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

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 +463 -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
@@ -0,0 +1,9 @@
1
+ import type { IHostingServiceConstructorOptions } from "@twin.org/api-service";
2
+ import type { HostingComponentType } from "../types/hostingComponentType.js";
3
+ /**
4
+ * Hosting component config types.
5
+ */
6
+ export type HostingComponentConfig = {
7
+ type: typeof HostingComponentType.Service;
8
+ options: IHostingServiceConstructorOptions;
9
+ };
@@ -1,7 +1,6 @@
1
1
  import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
2
2
  import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, IRestRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@twin.org/api-processors";
3
3
  import type { ITenantProcessorConstructorOptions } from "@twin.org/api-tenant-processor";
4
- import type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from "@twin.org/identity-authentication";
5
4
  import type { RestRouteProcessorType } from "../types/restRouteProcessorType.js";
6
5
  /**
7
6
  * REST route processor config types.
@@ -9,9 +8,6 @@ import type { RestRouteProcessorType } from "../types/restRouteProcessorType.js"
9
8
  export type RestRouteProcessorConfig = {
10
9
  type: typeof RestRouteProcessorType.AuthHeader;
11
10
  options?: IAuthHeaderProcessorConstructorOptions;
12
- } | {
13
- type: typeof RestRouteProcessorType.AuthVerifiableCredential;
14
- options?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;
15
11
  } | {
16
12
  type: typeof RestRouteProcessorType.Logging;
17
13
  options?: ILoggingProcessorConstructorOptions;
@@ -1,7 +1,6 @@
1
1
  import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
2
2
  import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, ISocketRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@twin.org/api-processors";
3
3
  import type { ITenantProcessorConstructorOptions } from "@twin.org/api-tenant-processor";
4
- import type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from "@twin.org/identity-authentication";
5
4
  import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType.js";
6
5
  /**
7
6
  * Socket route processor config types.
@@ -9,9 +8,6 @@ import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType
9
8
  export type SocketRouteProcessorConfig = {
10
9
  type: typeof SocketRouteProcessorType.AuthHeader;
11
10
  options?: IAuthHeaderProcessorConstructorOptions;
12
- } | {
13
- type: typeof SocketRouteProcessorType.AuthVerifiableCredential;
14
- options?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;
15
11
  } | {
16
12
  type: typeof SocketRouteProcessorType.Logging;
17
13
  options?: ILoggingProcessorConstructorOptions;
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Authentication audit component types.
3
+ */
4
+ export declare const AuthenticationAuditComponentType: {
5
+ /**
6
+ * Entity storage.
7
+ */
8
+ readonly EntityStorage: "entity-storage";
9
+ };
10
+ /**
11
+ * Authentication audit component types.
12
+ */
13
+ export type AuthenticationAuditComponentType = (typeof AuthenticationAuditComponentType)[keyof typeof AuthenticationAuditComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Authentication rate component types.
3
+ */
4
+ export declare const AuthenticationRateComponentType: {
5
+ /**
6
+ * Entity storage.
7
+ */
8
+ readonly EntityStorage: "entity-storage";
9
+ };
10
+ /**
11
+ * Authentication rate component types.
12
+ */
13
+ export type AuthenticationRateComponentType = (typeof AuthenticationRateComponentType)[keyof typeof AuthenticationRateComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Hosting component types.
3
+ */
4
+ export declare const HostingComponentType: {
5
+ /**
6
+ * Service.
7
+ */
8
+ readonly Service: "service";
9
+ };
10
+ /**
11
+ * Hosting component types.
12
+ */
13
+ export type HostingComponentType = (typeof HostingComponentType)[keyof typeof HostingComponentType];
package/docs/changelog.md CHANGED
@@ -1,4 +1,466 @@
1
- # @twin.org/engine-server-types - Changelog
1
+ # Changelog
2
+
3
+ ## [0.0.3-next.30](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.29...engine-server-types-v0.0.3-next.30) (2026-04-16)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **engine-server-types:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/engine-models bumped from 0.0.3-next.29 to 0.0.3-next.30
16
+ * @twin.org/engine-types bumped from 0.0.3-next.29 to 0.0.3-next.30
17
+
18
+ ## [0.0.3-next.29](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.28...engine-server-types-v0.0.3-next.29) (2026-04-14)
19
+
20
+
21
+ ### Features
22
+
23
+ * add authentication rate and audit services ([#95](https://github.com/twinfoundation/engine/issues/95)) ([55e2b08](https://github.com/twinfoundation/engine/commit/55e2b089661529e0556115817cc435cc6e4292cc))
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.28 to 0.0.3-next.29
31
+ * @twin.org/engine-types bumped from 0.0.3-next.28 to 0.0.3-next.29
32
+
33
+ ## [0.0.3-next.28](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.27...engine-server-types-v0.0.3-next.28) (2026-04-10)
34
+
35
+
36
+ ### Miscellaneous Chores
37
+
38
+ * **engine-server-types:** Synchronize repo versions
39
+
40
+
41
+ ### Dependencies
42
+
43
+ * The following workspace dependencies were updated
44
+ * dependencies
45
+ * @twin.org/engine-models bumped from 0.0.3-next.27 to 0.0.3-next.28
46
+ * @twin.org/engine-types bumped from 0.0.3-next.27 to 0.0.3-next.28
47
+
48
+ ## [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)
49
+
50
+
51
+ ### Features
52
+
53
+ * update dependencies ([e6ebe42](https://github.com/twinfoundation/engine/commit/e6ebe42b9d61066227ad8b45dae14c8f8615b760))
54
+
55
+
56
+ ### Dependencies
57
+
58
+ * The following workspace dependencies were updated
59
+ * dependencies
60
+ * @twin.org/engine-models bumped from 0.0.3-next.26 to 0.0.3-next.27
61
+ * @twin.org/engine-types bumped from 0.0.3-next.26 to 0.0.3-next.27
62
+
63
+ ## [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)
64
+
65
+
66
+ ### Miscellaneous Chores
67
+
68
+ * **engine-server-types:** Synchronize repo versions
69
+
70
+
71
+ ### Dependencies
72
+
73
+ * The following workspace dependencies were updated
74
+ * dependencies
75
+ * @twin.org/engine-models bumped from 0.0.3-next.25 to 0.0.3-next.26
76
+ * @twin.org/engine-types bumped from 0.0.3-next.25 to 0.0.3-next.26
77
+
78
+ ## [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)
79
+
80
+
81
+ ### Features
82
+
83
+ * replace unified data space connector with control plane and data plane components ([#78](https://github.com/twinfoundation/engine/issues/78)) ([a6ebace](https://github.com/twinfoundation/engine/commit/a6ebace389dafe754a3ca0827999966b5a101a59))
84
+
85
+
86
+ ### Dependencies
87
+
88
+ * The following workspace dependencies were updated
89
+ * dependencies
90
+ * @twin.org/engine-models bumped from 0.0.3-next.24 to 0.0.3-next.25
91
+ * @twin.org/engine-types bumped from 0.0.3-next.24 to 0.0.3-next.25
92
+
93
+ ## [0.0.3-next.24](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.23...engine-server-types-v0.0.3-next.24) (2026-02-26)
94
+
95
+
96
+ ### Miscellaneous Chores
97
+
98
+ * **engine-server-types:** Synchronize repo versions
99
+
100
+
101
+ ### Dependencies
102
+
103
+ * The following workspace dependencies were updated
104
+ * dependencies
105
+ * @twin.org/engine-models bumped from 0.0.3-next.23 to 0.0.3-next.24
106
+ * @twin.org/engine-types bumped from 0.0.3-next.23 to 0.0.3-next.24
107
+
108
+ ## [0.0.3-next.23](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.22...engine-server-types-v0.0.3-next.23) (2026-02-23)
109
+
110
+
111
+ ### Features
112
+
113
+ * add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
114
+ * add context id features ([#51](https://github.com/twinfoundation/engine/issues/51)) ([eaef180](https://github.com/twinfoundation/engine/commit/eaef1807397a907bc7655ef1545a151a710ca2f1))
115
+ * add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
116
+ * add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
117
+ * add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
118
+ * add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
119
+ * add hosting component ([#70](https://github.com/twinfoundation/engine/issues/70)) ([2ab0dec](https://github.com/twinfoundation/engine/commit/2ab0dec8fdb979395c639b73f394a40a0dd7e55a))
120
+ * add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
121
+ * add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
122
+ * add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
123
+ * add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
124
+ * add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
125
+ * add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
126
+ * add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
127
+ * add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
128
+ * add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
129
+ * context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
130
+ * eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
131
+ * modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
132
+ * multi instance component support ([#83](https://github.com/twinfoundation/engine/issues/83)) ([6012b50](https://github.com/twinfoundation/engine/commit/6012b50959df5af893f05516d42eea2e0800b31a))
133
+ * remove additional identity auth components ([409b2e6](https://github.com/twinfoundation/engine/commit/409b2e6a5a543d0795b01916349b39922afb6d88))
134
+ * remove authentication generator components ([#67](https://github.com/twinfoundation/engine/issues/67)) ([62f7984](https://github.com/twinfoundation/engine/commit/62f798468f567fdbf648401aa0dc51cda871c913))
135
+ * remove dap and darp ([d568c4f](https://github.com/twinfoundation/engine/commit/d568c4fc58a3159378e1d65f93228ae84f34a31d))
136
+ * simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
137
+ * standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
138
+ * switch to devDeps ([32832ac](https://github.com/twinfoundation/engine/commit/32832acd934e1e5569474281a527c9b118d30732))
139
+ * update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
140
+ * update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
141
+ * update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
142
+ * upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
143
+ * use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
144
+
145
+
146
+ ### Dependencies
147
+
148
+ * The following workspace dependencies were updated
149
+ * dependencies
150
+ * @twin.org/engine-models bumped from 0.0.3-next.22 to 0.0.3-next.23
151
+ * @twin.org/engine-types bumped from 0.0.3-next.22 to 0.0.3-next.23
152
+
153
+ ## [0.0.3-next.22](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.21...engine-server-types-v0.0.3-next.22) (2026-02-23)
154
+
155
+
156
+ ### Miscellaneous Chores
157
+
158
+ * **engine-server-types:** Synchronize repo versions
159
+
160
+
161
+ ### Dependencies
162
+
163
+ * The following workspace dependencies were updated
164
+ * dependencies
165
+ * @twin.org/engine-models bumped from 0.0.3-next.21 to 0.0.3-next.22
166
+ * @twin.org/engine-types bumped from 0.0.3-next.21 to 0.0.3-next.22
167
+
168
+ ## [0.0.3-next.21](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.20...engine-server-types-v0.0.3-next.21) (2026-02-13)
169
+
170
+
171
+ ### Features
172
+
173
+ * multi instance component support ([#83](https://github.com/twinfoundation/engine/issues/83)) ([6012b50](https://github.com/twinfoundation/engine/commit/6012b50959df5af893f05516d42eea2e0800b31a))
174
+
175
+
176
+ ### Dependencies
177
+
178
+ * The following workspace dependencies were updated
179
+ * dependencies
180
+ * @twin.org/engine-models bumped from 0.0.3-next.20 to 0.0.3-next.21
181
+ * @twin.org/engine-types bumped from 0.0.3-next.20 to 0.0.3-next.21
182
+
183
+ ## [0.0.3-next.20](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.19...engine-server-types-v0.0.3-next.20) (2026-02-06)
184
+
185
+
186
+ ### Miscellaneous Chores
187
+
188
+ * **engine-server-types:** Synchronize repo versions
189
+
190
+
191
+ ### Dependencies
192
+
193
+ * The following workspace dependencies were updated
194
+ * dependencies
195
+ * @twin.org/engine-models bumped from 0.0.3-next.19 to 0.0.3-next.20
196
+ * @twin.org/engine-types bumped from 0.0.3-next.19 to 0.0.3-next.20
197
+
198
+ ## [0.0.3-next.19](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.18...engine-server-types-v0.0.3-next.19) (2026-02-05)
199
+
200
+
201
+ ### Miscellaneous Chores
202
+
203
+ * **engine-server-types:** Synchronize repo versions
204
+
205
+
206
+ ### Dependencies
207
+
208
+ * The following workspace dependencies were updated
209
+ * dependencies
210
+ * @twin.org/engine-models bumped from 0.0.3-next.18 to 0.0.3-next.19
211
+ * @twin.org/engine-types bumped from 0.0.3-next.18 to 0.0.3-next.19
212
+
213
+ ## [0.0.3-next.18](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.17...engine-server-types-v0.0.3-next.18) (2026-02-04)
214
+
215
+
216
+ ### Miscellaneous Chores
217
+
218
+ * **engine-server-types:** Synchronize repo versions
219
+
220
+
221
+ ### Dependencies
222
+
223
+ * The following workspace dependencies were updated
224
+ * dependencies
225
+ * @twin.org/engine-models bumped from 0.0.3-next.17 to 0.0.3-next.18
226
+ * @twin.org/engine-types bumped from 0.0.3-next.17 to 0.0.3-next.18
227
+
228
+ ## [0.0.3-next.17](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.16...engine-server-types-v0.0.3-next.17) (2026-02-02)
229
+
230
+
231
+ ### Miscellaneous Chores
232
+
233
+ * **engine-server-types:** Synchronize repo versions
234
+
235
+
236
+ ### Dependencies
237
+
238
+ * The following workspace dependencies were updated
239
+ * dependencies
240
+ * @twin.org/engine-models bumped from 0.0.3-next.16 to 0.0.3-next.17
241
+ * @twin.org/engine-types bumped from 0.0.3-next.16 to 0.0.3-next.17
242
+
243
+ ## [0.0.3-next.16](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.15...engine-server-types-v0.0.3-next.16) (2026-01-28)
244
+
245
+
246
+ ### Features
247
+
248
+ * remove dap and darp ([d568c4f](https://github.com/twinfoundation/engine/commit/d568c4fc58a3159378e1d65f93228ae84f34a31d))
249
+
250
+
251
+ ### Dependencies
252
+
253
+ * The following workspace dependencies were updated
254
+ * dependencies
255
+ * @twin.org/engine-models bumped from 0.0.3-next.15 to 0.0.3-next.16
256
+ * @twin.org/engine-types bumped from 0.0.3-next.15 to 0.0.3-next.16
257
+
258
+ ## [0.0.3-next.15](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.14...engine-server-types-v0.0.3-next.15) (2026-01-26)
259
+
260
+
261
+ ### Features
262
+
263
+ * add hosting component ([#70](https://github.com/twinfoundation/engine/issues/70)) ([2ab0dec](https://github.com/twinfoundation/engine/commit/2ab0dec8fdb979395c639b73f394a40a0dd7e55a))
264
+
265
+
266
+ ### Dependencies
267
+
268
+ * The following workspace dependencies were updated
269
+ * dependencies
270
+ * @twin.org/engine-models bumped from 0.0.3-next.14 to 0.0.3-next.15
271
+ * @twin.org/engine-types bumped from 0.0.3-next.14 to 0.0.3-next.15
272
+
273
+ ## [0.0.3-next.14](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.13...engine-server-types-v0.0.3-next.14) (2026-01-19)
274
+
275
+
276
+ ### Features
277
+
278
+ * add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
279
+ * add context id features ([#51](https://github.com/twinfoundation/engine/issues/51)) ([eaef180](https://github.com/twinfoundation/engine/commit/eaef1807397a907bc7655ef1545a151a710ca2f1))
280
+ * add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
281
+ * add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
282
+ * add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
283
+ * add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
284
+ * add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
285
+ * add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
286
+ * add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
287
+ * add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
288
+ * add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
289
+ * add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
290
+ * add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
291
+ * add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
292
+ * add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
293
+ * context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
294
+ * eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
295
+ * modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
296
+ * remove additional identity auth components ([409b2e6](https://github.com/twinfoundation/engine/commit/409b2e6a5a543d0795b01916349b39922afb6d88))
297
+ * remove authentication generator components ([#67](https://github.com/twinfoundation/engine/issues/67)) ([62f7984](https://github.com/twinfoundation/engine/commit/62f798468f567fdbf648401aa0dc51cda871c913))
298
+ * simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
299
+ * standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
300
+ * switch to devDeps ([32832ac](https://github.com/twinfoundation/engine/commit/32832acd934e1e5569474281a527c9b118d30732))
301
+ * update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
302
+ * update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
303
+ * update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
304
+ * upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
305
+ * use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
306
+
307
+
308
+ ### Dependencies
309
+
310
+ * The following workspace dependencies were updated
311
+ * dependencies
312
+ * @twin.org/engine-models bumped from 0.0.3-next.13 to 0.0.3-next.14
313
+ * @twin.org/engine-types bumped from 0.0.3-next.13 to 0.0.3-next.14
314
+
315
+ ## [0.0.3-next.13](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.12...engine-server-types-v0.0.3-next.13) (2026-01-19)
316
+
317
+
318
+ ### Features
319
+
320
+ * remove authentication generator components ([#67](https://github.com/twinfoundation/engine/issues/67)) ([62f7984](https://github.com/twinfoundation/engine/commit/62f798468f567fdbf648401aa0dc51cda871c913))
321
+
322
+
323
+ ### Dependencies
324
+
325
+ * The following workspace dependencies were updated
326
+ * dependencies
327
+ * @twin.org/engine-models bumped from 0.0.3-next.12 to 0.0.3-next.13
328
+ * @twin.org/engine-types bumped from 0.0.3-next.12 to 0.0.3-next.13
329
+
330
+ ## [0.0.3-next.12](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.11...engine-server-types-v0.0.3-next.12) (2026-01-19)
331
+
332
+
333
+ ### Miscellaneous Chores
334
+
335
+ * **engine-server-types:** Synchronize repo versions
336
+
337
+
338
+ ### Dependencies
339
+
340
+ * The following workspace dependencies were updated
341
+ * dependencies
342
+ * @twin.org/engine-models bumped from 0.0.3-next.11 to 0.0.3-next.12
343
+ * @twin.org/engine-types bumped from 0.0.3-next.11 to 0.0.3-next.12
344
+
345
+ ## [0.0.3-next.11](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.10...engine-server-types-v0.0.3-next.11) (2026-01-16)
346
+
347
+
348
+ ### Miscellaneous Chores
349
+
350
+ * **engine-server-types:** Synchronize repo versions
351
+
352
+
353
+ ### Dependencies
354
+
355
+ * The following workspace dependencies were updated
356
+ * dependencies
357
+ * @twin.org/engine-models bumped from 0.0.3-next.10 to 0.0.3-next.11
358
+ * @twin.org/engine-types bumped from 0.0.3-next.10 to 0.0.3-next.11
359
+
360
+ ## [0.0.3-next.10](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.9...engine-server-types-v0.0.3-next.10) (2026-01-13)
361
+
362
+
363
+ ### Miscellaneous Chores
364
+
365
+ * **engine-server-types:** Synchronize repo versions
366
+
367
+
368
+ ### Dependencies
369
+
370
+ * The following workspace dependencies were updated
371
+ * dependencies
372
+ * @twin.org/engine-models bumped from 0.0.3-next.9 to 0.0.3-next.10
373
+ * @twin.org/engine-types bumped from 0.0.3-next.9 to 0.0.3-next.10
374
+
375
+ ## [0.0.3-next.9](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.8...engine-server-types-v0.0.3-next.9) (2026-01-07)
376
+
377
+
378
+ ### Miscellaneous Chores
379
+
380
+ * **engine-server-types:** Synchronize repo versions
381
+
382
+
383
+ ### Dependencies
384
+
385
+ * The following workspace dependencies were updated
386
+ * dependencies
387
+ * @twin.org/engine-models bumped from 0.0.3-next.8 to 0.0.3-next.9
388
+ * @twin.org/engine-types bumped from 0.0.3-next.8 to 0.0.3-next.9
389
+
390
+ ## [0.0.3-next.8](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.7...engine-server-types-v0.0.3-next.8) (2026-01-06)
391
+
392
+
393
+ ### Miscellaneous Chores
394
+
395
+ * **engine-server-types:** Synchronize repo versions
396
+
397
+
398
+ ### Dependencies
399
+
400
+ * The following workspace dependencies were updated
401
+ * dependencies
402
+ * @twin.org/engine-models bumped from 0.0.3-next.7 to 0.0.3-next.8
403
+ * @twin.org/engine-types bumped from 0.0.3-next.7 to 0.0.3-next.8
404
+
405
+ ## [0.0.3-next.7](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.6...engine-server-types-v0.0.3-next.7) (2025-12-04)
406
+
407
+
408
+ ### Features
409
+
410
+ * add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
411
+
412
+
413
+ ### Dependencies
414
+
415
+ * The following workspace dependencies were updated
416
+ * dependencies
417
+ * @twin.org/engine-models bumped from 0.0.3-next.6 to 0.0.3-next.7
418
+ * @twin.org/engine-types bumped from 0.0.3-next.6 to 0.0.3-next.7
419
+
420
+ ## [0.0.3-next.6](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.5...engine-server-types-v0.0.3-next.6) (2025-11-28)
421
+
422
+
423
+ ### Features
424
+
425
+ * add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
426
+
427
+
428
+ ### Dependencies
429
+
430
+ * The following workspace dependencies were updated
431
+ * dependencies
432
+ * @twin.org/engine-models bumped from 0.0.3-next.5 to 0.0.3-next.6
433
+ * @twin.org/engine-types bumped from 0.0.3-next.5 to 0.0.3-next.6
434
+
435
+ ## [0.0.3-next.5](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.4...engine-server-types-v0.0.3-next.5) (2025-11-20)
436
+
437
+
438
+ ### Miscellaneous Chores
439
+
440
+ * **engine-server-types:** Synchronize repo versions
441
+
442
+
443
+ ### Dependencies
444
+
445
+ * The following workspace dependencies were updated
446
+ * dependencies
447
+ * @twin.org/engine-models bumped from 0.0.3-next.4 to 0.0.3-next.5
448
+ * @twin.org/engine-types bumped from 0.0.3-next.4 to 0.0.3-next.5
449
+
450
+ ## [0.0.3-next.4](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.3...engine-server-types-v0.0.3-next.4) (2025-11-20)
451
+
452
+
453
+ ### Features
454
+
455
+ * context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
456
+
457
+
458
+ ### Dependencies
459
+
460
+ * The following workspace dependencies were updated
461
+ * dependencies
462
+ * @twin.org/engine-models bumped from 0.0.3-next.3 to 0.0.3-next.4
463
+ * @twin.org/engine-types bumped from 0.0.3-next.3 to 0.0.3-next.4
2
464
 
3
465
  ## [0.0.3-next.3](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.2...engine-server-types-v0.0.3-next.3) (2025-11-14)
4
466
 
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
+ ```
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseAuthenticationAdminComponent()
2
2
 
3
- > **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
3
+ > **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
4
4
 
5
5
  Initialise the authentication admin.
6
6
 
@@ -26,6 +26,6 @@ The instance config.
26
26
 
27
27
  ## Returns
28
28
 
29
- `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
29
+ `EngineTypeInitialiserReturn`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
30
30
 
31
31
  The instance created and the factory for it.