@xyo-network/diviner-payload-indexeddb 2.87.0-rc.2

package/dist/node/index.cjs

@@ -0,0 +1,171 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  IndexedDbPayloadDiviner: () => IndexedDbPayloadDiviner,
+  IndexedDbPayloadDivinerConfigSchema: () => IndexedDbPayloadDivinerConfigSchema,
+  IndexedDbPayloadDivinerSchema: () => IndexedDbPayloadDivinerSchema
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/Schema.ts
+var import_diviner_payload_model = require("@xyo-network/diviner-payload-model");
+var IndexedDbPayloadDivinerSchema = `${import_diviner_payload_model.PayloadDivinerSchema}.indexeddb`;
+
+// src/Config.ts
+var IndexedDbPayloadDivinerConfigSchema = `${IndexedDbPayloadDivinerSchema}.config`;
+
+// src/Diviner.ts
+var import_assert = require("@xylabs/assert");
+var import_archivist_model = require("@xyo-network/archivist-model");
+var import_diviner_payload_abstract = require("@xyo-network/diviner-payload-abstract");
+var import_diviner_payload_model2 = require("@xyo-network/diviner-payload-model");
+var import_hash = require("@xyo-network/hash");
+var import_idb = require("idb");
+var _IndexedDbPayloadDiviner = class _IndexedDbPayloadDiviner extends import_diviner_payload_abstract.PayloadDiviner {
+  _db;
+  /**
+  * The database name. If not supplied via config it defaults to
+  * `archivist`. This behavior biases towards a single, isolated
+  * DB per archivist which seems to make the most sense for 99% of
+  * use cases.
+  */
+  get dbName() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.dbName) ?? _IndexedDbPayloadDiviner.defaultDbName;
+  }
+  /**
+  * The database version. If not supplied via config, it defaults to 1.
+  */
+  get dbVersion() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.dbVersion) ?? _IndexedDbPayloadDiviner.defaultDbVersion;
+  }
+  /**
+  * The database indexes.
+  */
+  get indexes() {
+    var _a, _b;
+    return ((_b = (_a = this.config) == null ? void 0 : _a.storage) == null ? void 0 : _b.indexes) ?? [];
+  }
+  /**
+  * The name of the object store. If not supplied via config, it defaults
+  * to `payloads`.
+  */
+  get storeName() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.storeName) ?? _IndexedDbPayloadDiviner.defaultStoreName;
+  }
+  get db() {
+    return (0, import_assert.assertEx)(this._db, "DB not initialized");
+  }
+  async divineHandler(payloads) {
+    var _a;
+    const query = (0, import_assert.assertEx)((_a = payloads == null ? void 0 : payloads.filter(import_diviner_payload_model2.isPayloadDivinerQueryPayload)) == null ? void 0 : _a.pop(), "Missing query payload");
+    if (!query)
+      return [];
+    const { schemas, limit, offset, hash, order, schema: _schema, sources, ...props } = query;
+    const tx = this.db.transaction(this.storeName, "readonly");
+    const store = tx.objectStore(this.storeName);
+    const results = [];
+    let parsedOffset = offset ?? 0;
+    const parsedLimit = limit ?? 10;
+    (0, import_assert.assertEx)(((schemas == null ? void 0 : schemas.length) ?? 1) === 1, "IndexedDbPayloadDiviner: Only one filter schema supported");
+    const filterSchema = schemas == null ? void 0 : schemas[0];
+    const filter = filterSchema ? {
+      schema: filterSchema,
+      ...props
+    } : {
+      ...props
+    };
+    const direction = order === "desc" ? "prev" : "next";
+    const suggestedIndex = this.selectBestIndex(filter, store);
+    const filterValues = this.getKeyValuesFromQuery(suggestedIndex, filter);
+    let cursor = suggestedIndex ? await store.index(suggestedIndex).openCursor(IDBKeyRange.only(filterValues.length === 1 ? filterValues[0] : filterValues), direction) : await store.openCursor(suggestedIndex, direction);
+    while (cursor && parsedOffset > 0) {
+      cursor = await cursor.advance(parsedOffset);
+      parsedOffset = 0;
+    }
+    while (cursor && results.length < parsedLimit) {
+      results.push(cursor.value);
+      cursor = await cursor.continue();
+    }
+    await tx.done;
+    return results.map((payload) => import_hash.PayloadHasher.jsonPayload(payload));
+  }
+  async startHandler() {
+    await super.startHandler();
+    this._db = await (0, import_idb.openDB)(this.dbName, this.dbVersion);
+    return true;
+  }
+  getKeyValuesFromQuery(indexName, query) {
+    if (!indexName)
+      return [];
+    const extractFields = /* @__PURE__ */ __name((indexName2) => {
+      return indexName2.slice(3).split(import_archivist_model.IndexSeparator).map((field) => field.toLowerCase());
+    }, "extractFields");
+    const indexFields = extractFields(indexName);
+    return indexFields.map((field) => query[field]);
+  }
+  selectBestIndex(query, store) {
+    const { indexNames } = store;
+    const extractFields = /* @__PURE__ */ __name((indexName) => {
+      return indexName.slice(3).split(import_archivist_model.IndexSeparator).map((field) => field.toLowerCase());
+    }, "extractFields");
+    const queryKeys = new Set(Object.keys(query).map((key) => key.toLowerCase()));
+    let bestMatch = {
+      indexName: "",
+      matchCount: 0
+    };
+    for (const indexName of indexNames) {
+      const indexFields = extractFields(indexName);
+      const matchCount = indexFields.filter((field) => queryKeys.has(field)).length;
+      if (matchCount > bestMatch.matchCount) {
+        bestMatch = {
+          indexName,
+          matchCount
+        };
+      }
+    }
+    return bestMatch.matchCount > 0 ? bestMatch.indexName : null;
+  }
+};
+__name(_IndexedDbPayloadDiviner, "IndexedDbPayloadDiviner");
+__publicField(_IndexedDbPayloadDiviner, "configSchemas", [
+  IndexedDbPayloadDivinerConfigSchema
+]);
+__publicField(_IndexedDbPayloadDiviner, "defaultDbName", "archivist");
+__publicField(_IndexedDbPayloadDiviner, "defaultDbVersion", 1);
+__publicField(_IndexedDbPayloadDiviner, "defaultStoreName", "payloads");
+var IndexedDbPayloadDiviner = _IndexedDbPayloadDiviner;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  IndexedDbPayloadDiviner,
+  IndexedDbPayloadDivinerConfigSchema,
+  IndexedDbPayloadDivinerSchema
+});
+//# sourceMappingURL=index.cjs.map

