@twin.org/verifiable-storage-rest-client 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 (5) hide show
  1. package/README.md +3 -1
  2. package/docs/changelog.md +198 -51
  3. package/docs/examples.md +30 -1
  4. package/docs/reference/classes/VerifiableStorageRestClient.md +6 -6
  5. package/package.json +5 -5
package/README.md CHANGED
@@ -1,6 +1,8 @@
1
1
  # TWIN Verifiable Storage REST Client
2
2
 
3
- Verifiable Storage contract implementation which can connect to REST endpoints.
3
+ This package provides a REST client for calling verifiable storage service endpoints from external applications and services. It wraps API requests and responses in the shared model contracts so consumers can integrate with predictable request shapes and result handling.
4
+
5
+ It is intended for client-side or service-to-service use cases where verifiable storage operations are accessed over HTTP rather than through direct connector invocation.
4
6
 
5
7
  ## Installation
6
8
 
package/docs/changelog.md CHANGED
@@ -1,18 +1,165 @@
1
- # @twin.org/verifiable-storage-rest-client - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.1](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.0...verifiable-storage-rest-client-v0.0.3-next.1) (2025-11-12)
3
+ ## [0.0.3-next.11](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.10...verifiable-storage-rest-client-v0.0.3-next.11) (2026-05-20)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **verifiable-storage-rest-client:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.10 to 0.0.3-next.11
16
+
17
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.9...verifiable-storage-rest-client-v0.0.3-next.10) (2026-05-12)
18
+
19
+
20
+ ### Features
21
+
22
+ * typescript 6 update ([66823cf](https://github.com/iotaledger/twin-verifiable-storage/commit/66823cf7a6522622c889afdc49005d016e8574fe))
23
+
24
+
25
+ ### Dependencies
26
+
27
+ * The following workspace dependencies were updated
28
+ * dependencies
29
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.9 to 0.0.3-next.10
30
+
31
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.8...verifiable-storage-rest-client-v0.0.3-next.9) (2026-05-08)
32
+
33
+
34
+ ### Miscellaneous Chores
35
+
36
+ * **verifiable-storage-rest-client:** Synchronize repo versions
37
+
38
+
39
+ ### Dependencies
40
+
41
+ * The following workspace dependencies were updated
42
+ * dependencies
43
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.8 to 0.0.3-next.9
44
+
45
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.7...verifiable-storage-rest-client-v0.0.3-next.8) (2026-03-03)
46
+
47
+
48
+ ### Miscellaneous Chores
49
+
50
+ * **verifiable-storage-rest-client:** Synchronize repo versions
51
+
52
+
53
+ ### Dependencies
54
+
55
+ * The following workspace dependencies were updated
56
+ * dependencies
57
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.7 to 0.0.3-next.8
58
+
59
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.6...verifiable-storage-rest-client-v0.0.3-next.7) (2026-02-25)
60
+
61
+
62
+ ### Features
63
+
64
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
65
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
66
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
67
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
68
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
69
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
70
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
71
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
72
+
73
+
74
+ ### Dependencies
75
+
76
+ * The following workspace dependencies were updated
77
+ * dependencies
78
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
79
+
80
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.5...verifiable-storage-rest-client-v0.0.3-next.6) (2026-02-25)
81
+
82
+
83
+ ### Miscellaneous Chores
84
+
85
+ * **verifiable-storage-rest-client:** Synchronize repo versions
86
+
87
+
88
+ ### Dependencies
89
+
90
+ * The following workspace dependencies were updated
91
+ * dependencies
92
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.5 to 0.0.3-next.6
93
+
94
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.4...verifiable-storage-rest-client-v0.0.3-next.5) (2026-02-09)
95
+
96
+
97
+ ### Miscellaneous Chores
98
+
99
+ * **verifiable-storage-rest-client:** Synchronize repo versions
100
+
101
+
102
+ ### Dependencies
103
+
104
+ * The following workspace dependencies were updated
105
+ * dependencies
106
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.4 to 0.0.3-next.5
107
+
108
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.3...verifiable-storage-rest-client-v0.0.3-next.4) (2026-02-09)
109
+
110
+
111
+ ### Miscellaneous Chores
112
+
113
+ * **verifiable-storage-rest-client:** Synchronize repo versions
114
+
115
+
116
+ ### Dependencies
117
+
118
+ * The following workspace dependencies were updated
119
+ * dependencies
120
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.3 to 0.0.3-next.4
121
+
122
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.2...verifiable-storage-rest-client-v0.0.3-next.3) (2026-01-21)
123
+
124
+
125
+ ### Miscellaneous Chores
126
+
127
+ * **verifiable-storage-rest-client:** Synchronize repo versions
128
+
129
+
130
+ ### Dependencies
131
+
132
+ * The following workspace dependencies were updated
133
+ * dependencies
134
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.2 to 0.0.3-next.3
135
+
136
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.1...verifiable-storage-rest-client-v0.0.3-next.2) (2026-01-14)
137
+
138
+
139
+ ### Miscellaneous Chores
140
+
141
+ * **verifiable-storage-rest-client:** Synchronize repo versions
142
+
143
+
144
+ ### Dependencies
145
+
146
+ * The following workspace dependencies were updated
147
+ * dependencies
148
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
149
+
150
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.0...verifiable-storage-rest-client-v0.0.3-next.1) (2025-11-12)
4
151
 
