@xyo-network/module-abstract 2.72.8 → 2.73.0

package/dist/{types/AbstractModule.d.ts → index.d.mts}

@@ -1,16 +1,72 @@
-import { WalletInstance } from '@xyo-network/account/packages/wallet-model';
 import { AccountInstance } from '@xyo-network/account-model';
 import { ArchivistInstance } from '@xyo-network/archivist-model';
 import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
+import * as _xyo_network_boundwitness_model from '@xyo-network/boundwitness-model';
 import { BoundWitness } from '@xyo-network/boundwitness-model';
 import { ModuleManifestPayload } from '@xyo-network/manifest-model';
-import { AddressPreviousHashPayload, AnyConfigSchema, CreatableModule, CreatableModuleFactory, Module, ModuleConfig, ModuleDescriptionPayload, ModuleEventData, ModuleFilter, ModuleFilterOptions, ModuleInstance, ModuleParams, ModuleQueryBase, ModuleQueryHandlerResult, ModuleQueryResult, SchemaString } from '@xyo-network/module-model';
+import { AnyConfigSchema, ModuleConfig, SchemaString, AddressString, Module, ModuleParams, ModuleEventData, ModuleQueryBase, ModuleInstance, CreatableModule, CreatableModuleFactory, ModuleQueryResult, ModuleFilter, ModuleFilterOptions, ModuleDescriptionPayload, AddressPreviousHashPayload, ModuleQueryHandlerResult } from '@xyo-network/module-model';
 import { CompositeModuleResolver } from '@xyo-network/module-resolver';
-import { ModuleError, Payload, Query } from '@xyo-network/payload-model';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import { Payload, Query, ModuleError } from '@xyo-network/payload-model';
 import { Promisable, PromiseEx } from '@xyo-network/promise';
