@twin.org/engine-server-types 0.0.3-next.3 → 0.0.3-next.31

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 (88) hide show
  1. package/README.md +1 -1
  2. package/dist/es/components/authentication.js +23 -19
  3. package/dist/es/components/authentication.js.map +1 -1
  4. package/dist/es/components/authenticationAdmin.js +19 -15
  5. package/dist/es/components/authenticationAdmin.js.map +1 -1
  6. package/dist/es/components/authenticationAudit.js +35 -0
  7. package/dist/es/components/authenticationAudit.js.map +1 -0
  8. package/dist/es/components/authenticationRate.js +37 -0
  9. package/dist/es/components/authenticationRate.js.map +1 -0
  10. package/dist/es/components/hosting.js +29 -0
  11. package/dist/es/components/hosting.js.map +1 -0
  12. package/dist/es/components/information.js +12 -9
  13. package/dist/es/components/information.js.map +1 -1
  14. package/dist/es/components/mimeTypeProcessor.js +7 -7
  15. package/dist/es/components/mimeTypeProcessor.js.map +1 -1
  16. package/dist/es/components/restRouteProcessor.js +38 -46
  17. package/dist/es/components/restRouteProcessor.js.map +1 -1
  18. package/dist/es/components/socketRouteProcessor.js +34 -42
  19. package/dist/es/components/socketRouteProcessor.js.map +1 -1
  20. package/dist/es/index.js +9 -0
  21. package/dist/es/index.js.map +1 -1
  22. package/dist/es/models/IEngineServerConfig.js.map +1 -1
  23. package/dist/es/models/config/authenticationAuditComponentConfig.js +2 -0
  24. package/dist/es/models/config/authenticationAuditComponentConfig.js.map +1 -0
  25. package/dist/es/models/config/authenticationRateComponentConfig.js +2 -0
  26. package/dist/es/models/config/authenticationRateComponentConfig.js.map +1 -0
  27. package/dist/es/models/config/hostingComponentConfig.js +2 -0
  28. package/dist/es/models/config/hostingComponentConfig.js.map +1 -0
  29. package/dist/es/models/config/restRouteProcessorConfig.js.map +1 -1
  30. package/dist/es/models/config/socketRouteProcessorConfig.js.map +1 -1
  31. package/dist/es/models/types/authenticationAuditComponentType.js +13 -0
  32. package/dist/es/models/types/authenticationAuditComponentType.js.map +1 -0
  33. package/dist/es/models/types/authenticationRateComponentType.js +13 -0
  34. package/dist/es/models/types/authenticationRateComponentType.js.map +1 -0
  35. package/dist/es/models/types/hostingComponentType.js +13 -0
  36. package/dist/es/models/types/hostingComponentType.js.map +1 -0
  37. package/dist/types/components/authentication.d.ts +3 -7
  38. package/dist/types/components/authenticationAdmin.d.ts +3 -7
  39. package/dist/types/components/authenticationAudit.d.ts +12 -0
  40. package/dist/types/components/authenticationRate.d.ts +12 -0
  41. package/dist/types/components/hosting.d.ts +12 -0
  42. package/dist/types/components/information.d.ts +3 -7
  43. package/dist/types/components/mimeTypeProcessor.d.ts +2 -7
  44. package/dist/types/components/restRouteProcessor.d.ts +2 -7
  45. package/dist/types/components/socketRouteProcessor.d.ts +2 -7
  46. package/dist/types/index.d.ts +9 -0
  47. package/dist/types/models/IEngineServerConfig.d.ts +21 -6
  48. package/dist/types/models/config/authenticationAuditComponentConfig.d.ts +9 -0
  49. package/dist/types/models/config/authenticationRateComponentConfig.d.ts +9 -0
  50. package/dist/types/models/config/hostingComponentConfig.d.ts +9 -0
  51. package/dist/types/models/config/restRouteProcessorConfig.d.ts +0 -4
  52. package/dist/types/models/config/socketRouteProcessorConfig.d.ts +0 -4
  53. package/dist/types/models/types/authenticationAuditComponentType.d.ts +13 -0
  54. package/dist/types/models/types/authenticationRateComponentType.d.ts +13 -0
  55. package/dist/types/models/types/hostingComponentType.d.ts +13 -0
  56. package/docs/changelog.md +478 -1
  57. package/docs/examples.md +64 -1
  58. package/docs/reference/functions/initialiseAuthenticationAdminComponent.md +2 -2
  59. package/docs/reference/functions/initialiseAuthenticationAuditComponent.md +31 -0
  60. package/docs/reference/functions/initialiseAuthenticationComponent.md +2 -2
  61. package/docs/reference/functions/initialiseAuthenticationRateComponent.md +31 -0
  62. package/docs/reference/functions/initialiseHostingComponent.md +31 -0
  63. package/docs/reference/functions/initialiseInformationComponent.md +2 -2
  64. package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +2 -2
  65. package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +2 -2
  66. package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +2 -2
  67. package/docs/reference/index.md +12 -0
  68. package/docs/reference/interfaces/IEngineServerConfig.md +473 -15
  69. package/docs/reference/type-aliases/AuthenticationAdminComponentConfig.md +3 -3
  70. package/docs/reference/type-aliases/AuthenticationAuditComponentConfig.md +17 -0
  71. package/docs/reference/type-aliases/AuthenticationAuditComponentType.md +5 -0
  72. package/docs/reference/type-aliases/AuthenticationRateComponentConfig.md +17 -0
  73. package/docs/reference/type-aliases/AuthenticationRateComponentType.md +5 -0
  74. package/docs/reference/type-aliases/HostingComponentConfig.md +17 -0
  75. package/docs/reference/type-aliases/HostingComponentType.md +5 -0
  76. package/docs/reference/type-aliases/MimeTypeProcessorConfig.md +3 -3
  77. package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
  78. package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
  79. package/docs/reference/variables/AuthenticationAdminComponentType.md +1 -1
  80. package/docs/reference/variables/AuthenticationAuditComponentType.md +13 -0
  81. package/docs/reference/variables/AuthenticationComponentType.md +2 -2
  82. package/docs/reference/variables/AuthenticationRateComponentType.md +13 -0
  83. package/docs/reference/variables/HostingComponentType.md +13 -0
  84. package/docs/reference/variables/InformationComponentType.md +2 -2
  85. package/docs/reference/variables/MimeTypeProcessorType.md +1 -1
  86. package/docs/reference/variables/RestRouteProcessorType.md +7 -7
  87. package/docs/reference/variables/SocketRouteProcessorType.md +7 -7
  88. package/package.json +4 -5
