@xyo-network/diviner-payload-indexeddb 3.2.0 → 3.3.1

package/dist/browser/Config.d.ts

@@ -3,12 +3,28 @@ import type { DivinerConfig } from '@xyo-network/diviner-model';
 export declare const IndexedDbPayloadDivinerConfigSchema: "network.xyo.diviner.payload.indexeddb.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;
 }>;
 //# sourceMappingURL=Config.d.ts.map

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

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

package/dist/browser/Diviner.d.ts

@@ -7,14 +7,37 @@ export declare class IndexedDbPayloadDiviner<TParams extends IndexedDbPayloadDiv
     static readonly configSchemas: Schema[];
     static readonly defaultConfigSchema: Schema;
     private _db;
+    /**
+     * The database name. If not supplied via config, it defaults
+     * to the archivist's name and if archivist's 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;
+    /**
+     * The database version. If not supplied via config, it defaults to the archivist default version.
+     */
     get dbVersion(): number;
+    /**
+     * The name of the object store. If not supplied via config, it defaults
+     * to `payloads`.
+     */
     get storeName(): string;
     protected divineHandler(payloads?: TIn[]): Promise<TOut[]>;
     protected startHandler(): Promise<boolean>;
     private getKeyRangeValue;
     private selectBestIndex;
+    /**
+     * Checks that the desired DB/objectStore exists and is initialized to the correct version
+     * @returns The initialized DB or undefined if it does not exist in the desired state
+     */
     private tryGetInitializedDb;
+    /**
+     * Executes a callback with the initialized DB and then closes the db
+     * @param callback The method to execute with the initialized DB
+     * @returns
+     */
     private tryUseDb;
 }
 //# sourceMappingURL=Diviner.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA;AACtE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAA;AAGpF,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAChB,MAAM,4BAA4B,CAAA;AAKnC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAA;AA4BhE,qBAAa,uBAAuB,CAClC,OAAO,SAAS,6BAA6B,GAAG,6BAA6B,EAC7E,GAAG,SAAS,0BAA0B,GAAG,0BAA0B,EACnE,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CACD,SAAQ,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACtD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAgE;IAChH,gBAAyB,mBAAmB,EAAE,MAAM,CAAsC;IAE1F,OAAO,CAAC,GAAG,CAAwC;IASnD,IAAI,MAAM,WAET;IAKD,IAAI,SAAS,WAEZ;IAMD,IAAI,SAAS,WAEZ;cAEwB,aAAa,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;cAsEhD,YAAY;IAKrC,OAAO,CAAC,gBAAgB;IAWxB,OAAO,CAAC,eAAe;YAwBT,mBAAmB;YA6BnB,QAAQ;CAcvB"}
+{"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA;AACtE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAA;AAGpF,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAChB,MAAM,4BAA4B,CAAA;AAKnC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAA;AA4BhE,qBAAa,uBAAuB,CAClC,OAAO,SAAS,6BAA6B,GAAG,6BAA6B,EAC7E,GAAG,SAAS,0BAA0B,GAAG,0BAA0B,EACnE,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CACD,SAAQ,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACtD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAgE;IAChH,gBAAyB,mBAAmB,EAAE,MAAM,CAAsC;IAE1F,OAAO,CAAC,GAAG,CAAwC;IAEnD;;;;;;OAMG;IACH,IAAI,MAAM,WAET;IAED;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED;;;OAGG;IACH,IAAI,SAAS,WAEZ;cAEwB,aAAa,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;cAsEhD,YAAY;IAKrC,OAAO,CAAC,gBAAgB;IAWxB,OAAO,CAAC,eAAe;IAoBvB;;;OAGG;YACW,mBAAmB;IAwBjC;;;;OAIG;YACW,QAAQ;CAcvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-payload-indexeddb",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,28 +29,28 @@
   "module": "dist/browser/index.mjs",
   "types": "dist/browser/index.d.ts",
   "dependencies": {
-    "@xylabs/array": "^4.1.0",
-    "@xylabs/assert": "^4.1.0",
-    "@xylabs/exists": "^4.1.0",
-    "@xylabs/hex": "^4.1.0",
-    "@xylabs/object": "^4.1.0",
-    "@xyo-network/archivist-indexeddb": "^3.2.0",
-    "@xyo-network/archivist-model": "^3.2.0",
-    "@xyo-network/diviner-model": "^3.2.0",
-    "@xyo-network/diviner-payload-abstract": "^3.2.0",
-    "@xyo-network/diviner-payload-model": "^3.2.0",
-    "@xyo-network/module-model": "^3.2.0",
-    "@xyo-network/payload-builder": "^3.2.0",
-    "@xyo-network/payload-model": "^3.2.0",
+    "@xylabs/array": "^4.3.2",
+    "@xylabs/assert": "^4.3.2",
+    "@xylabs/exists": "^4.3.2",
+    "@xylabs/hex": "^4.3.2",
+    "@xylabs/object": "^4.3.2",
+    "@xyo-network/archivist-indexeddb": "^3.3.1",
+    "@xyo-network/archivist-model": "^3.3.1",
+    "@xyo-network/diviner-model": "^3.3.1",
+    "@xyo-network/diviner-payload-abstract": "^3.3.1",
+    "@xyo-network/diviner-payload-model": "^3.3.1",
+    "@xyo-network/module-model": "^3.3.1",
+    "@xyo-network/payload-builder": "^3.3.1",
+    "@xyo-network/payload-model": "^3.3.1",
     "idb": "^8.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.1.0",
-    "@xylabs/tsconfig": "^4.1.0",
-    "@xyo-network/archivist-indexeddb": "^3.2.0",
-    "@xyo-network/node-memory": "^3.2.0",
+    "@xylabs/ts-scripts-yarn3": "^4.2.3",
+    "@xylabs/tsconfig": "^4.2.3",
+    "@xyo-network/archivist-indexeddb": "^3.3.1",
+    "@xyo-network/node-memory": "^3.3.1",
     "fake-indexeddb": "^6.0.0",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.3"
   },
   "publishConfig": {
     "access": "public"