@twin.org/engine-models 0.0.1 → 0.0.2-next.10

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

@@ -25,6 +25,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 +61,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/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/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

@@ -8,4 +8,5 @@ export type IEngineCoreTypeConfig<T extends IEngineCoreTypeBaseConfig = {
     [id: string]: unknown;
     overrideInstanceType?: string;
     isDefault?: boolean;
+    features?: string[];
 };

package/docs/changelog.md

@@ -1,5 +1,79 @@
 # @twin.org/engine-models - Changelog
 
+## [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)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.1](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.0...engine-models-v0.0.2-next.1) (2025-07-11)
+
+
+### Features
+
+* add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* remove bootstrapped components, component should manage their own state ([5c7e9e4](https://github.com/twinfoundation/engine/commit/5c7e9e419ef26933e49c9c5a21a20a8961244e7f))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
 ## 0.0.1 (2025-07-11)
 
 

package/docs/reference/interfaces/IEngineCore.md

@@ -80,6 +80,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 +190,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/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/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/IEngineCoreTypeConfig.md

@@ -14,6 +14,10 @@ Configuration for the engine core type.
 
 > `optional` **isDefault**: `boolean`
 
+### features?
+
+> `optional` **features**: `string`[]
+
 ## Type Parameters
 
 ### T

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-models",
-	"version": "0.0.1",
+	"version": "0.0.2-next.10",
 	"description": "Models which define the structure of the engine.",
 	"repository": {
 		"type": "git",