@twin.org/engine-models 0.0.3-next.2 → 0.0.3-next.21

package/dist/es/models/IEngineCore.js.map

@@ -1 +1 @@
-{"version":3,"file":"IEngineCore.js","sourceRoot":"","sources":["../../../src/models/IEngineCore.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IContextIds } from \"@twin.org/context\";\nimport type { IError } from \"@twin.org/core\";\nimport type { IEngineCoreConfig } from \"./config/IEngineCoreConfig.js\";\nimport type { IEngineCoreTypeConfig } from \"./config/IEngineCoreTypeConfig.js\";\nimport type { IEngineCoreClone } from \"./IEngineCoreClone.js\";\nimport type { IEngineState } from \"./IEngineState.js\";\n\n/**\n * Interface describing the engine core methods.\n */\nexport interface IEngineCore<\n\tC extends IEngineCoreConfig = IEngineCoreConfig,\n\tS extends IEngineState = IEngineState\n> {\n\t/**\n\t * Add a type initialiser.\n\t * @param type The type to add the initialiser for.\n\t * @param module The name of the module which contains the initialiser method.\n\t * @param method The name of the method to call.\n\t */\n\taddTypeInitialiser(type: string, module: string, method: string): void;\n\n\t/**\n\t * Get the type config for a specific type.\n\t * @param type The type to get the config for.\n\t * @returns The type config or undefined if not found.\n\t */\n\tgetTypeConfig(type: string): IEngineCoreTypeConfig[] | undefined;\n\n\t/**\n\t * Add a context ID key to the engine.\n\t * @param key The context ID key.\n\t */\n\taddContextIdKey(key: string): void;\n\n\t/**\n\t * Get the context ID keys for the engine.\n\t * @returns The context IDs keys.\n\t */\n\tgetContextIdKeys(): string[];\n\n\t/**\n\t * Add a context ID to the engine.\n\t * @param key The context ID key.\n\t * @param value The context ID value.\n\t */\n\taddContextId(key: string, value: string): void;\n\n\t/**\n\t * Get the context IDs for the engine.\n\t * @returns The context IDs or undefined if none are set.\n\t */\n\tgetContextIds(): IContextIds | undefined;\n\n\t/**\n\t * Start the engine core.\n\t * @returns True if the start was successful.\n\t */\n\tstart(): Promise<boolean>;\n\n\t/**\n\t * Stop the engine core.\n\t * @returns Nothing.\n\t */\n\tstop(): Promise<void>;\n\n\t/**\n\t * Is the engine started.\n\t * @returns True if the engine is started.\n\t */\n\tisStarted(): boolean;\n\n\t/**\n\t * Is this the primary engine instance.\n\t * @returns True if the engine is the primary instance.\n\t */\n\tisPrimary(): boolean;\n\n\t/**\n\t * Is this engine instance a clone.\n\t * @returns True if the engine instance is a clone.\n\t */\n\tisClone(): boolean;\n\n\t/**\n\t * Log info.\n\t * @param message The message to log.\n\t */\n\tlogInfo(message: string): void;\n\n\t/**\n\t * Log error.\n\t * @param error The error to log.\n\t */\n\tlogError(error: IError): void;\n\n\t/**\n\t * Get the config for the engine.\n\t * @returns The config for the engine.\n\t */\n\tgetConfig(): C;\n\n\t/**\n\t * Get the state of the engine.\n\t * @returns The state of the engine.\n\t */\n\tgetState(): S;\n\n\t/**\n\t * Get all the registered instances.\n\t * @returns The registered instances.\n\t */\n\tgetRegisteredInstances(): {\n\t\t[name: string]: {\n\t\t\ttype: string;\n\t\t\tfeatures?: string[];\n\t\t}[];\n\t};\n\n\t/**\n\t * Get the registered instance type for the component/connector.\n\t * @param componentConnectorType The type of the component/connector.\n\t * @param features The requested features of the component, if not specified the default entry will be retrieved.\n\t * @returns The instance type matching the criteria if one is registered.\n\t * @throws If a matching instance was not found.\n\t */\n\tgetRegisteredInstanceType(componentConnectorType: string, features?: string[]): string;\n\n\t/**\n\t * Get the registered instance type for the component/connector.\n\t * @param componentConnectorType The type of the component/connector.\n\t * @param features The requested features of the component, if not specified the default entry will be retrieved.\n\t * @returns The instance type matching the criteria if one is registered.\n\t */\n\tgetRegisteredInstanceTypeOptional(\n\t\tcomponentConnectorType: string,\n\t\tfeatures?: string[]\n\t): string | undefined;\n\n\t/**\n\t * Get the data required to create a clone of the engine.\n\t * @returns The clone data.\n\t */\n\tgetCloneData(): IEngineCoreClone<C, S>;\n\n\t/**\n\t * Populate the engine from the clone data.\n\t * @param cloneData The clone data to populate from.\n\t * @param silent Should the clone be silent.\n\t */\n\tpopulateClone(cloneData: IEngineCoreClone<C, S>, silent?: boolean): void;\n}\n"]}
+{"version":3,"file":"IEngineCore.js","sourceRoot":"","sources":["../../../src/models/IEngineCore.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IContextIds } from \"@twin.org/context\";\nimport type { IError } from \"@twin.org/core\";\nimport type { IEngineCoreConfig } from \"./config/IEngineCoreConfig.js\";\nimport type { IEngineCoreTypeConfig } from \"./config/IEngineCoreTypeConfig.js\";\nimport type { IEngineCoreClone } from \"./IEngineCoreClone.js\";\nimport type { IEngineState } from \"./IEngineState.js\";\n\n/**\n * Interface describing the engine core methods.\n */\nexport interface IEngineCore<\n\tC extends IEngineCoreConfig = IEngineCoreConfig,\n\tS extends IEngineState = IEngineState\n> {\n\t/**\n\t * Add a type initialiser.\n\t * @param type The type to add the initialiser for.\n\t * @param module The name of the module which contains the initialiser method.\n\t * @param method The name of the method to call.\n\t */\n\taddTypeInitialiser(type: string, module: string, method: string): void;\n\n\t/**\n\t * Get the type config for a specific type.\n\t * @param type The type to get the config for.\n\t * @returns The type config or undefined if not found.\n\t */\n\tgetTypeConfig(type: string): IEngineCoreTypeConfig[] | undefined;\n\n\t/**\n\t * Add a context ID key to the engine.\n\t * @param key The context ID key.\n\t * @param componentFeatures The component features for the context ID handler.\n\t */\n\taddContextIdKey(key: string, componentFeatures: string[]): void;\n\n\t/**\n\t * Get the context ID keys for the engine.\n\t * @returns The context IDs keys.\n\t */\n\tgetContextIdKeys(): string[];\n\n\t/**\n\t * Add a context ID to the engine.\n\t * @param key The context ID key.\n\t * @param value The context ID value.\n\t */\n\taddContextId(key: string, value: string): void;\n\n\t/**\n\t * Get the context IDs for the engine.\n\t * @returns The context IDs or undefined if none are set.\n\t */\n\tgetContextIds(): IContextIds | undefined;\n\n\t/**\n\t * Start the engine core.\n\t * @param skipComponentStart Should the component start be skipped.\n\t * @returns Nothing.\n\t */\n\tstart(skipComponentStart?: boolean): Promise<void>;\n\n\t/**\n\t * Stop the engine core.\n\t * @returns Nothing.\n\t */\n\tstop(): Promise<void>;\n\n\t/**\n\t * Is the engine started.\n\t * @returns True if the engine is started.\n\t */\n\tisStarted(): boolean;\n\n\t/**\n\t * Is this the primary engine instance.\n\t * @returns True if the engine is the primary instance.\n\t */\n\tisPrimary(): boolean;\n\n\t/**\n\t * Is this engine instance a clone.\n\t * @returns True if the engine instance is a clone.\n\t */\n\tisClone(): boolean;\n\n\t/**\n\t * Log info.\n\t * @param message The message to log.\n\t */\n\tlogInfo(message: string): void;\n\n\t/**\n\t * Log error.\n\t * @param error The error to log.\n\t */\n\tlogError(error: IError): void;\n\n\t/**\n\t * Get the config for the engine.\n\t * @returns The config for the engine.\n\t */\n\tgetConfig(): C;\n\n\t/**\n\t * Get the state of the engine.\n\t * @returns The state of the engine.\n\t */\n\tgetState(): S;\n\n\t/**\n\t * Set the state to dirty so it gets saved.\n\t */\n\tsetStateDirty(): void;\n\n\t/**\n\t * Get all the registered instances.\n\t * @returns The registered instances.\n\t */\n\tgetRegisteredInstances(): {\n\t\t[name: string]: {\n\t\t\ttype: string;\n\t\t\tfeatures?: string[];\n\t\t}[];\n\t};\n\n\t/**\n\t * Get the registered instance type for the component/connector.\n\t * @param componentConnectorType The type of the component/connector.\n\t * @param features The requested features of the component, if not specified the default entry will be retrieved.\n\t * @returns The instance type matching the criteria if one is registered.\n\t * @throws If a matching instance was not found.\n\t */\n\tgetRegisteredInstanceType(componentConnectorType: string, features?: string[]): string;\n\n\t/**\n\t * Get the registered instance type for the component/connector.\n\t * @param componentConnectorType The type of the component/connector.\n\t * @param features The requested features of the component, if not specified the default entry will be retrieved.\n\t * @returns The instance type matching the criteria if one is registered.\n\t */\n\tgetRegisteredInstanceTypeOptional(\n\t\tcomponentConnectorType: string,\n\t\tfeatures?: string[]\n\t): string | undefined;\n\n\t/**\n\t * Get the data required to create a clone of the engine.\n\t * @returns The clone data.\n\t */\n\tgetCloneData(): IEngineCoreClone<C, S>;\n\n\t/**\n\t * Populate the engine from the clone data.\n\t * @param cloneData The clone data to populate from.\n\t * @param contextIds The context IDs to use for the clone.\n\t * @param silent Should the clone be silent.\n\t */\n\tpopulateClone(\n\t\tcloneData: IEngineCoreClone<C, S>,\n\t\tcontextIds?: IContextIds,\n\t\tsilent?: boolean\n\t): void;\n}\n"]}