5
152
 
6
153
  ### Features
7
154
 
8
- * add context id features ([#40](https://github.com/twinfoundation/verifiable-storage/issues/40)) ([260b96a](https://github.com/twinfoundation/verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
9
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
10
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
11
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
12
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
13
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
14
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
15
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
155
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
156
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
157
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
158
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
159
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
160
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
161
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
162
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
16
163
 
17
164
 
18
165
  ### Dependencies
@@ -21,12 +168,12 @@
21
168
  * dependencies
22
169
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
23
170
 
24
- ## [0.0.2-next.6](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.5...verifiable-storage-rest-client-v0.0.2-next.6) (2025-10-09)
171
+ ## [0.0.2-next.6](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.5...verifiable-storage-rest-client-v0.0.2-next.6) (2025-10-09)
25
172
 
26
173
 
27
174
  ### Features
28
175
 
29
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
176
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
30
177
 
31
178
 
32
179
  ### Dependencies
@@ -35,12 +182,12 @@
35
182
  * dependencies
36
183
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.5 to 0.0.2-next.6
37
184
 
38
- ## [0.0.2-next.5](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.4...verifiable-storage-rest-client-v0.0.2-next.5) (2025-09-26)
185
+ ## [0.0.2-next.5](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.4...verifiable-storage-rest-client-v0.0.2-next.5) (2025-09-26)
39
186
 
40
187
 
41
188
  ### Features
42
189
 
43
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
190
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
44
191
 
45
192
 
46
193
  ### Dependencies
@@ -49,12 +196,12 @@
49
196
  * dependencies
50
197
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.4 to 0.0.2-next.5
51
198
 
52
- ## [0.0.2-next.4](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.3...verifiable-storage-rest-client-v0.0.2-next.4) (2025-08-20)
199
+ ## [0.0.2-next.4](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.3...verifiable-storage-rest-client-v0.0.2-next.4) (2025-08-20)
53
200
 
54
201
 
55
202
  ### Features
56
203
 
57
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
204
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
58
205
 
59
206
 
60
207
  ### Dependencies
@@ -63,7 +210,7 @@
63
210
  * dependencies
64
211
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.3 to 0.0.2-next.4
65
212
 
66
- ## [0.0.2-next.3](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.2...verifiable-storage-rest-client-v0.0.2-next.3) (2025-07-28)
213
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.2...verifiable-storage-rest-client-v0.0.2-next.3) (2025-07-28)
67
214
 
68
215
 
69
216
  ### Miscellaneous Chores
@@ -77,15 +224,15 @@
77
224
  * dependencies
78
225
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.2 to 0.0.2-next.3
79
226
 
80
- ## [0.0.2-next.2](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.1...verifiable-storage-rest-client-v0.0.2-next.2) (2025-07-16)
227
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.1...verifiable-storage-rest-client-v0.0.2-next.2) (2025-07-16)
81
228
 
82
229
 
83
230
  ### Features
84
231
 
85
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
86
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
87
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
88
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
232
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
233
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
234
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
235
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
89
236
 
90
237
 
91
238
  ### Dependencies
@@ -94,15 +241,15 @@
94
241
  * dependencies
95
242
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.2
96
243
 
97
- ## [0.0.2-next.0](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.0...verifiable-storage-rest-client-v0.0.2-next.0) (2025-07-16)
244
+ ## [0.0.2-next.0](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.0...verifiable-storage-rest-client-v0.0.2-next.0) (2025-07-16)
98
245
 
99
246
 
100
247
  ### Features
101
248
 
102
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
103
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
104
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
105
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
249
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
250
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
251
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
252
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
106
253
 
