@procedures/signaldb 0.0.0-stage → 0.24.1

package/dist/storage.js

@@ -0,0 +1,485 @@
+/**
+ * A collection storage over the SignalDB collection of an app (roadmap CLI-23, server stack D9).
+ *
+ * The app owns the SignalDB `Collection`: its persistence, its indexes, its cursors and its
+ * reactivity. `SignalDbStorage` reads and writes the items of that collection through the
+ * `CollectionStorage` contract. Thus the collection is the local copy of a `HybridStorage`, and
+ * the `HybridStorage` owns the sync: the queue, the sync state and the remote.
+ *
+ * The rules:
+ * - Each operation waits for the load of the persistence of the collection (`isReady()`). A failed
+ *   load does not stop the storage: the collection then keeps its items in memory, as SignalDB does.
+ * - A write of SignalDB is synchronous. Each write of the storage reads, tests and writes in one
+ *   synchronous step. Thus two writes do not mix, and a patch and a precondition are atomic.
+ * - A write of several items is one `batch()` of the collection: the indexes and the cursors update
+ *   one time. The validators of the collection examine each item before the first write. Thus an
+ *   item that a validator refuses changes nothing.
+ * - Each write takes a copy of its value, and each read gives a new copy. A cursor of SignalDB gives
+ *   copies (`structuredClone`) of the items, and the storage reads only through cursors.
+ * - `observe()` gives the batches of the writes of the storage, with their origins. It also gives
+ *   each change that the app makes directly on the collection: one batch for each change, with no
+ *   origin. Thus a `HybridStorage` with `capture: "observe"` sends the writes of the app.
+ * - `query()` applies `queryEntries()` to the values. It does not give the selector to SignalDB.
+ *   SignalDB applies Mongo selectors to the items with `mingo`. The contract needs the query
+ *   language of the client on the values.
+ * - `close()` stops the storage. The collection stays open, with its items: the app disposes it.
+ *
+ * The limits:
+ * - A load of the persistence (`persistence.received`) changes the items without the events of a
+ *   change. `observe()` thus does not tell it. The order of the entries after a load is the order of
+ *   the persistence adapter.
+ * - The collection must not have a `transform`: the storage reads the items through cursors.
+ * - Each id is a string. An item of the collection whose `id` is not a string is an error.
+ * - The storage keeps no change log, so it has no `getChangesSince()`. A cursor copies each item,
+ *   so the storage has no cheap `getIds()` either.
+ * - A listener of the app that throws in a write of the storage stops the write, and the write
+ *   rejects. SignalDB keeps the changes before the error. The observers get the changes that the
+ *   storage knows.
+ */
+import { StorageListeners, reportListenerError } from "@procedures/collections";
+import { VersionConflictError, applyPatch, patchProblems, preconditionNotSupported, queryEntries, queryOptionsProblems, selectorProblems, versionConflicts, } from "@procedures/client/query";
+import { documentCodec, isPlainObject } from "./codec.js";
+/** The options of the reads: no reactivity and no field tracking, also in a reactive scope of the app. */
+const READ = { reactive: false, fieldTracking: false };
+/** An id must be a string: it is the key of an item. */
+function checkId(id) {
+    if (typeof id !== "string")
+        throw new TypeError(`An id must be a string, not ${typeof id}`);
+    return id;
+}
+/** A change with the origin of the write, when the write has one. */
+function withOrigin(change, origin) {
+    return origin === undefined ? change : { ...change, origin };
+}
+/**
+ * A collection storage over the SignalDB collection of an app (roadmap CLI-23).
+ *
+ * - The collection keeps the items. The storage keeps nothing of its own, and a new storage of the
+ *   same collection reads the same items.
+ * - `observe()` tells the writes of the storage and the changes that the app makes on the collection.
+ * - `query()` applies a selector, and `patch()` changes an item in one step.
+ * - After `close()`, each operation rejects, and a second `close()` does nothing.
+ *
+ * @example
+ * ```typescript
+ * import { Collection } from "@signaldb/core";
+ * import { ApiStorage, HybridStorage } from "@procedures/store/browser";
+ * import { SignalDbStorage } from "@procedures/signaldb";
+ *
+ * const todos = new Collection<Todo>({ persistence: createIndexedDBAdapter("todos") });
+ * const storage = new HybridStorage<Todo>(new ApiStorage(client, { collection: "todos" }), {
+ *   mode: "write-back",
+ *   local: new SignalDbStorage<Todo>(todos),
+ *   capture: "observe",
+ * });
+ * todos.insert({ id: "t1", title: "Write the docs" }); // the storage sends it to the server
+ * ```
+ */
+export class SignalDbStorage {
+    collection;
+    codec;
+    /** The query policy of a call without a policy */
+    queryPolicy;
+    /** The version of a value, for the preconditions of the writes (roadmap CLI-16) */
+    versionOf;
+    onObserverError;
+    /** The observers of `observe()` */
+    observers;
+    /** The load of the persistence of the collection. A failed load also resolves. */
+    ready;
+    /** True while a write of this storage runs: its events are not changes of the app */
+    writing = false;
+    /** True while the storage listens to the events of the collection */
+    listening = false;
+    closed = false;
+    /**
+     * @param collection - The SignalDB collection of the app. The app owns it, and `close()` does not dispose it.
+     * @param options - The codec, the query policy, `versionOf` and the handler of the errors of the observers.
+     */
+    constructor(collection, options = {}) {
+        if (typeof collection?.find !== "function" || typeof collection.replaceOne !== "function" || typeof collection.on !== "function") {
+            throw new TypeError("SignalDbStorage needs a SignalDB Collection");
+        }
+        this.collection = collection;
+        this.codec = options.codec ?? documentCodec();
+        this.queryPolicy = options.queryPolicy;
+        this.versionOf = options.versionOf;
+        this.onObserverError = options.onObserverError ?? reportListenerError;
+        this.observers = new StorageListeners(this.onObserverError);
+        // The collection still operates in memory after a failed load: the app gets `persistence.error`
+        this.ready = collection.isReady().then(() => undefined, () => undefined);
+    }
+    /** The name of the collection. */
+    get name() {
+        return this.collection.name;
+    }
+    //
+    // ═══ Read Operations ═══
+    //
+    async get(id) {
+        this.checkOpen();
+        checkId(id);
+        await this.whenReady();
+        const current = this.current(id);
+        return current.found ? current.value : undefined;
+    }
+    async getAll() {
+        return (await this.getEntries()).map(([, value]) => value);
+    }
+    /** Every item with its id, in the order of the collection: the order of the first set of each id. */
+    async getEntries() {
+        this.checkOpen();
+        await this.whenReady();
+        return this.collection
+            .find({}, READ)
+            .fetch()
+            .map((raw, index) => this.entryOf(raw, index));
+    }
+    /** The items for which the predicate gives true, in the order of the entries. The predicate gets a copy of each item. */
+    async find(predicate) {
+        return (await this.getAll()).filter((item) => predicate(item));
+    }
+    /**
+     * The entries whose values match the selector, with the order, the skip and the limit of
+     * `queryEntries()`. The policy is the policy of the call, or else of the options. A query that is
+     * not correct rejects with a `TypeError` before the storage reads the collection.
+     */
+    async query(selector, options, policy) {
+        this.checkOpen();
+        const limits = policy ?? this.queryPolicy;
+        const problems = [...selectorProblems(selector, limits), ...queryOptionsProblems(options, limits)];
+        if (problems.length > 0)
+            throw new TypeError(`The query is not correct: ${problems.join(". ")}`);
+        return queryEntries(await this.getEntries(), selector, options, limits);
+    }
+    /**
+     * This method starts to send the changes of the collection to the observer.
+     *
+     * - A write of this storage gives one batch, with the origin of its options, before the write resolves.
+     * - A change that the app makes directly on the collection gives one batch with one change and no
+     *   origin, at once. Examples are `insert`, `updateOne`, `replaceOne` and `removeOne`.
+     * - The observers share each batch. A load of the persistence gives no batch.
+     *
+     * @returns The function that stops the batches. A second use of it does nothing.
+     * @throws Error after `close()`
+     */
+    observe(observer) {
+        this.checkOpen();
+        const remove = this.observers.add(observer);
+        this.listen();
+        let stopped = false;
+        return () => {
+            if (stopped)
+                return;
+            stopped = true;
+            remove();
+            if (this.observers.size === 0)
+                this.unlisten();
+        };
+    }
+    async has(id) {
+        this.checkOpen();
+        checkId(id);
+        await this.whenReady();
+        return this.collection.find({ id }, READ).count() > 0;
+    }
+    async size() {
+        this.checkOpen();
+        await this.whenReady();
+        return this.collection.find({}, READ).count();
+    }
+    //
+    // ═══ Write Operations ═══
+    //
+    async set(id, value, options) {
+        this.checkOpen();
+        checkId(id);
+        const expected = this.preconditions(options?.expectedVersion === undefined ? [] : [[id, options.expectedVersion]]);
+        const write = this.prepare(id, value);
+        await this.whenReady();
+        this.write(options?.origin, (changes) => {
+            this.checkVersions(expected);
+            this.put(write, changes);
+        });
+    }
+    async delete(id, options) {
+        this.checkOpen();
+        checkId(id);
+        const expected = this.preconditions(options?.expectedVersion === undefined ? [] : [[id, options.expectedVersion]]);
+        await this.whenReady();
+        return this.write(options?.origin, (changes) => {
+            this.checkVersions(expected);
+            return this.remove(id, changes);
+        });
+    }
+    /** This method deletes each item of the collection in one batch. A collection with items gives one `clear` change. */
+    async clear(options) {
+        this.checkOpen();
+        await this.whenReady();
+        this.write(options?.origin, (changes) => {
+            let removed = 0;
+            this.batch(() => {
+                removed = this.collection.removeMany({});
+            });
+            if (removed > 0)
+                changes.push({ type: "clear" });
+        });
+    }
+    /**
+     * This method changes the item of the id in one step (a JSON Merge Patch, or the operations
+     * `$set`, `$unset`, `$remove` and `$insert`), and gives a copy of the new item. A missing id stays
+     * missing, and the result is undefined.
+     */
+    async patch(id, fields, options) {
+        this.checkOpen();
+        checkId(id);
+        const [problem] = patchProblems(fields);
+        if (problem !== undefined)
+            throw new TypeError(`The patch of ${JSON.stringify(id)} is not correct: ${problem}`);
+        // A copy: a change of the fields during the wait does not change the patch
+        const own = structuredClone(fields);
+        await this.whenReady();
+        return this.write(options?.origin, (changes) => {
+            const current = this.current(id);
+            if (!current.found)
+                return undefined;
+            const next = applyPatch(current.value, own);
+            this.put({ id, value: next, item: this.itemOf(id, next) }, changes);
+            // The collection keeps `next`: the caller gets its own copy
+            return structuredClone(next);
+        });
+    }
+    //
+    // ═══ Bulk Operations ═══
+    //
+    /**
+     * This method sets several items in one batch of the collection. When one expected version has a
+     * conflict, or a validator of the collection refuses one item, nothing changes.
+     */
+    async setBatch(items, options) {
+        this.checkOpen();
+        for (const [id] of items)
+            checkId(id);
+        const expected = this.preconditions(options?.expectedVersions ?? []);
+        const writes = items.map(([id, value]) => this.prepare(id, value));
+        if (writes.length === 0 && expected.length === 0)
+            return;
+        await this.whenReady();
+        this.write(options?.origin, (changes) => {
+            this.checkVersions(expected);
+            // The validators of the app refuse an item before the first write, so a refusal changes nothing
+            if (writes.length > 1)
+                for (const { item } of writes)
+                    this.collection.emit("validate", item);
+            this.batch(() => {
+                for (const write of writes)
+                    this.put(write, changes);
+            });
+        });
+    }
+    /** This method deletes several items in one batch of the collection. */
+    async deleteBatch(ids, options) {
+        this.checkOpen();
+        for (const id of ids)
+            checkId(id);
+        if (ids.length === 0)
+            return 0;
+        await this.whenReady();
+        return this.write(options?.origin, (changes) => {
+            let deleted = 0;
+            this.batch(() => {
+                for (const id of new Set(ids))
+                    if (this.remove(id, changes))
+                        deleted++;
+            });
+            return deleted;
+        });
+    }
+    async getBatch(ids) {
+        this.checkOpen();
+        for (const id of ids)
+            checkId(id);
+        await this.whenReady();
+        const result = new Map();
+        for (const id of new Set(ids)) {
+            const current = this.current(id);
+            if (current.found)
+                result.set(id, current.value);
+        }
+        return result;
+    }
+    //
+    // ═══ Lifecycle & Metadata ═══
+    //
+    /**
+     * This method stops the storage. The collection stays open, with its items: a new storage of the
+     * collection reads them. After `close()`, each operation rejects, and a second `close()` does nothing.
+     */
+    async close() {
+        if (this.closed)
+            return;
+        this.closed = true;
+        this.observers.clear();
+        this.unlisten();
+    }
+    async getMetadata() {
+        const size = await this.size();
+        return { type: "custom", size, stats: { backend: "signaldb", collection: this.name } };
+    }
+    //
+    // ═══ Internal Helpers ═══
+    //
+    /** This method throws after `close()`. In an async method, the throw rejects the promise. */
+    checkOpen() {
+        if (this.closed)
+            throw new Error(`The SignalDbStorage of the collection ${this.name} is closed`);
+    }
+    /** This method waits for the load of the persistence. A close during the wait rejects. */
+    async whenReady() {
+        await this.ready;
+        this.checkOpen();
+    }
+    problem(what) {
+        return new Error(`The SignalDB collection ${this.name} has ${what}`);
+    }
+    /** The id and the value of an item that a cursor gave. An item without a string id throws. */
+    entryOf(raw, index) {
+        if (!isPlainObject(raw) || typeof raw["id"] !== "string")
+            throw this.problem(`an item without a string id (item ${index + 1})`);
+        return [raw["id"], this.codec.fromItem(raw)];
+    }
+    /** The current value of an id: a copy. */
+    current(id) {
+        const raw = this.collection.findOne({ id }, READ);
+        if (raw === undefined)
+            return { found: false };
+        return { found: true, value: this.entryOf(raw, 0)[1] };
+    }
+    /** The item of a value. The codec must give a plain object with the id. */
+    itemOf(id, value) {
+        const item = this.codec.toItem(id, value);
+        if (!isPlainObject(item) || item["id"] !== id) {
+            throw new TypeError(`The codec of the SignalDbStorage ${this.name} gave no item with the id ${JSON.stringify(id)}`);
+        }
+        return item;
+    }
+    /** A write of a value: a copy of the value, and its item. */
+    prepare(id, value) {
+        const copy = structuredClone(value);
+        return { id, value: copy, item: this.itemOf(id, copy) };
+    }
+    /** This method writes an item. An existing id keeps its place in the order of the entries. */
+    put(write, changes) {
+        this.collection.replaceOne({ id: write.id }, write.item, { upsert: true });
+        changes.push({ type: "set", id: write.id, value: write.value });
+    }
+    /** This method deletes the item of an id. True when the item existed. */
+    remove(id, changes) {
+        if (this.collection.removeOne({ id }) === 0)
+            return false;
+        changes.push({ type: "delete", id });
+        return true;
+    }
+    /**
+     * One write of the storage: `body` reads, tests and writes in one synchronous step. The events of
+     * the collection during the step are not changes of the app. The observers get the changes of the
+     * step after it, also when it fails after a change, with copies of the values.
+     */
+    write(origin, body) {
+        const changes = [];
+        this.writing = true;
+        try {
+            return body(changes);
+        }
+        finally {
+            this.writing = false;
+            if (changes.length > 0 && this.observers.size > 0) {
+                this.observers.emit(changes.map((change) => withOrigin(change.type === "set" ? { ...change, value: structuredClone(change.value) } : change, origin)));
+            }
+        }
+    }
+    /**
+     * One batch of the collection. `Collection.batch()` of SignalDB does not end its batch when the
+     * callback throws, so the error leaves the batch first, and the batch ends.
+     */
+    batch(body) {
+        let failure;
+        this.collection.batch(() => {
+            try {
+                body();
+            }
+            catch (error) {
+                failure = { error };
+            }
+        });
+        if (failure)
+            throw failure.error;
+    }
+    /**
+     * The preconditions of a write. A storage without `versionOf` throws a `TypeError` before the
+     * write starts (roadmap CLI-16).
+     */
+    preconditions(expected) {
+        if (expected.length === 0)
+            return expected;
+        if (!this.versionOf)
+            throw preconditionNotSupported("This SignalDbStorage");
+        for (const [id] of expected)
+            checkId(id);
+        return expected;
+    }
+    /** This method tests the expected versions in the step of the write. A conflict throws `VersionConflictError`. */
+    checkVersions(expected) {
+        if (expected.length === 0 || !this.versionOf)
+            return;
+        const conflicts = versionConflicts(expected, (id) => this.current(id), this.versionOf);
+        if (conflicts.length > 0)
+            throw new VersionConflictError(conflicts);
+    }
+    //
+    // ═══ The changes of the app ═══
+    //
+    onAdded = (item) => this.appChange("set", item);
+    onChanged = (item) => this.appChange("set", item);
+    onRemoved = (item) => this.appChange("delete", item);
+    /** This method starts to listen to the changes of the collection. */
+    listen() {
+        if (this.listening)
+            return;
+        this.listening = true;
+        this.collection.on("added", this.onAdded);
+        this.collection.on("changed", this.onChanged);
+        this.collection.on("removed", this.onRemoved);
+    }
+    /** This method stops to listen to the changes of the collection. */
+    unlisten() {
+        if (!this.listening)
+            return;
+        this.listening = false;
+        this.collection.off("added", this.onAdded);
+        this.collection.off("changed", this.onChanged);
+        this.collection.off("removed", this.onRemoved);
+    }
+    /**
+     * This method gives a change that the app made on the collection to the observers. It does not
+     * throw, because it operates in the write of the app. An item that the storage cannot read goes to
+     * `onObserverError`.
+     */
+    appChange(type, item) {
+        if (this.writing || this.closed || this.observers.size === 0)
+            return;
+        let change;
+        try {
+            const raw = structuredClone(item);
+            if (!isPlainObject(raw) || typeof raw["id"] !== "string")
+                throw this.problem("a changed item without a string id");
+            change = type === "set" ? { type, id: raw["id"], value: this.codec.fromItem(raw) } : { type, id: raw["id"] };
+        }
+        catch (error) {
+            this.onObserverError(error);
+            return;
+        }
+        this.observers.emit([change]);
+    }
+}
+//# sourceMappingURL=storage.js.map

