@xyo-network/archivist-model 3.0.7 → 3.0.8

package/dist/neutral/index.d.ts

@@ -1,436 +1,14 @@
-import * as _xylabs_promise from '@xylabs/promise';
-import { PromisableArray, Promisable } from '@xylabs/promise';
-import * as _xylabs_object from '@xylabs/object';
-import { EmptyObject, WithAdditional, TypeCheck, IsObjectFactory, ObjectTypeShape } from '@xylabs/object';
-import * as _xyo_network_module_model from '@xyo-network/module-model';
-import { Module, ModuleEventArgs, ModuleEventData, ModuleConfig, ModuleParams, AnyConfigSchema, ModuleQueryFunctions, ModuleQueryResult, ModuleInstance, AttachableModuleInstance, Labels, ModuleQueries } from '@xyo-network/module-model';
-import * as _xyo_network_payload_model from '@xyo-network/payload-model';
-import { WithMeta, Payload, Query } from '@xyo-network/payload-model';
-import { EventData } from '@xyo-network/module-events';
-import { Hash, Address } from '@xylabs/hex';
-import * as _xyo_network_account_model from '@xyo-network/account-model';
-import { AccountInstance } from '@xyo-network/account-model';
-
-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: WithMeta<Payload>[];
-}>;
-interface InsertedEventData<T extends Module = Module> extends EventData {
-    inserted: InsertedEventArgs<T>;
-}
-
-interface ArchivistModuleEventData extends InsertedEventData, DeletedEventData, ClearedEventData, ModuleEventData {
-}
-
-type IndexDirection = -1 | 1;
-type IndexDescription = {
-    key: {
-        [key: string]: IndexDirection;
-    } | Map<string, IndexDirection>;
-    multiEntry?: boolean;
-    name?: string;
-    unique?: boolean;
-};
-declare const IndexSeparator = "-";
-declare const buildStandardIndexName: (index: IndexDescription) => string;
-
-interface ArchivistParents {
-    commit?: Address[];
-    read?: Address[];
-    write?: Address[];
-}
-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 ArchivistModule<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 NextOptions<TId = string> {
-    limit?: number;
-    offset?: TId;
-    order?: 'asc' | 'desc';
-}
-interface ArchivistNextOptions extends NextOptions<Hash> {
-}
-
-interface ReadArchivist<TReadResponse, TId = string> {
-    all(): PromisableArray<TReadResponse>;
-    get(ids: TId[]): PromisableArray<TReadResponse>;
-    next(options?: NextOptions<TId>): PromisableArray<TReadResponse>;
-}
-interface WriteArchivist<TReadResponse, TWriteResponse = TReadResponse, TWrite = TReadResponse, TId = string> {
-    clear(): Promisable<void>;
-    delete(ids: TId[]): PromisableArray<TId>;
-    insert(item: TWrite[]): PromisableArray<TWriteResponse>;
-}
-interface StashArchivist<TWriteResponse> {
-    commit(): PromisableArray<TWriteResponse>;
-}
-interface Archivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = Payload, TWrite extends Payload = TReadResponse & Payload, TId = Hash> extends ReadArchivist<WithMeta<TReadResponse>, TId>, WriteArchivist<WithMeta<TReadResponse>, WithMeta<TWriteResponse>, TWrite, TId>, StashArchivist<WithMeta<TWriteResponse>> {
-}
-interface ArchivistQueryFunctions<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = Payload, TWrite extends Payload = TReadResponse & Payload, TId = Hash> extends Archivist<TReadResponse, TWriteResponse, TWrite, TId>, ModuleQueryFunctions {
-}
-
-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 ArchivistModule<TParams, TEventData>, ArchivistQueryFunctions<TPayload, WithMeta<TPayload>>, ModuleInstance<TParams, TEventData>, ArchivistRawQueryFunctions {
-}
-
-interface AttachableArchivistInstance<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData, TPayload extends Payload = Payload> extends ArchivistModule<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: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-            parents?: ArchivistParents;
-            requireAllParents?: boolean;
-            schema: "network.xyo.archivist.config";
-            storage?: ArchivistStorage;
-            storeParentReads?: boolean;
-        }, "schema"> & {
-            schema: "network.xyo.archivist.config";
-        }, "schema"> & {
-            schema: string;
-        };
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-    }, ArchivistModuleEventData, {
-        schema: string;
-    } & _xyo_network_payload_model.PayloadFields>>(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: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-            parents?: ArchivistParents;
-            requireAllParents?: boolean;
-            schema: "network.xyo.archivist.config";
-            storage?: ArchivistStorage;
-            storeParentReads?: boolean;
-        }, "schema"> & {
-            schema: "network.xyo.archivist.config";
-        }, "schema"> & {
-            schema: string;
-        };
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-    }, ArchivistModuleEventData, {
-        schema: string;
-    } & _xyo_network_payload_model.PayloadFields>>(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: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-            parents?: ArchivistParents;
-            requireAllParents?: boolean;
-            schema: "network.xyo.archivist.config";
-            storage?: ArchivistStorage;
-            storeParentReads?: boolean;
-        }, "schema"> & {
-            schema: "network.xyo.archivist.config";
-        }, "schema"> & {
-            schema: string;
-        };
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-    }, ArchivistModuleEventData, {
-        schema: string;
-    } & _xyo_network_payload_model.PayloadFields>>, 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';
-}
-
-type ArchivistAllQuerySchema = 'network.xyo.query.archivist.all';
-declare const ArchivistAllQuerySchema: ArchivistAllQuerySchema;
-type ArchivistAllQuery = Query<{
-    schema: ArchivistAllQuerySchema;
-}>;
-
-type ArchivistClearQuerySchema = 'network.xyo.query.archivist.clear';
-declare const ArchivistClearQuerySchema: ArchivistClearQuerySchema;
-type ArchivistClearQuery = Query<{
-    schema: ArchivistClearQuerySchema;
-}>;
-
-type ArchivistCommitQuerySchema = 'network.xyo.query.archivist.commit';
-declare const ArchivistCommitQuerySchema: ArchivistCommitQuerySchema;
-type ArchivistCommitQuery = Query<{
-    schema: ArchivistCommitQuerySchema;
-}>;
-
-type ArchivistDeleteQuerySchema = 'network.xyo.query.archivist.delete';
-declare const ArchivistDeleteQuerySchema: ArchivistDeleteQuerySchema;
-type ArchivistDeleteQuery = Query<{
-    hashes: Hash[];
-    schema: ArchivistDeleteQuerySchema;
-}>;
-
-type ArchivistGetQuerySchema = 'network.xyo.query.archivist.get';
-declare const ArchivistGetQuerySchema: ArchivistGetQuerySchema;
-type ArchivistGetQuery = Query<{
-    hashes: Hash[];
-    schema: ArchivistGetQuerySchema;
-}>;
-
-type ArchivistInsertQuerySchema = 'network.xyo.query.archivist.insert';
-declare const ArchivistInsertQuerySchema: ArchivistInsertQuerySchema;
-type ArchivistInsertQuery = Query<{
-    schema: ArchivistInsertQuerySchema;
-}>;
-
-type ArchivistNextQuerySchema = 'network.xyo.query.archivist.next';
-declare const ArchivistNextQuerySchema: 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: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-        parents?: ArchivistParents;
-        requireAllParents?: boolean;
-        schema: "network.xyo.archivist.config";
-        storage?: ArchivistStorage;
-        storeParentReads?: boolean;
-    }, "schema"> & {
-        schema: "network.xyo.archivist.config";
-    }, "schema"> & {
-        schema: string;
-    };
-    ephemeralQueryAccountEnabled?: boolean;
-    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-}, ArchivistModuleEventData, {
-    schema: string;
-} & _xyo_network_payload_model.PayloadFields>>;
-declare const isArchivistModule: _xyo_network_module_model.ModuleTypeCheck<ArchivistModule<_xylabs_object.BaseParamsFields & {
-    account?: _xyo_network_account_model.AccountInstance | "random";
-    addToResolvers?: boolean;
-    additionalSigners?: _xyo_network_account_model.AccountInstance[];
-    allowNameResolution?: boolean;
-    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-        parents?: ArchivistParents;
-        requireAllParents?: boolean;
-        schema: "network.xyo.archivist.config";
-        storage?: ArchivistStorage;
-        storeParentReads?: boolean;
-    }, "schema"> & {
-        schema: "network.xyo.archivist.config";
-    }, "schema"> & {
-        schema: string;
-    };
-    ephemeralQueryAccountEnabled?: boolean;
-    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-}, ArchivistModuleEventData>>;
-declare const asArchivistModule: {
-    <TType extends ArchivistModule<_xylabs_object.BaseParamsFields & {
-        account?: _xyo_network_account_model.AccountInstance | "random";
-        addToResolvers?: boolean;
-        additionalSigners?: _xyo_network_account_model.AccountInstance[];
-        allowNameResolution?: boolean;
-        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-            parents?: ArchivistParents;
-            requireAllParents?: boolean;
-            schema: "network.xyo.archivist.config";
-            storage?: ArchivistStorage;
-            storeParentReads?: boolean;
-        }, "schema"> & {
-            schema: "network.xyo.archivist.config";
-        }, "schema"> & {
-            schema: string;
-        };
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-    }, ArchivistModuleEventData>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
-    <TType extends ArchivistModule<_xylabs_object.BaseParamsFields & {
-        account?: _xyo_network_account_model.AccountInstance | "random";
-        addToResolvers?: boolean;
-        additionalSigners?: _xyo_network_account_model.AccountInstance[];
-        allowNameResolution?: boolean;
-        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-            parents?: ArchivistParents;
-            requireAllParents?: boolean;
-            schema: "network.xyo.archivist.config";
-            storage?: ArchivistStorage;
-            storeParentReads?: boolean;
-        }, "schema"> & {
-            schema: "network.xyo.archivist.config";
-        }, "schema"> & {
-            schema: string;
-        };
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-    }, ArchivistModuleEventData>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<ArchivistModule<_xylabs_object.BaseParamsFields & {
-        account?: _xyo_network_account_model.AccountInstance | "random";
-        addToResolvers?: boolean;
-        additionalSigners?: _xyo_network_account_model.AccountInstance[];
-        allowNameResolution?: boolean;
-        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-            parents?: ArchivistParents;
-            requireAllParents?: boolean;
-            schema: "network.xyo.archivist.config";
-            storage?: ArchivistStorage;
-            storeParentReads?: boolean;
-        }, "schema"> & {
-            schema: "network.xyo.archivist.config";
-        }, "schema"> & {
-            schema: string;
-        };
-        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: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-            parents?: ArchivistParents;
-            requireAllParents?: boolean;
-            schema: "network.xyo.archivist.config";
-            storage?: ArchivistStorage;
-            storeParentReads?: boolean;
-        }, "schema"> & {
-            schema: "network.xyo.archivist.config";
-        }, "schema"> & {
-            schema: string;
-        };
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-    }, ArchivistModuleEventData, {
-        schema: string;
-    } & _xyo_network_payload_model.PayloadFields>>(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: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-            parents?: ArchivistParents;
-            requireAllParents?: boolean;
-            schema: "network.xyo.archivist.config";
-            storage?: ArchivistStorage;
-            storeParentReads?: boolean;
-        }, "schema"> & {
-            schema: "network.xyo.archivist.config";
-        }, "schema"> & {
-            schema: string;
-        };
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-    }, ArchivistModuleEventData, {
-        schema: string;
-    } & _xyo_network_payload_model.PayloadFields>>(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: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-            parents?: ArchivistParents;
-            requireAllParents?: boolean;
-            schema: "network.xyo.archivist.config";
-            storage?: ArchivistStorage;
-            storeParentReads?: boolean;
-        }, "schema"> & {
-            schema: "network.xyo.archivist.config";
-        }, "schema"> & {
-            schema: string;
-        };
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-    }, ArchivistModuleEventData, {
-        schema: string;
-    } & _xyo_network_payload_model.PayloadFields>>, config?: _xylabs_object.TypeCheckConfig): TType;
-};
-declare const withArchivistModule: <R>(mod: any, closure: (mod: ArchivistModule<_xylabs_object.BaseParamsFields & {
-    account?: _xyo_network_account_model.AccountInstance | "random";
-    addToResolvers?: boolean;
-    additionalSigners?: _xyo_network_account_model.AccountInstance[];
-    allowNameResolution?: boolean;
-    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-        parents?: ArchivistParents;
-        requireAllParents?: boolean;
-        schema: "network.xyo.archivist.config";
-        storage?: ArchivistStorage;
-        storeParentReads?: boolean;
-    }, "schema"> & {
-        schema: "network.xyo.archivist.config";
-    }, "schema"> & {
-        schema: string;
-    };
-    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: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
-        parents?: ArchivistParents;
-        requireAllParents?: boolean;
-        schema: "network.xyo.archivist.config";
-        storage?: ArchivistStorage;
-        storeParentReads?: boolean;
-    }, "schema"> & {
-        schema: "network.xyo.archivist.config";
-    }, "schema"> & {
-        schema: string;
-    };
-    ephemeralQueryAccountEnabled?: boolean;
-    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-}, ArchivistModuleEventData, {
-    schema: string;
-} & _xyo_network_payload_model.PayloadFields>) => R) => R | undefined;
-
-export { 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 ArchivistModule, type ArchivistModuleEventData, type ArchivistModuleQueries, type ArchivistNextOptions, type ArchivistNextQuery, ArchivistNextQuerySchema, type ArchivistParams, type ArchivistParents, type ArchivistQueries, type ArchivistQueryFunctions, type ArchivistRawQueryFunctions, type ArchivistStorage, type AttachableArchivistInstance, type AttachableArchivistInstanceTypeCheck, type IndexDescription, type IndexDirection, IndexSeparator, IsAttachableArchivistInstanceFactory, type NextOptions, type ReadArchivist, type StashArchivist, type WriteArchivist, asArchivistInstance, asArchivistModule, asAttachableArchivistInstance, buildStandardIndexName, isArchivistInstance, isArchivistModule, isAttachableArchivistInstance, requiredAttachableArchivistInstanceFunctions, withArchivistInstance, withArchivistModule };
+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

