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

package/dist/types/index.d.ts

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

package/dist/types/models/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

@@ -4,4 +4,4 @@ import type { IEngineCoreContext } from "./IEngineCoreContext";
 /**
  * Method definition for the engine type initialiser.
  */
-export type EngineTypeInitialiser<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> = (engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: T, overrideInstanceType?: string) => string | undefined;
+export type EngineTypeInitialiser<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> = (engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: T, overrideInstanceType?: string) => Promise<string | undefined>;

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/engine-models - Changelog
 
+## [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)
 
 

package/docs/reference/index.md

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

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/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`, `overrideInstanceType?`) => `Promise`\<`string` \| `undefined`\>
 
 Method definition for the engine type initialiser.
 
@@ -30,4 +30,4 @@ Method definition for the engine type initialiser.
 
 ## Returns
 
-`string` \| `undefined`
+`Promise`\<`string` \| `undefined`\>

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

@@ -4,7 +4,7 @@
 
 Configuration for the engine core type.
 
-## Type declaration
+## Type Declaration
 
 ### overrideInstanceType?
 

package/package.json

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