@xyo-network/node-model 2.87.0 → 2.87.1

package/dist/node/typeChecks.d.ts

@@ -1,14 +1,342 @@
 import { NodeInstance, NodeModule } from './Node';
-export declare const isNodeInstance: import("@xyo-network/object").TypeCheck<NodeInstance>;
-export declare const isNodeModule: import("@xyo-network/module-model").ModuleTypeCheck<NodeModule>;
+export declare const isNodeInstance: import("@xyo-network/object").TypeCheck<NodeInstance<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("@xyo-network/module-model").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.node.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+        readonly archivist?: string | undefined;
+        readonly labels?: import("@xyo-network/module-model").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.node.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & {
+        archivist?: string | undefined;
+        schema: "network.xyo.node.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+}, import("./Node").NodeModuleEventData>>;
+export declare const isNodeModule: import("@xyo-network/module-model").ModuleTypeCheck<NodeModule<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("@xyo-network/module-model").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.node.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+        readonly archivist?: string | undefined;
+        readonly labels?: import("@xyo-network/module-model").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.node.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & {
+        archivist?: string | undefined;
+        schema: "network.xyo.node.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+}, import("./Node").NodeModuleEventData>>;
 export declare const asNodeModule: {
-    <TType extends NodeModule>(value: unknown, config?: import("@xyo-network/object").TypeCheckConfig | undefined): TType | undefined;
-    <TType_1 extends NodeModule>(value: unknown, assert: string | (() => string), config?: import("@xyo-network/object").TypeCheckConfig | undefined): TType_1;
+    <TType extends NodeModule<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("@xyo-network/module-model").Labels | undefined;
+            readonly name?: string | undefined;
+            readonly paging?: Record<string, {
+                size?: number | undefined;
+            }> | undefined;
+            schema: "network.xyo.node.config";
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+                readonly disallowed?: Record<string, string[]> | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        } & import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+            readonly archivist?: string | undefined;
+            readonly labels?: import("@xyo-network/module-model").Labels | undefined;
+            readonly name?: string | undefined;
+            readonly paging?: Record<string, {
+                size?: number | undefined;
+            }> | undefined;
+            schema: "network.xyo.node.config";
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+                readonly disallowed?: Record<string, string[]> | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        } & {
+            archivist?: string | undefined;
+            schema: "network.xyo.node.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+    }, import("./Node").NodeModuleEventData>>(value: unknown, config?: import("@xyo-network/object").TypeCheckConfig | undefined): TType | undefined;
+    <TType_1 extends NodeModule<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("@xyo-network/module-model").Labels | undefined;
+            readonly name?: string | undefined;
+            readonly paging?: Record<string, {
+                size?: number | undefined;
+            }> | undefined;
+            schema: "network.xyo.node.config";
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+                readonly disallowed?: Record<string, string[]> | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        } & import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+            readonly archivist?: string | undefined;
+            readonly labels?: import("@xyo-network/module-model").Labels | undefined;
+            readonly name?: string | undefined;
+            readonly paging?: Record<string, {
+                size?: number | undefined;
+            }> | undefined;
+            schema: "network.xyo.node.config";
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+                readonly disallowed?: Record<string, string[]> | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        } & {
+            archivist?: string | undefined;
+            schema: "network.xyo.node.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+    }, import("./Node").NodeModuleEventData>>(value: unknown, assert: string | (() => string), config?: import("@xyo-network/object").TypeCheckConfig | undefined): TType_1;
 };
 export declare const asNodeInstance: {
-    <TType extends NodeInstance>(value: unknown, config?: import("@xyo-network/object").TypeCheckConfig | undefined): TType | undefined;
-    <TType_1 extends NodeInstance>(value: unknown, assert: string | (() => string), config?: import("@xyo-network/object").TypeCheckConfig | undefined): TType_1;
+    <TType extends NodeInstance<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("@xyo-network/module-model").Labels | undefined;
+            readonly name?: string | undefined;
+            readonly paging?: Record<string, {
+                size?: number | undefined;
+            }> | undefined;
+            schema: "network.xyo.node.config";
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+                readonly disallowed?: Record<string, string[]> | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        } & import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+            readonly archivist?: string | undefined;
+            readonly labels?: import("@xyo-network/module-model").Labels | undefined;
+            readonly name?: string | undefined;
+            readonly paging?: Record<string, {
+                size?: number | undefined;
+            }> | undefined;
+            schema: "network.xyo.node.config";
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+                readonly disallowed?: Record<string, string[]> | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        } & {
+            archivist?: string | undefined;
+            schema: "network.xyo.node.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+    }, import("./Node").NodeModuleEventData>>(value: unknown, config?: import("@xyo-network/object").TypeCheckConfig | undefined): TType | undefined;
+    <TType_1 extends NodeInstance<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("@xyo-network/module-model").Labels | undefined;
+            readonly name?: string | undefined;
+            readonly paging?: Record<string, {
+                size?: number | undefined;
+            }> | undefined;
+            schema: "network.xyo.node.config";
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+                readonly disallowed?: Record<string, string[]> | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        } & import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+            readonly archivist?: string | undefined;
+            readonly labels?: import("@xyo-network/module-model").Labels | undefined;
+            readonly name?: string | undefined;
+            readonly paging?: Record<string, {
+                size?: number | undefined;
+            }> | undefined;
+            schema: "network.xyo.node.config";
+            readonly security?: {
+                readonly allowAnonymous?: boolean | undefined;
+                readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+                readonly disallowed?: Record<string, string[]> | undefined;
+            } | undefined;
+            readonly sign?: boolean | undefined;
+            readonly storeQueries?: boolean | undefined;
+            readonly timestamp?: boolean | undefined;
+        } & {
+            archivist?: string | undefined;
+            schema: "network.xyo.node.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+    }, import("./Node").NodeModuleEventData>>(value: unknown, assert: string | (() => string), config?: import("@xyo-network/object").TypeCheckConfig | undefined): TType_1;
 };