package/dist/es/models/IEngineCoreClone.js.map

@@ -1 +1 @@
-{"version":3,"file":"IEngineCoreClone.js","sourceRoot":"","sources":["../../../src/models/IEngineCoreClone.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEntitySchema } from \"@twin.org/entity\";\nimport type { IEngineCoreConfig } from \"./config/IEngineCoreConfig.js\";\nimport type { IEngineState } from \"./IEngineState.js\";\n\n/**\n * Interface describing the data required to clone an engine.\n */\nexport interface IEngineCoreClone<\n\tC extends IEngineCoreConfig = IEngineCoreConfig,\n\tS extends IEngineState = IEngineState\n> {\n\t/**\n\t * The config for the engine.\n\t */\n\tconfig: C;\n\n\t/**\n\t * The state of the engine.\n\t */\n\tstate: S;\n\n\t/**\n\t * The type initialisers for the engine.\n\t */\n\ttypeInitialisers: {\n\t\ttype: string;\n\t\tmodule: string;\n\t\tmethod: string;\n\t}[];\n\n\t/**\n\t * The entity schemas for the engine.\n\t */\n\tentitySchemas: { [schema: string]: IEntitySchema };\n\n\t/**\n\t * The context ID keys.\n\t */\n\tcontextIdKeys: string[];\n}\n"]}
+{"version":3,"file":"IEngineCoreClone.js","sourceRoot":"","sources":["../../../src/models/IEngineCoreClone.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEntitySchema } from \"@twin.org/entity\";\nimport type { IEngineCoreConfig } from \"./config/IEngineCoreConfig.js\";\nimport type { IEngineState } from \"./IEngineState.js\";\n\n/**\n * Interface describing the data required to clone an engine.\n */\nexport interface IEngineCoreClone<\n\tC extends IEngineCoreConfig = IEngineCoreConfig,\n\tS extends IEngineState = IEngineState\n> {\n\t/**\n\t * The config for the engine.\n\t */\n\tconfig: C;\n\n\t/**\n\t * The state of the engine.\n\t */\n\tstate: S;\n\n\t/**\n\t * The type initialisers for the engine.\n\t */\n\ttypeInitialisers: {\n\t\ttype: string;\n\t\tmodule: string;\n\t\tmethod: string;\n\t}[];\n\n\t/**\n\t * The entity schemas for the engine.\n\t */\n\tentitySchemas: { [schema: string]: IEntitySchema };\n\n\t/**\n\t * The context ID keys.\n\t */\n\tcontextIdKeys: { key: string; componentFeatures: string[] }[];\n}\n"]}

