@xyo-network/module-wrapper 4.0.3 → 4.1.1

package/dist/{types → neutral}/ModuleWrapper.d.ts

@@ -49,7 +49,7 @@ export declare class ModuleWrapper<TWrappedModule extends Module = Module> exten
     get status(): ModuleStatus;
     get upResolver(): ModuleResolverInstance;
     protected set status(value: ModuleStatus);
-    static canWrap(mod?: Module): mod is Module<import("@xyo-network/module-model").ModuleParams<import("@xyo-network/module-model").AnyConfigSchema<import("@xyo-network/module-model").ModuleConfig>>, import("@xyo-network/module-model").ModuleEventData<object>>;
+    static canWrap(mod?: Module): mod is Module<import("@xyo-network/module-model").ModuleParams<import("@xyo-network/module-model").AnyConfigSchema<import("@xyo-network/module-model").ModuleConfig<object, void>>>, import("@xyo-network/module-model").ModuleEventData<object>>;
     static hasRequiredQueries(mod: Module): void;
     static is<TModuleWrapper extends ModuleWrapper>(this: ConstructableModuleWrapper<TModuleWrapper>, wrapper: any): wrapper is TModuleWrapper;
     static missingRequiredQueries(mod: Module): string[];

package/dist/neutral/index.d.ts

