@bodil/bdb 0.1.0

package/dist/table.js

@@ -0,0 +1,223 @@
+import { assert, isIterable } from "@bodil/core/assert";
+import { Emitter } from "@bodil/core/async";
+import { DisposableContext } from "@bodil/core/disposable";
+import { Signal } from "@bodil/signal";
+import { freeze, produce } from "immer";
+import BTree from "sorted-btree";
+import { CustomIndex } from "./indices";
+import { IndexQuery, IteratorDirection } from "./query";
+import { TableStorage } from "./storage";
+export class Table extends Emitter {
+    #storage;
+    #signals;
+    #signalCleanupRegistry;
+    #context;
+    constructor(primaryIndex) {
+        super();
+        this.ready = Promise.resolve();
+        this.primary = new BTree();
+        this.indices = {};
+        this.indexTables = {};
+        this.changed = Signal(0);
+        this.#signals = new BTree();
+        this.#signalCleanupRegistry = new FinalizationRegistry(this.#signalCleanup.bind(this));
+        this.#context = new DisposableContext();
+        this.primaryIndex = primaryIndex;
+    }
+    [Symbol.dispose]() {
+        super[Symbol.dispose]();
+        this.#context.dispose();
+    }
+    withIndex(index) {
+        assert(this.indices[index.name] === undefined, `duplicate index definition: "${index.name}"`);
+        this.indices[index.name] = index;
+        this.indexTables[index.name] =
+            index instanceof CustomIndex ? index.makeIndex() : new BTree();
+        return this;
+    }
+    withStorage(backend, name) {
+        this.#storage = new TableStorage(backend, name, this.primaryIndex);
+        this.ready = this.#storage.ready;
+        this.#context.use(this.#storage.on((event) => {
+            switch (event.type) {
+                case "update":
+                    this.add(event.item);
+                    break;
+                case "delete":
+                    this.delete(event.key);
+                    break;
+            }
+        }));
+        void this.#storage.link(this);
+        return this;
+    }
+    signal(primaryKey) {
+        const active = this.#signals.get(primaryKey)?.deref();
+        if (active !== undefined) {
+            return active.readOnly();
+        }
+        const sig = Signal(this.get(primaryKey), {
+            equals: () => false,
+        });
+        this.#signalCleanupRegistry.register(sig, primaryKey);
+        this.#signals.set(primaryKey, new WeakRef(sig));
+        return sig.readOnly();
+    }
+    get(primaryKey) {
+        return this.primary.get(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 the
+     * value before passing it to the update function.
+     */
+    createAndUpdate(primaryKey, create, update) {
+        const oldItem = this.primary.get(primaryKey) ?? create();
+        const item = produce(oldItem, update);
+        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.
+     */
+    createOrUpdate(primaryKey, create, update) {
+        const oldItem = this.primary.get(primaryKey);
+        const item = oldItem === undefined ? create() : produce(oldItem, update);
+        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(primaryKey, update) {
+        const oldItem = this.primary.get(primaryKey);
+        if (oldItem === undefined) {
+            return undefined;
+        }
+        const item = produce(oldItem, update);
+        return this.#setItem(item, oldItem, primaryKey);
+    }
+    add(...items) {
+        return this.#addFrom(items.length === 1 && isIterable(items[0]) ? items[0] : items);
+    }
+    delete(...items) {
+        return this.#deleteFrom(items.length === 1 && isIterable(items[0]) ? items[0] : items);
+    }
+    /**
+     * Delete all data from the table.
+     */
+    clear() {
+        this.delete(...this.primary.keys());
+    }
+    [Symbol.iterator]() {
+        return this.primary.values();
+    }
+    where(index) {
+        return new IndexQuery(this, index, IteratorDirection.Ascending);
+    }
+    orderBy(index) {
+        return this.where(index);
+    }
+    size() {
+        return this.primary.size;
+    }
+    #addFrom(items) {
+        for (const item of items) {
+            const key = this.primaryIndex.extractKey(item);
+            this.#setItem(item, this.primary.get(key), key);
+        }
+    }
+    #deleteFrom(primaryKeys) {
+        let deleted = 0;
+        for (const primaryKey of primaryKeys) {
+            const item = this.primary.get(primaryKey);
+            if (item !== undefined) {
+                this.#deleteItem(item, primaryKey);
+                deleted++;
+            }
+        }
+        return deleted;
+    }
+    #setItem(item, oldItem, key) {
+        freeze(item, true);
+        // stop now if the new value is the same as the old one
+        if (Object.is(oldItem, item)) {
+            return item;
+        }
+        // remove the old item from indices
+        if (oldItem !== undefined) {
+            this.#deleteFromIndices(oldItem);
+        }
+        // store the new item under its primary key, overwriting the old value
+        this.primary.set(key, item, true);
+        // add new item to indices
+        for (const property of Object.keys(this.indices)) {
+            const index = this.indices[property];
+            const table = this.indexTables[property];
+            const keys = index.extractKeys(item);
+            for (const key of keys) {
+                const record = table.get(key);
+                if (record === undefined) {
+                    table.set(key, [item]);
+                }
+                else {
+                    record.push(item);
+                }
+            }
+        }
+        // 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);
+        return item;
+    }
+    #deleteItem(item, primaryKey) {
+        // remove the item from indices
+        this.#deleteFromIndices(item);
+        // remove the item from the primary index
+        this.primary.delete(primaryKey);
+        // 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);
+    }
+    #withSignal(primaryKey, fn) {
+        const sigRef = this.#signals.get(primaryKey);
+        const sig = sigRef?.deref();
+        if (sig !== undefined) {
+            // Only run the function if we have a live signal
+            return fn(sig);
+        }
+        else if (sigRef !== undefined) {
+            // Remove dangling reference from signal map
+            this.#signals.delete(primaryKey);
+        }
+    }
+    #deleteFromIndices(item) {
+        for (const property of Object.keys(this.indices)) {
+            const index = this.indices[property];
+            const table = this.indexTables[property];
+            const keys = index.extractKeys(item);
+            for (const key of keys) {
+                const record = table.get(key);
+                if (record !== undefined) {
+                    const recordIndex = record.indexOf(item);
+                    if (recordIndex >= 0) {
+                        if (record.length === 1) {
+                            table.delete(key);
+                        }
+                        else {
+                            record.splice(recordIndex, 1);
+                        }
+                    }
+                }
+            }
+        }
+    }
+    #signalCleanup(primaryKey) {
+        this.#signals.delete(primaryKey);
+    }
+}
+//# sourceMappingURL=table.js.map

