@xyo-network/archivist-indexeddb 2.74.5 → 2.75.1

package/dist/node/index.mjs

@@ -0,0 +1,113 @@
+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/IndexedDbArchivist.ts
+import { assertEx } from "@xylabs/assert";
+import { AbstractArchivist } from "@xyo-network/archivist-abstract";
+import { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema } from "@xyo-network/archivist-model";
+import { PayloadHasher } from "@xyo-network/core";
+import { creatableModule } from "@xyo-network/module";
+import { clear, createStore, delMany, entries, getMany, setMany } from "idb-keyval";
+function _ts_decorate(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
+    r = Reflect.decorate(decorators, target, key, desc);
+  else
+    for (var i = decorators.length - 1; i >= 0; i--)
+      if (d = decorators[i])
+        r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate, "_ts_decorate");
+var IndexedDbArchivistConfigSchema = "network.xyo.archivist.indexeddb.config";
+var _a;
+var IndexedDbArchivist = (_a = class extends AbstractArchivist {
+  _db;
+  /**
+  * The database name. If not supplied via config, it defaults
+  * to the module name (not guaranteed to be unique) and if module
+  * name is not supplied, 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 _a2, _b;
+    return ((_a2 = this.config) == null ? void 0 : _a2.dbName) ?? ((_b = this.config) == null ? void 0 : _b.name) ?? _a.defaultDbName;
+  }
+  get queries() {
+    return [
+      ArchivistAllQuerySchema,
+      ArchivistClearQuerySchema,
+      ArchivistDeleteQuerySchema,
+      ArchivistInsertQuerySchema,
+      ...super.queries
+    ];
+  }
+  /**
+  * The name of the object store. If not supplied via config, it defaults
+  * to `payloads`. The limitation of the current IndexedDB wrapper we're
+  * using is that it only supports a single object store per DB. See here:
+  * https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name
+  * If this becomes a problem or we need migrations/transactions, we can
+  * move to this more-flexible library, which they recommend (and who
+  * recommends them for our simple use case of key-value storage):
+  * https://www.npmjs.com/package/idb
+  */
+  get storeName() {
+    var _a2;
+    return ((_a2 = this.config) == null ? void 0 : _a2.storeName) ?? _a.defaultStoreName;
+  }
+  get db() {
+    return assertEx(this._db, "DB not initialized");
+  }
+  async allHandler() {
+    const result = await entries(this.db);
+    return result.map(([_hash, payload]) => payload);
+  }
+  async clearHandler() {
+    await clear(this.db);
+  }
+  async deleteHandler(hashes) {
+    const payloadPairs = await Promise.all((await this.get(hashes)).map(async (payload) => [
+      await PayloadHasher.hashAsync(payload),
+      payload
+    ]));
+    const foundHashesToDelete = payloadPairs.map(([hash, _]) => hash);
+    await delMany(foundHashesToDelete, this.db);
+    return foundHashesToDelete;
+  }
+  async getHandler(hashes) {
+    return (await getMany(hashes, this.db)).filter((result) => result !== void 0);
+  }
+  async insertHandler(payloads) {
+    const entries2 = await Promise.all(payloads.map(async (payload) => {
+      const hash = await PayloadHasher.hashAsync(payload);
+      return [
+        hash,
+        payload
+      ];
+    }));
+    await setMany(entries2, this.db);
+    return payloads;
+  }
+  async startHandler() {
+    await super.startHandler();
+    this._db = createStore(this.dbName, this.storeName);
+    return true;
+  }
+}, __name(_a, "IndexedDbArchivist"), __publicField(_a, "configSchemas", [
+  IndexedDbArchivistConfigSchema
+]), __publicField(_a, "defaultDbName", "archivist"), __publicField(_a, "defaultStoreName", "payloads"), _a);
+IndexedDbArchivist = _ts_decorate([
+  creatableModule()
+], IndexedDbArchivist);
+export {
+  IndexedDbArchivist,
+  IndexedDbArchivistConfigSchema
+};
+//# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/IndexedDbArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n  ArchivistAllQuerySchema,\n  ArchivistClearQuerySchema,\n  ArchivistConfig,\n  ArchivistDeleteQuerySchema,\n  ArchivistInsertQuerySchema,\n  ArchivistModuleEventData,\n  ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { clear, createStore, delMany, entries, getMany, setMany, UseStore } from 'idb-keyval'\n\nexport type IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n  /**\n   * The database name\n   */\n  dbName?: string\n  schema: IndexedDbArchivistConfigSchema\n  /**\n   * The name of the object store\n   */\n  storeName?: string\n}>\n\nexport type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>\n\n@creatableModule()\nexport class IndexedDbArchivist<\n  TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n  static override configSchemas = [IndexedDbArchivistConfigSchema]\n  static defaultDbName = 'archivist'\n  static defaultStoreName = 'payloads'\n\n  private _db: UseStore | undefined\n\n  /**\n   * The database name. If not supplied via config, it defaults\n   * to the module name (not guaranteed to be unique) and if module\n   * name is not supplied, 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?.name ?? IndexedDbArchivist.defaultDbName\n  }\n\n  override get queries() {\n    return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n  }\n  /**\n   * The name of the object store. If not supplied via config, it defaults\n   * to `payloads`. The limitation of the current IndexedDB wrapper we're\n   * using is that it only supports a single object store per DB. See here:\n   * https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name\n   * If this becomes a problem or we need migrations/transactions, we can\n   * move to this more-flexible library, which they recommend (and who\n   * recommends them for our simple use case of key-value storage):\n   * https://www.npmjs.com/package/idb\n   */\n  get storeName() {\n    return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n  }\n\n  private get db(): UseStore {\n    return assertEx(this._db, 'DB not initialized')\n  }\n\n  protected override async allHandler(): Promise<Payload[]> {\n    const result = await entries<string, Payload>(this.db)\n    return result.map<Payload>(([_hash, payload]) => payload)\n  }\n\n  protected override async clearHandler(): Promise<void> {\n    await clear(this.db)\n  }\n\n  protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n    const payloadPairs: [string, Payload][] = await Promise.all(\n      (await this.get(hashes)).map<Promise<[string, Payload]>>(async (payload) => [await PayloadHasher.hashAsync(payload), payload]),\n    )\n\n    const foundHashesToDelete = payloadPairs.map(([hash, _]) => hash)\n    await delMany(foundHashesToDelete, this.db)\n\n    return foundHashesToDelete\n  }\n\n  protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n    return (await getMany<Payload>(hashes, this.db)).filter((result) => result !== undefined)\n  }\n\n  protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n    const entries = await Promise.all(\n      payloads.map<Promise<[string, Payload]>>(async (payload) => {\n        const hash = await PayloadHasher.hashAsync(payload)\n        return [hash, payload]\n      }),\n    )\n    await setMany(entries, this.db)\n\n    return payloads\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 = createStore(this.dbName, this.storeName)\n    return true\n  }\n}\n"],"mappings":";;;;;;;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BAEAC,4BACAC,kCAGK;AACP,SAASC,qBAAqB;AAC9B,SAA0BC,uBAAuB;AAEjD,SAASC,OAAOC,aAAaC,SAASC,SAASC,SAASC,eAAyB;;;;;;;;;;;;AAG1E,IAAMC,iCAAiE;;AAiB9E,IAAaC,sBAAN,mBAGGC,kBAAAA;EAKAC;;;;;;;;EASR,IAAIC,SAAS;;AACX,aAAOC,MAAA,KAAKC,WAAL,gBAAAD,IAAaD,aAAU,UAAKE,WAAL,mBAAaC,SAAQN,GAAmBO;EACxE;EAEA,IAAaC,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;;;;;;;EAWA,IAAIK,YAAY;;AACd,aAAOT,MAAA,KAAKC,WAAL,gBAAAD,IAAaS,cAAab,GAAmBc;EACtD;EAEA,IAAYC,KAAe;AACzB,WAAOC,SAAS,KAAKd,KAAK,oBAAA;EAC5B;EAEA,MAAyBe,aAAiC;AACxD,UAAMC,SAAS,MAAMC,QAAyB,KAAKJ,EAAE;AACrD,WAAOG,OAAOE,IAAa,CAAC,CAACC,OAAOC,OAAAA,MAAaA,OAAAA;EACnD;EAEA,MAAyBC,eAA8B;AACrD,UAAMC,MAAM,KAAKT,EAAE;EACrB;EAEA,MAAyBU,cAAcC,QAAqC;AAC1E,UAAMC,eAAoC,MAAMC,QAAQC,KACrD,MAAM,KAAKC,IAAIJ,MAAAA,GAASN,IAAgC,OAAOE,YAAY;MAAC,MAAMS,cAAcC,UAAUV,OAAAA;MAAUA;KAAQ,CAAA;AAG/H,UAAMW,sBAAsBN,aAAaP,IAAI,CAAC,CAACc,MAAMC,CAAAA,MAAOD,IAAAA;AAC5D,UAAME,QAAQH,qBAAqB,KAAKlB,EAAE;AAE1C,WAAOkB;EACT;EAEA,MAAyBI,WAAWX,QAAsC;AACxE,YAAQ,MAAMY,QAAiBZ,QAAQ,KAAKX,EAAE,GAAGwB,OAAO,CAACrB,WAAWA,WAAWsB,MAAAA;EACjF;EAEA,MAAyBC,cAAcC,UAAyC;AAC9E,UAAMvB,WAAU,MAAMS,QAAQC,IAC5Ba,SAAStB,IAAgC,OAAOE,YAAAA;AAC9C,YAAMY,OAAO,MAAMH,cAAcC,UAAUV,OAAAA;AAC3C,aAAO;QAACY;QAAMZ;;IAChB,CAAA,CAAA;AAEF,UAAMqB,QAAQxB,UAAS,KAAKJ,EAAE;AAE9B,WAAO2B;EACT;EAEA,MAAyBE,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,SAAK1C,MAAM2C,YAAY,KAAK1C,QAAQ,KAAKU,SAAS;AAClD,WAAO;EACT;AACF,GAlFUZ,kCACR,cAJK,IAIW6C,iBAAgB;EAAC/C;IACjC,cALK,IAKEQ,iBAAgB,cACvB,cANK,IAMEO,oBAAmB,aANrB;AAAMd,qBAAAA,aAAAA;EADZ+C,gBAAAA;GACY/C,kBAAAA;","names":["assertEx","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","PayloadHasher","creatableModule","clear","createStore","delMany","entries","getMany","setMany","IndexedDbArchivistConfigSchema","IndexedDbArchivist","AbstractArchivist","_db","dbName","_a","config","name","defaultDbName","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","defaultStoreName","db","assertEx","allHandler","result","entries","map","_hash","payload","clearHandler","clear","deleteHandler","hashes","payloadPairs","Promise","all","get","PayloadHasher","hashAsync","foundHashesToDelete","hash","_","delMany","getHandler","getMany","filter","undefined","insertHandler","payloads","setMany","startHandler","createStore","configSchemas","creatableModule"]}

