@twin.org/engine-models 0.0.3-next.4 → 0.0.3-next.40

package/docs/examples.md

@@ -1 +1,52 @@
-# @twin.org/engine-models - Examples
+# Engine Models Examples
+
+These examples show how to register factories and define strongly typed contracts for core and server integrations.
+
+## EngineCoreFactory and EngineServerFactory
+
+```typescript
+import { EngineCoreFactory, EngineServerFactory } from '@twin.org/engine-models';
+import { EngineCore } from '@twin.org/engine-core';
+import { EngineServer } from '@twin.org/engine-server';
+
+EngineCoreFactory.register(
+  'default',
+  () => new EngineCore({ config: { debug: false, silent: true, types: {} }, skipBootstrap: true })
+);
+EngineServerFactory.register(
+  'default',
+  () => new EngineServer({ engineCore: EngineCoreFactory.get('default') })
+);
+
+const core = EngineCoreFactory.get('default');
+const server = EngineServerFactory.get('default');
+
+console.log(core.isStarted()); // false
+console.log(server.getRestRoutes().length); // 0
+```
+
+## IEngineCoreConfig and IEngineCoreTypeConfig
+
+```typescript
+import type { IEngineCoreConfig, IEngineCoreTypeConfig } from '@twin.org/engine-models';
+
+const loggingConnectorConfig: IEngineCoreTypeConfig<{ config: { prettyPrint: boolean } }> = {
+  type: 'console',
+  isDefault: true,
+  options: {
+    config: {
+      prettyPrint: true
+    }
+  }
+};
+
+const coreConfig: IEngineCoreConfig = {
+  debug: true,
+  silent: false,
+  types: {
+    loggingConnector: [loggingConnectorConfig]
+  }
+};
+
+console.log(coreConfig.types.loggingConnector?.[0].type); // "console"
+```

package/docs/reference/interfaces/EngineTypeInitialiserReturn.md

@@ -1,27 +1,47 @@
-# Interface: EngineTypeInitialiserReturn
+# Interface: EngineTypeInitialiserReturn\<T, F\>
 
 Engine type initialiser return type.
 
+## Type Parameters
+
+### T
+
+`T` *extends* [`IEngineCoreTypeBaseConfig`](IEngineCoreTypeBaseConfig.md) = [`IEngineCoreTypeBaseConfig`](IEngineCoreTypeBaseConfig.md)
+
+### F
+
+`F` = `Factory`\<`unknown`\>
+
 ## Properties
 
-### instanceType?
+### instanceTypeName? {#instancetypename}
 
-> `optional` **instanceType**: `string`
+> `optional` **instanceTypeName?**: `string`
 
 The instance type created.
 
 ***
 
-### factory?
+### factory? {#factory}
 
-> `optional` **factory**: `Factory`\<`unknown`\>
+> `optional` **factory?**: `F`
 
 The factory to store the instance in.
 
 ***
 
-### component?
+### createComponent? {#createcomponent}
+
+> `optional` **createComponent?**: (`additionalConfig`) => `IComponent`
+
+Create a new component.
+
+#### Parameters
+
+##### additionalConfig
+
+`T`
 
-> `optional` **component**: `IComponent`
+#### Returns
 
-The component created.
+`IComponent`

package/docs/reference/interfaces/IEngineCore.md

@@ -14,7 +14,7 @@ Interface describing the engine core methods.
 
 ## Methods
 
-### addTypeInitialiser()
+### addTypeInitialiser() {#addtypeinitialiser}
 
 > **addTypeInitialiser**(`type`, `module`, `method`): `void`
 
@@ -46,9 +46,9 @@ The name of the method to call.
 
 ***
 
-### getTypeConfig()
+### getTypeConfig() {#gettypeconfig}
 
