@xyo-network/archivist-model 2.111.2 → 3.0.0

package/dist/neutral/index.d.ts

@@ -1,14 +1,436 @@
-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 * 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 };

package/package.json

@@ -10,48 +10,29 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/hex": "^3.6.8",
-    "@xylabs/object": "^3.6.8",
-    "@xylabs/promise": "^3.6.8",
-    "@xyo-network/account-model": "^2.111.2",
-    "@xyo-network/module-events": "^2.111.2",
-    "@xyo-network/module-model": "^2.111.2",
-    "@xyo-network/payload-model": "^2.111.2"
+    "@xylabs/hex": "^3.6.12",
+    "@xylabs/object": "^3.6.12",
+    "@xylabs/promise": "^3.6.12",
+    "@xyo-network/account-model": "^3.0.0",
+    "@xyo-network/module-events": "^3.0.0",
+    "@xyo-network/module-model": "^3.0.0",
+    "@xyo-network/payload-model": "^3.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.15.13",
-    "@xylabs/tsconfig": "^3.15.13",
+    "@xylabs/ts-scripts-yarn3": "next",
+    "@xylabs/tsconfig": "next",
     "typescript": "^5.5.4"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
-  "types": "dist/node/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "exports": {
     ".": {
-      "browser": {
-        "require": {
-          "types": "./dist/browser/index.d.cts",
-          "default": "./dist/browser/index.cjs"
-        },
-        "import": {
-          "types": "./dist/browser/index.d.mts",
-          "default": "./dist/browser/index.mjs"
-        }
-      },
-      "node": {
-        "require": {
-          "types": "./dist/node/index.d.cts",
-          "default": "./dist/node/index.cjs"
-        },
-        "import": {
-          "types": "./dist/node/index.d.mts",
-          "default": "./dist/node/index.mjs"
-        }
-      }
+      "types": "./dist/neutral/index.d.ts",
+      "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "main": "dist/node/index.cjs",
-  "module": "dist/node/index.mjs",
+  "module": "dist/neutral/index.mjs",
   "homepage": "https://xyo.network",
   "license": "LGPL-3.0-only",
   "publishConfig": {
@@ -62,6 +43,6 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.111.2",
+  "version": "3.0.0",
   "type": "module"
 }

package/src/Module.ts

@@ -3,7 +3,6 @@ import { AnyConfigSchema, Module, ModuleParams } from '@xyo-network/module-model
 import { ArchivistConfig } from './Config.ts'
 import { ArchivistModuleEventData } from './EventData.ts'
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface ArchivistModule<
   TParams extends ModuleParams<AnyConfigSchema<ArchivistConfig>> = ModuleParams<AnyConfigSchema<ArchivistConfig>>,
   TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,

package/src/NextOptions.ts

@@ -6,5 +6,4 @@ export interface NextOptions<TId = string> {
   order?: 'asc' | 'desc'
 }
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface ArchivistNextOptions extends NextOptions<Hash> {}

package/xy.config.ts

@@ -0,0 +1,12 @@
+import { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: {},
+    neutral: {
+      src: true,
+    },
+    node: {},
+  },
+}
+
+export default config

package/dist/browser/Config.d.cts

@@ -1,23 +0,0 @@
-import { Address } from '@xylabs/hex';
-import { EmptyObject, WithAdditional } from '@xylabs/object';
-import { ModuleConfig } from '@xyo-network/module-model';
-import { Payload } from '@xyo-network/payload-model';
-import { IndexDescription } from './IndexDescription.ts';
-export interface ArchivistParents {
-    commit?: Address[];
-    read?: Address[];
-    write?: Address[];
-}
-export interface ArchivistStorage {
-    indexes?: IndexDescription[];
-}
-export declare const ArchivistConfigSchema: "network.xyo.archivist.config";
-export type ArchivistConfigSchema = typeof ArchivistConfigSchema;
-export 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>;
-//# sourceMappingURL=Config.d.ts.map

package/dist/browser/Config.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,OAAO,EAAE,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;IAChB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,gBAAgB;IAE/B,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;CAC7B;AAED,eAAO,MAAM,qBAAqB,gCAA0C,CAAA;AAC5E,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAA;AAEhE,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,OAAO,GAAG,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,YAAY,CACnI,cAAc,CACZ;IAEE,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAE1B,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,MAAM,EAAE,OAAO,SAAS,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,qBAAqB,CAAA;IAE3E,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAE1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,EACD,OAAO,CACR,EACD,OAAO,CACR,CAAA"}

package/dist/browser/Config.d.mts

@@ -1,23 +0,0 @@
-import { Address } from '@xylabs/hex';
-import { EmptyObject, WithAdditional } from '@xylabs/object';
-import { ModuleConfig } from '@xyo-network/module-model';
-import { Payload } from '@xyo-network/payload-model';
-import { IndexDescription } from './IndexDescription.ts';
-export interface ArchivistParents {
-    commit?: Address[];
-    read?: Address[];
-    write?: Address[];
-}
-export interface ArchivistStorage {
-    indexes?: IndexDescription[];
-}
-export declare const ArchivistConfigSchema: "network.xyo.archivist.config";
-export type ArchivistConfigSchema = typeof ArchivistConfigSchema;
-export 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>;
-//# sourceMappingURL=Config.d.ts.map

package/dist/browser/Config.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,OAAO,EAAE,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;IAChB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,gBAAgB;IAE/B,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;CAC7B;AAED,eAAO,MAAM,qBAAqB,gCAA0C,CAAA;AAC5E,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAA;AAEhE,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,OAAO,GAAG,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,YAAY,CACnI,cAAc,CACZ;IAEE,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAE1B,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,MAAM,EAAE,OAAO,SAAS,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,qBAAqB,CAAA;IAE3E,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAE1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,EACD,OAAO,CACR,EACD,OAAO,CACR,CAAA"}

package/dist/browser/Config.d.ts

@@ -1,23 +0,0 @@
-import { Address } from '@xylabs/hex';
-import { EmptyObject, WithAdditional } from '@xylabs/object';
-import { ModuleConfig } from '@xyo-network/module-model';
-import { Payload } from '@xyo-network/payload-model';
-import { IndexDescription } from './IndexDescription.ts';
-export interface ArchivistParents {
-    commit?: Address[];
-    read?: Address[];
-    write?: Address[];
-}
-export interface ArchivistStorage {
-    indexes?: IndexDescription[];
-}
-export declare const ArchivistConfigSchema: "network.xyo.archivist.config";
-export type ArchivistConfigSchema = typeof ArchivistConfigSchema;
-export 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>;
-//# sourceMappingURL=Config.d.ts.map

package/dist/browser/Config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,OAAO,EAAE,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;IAChB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,gBAAgB;IAE/B,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;CAC7B;AAED,eAAO,MAAM,qBAAqB,gCAA0C,CAAA;AAC5E,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAA;AAEhE,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,OAAO,GAAG,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,YAAY,CACnI,cAAc,CACZ;IAEE,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAE1B,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,MAAM,EAAE,OAAO,SAAS,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,qBAAqB,CAAA;IAE3E,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAE1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,EACD,OAAO,CACR,EACD,OAAO,CACR,CAAA"}

package/dist/browser/EventData.d.cts

@@ -1,5 +0,0 @@
-import { ModuleEventData } from '@xyo-network/module-model';
-import { ClearedEventData, DeletedEventData, InsertedEventData } from './EventModels/index.ts';
-export interface ArchivistModuleEventData extends InsertedEventData, DeletedEventData, ClearedEventData, ModuleEventData {
-}
-//# sourceMappingURL=EventData.d.ts.map