LibWeb/IDB: Add internal ObjectStore type

This commit is contained in:
stelar7 2025-03-24 20:29:33 +01:00 committed by Jelle Raaijmakers
commit 3c5578cc87
Notes: github-actions[bot] 2025-03-27 15:49:50 +00:00
6 changed files with 86 additions and 2 deletions

View file

@ -0,0 +1,59 @@
/*
* Copyright (c) 2025, stelar7 <dudedbz@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Optional.h>
#include <AK/String.h>
#include <AK/Variant.h>
#include <AK/Vector.h>
#include <LibGC/Ptr.h>
#include <LibJS/Heap/Cell.h>
#include <LibJS/Runtime/Realm.h>
#include <LibWeb/IndexedDB/Internal/Algorithms.h>
#include <LibWeb/IndexedDB/Internal/KeyGenerator.h>
namespace Web::IndexedDB {
using KeyPath = Variant<String, Vector<String>>;
// https://w3c.github.io/IndexedDB/#object-store-construct
class ObjectStore : public JS::Cell {
GC_CELL(ObjectStore, JS::Cell);
GC_DECLARE_ALLOCATOR(ObjectStore);
public:
[[nodiscard]] static GC::Ref<ObjectStore> create(JS::Realm&, String, bool, Optional<KeyPath> const&);
virtual ~ObjectStore();
String name() const { return m_name; }
Optional<KeyPath> key_path() const { return m_key_path; }
bool uses_inline_keys() const { return m_key_path.has_value(); }
bool uses_out_of_line_keys() const { return !m_key_path.has_value(); }
// The autoIncrement getter steps are to return true if thiss object store has a key generator, and false otherwise.
bool auto_increment() const { return m_key_generator.has_value(); }
private:
ObjectStore(String name, bool auto_increment, Optional<KeyPath> const& key_path)
: m_name(move(name))
, m_key_path(key_path)
{
if (auto_increment)
m_key_generator = KeyGenerator {};
}
// An object store has a name, which is a name. At any one time, the name is unique within the database to which it belongs.
String m_name;
// An object store optionally has a key path. If the object store has a key path it is said to use in-line keys. Otherwise it is said to use out-of-line keys.
Optional<KeyPath> m_key_path;
// An object store optionally has a key generator.
Optional<KeyGenerator> m_key_generator;
};
}