package/dist/node/sample.archivist.xyo.js

@@ -0,0 +1,23 @@
+// src/sample.archivist.xyo.json
+var payloads = [
+  {
+    schema: "network.xyo.test.1"
+  },
+  {
+    schema: "network.xyo.test.2"
+  },
+  {
+    schema: "network.xyo.test.3"
+  },
+  {
+    schema: "network.xyo.test.4"
+  }
+];
+var sample_archivist_xyo_default = {
+  payloads
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  payloads
+});
+//# sourceMappingURL=sample.archivist.xyo.js.map

package/dist/node/sample.archivist.xyo.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/sample.archivist.xyo.json"],"sourcesContent":["{\n  \"payloads\": [\n    {\n      \"schema\": \"network.xyo.test.1\"\n    },\n    {\n      \"schema\": \"network.xyo.test.2\"\n    },\n    {\n      \"schema\": \"network.xyo.test.3\"\n    },\n    {\n      \"schema\": \"network.xyo.test.4\"\n    }\n  ]\n}"],"mappings":";AACE,eAAY;AAAA,EACV;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AACF;AAdF;AAAA,EACE;AAcF;","names":[]}

package/dist/node/sample.archivist.xyo.mjs

@@ -0,0 +1,23 @@
+// src/sample.archivist.xyo.json
+var payloads = [
+  {
+    schema: "network.xyo.test.1"
+  },
+  {
+    schema: "network.xyo.test.2"
+  },
+  {
+    schema: "network.xyo.test.3"
+  },
+  {
+    schema: "network.xyo.test.4"
+  }
+];
+var sample_archivist_xyo_default = {
+  payloads
+};
+export {
+  sample_archivist_xyo_default as default,
+  payloads
+};
+//# sourceMappingURL=sample.archivist.xyo.mjs.map

