@xyo-network/module-model 2.87.0 → 2.87.2

package/dist/node/withModule.d.mts

@@ -2,6 +2,82 @@ import { TypeCheck } from '@xyo-network/object';
 export declare const WithFactory: {
     create: <T extends object>(typeCheck: TypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
 };
-export declare const withModule: <R>(module: any, closure: (module: import("./module").Module) => R) => R | undefined;
-export declare const withModuleInstance: <R>(module: any, closure: (module: import("./instance").ModuleInstance) => R) => R | undefined;
+export declare const withModule: <R>(module: any, closure: (module: import("./module").Module<import("@xyo-network/object").BaseParamsFields & {
+    account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+    config: import("@xyo-network/payload-model").SchemaFields & object & Omit<{
+        readonly archivist?: string | undefined;
+        readonly labels?: import("./Labels").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.module.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & import("./Config").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+        readonly archivist?: string | undefined;
+        readonly labels?: import("./Labels").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.module.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+}, import("./EventsModels").ModuleEventData<object>>) => R) => R | undefined;
+export declare const withModuleInstance: <R>(module: any, closure: (module: import("./instance").ModuleInstance<import("@xyo-network/object").BaseParamsFields & {
+    account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+    config: import("@xyo-network/payload-model").SchemaFields & object & Omit<{
+        readonly archivist?: string | undefined;
+        readonly labels?: import("./Labels").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.module.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & import("./Config").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+        readonly archivist?: string | undefined;
+        readonly labels?: import("./Labels").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.module.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+}, import("./EventsModels").ModuleEventData<object>>) => R) => R | undefined;
 //# sourceMappingURL=withModule.d.ts.map

package/dist/node/withModule.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAK/C,eAAO,MAAM,WAAW;uEAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}
+{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAK/C,eAAO,MAAM,WAAW;uEAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAUqD,CAAA"}

package/dist/node/withModule.d.ts

@@ -2,6 +2,82 @@ import { TypeCheck } from '@xyo-network/object';
 export declare const WithFactory: {
     create: <T extends object>(typeCheck: TypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
 };
-export declare const withModule: <R>(module: any, closure: (module: import("./module").Module) => R) => R | undefined;
-export declare const withModuleInstance: <R>(module: any, closure: (module: import("./instance").ModuleInstance) => R) => R | undefined;
+export declare const withModule: <R>(module: any, closure: (module: import("./module").Module<import("@xyo-network/object").BaseParamsFields & {
+    account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+    config: import("@xyo-network/payload-model").SchemaFields & object & Omit<{
+        readonly archivist?: string | undefined;
+        readonly labels?: import("./Labels").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.module.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & import("./Config").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+        readonly archivist?: string | undefined;
+        readonly labels?: import("./Labels").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.module.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+}, import("./EventsModels").ModuleEventData<object>>) => R) => R | undefined;
+export declare const withModuleInstance: <R>(module: any, closure: (module: import("./instance").ModuleInstance<import("@xyo-network/object").BaseParamsFields & {
+    account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+    config: import("@xyo-network/payload-model").SchemaFields & object & Omit<{
+        readonly archivist?: string | undefined;
+        readonly labels?: import("./Labels").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.module.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & import("./Config").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+        readonly archivist?: string | undefined;
+        readonly labels?: import("./Labels").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.module.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+}, import("./EventsModels").ModuleEventData<object>>) => R) => R | undefined;
 //# sourceMappingURL=withModule.d.ts.map

package/dist/node/withModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAK/C,eAAO,MAAM,WAAW;uEAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}
+{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAK/C,eAAO,MAAM,WAAW;uEAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAUqD,CAAA"}

package/package.json

@@ -15,17 +15,17 @@
     "@xylabs/lodash": "^2.13.23",
     "@xylabs/logger": "^2.13.23",
     "@xylabs/promise": "^2.13.23",
-    "@xyo-network/account-model": "~2.87.0",
-    "@xyo-network/address-payload-plugin": "~2.87.0",
-    "@xyo-network/boundwitness-model": "~2.87.0",
-    "@xyo-network/manifest-model": "~2.87.0",
-    "@xyo-network/module-events": "~2.87.0",
-    "@xyo-network/object": "~2.87.0",
-    "@xyo-network/payload-model": "~2.87.0"
+    "@xyo-network/account-model": "~2.87.2",
+    "@xyo-network/address-payload-plugin": "~2.87.2",
+    "@xyo-network/boundwitness-model": "~2.87.2",
+    "@xyo-network/manifest-model": "~2.87.2",
+    "@xyo-network/module-events": "~2.87.2",
+    "@xyo-network/object": "~2.87.2",
+    "@xyo-network/payload-model": "~2.87.2"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.2.33",
-    "@xylabs/tsconfig": "^3.2.33",
+    "@xylabs/ts-scripts-yarn3": "^3.2.41",
+    "@xylabs/tsconfig": "^3.2.41",
     "typescript": "^5.3.3"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -67,6 +67,6 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.87.0",
+  "version": "2.87.2",
   "type": "module"
 }

package/src/instance/ModuleInstance.ts

@@ -20,19 +20,17 @@ export interface ModuleResolver extends ResolveFunctions {
   removeResolver: (resolver: ModuleResolver) => this
 }
 
-export type ModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData> = Module<
-  TParams,
-  TEventData
-> &
-  ResolveFunctions &
-  ModuleQueryFunctions & {
-    /* The resolver is a 'down' resolver.  It can resolve the module or any children (if it is a node for example), that are in the module*/
-    readonly downResolver: Omit<ModuleResolver, 'resolve'>
+export interface ModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData>
+  extends Module<TParams, TEventData>,
+    ResolveFunctions,
+    ModuleQueryFunctions {
+  /* The resolver is a 'down' resolver.  It can resolve the module or any children (if it is a node for example), that are in the module*/
+  readonly downResolver: Omit<ModuleResolver, 'resolve'>
 
-    /* The resolver is a 'up' resolver.  It can resolve the parent or any children of the parent*/
-    /* This is set by a NodeModule when attaching to the module */
-    readonly upResolver: Omit<ModuleResolver, 'resolve'>
-  }
+  /* The resolver is a 'up' resolver.  It can resolve the parent or any children of the parent*/
+  /* This is set by a NodeModule when attaching to the module */
+  readonly upResolver: Omit<ModuleResolver, 'resolve'>
+}
 
 export type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = TypeCheck<T>
 

package/src/module/Module.ts

@@ -4,7 +4,6 @@ import { ModuleEventData } from '../EventsModels'
 import { ModuleParams } from '../ModuleParams'
 import { ModuleFields } from './ModuleFields'
 
-export type Module<
-  TParams extends ModuleParams = ModuleParams,
-  TEventData extends ModuleEventData<object> = ModuleEventData<object>,
-> = ModuleFields<TParams> & EventFunctions<TEventData>
+export interface Module<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData<object> = ModuleEventData<object>>
+  extends ModuleFields<TParams>,
+    EventFunctions<TEventData> {}