@twin.org/engine-server-types 0.0.2-next.2 → 0.0.2-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 (29) hide show
  1. package/dist/cjs/index.cjs +109 -164
  2. package/dist/esm/index.mjs +110 -165
  3. package/dist/types/components/authentication.d.ts +7 -4
  4. package/dist/types/components/authenticationAdmin.d.ts +7 -4
  5. package/dist/types/components/information.d.ts +7 -4
  6. package/dist/types/components/mimeTypeProcessor.d.ts +8 -4
  7. package/dist/types/components/restRouteProcessor.d.ts +9 -5
  8. package/dist/types/components/socketRouteProcessor.d.ts +8 -4
  9. package/dist/types/models/config/restRouteProcessorConfig.d.ts +4 -0
  10. package/dist/types/models/config/socketRouteProcessorConfig.d.ts +4 -0
  11. package/dist/types/models/types/restRouteProcessorType.d.ts +4 -0
  12. package/dist/types/models/types/socketRouteProcessorType.d.ts +4 -0
  13. package/docs/changelog.md +285 -0
  14. package/docs/reference/functions/initialiseAuthenticationAdminComponent.md +3 -13
  15. package/docs/reference/functions/initialiseAuthenticationComponent.md +3 -13
  16. package/docs/reference/functions/initialiseInformationComponent.md +3 -13
  17. package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +3 -13
  18. package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +3 -13
  19. package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +3 -13
  20. package/docs/reference/interfaces/IEngineServerConfig.md +1 -1
  21. package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
  22. package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
  23. package/docs/reference/variables/AuthenticationAdminComponentType.md +1 -1
  24. package/docs/reference/variables/AuthenticationComponentType.md +1 -1
  25. package/docs/reference/variables/InformationComponentType.md +1 -1
  26. package/docs/reference/variables/MimeTypeProcessorType.md +1 -1
  27. package/docs/reference/variables/RestRouteProcessorType.md +7 -1
  28. package/docs/reference/variables/SocketRouteProcessorType.md +7 -1
  29. package/package.json +12 -3
package/docs/changelog.md CHANGED
@@ -1,5 +1,290 @@
1
1
  # @twin.org/engine-server-types - Changelog
2
2
 
