@xyo-network/module-model 2.64.4 → 2.64.6

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 export * from './Config';
 export * from './CreatableModule';
 export * from './Error';
+export * from './isModule';
 export * from './Module';
 export * from './ModuleDescription';
 export * from './ModuleFilter';
@@ -9,4 +10,5 @@ export * from './ModuleQueryResult';
 export * from './ModuleRepository';
 export * from './Queries';
 export * from './Query';
+export * from './withModule';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA"}

package/dist/esm/isModule.js

@@ -0,0 +1,14 @@
+export const IsModuleFactory = {
+    create: (baseCheck, expectedFunctions, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    additionalCheck) => {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return (module) => {
+            return ((baseCheck?.(module) || true) &&
+                (additionalCheck?.(module) ?? true) &&
+                (expectedFunctions?.reduce((prev, value) => prev && typeof module[value] === 'function', true) ?? true));
+        };
+    },
+};
+export const isModule = IsModuleFactory.create(undefined, ['query'], (module) => typeof module.config === 'object');
+//# sourceMappingURL=isModule.js.map

package/dist/esm/isModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isModule.js","sourceRoot":"","sources":["../../src/isModule.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE,CACN,SAA2B,EAC3B,iBAA4B;IAC5B,8DAA8D;IAC9D,eAA0C,EACtB,EAAE;QACtB,8DAA8D;QAC9D,OAAO,CAAC,MAAW,EAAe,EAAE;YAClC,OAAO,CACL,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;gBAC7B,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;gBACnC,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,UAAU,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,CACxG,CAAA;QACH,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAA4B,eAAe,CAAC,MAAM,CAAS,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAA"}

package/dist/esm/withModule.js

@@ -0,0 +1,14 @@
+import { isModule } from './isModule';
+export const WithModuleFactory = {
+    create: (typeCheck) => {
+        return (
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        module, 
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        closure) => {
+            return typeCheck(module) ? closure(module) : undefined;
+        };
+    },
+};
+export const withModule = WithModuleFactory.create(isModule);
+//# sourceMappingURL=withModule.js.map

package/dist/esm/withModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withModule.js","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmB,MAAM,YAAY,CAAA;AAGtD,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,MAAM,EAAE,CAA4B,SAA6B,EAAE,EAAE;QACnE,OAAO;QACL,8DAA8D;QAC9D,MAAW;QACX,8DAA8D;QAC9D,OAA2B,EACZ,EAAE;YACjB,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACxD,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA"}

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from './Config';
 export * from './CreatableModule';
 export * from './Error';
+export * from './isModule';
 export * from './Module';
 export * from './ModuleDescription';
 export * from './ModuleFilter';
@@ -9,4 +10,5 @@ export * from './ModuleQueryResult';
 export * from './ModuleRepository';
 export * from './Queries';
 export * from './Query';
+export * from './withModule';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA"}

package/dist/types/isModule.d.ts

@@ -0,0 +1,7 @@
+import { Module } from './Module';
+export type ModuleTypeCheck<T extends Module = Module> = (module: any) => module is T;
+export declare const IsModuleFactory: {
+    create: <T extends Module = Module>(baseCheck?: ModuleTypeCheck, expectedFunctions?: string[], additionalCheck?: ((module: any) => boolean) | undefined) => ModuleTypeCheck<T>;
+};
+export declare const isModule: ModuleTypeCheck<Module>;
+//# sourceMappingURL=isModule.d.ts.map

package/dist/types/isModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isModule.d.ts","sourceRoot":"","sources":["../../src/isModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAGjC,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,MAAM,IAAI,CAAC,CAAA;AAErF,eAAO,MAAM,eAAe;oDAEZ,eAAe,sBACP,MAAM,EAAE,8BAED,GAAG,KAAK,OAAO;CAW7C,CAAA;AAED,eAAO,MAAM,QAAQ,EAAE,eAAe,CAAC,MAAM,CAAuG,CAAA"}

package/dist/types/withModule.d.ts

