@xyo-network/module-model 2.74.5 → 2.75.1

package/dist/browser/CreatableModule/ModuleFactory.js

@@ -0,0 +1,48 @@
+import { assertEx } from "@xylabs/assert";
+import { merge } from "@xylabs/lodash";
+class ModuleFactory {
+  configSchemas;
+  creatableModule;
+  defaultLogger;
+  defaultParams;
+  labels;
+  constructor(creatableModule, params, labels = {}) {
+    this.creatableModule = creatableModule;
+    this.defaultParams = params;
+    this.configSchemas = creatableModule.configSchemas;
+    this.labels = Object.assign({}, creatableModule.labels ?? {}, labels ?? {});
+  }
+  get configSchema() {
+    return this.configSchemas[0];
+  }
+  static withParams(creatableModule, params, labels = {}) {
+    return new ModuleFactory(creatableModule, params, labels);
+  }
+  _getRootFunction(funcName) {
+    let anyThis = this;
+    while (anyThis.__proto__[funcName]) {
+      anyThis = anyThis.__proto__;
+    }
+    return anyThis[funcName];
+  }
+  _noOverride(functionName) {
+    const thisFunc = this[functionName];
+    const rootFunc = this._getRootFunction(functionName);
+    assertEx(thisFunc === rootFunc, `Override not allowed for [${functionName}] - override ${functionName}Handler instead`);
+  }
+  create(params) {
+    const factory = this;
+    const schema = factory.creatableModule.configSchema;
+    const mergedParams = merge({}, factory.defaultParams, params, {
+      config: merge({}, factory.defaultParams?.config, params?.config, { schema })
+    });
+    return factory.creatableModule.create(mergedParams);
+  }
+  factory(_params) {
+    throw new Error("Method not implemented.");
+  }
+}
+export {
+  ModuleFactory
+};
+//# sourceMappingURL=ModuleFactory.js.map

package/dist/browser/CreatableModule/ModuleFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/CreatableModule/ModuleFactory.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { merge } from '@xylabs/lodash'\nimport { Logger } from '@xyo-network/logger'\n\nimport { ModuleInstance } from '../instance'\nimport { Labels, WithOptionalLabels } from '../Labels'\nimport { CreatableModule, CreatableModuleFactory } from './CreatableModule'\n\nexport class ModuleFactory<TModule extends ModuleInstance> implements CreatableModuleFactory<TModule> {\n  configSchemas: CreatableModuleFactory<TModule>['configSchemas']\n\n  creatableModule: CreatableModule<TModule>\n\n  defaultLogger?: Logger | undefined\n\n  defaultParams?: Omit<TModule['params'], 'config'> & { config?: TModule['params']['config'] }\n\n  labels?: Labels\n\n  constructor(\n    creatableModule: CreatableModule<TModule>,\n    params?: Omit<TModule['params'], 'config'> & { config?: TModule['params']['config'] },\n    labels: Labels = {},\n  ) {\n    this.creatableModule = creatableModule\n    this.defaultParams = params\n    this.configSchemas = creatableModule.configSchemas\n    this.labels = Object.assign({}, (creatableModule as WithOptionalLabels).labels ?? {}, labels ?? {})\n  }\n\n  get configSchema(): string {\n    return this.configSchemas[0]\n  }\n\n  static withParams<T extends ModuleInstance>(\n    creatableModule: CreatableModule<T>,\n    params?: Omit<T['params'], 'config'> & { config?: T['params']['config'] },\n    labels: Labels = {},\n  ) {\n    return new ModuleFactory(creatableModule, params, labels)\n  }\n\n  _getRootFunction(funcName: string) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    let anyThis = this as any\n    while (anyThis.__proto__[funcName]) {\n      anyThis = anyThis.__proto__\n    }\n    return anyThis[funcName]\n  }\n\n  _noOverride(functionName: string) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const thisFunc = (this as any)[functionName]\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const rootFunc = this._getRootFunction(functionName)\n    assertEx(thisFunc === rootFunc, `Override not allowed for [${functionName}] - override ${functionName}Handler instead`)\n  }\n\n  create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: TModule['params'] | undefined): Promise<T> {\n    const factory = this as ModuleFactory<T>\n    const schema = factory.creatableModule.configSchema\n    const mergedParams: TModule['params'] = merge({}, factory.defaultParams, params, {\n      config: merge({}, factory.defaultParams?.config, params?.config, { schema }),\n    })\n    return factory.creatableModule.create<T>(mergedParams)\n  }\n\n  factory<T extends ModuleInstance>(this: CreatableModule<T>, _params?: T['params'] | undefined): CreatableModuleFactory<T> {\n    throw new Error('Method not implemented.')\n  }\n}\n"],"mappings":"AAAA,SAAS,gBAAgB;AACzB,SAAS,aAAa;AAOf,MAAM,cAAyF;AAAA,EACpG;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA,YACE,iBACA,QACA,SAAiB,CAAC,GAClB;AACA,SAAK,kBAAkB;AACvB,SAAK,gBAAgB;AACrB,SAAK,gBAAgB,gBAAgB;AACrC,SAAK,SAAS,OAAO,OAAO,CAAC,GAAI,gBAAuC,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC;AAAA,EACpG;AAAA,EAEA,IAAI,eAAuB;AACzB,WAAO,KAAK,cAAc,CAAC;AAAA,EAC7B;AAAA,EAEA,OAAO,WACL,iBACA,QACA,SAAiB,CAAC,GAClB;AACA,WAAO,IAAI,cAAc,iBAAiB,QAAQ,MAAM;AAAA,EAC1D;AAAA,EAEA,iBAAiB,UAAkB;AAEjC,QAAI,UAAU;AACd,WAAO,QAAQ,UAAU,QAAQ,GAAG;AAClC,gBAAU,QAAQ;AAAA,IACpB;AACA,WAAO,QAAQ,QAAQ;AAAA,EACzB;AAAA,EAEA,YAAY,cAAsB;AAEhC,UAAM,WAAY,KAAa,YAAY;AAE3C,UAAM,WAAW,KAAK,iBAAiB,YAAY;AACnD,aAAS,aAAa,UAAU,6BAA6B,YAAY,gBAAgB,YAAY,iBAAiB;AAAA,EACxH;AAAA,EAEA,OAAkE,QAAoD;AACpH,UAAM,UAAU;AAChB,UAAM,SAAS,QAAQ,gBAAgB;AACvC,UAAM,eAAkC,MAAM,CAAC,GAAG,QAAQ,eAAe,QAAQ;AAAA,MAC/E,QAAQ,MAAM,CAAC,GAAG,QAAQ,eAAe,QAAQ,QAAQ,QAAQ,EAAE,OAAO,CAAC;AAAA,IAC7E,CAAC;AACD,WAAO,QAAQ,gBAAgB,OAAU,YAAY;AAAA,EACvD;AAAA,EAEA,QAA4D,SAA8D;AACxH,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC3C;AACF;","names":[]}

