@twin.org/engine-core 0.0.3-next.9 → 0.9.0

package/docs/reference/interfaces/IEngineCoreOptions.md

@@ -14,33 +14,33 @@ The options for creating engine core.
 
 ## Properties
 
-### config?
+### config? {#config}
 
-> `optional` **config**: `C`
+> `optional` **config?**: `C`
 
 The engine core config.
 
 ***
 
-### stateStorage?
+### stateStorage? {#statestorage}
 
-> `optional` **stateStorage**: `IEngineStateStorage`\<`S`\>
+> `optional` **stateStorage?**: `IEngineStateStorage`\<`S`\>
 
 The state storage component.
 
 ***
 
-### skipBootstrap?
+### skipBootstrap? {#skipbootstrap}
 
-> `optional` **skipBootstrap**: `boolean`
+> `optional` **skipBootstrap?**: `boolean`
 
 Skip the bootstrap process, useful for additional engine instances.
 
 ***
 
-### populateTypeInitialisers()?
+### populateTypeInitialisers? {#populatetypeinitialisers}
 
-> `optional` **populateTypeInitialisers**: (`engineCore`, `context`) => `void`
+> `optional` **populateTypeInitialisers?**: (`engineCore`, `context`) => `void`
 
 Populate the type initialisers for the engine.
 
@@ -60,9 +60,9 @@ Populate the type initialisers for the engine.
 
 ***
 
-### customBootstrap()?
+### customBootstrap? {#custombootstrap}
 
-> `optional` **customBootstrap**: (`engineCore`, `context`) => `Promise`\<`void`\>
+> `optional` **customBootstrap?**: (`engineCore`, `context`) => `Promise`\<`void`\>
 
 Custom bootstrap method for the engine.
 

package/locales/en.json

@@ -5,14 +5,12 @@
 			"bootstrapFailed": "Failed to bootstrap component type \"{className}\" with instance type \"{instanceType}\"",
 			"componentStartFailed": "Failed to start component type \"{className}\" with instance type \"{instanceType}\"",
 			"componentStopFailed": "Failed to stop component type \"{className}\" with instance type \"{instanceType}\"",
-			"instanceTypeNotFound": "Instance type not found for \"{type}\" with features \"{features}\""
+			"instanceTypeNotFound": "Instance type not found for \"{type}\"",
+			"instanceTypeNotFoundWithFeatures": "Instance type not found for \"{type}\" with features \"{features}\""
 		},
 		"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,10 +1,10 @@
 {
 	"name": "@twin.org/engine-core",
-	"version": "0.0.3-next.9",
-	"description": "Engine core.",
+	"version": "0.9.0",
+	"description": "Core runtime lifecycle and state orchestration for engine instances.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/engine.git",
+		"url": "git+https://github.com/iotaledger/twin-engine.git",
 		"directory": "packages/engine-core"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,17 +14,17 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/context": "next",
-		"@twin.org/core": "next",
-		"@twin.org/crypto": "next",
-		"@twin.org/data-core": "next",
-		"@twin.org/engine-models": "0.0.3-next.9",
-		"@twin.org/entity": "next",
-		"@twin.org/logging-connector-console": "next",
-		"@twin.org/logging-models": "next",
-		"@twin.org/logging-service": "next",
-		"@twin.org/modules": "next",
-		"@twin.org/nameof": "next"
+		"@twin.org/context": "^0.9.0",
+		"@twin.org/core": "^0.9.0",
+		"@twin.org/crypto": "^0.9.0",
+		"@twin.org/data-core": "^0.9.0",
+		"@twin.org/engine-models": "^0.9.0",
+		"@twin.org/entity": "^0.9.0",
+		"@twin.org/logging-connector-console": "^0.9.0",
+		"@twin.org/logging-models": "^0.9.0",
+		"@twin.org/logging-service": "^0.9.0",
+		"@twin.org/modules": "^0.9.0",
+		"@twin.org/nameof": "^0.9.0"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -54,7 +54,7 @@
 		"utilities"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/engine/issues"
+		"url": "git+https://github.com/iotaledger/twin-engine/issues"
 	},
 	"homepage": "https://twindev.org"
 }

package/dist/es/utils/engineModuleHelper.js

@@ -1,46 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-import { GeneralError, Is } from "@twin.org/core";
-import { ModuleHelper } from "@twin.org/modules";
-/**
- * Helper class for engine modules.
- */
-export 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);
-    }
-}
-//# sourceMappingURL=engineModuleHelper.js.map