package/dist/es/models/IEngineCoreContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"IEngineCoreContext.js","sourceRoot":"","sources":["../../../src/models/IEngineCoreContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IEngineCoreConfig } from \"./config/IEngineCoreConfig.js\";\nimport type { IEngineState } from \"./IEngineState.js\";\n\n/**\n * The context for the engine core.\n */\nexport interface IEngineCoreContext<\n\tC extends IEngineCoreConfig = IEngineCoreConfig,\n\tS extends IEngineState = IEngineState\n> {\n\t/**\n\t * The engine core config.\n\t */\n\tconfig: C;\n\n\t/**\n\t * The engine core state.\n\t */\n\tstate: S;\n\n\t/**\n\t * The state dirty flag, which flags that the state needs saving.\n\t */\n\tstateDirty: boolean;\n\n\t/**\n\t * The registered instances to use when components don't have custom types.\n\t * The default entry will be the first in the list.\n\t */\n\tregisteredInstances: {\n\t\t[name: string]: { type: string; isDefault?: boolean; features?: string[] }[];\n\t};\n\n\t/**\n\t * The components.\n\t */\n\tcomponentInstances: { instanceType: string; component: IComponent; started: boolean }[];\n}\n"]}
+{"version":3,"file":"IEngineCoreContext.js","sourceRoot":"","sources":["../../../src/models/IEngineCoreContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IEngineCoreConfig } from \"./config/IEngineCoreConfig.js\";\nimport type { IEngineState } from \"./IEngineState.js\";\n\n/**\n * The context for the engine core.\n */\nexport interface IEngineCoreContext<\n\tC extends IEngineCoreConfig = IEngineCoreConfig,\n\tS extends IEngineState = IEngineState\n> {\n\t/**\n\t * The engine core config.\n\t */\n\tconfig: C;\n\n\t/**\n\t * The engine core state.\n\t */\n\tstate: S;\n\n\t/**\n\t * The state dirty flag, which flags that the state needs saving.\n\t */\n\tstateDirty: boolean;\n\n\t/**\n\t * The registered instances to use when components don't have custom types.\n\t * The default entry will be the first in the list.\n\t */\n\tregisteredInstances: {\n\t\t[name: string]: { type: string; isDefault?: boolean; features?: string[] }[];\n\t};\n\n\t/**\n\t * The components.\n\t */\n\tcomponentInstances: { instanceType: string; component: IComponent; initialised: boolean }[];\n}\n"]}

