@xyo-network/archivist-indexeddb 2.60.3

package/dist/esm/IndexedDbArchivist.js

@@ -0,0 +1,42 @@
+import { __decorate } from "tslib";
+import { AbstractArchivist } from '@xyo-network/abstract-archivist';
+import { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, } from '@xyo-network/archivist-model';
+import { PayloadHasher } from '@xyo-network/core';
+import { creatableModule } from '@xyo-network/module';
+import { clear, delMany, entries, getMany, setMany } from 'idb-keyval';
+export const IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.storage';
+let IndexedDbArchivist = class IndexedDbArchivist extends AbstractArchivist {
+    static configSchema = IndexedDbArchivistConfigSchema;
+    get queries() {
+        return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries];
+    }
+    async all() {
+        const result = await entries(this.params.indexedDB ?? undefined);
+        return result.map(([_hash, payload]) => payload);
+    }
+    async clear() {
+        await clear(this.params.indexedDB ?? undefined);
+    }
+    async delete(hashes) {
+        await delMany(hashes, this.params.indexedDB ?? undefined);
+        return hashes.map((_) => true);
+    }
+    async get(hashes) {
+        const result = await getMany(hashes, this.params.indexedDB ?? undefined);
+        return result;
+    }
+    async insert(payloads) {
+        const entries = await Promise.all(payloads.map(async (payload) => {
+            const hash = await PayloadHasher.hashAsync(payload);
+            return [hash, payload];
+        }));
+        await setMany(entries, this.params.indexedDB ?? undefined);
+        const result = await this.bindQueryResult({ payloads, schema: ArchivistInsertQuerySchema }, payloads);
+        return [result[0]];
+    }
+};
+IndexedDbArchivist = __decorate([
+    creatableModule()
+], IndexedDbArchivist);
+export { IndexedDbArchivist };
+//# sourceMappingURL=IndexedDbArchivist.js.map

package/dist/esm/IndexedDbArchivist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexedDbArchivist.js","sourceRoot":"","sources":["../../src/IndexedDbArchivist.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EAEzB,0BAA0B,EAC1B,0BAA0B,GAG3B,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAmB,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAEtE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAY,MAAM,YAAY,CAAA;AAGhF,MAAM,CAAC,MAAM,8BAA8B,GAAmC,6CAA6C,CAAA;AAiBpH,IAAM,kBAAkB,GAAxB,MAAM,kBAGX,SAAQ,iBAAsC;IAC9C,MAAM,CAAU,YAAY,GAAG,8BAA8B,CAAA;IAE7D,IAAa,OAAO;QAClB,OAAO,CAAC,uBAAuB,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACvI,CAAC;IAEQ,KAAK,CAAC,GAAG;QAChB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAkB,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;QACjF,OAAO,MAAM,CAAC,GAAG,CAAU,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAA;IAC3D,CAAC;IAEQ,KAAK,CAAC,KAAK;QAClB,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;IACjD,CAAC;IAEQ,KAAK,CAAC,MAAM,CAAC,MAAgB;QACpC,MAAM,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;QACzD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAEQ,KAAK,CAAC,GAAG,CAAC,MAAgB;QACjC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAU,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;QACjF,OAAO,MAAM,CAAA;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAmB;QAC9B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,QAAQ,CAAC,GAAG,CAA6B,KAAK,EAAE,OAAO,EAAE,EAAE;YACzD,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;YACnD,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACxB,CAAC,CAAC,CACH,CAAA;QACD,MAAM,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,CAAA;QAC1D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,0BAA0B,EAAE,EAAE,QAAQ,CAAC,CAAA;QACrG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;;AAvCU,kBAAkB;IAD9B,eAAe,EAAE;GACL,kBAAkB,CAwC9B;SAxCY,kBAAkB"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './IndexedDbArchivist';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}

package/dist/types/IndexedDbArchivist.d.ts