@@ -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,41 +60,463 @@ 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
+ ##### notarizationConnector?
256
+
257
+ > `optional` **notarizationConnector?**: `IEngineCoreTypeConfig`\<`NotarizationConnectorConfig`\>[]
258
+
259
+ Notarization connector options which can be overridden by individual components by specifying types other than default.
260
+
261
+ ##### notarizationComponent?
262
+
263
+ > `optional` **notarizationComponent?**: `IEngineCoreTypeConfig`\<`NotarizationComponentConfig`\>[]
264
+
265
+ Notarization component options which can be overridden by individual components by specifying types other than default.
266
+
267
+ ##### attestationConnector?
268
+
269
+ > `optional` **attestationConnector?**: `IEngineCoreTypeConfig`\<`AttestationConnectorConfig`\>[]
270
+
271
+ Attestation connector options which can be overridden by individual components by specifying types other than default.
272
+
273
+ ##### attestationComponent?
274
+
275
+ > `optional` **attestationComponent?**: `IEngineCoreTypeConfig`\<`AttestationComponentConfig`\>[]
276
+
277
+ Attestation component options which can be overridden by individual components by specifying types other than default.
278
+
279
+ ##### auditableItemGraphComponent?
280
+
281
+ > `optional` **auditableItemGraphComponent?**: `IEngineCoreTypeConfig`\<`AuditableItemGraphComponentConfig`\>[]
282
+
283
+ Auditable item graph component options which can be overridden by individual components by specifying types other than default.
284
+
285
+ ##### auditableItemStreamComponent?
286
+
287
+ > `optional` **auditableItemStreamComponent?**: `IEngineCoreTypeConfig`\<`AuditableItemStreamComponentConfig`\>[]
288
+
289
+ Auditable item stream component options which can be overridden by individual components by specifying types other than default.
290
+
291
+ ##### dataConverterConnector?
292
+
293
+ > `optional` **dataConverterConnector?**: `IEngineCoreTypeConfig`\<`DataConverterConnectorConfig`\>[]
294
+
295
+ Data converter connector options which can be overridden by individual components by specifying types other than default.
296
+
297
+ ##### dataExtractorConnector?
298
+
299
+ > `optional` **dataExtractorConnector?**: `IEngineCoreTypeConfig`\<`DataExtractorConnectorConfig`\>[]
300
+
301
+ Data extractor connector options which can be overridden by individual components by specifying types other than default.
302
+
303
+ ##### dataProcessingComponent?
304
+
305
+ > `optional` **dataProcessingComponent?**: `IEngineCoreTypeConfig`\<`DataProcessingComponentConfig`\>[]
306
+
307
+ Date processing options which can be overridden by individual components by specifying types other than default.
308
+
309
+ ##### documentManagementComponent?
310
+
311
+ > `optional` **documentManagementComponent?**: `IEngineCoreTypeConfig`\<`DocumentManagementComponentConfig`\>[]
312
+
313
+ Document management options which can be overridden by individual components by specifying types other than default.
314
+
315
+ ##### trustComponent?
316
+
317
+ > `optional` **trustComponent?**: `IEngineCoreTypeConfig`\<`TrustComponentConfig`\>[]
318
+
319
+ Trust component options which can be overridden by individual components by specifying types other than default.
320
+
321
+ ##### trustGeneratorComponent?
322
+
323
+ > `optional` **trustGeneratorComponent?**: `IEngineCoreTypeConfig`\<`TrustGeneratorComponentConfig`\>[]
324
+
325
+ Trust generator component options which can be overridden by individual components by specifying types other than default.
326
+
327
+ ##### trustVerifierComponent?
328
+
329
+ > `optional` **trustVerifierComponent?**: `IEngineCoreTypeConfig`\<`TrustVerifierComponentConfig`\>[]
330
+
331
+ Trust verifier component options which can be overridden by individual components by specifying types other than default.
332
+
333
+ ##### rightsManagementPapComponent?
334
+
335
+ > `optional` **rightsManagementPapComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPapComponentConfig`\>[]
336
+
337
+ Rights management PAP options which can be overridden by individual components by specifying types other than default.
338
+
339
+ ##### rightsManagementPdpComponent?
340
+
341
+ > `optional` **rightsManagementPdpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPdpComponentConfig`\>[]
342
+
343
+ Rights management PDP options which can be overridden by individual components by specifying types other than default.
344
+
345
+ ##### rightsManagementPepComponent?
346
+
347
+ > `optional` **rightsManagementPepComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPepComponentConfig`\>[]
348
+
349
+ Rights management PEP options which can be overridden by individual components by specifying types other than default.
350
+
351
+ ##### rightsManagementPipComponent?
352
+
353
+ > `optional` **rightsManagementPipComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPipComponentConfig`\>[]
354
+
355
+ Rights management PIP options which can be overridden by individual components by specifying types other than default.
356
+
357
+ ##### rightsManagementPmpComponent?
358
+
359
+ > `optional` **rightsManagementPmpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPmpComponentConfig`\>[]
360
+
361
+ Rights management PMP options which can be overridden by individual components by specifying types other than default.
362
+
363
+ ##### rightsManagementPxpComponent?
364
+
365
+ > `optional` **rightsManagementPxpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPxpComponentConfig`\>[]
366
+
367
+ Rights management PXP options which can be overridden by individual components by specifying types other than default.
368
+
369
+ ##### rightsManagementPnpComponent?
370
+
371
+ > `optional` **rightsManagementPnpComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPnpComponentConfig`\>[]
372
+
373
+ Rights management PNP options which can be overridden by individual components by specifying types other than default.
374
+
375
+ ##### rightsManagementPnapComponent?
376
+
377
+ > `optional` **rightsManagementPnapComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPnapComponentConfig`\>[]
378
+
379
+ Rights management PNAP options which can be overridden by individual components by specifying types other than default.
380
+
381
+ ##### rightsManagementPolicyArbiterComponent?
382
+
383
+ > `optional` **rightsManagementPolicyArbiterComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyArbiterComponentConfig`\>[]
384
+
385
+ Rights management policy arbiter options which can be overridden by individual components by specifying types other than default.
386
+
387
+ ##### rightsManagementPolicyObligationEnforcerComponent?
388
+
389
+ > `optional` **rightsManagementPolicyObligationEnforcerComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyObligationEnforcerComponentConfig`\>[]
390
+
391
+ Rights management policy obligation enforcer options which can be overridden by individual components by specifying types other than default.
392
+
393
+ ##### rightsManagementPolicyEnforcementProcessorComponent?
394
+
395
+ > `optional` **rightsManagementPolicyEnforcementProcessorComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyEnforcementProcessorComponentConfig`\>[]
396
+
397
+ Rights management policy enforcement processor options which can be overridden by individual components by specifying types other than default.
398
+
399
+ ##### rightsManagementPolicyExecutionActionComponent?
400
+
401
+ > `optional` **rightsManagementPolicyExecutionActionComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyExecutionActionComponentConfig`\>[]
402
+
403
+ Rights management policy execution action options which can be overridden by individual components by specifying types other than default.
404
+
405
+ ##### rightsManagementPolicyInformationSourceComponent?
406
+
407
+ > `optional` **rightsManagementPolicyInformationSourceComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyInformationSourceComponentConfig`\>[]
408
+
409
+ Rights management policy information source options which can be overridden by individual components by specifying types other than default.
410
+
411
+ ##### rightsManagementPolicyNegotiatorComponent?
412
+
413
+ > `optional` **rightsManagementPolicyNegotiatorComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyNegotiatorComponentConfig`\>[]
414
+
415
+ Rights management policy negotiator options which can be overridden by individual components by specifying types other than default.
416
+
417
+ ##### rightsManagementPolicyRequesterComponent?
418
+
419
+ > `optional` **rightsManagementPolicyRequesterComponent?**: `IEngineCoreTypeConfig`\<`RightsManagementPolicyRequesterComponentConfig`\>[]
420
+
421
+ Rights management policy requester options which can be overridden by individual components by specifying types other than default.
422
+
423
+ ##### synchronisedStorageComponent?
424
+
425
+ > `optional` **synchronisedStorageComponent?**: `IEngineCoreTypeConfig`\<`SynchronisedStorageComponentConfig`\>[]
426
+
427
+ Synchronised storage options which can be overridden by individual components by specifying types other than default.
428
+
429
+ ##### federatedCatalogueComponent?
430
+
431
+ > `optional` **federatedCatalogueComponent?**: `IEngineCoreTypeConfig`\<`FederatedCatalogueComponentConfig`\>[]
432
+
433
+ Federated catalogue options which can be overridden by individual components by specifying types other than default.
434
+
435
+ ##### federatedCatalogueFilterComponent?
436
+
437
+ > `optional` **federatedCatalogueFilterComponent?**: `IEngineCoreTypeConfig`\<`FederatedCatalogueFilterComponentConfig`\>[]
438
+
439
+ Federated catalogue filter options which can be overridden by individual components by specifying types other than default.
440
+
441
+ ##### dataspaceControlPlaneComponent?
442
+
443
+ > `optional` **dataspaceControlPlaneComponent?**: `IEngineCoreTypeConfig`\<`DataspaceControlPlaneComponentConfig`\>[]
444
+
445
+ Dataspace control plane component options which can be overridden by individual components by specifying types other than default.
446
+
447
+ ##### dataspaceDataPlaneComponent?
448
+
449
+ > `optional` **dataspaceDataPlaneComponent?**: `IEngineCoreTypeConfig`\<`DataspaceDataPlaneComponentConfig`\>[]
450
+
451
+ Dataspace data plane component options which can be overridden by individual components by specifying types other than default.
452
+
453
+ ##### tenantAdminComponent?
454
+
455
+ > `optional` **tenantAdminComponent?**: `IEngineCoreTypeConfig`\<`TenantAdminComponentConfig`\>[]
456
+
457
+ Tenant admin component options which can be overridden by individual components by specifying types other than default.
458
+
459
+ ##### contextIdHandlerComponent?
460
+
461
+ > `optional` **contextIdHandlerComponent?**: `IEngineCoreTypeConfig`\<`ContextIdHandlerComponentConfig`\>[]
462
+
463
+ Context Id Handler component options which can be overridden by individual components by specifying types other than default.
464
+
465
+ #### Type Declaration
466
+
27
467
  ##### informationComponent?