-import { BaseEmitter } from './BaseEmitter';
-import { Queryable } from './QueryValidator';
-export declare abstract class AbstractModule<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<ModuleConfig>, TEventData extends ModuleEventData = ModuleEventData> extends BaseEmitter<TParams, TEventData> implements Module<TParams, TEventData> {
+import { WalletInstance } from '@xyo-network/wallet-model';
+import { BaseParams, Base } from '@xyo-network/core';
+import { EventData, EventFunctions, EventListener, EventAnyListener } from '@xyo-network/module-events';
+import { PayloadBuilder } from '@xyo-network/payload-builder';
+
+declare class BaseEmitter<TParams extends BaseParams = BaseParams, TEventData extends EventData = EventData> extends Base<TParams> implements EventFunctions<TEventData> {
+    eventData: TEventData;
+    private events;
+    constructor(params: TParams);
+    clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): void;
+    emit<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
+    emitSerial<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
+    listenerCount(eventNames: keyof TEventData | (keyof TEventData)[]): number;
+    off<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): void;
+    offAny(listener: EventAnyListener): void;
+    on<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): () => void;
+    onAny(listener: EventAnyListener): () => void;
+    once<TEventName extends keyof TEventData>(eventName: TEventName, listener: EventListener<TEventData[TEventName]>): () => void;
+}
+
+type Queryable<T extends QueryBoundWitness = QueryBoundWitness> = (query: T, payloads?: Payload[]) => Promisable<boolean>;
+interface QueryValidator<T extends QueryBoundWitness = QueryBoundWitness> {
+    queryable: Queryable<T>;
+}
+
+type SortedPipedAddressesString = string;
+declare class ModuleConfigQueryValidator<TConfig extends AnyConfigSchema<ModuleConfig>> implements QueryValidator {
+    protected allowed: Record<SchemaString, SortedPipedAddressesString[]>;
+    protected disallowed: Record<SchemaString, AddressString[]>;
+    protected readonly hasAllowedRules: boolean;
+    protected readonly hasDisallowedRules: boolean;
+    protected readonly hasRules: boolean;
+    constructor(config?: TConfig);
+    queryable: Queryable;
+    protected queryAllowed: (schema: SchemaString, addresses: string[]) => boolean;
+    protected queryDisallowed: (schema: SchemaString, addresses: string[]) => boolean;
+}
+
+declare const isQuerySupportedByModule: <T extends _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
+    query: string;
+    resultSet?: string | undefined;
+    schema: "network.xyo.boundwitness";
+} & {
+    schema: "network.xyo.boundwitness";
+} = _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
+    query: string;
+    resultSet?: string | undefined;
+    schema: "network.xyo.boundwitness";
+} & {
+    schema: "network.xyo.boundwitness";
+}>(mod: Module, query: T, payloads?: Payload[]) => Promise<boolean>;
+declare class SupportedQueryValidator implements QueryValidator {
+    protected readonly mod: Module;
+    constructor(mod: Module);
+    queryable: Queryable;
+}
+
+declare abstract class AbstractModule<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<ModuleConfig>, TEventData extends ModuleEventData = ModuleEventData> extends BaseEmitter<TParams, TEventData> implements Module<TParams, TEventData> {
     static configSchemas: string[];
     static enableLazyLoad: boolean;
     protected static privateConstructorKey: string;
@@ -34,8 +90,8 @@ export declare abstract class AbstractModule<TParams extends ModuleParams<AnyCon
     get queries(): string[];
     get queryAccountPaths(): Readonly<Record<Query['schema'], string | undefined>>;
     get queryAccounts(): Readonly<Record<Query['schema'], AccountInstance | undefined>>;
-    protected abstract get _queryAccountPaths(): Record<Query['schema'], string>;
     get timestamp(): boolean;
+    protected abstract get _queryAccountPaths(): Record<Query['schema'], string>;
     static _getRootFunction(funcName: string): any;
     static _noOverride(functionName: string): void;
     static create<TModule extends ModuleInstance>(this: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & {
@@ -81,4 +137,27 @@ export declare abstract class AbstractModule<TParams extends ModuleParams<AnyCon
     protected writeArchivist: () => Promise<ArchivistInstance | undefined>;
     private getArchivist;
 }
-//# sourceMappingURL=AbstractModule.d.ts.map
+
+declare abstract class AbstractModuleInstance<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<ModuleConfig>, TEventData extends ModuleEventData = ModuleEventData> extends AbstractModule<TParams, TEventData> implements Module<TParams, TEventData> {
+    constructor(privateConstructorKey: string, params: TParams, account: AccountInstance);
+    describe(): Promise<ModuleDescriptionPayload>;
+    discover(): Promise<Payload[]>;
+    manifest(ignoreAddresses?: string[]): Promise<ModuleManifestPayload>;
+    moduleAddress(): Promise<AddressPreviousHashPayload[]>;
+    subscribe(_queryAccount?: AccountInstance): void;
+}
+
+declare class ModuleErrorBuilder extends PayloadBuilder {
+    _message?: string;
+    _name?: string;
+    _query?: string;
+    _sources?: string[];
+    constructor();
+    build(): ModuleError;
+    message(message: string): this;
+    name(name: string): this;
+    query(query: string): this;
+    sources(sources: string[]): this;
+}
+
+export { AbstractModule, AbstractModuleInstance, BaseEmitter, ModuleConfigQueryValidator, ModuleErrorBuilder, QueryValidator, Queryable, SortedPipedAddressesString, SupportedQueryValidator, isQuerySupportedByModule };

package/dist/index.d.ts

@@ -0,0 +1,163 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import { ArchivistInstance } from '@xyo-network/archivist-model';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
+import * as _xyo_network_boundwitness_model from '@xyo-network/boundwitness-model';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { ModuleManifestPayload } from '@xyo-network/manifest-model';
+import { AnyConfigSchema, ModuleConfig, SchemaString, AddressString, Module, ModuleParams, ModuleEventData, ModuleQueryBase, ModuleInstance, CreatableModule, CreatableModuleFactory, ModuleQueryResult, ModuleFilter, ModuleFilterOptions, ModuleDescriptionPayload, AddressPreviousHashPayload, ModuleQueryHandlerResult } from '@xyo-network/module-model';
+import { CompositeModuleResolver } from '@xyo-network/module-resolver';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import { Payload, Query, ModuleError } from '@xyo-network/payload-model';
+import { Promisable, PromiseEx } from '@xyo-network/promise';
+import { WalletInstance } from '@xyo-network/wallet-model';
+import { BaseParams, Base } from '@xyo-network/core';
+import { EventData, EventFunctions, EventListener, EventAnyListener } from '@xyo-network/module-events';
+import { PayloadBuilder } from '@xyo-network/payload-builder';
+
+declare class BaseEmitter<TParams extends BaseParams = BaseParams, TEventData extends EventData = EventData> extends Base<TParams> implements EventFunctions<TEventData> {
+    eventData: TEventData;
+    private events;
+    constructor(params: TParams);
+    clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): void;
+    emit<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
+    emitSerial<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
+    listenerCount(eventNames: keyof TEventData | (keyof TEventData)[]): number;
+    off<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): void;
+    offAny(listener: EventAnyListener): void;
+    on<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): () => void;
+    onAny(listener: EventAnyListener): () => void;
+    once<TEventName extends keyof TEventData>(eventName: TEventName, listener: EventListener<TEventData[TEventName]>): () => void;
+}
+
+type Queryable<T extends QueryBoundWitness = QueryBoundWitness> = (query: T, payloads?: Payload[]) => Promisable<boolean>;
+interface QueryValidator<T extends QueryBoundWitness = QueryBoundWitness> {
+    queryable: Queryable<T>;
+}
+
+type SortedPipedAddressesString = string;
+declare class ModuleConfigQueryValidator<TConfig extends AnyConfigSchema<ModuleConfig>> implements QueryValidator {
+    protected allowed: Record<SchemaString, SortedPipedAddressesString[]>;
+    protected disallowed: Record<SchemaString, AddressString[]>;
+    protected readonly hasAllowedRules: boolean;
+    protected readonly hasDisallowedRules: boolean;
+    protected readonly hasRules: boolean;
+    constructor(config?: TConfig);
+    queryable: Queryable;
+    protected queryAllowed: (schema: SchemaString, addresses: string[]) => boolean;
+    protected queryDisallowed: (schema: SchemaString, addresses: string[]) => boolean;
+}
+
+declare const isQuerySupportedByModule: <T extends _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
+    query: string;
+    resultSet?: string | undefined;
+    schema: "network.xyo.boundwitness";
+} & {
+    schema: "network.xyo.boundwitness";
+} = _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
+    query: string;
+    resultSet?: string | undefined;
+    schema: "network.xyo.boundwitness";
+} & {
+    schema: "network.xyo.boundwitness";
+}>(mod: Module, query: T, payloads?: Payload[]) => Promise<boolean>;
+declare class SupportedQueryValidator implements QueryValidator {
+    protected readonly mod: Module;
+    constructor(mod: Module);
+    queryable: Queryable;
+}
+
+declare abstract class AbstractModule<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<ModuleConfig>, TEventData extends ModuleEventData = ModuleEventData> extends BaseEmitter<TParams, TEventData> implements Module<TParams, TEventData> {
+    static configSchemas: string[];
+    static enableLazyLoad: boolean;
+    protected static privateConstructorKey: string;
+    readonly downResolver: Omit<CompositeModuleResolver, 'resolve'>;
+    readonly upResolver: Omit<CompositeModuleResolver, 'resolve>'>;
+    protected _account: AccountInstance | undefined;
+    protected readonly _baseModuleQueryAccountPaths: Record<ModuleQueryBase['schema'], string>;
+    protected readonly _queryAccounts: Record<ModuleQueryBase['schema'], AccountInstance | undefined>;
+    protected _startPromise: Promisable<boolean> | undefined;
+    protected _started: Promisable<boolean> | undefined;
+    protected readonly moduleConfigQueryValidator: Queryable;
+    protected readonly supportedQueryValidator: Queryable;
+    private _busyCount;
+    constructor(privateConstructorKey: string, params: TParams, account: AccountInstance);
+    static get configSchema(): string;
+    get account(): AccountInstance;
+    get address(): string;
+    get allowAnonymous(): boolean;
+    get config(): TParams['config'];
+    get ephemeralQueryAccountEnabled(): boolean;
+    get queries(): string[];
+    get queryAccountPaths(): Readonly<Record<Query['schema'], string | undefined>>;
+    get queryAccounts(): Readonly<Record<Query['schema'], AccountInstance | undefined>>;
+    get timestamp(): boolean;
+    protected abstract get _queryAccountPaths(): Record<Query['schema'], string>;
+    static _getRootFunction(funcName: string): any;
+    static _noOverride(functionName: string): void;
+    static create<TModule extends ModuleInstance>(this: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & {
+        config?: TModule['params']['config'];
+    }): Promise<TModule>;
+    static determineAccount({ account, accountDerivationPath, wallet, }: {
+        account?: AccountInstance | 'random';
+        accountDerivationPath?: string;
+        wallet?: WalletInstance;
+    }): Promise<AccountInstance>;
+    static factory<TModule extends ModuleInstance>(this: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & {
+        config?: TModule['params']['config'];
+    }): CreatableModuleFactory<TModule>;
+    _getRootFunction(funcName: string): any;
+    _noOverride(functionName: string): void;
+    busy<R>(closure: () => Promise<R>): Promise<R>;
+    emit<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
+    previousHash(): Promisable<string | undefined>;
+    query<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryResult>;
+    queryable<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): boolean;
+    resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter, options?: ModuleFilterOptions<T>): Promise<T[]>;
+    resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promise<T | undefined>;
+    start(_timeout?: number): Promisable<boolean>;
+    started(notStartedAction?: 'error' | 'throw' | 'warn' | 'log' | 'none', tryStart?: boolean): Promise<boolean>;
+    stop(_timeout?: number): Promise<boolean>;
+    protected bindHashes(hashes: string[], schema: SchemaString[], account?: AccountInstance): PromiseEx<unknown, AccountInstance>;
+    protected bindHashesInternal(hashes: string[], schema: SchemaString[], account?: AccountInstance): Promise<BoundWitness>;
+    protected bindQuery<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance): PromiseEx<[QueryBoundWitness, Payload[], Payload[]], AccountInstance>;
+    protected bindQueryInternal<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance): Promise<[QueryBoundWitness, Payload[], Payload[]]>;
+    protected bindQueryResult<T extends Query>(query: T, payloads: Payload[], additionalWitnesses?: AccountInstance[], errors?: ModuleError[]): Promise<ModuleQueryResult>;
+    protected commitArchivist: () => Promise<ArchivistInstance | undefined>;
+    protected describeHandler(): Promise<ModuleDescriptionPayload>;
+    protected discoverHandler(): Promisable<Payload[]>;
+    protected initializeQueryAccounts(): Promise<void>;
+    protected manifestHandler(_ignoreAddresses?: string[]): Promisable<ModuleManifestPayload>;
+    protected moduleAddressHandler(): Promisable<AddressPreviousHashPayload[]>;
+    protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
+    protected readArchivist: () => Promise<ArchivistInstance | undefined>;
+    protected startHandler(): Promise<boolean>;
+    protected stopHandler(_timeout?: number): Promisable<boolean>;
+    protected subscribeHandler(): void;
+    protected validateConfig(config?: unknown, parents?: string[]): boolean;
+    protected writeArchivist: () => Promise<ArchivistInstance | undefined>;
+    private getArchivist;
+}
+
+declare abstract class AbstractModuleInstance<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<ModuleConfig>, TEventData extends ModuleEventData = ModuleEventData> extends AbstractModule<TParams, TEventData> implements Module<TParams, TEventData> {
+    constructor(privateConstructorKey: string, params: TParams, account: AccountInstance);
+    describe(): Promise<ModuleDescriptionPayload>;
+    discover(): Promise<Payload[]>;
+    manifest(ignoreAddresses?: string[]): Promise<ModuleManifestPayload>;
+    moduleAddress(): Promise<AddressPreviousHashPayload[]>;
+    subscribe(_queryAccount?: AccountInstance): void;
+}
+
+declare class ModuleErrorBuilder extends PayloadBuilder {
+    _message?: string;
+    _name?: string;
+    _query?: string;
+    _sources?: string[];
+    constructor();
+    build(): ModuleError;
+    message(message: string): this;
+    name(name: string): this;
+    query(query: string): this;
+    sources(sources: string[]): this;
+}
+
+export { AbstractModule, AbstractModuleInstance, BaseEmitter, ModuleConfigQueryValidator, ModuleErrorBuilder, QueryValidator, Queryable, SortedPipedAddressesString, SupportedQueryValidator, isQuerySupportedByModule };