@twin.org/engine-server-types 0.0.3-next.2 → 0.0.3-next.21

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 (52) hide show
  1. package/dist/es/components/authentication.js +22 -19
  2. package/dist/es/components/authentication.js.map +1 -1
  3. package/dist/es/components/authenticationAdmin.js +17 -15
  4. package/dist/es/components/authenticationAdmin.js.map +1 -1
  5. package/dist/es/components/hosting.js +29 -0
  6. package/dist/es/components/hosting.js.map +1 -0
  7. package/dist/es/components/information.js +12 -9
  8. package/dist/es/components/information.js.map +1 -1
  9. package/dist/es/components/mimeTypeProcessor.js +7 -7
  10. package/dist/es/components/mimeTypeProcessor.js.map +1 -1
  11. package/dist/es/components/restRouteProcessor.js +29 -44
  12. package/dist/es/components/restRouteProcessor.js.map +1 -1
  13. package/dist/es/components/socketRouteProcessor.js +26 -41
  14. package/dist/es/components/socketRouteProcessor.js.map +1 -1
  15. package/dist/es/index.js +3 -0
  16. package/dist/es/index.js.map +1 -1
  17. package/dist/es/models/IEngineServerConfig.js.map +1 -1
  18. package/dist/es/models/config/hostingComponentConfig.js +2 -0
  19. package/dist/es/models/config/hostingComponentConfig.js.map +1 -0
  20. package/dist/es/models/config/restRouteProcessorConfig.js.map +1 -1
  21. package/dist/es/models/config/socketRouteProcessorConfig.js.map +1 -1
  22. package/dist/es/models/types/hostingComponentType.js +13 -0
  23. package/dist/es/models/types/hostingComponentType.js.map +1 -0
  24. package/dist/types/components/authentication.d.ts +3 -7
  25. package/dist/types/components/authenticationAdmin.d.ts +3 -7
  26. package/dist/types/components/hosting.d.ts +12 -0
  27. package/dist/types/components/information.d.ts +3 -7
  28. package/dist/types/components/mimeTypeProcessor.d.ts +2 -7
  29. package/dist/types/components/restRouteProcessor.d.ts +2 -7
  30. package/dist/types/components/socketRouteProcessor.d.ts +2 -7
  31. package/dist/types/index.d.ts +3 -0
  32. package/dist/types/models/IEngineServerConfig.d.ts +11 -6
  33. package/dist/types/models/config/hostingComponentConfig.d.ts +9 -0
  34. package/dist/types/models/config/restRouteProcessorConfig.d.ts +0 -4
  35. package/dist/types/models/config/socketRouteProcessorConfig.d.ts +0 -4
  36. package/dist/types/models/types/hostingComponentType.d.ts +13 -0
  37. package/docs/changelog.md +312 -0
  38. package/docs/reference/functions/initialiseAuthenticationAdminComponent.md +2 -2
  39. package/docs/reference/functions/initialiseAuthenticationComponent.md +2 -2
  40. package/docs/reference/functions/initialiseHostingComponent.md +31 -0
  41. package/docs/reference/functions/initialiseInformationComponent.md +2 -2
  42. package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +2 -2
  43. package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +2 -2
  44. package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +2 -2
  45. package/docs/reference/index.md +4 -0
  46. package/docs/reference/interfaces/IEngineServerConfig.md +12 -6
  47. package/docs/reference/type-aliases/HostingComponentConfig.md +17 -0
  48. package/docs/reference/type-aliases/HostingComponentType.md +5 -0
  49. package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
  50. package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
  51. package/docs/reference/variables/HostingComponentType.md +13 -0
  52. package/package.json +3 -4
package/docs/changelog.md CHANGED
@@ -1,5 +1,317 @@
1
1
  # @twin.org/engine-server-types - Changelog
2
2
 