package/dist/es/utils/engineModuleHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"engineModuleHelper.js","sourceRoot":"","sources":["../../../src/utils/engineModuleHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAChC,UAAuB,EACvB,kBAAuC;QAEvC,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,cAAc,CACpD,kBAAkB,CAAC,UAAU,EAC7B,kBAAkB,CAAC,SAAS,CAC5B,CAAC;QAEF,MAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,UAAU,EAAE,gBAAgB,EAAE;gBACvE,UAAU,EAAE,kBAAkB,CAAC,UAAU;gBACzC,SAAS,EAAE,kBAAkB,CAAC,SAAS;aACvC,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,kBAAkB,GAA+B,EAAE,CAAC;QAE1D,IAAI,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;YACpD,KAAK,MAAM,UAAU,IAAI,kBAAkB,CAAC,YAAY,EAAE,CAAC;gBAC1D,IAAI,UAAU,CAAC,UAAU,IAAI,KAAK,EAAE,CAAC;oBACpC,kBAAkB,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,yBAAyB,CACjF,UAAU,CAAC,aAAa,EACxB,UAAU,CAAC,QAAQ,CACnB,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACP,kBAAkB,CAAC,UAAU,CAAC,YAAY,CAAC;wBAC1C,UAAU,CAAC,iCAAiC,CAC3C,UAAU,CAAC,aAAa,EACxB,UAAU,CAAC,QAAQ,CACnB,CAAC;gBACJ,CAAC;YACF,CAAC;QACF,CAAC;QAED,IAAI,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,kBAAkB,CAAC,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC;QACvD,CAAC;QAED,OAAO,IAAI,WAAW,CAAC,kBAAkB,CAAM,CAAC;IACjD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Is } from \"@twin.org/core\";\nimport type { IEngineCore, IEngineModuleConfig } from \"@twin.org/engine-models\";\nimport { ModuleHelper } from \"@twin.org/modules\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * Helper class for engine modules.\n */\nexport class EngineModuleHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<EngineModuleHelper>();\n\n\t/**\n\t * Loads an engine component and constructs it with the relevant dependencies and configuration.\n\t * @param engineCore The engine core.\n\t * @param engineModuleConfig The configuration for the module.\n\t * @returns The instantiated component.\n\t */\n\tpublic static async loadComponent<T>(\n\t\tengineCore: IEngineCore,\n\t\tengineModuleConfig: IEngineModuleConfig\n\t): Promise<T> {\n\t\tconst moduleClass = await ModuleHelper.getModuleEntry(\n\t\t\tengineModuleConfig.moduleName,\n\t\t\tengineModuleConfig.className\n\t\t);\n\n\t\tconst isClass = Is.class(moduleClass);\n\t\tif (!isClass) {\n\t\t\tthrow new GeneralError(EngineModuleHelper.CLASS_NAME, \"moduleNotClass\", {\n\t\t\t\tmoduleName: engineModuleConfig.moduleName,\n\t\t\t\tclassName: engineModuleConfig.className\n\t\t\t});\n\t\t}\n\n\t\tconst constructorOptions: { [key: string]: unknown } = {};\n\n\t\tif (Is.arrayValue(engineModuleConfig.dependencies)) {\n\t\t\tfor (const dependency of engineModuleConfig.dependencies) {\n\t\t\t\tif (dependency.isOptional ?? false) {\n\t\t\t\t\tconstructorOptions[dependency.propertyName] = engineCore.getRegisteredInstanceType(\n\t\t\t\t\t\tdependency.componentName,\n\t\t\t\t\t\tdependency.features\n\t\t\t\t\t);\n\t\t\t\t} else {\n\t\t\t\t\tconstructorOptions[dependency.propertyName] =\n\t\t\t\t\t\tengineCore.getRegisteredInstanceTypeOptional(\n\t\t\t\t\t\t\tdependency.componentName,\n\t\t\t\t\t\t\tdependency.features\n\t\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif (Is.object(engineModuleConfig.config)) {\n\t\t\tconstructorOptions.config = engineModuleConfig.config;\n\t\t}\n\n\t\treturn new moduleClass(constructorOptions) as T;\n\t}\n}\n"]}

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

@@ -1,17 +0,0 @@
-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/reference/classes/EngineModuleHelper.md

@@ -1,55 +0,0 @@
-# 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.