@xyo-network/archivist-storage 5.2.27 → 5.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/neutral/StorageArchivist.d.ts +6 -5
  2. package/dist/neutral/StorageArchivist.d.ts.map +1 -1
  3. package/dist/neutral/index.mjs +4 -1
  4. package/dist/neutral/index.mjs.map +1 -1
  5. package/package.json +14 -14
  6. package/src/StorageArchivist.ts +6 -6
package/dist/neutral/StorageArchivist.d.ts CHANGED
@@ -3,16 +3,17 @@ import { AbstractArchivist } from '@xyo-network/archivist-abstract';
3
3
  import type { ArchivistConfig, ArchivistInstance, ArchivistModuleEventData, ArchivistNextOptions, ArchivistParams } from '@xyo-network/archivist-model';
4
4
  import type { BoundWitness } from '@xyo-network/boundwitness-model';
5
5
  import type { AnyConfigSchema } from '@xyo-network/module-model';
6
- import type { Payload, Schema, WithStorageMeta } from '@xyo-network/payload-model';
7
- export declare const StorageArchivistConfigSchema: "network.xyo.archivist.storage.config";
6
+ import { type Payload, type Schema, type WithStorageMeta } from '@xyo-network/payload-model';
7
+ export declare const StorageArchivistConfigSchema: "network.xyo.archivist.storage.config" & {
8
+ readonly __schema: true;
9
+ };
8
10
  export type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema;
9
11
  export type StorageArchivistConfig = ArchivistConfig<{
10
12
  maxEntries?: number;
11
13
  maxEntrySize?: number;
12
14
  namespace?: string;
13
- schema: StorageArchivistConfigSchema;
14
15
  type?: 'local' | 'session' | 'page';
15
- }>;
16
+ }, StorageArchivistConfigSchema>;
16
17
  export type StorageArchivistParams = ArchivistParams<AnyConfigSchema<StorageArchivistConfig>>;
