@twin.org/engine-core 0.0.3-next.5 → 0.0.3-next.51

package/docs/examples.md

@@ -1 +1,156 @@
-# @twin.org/engine-core - Examples
+# Engine Core Examples
+
+These examples focus on common runtime patterns such as lifecycle control, cloning, state storage, and module loading.
+
+## EngineCore
+
+```typescript
+import { EngineCore, MemoryStateStorage } from '@twin.org/engine-core';
+import type { IEngineCoreConfig, IEngineState } from '@twin.org/engine-models';
+
+interface AppState extends IEngineState {
+  runCount?: number;
+}
+
+const config: IEngineCoreConfig = {
+  debug: true,
+  silent: false,
+  types: {}
+};
+
+const stateStorage = new MemoryStateStorage<AppState>();
+const engineCore = new EngineCore<IEngineCoreConfig, AppState>({
+  config,
+  stateStorage,
+  skipBootstrap: true
+});
+
+engineCore.addTypeInitialiser('loggingConnector', '@twin.org/engine-types', 'initLoggingConnector');
+console.log(engineCore.getTypeConfig('loggingConnector')?.length ?? 0); // 0
+
+engineCore.addContextIdKey('tenant', ['tenant']);
+engineCore.addContextId('tenant', 'tenant-a');
+
+console.log(engineCore.getContextIdKeys()); // ["tenant"]
+console.log(engineCore.getContextIds()); // { tenant: "tenant-a" }
+console.log(engineCore.isPrimary()); // true
+console.log(engineCore.isClone()); // false
+console.log(engineCore.isStarted()); // false
+
+await engineCore.start(true);
+console.log(engineCore.isStarted()); // true
+
+await engineCore.logInfo('Engine started for tenant-a');
+
+const state = engineCore.getState();
+state.runCount = (state.runCount ?? 0) + 1;
+engineCore.setStateDirty();
+
+console.log(engineCore.getConfig().debug); // true
+console.log(engineCore.getRegisteredInstances()); // { loggingConnector: [...], loggingComponent: [...] }
+console.log(engineCore.getRegisteredInstanceType('loggingComponent')); // "engine-logging-service"
+console.log(engineCore.getRegisteredInstanceTypeOptional('hostingComponent')); // undefined
+
+await engineCore.stop();
+console.log(engineCore.isStarted()); // false
+```
+
+```typescript
+import { BaseError, GeneralError } from '@twin.org/core';
+import { EngineCore } from '@twin.org/engine-core';
+
+const engineCore = new EngineCore({
+  config: { debug: false, silent: true, types: {} },
+  skipBootstrap: true
+});
+
+const wrapped = new GeneralError(
+  EngineCore.CLASS_NAME,
+  'sampleFailure',
+  { area: 'examples' },
+  BaseError.fromError(new Error('Sample failure'))
+);
+await engineCore.logError(wrapped);
+```
+
+```typescript
+import { EngineCore } from '@twin.org/engine-core';
+
+const primary = new EngineCore({
+  config: { debug: false, silent: true, types: {} },
+  skipBootstrap: true
+});
+primary.addContextIdKey('node', ['node']);
+
+const cloneData = primary.getCloneData();
+
+const clone = new EngineCore({ config: { debug: false, silent: true, types: {} } });
+clone.populateClone(cloneData, { node: 'node-1', tenant: 'tenant-a' }, true);
+
+console.log(clone.isClone()); // true
+console.log(clone.getContextIds()); // { node: "node-1", tenant: "tenant-a" }
+```
+
+## FileStateStorage
+
+```typescript
+import { EngineCore, FileStateStorage } from '@twin.org/engine-core';
+
+const engineCore = new EngineCore({
+  config: { debug: false, silent: true, types: {} },
+  skipBootstrap: true
+});
+const fileStorage = new FileStateStorage('./data/engine-state.json');
+
+await fileStorage.save(engineCore, { ready: true });
+
+const loaded = await fileStorage.load(engineCore);
+console.log(loaded); // { ready: true }
+```
+
+## MemoryStateStorage
+
+```typescript
+import { EngineCore, MemoryStateStorage } from '@twin.org/engine-core';
+
+const engineCore = new EngineCore({
+  config: { debug: false, silent: true, types: {} },
+  skipBootstrap: true
+});
+const memoryStorage = new MemoryStateStorage(false, { retries: 1 });
+
+console.log(await memoryStorage.load(engineCore)); // { retries: 1 }
+
+await memoryStorage.save(engineCore, { retries: 2 });
+console.log(await memoryStorage.load(engineCore)); // { retries: 2 }
+```
+
+## EngineModuleHelper
+
+```typescript
+import { EngineCore, EngineModuleHelper } from '@twin.org/engine-core';
+import type { IEngineModuleConfig } from '@twin.org/engine-models';
+
+const engineCore = new EngineCore({
+  config: { debug: false, silent: true, types: {} },
+  skipBootstrap: true
+});
+
+const moduleConfig: IEngineModuleConfig = {
+  moduleName: '@twin.org/logging-service',
+  className: 'LoggingService',
+  dependencies: [
+    {
+      propertyName: 'loggingConnectorType',
+      componentName: 'loggingConnector',
+      isOptional: false
+    }
+  ],
+  config: {
+    level: 'info'
+  }
+};
+
+const component = await EngineModuleHelper.loadComponent<unknown>(engineCore, moduleConfig);
+console.log(component !== undefined); // true
+```

