@twin.org/engine-models 0.0.1-next.30 → 0.0.1-next.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/docs/reference/interfaces/IEngineCore.md +24 -8
  2. package/docs/reference/interfaces/IEngineCoreClone.md +17 -1
  3. package/docs/reference/interfaces/IEngineCoreConfig.md +1 -1
  4. package/docs/reference/interfaces/IEngineCoreContext.md +9 -1
  5. package/docs/reference/interfaces/IEngineServer.md +24 -8
  6. package/docs/reference/interfaces/IEngineState.md +1 -1
  7. package/docs/reference/interfaces/IEngineStateStorage.md +9 -3
  8. package/docs/reference/type-aliases/EngineTypeInitialiser.md +12 -4
  9. package/docs/reference/type-aliases/IEngineCoreTypeConfig.md +1 -1
  10. package/docs/reference/variables/EngineCoreFactory.md +1 -1
  11. package/package.json +1 -1
package/docs/reference/interfaces/IEngineCore.md CHANGED
@@ -18,19 +18,27 @@ Add a type initialiser.
18
18
 
19
19
  #### Parameters
20
20
 
21
- • **type**: `string`
21
+ ##### type
22
+
23
+ `string`
22
24
 
23
25
  The type to add the initialiser for.
24
26
 
25
- • **typeConfig**: `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
27
+ ##### typeConfig
26
28
 
27
29
  The type config.
28
30
 
29
- • **module**: `string`
31
+ `undefined` | [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
32
+
33
+ ##### module
34
+
35
+ `string`
30
36
 
31
37
  The name of the module which contains the initialiser method.
32
38
 
33
- • **method**: `string`
39
+ ##### method
40
+
41
+ `string`
34
42
 
35
43
  The name of the method to call.
36
44
 
@@ -76,7 +84,9 @@ Log info.
76
84
 
77
85
  #### Parameters
78
86
 
79
- • **message**: `string`
87
+ ##### message
88
+
89
+ `string`
80
90
 
81
91
  The message to log.
82
92
 
@@ -94,7 +104,9 @@ Log error.
94
104
 
95
105
  #### Parameters
96
106
 
97
- • **error**: `IError`
107
+ ##### error
108
+
109
+ `IError`
98
110
 
99
111
  The error to log.
100
112
 
@@ -168,11 +180,15 @@ Populate the engine from the clone data.
168
180
 
169
181
  #### Parameters
170
182
 
171
- • **cloneData**: [`IEngineCoreClone`](IEngineCoreClone.md)\<`C`, `S`\>
183
+ ##### cloneData
184
+
185
+ [`IEngineCoreClone`](IEngineCoreClone.md)\<`C`, `S`\>
172
186
 
173
187
  The clone data to populate from.
174
188
 
175
- • **silent?**: `boolean`
189
+ ##### silent?
190
+
191
+ `boolean`
176
192
 
177
193
  Should the clone be silent.
178
194
 
package/docs/reference/interfaces/IEngineCoreClone.md CHANGED
@@ -32,6 +32,22 @@ The state of the engine.
32
32
 
33
33
  The type initialisers for the engine.
34
34
 
35
+ #### type
36
+
37
+ > **type**: `string`
38
+
39
+ #### typeConfig
40
+
41
+ > **typeConfig**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
42
+
43
+ #### module
44
+
45
+ > **module**: `string`
46
+
47
+ #### method
48
+
49
+ > **method**: `string`
50
+
35
51
  ***
36
52
 
37
53
  ### entitySchemas
@@ -42,7 +58,7 @@ The entity schemas for the engine.
42
58
 
43
59
  #### Index Signature
44
60
 
45
- \[`schema`: `string`\]: `IEntitySchema`
61
+ \[`schema`: `string`\]: `IEntitySchema`
46
62
 
47
63
  ***
48
64
 
package/docs/reference/interfaces/IEngineCoreConfig.md CHANGED
@@ -40,4 +40,4 @@ The types to initialise in the engine.
40
40
 
41
41
  #### Index Signature
42
42
 
43
- \[`type`: `string`\]: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[] \| `undefined`
43
+ \[`type`: `string`\]: `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
package/docs/reference/interfaces/IEngineCoreContext.md CHANGED
@@ -42,7 +42,7 @@ The default types to use when components don't have custom types.
42
42
 
43
43
  #### Index Signature
44
44
 
45
- \[`type`: `string`\]: `string`
45
+ \[`type`: `string`\]: `string`
46
46
 
47
47
  ***
48
48
 
@@ -51,3 +51,11 @@ The default types to use when components don't have custom types.
51
51
  > **componentInstances**: `object`[]
52
52
 
53
53
  The components.
54
+
55
+ #### instanceType
56
+
57
+ > **instanceType**: `string`
58
+
59
+ #### component
60
+
61
+ > **component**: `IComponent`
package/docs/reference/interfaces/IEngineServer.md CHANGED
@@ -12,19 +12,27 @@ Add a REST route generator.
12
12
 
13
13
  #### Parameters
