@twin.org/entity-storage-service 0.0.3-next.1 → 0.0.3-next.11

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 (22) hide show
  1. package/README.md +2 -2
  2. package/dist/es/entityStorageRoutes.js +173 -1
  3. package/dist/es/entityStorageRoutes.js.map +1 -1
  4. package/dist/es/entityStorageService.js +35 -44
  5. package/dist/es/entityStorageService.js.map +1 -1
  6. package/dist/es/models/IEntityStorageRoutesExamples.js.map +1 -1
  7. package/dist/types/entityStorageRoutes.d.ts +33 -1
  8. package/dist/types/entityStorageService.d.ts +22 -0
  9. package/dist/types/models/IEntityStorageRoutesExamples.d.ts +8 -1
  10. package/docs/changelog.md +204 -44
  11. package/docs/examples.md +77 -1
  12. package/docs/open-api/spec.json +690 -46
  13. package/docs/reference/classes/EntityStorageService.md +94 -6
  14. package/docs/reference/functions/entityStorageCount.md +31 -0
  15. package/docs/reference/functions/entityStorageEmpty.md +31 -0
  16. package/docs/reference/functions/entityStorageRemoveBatch.md +31 -0
  17. package/docs/reference/functions/entityStorageSetBatch.md +31 -0
  18. package/docs/reference/index.md +4 -0
  19. package/docs/reference/interfaces/IEntityStorageRoutesExamples.md +24 -8
  20. package/docs/reference/interfaces/IEntityStorageServiceConstructorOptions.md +3 -3
  21. package/locales/en.json +1 -7
  22. package/package.json +5 -5