package/dist/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAaH,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAA6B,MAAM,yBAAyB,CAAC;AAC3G,OAAO,EACL,oBAAoB,EACpB,UAAU,EACV,aAAa,EACb,wBAAwB,EACxB,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,GAMjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,aAAa,EAA6C,MAAM,YAAY,CAAC;AAqCrG,0GAA0G;AAC1G,MAAM,IAAI,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAW,CAAC;AAEhE,wDAAwD;AACxD,SAAS,OAAO,CAAC,EAAW;IAC1B,IAAI,OAAO,EAAE,KAAK,QAAQ;QAAE,MAAM,IAAI,SAAS,CAAC,+BAA+B,OAAO,EAAE,EAAE,CAAC,CAAC;IAC5F,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,qEAAqE;AACrE,SAAS,UAAU,CAAI,MAA6B,EAAE,MAA0B;IAC9E,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC;AAC/D,CAAC;AAUD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,eAAe;IACT,UAAU,CAAqB;IAC/B,KAAK,CAAuB;IAC7C,kDAAkD;IACjC,WAAW,CAAiC;IAC7D,mFAAmF;IAClE,SAAS,CAAgD;IACzD,eAAe,CAAuB;IACvD,mCAAmC;IAClB,SAAS,CAA0C;IACpE,kFAAkF;IACjE,KAAK,CAAgB;IACtC,qFAAqF;IAC7E,OAAO,GAAG,KAAK,CAAC;IACxB,qEAAqE;IAC7D,SAAS,GAAG,KAAK,CAAC;IAClB,MAAM,GAAG,KAAK,CAAC;IAEvB;;;OAGG;IACH,YAAY,UAA8B,EAAE,OAAO,GAA8B,EAAE;QACjF,IAAI,OAAO,UAAU,EAAE,IAAI,KAAK,UAAU,IAAI,OAAO,UAAU,CAAC,UAAU,KAAK,UAAU,IAAI,OAAO,UAAU,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;YACjI,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;QACrE,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,aAAa,EAAK,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,mBAAmB,CAAC;QACtE,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAwB,IAAI,CAAC,eAAe,CAAC,CAAC;QACnF,gGAAgG;QAChG,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC,IAAI,CACpC,GAAG,EAAE,CAAC,SAAS,EACf,GAAG,EAAE,CAAC,SAAS,CAChB,CAAC;IACJ,CAAC;IAED,kCAAkC;IAClC,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED,EAAE;IACF,0BAA0B;IAC1B,EAAE;IAEF,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,CAAC,EAAE,CAAC,CAAC;QACZ,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACjC,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,MAAM;QACV,OAAO,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC;IAED,qGAAqG;IACrG,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,UAAU;aACnB,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;aACd,KAAK,EAAE;aACP,GAAG,CAAC,CAAC,GAAY,EAAE,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,yHAAyH;IACzH,KAAK,CAAC,IAAI,CAAC,SAA+B;QACxC,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,QAAyB,EAAE,OAA6B,EAAE,MAA2B;QAC/F,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC;QAC1C,MAAM,QAAQ,GAAG,CAAC,GAAG,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,GAAG,oBAAoB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;QACnG,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,IAAI,SAAS,CAAC,6BAA6B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjG,OAAO,YAAY,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,QAA4B;QAClC,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,OAAO,GAAG,EAAE;YACV,IAAI,OAAO;gBAAE,OAAO;YACpB,OAAO,GAAG,IAAI,CAAC;YACf,MAAM,EAAE,CAAC;YACT,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC;gBAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjD,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,CAAC,EAAE,CAAC,CAAC;QACZ,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;IAChD,CAAC;IAED,EAAE;IACF,2BAA2B;IAC3B,EAAE;IAEF,KAAK,CAAC,GAAG,CAAC,EAAU,EAAE,KAAQ,EAAE,OAAiC;QAC/D,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,CAAC,EAAE,CAAC,CAAC;QACZ,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACnH,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACtC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;YACtC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAiC;QACxD,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,CAAC,EAAE,CAAC,CAAC;QACZ,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACnH,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;YAC7C,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sHAAsH;IACtH,KAAK,CAAC,KAAK,CAAC,OAA6B;QACvC,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;YACtC,IAAI,OAAO,GAAG,CAAC,CAAC;YAChB,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;gBACd,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;YACH,IAAI,OAAO,GAAG,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,EAAU,EAAE,MAAoB,EAAE,OAA6B;QACzE,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,CAAC,EAAE,CAAC,CAAC;QACZ,MAAM,CAAC,OAAO,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,OAAO,KAAK,SAAS;YAAE,MAAM,IAAI,SAAS,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAC;QAChH,2EAA2E;QAC3E,MAAM,GAAG,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;YAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACjC,IAAI,CAAC,OAAO,CAAC,KAAK;gBAAE,OAAO,SAAS,CAAC;YACrC,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAiB,CAAC;YAC5D,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YACpE,4DAA4D;YAC5D,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,EAAE;IACF,0BAA0B;IAC1B,EAAE;IAEF;;;OAGG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAyB,EAAE,OAAkC;QAC1E,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,KAAK;YAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,gBAAgB,IAAI,EAAE,CAAC,CAAC;QACrE,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACnE,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QACzD,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;YACtC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAC7B,gGAAgG;YAChG,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;gBAAE,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,MAAM;oBAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAC7F,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;gBACd,KAAK,MAAM,KAAK,IAAI,MAAM;oBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,wEAAwE;IACxE,KAAK,CAAC,WAAW,CAAC,GAAa,EAAE,OAA6B;QAC5D,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,KAAK,MAAM,EAAE,IAAI,GAAG;YAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;YAC7C,IAAI,OAAO,GAAG,CAAC,CAAC;YAChB,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;gBACd,KAAK,MAAM,EAAE,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC;oBAAE,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC;wBAAE,OAAO,EAAE,CAAC;YACzE,CAAC,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAa;QAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,KAAK,MAAM,EAAE,IAAI,GAAG;YAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QAClC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAa,CAAC;QACpC,KAAK,MAAM,EAAE,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACjC,IAAI,OAAO,CAAC,KAAK;gBAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,EAAE;IACF,+BAA+B;IAC/B,EAAE;IAEF;;;OAGG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;IACzF,CAAC;IAED,EAAE;IACF,2BAA2B;IAC3B,EAAE;IAEF,6FAA6F;IACrF,SAAS;QACf,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,IAAI,YAAY,CAAC,CAAC;IACnG,CAAC;IAED,0FAA0F;IAClF,KAAK,CAAC,SAAS;QACrB,MAAM,IAAI,CAAC,KAAK,CAAC;QACjB,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAEO,OAAO,CAAC,IAAY;QAC1B,OAAO,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,IAAI,QAAQ,IAAI,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,8FAA8F;IACtF,OAAO,CAAC,GAAY,EAAE,KAAa;QACzC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ;YAAE,MAAM,IAAI,CAAC,OAAO,CAAC,qCAAqC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;QAChI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAmB,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,0CAA0C;IAClC,OAAO,CAAC,EAAU;QACxB,MAAM,GAAG,GAAY,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAC3D,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QAC/C,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,CAAC;IAED,2EAA2E;IACnE,MAAM,CAAC,EAAU,EAAE,KAAQ;QACjC,MAAM,IAAI,GAAY,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YAC9C,MAAM,IAAI,SAAS,CAAC,oCAAoC,IAAI,CAAC,IAAI,6BAA6B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACtH,CAAC;QACD,OAAO,IAAoB,CAAC;IAC9B,CAAC;IAED,6DAA6D;IACrD,OAAO,CAAC,EAAU,EAAE,KAAQ;QAClC,MAAM,IAAI,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC;IAC1D,CAAC;IAED,8FAA8F;IACtF,GAAG,CAAC,KAAkB,EAAE,OAAqC;QACnE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3E,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,EAAU,EAAE,OAAqC;QAC9D,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAI,MAA0B,EAAE,IAAkD;QAC7F,MAAM,OAAO,GAAiC,EAAE,CAAC;QACjD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;YACzJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,IAAgB;QAC5B,IAAI,OAAgD,CAAC;QACrD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE;YACzB,IAAI,CAAC;gBACH,IAAI,EAAE,CAAC;YACT,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,GAAG,EAAE,KAAK,EAAE,CAAC;YACtB,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,OAAO;YAAE,MAAM,OAAO,CAAC,KAAK,CAAC;IACnC,CAAC;IAED;;;OAGG;IACK,aAAa,CAAC,QAAyD;QAC7E,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,QAAQ,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,MAAM,wBAAwB,CAAC,sBAAsB,CAAC,CAAC;QAC5E,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,QAAQ;YAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACzC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kHAAkH;IAC1G,aAAa,CAAC,QAAyD;QAC7E,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO;QACrD,MAAM,SAAS,GAAG,gBAAgB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACvF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC;IACtE,CAAC;IAED,EAAE;IACF,iCAAiC;IACjC,EAAE;IAEe,OAAO,GAAG,CAAC,IAAa,EAAQ,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC/D,SAAS,GAAG,CAAC,IAAa,EAAQ,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjE,SAAS,GAAG,CAAC,IAAa,EAAQ,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAErF,qEAAqE;IAC7D,MAAM;QACZ,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAChD,CAAC;IAED,oEAAoE;IAC5D,QAAQ;QACd,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO;QAC5B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACK,SAAS,CAAC,IAAsB,EAAE,IAAa;QACrD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO;QACrE,IAAI,MAA6B,CAAC;QAClC,IAAI,CAAC;YACH,MAAM,GAAG,GAAY,eAAe,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ;gBAAE,MAAM,IAAI,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;YACnH,MAAM,GAAG,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/H,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAC5B,OAAO;QACT,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAChC,CAAC;CACF"}

