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

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 (75) hide show
  1. package/dist/es/components/authentication.js +40 -0
  2. package/dist/es/components/authentication.js.map +1 -0
  3. package/dist/es/components/authenticationAdmin.js +33 -0
  4. package/dist/es/components/authenticationAdmin.js.map +1 -0
  5. package/dist/es/components/information.js +29 -0
  6. package/dist/es/components/information.js.map +1 -0
  7. package/dist/es/components/mimeTypeProcessor.js +26 -0
  8. package/dist/es/components/mimeTypeProcessor.js.map +1 -0
  9. package/dist/es/components/restRouteProcessor.js +76 -0
  10. package/dist/es/components/restRouteProcessor.js.map +1 -0
  11. package/dist/es/components/socketRouteProcessor.js +73 -0
  12. package/dist/es/components/socketRouteProcessor.js.map +1 -0
  13. package/dist/es/index.js +22 -0
  14. package/dist/es/index.js.map +1 -0
  15. package/dist/es/models/IEngineServerConfig.js +2 -0
  16. package/dist/es/models/IEngineServerConfig.js.map +1 -0
  17. package/dist/es/models/config/authenticationAdminComponentConfig.js +2 -0
  18. package/dist/es/models/config/authenticationAdminComponentConfig.js.map +1 -0
  19. package/dist/es/models/config/authenticationComponentConfig.js +2 -0
  20. package/dist/es/models/config/authenticationComponentConfig.js.map +1 -0
  21. package/dist/es/models/config/informationComponentConfig.js +2 -0
  22. package/dist/es/models/config/informationComponentConfig.js.map +1 -0
  23. package/dist/es/models/config/mimeTypeProcessorConfig.js +2 -0
  24. package/dist/es/models/config/mimeTypeProcessorConfig.js.map +1 -0
  25. package/dist/es/models/config/restRouteProcessorConfig.js +2 -0
  26. package/dist/es/models/config/restRouteProcessorConfig.js.map +1 -0
  27. package/dist/es/models/config/socketRouteProcessorConfig.js +2 -0
  28. package/dist/es/models/config/socketRouteProcessorConfig.js.map +1 -0
  29. package/dist/es/models/types/authenticationAdminComponentType.js +13 -0
  30. package/dist/es/models/types/authenticationAdminComponentType.js.map +1 -0
  31. package/dist/es/models/types/authenticationComponentType.js +17 -0
  32. package/dist/es/models/types/authenticationComponentType.js.map +1 -0
  33. package/dist/es/models/types/informationComponentType.js +17 -0
  34. package/dist/es/models/types/informationComponentType.js.map +1 -0
  35. package/dist/es/models/types/mimeTypeProcessorType.js +13 -0
  36. package/dist/es/models/types/mimeTypeProcessorType.js.map +1 -0
  37. package/dist/es/models/types/restRouteProcessorType.js +37 -0
  38. package/dist/es/models/types/restRouteProcessorType.js.map +1 -0
  39. package/dist/es/models/types/socketRouteProcessorType.js +37 -0
  40. package/dist/es/models/types/socketRouteProcessorType.js.map +1 -0
  41. package/dist/types/components/authentication.d.ts +9 -6
  42. package/dist/types/components/authenticationAdmin.d.ts +9 -6
  43. package/dist/types/components/information.d.ts +9 -6
  44. package/dist/types/components/mimeTypeProcessor.d.ts +10 -6
  45. package/dist/types/components/restRouteProcessor.d.ts +11 -7
  46. package/dist/types/components/socketRouteProcessor.d.ts +10 -6
  47. package/dist/types/index.d.ts +19 -19
  48. package/dist/types/models/IEngineServerConfig.d.ts +6 -6
  49. package/dist/types/models/config/authenticationAdminComponentConfig.d.ts +1 -1
  50. package/dist/types/models/config/authenticationComponentConfig.d.ts +1 -1
  51. package/dist/types/models/config/informationComponentConfig.d.ts +1 -1
  52. package/dist/types/models/config/mimeTypeProcessorConfig.d.ts +1 -1
  53. package/dist/types/models/config/restRouteProcessorConfig.d.ts +14 -6
  54. package/dist/types/models/config/socketRouteProcessorConfig.d.ts +14 -6
  55. package/dist/types/models/types/restRouteProcessorType.d.ts +12 -4
  56. package/dist/types/models/types/socketRouteProcessorType.d.ts +12 -4
  57. package/docs/changelog.md +307 -0
  58. package/docs/reference/functions/initialiseAuthenticationAdminComponent.md +3 -13
  59. package/docs/reference/functions/initialiseAuthenticationComponent.md +3 -13
  60. package/docs/reference/functions/initialiseInformationComponent.md +3 -13
  61. package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +3 -13
  62. package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +3 -13
  63. package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +3 -13
  64. package/docs/reference/interfaces/IEngineServerConfig.md +1 -1
  65. package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
  66. package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
  67. package/docs/reference/variables/AuthenticationAdminComponentType.md +1 -1
  68. package/docs/reference/variables/AuthenticationComponentType.md +1 -1
  69. package/docs/reference/variables/InformationComponentType.md +1 -1
  70. package/docs/reference/variables/MimeTypeProcessorType.md +1 -1
  71. package/docs/reference/variables/RestRouteProcessorType.md +19 -7
  72. package/docs/reference/variables/SocketRouteProcessorType.md +19 -7
  73. package/package.json +23 -10
  74. package/dist/cjs/index.cjs +0 -427
  75. package/dist/esm/index.mjs +0 -414