14
14
 
15
- • **type**: `string`
15
+ ##### type
16
+
17
+ `string`
16
18
 
17
19
  The type to add the generator for.
18
20
 
19
- • **typeConfig**: `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
21
+ ##### typeConfig
20
22
 
21
23
  The type config.
22
24
 
23
- • **module**: `string`
25
+ `undefined` | [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
26
+
27
+ ##### module
28
+
29
+ `string`
24
30
 
25
31
  The module containing the generator.
26
32
 
27
- • **method**: `string`
33
+ ##### method
34
+
35
+ `string`
28
36
 
29
37
  The method to call on the module.
30
38
 
@@ -42,19 +50,27 @@ Add a socket route generator.
42
50
 
43
51
  #### Parameters
44
52
 
45
- • **type**: `string`
53
+ ##### type
54
+
55
+ `string`
46
56
 
47
57
  The type to add the generator for.
48
58
 
49
- • **typeConfig**: `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
59
+ ##### typeConfig
50
60
 
51
61
  The type config.
52
62
 
53
- • **module**: `string`
63
+ `undefined` | [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
64
+
65
+ ##### module
66
+
67
+ `string`
54
68
 
55
69
  The module containing the generator.
56
70
 
57
- • **method**: `string`
71
+ ##### method
72
+
73
+ `string`
58
74
 
59
75
  The method to call on the module.
60
76
 
package/docs/reference/interfaces/IEngineState.md CHANGED
@@ -28,4 +28,4 @@ The component states.
28
28
 
29
29
  #### Index Signature
30
30
 
31
- \[`component`: `string`\]: `object`
31
+ \[`component`: `string`\]: `object`
package/docs/reference/interfaces/IEngineStateStorage.md CHANGED
@@ -16,7 +16,9 @@ Method for loading the state.
16
16
 
17
17
  #### Parameters
18
18
 
19
- • **engineCore**: [`IEngineCore`](IEngineCore.md)\<[`IEngineCoreConfig`](IEngineCoreConfig.md), [`IEngineState`](IEngineState.md)\>
19
+ ##### engineCore
20
+
21
+ [`IEngineCore`](IEngineCore.md)
20
22
 
21
23
  The engine core to load the state for.
22
24
 
@@ -36,11 +38,15 @@ Method for saving the state.
36
38
 
37
39
  #### Parameters
38
40
 
39
- • **engineCore**: [`IEngineCore`](IEngineCore.md)\<[`IEngineCoreConfig`](IEngineCoreConfig.md), [`IEngineState`](IEngineState.md)\>
41
+ ##### engineCore
42
+
43
+ [`IEngineCore`](IEngineCore.md)
40
44
 
41
45
  The engine core to save the state for.
42
46
 
43
- • **state**: `S`
47
+ ##### state
48
+
49
+ `S`
44
50
 
45
51
  The state of the engine to save.
46
52
 
package/docs/reference/type-aliases/EngineTypeInitialiser.md CHANGED
@@ -10,13 +10,21 @@ Method definition for the engine type initialiser.
10
10
 
11
11
  ## Parameters
12
12
 
13
- • **engineCore**: [`IEngineCore`](../interfaces/IEngineCore.md)
13
+ ### engineCore
14
14
 
15
- • **context**: [`IEngineCoreContext`](../interfaces/IEngineCoreContext.md)
15
+ [`IEngineCore`](../interfaces/IEngineCore.md)
16
16
 
17
- • **instanceConfig**: `T`
17
+ ### context
18
18
 
19
- • **overrideInstanceType?**: `string`
19
+ [`IEngineCoreContext`](../interfaces/IEngineCoreContext.md)
20
+
21
+ ### instanceConfig
22
+
23
+ `T`
24
+
25
+ ### overrideInstanceType?
26
+
27
+ `string`
20
28
 
21
29
  ## Returns
22
30
 
package/docs/reference/type-aliases/IEngineCoreTypeConfig.md CHANGED
@@ -16,4 +16,4 @@ Configuration for the engine core type.
16
16
 
17
17
  ## Type Parameters
18
18
 
19
- • **T** *extends* [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md) = `object`
19
+ • **T** *extends* [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md) = \{ `type`: `string`; \}
package/docs/reference/variables/EngineCoreFactory.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Variable: EngineCoreFactory
2
2
 
3
- > `const` **EngineCoreFactory**: `Factory`\<[`IEngineCore`](../interfaces/IEngineCore.md)\<[`IEngineCoreConfig`](../interfaces/IEngineCoreConfig.md), [`IEngineState`](../interfaces/IEngineState.md)\>\>
3
+ > `const` **EngineCoreFactory**: `Factory`\<[`IEngineCore`](../interfaces/IEngineCore.md)\>
4
4
 
5
5
  Factory for creating engine cores.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/engine-models",
3
- "version": "0.0.1-next.30",
3
+ "version": "0.0.1-next.32",
4
4
  "description": "Models which define the structure of the engine.",
5
5
  "repository": {
6
6
  "type": "git",