17
18
  export declare class StorageArchivist<TParams extends StorageArchivistParams = StorageArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> implements ArchivistInstance {
18
19
  static readonly configSchemas: Schema[];
@@ -25,7 +26,7 @@ export declare class StorageArchivist<TParams extends StorageArchivistParams = S
25
26
  get maxEntries(): number;
26
27
  get maxEntrySize(): number;
27
28
  get namespace(): string;
28
- get queries(): string[];
29
+ get queries(): Schema[];
29
30
  get type(): "local" | "session" | "page";
30
31
  private get privateStorage();
31
32
  private get storage();
package/dist/neutral/StorageArchivist.d.ts.map CHANGED
@@ -1 +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,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;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;cAgBvD,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,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAc3F,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;cAQ9D,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;CAGtC"}
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,YAAY,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,EAEL,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,eAAe,EAChD,MAAM,4BAA4B,CAAA;AAMnC,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;cAgBvD,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,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAc3F,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;cAQ9D,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;CAGtC"}
package/dist/neutral/index.mjs CHANGED
@@ -14,9 +14,12 @@ import {
14
14
  ArchivistNextQuerySchema
15
15
  } from "@xyo-network/archivist-model";
16
16
  import { PayloadBuilder } from "@xyo-network/payload-builder";
17
+ import {
18
+ asSchema
19
+ } from "@xyo-network/payload-model";
17
20
  import store from "store2";
18
21
  var storeTypes = store;
19
- var StorageArchivistConfigSchema = "network.xyo.archivist.storage.config";
22
+ var StorageArchivistConfigSchema = asSchema("network.xyo.archivist.storage.config", true);
20
23
  var StorageArchivist = class extends AbstractArchivist {
21
24
  static configSchemas = [...super.configSchemas, StorageArchivistConfigSchema];
22
25
  static defaultConfigSchema = StorageArchivistConfigSchema;
package/dist/neutral/index.mjs.map CHANGED
@@ -1 +1 @@
1
- {"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 { 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 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(): string[] {\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 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 .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.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<WithStorageMeta<Payload>[]> {\n return (\n await Promise.all(\n hashes.map((hash) => {\n const payload = this.storage.get(hash)\n if (payload) {\n this.storage.remove(hash)\n }\n return payload\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 .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 (\n hashes.map((hash) => {\n return this.storage.get(hash)\n })\n ).filter(exists)\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 = 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;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,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;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,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,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,QAAqD;AAC1F,YACE,MAAM,QAAQ;AAAA,MACZ,OAAO,IAAI,CAAC,SAAS;AACnB,cAAM,UAAU,KAAK,QAAQ,IAAI,IAAI;AACrC,YAAI,SAAS;AACX,eAAK,QAAQ,OAAO,IAAI;AAAA,QAC1B;AACA,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,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,WACE,OAAO,IAAI,CAAC,SAAS;AACnB,aAAO,KAAK,QAAQ,IAAI,IAAI;AAAA,IAC9B,CAAC,EACD,OAAO,MAAM;AAAA,EACjB;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,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;","names":[]}
1
+ {"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 { BoundWitness } from '@xyo-network/boundwitness-model'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport {\n asSchema,\n type Payload, type Schema, type 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 = 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 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 .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.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<WithStorageMeta<Payload>[]> {\n return (\n await Promise.all(\n hashes.map((hash) => {\n const payload = this.storage.get(hash)\n if (payload) {\n this.storage.remove(hash)\n }\n return payload\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 .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 (\n hashes.map((hash) => {\n return this.storage.get(hash)\n })\n ).filter(exists)\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 = 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;AAGP,SAAS,sBAAsB;AAC/B;AAAA,EACE;AAAA,OAEK;AAEP,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;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,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,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,QAAqD;AAC1F,YACE,MAAM,QAAQ;AAAA,MACZ,OAAO,IAAI,CAAC,SAAS;AACnB,cAAM,UAAU,KAAK,QAAQ,IAAI,IAAI;AACrC,YAAI,SAAS;AACX,eAAK,QAAQ,OAAO,IAAI;AAAA,QAC1B;AACA,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,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,WACE,OAAO,IAAI,CAAC,SAAS;AACnB,aAAO,KAAK,QAAQ,IAAI,IAAI;AAAA,IAC9B,CAAC,EACD,OAAO,MAAM;AAAA,EACjB;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,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;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/archivist-storage",
3
- "version": "5.2.27",
3
+ "version": "5.3.0",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -37,12 +37,12 @@
37
37
  ],
38
38
  "dependencies": {
39
39
  "@xylabs/sdk-js": "~5.0.64",
40
- "@xyo-network/archivist-abstract": "~5.2.27",
41
- "@xyo-network/archivist-model": "~5.2.27",
42
- "@xyo-network/boundwitness-model": "~5.2.27",
43
- "@xyo-network/module-model": "~5.2.27",
44
- "@xyo-network/payload-builder": "~5.2.27",
45
- "@xyo-network/payload-model": "~5.2.27",
40
+ "@xyo-network/archivist-abstract": "~5.3.0",
41
+ "@xyo-network/archivist-model": "~5.3.0",
42
+ "@xyo-network/boundwitness-model": "~5.3.0",
43
+ "@xyo-network/module-model": "~5.3.0",
44
+ "@xyo-network/payload-builder": "~5.3.0",
45
+ "@xyo-network/payload-model": "~5.3.0",
46
46
  "store2": "~2.14.4"
47
47
  },
48
48
  "devDependencies": {
@@ -50,13 +50,13 @@
50
50
  "@xylabs/ts-scripts-yarn3": "~7.3.2",
51
51
  "@xylabs/tsconfig": "~7.3.2",
52
52
  "@xylabs/vitest-extended": "~5.0.64",
53
- "@xyo-network/account": "~5.2.27",
54
- "@xyo-network/archivist-acceptance-tests": "~5.2.27",
55
- "@xyo-network/archivist-memory": "~5.2.27",
56
- "@xyo-network/boundwitness-wrapper": "~5.2.27",
57
- "@xyo-network/id-payload-plugin": "~5.2.27",
58
- "@xyo-network/node-memory": "~5.2.27",
59
- "@xyo-network/payload-wrapper": "~5.2.27",
53
+ "@xyo-network/account": "~5.3.0",
54
+ "@xyo-network/archivist-acceptance-tests": "~5.3.0",
55
+ "@xyo-network/archivist-memory": "~5.3.0",
56
+ "@xyo-network/boundwitness-wrapper": "~5.3.0",
57
+ "@xyo-network/id-payload-plugin": "~5.3.0",
58
+ "@xyo-network/node-memory": "~5.3.0",
59
+ "@xyo-network/payload-wrapper": "~5.3.0",
60
60
  "typescript": "~5.9.3",
61
61
  "uuid": "~13.0.0",
62
62
  "vitest": "~4.0.18"
package/src/StorageArchivist.ts CHANGED
@@ -24,24 +24,24 @@ import {
24
24
  import type { BoundWitness } from '@xyo-network/boundwitness-model'
25
25
  import type { AnyConfigSchema } from '@xyo-network/module-model'
26
26
  import { PayloadBuilder } from '@xyo-network/payload-builder'
27
- import type {
28
- Payload, Schema, WithStorageMeta,
27
+ import {
28
+ asSchema,
29
+ type Payload, type Schema, type WithStorageMeta,
29
30
  } from '@xyo-network/payload-model'
30
31
  import type { StoreBase, StoreType } from 'store2'
31
32
  import store from 'store2'
32
33
 
33
34
  const storeTypes = store as unknown as StoreType
34
35
 
35
- export const StorageArchivistConfigSchema = 'network.xyo.archivist.storage.config' as const
36
+ export const StorageArchivistConfigSchema = asSchema('network.xyo.archivist.storage.config', true)
36
37
  export type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema
37
38
 
38
39
  export type StorageArchivistConfig = ArchivistConfig<{
39
40
  maxEntries?: number
40
41
  maxEntrySize?: number
41
42
  namespace?: string
42
- schema: StorageArchivistConfigSchema
43
43
  type?: 'local' | 'session' | 'page'
44
- }>
44
+ }, StorageArchivistConfigSchema>
45
45
 
46
46
  export type StorageArchivistParams = ArchivistParams<AnyConfigSchema<StorageArchivistConfig>>
47
47
  export class StorageArchivist<
@@ -69,7 +69,7 @@ export class StorageArchivist<
69
69
  return this.config?.namespace ?? 'xyo-archivist'
70
70
  }
71
71
 
72
- override get queries(): string[] {
72
+ override get queries(): Schema[] {
73
73
  return [
74
74
  ArchivistAllQuerySchema,
75
75
  ArchivistDeleteQuerySchema,