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

package/dist/es/factories/engineCoreFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
+/**
+ * Factory for creating engine cores.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EngineCoreFactory = Factory.createFactory("engine-core");
+//# sourceMappingURL=engineCoreFactory.js.map

package/dist/es/factories/engineCoreFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engineCoreFactory.js","sourceRoot":"","sources":["../../../src/factories/engineCoreFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAc,aAAa,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IEngineCore } from \"../models/IEngineCore.js\";\n\n/**\n * Factory for creating engine cores.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EngineCoreFactory = Factory.createFactory<IEngineCore>(\"engine-core\");\n"]}

package/dist/es/factories/engineServerFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
+/**
+ * Factory for creating engine servers.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EngineServerFactory = Factory.createFactory("engine-server");
+//# sourceMappingURL=engineServerFactory.js.map

package/dist/es/factories/engineServerFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engineServerFactory.js","sourceRoot":"","sources":["../../../src/factories/engineServerFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAgB,eAAe,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IEngineServer } from \"../models/IEngineServer.js\";\n\n/**\n * Factory for creating engine servers.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EngineServerFactory = Factory.createFactory<IEngineServer>(\"engine-server\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,16 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/engineCoreFactory.js";
+export * from "./factories/engineServerFactory.js";
+export * from "./models/config/IEngineCoreConfig.js";
+export * from "./models/config/IEngineCoreTypeBaseConfig.js";
+export * from "./models/config/IEngineCoreTypeConfig.js";
+export * from "./models/config/IEngineModuleConfig.js";
+export * from "./models/engineTypeInitialiser.js";
+export * from "./models/IEngineCore.js";
+export * from "./models/IEngineCoreClone.js";
+export * from "./models/IEngineCoreContext.js";
+export * from "./models/IEngineServer.js";
+export * from "./models/IEngineState.js";
+export * from "./models/IEngineStateStorage.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,kCAAkC,CAAC;AACjD,cAAc,oCAAoC,CAAC;AACnD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,0CAA0C,CAAC;AACzD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/engineCoreFactory.js\";\nexport * from \"./factories/engineServerFactory.js\";\nexport * from \"./models/config/IEngineCoreConfig.js\";\nexport * from \"./models/config/IEngineCoreTypeBaseConfig.js\";\nexport * from \"./models/config/IEngineCoreTypeConfig.js\";\nexport * from \"./models/config/IEngineModuleConfig.js\";\nexport * from \"./models/engineTypeInitialiser.js\";\nexport * from \"./models/IEngineCore.js\";\nexport * from \"./models/IEngineCoreClone.js\";\nexport * from \"./models/IEngineCoreContext.js\";\nexport * from \"./models/IEngineServer.js\";\nexport * from \"./models/IEngineState.js\";\nexport * from \"./models/IEngineStateStorage.js\";\n"]}

package/dist/es/models/IEngineCore.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEngineCore.js.map

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

@@ -0,0 +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"]}

package/dist/es/models/IEngineCoreClone.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEngineCoreClone.js.map

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

@@ -0,0 +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"]}

package/dist/es/models/IEngineCoreContext.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEngineCoreContext.js.map

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

@@ -0,0 +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"]}

package/dist/es/models/IEngineServer.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEngineServer.js.map

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

@@ -0,0 +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"]}

package/dist/es/models/IEngineState.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEngineState.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEngineState.js","sourceRoot":"","sources":["../../../src/models/IEngineState.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The state of the engine.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface IEngineState {}\n"]}

package/dist/es/models/IEngineStateStorage.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEngineStateStorage.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEngineStateStorage.js","sourceRoot":"","sources":["../../../src/models/IEngineStateStorage.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEngineCore } from \"./IEngineCore.js\";\nimport type { IEngineState } from \"./IEngineState.js\";\n\n/**\n * Definition of state storage for engine.\n */\nexport interface IEngineStateStorage<S extends IEngineState = IEngineState> {\n\t/**\n\t * Method for loading the state.\n\t * @param engineCore The engine core to load the state for.\n\t * @returns The state of the engine or undefined if it doesn't exist.\n\t */\n\tload(engineCore: IEngineCore): Promise<S | undefined>;\n\n\t/**\n\t * Method for saving the state.\n\t * @param engineCore The engine core to save the state for.\n\t * @param state The state of the engine to save.\n\t * @returns Nothing.\n\t */\n\tsave(engineCore: IEngineCore, state: S): Promise<void>;\n}\n"]}