@@ -0,0 +1,27 @@
+import { AbstractArchivist } from '@xyo-network/abstract-archivist';
+import { ArchivistConfig, ArchivistModuleEventData, ArchivistParams } from '@xyo-network/archivist-model';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { AnyConfigSchema } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { UseStore } from 'idb-keyval';
+export type IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.storage';
+export declare const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema;
+export type IndexedDbArchivistConfig = ArchivistConfig<{
+    maxEntries?: number;
+    maxEntrySize?: number;
+    namespace?: string;
+    schema: IndexedDbArchivistConfigSchema;
+}>;
+export type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>, {
+    indexedDB?: UseStore;
+}>;
+export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> {
+    static configSchema: "network.xyo.module.config.archivist.storage";
+    get queries(): string[];
+    all(): Promise<Payload[]>;
+    clear(): Promise<void>;
+    delete(hashes: string[]): Promise<boolean[]>;
+    get(hashes: string[]): Promise<Payload[]>;
+    insert(payloads: Payload[]): Promise<BoundWitness[]>;
+}
+//# sourceMappingURL=IndexedDbArchivist.d.ts.map

package/dist/types/IndexedDbArchivist.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexedDbArchivist.d.ts","sourceRoot":"","sources":["../../src/IndexedDbArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAGL,eAAe,EAGf,wBAAwB,EACxB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAE9D,OAAO,EAAE,eAAe,EAAmB,MAAM,qBAAqB,CAAA;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAA6C,QAAQ,EAAE,MAAM,YAAY,CAAA;AAEhF,MAAM,MAAM,8BAA8B,GAAG,6CAA6C,CAAA;AAC1F,eAAO,MAAM,8BAA8B,EAAE,8BAA8E,CAAA;AAE3H,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC;IACrD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,8BAA8B,CAAA;CACvC,CAAC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,CACpD,eAAe,CAAC,wBAAwB,CAAC,EACzC;IACE,SAAS,CAAC,EAAE,QAAQ,CAAA;CACrB,CACF,CAAA;AAED,qBACa,kBAAkB,CAC7B,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,EACnE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,OAAgB,YAAY,gDAAiC;IAE7D,IAAa,OAAO,aAEnB;IAEc,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAKzB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAK5C,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAKlD,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;CAW3D"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './IndexedDbArchivist';
+//# sourceMappingURL=index.d.ts.map

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

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

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@xyo-network/archivist-indexeddb",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xyo-network/abstract-archivist": "^2.60.3",
+    "@xyo-network/archivist-model": "^2.60.3",
+    "@xyo-network/boundwitness-model": "^2.60.3",
+    "@xyo-network/core": "^2.60.3",
+    "@xyo-network/module": "^2.60.3",
+    "@xyo-network/payload-model": "^2.60.3",
+    "@xyo-network/payload-wrapper": "^2.60.3",
+    "@xyo-network/promise": "^2.60.3",
+    "idb-keyval": "^6.2.1"
+  },
+  "devDependencies": {
+    "@xylabs/delay": "^2.8.1",
+    "@xylabs/ts-scripts-yarn3": "^2.17.13",
+    "@xylabs/tsconfig": "^2.17.13",
+    "@xyo-network/archivist-wrapper": "^2.60.3",
+    "@xyo-network/boundwitness-wrapper": "^2.60.3",
+    "@xyo-network/plugins": "^2.60.3",
+    "fake-indexeddb": "^4.0.1",
+    "typescript": "^5.1.3"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "version": "2.60.3"
+}

package/src/IndexedDbArchivist.ts

