@xyo-network/archivist-storage 3.7.0 → 3.7.2

package/dist/neutral/StorageArchivist.d.ts

@@ -31,7 +31,7 @@ export declare class StorageArchivist<TParams extends StorageArchivistParams = S
     protected clearHandler(): void | Promise<void>;
     protected commitHandler(): Promise<BoundWitness[]>;
     protected deleteHandler(hashes: Hash[]): Promise<Hash[]>;
-    protected getFromCursor(order?: 'asc' | 'desc', limit?: number, cursor?: Hex): WithStorageMeta[];
+    protected getFromCursor(order?: 'asc' | 'desc', limit?: number, cursor?: Hex, open?: boolean): WithStorageMeta[];
     protected getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]>;
     protected insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]>;
     protected nextHandler(options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]>;

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

@@ -1 +1 @@
-{"version":3,"file":"StorageArchivist.d.ts","sourceRoot":"","sources":["../../src/StorageArchivist.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EACV,eAAe,EAEf,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AAQrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAAE,eAAe,EACjC,MAAM,4BAA4B,CAAA;AAMnC,eAAO,MAAM,4BAA4B,EAAG,sCAA+C,CAAA;AAC3F,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,MAAM,EAAE,4BAA4B,CAAA;IACpC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;CACpC,CAAC,CAAA;AAEF,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;IAEnF,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,CAS/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;cAiBvD,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAM9B,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;cAgBxC,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAWvE,SAAS,CAAC,aAAa,CACrB,KAAK,GAAE,KAAK,GAAG,MAAc,EAC7B,KAAK,GAAE,MAAW,EAClB,MAAM,CAAC,EAAE,GAAG,GACX,eAAe,EAAE;cAcD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAiB9D,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAW9F,WAAW,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAO7E,YAAY;CAItC"}
+{"version":3,"file":"StorageArchivist.d.ts","sourceRoot":"","sources":["../../src/StorageArchivist.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EACV,eAAe,EAEf,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AAQrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAAE,eAAe,EACjC,MAAM,4BAA4B,CAAA;AAMnC,eAAO,MAAM,4BAA4B,EAAG,sCAA+C,CAAA;AAC3F,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,MAAM,EAAE,4BAA4B,CAAA;IACpC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;CACpC,CAAC,CAAA;AAEF,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;IAEnF,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,CAS/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;cAiBvD,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAM9B,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;cAgBxC,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAWvE,SAAS,CAAC,aAAa,CACrB,KAAK,GAAE,KAAK,GAAG,MAAc,EAC7B,KAAK,GAAE,MAAW,EAClB,MAAM,CAAC,EAAE,GAAG,EACZ,IAAI,CAAC,EAAE,OAAO,GACb,eAAe,EAAE;cAcD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAiB9D,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAW9F,WAAW,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAO7E,YAAY;CAItC"}

package/dist/neutral/index.mjs

@@ -90,14 +90,14 @@ var StorageArchivist = class extends AbstractArchivist {
       })
     )).filter(exists);
   }
