@xyo-network/diviner-payload-indexeddb 3.7.2 → 3.8.1

package/dist/browser/index.d.ts

@@ -1,5 +1,37 @@
-export * from './Config.ts';
-export * from './Diviner.ts';
-export * from './Params.ts';
-export * from './Schema.ts';
-//# sourceMappingURL=index.d.ts.map
+import { IndexDescription } from '@xyo-network/archivist-model';
+import { DivinerConfig, DivinerParams, DivinerModuleEventData, DivinerInstance } from '@xyo-network/diviner-model';
+import { PayloadDiviner } from '@xyo-network/diviner-payload-abstract';
+import { PayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model';
+import { Payload, Schema } from '@xyo-network/payload-model';
+import { AnyConfigSchema } from '@xyo-network/module-model';
+
+declare const IndexedDbPayloadDivinerConfigSchema: "network.xyo.diviner.payload.indexeddb.config";
+type IndexedDbPayloadDivinerConfigSchema = typeof IndexedDbPayloadDivinerConfigSchema;
+type IndexedDbPayloadDivinerConfig = DivinerConfig<{
+    dbName?: string;
+    dbVersion?: number;
+    schema: IndexedDbPayloadDivinerConfigSchema;
+    storage?: {
+        indexes?: IndexDescription[];
+    };
+    storeName?: string;
+}>;
+
+type IndexedDbPayloadDivinerParams = DivinerParams<AnyConfigSchema<IndexedDbPayloadDivinerConfig>>;
+
+declare class IndexedDbPayloadDiviner<TParams extends IndexedDbPayloadDivinerParams = IndexedDbPayloadDivinerParams, TIn extends PayloadDivinerQueryPayload = PayloadDivinerQueryPayload, TOut extends Payload = Payload, TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>> extends PayloadDiviner<TParams, TIn, TOut, TEventData> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    get dbName(): string;
+    get dbVersion(): number;
+    get storeName(): string;
+    protected divineHandler(payloads?: TIn[]): Promise<TOut[]>;
+    protected startHandler(): Promise<boolean>;
+    private tryGetInitializedDb;
+    private tryUseDb;
+}
+
+declare const IndexedDbPayloadDivinerSchema: "network.xyo.diviner.payload.indexeddb";
+type IndexedDbPayloadDivinerSchema = typeof IndexedDbPayloadDivinerSchema;
+
+export { IndexedDbPayloadDiviner, type IndexedDbPayloadDivinerConfig, IndexedDbPayloadDivinerConfigSchema, type IndexedDbPayloadDivinerParams, IndexedDbPayloadDivinerSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-payload-indexeddb",
-  "version": "3.7.2",
+  "version": "3.8.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -33,25 +33,25 @@
     "@xylabs/assert": "^4.5.1",
     "@xylabs/exists": "^4.5.1",
     "@xylabs/object": "^4.5.1",
-    "@xyo-network/archivist-indexeddb": "^3.7.2",
-    "@xyo-network/archivist-model": "^3.7.2",
-    "@xyo-network/diviner-model": "^3.7.2",
-    "@xyo-network/diviner-payload-abstract": "^3.7.2",
-    "@xyo-network/diviner-payload-model": "^3.7.2",
-    "@xyo-network/module-model": "^3.7.2",
-    "@xyo-network/payload-model": "^3.7.2",
-    "idb": "^8.0.1"
+    "@xyo-network/archivist-indexeddb": "^3.8.1",
+    "@xyo-network/archivist-model": "^3.8.1",
+    "@xyo-network/diviner-model": "^3.8.1",
+    "@xyo-network/diviner-payload-abstract": "^3.8.1",
+    "@xyo-network/diviner-payload-model": "^3.8.1",
+    "@xyo-network/module-model": "^3.8.1",
+    "@xyo-network/payload-model": "^3.8.1",
+    "idb": "^8.0.2"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.6",
-    "@xylabs/tsconfig": "^4.2.6",
+    "@xylabs/ts-scripts-yarn3": "^5.0.22",
+    "@xylabs/tsconfig": "^5.0.22",
     "@xylabs/vitest-extended": "^4.5.1",
-    "@xyo-network/archivist-indexeddb": "^3.7.2",
-    "@xyo-network/node-memory": "^3.7.2",
-    "@xyo-network/payload-builder": "^3.7.2",
+    "@xyo-network/archivist-indexeddb": "^3.8.1",
+    "@xyo-network/node-memory": "^3.8.1",
+    "@xyo-network/payload-builder": "^3.8.1",
     "fake-indexeddb": "^6.0.0",
     "typescript": "^5.7.3",
-    "vitest": "^3.0.4"
+    "vitest": "^3.0.5"
   },
   "publishConfig": {
     "access": "public"

package/dist/browser/Config.d.ts

@@ -1,30 +0,0 @@
-import type { IndexDescription } from '@xyo-network/archivist-model';
-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 +0,0 @@
-{"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

@@ -1,40 +0,0 @@
-import type { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model';
-import { PayloadDiviner } from '@xyo-network/diviner-payload-abstract';
-import type { PayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model';
-import type { Payload, Schema } from '@xyo-network/payload-model';
-import type { IndexedDbPayloadDivinerParams } from './Params.ts';
-export declare class IndexedDbPayloadDiviner<TParams extends IndexedDbPayloadDivinerParams = IndexedDbPayloadDivinerParams, TIn extends PayloadDivinerQueryPayload = PayloadDivinerQueryPayload, TOut extends Payload = Payload, TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>> extends PayloadDiviner<TParams, TIn, TOut, TEventData> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    /**
-     * 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>;
-    /**
-     * 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 +0,0 @@
-{"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAKA,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;AAEpF,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAChB,MAAM,4BAA4B,CAAA;AAKnC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAA;AAoBhE,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;;;;;;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;cAkEhD,YAAY;IAKrC;;;OAGG;YACW,mBAAmB;IAwBjC;;;;OAIG;YACW,QAAQ;CAcvB"}

package/dist/browser/Params.d.ts

@@ -1,5 +0,0 @@
-import type { DivinerParams } from '@xyo-network/diviner-model';
-import type { AnyConfigSchema } from '@xyo-network/module-model';
-import type { IndexedDbPayloadDivinerConfig } from './Config.ts';
-export type IndexedDbPayloadDivinerParams = DivinerParams<AnyConfigSchema<IndexedDbPayloadDivinerConfig>>;
-//# sourceMappingURL=Params.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../src/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAA;AAEhE,MAAM,MAAM,6BAA6B,GAAG,aAAa,CAAC,eAAe,CAAC,6BAA6B,CAAC,CAAC,CAAA"}

package/dist/browser/Schema.d.ts

@@ -1,3 +0,0 @@
-export declare const IndexedDbPayloadDivinerSchema: "network.xyo.diviner.payload.indexeddb";
-export type IndexedDbPayloadDivinerSchema = typeof IndexedDbPayloadDivinerSchema;
-//# sourceMappingURL=Schema.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,6BAA6B,yCAA+C,CAAA;AACzF,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAA"}

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

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