-export declare const withNodeModule: <R>(module: any, closure: (module: NodeModule) => R) => R | undefined;
-export declare const withNodeInstance: <R>(module: any, closure: (module: NodeInstance) => R) => R | undefined;
+export declare const withNodeModule: <R>(module: any, closure: (module: NodeModule<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("@xyo-network/module-model").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.node.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+        readonly archivist?: string | undefined;
+        readonly labels?: import("@xyo-network/module-model").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.node.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & {
+        archivist?: string | undefined;
+        schema: "network.xyo.node.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+}, import("./Node").NodeModuleEventData>) => R) => R | undefined;
+export declare const withNodeInstance: <R>(module: any, closure: (module: NodeInstance<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("@xyo-network/module-model").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.node.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/payload-model").SchemaFields & object & {
+        readonly archivist?: string | undefined;
+        readonly labels?: import("@xyo-network/module-model").Labels | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        schema: "network.xyo.node.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+    } & {
+        archivist?: string | undefined;
+        schema: "network.xyo.node.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+}, import("./Node").NodeModuleEventData>) => R) => R | undefined;
 //# sourceMappingURL=typeChecks.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"typeChecks.d.ts","sourceRoot":"","sources":["../../src/typeChecks.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAKjD,eAAO,MAAM,cAAc,uDAQ1B,CAAA;AAID,eAAO,MAAM,YAAY,iEAA2H,CAAA;AAEpJ,eAAO,MAAM,YAAY;;;CAAuC,CAAA;AAChE,eAAO,MAAM,cAAc;;;CAAyC,CAAA;AACpE,eAAO,MAAM,cAAc,uEAAmC,CAAA;AAC9D,eAAO,MAAM,gBAAgB,yEAAqC,CAAA"}
+{"version":3,"file":"typeChecks.d.ts","sourceRoot":"","sources":["../../src/typeChecks.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAKjD,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yCAQ1B,CAAA;AAID,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yCAA2H,CAAA;AAEpJ,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAuC,CAAA;AAChE,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAyC,CAAA;AACpE,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gEAAmC,CAAA;AAC9D,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gEAAqC,CAAA"}

package/package.json

@@ -11,15 +11,15 @@
   },
   "dependencies": {
     "@xylabs/promise": "^2.13.23",
-    "@xyo-network/manifest-model": "~2.87.0",
-    "@xyo-network/module-events": "~2.87.0",
-    "@xyo-network/module-model": "~2.87.0",
-    "@xyo-network/object": "~2.87.0",
-    "@xyo-network/payload-model": "~2.87.0"
+    "@xyo-network/manifest-model": "~2.87.1",
+    "@xyo-network/module-events": "~2.87.1",
+    "@xyo-network/module-model": "~2.87.1",
+    "@xyo-network/object": "~2.87.1",
+    "@xyo-network/payload-model": "~2.87.1"
   },
   "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",
@@ -61,6 +61,6 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.87.0",
+  "version": "2.87.1",
   "type": "module"
 }

package/src/Node.ts

@@ -1,5 +1,4 @@
 import { Promisable } from '@xylabs/promise'
-import { ModuleManifestPayload } from '@xyo-network/manifest-model'
 import { Module, ModuleEventData, ModuleInstance } from '@xyo-network/module-model'
 
 import { ModuleAttachedEventData, ModuleDetachedEventData, ModuleRegisteredEventData, ModuleUnregisteredEventData } from './EventsModels'
@@ -9,7 +8,6 @@ export interface NodeQueryFunctions {
   attach(nameOrAddress: string, external?: boolean): Promisable<string | undefined>
   attached(): Promisable<string[]>
   detach(nameOrAddress: string): Promisable<string | undefined>
-  manifest(maxDepth?: number): Promise<ModuleManifestPayload>
   registered(): Promisable<string[]>
 }
 
@@ -20,17 +18,13 @@ export interface NodeModuleEventData
     ModuleUnregisteredEventData,
     ModuleEventData {}
 
-export type NodeModule<TParams extends NodeParams = NodeParams, TEventData extends NodeModuleEventData = NodeModuleEventData> = Module<
-  TParams,
-  TEventData
->
+export interface NodeModule<TParams extends NodeParams = NodeParams, TEventData extends NodeModuleEventData = NodeModuleEventData>
+  extends Module<TParams, TEventData> {}
 
-export type NodeInstance<TParams extends NodeParams = NodeParams, TEventData extends NodeModuleEventData = NodeModuleEventData> = NodeModule<
-  TParams,
-  TEventData
-> &
-  NodeQueryFunctions &
-  ModuleInstance & {
-    register: (mod: ModuleInstance) => Promisable<void>
-    registeredModules(): Promisable<ModuleInstance[]>
-  }
+export interface NodeInstance<TParams extends NodeParams = NodeParams, TEventData extends NodeModuleEventData = NodeModuleEventData>
+  extends NodeModule<TParams, TEventData>,
+    NodeQueryFunctions,
+    ModuleInstance<TParams, TEventData> {
+  register: (mod: ModuleInstance) => Promisable<void>
+  registeredModules(): Promisable<ModuleInstance[]>
+}