package/docs/reference/classes/EngineCore.md

@@ -38,7 +38,7 @@ The options for the engine.
 
 ## Properties
 
-### LOGGING\_COMPONENT\_TYPE\_NAME
+### LOGGING\_COMPONENT\_TYPE\_NAME {#logging_component_type_name}
 
 > `readonly` `static` **LOGGING\_COMPONENT\_TYPE\_NAME**: `string` = `"engine-logging-service"`
 
@@ -46,7 +46,7 @@ Name for the engine logger component, used for direct console logging.
 
 ***
 
-### LOGGING\_CONNECTOR\_TYPE\_NAME
+### LOGGING\_CONNECTOR\_TYPE\_NAME {#logging_connector_type_name}
 
 > `readonly` `static` **LOGGING\_CONNECTOR\_TYPE\_NAME**: `string` = `"engine-logging-connector"`
 
@@ -54,7 +54,7 @@ Name for the engine logger connector, used for direct console logging.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -62,7 +62,7 @@ Runtime name for the class.
 
 ***
 
-### \_context
+### \_context {#_context}
 
 > `protected` **\_context**: `IEngineCoreContext`\<`C`, `S`\>
 
@@ -70,7 +70,7 @@ The core context.
 
 ***
 
-### \_contextIdKeys
+### \_contextIdKeys {#_contextidkeys}
 
 > `protected` `readonly` **\_contextIdKeys**: `object`[]
 
@@ -86,15 +86,15 @@ The context ID keys.
 
 ***
 
-### \_contextIds?
+### \_contextIds? {#_contextids}
 
-> `protected` `optional` **\_contextIds**: `IContextIds`
+> `protected` `optional` **\_contextIds?**: `IContextIds`
 
 The context IDs.
 
 ## Methods
 
-### addTypeInitialiser()
+### addTypeInitialiser() {#addtypeinitialiser}
 
 > **addTypeInitialiser**(`type`, `module`, `method`): `void`
 
@@ -130,9 +130,9 @@ The name of the method to call.
 
 ***
 
-### getTypeConfig()
+### getTypeConfig() {#gettypeconfig}
 
-> **getTypeConfig**(`type`): `undefined` \| `IEngineCoreTypeConfig`[]
+> **getTypeConfig**(`type`): `IEngineCoreTypeConfig`[] \| `undefined`
 
 Get the type config for a specific type.
 
@@ -146,7 +146,7 @@ The type to get the config for.
 
 #### Returns
 
-`undefined` \| `IEngineCoreTypeConfig`[]
+`IEngineCoreTypeConfig`[] \| `undefined`
 
 The type config or undefined if not found.
 
@@ -156,7 +156,7 @@ The type config or undefined if not found.
 
 ***
 
-### addContextIdKey()
+### addContextIdKey() {#addcontextidkey}
 
 > **addContextIdKey**(`key`, `componentFeatures`): `void`
 
@@ -186,7 +186,7 @@ The component features for the context ID handler.
 
 ***
 
-### getContextIdKeys()
+### getContextIdKeys() {#getcontextidkeys}
 
 > **getContextIdKeys**(): `string`[]
 
@@ -204,7 +204,7 @@ The context IDs keys.
 
 ***
 
-### addContextId()
+### addContextId() {#addcontextid}
 
 > **addContextId**(`key`, `value`): `void`
 
@@ -234,15 +234,15 @@ The context ID value.
 
 ***
 
-### getContextIds()
+### getContextIds() {#getcontextids}
 
-> **getContextIds**(): `undefined` \| `IContextIds`
+> **getContextIds**(): `IContextIds` \| `undefined`
 
 Get the context IDs for the engine.
 
 #### Returns
 
-`undefined` \| `IContextIds`
+`IContextIds` \| `undefined`
 
 The context IDs or undefined if none are set.
 
@@ -252,17 +252,25 @@ The context IDs or undefined if none are set.
 
 ***
 
