@xyo-network/archivist-indexeddb 3.9.17 → 3.9.19

package/dist/browser/Archivist.d.ts

@@ -0,0 +1,74 @@
+import { Hash, Hex } from '@xylabs/hex';
+import { ObjectStore } from '@xylabs/indexed-db';
+import { AbstractArchivist } from '@xyo-network/archivist-abstract';
+import { ArchivistModuleEventData, ArchivistNextOptions } from '@xyo-network/archivist-model';
+import { Payload, Schema, WithStorageMeta } from '@xyo-network/payload-model';
+import { IDBPDatabase } from 'idb';
+import { IndexedDbArchivistParams } from './Params.ts';
+export interface PayloadStore {
+    [s: string]: WithStorageMeta;
+}
+export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    static readonly defaultDbName = "archivist";
+    static readonly defaultDbVersion = 1;
+    static readonly defaultStoreName = "payloads";
+    private static readonly dataHashIndex;
+    private static readonly hashIndex;
+    private static readonly schemaIndex;
+    private static readonly sequenceIndex;
+    static readonly hashIndexName: string;
+    static readonly dataHashIndexName: string;
+    static readonly schemaIndexName: string;
+    static readonly sequenceIndexName: string;
+    private _dbName?;
+    private _dbVersion?;
+    private _storeName?;
+    /**
+     * 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;
+    /**
+     * The database version. If not supplied via config, it defaults to 1.
+     */
+    get dbVersion(): number;
+    get queries(): string[];
+    /**
+     * The name of the object store. If not supplied via config, it defaults
+     * to `payloads`.
+     */
+    get storeName(): string;
+    /**
+     * The indexes to create on the store
+     */
+    private get indexes();
+    protected allHandler(): Promise<WithStorageMeta<Payload>[]>;
+    protected clearHandler(): Promise<void>;
+    protected deleteHandler(hashes: Hash[]): Promise<Hash[]>;
+    protected getFromCursor(db: IDBPDatabase<ObjectStore>, storeName: string, order?: 'asc' | 'desc', limit?: number, cursor?: Hex, open?: boolean): Promise<WithStorageMeta[]>;
+    /**
+     * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)
+     * @param db The db instance to use
+     * @param storeName The name of the store to use
+     * @param indexName The index to use
+     * @param key The key to get from the index
+     * @returns The primary key and the payload, or undefined if not found
+     */
+    protected getFromIndexWithPrimaryKey(db: IDBPDatabase<ObjectStore>, storeName: string, indexName: string, key: IDBValidKey): Promise<[number, WithStorageMeta] | undefined>;
+    protected getHandler(hashes: string[]): Promise<WithStorageMeta[]>;
+    protected insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]>;
+    protected nextHandler(options?: ArchivistNextOptions): Promise<WithStorageMeta<Payload>[]>;
+    protected startHandler(): Promise<boolean>;
+    /**
+     * Executes a callback with the initialized DB and then closes the db
+     * @param callback The method to execute with the initialized DB
+     * @returns
+     */
+    private useDb;
+}
+//# sourceMappingURL=Archivist.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EACL,WAAW,EAGZ,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAKL,wBAAwB,EACxB,oBAAoB,EAIrB,MAAM,8BAA8B,CAAA;AAGrC,OAAO,EACL,OAAO,EAAE,MAAM,EAAE,eAAe,EACjC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAuB,YAAY,EAAE,MAAM,KAAK,CAAA;AAGvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAEtD,MAAM,WAAW,YAAY;IAC3B,CAAC,CAAC,EAAE,MAAM,GAAG,eAAe,CAAA;CAC7B;AAED,qBACa,kBAAkB,CAC7B,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,EACnE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAA2D;IAC3G,gBAAyB,mBAAmB,EAAE,MAAM,CAAiC;IACrF,MAAM,CAAC,QAAQ,CAAC,aAAa,eAAc;IAC3C,MAAM,CAAC,QAAQ,CAAC,gBAAgB,KAAI;IACpC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,cAAa;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAEpC;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAEhC;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAElC;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAEpC;IAGD,MAAM,CAAC,QAAQ,CAAC,aAAa,SAAuD;IAEpF,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAA2D;IAE5F,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAyD;IAExF,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAA2D;IAE5F,OAAO,CAAC,OAAO,CAAC,CAAQ;IACxB,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAE3B;;;;;;OAMG;IACH,IAAI,MAAM,WAeT;IAED;;OAEG;IACH,IAAI,SAAS,WAGZ;IAED,IAAa,OAAO,aASnB;IAED;;;OAGG;IACH,IAAI,SAAS,WAUZ;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAQlB;cAEwB,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAOjD,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;cAI7B,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;cA+BvD,aAAa,CAC3B,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,EAC7B,SAAS,EAAE,MAAM,EACf,KAAK,GAAE,KAAK,GAAG,MAAc,EAC7B,KAAK,GAAE,MAAW,EAClB,MAAM,CAAC,EAAE,GAAG,EACZ,IAAI,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,eAAe,EAAE,CAAC;IAsC7B;;;;;;;OAOG;cACa,0BAA0B,CACxC,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,EAC7B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,WAAW,GACf,OAAO,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,SAAS,CAAC;cAkBxB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;cAmCxD,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cA6BxF,WAAW,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAShF,YAAY;IAQrC;;;;OAIG;YACW,KAAK;CAKpB"}

