@twin.org/verifiable-storage-rest-client 0.0.3-next.8 → 0.0.3-next.9

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 +80 -66
  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,6 +1,20 @@
1
- # @twin.org/verifiable-storage-rest-client - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.8](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.7...verifiable-storage-rest-client-v0.0.3-next.8) (2026-03-03)
3
+ ## [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)
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.8 to 0.0.3-next.9
16
+
17
+ ## [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)
4
18
 
5
19
 
6
20
  ### Miscellaneous Chores
@@ -14,19 +28,19 @@
14
28
  * dependencies
15
29
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.7 to 0.0.3-next.8
16
30
 
17
- ## [0.0.3-next.7](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.6...verifiable-storage-rest-client-v0.0.3-next.7) (2026-02-25)
31
+ ## [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)
18
32
 
19
33
 
20
34
  ### Features
21
35
 
22
- * add context id features ([#40](https://github.com/twinfoundation/verifiable-storage/issues/40)) ([260b96a](https://github.com/twinfoundation/verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
23
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
24
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
25
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
26
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
27
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
28
- * 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))
29
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
36
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
37
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
38
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
39
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
40
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
41
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
42
+ * 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))
43
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
30
44
 
31
45
 
32
46
  ### Dependencies
@@ -35,7 +49,7 @@
35
49
  * dependencies
36
50
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
37
51
 
38
- ## [0.0.3-next.6](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.5...verifiable-storage-rest-client-v0.0.3-next.6) (2026-02-25)
52
+ ## [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)
39
53
 
40
54
 
41
55
  ### Miscellaneous Chores
@@ -49,7 +63,7 @@
49
63
  * dependencies
50
64
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.5 to 0.0.3-next.6
51
65
 
52
- ## [0.0.3-next.5](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.4...verifiable-storage-rest-client-v0.0.3-next.5) (2026-02-09)
66
+ ## [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)
53
67
 
54
68
 
55
69
  ### Miscellaneous Chores
@@ -63,7 +77,7 @@
63
77
  * dependencies
64
78
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.4 to 0.0.3-next.5
65
79
 
66
- ## [0.0.3-next.4](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.3...verifiable-storage-rest-client-v0.0.3-next.4) (2026-02-09)
80
+ ## [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)
67
81
 
68
82
 
69
83
  ### Miscellaneous Chores
@@ -77,7 +91,7 @@
77
91
  * dependencies
78
92
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.3 to 0.0.3-next.4
79
93
 
80
- ## [0.0.3-next.3](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.2...verifiable-storage-rest-client-v0.0.3-next.3) (2026-01-21)
94
+ ## [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)
81
95
 
82
96
 
83
97
  ### Miscellaneous Chores
@@ -91,7 +105,7 @@
91
105
  * dependencies
92
106
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.2 to 0.0.3-next.3
93
107
 
94
- ## [0.0.3-next.2](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.1...verifiable-storage-rest-client-v0.0.3-next.2) (2026-01-14)
108
+ ## [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)
95
109
 
96
110
 
97
111
  ### Miscellaneous Chores
@@ -105,19 +119,19 @@
105
119
  * dependencies
106
120
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
107
121
 
108
- ## [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)
122
+ ## [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)
109
123
 
110
124
 
111
125
  ### Features
112
126
 
113
- * add context id features ([#40](https://github.com/twinfoundation/verifiable-storage/issues/40)) ([260b96a](https://github.com/twinfoundation/verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
114
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
115
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
116
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
117
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
118
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
119
- * 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))
120
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
127
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
128
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
129
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
130
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
131
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
132
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
133
+ * 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))
134
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
121
135
 
122
136
 
123
137
  ### Dependencies
@@ -126,12 +140,12 @@
126
140
  * dependencies
127
141
  * @twin.org/verifiable-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
128
142
 
129
- ## [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)
143
+ ## [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)
130
144
 
131
145
 
132
146
  ### Features
133
147
 
134
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
148
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
135
149
 
136
150
 
137
151
  ### Dependencies
@@ -140,12 +154,12 @@
140
154
  * dependencies
141
155
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.5 to 0.0.2-next.6
142
156
 
143
- ## [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)
157
+ ## [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)
144
158
 
145
159
 
146
160
  ### Features
147
161
 
148
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
162
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
149
163
 
150
164
 
151
165
  ### Dependencies
@@ -154,12 +168,12 @@
154
168
  * dependencies
155
169
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.4 to 0.0.2-next.5
156
170
 
157
- ## [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)
171
+ ## [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)
158
172
 
159
173
 
160
174
  ### Features
161
175
 
162
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
176
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
163
177
 
164
178
 
165
179
  ### Dependencies
@@ -168,7 +182,7 @@
168
182
  * dependencies
169
183
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.3 to 0.0.2-next.4
170
184
 
171
- ## [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)
185
+ ## [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)
172
186
 
173
187
 
174
188
  ### Miscellaneous Chores
@@ -182,15 +196,15 @@
182
196
  * dependencies
183
197
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.2 to 0.0.2-next.3
184
198
 
185
- ## [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)
199
+ ## [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)
186
200
 
187
201
 
188
202
  ### Features
189
203
 
190
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
191
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
192
- * 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))
193
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
204
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
205
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
206
+ * 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))
207
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
194
208
 
195
209
 
196
210
  ### Dependencies
@@ -199,15 +213,15 @@
199
213
  * dependencies
200
214
  * @twin.org/verifiable-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.2
201
215
 
