@xyo-network/module-model 2.64.6 → 2.64.8

package/src/isModule.ts

@@ -1,24 +1,69 @@
-import { Module } from './Module'
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Module, ModuleInstance } from './Module'
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type ModuleTypeCheck<T extends Module = Module> = (module: any) => module is T
+export type InstanceTypeCheck<T extends object = object> = (module: object) => module is T
+
+export type ModuleTypeCheck<T extends Module = Module> = InstanceTypeCheck<T>
+
+export type FieldType = 'string' | 'number' | 'object' | 'symbol' | 'symbol' | 'undefined' | 'null' | 'array' | 'function' | 'payload'
+
+export type InstanceTypeShape = Record<string | number | symbol, FieldType>
+
+export const isType = (value: any, expectedType: FieldType) => {
+  if (expectedType === 'array') {
+    return Array.isArray(value)
+  } else if (expectedType === 'payload') {
+    return typeof value === 'object' && typeof value.schema === 'string'
+  } else {
+    return typeof value === expectedType
+  }
+}
+
+export const IsInstanceFactory = {
+  create: <T extends object = object>(shape?: InstanceTypeShape, additionalCheck?: (module: any) => boolean): InstanceTypeCheck<T> => {
+    return (module: any = {}): module is T => {
+      return (
+        (additionalCheck?.(module) ?? true) &&
+        (Object.entries(shape ?? {}).reduce((prev, [key, type]) => prev && isType(module[key], type), true) ?? true)
+      )
+    }
+  },
+}
 
 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 => {
+  create: <T extends ModuleInstance = ModuleInstance>(expectedQueries?: string[], additionalCheck?: (module: any) => boolean): ModuleTypeCheck<T> => {
+    return (module: any = {}): module is T => {
       return (
-        (baseCheck?.(module) || true) &&
+        isModuleInstance(module) &&
         (additionalCheck?.(module) ?? true) &&
-        (expectedFunctions?.reduce((prev, value) => prev && typeof module[value] === 'function', true) ?? true)
+        (expectedQueries?.reduce((prev, query) => prev && module.queries.includes(query), true) ?? true)
       )
     }
   },
 }
 
-export const isModule: ModuleTypeCheck<Module> = IsModuleFactory.create<Module>(undefined, ['query'], (module) => typeof module.config === 'object')
+export const isModuleInstance: InstanceTypeCheck<ModuleInstance> = IsInstanceFactory.create<ModuleInstance>({
+  account: 'object',
+  address: 'string',
+  config: 'object',
+  discover: 'function',
+  downResolver: 'object',
+  manifest: 'function',
+  params: 'object',
+  queries: 'array',
+  query: 'function',
+  queryable: 'function',
+  upResolver: 'object',
+})
+
+export const isModule = <T extends Module = Module>(
+  module: any = {},
+  expectedQueries?: string[],
+  additionalCheck?: (module: any) => boolean,
+): module is T => {
+  return (
+    isModuleInstance(module) &&
+    (additionalCheck?.(module) ?? true) &&
+    (expectedQueries?.reduce((prev, query) => prev && module.queries.includes(query), true) ?? true)
+  )
+}

package/src/withModule.ts

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

package/dist/cjs/Queries/ModuleAccount/Query.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModuleAccountQuerySchema = void 0;
-exports.ModuleAccountQuerySchema = 'network.xyo.query.module.account';
-//# sourceMappingURL=Query.js.map

package/dist/cjs/Queries/ModuleAccount/Query.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Query.js","sourceRoot":"","sources":["../../../../src/Queries/ModuleAccount/Query.ts"],"names":[],"mappings":";;;AAGa,QAAA,wBAAwB,GAA6B,kCAAkC,CAAA"}

package/dist/cjs/Queries/ModuleAccount/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/Queries/ModuleAccount/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,kDAAuB"}

package/dist/esm/Queries/ModuleAccount/Query.js

@@ -1,2 +0,0 @@
-export const ModuleAccountQuerySchema = 'network.xyo.query.module.account';
-//# sourceMappingURL=Query.js.map

package/dist/esm/Queries/ModuleAccount/Query.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Query.js","sourceRoot":"","sources":["../../../../src/Queries/ModuleAccount/Query.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,wBAAwB,GAA6B,kCAAkC,CAAA"}

package/dist/esm/Queries/ModuleAccount/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/Queries/ModuleAccount/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}

package/dist/types/Queries/ModuleAccount/Query.d.ts

@@ -1,7 +0,0 @@
-import { Query } from '../../Query';
-export type ModuleAccountQuerySchema = 'network.xyo.query.module.account';
-export declare const ModuleAccountQuerySchema: ModuleAccountQuerySchema;
-export type ModuleAccountQuery = Query<{
-    schema: ModuleAccountQuerySchema;
-}>;
-//# sourceMappingURL=Query.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Queries/ModuleAccount/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}

package/src/Queries/ModuleAccount/Query.ts

@@ -1,8 +0,0 @@
-import { Query } from '../../Query'
-
-export type ModuleAccountQuerySchema = 'network.xyo.query.module.account'
-export const ModuleAccountQuerySchema: ModuleAccountQuerySchema = 'network.xyo.query.module.account'
-
-export type ModuleAccountQuery = Query<{
-  schema: ModuleAccountQuerySchema
-}>