@xyo-network/archivist-storage 3.7.2 → 3.8.1

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.
@@ -1,2 +1,42 @@
1
- export * from './StorageArchivist.ts';
2
- //# sourceMappingURL=index.d.ts.map
1
+ import { Hash, Hex } from '@xylabs/hex';
2
+ import { PromisableArray, Promisable } from '@xylabs/promise';
3
+ import { AbstractArchivist } from '@xyo-network/archivist-abstract';
4
+ import { ArchivistConfig, ArchivistParams, ArchivistModuleEventData, ArchivistInstance, ArchivistNextOptions } from '@xyo-network/archivist-model';
5
+ import { BoundWitness } from '@xyo-network/boundwitness-model';
6
+ import { AnyConfigSchema } from '@xyo-network/module-model';
7
+ import { Schema, WithStorageMeta, Payload } from '@xyo-network/payload-model';
8
+
9
+ declare const StorageArchivistConfigSchema: "network.xyo.archivist.storage.config";
10
+ type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema;
11
+ type StorageArchivistConfig = ArchivistConfig<{
12
+ maxEntries?: number;
13
+ maxEntrySize?: number;
14
+ namespace?: string;
15
+ schema: StorageArchivistConfigSchema;
16
+ type?: 'local' | 'session' | 'page';
17
+ }>;
18
+ type StorageArchivistParams = ArchivistParams<AnyConfigSchema<StorageArchivistConfig>>;
19
+ declare class StorageArchivist<TParams extends StorageArchivistParams = StorageArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> implements ArchivistInstance {
20
+ static readonly configSchemas: Schema[];
21
+ static readonly defaultConfigSchema: Schema;
22
+ private _privateStorage;
23
+ private _storage;
24
+ get maxEntries(): number;
25
+ get maxEntrySize(): number;
26
+ get namespace(): string;
27
+ get queries(): string[];
28
+ get type(): "local" | "session" | "page";
29
+ private get privateStorage();
30
+ private get storage();
31
+ protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;
32
+ protected clearHandler(): void | Promise<void>;
33
+ protected commitHandler(): Promise<BoundWitness[]>;
34
+ protected deleteHandler(hashes: Hash[]): Promise<Hash[]>;
35
+ protected getFromCursor(order?: 'asc' | 'desc', limit?: number, cursor?: Hex, open?: boolean): WithStorageMeta[];
36
+ protected getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]>;
37
+ protected insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]>;
38
+ protected nextHandler(options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]>;
39
+ protected startHandler(): Promise<boolean>;
40
+ }
41
+
42
+ export { StorageArchivist, type StorageArchivistConfig, StorageArchivistConfigSchema, type StorageArchivistParams };
@@ -92,8 +92,8 @@ var StorageArchivist = class extends AbstractArchivist {
92
92
  }
