@twin.org/modules 0.0.3-next.22 → 0.0.3-next.23

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Framework Modules
 
-Helper classes for loading and executing from modules.
+This package is part of the framework workspace and provides helper classes for loading and executing from modules to support consistent development workflows across the ecosystem.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,24 @@
-# @twin.org/modules - Changelog
+# Changelog
+
+## [0.0.3-next.23](https://github.com/twinfoundation/framework/compare/modules-v0.0.3-next.22...modules-v0.0.3-next.23) (2026-03-17)
+
+
+### Miscellaneous Chores
+
+* **modules:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/context bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof bumped from 0.0.3-next.22 to 0.0.3-next.23
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/validate-locales bumped from 0.0.3-next.22 to 0.0.3-next.23
 
 ## [0.0.3-next.22](https://github.com/twinfoundation/framework/compare/modules-v0.0.3-next.21...modules-v0.0.3-next.22) (2026-02-26)
 

package/docs/examples.md

@@ -1 +1,110 @@
-# @twin.org/modules - Examples
+# Modules Examples
+
+Use these snippets for dynamic module loading patterns at runtime extension points.
+
+## ModuleHelper
+
+```typescript
+import { ModuleHelper } from '@twin.org/modules';
+
+console.log(ModuleHelper.isRelativeModule('./workers/sendEmail.js')); // true
+console.log(ModuleHelper.isLocalModule('./workers/sendEmail.js')); // true
+console.log(ModuleHelper.isLocalModule('@twin.org/core')); // false
+```
+
+```typescript
+import { ModuleHelper } from '@twin.org/modules';
+
+const convertToFahrenheit = await ModuleHelper.getModuleMethod<(celsius: number) => number>(
+  './workers/temperature.js',
+  'convertToFahrenheit'
+);
+
+console.log(convertToFahrenheit(18)); // 64.4
+```
+
+```typescript
+import { ModuleHelper } from '@twin.org/modules';
+
+const sum = await ModuleHelper.getModuleEntry<(left: number, right: number) => number>(
+  './workers/math.js',
+  'sum'
+);
+
+console.log(sum(7, 5)); // 12
+```
+
+```typescript
+import { ModuleHelper } from '@twin.org/modules';
+
+const result = await ModuleHelper.execModuleMethod<number>(
+  './workers/temperature.js',
+  'convertToFahrenheit',
+  [18]
+);
+
+console.log(result); // 64.4
+```
+
+```typescript
+import { ModuleHelper } from '@twin.org/modules';
+
+ModuleHelper.overrideImport(async moduleName => {
+  if (moduleName === './workers/math.js') {
+    return {
+      module: {
+        sum: (left: number, right: number) => left + right
+      },
+      useDefault: false
+    };
+  }
+
+  return {
+    useDefault: true
+  };
+});
+
+const sum = await ModuleHelper.execModuleMethod<number>('./workers/math.js', 'sum', [3, 4]);
+
+console.log(sum); // 7
+```
+
+```typescript
+import { ModuleHelper } from '@twin.org/modules';
+
+const threaded = await ModuleHelper.execModuleMethodThread<number>(
+  './workers/temperature.js',
+  'convertToFahrenheit',
+  [18],
+  {
+    traceId: 'trc-01',
+    spanId: 'spn-02'
+  }
+);
+
+console.log(threaded); // 64.4
+```
+
+```typescript
+import { ModuleHelper } from '@twin.org/modules';
+
+const worker = ModuleHelper.execModuleMethodThreadMessage(
+  './workers/temperature.js',
+  (operation, result, err) => {
+    if (err) {
+      console.log(err.message); // resultError
+      return;
+    }
+
+    if (operation === 'convertToFahrenheit') {
+      console.log(result); // 64.4
+    }
+  },
+  {
+    threadName: 'temperature-worker'
+  }
+);
+
+worker.executeMethod('convertToFahrenheit', [18]);
+await worker.terminate();
+```

package/docs/reference/classes/ModuleHelper.md

@@ -14,7 +14,7 @@ Helper functions for modules.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### overrideImport()
+### overrideImport() {#overrideimport}
 
 > `static` **overrideImport**(`overrideImport`): `void`
 
@@ -42,7 +42,7 @@ The override import function.
 
 ***
 
-### getModuleEntry()
+### getModuleEntry() {#getmoduleentry}
 
 > `static` **getModuleEntry**\<`T`\>(`module`, `entry`): `Promise`\<`T`\>
 
@@ -80,7 +80,7 @@ GeneralError if getting the module entry failed.
 
 ***
 
-### getModuleMethod()
+### getModuleMethod() {#getmodulemethod}
 
 > `static` **getModuleMethod**\<`T`\>(`module`, `method`): `Promise`\<`T`\>
 
@@ -118,7 +118,7 @@ GeneralError if executing the module entry failed.
 
 ***
 
-### execModuleMethod()
+### execModuleMethod() {#execmodulemethod}
 
 > `static` **execModuleMethod**\<`T`\>(`module`, `method`, `args?`): `Promise`\<`T`\>
 
@@ -162,7 +162,7 @@ GeneralError if executing the module entry failed.
 
 ***
 
-### execModuleMethodThread()
+### execModuleMethodThread() {#execmodulemethodthread}
 
 > `static` **execModuleMethodThread**\<`T`\>(`module`, `method`, `args?`, `contextIds?`): `Promise`\<`T`\>
 
@@ -212,7 +212,7 @@ GeneralError if executing the module entry failed.
 
 ***
 
-### execModuleMethodThreadMessage()
+### execModuleMethodThreadMessage() {#execmodulemethodthreadmessage}
 
 > `static` **execModuleMethodThreadMessage**(`module`, `completed`, `options?`): [`IModuleWorker`](../interfaces/IModuleWorker.md)
 
@@ -254,7 +254,7 @@ GeneralError if executing the module entry failed.
 
 ***
 
-### isLocalModule()
+### isLocalModule() {#islocalmodule}
 
 > `static` **isLocalModule**(`name`): `boolean`
 
@@ -276,7 +276,7 @@ True if the module is local, false otherwise.
 
 ***
 
-### isRelativeModule()
+### isRelativeModule() {#isrelativemodule}
 
 > `static` **isRelativeModule**(`name`): `boolean`
 

package/docs/reference/interfaces/IModuleWorker.md

@@ -4,7 +4,7 @@ Worker definition for modules.
 
 ## Methods
 
-### executeMethod()
+### executeMethod() {#executemethod}
 
 > **executeMethod**(`method`, `args?`, `contextIds?`): `void`
 
@@ -38,7 +38,7 @@ The result of the method.
 
 ***
 
-### terminate()
+### terminate() {#terminate}
 
 > **terminate**(): `Promise`\<`number`\>
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/modules",
-	"version": "0.0.3-next.22",
+	"version": "0.0.3-next.23",
 	"description": "Helper classes for loading and executing from modules",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,9 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/context": "0.0.3-next.22",
-		"@twin.org/core": "0.0.3-next.22",
-		"@twin.org/nameof": "0.0.3-next.22"
+		"@twin.org/context": "0.0.3-next.23",
+		"@twin.org/core": "0.0.3-next.23",
+		"@twin.org/nameof": "0.0.3-next.23"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",