@xyo-network/archivist-storage 2.85.6

package/dist/node/index.js

@@ -0,0 +1,161 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+// src/StorageArchivist.ts
+import { assertEx } from "@xylabs/assert";
+import { compact } from "@xylabs/lodash";
+import { fulfilled } from "@xylabs/promise";
+import { AbstractArchivist } from "@xyo-network/archivist-abstract";
+import { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistCommitQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema } from "@xyo-network/archivist-model";
+import { PayloadHasher } from "@xyo-network/hash";
+import { PayloadWrapper } from "@xyo-network/payload-wrapper";
+import store from "store2";
+var StorageArchivistConfigSchema = "network.xyo.archivist.storage.config";
+var _StorageArchivist = class _StorageArchivist extends AbstractArchivist {
+  _privateStorage;
+  _storage;
+  get maxEntries() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.maxEntries) ?? 1e3;
+  }
+  get maxEntrySize() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.maxEntrySize) ?? 16e3;
+  }
+  get namespace() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.namespace) ?? "xyo-archivist";
+  }
+  get persistAccount() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.persistAccount) ?? false;
+  }
+  get queries() {
+    return [
+      ArchivistAllQuerySchema,
+      ArchivistDeleteQuerySchema,
+      ArchivistClearQuerySchema,
+      ArchivistInsertQuerySchema,
+      ArchivistCommitQuerySchema,
+      ...super.queries
+    ];
+  }
+  get type() {
+    var _a;
+    return ((_a = this.config) == null ? void 0 : _a.type) ?? "local";
+  }
+  /* This has to be a getter so that it can access it during construction */
+  get privateStorage() {
+    this._privateStorage = this._storage ?? store[this.type].namespace(`${this.namespace}|private`);
+    return this._privateStorage;
+  }
+  /* This has to be a getter so that it can access it during construction */
+  get storage() {
+    this._storage = this._storage ?? store[this.type].namespace(this.namespace);
+    return this._storage;
+  }
+  /*override async loadAccount(account?: AccountInstance, persistAccount?: boolean, privateStorage?: StoreBase, _logger?: Logger) {
+    if (!this._account) {
+      if (persistAccount) {
+        const privateKey = privateStorage?.get('privateKey')
+        if (privateKey) {
+          try {
+            this._account = await Account.create({ privateKey })
+            return this._account
+          } catch (ex) {
+            console.error(`Error reading Account from storage [${ex}] - Recreating Account`)
+            privateStorage?.remove('privateKey')
+          }
+        }
+      }
+    }
+    return await super.loadAccount()
+  }*/
+  allHandler() {
+    var _a;
+    (_a = this.logger) == null ? void 0 : _a.log(`this.storage.length: ${this.storage.length}`);
+    return Object.entries(this.storage.getAll()).map(([, value]) => value);
+  }
+  clearHandler() {
+    var _a;
+    (_a = this.logger) == null ? void 0 : _a.log(`this.storage.length: ${this.storage.length}`);
+    this.storage.clear();
+    return this.emit("cleared", {
+      module: this
+    });
+  }
+  async commitHandler() {
+    var _a, _b;
+    (_a = this.logger) == null ? void 0 : _a.log(`this.storage.length: ${this.storage.length}`);
+    const payloads = await this.all();
+    assertEx(payloads.length > 0, "Nothing to commit");
+    const settled = await Promise.allSettled(compact((_b = Object.values((await this.parents()).commit ?? [])) == null ? void 0 : _b.map(async (parent) => {
+      var _a2;
+      const queryPayload = {
+        schema: ArchivistInsertQuerySchema
+      };
+      const query = await this.bindQuery(queryPayload, payloads);
+      return (_a2 = await (parent == null ? void 0 : parent.query(query[0], query[1]))) == null ? void 0 : _a2[0];
+    })));
+    await this.clear();
+    return compact(settled.filter(fulfilled).map((result) => result.value));
+  }
+  async deleteHandler(hashes) {
+    const payloadPairs = await Promise.all((await this.get(hashes)).map(async (payload) => [
+      await PayloadHasher.hashAsync(payload),
+      payload
+    ]));
+    const deletedPairs = compact(await Promise.all(payloadPairs.map(([hash, payload]) => {
+      this.storage.remove(hash);
+      return [
+        hash,
+        payload
+      ];
+    })));
+    return deletedPairs.map(([hash]) => hash);
+  }
+  getHandler(hashes) {
+    return compact(hashes.map((hash) => {
+      return this.storage.get(hash);
+    }));
+  }
+  async insertHandler(payloads) {
+    const resultPayloads = await Promise.all(payloads.map(async (payload) => {
+      const wrapper = PayloadWrapper.wrap(payload);
+      const hash = await wrapper.hashAsync();
+      const value = JSON.stringify(wrapper.payload());
+      assertEx(value.length < this.maxEntrySize, `Payload too large [${hash}, ${value.length}]`);
+      this.storage.set(hash, wrapper.payload());
+      return wrapper.payload();
+    }));
+    return resultPayloads;
+  }
+  saveAccount() {
+    var _a;
+    if (this.persistAccount) {
+      const account = this.account;
+      (_a = this.logger) == null ? void 0 : _a.log(account.address);
+      this.privateStorage.set("privateKey", account.private.hex);
+    }
+  }
+  async startHandler() {
+    await super.startHandler();
+    this.saveAccount();
+    return true;
+  }
+};
+__name(_StorageArchivist, "StorageArchivist");
+__publicField(_StorageArchivist, "configSchemas", [
+  StorageArchivistConfigSchema
+]);
+var StorageArchivist = _StorageArchivist;
+export {
+  StorageArchivist,
+  StorageArchivistConfigSchema
+};
+//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/StorageArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { compact } from '@xylabs/lodash'\nimport { fulfilled, Promisable, PromisableArray } from '@xylabs/promise'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n  ArchivistAllQuerySchema,\n  ArchivistClearQuerySchema,\n  ArchivistCommitQuerySchema,\n  ArchivistConfig,\n  ArchivistDeleteQuerySchema,\n  ArchivistInsertQuery,\n  ArchivistInsertQuerySchema,\n  ArchivistInstance,\n  ArchivistModuleEventData,\n  ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\nimport { PayloadWrapper } from '@xyo-network/payload-wrapper'\nimport store, { StoreBase } from 'store2'\n\nexport type StorageArchivistConfigSchema = 'network.xyo.archivist.storage.config'\nexport const StorageArchivistConfigSchema: StorageArchivistConfigSchema = 'network.xyo.archivist.storage.config'\n\nexport type StorageArchivistConfig = ArchivistConfig<{\n  maxEntries?: number\n  maxEntrySize?: number\n  namespace?: string\n  persistAccount?: boolean\n  schema: StorageArchivistConfigSchema\n  type?: 'local' | 'session' | 'page'\n}>\n\nexport type StorageArchivistParams = ArchivistParams<AnyConfigSchema<StorageArchivistConfig>>\nexport class StorageArchivist<\n    TParams extends StorageArchivistParams = StorageArchivistParams,\n    TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n  >\n  extends AbstractArchivist<TParams, TEventData>\n  implements ArchivistInstance\n{\n  static override configSchemas = [StorageArchivistConfigSchema]\n\n  private _privateStorage: StoreBase | undefined\n  private _storage: StoreBase | undefined\n\n  get maxEntries() {\n    return this.config?.maxEntries ?? 1000\n  }\n\n  get maxEntrySize() {\n    return this.config?.maxEntrySize ?? 16_000\n  }\n\n  get namespace() {\n    return this.config?.namespace ?? 'xyo-archivist'\n  }\n\n  get persistAccount() {\n    return this.config?.persistAccount ?? false\n  }\n\n  override get queries(): string[] {\n    return [\n      ArchivistAllQuerySchema,\n      ArchivistDeleteQuerySchema,\n      ArchivistClearQuerySchema,\n      ArchivistInsertQuerySchema,\n      ArchivistCommitQuerySchema,\n      ...super.queries,\n    ]\n  }\n\n  get type() {\n    return this.config?.type ?? 'local'\n  }\n\n  /* This has to be a getter so that it can access it during construction */\n  private get privateStorage(): StoreBase {\n    this._privateStorage = this._storage ?? store[this.type].namespace(`${this.namespace}|private`)\n    return this._privateStorage\n  }\n\n  /* This has to be a getter so that it can access it during construction */\n  private get storage(): StoreBase {\n    this._storage = this._storage ?? store[this.type].namespace(this.namespace)\n    return this._storage\n  }\n\n  /*override async loadAccount(account?: AccountInstance, persistAccount?: boolean, privateStorage?: StoreBase, _logger?: Logger) {\n    if (!this._account) {\n      if (persistAccount) {\n        const privateKey = privateStorage?.get('privateKey')\n        if (privateKey) {\n          try {\n            this._account = await Account.create({ privateKey })\n            return this._account\n          } catch (ex) {\n            console.error(`Error reading Account from storage [${ex}] - Recreating Account`)\n            privateStorage?.remove('privateKey')\n          }\n        }\n      }\n    }\n    return await super.loadAccount()\n  }*/\n\n  protected override allHandler(): PromisableArray<Payload> {\n    this.logger?.log(`this.storage.length: ${this.storage.length}`)\n    return Object.entries(this.storage.getAll()).map(([, value]) => value)\n  }\n\n  protected override clearHandler(): void | Promise<void> {\n    this.logger?.log(`this.storage.length: ${this.storage.length}`)\n    this.storage.clear()\n    return this.emit('cleared', { module: this })\n  }\n\n  protected override async commitHandler(): Promise<BoundWitness[]> {\n    this.logger?.log(`this.storage.length: ${this.storage.length}`)\n    const payloads = await this.all()\n    assertEx(payloads.length > 0, 'Nothing to commit')\n    const settled = await Promise.allSettled(\n      compact(\n        Object.values((await this.parents()).commit ?? [])?.map(async (parent) => {\n          const queryPayload: ArchivistInsertQuery = {\n            schema: ArchivistInsertQuerySchema,\n          }\n          const query = await this.bindQuery(queryPayload, payloads)\n          return (await parent?.query(query[0], query[1]))?.[0]\n        }),\n      ),\n    )\n    // TODO - rather than clear, delete the payloads that come back as successfully inserted\n    await this.clear()\n    return compact(settled.filter(fulfilled).map((result) => result.value))\n  }\n\n  protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n    const payloadPairs: [string, Payload][] = await Promise.all(\n      (await this.get(hashes)).map<Promise<[string, Payload]>>(async (payload) => [await PayloadHasher.hashAsync(payload), payload]),\n    )\n    const deletedPairs: [string, Payload][] = compact(\n      await Promise.all(\n        payloadPairs.map<[string, Payload] | undefined>(([hash, payload]) => {\n          this.storage.remove(hash)\n          return [hash, payload]\n        }),\n      ),\n    )\n    return deletedPairs.map(([hash]) => hash)\n  }\n\n  protected override getHandler(hashes: string[]): Promisable<Payload[]> {\n    return compact(\n      hashes.map((hash) => {\n        return this.storage.get(hash)\n      }),\n    )\n  }\n\n  protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n    const resultPayloads = await Promise.all(\n      payloads.map(async (payload) => {\n        const wrapper = PayloadWrapper.wrap(payload)\n        const hash = await wrapper.hashAsync()\n        const value = JSON.stringify(wrapper.payload())\n        assertEx(value.length < this.maxEntrySize, `Payload too large [${hash}, ${value.length}]`)\n        this.storage.set(hash, wrapper.payload())\n        return wrapper.payload()\n      }),\n    )\n    return resultPayloads\n  }\n\n  protected saveAccount() {\n    if (this.persistAccount) {\n      const account = this.account\n      this.logger?.log(account.address)\n      this.privateStorage.set('privateKey', account.private.hex)\n    }\n  }\n\n  protected override async startHandler() {\n    await super.startHandler()\n    this.saveAccount()\n    return true\n  }\n}\n"],"mappings":";;;;;;;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,eAAe;AACxB,SAASC,iBAA8C;AACvD,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BACAC,4BAEAC,4BAEAC,kCAIK;AAEP,SAASC,qBAAqB;AAG9B,SAASC,sBAAsB;AAC/B,OAAOC,WAA0B;AAG1B,IAAMC,+BAA6D;AAYnE,IAAMC,oBAAN,MAAMA,0BAIHC,kBAAAA;EAKAC;EACAC;EAER,IAAIC,aAAa;AAhDnB;AAiDI,aAAO,UAAKC,WAAL,mBAAaD,eAAc;EACpC;EAEA,IAAIE,eAAe;AApDrB;AAqDI,aAAO,UAAKD,WAAL,mBAAaC,iBAAgB;EACtC;EAEA,IAAIC,YAAY;AAxDlB;AAyDI,aAAO,UAAKF,WAAL,mBAAaE,cAAa;EACnC;EAEA,IAAIC,iBAAiB;AA5DvB;AA6DI,aAAO,UAAKH,WAAL,mBAAaG,mBAAkB;EACxC;EAEA,IAAaC,UAAoB;AAC/B,WAAO;MACLC;MACAC;MACAC;MACAC;MACAC;SACG,MAAML;;EAEb;EAEA,IAAIM,OAAO;AA3Eb;AA4EI,aAAO,UAAKV,WAAL,mBAAaU,SAAQ;EAC9B;;EAGA,IAAYC,iBAA4B;AACtC,SAAKd,kBAAkB,KAAKC,YAAYc,MAAM,KAAKF,IAAI,EAAER,UAAU,GAAG,KAAKA,SAAS,UAAU;AAC9F,WAAO,KAAKL;EACd;;EAGA,IAAYgB,UAAqB;AAC/B,SAAKf,WAAW,KAAKA,YAAYc,MAAM,KAAKF,IAAI,EAAER,UAAU,KAAKA,SAAS;AAC1E,WAAO,KAAKJ;EACd;;;;;;;;;;;;;;;;;;EAoBmBgB,aAAuC;AA7G5D;AA8GI,eAAKC,WAAL,mBAAaC,IAAI,wBAAwB,KAAKH,QAAQI,MAAM;AAC5D,WAAOC,OAAOC,QAAQ,KAAKN,QAAQO,OAAM,CAAA,EAAIC,IAAI,CAAC,CAAA,EAAGC,KAAAA,MAAWA,KAAAA;EAClE;EAEmBC,eAAqC;AAlH1D;AAmHI,eAAKR,WAAL,mBAAaC,IAAI,wBAAwB,KAAKH,QAAQI,MAAM;AAC5D,SAAKJ,QAAQW,MAAK;AAClB,WAAO,KAAKC,KAAK,WAAW;MAAEC,QAAQ;IAAK,CAAA;EAC7C;EAEA,MAAyBC,gBAAyC;AAxHpE;AAyHI,eAAKZ,WAAL,mBAAaC,IAAI,wBAAwB,KAAKH,QAAQI,MAAM;AAC5D,UAAMW,WAAW,MAAM,KAAKC,IAAG;AAC/BC,aAASF,SAASX,SAAS,GAAG,mBAAA;AAC9B,UAAMc,UAAU,MAAMC,QAAQC,WAC5BC,SACEhB,YAAOiB,QAAQ,MAAM,KAAKC,QAAO,GAAIC,UAAU,CAAA,CAAE,MAAjDnB,mBAAoDG,IAAI,OAAOiB,WAAAA;AA9HvE,UAAAC;AA+HU,YAAMC,eAAqC;QACzCC,QAAQjC;MACV;AACA,YAAMkC,QAAQ,MAAM,KAAKC,UAAUH,cAAcZ,QAAAA;AACjD,cAAQW,MAAA,OAAMD,iCAAQI,MAAMA,MAAM,CAAA,GAAIA,MAAM,CAAA,QAApC,gBAAAH,IAA2C;IACrD,EAAA,CAAA;AAIJ,UAAM,KAAKf,MAAK;AAChB,WAAOU,QAAQH,QAAQa,OAAOC,SAAAA,EAAWxB,IAAI,CAACyB,WAAWA,OAAOxB,KAAK,CAAA;EACvE;EAEA,MAAyByB,cAAcC,QAAqC;AAC1E,UAAMC,eAAoC,MAAMjB,QAAQH,KACrD,MAAM,KAAKqB,IAAIF,MAAAA,GAAS3B,IAAgC,OAAO8B,YAAY;MAAC,MAAMC,cAAcC,UAAUF,OAAAA;MAAUA;KAAQ,CAAA;AAE/H,UAAMG,eAAoCpB,QACxC,MAAMF,QAAQH,IACZoB,aAAa5B,IAAmC,CAAC,CAACkC,MAAMJ,OAAAA,MAAQ;AAC9D,WAAKtC,QAAQ2C,OAAOD,IAAAA;AACpB,aAAO;QAACA;QAAMJ;;IAChB,CAAA,CAAA,CAAA;AAGJ,WAAOG,aAAajC,IAAI,CAAC,CAACkC,IAAAA,MAAUA,IAAAA;EACtC;EAEmBE,WAAWT,QAAyC;AACrE,WAAOd,QACLc,OAAO3B,IAAI,CAACkC,SAAAA;AACV,aAAO,KAAK1C,QAAQqC,IAAIK,IAAAA;IAC1B,CAAA,CAAA;EAEJ;EAEA,MAAyBG,cAAc9B,UAAyC;AAC9E,UAAM+B,iBAAiB,MAAM3B,QAAQH,IACnCD,SAASP,IAAI,OAAO8B,YAAAA;AAClB,YAAMS,UAAUC,eAAeC,KAAKX,OAAAA;AACpC,YAAMI,OAAO,MAAMK,QAAQP,UAAS;AACpC,YAAM/B,QAAQyC,KAAKC,UAAUJ,QAAQT,QAAO,CAAA;AAC5CrB,eAASR,MAAML,SAAS,KAAKhB,cAAc,sBAAsBsD,IAAAA,KAASjC,MAAML,MAAM,GAAG;AACzF,WAAKJ,QAAQoD,IAAIV,MAAMK,QAAQT,QAAO,CAAA;AACtC,aAAOS,QAAQT,QAAO;IACxB,CAAA,CAAA;AAEF,WAAOQ;EACT;EAEUO,cAAc;AAjL1B;AAkLI,QAAI,KAAK/D,gBAAgB;AACvB,YAAMgE,UAAU,KAAKA;AACrB,iBAAKpD,WAAL,mBAAaC,IAAImD,QAAQC;AACzB,WAAKzD,eAAesD,IAAI,cAAcE,QAAQE,QAAQC,GAAG;IAC3D;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AACZ,SAAKL,YAAW;AAChB,WAAO;EACT;AACF;AAtJUtE;AAGR,cAPWD,mBAOK6E,iBAAgB;EAAC9E;;AAP5B,IAAMC,mBAAN;","names":["assertEx","compact","fulfilled","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistCommitQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","PayloadHasher","PayloadWrapper","store","StorageArchivistConfigSchema","StorageArchivist","AbstractArchivist","_privateStorage","_storage","maxEntries","config","maxEntrySize","namespace","persistAccount","queries","ArchivistAllQuerySchema","ArchivistDeleteQuerySchema","ArchivistClearQuerySchema","ArchivistInsertQuerySchema","ArchivistCommitQuerySchema","type","privateStorage","store","storage","allHandler","logger","log","length","Object","entries","getAll","map","value","clearHandler","clear","emit","module","commitHandler","payloads","all","assertEx","settled","Promise","allSettled","compact","values","parents","commit","parent","_a","queryPayload","schema","query","bindQuery","filter","fulfilled","result","deleteHandler","hashes","payloadPairs","get","payload","PayloadHasher","hashAsync","deletedPairs","hash","remove","getHandler","insertHandler","resultPayloads","wrapper","PayloadWrapper","wrap","JSON","stringify","set","saveAccount","account","address","private","hex","startHandler","configSchemas"]}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@xyo-network/archivist-storage",
+  "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": {
+    "@xylabs/assert": "^2.13.23",
+    "@xylabs/delay": "^2.13.23",
+    "@xylabs/lodash": "^2.13.23",
+    "@xylabs/promise": "^2.13.23",
+    "@xyo-network/archivist-abstract": "~2.85.6",
+    "@xyo-network/archivist-model": "~2.85.6",
+    "@xyo-network/boundwitness-model": "~2.85.6",
+    "@xyo-network/hash": "~2.85.6",
+    "@xyo-network/id-payload-plugin": "~2.85.6",
+    "@xyo-network/module-model": "~2.85.6",
+    "@xyo-network/payload-model": "~2.85.6",
+    "@xyo-network/payload-wrapper": "~2.85.6",
+    "store2": "^2.14.2"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.2.25",
+    "@xylabs/tsconfig": "^3.2.25",
+    "@xyo-network/account": "~2.85.6",
+    "@xyo-network/archivist-memory": "~2.85.6",
+    "@xyo-network/boundwitness-builder": "~2.85.6",
+    "@xyo-network/node-memory": "~2.85.6",
+    "typescript": "^5.3.3"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "types": "dist/node/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.cts",
+          "default": "./dist/node/index.cjs"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.js"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.85.6",
+  "type": "module"
+}

