npm - @xyo-network/archivist-abstract - Versions diffs - 2.73.4 → 2.74.1 - Mend

@xyo-network/archivist-abstract 2.73.4 → 2.74.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.

Files changed (16) hide show

package/dist/AbstractArchivist.d.mts +51 -0
package/dist/AbstractArchivist.d.mts.map +1 -0
package/dist/AbstractArchivist.d.ts +51 -0
package/dist/AbstractArchivist.d.ts.map +1 -0
package/dist/docs.json +7175 -8211
package/dist/index.d.mts +2 -54
package/dist/index.d.mts.map +1 -0
package/dist/index.d.ts +2 -54
package/dist/index.d.ts.map +1 -0
package/dist/index.js +0 -1
package/dist/index.js.map +1 -1
package/dist/index.mjs +0 -1
package/dist/index.mjs.map +1 -1
package/package.json +13 -19
package/src/AbstractArchivist.ts +3 -5
package/tsup.config.ts +0 -14

package/dist/AbstractArchivist.d.mts ADDED Viewed

@@ -0,0 +1,51 @@
+import { ArchivistInstance, ArchivistModuleEventData, ArchivistParams, ArchivistQueryBase } from '@xyo-network/archivist-model';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { Promisable, PromisableArray } from '@xyo-network/promise';
+export interface ActionConfig {
+    emitEvents?: boolean;
+}
+export interface InsertConfig extends ActionConfig {
+    writeToParents?: boolean;
+}
+export interface ArchivistParentInstances {
+    commit?: Record<string, ArchivistInstance>;
+    read?: Record<string, ArchivistInstance>;
+    write?: Record<string, ArchivistInstance>;
+}
+export declare abstract class AbstractArchivist<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractModuleInstance<TParams, TEventData> implements ArchivistInstance<TParams> {
+    private _lastInsertedPayload;
+    private _parents?;
+    get queries(): string[];
+    get requireAllParents(): boolean;
+    protected get _queryAccountPaths(): Record<ArchivistQueryBase['schema'], string>;
+    protected get storeParentReads(): boolean;
+    all(): PromisableArray<Payload>;
+    clear(): Promisable<void>;
+    commit(): Promisable<BoundWitness[]>;
+    delete(hashes: string[]): Promise<string[]>;
+    get(hashes: string[]): Promise<Payload[]>;
+    insert(payloads: Payload[]): Promise<Payload[]>;
+    protected allHandler(): PromisableArray<Payload>;
+    protected clearHandler(): Promisable<void>;
+    protected commitHandler(): Promisable<BoundWitness[]>;
+    protected deleteHandler(_hashes: string[]): PromisableArray<string>;
+    protected deleteWithConfig(hashes: string[], config?: ActionConfig): Promise<string[]>;
+    protected getFromParent(hashes: string[], archivist: ArchivistInstance): Promise<[Payload[], string[]]>;
+    protected getFromParents(hashes: string[]): Promise<[Payload[], string[]]>;
+    protected getHandler(_hashes: string[]): Promisable<Payload[]>;
+    protected getWithConfig(hashes: string[], config?: InsertConfig): Promise<Payload[]>;
+    protected head(): Promisable<Payload | undefined>;
+    protected insertHandler(_payloads: Payload[]): Promise<Payload[]>;
+    protected insertWithConfig(payloads: Payload[], config?: InsertConfig): Promise<Payload[]>;
+    protected parents(): Promise<ArchivistParentInstances>;
+    protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
+    protected writeToParent(parent: ArchivistInstance, payloads: Payload[]): Promise<{
+        schema: string;
+    }[]>;
+    protected writeToParents(payloads: Payload[]): Promise<Payload[]>;
+    private resolveArchivists;
+}
+//# sourceMappingURL=AbstractArchivist.d.ts.map

