@twin.org/engine-server 0.0.1-next.9 → 0.0.2-next.1
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.
- package/dist/cjs/index.cjs +198 -444
- package/dist/esm/index.mjs +197 -444
- package/dist/types/engineServer.d.ts +23 -15
- package/dist/types/index.d.ts +1 -2
- package/dist/types/utils/engineServerConfigHelper.d.ts +11 -0
- package/docs/changelog.md +401 -1
- package/docs/reference/classes/EngineServer.md +79 -31
- package/docs/reference/functions/addDefaultRestPaths.md +17 -0
- package/docs/reference/functions/addDefaultSocketPaths.md +17 -0
- package/docs/reference/index.md +2 -5
- package/package.json +8 -68
- package/dist/types/components/authentication.d.ts +0 -11
- package/dist/types/components/information.d.ts +0 -11
- package/dist/types/components/mimeTypeProcessor.d.ts +0 -11
- package/dist/types/components/restRouteProcessor.d.ts +0 -11
- package/dist/types/components/socketRouteProcessor.d.ts +0 -11
- package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +0 -41
- package/dist/types/utils/engineServerEnvBuilder.d.ts +0 -11
- package/docs/reference/functions/buildEngineServerConfiguration.md +0 -25
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +0 -75
|
@@ -1,45 +1,53 @@
|
|
|
1
|
-
import
|
|
1
|
+
import type { IRestRoute, ISocketRoute } from "@twin.org/api-models";
|
|
2
|
+
import type { IEngineCore, IEngineCoreTypeConfig, IEngineServer } from "@twin.org/engine-models";
|
|
3
|
+
import { type IEngineServerConfig } from "@twin.org/engine-server-types";
|
|
2
4
|
/**
|
|
3
5
|
* Server for the engine.
|
|
4
6
|
*/
|
|
5
|
-
export declare class EngineServer implements IEngineServer {
|
|
7
|
+
export declare class EngineServer<T extends IEngineServerConfig = IEngineServerConfig> implements IEngineServer {
|
|
6
8
|
/**
|
|
7
9
|
* Runtime name for the class.
|
|
8
10
|
*/
|
|
9
11
|
readonly CLASS_NAME: string;
|
|
10
|
-
/**
|
|
11
|
-
* The server config.
|
|
12
|
-
*/
|
|
13
|
-
protected readonly _config: IEngineServerConfig;
|
|
14
12
|
/**
|
|
15
13
|
* Create a new instance of EngineServer.
|
|
16
14
|
* @param options The options for the engine.
|
|
17
|
-
* @param options.server The server options for the engine.
|
|
18
15
|
* @param options.engineCore The engine core to serve from.
|
|
19
16
|
*/
|
|
20
17
|
constructor(options: {
|
|
21
|
-
engineCore: IEngineCore
|
|
22
|
-
server?: IEngineServerConfig;
|
|
18
|
+
engineCore: IEngineCore<T>;
|
|
23
19
|
});
|
|
24
20
|
/**
|
|
25
21
|
* Add a REST route generator.
|
|
26
22
|
* @param type The type to add the generator for.
|
|
27
23
|
* @param typeConfig The type config.
|
|
28
|
-
* @param
|
|
24
|
+
* @param module The module containing the generator.
|
|
25
|
+
* @param method The method to call on the module.
|
|
29
26
|
*/
|
|
30
|
-
addRestRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined,
|
|
27
|
+
addRestRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, module: string, method: string): void;
|
|
31
28
|
/**
|
|
32
29
|
* Add a socket route generator.
|
|
33
30
|
* @param type The type to add the generator for.
|
|
34
31
|
* @param typeConfig The type config.
|
|
35
|
-
* @param
|
|
32
|
+
* @param module The module containing the generator.
|
|
33
|
+
* @param method The method to call on the module.
|
|
34
|
+
*/
|
|
35
|
+
addSocketRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, module: string, method: string): void;
|
|
36
|
+
/**
|
|
37
|
+
* Get the built REST routes.
|
|
38
|
+
* @returns The REST routes.
|
|
36
39
|
*/
|
|
37
|
-
|
|
40
|
+
getRestRoutes(): IRestRoute[];
|
|
41
|
+
/**
|
|
42
|
+
* Get the built socket routes.
|
|
43
|
+
* @returns The socket routes.
|
|
44
|
+
*/
|
|
45
|
+
getSocketRoutes(): ISocketRoute[];
|
|
38
46
|
/**
|
|
39
47
|
* Start the engine server.
|
|
40
|
-
* @returns
|
|
48
|
+
* @returns True if the start was successful.
|
|
41
49
|
*/
|
|
42
|
-
start(): Promise<
|
|
50
|
+
start(): Promise<boolean>;
|
|
43
51
|
/**
|
|
44
52
|
* Stop the engine server.
|
|
45
53
|
* @returns Nothing.
|
package/dist/types/index.d.ts
CHANGED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { IEngineServerConfig } from "@twin.org/engine-server-types";
|
|
2
|
+
/**
|
|
3
|
+
* Adds the rest paths to the server config.
|
|
4
|
+
* @param serverConfig The server config.
|
|
5
|
+
*/
|
|
6
|
+
export declare function addDefaultRestPaths(serverConfig: IEngineServerConfig): void;
|
|
7
|
+
/**
|
|
8
|
+
* Adds the socket paths to the server config.
|
|
9
|
+
* @param serverConfig The server config.
|
|
10
|
+
*/
|
|
11
|
+
export declare function addDefaultSocketPaths(serverConfig: IEngineServerConfig): void;
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,405 @@
|
|
|
1
1
|
# @twin.org/engine-server - Changelog
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## [0.0.2-next.1](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.2-next.0...engine-server-v0.0.2-next.1) (2025-07-11)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
|
|
9
|
+
* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
|
|
10
|
+
* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
|
|
11
|
+
* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
|
|
12
|
+
* expose default rest and socket path creation ([e6c6e26](https://github.com/twinfoundation/engine/commit/e6c6e266c8017212a74d4997e2e335347457a2bc))
|
|
13
|
+
* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
|
|
14
|
+
* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
|
|
15
|
+
* move environment variable processing to node level ([2223c12](https://github.com/twinfoundation/engine/commit/2223c12f49f3d34051ecec9687351aa5dd094e54))
|
|
16
|
+
* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
|
|
17
|
+
* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Bug Fixes
|
|
21
|
+
|
|
22
|
+
* method docs ([fb3d73f](https://github.com/twinfoundation/engine/commit/fb3d73fa9e71ab392378fe7bad7a3677e5e7b132))
|
|
23
|
+
* use abbreviated docs path ([9258a72](https://github.com/twinfoundation/engine/commit/9258a72adf266ddcc4f98002a07a7a162755f24b))
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* The following workspace dependencies were updated
|
|
29
|
+
* dependencies
|
|
30
|
+
* @twin.org/engine-core bumped from 0.0.2-next.0 to 0.0.2-next.1
|
|
31
|
+
* @twin.org/engine-models bumped from 0.0.2-next.0 to 0.0.2-next.1
|
|
32
|
+
* @twin.org/engine-server-types bumped from 0.0.2-next.0 to 0.0.2-next.1
|
|
33
|
+
* devDependencies
|
|
34
|
+
* @twin.org/engine bumped from 0.0.2-next.0 to 0.0.2-next.1
|
|
35
|
+
|
|
36
|
+
## 0.0.1 (2025-07-11)
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### Features
|
|
40
|
+
|
|
41
|
+
* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
|
|
42
|
+
* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
|
|
43
|
+
* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
|
|
44
|
+
* expose default rest and socket path creation ([e6c6e26](https://github.com/twinfoundation/engine/commit/e6c6e266c8017212a74d4997e2e335347457a2bc))
|
|
45
|
+
* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
|
|
46
|
+
* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
|
|
47
|
+
* move environment variable processing to node level ([2223c12](https://github.com/twinfoundation/engine/commit/2223c12f49f3d34051ecec9687351aa5dd094e54))
|
|
48
|
+
* release to production ([3a4acd1](https://github.com/twinfoundation/engine/commit/3a4acd1f6c66b841d80b6fd3bc1a439a77148fa5))
|
|
49
|
+
* release to production ([5559958](https://github.com/twinfoundation/engine/commit/5559958e2128e6ec3a81e779d1ebd3f370bbb081))
|
|
50
|
+
* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
|
|
51
|
+
* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### Bug Fixes
|
|
55
|
+
|
|
56
|
+
* method docs ([fb3d73f](https://github.com/twinfoundation/engine/commit/fb3d73fa9e71ab392378fe7bad7a3677e5e7b132))
|
|
57
|
+
* use abbreviated docs path ([9258a72](https://github.com/twinfoundation/engine/commit/9258a72adf266ddcc4f98002a07a7a162755f24b))
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### Dependencies
|
|
61
|
+
|
|
62
|
+
* The following workspace dependencies were updated
|
|
63
|
+
* dependencies
|
|
64
|
+
* @twin.org/engine-core bumped from 0.0.1-next.84 to 0.0.1
|
|
65
|
+
* @twin.org/engine-models bumped from 0.0.1-next.84 to 0.0.1
|
|
66
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.84 to 0.0.1
|
|
67
|
+
* devDependencies
|
|
68
|
+
* @twin.org/engine bumped from 0.0.1-next.84 to 0.0.1
|
|
69
|
+
|
|
70
|
+
## [0.0.1-next.84](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.83...engine-server-v0.0.1-next.84) (2025-07-11)
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
### Features
|
|
74
|
+
|
|
75
|
+
* move environment variable processing to node level ([2223c12](https://github.com/twinfoundation/engine/commit/2223c12f49f3d34051ecec9687351aa5dd094e54))
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
### Dependencies
|
|
79
|
+
|
|
80
|
+
* The following workspace dependencies were updated
|
|
81
|
+
* dependencies
|
|
82
|
+
* @twin.org/engine-core bumped from 0.0.1-next.83 to 0.0.1-next.84
|
|
83
|
+
* @twin.org/engine-models bumped from 0.0.1-next.83 to 0.0.1-next.84
|
|
84
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.83 to 0.0.1-next.84
|
|
85
|
+
* devDependencies
|
|
86
|
+
* @twin.org/engine bumped from 0.0.1-next.83 to 0.0.1-next.84
|
|
87
|
+
|
|
88
|
+
## [0.0.1-next.83](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.82...engine-server-v0.0.1-next.83) (2025-07-10)
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### Features
|
|
92
|
+
|
|
93
|
+
* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
|
|
94
|
+
* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
|
|
95
|
+
* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
|
|
96
|
+
* expose default rest and socket path creation ([e6c6e26](https://github.com/twinfoundation/engine/commit/e6c6e266c8017212a74d4997e2e335347457a2bc))
|
|
97
|
+
* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
|
|
98
|
+
* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
|
|
99
|
+
* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
|
|
100
|
+
* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Bug Fixes
|
|
104
|
+
|
|
105
|
+
* method docs ([fb3d73f](https://github.com/twinfoundation/engine/commit/fb3d73fa9e71ab392378fe7bad7a3677e5e7b132))
|
|
106
|
+
* use abbreviated docs path ([9258a72](https://github.com/twinfoundation/engine/commit/9258a72adf266ddcc4f98002a07a7a162755f24b))
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
### Dependencies
|
|
110
|
+
|
|
111
|
+
* The following workspace dependencies were updated
|
|
112
|
+
* dependencies
|
|
113
|
+
* @twin.org/engine-core bumped from 0.0.1-next.81 to 0.0.1-next.83
|
|
114
|
+
* @twin.org/engine-models bumped from 0.0.1-next.81 to 0.0.1-next.83
|
|
115
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.81 to 0.0.1-next.83
|
|
116
|
+
* devDependencies
|
|
117
|
+
* @twin.org/engine bumped from 0.0.1-next.81 to 0.0.1-next.83
|
|
118
|
+
|
|
119
|
+
## [0.0.1-next.81](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.80...engine-server-v0.0.1-next.81) (2025-07-07)
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### Miscellaneous Chores
|
|
123
|
+
|
|
124
|
+
* **engine-server:** Synchronize repo versions
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
### Dependencies
|
|
128
|
+
|
|
129
|
+
* The following workspace dependencies were updated
|
|
130
|
+
* dependencies
|
|
131
|
+
* @twin.org/engine-core bumped from 0.0.1-next.80 to 0.0.1-next.81
|
|
132
|
+
* @twin.org/engine-models bumped from 0.0.1-next.80 to 0.0.1-next.81
|
|
133
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.80 to 0.0.1-next.81
|
|
134
|
+
* devDependencies
|
|
135
|
+
* @twin.org/engine bumped from 0.0.1-next.80 to 0.0.1-next.81
|
|
136
|
+
|
|
137
|
+
## [0.0.1-next.80](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.79...engine-server-v0.0.1-next.80) (2025-06-23)
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
### Features
|
|
141
|
+
|
|
142
|
+
* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
### Dependencies
|
|
146
|
+
|
|
147
|
+
* The following workspace dependencies were updated
|
|
148
|
+
* dependencies
|
|
149
|
+
* @twin.org/engine-core bumped from 0.0.1-next.79 to 0.0.1-next.80
|
|
150
|
+
* @twin.org/engine-models bumped from 0.0.1-next.79 to 0.0.1-next.80
|
|
151
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.79 to 0.0.1-next.80
|
|
152
|
+
* devDependencies
|
|
153
|
+
* @twin.org/engine bumped from 0.0.1-next.79 to 0.0.1-next.80
|
|
154
|
+
|
|
155
|
+
## [0.0.1-next.79](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.78...engine-server-v0.0.1-next.79) (2025-06-18)
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### Miscellaneous Chores
|
|
159
|
+
|
|
160
|
+
* **engine-server:** Synchronize repo versions
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
### Dependencies
|
|
164
|
+
|
|
165
|
+
* The following workspace dependencies were updated
|
|
166
|
+
* dependencies
|
|
167
|
+
* @twin.org/engine-core bumped from 0.0.1-next.78 to 0.0.1-next.79
|
|
168
|
+
* @twin.org/engine-models bumped from 0.0.1-next.78 to 0.0.1-next.79
|
|
169
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.78 to 0.0.1-next.79
|
|
170
|
+
* devDependencies
|
|
171
|
+
* @twin.org/engine bumped from 0.0.1-next.78 to 0.0.1-next.79
|
|
172
|
+
|
|
173
|
+
## [0.0.1-next.78](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.77...engine-server-v0.0.1-next.78) (2025-06-18)
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
### Miscellaneous Chores
|
|
177
|
+
|
|
178
|
+
* **engine-server:** Synchronize repo versions
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
### Dependencies
|
|
182
|
+
|
|
183
|
+
* The following workspace dependencies were updated
|
|
184
|
+
* dependencies
|
|
185
|
+
* @twin.org/engine-core bumped from 0.0.1-next.77 to 0.0.1-next.78
|
|
186
|
+
* @twin.org/engine-models bumped from 0.0.1-next.77 to 0.0.1-next.78
|
|
187
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.77 to 0.0.1-next.78
|
|
188
|
+
* devDependencies
|
|
189
|
+
* @twin.org/engine bumped from 0.0.1-next.77 to 0.0.1-next.78
|
|
190
|
+
|
|
191
|
+
## [0.0.1-next.77](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.76...engine-server-v0.0.1-next.77) (2025-06-18)
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
### Miscellaneous Chores
|
|
195
|
+
|
|
196
|
+
* **engine-server:** Synchronize repo versions
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
### Dependencies
|
|
200
|
+
|
|
201
|
+
* The following workspace dependencies were updated
|
|
202
|
+
* dependencies
|
|
203
|
+
* @twin.org/engine-core bumped from 0.0.1-next.76 to 0.0.1-next.77
|
|
204
|
+
* @twin.org/engine-models bumped from 0.0.1-next.76 to 0.0.1-next.77
|
|
205
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.76 to 0.0.1-next.77
|
|
206
|
+
* devDependencies
|
|
207
|
+
* @twin.org/engine bumped from 0.0.1-next.76 to 0.0.1-next.77
|
|
208
|
+
|
|
209
|
+
## [0.0.1-next.76](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.75...engine-server-v0.0.1-next.76) (2025-06-12)
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
### Features
|
|
213
|
+
|
|
214
|
+
* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
### Dependencies
|
|
218
|
+
|
|
219
|
+
* The following workspace dependencies were updated
|
|
220
|
+
* dependencies
|
|
221
|
+
* @twin.org/engine-core bumped from 0.0.1-next.75 to 0.0.1-next.76
|
|
222
|
+
* @twin.org/engine-models bumped from 0.0.1-next.75 to 0.0.1-next.76
|
|
223
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.75 to 0.0.1-next.76
|
|
224
|
+
* devDependencies
|
|
225
|
+
* @twin.org/engine bumped from 0.0.1-next.75 to 0.0.1-next.76
|
|
226
|
+
|
|
227
|
+
## [0.0.1-next.75](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.74...engine-server-v0.0.1-next.75) (2025-05-29)
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
### Features
|
|
231
|
+
|
|
232
|
+
* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
### Dependencies
|
|
236
|
+
|
|
237
|
+
* The following workspace dependencies were updated
|
|
238
|
+
* dependencies
|
|
239
|
+
* @twin.org/engine-core bumped from 0.0.1-next.74 to 0.0.1-next.75
|
|
240
|
+
* @twin.org/engine-models bumped from 0.0.1-next.74 to 0.0.1-next.75
|
|
241
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.74 to 0.0.1-next.75
|
|
242
|
+
* devDependencies
|
|
243
|
+
* @twin.org/engine bumped from 0.0.1-next.74 to 0.0.1-next.75
|
|
244
|
+
|
|
245
|
+
## [0.0.1-next.74](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.73...engine-server-v0.0.1-next.74) (2025-05-23)
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
### Features
|
|
249
|
+
|
|
250
|
+
* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
### Dependencies
|
|
254
|
+
|
|
255
|
+
* The following workspace dependencies were updated
|
|
256
|
+
* dependencies
|
|
257
|
+
* @twin.org/engine-core bumped from 0.0.1-next.73 to 0.0.1-next.74
|
|
258
|
+
* @twin.org/engine-models bumped from 0.0.1-next.73 to 0.0.1-next.74
|
|
259
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.73 to 0.0.1-next.74
|
|
260
|
+
* devDependencies
|
|
261
|
+
* @twin.org/engine bumped from 0.0.1-next.73 to 0.0.1-next.74
|
|
262
|
+
|
|
263
|
+
## [0.0.1-next.73](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.72...engine-server-v0.0.1-next.73) (2025-05-22)
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
### Miscellaneous Chores
|
|
267
|
+
|
|
268
|
+
* **engine-server:** Synchronize repo versions
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
### Dependencies
|
|
272
|
+
|
|
273
|
+
* The following workspace dependencies were updated
|
|
274
|
+
* dependencies
|
|
275
|
+
* @twin.org/engine-core bumped from 0.0.1-next.72 to 0.0.1-next.73
|
|
276
|
+
* @twin.org/engine-models bumped from 0.0.1-next.72 to 0.0.1-next.73
|
|
277
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.72 to 0.0.1-next.73
|
|
278
|
+
* devDependencies
|
|
279
|
+
* @twin.org/engine bumped from 0.0.1-next.72 to 0.0.1-next.73
|
|
280
|
+
|
|
281
|
+
## [0.0.1-next.72](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.71...engine-server-v0.0.1-next.72) (2025-05-06)
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
### Features
|
|
285
|
+
|
|
286
|
+
* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
|
|
287
|
+
* expose default rest and socket path creation ([e6c6e26](https://github.com/twinfoundation/engine/commit/e6c6e266c8017212a74d4997e2e335347457a2bc))
|
|
288
|
+
* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
|
|
289
|
+
* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
### Bug Fixes
|
|
293
|
+
|
|
294
|
+
* method docs ([fb3d73f](https://github.com/twinfoundation/engine/commit/fb3d73fa9e71ab392378fe7bad7a3677e5e7b132))
|
|
295
|
+
* use abbreviated docs path ([9258a72](https://github.com/twinfoundation/engine/commit/9258a72adf266ddcc4f98002a07a7a162755f24b))
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
### Dependencies
|
|
299
|
+
|
|
300
|
+
* The following workspace dependencies were updated
|
|
301
|
+
* dependencies
|
|
302
|
+
* @twin.org/engine-core bumped from 0.0.1-next.71 to 0.0.1-next.72
|
|
303
|
+
* @twin.org/engine-models bumped from 0.0.1-next.71 to 0.0.1-next.72
|
|
304
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.71 to 0.0.1-next.72
|
|
305
|
+
* devDependencies
|
|
306
|
+
* @twin.org/engine bumped from 0.0.1-next.71 to 0.0.1-next.72
|
|
307
|
+
|
|
308
|
+
## [0.0.1-next.71](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.70...engine-server-v0.0.1-next.71) (2025-05-06)
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
### Features
|
|
312
|
+
|
|
313
|
+
* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
### Dependencies
|
|
317
|
+
|
|
318
|
+
* The following workspace dependencies were updated
|
|
319
|
+
* dependencies
|
|
320
|
+
* @twin.org/engine-core bumped from 0.0.1-next.70 to 0.0.1-next.71
|
|
321
|
+
* @twin.org/engine-models bumped from 0.0.1-next.70 to 0.0.1-next.71
|
|
322
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.70 to 0.0.1-next.71
|
|
323
|
+
* devDependencies
|
|
324
|
+
* @twin.org/engine bumped from 0.0.1-next.70 to 0.0.1-next.71
|
|
325
|
+
|
|
326
|
+
## [0.0.1-next.70](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.69...engine-server-v0.0.1-next.70) (2025-04-28)
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
### Miscellaneous Chores
|
|
330
|
+
|
|
331
|
+
* **engine-server:** Synchronize repo versions
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
### Dependencies
|
|
335
|
+
|
|
336
|
+
* The following workspace dependencies were updated
|
|
337
|
+
* dependencies
|
|
338
|
+
* @twin.org/engine-core bumped from 0.0.1-next.69 to 0.0.1-next.70
|
|
339
|
+
* @twin.org/engine-models bumped from 0.0.1-next.69 to 0.0.1-next.70
|
|
340
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.69 to 0.0.1-next.70
|
|
341
|
+
* devDependencies
|
|
342
|
+
* @twin.org/engine bumped from 0.0.1-next.69 to 0.0.1-next.70
|
|
343
|
+
|
|
344
|
+
## [0.0.1-next.69](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.68...engine-server-v0.0.1-next.69) (2025-04-25)
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
### Features
|
|
348
|
+
|
|
349
|
+
* expose default rest and socket path creation ([e6c6e26](https://github.com/twinfoundation/engine/commit/e6c6e266c8017212a74d4997e2e335347457a2bc))
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
### Bug Fixes
|
|
353
|
+
|
|
354
|
+
* use abbreviated docs path ([9258a72](https://github.com/twinfoundation/engine/commit/9258a72adf266ddcc4f98002a07a7a162755f24b))
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
### Dependencies
|
|
358
|
+
|
|
359
|
+
* The following workspace dependencies were updated
|
|
360
|
+
* dependencies
|
|
361
|
+
* @twin.org/engine-core bumped from 0.0.1-next.68 to 0.0.1-next.69
|
|
362
|
+
* @twin.org/engine-models bumped from 0.0.1-next.68 to 0.0.1-next.69
|
|
363
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.68 to 0.0.1-next.69
|
|
364
|
+
* devDependencies
|
|
365
|
+
* @twin.org/engine bumped from 0.0.1-next.68 to 0.0.1-next.69
|
|
366
|
+
|
|
367
|
+
## [0.0.1-next.68](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.67...engine-server-v0.0.1-next.68) (2025-04-17)
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
### Features
|
|
371
|
+
|
|
372
|
+
* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
### Dependencies
|
|
376
|
+
|
|
377
|
+
* The following workspace dependencies were updated
|
|
378
|
+
* dependencies
|
|
379
|
+
* @twin.org/engine-core bumped from 0.0.1-next.67 to 0.0.1-next.68
|
|
380
|
+
* @twin.org/engine-models bumped from 0.0.1-next.67 to 0.0.1-next.68
|
|
381
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.67 to 0.0.1-next.68
|
|
382
|
+
* devDependencies
|
|
383
|
+
* @twin.org/engine bumped from 0.0.1-next.67 to 0.0.1-next.68
|
|
384
|
+
|
|
385
|
+
## [0.0.1-next.67](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.66...engine-server-v0.0.1-next.67) (2025-03-28)
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
### Features
|
|
389
|
+
|
|
390
|
+
* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
### Dependencies
|
|
394
|
+
|
|
395
|
+
* The following workspace dependencies were updated
|
|
396
|
+
* dependencies
|
|
397
|
+
* @twin.org/engine-core bumped from 0.0.1-next.66 to 0.0.1-next.67
|
|
398
|
+
* @twin.org/engine-models bumped from 0.0.1-next.66 to 0.0.1-next.67
|
|
399
|
+
* @twin.org/engine-server-types bumped from 0.0.1-next.66 to 0.0.1-next.67
|
|
400
|
+
* devDependencies
|
|
401
|
+
* @twin.org/engine bumped from 0.0.1-next.66 to 0.0.1-next.67
|
|
402
|
+
|
|
403
|
+
## v0.0.1-next.66
|
|
4
404
|
|
|
5
405
|
- Initial Release
|
|
@@ -1,36 +1,40 @@
|
|
|
1
|
-
# Class: EngineServer
|
|
1
|
+
# Class: EngineServer\<T\>
|
|
2
2
|
|
|
3
3
|
Server for the engine.
|
|
4
4
|
|
|
5
|
+
## Type Parameters
|
|
6
|
+
|
|
7
|
+
### T
|
|
8
|
+
|
|
9
|
+
`T` *extends* `IEngineServerConfig` = `IEngineServerConfig`
|
|
10
|
+
|
|
5
11
|
## Implements
|
|
6
12
|
|
|
7
13
|
- `IEngineServer`
|
|
8
14
|
|
|
9
15
|
## Constructors
|
|
10
16
|
|
|
11
|
-
###
|
|
17
|
+
### Constructor
|
|
12
18
|
|
|
13
|
-
> **new EngineServer
|
|
19
|
+
> **new EngineServer**\<`T`\>(`options`): `EngineServer`\<`T`\>
|
|
14
20
|
|
|
15
21
|
Create a new instance of EngineServer.
|
|
16
22
|
|
|
17
23
|
#### Parameters
|
|
18
24
|
|
|
19
|
-
|
|
25
|
+
##### options
|
|
20
26
|
|
|
21
27
|
The options for the engine.
|
|
22
28
|
|
|
23
|
-
|
|
29
|
+
###### engineCore
|
|
24
30
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
• **options.server?**: `IEngineServerConfig`
|
|
31
|
+
`IEngineCore`\<`T`\>
|
|
28
32
|
|
|
29
|
-
The
|
|
33
|
+
The engine core to serve from.
|
|
30
34
|
|
|
31
35
|
#### Returns
|
|
32
36
|
|
|
33
|
-
|
|
37
|
+
`EngineServer`\<`T`\>
|
|
34
38
|
|
|
35
39
|
## Properties
|
|
36
40
|
|
|
@@ -40,35 +44,39 @@ The server options for the engine.
|
|
|
40
44
|
|
|
41
45
|
Runtime name for the class.
|
|
42
46
|
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### \_config
|
|
46
|
-
|
|
47
|
-
> `protected` `readonly` **\_config**: `IEngineServerConfig`
|
|
48
|
-
|
|
49
|
-
The server config.
|
|
50
|
-
|
|
51
47
|
## Methods
|
|
52
48
|
|
|
53
49
|
### addRestRouteGenerator()
|
|
54
50
|
|
|
55
|
-
> **addRestRouteGenerator**(`type`, `typeConfig`, `
|
|
51
|
+
> **addRestRouteGenerator**(`type`, `typeConfig`, `module`, `method`): `void`
|
|
56
52
|
|
|
57
53
|
Add a REST route generator.
|
|
58
54
|
|
|
59
55
|
#### Parameters
|
|
60
56
|
|
|
61
|
-
|
|
57
|
+
##### type
|
|
58
|
+
|
|
59
|
+
`string`
|
|
62
60
|
|
|
63
61
|
The type to add the generator for.
|
|
64
62
|
|
|
65
|
-
|
|
63
|
+
##### typeConfig
|
|
66
64
|
|
|
67
65
|
The type config.
|
|
68
66
|
|
|
69
|
-
|
|
67
|
+
`undefined` | `IEngineCoreTypeConfig`[]
|
|
68
|
+
|
|
69
|
+
##### module
|
|
70
|
+
|
|
71
|
+
`string`
|
|
72
|
+
|
|
73
|
+
The module containing the generator.
|
|
74
|
+
|
|
75
|
+
##### method
|
|
76
|
+
|
|
77
|
+
`string`
|
|
70
78
|
|
|
71
|
-
The
|
|
79
|
+
The method to call on the module.
|
|
72
80
|
|
|
73
81
|
#### Returns
|
|
74
82
|
|
|
@@ -82,23 +90,35 @@ The generator to add.
|
|
|
82
90
|
|
|
83
91
|
### addSocketRouteGenerator()
|
|
84
92
|
|
|
85
|
-
> **addSocketRouteGenerator**(`type`, `typeConfig`, `
|
|
93
|
+
> **addSocketRouteGenerator**(`type`, `typeConfig`, `module`, `method`): `void`
|
|
86
94
|
|
|
87
95
|
Add a socket route generator.
|
|
88
96
|
|
|
89
97
|
#### Parameters
|
|
90
98
|
|
|
91
|
-
|
|
99
|
+
##### type
|
|
100
|
+
|
|
101
|
+
`string`
|
|
92
102
|
|
|
93
103
|
The type to add the generator for.
|
|
94
104
|
|
|
95
|
-
|
|
105
|
+
##### typeConfig
|
|
96
106
|
|
|
97
107
|
The type config.
|
|
98
108
|
|
|
99
|
-
|
|
109
|
+
`undefined` | `IEngineCoreTypeConfig`[]
|
|
110
|
+
|
|
111
|
+
##### module
|
|
112
|
+
|
|
113
|
+
`string`
|
|
114
|
+
|
|
115
|
+
The module containing the generator.
|
|
116
|
+
|
|
117
|
+
##### method
|
|
100
118
|
|
|
101
|
-
|
|
119
|
+
`string`
|
|
120
|
+
|
|
121
|
+
The method to call on the module.
|
|
102
122
|
|
|
103
123
|
#### Returns
|
|
104
124
|
|
|
@@ -110,17 +130,45 @@ The generator to add.
|
|
|
110
130
|
|
|
111
131
|
***
|
|
112
132
|
|
|
133
|
+
### getRestRoutes()
|
|
134
|
+
|
|
135
|
+
> **getRestRoutes**(): `IRestRoute`\<`any`, `any`\>[]
|
|
136
|
+
|
|
137
|
+
Get the built REST routes.
|
|
138
|
+
|
|
139
|
+
#### Returns
|
|
140
|
+
|
|
141
|
+
`IRestRoute`\<`any`, `any`\>[]
|
|
142
|
+
|
|
143
|
+
The REST routes.
|
|
144
|
+
|
|
145
|
+
***
|
|
146
|
+
|
|
147
|
+
### getSocketRoutes()
|
|
148
|
+
|
|
149
|
+
> **getSocketRoutes**(): `ISocketRoute`\<`any`, `any`\>[]
|
|
150
|
+
|
|
151
|
+
Get the built socket routes.
|
|
152
|
+
|
|
153
|
+
#### Returns
|
|
154
|
+
|
|
155
|
+
`ISocketRoute`\<`any`, `any`\>[]
|
|
156
|
+
|
|
157
|
+
The socket routes.
|
|
158
|
+
|
|
159
|
+
***
|
|
160
|
+
|
|
113
161
|
### start()
|
|
114
162
|
|
|
115
|
-
> **start**(): `Promise`\<`
|
|
163
|
+
> **start**(): `Promise`\<`boolean`\>
|
|
116
164
|
|
|
117
165
|
Start the engine server.
|
|
118
166
|
|
|
119
167
|
#### Returns
|
|
120
168
|
|
|
121
|
-
`Promise`\<`
|
|
169
|
+
`Promise`\<`boolean`\>
|
|
122
170
|
|
|
123
|
-
|
|
171
|
+
True if the start was successful.
|
|
124
172
|
|
|
125
173
|
#### Implementation of
|
|
126
174
|
|