package/dist/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../src/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,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,CAAC,CAAC,CAAC;QAGpB,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,GAAG,CAAC,UAAU,CAAC,EAAE;YACrC,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,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"}

package/dist/types.d.ts

@@ -0,0 +1,8 @@
+export type IndexablePrimitive = string | number | null | undefined | 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;
+}[keyof A];
+export type IndexablesOf<A> = CustomIndexablesOf<A, IndexableType>;
+export type PrimitiveIndexablesOf<A> = CustomIndexablesOf<A, IndexablePrimitive>;
+export type ArrayIndexablesOf<A> = CustomIndexablesOf<A, Array<IndexablePrimitive> | ReadonlyArray<IndexablePrimitive>>;

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@bodil/bdb",
+  "version": "0.1.0",
+  "description": "A signal enabled database",
+  "homepage": "https://codeberg.org/bodil/bdb",
+  "repository": {
+    "type": "git",
+    "url": "git+https://codeberg.org/bodil/bdb.git"
+  },
+  "license": "EUPL-1.2+",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.js"
+      }
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@bodil/core": "^0.4.9",
+    "@bodil/opt": "^0.4.2",
+    "@bodil/signal": "^0.3.3",
+    "immer": "^11.0.1",
+    "sorted-btree": "2.0.0-alpha.0"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^9.39.1",
+    "@ianvs/prettier-plugin-sort-imports": "^4.7.0",
+    "@typescript-eslint/eslint-plugin": "^8.49.0",
+    "@typescript-eslint/parser": "^8.49.0",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsdoc": "^54.7.0",
+    "fake-indexeddb": "^6.2.5",
+    "globals": "^16.5.0",
+    "npm-run-all2": "^8.0.4",
+    "prettier": "^3.7.4",
+    "temporal-polyfill": "^0.3.0",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-extras": "^4.0.1",
+    "typedoc-plugin-mdn-links": "^5.0.10",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "prettier": {
+    "editorconfig": true,
+    "plugins": [
+      "@ianvs/prettier-plugin-sort-imports"
+    ],
+    "importOrderParserPlugins": [
+      "typescript",
+      "decorators"
+    ],
+    "importOrderTypeScriptVersion": "5.0.0",
+    "importOrder": [
+      "",
+      "<BUILTIN_MODULES>",
+      "",
+      "<THIRD_PARTY_MODULES>",
+      "",
+      "^[.](?!.*[?]inline$)",
+      "",
+      "[?]inline$"
+    ]
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest --run",
+    "check:eslint": "eslint src",
+    "check:tsc": "tsc --noEmit",
+    "check": "run-p check:tsc check:eslint",
+    "doc": "typedoc",
+    "doc:readthedocs": "typedoc --out $READTHEDOCS_OUTPUT/html",
+    "prepublish": "tsc"
+  }
+}

package/src/backend.ts