28
468
 
29
- > `optional` **informationComponent**: `IEngineCoreTypeConfig`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
469
+ > `optional` **informationComponent?**: `IEngineCoreTypeConfig`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
470
+
471
+ Information component options which can be overridden by individual components by specifying types other than default.
472
+
473
+ ##### hostingComponent?
30
474
 
31
- Information component options which can be overridden by individual components by specifying types other than default..
475
+ > `optional` **hostingComponent?**: `IEngineCoreTypeConfig`\<[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md)\>[]
476
+
477
+ Hosting component options which can be overridden by individual components by specifying types other than default.
32
478
 
33
479
  ##### restRouteProcessor?
34
480
 
35
- > `optional` **restRouteProcessor**: `IEngineCoreTypeConfig`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
481
+ > `optional` **restRouteProcessor?**: `IEngineCoreTypeConfig`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
36
482
 
37
- REST route processors options which can be overridden by individual components by specifying types other than default..
483
+ REST route processors options which can be overridden by individual components by specifying types other than default.
38
484
 
39
485
  ##### socketRouteProcessor?
40
486
 
41
- > `optional` **socketRouteProcessor**: `IEngineCoreTypeConfig`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
487
+ > `optional` **socketRouteProcessor?**: `IEngineCoreTypeConfig`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
42
488
 
