@xyo-network/archivist-storage 6.0.3 → 6.1.0

package/README.md

@@ -38,10 +38,12 @@ bun add {{name}}
 
 See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
+## Credits
 
+[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
 [npm-badge]: https://img.shields.io/npm/v/@xyo-network/archivist-storage.svg
 [npm-link]: https://www.npmjs.com/package/@xyo-network/archivist-storage
 [license-badge]: https://img.shields.io/npm/l/@xyo-network/archivist-storage.svg
 [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/neutral/StorageArchivist.d.ts

@@ -3,7 +3,7 @@ import { AbstractArchivist } from '@xyo-network/archivist-abstract';
 import type { ArchivistConfig, ArchivistInstance, ArchivistModuleEventData, ArchivistNextOptions, ArchivistParams } from '@xyo-network/archivist-model';
 import type { AnyConfigSchema } from '@xyo-network/module-model';
 import type { BoundWitness, Payload, Schema, WithStorageMeta } from '@xyo-network/sdk-protocol-js';
-export declare const StorageArchivistConfigSchema: "network.xyo.archivist.storage.config" & {
+export declare const StorageArchivistConfigSchema: 'network.xyo.archivist.storage.config' & {
     readonly __schema: true;
 };
 export type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema;
@@ -18,7 +18,7 @@ export declare class StorageArchivist<TParams extends StorageArchivistParams = S
     static readonly configSchemas: Schema[];
     static readonly defaultConfigSchema: Schema;
     static readonly labels: {
-        "network.xyo.storage.class": string;
+        'network.xyo.storage.class': string;
     };
     private _privateStorage;
     private _storage;
@@ -26,7 +26,7 @@ export declare class StorageArchivist<TParams extends StorageArchivistParams = S
     get maxEntrySize(): number;
     get namespace(): string;
     get queries(): Schema[];
-    get type(): "local" | "session" | "page";
+    get type(): 'local' | 'session' | 'page';
     private get privateStorage();
     private get storage();
     protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;

package/dist/neutral/StorageArchivist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageArchivist.d.ts","sourceRoot":"","sources":["../../src/StorageArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,eAAe,EACvC,MAAM,gBAAgB,CAAA;AAIvB,OAAO,EAAE,iBAAiB,EAAqB,MAAM,iCAAiC,CAAA;AACtF,OAAO,KAAK,EACV,eAAe,EAEf,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AASrC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EACV,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAC/C,MAAM,8BAA8B,CAAA;AAOrC,eAAO,MAAM,4BAA4B;;CAAyD,CAAA;AAClG,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAA;AAE9E,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAAC;IACnD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;CACpC,EAAE,4BAA4B,CAAC,CAAA;AAEhC,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC,CAAA;AAC7F,qBAAa,gBAAgB,CAC3B,OAAO,SAAS,sBAAsB,GAAG,sBAAsB,EAC/D,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CAEtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAC7C,YAAW,iBAAiB;IAC5B,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAyD;IACzG,gBAAyB,mBAAmB,EAAE,MAAM,CAA+B;IACnF,gBAAyB,MAAM;;MAAmD;IAElF,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,QAAQ,CAAuB;IAEvC,IAAI,UAAU,WAEb;IAED,IAAI,YAAY,WAEf;IAED,IAAI,SAAS,WAEZ;IAED,IAAa,OAAO,IAAI,MAAM,EAAE,CAU/B;IAED,IAAI,IAAI,iCAEP;IAGD,OAAO,KAAK,cAAc,GAGzB;IAGD,OAAO,KAAK,OAAO,GAGlB;cAEkB,UAAU,IAAI,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;cAkBvD,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAM9B,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;cAgB9C,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,EAAE;IAU5E,SAAS,CAAC,aAAa,CACrB,KAAK,GAAE,KAAK,GAAG,MAAc,EAC7B,KAAK,SAAK,EACV,MAAM,CAAC,EAAE,GAAG,EACZ,IAAI,CAAC,EAAE,OAAO,GACb,eAAe,EAAE;cAeD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAMpE,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,EAAE;cAW/E,WAAW,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAO7E,YAAY;CAGtC"}
+{"version":3,"file":"StorageArchivist.d.ts","sourceRoot":"","sources":["../../src/StorageArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,eAAe,EACvC,MAAM,gBAAgB,CAAA;AAIvB,OAAO,EAAE,iBAAiB,EAAqB,MAAM,iCAAiC,CAAA;AACtF,OAAO,KAAK,EACV,eAAe,EAEf,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AASrC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EACV,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAC/C,MAAM,8BAA8B,CAAA;AAOrC,eAAO,MAAM,4BAA4B,EAAE,sCAAsC,GAAG;IAClF,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;CACiC,CAAA;AAC1D,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAA;AAE9E,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAAC;IACnD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;CACpC,EAAE,4BAA4B,CAAC,CAAA;AAEhC,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC,CAAA;AAC7F,qBAAa,gBAAgB,CAC3B,OAAO,SAAS,sBAAsB,GAAG,sBAAsB,EAC/D,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CAEtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAC7C,YAAW,iBAAiB;IAC5B,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAyD;IACzG,gBAAyB,mBAAmB,EAAE,MAAM,CAA+B;IACnF,gBAAyB,MAAM,EAAE;QAC/B,2BAA2B,EAAE,MAAM,CAAA;KACpC,CAAmD;IAEpD,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,QAAQ,CAAuB;IAEvC,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,IAAa,OAAO,IAAI,MAAM,EAAE,CAU/B;IAED,IAAI,IAAI,IAAI,OAAO,GAAG,SAAS,GAAG,MAAM,CAEvC;IAGD,OAAO,KAAK,cAAc,GAGzB;IAGD,OAAO,KAAK,OAAO,GAGlB;cAEkB,UAAU,IAAI,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;cAkBvD,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAM9B,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;cAgB9C,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,EAAE;IAU5E,SAAS,CAAC,aAAa,CACrB,KAAK,GAAE,KAAK,GAAG,MAAc,EAC7B,KAAK,SAAK,EACV,MAAM,CAAC,EAAE,GAAG,EACZ,IAAI,CAAC,EAAE,OAAO,GACb,eAAe,EAAE;cAeD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAMpE,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,EAAE;cAW/E,WAAW,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAO7E,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAGvD"}

package/dist/neutral/index.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/StorageArchivist.ts"],
-  "sourcesContent": ["import type {\n  Hash, Hex, Promisable, PromisableArray,\n} from '@xylabs/sdk-js'\nimport {\n  assertEx, exists, fulfilled,\n} from '@xylabs/sdk-js'\nimport { AbstractArchivist, StorageClassLabel } from '@xyo-network/archivist-abstract'\nimport type {\n  ArchivistConfig,\n  ArchivistInsertQuery,\n  ArchivistInstance,\n  ArchivistModuleEventData,\n  ArchivistNextOptions,\n  ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport {\n  ArchivistAllQuerySchema,\n  ArchivistClearQuerySchema,\n  ArchivistCommitQuerySchema,\n  ArchivistDeleteQuerySchema,\n  ArchivistInsertQuerySchema,\n  ArchivistNextQuerySchema,\n} from '@xyo-network/archivist-model'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport type {\n  BoundWitness, Payload, Schema, WithStorageMeta,\n} from '@xyo-network/sdk-protocol-js'\nimport { asSchema, PayloadBuilder } from '@xyo-network/sdk-protocol-js'\nimport type { StoreBase, StoreType } from 'store2'\nimport store from 'store2'\n\nconst storeTypes = store as unknown as StoreType\n\nexport const StorageArchivistConfigSchema = asSchema('network.xyo.archivist.storage.config', true)\nexport type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema\n\nexport type StorageArchivistConfig = ArchivistConfig<{\n  maxEntries?: number\n  maxEntrySize?: number\n  namespace?: string\n  type?: 'local' | 'session' | 'page'\n}, StorageArchivistConfigSchema>\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  static override readonly configSchemas: Schema[] = [...super.configSchemas, StorageArchivistConfigSchema]\n  static override readonly defaultConfigSchema: Schema = StorageArchivistConfigSchema\n  static override readonly labels = { ...super.labels, [StorageClassLabel]: 'disk' }\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  override get queries(): Schema[] {\n    return [\n      ArchivistAllQuerySchema,\n      ArchivistDeleteQuerySchema,\n      ArchivistClearQuerySchema,\n      ArchivistInsertQuerySchema,\n      ArchivistCommitQuerySchema,\n      ArchivistNextQuerySchema,\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 ?? storeTypes[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 ?? storeTypes[this.type].namespace(this.namespace)\n    return this._storage\n  }\n\n  protected override allHandler(): PromisableArray<WithStorageMeta<Payload>> {\n    const found = new Set<string>()\n    this.logger?.log(`this.storage.length: ${this.storage.length}`)\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const entries: [string, WithStorageMeta<Payload>][] = Object.entries(this.storage.getAll())\n    return entries\n      .map(([, value]) => value)\n      .filter((payload) => {\n        if (found.has(payload._dataHash)) {\n          return false\n        } else {\n          found.add(payload._dataHash)\n          return true\n        }\n      })\n      .toSorted(PayloadBuilder.compareStorageMeta)\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', { mod: 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.next({ limit: Number.MAX_SAFE_INTEGER })\n    assertEx(payloads.length > 0, () => 'Nothing to commit')\n    const settled = (await Promise.allSettled(\n      Object.values((await this.parentArchivists()).commit ?? [])?.map(async (parent) => {\n        const queryPayload: ArchivistInsertQuery = { schema: ArchivistInsertQuerySchema }\n        const query = await this.bindQuery(queryPayload, payloads)\n        return (await parent?.query(query[0], query[1]))?.[0]\n      }),\n    )).filter(exists)\n    // TODO - rather than clear, delete the payloads that come back as successfully inserted\n    await this.clear()\n    return (settled.filter(fulfilled).map(result => result.value)).filter(exists)\n  }\n\n  protected override deleteHandler(hashes: Hash[]): WithStorageMeta<Payload>[] {\n    return hashes.map((hash) => {\n      const payload = this.storage.get(hash) as WithStorageMeta<Payload> | undefined\n      if (payload) {\n        this.storage.remove(hash)\n      }\n      return payload\n    }).filter(exists)\n  }\n\n  protected getFromCursor(\n    order: 'asc' | 'desc' = 'asc',\n    limit = 10,\n    cursor?: Hex,\n    open?: boolean,\n  ): WithStorageMeta[] {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const all: WithStorageMeta[] = Object.values(this.storage.getAll())\n    const payloads: WithStorageMeta[] = all\n      .map(value => value)\n      .toSorted((item1, item2) => {\n        return order === 'asc' ? PayloadBuilder.compareStorageMeta(item1, item2) : PayloadBuilder.compareStorageMeta(item2, item1)\n      })\n    const index = payloads.findIndex(payload => payload._sequence === cursor)\n    if (index !== -1) {\n      return payloads.slice(index + (open ? 1 : 0), index + (open ? 1 : 0) + limit)\n    }\n    return payloads.slice(0, limit)\n  }\n\n  protected override getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]> {\n    return hashes\n      .map(hash => this.storage.get(hash) as WithStorageMeta<Payload> | undefined)\n      .filter(exists)\n  }\n\n  protected override insertHandler(payloads: WithStorageMeta<Payload>[]): WithStorageMeta<Payload>[] {\n    return payloads.map((payload) => {\n      const value = JSON.stringify(payload)\n      // console.log('insert.storagePayloads:', storagePayload)\n      assertEx(value.length < this.maxEntrySize, () => `Payload too large [${payload._hash}, ${value.length}]`)\n      this.storage.set(payload._hash, payload)\n      this.storage.set(payload._dataHash, payload)\n      return payload\n    })\n  }\n\n  protected override nextHandler(options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]> {\n    const {\n      limit, cursor, order, open = true,\n    } = options ?? {}\n    return this.getFromCursor(order, limit ?? 10, cursor, open)\n  }\n\n  protected override async startHandler() {\n    await super.startHandler()\n  }\n}\n"],
-  "mappings": ";AAGA;AAAA,EACE;AAAA,EAAU;AAAA,EAAQ;AAAA,OACb;AACP,SAAS,mBAAmB,yBAAyB;AASrD;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAKP,SAAS,UAAU,sBAAsB;AAEzC,OAAO,WAAW;AAElB,IAAM,aAAa;AAEZ,IAAM,+BAA+B,SAAS,wCAAwC,IAAI;AAW1F,IAAM,mBAAN,cAIG,kBACqB;AAAA,EAC7B,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,4BAA4B;AAAA,EACxG,OAAyB,sBAA8B;AAAA,EACvD,OAAyB,SAAS,EAAE,GAAG,MAAM,QAAQ,CAAC,iBAAiB,GAAG,OAAO;AAAA,EAEzE;AAAA,EACA;AAAA,EAER,IAAI,aAAa;AACf,WAAO,KAAK,QAAQ,cAAc;AAAA,EACpC;AAAA,EAEA,IAAI,eAAe;AACjB,WAAO,KAAK,QAAQ,gBAAgB;AAAA,EACtC;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK,QAAQ,aAAa;AAAA,EACnC;AAAA,EAEA,IAAa,UAAoB;AAC/B,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,GAAG,MAAM;AAAA,IACX;AAAA,EACF;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,KAAK,QAAQ,QAAQ;AAAA,EAC9B;AAAA;AAAA,EAGA,IAAY,iBAA4B;AACtC,SAAK,kBAAkB,KAAK,YAAY,WAAW,KAAK,IAAI,EAAE,UAAU,GAAG,KAAK,SAAS,UAAU;AACnG,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,IAAY,UAAqB;AAC/B,SAAK,WAAW,KAAK,YAAY,WAAW,KAAK,IAAI,EAAE,UAAU,KAAK,SAAS;AAC/E,WAAO,KAAK;AAAA,EACd;AAAA,EAEmB,aAAwD;AACzE,UAAM,QAAQ,oBAAI,IAAY;AAC9B,SAAK,QAAQ,IAAI,wBAAwB,KAAK,QAAQ,MAAM,EAAE;AAE9D,UAAM,UAAgD,OAAO,QAAQ,KAAK,QAAQ,OAAO,CAAC;AAC1F,WAAO,QACJ,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM,KAAK,EACxB,OAAO,CAAC,YAAY;AACnB,UAAI,MAAM,IAAI,QAAQ,SAAS,GAAG;AAChC,eAAO;AAAA,MACT,OAAO;AACL,cAAM,IAAI,QAAQ,SAAS;AAC3B,eAAO;AAAA,MACT;AAAA,IACF,CAAC,EACA,SAAS,eAAe,kBAAkB;AAAA,EAC/C;AAAA,EAEmB,eAAqC;AACtD,SAAK,QAAQ,IAAI,wBAAwB,KAAK,QAAQ,MAAM,EAAE;AAC9D,SAAK,QAAQ,MAAM;AACnB,WAAO,KAAK,KAAK,WAAW,EAAE,KAAK,KAAK,CAAC;AAAA,EAC3C;AAAA,EAEA,MAAyB,gBAAyC;AAChE,SAAK,QAAQ,IAAI,wBAAwB,KAAK,QAAQ,MAAM,EAAE;AAC9D,UAAM,WAAW,MAAM,KAAK,KAAK,EAAE,OAAO,OAAO,iBAAiB,CAAC;AACnE,aAAS,SAAS,SAAS,GAAG,MAAM,mBAAmB;AACvD,UAAM,WAAW,MAAM,QAAQ;AAAA,MAC7B,OAAO,QAAQ,MAAM,KAAK,iBAAiB,GAAG,UAAU,CAAC,CAAC,GAAG,IAAI,OAAO,WAAW;AACjF,cAAM,eAAqC,EAAE,QAAQ,2BAA2B;AAChF,cAAM,QAAQ,MAAM,KAAK,UAAU,cAAc,QAAQ;AACzD,gBAAQ,MAAM,QAAQ,MAAM,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAAC;AAAA,MACtD,CAAC;AAAA,IACH,GAAG,OAAO,MAAM;AAEhB,UAAM,KAAK,MAAM;AACjB,WAAQ,QAAQ,OAAO,SAAS,EAAE,IAAI,YAAU,OAAO,KAAK,EAAG,OAAO,MAAM;AAAA,EAC9E;AAAA,EAEmB,cAAc,QAA4C;AAC3E,WAAO,OAAO,IAAI,CAAC,SAAS;AAC1B,YAAM,UAAU,KAAK,QAAQ,IAAI,IAAI;AACrC,UAAI,SAAS;AACX,aAAK,QAAQ,OAAO,IAAI;AAAA,MAC1B;AACA,aAAO;AAAA,IACT,CAAC,EAAE,OAAO,MAAM;AAAA,EAClB;AAAA,EAEU,cACR,QAAwB,OACxB,QAAQ,IACR,QACA,MACmB;AAEnB,UAAM,MAAyB,OAAO,OAAO,KAAK,QAAQ,OAAO,CAAC;AAClE,UAAM,WAA8B,IACjC,IAAI,WAAS,KAAK,EAClB,SAAS,CAAC,OAAO,UAAU;AAC1B,aAAO,UAAU,QAAQ,eAAe,mBAAmB,OAAO,KAAK,IAAI,eAAe,mBAAmB,OAAO,KAAK;AAAA,IAC3H,CAAC;AACH,UAAM,QAAQ,SAAS,UAAU,aAAW,QAAQ,cAAc,MAAM;AACxE,QAAI,UAAU,IAAI;AAChB,aAAO,SAAS,MAAM,SAAS,OAAO,IAAI,IAAI,SAAS,OAAO,IAAI,KAAK,KAAK;AAAA,IAC9E;AACA,WAAO,SAAS,MAAM,GAAG,KAAK;AAAA,EAChC;AAAA,EAEmB,WAAW,QAA0D;AACtF,WAAO,OACJ,IAAI,UAAQ,KAAK,QAAQ,IAAI,IAAI,CAAyC,EAC1E,OAAO,MAAM;AAAA,EAClB;AAAA,EAEmB,cAAc,UAAkE;AACjG,WAAO,SAAS,IAAI,CAAC,YAAY;AAC/B,YAAM,QAAQ,KAAK,UAAU,OAAO;AAEpC,eAAS,MAAM,SAAS,KAAK,cAAc,MAAM,sBAAsB,QAAQ,KAAK,KAAK,MAAM,MAAM,GAAG;AACxG,WAAK,QAAQ,IAAI,QAAQ,OAAO,OAAO;AACvC,WAAK,QAAQ,IAAI,QAAQ,WAAW,OAAO;AAC3C,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEmB,YAAY,SAAwE;AACrG,UAAM;AAAA,MACJ;AAAA,MAAO;AAAA,MAAQ;AAAA,MAAO,OAAO;AAAA,IAC/B,IAAI,WAAW,CAAC;AAChB,WAAO,KAAK,cAAc,OAAO,SAAS,IAAI,QAAQ,IAAI;AAAA,EAC5D;AAAA,EAEA,MAAyB,eAAe;AACtC,UAAM,MAAM,aAAa;AAAA,EAC3B;AACF;",
+  "sourcesContent": ["import type {\n  Hash, Hex, Promisable, PromisableArray,\n} from '@xylabs/sdk-js'\nimport {\n  assertEx, exists, fulfilled,\n} from '@xylabs/sdk-js'\nimport { AbstractArchivist, StorageClassLabel } from '@xyo-network/archivist-abstract'\nimport type {\n  ArchivistConfig,\n  ArchivistInsertQuery,\n  ArchivistInstance,\n  ArchivistModuleEventData,\n  ArchivistNextOptions,\n  ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport {\n  ArchivistAllQuerySchema,\n  ArchivistClearQuerySchema,\n  ArchivistCommitQuerySchema,\n  ArchivistDeleteQuerySchema,\n  ArchivistInsertQuerySchema,\n  ArchivistNextQuerySchema,\n} from '@xyo-network/archivist-model'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport type {\n  BoundWitness, Payload, Schema, WithStorageMeta,\n} from '@xyo-network/sdk-protocol-js'\nimport { asSchema, PayloadBuilder } from '@xyo-network/sdk-protocol-js'\nimport type { StoreBase, StoreType } from 'store2'\nimport store from 'store2'\n\nconst storeTypes = store as unknown as StoreType\n\nexport const StorageArchivistConfigSchema: 'network.xyo.archivist.storage.config' & {\n  readonly __schema: true\n} = asSchema('network.xyo.archivist.storage.config', true)\nexport type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema\n\nexport type StorageArchivistConfig = ArchivistConfig<{\n  maxEntries?: number\n  maxEntrySize?: number\n  namespace?: string\n  type?: 'local' | 'session' | 'page'\n}, StorageArchivistConfigSchema>\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  static override readonly configSchemas: Schema[] = [...super.configSchemas, StorageArchivistConfigSchema]\n  static override readonly defaultConfigSchema: Schema = StorageArchivistConfigSchema\n  static override readonly labels: {\n    'network.xyo.storage.class': string\n  } = { ...super.labels, [StorageClassLabel]: 'disk' }\n\n  private _privateStorage: StoreBase | undefined\n  private _storage: StoreBase | undefined\n\n  get maxEntries(): number {\n    return this.config?.maxEntries ?? 1000\n  }\n\n  get maxEntrySize(): number {\n    return this.config?.maxEntrySize ?? 16_000\n  }\n\n  get namespace(): string {\n    return this.config?.namespace ?? 'xyo-archivist'\n  }\n\n  override get queries(): Schema[] {\n    return [\n      ArchivistAllQuerySchema,\n      ArchivistDeleteQuerySchema,\n      ArchivistClearQuerySchema,\n      ArchivistInsertQuerySchema,\n      ArchivistCommitQuerySchema,\n      ArchivistNextQuerySchema,\n      ...super.queries,\n    ]\n  }\n\n  get type(): 'local' | 'session' | 'page' {\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 ?? storeTypes[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 ?? storeTypes[this.type].namespace(this.namespace)\n    return this._storage\n  }\n\n  protected override allHandler(): PromisableArray<WithStorageMeta<Payload>> {\n    const found = new Set<string>()\n    this.logger?.log(`this.storage.length: ${this.storage.length}`)\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const entries: [string, WithStorageMeta<Payload>][] = Object.entries(this.storage.getAll())\n    return entries\n      .map(([, value]) => value)\n      .filter((payload) => {\n        if (found.has(payload._dataHash)) {\n          return false\n        } else {\n          found.add(payload._dataHash)\n          return true\n        }\n      })\n      .toSorted(PayloadBuilder.compareStorageMeta)\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', { mod: 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.next({ limit: Number.MAX_SAFE_INTEGER })\n    assertEx(payloads.length > 0, () => 'Nothing to commit')\n    const settled = (await Promise.allSettled(\n      Object.values((await this.parentArchivists()).commit ?? [])?.map(async (parent) => {\n        const queryPayload: ArchivistInsertQuery = { schema: ArchivistInsertQuerySchema }\n        const query = await this.bindQuery(queryPayload, payloads)\n        return (await parent?.query(query[0], query[1]))?.[0]\n      }),\n    )).filter(exists)\n    // TODO - rather than clear, delete the payloads that come back as successfully inserted\n    await this.clear()\n    return (settled.filter(fulfilled).map(result => result.value)).filter(exists)\n  }\n\n  protected override deleteHandler(hashes: Hash[]): WithStorageMeta<Payload>[] {\n    return hashes.map((hash) => {\n      const payload = this.storage.get(hash) as WithStorageMeta<Payload> | undefined\n      if (payload) {\n        this.storage.remove(hash)\n      }\n      return payload\n    }).filter(exists)\n  }\n\n  protected getFromCursor(\n    order: 'asc' | 'desc' = 'asc',\n    limit = 10,\n    cursor?: Hex,\n    open?: boolean,\n  ): WithStorageMeta[] {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const all: WithStorageMeta[] = Object.values(this.storage.getAll())\n    const payloads: WithStorageMeta[] = all\n      .map(value => value)\n      .toSorted((item1, item2) => {\n        return order === 'asc' ? PayloadBuilder.compareStorageMeta(item1, item2) : PayloadBuilder.compareStorageMeta(item2, item1)\n      })\n    const index = payloads.findIndex(payload => payload._sequence === cursor)\n    if (index !== -1) {\n      return payloads.slice(index + (open ? 1 : 0), index + (open ? 1 : 0) + limit)\n    }\n    return payloads.slice(0, limit)\n  }\n\n  protected override getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]> {\n    return hashes\n      .map(hash => this.storage.get(hash) as WithStorageMeta<Payload> | undefined)\n      .filter(exists)\n  }\n\n  protected override insertHandler(payloads: WithStorageMeta<Payload>[]): WithStorageMeta<Payload>[] {\n    return payloads.map((payload) => {\n      const value = JSON.stringify(payload)\n      // console.log('insert.storagePayloads:', storagePayload)\n      assertEx(value.length < this.maxEntrySize, () => `Payload too large [${payload._hash}, ${value.length}]`)\n      this.storage.set(payload._hash, payload)\n      this.storage.set(payload._dataHash, payload)\n      return payload\n    })\n  }\n\n  protected override nextHandler(options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]> {\n    const {\n      limit, cursor, order, open = true,\n    } = options ?? {}\n    return this.getFromCursor(order, limit ?? 10, cursor, open)\n  }\n\n  protected override async startHandler(): Promise<void> {\n    await super.startHandler()\n  }\n}\n"],
+  "mappings": ";AAGA;AAAA,EACE;AAAA,EAAU;AAAA,EAAQ;AAAA,OACb;AACP,SAAS,mBAAmB,yBAAyB;AASrD;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAKP,SAAS,UAAU,sBAAsB;AAEzC,OAAO,WAAW;AAElB,IAAM,aAAa;AAEZ,IAAM,+BAET,SAAS,wCAAwC,IAAI;AAWlD,IAAM,mBAAN,cAIG,kBACqB;AAAA,EAC7B,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,4BAA4B;AAAA,EACxG,OAAyB,sBAA8B;AAAA,EACvD,OAAyB,SAErB,EAAE,GAAG,MAAM,QAAQ,CAAC,iBAAiB,GAAG,OAAO;AAAA,EAE3C;AAAA,EACA;AAAA,EAER,IAAI,aAAqB;AACvB,WAAO,KAAK,QAAQ,cAAc;AAAA,EACpC;AAAA,EAEA,IAAI,eAAuB;AACzB,WAAO,KAAK,QAAQ,gBAAgB;AAAA,EACtC;AAAA,EAEA,IAAI,YAAoB;AACtB,WAAO,KAAK,QAAQ,aAAa;AAAA,EACnC;AAAA,EAEA,IAAa,UAAoB;AAC/B,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,GAAG,MAAM;AAAA,IACX;AAAA,EACF;AAAA,EAEA,IAAI,OAAqC;AACvC,WAAO,KAAK,QAAQ,QAAQ;AAAA,EAC9B;AAAA;AAAA,EAGA,IAAY,iBAA4B;AACtC,SAAK,kBAAkB,KAAK,YAAY,WAAW,KAAK,IAAI,EAAE,UAAU,GAAG,KAAK,SAAS,UAAU;AACnG,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,IAAY,UAAqB;AAC/B,SAAK,WAAW,KAAK,YAAY,WAAW,KAAK,IAAI,EAAE,UAAU,KAAK,SAAS;AAC/E,WAAO,KAAK;AAAA,EACd;AAAA,EAEmB,aAAwD;AACzE,UAAM,QAAQ,oBAAI,IAAY;AAC9B,SAAK,QAAQ,IAAI,wBAAwB,KAAK,QAAQ,MAAM,EAAE;AAE9D,UAAM,UAAgD,OAAO,QAAQ,KAAK,QAAQ,OAAO,CAAC;AAC1F,WAAO,QACJ,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM,KAAK,EACxB,OAAO,CAAC,YAAY;AACnB,UAAI,MAAM,IAAI,QAAQ,SAAS,GAAG;AAChC,eAAO;AAAA,MACT,OAAO;AACL,cAAM,IAAI,QAAQ,SAAS;AAC3B,eAAO;AAAA,MACT;AAAA,IACF,CAAC,EACA,SAAS,eAAe,kBAAkB;AAAA,EAC/C;AAAA,EAEmB,eAAqC;AACtD,SAAK,QAAQ,IAAI,wBAAwB,KAAK,QAAQ,MAAM,EAAE;AAC9D,SAAK,QAAQ,MAAM;AACnB,WAAO,KAAK,KAAK,WAAW,EAAE,KAAK,KAAK,CAAC;AAAA,EAC3C;AAAA,EAEA,MAAyB,gBAAyC;AAChE,SAAK,QAAQ,IAAI,wBAAwB,KAAK,QAAQ,MAAM,EAAE;AAC9D,UAAM,WAAW,MAAM,KAAK,KAAK,EAAE,OAAO,OAAO,iBAAiB,CAAC;AACnE,aAAS,SAAS,SAAS,GAAG,MAAM,mBAAmB;AACvD,UAAM,WAAW,MAAM,QAAQ;AAAA,MAC7B,OAAO,QAAQ,MAAM,KAAK,iBAAiB,GAAG,UAAU,CAAC,CAAC,GAAG,IAAI,OAAO,WAAW;AACjF,cAAM,eAAqC,EAAE,QAAQ,2BAA2B;AAChF,cAAM,QAAQ,MAAM,KAAK,UAAU,cAAc,QAAQ;AACzD,gBAAQ,MAAM,QAAQ,MAAM,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAAC;AAAA,MACtD,CAAC;AAAA,IACH,GAAG,OAAO,MAAM;AAEhB,UAAM,KAAK,MAAM;AACjB,WAAQ,QAAQ,OAAO,SAAS,EAAE,IAAI,YAAU,OAAO,KAAK,EAAG,OAAO,MAAM;AAAA,EAC9E;AAAA,EAEmB,cAAc,QAA4C;AAC3E,WAAO,OAAO,IAAI,CAAC,SAAS;AAC1B,YAAM,UAAU,KAAK,QAAQ,IAAI,IAAI;AACrC,UAAI,SAAS;AACX,aAAK,QAAQ,OAAO,IAAI;AAAA,MAC1B;AACA,aAAO;AAAA,IACT,CAAC,EAAE,OAAO,MAAM;AAAA,EAClB;AAAA,EAEU,cACR,QAAwB,OACxB,QAAQ,IACR,QACA,MACmB;AAEnB,UAAM,MAAyB,OAAO,OAAO,KAAK,QAAQ,OAAO,CAAC;AAClE,UAAM,WAA8B,IACjC,IAAI,WAAS,KAAK,EAClB,SAAS,CAAC,OAAO,UAAU;AAC1B,aAAO,UAAU,QAAQ,eAAe,mBAAmB,OAAO,KAAK,IAAI,eAAe,mBAAmB,OAAO,KAAK;AAAA,IAC3H,CAAC;AACH,UAAM,QAAQ,SAAS,UAAU,aAAW,QAAQ,cAAc,MAAM;AACxE,QAAI,UAAU,IAAI;AAChB,aAAO,SAAS,MAAM,SAAS,OAAO,IAAI,IAAI,SAAS,OAAO,IAAI,KAAK,KAAK;AAAA,IAC9E;AACA,WAAO,SAAS,MAAM,GAAG,KAAK;AAAA,EAChC;AAAA,EAEmB,WAAW,QAA0D;AACtF,WAAO,OACJ,IAAI,UAAQ,KAAK,QAAQ,IAAI,IAAI,CAAyC,EAC1E,OAAO,MAAM;AAAA,EAClB;AAAA,EAEmB,cAAc,UAAkE;AACjG,WAAO,SAAS,IAAI,CAAC,YAAY;AAC/B,YAAM,QAAQ,KAAK,UAAU,OAAO;AAEpC,eAAS,MAAM,SAAS,KAAK,cAAc,MAAM,sBAAsB,QAAQ,KAAK,KAAK,MAAM,MAAM,GAAG;AACxG,WAAK,QAAQ,IAAI,QAAQ,OAAO,OAAO;AACvC,WAAK,QAAQ,IAAI,QAAQ,WAAW,OAAO;AAC3C,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEmB,YAAY,SAAwE;AACrG,UAAM;AAAA,MACJ;AAAA,MAAO;AAAA,MAAQ;AAAA,MAAO,OAAO;AAAA,IAC/B,IAAI,WAAW,CAAC;AAChB,WAAO,KAAK,cAAc,OAAO,SAAS,IAAI,QAAQ,IAAI;AAAA,EAC5D;AAAA,EAEA,MAAyB,eAA8B;AACrD,UAAM,MAAM,aAAa;AAAA,EAC3B;AACF;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-storage",
-  "version": "6.0.3",
+  "version": "6.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -34,9 +34,9 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/archivist-abstract": "~6.0.3",
-    "@xyo-network/module-model": "~6.0.3",
-    "@xyo-network/archivist-model": "~6.0.3"
+    "@xyo-network/archivist-abstract": "~6.1.0",
+    "@xyo-network/archivist-model": "~6.1.0",
+    "@xyo-network/module-model": "~6.1.0"
   },
   "devDependencies": {
     "@bitauth/libauth": "~3.0.0",
@@ -46,17 +46,15 @@
     "@opentelemetry/sdk-trace-base": "^2.7.1",
     "@scure/base": "~2.2.0",
     "@scure/bip39": "~2.2.0",
-    "@xylabs/geo": "^6.0.7",
-    "@xylabs/sdk-js": "^6.0.7",
-    "@xylabs/threads": "^6.0.7",
-    "@xylabs/toolchain": "~8.1.15",
-    "@xylabs/tsconfig": "~8.1.15",
-    "@xylabs/vitest-extended": "~6.0.7",
-    "@xyo-network/sdk-protocol-js": "~6.0.8",
+    "@xylabs/geo": "^6.1.0",
+    "@xylabs/sdk-js": "^6.1.0",
+    "@xylabs/threads": "^6.1.0",
+    "@xylabs/toolchain": "^8.1.20",
+    "@xylabs/tsconfig": "^8.1.20",
+    "@xylabs/vitest-extended": "^6.1.0",
+    "@xyo-network/sdk-protocol-js": "^6.1.0",
     "ajv": "^8.20.0",
     "async-mutex": "^0.5.0",
-    "bn.js": "^5.2.3",
-    "buffer": "^6.0.3",
     "debug": "~4.4.3",
     "eslint": "^10.4.1",
     "ethers": "^6.16.0",
@@ -64,7 +62,6 @@
     "idb": "^8.0.3",
     "lru-cache": "^11.5.1",
     "observable-fns": "~0.6.1",
-    "pako": "~2.1.0",
     "store2": "~2.14.4",
     "typescript": "~6.0.3",
     "uuid": "~14.0.0",
@@ -72,9 +69,9 @@
     "vitest": "~4.1.8",
     "webextension-polyfill": "^0.12.0",
     "zod": "^4.4.3",
-    "@xyo-network/archivist-memory": "~6.0.3",
-    "@xyo-network/archivist-acceptance-tests": "~6.0.3",
-    "@xyo-network/node-memory": "~6.0.3"
+    "@xyo-network/archivist-acceptance-tests": "~6.1.0",
+    "@xyo-network/archivist-memory": "~6.1.0",
+    "@xyo-network/node-memory": "~6.1.0"
   },
   "peerDependencies": {
     "@bitauth/libauth": "~3.0",
@@ -87,22 +84,22 @@
     "@xylabs/geo": "^6.0",
     "@xylabs/sdk-js": "^6.0",
     "@xylabs/threads": "^6.0",
-    "@xyo-network/sdk-protocol-js": "~6.0",
+    "@xyo-network/sdk-protocol-js": "^6.1",
     "ajv": "^8.20",
     "async-mutex": "^0.5",
-    "bn.js": "^5.2",
-    "buffer": "^6.0",
     "debug": "~4.4",
     "ethers": "^6.16",
     "hash-wasm": "~4.12",
     "idb": "^8.0",
     "lru-cache": "^11.3",
     "observable-fns": "~0.6",
-    "pako": "~2.1",
     "store2": "~2.14",
     "webextension-polyfill": "^0.12",
     "zod": "^4.4"
   },
+  "engines": {
+    "node": "^24"
+  },
   "publishConfig": {
     "access": "public"
   }