3
+ ## [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)
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.2-next.20 to 0.0.2-next.21
16
+ * @twin.org/engine-types bumped from 0.0.2-next.20 to 0.0.2-next.21
17
+
18
+ ## [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)
19
+
20
+
21
+ ### Features
22
+
23
+ * standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/engine-models bumped from 0.0.2-next.19 to 0.0.2-next.20
31
+ * @twin.org/engine-types bumped from 0.0.2-next.19 to 0.0.2-next.20
32
+
33
+ ## [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)
34
+
35
+
36
+ ### Features
37
+
38
+ * simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
39
+
40
+
41
+ ### Dependencies
42
+
43
+ * The following workspace dependencies were updated
44
+ * dependencies
45
+ * @twin.org/engine-models bumped from 0.0.2-next.18 to 0.0.2-next.19
46
+ * @twin.org/engine-types bumped from 0.0.2-next.18 to 0.0.2-next.19
47
+
48
+ ## [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)
49
+
50
+
51
+ ### Features
52
+
53
+ * upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
54
+
55
+
56
+ ### Dependencies
57
+
58
+ * The following workspace dependencies were updated
59
+ * dependencies
60
+ * @twin.org/engine-models bumped from 0.0.2-next.17 to 0.0.2-next.18
61
+ * @twin.org/engine-types bumped from 0.0.2-next.17 to 0.0.2-next.18
62
+
63
+ ## [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)
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.2-next.16 to 0.0.2-next.17
76
+ * @twin.org/engine-types bumped from 0.0.2-next.16 to 0.0.2-next.17
77
+
78
+ ## [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)
79
+
80
+
81
+ ### Miscellaneous Chores
82
+
83
+ * **engine-server-types:** Synchronize repo versions
84
+
85
+
86
+ ### Dependencies
87
+
88
+ * The following workspace dependencies were updated
89
+ * dependencies
90
+ * @twin.org/engine-models bumped from 0.0.2-next.15 to 0.0.2-next.16
91
+ * @twin.org/engine-types bumped from 0.0.2-next.15 to 0.0.2-next.16
92
+
93
+ ## [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)
94
+
95
+
96
+ ### Features
97
+
98
+ * update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
99
+
100
+
101
+ ### Dependencies
102
+
103
+ * The following workspace dependencies were updated
104
+ * dependencies
105
+ * @twin.org/engine-models bumped from 0.0.2-next.14 to 0.0.2-next.15
106
+ * @twin.org/engine-types bumped from 0.0.2-next.14 to 0.0.2-next.15
107
+
108
+ ## [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)
109
+
110
+
111
+ ### Features
112
+
113
+ * add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
114
+
115
+
116
+ ### Dependencies
117
+
118
+ * The following workspace dependencies were updated
119
+ * dependencies
120
+ * @twin.org/engine-models bumped from 0.0.2-next.13 to 0.0.2-next.14
121
+ * @twin.org/engine-types bumped from 0.0.2-next.13 to 0.0.2-next.14
122
+
123
+ ## [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)
124
+
125
+
126
+ ### Miscellaneous Chores
127
+
128
+ * **engine-server-types:** Synchronize repo versions
129
+
130
+
131
+ ### Dependencies
132
+
133
+ * The following workspace dependencies were updated
134
+ * dependencies
135
+ * @twin.org/engine-models bumped from 0.0.2-next.12 to 0.0.2-next.13
136
+ * @twin.org/engine-types bumped from 0.0.2-next.12 to 0.0.2-next.13
137
+
138
+ ## [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)
139
+
140
+
141
+ ### Features
142
+
143
+ * add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
144
+
145
+
146
+ ### Dependencies
147
+
148
+ * The following workspace dependencies were updated
149
+ * dependencies
150
+ * @twin.org/engine-models bumped from 0.0.2-next.11 to 0.0.2-next.12
151
+ * @twin.org/engine-types bumped from 0.0.2-next.11 to 0.0.2-next.12
152
+
153
+ ## [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)
154
+
155
+
156
+ ### Features
157
+
158
+ * eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
159
+
160
+
161
+ ### Dependencies
162
+
163
+ * The following workspace dependencies were updated
164
+ * dependencies
165
+ * @twin.org/engine-models bumped from 0.0.2-next.10 to 0.0.2-next.11
166
+ * @twin.org/engine-types bumped from 0.0.2-next.10 to 0.0.2-next.11
167
+
168
+ ## [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)
169
+
170
+
171
+ ### Features
172
+
173
+ * add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
174
+
175
+
176
+ ### Dependencies
177
+
178
+ * The following workspace dependencies were updated
179
+ * dependencies
180
+ * @twin.org/engine-models bumped from 0.0.2-next.9 to 0.0.2-next.10
181
+ * @twin.org/engine-types bumped from 0.0.2-next.9 to 0.0.2-next.10
182
+
183
+ ## [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)
184
+
185
+
186
+ ### Miscellaneous Chores
187
+
188
+ * **engine-server-types:** Synchronize repo versions
189
+
190
+
191
+ ### Dependencies
192
+
193
+ * The following workspace dependencies were updated
194
+ * dependencies
195
+ * @twin.org/engine-models bumped from 0.0.2-next.8 to 0.0.2-next.9
196
+ * @twin.org/engine-types bumped from 0.0.2-next.8 to 0.0.2-next.9
197
+
198
+ ## [0.0.2-next.8](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.7...engine-server-types-v0.0.2-next.8) (2025-08-22)
199
+
200
+
201
+ ### Features
202
+
203
+ * add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
204
+
205
+
206
+ ### Dependencies
207
+
208
+ * The following workspace dependencies were updated
209
+ * dependencies
210
+ * @twin.org/engine-models bumped from 0.0.2-next.7 to 0.0.2-next.8
211
+ * @twin.org/engine-types bumped from 0.0.2-next.7 to 0.0.2-next.8
212
+
213
+ ## [0.0.2-next.7](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.6...engine-server-types-v0.0.2-next.7) (2025-08-22)
214
+
215
+
216
+ ### Miscellaneous Chores
217
+
218
+ * **engine-server-types:** Synchronize repo versions
219
+
220
+
221
+ ### Dependencies
222
+
223
+ * The following workspace dependencies were updated
224
+ * dependencies
225
+ * @twin.org/engine-models bumped from 0.0.2-next.6 to 0.0.2-next.7
226
+ * @twin.org/engine-types bumped from 0.0.2-next.6 to 0.0.2-next.7
227
+
228
+ ## [0.0.2-next.6](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.5...engine-server-types-v0.0.2-next.6) (2025-08-21)
229
+
230
+
231
+ ### Features
232
+
233
+ * update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
234
+
235
+
236
+ ### Dependencies
237
+
238
+ * The following workspace dependencies were updated
239
+ * dependencies
240
+ * @twin.org/engine-models bumped from 0.0.2-next.5 to 0.0.2-next.6
241
+ * @twin.org/engine-types bumped from 0.0.2-next.5 to 0.0.2-next.6
242
+
243
+ ## [0.0.2-next.5](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.4...engine-server-types-v0.0.2-next.5) (2025-08-14)
244
+
245
+
246
+ ### Features
247
+
248
+ * add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
249
+
250
+
251
+ ### Dependencies
252
+
253
+ * The following workspace dependencies were updated
254
+ * dependencies
255
+ * @twin.org/engine-models bumped from 0.0.2-next.4 to 0.0.2-next.5
256
+ * @twin.org/engine-types bumped from 0.0.2-next.4 to 0.0.2-next.5
257
+
258
+ ## [0.0.2-next.4](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.3...engine-server-types-v0.0.2-next.4) (2025-07-25)
259
+
260
+
261
+ ### Features
262
+
263
+ * add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
264
+
265
+
266
+ ### Dependencies
267
+
268
+ * The following workspace dependencies were updated
269
+ * dependencies
270
+ * @twin.org/engine-models bumped from 0.0.2-next.3 to 0.0.2-next.4
271
+ * @twin.org/engine-types bumped from 0.0.2-next.3 to 0.0.2-next.4
272
+
273
+ ## [0.0.2-next.3](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.2...engine-server-types-v0.0.2-next.3) (2025-07-24)
274
+
275
+
276
+ ### Miscellaneous Chores
277
+
278
+ * **engine-server-types:** Synchronize repo versions
279
+
280
+
281
+ ### Dependencies
282
+
283
+ * The following workspace dependencies were updated
284
+ * dependencies
285
+ * @twin.org/engine-models bumped from 0.0.2-next.2 to 0.0.2-next.3
286
+ * @twin.org/engine-types bumped from 0.0.2-next.2 to 0.0.2-next.3
287
+
3
288
  ## [0.0.2-next.2](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.1...engine-server-types-v0.0.2-next.2) (2025-07-21)
