@twin.org/blob-storage-service 0.0.1-next.35 → 0.0.1-next.37

package/dist/cjs/index.cjs

@@ -427,7 +427,7 @@ async function blobStorageGet(httpRequestContext, componentName, request) {
     const component = core.ComponentFactory.get(componentName);
     const result = await component.get(request.pathParams.id, {
         includeContent: core.Coerce.boolean(request.query?.includeContent),
-        disableDecryption: core.Coerce.boolean(request.query?.disableDecryption),
+        decompress: core.Coerce.boolean(request.query?.decompress),
         overrideVaultKeyId: request.query?.overrideVaultKeyId
     }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
@@ -449,22 +449,34 @@ async function blobStorageGetContent(httpRequestContext, componentName, request)
     core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = core.ComponentFactory.get(componentName);
+    const decompress = core.Coerce.boolean(request.query?.decompress);
+    const download = core.Coerce.boolean(request.query?.download) ?? false;
     const result = await component.get(request.pathParams.id, {
         includeContent: true,
-        disableDecryption: core.Coerce.boolean(request.query?.disableDecryption),
+        decompress,
         overrideVaultKeyId: request.query?.overrideVaultKeyId
     }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     const encodingFormat = result?.encodingFormat ?? web.MimeTypes.OctetStream;
+    let compressedEncodingFormat;
+    let compressedExtension = "";
+    // If the entry is compressed and we are not decompressing
+    // we need to override the encoding format to the compressed type
+    // and append an additional extension to the filename.
+    if (result.compression && !decompress) {
+        compressedEncodingFormat =
+            result.compression === blobStorageModels.BlobStorageCompressionType.Gzip ? web.MimeTypes.Gzip : web.MimeTypes.Zlib;
+        compressedExtension = `.${web.MimeTypeHelper.defaultExtension(compressedEncodingFormat)}`;
+    }
     let filename = request.query?.filename;
     if (!core.Is.stringValue(filename)) {
-        filename = `file.${result.fileExtension ?? web.MimeTypeHelper.defaultExtension(encodingFormat)}`;
+        filename = `file.${result.fileExtension ?? web.MimeTypeHelper.defaultExtension(encodingFormat)}${compressedExtension}`;
     }
     return {
         body: core.Is.stringBase64(result.blob) ? core.Converter.base64ToBytes(result.blob) : new Uint8Array(),
         attachment: {
-            mimeType: encodingFormat,
+            mimeType: compressedEncodingFormat ?? encodingFormat,
             filename,
-            inline: !(request.query?.download ?? false)
+            inline: !download
         }
     };
 }
@@ -595,6 +607,7 @@ class BlobStorageService {
      * @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.compress Optional compression type to use for the blob, defaults to no compression.*
      * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
      * @param userIdentity The user identity to use with storage operations.
      * @param nodeIdentity The node identity to use with storage operations.
@@ -632,6 +645,9 @@ class BlobStorageService {
                 core.Validation.asValidationError(this.CLASS_NAME, "metadata", validationFailures);
             }
             const blobHash = `sha256:${core.Converter.bytesToBase64(crypto.Sha256.sum256(storeBlob))}`;
+            if (!core.Is.empty(options?.compress)) {
+                storeBlob = await core.Compression.compress(storeBlob, options.compress);
+            }
             // If we have a vault connector then encrypt the data.
             if (encryptionEnabled) {
                 if (core.Is.empty(this._vaultConnector)) {
@@ -650,7 +666,8 @@ class BlobStorageService {
                 encodingFormat,
                 fileExtension,
                 metadata,
-                isEncrypted: encryptionEnabled
+                isEncrypted: encryptionEnabled,
+                compression: options?.compress
             };
             const conditions = [];
             if (this._includeUserIdentity) {
@@ -673,8 +690,8 @@ class BlobStorageService {
      * @param id The id of the blob to get in urn format.
      * @param options Optional options for the retrieval of the blob.
      * @param options.includeContent Include the content, or just get the metadata.
-     * @param options.disableDecryption Disables decryption if enabled by default.
      * @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.
      * @param userIdentity The user identity to use with storage operations.
      * @param nodeIdentity The node identity to use with storage operations.
      * @returns The entry and data for the blob if it can be found.
@@ -683,9 +700,7 @@ class BlobStorageService {
     async get(id, options, userIdentity, nodeIdentity) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
         const includeContent = options?.includeContent ?? false;
-        const disableEncryption = options?.disableDecryption ?? false;
         const vaultKeyId = options?.overrideVaultKeyId ?? this._vaultKeyId;
-        const decryptionEnabled = !disableEncryption && core.Is.stringValue(vaultKeyId);
         const conditions = [];
         if (this._includeUserIdentity) {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
@@ -712,13 +727,17 @@ class BlobStorageService {
                 if (core.Is.undefined(returnBlob)) {
                     throw new core.NotFoundError(this.CLASS_NAME, "blobNotFound", id);
                 }
-                // If we have a vault connector then decrypt the data.
+                // If the data is encrypted then decrypt it.
+                const decryptionEnabled = blobEntry.isEncrypted && core.Is.stringValue(vaultKeyId);
                 if (decryptionEnabled) {
                     if (core.Is.empty(this._vaultConnector)) {
                         throw new core.GeneralError(this.CLASS_NAME, "vaultConnectorNotConfigured");
                     }
                     returnBlob = await this._vaultConnector.decrypt(`${nodeIdentity}/${vaultKeyId}`, vaultModels.VaultEncryptionType.ChaCha20Poly1305, returnBlob);
                 }
+                if (!core.Is.empty(blobEntry.compression) && (options?.decompress ?? true)) {
+                    returnBlob = await core.Compression.decompress(returnBlob, blobEntry.compression);
+                }
             }
             const jsonLd = this.entryToJsonLd(blobEntry, returnBlob);
             return dataJsonLd.JsonLdProcessor.compact(jsonLd, jsonLd["@context"]);
@@ -766,7 +785,8 @@ class BlobStorageService {
                 encodingFormat: encodingFormat ?? blobEntry.encodingFormat,
                 fileExtension: fileExtension ?? blobEntry.fileExtension,
                 metadata: metadata ?? blobEntry.metadata,
-                isEncrypted: blobEntry.isEncrypted
+                isEncrypted: blobEntry.isEncrypted,
+                compression: blobEntry.compression
             };
             const conditions = [];
             if (this._includeUserIdentity) {
@@ -861,10 +881,6 @@ class BlobStorageService {
                 sortDirection: orderDirection
             }
         ], undefined, cursor, pageSize);
-        for (const entity of result.entities) {
-            core.ObjectHelper.propertyDelete(entity, "nodeIdentity");
-            core.ObjectHelper.propertyDelete(entity, "userIdentity");
-        }
         let context = [
             standardsSchemaOrg.SchemaOrgContexts.ContextRoot,
             blobStorageModels.BlobStorageContexts.ContextRoot,
@@ -948,9 +964,7 @@ class BlobStorageService {
         if (core.Is.empty(entity$1)) {
             throw new core.NotFoundError(this.CLASS_NAME, "entityNotFound", id);
         }
-        core.ObjectHelper.propertyDelete(entity$1, "nodeIdentity");
-        core.ObjectHelper.propertyDelete(entity$1, "userIdentity");
-        return entity$1;
+        return core.ObjectHelper.omit(entity$1, ["nodeIdentity", "userIdentity"]);
     }
     /**
      * Convert the entry to JSON-LD.
@@ -975,7 +989,9 @@ class BlobStorageService {
             encodingFormat: entry?.encodingFormat,
             fileExtension: entry?.fileExtension,
             metadata: entry?.metadata,
-            blob: core.Is.uint8Array(blob) ? core.Converter.bytesToBase64(blob) : undefined
+            blob: core.Is.uint8Array(blob) ? core.Converter.bytesToBase64(blob) : undefined,
+            isEncrypted: entry.isEncrypted,
+            compression: entry.compression
         };
         return jsonLd;
     }
@@ -1021,6 +1037,10 @@ exports.BlobStorageEntry = class BlobStorageEntry {
      * Is the entry encrypted.
      */
     isEncrypted;
+    /**
+     * Is the entry compressed.
+     */
+    compression;
     /**
      * The user identity that created the blob.
      */
@@ -1071,6 +1091,10 @@ __decorate([
     entity.property({ type: "boolean" }),
     __metadata("design:type", Boolean)
 ], exports.BlobStorageEntry.prototype, "isEncrypted", void 0);
+__decorate([
+    entity.property({ type: "string", optional: true }),
+    __metadata("design:type", String)
+], exports.BlobStorageEntry.prototype, "compression", void 0);
 __decorate([
     entity.property({ type: "string", optional: true }),
     __metadata("design:type", String)

package/dist/esm/index.mjs

@@ -1,6 +1,6 @@
 import { HttpParameterHelper } from '@twin.org/api-models';
-import { BlobStorageTypes, BlobStorageContexts, BlobStorageConnectorFactory } from '@twin.org/blob-storage-models';
-import { StringHelper, Guards, ComponentFactory, Coerce, Is, Converter, GeneralError, Validation, ObjectHelper, Urn, NotFoundError } from '@twin.org/core';
+import { BlobStorageTypes, BlobStorageContexts, BlobStorageCompressionType, BlobStorageConnectorFactory } from '@twin.org/blob-storage-models';
+import { StringHelper, Guards, ComponentFactory, Coerce, Is, Converter, GeneralError, Validation, Compression, ObjectHelper, Urn, NotFoundError } from '@twin.org/core';
 import { SchemaOrgContexts, SchemaOrgTypes, SchemaOrgDataTypes } from '@twin.org/standards-schema-org';
 import { HttpStatusCode, HeaderTypes, MimeTypes, MimeTypeHelper } from '@twin.org/web';
 import { Sha256 } from '@twin.org/crypto';
@@ -425,7 +425,7 @@ async function blobStorageGet(httpRequestContext, componentName, request) {
     const component = ComponentFactory.get(componentName);
     const result = await component.get(request.pathParams.id, {
         includeContent: Coerce.boolean(request.query?.includeContent),
-        disableDecryption: Coerce.boolean(request.query?.disableDecryption),
+        decompress: Coerce.boolean(request.query?.decompress),
         overrideVaultKeyId: request.query?.overrideVaultKeyId
     }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
@@ -447,22 +447,34 @@ async function blobStorageGetContent(httpRequestContext, componentName, request)
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = ComponentFactory.get(componentName);
+    const decompress = Coerce.boolean(request.query?.decompress);
+    const download = Coerce.boolean(request.query?.download) ?? false;
     const result = await component.get(request.pathParams.id, {
         includeContent: true,
-        disableDecryption: Coerce.boolean(request.query?.disableDecryption),
+        decompress,
         overrideVaultKeyId: request.query?.overrideVaultKeyId
     }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     const encodingFormat = result?.encodingFormat ?? MimeTypes.OctetStream;
+    let compressedEncodingFormat;
+    let compressedExtension = "";
+    // If the entry is compressed and we are not decompressing
+    // we need to override the encoding format to the compressed type
+    // and append an additional extension to the filename.
+    if (result.compression && !decompress) {
+        compressedEncodingFormat =
+            result.compression === BlobStorageCompressionType.Gzip ? MimeTypes.Gzip : MimeTypes.Zlib;
+        compressedExtension = `.${MimeTypeHelper.defaultExtension(compressedEncodingFormat)}`;
+    }
     let filename = request.query?.filename;
     if (!Is.stringValue(filename)) {
-        filename = `file.${result.fileExtension ?? MimeTypeHelper.defaultExtension(encodingFormat)}`;
+        filename = `file.${result.fileExtension ?? MimeTypeHelper.defaultExtension(encodingFormat)}${compressedExtension}`;
     }
     return {
         body: Is.stringBase64(result.blob) ? Converter.base64ToBytes(result.blob) : new Uint8Array(),
         attachment: {
-            mimeType: encodingFormat,
+            mimeType: compressedEncodingFormat ?? encodingFormat,
             filename,
-            inline: !(request.query?.download ?? false)
+            inline: !download
         }
     };
 }
@@ -593,6 +605,7 @@ class BlobStorageService {
      * @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.compress Optional compression type to use for the blob, defaults to no compression.*
      * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
      * @param userIdentity The user identity to use with storage operations.
      * @param nodeIdentity The node identity to use with storage operations.
@@ -630,6 +643,9 @@ class BlobStorageService {
                 Validation.asValidationError(this.CLASS_NAME, "metadata", validationFailures);
             }
             const blobHash = `sha256:${Converter.bytesToBase64(Sha256.sum256(storeBlob))}`;
+            if (!Is.empty(options?.compress)) {
+                storeBlob = await Compression.compress(storeBlob, options.compress);
+            }
             // If we have a vault connector then encrypt the data.
             if (encryptionEnabled) {
                 if (Is.empty(this._vaultConnector)) {
@@ -648,7 +664,8 @@ class BlobStorageService {
                 encodingFormat,
                 fileExtension,
                 metadata,
-                isEncrypted: encryptionEnabled
+                isEncrypted: encryptionEnabled,
+                compression: options?.compress
             };
             const conditions = [];
             if (this._includeUserIdentity) {
@@ -671,8 +688,8 @@ class BlobStorageService {
      * @param id The id of the blob to get in urn format.
      * @param options Optional options for the retrieval of the blob.
      * @param options.includeContent Include the content, or just get the metadata.
-     * @param options.disableDecryption Disables decryption if enabled by default.
      * @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.
      * @param userIdentity The user identity to use with storage operations.
      * @param nodeIdentity The node identity to use with storage operations.
      * @returns The entry and data for the blob if it can be found.
@@ -681,9 +698,7 @@ class BlobStorageService {
     async get(id, options, userIdentity, nodeIdentity) {
         Urn.guard(this.CLASS_NAME, "id", id);
         const includeContent = options?.includeContent ?? false;
-        const disableEncryption = options?.disableDecryption ?? false;
         const vaultKeyId = options?.overrideVaultKeyId ?? this._vaultKeyId;
-        const decryptionEnabled = !disableEncryption && Is.stringValue(vaultKeyId);
         const conditions = [];
         if (this._includeUserIdentity) {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
@@ -710,13 +725,17 @@ class BlobStorageService {
                 if (Is.undefined(returnBlob)) {
                     throw new NotFoundError(this.CLASS_NAME, "blobNotFound", id);
                 }
-                // If we have a vault connector then decrypt the data.
+                // If the data is encrypted then decrypt it.
+                const decryptionEnabled = blobEntry.isEncrypted && Is.stringValue(vaultKeyId);
                 if (decryptionEnabled) {
                     if (Is.empty(this._vaultConnector)) {
                         throw new GeneralError(this.CLASS_NAME, "vaultConnectorNotConfigured");
                     }
                     returnBlob = await this._vaultConnector.decrypt(`${nodeIdentity}/${vaultKeyId}`, VaultEncryptionType.ChaCha20Poly1305, returnBlob);
                 }
+                if (!Is.empty(blobEntry.compression) && (options?.decompress ?? true)) {
+                    returnBlob = await Compression.decompress(returnBlob, blobEntry.compression);
+                }
             }
             const jsonLd = this.entryToJsonLd(blobEntry, returnBlob);
             return JsonLdProcessor.compact(jsonLd, jsonLd["@context"]);
@@ -764,7 +783,8 @@ class BlobStorageService {
                 encodingFormat: encodingFormat ?? blobEntry.encodingFormat,
                 fileExtension: fileExtension ?? blobEntry.fileExtension,
                 metadata: metadata ?? blobEntry.metadata,
-                isEncrypted: blobEntry.isEncrypted
+                isEncrypted: blobEntry.isEncrypted,
+                compression: blobEntry.compression
             };
             const conditions = [];
             if (this._includeUserIdentity) {
@@ -859,10 +879,6 @@ class BlobStorageService {
                 sortDirection: orderDirection
             }
         ], undefined, cursor, pageSize);
-        for (const entity of result.entities) {
-            ObjectHelper.propertyDelete(entity, "nodeIdentity");
-            ObjectHelper.propertyDelete(entity, "userIdentity");
-        }
         let context = [
             SchemaOrgContexts.ContextRoot,
             BlobStorageContexts.ContextRoot,
@@ -946,9 +962,7 @@ class BlobStorageService {
         if (Is.empty(entity)) {
             throw new NotFoundError(this.CLASS_NAME, "entityNotFound", id);
         }
-        ObjectHelper.propertyDelete(entity, "nodeIdentity");
-        ObjectHelper.propertyDelete(entity, "userIdentity");
-        return entity;
+        return ObjectHelper.omit(entity, ["nodeIdentity", "userIdentity"]);
     }
     /**
      * Convert the entry to JSON-LD.
@@ -973,7 +987,9 @@ class BlobStorageService {
             encodingFormat: entry?.encodingFormat,
             fileExtension: entry?.fileExtension,
             metadata: entry?.metadata,
-            blob: Is.uint8Array(blob) ? Converter.bytesToBase64(blob) : undefined
+            blob: Is.uint8Array(blob) ? Converter.bytesToBase64(blob) : undefined,
+            isEncrypted: entry.isEncrypted,
+            compression: entry.compression
         };
         return jsonLd;
     }
@@ -1019,6 +1035,10 @@ let BlobStorageEntry = class BlobStorageEntry {
      * Is the entry encrypted.
      */
     isEncrypted;
+    /**
+     * Is the entry compressed.
+     */
+    compression;
     /**
      * The user identity that created the blob.
      */
@@ -1069,6 +1089,10 @@ __decorate([
     property({ type: "boolean" }),
     __metadata("design:type", Boolean)
 ], BlobStorageEntry.prototype, "isEncrypted", void 0);
+__decorate([
+    property({ type: "string", optional: true }),
+    __metadata("design:type", String)
+], BlobStorageEntry.prototype, "compression", void 0);
 __decorate([
     property({ type: "string", optional: true }),
     __metadata("design:type", String)

package/dist/types/blobStorageService.d.ts

@@ -1,4 +1,4 @@
-import { type IBlobStorageComponent, type IBlobStorageEntry, type IBlobStorageEntryList } from "@twin.org/blob-storage-models";
+import { type BlobStorageCompressionType, type IBlobStorageComponent, type IBlobStorageEntry, type IBlobStorageEntryList } from "@twin.org/blob-storage-models";
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { SortDirection, type EntityCondition } from "@twin.org/entity";
 import type { IBlobStorageServiceConstructorOptions } from "./models/IBlobStorageServiceConstructorOptions";
@@ -28,6 +28,7 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      * @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.compress Optional compression type to use for the blob, defaults to no compression.*
      * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
      * @param userIdentity The user identity to use with storage operations.
      * @param nodeIdentity The node identity to use with storage operations.
@@ -36,6 +37,7 @@ export declare class BlobStorageService implements IBlobStorageComponent {
     create(blob: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, options?: {
         disableEncryption?: boolean;
         overrideVaultKeyId?: string;
+        compress?: BlobStorageCompressionType;
         namespace?: string;
     }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
@@ -43,8 +45,8 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      * @param id The id of the blob to get in urn format.
      * @param options Optional options for the retrieval of the blob.
      * @param options.includeContent Include the content, or just get the metadata.
-     * @param options.disableDecryption Disables decryption if enabled by default.
      * @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.
      * @param userIdentity The user identity to use with storage operations.
      * @param nodeIdentity The node identity to use with storage operations.
      * @returns The entry and data for the blob if it can be found.
@@ -52,7 +54,7 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      */
     get(id: string, options?: {
         includeContent?: boolean;
-        disableDecryption?: boolean;
+        decompress?: boolean;
         overrideVaultKeyId?: string;
     }, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntry>;
     /**

package/dist/types/entities/blobStorageEntry.d.ts

@@ -1,3 +1,4 @@
+import type { BlobStorageCompressionType } from "@twin.org/blob-storage-models";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 /**
  * Class representing entry for the blob storage.
@@ -39,6 +40,10 @@ export declare class BlobStorageEntry {
      * Is the entry encrypted.
      */
     isEncrypted: boolean;
+    /**
+     * Is the entry compressed.
+     */
+    compression?: BlobStorageCompressionType;
     /**
      * The user identity that created the blob.
      */

package/docs/changelog.md

@@ -1,5 +1,37 @@
 # @twin.org/blob-storage-service - Changelog
 
+## [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)
+
+
+### Bug Fixes
+
+* query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.36 to 0.0.1-next.37
+  * devDependencies
+    * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.36 to 0.0.1-next.37
+
+## [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)
+
+
+### 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
+  * devDependencies
+    * @twin.org/blob-storage-connector-memory 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-service-v0.0.1-next.34...blob-storage-service-v0.0.1-next.35) (2025-06-17)
 
 

package/docs/open-api/spec.json

@@ -171,7 +171,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "number"
+							"type": [
+								"number",
+								"string"
+							]
 						}
 					},
 					{
@@ -388,17 +391,23 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "string"
+							"type": [
+								"boolean",
+								"string"
+							]
 						},
 						"example": "true"
 					},
 					{
-						"name": "disableDecryption",
-						"description": "Disables decryption if enabled by default.",
+						"name": "decompress",
+						"description": "If the content should be decompressed, if it was compressed when stored, defaults to true.",
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "string"
+							"type": [
+								"boolean",
+								"string"
+							]
 						}
 					},
 					{
@@ -914,6 +923,21 @@
 	},
 	"components": {
 		"schemas": {
+			"BlobStorageCompressionType": {
+				"anyOf": [
+					{
+						"type": "string",
+						"const": "gzip",
+						"description": "Gzip."
+					},
+					{
+						"type": "string",
+						"const": "deflate",
+						"description": "Deflate."
+					}
+				],
+				"description": "The types of compression for blob storage data."
+			},
 			"BlobStorageCreateRequest": {
 				"type": "object",
 				"properties": {
@@ -937,6 +961,9 @@
 						"description": "Disables encryption if enabled by default.",
 						"default": false
 					},
+					"compress": {
+						"$ref": "#/components/schemas/BlobStorageCompressionType"
+					},
 					"overrideVaultKeyId": {
 						"type": "string",
 						"description": "Use a different vault key id for encryption, if not provided the default vault key id will be used.",
@@ -1007,6 +1034,9 @@
 						"type": "boolean",
 						"description": "Indicates if the blob is encrypted."
 					},
+					"compression": {
+						"$ref": "#/components/schemas/BlobStorageCompressionType"
+					},
 					"fileExtension": {
 						"type": "string",
 						"description": "The extension."
@@ -1095,16 +1125,6 @@
 					},
 					"metadata": {
 						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-					},
-					"disableEncryption": {
-						"type": "boolean",
-						"description": "Disables encryption if enabled by default.",
-						"default": false
-					},
-					"overrideVaultKeyId": {
-						"type": "string",
-						"description": "Use a different vault key id for encryption, if not provided the default vault key id will be used.",
-						"default": "undefined"
 					}
 				},
 				"additionalProperties": false,

package/docs/reference/classes/BlobStorageEntry.md

@@ -86,6 +86,14 @@ Is the entry encrypted.
 
 ***
 
+### compression?
+
+> `optional` **compression**: `BlobStorageCompressionType`
+
+Is the entry compressed.
+
+***
+
 ### userIdentity?
 
 > `optional` **userIdentity**: `string`

package/docs/reference/classes/BlobStorageService.md

@@ -96,6 +96,12 @@ Disables encryption if enabled by default.
 
 Use a different vault key id for encryption, if not provided the default vault key id will be used.
 
+###### compress?
+
+`BlobStorageCompressionType`
+
+Optional compression type to use for the blob, defaults to no compression.*
+
 ###### namespace?
 
 `string`
@@ -150,11 +156,11 @@ Optional options for the retrieval of the blob.
 
 Include the content, or just get the metadata.
 
-###### disableDecryption?
+###### decompress?
 
 `boolean`
 
-Disables decryption if enabled by default.
+If the content should be decompressed, if it was compressed when stored, defaults to true.
 
 ###### overrideVaultKeyId?
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-service",
-	"version": "0.0.1-next.35",
+	"version": "0.0.1-next.37",
 	"description": "Blob storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/api-models": "next",
-		"@twin.org/blob-storage-models": "0.0.1-next.35",
+		"@twin.org/blob-storage-models": "0.0.1-next.37",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",