@twin.org/entity-storage-service 0.0.3-next.1 → 0.0.3-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.
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 +188 -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,168 @@
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.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)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
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))
8
+ * entity storage enhancements ([#86](https://github.com/iotaledger/twin-entity-storage/issues/86)) ([1279af4](https://github.com/iotaledger/twin-entity-storage/commit/1279af42615c6497bb06539842cee44842dd1f75))
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.9 to 0.0.3-next.10
16
+ * devDependencies
17
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.9 to 0.0.3-next.10
18
+
19
+ ## [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)
20
+
21
+
22
+ ### Miscellaneous Chores
23
+
24
+ * **entity-storage-service:** Synchronize repo versions
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.8 to 0.0.3-next.9
32
+ * devDependencies
33
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.8 to 0.0.3-next.9
34
+
35
+ ## [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)
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.7 to 0.0.3-next.8
48
+ * devDependencies
49
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.7 to 0.0.3-next.8
50
+
51
+ ## [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)
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.6 to 0.0.3-next.7
64
+ * devDependencies
65
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.6 to 0.0.3-next.7
66
+
67
+ ## [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)
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.5 to 0.0.3-next.6
80
+ * devDependencies
81
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.5 to 0.0.3-next.6
82
+
83
+ ## [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)
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.4 to 0.0.3-next.5
96
+ * devDependencies
97
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.4 to 0.0.3-next.5
98
+
99
+ ## [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)
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.3 to 0.0.3-next.4
112
+ * devDependencies
113
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.3 to 0.0.3-next.4
114
+
115
+ ## [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)
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.2 to 0.0.3-next.3
128
+ * devDependencies
129
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.2 to 0.0.3-next.3
130
+
131
+ ## [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)
132
+
133
+
134
+ ### Bug Fixes
135
+
136
+ * api docs ([4228736](https://github.com/iotaledger/twin-entity-storage/commit/4228736ebc8be212f81b3ccc70b56991d5d95032))
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.1 to 0.0.3-next.2
144
+ * devDependencies
145
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.1 to 0.0.3-next.2
146
+
147
+ ## [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)
148
+
149
+
150
+ ### Features
151
+
152
+ * add context id features ([#55](https://github.com/iotaledger/twin-entity-storage/issues/55)) ([99c15a2](https://github.com/iotaledger/twin-entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
153
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
154
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
155
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
156
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
157
+ * synchronised storage ([#44](https://github.com/iotaledger/twin-entity-storage/issues/44)) ([94e10e2](https://github.com/iotaledger/twin-entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
158
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
159
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
160
+ * 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
161
 
18
162
 
19
163
  ### Bug Fixes
20
164
 
21
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
165
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
22
166
 
23
167
 
24
168
  ### Dependencies
@@ -29,12 +173,12 @@
29
173
  * devDependencies
30
174
  * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.0 to 0.0.3-next.1
31
175
 
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)
176
+ ## [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
177
 
34
178
 
35
179
  ### Features
36
180
 
37
- * add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
181
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
38
182
 
39
183
 
40
184
  ### Dependencies
@@ -45,7 +189,7 @@
45
189
  * devDependencies
46
190
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.9 to 0.0.2-next.10
47
191
 
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)
192
+ ## [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
193
 
50
194
 
51
195
  ### Miscellaneous Chores
@@ -61,12 +205,12 @@
61
205
  * devDependencies
62
206
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.8 to 0.0.2-next.9
63
207
 
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)
208
+ ## [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
209
 
66
210
 
67
211
  ### Features
68
212
 
69
- * eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
213
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
70
214
 
71
215
 
72
216
  ### Dependencies
@@ -77,7 +221,7 @@
77
221
  * devDependencies
78
222
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.7 to 0.0.2-next.8
79
223
 
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)
224
+ ## [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
225
 
82
226
 
83
227
  ### Miscellaneous Chores
@@ -93,12 +237,12 @@
93
237
  * devDependencies
94
238
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.6 to 0.0.2-next.7
95
239
 
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)
240
+ ## [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
241
 
98
242
 
99
243
  ### Features
100
244
 
101
- * update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
245
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
102
246
 
103
247
 
104
248
  ### Dependencies
@@ -109,7 +253,7 @@
109
253
  * devDependencies
110
254
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.5 to 0.0.2-next.6
111
255
 
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)
256
+ ## [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
257
 
114
258
 
115
259
  ### Miscellaneous Chores
@@ -125,7 +269,7 @@
125
269
  * devDependencies
126
270
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.4 to 0.0.2-next.5
127
271
 
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)
272
+ ## [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
273
 
130
274
 
131
275
  ### Miscellaneous Chores
@@ -141,7 +285,7 @@
141
285
  * devDependencies
142
286
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.3 to 0.0.2-next.4
143
287
 
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)
288
+ ## [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
289
 
146
290
 
147
291
  ### Miscellaneous Chores
@@ -157,13 +301,13 @@
157
301
  * devDependencies
158
302
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.2 to 0.0.2-next.3
159
303
 
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)
304
+ ## [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
305
 
162
306
 
163
307
  ### Features
164
308
 
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))
309
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
310
+ * synchronised storage ([#44](https://github.com/iotaledger/twin-entity-storage/issues/44)) ([94e10e2](https://github.com/iotaledger/twin-entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
167
311
 
168
312
 
169
313
  ### Dependencies
@@ -174,19 +318,19 @@
174
318
  * devDependencies
175
319
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.1 to 0.0.2-next.2
176
320
 
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)
321
+ ## [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
322
 
179
323
 
180
324
  ### Features
181
325
 
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))
326
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
327
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
328
+ * 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
329
 
186
330
 
187
331
  ### Bug Fixes
188
332
 
189
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
333
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
190
334
 
191
335
 
192
336
  ### Dependencies
@@ -202,15 +346,15 @@
202
346
 
203
347
  ### Features
204
348
 
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))
349
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
350
+ * release to production ([a309051](https://github.com/iotaledger/twin-entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
351
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
352
+ * 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
353
 
210
354
 
211
355
  ### Bug Fixes
212
356
 
213
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
357
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
214
358
 
215
359
 
216
360
  ### Dependencies
@@ -221,12 +365,12 @@
221
365
  * devDependencies
222
366
  * @twin.org/entity-storage-connector-memory bumped from ^0.0.0 to ^0.0.1
223
367
 
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)
368
+ ## [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
369
 
226
370
 
227
371
  ### Bug Fixes
228
372
 
229
- * 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))
230
374
 
231
375
 
232
376
  ### Dependencies
@@ -237,12 +381,12 @@
237
381
  * devDependencies
238
382
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.30 to 0.0.1-next.31
239
383
 
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)
384
+ ## [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
385
 
242
386
 
243
387
  ### Features
244
388
 
245
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
389
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
246
390
 
247
391
 
248
392
  ### Dependencies
@@ -253,12 +397,12 @@
253
397
  * devDependencies
254
398
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
255
399
 
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)
400
+ ## [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
401
 
258
402
 
259
403
  ### Features
260
404
 
261
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
405
+ * 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
406
 
263
407
 
264
408
  ### Dependencies
@@ -269,7 +413,7 @@
269
413
  * devDependencies
270
414
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.28 to 0.0.1-next.29
271
415
 
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)
416
+ ## [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
417
 
274
418
 
275
419
  ### Miscellaneous Chores
@@ -285,7 +429,7 @@
285
429
  * devDependencies
286
430
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.27 to 0.0.1-next.28
287
431
 
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)
432
+ ## [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
433
 
290
434
 
291
435
  ### 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
+ ```