@xyo-network/archivist-indexeddb 2.60.3 → 2.60.5

package/dist/esm/IndexedDbArchivist.js

@@ -1,28 +1,59 @@
+var IndexedDbArchivist_1;
 import { __decorate } from "tslib";
+import { assertEx } from '@xylabs/assert';
 import { AbstractArchivist } from '@xyo-network/abstract-archivist';
 import { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, } from '@xyo-network/archivist-model';
 import { PayloadHasher } from '@xyo-network/core';
 import { creatableModule } from '@xyo-network/module';
-import { clear, delMany, entries, getMany, setMany } from 'idb-keyval';
-export const IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.storage';
-let IndexedDbArchivist = class IndexedDbArchivist extends AbstractArchivist {
+import { clear, createStore, delMany, entries, getMany, setMany } from 'idb-keyval';
+export const IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.indexeddb';
+let IndexedDbArchivist = IndexedDbArchivist_1 = class IndexedDbArchivist extends AbstractArchivist {
     static configSchema = IndexedDbArchivistConfigSchema;
+    static defaultDbName = 'archivist';
+    static defaultStoreName = 'payloads';
+    _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() {
+        return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist_1.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() {
+        return this.config?.storeName ?? IndexedDbArchivist_1.defaultStoreName;
+    }
+    get db() {
+        return assertEx(this._db, 'DB not initialized');
+    }
     async all() {
-        const result = await entries(this.params.indexedDB ?? undefined);
+        const result = await entries(this.db);
         return result.map(([_hash, payload]) => payload);
     }
     async clear() {
-        await clear(this.params.indexedDB ?? undefined);
+        await clear(this.db);
     }
     async delete(hashes) {
-        await delMany(hashes, this.params.indexedDB ?? undefined);
+        await delMany(hashes, this.db);
         return hashes.map((_) => true);
     }
     async get(hashes) {
-        const result = await getMany(hashes, this.params.indexedDB ?? undefined);
+        const result = await getMany(hashes, this.db);
         return result;
     }
     async insert(payloads) {
@@ -30,12 +61,18 @@ let IndexedDbArchivist = class IndexedDbArchivist extends AbstractArchivist {
             const hash = await PayloadHasher.hashAsync(payload);
             return [hash, payload];
         }));
-        await setMany(entries, this.params.indexedDB ?? undefined);
+        await setMany(entries, this.db);
         const result = await this.bindQueryResult({ payloads, schema: ArchivistInsertQuerySchema }, payloads);
         return [result[0]];
     }
+    async start() {
+        await super.start();
+        // NOTE: We could defer this creation to first access but we
+        // want to fail fast here in case something is wrong
+        this._db = createStore(this.dbName, this.storeName);
+    }
 };
