@xyo-network/archivist-indexeddb 2.60.3 → 2.60.5

package/dist/cjs/IndexedDbArchivist.js

@@ -1,59 +1,97 @@
 "use strict";
+var IndexedDbArchivist_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IndexedDbArchivist = exports.IndexedDbArchivistConfigSchema = void 0;
 const tslib_1 = require("tslib");
+const assert_1 = require("@xylabs/assert");
 const abstract_archivist_1 = require("@xyo-network/abstract-archivist");
 const archivist_model_1 = require("@xyo-network/archivist-model");
 const core_1 = require("@xyo-network/core");
 const module_1 = require("@xyo-network/module");
 const idb_keyval_1 = require("idb-keyval");
-exports.IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.storage';
-let IndexedDbArchivist = class IndexedDbArchivist extends abstract_archivist_1.AbstractArchivist {
+exports.IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.indexeddb';
+let IndexedDbArchivist = IndexedDbArchivist_1 = class IndexedDbArchivist extends abstract_archivist_1.AbstractArchivist {
+    /**
+     * 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 _a, _b, _c, _d;
+        return (_d = (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.dbName) !== null && _b !== void 0 ? _b : (_c = this.config) === null || _c === void 0 ? void 0 : _c.name) !== null && _d !== void 0 ? _d : IndexedDbArchivist_1.defaultDbName;
+    }
     get queries() {
         return [archivist_model_1.ArchivistAllQuerySchema, archivist_model_1.ArchivistClearQuerySchema, archivist_model_1.ArchivistDeleteQuerySchema, archivist_model_1.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 _a, _b;
+        return (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.storeName) !== null && _b !== void 0 ? _b : IndexedDbArchivist_1.defaultStoreName;
+    }
+    get db() {
+        return (0, assert_1.assertEx)(this._db, 'DB not initialized');
+    }
     all() {
-        var _a;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const result = yield (0, idb_keyval_1.entries)((_a = this.params.indexedDB) !== null && _a !== void 0 ? _a : undefined);
+            const result = yield (0, idb_keyval_1.entries)(this.db);
             return result.map(([_hash, payload]) => payload);
         });
     }
     clear() {
-        var _a;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield (0, idb_keyval_1.clear)((_a = this.params.indexedDB) !== null && _a !== void 0 ? _a : undefined);
+            yield (0, idb_keyval_1.clear)(this.db);
         });
     }
     delete(hashes) {
-        var _a;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield (0, idb_keyval_1.delMany)(hashes, (_a = this.params.indexedDB) !== null && _a !== void 0 ? _a : undefined);
+            yield (0, idb_keyval_1.delMany)(hashes, this.db);
             return hashes.map((_) => true);
         });
     }
     get(hashes) {
-        var _a;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const result = yield (0, idb_keyval_1.getMany)(hashes, (_a = this.params.indexedDB) !== null && _a !== void 0 ? _a : undefined);
+            const result = yield (0, idb_keyval_1.getMany)(hashes, this.db);
             return result;
         });
     }
     insert(payloads) {
-        var _a;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const entries = yield Promise.all(payloads.map((payload) => tslib_1.__awaiter(this, void 0, void 0, function* () {
                 const hash = yield core_1.PayloadHasher.hashAsync(payload);
                 return [hash, payload];
             })));
-            yield (0, idb_keyval_1.setMany)(entries, (_a = this.params.indexedDB) !== null && _a !== void 0 ? _a : undefined);
+            yield (0, idb_keyval_1.setMany)(entries, this.db);
             const result = yield this.bindQueryResult({ payloads, schema: archivist_model_1.ArchivistInsertQuerySchema }, payloads);
             return [result[0]];
         });
     }
+    start() {
+        const _super = Object.create(null, {
+            start: { get: () => super.start }
+        });
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            yield _super.start.call(this);
+            // NOTE: We could defer this creation to first access but we
+            // want to fail fast here in case something is wrong
+            this._db = (0, idb_keyval_1.createStore)(this.dbName, this.storeName);
+        });
+    }
 };
 IndexedDbArchivist.configSchema = exports.IndexedDbArchivistConfigSchema;
-IndexedDbArchivist = tslib_1.__decorate([
+IndexedDbArchivist.defaultDbName = 'archivist';
+IndexedDbArchivist.defaultStoreName = 'payloads';
+IndexedDbArchivist = IndexedDbArchivist_1 = tslib_1.__decorate([
     (0, module_1.creatableModule)()
 ], IndexedDbArchivist);
 exports.IndexedDbArchivist = IndexedDbArchivist;

package/dist/cjs/IndexedDbArchivist.js.map

@@ -1 +1 @@
-{"version":3,"file":"IndexedDbArchivist.js","sourceRoot":"","sources":["../../src/IndexedDbArchivist.ts"],"names":[],"mappings":";;;;AAAA,wEAAmE;AACnE,kEAQqC;AAErC,4CAAiD;AACjD,gDAAsE;AAEtE,2CAAgF;AAGnE,QAAA,8BAA8B,GAAmC,6CAA6C,CAAA;AAiBpH,IAAM,kBAAkB,GAAxB,MAAM,kBAGX,SAAQ,sCAAsC;IAG9C,IAAa,OAAO;QAClB,OAAO,CAAC,yCAAuB,EAAE,2CAAyB,EAAE,4CAA0B,EAAE,4CAA0B,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACvI,CAAC;IAEc,GAAG;;;YAChB,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAO,EAAkB,MAAA,IAAI,CAAC,MAAM,CAAC,SAAS,mCAAI,SAAS,CAAC,CAAA;YACjF,OAAO,MAAM,CAAC,GAAG,CAAU,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAA;;KAC1D;IAEc,KAAK;;;YAClB,MAAM,IAAA,kBAAK,EAAC,MAAA,IAAI,CAAC,MAAM,CAAC,SAAS,mCAAI,SAAS,CAAC,CAAA;;KAChD;IAEc,MAAM,CAAC,MAAgB;;;YACpC,MAAM,IAAA,oBAAO,EAAC,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,CAAC,SAAS,mCAAI,SAAS,CAAC,CAAA;YACzD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAA;;KAC/B;IAEc,GAAG,CAAC,MAAgB;;;YACjC,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAO,EAAU,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,CAAC,SAAS,mCAAI,SAAS,CAAC,CAAA;YACjF,OAAO,MAAM,CAAA;;KACd;IAEK,MAAM,CAAC,QAAmB;;;YAC9B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,QAAQ,CAAC,GAAG,CAA6B,CAAO,OAAO,EAAE,EAAE;gBACzD,MAAM,IAAI,GAAG,MAAM,oBAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;gBACnD,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACxB,CAAC,CAAA,CAAC,CACH,CAAA;YACD,MAAM,IAAA,oBAAO,EAAC,OAAO,EAAE,MAAA,IAAI,CAAC,MAAM,CAAC,SAAS,mCAAI,SAAS,CAAC,CAAA;YAC1D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,4CAA0B,EAAE,EAAE,QAAQ,CAAC,CAAA;YACrG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;;KACnB;;AAnCe,+BAAY,GAAG,sCAA8B,CAAA;AAJlD,kBAAkB;IAD9B,IAAA,wBAAe,GAAE;GACL,kBAAkB,CAwC9B;AAxCY,gDAAkB"}
+{"version":3,"file":"IndexedDbArchivist.js","sourceRoot":"","sources":["../../src/IndexedDbArchivist.ts"],"names":[],"mappings":";;;;;AAAA,2CAAyC;AACzC,wEAAmE;AACnE,kEAQqC;AAErC,4CAAiD;AACjD,gDAAsE;AAEtE,2CAA6F;AAGhF,QAAA,8BAA8B,GAAmC,+CAA+C,CAAA;AAiBtH,IAAM,kBAAkB,0BAAxB,MAAM,kBAGX,SAAQ,sCAAsC;IAO9C;;;;;;OAMG;IACH,IAAI,MAAM;;QACR,OAAO,MAAA,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,MAAM,mCAAI,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,mCAAI,oBAAkB,CAAC,aAAa,CAAA;IACrF,CAAC;IAED,IAAa,OAAO;QAClB,OAAO,CAAC,yCAAuB,EAAE,2CAAyB,EAAE,4CAA0B,EAAE,4CAA0B,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACvI,CAAC;IACD;;;;;;;;;OASG;IACH,IAAI,SAAS;;QACX,OAAO,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,SAAS,mCAAI,oBAAkB,CAAC,gBAAgB,CAAA;IACtE,CAAC;IAED,IAAY,EAAE;QACZ,OAAO,IAAA,iBAAQ,EAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAA;IACjD,CAAC;IAEc,GAAG;;YAChB,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAO,EAAkB,IAAI,CAAC,EAAE,CAAC,CAAA;YACtD,OAAO,MAAM,CAAC,GAAG,CAAU,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAA;QAC3D,CAAC;KAAA;IAEc,KAAK;;YAClB,MAAM,IAAA,kBAAK,EAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACtB,CAAC;KAAA;IAEc,MAAM,CAAC,MAAgB;;YACpC,MAAM,IAAA,oBAAO,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;YAC9B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC;KAAA;IAEc,GAAG,CAAC,MAAgB;;YACjC,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAO,EAAU,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;YACtD,OAAO,MAAM,CAAA;QACf,CAAC;KAAA;IAEK,MAAM,CAAC,QAAmB;;YAC9B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,QAAQ,CAAC,GAAG,CAA6B,CAAO,OAAO,EAAE,EAAE;gBACzD,MAAM,IAAI,GAAG,MAAM,oBAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;gBACnD,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACxB,CAAC,CAAA,CAAC,CACH,CAAA;YACD,MAAM,IAAA,oBAAO,EAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;YAC/B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,4CAA0B,EAAE,EAAE,QAAQ,CAAC,CAAA;YACrG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QACpB,CAAC;KAAA;IAEc,KAAK;;;;;YAClB,MAAM,OAAM,KAAK,WAAE,CAAA;YACnB,4DAA4D;YAC5D,oDAAoD;YACpD,IAAI,CAAC,GAAG,GAAG,IAAA,wBAAW,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;QACrD,CAAC;KAAA;;AA1Ee,+BAAY,GAAG,sCAA8B,CAAA;AACtD,gCAAa,GAAG,WAAW,CAAA;AAC3B,mCAAgB,GAAG,UAAU,CAAA;AANzB,kBAAkB;IAD9B,IAAA,wBAAe,GAAE;GACL,kBAAkB,CA+E9B;AA/EY,gDAAkB"}