package/dist/es/models/config/IEngineCoreConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEngineCoreConfig.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEngineCoreConfig.js","sourceRoot":"","sources":["../../../../src/models/config/IEngineCoreConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEngineCoreTypeConfig } from \"./IEngineCoreTypeConfig.js\";\n\n/**\n * Configuration for the engine core.\n */\nexport interface IEngineCoreConfig {\n\t/**\n\t * Start the engine in debug mode.\n\t * @default false\n\t */\n\tdebug?: boolean;\n\n\t/**\n\t * Disable output to the console.\n\t * @default false\n\t */\n\tsilent?: boolean;\n\n\t/**\n\t * The types to initialise in the engine.\n\t */\n\ttypes: {\n\t\t[type: string]: IEngineCoreTypeConfig[] | undefined;\n\t};\n}\n"]}

package/dist/es/models/config/IEngineCoreTypeBaseConfig.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEngineCoreTypeBaseConfig.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEngineCoreTypeBaseConfig.js","sourceRoot":"","sources":["../../../../src/models/config/IEngineCoreTypeBaseConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the engine core type base.\n */\nexport interface IEngineCoreTypeBaseConfig<T = unknown> {\n\t/**\n\t * The type of the instance.\n\t */\n\ttype: string;\n\n\t/**\n\t * The options for the instance.\n\t */\n\toptions?: T;\n}\n"]}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEngineCoreTypeConfig.js.map

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

@@ -0,0 +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"]}

package/dist/es/models/config/IEngineModuleConfig.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEngineModuleConfig.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEngineModuleConfig.js","sourceRoot":"","sources":["../../../../src/models/config/IEngineModuleConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for an engine module.\n */\nexport interface IEngineModuleConfig {\n\t/**\n\t * The unique identifier for the module.\n\t */\n\tid: string;\n\n\t/**\n\t * The module that implements the additional component.\n\t */\n\tmoduleName: string;\n\n\t/**\n\t * The class name of the additional component.\n\t */\n\tclassName: string;\n\n\t/**\n\t * Additional dependencies required by the component.\n\t */\n\tdependencies?: {\n\t\tpropertyName: string;\n\t\tcomponentName: string;\n\t\tfeatures?: string[];\n\t\tisOptional?: boolean;\n\t}[];\n\n\t/**\n\t * Additional configuration for the component.\n\t */\n\tconfig?: unknown;\n}\n"]}

package/dist/es/models/engineTypeInitialiser.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=engineTypeInitialiser.js.map

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

@@ -0,0 +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"]}

package/dist/types/factories/engineCoreFactory.d.ts

@@ -1,6 +1,6 @@
 import { Factory } from "@twin.org/core";
-import type { IEngineCore } from "../models/IEngineCore";
+import type { IEngineCore } from "../models/IEngineCore.js";
 /**
  * Factory for creating engine cores.
  */
-export declare const EngineCoreFactory: Factory<IEngineCore<import("..").IEngineCoreConfig, import("..").IEngineState>>;
+export declare const EngineCoreFactory: Factory<IEngineCore<import("../index.js").IEngineCoreConfig, import("../index.js").IEngineState>>;

package/dist/types/factories/engineServerFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IEngineServer } from "../models/IEngineServer";
+import type { IEngineServer } from "../models/IEngineServer.js";
 /**
  * Factory for creating engine servers.
  */

package/dist/types/index.d.ts

@@ -1,12 +1,13 @@
-export * from "./factories/engineCoreFactory";
-export * from "./factories/engineServerFactory";
-export * from "./models/config/IEngineCoreConfig";
-export * from "./models/config/IEngineCoreTypeBaseConfig";
-export * from "./models/config/IEngineCoreTypeConfig";
-export * from "./models/engineTypeInitialiser";
-export * from "./models/IEngineCore";
-export * from "./models/IEngineCoreClone";
-export * from "./models/IEngineCoreContext";
-export * from "./models/IEngineServer";
-export * from "./models/IEngineState";
-export * from "./models/IEngineStateStorage";
+export * from "./factories/engineCoreFactory.js";
+export * from "./factories/engineServerFactory.js";
+export * from "./models/config/IEngineCoreConfig.js";
+export * from "./models/config/IEngineCoreTypeBaseConfig.js";
+export * from "./models/config/IEngineCoreTypeConfig.js";
+export * from "./models/config/IEngineModuleConfig.js";
+export * from "./models/engineTypeInitialiser.js";
+export * from "./models/IEngineCore.js";
+export * from "./models/IEngineCoreClone.js";
+export * from "./models/IEngineCoreContext.js";
+export * from "./models/IEngineServer.js";
+export * from "./models/IEngineState.js";
+export * from "./models/IEngineStateStorage.js";

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

