@xyo-network/module-abstract 4.0.2 → 4.1.0

package/dist/neutral/index.d.ts

@@ -0,0 +1,202 @@
+import * as _xyo_network_module_model from '@xyo-network/module-model';
+import { AnyConfigSchema, ModuleConfig, Module, ModuleParams, ModuleEventData, Labels, ModuleDetailsError, ArchivingModuleConfig, ModuleResolverInstance, CreatableModuleInstance, CreatableModule, CreatableModuleFactory, AttachableModuleInstance, ModuleQueryResult, ModuleDescriptionPayload, AddressPreviousHashPayload, AddressPayload, ModuleQueryHandlerResult, ModuleNameResolver, ModuleInstance, ModuleFilterOptions, ModuleIdentifier, ObjectFilterOptions, ModuleStatusReporter } from '@xyo-network/module-model';
+import { AbstractCreatable, CreatableStatus, CreatableInstance, CreatableName } from '@xylabs/creatable';
+import { Address, Hash } from '@xylabs/hex';
+import { Logger } from '@xylabs/logger';
+import { Promisable, PromiseEx } from '@xylabs/promise';
+import { AccountInstance } from '@xyo-network/account-model';
+import { ArchivistInstance } from '@xyo-network/archivist-model';
+import { QueryBoundWitness, BoundWitness } from '@xyo-network/boundwitness-model';
+import { ModuleManifestPayload } from '@xyo-network/manifest-model';
+import { Payload, Schema, Query, ModuleError } from '@xyo-network/payload-model';
+import { WalletInstance } from '@xyo-network/wallet-model';
+import { Mutex } from 'async-mutex';
+import { LRUCache } from 'lru-cache';
+import * as _xyo_network_module_resolver from '@xyo-network/module-resolver';
+import { CompositeModuleResolver } from '@xyo-network/module-resolver';
+import { NodeInstance } from '@xyo-network/node-model';
+import { JsonValue } from '@xylabs/object';
+import { PayloadBuilder } from '@xyo-network/payload-builder';
+
+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<Schema, SortedPipedAddressesString[]>;
+    protected disallowed: Record<Schema, SortedPipedAddressesString[]>;
+    protected readonly hasAllowedRules: boolean;
+    protected readonly hasDisallowedRules: boolean;
+    protected readonly hasRules: boolean;
+    constructor(config?: TConfig);
+    queryable: Queryable;
+    protected queryAllowed: (schema: Schema, addresses: Address[]) => boolean;
+    protected queryDisallowed: (schema: Schema, addresses: string[]) => boolean;
+}
+
+declare const isQuerySupportedByModule: <T extends QueryBoundWitness = QueryBoundWitness>(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 = ModuleParams, TEventData extends ModuleEventData = ModuleEventData> extends AbstractCreatable<TParams, TEventData> implements Module<TParams, TEventData> {
+    static readonly allowRandomAccount: boolean;
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    static defaultLogger: Logger;
+    static enableLazyLoad: boolean;
+    static readonly labels: Labels;
+    static readonly uniqueName: string;
+    protected static privateConstructorKey: string;
+    protected _account: AccountInstance | undefined;
+    protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;
+    protected _globalReentrancyMutex: Mutex | undefined;
+    protected _lastError?: ModuleDetailsError;
+    protected _moduleConfigQueryValidator: Queryable | undefined;
+    protected _startPromise: Promisable<boolean> | undefined;
+    protected _supportedQueryValidator: Queryable | undefined;
+    private _busyCount;
+    private _logger;
+    private _status;
+    get account(): AccountInstance;
+    get additionalSigners(): AccountInstance[];
+    get address(): Lowercase<string>;
+    get allowAnonymous(): boolean;
+    get allowNameResolution(): boolean;
+    get archiving(): ArchivingModuleConfig['archiving'] | undefined;
+    get archivist(): string | undefined;
+    get config(): TParams['config'] & {
+        schema: Schema;
+    };
+    get dead(): boolean;
+    get ephemeralQueryAccountEnabled(): boolean;
+    get globalReentrancyMutex(): Mutex | undefined;
+    get id(): string;
+    get logger(): Logger | undefined;
+    get modName(): string | undefined;
+    get priority(): 2;
+    get queries(): Schema[];
+    get reentrancy(): {
+        action: "skip" | "wait";
+        scope: "global";
+    } | undefined;
+    get status(): CreatableStatus;
+    get statusReporter(): _xyo_network_module_model.ModuleStatusReporter | undefined;
+    get timestamp(): boolean;
+    protected get moduleConfigQueryValidator(): Queryable;
+    protected set status(value: CreatableStatus);
+    protected get supportedQueryValidator(): Queryable;
+    abstract get downResolver(): ModuleResolverInstance;
+    abstract get upResolver(): ModuleResolverInstance;
+    static _getRootFunction(funcName: string): any;
+    static _noOverride(functionName: string): void;
+    static createHandler<T extends CreatableInstance>(inInstance: T): Promise<T & AbstractModule<any, any>>;
+    static determineAccount(params: {
+        account?: AccountInstance | 'random';
+        accountPath?: string;
+        wallet?: WalletInstance;
+    }): Promise<AccountInstance>;
+    static factory<TModule extends CreatableModuleInstance>(this: CreatableModule<TModule>, params?: Partial<TModule['params']>): CreatableModuleFactory<TModule>;
+    static isAllowedSchema(schema: Schema): boolean;
+    static paramsHandler<T extends AttachableModuleInstance<ModuleParams, ModuleEventData>>(inParams?: Partial<T['params']>): Promise<T["params"]>;
+    _getRootFunction(funcName: string): any;
+    busy<R>(closure: () => Promise<R>): Promise<R>;
+    createHandler(): Promise<void>;
+    emit<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
+    isSupportedQuery(query: Schema, assert?: boolean | string): boolean;
+    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): Promise<boolean>;
+    started(notStartedAction?: 'error' | 'throw' | 'warn' | 'log' | 'none', tryStart?: boolean): Promise<boolean>;
+    protected _checkDead(): void;
+    protected archivistInstance(): Promise<ArchivistInstance | undefined>;
+    protected archivistInstance(required: true): Promise<ArchivistInstance>;
+    protected bindHashes(hashes: Hash[], schema: Schema[], account?: AccountInstance): PromiseEx<unknown, AccountInstance>;
+    protected bindHashesInternal(hashes: Hash[], schema: Schema[], account?: AccountInstance): Promise<BoundWitness>;
+    protected bindQuery<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance, additionalSigners?: AccountInstance[]): PromiseEx<[QueryBoundWitness, Payload[], Payload[]], AccountInstance>;
+    protected bindQueryInternal<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance, additionalSigners?: AccountInstance[]): Promise<[QueryBoundWitness, Payload[], Payload[]]>;
+    protected bindQueryResult<T extends Query>(query: T, payloads: Payload[], additionalWitnesses?: AccountInstance[], errors?: ModuleError[]): Promise<ModuleQueryResult>;
+    protected generateConfigAndAddress(_maxDepth?: number): Promisable<Payload[]>;
+    protected generateDescribe(): Promise<ModuleDescriptionPayload>;
+    /** @deprecated use archivistInstance() instead */
+    protected getArchivist(): Promise<ArchivistInstance | undefined>;
+    protected isAllowedArchivingQuery(schema: Schema): boolean;
+    protected manifestHandler(_maxDepth?: number, _ignoreAddresses?: Address[]): Promisable<ModuleManifestPayload>;
+    protected moduleAddressHandler(): Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
+    protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
+    protected startHandler(): Promise<void>;
+    protected stateHandler(): Promise<Payload[]>;
+    protected stopHandler(): Promise<void>;
+    protected subscribeHandler(): void;
+    protected validateConfig(config?: unknown, parents?: string[]): boolean;
+    protected abstract certifyParents(): Promise<Payload[]>;
+    protected abstract storeToArchivists(payloads: Payload[]): Promise<Payload[]>;
+}
+
+declare abstract class AbstractModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData> extends AbstractModule<TParams, TEventData> implements AttachableModuleInstance<TParams, TEventData>, ModuleNameResolver {
+    static readonly uniqueName: string;
+    static readonly useNewResolver = false;
+    private _downResolver?;
+    private _parents;
+    private _privateResolver?;
+    private _upResolver?;
+    get downResolver(): CompositeModuleResolver<_xyo_network_module_resolver.CompositeModuleResolverParams>;
+    get modName(): string | undefined;
+    get moduleIdentifierTransformers(): _xyo_network_module_model.ModuleIdentifierTransformer[];
+    get privateResolver(): CompositeModuleResolver<_xyo_network_module_resolver.CompositeModuleResolverParams>;
+    get root(): this;
+    get upResolver(): CompositeModuleResolver<_xyo_network_module_resolver.CompositeModuleResolverParams>;
+    addParent(mod: ModuleInstance): void;
+    certifyParents(): Promise<Payload[]>;
+    createHandler(): Promise<void>;
+    manifest(maxDepth?: number): Promise<ModuleManifestPayload>;
+    manifestQuery(account: AccountInstance, maxDepth?: number): Promise<ModuleQueryResult<ModuleManifestPayload>>;
+    moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>;
+    parents(): Promisable<NodeInstance[]>;
+    privateChildren(): Promisable<ModuleInstance[]>;
+    publicChildren(): Promisable<ModuleInstance[]>;
+    removeParent(address: Address): void;
+    resolve(): Promise<ModuleInstance[]>;
+    resolve<T extends ModuleInstance = ModuleInstance>(all: '*', options?: ModuleFilterOptions<T>): Promise<T[]>;
+    resolve<T extends ModuleInstance = ModuleInstance>(id: ModuleIdentifier, options?: ModuleFilterOptions<T>): Promise<T | undefined>;
+    resolveIdentifier(id: ModuleIdentifier, options?: ObjectFilterOptions): Promise<Address | undefined>;
+    resolvePrivate<T extends ModuleInstance = ModuleInstance>(all: '*', options?: ModuleFilterOptions<T>): Promise<T[]>;
+    resolvePrivate<T extends ModuleInstance = ModuleInstance>(id: ModuleIdentifier, options?: ModuleFilterOptions<T>): Promise<T | undefined>;
+    siblings(): Promise<ModuleInstance[]>;
+    state(): Promise<Payload[]>;
+    stateQuery(account: AccountInstance): Promise<ModuleQueryResult>;
+    subscribe(_queryAccount?: AccountInstance): void;
+    protected manifestHandler(maxDepth?: number, _ignoreAddresses?: Address[]): Promise<ModuleManifestPayload>;
+    protected resolveArchivingArchivists(): Promise<ArchivistInstance[]>;
+    protected sendQuery<T extends Query, P extends Payload = Payload, R extends Payload = Payload>(queryPayload: T, payloads?: P[], account?: AccountInstance): Promise<R[]>;
+    protected sendQueryRaw<T extends Query, P extends Payload = Payload, R extends Payload = Payload>(queryPayload: T, payloads?: P[], account?: AccountInstance): Promise<ModuleQueryResult<R>>;
+    protected startHandler(): Promise<void>;
+    protected storeToArchivists(payloads: Payload[]): Promise<Payload[]>;
+}
+
+declare class ModuleErrorBuilder extends PayloadBuilder<ModuleError> {
+    _details?: JsonValue;
+    _message?: string;
+    _name?: string;
+    _query?: Hash;
+    constructor();
+    build(): ModuleError;
+    details(details?: JsonValue): this;
+    message(message: string): this;
+    name(name: string): this;
+    query(query: Hash): this;
+}
+
+declare class LoggerModuleStatusReporter implements ModuleStatusReporter {
+    protected logger: Logger;
+    protected statusMap: Record<CreatableName, CreatableStatus>;
+    constructor(logger: Logger);
+    report(name: string, status: CreatableStatus, progress?: number | Error): void;
+}
+
+export { AbstractModule, AbstractModuleInstance, LoggerModuleStatusReporter, ModuleConfigQueryValidator, ModuleErrorBuilder, SupportedQueryValidator, isQuerySupportedByModule };
+export type { QueryValidator, Queryable, SortedPipedAddressesString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-abstract",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,50 +21,49 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.12.33",
-    "@xylabs/base": "^4.12.33",
-    "@xylabs/creatable": "^4.12.33",
-    "@xylabs/error": "^4.12.33",
-    "@xylabs/exists": "^4.12.33",
-    "@xylabs/forget": "^4.12.33",
-    "@xylabs/hex": "^4.12.33",
-    "@xylabs/logger": "^4.12.33",
-    "@xylabs/object": "^4.12.33",
-    "@xylabs/promise": "^4.12.33",
-    "@xylabs/telemetry": "^4.12.33",
-    "@xylabs/typeof": "^4.12.33",
-    "@xyo-network/account": "^4.0.2",
-    "@xyo-network/account-model": "^4.0.2",
-    "@xyo-network/archivist-model": "^4.0.2",
-    "@xyo-network/boundwitness-builder": "^4.0.2",
-    "@xyo-network/boundwitness-model": "^4.0.2",
-    "@xyo-network/boundwitness-wrapper": "^4.0.2",
-    "@xyo-network/config-payload-plugin": "^4.0.2",
-    "@xyo-network/manifest-model": "^4.0.2",
-    "@xyo-network/module-event-emitter": "^4.0.2",
-    "@xyo-network/module-model": "^4.0.2",
-    "@xyo-network/module-resolver": "^4.0.2",
-    "@xyo-network/node-model": "^4.0.2",
-    "@xyo-network/payload-builder": "^4.0.2",
-    "@xyo-network/payload-model": "^4.0.2",
-    "@xyo-network/query-payload-plugin": "^4.0.2",
-    "@xyo-network/wallet-model": "^4.0.2",
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/base": "^4.13.15",
+    "@xylabs/creatable": "^4.13.15",
+    "@xylabs/error": "^4.13.15",
+    "@xylabs/exists": "^4.13.15",
+    "@xylabs/forget": "^4.13.15",
+    "@xylabs/hex": "^4.13.15",
+    "@xylabs/logger": "^4.13.15",
+    "@xylabs/object": "^4.13.15",
+    "@xylabs/promise": "^4.13.15",
+    "@xylabs/telemetry": "^4.13.15",
+    "@xylabs/typeof": "^4.13.15",
+    "@xyo-network/account": "^4.1.0",
+    "@xyo-network/account-model": "^4.1.0",
+    "@xyo-network/archivist-model": "^4.1.0",
+    "@xyo-network/boundwitness-builder": "^4.1.0",
+    "@xyo-network/boundwitness-model": "^4.1.0",
+    "@xyo-network/boundwitness-wrapper": "^4.1.0",
+    "@xyo-network/config-payload-plugin": "^4.1.0",
+    "@xyo-network/manifest-model": "^4.1.0",
+    "@xyo-network/module-model": "^4.1.0",
+    "@xyo-network/module-resolver": "^4.1.0",
+    "@xyo-network/node-model": "^4.1.0",
+    "@xyo-network/payload-builder": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0",
+    "@xyo-network/query-payload-plugin": "^4.1.0",
+    "@xyo-network/wallet-model": "^4.1.0",
     "async-mutex": "^0.5.0",
     "lru-cache": "^11.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
-    "@xylabs/tsconfig": "^6.5.12",
-    "@xylabs/typeof": "^4.12.33",
-    "@xylabs/vitest-extended": "^4.12.33",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/typeof": "^4.13.15",
+    "@xylabs/vitest-extended": "^4.13.15",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },