@xyo-network/archivist-model 3.8.0 → 3.8.2

package/dist/neutral/index.d.ts

@@ -1,14 +1,995 @@
-export * from './attachable/index.ts';
-export * from './Config.ts';
-export * from './EventData.ts';
-export * from './IndexDescription.ts';
-export * from './Instance.ts';
-export * from './Labels.ts';
-export * from './Module.ts';
-export * from './NextOptions.ts';
-export * from './Params.ts';
-export * from './Queries/index.ts';
-export * from './QueryFunctions.ts';
-export * from './RawQueryFunctions.ts';
-export * from './typeChecks.ts';
-//# sourceMappingURL=index.d.ts.map
+import * as _xylabs_promise from '@xylabs/promise';
+import { PromisableArray, Promisable } from '@xylabs/promise';
+import { Hex, Hash } from '@xylabs/hex';
+import * as _xylabs_object from '@xylabs/object';
+import { EmptyObject, WithAdditional, TypeCheck, IsObjectFactory } from '@xylabs/object';
+import * as _xyo_network_module_model from '@xyo-network/module-model';
+import { Module, ModuleEventArgs, ModuleEventData, ModuleQueryFunctions, ModuleConfig, ModuleIdentifier, ModuleParams, AnyConfigSchema, ModuleQueryResult, ModuleInstance, AttachableModuleInstance, Labels, ModuleQueries } from '@xyo-network/module-model';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import { Payload, WithStorageMeta, Query } from '@xyo-network/payload-model';
+import { EventData } from '@xyo-network/module-events';
+import * as _xyo_network_account_model from '@xyo-network/account-model';
+import { AccountInstance } from '@xyo-network/account-model';
+import * as _xylabs_logger from '@xylabs/logger';
+import { ObjectTypeShape } from '@xylabs/typeof';
+
+interface NextOptions<TId = Hex> {
+    cursor?: TId;
+    limit?: number;
+    open?: boolean;
+    order?: 'asc' | 'desc';
+}
+interface ArchivistNextOptions extends NextOptions<Hash> {
+}
+
+interface AllArchivistFunctions<TReadResponse> {
+    all(): PromisableArray<TReadResponse>;
+}
+interface ReadArchivistFunctions<TReadResponse, TId = string> {
+    get(ids: TId[]): PromisableArray<TReadResponse>;
+    next(options?: NextOptions<TId>): PromisableArray<TReadResponse>;
+}
+interface WriteArchivistFunctions<TReadResponse, TWriteResponse = TReadResponse, TWrite = TReadResponse, TId = string> {
+    clear(): Promisable<void>;
+    delete(ids: TId[]): PromisableArray<TId>;
+    insert(item: TWrite[]): PromisableArray<TWriteResponse>;
+}
+interface StashArchivistFunctions<TWriteResponse> {
+    commit(): PromisableArray<TWriteResponse>;
+}
+
+type ClearedEventArgs<T extends Module = Module> = ModuleEventArgs<T>;
+interface ClearedEventData<T extends Module = Module> extends EventData {
+    cleared: ClearedEventArgs<T>;
+}
+
+type DeletedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    hashes: Hash[];
+}>;
+interface DeletedEventData<T extends Module = Module> extends EventData {
+    deleted: DeletedEventArgs<T>;
+}
+
+type InsertedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    payloads: Payload[];
+}>;
+interface InsertedEventData<T extends Module = Module> extends EventData {
+    inserted: InsertedEventArgs<T>;
+}
+
+interface ArchivistModuleEventData extends InsertedEventData, DeletedEventData, ClearedEventData, ModuleEventData {
+}
+
+interface AllArchivist<TReadResponse extends Payload = Payload> extends AllArchivistFunctions<WithStorageMeta<TReadResponse>> {
+}
+interface ReadArchivist<TReadResponse extends Payload = Payload, TId = Hash> extends ReadArchivistFunctions<WithStorageMeta<TReadResponse>, TId> {
+}
+interface WriteArchivist<TReadResponse extends Payload = Payload, TWriteResponse = TReadResponse, TWrite = TReadResponse, TId = Hash> extends WriteArchivistFunctions<WithStorageMeta<TReadResponse>, TWriteResponse, TWrite, TId> {
+}
+interface StashArchivist<TWriteResponse extends Payload = Payload> extends StashArchivistFunctions<WithStorageMeta<TWriteResponse>> {
+}
+interface Archivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = Payload, TWrite extends Payload = TReadResponse & Payload, TId = Hash> extends ReadArchivist<WithStorageMeta<TReadResponse>, TId>, AllArchivist<WithStorageMeta<TReadResponse>>, WriteArchivist<WithStorageMeta<TReadResponse>, WithStorageMeta<TWriteResponse>, TWrite, TId>, StashArchivistFunctions<TWriteResponse> {
+}
+
+interface ArchivistModule<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = Payload, TWrite extends Payload = TReadResponse & Payload, TId = Hash> extends Archivist<TReadResponse, TWriteResponse, TWrite, TId>, ModuleQueryFunctions {
+}
+
+type IndexDirection = -1 | 1;
+type IndexDescription = {
+    key: Record<string, IndexDirection>;
+    multiEntry?: boolean;
+    name?: string;
+    unique?: boolean;
+};
+declare const IndexSeparator = "-";
+declare const buildStandardIndexName: (index: IndexDescription) => string;
+
+interface ArchivistParents {
+    commit?: ModuleIdentifier[];
+    read?: ModuleIdentifier[];
+    write?: ModuleIdentifier[];
+}
+interface ArchivistStorage {
+    indexes?: IndexDescription[];
+}
+declare const ArchivistConfigSchema: "network.xyo.archivist.config";
+type ArchivistConfigSchema = typeof ArchivistConfigSchema;
+type ArchivistConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = ModuleConfig<WithAdditional<{
+    parents?: ArchivistParents;
+    requireAllParents?: boolean;
+    schema: TConfig extends Payload ? TConfig['schema'] : ArchivistConfigSchema;
+    storage?: ArchivistStorage;
+    storeParentReads?: boolean;
+}, TConfig>, TSchema>;
+
+interface ArchivistModuleInstance<TParams extends ModuleParams<AnyConfigSchema<ArchivistConfig>> = ModuleParams<AnyConfigSchema<ArchivistConfig>>, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends Module<TParams, TEventData> {
+}
+
+type ArchivistParams<TConfig extends AnyConfigSchema<ArchivistConfig> = AnyConfigSchema<ArchivistConfig>, TAdditionalParams extends EmptyObject | undefined = undefined> = ModuleParams<TConfig, TAdditionalParams>;
+
+interface ArchivistRawQueryFunctions {
+    allQuery(account?: AccountInstance): Promisable<ModuleQueryResult>;
+    clearQuery(account?: AccountInstance): Promisable<ModuleQueryResult>;
+    commitQuery(account?: AccountInstance): Promisable<ModuleQueryResult>;
+    deleteQuery(hashes: Hash[], account?: AccountInstance): Promisable<ModuleQueryResult>;
+    getQuery(hashes: Hash[], account?: AccountInstance): Promisable<ModuleQueryResult>;
+    insertQuery(payloads: Payload[], account?: AccountInstance): Promisable<ModuleQueryResult>;
+    nextQuery(options?: ArchivistNextOptions, account?: AccountInstance): Promisable<ModuleQueryResult>;
+}
+
+interface ArchivistInstance<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData, TPayload extends Payload = Payload> extends ArchivistModuleInstance<TParams, TEventData>, ArchivistModule<TPayload, TPayload>, ModuleInstance<TParams, TEventData>, ArchivistRawQueryFunctions {
+}
+
+interface AttachableArchivistInstance<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData, TPayload extends Payload = Payload> extends ArchivistModuleInstance<TParams, TEventData>, AttachableModuleInstance<TParams, TEventData>, ArchivistInstance<TParams, TEventData, TPayload> {
+}
+type AttachableArchivistInstanceTypeCheck<T extends AttachableArchivistInstance = AttachableArchivistInstance> = TypeCheck<T>;
+declare class IsAttachableArchivistInstanceFactory<T extends AttachableArchivistInstance = AttachableArchivistInstance> extends IsObjectFactory<T> {
+}
+
+declare const asAttachableArchivistInstance: {
+    <TType extends AttachableArchivistInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xylabs_object.DeepRestrictToStringKeys<{
+            schema: _xyo_network_payload_model.Schema;
+            parents?: {
+                commit?: string[] | undefined;
+                read?: string[] | undefined;
+                write?: string[] | undefined;
+            } | undefined;
+            requireAllParents?: boolean | undefined;
+            storage?: {
+                indexes?: {
+                    key: {
+                        [x: string]: IndexDirection;
+                    };
+                    multiEntry?: boolean | undefined;
+                    name?: string | undefined;
+                    unique?: boolean | undefined;
+                }[] | undefined;
+            } | undefined;
+            storeParentReads?: boolean | undefined;
+            readonly archiving?: {
+                readonly archivists?: string[] | undefined;
+                readonly queries?: string[] | undefined;
+            } | undefined;
+            readonly allowedQueries?: string[] | undefined;
+            readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+            readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+            readonly labels?: {
+                [x: string]: string | undefined;
+            } | undefined;
+            readonly name?: _xyo_network_module_model.ModuleName | undefined;
+            readonly paging?: {
+                [x: string]: {
+                    size?: number | undefined;
+                };
+            } | undefined;
+            readonly retry?: {
+                backoff?: number | undefined;
+                interval?: number | undefined;
+                retries?: number | undefined;
+            } | undefined;
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: {
+                    [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+                } | undefined;
+                readonly disallowed?: {
+                    [x: string]: Lowercase<string>[];
+                } | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        }>;
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, ArchivistModuleEventData, _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+    }>>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
+    <TType extends AttachableArchivistInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xylabs_object.DeepRestrictToStringKeys<{
+            schema: _xyo_network_payload_model.Schema;
+            parents?: {
+                commit?: string[] | undefined;
+                read?: string[] | undefined;
+                write?: string[] | undefined;
+            } | undefined;
+            requireAllParents?: boolean | undefined;
+            storage?: {
+                indexes?: {
+                    key: {
+                        [x: string]: IndexDirection;
+                    };
+                    multiEntry?: boolean | undefined;
+                    name?: string | undefined;
+                    unique?: boolean | undefined;
+                }[] | undefined;
+            } | undefined;
+            storeParentReads?: boolean | undefined;
+            readonly archiving?: {
+                readonly archivists?: string[] | undefined;
+                readonly queries?: string[] | undefined;
+            } | undefined;
+            readonly allowedQueries?: string[] | undefined;
+            readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+            readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+            readonly labels?: {
+                [x: string]: string | undefined;
+            } | undefined;
+            readonly name?: _xyo_network_module_model.ModuleName | undefined;
+            readonly paging?: {
+                [x: string]: {
+                    size?: number | undefined;
+                };
+            } | undefined;
+            readonly retry?: {
+                backoff?: number | undefined;
+                interval?: number | undefined;
+                retries?: number | undefined;
+            } | undefined;
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: {
+                    [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+                } | undefined;
+                readonly disallowed?: {
+                    [x: string]: Lowercase<string>[];
+                } | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        }>;
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, ArchivistModuleEventData, _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+    }>>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<AttachableArchivistInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xylabs_object.DeepRestrictToStringKeys<{
+            schema: _xyo_network_payload_model.Schema;
+            parents?: {
+                commit?: string[] | undefined;
+                read?: string[] | undefined;
+                write?: string[] | undefined;
+            } | undefined;
+            requireAllParents?: boolean | undefined;
+            storage?: {
+                indexes?: {
+                    key: {
+                        [x: string]: IndexDirection;
+                    };
+                    multiEntry?: boolean | undefined;
+                    name?: string | undefined;
+                    unique?: boolean | undefined;
+                }[] | undefined;
+            } | undefined;
+            storeParentReads?: boolean | undefined;
+            readonly archiving?: {
+                readonly archivists?: string[] | undefined;
+                readonly queries?: string[] | undefined;
+            } | undefined;
+            readonly allowedQueries?: string[] | undefined;
+            readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+            readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+            readonly labels?: {
+                [x: string]: string | undefined;
+            } | undefined;
+            readonly name?: _xyo_network_module_model.ModuleName | undefined;
+            readonly paging?: {
+                [x: string]: {
+                    size?: number | undefined;
+                };
+            } | undefined;
+            readonly retry?: {
+                backoff?: number | undefined;
+                interval?: number | undefined;
+                retries?: number | undefined;
+            } | undefined;
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: {
+                    [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+                } | undefined;
+                readonly disallowed?: {
+                    [x: string]: Lowercase<string>[];
+                } | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        }>;
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, ArchivistModuleEventData, _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+    }>>>, config?: _xylabs_object.TypeCheckConfig): TType;
+};
+
+declare const requiredAttachableArchivistInstanceFunctions: ObjectTypeShape;
+declare const isAttachableArchivistInstance: TypeCheck<AttachableArchivistInstance>;
+
+interface ArchivistLabels extends Labels {
+    'network.xyo.archivist.persistence.scope': 'memory' | 'thread' | 'process' | 'device' | 'network';
+}
+
+declare const ArchivistAllQuerySchema: "network.xyo.query.archivist.all";
+type ArchivistAllQuerySchema = typeof ArchivistAllQuerySchema;
+type ArchivistAllQuery = Query<{
+    schema: ArchivistAllQuerySchema;
+}>;
+
+declare const ArchivistClearQuerySchema: "network.xyo.query.archivist.clear";
+type ArchivistClearQuerySchema = typeof ArchivistClearQuerySchema;
+type ArchivistClearQuery = Query<{
+    schema: ArchivistClearQuerySchema;
+}>;
+
+declare const ArchivistCommitQuerySchema: "network.xyo.query.archivist.commit";
+type ArchivistCommitQuerySchema = typeof ArchivistCommitQuerySchema;
+type ArchivistCommitQuery = Query<{
+    schema: ArchivistCommitQuerySchema;
+}>;
+
+declare const ArchivistDeleteQuerySchema: "network.xyo.query.archivist.delete";
+type ArchivistDeleteQuerySchema = typeof ArchivistDeleteQuerySchema;
+type ArchivistDeleteQuery = Query<{
+    hashes: Hash[];
+    schema: ArchivistDeleteQuerySchema;
+}>;
+
+declare const ArchivistGetQuerySchema: "network.xyo.query.archivist.get";
+type ArchivistGetQuerySchema = typeof ArchivistGetQuerySchema;
+type ArchivistGetQuery = Query<{
+    hashes: Hash[];
+    schema: ArchivistGetQuerySchema;
+}>;
+
+declare const ArchivistInsertQuerySchema: "network.xyo.query.archivist.insert";
+type ArchivistInsertQuerySchema = typeof ArchivistInsertQuerySchema;
+type ArchivistInsertQuery = Query<{
+    schema: ArchivistInsertQuerySchema;
+}>;
+
+declare const ArchivistNextQuerySchema: "network.xyo.query.archivist.next";
+type ArchivistNextQuerySchema = typeof ArchivistNextQuerySchema;
+type ArchivistNextQuery = Query<ArchivistNextOptions, ArchivistNextQuerySchema>;
+
+type ArchivistQueries = ArchivistAllQuery | ArchivistClearQuery | ArchivistCommitQuery | ArchivistDeleteQuery | ArchivistGetQuery | ArchivistInsertQuery | ArchivistNextQuery;
+type ArchivistModuleQueries = ModuleQueries | ArchivistQueries;
+
+declare const isArchivistInstance: _xylabs_object.TypeCheck<ArchivistInstance<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+        parents?: {
+            commit?: string[] | undefined;
+            read?: string[] | undefined;
+            write?: string[] | undefined;
+        } | undefined;
+        requireAllParents?: boolean | undefined;
+        storage?: {
+            indexes?: {
+                key: {
+                    [x: string]: IndexDirection;
+                };
+                multiEntry?: boolean | undefined;
+                name?: string | undefined;
+                unique?: boolean | undefined;
+            }[] | undefined;
+        } | undefined;
+        storeParentReads?: boolean | undefined;
+        readonly archiving?: {
+            readonly archivists?: string[] | undefined;
+            readonly queries?: string[] | undefined;
+        } | undefined;
+        readonly allowedQueries?: string[] | undefined;
+        readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+        readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+        readonly labels?: {
+            [x: string]: string | undefined;
+        } | undefined;
+        readonly name?: _xyo_network_module_model.ModuleName | undefined;
+        readonly paging?: {
+            [x: string]: {
+                size?: number | undefined;
+            };
+        } | undefined;
+        readonly retry?: {
+            backoff?: number | undefined;
+            interval?: number | undefined;
+            retries?: number | undefined;
+        } | undefined;
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: {
+                [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+            } | undefined;
+            readonly disallowed?: {
+                [x: string]: Lowercase<string>[];
+            } | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    }>;
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, ArchivistModuleEventData, _xylabs_object.DeepRestrictToStringKeys<{
+    schema: _xyo_network_payload_model.Schema;
+}>>>;
+declare const isArchivistModule: _xyo_network_module_model.ModuleTypeCheck<ArchivistModuleInstance<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+        parents?: {
+            commit?: string[] | undefined;
+            read?: string[] | undefined;
+            write?: string[] | undefined;
+        } | undefined;
+        requireAllParents?: boolean | undefined;
+        storage?: {
+            indexes?: {
+                key: {
+                    [x: string]: IndexDirection;
+                };
+                multiEntry?: boolean | undefined;
+                name?: string | undefined;
+                unique?: boolean | undefined;
+            }[] | undefined;
+        } | undefined;
+        storeParentReads?: boolean | undefined;
+        readonly archiving?: {
+            readonly archivists?: string[] | undefined;
+            readonly queries?: string[] | undefined;
+        } | undefined;
+        readonly allowedQueries?: string[] | undefined;
+        readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+        readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+        readonly labels?: {
+            [x: string]: string | undefined;
+        } | undefined;
+        readonly name?: _xyo_network_module_model.ModuleName | undefined;
+        readonly paging?: {
+            [x: string]: {
+                size?: number | undefined;
+            };
+        } | undefined;
+        readonly retry?: {
+            backoff?: number | undefined;
+            interval?: number | undefined;
+            retries?: number | undefined;
+        } | undefined;
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: {
+                [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+            } | undefined;
+            readonly disallowed?: {
+                [x: string]: Lowercase<string>[];
+            } | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    }>;
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, ArchivistModuleEventData>>;
+declare const asArchivistModule: {
+    <TType extends ArchivistModuleInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xylabs_object.DeepRestrictToStringKeys<{
+            schema: _xyo_network_payload_model.Schema;
+            parents?: {
+                commit?: string[] | undefined;
+                read?: string[] | undefined;
+                write?: string[] | undefined;
+            } | undefined;
+            requireAllParents?: boolean | undefined;
+            storage?: {
+                indexes?: {
+                    key: {
+                        [x: string]: IndexDirection;
+                    };
+                    multiEntry?: boolean | undefined;
+                    name?: string | undefined;
+                    unique?: boolean | undefined;
+                }[] | undefined;
+            } | undefined;
+            storeParentReads?: boolean | undefined;
+            readonly archiving?: {
+                readonly archivists?: string[] | undefined;
+                readonly queries?: string[] | undefined;
+            } | undefined;
+            readonly allowedQueries?: string[] | undefined;
+            readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+            readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+            readonly labels?: {
+                [x: string]: string | undefined;
+            } | undefined;
+            readonly name?: _xyo_network_module_model.ModuleName | undefined;
+            readonly paging?: {
+                [x: string]: {
+                    size?: number | undefined;
+                };
+            } | undefined;
+            readonly retry?: {
+                backoff?: number | undefined;
+                interval?: number | undefined;
+                retries?: number | undefined;
+            } | undefined;
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: {
+                    [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+                } | undefined;
+                readonly disallowed?: {
+                    [x: string]: Lowercase<string>[];
+                } | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        }>;
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, ArchivistModuleEventData>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
+    <TType extends ArchivistModuleInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xylabs_object.DeepRestrictToStringKeys<{
+            schema: _xyo_network_payload_model.Schema;
+            parents?: {
+                commit?: string[] | undefined;
+                read?: string[] | undefined;
+                write?: string[] | undefined;
+            } | undefined;
+            requireAllParents?: boolean | undefined;
+            storage?: {
+                indexes?: {
+                    key: {
+                        [x: string]: IndexDirection;
+                    };
+                    multiEntry?: boolean | undefined;
+                    name?: string | undefined;
+                    unique?: boolean | undefined;
+                }[] | undefined;
+            } | undefined;
+            storeParentReads?: boolean | undefined;
+            readonly archiving?: {
+                readonly archivists?: string[] | undefined;
+                readonly queries?: string[] | undefined;
+            } | undefined;
+            readonly allowedQueries?: string[] | undefined;
+            readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+            readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+            readonly labels?: {
+                [x: string]: string | undefined;
+            } | undefined;
+            readonly name?: _xyo_network_module_model.ModuleName | undefined;
+            readonly paging?: {
+                [x: string]: {
+                    size?: number | undefined;
+                };
+            } | undefined;
+            readonly retry?: {
+                backoff?: number | undefined;
+                interval?: number | undefined;
+                retries?: number | undefined;
+            } | undefined;
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: {
+                    [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+                } | undefined;
+                readonly disallowed?: {
+                    [x: string]: Lowercase<string>[];
+                } | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        }>;
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, ArchivistModuleEventData>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<ArchivistModuleInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xylabs_object.DeepRestrictToStringKeys<{
+            schema: _xyo_network_payload_model.Schema;
+            parents?: {
+                commit?: string[] | undefined;
+                read?: string[] | undefined;
+                write?: string[] | undefined;
+            } | undefined;
+            requireAllParents?: boolean | undefined;
+            storage?: {
+                indexes?: {
+                    key: {
+                        [x: string]: IndexDirection;
+                    };
+                    multiEntry?: boolean | undefined;
+                    name?: string | undefined;
+                    unique?: boolean | undefined;
+                }[] | undefined;
+            } | undefined;
+            storeParentReads?: boolean | undefined;
+            readonly archiving?: {
+                readonly archivists?: string[] | undefined;
+                readonly queries?: string[] | undefined;
+            } | undefined;
+            readonly allowedQueries?: string[] | undefined;
+            readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+            readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+            readonly labels?: {
+                [x: string]: string | undefined;
+            } | undefined;
+            readonly name?: _xyo_network_module_model.ModuleName | undefined;
+            readonly paging?: {
+                [x: string]: {
+                    size?: number | undefined;
+                };
+            } | undefined;
+            readonly retry?: {
+                backoff?: number | undefined;
+                interval?: number | undefined;
+                retries?: number | undefined;
+            } | undefined;
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: {
+                    [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+                } | undefined;
+                readonly disallowed?: {
+                    [x: string]: Lowercase<string>[];
+                } | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        }>;
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, ArchivistModuleEventData>>, config?: _xylabs_object.TypeCheckConfig): TType;
+};
+declare const asArchivistInstance: {
+    <TType extends ArchivistInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xylabs_object.DeepRestrictToStringKeys<{
+            schema: _xyo_network_payload_model.Schema;
+            parents?: {
+                commit?: string[] | undefined;
+                read?: string[] | undefined;
+                write?: string[] | undefined;
+            } | undefined;
+            requireAllParents?: boolean | undefined;
+            storage?: {
+                indexes?: {
+                    key: {
+                        [x: string]: IndexDirection;
+                    };
+                    multiEntry?: boolean | undefined;
+                    name?: string | undefined;
+                    unique?: boolean | undefined;
+                }[] | undefined;
+            } | undefined;
+            storeParentReads?: boolean | undefined;
+            readonly archiving?: {
+                readonly archivists?: string[] | undefined;
+                readonly queries?: string[] | undefined;
+            } | undefined;
+            readonly allowedQueries?: string[] | undefined;
+            readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+            readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+            readonly labels?: {
+                [x: string]: string | undefined;
+            } | undefined;
+            readonly name?: _xyo_network_module_model.ModuleName | undefined;
+            readonly paging?: {
+                [x: string]: {
+                    size?: number | undefined;
+                };
+            } | undefined;
+            readonly retry?: {
+                backoff?: number | undefined;
+                interval?: number | undefined;
+                retries?: number | undefined;
+            } | undefined;
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: {
+                    [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+                } | undefined;
+                readonly disallowed?: {
+                    [x: string]: Lowercase<string>[];
+                } | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        }>;
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, ArchivistModuleEventData, _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+    }>>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
+    <TType extends ArchivistInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xylabs_object.DeepRestrictToStringKeys<{
+            schema: _xyo_network_payload_model.Schema;
+            parents?: {
+                commit?: string[] | undefined;
+                read?: string[] | undefined;
+                write?: string[] | undefined;
+            } | undefined;
+            requireAllParents?: boolean | undefined;
+            storage?: {
+                indexes?: {
+                    key: {
+                        [x: string]: IndexDirection;
+                    };
+                    multiEntry?: boolean | undefined;
+                    name?: string | undefined;
+                    unique?: boolean | undefined;
+                }[] | undefined;
+            } | undefined;
+            storeParentReads?: boolean | undefined;
+            readonly archiving?: {
+                readonly archivists?: string[] | undefined;
+                readonly queries?: string[] | undefined;
+            } | undefined;
+            readonly allowedQueries?: string[] | undefined;
+            readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+            readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+            readonly labels?: {
+                [x: string]: string | undefined;
+            } | undefined;
+            readonly name?: _xyo_network_module_model.ModuleName | undefined;
+            readonly paging?: {
+                [x: string]: {
+                    size?: number | undefined;
+                };
+            } | undefined;
+            readonly retry?: {
+                backoff?: number | undefined;
+                interval?: number | undefined;
+                retries?: number | undefined;
+            } | undefined;
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: {
+                    [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+                } | undefined;
+                readonly disallowed?: {
+                    [x: string]: Lowercase<string>[];
+                } | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        }>;
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, ArchivistModuleEventData, _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+    }>>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<ArchivistInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xylabs_object.DeepRestrictToStringKeys<{
+            schema: _xyo_network_payload_model.Schema;
+            parents?: {
+                commit?: string[] | undefined;
+                read?: string[] | undefined;
+                write?: string[] | undefined;
+            } | undefined;
+            requireAllParents?: boolean | undefined;
+            storage?: {
+                indexes?: {
+                    key: {
+                        [x: string]: IndexDirection;
+                    };
+                    multiEntry?: boolean | undefined;
+                    name?: string | undefined;
+                    unique?: boolean | undefined;
+                }[] | undefined;
+            } | undefined;
+            storeParentReads?: boolean | undefined;
+            readonly archiving?: {
+                readonly archivists?: string[] | undefined;
+                readonly queries?: string[] | undefined;
+            } | undefined;
+            readonly allowedQueries?: string[] | undefined;
+            readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+            readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+            readonly labels?: {
+                [x: string]: string | undefined;
+            } | undefined;
+            readonly name?: _xyo_network_module_model.ModuleName | undefined;
+            readonly paging?: {
+                [x: string]: {
+                    size?: number | undefined;
+                };
+            } | undefined;
+            readonly retry?: {
+                backoff?: number | undefined;
+                interval?: number | undefined;
+                retries?: number | undefined;
+            } | undefined;
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: {
+                    [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+                } | undefined;
+                readonly disallowed?: {
+                    [x: string]: Lowercase<string>[];
+                } | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        }>;
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, ArchivistModuleEventData, _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+    }>>>, config?: _xylabs_object.TypeCheckConfig): TType;
+};
+declare const withArchivistModule: <R>(mod: any, closure: (mod: ArchivistModuleInstance<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+        parents?: {
+            commit?: string[] | undefined;
+            read?: string[] | undefined;
+            write?: string[] | undefined;
+        } | undefined;
+        requireAllParents?: boolean | undefined;
+        storage?: {
+            indexes?: {
+                key: {
+                    [x: string]: IndexDirection;
+                };
+                multiEntry?: boolean | undefined;
+                name?: string | undefined;
+                unique?: boolean | undefined;
+            }[] | undefined;
+        } | undefined;
+        storeParentReads?: boolean | undefined;
+        readonly archiving?: {
+            readonly archivists?: string[] | undefined;
+            readonly queries?: string[] | undefined;
+        } | undefined;
+        readonly allowedQueries?: string[] | undefined;
+        readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+        readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+        readonly labels?: {
+            [x: string]: string | undefined;
+        } | undefined;
+        readonly name?: _xyo_network_module_model.ModuleName | undefined;
+        readonly paging?: {
+            [x: string]: {
+                size?: number | undefined;
+            };
+        } | undefined;
+        readonly retry?: {
+            backoff?: number | undefined;
+            interval?: number | undefined;
+            retries?: number | undefined;
+        } | undefined;
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: {
+                [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+            } | undefined;
+            readonly disallowed?: {
+                [x: string]: Lowercase<string>[];
+            } | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    }>;
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, ArchivistModuleEventData>) => R) => R | undefined;
+declare const withArchivistInstance: <R>(mod: any, closure: (mod: ArchivistInstance<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xylabs_object.DeepRestrictToStringKeys<{
+        schema: _xyo_network_payload_model.Schema;
+        parents?: {
+            commit?: string[] | undefined;
+            read?: string[] | undefined;
+            write?: string[] | undefined;
+        } | undefined;
+        requireAllParents?: boolean | undefined;
+        storage?: {
+            indexes?: {
+                key: {
+                    [x: string]: IndexDirection;
+                };
+                multiEntry?: boolean | undefined;
+                name?: string | undefined;
+                unique?: boolean | undefined;
+            }[] | undefined;
+        } | undefined;
+        storeParentReads?: boolean | undefined;
+        readonly archiving?: {
+            readonly archivists?: string[] | undefined;
+            readonly queries?: string[] | undefined;
+        } | undefined;
+        readonly allowedQueries?: string[] | undefined;
+        readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
+        readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
+        readonly labels?: {
+            [x: string]: string | undefined;
+        } | undefined;
+        readonly name?: _xyo_network_module_model.ModuleName | undefined;
+        readonly paging?: {
+            [x: string]: {
+                size?: number | undefined;
+            };
+        } | undefined;
+        readonly retry?: {
+            backoff?: number | undefined;
+            interval?: number | undefined;
+            retries?: number | undefined;
+        } | undefined;
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: {
+                [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+            } | undefined;
+            readonly disallowed?: {
+                [x: string]: Lowercase<string>[];
+            } | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    }>;
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, ArchivistModuleEventData, _xylabs_object.DeepRestrictToStringKeys<{
+    schema: _xyo_network_payload_model.Schema;
+}>>) => R) => R | undefined;
+
+export { type AllArchivist, type AllArchivistFunctions, type Archivist, type ArchivistAllQuery, ArchivistAllQuerySchema, type ArchivistClearQuery, ArchivistClearQuerySchema, type ArchivistCommitQuery, ArchivistCommitQuerySchema, type ArchivistConfig, ArchivistConfigSchema, type ArchivistDeleteQuery, ArchivistDeleteQuerySchema, type ArchivistGetQuery, ArchivistGetQuerySchema, type ArchivistInsertQuery, ArchivistInsertQuerySchema, type ArchivistInstance, type ArchivistLabels, type ArchivistModuleEventData, type ArchivistModuleInstance, type ArchivistModuleQueries, type ArchivistNextOptions, type ArchivistNextQuery, ArchivistNextQuerySchema, type ArchivistParams, type ArchivistParents, type ArchivistQueries, type ArchivistRawQueryFunctions, type ArchivistStorage, type AttachableArchivistInstance, type AttachableArchivistInstanceTypeCheck, type IndexDescription, type IndexDirection, IndexSeparator, IsAttachableArchivistInstanceFactory, type NextOptions, type ReadArchivist, type ReadArchivistFunctions, type StashArchivist, type StashArchivistFunctions, type WriteArchivist, type WriteArchivistFunctions, asArchivistInstance, asArchivistModule, asAttachableArchivistInstance, buildStandardIndexName, isArchivistInstance, isArchivistModule, isAttachableArchivistInstance, requiredAttachableArchivistInstanceFunctions, withArchivistInstance, withArchivistModule };