package/dist/neutral/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,wBAAwB,CAAA;AACtC,cAAc,iBAAiB,CAAA"}

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/attachable/asAttachableInstance.ts","../../src/attachable/isAttachableInstance.ts","../../src/typeChecks.ts","../../src/Queries/All.ts","../../src/Queries/Clear.ts","../../src/Queries/Commit.ts","../../src/Queries/Delete.ts","../../src/Queries/Get.ts","../../src/Queries/Insert.ts","../../src/Queries/Next.ts","../../src/attachable/AttachableInstance.ts","../../src/Config.ts","../../src/IndexDescription.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/object'\n\nimport { isAttachableArchivistInstance } from './isAttachableInstance.ts'\n\nexport const asAttachableArchivistInstance = AsObjectFactory.create(isAttachableArchivistInstance)\n","import type { ObjectTypeShape, TypeCheck } from '@xylabs/object'\nimport { IsObjectFactory } from '@xylabs/object'\nimport { isAttachableModuleInstance } from '@xyo-network/module-model'\n\nimport { isArchivistInstance } from '../typeChecks.ts'\nimport type { AttachableArchivistInstance } from './AttachableInstance.ts'\n\nexport const requiredAttachableArchivistInstanceFunctions: ObjectTypeShape = {}\n\n// we do not use IsInstanceFactory here to prevent a cycle\nconst factory = new IsObjectFactory<AttachableArchivistInstance>()\n\nexport const isAttachableArchivistInstance: TypeCheck<AttachableArchivistInstance> = factory.create(requiredAttachableArchivistInstanceFunctions, [\n  isArchivistInstance,\n  isAttachableModuleInstance,\n])\n","import { AsObjectFactory } from '@xylabs/object'\nimport { IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory } from '@xyo-network/module-model'\n\nimport type { ArchivistInstance } from './Instance.ts'\nimport type { ArchivistModule } from './Module.ts'\nimport { ArchivistGetQuerySchema } from './Queries/index.ts'\n\nexport const isArchivistInstance = new IsInstanceFactory<ArchivistInstance>().create({ get: 'function' }, [isModuleInstance])\nexport const isArchivistModule = new IsModuleFactory<ArchivistModule>().create([ArchivistGetQuerySchema])\n\nexport const asArchivistModule = AsObjectFactory.create(isArchivistModule)\nexport const asArchivistInstance = AsObjectFactory.create(isArchivistInstance)\nexport const withArchivistModule = WithFactory.create(isArchivistModule)\nexport const withArchivistInstance = WithFactory.create(isArchivistInstance)\n","import type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistAllQuerySchema = 'network.xyo.query.archivist.all'\nexport const ArchivistAllQuerySchema: ArchivistAllQuerySchema = 'network.xyo.query.archivist.all'\n\nexport type ArchivistAllQuery = Query<{\n  schema: ArchivistAllQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistClearQuerySchema = 'network.xyo.query.archivist.clear'\nexport const ArchivistClearQuerySchema: ArchivistClearQuerySchema = 'network.xyo.query.archivist.clear'\n\nexport type ArchivistClearQuery = Query<{\n  schema: ArchivistClearQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistCommitQuerySchema = 'network.xyo.query.archivist.commit'\nexport const ArchivistCommitQuerySchema: ArchivistCommitQuerySchema = 'network.xyo.query.archivist.commit'\n\nexport type ArchivistCommitQuery = Query<{\n  schema: ArchivistCommitQuerySchema\n}>\n","import type { Hash } from '@xylabs/hex'\nimport type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistDeleteQuerySchema = 'network.xyo.query.archivist.delete'\nexport const ArchivistDeleteQuerySchema: ArchivistDeleteQuerySchema = 'network.xyo.query.archivist.delete'\n\nexport type ArchivistDeleteQuery = Query<{\n  hashes: Hash[]\n  schema: ArchivistDeleteQuerySchema\n}>\n","import type { Hash } from '@xylabs/hex'\nimport type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistGetQuerySchema = 'network.xyo.query.archivist.get'\nexport const ArchivistGetQuerySchema: ArchivistGetQuerySchema = 'network.xyo.query.archivist.get'\n\nexport type ArchivistGetQuery = Query<{\n  hashes: Hash[]\n  schema: ArchivistGetQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistInsertQuerySchema = 'network.xyo.query.archivist.insert'\nexport const ArchivistInsertQuerySchema: ArchivistInsertQuerySchema = 'network.xyo.query.archivist.insert'\n\nexport type ArchivistInsertQuery = Query<{\n  schema: ArchivistInsertQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nimport type { ArchivistNextOptions } from '../NextOptions.ts'\n\nexport type ArchivistNextQuerySchema = 'network.xyo.query.archivist.next'\nexport const ArchivistNextQuerySchema: ArchivistNextQuerySchema = 'network.xyo.query.archivist.next'\n\nexport type ArchivistNextQuery = Query<ArchivistNextOptions, ArchivistNextQuerySchema>\n","import type { TypeCheck } from '@xylabs/object'\nimport { IsObjectFactory } from '@xylabs/object'\nimport type { AttachableModuleInstance } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\n\nimport type { ArchivistModuleEventData } from '../EventData.ts'\nimport type { ArchivistInstance } from '../Instance.ts'\nimport type { ArchivistModule } from '../Module.ts'\nimport type { ArchivistParams } from '../Params.ts'\n\nexport interface AttachableArchivistInstance<\n  TParams extends ArchivistParams = ArchivistParams,\n  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n  TPayload extends Payload = Payload,\n> extends ArchivistModule<TParams, TEventData>,\n  AttachableModuleInstance<TParams, TEventData>,\n  ArchivistInstance<TParams, TEventData, TPayload> {}\n\nexport type AttachableArchivistInstanceTypeCheck<T extends AttachableArchivistInstance = AttachableArchivistInstance> = TypeCheck<T>\n\nexport class IsAttachableArchivistInstanceFactory<T extends AttachableArchivistInstance = AttachableArchivistInstance> extends IsObjectFactory<T> {}\n","import type { Address } from '@xylabs/hex'\nimport type { EmptyObject, WithAdditional } from '@xylabs/object'\nimport type { ModuleConfig } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\n\nimport type { IndexDescription } from './IndexDescription.ts'\n\nexport interface ArchivistParents {\n  commit?: Address[]\n  read?: Address[]\n  write?: Address[]\n}\n\nexport interface ArchivistStorage {\n  /** The indexes to create on the object store */\n  indexes?: IndexDescription[]\n}\n\nexport const ArchivistConfigSchema = 'network.xyo.archivist.config' as const\nexport type ArchivistConfigSchema = typeof ArchivistConfigSchema\n\nexport type ArchivistConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = ModuleConfig<\n  WithAdditional<\n    {\n      /** @field address of one or more parent archivists to read from */\n      parents?: ArchivistParents\n      /** @field fail if some parents can not be resolved (true if unspecified) */\n      requireAllParents?: boolean\n      schema: TConfig extends Payload ? TConfig['schema'] : ArchivistConfigSchema\n      /** @field storage configuration */\n      storage?: ArchivistStorage\n      /** @field should child store all reads from parents? */\n      storeParentReads?: boolean\n    },\n    TConfig\n  >,\n  TSchema\n>\n","/**\n * The index direction (1 for ascending, -1 for descending)\n */\nexport type IndexDirection = -1 | 1\n\n/**\n * Description of index(es) to be created on a store\n */\nexport type IndexDescription = {\n  /**\n   * The key(s) to index\n   */\n  key:\n    | {\n      [key: string]: IndexDirection\n    }\n    | Map<string, IndexDirection>\n  /**\n   * Is the indexed value an array\n   */\n  multiEntry?: boolean\n  /**\n   * The name of the index\n   */\n  name?: string\n  /**\n   * If true, the index must enforce uniqueness on the key\n   */\n  unique?: boolean\n}\n\nexport const IndexSeparator = '-'\n\n/**\n * Given an index description, this will build the index\n * name in standard form\n * @param index The index description\n * @returns The index name in standard form\n */\nexport const buildStandardIndexName = (index: IndexDescription) => {\n  const { key, unique } = index\n  const prefix = unique ? 'UX' : 'IX'\n  const indexKeys = Object.keys(key)\n  return `${prefix}_${indexKeys.join(IndexSeparator)}`\n}\n"],"mappings":";;;;AAAA,SAASA,mBAAAA,wBAAuB;;;ACChC,SAASC,uBAAuB;AAChC,SAASC,kCAAkC;;;ACF3C,SAASC,uBAAuB;AAChC,SAASC,mBAAmBC,iBAAiBC,kBAAkBC,mBAAmB;;;ACE3E,IAAMC,0BAAmD;;;ACAzD,IAAMC,4BAAuD;;;ACA7D,IAAMC,6BAAyD;;;ACC/D,IAAMC,6BAAyD;;;ACA/D,IAAMC,0BAAmD;;;ACDzD,IAAMC,6BAAyD;;;ACE/D,IAAMC,2BAAqD;;;APE3D,IAAMC,sBAAsB,IAAIC,kBAAAA,EAAuCC,OAAO;EAAEC,KAAK;AAAW,GAAG;EAACC;CAAiB;AACrH,IAAMC,oBAAoB,IAAIC,gBAAAA,EAAmCJ,OAAO;EAACK;CAAwB;AAEjG,IAAMC,oBAAoBC,gBAAgBP,OAAOG,iBAAAA;AACjD,IAAMK,sBAAsBD,gBAAgBP,OAAOF,mBAAAA;AACnD,IAAMW,sBAAsBC,YAAYV,OAAOG,iBAAAA;AAC/C,IAAMQ,wBAAwBD,YAAYV,OAAOF,mBAAAA;;;ADNjD,IAAMc,+CAAgE,CAAC;AAG9E,IAAMC,UAAU,IAAIC,gBAAAA;AAEb,IAAMC,gCAAwEF,QAAQG,OAAOJ,8CAA8C;EAChJK;EACAC;CACD;;;ADXM,IAAMC,gCAAgCC,iBAAgBC,OAAOC,6BAAAA;;;AUHpE,SAASC,mBAAAA,wBAAuB;AAmBzB,IAAMC,uCAAN,cAAwHC,iBAAAA;EAnB/H,OAmB+HA;;;AAAoB;;;ACF5I,IAAMC,wBAAwB;;;ACa9B,IAAMC,iBAAiB;AAQvB,IAAMC,yBAAyB,wBAACC,UAAAA;AACrC,QAAM,EAAEC,KAAKC,OAAM,IAAKF;AACxB,QAAMG,SAASD,SAAS,OAAO;AAC/B,QAAME,YAAYC,OAAOC,KAAKL,GAAAA;AAC9B,SAAO,GAAGE,MAAAA,IAAUC,UAAUG,KAAKT,cAAAA,CAAAA;AACrC,GALsC;","names":["AsObjectFactory","IsObjectFactory","isAttachableModuleInstance","AsObjectFactory","IsInstanceFactory","IsModuleFactory","isModuleInstance","WithFactory","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistCommitQuerySchema","ArchivistDeleteQuerySchema","ArchivistGetQuerySchema","ArchivistInsertQuerySchema","ArchivistNextQuerySchema","isArchivistInstance","IsInstanceFactory","create","get","isModuleInstance","isArchivistModule","IsModuleFactory","ArchivistGetQuerySchema","asArchivistModule","AsObjectFactory","asArchivistInstance","withArchivistModule","WithFactory","withArchivistInstance","requiredAttachableArchivistInstanceFunctions","factory","IsObjectFactory","isAttachableArchivistInstance","create","isArchivistInstance","isAttachableModuleInstance","asAttachableArchivistInstance","AsObjectFactory","create","isAttachableArchivistInstance","IsObjectFactory","IsAttachableArchivistInstanceFactory","IsObjectFactory","ArchivistConfigSchema","IndexSeparator","buildStandardIndexName","index","key","unique","prefix","indexKeys","Object","keys","join"]}
+{"version":3,"sources":["../../src/attachable/asAttachableInstance.ts","../../src/attachable/isAttachableInstance.ts","../../src/typeChecks.ts","../../src/Queries/All.ts","../../src/Queries/Clear.ts","../../src/Queries/Commit.ts","../../src/Queries/Delete.ts","../../src/Queries/Get.ts","../../src/Queries/Insert.ts","../../src/Queries/Next.ts","../../src/attachable/AttachableInstance.ts","../../src/Config.ts","../../src/IndexDescription.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/object'\n\nimport { isAttachableArchivistInstance } from './isAttachableInstance.ts'\n\nexport const asAttachableArchivistInstance = AsObjectFactory.create(isAttachableArchivistInstance)\n","import type { ObjectTypeShape, TypeCheck } from '@xylabs/object'\nimport { IsObjectFactory } from '@xylabs/object'\nimport { isAttachableModuleInstance } from '@xyo-network/module-model'\n\nimport { isArchivistInstance } from '../typeChecks.ts'\nimport type { AttachableArchivistInstance } from './AttachableInstance.ts'\n\nexport const requiredAttachableArchivistInstanceFunctions: ObjectTypeShape = {}\n\n// we do not use IsInstanceFactory here to prevent a cycle\nconst factory = new IsObjectFactory<AttachableArchivistInstance>()\n\nexport const isAttachableArchivistInstance: TypeCheck<AttachableArchivistInstance> = factory.create(requiredAttachableArchivistInstanceFunctions, [\n  isArchivistInstance,\n  isAttachableModuleInstance,\n])\n","import { AsObjectFactory } from '@xylabs/object'\nimport {\n  IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory,\n} from '@xyo-network/module-model'\n\nimport type { ArchivistInstance } from './Instance.ts'\nimport type { ArchivistModule } from './Module.ts'\nimport { ArchivistGetQuerySchema } from './Queries/index.ts'\n\nexport const isArchivistInstance = new IsInstanceFactory<ArchivistInstance>().create({ get: 'function' }, [isModuleInstance])\nexport const isArchivistModule = new IsModuleFactory<ArchivistModule>().create([ArchivistGetQuerySchema])\n\nexport const asArchivistModule = AsObjectFactory.create(isArchivistModule)\nexport const asArchivistInstance = AsObjectFactory.create(isArchivistInstance)\nexport const withArchivistModule = WithFactory.create(isArchivistModule)\nexport const withArchivistInstance = WithFactory.create(isArchivistInstance)\n","import type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistAllQuerySchema = 'network.xyo.query.archivist.all'\nexport const ArchivistAllQuerySchema: ArchivistAllQuerySchema = 'network.xyo.query.archivist.all'\n\nexport type ArchivistAllQuery = Query<{\n  schema: ArchivistAllQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistClearQuerySchema = 'network.xyo.query.archivist.clear'\nexport const ArchivistClearQuerySchema: ArchivistClearQuerySchema = 'network.xyo.query.archivist.clear'\n\nexport type ArchivistClearQuery = Query<{\n  schema: ArchivistClearQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistCommitQuerySchema = 'network.xyo.query.archivist.commit'\nexport const ArchivistCommitQuerySchema: ArchivistCommitQuerySchema = 'network.xyo.query.archivist.commit'\n\nexport type ArchivistCommitQuery = Query<{\n  schema: ArchivistCommitQuerySchema\n}>\n","import type { Hash } from '@xylabs/hex'\nimport type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistDeleteQuerySchema = 'network.xyo.query.archivist.delete'\nexport const ArchivistDeleteQuerySchema: ArchivistDeleteQuerySchema = 'network.xyo.query.archivist.delete'\n\nexport type ArchivistDeleteQuery = Query<{\n  hashes: Hash[]\n  schema: ArchivistDeleteQuerySchema\n}>\n","import type { Hash } from '@xylabs/hex'\nimport type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistGetQuerySchema = 'network.xyo.query.archivist.get'\nexport const ArchivistGetQuerySchema: ArchivistGetQuerySchema = 'network.xyo.query.archivist.get'\n\nexport type ArchivistGetQuery = Query<{\n  hashes: Hash[]\n  schema: ArchivistGetQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport type ArchivistInsertQuerySchema = 'network.xyo.query.archivist.insert'\nexport const ArchivistInsertQuerySchema: ArchivistInsertQuerySchema = 'network.xyo.query.archivist.insert'\n\nexport type ArchivistInsertQuery = Query<{\n  schema: ArchivistInsertQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nimport type { ArchivistNextOptions } from '../NextOptions.ts'\n\nexport type ArchivistNextQuerySchema = 'network.xyo.query.archivist.next'\nexport const ArchivistNextQuerySchema: ArchivistNextQuerySchema = 'network.xyo.query.archivist.next'\n\nexport type ArchivistNextQuery = Query<ArchivistNextOptions, ArchivistNextQuerySchema>\n","import type { TypeCheck } from '@xylabs/object'\nimport { IsObjectFactory } from '@xylabs/object'\nimport type { AttachableModuleInstance } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\n\nimport type { ArchivistModuleEventData } from '../EventData.ts'\nimport type { ArchivistInstance } from '../Instance.ts'\nimport type { ArchivistModule } from '../Module.ts'\nimport type { ArchivistParams } from '../Params.ts'\n\nexport interface AttachableArchivistInstance<\n  TParams extends ArchivistParams = ArchivistParams,\n  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n  TPayload extends Payload = Payload,\n> extends ArchivistModule<TParams, TEventData>,\n  AttachableModuleInstance<TParams, TEventData>,\n  ArchivistInstance<TParams, TEventData, TPayload> {}\n\nexport type AttachableArchivistInstanceTypeCheck<T extends AttachableArchivistInstance = AttachableArchivistInstance> = TypeCheck<T>\n\nexport class IsAttachableArchivistInstanceFactory<T extends AttachableArchivistInstance = AttachableArchivistInstance> extends IsObjectFactory<T> {}\n","import type { Address } from '@xylabs/hex'\nimport type { EmptyObject, WithAdditional } from '@xylabs/object'\nimport type { ModuleConfig } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\n\nimport type { IndexDescription } from './IndexDescription.ts'\n\nexport interface ArchivistParents {\n  commit?: Address[]\n  read?: Address[]\n  write?: Address[]\n}\n\nexport interface ArchivistStorage {\n  /** The indexes to create on the object store */\n  indexes?: IndexDescription[]\n}\n\nexport const ArchivistConfigSchema = 'network.xyo.archivist.config' as const\nexport type ArchivistConfigSchema = typeof ArchivistConfigSchema\n\nexport type ArchivistConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = ModuleConfig<\n  WithAdditional<\n    {\n      /** @field address of one or more parent archivists to read from */\n      parents?: ArchivistParents\n      /** @field fail if some parents can not be resolved (true if unspecified) */\n      requireAllParents?: boolean\n      schema: TConfig extends Payload ? TConfig['schema'] : ArchivistConfigSchema\n      /** @field storage configuration */\n      storage?: ArchivistStorage\n      /** @field should child store all reads from parents? */\n      storeParentReads?: boolean\n    },\n    TConfig\n  >,\n  TSchema\n>\n","/**\n * The index direction (1 for ascending, -1 for descending)\n */\nexport type IndexDirection = -1 | 1\n\n/**\n * Description of index(es) to be created on a store\n */\nexport type IndexDescription = {\n  /**\n   * The key(s) to index\n   */\n  key:\n    | {\n      [key: string]: IndexDirection\n    }\n    | Map<string, IndexDirection>\n  /**\n   * Is the indexed value an array\n   */\n  multiEntry?: boolean\n  /**\n   * The name of the index\n   */\n  name?: string\n  /**\n   * If true, the index must enforce uniqueness on the key\n   */\n  unique?: boolean\n}\n\nexport const IndexSeparator = '-'\n\n/**\n * Given an index description, this will build the index\n * name in standard form\n * @param index The index description\n * @returns The index name in standard form\n */\nexport const buildStandardIndexName = (index: IndexDescription) => {\n  const { key, unique } = index\n  const prefix = unique ? 'UX' : 'IX'\n  const indexKeys = Object.keys(key)\n  return `${prefix}_${indexKeys.join(IndexSeparator)}`\n}\n"],"mappings":";;;;AAAA,SAASA,mBAAAA,wBAAuB;;;ACChC,SAASC,uBAAuB;AAChC,SAASC,kCAAkC;;;ACF3C,SAASC,uBAAuB;AAChC,SACEC,mBAAmBC,iBAAiBC,kBAAkBC,mBACjD;;;ACAA,IAAMC,0BAAmD;;;ACAzD,IAAMC,4BAAuD;;;ACA7D,IAAMC,6BAAyD;;;ACC/D,IAAMC,6BAAyD;;;ACA/D,IAAMC,0BAAmD;;;ACDzD,IAAMC,6BAAyD;;;ACE/D,IAAMC,2BAAqD;;;API3D,IAAMC,sBAAsB,IAAIC,kBAAAA,EAAuCC,OAAO;EAAEC,KAAK;AAAW,GAAG;EAACC;CAAiB;AACrH,IAAMC,oBAAoB,IAAIC,gBAAAA,EAAmCJ,OAAO;EAACK;CAAwB;AAEjG,IAAMC,oBAAoBC,gBAAgBP,OAAOG,iBAAAA;AACjD,IAAMK,sBAAsBD,gBAAgBP,OAAOF,mBAAAA;AACnD,IAAMW,sBAAsBC,YAAYV,OAAOG,iBAAAA;AAC/C,IAAMQ,wBAAwBD,YAAYV,OAAOF,mBAAAA;;;ADRjD,IAAMc,+CAAgE,CAAC;AAG9E,IAAMC,UAAU,IAAIC,gBAAAA;AAEb,IAAMC,gCAAwEF,QAAQG,OAAOJ,8CAA8C;EAChJK;EACAC;CACD;;;ADXM,IAAMC,gCAAgCC,iBAAgBC,OAAOC,6BAAAA;;;AUHpE,SAASC,mBAAAA,wBAAuB;AAmBzB,IAAMC,uCAAN,cAAwHC,iBAAAA;EAnB/H,OAmB+HA;;;AAAoB;;;ACF5I,IAAMC,wBAAwB;;;ACa9B,IAAMC,iBAAiB;AAQvB,IAAMC,yBAAyB,wBAACC,UAAAA;AACrC,QAAM,EAAEC,KAAKC,OAAM,IAAKF;AACxB,QAAMG,SAASD,SAAS,OAAO;AAC/B,QAAME,YAAYC,OAAOC,KAAKL,GAAAA;AAC9B,SAAO,GAAGE,MAAAA,IAAUC,UAAUG,KAAKT,cAAAA,CAAAA;AACrC,GALsC;","names":["AsObjectFactory","IsObjectFactory","isAttachableModuleInstance","AsObjectFactory","IsInstanceFactory","IsModuleFactory","isModuleInstance","WithFactory","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistCommitQuerySchema","ArchivistDeleteQuerySchema","ArchivistGetQuerySchema","ArchivistInsertQuerySchema","ArchivistNextQuerySchema","isArchivistInstance","IsInstanceFactory","create","get","isModuleInstance","isArchivistModule","IsModuleFactory","ArchivistGetQuerySchema","asArchivistModule","AsObjectFactory","asArchivistInstance","withArchivistModule","WithFactory","withArchivistInstance","requiredAttachableArchivistInstanceFunctions","factory","IsObjectFactory","isAttachableArchivistInstance","create","isArchivistInstance","isAttachableModuleInstance","asAttachableArchivistInstance","AsObjectFactory","create","isAttachableArchivistInstance","IsObjectFactory","IsAttachableArchivistInstanceFactory","IsObjectFactory","ArchivistConfigSchema","IndexSeparator","buildStandardIndexName","index","key","unique","prefix","indexKeys","Object","keys","join"]}