43
- Socket route processors options which can be overridden by individual components by specifying types other than default..
489
+ Socket route processors options which can be overridden by individual components by specifying types other than default.
44
490
 
45
491
  ##### mimeTypeProcessor?
46
492
 
47
- > `optional` **mimeTypeProcessor**: `IEngineCoreTypeConfig`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
493
+ > `optional` **mimeTypeProcessor?**: `IEngineCoreTypeConfig`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
494
+
495
+ Mime type processors options which can be overridden by individual components by specifying types other than default.
496
+
497
+ ##### authenticationAuditComponent?
498
+
499
+ > `optional` **authenticationAuditComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationAuditComponentConfig`](../type-aliases/AuthenticationAuditComponentConfig.md)\>[]
500
+
501
+ Authentication audit component options which can be overridden by individual components by specifying types other than default.
502
+
503
+ ##### authenticationRateComponent?
504
+
505
+ > `optional` **authenticationRateComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationRateComponentConfig`](../type-aliases/AuthenticationRateComponentConfig.md)\>[]
48
506
 
49
- Mime type processors options which can be overridden by individual components by specifying types other than default..
507
+ Authentication rate component options which can be overridden by individual components by specifying types other than default.
50
508
 
51
509
  ##### authenticationComponent?
52
510
 