93
93
  getFromCursor(order = "asc", limit = 10, cursor, open) {
94
94
  const all = Object.values(this.storage.getAll());
95
- const payloads = all.map((value) => value).sort((a, b) => {
96
- return order === "asc" ? PayloadBuilder.compareStorageMeta(a, b) : PayloadBuilder.compareStorageMeta(b, a);
95
+ const payloads = all.map((value) => value).sort((item1, item2) => {
96
+ return order === "asc" ? PayloadBuilder.compareStorageMeta(item1, item2) : PayloadBuilder.compareStorageMeta(item2, item1);
97
97
  });
98
98
  const index = payloads.findIndex((payload) => payload._sequence === cursor);
99
99
  if (index !== -1) {
@@ -1 +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 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":[]}
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 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((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 ? 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,OAAO,UAAU;AACtB,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,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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/archivist-storage",
3
- "version": "3.7.2",
3
+ "version": "3.8.1",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -33,27 +33,27 @@
33
33
  "@xylabs/exists": "^4.5.1",
34
34
  "@xylabs/hex": "^4.5.1",
35
35
  "@xylabs/promise": "^4.5.1",
36
- "@xyo-network/archivist-abstract": "^3.7.2",
37
- "@xyo-network/archivist-model": "^3.7.2",
38
- "@xyo-network/boundwitness-model": "^3.7.2",
39
- "@xyo-network/module-model": "^3.7.2",
40
- "@xyo-network/payload-builder": "^3.7.2",
41
- "@xyo-network/payload-model": "^3.7.2",
36
+ "@xyo-network/archivist-abstract": "^3.8.1",
37
+ "@xyo-network/archivist-model": "^3.8.1",
38
+ "@xyo-network/boundwitness-model": "^3.8.1",
39
+ "@xyo-network/module-model": "^3.8.1",
40
+ "@xyo-network/payload-builder": "^3.8.1",
41
+ "@xyo-network/payload-model": "^3.8.1",
42
42
  "store2": "^2.14.4"
43
43
  },
44
44
  "devDependencies": {
45
45
  "@xylabs/delay": "^4.5.1",
46
- "@xylabs/ts-scripts-yarn3": "^4.2.6",
47
- "@xylabs/tsconfig": "^4.2.6",
46
+ "@xylabs/ts-scripts-yarn3": "^5.0.22",
47
+ "@xylabs/tsconfig": "^5.0.22",
48
48
  "@xylabs/vitest-extended": "^4.5.1",
49
- "@xyo-network/account": "^3.7.2",
50
- "@xyo-network/archivist-memory": "^3.7.2",
51
- "@xyo-network/boundwitness-wrapper": "^3.7.2",
52
- "@xyo-network/id-payload-plugin": "^3.7.2",
53
- "@xyo-network/node-memory": "^3.7.2",
54
- "@xyo-network/payload-wrapper": "^3.7.2",
49
+ "@xyo-network/account": "^3.8.1",
50
+ "@xyo-network/archivist-memory": "^3.8.1",
51
+ "@xyo-network/boundwitness-wrapper": "^3.8.1",
52
+ "@xyo-network/id-payload-plugin": "^3.8.1",
53
+ "@xyo-network/node-memory": "^3.8.1",
54
+ "@xyo-network/payload-wrapper": "^3.8.1",
55
55
  "typescript": "^5.7.3",
56
- "vitest": "^3.0.4"
56
+ "vitest": "^3.0.5"
57
57
  },
58
58
  "publishConfig": {
59
59
  "access": "public"
@@ -152,8 +152,8 @@ export class StorageArchivist<
152
152
  const all = Object.values(this.storage.getAll()) as WithStorageMeta[]
153
153
  const payloads: WithStorageMeta[] = all
154
154
  .map(value => value)
155
- .sort((a, b) => {
156
- return order === 'asc' ? PayloadBuilder.compareStorageMeta(a, b) : PayloadBuilder.compareStorageMeta(b, a)
155
+ .sort((item1, item2) => {
156
+ return order === 'asc' ? PayloadBuilder.compareStorageMeta(item1, item2) : PayloadBuilder.compareStorageMeta(item2, item1)
157
157
  })
158
158
  const index = payloads.findIndex(payload => payload._sequence === cursor)
159
159
  if (index !== -1) {
@@ -1,40 +0,0 @@
1
- import type { Hash, Hex } from '@xylabs/hex';
2
- import type { Promisable, PromisableArray } from '@xylabs/promise';
3
- import { AbstractArchivist } from '@xyo-network/archivist-abstract';
4
- import type { ArchivistConfig, ArchivistInstance, ArchivistModuleEventData, ArchivistNextOptions, ArchivistParams } from '@xyo-network/archivist-model';
5
- import type { BoundWitness } from '@xyo-network/boundwitness-model';
6
- import type { AnyConfigSchema } from '@xyo-network/module-model';
7
- import type { Payload, Schema, WithStorageMeta } from '@xyo-network/payload-model';
8
- export declare const StorageArchivistConfigSchema: "network.xyo.archivist.storage.config";
9
- export type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema;
10
- export type StorageArchivistConfig = ArchivistConfig<{
11
- maxEntries?: number;
12
- maxEntrySize?: number;
13
- namespace?: string;
14
- schema: StorageArchivistConfigSchema;
15
- type?: 'local' | 'session' | 'page';
16
- }>;
17
- export type StorageArchivistParams = ArchivistParams<AnyConfigSchema<StorageArchivistConfig>>;
18
- export declare class StorageArchivist<TParams extends StorageArchivistParams = StorageArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> implements ArchivistInstance {
19
- static readonly configSchemas: Schema[];
20
- static readonly defaultConfigSchema: Schema;
21
- private _privateStorage;
22
- private _storage;
23
- get maxEntries(): number;
24
- get maxEntrySize(): number;
25
- get namespace(): string;
26
- get queries(): string[];
27
- get type(): "local" | "session" | "page";
28
- private get privateStorage();
29
- private get storage();
30
- protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;
31
- protected clearHandler(): void | Promise<void>;
32
- protected commitHandler(): Promise<BoundWitness[]>;
33
- protected deleteHandler(hashes: Hash[]): Promise<Hash[]>;
34
- protected getFromCursor(order?: 'asc' | 'desc', limit?: number, cursor?: Hex, open?: boolean): WithStorageMeta[];
35
- protected getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]>;
36
- protected insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]>;
37
- protected nextHandler(options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]>;
38
- protected startHandler(): Promise<boolean>;
39
- }
40
- //# sourceMappingURL=StorageArchivist.d.ts.map
@@ -1 +0,0 @@
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,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"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA"}