-IndexedDbArchivist = __decorate([
+IndexedDbArchivist = IndexedDbArchivist_1 = __decorate([
     creatableModule()
 ], IndexedDbArchivist);
 export { IndexedDbArchivist };

package/dist/esm/IndexedDbArchivist.js.map

@@ -1 +1 @@
-{"version":3,"file":"IndexedDbArchivist.js","sourceRoot":"","sources":["../../src/IndexedDbArchivist.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EAEzB,0BAA0B,EAC1B,0BAA0B,GAG3B,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAmB,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAEtE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAY,MAAM,YAAY,CAAA;AAGhF,MAAM,CAAC,MAAM,8BAA8B,GAAmC,6CAA6C,CAAA;AAiBpH,IAAM,kBAAkB,GAAxB,MAAM,kBAGX,SAAQ,iBAAsC;IAC9C,MAAM,CAAU,YAAY,GAAG,8BAA8B,CAAA;IAE7D,IAAa,OAAO;QAClB,OAAO,CAAC,uBAAuB,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACvI,CAAC;IAEQ,KAAK,CAAC,GAAG;QAChB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAkB,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;QACjF,OAAO,MAAM,CAAC,GAAG,CAAU,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAA;IAC3D,CAAC;IAEQ,KAAK,CAAC,KAAK;QAClB,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;IACjD,CAAC;IAEQ,KAAK,CAAC,MAAM,CAAC,MAAgB;QACpC,MAAM,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;QACzD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAEQ,KAAK,CAAC,GAAG,CAAC,MAAgB;QACjC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAU,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;QACjF,OAAO,MAAM,CAAA;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAmB;QAC9B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,QAAQ,CAAC,GAAG,CAA6B,KAAK,EAAE,OAAO,EAAE,EAAE;YACzD,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;YACnD,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACxB,CAAC,CAAC,CACH,CAAA;QACD,MAAM,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;QAC1D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,0BAA0B,EAAE,EAAE,QAAQ,CAAC,CAAA;QACrG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;;AAvCU,kBAAkB;IAD9B,eAAe,EAAE;GACL,kBAAkB,CAwC9B;SAxCY,kBAAkB"}
+{"version":3,"file":"IndexedDbArchivist.js","sourceRoot":"","sources":["../../src/IndexedDbArchivist.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EAEzB,0BAA0B,EAC1B,0BAA0B,GAG3B,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAmB,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAEtE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAY,MAAM,YAAY,CAAA;AAG7F,MAAM,CAAC,MAAM,8BAA8B,GAAmC,+CAA+C,CAAA;AAiBtH,IAAM,kBAAkB,0BAAxB,MAAM,kBAGX,SAAQ,iBAAsC;IAC9C,MAAM,CAAU,YAAY,GAAG,8BAA8B,CAAA;IAC7D,MAAM,CAAC,aAAa,GAAG,WAAW,CAAA;IAClC,MAAM,CAAC,gBAAgB,GAAG,UAAU,CAAA;IAE5B,GAAG,CAAsB;IAEjC;;;;;;OAMG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,oBAAkB,CAAC,aAAa,CAAA;IACrF,CAAC;IAED,IAAa,OAAO;QAClB,OAAO,CAAC,uBAAuB,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACvI,CAAC;IACD;;;;;;;;;OASG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAkB,CAAC,gBAAgB,CAAA;IACtE,CAAC;IAED,IAAY,EAAE;QACZ,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAA;IACjD,CAAC;IAEQ,KAAK,CAAC,GAAG;QAChB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAkB,IAAI,CAAC,EAAE,CAAC,CAAA;QACtD,OAAO,MAAM,CAAC,GAAG,CAAU,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAA;IAC3D,CAAC;IAEQ,KAAK,CAAC,KAAK;QAClB,MAAM,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACtB,CAAC;IAEQ,KAAK,CAAC,MAAM,CAAC,MAAgB;QACpC,MAAM,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAC9B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAEQ,KAAK,CAAC,GAAG,CAAC,MAAgB;QACjC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAU,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QACtD,OAAO,MAAM,CAAA;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAmB;QAC9B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,QAAQ,CAAC,GAAG,CAA6B,KAAK,EAAE,OAAO,EAAE,EAAE;YACzD,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;YACnD,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACxB,CAAC,CAAC,CACH,CAAA;QACD,MAAM,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAC/B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,0BAA0B,EAAE,EAAE,QAAQ,CAAC,CAAA;QACrG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAEQ,KAAK,CAAC,KAAK;QAClB,MAAM,KAAK,CAAC,KAAK,EAAE,CAAA;QACnB,4DAA4D;QAC5D,oDAAoD;QACpD,IAAI,CAAC,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IACrD,CAAC;;AA9EU,kBAAkB;IAD9B,eAAe,EAAE;GACL,kBAAkB,CA+E9B;SA/EY,kBAAkB"}

package/dist/types/IndexedDbArchivist.d.ts

@@ -3,25 +3,51 @@ import { ArchivistConfig, ArchivistModuleEventData, ArchivistParams } from '@xyo
 import { BoundWitness } from '@xyo-network/boundwitness-model';
 import { AnyConfigSchema } from '@xyo-network/module';
 import { Payload } from '@xyo-network/payload-model';
-import { UseStore } from 'idb-keyval';
-export type IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.storage';
+export type IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.indexeddb';
 export declare const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema;
 export type IndexedDbArchivistConfig = ArchivistConfig<{
-    maxEntries?: number;
-    maxEntrySize?: number;
-    namespace?: string;
+    /**
+     * The database name
+     */
+    dbName?: string;
     schema: IndexedDbArchivistConfigSchema;
+    /**
+     * The name of the object store
+     */
+    storeName?: string;
 }>;
-export type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>, {
-    indexedDB?: UseStore;
-}>;
+export type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>;
 export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> {
-    static configSchema: "network.xyo.module.config.archivist.storage";
+    static configSchema: "network.xyo.module.config.archivist.indexeddb";
+    static defaultDbName: string;
+    static defaultStoreName: string;
+    private _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(): string;
     get queries(): string[];
+    /**
+     * 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(): string;
+    private get db();
     all(): Promise<Payload[]>;
     clear(): Promise<void>;
     delete(hashes: string[]): Promise<boolean[]>;
     get(hashes: string[]): Promise<Payload[]>;
     insert(payloads: Payload[]): Promise<BoundWitness[]>;
+    start(): Promise<void>;
 }
 //# sourceMappingURL=IndexedDbArchivist.d.ts.map

package/dist/types/IndexedDbArchivist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IndexedDbArchivist.d.ts","sourceRoot":"","sources":["../../src/IndexedDbArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAGL,eAAe,EAGf,wBAAwB,EACxB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAE9D,OAAO,EAAE,eAAe,EAAmB,MAAM,qBAAqB,CAAA;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAA6C,QAAQ,EAAE,MAAM,YAAY,CAAA;AAEhF,MAAM,MAAM,8BAA8B,GAAG,6CAA6C,CAAA;AAC1F,eAAO,MAAM,8BAA8B,EAAE,8BAA8E,CAAA;AAE3H,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC;IACrD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,8BAA8B,CAAA;CACvC,CAAC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,CACpD,eAAe,CAAC,wBAAwB,CAAC,EACzC;IACE,SAAS,CAAC,EAAE,QAAQ,CAAA;CACrB,CACF,CAAA;AAED,qBACa,kBAAkB,CAC7B,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,EACnE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,OAAgB,YAAY,gDAAiC;IAE7D,IAAa,OAAO,aAEnB;IAEc,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAKzB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAK5C,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAKlD,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;CAW3D"}
+{"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;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAE9D,OAAO,EAAE,eAAe,EAAmB,MAAM,qBAAqB,CAAA;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGpD,MAAM,MAAM,8BAA8B,GAAG,+CAA+C,CAAA;AAC5F,eAAO,MAAM,8BAA8B,EAAE,8BAAgF,CAAA;AAE7H,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,YAAY,kDAAiC;IAC7D,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;IAEc,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAKzB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAK5C,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAKlD,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAY3C,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAMtC"}

package/package.json

@@ -10,23 +10,24 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/abstract-archivist": "^2.60.3",
-    "@xyo-network/archivist-model": "^2.60.3",
-    "@xyo-network/boundwitness-model": "^2.60.3",
-    "@xyo-network/core": "^2.60.3",
-    "@xyo-network/module": "^2.60.3",
-    "@xyo-network/payload-model": "^2.60.3",
-    "@xyo-network/payload-wrapper": "^2.60.3",
-    "@xyo-network/promise": "^2.60.3",
+    "@xylabs/assert": "^2.9.1",
+    "@xyo-network/abstract-archivist": "^2.60.5",
+    "@xyo-network/archivist-model": "^2.60.5",
+    "@xyo-network/boundwitness-model": "^2.60.5",
+    "@xyo-network/core": "^2.60.5",
+    "@xyo-network/module": "^2.60.5",
+    "@xyo-network/payload-model": "^2.60.5",
+    "@xyo-network/payload-wrapper": "^2.60.5",
+    "@xyo-network/promise": "^2.60.5",
     "idb-keyval": "^6.2.1"
   },
   "devDependencies": {
-    "@xylabs/delay": "^2.8.1",
+    "@xylabs/delay": "^2.9.1",
     "@xylabs/ts-scripts-yarn3": "^2.17.13",
     "@xylabs/tsconfig": "^2.17.13",
-    "@xyo-network/archivist-wrapper": "^2.60.3",
-    "@xyo-network/boundwitness-wrapper": "^2.60.3",
-    "@xyo-network/plugins": "^2.60.3",
+    "@xyo-network/archivist-wrapper": "^2.60.5",
+    "@xyo-network/boundwitness-wrapper": "^2.60.5",
+    "@xyo-network/plugins": "^2.60.5",
     "fake-indexeddb": "^4.0.1",
     "typescript": "^5.1.3"
   },
@@ -63,5 +64,5 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.60.3"
+  "version": "2.60.5"
 }

package/src/IndexedDbArchivist.ts

@@ -1,3 +1,4 @@
+import { assertEx } from '@xylabs/assert'
 import { AbstractArchivist } from '@xyo-network/abstract-archivist'
 import {
   ArchivistAllQuerySchema,
@@ -12,24 +13,24 @@ import { BoundWitness } from '@xyo-network/boundwitness-model'
 import { PayloadHasher } from '@xyo-network/core'
 import { AnyConfigSchema, creatableModule } from '@xyo-network/module'
 import { Payload } from '@xyo-network/payload-model'
-import { clear, delMany, entries, getMany, setMany, UseStore } from 'idb-keyval'
+import { clear, createStore, delMany, entries, getMany, setMany, UseStore } from 'idb-keyval'
 
-export type IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.storage'
-export const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.storage'
+export type IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.indexeddb'
+export const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.indexeddb'
 
 export type IndexedDbArchivistConfig = ArchivistConfig<{
-  maxEntries?: number
-  maxEntrySize?: number
-  namespace?: string
+  /**
+   * The database name
+   */
+  dbName?: string
   schema: IndexedDbArchivistConfigSchema
+  /**
+   * The name of the object store
+   */
+  storeName?: string
 }>
 
-export type IndexedDbArchivistParams = ArchivistParams<
-  AnyConfigSchema<IndexedDbArchivistConfig>,
-  {
-    indexedDB?: UseStore
-  }
->
+export type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>
 
 @creatableModule()
 export class IndexedDbArchivist<
@@ -37,27 +38,59 @@ export class IndexedDbArchivist<
   TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,
 > extends AbstractArchivist<TParams, TEventData> {
   static override configSchema = IndexedDbArchivistConfigSchema
+  static defaultDbName = 'archivist'
+  static defaultStoreName = 'payloads'
+
+  private _db: UseStore | undefined
+
+  /**
+   * 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() {
+    return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist.defaultDbName
+  }
 
   override 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() {
+    return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName
+  }
+
+  private get db(): UseStore {
+    return assertEx(this._db, 'DB not initialized')
+  }
 
   override async all(): Promise<Payload[]> {
-    const result = await entries<string, Payload>(this.params.indexedDB ?? undefined)
+    const result = await entries<string, Payload>(this.db)
     return result.map<Payload>(([_hash, payload]) => payload)
   }
 
   override async clear(): Promise<void> {
-    await clear(this.params.indexedDB ?? undefined)
+    await clear(this.db)
   }
 
   override async delete(hashes: string[]): Promise<boolean[]> {
-    await delMany(hashes, this.params.indexedDB ?? undefined)
+    await delMany(hashes, this.db)
     return hashes.map((_) => true)
   }
 
   override async get(hashes: string[]): Promise<Payload[]> {
-    const result = await getMany<Payload>(hashes, this.params.indexedDB ?? undefined)
+    const result = await getMany<Payload>(hashes, this.db)
     return result
   }
 
@@ -68,8 +101,15 @@ export class IndexedDbArchivist<
         return [hash, payload]
       }),
     )
-    await setMany(entries, this.params.indexedDB ?? undefined)
+    await setMany(entries, this.db)
     const result = await this.bindQueryResult({ payloads, schema: ArchivistInsertQuerySchema }, payloads)
     return [result[0]]
   }
+
+  override async start(): Promise<void> {
+    await super.start()
+    // NOTE: We could defer this creation to first access but we
+    // want to fail fast here in case something is wrong
+    this._db = createStore(this.dbName, this.storeName)
+  }
 }