@twin.org/engine-models 0.0.1-next.1 → 0.0.1-next.2

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

@@ -3,4 +3,4 @@ import type { IEngineCore } from "../models/IEngineCore";
 /**
  * Factory for creating engine cores.
  */
-export declare const EngineCoreFactory: Factory<IEngineCore>;
+export declare const EngineCoreFactory: Factory<IEngineCore<import("..").IEngineState>>;

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

@@ -7,7 +7,7 @@ import type { IEngineState } from "./IEngineState";
 /**
  * Interface describing the engine core methods.
  */
-export interface IEngineCore {
+export interface IEngineCore<S extends IEngineState = IEngineState> {
     /**
      * Add a type initialiser.
      * @param type The type to add the initialiser for.
@@ -44,7 +44,7 @@ export interface IEngineCore {
      * Get the state of the engine.
      * @returns The state of the engine.
      */
-    getState(): IEngineState;
+    getState(): S;
     /**
      * Get the types for the component.
      * @returns The default types.

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

@@ -4,7 +4,7 @@ import type { IEngineState } from "./IEngineState";
 /**
  * The context for the engine core.
  */
-export interface IEngineCoreContext {
+export interface IEngineCoreContext<S extends IEngineState = IEngineState> {
     /**
      * The engine core config.
      */
@@ -12,7 +12,7 @@ export interface IEngineCoreContext {
     /**
      * The engine core state.
      */
-    state: IEngineState;
+    state: S;
     /**
      * The state dirty flag, which flags that the state needs saving.
      */

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

@@ -3,18 +3,18 @@ import type { IEngineState } from "./IEngineState";
 /**
  * Definition of state storage for engine.
  */
-export interface IEngineStateStorage {
+export interface IEngineStateStorage<S extends IEngineState = IEngineState> {
     /**
      * Method for loading the state.
      * @param engineCore The engine core to load the state for.
      * @returns The state of the engine or undefined if it doesn't exist.
      */
-    load(engineCore: IEngineCore): Promise<IEngineState | undefined>;
+    load(engineCore: IEngineCore): Promise<S | undefined>;
     /**
      * Method for saving the state.
      * @param engineCore The engine core to save the state for.
      * @param state The state of the engine to save.
      * @returns Nothing.
      */
-    save(engineCore: IEngineCore, state: IEngineState): Promise<void>;
+    save(engineCore: IEngineCore, state: S): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/engine-models - Changelog
 
-## v0.0.1-next.1
+## v0.0.1-next.2
 
 - Initial Release

package/docs/reference/interfaces/IEngineCore.md

@@ -1,7 +1,11 @@
-# Interface: IEngineCore
+# Interface: IEngineCore\<S\>
 
 Interface describing the engine core methods.
 
+## Type Parameters
+
+• **S** *extends* [`IEngineState`](IEngineState.md) = [`IEngineState`](IEngineState.md)
+
 ## Methods
 
 ### addTypeInitialiser()
@@ -114,13 +118,13 @@ The config for the engine.
 
 ### getState()
 
-> **getState**(): [`IEngineState`](IEngineState.md)
+> **getState**(): `S`
 
 Get the state of the engine.
 
 #### Returns
 
-[`IEngineState`](IEngineState.md)
+`S`
 
 The state of the engine.
 

package/docs/reference/interfaces/IEngineCoreContext.md

@@ -1,7 +1,11 @@
-# Interface: IEngineCoreContext
+# Interface: IEngineCoreContext\<S\>
 
 The context for the engine core.
 
+## Type Parameters
+
+• **S** *extends* [`IEngineState`](IEngineState.md) = [`IEngineState`](IEngineState.md)
+
 ## Properties
 
 ### config
@@ -14,7 +18,7 @@ The engine core config.
 
 ### state
 
-> **state**: [`IEngineState`](IEngineState.md)
+> **state**: `S`
 
 The engine core state.
 

package/docs/reference/interfaces/IEngineStateStorage.md

@@ -1,24 +1,28 @@
-# Interface: IEngineStateStorage
+# Interface: IEngineStateStorage\<S\>
 
 Definition of state storage for engine.
 
+## Type Parameters
+
+• **S** *extends* [`IEngineState`](IEngineState.md) = [`IEngineState`](IEngineState.md)
+
 ## Methods
 
 ### load()
 
-> **load**(`engineCore`): `Promise`\<`undefined` \| [`IEngineState`](IEngineState.md)\>
+> **load**(`engineCore`): `Promise`\<`undefined` \| `S`\>
 
 Method for loading the state.
 
 #### Parameters
 
-• **engineCore**: [`IEngineCore`](IEngineCore.md)
+• **engineCore**: [`IEngineCore`](IEngineCore.md)\<[`IEngineState`](IEngineState.md)\>
 
 The engine core to load the state for.
 
 #### Returns
 
-`Promise`\<`undefined` \| [`IEngineState`](IEngineState.md)\>
+`Promise`\<`undefined` \| `S`\>
 
 The state of the engine or undefined if it doesn't exist.
 
@@ -32,11 +36,11 @@ Method for saving the state.
 
 #### Parameters
 
-• **engineCore**: [`IEngineCore`](IEngineCore.md)
+• **engineCore**: [`IEngineCore`](IEngineCore.md)\<[`IEngineState`](IEngineState.md)\>
 
 The engine core to save the state for.
 
-• **state**: [`IEngineState`](IEngineState.md)
+• **state**: `S`
 
 The state of the engine to save.
 

package/docs/reference/variables/EngineCoreFactory.md

@@ -1,5 +1,5 @@
 # Variable: EngineCoreFactory
 
-> `const` **EngineCoreFactory**: `Factory`\<[`IEngineCore`](../interfaces/IEngineCore.md)\>
+> `const` **EngineCoreFactory**: `Factory`\<[`IEngineCore`](../interfaces/IEngineCore.md)\<[`IEngineState`](../interfaces/IEngineState.md)\>\>
 
 Factory for creating engine cores.

package/package.json

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