@twin.org/verifiable-storage-rest-client 0.0.3-next.7 → 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.
- package/README.md +3 -1
- package/docs/changelog.md +93 -65
- package/docs/examples.md +30 -1
- package/docs/reference/classes/VerifiableStorageRestClient.md +6 -6
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# TWIN Verifiable Storage REST Client
|
|
2
2
|
|
|
3
|
-
|
|
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,46 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Changelog
|
|
2
2
|
|
|
3
|
-
## [0.0.3-next.
|
|
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)
|
|
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.7 to 0.0.3-next.8
|
|
30
|
+
|
|
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)
|
|
4
32
|
|
|
5
33
|
|
|
6
34
|
### Features
|
|
7
35
|
|
|
8
|
-
* add context id features ([#40](https://github.com/
|
|
9
|
-
* add support for allowlist ([#17](https://github.com/
|
|
10
|
-
* add validate-locales ([326384f](https://github.com/
|
|
11
|
-
* eslint migration to flat config ([b0a0b85](https://github.com/
|
|
12
|
-
* update dependencies ([a16a772](https://github.com/
|
|
13
|
-
* update framework core ([efa612e](https://github.com/
|
|
14
|
-
* use new dlt packages with latency fix ([#6](https://github.com/
|
|
15
|
-
* use shared store mechanism ([#8](https://github.com/
|
|
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))
|
|
16
44
|
|
|
17
45
|
|
|
18
46
|
### Dependencies
|
|
@@ -21,7 +49,7 @@
|
|
|
21
49
|
* dependencies
|
|
22
50
|
* @twin.org/verifiable-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
|
|
23
51
|
|
|
24
|
-
## [0.0.3-next.6](https://github.com/
|
|
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)
|
|
25
53
|
|
|
26
54
|
|
|
27
55
|
### Miscellaneous Chores
|
|
@@ -35,7 +63,7 @@
|
|
|
35
63
|
* dependencies
|
|
36
64
|
* @twin.org/verifiable-storage-models bumped from 0.0.3-next.5 to 0.0.3-next.6
|
|
37
65
|
|
|
38
|
-
## [0.0.3-next.5](https://github.com/
|
|
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)
|
|
39
67
|
|
|
40
68
|
|
|
41
69
|
### Miscellaneous Chores
|
|
@@ -49,7 +77,7 @@
|
|
|
49
77
|
* dependencies
|
|
50
78
|
* @twin.org/verifiable-storage-models bumped from 0.0.3-next.4 to 0.0.3-next.5
|
|
51
79
|
|
|
52
|
-
## [0.0.3-next.4](https://github.com/
|
|
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)
|
|
53
81
|
|
|
54
82
|
|
|
55
83
|
### Miscellaneous Chores
|
|
@@ -63,7 +91,7 @@
|
|
|
63
91
|
* dependencies
|
|
64
92
|
* @twin.org/verifiable-storage-models bumped from 0.0.3-next.3 to 0.0.3-next.4
|
|
65
93
|
|
|
66
|
-
## [0.0.3-next.3](https://github.com/
|
|
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)
|
|
67
95
|
|
|
68
96
|
|
|
69
97
|
### Miscellaneous Chores
|
|
@@ -77,7 +105,7 @@
|
|
|
77
105
|
* dependencies
|
|
78
106
|
* @twin.org/verifiable-storage-models bumped from 0.0.3-next.2 to 0.0.3-next.3
|
|
79
107
|
|
|
80
|
-
## [0.0.3-next.2](https://github.com/
|
|
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)
|
|
81
109
|
|
|
82
110
|
|
|
83
111
|
### Miscellaneous Chores
|
|
@@ -91,19 +119,19 @@
|
|
|
91
119
|
* dependencies
|
|
92
120
|
* @twin.org/verifiable-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
|
|
93
121
|
|
|
94
|
-
## [0.0.3-next.1](https://github.com/
|
|
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)
|
|
95
123
|
|
|
96
124
|
|
|
97
125
|
### Features
|
|
98
126
|
|
|
99
|
-
* add context id features ([#40](https://github.com/
|
|
100
|
-
* add support for allowlist ([#17](https://github.com/
|
|
101
|
-
* add validate-locales ([326384f](https://github.com/
|
|
102
|
-
* eslint migration to flat config ([b0a0b85](https://github.com/
|
|
103
|
-
* update dependencies ([a16a772](https://github.com/
|
|
104
|
-
* update framework core ([efa612e](https://github.com/
|
|
105
|
-
* use new dlt packages with latency fix ([#6](https://github.com/
|
|
106
|
-
* use shared store mechanism ([#8](https://github.com/
|
|
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))
|
|
107
135
|
|
|
108
136
|
|
|
109
137
|
### Dependencies
|
|
@@ -112,12 +140,12 @@
|
|
|
112
140
|
* dependencies
|
|
113
141
|
* @twin.org/verifiable-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
|
|
114
142
|
|
|
115
|
-
## [0.0.2-next.6](https://github.com/
|
|
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)
|
|
116
144
|
|
|
117
145
|
|
|
118
146
|
### Features
|
|
119
147
|
|
|
120
|
-
* add validate-locales ([326384f](https://github.com/
|
|
148
|
+
* add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
|
|
121
149
|
|
|
122
150
|
|
|
123
151
|
### Dependencies
|
|
@@ -126,12 +154,12 @@
|
|
|
126
154
|
* dependencies
|
|
127
155
|
* @twin.org/verifiable-storage-models bumped from 0.0.2-next.5 to 0.0.2-next.6
|
|
128
156
|
|
|
129
|
-
## [0.0.2-next.5](https://github.com/
|
|
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)
|
|
130
158
|
|
|
131
159
|
|
|
132
160
|
### Features
|
|
133
161
|
|
|
134
|
-
* eslint migration to flat config ([b0a0b85](https://github.com/
|
|
162
|
+
* eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
|
|
135
163
|
|
|
136
164
|
|
|
137
165
|
### Dependencies
|
|
@@ -140,12 +168,12 @@
|
|
|
140
168
|
* dependencies
|
|
141
169
|
* @twin.org/verifiable-storage-models bumped from 0.0.2-next.4 to 0.0.2-next.5
|
|
142
170
|
|
|
143
|
-
## [0.0.2-next.4](https://github.com/
|
|
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)
|
|
144
172
|
|
|
145
173
|
|
|
146
174
|
### Features
|
|
147
175
|
|
|
148
|
-
* update framework core ([efa612e](https://github.com/
|
|
176
|
+
* update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
|
|
149
177
|
|
|
150
178
|
|
|
151
179
|
### Dependencies
|
|
@@ -154,7 +182,7 @@
|
|
|
154
182
|
* dependencies
|
|
155
183
|
* @twin.org/verifiable-storage-models bumped from 0.0.2-next.3 to 0.0.2-next.4
|
|
156
184
|
|
|
157
|
-
## [0.0.2-next.3](https://github.com/
|
|
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)
|
|
158
186
|
|
|
159
187
|
|
|
160
188
|
### Miscellaneous Chores
|
|
@@ -168,15 +196,15 @@
|
|
|
168
196
|
* dependencies
|
|
169
197
|
* @twin.org/verifiable-storage-models bumped from 0.0.2-next.2 to 0.0.2-next.3
|
|
170
198
|
|
|
171
|
-
## [0.0.2-next.2](https://github.com/
|
|
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)
|
|
172
200
|
|
|
173
201
|
|
|
174
202
|
### Features
|
|
175
203
|
|
|
176
|
-
* add support for allowlist ([#17](https://github.com/
|
|
177
|
-
* update dependencies ([a16a772](https://github.com/
|
|
178
|
-
* use new dlt packages with latency fix ([#6](https://github.com/
|
|
179
|
-
* use shared store mechanism ([#8](https://github.com/
|
|
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))
|
|
180
208
|
|
|
181
209
|
|
|
182
210
|
### Dependencies
|
|
@@ -185,15 +213,15 @@
|
|
|
185
213
|
* dependencies
|
|
186
214
|
* @twin.org/verifiable-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.2
|
|
187
215
|
|
|
188
|
-
## [0.0.2-next.0](https://github.com/
|
|
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)
|
|
189
217
|
|
|
190
218
|
|
|
191
219
|
### Features
|
|
192
220
|
|
|
193
|
-
* add support for allowlist ([#17](https://github.com/
|
|
194
|
-
* update dependencies ([a16a772](https://github.com/
|
|
195
|
-
* use new dlt packages with latency fix ([#6](https://github.com/
|
|
196
|
-
* use shared store mechanism ([#8](https://github.com/
|
|
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))
|
|
197
225
|
|
|
198
226
|
|
|
199
227
|
### Dependencies
|
|
@@ -207,7 +235,7 @@
|
|
|
207
235
|
|
|
208
236
|
### Features
|
|
209
237
|
|
|
210
|
-
* release to production ([6ce6744](https://github.com/
|
|
238
|
+
* release to production ([6ce6744](https://github.com/iotaledger/twin-verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
|
|
211
239
|
|
|
212
240
|
|
|
213
241
|
### Dependencies
|
|
@@ -216,7 +244,7 @@
|
|
|
216
244
|
* dependencies
|
|
217
245
|
* @twin.org/verifiable-storage-models bumped from ^0.0.0 to ^0.0.1
|
|
218
246
|
|
|
219
|
-
## [0.0.1-next.17](https://github.com/
|
|
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)
|
|
220
248
|
|
|
221
249
|
|
|
222
250
|
### Miscellaneous Chores
|
|
@@ -230,12 +258,12 @@
|
|
|
230
258
|
* dependencies
|
|
231
259
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.16 to 0.0.1-next.17
|
|
232
260
|
|
|
233
|
-
## [0.0.1-next.16](https://github.com/
|
|
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)
|
|
234
262
|
|
|
235
263
|
|
|
236
264
|
### Features
|
|
237
265
|
|
|
238
|
-
* update dependencies ([a16a772](https://github.com/
|
|
266
|
+
* update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
|
|
239
267
|
|
|
240
268
|
|
|
241
269
|
### Dependencies
|
|
@@ -244,7 +272,7 @@
|
|
|
244
272
|
* dependencies
|
|
245
273
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.15 to 0.0.1-next.16
|
|
246
274
|
|
|
247
|
-
## [0.0.1-next.15](https://github.com/
|
|
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)
|
|
248
276
|
|
|
249
277
|
|
|
250
278
|
### Miscellaneous Chores
|
|
@@ -258,14 +286,14 @@
|
|
|
258
286
|
* dependencies
|
|
259
287
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.14 to 0.0.1-next.15
|
|
260
288
|
|
|
261
|
-
## [0.0.1-next.14](https://github.com/
|
|
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)
|
|
262
290
|
|
|
263
291
|
|
|
264
292
|
### Features
|
|
265
293
|
|
|
266
|
-
* add support for allowlist ([#17](https://github.com/
|
|
267
|
-
* use new dlt packages with latency fix ([#6](https://github.com/
|
|
268
|
-
* use shared store mechanism ([#8](https://github.com/
|
|
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))
|
|
269
297
|
|
|
270
298
|
|
|
271
299
|
### Dependencies
|
|
@@ -274,7 +302,7 @@
|
|
|
274
302
|
* dependencies
|
|
275
303
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.13 to 0.0.1-next.14
|
|
276
304
|
|
|
277
|
-
## [0.0.1-next.13](https://github.com/
|
|
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)
|
|
278
306
|
|
|
279
307
|
|
|
280
308
|
### Miscellaneous Chores
|
|
@@ -288,7 +316,7 @@
|
|
|
288
316
|
* dependencies
|
|
289
317
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.12 to 0.0.1-next.13
|
|
290
318
|
|
|
291
|
-
## [0.0.1-next.12](https://github.com/
|
|
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)
|
|
292
320
|
|
|
293
321
|
|
|
294
322
|
### Miscellaneous Chores
|
|
@@ -302,7 +330,7 @@
|
|
|
302
330
|
* dependencies
|
|
303
331
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.11 to 0.0.1-next.12
|
|
304
332
|
|
|
305
|
-
## [0.0.1-next.11](https://github.com/
|
|
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)
|
|
306
334
|
|
|
307
335
|
|
|
308
336
|
### Miscellaneous Chores
|
|
@@ -316,12 +344,12 @@
|
|
|
316
344
|
* dependencies
|
|
317
345
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.10 to 0.0.1-next.11
|
|
318
346
|
|
|
319
|
-
## [0.0.1-next.10](https://github.com/
|
|
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)
|
|
320
348
|
|
|
321
349
|
|
|
322
350
|
### Features
|
|
323
351
|
|
|
324
|
-
* add support for allowlist ([#17](https://github.com/
|
|
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))
|
|
325
353
|
|
|
326
354
|
|
|
327
355
|
### Dependencies
|
|
@@ -330,7 +358,7 @@
|
|
|
330
358
|
* dependencies
|
|
331
359
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.9 to 0.0.1-next.10
|
|
332
360
|
|
|
333
|
-
## [0.0.1-next.9](https://github.com/
|
|
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)
|
|
334
362
|
|
|
335
363
|
|
|
336
364
|
### Miscellaneous Chores
|
|
@@ -344,7 +372,7 @@
|
|
|
344
372
|
* dependencies
|
|
345
373
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.8 to 0.0.1-next.9
|
|
346
374
|
|
|
347
|
-
## [0.0.1-next.8](https://github.com/
|
|
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)
|
|
348
376
|
|
|
349
377
|
|
|
350
378
|
### Miscellaneous Chores
|
|
@@ -358,7 +386,7 @@
|
|
|
358
386
|
* dependencies
|
|
359
387
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.7 to 0.0.1-next.8
|
|
360
388
|
|
|
361
|
-
## [0.0.1-next.7](https://github.com/
|
|
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)
|
|
362
390
|
|
|
363
391
|
|
|
364
392
|
### Miscellaneous Chores
|
|
@@ -372,7 +400,7 @@
|
|
|
372
400
|
* dependencies
|
|
373
401
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.6 to 0.0.1-next.7
|
|
374
402
|
|
|
375
|
-
## [0.0.1-next.6](https://github.com/
|
|
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)
|
|
376
404
|
|
|
377
405
|
|
|
378
406
|
### Miscellaneous Chores
|
|
@@ -386,7 +414,7 @@
|
|
|
386
414
|
* dependencies
|
|
387
415
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.5 to 0.0.1-next.6
|
|
388
416
|
|
|
389
|
-
## [0.0.1-next.5](https://github.com/
|
|
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)
|
|
390
418
|
|
|
391
419
|
|
|
392
420
|
### Miscellaneous Chores
|
|
@@ -400,12 +428,12 @@
|
|
|
400
428
|
* dependencies
|
|
401
429
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.4 to 0.0.1-next.5
|
|
402
430
|
|
|
403
|
-
## [0.0.1-next.4](https://github.com/
|
|
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)
|
|
404
432
|
|
|
405
433
|
|
|
406
434
|
### Features
|
|
407
435
|
|
|
408
|
-
* use shared store mechanism ([#8](https://github.com/
|
|
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))
|
|
409
437
|
|
|
410
438
|
|
|
411
439
|
### Dependencies
|
|
@@ -414,12 +442,12 @@
|
|
|
414
442
|
* dependencies
|
|
415
443
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.3 to 0.0.1-next.4
|
|
416
444
|
|
|
417
|
-
## [0.0.1-next.3](https://github.com/
|
|
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)
|
|
418
446
|
|
|
419
447
|
|
|
420
448
|
### Features
|
|
421
449
|
|
|
422
|
-
* use new dlt packages with latency fix ([#6](https://github.com/
|
|
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))
|
|
423
451
|
|
|
424
452
|
|
|
425
453
|
### Dependencies
|
|
@@ -428,7 +456,7 @@
|
|
|
428
456
|
* dependencies
|
|
429
457
|
* @twin.org/verifiable-storage-models bumped from 0.0.1-next.2 to 0.0.1-next.3
|
|
430
458
|
|
|
431
|
-
## [0.0.1-next.2](https://github.com/
|
|
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)
|
|
432
460
|
|
|
433
461
|
|
|
434
462
|
### Miscellaneous Chores
|
package/docs/examples.md
CHANGED
|
@@ -1 +1,30 @@
|
|
|
1
|
-
#
|
|
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
|
+
```
|
|
@@ -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.
|
|
4
|
-
"description": "
|
|
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/
|
|
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.
|
|
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/
|
|
57
|
+
"url": "git+https://github.com/iotaledger/verifiable-storage/issues"
|
|
58
58
|
},
|
|
59
59
|
"homepage": "https://twindev.org"
|
|
60
60
|
}
|