@@ -0,0 +1,7 @@
+import { ModuleTypeCheck } from './isModule';
+import { Module } from './Module';
+export declare const WithModuleFactory: {
+    create: <T extends Module = Module>(typeCheck: ModuleTypeCheck<T>) => <R extends void = void>(module: any, closure: (module: any) => R) => R | undefined;
+};
+export declare const withModule: <R extends void = void>(module: any, closure: (module: any) => R) => R | undefined;
+//# sourceMappingURL=withModule.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,eAAe,EAAE,MAAM,YAAY,CAAA;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,eAAO,MAAM,iBAAiB;0GAIhB,GAAG,oBAEO,GAAG;CAK1B,CAAA;AAED,eAAO,MAAM,UAAU,kCATT,GAAG,oBAEO,GAAG,wBAOiC,CAAA"}

package/package.json

@@ -10,15 +10,15 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/account-model": "^2.64.4",
-    "@xyo-network/address-payload-plugin": "^2.64.4",
-    "@xyo-network/boundwitness-model": "^2.64.4",
-    "@xyo-network/core": "^2.64.4",
-    "@xyo-network/manifest-model": "^2.64.4",
-    "@xyo-network/module-events": "^2.64.4",
-    "@xyo-network/payload-model": "^2.64.4",
-    "@xyo-network/promise": "^2.64.4",
-    "@xyo-network/wallet-model": "^2.64.4"
+    "@xyo-network/account-model": "^2.64.6",
+    "@xyo-network/address-payload-plugin": "^2.64.6",
+    "@xyo-network/boundwitness-model": "^2.64.6",
+    "@xyo-network/core": "^2.64.6",
+    "@xyo-network/manifest-model": "^2.64.6",
+    "@xyo-network/module-events": "^2.64.6",
+    "@xyo-network/payload-model": "^2.64.6",
+    "@xyo-network/promise": "^2.64.6",
+    "@xyo-network/wallet-model": "^2.64.6"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^2.18.5",
@@ -58,5 +58,5 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.64.4"
+  "version": "2.64.6"
 }

package/src/index.ts

@@ -1,6 +1,7 @@
 export * from './Config'
 export * from './CreatableModule'
 export * from './Error'
+export * from './isModule'
 export * from './Module'
 export * from './ModuleDescription'
 export * from './ModuleFilter'
@@ -9,3 +10,4 @@ export * from './ModuleQueryResult'
 export * from './ModuleRepository'
 export * from './Queries'
 export * from './Query'
+export * from './withModule'

package/src/isModule.ts

@@ -0,0 +1,24 @@
+import { Module } from './Module'
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type ModuleTypeCheck<T extends Module = Module> = (module: any) => module is T
+
+export const IsModuleFactory = {
+  create: <T extends Module = Module>(
+    baseCheck?: ModuleTypeCheck,
+    expectedFunctions?: string[],
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    additionalCheck?: (module: any) => boolean,
+  ): ModuleTypeCheck<T> => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return (module: any): module is T => {
+      return (
+        (baseCheck?.(module) || true) &&
+        (additionalCheck?.(module) ?? true) &&
+        (expectedFunctions?.reduce((prev, value) => prev && typeof module[value] === 'function', true) ?? true)
+      )
+    }
+  },
+}
+
+export const isModule: ModuleTypeCheck<Module> = IsModuleFactory.create<Module>(undefined, ['query'], (module) => typeof module.config === 'object')

package/src/withModule.ts

@@ -0,0 +1,17 @@
+import { isModule, ModuleTypeCheck } from './isModule'
+import { Module } from './Module'
+
+export const WithModuleFactory = {
+  create: <T extends Module = Module>(typeCheck: ModuleTypeCheck<T>) => {
+    return <R extends void = void>(
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      module: any,
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      closure: (module: any) => R,
+    ): R | undefined => {
+      return typeCheck(module) ? closure(module) : undefined
+    }
+  },
+}
+
+export const withModule = WithModuleFactory.create(isModule)