107
254
 
108
255
  ### Dependencies
@@ -116,7 +263,7 @@
116
263
 
117
264
  ### Features
118
265
 
119
- * release to production ([6ce6744](https://github.com/twinfoundation/verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
266
+ * release to production ([6ce6744](https://github.com/iotaledger/twin-verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
120
267
 
121
268
 
122
269
  ### Dependencies
@@ -125,7 +272,7 @@
125
272
  * dependencies
126
273
  * @twin.org/verifiable-storage-models bumped from ^0.0.0 to ^0.0.1
127
274
 
128
- ## [0.0.1-next.17](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.16...verifiable-storage-rest-client-v0.0.1-next.17) (2025-06-25)
275
+ ## [0.0.1-next.17](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.16...verifiable-storage-rest-client-v0.0.1-next.17) (2025-06-25)
129
276
 
130
277
 
131
278
  ### Miscellaneous Chores
@@ -139,12 +286,12 @@
139
286
  * dependencies
140
287
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.16 to 0.0.1-next.17
141
288
 
142
- ## [0.0.1-next.16](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.15...verifiable-storage-rest-client-v0.0.1-next.16) (2025-06-12)
289
+ ## [0.0.1-next.16](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.15...verifiable-storage-rest-client-v0.0.1-next.16) (2025-06-12)
143
290
 
144
291
 
145
292
  ### Features
146
293
 
147
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
294
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
148
295
 
149
296
 
150
297
  ### Dependencies
@@ -153,7 +300,7 @@
153
300
  * dependencies
154
301
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.15 to 0.0.1-next.16
155
302
 
156
- ## [0.0.1-next.15](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.14...verifiable-storage-rest-client-v0.0.1-next.15) (2025-06-03)
303
+ ## [0.0.1-next.15](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.14...verifiable-storage-rest-client-v0.0.1-next.15) (2025-06-03)
157
304
 
158
305
 
159
306
  ### Miscellaneous Chores
@@ -167,14 +314,14 @@
167
314
  * dependencies
168
315
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.14 to 0.0.1-next.15
169
316
 
170
- ## [0.0.1-next.14](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.13...verifiable-storage-rest-client-v0.0.1-next.14) (2025-05-28)
317
+ ## [0.0.1-next.14](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.13...verifiable-storage-rest-client-v0.0.1-next.14) (2025-05-28)
171
318
 
172
319
 
173
320
  ### Features
174
321
 
175
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
176
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
177
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
322
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
323
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
324
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
178
325
 
179
326
 
180
327
  ### Dependencies
@@ -183,7 +330,7 @@
183
330
  * dependencies
184
331
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.13 to 0.0.1-next.14
185
332
 
186
- ## [0.0.1-next.13](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.12...verifiable-storage-rest-client-v0.0.1-next.13) (2025-05-28)
333
+ ## [0.0.1-next.13](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.12...verifiable-storage-rest-client-v0.0.1-next.13) (2025-05-28)
187
334
 
188
335
 
189
336
  ### Miscellaneous Chores
@@ -197,7 +344,7 @@
197
344
  * dependencies
198
345
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.12 to 0.0.1-next.13
199
346
 
200
- ## [0.0.1-next.12](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.11...verifiable-storage-rest-client-v0.0.1-next.12) (2025-05-28)
347
+ ## [0.0.1-next.12](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.11...verifiable-storage-rest-client-v0.0.1-next.12) (2025-05-28)
201
348
 
202
349
 
203
350
  ### Miscellaneous Chores
@@ -211,7 +358,7 @@
211
358
  * dependencies
212
359
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.11 to 0.0.1-next.12
213
360
 
214
- ## [0.0.1-next.11](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.10...verifiable-storage-rest-client-v0.0.1-next.11) (2025-05-22)
361
+ ## [0.0.1-next.11](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.10...verifiable-storage-rest-client-v0.0.1-next.11) (2025-05-22)
215
362
 
216
363
 
217
364
  ### Miscellaneous Chores
@@ -225,12 +372,12 @@
225
372
  * dependencies
226
373
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.10 to 0.0.1-next.11
227
374
 
228
- ## [0.0.1-next.10](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.9...verifiable-storage-rest-client-v0.0.1-next.10) (2025-05-22)
375
+ ## [0.0.1-next.10](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.9...verifiable-storage-rest-client-v0.0.1-next.10) (2025-05-22)
229
376
 
230
377
 
231
378
  ### Features
232
379
 
233
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
380
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
234
381
 
235
382
 
236
383
  ### Dependencies
@@ -239,7 +386,7 @@
239
386
  * dependencies
240
387
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.9 to 0.0.1-next.10
241
388
 
242
- ## [0.0.1-next.9](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.8...verifiable-storage-rest-client-v0.0.1-next.9) (2025-05-06)
389
+ ## [0.0.1-next.9](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.8...verifiable-storage-rest-client-v0.0.1-next.9) (2025-05-06)
243
390
 
244
391
 
245
392
  ### Miscellaneous Chores
@@ -253,7 +400,7 @@
253
400
  * dependencies
254
401
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.8 to 0.0.1-next.9
255
402
 
256
- ## [0.0.1-next.8](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.7...verifiable-storage-rest-client-v0.0.1-next.8) (2025-04-24)
403
+ ## [0.0.1-next.8](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.7...verifiable-storage-rest-client-v0.0.1-next.8) (2025-04-24)
257
404
 
258
405
 
259
406
  ### Miscellaneous Chores
@@ -267,7 +414,7 @@
267
414
  * dependencies
268
415
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.7 to 0.0.1-next.8
269
416
 
270
- ## [0.0.1-next.7](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.6...verifiable-storage-rest-client-v0.0.1-next.7) (2025-04-23)
417
+ ## [0.0.1-next.7](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.6...verifiable-storage-rest-client-v0.0.1-next.7) (2025-04-23)
271
418
 
272
419
 
273
420
  ### Miscellaneous Chores
@@ -281,7 +428,7 @@
281
428
  * dependencies
282
429
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.6 to 0.0.1-next.7
283
430
 
284
- ## [0.0.1-next.6](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.5...verifiable-storage-rest-client-v0.0.1-next.6) (2025-04-23)
431
+ ## [0.0.1-next.6](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.5...verifiable-storage-rest-client-v0.0.1-next.6) (2025-04-23)
285
432
 
286
433
 
287
434
  ### Miscellaneous Chores
@@ -295,7 +442,7 @@
295
442
  * dependencies
296
443
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.5 to 0.0.1-next.6
297
444
 
298
- ## [0.0.1-next.5](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.4...verifiable-storage-rest-client-v0.0.1-next.5) (2025-04-23)
445
+ ## [0.0.1-next.5](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.4...verifiable-storage-rest-client-v0.0.1-next.5) (2025-04-23)
299
446
 
300
447
 
301
448
  ### Miscellaneous Chores
@@ -309,12 +456,12 @@
309
456
  * dependencies
310
457
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.4 to 0.0.1-next.5
311
458
 
312
- ## [0.0.1-next.4](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.3...verifiable-storage-rest-client-v0.0.1-next.4) (2025-04-17)
459
+ ## [0.0.1-next.4](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.3...verifiable-storage-rest-client-v0.0.1-next.4) (2025-04-17)
313
460
 
314
461
 
315
462
  ### Features
316
463
 
317
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
464
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
318
465
 
319
466
 
320
467
  ### Dependencies
@@ -323,12 +470,12 @@
323
470
  * dependencies
324
471
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.3 to 0.0.1-next.4
325
472
 
326
- ## [0.0.1-next.3](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.2...verifiable-storage-rest-client-v0.0.1-next.3) (2025-04-17)
473
+ ## [0.0.1-next.3](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.2...verifiable-storage-rest-client-v0.0.1-next.3) (2025-04-17)
327
474
 
328
475
 
329
476
  ### Features
330
477
 
331
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
478
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
332
479
 
333
480
 
334
481
  ### Dependencies
@@ -337,7 +484,7 @@
337
484
  * dependencies
338
485
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.2 to 0.0.1-next.3
339
486
 
340
- ## [0.0.1-next.2](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.1...verifiable-storage-rest-client-v0.0.1-next.2) (2025-03-28)
487
+ ## [0.0.1-next.2](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.1...verifiable-storage-rest-client-v0.0.1-next.2) (2025-03-28)
341
488
 
342
489
 
343
490
  ### Miscellaneous Chores
package/docs/examples.md CHANGED
@@ -1 +1,30 @@
1
- # @twin.org/verifiable-storage-rest-client - Examples
1
+ # Verifiable Storage REST Client Examples
2
+
3
+ This page provides TypeScript examples for using the REST client to interact with verifiable storage endpoints. These samples show how to create, retrieve, and update verifiable storage items over HTTP, making it easier to integrate verifiable storage into your applications.
4
+
5
+ ## VerifiableStorageRestClient
6
+
7
+ ```typescript
8
+ import { VerifiableStorageRestClient } from '@twin.org/verifiable-storage-rest-client';
9
+
10
+ const config = { baseUrl: 'https://api.example.com', apiKey: 'your-api-key' };
11
+ const client = new VerifiableStorageRestClient(config);
12
+
13
+ // Create a new verifiable storage item
14
+ const data = new TextEncoder().encode('REST data');
15
+ const allowList = ['did:example:controller1'];
16
+ const { id, receipt } = await client.create(data, allowList, { maxAllowListSize: 2 });
17
+ console.log(id); // Outputs the new item id
18
+ console.log(receipt); // Outputs the receipt object
19
+ ```
20
+
21
+ ```typescript
22
+ // Retrieve a verifiable storage item
23
+ const item = await client.get(id);
24
+ if (item.data) {
25
+ const decoded = new TextDecoder().decode(item.data);
26
+ console.log(decoded); // REST data
27
+ }
28
+ console.log(item.allowList); // Outputs the allow list
29
+ console.log(item.receipt); // Outputs the receipt object
30
+ ```
package/docs/reference/classes/VerifiableStorageRestClient.md CHANGED
@@ -36,7 +36,7 @@ The configuration for the client.
36
36
 
37
37
  ## Properties
38
38
 
39
- ### CLASS\_NAME
39
+ ### CLASS\_NAME {#class_name}
40
40
 
41
41
  > `readonly` `static` **CLASS\_NAME**: `string`
42
42
 
@@ -44,7 +44,7 @@ Runtime name for the class.
44
44
 
45
45
  ## Methods
46
46
 
47
- ### className()
47
+ ### className() {#classname}
48
48
 
49
49
  > **className**(): `string`
50
50
 
@@ -62,7 +62,7 @@ The class name of the component.
62
62
 
63
63
  ***
64
64
 
65
- ### create()
65
+ ### create() {#create}
66
66
 
67
67
  > **create**(`data`, `allowList?`, `options?`): `Promise`\<\{ `id`: `string`; `receipt`: `IJsonLdNodeObject`; \}\>
68
68
 
@@ -104,7 +104,7 @@ The id of the created verifiable storage item.
104
104
 
105
105
  ***
106
106
 
107
- ### update()
107
+ ### update() {#update}
108
108
 
109
109
  > **update**(`id`, `data?`, `allowList?`): `Promise`\<`IJsonLdNodeObject`\>
110
110
 
@@ -142,7 +142,7 @@ The updated receipt.
142
142
 
143
143
  ***
144
144
 
145
- ### get()
145
+ ### get() {#get}
146
146
 
147
147
  > **get**(`id`, `options?`): `Promise`\<\{ `data?`: `Uint8Array`\<`ArrayBufferLike`\>; `receipt`: `IJsonLdNodeObject`; \}\>
148
148
 
@@ -178,7 +178,7 @@ The data for the verifiable storage item.
178
178
 
179
179
  ***
180
180
 
181
- ### remove()
181
+ ### remove() {#remove}
182
182
 
183
183
  > **remove**(`id`): `Promise`\<`void`\>
184
184
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/verifiable-storage-rest-client",
3
- "version": "0.0.3-next.1",
4
- "description": "Verifiable Storage contract implementation which can connect to REST endpoints",
3
+ "version": "0.0.3-next.11",
4
+ "description": "REST client component for calling verifiable storage service endpoints",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/verifiable-storage.git",
7
+ "url": "git+https://github.com/iotaledger/verifiable-storage.git",
8
8
  "directory": "packages/verifiable-storage-rest-client"
9
9
  },
10
10
  "contributors": [
@@ -22,7 +22,7 @@
22
22
  "@twin.org/core": "next",
23
23
  "@twin.org/entity": "next",
24
24
  "@twin.org/nameof": "next",
25
- "@twin.org/verifiable-storage-models": "0.0.3-next.1",
25
+ "@twin.org/verifiable-storage-models": "0.0.3-next.11",
26
26
  "@twin.org/web": "next"
27
27
  },
28
28
  "main": "./dist/es/index.js",
@@ -54,7 +54,7 @@
54
54
  "immutable"
55
55
  ],
56
56
  "bugs": {
57
- "url": "git+https://github.com/twinfoundation/verifiable-storage/issues"
57
+ "url": "git+https://github.com/iotaledger/verifiable-storage/issues"
58
58
  },
59
59
  "homepage": "https://twindev.org"
60
60
  }