@bandeira-tech/b3nd-save 0.8.1 → 0.13.1

package/esm/indexeddb/store.d.ts

@@ -1,9 +1,27 @@
-import type { DeleteResult, Output, StatusResult } from "../deps/jsr.io/@bandeira-tech/b3nd-core/0.22.0/src/types/types.js";
-import { type BytesOnlyEntityMeta } from "../byte-entity-shim.js";
+import type { DeleteResult, Output, StatusResult } from "../deps/jsr.io/@bandeira-tech/b3nd-core/0.25.0/src/types/types.js";
 import type { EntityStore } from "../entity-store.js";
-import type { EntityRecord, EntitySchema } from "../entity.js";
+import { type EntityMeta, type EntityRecord, type EntitySchema } from "../entity.js";
 import type { StoreCapabilities, StoreWriteResult } from "../types.js";
-export declare class IndexedDBStore implements EntityStore<BytesOnlyEntityMeta> {
+import { type FieldPlan } from "./fields.js";
+/**
+ * IndexedDBStore-specific entity handle.
+ *
+ * `storageRoot` is the storage-key prefix under which records of this
+ * entity live (`""` for BYTES_ENTITY, `__entities__/{name}/` for
+ * custom). `isBytes` selects the legacy bytes record shape vs the
+ * verbatim `EntityRecord` shape. `fields`/`declared`/`bytesFields`
+ * drive write-time validation and stream normalisation;
+ * `signature` is used for collision detection.
+ */
+export interface IndexedDBEntityMeta extends EntityMeta {
+    readonly storageRoot: string;
+    readonly isBytes: boolean;
+    readonly fields: readonly FieldPlan[];
+    readonly declared: ReadonlySet<string>;
+    readonly bytesFields: ReadonlySet<string>;
+    readonly signature: string;
+}
+export declare class IndexedDBStore implements EntityStore<IndexedDBEntityMeta> {
     private readonly databaseName;
     private readonly storeName;
     private readonly version;
@@ -19,29 +37,66 @@ export declare class IndexedDBStore implements EntityStore<BytesOnlyEntityMeta>
     });
     private initDB;
     private getStore;
