@twin.org/blob-storage-service 0.0.2-next.5 → 0.0.3-next.1
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/dist/es/blobStorageRoutes.js +528 -0
- package/dist/es/blobStorageRoutes.js.map +1 -0
- package/dist/es/blobStorageService.js +359 -0
- package/dist/es/blobStorageService.js.map +1 -0
- package/dist/es/entities/blobStorageEntry.js +96 -0
- package/dist/es/entities/blobStorageEntry.js.map +1 -0
- package/dist/es/index.js +10 -0
- package/dist/es/index.js.map +1 -0
- package/dist/es/models/IBlobStorageServiceConfig.js +4 -0
- package/dist/es/models/IBlobStorageServiceConfig.js.map +1 -0
- package/dist/es/models/IBlobStorageServiceConstructorOptions.js +2 -0
- package/dist/es/models/IBlobStorageServiceConstructorOptions.js.map +1 -0
- package/dist/es/restEntryPoints.js +15 -0
- package/dist/es/restEntryPoints.js.map +1 -0
- package/dist/es/schema.js +11 -0
- package/dist/es/schema.js.map +1 -0
- package/dist/types/blobStorageService.d.ts +12 -14
- package/dist/types/entities/blobStorageEntry.d.ts +0 -4
- package/dist/types/index.d.ts +7 -7
- package/dist/types/models/IBlobStorageServiceConfig.d.ts +0 -4
- package/dist/types/models/IBlobStorageServiceConstructorOptions.d.ts +1 -1
- package/docs/changelog.md +33 -0
- package/docs/open-api/spec.json +35 -491
- package/docs/reference/classes/BlobStorageEntry.md +0 -8
- package/docs/reference/classes/BlobStorageService.md +24 -48
- package/docs/reference/interfaces/IBlobStorageServiceConfig.md +0 -8
- package/package.json +7 -8
- package/dist/cjs/index.cjs +0 -1084
- package/dist/esm/index.mjs +0 -1072
|
@@ -36,9 +36,27 @@ Runtime name for the class.
|
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
|
39
|
+
### className()
|
|
40
|
+
|
|
41
|
+
> **className**(): `string`
|
|
42
|
+
|
|
43
|
+
Returns the class name of the component.
|
|
44
|
+
|
|
45
|
+
#### Returns
|
|
46
|
+
|
|
47
|
+
`string`
|
|
48
|
+
|
|
49
|
+
The class name of the component.
|
|
50
|
+
|
|
51
|
+
#### Implementation of
|
|
52
|
+
|
|
53
|
+
`IBlobStorageComponent.className`
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
39
57
|
### create()
|
|
40
58
|
|
|
41
|
-
> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options
|
|
59
|
+
> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`): `Promise`\<`string`\>
|
|
42
60
|
|
|
43
61
|
Create the blob with some metadata.
|
|
44
62
|
|
|
@@ -88,7 +106,7 @@ Use a different vault key id for encryption, if not provided the default vault k
|
|
|
88
106
|
|
|
89
107
|
`BlobStorageCompressionType`
|
|
90
108
|
|
|
91
|
-
Optional compression type to use for the blob, defaults to no compression
|
|
109
|
+
Optional compression type to use for the blob, defaults to no compression.
|
|
92
110
|
|
|
93
111
|
###### namespace?
|
|
94
112
|
|
|
@@ -96,18 +114,6 @@ Optional compression type to use for the blob, defaults to no compression.*
|
|
|
96
114
|
|
|
97
115
|
The namespace to use for storing, defaults to component configured namespace.
|
|
98
116
|
|
|
99
|
-
##### userIdentity?
|
|
100
|
-
|
|
101
|
-
`string`
|
|
102
|
-
|
|
103
|
-
The user identity to use with storage operations.
|
|
104
|
-
|
|
105
|
-
##### nodeIdentity?
|
|
106
|
-
|
|
107
|
-
`string`
|
|
108
|
-
|
|
109
|
-
The node identity to use with storage operations.
|
|
110
|
-
|
|
111
117
|
#### Returns
|
|
112
118
|
|
|
113
119
|
`Promise`\<`string`\>
|
|
@@ -122,7 +128,7 @@ The id of the stored blob in urn format.
|
|
|
122
128
|
|
|
123
129
|
### get()
|
|
124
130
|
|
|
125
|
-
> **get**(`id`, `options
|
|
131
|
+
> **get**(`id`, `options?`): `Promise`\<`IBlobStorageEntry`\>
|
|
126
132
|
|
|
127
133
|
Get the blob entry.
|
|
128
134
|
|
|
@@ -156,18 +162,6 @@ If the content should be decompressed, if it was compressed when stored, default
|
|
|
156
162
|
|
|
157
163
|
Use a different vault key id for decryption, if not provided the default vault key id will be used.
|
|
158
164
|
|
|
159
|
-
##### userIdentity?
|
|
160
|
-
|
|
161
|
-
`string`
|
|
162
|
-
|
|
163
|
-
The user identity to use with storage operations.
|
|
164
|
-
|
|
165
|
-
##### nodeIdentity?
|
|
166
|
-
|
|
167
|
-
`string`
|
|
168
|
-
|
|
169
|
-
The node identity to use with storage operations.
|
|
170
|
-
|
|
171
165
|
#### Returns
|
|
172
166
|
|
|
173
167
|
`Promise`\<`IBlobStorageEntry`\>
|
|
@@ -186,7 +180,7 @@ Not found error if the blob cannot be found.
|
|
|
186
180
|
|
|
187
181
|
### update()
|
|
188
182
|
|
|
189
|
-
> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata
|
|
183
|
+
> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`): `Promise`\<`void`\>
|
|
190
184
|
|
|
191
185
|
Update the blob with metadata.
|
|
192
186
|
|
|
@@ -216,12 +210,6 @@ Extension for the blob, will be detected if left undefined.
|
|
|
216
210
|
|
|
217
211
|
Data for the custom metadata as JSON-LD.
|
|
218
212
|
|
|
219
|
-
##### userIdentity?
|
|
220
|
-
|
|
221
|
-
`string`
|
|
222
|
-
|
|
223
|
-
The user identity to use with storage operations.
|
|
224
|
-
|
|
225
213
|
#### Returns
|
|
226
214
|
|
|
227
215
|
`Promise`\<`void`\>
|
|
@@ -240,7 +228,7 @@ Not found error if the blob cannot be found.
|
|
|
240
228
|
|
|
241
229
|
### remove()
|
|
242
230
|
|
|
243
|
-
> **remove**(`id
|
|
231
|
+
> **remove**(`id`): `Promise`\<`void`\>
|
|
244
232
|
|
|
245
233
|
Remove the blob.
|
|
246
234
|
|
|
@@ -252,12 +240,6 @@ Remove the blob.
|
|
|
252
240
|
|
|
253
241
|
The id of the blob to remove in urn format.
|
|
254
242
|
|
|
255
|
-
##### userIdentity?
|
|
256
|
-
|
|
257
|
-
`string`
|
|
258
|
-
|
|
259
|
-
The user identity to use with storage operations.
|
|
260
|
-
|
|
261
243
|
#### Returns
|
|
262
244
|
|
|
263
245
|
`Promise`\<`void`\>
|
|
@@ -272,7 +254,7 @@ Nothing.
|
|
|
272
254
|
|
|
273
255
|
### query()
|
|
274
256
|
|
|
275
|
-
> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit
|
|
257
|
+
> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`): `Promise`\<`IBlobStorageEntryList`\>
|
|
276
258
|
|
|
277
259
|
Query all the blob storage entries which match the conditions.
|
|
278
260
|
|
|
@@ -308,12 +290,6 @@ The cursor to request the next page of entries.
|
|
|
308
290
|
|
|
309
291
|
The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
|
|
310
292
|
|
|
311
|
-
##### userIdentity?
|
|
312
|
-
|
|
313
|
-
`string`
|
|
314
|
-
|
|
315
|
-
The user identity to use with storage operations.
|
|
316
|
-
|
|
317
293
|
#### Returns
|
|
318
294
|
|
|
319
295
|
`Promise`\<`IBlobStorageEntryList`\>
|
|
@@ -18,11 +18,3 @@ The name of the vault key to use for encryption, if not configured no encryption
|
|
|
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.
|
|
21
|
-
|
|
22
|
-
***
|
|
23
|
-
|
|
24
|
-
### partitionPerUser?
|
|
25
|
-
|
|
26
|
-
> `optional` **partitionPerUser**: `boolean`
|
|
27
|
-
|
|
28
|
-
Include the user identity when performing storage operations, allow partitioning per user, defaults to false.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/blob-storage-service",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3-next.1",
|
|
4
4
|
"description": "Blob storage contract implementation and REST endpoint definitions",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -15,7 +15,8 @@
|
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@twin.org/api-models": "next",
|
|
18
|
-
"@twin.org/blob-storage-models": "0.0.
|
|
18
|
+
"@twin.org/blob-storage-models": "0.0.3-next.1",
|
|
19
|
+
"@twin.org/context": "next",
|
|
19
20
|
"@twin.org/core": "next",
|
|
20
21
|
"@twin.org/crypto": "next",
|
|
21
22
|
"@twin.org/data-json-ld": "next",
|
|
@@ -26,20 +27,18 @@
|
|
|
26
27
|
"@twin.org/vault-models": "next",
|
|
27
28
|
"@twin.org/web": "next"
|
|
28
29
|
},
|
|
29
|
-
"main": "./dist/
|
|
30
|
-
"module": "./dist/esm/index.mjs",
|
|
30
|
+
"main": "./dist/es/index.js",
|
|
31
31
|
"types": "./dist/types/index.d.ts",
|
|
32
32
|
"exports": {
|
|
33
33
|
".": {
|
|
34
34
|
"types": "./dist/types/index.d.ts",
|
|
35
|
-
"
|
|
36
|
-
"
|
|
35
|
+
"import": "./dist/es/index.js",
|
|
36
|
+
"default": "./dist/es/index.js"
|
|
37
37
|
},
|
|
38
38
|
"./locales/*.json": "./locales/*.json"
|
|
39
39
|
},
|
|
40
40
|
"files": [
|
|
41
|
-
"dist/
|
|
42
|
-
"dist/esm",
|
|
41
|
+
"dist/es",
|
|
43
42
|
"dist/types",
|
|
44
43
|
"locales",
|
|
45
44
|
"docs"
|