@xyo-network/module-model 4.1.2 → 4.1.4

package/dist/neutral/index.d.ts

@@ -1,671 +1,22 @@
-import { Schema, Payload, ModuleError, WithoutPrivateStorageMeta, WithSources, Query } from '@xyo-network/payload-model';
-import { Address } from '@xylabs/hex';
-import * as _xylabs_object from '@xylabs/object';
-import { EmptyObject, TypeCheck, AnyObject, IsObjectFactory, JsonValue } from '@xylabs/object';
-import { LogLevel, Logger } from '@xylabs/logger';
-import { RetryConfig } from '@xylabs/retry';
-import { CreatableStatusReporter, CreatableParams, CreatableStatus, CreatableInstance, Creatable } from '@xylabs/creatable';
-import { EventArgs, EventData, EventEmitter } from '@xylabs/events';
-import { BoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model';
-import { AccountInstance } from '@xyo-network/account-model';
-import * as _xylabs_promise from '@xylabs/promise';
-import { Promisable } from '@xylabs/promise';
-import { ModuleManifestPayload } from '@xyo-network/manifest-model';
-import { ObjectTypeShape } from '@xylabs/typeof';
-
-interface CacheConfig {
-    max?: number;
-    maxSize?: number;
-    ttl?: number;
-}
-
-declare const MODULE_PATH_SEPARATOR: ":";
-declare const DisallowedModuleIdentifierCharacters: {
-    ' ': boolean;
-    '!': boolean;
-    '"': boolean;
-    '#': boolean;
-    $: boolean;
-    '%': boolean;
-    '&': boolean;
-    "'": boolean;
-    '(': boolean;
-    ')': boolean;
-    '*': boolean;
-    ',': boolean;
-    '.': boolean;
-    '/': boolean;
-    ':': boolean;
-    ';': boolean;
-    '<': boolean;
-    '=': boolean;
-    '>': boolean;
-    '?': boolean;
-    '@': boolean;
-    '[': boolean;
-    ']': boolean;
-    '^': boolean;
-    _: boolean;
-    '{': boolean;
-    '|': boolean;
-    '}': boolean;
-    '~': boolean;
-};
-type ReservedModuleIdentifierCharacter = keyof typeof DisallowedModuleIdentifierCharacters;
-declare const ReservedModuleIdentifierCharacters: Set<":" | " " | "!" | "\"" | "#" | "$" | "%" | "&" | "'" | "(" | ")" | "*" | "," | "." | "/" | ";" | "<" | "=" | ">" | "?" | "@" | "[" | "]" | "^" | "_" | "{" | "|" | "}" | "~">;
-type ModuleName = Exclude<string, 'reserved-module-name-56487634'>;
-type ModuleIdentifier = ColonPair<ModuleIdentifierPart> | ColonPair<ColonPair<ModuleIdentifierPart>> | ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>> | ColonPair<ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>>> | ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>>>> | ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>>>>> | ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>>>>>>;
-type ColonPair<T extends string> = `${T}:${T}` | T;
-type ModuleIdentifierPart = Exclude<Address | ModuleName, '*'>;
-declare const isModuleName: (value: unknown) => value is ModuleName;
-declare const includesReservedModuleIdentifierCharacter: (value: unknown) => boolean;
-declare const isModuleIdentifierPart: (value: unknown) => value is ModuleIdentifierPart;
-
-interface ArchivingModuleConfig {
-    readonly archiving?: {
-        readonly archivists?: ModuleIdentifier[];
-        readonly queries?: Schema[];
-    };
-}
-
-/**
- * Object used to represent labels identifying a resource.
- */
-interface Labels {
-    [key: string]: string | undefined;
-}
-/**
- * Interface for objects that have labels.
- */
-interface WithLabels<T extends Labels = Labels> {
-    labels: T;
-}
-/**
- * Interface for objects that have labels.
- */
-interface WithOptionalLabels<T extends Labels = Labels> {
-    labels?: T;
-}
-/**
- * Returns true if the source object has all the labels from the required set
- * @param source Source object to check against
- * @param required Set of labels to check for in source
- * @returns True of the source object has all the labels from the required set
- */
-declare const hasAllLabels: (source?: Labels, required?: Labels) => boolean;
-
-declare const ModuleLimitationLabelName = "network.xyo.module.limitation";
-type ModuleLimitationLabelName = typeof ModuleLimitationLabelName;
-declare const ModuleLimitationViewLabel: {
-    ModuleLimitationLabelName: string;
-};
-
-type CosigningAddressSet = Address[];
-interface ModuleSecurityConfig {
-    /** @field Will the module process queries that have unsigned BoundWitness in query tuples */
-    readonly allowAnonymous?: boolean;
-    /** @field If schema in record, then only these address sets can access query */
-    readonly allowed?: Record<Schema, (Address | CosigningAddressSet)[]>;
-    /** @field If schema in record, then anyone except these addresses can access query */
-    readonly disallowed?: Record<Schema, Address[]>;
-}
-
-interface ModuleConfigFields {
-    /** Limit to only these allowed queries */
-    readonly allowedQueries?: Schema[];
-    /** @field The name/address of the Archivist to use for this module */
-    readonly archivist?: ModuleIdentifier;
-    /**
-     * @field The labels used for this module. If a label is specified, then the
-     * ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding
-     * labels to construct this module.
-     */
-    readonly labels?: Labels;
-    readonly logLevel?: LogLevel;
-    /** @field Friendly name of module (not collision resistant). Can be used to resolve module when registered/attached to Node. */
-    readonly name?: ModuleName;
-    /** @field paging settings for queries */
-    readonly paging?: Record<string, {
-        size?: number;
-    }>;
-    readonly retry?: RetryConfig;
-    /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module.
-     * If both allowed and disallowed is specified, then disallowed takes priority. */
-    readonly security?: ModuleSecurityConfig;
-    /** @field sign every query */
-    readonly sign?: boolean;
-    /** @field Store the queries made to the module in an archivist if possible */
-    readonly storeQueries?: boolean;
-    /** @field add a timestamp payload to every query  */
-    readonly timestamp?: boolean;
-}
-
-interface ArchivingReentrancyConfig {
-    readonly reentrancy?: {
-        action: 'skip' | 'wait';
-        scope: 'global';
-    };
-}
-
-declare const ModuleConfigSchema: "network.xyo.module.config";
-type ModuleConfigSchema = typeof ModuleConfigSchema;
-type WithAdditional<T extends EmptyObject = EmptyObject, TAdditional extends EmptyObject = EmptyObject> = T & TAdditional;
-type ModuleConfig<TConfig extends EmptyObject | Payload = EmptyObject, TSchema extends Schema | void = void> = Payload<WithAdditional<ArchivingModuleConfig & ModuleConfigFields & ArchivingReentrancyConfig, TConfig>, TSchema extends void ? TConfig extends Payload ? TConfig['schema'] : Schema : TSchema>;
-type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & {
-    schema: Schema;
-} = Omit<ModuleConfig, 'schema'> & {
-    schema: Schema;
-}> = ModuleConfig<TConfig, string>;
-type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {
-    schema?: TConfig['schema'];
-};
-type AnyModuleConfig = AnyConfigSchema<ModuleConfig>;
-
-type ModuleEventArgs<TModule extends object = object, TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs ? {
-    mod: TModule;
-} & TArgs : {
-    mod: TModule;
-};
-
-type ModuleBusyEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
-    busy: boolean;
-}>;
-interface ModuleBusyEventData<TModule extends object = object> extends EventData {
-    moduleBusy: ModuleBusyEventArgs<TModule>;
-}
-
-type ModuleErrorEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
-    error: Error;
-}>;
-interface ModuleErrorEventData<TModule extends object = object> extends EventData {
-    moduleError: ModuleErrorEventArgs<TModule>;
-}
-
-type ModuleQueryResult<P extends Payload = Payload, E extends ModuleError = ModuleError, B extends BoundWitness = BoundWitness> = [
-    WithoutPrivateStorageMeta<B>,
-    WithoutPrivateStorageMeta<P>[],
-    WithoutPrivateStorageMeta<E>[]
-];
-
-type ModuleQueriedEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
-    payloads?: Payload[];
-    query: QueryBoundWitness;
-    result: ModuleQueryResult;
-}>;
-interface ModuleQueriedEventData<TModule extends object = object> extends EventData {
-    moduleQueried: ModuleQueriedEventArgs<TModule>;
-}
-
-interface ModuleEventData<TModule extends object = object> extends ModuleQueriedEventData<TModule>, ModuleBusyEventData<TModule>, ModuleErrorEventData<TModule> {
-}
-
-type ModuleIdentifierTransformerFunc = (id: ModuleIdentifier) => Promisable<ModuleIdentifier | undefined>;
-interface ModuleIdentifierTransformer {
-    transform: ModuleIdentifierTransformerFunc;
-}
-
-interface ModuleStatusReporter extends CreatableStatusReporter {
-}
-
-type ModuleChildrenParams = {
-    privateChildren?: ModuleInstance[];
-    publicChildren?: ModuleInstance[];
-};
-interface ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> extends CreatableParams, ModuleChildrenParams {
-    account?: AccountInstance | 'random';
-    addToResolvers?: boolean;
-    additionalSigners?: AccountInstance[];
-    allowNameResolution?: boolean;
-    config: Partial<TConfig>;
-    ephemeralQueryAccountEnabled?: boolean;
-    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
-    statusReporter?: ModuleStatusReporter;
-}
-
-interface ModuleFields<TParams extends ModuleParams = ModuleParams> {
-    address: Address;
-    config: TParams['config'];
-    /** The name (if specified) or address of the module */
-    id: string;
-    modName?: ModuleName;
-    params: TParams;
-    previousHash: () => Promisable<string | undefined>;
-    queries: string[];
-    query: <T extends QueryBoundWitness = QueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConf) => Promisable<ModuleQueryResult>;
-    queryable: <T extends QueryBoundWitness = QueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConf) => Promisable<boolean>;
-    start?: () => Promisable<boolean>;
-    stop?: () => Promisable<boolean>;
-}
-
-interface Module<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData<object> = ModuleEventData<object>> extends ModuleFields<TParams>, EventEmitter<TEventData> {
-}
-
-declare const asModule: _xylabs_object.AsTypeFunction<Module<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
-
-declare const asModuleObject: _xylabs_object.AsTypeFunction<Module<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
-
-declare const requiredModuleQueries: Schema[];
-declare const isModule: TypeCheck<Module>;
-
-type ModuleTypeCheck<T extends Module = Module> = TypeCheck<T>;
-declare class IsModuleFactory<T extends Module = Module> {
-    create(expectedQueries?: string[], additionalChecks?: TypeCheck<AnyObject | EmptyObject>[]): ModuleTypeCheck<T>;
-}
-
-declare const requiredModuleShape: ObjectTypeShape;
-declare const isModuleObject: TypeCheck<Module>;
-
-declare const AddressSchema: "network.xyo.address";
-type AddressSchema = typeof AddressSchema;
-declare const AddressChildSchema: "network.xyo.address.child";
-type AddressChildSchema = typeof AddressChildSchema;
-interface AddressFields {
-    address: Address;
-}
-type AddressPayload = Payload<AddressFields, AddressSchema>;
-/**
- * Identity function for determining if an object is an Address
- */
-declare const isAddressPayload: (x?: unknown | null) => x is AddressPayload;
-declare const asAddressPayload: _xylabs_object.AsTypeFunction<AddressPayload>;
-declare const asOptionalAddressPayload: (value: _xylabs_promise.AnyNonPromise) => AddressPayload | undefined;
-interface AddressChildFields extends AddressFields {
-    /**
-     * The derivation path of the child address
-     */
-    path?: string;
-    /**
-     * The public address of the root of the hierarchy
-     */
-    root?: Address;
-}
-type AddressChildPayload = Payload<AddressChildFields, AddressChildSchema>;
-
-declare const AddressPreviousHashSchema: "network.xyo.address.hash.previous";
-type AddressPreviousHashSchema = typeof AddressPreviousHashSchema;
-type AddressPreviousHashPayload = Payload<{
-    address: Address;
-    previousHash?: string;
-}, AddressPreviousHashSchema>;
-
-interface ModuleDescription {
-    address: Address;
-    children?: string[];
-    name?: ModuleName;
-    queries: string[];
-}
-
-declare const ModuleDescriptionSchema: "network.xyo.module.description";
-type ModuleDescriptionSchema = typeof ModuleDescriptionSchema;
-type ModuleDescriptionPayload = Payload<ModuleDescription, ModuleDescriptionSchema>;
-
-interface StateDictionary {
-    [key: string]: string | number;
-}
-interface State<T extends StateDictionary = StateDictionary> {
-    state: T;
-}
-declare const ModuleStateSchema: "network.xyo.module.state";
-type ModuleStateSchema = typeof ModuleStateSchema;
-type ModuleState<T extends StateDictionary = StateDictionary> = Payload<State<T>, ModuleStateSchema>;
-declare const isModuleState: <T extends StateDictionary = StateDictionary>(payload?: unknown) => payload is ModuleState<T>;
-declare const isModuleStateWithSources: <T extends StateDictionary = StateDictionary>(payload?: unknown) => payload is WithSources<ModuleState<T>>;
-declare const asModuleState: _xylabs_object.AsTypeFunction<ModuleState<StateDictionary>>;
-declare const asOptionalModuleState: (value: _xylabs_promise.AnyNonPromise) => ModuleState<StateDictionary> | undefined;
-
-interface ModuleQueryFunctions {
-    manifest: (maxDepth?: number, ignoreAddresses?: Address[]) => Promisable<ModuleManifestPayload>;
-    manifestQuery: (account: AccountInstance, maxDepth?: number, ignoreAddresses?: Address[]) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
-    moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
-    state: () => Promisable<Payload[]>;
-    stateQuery: (account: AccountInstance) => Promisable<ModuleQueryResult>;
-}
-
-type Direction = 'up' | 'down' | 'all';
-type Visibility = 'public' | 'private' | 'all';
-interface ResolveStrategy {
-    maxDepth?: number;
-    required?: boolean | 'warn' | 'log';
-    retry?: number;
-    timeout?: number;
-}
-interface ObjectFilterOptions<T extends EmptyObject = AnyObject> extends ResolveStrategy {
-    direction?: Direction;
-    identity?: TypeCheck<T>;
-}
-interface AddressObjectFilter<T extends EmptyObject = AnyObject> extends ObjectFilterOptions<T> {
-    address: Address[];
-}
-declare const isAddressObjectFilter: <T extends EmptyObject = AnyObject>(value: unknown) => value is AddressObjectFilter<T>;
-interface NameObjectFilter<T extends EmptyObject = AnyObject> extends ObjectFilterOptions<T> {
-    name: ModuleName[];
-}
-declare const isNameObjectFilter: <T extends EmptyObject = AnyObject>(value: unknown) => value is NameObjectFilter<T>;
-interface QueryObjectFilter<T extends EmptyObject = AnyObject> extends ObjectFilterOptions<T> {
-    query: string[][];
-}
-declare const isQueryObjectFilter: <T extends EmptyObject = AnyObject>(value: unknown) => value is QueryObjectFilter<T>;
-type AnyObjectFilter<T extends EmptyObject = AnyObject> = Partial<AddressObjectFilter<T>> & Partial<NameObjectFilter<T>> & Partial<QueryObjectFilter<T>>;
-type ObjectFilter<T extends EmptyObject> = ObjectFilterOptions<T> | AddressObjectFilter<T> | NameObjectFilter<T> | QueryObjectFilter<T>;
-
-declare const isObjectResolver: <T extends EmptyObject = AnyObject>(value?: unknown) => value is ObjectResolver<T>;
-declare const ObjectResolverPriority: {
-    readonly Disabled: -1;
-    readonly VeryLow: 0;
-    readonly Low: 1;
-    readonly Normal: 2;
-    readonly High: 3;
-    readonly VeryHigh: 4;
-};
-type ObjectResolverPriority = typeof ObjectResolverPriority[keyof typeof ObjectResolverPriority];
-interface ObjectResolver<TResult extends EmptyObject> {
-    priority: ObjectResolverPriority;
-    /** @deprecated do not pass undefined.  If trying to get all, pass '*' */
-    resolve<T extends TResult = TResult>(): Promisable<T | undefined>;
-    resolve<T extends TResult = TResult>(all: '*', options?: ObjectFilterOptions<T>): Promisable<T[]>;
-    resolve<T extends TResult = TResult>(id: ModuleIdentifier, options?: ObjectFilterOptions<T>): Promisable<T | undefined>;
-    resolve<T extends TResult = TResult>(id?: ModuleIdentifier, options?: ObjectFilterOptions<T>): Promisable<T | T[] | undefined>;
-    resolvePrivate<T extends TResult = TResult>(all: '*', options?: ObjectFilterOptions<T>): Promise<T[]>;
-    resolvePrivate<T extends TResult = TResult>(id: ModuleIdentifier, options?: ObjectFilterOptions<T>): Promise<T | undefined>;
-    resolvePrivate<T extends TResult = TResult>(id: ModuleIdentifier, options?: ObjectFilterOptions<T>): Promise<T | T[] | undefined>;
-}
-interface ObjectResolverInstance<TResult extends EmptyObject> extends ObjectResolver<TResult> {
-    addResolver: (resolver: ObjectResolverInstance<TResult>) => this;
-    removeResolver: (resolver: ObjectResolverInstance<TResult>) => this;
-}
-
-type ModulePipeLine = Lowercase<'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many'>;
-type ModuleStatus = CreatableStatus | 'wrapped' | 'proxy';
-declare class DeadModuleError extends Error {
-    id: ModuleIdentifier;
-    error: Error | undefined;
-    constructor(id: ModuleIdentifier, error: Error | undefined, msg?: string);
-}
-interface AddressToWeakInstanceCache {
-    get: (address: Address) => WeakRef<ModuleInstance> | null;
-    set: (address: Address, instance: WeakRef<ModuleInstance> | null) => void;
-}
-interface ModuleFamilyFunctions {
-    account?: AccountInstance;
-    addParent: (mod: ModuleInstance) => void;
-    addressCache?: (direction: Direction, includePrivate: boolean) => AddressToWeakInstanceCache | undefined;
-    modName?: ModuleName;
-    parents: () => Promisable<ModuleInstance[]>;
-    privateChildren: () => Promisable<ModuleInstance[]>;
-    publicChildren: () => Promisable<ModuleInstance[]>;
-    removeParent: (address: Address) => void;
-    siblings: () => Promisable<ModuleInstance[]>;
-}
-interface ModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData> extends Module<TParams, TEventData>, ObjectResolver<ModuleInstance>, ModuleQueryFunctions, ModuleFamilyFunctions {
-    readonly pipeline?: ModulePipeLine;
-    readonly status: ModuleStatus;
-}
-type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = TypeCheck<T>;
-declare class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {
-}
-
-declare const asModuleInstance: _xylabs_object.AsTypeFunction<ModuleInstance<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
-
-declare const isModuleResolver: (value?: unknown) => value is ObjectResolver<ModuleInstance<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
-interface ModuleResolver<TResult extends ModuleInstance = ModuleInstance> extends ObjectResolver<TResult> {
-}
-interface ModuleNameResolver {
-    readonly root: ModuleInstance;
-    resolveIdentifier(id: ModuleIdentifier, options?: ObjectFilterOptions): Promisable<Address | undefined>;
-}
-interface ModuleResolverInstance<TResult extends ModuleInstance = ModuleInstance> extends ModuleResolver<TResult>, ModuleNameResolver {
-    addResolver: (resolver: ModuleResolverInstance<TResult>) => this;
-    removeResolver: (resolver: ModuleResolverInstance<TResult>) => this;
-}
-
-interface AttachableModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData> extends ModuleInstance<TParams, TEventData>, CreatableInstance<TParams, TEventData> {
-    config: TParams['config'];
-    readonly downResolver: ModuleResolverInstance;
-    readonly privateResolver: ModuleResolverInstance;
-    readonly upResolver: ModuleResolverInstance;
-}
-type AttachableModuleInstanceTypeCheck<T extends AttachableModuleInstance = AttachableModuleInstance> = TypeCheck<T>;
-declare class IsAttachableModuleInstanceFactory<T extends AttachableModuleInstance = AttachableModuleInstance> extends IsObjectFactory<T> {
-}
-
-declare const asAttachableModuleInstance: _xylabs_object.AsTypeFunction<AttachableModuleInstance<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
-
-declare const requiredAttachableModuleInstanceFunctions: ObjectTypeShape;
-declare const isAttachableModuleInstance: TypeCheck<AttachableModuleInstance>;
-
-declare const requiredModuleInstanceFunctions: ObjectTypeShape;
-declare const isModuleInstance: TypeCheck<ModuleInstance>;
-
-interface ModuleFilterOptions<T extends ModuleInstance = ModuleInstance> extends ObjectFilterOptions<T> {
-}
-declare const isAddressModuleFilter: (value: unknown) => value is AddressObjectFilter<ModuleInstance<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
-declare const isNameModuleFilter: (value: unknown) => value is NameObjectFilter<ModuleInstance<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
-declare const isQueryModuleFilter: (value: unknown) => value is QueryObjectFilter<ModuleInstance<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
-type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = AnyObjectFilter<T>;
-type AddressModuleFilter<T extends ModuleInstance = ModuleInstance> = AddressObjectFilter<T>;
-type NameModuleFilter<T extends ModuleInstance = ModuleInstance> = NameObjectFilter<T>;
-type QueryModuleFilter<T extends ModuleInstance = ModuleInstance> = QueryObjectFilter<T>;
-/** @deprecated use ModuleIdentifier instead */
-type ModuleFilter<T extends ModuleInstance = ModuleInstance> = ObjectFilter<T>;
-
-interface ModuleRepository<T extends ModuleInstance = ModuleInstance> extends ModuleResolverInstance<T> {
-    add(mod: T): this;
-    add(mod: T[]): this;
-    add(mod: T | T[]): this;
-    remove(address: Address | string[]): this;
-}
-
-type LabeledCreatableModuleFactory<T extends CreatableModuleInstance = CreatableModuleInstance> = CreatableModuleFactory<T> & WithOptionalLabels;
-declare const hasLabels: (factory: CreatableModuleFactory | LabeledCreatableModuleFactory) => factory is LabeledCreatableModuleFactory;
-/**
- * Class annotation to be used to decorate Modules which support
- * an asynchronous labeled creation factory pattern
- * @returns The decorated Module requiring it implement the members
- * of the CreatableModule as statics properties/methods
- */
-declare function labeledCreatableModuleFactory<TModule extends CreatableModuleInstance = CreatableModuleInstance>(): <U extends LabeledCreatableModuleFactory<TModule>>(constructor: U) => void;
-
-interface CreatableModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData> extends CreatableInstance<TParams, TEventData>, AttachableModuleInstance<TParams, TEventData> {
-}
-interface CreatableModuleFactory<T extends CreatableModuleInstance = CreatableModuleInstance> extends Omit<CreatableModule<T>, 'create' | 'createHandler' | 'paramsHandler'> {
-    creatableModule: CreatableModule<T>;
-    defaultParams?: Partial<T['params']>;
-    create(this: CreatableModuleFactory<T>, params?: Partial<T['params']>): Promise<T>;
-}
-interface LabeledCreatableModule<T extends CreatableModuleInstance = CreatableModuleInstance> extends CreatableModule<T>, WithOptionalLabels {
-    factory(params?: Partial<T['params']>): LabeledCreatableModuleFactory<T>;
-}
-interface CreatableModule<T extends CreatableModuleInstance = CreatableModuleInstance> extends Creatable<T> {
-    configSchemas: Schema[];
-    defaultConfigSchema: Schema;
-    defaultLogger?: Logger;
-    new (key: unknown, params: Partial<T['params']>): T;
-    factory(params?: Partial<T['params']>): CreatableModuleFactory<T>;
-}
-/**
- * Class annotation to be used to decorate Modules which support
- * an asynchronous creation pattern
- * @returns The decorated Module requiring it implement the members
- * of the CreatableModule as statics properties/methods
- */
-declare function creatableModule<TModule extends CreatableModuleInstance = CreatableModuleInstance>(): <U extends CreatableModule<TModule>>(constructor: U) => void;
-/**
- * Class annotation to be used to decorate Modules which support
- * an asynchronous creation pattern
- * @returns The decorated Module requiring it implement the members
- * of the CreatableModule as statics properties/methods
- */
-declare function labeledCreatableModule<TModule extends CreatableModuleInstance = CreatableModuleInstance>(): <U extends LabeledCreatableModule<TModule>>(constructor: U) => void;
-
-interface CreatableModuleRegistry {
-    [key: Schema]: (CreatableModuleFactory | LabeledCreatableModuleFactory)[] | undefined;
-}
-declare const registerCreatableModuleFactory: <TModule extends CreatableModuleInstance>(registry: CreatableModuleRegistry, factory: CreatableModuleFactory<TModule> | LabeledCreatableModuleFactory<TModule>, labels?: Labels, 
-/** register this as the primary factory for every schema it supports */
-primary?: boolean | Schema | Schema[]) => void;
-declare const registerCreatableModuleFactories: (factories: (CreatableModuleFactory | LabeledCreatableModuleFactory)[], registry?: CreatableModuleRegistry, primary?: boolean) => CreatableModuleRegistry;
-/** @deprecated use registerCreatableModuleFactory instead */
-declare const assignCreatableModuleRegistry: (target?: CreatableModuleRegistry, ...sources: CreatableModuleRegistry[]) => CreatableModuleRegistry;
-
-declare class ModuleFactory<TModule extends CreatableModuleInstance> implements CreatableModuleFactory<TModule> {
-    configSchemas: CreatableModule<TModule>['configSchemas'];
-    creatableModule: CreatableModule<TModule>;
-    defaultConfigSchema: Schema;
-    defaultLogger?: Logger;
-    defaultParams?: Partial<TModule['params']>;
-    labels?: Labels;
-    constructor(creatableModule: CreatableModule<TModule>, params?: Partial<TModule['params']>, labels?: Labels);
-    static withParams<T extends CreatableModuleInstance>(creatableModule: CreatableModule<T>, params?: Partial<T['params']>, labels?: Labels): ModuleFactory<T>;
-    create(this: CreatableModuleFactory<TModule>, params?: Partial<TModule['params']>): Promise<TModule>;
-    factory<T extends CreatableModuleInstance>(this: CreatableModuleFactory<T>, params?: Partial<T['params']>, labels?: Labels): CreatableModuleFactory<T>;
-}
-
-declare class ModuleDetailsError extends Error {
-    details?: JsonValue | undefined;
-    constructor(message: string, details?: JsonValue | undefined);
-}
-
-/**
- * Used to filter duplicates from an array of modules
- * @example: modulesArray.filter(duplicateModules)
- * @param value Current Module
- * @param index Current Module's index
- * @param array Module Array
- * @returns True if the Module's address is the first occurrence of
- * that address in the array, false otherwise
- */
-declare const duplicateModules: (value: Module, index: number, array: Module[]) => value is Module;
-
-declare const isSerializable: (value: unknown, maxDepth?: number) => boolean;
-
-interface ModuleFactoryLocatorInstance {
-    /**
-     * The current registry for the module factory
-     */
-    registry: Readonly<CreatableModuleRegistry>;
-    freeze(): void;
-    /**
-     * Locates a module factory that matches the supplied schema and labels
-     * @param schema The config schema for the module
-     * @param labels The labels for the module factory
-     * @returns A module factory that matches the supplied schema and labels or throws if one is not found
-     */
-    locate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory;
-    merge(locator: ModuleFactoryLocatorInstance): ModuleFactoryLocatorInstance;
-    /**
-     * Registers a single module factory (with optional tags) with the locator
-     * @param factory The factory to register
-     * @param labels The labels for the module factory
-     */
-    register(factory: CreatableModuleFactory, labels?: Labels, primary?: boolean | Schema | Schema[]): ModuleFactoryLocatorInstance;
-    /**
-     * Registers multiple module factories with the locator
-     * @param factories The factories to register
-     */
-    registerMany(factories: CreatableModuleFactory[]): ModuleFactoryLocatorInstance;
-    /**
-     * Tries to locate a module factory that matches the supplied schema and labels
-     * @param schema The config schema for the module
-     * @param labels The labels for the module factory
-     * @returns A module factory that matches the supplied schema and labels or undefined
-     */
-    tryLocate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory | undefined;
-}
-
-type ModuleQueryHandlerResult = Payload[];
-
-declare const ModuleManifestQuerySchema: "network.xyo.query.module.manifest";
-type ModuleManifestQuerySchema = typeof ModuleManifestQuerySchema;
-type ModuleManifestQuery = Query<{
-    maxDepth?: number;
-    schema: ModuleManifestQuerySchema;
-}>;
-
-declare const ModuleAddressQuerySchema: "network.xyo.query.module.address";
-type ModuleAddressQuerySchema = typeof ModuleAddressQuerySchema;
-type ModuleAddressQuery = Query<{
-    schema: ModuleAddressQuerySchema;
-}>;
-
-declare const ModuleStateQuerySchema: "network.xyo.query.module.state";
-type ModuleStateQuerySchema = typeof ModuleStateQuerySchema;
-type ModuleStateQuery = Query<void, ModuleStateQuerySchema>;
-
-declare const ModuleSubscribeQuerySchema: "network.xyo.query.module.subscribe";
-type ModuleSubscribeQuerySchema = typeof ModuleSubscribeQuerySchema;
-interface ModuleSubscribeFilter {
-    /** @field if specified, at least one of the schemas must be present in the boundwtness to generate a notification */
-    schema?: string[];
-}
-type ModuleSubscribeQuery = Query<{
-    /** @field The address that will receive notifications */
-    address: Address;
-    /** @field A subscribe with a null for filter is an unsubscribe */
-    filter?: ModuleSubscribeFilter | null;
-    /** @field The maximum events queued per send [may increase frequency] */
-    maxQueue?: number;
-    schema: ModuleSubscribeQuerySchema;
-}>;
-
-type ModuleQueries = ModuleAddressQuery | ModuleSubscribeQuery | ModuleManifestQuery | ModuleStateQuery;
-
-type ModuleResolveDirection = 'all' | 'up' | 'down';
-
-declare const resolveAddressToInstanceDown: (root: ModuleInstance, address: Address, includePrivate?: boolean | undefined, ignore?: Address[]) => Promise<ModuleInstance | undefined>;
-declare const resolveAddressToInstanceSiblings: (root: ModuleInstance, address: Address, includePrivate?: boolean | undefined, ignore?: Address[]) => Promise<ModuleInstance | undefined>;
-declare const resolveAddressToInstanceUp: (root: ModuleInstance, address: Address, includePrivate?: boolean | undefined, ignore?: Address[]) => Promise<ModuleInstance | undefined>;
-declare const resolveAddressToInstanceAll: (root: ModuleInstance, address: Address, includePrivate?: boolean | undefined, ignore?: Address[]) => Promise<ModuleInstance | undefined>;
-declare const resolveAddressToInstance: (root: ModuleInstance, address: Address, includePrivate?: boolean | undefined, ignore?: Address[], direction?: ModuleResolveDirection) => Promise<ModuleInstance | undefined>;
-
-declare const resolveAllUp: (root: ModuleInstance, maxDepth?: number, exclude?: Address[]) => Promise<ModuleInstance[]>;
-declare const resolveAllDown: (root: ModuleInstance, maxDepth?: number, exclude?: Address[], includePrivate?: boolean) => Promise<ModuleInstance[]>;
-declare const resolveAll: (root: ModuleInstance, maxDepth?: number, exclude?: Address[]) => Promise<ModuleInstance[]>;
-
-declare class ResolveHelperStatic {
-    static readonly defaultLogger?: Logger;
-    static transformers: ModuleIdentifierTransformer[];
-}
-
-interface ResolveHelperConfig {
-    address: Address;
-    dead?: boolean;
-    downResolver?: ModuleResolver;
-    logger?: Logger;
-    mod: ModuleInstance;
-    privateResolver?: ModuleResolver;
-    transformers: ModuleIdentifierTransformer[];
-    upResolver?: ModuleResolver;
-}
-declare class ResolveHelper extends ResolveHelperStatic {
-    static resolve<T extends ModuleInstance = ModuleInstance>(config: ResolveHelperConfig, all: '*', options?: ModuleFilterOptions<T>): Promise<T[]>;
-    static resolve<T extends ModuleInstance = ModuleInstance>(config: ResolveHelperConfig, id: ModuleIdentifier, options?: ModuleFilterOptions<T>): Promise<T | undefined>;
-    static resolveModuleIdentifier<T extends ModuleInstance = ModuleInstance>(resolver: ModuleResolver, path: ModuleIdentifier, required?: boolean): Promise<T | undefined>;
-    static traceModuleIdentifier(resolver: ModuleResolver, path: ModuleIdentifier): Promise<Lowercase<string>[]>;
-    static transformModuleIdentifier(identifier: ModuleIdentifier, transformers?: ModuleIdentifierTransformer[]): Promise<string | undefined>;
-    static validateRequiredResolve(required: boolean | 'warn' | 'log', result: ModuleInstance[] | ModuleInstance | undefined, id: ModuleIdentifier, logger?: Logger | undefined): void;
-}
-
-declare const resolveLocalNameToAddressUp: (root: ModuleInstance, modName: ModuleName) => Promise<Address | undefined>;
-declare const resolveLocalNameToAddressDown: (root: ModuleInstance, modName: ModuleName, includePrivate?: boolean | undefined) => Promise<Address | undefined>;
-declare const resolveLocalNameToAddressAll: (root: ModuleInstance, modName: ModuleName, includePrivate?: boolean | undefined) => Promise<Address | undefined>;
-declare const resolveLocalNameToAddress: (root: ModuleInstance, modName: ModuleName, includePrivate?: boolean | undefined, direction?: ModuleResolveDirection) => Promise<Address | undefined>;
-
-declare const resolveLocalNameToInstanceUp: (root: ModuleInstance, modName: ModuleName) => Promise<ModuleInstance | undefined>;
-declare const resolveLocalNameToInstanceDown: (root: ModuleInstance, modName: ModuleName, includePrivate?: boolean | undefined) => Promise<ModuleInstance | undefined>;
-declare const resolveLocalNameToInstanceAll: (root: ModuleInstance, modName: ModuleName, includePrivate?: boolean) => Promise<ModuleInstance | undefined>;
-declare const resolveLocalNameToInstance: (root: ModuleInstance, modName: ModuleName, includePrivate?: boolean, direction?: ModuleResolveDirection) => Promise<ModuleInstance | undefined>;
-
-declare const resolvePathToAddress: (root: ModuleInstance, path: string, includePrivate?: boolean | undefined, transformers?: ModuleIdentifierTransformer[]) => Promise<Address | undefined>;
-
-declare const resolvePathToInstance: (root: ModuleInstance, path: string, includePrivate?: boolean | undefined, transformers?: ModuleIdentifierTransformer[]) => Promise<ModuleInstance | undefined>;
-
-declare const transformModuleIdentifier: (id: ModuleIdentifier, transformers: ModuleIdentifierTransformer[]) => Promise<ModuleIdentifier | undefined>;
-
-declare const WithFactory: {
-    create: <T extends object>(typeCheck: TypeCheck<T>) => <R>(mod: any, closure: (mod: T) => R) => R | undefined;
-};
-declare const withModule: <R>(mod: any, closure: (mod: Module<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>) => R) => R | undefined;
-declare const withModuleInstance: <R>(mod: any, closure: (mod: ModuleInstance<ModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>) => R) => R | undefined;
-
-export { AddressChildSchema, AddressPreviousHashSchema, AddressSchema, DeadModuleError, DisallowedModuleIdentifierCharacters, IsAttachableModuleInstanceFactory, IsInstanceFactory, IsModuleFactory, MODULE_PATH_SEPARATOR, ModuleAddressQuerySchema, ModuleConfigSchema, ModuleDescriptionSchema, ModuleDetailsError, ModuleFactory, ModuleLimitationLabelName, ModuleLimitationViewLabel, ModuleManifestQuerySchema, ModuleStateQuerySchema, ModuleStateSchema, ModuleSubscribeQuerySchema, ObjectResolverPriority, ReservedModuleIdentifierCharacters, ResolveHelper, WithFactory, asAddressPayload, asAttachableModuleInstance, asModule, asModuleInstance, asModuleObject, asModuleState, asOptionalAddressPayload, asOptionalModuleState, assignCreatableModuleRegistry, creatableModule, duplicateModules, hasAllLabels, hasLabels, includesReservedModuleIdentifierCharacter, isAddressModuleFilter, isAddressObjectFilter, isAddressPayload, isAttachableModuleInstance, isModule, isModuleIdentifierPart, isModuleInstance, isModuleName, isModuleObject, isModuleResolver, isModuleState, isModuleStateWithSources, isNameModuleFilter, isNameObjectFilter, isObjectResolver, isQueryModuleFilter, isQueryObjectFilter, isSerializable, labeledCreatableModule, labeledCreatableModuleFactory, registerCreatableModuleFactories, registerCreatableModuleFactory, requiredAttachableModuleInstanceFunctions, requiredModuleInstanceFunctions, requiredModuleQueries, requiredModuleShape, resolveAddressToInstance, resolveAddressToInstanceAll, resolveAddressToInstanceDown, resolveAddressToInstanceSiblings, resolveAddressToInstanceUp, resolveAll, resolveAllDown, resolveAllUp, resolveLocalNameToAddress, resolveLocalNameToAddressAll, resolveLocalNameToAddressDown, resolveLocalNameToAddressUp, resolveLocalNameToInstance, resolveLocalNameToInstanceAll, resolveLocalNameToInstanceDown, resolveLocalNameToInstanceUp, resolvePathToAddress, resolvePathToInstance, transformModuleIdentifier, withModule, withModuleInstance };
-export type { AddressChildFields, AddressChildPayload, AddressFields, AddressModuleFilter, AddressObjectFilter, AddressPayload, AddressPreviousHashPayload, AddressToWeakInstanceCache, AnyConfigSchema, AnyModuleConfig, AnyModuleFilter, AnyObjectFilter, ArchivingModuleConfig, ArchivingReentrancyConfig, AttachableModuleInstance, AttachableModuleInstanceTypeCheck, CacheConfig, ColonPair, CosigningAddressSet, CreatableModule, CreatableModuleFactory, CreatableModuleInstance, CreatableModuleRegistry, Direction, InstanceTypeCheck, LabeledCreatableModule, LabeledCreatableModuleFactory, Labels, Module, ModuleAddressQuery, ModuleBusyEventArgs, ModuleBusyEventData, ModuleChildrenParams, ModuleConfig, ModuleConfigFields, ModuleDescription, ModuleDescriptionPayload, ModuleErrorEventArgs, ModuleErrorEventData, ModuleEventArgs, ModuleEventData, ModuleFactoryLocatorInstance, ModuleFamilyFunctions, ModuleFields, ModuleFilter, ModuleFilterOptions, ModuleIdentifier, ModuleIdentifierPart, ModuleIdentifierTransformer, ModuleIdentifierTransformerFunc, ModuleInstance, ModuleManifestQuery, ModuleName, ModuleNameResolver, ModuleParams, ModulePipeLine, ModuleQueriedEventArgs, ModuleQueriedEventData, ModuleQueries, ModuleQueryFunctions, ModuleQueryHandlerResult, ModuleQueryResult, ModuleRepository, ModuleResolveDirection, ModuleResolver, ModuleResolverInstance, ModuleSecurityConfig, ModuleState, ModuleStateQuery, ModuleStatus, ModuleStatusReporter, ModuleSubscribeFilter, ModuleSubscribeQuery, ModuleTypeCheck, NameModuleFilter, NameObjectFilter, ObjectFilter, ObjectFilterOptions, ObjectResolver, ObjectResolverInstance, OptionalConfigSchema, QueryModuleFilter, QueryObjectFilter, ReservedModuleIdentifierCharacter, ResolveHelperConfig, ResolveStrategy, State, StateDictionary, Visibility, WithAdditional, WithLabels, WithOptionalLabels };
+export * from './cache.ts';
+export * from './Config/index.ts';
+export * from './CreatableModule/index.ts';
+export * from './DetailsError.ts';
+export * from './EventsModels/index.ts';
+export * from './instance/index.ts';
+export * from './Labels/index.ts';
+export * from './lib/index.ts';
+export * from './module/index.ts';
+export * from './ModuleDescription.ts';
+export * from './ModuleFactoryLocatorInstance.ts';
+export * from './ModuleIdentifier.ts';
+export * from './ModuleIdentifierTransformer.ts';
+export * from './ModuleParams.ts';
+export * from './ModuleQueryHandlerResult.ts';
+export * from './ModuleQueryResult.ts';
+export * from './ModuleStatusReporter.ts';
+export * from './Payload/index.ts';
+export * from './Queries/index.ts';
+export * from './ResolveHelper/index.ts';
+export * from './withModule.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-model",
-  "version": "4.1.2",
+  "version": "4.1.4",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,25 +29,25 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.13.15",
-    "@xylabs/creatable": "^4.13.15",
-    "@xylabs/events": "^4.13.15",
-    "@xylabs/exists": "^4.13.15",
-    "@xylabs/hex": "^4.13.15",
-    "@xylabs/logger": "^4.13.15",
-    "@xylabs/object": "^4.13.15",
-    "@xylabs/promise": "^4.13.15",
-    "@xylabs/retry": "^4.13.15",
-    "@xylabs/typeof": "^4.13.15",
-    "@xyo-network/account-model": "^4.1.2",
-    "@xyo-network/boundwitness-model": "^4.1.2",
-    "@xyo-network/manifest-model": "^4.1.2",
-    "@xyo-network/payload-model": "^4.1.2"
+    "@xylabs/assert": "^4.13.16",
+    "@xylabs/creatable": "^4.13.16",
+    "@xylabs/events": "^4.13.16",
+    "@xylabs/exists": "^4.13.16",
+    "@xylabs/hex": "^4.13.16",
+    "@xylabs/logger": "^4.13.16",
+    "@xylabs/object": "^4.13.16",
+    "@xylabs/promise": "^4.13.16",
+    "@xylabs/retry": "^4.13.16",
+    "@xylabs/typeof": "^4.13.16",
+    "@xyo-network/account-model": "^4.1.4",
+    "@xyo-network/boundwitness-model": "^4.1.4",
+    "@xyo-network/manifest-model": "^4.1.4",
+    "@xyo-network/payload-model": "^4.1.4"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
-    "@xylabs/tsconfig": "^7.0.0-rc.23",
-    "@xylabs/vitest-extended": "^4.13.15",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/vitest-extended": "^4.13.16",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },