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

package/dist/types/index.d.ts

@@ -3,6 +3,7 @@ export * from "./factories/engineServerFactory";
 export * from "./models/config/IEngineCoreConfig";
 export * from "./models/config/IEngineCoreTypeBaseConfig";
 export * from "./models/config/IEngineCoreTypeConfig";
+export * from "./models/config/IEngineModuleConfig";
 export * from "./models/engineTypeInitialiser";
 export * from "./models/IEngineCore";
 export * from "./models/IEngineCoreClone";

package/dist/types/models/IEngineCore.d.ts

@@ -10,11 +10,16 @@ export interface IEngineCore<C extends IEngineCoreConfig = IEngineCoreConfig, S
     /**
      * Add a type initialiser.
      * @param type The type to add the initialiser for.
-     * @param typeConfig The type config.
      * @param module The name of the module which contains the initialiser method.
      * @param method The name of the method to call.
      */
-    addTypeInitialiser(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, module: string, method: string): void;
+    addTypeInitialiser(type: string, module: string, method: string): void;
+    /**
+     * Get the type config for a specific type.
+     * @param type The type to get the config for.
+     * @returns The type config or undefined if not found.
+     */
+    getTypeConfig(type: string): IEngineCoreTypeConfig[] | undefined;
     /**
      * Start the engine core.
      * @returns True if the start was successful.
@@ -25,6 +30,21 @@ export interface IEngineCore<C extends IEngineCoreConfig = IEngineCoreConfig, S
      * @returns Nothing.
      */
     stop(): Promise<void>;
+    /**
+     * Is the engine started.
+     * @returns True if the engine is started.
+     */
+    isStarted(): boolean;
+    /**
+     * Is this the primary engine instance.
+     * @returns True if the engine is the primary instance.
+     */
+    isPrimary(): boolean;
+    /**
+     * Is this engine instance a clone.
+     * @returns True if the engine instance is a clone.
+     */
+    isClone(): boolean;
     /**
      * Log info.
      * @param message The message to log.
@@ -46,12 +66,30 @@ export interface IEngineCore<C extends IEngineCoreConfig = IEngineCoreConfig, S
      */
     getState(): S;
     /**
-     * Get the types for the component.
-     * @returns The default types.
+     * Get all the registered instances.
+     * @returns The registered instances.
      */
-    getDefaultTypes(): {
-        [type: string]: string;
+    getRegisteredInstances(): {
+        [name: string]: {
+            type: string;
+            features?: string[];
+        }[];
     };
+    /**
+     * Get the registered instance type for the component/connector.
+     * @param componentConnectorType The type of the component/connector.
+     * @param features The requested features of the component, if not specified the default entry will be retrieved.
+     * @returns The instance type matching the criteria if one is registered.
+     * @throws If a matching instance was not found.
+     */
+    getRegisteredInstanceType(componentConnectorType: string, features?: string[]): string;
+    /**
+     * Get the registered instance type for the component/connector.
+     * @param componentConnectorType The type of the component/connector.
+     * @param features The requested features of the component, if not specified the default entry will be retrieved.
+     * @returns The instance type matching the criteria if one is registered.
+     */
+    getRegisteredInstanceTypeOptional(componentConnectorType: string, features?: string[]): string | undefined;
     /**
      * Get the data required to create a clone of the engine.
      * @returns The clone data.

package/dist/types/models/IEngineCoreClone.d.ts

@@ -1,6 +1,5 @@
 import type { IEntitySchema } from "@twin.org/entity";
 import type { IEngineCoreConfig } from "./config/IEngineCoreConfig";
-import type { IEngineCoreTypeConfig } from "./config/IEngineCoreTypeConfig";
 import type { IEngineState } from "./IEngineState";
 /**
  * Interface describing the data required to clone an engine.
@@ -19,7 +18,6 @@ export interface IEngineCoreClone<C extends IEngineCoreConfig = IEngineCoreConfi
      */
     typeInitialisers: {
         type: string;
-        typeConfig: IEngineCoreTypeConfig[];
         module: string;
         method: string;
     }[];
@@ -29,8 +27,4 @@ export interface IEngineCoreClone<C extends IEngineCoreConfig = IEngineCoreConfi
     entitySchemas: {
         [schema: string]: IEntitySchema;
     };
-    /**
-     * The logger type name.
-     */
-    loggerTypeName: string;
 }

package/dist/types/models/IEngineCoreContext.d.ts

@@ -18,10 +18,14 @@ export interface IEngineCoreContext<C extends IEngineCoreConfig = IEngineCoreCon
      */
     stateDirty: boolean;
     /**
-     * The default types to use when components don't have custom types.
+     * The registered instances to use when components don't have custom types.
+     * The default entry will be the first in the list.
      */
-    defaultTypes: {
-        [type: string]: string;
+    registeredInstances: {
+        [name: string]: {
+            type: string;
+            features?: string[];
+        }[];
     };
     /**
      * The components.

package/dist/types/models/IEngineServer.d.ts

@@ -1,4 +1,3 @@
-import type { IEngineCoreTypeConfig } from "./config/IEngineCoreTypeConfig";
 /**
  * Interface describing the engine server methods.
  */
@@ -6,19 +5,17 @@ export interface IEngineServer {
     /**
      * Add a REST route generator.
      * @param type The type to add the generator for.
-     * @param typeConfig The type config.
      * @param module The module containing the generator.
      * @param method The method to call on the module.
      */
-    addRestRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, module: string, method: string): void;
+    addRestRouteGenerator(type: string, module: string, method: string): void;
     /**
      * Add a socket route generator.
      * @param type The type to add the generator for.
-     * @param typeConfig The type config.
      * @param module The module containing the generator.
      * @param method The method to call on the module.
      */
-    addSocketRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, module: string, method: string): void;
+    addSocketRouteGenerator(type: string, module: string, method: string): void;
     /**
      * Start the engine server.
      * @returns True if the start was successful.

package/dist/types/models/IEngineState.d.ts

@@ -6,12 +6,4 @@ export interface IEngineState {
      * The identity for the node.
      */
     nodeIdentity?: string;
-    /**
-     * The component states.
-     */
-    componentStates: {
-        [component: string]: {
-            [id: string]: unknown;
-        };
-    };
 }

package/dist/types/models/config/IEngineCoreTypeConfig.d.ts

@@ -2,10 +2,33 @@ import type { IEngineCoreTypeBaseConfig } from "./IEngineCoreTypeBaseConfig";
 /**
  * Configuration for the engine core type.
  */