package/dist/es/models/IEngineServer.js.map

@@ -1 +1 @@
-{"version":3,"file":"IEngineServer.js","sourceRoot":"","sources":["../../../src/models/IEngineServer.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing the engine server methods.\n */\nexport interface IEngineServer {\n\t/**\n\t * Add a REST route generator.\n\t * @param type The type to add the generator for.\n\t * @param module The module containing the generator.\n\t * @param method The method to call on the module.\n\t */\n\taddRestRouteGenerator(type: string, module: string, method: string): void;\n\n\t/**\n\t * Add a socket route generator.\n\t * @param type The type to add the generator for.\n\t * @param module The module containing the generator.\n\t * @param method The method to call on the module.\n\t */\n\taddSocketRouteGenerator(type: string, module: string, method: string): void;\n\n\t/**\n\t * Start the engine server.\n\t * @returns True if the start was successful.\n\t */\n\tstart(): Promise<boolean>;\n\n\t/**\n\t * Stop the engine server.\n\t * @returns Nothing.\n\t */\n\tstop(): Promise<void>;\n}\n"]}
+{"version":3,"file":"IEngineServer.js","sourceRoot":"","sources":["../../../src/models/IEngineServer.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing the engine server methods.\n */\nexport interface IEngineServer {\n\t/**\n\t * Add a REST route generator.\n\t * @param type The type to add the generator for.\n\t * @param module The module containing the generator.\n\t * @param method The method to call on the module.\n\t */\n\taddRestRouteGenerator(type: string, module: string, method: string): void;\n\n\t/**\n\t * Add a socket route generator.\n\t * @param type The type to add the generator for.\n\t * @param module The module containing the generator.\n\t * @param method The method to call on the module.\n\t */\n\taddSocketRouteGenerator(type: string, module: string, method: string): void;\n\n\t/**\n\t * Start the engine server.\n\t * @returns Nothing.\n\t */\n\tstart(): Promise<void>;\n\n\t/**\n\t * Stop the engine server.\n\t * @returns Nothing.\n\t */\n\tstop(): Promise<void>;\n}\n"]}

