@twin.org/engine-server-types 0.0.3-next.26 → 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,19 @@
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
2
17
 
3
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)
4
19
 
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,9 +8,9 @@ Extended engine server config with known types.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### debug?
11
+ ### debug? {#debug}
12
12
 
13
- > `optional` **debug**: `boolean`
13
+ > `optional` **debug?**: `boolean`
14
14
 
15
15
  Start the engine in debug mode.
16
16
 
@@ -26,9 +26,9 @@ false
26
26
 
27
27
  ***
28
28
 
29
- ### silent?
29
+ ### silent? {#silent}
30
30
 
31
- > `optional` **silent**: `boolean`
31
+ > `optional` **silent?**: `boolean`
32
32
 
33
33
  Disable output to the console.
34
34
 
@@ -44,15 +44,15 @@ false
44
44
 
45
45
  ***
46
46
 
47
- ### web?
47
+ ### web? {#web}
48
48
 
49
- > `optional` **web**: `IWebServerOptions`
49
+ > `optional` **web?**: `IWebServerOptions`
50
50
 
51
51
  Configuration for the web server.
52
52
 
53
53
  ***
54
54
 
55
- ### types
55
+ ### types {#types}
56
56
 
57
57
  > **types**: `object` & `object`
58
58
 
@@ -62,391 +62,391 @@ The types to initialise in the engine.
62
62
 
63
63
  ##### loggingConnector?
64
64
 
65
- > `optional` **loggingConnector**: `IEngineCoreTypeConfig`\<`LoggingConnectorConfig`\>[]
65
+ > `optional` **loggingConnector?**: `IEngineCoreTypeConfig`\<`LoggingConnectorConfig`\>[]
66
66
 
67
67
  Logging connector options which can be overridden by individual components by specifying types other than default.
68
68
 
69
69
  ##### loggingComponent?
70
70
 
71
- > `optional` **loggingComponent**: `IEngineCoreTypeConfig`\<`LoggingComponentConfig`\>[]
71
+ > `optional` **loggingComponent?**: `IEngineCoreTypeConfig`\<`LoggingComponentConfig`\>[]
72
72
 
73
73
  Logging component options which can be overridden by individual components by specifying types other than default.
74
74
 
75
75
  ##### entityStorageConnector?
76
76
 
77
- > `optional` **entityStorageConnector**: `IEngineCoreTypeConfig`\<`EntityStorageConnectorConfig`\>[]
77
+ > `optional` **entityStorageConnector?**: `IEngineCoreTypeConfig`\<`EntityStorageConnectorConfig`\>[]
78
78
 
79
79
  Entity storage connector options which can be overridden by individual components by specifying types other than default.
80
80
 
81
81
  ##### entityStorageComponent?
82
82
 
83
- > `optional` **entityStorageComponent**: `IEngineCoreTypeConfig`\<`EntityStorageComponentConfig`\>[]
83
+ > `optional` **entityStorageComponent?**: `IEngineCoreTypeConfig`\<`EntityStorageComponentConfig`\>[]
84
84
 
85
85
  Entity storage component options which can be overridden by individual components by specifying types other than default.
86
86
 
87
87
  ##### blobStorageConnector?
88
88
 
89
- > `optional` **blobStorageConnector**: `IEngineCoreTypeConfig`\<`BlobStorageConnectorConfig`\>[]
89
+ > `optional` **blobStorageConnector?**: `IEngineCoreTypeConfig`\<`BlobStorageConnectorConfig`\>[]
90
90
 
91
91
  Blob storage connector options which can be overridden by individual components by specifying types other than default.
92
92
 
93
93
  ##### blobStorageComponent?
94
94
 
95
- > `optional` **blobStorageComponent**: `IEngineCoreTypeConfig`\<`BlobStorageComponentConfig`\>[]
95
+ > `optional` **blobStorageComponent?**: `IEngineCoreTypeConfig`\<`BlobStorageComponentConfig`\>[]
96
96
 
97
97
  Blob storage component options which can be overridden by individual components by specifying types other than default.
98
98
 
99
99
  ##### telemetryConnector?
100
100
 
