@twin.org/verifiable-storage-rest-client 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 (5) hide show
  1. package/README.md +3 -1
  2. package/docs/changelog.md +184 -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,151 @@
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.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)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
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))
8
+ * typescript 6 update ([66823cf](https://github.com/iotaledger/twin-verifiable-storage/commit/66823cf7a6522622c889afdc49005d016e8574fe))
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.9 to 0.0.3-next.10
16
+
17
+ ## [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)
18
+
19
+
20
+ ### Miscellaneous Chores
21
+
22
+ * **verifiable-storage-rest-client:** Synchronize repo versions
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.8 to 0.0.3-next.9
30
+
31
+ ## [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)
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.7 to 0.0.3-next.8
44
+
45
+ ## [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)
46
+
47
+
48
+ ### Features
49
+
50
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
51
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
52
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
53
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
54
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
55
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
56
+ * 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))
57
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
58
+
59
+
60
+ ### Dependencies
61
+
62
+ * The following workspace dependencies were updated
63
+ * dependencies
64
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
65
+
66
+ ## [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)
67
+
68
+
69
+ ### Miscellaneous Chores
70
+
71
+ * **verifiable-storage-rest-client:** Synchronize repo versions
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.5 to 0.0.3-next.6
79
+
80
+ ## [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)
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.4 to 0.0.3-next.5
93
+
94
+ ## [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)
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.3 to 0.0.3-next.4
107
+
108
+ ## [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)
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.2 to 0.0.3-next.3
121
+
122
+ ## [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)
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.1 to 0.0.3-next.2
135
+
136
+ ## [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)
137
+
138
+
139
+ ### Features
140
+
141
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
142
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
143
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
144
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
145
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
146
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
147
+ * 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))
148
+ * 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
149
 
17
150
 
18
151
  ### Dependencies
@@ -21,12 +154,12 @@
21
154
  * dependencies
22
155
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
23
156
 
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)
157
+ ## [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
158
 
26
159
 
27
160
  ### Features
28
161
 
29
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
162
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
30
163
 
31
164
 
32
165
  ### Dependencies
@@ -35,12 +168,12 @@
35
168
  * dependencies
36
169
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.5 to 0.0.2-next.6
37
170
 
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)
171
+ ## [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
172
 
40
173
 
41
174
  ### Features
42
175
 
43
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
176
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
44
177
 
45
178
 
46
179
  ### Dependencies
@@ -49,12 +182,12 @@
49
182
  * dependencies
50
183
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.4 to 0.0.2-next.5
51
184
 
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)
185
+ ## [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
186
 
54
187
 
55
188
  ### Features
56
189
 
57
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
190
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
58
191
 
59
192
 
60
193
  ### Dependencies
@@ -63,7 +196,7 @@
63
196
  * dependencies
64
197
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.3 to 0.0.2-next.4
65
198
 
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)
199
+ ## [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
200
 
68
201
 
69
202
  ### Miscellaneous Chores
@@ -77,15 +210,15 @@
77
210
  * dependencies
78
211
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.2 to 0.0.2-next.3
79
212
 
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)
213
+ ## [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
214
 
82
215
 
83
216
  ### Features
84
217
 
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))
218
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
219
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
220
+ * 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))
221
+ * 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
222
 
90
223
 
91
224
  ### Dependencies
@@ -94,15 +227,15 @@
94
227
  * dependencies
95
228
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.2
96
229
 
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)
230
+ ## [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
231
 
99
232
 
100
233
  ### Features
101
234
 
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))
235
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
236
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
237
+ * 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))
238
+ * 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
239
 
107
240
 
108
241
  ### Dependencies
@@ -116,7 +249,7 @@
116
249
 
117
250
  ### Features
118
251
 
