@twin.org/engine-core 0.0.2-next.2 → 0.0.2-next.20

package/docs/changelog.md

@@ -1,5 +1,257 @@
 # @twin.org/engine-core - Changelog
 
+## [0.0.2-next.20](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.19...engine-core-v0.0.2-next.20) (2025-10-06)
+
+
+### Features
+
+* standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.19 to 0.0.2-next.20
+
+## [0.0.2-next.19](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.18...engine-core-v0.0.2-next.19) (2025-10-02)
+
+
+### Features
+
+* simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.18 to 0.0.2-next.19
+
+## [0.0.2-next.18](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.17...engine-core-v0.0.2-next.18) (2025-09-29)
+
+
+### Features
+
+* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.17 to 0.0.2-next.18
+
+## [0.0.2-next.17](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.16...engine-core-v0.0.2-next.17) (2025-09-26)
+
+
+### Miscellaneous Chores
+
+* **engine-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.16 to 0.0.2-next.17
+
+## [0.0.2-next.16](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.15...engine-core-v0.0.2-next.16) (2025-09-25)
+
+
+### Miscellaneous Chores
+
+* **engine-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.15 to 0.0.2-next.16
+
+## [0.0.2-next.15](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.14...engine-core-v0.0.2-next.15) (2025-09-24)
+
+
+### Miscellaneous Chores
+
+* **engine-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.14 to 0.0.2-next.15
+
+## [0.0.2-next.14](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.13...engine-core-v0.0.2-next.14) (2025-09-19)
+
+
+### Miscellaneous Chores
+
+* **engine-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.13 to 0.0.2-next.14
+
+## [0.0.2-next.13](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.12...engine-core-v0.0.2-next.13) (2025-09-08)
+
+
+### Miscellaneous Chores
+
+* **engine-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.12 to 0.0.2-next.13
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **engine-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.8...engine-core-v0.0.2-next.9) (2025-08-25)
+
+
+### Features
+
+* add isPrimary and isClone methods ([a7c63e9](https://github.com/twinfoundation/engine/commit/a7c63e97f54c95b104cc81e66d3fa42c6607bdc1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.7...engine-core-v0.0.2-next.8) (2025-08-22)
+
+
+### Miscellaneous Chores
+
+* **engine-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.6...engine-core-v0.0.2-next.7) (2025-08-22)
+
+
+### Features
+
+* remove unused component states ([d56d648](https://github.com/twinfoundation/engine/commit/d56d6486119ea8b8501a33f9e3a3101a08b826ed))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [0.0.2-next.6](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.5...engine-core-v0.0.2-next.6) (2025-08-21)
+
+
+### Features
+
+* update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.4...engine-core-v0.0.2-next.5) (2025-08-14)
+
+
+### Features
+
+* add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.3...engine-core-v0.0.2-next.4) (2025-07-25)
+
+
+### Features
+
+* add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.2...engine-core-v0.0.2-next.3) (2025-07-24)
+
+
+### Miscellaneous Chores
+
+* **engine-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
 ## [0.0.2-next.2](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.1...engine-core-v0.0.2-next.2) (2025-07-21)
 
 

package/docs/reference/classes/EngineCore.md

@@ -38,19 +38,11 @@ The options for the engine.
 
 ## Properties
 
-### LOGGER\_TYPE\_NAME
+### LOGGING\_TYPE\_NAME
 
-> `readonly` `static` **LOGGER\_TYPE\_NAME**: `string` = `"engine"`
+> `readonly` `static` **LOGGING\_TYPE\_NAME**: `string` = `"engine-logging-service"`
 
-Name for the engine logger.
-
-***
-
-### CLASS\_NAME
-
-> `readonly` **CLASS\_NAME**: `string`
-
-Runtime name for the class.
+Name for the engine logger, used for direct console logging.
 
 ***
 
@@ -64,7 +56,7 @@ The core context.
 
 ### addTypeInitialiser()
 
-> **addTypeInitialiser**(`type`, `typeConfig`, `module`, `method`): `void`
+> **addTypeInitialiser**(`type`, `module`, `method`): `void`
 
 Add a type initialiser.
 
@@ -76,12 +68,6 @@ Add a type initialiser.
 
 The type to add the initialiser for.
 
-##### typeConfig
-
-The type config.
-
-`undefined` | `IEngineCoreTypeConfig`[]
-
 ##### module
 
 `string`
@@ -104,6 +90,32 @@ The name of the method to call.
 
 ***
 