package/docs/changelog.md CHANGED
@@ -1,5 +1,312 @@
1
1
  # @twin.org/engine-server-types - Changelog
2
2
 
3
+ ## [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
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **engine-server-types:** Synchronize repo versions
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.1 to 0.0.3-next.2
16
+ * @twin.org/engine-types bumped from 0.0.3-next.1 to 0.0.3-next.2
17
+
18
+ ## [0.0.3-next.1](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.0...engine-server-types-v0.0.3-next.1) (2025-11-13)
19
+
20
+
21
+ ### Features
22
+
23
+ * add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
24
+ * add context id features ([#51](https://github.com/twinfoundation/engine/issues/51)) ([eaef180](https://github.com/twinfoundation/engine/commit/eaef1807397a907bc7655ef1545a151a710ca2f1))
25
+ * add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
26
+ * add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
27
+ * add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
28
+ * add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
29
+ * add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
30
+ * add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
31
+ * add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
32
+ * add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
33
+ * add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
34
+ * add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
35
+ * add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
36
+ * eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
37
+ * modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
38
+ * simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
39
+ * standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
40
+ * switch to devDeps ([32832ac](https://github.com/twinfoundation/engine/commit/32832acd934e1e5569474281a527c9b118d30732))
41
+ * update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
42
+ * update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
43
+ * update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
44
+ * upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
45
+ * use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
46
+
47
+
48
+ ### Dependencies
49
+
50
+ * The following workspace dependencies were updated
51
+ * dependencies
52
+ * @twin.org/engine-models bumped from 0.0.3-next.0 to 0.0.3-next.1
53
+ * @twin.org/engine-types bumped from 0.0.3-next.0 to 0.0.3-next.1
54
+
55
+ ## [0.0.2-next.26](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.25...engine-server-types-v0.0.2-next.26) (2025-10-09)
56
+
57
+
58
+ ### Miscellaneous Chores
59
+
60
+ * **engine-server-types:** Synchronize repo versions
61
+
62
+
63
+ ### Dependencies
64
+
65
+ * The following workspace dependencies were updated
66
+ * dependencies
67
+ * @twin.org/engine-models bumped from 0.0.2-next.25 to 0.0.2-next.26
68
+ * @twin.org/engine-types bumped from 0.0.2-next.25 to 0.0.2-next.26
69
+
70
+ ## [0.0.2-next.25](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.24...engine-server-types-v0.0.2-next.25) (2025-10-09)
71
+
72
+
73
+ ### Features
74
+
75
+ * add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
76
+
77
+
78
+ ### Dependencies
79
+
80
+ * The following workspace dependencies were updated
81
+ * dependencies
82
+ * @twin.org/engine-models bumped from 0.0.2-next.24 to 0.0.2-next.25
83
+ * @twin.org/engine-types bumped from 0.0.2-next.24 to 0.0.2-next.25
84
+
85
+ ## [0.0.2-next.24](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.23...engine-server-types-v0.0.2-next.24) (2025-10-08)
86
+
87
+
88
+ ### Miscellaneous Chores
89
+
90
+ * **engine-server-types:** Synchronize repo versions
91
+
92
+
93
+ ### Dependencies
94
+
95
+ * The following workspace dependencies were updated
96
+ * dependencies
97
+ * @twin.org/engine-models bumped from 0.0.2-next.23 to 0.0.2-next.24
98
+ * @twin.org/engine-types bumped from 0.0.2-next.23 to 0.0.2-next.24
99
+
100
+ ## [0.0.2-next.23](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.22...engine-server-types-v0.0.2-next.23) (2025-10-07)
101
+
102
+
103
+ ### Miscellaneous Chores
104
+
105
+ * **engine-server-types:** Synchronize repo versions
106
+
107
+
108
+ ### Dependencies
109
+
110
+ * The following workspace dependencies were updated
111
+ * dependencies
112
+ * @twin.org/engine-models bumped from 0.0.2-next.22 to 0.0.2-next.23
113
+ * @twin.org/engine-types bumped from 0.0.2-next.22 to 0.0.2-next.23
114
+
115
+ ## [0.0.2-next.22](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.21...engine-server-types-v0.0.2-next.22) (2025-10-07)
116
+
117
+
118
+ ### Miscellaneous Chores
119
+
120
+ * **engine-server-types:** Synchronize repo versions
121
+
122
+
123
+ ### Dependencies
124
+
125
+ * The following workspace dependencies were updated
126
+ * dependencies
127
+ * @twin.org/engine-models bumped from 0.0.2-next.21 to 0.0.2-next.22
128
+ * @twin.org/engine-types bumped from 0.0.2-next.21 to 0.0.2-next.22
129
+
130
+ ## [0.0.2-next.21](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.20...engine-server-types-v0.0.2-next.21) (2025-10-07)
131
+
132
+
133
+ ### Miscellaneous Chores
134
+
135
+ * **engine-server-types:** Synchronize repo versions
136
+
137
+
138
+ ### Dependencies
139
+
140
+ * The following workspace dependencies were updated
141
+ * dependencies
142
+ * @twin.org/engine-models bumped from 0.0.2-next.20 to 0.0.2-next.21
143
+ * @twin.org/engine-types bumped from 0.0.2-next.20 to 0.0.2-next.21
144
+
145
+ ## [0.0.2-next.20](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.19...engine-server-types-v0.0.2-next.20) (2025-10-06)
146
+
147
+
148
+ ### Features
149
+
150
+ * standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
151
+
152
+
153
+ ### Dependencies
154
+
155
+ * The following workspace dependencies were updated
156
+ * dependencies
157
+ * @twin.org/engine-models bumped from 0.0.2-next.19 to 0.0.2-next.20
158
+ * @twin.org/engine-types bumped from 0.0.2-next.19 to 0.0.2-next.20
159
+
160
+ ## [0.0.2-next.19](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.18...engine-server-types-v0.0.2-next.19) (2025-10-02)
161
+
162
+
163
+ ### Features
164
+
165
+ * simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
166
+
167
+
168
+ ### Dependencies
169
+
170
+ * The following workspace dependencies were updated
171
+ * dependencies
172
+ * @twin.org/engine-models bumped from 0.0.2-next.18 to 0.0.2-next.19
173
+ * @twin.org/engine-types bumped from 0.0.2-next.18 to 0.0.2-next.19
174
+
175
+ ## [0.0.2-next.18](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.17...engine-server-types-v0.0.2-next.18) (2025-09-29)
176
+
177
+
178
+ ### Features
179
+
180
+ * upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
181
+
182
+
183
+ ### Dependencies
184
+
185
+ * The following workspace dependencies were updated
186
+ * dependencies
187
+ * @twin.org/engine-models bumped from 0.0.2-next.17 to 0.0.2-next.18
188
+ * @twin.org/engine-types bumped from 0.0.2-next.17 to 0.0.2-next.18
189
+
190
+ ## [0.0.2-next.17](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.16...engine-server-types-v0.0.2-next.17) (2025-09-26)
191
+
192
+
193
+ ### Miscellaneous Chores
194
+
195
+ * **engine-server-types:** Synchronize repo versions
196
+
197
+
198
+ ### Dependencies
199
+
200
+ * The following workspace dependencies were updated
201
+ * dependencies
202
+ * @twin.org/engine-models bumped from 0.0.2-next.16 to 0.0.2-next.17
203
+ * @twin.org/engine-types bumped from 0.0.2-next.16 to 0.0.2-next.17
204
+
205
+ ## [0.0.2-next.16](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.15...engine-server-types-v0.0.2-next.16) (2025-09-25)
206
+
207
+
208
+ ### Miscellaneous Chores
209
+
210
+ * **engine-server-types:** Synchronize repo versions
211
+
212
+
213
+ ### Dependencies
214
+
215
+ * The following workspace dependencies were updated
216
+ * dependencies
217
+ * @twin.org/engine-models bumped from 0.0.2-next.15 to 0.0.2-next.16
218
+ * @twin.org/engine-types bumped from 0.0.2-next.15 to 0.0.2-next.16
219
+
220
+ ## [0.0.2-next.15](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.14...engine-server-types-v0.0.2-next.15) (2025-09-24)
221
+
222
+
223
+ ### Features
224
+
225
+ * update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
226
+
227
+
228
+ ### Dependencies
229
+
230
+ * The following workspace dependencies were updated
231
+ * dependencies
232
+ * @twin.org/engine-models bumped from 0.0.2-next.14 to 0.0.2-next.15
233
+ * @twin.org/engine-types bumped from 0.0.2-next.14 to 0.0.2-next.15
234
+
235
+ ## [0.0.2-next.14](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.13...engine-server-types-v0.0.2-next.14) (2025-09-19)
236
+
237
+
238
+ ### Features
239
+
240
+ * add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
241
+
242
+
243
+ ### Dependencies
244
+
245
+ * The following workspace dependencies were updated
246
+ * dependencies
247
+ * @twin.org/engine-models bumped from 0.0.2-next.13 to 0.0.2-next.14
248
+ * @twin.org/engine-types bumped from 0.0.2-next.13 to 0.0.2-next.14
249
+
250
+ ## [0.0.2-next.13](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.12...engine-server-types-v0.0.2-next.13) (2025-09-08)
251
+
252
+
253
+ ### Miscellaneous Chores
254
+
255
+ * **engine-server-types:** Synchronize repo versions
256
+
257
+
258
+ ### Dependencies
259
+
260
+ * The following workspace dependencies were updated
261
+ * dependencies
262
+ * @twin.org/engine-models bumped from 0.0.2-next.12 to 0.0.2-next.13
263
+ * @twin.org/engine-types bumped from 0.0.2-next.12 to 0.0.2-next.13
264
+
265
+ ## [0.0.2-next.12](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.11...engine-server-types-v0.0.2-next.12) (2025-09-05)
266
+
267
+
268
+ ### Features
269
+
270
+ * add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
271
+
272
+
273
+ ### Dependencies
274
+
275
+ * The following workspace dependencies were updated
276
+ * dependencies
277
+ * @twin.org/engine-models bumped from 0.0.2-next.11 to 0.0.2-next.12
278
+ * @twin.org/engine-types bumped from 0.0.2-next.11 to 0.0.2-next.12
279
+
280
+ ## [0.0.2-next.11](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.10...engine-server-types-v0.0.2-next.11) (2025-08-29)
281
+
282
+
283
+ ### Features
284
+
285
+ * eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
286
+
287
+
288
+ ### Dependencies
289
+
290
+ * The following workspace dependencies were updated
291
+ * dependencies
292
+ * @twin.org/engine-models bumped from 0.0.2-next.10 to 0.0.2-next.11
293
+ * @twin.org/engine-types bumped from 0.0.2-next.10 to 0.0.2-next.11
294
+
295
+ ## [0.0.2-next.10](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.9...engine-server-types-v0.0.2-next.10) (2025-08-26)
296
+
297
+
298
+ ### Features
299
+
300
+ * add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
301
+
302
+
303
+ ### Dependencies
304
+
305
+ * The following workspace dependencies were updated
306
+ * dependencies
307
+ * @twin.org/engine-models bumped from 0.0.2-next.9 to 0.0.2-next.10
308
+ * @twin.org/engine-types bumped from 0.0.2-next.9 to 0.0.2-next.10
309
+
3
310
  ## [0.0.2-next.9](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.8...engine-server-types-v0.0.2-next.9) (2025-08-25)
4
311
 
5
312
 
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseAuthenticationAdminComponent()
2
2
 
3
- > **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the authentication admin.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseAuthenticationComponent()
2
2
 
3
- > **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the authentication.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseInformationComponent()
2
2
 
3
- > **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the information component.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseMimeTypeProcessorComponent()
2
2
 
3
- > **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMimeTypeProcessor`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the mime type processor.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMimeTypeProcessor`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseRestRouteProcessorComponent()
2
2
 
3
- > **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IRestRouteProcessor`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the rest route processor.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IRestRouteProcessor`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseSocketRouteProcessorComponent()
2
2
 
3
- > **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ISocketRouteProcessor`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the socket route processor.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ISocketRouteProcessor`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -22,7 +22,7 @@ Configuration for the web server.
22
22
 
23
23
  The types to initialise in the engine.
24
24
 
25
- #### Type declaration
25
+ #### Type Declaration
26
26
 
27
27
  ##### informationComponent?
28
28
 
@@ -1,5 +1,5 @@
1
1
  # Type Alias: RestRouteProcessorConfig
2
2
 
3
- > **RestRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/RestRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/RestRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`NodeIdentity`](../variables/RestRouteProcessorType.md#nodeidentity); `options?`: `never`; \} \| \{ `type`: *typeof* [`StaticUserIdentity`](../variables/RestRouteProcessorType.md#staticuseridentity); `options`: `IStaticUserIdentityProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`RestRoute`](../variables/RestRouteProcessorType.md#restroute); `options?`: `IRestRouteProcessorConstructorOptions`; \}
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`; \}
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* [`Logging`](../variables/SocketRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`NodeIdentity`](../variables/SocketRouteProcessorType.md#nodeidentity); `options?`: `never`; \} \| \{ `type`: *typeof* [`StaticUserIdentity`](../variables/SocketRouteProcessorType.md#staticuseridentity); `options`: `IStaticUserIdentityProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`SocketRoute`](../variables/SocketRouteProcessorType.md#socketroute); `options?`: `ISocketRouteProcessorConstructorOptions`; \}
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`; \}
4
4
 
5
5
  Socket route processor config types.
@@ -4,7 +4,7 @@
4
4
 
5
5
  Authentication admin component types.
6
6
 
7
- ## Type declaration
7
+ ## Type Declaration
8
8
 
9
9
  ### EntityStorage
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Authentication component types.
6
6
 
7
- ## Type declaration
7
+ ## Type Declaration
8
8
 
9
9
  ### EntityStorage
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Information component types.
6
6
 
7
- ## Type declaration
7
+ ## Type Declaration
8
8
 
9
9
  ### Service
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Mime type route processor types.
6
6
 
7
- ## Type declaration
7
+ ## Type Declaration
8
8
 
9
9
  ### Jwt
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  REST route processor types.
6
6
 
7
- ## Type declaration
7
+ ## Type Declaration
8
8
 
9
9
  ### AuthHeader
10
10
 
@@ -12,23 +12,35 @@ REST route processor types.
12
12
 
13
13
  Auth header.
14
14
 
15
+ ### AuthVerifiableCredential
16
+
17
+ > `readonly` **AuthVerifiableCredential**: `"auth-verifiable-credential"` = `"auth-verifiable-credential"`
18
+
19
+ Auth verifiable credential.
20
+
15
21
  ### Logging
16
22
 
17
23
  > `readonly` **Logging**: `"logging"` = `"logging"`
18
24
 
19
25
  Logging.
20
26
 
21
- ### NodeIdentity
27
+ ### ContextId
28
+
29
+ > `readonly` **ContextId**: `"context-id"` = `"context-id"`
30
+
31
+ Context ID.
32
+
33
+ ### StaticContextId
22
34
 
23
- > `readonly` **NodeIdentity**: `"node-identity"` = `"node-identity"`
35
+ > `readonly` **StaticContextId**: `"static-context-id"` = `"static-context-id"`
24
36
 
25
- Node Identity.
37
+ Static Context ID.
26
38
 
27
- ### StaticUserIdentity
39
+ ### Tenant
28
40
 
29
- > `readonly` **StaticUserIdentity**: `"static-user-identity"` = `"static-user-identity"`
41
+ > `readonly` **Tenant**: `"tenant"` = `"tenant"`
30
42
 
31
- Static User Identity.
43
+ Tenant.
32
44
 
33
45
  ### RestRoute
34
46
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Socket route processor types.
6
6
 
7
- ## Type declaration
7
+ ## Type Declaration
8
8
 
9
9
  ### AuthHeader
10
10
 
@@ -12,23 +12,35 @@ Socket route processor types.
12
12
 
13
13
  Auth header.
14
14
 
15
+ ### AuthVerifiableCredential
16
+
17
+ > `readonly` **AuthVerifiableCredential**: `"auth-verifiable-credential"` = `"auth-verifiable-credential"`
18
+
19
+ Auth verifiable credential.
20
+
15
21
  ### Logging
16
22
 
17
23
  > `readonly` **Logging**: `"logging"` = `"logging"`
18
24
 
19
25
  Logging.
20
26
 
21
- ### NodeIdentity
27
+ ### ContextId
28
+
29
+ > `readonly` **ContextId**: `"context-id"` = `"context-id"`
30
+
31
+ Context ID.
32
+
33
+ ### StaticContextId
22
34
 
23
- > `readonly` **NodeIdentity**: `"node-identity"` = `"node-identity"`
35
+ > `readonly` **StaticContextId**: `"static-context-id"` = `"static-context-id"`
24
36
 
25
- Node Identity.
37
+ Static Context ID.
26
38
 
27
- ### StaticUserIdentity
39
+ ### Tenant
28
40
 
29
- > `readonly` **StaticUserIdentity**: `"static-user-identity"` = `"static-user-identity"`
41
+ > `readonly` **Tenant**: `"tenant"` = `"tenant"`
30
42
 
31
- Static User Identity.
43
+ Tenant.
32
44
 
33
45
  ### SocketRoute
34
46