-export type IEngineCoreTypeConfig<T extends IEngineCoreTypeBaseConfig = {
-    type: string;
-}> = T & {
-    [id: string]: unknown;
+export type IEngineCoreTypeConfig<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> = T & {
+    /**
+     * The instance type to override with.
+     */
     overrideInstanceType?: string;
+    /**
+     * Whether this is the default instance.
+     */
     isDefault?: boolean;
+    /**
+     * The features supported by this instance.
+     */
+    features?: string[];
+    /**
+     * The path for the REST API.
+     */
+    restPath?: string;
+    /**
+     * The options for the REST API route generation.
+     */
+    restOptions?: unknown;
+    /**
+     * The path for the socket API.
+     */
+    socketPath?: string;
+    /**
+     * The options for the socket API route generation.
+     */
+    socketOptions?: unknown;
 };

package/dist/types/models/config/IEngineModuleConfig.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Configuration for an engine module.
+ */
+export interface IEngineModuleConfig {
+    /**
+     * The unique identifier for the module.
+     */
+    id: string;
+    /**
+     * The module that implements the additional component.
+     */
+    moduleName: string;
+    /**
+     * The class name of the additional component.
+     */
+    className: string;
+    /**
+     * Additional dependencies required by the component.
+     */
+    dependencies?: {
+        propertyName: string;
+        componentName: string;
+        features?: string[];
+        isOptional?: boolean;
+    }[];
+    /**
+     * Additional configuration for the component.
+     */
+    config?: unknown;
+}

package/dist/types/models/engineTypeInitialiser.d.ts

@@ -1,7 +1,25 @@
+import type { Factory, IComponent } from "@twin.org/core";
 import type { IEngineCoreTypeBaseConfig } from "./config/IEngineCoreTypeBaseConfig";
 import type { IEngineCore } from "./IEngineCore";
 import type { IEngineCoreContext } from "./IEngineCoreContext";
 /**
  * Method definition for the engine type initialiser.
  */
-export type EngineTypeInitialiser<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> = (engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: T, overrideInstanceType?: string) => string | undefined;
+export type EngineTypeInitialiser<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> = (engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: T) => Promise<EngineTypeInitialiserReturn>;
+/**
+ * Engine type initialiser return type.
+ */
+export interface EngineTypeInitialiserReturn {
+    /**
+     * The instance type created.
+     */
+    instanceType?: string;
+    /**
+     * The factory to store the instance in.
+     */
+    factory?: Factory<unknown>;
+    /**
+     * The component created.
+     */
+    component?: IComponent;
+}

package/docs/changelog.md

@@ -1,5 +1,132 @@
 # @twin.org/engine-models - Changelog
 
+## [0.0.2-next.20](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.19...engine-models-v0.0.2-next.20) (2025-10-06)
+
+
+### Features
+
+* standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
+
+## [0.0.2-next.19](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.18...engine-models-v0.0.2-next.19) (2025-10-02)
+
+
+### Features
+
+* simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
+
+## [0.0.2-next.18](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.17...engine-models-v0.0.2-next.18) (2025-09-29)
+
+
+### Features
+
+* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
+
+## [0.0.2-next.17](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.16...engine-models-v0.0.2-next.17) (2025-09-26)
+
+
+### Features
+
+* add engine type helper for config lookups ([a20a398](https://github.com/twinfoundation/engine/commit/a20a3987016c48351178ab8410bc05b0fba0f2c1))
+* add REST options for route construction ([4adf0af](https://github.com/twinfoundation/engine/commit/4adf0af8a03689a4dbdf67e8527d6db0d2c5d59d))
+
+## [0.0.2-next.16](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.15...engine-models-v0.0.2-next.16) (2025-09-25)
+
+
+### Features
+
+* add engine type helper for config lookups ([7d5eeef](https://github.com/twinfoundation/engine/commit/7d5eeefd3e7b9daab1ba20e2fb6b1ebfec178aec))
+
+## [0.0.2-next.15](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.14...engine-models-v0.0.2-next.15) (2025-09-24)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.14](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.13...engine-models-v0.0.2-next.14) (2025-09-19)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.13](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.12...engine-models-v0.0.2-next.13) (2025-09-08)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.12](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.11...engine-models-v0.0.2-next.12) (2025-09-05)
+
+
+### Features
+
+* add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
+
+## [0.0.2-next.11](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.10...engine-models-v0.0.2-next.11) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
+
+## [0.0.2-next.10](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.9...engine-models-v0.0.2-next.10) (2025-08-26)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.9](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.8...engine-models-v0.0.2-next.9) (2025-08-25)
+
+
+### Features
+
+* add isPrimary and isClone methods ([a7c63e9](https://github.com/twinfoundation/engine/commit/a7c63e97f54c95b104cc81e66d3fa42c6607bdc1))
+
+## [0.0.2-next.8](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.7...engine-models-v0.0.2-next.8) (2025-08-22)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.7](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.6...engine-models-v0.0.2-next.7) (2025-08-22)
+
+
+### Features
+
+* remove unused component states ([d56d648](https://github.com/twinfoundation/engine/commit/d56d6486119ea8b8501a33f9e3a3101a08b826ed))
+
+## [0.0.2-next.6](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.5...engine-models-v0.0.2-next.6) (2025-08-21)
+
+
+### Features
+
+* update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
+
+## [0.0.2-next.5](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.4...engine-models-v0.0.2-next.5) (2025-08-14)
+
+
+### Features
+
+* add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
+
+## [0.0.2-next.4](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.3...engine-models-v0.0.2-next.4) (2025-07-25)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.3](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.2...engine-models-v0.0.2-next.3) (2025-07-24)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
 ## [0.0.2-next.2](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.1...engine-models-v0.0.2-next.2) (2025-07-21)
 
 

package/docs/reference/index.md

@@ -10,6 +10,8 @@
 - [IEngineStateStorage](interfaces/IEngineStateStorage.md)
 - [IEngineCoreConfig](interfaces/IEngineCoreConfig.md)
 - [IEngineCoreTypeBaseConfig](interfaces/IEngineCoreTypeBaseConfig.md)
+- [IEngineModuleConfig](interfaces/IEngineModuleConfig.md)
+- [EngineTypeInitialiserReturn](interfaces/EngineTypeInitialiserReturn.md)
 
 ## Type Aliases
 

package/docs/reference/interfaces/EngineTypeInitialiserReturn.md

@@ -0,0 +1,27 @@
+# Interface: EngineTypeInitialiserReturn
+
+Engine type initialiser return type.
+
+## Properties
+
+### instanceType?
+
+> `optional` **instanceType**: `string`
+
+The instance type created.
+
+***
+
+### factory?
+
+> `optional` **factory**: `Factory`\<`unknown`\>
+
+The factory to store the instance in.
+
+***
+
+### component?
+
+> `optional` **component**: `IComponent`
+
+The component created.

package/docs/reference/interfaces/IEngineCore.md

@@ -16,7 +16,7 @@ Interface describing the engine core methods.
 
 ### addTypeInitialiser()
 
-> **addTypeInitialiser**(`type`, `typeConfig`, `module`, `method`): `void`
+> **addTypeInitialiser**(`type`, `module`, `method`): `void`
 
 Add a type initialiser.
 
@@ -28,12 +28,6 @@ Add a type initialiser.
 
 The type to add the initialiser for.
 
-##### typeConfig
-
-The type config.
-
-`undefined` | [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
-
 ##### module
 
 `string`
@@ -52,6 +46,28 @@ The name of the method to call.
 
 ***
 
+### getTypeConfig()
+
+> **getTypeConfig**(`type`): `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+
+Get the type config for a specific type.
+
+#### Parameters
+
+##### type
+
+`string`
+
+The type to get the config for.
+
+#### Returns
+
+`undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+
+The type config or undefined if not found.
+
+***
+
 ### start()
 
 > **start**(): `Promise`\<`boolean`\>
@@ -80,6 +96,48 @@ Nothing.
 
 ***
 
+### isStarted()
+
+> **isStarted**(): `boolean`
+
+Is the engine started.
+
+#### Returns
+
+`boolean`
+
+True if the engine is started.
+
+***
+
+### isPrimary()
+
+> **isPrimary**(): `boolean`
+
+Is this the primary engine instance.
+
+#### Returns
+
+`boolean`
+
+True if the engine is the primary instance.
+
+***
+
+### isClone()
+
+> **isClone**(): `boolean`
+
+Is this engine instance a clone.
+
+#### Returns
+
+`boolean`
+
+True if the engine instance is a clone.
+
+***
+
 ### logInfo()
 
 > **logInfo**(`message`): `void`
@@ -148,17 +206,77 @@ 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.
+
+***
+
+### 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.
+
+***
+
+### getRegisteredInstanceTypeOptional()
+
+> **getRegisteredInstanceTypeOptional**(`componentConnectorType`, `features?`): `undefined` \| `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
+
+`undefined` \| `string`
+
+The instance type matching the criteria if one is registered.
 
 ***
 

package/docs/reference/interfaces/IEngineCoreClone.md

@@ -40,10 +40,6 @@ The type initialisers for the engine.
 
 > **type**: `string`
 
-#### typeConfig
-
-> **typeConfig**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
-
 #### module
 
 > **module**: `string`
@@ -63,11 +59,3 @@ The entity schemas for the engine.
 #### Index Signature
 
 \[`schema`: `string`\]: `IEntitySchema`\<`unknown`\>
-
-***
-
-### loggerTypeName
-
-> **loggerTypeName**: `string`
-
-The logger type name.

package/docs/reference/interfaces/IEngineCoreContext.md

@@ -38,15 +38,16 @@ The state dirty flag, which flags that the state needs saving.
 
 ***
 
-### defaultTypes
+### registeredInstances
 
-> **defaultTypes**: `object`
+> **registeredInstances**: `object`
 
-The default types to use when components don't have custom types.
+The registered instances to use when components don't have custom types.
+The default entry will be the first in the list.
 
 #### Index Signature
 
-\[`type`: `string`\]: `string`
+\[`name`: `string`\]: `object`[]
 
 ***
 

package/docs/reference/interfaces/IEngineModuleConfig.md

@@ -0,0 +1,59 @@
+# Interface: IEngineModuleConfig
+
+Configuration for an engine module.
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The unique identifier for the module.
+
+***
+
+### moduleName
+
+> **moduleName**: `string`
+
+The module that implements the additional component.
+
+***
+
+### className
+
+> **className**: `string`
+
+The class name of the additional component.
+
+***
+
+### dependencies?
+
+> `optional` **dependencies**: `object`[]
+
+Additional dependencies required by the component.
+
+#### propertyName
+
+> **propertyName**: `string`
+
+#### componentName
+
+> **componentName**: `string`
+
+#### features?
+
+> `optional` **features**: `string`[]
+
+#### isOptional?
+
+> `optional` **isOptional**: `boolean`
+
+***
+
+### config?
+
+> `optional` **config**: `unknown`
+
+Additional configuration for the component.

package/docs/reference/interfaces/IEngineServer.md

@@ -6,7 +6,7 @@ Interface describing the engine server methods.
 
 ### addRestRouteGenerator()
 
-> **addRestRouteGenerator**(`type`, `typeConfig`, `module`, `method`): `void`
+> **addRestRouteGenerator**(`type`, `module`, `method`): `void`
 
 Add a REST route generator.
 
@@ -18,12 +18,6 @@ Add a REST route generator.
 
 The type to add the generator for.
 
-##### typeConfig
-
-The type config.
-
-`undefined` | [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
-
 ##### module
 
 `string`
@@ -44,7 +38,7 @@ The method to call on the module.
 
 ### addSocketRouteGenerator()
 
-> **addSocketRouteGenerator**(`type`, `typeConfig`, `module`, `method`): `void`
+> **addSocketRouteGenerator**(`type`, `module`, `method`): `void`
 
 Add a socket route generator.
 
@@ -56,12 +50,6 @@ Add a socket route generator.
 
 The type to add the generator for.
 
-##### typeConfig
-
-The type config.
-
-`undefined` | [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
-
 ##### module
 
 `string`

package/docs/reference/interfaces/IEngineState.md

@@ -9,15 +9,3 @@ The state of the engine.
 > `optional` **nodeIdentity**: `string`
 
 The identity for the node.
-
-***
-
-### componentStates
-
-> **componentStates**: `object`
-
-The component states.
-
-#### Index Signature
-
-\[`component`: `string`\]: `object`

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

@@ -1,6 +1,6 @@
 # Type Alias: EngineTypeInitialiser()\<T\>
 
-> **EngineTypeInitialiser**\<`T`\> = (`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`) => `string` \| `undefined`
+> **EngineTypeInitialiser**\<`T`\> = (`engineCore`, `context`, `instanceConfig`) => `Promise`\<[`EngineTypeInitialiserReturn`](../interfaces/EngineTypeInitialiserReturn.md)\>
 
 Method definition for the engine type initialiser.
 
@@ -24,10 +24,6 @@ Method definition for the engine type initialiser.
 
 `T`
 
-### overrideInstanceType?
-
-`string`
-
 ## Returns
 
-`string` \| `undefined`
+`Promise`\<[`EngineTypeInitialiserReturn`](../interfaces/EngineTypeInitialiserReturn.md)\>

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

@@ -4,18 +4,52 @@
 
 Configuration for the engine core type.
 
-## Type declaration
+## Type Declaration
 
 ### overrideInstanceType?
 
 > `optional` **overrideInstanceType**: `string`
 
+The instance type to override with.
+
 ### isDefault?
 
 > `optional` **isDefault**: `boolean`
 
+Whether this is the default instance.
+
+### features?
+
+> `optional` **features**: `string`[]
+
+The features supported by this instance.
+
+### restPath?
+
+> `optional` **restPath**: `string`
+
+The path for the REST API.
+
+### restOptions?
+
+> `optional` **restOptions**: `unknown`
+
+The options for the REST API route generation.
+
+### socketPath?
+
+> `optional` **socketPath**: `string`
+
+The path for the socket API.
+
+### socketOptions?
+
+> `optional` **socketOptions**: `unknown`
+
+The options for the socket API route generation.
+
 ## Type Parameters
 
 ### T
 
-`T` *extends* [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md) = \{ `type`: `string`; \}
+`T` *extends* [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md) = [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-models",
-	"version": "0.0.2-next.2",
+	"version": "0.0.2-next.20",
 	"description": "Models which define the structure of the engine.",
 	"repository": {
 		"type": "git",
@@ -34,5 +34,16 @@
 		"dist/types",
 		"locales",
 		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"engine",
+		"models",
+		"types",
+		"schemas"
 	]
 }