@xyo-network/module-factory-locator 2.98.3

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@xyo-network/module-factory-locator",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^3.1.10",
+    "@xyo-network/archivist-memory": "~2.98.3",
+    "@xyo-network/archivist-model": "~2.98.3",
+    "@xyo-network/archivist-view": "~2.98.3",
+    "@xyo-network/bridge-model": "~2.98.3",
+    "@xyo-network/diviner-identity": "~2.98.3",
+    "@xyo-network/diviner-model": "~2.98.3",
+    "@xyo-network/http-bridge": "~2.98.3",
+    "@xyo-network/module-model": "~2.98.3",
+    "@xyo-network/node-memory": "~2.98.3",
+    "@xyo-network/node-model": "~2.98.3",
+    "@xyo-network/node-view": "~2.98.3",
+    "@xyo-network/payload-model": "~2.98.3",
+    "@xyo-network/sentinel-memory": "~2.98.3",
+    "@xyo-network/sentinel-model": "~2.98.3",
+    "@xyo-network/witness-adhoc": "~2.98.3",
+    "@xyo-network/witness-model": "~2.98.3"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.9.1",
+    "@xylabs/tsconfig": "^3.9.1",
+    "typescript": "^5.4.5"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "types": "dist/node/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.cts",
+          "default": "./dist/node/index.cjs"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.js"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.98.3",
+  "type": "module"
+}

package/src/ModuleFactoryLocator.ts

@@ -0,0 +1,101 @@
+import { assertEx } from '@xylabs/assert'
+import {
+  AttachableModuleInstance,
+  CreatableModuleFactory,
+  CreatableModuleRegistry,
+  hasAllLabels,
+  hasLabels,
+  LabeledCreatableModuleFactory,
+  Labels,
+} from '@xyo-network/module-model'
+import { Schema } from '@xyo-network/payload-model'
+
+import { standardCreatableFactories } from './standardCreatableFactories'
+
+/**
+ * A class which encapsulates the Service Locator Pattern for Module Factories
+ */
+export class ModuleFactoryLocator {
+  constructor(protected readonly _registry: CreatableModuleRegistry = standardCreatableFactories()) {}
+
+  /**
+   * 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),
+      () => `No module factory for the supplied ${`config schema [${schema}]`}${labels ? ` & labels [${JSON.stringify(labels)}]` : ''} registered`,
+    )
+  }
+
+  /**
+   * Registers a single module factory (with optional tags) with the locator
+   * @param additional Additional module factories to register
+   */
+  register(mod: CreatableModuleFactory, labels?: Labels): this {
+    this.registerOne(mod, mod.defaultConfigSchema, labels, true)
+    mod.configSchemas.map((schema) => {
+      this.registerOne(mod, schema, labels, false)
+    })
+    return this
+  }
+
+  /**
+   * Registers multiple module factories with the locator
+   * @param additional Additional module factories to register
+   */
+  registerMany(mods: CreatableModuleFactory[]): this {
+    for (const mod of mods) {
+      this.register(mod)
+    }
+    return this
+  }
+
+  /**
+   * Registers a single module factory (with optional tags) with the locator & a specific schema
+   * @param additional Additional module factories to register
+   */
+  registerOne<TModule extends AttachableModuleInstance>(
+    mod: CreatableModuleFactory<TModule>,
+    schema: Schema,
+    labels?: Labels,
+    primary = false,
+  ): this {
+    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] = primary ? [factory, ...(existingFactories ?? [])] : [...(existingFactories ?? []), factory]
+    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/index.ts

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

package/src/standardCreatableFactories.ts

@@ -0,0 +1,42 @@
+import { MemoryArchivist } from '@xyo-network/archivist-memory'
+import { ArchivistConfigSchema } from '@xyo-network/archivist-model'
+import { ViewArchivist } from '@xyo-network/archivist-view'
+import { BridgeConfigSchema } from '@xyo-network/bridge-model'
+import { IdentityDiviner } from '@xyo-network/diviner-identity'
+import { DivinerConfigSchema } from '@xyo-network/diviner-model'
+import { HttpBridge } from '@xyo-network/http-bridge'
+import {
+  CreatableModuleFactory,
+  LabeledCreatableModuleFactory,
+  registerCreatableModuleFactories,
+  registerPrimaryCreatableModuleFactory,
+} from '@xyo-network/module-model'
+import { MemoryNode } from '@xyo-network/node-memory'
+import { NodeConfigSchema } from '@xyo-network/node-model'
+import { ViewNode } from '@xyo-network/node-view'
+import { MemorySentinel } from '@xyo-network/sentinel-memory'
+import { SentinelConfigSchema } from '@xyo-network/sentinel-model'
+import { AdhocWitness } from '@xyo-network/witness-adhoc'
+import { WitnessConfigSchema } from '@xyo-network/witness-model'
+
+export const standardCreatableFactoriesList: (CreatableModuleFactory | LabeledCreatableModuleFactory)[] = [
+  MemoryArchivist,
+  HttpBridge,
+  MemoryArchivist,
+  MemoryNode,
+  MemorySentinel,
+  ViewArchivist,
+  ViewNode,
+  AdhocWitness,
+]
+
+export const standardCreatableFactories = () => {
+  const registry = registerCreatableModuleFactories(standardCreatableFactoriesList)
+  registerPrimaryCreatableModuleFactory(registry, MemoryNode, NodeConfigSchema)
+  registerPrimaryCreatableModuleFactory(registry, MemoryArchivist, ArchivistConfigSchema)
+  registerPrimaryCreatableModuleFactory(registry, MemorySentinel, SentinelConfigSchema)
+  registerPrimaryCreatableModuleFactory(registry, AdhocWitness, WitnessConfigSchema)
+  registerPrimaryCreatableModuleFactory(registry, IdentityDiviner, DivinerConfigSchema)
+  registerPrimaryCreatableModuleFactory(registry, HttpBridge, BridgeConfigSchema)
+  return registry
+}

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}