+### getTypeConfig()
+
+> **getTypeConfig**(`type`): `undefined` \| `IEngineCoreTypeConfig`[]
+
+Get the type config for a specific type.
+
+#### Parameters
+
+##### type
+
+`string`
+
+The type to get the config for.
+
+#### Returns
+
+`undefined` \| `IEngineCoreTypeConfig`[]
+
+The type config or undefined if not found.
+
+#### Implementation of
+
+`IEngineCore.getTypeConfig`
+
+***
+
 ### start()
 
 > **start**(): `Promise`\<`boolean`\>
@@ -140,6 +152,60 @@ Nothing.
 
 ***
 
+### isStarted()
+
+> **isStarted**(): `boolean`
+
+Is the engine started.
+
+#### Returns
+
+`boolean`
+
+True if the engine is started.
+
+#### Implementation of
+
+`IEngineCore.isStarted`
+
+***
+
+### isPrimary()
+
+> **isPrimary**(): `boolean`
+
+Is this the primary engine instance.
+
+#### Returns
+
+`boolean`
+
+True if the engine is the primary instance.
+
+#### Implementation of
+
+`IEngineCore.isPrimary`
+
+***
+
+### isClone()
+
+> **isClone**(): `boolean`
+
+Is this engine instance a clone.
+
+#### Returns
+
+`boolean`
+
+True if the engine instance is a clone.
+
+#### Implementation of
+
+`IEngineCore.isClone`
+
+***
+
 ### logInfo()
 
 > **logInfo**(`message`): `void`
@@ -224,21 +290,89 @@ The state of the engine.
 
 ***
 
-### getDefaultTypes()
+### getRegisteredInstances()
 
-> **getDefaultTypes**(): `object`
+> **getRegisteredInstances**(): `object`
 
-Get the types for the component.
+Get all the registered instances.
 
 #### Returns
 
 `object`
 
-The default types.
+The registered instances.
+
+#### Implementation of
+
+`IEngineCore.getRegisteredInstances`
+
+***
+
+### getRegisteredInstanceType()
+
+> **getRegisteredInstanceType**(`componentConnectorType`, `features?`): `string`
+
+Get the registered instance type for the component/connector.
+
+#### Parameters
+
+##### componentConnectorType
+
+`string`
+
+The type of the component/connector.
+
+##### features?
+
+`string`[]
+
+The requested features of the component, if not specified the default entry will be retrieved.
+
+#### Returns
+
+`string`
+
+The instance type matching the criteria if one is registered.
+
+#### Throws
+
+If a matching instance was not found.
+
+#### Implementation of
+
+`IEngineCore.getRegisteredInstanceType`
+
+***
+
+### getRegisteredInstanceTypeOptional()
+
+> **getRegisteredInstanceTypeOptional**(`componentConnectorType`, `features?`): `undefined` \| `string`
+
+Get the registered instance type for the component/connector if it exists.
+
+#### Parameters
+
+##### componentConnectorType
+
+`string`
+
+The type of the component/connector.
+
+##### features?
+
+`string`[]
+
+The requested features of the component, if not specified the default entry will be retrieved.
+
+#### Returns
+
+`undefined` \| `string`
+
+The instance type matching the criteria if one is registered.
 
 #### Implementation of
 
-`IEngineCore.getDefaultTypes`
+`IEngineCore.getRegisteredInstanceTypeOptional`
 
 ***
 

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/docs/reference/interfaces/IEngineCoreOptions.md

@@ -79,17 +79,3 @@ Custom bootstrap method for the engine.
 #### Returns
 
 `Promise`\<`void`\>
-
-***
-
-### loggerTypeName?
-
-> `optional` **loggerTypeName**: `string`
-
-The name of the logger to use in the engine.
-
-#### Default
-
-```ts
-engine
-```

package/locales/en.json

@@ -6,11 +6,15 @@
 			"entityStorageCustomMissing": "Entity storage custom \"{typeCustom}\" missing for component \"{storageName}\"",
 			"entityStorageMissing": "Entity storage configuration missing for component \"{storageName}\"",
 			"bootstrapFailed": "Bootstrap failed for component \"{component}\", please check the logs for more information",
-			"componentStopFailed": "Failed to stop component \"{component}\""
+			"componentStopFailed": "Failed to stop component \"{component}\"",
+			"instanceTypeNotFound": "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,6 +1,6 @@
 {
 	"name": "@twin.org/engine-core",
-	"version": "0.0.2-next.2",
+	"version": "0.0.2-next.20",
 	"description": "Engine core.",
 	"repository": {
 		"type": "git",
@@ -17,10 +17,11 @@
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-core": "next",
-		"@twin.org/engine-models": "0.0.2-next.2",
+		"@twin.org/engine-models": "0.0.2-next.20",
 		"@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"
 	},
@@ -41,5 +42,16 @@
 		"dist/types",
 		"locales",
 		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"engine",
+		"core",
+		"foundation",
+		"utilities"
 	]
 }