package/dist/node/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.ts","../../src/Schema.ts","../../src/Config.ts","../../src/Diviner.ts"],"sourcesContent":["export * from './Config'\nexport * from './Diviner'\nexport * from './Params'\nexport * from './Schema'\n","import { PayloadDivinerSchema } from '@xyo-network/diviner-payload-model'\n\nexport const IndexedDbPayloadDivinerSchema = `${PayloadDivinerSchema}.indexeddb`\nexport type IndexedDbPayloadDivinerSchema = typeof IndexedDbPayloadDivinerSchema\n","import { IndexDescription } from '@xyo-network/archivist-model'\nimport { DivinerConfig } from '@xyo-network/diviner-model'\n\nimport { IndexedDbPayloadDivinerSchema } from './Schema'\n\nexport const IndexedDbPayloadDivinerConfigSchema = `${IndexedDbPayloadDivinerSchema}.config`\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 { assertEx } from '@xylabs/assert'\nimport { IndexSeparator } from '@xyo-network/archivist-model'\nimport { DivinerModule, DivinerModuleEventData } from '@xyo-network/diviner-model'\nimport { PayloadDiviner } from '@xyo-network/diviner-payload-abstract'\nimport { isPayloadDivinerQueryPayload, PayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { AnyObject } from '@xyo-network/object'\nimport { Payload } from '@xyo-network/payload-model'\nimport { IDBPDatabase, IDBPObjectStore, openDB } from 'idb'\n\nimport { IndexedDbPayloadDivinerConfigSchema } from './Config'\nimport { IndexedDbPayloadDivinerParams } from './Params'\n\ninterface PayloadStore {\n  [s: string]: Payload\n}\n\nexport class IndexedDbPayloadDiviner<\n  TParams extends IndexedDbPayloadDivinerParams = IndexedDbPayloadDivinerParams,\n  TIn extends PayloadDivinerQueryPayload = PayloadDivinerQueryPayload,\n  TOut extends Payload = Payload,\n  TEventData extends DivinerModuleEventData<DivinerModule<TParams>, TIn, TOut> = DivinerModuleEventData<DivinerModule<TParams>, TIn, TOut>,\n> extends PayloadDiviner<TParams, TIn, TOut, TEventData> {\n  static override configSchemas = [IndexedDbPayloadDivinerConfigSchema]\n  static defaultDbName = 'archivist'\n  static defaultDbVersion = 1\n  static defaultStoreName = 'payloads'\n\n  private _db: IDBPDatabase<PayloadStore> | undefined\n\n  /**\n   * The database name. If not supplied via config it defaults to\n   * `archivist`. This behavior biases towards a single, isolated\n   * DB per archivist which seems to make the most sense for 99% of\n   * use cases.\n   */\n  get dbName() {\n    return this.config?.dbName ?? IndexedDbPayloadDiviner.defaultDbName\n  }\n\n  /**\n   * The database version. If not supplied via config, it defaults to 1.\n   */\n  get dbVersion() {\n    return this.config?.dbVersion ?? IndexedDbPayloadDiviner.defaultDbVersion\n  }\n\n  /**\n   * The database indexes.\n   */\n  get indexes() {\n    return this.config?.storage?.indexes ?? []\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 ?? IndexedDbPayloadDiviner.defaultStoreName\n  }\n\n  private get db(): IDBPDatabase<PayloadStore> {\n    return assertEx(this._db, 'DB not initialized')\n  }\n\n  protected override async divineHandler(payloads?: TIn[]): Promise<TOut[]> {\n    const query = assertEx(payloads?.filter(isPayloadDivinerQueryPayload)?.pop(), 'Missing query payload')\n    if (!query) return []\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { schemas, limit, offset, hash, order, schema: _schema, sources, ...props } = query as unknown as TIn & { sources?: string[] }\n    const tx = this.db.transaction(this.storeName, 'readonly')\n    const store = tx.objectStore(this.storeName)\n    const results: TOut[] = []\n    let parsedOffset = offset ?? 0\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 direction: IDBCursorDirection = order === 'desc' ? 'prev' : 'next'\n    const suggestedIndex = this.selectBestIndex(filter, store)\n    const filterValues = this.getKeyValuesFromQuery(suggestedIndex, filter)\n    let cursor = suggestedIndex\n      ? // Conditionally filter on schemas\n        await store.index(suggestedIndex).openCursor(IDBKeyRange.only(filterValues.length === 1 ? filterValues[0] : filterValues), direction)\n      : // Just iterate all records\n        await store.openCursor(suggestedIndex, direction)\n\n    // Skip records until the offset is reached\n    while (cursor && parsedOffset > 0) {\n      cursor = await cursor.advance(parsedOffset)\n      parsedOffset = 0 // Reset offset after skipping\n    }\n    // Collect results up to the limit\n    while (cursor && results.length < parsedLimit) {\n      results.push(cursor.value)\n      cursor = await cursor.continue()\n    }\n    await tx.done\n    // Remove any metadata before returning to the client\n    return results.map((payload) => PayloadHasher.jsonPayload(payload))\n  }\n\n  protected override async startHandler() {\n    await super.startHandler()\n    // NOTE: We could defer this creation to first access but we\n    // want to fail fast here in case something is wrong\n    this._db = await openDB<PayloadStore>(this.dbName, this.dbVersion)\n    return true\n  }\n\n  private getKeyValuesFromQuery(indexName: string | null, query: AnyObject): unknown[] {\n    if (!indexName) return []\n    // Function to extract fields from an index name\n    const extractFields = (indexName: string): string[] => {\n      return indexName\n        .slice(3)\n        .split(IndexSeparator)\n        .map((field) => field.toLowerCase())\n    }\n\n    // Extracting the relevant fields from the index name\n    const indexFields = extractFields(indexName)\n\n    // Collecting the values for these fields from the query object\n    return indexFields.map((field) => query[field as keyof AnyObject])\n  }\n\n  private selectBestIndex(query: AnyObject, store: IDBPObjectStore<PayloadStore>): string | null {\n    // List of available indexes\n    const { indexNames } = store\n\n    // Function to extract fields from an index name\n    const extractFields = (indexName: string): string[] => {\n      return indexName\n        .slice(3)\n        .split(IndexSeparator)\n        .map((field) => field.toLowerCase())\n    }\n\n    // Convert query object keys to a set for easier comparison\n    const queryKeys = new Set(Object.keys(query).map((key) => key.toLowerCase()))\n\n    // Find the best matching index\n    let bestMatch: { indexName: string; matchCount: number } = { indexName: '', matchCount: 0 }\n\n    for (const indexName of indexNames) {\n      const indexFields = extractFields(indexName)\n      const matchCount = indexFields.filter((field) => queryKeys.has(field)).length\n      if (matchCount > bestMatch.matchCount) {\n        bestMatch = { indexName, matchCount }\n      }\n    }\n    return bestMatch.matchCount > 0 ? bestMatch.indexName : null\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;ACAA,mCAAqC;AAE9B,IAAMA,gCAAgC,GAAGC,iDAAAA;;;ACGzC,IAAMC,sCAAsC,GAAGC,6BAAAA;;;ACLtD,oBAAyB;AACzB,6BAA+B;AAE/B,sCAA+B;AAC/B,IAAAC,gCAAyE;AACzE,kBAA8B;AAG9B,iBAAsD;AAS/C,IAAMC,2BAAN,MAAMA,iCAKHC,+CAAAA;EAMAC;;;;;;;EAQR,IAAIC,SAAS;AApCf;AAqCI,aAAO,UAAKC,WAAL,mBAAaD,WAAUH,yBAAwBK;EACxD;;;;EAKA,IAAIC,YAAY;AA3ClB;AA4CI,aAAO,UAAKF,WAAL,mBAAaE,cAAaN,yBAAwBO;EAC3D;;;;EAKA,IAAIC,UAAU;AAlDhB;AAmDI,aAAO,gBAAKJ,WAAL,mBAAaK,YAAb,mBAAsBD,YAAW,CAAA;EAC1C;;;;;EAMA,IAAIE,YAAY;AA1DlB;AA2DI,aAAO,UAAKN,WAAL,mBAAaM,cAAaV,yBAAwBW;EAC3D;EAEA,IAAYC,KAAiC;AAC3C,eAAOC,wBAAS,KAAKX,KAAK,oBAAA;EAC5B;EAEA,MAAyBY,cAAcC,UAAmC;AAlE5E;AAmEI,UAAMC,YAAQH,yBAASE,0CAAUE,OAAOC,gEAAjBH,mBAAgDI,OAAO,uBAAA;AAC9E,QAAI,CAACH;AAAO,aAAO,CAAA;AAEnB,UAAM,EAAEI,SAASC,OAAOC,QAAQC,MAAMC,OAAOC,QAAQC,SAASC,SAAS,GAAGC,MAAAA,IAAUZ;AACpF,UAAMa,KAAK,KAAKjB,GAAGkB,YAAY,KAAKpB,WAAW,UAAA;AAC/C,UAAMqB,QAAQF,GAAGG,YAAY,KAAKtB,SAAS;AAC3C,UAAMuB,UAAkB,CAAA;AACxB,QAAIC,eAAeZ,UAAU;AAC7B,UAAMa,cAAcd,SAAS;AAC7BR,kCAAUO,mCAASgB,WAAU,OAAO,GAAG,2DAAA;AACvC,UAAMC,eAAejB,mCAAU;AAC/B,UAAMH,SAASoB,eAAe;MAAEZ,QAAQY;MAAc,GAAGT;IAAM,IAAI;MAAE,GAAGA;IAAM;AAC9E,UAAMU,YAAgCd,UAAU,SAAS,SAAS;AAClE,UAAMe,iBAAiB,KAAKC,gBAAgBvB,QAAQc,KAAAA;AACpD,UAAMU,eAAe,KAAKC,sBAAsBH,gBAAgBtB,MAAAA;AAChE,QAAI0B,SAASJ,iBAET,MAAMR,MAAMa,MAAML,cAAAA,EAAgBM,WAAWC,YAAYC,KAAKN,aAAaL,WAAW,IAAIK,aAAa,CAAA,IAAKA,YAAAA,GAAeH,SAAAA,IAE3H,MAAMP,MAAMc,WAAWN,gBAAgBD,SAAAA;AAG3C,WAAOK,UAAUT,eAAe,GAAG;AACjCS,eAAS,MAAMA,OAAOK,QAAQd,YAAAA;AAC9BA,qBAAe;IACjB;AAEA,WAAOS,UAAUV,QAAQG,SAASD,aAAa;AAC7CF,cAAQgB,KAAKN,OAAOO,KAAK;AACzBP,eAAS,MAAMA,OAAOQ,SAAQ;IAChC;AACA,UAAMtB,GAAGuB;AAET,WAAOnB,QAAQoB,IAAI,CAACC,YAAYC,0BAAcC,YAAYF,OAAAA,CAAAA;EAC5D;EAEA,MAAyBG,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,SAAKvD,MAAM,UAAMwD,mBAAqB,KAAKvD,QAAQ,KAAKG,SAAS;AACjE,WAAO;EACT;EAEQoC,sBAAsBiB,WAA0B3C,OAA6B;AACnF,QAAI,CAAC2C;AAAW,aAAO,CAAA;AAEvB,UAAMC,gBAAgB,wBAACD,eAAAA;AACrB,aAAOA,WACJE,MAAM,CAAA,EACNC,MAAMC,qCAAAA,EACNV,IAAI,CAACW,UAAUA,MAAMC,YAAW,CAAA;IACrC,GALsB;AAQtB,UAAMC,cAAcN,cAAcD,SAAAA;AAGlC,WAAOO,YAAYb,IAAI,CAACW,UAAUhD,MAAMgD,KAAAA,CAAyB;EACnE;EAEQxB,gBAAgBxB,OAAkBe,OAAqD;AAE7F,UAAM,EAAEoC,WAAU,IAAKpC;AAGvB,UAAM6B,gBAAgB,wBAACD,cAAAA;AACrB,aAAOA,UACJE,MAAM,CAAA,EACNC,MAAMC,qCAAAA,EACNV,IAAI,CAACW,UAAUA,MAAMC,YAAW,CAAA;IACrC,GALsB;AAQtB,UAAMG,YAAY,IAAIC,IAAIC,OAAOC,KAAKvD,KAAAA,EAAOqC,IAAI,CAACmB,QAAQA,IAAIP,YAAW,CAAA,CAAA;AAGzE,QAAIQ,YAAuD;MAAEd,WAAW;MAAIe,YAAY;IAAE;AAE1F,eAAWf,aAAaQ,YAAY;AAClC,YAAMD,cAAcN,cAAcD,SAAAA;AAClC,YAAMe,aAAaR,YAAYjD,OAAO,CAAC+C,UAAUI,UAAUO,IAAIX,KAAAA,CAAAA,EAAQ5B;AACvE,UAAIsC,aAAaD,UAAUC,YAAY;AACrCD,oBAAY;UAAEd;UAAWe;QAAW;MACtC;IACF;AACA,WAAOD,UAAUC,aAAa,IAAID,UAAUd,YAAY;EAC1D;AACF;AArIU1D;AACR,cANWD,0BAMK4E,iBAAgB;EAACC;;AACjC,cAPW7E,0BAOJK,iBAAgB;AACvB,cARWL,0BAQJO,oBAAmB;AAC1B,cATWP,0BASJW,oBAAmB;AATrB,IAAMX,0BAAN;","names":["IndexedDbPayloadDivinerSchema","PayloadDivinerSchema","IndexedDbPayloadDivinerConfigSchema","IndexedDbPayloadDivinerSchema","import_diviner_payload_model","IndexedDbPayloadDiviner","PayloadDiviner","_db","dbName","config","defaultDbName","dbVersion","defaultDbVersion","indexes","storage","storeName","defaultStoreName","db","assertEx","divineHandler","payloads","query","filter","isPayloadDivinerQueryPayload","pop","schemas","limit","offset","hash","order","schema","_schema","sources","props","tx","transaction","store","objectStore","results","parsedOffset","parsedLimit","length","filterSchema","direction","suggestedIndex","selectBestIndex","filterValues","getKeyValuesFromQuery","cursor","index","openCursor","IDBKeyRange","only","advance","push","value","continue","done","map","payload","PayloadHasher","jsonPayload","startHandler","openDB","indexName","extractFields","slice","split","IndexSeparator","field","toLowerCase","indexFields","indexNames","queryKeys","Set","Object","keys","key","bestMatch","matchCount","has","configSchemas","IndexedDbPayloadDivinerConfigSchema"]}

package/dist/node/index.d.cts

@@ -0,0 +1,5 @@
+export * from './Config';
+export * from './Diviner';
+export * from './Params';
+export * from './Schema';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA"}

package/dist/node/index.d.mts

@@ -0,0 +1,5 @@
+export * from './Config';
+export * from './Diviner';
+export * from './Params';
+export * from './Schema';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA"}

package/dist/node/index.d.ts

@@ -0,0 +1,5 @@
+export * from './Config';
+export * from './Diviner';
+export * from './Params';
+export * from './Schema';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA"}

package/dist/node/index.js

@@ -0,0 +1,144 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+// src/Schema.ts
+import { PayloadDivinerSchema } from "@xyo-network/diviner-payload-model";
+var IndexedDbPayloadDivinerSchema = `${PayloadDivinerSchema}.indexeddb`;
+
+// src/Config.ts
+var IndexedDbPayloadDivinerConfigSchema = `${IndexedDbPayloadDivinerSchema}.config`;
+
+// src/Diviner.ts
+import { assertEx } from "@xylabs/assert";
+import { IndexSeparator } from "@xyo-network/archivist-model";
+import { PayloadDiviner } from "@xyo-network/diviner-payload-abstract";
+import { isPayloadDivinerQueryPayload } from "@xyo-network/diviner-payload-model";
+import { PayloadHasher } from "@xyo-network/hash";
+import { openDB } from "idb";
+var _IndexedDbPayloadDiviner = class _IndexedDbPayloadDiviner extends PayloadDiviner {
+  _db;
+  /**
+  * The database name. If not supplied via config it defaults to
+  * `archivist`. This behavior biases towards a single, isolated
+  * DB per archivist which seems to make the most sense for 99% of
+  * use cases.
+  */
+  get dbName() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.dbName) ?? _IndexedDbPayloadDiviner.defaultDbName;
+  }
+  /**
+  * The database version. If not supplied via config, it defaults to 1.
+  */
+  get dbVersion() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.dbVersion) ?? _IndexedDbPayloadDiviner.defaultDbVersion;
+  }
+  /**
+  * The database indexes.
+  */
+  get indexes() {
+    var _a, _b;
+    return ((_b = (_a = this.config) == null ? void 0 : _a.storage) == null ? void 0 : _b.indexes) ?? [];
+  }
+  /**
+  * The name of the object store. If not supplied via config, it defaults
+  * to `payloads`.
+  */
+  get storeName() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.storeName) ?? _IndexedDbPayloadDiviner.defaultStoreName;
+  }
+  get db() {
+    return assertEx(this._db, "DB not initialized");
+  }
+  async divineHandler(payloads) {
+    var _a;
+    const query = assertEx((_a = payloads == null ? void 0 : payloads.filter(isPayloadDivinerQueryPayload)) == null ? void 0 : _a.pop(), "Missing query payload");
+    if (!query)
+      return [];
+    const { schemas, limit, offset, hash, order, schema: _schema, sources, ...props } = query;
+    const tx = this.db.transaction(this.storeName, "readonly");
+    const store = tx.objectStore(this.storeName);
+    const results = [];
+    let parsedOffset = offset ?? 0;
+    const parsedLimit = limit ?? 10;
+    assertEx(((schemas == null ? void 0 : schemas.length) ?? 1) === 1, "IndexedDbPayloadDiviner: Only one filter schema supported");
+    const filterSchema = schemas == null ? void 0 : schemas[0];
+    const filter = filterSchema ? {
+      schema: filterSchema,
+      ...props
+    } : {
+      ...props
+    };
+    const direction = order === "desc" ? "prev" : "next";
+    const suggestedIndex = this.selectBestIndex(filter, store);
+    const filterValues = this.getKeyValuesFromQuery(suggestedIndex, filter);
+    let cursor = suggestedIndex ? await store.index(suggestedIndex).openCursor(IDBKeyRange.only(filterValues.length === 1 ? filterValues[0] : filterValues), direction) : await store.openCursor(suggestedIndex, direction);
+    while (cursor && parsedOffset > 0) {
+      cursor = await cursor.advance(parsedOffset);
+      parsedOffset = 0;
+    }
+    while (cursor && results.length < parsedLimit) {
+      results.push(cursor.value);
+      cursor = await cursor.continue();
+    }
+    await tx.done;
+    return results.map((payload) => PayloadHasher.jsonPayload(payload));
+  }
+  async startHandler() {
+    await super.startHandler();
+    this._db = await openDB(this.dbName, this.dbVersion);
+    return true;
+  }
+  getKeyValuesFromQuery(indexName, query) {
+    if (!indexName)
+      return [];
+    const extractFields = /* @__PURE__ */ __name((indexName2) => {
+      return indexName2.slice(3).split(IndexSeparator).map((field) => field.toLowerCase());
+    }, "extractFields");
+    const indexFields = extractFields(indexName);
+    return indexFields.map((field) => query[field]);
+  }
+  selectBestIndex(query, store) {
+    const { indexNames } = store;
+    const extractFields = /* @__PURE__ */ __name((indexName) => {
+      return indexName.slice(3).split(IndexSeparator).map((field) => field.toLowerCase());
+    }, "extractFields");
+    const queryKeys = new Set(Object.keys(query).map((key) => key.toLowerCase()));
+    let bestMatch = {
+      indexName: "",
+      matchCount: 0
+    };
+    for (const indexName of indexNames) {
+      const indexFields = extractFields(indexName);
+      const matchCount = indexFields.filter((field) => queryKeys.has(field)).length;
+      if (matchCount > bestMatch.matchCount) {
+        bestMatch = {
+          indexName,
+          matchCount
+        };
+      }
+    }
+    return bestMatch.matchCount > 0 ? bestMatch.indexName : null;
+  }
+};
+__name(_IndexedDbPayloadDiviner, "IndexedDbPayloadDiviner");
+__publicField(_IndexedDbPayloadDiviner, "configSchemas", [
+  IndexedDbPayloadDivinerConfigSchema
+]);
+__publicField(_IndexedDbPayloadDiviner, "defaultDbName", "archivist");
+__publicField(_IndexedDbPayloadDiviner, "defaultDbVersion", 1);
+__publicField(_IndexedDbPayloadDiviner, "defaultStoreName", "payloads");
+var IndexedDbPayloadDiviner = _IndexedDbPayloadDiviner;
+export {
+  IndexedDbPayloadDiviner,
+  IndexedDbPayloadDivinerConfigSchema,
+  IndexedDbPayloadDivinerSchema
+};
+//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -0,0 +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`\nexport type IndexedDbPayloadDivinerSchema = typeof IndexedDbPayloadDivinerSchema\n","import { IndexDescription } from '@xyo-network/archivist-model'\nimport { DivinerConfig } from '@xyo-network/diviner-model'\n\nimport { IndexedDbPayloadDivinerSchema } from './Schema'\n\nexport const IndexedDbPayloadDivinerConfigSchema = `${IndexedDbPayloadDivinerSchema}.config`\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 { assertEx } from '@xylabs/assert'\nimport { IndexSeparator } from '@xyo-network/archivist-model'\nimport { DivinerModule, DivinerModuleEventData } from '@xyo-network/diviner-model'\nimport { PayloadDiviner } from '@xyo-network/diviner-payload-abstract'\nimport { isPayloadDivinerQueryPayload, PayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { AnyObject } from '@xyo-network/object'\nimport { Payload } from '@xyo-network/payload-model'\nimport { IDBPDatabase, IDBPObjectStore, openDB } from 'idb'\n\nimport { IndexedDbPayloadDivinerConfigSchema } from './Config'\nimport { IndexedDbPayloadDivinerParams } from './Params'\n\ninterface PayloadStore {\n  [s: string]: Payload\n}\n\nexport class IndexedDbPayloadDiviner<\n  TParams extends IndexedDbPayloadDivinerParams = IndexedDbPayloadDivinerParams,\n  TIn extends PayloadDivinerQueryPayload = PayloadDivinerQueryPayload,\n  TOut extends Payload = Payload,\n  TEventData extends DivinerModuleEventData<DivinerModule<TParams>, TIn, TOut> = DivinerModuleEventData<DivinerModule<TParams>, TIn, TOut>,\n> extends PayloadDiviner<TParams, TIn, TOut, TEventData> {\n  static override configSchemas = [IndexedDbPayloadDivinerConfigSchema]\n  static defaultDbName = 'archivist'\n  static defaultDbVersion = 1\n  static defaultStoreName = 'payloads'\n\n  private _db: IDBPDatabase<PayloadStore> | undefined\n\n  /**\n   * The database name. If not supplied via config it defaults to\n   * `archivist`. This behavior biases towards a single, isolated\n   * DB per archivist which seems to make the most sense for 99% of\n   * use cases.\n   */\n  get dbName() {\n    return this.config?.dbName ?? IndexedDbPayloadDiviner.defaultDbName\n  }\n\n  /**\n   * The database version. If not supplied via config, it defaults to 1.\n   */\n  get dbVersion() {\n    return this.config?.dbVersion ?? IndexedDbPayloadDiviner.defaultDbVersion\n  }\n\n  /**\n   * The database indexes.\n   */\n  get indexes() {\n    return this.config?.storage?.indexes ?? []\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 ?? IndexedDbPayloadDiviner.defaultStoreName\n  }\n\n  private get db(): IDBPDatabase<PayloadStore> {\n    return assertEx(this._db, 'DB not initialized')\n  }\n\n  protected override async divineHandler(payloads?: TIn[]): Promise<TOut[]> {\n    const query = assertEx(payloads?.filter(isPayloadDivinerQueryPayload)?.pop(), 'Missing query payload')\n    if (!query) return []\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { schemas, limit, offset, hash, order, schema: _schema, sources, ...props } = query as unknown as TIn & { sources?: string[] }\n    const tx = this.db.transaction(this.storeName, 'readonly')\n    const store = tx.objectStore(this.storeName)\n    const results: TOut[] = []\n    let parsedOffset = offset ?? 0\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 direction: IDBCursorDirection = order === 'desc' ? 'prev' : 'next'\n    const suggestedIndex = this.selectBestIndex(filter, store)\n    const filterValues = this.getKeyValuesFromQuery(suggestedIndex, filter)\n    let cursor = suggestedIndex\n      ? // Conditionally filter on schemas\n        await store.index(suggestedIndex).openCursor(IDBKeyRange.only(filterValues.length === 1 ? filterValues[0] : filterValues), direction)\n      : // Just iterate all records\n        await store.openCursor(suggestedIndex, direction)\n\n    // Skip records until the offset is reached\n    while (cursor && parsedOffset > 0) {\n      cursor = await cursor.advance(parsedOffset)\n      parsedOffset = 0 // Reset offset after skipping\n    }\n    // Collect results up to the limit\n    while (cursor && results.length < parsedLimit) {\n      results.push(cursor.value)\n      cursor = await cursor.continue()\n    }\n    await tx.done\n    // Remove any metadata before returning to the client\n    return results.map((payload) => PayloadHasher.jsonPayload(payload))\n  }\n\n  protected override async startHandler() {\n    await super.startHandler()\n    // NOTE: We could defer this creation to first access but we\n    // want to fail fast here in case something is wrong\n    this._db = await openDB<PayloadStore>(this.dbName, this.dbVersion)\n    return true\n  }\n\n  private getKeyValuesFromQuery(indexName: string | null, query: AnyObject): unknown[] {\n    if (!indexName) return []\n    // Function to extract fields from an index name\n    const extractFields = (indexName: string): string[] => {\n      return indexName\n        .slice(3)\n        .split(IndexSeparator)\n        .map((field) => field.toLowerCase())\n    }\n\n    // Extracting the relevant fields from the index name\n    const indexFields = extractFields(indexName)\n\n    // Collecting the values for these fields from the query object\n    return indexFields.map((field) => query[field as keyof AnyObject])\n  }\n\n  private selectBestIndex(query: AnyObject, store: IDBPObjectStore<PayloadStore>): string | null {\n    // List of available indexes\n    const { indexNames } = store\n\n    // Function to extract fields from an index name\n    const extractFields = (indexName: string): string[] => {\n      return indexName\n        .slice(3)\n        .split(IndexSeparator)\n        .map((field) => field.toLowerCase())\n    }\n\n    // Convert query object keys to a set for easier comparison\n    const queryKeys = new Set(Object.keys(query).map((key) => key.toLowerCase()))\n\n    // Find the best matching index\n    let bestMatch: { indexName: string; matchCount: number } = { indexName: '', matchCount: 0 }\n\n    for (const indexName of indexNames) {\n      const indexFields = extractFields(indexName)\n      const matchCount = indexFields.filter((field) => queryKeys.has(field)).length\n      if (matchCount > bestMatch.matchCount) {\n        bestMatch = { indexName, matchCount }\n      }\n    }\n    return bestMatch.matchCount > 0 ? bestMatch.indexName : null\n  }\n}\n"],"mappings":";;;;;;;;;AAAA,SAASA,4BAA4B;AAE9B,IAAMC,gCAAgC,GAAGD,oBAAAA;;;ACGzC,IAAME,sCAAsC,GAAGC,6BAAAA;;;ACLtD,SAASC,gBAAgB;AACzB,SAASC,sBAAsB;AAE/B,SAASC,sBAAsB;AAC/B,SAASC,oCAAgE;AACzE,SAASC,qBAAqB;AAG9B,SAAwCC,cAAc;AAS/C,IAAMC,2BAAN,MAAMA,iCAKHC,eAAAA;EAMAC;;;;;;;EAQR,IAAIC,SAAS;AApCf;AAqCI,aAAO,UAAKC,WAAL,mBAAaD,WAAUH,yBAAwBK;EACxD;;;;EAKA,IAAIC,YAAY;AA3ClB;AA4CI,aAAO,UAAKF,WAAL,mBAAaE,cAAaN,yBAAwBO;EAC3D;;;;EAKA,IAAIC,UAAU;AAlDhB;AAmDI,aAAO,gBAAKJ,WAAL,mBAAaK,YAAb,mBAAsBD,YAAW,CAAA;EAC1C;;;;;EAMA,IAAIE,YAAY;AA1DlB;AA2DI,aAAO,UAAKN,WAAL,mBAAaM,cAAaV,yBAAwBW;EAC3D;EAEA,IAAYC,KAAiC;AAC3C,WAAOC,SAAS,KAAKX,KAAK,oBAAA;EAC5B;EAEA,MAAyBY,cAAcC,UAAmC;AAlE5E;AAmEI,UAAMC,QAAQH,UAASE,0CAAUE,OAAOC,kCAAjBH,mBAAgDI,OAAO,uBAAA;AAC9E,QAAI,CAACH;AAAO,aAAO,CAAA;AAEnB,UAAM,EAAEI,SAASC,OAAOC,QAAQC,MAAMC,OAAOC,QAAQC,SAASC,SAAS,GAAGC,MAAAA,IAAUZ;AACpF,UAAMa,KAAK,KAAKjB,GAAGkB,YAAY,KAAKpB,WAAW,UAAA;AAC/C,UAAMqB,QAAQF,GAAGG,YAAY,KAAKtB,SAAS;AAC3C,UAAMuB,UAAkB,CAAA;AACxB,QAAIC,eAAeZ,UAAU;AAC7B,UAAMa,cAAcd,SAAS;AAC7BR,eAAUO,mCAASgB,WAAU,OAAO,GAAG,2DAAA;AACvC,UAAMC,eAAejB,mCAAU;AAC/B,UAAMH,SAASoB,eAAe;MAAEZ,QAAQY;MAAc,GAAGT;IAAM,IAAI;MAAE,GAAGA;IAAM;AAC9E,UAAMU,YAAgCd,UAAU,SAAS,SAAS;AAClE,UAAMe,iBAAiB,KAAKC,gBAAgBvB,QAAQc,KAAAA;AACpD,UAAMU,eAAe,KAAKC,sBAAsBH,gBAAgBtB,MAAAA;AAChE,QAAI0B,SAASJ,iBAET,MAAMR,MAAMa,MAAML,cAAAA,EAAgBM,WAAWC,YAAYC,KAAKN,aAAaL,WAAW,IAAIK,aAAa,CAAA,IAAKA,YAAAA,GAAeH,SAAAA,IAE3H,MAAMP,MAAMc,WAAWN,gBAAgBD,SAAAA;AAG3C,WAAOK,UAAUT,eAAe,GAAG;AACjCS,eAAS,MAAMA,OAAOK,QAAQd,YAAAA;AAC9BA,qBAAe;IACjB;AAEA,WAAOS,UAAUV,QAAQG,SAASD,aAAa;AAC7CF,cAAQgB,KAAKN,OAAOO,KAAK;AACzBP,eAAS,MAAMA,OAAOQ,SAAQ;IAChC;AACA,UAAMtB,GAAGuB;AAET,WAAOnB,QAAQoB,IAAI,CAACC,YAAYC,cAAcC,YAAYF,OAAAA,CAAAA;EAC5D;EAEA,MAAyBG,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,SAAKvD,MAAM,MAAMwD,OAAqB,KAAKvD,QAAQ,KAAKG,SAAS;AACjE,WAAO;EACT;EAEQoC,sBAAsBiB,WAA0B3C,OAA6B;AACnF,QAAI,CAAC2C;AAAW,aAAO,CAAA;AAEvB,UAAMC,gBAAgB,wBAACD,eAAAA;AACrB,aAAOA,WACJE,MAAM,CAAA,EACNC,MAAMC,cAAAA,EACNV,IAAI,CAACW,UAAUA,MAAMC,YAAW,CAAA;IACrC,GALsB;AAQtB,UAAMC,cAAcN,cAAcD,SAAAA;AAGlC,WAAOO,YAAYb,IAAI,CAACW,UAAUhD,MAAMgD,KAAAA,CAAyB;EACnE;EAEQxB,gBAAgBxB,OAAkBe,OAAqD;AAE7F,UAAM,EAAEoC,WAAU,IAAKpC;AAGvB,UAAM6B,gBAAgB,wBAACD,cAAAA;AACrB,aAAOA,UACJE,MAAM,CAAA,EACNC,MAAMC,cAAAA,EACNV,IAAI,CAACW,UAAUA,MAAMC,YAAW,CAAA;IACrC,GALsB;AAQtB,UAAMG,YAAY,IAAIC,IAAIC,OAAOC,KAAKvD,KAAAA,EAAOqC,IAAI,CAACmB,QAAQA,IAAIP,YAAW,CAAA,CAAA;AAGzE,QAAIQ,YAAuD;MAAEd,WAAW;MAAIe,YAAY;IAAE;AAE1F,eAAWf,aAAaQ,YAAY;AAClC,YAAMD,cAAcN,cAAcD,SAAAA;AAClC,YAAMe,aAAaR,YAAYjD,OAAO,CAAC+C,UAAUI,UAAUO,IAAIX,KAAAA,CAAAA,EAAQ5B;AACvE,UAAIsC,aAAaD,UAAUC,YAAY;AACrCD,oBAAY;UAAEd;UAAWe;QAAW;MACtC;IACF;AACA,WAAOD,UAAUC,aAAa,IAAID,UAAUd,YAAY;EAC1D;AACF;AArIU1D;AACR,cANWD,0BAMK4E,iBAAgB;EAACC;;AACjC,cAPW7E,0BAOJK,iBAAgB;AACvB,cARWL,0BAQJO,oBAAmB;AAC1B,cATWP,0BASJW,oBAAmB;AATrB,IAAMX,0BAAN;","names":["PayloadDivinerSchema","IndexedDbPayloadDivinerSchema","IndexedDbPayloadDivinerConfigSchema","IndexedDbPayloadDivinerSchema","assertEx","IndexSeparator","PayloadDiviner","isPayloadDivinerQueryPayload","PayloadHasher","openDB","IndexedDbPayloadDiviner","PayloadDiviner","_db","dbName","config","defaultDbName","dbVersion","defaultDbVersion","indexes","storage","storeName","defaultStoreName","db","assertEx","divineHandler","payloads","query","filter","isPayloadDivinerQueryPayload","pop","schemas","limit","offset","hash","order","schema","_schema","sources","props","tx","transaction","store","objectStore","results","parsedOffset","parsedLimit","length","filterSchema","direction","suggestedIndex","selectBestIndex","filterValues","getKeyValuesFromQuery","cursor","index","openCursor","IDBKeyRange","only","advance","push","value","continue","done","map","payload","PayloadHasher","jsonPayload","startHandler","openDB","indexName","extractFields","slice","split","IndexSeparator","field","toLowerCase","indexFields","indexNames","queryKeys","Set","Object","keys","key","bestMatch","matchCount","has","configSchemas","IndexedDbPayloadDivinerConfigSchema"]}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@xyo-network/diviner-payload-indexeddb",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.13.23",
+    "@xyo-network/diviner-model": "~2.87.0-rc.2",
+    "@xyo-network/diviner-payload-abstract": "~2.87.0-rc.2",
+    "@xyo-network/diviner-payload-model": "~2.87.0-rc.2",
+    "@xyo-network/hash": "~2.87.0-rc.2",
+    "@xyo-network/payload-model": "~2.87.0-rc.2",
+    "idb": "^8.0.0"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.2.33",
+    "@xylabs/tsconfig": "^3.2.33",
+    "@xyo-network/account": "~2.87.0-rc.2",
+    "@xyo-network/archivist-indexeddb": "~2.87.0-rc.2",
+    "@xyo-network/archivist-model": "~2.87.0-rc.2",
+    "@xyo-network/module-model": "~2.87.0-rc.2",
+    "@xyo-network/node-memory": "~2.87.0-rc.2",
+    "@xyo-network/object": "~2.87.0-rc.2",
+    "@xyo-network/payload-builder": "~2.87.0-rc.2",
+    "fake-indexeddb": "^5.0.2",
+    "typescript": "^5.3.3"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "types": "dist/node/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.cts",
+          "default": "./dist/node/index.cjs"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.js"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.87.0-rc.2",
+  "type": "module",
+  "stableVersion": "2.86.1"
+}

package/src/Config.ts

@@ -0,0 +1,33 @@
+import { IndexDescription } from '@xyo-network/archivist-model'
+import { DivinerConfig } from '@xyo-network/diviner-model'
+
+import { IndexedDbPayloadDivinerSchema } from './Schema'
+
+export const IndexedDbPayloadDivinerConfigSchema = `${IndexedDbPayloadDivinerSchema}.config`
+export type IndexedDbPayloadDivinerConfigSchema = typeof IndexedDbPayloadDivinerConfigSchema
+
+export type IndexedDbPayloadDivinerConfig = DivinerConfig<{
+  /**
+   * The database name
+   */
+  dbName?: string
+  /**
+   * The version of the DB, defaults to 1
+   */
+  dbVersion?: number
+  schema: IndexedDbPayloadDivinerConfigSchema
+  /**
+   * The storage configuration
+   * // TODO: Hoist to main diviner config
+   */
+  storage?: {
+    /**
+     * The indexes to create on the object store
+     */
+    indexes?: IndexDescription[]
+  }
+  /**
+   * The name of the object store
+   */
+  storeName?: string
+}>