53
- > `optional` **authenticationComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
511
+ > `optional` **authenticationComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
54
512
 
55
- Authentication component options which can be overridden by individual components by specifying types other than default..
513
+ Authentication component options which can be overridden by individual components by specifying types other than default.
56
514
 
57
515
  ##### authenticationAdminComponent?
58
516
 
59
- > `optional` **authenticationAdminComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md)\>[]
517
+ > `optional` **authenticationAdminComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md)\>[]
60
518
 
61
- Authentication admin component options which can be overridden by individual components by specifying types other than default..
519
+ Authentication admin component options which can be overridden by individual components by specifying types other than default.
62
520
 
63
521
  #### Overrides
64
522
 
@@ -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`
@@ -0,0 +1,17 @@
1
+ # Type Alias: AuthenticationAuditComponentConfig
2
+
3
+ > **AuthenticationAuditComponentConfig** = `object`
4
+
5
+ Authentication audit component config types.
6
+
7
+ ## Properties
8
+
9
+ ### type {#type}
10
+
11
+ > **type**: *typeof* [`EntityStorage`](../variables/AuthenticationAuditComponentType.md#entitystorage)
12
+
13
+ ***
14
+
15
+ ### options? {#options}
16
+
17
+ > `optional` **options?**: `IEntityStorageAuthenticationAuditServiceConstructorOptions`
@@ -0,0 +1,5 @@
1
+ # Type Alias: AuthenticationAuditComponentType
2
+
3
+ > **AuthenticationAuditComponentType** = *typeof* [`AuthenticationAuditComponentType`](../variables/AuthenticationAuditComponentType.md)\[keyof *typeof* [`AuthenticationAuditComponentType`](../variables/AuthenticationAuditComponentType.md)\]
4
+
5
+ Authentication audit component types.
@@ -0,0 +1,17 @@
1
+ # Type Alias: AuthenticationRateComponentConfig
2
+
3
+ > **AuthenticationRateComponentConfig** = `object`
4
+
5
+ Authentication rate component config types.
6
+
7
+ ## Properties
8
+
9
+ ### type {#type}
10
+
11
+ > **type**: *typeof* [`EntityStorage`](../variables/AuthenticationRateComponentType.md#entitystorage)
12
+
13
+ ***
14
+
15
+ ### options? {#options}
16
+
17
+ > `optional` **options?**: `IEntityStorageAuthenticationRateServiceConstructorOptions`
@@ -0,0 +1,5 @@
1
+ # Type Alias: AuthenticationRateComponentType
2
+
3
+ > **AuthenticationRateComponentType** = *typeof* [`AuthenticationRateComponentType`](../variables/AuthenticationRateComponentType.md)\[keyof *typeof* [`AuthenticationRateComponentType`](../variables/AuthenticationRateComponentType.md)\]
4
+
5
+ Authentication rate component types.
@@ -0,0 +1,17 @@
1
+ # Type Alias: HostingComponentConfig
2
+
3
+ > **HostingComponentConfig** = `object`
4
+
5
+ Hosting component config types.
6
+
7
+ ## Properties
8
+
9
+ ### type {#type}
10
+
11
+ > **type**: *typeof* [`Service`](../variables/HostingComponentType.md#service)
12
+
13
+ ***
14
+
15
+ ### options {#options}
16
+
17
+ > **options**: `IHostingServiceConstructorOptions`
@@ -0,0 +1,5 @@
1
+ # Type Alias: HostingComponentType
2
+
3
+ > **HostingComponentType** = *typeof* [`HostingComponentType`](../variables/HostingComponentType.md)\[keyof *typeof* [`HostingComponentType`](../variables/HostingComponentType.md)\]
4
+
5
+ Hosting component types.
@@ -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`
@@ -1,5 +1,5 @@
1
1
  # Type Alias: RestRouteProcessorConfig
