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

package/dist/cjs/index.cjs

@@ -33,10 +33,13 @@ class BlobStorageClient extends apiCore.BaseRestClient {
      * @param encodingFormat Mime type for the blob, will be detected if left undefined.
      * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
-     * @param namespace The namespace to use for storing, defaults to component configured namespace.
+     * @param options Optional options for the creation of the blob.
+     * @param options.disableEncryption Disables encryption if enabled by default.
+     * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.
+     * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
      * @returns The id of the stored blob in urn format.
      */
-    async create(blob, encodingFormat, fileExtension, metadata, namespace) {
+    async create(blob, encodingFormat, fileExtension, metadata, options) {
         core.Guards.stringBase64(this.CLASS_NAME, "blob", blob);
         const response = await this.fetch("/", "POST", {
             body: {
@@ -44,7 +47,9 @@ class BlobStorageClient extends apiCore.BaseRestClient {
                 encodingFormat,
                 fileExtension,
                 metadata,
-                namespace
+                disableEncryption: options?.disableEncryption,
+                overrideVaultKeyId: options?.overrideVaultKeyId,
+                namespace: options?.namespace
             }
         });
         return response.headers[web.HeaderTypes.Location];
@@ -52,11 +57,14 @@ class BlobStorageClient extends apiCore.BaseRestClient {
     /**
      * Get the blob and metadata.
      * @param id The id of the blob to get in urn format.
-     * @param includeContent Include the content, or just get the metadata.
+     * @param options Optional options for the retrieval of the blob.
+     * @param options.includeContent Include the content, or just get the metadata.
+     * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
+     * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
      * @returns The metadata and data for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
-    async get(id, includeContent) {
+    async get(id, options) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
             headers: {
@@ -66,7 +74,9 @@ class BlobStorageClient extends apiCore.BaseRestClient {
                 id
             },
             query: {
-                includeContent
+                includeContent: core.Coerce.string(options?.includeContent),
+                decompress: core.Coerce.string(options?.decompress),
+                overrideVaultKeyId: options?.overrideVaultKeyId
             }
         });
         return response.body;

package/dist/esm/index.mjs

@@ -1,6 +1,6 @@
 import { BaseRestClient } from '@twin.org/api-core';
 import { HttpParameterHelper } from '@twin.org/api-models';
-import { Guards, Urn, StringHelper, Is } from '@twin.org/core';
+import { Guards, Urn, Coerce, StringHelper, Is } from '@twin.org/core';
 import { HeaderTypes, MimeTypes } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
@@ -31,10 +31,13 @@ class BlobStorageClient extends BaseRestClient {
      * @param encodingFormat Mime type for the blob, will be detected if left undefined.
      * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
-     * @param namespace The namespace to use for storing, defaults to component configured namespace.
+     * @param options Optional options for the creation of the blob.
+     * @param options.disableEncryption Disables encryption if enabled by default.
+     * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.
+     * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
      * @returns The id of the stored blob in urn format.
      */
-    async create(blob, encodingFormat, fileExtension, metadata, namespace) {
+    async create(blob, encodingFormat, fileExtension, metadata, options) {
         Guards.stringBase64(this.CLASS_NAME, "blob", blob);
         const response = await this.fetch("/", "POST", {
             body: {
@@ -42,7 +45,9 @@ class BlobStorageClient extends BaseRestClient {
                 encodingFormat,
                 fileExtension,
                 metadata,
-                namespace
+                disableEncryption: options?.disableEncryption,
+                overrideVaultKeyId: options?.overrideVaultKeyId,
+                namespace: options?.namespace
             }
         });
         return response.headers[HeaderTypes.Location];
@@ -50,11 +55,14 @@ class BlobStorageClient extends BaseRestClient {
     /**
      * Get the blob and metadata.
      * @param id The id of the blob to get in urn format.
-     * @param includeContent Include the content, or just get the metadata.
+     * @param options Optional options for the retrieval of the blob.
+     * @param options.includeContent Include the content, or just get the metadata.
+     * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
+     * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
      * @returns The metadata and data for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
-    async get(id, includeContent) {
+    async get(id, options) {
         Urn.guard(this.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
             headers: {
@@ -64,7 +72,9 @@ class BlobStorageClient extends BaseRestClient {
                 id
             },
             query: {
-                includeContent
+                includeContent: Coerce.string(options?.includeContent),
+                decompress: Coerce.string(options?.decompress),
+                overrideVaultKeyId: options?.overrideVaultKeyId
             }
         });
         return response.body;

package/dist/types/blobStorageClient.d.ts

@@ -22,18 +22,32 @@ export declare class BlobStorageClient extends BaseRestClient implements IBlobSt
      * @param encodingFormat Mime type for the blob, will be detected if left undefined.
      * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
-     * @param namespace The namespace to use for storing, defaults to component configured namespace.
+     * @param options Optional options for the creation of the blob.
+     * @param options.disableEncryption Disables encryption if enabled by default.
+     * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.
+     * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
      * @returns The id of the stored blob in urn format.
      */
-    create(blob: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, namespace?: string): Promise<string>;
+    create(blob: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, options?: {
+        disableEncryption?: boolean;
+        overrideVaultKeyId?: string;
+        namespace?: string;
+    }): Promise<string>;
     /**
      * Get the blob and metadata.
      * @param id The id of the blob to get in urn format.
-     * @param includeContent Include the content, or just get the metadata.
+     * @param options Optional options for the retrieval of the blob.
+     * @param options.includeContent Include the content, or just get the metadata.
+     * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
+     * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
      * @returns The metadata and data for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
-    get(id: string, includeContent: boolean): Promise<IBlobStorageEntry>;
+    get(id: string, options?: {
+        includeContent?: boolean;
+        decompress?: boolean;
+        overrideVaultKeyId?: string;
+    }): Promise<IBlobStorageEntry>;
     /**
      * Update the blob with metadata.
      * @param id The id of the blob metadata to update.

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/blob-storage-rest-client - Changelog
 
+## [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)
+
+
+### Features
+
+* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.35 to 0.0.1-next.36
+
+## [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)
+
+
+### Features
+
+* additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+
 ## [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)
 
 

package/docs/reference/classes/BlobStorageClient.md

@@ -50,7 +50,7 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `namespace?`): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`): `Promise`\<`string`\>
 
 Create the blob with some metadata.
 
@@ -80,7 +80,23 @@ Extension for the blob, will be detected if left undefined.
 
 Data for the custom metadata as JSON-LD.
 
-##### namespace?
+##### options?
+
+Optional options for the creation of the blob.
+
+###### disableEncryption?
+
+`boolean`
+
+Disables encryption if enabled by default.
+
+###### overrideVaultKeyId?
+
+`string`
+
+Use a different vault key id for encryption, if not provided the default vault key id will be used.
+
+###### namespace?
 
 `string`
 
@@ -100,7 +116,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `includeContent`): `Promise`\<`IBlobStorageEntry`\>
+> **get**(`id`, `options?`): `Promise`\<`IBlobStorageEntry`\>
 
 Get the blob and metadata.
 
@@ -112,12 +128,28 @@ Get the blob and metadata.
 
 The id of the blob to get in urn format.
 
-##### includeContent
+##### options?
+
+Optional options for the retrieval of the blob.
+
+###### includeContent?
 
 `boolean`
 
 Include the content, or just get the metadata.
 
+###### decompress?
+
+`boolean`
+
+If the content should be decompressed, if it was compressed when stored, defaults to true.
+
+###### overrideVaultKeyId?
+
+`string`
+
+Use a different vault key id for decryption, if not provided the default vault key id will be used.
+
 #### Returns
 
 `Promise`\<`IBlobStorageEntry`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-rest-client",
-	"version": "0.0.1-next.34",
+	"version": "0.0.1-next.36",
 	"description": "Blob storage implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,7 @@
 	"dependencies": {
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
-		"@twin.org/blob-storage-models": "0.0.1-next.34",
+		"@twin.org/blob-storage-models": "0.0.1-next.36",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",