package/dist/es/models/config/IEngineCoreTypeConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"IEngineCoreTypeConfig.js","sourceRoot":"","sources":["../../../../src/models/config/IEngineCoreTypeConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEngineCoreTypeBaseConfig } from \"./IEngineCoreTypeBaseConfig.js\";\n\n/**\n * Configuration for the engine core type.\n */\nexport type IEngineCoreTypeConfig<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> =\n\tT & {\n\t\t/**\n\t\t * The instance type to override with.\n\t\t */\n\t\toverrideInstanceType?: string;\n\n\t\t/**\n\t\t * Whether this is the default instance.\n\t\t */\n\t\tisDefault?: boolean;\n\n\t\t/**\n\t\t * The features supported by this instance.\n\t\t */\n\t\tfeatures?: string[];\n\n\t\t/**\n\t\t * The path for the REST API.\n\t\t */\n\t\trestPath?: string;\n\n\t\t/**\n\t\t * The options for the REST API route generation.\n\t\t */\n\t\trestOptions?: unknown;\n\n\t\t/**\n\t\t * The path for the socket API.\n\t\t */\n\t\tsocketPath?: string;\n\n\t\t/**\n\t\t * The options for the socket API route generation.\n\t\t */\n\t\tsocketOptions?: unknown;\n\t};\n"]}
+{"version":3,"file":"IEngineCoreTypeConfig.js","sourceRoot":"","sources":["../../../../src/models/config/IEngineCoreTypeConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEngineCoreTypeBaseConfig } from \"./IEngineCoreTypeBaseConfig.js\";\n\n/**\n * Configuration for the engine core type.\n */\nexport type IEngineCoreTypeConfig<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> =\n\tT & {\n\t\t/**\n\t\t * The instance type to override with.\n\t\t */\n\t\toverrideInstanceType?: string;\n\n\t\t/**\n\t\t * Whether this is the default instance.\n\t\t */\n\t\tisDefault?: boolean;\n\n\t\t/**\n\t\t * Whether this is a multi-instance component.\n\t\t */\n\t\tisMultiInstance?: boolean;\n\n\t\t/**\n\t\t * The features supported by this instance.\n\t\t */\n\t\tfeatures?: string[];\n\n\t\t/**\n\t\t * The path for the REST API.\n\t\t */\n\t\trestPath?: string;\n\n\t\t/**\n\t\t * The options for the REST API route generation.\n\t\t */\n\t\trestOptions?: unknown;\n\n\t\t/**\n\t\t * The path for the socket API.\n\t\t */\n\t\tsocketPath?: string;\n\n\t\t/**\n\t\t * The options for the socket API route generation.\n\t\t */\n\t\tsocketOptions?: unknown;\n\t};\n"]}

package/dist/es/models/engineTypeInitialiser.js.map

@@ -1 +1 @@
-{"version":3,"file":"engineTypeInitialiser.js","sourceRoot":"","sources":["../../../src/models/engineTypeInitialiser.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { Factory, IComponent } from \"@twin.org/core\";\nimport type { IEngineCoreTypeBaseConfig } from \"./config/IEngineCoreTypeBaseConfig.js\";\nimport type { IEngineCore } from \"./IEngineCore.js\";\nimport type { IEngineCoreContext } from \"./IEngineCoreContext.js\";\n\n/**\n * Method definition for the engine type initialiser.\n */\nexport type EngineTypeInitialiser<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> =\n\t(\n\t\tengineCore: IEngineCore,\n\t\tcontext: IEngineCoreContext,\n\t\tinstanceConfig: T\n\t) => Promise<EngineTypeInitialiserReturn>;\n\n/**\n * Engine type initialiser return type.\n */\nexport interface EngineTypeInitialiserReturn {\n\t/**\n\t * The instance type created.\n\t */\n\tinstanceType?: string;\n\n\t/**\n\t * The factory to store the instance in.\n\t */\n\tfactory?: Factory<unknown>;\n\n\t/**\n\t * The component created.\n\t */\n\tcomponent?: IComponent;\n}\n"]}
+{"version":3,"file":"engineTypeInitialiser.js","sourceRoot":"","sources":["../../../src/models/engineTypeInitialiser.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { Factory, IComponent } from \"@twin.org/core\";\nimport type { IEngineCoreTypeBaseConfig } from \"./config/IEngineCoreTypeBaseConfig.js\";\nimport type { IEngineCore } from \"./IEngineCore.js\";\nimport type { IEngineCoreContext } from \"./IEngineCoreContext.js\";\n\n/**\n * Method definition for the engine type initialiser.\n */\nexport type EngineTypeInitialiser<\n\tT extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig,\n\tF = Factory<unknown>\n> = (\n\tengineCore: IEngineCore,\n\tcontext: IEngineCoreContext,\n\tinstanceConfig: T\n) => EngineTypeInitialiserReturn<T, F>;\n\n/**\n * Engine type initialiser return type.\n */\nexport interface EngineTypeInitialiserReturn<\n\tT extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig,\n\tF = Factory<unknown>\n> {\n\t/**\n\t * The instance type created.\n\t */\n\tinstanceTypeName?: string;\n\n\t/**\n\t * The factory to store the instance in.\n\t */\n\tfactory?: F;\n\n\t/**\n\t * Create a new component.\n\t */\n\tcreateComponent?: (additionalConfig: T) => IComponent;\n}\n"]}

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