package/dist/node/sample.archivist.xyo.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/sample.archivist.xyo.json"],"sourcesContent":["{\n  \"payloads\": [\n    {\n      \"schema\": \"network.xyo.test.1\"\n    },\n    {\n      \"schema\": \"network.xyo.test.2\"\n    },\n    {\n      \"schema\": \"network.xyo.test.3\"\n    },\n    {\n      \"schema\": \"network.xyo.test.4\"\n    }\n  ]\n}"],"mappings":";AACE,eAAY;AAAA,EACV;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AACF;AAdF;AAAA,EACE;AAcF;","names":[]}

package/package.json

@@ -10,54 +10,57 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/assert": "^2.11.7",
-    "@xyo-network/archivist-abstract": "~2.74.5",
-    "@xyo-network/archivist-model": "~2.74.5",
-    "@xyo-network/core": "~2.74.5",
-    "@xyo-network/module": "~2.74.5",
-    "@xyo-network/payload-model": "~2.74.5",
+    "@xylabs/assert": "^2.12.10",
+    "@xyo-network/archivist-abstract": "~2.75.1",
+    "@xyo-network/archivist-model": "~2.75.1",
+    "@xyo-network/core": "~2.75.1",
+    "@xyo-network/module": "~2.75.1",
+    "@xyo-network/payload-model": "~2.75.1",
     "idb-keyval": "^6.2.1"
   },
   "devDependencies": {
-    "@xylabs/delay": "^2.11.7",
-    "@xylabs/ts-scripts-yarn3": "^3.0.28",
-    "@xylabs/tsconfig": "^3.0.28",
-    "@xyo-network/id-payload-plugin": "^2.74.5",
-    "@xyo-network/payload-wrapper": "^2.74.5",
-    "@xyo-network/promise": "^2.74.5",
+    "@xylabs/delay": "^2.12.10",
+    "@xylabs/ts-scripts-yarn3": "^3.0.77",
+    "@xylabs/tsconfig": "^3.0.77",
+    "@xyo-network/id-payload-plugin": "^2.75.1",
+    "@xyo-network/payload-wrapper": "^2.75.1",
+    "@xyo-network/promise": "^2.75.1",
     "fake-indexeddb": "^4.0.2",
     "typescript": "^5.2.2"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
   "docs": "dist/docs.json",
-  "types": "dist/index.d.ts",
+  "types": "dist/node/index.d.ts",
   "exports": {
     ".": {
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
+      "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"
+        }
       },
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.ts",
+          "default": "./dist/node/index.js"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.mjs"
+        }
       }
     },