package/dist/AbstractArchivist.d.mts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"AbstractArchivist.d.ts","sourceRoot":"","sources":["../src/AbstractArchivist.ts"],"names":[],"mappings":"AAEA,OAAO,EAQL,iBAAiB,EACjB,wBAAwB,EACxB,eAAe,EAEf,kBAAkB,EAGnB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,iBAAiB,EAA4B,MAAM,mCAAmC,CAAA;AAC/F,OAAO,EAAE,YAAY,EAAsB,MAAM,iCAAiC,CAAA;AAElF,OAAO,EAAE,sBAAsB,EAAoB,YAAY,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AACtH,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAElE,MAAM,WAAW,YAAY;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC1C;AAED,8BAAsB,iBAAiB,CACnC,OAAO,SAAS,eAAe,GAAG,eAAe,EACjD,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CAExE,SAAQ,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAClD,YAAW,iBAAiB,CAAC,OAAO,CAAC;IAErC,OAAO,CAAC,oBAAoB,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,CAA0B;IAE3C,IAAa,OAAO,IAAI,MAAM,EAAE,CAE/B;IAED,IAAI,iBAAiB,YAEpB;IAED,cAAuB,kBAAkB,IAAI,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CASxF;IAED,SAAS,KAAK,gBAAgB,YAE7B;IAED,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC;IAQ/B,KAAK,IAAI,UAAU,CAAC,IAAI,CAAC;IAQzB,MAAM,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;IAQ9B,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQ3C,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAQzC,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAQrD,SAAS,CAAC,UAAU,IAAI,eAAe,CAAC,OAAO,CAAC;IAIhD,SAAS,CAAC,YAAY,IAAI,UAAU,CAAC,IAAI,CAAC;IAI1C,SAAS,CAAC,aAAa,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;IAIrD,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC;cAInD,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;cAY5E,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;cAqB7F,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAgBhF,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;cAI9C,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IA+B1F,SAAS,CAAC,IAAI,IAAI,UAAU,CAAC,OAAO,GAAG,SAAS,CAAC;IAIjD,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAIjD,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAgBhF,OAAO;cASE,YAAY,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,OAAO,SAAS,YAAY,GAAG,YAAY,EAChI,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,wBAAwB,CAAC;cAqDpB,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAAE,OAAO,EAAE;;;cAI5D,cAAc,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAWzD,iBAAiB;CAqBhC"}

package/dist/AbstractArchivist.d.ts ADDED Viewed

@@ -0,0 +1,51 @@
+import { ArchivistInstance, ArchivistModuleEventData, ArchivistParams, ArchivistQueryBase } from '@xyo-network/archivist-model';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { Promisable, PromisableArray } from '@xyo-network/promise';
+export interface ActionConfig {
+    emitEvents?: boolean;
+}
+export interface InsertConfig extends ActionConfig {
+    writeToParents?: boolean;
+}
+export interface ArchivistParentInstances {
+    commit?: Record<string, ArchivistInstance>;
+    read?: Record<string, ArchivistInstance>;
+    write?: Record<string, ArchivistInstance>;
+}
+export declare abstract class AbstractArchivist<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractModuleInstance<TParams, TEventData> implements ArchivistInstance<TParams> {
+    private _lastInsertedPayload;
+    private _parents?;
+    get queries(): string[];
+    get requireAllParents(): boolean;
+    protected get _queryAccountPaths(): Record<ArchivistQueryBase['schema'], string>;
+    protected get storeParentReads(): boolean;
+    all(): PromisableArray<Payload>;
+    clear(): Promisable<void>;
+    commit(): Promisable<BoundWitness[]>;
+    delete(hashes: string[]): Promise<string[]>;
+    get(hashes: string[]): Promise<Payload[]>;
+    insert(payloads: Payload[]): Promise<Payload[]>;
+    protected allHandler(): PromisableArray<Payload>;
+    protected clearHandler(): Promisable<void>;
+    protected commitHandler(): Promisable<BoundWitness[]>;
+    protected deleteHandler(_hashes: string[]): PromisableArray<string>;
+    protected deleteWithConfig(hashes: string[], config?: ActionConfig): Promise<string[]>;
+    protected getFromParent(hashes: string[], archivist: ArchivistInstance): Promise<[Payload[], string[]]>;
+    protected getFromParents(hashes: string[]): Promise<[Payload[], string[]]>;
+    protected getHandler(_hashes: string[]): Promisable<Payload[]>;
+    protected getWithConfig(hashes: string[], config?: InsertConfig): Promise<Payload[]>;
+    protected head(): Promisable<Payload | undefined>;
+    protected insertHandler(_payloads: Payload[]): Promise<Payload[]>;
+    protected insertWithConfig(payloads: Payload[], config?: InsertConfig): Promise<Payload[]>;
+    protected parents(): Promise<ArchivistParentInstances>;
+    protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
+    protected writeToParent(parent: ArchivistInstance, payloads: Payload[]): Promise<{
+        schema: string;
+    }[]>;
+    protected writeToParents(payloads: Payload[]): Promise<Payload[]>;
+    private resolveArchivists;
+}
+//# sourceMappingURL=AbstractArchivist.d.ts.map

package/dist/AbstractArchivist.d.ts.map ADDED Viewed

@@ -0,0 +1 @@