package/src/StorageArchivist.ts

@@ -0,0 +1,191 @@
+import { assertEx } from '@xylabs/assert'
+import { compact } from '@xylabs/lodash'
+import { fulfilled, Promisable, PromisableArray } from '@xylabs/promise'
+import { AbstractArchivist } from '@xyo-network/archivist-abstract'
+import {
+  ArchivistAllQuerySchema,
+  ArchivistClearQuerySchema,
+  ArchivistCommitQuerySchema,
+  ArchivistConfig,
+  ArchivistDeleteQuerySchema,
+  ArchivistInsertQuery,
+  ArchivistInsertQuerySchema,
+  ArchivistInstance,
+  ArchivistModuleEventData,
+  ArchivistParams,
+} from '@xyo-network/archivist-model'
+import { BoundWitness } from '@xyo-network/boundwitness-model'
+import { PayloadHasher } from '@xyo-network/hash'
+import { AnyConfigSchema } from '@xyo-network/module-model'
+import { Payload } from '@xyo-network/payload-model'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import store, { StoreBase } from 'store2'
+
+export type StorageArchivistConfigSchema = 'network.xyo.archivist.storage.config'
+export const StorageArchivistConfigSchema: StorageArchivistConfigSchema = 'network.xyo.archivist.storage.config'
+
+export type StorageArchivistConfig = ArchivistConfig<{
+  maxEntries?: number
+  maxEntrySize?: number
+  namespace?: string
+  persistAccount?: boolean
+  schema: StorageArchivistConfigSchema
+  type?: 'local' | 'session' | 'page'
+}>
+
+export type StorageArchivistParams = ArchivistParams<AnyConfigSchema<StorageArchivistConfig>>
+export class StorageArchivist<
+    TParams extends StorageArchivistParams = StorageArchivistParams,
+    TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,
+  >
+  extends AbstractArchivist<TParams, TEventData>
+  implements ArchivistInstance
+{
+  static override configSchemas = [StorageArchivistConfigSchema]
+
+  private _privateStorage: StoreBase | undefined
+  private _storage: StoreBase | undefined
+
+  get maxEntries() {
+    return this.config?.maxEntries ?? 1000
+  }
+
+  get maxEntrySize() {
+    return this.config?.maxEntrySize ?? 16_000
+  }
+
+  get namespace() {
+    return this.config?.namespace ?? 'xyo-archivist'
+  }
+
+  get persistAccount() {
+    return this.config?.persistAccount ?? false
+  }
+
+  override get queries(): string[] {
+    return [
+      ArchivistAllQuerySchema,
+      ArchivistDeleteQuerySchema,
+      ArchivistClearQuerySchema,
+      ArchivistInsertQuerySchema,
+      ArchivistCommitQuerySchema,
+      ...super.queries,
+    ]
+  }
+
+  get type() {
+    return this.config?.type ?? 'local'
+  }
+
+  /* This has to be a getter so that it can access it during construction */
+  private get privateStorage(): StoreBase {
+    this._privateStorage = this._storage ?? store[this.type].namespace(`${this.namespace}|private`)
+    return this._privateStorage
+  }
+
+  /* This has to be a getter so that it can access it during construction */
+  private get storage(): StoreBase {
+    this._storage = this._storage ?? store[this.type].namespace(this.namespace)
+    return this._storage
+  }
+
+  /*override async loadAccount(account?: AccountInstance, persistAccount?: boolean, privateStorage?: StoreBase, _logger?: Logger) {
+    if (!this._account) {
+      if (persistAccount) {
+        const privateKey = privateStorage?.get('privateKey')
+        if (privateKey) {
+          try {
+            this._account = await Account.create({ privateKey })
+            return this._account
+          } catch (ex) {
+            console.error(`Error reading Account from storage [${ex}] - Recreating Account`)
+            privateStorage?.remove('privateKey')
+          }
+        }
+      }
+    }
+    return await super.loadAccount()
+  }*/
+
+  protected override allHandler(): PromisableArray<Payload> {
+    this.logger?.log(`this.storage.length: ${this.storage.length}`)
+    return Object.entries(this.storage.getAll()).map(([, value]) => value)
+  }
+
+  protected override clearHandler(): void | Promise<void> {
+    this.logger?.log(`this.storage.length: ${this.storage.length}`)
+    this.storage.clear()
+    return this.emit('cleared', { module: this })
+  }
+
+  protected override async commitHandler(): Promise<BoundWitness[]> {
+    this.logger?.log(`this.storage.length: ${this.storage.length}`)
+    const payloads = await this.all()
+    assertEx(payloads.length > 0, 'Nothing to commit')
+    const settled = await Promise.allSettled(
+      compact(
+        Object.values((await this.parents()).commit ?? [])?.map(async (parent) => {
+          const queryPayload: ArchivistInsertQuery = {
+            schema: ArchivistInsertQuerySchema,
+          }
+          const query = await this.bindQuery(queryPayload, payloads)
+          return (await parent?.query(query[0], query[1]))?.[0]
+        }),
+      ),
+    )
+    // TODO - rather than clear, delete the payloads that come back as successfully inserted
+    await this.clear()
+    return compact(settled.filter(fulfilled).map((result) => result.value))
+  }
+
+  protected override async deleteHandler(hashes: string[]): Promise<string[]> {
+    const payloadPairs: [string, Payload][] = await Promise.all(
+      (await this.get(hashes)).map<Promise<[string, Payload]>>(async (payload) => [await PayloadHasher.hashAsync(payload), payload]),
+    )
+    const deletedPairs: [string, Payload][] = compact(
+      await Promise.all(
+        payloadPairs.map<[string, Payload] | undefined>(([hash, payload]) => {
+          this.storage.remove(hash)
+          return [hash, payload]
+        }),
+      ),
+    )
+    return deletedPairs.map(([hash]) => hash)
+  }
+
+  protected override getHandler(hashes: string[]): Promisable<Payload[]> {
+    return compact(
+      hashes.map((hash) => {
+        return this.storage.get(hash)
+      }),
+    )
+  }
+
+  protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {
+    const resultPayloads = await Promise.all(
+      payloads.map(async (payload) => {
+        const wrapper = PayloadWrapper.wrap(payload)
+        const hash = await wrapper.hashAsync()
+        const value = JSON.stringify(wrapper.payload())
+        assertEx(value.length < this.maxEntrySize, `Payload too large [${hash}, ${value.length}]`)
+        this.storage.set(hash, wrapper.payload())
+        return wrapper.payload()
+      }),
+    )
+    return resultPayloads
+  }
+
+  protected saveAccount() {
+    if (this.persistAccount) {
+      const account = this.account
+      this.logger?.log(account.address)
+      this.privateStorage.set('privateKey', account.private.hex)
+    }
+  }
+
+  protected override async startHandler() {
+    await super.startHandler()
+    this.saveAccount()
+    return true
+  }
+}

