@twin.org/blob-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.
Files changed (5) hide show
  1. package/README.md +2 -2
  2. package/docs/changelog.md +79 -43
  3. package/docs/examples.md +98 -1
  4. package/docs/reference/classes/BlobStorageRestClient.md +10 -10
  5. package/package.json +5 -5
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # TWIN Blob Storage Rest Client
1
+ # TWIN Blob Storage REST Client
2
2
 
3
- Blob storage contract implementation which can connect to REST endpoints.
3
+ This package provides client utilities for consuming blob storage service endpoints over HTTP. It helps applications call blob APIs with consistent request construction and response handling.
4
4
 
5
5
  ## Installation
6
6
 
package/docs/changelog.md CHANGED
@@ -1,6 +1,42 @@
1
- # @twin.org/blob-storage-rest-client - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.7](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.3-next.6...blob-storage-rest-client-v0.0.3-next.7) (2026-02-25)
3
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.3-next.8...blob-storage-rest-client-v0.0.3-next.9) (2026-05-07)
4
+
5
+
6
+ ### Features
7
+
8
+ * add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
9
+ * add context id features ([#30](https://github.com/iotaledger/twin-blob-storage/issues/30)) ([fbf1c92](https://github.com/iotaledger/twin-blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
10
+ * add validate-locales ([f20fcec](https://github.com/iotaledger/twin-blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
11
+ * additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
12
+ * eslint migration to flat config ([e4239dd](https://github.com/iotaledger/twin-blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
13
+ * replace nextItem property with Link header ([#37](https://github.com/iotaledger/twin-blob-storage/issues/37)) ([0b68da5](https://github.com/iotaledger/twin-blob-storage/commit/0b68da58549c9e52eb2313ea5a868573840d5ca6))
14
+ * update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
15
+ * update framework core ([ff339fe](https://github.com/iotaledger/twin-blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
16
+ * use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
17
+
18
+
19
+ ### Dependencies
20
+
21
+ * The following workspace dependencies were updated
22
+ * dependencies
23
+ * @twin.org/blob-storage-models bumped from 0.0.3-next.8 to 0.0.3-next.9
24
+
25
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.3-next.7...blob-storage-rest-client-v0.0.3-next.8) (2026-05-07)
26
+
27
+
28
+ ### Miscellaneous Chores
29
+
30
+ * **blob-storage-rest-client:** Synchronize repo versions
31
+
32
+
33
+ ### Dependencies
34
+
35
+ * The following workspace dependencies were updated
36
+ * dependencies
37
+ * @twin.org/blob-storage-models bumped from 0.0.3-next.7 to 0.0.3-next.8
38
+
39
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.3-next.6...blob-storage-rest-client-v0.0.3-next.7) (2026-02-25)
4
40
 
5
41
 
6
42
  ### Miscellaneous Chores
@@ -14,7 +50,7 @@
14
50
  * dependencies
15
51
  * @twin.org/blob-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
16
52
 
17
- ## [0.0.3-next.6](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.3-next.5...blob-storage-rest-client-v0.0.3-next.6) (2026-02-09)
53
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.3-next.5...blob-storage-rest-client-v0.0.3-next.6) (2026-02-09)
18
54
 
19
55
 
20
56
  ### Miscellaneous Chores
@@ -28,7 +64,7 @@
28
64
  * dependencies
29
65
  * @twin.org/blob-storage-models bumped from 0.0.3-next.5 to 0.0.3-next.6
30
66
 
31
- ## [0.0.3-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.3-next.4...blob-storage-rest-client-v0.0.3-next.5) (2026-01-26)
67
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.3-next.4...blob-storage-rest-client-v0.0.3-next.5) (2026-01-26)
32
68
 
33
69
 
34
70
  ### Miscellaneous Chores
@@ -42,12 +78,12 @@
42
78
  * dependencies
43
79
  * @twin.org/blob-storage-models bumped from 0.0.3-next.4 to 0.0.3-next.5
44
80
 
45
- ## [0.0.3-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.3-next.3...blob-storage-rest-client-v0.0.3-next.4) (2026-01-23)
81
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.3-next.3...blob-storage-rest-client-v0.0.3-next.4) (2026-01-23)
46
82
 
47
83
 
48
84
  ### Features
49
85
 
50
- * replace nextItem property with Link header ([#37](https://github.com/twinfoundation/blob-storage/issues/37)) ([0b68da5](https://github.com/twinfoundation/blob-storage/commit/0b68da58549c9e52eb2313ea5a868573840d5ca6))
86
+ * replace nextItem property with Link header ([#37](https://github.com/iotaledger/twin-blob-storage/issues/37)) ([0b68da5](https://github.com/iotaledger/twin-blob-storage/commit/0b68da58549c9e52eb2313ea5a868573840d5ca6))
51
87
 
52
88
 
53
89
  ### Dependencies
@@ -56,7 +92,7 @@
56
92
  * dependencies
57
93
  * @twin.org/blob-storage-models bumped from 0.0.3-next.3 to 0.0.3-next.4
58
94
 
59
- ## [0.0.3-next.3](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.3-next.2...blob-storage-rest-client-v0.0.3-next.3) (2026-01-21)
95
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.3-next.2...blob-storage-rest-client-v0.0.3-next.3) (2026-01-21)
60
96
 
61
97
 
62
98
  ### Miscellaneous Chores
@@ -70,7 +106,7 @@
70
106
  * dependencies
71
107
  * @twin.org/blob-storage-models bumped from 0.0.3-next.2 to 0.0.3-next.3
72
108
 
73
- ## [0.0.3-next.2](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.3-next.1...blob-storage-rest-client-v0.0.3-next.2) (2026-01-14)
109
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.3-next.1...blob-storage-rest-client-v0.0.3-next.2) (2026-01-14)
74
110
 
75
111
 
76
112
  ### Miscellaneous Chores
@@ -84,19 +120,19 @@
84
120
  * dependencies
85
121
  * @twin.org/blob-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
86
122
 
87
- ## [0.0.3-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.3-next.0...blob-storage-rest-client-v0.0.3-next.1) (2025-11-11)
123
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.3-next.0...blob-storage-rest-client-v0.0.3-next.1) (2025-11-11)
88
124
 
89
125
 
90
126
  ### Features
91
127
 
92
- * add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
93
- * add context id features ([#30](https://github.com/twinfoundation/blob-storage/issues/30)) ([fbf1c92](https://github.com/twinfoundation/blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
94
- * add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
95
- * additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
96
- * eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
97
- * update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
98
- * update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
99
- * use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
128
+ * add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
129
+ * add context id features ([#30](https://github.com/iotaledger/twin-blob-storage/issues/30)) ([fbf1c92](https://github.com/iotaledger/twin-blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
130
+ * add validate-locales ([f20fcec](https://github.com/iotaledger/twin-blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
131
+ * additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
132
+ * eslint migration to flat config ([e4239dd](https://github.com/iotaledger/twin-blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
133
+ * update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
134
+ * update framework core ([ff339fe](https://github.com/iotaledger/twin-blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
135
+ * use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
100
136
 
101
137
 
102
138
  ### Dependencies
@@ -105,12 +141,12 @@
105
141
  * dependencies
106
142
  * @twin.org/blob-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
107
143
 
108
- ## [0.0.2-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.2-next.4...blob-storage-rest-client-v0.0.2-next.5) (2025-10-09)
144
+ ## [0.0.2-next.5](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.2-next.4...blob-storage-rest-client-v0.0.2-next.5) (2025-10-09)
109
145
 
110
146
 
111
147
  ### Features
112
148
 
113
- * add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
149
+ * add validate-locales ([f20fcec](https://github.com/iotaledger/twin-blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
114
150
 
115
151
 
116
152
  ### Dependencies
@@ -119,7 +155,7 @@
119
155
  * dependencies
120
156
  * @twin.org/blob-storage-models bumped from 0.0.2-next.4 to 0.0.2-next.5
121
157
 
122
- ## [0.0.2-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.2-next.3...blob-storage-rest-client-v0.0.2-next.4) (2025-10-02)
158
+ ## [0.0.2-next.4](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.2-next.3...blob-storage-rest-client-v0.0.2-next.4) (2025-10-02)
123
159
 
124
160
 
125
161
  ### Miscellaneous Chores
@@ -133,12 +169,12 @@
133
169
  * dependencies
134
170
  * @twin.org/blob-storage-models bumped from 0.0.2-next.3 to 0.0.2-next.4
135
171
 
136
- ## [0.0.2-next.3](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.2-next.2...blob-storage-rest-client-v0.0.2-next.3) (2025-08-29)
172
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.2-next.2...blob-storage-rest-client-v0.0.2-next.3) (2025-08-29)
137
173
 
138
174
 
139
175
  ### Features
140
176
 
141
- * eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
177
+ * eslint migration to flat config ([e4239dd](https://github.com/iotaledger/twin-blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
142
178
 
143
179
 
144
180
  ### Dependencies
@@ -147,12 +183,12 @@
147
183
  * dependencies
148
184
  * @twin.org/blob-storage-models bumped from 0.0.2-next.2 to 0.0.2-next.3
149
185
 
150
- ## [0.0.2-next.2](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.2-next.1...blob-storage-rest-client-v0.0.2-next.2) (2025-08-20)
186
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.2-next.1...blob-storage-rest-client-v0.0.2-next.2) (2025-08-20)
151
187
 
152
188
 
153
189
  ### Features
154
190
 
155
- * update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
191
+ * update framework core ([ff339fe](https://github.com/iotaledger/twin-blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
156
192
 
157
193
 
158
194
  ### Dependencies
@@ -161,15 +197,15 @@
161
197
  * dependencies
162
198
  * @twin.org/blob-storage-models bumped from 0.0.2-next.1 to 0.0.2-next.2
163
199
 
164
- ## [0.0.2-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.2-next.0...blob-storage-rest-client-v0.0.2-next.1) (2025-07-24)
200
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.2-next.0...blob-storage-rest-client-v0.0.2-next.1) (2025-07-24)
165
201
 
166
202
 
167
203
  ### Features
168
204
 
169
- * add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
170
- * additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
171
- * update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
172
- * use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
205
+ * add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
206
+ * additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
207
+ * update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
208
+ * use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
173
209
 
174
210
 
175
211
  ### Dependencies
@@ -183,7 +219,7 @@
183
219
 
184
220
  ### Features
185
221
 
186
- * release to production ([eacfe75](https://github.com/twinfoundation/blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
222
+ * release to production ([eacfe75](https://github.com/iotaledger/twin-blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
187
223
 
188
224
 
189
225
  ### Dependencies
@@ -192,7 +228,7 @@
192
228
  * dependencies
193
229
  * @twin.org/blob-storage-models bumped from ^0.0.0 to ^0.0.1
194
230
 
195
- ## [0.0.1-next.37](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.36...blob-storage-rest-client-v0.0.1-next.37) (2025-06-20)
231
+ ## [0.0.1-next.37](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.1-next.36...blob-storage-rest-client-v0.0.1-next.37) (2025-06-20)
196
232
 
197
233
 
198
234
  ### Miscellaneous Chores
@@ -206,12 +242,12 @@
206
242
  * dependencies
207
243
  * @twin.org/blob-storage-models bumped from 0.0.1-next.36 to 0.0.1-next.37
208
244
 
209
- ## [0.0.1-next.36](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.35...blob-storage-rest-client-v0.0.1-next.36) (2025-06-19)
245
+ ## [0.0.1-next.36](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.1-next.35...blob-storage-rest-client-v0.0.1-next.36) (2025-06-19)
210
246
 
211
247
 
212
248
  ### Features
213
249
 
214
- * add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
250
+ * add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
215
251
 
216
252
 
217
253
  ### Dependencies
@@ -220,12 +256,12 @@
220
256
  * dependencies
221
257
  * @twin.org/blob-storage-models bumped from 0.0.1-next.35 to 0.0.1-next.36
222
258
 
223
- ## [0.0.1-next.35](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.34...blob-storage-rest-client-v0.0.1-next.35) (2025-06-17)
259
+ ## [0.0.1-next.35](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.1-next.34...blob-storage-rest-client-v0.0.1-next.35) (2025-06-17)
224
260
 
225
261
 
226
262
  ### Features
227
263
 
228
- * additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
264
+ * additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
229
265
 
230
266
 
231
267
  ### Dependencies
@@ -234,12 +270,12 @@
234
270
  * dependencies
235
271
  * @twin.org/blob-storage-models bumped from 0.0.1-next.34 to 0.0.1-next.35
236
272
 
237
- ## [0.0.1-next.34](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.33...blob-storage-rest-client-v0.0.1-next.34) (2025-06-12)
273
+ ## [0.0.1-next.34](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.1-next.33...blob-storage-rest-client-v0.0.1-next.34) (2025-06-12)
238
274
 
239
275
 
240
276
  ### Features
241
277
 
242
- * update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
278
+ * update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
243
279
 
244
280
 
245
281
  ### Dependencies
@@ -248,7 +284,7 @@
248
284
  * dependencies
249
285
  * @twin.org/blob-storage-models bumped from 0.0.1-next.33 to 0.0.1-next.34
250
286
 
251
- ## [0.0.1-next.33](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.32...blob-storage-rest-client-v0.0.1-next.33) (2025-06-03)
287
+ ## [0.0.1-next.33](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.1-next.32...blob-storage-rest-client-v0.0.1-next.33) (2025-06-03)
252
288
 
253
289
 
254
290
  ### Miscellaneous Chores
@@ -262,7 +298,7 @@
262
298
  * dependencies
263
299
  * @twin.org/blob-storage-models bumped from 0.0.1-next.32 to 0.0.1-next.33
264
300
 
265
- ## [0.0.1-next.32](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.31...blob-storage-rest-client-v0.0.1-next.32) (2025-05-28)
301
+ ## [0.0.1-next.32](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.1-next.31...blob-storage-rest-client-v0.0.1-next.32) (2025-05-28)
266
302
 
267
303
 
268
304
  ### Miscellaneous Chores
@@ -276,7 +312,7 @@
276
312
  * dependencies
277
313
  * @twin.org/blob-storage-models bumped from 0.0.1-next.31 to 0.0.1-next.32
278
314
 
279
- ## [0.0.1-next.31](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.30...blob-storage-rest-client-v0.0.1-next.31) (2025-05-08)
315
+ ## [0.0.1-next.31](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.1-next.30...blob-storage-rest-client-v0.0.1-next.31) (2025-05-08)
280
316
 
281
317
 
282
318
  ### Miscellaneous Chores
@@ -290,12 +326,12 @@
290
326
  * dependencies
291
327
  * @twin.org/blob-storage-models bumped from 0.0.1-next.30 to 0.0.1-next.31
292
328
 
293
- ## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.29...blob-storage-rest-client-v0.0.1-next.30) (2025-04-17)
329
+ ## [0.0.1-next.30](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.1-next.29...blob-storage-rest-client-v0.0.1-next.30) (2025-04-17)
294
330
 
295
331
 
296
332
  ### Features
297
333
 
298
- * use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
334
+ * use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
299
335
 
300
336
 
301
337
  ### Dependencies
@@ -304,7 +340,7 @@
304
340
  * dependencies
305
341
  * @twin.org/blob-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
306
342
 
307
- ## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.28...blob-storage-rest-client-v0.0.1-next.29) (2025-03-28)
343
+ ## [0.0.1-next.29](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-rest-client-v0.0.1-next.28...blob-storage-rest-client-v0.0.1-next.29) (2025-03-28)
308
344
 
309
345
 
310
346
  ### Miscellaneous Chores
package/docs/examples.md CHANGED
@@ -1 +1,98 @@
1
- # @twin.org/blob-storage-rest-client - Examples
1
+ # REST Client Examples
2
+
3
+ Use these snippets to create, query, and manage blobs through HTTP endpoints with strongly typed requests and responses.
4
+
5
+ ## BlobStorageRestClient
6
+
7
+ ```typescript
8
+ import { BlobStorageRestClient } from '@twin.org/blob-storage-rest-client';
9
+
10
+ const client = new BlobStorageRestClient({
11
+ endpoint: 'https://api.example.com',
12
+ pathPrefix: '/v1'
13
+ });
14
+
15
+ console.log(client.className()); // BlobStorageRestClient
16
+ ```
17
+
18
+ ```typescript
19
+ import { BlobStorageRestClient } from '@twin.org/blob-storage-rest-client';
20
+
21
+ const client = new BlobStorageRestClient({
22
+ endpoint: 'https://api.example.com',
23
+ pathPrefix: '/v1'
24
+ });
25
+
26
+ const blobId = await client.create(
27
+ 'SGVsbG8gVFdJTiE=',
28
+ 'text/plain',
29
+ 'txt',
30
+ {
31
+ '@context': 'https://schema.org',
32
+ type: 'DigitalDocument',
33
+ name: 'greeting'
34
+ },
35
+ {
36
+ disableEncryption: false,
37
+ namespace: 'tenant-a'
38
+ }
39
+ );
40
+ console.log(blobId); // blob:urn:blob:...
41
+
42
+ const blobEntry = await client.get(blobId, { includeContent: true, decompress: true });
43
+ console.log(blobEntry.encodingFormat); // text/plain
44
+
45
+ await client.update(blobId, 'text/plain', 'txt', {
46
+ '@context': 'https://schema.org',
47
+ type: 'DigitalDocument',
48
+ name: 'greeting-v2'
49
+ });
50
+ console.log(blobId); // blob:urn:blob:...
51
+ ```
52
+
53
+ ```typescript
54
+ import {
55
+ type EntityCondition,
56
+ ComparisonOperator,
57
+ LogicalOperator,
58
+ SortDirection
59
+ } from '@twin.org/entity';
60
+ import type { IBlobStorageEntry } from '@twin.org/blob-storage-models';
61
+ import { BlobStorageRestClient } from '@twin.org/blob-storage-rest-client';
62
+
63
+ const client = new BlobStorageRestClient({
64
+ endpoint: 'https://api.example.com',
65
+ pathPrefix: '/v1'
66
+ });
67
+
68
+ const conditions: EntityCondition<IBlobStorageEntry> = {
69
+ logicalOperator: LogicalOperator.And,
70
+ conditions: [
71
+ {
72
+ property: 'encodingFormat',
73
+ comparison: ComparisonOperator.Equals,
74
+ value: 'text/plain'
75
+ }
76
+ ]
77
+ };
78
+
79
+ const queryResult = await client.query(conditions, 'dateCreated', SortDirection.Descending, '', 25);
80
+ console.log(queryResult.entries.itemListElement.length); // 1
81
+ console.log(queryResult.cursor); // eyJwYWdlIjoyfQ==
82
+ ```
83
+
84
+ ```typescript
85
+ import { BlobStorageRestClient } from '@twin.org/blob-storage-rest-client';
86
+
87
+ const client = new BlobStorageRestClient({
88
+ endpoint: 'https://api.example.com',
89
+ pathPrefix: '/v1'
90
+ });
91
+
92
+ const blobId = 'blob:urn:blob:file:4ef42bb1b8d31f0c';
93
+ const downloadLink = client.createDownloadLink(blobId, true, 'report.txt');
94
+ console.log(downloadLink); // https://api.example.com/v1/blob/blob:urn:blob:file:4ef42bb1b8d31f0c/content?download=true&filename=report.txt
95
+
96
+ await client.remove(blobId);
97
+ console.log(blobId); // blob:urn:blob:file:4ef42bb1b8d31f0c
98
+ ```
package/docs/reference/classes/BlobStorageRestClient.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**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`): `Promise`\<`string`\>
68
68
 
@@ -128,7 +128,7 @@ The id of the stored blob in urn format.
128
128
 
129
129
  ***
130
130
 
131
- ### get()
131
+ ### get() {#get}
132
132
 
133
133
  > **get**(`id`, `options?`): `Promise`\<`IBlobStorageEntry`\>
134
134
 
@@ -180,7 +180,7 @@ Not found error if the blob cannot be found.
180
180
 
181
181
  ***
182
182
 
183
- ### update()
183
+ ### update() {#update}
184
184
 
185
185
  > **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`): `Promise`\<`void`\>
186
186
 
@@ -228,7 +228,7 @@ Not found error if the blob cannot be found.
228
228
 
229
229
  ***
230
230
 
231
- ### remove()
231
+ ### remove() {#remove}
232
232
 
233
233
  > **remove**(`id`): `Promise`\<`void`\>
234
234
 
@@ -254,7 +254,7 @@ Nothing.
254
254
 
255
255
  ***
256
256
 
257
- ### query()
257
+ ### query() {#query}
258
258
 
259
259
  > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IBlobStorageEntryList`; `cursor?`: `string`; \}\>
260
260
 
@@ -270,9 +270,9 @@ The conditions to match for the entries.
270
270
 
271
271
  ##### orderBy?
272
272
 
273
- The order for the results, defaults to created.
273
+ `"dateCreated"` \| `"dateModified"`
274
274
 
275
- `"dateCreated"` | `"dateModified"`
275
+ The order for the results, defaults to created.
276
276
 
277
277
  ##### orderByDirection?
278
278
 
@@ -305,7 +305,7 @@ and a cursor which can be used to request more entities.
305
305
 
306
306
  ***
307
307
 
308
- ### createDownloadLink()
308
+ ### createDownloadLink() {#createdownloadlink}
309
309
 
310
310
  > **createDownloadLink**(`id`, `download?`, `filename?`): `string`
311
311
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-rest-client",
3
- "version": "0.0.3-next.7",
4
- "description": "Blob storage implementation which can connect to REST endpoints",
3
+ "version": "0.0.3-next.9",
4
+ "description": "Offers client utilities for calling blob service endpoints with consistent request handling.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/blob-storage.git",
7
+ "url": "git+https://github.com/iotaledger/blob-storage.git",
8
8
  "directory": "packages/blob-storage-rest-client"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -16,7 +16,7 @@
16
16
  "dependencies": {
17
17
  "@twin.org/api-core": "next",
18
18
  "@twin.org/api-models": "next",
19
- "@twin.org/blob-storage-models": "0.0.3-next.7",
19
+ "@twin.org/blob-storage-models": "0.0.3-next.9",
20
20
  "@twin.org/core": "next",
21
21
  "@twin.org/data-json-ld": "next",
22
22
  "@twin.org/entity": "next",
@@ -52,7 +52,7 @@
52
52
  "binary"
53
53
  ],
54
54
  "bugs": {
55
- "url": "git+https://github.com/twinfoundation/blob-storage/issues"
55
+ "url": "git+https://github.com/iotaledger/blob-storage/issues"
56
56
  },
57
57
  "homepage": "https://twindev.org"
58
58
  }