@twin.org/engine-core 0.0.2-next.10 → 0.0.2-next.12

package/dist/cjs/index.cjs

@@ -420,7 +420,7 @@ class EngineCore {
         if (core.Is.arrayValue(typeConfig)) {
             const instanceMethod = await modules.ModuleHelper.getModuleEntry(module, method);
             for (let i = 0; i < typeConfig.length; i++) {
-                const instanceType = instanceMethod(this, this._context, typeConfig[i], typeConfig[i].overrideInstanceType);
+                const instanceType = await instanceMethod(this, this._context, typeConfig[i], typeConfig[i].overrideInstanceType);
                 if (core.Is.stringValue(instanceType)) {
                     this._context.registeredInstances[typeKey] ??= [];
                     if (typeConfig[i].isDefault ?? false) {
@@ -644,6 +644,51 @@ class FileStateStorage {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper class for engine modules.
+ */
+class EngineModuleHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "EngineModuleHelper";
+    /**
+     * Loads an engine component and constructs it with the relevant dependencies and configuration.
+     * @param engineCore The engine core.
+     * @param engineModuleConfig The configuration for the module.
+     * @returns The instantiated component.
+     */
+    static async loadComponent(engineCore, engineModuleConfig) {
+        const moduleClass = await modules.ModuleHelper.getModuleEntry(engineModuleConfig.moduleName, engineModuleConfig.className);
+        const isClass = core.Is.class(moduleClass);
+        if (!isClass) {
+            throw new core.GeneralError(EngineModuleHelper.CLASS_NAME, "moduleNotClass", {
+                moduleName: engineModuleConfig.moduleName,
+                className: engineModuleConfig.className
+            });
+        }
+        const constructorOptions = {};
+        if (core.Is.arrayValue(engineModuleConfig.dependencies)) {
+            for (const dependency of engineModuleConfig.dependencies) {
+                if (dependency.isOptional ?? false) {
+                    constructorOptions[dependency.propertyName] = engineCore.getRegisteredInstanceType(dependency.componentName, dependency.features);
+                }
+                else {
+                    constructorOptions[dependency.propertyName] =
+                        engineCore.getRegisteredInstanceTypeOptional(dependency.componentName, dependency.features);
+                }
+            }
+        }
+        if (core.Is.object(engineModuleConfig.config)) {
+            constructorOptions.config = engineModuleConfig.config;
+        }
+        return new moduleClass(constructorOptions);
+    }
+}
+
 exports.EngineCore = EngineCore;
+exports.EngineModuleHelper = EngineModuleHelper;
 exports.FileStateStorage = FileStateStorage;
 exports.MemoryStateStorage = MemoryStateStorage;

package/dist/esm/index.mjs

@@ -418,7 +418,7 @@ class EngineCore {
         if (Is.arrayValue(typeConfig)) {
             const instanceMethod = await ModuleHelper.getModuleEntry(module, method);
             for (let i = 0; i < typeConfig.length; i++) {
-                const instanceType = instanceMethod(this, this._context, typeConfig[i], typeConfig[i].overrideInstanceType);
+                const instanceType = await instanceMethod(this, this._context, typeConfig[i], typeConfig[i].overrideInstanceType);
                 if (Is.stringValue(instanceType)) {
                     this._context.registeredInstances[typeKey] ??= [];
                     if (typeConfig[i].isDefault ?? false) {
@@ -642,4 +642,48 @@ class FileStateStorage {
     }
 }
 
-export { EngineCore, FileStateStorage, MemoryStateStorage };
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper class for engine modules.
+ */
+class EngineModuleHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "EngineModuleHelper";
+    /**
+     * Loads an engine component and constructs it with the relevant dependencies and configuration.
+     * @param engineCore The engine core.
+     * @param engineModuleConfig The configuration for the module.
+     * @returns The instantiated component.
+     */
+    static async loadComponent(engineCore, engineModuleConfig) {
+        const moduleClass = await ModuleHelper.getModuleEntry(engineModuleConfig.moduleName, engineModuleConfig.className);
+        const isClass = Is.class(moduleClass);
+        if (!isClass) {
+            throw new GeneralError(EngineModuleHelper.CLASS_NAME, "moduleNotClass", {
+                moduleName: engineModuleConfig.moduleName,
+                className: engineModuleConfig.className
+            });
+        }
+        const constructorOptions = {};
+        if (Is.arrayValue(engineModuleConfig.dependencies)) {
+            for (const dependency of engineModuleConfig.dependencies) {
+                if (dependency.isOptional ?? false) {
+                    constructorOptions[dependency.propertyName] = engineCore.getRegisteredInstanceType(dependency.componentName, dependency.features);
+                }
+                else {
+                    constructorOptions[dependency.propertyName] =
+                        engineCore.getRegisteredInstanceTypeOptional(dependency.componentName, dependency.features);
+                }
+            }
+        }
+        if (Is.object(engineModuleConfig.config)) {
+            constructorOptions.config = engineModuleConfig.config;
+        }
+        return new moduleClass(constructorOptions);
+    }
+}
+
+export { EngineCore, EngineModuleHelper, FileStateStorage, MemoryStateStorage };

package/dist/types/index.d.ts

@@ -2,3 +2,4 @@ export * from "./engineCore";
 export * from "./models/IEngineCoreOptions";
 export * from "./storage/fileStateStorage";
 export * from "./storage/memoryStateStorage";
+export * from "./utils/engineModuleHelper";

package/dist/types/utils/engineModuleHelper.d.ts

@@ -0,0 +1,17 @@
+import type { IEngineCore, IEngineModuleConfig } from "@twin.org/engine-models";
+/**
+ * Helper class for engine modules.
+ */
+export declare class EngineModuleHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Loads an engine component and constructs it with the relevant dependencies and configuration.
+     * @param engineCore The engine core.
+     * @param engineModuleConfig The configuration for the module.
+     * @returns The instantiated component.
+     */
+    static loadComponent<T>(engineCore: IEngineCore, engineModuleConfig: IEngineModuleConfig): Promise<T>;
+}

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/engine-core - Changelog
 
+## [0.0.2-next.12](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.11...engine-core-v0.0.2-next.12) (2025-09-05)
+
+
+### Features
+
+* add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.11 to 0.0.2-next.12
+
+## [0.0.2-next.11](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.10...engine-core-v0.0.2-next.11) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.10 to 0.0.2-next.11
+
 ## [0.0.2-next.10](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.9...engine-core-v0.0.2-next.10) (2025-08-26)
 
 

package/docs/reference/classes/EngineModuleHelper.md

@@ -0,0 +1,55 @@
+# Class: EngineModuleHelper
+
+Helper class for engine modules.
+
+## Constructors
+
+### Constructor
+
+> **new EngineModuleHelper**(): `EngineModuleHelper`
+
+#### Returns
+
+`EngineModuleHelper`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### loadComponent()
+
+> `static` **loadComponent**\<`T`\>(`engineCore`, `engineModuleConfig`): `Promise`\<`T`\>
+
+Loads an engine component and constructs it with the relevant dependencies and configuration.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### engineCore
+
+`IEngineCore`
+
+The engine core.
+
+##### engineModuleConfig
+
+`IEngineModuleConfig`
+
+The configuration for the module.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+The instantiated component.

package/docs/reference/index.md

@@ -5,6 +5,7 @@
 - [EngineCore](classes/EngineCore.md)
 - [FileStateStorage](classes/FileStateStorage.md)
 - [MemoryStateStorage](classes/MemoryStateStorage.md)
+- [EngineModuleHelper](classes/EngineModuleHelper.md)
 
 ## Interfaces
 

package/locales/en.json

@@ -12,6 +12,9 @@
 		"fileStateStorage": {
 			"failedLoading": "Failed to load file state storage from \"{filename}\"",
 			"failedSaving": "Failed to save file state storage to \"{filename}\""
+		},
+		"engineModuleHelper": {
+			"moduleNotClass": "The module \"{moduleName}\" does not export a class \"{className}\""
 		}
 	},
 	"engineCore": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-core",
-	"version": "0.0.2-next.10",
+	"version": "0.0.2-next.12",
 	"description": "Engine core.",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-core": "next",
-		"@twin.org/engine-models": "0.0.2-next.10",
+		"@twin.org/engine-models": "0.0.2-next.12",
 		"@twin.org/entity": "next",
 		"@twin.org/logging-connector-console": "next",
 		"@twin.org/logging-models": "next",