-    "./dist/docs.json": {
-      "default": "./dist/docs.json"
-    },
-    "./cjs": {
-      "default": "./dist/index.js"
-    },
     "./docs": {
       "default": "./dist/docs.json"
     },
-    "./esm": {
-      "default": "./dist/index.mjs"
-    },
     "./package.json": "./package.json"
   },
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
+  "main": "dist/node/index.js",
+  "module": "dist/node/index.mjs",
   "homepage": "https://xyo.network",
   "license": "LGPL-3.0",
   "publishConfig": {
@@ -68,5 +71,5 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.74.5"
+  "version": "2.75.1"
 }

package/dist/IndexedDbArchivist.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"IndexedDbArchivist.d.ts","sourceRoot":"","sources":["../src/IndexedDbArchivist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAGL,eAAe,EAGf,wBAAwB,EACxB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,eAAe,EAAmB,MAAM,qBAAqB,CAAA;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGpD,MAAM,MAAM,8BAA8B,GAAG,wCAAwC,CAAA;AACrF,eAAO,MAAM,8BAA8B,EAAE,8BAAyE,CAAA;AAEtH,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC;IACrD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,8BAA8B,CAAA;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC,CAAA;AAEjG,qBACa,kBAAkB,CAC7B,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,EACnE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,OAAgB,aAAa,6CAAmC;IAChE,MAAM,CAAC,aAAa,SAAc;IAClC,MAAM,CAAC,gBAAgB,SAAa;IAEpC,OAAO,CAAC,GAAG,CAAsB;IAEjC;;;;;;OAMG;IACH,IAAI,MAAM,WAET;IAED,IAAa,OAAO,aAEnB;IACD;;;;;;;;;OASG;IACH,IAAI,SAAS,WAEZ;IAED,OAAO,KAAK,EAAE,GAEb;cAEwB,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;cAKhC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;cAI7B,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;cAWlD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAIhD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAYtD,YAAY;CAOtC"}

