@twin.org/engine-models 0.0.2-next.16 → 0.0.2-next.18
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.
|
@@ -2,11 +2,33 @@ import type { IEngineCoreTypeBaseConfig } from "./IEngineCoreTypeBaseConfig";
|
|
|
2
2
|
/**
|
|
3
3
|
* Configuration for the engine core type.
|
|
4
4
|
*/
|
|
5
|
-
export type IEngineCoreTypeConfig<T extends IEngineCoreTypeBaseConfig = {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
export type IEngineCoreTypeConfig<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> = T & {
|
|
6
|
+
/**
|
|
7
|
+
* The instance type to override with.
|
|
8
|
+
*/
|
|
9
9
|
overrideInstanceType?: string;
|
|
10
|
+
/**
|
|
11
|
+
* Whether this is the default instance.
|
|
12
|
+
*/
|
|
10
13
|
isDefault?: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* The features supported by this instance.
|
|
16
|
+
*/
|
|
11
17
|
features?: string[];
|
|
18
|
+
/**
|
|
19
|
+
* The path for the REST API.
|
|
20
|
+
*/
|
|
21
|
+
restPath?: string;
|
|
22
|
+
/**
|
|
23
|
+
* The options for the REST API route generation.
|
|
24
|
+
*/
|
|
25
|
+
restOptions?: unknown;
|
|
26
|
+
/**
|
|
27
|
+
* The path for the socket API.
|
|
28
|
+
*/
|
|
29
|
+
socketPath?: string;
|
|
30
|
+
/**
|
|
31
|
+
* The options for the socket API route generation.
|
|
32
|
+
*/
|
|
33
|
+
socketOptions?: unknown;
|
|
12
34
|
};
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# @twin.org/engine-models - Changelog
|
|
2
2
|
|
|
3
|
+
## [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)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
|
|
9
|
+
|
|
10
|
+
## [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)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* add engine type helper for config lookups ([a20a398](https://github.com/twinfoundation/engine/commit/a20a3987016c48351178ab8410bc05b0fba0f2c1))
|
|
16
|
+
* add REST options for route construction ([4adf0af](https://github.com/twinfoundation/engine/commit/4adf0af8a03689a4dbdf67e8527d6db0d2c5d59d))
|
|
17
|
+
|
|
3
18
|
## [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)
|
|
4
19
|
|
|
5
20
|
|
|
@@ -10,16 +10,46 @@ Configuration for the engine core type.
|
|
|
10
10
|
|
|
11
11
|
> `optional` **overrideInstanceType**: `string`
|
|
12
12
|
|
|
13
|
+
The instance type to override with.
|
|
14
|
+
|
|
13
15
|
### isDefault?
|
|
14
16
|
|
|
15
17
|
> `optional` **isDefault**: `boolean`
|
|
16
18
|
|
|
19
|
+
Whether this is the default instance.
|
|
20
|
+
|
|
17
21
|
### features?
|
|
18
22
|
|
|
19
23
|
> `optional` **features**: `string`[]
|
|
20
24
|
|
|
25
|
+
The features supported by this instance.
|
|
26
|
+
|
|
27
|
+
### restPath?
|
|
28
|
+
|
|
29
|
+
> `optional` **restPath**: `string`
|
|
30
|
+
|
|
31
|
+
The path for the REST API.
|
|
32
|
+
|
|
33
|
+
### restOptions?
|
|
34
|
+
|
|
35
|
+
> `optional` **restOptions**: `unknown`
|
|
36
|
+
|
|
37
|
+
The options for the REST API route generation.
|
|
38
|
+
|
|
39
|
+
### socketPath?
|
|
40
|
+
|
|
41
|
+
> `optional` **socketPath**: `string`
|
|
42
|
+
|
|
43
|
+
The path for the socket API.
|
|
44
|
+
|
|
45
|
+
### socketOptions?
|
|
46
|
+
|
|
47
|
+
> `optional` **socketOptions**: `unknown`
|
|
48
|
+
|
|
49
|
+
The options for the socket API route generation.
|
|
50
|
+
|
|
21
51
|
## Type Parameters
|
|
22
52
|
|
|
23
53
|
### T
|
|
24
54
|
|
|
25
|
-
`T` *extends* [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md) =
|
|
55
|
+
`T` *extends* [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md) = [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md)
|