@@ -0,0 +1,106 @@
+import { BaseParams, Base } from '@xylabs/base';
+import { AccountInstance } from '@xyo-network/account-model';
+import * as _xyo_network_module_model from '@xyo-network/module-model';
+import { Module, AttachableModuleInstance, InstanceTypeCheck, ModuleTypeCheck, ModuleResolverInstance, ModuleStatus, ModuleInstance, AddressPreviousHashPayload, ModuleQueryResult, ModuleFilterOptions, ModuleIdentifier } from '@xyo-network/module-model';
+import * as _xylabs_events from '@xylabs/events';
+import { EventListener, EventAnyListener } from '@xylabs/events';
+import { Address } from '@xylabs/hex';
+import { Logger } from '@xylabs/logger';
+import { Promisable, PromiseEx } from '@xylabs/promise';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-model';
+import { ModuleManifestPayload } from '@xyo-network/manifest-model';
+import { Payload, Query, ModuleError } from '@xyo-network/payload-model';
+import { LRUCache } from 'lru-cache';
+
+type ModuleWrapperParams<TWrappedModule extends Module = Module> = BaseParams<{
+    account: AccountInstance;
+    additionalSigners?: AccountInstance[];
+    mod: TWrappedModule;
+}>;
+
+type ConstructableModuleWrapper<TWrapper extends ModuleWrapper> = {
+    defaultLogger?: Logger;
+    instanceIdentityCheck: InstanceTypeCheck;
+    moduleIdentityCheck: ModuleTypeCheck;
+    requiredQueries: string[];
+    new (params: ModuleWrapperParams<TWrapper['mod']>): TWrapper;
+    canWrap(mod: Module | undefined): boolean;
+    is<TModuleWrapper extends ModuleWrapper>(this: ConstructableModuleWrapper<TModuleWrapper>, wrapper?: any): wrapper is TModuleWrapper;
+    tryWrap<TModuleWrapper extends ModuleWrapper>(this: ConstructableModuleWrapper<TModuleWrapper>, mod: Module | undefined, account: AccountInstance, checkIdentity?: boolean): TModuleWrapper | undefined;
+    wrap<TModuleWrapper extends ModuleWrapper>(this: ConstructableModuleWrapper<TModuleWrapper>, mod: Module | undefined, account: AccountInstance, checkIdentity?: boolean): TModuleWrapper;
+};
+declare function constructableModuleWrapper<TWrapper extends ModuleWrapper>(): <U extends ConstructableModuleWrapper<TWrapper>>(constructor: U) => void;
+declare class ModuleWrapper<TWrappedModule extends Module = Module> extends Base<Exclude<Omit<TWrappedModule['params'], 'config'> & {
+    config: Exclude<TWrappedModule['params']['config'], undefined>;
+}, undefined>> implements AttachableModuleInstance<TWrappedModule['params'], TWrappedModule['eventData']> {
+    static readonly instanceIdentityCheck: InstanceTypeCheck;
+    static readonly moduleIdentityCheck: ModuleTypeCheck;
+    static readonly requiredQueries: string[];
+    eventData: TWrappedModule["eventData"];
+    protected readonly cachedCalls: LRUCache<string, Payload[], unknown>;
+    protected readonly wrapperParams: ModuleWrapperParams<TWrappedModule>;
+    private _parents;
+    private _status;
+    constructor(params: ModuleWrapperParams<TWrappedModule>);
+    get account(): AccountInstance;
+    get additionalSigners(): AccountInstance[];
+    get address(): Lowercase<string>;
+    get config(): Exclude<TWrappedModule["params"]["config"], undefined>;
+    get downResolver(): ModuleResolverInstance;
+    get id(): string;
+    get mod(): TWrappedModule;
+    get modName(): string | undefined;
+    get name(): string;
+    get priority(): 1;
+    get privateResolver(): ModuleResolverInstance;
+    get queries(): string[];
+    get status(): ModuleStatus;
+    get upResolver(): ModuleResolverInstance;
+    protected set status(value: ModuleStatus);
+    static canWrap(mod?: Module): mod is Module<_xyo_network_module_model.ModuleParams<_xyo_network_module_model.AnyConfigSchema<_xyo_network_module_model.ModuleConfig<object, void>>>, _xyo_network_module_model.ModuleEventData<object>>;
+    static hasRequiredQueries(mod: Module): void;
+    static is<TModuleWrapper extends ModuleWrapper>(this: ConstructableModuleWrapper<TModuleWrapper>, wrapper: any): wrapper is TModuleWrapper;
+    static missingRequiredQueries(mod: Module): string[];
+    static tryWrap<TModuleWrapper extends ModuleWrapper>(this: ConstructableModuleWrapper<TModuleWrapper>, mod: Module | undefined, account: AccountInstance, checkIdentity?: boolean): TModuleWrapper | undefined;
+    static with<TModuleWrapper extends ModuleWrapper, R extends Promisable<void> = void>(this: ConstructableModuleWrapper<TModuleWrapper>, mod: any, closure: (mod: TModuleWrapper) => R): R | undefined;
+    static wrap<TModuleWrapper extends ModuleWrapper>(this: ConstructableModuleWrapper<TModuleWrapper>, mod: Module | undefined, account: AccountInstance, checkIdentity?: boolean): TModuleWrapper;
+    addParent(mod: ModuleInstance): void;
+    addressPreviousHash(): Promise<AddressPreviousHashPayload>;
+    clearListeners(eventNames: Parameters<TWrappedModule['clearListeners']>[0]): void;
+    emit(eventName: Parameters<TWrappedModule['emit']>[0], eventArgs: Parameters<TWrappedModule['emit']>[1]): Promise<void>;
+    emitSerial(eventName: Parameters<TWrappedModule['emitSerial']>[0], eventArgs: Parameters<TWrappedModule['emitSerial']>[1]): Promise<void>;
+    listenerCount(eventNames: Parameters<TWrappedModule['listenerCount']>[0]): number;
+    manifest(maxDepth?: number): Promise<ModuleManifestPayload>;
+    manifestQuery(account: AccountInstance, maxDepth?: number): Promise<ModuleQueryResult<ModuleManifestPayload>>;
+    moduleAddress(): Promise<AddressPreviousHashPayload[]>;
+    off<TEventName extends keyof TWrappedModule['eventData']>(eventNames: TEventName, listener: EventListener<TWrappedModule['eventData'][TEventName]>): void;
+    offAny(listener: EventAnyListener): void;
+    on<TEventName extends keyof TWrappedModule['eventData']>(eventNames: TEventName, listener: EventListener<TWrappedModule['eventData'][TEventName]>): _xylabs_events.EventUnsubscribeFunction;
+    onAny(listener: EventAnyListener): _xylabs_events.EventUnsubscribeFunction;
+    once<TEventName extends keyof TWrappedModule['eventData']>(eventName: TEventName, listener: EventListener<TWrappedModule['eventData'][TEventName]>): _xylabs_events.EventUnsubscribeFunction;
+    parents(): Promisable<ModuleInstance[]>;
+    previousHash(): Promise<string | undefined>;
+    previousHashQuery(account?: AccountInstance): Promise<ModuleQueryResult<AddressPreviousHashPayload>>;
+    privateChildren(): Promise<ModuleInstance[]>;
+    publicChildren(): Promise<ModuleInstance[]>;
+    query<T extends QueryBoundWitness = QueryBoundWitness>(query: T, payloads?: Payload[]): Promise<ModuleQueryResult>;
+    queryable<T extends QueryBoundWitness = QueryBoundWitness>(query: T, payloads?: Payload[]): Promisable<boolean>;
+    removeParent(address: Address): void;
+    /** @deprecated do not pass undefined.  If trying to get all, pass '*' */
+    resolve<T extends ModuleInstance = ModuleInstance>(): Promise<T[]>;
+    resolve<T extends ModuleInstance = ModuleInstance>(all: '*', options?: ModuleFilterOptions<T>): Promise<T[]>;
+    resolve<T extends ModuleInstance = ModuleInstance>(id: ModuleIdentifier, options?: ModuleFilterOptions<T> | undefined): Promise<ModuleInstance>;
+    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>;
+    protected bindQuery<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance, additionalSigners?: AccountInstance[]): PromiseEx<[QueryBoundWitness, Payload[], ModuleError[]], AccountInstance>;
+    protected bindQueryInternal<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance, additionalSigners?: AccountInstance[]): Promise<[QueryBoundWitness, Payload[], ModuleError[]]>;
+    protected filterErrors(result: ModuleQueryResult): ModuleError[];
+    protected sendQuery<T extends Query, P extends Payload = Payload, R extends Payload = Payload>(queryPayload: T, payloads?: P[]): Promise<R[]>;
+    protected sendQueryRaw<T extends Query, P extends Payload = Payload, R extends Payload = Payload>(queryPayload: T, payloads?: P[], account?: AccountInstance): Promise<ModuleQueryResult<R>>;
+}
+
+export { ModuleWrapper, constructableModuleWrapper };
+export type { ConstructableModuleWrapper, ModuleWrapperParams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-wrapper",
-  "version": "4.0.3",
+  "version": "4.1.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,33 +21,33 @@
   "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.13.4",
-    "@xylabs/base": "^4.13.4",
-    "@xylabs/events": "^4.13.4",
-    "@xylabs/exists": "^4.13.4",
-    "@xylabs/hex": "^4.13.4",
-    "@xylabs/logger": "^4.13.4",
-    "@xylabs/promise": "^4.13.4",
-    "@xyo-network/account-model": "^4.0.3",
-    "@xyo-network/boundwitness-builder": "^4.0.3",
-    "@xyo-network/boundwitness-model": "^4.0.3",
-    "@xyo-network/boundwitness-wrapper": "^4.0.3",
-    "@xyo-network/manifest-model": "^4.0.3",
-    "@xyo-network/module-model": "^4.0.3",
-    "@xyo-network/payload-model": "^4.0.3",
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/base": "^4.13.15",
+    "@xylabs/events": "^4.13.15",
+    "@xylabs/exists": "^4.13.15",
+    "@xylabs/hex": "^4.13.15",
+    "@xylabs/logger": "^4.13.15",
+    "@xylabs/promise": "^4.13.15",
+    "@xyo-network/account-model": "^4.1.1",
+    "@xyo-network/boundwitness-builder": "^4.1.1",
+    "@xyo-network/boundwitness-model": "^4.1.1",
+    "@xyo-network/boundwitness-wrapper": "^4.1.1",
+    "@xyo-network/manifest-model": "^4.1.1",
+    "@xyo-network/module-model": "^4.1.1",
+    "@xyo-network/payload-model": "^4.1.1",
     "lru-cache": "^11.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
+    "@xylabs/tsconfig": "^7.0.0-rc.23",
     "typescript": "^5.8.3"
   },
   "publishConfig": {

package/dist/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './models.ts';
-export * from './ModuleWrapper.ts';
-//# sourceMappingURL=index.d.ts.map