-### start()
+### start() {#start}
 
-> **start**(): `Promise`\<`boolean`\>
+> **start**(`skipComponentStart?`): `Promise`\<`void`\>
 
 Start the engine core.
 
+#### Parameters
+
+##### skipComponentStart?
+
+`boolean`
+
+Should the component start be skipped.
+
 #### Returns
 
-`Promise`\<`boolean`\>
+`Promise`\<`void`\>
 
-True if the start was successful.
+A promise that resolves when the engine and all components have started.
 
 #### Implementation of
 
@@ -270,7 +278,7 @@ True if the start was successful.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 
@@ -280,7 +288,7 @@ Stop the engine core.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when all components have stopped and state has been saved.
 
 #### Implementation of
 
@@ -288,7 +296,7 @@ Nothing.
 
 ***
 
-### isStarted()
+### isStarted() {#isstarted}
 
 > **isStarted**(): `boolean`
 
@@ -306,7 +314,7 @@ True if the engine is started.
 
 ***
 
-### isPrimary()
+### isPrimary() {#isprimary}
 
 > **isPrimary**(): `boolean`
 
@@ -324,7 +332,7 @@ True if the engine is the primary instance.
 
 ***
 
-### isClone()
+### isClone() {#isclone}
 
 > **isClone**(): `boolean`
 
@@ -342,7 +350,7 @@ True if the engine instance is a clone.
 
 ***
 
-### logInfo()
+### logInfo() {#loginfo}
 
 > **logInfo**(`message`): `Promise`\<`void`\>
 
@@ -360,13 +368,15 @@ The message to log.
 
 `Promise`\<`void`\>
 
+A promise that resolves when the message has been logged.
+
 #### Implementation of
 
 `IEngineCore.logInfo`
 
 ***
 
-### logError()
+### logError() {#logerror}
 
 > **logError**(`error`): `Promise`\<`void`\>
 
@@ -384,13 +394,15 @@ The error to log.
 
 `Promise`\<`void`\>
 
+A promise that resolves when the error has been logged.
+
 #### Implementation of
 
 `IEngineCore.logError`
 
 ***
 
-### getConfig()
+### getConfig() {#getconfig}
 
 > **getConfig**(): `C`
 
@@ -408,7 +420,7 @@ The config for the engine.
 
 ***
 
-### getState()
+### getState() {#getstate}
 
 > **getState**(): `S`
 
@@ -426,7 +438,23 @@ The state of the engine.
 
 ***
 