package/dist/IndexedDbArchivist.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"IndexedDbArchivist.d.ts","sourceRoot":"","sources":["../src/IndexedDbArchivist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAGL,eAAe,EAGf,wBAAwB,EACxB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,eAAe,EAAmB,MAAM,qBAAqB,CAAA;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGpD,MAAM,MAAM,8BAA8B,GAAG,wCAAwC,CAAA;AACrF,eAAO,MAAM,8BAA8B,EAAE,8BAAyE,CAAA;AAEtH,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC;IACrD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,8BAA8B,CAAA;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC,CAAA;AAEjG,qBACa,kBAAkB,CAC7B,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,EACnE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,OAAgB,aAAa,6CAAmC;IAChE,MAAM,CAAC,aAAa,SAAc;IAClC,MAAM,CAAC,gBAAgB,SAAa;IAEpC,OAAO,CAAC,GAAG,CAAsB;IAEjC;;;;;;OAMG;IACH,IAAI,MAAM,WAET;IAED,IAAa,OAAO,aAEnB;IACD;;;;;;;;;OASG;IACH,IAAI,SAAS,WAEZ;IAED,OAAO,KAAK,EAAE,GAEb;cAEwB,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;cAKhC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;cAI7B,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;cAWlD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAIhD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAYtD,YAAY;CAOtC"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/index.ts","../src/IndexedDbArchivist.ts"],"sourcesContent":["export * from './IndexedDbArchivist'\n","import { assertEx } from '@xylabs/assert'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n  ArchivistAllQuerySchema,\n  ArchivistClearQuerySchema,\n  ArchivistConfig,\n  ArchivistDeleteQuerySchema,\n  ArchivistInsertQuerySchema,\n  ArchivistModuleEventData,\n  ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { clear, createStore, delMany, entries, getMany, setMany, UseStore } from 'idb-keyval'\n\nexport type IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n  /**\n   * The database name\n   */\n  dbName?: string\n  schema: IndexedDbArchivistConfigSchema\n  /**\n   * The name of the object store\n   */\n  storeName?: string\n}>\n\nexport type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>\n\n@creatableModule()\nexport class IndexedDbArchivist<\n  TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n  static override configSchemas = [IndexedDbArchivistConfigSchema]\n  static defaultDbName = 'archivist'\n  static defaultStoreName = 'payloads'\n\n  private _db: UseStore | undefined\n\n  /**\n   * The database name. If not supplied via config, it defaults\n   * to the module name (not guaranteed to be unique) and if module\n   * name is not supplied, 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?.name ?? IndexedDbArchivist.defaultDbName\n  }\n\n  override get queries() {\n    return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n  }\n  /**\n   * The name of the object store. If not supplied via config, it defaults\n   * to `payloads`. The limitation of the current IndexedDB wrapper we're\n   * using is that it only supports a single object store per DB. See here:\n   * https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name\n   * If this becomes a problem or we need migrations/transactions, we can\n   * move to this more-flexible library, which they recommend (and who\n   * recommends them for our simple use case of key-value storage):\n   * https://www.npmjs.com/package/idb\n   */\n  get storeName() {\n    return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n  }\n\n  private get db(): UseStore {\n    return assertEx(this._db, 'DB not initialized')\n  }\n\n  protected override async allHandler(): Promise<Payload[]> {\n    const result = await entries<string, Payload>(this.db)\n    return result.map<Payload>(([_hash, payload]) => payload)\n  }\n\n  protected override async clearHandler(): Promise<void> {\n    await clear(this.db)\n  }\n\n  protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n    const payloadPairs: [string, Payload][] = await Promise.all(\n      (await this.get(hashes)).map<Promise<[string, Payload]>>(async (payload) => [await PayloadHasher.hashAsync(payload), payload]),\n    )\n\n    const foundHashesToDelete = payloadPairs.map(([hash, _]) => hash)\n    await delMany(foundHashesToDelete, this.db)\n\n    return foundHashesToDelete\n  }\n\n  protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n    return (await getMany<Payload>(hashes, this.db)).filter((result) => result !== undefined)\n  }\n\n  protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n    const entries = await Promise.all(\n      payloads.map<Promise<[string, Payload]>>(async (payload) => {\n        const hash = await PayloadHasher.hashAsync(payload)\n        return [hash, payload]\n      }),\n    )\n    await setMany(entries, this.db)\n\n    return payloads\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 = createStore(this.dbName, this.storeName)\n    return true\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;ACAA,oBAAyB;AACzB,gCAAkC;AAClC,6BAQO;AACP,kBAA8B;AAC9B,oBAAiD;AAEjD,wBAAiF;;;;;;;;;;;;AAG1E,IAAMA,iCAAiE;AAiB9E,IAAaC,qBAAN,MAAAA,4BAGGC,4CAAAA;SAAAA;;;EACR,OAAgBC,gBAAgB;IAACH;;EACjC,OAAOI,gBAAgB;EACvB,OAAOC,mBAAmB;EAElBC;;;;;;;;EASR,IAAIC,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQR,oBAAmBG;EACxE;EAEA,IAAaM,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;;;;;;;EAWA,IAAIK,YAAY;AACd,WAAO,KAAKP,QAAQO,aAAad,oBAAmBI;EACtD;EAEA,IAAYW,KAAe;AACzB,eAAOC,wBAAS,KAAKX,KAAK,oBAAA;EAC5B;EAEA,MAAyBY,aAAiC;AACxD,UAAMC,SAAS,UAAMC,2BAAyB,KAAKJ,EAAE;AACrD,WAAOG,OAAOE,IAAa,CAAC,CAACC,OAAOC,OAAAA,MAAaA,OAAAA;EACnD;EAEA,MAAyBC,eAA8B;AACrD,cAAMC,yBAAM,KAAKT,EAAE;EACrB;EAEA,MAAyBU,cAAcC,QAAqC;AAC1E,UAAMC,eAAoC,MAAMC,QAAQC,KACrD,MAAM,KAAKC,IAAIJ,MAAAA,GAASN,IAAgC,OAAOE,YAAY;MAAC,MAAMS,0BAAcC,UAAUV,OAAAA;MAAUA;KAAQ,CAAA;AAG/H,UAAMW,sBAAsBN,aAAaP,IAAI,CAAC,CAACc,MAAMC,CAAAA,MAAOD,IAAAA;AAC5D,cAAME,2BAAQH,qBAAqB,KAAKlB,EAAE;AAE1C,WAAOkB;EACT;EAEA,MAAyBI,WAAWX,QAAsC;AACxE,YAAQ,UAAMY,2BAAiBZ,QAAQ,KAAKX,EAAE,GAAGwB,OAAO,CAACrB,WAAWA,WAAWsB,MAAAA;EACjF;EAEA,MAAyBC,cAAcC,UAAyC;AAC9E,UAAMvB,WAAU,MAAMS,QAAQC,IAC5Ba,SAAStB,IAAgC,OAAOE,YAAAA;AAC9C,YAAMY,OAAO,MAAMH,0BAAcC,UAAUV,OAAAA;AAC3C,aAAO;QAACY;QAAMZ;;IAChB,CAAA,CAAA;AAEF,cAAMqB,2BAAQxB,UAAS,KAAKJ,EAAE;AAE9B,WAAO2B;EACT;EAEA,MAAyBE,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,SAAKvC,UAAMwC,+BAAY,KAAKvC,QAAQ,KAAKQ,SAAS;AAClD,WAAO;EACT;AACF;AArFad,qBAAAA,aAAAA;MADZ8C,+BAAAA;GACY9C,kBAAAA;","names":["IndexedDbArchivistConfigSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","defaultDbName","defaultStoreName","_db","dbName","config","name","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","db","assertEx","allHandler","result","entries","map","_hash","payload","clearHandler","clear","deleteHandler","hashes","payloadPairs","Promise","all","get","PayloadHasher","hashAsync","foundHashesToDelete","hash","_","delMany","getHandler","getMany","filter","undefined","insertHandler","payloads","setMany","startHandler","createStore","creatableModule"]}

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/IndexedDbArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n  ArchivistAllQuerySchema,\n  ArchivistClearQuerySchema,\n  ArchivistConfig,\n  ArchivistDeleteQuerySchema,\n  ArchivistInsertQuerySchema,\n  ArchivistModuleEventData,\n  ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { clear, createStore, delMany, entries, getMany, setMany, UseStore } from 'idb-keyval'\n\nexport type IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n  /**\n   * The database name\n   */\n  dbName?: string\n  schema: IndexedDbArchivistConfigSchema\n  /**\n   * The name of the object store\n   */\n  storeName?: string\n}>\n\nexport type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>\n\n@creatableModule()\nexport class IndexedDbArchivist<\n  TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n  static override configSchemas = [IndexedDbArchivistConfigSchema]\n  static defaultDbName = 'archivist'\n  static defaultStoreName = 'payloads'\n\n  private _db: UseStore | undefined\n\n  /**\n   * The database name. If not supplied via config, it defaults\n   * to the module name (not guaranteed to be unique) and if module\n   * name is not supplied, 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?.name ?? IndexedDbArchivist.defaultDbName\n  }\n\n  override get queries() {\n    return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n  }\n  /**\n   * The name of the object store. If not supplied via config, it defaults\n   * to `payloads`. The limitation of the current IndexedDB wrapper we're\n   * using is that it only supports a single object store per DB. See here:\n   * https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name\n   * If this becomes a problem or we need migrations/transactions, we can\n   * move to this more-flexible library, which they recommend (and who\n   * recommends them for our simple use case of key-value storage):\n   * https://www.npmjs.com/package/idb\n   */\n  get storeName() {\n    return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n  }\n\n  private get db(): UseStore {\n    return assertEx(this._db, 'DB not initialized')\n  }\n\n  protected override async allHandler(): Promise<Payload[]> {\n    const result = await entries<string, Payload>(this.db)\n    return result.map<Payload>(([_hash, payload]) => payload)\n  }\n\n  protected override async clearHandler(): Promise<void> {\n    await clear(this.db)\n  }\n\n  protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n    const payloadPairs: [string, Payload][] = await Promise.all(\n      (await this.get(hashes)).map<Promise<[string, Payload]>>(async (payload) => [await PayloadHasher.hashAsync(payload), payload]),\n    )\n\n    const foundHashesToDelete = payloadPairs.map(([hash, _]) => hash)\n    await delMany(foundHashesToDelete, this.db)\n\n    return foundHashesToDelete\n  }\n\n  protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n    return (await getMany<Payload>(hashes, this.db)).filter((result) => result !== undefined)\n  }\n\n  protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n    const entries = await Promise.all(\n      payloads.map<Promise<[string, Payload]>>(async (payload) => {\n        const hash = await PayloadHasher.hashAsync(payload)\n        return [hash, payload]\n      }),\n    )\n    await setMany(entries, this.db)\n\n    return payloads\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 = createStore(this.dbName, this.storeName)\n    return true\n  }\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BAEAC,4BACAC,kCAGK;AACP,SAASC,qBAAqB;AAC9B,SAA0BC,uBAAuB;AAEjD,SAASC,OAAOC,aAAaC,SAASC,SAASC,SAASC,eAAyB;;;;;;;;;;;;AAG1E,IAAMC,iCAAiE;AAiB9E,IAAaC,qBAAN,MAAAA,4BAGGC,kBAAAA;SAAAA;;;EACR,OAAgBC,gBAAgB;IAACH;;EACjC,OAAOI,gBAAgB;EACvB,OAAOC,mBAAmB;EAElBC;;;;;;;;EASR,IAAIC,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQR,oBAAmBG;EACxE;EAEA,IAAaM,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;;;;;;;EAWA,IAAIK,YAAY;AACd,WAAO,KAAKP,QAAQO,aAAad,oBAAmBI;EACtD;EAEA,IAAYW,KAAe;AACzB,WAAOC,SAAS,KAAKX,KAAK,oBAAA;EAC5B;EAEA,MAAyBY,aAAiC;AACxD,UAAMC,SAAS,MAAMC,QAAyB,KAAKJ,EAAE;AACrD,WAAOG,OAAOE,IAAa,CAAC,CAACC,OAAOC,OAAAA,MAAaA,OAAAA;EACnD;EAEA,MAAyBC,eAA8B;AACrD,UAAMC,MAAM,KAAKT,EAAE;EACrB;EAEA,MAAyBU,cAAcC,QAAqC;AAC1E,UAAMC,eAAoC,MAAMC,QAAQC,KACrD,MAAM,KAAKC,IAAIJ,MAAAA,GAASN,IAAgC,OAAOE,YAAY;MAAC,MAAMS,cAAcC,UAAUV,OAAAA;MAAUA;KAAQ,CAAA;AAG/H,UAAMW,sBAAsBN,aAAaP,IAAI,CAAC,CAACc,MAAMC,CAAAA,MAAOD,IAAAA;AAC5D,UAAME,QAAQH,qBAAqB,KAAKlB,EAAE;AAE1C,WAAOkB;EACT;EAEA,MAAyBI,WAAWX,QAAsC;AACxE,YAAQ,MAAMY,QAAiBZ,QAAQ,KAAKX,EAAE,GAAGwB,OAAO,CAACrB,WAAWA,WAAWsB,MAAAA;EACjF;EAEA,MAAyBC,cAAcC,UAAyC;AAC9E,UAAMvB,WAAU,MAAMS,QAAQC,IAC5Ba,SAAStB,IAAgC,OAAOE,YAAAA;AAC9C,YAAMY,OAAO,MAAMH,cAAcC,UAAUV,OAAAA;AAC3C,aAAO;QAACY;QAAMZ;;IAChB,CAAA,CAAA;AAEF,UAAMqB,QAAQxB,UAAS,KAAKJ,EAAE;AAE9B,WAAO2B;EACT;EAEA,MAAyBE,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,SAAKvC,MAAMwC,YAAY,KAAKvC,QAAQ,KAAKQ,SAAS;AAClD,WAAO;EACT;AACF;AArFad,qBAAAA,aAAAA;EADZ8C,gBAAAA;GACY9C,kBAAAA;","names":["assertEx","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","PayloadHasher","creatableModule","clear","createStore","delMany","entries","getMany","setMany","IndexedDbArchivistConfigSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","defaultDbName","defaultStoreName","_db","dbName","config","name","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","db","assertEx","allHandler","result","entries","map","_hash","payload","clearHandler","clear","deleteHandler","hashes","payloadPairs","Promise","all","get","PayloadHasher","hashAsync","foundHashesToDelete","hash","_","delMany","getHandler","getMany","filter","undefined","insertHandler","payloads","setMany","startHandler","createStore","creatableModule"]}