202
- ## [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)
216
+ ## [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)
203
217
 
204
218
 
205
219
  ### Features
206
220
 
207
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
208
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
209
- * 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))
210
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
221
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
222
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
223
+ * 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))
224
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
211
225
 
212
226
 
213
227
  ### Dependencies
@@ -221,7 +235,7 @@
221
235
 
222
236
  ### Features
223
237
 
224
- * release to production ([6ce6744](https://github.com/twinfoundation/verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
238
+ * release to production ([6ce6744](https://github.com/iotaledger/twin-verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
225
239
 
226
240
 
227
241
  ### Dependencies
@@ -230,7 +244,7 @@
230
244
  * dependencies
231
245
  * @twin.org/verifiable-storage-models bumped from ^0.0.0 to ^0.0.1
232
246
 
233
- ## [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)
247
+ ## [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)
234
248
 
235
249
 
236
250
  ### Miscellaneous Chores
@@ -244,12 +258,12 @@
244
258
  * dependencies
245
259
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.16 to 0.0.1-next.17
246
260
 
247
- ## [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)
261
+ ## [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)
248
262
 
249
263
 
250
264
  ### Features
251
265
 
252
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
266
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
253
267
 
254
268
 
255
269
  ### Dependencies
@@ -258,7 +272,7 @@
258
272
  * dependencies
259
273
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.15 to 0.0.1-next.16
260
274
 
261
- ## [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)
275
+ ## [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)
262
276
 
263
277
 
264
278
  ### Miscellaneous Chores
@@ -272,14 +286,14 @@
272
286
  * dependencies
273
287
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.14 to 0.0.1-next.15
274
288
 
275
- ## [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)
289
+ ## [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)
276
290
 
277
291
 
278
292
  ### Features
279
293
 
280
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
281
- * 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))
282
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
294
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
295
+ * 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))
296
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
283
297
 
284
298
 
285
299
  ### Dependencies
@@ -288,7 +302,7 @@
288
302
  * dependencies
289
303
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.13 to 0.0.1-next.14
290
304
 
291
- ## [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)
305
+ ## [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)
292
306
 
293
307
 
294
308
  ### Miscellaneous Chores
@@ -302,7 +316,7 @@
302
316
  * dependencies
303
317
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.12 to 0.0.1-next.13
304
318
 
305
- ## [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)
319
+ ## [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)
306
320
 
307
321
 
308
322
  ### Miscellaneous Chores
@@ -316,7 +330,7 @@
316
330
  * dependencies
317
331
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.11 to 0.0.1-next.12
318
332
 
319
- ## [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)
333
+ ## [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)
320
334
 
321
335
 
322
336
  ### Miscellaneous Chores
@@ -330,12 +344,12 @@
330
344
  * dependencies
331
345
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.10 to 0.0.1-next.11
332
346
 
333
- ## [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)
347
+ ## [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)
334
348
 
335
349
 
336
350
  ### Features
337
351
 
338
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
352
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
339
353
 
340
354
 
341
355
  ### Dependencies
@@ -344,7 +358,7 @@
344
358
  * dependencies
345
359
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.9 to 0.0.1-next.10
346
360
 
347
- ## [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)
361
+ ## [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)
348
362
 
349
363
 
350
364
  ### Miscellaneous Chores
@@ -358,7 +372,7 @@
358
372
  * dependencies
359
373
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.8 to 0.0.1-next.9
360
374
 
361
- ## [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)
375
+ ## [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)
362
376
 
363
377
 
364
378
  ### Miscellaneous Chores
@@ -372,7 +386,7 @@
372
386
  * dependencies
373
387
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.7 to 0.0.1-next.8
374
388
 
375
- ## [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)
389
+ ## [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)
376
390
 
377
391
 
378
392
  ### Miscellaneous Chores
@@ -386,7 +400,7 @@
386
400
  * dependencies
387
401
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.6 to 0.0.1-next.7
388
402
 
389
- ## [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)
403
+ ## [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)
390
404
 
391
405
 
392
406
  ### Miscellaneous Chores
@@ -400,7 +414,7 @@
400
414
  * dependencies
401
415
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.5 to 0.0.1-next.6
402
416
 
403
- ## [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)
417
+ ## [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)
404
418
 
405
419
 
406
420
  ### Miscellaneous Chores
@@ -414,12 +428,12 @@
414
428
  * dependencies
415
429
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.4 to 0.0.1-next.5
416
430
 
417
- ## [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)
431
+ ## [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)
418
432
 
419
433
 
420
434
  ### Features
421
435
 
422
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
436
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
423
437
 
424
438
 
425
439
  ### Dependencies
@@ -428,12 +442,12 @@
428
442
  * dependencies
429
443
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.3 to 0.0.1-next.4
430
444
 
431
- ## [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)
445
+ ## [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)
432
446
 
433
447
 
434
448
  ### Features
435
449
 
436
- * 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))
450
+ * 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))
437
451
 
438
452
 
439
453
  ### Dependencies
@@ -442,7 +456,7 @@
442
456
  * dependencies
443
457
  * @twin.org/verifiable-storage-models bumped from 0.0.1-next.2 to 0.0.1-next.3
444
458
 
445
- ## [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)
459
+ ## [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)
446
460
 
447
461
 
448
462
  ### 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.8",
4
- "description": "Verifiable Storage contract implementation which can connect to REST endpoints",
3
+ "version": "0.0.3-next.9",
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.8",
25
+ "@twin.org/verifiable-storage-models": "0.0.3-next.9",
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
  }