@twin.org/engine-models 0.0.3-next.26 → 0.0.3-next.27

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Engine Models
 
-Models which define the structure of the engine.
+Engine Models defines shared contracts and factories used to compose runtime behaviour across the repository. It provides stable interfaces for core and server implementations so packages can interoperate with a clear and predictable structure.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,11 @@
-# @twin.org/engine-models - Changelog
+# Changelog
+
+## [0.0.3-next.27](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.26...engine-models-v0.0.3-next.27) (2026-03-20)
+
+
+### Features
+
+* update dependencies ([e6ebe42](https://github.com/twinfoundation/engine/commit/e6ebe42b9d61066227ad8b45dae14c8f8615b760))
 
 ## [0.0.3-next.26](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.25...engine-models-v0.0.3-next.26) (2026-03-05)
 

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

@@ -14,25 +14,25 @@ Engine type initialiser return type.
 
 ## Properties
 
-### instanceTypeName?
+### instanceTypeName? {#instancetypename}
 
-> `optional` **instanceTypeName**: `string`
+> `optional` **instanceTypeName?**: `string`
 
 The instance type created.
 
 ***
 
-### factory?
+### factory? {#factory}
 
-> `optional` **factory**: `F`
+> `optional` **factory?**: `F`
 
 The factory to store the instance in.
 
 ***
 
-### createComponent()?
+### createComponent? {#createcomponent}
 
-> `optional` **createComponent**: (`additionalConfig`) => `IComponent`
+> `optional` **createComponent?**: (`additionalConfig`) => `IComponent`
 
 Create a new component.
 

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,7 +46,7 @@ The name of the method to call.
 
 ***
 
-### getTypeConfig()
+### getTypeConfig() {#gettypeconfig}
 
 > **getTypeConfig**(`type`): [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[] \| `undefined`
 
@@ -68,7 +68,7 @@ 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,7 +134,7 @@ The context ID value.
 
 ***
 
-### getContextIds()
+### getContextIds() {#getcontextids}
 
 > **getContextIds**(): `IContextIds` \| `undefined`
 
@@ -148,7 +148,7 @@ The context IDs or undefined if none are set.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(`skipComponentStart?`): `Promise`\<`void`\>
 
@@ -170,7 +170,7 @@ Nothing.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 
@@ -184,7 +184,7 @@ Nothing.
 
 ***
 
-### isStarted()
+### isStarted() {#isstarted}
 
 > **isStarted**(): `boolean`
 
@@ -198,7 +198,7 @@ True if the engine is started.
 
 ***
 
-### isPrimary()
+### isPrimary() {#isprimary}
 
 > **isPrimary**(): `boolean`
 
@@ -212,7 +212,7 @@ True if the engine is the primary instance.
 
 ***
 
-### isClone()
+### isClone() {#isclone}
 
 > **isClone**(): `boolean`
 
@@ -226,7 +226,7 @@ True if the engine instance is a clone.
 
 ***
 
-### logInfo()
+### logInfo() {#loginfo}
 
 > **logInfo**(`message`): `void`
 
@@ -246,7 +246,7 @@ The message to log.
 
 ***
 
-### logError()
+### logError() {#logerror}
 
 > **logError**(`error`): `void`
 
@@ -266,7 +266,7 @@ The error to log.
 
 ***
 
-### getConfig()
+### getConfig() {#getconfig}
 
 > **getConfig**(): `C`
 
@@ -280,7 +280,7 @@ The config for the engine.
 
 ***
 
-### getState()
+### getState() {#getstate}
 
 > **getState**(): `S`
 
@@ -294,7 +294,7 @@ The state of the engine.
 
 ***
 
-### setStateDirty()
+### setStateDirty() {#setstatedirty}
 
 > **setStateDirty**(): `void`
 
@@ -306,7 +306,7 @@ Set the state to dirty so it gets saved.
 
 ***
 
-### getRegisteredInstances()
+### getRegisteredInstances() {#getregisteredinstances}
 
 > **getRegisteredInstances**(): `object`
 
@@ -320,7 +320,7 @@ The registered instances.
 
 ***
 
-### getRegisteredInstanceType()
+### getRegisteredInstanceType() {#getregisteredinstancetype}
 
 > **getRegisteredInstanceType**(`componentConnectorType`, `features?`): `string`
 
@@ -352,7 +352,7 @@ If a matching instance was not found.
 
 ***
 
-### getRegisteredInstanceTypeOptional()
+### getRegisteredInstanceTypeOptional() {#getregisteredinstancetypeoptional}
 
 > **getRegisteredInstanceTypeOptional**(`componentConnectorType`, `features?`): `string` \| `undefined`
 
@@ -380,7 +380,7 @@ The instance type matching the criteria if one is registered.
 
 ***
 
-### getCloneData()
+### getCloneData() {#getclonedata}
 
 > **getCloneData**(): [`IEngineCoreClone`](IEngineCoreClone.md)\<`C`, `S`\>
 
@@ -394,7 +394,7 @@ The clone data.
 
 ***
 
-### populateClone()
+### populateClone() {#populateclone}
 
 > **populateClone**(`cloneData`, `contextIds?`, `silent?`): `void`
 

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`
 

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,7 +68,7 @@ The method to call on the module.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(): `Promise`\<`void`\>
 
@@ -82,7 +82,7 @@ Nothing.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IEngineStateStorage.md

@@ -10,7 +10,7 @@ Definition of state storage for engine.
 
 ## Methods
 
-### load()
+### load() {#load}
 
 > **load**(`engineCore`): `Promise`\<`S` \| `undefined`\>
 
@@ -32,7 +32,7 @@ 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,4 +1,4 @@
-# Type Alias: EngineTypeInitialiser()\<T, F\>
+# Type Alias: EngineTypeInitialiser\<T, F\>
 
 > **EngineTypeInitialiser**\<`T`, `F`\> = (`engineCore`, `context`, `instanceConfig`) => [`EngineTypeInitialiserReturn`](../interfaces/EngineTypeInitialiserReturn.md)\<`T`, `F`\>
 

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

@@ -8,49 +8,49 @@ Configuration for the engine core type.
 
 ### overrideInstanceType?
 
-> `optional` **overrideInstanceType**: `string`
+> `optional` **overrideInstanceType?**: `string`
 
 The instance type to override with.
 
 ### isDefault?
 
-> `optional` **isDefault**: `boolean`
+> `optional` **isDefault?**: `boolean`
 
 Whether this is the default instance.
 
 ### isMultiInstance?
 
-> `optional` **isMultiInstance**: `boolean`
+> `optional` **isMultiInstance?**: `boolean`
 
 Whether this is a multi-instance component.
 
 ### features?
 
-> `optional` **features**: `string`[]
+> `optional` **features?**: `string`[]
 
 The features supported by this instance.
 
 ### restPath?
 
-> `optional` **restPath**: `string`
+> `optional` **restPath?**: `string`
 
 The path for the REST API.
 
 ### restOptions?
 
-> `optional` **restOptions**: `unknown`
+> `optional` **restOptions?**: `unknown`
 
 The options for the REST API route generation.
 
 ### socketPath?
 
-> `optional` **socketPath**: `string`
+> `optional` **socketPath?**: `string`
 
 The path for the socket API.
 
 ### socketOptions?
 
-> `optional` **socketOptions**: `unknown`
+> `optional` **socketOptions?**: `unknown`
 
 The options for the socket API route generation.
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/engine-models",
-	"version": "0.0.3-next.26",
-	"description": "Models which define the structure of the engine.",
+	"version": "0.0.3-next.27",
+	"description": "Shared contracts and factory interfaces for composing engine core and server implementations.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/engine.git",