101
- > `optional` **telemetryConnector**: `IEngineCoreTypeConfig`\<`TelemetryConnectorConfig`\>[]
101
+ > `optional` **telemetryConnector?**: `IEngineCoreTypeConfig`\<`TelemetryConnectorConfig`\>[]
102
102
 
103
103
  Telemetry connector options which can be overridden by individual components by specifying types other than default.
104
104
 
105
105
  ##### telemetryComponent?
106
106
 
107
- > `optional` **telemetryComponent**: `IEngineCoreTypeConfig`\<`TelemetryComponentConfig`\>[]
107
+ > `optional` **telemetryComponent?**: `IEngineCoreTypeConfig`\<`TelemetryComponentConfig`\>[]
108
108
 
109
109
  Telemetry component options which can be overridden by individual components by specifying types other than default.
110
110
 
111
111
  ##### messagingEmailConnector?
112
112
 
113
- > `optional` **messagingEmailConnector**: `IEngineCoreTypeConfig`\<`MessagingEmailConnectorConfig`\>[]
113
+ > `optional` **messagingEmailConnector?**: `IEngineCoreTypeConfig`\<`MessagingEmailConnectorConfig`\>[]
114
114
 
115
115
  Messaging email connector options which can be overridden by individual components by specifying types other than default.
116
116
 
117
117
  ##### messagingSmsConnector?
118
118
 
119
- > `optional` **messagingSmsConnector**: `IEngineCoreTypeConfig`\<`MessagingSmsConnectorConfig`\>[]
119
+ > `optional` **messagingSmsConnector?**: `IEngineCoreTypeConfig`\<`MessagingSmsConnectorConfig`\>[]
120
120
 
121
121
  Messaging SMS connector options which can be overridden by individual components by specifying types other than default.
122
122
 
123
123
  ##### messagingPushNotificationConnector?
124
124
 
125
- > `optional` **messagingPushNotificationConnector**: `IEngineCoreTypeConfig`\<`MessagingPushNotificationConnectorConfig`\>[]
125
+ > `optional` **messagingPushNotificationConnector?**: `IEngineCoreTypeConfig`\<`MessagingPushNotificationConnectorConfig`\>[]
126
126
 
127
127
  Messaging push notification connector options which can be overridden by individual components by specifying types other than default.
128
128
 
129
129
  ##### messagingAdminComponent?
130
130
 
131
- > `optional` **messagingAdminComponent**: `IEngineCoreTypeConfig`\<`MessagingAdminComponentConfig`\>[]
131
+ > `optional` **messagingAdminComponent?**: `IEngineCoreTypeConfig`\<`MessagingAdminComponentConfig`\>[]
132
132
 
133
133
  Messaging admin component options which can be overridden by individual components by specifying types other than default.
134
134
 
135
135
  ##### messagingComponent?
136
136
 
137
- > `optional` **messagingComponent**: `IEngineCoreTypeConfig`\<`MessagingComponentConfig`\>[]
137
+ > `optional` **messagingComponent?**: `IEngineCoreTypeConfig`\<`MessagingComponentConfig`\>[]
138
138
 
139
139
  Messaging component options which can be overridden by individual components by specifying types other than default.
140
140
 
141
141
  ##### backgroundTaskComponent?
142
142
 
143
- > `optional` **backgroundTaskComponent**: `IEngineCoreTypeConfig`\<`BackgroundTaskComponentConfig`\>[]
143
+ > `optional` **backgroundTaskComponent?**: `IEngineCoreTypeConfig`\<`BackgroundTaskComponentConfig`\>[]
144
144
 
145
145
  Background task component options which can be overridden by individual components by specifying types other than default.
146
146
 
147
147
  ##### taskSchedulerComponent?
148
148
 
149
- > `optional` **taskSchedulerComponent**: `IEngineCoreTypeConfig`\<`TaskSchedulerComponentConfig`\>[]
149
+ > `optional` **taskSchedulerComponent?**: `IEngineCoreTypeConfig`\<`TaskSchedulerComponentConfig`\>[]
150
150
 
151
151
  Task scheduler component options which can be overridden by individual components by specifying types other than default.