@@ -24,8 +24,9 @@ export interface IEngineCore<C extends IEngineCoreConfig = IEngineCoreConfig, S
     /**
      * Add a context ID key to the engine.
      * @param key The context ID key.
+     * @param componentFeatures The component features for the context ID handler.
      */
-    addContextIdKey(key: string): void;
+    addContextIdKey(key: string, componentFeatures: string[]): void;
     /**
      * Get the context ID keys for the engine.
      * @returns The context IDs keys.
@@ -44,9 +45,10 @@ export interface IEngineCore<C extends IEngineCoreConfig = IEngineCoreConfig, S
     getContextIds(): IContextIds | undefined;
     /**
      * Start the engine core.
-     * @returns True if the start was successful.
+     * @param skipComponentStart Should the component start be skipped.
+     * @returns Nothing.
      */
-    start(): Promise<boolean>;
+    start(skipComponentStart?: boolean): Promise<void>;
     /**
      * Stop the engine core.
      * @returns Nothing.
@@ -87,6 +89,10 @@ export interface IEngineCore<C extends IEngineCoreConfig = IEngineCoreConfig, S
      * @returns The state of the engine.
      */
     getState(): S;
+    /**
+     * Set the state to dirty so it gets saved.
+     */
+    setStateDirty(): void;
     /**
      * Get all the registered instances.
      * @returns The registered instances.
@@ -120,7 +126,8 @@ export interface IEngineCore<C extends IEngineCoreConfig = IEngineCoreConfig, S
     /**
      * Populate the engine from the clone data.
      * @param cloneData The clone data to populate from.
+     * @param contextIds The context IDs to use for the clone.
      * @param silent Should the clone be silent.
      */
-    populateClone(cloneData: IEngineCoreClone<C, S>, silent?: boolean): void;
+    populateClone(cloneData: IEngineCoreClone<C, S>, contextIds?: IContextIds, silent?: boolean): void;
 }

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

@@ -30,5 +30,8 @@ export interface IEngineCoreClone<C extends IEngineCoreConfig = IEngineCoreConfi
     /**
      * The context ID keys.
      */
-    contextIdKeys: string[];
+    contextIdKeys: {
+        key: string;
+        componentFeatures: string[];
+    }[];
 }

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

@@ -34,6 +34,6 @@ export interface IEngineCoreContext<C extends IEngineCoreConfig = IEngineCoreCon
     componentInstances: {
         instanceType: string;
         component: IComponent;
-        started: boolean;
+        initialised: boolean;
     }[];
 }

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

