@xyo-network/archivist-abstract 4.0.2 → 4.1.0

package/dist/neutral/index.d.ts

@@ -0,0 +1,92 @@
+import * as _opentelemetry_api from '@opentelemetry/api';
+import { Gauge, Meter } from '@opentelemetry/api';
+import { Hash } from '@xylabs/hex';
+import { PromisableArray, Promisable } from '@xylabs/promise';
+import { AccountInstance } from '@xyo-network/account-model';
+import { ArchivistParams, ArchivistModuleEventData, AttachableArchivistInstance, ArchivistNextOptions, ArchivistSnapshotPayload, ArchivistStatsPayload, ReadArchivist, ArchivistInstance } from '@xyo-network/archivist-model';
+import { BoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model';
+import { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper';
+import { AbstractModuleInstance } from '@xyo-network/module-abstract';
+import { ModuleQueryResult, ModuleIdentifier, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module-model';
+import { Payload, Schema, WithStorageMeta } from '@xyo-network/payload-model';
+
+interface ActionConfig {
+    emitEvents?: boolean;
+}
+interface InsertConfig extends ActionConfig {
+    writeToParents?: boolean;
+}
+interface ArchivistParentInstanceMap {
+    commit?: Partial<Record<ModuleIdentifier, ArchivistInstance>>;
+    read?: Partial<Record<ModuleIdentifier, ArchivistInstance>>;
+    write?: Partial<Record<ModuleIdentifier, ArchivistInstance>>;
+}
+declare abstract class AbstractArchivist<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractModuleInstance<TParams, TEventData> implements AttachableArchivistInstance<TParams, TEventData, Payload> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    static readonly labels: {
+        "network.xyo.storage.class": string;
+    };
+    static readonly uniqueName: string;
+    protected static defaultNextLimitSetting: number;
+    private _getCache?;
+    private _parentArchivists?;
+    private _payloadCountGauge?;
+    private _payloadCountMeter?;
+    static get defaultNextLimit(): number;
+    get queries(): string[];
+    get requireAllParents(): boolean;
+    protected get payloadCountGauge(): Gauge<_opentelemetry_api.Attributes> | null | undefined;
+    protected get payloadCountMeter(): Meter | null;
+    protected get storeParentReads(): boolean;
+    /** deprecated use next or snapshot instead */
+    all(): Promise<WithStorageMeta<Payload>[]>;
+    /** deprecated use nextQuery or snapshotQuery instead */
+    allQuery(account: AccountInstance): Promise<ModuleQueryResult>;
+    clear(): Promise<void>;
+    clearQuery(account: AccountInstance): Promise<ModuleQueryResult>;
+    commit(): Promise<BoundWitness[]>;
+    commitQuery(account: AccountInstance): Promise<ModuleQueryResult>;
+    delete(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]>;
+    deleteQuery(hashes: Hash[], account?: AccountInstance): Promise<ModuleQueryResult>;
+    get(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]>;
+    getQuery(hashes: Hash[], account?: AccountInstance): Promise<ModuleQueryResult>;
+    insert(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]>;
+    insertQuery(payloads: Payload[], account?: AccountInstance): Promise<ModuleQueryResult>;
+    next(options?: ArchivistNextOptions): Promise<WithStorageMeta<Payload>[]>;
+    nextQuery(options?: ArchivistNextOptions, account?: AccountInstance): Promise<ModuleQueryResult>;
+    snapshot(): Promise<ArchivistSnapshotPayload<WithStorageMeta<Payload>, Hash>[]>;
+    snapshotQuery(account?: AccountInstance): Promise<ModuleQueryResult>;
+    protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;
+    protected clearHandler(): Promisable<void>;
+    protected commitHandler(): Promisable<BoundWitness[]>;
+    protected deleteHandler(_hashes: Hash[]): PromisableArray<WithStorageMeta<Payload>>;
+    protected deleteWithConfig(hashes: Hash[], config?: ActionConfig): Promise<WithStorageMeta<Payload>[]>;
+    protected generateStats(): Promisable<ArchivistStatsPayload>;
+    protected getFromParent(hashes: Hash[], archivist: ReadArchivist): Promise<[WithStorageMeta<Payload>[], Hash[]]>;
+    protected getFromParents(hashes: Hash[]): Promise<[WithStorageMeta<Payload>[], Hash[]]>;
+    protected getHandler(_hashes: Hash[]): Promisable<WithStorageMeta<Payload>[]>;
+    protected getWithConfig(hashes: Hash[], _config?: InsertConfig): Promise<WithStorageMeta<Payload>[]>;
+    protected insertHandler(_payloads: WithStorageMeta<Payload>[]): Promisable<WithStorageMeta<Payload>[]>;
+    protected insertQueryHandler<T extends QueryBoundWitnessWrapper = QueryBoundWitnessWrapper>(query: T, payloads?: Payload[]): Promise<WithStorageMeta<Payload>[]>;
+    protected insertWithConfig(payloads: Payload[], config?: InsertConfig): Promise<WithStorageMeta<Payload>[]>;
+    protected nextHandler(_options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]>;
+    protected nextWithConfig(options?: ArchivistNextOptions, _config?: InsertConfig): Promise<WithStorageMeta<Payload>[]>;
+    protected parentArchivists(): Promise<ArchivistParentInstanceMap>;
+    protected payloadCountHandler(): number;
+    protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
+    protected reportPayloadCount(): void;
+    protected snapshotHandler(): PromisableArray<ArchivistSnapshotPayload<WithStorageMeta<Payload>, Hash>>;
+    protected startHandler(): Promise<void>;
+    protected stateHandler(): Promise<Payload[]>;
+    protected writeToParent(parent: ArchivistInstance, payloads: Payload[]): Promise<Payload[]>;
+    protected writeToParents(payloads: Payload[]): Promise<Payload[]>;
+    private omitClientMetaForDataHashes;
+    private resolveArchivists;
+}
+
+declare const StorageClassLabel = "network.xyo.storage.class";
+type StorageClassLabelValue = 'memory' | 'disk' | 'network' | 'proxy' | 'unknown';
+
+export { AbstractArchivist, StorageClassLabel };
+export type { ActionConfig, InsertConfig, StorageClassLabelValue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-abstract",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,36 +21,36 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@xylabs/assert": "^4.12.33",
-    "@xylabs/base": "^4.12.33",
-    "@xylabs/exists": "^4.12.33",
-    "@xylabs/hex": "^4.12.33",
-    "@xylabs/promise": "^4.12.33",
-    "@xylabs/set": "^4.12.33",
-    "@xylabs/telemetry": "^4.12.33",
-    "@xylabs/typeof": "^4.12.33",
-    "@xyo-network/account-model": "^4.0.2",
-    "@xyo-network/archivist-model": "^4.0.2",
-    "@xyo-network/boundwitness-model": "^4.0.2",
-    "@xyo-network/boundwitness-wrapper": "^4.0.2",
-    "@xyo-network/module-abstract": "^4.0.2",
-    "@xyo-network/module-model": "^4.0.2",
-    "@xyo-network/payload-builder": "^4.0.2",
-    "@xyo-network/payload-model": "^4.0.2",
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/base": "^4.13.15",
+    "@xylabs/exists": "^4.13.15",
+    "@xylabs/hex": "^4.13.15",
+    "@xylabs/promise": "^4.13.15",
+    "@xylabs/set": "^4.13.15",
+    "@xylabs/telemetry": "^4.13.15",
+    "@xylabs/typeof": "^4.13.15",
+    "@xyo-network/account-model": "^4.1.0",
+    "@xyo-network/archivist-model": "^4.1.0",
+    "@xyo-network/boundwitness-model": "^4.1.0",
+    "@xyo-network/boundwitness-wrapper": "^4.1.0",
+    "@xyo-network/module-abstract": "^4.1.0",
+    "@xyo-network/module-model": "^4.1.0",
+    "@xyo-network/payload-builder": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0",
     "lru-cache": "^11.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
-    "@xylabs/tsconfig": "^6.5.12",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
     "typescript": "^5.8.3"
   },
   "publishConfig": {