3
+ ## [0.0.3-next.21](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.20...engine-server-types-v0.0.3-next.21) (2026-02-13)
4
+
5
+
6
+ ### Features
7
+
8
+ * multi instance component support ([#83](https://github.com/twinfoundation/engine/issues/83)) ([6012b50](https://github.com/twinfoundation/engine/commit/6012b50959df5af893f05516d42eea2e0800b31a))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/engine-models bumped from 0.0.3-next.20 to 0.0.3-next.21
16
+ * @twin.org/engine-types bumped from 0.0.3-next.20 to 0.0.3-next.21
17
+
18
+ ## [0.0.3-next.20](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.19...engine-server-types-v0.0.3-next.20) (2026-02-06)
19
+
20
+
21
+ ### Miscellaneous Chores
22
+
23
+ * **engine-server-types:** Synchronize repo versions
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/engine-models bumped from 0.0.3-next.19 to 0.0.3-next.20
31
+ * @twin.org/engine-types bumped from 0.0.3-next.19 to 0.0.3-next.20
32
+
33
+ ## [0.0.3-next.19](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.18...engine-server-types-v0.0.3-next.19) (2026-02-05)
34
+
35
+
36
+ ### Miscellaneous Chores
37
+
38
+ * **engine-server-types:** Synchronize repo versions
39
+
40
+
41
+ ### Dependencies
42
+
43
+ * The following workspace dependencies were updated
44
+ * dependencies
45
+ * @twin.org/engine-models bumped from 0.0.3-next.18 to 0.0.3-next.19
46
+ * @twin.org/engine-types bumped from 0.0.3-next.18 to 0.0.3-next.19
47
+
48
+ ## [0.0.3-next.18](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.17...engine-server-types-v0.0.3-next.18) (2026-02-04)
49
+
50
+
51
+ ### Miscellaneous Chores
52
+
53
+ * **engine-server-types:** Synchronize repo versions
54
+
55
+
56
+ ### Dependencies
57
+
58
+ * The following workspace dependencies were updated
59
+ * dependencies
60
+ * @twin.org/engine-models bumped from 0.0.3-next.17 to 0.0.3-next.18
61
+ * @twin.org/engine-types bumped from 0.0.3-next.17 to 0.0.3-next.18
62
+
63
+ ## [0.0.3-next.17](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.16...engine-server-types-v0.0.3-next.17) (2026-02-02)
64
+
65
+
66
+ ### Miscellaneous Chores
67
+
68
+ * **engine-server-types:** Synchronize repo versions
69
+
70
+
71
+ ### Dependencies
72
+
73
+ * The following workspace dependencies were updated
74
+ * dependencies
75
+ * @twin.org/engine-models bumped from 0.0.3-next.16 to 0.0.3-next.17
76
+ * @twin.org/engine-types bumped from 0.0.3-next.16 to 0.0.3-next.17
77
+
78
+ ## [0.0.3-next.16](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.15...engine-server-types-v0.0.3-next.16) (2026-01-28)
79
+
80
+
81
+ ### Features
82
+
83
+ * remove dap and darp ([d568c4f](https://github.com/twinfoundation/engine/commit/d568c4fc58a3159378e1d65f93228ae84f34a31d))
84
+
85
+
86
+ ### Dependencies
87
+
88
+ * The following workspace dependencies were updated
89
+ * dependencies
90
+ * @twin.org/engine-models bumped from 0.0.3-next.15 to 0.0.3-next.16
91
+ * @twin.org/engine-types bumped from 0.0.3-next.15 to 0.0.3-next.16
92
+
93
+ ## [0.0.3-next.15](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.14...engine-server-types-v0.0.3-next.15) (2026-01-26)
94
+
95
+
96
+ ### Features
97
+
98
+ * add hosting component ([#70](https://github.com/twinfoundation/engine/issues/70)) ([2ab0dec](https://github.com/twinfoundation/engine/commit/2ab0dec8fdb979395c639b73f394a40a0dd7e55a))
99
+
100
+
101
+ ### Dependencies
102
+
103
+ * The following workspace dependencies were updated
104
+ * dependencies
105
+ * @twin.org/engine-models bumped from 0.0.3-next.14 to 0.0.3-next.15
106
+ * @twin.org/engine-types bumped from 0.0.3-next.14 to 0.0.3-next.15
107
+
108
+ ## [0.0.3-next.14](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.13...engine-server-types-v0.0.3-next.14) (2026-01-19)
109
+
110
+
111
+ ### Features
112
+
113
+ * add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
114
+ * add context id features ([#51](https://github.com/twinfoundation/engine/issues/51)) ([eaef180](https://github.com/twinfoundation/engine/commit/eaef1807397a907bc7655ef1545a151a710ca2f1))
115
+ * add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
116
+ * add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
117
+ * add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
118
+ * add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
119
+ * add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
120
+ * add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
121
+ * add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
122
+ * add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
123
+ * add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
124
+ * add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
125
+ * add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
126
+ * add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
127
+ * add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
128
+ * context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
129
+ * eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
130
+ * modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
131
+ * remove additional identity auth components ([409b2e6](https://github.com/twinfoundation/engine/commit/409b2e6a5a543d0795b01916349b39922afb6d88))
132
+ * remove authentication generator components ([#67](https://github.com/twinfoundation/engine/issues/67)) ([62f7984](https://github.com/twinfoundation/engine/commit/62f798468f567fdbf648401aa0dc51cda871c913))
133
+ * simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
134
+ * standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
135
+ * switch to devDeps ([32832ac](https://github.com/twinfoundation/engine/commit/32832acd934e1e5569474281a527c9b118d30732))
136
+ * update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
137
+ * update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
138
+ * update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
139
+ * upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
140
+ * use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
141
+
142
+
143
+ ### Dependencies
144
+
145
+ * The following workspace dependencies were updated
146
+ * dependencies
147
+ * @twin.org/engine-models bumped from 0.0.3-next.13 to 0.0.3-next.14
148
+ * @twin.org/engine-types bumped from 0.0.3-next.13 to 0.0.3-next.14
149
+
150
+ ## [0.0.3-next.13](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.12...engine-server-types-v0.0.3-next.13) (2026-01-19)
151
+
152
+
153
+ ### Features
154
+
155
+ * remove authentication generator components ([#67](https://github.com/twinfoundation/engine/issues/67)) ([62f7984](https://github.com/twinfoundation/engine/commit/62f798468f567fdbf648401aa0dc51cda871c913))
156
+
157
+
158
+ ### Dependencies
159
+
160
+ * The following workspace dependencies were updated
161
+ * dependencies
162
+ * @twin.org/engine-models bumped from 0.0.3-next.12 to 0.0.3-next.13
163
+ * @twin.org/engine-types bumped from 0.0.3-next.12 to 0.0.3-next.13
164
+
165
+ ## [0.0.3-next.12](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.11...engine-server-types-v0.0.3-next.12) (2026-01-19)
166
+
167
+
168
+ ### Miscellaneous Chores
169
+
170
+ * **engine-server-types:** Synchronize repo versions
171
+
172
+
173
+ ### Dependencies
174
+
175
+ * The following workspace dependencies were updated
176
+ * dependencies
177
+ * @twin.org/engine-models bumped from 0.0.3-next.11 to 0.0.3-next.12
178
+ * @twin.org/engine-types bumped from 0.0.3-next.11 to 0.0.3-next.12
179
+
180
+ ## [0.0.3-next.11](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.10...engine-server-types-v0.0.3-next.11) (2026-01-16)
181
+
182
+
183
+ ### Miscellaneous Chores
184
+
185
+ * **engine-server-types:** Synchronize repo versions
186
+
187
+
188
+ ### Dependencies
189
+
190
+ * The following workspace dependencies were updated
191
+ * dependencies
192
+ * @twin.org/engine-models bumped from 0.0.3-next.10 to 0.0.3-next.11
193
+ * @twin.org/engine-types bumped from 0.0.3-next.10 to 0.0.3-next.11
194
+
195
+ ## [0.0.3-next.10](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.9...engine-server-types-v0.0.3-next.10) (2026-01-13)
196
+
197
+
198
+ ### Miscellaneous Chores
199
+
200
+ * **engine-server-types:** Synchronize repo versions
201
+
202
+
203
+ ### Dependencies
204
+
205
+ * The following workspace dependencies were updated
206
+ * dependencies
207
+ * @twin.org/engine-models bumped from 0.0.3-next.9 to 0.0.3-next.10
208
+ * @twin.org/engine-types bumped from 0.0.3-next.9 to 0.0.3-next.10
209
+
210
+ ## [0.0.3-next.9](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.8...engine-server-types-v0.0.3-next.9) (2026-01-07)
211
+
212
+
213
+ ### Miscellaneous Chores
214
+
215
+ * **engine-server-types:** Synchronize repo versions
216
+
217
+
218
+ ### Dependencies
219
+
220
+ * The following workspace dependencies were updated
221
+ * dependencies
222
+ * @twin.org/engine-models bumped from 0.0.3-next.8 to 0.0.3-next.9
223
+ * @twin.org/engine-types bumped from 0.0.3-next.8 to 0.0.3-next.9
224
+
225
+ ## [0.0.3-next.8](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.7...engine-server-types-v0.0.3-next.8) (2026-01-06)
226
+
227
+
228
+ ### Miscellaneous Chores
229
+
230
+ * **engine-server-types:** Synchronize repo versions
231
+
232
+
233
+ ### Dependencies
234
+
235
+ * The following workspace dependencies were updated
236
+ * dependencies
237
+ * @twin.org/engine-models bumped from 0.0.3-next.7 to 0.0.3-next.8
238
+ * @twin.org/engine-types bumped from 0.0.3-next.7 to 0.0.3-next.8
239
+
240
+ ## [0.0.3-next.7](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.6...engine-server-types-v0.0.3-next.7) (2025-12-04)
241
+
242
+
243
+ ### Features
244
+
245
+ * add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
246
+
247
+
248
+ ### Dependencies
249
+
250
+ * The following workspace dependencies were updated
251
+ * dependencies
252
+ * @twin.org/engine-models bumped from 0.0.3-next.6 to 0.0.3-next.7
253
+ * @twin.org/engine-types bumped from 0.0.3-next.6 to 0.0.3-next.7
254
+
255
+ ## [0.0.3-next.6](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.5...engine-server-types-v0.0.3-next.6) (2025-11-28)
256
+
257
+
258
+ ### Features
259
+
260
+ * add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
261
+
262
+
263
+ ### Dependencies
264
+
265
+ * The following workspace dependencies were updated
266
+ * dependencies
267
+ * @twin.org/engine-models bumped from 0.0.3-next.5 to 0.0.3-next.6
268
+ * @twin.org/engine-types bumped from 0.0.3-next.5 to 0.0.3-next.6
269
+
270
+ ## [0.0.3-next.5](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.4...engine-server-types-v0.0.3-next.5) (2025-11-20)
271
+
272
+
273
+ ### Miscellaneous Chores
274
+
275
+ * **engine-server-types:** Synchronize repo versions
276
+
277
+
278
+ ### Dependencies
279
+
280
+ * The following workspace dependencies were updated
281
+ * dependencies
282
+ * @twin.org/engine-models bumped from 0.0.3-next.4 to 0.0.3-next.5
283
+ * @twin.org/engine-types bumped from 0.0.3-next.4 to 0.0.3-next.5
284
+
285
+ ## [0.0.3-next.4](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.3...engine-server-types-v0.0.3-next.4) (2025-11-20)
286
+
287
+
288
+ ### Features
289
+
290
+ * context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
291
+
292
+
293
+ ### Dependencies
294
+
295
+ * The following workspace dependencies were updated
296
+ * dependencies
297
+ * @twin.org/engine-models bumped from 0.0.3-next.3 to 0.0.3-next.4
298
+ * @twin.org/engine-types bumped from 0.0.3-next.3 to 0.0.3-next.4
299
+
300
+ ## [0.0.3-next.3](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.2...engine-server-types-v0.0.3-next.3) (2025-11-14)
301
+
302
+
303
+ ### Miscellaneous Chores
304
+
305
+ * **engine-server-types:** Synchronize repo versions
306
+
307
+
308
+ ### Dependencies
309
+
310
+ * The following workspace dependencies were updated
311
+ * dependencies
312
+ * @twin.org/engine-models bumped from 0.0.3-next.2 to 0.0.3-next.3
313
+ * @twin.org/engine-types bumped from 0.0.3-next.2 to 0.0.3-next.3
314
+
3
315
  ## [0.0.3-next.2](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.1...engine-server-types-v0.0.3-next.2) (2025-11-13)
4
316
 
5
317
 
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseAuthenticationAdminComponent()
2
2
 
3
- > **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
3
+ > **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
4
4
 
5
5
  Initialise the authentication admin.
6
6
 
@@ -26,6 +26,6 @@ The instance config.
26
26
 
27
27
  ## Returns
28
28
 
29
- `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
29
+ `EngineTypeInitialiserReturn`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
30
30
 
31
31
  The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseAuthenticationComponent()
2
2
 
3
- > **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
3
+ > **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md), `Factory`\<`IComponent`\>\>
4
4
 
5
5
  Initialise the authentication.
6
6
 
@@ -26,6 +26,6 @@ The instance config.
26
26
 
27
27
  ## Returns
28
28
 
29
- `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
29
+ `EngineTypeInitialiserReturn`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md), `Factory`\<`IComponent`\>\>
30
30
 
31
31
  The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseHostingComponent()
2
+
3
+ > **initialiseHostingComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md), `Factory`\<`IComponent`\>\>
4
+
5
+ Initialise the hosting component.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `EngineTypeInitialiserReturn`\<[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md), `Factory`\<`IComponent`\>\>
30
+
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseInformationComponent()
2
2
 
3
- > **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
3
+ > **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md), `Factory`\<`IComponent`\>\>
4
4
 
5
5
  Initialise the information component.
6
6
 
@@ -26,6 +26,6 @@ The instance config.
26
26
 
27
27
  ## Returns
28
28
 
29
- `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
29
+ `EngineTypeInitialiserReturn`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md), `Factory`\<`IComponent`\>\>
30
30
 
31
31
  The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseMimeTypeProcessorComponent()
2
2
 
3
- > **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMimeTypeProcessor`\>; `component?`: `IComponent`; \}\>
3
+ > **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md), `Factory`\<`IMimeTypeProcessor`\>\>
4
4
 
5
5
  Initialise the mime type processor.
6
6
 
@@ -26,6 +26,6 @@ The instance config.
26
26
 
27
27
  ## Returns
28
28
 
29
- `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMimeTypeProcessor`\>; `component?`: `IComponent`; \}\>
29
+ `EngineTypeInitialiserReturn`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md), `Factory`\<`IMimeTypeProcessor`\>\>
30
30
 
31
31
  The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseRestRouteProcessorComponent()
2
2
 
3
- > **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IRestRouteProcessor`\>; `component?`: `IComponent`; \}\>
3
+ > **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md), `Factory`\<`IRestRouteProcessor`\>\>
4
4
 
5
5
  Initialise the rest route processor.
6
6
 
@@ -26,6 +26,6 @@ The instance config.
26
26
 
27
27
  ## Returns
28
28
 
29
- `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IRestRouteProcessor`\>; `component?`: `IComponent`; \}\>
29
+ `EngineTypeInitialiserReturn`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md), `Factory`\<`IRestRouteProcessor`\>\>
30
30
 
31
31
  The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseSocketRouteProcessorComponent()
2
2
 
3
- > **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ISocketRouteProcessor`\>; `component?`: `IComponent`; \}\>
3
+ > **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md), `Factory`\<`ISocketRouteProcessor`\>\>
4
4
 
5
5
  Initialise the socket route processor.
6
6
 
@@ -26,6 +26,6 @@ The instance config.
26
26
 
27
27
  ## Returns
28
28
 
29
- `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ISocketRouteProcessor`\>; `component?`: `IComponent`; \}\>
29
+ `EngineTypeInitialiserReturn`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md), `Factory`\<`ISocketRouteProcessor`\>\>
30
30
 
31
31
  The instance created and the factory for it.
@@ -8,12 +8,14 @@
8
8
 
9
9
  - [AuthenticationAdminComponentConfig](type-aliases/AuthenticationAdminComponentConfig.md)
10
10
  - [AuthenticationComponentConfig](type-aliases/AuthenticationComponentConfig.md)
11
+ - [HostingComponentConfig](type-aliases/HostingComponentConfig.md)
11
12
  - [InformationComponentConfig](type-aliases/InformationComponentConfig.md)
12
13
  - [MimeTypeProcessorConfig](type-aliases/MimeTypeProcessorConfig.md)
13
14
  - [RestRouteProcessorConfig](type-aliases/RestRouteProcessorConfig.md)
14
15
  - [SocketRouteProcessorConfig](type-aliases/SocketRouteProcessorConfig.md)
15
16
  - [AuthenticationAdminComponentType](type-aliases/AuthenticationAdminComponentType.md)
16
17
  - [AuthenticationComponentType](type-aliases/AuthenticationComponentType.md)
18
+ - [HostingComponentType](type-aliases/HostingComponentType.md)
17
19
  - [InformationComponentType](type-aliases/InformationComponentType.md)
18
20
  - [MimeTypeProcessorType](type-aliases/MimeTypeProcessorType.md)
19
21
  - [RestRouteProcessorType](type-aliases/RestRouteProcessorType.md)
@@ -23,6 +25,7 @@
23
25
 
24
26
  - [AuthenticationAdminComponentType](variables/AuthenticationAdminComponentType.md)
25
27
  - [AuthenticationComponentType](variables/AuthenticationComponentType.md)
28
+ - [HostingComponentType](variables/HostingComponentType.md)
26
29
  - [InformationComponentType](variables/InformationComponentType.md)
27
30
  - [MimeTypeProcessorType](variables/MimeTypeProcessorType.md)
28
31
  - [RestRouteProcessorType](variables/RestRouteProcessorType.md)
@@ -32,6 +35,7 @@
32
35
 
33
36
  - [initialiseAuthenticationComponent](functions/initialiseAuthenticationComponent.md)
34
37
  - [initialiseAuthenticationAdminComponent](functions/initialiseAuthenticationAdminComponent.md)
38
+ - [initialiseHostingComponent](functions/initialiseHostingComponent.md)
35
39
  - [initialiseInformationComponent](functions/initialiseInformationComponent.md)
36
40
  - [initialiseMimeTypeProcessorComponent](functions/initialiseMimeTypeProcessorComponent.md)
37
41
  - [initialiseRestRouteProcessorComponent](functions/initialiseRestRouteProcessorComponent.md)
@@ -28,37 +28,43 @@ The types to initialise in the engine.
28
28
 
29
29
  > `optional` **informationComponent**: `IEngineCoreTypeConfig`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
30
30
 
31
- Information component options which can be overridden by individual components by specifying types other than default..
31
+ Information component options which can be overridden by individual components by specifying types other than default.
32
+
33
+ ##### hostingComponent?
34
+
35
+ > `optional` **hostingComponent**: `IEngineCoreTypeConfig`\<[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md)\>[]
36
+
37
+ Hosting component options which can be overridden by individual components by specifying types other than default.
32
38
 
33
39
  ##### restRouteProcessor?
34
40
 
35
41
  > `optional` **restRouteProcessor**: `IEngineCoreTypeConfig`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
36
42
 
37
- REST route processors options which can be overridden by individual components by specifying types other than default..
43
+ REST route processors options which can be overridden by individual components by specifying types other than default.
38
44
 
39
45
  ##### socketRouteProcessor?
40
46
 
41
47
  > `optional` **socketRouteProcessor**: `IEngineCoreTypeConfig`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
42
48
 
43
- Socket route processors options which can be overridden by individual components by specifying types other than default..
49
+ Socket route processors options which can be overridden by individual components by specifying types other than default.
44
50
 
45
51
  ##### mimeTypeProcessor?
46
52
 
47
53
  > `optional` **mimeTypeProcessor**: `IEngineCoreTypeConfig`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
48
54
 
49
- Mime type processors options which can be overridden by individual components by specifying types other than default..
55
+ Mime type processors options which can be overridden by individual components by specifying types other than default.
50
56
 
51
57
  ##### authenticationComponent?
52
58
 
53
59
  > `optional` **authenticationComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
54
60
 
55
- Authentication component options which can be overridden by individual components by specifying types other than default..
61
+ Authentication component options which can be overridden by individual components by specifying types other than default.
56
62
 
57
63
  ##### authenticationAdminComponent?
58
64
 
59
65
  > `optional` **authenticationAdminComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md)\>[]
60
66
 
61
- Authentication admin component options which can be overridden by individual components by specifying types other than default..
67
+ Authentication admin component options which can be overridden by individual components by specifying types other than default.
62
68
 
63
69
  #### Overrides
64
70
 
@@ -0,0 +1,17 @@
1
+ # Type Alias: HostingComponentConfig
2
+
3
+ > **HostingComponentConfig** = `object`
4
+
5
+ Hosting component config types.
6
+
7
+ ## Properties
8
+
9
+ ### type
10
+
11
+ > **type**: *typeof* [`Service`](../variables/HostingComponentType.md#service)
12
+
13
+ ***
14
+
15
+ ### options
16
+
17
+ > **options**: `IHostingServiceConstructorOptions`
@@ -0,0 +1,5 @@
1
+ # Type Alias: HostingComponentType
2
+
3
+ > **HostingComponentType** = *typeof* [`HostingComponentType`](../variables/HostingComponentType.md)\[keyof *typeof* [`HostingComponentType`](../variables/HostingComponentType.md)\]
4
+
5
+ Hosting component types.
@@ -1,5 +1,5 @@
1
1
  # Type Alias: RestRouteProcessorConfig
2
2
 
3
- > **RestRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/RestRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`AuthVerifiableCredential`](../variables/RestRouteProcessorType.md#authverifiablecredential); `options?`: `IVerifiableCredentialAuthenticationProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/RestRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/RestRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/RestRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/RestRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`RestRoute`](../variables/RestRouteProcessorType.md#restroute); `options?`: `IRestRouteProcessorConstructorOptions`; \}
3
+ > **RestRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/RestRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/RestRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/RestRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/RestRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/RestRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`RestRoute`](../variables/RestRouteProcessorType.md#restroute); `options?`: `IRestRouteProcessorConstructorOptions`; \}
4
4
 
5
5
  REST route processor config types.
@@ -1,5 +1,5 @@
1
1
  # Type Alias: SocketRouteProcessorConfig
2
2
 
3
- > **SocketRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/SocketRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`AuthVerifiableCredential`](../variables/SocketRouteProcessorType.md#authverifiablecredential); `options?`: `IVerifiableCredentialAuthenticationProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/SocketRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/SocketRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/SocketRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/SocketRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`SocketRoute`](../variables/SocketRouteProcessorType.md#socketroute); `options?`: `ISocketRouteProcessorConstructorOptions`; \}
3
+ > **SocketRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/SocketRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/SocketRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/SocketRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/SocketRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/SocketRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`SocketRoute`](../variables/SocketRouteProcessorType.md#socketroute); `options?`: `ISocketRouteProcessorConstructorOptions`; \}
4
4
 
5
5
  Socket route processor config types.
@@ -0,0 +1,13 @@
1
+ # Variable: HostingComponentType
2
+
3
+ > `const` **HostingComponentType**: `object`
4
+
5
+ Hosting component types.
6
+
7
+ ## Type Declaration
8
+
9
+ ### Service
10
+
11
+ > `readonly` **Service**: `"service"` = `"service"`
12
+
13
+ Service.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/engine-server-types",
3
- "version": "0.0.3-next.2",
3
+ "version": "0.0.3-next.21",
4
4
  "description": "Server types to use in an engine server.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -25,10 +25,9 @@
25
25
  "@twin.org/api-tenant-processor": "next",
26
26
  "@twin.org/context": "next",
27
27
  "@twin.org/core": "next",
28
- "@twin.org/engine-models": "0.0.3-next.2",
29
- "@twin.org/engine-types": "0.0.3-next.2",
28
+ "@twin.org/engine-models": "0.0.3-next.21",
29
+ "@twin.org/engine-types": "0.0.3-next.21",
30
30
  "@twin.org/entity": "next",
31
- "@twin.org/identity-authentication": "next",
32
31
  "@twin.org/nameof": "next"
33
32
  },
34
33
  "main": "./dist/es/index.js",