@@ -1,8 +1,9 @@
+import type { IContextIds } from "@twin.org/context";
 import type { IError } from "@twin.org/core";
-import type { IEngineCoreConfig } from "./config/IEngineCoreConfig";
-import type { IEngineCoreTypeConfig } from "./config/IEngineCoreTypeConfig";
-import type { IEngineCoreClone } from "./IEngineCoreClone";
-import type { IEngineState } from "./IEngineState";
+import type { IEngineCoreConfig } from "./config/IEngineCoreConfig.js";
+import type { IEngineCoreTypeConfig } from "./config/IEngineCoreTypeConfig.js";
+import type { IEngineCoreClone } from "./IEngineCoreClone.js";
+import type { IEngineState } from "./IEngineState.js";
 /**
  * Interface describing the engine core methods.
  */
@@ -10,11 +11,37 @@ 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;
+    /**
+     * Add a context ID key to the engine.
+     * @param key The context ID key.
+     */
+    addContextIdKey(key: string): void;
+    /**
+     * Get the context ID keys for the engine.
+     * @returns The context IDs keys.
+     */
+    getContextIdKeys(): string[];
+    /**
+     * Add a context ID to the engine.
+     * @param key The context ID key.
+     * @param value The context ID value.
+     */
+    addContextId(key: string, value: string): void;
+    /**
+     * Get the context IDs for the engine.
+     * @returns The context IDs or undefined if none are set.
+     */
+    getContextIds(): IContextIds | undefined;
     /**
      * Start the engine core.
      * @returns True if the start was successful.

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

@@ -1,7 +1,6 @@
 import type { IEntitySchema } from "@twin.org/entity";
-import type { IEngineCoreConfig } from "./config/IEngineCoreConfig";
-import type { IEngineCoreTypeConfig } from "./config/IEngineCoreTypeConfig";
-import type { IEngineState } from "./IEngineState";
+import type { IEngineCoreConfig } from "./config/IEngineCoreConfig.js";
+import type { IEngineState } from "./IEngineState.js";
 /**
  * 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;
     }[];
@@ -30,7 +28,7 @@ export interface IEngineCoreClone<C extends IEngineCoreConfig = IEngineCoreConfi
         [schema: string]: IEntitySchema;
     };
     /**
-     * The logger type name.
+     * The context ID keys.
      */
-    loggerTypeName: string;
+    contextIdKeys: string[];
 }

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
-import type { IEngineCoreConfig } from "./config/IEngineCoreConfig";
-import type { IEngineState } from "./IEngineState";
+import type { IEngineCoreConfig } from "./config/IEngineCoreConfig.js";
+import type { IEngineState } from "./IEngineState.js";
 /**
  * The context for the engine core.
  */
@@ -24,6 +24,7 @@ export interface IEngineCoreContext<C extends IEngineCoreConfig = IEngineCoreCon
     registeredInstances: {
         [name: string]: {
             type: string;
+            isDefault?: boolean;
             features?: string[];
         }[];
     };
@@ -33,5 +34,6 @@ export interface IEngineCoreContext<C extends IEngineCoreConfig = IEngineCoreCon
     componentInstances: {
         instanceType: string;
         component: IComponent;
+        started: boolean;
     }[];
 }

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

@@ -2,8 +2,4 @@
  * The state of the engine.
  */
 export interface IEngineState {
-    /**
-     * The identity for the node.
-     */
-    nodeIdentity?: string;
 }

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

@@ -1,5 +1,5 @@
-import type { IEngineCore } from "./IEngineCore";
-import type { IEngineState } from "./IEngineState";
+import type { IEngineCore } from "./IEngineCore.js";
+import type { IEngineState } from "./IEngineState.js";
 /**
  * Definition of state storage for engine.
  */

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

@@ -1,4 +1,4 @@
-import type { IEngineCoreTypeConfig } from "./IEngineCoreTypeConfig";
+import type { IEngineCoreTypeConfig } from "./IEngineCoreTypeConfig.js";
 /**
  * Configuration for the engine core.
  */

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