@@ -0,0 +1,137 @@
+import { Broadcaster } from "./broadcast";
+import { deserialise, serialise, type Serialised } from "./serial";
+import type { IndexablePrimitive } from "./types";
+
+export type DatabaseBroadcast = { event: "update" | "delete"; table: string; key: unknown };
+
+export type IndexedDBBackendConfig = {
+    name: string;
+    version: number;
+    table?: string;
+};
+
+const backendConfigDefaults = {
+    table: "store",
+};
+
+type StorageRecord = { table: string; key: IndexablePrimitive; value: Serialised };
+
+function request<A>(req: IDBRequest): Promise<A> {
+    return new Promise((resolve, reject) => {
+        req.onerror = () => reject(req.error as Error);
+        req.onsuccess = () => resolve(req.result);
+    });
+}
+
+function unpackRecord<A = unknown>(record: StorageRecord): A {
+    return deserialise(record.value) as A;
+}
+
+export abstract class StorageBackend {
+    readonly name: string;
+
+    abstract get<A = unknown>(table: string, key: unknown): Promise<A>;
+    abstract getAll<A = unknown>(table: string): Promise<Array<A>>;
+    abstract update(table: string, key: unknown, value: unknown): Promise<void>;
+    abstract delete(table: string, key: unknown): Promise<void>;
+
+    protected readonly broadcast?: Broadcaster<DatabaseBroadcast>;
+
+    protected constructor(name: string) {
+        this.name = name;
+        if (Object.hasOwn(globalThis, "BroadcastChannel")) {
+            this.broadcast = new Broadcaster<DatabaseBroadcast>(`memdb-broadcast-${name}`);
+        }
+    }
+
+    onBroadcast(callback: (message: DatabaseBroadcast) => void): Disposable | undefined {
+        return this.broadcast?.on(callback);
+    }
+}
+
+export class IndexedDBBackend extends StorageBackend {
+    private db?: IDBDatabase;
+
+    readonly version: number;
+    readonly table: string;
+
+    static async open(config: IndexedDBBackendConfig): Promise<IndexedDBBackend> {
+        const c = { ...backendConfigDefaults, ...config };
+        const storage = new IndexedDBBackend(c.name, c.version, c.table);
+        await storage.open();
+        return storage;
+    }
+
+    protected constructor(name: string, version: number, table: string) {
+        super(name);
+        this.version = version;
+        this.table = table;
+    }
+
+    private async open(): Promise<void> {
+        const resolver = Promise.withResolvers<void>();
+        const request = indexedDB.open(this.name, this.version);
+        request.onerror = (event: Event) => {
+            const error = (event.target as IDBOpenDBRequest).error as Error;
+            resolver.reject(error);
+        };
+        request.onsuccess = (event: Event) => {
+            this.db = (event.target as IDBOpenDBRequest).result;
+            this.db.onerror = null;
+            resolver.resolve();
+        };
+        request.onupgradeneeded = (event: IDBVersionChangeEvent) => {
+            const db = (event.target as IDBOpenDBRequest).result;
+            db.onerror = (event) => {
+                const error = (event.target as IDBOpenDBRequest).error as Error;
+                resolver.reject(error);
+            };
+            const store = db.createObjectStore(this.table, { keyPath: ["table", "key"] });
+            store.createIndex("table", "table", { unique: false });
+        };
+        return resolver.promise;
+    }
+
+    private transaction<A>(
+        mode: "readonly" | "readwrite",
+        job: (store: IDBObjectStore) => Promise<A>,
+    ): Promise<A> {
+        if (this.db === undefined) {
+            throw new Error("database not ready");
+        }
+        return new Promise((resolve, reject: (reason?: unknown) => void) => {
+            const tx = this.db!.transaction([this.table], mode);
+            tx.onerror = () => reject(tx.error as Error);
+            tx.oncomplete = async () => resolve(await result);
+            const result = job(tx.objectStore(this.table)).catch(reject) as Promise<A>;
+        });
+    }
+
+    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));
+        });
+        return unpackRecord(value);
+    }
+
+    async getAll<A = unknown>(table: string): Promise<Array<A>> {
+        const values = await this.transaction("readonly", (store) => {
+            return request(store.index("table").getAll(table));
+        });
+        return (values as Array<StorageRecord>).map(unpackRecord<A>);
+    }
+
+    async update(table: string, key: unknown, value: unknown): Promise<void> {
+        await this.transaction("readwrite", (store) => {
+            return request(store.put({ table, key, value: serialise(value) }));
+        });
+        this.broadcast?.send({ event: "update", table, key });
+    }
+
+    async delete(table: string, key: unknown): Promise<void> {
+        await this.transaction("readwrite", (store) => {
+            return request(store.delete([table, key as IDBValidKey]));
+        });
+        this.broadcast?.send({ event: "delete", table, key });
+    }
+}

package/src/broadcast.ts

@@ -0,0 +1,27 @@
+import { Emitter } from "@bodil/core/async";
+import { DisposableContext, eventListener } from "@bodil/core/disposable";
+
+/** @internal */
+export class Broadcaster<MessageType> extends Emitter<MessageType> implements Disposable {
+    private readonly channel: BroadcastChannel;
+    private readonly context = new DisposableContext();
+
+    constructor(name: string) {
+        super();
+        this.channel = new BroadcastChannel(name);
+        this.context.use(() => this.channel.close());
+        this.context.use(
+            eventListener(this.channel, "message", ((event: MessageEvent<MessageType>) =>
+                this.emit(event.data)) as EventListener),
+        );
+    }
+
+    override [Symbol.dispose]() {
+        super[Symbol.dispose]();
+        this.context.dispose();
+    }
+
+    send(message: MessageType) {
+        this.channel.postMessage(message);
+    }
+}