@twin.org/engine-server-types 0.0.3-next.25 → 0.0.3-next.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TWIN Engine Server Types
2
2
 
3
- The data types to use in an engine server.
3
+ Engine Server Types defines server-focused component and processor types for hosting and API route handling. It provides the configuration model for building predictable REST and socket integration behaviour.
4
4
 
5
5
  ## Installation
6
6
 
package/docs/changelog.md CHANGED
@@ -1,4 +1,34 @@
1
- # @twin.org/engine-server-types - Changelog
1
+ # Changelog
2
+
3
+ ## [0.0.3-next.27](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.26...engine-server-types-v0.0.3-next.27) (2026-03-20)
4
+
5
+
6
+ ### Features
7
+
8
+ * update dependencies ([e6ebe42](https://github.com/twinfoundation/engine/commit/e6ebe42b9d61066227ad8b45dae14c8f8615b760))
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.26 to 0.0.3-next.27
16
+ * @twin.org/engine-types bumped from 0.0.3-next.26 to 0.0.3-next.27
17
+
18
+ ## [0.0.3-next.26](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.25...engine-server-types-v0.0.3-next.26) (2026-03-05)
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.25 to 0.0.3-next.26
31
+ * @twin.org/engine-types bumped from 0.0.3-next.25 to 0.0.3-next.26
2
32
 
3
33
  ## [0.0.3-next.25](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.24...engine-server-types-v0.0.3-next.25) (2026-03-02)
4
34
 
package/docs/examples.md CHANGED
@@ -1 +1,64 @@
1
- # @twin.org/engine-server-types - Examples
1
+ # Engine Server Types Examples
2
+
3
+ These examples demonstrate how to compose server configuration with shared type constants for REST and socket processing.
4
+
5
+ ## Component and Processor Types
6
+
7
+ ```typescript
8
+ import {
9
+ AuthenticationComponentType,
10
+ HostingComponentType,
11
+ InformationComponentType,
12
+ RestRouteProcessorType,
13
+ SocketRouteProcessorType
14
+ } from '@twin.org/engine-server-types';
15
+
16
+ const selectedTypes = {
17
+ authentication: AuthenticationComponentType.Service,
18
+ hosting: HostingComponentType.Service,
19
+ information: InformationComponentType.Service,
20
+ restProcessor: RestRouteProcessorType.RestRoute,
21
+ socketProcessor: SocketRouteProcessorType.SocketRoute
22
+ };
23
+
24
+ console.log(selectedTypes.authentication); // "service"
25
+ console.log(selectedTypes.restProcessor); // "rest-route"
26
+ ```
27
+
28
+ ## IEngineServerConfig
29
+
30
+ ```typescript
31
+ import type { IEngineServerConfig } from '@twin.org/engine-server-types';
32
+ import {
33
+ AuthenticationComponentType,
34
+ HostingComponentType,
35
+ InformationComponentType,
36
+ RestRouteProcessorType,
37
+ SocketRouteProcessorType
38
+ } from '@twin.org/engine-server-types';
39
+
40
+ const serverConfig: IEngineServerConfig = {
41
+ debug: true,
42
+ silent: false,
43
+ web: {
44
+ port: 3001,
45
+ host: '0.0.0.0'
46
+ },
47
+ types: {
48
+ hostingComponent: [{ type: HostingComponentType.Service }],
49
+ informationComponent: [{ type: InformationComponentType.Service, restPath: '/info' }],
50
+ authenticationComponent: [{ type: AuthenticationComponentType.Service }],
51
+ restRouteProcessor: [
52
+ { type: RestRouteProcessorType.Logging },
53
+ { type: RestRouteProcessorType.RestRoute }
54
+ ],
55
+ socketRouteProcessor: [
56
+ { type: SocketRouteProcessorType.Logging },
57
+ { type: SocketRouteProcessorType.SocketRoute }
58
+ ]
59
+ }
60
+ };
61
+
62
+ console.log(serverConfig.web?.port); // 3001
63
+ console.log(serverConfig.types.restRouteProcessor?.length ?? 0); // 2
64
+ ```
@@ -8,15 +8,51 @@ Extended engine server config with known types.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### web?
11
+ ### debug? {#debug}
12
12
 
13
- > `optional` **web**: `IWebServerOptions`
13
+ > `optional` **debug?**: `boolean`
14
+
15
+ Start the engine in debug mode.
16
+
17
+ #### Default
18
+
19
+ ```ts
20
+ false
21
+ ```
22
+
23
+ #### Inherited from
24
+
25
+ `IEngineConfig.debug`
26
+
27
+ ***
28
+
29
+ ### silent? {#silent}
30
+
31
+ > `optional` **silent?**: `boolean`
32
+
33
+ Disable output to the console.
34
+
35
+ #### Default
36
+
37
+ ```ts
38
+ false
39
+ ```
40
+
41
+ #### Inherited from
42
+
43
+ `IEngineConfig.silent`
44
+
45
+ ***
46
+
47
+ ### web? {#web}
48
+
49
+ > `optional` **web?**: `IWebServerOptions`
14
50
 
15
51
  Configuration for the web server.
16
52
 
17
53
  ***
18
54
 
19
- ### types
55
+ ### types {#types}
20
56
 
21
57
  > **types**: `object` & `object`
22
58
 
@@ -24,45 +60,437 @@ The types to initialise in the engine.
24
60
 
25
61
  #### Type Declaration
26
62
 
63
+ ##### loggingConnector?
64
+
65
+ > `optional` **loggingConnector?**: `IEngineCoreTypeConfig`\<`LoggingConnectorConfig`\>[]
66
+
67
+ Logging connector options which can be overridden by individual components by specifying types other than default.
68
+
69
+ ##### loggingComponent?
70
+
71
+ > `optional` **loggingComponent?**: `IEngineCoreTypeConfig`\<`LoggingComponentConfig`\>[]
72
+
73
+ Logging component options which can be overridden by individual components by specifying types other than default.
74
+
75
+ ##### entityStorageConnector?
76
+
77
+ > `optional` **entityStorageConnector?**: `IEngineCoreTypeConfig`\<`EntityStorageConnectorConfig`\>[]
78
+
79
+ Entity storage connector options which can be overridden by individual components by specifying types other than default.
80
+
81
+ ##### entityStorageComponent?
82
+
83
+ > `optional` **entityStorageComponent?**: `IEngineCoreTypeConfig`\<`EntityStorageComponentConfig`\>[]
84
+
85
+ Entity storage component options which can be overridden by individual components by specifying types other than default.
86
+
87
+ ##### blobStorageConnector?
88
+
89
+ > `optional` **blobStorageConnector?**: `IEngineCoreTypeConfig`\<`BlobStorageConnectorConfig`\>[]
90
+
91
+ Blob storage connector options which can be overridden by individual components by specifying types other than default.
92
+
93
+ ##### blobStorageComponent?
94
+
95
+ > `optional` **blobStorageComponent?**: `IEngineCoreTypeConfig`\<`BlobStorageComponentConfig`\>[]
96
+
97
+ Blob storage component options which can be overridden by individual components by specifying types other than default.
98
+
99
+ ##### telemetryConnector?
100
+
101
+ > `optional` **telemetryConnector?**: `IEngineCoreTypeConfig`\<`TelemetryConnectorConfig`\>[]
102
+
103
+ Telemetry connector options which can be overridden by individual components by specifying types other than default.
104
+
105
+ ##### telemetryComponent?
106
+
107
+ > `optional` **telemetryComponent?**: `IEngineCoreTypeConfig`\<`TelemetryComponentConfig`\>[]
108
+
109
+ Telemetry component options which can be overridden by individual components by specifying types other than default.
110
+
111
+ ##### messagingEmailConnector?
112
+
113
+ > `optional` **messagingEmailConnector?**: `IEngineCoreTypeConfig`\<`MessagingEmailConnectorConfig`\>[]
114
+
115
+ Messaging email connector options which can be overridden by individual components by specifying types other than default.
116
+
117
+ ##### messagingSmsConnector?
118
+
119
+ > `optional` **messagingSmsConnector?**: `IEngineCoreTypeConfig`\<`MessagingSmsConnectorConfig`\>[]
120
+
121
+ Messaging SMS connector options which can be overridden by individual components by specifying types other than default.
122
+
123
+ ##### messagingPushNotificationConnector?
124
+
125
+ > `optional` **messagingPushNotificationConnector?**: `IEngineCoreTypeConfig`\<`MessagingPushNotificationConnectorConfig`\>[]
126
+
127
+ Messaging push notification connector options which can be overridden by individual components by specifying types other than default.
128
+
129
+ ##### messagingAdminComponent?
130
+
131
+ > `optional` **messagingAdminComponent?**: `IEngineCoreTypeConfig`\<`MessagingAdminComponentConfig`\>[]
132
+
133
+ Messaging admin component options which can be overridden by individual components by specifying types other than default.
134
+
135
+ ##### messagingComponent?
136
+
137
+ > `optional` **messagingComponent?**: `IEngineCoreTypeConfig`\<`MessagingComponentConfig`\>[]
138
+
139
+ Messaging component options which can be overridden by individual components by specifying types other than default.
140
+
141
+ ##### backgroundTaskComponent?
142
+
143
+ > `optional` **backgroundTaskComponent?**: `IEngineCoreTypeConfig`\<`BackgroundTaskComponentConfig`\>[]
144
+
145
+ Background task component options which can be overridden by individual components by specifying types other than default.
146
+
147
+ ##### taskSchedulerComponent?
148
+
149
+ > `optional` **taskSchedulerComponent?**: `IEngineCoreTypeConfig`\<`TaskSchedulerComponentConfig`\>[]
150
+
151
+ Task scheduler component options which can be overridden by individual components by specifying types other than default.
152
+
153
+ ##### eventBusConnector?
154
+
155
+ > `optional` **eventBusConnector?**: `IEngineCoreTypeConfig`\<`EventBusConnectorConfig`\>[]
156
+
157
+ Event bus connector options which can be overridden by individual components by specifying types other than default.
158
+
159
+ ##### eventBusComponent?
160
+
161
+ > `optional` **eventBusComponent?**: `IEngineCoreTypeConfig`\<`EventBusComponentConfig`\>[]
162
+
163
+ Event bus component options which can be overridden by individual components by specifying types other than default.
164
+
165
+ ##### vaultConnector?
166
+
167
+ > `optional` **vaultConnector?**: `IEngineCoreTypeConfig`\<`VaultConnectorConfig`\>[]
168
+
169
+ Vault connector options which can be overridden by individual components by specifying types other than default.
170
+
171
+ ##### dltConfig?
172
+
173
+ > `optional` **dltConfig?**: `IEngineCoreTypeConfig`\<`DltConfig`\>[]
174
+
175
+ DLT options which can be overridden by individual components by specifying types other than default.
176
+
177
+ ##### walletConnector?
178
+
179
+ > `optional` **walletConnector?**: `IEngineCoreTypeConfig`\<`WalletConnectorConfig`\>[]
180
+
181
+ Wallet connector options which can be overridden by individual components by specifying types other than default.
182
+
183
+ ##### verifiableStorageConnector?
184
+
185
+ > `optional` **verifiableStorageConnector?**: `IEngineCoreTypeConfig`\<`VerifiableStorageConnectorConfig`\>[]
186
+
187
+ Verifiable storage connector options which can be overridden by individual components by specifying types other than default.
188
+
189
+ ##### verifiableStorageComponent?
190
+
191
+ > `optional` **verifiableStorageComponent?**: `IEngineCoreTypeConfig`\<`VerifiableStorageComponentConfig`\>[]
192
+
193
+ Verifiable storage component options which can be overridden by individual components by specifying types other than default.
194
+
195
+ ##### immutableProofComponent?
196
+
197
+ > `optional` **immutableProofComponent?**: `IEngineCoreTypeConfig`\<`ImmutableProofComponentConfig`\>[]
198
+
199
+ Immutable proof component options which can be overridden by individual components by specifying types other than default.
200
+
201
+ ##### faucetConnector?
202
+
203
+ > `optional` **faucetConnector?**: `IEngineCoreTypeConfig`\<`FaucetConnectorConfig`\>[]
204
+
205
+ Faucet connector options which can be overridden by individual components by specifying types other than default.
206
+
207
+ ##### identityConnector?
208
+
209
+ > `optional` **identityConnector?**: `IEngineCoreTypeConfig`\<`IdentityConnectorConfig`\>[]
210
+
211
+ Identity connector options which can be overridden by individual components by specifying types other than default.
212
+
213
+ ##### identityComponent?
214
+
215
+ > `optional` **identityComponent?**: `IEngineCoreTypeConfig`\<`IdentityComponentConfig`\>[]
216
+
217
+ Identity component options which can be overridden by individual components by specifying types other than default.
218
+
219
+ ##### identityResolverConnector?
220
+
221
+ > `optional` **identityResolverConnector?**: `IEngineCoreTypeConfig`\<`IdentityResolverConnectorConfig`\>[]
222
+
223
+ Identity resolver connector options which can be overridden by individual components by specifying types other than default.
224
+
225
+ ##### identityResolverComponent?
226
+
227
+ > `optional` **identityResolverComponent?**: `IEngineCoreTypeConfig`\<`IdentityResolverComponentConfig`\>[]
228
+
229
+ Identity resolver component options which can be overridden by individual components by specifying types other than default.
230
+
231
+ ##### identityProfileConnector?
232
+
233
+ > `optional` **identityProfileConnector?**: `IEngineCoreTypeConfig`\<`IdentityProfileConnectorConfig`\>[]
234
+
235
+ Identity profile connector options which can be overridden by individual components by specifying types other than default.
236
+
237
+ ##### identityProfileComponent?
238
+
239
+ > `optional` **identityProfileComponent?**: `IEngineCoreTypeConfig`\<`IdentityProfileComponentConfig`\>[]
240
+
241
+ Identity profile component options which can be overridden by individual components by specifying types other than default.
242
+
243
+ ##### nftConnector?
244
+
245
+ > `optional` **nftConnector?**: `IEngineCoreTypeConfig`\<`NftConnectorConfig`\>[]
246
+
247
+ NFT connector options which can be overridden by individual components by specifying types other than default.
248
+
249
+ ##### nftComponent?
250
+
251
+ > `optional` **nftComponent?**: `IEngineCoreTypeConfig`\<`NftComponentConfig`\>[]
252
+
253
+ NFT component options which can be overridden by individual components by specifying types other than default.
254
+
255
+ ##### attestationConnector?
256
+
257
+ > `optional` **attestationConnector?**: `IEngineCoreTypeConfig`\<`AttestationConnectorConfig`\>[]
258
+
259
+ Attestation connector options which can be overridden by individual components by specifying types other than default.
260
+
261
+ ##### attestationComponent?
262
+
263
+ > `optional` **attestationComponent?**: `IEngineCoreTypeConfig`\<`AttestationComponentConfig`\>[]
264
+
265
+ Attestation component options which can be overridden by individual components by specifying types other than default.
266
+
267
+ ##### auditableItemGraphComponent?
268
+
269
+ > `optional` **auditableItemGraphComponent?**: `IEngineCoreTypeConfig`\<`AuditableItemGraphComponentConfig`\>[]
270
+
271
+ Auditable item graph component options which can be overridden by individual components by specifying types other than default.
272
+
273
+ ##### auditableItemStreamComponent?
274
+
275
+ > `optional` **auditableItemStreamComponent?**: `IEngineCoreTypeConfig`\<`AuditableItemStreamComponentConfig`\>[]
276
+
277
+ Auditable item stream component options which can be overridden by individual components by specifying types other than default.
278
+
279
+ ##### dataConverterConnector?
280
+
281
+ > `optional` **dataConverterConnector?**: `IEngineCoreTypeConfig`\<`DataConverterConnectorConfig`\>[]
282
+
283
+ Data converter connector options which can be overridden by individual components by specifying types other than default.
284
+
285
+ ##### dataExtractorConnector?
286
+
287
+ > `optional` **dataExtractorConnector?**: `IEngineCoreTypeConfig`\<`DataExtractorConnectorConfig`\>[]
288
+
289
+ Data extractor connector options which can be overridden by individual components by specifying types other than default.
290
+
291
+ ##### dataProcessingComponent?
292
+
293
+ > `optional` **dataProcessingComponent?**: `IEngineCoreTypeConfig`\<`DataProcessingComponentConfig`\>[]
294
+
295
+ Date processing options which can be overridden by individual components by specifying types other than default.
296
+
297
+ ##### documentManagementComponent?
298
+
299
+ > `optional` **documentManagementComponent?**: `IEngineCoreTypeConfig`\<`DocumentManagementComponentConfig`\>[]
300
+
301
+ Document management options which can be overridden by individual components by specifying types other than default.
302
+
303
+ ##### trustComponent?
304
+
305
+ > `optional` **trustComponent?**: `IEngineCoreTypeConfig`\<`TrustComponentConfig`\>[]
306
+
307
+ Trust component options which can be overridden by individual components by specifying types other than default.
308
+
309
+ ##### trustGeneratorComponent?
310
+
311
+ > `optional` **trustGeneratorComponent?**: `IEngineCoreTypeConfig`\<`TrustGeneratorComponentConfig`\>[]
312
+
313
+ Trust generator component options which can be overridden by individual components by specifying types other than default.
314
+
315
+ ##### trustVerifierComponent?
316
+
317
+ > `optional` **trustVerifierComponent?**: `IEngineCoreTypeConfig`\<`TrustVerifierComponentConfig`\>[]
318
+
319
+ Trust verifier component options which can be overridden by individual components by specifying types other than default.
320
+
321
+ ##### rightsManagementPapComponent?
322
+
323
+ > `optional` **rightsManagementPapComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPapComponentConfig`\>[]
324
+
325
+ Rights management PAP options which can be overridden by individual components by specifying types other than default.
326
+
327
+ ##### rightsManagementPdpComponent?
328
+
329
+ > `optional` **rightsManagementPdpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPdpComponentConfig`\>[]
330
+
331
+ Rights management PDP options which can be overridden by individual components by specifying types other than default.
332
+
333
+ ##### rightsManagementPepComponent?
334
+
335
+ > `optional` **rightsManagementPepComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPepComponentConfig`\>[]
336
+
337
+ Rights management PEP options which can be overridden by individual components by specifying types other than default.
338
+
339
+ ##### rightsManagementPipComponent?
340
+
341
+ > `optional` **rightsManagementPipComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPipComponentConfig`\>[]
342
+
343
+ Rights management PIP options which can be overridden by individual components by specifying types other than default.
344
+
345
+ ##### rightsManagementPmpComponent?
346
+
347
+ > `optional` **rightsManagementPmpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPmpComponentConfig`\>[]
348
+
349
+ Rights management PMP options which can be overridden by individual components by specifying types other than default.
350
+
351
+ ##### rightsManagementPxpComponent?
352
+
353
+ > `optional` **rightsManagementPxpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPxpComponentConfig`\>[]
354
+
355
+ Rights management PXP options which can be overridden by individual components by specifying types other than default.
356
+
357
+ ##### rightsManagementPnpComponent?
358
+
359
+ > `optional` **rightsManagementPnpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPnpComponentConfig`\>[]
360
+
361
+ Rights management PNP options which can be overridden by individual components by specifying types other than default.
362
+
363
+ ##### rightsManagementPnapComponent?
364
+
365
+ > `optional` **rightsManagementPnapComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPnapComponentConfig`\>[]
366
+
367
+ Rights management PNAP options which can be overridden by individual components by specifying types other than default.
368
+
369
+ ##### rightsManagementPolicyArbiterComponent?
370
+
371
+ > `optional` **rightsManagementPolicyArbiterComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyArbiterComponentConfig`\>[]
372
+
373
+ Rights management policy arbiter options which can be overridden by individual components by specifying types other than default.
374
+
375
+ ##### rightsManagementPolicyObligationEnforcerComponent?
376
+
377
+ > `optional` **rightsManagementPolicyObligationEnforcerComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyObligationEnforcerComponentConfig`\>[]
378
+
379
+ Rights management policy obligation enforcer options which can be overridden by individual components by specifying types other than default.
380
+
381
+ ##### rightsManagementPolicyEnforcementProcessorComponent?
382
+
383
+ > `optional` **rightsManagementPolicyEnforcementProcessorComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyEnforcementProcessorComponentConfig`\>[]
384
+
385
+ Rights management policy enforcement processor options which can be overridden by individual components by specifying types other than default.
386
+
387
+ ##### rightsManagementPolicyExecutionActionComponent?
388
+
389
+ > `optional` **rightsManagementPolicyExecutionActionComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyExecutionActionComponentConfig`\>[]
390
+
391
+ Rights management policy execution action options which can be overridden by individual components by specifying types other than default.
392
+
393
+ ##### rightsManagementPolicyInformationSourceComponent?
394
+
395
+ > `optional` **rightsManagementPolicyInformationSourceComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyInformationSourceComponentConfig`\>[]
396
+
397
+ Rights management policy information source options which can be overridden by individual components by specifying types other than default.
398
+
399
+ ##### rightsManagementPolicyNegotiatorComponent?
400
+
401
+ > `optional` **rightsManagementPolicyNegotiatorComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyNegotiatorComponentConfig`\>[]
402
+
403
+ Rights management policy negotiator options which can be overridden by individual components by specifying types other than default.
404
+
405
+ ##### rightsManagementPolicyRequesterComponent?
406
+
407
+ > `optional` **rightsManagementPolicyRequesterComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyRequesterComponentConfig`\>[]
408
+
409
+ Rights management policy requester options which can be overridden by individual components by specifying types other than default.
410
+
411
+ ##### synchronisedStorageComponent?
412
+
413
+ > `optional` **synchronisedStorageComponent?**: `IEngineCoreTypeConfig`\<`SynchronisedStorageComponentConfig`\>[]
414
+
415
+ Synchronised storage options which can be overridden by individual components by specifying types other than default.
416
+
417
+ ##### federatedCatalogueComponent?
418
+
419
+ > `optional` **federatedCatalogueComponent?**: `IEngineCoreTypeConfig`\<`FederatedCatalogueComponentConfig`\>[]
420
+
421
+ Federated catalogue options which can be overridden by individual components by specifying types other than default.
422
+
423
+ ##### federatedCatalogueFilterComponent?
424
+
425
+ > `optional` **federatedCatalogueFilterComponent?**: `IEngineCoreTypeConfig`\<`FederatedCatalogueFilterComponentConfig`\>[]
426
+
427
+ Federated catalogue filter options which can be overridden by individual components by specifying types other than default.
428
+
429
+ ##### dataspaceControlPlaneComponent?
430
+
431
+ > `optional` **dataspaceControlPlaneComponent?**: `IEngineCoreTypeConfig`\<`DataspaceControlPlaneComponentConfig`\>[]
432
+
433
+ Dataspace control plane component options which can be overridden by individual components by specifying types other than default.
434
+
435
+ ##### dataspaceDataPlaneComponent?
436
+
437
+ > `optional` **dataspaceDataPlaneComponent?**: `IEngineCoreTypeConfig`\<`DataspaceDataPlaneComponentConfig`\>[]
438
+
439
+ Dataspace data plane component options which can be overridden by individual components by specifying types other than default.
440
+
441
+ ##### tenantAdminComponent?
442
+
443
+ > `optional` **tenantAdminComponent?**: `IEngineCoreTypeConfig`\<`TenantAdminComponentConfig`\>[]
444
+
445
+ Tenant admin component options which can be overridden by individual components by specifying types other than default.
446
+
447
+ ##### contextIdHandlerComponent?
448
+
449
+ > `optional` **contextIdHandlerComponent?**: `IEngineCoreTypeConfig`\<`ContextIdHandlerComponentConfig`\>[]
450
+
451
+ Context Id Handler component options which can be overridden by individual components by specifying types other than default.
452
+
453
+ #### Type Declaration
454
+
27
455
  ##### informationComponent?
28
456
 
29
- > `optional` **informationComponent**: `IEngineCoreTypeConfig`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
457
+ > `optional` **informationComponent?**: `IEngineCoreTypeConfig`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
30
458
 
31
459
  Information component options which can be overridden by individual components by specifying types other than default.
32
460
 
33
461
  ##### hostingComponent?
34
462
 
35
- > `optional` **hostingComponent**: `IEngineCoreTypeConfig`\<[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md)\>[]
463
+ > `optional` **hostingComponent?**: `IEngineCoreTypeConfig`\<[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md)\>[]
36
464
 
37
465
  Hosting component options which can be overridden by individual components by specifying types other than default.
38
466
 
39
467
  ##### restRouteProcessor?
40
468
 
41
- > `optional` **restRouteProcessor**: `IEngineCoreTypeConfig`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
469
+ > `optional` **restRouteProcessor?**: `IEngineCoreTypeConfig`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
42
470
 
43
471
  REST route processors options which can be overridden by individual components by specifying types other than default.
44
472
 
45
473
  ##### socketRouteProcessor?
46
474
 
47
- > `optional` **socketRouteProcessor**: `IEngineCoreTypeConfig`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
475
+ > `optional` **socketRouteProcessor?**: `IEngineCoreTypeConfig`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
48
476
 
49
477
  Socket route processors options which can be overridden by individual components by specifying types other than default.
50
478
 
51
479
  ##### mimeTypeProcessor?
52
480
 
53
- > `optional` **mimeTypeProcessor**: `IEngineCoreTypeConfig`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
481
+ > `optional` **mimeTypeProcessor?**: `IEngineCoreTypeConfig`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
54
482
 
55
483
  Mime type processors options which can be overridden by individual components by specifying types other than default.
56
484
 
57
485
  ##### authenticationComponent?
58
486
 
59
- > `optional` **authenticationComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
487
+ > `optional` **authenticationComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
60
488
 
61
489
  Authentication component options which can be overridden by individual components by specifying types other than default.
62
490
 
63
491
  ##### authenticationAdminComponent?
64
492
 
65
- > `optional` **authenticationAdminComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md)\>[]
493
+ > `optional` **authenticationAdminComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md)\>[]
66
494
 
67
495
  Authentication admin component options which can be overridden by individual components by specifying types other than default.
68
496
 
@@ -6,12 +6,12 @@ Authentication admin component config types.
6
6
 
7
7
  ## Properties
8
8
 
9
- ### type
9
+ ### type {#type}
10
10
 
11
11
  > **type**: *typeof* [`EntityStorage`](../variables/AuthenticationAdminComponentType.md#entitystorage)
12
12
 
13
13
  ***
14
14
 
15
- ### options?
15
+ ### options? {#options}
16
16
 
17
- > `optional` **options**: `IEntityStorageAuthenticationAdminServiceConstructorOptions`
17
+ > `optional` **options?**: `IEntityStorageAuthenticationAdminServiceConstructorOptions`
@@ -6,12 +6,12 @@ Hosting component config types.
6
6
 
7
7
  ## Properties
8
8
 
9
- ### type
9
+ ### type {#type}
10
10
 
11
11
  > **type**: *typeof* [`Service`](../variables/HostingComponentType.md#service)
12
12
 
13
13
  ***
14
14
 
15
- ### options
15
+ ### options {#options}
16
16
 
17
17
  > **options**: `IHostingServiceConstructorOptions`
@@ -6,12 +6,12 @@ Mime type processor config types.
6
6
 
7
7
  ## Properties
8
8
 
9
- ### type
9
+ ### type {#type}
10
10
 
11
11
  > **type**: *typeof* [`Jwt`](../variables/MimeTypeProcessorType.md#jwt)
12
12
 
13
13
  ***
14
14
 
15
- ### options?
15
+ ### options? {#options}
16
16
 
17
- > `optional` **options**: `never`
17
+ > `optional` **options?**: `never`
@@ -6,7 +6,7 @@ Authentication admin component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### EntityStorage
9
+ ### EntityStorage {#entitystorage}
10
10
 
11
11
  > `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
12
12
 
@@ -6,13 +6,13 @@ Authentication component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### EntityStorage
9
+ ### EntityStorage {#entitystorage}
10
10
 
11
11
  > `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
12
12
 
13
13
  Entity storage.
14
14
 
15
- ### RestClient
15
+ ### RestClient {#restclient}
16
16
 
17
17
  > `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
18
18
 
@@ -6,7 +6,7 @@ Hosting component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Service
9
+ ### Service {#service}
10
10
 
11
11
  > `readonly` **Service**: `"service"` = `"service"`
12
12
 
@@ -6,13 +6,13 @@ Information component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Service
9
+ ### Service {#service}
10
10
 
11
11
  > `readonly` **Service**: `"service"` = `"service"`
12
12
 
13
13
  Service.
14
14
 
15
- ### RestClient
15
+ ### RestClient {#restclient}
16
16
 
17
17
  > `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
18
18
 
@@ -6,7 +6,7 @@ Mime type route processor types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Jwt
9
+ ### Jwt {#jwt}
10
10
 
11
11
  > `readonly` **Jwt**: `"jwt"` = `"jwt"`
12
12
 
@@ -6,43 +6,43 @@ REST route processor types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### AuthHeader
9
+ ### AuthHeader {#authheader}
10
10
 
11
11
  > `readonly` **AuthHeader**: `"auth-header"` = `"auth-header"`
12
12
 
13
13
  Auth header.
14
14
 
15
- ### AuthVerifiableCredential
15
+ ### AuthVerifiableCredential {#authverifiablecredential}
16
16
 
17
17
  > `readonly` **AuthVerifiableCredential**: `"auth-verifiable-credential"` = `"auth-verifiable-credential"`
18
18
 
19
19
  Auth verifiable credential.
20
20
 
21
- ### Logging
21
+ ### Logging {#logging}
22
22
 
23
23
  > `readonly` **Logging**: `"logging"` = `"logging"`
24
24
 
25
25
  Logging.
26
26
 
27
- ### ContextId
27
+ ### ContextId {#contextid}
28
28
 
29
29
  > `readonly` **ContextId**: `"context-id"` = `"context-id"`
30
30
 
31
31
  Context ID.
32
32
 
33
- ### StaticContextId
33
+ ### StaticContextId {#staticcontextid}
34
34
 
35
35
  > `readonly` **StaticContextId**: `"static-context-id"` = `"static-context-id"`
36
36
 
37
37
  Static Context ID.
38
38
 
39
- ### Tenant
39
+ ### Tenant {#tenant}
40
40
 
41
41
  > `readonly` **Tenant**: `"tenant"` = `"tenant"`
42
42
 
43
43
  Tenant.
44
44
 
45
- ### RestRoute
45
+ ### RestRoute {#restroute}
46
46
 
47
47
  > `readonly` **RestRoute**: `"rest-route"` = `"rest-route"`
48
48
 
@@ -6,43 +6,43 @@ Socket route processor types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### AuthHeader
9
+ ### AuthHeader {#authheader}
10
10
 
11
11
  > `readonly` **AuthHeader**: `"auth-header"` = `"auth-header"`
12
12
 
13
13
  Auth header.
14
14
 
15
- ### AuthVerifiableCredential
15
+ ### AuthVerifiableCredential {#authverifiablecredential}
16
16
 
17
17
  > `readonly` **AuthVerifiableCredential**: `"auth-verifiable-credential"` = `"auth-verifiable-credential"`
18
18
 
19
19
  Auth verifiable credential.
20
20
 
21
- ### Logging
21
+ ### Logging {#logging}
22
22
 
23
23
  > `readonly` **Logging**: `"logging"` = `"logging"`
24
24
 
25
25
  Logging.
26
26
 
27
- ### ContextId
27
+ ### ContextId {#contextid}
28
28
 
29
29
  > `readonly` **ContextId**: `"context-id"` = `"context-id"`
30
30
 
31
31
  Context ID.
32
32
 
33
- ### StaticContextId
33
+ ### StaticContextId {#staticcontextid}
34
34
 
35
35
  > `readonly` **StaticContextId**: `"static-context-id"` = `"static-context-id"`
36
36
 
37
37
  Static Context ID.
38
38
 
39
- ### Tenant
39
+ ### Tenant {#tenant}
40
40
 
41
41
  > `readonly` **Tenant**: `"tenant"` = `"tenant"`
42
42
 
43
43
  Tenant.
44
44
 
45
- ### SocketRoute
45
+ ### SocketRoute {#socketroute}
46
46
 
47
47
  > `readonly` **SocketRoute**: `"socket-route"` = `"socket-route"`
48
48
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@twin.org/engine-server-types",
3
- "version": "0.0.3-next.25",
4
- "description": "Server types to use in an engine server.",
3
+ "version": "0.0.3-next.27",
4
+ "description": "Server-focused component types and configuration models for API routing and hosting.",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "git+https://github.com/twinfoundation/engine.git",
@@ -25,8 +25,8 @@
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.25",
29
- "@twin.org/engine-types": "0.0.3-next.25",
28
+ "@twin.org/engine-models": "0.0.3-next.27",
29
+ "@twin.org/engine-types": "0.0.3-next.27",
30
30
  "@twin.org/entity": "next",
31
31
  "@twin.org/nameof": "next"
32
32
  },