package/dist/browser/Config.d.ts

@@ -0,0 +1,20 @@
+import type { ArchivistConfig } from '@xyo-network/archivist-model';
+import { IndexedDbArchivistSchema } from './Schema.ts';
+export type IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`;
+export declare const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema;
+export type IndexedDbArchivistConfig<TStoreName extends string = string> = ArchivistConfig<{
+    /**
+     * The database name
+     */
+    dbName?: string;
+    /**
+     * The version of the DB, defaults to 1
+     */
+    dbVersion?: number;
+    schema: IndexedDbArchivistConfigSchema;
+    /**
+     * The name of the object store
+     */
+    storeName?: TStoreName;
+}>;
+//# sourceMappingURL=Config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAEnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAEtD,MAAM,MAAM,8BAA8B,GAAG,GAAG,wBAAwB,SAAS,CAAA;AACjF,eAAO,MAAM,8BAA8B,EAAE,8BAAqE,CAAA;AAElH,MAAM,MAAM,wBAAwB,CAAC,UAAU,SAAS,MAAM,GAAG,MAAM,IAAI,eAAe,CAAC;IACzF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,8BAA8B,CAAA;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,UAAU,CAAA;CACvB,CAAC,CAAA"}

package/dist/browser/Params.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../src/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAE3D,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC,CAAA"}

package/dist/browser/Schema.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,wBAAwB,EAAG,iCAA0C,CAAA;AAClF,MAAM,MAAM,wBAAwB,GAAG,OAAO,wBAAwB,CAAA"}

package/dist/browser/index.d.ts

@@ -1,60 +1,5 @@
-import { Hash, Hex } from '@xylabs/hex';
-import { ObjectStore } from '@xylabs/indexed-db';
-import { AbstractArchivist } from '@xyo-network/archivist-abstract';
-import { ArchivistConfig, ArchivistParams, ArchivistModuleEventData, ArchivistNextOptions } from '@xyo-network/archivist-model';
-import { WithStorageMeta, Schema, Payload } from '@xyo-network/payload-model';
-import { IDBPDatabase } from 'idb';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-
-declare const IndexedDbArchivistSchema: "network.xyo.archivist.indexeddb";
-type IndexedDbArchivistSchema = typeof IndexedDbArchivistSchema;
-
-type IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`;
-declare const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema;
-type IndexedDbArchivistConfig<TStoreName extends string = string> = ArchivistConfig<{
-    dbName?: string;
-    dbVersion?: number;
-    schema: IndexedDbArchivistConfigSchema;
-    storeName?: TStoreName;
-}>;
-
-type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>;
-
-interface PayloadStore {
-    [s: string]: WithStorageMeta;
-}
-declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    static readonly defaultDbName = "archivist";
-    static readonly defaultDbVersion = 1;
-    static readonly defaultStoreName = "payloads";
-    private static readonly dataHashIndex;
-    private static readonly hashIndex;
-    private static readonly schemaIndex;
-    private static readonly sequenceIndex;
-    static readonly hashIndexName: string;
-    static readonly dataHashIndexName: string;
-    static readonly schemaIndexName: string;
-    static readonly sequenceIndexName: string;
-    private _dbName?;
-    private _dbVersion?;
-    private _storeName?;
-    get dbName(): string;
-    get dbVersion(): number;
-    get queries(): string[];
-    get storeName(): string;
-    private get indexes();
-    protected allHandler(): Promise<WithStorageMeta<Payload>[]>;
-    protected clearHandler(): Promise<void>;
-    protected deleteHandler(hashes: Hash[]): Promise<Hash[]>;
-    protected getFromCursor(db: IDBPDatabase<ObjectStore>, storeName: string, order?: 'asc' | 'desc', limit?: number, cursor?: Hex, open?: boolean): Promise<WithStorageMeta[]>;
-    protected getFromIndexWithPrimaryKey(db: IDBPDatabase<ObjectStore>, storeName: string, indexName: string, key: IDBValidKey): Promise<[number, WithStorageMeta] | undefined>;
-    protected getHandler(hashes: string[]): Promise<WithStorageMeta[]>;
-    protected insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]>;
-    protected nextHandler(options?: ArchivistNextOptions): Promise<WithStorageMeta<Payload>[]>;
-    protected startHandler(): Promise<boolean>;
-    private useDb;
-}
-
-export { IndexedDbArchivist, type IndexedDbArchivistConfig, IndexedDbArchivistConfigSchema, type IndexedDbArchivistParams, IndexedDbArchivistSchema, type PayloadStore };
+export * from './Archivist.ts';
+export * from './Config.ts';
+export * from './Params.ts';
+export * from './Schema.ts';
+//# sourceMappingURL=index.d.ts.map

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-indexeddb",
-  "version": "3.9.17",
+  "version": "3.9.19",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -34,26 +34,26 @@
     "@xylabs/exists": "^4.5.1",
     "@xylabs/hex": "^4.5.1",
     "@xylabs/indexed-db": "^4.5.1",
