@twin.org/blob-storage-rest-client 0.0.1-next.29 → 0.0.1-next.30

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 (3) hide show
  1. package/docs/changelog.md +14 -0
  2. package/docs/reference/classes/BlobStorageClient.md +7 -7
  3. package/package.json +2 -2
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @twin.org/blob-storage-rest-client - Changelog
2
2
 
3
+ ## [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)
4
+
5
+
6
+ ### Features
7
+
8
+ * use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
16
+
3
17
  ## [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)
4
18
 
5
19
 
package/docs/reference/classes/BlobStorageClient.md CHANGED
@@ -12,9 +12,9 @@ Client for performing blob storage through to REST endpoints.
12
12
 
13
13
  ## Constructors
14
14
 
15
- ### new BlobStorageClient()
15
+ ### Constructor
16
16
 
17
- > **new BlobStorageClient**(`config`): [`BlobStorageClient`](BlobStorageClient.md)
17
+ > **new BlobStorageClient**(`config`): `BlobStorageClient`
18
18
 
19
19
  Create a new instance of BlobStorageClient.
20
20
 
@@ -28,7 +28,7 @@ The configuration for the client.
28
28
 
29
29
  #### Returns
30
30
 
31
- [`BlobStorageClient`](BlobStorageClient.md)
31
+ `BlobStorageClient`
32
32
 
33
33
  #### Overrides
34
34
 
@@ -50,7 +50,7 @@ Runtime name for the class.
50
50
 
51
51
  ### create()
52
52
 
53
- > **create**(`blob`, `encodingFormat`?, `fileExtension`?, `metadata`?, `namespace`?): `Promise`\<`string`\>
53
+ > **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `namespace?`): `Promise`\<`string`\>
54
54
 
55
55
  Create the blob with some metadata.
56
56
 
@@ -136,7 +136,7 @@ Not found error if the blob cannot be found.
136
136
 
137
137
  ### update()
138
138
 
139
- > **update**(`id`, `encodingFormat`?, `fileExtension`?, `metadata`?): `Promise`\<`void`\>
139
+ > **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`): `Promise`\<`void`\>
140
140
 
141
141
  Update the blob with metadata.
142
142
 
@@ -210,7 +210,7 @@ Nothing.
210
210
 
211
211
  ### query()
212
212
 
213
- > **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `cursor`?, `pageSize`?): `Promise`\<`IBlobStorageEntryList`\>
213
+ > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`): `Promise`\<`IBlobStorageEntryList`\>
214
214
 
215
215
  Query all the blob storage entries which match the conditions.
216
216
 
@@ -261,7 +261,7 @@ and a cursor which can be used to request more entities.
261
261
 
262
262
  ### createDownloadLink()
263
263
 
264
- > **createDownloadLink**(`id`, `download`?, `filename`?): `string`
264
+ > **createDownloadLink**(`id`, `download?`, `filename?`): `string`
265
265
 
266
266
  Create a download link for the blob.
267
267
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-rest-client",
3
- "version": "0.0.1-next.29",
3
+ "version": "0.0.1-next.30",
4
4
  "description": "Blob storage implementation which can connect to REST endpoints",
5
5
  "repository": {
6
6
  "type": "git",
@@ -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.1-next.29",
19
+ "@twin.org/blob-storage-models": "0.0.1-next.30",
20
20
  "@twin.org/core": "next",
21
21
  "@twin.org/data-json-ld": "next",
22
22
  "@twin.org/entity": "next",