@xyo-network/diviner-payload-indexeddb 5.2.27 → 5.3.1

package/dist/browser/Config.d.ts

@@ -1,6 +1,8 @@
 import type { IndexDescription } from '@xyo-network/archivist-model';
 import type { DivinerConfig } from '@xyo-network/diviner-model';
-export declare const IndexedDbPayloadDivinerConfigSchema: "network.xyo.diviner.payload.indexeddb.config";
+export declare const IndexedDbPayloadDivinerConfigSchema: string & {
+    readonly __schema: true;
+};
 export type IndexedDbPayloadDivinerConfigSchema = typeof IndexedDbPayloadDivinerConfigSchema;
 export type IndexedDbPayloadDivinerConfig = DivinerConfig<{
     /**

package/dist/browser/Config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAI/D,eAAO,MAAM,mCAAmC,gDAAqD,CAAA;AACrG,MAAM,MAAM,mCAAmC,GAAG,OAAO,mCAAmC,CAAA;AAE5F,MAAM,MAAM,6BAA6B,GAAG,aAAa,CAAC;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,mCAAmC,CAAA;IAC3C;;;OAGG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAC7B,CAAA;IACD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAC,CAAA"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAK/D,eAAO,MAAM,mCAAmC;;CAA4D,CAAA;AAC5G,MAAM,MAAM,mCAAmC,GAAG,OAAO,mCAAmC,CAAA;AAE5F,MAAM,MAAM,6BAA6B,GAAG,aAAa,CAAC;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,mCAAmC,CAAA;IAC3C;;;OAGG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAC7B,CAAA;IACD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAC,CAAA"}

package/dist/browser/Schema.d.ts

@@ -1,3 +1,5 @@
-export declare const IndexedDbPayloadDivinerSchema: "network.xyo.diviner.payload.indexeddb";
+export declare const IndexedDbPayloadDivinerSchema: `${"network.xyo.diviner.payload" & {
+    readonly __schema: true;
+}}.indexeddb`;
 export type IndexedDbPayloadDivinerSchema = typeof IndexedDbPayloadDivinerSchema;
 //# sourceMappingURL=Schema.d.ts.map

package/dist/browser/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,6BAA6B,yCAA+C,CAAA;AACzF,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAA"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,6BAA6B;;aAA+C,CAAA;AACzF,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAA"}

package/dist/browser/index.mjs

@@ -1,9 +1,12 @@
+// src/Config.ts
+import { asSchema } from "@xyo-network/payload-model";
+
 // src/Schema.ts
 import { PayloadDivinerSchema } from "@xyo-network/diviner-payload-model";
 var IndexedDbPayloadDivinerSchema = `${PayloadDivinerSchema}.indexeddb`;
 
 // src/Config.ts
-var IndexedDbPayloadDivinerConfigSchema = `${IndexedDbPayloadDivinerSchema}.config`;
+var IndexedDbPayloadDivinerConfigSchema = asSchema(`${IndexedDbPayloadDivinerSchema}.config`, true);
 
 // src/Diviner.ts
 import {

package/dist/browser/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Schema.ts","../../src/Config.ts","../../src/Diviner.ts"],"sourcesContent":["import { PayloadDivinerSchema } from '@xyo-network/diviner-payload-model'\n\nexport const IndexedDbPayloadDivinerSchema = `${PayloadDivinerSchema}.indexeddb` as const\nexport type IndexedDbPayloadDivinerSchema = typeof IndexedDbPayloadDivinerSchema\n","import type { IndexDescription } from '@xyo-network/archivist-model'\nimport type { DivinerConfig } from '@xyo-network/diviner-model'\n\nimport { IndexedDbPayloadDivinerSchema } from './Schema.ts'\n\nexport const IndexedDbPayloadDivinerConfigSchema = `${IndexedDbPayloadDivinerSchema}.config` as const\nexport type IndexedDbPayloadDivinerConfigSchema = typeof IndexedDbPayloadDivinerConfigSchema\n\nexport type IndexedDbPayloadDivinerConfig = DivinerConfig<{\n  /**\n   * The database name\n   */\n  dbName?: string\n  /**\n   * The version of the DB, defaults to 1\n   */\n  dbVersion?: number\n  schema: IndexedDbPayloadDivinerConfigSchema\n  /**\n   * The storage configuration\n   * // TODO: Hoist to main diviner config\n   */\n  storage?: {\n    /**\n     * The indexes to create on the object store\n     */\n    indexes?: IndexDescription[]\n  }\n  /**\n   * The name of the object store\n   */\n  storeName?: string\n}>\n","/// <reference lib=\"dom\" />\n\nimport {\n  assertEx, containsAll,\n  exists, removeFields,\n} from '@xylabs/sdk-js'\nimport { IndexedDbArchivist } from '@xyo-network/archivist-indexeddb'\nimport type { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model'\nimport { PayloadDiviner } from '@xyo-network/diviner-payload-abstract'\nimport type { PayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model'\nimport { isPayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model'\nimport type {\n  AnyPayload,\n  Payload, Schema, Sequence,\n} from '@xyo-network/payload-model'\nimport type { IDBPCursorWithValue, IDBPDatabase } from 'idb'\nimport { openDB } from 'idb'\n\nimport { IndexedDbPayloadDivinerConfigSchema } from './Config.ts'\nimport type { IndexedDbPayloadDivinerParams } from './Params.ts'\n\ninterface PayloadStore {\n  [s: string]: Payload\n}\n\ntype ValueFilter = (payload?: AnyPayload | null) => boolean\n\nconst payloadValueFilter = (key: keyof AnyPayload, value?: unknown | unknown[]): ValueFilter | undefined => {\n  if (!value) return undefined\n  return (payload) => {\n    if (!payload) return false\n    const sourceValue = payload?.[key]\n    if (sourceValue === undefined) return false\n    return Array.isArray(sourceValue) && Array.isArray(value) ? containsAll(sourceValue, value) : sourceValue == value\n  }\n}\n\nexport class IndexedDbPayloadDiviner<\n  TParams extends IndexedDbPayloadDivinerParams = IndexedDbPayloadDivinerParams,\n  TIn extends PayloadDivinerQueryPayload = PayloadDivinerQueryPayload,\n  TOut extends Payload = Payload,\n  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n    DivinerInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends PayloadDiviner<TParams, TIn, TOut, TEventData> {\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, IndexedDbPayloadDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = IndexedDbPayloadDivinerConfigSchema\n\n  /**\n   * The database name. If not supplied via config, it defaults\n   * to the archivist's name and if archivist's name is not supplied,\n   * it defaults to `archivist`. This behavior\n   * biases towards a single, isolated DB per archivist which seems to\n   * make the most sense for 99% of use cases.\n   */\n  get dbName() {\n    return this.config?.dbName ?? this.config?.archivist ?? IndexedDbArchivist.defaultDbName\n  }\n\n  /**\n   * The database version. If not supplied via config, it defaults to the archivist default version.\n   */\n  get dbVersion() {\n    return this.config?.dbVersion ?? IndexedDbArchivist.defaultDbVersion\n  }\n\n  /**\n   * The name of the object store. If not supplied via config, it defaults\n   * to `payloads`.\n   */\n  get storeName() {\n    return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n  }\n\n  protected override async divineHandler(payloads?: TIn[]): Promise<TOut[]> {\n    const query = payloads?.find(isPayloadDivinerQueryPayload)\n    if (!query) return []\n    const result = await this.tryUseDb(async (db) => {\n      const {\n        schemas, limit, cursor, order, ...props\n      } = removeFields(query, ['schema'])\n      const tx = db.transaction(this.storeName, 'readonly')\n      const store = tx.objectStore(this.storeName)\n      const results: TOut[] = []\n      let parsedCursor = cursor\n      const parsedLimit = limit ?? 10\n      assertEx((schemas?.length ?? 1) === 1, () => 'IndexedDbPayloadDiviner: Only one filter schema supported')\n      const filterSchema = schemas?.[0]\n      const filter = filterSchema ? { schema: filterSchema, ...props } : { ...props }\n      const valueFilters: ValueFilter[] = Object.entries(filter)\n        .map(([key, value]) => payloadValueFilter(key, value))\n        .filter(exists)\n      const direction: IDBCursorDirection = order === 'desc' ? 'prev' : 'next'\n\n      // Iterate all records using the sequence index\n      const sequenceIndex = assertEx(store.index(IndexedDbArchivist.sequenceIndexName), () => 'Failed to get sequence index')\n      let dbCursor: IDBPCursorWithValue<PayloadStore, [string], string, string, 'readonly'> | null\n        = await sequenceIndex.openCursor(null, direction)\n\n      // If a cursor was supplied\n      if (parsedCursor !== undefined) {\n        let currentSequence: Sequence | undefined\n        // Skip records until the supplied cursor offset is reached\n        while (dbCursor && currentSequence !== parsedCursor) {\n          // Find the sequence of the current record\n          currentSequence = await dbCursor.value?.sequence\n          // Advance one record beyond the cursor\n          dbCursor = await dbCursor.advance(1)\n        }\n      }\n\n      // Collect results up to the limit\n      while (dbCursor && results.length < parsedLimit) {\n        const value = dbCursor.value\n        if (value) {\n          // If we're filtering on more than just the schema\n          if (valueFilters.length > 0) {\n            // Ensure all filters pass\n            if (valueFilters.every(filter => filter(value))) {\n              // Then save the value\n              results.push(value)\n            }\n          } else {\n            // Otherwise just save the value\n            results.push(value)\n          }\n        }\n        try {\n          dbCursor = await dbCursor.continue()\n        } catch {\n          break\n        }\n      }\n      await tx.done\n      // Remove any metadata before returning to the client\n      return results\n    })\n    return result ?? []\n  }\n\n  /**\n   * Checks that the desired DB/objectStore exists and is initialized to the correct version\n   * @returns The initialized DB or undefined if it does not exist in the desired state\n   */\n  private async tryGetInitializedDb(): Promise<IDBPDatabase<PayloadStore> | undefined> {\n    // Enumerate the DBs\n    const dbs = await indexedDB.databases()\n    // Check that the DB exists\n    const dbExists = dbs.some((db) => {\n      return db.name === this.dbName\n    })\n    // If the DB exists\n    if (dbExists) {\n      // If the db does exist, open it\n      const db = await openDB<PayloadStore>(this.dbName)\n      // Check that the desired objectStore exists\n      const storeExists = db.objectStoreNames.contains(this.storeName)\n      // If the correct db/version/objectStore exists\n      if (storeExists) {\n        return db\n      } else {\n        // Otherwise close the db so the process that is going to update the\n        // db can open it\n        db.close()\n      }\n    }\n  }\n\n  /**\n   * Executes a callback with the initialized DB and then closes the db\n   * @param callback The method to execute with the initialized DB\n   * @returns\n   */\n  private async tryUseDb<T>(callback: (db: IDBPDatabase<PayloadStore>) => Promise<T> | T): Promise<T | undefined> {\n    // Get the initialized DB\n    const db = await this.tryGetInitializedDb()\n    if (db) {\n      try {\n        // Perform the callback\n        return await callback(db)\n      } finally {\n        // Close the DB\n        db.close()\n      }\n    }\n    return undefined\n  }\n}\n"],"mappings":";AAAA,SAAS,4BAA4B;AAE9B,IAAM,gCAAgC,GAAG,oBAAoB;;;ACG7D,IAAM,sCAAsC,GAAG,6BAA6B;;;ACHnF;AAAA,EACE;AAAA,EAAU;AAAA,EACV;AAAA,EAAQ;AAAA,OACH;AACP,SAAS,0BAA0B;AAEnC,SAAS,sBAAsB;AAE/B,SAAS,oCAAoC;AAM7C,SAAS,cAAc;AAWvB,IAAM,qBAAqB,CAAC,KAAuB,UAAyD;AAC1G,MAAI,CAAC,MAAO,QAAO;AACnB,SAAO,CAAC,YAAY;AAClB,QAAI,CAAC,QAAS,QAAO;AACrB,UAAM,cAAc,UAAU,GAAG;AACjC,QAAI,gBAAgB,OAAW,QAAO;AACtC,WAAO,MAAM,QAAQ,WAAW,KAAK,MAAM,QAAQ,KAAK,IAAI,YAAY,aAAa,KAAK,IAAI,eAAe;AAAA,EAC/G;AACF;AAEO,IAAM,0BAAN,cASG,eAA+C;AAAA,EACvD,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,mCAAmC;AAAA,EAC/G,OAAyB,sBAA8B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASvD,IAAI,SAAS;AACX,WAAO,KAAK,QAAQ,UAAU,KAAK,QAAQ,aAAa,mBAAmB;AAAA,EAC7E;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,YAAY;AACd,WAAO,KAAK,QAAQ,aAAa,mBAAmB;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,YAAY;AACd,WAAO,KAAK,QAAQ,aAAa,mBAAmB;AAAA,EACtD;AAAA,EAEA,MAAyB,cAAc,UAAmC;AACxE,UAAM,QAAQ,UAAU,KAAK,4BAA4B;AACzD,QAAI,CAAC,MAAO,QAAO,CAAC;AACpB,UAAM,SAAS,MAAM,KAAK,SAAS,OAAO,OAAO;AAC/C,YAAM;AAAA,QACJ;AAAA,QAAS;AAAA,QAAO;AAAA,QAAQ;AAAA,QAAO,GAAG;AAAA,MACpC,IAAI,aAAa,OAAO,CAAC,QAAQ,CAAC;AAClC,YAAM,KAAK,GAAG,YAAY,KAAK,WAAW,UAAU;AACpD,YAAM,QAAQ,GAAG,YAAY,KAAK,SAAS;AAC3C,YAAM,UAAkB,CAAC;AACzB,UAAI,eAAe;AACnB,YAAM,cAAc,SAAS;AAC7B,gBAAU,SAAS,UAAU,OAAO,GAAG,MAAM,2DAA2D;AACxG,YAAM,eAAe,UAAU,CAAC;AAChC,YAAM,SAAS,eAAe,EAAE,QAAQ,cAAc,GAAG,MAAM,IAAI,EAAE,GAAG,MAAM;AAC9E,YAAM,eAA8B,OAAO,QAAQ,MAAM,EACtD,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,mBAAmB,KAAK,KAAK,CAAC,EACpD,OAAO,MAAM;AAChB,YAAM,YAAgC,UAAU,SAAS,SAAS;AAGlE,YAAM,gBAAgB,SAAS,MAAM,MAAM,mBAAmB,iBAAiB,GAAG,MAAM,8BAA8B;AACtH,UAAI,WACA,MAAM,cAAc,WAAW,MAAM,SAAS;AAGlD,UAAI,iBAAiB,QAAW;AAC9B,YAAI;AAEJ,eAAO,YAAY,oBAAoB,cAAc;AAEnD,4BAAkB,MAAM,SAAS,OAAO;AAExC,qBAAW,MAAM,SAAS,QAAQ,CAAC;AAAA,QACrC;AAAA,MACF;AAGA,aAAO,YAAY,QAAQ,SAAS,aAAa;AAC/C,cAAM,QAAQ,SAAS;AACvB,YAAI,OAAO;AAET,cAAI,aAAa,SAAS,GAAG;AAE3B,gBAAI,aAAa,MAAM,CAAAA,YAAUA,QAAO,KAAK,CAAC,GAAG;AAE/C,sBAAQ,KAAK,KAAK;AAAA,YACpB;AAAA,UACF,OAAO;AAEL,oBAAQ,KAAK,KAAK;AAAA,UACpB;AAAA,QACF;AACA,YAAI;AACF,qBAAW,MAAM,SAAS,SAAS;AAAA,QACrC,QAAQ;AACN;AAAA,QACF;AAAA,MACF;AACA,YAAM,GAAG;AAET,aAAO;AAAA,IACT,CAAC;AACD,WAAO,UAAU,CAAC;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAc,sBAAuE;AAEnF,UAAM,MAAM,MAAM,UAAU,UAAU;AAEtC,UAAM,WAAW,IAAI,KAAK,CAAC,OAAO;AAChC,aAAO,GAAG,SAAS,KAAK;AAAA,IAC1B,CAAC;AAED,QAAI,UAAU;AAEZ,YAAM,KAAK,MAAM,OAAqB,KAAK,MAAM;AAEjD,YAAM,cAAc,GAAG,iBAAiB,SAAS,KAAK,SAAS;AAE/D,UAAI,aAAa;AACf,eAAO;AAAA,MACT,OAAO;AAGL,WAAG,MAAM;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAc,SAAY,UAAsF;AAE9G,UAAM,KAAK,MAAM,KAAK,oBAAoB;AAC1C,QAAI,IAAI;AACN,UAAI;AAEF,eAAO,MAAM,SAAS,EAAE;AAAA,MAC1B,UAAE;AAEA,WAAG,MAAM;AAAA,MACX;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;","names":["filter"]}
+{"version":3,"sources":["../../src/Config.ts","../../src/Schema.ts","../../src/Diviner.ts"],"sourcesContent":["import type { IndexDescription } from '@xyo-network/archivist-model'\nimport type { DivinerConfig } from '@xyo-network/diviner-model'\nimport { asSchema } from '@xyo-network/payload-model'\n\nimport { IndexedDbPayloadDivinerSchema } from './Schema.ts'\n\nexport const IndexedDbPayloadDivinerConfigSchema = asSchema(`${IndexedDbPayloadDivinerSchema}.config`, true)\nexport type IndexedDbPayloadDivinerConfigSchema = typeof IndexedDbPayloadDivinerConfigSchema\n\nexport type IndexedDbPayloadDivinerConfig = DivinerConfig<{\n  /**\n   * The database name\n   */\n  dbName?: string\n  /**\n   * The version of the DB, defaults to 1\n   */\n  dbVersion?: number\n  schema: IndexedDbPayloadDivinerConfigSchema\n  /**\n   * The storage configuration\n   * // TODO: Hoist to main diviner config\n   */\n  storage?: {\n    /**\n     * The indexes to create on the object store\n     */\n    indexes?: IndexDescription[]\n  }\n  /**\n   * The name of the object store\n   */\n  storeName?: string\n}>\n","import { PayloadDivinerSchema } from '@xyo-network/diviner-payload-model'\n\nexport const IndexedDbPayloadDivinerSchema = `${PayloadDivinerSchema}.indexeddb` as const\nexport type IndexedDbPayloadDivinerSchema = typeof IndexedDbPayloadDivinerSchema\n","/// <reference lib=\"dom\" />\n\nimport {\n  assertEx, containsAll,\n  exists, removeFields,\n} from '@xylabs/sdk-js'\nimport { IndexedDbArchivist } from '@xyo-network/archivist-indexeddb'\nimport type { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model'\nimport { PayloadDiviner } from '@xyo-network/diviner-payload-abstract'\nimport type { PayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model'\nimport { isPayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model'\nimport type {\n  AnyPayload,\n  Payload, Schema, Sequence,\n} from '@xyo-network/payload-model'\nimport type { IDBPCursorWithValue, IDBPDatabase } from 'idb'\nimport { openDB } from 'idb'\n\nimport { IndexedDbPayloadDivinerConfigSchema } from './Config.ts'\nimport type { IndexedDbPayloadDivinerParams } from './Params.ts'\n\ninterface PayloadStore {\n  [s: string]: Payload\n}\n\ntype ValueFilter = (payload?: AnyPayload | null) => boolean\n\nconst payloadValueFilter = (key: keyof AnyPayload, value?: unknown | unknown[]): ValueFilter | undefined => {\n  if (!value) return undefined\n  return (payload) => {\n    if (!payload) return false\n    const sourceValue = payload?.[key]\n    if (sourceValue === undefined) return false\n    return Array.isArray(sourceValue) && Array.isArray(value) ? containsAll(sourceValue, value) : sourceValue == value\n  }\n}\n\nexport class IndexedDbPayloadDiviner<\n  TParams extends IndexedDbPayloadDivinerParams = IndexedDbPayloadDivinerParams,\n  TIn extends PayloadDivinerQueryPayload = PayloadDivinerQueryPayload,\n  TOut extends Payload = Payload,\n  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n    DivinerInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends PayloadDiviner<TParams, TIn, TOut, TEventData> {\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, IndexedDbPayloadDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = IndexedDbPayloadDivinerConfigSchema\n\n  /**\n   * The database name. If not supplied via config, it defaults\n   * to the archivist's name and if archivist's name is not supplied,\n   * it defaults to `archivist`. This behavior\n   * biases towards a single, isolated DB per archivist which seems to\n   * make the most sense for 99% of use cases.\n   */\n  get dbName() {\n    return this.config?.dbName ?? this.config?.archivist ?? IndexedDbArchivist.defaultDbName\n  }\n\n  /**\n   * The database version. If not supplied via config, it defaults to the archivist default version.\n   */\n  get dbVersion() {\n    return this.config?.dbVersion ?? IndexedDbArchivist.defaultDbVersion\n  }\n\n  /**\n   * The name of the object store. If not supplied via config, it defaults\n   * to `payloads`.\n   */\n  get storeName() {\n    return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n  }\n\n  protected override async divineHandler(payloads?: TIn[]): Promise<TOut[]> {\n    const query = payloads?.find(isPayloadDivinerQueryPayload)\n    if (!query) return []\n    const result = await this.tryUseDb(async (db) => {\n      const {\n        schemas, limit, cursor, order, ...props\n      } = removeFields(query, ['schema'])\n      const tx = db.transaction(this.storeName, 'readonly')\n      const store = tx.objectStore(this.storeName)\n      const results: TOut[] = []\n      let parsedCursor = cursor\n      const parsedLimit = limit ?? 10\n      assertEx((schemas?.length ?? 1) === 1, () => 'IndexedDbPayloadDiviner: Only one filter schema supported')\n      const filterSchema = schemas?.[0]\n      const filter = filterSchema ? { schema: filterSchema, ...props } : { ...props }\n      const valueFilters: ValueFilter[] = Object.entries(filter)\n        .map(([key, value]) => payloadValueFilter(key, value))\n        .filter(exists)\n      const direction: IDBCursorDirection = order === 'desc' ? 'prev' : 'next'\n\n      // Iterate all records using the sequence index\n      const sequenceIndex = assertEx(store.index(IndexedDbArchivist.sequenceIndexName), () => 'Failed to get sequence index')\n      let dbCursor: IDBPCursorWithValue<PayloadStore, [string], string, string, 'readonly'> | null\n        = await sequenceIndex.openCursor(null, direction)\n\n      // If a cursor was supplied\n      if (parsedCursor !== undefined) {\n        let currentSequence: Sequence | undefined\n        // Skip records until the supplied cursor offset is reached\n        while (dbCursor && currentSequence !== parsedCursor) {\n          // Find the sequence of the current record\n          currentSequence = await dbCursor.value?.sequence\n          // Advance one record beyond the cursor\n          dbCursor = await dbCursor.advance(1)\n        }\n      }\n\n      // Collect results up to the limit\n      while (dbCursor && results.length < parsedLimit) {\n        const value = dbCursor.value\n        if (value) {\n          // If we're filtering on more than just the schema\n          if (valueFilters.length > 0) {\n            // Ensure all filters pass\n            if (valueFilters.every(filter => filter(value))) {\n              // Then save the value\n              results.push(value)\n            }\n          } else {\n            // Otherwise just save the value\n            results.push(value)\n          }\n        }\n        try {\n          dbCursor = await dbCursor.continue()\n        } catch {\n          break\n        }\n      }\n      await tx.done\n      // Remove any metadata before returning to the client\n      return results\n    })\n    return result ?? []\n  }\n\n  /**\n   * Checks that the desired DB/objectStore exists and is initialized to the correct version\n   * @returns The initialized DB or undefined if it does not exist in the desired state\n   */\n  private async tryGetInitializedDb(): Promise<IDBPDatabase<PayloadStore> | undefined> {\n    // Enumerate the DBs\n    const dbs = await indexedDB.databases()\n    // Check that the DB exists\n    const dbExists = dbs.some((db) => {\n      return db.name === this.dbName\n    })\n    // If the DB exists\n    if (dbExists) {\n      // If the db does exist, open it\n      const db = await openDB<PayloadStore>(this.dbName)\n      // Check that the desired objectStore exists\n      const storeExists = db.objectStoreNames.contains(this.storeName)\n      // If the correct db/version/objectStore exists\n      if (storeExists) {\n        return db\n      } else {\n        // Otherwise close the db so the process that is going to update the\n        // db can open it\n        db.close()\n      }\n    }\n  }\n\n  /**\n   * Executes a callback with the initialized DB and then closes the db\n   * @param callback The method to execute with the initialized DB\n   * @returns\n   */\n  private async tryUseDb<T>(callback: (db: IDBPDatabase<PayloadStore>) => Promise<T> | T): Promise<T | undefined> {\n    // Get the initialized DB\n    const db = await this.tryGetInitializedDb()\n    if (db) {\n      try {\n        // Perform the callback\n        return await callback(db)\n      } finally {\n        // Close the DB\n        db.close()\n      }\n    }\n    return undefined\n  }\n}\n"],"mappings":";AAEA,SAAS,gBAAgB;;;ACFzB,SAAS,4BAA4B;AAE9B,IAAM,gCAAgC,GAAG,oBAAoB;;;ADI7D,IAAM,sCAAsC,SAAS,GAAG,6BAA6B,WAAW,IAAI;;;AEJ3G;AAAA,EACE;AAAA,EAAU;AAAA,EACV;AAAA,EAAQ;AAAA,OACH;AACP,SAAS,0BAA0B;AAEnC,SAAS,sBAAsB;AAE/B,SAAS,oCAAoC;AAM7C,SAAS,cAAc;AAWvB,IAAM,qBAAqB,CAAC,KAAuB,UAAyD;AAC1G,MAAI,CAAC,MAAO,QAAO;AACnB,SAAO,CAAC,YAAY;AAClB,QAAI,CAAC,QAAS,QAAO;AACrB,UAAM,cAAc,UAAU,GAAG;AACjC,QAAI,gBAAgB,OAAW,QAAO;AACtC,WAAO,MAAM,QAAQ,WAAW,KAAK,MAAM,QAAQ,KAAK,IAAI,YAAY,aAAa,KAAK,IAAI,eAAe;AAAA,EAC/G;AACF;AAEO,IAAM,0BAAN,cASG,eAA+C;AAAA,EACvD,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,mCAAmC;AAAA,EAC/G,OAAyB,sBAA8B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASvD,IAAI,SAAS;AACX,WAAO,KAAK,QAAQ,UAAU,KAAK,QAAQ,aAAa,mBAAmB;AAAA,EAC7E;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,YAAY;AACd,WAAO,KAAK,QAAQ,aAAa,mBAAmB;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,YAAY;AACd,WAAO,KAAK,QAAQ,aAAa,mBAAmB;AAAA,EACtD;AAAA,EAEA,MAAyB,cAAc,UAAmC;AACxE,UAAM,QAAQ,UAAU,KAAK,4BAA4B;AACzD,QAAI,CAAC,MAAO,QAAO,CAAC;AACpB,UAAM,SAAS,MAAM,KAAK,SAAS,OAAO,OAAO;AAC/C,YAAM;AAAA,QACJ;AAAA,QAAS;AAAA,QAAO;AAAA,QAAQ;AAAA,QAAO,GAAG;AAAA,MACpC,IAAI,aAAa,OAAO,CAAC,QAAQ,CAAC;AAClC,YAAM,KAAK,GAAG,YAAY,KAAK,WAAW,UAAU;AACpD,YAAM,QAAQ,GAAG,YAAY,KAAK,SAAS;AAC3C,YAAM,UAAkB,CAAC;AACzB,UAAI,eAAe;AACnB,YAAM,cAAc,SAAS;AAC7B,gBAAU,SAAS,UAAU,OAAO,GAAG,MAAM,2DAA2D;AACxG,YAAM,eAAe,UAAU,CAAC;AAChC,YAAM,SAAS,eAAe,EAAE,QAAQ,cAAc,GAAG,MAAM,IAAI,EAAE,GAAG,MAAM;AAC9E,YAAM,eAA8B,OAAO,QAAQ,MAAM,EACtD,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,mBAAmB,KAAK,KAAK,CAAC,EACpD,OAAO,MAAM;AAChB,YAAM,YAAgC,UAAU,SAAS,SAAS;AAGlE,YAAM,gBAAgB,SAAS,MAAM,MAAM,mBAAmB,iBAAiB,GAAG,MAAM,8BAA8B;AACtH,UAAI,WACA,MAAM,cAAc,WAAW,MAAM,SAAS;AAGlD,UAAI,iBAAiB,QAAW;AAC9B,YAAI;AAEJ,eAAO,YAAY,oBAAoB,cAAc;AAEnD,4BAAkB,MAAM,SAAS,OAAO;AAExC,qBAAW,MAAM,SAAS,QAAQ,CAAC;AAAA,QACrC;AAAA,MACF;AAGA,aAAO,YAAY,QAAQ,SAAS,aAAa;AAC/C,cAAM,QAAQ,SAAS;AACvB,YAAI,OAAO;AAET,cAAI,aAAa,SAAS,GAAG;AAE3B,gBAAI,aAAa,MAAM,CAAAA,YAAUA,QAAO,KAAK,CAAC,GAAG;AAE/C,sBAAQ,KAAK,KAAK;AAAA,YACpB;AAAA,UACF,OAAO;AAEL,oBAAQ,KAAK,KAAK;AAAA,UACpB;AAAA,QACF;AACA,YAAI;AACF,qBAAW,MAAM,SAAS,SAAS;AAAA,QACrC,QAAQ;AACN;AAAA,QACF;AAAA,MACF;AACA,YAAM,GAAG;AAET,aAAO;AAAA,IACT,CAAC;AACD,WAAO,UAAU,CAAC;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAc,sBAAuE;AAEnF,UAAM,MAAM,MAAM,UAAU,UAAU;AAEtC,UAAM,WAAW,IAAI,KAAK,CAAC,OAAO;AAChC,aAAO,GAAG,SAAS,KAAK;AAAA,IAC1B,CAAC;AAED,QAAI,UAAU;AAEZ,YAAM,KAAK,MAAM,OAAqB,KAAK,MAAM;AAEjD,YAAM,cAAc,GAAG,iBAAiB,SAAS,KAAK,SAAS;AAE/D,UAAI,aAAa;AACf,eAAO;AAAA,MACT,OAAO;AAGL,WAAG,MAAM;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAc,SAAY,UAAsF;AAE9G,UAAM,KAAK,MAAM,KAAK,oBAAoB;AAC1C,QAAI,IAAI;AACN,UAAI;AAEF,eAAO,MAAM,SAAS,EAAE;AAAA,MAC1B,UAAE;AAEA,WAAG,MAAM;AAAA,MACX;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;","names":["filter"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-payload-indexeddb",
-  "version": "5.2.27",
+  "version": "5.3.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -37,22 +37,22 @@
   ],
   "dependencies": {
     "@xylabs/sdk-js": "~5.0.64",
-    "@xyo-network/archivist-indexeddb": "~5.2.27",
-    "@xyo-network/archivist-model": "~5.2.27",
-    "@xyo-network/diviner-model": "~5.2.27",
-    "@xyo-network/diviner-payload-abstract": "~5.2.27",
-    "@xyo-network/diviner-payload-model": "~5.2.27",
-    "@xyo-network/module-model": "~5.2.27",
-    "@xyo-network/payload-model": "~5.2.27",
+    "@xyo-network/archivist-indexeddb": "~5.3.1",
+    "@xyo-network/archivist-model": "~5.3.1",
+    "@xyo-network/diviner-model": "~5.3.1",
+    "@xyo-network/diviner-payload-abstract": "~5.3.1",
+    "@xyo-network/diviner-payload-model": "~5.3.1",
+    "@xyo-network/module-model": "~5.3.1",
+    "@xyo-network/payload-model": "~5.3.1",
     "idb": "~8.0.3"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "~7.3.2",
     "@xylabs/tsconfig": "~7.3.2",
     "@xylabs/vitest-extended": "~5.0.64",
-    "@xyo-network/archivist-indexeddb": "~5.2.27",
-    "@xyo-network/node-memory": "~5.2.27",
-    "@xyo-network/payload-builder": "~5.2.27",
+    "@xyo-network/archivist-indexeddb": "~5.3.1",
+    "@xyo-network/node-memory": "~5.3.1",
+    "@xyo-network/payload-builder": "~5.3.1",
     "fake-indexeddb": "~6.2.5",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"

package/src/Config.ts

@@ -1,9 +1,10 @@
 import type { IndexDescription } from '@xyo-network/archivist-model'
 import type { DivinerConfig } from '@xyo-network/diviner-model'
+import { asSchema } from '@xyo-network/payload-model'
 
 import { IndexedDbPayloadDivinerSchema } from './Schema.ts'
 
-export const IndexedDbPayloadDivinerConfigSchema = `${IndexedDbPayloadDivinerSchema}.config` as const
+export const IndexedDbPayloadDivinerConfigSchema = asSchema(`${IndexedDbPayloadDivinerSchema}.config`, true)
 export type IndexedDbPayloadDivinerConfigSchema = typeof IndexedDbPayloadDivinerConfigSchema
 
 export type IndexedDbPayloadDivinerConfig = DivinerConfig<{