119
- * release to production ([6ce6744](https://github.com/twinfoundation/verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
252
+ * release to production ([6ce6744](https://github.com/iotaledger/twin-verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
120
253
 
121
254
 
122
255
  ### Dependencies
@@ -125,7 +258,7 @@
125
258
  * dependencies
126
259
  * @twin.org/verifiable-storage-models bumped from ^0.0.0 to ^0.0.1
127
260
 
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)
261
+ ## [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
262
 
130
263
 
131
264
  ### Miscellaneous Chores
@@ -139,12 +272,12 @@
139
272
  * dependencies
140
273
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.16 to 0.0.1-next.17
141
274
 
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)
275
+ ## [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
276
 
144
277
 
145
278
  ### Features
146
279
 
147
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
280
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
148
281
 
149
282
 
150
283
  ### Dependencies
@@ -153,7 +286,7 @@
153
286
  * dependencies
154
287
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.15 to 0.0.1-next.16
155
288
 
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)
289
+ ## [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
290
 
158
291
 
159
292
  ### Miscellaneous Chores
@@ -167,14 +300,14 @@
167
300
  * dependencies
168
301
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.14 to 0.0.1-next.15
169
302
 
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)
303
+ ## [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
304
 
172
305
 
173
306
  ### Features
174
307
 
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))
308
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
309
+ * 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))
310
+ * 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
311
 
179
312
 
180
313
  ### Dependencies
@@ -183,7 +316,7 @@
183
316
  * dependencies
184
317
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.13 to 0.0.1-next.14
185
318
 
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)
319
+ ## [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
320
 
188
321
 
189
322
  ### Miscellaneous Chores
@@ -197,7 +330,7 @@
197
330
  * dependencies
198
331
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.12 to 0.0.1-next.13
199
332
 
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)
333
+ ## [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
334
 
202
335
 
203
336
  ### Miscellaneous Chores
@@ -211,7 +344,7 @@
211
344
  * dependencies
212
345
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.11 to 0.0.1-next.12
213
346
 
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)
347
+ ## [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
348
 
216
349
 
217
350
  ### Miscellaneous Chores
@@ -225,12 +358,12 @@
225
358
  * dependencies
226
359
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.10 to 0.0.1-next.11
227
360
 
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)
361
+ ## [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
362
 
230
363
 
231
364
  ### Features
232
365
 
233
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
366
+ * 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
367
 
235
368
 
236
369
  ### Dependencies
@@ -239,7 +372,7 @@
239
372
  * dependencies
240
373
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.9 to 0.0.1-next.10
241
374
 
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)
375
+ ## [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
376
 
244
377
 
245
378
  ### Miscellaneous Chores
@@ -253,7 +386,7 @@
253
386
  * dependencies
254
387
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.8 to 0.0.1-next.9
255
388
 
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)
389
+ ## [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
390
 
258
391
 
259
392
  ### Miscellaneous Chores
@@ -267,7 +400,7 @@
267
400
  * dependencies
268
401
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.7 to 0.0.1-next.8
269
402
 
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)
403
+ ## [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
404
 
272
405
 
273
406
  ### Miscellaneous Chores
@@ -281,7 +414,7 @@
281
414
  * dependencies
282
415
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.6 to 0.0.1-next.7
283
416
 
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)
417
+ ## [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
418
 
286
419
 
287
420
  ### Miscellaneous Chores
@@ -295,7 +428,7 @@
295
428
  * dependencies
296
429
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.5 to 0.0.1-next.6
297
430
 
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)
431
+ ## [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
432
 
300
433
 
301
434
  ### Miscellaneous Chores
@@ -309,12 +442,12 @@
309
442
  * dependencies
310
443
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.4 to 0.0.1-next.5
311
444
 
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)
445
+ ## [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
446
 
314
447
 
315
448
  ### Features
316
449
 
317
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
450
+ * 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
451
 
319
452
 
320
453
  ### Dependencies
@@ -323,12 +456,12 @@
323
456
  * dependencies
324
457
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.3 to 0.0.1-next.4
325
458
 
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)
459
+ ## [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
460
 
328
461
 
329
462
  ### Features
330
463
 
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))
464
+ * 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
465
 
333
466
 
334
467
  ### Dependencies
@@ -337,7 +470,7 @@
337
470
  * dependencies
338
471
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.2 to 0.0.1-next.3
339
472
 
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)
473
+ ## [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
474
 
342
475
 
343
476
  ### 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.10",
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.10",
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
  }