@xyo-network/module-factory-locator 5.3.25 → 5.3.27

package/README.md

@@ -1,23 +1,367 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/module-factory-locator
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
+
+```sh
+yarn add {{name}}
+```
 
-Version: 5.0.2
+Using pnpm:
 
-Primary SDK for using XYO Protocol 2.0
+```sh
+pnpm add {{name}}
+```
 
-## Documentation
+Using bun:
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__module-factory-locator)
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### modules
+
+    ### packages
+
+      ### module
+
+        ### packages
+
+          ### locator
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="ModuleFactoryLocator"></a>ModuleFactoryLocator
+
+[**@xyo-network/module-factory-locator**](#../README)
+
+***
+
+A class which encapsulates the Service Locator Pattern for Module Factories
+
+## Implements
+
+- `ModuleFactoryLocatorInstance`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ModuleFactoryLocator(_registry?): ModuleFactoryLocator;
+```
+
+### Parameters
+
+#### \_registry?
+
+`CreatableModuleRegistry` = `...`
+
+### Returns
+
+`ModuleFactoryLocator`
+
+## Properties
+
+### \_registry
+
+```ts
+protected readonly _registry: CreatableModuleRegistry;
+```
+
+## Accessors
+
+### registry
+
+### Get Signature
+
+```ts
+get registry(): Readonly<CreatableModuleRegistry>;
+```
+
+The current registry for the module factory
+
+#### Returns
+
+`Readonly`\<`CreatableModuleRegistry`\>
+
+### Implementation of
+
+```ts
+ModuleFactoryLocatorInstance.registry
+```
+
+## Methods
+
+### empty()
+
+```ts
+static empty(): ModuleFactoryLocator;
+```
+
+### Returns
+
+`ModuleFactoryLocator`
+
+***
+
+### standard()
+
+```ts
+static standard(): ModuleFactoryLocator;
+```
+
+### Returns
+
+`ModuleFactoryLocator`
+
+***
+
+### freeze()
+
+```ts
+freeze(): void;
+```
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+ModuleFactoryLocatorInstance.freeze
+```
+
+***
+
+### locate()
+
+```ts
+locate(schema, labels?): 
+  | CreatableModuleFactory<CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>
+  | LabeledCreatableModuleFactory;
+```
+
+Locates a module factory that matches the supplied schema and labels
+
+### Parameters
+
+#### schema
+
+`Schema`
+
+The config schema for the module
+
+#### labels?
+
+`Labels`
+
+The labels for the module factory
+
+### Returns
+
+  \| `CreatableModuleFactory`\<`CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
+  \| `LabeledCreatableModuleFactory`
+
+A module factory that matches the supplied schema and labels or throws if one is not found
+
+### Implementation of
+
+```ts
+ModuleFactoryLocatorInstance.locate
+```
+
+***
+
+### merge()
+
+```ts
+merge(locator): ModuleFactoryLocatorInstance;
+```
+
+### Parameters
+
+#### locator
+
+`ModuleFactoryLocatorInstance`
+
+### Returns
+
+`ModuleFactoryLocatorInstance`
+
+### Implementation of
+
+```ts
+ModuleFactoryLocatorInstance.merge
+```
+
+***
+
+### register()
+
+```ts
+register(
+   factory, 
+   labels?, 
+   primary?): this;
+```
+
+Registers a single module factory (with optional tags) with the locator
+
+### Parameters
+
+#### factory
+
+`CreatableModuleFactory`
+
+The factory to register
+
+#### labels?
+
+`Labels`
+
+The labels for the module factory
+
+#### primary?
+
+`boolean` \| `Schema` \| `Schema`[]
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleFactoryLocatorInstance.register
+```
+
+***
+
+### registerMany()
+
+```ts
+registerMany(factories): this;
+```
+
+Registers multiple module factories with the locator
+
+### Parameters
+
+#### factories
+
+`CreatableModuleFactory`\<`CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>[]
+
+The factories to register
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleFactoryLocatorInstance.registerMany
+```
+
+***
+
+### tryLocate()
+
+```ts
+tryLocate(schema, labels?): 
+  | CreatableModuleFactory<CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>
+  | LabeledCreatableModuleFactory
+  | undefined;
+```
+
+Tries to locate a module factory that matches the supplied schema and labels
+
+### Parameters
+
+#### schema
+
+`Schema`
+
+The config schema for the module
+
+#### labels?
+
+`Labels`
+
+The labels for the module factory
+
+### Returns
+
+  \| `CreatableModuleFactory`\<`CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
+  \| `LabeledCreatableModuleFactory`
+  \| `undefined`
+
+A module factory that matches the supplied schema and labels or undefined
+
+### Implementation of
+
+```ts
+ModuleFactoryLocatorInstance.tryLocate
+```
+
+              ### functions
+
+                ### <a id="standardCreatableFactories"></a>standardCreatableFactories
+
+[**@xyo-network/module-factory-locator**](#../README)
+
+***
+
+```ts
+function standardCreatableFactories(): CreatableModuleRegistry;
+```
+
+## Returns
+
+`CreatableModuleRegistry`
+
+              ### variables
+
+                ### <a id="standardCreatableModulesList"></a>standardCreatableModulesList
+
+[**@xyo-network/module-factory-locator**](#../README)
+
+***
 
-## Credits
+```ts
+const standardCreatableModulesList: (CreatableModuleFactory | LabeledCreatableModuleFactory)[];
+```
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/module-factory-locator.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/module-factory-locator
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/module-factory-locator.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-factory-locator",
-  "version": "5.3.25",
+  "version": "5.3.27",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -36,52 +36,44 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/archivist-view": "~5.3.25",
-    "@xyo-network/bridge-http": "~5.3.25",
-    "@xyo-network/diviner-boundwitness-memory": "~5.3.25",
-    "@xyo-network/diviner-identity": "~5.3.25",
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/diviner-payload-generic": "~5.3.25",
-    "@xyo-network/node-memory": "~5.3.25",
-    "@xyo-network/node-view": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25",
-    "@xyo-network/sentinel-memory": "~5.3.25",
-    "@xyo-network/witness-adhoc": "~5.3.25",
-    "@xyo-network/archivist-memory": "~5.3.25"
+    "@xyo-network/archivist-view": "~5.3.27",
+    "@xyo-network/archivist-memory": "~5.3.27",
+    "@xyo-network/bridge-http": "~5.3.27",
+    "@xyo-network/diviner-boundwitness-memory": "~5.3.27",
+    "@xyo-network/diviner-identity": "~5.3.27",
+    "@xyo-network/diviner-payload-generic": "~5.3.27",
+    "@xyo-network/node-memory": "~5.3.27",
+    "@xyo-network/node-view": "~5.3.27",
+    "@xyo-network/payload-model": "~5.3.27",
+    "@xyo-network/sentinel-memory": "~5.3.27",
+    "@xyo-network/module-model": "~5.3.27",
+    "@xyo-network/witness-adhoc": "~5.3.27"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "~7.6.16",
-    "acorn": "^8.16.0",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.15",
+    "@xylabs/ts-scripts-pnpm": "~7.7.15",
+    "@xylabs/tsconfig": "~7.7.15",
     "axios": "^1.14.0",
-    "esbuild": "^0.28.0",
     "ethers": "^6.16.0",
-    "tslib": "^2.8.1",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/archivist-memory": "~5.3.25",
-    "@xyo-network/archivist-view": "~5.3.25",
-    "@xyo-network/bridge-http": "~5.3.25",
-    "@xyo-network/diviner-boundwitness-memory": "~5.3.25",
-    "@xyo-network/diviner-identity": "~5.3.25",
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/diviner-payload-generic": "~5.3.25",
-    "@xyo-network/node-view": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25",
-    "@xyo-network/sentinel-memory": "~5.3.25",
-    "@xyo-network/node-memory": "~5.3.25",
-    "@xyo-network/witness-adhoc": "~5.3.25"
+    "@xyo-network/archivist-memory": "~5.3.27",
+    "@xyo-network/archivist-view": "~5.3.27",
+    "@xyo-network/diviner-boundwitness-memory": "~5.3.27",
+    "@xyo-network/diviner-payload-generic": "~5.3.27",
+    "@xyo-network/diviner-identity": "~5.3.27",
+    "@xyo-network/bridge-http": "~5.3.27",
+    "@xyo-network/node-memory": "~5.3.27",
+    "@xyo-network/module-model": "~5.3.27",
+    "@xyo-network/node-view": "~5.3.27",
+    "@xyo-network/payload-model": "~5.3.27",
+    "@xyo-network/sentinel-memory": "~5.3.27",
+    "@xyo-network/witness-adhoc": "~5.3.27"
   },
   "peerDependencies": {
-    "@xylabs/sdk-js": "^5",
-    "axios": "^1",
-    "ethers": "^6",
-    "tslib": "^2.8.1",
-    "zod": "^4"
+    "@xylabs/sdk-js": "^5"
   },
   "publishConfig": {
     "access": "public"