package/package.json

@@ -1,6 +1,78 @@
 {
+  "$schema": "https://json.schemastore.org/package",
   "name": "@procedures/signaldb",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.24.1",
+  "description": "SignalDbStorage: a CollectionStorage over the SignalDB collection of an app, so the collection is the local copy of a HybridStorage and the app keeps its reactive queries.",
+  "keywords": [
+    "signaldb",
+    "collection-storage",
+    "local-first",
+    "offline",
+    "sync",
+    "reactive",
+    "procedures"
+  ],
+  "homepage": "https://mark1russell7.github.io/client/",
+  "bugs": {
+    "url": "https://github.com/mark1russell7/client/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mark1russell7/client.git",
+    "directory": "packages/signaldb"
+  },
+  "license": "MIT",
+  "author": "Mark Russell (https://github.com/mark1russell7)",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test.tsx",
+    "!src/**/__tests__",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": false,
+  "client": {
+    "browser": [
+      "."
+    ]
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@procedures/client": "0.24.1",
+    "@procedures/collections": "0.24.1"
+  },
+  "peerDependencies": {
+    "@signaldb/core": "^1.8.1"
+  },
+  "devDependencies": {
+    "typescript": "^7.0.2",
+    "@types/node": "^22.0.0",
+    "@mark1russell7/cue": "^1.0.0",
+    "@procedures/store": "0.24.1",
+    "@signaldb/core": "^1.8.1",
+    "vitest": "^5.0.3"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist .tsbuildinfo",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
 }

package/src/codec.ts

@@ -0,0 +1,74 @@
+/**
+ * The form of the values in the items of a SignalDB collection (roadmap CLI-23).
+ *
+ * A `CollectionStorage` keeps any JSON value under a string id. A SignalDB collection keeps objects,
+ * and each object has its key in the field `id`. A codec changes a value to an item and back.
+ *
+ * `documentCodec()` is the default codec:
+ * - A document is a plain object whose field `id` is its key. The item is the document itself, so
+ *   the cursors and the selectors of the app read the document as it is.
+ * - Each other value goes into an envelope: `{ id, __value: value }`. This is a value without the
+ *   field `id`, a value with another `id`, an array, `null`, a string, a number or a boolean.
+ *
+ * An app whose items have another form gives its own codec. For example, an app that keeps the
+ * Mongo key `_id` of a document in the field `id` of the item maps the two fields.
+ */
+
+/** An item of a SignalDB collection: an object with the key of the entry in its field `id`. */
+export interface SignalDbItem {
+  readonly id: string;
+  readonly [field: string]: unknown;
+}
+
+/**
+ * The change of a value to an item of the collection and back. `fromItem(toItem(id, value))` must
+ * give a value that is equal to `value`.
+ */
+export interface SignalDbItemCodec<T> {
+  /**
+   * This function gives the item of a value. The item must be a plain object, and its field `id`
+   * must be the id of the entry. The storage gives a copy of the value, so the item can keep it.
+   */
+  toItem(id: string, value: T): SignalDbItem;
+  /**
+   * This function gives the value of an item. The item is a copy, so the value can keep it. An item
+   * that has no value of this codec throws an error.
+   */
+  fromItem(item: SignalDbItem): T;
+}
+
+/** The field of an envelope that holds a value that is not a document. */
+export const VALUE_FIELD = "__value";
+
+/** True for a plain object: not `null`, not an array, and not an instance of a class. */
+export function isPlainObject(value: unknown): value is Record<string, unknown> {
+  if (typeof value !== "object" || value === null || Array.isArray(value)) return false;
+  const prototype = Object.getPrototypeOf(value) as unknown;
+  return prototype === Object.prototype || prototype === null;
+}
+
+/**
+ * The default codec. A plain object whose `id` is its key is the item itself. Each other value goes
+ * into an envelope with the field `valueField`.
+ *
+ * - A document does not have the field `valueField`: a value with that field goes into an envelope.
+ *   Thus an item with the field is always an envelope, and each value comes back as it was.
+ * - The field `valueField` is reserved. An item of the app with that field reads as an envelope.
+ *
+ * @param valueField - The field of an envelope. The default is `__value`.
+ * @returns The codec
+ */
+export function documentCodec<T>(valueField: string = VALUE_FIELD): SignalDbItemCodec<T> {
+  if (typeof valueField !== "string" || valueField === "" || valueField === "id") {
+    throw new TypeError(`The field of an envelope must be a text that is not empty and not "id", not ${JSON.stringify(valueField)}`);
+  }
+  return {
+    toItem(id: string, value: T): SignalDbItem {
+      if (isPlainObject(value) && value["id"] === id && !Object.hasOwn(value, valueField)) return value as unknown as SignalDbItem;
+      return { id, [valueField]: value };
+    },
+    fromItem(item: SignalDbItem): T {
+      return (Object.hasOwn(item, valueField) ? item[valueField] : item) as T;
+    },
+  };
+}