@@ -0,0 +1,75 @@
+import { AbstractArchivist } from '@xyo-network/abstract-archivist'
+import {
+  ArchivistAllQuerySchema,
+  ArchivistClearQuerySchema,
+  ArchivistConfig,
+  ArchivistDeleteQuerySchema,
+  ArchivistInsertQuerySchema,
+  ArchivistModuleEventData,
+  ArchivistParams,
+} from '@xyo-network/archivist-model'
+import { BoundWitness } from '@xyo-network/boundwitness-model'
+import { PayloadHasher } from '@xyo-network/core'
+import { AnyConfigSchema, creatableModule } from '@xyo-network/module'
+import { Payload } from '@xyo-network/payload-model'
+import { clear, delMany, entries, getMany, setMany, UseStore } from 'idb-keyval'
+
+export type IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.storage'
+export const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = 'network.xyo.module.config.archivist.storage'
+
+export type IndexedDbArchivistConfig = ArchivistConfig<{
+  maxEntries?: number
+  maxEntrySize?: number
+  namespace?: string
+  schema: IndexedDbArchivistConfigSchema
+}>
+
+export type IndexedDbArchivistParams = ArchivistParams<
+  AnyConfigSchema<IndexedDbArchivistConfig>,
+  {
+    indexedDB?: UseStore
+  }
+>
+
+@creatableModule()
+export class IndexedDbArchivist<
+  TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,
+  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,
+> extends AbstractArchivist<TParams, TEventData> {
+  static override configSchema = IndexedDbArchivistConfigSchema
+
+  override get queries() {
+    return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]
+  }
+
+  override async all(): Promise<Payload[]> {
+    const result = await entries<string, Payload>(this.params.indexedDB ?? undefined)
+    return result.map<Payload>(([_hash, payload]) => payload)
+  }
+
+  override async clear(): Promise<void> {
+    await clear(this.params.indexedDB ?? undefined)
+  }
+
+  override async delete(hashes: string[]): Promise<boolean[]> {
+    await delMany(hashes, this.params.indexedDB ?? undefined)
+    return hashes.map((_) => true)
+  }
+
+  override async get(hashes: string[]): Promise<Payload[]> {
+    const result = await getMany<Payload>(hashes, this.params.indexedDB ?? undefined)
+    return result
+  }
+
+  async insert(payloads: Payload[]): Promise<BoundWitness[]> {
+    const entries = await Promise.all(
+      payloads.map<Promise<[string, Payload]>>(async (payload) => {
+        const hash = await PayloadHasher.hashAsync(payload)
+        return [hash, payload]
+      }),
+    )
+    await setMany(entries, this.params.indexedDB ?? undefined)
+    const result = await this.bindQueryResult({ payloads, schema: ArchivistInsertQuerySchema }, payloads)
+    return [result[0]]
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './IndexedDbArchivist'

package/src/sample.archivist.xyo.json

@@ -0,0 +1,16 @@
+{
+  "payloads": [
+    {
+      "schema": "network.xyo.test.1"
+    },
+    {
+      "schema": "network.xyo.test.2"
+    },
+    {
+      "schema": "network.xyo.test.3"
+    },
+    {
+      "schema": "network.xyo.test.4"
+    }
+  ]
+}

package/src/spec/index.ts

@@ -0,0 +1 @@
+export * from './testArchivist'

package/src/spec/testArchivist.ts

@@ -0,0 +1,56 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { delay } from '@xylabs/delay'
+import { ArchivistModule } from '@xyo-network/archivist-model'
+import { ArchivistWrapper } from '@xyo-network/archivist-wrapper'
+import { BoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
+import { PayloadHasher } from '@xyo-network/core'
+import { Payload } from '@xyo-network/payload-model'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import { IdSchema } from '@xyo-network/plugins'
+import { Promisable } from '@xyo-network/promise'
+
+export const testArchivistRoundTrip = (archivist: Promisable<ArchivistModule>, name: string) => {
+  test(`XyoArchivist RoundTrip [${name}]`, async () => {
+    const idPayload: Payload<{ salt: string }> = {
+      salt: Date.now().toString(),
+      schema: IdSchema,
+    }
+    const payloadWrapper = new PayloadWrapper(idPayload)
+
+    const archivistWrapper = ArchivistWrapper.wrap(await archivist)
+    const insertResult = await archivistWrapper.insert([idPayload])
+    const insertResultWrappers = insertResult.map((bw) => new BoundWitnessWrapper(bw))
+    const insertResultPayload = insertResultWrappers.pop() as BoundWitnessWrapper
+    expect(insertResultPayload).toBeDefined()
+
+    expect(PayloadHasher.find(insertResultPayload.payloadHashes, await payloadWrapper.hashAsync())).toBeDefined()
+    const getResult = await archivistWrapper.get([await payloadWrapper.hashAsync()])
+    expect(getResult).toBeDefined()
+    expect(getResult.length).toBe(1)
+    const gottenPayload = getResult[0]
+    if (gottenPayload) {
+      const gottenPayloadWrapper = new PayloadWrapper(gottenPayload)
+      expect(await gottenPayloadWrapper.hashAsync()).toBe(await payloadWrapper.hashAsync())
+    }
+  })
+}
+
+export const testArchivistAll = (archivist: Promisable<ArchivistModule>, name: string) => {
+  test(`XyoArchivist All [${name}]`, async () => {
+    const idPayload = {
+      salt: Date.now().toString(),
+      schema: IdSchema,
+    }
+    const archivistWrapper = ArchivistWrapper.wrap(await archivist)
+    for (let x = 0; x < 10; x++) {
+      await archivistWrapper.insert([idPayload])
+      await delay(10)
+    }
+    const getResult = await archivistWrapper.all()
+    expect(getResult).toBeDefined()
+    expect(getResult.length).toBe(2)
+  })
+}

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}