@@ -1,12 +1,34 @@
-import type { IEngineCoreTypeBaseConfig } from "./IEngineCoreTypeBaseConfig";
+import type { IEngineCoreTypeBaseConfig } from "./IEngineCoreTypeBaseConfig.js";
 /**
  * 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 { IEngineCoreTypeBaseConfig } from "./config/IEngineCoreTypeBaseConfig";
-import type { IEngineCore } from "./IEngineCore";
-import type { IEngineCoreContext } from "./IEngineCoreContext";
+import type { Factory, IComponent } from "@twin.org/core";
+import type { IEngineCoreTypeBaseConfig } from "./config/IEngineCoreTypeBaseConfig.js";
+import type { IEngineCore } from "./IEngineCore.js";
+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, 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,158 @@
 # @twin.org/engine-models - Changelog
 
+## [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)
+
+
+### Features
+
+* close already started components on startup error ([a55a117](https://github.com/twinfoundation/engine/commit/a55a117a508998288c8ae804e732fc6085cb22fa))
+
+## [0.0.3-next.1](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.3-next.0...engine-models-v0.0.3-next.1) (2025-11-13)
+
+
+### 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 synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
+* add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
+* eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
+* 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))
+
+## [0.0.2-next.26](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.25...engine-models-v0.0.2-next.26) (2025-10-09)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.25](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.24...engine-models-v0.0.2-next.25) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
+
+## [0.0.2-next.24](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.23...engine-models-v0.0.2-next.24) (2025-10-08)
+
+
+### Features
+
+* maintain isDefault flag for registered instances ([2ac5bee](https://github.com/twinfoundation/engine/commit/2ac5bee094bef42b396cc82b0d18bb6aebe27352))
+
+## [0.0.2-next.23](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.22...engine-models-v0.0.2-next.23) (2025-10-07)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.22](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.21...engine-models-v0.0.2-next.22) (2025-10-07)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.2-next.21](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.2-next.20...engine-models-v0.0.2-next.21) (2025-10-07)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [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)
 
 

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,102 @@ 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.
+
+***
+
+### addContextIdKey()
+
+> **addContextIdKey**(`key`): `void`
+
+Add a context ID key to the engine.
+
+#### Parameters
+
+##### key
+
+`string`
+
+The context ID key.
+
+#### Returns
+
+`void`
+
+***
+
+### getContextIdKeys()
+
+> **getContextIdKeys**(): `string`[]
+
+Get the context ID keys for the engine.
+
+#### Returns
+
+`string`[]
+
+The context IDs keys.
+
+***
+
+### addContextId()
+
+> **addContextId**(`key`, `value`): `void`
+
+Add a context ID to the engine.
+
+#### Parameters
+
+##### key
+
+`string`
+
+The context ID key.
+
+##### value
+
+`string`
+
+The context ID value.
+
+#### Returns
+
+`void`
+
+***
+
+### getContextIds()
+
+> **getContextIds**(): `undefined` \| `IContextIds`
+
+Get the context IDs for the engine.
+
+#### Returns
+
+`undefined` \| `IContextIds`
+
+The context IDs or undefined if none are set.
+
+***
+
 ### start()
 
 > **start**(): `Promise`\<`boolean`\>

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`
@@ -66,8 +62,8 @@ The entity schemas for the engine.
 
 ***
 
-### loggerTypeName
+### contextIdKeys
 
-> **loggerTypeName**: `string`
+> **contextIdKeys**: `string`[]
 
-The logger type name.
+The context ID keys.

package/docs/reference/interfaces/IEngineCoreContext.md

@@ -64,3 +64,7 @@ The components.
 #### component
 
 > **component**: `IComponent`
+
+#### started
+
+> **started**: `boolean`

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

@@ -1,11 +1,3 @@
 # Interface: IEngineState
 
 The state of the engine.
-
-## Properties
-
-### nodeIdentity?
-
-> `optional` **nodeIdentity**: `string`
-
-The identity for the node.

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,22 +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.9",
+	"version": "0.0.3-next.2",
 	"description": "Models which define the structure of the engine.",
 	"repository": {
 		"type": "git",
@@ -14,25 +14,39 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"engine",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/engine/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,22 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating engine cores.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const EngineCoreFactory = core.Factory.createFactory("engine-core");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating engine servers.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const EngineServerFactory = core.Factory.createFactory("engine-server");
-
-exports.EngineCoreFactory = EngineCoreFactory;
-exports.EngineServerFactory = EngineServerFactory;

package/dist/esm/index.mjs

@@ -1,19 +0,0 @@
-import { Factory } from '@twin.org/core';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating engine cores.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const EngineCoreFactory = Factory.createFactory("engine-core");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating engine servers.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const EngineServerFactory = Factory.createFactory("engine-server");
-
-export { EngineCoreFactory, EngineServerFactory };