@twin.org/entity-storage-models 0.0.3-next.3 → 0.0.3-next.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/README.md +2 -2
  2. package/dist/es/factories/schemaMigrationFactory.js +17 -0
  3. package/dist/es/factories/schemaMigrationFactory.js.map +1 -0
  4. package/dist/es/helpers/entityStorageHelper.js +126 -0
  5. package/dist/es/helpers/entityStorageHelper.js.map +1 -0
  6. package/dist/es/helpers/migrationHelper.js +232 -0
  7. package/dist/es/helpers/migrationHelper.js.map +1 -0
  8. package/dist/es/index.js +14 -1
  9. package/dist/es/index.js.map +1 -1
  10. package/dist/es/models/IEntityStorageComponent.js.map +1 -1
  11. package/dist/es/models/IEntityStorageConnector.js.map +1 -1
  12. package/dist/es/models/IEntityStorageMigrationConnector.js +2 -0
  13. package/dist/es/models/IEntityStorageMigrationConnector.js.map +1 -0
  14. package/dist/es/models/IMigrationOptions.js +4 -0
  15. package/dist/es/models/IMigrationOptions.js.map +1 -0
  16. package/dist/es/models/IResolvedMigrationStep.js +2 -0
  17. package/dist/es/models/IResolvedMigrationStep.js.map +1 -0
  18. package/dist/es/models/ISchemaMigration.js +2 -0
  19. package/dist/es/models/ISchemaMigration.js.map +1 -0
  20. package/dist/es/models/api/IEntityStorageCountRequest.js +4 -0
  21. package/dist/es/models/api/IEntityStorageCountRequest.js.map +1 -0
  22. package/dist/es/models/api/IEntityStorageCountResponse.js +4 -0
  23. package/dist/es/models/api/IEntityStorageCountResponse.js.map +1 -0
  24. package/dist/es/models/api/IEntityStorageEmptyRequest.js +4 -0
  25. package/dist/es/models/api/IEntityStorageEmptyRequest.js.map +1 -0
  26. package/dist/es/models/api/IEntityStorageGetRequest.js.map +1 -1
  27. package/dist/es/models/api/IEntityStorageRemoveBatchRequest.js +4 -0
  28. package/dist/es/models/api/IEntityStorageRemoveBatchRequest.js.map +1 -0
  29. package/dist/es/models/api/IEntityStorageRemoveRequest.js.map +1 -1
  30. package/dist/es/models/api/IEntityStorageSetBatchRequest.js +4 -0
  31. package/dist/es/models/api/IEntityStorageSetBatchRequest.js.map +1 -0
  32. package/dist/es/models/api/IEntityStorageSetRequest.js.map +1 -1
  33. package/dist/es/models/entityPropertyTransformer.js +2 -0
  34. package/dist/es/models/entityPropertyTransformer.js.map +1 -0
  35. package/dist/types/factories/schemaMigrationFactory.d.ts +14 -0
  36. package/dist/types/helpers/entityStorageHelper.d.ts +59 -0
  37. package/dist/types/helpers/migrationHelper.d.ts +65 -0
  38. package/dist/types/index.d.ts +13 -0
  39. package/dist/types/models/IEntityStorageComponent.d.ts +38 -3
  40. package/dist/types/models/IEntityStorageConnector.d.ts +23 -0
  41. package/dist/types/models/IEntityStorageMigrationConnector.d.ts +35 -0
  42. package/dist/types/models/IMigrationOptions.d.ts +17 -0
  43. package/dist/types/models/IResolvedMigrationStep.d.ts +38 -0
  44. package/dist/types/models/ISchemaMigration.d.ts +30 -0
  45. package/dist/types/models/api/IEntityStorageCountRequest.d.ts +14 -0
  46. package/dist/types/models/api/IEntityStorageCountResponse.d.ts +14 -0
  47. package/dist/types/models/api/IEntityStorageEmptyRequest.d.ts +5 -0
  48. package/dist/types/models/api/IEntityStorageGetRequest.d.ts +4 -0
  49. package/dist/types/models/api/IEntityStorageRemoveBatchRequest.d.ts +9 -0
  50. package/dist/types/models/api/IEntityStorageRemoveRequest.d.ts +9 -0
  51. package/dist/types/models/api/IEntityStorageSetBatchRequest.d.ts +9 -0
  52. package/dist/types/models/api/IEntityStorageSetRequest.d.ts +9 -0
  53. package/dist/types/models/entityPropertyTransformer.d.ts +6 -0
  54. package/docs/changelog.md +308 -44
  55. package/docs/examples.md +87 -1
  56. package/docs/reference/classes/EntityStorageHelper.md +209 -0
  57. package/docs/reference/classes/MigrationHelper.md +198 -0
  58. package/docs/reference/index.md +19 -0
  59. package/docs/reference/interfaces/IEntityStorageComponent.md +105 -7
  60. package/docs/reference/interfaces/IEntityStorageConnector.md +89 -5
  61. package/docs/reference/interfaces/IEntityStorageCountRequest.md +17 -0
  62. package/docs/reference/interfaces/IEntityStorageCountResponse.md +17 -0
  63. package/docs/reference/interfaces/IEntityStorageEmptyRequest.md +3 -0
  64. package/docs/reference/interfaces/IEntityStorageGetRequest.md +10 -4
  65. package/docs/reference/interfaces/IEntityStorageGetResponse.md +1 -1
  66. package/docs/reference/interfaces/IEntityStorageListRequest.md +8 -8
  67. package/docs/reference/interfaces/IEntityStorageListResponse.md +2 -2
  68. package/docs/reference/interfaces/IEntityStorageMigrationConnector.md +402 -0
  69. package/docs/reference/interfaces/IEntityStorageRemoveBatchRequest.md +11 -0
  70. package/docs/reference/interfaces/IEntityStorageRemoveRequest.md +15 -1
  71. package/docs/reference/interfaces/IEntityStorageSetBatchRequest.md +11 -0
  72. package/docs/reference/interfaces/IEntityStorageSetRequest.md +15 -1
  73. package/docs/reference/interfaces/IMigrationOptions.md +49 -0
  74. package/docs/reference/interfaces/IResolvedMigrationStep.md +78 -0
  75. package/docs/reference/interfaces/ISchemaMigration.md +62 -0
  76. package/docs/reference/type-aliases/EntityPropertyTransformer.md +34 -0
  77. package/docs/reference/variables/SchemaMigrationFactory.md +13 -0
  78. package/locales/en.json +18 -1
  79. package/package.json +6 -4