package/dist/browser/CreatableModule/ModuleFactoryLocator.cjs

@@ -0,0 +1,114 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/CreatableModule/ModuleFactoryLocator.ts
+var ModuleFactoryLocator_exports = {};
+__export(ModuleFactoryLocator_exports, {
+  ModuleFactoryLocator: () => ModuleFactoryLocator
+});
+module.exports = __toCommonJS(ModuleFactoryLocator_exports);
+var import_assert = require("@xylabs/assert");
+
+// src/Labels/Labels.ts
+var hasAllLabels = (source, required) => {
+  if (!required)
+    return true;
+  return Object.entries(required).every(([key, value]) => {
+    return source?.hasOwnProperty(key) && source?.[key] === value;
+  });
+};
+
+// src/CreatableModule/LabeledCreatableModuleFactory.ts
+var hasLabels = (factory) => {
+  return factory.labels !== void 0;
+};
+
+// src/CreatableModule/ModuleFactoryLocator.ts
+var ModuleFactoryLocator = class {
+  constructor(_registry = {}) {
+    this._registry = _registry;
+  }
+  /**
+   * The current registry for the module factory
+   */
+  get registry() {
+    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, labels) {
+    return (0, import_assert.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(mod, labels) {
+    mod.configSchemas.map((schema) => {
+      const existingFactories = this._registry[schema];
+      const factory = {
+        // Destructure instance properties
+        ...mod,
+        // Copy static methods
+        create: mod.create.bind(mod),
+        // Merge module & supplied labels
+        labels: Object.assign({}, mod.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) {
+    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, labels) {
+    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]
+    );
+  }
+};
+//# sourceMappingURL=ModuleFactoryLocator.cjs.map

package/dist/browser/CreatableModule/ModuleFactoryLocator.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/CreatableModule/ModuleFactoryLocator.ts","../../../src/Labels/Labels.ts","../../../src/CreatableModule/LabeledCreatableModuleFactory.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\n\nimport { ModuleInstance } from '../instance'\nimport { hasAllLabels, Labels } from '../Labels'\nimport { CreatableModuleFactory } from './CreatableModule'\nimport { CreatableModuleRegistry } from './CreatableModuleRegistry'\nimport { hasLabels, LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory'\n\n/**\n * A class which encapsulates the Service Locator Pattern for Module Factories\n */\nexport class ModuleFactoryLocator {\n  constructor(protected readonly _registry: CreatableModuleRegistry = {}) {}\n\n  /**\n   * The current registry for the module factory\n   */\n  get registry(): Readonly<CreatableModuleRegistry> {\n    return this._registry\n  }\n\n  /**\n   * Locates a module factory that matches the supplied schema and labels\n   * @param schema The config schema for the module\n   * @param labels The labels for the module factory\n   * @returns A module factory that matches the supplied schema and labels or throws if one is not found\n   */\n  locate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory {\n    return assertEx(this.tryLocate(schema, labels), () => {\n      const configString = `config schema [${schema}]`\n      const labelsString = labels ? ` & labels [${JSON.stringify(labels)}]` : ''\n      return `No module factory for the supplied ${configString}${labelsString} registered`\n    })\n  }\n\n  /**\n   * Registers a single module factory (with optional tags) with the locator\n   * @param additional Additional module factories to register\n   */\n  register<TModule extends ModuleInstance>(mod: CreatableModuleFactory<TModule>, labels?: Labels): this {\n    mod.configSchemas.map((schema) => {\n      const existingFactories = this._registry[schema]\n      const factory: LabeledCreatableModuleFactory<TModule> = {\n        // Destructure instance properties\n        ...mod,\n        // Copy static methods\n        create: mod.create.bind(mod) as LabeledCreatableModuleFactory<TModule>['create'],\n        // Merge module & supplied labels\n        labels: Object.assign({}, (mod as LabeledCreatableModuleFactory).labels ?? {}, labels ?? {}),\n      }\n      this._registry[schema] = existingFactories ? [...existingFactories, factory] : [factory]\n    })\n    return this\n  }\n\n  /**\n   * Registers multiple module factories with the locator\n   * @param additional Additional module factories to register\n   */\n  registerMany(additional: CreatableModuleRegistry): this {\n    Object.entries(additional).map(([schema, factories]) => {\n      if (factories) {\n        const existingFactories = this._registry[schema]\n        this._registry[schema] = existingFactories ? [...existingFactories, ...factories] : factories\n      }\n    })\n    return this\n  }\n\n  /**\n   * Tries to locate a module factory that matches the supplied schema and labels\n   * @param schema The config schema for the module\n   * @param labels The labels for the module factory\n   * @returns A module factory that matches the supplied schema and labels or undefined\n   */\n  tryLocate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory | undefined {\n    // If labels were provided\n    return labels\n      ? // Find the first factory that has labels and has all the labels provided\n        this._registry[schema]?.filter(hasLabels).find((factory) => hasAllLabels(factory?.labels, labels))\n      : // Otherwise, return the first factory\n        this._registry[schema]?.[0]\n  }\n}\n","/**\n * Object used to represent labels identifying a resource.\n */\nexport interface Labels {\n  [key: string]: string | undefined\n}\n\n/**\n * Interface for objects that have labels.\n */\nexport interface WithLabels<T extends Labels = Labels> {\n  labels: T\n}\n\n/**\n * Interface for objects that have labels.\n */\nexport interface WithOptionalLabels<T extends Labels = Labels> {\n  labels?: T\n}\n\n/**\n * Returns true if the source object has all the labels from the required set\n * @param source Source object to check against\n * @param required Set of labels to check for in source\n * @returns True of the source object has all the labels from the required set\n */\nexport const hasAllLabels = (source?: Labels, required?: Labels): boolean => {\n  if (!required) return true\n  return Object.entries(required).every(([key, value]) => {\n    // eslint-disable-next-line no-prototype-builtins\n    return source?.hasOwnProperty(key as keyof typeof source) && source?.[key as keyof typeof source] === value\n  })\n}\n","import { ModuleInstance } from '../instance'\nimport { WithOptionalLabels } from '../Labels'\nimport { CreatableModuleFactory } from './CreatableModule'\n\nexport type LabeledCreatableModuleFactory<T extends ModuleInstance = ModuleInstance> = CreatableModuleFactory<T> & WithOptionalLabels\n\nexport const hasLabels = (factory: CreatableModuleFactory | LabeledCreatableModuleFactory): factory is LabeledCreatableModuleFactory => {\n  return (factory as LabeledCreatableModuleFactory).labels !== undefined\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAyB;;;AC2BlB,IAAM,eAAe,CAAC,QAAiB,aAA+B;AAC3E,MAAI,CAAC;AAAU,WAAO;AACtB,SAAO,OAAO,QAAQ,QAAQ,EAAE,MAAM,CAAC,CAAC,KAAK,KAAK,MAAM;AAEtD,WAAO,QAAQ,eAAe,GAA0B,KAAK,SAAS,GAA0B,MAAM;AAAA,EACxG,CAAC;AACH;;;AC3BO,IAAM,YAAY,CAAC,YAA8G;AACtI,SAAQ,QAA0C,WAAW;AAC/D;;;AFGO,IAAM,uBAAN,MAA2B;AAAA,EAChC,YAA+B,YAAqC,CAAC,GAAG;AAAzC;AAAA,EAA0C;AAAA;AAAA;AAAA;AAAA,EAKzE,IAAI,WAA8C;AAChD,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,QAAgB,QAAyE;AAC9F,eAAO,wBAAS,KAAK,UAAU,QAAQ,MAAM,GAAG,MAAM;AACpD,YAAM,eAAe,kBAAkB,MAAM;AAC7C,YAAM,eAAe,SAAS,cAAc,KAAK,UAAU,MAAM,CAAC,MAAM;AACxE,aAAO,sCAAsC,YAAY,GAAG,YAAY;AAAA,IAC1E,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAyC,KAAsC,QAAuB;AACpG,QAAI,cAAc,IAAI,CAAC,WAAW;AAChC,YAAM,oBAAoB,KAAK,UAAU,MAAM;AAC/C,YAAM,UAAkD;AAAA;AAAA,QAEtD,GAAG;AAAA;AAAA,QAEH,QAAQ,IAAI,OAAO,KAAK,GAAG;AAAA;AAAA,QAE3B,QAAQ,OAAO,OAAO,CAAC,GAAI,IAAsC,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC;AAAA,MAC7F;AACA,WAAK,UAAU,MAAM,IAAI,oBAAoB,CAAC,GAAG,mBAAmB,OAAO,IAAI,CAAC,OAAO;AAAA,IACzF,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,YAA2C;AACtD,WAAO,QAAQ,UAAU,EAAE,IAAI,CAAC,CAAC,QAAQ,SAAS,MAAM;AACtD,UAAI,WAAW;AACb,cAAM,oBAAoB,KAAK,UAAU,MAAM;AAC/C,aAAK,UAAU,MAAM,IAAI,oBAAoB,CAAC,GAAG,mBAAmB,GAAG,SAAS,IAAI;AAAA,MACtF;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAAgB,QAAqF;AAE7G,WAAO;AAAA;AAAA,MAEH,KAAK,UAAU,MAAM,GAAG,OAAO,SAAS,EAAE,KAAK,CAAC,YAAY,aAAa,SAAS,QAAQ,MAAM,CAAC;AAAA;AAAA;AAAA,MAEjG,KAAK,UAAU,MAAM,IAAI,CAAC;AAAA;AAAA,EAChC;AACF;","names":[]}

package/dist/browser/CreatableModule/ModuleFactoryLocator.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleFactoryLocator.d.ts","sourceRoot":"","sources":["../../../src/CreatableModule/ModuleFactoryLocator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAgB,MAAM,EAAE,MAAM,WAAW,CAAA;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,EAAa,6BAA6B,EAAE,MAAM,iCAAiC,CAAA;AAE1F;;GAEG;AACH,qBAAa,oBAAoB;IACnB,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,uBAAuB;gBAAlC,SAAS,GAAE,uBAA4B;IAEtE;;OAEG;IACH,IAAI,QAAQ,IAAI,QAAQ,CAAC,uBAAuB,CAAC,CAEhD;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,6BAA6B;IAQ/F;;;OAGG;IACH,QAAQ,CAAC,OAAO,SAAS,cAAc,EAAE,GAAG,EAAE,sBAAsB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAgBrG;;;OAGG;IACH,YAAY,CAAC,UAAU,EAAE,uBAAuB,GAAG,IAAI;IAUvD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,6BAA6B,GAAG,SAAS;CAQ/G"}

package/dist/browser/CreatableModule/ModuleFactoryLocator.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleFactoryLocator.d.ts","sourceRoot":"","sources":["../../../src/CreatableModule/ModuleFactoryLocator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAgB,MAAM,EAAE,MAAM,WAAW,CAAA;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,EAAa,6BAA6B,EAAE,MAAM,iCAAiC,CAAA;AAE1F;;GAEG;AACH,qBAAa,oBAAoB;IACnB,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,uBAAuB;gBAAlC,SAAS,GAAE,uBAA4B;IAEtE;;OAEG;IACH,IAAI,QAAQ,IAAI,QAAQ,CAAC,uBAAuB,CAAC,CAEhD;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,6BAA6B;IAQ/F;;;OAGG;IACH,QAAQ,CAAC,OAAO,SAAS,cAAc,EAAE,GAAG,EAAE,sBAAsB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAgBrG;;;OAGG;IACH,YAAY,CAAC,UAAU,EAAE,uBAAuB,GAAG,IAAI;IAUvD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,6BAA6B,GAAG,SAAS;CAQ/G"}

package/dist/browser/CreatableModule/ModuleFactoryLocator.d.ts

@@ -0,0 +1,41 @@
+import { ModuleInstance } from '../instance';
+import { Labels } from '../Labels';
+import { CreatableModuleFactory } from './CreatableModule';
+import { CreatableModuleRegistry } from './CreatableModuleRegistry';
+import { LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory';
+/**
+ * A class which encapsulates the Service Locator Pattern for Module Factories
+ */
+export declare class ModuleFactoryLocator {
+    protected readonly _registry: CreatableModuleRegistry;
+    constructor(_registry?: CreatableModuleRegistry);
+    /**
+     * The current registry for the module factory
+     */
+    get registry(): Readonly<CreatableModuleRegistry>;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Registers multiple module factories with the locator
+     * @param additional Additional module factories to register
+     */
+    registerMany(additional: CreatableModuleRegistry): 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;
+}
+//# sourceMappingURL=ModuleFactoryLocator.d.ts.map

package/dist/browser/CreatableModule/ModuleFactoryLocator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleFactoryLocator.d.ts","sourceRoot":"","sources":["../../../src/CreatableModule/ModuleFactoryLocator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAgB,MAAM,EAAE,MAAM,WAAW,CAAA;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,EAAa,6BAA6B,EAAE,MAAM,iCAAiC,CAAA;AAE1F;;GAEG;AACH,qBAAa,oBAAoB;IACnB,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,uBAAuB;gBAAlC,SAAS,GAAE,uBAA4B;IAEtE;;OAEG;IACH,IAAI,QAAQ,IAAI,QAAQ,CAAC,uBAAuB,CAAC,CAEhD;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,6BAA6B;IAQ/F;;;OAGG;IACH,QAAQ,CAAC,OAAO,SAAS,cAAc,EAAE,GAAG,EAAE,sBAAsB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAgBrG;;;OAGG;IACH,YAAY,CAAC,UAAU,EAAE,uBAAuB,GAAG,IAAI;IAUvD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,6BAA6B,GAAG,SAAS;CAQ/G"}

package/dist/browser/CreatableModule/ModuleFactoryLocator.js

@@ -0,0 +1,78 @@
+import { assertEx } from "@xylabs/assert";
+import { hasAllLabels } from "../Labels";
+import { hasLabels } from "./LabeledCreatableModuleFactory";
+class ModuleFactoryLocator {
+  constructor(_registry = {}) {
+    this._registry = _registry;
+  }
+  /**
+   * The current registry for the module factory
+   */
+  get registry() {
+    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, labels) {
+    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(mod, labels) {
+    mod.configSchemas.map((schema) => {
+      const existingFactories = this._registry[schema];
+      const factory = {
+        // Destructure instance properties
+        ...mod,
+        // Copy static methods
+        create: mod.create.bind(mod),
+        // Merge module & supplied labels
+        labels: Object.assign({}, mod.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) {
+    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, labels) {
+    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]
+    );
+  }
+}
+export {
+  ModuleFactoryLocator
+};
+//# sourceMappingURL=ModuleFactoryLocator.js.map

package/dist/browser/CreatableModule/ModuleFactoryLocator.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/CreatableModule/ModuleFactoryLocator.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\n\nimport { ModuleInstance } from '../instance'\nimport { hasAllLabels, Labels } from '../Labels'\nimport { CreatableModuleFactory } from './CreatableModule'\nimport { CreatableModuleRegistry } from './CreatableModuleRegistry'\nimport { hasLabels, LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory'\n\n/**\n * A class which encapsulates the Service Locator Pattern for Module Factories\n */\nexport class ModuleFactoryLocator {\n  constructor(protected readonly _registry: CreatableModuleRegistry = {}) {}\n\n  /**\n   * The current registry for the module factory\n   */\n  get registry(): Readonly<CreatableModuleRegistry> {\n    return this._registry\n  }\n\n  /**\n   * Locates a module factory that matches the supplied schema and labels\n   * @param schema The config schema for the module\n   * @param labels The labels for the module factory\n   * @returns A module factory that matches the supplied schema and labels or throws if one is not found\n   */\n  locate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory {\n    return assertEx(this.tryLocate(schema, labels), () => {\n      const configString = `config schema [${schema}]`\n      const labelsString = labels ? ` & labels [${JSON.stringify(labels)}]` : ''\n      return `No module factory for the supplied ${configString}${labelsString} registered`\n    })\n  }\n\n  /**\n   * Registers a single module factory (with optional tags) with the locator\n   * @param additional Additional module factories to register\n   */\n  register<TModule extends ModuleInstance>(mod: CreatableModuleFactory<TModule>, labels?: Labels): this {\n    mod.configSchemas.map((schema) => {\n      const existingFactories = this._registry[schema]\n      const factory: LabeledCreatableModuleFactory<TModule> = {\n        // Destructure instance properties\n        ...mod,\n        // Copy static methods\n        create: mod.create.bind(mod) as LabeledCreatableModuleFactory<TModule>['create'],\n        // Merge module & supplied labels\n        labels: Object.assign({}, (mod as LabeledCreatableModuleFactory).labels ?? {}, labels ?? {}),\n      }\n      this._registry[schema] = existingFactories ? [...existingFactories, factory] : [factory]\n    })\n    return this\n  }\n\n  /**\n   * Registers multiple module factories with the locator\n   * @param additional Additional module factories to register\n   */\n  registerMany(additional: CreatableModuleRegistry): this {\n    Object.entries(additional).map(([schema, factories]) => {\n      if (factories) {\n        const existingFactories = this._registry[schema]\n        this._registry[schema] = existingFactories ? [...existingFactories, ...factories] : factories\n      }\n    })\n    return this\n  }\n\n  /**\n   * Tries to locate a module factory that matches the supplied schema and labels\n   * @param schema The config schema for the module\n   * @param labels The labels for the module factory\n   * @returns A module factory that matches the supplied schema and labels or undefined\n   */\n  tryLocate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory | undefined {\n    // If labels were provided\n    return labels\n      ? // Find the first factory that has labels and has all the labels provided\n        this._registry[schema]?.filter(hasLabels).find((factory) => hasAllLabels(factory?.labels, labels))\n      : // Otherwise, return the first factory\n        this._registry[schema]?.[0]\n  }\n}\n"],"mappings":"AAAA,SAAS,gBAAgB;AAGzB,SAAS,oBAA4B;AAGrC,SAAS,iBAAgD;AAKlD,MAAM,qBAAqB;AAAA,EAChC,YAA+B,YAAqC,CAAC,GAAG;AAAzC;AAAA,EAA0C;AAAA;AAAA;AAAA;AAAA,EAKzE,IAAI,WAA8C;AAChD,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,QAAgB,QAAyE;AAC9F,WAAO,SAAS,KAAK,UAAU,QAAQ,MAAM,GAAG,MAAM;AACpD,YAAM,eAAe,kBAAkB,MAAM;AAC7C,YAAM,eAAe,SAAS,cAAc,KAAK,UAAU,MAAM,CAAC,MAAM;AACxE,aAAO,sCAAsC,YAAY,GAAG,YAAY;AAAA,IAC1E,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAyC,KAAsC,QAAuB;AACpG,QAAI,cAAc,IAAI,CAAC,WAAW;AAChC,YAAM,oBAAoB,KAAK,UAAU,MAAM;AAC/C,YAAM,UAAkD;AAAA;AAAA,QAEtD,GAAG;AAAA;AAAA,QAEH,QAAQ,IAAI,OAAO,KAAK,GAAG;AAAA;AAAA,QAE3B,QAAQ,OAAO,OAAO,CAAC,GAAI,IAAsC,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC;AAAA,MAC7F;AACA,WAAK,UAAU,MAAM,IAAI,oBAAoB,CAAC,GAAG,mBAAmB,OAAO,IAAI,CAAC,OAAO;AAAA,IACzF,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,YAA2C;AACtD,WAAO,QAAQ,UAAU,EAAE,IAAI,CAAC,CAAC,QAAQ,SAAS,MAAM;AACtD,UAAI,WAAW;AACb,cAAM,oBAAoB,KAAK,UAAU,MAAM;AAC/C,aAAK,UAAU,MAAM,IAAI,oBAAoB,CAAC,GAAG,mBAAmB,GAAG,SAAS,IAAI;AAAA,MACtF;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAAgB,QAAqF;AAE7G,WAAO;AAAA;AAAA,MAEH,KAAK,UAAU,MAAM,GAAG,OAAO,SAAS,EAAE,KAAK,CAAC,YAAY,aAAa,SAAS,QAAQ,MAAM,CAAC;AAAA;AAAA;AAAA,MAEjG,KAAK,UAAU,MAAM,IAAI,CAAC;AAAA;AAAA,EAChC;AACF;","names":[]}

package/dist/browser/CreatableModule/index.cjs

@@ -0,0 +1,193 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/CreatableModule/index.ts
+var CreatableModule_exports = {};
+__export(CreatableModule_exports, {
+  ModuleFactory: () => ModuleFactory,
+  ModuleFactoryLocator: () => ModuleFactoryLocator,
+  assignCreatableModuleRegistry: () => assignCreatableModuleRegistry,
+  creatableModule: () => creatableModule,
+  hasLabels: () => hasLabels,
+  toCreatableModuleRegistry: () => toCreatableModuleRegistry
+});
+module.exports = __toCommonJS(CreatableModule_exports);
+
+// src/CreatableModule/CreatableModule.ts
+function creatableModule() {
+  return (constructor) => {
+    constructor;
+  };
+}
+
+// src/CreatableModule/CreatableModuleRegistry.ts
+var toCreatableModuleRegistry = (dict) => {
+  return Object.entries(dict).reduce((registry, [schema, factory]) => {
+    registry[schema] = Array.isArray(factory) ? factory : [factory];
+    return registry;
+  }, {});
+};
+var assignCreatableModuleRegistry = (target = {}, ...sources) => {
+  sources.map(
+    (source) => Object.entries(source).map(([schema, factories]) => {
+      if (factories) {
+        const existingFactories = target[schema];
+        target[schema] = existingFactories ? target[schema] = [...existingFactories, ...factories] : factories;
+      }
+    })
+  );
+  return target;
+};
+
+// src/CreatableModule/LabeledCreatableModuleFactory.ts
+var hasLabels = (factory) => {
+  return factory.labels !== void 0;
+};
+
+// src/CreatableModule/ModuleFactory.ts
+var import_assert = require("@xylabs/assert");
+var import_lodash = require("@xylabs/lodash");
+var ModuleFactory = class _ModuleFactory {
+  configSchemas;
+  creatableModule;
+  defaultLogger;
+  defaultParams;
+  labels;
+  constructor(creatableModule2, params, labels = {}) {
+    this.creatableModule = creatableModule2;
+    this.defaultParams = params;
+    this.configSchemas = creatableModule2.configSchemas;
+    this.labels = Object.assign({}, creatableModule2.labels ?? {}, labels ?? {});
+  }
+  get configSchema() {
+    return this.configSchemas[0];
+  }
+  static withParams(creatableModule2, params, labels = {}) {
+    return new _ModuleFactory(creatableModule2, params, labels);
+  }
+  _getRootFunction(funcName) {
+    let anyThis = this;
+    while (anyThis.__proto__[funcName]) {
+      anyThis = anyThis.__proto__;
+    }
+    return anyThis[funcName];
+  }
+  _noOverride(functionName) {
+    const thisFunc = this[functionName];
+    const rootFunc = this._getRootFunction(functionName);
+    (0, import_assert.assertEx)(thisFunc === rootFunc, `Override not allowed for [${functionName}] - override ${functionName}Handler instead`);
+  }
+  create(params) {
+    const factory = this;
+    const schema = factory.creatableModule.configSchema;
+    const mergedParams = (0, import_lodash.merge)({}, factory.defaultParams, params, {
+      config: (0, import_lodash.merge)({}, factory.defaultParams?.config, params?.config, { schema })
+    });
+    return factory.creatableModule.create(mergedParams);
+  }
+  factory(_params) {
+    throw new Error("Method not implemented.");
+  }
+};
+
+// src/CreatableModule/ModuleFactoryLocator.ts
+var import_assert2 = require("@xylabs/assert");
+
+// src/Labels/Labels.ts
+var hasAllLabels = (source, required) => {
+  if (!required)
+    return true;
+  return Object.entries(required).every(([key, value]) => {
+    return source?.hasOwnProperty(key) && source?.[key] === value;
+  });
+};
+
+// src/CreatableModule/ModuleFactoryLocator.ts
+var ModuleFactoryLocator = class {
+  constructor(_registry = {}) {
+    this._registry = _registry;
+  }
+  /**
+   * The current registry for the module factory
+   */
+  get registry() {
+    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, labels) {
+    return (0, import_assert2.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(mod, labels) {
+    mod.configSchemas.map((schema) => {
+      const existingFactories = this._registry[schema];
+      const factory = {
+        // Destructure instance properties
+        ...mod,
+        // Copy static methods
+        create: mod.create.bind(mod),
+        // Merge module & supplied labels
+        labels: Object.assign({}, mod.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) {
+    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, labels) {
+    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]
+    );
+  }
+};
+//# sourceMappingURL=index.cjs.map

package/dist/browser/CreatableModule/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/CreatableModule/index.ts","../../../src/CreatableModule/CreatableModule.ts","../../../src/CreatableModule/CreatableModuleRegistry.ts","../../../src/CreatableModule/LabeledCreatableModuleFactory.ts","../../../src/CreatableModule/ModuleFactory.ts","../../../src/CreatableModule/ModuleFactoryLocator.ts","../../../src/Labels/Labels.ts"],"sourcesContent":["export * from './CreatableModule'\nexport * from './CreatableModuleDictionary'\nexport * from './CreatableModuleRegistry'\nexport * from './LabeledCreatableModuleFactory'\nexport * from './ModuleFactory'\nexport * from './ModuleFactoryLocator'\n","import { AccountInstance } from '@xyo-network/account-model'\nimport { Logger } from '@xyo-network/logger'\n\nimport { ModuleInstance } from '../instance'\n\nexport type CreatableModuleFactory<T extends ModuleInstance = ModuleInstance> = Omit<Omit<CreatableModule<T>, 'new'>, 'create'> & {\n  create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: T['params']): Promise<T>\n}\n\nexport interface CreatableModule<T extends ModuleInstance = ModuleInstance> {\n  configSchema: string\n  configSchemas: string[]\n  defaultLogger?: Logger\n  new (privateConstructorKey: string, params: T['params'], account: AccountInstance): T\n  _noOverride(functionName: string): void\n  create<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): Promise<T>\n  factory<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): CreatableModuleFactory<T>\n}\n\n/**\n * Class annotation to be used to decorate Modules which support\n * an asynchronous creation pattern\n * @returns The decorated Module requiring it implement the members\n * of the CreatableModule as statics properties/methods\n */\nexport function creatableModule<TModule extends ModuleInstance = ModuleInstance>() {\n  return <U extends CreatableModule<TModule>>(constructor: U) => {\n    constructor\n  }\n}\n","import { CreatableModuleFactory } from './CreatableModule'\nimport { CreatableModuleDictionary } from './CreatableModuleDictionary'\nimport { LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory'\n\nexport interface CreatableModuleRegistry {\n  [key: string]: (CreatableModuleFactory | LabeledCreatableModuleFactory)[] | undefined\n}\n\nexport const toCreatableModuleRegistry = (dict: CreatableModuleDictionary | CreatableModuleRegistry): CreatableModuleRegistry => {\n  return Object.entries(dict).reduce((registry, [schema, factory]) => {\n    registry[schema] = Array.isArray(factory) ? factory : [factory]\n    return registry\n  }, {} as CreatableModuleRegistry)\n}\n\nexport const assignCreatableModuleRegistry = (\n  target: CreatableModuleRegistry = {},\n  ...sources: CreatableModuleRegistry[]\n): CreatableModuleRegistry => {\n  sources.map((source) =>\n    Object.entries(source).map(([schema, factories]) => {\n      if (factories) {\n        const existingFactories = target[schema]\n        target[schema] = existingFactories ? (target[schema] = [...existingFactories, ...factories]) : factories\n      }\n    }),\n  )\n  return target\n}\n","import { ModuleInstance } from '../instance'\nimport { WithOptionalLabels } from '../Labels'\nimport { CreatableModuleFactory } from './CreatableModule'\n\nexport type LabeledCreatableModuleFactory<T extends ModuleInstance = ModuleInstance> = CreatableModuleFactory<T> & WithOptionalLabels\n\nexport const hasLabels = (factory: CreatableModuleFactory | LabeledCreatableModuleFactory): factory is LabeledCreatableModuleFactory => {\n  return (factory as LabeledCreatableModuleFactory).labels !== undefined\n}\n","import { assertEx } from '@xylabs/assert'\nimport { merge } from '@xylabs/lodash'\nimport { Logger } from '@xyo-network/logger'\n\nimport { ModuleInstance } from '../instance'\nimport { Labels, WithOptionalLabels } from '../Labels'\nimport { CreatableModule, CreatableModuleFactory } from './CreatableModule'\n\nexport class ModuleFactory<TModule extends ModuleInstance> implements CreatableModuleFactory<TModule> {\n  configSchemas: CreatableModuleFactory<TModule>['configSchemas']\n\n  creatableModule: CreatableModule<TModule>\n\n  defaultLogger?: Logger | undefined\n\n  defaultParams?: Omit<TModule['params'], 'config'> & { config?: TModule['params']['config'] }\n\n  labels?: Labels\n\n  constructor(\n    creatableModule: CreatableModule<TModule>,\n    params?: Omit<TModule['params'], 'config'> & { config?: TModule['params']['config'] },\n    labels: Labels = {},\n  ) {\n    this.creatableModule = creatableModule\n    this.defaultParams = params\n    this.configSchemas = creatableModule.configSchemas\n    this.labels = Object.assign({}, (creatableModule as WithOptionalLabels).labels ?? {}, labels ?? {})\n  }\n\n  get configSchema(): string {\n    return this.configSchemas[0]\n  }\n\n  static withParams<T extends ModuleInstance>(\n    creatableModule: CreatableModule<T>,\n    params?: Omit<T['params'], 'config'> & { config?: T['params']['config'] },\n    labels: Labels = {},\n  ) {\n    return new ModuleFactory(creatableModule, params, labels)\n  }\n\n  _getRootFunction(funcName: string) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    let anyThis = this as any\n    while (anyThis.__proto__[funcName]) {\n      anyThis = anyThis.__proto__\n    }\n    return anyThis[funcName]\n  }\n\n  _noOverride(functionName: string) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const thisFunc = (this as any)[functionName]\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const rootFunc = this._getRootFunction(functionName)\n    assertEx(thisFunc === rootFunc, `Override not allowed for [${functionName}] - override ${functionName}Handler instead`)\n  }\n\n  create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: TModule['params'] | undefined): Promise<T> {\n    const factory = this as ModuleFactory<T>\n    const schema = factory.creatableModule.configSchema\n    const mergedParams: TModule['params'] = merge({}, factory.defaultParams, params, {\n      config: merge({}, factory.defaultParams?.config, params?.config, { schema }),\n    })\n    return factory.creatableModule.create<T>(mergedParams)\n  }\n\n  factory<T extends ModuleInstance>(this: CreatableModule<T>, _params?: T['params'] | undefined): CreatableModuleFactory<T> {\n    throw new Error('Method not implemented.')\n  }\n}\n","import { assertEx } from '@xylabs/assert'\n\nimport { ModuleInstance } from '../instance'\nimport { hasAllLabels, Labels } from '../Labels'\nimport { CreatableModuleFactory } from './CreatableModule'\nimport { CreatableModuleRegistry } from './CreatableModuleRegistry'\nimport { hasLabels, LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory'\n\n/**\n * A class which encapsulates the Service Locator Pattern for Module Factories\n */\nexport class ModuleFactoryLocator {\n  constructor(protected readonly _registry: CreatableModuleRegistry = {}) {}\n\n  /**\n   * The current registry for the module factory\n   */\n  get registry(): Readonly<CreatableModuleRegistry> {\n    return this._registry\n  }\n\n  /**\n   * Locates a module factory that matches the supplied schema and labels\n   * @param schema The config schema for the module\n   * @param labels The labels for the module factory\n   * @returns A module factory that matches the supplied schema and labels or throws if one is not found\n   */\n  locate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory {\n    return assertEx(this.tryLocate(schema, labels), () => {\n      const configString = `config schema [${schema}]`\n      const labelsString = labels ? ` & labels [${JSON.stringify(labels)}]` : ''\n      return `No module factory for the supplied ${configString}${labelsString} registered`\n    })\n  }\n\n  /**\n   * Registers a single module factory (with optional tags) with the locator\n   * @param additional Additional module factories to register\n   */\n  register<TModule extends ModuleInstance>(mod: CreatableModuleFactory<TModule>, labels?: Labels): this {\n    mod.configSchemas.map((schema) => {\n      const existingFactories = this._registry[schema]\n      const factory: LabeledCreatableModuleFactory<TModule> = {\n        // Destructure instance properties\n        ...mod,\n        // Copy static methods\n        create: mod.create.bind(mod) as LabeledCreatableModuleFactory<TModule>['create'],\n        // Merge module & supplied labels\n        labels: Object.assign({}, (mod as LabeledCreatableModuleFactory).labels ?? {}, labels ?? {}),\n      }\n      this._registry[schema] = existingFactories ? [...existingFactories, factory] : [factory]\n    })\n    return this\n  }\n\n  /**\n   * Registers multiple module factories with the locator\n   * @param additional Additional module factories to register\n   */\n  registerMany(additional: CreatableModuleRegistry): this {\n    Object.entries(additional).map(([schema, factories]) => {\n      if (factories) {\n        const existingFactories = this._registry[schema]\n        this._registry[schema] = existingFactories ? [...existingFactories, ...factories] : factories\n      }\n    })\n    return this\n  }\n\n  /**\n   * Tries to locate a module factory that matches the supplied schema and labels\n   * @param schema The config schema for the module\n   * @param labels The labels for the module factory\n   * @returns A module factory that matches the supplied schema and labels or undefined\n   */\n  tryLocate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory | undefined {\n    // If labels were provided\n    return labels\n      ? // Find the first factory that has labels and has all the labels provided\n        this._registry[schema]?.filter(hasLabels).find((factory) => hasAllLabels(factory?.labels, labels))\n      : // Otherwise, return the first factory\n        this._registry[schema]?.[0]\n  }\n}\n","/**\n * Object used to represent labels identifying a resource.\n */\nexport interface Labels {\n  [key: string]: string | undefined\n}\n\n/**\n * Interface for objects that have labels.\n */\nexport interface WithLabels<T extends Labels = Labels> {\n  labels: T\n}\n\n/**\n * Interface for objects that have labels.\n */\nexport interface WithOptionalLabels<T extends Labels = Labels> {\n  labels?: T\n}\n\n/**\n * Returns true if the source object has all the labels from the required set\n * @param source Source object to check against\n * @param required Set of labels to check for in source\n * @returns True of the source object has all the labels from the required set\n */\nexport const hasAllLabels = (source?: Labels, required?: Labels): boolean => {\n  if (!required) return true\n  return Object.entries(required).every(([key, value]) => {\n    // eslint-disable-next-line no-prototype-builtins\n    return source?.hasOwnProperty(key as keyof typeof source) && source?.[key as keyof typeof source] === value\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACyBO,SAAS,kBAAmE;AACjF,SAAO,CAAqC,gBAAmB;AAC7D;AAAA,EACF;AACF;;;ACrBO,IAAM,4BAA4B,CAAC,SAAuF;AAC/H,SAAO,OAAO,QAAQ,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQ,OAAO,MAAM;AAClE,aAAS,MAAM,IAAI,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,OAAO;AAC9D,WAAO;AAAA,EACT,GAAG,CAAC,CAA4B;AAClC;AAEO,IAAM,gCAAgC,CAC3C,SAAkC,CAAC,MAChC,YACyB;AAC5B,UAAQ;AAAA,IAAI,CAAC,WACX,OAAO,QAAQ,MAAM,EAAE,IAAI,CAAC,CAAC,QAAQ,SAAS,MAAM;AAClD,UAAI,WAAW;AACb,cAAM,oBAAoB,OAAO,MAAM;AACvC,eAAO,MAAM,IAAI,oBAAqB,OAAO,MAAM,IAAI,CAAC,GAAG,mBAAmB,GAAG,SAAS,IAAK;AAAA,MACjG;AAAA,IACF,CAAC;AAAA,EACH;AACA,SAAO;AACT;;;ACtBO,IAAM,YAAY,CAAC,YAA8G;AACtI,SAAQ,QAA0C,WAAW;AAC/D;;;ACRA,oBAAyB;AACzB,oBAAsB;AAOf,IAAM,gBAAN,MAAM,eAAyF;AAAA,EACpG;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA,YACEA,kBACA,QACA,SAAiB,CAAC,GAClB;AACA,SAAK,kBAAkBA;AACvB,SAAK,gBAAgB;AACrB,SAAK,gBAAgBA,iBAAgB;AACrC,SAAK,SAAS,OAAO,OAAO,CAAC,GAAIA,iBAAuC,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC;AAAA,EACpG;AAAA,EAEA,IAAI,eAAuB;AACzB,WAAO,KAAK,cAAc,CAAC;AAAA,EAC7B;AAAA,EAEA,OAAO,WACLA,kBACA,QACA,SAAiB,CAAC,GAClB;AACA,WAAO,IAAI,eAAcA,kBAAiB,QAAQ,MAAM;AAAA,EAC1D;AAAA,EAEA,iBAAiB,UAAkB;AAEjC,QAAI,UAAU;AACd,WAAO,QAAQ,UAAU,QAAQ,GAAG;AAClC,gBAAU,QAAQ;AAAA,IACpB;AACA,WAAO,QAAQ,QAAQ;AAAA,EACzB;AAAA,EAEA,YAAY,cAAsB;AAEhC,UAAM,WAAY,KAAa,YAAY;AAE3C,UAAM,WAAW,KAAK,iBAAiB,YAAY;AACnD,gCAAS,aAAa,UAAU,6BAA6B,YAAY,gBAAgB,YAAY,iBAAiB;AAAA,EACxH;AAAA,EAEA,OAAkE,QAAoD;AACpH,UAAM,UAAU;AAChB,UAAM,SAAS,QAAQ,gBAAgB;AACvC,UAAM,mBAAkC,qBAAM,CAAC,GAAG,QAAQ,eAAe,QAAQ;AAAA,MAC/E,YAAQ,qBAAM,CAAC,GAAG,QAAQ,eAAe,QAAQ,QAAQ,QAAQ,EAAE,OAAO,CAAC;AAAA,IAC7E,CAAC;AACD,WAAO,QAAQ,gBAAgB,OAAU,YAAY;AAAA,EACvD;AAAA,EAEA,QAA4D,SAA8D;AACxH,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC3C;AACF;;;ACvEA,IAAAC,iBAAyB;;;AC2BlB,IAAM,eAAe,CAAC,QAAiB,aAA+B;AAC3E,MAAI,CAAC;AAAU,WAAO;AACtB,SAAO,OAAO,QAAQ,QAAQ,EAAE,MAAM,CAAC,CAAC,KAAK,KAAK,MAAM;AAEtD,WAAO,QAAQ,eAAe,GAA0B,KAAK,SAAS,GAA0B,MAAM;AAAA,EACxG,CAAC;AACH;;;ADtBO,IAAM,uBAAN,MAA2B;AAAA,EAChC,YAA+B,YAAqC,CAAC,GAAG;AAAzC;AAAA,EAA0C;AAAA;AAAA;AAAA;AAAA,EAKzE,IAAI,WAA8C;AAChD,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,QAAgB,QAAyE;AAC9F,eAAO,yBAAS,KAAK,UAAU,QAAQ,MAAM,GAAG,MAAM;AACpD,YAAM,eAAe,kBAAkB,MAAM;AAC7C,YAAM,eAAe,SAAS,cAAc,KAAK,UAAU,MAAM,CAAC,MAAM;AACxE,aAAO,sCAAsC,YAAY,GAAG,YAAY;AAAA,IAC1E,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAyC,KAAsC,QAAuB;AACpG,QAAI,cAAc,IAAI,CAAC,WAAW;AAChC,YAAM,oBAAoB,KAAK,UAAU,MAAM;AAC/C,YAAM,UAAkD;AAAA;AAAA,QAEtD,GAAG;AAAA;AAAA,QAEH,QAAQ,IAAI,OAAO,KAAK,GAAG;AAAA;AAAA,QAE3B,QAAQ,OAAO,OAAO,CAAC,GAAI,IAAsC,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC;AAAA,MAC7F;AACA,WAAK,UAAU,MAAM,IAAI,oBAAoB,CAAC,GAAG,mBAAmB,OAAO,IAAI,CAAC,OAAO;AAAA,IACzF,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,YAA2C;AACtD,WAAO,QAAQ,UAAU,EAAE,IAAI,CAAC,CAAC,QAAQ,SAAS,MAAM;AACtD,UAAI,WAAW;AACb,cAAM,oBAAoB,KAAK,UAAU,MAAM;AAC/C,aAAK,UAAU,MAAM,IAAI,oBAAoB,CAAC,GAAG,mBAAmB,GAAG,SAAS,IAAI;AAAA,MACtF;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAAgB,QAAqF;AAE7G,WAAO;AAAA;AAAA,MAEH,KAAK,UAAU,MAAM,GAAG,OAAO,SAAS,EAAE,KAAK,CAAC,YAAY,aAAa,SAAS,QAAQ,MAAM,CAAC;AAAA;AAAA;AAAA,MAEjG,KAAK,UAAU,MAAM,IAAI,CAAC;AAAA;AAAA,EAChC;AACF;","names":["creatableModule","import_assert"]}

package/dist/browser/CreatableModule/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/CreatableModule/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA"}

package/dist/browser/CreatableModule/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/CreatableModule/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA"}

package/dist/browser/CreatableModule/index.d.ts

@@ -0,0 +1,7 @@
+export * from './CreatableModule';
+export * from './CreatableModuleDictionary';
+export * from './CreatableModuleRegistry';
+export * from './LabeledCreatableModuleFactory';
+export * from './ModuleFactory';
+export * from './ModuleFactoryLocator';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/CreatableModule/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/CreatableModule/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA"}

package/dist/browser/CreatableModule/index.js

@@ -0,0 +1,7 @@
+export * from "./CreatableModule";
+export * from "./CreatableModuleDictionary";
+export * from "./CreatableModuleRegistry";
+export * from "./LabeledCreatableModuleFactory";
+export * from "./ModuleFactory";
+export * from "./ModuleFactoryLocator";
+//# sourceMappingURL=index.js.map

package/dist/browser/CreatableModule/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/CreatableModule/index.ts"],"sourcesContent":["export * from './CreatableModule'\nexport * from './CreatableModuleDictionary'\nexport * from './CreatableModuleRegistry'\nexport * from './LabeledCreatableModuleFactory'\nexport * from './ModuleFactory'\nexport * from './ModuleFactoryLocator'\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

package/dist/browser/EventsModels/ModuleBusy.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/EventsModels/ModuleBusy.ts
+var ModuleBusy_exports = {};
+module.exports = __toCommonJS(ModuleBusy_exports);
+//# sourceMappingURL=ModuleBusy.cjs.map

package/dist/browser/EventsModels/ModuleBusy.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/EventsModels/ModuleBusy.ts"],"sourcesContent":["import { EventData } from '@xyo-network/module-events'\n\nimport { ModuleEventArgs } from './ModuleEventArgs'\n\nexport type ModuleBusyEventArgs<TModule extends object = object> = ModuleEventArgs<\n  TModule,\n  {\n    busy: boolean\n  }\n>\n\nexport interface ModuleBusyEventData<TModule extends object = object> extends EventData {\n  moduleBusy: ModuleBusyEventArgs<TModule>\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/browser/EventsModels/ModuleBusy.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleBusy.d.ts","sourceRoot":"","sources":["../../../src/EventsModels/ModuleBusy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAEtD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,MAAM,MAAM,mBAAmB,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,IAAI,eAAe,CAChF,OAAO,EACP;IACE,IAAI,EAAE,OAAO,CAAA;CACd,CACF,CAAA;AAED,MAAM,WAAW,mBAAmB,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,SAAS;IACrF,UAAU,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAA;CACzC"}

package/dist/browser/EventsModels/ModuleBusy.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleBusy.d.ts","sourceRoot":"","sources":["../../../src/EventsModels/ModuleBusy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAEtD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,MAAM,MAAM,mBAAmB,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,IAAI,eAAe,CAChF,OAAO,EACP;IACE,IAAI,EAAE,OAAO,CAAA;CACd,CACF,CAAA;AAED,MAAM,WAAW,mBAAmB,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,SAAS;IACrF,UAAU,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAA;CACzC"}

package/dist/browser/EventsModels/ModuleBusy.d.ts

@@ -0,0 +1,9 @@
+import { EventData } from '@xyo-network/module-events';
+import { ModuleEventArgs } from './ModuleEventArgs';
+export type ModuleBusyEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
+    busy: boolean;
+}>;
+export interface ModuleBusyEventData<TModule extends object = object> extends EventData {
+    moduleBusy: ModuleBusyEventArgs<TModule>;
+}
+//# sourceMappingURL=ModuleBusy.d.ts.map