@twin.org/engine 0.0.1 → 0.0.2-next.10

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.
@@ -66,9 +66,16 @@ class Engine extends engineCore.EngineCore {
66
66
  this.addTypeInitialiser("dataExtractorConnector", this._context.config.types.dataExtractorConnector, "@twin.org/engine-types", "initialiseDataExtractorConnector");
67
67
  this.addTypeInitialiser("dataProcessingComponent", this._context.config.types.dataProcessingComponent, "@twin.org/engine-types", "initialiseDataProcessingComponent");
68
68
  this.addTypeInitialiser("documentManagementComponent", this._context.config.types.documentManagementComponent, "@twin.org/engine-types", "initialiseDocumentManagementComponent");
69
- this.addTypeInitialiser("federatedCatalogueComponent", this._context.config.types.federatedCatalogueComponent, "@twin.org/engine-types", "initialiseFederatedCatalogueComponent");
70
69
  this.addTypeInitialiser("rightsManagementPapComponent", this._context.config.types.rightsManagementPapComponent, "@twin.org/engine-types", "initialiseRightsManagementPapComponent");
70
+ this.addTypeInitialiser("rightsManagementPmpComponent", this._context.config.types.rightsManagementPmpComponent, "@twin.org/engine-types", "initialiseRightsManagementPmpComponent");
71
+ this.addTypeInitialiser("rightsManagementPxpComponent", this._context.config.types.rightsManagementPxpComponent, "@twin.org/engine-types", "initialiseRightsManagementPxpComponent");
72
+ this.addTypeInitialiser("rightsManagementPipComponent", this._context.config.types.rightsManagementPipComponent, "@twin.org/engine-types", "initialiseRightsManagementPipComponent");
73
+ this.addTypeInitialiser("rightsManagementPdpComponent", this._context.config.types.rightsManagementPdpComponent, "@twin.org/engine-types", "initialiseRightsManagementPdpComponent");
74
+ this.addTypeInitialiser("rightsManagementPepComponent", this._context.config.types.rightsManagementPepComponent, "@twin.org/engine-types", "initialiseRightsManagementPepComponent");
71
75
  this.addTypeInitialiser("rightsManagementComponent", this._context.config.types.rightsManagementComponent, "@twin.org/engine-types", "initialiseRightsManagementComponent");
76
+ this.addTypeInitialiser("synchronisedStorageComponent", this._context.config.types.synchronisedStorageComponent, "@twin.org/engine-types", "initialiseSynchronisedStorageComponent");
77
+ this.addTypeInitialiser("federatedCatalogueComponent", this._context.config.types.federatedCatalogueComponent, "@twin.org/engine-types", "initialiseFederatedCatalogueComponent");
78
+ this.addTypeInitialiser("dataSpaceConnectorComponent", this._context.config.types.dataSpaceConnectorComponent, "@twin.org/engine-types", "initialiseDataSpaceConnectorComponent");
72
79
  }
73
80
  }
74
81
 