package/docs/changelog.md CHANGED
@@ -1,159 +1,423 @@
1
- # @twin.org/entity-storage-models - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.3](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.3-next.2...entity-storage-models-v0.0.3-next.3) (2025-11-26)
3
+ ## [0.0.3-next.30](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.29...entity-storage-models-v0.0.3-next.30) (2026-06-15)
4
+
5
+
6
+ ### Features
7
+
8
+ * add context id features ([#55](https://github.com/iotaledger/twin-entity-storage/issues/55)) ([99c15a2](https://github.com/iotaledger/twin-entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
9
+ * add ISchemaMigration chain, SchemaVersionMigrator runner and version store ([#110](https://github.com/iotaledger/twin-entity-storage/issues/110)) ([2dac924](https://github.com/iotaledger/twin-entity-storage/commit/2dac9244a752cb58304d1649ff03c3a2469783dd))
10
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
11
+ * add SchemaVersionService for automatic schema migrations ([#118](https://github.com/iotaledger/twin-entity-storage/issues/118)) ([b2ad843](https://github.com/iotaledger/twin-entity-storage/commit/b2ad8435185c53304aca99eb4d98582009b3902d))
12
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
13
+ * adding schema migration functionality to all the connectors ([#85](https://github.com/iotaledger/twin-entity-storage/issues/85)) ([fd1555a](https://github.com/iotaledger/twin-entity-storage/commit/fd1555a34380158214a577586dafae821e72a578))
14
+ * entity storage conditions ([#115](https://github.com/iotaledger/twin-entity-storage/issues/115)) ([7a53884](https://github.com/iotaledger/twin-entity-storage/commit/7a53884f6acb856d77733e4e0f23ec1c00b74cb4))
15
+ * entity storage enhancements ([#86](https://github.com/iotaledger/twin-entity-storage/issues/86)) ([1279af4](https://github.com/iotaledger/twin-entity-storage/commit/1279af42615c6497bb06539842cee44842dd1f75))
16
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
17
+ * migration progress ([#121](https://github.com/iotaledger/twin-entity-storage/issues/121)) ([d032162](https://github.com/iotaledger/twin-entity-storage/commit/d032162768b6b7d4ccca7e39b80f8bc3ba46440e))
18
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
19
+ * typescript 6 update ([995a0c6](https://github.com/iotaledger/twin-entity-storage/commit/995a0c6fa9a6813bfdc7200779ce3664236e59e9))
20
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
21
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
22
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
23
+
24
+
25
+ ### Bug Fixes
26
+
27
+ * docs ([1a30170](https://github.com/iotaledger/twin-entity-storage/commit/1a301707ee0cb48314223347a6e9f3b3a3a7362d))
28
+ * null secondary indexes ([#103](https://github.com/iotaledger/twin-entity-storage/issues/103)) ([5e44f11](https://github.com/iotaledger/twin-entity-storage/commit/5e44f11bb5af5bf2c27d6f1d56aba5851116ff89))
29
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
30
+ * route GSI sort-key conditions to KeyConditionExpression and cross-connector cursor-walk tests ([#127](https://github.com/iotaledger/twin-entity-storage/issues/127)) ([6a24e1b](https://github.com/iotaledger/twin-entity-storage/commit/6a24e1b5f3b8b426987e43da3af6766d8cb68afb))
31
+
32
+ ## [0.0.3-next.29](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.28...entity-storage-models-v0.0.3-next.29) (2026-06-15)
33
+
34
+
35
+ ### Miscellaneous Chores
36
+
37
+ * **entity-storage-models:** Synchronize repo versions
38
+
39
+ ## [0.0.3-next.28](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.27...entity-storage-models-v0.0.3-next.28) (2026-06-12)
40
+
41
+
42
+ ### Miscellaneous Chores
43
+
44
+ * **entity-storage-models:** Synchronize repo versions
45
+
46
+ ## [0.0.3-next.27](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.26...entity-storage-models-v0.0.3-next.27) (2026-06-11)
47
+
48
+
49
+ ### Bug Fixes
50
+
51
+ * route GSI sort-key conditions to KeyConditionExpression and cross-connector cursor-walk tests ([#127](https://github.com/iotaledger/twin-entity-storage/issues/127)) ([6a24e1b](https://github.com/iotaledger/twin-entity-storage/commit/6a24e1b5f3b8b426987e43da3af6766d8cb68afb))
52
+
53
+ ## [0.0.3-next.26](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.25...entity-storage-models-v0.0.3-next.26) (2026-06-11)
54
+
55
+
56
+ ### Miscellaneous Chores
57
+
58
+ * **entity-storage-models:** Synchronize repo versions
59
+
60
+ ## [0.0.3-next.25](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.24...entity-storage-models-v0.0.3-next.25) (2026-06-09)
61
+
62
+
63
+ ### Features
64
+
65
+ * migration progress ([#121](https://github.com/iotaledger/twin-entity-storage/issues/121)) ([d032162](https://github.com/iotaledger/twin-entity-storage/commit/d032162768b6b7d4ccca7e39b80f8bc3ba46440e))
66
+
67
+ ## [0.0.3-next.24](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.23...entity-storage-models-v0.0.3-next.24) (2026-06-08)
68
+
69
+
70
+ ### Features
71
+
72
+ * add SchemaVersionService for automatic schema migrations ([#118](https://github.com/iotaledger/twin-entity-storage/issues/118)) ([b2ad843](https://github.com/iotaledger/twin-entity-storage/commit/b2ad8435185c53304aca99eb4d98582009b3902d))
73
+
74
+
75
+ ### Bug Fixes
76
+
77
+ * docs ([1a30170](https://github.com/iotaledger/twin-entity-storage/commit/1a301707ee0cb48314223347a6e9f3b3a3a7362d))
78
+
79
+ ## [0.0.3-next.23](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.22...entity-storage-models-v0.0.3-next.23) (2026-06-08)
80
+
81
+
82
+ ### Features
83
+
84
+ * entity storage conditions ([#115](https://github.com/iotaledger/twin-entity-storage/issues/115)) ([7a53884](https://github.com/iotaledger/twin-entity-storage/commit/7a53884f6acb856d77733e4e0f23ec1c00b74cb4))
85
+
86
+ ## [0.0.3-next.22](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.21...entity-storage-models-v0.0.3-next.22) (2026-06-08)
87
+
88
+
89
+ ### Features
90
+
91
+ * add ISchemaMigration chain, SchemaVersionMigrator runner and version store ([#110](https://github.com/iotaledger/twin-entity-storage/issues/110)) ([2dac924](https://github.com/iotaledger/twin-entity-storage/commit/2dac9244a752cb58304d1649ff03c3a2469783dd))
92
+
93
+ ## [0.0.3-next.21](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.20...entity-storage-models-v0.0.3-next.21) (2026-06-01)
94
+
95
+
96
+ ### Miscellaneous Chores
97
+
98
+ * **entity-storage-models:** Synchronize repo versions
99
+
100
+ ## [0.0.3-next.20](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.19...entity-storage-models-v0.0.3-next.20) (2026-06-01)
101
+
102
+
103
+ ### Features
104
+
105
+ * add context id features ([#55](https://github.com/iotaledger/twin-entity-storage/issues/55)) ([99c15a2](https://github.com/iotaledger/twin-entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
106
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
107
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
108
+ * adding schema migration functionality to all the connectors ([#85](https://github.com/iotaledger/twin-entity-storage/issues/85)) ([fd1555a](https://github.com/iotaledger/twin-entity-storage/commit/fd1555a34380158214a577586dafae821e72a578))
109
+ * entity storage enhancements ([#86](https://github.com/iotaledger/twin-entity-storage/issues/86)) ([1279af4](https://github.com/iotaledger/twin-entity-storage/commit/1279af42615c6497bb06539842cee44842dd1f75))
110
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
111
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
112
+ * typescript 6 update ([995a0c6](https://github.com/iotaledger/twin-entity-storage/commit/995a0c6fa9a6813bfdc7200779ce3664236e59e9))
113
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
114
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
115
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
116
+
117
+
118
+ ### Bug Fixes
119
+
120
+ * null secondary indexes ([#103](https://github.com/iotaledger/twin-entity-storage/issues/103)) ([5e44f11](https://github.com/iotaledger/twin-entity-storage/commit/5e44f11bb5af5bf2c27d6f1d56aba5851116ff89))
121
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
122
+
123
+ ## [0.0.3-next.19](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.18...entity-storage-models-v0.0.3-next.19) (2026-06-01)
124
+
125
+
126
+ ### Features
127
+
128
+ * add context id features ([#55](https://github.com/iotaledger/twin-entity-storage/issues/55)) ([99c15a2](https://github.com/iotaledger/twin-entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
129
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
130
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
131
+ * adding schema migration functionality to all the connectors ([#85](https://github.com/iotaledger/twin-entity-storage/issues/85)) ([fd1555a](https://github.com/iotaledger/twin-entity-storage/commit/fd1555a34380158214a577586dafae821e72a578))
132
+ * entity storage enhancements ([#86](https://github.com/iotaledger/twin-entity-storage/issues/86)) ([1279af4](https://github.com/iotaledger/twin-entity-storage/commit/1279af42615c6497bb06539842cee44842dd1f75))
133
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
134
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
135
+ * typescript 6 update ([995a0c6](https://github.com/iotaledger/twin-entity-storage/commit/995a0c6fa9a6813bfdc7200779ce3664236e59e9))
136
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
137
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
138
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
139
+
140
+
141
+ ### Bug Fixes
142
+
143
+ * null secondary indexes ([#103](https://github.com/iotaledger/twin-entity-storage/issues/103)) ([5e44f11](https://github.com/iotaledger/twin-entity-storage/commit/5e44f11bb5af5bf2c27d6f1d56aba5851116ff89))
144
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
145
+
146
+ ## [0.0.3-next.18](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.17...entity-storage-models-v0.0.3-next.18) (2026-06-01)
147
+
148
+
149
+ ### Features
150
+
151
+ * add context id features ([#55](https://github.com/iotaledger/twin-entity-storage/issues/55)) ([99c15a2](https://github.com/iotaledger/twin-entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
152
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
153
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
154
+ * adding schema migration functionality to all the connectors ([#85](https://github.com/iotaledger/twin-entity-storage/issues/85)) ([fd1555a](https://github.com/iotaledger/twin-entity-storage/commit/fd1555a34380158214a577586dafae821e72a578))
155
+ * entity storage enhancements ([#86](https://github.com/iotaledger/twin-entity-storage/issues/86)) ([1279af4](https://github.com/iotaledger/twin-entity-storage/commit/1279af42615c6497bb06539842cee44842dd1f75))
156
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
157
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
158
+ * typescript 6 update ([995a0c6](https://github.com/iotaledger/twin-entity-storage/commit/995a0c6fa9a6813bfdc7200779ce3664236e59e9))
159
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
160
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
161
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
162
+
163
+
164
+ ### Bug Fixes
165
+
166
+ * null secondary indexes ([#103](https://github.com/iotaledger/twin-entity-storage/issues/103)) ([5e44f11](https://github.com/iotaledger/twin-entity-storage/commit/5e44f11bb5af5bf2c27d6f1d56aba5851116ff89))
167
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
168
+
169
+ ## [0.0.3-next.17](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.16...entity-storage-models-v0.0.3-next.17) (2026-06-01)
170
+
171
+
172
+ ### Bug Fixes
173
+
174
+ * null secondary indexes ([#103](https://github.com/iotaledger/twin-entity-storage/issues/103)) ([5e44f11](https://github.com/iotaledger/twin-entity-storage/commit/5e44f11bb5af5bf2c27d6f1d56aba5851116ff89))
175
+
176
+ ## [0.0.3-next.16](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.15...entity-storage-models-v0.0.3-next.16) (2026-05-20)
177
+
178
+
179
+ ### Miscellaneous Chores
180
+
181
+ * **entity-storage-models:** Synchronize repo versions
182
+
183
+ ## [0.0.3-next.15](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.14...entity-storage-models-v0.0.3-next.15) (2026-05-19)
184
+
185
+
186
+ ### Miscellaneous Chores
187
+
188
+ * **entity-storage-models:** Synchronize repo versions
189
+
190
+ ## [0.0.3-next.14](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.13...entity-storage-models-v0.0.3-next.14) (2026-05-19)
191
+
192
+
193
+ ### Features
194
+
195
+ * adding schema migration functionality to all the connectors ([#85](https://github.com/iotaledger/twin-entity-storage/issues/85)) ([fd1555a](https://github.com/iotaledger/twin-entity-storage/commit/fd1555a34380158214a577586dafae821e72a578))
196
+
197
+ ## [0.0.3-next.13](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.12...entity-storage-models-v0.0.3-next.13) (2026-05-13)
198
+
199
+
200
+ ### Miscellaneous Chores
201
+
202
+ * **entity-storage-models:** Synchronize repo versions
203
+
204
+ ## [0.0.3-next.12](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.11...entity-storage-models-v0.0.3-next.12) (2026-05-11)
205
+
206
+
207
+ ### Features
208
+
209
+ * typescript 6 update ([995a0c6](https://github.com/iotaledger/twin-entity-storage/commit/995a0c6fa9a6813bfdc7200779ce3664236e59e9))
210
+
211
+ ## [0.0.3-next.11](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.10...entity-storage-models-v0.0.3-next.11) (2026-05-07)
212
+
213
+
214
+ ### Miscellaneous Chores
215
+
216
+ * **entity-storage-models:** Synchronize repo versions
217
+
218
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.9...entity-storage-models-v0.0.3-next.10) (2026-05-07)
219
+
220
+
221
+ ### Features
222
+
223
+ * entity storage enhancements ([#86](https://github.com/iotaledger/twin-entity-storage/issues/86)) ([1279af4](https://github.com/iotaledger/twin-entity-storage/commit/1279af42615c6497bb06539842cee44842dd1f75))
224
+
225
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.8...entity-storage-models-v0.0.3-next.9) (2026-04-22)
226
+
227
+
228
+ ### Miscellaneous Chores
229
+
230
+ * **entity-storage-models:** Synchronize repo versions
231
+
232
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.7...entity-storage-models-v0.0.3-next.8) (2026-03-20)
233
+
234
+
235
+ ### Miscellaneous Chores
236
+
237
+ * **entity-storage-models:** Synchronize repo versions
238
+
239
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.6...entity-storage-models-v0.0.3-next.7) (2026-03-13)
240
+
241
+
242
+ ### Miscellaneous Chores
243
+
244
+ * **entity-storage-models:** Synchronize repo versions
245
+
246
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.5...entity-storage-models-v0.0.3-next.6) (2026-01-21)
247
+
248
+
249
+ ### Miscellaneous Chores
250
+
251
+ * **entity-storage-models:** Synchronize repo versions
252
+
253
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.4...entity-storage-models-v0.0.3-next.5) (2026-01-06)
254
+
255
+
256
+ ### Miscellaneous Chores
257
+
258
+ * **entity-storage-models:** Synchronize repo versions
259
+
260
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.3...entity-storage-models-v0.0.3-next.4) (2025-12-03)
261
+
262
+
263
+ ### Miscellaneous Chores
264
+
265
+ * **entity-storage-models:** Synchronize repo versions
266
+
267
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.2...entity-storage-models-v0.0.3-next.3) (2025-11-26)
4
268
 
5
269
 
6
270
  ### Miscellaneous Chores
7
271
 
8
272
  * **entity-storage-models:** Synchronize repo versions
9
273
 
10
- ## [0.0.3-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.3-next.1...entity-storage-models-v0.0.3-next.2) (2025-11-13)
274
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.1...entity-storage-models-v0.0.3-next.2) (2025-11-13)
11
275
 
12
276
 
13
277
  ### Miscellaneous Chores
14
278
 
15
279
  * **entity-storage-models:** Synchronize repo versions
16
280
 
17
- ## [0.0.3-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.3-next.0...entity-storage-models-v0.0.3-next.1) (2025-11-10)
281
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.3-next.0...entity-storage-models-v0.0.3-next.1) (2025-11-10)
18
282
 
19
283
 
20
284
  ### Features
21
285
 
22
- * add context id features ([#55](https://github.com/twinfoundation/entity-storage/issues/55)) ([99c15a2](https://github.com/twinfoundation/entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
23
- * add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
24
- * add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
25
- * eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
26
- * remove includeNodeIdentity flag ([d88d1d0](https://github.com/twinfoundation/entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
27
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
28
- * update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
29
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
286
+ * add context id features ([#55](https://github.com/iotaledger/twin-entity-storage/issues/55)) ([99c15a2](https://github.com/iotaledger/twin-entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
287
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
288
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
289
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
290
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
291
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
292
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
293
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
30
294
 
31
295
 
32
296
  ### Bug Fixes
33
297
 
34
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
298
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
35
299
 
36
- ## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.9...entity-storage-models-v0.0.2-next.10) (2025-10-09)
300
+ ## [0.0.2-next.10](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.9...entity-storage-models-v0.0.2-next.10) (2025-10-09)
37
301
 
38
302
 
39
303
  ### Features
40
304
 
41
- * add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
305
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
42
306
 
43
- ## [0.0.2-next.9](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.8...entity-storage-models-v0.0.2-next.9) (2025-10-02)
307
+ ## [0.0.2-next.9](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.8...entity-storage-models-v0.0.2-next.9) (2025-10-02)
44
308
 
45
309
 
46
310
  ### Miscellaneous Chores
47
311
 
48
312
  * **entity-storage-models:** Synchronize repo versions
49
313
 
50
- ## [0.0.2-next.8](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.7...entity-storage-models-v0.0.2-next.8) (2025-08-29)
314
+ ## [0.0.2-next.8](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.7...entity-storage-models-v0.0.2-next.8) (2025-08-29)
51
315
 
52
316
 
53
317
  ### Features
54
318
 
55
- * eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
319
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
56
320
 
57
- ## [0.0.2-next.7](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.6...entity-storage-models-v0.0.2-next.7) (2025-08-20)
321
+ ## [0.0.2-next.7](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.6...entity-storage-models-v0.0.2-next.7) (2025-08-20)
58
322
 
59
323
 
60
324
  ### Miscellaneous Chores
61
325
 
62
326
  * **entity-storage-models:** Synchronize repo versions
63
327
 
64
- ## [0.0.2-next.6](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.5...entity-storage-models-v0.0.2-next.6) (2025-08-19)
328
+ ## [0.0.2-next.6](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.5...entity-storage-models-v0.0.2-next.6) (2025-08-19)
65
329
 
66
330
 
67
331
  ### Features
68
332
 
69
- * update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
333
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
70
334
 
71
- ## [0.0.2-next.5](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.4...entity-storage-models-v0.0.2-next.5) (2025-08-11)
335
+ ## [0.0.2-next.5](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.4...entity-storage-models-v0.0.2-next.5) (2025-08-11)
72
336
 
73
337
 
74
338
  ### Miscellaneous Chores
75
339
 
76
340
  * **entity-storage-models:** Synchronize repo versions
77
341
 
78
- ## [0.0.2-next.4](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.3...entity-storage-models-v0.0.2-next.4) (2025-08-08)
342
+ ## [0.0.2-next.4](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.3...entity-storage-models-v0.0.2-next.4) (2025-08-08)
79
343
 
80
344
 
81
345
  ### Miscellaneous Chores
82
346
 
83
347
  * **entity-storage-models:** Synchronize repo versions
84
348
 
85
- ## [0.0.2-next.3](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.2...entity-storage-models-v0.0.2-next.3) (2025-07-25)
349
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.2...entity-storage-models-v0.0.2-next.3) (2025-07-25)
86
350
 
87
351
 
88
352
  ### Miscellaneous Chores
89
353
 
90
354
  * **entity-storage-models:** Synchronize repo versions
91
355
 
92
- ## [0.0.2-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.1...entity-storage-models-v0.0.2-next.2) (2025-07-24)
356
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.1...entity-storage-models-v0.0.2-next.2) (2025-07-24)
93
357
 
94
358
 
95
359
  ### Features
96
360
 
97
- * remove includeNodeIdentity flag ([d88d1d0](https://github.com/twinfoundation/entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
361
+ * remove includeNodeIdentity flag ([d88d1d0](https://github.com/iotaledger/twin-entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
98
362
 
99
- ## [0.0.2-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.0...entity-storage-models-v0.0.2-next.1) (2025-07-17)
363
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.2-next.0...entity-storage-models-v0.0.2-next.1) (2025-07-17)
100
364
 
101
365
 
102
366
  ### Features
103
367
 
104
- * add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
105
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
106
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
368
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
369
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
370
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
107
371
 
108
372
 
109
373
  ### Bug Fixes
110
374
 
111
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
375
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
112
376
 
113
377
  ## 0.0.1 (2025-07-04)
114
378
 
115
379
 
116
380
  ### Features
117
381
 
118
- * add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
119
- * release to production ([a309051](https://github.com/twinfoundation/entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
120
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
121
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
382
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
383
+ * release to production ([a309051](https://github.com/iotaledger/twin-entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
384
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
385
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
122
386
 
123
387
 
124
388
  ### Bug Fixes
125
389
 
126
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
390
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
127
391
 
128
- ## [0.0.1-next.31](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.1-next.30...entity-storage-models-v0.0.1-next.31) (2025-06-20)
392
+ ## [0.0.1-next.31](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.1-next.30...entity-storage-models-v0.0.1-next.31) (2025-06-20)
129
393
 
130
394
 
131
395
  ### Bug Fixes
132
396
 
133
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
397
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
134
398
 
135
- ## [0.0.1-next.30](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.1-next.29...entity-storage-models-v0.0.1-next.30) (2025-06-12)
399
+ ## [0.0.1-next.30](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.1-next.29...entity-storage-models-v0.0.1-next.30) (2025-06-12)
136
400
 
137
401
 
138
402
  ### Features
139
403
 
140
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
404
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
141
405
 
142
- ## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.1-next.28...entity-storage-models-v0.0.1-next.29) (2025-04-17)
406
+ ## [0.0.1-next.29](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.1-next.28...entity-storage-models-v0.0.1-next.29) (2025-04-17)
143
407
 
144
408
 
145
409
  ### Features
146
410
 
147
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
411
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
148
412
 
149
- ## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.1-next.27...entity-storage-models-v0.0.1-next.28) (2025-04-09)
413
+ ## [0.0.1-next.28](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.1-next.27...entity-storage-models-v0.0.1-next.28) (2025-04-09)
150
414
 
151
415
 
152
416
  ### Miscellaneous Chores
153
417
 
154
418
  * **entity-storage-models:** Synchronize repo versions
155
419
 
156
- ## [0.0.1-next.27](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.1-next.26...entity-storage-models-v0.0.1-next.27) (2025-03-28)
420
+ ## [0.0.1-next.27](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-models-v0.0.1-next.26...entity-storage-models-v0.0.1-next.27) (2025-03-28)
157
421
 
158
422
 
159
423
  ### Miscellaneous Chores
package/docs/examples.md CHANGED
@@ -1 +1,87 @@
1
- # @twin.org/entity-storage-models - Examples
1
+ # Entity Storage Models Examples
2
+
3
+ These examples focus on wiring connectors through the shared factory and shaping typed API request and response contracts.
4
+
5
+ ## EntityStorageConnectorFactory
6
+
7
+ ```typescript
8
+ import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
9
+ import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
10
+
11
+ interface Profile {
12
+ id: string;
13
+ email: string;
14
+ status: 'active' | 'inactive';
15
+ createdAt: string;
16
+ }
17
+
18
+ EntityStorageConnectorFactory.register(
19
+ 'profile-storage',
20
+ () =>
21
+ new MemoryEntityStorageConnector<Profile>({
22
+ entitySchema: 'Profile'
23
+ })
24
+ );
25
+
26
+ const connector =
27
+ EntityStorageConnectorFactory.get<MemoryEntityStorageConnector<Profile>>('profile-storage');
28
+
29
+ await connector.set({
30
+ id: 'profile-1',
31
+ email: 'ada@example.com',
32
+ status: 'active',
33
+ createdAt: '2026-03-09T10:30:00.000Z'
34
+ });
35
+ ```
36
+
37
+ ```typescript
38
+ import type {
39
+ IEntityStorageGetRequest,
40
+ IEntityStorageGetResponse,
41
+ IEntityStorageListRequest,
42
+ IEntityStorageListResponse,
43
+ IEntityStorageRemoveRequest,
44
+ IEntityStorageSetRequest
45
+ } from '@twin.org/entity-storage-models';
46
+
47
+ interface Profile {
48
+ id: string;
49
+ email: string;
50
+ status: 'active' | 'inactive';
51
+ createdAt: string;
52
+ }
53
+
54
+ const setRequest: IEntityStorageSetRequest = {
55
+ body: {
56
+ id: 'profile-1',
57
+ email: 'ada@example.com',
58
+ status: 'active',
59
+ createdAt: '2026-03-09T10:30:00.000Z'
60
+ }
61
+ };
62
+
63
+ const getRequest: IEntityStorageGetRequest = {
64
+ pathParams: { id: 'profile-1' }
65
+ };
66
+
67
+ const listRequest: IEntityStorageListRequest = {
68
+ query: {
69
+ limit: '25'
70
+ }
71
+ };
72
+
73
+ const getResponse: IEntityStorageGetResponse = {
74
+ body: setRequest.body
75
+ };
76
+
77
+ const listResponse: IEntityStorageListResponse = {
78
+ body: {
79
+ entities: [setRequest.body],
80
+ cursor: 'next-page-token'
81
+ }
82
+ };
83
+
84
+ const removeRequest: IEntityStorageRemoveRequest = {
85
+ pathParams: { id: 'profile-1' }
86
+ };
87
+ ```