@twin.org/blob-storage-rest-client 0.0.1-next.35 → 0.0.1-next.36

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 (6) hide show
  1. package/dist/cjs/index.cjs +2 -2
  2. package/dist/esm/index.mjs +2 -2
  3. package/dist/types/blobStorageClient.d.ts +2 -2
  4. package/docs/changelog.md +14 -0
  5. package/docs/reference/classes/BlobStorageClient.md +2 -2
  6. package/package.json +2 -2
package/dist/cjs/index.cjs CHANGED
@@ -59,8 +59,8 @@ class BlobStorageClient extends apiCore.BaseRestClient {
59
59
  * @param id The id of the blob to get in urn format.
60
60
  * @param options Optional options for the retrieval of the blob.
61
61
  * @param options.includeContent Include the content, or just get the metadata.
62
- * @param options.disableDecryption Disables decryption if enabled by default.
63
62
  * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
63
+ * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
64
64
  * @returns The metadata and data for the blob if it can be found.
65
65
  * @throws Not found error if the blob cannot be found.
66
66
  */
@@ -75,7 +75,7 @@ class BlobStorageClient extends apiCore.BaseRestClient {
75
75
  },
76
76
  query: {
77
77
  includeContent: core.Coerce.string(options?.includeContent),
78
- disableDecryption: core.Coerce.string(options?.disableDecryption),
78
+ decompress: core.Coerce.string(options?.decompress),
79
79
  overrideVaultKeyId: options?.overrideVaultKeyId
80
80
  }
81
81
  });
package/dist/esm/index.mjs CHANGED
@@ -57,8 +57,8 @@ class BlobStorageClient extends BaseRestClient {
57
57
  * @param id The id of the blob to get in urn format.
58
58
  * @param options Optional options for the retrieval of the blob.
59
59
  * @param options.includeContent Include the content, or just get the metadata.
60
- * @param options.disableDecryption Disables decryption if enabled by default.
61
60
  * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
61
+ * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
62
62
  * @returns The metadata and data for the blob if it can be found.
63
63
  * @throws Not found error if the blob cannot be found.
64
64
  */
@@ -73,7 +73,7 @@ class BlobStorageClient extends BaseRestClient {
73
73
  },
74
74
  query: {
75
75
  includeContent: Coerce.string(options?.includeContent),
76
- disableDecryption: Coerce.string(options?.disableDecryption),
76
+ decompress: Coerce.string(options?.decompress),
77
77
  overrideVaultKeyId: options?.overrideVaultKeyId
78
78
  }
79
79
  });
package/dist/types/blobStorageClient.d.ts CHANGED
@@ -38,14 +38,14 @@ export declare class BlobStorageClient extends BaseRestClient implements IBlobSt
38
38
  * @param id The id of the blob to get in urn format.
39
39
  * @param options Optional options for the retrieval of the blob.
40
40
  * @param options.includeContent Include the content, or just get the metadata.
41
- * @param options.disableDecryption Disables decryption if enabled by default.
42
41
  * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
42
+ * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
43
43
  * @returns The metadata and data for the blob if it can be found.
44
44
  * @throws Not found error if the blob cannot be found.
45
45
  */
46
46
  get(id: string, options?: {
47
47
  includeContent?: boolean;
48
- disableDecryption?: boolean;
48
+ decompress?: boolean;
49
49
  overrideVaultKeyId?: string;
50
50
  }): Promise<IBlobStorageEntry>;
51
51
  /**
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.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)
4
+
5
+
6
+ ### Features
7
+
8
+ * add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
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.35 to 0.0.1-next.36
16
+
3
17
  ## [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)
4
18
 
5
19
 
package/docs/reference/classes/BlobStorageClient.md CHANGED
@@ -138,11 +138,11 @@ Optional options for the retrieval of the blob.
138
138
 
139
139
  Include the content, or just get the metadata.
140
140
 
141
- ###### disableDecryption?
141
+ ###### decompress?
142
142
 
143
143
  `boolean`
144
144
 
145
- Disables decryption if enabled by default.
145
+ If the content should be decompressed, if it was compressed when stored, defaults to true.
146
146
 
147
147
  ###### overrideVaultKeyId?
148
148
 
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.35",
3
+ "version": "0.0.1-next.36",
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.35",
19
+ "@twin.org/blob-storage-models": "0.0.1-next.36",
20
20
  "@twin.org/core": "next",
21
21
  "@twin.org/data-json-ld": "next",
22
22
  "@twin.org/entity": "next",