@twin.org/blob-storage-service 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 (9) hide show
  1. package/README.md +1 -1
  2. package/docs/changelog.md +125 -67
  3. package/docs/examples.md +109 -1
  4. package/docs/open-api/spec.json +29 -64
  5. package/docs/reference/classes/BlobStorageEntry.md +15 -15
  6. package/docs/reference/classes/BlobStorageService.md +9 -9
  7. package/docs/reference/interfaces/IBlobStorageServiceConfig.md +4 -4
  8. package/docs/reference/interfaces/IBlobStorageServiceConstructorOptions.md +6 -6
  9. package/package.json +5 -5
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TWIN Blob Storage Service
2
2
 
3
- Blob storage contract implementation and REST endpoint definitions.
3
+ This package exposes service-side components and endpoint definitions for blob upload, retrieval, and management operations. It bridges shared blob models with application service layers so APIs can be published with consistent behaviour.
4
4
 
5
5
  ## Installation
6
6
 
package/docs/changelog.md CHANGED
@@ -1,11 +1,69 @@
1
- # @twin.org/blob-storage-service - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.7](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.3-next.6...blob-storage-service-v0.0.3-next.7) (2026-02-25)
3
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.3-next.8...blob-storage-service-v0.0.3-next.9) (2026-05-07)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
8
- * update schemas ([6fe6571](https://github.com/twinfoundation/blob-storage/commit/6fe65714e23209cdd760ecd5aa8e18762044e4b3))
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 ts-to-jsonld-context tool ([2fd217f](https://github.com/iotaledger/twin-blob-storage/commit/2fd217f50dfaf6ac068091876237f5a101a7995e))
11
+ * add validate-locales ([f20fcec](https://github.com/iotaledger/twin-blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
12
+ * additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
13
+ * blobHash changed to integrity ([#41](https://github.com/iotaledger/twin-blob-storage/issues/41)) ([c06a55f](https://github.com/iotaledger/twin-blob-storage/commit/c06a55f0eed3f7cad5d19c4084abd8ef0cdbfb60))
14
+ * eslint migration to flat config ([e4239dd](https://github.com/iotaledger/twin-blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
15
+ * remove includeNodeIdentity flag ([13bc334](https://github.com/iotaledger/twin-blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
16
+ * remove unused namespace ([6376433](https://github.com/iotaledger/twin-blob-storage/commit/637643399ffa42dbf6af07e7579e82e392ac90c9))
17
+ * 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))
18
+ * update contexts ([#34](https://github.com/iotaledger/twin-blob-storage/issues/34)) ([b9e432c](https://github.com/iotaledger/twin-blob-storage/commit/b9e432c26025e4bfdf5ba837516dfdbf40f45a61))
19
+ * update contexts and namespaces ([#32](https://github.com/iotaledger/twin-blob-storage/issues/32)) ([187ed36](https://github.com/iotaledger/twin-blob-storage/commit/187ed36a7d83062665f70689ec5e2b2f553a592e))
20
+ * update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
21
+ * update framework core ([ff339fe](https://github.com/iotaledger/twin-blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
22
+ * update naming ([19d160f](https://github.com/iotaledger/twin-blob-storage/commit/19d160f6c2b155a1a19b85f4d676cbc15c0f0869))
23
+ * update schemas ([6fe6571](https://github.com/iotaledger/twin-blob-storage/commit/6fe65714e23209cdd760ecd5aa8e18762044e4b3))
24
+ * update to support fully qualified data type names ([3297d69](https://github.com/iotaledger/twin-blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
25
+ * use new hosting url for cursor links ([6844126](https://github.com/iotaledger/twin-blob-storage/commit/6844126e1c431448de51225392daa3559776fdf3))
26
+ * use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
27
+ * use standard list json ld types ([d6bdfd6](https://github.com/iotaledger/twin-blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
28
+
29
+
30
+ ### Bug Fixes
31
+
32
+ * Adding the optional flag to the entity ([#10](https://github.com/iotaledger/twin-blob-storage/issues/10)) ([626677e](https://github.com/iotaledger/twin-blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
33
+ * api docs ([0f5d3ad](https://github.com/iotaledger/twin-blob-storage/commit/0f5d3ad88c4c048495ffd64886d00ceb25a976d6))
34
+ * query params force coercion ([a5e547a](https://github.com/iotaledger/twin-blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
35
+
36
+
37
+ ### Dependencies
38
+
39
+ * The following workspace dependencies were updated
40
+ * dependencies
41
+ * @twin.org/blob-storage-models bumped from 0.0.3-next.8 to 0.0.3-next.9
42
+ * devDependencies
43
+ * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.8 to 0.0.3-next.9
44
+
45
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.3-next.7...blob-storage-service-v0.0.3-next.8) (2026-05-07)
46
+
47
+
48
+ ### Miscellaneous Chores
49
+
50
+ * **blob-storage-service:** Synchronize repo versions
51
+
52
+
53
+ ### Dependencies
54
+
55
+ * The following workspace dependencies were updated
56
+ * dependencies
57
+ * @twin.org/blob-storage-models bumped from 0.0.3-next.7 to 0.0.3-next.8
58
+ * devDependencies
59
+ * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.7 to 0.0.3-next.8
60
+
61
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.3-next.6...blob-storage-service-v0.0.3-next.7) (2026-02-25)
62
+
63
+
64
+ ### Features
65
+
66
+ * update schemas ([6fe6571](https://github.com/iotaledger/twin-blob-storage/commit/6fe65714e23209cdd760ecd5aa8e18762044e4b3))
9
67
 
10
68
 
11
69
  ### Dependencies
@@ -16,14 +74,14 @@
16
74
  * devDependencies
17
75
  * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.6 to 0.0.3-next.7
18
76
 
19
- ## [0.0.3-next.6](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.3-next.5...blob-storage-service-v0.0.3-next.6) (2026-02-09)
77
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.3-next.5...blob-storage-service-v0.0.3-next.6) (2026-02-09)
20
78
 
21
79
 
22
80
  ### Features
23
81
 
24
- * add ts-to-jsonld-context tool ([2fd217f](https://github.com/twinfoundation/blob-storage/commit/2fd217f50dfaf6ac068091876237f5a101a7995e))
25
- * blobHash changed to integrity ([#41](https://github.com/twinfoundation/blob-storage/issues/41)) ([c06a55f](https://github.com/twinfoundation/blob-storage/commit/c06a55f0eed3f7cad5d19c4084abd8ef0cdbfb60))
26
- * update naming ([19d160f](https://github.com/twinfoundation/blob-storage/commit/19d160f6c2b155a1a19b85f4d676cbc15c0f0869))
82
+ * add ts-to-jsonld-context tool ([2fd217f](https://github.com/iotaledger/twin-blob-storage/commit/2fd217f50dfaf6ac068091876237f5a101a7995e))
83
+ * blobHash changed to integrity ([#41](https://github.com/iotaledger/twin-blob-storage/issues/41)) ([c06a55f](https://github.com/iotaledger/twin-blob-storage/commit/c06a55f0eed3f7cad5d19c4084abd8ef0cdbfb60))
84
+ * update naming ([19d160f](https://github.com/iotaledger/twin-blob-storage/commit/19d160f6c2b155a1a19b85f4d676cbc15c0f0869))
27
85
 
28
86
 
29
87
  ### Dependencies
@@ -34,12 +92,12 @@
34
92
  * devDependencies
35
93
  * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.5 to 0.0.3-next.6
36
94
 
37
- ## [0.0.3-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.3-next.4...blob-storage-service-v0.0.3-next.5) (2026-01-26)
95
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.3-next.4...blob-storage-service-v0.0.3-next.5) (2026-01-26)
38
96
 
39
97
 
40
98
  ### Features
41
99
 
42
- * use new hosting url for cursor links ([6844126](https://github.com/twinfoundation/blob-storage/commit/6844126e1c431448de51225392daa3559776fdf3))
100
+ * use new hosting url for cursor links ([6844126](https://github.com/iotaledger/twin-blob-storage/commit/6844126e1c431448de51225392daa3559776fdf3))
43
101
 
44
102
 
45
103
  ### Dependencies
@@ -50,12 +108,12 @@
50
108
  * devDependencies
51
109
  * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.4 to 0.0.3-next.5
52
110
 
53
- ## [0.0.3-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.3-next.3...blob-storage-service-v0.0.3-next.4) (2026-01-23)
111
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.3-next.3...blob-storage-service-v0.0.3-next.4) (2026-01-23)
54
112
 
55
113
 
56
114
  ### Features
57
115
 
58
- * replace nextItem property with Link header ([#37](https://github.com/twinfoundation/blob-storage/issues/37)) ([0b68da5](https://github.com/twinfoundation/blob-storage/commit/0b68da58549c9e52eb2313ea5a868573840d5ca6))
116
+ * 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))
59
117
 
60
118
 
61
119
  ### Dependencies
@@ -66,12 +124,12 @@
66
124
  * devDependencies
67
125
  * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.3 to 0.0.3-next.4
68
126
 
69
- ## [0.0.3-next.3](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.3-next.2...blob-storage-service-v0.0.3-next.3) (2026-01-21)
127
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.3-next.2...blob-storage-service-v0.0.3-next.3) (2026-01-21)
70
128
 
71
129
 
72
130
  ### Features
73
131
 
74
- * update contexts ([#34](https://github.com/twinfoundation/blob-storage/issues/34)) ([b9e432c](https://github.com/twinfoundation/blob-storage/commit/b9e432c26025e4bfdf5ba837516dfdbf40f45a61))
132
+ * update contexts ([#34](https://github.com/iotaledger/twin-blob-storage/issues/34)) ([b9e432c](https://github.com/iotaledger/twin-blob-storage/commit/b9e432c26025e4bfdf5ba837516dfdbf40f45a61))
75
133
 
76
134
 
77
135
  ### Dependencies
@@ -82,17 +140,17 @@
82
140
  * devDependencies
83
141
  * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.2 to 0.0.3-next.3
84
142
 
85
- ## [0.0.3-next.2](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.3-next.1...blob-storage-service-v0.0.3-next.2) (2026-01-14)
143
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.3-next.1...blob-storage-service-v0.0.3-next.2) (2026-01-14)
86
144
 
87
145
 
88
146
  ### Features
89
147
 
90
- * update contexts and namespaces ([#32](https://github.com/twinfoundation/blob-storage/issues/32)) ([187ed36](https://github.com/twinfoundation/blob-storage/commit/187ed36a7d83062665f70689ec5e2b2f553a592e))
148
+ * update contexts and namespaces ([#32](https://github.com/iotaledger/twin-blob-storage/issues/32)) ([187ed36](https://github.com/iotaledger/twin-blob-storage/commit/187ed36a7d83062665f70689ec5e2b2f553a592e))
91
149
 
92
150
 
93
151
  ### Bug Fixes
94
152
 
95
- * api docs ([0f5d3ad](https://github.com/twinfoundation/blob-storage/commit/0f5d3ad88c4c048495ffd64886d00ceb25a976d6))
153
+ * api docs ([0f5d3ad](https://github.com/iotaledger/twin-blob-storage/commit/0f5d3ad88c4c048495ffd64886d00ceb25a976d6))
96
154
 
97
155
 
98
156
  ### Dependencies
@@ -103,29 +161,29 @@
103
161
  * devDependencies
104
162
  * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.1 to 0.0.3-next.2
105
163
 
106
- ## [0.0.3-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.3-next.0...blob-storage-service-v0.0.3-next.1) (2025-11-11)
164
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.3-next.0...blob-storage-service-v0.0.3-next.1) (2025-11-11)
107
165
 
108
166
 
109
167
  ### Features
110
168
 
111
- * add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
112
- * add context id features ([#30](https://github.com/twinfoundation/blob-storage/issues/30)) ([fbf1c92](https://github.com/twinfoundation/blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
113
- * add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
114
- * additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
115
- * eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
116
- * remove includeNodeIdentity flag ([13bc334](https://github.com/twinfoundation/blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
117
- * remove unused namespace ([6376433](https://github.com/twinfoundation/blob-storage/commit/637643399ffa42dbf6af07e7579e82e392ac90c9))
118
- * update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
119
- * update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
120
- * update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
121
- * use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
122
- * use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
169
+ * add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
170
+ * add context id features ([#30](https://github.com/iotaledger/twin-blob-storage/issues/30)) ([fbf1c92](https://github.com/iotaledger/twin-blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
171
+ * add validate-locales ([f20fcec](https://github.com/iotaledger/twin-blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
172
+ * additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
173
+ * eslint migration to flat config ([e4239dd](https://github.com/iotaledger/twin-blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
174
+ * remove includeNodeIdentity flag ([13bc334](https://github.com/iotaledger/twin-blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
175
+ * remove unused namespace ([6376433](https://github.com/iotaledger/twin-blob-storage/commit/637643399ffa42dbf6af07e7579e82e392ac90c9))
176
+ * update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
177
+ * update framework core ([ff339fe](https://github.com/iotaledger/twin-blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
178
+ * update to support fully qualified data type names ([3297d69](https://github.com/iotaledger/twin-blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
179
+ * use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
180
+ * use standard list json ld types ([d6bdfd6](https://github.com/iotaledger/twin-blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
123
181
 
124
182
 
125
183
  ### Bug Fixes
126
184
 
127
- * Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
128
- * query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
185
+ * Adding the optional flag to the entity ([#10](https://github.com/iotaledger/twin-blob-storage/issues/10)) ([626677e](https://github.com/iotaledger/twin-blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
186
+ * query params force coercion ([a5e547a](https://github.com/iotaledger/twin-blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
129
187
 
130
188
 
131
189
  ### Dependencies
@@ -136,12 +194,12 @@
136
194
  * devDependencies
137
195
  * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.0 to 0.0.3-next.1
138
196
 
139
- ## [0.0.2-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.2-next.4...blob-storage-service-v0.0.2-next.5) (2025-10-09)
197
+ ## [0.0.2-next.5](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.2-next.4...blob-storage-service-v0.0.2-next.5) (2025-10-09)
140
198
 
141
199
 
142
200
  ### Features
143
201
 
144
- * add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
202
+ * add validate-locales ([f20fcec](https://github.com/iotaledger/twin-blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
145
203
 
146
204
 
147
205
  ### Dependencies
@@ -152,7 +210,7 @@
152
210
  * devDependencies
153
211
  * @twin.org/blob-storage-connector-memory bumped from 0.0.2-next.4 to 0.0.2-next.5
154
212
 
155
- ## [0.0.2-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.2-next.3...blob-storage-service-v0.0.2-next.4) (2025-10-02)
213
+ ## [0.0.2-next.4](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.2-next.3...blob-storage-service-v0.0.2-next.4) (2025-10-02)
156
214
 
157
215
 
158
216
  ### Miscellaneous Chores
@@ -168,12 +226,12 @@
168
226
  * devDependencies
169
227
  * @twin.org/blob-storage-connector-memory bumped from 0.0.2-next.3 to 0.0.2-next.4
170
228
 
171
- ## [0.0.2-next.3](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.2-next.2...blob-storage-service-v0.0.2-next.3) (2025-08-29)
229
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.2-next.2...blob-storage-service-v0.0.2-next.3) (2025-08-29)
172
230
 
173
231
 
174
232
  ### Features
175
233
 
176
- * eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
234
+ * eslint migration to flat config ([e4239dd](https://github.com/iotaledger/twin-blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
177
235
 
178
236
 
179
237
  ### Dependencies
@@ -184,12 +242,12 @@
184
242
  * devDependencies
185
243
  * @twin.org/blob-storage-connector-memory bumped from 0.0.2-next.2 to 0.0.2-next.3
186
244
 
187
- ## [0.0.2-next.2](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.2-next.1...blob-storage-service-v0.0.2-next.2) (2025-08-20)
245
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.2-next.1...blob-storage-service-v0.0.2-next.2) (2025-08-20)
188
246
 
189
247
 
190
248
  ### Features
191
249
 
192
- * update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
250
+ * update framework core ([ff339fe](https://github.com/iotaledger/twin-blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
193
251
 
194
252
 
195
253
  ### Dependencies
@@ -200,25 +258,25 @@
200
258
  * devDependencies
201
259
  * @twin.org/blob-storage-connector-memory bumped from 0.0.2-next.1 to 0.0.2-next.2
202
260
 
203
- ## [0.0.2-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.2-next.0...blob-storage-service-v0.0.2-next.1) (2025-07-24)
261
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.2-next.0...blob-storage-service-v0.0.2-next.1) (2025-07-24)
204
262
 
205
263
 
206
264
  ### Features
207
265
 
208
- * add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
209
- * additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
210
- * remove includeNodeIdentity flag ([13bc334](https://github.com/twinfoundation/blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
211
- * remove unused namespace ([6376433](https://github.com/twinfoundation/blob-storage/commit/637643399ffa42dbf6af07e7579e82e392ac90c9))
212
- * update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
213
- * update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
214
- * use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
215
- * use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
266
+ * add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
267
+ * additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
268
+ * remove includeNodeIdentity flag ([13bc334](https://github.com/iotaledger/twin-blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
269
+ * remove unused namespace ([6376433](https://github.com/iotaledger/twin-blob-storage/commit/637643399ffa42dbf6af07e7579e82e392ac90c9))
270
+ * update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
271
+ * update to support fully qualified data type names ([3297d69](https://github.com/iotaledger/twin-blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
272
+ * use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
273
+ * use standard list json ld types ([d6bdfd6](https://github.com/iotaledger/twin-blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
216
274
 
217
275
 
218
276
  ### Bug Fixes
219
277
 
220
- * Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
221
- * query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
278
+ * Adding the optional flag to the entity ([#10](https://github.com/iotaledger/twin-blob-storage/issues/10)) ([626677e](https://github.com/iotaledger/twin-blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
279
+ * query params force coercion ([a5e547a](https://github.com/iotaledger/twin-blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
222
280
 
223
281
 
224
282
  ### Dependencies
@@ -234,7 +292,7 @@
234
292
 
235
293
  ### Features
236
294
 
237
- * release to production ([eacfe75](https://github.com/twinfoundation/blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
295
+ * release to production ([eacfe75](https://github.com/iotaledger/twin-blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
238
296
 
239
297
 
240
298
  ### Dependencies
@@ -245,12 +303,12 @@
245
303
  * devDependencies
246
304
  * @twin.org/blob-storage-connector-memory bumped from ^0.0.0 to ^0.0.1
247
305
 
248
- ## [0.0.1-next.37](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.36...blob-storage-service-v0.0.1-next.37) (2025-06-20)
306
+ ## [0.0.1-next.37](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.1-next.36...blob-storage-service-v0.0.1-next.37) (2025-06-20)
249
307
 
250
308
 
251
309
  ### Bug Fixes
252
310
 
253
- * query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
311
+ * query params force coercion ([a5e547a](https://github.com/iotaledger/twin-blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
254
312
 
255
313
 
256
314
  ### Dependencies
@@ -261,12 +319,12 @@
261
319
  * devDependencies
262
320
  * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.36 to 0.0.1-next.37
263
321
 
264
- ## [0.0.1-next.36](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.35...blob-storage-service-v0.0.1-next.36) (2025-06-19)
322
+ ## [0.0.1-next.36](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.1-next.35...blob-storage-service-v0.0.1-next.36) (2025-06-19)
265
323
 
266
324
 
267
325
  ### Features
268
326
 
269
- * add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
327
+ * add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
270
328
 
271
329
 
272
330
  ### Dependencies
@@ -277,12 +335,12 @@
277
335
  * devDependencies
278
336
  * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.35 to 0.0.1-next.36
279
337
 
280
- ## [0.0.1-next.35](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.34...blob-storage-service-v0.0.1-next.35) (2025-06-17)
338
+ ## [0.0.1-next.35](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.1-next.34...blob-storage-service-v0.0.1-next.35) (2025-06-17)
281
339
 
282
340
 
283
341
  ### Features
284
342
 
285
- * additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
343
+ * additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
286
344
 
287
345
 
288
346
  ### Dependencies
@@ -293,12 +351,12 @@
293
351
  * devDependencies
294
352
  * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.34 to 0.0.1-next.35
295
353
 
296
- ## [0.0.1-next.34](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.33...blob-storage-service-v0.0.1-next.34) (2025-06-12)
354
+ ## [0.0.1-next.34](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.1-next.33...blob-storage-service-v0.0.1-next.34) (2025-06-12)
297
355
 
298
356
 
299
357
  ### Features
300
358
 
301
- * update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
359
+ * update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
302
360
 
303
361
 
304
362
  ### Dependencies
@@ -309,7 +367,7 @@
309
367
  * devDependencies
310
368
  * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.33 to 0.0.1-next.34
311
369
 
312
- ## [0.0.1-next.33](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.32...blob-storage-service-v0.0.1-next.33) (2025-06-03)
370
+ ## [0.0.1-next.33](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.1-next.32...blob-storage-service-v0.0.1-next.33) (2025-06-03)
313
371
 
314
372
 
315
373
  ### Miscellaneous Chores
@@ -325,12 +383,12 @@
325
383
  * devDependencies
326
384
  * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.32 to 0.0.1-next.33
327
385
 
328
- ## [0.0.1-next.32](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.31...blob-storage-service-v0.0.1-next.32) (2025-05-28)
386
+ ## [0.0.1-next.32](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.1-next.31...blob-storage-service-v0.0.1-next.32) (2025-05-28)
329
387
 
330
388
 
331
389
  ### Features
332
390
 
333
- * update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
391
+ * update to support fully qualified data type names ([3297d69](https://github.com/iotaledger/twin-blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
334
392
 
335
393
 
336
394
  ### Dependencies
@@ -341,12 +399,12 @@
341
399
  * devDependencies
342
400
  * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.31 to 0.0.1-next.32
343
401
 
344
- ## [0.0.1-next.31](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.30...blob-storage-service-v0.0.1-next.31) (2025-05-08)
402
+ ## [0.0.1-next.31](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.1-next.30...blob-storage-service-v0.0.1-next.31) (2025-05-08)
345
403
 
346
404
 
347
405
  ### Features
348
406
 
349
- * use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
407
+ * use standard list json ld types ([d6bdfd6](https://github.com/iotaledger/twin-blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
350
408
 
351
409
 
352
410
  ### Dependencies
@@ -357,12 +415,12 @@
357
415
  * devDependencies
358
416
  * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.30 to 0.0.1-next.31
359
417
 
360
- ## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.29...blob-storage-service-v0.0.1-next.30) (2025-04-17)
418
+ ## [0.0.1-next.30](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.1-next.29...blob-storage-service-v0.0.1-next.30) (2025-04-17)
361
419
 
362
420
 
363
421
  ### Features
364
422
 
365
- * use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
423
+ * use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
366
424
 
367
425
 
368
426
  ### Dependencies
@@ -373,12 +431,12 @@
373
431
  * devDependencies
374
432
  * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
375
433
 
376
- ## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.28...blob-storage-service-v0.0.1-next.29) (2025-03-28)
434
+ ## [0.0.1-next.29](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-service-v0.0.1-next.28...blob-storage-service-v0.0.1-next.29) (2025-03-28)
377
435
 
378
436
 
379
437
  ### Bug Fixes
380
438
 
381
- * Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
439
+ * Adding the optional flag to the entity ([#10](https://github.com/iotaledger/twin-blob-storage/issues/10)) ([626677e](https://github.com/iotaledger/twin-blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
382
440
 
383
441
 
384
442
  ### Dependencies
package/docs/examples.md CHANGED
@@ -1 +1,109 @@
1
- # @twin.org/blob-storage-service - Examples
1
+ # Service Examples
2
+
3
+ Use these snippets to create metadata-rich entries, retrieve stored content, and keep catalogue data consistent over time.
4
+
5
+ ## BlobStorageService
6
+
7
+ ```typescript
8
+ import { BlobStorageService } from '@twin.org/blob-storage-service';
9
+
10
+ const service = new BlobStorageService({
11
+ config: {
12
+ defaultNamespace: 'memory',
13
+ vaultKeyId: 'tenant-main'
14
+ }
15
+ });
16
+
17
+ console.log(service.className()); // BlobStorageService
18
+ ```
19
+
20
+ ```typescript
21
+ import { BlobStorageService } from '@twin.org/blob-storage-service';
22
+
23
+ const service = new BlobStorageService({
24
+ config: {
25
+ defaultNamespace: 'memory'
26
+ }
27
+ });
28
+
29
+ const blobId = await service.create(
30
+ 'SGVsbG8gVFdJTiE=',
31
+ 'text/plain',
32
+ 'txt',
33
+ {
34
+ '@context': 'https://schema.org',
35
+ type: 'DigitalDocument',
36
+ name: 'welcome-note'
37
+ },
38
+ {
39
+ disableEncryption: true,
40
+ namespace: 'memory'
41
+ }
42
+ );
43
+ console.log(blobId); // blob:urn:blob:memory:...
44
+
45
+ const blobEntry = await service.get(blobId, { includeContent: true, decompress: true });
46
+ console.log(blobEntry.blobSize); // 11
47
+ ```
48
+
49
+ ```typescript
50
+ import { BlobStorageService } from '@twin.org/blob-storage-service';
51
+
52
+ const service = new BlobStorageService({
53
+ config: {
54
+ defaultNamespace: 'memory'
55
+ }
56
+ });
57
+
58
+ const blobId = 'blob:urn:blob:memory:7f83b1657ff1fc53';
59
+ await service.update(blobId, 'text/markdown', 'md', {
60
+ '@context': 'https://schema.org',
61
+ type: 'DigitalDocument',
62
+ name: 'release-notes'
63
+ });
64
+ console.log(blobId); // blob:urn:blob:memory:7f83b1657ff1fc53
65
+
66
+ const result = await service.query(
67
+ {
68
+ logicalOperator: 'and',
69
+ conditions: [
70
+ {
71
+ property: 'encodingFormat',
72
+ comparison: 'equals',
73
+ value: 'text/markdown'
74
+ }
75
+ ]
76
+ },
77
+ 'dateCreated',
78
+ 'descending',
79
+ 'eyJwYWdlIjoyfQ==',
80
+ 10
81
+ );
82
+ console.log(result.entries.itemListElement.length); // 1
83
+
84
+ await service.remove(blobId);
85
+ console.log(blobId); // blob:urn:blob:memory:7f83b1657ff1fc53
86
+ ```
87
+
88
+ ## BlobStorageEntry
89
+
90
+ ```typescript
91
+ import type { BlobStorageEntry } from '@twin.org/blob-storage-service';
92
+
93
+ const entry: BlobStorageEntry = {
94
+ id: 'blob:urn:blob:memory:7f83b1657ff1fc53',
95
+ dateCreated: '2026-03-09T12:00:00.000Z',
96
+ blobSize: 2048,
97
+ integrity: 'sha256:ab45f3f0c2b13496',
98
+ encodingFormat: 'application/pdf',
99
+ fileExtension: 'pdf',
100
+ metadata: {
101
+ '@context': 'https://schema.org',
102
+ type: 'DigitalDocument',
103
+ name: 'invoice-2026-03'
104
+ },
105
+ isEncrypted: false
106
+ };
107
+
108
+ console.log(entry.encodingFormat); // application/pdf
109
+ ```
package/docs/open-api/spec.json CHANGED
@@ -149,7 +149,6 @@
149
149
  "in": "query",
150
150
  "required": false,
151
151
  "schema": {
152
- "type": "string",
153
152
  "enum": [
154
153
  "dateCreated",
155
154
  "dateModified"
@@ -915,19 +914,17 @@
915
914
  "components": {
916
915
  "schemas": {
917
916
  "BlobStorageCompressionType": {
917
+ "description": "The types of compression for blob storage data.",
918
918
  "anyOf": [
919
919
  {
920
- "type": "string",
921
920
  "const": "gzip",
922
921
  "description": "Gzip."
923
922
  },
924
923
  {
925
- "type": "string",
926
924
  "const": "deflate",
927
925
  "description": "Deflate."
928
926
  }
929
- ],
930
- "description": "The types of compression for blob storage data."
927
+ ]
931
928
  },
932
929
  "BlobStorageCreateRequest": {
933
930
  "type": "object",
@@ -971,28 +968,26 @@
971
968
  "description": "The body parameters."
972
969
  },
973
970
  "BlobStorageEntry": {
971
+ "description": "Interface describing a blob storage entry.",
974
972
  "type": "object",
975
973
  "properties": {
976
974
  "@context": {
977
975
  "type": "array",
978
- "minItems": 2,
979
- "description": "JSON-LD Context.",
980
976
  "prefixItems": [
981
977
  {
982
- "type": "string",
983
978
  "const": "https://schema.twindev.org/blob-storage/"
984
979
  },
985
980
  {
986
- "type": "string",
987
981
  "const": "https://schema.twindev.org/common/"
988
982
  }
989
983
  ],
990
984
  "items": {
991
985
  "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
992
- }
986
+ },
987
+ "minItems": 2,
988
+ "description": "JSON-LD Context."
993
989
  },
994
990
  "type": {
995
- "type": "string",
996
991
  "const": "BlobStorageEntry",
997
992
  "description": "JSON-LD Type."
998
993
  },
@@ -1002,41 +997,41 @@
1002
997
  },
1003
998
  "dateCreated": {
1004
999
  "type": "string",
1005
- "description": "The date/time when the entry was created. json-ld namespace:schema"
1000
+ "description": "The date/time when the entry was created."
1006
1001
  },
1007
1002
  "dateModified": {
1008
1003
  "type": "string",
1009
- "description": "The date/time when the entry was modified. json-ld namespace:schema"
1004
+ "description": "The date/time when the entry was modified."
1010
1005
  },
1011
1006
  "blobSize": {
1012
1007
  "type": "number",
1013
- "description": "The size of the data in the blob. json-ld type:schema:Integer"
1008
+ "description": "The size of the data in the blob."
1014
1009
  },
1015
1010
  "integrity": {
1016
1011
  "type": "string",
1017
- "description": "The integrity of the data in the blob. json-ld namespace:twin-common"
1012
+ "description": "The integrity of the data in the blob."
1018
1013
  },
1019
1014
  "encodingFormat": {
1020
1015
  "type": "string",
1021
- "description": "The mime type for the blob. json-ld namespace:schema"
1016
+ "description": "The mime type for the blob."
1022
1017
  },
1023
1018
  "isEncrypted": {
1024
1019
  "type": "boolean",
1025
- "description": "Indicates if the blob is encrypted. json-ld type:schema:Boolean"
1020
+ "description": "Indicates if the blob is encrypted."
1026
1021
  },
1027
1022
  "compression": {
1028
1023
  "$ref": "#/components/schemas/BlobStorageCompressionType"
1029
1024
  },
1030
1025
  "fileExtension": {
1031
1026
  "type": "string",
1032
- "description": "The extension. json-ld type:schema:Text"
1027
+ "description": "The extension."
1033
1028
  },
1034
1029
  "metadata": {
1035
1030
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
1036
1031
  },
1037
1032
  "blob": {
1038
1033
  "type": "string",
1039
- "description": "The blob in base64 format, included if the includeContent flag was set in the request. json-ld type:schema:Text"
1034
+ "description": "The blob in base64 format, included if the includeContent flag was set in the request."
1040
1035
  }
1041
1036
  },
1042
1037
  "required": [
@@ -1046,36 +1041,32 @@
1046
1041
  "dateCreated",
1047
1042
  "blobSize",
1048
1043
  "integrity"
1049
- ],
1050
- "description": "Interface describing a blob storage entry."
1044
+ ]
1051
1045
  },
1052
1046
  "BlobStorageEntryList": {
1047
+ "description": "Interface describing an blob storage entry list.",
1053
1048
  "type": "object",
1054
1049
  "properties": {
1055
1050
  "@context": {
1056
1051
  "type": "array",
1057
- "minItems": 3,
1058
- "description": "JSON-LD Context.",
1059
1052
  "prefixItems": [
1060
1053
  {
1061
- "type": "string",
1062
1054
  "const": "https://schema.org"
1063
1055
  },
1064
1056
  {
1065
- "type": "string",
1066
1057
  "const": "https://schema.twindev.org/blob-storage/"
1067
1058
  },
1068
1059
  {
1069
- "type": "string",
1070
1060
  "const": "https://schema.twindev.org/common/"
1071
1061
  }
1072
1062
  ],
1073
1063
  "items": {
1074
1064
  "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
1075
- }
1065
+ },
1066
+ "minItems": 3,
1067
+ "description": "JSON-LD Context."
1076
1068
  },
1077
1069
  "type": {
1078
- "type": "string",
1079
1070
  "const": "ItemList",
1080
1071
  "description": "JSON-LD Type."
1081
1072
  },
@@ -1091,8 +1082,7 @@
1091
1082
  "@context",
1092
1083
  "type",
1093
1084
  "itemListElement"
1094
- ],
1095
- "description": "Interface describing an blob storage entry list."
1085
+ ]
1096
1086
  },
1097
1087
  "BlobStorageUpdateRequest": {
1098
1088
  "type": "object",
@@ -1112,6 +1102,7 @@
1112
1102
  "description": "The body parameters."
1113
1103
  },
1114
1104
  "Error": {
1105
+ "description": "Model to describe serialized error.",
1115
1106
  "type": "object",
1116
1107
  "properties": {
1117
1108
  "name": {
@@ -1120,7 +1111,7 @@
1120
1111
  },
1121
1112
  "message": {
1122
1113
  "type": "string",
1123
- "description": "The message for the error."
1114
+ "description": "The message for the error as an i18n key."
1124
1115
  },
1125
1116
  "source": {
1126
1117
  "type": "string",
@@ -1142,8 +1133,7 @@
1142
1133
  "required": [
1143
1134
  "name",
1144
1135
  "message"
1145
- ],
1146
- "description": "Model to describe serialized error."
1136
+ ]
1147
1137
  },
1148
1138
  "NotFoundResponse": {
1149
1139
  "type": "object",
@@ -1151,52 +1141,27 @@
1151
1141
  "notFoundId": {
1152
1142
  "type": "string",
1153
1143
  "description": "The id if the item that was not found."
1154
- },
1155
- "name": {
1156
- "type": "string",
1157
- "description": "The name for the error."
1158
- },
1159
- "message": {
1160
- "type": "string",
1161
- "description": "The message for the error."
1162
- },
1163
- "source": {
1164
- "type": "string",
1165
- "description": "The source of the error."
1166
- },
1167
- "properties": {
1168
- "type": "object",
1169
- "additionalProperties": {},
1170
- "description": "Any additional information for the error."
1171
- },
1172
- "stack": {
1173
- "type": "string",
1174
- "description": "The stack trace for the error."
1175
- },
1176
- "cause": {
1177
- "$ref": "#/components/schemas/Error"
1178
1144
  }
1179
1145
  },
1180
- "required": [
1181
- "message",
1182
- "name"
1146
+ "allOf": [
1147
+ {
1148
+ "$ref": "#/components/schemas/Error"
1149
+ }
1183
1150
  ],
1184
1151
  "description": "The body which contains the error."
1185
1152
  },
1186
1153
  "SortDirection": {
1154
+ "description": "The sort directions.",
1187
1155
  "anyOf": [
1188
1156
  {
1189
- "type": "string",
1190
1157
  "const": "asc",
1191
1158
  "description": "Ascending."
1192
1159
  },
1193
1160
  {
1194
- "type": "string",
1195
1161
  "const": "desc",
1196
1162
  "description": "Descending."
1197
1163
  }
1198
- ],
1199
- "description": "The sort directions."
1164
+ ]
1200
1165
  }
1201
1166
  },
1202
1167
  "securitySchemes": {
package/docs/reference/classes/BlobStorageEntry.md CHANGED
@@ -14,7 +14,7 @@ Class representing entry for the blob storage.
14
14
 
15
15
  ## Properties
16
16
 
17
- ### id
17
+ ### id {#id}
18
18
 
19
19
  > **id**: `string`
20
20
 
@@ -22,7 +22,7 @@ The id for the blob.
22
22
 
23
23
  ***
24
24
 
25
- ### dateCreated
25
+ ### dateCreated {#datecreated}
26
26
 
27
27
  > **dateCreated**: `string`
28
28
 
@@ -30,15 +30,15 @@ The date/time when the entry was created.
30
30
 
31
31
  ***
32
32
 
33
- ### dateModified?
33
+ ### dateModified? {#datemodified}
34
34
 
35
- > `optional` **dateModified**: `string`
35
+ > `optional` **dateModified?**: `string`
36
36
 
37
37
  The date/time when the entry was modified.
38
38
 
39
39
  ***
40
40
 
41
- ### blobSize
41
+ ### blobSize {#blobsize}
42
42
 
43
43
  > **blobSize**: `number`
44
44
 
@@ -46,7 +46,7 @@ The length of the data in the blob.
46
46
 
47
47
  ***
48
48
 
49
- ### integrity
49
+ ### integrity {#integrity}
50
50
 
51
51
  > **integrity**: `string`
52
52
 
@@ -54,31 +54,31 @@ The integrity of the data in the blob.
54
54
 
55
55
  ***
56
56
 
57
- ### encodingFormat?
57
+ ### encodingFormat? {#encodingformat}
58
58
 
59
- > `optional` **encodingFormat**: `string`
59
+ > `optional` **encodingFormat?**: `string`
60
60
 
61
61
  The mime type for the blob.
62
62
 
63
63
  ***
64
64
 
65
- ### fileExtension?
65
+ ### fileExtension? {#fileextension}
66
66
 
67
- > `optional` **fileExtension**: `string`
67
+ > `optional` **fileExtension?**: `string`
68
68
 
69
69
  The extension.
70
70
 
71
71
  ***
72
72
 
73
- ### metadata?
73
+ ### metadata? {#metadata}
74
74
 
75
- > `optional` **metadata**: `IJsonLdNodeObject`
75
+ > `optional` **metadata?**: `IJsonLdNodeObject`
76
76
 
77
77
  The metadata for the blob as JSON-LD.
78
78
 
79
79
  ***
80
80
 
81
- ### isEncrypted
81
+ ### isEncrypted {#isencrypted}
82
82
 
83
83
  > **isEncrypted**: `boolean`
84
84
 
@@ -86,8 +86,8 @@ Is the entry encrypted.
86
86
 
87
87
  ***
88
88
 
89
- ### compression?
89
+ ### compression? {#compression}
90
90
 
91
- > `optional` **compression**: `BlobStorageCompressionType`
91
+ > `optional` **compression?**: `BlobStorageCompressionType`
92
92
 
93
93
  Is the entry compressed.
package/docs/reference/classes/BlobStorageService.md CHANGED
@@ -28,7 +28,7 @@ The options for the service.
28
28
 
29
29
  ## Properties
30
30
 
31
- ### CLASS\_NAME
31
+ ### CLASS\_NAME {#class_name}
32
32
 
33
33
  > `readonly` `static` **CLASS\_NAME**: `string`
34
34
 
@@ -36,7 +36,7 @@ Runtime name for the class.
36
36
 
37
37
  ## Methods
38
38
 
39
- ### className()
39
+ ### className() {#classname}
40
40
 
41
41
  > **className**(): `string`
42
42
 
@@ -54,7 +54,7 @@ The class name of the component.
54
54
 
55
55
  ***
56
56
 
57
- ### create()
57
+ ### create() {#create}
58
58
 
59
59
  > **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`): `Promise`\<`string`\>
60
60
 
@@ -126,7 +126,7 @@ The id of the stored blob in urn format.
126
126
 
127
127
  ***
128
128
 
129
- ### get()
129
+ ### get() {#get}
130
130
 
131
131
  > **get**(`id`, `options?`): `Promise`\<`IBlobStorageEntry`\>
132
132
 
@@ -178,7 +178,7 @@ Not found error if the blob cannot be found.
178
178
 
179
179
  ***
180
180
 
181
- ### update()
181
+ ### update() {#update}
182
182
 
183
183
  > **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`): `Promise`\<`void`\>
184
184
 
@@ -226,7 +226,7 @@ Not found error if the blob cannot be found.
226
226
 
227
227
  ***
228
228
 
229
- ### remove()
229
+ ### remove() {#remove}
230
230
 
231
231
  > **remove**(`id`): `Promise`\<`void`\>
232
232
 
@@ -252,7 +252,7 @@ Nothing.
252
252
 
253
253
  ***
254
254
 
255
- ### query()
255
+ ### query() {#query}
256
256
 
257
257
  > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IBlobStorageEntryList`; `cursor?`: `string`; \}\>
258
258
 
@@ -268,9 +268,9 @@ The conditions to match for the entries.
268
268
 
269
269
  ##### orderBy?
270
270
 
271
- The order for the results, defaults to created.
271
+ `"dateCreated"` \| `"dateModified"`
272
272
 
273
- `"dateCreated"` | `"dateModified"`
273
+ The order for the results, defaults to created.
274
274
 
275
275
  ##### orderByDirection?
276
276
 
package/docs/reference/interfaces/IBlobStorageServiceConfig.md CHANGED
@@ -4,17 +4,17 @@ Configuration for the blob storage service.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### vaultKeyId?
7
+ ### vaultKeyId? {#vaultkeyid}
8
8
 
9
- > `optional` **vaultKeyId**: `string`
9
+ > `optional` **vaultKeyId?**: `string`
10
10
 
11
11
  The name of the vault key to use for encryption, if not configured no encryption will happen.
12
12
 
13
13
  ***
14
14
 
15
- ### defaultNamespace?
15
+ ### defaultNamespace? {#defaultnamespace}
16
16
 
17
- > `optional` **defaultNamespace**: `string`
17
+ > `optional` **defaultNamespace?**: `string`
18
18
 
19
19
  The namespace of the default storage connector to use.
20
20
  Defaults to the first entry in the factory if not provided.
package/docs/reference/interfaces/IBlobStorageServiceConstructorOptions.md CHANGED
@@ -4,9 +4,9 @@ Options for the Blob Storage Service constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### entryEntityStorageType?
7
+ ### entryEntityStorageType? {#entryentitystoragetype}
8
8
 
9
- > `optional` **entryEntityStorageType**: `string`
9
+ > `optional` **entryEntityStorageType?**: `string`
10
10
 
11
11
  The type of the storage connector for the metadata.
12
12
 
@@ -18,16 +18,16 @@ blob-storage-entry
18
18
 
19
19
  ***
20
20
 
21
- ### vaultConnectorType?
21
+ ### vaultConnectorType? {#vaultconnectortype}
22
22
 
23
- > `optional` **vaultConnectorType**: `string`
23
+ > `optional` **vaultConnectorType?**: `string`
24
24
 
25
25
  The type of the vault connector for encryption.
26
26
 
27
27
  ***
28
28
 
29
- ### config?
29
+ ### config? {#config}
30
30
 
31
- > `optional` **config**: [`IBlobStorageServiceConfig`](IBlobStorageServiceConfig.md)
31
+ > `optional` **config?**: [`IBlobStorageServiceConfig`](IBlobStorageServiceConfig.md)
32
32
 
33
33
  The configuration for the service.
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-service",
3
- "version": "0.0.3-next.7",
4
- "description": "Blob storage contract implementation and REST endpoint definitions",
3
+ "version": "0.0.3-next.9",
4
+ "description": "Exposes blob operations through service components and HTTP route definitions.",
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-service"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -15,7 +15,7 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/api-models": "next",
18
- "@twin.org/blob-storage-models": "0.0.3-next.7",
18
+ "@twin.org/blob-storage-models": "0.0.3-next.9",
19
19
  "@twin.org/context": "next",
20
20
  "@twin.org/core": "next",
21
21
  "@twin.org/crypto": "next",
@@ -59,7 +59,7 @@
59
59
  "business-logic"
60
60
  ],
61
61
  "bugs": {
62
- "url": "git+https://github.com/twinfoundation/blob-storage/issues"
62
+ "url": "git+https://github.com/iotaledger/blob-storage/issues"
63
63
  },
64
64
  "homepage": "https://twindev.org"
65
65
  }