152
152
 
153
153
  ##### eventBusConnector?
154
154
 
155
- > `optional` **eventBusConnector**: `IEngineCoreTypeConfig`\<`EventBusConnectorConfig`\>[]
155
+ > `optional` **eventBusConnector?**: `IEngineCoreTypeConfig`\<`EventBusConnectorConfig`\>[]
156
156
 
157
157
  Event bus connector options which can be overridden by individual components by specifying types other than default.
158
158
 
159
159
  ##### eventBusComponent?
160
160
 
161
- > `optional` **eventBusComponent**: `IEngineCoreTypeConfig`\<`EventBusComponentConfig`\>[]
161
+ > `optional` **eventBusComponent?**: `IEngineCoreTypeConfig`\<`EventBusComponentConfig`\>[]
162
162
 
163
163
  Event bus component options which can be overridden by individual components by specifying types other than default.
164
164
 
165
165
  ##### vaultConnector?
166
166
 
167
- > `optional` **vaultConnector**: `IEngineCoreTypeConfig`\<`VaultConnectorConfig`\>[]
167
+ > `optional` **vaultConnector?**: `IEngineCoreTypeConfig`\<`VaultConnectorConfig`\>[]
168
168
 
169
169
  Vault connector options which can be overridden by individual components by specifying types other than default.
170
170
 
171
171
  ##### dltConfig?
172
172
 
173
- > `optional` **dltConfig**: `IEngineCoreTypeConfig`\<`DltConfig`\>[]
173
+ > `optional` **dltConfig?**: `IEngineCoreTypeConfig`\<`DltConfig`\>[]
174
174
 
175
175
  DLT options which can be overridden by individual components by specifying types other than default.
176
176
 
177
177
  ##### walletConnector?
178
178
 
179
- > `optional` **walletConnector**: `IEngineCoreTypeConfig`\<`WalletConnectorConfig`\>[]
179
+ > `optional` **walletConnector?**: `IEngineCoreTypeConfig`\<`WalletConnectorConfig`\>[]
180
180
 
181
181
  Wallet connector options which can be overridden by individual components by specifying types other than default.
182
182
 
183
183
  ##### verifiableStorageConnector?
184
184
 
185
- > `optional` **verifiableStorageConnector**: `IEngineCoreTypeConfig`\<`VerifiableStorageConnectorConfig`\>[]
185
+ > `optional` **verifiableStorageConnector?**: `IEngineCoreTypeConfig`\<`VerifiableStorageConnectorConfig`\>[]
186
186
 
187
187
  Verifiable storage connector options which can be overridden by individual components by specifying types other than default.
188
188
 
189
189
  ##### verifiableStorageComponent?
190
190
 
191
- > `optional` **verifiableStorageComponent**: `IEngineCoreTypeConfig`\<`VerifiableStorageComponentConfig`\>[]
191
+ > `optional` **verifiableStorageComponent?**: `IEngineCoreTypeConfig`\<`VerifiableStorageComponentConfig`\>[]
192
192
 
193
193
  Verifiable storage component options which can be overridden by individual components by specifying types other than default.
194
194
 
195
195
  ##### immutableProofComponent?
196
196
 
197
- > `optional` **immutableProofComponent**: `IEngineCoreTypeConfig`\<`ImmutableProofComponentConfig`\>[]
197
+ > `optional` **immutableProofComponent?**: `IEngineCoreTypeConfig`\<`ImmutableProofComponentConfig`\>[]
198
198
 
199
199
  Immutable proof component options which can be overridden by individual components by specifying types other than default.
200
200
 
201
201
  ##### faucetConnector?
202
202
 
203
- > `optional` **faucetConnector**: `IEngineCoreTypeConfig`\<`FaucetConnectorConfig`\>[]
203
+ > `optional` **faucetConnector?**: `IEngineCoreTypeConfig`\<`FaucetConnectorConfig`\>[]
204
204
 
205
205
  Faucet connector options which can be overridden by individual components by specifying types other than default.
206
206
 
207
207
  ##### identityConnector?
208
208
 