@@ -89,8 +96,7 @@ class EngineConfigHelper {
89
96
  * @param entitySchema The entity schema.
90
97
  * @param restPath The rest path to serve the entity storage from, leave undefined for no endpoints.
91
98
  * @param options Additional options.
92
- * @param options.includeNodeIdentity Whether to include the node identity in the entity, defaults to true.
93
- * @param options.includeUserIdentity Whether to include the user identity in the entity, defaults to true.
99
+ * @param options.partitionPerUser Whether to partition the user identity in the data, defaults to false.
94
100
  */
95
101
  static addCustomEntityStorage(engineConfig, entityTypeName, entitySchema, restPath, options) {
96
102
  core.Guards.object(EngineConfigHelper.CLASS_NAME, "engineConfig", engineConfig);
@@ -103,8 +109,7 @@ class EngineConfigHelper {
103
109
  options: {
104
110
  entityStorageType: entityTypeName,
105
111
  config: {
106
- includeNodeIdentity: options?.includeNodeIdentity ?? true,
107
- includeUserIdentity: options?.includeUserIdentity ?? true
112
+ partitionPerUser: options?.partitionPerUser
108
113
  }
109
114
  },
110
115
  overrideInstanceType: core.StringHelper.kebabCase(entityTypeName),
@@ -64,9 +64,16 @@ class Engine extends EngineCore {
64
64
  this.addTypeInitialiser("dataExtractorConnector", this._context.config.types.dataExtractorConnector, "@twin.org/engine-types", "initialiseDataExtractorConnector");
65
65
  this.addTypeInitialiser("dataProcessingComponent", this._context.config.types.dataProcessingComponent, "@twin.org/engine-types", "initialiseDataProcessingComponent");
66
66
  this.addTypeInitialiser("documentManagementComponent", this._context.config.types.documentManagementComponent, "@twin.org/engine-types", "initialiseDocumentManagementComponent");
67
- this.addTypeInitialiser("federatedCatalogueComponent", this._context.config.types.federatedCatalogueComponent, "@twin.org/engine-types", "initialiseFederatedCatalogueComponent");
68
67
  this.addTypeInitialiser("rightsManagementPapComponent", this._context.config.types.rightsManagementPapComponent, "@twin.org/engine-types", "initialiseRightsManagementPapComponent");
68
+ this.addTypeInitialiser("rightsManagementPmpComponent", this._context.config.types.rightsManagementPmpComponent, "@twin.org/engine-types", "initialiseRightsManagementPmpComponent");
69
+ this.addTypeInitialiser("rightsManagementPxpComponent", this._context.config.types.rightsManagementPxpComponent, "@twin.org/engine-types", "initialiseRightsManagementPxpComponent");
70
+ this.addTypeInitialiser("rightsManagementPipComponent", this._context.config.types.rightsManagementPipComponent, "@twin.org/engine-types", "initialiseRightsManagementPipComponent");
71
+ this.addTypeInitialiser("rightsManagementPdpComponent", this._context.config.types.rightsManagementPdpComponent, "@twin.org/engine-types", "initialiseRightsManagementPdpComponent");
72
+ this.addTypeInitialiser("rightsManagementPepComponent", this._context.config.types.rightsManagementPepComponent, "@twin.org/engine-types", "initialiseRightsManagementPepComponent");
69
73
  this.addTypeInitialiser("rightsManagementComponent", this._context.config.types.rightsManagementComponent, "@twin.org/engine-types", "initialiseRightsManagementComponent");
74
+ this.addTypeInitialiser("synchronisedStorageComponent", this._context.config.types.synchronisedStorageComponent, "@twin.org/engine-types", "initialiseSynchronisedStorageComponent");
75
+ this.addTypeInitialiser("federatedCatalogueComponent", this._context.config.types.federatedCatalogueComponent, "@twin.org/engine-types", "initialiseFederatedCatalogueComponent");
76
+ this.addTypeInitialiser("dataSpaceConnectorComponent", this._context.config.types.dataSpaceConnectorComponent, "@twin.org/engine-types", "initialiseDataSpaceConnectorComponent");
70
77
  }
71
78
  }
72
79
 
@@ -87,8 +94,7 @@ class EngineConfigHelper {
87
94
  * @param entitySchema The entity schema.
88
95
  * @param restPath The rest path to serve the entity storage from, leave undefined for no endpoints.
89
96
  * @param options Additional options.
90
- * @param options.includeNodeIdentity Whether to include the node identity in the entity, defaults to true.
91
- * @param options.includeUserIdentity Whether to include the user identity in the entity, defaults to true.
97
+ * @param options.partitionPerUser Whether to partition the user identity in the data, defaults to false.
92
98
  */
93
99
  static addCustomEntityStorage(engineConfig, entityTypeName, entitySchema, restPath, options) {
94
100
  Guards.object(EngineConfigHelper.CLASS_NAME, "engineConfig", engineConfig);
@@ -101,8 +107,7 @@ class EngineConfigHelper {
101
107
  options: {
102
108
  entityStorageType: entityTypeName,
103
109
  config: {
104
- includeNodeIdentity: options?.includeNodeIdentity ?? true,
105
- includeUserIdentity: options?.includeUserIdentity ?? true
110
+ partitionPerUser: options?.partitionPerUser
106
111
  }
107
112
  },
108
113
  overrideInstanceType: StringHelper.kebabCase(entityTypeName),
@@ -15,11 +15,9 @@ export declare class EngineConfigHelper {
15
15
  * @param entitySchema The entity schema.
16
16
  * @param restPath The rest path to serve the entity storage from, leave undefined for no endpoints.
17
17
  * @param options Additional options.
18
- * @param options.includeNodeIdentity Whether to include the node identity in the entity, defaults to true.
19
- * @param options.includeUserIdentity Whether to include the user identity in the entity, defaults to true.
18
+ * @param options.partitionPerUser Whether to partition the user identity in the data, defaults to false.
20
19
  */
21
20
  static addCustomEntityStorage<T>(engineConfig: IEngineConfig, entityTypeName: string, entitySchema: IEntitySchema<T>, restPath?: string, options?: {
22
- includeNodeIdentity?: boolean;
23
- includeUserIdentity?: true;
21
+ partitionPerUser?: boolean;
24
22
  }): void;
25
23
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,171 @@
1
1
  # @twin.org/engine - Changelog
2
2
 
3
+ ## [0.0.2-next.10](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.9...engine-v0.0.2-next.10) (2025-08-26)
4
+
5
+
6
+ ### Features
7
+
8
+ * add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/engine-core bumped from 0.0.2-next.9 to 0.0.2-next.10
16
+ * @twin.org/engine-types bumped from 0.0.2-next.9 to 0.0.2-next.10
17
+
18
+ ## [0.0.2-next.9](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.8...engine-v0.0.2-next.9) (2025-08-25)
19
+
20
+
21
+ ### Features
22
+
23
+ * add isPrimary and isClone methods ([a7c63e9](https://github.com/twinfoundation/engine/commit/a7c63e97f54c95b104cc81e66d3fa42c6607bdc1))
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/engine-core bumped from 0.0.2-next.8 to 0.0.2-next.9
31
+ * @twin.org/engine-types bumped from 0.0.2-next.8 to 0.0.2-next.9
32
+
33
+ ## [0.0.2-next.8](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.7...engine-v0.0.2-next.8) (2025-08-22)
34
+
35
+
36
+ ### Features
37
+
38
+ * add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
39
+
40
+
41
+ ### Dependencies
42
+
43
+ * The following workspace dependencies were updated
44
+ * dependencies
45
+ * @twin.org/engine-core bumped from 0.0.2-next.7 to 0.0.2-next.8
46
+ * @twin.org/engine-types bumped from 0.0.2-next.7 to 0.0.2-next.8
47
+
48
+ ## [0.0.2-next.7](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.6...engine-v0.0.2-next.7) (2025-08-22)
49
+
50
+
51
+ ### Miscellaneous Chores
52
+
53
+ * **engine:** Synchronize repo versions
54
+
55
+
56
+ ### Dependencies
57
+
58
+ * The following workspace dependencies were updated
59
+ * dependencies
60
+ * @twin.org/engine-core bumped from 0.0.2-next.6 to 0.0.2-next.7
61
+ * @twin.org/engine-types bumped from 0.0.2-next.6 to 0.0.2-next.7
62
+
63
+ ## [0.0.2-next.6](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.5...engine-v0.0.2-next.6) (2025-08-21)
64
+
65
+
66
+ ### Features
67
+
68
+ * update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
69
+
70
+
71
+ ### Dependencies
72
+
73
+ * The following workspace dependencies were updated
74
+ * dependencies
75
+ * @twin.org/engine-core bumped from 0.0.2-next.5 to 0.0.2-next.6
76
+ * @twin.org/engine-types bumped from 0.0.2-next.5 to 0.0.2-next.6
77
+
78
+ ## [0.0.2-next.5](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.4...engine-v0.0.2-next.5) (2025-08-14)
79
+
80
+
81
+ ### Features
82
+
83
+ * add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
84
+
85
+
86
+ ### Dependencies
87
+
88
+ * The following workspace dependencies were updated
89
+ * dependencies
90
+ * @twin.org/engine-core bumped from 0.0.2-next.4 to 0.0.2-next.5
91
+ * @twin.org/engine-types bumped from 0.0.2-next.4 to 0.0.2-next.5
92
+
93
+ ## [0.0.2-next.4](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.3...engine-v0.0.2-next.4) (2025-07-25)
94
+
95
+
96
+ ### Features
97
+
98
+ * add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
99
+
100
+
101
+ ### Dependencies
102
+
103
+ * The following workspace dependencies were updated
104
+ * dependencies
105
+ * @twin.org/engine-core bumped from 0.0.2-next.3 to 0.0.2-next.4
106
+ * @twin.org/engine-types bumped from 0.0.2-next.3 to 0.0.2-next.4
107
+
108
+ ## [0.0.2-next.3](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.2...engine-v0.0.2-next.3) (2025-07-24)
109
+
110
+
111
+ ### Features
112
+
113
+ * update includeUserIdentity usage ([d34f597](https://github.com/twinfoundation/engine/commit/d34f597a61f9645a029411d2911bbda20ddc9eb9))
114
+
115
+
116
+ ### Dependencies
117
+
118
+ * The following workspace dependencies were updated
119
+ * dependencies
120
+ * @twin.org/engine-core bumped from 0.0.2-next.2 to 0.0.2-next.3
121
+ * @twin.org/engine-types bumped from 0.0.2-next.2 to 0.0.2-next.3
122
+
123
+ ## [0.0.2-next.2](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.1...engine-v0.0.2-next.2) (2025-07-21)
124
+
125
+
126
+ ### Features
127
+
128
+ * add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
129
+
130
+
131
+ ### Dependencies
132
+
133
+ * The following workspace dependencies were updated
134
+ * dependencies
135
+ * @twin.org/engine-core bumped from 0.0.2-next.1 to 0.0.2-next.2
136
+ * @twin.org/engine-types bumped from 0.0.2-next.1 to 0.0.2-next.2
137
+
138
+ ## [0.0.2-next.1](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.0...engine-v0.0.2-next.1) (2025-07-11)
139
+
140
+
141
+ ### Features
142
+
143
+ * add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
144
+ * add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
145
+ * add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
146
+ * add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
147
+ * addCustomEntityStorage optional rest path ([55f42c5](https://github.com/twinfoundation/engine/commit/55f42c568945f010eb8883e27fb385d2c30eebff))
148
+ * gas station integration ([#17](https://github.com/twinfoundation/engine/issues/17)) ([a3f844a](https://github.com/twinfoundation/engine/commit/a3f844a7fc58c43b4d0700d8d4351062045e66e1))
149
+ * iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
150
+ * modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
151
+ * move environment variable processing to node level ([2223c12](https://github.com/twinfoundation/engine/commit/2223c12f49f3d34051ecec9687351aa5dd094e54))
152
+ * update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
153
+ * update rights management config ([d447575](https://github.com/twinfoundation/engine/commit/d447575cd5cdf3cdf1fe92087e90188ec97516f5))
154
+ * use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
155
+
156
+
157
+ ### Bug Fixes
158
+
159
+ * blob storage encryption settings ([63ee879](https://github.com/twinfoundation/engine/commit/63ee87904d2be205d8fe2fa11b536790a0d22082))
160
+
161
+
162
+ ### Dependencies
163
+
164
+ * The following workspace dependencies were updated
165
+ * dependencies
166
+ * @twin.org/engine-core bumped from 0.0.2-next.0 to 0.0.2-next.1
167
+ * @twin.org/engine-types bumped from 0.0.2-next.0 to 0.0.2-next.1
168
+
3
169
  ## 0.0.1 (2025-07-11)
4
170
 
5
171
 
@@ -47,7 +47,3 @@ The options for the engine.
47
47
  > `readonly` **CLASS\_NAME**: `string`
48
48
 
49
49
  Runtime name for the class.
50
-
51
- #### Overrides
52
-
53
- `EngineCore.CLASS_NAME`
@@ -64,17 +64,11 @@ The rest path to serve the entity storage from, leave undefined for no endpoints
64
64
 
65
65
  Additional options.
66
66
 
67
- ###### includeNodeIdentity?
67
+ ###### partitionPerUser?
68
68
 
69
69
  `boolean`
70
70
 
71
- Whether to include the node identity in the entity, defaults to true.
72
-
73
- ###### includeUserIdentity?
74
-
75
- `true`
76
-
77
- Whether to include the user identity in the entity, defaults to true.
71
+ Whether to partition the user identity in the data, defaults to false.
78
72
 
79
73
  #### Returns
80
74
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/engine",
3
- "version": "0.0.1",
3
+ "version": "0.0.2-next.10",
4
4
  "description": "Engine implementation.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,9 +15,10 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/core": "next",
18
- "@twin.org/engine-core": "0.0.1",
19
- "@twin.org/engine-types": "0.0.1",
20
- "@twin.org/entity": "next"
18
+ "@twin.org/engine-core": "0.0.2-next.10",
19
+ "@twin.org/engine-types": "0.0.2-next.10",
20
+ "@twin.org/entity": "next",
21
+ "@twin.org/nameof": "next"
21
22
  },
22
23
  "main": "./dist/cjs/index.cjs",
23
24
  "module": "./dist/esm/index.mjs",