@@ -18,9 +18,9 @@ export interface IEngineServer {
     addSocketRouteGenerator(type: string, module: string, method: string): void;
     /**
      * Start the engine server.
-     * @returns True if the start was successful.
+     * @returns Nothing.
      */
-    start(): Promise<boolean>;
+    start(): Promise<void>;
     /**
      * Stop the engine server.
      * @returns Nothing.

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

@@ -11,6 +11,10 @@ export type IEngineCoreTypeConfig<T extends IEngineCoreTypeBaseConfig = IEngineC
      * Whether this is the default instance.
      */
     isDefault?: boolean;
+    /**
+     * Whether this is a multi-instance component.
+     */
+    isMultiInstance?: boolean;
     /**
      * The features supported by this instance.
      */

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

@@ -5,21 +5,21 @@ import type { IEngineCoreContext } from "./IEngineCoreContext.js";
 /**
  * Method definition for the engine type initialiser.
  */
-export type EngineTypeInitialiser<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> = (engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: T) => Promise<EngineTypeInitialiserReturn>;
+export type EngineTypeInitialiser<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig, F = Factory<unknown>> = (engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: T) => EngineTypeInitialiserReturn<T, F>;
 /**
  * Engine type initialiser return type.
  */
-export interface EngineTypeInitialiserReturn {
+export interface EngineTypeInitialiserReturn<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig, F = Factory<unknown>> {
     /**
      * The instance type created.
      */
-    instanceType?: string;
+    instanceTypeName?: string;
     /**
      * The factory to store the instance in.
      */
-    factory?: Factory<unknown>;
+    factory?: F;
     /**
-     * The component created.
+     * Create a new component.
      */
-    component?: IComponent;
+    createComponent?: (additionalConfig: T) => IComponent;
 }

package/docs/changelog.md

@@ -1,5 +1,166 @@
 # @twin.org/engine-models - Changelog
 
+## [0.0.3-next.21](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.20...engine-models-v0.0.3-next.21) (2026-02-13)
+
+
+### Features
+
+* multi instance component support ([#83](https://github.com/twinfoundation/engine/issues/83)) ([6012b50](https://github.com/twinfoundation/engine/commit/6012b50959df5af893f05516d42eea2e0800b31a))
+
+## [0.0.3-next.20](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.19...engine-models-v0.0.3-next.20) (2026-02-06)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.19](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.18...engine-models-v0.0.3-next.19) (2026-02-05)
+
+
+### Bug Fixes
+
+* pass contextIds to populateClone ([#79](https://github.com/twinfoundation/engine/issues/79)) ([b22f1bb](https://github.com/twinfoundation/engine/commit/b22f1bbf0319069914e316d27de4c2a8623421cf))
+
+## [0.0.3-next.18](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.17...engine-models-v0.0.3-next.18) (2026-02-04)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.17](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.16...engine-models-v0.0.3-next.17) (2026-02-02)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.16](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.15...engine-models-v0.0.3-next.16) (2026-01-28)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.15](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.14...engine-models-v0.0.3-next.15) (2026-01-26)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.14](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.13...engine-models-v0.0.3-next.14) (2026-01-19)
+
+
+### Features
+
+* add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
+* add context id features ([#51](https://github.com/twinfoundation/engine/issues/51)) ([eaef180](https://github.com/twinfoundation/engine/commit/eaef1807397a907bc7655ef1545a151a710ca2f1))
+* add engine type helper for config lookups ([a20a398](https://github.com/twinfoundation/engine/commit/a20a3987016c48351178ab8410bc05b0fba0f2c1))
+* add engine type helper for config lookups ([7d5eeef](https://github.com/twinfoundation/engine/commit/7d5eeefd3e7b9daab1ba20e2fb6b1ebfec178aec))
+* add isPrimary and isClone methods ([a7c63e9](https://github.com/twinfoundation/engine/commit/a7c63e97f54c95b104cc81e66d3fa42c6607bdc1))
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* add REST options for route construction ([4adf0af](https://github.com/twinfoundation/engine/commit/4adf0af8a03689a4dbdf67e8527d6db0d2c5d59d))
+* add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
+* add skipComponentStart flag ([#62](https://github.com/twinfoundation/engine/issues/62)) ([07e90af](https://github.com/twinfoundation/engine/commit/07e90afa4ba1baaa79c0c6f0f45200d781801534))
+* add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
+* add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
+* close already started components on startup error ([a55a117](https://github.com/twinfoundation/engine/commit/a55a117a508998288c8ae804e732fc6085cb22fa))
+* context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
+* eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
+* improve startup error handling ([#65](https://github.com/twinfoundation/engine/issues/65)) ([5b2d1c5](https://github.com/twinfoundation/engine/commit/5b2d1c539cf5484afa85e294d6d6c18f24ef8274))
+* maintain isDefault flag for registered instances ([2ac5bee](https://github.com/twinfoundation/engine/commit/2ac5bee094bef42b396cc82b0d18bb6aebe27352))
+* remove bootstrapped components, component should manage their own state ([5c7e9e4](https://github.com/twinfoundation/engine/commit/5c7e9e419ef26933e49c9c5a21a20a8961244e7f))
+* remove unused component states ([d56d648](https://github.com/twinfoundation/engine/commit/d56d6486119ea8b8501a33f9e3a3101a08b826ed))
+* simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
+* standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
+* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+
+### Bug Fixes
+
+* make sure stop is called even if start is not implemented ([ece2b9d](https://github.com/twinfoundation/engine/commit/ece2b9de5c6dff2b5ccf2a3115c1a7328a330125))
+
+## [0.0.3-next.13](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.12...engine-models-v0.0.3-next.13) (2026-01-19)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.12](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.11...engine-models-v0.0.3-next.12) (2026-01-19)
+
+
+### Features
+
+* improve startup error handling ([#65](https://github.com/twinfoundation/engine/issues/65)) ([5b2d1c5](https://github.com/twinfoundation/engine/commit/5b2d1c539cf5484afa85e294d6d6c18f24ef8274))
+
+## [0.0.3-next.11](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.10...engine-models-v0.0.3-next.11) (2026-01-16)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.10](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.9...engine-models-v0.0.3-next.10) (2026-01-13)
+
+
+### Features
+
+* add skipComponentStart flag ([#62](https://github.com/twinfoundation/engine/issues/62)) ([07e90af](https://github.com/twinfoundation/engine/commit/07e90afa4ba1baaa79c0c6f0f45200d781801534))
+
+## [0.0.3-next.9](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.8...engine-models-v0.0.3-next.9) (2026-01-07)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.8](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.7...engine-models-v0.0.3-next.8) (2026-01-06)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.7](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.6...engine-models-v0.0.3-next.7) (2025-12-04)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.6](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.5...engine-models-v0.0.3-next.6) (2025-11-28)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.5](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.4...engine-models-v0.0.3-next.5) (2025-11-20)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.3-next.4](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.3...engine-models-v0.0.3-next.4) (2025-11-20)
+
+
+### Features
+
+* context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
+
+## [0.0.3-next.3](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.2...engine-models-v0.0.3-next.3) (2025-11-14)
+
+
+### Bug Fixes
+
+* make sure stop is called even if start is not implemented ([ece2b9d](https://github.com/twinfoundation/engine/commit/ece2b9de5c6dff2b5ccf2a3115c1a7328a330125))
+
 ## [0.0.3-next.2](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.1...engine-models-v0.0.3-next.2) (2025-11-13)
 
 

package/docs/reference/interfaces/EngineTypeInitialiserReturn.md

@@ -1,12 +1,22 @@
-# 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?
 
-> `optional` **instanceType**: `string`
+> `optional` **instanceTypeName**: `string`
 
 The instance type created.
 
@@ -14,14 +24,24 @@ The instance type created.
 
 ### factory?
 
-> `optional` **factory**: `Factory`\<`unknown`\>
+> `optional` **factory**: `F`
 
 The factory to store the instance in.
 
 ***
 
-### component?
+### 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

@@ -70,7 +70,7 @@ The type config or undefined if not found.
 
 ### addContextIdKey()
 
-> **addContextIdKey**(`key`): `void`
+> **addContextIdKey**(`key`, `componentFeatures`): `void`
 
 Add a context ID key to the engine.
 
@@ -82,6 +82,12 @@ Add a context ID key to the engine.
 
 The context ID key.
 
+##### componentFeatures
+
+`string`[]
+
+The component features for the context ID handler.
+
 #### Returns
 
 `void`
@@ -144,15 +150,23 @@ The context IDs or undefined if none are set.
 
 ### 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.
 
 ***
 
@@ -280,6 +294,18 @@ The state of the engine.
 
 ***
 
+### setStateDirty()
+
+> **setStateDirty**(): `void`
+
+Set the state to dirty so it gets saved.
+
+#### Returns
+
+`void`
+
+***
+
 ### getRegisteredInstances()
 
 > **getRegisteredInstances**(): `object`
@@ -370,7 +396,7 @@ The clone data.
 
 ### populateClone()
 
-> **populateClone**(`cloneData`, `silent?`): `void`
+> **populateClone**(`cloneData`, `contextIds?`, `silent?`): `void`
 
 Populate the engine from the clone data.
 
@@ -382,6 +408,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

@@ -64,6 +64,14 @@ The entity schemas for the engine.
 
 ### contextIdKeys
 
-> **contextIdKeys**: `string`[]
+> **contextIdKeys**: `object`[]
 
 The context ID keys.
+
+#### key
+
+> **key**: `string`
+
+#### componentFeatures
+
+> **componentFeatures**: `string`[]

package/docs/reference/interfaces/IEngineCoreContext.md

@@ -65,6 +65,6 @@ The components.
 
 > **component**: `IComponent`
 
-#### started
+#### initialised
 
-> **started**: `boolean`
+> **initialised**: `boolean`

package/docs/reference/interfaces/IEngineServer.md

@@ -70,15 +70,15 @@ The method to call on the module.
 
 ### start()
 
-> **start**(): `Promise`\<`boolean`\>
+> **start**(): `Promise`\<`void`\>
 
 Start the engine server.
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`Promise`\<`void`\>
 
-True if the start was successful.
+Nothing.
 
 ***
 

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`\>

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

@@ -18,6 +18,12 @@ The instance type to override with.
 
 Whether this is the default instance.
 
+### isMultiInstance?
+
+> `optional` **isMultiInstance**: `boolean`
+
+Whether this is a multi-instance component.
+
 ### features?
 
 > `optional` **features**: `string`[]

package/package.json

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