package/src/index.ts

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

package/src/spec/testArchivist.ts

@@ -0,0 +1,50 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { delay } from '@xylabs/delay'
+import { Promisable } from '@xylabs/promise'
+import { ArchivistInstance } from '@xyo-network/archivist-model'
+import { IdSchema } from '@xyo-network/id-payload-plugin'
+import { Payload } from '@xyo-network/payload-model'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+
+export const testArchivistRoundTrip = (archivistPromise: Promisable<ArchivistInstance>, name: string) => {
+  test(`Archivist RoundTrip [${name}]`, async () => {
+    const idPayload: Payload<{ salt: string }> = {
+      salt: Date.now().toString(),
+      schema: IdSchema,
+    }
+    const payloadWrapper = PayloadWrapper.wrap(idPayload)
+
+    const archivist = await archivistPromise
+    const insertResult = await archivist.insert([idPayload])
+    expect(insertResult).toBeDefined()
+
+    const getResult = await archivist.get([await payloadWrapper.hashAsync()])
+    expect(getResult).toBeDefined()
+    expect(getResult.length).toBe(1)
+    const gottenPayload = getResult[0]
+    if (gottenPayload) {
+      const gottenPayloadWrapper = PayloadWrapper.wrap(gottenPayload)
+      expect(await gottenPayloadWrapper.hashAsync()).toBe(await payloadWrapper.hashAsync())
+    }
+  })
+}
+
+export const testArchivistAll = (archivist: Promisable<ArchivistInstance>, name: string) => {
+  test(`Archivist All [${name}]`, async () => {
+    const idPayload = {
+      salt: Date.now().toString(),
+      schema: IdSchema,
+    }
+    const archivistModule = await archivist
+    for (let x = 0; x < 10; x++) {
+      await archivistModule.insert([idPayload])
+      await delay(10)
+    }
+    const getResult = await archivistModule.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"
+}