-    entitySupport(schema: EntitySchema): BytesOnlyEntityMeta;
-    entityStatus(meta: BytesOnlyEntityMeta): Promise<"live" | "unprovisioned">;
-    provisionEntity(_meta: BytesOnlyEntityMeta): Promise<void>;
-    write(meta: BytesOnlyEntityMeta, entries: {
+    entitySupport(schema: EntitySchema): IndexedDBEntityMeta;
+    entityStatus(meta: IndexedDBEntityMeta): Promise<"live" | "unprovisioned">;
+    provisionEntity(meta: IndexedDBEntityMeta): Promise<void>;
+    write(meta: IndexedDBEntityMeta, entries: {
         uri: string;
         record: EntityRecord;
     }[]): Promise<StoreWriteResult[]>;
-    read<T = EntityRecord | undefined>(meta: BytesOnlyEntityMeta, urls: string[]): Promise<Output<T>[]>;
-    delete(meta: BytesOnlyEntityMeta, uris: string[]): Promise<DeleteResult[]>;
-    private _writeBytes;
-    private _readBytes;
+    read<T = EntityRecord | undefined>(meta: IndexedDBEntityMeta, urls: string[]): Promise<Output<T>[]>;
     private _readOne;
     /**
-     * Open a cursor over the `uri_index` constrained to the prefix.
-     * Returns URIs (and optionally records) that are direct leaves
-     * under `prefixUri` — i.e. `prefixUri + <segment>` with no further
-     * `/`. Honours sortOrder and limit/page via cursor walking.
+     * Cursor over `uri_index` constrained to `[meta.storageRoot+prefix,
+     * meta.storageRoot+prefix+￿)`. Honours `sortOrder=desc` via `prev`
+     * direction and `limit`/`page` via cursor walking + skipping.
+     *
+     * `shallow` selects the walk shape:
+     *   - `true`  → only direct leaves (the `rest.includes("/")` tail
+     *     cutoff). Powers `fn=ls` and shallow `fn=count`.
+     *   - `false` → every descendant under the prefix, any depth. Powers
+     *     `fn=find` (v2 §3.5). Dispatch applies the glob, sort, cursor,
+     *     limit, format on top.
+     *
+     * Either way the exact-prefix match (`tail === ""`) is skipped — the
+     * URL identifies the parent, not a child of itself.
      */
     private _walkLeaves;
     private _ls;
+    /**
+     * v2 §3.5: recursive walk under the prefix. Same cursor as `_ls` with
+     * `shallow=false` so the `tail.includes("/")` cutoff is dropped —
+     * every descendant flows through, any depth. By the time dispatch
+     * calls us (with `pushDownFind: false`), it has stripped
+     * pattern/cursor/limit/page from `parsed.params`; sortBy is forced to
+     * `"uri"`; format may be either `"full"` or `"uris"`. The handler
+     * returns the raw deep walk in that format; dispatch handles glob
+     * post-filter, sort, cursor, limit, and the cursor-as-trailing-slot.
+     */
+    private _find;
     private _count;
-    private _deleteBytes;
+    delete(meta: IndexedDBEntityMeta, uris: string[]): Promise<DeleteResult[]>;
     status(): Promise<StatusResult>;
     capabilities(): StoreCapabilities;
+    /**
+     * Read the persisted signature for an entity's meta record. Returns
+     * `null` if no provisioning record exists. The meta record lives at
+     * `__meta__/{name}` in the same object store as data records, so a
+     * single object-store cursor sees both layouts without needing a
+     * separate IDB store.
+     */
+    private _readMetaSignature;
+    /**
+     * Scan the meta keyspace for every provisioned entity name. Used by
+     * `status()` to advertise the entities a peer can talk to.
+     */
+    private _listProvisionedEntities;
+    /**
+     * Collect any `ReadableStream` values on `bytes`-tagged fields into
+     * `Uint8Array` and return a shallow-copied record. Non-stream values
+     * pass through; matches the normalisation pattern used by Memory,
+     * Postgres, and LocalStorage.
+     */
+    private _normaliseBytesFields;
 }
 //# sourceMappingURL=store.d.ts.map

package/esm/indexeddb/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/indexeddb/store.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EACV,YAAY,EACZ,MAAM,EACN,YAAY,EACb,MAAM,mEAAmE,CAAC;AAC3E,OAAO,EAEL,KAAK,mBAAmB,EAIzB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAO/D,OAAO,KAAK,EACV,iBAAiB,EAEjB,gBAAgB,EACjB,MAAM,aAAa,CAAC;AAyErB,qBAAa,cAAe,YAAW,WAAW,CAAC,mBAAmB,CAAC;IACrE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0B;IACnD,OAAO,CAAC,EAAE,CAA4B;gBAE1B,MAAM,GAAE;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,GAAG,CAAC;QAEhB,WAAW,CAAC,EAAE,GAAG,CAAC;KACd;IAcN,OAAO,CAAC,MAAM;YAuBA,QAAQ;IAStB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,mBAAmB;IAIxD,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,GAAG,eAAe,CAAC;IAI1E,eAAe,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1D,KAAK,CACH,IAAI,EAAE,mBAAmB,EACzB,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,YAAY,CAAA;KAAE,EAAE,GAC/C,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAS9B,IAAI,CAAC,CAAC,GAAG,YAAY,GAAG,SAAS,EAC/B,IAAI,EAAE,mBAAmB,EACzB,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IASvB,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;YAW5D,WAAW;IA2DzB,OAAO,CAAC,UAAU;YAQJ,QAAQ;IAgBtB;;;;;OAKG;YACW,WAAW;YAuEX,GAAG;YAcH,MAAM;YAYN,YAAY;IAmCpB,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC;IAiBrC,YAAY,IAAI,iBAAiB;CAGlC"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/indexeddb/store.ts"],"names":[],"mappings":"AAgDA,OAAO,KAAK,EACV,YAAY,EACZ,MAAM,EACN,YAAY,EACb,MAAM,mEAAmE,CAAC;AAM3E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAEL,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,YAAY,EAClB,MAAM,cAAc,CAAC;AAEtB,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAoB,KAAK,SAAS,EAAc,MAAM,aAAa,CAAC;AAsF3E;;;;;;;;;GASG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IACtC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACvC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAMD,qBAAa,cAAe,YAAW,WAAW,CAAC,mBAAmB,CAAC;IACrE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0B;IACnD,OAAO,CAAC,EAAE,CAA4B;gBAE1B,MAAM,GAAE;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,GAAG,CAAC;QAEhB,WAAW,CAAC,EAAE,GAAG,CAAC;KACd;IAcN,OAAO,CAAC,MAAM;YAuBA,QAAQ;IAStB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,mBAAmB;IA0ClD,YAAY,CAChB,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,MAAM,GAAG,eAAe,CAAC;IAM9B,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BzD,KAAK,CACT,IAAI,EAAE,mBAAmB,EACzB,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,YAAY,CAAA;KAAE,EAAE,GAC/C,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAyG9B,IAAI,CAAC,CAAC,GAAG,YAAY,GAAG,SAAS,EAC/B,IAAI,EAAE,mBAAmB,EACzB,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YAiBT,QAAQ;IAyBtB;;;;;;;;;;;;;;OAcG;YACW,WAAW;YAoEX,GAAG;IAuBjB;;;;;;;;;OASG;YACW,KAAK;YAuBL,MAAM;IAiBd,MAAM,CACV,IAAI,EAAE,mBAAmB,EACzB,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAAC,YAAY,EAAE,CAAC;IA6CpB,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC;IAkBrC,YAAY,IAAI,iBAAiB;IAMjC;;;;;;OAMG;YACW,kBAAkB;IAkBhC;;;OAGG;YACW,wBAAwB;IAoBtC;;;;;OAKG;YACW,qBAAqB;CAmBpC"}