209
- > `optional` **identityConnector**: `IEngineCoreTypeConfig`\<`IdentityConnectorConfig`\>[]
209
+ > `optional` **identityConnector?**: `IEngineCoreTypeConfig`\<`IdentityConnectorConfig`\>[]
210
210
 
211
211
  Identity connector options which can be overridden by individual components by specifying types other than default.
212
212
 
213
213
  ##### identityComponent?
214
214
 
215
- > `optional` **identityComponent**: `IEngineCoreTypeConfig`\<`IdentityComponentConfig`\>[]
215
+ > `optional` **identityComponent?**: `IEngineCoreTypeConfig`\<`IdentityComponentConfig`\>[]
216
216
 
217
217
  Identity component options which can be overridden by individual components by specifying types other than default.
218
218
 
219
219
  ##### identityResolverConnector?
220
220
 
221
- > `optional` **identityResolverConnector**: `IEngineCoreTypeConfig`\<`IdentityResolverConnectorConfig`\>[]
221
+ > `optional` **identityResolverConnector?**: `IEngineCoreTypeConfig`\<`IdentityResolverConnectorConfig`\>[]
222
222
 
223
223
  Identity resolver connector options which can be overridden by individual components by specifying types other than default.
224
224
 
225
225
  ##### identityResolverComponent?
226
226
 
227
- > `optional` **identityResolverComponent**: `IEngineCoreTypeConfig`\<`IdentityResolverComponentConfig`\>[]
227
+ > `optional` **identityResolverComponent?**: `IEngineCoreTypeConfig`\<`IdentityResolverComponentConfig`\>[]
228
228
 
229
229
  Identity resolver component options which can be overridden by individual components by specifying types other than default.
230
230
 
231
231
  ##### identityProfileConnector?
232
232
 
233
- > `optional` **identityProfileConnector**: `IEngineCoreTypeConfig`\<`IdentityProfileConnectorConfig`\>[]
233
+ > `optional` **identityProfileConnector?**: `IEngineCoreTypeConfig`\<`IdentityProfileConnectorConfig`\>[]
234
234
 
235
235
  Identity profile connector options which can be overridden by individual components by specifying types other than default.
236
236
 
237
237
  ##### identityProfileComponent?
238
238
 
239
- > `optional` **identityProfileComponent**: `IEngineCoreTypeConfig`\<`IdentityProfileComponentConfig`\>[]
239
+ > `optional` **identityProfileComponent?**: `IEngineCoreTypeConfig`\<`IdentityProfileComponentConfig`\>[]
240
240
 
241
241
  Identity profile component options which can be overridden by individual components by specifying types other than default.
242
242
 
243
243
  ##### nftConnector?
244
244
 
245
- > `optional` **nftConnector**: `IEngineCoreTypeConfig`\<`NftConnectorConfig`\>[]
245
+ > `optional` **nftConnector?**: `IEngineCoreTypeConfig`\<`NftConnectorConfig`\>[]
246
246
 
247
247
  NFT connector options which can be overridden by individual components by specifying types other than default.
248
248
 
249
249
  ##### nftComponent?
250
250
 
251
- > `optional` **nftComponent**: `IEngineCoreTypeConfig`\<`NftComponentConfig`\>[]
251
+ > `optional` **nftComponent?**: `IEngineCoreTypeConfig`\<`NftComponentConfig`\>[]
252
252
 
253
253
  NFT component options which can be overridden by individual components by specifying types other than default.
254
254
 
255
255
  ##### attestationConnector?
256
256
 
257
- > `optional` **attestationConnector**: `IEngineCoreTypeConfig`\<`AttestationConnectorConfig`\>[]
257
+ > `optional` **attestationConnector?**: `IEngineCoreTypeConfig`\<`AttestationConnectorConfig`\>[]
258
258
 
259
259
  Attestation connector options which can be overridden by individual components by specifying types other than default.
260
260
 
261
261
  ##### attestationComponent?
262
262
 
263
- > `optional` **attestationComponent**: `IEngineCoreTypeConfig`\<`AttestationComponentConfig`\>[]
263
+ > `optional` **attestationComponent?**: `IEngineCoreTypeConfig`\<`AttestationComponentConfig`\>[]
264
264
 
