@twin.org/modules 0.0.1-next.16

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Framework Modules
+
+Helper classes for loading and executing from modules.
+
+## Installation
+
+```shell
+npm install @twin.org/modules
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,158 @@
+'use strict';
+
+var node_worker_threads = require('node:worker_threads');
+var core = require('@twin.org/core');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/* eslint-disable promise/prefer-await-to-then */
+/**
+ * Helper functions for modules.
+ */
+class ModuleHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ModuleHelper";
+    /**
+     * Get the module entry.
+     * @param module The module.
+     * @param entry The entry to get from the module.
+     * @returns The entry from the module.
+     * @throws GeneralError if getting the module entry failed.
+     */
+    static async getModuleEntry(module, entry) {
+        let moduleInstance;
+        try {
+            moduleInstance = await import(module);
+        }
+        catch (err) {
+            throw new core.GeneralError(ModuleHelper.CLASS_NAME, "moduleNotFound", {
+                module,
+                entry
+            }, core.BaseError.fromError(err));
+        }
+        const moduleEntry = moduleInstance[entry];
+        if (core.Is.empty(moduleEntry)) {
+            throw new core.GeneralError(ModuleHelper.CLASS_NAME, "entryNotFound", {
+                module,
+                entry
+            });
+        }
+        return moduleEntry;
+    }
+    /**
+     * Get the method from a module.
+     * @param module The module.
+     * @param method The method to execute from the module, use dot notation to get a static class method.
+     * @returns The result of the method execution.
+     * @throws GeneralError if executing the module entry failed.
+     */
+    static async getModuleMethod(module, method) {
+        const methodParts = method.split(".");
+        if (methodParts.length === 2) {
+            const moduleEntry = await ModuleHelper.getModuleEntry(module, methodParts[0]);
+            if (core.Is.function(moduleEntry[methodParts[1]])) {
+                return moduleEntry[methodParts[1]];
+            }
+            throw new core.GeneralError(ModuleHelper.CLASS_NAME, "notFunction", {
+                module,
+                entry: method
+            });
+        }
+        const moduleEntry = await ModuleHelper.getModuleEntry(module, methodParts[0]);
+        if (core.Is.function(moduleEntry)) {
+            return moduleEntry;
+        }
+        throw new core.GeneralError(ModuleHelper.CLASS_NAME, "notFunction", {
+            module,
+            entry: method
+        });
+    }
+    /**
+     * Execute the method in the module.
+     * @param module The module.
+     * @param method The method to execute from the module.
+     * @param args The arguments to pass to the method.
+     * @returns The result of the method execution.
+     * @throws GeneralError if executing the module entry failed.
+     */
+    static async execModuleMethod(module, method, args) {
+        const moduleMethod = await ModuleHelper.getModuleMethod(module, method);
+        return moduleMethod(...(args ?? []));
+    }
+    /**
+     * Execute the method in the module in a thread.
+     * @param module The module.
+     * @param method The method to execute from the module.
+     * @param args The arguments to pass to the method.
+     * @returns The result of the method execution.
+     * @throws GeneralError if executing the module entry failed.
+     */
+    static async execModuleMethodThread(module, method, args) {
+        return new Promise((resolve, reject) => {
+            const worker = new node_worker_threads.Worker(`
+	    const { workerData, parentPort } = require('worker_threads');
+
+			function rejectError(type, innerError) {
+				parentPort.postMessage({ errorType: type, innerError });
+			}
+
+			function resolveResult(result) {
+				Promise.resolve(result).then(res => parentPort.postMessage({ result: res }));
+			}
+
+			const { module, method, args } = workerData;
+
+			import(module)
+				.then(moduleInstance => {
+					const methodParts = method.split(".");
+					const moduleEntry = moduleInstance[methodParts[0]];
+
+					if (moduleEntry === undefined) {
+						rejectError("entryNotFound");
+					} else if (methodParts.length === 2) {
+						const moduleMethod = moduleEntry[methodParts[1]];
+						if (typeof moduleMethod === "function") {
+							resolveResult(moduleMethod(...(args ?? [])));
+						} else {
+							rejectError("notFunction");
+						}
+					} else if (typeof moduleEntry === "function") {
+						resolveResult(moduleEntry(...(args ?? [])));
+					} else {
+						rejectError("notFunction");
+					}
+				})
+				.catch(err => {
+					rejectError("moduleNotFound", err);
+				});
+	  `, { eval: true, workerData: { module, method, args: args ?? [] } });
+            worker.on("message", msg => {
+                if (core.Is.stringValue(msg.errorType)) {
+                    reject(new core.GeneralError(ModuleHelper.CLASS_NAME, msg.errorType, { module, entry: method }, msg.innerError));
+                }
+                else {
+                    resolve(msg.result);
+                }
+            });
+            worker.on("error", err => {
+                reject(new core.GeneralError(ModuleHelper.CLASS_NAME, "workerException", {
+                    module,
+                    entry: method
+                }, err));
+            });
+            worker.on("exit", code => {
+                if (code === 1) {
+                    reject(new core.GeneralError(ModuleHelper.CLASS_NAME, "workerFailed", {
+                        module,
+                        entry: method,
+                        exitCode: code
+                    }));
+                }
+            });
+        });
+    }
+}
+
+exports.ModuleHelper = ModuleHelper;

package/dist/esm/index.mjs

@@ -0,0 +1,156 @@
+import { Worker } from 'node:worker_threads';
+import { GeneralError, BaseError, Is } from '@twin.org/core';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/* eslint-disable promise/prefer-await-to-then */
+/**
+ * Helper functions for modules.
+ */
+class ModuleHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ModuleHelper";
+    /**
+     * Get the module entry.
+     * @param module The module.
+     * @param entry The entry to get from the module.
+     * @returns The entry from the module.
+     * @throws GeneralError if getting the module entry failed.
+     */
+    static async getModuleEntry(module, entry) {
+        let moduleInstance;
+        try {
+            moduleInstance = await import(module);
+        }
+        catch (err) {
+            throw new GeneralError(ModuleHelper.CLASS_NAME, "moduleNotFound", {
+                module,
+                entry
+            }, BaseError.fromError(err));
+        }
+        const moduleEntry = moduleInstance[entry];
+        if (Is.empty(moduleEntry)) {
+            throw new GeneralError(ModuleHelper.CLASS_NAME, "entryNotFound", {
+                module,
+                entry
+            });
+        }
+        return moduleEntry;
+    }
+    /**
+     * Get the method from a module.
+     * @param module The module.
+     * @param method The method to execute from the module, use dot notation to get a static class method.
+     * @returns The result of the method execution.
+     * @throws GeneralError if executing the module entry failed.
+     */
+    static async getModuleMethod(module, method) {
+        const methodParts = method.split(".");
+        if (methodParts.length === 2) {
+            const moduleEntry = await ModuleHelper.getModuleEntry(module, methodParts[0]);
+            if (Is.function(moduleEntry[methodParts[1]])) {
+                return moduleEntry[methodParts[1]];
+            }
+            throw new GeneralError(ModuleHelper.CLASS_NAME, "notFunction", {
+                module,
+                entry: method
+            });
+        }
+        const moduleEntry = await ModuleHelper.getModuleEntry(module, methodParts[0]);
+        if (Is.function(moduleEntry)) {
+            return moduleEntry;
+        }
+        throw new GeneralError(ModuleHelper.CLASS_NAME, "notFunction", {
+            module,
+            entry: method
+        });
+    }
+    /**
+     * Execute the method in the module.
+     * @param module The module.
+     * @param method The method to execute from the module.
+     * @param args The arguments to pass to the method.
+     * @returns The result of the method execution.
+     * @throws GeneralError if executing the module entry failed.
+     */
+    static async execModuleMethod(module, method, args) {
+        const moduleMethod = await ModuleHelper.getModuleMethod(module, method);
+        return moduleMethod(...(args ?? []));
+    }
+    /**
+     * Execute the method in the module in a thread.
+     * @param module The module.
+     * @param method The method to execute from the module.
+     * @param args The arguments to pass to the method.
+     * @returns The result of the method execution.
+     * @throws GeneralError if executing the module entry failed.
+     */
+    static async execModuleMethodThread(module, method, args) {
+        return new Promise((resolve, reject) => {
+            const worker = new Worker(`
+	    const { workerData, parentPort } = require('worker_threads');
+
+			function rejectError(type, innerError) {
+				parentPort.postMessage({ errorType: type, innerError });
+			}
+
+			function resolveResult(result) {
+				Promise.resolve(result).then(res => parentPort.postMessage({ result: res }));
+			}
+
+			const { module, method, args } = workerData;
+
+			import(module)
+				.then(moduleInstance => {
+					const methodParts = method.split(".");
+					const moduleEntry = moduleInstance[methodParts[0]];
+
+					if (moduleEntry === undefined) {
+						rejectError("entryNotFound");
+					} else if (methodParts.length === 2) {
+						const moduleMethod = moduleEntry[methodParts[1]];
+						if (typeof moduleMethod === "function") {
+							resolveResult(moduleMethod(...(args ?? [])));
+						} else {
+							rejectError("notFunction");
+						}
+					} else if (typeof moduleEntry === "function") {
+						resolveResult(moduleEntry(...(args ?? [])));
+					} else {
+						rejectError("notFunction");
+					}
+				})
+				.catch(err => {
+					rejectError("moduleNotFound", err);
+				});
+	  `, { eval: true, workerData: { module, method, args: args ?? [] } });
+            worker.on("message", msg => {
+                if (Is.stringValue(msg.errorType)) {
+                    reject(new GeneralError(ModuleHelper.CLASS_NAME, msg.errorType, { module, entry: method }, msg.innerError));
+                }
+                else {
+                    resolve(msg.result);
+                }
+            });
+            worker.on("error", err => {
+                reject(new GeneralError(ModuleHelper.CLASS_NAME, "workerException", {
+                    module,
+                    entry: method
+                }, err));
+            });
+            worker.on("exit", code => {
+                if (code === 1) {
+                    reject(new GeneralError(ModuleHelper.CLASS_NAME, "workerFailed", {
+                        module,
+                        entry: method,
+                        exitCode: code
+                    }));
+                }
+            });
+        });
+    }
+}
+
+export { ModuleHelper };

package/dist/types/helpers/moduleHelper.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Helper functions for modules.
+ */
+export declare class ModuleHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Get the module entry.
+     * @param module The module.
+     * @param entry The entry to get from the module.
+     * @returns The entry from the module.
+     * @throws GeneralError if getting the module entry failed.
+     */
+    static getModuleEntry<T>(module: string, entry: string): Promise<T>;
+    /**
+     * Get the method from a module.
+     * @param module The module.
+     * @param method The method to execute from the module, use dot notation to get a static class method.
+     * @returns The result of the method execution.
+     * @throws GeneralError if executing the module entry failed.
+     */
+    static getModuleMethod<T>(module: string, method: string): Promise<(...args: unknown[]) => T>;
+    /**
+     * Execute the method in the module.
+     * @param module The module.
+     * @param method The method to execute from the module.
+     * @param args The arguments to pass to the method.
+     * @returns The result of the method execution.
+     * @throws GeneralError if executing the module entry failed.
+     */
+    static execModuleMethod<T>(module: string, method: string, args?: unknown[]): Promise<T>;
+    /**
+     * Execute the method in the module in a thread.
+     * @param module The module.
+     * @param method The method to execute from the module.
+     * @param args The arguments to pass to the method.
+     * @returns The result of the method execution.
+     * @throws GeneralError if executing the module entry failed.
+     */
+    static execModuleMethodThread<T>(module: string, method: string, args?: unknown[]): Promise<T>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./helpers/moduleHelper";

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/modules - Changelog
+
+## 0.0.1-next.16
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/modules - Examples

package/docs/reference/classes/ModuleHelper.md

@@ -0,0 +1,157 @@
+# Class: ModuleHelper
+
+Helper functions for modules.
+
+## Constructors
+
+### new ModuleHelper()
+
+> **new ModuleHelper**(): [`ModuleHelper`](ModuleHelper.md)
+
+#### Returns
+
+[`ModuleHelper`](ModuleHelper.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### getModuleEntry()
+
+> `static` **getModuleEntry**\<`T`\>(`module`, `entry`): `Promise`\<`T`\>
+
+Get the module entry.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **module**: `string`
+
+The module.
+
+• **entry**: `string`
+
+The entry to get from the module.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+The entry from the module.
+
+#### Throws
+
+GeneralError if getting the module entry failed.
+
+***
+
+### getModuleMethod()
+
+> `static` **getModuleMethod**\<`T`\>(`module`, `method`): `Promise`\<(...`args`) => `T`\>
+
+Get the method from a module.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **module**: `string`
+
+The module.
+
+• **method**: `string`
+
+The method to execute from the module, use dot notation to get a static class method.
+
+#### Returns
+
+`Promise`\<(...`args`) => `T`\>
+
+The result of the method execution.
+
+#### Throws
+
+GeneralError if executing the module entry failed.
+
+***
+
+### execModuleMethod()
+
+> `static` **execModuleMethod**\<`T`\>(`module`, `method`, `args`?): `Promise`\<`T`\>
+
+Execute the method in the module.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **module**: `string`
+
+The module.
+
+• **method**: `string`
+
+The method to execute from the module.
+
+• **args?**: `unknown`[]
+
+The arguments to pass to the method.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+The result of the method execution.
+
+#### Throws
+
+GeneralError if executing the module entry failed.
+
+***
+
+### execModuleMethodThread()
+
+> `static` **execModuleMethodThread**\<`T`\>(`module`, `method`, `args`?): `Promise`\<`T`\>
+
+Execute the method in the module in a thread.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **module**: `string`
+
+The module.
+
+• **method**: `string`
+
+The method to execute from the module.
+
+• **args?**: `unknown`[]
+
+The arguments to pass to the method.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+The result of the method execution.
+
+#### Throws
+
+GeneralError if executing the module entry failed.

package/docs/reference/index.md

@@ -0,0 +1,5 @@
+# @twin.org/modules
+
+## Classes
+
+- [ModuleHelper](classes/ModuleHelper.md)

package/locales/en.json

@@ -0,0 +1,11 @@
+{
+	"error": {
+		"moduleHelper": {
+			"moduleNotFound": "Failed to load module \"{module}\"",
+			"entryNotFound": "Failed to load entry \"{entry}\" from module \"{module}\"",
+			"notFunction": "The entry \"{entry}\" in module \"{module}\" is not a function",
+			"workerFailed": "The thread worker failed for \"{entry}\" in module \"{module}\" with exit code \"{exitCode}\"",
+			"workerException": "The thread worker failed with an exception \"{entry}\" in module \"{module}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+	"name": "@twin.org/modules",
+	"version": "0.0.1-next.16",
+	"description": "Helper classes for loading and executing from modules",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/framework.git",
+		"directory": "packages/modules"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}