@xyo-network/diviner-boundwitness-indexeddb 4.0.2 → 4.1.0

package/dist/browser/index.d.ts

@@ -0,0 +1,78 @@
+import { IndexDescription } from '@xyo-network/archivist-model';
+import { DivinerConfig, DivinerParams } from '@xyo-network/diviner-model';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { BoundWitnessDiviner } from '@xyo-network/diviner-boundwitness-abstract';
+import { BoundWitnessDivinerQueryPayload } from '@xyo-network/diviner-boundwitness-model';
+import { Schema } from '@xyo-network/payload-model';
+import { AnyConfigSchema } from '@xyo-network/module-model';
+
+declare const IndexedDbBoundWitnessDivinerConfigSchema: "network.xyo.diviner.boundwitness.indexeddb.config";
+type IndexedDbBoundWitnessDivinerConfigSchema = typeof IndexedDbBoundWitnessDivinerConfigSchema;
+type IndexedDbBoundWitnessDivinerConfig = DivinerConfig<{
+    /**
+     * The database name
+     */
+    dbName?: string;
+    /**
+     * The version of the DB, defaults to 1
+     */
+    dbVersion?: number;
+    schema: IndexedDbBoundWitnessDivinerConfigSchema;
+    /**
+     * 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;
+}>;
+
+type IndexedDbBoundWitnessDivinerParams = DivinerParams<AnyConfigSchema<IndexedDbBoundWitnessDivinerConfig>>;
+
+declare class IndexedDbBoundWitnessDiviner<TParams extends IndexedDbBoundWitnessDivinerParams = IndexedDbBoundWitnessDivinerParams, TIn extends BoundWitnessDivinerQueryPayload = BoundWitnessDivinerQueryPayload, TOut extends BoundWitness = BoundWitness> extends BoundWitnessDiviner<TParams, TIn, TOut> {
+    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<void>;
+    /**
+     * 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;
+}
+
+declare const IndexedDbBoundWitnessDivinerSchema: "network.xyo.diviner.boundwitness.indexeddb";
+type IndexedDbBoundWitnessDivinerSchema = typeof IndexedDbBoundWitnessDivinerSchema;
+
+export { IndexedDbBoundWitnessDiviner, IndexedDbBoundWitnessDivinerConfigSchema, IndexedDbBoundWitnessDivinerSchema };
+export type { IndexedDbBoundWitnessDivinerConfig, IndexedDbBoundWitnessDivinerParams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-boundwitness-indexeddb",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,36 +21,36 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/browser/index.d.ts",
       "default": "./dist/browser/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/browser/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/browser/index.d.ts",
   "dependencies": {
-    "@xylabs/array": "^4.12.33",
-    "@xylabs/assert": "^4.12.33",
-    "@xylabs/exists": "^4.12.33",
-    "@xyo-network/archivist-indexeddb": "^4.0.2",
-    "@xyo-network/archivist-model": "^4.0.2",
-    "@xyo-network/boundwitness-model": "^4.0.2",
-    "@xyo-network/diviner-boundwitness-abstract": "^4.0.2",
-    "@xyo-network/diviner-boundwitness-model": "^4.0.2",
-    "@xyo-network/diviner-model": "^4.0.2",
-    "@xyo-network/module-model": "^4.0.2",
-    "@xyo-network/payload-model": "^4.0.2",
+    "@xylabs/array": "^4.13.15",
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/exists": "^4.13.15",
+    "@xyo-network/archivist-indexeddb": "^4.1.0",
+    "@xyo-network/archivist-model": "^4.1.0",
+    "@xyo-network/boundwitness-model": "^4.1.0",
+    "@xyo-network/diviner-boundwitness-abstract": "^4.1.0",
+    "@xyo-network/diviner-boundwitness-model": "^4.1.0",
+    "@xyo-network/diviner-model": "^4.1.0",
+    "@xyo-network/module-model": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0",
     "idb": "^8.0.3"
   },
   "devDependencies": {
-    "@xylabs/delay": "^4.12.33",
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
-    "@xylabs/tsconfig": "^6.5.12",
-    "@xylabs/vitest-extended": "^4.12.33",
-    "@xyo-network/archivist-indexeddb": "^4.0.2",
-    "@xyo-network/boundwitness-builder": "^4.0.2",
-    "@xyo-network/node-memory": "^4.0.2",
-    "@xyo-network/payload-builder": "^4.0.2",
+    "@xylabs/delay": "^4.13.15",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/vitest-extended": "^4.13.15",
+    "@xyo-network/archivist-indexeddb": "^4.1.0",
+    "@xyo-network/boundwitness-builder": "^4.1.0",
+    "@xyo-network/node-memory": "^4.1.0",
+    "@xyo-network/payload-builder": "^4.1.0",
     "fake-indexeddb": "^6.0.1",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"