@twin.org/engine 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.
- package/README.md +1 -1
- package/dist/es/data/coreTypeInitialisers.json +75 -10
- package/docs/changelog.md +528 -1
- package/docs/examples.md +56 -23
- package/docs/reference/classes/Engine.md +565 -1
- package/docs/reference/classes/EngineConfigHelper.md +2 -2
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# TWIN Engine
|
|
2
2
|
|
|
3
|
-
Engine
|
|
3
|
+
Engine provides a ready-to-use runtime that extends the core layer with built-in type initialisers. It helps applications start from a practical baseline while still allowing customisation of configuration and component selection.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
"method": "initialiseLoggingComponent"
|
|
11
11
|
},
|
|
12
12
|
{
|
|
13
|
-
"type": "
|
|
13
|
+
"type": "backgroundTaskComponent",
|
|
14
14
|
"module": "@twin.org/engine-types",
|
|
15
|
-
"method": "
|
|
15
|
+
"method": "initialiseBackgroundTaskComponent"
|
|
16
16
|
},
|
|
17
17
|
{
|
|
18
18
|
"type": "taskSchedulerComponent",
|
|
@@ -144,6 +144,16 @@
|
|
|
144
144
|
"module": "@twin.org/engine-types",
|
|
145
145
|
"method": "initialiseNftComponent"
|
|
146
146
|
},
|
|
147
|
+
{
|
|
148
|
+
"type": "notarizationConnector",
|
|
149
|
+
"module": "@twin.org/engine-types",
|
|
150
|
+
"method": "initialiseNotarizationConnector"
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"type": "notarizationComponent",
|
|
154
|
+
"module": "@twin.org/engine-types",
|
|
155
|
+
"method": "initialiseNotarizationComponent"
|
|
156
|
+
},
|
|
147
157
|
{
|
|
148
158
|
"type": "immutableProofComponent",
|
|
149
159
|
"module": "@twin.org/engine-types",
|
|
@@ -190,9 +200,19 @@
|
|
|
190
200
|
"method": "initialiseDocumentManagementComponent"
|
|
191
201
|
},
|
|
192
202
|
{
|
|
193
|
-
"type": "
|
|
203
|
+
"type": "trustComponent",
|
|
204
|
+
"module": "@twin.org/engine-types",
|
|
205
|
+
"method": "initialiseTrustComponent"
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
"type": "trustGeneratorComponent",
|
|
209
|
+
"module": "@twin.org/engine-types",
|
|
210
|
+
"method": "initialiseTrustGeneratorComponent"
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
"type": "trustVerifierComponent",
|
|
194
214
|
"module": "@twin.org/engine-types",
|
|
195
|
-
"method": "
|
|
215
|
+
"method": "initialiseTrustVerifierComponent"
|
|
196
216
|
},
|
|
197
217
|
{
|
|
198
218
|
"type": "rightsManagementPapComponent",
|
|
@@ -235,14 +255,44 @@
|
|
|
235
255
|
"method": "initialiseRightsManagementPnpComponent"
|
|
236
256
|
},
|
|
237
257
|
{
|
|
238
|
-
"type": "
|
|
258
|
+
"type": "rightsManagementPolicyArbiterComponent",
|
|
259
|
+
"module": "@twin.org/engine-types",
|
|
260
|
+
"method": "initialiseRightsManagementPolicyArbiterComponent"
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"type": "rightsManagementPolicyObligationEnforcerComponent",
|
|
239
264
|
"module": "@twin.org/engine-types",
|
|
240
|
-
"method": "
|
|
265
|
+
"method": "initialiseRightsManagementPolicyObligationEnforcerComponent"
|
|
241
266
|
},
|
|
242
267
|
{
|
|
243
|
-
"type": "
|
|
268
|
+
"type": "rightsManagementPolicyEnforcementProcessorComponent",
|
|
244
269
|
"module": "@twin.org/engine-types",
|
|
245
|
-
"method": "
|
|
270
|
+
"method": "initialiseRightsManagementPolicyEnforcementProcessorComponent"
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
"type": "rightsManagementPolicyExecutionActionComponent",
|
|
274
|
+
"module": "@twin.org/engine-types",
|
|
275
|
+
"method": "initialiseRightsManagementPolicyExecutionActionComponent"
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
"type": "rightsManagementPolicyInformationSourceComponent",
|
|
279
|
+
"module": "@twin.org/engine-types",
|
|
280
|
+
"method": "initialiseRightsManagementPolicyInformationSourceComponent"
|
|
281
|
+
},
|
|
282
|
+
{
|
|
283
|
+
"type": "rightsManagementPolicyNegotiatorComponent",
|
|
284
|
+
"module": "@twin.org/engine-types",
|
|
285
|
+
"method": "initialiseRightsManagementPolicyNegotiatorComponent"
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"type": "rightsManagementPolicyObligationEnforcerComponent",
|
|
289
|
+
"module": "@twin.org/engine-types",
|
|
290
|
+
"method": "initialiseRightsManagementPolicyObligationEnforcerComponent"
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
"type": "rightsManagementPolicyRequesterComponent",
|
|
294
|
+
"module": "@twin.org/engine-types",
|
|
295
|
+
"method": "initialiseRightsManagementPolicyRequesterComponent"
|
|
246
296
|
},
|
|
247
297
|
{
|
|
248
298
|
"type": "synchronisedStorageComponent",
|
|
@@ -255,13 +305,28 @@
|
|
|
255
305
|
"method": "initialiseFederatedCatalogueComponent"
|
|
256
306
|
},
|
|
257
307
|
{
|
|
258
|
-
"type": "
|
|
308
|
+
"type": "federatedCatalogueFilterComponent",
|
|
259
309
|
"module": "@twin.org/engine-types",
|
|
260
|
-
"method": "
|
|
310
|
+
"method": "initialiseFederatedCatalogueFilterComponent"
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
"type": "dataspaceControlPlaneComponent",
|
|
314
|
+
"module": "@twin.org/engine-types",
|
|
315
|
+
"method": "initialiseDataspaceControlPlaneComponent"
|
|
316
|
+
},
|
|
317
|
+
{
|
|
318
|
+
"type": "dataspaceDataPlaneComponent",
|
|
319
|
+
"module": "@twin.org/engine-types",
|
|
320
|
+
"method": "initialiseDataspaceDataPlaneComponent"
|
|
261
321
|
},
|
|
262
322
|
{
|
|
263
323
|
"type": "tenantAdminComponent",
|
|
264
324
|
"module": "@twin.org/engine-types",
|
|
265
325
|
"method": "initialiseTenantAdminComponent"
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
"type": "contextIdHandlerComponent",
|
|
329
|
+
"module": "@twin.org/engine-types",
|
|
330
|
+
"method": "initialiseContextIdHandlerComponent"
|
|
266
331
|
}
|
|
267
332
|
]
|
package/docs/changelog.md
CHANGED
|
@@ -1,4 +1,531 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [0.0.3-next.30](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.29...engine-v0.0.3-next.30) (2026-04-16)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add notarization ([#98](https://github.com/twinfoundation/engine/issues/98)) ([f560e2a](https://github.com/twinfoundation/engine/commit/f560e2a12a5fba01c95e47518ebdc4220801f8b8))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/engine-core bumped from 0.0.3-next.29 to 0.0.3-next.30
|
|
16
|
+
* @twin.org/engine-models bumped from 0.0.3-next.29 to 0.0.3-next.30
|
|
17
|
+
* @twin.org/engine-types bumped from 0.0.3-next.29 to 0.0.3-next.30
|
|
18
|
+
|
|
19
|
+
## [0.0.3-next.29](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.28...engine-v0.0.3-next.29) (2026-04-14)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Miscellaneous Chores
|
|
23
|
+
|
|
24
|
+
* **engine:** Synchronize repo versions
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Dependencies
|
|
28
|
+
|
|
29
|
+
* The following workspace dependencies were updated
|
|
30
|
+
* dependencies
|
|
31
|
+
* @twin.org/engine-core bumped from 0.0.3-next.28 to 0.0.3-next.29
|
|
32
|
+
* @twin.org/engine-models bumped from 0.0.3-next.28 to 0.0.3-next.29
|
|
33
|
+
* @twin.org/engine-types bumped from 0.0.3-next.28 to 0.0.3-next.29
|
|
34
|
+
|
|
35
|
+
## [0.0.3-next.28](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.27...engine-v0.0.3-next.28) (2026-04-10)
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
### Miscellaneous Chores
|
|
39
|
+
|
|
40
|
+
* **engine:** Synchronize repo versions
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Dependencies
|
|
44
|
+
|
|
45
|
+
* The following workspace dependencies were updated
|
|
46
|
+
* dependencies
|
|
47
|
+
* @twin.org/engine-core bumped from 0.0.3-next.27 to 0.0.3-next.28
|
|
48
|
+
* @twin.org/engine-models bumped from 0.0.3-next.27 to 0.0.3-next.28
|
|
49
|
+
* @twin.org/engine-types bumped from 0.0.3-next.27 to 0.0.3-next.28
|
|
50
|
+
|
|
51
|
+
## [0.0.3-next.27](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.26...engine-v0.0.3-next.27) (2026-03-20)
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### Features
|
|
55
|
+
|
|
56
|
+
* update dependencies ([e6ebe42](https://github.com/twinfoundation/engine/commit/e6ebe42b9d61066227ad8b45dae14c8f8615b760))
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### Dependencies
|
|
60
|
+
|
|
61
|
+
* The following workspace dependencies were updated
|
|
62
|
+
* dependencies
|
|
63
|
+
* @twin.org/engine-core bumped from 0.0.3-next.26 to 0.0.3-next.27
|
|
64
|
+
* @twin.org/engine-models bumped from 0.0.3-next.26 to 0.0.3-next.27
|
|
65
|
+
* @twin.org/engine-types bumped from 0.0.3-next.26 to 0.0.3-next.27
|
|
66
|
+
|
|
67
|
+
## [0.0.3-next.26](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.25...engine-v0.0.3-next.26) (2026-03-05)
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### Bug Fixes
|
|
71
|
+
|
|
72
|
+
* use custom instance type for entity storage registration ([#90](https://github.com/twinfoundation/engine/issues/90)) ([2c23995](https://github.com/twinfoundation/engine/commit/2c239953dab4510a4cf97063ee90d048210bf4a6))
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### Dependencies
|
|
76
|
+
|
|
77
|
+
* The following workspace dependencies were updated
|
|
78
|
+
* dependencies
|
|
79
|
+
* @twin.org/engine-core bumped from 0.0.3-next.25 to 0.0.3-next.26
|
|
80
|
+
* @twin.org/engine-models bumped from 0.0.3-next.25 to 0.0.3-next.26
|
|
81
|
+
* @twin.org/engine-types bumped from 0.0.3-next.25 to 0.0.3-next.26
|
|
82
|
+
|
|
83
|
+
## [0.0.3-next.25](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.24...engine-v0.0.3-next.25) (2026-03-02)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
### Features
|
|
87
|
+
|
|
88
|
+
* 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))
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### Dependencies
|
|
92
|
+
|
|
93
|
+
* The following workspace dependencies were updated
|
|
94
|
+
* dependencies
|
|
95
|
+
* @twin.org/engine-core bumped from 0.0.3-next.24 to 0.0.3-next.25
|
|
96
|
+
* @twin.org/engine-models bumped from 0.0.3-next.24 to 0.0.3-next.25
|
|
97
|
+
* @twin.org/engine-types bumped from 0.0.3-next.24 to 0.0.3-next.25
|
|
98
|
+
|
|
99
|
+
## [0.0.3-next.24](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.23...engine-v0.0.3-next.24) (2026-02-26)
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Features
|
|
103
|
+
|
|
104
|
+
* use factory default feature for sorting ([ec8b370](https://github.com/twinfoundation/engine/commit/ec8b370c5c028cb300cdd1e76b0a0cdb2263773c))
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
### Dependencies
|
|
108
|
+
|
|
109
|
+
* The following workspace dependencies were updated
|
|
110
|
+
* dependencies
|
|
111
|
+
* @twin.org/engine-core bumped from 0.0.3-next.23 to 0.0.3-next.24
|
|
112
|
+
* @twin.org/engine-models bumped from 0.0.3-next.23 to 0.0.3-next.24
|
|
113
|
+
* @twin.org/engine-types bumped from 0.0.3-next.23 to 0.0.3-next.24
|
|
114
|
+
|
|
115
|
+
## [0.0.3-next.23](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.22...engine-v0.0.3-next.23) (2026-02-23)
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### Features
|
|
119
|
+
|
|
120
|
+
* add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
|
|
121
|
+
* add context id features ([#51](https://github.com/twinfoundation/engine/issues/51)) ([eaef180](https://github.com/twinfoundation/engine/commit/eaef1807397a907bc7655ef1545a151a710ca2f1))
|
|
122
|
+
* add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
|
|
123
|
+
* add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
|
|
124
|
+
* add engine type helper for config lookups ([a20a398](https://github.com/twinfoundation/engine/commit/a20a3987016c48351178ab8410bc05b0fba0f2c1))
|
|
125
|
+
* add entity storage to task scheduler ([da4dc0f](https://github.com/twinfoundation/engine/commit/da4dc0f26ee4d506d35cd267144c8300a8b52f90))
|
|
126
|
+
* add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
|
|
127
|
+
* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
|
|
128
|
+
* add hosting component ([#70](https://github.com/twinfoundation/engine/issues/70)) ([2ab0dec](https://github.com/twinfoundation/engine/commit/2ab0dec8fdb979395c639b73f394a40a0dd7e55a))
|
|
129
|
+
* add isPrimary and isClone methods ([a7c63e9](https://github.com/twinfoundation/engine/commit/a7c63e97f54c95b104cc81e66d3fa42c6607bdc1))
|
|
130
|
+
* add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
|
|
131
|
+
* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
|
|
132
|
+
* add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
|
|
133
|
+
* add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
|
|
134
|
+
* add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
|
|
135
|
+
* add skipComponentStart flag ([#62](https://github.com/twinfoundation/engine/issues/62)) ([07e90af](https://github.com/twinfoundation/engine/commit/07e90afa4ba1baaa79c0c6f0f45200d781801534))
|
|
136
|
+
* add sorting to factories so default entries are at start ([1a69356](https://github.com/twinfoundation/engine/commit/1a693567befcf27e6edc9880746ee82cfb9538e5))
|
|
137
|
+
* add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
|
|
138
|
+
* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
|
|
139
|
+
* add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
|
|
140
|
+
* add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
|
|
141
|
+
* addCustomEntityStorage optional rest path ([55f42c5](https://github.com/twinfoundation/engine/commit/55f42c568945f010eb8883e27fb385d2c30eebff))
|
|
142
|
+
* context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
|
|
143
|
+
* eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
|
|
144
|
+
* gas station integration ([#17](https://github.com/twinfoundation/engine/issues/17)) ([a3f844a](https://github.com/twinfoundation/engine/commit/a3f844a7fc58c43b4d0700d8d4351062045e66e1))
|
|
145
|
+
* improve startup error handling ([#65](https://github.com/twinfoundation/engine/issues/65)) ([5b2d1c5](https://github.com/twinfoundation/engine/commit/5b2d1c539cf5484afa85e294d6d6c18f24ef8274))
|
|
146
|
+
* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
|
|
147
|
+
* maintain isDefault flag for registered instances ([2ac5bee](https://github.com/twinfoundation/engine/commit/2ac5bee094bef42b396cc82b0d18bb6aebe27352))
|
|
148
|
+
* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
|
|
149
|
+
* move environment variable processing to node level ([2223c12](https://github.com/twinfoundation/engine/commit/2223c12f49f3d34051ecec9687351aa5dd094e54))
|
|
150
|
+
* multi instance component support ([#83](https://github.com/twinfoundation/engine/issues/83)) ([6012b50](https://github.com/twinfoundation/engine/commit/6012b50959df5af893f05516d42eea2e0800b31a))
|
|
151
|
+
* override type initialisers with new registrations ([5b4ff56](https://github.com/twinfoundation/engine/commit/5b4ff561d06b6513c870a72bb20ba23c0653cfe8))
|
|
152
|
+
* remove authentication generator components ([#67](https://github.com/twinfoundation/engine/issues/67)) ([62f7984](https://github.com/twinfoundation/engine/commit/62f798468f567fdbf648401aa0dc51cda871c913))
|
|
153
|
+
* remove dap and darp ([d568c4f](https://github.com/twinfoundation/engine/commit/d568c4fc58a3159378e1d65f93228ae84f34a31d))
|
|
154
|
+
* simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
|
|
155
|
+
* standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
|
|
156
|
+
* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
|
|
157
|
+
* update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
|
|
158
|
+
* update includeUserIdentity usage ([d34f597](https://github.com/twinfoundation/engine/commit/d34f597a61f9645a029411d2911bbda20ddc9eb9))
|
|
159
|
+
* update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
|
|
160
|
+
* update rights management components ([#74](https://github.com/twinfoundation/engine/issues/74)) ([be94ba8](https://github.com/twinfoundation/engine/commit/be94ba837999c586266a7c73228689566ec9876b))
|
|
161
|
+
* update rights management config ([d447575](https://github.com/twinfoundation/engine/commit/d447575cd5cdf3cdf1fe92087e90188ec97516f5))
|
|
162
|
+
* update rights management dependencies ([14d06fb](https://github.com/twinfoundation/engine/commit/14d06fb6604ad04e4094da7b51b61a01a0280b8b))
|
|
163
|
+
* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
|
|
164
|
+
* use peer dependencies ([69dd744](https://github.com/twinfoundation/engine/commit/69dd7449010b8e6f5f35e7fad201ad4c1cab400c))
|
|
165
|
+
* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
### Bug Fixes
|
|
169
|
+
|
|
170
|
+
* blob storage encryption settings ([63ee879](https://github.com/twinfoundation/engine/commit/63ee87904d2be205d8fe2fa11b536790a0d22082))
|
|
171
|
+
* pass contextIds to populateClone ([#79](https://github.com/twinfoundation/engine/issues/79)) ([b22f1bb](https://github.com/twinfoundation/engine/commit/b22f1bbf0319069914e316d27de4c2a8623421cf))
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
### Dependencies
|
|
175
|
+
|
|
176
|
+
* The following workspace dependencies were updated
|
|
177
|
+
* dependencies
|
|
178
|
+
* @twin.org/engine-core bumped from 0.0.3-next.22 to 0.0.3-next.23
|
|
179
|
+
* @twin.org/engine-models bumped from 0.0.3-next.22 to 0.0.3-next.23
|
|
180
|
+
* @twin.org/engine-types bumped from 0.0.3-next.22 to 0.0.3-next.23
|
|
181
|
+
|
|
182
|
+
## [0.0.3-next.22](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.21...engine-v0.0.3-next.22) (2026-02-23)
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
### Features
|
|
186
|
+
|
|
187
|
+
* add sorting to factories so default entries are at start ([1a69356](https://github.com/twinfoundation/engine/commit/1a693567befcf27e6edc9880746ee82cfb9538e5))
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
### Dependencies
|
|
191
|
+
|
|
192
|
+
* The following workspace dependencies were updated
|
|
193
|
+
* dependencies
|
|
194
|
+
* @twin.org/engine-core bumped from 0.0.3-next.21 to 0.0.3-next.22
|
|
195
|
+
* @twin.org/engine-models bumped from 0.0.3-next.21 to 0.0.3-next.22
|
|
196
|
+
* @twin.org/engine-types bumped from 0.0.3-next.21 to 0.0.3-next.22
|
|
197
|
+
|
|
198
|
+
## [0.0.3-next.21](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.20...engine-v0.0.3-next.21) (2026-02-13)
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
### Features
|
|
202
|
+
|
|
203
|
+
* multi instance component support ([#83](https://github.com/twinfoundation/engine/issues/83)) ([6012b50](https://github.com/twinfoundation/engine/commit/6012b50959df5af893f05516d42eea2e0800b31a))
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
### Dependencies
|
|
207
|
+
|
|
208
|
+
* The following workspace dependencies were updated
|
|
209
|
+
* dependencies
|
|
210
|
+
* @twin.org/engine-core bumped from 0.0.3-next.20 to 0.0.3-next.21
|
|
211
|
+
* @twin.org/engine-models bumped from 0.0.3-next.20 to 0.0.3-next.21
|
|
212
|
+
* @twin.org/engine-types bumped from 0.0.3-next.20 to 0.0.3-next.21
|
|
213
|
+
|
|
214
|
+
## [0.0.3-next.20](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.19...engine-v0.0.3-next.20) (2026-02-06)
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
### Miscellaneous Chores
|
|
218
|
+
|
|
219
|
+
* **engine:** Synchronize repo versions
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
### Dependencies
|
|
223
|
+
|
|
224
|
+
* The following workspace dependencies were updated
|
|
225
|
+
* dependencies
|
|
226
|
+
* @twin.org/engine-core bumped from 0.0.3-next.19 to 0.0.3-next.20
|
|
227
|
+
* @twin.org/engine-models bumped from 0.0.3-next.19 to 0.0.3-next.20
|
|
228
|
+
* @twin.org/engine-types bumped from 0.0.3-next.19 to 0.0.3-next.20
|
|
229
|
+
|
|
230
|
+
## [0.0.3-next.19](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.18...engine-v0.0.3-next.19) (2026-02-05)
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
### Bug Fixes
|
|
234
|
+
|
|
235
|
+
* pass contextIds to populateClone ([#79](https://github.com/twinfoundation/engine/issues/79)) ([b22f1bb](https://github.com/twinfoundation/engine/commit/b22f1bbf0319069914e316d27de4c2a8623421cf))
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
### Dependencies
|
|
239
|
+
|
|
240
|
+
* The following workspace dependencies were updated
|
|
241
|
+
* dependencies
|
|
242
|
+
* @twin.org/engine-core bumped from 0.0.3-next.18 to 0.0.3-next.19
|
|
243
|
+
* @twin.org/engine-models bumped from 0.0.3-next.18 to 0.0.3-next.19
|
|
244
|
+
* @twin.org/engine-types bumped from 0.0.3-next.18 to 0.0.3-next.19
|
|
245
|
+
|
|
246
|
+
## [0.0.3-next.18](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.17...engine-v0.0.3-next.18) (2026-02-04)
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
### Miscellaneous Chores
|
|
250
|
+
|
|
251
|
+
* **engine:** Synchronize repo versions
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
### Dependencies
|
|
255
|
+
|
|
256
|
+
* The following workspace dependencies were updated
|
|
257
|
+
* dependencies
|
|
258
|
+
* @twin.org/engine-core bumped from 0.0.3-next.17 to 0.0.3-next.18
|
|
259
|
+
* @twin.org/engine-models bumped from 0.0.3-next.17 to 0.0.3-next.18
|
|
260
|
+
* @twin.org/engine-types bumped from 0.0.3-next.17 to 0.0.3-next.18
|
|
261
|
+
|
|
262
|
+
## [0.0.3-next.17](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.16...engine-v0.0.3-next.17) (2026-02-02)
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
### Features
|
|
266
|
+
|
|
267
|
+
* update rights management components ([#74](https://github.com/twinfoundation/engine/issues/74)) ([be94ba8](https://github.com/twinfoundation/engine/commit/be94ba837999c586266a7c73228689566ec9876b))
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
### Dependencies
|
|
271
|
+
|
|
272
|
+
* The following workspace dependencies were updated
|
|
273
|
+
* dependencies
|
|
274
|
+
* @twin.org/engine-core bumped from 0.0.3-next.16 to 0.0.3-next.17
|
|
275
|
+
* @twin.org/engine-models bumped from 0.0.3-next.16 to 0.0.3-next.17
|
|
276
|
+
* @twin.org/engine-types bumped from 0.0.3-next.16 to 0.0.3-next.17
|
|
277
|
+
|
|
278
|
+
## [0.0.3-next.16](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.15...engine-v0.0.3-next.16) (2026-01-28)
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
### Features
|
|
282
|
+
|
|
283
|
+
* remove dap and darp ([d568c4f](https://github.com/twinfoundation/engine/commit/d568c4fc58a3159378e1d65f93228ae84f34a31d))
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
### Dependencies
|
|
287
|
+
|
|
288
|
+
* The following workspace dependencies were updated
|
|
289
|
+
* dependencies
|
|
290
|
+
* @twin.org/engine-core bumped from 0.0.3-next.15 to 0.0.3-next.16
|
|
291
|
+
* @twin.org/engine-models bumped from 0.0.3-next.15 to 0.0.3-next.16
|
|
292
|
+
* @twin.org/engine-types bumped from 0.0.3-next.15 to 0.0.3-next.16
|
|
293
|
+
|
|
294
|
+
## [0.0.3-next.15](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.14...engine-v0.0.3-next.15) (2026-01-26)
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
### Features
|
|
298
|
+
|
|
299
|
+
* add hosting component ([#70](https://github.com/twinfoundation/engine/issues/70)) ([2ab0dec](https://github.com/twinfoundation/engine/commit/2ab0dec8fdb979395c639b73f394a40a0dd7e55a))
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
### Dependencies
|
|
303
|
+
|
|
304
|
+
* The following workspace dependencies were updated
|
|
305
|
+
* dependencies
|
|
306
|
+
* @twin.org/engine-core bumped from 0.0.3-next.14 to 0.0.3-next.15
|
|
307
|
+
* @twin.org/engine-models bumped from 0.0.3-next.14 to 0.0.3-next.15
|
|
308
|
+
* @twin.org/engine-types bumped from 0.0.3-next.14 to 0.0.3-next.15
|
|
309
|
+
|
|
310
|
+
## [0.0.3-next.14](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.13...engine-v0.0.3-next.14) (2026-01-19)
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
### Features
|
|
314
|
+
|
|
315
|
+
* add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
|
|
316
|
+
* add context id features ([#51](https://github.com/twinfoundation/engine/issues/51)) ([eaef180](https://github.com/twinfoundation/engine/commit/eaef1807397a907bc7655ef1545a151a710ca2f1))
|
|
317
|
+
* add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
|
|
318
|
+
* add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
|
|
319
|
+
* add engine type helper for config lookups ([a20a398](https://github.com/twinfoundation/engine/commit/a20a3987016c48351178ab8410bc05b0fba0f2c1))
|
|
320
|
+
* add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
|
|
321
|
+
* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
|
|
322
|
+
* add isPrimary and isClone methods ([a7c63e9](https://github.com/twinfoundation/engine/commit/a7c63e97f54c95b104cc81e66d3fa42c6607bdc1))
|
|
323
|
+
* add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
|
|
324
|
+
* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
|
|
325
|
+
* add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
|
|
326
|
+
* add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
|
|
327
|
+
* add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
|
|
328
|
+
* add skipComponentStart flag ([#62](https://github.com/twinfoundation/engine/issues/62)) ([07e90af](https://github.com/twinfoundation/engine/commit/07e90afa4ba1baaa79c0c6f0f45200d781801534))
|
|
329
|
+
* add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
|
|
330
|
+
* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
|
|
331
|
+
* add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
|
|
332
|
+
* add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
|
|
333
|
+
* addCustomEntityStorage optional rest path ([55f42c5](https://github.com/twinfoundation/engine/commit/55f42c568945f010eb8883e27fb385d2c30eebff))
|
|
334
|
+
* context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
|
|
335
|
+
* eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
|
|
336
|
+
* gas station integration ([#17](https://github.com/twinfoundation/engine/issues/17)) ([a3f844a](https://github.com/twinfoundation/engine/commit/a3f844a7fc58c43b4d0700d8d4351062045e66e1))
|
|
337
|
+
* improve startup error handling ([#65](https://github.com/twinfoundation/engine/issues/65)) ([5b2d1c5](https://github.com/twinfoundation/engine/commit/5b2d1c539cf5484afa85e294d6d6c18f24ef8274))
|
|
338
|
+
* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
|
|
339
|
+
* maintain isDefault flag for registered instances ([2ac5bee](https://github.com/twinfoundation/engine/commit/2ac5bee094bef42b396cc82b0d18bb6aebe27352))
|
|
340
|
+
* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
|
|
341
|
+
* move environment variable processing to node level ([2223c12](https://github.com/twinfoundation/engine/commit/2223c12f49f3d34051ecec9687351aa5dd094e54))
|
|
342
|
+
* override type initialisers with new registrations ([5b4ff56](https://github.com/twinfoundation/engine/commit/5b4ff561d06b6513c870a72bb20ba23c0653cfe8))
|
|
343
|
+
* remove authentication generator components ([#67](https://github.com/twinfoundation/engine/issues/67)) ([62f7984](https://github.com/twinfoundation/engine/commit/62f798468f567fdbf648401aa0dc51cda871c913))
|
|
344
|
+
* simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
|
|
345
|
+
* standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
|
|
346
|
+
* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
|
|
347
|
+
* update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
|
|
348
|
+
* update includeUserIdentity usage ([d34f597](https://github.com/twinfoundation/engine/commit/d34f597a61f9645a029411d2911bbda20ddc9eb9))
|
|
349
|
+
* update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
|
|
350
|
+
* update rights management config ([d447575](https://github.com/twinfoundation/engine/commit/d447575cd5cdf3cdf1fe92087e90188ec97516f5))
|
|
351
|
+
* update rights management dependencies ([14d06fb](https://github.com/twinfoundation/engine/commit/14d06fb6604ad04e4094da7b51b61a01a0280b8b))
|
|
352
|
+
* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
|
|
353
|
+
* use peer dependencies ([69dd744](https://github.com/twinfoundation/engine/commit/69dd7449010b8e6f5f35e7fad201ad4c1cab400c))
|
|
354
|
+
* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
### Bug Fixes
|
|
358
|
+
|
|
359
|
+
* blob storage encryption settings ([63ee879](https://github.com/twinfoundation/engine/commit/63ee87904d2be205d8fe2fa11b536790a0d22082))
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
### Dependencies
|
|
363
|
+
|
|
364
|
+
* The following workspace dependencies were updated
|
|
365
|
+
* dependencies
|
|
366
|
+
* @twin.org/engine-core bumped from 0.0.3-next.13 to 0.0.3-next.14
|
|
367
|
+
* @twin.org/engine-models bumped from 0.0.3-next.13 to 0.0.3-next.14
|
|
368
|
+
* @twin.org/engine-types bumped from 0.0.3-next.13 to 0.0.3-next.14
|
|
369
|
+
|
|
370
|
+
## [0.0.3-next.13](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.12...engine-v0.0.3-next.13) (2026-01-19)
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
### Features
|
|
374
|
+
|
|
375
|
+
* remove authentication generator components ([#67](https://github.com/twinfoundation/engine/issues/67)) ([62f7984](https://github.com/twinfoundation/engine/commit/62f798468f567fdbf648401aa0dc51cda871c913))
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
### Dependencies
|
|
379
|
+
|
|
380
|
+
* The following workspace dependencies were updated
|
|
381
|
+
* dependencies
|
|
382
|
+
* @twin.org/engine-core bumped from 0.0.3-next.12 to 0.0.3-next.13
|
|
383
|
+
* @twin.org/engine-models bumped from 0.0.3-next.12 to 0.0.3-next.13
|
|
384
|
+
* @twin.org/engine-types bumped from 0.0.3-next.12 to 0.0.3-next.13
|
|
385
|
+
|
|
386
|
+
## [0.0.3-next.12](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.11...engine-v0.0.3-next.12) (2026-01-19)
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
### Features
|
|
390
|
+
|
|
391
|
+
* improve startup error handling ([#65](https://github.com/twinfoundation/engine/issues/65)) ([5b2d1c5](https://github.com/twinfoundation/engine/commit/5b2d1c539cf5484afa85e294d6d6c18f24ef8274))
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
### Dependencies
|
|
395
|
+
|
|
396
|
+
* The following workspace dependencies were updated
|
|
397
|
+
* dependencies
|
|
398
|
+
* @twin.org/engine-core bumped from 0.0.3-next.11 to 0.0.3-next.12
|
|
399
|
+
* @twin.org/engine-models bumped from 0.0.3-next.11 to 0.0.3-next.12
|
|
400
|
+
* @twin.org/engine-types bumped from 0.0.3-next.11 to 0.0.3-next.12
|
|
401
|
+
|
|
402
|
+
## [0.0.3-next.11](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.10...engine-v0.0.3-next.11) (2026-01-16)
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
### Miscellaneous Chores
|
|
406
|
+
|
|
407
|
+
* **engine:** Synchronize repo versions
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
### Dependencies
|
|
411
|
+
|
|
412
|
+
* The following workspace dependencies were updated
|
|
413
|
+
* dependencies
|
|
414
|
+
* @twin.org/engine-core bumped from 0.0.3-next.10 to 0.0.3-next.11
|
|
415
|
+
* @twin.org/engine-models bumped from 0.0.3-next.10 to 0.0.3-next.11
|
|
416
|
+
* @twin.org/engine-types bumped from 0.0.3-next.10 to 0.0.3-next.11
|
|
417
|
+
|
|
418
|
+
## [0.0.3-next.10](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.9...engine-v0.0.3-next.10) (2026-01-13)
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
### Features
|
|
422
|
+
|
|
423
|
+
* add skipComponentStart flag ([#62](https://github.com/twinfoundation/engine/issues/62)) ([07e90af](https://github.com/twinfoundation/engine/commit/07e90afa4ba1baaa79c0c6f0f45200d781801534))
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
### Dependencies
|
|
427
|
+
|
|
428
|
+
* The following workspace dependencies were updated
|
|
429
|
+
* dependencies
|
|
430
|
+
* @twin.org/engine-core bumped from 0.0.3-next.9 to 0.0.3-next.10
|
|
431
|
+
* @twin.org/engine-models bumped from 0.0.3-next.9 to 0.0.3-next.10
|
|
432
|
+
* @twin.org/engine-types bumped from 0.0.3-next.9 to 0.0.3-next.10
|
|
433
|
+
|
|
434
|
+
## [0.0.3-next.9](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.8...engine-v0.0.3-next.9) (2026-01-07)
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
### Miscellaneous Chores
|
|
438
|
+
|
|
439
|
+
* **engine:** Synchronize repo versions
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
### Dependencies
|
|
443
|
+
|
|
444
|
+
* The following workspace dependencies were updated
|
|
445
|
+
* dependencies
|
|
446
|
+
* @twin.org/engine-core bumped from 0.0.3-next.8 to 0.0.3-next.9
|
|
447
|
+
* @twin.org/engine-models bumped from 0.0.3-next.8 to 0.0.3-next.9
|
|
448
|
+
* @twin.org/engine-types bumped from 0.0.3-next.8 to 0.0.3-next.9
|
|
449
|
+
|
|
450
|
+
## [0.0.3-next.8](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.7...engine-v0.0.3-next.8) (2026-01-06)
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
### Miscellaneous Chores
|
|
454
|
+
|
|
455
|
+
* **engine:** Synchronize repo versions
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
### Dependencies
|
|
459
|
+
|
|
460
|
+
* The following workspace dependencies were updated
|
|
461
|
+
* dependencies
|
|
462
|
+
* @twin.org/engine-core bumped from 0.0.3-next.7 to 0.0.3-next.8
|
|
463
|
+
* @twin.org/engine-models bumped from 0.0.3-next.7 to 0.0.3-next.8
|
|
464
|
+
* @twin.org/engine-types bumped from 0.0.3-next.7 to 0.0.3-next.8
|
|
465
|
+
|
|
466
|
+
## [0.0.3-next.7](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.6...engine-v0.0.3-next.7) (2025-12-04)
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
### Features
|
|
470
|
+
|
|
471
|
+
* add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
### Dependencies
|
|
475
|
+
|
|
476
|
+
* The following workspace dependencies were updated
|
|
477
|
+
* dependencies
|
|
478
|
+
* @twin.org/engine-core bumped from 0.0.3-next.6 to 0.0.3-next.7
|
|
479
|
+
* @twin.org/engine-models bumped from 0.0.3-next.6 to 0.0.3-next.7
|
|
480
|
+
* @twin.org/engine-types bumped from 0.0.3-next.6 to 0.0.3-next.7
|
|
481
|
+
|
|
482
|
+
## [0.0.3-next.6](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.5...engine-v0.0.3-next.6) (2025-11-28)
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
### Features
|
|
486
|
+
|
|
487
|
+
* add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
### Dependencies
|
|
491
|
+
|
|
492
|
+
* The following workspace dependencies were updated
|
|
493
|
+
* dependencies
|
|
494
|
+
* @twin.org/engine-core bumped from 0.0.3-next.5 to 0.0.3-next.6
|
|
495
|
+
* @twin.org/engine-models bumped from 0.0.3-next.5 to 0.0.3-next.6
|
|
496
|
+
* @twin.org/engine-types bumped from 0.0.3-next.5 to 0.0.3-next.6
|
|
497
|
+
|
|
498
|
+
## [0.0.3-next.5](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.4...engine-v0.0.3-next.5) (2025-11-20)
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
### Miscellaneous Chores
|
|
502
|
+
|
|
503
|
+
* **engine:** Synchronize repo versions
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
### Dependencies
|
|
507
|
+
|
|
508
|
+
* The following workspace dependencies were updated
|
|
509
|
+
* dependencies
|
|
510
|
+
* @twin.org/engine-core bumped from 0.0.3-next.4 to 0.0.3-next.5
|
|
511
|
+
* @twin.org/engine-models bumped from 0.0.3-next.4 to 0.0.3-next.5
|
|
512
|
+
* @twin.org/engine-types bumped from 0.0.3-next.4 to 0.0.3-next.5
|
|
513
|
+
|
|
514
|
+
## [0.0.3-next.4](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.3...engine-v0.0.3-next.4) (2025-11-20)
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
### Features
|
|
518
|
+
|
|
519
|
+
* context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
### Dependencies
|
|
523
|
+
|
|
524
|
+
* The following workspace dependencies were updated
|
|
525
|
+
* dependencies
|
|
526
|
+
* @twin.org/engine-core bumped from 0.0.3-next.3 to 0.0.3-next.4
|
|
527
|
+
* @twin.org/engine-models bumped from 0.0.3-next.3 to 0.0.3-next.4
|
|
528
|
+
* @twin.org/engine-types bumped from 0.0.3-next.3 to 0.0.3-next.4
|
|
2
529
|
|
|
3
530
|
## [0.0.3-next.3](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.2...engine-v0.0.3-next.3) (2025-11-14)
|
|
4
531
|
|
package/docs/examples.md
CHANGED
|
@@ -1,35 +1,68 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Engine Examples
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
These examples show a practical way to configure and run an instance with built-in type initialisers and custom entity storage.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Engine
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
```typescript
|
|
8
|
+
import { Engine } from '@twin.org/engine';
|
|
9
|
+
import type { IEngineConfig } from '@twin.org/engine-types';
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
const config: IEngineConfig = {
|
|
12
|
+
debug: true,
|
|
13
|
+
silent: false,
|
|
14
|
+
types: {}
|
|
15
|
+
};
|
|
10
16
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
IOTA_EXPLORER_ENDPOINT="https://explorer.iota.org/"
|
|
16
|
-
IOTA_NETWORK="devnet"
|
|
17
|
-
IOTA_COIN_TYPE="4218"
|
|
18
|
-
```
|
|
17
|
+
const engine = new Engine({ config, skipBootstrap: true });
|
|
18
|
+
|
|
19
|
+
engine.addContextIdKey('tenant', ['tenant']);
|
|
20
|
+
engine.addContextId('tenant', 'tenant-a');
|
|
19
21
|
|
|
20
|
-
|
|
22
|
+
engine.addTypeInitialiser('loggingConnector', '@twin.org/engine-types', 'initLoggingConnector');
|
|
21
23
|
|
|
22
|
-
|
|
24
|
+
console.log(engine.getContextIdKeys()); // ["tenant"]
|
|
25
|
+
console.log(engine.getContextIds()); // { tenant: "tenant-a" }
|
|
26
|
+
console.log(engine.isStarted()); // false
|
|
23
27
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
+
await engine.start(true);
|
|
29
|
+
console.log(engine.isStarted()); // true
|
|
30
|
+
|
|
31
|
+
await engine.stop();
|
|
32
|
+
console.log(engine.isStarted()); // false
|
|
28
33
|
```
|
|
29
34
|
|
|
30
|
-
|
|
35
|
+
## EngineConfigHelper
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { EngineConfigHelper } from '@twin.org/engine';
|
|
39
|
+
import type { IEngineConfig } from '@twin.org/engine-types';
|
|
40
|
+
import type { IEntitySchema } from '@twin.org/entity';
|
|
31
41
|
|
|
32
|
-
|
|
33
|
-
|
|
42
|
+
interface Product {
|
|
43
|
+
id: string;
|
|
44
|
+
name: string;
|
|
45
|
+
}
|
|
34
46
|
|
|
35
|
-
|
|
47
|
+
const config: IEngineConfig = {
|
|
48
|
+
debug: false,
|
|
49
|
+
silent: true,
|
|
50
|
+
types: {}
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
const productSchema = {
|
|
54
|
+
type: 'Product',
|
|
55
|
+
properties: {
|
|
56
|
+
id: { type: 'string', isPrimary: true },
|
|
57
|
+
name: { type: 'string' }
|
|
58
|
+
}
|
|
59
|
+
} as IEntitySchema<Product>;
|
|
60
|
+
|
|
61
|
+
EngineConfigHelper.addCustomEntityStorage(config, 'product', productSchema, '/products', [
|
|
62
|
+
'node',
|
|
63
|
+
'tenant'
|
|
64
|
+
]);
|
|
65
|
+
|
|
66
|
+
console.log(config.types.entityStorageComponent?.length ?? 0); // 1
|
|
67
|
+
console.log(config.types.entityStorageComponent?.[0].restPath); // "/products"
|
|
68
|
+
```
|
|
@@ -42,7 +42,7 @@ The options for the engine.
|
|
|
42
42
|
|
|
43
43
|
## Properties
|
|
44
44
|
|
|
45
|
-
### CLASS\_NAME
|
|
45
|
+
### CLASS\_NAME {#class_name}
|
|
46
46
|
|
|
47
47
|
> `readonly` `static` **CLASS\_NAME**: `string`
|
|
48
48
|
|
|
@@ -51,3 +51,567 @@ Runtime name for the class.
|
|
|
51
51
|
#### Overrides
|
|
52
52
|
|
|
53
53
|
`EngineCore.CLASS_NAME`
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
57
|
+
### LOGGING\_COMPONENT\_TYPE\_NAME {#logging_component_type_name}
|
|
58
|
+
|
|
59
|
+
> `readonly` `static` **LOGGING\_COMPONENT\_TYPE\_NAME**: `string`
|
|
60
|
+
|
|
61
|
+
Name for the engine logger component, used for direct console logging.
|
|
62
|
+
|
|
63
|
+
#### Inherited from
|
|
64
|
+
|
|
65
|
+
`EngineCore.LOGGING_COMPONENT_TYPE_NAME`
|
|
66
|
+
|
|
67
|
+
***
|
|
68
|
+
|
|
69
|
+
### LOGGING\_CONNECTOR\_TYPE\_NAME {#logging_connector_type_name}
|
|
70
|
+
|
|
71
|
+
> `readonly` `static` **LOGGING\_CONNECTOR\_TYPE\_NAME**: `string`
|
|
72
|
+
|
|
73
|
+
Name for the engine logger connector, used for direct console logging.
|
|
74
|
+
|
|
75
|
+
#### Inherited from
|
|
76
|
+
|
|
77
|
+
`EngineCore.LOGGING_CONNECTOR_TYPE_NAME`
|
|
78
|
+
|
|
79
|
+
***
|
|
80
|
+
|
|
81
|
+
### \_context {#_context}
|
|
82
|
+
|
|
83
|
+
> `protected` **\_context**: `IEngineCoreContext`\<`C`, `S`\>
|
|
84
|
+
|
|
85
|
+
The core context.
|
|
86
|
+
|
|
87
|
+
#### Inherited from
|
|
88
|
+
|
|
89
|
+
`EngineCore._context`
|
|
90
|
+
|
|
91
|
+
***
|
|
92
|
+
|
|
93
|
+
### \_contextIdKeys {#_contextidkeys}
|
|
94
|
+
|
|
95
|
+
> `protected` `readonly` **\_contextIdKeys**: `object`[]
|
|
96
|
+
|
|
97
|
+
The context ID keys.
|
|
98
|
+
|
|
99
|
+
#### key
|
|
100
|
+
|
|
101
|
+
> **key**: `string`
|
|
102
|
+
|
|
103
|
+
#### componentFeatures
|
|
104
|
+
|
|
105
|
+
> **componentFeatures**: `string`[]
|
|
106
|
+
|
|
107
|
+
#### Inherited from
|
|
108
|
+
|
|
109
|
+
`EngineCore._contextIdKeys`
|
|
110
|
+
|
|
111
|
+
***
|
|
112
|
+
|
|
113
|
+
### \_contextIds? {#_contextids}
|
|
114
|
+
|
|
115
|
+
> `protected` `optional` **\_contextIds?**: `IContextIds`
|
|
116
|
+
|
|
117
|
+
The context IDs.
|
|
118
|
+
|
|
119
|
+
#### Inherited from
|
|
120
|
+
|
|
121
|
+
`EngineCore._contextIds`
|
|
122
|
+
|
|
123
|
+
## Methods
|
|
124
|
+
|
|
125
|
+
### addTypeInitialiser() {#addtypeinitialiser}
|
|
126
|
+
|
|
127
|
+
> **addTypeInitialiser**(`type`, `module`, `method`): `void`
|
|
128
|
+
|
|
129
|
+
Add a type initialiser.
|
|
130
|
+
|
|
131
|
+
#### Parameters
|
|
132
|
+
|
|
133
|
+
##### type
|
|
134
|
+
|
|
135
|
+
`string`
|
|
136
|
+
|
|
137
|
+
The type to add the initialiser for.
|
|
138
|
+
|
|
139
|
+
##### module
|
|
140
|
+
|
|
141
|
+
`string`
|
|
142
|
+
|
|
143
|
+
The name of the module which contains the initialiser method.
|
|
144
|
+
|
|
145
|
+
##### method
|
|
146
|
+
|
|
147
|
+
`string`
|
|
148
|
+
|
|
149
|
+
The name of the method to call.
|
|
150
|
+
|
|
151
|
+
#### Returns
|
|
152
|
+
|
|
153
|
+
`void`
|
|
154
|
+
|
|
155
|
+
#### Inherited from
|
|
156
|
+
|
|
157
|
+
`EngineCore.addTypeInitialiser`
|
|
158
|
+
|
|
159
|
+
***
|
|
160
|
+
|
|
161
|
+
### getTypeConfig() {#gettypeconfig}
|
|
162
|
+
|
|
163
|
+
> **getTypeConfig**(`type`): `IEngineCoreTypeConfig`[] \| `undefined`
|
|
164
|
+
|
|
165
|
+
Get the type config for a specific type.
|
|
166
|
+
|
|
167
|
+
#### Parameters
|
|
168
|
+
|
|
169
|
+
##### type
|
|
170
|
+
|
|
171
|
+
`string`
|
|
172
|
+
|
|
173
|
+
The type to get the config for.
|
|
174
|
+
|
|
175
|
+
#### Returns
|
|
176
|
+
|
|
177
|
+
`IEngineCoreTypeConfig`[] \| `undefined`
|
|
178
|
+
|
|
179
|
+
The type config or undefined if not found.
|
|
180
|
+
|
|
181
|
+
#### Inherited from
|
|
182
|
+
|
|
183
|
+
`EngineCore.getTypeConfig`
|
|
184
|
+
|
|
185
|
+
***
|
|
186
|
+
|
|
187
|
+
### addContextIdKey() {#addcontextidkey}
|
|
188
|
+
|
|
189
|
+
> **addContextIdKey**(`key`, `componentFeatures`): `void`
|
|
190
|
+
|
|
191
|
+
Add a context ID key to the engine.
|
|
192
|
+
|
|
193
|
+
#### Parameters
|
|
194
|
+
|
|
195
|
+
##### key
|
|
196
|
+
|
|
197
|
+
`string`
|
|
198
|
+
|
|
199
|
+
The context ID key.
|
|
200
|
+
|
|
201
|
+
##### componentFeatures
|
|
202
|
+
|
|
203
|
+
`string`[]
|
|
204
|
+
|
|
205
|
+
The component features for the context ID handler.
|
|
206
|
+
|
|
207
|
+
#### Returns
|
|
208
|
+
|
|
209
|
+
`void`
|
|
210
|
+
|
|
211
|
+
#### Inherited from
|
|
212
|
+
|
|
213
|
+
`EngineCore.addContextIdKey`
|
|
214
|
+
|
|
215
|
+
***
|
|
216
|
+
|
|
217
|
+
### getContextIdKeys() {#getcontextidkeys}
|
|
218
|
+
|
|
219
|
+
> **getContextIdKeys**(): `string`[]
|
|
220
|
+
|
|
221
|
+
Get the context ID keys for the engine.
|
|
222
|
+
|
|
223
|
+
#### Returns
|
|
224
|
+
|
|
225
|
+
`string`[]
|
|
226
|
+
|
|
227
|
+
The context IDs keys.
|
|
228
|
+
|
|
229
|
+
#### Inherited from
|
|
230
|
+
|
|
231
|
+
`EngineCore.getContextIdKeys`
|
|
232
|
+
|
|
233
|
+
***
|
|
234
|
+
|
|
235
|
+
### addContextId() {#addcontextid}
|
|
236
|
+
|
|
237
|
+
> **addContextId**(`key`, `value`): `void`
|
|
238
|
+
|
|
239
|
+
Add a context ID to the engine.
|
|
240
|
+
|
|
241
|
+
#### Parameters
|
|
242
|
+
|
|
243
|
+
##### key
|
|
244
|
+
|
|
245
|
+
`string`
|
|
246
|
+
|
|
247
|
+
The context ID key.
|
|
248
|
+
|
|
249
|
+
##### value
|
|
250
|
+
|
|
251
|
+
`string`
|
|
252
|
+
|
|
253
|
+
The context ID value.
|
|
254
|
+
|
|
255
|
+
#### Returns
|
|
256
|
+
|
|
257
|
+
`void`
|
|
258
|
+
|
|
259
|
+
#### Inherited from
|
|
260
|
+
|
|
261
|
+
`EngineCore.addContextId`
|
|
262
|
+
|
|
263
|
+
***
|
|
264
|
+
|
|
265
|
+
### getContextIds() {#getcontextids}
|
|
266
|
+
|
|
267
|
+
> **getContextIds**(): `IContextIds` \| `undefined`
|
|
268
|
+
|
|
269
|
+
Get the context IDs for the engine.
|
|
270
|
+
|
|
271
|
+
#### Returns
|
|
272
|
+
|
|
273
|
+
`IContextIds` \| `undefined`
|
|
274
|
+
|
|
275
|
+
The context IDs or undefined if none are set.
|
|
276
|
+
|
|
277
|
+
#### Inherited from
|
|
278
|
+
|
|
279
|
+
`EngineCore.getContextIds`
|
|
280
|
+
|
|
281
|
+
***
|
|
282
|
+
|
|
283
|
+
### start() {#start}
|
|
284
|
+
|
|
285
|
+
> **start**(`skipComponentStart?`): `Promise`\<`void`\>
|
|
286
|
+
|
|
287
|
+
Start the engine core.
|
|
288
|
+
|
|
289
|
+
#### Parameters
|
|
290
|
+
|
|
291
|
+
##### skipComponentStart?
|
|
292
|
+
|
|
293
|
+
`boolean`
|
|
294
|
+
|
|
295
|
+
Should the component start be skipped.
|
|
296
|
+
|
|
297
|
+
#### Returns
|
|
298
|
+
|
|
299
|
+
`Promise`\<`void`\>
|
|
300
|
+
|
|
301
|
+
Nothing.
|
|
302
|
+
|
|
303
|
+
#### Inherited from
|
|
304
|
+
|
|
305
|
+
`EngineCore.start`
|
|
306
|
+
|
|
307
|
+
***
|
|
308
|
+
|
|
309
|
+
### stop() {#stop}
|
|
310
|
+
|
|
311
|
+
> **stop**(): `Promise`\<`void`\>
|
|
312
|
+
|
|
313
|
+
Stop the engine core.
|
|
314
|
+
|
|
315
|
+
#### Returns
|
|
316
|
+
|
|
317
|
+
`Promise`\<`void`\>
|
|
318
|
+
|
|
319
|
+
Nothing.
|
|
320
|
+
|
|
321
|
+
#### Inherited from
|
|
322
|
+
|
|
323
|
+
`EngineCore.stop`
|
|
324
|
+
|
|
325
|
+
***
|
|
326
|
+
|
|
327
|
+
### isStarted() {#isstarted}
|
|
328
|
+
|
|
329
|
+
> **isStarted**(): `boolean`
|
|
330
|
+
|
|
331
|
+
Is the engine started.
|
|
332
|
+
|
|
333
|
+
#### Returns
|
|
334
|
+
|
|
335
|
+
`boolean`
|
|
336
|
+
|
|
337
|
+
True if the engine is started.
|
|
338
|
+
|
|
339
|
+
#### Inherited from
|
|
340
|
+
|
|
341
|
+
`EngineCore.isStarted`
|
|
342
|
+
|
|
343
|
+
***
|
|
344
|
+
|
|
345
|
+
### isPrimary() {#isprimary}
|
|
346
|
+
|
|
347
|
+
> **isPrimary**(): `boolean`
|
|
348
|
+
|
|
349
|
+
Is this the primary engine instance.
|
|
350
|
+
|
|
351
|
+
#### Returns
|
|
352
|
+
|
|
353
|
+
`boolean`
|
|
354
|
+
|
|
355
|
+
True if the engine is the primary instance.
|
|
356
|
+
|
|
357
|
+
#### Inherited from
|
|
358
|
+
|
|
359
|
+
`EngineCore.isPrimary`
|
|
360
|
+
|
|
361
|
+
***
|
|
362
|
+
|
|
363
|
+
### isClone() {#isclone}
|
|
364
|
+
|
|
365
|
+
> **isClone**(): `boolean`
|
|
366
|
+
|
|
367
|
+
Is this engine instance a clone.
|
|
368
|
+
|
|
369
|
+
#### Returns
|
|
370
|
+
|
|
371
|
+
`boolean`
|
|
372
|
+
|
|
373
|
+
True if the engine instance is a clone.
|
|
374
|
+
|
|
375
|
+
#### Inherited from
|
|
376
|
+
|
|
377
|
+
`EngineCore.isClone`
|
|
378
|
+
|
|
379
|
+
***
|
|
380
|
+
|
|
381
|
+
### logInfo() {#loginfo}
|
|
382
|
+
|
|
383
|
+
> **logInfo**(`message`): `Promise`\<`void`\>
|
|
384
|
+
|
|
385
|
+
Log info.
|
|
386
|
+
|
|
387
|
+
#### Parameters
|
|
388
|
+
|
|
389
|
+
##### message
|
|
390
|
+
|
|
391
|
+
`string`
|
|
392
|
+
|
|
393
|
+
The message to log.
|
|
394
|
+
|
|
395
|
+
#### Returns
|
|
396
|
+
|
|
397
|
+
`Promise`\<`void`\>
|
|
398
|
+
|
|
399
|
+
#### Inherited from
|
|
400
|
+
|
|
401
|
+
`EngineCore.logInfo`
|
|
402
|
+
|
|
403
|
+
***
|
|
404
|
+
|
|
405
|
+
### logError() {#logerror}
|
|
406
|
+
|
|
407
|
+
> **logError**(`error`): `Promise`\<`void`\>
|
|
408
|
+
|
|
409
|
+
Log error.
|
|
410
|
+
|
|
411
|
+
#### Parameters
|
|
412
|
+
|
|
413
|
+
##### error
|
|
414
|
+
|
|
415
|
+
`IError`
|
|
416
|
+
|
|
417
|
+
The error to log.
|
|
418
|
+
|
|
419
|
+
#### Returns
|
|
420
|
+
|
|
421
|
+
`Promise`\<`void`\>
|
|
422
|
+
|
|
423
|
+
#### Inherited from
|
|
424
|
+
|
|
425
|
+
`EngineCore.logError`
|
|
426
|
+
|
|
427
|
+
***
|
|
428
|
+
|
|
429
|
+
### getConfig() {#getconfig}
|
|
430
|
+
|
|
431
|
+
> **getConfig**(): `C`
|
|
432
|
+
|
|
433
|
+
Get the config for the engine.
|
|
434
|
+
|
|
435
|
+
#### Returns
|
|
436
|
+
|
|
437
|
+
`C`
|
|
438
|
+
|
|
439
|
+
The config for the engine.
|
|
440
|
+
|
|
441
|
+
#### Inherited from
|
|
442
|
+
|
|
443
|
+
`EngineCore.getConfig`
|
|
444
|
+
|
|
445
|
+
***
|
|
446
|
+
|
|
447
|
+
### getState() {#getstate}
|
|
448
|
+
|
|
449
|
+
> **getState**(): `S`
|
|
450
|
+
|
|
451
|
+
Get the state of the engine.
|
|
452
|
+
|
|
453
|
+
#### Returns
|
|
454
|
+
|
|
455
|
+
`S`
|
|
456
|
+
|
|
457
|
+
The state of the engine.
|
|
458
|
+
|
|
459
|
+
#### Inherited from
|
|
460
|
+
|
|
461
|
+
`EngineCore.getState`
|
|
462
|
+
|
|
463
|
+
***
|
|
464
|
+
|
|
465
|
+
### setStateDirty() {#setstatedirty}
|
|
466
|
+
|
|
467
|
+
> **setStateDirty**(): `void`
|
|
468
|
+
|
|
469
|
+
Set the state to dirty so it gets saved.
|
|
470
|
+
|
|
471
|
+
#### Returns
|
|
472
|
+
|
|
473
|
+
`void`
|
|
474
|
+
|
|
475
|
+
#### Inherited from
|
|
476
|
+
|
|
477
|
+
`EngineCore.setStateDirty`
|
|
478
|
+
|
|
479
|
+
***
|
|
480
|
+
|
|
481
|
+
### getRegisteredInstances() {#getregisteredinstances}
|
|
482
|
+
|
|
483
|
+
> **getRegisteredInstances**(): `object`
|
|
484
|
+
|
|
485
|
+
Get all the registered instances.
|
|
486
|
+
|
|
487
|
+
#### Returns
|
|
488
|
+
|
|
489
|
+
`object`
|
|
490
|
+
|
|
491
|
+
The registered instances.
|
|
492
|
+
|
|
493
|
+
#### Inherited from
|
|
494
|
+
|
|
495
|
+
`EngineCore.getRegisteredInstances`
|
|
496
|
+
|
|
497
|
+
***
|
|
498
|
+
|
|
499
|
+
### getRegisteredInstanceType() {#getregisteredinstancetype}
|
|
500
|
+
|
|
501
|
+
> **getRegisteredInstanceType**(`componentConnectorType`, `features?`): `string`
|
|
502
|
+
|
|
503
|
+
Get the registered instance type for the component/connector.
|
|
504
|
+
|
|
505
|
+
#### Parameters
|
|
506
|
+
|
|
507
|
+
##### componentConnectorType
|
|
508
|
+
|
|
509
|
+
`string`
|
|
510
|
+
|
|
511
|
+
The type of the component/connector.
|
|
512
|
+
|
|
513
|
+
##### features?
|
|
514
|
+
|
|
515
|
+
`string`[]
|
|
516
|
+
|
|
517
|
+
The requested features of the component, if not specified the default entry will be retrieved.
|
|
518
|
+
|
|
519
|
+
#### Returns
|
|
520
|
+
|
|
521
|
+
`string`
|
|
522
|
+
|
|
523
|
+
The instance type matching the criteria if one is registered.
|
|
524
|
+
|
|
525
|
+
#### Throws
|
|
526
|
+
|
|
527
|
+
If a matching instance was not found.
|
|
528
|
+
|
|
529
|
+
#### Inherited from
|
|
530
|
+
|
|
531
|
+
`EngineCore.getRegisteredInstanceType`
|
|
532
|
+
|
|
533
|
+
***
|
|
534
|
+
|
|
535
|
+
### getRegisteredInstanceTypeOptional() {#getregisteredinstancetypeoptional}
|
|
536
|
+
|
|
537
|
+
> **getRegisteredInstanceTypeOptional**(`componentConnectorType`, `features?`): `string` \| `undefined`
|
|
538
|
+
|
|
539
|
+
Get the registered instance type for the component/connector if it exists.
|
|
540
|
+
|
|
541
|
+
#### Parameters
|
|
542
|
+
|
|
543
|
+
##### componentConnectorType
|
|
544
|
+
|
|
545
|
+
`string`
|
|
546
|
+
|
|
547
|
+
The type of the component/connector.
|
|
548
|
+
|
|
549
|
+
##### features?
|
|
550
|
+
|
|
551
|
+
`string`[]
|
|
552
|
+
|
|
553
|
+
The requested features of the component, if not specified the default entry will be retrieved.
|
|
554
|
+
|
|
555
|
+
#### Returns
|
|
556
|
+
|
|
557
|
+
`string` \| `undefined`
|
|
558
|
+
|
|
559
|
+
The instance type matching the criteria if one is registered.
|
|
560
|
+
|
|
561
|
+
#### Inherited from
|
|
562
|
+
|
|
563
|
+
`EngineCore.getRegisteredInstanceTypeOptional`
|
|
564
|
+
|
|
565
|
+
***
|
|
566
|
+
|
|
567
|
+
### getCloneData() {#getclonedata}
|
|
568
|
+
|
|
569
|
+
> **getCloneData**(): `IEngineCoreClone`\<`C`, `S`\>
|
|
570
|
+
|
|
571
|
+
Get the data required to create a clone of the engine.
|
|
572
|
+
|
|
573
|
+
#### Returns
|
|
574
|
+
|
|
575
|
+
`IEngineCoreClone`\<`C`, `S`\>
|
|
576
|
+
|
|
577
|
+
The clone data.
|
|
578
|
+
|
|
579
|
+
#### Inherited from
|
|
580
|
+
|
|
581
|
+
`EngineCore.getCloneData`
|
|
582
|
+
|
|
583
|
+
***
|
|
584
|
+
|
|
585
|
+
### populateClone() {#populateclone}
|
|
586
|
+
|
|
587
|
+
> **populateClone**(`cloneData`, `contextIds?`, `silent?`): `void`
|
|
588
|
+
|
|
589
|
+
Populate the engine from the clone data.
|
|
590
|
+
|
|
591
|
+
#### Parameters
|
|
592
|
+
|
|
593
|
+
##### cloneData
|
|
594
|
+
|
|
595
|
+
`IEngineCoreClone`\<`C`, `S`\>
|
|
596
|
+
|
|
597
|
+
The clone data to populate from.
|
|
598
|
+
|
|
599
|
+
##### contextIds?
|
|
600
|
+
|
|
601
|
+
`IContextIds`
|
|
602
|
+
|
|
603
|
+
The context IDs to use for the clone.
|
|
604
|
+
|
|
605
|
+
##### silent?
|
|
606
|
+
|
|
607
|
+
`boolean`
|
|
608
|
+
|
|
609
|
+
Should the clone be silent.
|
|
610
|
+
|
|
611
|
+
#### Returns
|
|
612
|
+
|
|
613
|
+
`void`
|
|
614
|
+
|
|
615
|
+
#### Inherited from
|
|
616
|
+
|
|
617
|
+
`EngineCore.populateClone`
|
|
@@ -14,7 +14,7 @@ Helper methods for engine config.
|
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|
|
17
|
-
### CLASS\_NAME
|
|
17
|
+
### CLASS\_NAME {#class_name}
|
|
18
18
|
|
|
19
19
|
> `readonly` `static` **CLASS\_NAME**: `string`
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Runtime name for the class.
|
|
|
22
22
|
|
|
23
23
|
## Methods
|
|
24
24
|
|
|
25
|
-
### addCustomEntityStorage()
|
|
25
|
+
### addCustomEntityStorage() {#addcustomentitystorage}
|
|
26
26
|
|
|
27
27
|
> `static` **addCustomEntityStorage**\<`T`\>(`engineConfig`, `entityTypeName`, `entitySchema`, `restPath?`, `partitionContextIds?`): `void`
|
|
28
28
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/engine",
|
|
3
|
-
"version": "0.0.3-next.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.0.3-next.30",
|
|
4
|
+
"description": "Ready-to-use engine runtime that preloads built-in type initialisers.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
7
|
"url": "git+https://github.com/twinfoundation/engine.git",
|
|
@@ -16,9 +16,9 @@
|
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@twin.org/context": "next",
|
|
18
18
|
"@twin.org/core": "next",
|
|
19
|
-
"@twin.org/engine-core": "0.0.3-next.
|
|
20
|
-
"@twin.org/engine-models": "0.0.3-next.
|
|
21
|
-
"@twin.org/engine-types": "0.0.3-next.
|
|
19
|
+
"@twin.org/engine-core": "0.0.3-next.30",
|
|
20
|
+
"@twin.org/engine-models": "0.0.3-next.30",
|
|
21
|
+
"@twin.org/engine-types": "0.0.3-next.30",
|
|
22
22
|
"@twin.org/entity": "next",
|
|
23
23
|
"@twin.org/nameof": "next"
|
|
24
24
|
},
|