265
265
  Attestation component options which can be overridden by individual components by specifying types other than default.
266
266
 
267
267
  ##### auditableItemGraphComponent?
268
268
 
269
- > `optional` **auditableItemGraphComponent**: `IEngineCoreTypeConfig`\<`AuditableItemGraphComponentConfig`\>[]
269
+ > `optional` **auditableItemGraphComponent?**: `IEngineCoreTypeConfig`\<`AuditableItemGraphComponentConfig`\>[]
270
270
 
271
271
  Auditable item graph component options which can be overridden by individual components by specifying types other than default.
272
272
 
273
273
  ##### auditableItemStreamComponent?
274
274
 
275
- > `optional` **auditableItemStreamComponent**: `IEngineCoreTypeConfig`\<`AuditableItemStreamComponentConfig`\>[]
275
+ > `optional` **auditableItemStreamComponent?**: `IEngineCoreTypeConfig`\<`AuditableItemStreamComponentConfig`\>[]
276
276
 
277
277
  Auditable item stream component options which can be overridden by individual components by specifying types other than default.
278
278
 
279
279
  ##### dataConverterConnector?
280
280
 
281
- > `optional` **dataConverterConnector**: `IEngineCoreTypeConfig`\<`DataConverterConnectorConfig`\>[]
281
+ > `optional` **dataConverterConnector?**: `IEngineCoreTypeConfig`\<`DataConverterConnectorConfig`\>[]
282
282
 
283
283
  Data converter connector options which can be overridden by individual components by specifying types other than default.
284
284
 
285
285
  ##### dataExtractorConnector?
286
286
 
287
- > `optional` **dataExtractorConnector**: `IEngineCoreTypeConfig`\<`DataExtractorConnectorConfig`\>[]
287
+ > `optional` **dataExtractorConnector?**: `IEngineCoreTypeConfig`\<`DataExtractorConnectorConfig`\>[]
288
288
 
289
289
  Data extractor connector options which can be overridden by individual components by specifying types other than default.
290
290
 
291
291
  ##### dataProcessingComponent?
292
292
 
293
- > `optional` **dataProcessingComponent**: `IEngineCoreTypeConfig`\<`DataProcessingComponentConfig`\>[]
293
+ > `optional` **dataProcessingComponent?**: `IEngineCoreTypeConfig`\<`DataProcessingComponentConfig`\>[]
294
294
 
295
295
  Date processing options which can be overridden by individual components by specifying types other than default.
296
296
 
297
297
  ##### documentManagementComponent?
298
298
 
299
- > `optional` **documentManagementComponent**: `IEngineCoreTypeConfig`\<`DocumentManagementComponentConfig`\>[]
299
+ > `optional` **documentManagementComponent?**: `IEngineCoreTypeConfig`\<`DocumentManagementComponentConfig`\>[]
300
300
 
301
301
  Document management options which can be overridden by individual components by specifying types other than default.
302
302
 
303
303
  ##### trustComponent?
304
304
 
305
- > `optional` **trustComponent**: `IEngineCoreTypeConfig`\<`TrustComponentConfig`\>[]
305
+ > `optional` **trustComponent?**: `IEngineCoreTypeConfig`\<`TrustComponentConfig`\>[]
306
306
 
307
307
  Trust component options which can be overridden by individual components by specifying types other than default.
308
308
 
309
309
  ##### trustGeneratorComponent?
310
310
 
311
- > `optional` **trustGeneratorComponent**: `IEngineCoreTypeConfig`\<`TrustGeneratorComponentConfig`\>[]
311
+ > `optional` **trustGeneratorComponent?**: `IEngineCoreTypeConfig`\<`TrustGeneratorComponentConfig`\>[]
312
312
 
313
313
  Trust generator component options which can be overridden by individual components by specifying types other than default.
314
314
 
315
315
  ##### trustVerifierComponent?
316
316
 
317
- > `optional` **trustVerifierComponent**: `IEngineCoreTypeConfig`\<`TrustVerifierComponentConfig`\>[]
317
+ > `optional` **trustVerifierComponent?**: `IEngineCoreTypeConfig`\<`TrustVerifierComponentConfig`\>[]
318
318
 