4
289
 
5
290
 
@@ -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* [`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`; \}
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* [`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`; \}
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,6 +12,12 @@ 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"`
@@ -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,6 +12,12 @@ 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"`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/engine-server-types",
3
- "version": "0.0.2-next.2",
3
+ "version": "0.0.2-next.21",
4
4
  "description": "Server types to use in an engine server.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -23,9 +23,10 @@
23
23
  "@twin.org/api-server-fastify": "next",
24
24
  "@twin.org/api-service": "next",
25
25
  "@twin.org/core": "next",
26
- "@twin.org/engine-models": "0.0.2-next.2",
27
- "@twin.org/engine-types": "0.0.2-next.2",
26
+ "@twin.org/engine-models": "0.0.2-next.21",
27
+ "@twin.org/engine-types": "0.0.2-next.21",
28
28
  "@twin.org/entity": "next",
29
+ "@twin.org/identity-authentication": "next",
29
30
  "@twin.org/nameof": "next"
30
31
  },
31
32
  "main": "./dist/cjs/index.cjs",
@@ -45,5 +46,13 @@
45
46
  "dist/types",
46
47
  "locales",
47
48
  "docs"
49
+ ],
50
+ "keywords": [
51
+ "twin",
52
+ "trade",
53
+ "iota",
54
+ "framework",
55
+ "blockchain",
56
+ "engine"
48
57
  ]
49
58
  }