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

package/docs/changelog.md

@@ -1,5 +1,295 @@
 # @twin.org/engine-core - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.3-next.1...engine-core-v0.0.3-next.2) (2025-11-13)
+
+
+### Features
+
+* close already started components on startup error ([a55a117](https://github.com/twinfoundation/engine/commit/a55a117a508998288c8ae804e732fc6085cb22fa))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.3-next.0...engine-core-v0.0.3-next.1) (2025-11-13)
+
+
+### Features
+
+* add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
+* add context id features ([#51](https://github.com/twinfoundation/engine/issues/51)) ([eaef180](https://github.com/twinfoundation/engine/commit/eaef1807397a907bc7655ef1545a151a710ca2f1))
+* add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
+* add isPrimary and isClone methods ([a7c63e9](https://github.com/twinfoundation/engine/commit/a7c63e97f54c95b104cc81e66d3fa42c6607bdc1))
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
+* add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
+* add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
+* eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
+* maintain isDefault flag for registered instances ([2ac5bee](https://github.com/twinfoundation/engine/commit/2ac5bee094bef42b396cc82b0d18bb6aebe27352))
+* override type initialisers with new registrations ([5b4ff56](https://github.com/twinfoundation/engine/commit/5b4ff561d06b6513c870a72bb20ba23c0653cfe8))
+* remove bootstrapped components, component should manage their own state ([5c7e9e4](https://github.com/twinfoundation/engine/commit/5c7e9e419ef26933e49c9c5a21a20a8961244e7f))
+* remove unused component states ([d56d648](https://github.com/twinfoundation/engine/commit/d56d6486119ea8b8501a33f9e3a3101a08b826ed))
+* simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
+* standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
+* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
+* use peer dependencies ([69dd744](https://github.com/twinfoundation/engine/commit/69dd7449010b8e6f5f35e7fad201ad4c1cab400c))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+
+### Bug Fixes
+
+* use correct instance type name ([6278486](https://github.com/twinfoundation/engine/commit/6278486d8f0f2d601d3cf521a647898cd7cc1f31))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.26](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.25...engine-core-v0.0.2-next.26) (2025-10-09)
+
+
+### Bug Fixes
+
+* use correct instance type name ([6278486](https://github.com/twinfoundation/engine/commit/6278486d8f0f2d601d3cf521a647898cd7cc1f31))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.25 to 0.0.2-next.26
+
+## [0.0.2-next.25](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.24...engine-core-v0.0.2-next.25) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.24 to 0.0.2-next.25
+
+## [0.0.2-next.24](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.23...engine-core-v0.0.2-next.24) (2025-10-08)
+
+
+### Features
+
+* maintain isDefault flag for registered instances ([2ac5bee](https://github.com/twinfoundation/engine/commit/2ac5bee094bef42b396cc82b0d18bb6aebe27352))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.23 to 0.0.2-next.24
+
+## [0.0.2-next.23](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.22...engine-core-v0.0.2-next.23) (2025-10-07)
+
+
+### Features
+
+* override type initialisers with new registrations ([5b4ff56](https://github.com/twinfoundation/engine/commit/5b4ff561d06b6513c870a72bb20ba23c0653cfe8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.22 to 0.0.2-next.23
+
+## [0.0.2-next.22](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.21...engine-core-v0.0.2-next.22) (2025-10-07)
+
+
+### 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.21 to 0.0.2-next.22
+
+## [0.0.2-next.21](https://github.com/twinfoundation/engine/compare/engine-core-v0.0.2-next.20...engine-core-v0.0.2-next.21) (2025-10-07)
+
+
+### Features
+
+* use peer dependencies ([69dd744](https://github.com/twinfoundation/engine/commit/69dd7449010b8e6f5f35e7fad201ad4c1cab400c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.20 to 0.0.2-next.21
+
+## [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)
 
 

package/docs/reference/classes/EngineCore.md

@@ -38,11 +38,27 @@ The options for the engine.
 
 ## Properties
 
-### LOGGER\_TYPE\_NAME
+### LOGGING\_COMPONENT\_TYPE\_NAME
 
-> `readonly` `static` **LOGGER\_TYPE\_NAME**: `string` = `"engine"`
+> `readonly` `static` **LOGGING\_COMPONENT\_TYPE\_NAME**: `string` = `"engine-logging-service"`
 
-Name for the engine logger.
+Name for the engine logger component, used for direct console logging.
+
+***
+
+### LOGGING\_CONNECTOR\_TYPE\_NAME
+
+> `readonly` `static` **LOGGING\_CONNECTOR\_TYPE\_NAME**: `string` = `"engine-logging-connector"`
+
+Name for the engine logger connector, used for direct console logging.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
 
 ***
 
@@ -52,11 +68,27 @@ Name for the engine logger.
 
 The core context.
 
+***
+
+### \_contextIdKeys
+
+> `protected` `readonly` **\_contextIdKeys**: `string`[]
+
+The context ID keys.
+
+***
+
+### \_contextIds?
+
+> `protected` `optional` **\_contextIds**: `IContextIds`
+
+The context IDs.
+
 ## Methods
 
 ### addTypeInitialiser()
 
-> **addTypeInitialiser**(`type`, `typeConfig`, `module`, `method`): `void`
+> **addTypeInitialiser**(`type`, `module`, `method`): `void`
 
 Add a type initialiser.
 
@@ -68,12 +100,6 @@ Add a type initialiser.
 
 The type to add the initialiser for.
 
-##### typeConfig
-
-The type config.
-
-`undefined` | `IEngineCoreTypeConfig`[]
-
 ##### module
 
 `string`
@@ -96,6 +122,122 @@ 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`
+
+***
+
+### addContextIdKey()
+
+> **addContextIdKey**(`key`): `void`
+
+Add a context ID key to the engine.
+
+#### Parameters
+
+##### key
+
+`string`
+
+The context ID key.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IEngineCore.addContextIdKey`
+
+***
+
+### getContextIdKeys()
+
+> **getContextIdKeys**(): `string`[]
+
+Get the context ID keys for the engine.
+
+#### Returns
+
+`string`[]
+
+The context IDs keys.
+
+#### Implementation of
+
+`IEngineCore.getContextIdKeys`
+
+***
+
+### addContextId()
+
+> **addContextId**(`key`, `value`): `void`
+
+Add a context ID to the engine.
+
+#### Parameters
+
+##### key
+
+`string`
+
+The context ID key.
+
+##### value
+
+`string`
+
+The context ID value.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IEngineCore.addContextId`
+
+***
+
+### getContextIds()
+
+> **getContextIds**(): `undefined` \| `IContextIds`
+
+Get the context IDs for the engine.
+
+#### Returns
+
+`undefined` \| `IContextIds`
+
+The context IDs or undefined if none are set.
+
+#### Implementation of
+
+`IEngineCore.getContextIds`
+
+***
+
 ### start()
 
 > **start**(): `Promise`\<`boolean`\>
@@ -188,7 +330,7 @@ True if the engine instance is a clone.
 
 ### logInfo()
 
-> **logInfo**(`message`): `void`
+> **logInfo**(`message`): `Promise`\<`void`\>
 
 Log info.
 
@@ -202,7 +344,7 @@ The message to log.
 
 #### Returns
 
-`void`
+`Promise`\<`void`\>
 
 #### Implementation of
 
@@ -212,7 +354,7 @@ The message to log.
 
 ### logError()
 
-> **logError**(`error`): `void`
+> **logError**(`error`): `Promise`\<`void`\>
 
 Log error.
 
@@ -226,7 +368,7 @@ The error to log.
 
 #### Returns
 
-`void`
+`Promise`\<`void`\>
 
 #### Implementation of
 

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/classes/FileStateStorage.md

@@ -42,7 +42,7 @@ Whether the file is in read-only mode.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 

package/docs/reference/classes/MemoryStateStorage.md

@@ -42,7 +42,7 @@ The initial state.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 

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

@@ -1,17 +1,18 @@
 {
 	"error": {
 		"engineCore": {
-			"connectorUnknownType": "Unknown connector type \"{type}\" specified for \"{connectorType}\"",
 			"componentUnknownType": "Unknown component type \"{type}\" specified for \"{componentType}\"",
-			"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}\"",
+			"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}\""
 		},
 		"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": {
@@ -20,17 +21,16 @@
 		"started": "Engine has started",
 		"stopping": "Engine is stopping",
 		"stopped": "Engine has stopped",
-		"configuring": "Configuring {element}",
-		"configuringEntityStorage": "Configuring {element} with name \"{storageName}\" using \"{storageType}\" connector",
+		"configuring": "Configuring component type \"{componentType}\" with configuration type \"{configType}\"",
 		"bootstrapStarted": "Bootstrap started",
 		"bootstrapComplete": "Bootstrap complete",
-		"bootstrapping": "Bootstrap {element}",
+		"bootstrapping": "Bootstrapping component type \"{className}\" with instance type \"{instanceType}\"",
 		"componentsStarting": "Components are starting",
 		"componentsComplete": "Components have started",
 		"componentsStopping": "Components are stopping",
 		"componentsStopped": "Components have stopped",
-		"componentStarting": "Starting {element}",
-		"componentStopping": "Stopping {element}"
+		"componentStarting": "Starting component type \"{className}\" with instance type \"{instanceType}\"",
+		"componentStopping": "Stopping component type \"{className}\" with instance type \"{instanceType}\""
 	},
 	"fileStateStorage": {
 		"loading": "Loading state from file storage with filename \"{filename}\"",