319
319
  Trust verifier component options which can be overridden by individual components by specifying types other than default.
320
320
 
321
321
  ##### rightsManagementPapComponent?
322
322
 
323
- > `optional` **rightsManagementPapComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPapComponentConfig`\>[]
323
+ > `optional` **rightsManagementPapComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPapComponentConfig`\>[]
324
324
 
325
325
  Rights management PAP options which can be overridden by individual components by specifying types other than default.
326
326
 
327
327
  ##### rightsManagementPdpComponent?
328
328
 
329
- > `optional` **rightsManagementPdpComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPdpComponentConfig`\>[]
329
+ > `optional` **rightsManagementPdpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPdpComponentConfig`\>[]
330
330
 
331
331
  Rights management PDP options which can be overridden by individual components by specifying types other than default.
332
332
 
333
333
  ##### rightsManagementPepComponent?
334
334
 
335
- > `optional` **rightsManagementPepComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPepComponentConfig`\>[]
335
+ > `optional` **rightsManagementPepComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPepComponentConfig`\>[]
336
336
 
337
337
  Rights management PEP options which can be overridden by individual components by specifying types other than default.
338
338
 
339
339
  ##### rightsManagementPipComponent?
340
340
 
341
- > `optional` **rightsManagementPipComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPipComponentConfig`\>[]
341
+ > `optional` **rightsManagementPipComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPipComponentConfig`\>[]
342
342
 
343
343
  Rights management PIP options which can be overridden by individual components by specifying types other than default.
344
344
 
345
345
  ##### rightsManagementPmpComponent?
346
346
 
347
- > `optional` **rightsManagementPmpComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPmpComponentConfig`\>[]
347
+ > `optional` **rightsManagementPmpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPmpComponentConfig`\>[]
348
348
 
349
349
  Rights management PMP options which can be overridden by individual components by specifying types other than default.
350
350
 
351
351
  ##### rightsManagementPxpComponent?
352
352
 
353
- > `optional` **rightsManagementPxpComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPxpComponentConfig`\>[]
353
+ > `optional` **rightsManagementPxpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPxpComponentConfig`\>[]
354
354
 
355
355
  Rights management PXP options which can be overridden by individual components by specifying types other than default.
356
356
 
357
357
  ##### rightsManagementPnpComponent?
358
358
 
359
- > `optional` **rightsManagementPnpComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPnpComponentConfig`\>[]
359
+ > `optional` **rightsManagementPnpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPnpComponentConfig`\>[]
360
360
 
361
361
  Rights management PNP options which can be overridden by individual components by specifying types other than default.
362
362
 
363
363
  ##### rightsManagementPnapComponent?
364
364
 
365
- > `optional` **rightsManagementPnapComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPnapComponentConfig`\>[]
365
+ > `optional` **rightsManagementPnapComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPnapComponentConfig`\>[]
366
366
 
367
367
  Rights management PNAP options which can be overridden by individual components by specifying types other than default.
368
368
 
369
369
  ##### rightsManagementPolicyArbiterComponent?
370
370
 
371
- > `optional` **rightsManagementPolicyArbiterComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyArbiterComponentConfig`\>[]
371
+ > `optional` **rightsManagementPolicyArbiterComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyArbiterComponentConfig`\>[]
372
372
 
373
373
  Rights management policy arbiter options which can be overridden by individual components by specifying types other than default.
374
374
 
375
375
  ##### rightsManagementPolicyObligationEnforcerComponent?
376
376
 
377
- > `optional` **rightsManagementPolicyObligationEnforcerComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyObligationEnforcerComponentConfig`\>[]
377
+ > `optional` **rightsManagementPolicyObligationEnforcerComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyObligationEnforcerComponentConfig`\>[]
378
378
 
379
379
  Rights management policy obligation enforcer options which can be overridden by individual components by specifying types other than default.
380
380
 
381
381
  ##### rightsManagementPolicyEnforcementProcessorComponent?
382
382
 