-    "@xyo-network/archivist-abstract": "^3.9.17",
-    "@xyo-network/archivist-model": "^3.9.17",
-    "@xyo-network/module-model": "^3.9.17",
-    "@xyo-network/payload-builder": "^3.9.17",
-    "@xyo-network/payload-model": "^3.9.17",
+    "@xyo-network/archivist-abstract": "^3.9.19",
+    "@xyo-network/archivist-model": "^3.9.19",
+    "@xyo-network/module-model": "^3.9.19",
+    "@xyo-network/payload-builder": "^3.9.19",
+    "@xyo-network/payload-model": "^3.9.19",
     "idb": "^8.0.2"
   },
   "devDependencies": {
     "@xylabs/delay": "^4.5.1",
     "@xylabs/object": "^4.5.1",
-    "@xylabs/ts-scripts-yarn3": "^5.0.24",
-    "@xylabs/tsconfig": "^5.0.24",
-    "@xyo-network/account": "^3.9.17",
-    "@xyo-network/archivist-acceptance-tests": "^3.9.17",
-    "@xyo-network/id-payload-plugin": "^3.9.17",
-    "@xyo-network/payload-wrapper": "^3.9.17",
+    "@xylabs/ts-scripts-yarn3": "^5.0.39",
+    "@xylabs/tsconfig": "^5.0.39",
+    "@xyo-network/account": "^3.9.19",
+    "@xyo-network/archivist-acceptance-tests": "^3.9.19",
+    "@xyo-network/id-payload-plugin": "^3.9.19",
+    "@xyo-network/payload-wrapper": "^3.9.19",
     "fake-indexeddb": "^6.0.0",
-    "typescript": "^5.7.3",
+    "typescript": "^5.8.2",
     "uuid": "^11.1.0",
-    "vitest": "^3.0.6"
+    "vitest": "^3.0.7"
   },
   "publishConfig": {
     "access": "public"