-> **getTypeConfig**(`type`): `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+> **getTypeConfig**(`type`): [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[] \| `undefined`
 
 Get the type config for a specific type.
 
@@ -62,13 +62,13 @@ The type to get the config for.
 
 #### Returns
 
-`undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+[`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[] \| `undefined`
 
 The type config or undefined if not found.
 
 ***
 
-### addContextIdKey()
+### addContextIdKey() {#addcontextidkey}
 
 > **addContextIdKey**(`key`, `componentFeatures`): `void`
 
@@ -94,7 +94,7 @@ The component features for the context ID handler.
 
 ***
 
-### getContextIdKeys()
+### getContextIdKeys() {#getcontextidkeys}
 
 > **getContextIdKeys**(): `string`[]
 
@@ -108,7 +108,7 @@ The context IDs keys.
 
 ***
 
-### addContextId()
+### addContextId() {#addcontextid}
 
 > **addContextId**(`key`, `value`): `void`
 
@@ -134,35 +134,43 @@ 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.
 
 ***
 
-### 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.
+Nothing.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 
@@ -176,7 +184,7 @@ Nothing.
 
 ***
 
-### isStarted()
+### isStarted() {#isstarted}
 
 > **isStarted**(): `boolean`
 
@@ -190,7 +198,7 @@ True if the engine is started.
 
 ***
 
-### isPrimary()
+### isPrimary() {#isprimary}
 
 > **isPrimary**(): `boolean`
 
@@ -204,7 +212,7 @@ True if the engine is the primary instance.
 
 ***
 
-### isClone()
+### isClone() {#isclone}
 
 > **isClone**(): `boolean`
 
@@ -218,7 +226,7 @@ True if the engine instance is a clone.
 
 ***
 
-### logInfo()
+### logInfo() {#loginfo}
 
 > **logInfo**(`message`): `void`
 
@@ -238,7 +246,7 @@ The message to log.
 
 ***
 
-### logError()
+### logError() {#logerror}
 
 > **logError**(`error`): `void`
 
@@ -258,7 +266,7 @@ The error to log.
 
 ***
 
-### getConfig()
+### getConfig() {#getconfig}
 
 > **getConfig**(): `C`
 
@@ -272,7 +280,7 @@ The config for the engine.
 
 ***
 
-### getState()
+### getState() {#getstate}
 
 > **getState**(): `S`
 
@@ -286,7 +294,19 @@ The state of the engine.
 
 ***
 
-### getRegisteredInstances()
+### setStateDirty() {#setstatedirty}
+
+> **setStateDirty**(): `void`
+
+Set the state to dirty so it gets saved.
+
+#### Returns
+
+`void`
+
+***
+
+### getRegisteredInstances() {#getregisteredinstances}
 
 > **getRegisteredInstances**(): `object`
 
@@ -300,7 +320,7 @@ The registered instances.
 
 ***
 
-### getRegisteredInstanceType()
+### getRegisteredInstanceType() {#getregisteredinstancetype}
 
 > **getRegisteredInstanceType**(`componentConnectorType`, `features?`): `string`
 
@@ -332,9 +352,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.
 
@@ -354,13 +374,55 @@ 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.
 
 ***
 
-### getCloneData()
+### getRegisteredComponents() {#getregisteredcomponents}
+
+> **getRegisteredComponents**(): `Promise`\<`object`[]\>
+
+Get the registered components.
+
+#### Returns
+
+`Promise`\<`object`[]\>
+
+The registered components.
+
+***
+
+### 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`\>
+
+Nothing.
+
+***
+
+### getCloneData() {#getclonedata}
 
 > **getCloneData**(): [`IEngineCoreClone`](IEngineCoreClone.md)\<`C`, `S`\>
 
@@ -374,9 +436,9 @@ The clone data.
 
 ***
 
-### populateClone()
+### populateClone() {#populateclone}
 
-> **populateClone**(`cloneData`, `silent?`): `void`
+> **populateClone**(`cloneData`, `contextIds?`, `silent?`): `void`
 
 Populate the engine from the clone data.
 
@@ -388,6 +450,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/interfaces/IEngineCoreClone.md

@@ -14,7 +14,7 @@ Interface describing the data required to clone an engine.
 
 ## Properties
 
-### config
+### config {#config}
 
 > **config**: `C`
 
@@ -22,7 +22,7 @@ The config for the engine.
 
 ***
 
-### state
+### state {#state}
 
 > **state**: `S`
 
@@ -30,7 +30,7 @@ The state of the engine.
 
 ***
 
-### typeInitialisers
+### typeInitialisers {#typeinitialisers}
 
 > **typeInitialisers**: `object`[]
 
@@ -50,7 +50,7 @@ The type initialisers for the engine.
 
 ***
 
-### entitySchemas
+### entitySchemas {#entityschemas}
 
 > **entitySchemas**: `object`
 
@@ -62,7 +62,7 @@ The entity schemas for the engine.
 
 ***
 
-### contextIdKeys
+### contextIdKeys {#contextidkeys}
 
 > **contextIdKeys**: `object`[]
 

package/docs/reference/interfaces/IEngineCoreConfig.md

@@ -4,9 +4,9 @@ Configuration for the engine core.
 
 ## Properties
 
-### debug?
+### debug? {#debug}
 
-> `optional` **debug**: `boolean`
+> `optional` **debug?**: `boolean`
 
 Start the engine in debug mode.
 
@@ -18,9 +18,9 @@ false
 
 ***
 
-### silent?
+### silent? {#silent}
 
-> `optional` **silent**: `boolean`
+> `optional` **silent?**: `boolean`
 
 Disable output to the console.
 
@@ -32,7 +32,7 @@ false
 
 ***
 
-### types
+### types {#types}
 
 > **types**: `object`
 
@@ -40,4 +40,4 @@ The types to initialise in the engine.
 
 #### Index Signature
 
-\[`type`: `string`\]: `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+\[`type`: `string`\]: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[] \| `undefined`

package/docs/reference/interfaces/IEngineCoreContext.md

@@ -14,7 +14,7 @@ The context for the engine core.
 
 ## Properties
 
-### config
+### config {#config}
 
 > **config**: `C`
 
@@ -22,7 +22,7 @@ The engine core config.
 
 ***
 
-### state
+### state {#state}
 
 > **state**: `S`
 
@@ -30,7 +30,7 @@ The engine core state.
 
 ***
 
-### stateDirty
+### stateDirty {#statedirty}
 
 > **stateDirty**: `boolean`
 
@@ -38,7 +38,7 @@ The state dirty flag, which flags that the state needs saving.
 
 ***
 
-### registeredInstances
+### registeredInstances {#registeredinstances}
 
 > **registeredInstances**: `object`
 
@@ -51,7 +51,7 @@ The default entry will be the first in the list.
 
 ***
 
-### componentInstances
+### componentInstances {#componentinstances}
 
 > **componentInstances**: `object`[]
 

package/docs/reference/interfaces/IEngineCoreTypeBaseConfig.md

@@ -10,7 +10,7 @@ Configuration for the engine core type base.
 
 ## Properties
 
-### type
+### type {#type}
 
 > **type**: `string`
 
@@ -18,8 +18,8 @@ The type of the instance.
 
 ***
 
-### options?
+### options? {#options}
 
-> `optional` **options**: `T`
+> `optional` **options?**: `T`
 
 The options for the instance.

package/docs/reference/interfaces/IEngineModuleConfig.md

@@ -4,7 +4,7 @@ Configuration for an engine module.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -12,7 +12,7 @@ The unique identifier for the module.
 
 ***
 
-### moduleName
+### moduleName {#modulename}
 
 > **moduleName**: `string`
 
@@ -20,7 +20,7 @@ The module that implements the additional component.
 
 ***
 
-### className
+### className {#classname}
 
 > **className**: `string`
 
@@ -28,9 +28,9 @@ The class name of the additional component.
 
 ***
 
-### dependencies?
+### dependencies? {#dependencies}
 
-> `optional` **dependencies**: `object`[]
+> `optional` **dependencies?**: `object`[]
 
 Additional dependencies required by the component.
 
@@ -44,16 +44,16 @@ Additional dependencies required by the component.
 
 #### features?
 
-> `optional` **features**: `string`[]
+> `optional` **features?**: `string`[]
 
 #### isOptional?
 
-> `optional` **isOptional**: `boolean`
+> `optional` **isOptional?**: `boolean`
 
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: `unknown`
+> `optional` **config?**: `unknown`
 
 Additional configuration for the component.

package/docs/reference/interfaces/IEngineServer.md

@@ -4,7 +4,7 @@ Interface describing the engine server methods.
 
 ## Methods
 
-### addRestRouteGenerator()
+### addRestRouteGenerator() {#addrestroutegenerator}
 
 > **addRestRouteGenerator**(`type`, `module`, `method`): `void`
 
@@ -36,7 +36,7 @@ The method to call on the module.
 
 ***
 
-### addSocketRouteGenerator()
+### addSocketRouteGenerator() {#addsocketroutegenerator}
 
 > **addSocketRouteGenerator**(`type`, `module`, `method`): `void`
 
@@ -68,21 +68,21 @@ The method to call on the module.
 
 ***
 
-### start()
+### start() {#start}
 
-> **start**(): `Promise`\<`boolean`\>
+> **start**(): `Promise`\<`void`\>
 
 Start the engine server.
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`Promise`\<`void`\>
 
-True if the start was successful.
+Nothing.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IEngineStateStorage.md

@@ -10,9 +10,9 @@ Definition of state storage for engine.
 
 ## Methods
 
-### load()
+### load() {#load}
 
-> **load**(`engineCore`): `Promise`\<`undefined` \| `S`\>
+> **load**(`engineCore`): `Promise`\<`S` \| `undefined`\>
 
 Method for loading the state.
 
@@ -26,13 +26,13 @@ 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.
 
 ***
 
-### save()
+### save() {#save}
 
 > **save**(`engineCore`, `state`): `Promise`\<`void`\>
 

package/docs/reference/type-aliases/EngineTypeInitialiser.md

@@ -1,6 +1,6 @@
-# Type Alias: EngineTypeInitialiser()\<T\>
+# Type Alias: EngineTypeInitialiser\<T, F\>
 
-> **EngineTypeInitialiser**\<`T`\> = (`engineCore`, `context`, `instanceConfig`) => `Promise`\<[`EngineTypeInitialiserReturn`](../interfaces/EngineTypeInitialiserReturn.md)\>
+> **EngineTypeInitialiser**\<`T`, `F`\> = (`engineCore`, `context`, `instanceConfig`) => [`EngineTypeInitialiserReturn`](../interfaces/EngineTypeInitialiserReturn.md)\<`T`, `F`\>
 
 Method definition for the engine type initialiser.
 
@@ -10,6 +10,10 @@ Method definition for the engine type initialiser.
 
 `T` *extends* [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md) = [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md)
 
+### F
+
+`F` = `Factory`\<`unknown`\>
+
 ## Parameters
 
 ### engineCore
@@ -26,4 +30,4 @@ Method definition for the engine type initialiser.
 
 ## Returns
 
-`Promise`\<[`EngineTypeInitialiserReturn`](../interfaces/EngineTypeInitialiserReturn.md)\>
+[`EngineTypeInitialiserReturn`](../interfaces/EngineTypeInitialiserReturn.md)\<`T`, `F`\>