383
- > `optional` **rightsManagementPolicyEnforcementProcessorComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyEnforcementProcessorComponentConfig`\>[]
383
+ > `optional` **rightsManagementPolicyEnforcementProcessorComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyEnforcementProcessorComponentConfig`\>[]
384
384
 
385
385
  Rights management policy enforcement processor options which can be overridden by individual components by specifying types other than default.
386
386
 
387
387
  ##### rightsManagementPolicyExecutionActionComponent?
388
388
 
389
- > `optional` **rightsManagementPolicyExecutionActionComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyExecutionActionComponentConfig`\>[]
389
+ > `optional` **rightsManagementPolicyExecutionActionComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyExecutionActionComponentConfig`\>[]
390
390
 
391
391
  Rights management policy execution action options which can be overridden by individual components by specifying types other than default.
392
392
 
393
393
  ##### rightsManagementPolicyInformationSourceComponent?
394
394
 
395
- > `optional` **rightsManagementPolicyInformationSourceComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyInformationSourceComponentConfig`\>[]
395
+ > `optional` **rightsManagementPolicyInformationSourceComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyInformationSourceComponentConfig`\>[]
396
396
 
397
397
  Rights management policy information source options which can be overridden by individual components by specifying types other than default.
398
398
 
399
399
  ##### rightsManagementPolicyNegotiatorComponent?
400
400
 
401
- > `optional` **rightsManagementPolicyNegotiatorComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyNegotiatorComponentConfig`\>[]
401
+ > `optional` **rightsManagementPolicyNegotiatorComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyNegotiatorComponentConfig`\>[]
402
402
 
403
403
  Rights management policy negotiator options which can be overridden by individual components by specifying types other than default.
404
404
 
405
405
  ##### rightsManagementPolicyRequesterComponent?
406
406
 
407
- > `optional` **rightsManagementPolicyRequesterComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyRequesterComponentConfig`\>[]
407
+ > `optional` **rightsManagementPolicyRequesterComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyRequesterComponentConfig`\>[]
408
408
 
409
409
  Rights management policy requester options which can be overridden by individual components by specifying types other than default.
410
410
 
411
411
  ##### synchronisedStorageComponent?
412
412
 
413
- > `optional` **synchronisedStorageComponent**: `IEngineCoreTypeConfig`\<`SynchronisedStorageComponentConfig`\>[]
413
+ > `optional` **synchronisedStorageComponent?**: `IEngineCoreTypeConfig`\<`SynchronisedStorageComponentConfig`\>[]
414
414
 
415
415
  Synchronised storage options which can be overridden by individual components by specifying types other than default.
416
416
 
417
417
  ##### federatedCatalogueComponent?
418
418
 
419
- > `optional` **federatedCatalogueComponent**: `IEngineCoreTypeConfig`\<`FederatedCatalogueComponentConfig`\>[]
419
+ > `optional` **federatedCatalogueComponent?**: `IEngineCoreTypeConfig`\<`FederatedCatalogueComponentConfig`\>[]
420
420
 
421
421
  Federated catalogue options which can be overridden by individual components by specifying types other than default.
422
422
 
423
423
  ##### federatedCatalogueFilterComponent?
424
424
 
425
- > `optional` **federatedCatalogueFilterComponent**: `IEngineCoreTypeConfig`\<`FederatedCatalogueFilterComponentConfig`\>[]
425
+ > `optional` **federatedCatalogueFilterComponent?**: `IEngineCoreTypeConfig`\<`FederatedCatalogueFilterComponentConfig`\>[]
426
426
 
427
427
  Federated catalogue filter options which can be overridden by individual components by specifying types other than default.
428
428
 
429
429
  ##### dataspaceControlPlaneComponent?
430
430
 
431
- > `optional` **dataspaceControlPlaneComponent**: `IEngineCoreTypeConfig`\<`DataspaceControlPlaneComponentConfig`\>[]
431
+ > `optional` **dataspaceControlPlaneComponent?**: `IEngineCoreTypeConfig`\<`DataspaceControlPlaneComponentConfig`\>[]
432
432
 
433
433
  Dataspace control plane component options which can be overridden by individual components by specifying types other than default.