package/docs/changelog.md CHANGED
@@ -1,24 +1,184 @@
1
- # @twin.org/entity-storage-service - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.3-next.0...entity-storage-service-v0.0.3-next.1) (2025-11-10)
3
+ ## [0.0.3-next.11](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.10...entity-storage-service-v0.0.3-next.11) (2026-05-07)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **entity-storage-service:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.10 to 0.0.3-next.11
16
+ * devDependencies
17
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.10 to 0.0.3-next.11
18
+
19
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.9...entity-storage-service-v0.0.3-next.10) (2026-05-07)
20
+
21
+
22
+ ### Features
23
+
24
+ * entity storage enhancements ([#86](https://github.com/iotaledger/twin-entity-storage/issues/86)) ([1279af4](https://github.com/iotaledger/twin-entity-storage/commit/1279af42615c6497bb06539842cee44842dd1f75))
25
+
26
+
27
+ ### Dependencies
28
+
29
+ * The following workspace dependencies were updated
30
+ * dependencies
31
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.9 to 0.0.3-next.10
32
+ * devDependencies
33
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.9 to 0.0.3-next.10
34
+
35
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.8...entity-storage-service-v0.0.3-next.9) (2026-04-22)
36
+
37
+
38
+ ### Miscellaneous Chores
39
+
40
+ * **entity-storage-service:** Synchronize repo versions
41
+
42
+
43
+ ### Dependencies
44
+
45
+ * The following workspace dependencies were updated
46
+ * dependencies
47
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.8 to 0.0.3-next.9
48
+ * devDependencies
49
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.8 to 0.0.3-next.9
50
+
51
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.7...entity-storage-service-v0.0.3-next.8) (2026-03-20)
52
+
53
+
54
+ ### Miscellaneous Chores
55
+
56
+ * **entity-storage-service:** Synchronize repo versions
57
+
58
+
59
+ ### Dependencies
60
+
61
+ * The following workspace dependencies were updated
62
+ * dependencies
63
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.7 to 0.0.3-next.8
64
+ * devDependencies
65
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.7 to 0.0.3-next.8
66
+
67
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.6...entity-storage-service-v0.0.3-next.7) (2026-03-13)
68
+
69
+
70
+ ### Miscellaneous Chores
71
+
72
+ * **entity-storage-service:** Synchronize repo versions
73
+
74
+
75
+ ### Dependencies
76
+
77
+ * The following workspace dependencies were updated
78
+ * dependencies
79
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
80
+ * devDependencies
81
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.6 to 0.0.3-next.7
82
+
83
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.5...entity-storage-service-v0.0.3-next.6) (2026-01-21)
84
+
85
+
86
+ ### Miscellaneous Chores
87
+
88
+ * **entity-storage-service:** Synchronize repo versions
89
+
90
+
91
+ ### Dependencies
92
+
93
+ * The following workspace dependencies were updated
94
+ * dependencies
95
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.5 to 0.0.3-next.6
96
+ * devDependencies
97
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.5 to 0.0.3-next.6
98
+
99
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.4...entity-storage-service-v0.0.3-next.5) (2026-01-06)
100
+
101
+
102
+ ### Miscellaneous Chores
103
+
104
+ * **entity-storage-service:** Synchronize repo versions
105
+
106
+
107
+ ### Dependencies
108
+
109
+ * The following workspace dependencies were updated
110
+ * dependencies
111
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.4 to 0.0.3-next.5
112
+ * devDependencies
113
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.4 to 0.0.3-next.5
114
+
115
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.3...entity-storage-service-v0.0.3-next.4) (2025-12-03)
116
+
117
+
118
+ ### Miscellaneous Chores
119
+
120
+ * **entity-storage-service:** Synchronize repo versions
121
+
122
+
123
+ ### Dependencies
124
+
125
+ * The following workspace dependencies were updated
126
+ * dependencies
127
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.3 to 0.0.3-next.4
128
+ * devDependencies
129
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.3 to 0.0.3-next.4
130
+
131
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.2...entity-storage-service-v0.0.3-next.3) (2025-11-26)
132
+
133
+
134
+ ### Miscellaneous Chores
135
+
136
+ * **entity-storage-service:** Synchronize repo versions
137
+
138
+
139
+ ### Dependencies
140
+
141
+ * The following workspace dependencies were updated
142
+ * dependencies
143
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.2 to 0.0.3-next.3
144
+ * devDependencies
145
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.2 to 0.0.3-next.3
146
+
147
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.1...entity-storage-service-v0.0.3-next.2) (2025-11-13)
148
+
149
+
150
+ ### Bug Fixes
151
+
152
+ * api docs ([4228736](https://github.com/iotaledger/twin-entity-storage/commit/4228736ebc8be212f81b3ccc70b56991d5d95032))
153
+
154
+
155
+ ### Dependencies
156
+
157
+ * The following workspace dependencies were updated
158
+ * dependencies
159
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
160
+ * devDependencies
161
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.1 to 0.0.3-next.2
162
+
163
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.0...entity-storage-service-v0.0.3-next.1) (2025-11-10)
4
164
 
5
165
 
6
166
  ### Features
7
167
 
8
- * add context id features ([#55](https://github.com/twinfoundation/entity-storage/issues/55)) ([99c15a2](https://github.com/twinfoundation/entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
9
- * add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
10
- * add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
11
- * eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
12
- * remove includeNodeIdentity flag ([d88d1d0](https://github.com/twinfoundation/entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
13
- * synchronised storage ([#44](https://github.com/twinfoundation/entity-storage/issues/44)) ([94e10e2](https://github.com/twinfoundation/entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
14
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
15
- * update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
16
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
168
+ * add context id features ([#55](https://github.com/iotaledger/twin-entity-storage/issues/55)) ([99c15a2](https://github.com/iotaledger/twin-entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
169
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
170
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
171
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
172
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
173
+ * synchronised storage ([#44](https://github.com/iotaledger/twin-entity-storage/issues/44)) ([94e10e2](https://github.com/iotaledger/twin-entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
174
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
175
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
176
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
17
177
 
18
178
 
19
179
  ### Bug Fixes
20
180
 
21
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
181
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
22
182
 
23
183
 
24
184
  ### Dependencies
@@ -29,12 +189,12 @@
29
189
  * devDependencies
30
190
  * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.0 to 0.0.3-next.1
31
191
 
32
- ## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.9...entity-storage-service-v0.0.2-next.10) (2025-10-09)
192
+ ## [0.0.2-next.10](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.9...entity-storage-service-v0.0.2-next.10) (2025-10-09)
33
193
 
34
194
 
35
195
  ### Features
36
196
 
37
- * add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
197
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
38
198
 
39
199
 
40
200
  ### Dependencies
@@ -45,7 +205,7 @@
45
205
  * devDependencies
46
206
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.9 to 0.0.2-next.10
47
207
 
48
- ## [0.0.2-next.9](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.8...entity-storage-service-v0.0.2-next.9) (2025-10-02)
208
+ ## [0.0.2-next.9](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.8...entity-storage-service-v0.0.2-next.9) (2025-10-02)
49
209
 
50
210
 
51
211
  ### Miscellaneous Chores
@@ -61,12 +221,12 @@
61
221
  * devDependencies
62
222
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.8 to 0.0.2-next.9
63
223
 
64
- ## [0.0.2-next.8](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.7...entity-storage-service-v0.0.2-next.8) (2025-08-29)
224
+ ## [0.0.2-next.8](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.7...entity-storage-service-v0.0.2-next.8) (2025-08-29)
65
225
 
66
226
 
67
227
  ### Features
68
228
 
69
- * eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
229
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
70
230
 
71
231
 
72
232
  ### Dependencies
@@ -77,7 +237,7 @@
77
237
  * devDependencies
78
238
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.7 to 0.0.2-next.8
79
239
 
80
- ## [0.0.2-next.7](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.6...entity-storage-service-v0.0.2-next.7) (2025-08-20)
240
+ ## [0.0.2-next.7](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.6...entity-storage-service-v0.0.2-next.7) (2025-08-20)
81
241
 
82
242
 
83
243
  ### Miscellaneous Chores
@@ -93,12 +253,12 @@
93
253
  * devDependencies
94
254
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.6 to 0.0.2-next.7
95
255
 
96
- ## [0.0.2-next.6](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.5...entity-storage-service-v0.0.2-next.6) (2025-08-19)
256
+ ## [0.0.2-next.6](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.5...entity-storage-service-v0.0.2-next.6) (2025-08-19)
97
257
 
98
258
 
99
259
  ### Features
100
260
 
101
- * update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
261
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
102
262
 
103
263
 
104
264
  ### Dependencies
@@ -109,7 +269,7 @@
109
269
  * devDependencies
110
270
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.5 to 0.0.2-next.6
111
271
 
112
- ## [0.0.2-next.5](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.4...entity-storage-service-v0.0.2-next.5) (2025-08-11)
272
+ ## [0.0.2-next.5](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.4...entity-storage-service-v0.0.2-next.5) (2025-08-11)
113
273
 
114
274
 
115
275
  ### Miscellaneous Chores
@@ -125,7 +285,7 @@
125
285
  * devDependencies
126
286
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.4 to 0.0.2-next.5
127
287
 
128
- ## [0.0.2-next.4](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.3...entity-storage-service-v0.0.2-next.4) (2025-08-08)
288
+ ## [0.0.2-next.4](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.3...entity-storage-service-v0.0.2-next.4) (2025-08-08)
129
289
 
130
290
 
131
291
  ### Miscellaneous Chores
@@ -141,7 +301,7 @@
141
301
  * devDependencies
142
302
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.3 to 0.0.2-next.4
143
303
 
144
- ## [0.0.2-next.3](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.2...entity-storage-service-v0.0.2-next.3) (2025-07-25)
304
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.2...entity-storage-service-v0.0.2-next.3) (2025-07-25)
145
305
 
146
306
 
147
307
  ### Miscellaneous Chores
@@ -157,13 +317,13 @@
157
317
  * devDependencies
158
318
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.2 to 0.0.2-next.3
159
319
 
160
- ## [0.0.2-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.1...entity-storage-service-v0.0.2-next.2) (2025-07-24)
320
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.1...entity-storage-service-v0.0.2-next.2) (2025-07-24)
161
321
 
162
322
 
163
323
  ### Features
164
324
 
165
- * remove includeNodeIdentity flag ([d88d1d0](https://github.com/twinfoundation/entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
166
- * synchronised storage ([#44](https://github.com/twinfoundation/entity-storage/issues/44)) ([94e10e2](https://github.com/twinfoundation/entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
325
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
326
+ * synchronised storage ([#44](https://github.com/iotaledger/twin-entity-storage/issues/44)) ([94e10e2](https://github.com/iotaledger/twin-entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
167
327
 
168
328
 
169
329
  ### Dependencies
@@ -174,19 +334,19 @@
174
334
  * devDependencies
175
335
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.1 to 0.0.2-next.2
176
336
 
177
- ## [0.0.2-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.2-next.0...entity-storage-service-v0.0.2-next.1) (2025-07-17)
337
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.2-next.0...entity-storage-service-v0.0.2-next.1) (2025-07-17)
178
338
 
179
339
 
180
340
  ### Features
181
341
 
182
- * add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
183
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
184
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
342
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
343
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
344
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
185
345
 
186
346
 
187
347
  ### Bug Fixes
188
348
 
189
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
349
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
190
350
 
191
351
 
192
352
  ### Dependencies
@@ -202,15 +362,15 @@
202
362
 
203
363
  ### Features
204
364
 
205
- * add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
206
- * release to production ([a309051](https://github.com/twinfoundation/entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
207
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
208
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
365
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
366
+ * release to production ([a309051](https://github.com/iotaledger/twin-entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
367
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
368
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
209
369
 
210
370
 
211
371
  ### Bug Fixes
212
372
 
213
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
373
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
214
374
 
215
375
 
216
376
  ### Dependencies
@@ -221,12 +381,12 @@
221
381
  * devDependencies
222
382
  * @twin.org/entity-storage-connector-memory bumped from ^0.0.0 to ^0.0.1
223
383
 
224
- ## [0.0.1-next.31](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.1-next.30...entity-storage-service-v0.0.1-next.31) (2025-06-20)
384
+ ## [0.0.1-next.31](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.1-next.30...entity-storage-service-v0.0.1-next.31) (2025-06-20)
225
385
 
226
386
 
227
387
  ### Bug Fixes
228
388
 
229
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
389
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
230
390
 
231
391
 
232
392
  ### Dependencies
@@ -237,12 +397,12 @@
237
397
  * devDependencies
238
398
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.30 to 0.0.1-next.31
239
399
 
240
- ## [0.0.1-next.30](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.1-next.29...entity-storage-service-v0.0.1-next.30) (2025-06-12)
400
+ ## [0.0.1-next.30](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.1-next.29...entity-storage-service-v0.0.1-next.30) (2025-06-12)
241
401
 
242
402
 
243
403
  ### Features
244
404
 
245
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
405
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
246
406
 
247
407
 
248
408
  ### Dependencies
@@ -253,12 +413,12 @@
253
413
  * devDependencies
254
414
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
255
415
 
256
- ## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.1-next.28...entity-storage-service-v0.0.1-next.29) (2025-04-17)
416
+ ## [0.0.1-next.29](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.1-next.28...entity-storage-service-v0.0.1-next.29) (2025-04-17)
257
417
 
258
418
 
259
419
  ### Features
260
420
 
261
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
421
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
262
422
 
263
423
 
264
424
  ### Dependencies
@@ -269,7 +429,7 @@
269
429
  * devDependencies
270
430
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.28 to 0.0.1-next.29
271
431
 
272
- ## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.1-next.27...entity-storage-service-v0.0.1-next.28) (2025-04-09)
432
+ ## [0.0.1-next.28](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.1-next.27...entity-storage-service-v0.0.1-next.28) (2025-04-09)
273
433
 
274
434
 
275
435
  ### Miscellaneous Chores
@@ -285,7 +445,7 @@
285
445
  * devDependencies
286
446
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.27 to 0.0.1-next.28
287
447
 
288
- ## [0.0.1-next.27](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.1-next.26...entity-storage-service-v0.0.1-next.27) (2025-03-28)
448
+ ## [0.0.1-next.27](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.1-next.26...entity-storage-service-v0.0.1-next.27) (2025-03-28)
289
449
 
290
450
 
291
451
  ### Miscellaneous Chores
package/docs/examples.md CHANGED
@@ -1 +1,77 @@
1
- # @twin.org/entity-storage-service - Examples
1
+ # Entity Storage Service Examples
2
+
3
+ Use these snippets to wire a registered connector into the service layer and to expose matching REST routes.
4
+
5
+ ## EntityStorageService
6
+
7
+ ```typescript
8
+ import {
9
+ EntityStorageService,
10
+ generateRestRoutesEntityStorage
11
+ } from '@twin.org/entity-storage-service';
12
+ import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
13
+ import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
14
+ import {
15
+ ComparisonOperator,
16
+ LogicalOperator,
17
+ SortDirection,
18
+ type EntityCondition
19
+ } from '@twin.org/entity';
20
+
21
+ interface Profile {
22
+ id: string;
23
+ email: string;
24
+ status: 'active' | 'inactive';
25
+ createdAt: string;
26
+ }
27
+
28
+ EntityStorageConnectorFactory.register(
29
+ 'profile-storage',
30
+ () =>
31
+ new MemoryEntityStorageConnector<Profile>({
32
+ entitySchema: 'Profile'
33
+ })
34
+ );
35
+
36
+ const service = new EntityStorageService<Profile>({
37
+ entityStorageType: 'profile-storage'
38
+ });
39
+
40
+ const className = service.className();
41
+
42
+ await service.set({
43
+ id: 'profile-1',
44
+ email: 'ada@example.com',
45
+ status: 'active',
46
+ createdAt: '2026-03-09T10:30:00.000Z'
47
+ });
48
+
49
+ const byPrimaryKey = await service.get('profile-1');
50
+ const bySecondaryIndex = await service.get('ada@example.com', 'email');
51
+
52
+ const activeCondition: EntityCondition<Profile> = {
53
+ logicalOperator: LogicalOperator.And,
54
+ conditions: [
55
+ {
56
+ property: 'status',
57
+ comparison: ComparisonOperator.Equals,
58
+ value: 'active'
59
+ }
60
+ ]
61
+ };
62
+
63
+ const result = await service.query(
64
+ activeCondition,
65
+ 'createdAt',
66
+ SortDirection.Descending,
67
+ ['id', 'email', 'status'],
68
+ undefined,
69
+ 25
70
+ );
71
+
72
+ await service.remove('profile-1');
73
+
74
+ const routes = generateRestRoutesEntityStorage('/profiles', 'profileStorageComponent', {
75
+ typeName: 'Profile'
76
+ });
77
+ ```