@xyo-network/archivist-storage 6.1.0 → 7.0.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.
|
@@ -1,12 +1,26 @@
|
|
|
1
1
|
import type { Hash, Hex, Promisable, PromisableArray } from '@xylabs/sdk-js';
|
|
2
|
+
import { zodAsFactory, zodIsFactory, zodToFactory } from '@xylabs/sdk-js';
|
|
2
3
|
import { AbstractArchivist } from '@xyo-network/archivist-abstract';
|
|
3
4
|
import type { ArchivistConfig, ArchivistInstance, ArchivistModuleEventData, ArchivistNextOptions, ArchivistParams } from '@xyo-network/archivist-model';
|
|
5
|
+
import { ArchivistConfigZod } from '@xyo-network/archivist-model';
|
|
4
6
|
import type { AnyConfigSchema } from '@xyo-network/module-model';
|
|
5
7
|
import type { BoundWitness, Payload, Schema, WithStorageMeta } from '@xyo-network/sdk-protocol-js';
|
|
8
|
+
import * as z from 'zod/mini';
|
|
6
9
|
export declare const StorageArchivistConfigSchema: 'network.xyo.archivist.storage.config' & {
|
|
7
10
|
readonly __schema: true;
|
|
8
11
|
};
|
|
9
12
|
export type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema;
|
|
13
|
+
export declare const StorageArchivistConfigZod: z.ZodMiniObject<Omit<(typeof ArchivistConfigZod)['shape'], 'schema'> & {
|
|
14
|
+
maxEntries: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
15
|
+
maxEntrySize: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
16
|
+
namespace: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
17
|
+
schema: z.ZodMiniLiteral<StorageArchivistConfigSchema>;
|
|
18
|
+
type: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<'local'>, z.ZodMiniLiteral<'session'>, z.ZodMiniLiteral<'page'>]>>;
|
|
19
|
+
}, z.core.$strip>;
|
|
20
|
+
export type StorageArchivistConfigBase = z.infer<typeof StorageArchivistConfigZod>;
|
|
21
|
+
export declare const isStorageArchivistConfig: ReturnType<typeof zodIsFactory<StorageArchivistConfigBase>>;
|
|
22
|
+
export declare const asStorageArchivistConfig: ReturnType<typeof zodAsFactory<StorageArchivistConfigBase>>;
|
|
23
|
+
export declare const toStorageArchivistConfig: ReturnType<typeof zodToFactory<StorageArchivistConfigBase>>;
|
|
10
24
|
export type StorageArchivistConfig = ArchivistConfig<{
|
|
11
25
|
maxEntries?: number;
|
|
12
26
|
maxEntrySize?: number;
|
|
@@ -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;
|
|
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;AACvB,OAAO,EAEL,YAAY,EAAE,YAAY,EAAE,YAAY,EACzC,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,iBAAiB,EAAqB,MAAM,iCAAiC,CAAA;AACtF,OAAO,KAAK,EACV,eAAe,EAEf,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAIL,kBAAkB,EAInB,MAAM,8BAA8B,CAAA;AACrC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EACV,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAC/C,MAAM,8BAA8B,CAAA;AAIrC,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAI7B,eAAO,MAAM,4BAA4B,EAAE,sCAAsC,GAAG;IAClF,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;CACiC,CAAA;AAC1D,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAA;AAE9E,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,aAAa,CACnD,IAAI,CAAC,CAAC,OAAO,kBAAkB,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACpD;IACA,UAAU,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;IACtD,YAAY,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;IACxD,SAAS,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;IACrD,MAAM,EAAE,CAAC,CAAC,cAAc,CAAC,4BAA4B,CAAC,CAAA;IACtD,IAAI,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;CACrI,EACD,CAAC,CAAC,IAAI,CAAC,MAAM,CAOb,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAElF,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,0BAA0B,CAAC,CAA2C,CAAA;AAC5I,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,0BAA0B,CAAC,CAAuE,CAAA;AACxK,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,0BAA0B,CAAC,CAAuE,CAAA;AAExK,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAAC;IACnD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;CACpC,EAAE,4BAA4B,CAAC,CAAA;AAEhC,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC,CAAA;AAC7F,qBAAa,gBAAgB,CAC3B,OAAO,SAAS,sBAAsB,GAAG,sBAAsB,EAC/D,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CAEtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAC7C,YAAW,iBAAiB;IAC5B,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAyD;IACzG,gBAAyB,mBAAmB,EAAE,MAAM,CAA+B;IACnF,gBAAyB,MAAM,EAAE;QAC/B,2BAA2B,EAAE,MAAM,CAAA;KACpC,CAAmD;IAEpD,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,QAAQ,CAAuB;IAEvC,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,IAAa,OAAO,IAAI,MAAM,EAAE,CAU/B;IAED,IAAI,IAAI,IAAI,OAAO,GAAG,SAAS,GAAG,MAAM,CAEvC;IAGD,OAAO,KAAK,cAAc,GAGzB;IAGD,OAAO,KAAK,OAAO,GAGlB;cAEkB,UAAU,IAAI,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;cAkBvD,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAM9B,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;cAgB9C,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,EAAE;IAU5E,SAAS,CAAC,aAAa,CACrB,KAAK,GAAE,KAAK,GAAG,MAAc,EAC7B,KAAK,SAAK,EACV,MAAM,CAAC,EAAE,GAAG,EACZ,IAAI,CAAC,EAAE,OAAO,GACb,eAAe,EAAE;cAeD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAMpE,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,EAAE;cAW/E,WAAW,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAO7E,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAGvD"}
|
package/dist/neutral/index.mjs
CHANGED
|
@@ -2,21 +2,36 @@
|
|
|
2
2
|
import {
|
|
3
3
|
assertEx,
|
|
4
4
|
exists,
|
|
5
|
-
fulfilled
|
|
5
|
+
fulfilled,
|
|
6
|
+
zodAsFactory,
|
|
7
|
+
zodIsFactory,
|
|
8
|
+
zodToFactory
|
|
6
9
|
} from "@xylabs/sdk-js";
|
|
7
10
|
import { AbstractArchivist, StorageClassLabel } from "@xyo-network/archivist-abstract";
|
|
8
11
|
import {
|
|
9
12
|
ArchivistAllQuerySchema,
|
|
10
13
|
ArchivistClearQuerySchema,
|
|
11
14
|
ArchivistCommitQuerySchema,
|
|
15
|
+
ArchivistConfigZod,
|
|
12
16
|
ArchivistDeleteQuerySchema,
|
|
13
17
|
ArchivistInsertQuerySchema,
|
|
14
18
|
ArchivistNextQuerySchema
|
|
15
19
|
} from "@xyo-network/archivist-model";
|
|
16
20
|
import { asSchema, PayloadBuilder } from "@xyo-network/sdk-protocol-js";
|
|
17
21
|
import store from "store2";
|
|
22
|
+
import * as z from "zod/mini";
|
|
18
23
|
var storeTypes = store;
|
|
19
24
|
var StorageArchivistConfigSchema = asSchema("network.xyo.archivist.storage.config", true);
|
|
25
|
+
var StorageArchivistConfigZod = z.extend(ArchivistConfigZod, {
|
|
26
|
+
maxEntries: z.optional(z.number()),
|
|
27
|
+
maxEntrySize: z.optional(z.number()),
|
|
28
|
+
namespace: z.optional(z.string()),
|
|
29
|
+
schema: z.literal(StorageArchivistConfigSchema),
|
|
30
|
+
type: z.optional(z.union([z.literal("local"), z.literal("session"), z.literal("page")]))
|
|
31
|
+
});
|
|
32
|
+
var isStorageArchivistConfig = zodIsFactory(StorageArchivistConfigZod);
|
|
33
|
+
var asStorageArchivistConfig = zodAsFactory(StorageArchivistConfigZod, "asStorageArchivistConfig");
|
|
34
|
+
var toStorageArchivistConfig = zodToFactory(StorageArchivistConfigZod, "toStorageArchivistConfig");
|
|
20
35
|
var StorageArchivist = class extends AbstractArchivist {
|
|
21
36
|
static configSchemas = [...super.configSchemas, StorageArchivistConfigSchema];
|
|
22
37
|
static defaultConfigSchema = StorageArchivistConfigSchema;
|
|
@@ -135,6 +150,10 @@ var StorageArchivist = class extends AbstractArchivist {
|
|
|
135
150
|
};
|
|
136
151
|
export {
|
|
137
152
|
StorageArchivist,
|
|
138
|
-
StorageArchivistConfigSchema
|
|
153
|
+
StorageArchivistConfigSchema,
|
|
154
|
+
StorageArchivistConfigZod,
|
|
155
|
+
asStorageArchivistConfig,
|
|
156
|
+
isStorageArchivistConfig,
|
|
157
|
+
toStorageArchivistConfig
|
|
139
158
|
};
|
|
140
159
|
//# sourceMappingURL=index.mjs.map
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/StorageArchivist.ts"],
|
|
4
|
-
"sourcesContent": ["import type {\n Hash, Hex, Promisable, PromisableArray,\n} from '@xylabs/sdk-js'\nimport {\n assertEx, exists, fulfilled,\n} from '@xylabs/sdk-js'\nimport { AbstractArchivist, StorageClassLabel } from '@xyo-network/archivist-abstract'\nimport type {\n ArchivistConfig,\n ArchivistInsertQuery,\n ArchivistInstance,\n ArchivistModuleEventData,\n ArchivistNextOptions,\n ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistCommitQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistNextQuerySchema,\n} from '@xyo-network/archivist-model'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport type {\n BoundWitness, Payload, Schema, WithStorageMeta,\n} from '@xyo-network/sdk-protocol-js'\nimport { asSchema, PayloadBuilder } from '@xyo-network/sdk-protocol-js'\nimport type { StoreBase, StoreType } from 'store2'\nimport store from 'store2'\n\nconst storeTypes = store as unknown as StoreType\n\nexport const StorageArchivistConfigSchema: 'network.xyo.archivist.storage.config' & {\n readonly __schema: true\n} = asSchema('network.xyo.archivist.storage.config', true)\nexport type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema\n\nexport type StorageArchivistConfig = ArchivistConfig<{\n maxEntries?: number\n maxEntrySize?: number\n namespace?: string\n type?: 'local' | 'session' | 'page'\n}, StorageArchivistConfigSchema>\n\nexport type StorageArchivistParams = ArchivistParams<AnyConfigSchema<StorageArchivistConfig>>\nexport class StorageArchivist<\n TParams extends StorageArchivistParams = StorageArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n>\n extends AbstractArchivist<TParams, TEventData>\n implements ArchivistInstance {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, StorageArchivistConfigSchema]\n static override readonly defaultConfigSchema: Schema = StorageArchivistConfigSchema\n static override readonly labels: {\n 'network.xyo.storage.class': string\n } = { ...super.labels, [StorageClassLabel]: 'disk' }\n\n private _privateStorage: StoreBase | undefined\n private _storage: StoreBase | undefined\n\n get maxEntries(): number {\n return this.config?.maxEntries ?? 1000\n }\n\n get maxEntrySize(): number {\n return this.config?.maxEntrySize ?? 16_000\n }\n\n get namespace(): string {\n return this.config?.namespace ?? 'xyo-archivist'\n }\n\n override get queries(): Schema[] {\n return [\n ArchivistAllQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistCommitQuerySchema,\n ArchivistNextQuerySchema,\n ...super.queries,\n ]\n }\n\n get type(): 'local' | 'session' | 'page' {\n return this.config?.type ?? 'local'\n }\n\n /* This has to be a getter so that it can access it during construction */\n private get privateStorage(): StoreBase {\n this._privateStorage = this._storage ?? storeTypes[this.type].namespace(`${this.namespace}|private`)\n return this._privateStorage\n }\n\n /* This has to be a getter so that it can access it during construction */\n private get storage(): StoreBase {\n this._storage = this._storage ?? storeTypes[this.type].namespace(this.namespace)\n return this._storage\n }\n\n protected override allHandler(): PromisableArray<WithStorageMeta<Payload>> {\n const found = new Set<string>()\n this.logger?.log(`this.storage.length: ${this.storage.length}`)\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const entries: [string, WithStorageMeta<Payload>][] = Object.entries(this.storage.getAll())\n return entries\n .map(([, value]) => value)\n .filter((payload) => {\n if (found.has(payload._dataHash)) {\n return false\n } else {\n found.add(payload._dataHash)\n return true\n }\n })\n .toSorted(PayloadBuilder.compareStorageMeta)\n }\n\n protected override clearHandler(): void | Promise<void> {\n this.logger?.log(`this.storage.length: ${this.storage.length}`)\n this.storage.clear()\n return this.emit('cleared', { mod: this })\n }\n\n protected override async commitHandler(): Promise<BoundWitness[]> {\n this.logger?.log(`this.storage.length: ${this.storage.length}`)\n const payloads = await this.next({ limit: Number.MAX_SAFE_INTEGER })\n assertEx(payloads.length > 0, () => 'Nothing to commit')\n const settled = (await Promise.allSettled(\n Object.values((await this.parentArchivists()).commit ?? [])?.map(async (parent) => {\n const queryPayload: ArchivistInsertQuery = { schema: ArchivistInsertQuerySchema }\n const query = await this.bindQuery(queryPayload, payloads)\n return (await parent?.query(query[0], query[1]))?.[0]\n }),\n )).filter(exists)\n // TODO - rather than clear, delete the payloads that come back as successfully inserted\n await this.clear()\n return (settled.filter(fulfilled).map(result => result.value)).filter(exists)\n }\n\n protected override deleteHandler(hashes: Hash[]): WithStorageMeta<Payload>[] {\n return hashes.map((hash) => {\n const payload = this.storage.get(hash) as WithStorageMeta<Payload> | undefined\n if (payload) {\n this.storage.remove(hash)\n }\n return payload\n }).filter(exists)\n }\n\n protected getFromCursor(\n order: 'asc' | 'desc' = 'asc',\n limit = 10,\n cursor?: Hex,\n open?: boolean,\n ): WithStorageMeta[] {\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const all: WithStorageMeta[] = Object.values(this.storage.getAll())\n const payloads: WithStorageMeta[] = all\n .map(value => value)\n .toSorted((item1, item2) => {\n return order === 'asc' ? PayloadBuilder.compareStorageMeta(item1, item2) : PayloadBuilder.compareStorageMeta(item2, item1)\n })\n const index = payloads.findIndex(payload => payload._sequence === cursor)\n if (index !== -1) {\n return payloads.slice(index + (open ? 1 : 0), index + (open ? 1 : 0) + limit)\n }\n return payloads.slice(0, limit)\n }\n\n protected override getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]> {\n return hashes\n .map(hash => this.storage.get(hash) as WithStorageMeta<Payload> | undefined)\n .filter(exists)\n }\n\n protected override insertHandler(payloads: WithStorageMeta<Payload>[]): WithStorageMeta<Payload>[] {\n return payloads.map((payload) => {\n const value = JSON.stringify(payload)\n // console.log('insert.storagePayloads:', storagePayload)\n assertEx(value.length < this.maxEntrySize, () => `Payload too large [${payload._hash}, ${value.length}]`)\n this.storage.set(payload._hash, payload)\n this.storage.set(payload._dataHash, payload)\n return payload\n })\n }\n\n protected override nextHandler(options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]> {\n const {\n limit, cursor, order, open = true,\n } = options ?? {}\n return this.getFromCursor(order, limit ?? 10, cursor, open)\n }\n\n protected override async startHandler(): Promise<void> {\n await super.startHandler()\n }\n}\n"],
|
|
5
|
-
"mappings": ";AAGA;AAAA,EACE;AAAA,EAAU;AAAA,EAAQ;AAAA,
|
|
4
|
+
"sourcesContent": ["import type {\n Hash, Hex, Promisable, PromisableArray,\n} from '@xylabs/sdk-js'\nimport {\n assertEx, exists, fulfilled,\n zodAsFactory, zodIsFactory, zodToFactory,\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 ArchivistConfigZod,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistNextQuerySchema,\n} from '@xyo-network/archivist-model'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport type {\n BoundWitness, Payload, Schema, WithStorageMeta,\n} from '@xyo-network/sdk-protocol-js'\nimport { asSchema, PayloadBuilder } from '@xyo-network/sdk-protocol-js'\nimport type { StoreBase, StoreType } from 'store2'\nimport store from 'store2'\nimport * as z from 'zod/mini'\n\nconst storeTypes = store as unknown as StoreType\n\nexport const StorageArchivistConfigSchema: 'network.xyo.archivist.storage.config' & {\n readonly __schema: true\n} = asSchema('network.xyo.archivist.storage.config', true)\nexport type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema\n\nexport const StorageArchivistConfigZod: z.ZodMiniObject<\n & Omit<(typeof ArchivistConfigZod)['shape'], 'schema'>\n & {\n maxEntries: z.ZodMiniOptional<z.ZodMiniNumber<number>>\n maxEntrySize: z.ZodMiniOptional<z.ZodMiniNumber<number>>\n namespace: z.ZodMiniOptional<z.ZodMiniString<string>>\n schema: z.ZodMiniLiteral<StorageArchivistConfigSchema>\n type: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<'local'>, z.ZodMiniLiteral<'session'>, z.ZodMiniLiteral<'page'>]>>\n },\n z.core.$strip\n> = z.extend(ArchivistConfigZod, {\n maxEntries: z.optional(z.number()),\n maxEntrySize: z.optional(z.number()),\n namespace: z.optional(z.string()),\n schema: z.literal(StorageArchivistConfigSchema),\n type: z.optional(z.union([z.literal('local'), z.literal('session'), z.literal('page')])),\n})\n\nexport type StorageArchivistConfigBase = z.infer<typeof StorageArchivistConfigZod>\n\nexport const isStorageArchivistConfig: ReturnType<typeof zodIsFactory<StorageArchivistConfigBase>> = zodIsFactory(StorageArchivistConfigZod)\nexport const asStorageArchivistConfig: ReturnType<typeof zodAsFactory<StorageArchivistConfigBase>> = zodAsFactory(StorageArchivistConfigZod, 'asStorageArchivistConfig')\nexport const toStorageArchivistConfig: ReturnType<typeof zodToFactory<StorageArchivistConfigBase>> = zodToFactory(StorageArchivistConfigZod, 'toStorageArchivistConfig')\n\nexport type StorageArchivistConfig = ArchivistConfig<{\n maxEntries?: number\n maxEntrySize?: number\n namespace?: string\n type?: 'local' | 'session' | 'page'\n}, StorageArchivistConfigSchema>\n\nexport type StorageArchivistParams = ArchivistParams<AnyConfigSchema<StorageArchivistConfig>>\nexport class StorageArchivist<\n TParams extends StorageArchivistParams = StorageArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n>\n extends AbstractArchivist<TParams, TEventData>\n implements ArchivistInstance {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, StorageArchivistConfigSchema]\n static override readonly defaultConfigSchema: Schema = StorageArchivistConfigSchema\n static override readonly labels: {\n 'network.xyo.storage.class': string\n } = { ...super.labels, [StorageClassLabel]: 'disk' }\n\n private _privateStorage: StoreBase | undefined\n private _storage: StoreBase | undefined\n\n get maxEntries(): number {\n return this.config?.maxEntries ?? 1000\n }\n\n get maxEntrySize(): number {\n return this.config?.maxEntrySize ?? 16_000\n }\n\n get namespace(): string {\n return this.config?.namespace ?? 'xyo-archivist'\n }\n\n override get queries(): Schema[] {\n return [\n ArchivistAllQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistCommitQuerySchema,\n ArchivistNextQuerySchema,\n ...super.queries,\n ]\n }\n\n get type(): 'local' | 'session' | 'page' {\n return this.config?.type ?? 'local'\n }\n\n /* This has to be a getter so that it can access it during construction */\n private get privateStorage(): StoreBase {\n this._privateStorage = this._storage ?? storeTypes[this.type].namespace(`${this.namespace}|private`)\n return this._privateStorage\n }\n\n /* This has to be a getter so that it can access it during construction */\n private get storage(): StoreBase {\n this._storage = this._storage ?? storeTypes[this.type].namespace(this.namespace)\n return this._storage\n }\n\n protected override allHandler(): PromisableArray<WithStorageMeta<Payload>> {\n const found = new Set<string>()\n this.logger?.log(`this.storage.length: ${this.storage.length}`)\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const entries: [string, WithStorageMeta<Payload>][] = Object.entries(this.storage.getAll())\n return entries\n .map(([, value]) => value)\n .filter((payload) => {\n if (found.has(payload._dataHash)) {\n return false\n } else {\n found.add(payload._dataHash)\n return true\n }\n })\n .toSorted(PayloadBuilder.compareStorageMeta)\n }\n\n protected override clearHandler(): void | Promise<void> {\n this.logger?.log(`this.storage.length: ${this.storage.length}`)\n this.storage.clear()\n return this.emit('cleared', { mod: this })\n }\n\n protected override async commitHandler(): Promise<BoundWitness[]> {\n this.logger?.log(`this.storage.length: ${this.storage.length}`)\n const payloads = await this.next({ limit: Number.MAX_SAFE_INTEGER })\n assertEx(payloads.length > 0, () => 'Nothing to commit')\n const settled = (await Promise.allSettled(\n Object.values((await this.parentArchivists()).commit ?? [])?.map(async (parent) => {\n const queryPayload: ArchivistInsertQuery = { schema: ArchivistInsertQuerySchema }\n const query = await this.bindQuery(queryPayload, payloads)\n return (await parent?.query(query[0], query[1]))?.[0]\n }),\n )).filter(exists)\n // TODO - rather than clear, delete the payloads that come back as successfully inserted\n await this.clear()\n return (settled.filter(fulfilled).map(result => result.value)).filter(exists)\n }\n\n protected override deleteHandler(hashes: Hash[]): WithStorageMeta<Payload>[] {\n return hashes.map((hash) => {\n const payload = this.storage.get(hash) as WithStorageMeta<Payload> | undefined\n if (payload) {\n this.storage.remove(hash)\n }\n return payload\n }).filter(exists)\n }\n\n protected getFromCursor(\n order: 'asc' | 'desc' = 'asc',\n limit = 10,\n cursor?: Hex,\n open?: boolean,\n ): WithStorageMeta[] {\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const all: WithStorageMeta[] = Object.values(this.storage.getAll())\n const payloads: WithStorageMeta[] = all\n .map(value => value)\n .toSorted((item1, item2) => {\n return order === 'asc' ? PayloadBuilder.compareStorageMeta(item1, item2) : PayloadBuilder.compareStorageMeta(item2, item1)\n })\n const index = payloads.findIndex(payload => payload._sequence === cursor)\n if (index !== -1) {\n return payloads.slice(index + (open ? 1 : 0), index + (open ? 1 : 0) + limit)\n }\n return payloads.slice(0, limit)\n }\n\n protected override getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]> {\n return hashes\n .map(hash => this.storage.get(hash) as WithStorageMeta<Payload> | undefined)\n .filter(exists)\n }\n\n protected override insertHandler(payloads: WithStorageMeta<Payload>[]): WithStorageMeta<Payload>[] {\n return payloads.map((payload) => {\n const value = JSON.stringify(payload)\n // console.log('insert.storagePayloads:', storagePayload)\n assertEx(value.length < this.maxEntrySize, () => `Payload too large [${payload._hash}, ${value.length}]`)\n this.storage.set(payload._hash, payload)\n this.storage.set(payload._dataHash, payload)\n return payload\n })\n }\n\n protected override nextHandler(options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]> {\n const {\n limit, cursor, order, open = true,\n } = options ?? {}\n return this.getFromCursor(order, limit ?? 10, cursor, open)\n }\n\n protected override async startHandler(): Promise<void> {\n await super.startHandler()\n }\n}\n"],
|
|
5
|
+
"mappings": ";AAGA;AAAA,EACE;AAAA,EAAU;AAAA,EAAQ;AAAA,EAClB;AAAA,EAAc;AAAA,EAAc;AAAA,OACvB;AACP,SAAS,mBAAmB,yBAAyB;AASrD;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAKP,SAAS,UAAU,sBAAsB;AAEzC,OAAO,WAAW;AAClB,YAAY,OAAO;AAEnB,IAAM,aAAa;AAEZ,IAAM,+BAET,SAAS,wCAAwC,IAAI;AAGlD,IAAM,4BAUP,SAAO,oBAAoB;AAAA,EAC/B,YAAc,WAAW,SAAO,CAAC;AAAA,EACjC,cAAgB,WAAW,SAAO,CAAC;AAAA,EACnC,WAAa,WAAW,SAAO,CAAC;AAAA,EAChC,QAAU,UAAQ,4BAA4B;AAAA,EAC9C,MAAQ,WAAW,QAAM,CAAG,UAAQ,OAAO,GAAK,UAAQ,SAAS,GAAK,UAAQ,MAAM,CAAC,CAAC,CAAC;AACzF,CAAC;AAIM,IAAM,2BAAwF,aAAa,yBAAyB;AACpI,IAAM,2BAAwF,aAAa,2BAA2B,0BAA0B;AAChK,IAAM,2BAAwF,aAAa,2BAA2B,0BAA0B;AAUhK,IAAM,mBAAN,cAIG,kBACqB;AAAA,EAC7B,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,4BAA4B;AAAA,EACxG,OAAyB,sBAA8B;AAAA,EACvD,OAAyB,SAErB,EAAE,GAAG,MAAM,QAAQ,CAAC,iBAAiB,GAAG,OAAO;AAAA,EAE3C;AAAA,EACA;AAAA,EAER,IAAI,aAAqB;AACvB,WAAO,KAAK,QAAQ,cAAc;AAAA,EACpC;AAAA,EAEA,IAAI,eAAuB;AACzB,WAAO,KAAK,QAAQ,gBAAgB;AAAA,EACtC;AAAA,EAEA,IAAI,YAAoB;AACtB,WAAO,KAAK,QAAQ,aAAa;AAAA,EACnC;AAAA,EAEA,IAAa,UAAoB;AAC/B,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,GAAG,MAAM;AAAA,IACX;AAAA,EACF;AAAA,EAEA,IAAI,OAAqC;AACvC,WAAO,KAAK,QAAQ,QAAQ;AAAA,EAC9B;AAAA;AAAA,EAGA,IAAY,iBAA4B;AACtC,SAAK,kBAAkB,KAAK,YAAY,WAAW,KAAK,IAAI,EAAE,UAAU,GAAG,KAAK,SAAS,UAAU;AACnG,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,IAAY,UAAqB;AAC/B,SAAK,WAAW,KAAK,YAAY,WAAW,KAAK,IAAI,EAAE,UAAU,KAAK,SAAS;AAC/E,WAAO,KAAK;AAAA,EACd;AAAA,EAEmB,aAAwD;AACzE,UAAM,QAAQ,oBAAI,IAAY;AAC9B,SAAK,QAAQ,IAAI,wBAAwB,KAAK,QAAQ,MAAM,EAAE;AAE9D,UAAM,UAAgD,OAAO,QAAQ,KAAK,QAAQ,OAAO,CAAC;AAC1F,WAAO,QACJ,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM,KAAK,EACxB,OAAO,CAAC,YAAY;AACnB,UAAI,MAAM,IAAI,QAAQ,SAAS,GAAG;AAChC,eAAO;AAAA,MACT,OAAO;AACL,cAAM,IAAI,QAAQ,SAAS;AAC3B,eAAO;AAAA,MACT;AAAA,IACF,CAAC,EACA,SAAS,eAAe,kBAAkB;AAAA,EAC/C;AAAA,EAEmB,eAAqC;AACtD,SAAK,QAAQ,IAAI,wBAAwB,KAAK,QAAQ,MAAM,EAAE;AAC9D,SAAK,QAAQ,MAAM;AACnB,WAAO,KAAK,KAAK,WAAW,EAAE,KAAK,KAAK,CAAC;AAAA,EAC3C;AAAA,EAEA,MAAyB,gBAAyC;AAChE,SAAK,QAAQ,IAAI,wBAAwB,KAAK,QAAQ,MAAM,EAAE;AAC9D,UAAM,WAAW,MAAM,KAAK,KAAK,EAAE,OAAO,OAAO,iBAAiB,CAAC;AACnE,aAAS,SAAS,SAAS,GAAG,MAAM,mBAAmB;AACvD,UAAM,WAAW,MAAM,QAAQ;AAAA,MAC7B,OAAO,QAAQ,MAAM,KAAK,iBAAiB,GAAG,UAAU,CAAC,CAAC,GAAG,IAAI,OAAO,WAAW;AACjF,cAAM,eAAqC,EAAE,QAAQ,2BAA2B;AAChF,cAAM,QAAQ,MAAM,KAAK,UAAU,cAAc,QAAQ;AACzD,gBAAQ,MAAM,QAAQ,MAAM,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAAC;AAAA,MACtD,CAAC;AAAA,IACH,GAAG,OAAO,MAAM;AAEhB,UAAM,KAAK,MAAM;AACjB,WAAQ,QAAQ,OAAO,SAAS,EAAE,IAAI,YAAU,OAAO,KAAK,EAAG,OAAO,MAAM;AAAA,EAC9E;AAAA,EAEmB,cAAc,QAA4C;AAC3E,WAAO,OAAO,IAAI,CAAC,SAAS;AAC1B,YAAM,UAAU,KAAK,QAAQ,IAAI,IAAI;AACrC,UAAI,SAAS;AACX,aAAK,QAAQ,OAAO,IAAI;AAAA,MAC1B;AACA,aAAO;AAAA,IACT,CAAC,EAAE,OAAO,MAAM;AAAA,EAClB;AAAA,EAEU,cACR,QAAwB,OACxB,QAAQ,IACR,QACA,MACmB;AAEnB,UAAM,MAAyB,OAAO,OAAO,KAAK,QAAQ,OAAO,CAAC;AAClE,UAAM,WAA8B,IACjC,IAAI,WAAS,KAAK,EAClB,SAAS,CAAC,OAAO,UAAU;AAC1B,aAAO,UAAU,QAAQ,eAAe,mBAAmB,OAAO,KAAK,IAAI,eAAe,mBAAmB,OAAO,KAAK;AAAA,IAC3H,CAAC;AACH,UAAM,QAAQ,SAAS,UAAU,aAAW,QAAQ,cAAc,MAAM;AACxE,QAAI,UAAU,IAAI;AAChB,aAAO,SAAS,MAAM,SAAS,OAAO,IAAI,IAAI,SAAS,OAAO,IAAI,KAAK,KAAK;AAAA,IAC9E;AACA,WAAO,SAAS,MAAM,GAAG,KAAK;AAAA,EAChC;AAAA,EAEmB,WAAW,QAA0D;AACtF,WAAO,OACJ,IAAI,UAAQ,KAAK,QAAQ,IAAI,IAAI,CAAyC,EAC1E,OAAO,MAAM;AAAA,EAClB;AAAA,EAEmB,cAAc,UAAkE;AACjG,WAAO,SAAS,IAAI,CAAC,YAAY;AAC/B,YAAM,QAAQ,KAAK,UAAU,OAAO;AAEpC,eAAS,MAAM,SAAS,KAAK,cAAc,MAAM,sBAAsB,QAAQ,KAAK,KAAK,MAAM,MAAM,GAAG;AACxG,WAAK,QAAQ,IAAI,QAAQ,OAAO,OAAO;AACvC,WAAK,QAAQ,IAAI,QAAQ,WAAW,OAAO;AAC3C,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEmB,YAAY,SAAwE;AACrG,UAAM;AAAA,MACJ;AAAA,MAAO;AAAA,MAAQ;AAAA,MAAO,OAAO;AAAA,IAC/B,IAAI,WAAW,CAAC;AAChB,WAAO,KAAK,cAAc,OAAO,SAAS,IAAI,QAAQ,IAAI;AAAA,EAC5D;AAAA,EAEA,MAAyB,eAA8B;AACrD,UAAM,MAAM,aAAa;AAAA,EAC3B;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/archivist-storage",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "7.0.0",
|
|
4
4
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -34,29 +34,29 @@
|
|
|
34
34
|
"README.md"
|
|
35
35
|
],
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@xyo-network/archivist-
|
|
38
|
-
"@xyo-network/archivist-
|
|
39
|
-
"@xyo-network/module-model": "~
|
|
37
|
+
"@xyo-network/archivist-model": "~7.0.0",
|
|
38
|
+
"@xyo-network/archivist-abstract": "~7.0.0",
|
|
39
|
+
"@xyo-network/module-model": "~7.0.0"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"@bitauth/libauth": "~3.0.0",
|
|
43
43
|
"@metamask/providers": "^22.1.1",
|
|
44
44
|
"@noble/post-quantum": "~0.6.1",
|
|
45
45
|
"@opentelemetry/api": "^1.9.1",
|
|
46
|
-
"@opentelemetry/sdk-trace-base": "^2.
|
|
46
|
+
"@opentelemetry/sdk-trace-base": "^2.8.0",
|
|
47
47
|
"@scure/base": "~2.2.0",
|
|
48
48
|
"@scure/bip39": "~2.2.0",
|
|
49
|
-
"@xylabs/geo": "^6.1.
|
|
50
|
-
"@xylabs/sdk-js": "^6.1.
|
|
51
|
-
"@xylabs/threads": "^6.1.
|
|
49
|
+
"@xylabs/geo": "^6.1.1",
|
|
50
|
+
"@xylabs/sdk-js": "^6.1.1",
|
|
51
|
+
"@xylabs/threads": "^6.1.1",
|
|
52
52
|
"@xylabs/toolchain": "^8.1.20",
|
|
53
53
|
"@xylabs/tsconfig": "^8.1.20",
|
|
54
|
-
"@xylabs/vitest-extended": "^6.1.
|
|
55
|
-
"@xyo-network/sdk-protocol-js": "
|
|
54
|
+
"@xylabs/vitest-extended": "^6.1.1",
|
|
55
|
+
"@xyo-network/sdk-protocol-js": "~7.0",
|
|
56
56
|
"ajv": "^8.20.0",
|
|
57
57
|
"async-mutex": "^0.5.0",
|
|
58
58
|
"debug": "~4.4.3",
|
|
59
|
-
"eslint": "^10.
|
|
59
|
+
"eslint": "^10.5.0",
|
|
60
60
|
"ethers": "^6.16.0",
|
|
61
61
|
"hash-wasm": "~4.12.0",
|
|
62
62
|
"idb": "^8.0.3",
|
|
@@ -69,9 +69,9 @@
|
|
|
69
69
|
"vitest": "~4.1.8",
|
|
70
70
|
"webextension-polyfill": "^0.12.0",
|
|
71
71
|
"zod": "^4.4.3",
|
|
72
|
-
"@xyo-network/archivist-acceptance-tests": "~
|
|
73
|
-
"@xyo-network/archivist-memory": "~
|
|
74
|
-
"@xyo-network/node-memory": "~
|
|
72
|
+
"@xyo-network/archivist-acceptance-tests": "~7.0.0",
|
|
73
|
+
"@xyo-network/archivist-memory": "~7.0.0",
|
|
74
|
+
"@xyo-network/node-memory": "~7.0.0"
|
|
75
75
|
},
|
|
76
76
|
"peerDependencies": {
|
|
77
77
|
"@bitauth/libauth": "~3.0",
|
|
@@ -84,7 +84,7 @@
|
|
|
84
84
|
"@xylabs/geo": "^6.0",
|
|
85
85
|
"@xylabs/sdk-js": "^6.0",
|
|
86
86
|
"@xylabs/threads": "^6.0",
|
|
87
|
-
"@xyo-network/sdk-protocol-js": "^
|
|
87
|
+
"@xyo-network/sdk-protocol-js": "^7.0",
|
|
88
88
|
"ajv": "^8.20",
|
|
89
89
|
"async-mutex": "^0.5",
|
|
90
90
|
"debug": "~4.4",
|