@xyo-network/module-model 2.73.4 → 2.74.1

package/src/{ModuleFactory.ts → CreatableModule/ModuleFactory.ts}

@@ -2,8 +2,9 @@ import { assertEx } from '@xylabs/assert'
 import { merge } from '@xylabs/lodash'
 import { Logger } from '@xyo-network/logger'
 
+import { ModuleInstance } from '../instance'
+import { Labels, WithOptionalLabels } from '../Labels'
 import { CreatableModule, CreatableModuleFactory } from './CreatableModule'
-import { ModuleInstance } from './instance'
 
 export class ModuleFactory<TModule extends ModuleInstance> implements CreatableModuleFactory<TModule> {
   configSchemas: CreatableModuleFactory<TModule>['configSchemas']
@@ -14,10 +15,17 @@ export class ModuleFactory<TModule extends ModuleInstance> implements CreatableM
 
   defaultParams?: Omit<TModule['params'], 'config'> & { config?: TModule['params']['config'] }
 
-  constructor(creatableModule: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & { config?: TModule['params']['config'] }) {
+  labels?: Labels
+
+  constructor(
+    creatableModule: CreatableModule<TModule>,
+    params?: Omit<TModule['params'], 'config'> & { config?: TModule['params']['config'] },
+    labels: Labels = {},
+  ) {
     this.creatableModule = creatableModule
     this.defaultParams = params
     this.configSchemas = creatableModule.configSchemas
+    this.labels = Object.assign({}, (creatableModule as WithOptionalLabels).labels ?? {}, labels ?? {})
   }
 
   get configSchema(): string {
@@ -27,8 +35,9 @@ export class ModuleFactory<TModule extends ModuleInstance> implements CreatableM
   static withParams<T extends ModuleInstance>(
     creatableModule: CreatableModule<T>,
     params?: Omit<T['params'], 'config'> & { config?: T['params']['config'] },
+    labels: Labels = {},
   ) {
-    return new ModuleFactory(creatableModule, params)
+    return new ModuleFactory(creatableModule, params, labels)
   }
 
   _getRootFunction(funcName: string) {

package/src/CreatableModule/ModuleFactoryLocator.ts

@@ -0,0 +1,84 @@
+import { assertEx } from '@xylabs/assert'
+
+import { ModuleInstance } from '../instance'
+import { hasAllLabels, Labels } from '../Labels'
+import { CreatableModuleFactory } from './CreatableModule'
+import { CreatableModuleRegistry } from './CreatableModuleRegistry'
+import { hasLabels, LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory'
+
+/**
+ * A class which encapsulates the Service Locator Pattern for Module Factories
+ */
+export class ModuleFactoryLocator {
+  constructor(protected readonly _registry: CreatableModuleRegistry = {}) {}
+
+  /**
+   * The current registry for the module factory
+   */
+  get registry(): Readonly<CreatableModuleRegistry> {
+    return this._registry
+  }
+
+  /**
+   * Locates a module factory that matches the supplied schema and labels
+   * @param schema The config schema for the module
+   * @param labels The labels for the module factory
+   * @returns A module factory that matches the supplied schema and labels or throws if one is not found
+   */
+  locate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory {
+    return assertEx(this.tryLocate(schema, labels), () => {
+      const configString = `config schema [${schema}]`
+      const labelsString = labels ? ` & labels [${JSON.stringify(labels)}]` : ''
+      return `No module factory for the supplied ${configString}${labelsString} registered`
+    })
+  }
+
+  /**
+   * Registers a single module factory (with optional tags) with the locator
+   * @param additional Additional module factories to register
+   */
+  register<TModule extends ModuleInstance>(mod: CreatableModuleFactory<TModule>, labels?: Labels): this {
+    mod.configSchemas.map((schema) => {
+      const existingFactories = this._registry[schema]
+      const factory: LabeledCreatableModuleFactory<TModule> = {
+        // Destructure instance properties
+        ...mod,
+        // Copy static methods
+        create: mod.create.bind(mod) as LabeledCreatableModuleFactory<TModule>['create'],
+        // Merge module & supplied labels
+        labels: Object.assign({}, (mod as LabeledCreatableModuleFactory).labels ?? {}, labels ?? {}),
+      }
+      this._registry[schema] = existingFactories ? [...existingFactories, factory] : [factory]
+    })
+    return this
+  }
+
+  /**
+   * Registers multiple module factories with the locator
+   * @param additional Additional module factories to register
+   */
+  registerMany(additional: CreatableModuleRegistry): this {
+    Object.entries(additional).map(([schema, factories]) => {
+      if (factories) {
+        const existingFactories = this._registry[schema]
+        this._registry[schema] = existingFactories ? [...existingFactories, ...factories] : factories
+      }
+    })
+    return this
+  }
+
+  /**
+   * Tries to locate a module factory that matches the supplied schema and labels
+   * @param schema The config schema for the module
+   * @param labels The labels for the module factory
+   * @returns A module factory that matches the supplied schema and labels or undefined
+   */
+  tryLocate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory | undefined {
+    // If labels were provided
+    return labels
+      ? // Find the first factory that has labels and has all the labels provided
+        this._registry[schema]?.filter(hasLabels).find((factory) => hasAllLabels(factory?.labels, labels))
+      : // Otherwise, return the first factory
+        this._registry[schema]?.[0]
+  }
+}

package/src/CreatableModule/index.ts

@@ -0,0 +1,6 @@
+export * from './CreatableModule'
+export * from './CreatableModuleDictionary'
+export * from './CreatableModuleRegistry'
+export * from './LabeledCreatableModuleFactory'
+export * from './ModuleFactory'
+export * from './ModuleFactoryLocator'

package/src/Labels/Labels.ts

@@ -0,0 +1,34 @@
+/**
+ * Object used to represent labels identifying a resource.
+ */
+export interface Labels {
+  [key: string]: string | undefined
+}
+
+/**
+ * Interface for objects that have labels.
+ */
+export interface WithLabels<T extends Labels = Labels> {
+  labels: T
+}
+
+/**
+ * Interface for objects that have labels.
+ */
+export interface WithOptionalLabels<T extends Labels = Labels> {
+  labels?: T
+}
+
+/**
+ * Returns true if the source object has all the labels from the required set
+ * @param source Source object to check against
+ * @param required Set of labels to check for in source
+ * @returns True of the source object has all the labels from the required set
+ */
+export const hasAllLabels = (source?: Labels, required?: Labels): boolean => {
+  if (!required) return true
+  return Object.entries(required).every(([key, value]) => {
+    // eslint-disable-next-line no-prototype-builtins
+    return source?.hasOwnProperty(key as keyof typeof source) && source?.[key as keyof typeof source] === value
+  })
+}

package/src/Labels/index.ts

@@ -0,0 +1 @@
+export * from './Labels'

package/src/ModuleParams.ts

@@ -4,20 +4,15 @@ import { WalletInstance } from '@xyo-network/wallet-model'
 
 import { AnyConfigSchema, ModuleConfig } from './Config'
 
-export type BasicModuleParams<
-  TConfig extends AnyConfigSchema<ModuleConfig>,
-  TAdditionalParams extends AnyObject | undefined = undefined,
+export type ModuleParams<
+  TConfig extends AnyConfigSchema<ModuleConfig> | void = void,
+  TAdditionalParams extends AnyObject | void = void,
 > = WithAdditional<
   BaseParams<{
     account?: AccountInstance | 'random'
-    config: TConfig
+    config: TConfig extends AnyConfigSchema<ModuleConfig> ? TConfig : AnyConfigSchema<ModuleConfig>
     ephemeralQueryAccountEnabled?: boolean
     wallet?: WalletInstance
   }>,
   TAdditionalParams
 >
-
-export type ModuleParams<
-  TConfig extends AnyConfigSchema<ModuleConfig> = ModuleConfig,
-  TAdditionalParams extends AnyObject | undefined = undefined,
-> = BasicModuleParams<TConfig, TAdditionalParams>

package/src/index.ts

@@ -1,12 +1,11 @@
 export * from './Config'
 export * from './CreatableModule'
-export * from './CreatableModuleDictionary'
-export * from './Events'
+export * from './EventsModels'
 export * from './instance'
+export * from './Labels'
 export * from './lib'
 export * from './module'
 export * from './ModuleDescription'
-export * from './ModuleFactory'
 export * from './ModuleParams'
 export * from './ModuleQueryHandlerResult'
 export * from './ModuleQueryResult'

package/src/instance/ModuleInstance.ts

@@ -1,8 +1,8 @@
-import { IsObjectFactory, ObjectTypeCheck } from '@xyo-network/object-identity'
+import { IsObjectFactory, ObjectTypeCheck } from '@xyo-network/object'
 import { Promisable } from '@xyo-network/promise'
 
 import { AnyConfigSchema, ModuleConfig } from '../Config'
-import { ModuleEventData } from '../Events'
+import { ModuleEventData } from '../EventsModels'
 import { Module, ModuleQueryFunctions } from '../module'
 import { ModuleParams } from '../ModuleParams'
 

package/src/instance/asModuleInstance.ts

@@ -1,4 +1,4 @@
-import { AsObjectFactory } from '@xyo-network/object-identity'
+import { AsObjectFactory } from '@xyo-network/object'
 
 import { isModuleInstance } from './isModuleInstance'
 

package/src/instance/isModuleInstance.ts

@@ -1,4 +1,4 @@
-import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object-identity'
+import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'
 
 import { isModule } from '../module'
 import { ModuleInstance } from './ModuleInstance'

package/src/module/IsModuleFactory.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { ObjectTypeCheck } from '@xyo-network/object-identity'
+import { ObjectTypeCheck } from '@xyo-network/object'
 
 import { asModuleObject } from './asModuleObject'
 import { isModuleObject } from './isModuleObject'

package/src/module/Module.ts

@@ -1,11 +1,10 @@
 import { EventFunctions } from '@xyo-network/module-events'
 
-import { AnyConfigSchema, ModuleConfig } from '../Config'
-import { ModuleEventData } from '../Events'
+import { ModuleEventData } from '../EventsModels'
 import { ModuleParams } from '../ModuleParams'
 import { ModuleFields } from './ModuleFields'
 
 export type Module<
-  TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,
+  TParams extends ModuleParams = ModuleParams,
   TEventData extends ModuleEventData<object> = ModuleEventData<object>,
 > = ModuleFields<TParams> & EventFunctions<TEventData>

package/src/module/ModuleFields.ts

@@ -2,11 +2,11 @@ import { QueryBoundWitness } from '@xyo-network/boundwitness-builder'
 import { Payload } from '@xyo-network/payload-model'
 import { Promisable } from '@xyo-network/promise'
 
-import { AnyConfigSchema, ModuleConfig } from '../Config'
+import { ModuleConfig } from '../Config'
 import { ModuleParams } from '../ModuleParams'
 import { ModuleQueryResult } from '../ModuleQueryResult'
 
-export type ModuleFields<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
+export type ModuleFields<TParams extends ModuleParams = ModuleParams> = {
   address: string
   config: TParams['config']
 

package/src/module/asModule.ts

@@ -1,4 +1,4 @@
-import { AsObjectFactory } from '@xyo-network/object-identity'
+import { AsObjectFactory } from '@xyo-network/object'
 
 import { isModule } from './isModule'
 

package/src/module/asModuleObject.ts

@@ -1,4 +1,4 @@
-import { AsObjectFactory } from '@xyo-network/object-identity'
+import { AsObjectFactory } from '@xyo-network/object'
 
 import { isModuleObject } from './isModuleObject'
 

package/src/module/isModule.ts

@@ -1,4 +1,4 @@
-import { ObjectTypeCheck } from '@xyo-network/object-identity'
+import { ObjectTypeCheck } from '@xyo-network/object'
 
 import { ModuleDiscoverQuerySchema } from '../Queries'
 import { IsModuleFactory } from './IsModuleFactory'

package/src/module/isModuleObject.ts

@@ -1,4 +1,4 @@
-import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object-identity'
+import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'
 
 import { Module } from './Module'
 

package/src/withModule.ts

@@ -1,4 +1,4 @@
-import { ObjectTypeCheck } from '@xyo-network/object-identity'
+import { ObjectTypeCheck } from '@xyo-network/object'
 
 import { isModuleInstance } from './instance'
 import { isModule } from './module'

package/tsup.config.ts

@@ -1,16 +0,0 @@
-import { defineConfig } from 'tsup'
-
-// eslint-disable-next-line import/no-default-export
-export default defineConfig({
-  bundle: true,
-  cjsInterop: true,
-  clean: false,
-  dts: {
-    entry: ['src/index.ts'],
-  },
-  entry: ['src/index.ts'],
-  format: ['cjs', 'esm'],
-  sourcemap: true,
-  splitting: false,
-  tsconfig: 'tsconfig.json',
-})