@bodil/bdb 0.1.2 → 0.2.0

package/dist/table.js

@@ -8,18 +8,105 @@ import BTree from "sorted-btree";
 import { CustomIndex } from "./indices";
 import { IndexQuery, IteratorDirection } from "./query";
 import { TableStorage } from "./storage";
+/**
+ * A database table.
+ *
+ * To learn how to create a table, see the static method {@link Table.create}.
+ *
+ * @template Document The type of the documents this table stores.
+ */
 export class Table extends Emitter {
+    /**
+     * A promise which resolves when this table is ready to use.
+     *
+     * If the table isn't connected to a {@link StorageBackend}, this is a
+     * promise which resolves immediately, and you don't really need to await
+     * it. The table will be ready for use immediately.
+     *
+     * With an attached {@link StorageBackend}, this promise will resolve when
+     * the table has finished restoring its contents from the storage. You
+     * should not under any circumstances use the table before this is complete.
+     */
+    get ready() {
+        return this.#ready;
+    }
+    #ready;
+    #changed;
+    /**
+     * A signal which updates whenever the table has been modified.
+     */
+    get changed() {
+        return this.#changed.readOnly;
+    }
     #storage;
     #signals;
     #signalCleanupRegistry;
     #context;
+    /**
+     * Create a database {@link Table}.
+     *
+     * `Table.create` is a function which takes one type argument, the type of the
+     * object (which we'll call a *document*) you want the table to store, and no
+     * value arguments.
+     *
+     * This returns an object with one method: `withPrimaryIndex`. This method is
+     * what actually creates the table. So, the full incantation is, for instance:
+     *
+     * ```ts
+     * type Document = { id: string; value: number };
+     * const table = Table.create<Document>()
+     *     .withPrimaryIndex(index<Document>().key("id"));
+     * ```
+     *
+     * In order to look up something in a database table, you need an index. You can
+     * create an index using the {@link index} function, which, like `Table.create`,
+     * takes the document you're creating an index for as its type argument, and
+     * returns a selection of index constructors, of which the most straightforward
+     * one is {@link IndexConstructor.key}. This creates an index for a single named
+     * property of the document containing a primitive comparable value (a string, a
+     * number, or a bigint), and allows you to search for documents where the given
+     * property matches any given value. You can also create an index over multiple
+     * keys using {@link IndexConstructor.keys} or over a key containing an array
+     * using {@link IndexConstructor.array}. You can even create a completely
+     * customised index using {@link IndexConstructor.custom}.
+     *
+     * The primary index, unlike a regular index, is a unique identifier, and only
+     * one document can exist at any given time under the key or keys represented by
+     * the primary index. A table is required to have a primary index, which is why
+     * `Table.create` doesn't actually create the table until you call
+     * `withPrimaryIndex` on it. You can then add as many extra indices as you like
+     * using `withIndex`. To extend our example above with an additional index over
+     * the `value` property:
+     *
+     * ```ts
+     * type Document = { id: string; value: number };
+     * const table = Table.create<Document>()
+     *     .withPrimaryIndex(index<Document>().key("id"))
+     *     .withIndex(index<Document>().key("value"));
+     * ```
+     *
+     * @see {@link index}
+     *
+     * @template Document The type of the document this table stores.
+     */
+    static create() {
+        return {
+            withPrimaryIndex(primaryIndex) {
+                return new Table(primaryIndex);
+            },
+        };
+    }
+    /** @internal */
     constructor(primaryIndex) {
         super();
-        this.ready = Promise.resolve();
+        this.#ready = Promise.resolve();
+        /** @ignore */
         this.primary = new BTree();
+        /** @ignore */
         this.indices = {};
+        /** @ignore */
         this.indexTables = {};
-        this.changed = Signal.from(0);
+        this.#changed = Signal.from(null, { equals: () => false });
         this.#signals = new BTree();
         this.#signalCleanupRegistry = new FinalizationRegistry(this.#signalCleanup.bind(this));
         this.#context = new DisposableContext();
@@ -29,6 +116,15 @@ export class Table extends Emitter {
         super[Symbol.dispose]();
         this.#context.dispose();
     }
+    /**
+     * Add an index to a table.
+     *
+     * @example
+     * type Document = { id: string; value: number };
+     * const table = Table.create<Document>()
+     *     .withPrimaryIndex(index<Document>().key("id"))
+     *     .withIndex(index<Document>().key("value"));
+     */
     withIndex(index) {
         assert(this.indices[index.name] === undefined, `duplicate index definition: "${index.name}"`);
         this.indices[index.name] = index;
@@ -36,9 +132,14 @@ export class Table extends Emitter {
             index instanceof CustomIndex ? index.makeIndex() : new BTree();
         return this;
     }
+    /**
+     * Attach a table to a {@link StorageBackend}.
+     *
+     * See {@link IndexedDBBackend.open} for an example of how to use this.
+     */
     withStorage(backend, name) {
         this.#storage = new TableStorage(backend, name, this.primaryIndex);
-        this.ready = this.#storage.ready;
+        this.#ready = this.#storage.ready;
         this.#context.use(this.#storage.on((event) => {
             switch (event.type) {
                 case "update":
@@ -55,14 +156,14 @@ export class Table extends Emitter {
     signal(primaryKey) {
         const active = this.#signals.get(primaryKey)?.deref();
         if (active !== undefined) {
-            return active.readOnly();
+            return active.readOnly;
         }
         const sig = Signal.from(this.get(primaryKey), {
             equals: () => false,
         });
         this.#signalCleanupRegistry.register(sig, primaryKey);
         this.#signals.set(primaryKey, new WeakRef(sig));
-        return sig.readOnly();
+        return sig.readOnly;
     }
     get(primaryKey) {
         return this.primary.get(primaryKey);
@@ -78,9 +179,18 @@ export class Table extends Emitter {
         return this.#setItem(item, oldItem, primaryKey);
     }
     /**
-     * Given a primary key, apply an update function to the value stored under
-     * that key. If there's no value, call the create function to create a new
-     * value. In this case, the update function is not called.
+     * Create or update a document.
+     *
+     * Given a primary key, apply the `update` function to the document stored
+     * under that key.
+     *
+     * If there's no such document, call the `create` function to create a new
+     * document and insert that under the given primary key. In this case, the
+     * update function is not called.
+     *
+     * The `update` function is passed to {@link produce | Immer.produce} to
+     * perform the update. It should modify the provided document in place, and
+     * it's not necessary to return it.
      */
     createOrUpdate(primaryKey, create, update) {
         const oldItem = this.primary.get(primaryKey);
@@ -88,9 +198,17 @@ export class Table extends Emitter {
         return this.#setItem(item, oldItem, primaryKey);
     }
     /**
-     * Apply an update function to the value stored under the given primary key.
-     * If no value exists, the update function is not called and `undefined` is
-     * returned. Otherwise, the updated value is returned.
+     * Update a document.
+     *
+     * Apply the `update` function to the document stored under the given
+     * primary key.
+     *
+     * If no such document exists, the update function is not called and
+     * `undefined` is returned. Otherwise, the updated document is returned.
+     *
+     * The `update` function is passed to {@link produce | Immer.produce} to
+     * perform the update. It should modify the provided document in place, and
+     * it's not necessary to return it.
      */
     update(primaryKey, update) {
         const oldItem = this.primary.get(primaryKey);
@@ -107,20 +225,34 @@ export class Table extends Emitter {
         return this.#deleteFrom(items.length === 1 && isIterable(items[0]) ? items[0] : items);
     }
     /**
-     * Delete all data from the table.
+     * Delete all documents from the table.
      */
     clear() {
         this.delete(...this.primary.keys());
     }
+    /**
+     * Iterate over the documents in the table, ordered by primary key.
+     */
     [Symbol.iterator]() {
-        return this.primary.values();
+        return Iterator.from(this.primary.values());
     }
+    /**
+     * Perform an {@link IndexQuery} using the specified index.
+     */
     where(index) {
         return new IndexQuery(this, index, IteratorDirection.Ascending);
     }
+    /**
+     * Perform an {@link IndexQuery} using the specified index.
+     *
+     * This is an alias for {@link Table.where}.
+     */
     orderBy(index) {
         return this.where(index);
     }
+    /**
+     * Get the number of documents currently stored in the table.
+     */
     size() {
         return this.primary.size;
     }
@@ -176,7 +308,7 @@ export class Table extends Emitter {
         // emit an update event and update signals
         this.#withSignal(this.primaryIndex.extractKey(item), (sig) => sig.set(item));
         this.emit({ type: "update", item });
-        this.changed.update((i) => i + 1);
+        this.#changed.set(null);
         return item;
     }
     #deleteItem(item, primaryKey) {
@@ -187,7 +319,7 @@ export class Table extends Emitter {
         // emit a delete event and update signals
         this.#withSignal(primaryKey, (sig) => sig.set(undefined));
         this.emit({ type: "delete", key: primaryKey });
-        this.changed.update((i) => i + 1);
+        this.#changed.set(null);
     }
     #withSignal(primaryKey, fn) {
         const sigRef = this.#signals.get(primaryKey);

package/dist/table.js.map

@@ -1 +1 @@
-{"version":3,"file":"table.js","sourceRoot":"","sources":["../src/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,EAAE,EAAE,MAAM,iBAAiB,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAc,MAAM,OAAO,CAAC;AACpD,OAAO,KAAK,MAAM,cAAc,CAAC;AAGjC,OAAO,EAAE,WAAW,EAA8B,MAAM,WAAW,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAQzC,MAAM,OAAO,KACT,SAAQ,OAAqC;IAc7C,QAAQ,CAAuB;IACtB,QAAQ,CAA8E;IACtF,sBAAsB,CAA4D;IAClF,QAAQ,CAA2B;IAE5C,YAAY,YAAgB;QACxB,KAAK,EAAE,CAAC;QAjBZ,UAAK,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;QAGhC,YAAO,GAAG,IAAI,KAAK,EAA8B,CAAC;QAClD,YAAO,GAAgE,EAAS,CAAC;QACjF,gBAAW,GAEhB,EAAS,CAAC;QAEL,YAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAGzB,aAAQ,GAAG,IAAI,KAAK,EAAiE,CAAC;QACtF,2BAAsB,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAClF,aAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC;QAIxC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACrC,CAAC;IAEQ,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,SAAS,CACL,KAAQ;QAER,MAAM,CACD,IAAI,CAAC,OAAe,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,EAC/C,gCAAgC,KAAK,CAAC,IAAI,GAAG,CAChD,CAAC;QACD,IAAI,CAAC,OAAe,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACzC,IAAI,CAAC,WAAmB,CAAC,KAAK,CAAC,IAAI,CAAC;YACjC,KAAK,YAAY,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC;QACnE,OAAO,IAAgF,CAAC;IAC5F,CAAC;IAED,WAAW,CAAC,OAAuB,EAAE,IAAY;QAC7C,IAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACnE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,GAAG,CACb,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAmC,EAAE,EAAE;YACrD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;gBACjB,KAAK,QAAQ;oBACT,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrB,MAAM;gBACV,KAAK,QAAQ;oBACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACvB,MAAM;YACd,CAAC;QACL,CAAC,CAAC,CACL,CAAC;QACF,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,UAAyB;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC;QACtD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC7B,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YAC1C,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK;SACtB,CAAC,CAAC;QACH,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAChD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED,GAAG,CAAC,UAAyB;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,eAAe,CACX,UAAyB,EACzB,MAAe,EACf,MAA2C;QAE3C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,MAAM,EAAE,CAAC;QACzD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,cAAc,CACV,UAAyB,EACzB,MAAe,EACf,MAA2C;QAE3C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,MAAM,CACF,UAAyB,EACzB,MAA2C;QAE3C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAQD,GAAG,CAAC,GAAG,KAA6B;QAChC,OAAO,IAAI,CAAC,QAAQ,CAChB,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,KAAkB,CAC9E,CAAC;IACN,CAAC;IAOD,MAAM,CAAC,GAAG,KAAqD;QAC3D,OAAO,IAAI,CAAC,WAAW,CACnB,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,KAAkB,CAC9E,CAAC;IACN,CAAC;IAED;;OAEG;IACH,KAAK;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IACjC,CAAC;IAED,KAAK,CACD,KAAQ;QAER,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,CACH,KAAQ;QAER,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,QAAQ,CAAC,KAAkB;QACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC/C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC;IACL,CAAC;IAED,WAAW,CAAC,WAAoC;QAC5C,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC1C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACrB,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBACnC,OAAO,EAAE,CAAC;YACd,CAAC;QACL,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,QAAQ,CAAC,IAAO,EAAE,OAAgC,EAAE,GAAkB;QAClE,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEnB,8CAA8C;QAC9C,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC;QACrF,iEAAiE;QACjE,wCAAwC;QACxC,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAEzB,uDAAuD;QACvD,IAAI,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,mCAAmC;QACnC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QAED,sEAAsE;QACtE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAElC,0BAA0B;QAC1B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAI,IAAI,CAAC,OAAe,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,KAAK,GAAI,IAAI,CAAC,WAAmB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC9B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACvB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC3B,CAAC;qBAAM,CAAC;oBACJ,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtB,CAAC;YACL,CAAC;QACL,CAAC;QAED,0CAA0C;QAC1C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACpC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,IAAO,EAAE,UAAyB;QAC1C,+BAA+B;QAC/B,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC9B,yCAAyC;QACzC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAChC,yCAAyC;QACzC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,WAAW,CACP,UAAyB,EACzB,EAA2D;QAE3D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,GAAG,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC;QAC5B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACpB,iDAAiD;YACjD,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,4CAA4C;YAC5C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACrC,CAAC;IACL,CAAC;IAED,kBAAkB,CAAC,IAAO;QACtB,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAI,IAAI,CAAC,OAAe,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,KAAK,GAAI,IAAI,CAAC,WAAmB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC9B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACvB,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBACzC,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;wBACnB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BACtB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBACtB,CAAC;6BAAM,CAAC;4BACJ,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;wBAClC,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,cAAc,CAAC,UAAyB;QACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;CACJ"}
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../src/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,EAAE,EAAE,MAAM,iBAAiB,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAc,MAAM,OAAO,CAAC;AACpD,OAAO,KAAK,MAAM,cAAc,CAAC;AAGjC,OAAO,EAAE,WAAW,EAA8B,MAAM,WAAW,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAQzC;;;;;;GAMG;AACH,MAAM,OAAO,KAKT,SAAQ,OAAsD;IAG9D;;;;;;;;;;OAUG;IACH,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IACD,MAAM,CAAoC;IAkBjC,QAAQ,CAA8C;IAC/D;;OAEG;IACH,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAClC,CAAC;IAED,QAAQ,CAAwC;IACvC,QAAQ,CAGb;IACK,sBAAsB,CAA4D;IAClF,QAAQ,CAA2B;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CAAC,MAAM;QAKT,OAAO;YACH,gBAAgB,CAAC,YAAY;gBACzB,OAAO,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YACnC,CAAC;SACJ,CAAC;IACN,CAAC;IAED,gBAAgB;IAChB,YAAoB,YAA0B;QAC1C,KAAK,EAAE,CAAC;QA/FZ,WAAM,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;QAI1C,cAAc;QACL,YAAO,GAAG,IAAI,KAAK,EAA+C,CAAC;QAC5E,cAAc;QACL,YAAO,GAEZ,EAAS,CAAC;QACd,cAAc;QACL,gBAAW,GAKhB,EAAS,CAAC;QAEL,aAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;QAStD,aAAQ,GAAG,IAAI,KAAK,EAG1B,CAAC;QACK,2BAAsB,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAClF,aAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC;QAgExC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACrC,CAAC;IAEQ,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CACL,KAAQ;QAMR,MAAM,CACD,IAAI,CAAC,OAAe,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,EAC/C,gCAAgC,KAAK,CAAC,IAAI,GAAG,CAChD,CAAC;QACD,IAAI,CAAC,OAAe,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACzC,IAAI,CAAC,WAAmB,CAAC,KAAK,CAAC,IAAI,CAAC;YACjC,KAAK,YAAY,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC;QACnE,OAAO,IAIN,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,OAAuB,EAAE,IAAY;QAC7C,IAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACnE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CACb,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAoD,EAAE,EAAE;YACtE,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;gBACjB,KAAK,QAAQ;oBACT,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrB,MAAM;gBACV,KAAK,QAAQ;oBACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACvB,MAAM;YACd,CAAC;QACL,CAAC,CAAC,CACL,CAAC;QACF,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,UAAmC;QACtC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC;QACtD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,MAAM,CAAC,QAAQ,CAAC;QAC3B,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YAC1C,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK;SACtB,CAAC,CAAC;QACH,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAChD,OAAO,GAAG,CAAC,QAAQ,CAAC;IACxB,CAAC;IAED,GAAG,CAAC,UAAmC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,eAAe,CACX,UAAmC,EACnC,MAAsB,EACtB,MAAyD;QAEzD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,MAAM,EAAE,CAAC;QACzD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CACV,UAAmC,EACnC,MAAsB,EACtB,MAAyD;QAEzD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACF,UAAmC,EACnC,MAAyD;QAEzD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAQD,GAAG,CAAC,GAAG,KAA2C;QAC9C,OAAO,IAAI,CAAC,QAAQ,CAChB,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,KAAyB,CACrF,CAAC;IACN,CAAC;IAOD,MAAM,CAAC,GAAG,KAAyE;QAC/E,OAAO,IAAI,CAAC,WAAW,CACnB,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,KAAyB,CACrF,CAAC;IACN,CAAC;IAED;;OAEG;IACH,KAAK;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC;QACb,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,KAAK,CACD,KAAQ;QAER,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,OAAO,CACH,KAAQ;QAER,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI;QACA,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,QAAQ,CAAC,KAAyB;QAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC/C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC;IACL,CAAC;IAED,WAAW,CAAC,WAA8C;QACtD,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC1C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACrB,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBACnC,OAAO,EAAE,CAAC;YACd,CAAC;QACL,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,QAAQ,CACJ,IAAc,EACd,OAAuC,EACvC,GAA4B;QAE5B,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEnB,8CAA8C;QAC9C,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC;QACrF,iEAAiE;QACjE,wCAAwC;QACxC,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAEzB,uDAAuD;QACvD,IAAI,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,mCAAmC;QACnC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QAED,sEAAsE;QACtE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAElC,0BAA0B;QAC1B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAI,IAAI,CAAC,OAAe,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,KAAK,GAAI,IAAI,CAAC,WAAmB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC9B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACvB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC3B,CAAC;qBAAM,CAAC;oBACJ,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtB,CAAC;YACL,CAAC;QACL,CAAC;QAED,0CAA0C;QAC1C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,IAAc,EAAE,UAAmC;QAC3D,+BAA+B;QAC/B,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC9B,yCAAyC;QACzC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAChC,yCAAyC;QACzC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,WAAW,CACP,UAAmC,EACnC,EAAkE;QAElE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,GAAG,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC;QAC5B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACpB,iDAAiD;YACjD,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,4CAA4C;YAC5C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACrC,CAAC;IACL,CAAC;IAED,kBAAkB,CAAC,IAAc;QAC7B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAI,IAAI,CAAC,OAAe,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,KAAK,GAAI,IAAI,CAAC,WAAmB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC9B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACvB,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBACzC,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;wBACnB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BACtB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBACtB,CAAC;6BAAM,CAAC;4BACJ,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;wBAClC,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,cAAc,CAAC,UAAmC;QAC9C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;CACJ"}

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-export type IndexablePrimitive = string | number | null | undefined | bigint;
+export type IndexablePrimitive = string | number | bigint;
 export type IndexableType = IndexablePrimitive | Array<IndexablePrimitive> | ReadonlyArray<IndexablePrimitive>;
 export type CustomIndexablesOf<A, T> = string & keyof A & {
     [Key in keyof A]: A[Key] extends T ? Key : never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bodil/bdb",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "A signal enabled database",
   "homepage": "https://codeberg.org/bodil/bdb",
   "repository": {
@@ -27,8 +27,8 @@
   },
   "dependencies": {
     "@bodil/core": "^0.5.2",
-    "@bodil/opt": "^0.4.3",
-    "@bodil/signal": "^0.4.0",
+    "@bodil/opt": "^1.0.0",
+    "@bodil/signal": "^0.5.1",
     "immer": "^11.1.3",
     "sorted-btree": "2.1.0"
   },

package/src/backend.ts

@@ -4,9 +4,18 @@ import type { IndexablePrimitive } from "./types";
 
 export type DatabaseBroadcast = { event: "update" | "delete"; table: string; key: unknown };
 
+/**
+ * Configuration for IndexedDB backends.
+ */
 export type IndexedDBBackendConfig = {
+    /** Name of the IndexedDB database to connect to. */
     name: string;
+    /** Version number of the database. */
     version: number;
+    /**
+     * Name of the IndexedDB database table to store our database in. Defaults
+     * to `"store"`.
+     */
     table?: string;
 };
 
@@ -27,6 +36,9 @@ function unpackRecord<A = unknown>(record: StorageRecord): A {
     return deserialise(record.value) as A;
 }
 
+/**
+ * Base class for storage backends.
+ */
 export abstract class StorageBackend {
     readonly name: string;
 
@@ -49,12 +61,36 @@ export abstract class StorageBackend {
     }
 }
 
+/**
+ * Storage backend using an IndexedDB database.
+ *
+ * Use {@link IndexedDBBackend.open} to obtain a storage backend connected to
+ * the specified IndexedDB database.
+ *
+ * @example
+ * // Connect to the IndexedDB database.
+ * const storage = await IndexedDBBackend.open("my-docs", 1);
+ * // Declare a document type.
+ * type Document = { id: string; value: number };
+ * // Create the table.
+ * const docs = Table.create<Document>()
+ *     .withPrimaryKey(index<Document>().key("id"))
+ * // Connect the table to our storage.
+ *     .withStorage(storage);
+ * // Wait until the table has finished syncing with the storage.
+ * await docs.ready;
+ * // Ready for use!
+ * docs.add({ id: "Robert", value: 9001 });
+ */
 export class IndexedDBBackend extends StorageBackend {
     private db?: IDBDatabase;
 
     readonly version: number;
     readonly table: string;
 
+    /**
+     * Connect to an IndexedDB database.
+     */
     static async open(config: IndexedDBBackendConfig): Promise<IndexedDBBackend> {
         const c = { ...backendConfigDefaults, ...config };
         const storage = new IndexedDBBackend(c.name, c.version, c.table);
@@ -107,6 +143,7 @@ export class IndexedDBBackend extends StorageBackend {
         });
     }
 
+    /** @internal */
     async get<A = unknown>(table: string, key: unknown): Promise<A> {
         const value: StorageRecord = await this.transaction("readonly", (store) => {
             return request(store.get([table, key] as IDBValidKey));
@@ -114,6 +151,7 @@ export class IndexedDBBackend extends StorageBackend {
         return unpackRecord(value);
     }
 
+    /** @internal */
     async getAll<A = unknown>(table: string): Promise<Array<A>> {
         const values = await this.transaction("readonly", (store) => {
             return request(store.index("table").getAll(table));
@@ -121,6 +159,7 @@ export class IndexedDBBackend extends StorageBackend {
         return (values as Array<StorageRecord>).map(unpackRecord<A>);
     }
 
+    /** @internal */
     async update(table: string, key: unknown, value: unknown): Promise<void> {
         await this.transaction("readwrite", (store) => {
             return request(store.put({ table, key, value: serialise(value) }));
@@ -128,6 +167,7 @@ export class IndexedDBBackend extends StorageBackend {
         this.broadcast?.send({ event: "update", table, key });
     }
 
+    /** @internal */
     async delete(table: string, key: unknown): Promise<void> {
         await this.transaction("readwrite", (store) => {
             return request(store.delete([table, key as IDBValidKey]));

package/src/index.test.ts

@@ -6,7 +6,7 @@ import { sleep } from "@bodil/core/async";
 import { Signal } from "@bodil/signal";
 import { expect, expectTypeOf, test } from "vitest";
 
-import { arrayIndex, compoundIndex, createTable, index, timeIndex } from ".";
+import { index, Table } from ".";
 import { IndexedDBBackend } from "./backend";
 import type { IndexablesOf } from "./types";
 
@@ -34,11 +34,12 @@ test("memdb basics", () => {
         tags: Array<string>;
     };
 
-    const table = createTable<TestItem>()(index<TestItem>()("id"))
-        .withIndex(timeIndex<TestItem>()("created"))
-        .withIndex(index<TestItem>()("uri"))
-        .withIndex(arrayIndex<TestItem>()("tags"))
-        .withIndex(compoundIndex<TestItem>()("id", "uri"));
+    const table = Table.create<TestItem>()
+        .withPrimaryIndex(index<TestItem>().key("id"))
+        .withIndex(index<TestItem>().time("created"))
+        .withIndex(index<TestItem>().key("uri"))
+        .withIndex(index<TestItem>().array("tags"))
+        .withIndex(index<TestItem>().keys("id", "uri"));
 
     const now = time.now();
     const [welp, wolp, wulp, wilp] = [
@@ -115,9 +116,9 @@ test("memdb basics", () => {
 
 test("memdb index dupes", () => {
     type Account = { id: string; order: number };
-    const accounts = createTable<Account>()(index<Account>()("id")).withIndex(
-        index<Account>()("order"),
-    );
+    const accounts = Table.create<Account>()
+        .withPrimaryIndex(index<Account>().key("id"))
+        .withIndex(index<Account>().key("order"));
 
     const account = { id: "test@test.com", order: 1 };
     accounts.add({ ...account });
@@ -128,10 +129,10 @@ test("memdb index dupes", () => {
 
 test("memdb signals", () => {
     type Thing = { name: string; counter: number };
-    const things = createTable<Thing>()(index<Thing>()("name"));
+    const things = Table.create<Thing>().withPrimaryIndex(index<Thing>().key("name"));
 
     type ThingMap = { id: number; name: string };
-    const thingMaps = createTable<ThingMap>()(index<ThingMap>()("id"));
+    const thingMaps = Table.create<ThingMap>().withPrimaryIndex(index<ThingMap>().key("id"));
     thingMaps.add({ id: 1, name: "Mike" }, { id: 2, name: "Robert" });
 
     const joe = things.signal("Joe");
@@ -163,7 +164,7 @@ test("memdb signals", () => {
 
 test("failed update shouldn't change anything", () => {
     type Thing = { name: string; counter: number };
-    const things = createTable<Thing>()(index<Thing>()("name"));
+    const things = Table.create<Thing>().withPrimaryIndex(index<Thing>().key("name"));
 
     things.add({ name: "Joe", counter: 321 });
     expect(() =>
@@ -181,8 +182,9 @@ test("IndexedDB", async () => {
     const before = now.subtract(time.seconds(25));
     {
         const store = await IndexedDBBackend.open({ name: "test", version: 1 });
-        const things = createTable<Thing>()(index<Thing>()("key"))
-            .withIndex(timeIndex<Thing>()("time"))
+        const things = Table.create<Thing>()
+            .withPrimaryIndex(index<Thing>().key("key"))
+            .withIndex(index<Thing>().time("time"))
             .withStorage(store, "things");
         await things.ready;
         things.add(
@@ -199,8 +201,9 @@ test("IndexedDB", async () => {
     }
     {
         const store = await IndexedDBBackend.open({ name: "test", version: 1 });
-        const things = createTable<Thing>()(index<Thing>()("key"))
-            .withIndex(timeIndex<Thing>()("time"))
+        const things = Table.create<Thing>()
+            .withPrimaryIndex(index<Thing>().key("key"))
+            .withIndex(index<Thing>().time("time"))
             .withStorage(store, "things");
         await things.ready;
         expect(things.get("Joe")).deep.equal({ key: "Joe", value: "Armstrong", time: now });
@@ -210,3 +213,68 @@ test("IndexedDB", async () => {
         ]);
     }
 });
+
+test("query.below/query.above", () => {
+    type Item = { id: string; value: number };
+    const table = Table.create<Item>()
+        .withPrimaryIndex(index<Item>().key("id"))
+        .withIndex(index<Item>().key("value"));
+    table.add(
+        { id: "1", value: 1 },
+        { id: "2", value: 2 },
+        { id: "3", value: 3 },
+        { id: "4", value: 4 },
+        { id: "5", value: 5 },
+    );
+    expect(
+        table
+            .where("value")
+            .below(3)
+            .toArray()
+            .map((i) => i.value),
+    ).toEqual([2, 1]);
+    expect(
+        table
+            .where("value")
+            .below(3)
+            .inclusive()
+            .toArray()
+            .map((i) => i.value),
+    ).toEqual([3, 2, 1]);
+    expect(
+        table
+            .where("value")
+            .above(3)
+            .toArray()
+            .map((i) => i.value),
+    ).toEqual([4, 5]);
+    expect(
+        table
+            .where("value")
+            .above(3)
+            .inclusive()
+            .toArray()
+            .map((i) => i.value),
+    ).toEqual([3, 4, 5]);
+});
+
+test("query.delete()", () => {
+    type Doc = { id: number };
+    const table = Table.create<Doc>().withPrimaryIndex(index<Doc>().key("id"));
+    for (let id = 0; id < 10; id++) {
+        table.add({ id });
+    }
+
+    const ids = table
+        .where("id")
+        .signal()
+        .map((docs) => docs.map((doc) => doc.id));
+    expect(ids.get()).toEqual([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
+
+    expect(table.where("id").above(5).delete()).toEqual(4);
+    expect(
+        Iterator.from(table)
+            .map((doc) => doc.id)
+            .toArray(),
+    ).toEqual([0, 1, 2, 3, 4, 5]);
+});