@xyo-network/module-model 3.14.1 → 3.14.2

package/dist/types/ModuleFactoryLocatorInstance.d.ts

@@ -0,0 +1,37 @@
+import type { Schema } from '@xyo-network/payload-model';
+import type { CreatableModuleFactory, CreatableModuleRegistry, LabeledCreatableModuleFactory } from './CreatableModule/index.ts';
+import type { Labels } from './Labels/index.ts';
+export interface ModuleFactoryLocatorInstance {
+    /**
+     * The current registry for the module factory
+     */
+    registry: Readonly<CreatableModuleRegistry>;
+    freeze(): void;
+    /**
+     * 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;
+    merge(locator: ModuleFactoryLocatorInstance): ModuleFactoryLocatorInstance;
+    /**
+     * Registers a single module factory (with optional tags) with the locator
+     * @param factory The factory to register
+     * @param labels The labels for the module factory
+     */
+    register(factory: CreatableModuleFactory, labels?: Labels, primary?: boolean | Schema | Schema[]): ModuleFactoryLocatorInstance;
+    /**
+     * Registers multiple module factories with the locator
+     * @param factories The factories to register
+     */
+    registerMany(factories: CreatableModuleFactory[]): ModuleFactoryLocatorInstance;
+    /**
+     * 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=ModuleFactoryLocatorInstance.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleFactoryLocatorInstance.d.ts","sourceRoot":"","sources":["../../src/ModuleFactoryLocatorInstance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAExD,OAAO,KAAK,EACV,sBAAsB,EAAE,uBAAuB,EAAE,6BAA6B,EAC/E,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C,MAAM,WAAW,4BAA4B;IAE3C;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,uBAAuB,CAAC,CAAA;IAE3C,MAAM,IAAI,IAAI,CAAA;IAEd;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,6BAA6B,CAAA;IAE/F,KAAK,CAAC,OAAO,EAAE,4BAA4B,GAAG,4BAA4B,CAAA;IAE1E;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,4BAA4B,CAAA;IAE/H;;;OAGG;IACH,YAAY,CAAC,SAAS,EAAE,sBAAsB,EAAE,GAAG,4BAA4B,CAAA;IAE/E;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,6BAA6B,GAAG,SAAS,CAAA;CAC/G"}

package/dist/types/index.d.ts

@@ -8,6 +8,7 @@ export * from './Labels/index.ts';
 export * from './lib/index.ts';
 export * from './module/index.ts';
 export * from './ModuleDescription.ts';
+export * from './ModuleFactoryLocatorInstance.ts';
 export * from './ModuleIdentifier.ts';
 export * from './ModuleIdentifierTransformer.ts';
 export * from './ModuleParams.ts';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,kCAAkC,CAAA;AAChD,cAAc,mBAAmB,CAAA;AACjC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,0BAA0B,CAAA;AACxC,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA;AACtC,cAAc,mCAAmC,CAAA;AACjD,cAAc,uBAAuB,CAAA;AACrC,cAAc,kCAAkC,CAAA;AAChD,cAAc,mBAAmB,CAAA;AACjC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,0BAA0B,CAAA;AACxC,cAAc,iBAAiB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-model",
-  "version": "3.14.1",
+  "version": "3.14.2",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -38,11 +38,11 @@
     "@xylabs/promise": "^4.8.7",
     "@xylabs/retry": "^4.8.7",
     "@xylabs/typeof": "^4.8.7",
-    "@xyo-network/account-model": "^3.14.1",
-    "@xyo-network/boundwitness-model": "^3.14.1",
-    "@xyo-network/manifest-model": "^3.14.1",
-    "@xyo-network/module-events": "^3.14.1",
-    "@xyo-network/payload-model": "^3.14.1"
+    "@xyo-network/account-model": "^3.14.2",
+    "@xyo-network/boundwitness-model": "^3.14.2",
+    "@xyo-network/manifest-model": "^3.14.2",
+    "@xyo-network/module-events": "^3.14.2",
+    "@xyo-network/payload-model": "^3.14.2"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^6.3.5",

package/src/ModuleFactoryLocatorInstance.ts

@@ -0,0 +1,47 @@
+import type { Schema } from '@xyo-network/payload-model'
+
+import type {
+  CreatableModuleFactory, CreatableModuleRegistry, LabeledCreatableModuleFactory,
+} from './CreatableModule/index.ts'
+import type { Labels } from './Labels/index.ts'
+
+export interface ModuleFactoryLocatorInstance {
+
+  /**
+   * The current registry for the module factory
+   */
+  registry: Readonly<CreatableModuleRegistry>
+
+  freeze(): void
+
+  /**
+   * 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
+
+  merge(locator: ModuleFactoryLocatorInstance): ModuleFactoryLocatorInstance
+
+  /**
+   * Registers a single module factory (with optional tags) with the locator
+   * @param factory The factory to register
+   * @param labels The labels for the module factory
+   */
+  register(factory: CreatableModuleFactory, labels?: Labels, primary?: boolean | Schema | Schema[]): ModuleFactoryLocatorInstance
+
+  /**
+   * Registers multiple module factories with the locator
+   * @param factories The factories to register
+   */
+  registerMany(factories: CreatableModuleFactory[]): ModuleFactoryLocatorInstance
+
+  /**
+   * 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
+}

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './Labels/index.ts'
 export * from './lib/index.ts'
 export * from './module/index.ts'
 export * from './ModuleDescription.ts'
+export * from './ModuleFactoryLocatorInstance.ts'
 export * from './ModuleIdentifier.ts'
 export * from './ModuleIdentifierTransformer.ts'
 export * from './ModuleParams.ts'