434
434
 
435
435
  ##### dataspaceDataPlaneComponent?
436
436
 
437
- > `optional` **dataspaceDataPlaneComponent**: `IEngineCoreTypeConfig`\<`DataspaceDataPlaneComponentConfig`\>[]
437
+ > `optional` **dataspaceDataPlaneComponent?**: `IEngineCoreTypeConfig`\<`DataspaceDataPlaneComponentConfig`\>[]
438
438
 
439
439
  Dataspace data plane component options which can be overridden by individual components by specifying types other than default.
440
440
 
441
441
  ##### tenantAdminComponent?
442
442
 
443
- > `optional` **tenantAdminComponent**: `IEngineCoreTypeConfig`\<`TenantAdminComponentConfig`\>[]
443
+ > `optional` **tenantAdminComponent?**: `IEngineCoreTypeConfig`\<`TenantAdminComponentConfig`\>[]
444
444
 
445
445
  Tenant admin component options which can be overridden by individual components by specifying types other than default.
446
446
 
447
447
  ##### contextIdHandlerComponent?
448
448
 
449
- > `optional` **contextIdHandlerComponent**: `IEngineCoreTypeConfig`\<`ContextIdHandlerComponentConfig`\>[]
449
+ > `optional` **contextIdHandlerComponent?**: `IEngineCoreTypeConfig`\<`ContextIdHandlerComponentConfig`\>[]
450
450
 
451
451
  Context Id Handler component options which can be overridden by individual components by specifying types other than default.
452
452
 
@@ -454,43 +454,43 @@ Context Id Handler component options which can be overridden by individual compo
454
454
 
455
455
  ##### informationComponent?
456
456
 
457
- > `optional` **informationComponent**: `IEngineCoreTypeConfig`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
457
+ > `optional` **informationComponent?**: `IEngineCoreTypeConfig`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
458
458
 
459
459
  Information component options which can be overridden by individual components by specifying types other than default.
460
460
 
461
461
  ##### hostingComponent?
462
462
 
463
- > `optional` **hostingComponent**: `IEngineCoreTypeConfig`\<[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md)\>[]
463
+ > `optional` **hostingComponent?**: `IEngineCoreTypeConfig`\<[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md)\>[]
464
464
 
465
465
  Hosting component options which can be overridden by individual components by specifying types other than default.
466
466
 
467
467
  ##### restRouteProcessor?
468
468
 
469
- > `optional` **restRouteProcessor**: `IEngineCoreTypeConfig`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
469
+ > `optional` **restRouteProcessor?**: `IEngineCoreTypeConfig`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
470
470
 
471
471
  REST route processors options which can be overridden by individual components by specifying types other than default.
472
472
 
473
473
  ##### socketRouteProcessor?
474
474
 
475
- > `optional` **socketRouteProcessor**: `IEngineCoreTypeConfig`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
475
+ > `optional` **socketRouteProcessor?**: `IEngineCoreTypeConfig`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
476
476
 
477
477
  Socket route processors options which can be overridden by individual components by specifying types other than default.
478
478
 
479
479
  ##### mimeTypeProcessor?
480
480
 
481
- > `optional` **mimeTypeProcessor**: `IEngineCoreTypeConfig`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
481
+ > `optional` **mimeTypeProcessor?**: `IEngineCoreTypeConfig`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
482
482
 
483
483
  Mime type processors options which can be overridden by individual components by specifying types other than default.
484
484
 
485
485
  ##### authenticationComponent?
486
486
 
487
- > `optional` **authenticationComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
487
+ > `optional` **authenticationComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
488
488
 
489
489
  Authentication component options which can be overridden by individual components by specifying types other than default.
490
490
 
491
491
  ##### authenticationAdminComponent?
492
492
 
493
- > `optional` **authenticationAdminComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md)\>[]
493
+ > `optional` **authenticationAdminComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md)\>[]
494
494
 
495
495
  Authentication admin component options which can be overridden by individual components by specifying types other than default.
496
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.26",
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.26",
29
- "@twin.org/engine-types": "0.0.3-next.26",
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
  },