2
2
 
3
- > **RestRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/RestRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`AuthVerifiableCredential`](../variables/RestRouteProcessorType.md#authverifiablecredential); `options?`: `IVerifiableCredentialAuthenticationProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/RestRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/RestRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/RestRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/RestRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`RestRoute`](../variables/RestRouteProcessorType.md#restroute); `options?`: `IRestRouteProcessorConstructorOptions`; \}
3
+ > **RestRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/RestRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/RestRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/RestRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/RestRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/RestRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`RestRoute`](../variables/RestRouteProcessorType.md#restroute); `options?`: `IRestRouteProcessorConstructorOptions`; \}
4
4
 
5
5
  REST route processor config types.
@@ -1,5 +1,5 @@
1
1
  # Type Alias: SocketRouteProcessorConfig
2
2
 
3
- > **SocketRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/SocketRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`AuthVerifiableCredential`](../variables/SocketRouteProcessorType.md#authverifiablecredential); `options?`: `IVerifiableCredentialAuthenticationProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/SocketRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/SocketRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/SocketRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/SocketRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`SocketRoute`](../variables/SocketRouteProcessorType.md#socketroute); `options?`: `ISocketRouteProcessorConstructorOptions`; \}
3
+ > **SocketRouteProcessorConfig** = \{ `type`: *typeof* [`AuthHeader`](../variables/SocketRouteProcessorType.md#authheader); `options?`: `IAuthHeaderProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Logging`](../variables/SocketRouteProcessorType.md#logging); `options?`: `ILoggingProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`ContextId`](../variables/SocketRouteProcessorType.md#contextid); `options`: `IContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`StaticContextId`](../variables/SocketRouteProcessorType.md#staticcontextid); `options`: `IStaticContextIdProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`Tenant`](../variables/SocketRouteProcessorType.md#tenant); `options?`: `ITenantProcessorConstructorOptions`; \} \| \{ `type`: *typeof* [`SocketRoute`](../variables/SocketRouteProcessorType.md#socketroute); `options?`: `ISocketRouteProcessorConstructorOptions`; \}
4
4
 
5
5
  Socket route processor config types.
@@ -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