-  getFromCursor(order = "asc", limit = 10, cursor) {
+  getFromCursor(order = "asc", limit = 10, cursor, open) {
     const all = Object.values(this.storage.getAll());
     const payloads = all.map((value) => value).sort((a, b) => {
       return order === "asc" ? PayloadBuilder.compareStorageMeta(a, b) : PayloadBuilder.compareStorageMeta(b, a);
     });
     const index = payloads.findIndex((payload) => payload._sequence === cursor);
     if (index !== -1) {
-      return payloads.slice(index + 1, index + 1 + limit);
+      return payloads.slice(index + (open ? 0 : 1), index + (open ? 0 : 1) + limit);
     }
     return payloads.slice(0, limit);
   }
@@ -127,9 +127,10 @@ var StorageArchivist = class extends AbstractArchivist {
     const {
       limit,
       cursor,
-      order
+      order,
+      open
     } = options ?? {};
-    return this.getFromCursor(order, limit ?? 10, cursor);
+    return this.getFromCursor(order, limit ?? 10, cursor, open);
   }
   async startHandler() {
     await super.startHandler();

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/StorageArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { exists } from '@xylabs/exists'\nimport type { Hash, Hex } from '@xylabs/hex'\nimport type { Promisable, PromisableArray } from '@xylabs/promise'\nimport { fulfilled } from '@xylabs/promise'\nimport { AbstractArchivist } 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} from '@xyo-network/archivist-model'\nimport type { BoundWitness } from '@xyo-network/boundwitness-model'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n  Payload, Schema, WithStorageMeta,\n} from '@xyo-network/payload-model'\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' as const\nexport type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema\n\nexport type StorageArchivistConfig = ArchivistConfig<{\n  maxEntries?: number\n  maxEntrySize?: number\n  namespace?: string\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  static override readonly configSchemas: Schema[] = [...super.configSchemas, StorageArchivistConfigSchema]\n  static override readonly defaultConfigSchema: Schema = 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  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 ?? 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    return Object.entries(this.storage.getAll())\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      .sort(PayloadBuilder.compareStorageMeta)\n      .map(payload => PayloadBuilder.omitStorageMeta(payload))\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.all()\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 async deleteHandler(hashes: Hash[]): Promise<Hash[]> {\n    return (\n      await Promise.all(\n        hashes.map((hash) => {\n          this.storage.remove(hash)\n          return hash\n        }),\n      )\n    ).filter(exists)\n  }\n\n  protected getFromCursor(\n    order: 'asc' | 'desc' = 'asc',\n    limit: number = 10,\n    cursor?: Hex,\n  ): WithStorageMeta[] {\n    const all = Object.values(this.storage.getAll()) as WithStorageMeta[]\n    const payloads: WithStorageMeta[] = all\n      .map(value => value)\n      .sort((a, b) => {\n        return order === 'asc' ? PayloadBuilder.compareStorageMeta(a, b) : PayloadBuilder.compareStorageMeta(b, a)\n      })\n    const index = payloads.findIndex(payload => payload._sequence === cursor)\n    if (index !== -1) {\n      return payloads.slice(index + 1, index + 1 + limit)\n    }\n    return payloads.slice(0, limit)\n  }\n\n  protected override getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]> {\n    const found = new Set<string>()\n    return (\n      hashes.map((hash) => {\n        return this.storage.get(hash)\n      })\n    ).filter(exists)\n      .filter((payload) => {\n        if (found.has(payload._dataHash)) {\n          return false\n        } else {\n          found.add(payload._dataHash)\n          return true\n        }\n      }).map(payload => PayloadBuilder.omitStorageMeta(payload))\n  }\n\n  protected override async insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]> {\n    return await Promise.all(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,\n    } = options ?? {}\n    return this.getFromCursor(order, limit ?? 10, cursor)\n  }\n\n  protected override async startHandler() {\n    await super.startHandler()\n    return true\n  }\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAGvB,SAAS,iBAAiB;AAC1B,SAAS,yBAAyB;AASlC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAGP,SAAS,sBAAsB;AAK/B,OAAO,WAAW;AAElB,IAAM,aAAa;AAEZ,IAAM,+BAA+B;AAYrC,IAAM,mBAAN,cAIG,kBACqB;AAAA,EAC7B,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,4BAA4B;AAAA,EACxG,OAAyB,sBAA8B;AAAA,EAE/C;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,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;AAC9D,WAAO,OAAO,QAAQ,KAAK,QAAQ,OAAO,CAAC,EACxC,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,KAAK,eAAe,kBAAkB,EACtC,IAAI,aAAW,eAAe,gBAAgB,OAAO,CAAC;AAAA,EAC3D;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,IAAI;AAChC,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,EAEA,MAAyB,cAAc,QAAiC;AACtE,YACE,MAAM,QAAQ;AAAA,MACZ,OAAO,IAAI,CAAC,SAAS;AACnB,aAAK,QAAQ,OAAO,IAAI;AACxB,eAAO;AAAA,MACT,CAAC;AAAA,IACH,GACA,OAAO,MAAM;AAAA,EACjB;AAAA,EAEU,cACR,QAAwB,OACxB,QAAgB,IAChB,QACmB;AACnB,UAAM,MAAM,OAAO,OAAO,KAAK,QAAQ,OAAO,CAAC;AAC/C,UAAM,WAA8B,IACjC,IAAI,WAAS,KAAK,EAClB,KAAK,CAAC,GAAG,MAAM;AACd,aAAO,UAAU,QAAQ,eAAe,mBAAmB,GAAG,CAAC,IAAI,eAAe,mBAAmB,GAAG,CAAC;AAAA,IAC3G,CAAC;AACH,UAAM,QAAQ,SAAS,UAAU,aAAW,QAAQ,cAAc,MAAM;AACxE,QAAI,UAAU,IAAI;AAChB,aAAO,SAAS,MAAM,QAAQ,GAAG,QAAQ,IAAI,KAAK;AAAA,IACpD;AACA,WAAO,SAAS,MAAM,GAAG,KAAK;AAAA,EAChC;AAAA,EAEmB,WAAW,QAA0D;AACtF,UAAM,QAAQ,oBAAI,IAAY;AAC9B,WACE,OAAO,IAAI,CAAC,SAAS;AACnB,aAAO,KAAK,QAAQ,IAAI,IAAI;AAAA,IAC9B,CAAC,EACD,OAAO,MAAM,EACZ,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,EAAE,IAAI,aAAW,eAAe,gBAAgB,OAAO,CAAC;AAAA,EAC7D;AAAA,EAEA,MAAyB,cAAc,UAA2E;AAChH,WAAO,MAAM,QAAQ,IAAI,SAAS,IAAI,CAAC,YAAY;AACjD,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,CAAC;AAAA,EACJ;AAAA,EAEmB,YAAY,SAAwE;AACrG,UAAM;AAAA,MACJ;AAAA,MAAO;AAAA,MAAQ;AAAA,IACjB,IAAI,WAAW,CAAC;AAChB,WAAO,KAAK,cAAc,OAAO,SAAS,IAAI,MAAM;AAAA,EACtD;AAAA,EAEA,MAAyB,eAAe;AACtC,UAAM,MAAM,aAAa;AACzB,WAAO;AAAA,EACT;AACF;","names":[]}
+{"version":3,"sources":["../../src/StorageArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { exists } from '@xylabs/exists'\nimport type { Hash, Hex } from '@xylabs/hex'\nimport type { Promisable, PromisableArray } from '@xylabs/promise'\nimport { fulfilled } from '@xylabs/promise'\nimport { AbstractArchivist } 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} from '@xyo-network/archivist-model'\nimport type { BoundWitness } from '@xyo-network/boundwitness-model'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n  Payload, Schema, WithStorageMeta,\n} from '@xyo-network/payload-model'\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' as const\nexport type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema\n\nexport type StorageArchivistConfig = ArchivistConfig<{\n  maxEntries?: number\n  maxEntrySize?: number\n  namespace?: string\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  static override readonly configSchemas: Schema[] = [...super.configSchemas, StorageArchivistConfigSchema]\n  static override readonly defaultConfigSchema: Schema = 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  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 ?? 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    return Object.entries(this.storage.getAll())\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      .sort(PayloadBuilder.compareStorageMeta)\n      .map(payload => PayloadBuilder.omitStorageMeta(payload))\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.all()\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 async deleteHandler(hashes: Hash[]): Promise<Hash[]> {\n    return (\n      await Promise.all(\n        hashes.map((hash) => {\n          this.storage.remove(hash)\n          return hash\n        }),\n      )\n    ).filter(exists)\n  }\n\n  protected getFromCursor(\n    order: 'asc' | 'desc' = 'asc',\n    limit: number = 10,\n    cursor?: Hex,\n    open?: boolean,\n  ): WithStorageMeta[] {\n    const all = Object.values(this.storage.getAll()) as WithStorageMeta[]\n    const payloads: WithStorageMeta[] = all\n      .map(value => value)\n      .sort((a, b) => {\n        return order === 'asc' ? PayloadBuilder.compareStorageMeta(a, b) : PayloadBuilder.compareStorageMeta(b, a)\n      })\n    const index = payloads.findIndex(payload => payload._sequence === cursor)\n    if (index !== -1) {\n      return payloads.slice(index + (open ? 0 : 1), index + (open ? 0 : 1) + limit)\n    }\n    return payloads.slice(0, limit)\n  }\n\n  protected override getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]> {\n    const found = new Set<string>()\n    return (\n      hashes.map((hash) => {\n        return this.storage.get(hash)\n      })\n    ).filter(exists)\n      .filter((payload) => {\n        if (found.has(payload._dataHash)) {\n          return false\n        } else {\n          found.add(payload._dataHash)\n          return true\n        }\n      }).map(payload => PayloadBuilder.omitStorageMeta(payload))\n  }\n\n  protected override async insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]> {\n    return await Promise.all(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,\n    } = options ?? {}\n    return this.getFromCursor(order, limit ?? 10, cursor, open)\n  }\n\n  protected override async startHandler() {\n    await super.startHandler()\n    return true\n  }\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAGvB,SAAS,iBAAiB;AAC1B,SAAS,yBAAyB;AASlC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAGP,SAAS,sBAAsB;AAK/B,OAAO,WAAW;AAElB,IAAM,aAAa;AAEZ,IAAM,+BAA+B;AAYrC,IAAM,mBAAN,cAIG,kBACqB;AAAA,EAC7B,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,4BAA4B;AAAA,EACxG,OAAyB,sBAA8B;AAAA,EAE/C;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,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;AAC9D,WAAO,OAAO,QAAQ,KAAK,QAAQ,OAAO,CAAC,EACxC,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,KAAK,eAAe,kBAAkB,EACtC,IAAI,aAAW,eAAe,gBAAgB,OAAO,CAAC;AAAA,EAC3D;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,IAAI;AAChC,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,EAEA,MAAyB,cAAc,QAAiC;AACtE,YACE,MAAM,QAAQ;AAAA,MACZ,OAAO,IAAI,CAAC,SAAS;AACnB,aAAK,QAAQ,OAAO,IAAI;AACxB,eAAO;AAAA,MACT,CAAC;AAAA,IACH,GACA,OAAO,MAAM;AAAA,EACjB;AAAA,EAEU,cACR,QAAwB,OACxB,QAAgB,IAChB,QACA,MACmB;AACnB,UAAM,MAAM,OAAO,OAAO,KAAK,QAAQ,OAAO,CAAC;AAC/C,UAAM,WAA8B,IACjC,IAAI,WAAS,KAAK,EAClB,KAAK,CAAC,GAAG,MAAM;AACd,aAAO,UAAU,QAAQ,eAAe,mBAAmB,GAAG,CAAC,IAAI,eAAe,mBAAmB,GAAG,CAAC;AAAA,IAC3G,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,UAAM,QAAQ,oBAAI,IAAY;AAC9B,WACE,OAAO,IAAI,CAAC,SAAS;AACnB,aAAO,KAAK,QAAQ,IAAI,IAAI;AAAA,IAC9B,CAAC,EACD,OAAO,MAAM,EACZ,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,EAAE,IAAI,aAAW,eAAe,gBAAgB,OAAO,CAAC;AAAA,EAC7D;AAAA,EAEA,MAAyB,cAAc,UAA2E;AAChH,WAAO,MAAM,QAAQ,IAAI,SAAS,IAAI,CAAC,YAAY;AACjD,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,CAAC;AAAA,EACJ;AAAA,EAEmB,YAAY,SAAwE;AACrG,UAAM;AAAA,MACJ;AAAA,MAAO;AAAA,MAAQ;AAAA,MAAO;AAAA,IACxB,IAAI,WAAW,CAAC;AAChB,WAAO,KAAK,cAAc,OAAO,SAAS,IAAI,QAAQ,IAAI;AAAA,EAC5D;AAAA,EAEA,MAAyB,eAAe;AACtC,UAAM,MAAM,aAAa;AACzB,WAAO;AAAA,EACT;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-storage",
-  "version": "3.7.0",
+  "version": "3.7.2",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -33,12 +33,12 @@
     "@xylabs/exists": "^4.5.1",
     "@xylabs/hex": "^4.5.1",
     "@xylabs/promise": "^4.5.1",
-    "@xyo-network/archivist-abstract": "^3.7.0",
-    "@xyo-network/archivist-model": "^3.7.0",
-    "@xyo-network/boundwitness-model": "^3.7.0",
-    "@xyo-network/module-model": "^3.7.0",
-    "@xyo-network/payload-builder": "^3.7.0",
-    "@xyo-network/payload-model": "^3.7.0",
+    "@xyo-network/archivist-abstract": "^3.7.2",
+    "@xyo-network/archivist-model": "^3.7.2",
+    "@xyo-network/boundwitness-model": "^3.7.2",
+    "@xyo-network/module-model": "^3.7.2",
+    "@xyo-network/payload-builder": "^3.7.2",
+    "@xyo-network/payload-model": "^3.7.2",
     "store2": "^2.14.4"
   },
   "devDependencies": {
@@ -46,12 +46,12 @@
     "@xylabs/ts-scripts-yarn3": "^4.2.6",
     "@xylabs/tsconfig": "^4.2.6",
     "@xylabs/vitest-extended": "^4.5.1",
-    "@xyo-network/account": "^3.7.0",
-    "@xyo-network/archivist-memory": "^3.7.0",
-    "@xyo-network/boundwitness-wrapper": "^3.7.0",
-    "@xyo-network/id-payload-plugin": "^3.7.0",
-    "@xyo-network/node-memory": "^3.7.0",
-    "@xyo-network/payload-wrapper": "^3.7.0",
+    "@xyo-network/account": "^3.7.2",
+    "@xyo-network/archivist-memory": "^3.7.2",
+    "@xyo-network/boundwitness-wrapper": "^3.7.2",
+    "@xyo-network/id-payload-plugin": "^3.7.2",
+    "@xyo-network/node-memory": "^3.7.2",
+    "@xyo-network/payload-wrapper": "^3.7.2",
     "typescript": "^5.7.3",
     "vitest": "^3.0.4"
   },

package/src/StorageArchivist.ts

@@ -147,6 +147,7 @@ export class StorageArchivist<
     order: 'asc' | 'desc' = 'asc',
     limit: number = 10,
     cursor?: Hex,
+    open?: boolean,
   ): WithStorageMeta[] {
     const all = Object.values(this.storage.getAll()) as WithStorageMeta[]
     const payloads: WithStorageMeta[] = all
@@ -156,7 +157,7 @@ export class StorageArchivist<
       })
     const index = payloads.findIndex(payload => payload._sequence === cursor)
     if (index !== -1) {
-      return payloads.slice(index + 1, index + 1 + limit)
+      return payloads.slice(index + (open ? 0 : 1), index + (open ? 0 : 1) + limit)
     }
     return payloads.slice(0, limit)
   }
@@ -191,9 +192,9 @@ export class StorageArchivist<
 
   protected override nextHandler(options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]> {
     const {
-      limit, cursor, order,
+      limit, cursor, order, open,
     } = options ?? {}
-    return this.getFromCursor(order, limit ?? 10, cursor)
+    return this.getFromCursor(order, limit ?? 10, cursor, open)
   }
 
   protected override async startHandler() {