-### getRegisteredInstances()
+### setStateDirty() {#setstatedirty}
+
+> **setStateDirty**(): `void`
+
+Set the state to dirty so it gets saved.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IEngineCore.setStateDirty`
+
+***
+
+### getRegisteredInstances() {#getregisteredinstances}
 
 > **getRegisteredInstances**(): `object`
 
@@ -444,7 +472,7 @@ The registered instances.
 
 ***
 
-### getRegisteredInstanceType()
+### getRegisteredInstanceType() {#getregisteredinstancetype}
 
 > **getRegisteredInstanceType**(`componentConnectorType`, `features?`): `string`
 
@@ -480,9 +508,9 @@ If a matching instance was not found.
 
 ***
 
-### getRegisteredInstanceTypeOptional()
+### getRegisteredInstanceTypeOptional() {#getregisteredinstancetypeoptional}
 
-> **getRegisteredInstanceTypeOptional**(`componentConnectorType`, `features?`): `undefined` \| `string`
+> **getRegisteredInstanceTypeOptional**(`componentConnectorType`, `features?`): `string` \| `undefined`
 
 Get the registered instance type for the component/connector if it exists.
 
@@ -502,7 +530,7 @@ The requested features of the component, if not specified the default entry will
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The instance type matching the criteria if one is registered.
 
@@ -512,7 +540,83 @@ The instance type matching the criteria if one is registered.
 
 ***
 
-### getCloneData()
+### getRegisteredLoggerType() {#getregisteredloggertype}
+
+> **getRegisteredLoggerType**(`componentName`): `string` \| `undefined`
+
+Get the registered logger for the component/connector.
+
+#### Parameters
+
+##### componentName
+
+`string`
+
+The name of the component to get the logger for.
+
+#### Returns
+
+`string` \| `undefined`
+
+The logger type name if one is registered and not silenced.
+
+#### Implementation of
+
+`IEngineCore.getRegisteredLoggerType`
+
+***
+
+### getRegisteredComponents() {#getregisteredcomponents}
+
+> **getRegisteredComponents**(): `Promise`\<`object`[]\>
+
+Get the registered components.
+
+#### Returns
+
+`Promise`\<`object`[]\>
+
+The registered components.
+
+#### Implementation of
+
+`IEngineCore.getRegisteredComponents`
+
+***
+
+### addRegisteredComponent() {#addregisteredcomponent}
+
+> **addRegisteredComponent**(`instanceType`, `component`): `Promise`\<`void`\>
+
+Add a registered component to the engine.
+
+#### Parameters
+
+##### instanceType
+
+`string`
+
+The instance type to register the component under.
+
+##### component
+
+`IComponent`
+
+The component to register.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the component has been registered.
+
+#### Implementation of
+
+`IEngineCore.addRegisteredComponent`
+
+***
+
+### getCloneData() {#getclonedata}
 
 > **getCloneData**(): `IEngineCoreClone`\<`C`, `S`\>
 
@@ -530,9 +634,9 @@ The clone data.
 
 ***
 
-### populateClone()
+### populateClone() {#populateclone}
 
-> **populateClone**(`cloneData`, `silent?`): `void`
+> **populateClone**(`cloneData`, `contextIds?`, `silent?`): `void`
 
 Populate the engine from the clone data.
 
@@ -544,6 +648,12 @@ Populate the engine from the clone data.
 
 The clone data to populate from.
 
+##### contextIds?
+
+`IContextIds`
+
+The context IDs to use for the clone.
+
 ##### silent?
 
 `boolean`

package/docs/reference/classes/FileStateStorage.md

@@ -16,7 +16,7 @@ Store state in a file.
 
 ### Constructor
 
-> **new FileStateStorage**\<`S`\>(`filename`, `readonlyMode`): `FileStateStorage`\<`S`\>
+> **new FileStateStorage**\<`S`\>(`filename`, `readonlyMode?`): `FileStateStorage`\<`S`\>
 
 Create a new instance of FileStateStorage.
 
@@ -28,7 +28,7 @@ Create a new instance of FileStateStorage.
 
 The filename to store the state.
 
-##### readonlyMode
+##### readonlyMode?
 
 `boolean` = `false`
 
@@ -40,7 +40,7 @@ Whether the file is in read-only mode.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -48,9 +48,9 @@ Runtime name for the class.
 
 ## Methods
 
-### load()
+### load() {#load}
 
-> **load**(`engineCore`): `Promise`\<`undefined` \| `S`\>
+> **load**(`engineCore`): `Promise`\<`S` \| `undefined`\>
 
 Method for loading the state.
 
@@ -64,7 +64,7 @@ The engine core to load the state for.
 
 #### Returns
 
-`Promise`\<`undefined` \| `S`\>
+`Promise`\<`S` \| `undefined`\>
 
 The state of the engine or undefined if it doesn't exist.
 
@@ -74,7 +74,7 @@ The state of the engine or undefined if it doesn't exist.
 
 ***
 
-### save()
+### save() {#save}
 
 > **save**(`engineCore`, `state`): `Promise`\<`void`\>
 
@@ -98,7 +98,7 @@ The state of the engine to save.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the state has been written to disk.
 
 #### Implementation of
 

package/docs/reference/classes/MemoryStateStorage.md

@@ -16,13 +16,13 @@ Store state in memory.
 
 ### Constructor
 
-> **new MemoryStateStorage**\<`S`\>(`readonlyMode`, `state?`): `MemoryStateStorage`\<`S`\>
+> **new MemoryStateStorage**\<`S`\>(`readonlyMode?`, `state?`): `MemoryStateStorage`\<`S`\>
 
 Create a new instance of MemoryStateStorage.
 
 #### Parameters
 
-##### readonlyMode
+##### readonlyMode?
 
 `boolean` = `false`
 
@@ -40,7 +40,7 @@ The initial state.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -48,9 +48,9 @@ Runtime name for the class.
 
 ## Methods
 
-### load()
+### load() {#load}
 
-> **load**(`engineCore`): `Promise`\<`undefined` \| `S`\>
+> **load**(`engineCore`): `Promise`\<`S` \| `undefined`\>
 
 Method for loading the state.
 
@@ -64,7 +64,7 @@ The engine core to load the state for.
 
 #### Returns
 
-`Promise`\<`undefined` \| `S`\>
+`Promise`\<`S` \| `undefined`\>
 
 The state of the engine or undefined if it doesn't exist.
 
@@ -74,7 +74,7 @@ The state of the engine or undefined if it doesn't exist.
 
 ***
 
-### save()
+### save() {#save}
 
 > **save**(`engineCore`, `state`): `Promise`\<`void`\>
 
@@ -98,7 +98,7 @@ The state of the engine to save.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the state has been stored in memory.
 
 #### Implementation of
 

package/docs/reference/index.md

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