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

package/dist/cjs/index.cjs

@@ -30,7 +30,26 @@ const BlobStorageTypes = {
     /**
      * Represents blob storage entry.
      */
-    Entry: "BlobStorageEntry"
+    Entry: "BlobStorageEntry",
+    /**
+     * Represents blob storage entry compression.
+     */
+    CompressionType: "BlobStorageCompressionType"
+};
+
+var $schema$1 = "https://json-schema.org/draft/2020-12/schema";
+var $id$1 = "https://schema.twindev.org/blob-storage/BlobStorageCompressionType";
+var description$1 = "The types of compression for blob storage data.";
+var type$1 = "string";
+var BlobStorageCompressionTypeSchema = {
+	$schema: $schema$1,
+	$id: $id$1,
+	description: description$1,
+	type: type$1,
+	"enum": [
+	"gzip",
+	"deflate"
+]
 };
 
 var $schema = "https://json-schema.org/draft/2020-12/schema";
@@ -85,6 +104,14 @@ var properties = {
 		type: "string",
 		description: "The mime type for the blob."
 	},
+	isEncrypted: {
+		type: "boolean",
+		description: "Indicates if the blob is encrypted."
+	},
+	compression: {
+		$ref: "https://schema.twindev.org/blob-storage/BlobStorageCompressionType",
+		description: "The type of compression used for the blob, if not set it is not stored with compression."
+	},
 	fileExtension: {
 		type: "string",
 		description: "The extension."
@@ -133,6 +160,12 @@ class BlobStorageDataTypes {
             defaultValue: {},
             jsonSchema: async () => BlobStorageEntrySchema
         }));
+        dataCore.DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.CompressionType}`, () => ({
+            context: BlobStorageContexts.ContextRoot,
+            type: BlobStorageTypes.CompressionType,
+            defaultValue: {},
+            jsonSchema: async () => BlobStorageCompressionTypeSchema
+        }));
     }
 }
 
@@ -144,6 +177,24 @@ class BlobStorageDataTypes {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageConnectorFactory = core.Factory.createFactory("blob-storage");
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of compression for blob storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BlobStorageCompressionType = {
+    /**
+     * Gzip.
+     */
+    Gzip: "gzip",
+    /**
+     * Deflate.
+     */
+    Deflate: "deflate"
+};
+
+exports.BlobStorageCompressionType = BlobStorageCompressionType;
 exports.BlobStorageConnectorFactory = BlobStorageConnectorFactory;
 exports.BlobStorageContexts = BlobStorageContexts;
 exports.BlobStorageDataTypes = BlobStorageDataTypes;

package/dist/esm/index.mjs

@@ -28,7 +28,26 @@ const BlobStorageTypes = {
     /**
      * Represents blob storage entry.
      */
-    Entry: "BlobStorageEntry"
+    Entry: "BlobStorageEntry",
+    /**
+     * Represents blob storage entry compression.
+     */
+    CompressionType: "BlobStorageCompressionType"
+};
+
+var $schema$1 = "https://json-schema.org/draft/2020-12/schema";
+var $id$1 = "https://schema.twindev.org/blob-storage/BlobStorageCompressionType";
+var description$1 = "The types of compression for blob storage data.";
+var type$1 = "string";
+var BlobStorageCompressionTypeSchema = {
+	$schema: $schema$1,
+	$id: $id$1,
+	description: description$1,
+	type: type$1,
+	"enum": [
+	"gzip",
+	"deflate"
+]
 };
 
 var $schema = "https://json-schema.org/draft/2020-12/schema";
@@ -83,6 +102,14 @@ var properties = {
 		type: "string",
 		description: "The mime type for the blob."
 	},
+	isEncrypted: {
+		type: "boolean",
+		description: "Indicates if the blob is encrypted."
+	},
+	compression: {
+		$ref: "https://schema.twindev.org/blob-storage/BlobStorageCompressionType",
+		description: "The type of compression used for the blob, if not set it is not stored with compression."
+	},
 	fileExtension: {
 		type: "string",
 		description: "The extension."
@@ -131,6 +158,12 @@ class BlobStorageDataTypes {
             defaultValue: {},
             jsonSchema: async () => BlobStorageEntrySchema
         }));
+        DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.CompressionType}`, () => ({
+            context: BlobStorageContexts.ContextRoot,
+            type: BlobStorageTypes.CompressionType,
+            defaultValue: {},
+            jsonSchema: async () => BlobStorageCompressionTypeSchema
+        }));
     }
 }
 
@@ -142,4 +175,21 @@ class BlobStorageDataTypes {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageConnectorFactory = Factory.createFactory("blob-storage");
 
-export { BlobStorageConnectorFactory, BlobStorageContexts, BlobStorageDataTypes, BlobStorageTypes };
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of compression for blob storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BlobStorageCompressionType = {
+    /**
+     * Gzip.
+     */
+    Gzip: "gzip",
+    /**
+     * Deflate.
+     */
+    Deflate: "deflate"
+};
+
+export { BlobStorageCompressionType, BlobStorageConnectorFactory, BlobStorageContexts, BlobStorageDataTypes, BlobStorageTypes };

package/dist/types/index.d.ts

@@ -9,6 +9,7 @@ export * from "./models/api/IBlobStorageListRequest";
 export * from "./models/api/IBlobStorageListResponse";
 export * from "./models/api/IBlobStorageRemoveRequest";
 export * from "./models/api/IBlobStorageUpdateRequest";
+export * from "./models/blobStorageCompressionType";
 export * from "./models/blobStorageContexts";
 export * from "./models/blobStorageTypes";
 export * from "./models/IBlobStorageComponent";

package/dist/types/models/IBlobStorageComponent.d.ts

@@ -1,6 +1,7 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { EntityCondition, SortDirection } from "@twin.org/entity";
+import type { BlobStorageCompressionType } from "./blobStorageCompressionType";
 import type { IBlobStorageEntry } from "./IBlobStorageEntry";
 import type { IBlobStorageEntryList } from "./IBlobStorageEntryList";
 /**
@@ -13,22 +14,38 @@ export interface IBlobStorageComponent extends IComponent {
      * @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.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.
      * @returns The id of the stored blob in urn format.
      */
-    create(blob: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, namespace?: string, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    create(blob: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, options?: {
+        disableEncryption?: boolean;
+        overrideVaultKeyId?: string;
+        compress?: BlobStorageCompressionType;
+        namespace?: string;
+    }, userIdentity?: string, nodeIdentity?: 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.
      * @param userIdentity The user identity to use with storage operations.
      * @param nodeIdentity The node identity to use with storage operations.
      * @returns The data and metadata for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
-    get(id: string, includeContent: boolean, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntry>;
+    get(id: string, options?: {
+        includeContent?: boolean;
+        decompress?: boolean;
+        overrideVaultKeyId?: string;
+    }, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntry>;
     /**
      * Update the blob with metadata.
      * @param id The id of the blob metadata to update.

package/dist/types/models/IBlobStorageEntry.d.ts

@@ -1,4 +1,5 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { BlobStorageCompressionType } from "./blobStorageCompressionType";
 import type { BlobStorageContexts } from "./blobStorageContexts";
 import type { BlobStorageTypes } from "./blobStorageTypes";
 /**
@@ -41,6 +42,14 @@ export interface IBlobStorageEntry {
      * The mime type for the blob.
      */
     encodingFormat?: string;
+    /**
+     * Indicates if the blob is encrypted.
+     */
+    isEncrypted?: boolean;
+    /**
+     * The type of compression used for the blob, if not set it is not stored with compression.
+     */
+    compression?: BlobStorageCompressionType;
     /**
      * The extension.
      */

package/dist/types/models/api/IBlobStorageCreateRequest.d.ts

@@ -1,4 +1,5 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { BlobStorageCompressionType } from "../blobStorageCompressionType";
 /**
  * Request to create an entry in blob storage.
  */
@@ -23,6 +24,20 @@ export interface IBlobStorageCreateRequest {
          * Custom metadata to associate with the blob as JSON-LD.
          */
         metadata?: IJsonLdNodeObject;
+        /**
+         * Disables encryption if enabled by default.
+         * @default false
+         */
+        disableEncryption?: boolean;
+        /**
+         * Optional compression type to use for the blob, defaults to no compression.
+         */
+        compress?: BlobStorageCompressionType;
+        /**
+         * Use a different vault key id for encryption, if not provided the default vault key id will be used.
+         * @default undefined
+         */
+        overrideVaultKeyId?: string;
         /**
          * The namespace to store the data in, defaults to component configured namespace.
          */

package/dist/types/models/api/IBlobStorageGetContentRequest.d.ts

@@ -15,12 +15,22 @@ export interface IBlobStorageGetContentRequest {
      * The query parameters.
      */
     query?: {
+        /**
+         * If the content should be decompressed, if it was compressed when stored, defaults to true.
+         * @default true
+         */
+        decompress?: string;
+        /**
+         * Use a different vault key id for decryption, if not provided the default vault key id will be used.
+         * @default undefined
+         */
+        overrideVaultKeyId?: string;
         /**
          * Set the download flag which should prompt the browser to save the file.
          * Otherwise the browser should show the content inside the page.
          * @default false
          */
-        download?: boolean;
+        download?: string;
         /**
          * Set the filename to use when a download is triggered.
          * A filename will be generated if not provided.

package/dist/types/models/api/IBlobStorageGetRequest.d.ts

@@ -26,6 +26,16 @@ export interface IBlobStorageGetRequest {
          * Include the content in the response, otherwise only metadata is returned.
          * @default false
          */
-        includeContent?: boolean;
+        includeContent?: string;
+        /**
+         * If the content should be decompressed, if it was compressed when stored, defaults to true.
+         * @default true
+         */
+        decompress?: string;
+        /**
+         * Use a different vault key id for decryption, if not provided the default vault key id will be used.
+         * @default undefined
+         */
+        overrideVaultKeyId?: string;
     };
 }

package/dist/types/models/blobStorageCompressionType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The types of compression for blob storage data.
+ */
+export declare const BlobStorageCompressionType: {
+    /**
+     * Gzip.
+     */
+    readonly Gzip: "gzip";
+    /**
+     * Deflate.
+     */
+    readonly Deflate: "deflate";
+};
+/**
+ * The types of compression for blob storage data.
+ */
+export type BlobStorageCompressionType = (typeof BlobStorageCompressionType)[keyof typeof BlobStorageCompressionType];

package/dist/types/models/blobStorageTypes.d.ts

@@ -6,6 +6,10 @@ export declare const BlobStorageTypes: {
      * Represents blob storage entry.
      */
     readonly Entry: "BlobStorageEntry";
+    /**
+     * Represents blob storage entry compression.
+     */
+    readonly CompressionType: "BlobStorageCompressionType";
 };
 /**
  * The types of blob storage data.

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/blob-storage-models - Changelog
 
+## [0.0.1-next.36](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.35...blob-storage-models-v0.0.1-next.36) (2025-06-19)
+
+
+### Features
+
+* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+
+## [0.0.1-next.35](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.34...blob-storage-models-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))
+
 ## [0.0.1-next.34](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.33...blob-storage-models-v0.0.1-next.34) (2025-06-12)
 
 

package/docs/reference/index.md

@@ -22,11 +22,13 @@
 
 ## Type Aliases
 
+- [BlobStorageCompressionType](type-aliases/BlobStorageCompressionType.md)
 - [BlobStorageContexts](type-aliases/BlobStorageContexts.md)
 - [BlobStorageTypes](type-aliases/BlobStorageTypes.md)
 
 ## Variables
 
 - [BlobStorageConnectorFactory](variables/BlobStorageConnectorFactory.md)
+- [BlobStorageCompressionType](variables/BlobStorageCompressionType.md)
 - [BlobStorageContexts](variables/BlobStorageContexts.md)
 - [BlobStorageTypes](variables/BlobStorageTypes.md)

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -10,7 +10,7 @@ Interface describing an blob storage component.
 
 ### create()
 
-> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `namespace?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
 Create the blob with some metadata.
 
@@ -40,7 +40,29 @@ 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.
+
+###### compress?
+
+[`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
+
+Optional compression type to use for the blob, defaults to no compression.
+
+###### namespace?
 
 `string`
 
@@ -68,7 +90,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `includeContent`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
+> **get**(`id`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
 Get the blob and metadata.
 
@@ -80,12 +102,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.
+
 ##### userIdentity?
 
 `string`

package/docs/reference/interfaces/IBlobStorageCreateRequest.md

@@ -34,6 +34,36 @@ The extension of the blob, will be detected if left undefined.
 
 Custom metadata to associate with the blob as JSON-LD.
 
+#### disableEncryption?
+
+> `optional` **disableEncryption**: `boolean`
+
+Disables encryption if enabled by default.
+
+##### Default
+
+```ts
+false
+```
+
+#### compress?
+
+> `optional` **compress**: [`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
+
+Optional compression type to use for the blob, defaults to no compression.
+
+#### overrideVaultKeyId?
+
+> `optional` **overrideVaultKeyId**: `string`
+
+Use a different vault key id for encryption, if not provided the default vault key id will be used.
+
+##### Default
+
+```ts
+undefined
+```
+
 #### namespace?
 
 > `optional` **namespace**: `string`

package/docs/reference/interfaces/IBlobStorageEntry.md

@@ -68,6 +68,22 @@ The mime type for the blob.
 
 ***
 
+### isEncrypted?
+
+> `optional` **isEncrypted**: `boolean`
+
+Indicates if the blob is encrypted.
+
+***
+
+### compression?
+
+> `optional` **compression**: [`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
+
+The type of compression used for the blob, if not set it is not stored with compression.
+
+***
+
 ### fileExtension?
 
 > `optional` **fileExtension**: `string`

package/docs/reference/interfaces/IBlobStorageGetContentRequest.md

@@ -24,9 +24,33 @@ The id of the blob to get in urn format.
 
 The query parameters.
 
+#### decompress?
+
+> `optional` **decompress**: `string`
+
+If the content should be decompressed, if it was compressed when stored, defaults to true.
+
+##### Default
+
+```ts
+true
+```
+
+#### overrideVaultKeyId?
+
+> `optional` **overrideVaultKeyId**: `string`
+
+Use a different vault key id for decryption, if not provided the default vault key id will be used.
+
+##### Default
+
+```ts
+undefined
+```
+
 #### download?
 
-> `optional` **download**: `boolean`
+> `optional` **download**: `string`
 
 Set the download flag which should prompt the browser to save the file.
 Otherwise the browser should show the content inside the page.

package/docs/reference/interfaces/IBlobStorageGetRequest.md

@@ -38,7 +38,7 @@ The query parameters.
 
 #### includeContent?
 
-> `optional` **includeContent**: `boolean`
+> `optional` **includeContent**: `string`
 
 Include the content in the response, otherwise only metadata is returned.
 
@@ -47,3 +47,27 @@ Include the content in the response, otherwise only metadata is returned.
 ```ts
 false
 ```
+
+#### decompress?
+
+> `optional` **decompress**: `string`
+
+If the content should be decompressed, if it was compressed when stored, defaults to true.
+
+##### Default
+
+```ts
+true
+```
+
+#### overrideVaultKeyId?
+
+> `optional` **overrideVaultKeyId**: `string`
+
+Use a different vault key id for decryption, if not provided the default vault key id will be used.
+
+##### Default
+
+```ts
+undefined
+```

package/docs/reference/type-aliases/BlobStorageCompressionType.md

@@ -0,0 +1,5 @@
+# Type Alias: BlobStorageCompressionType
+
+> **BlobStorageCompressionType** = *typeof* [`BlobStorageCompressionType`](../variables/BlobStorageCompressionType.md)\[keyof *typeof* [`BlobStorageCompressionType`](../variables/BlobStorageCompressionType.md)\]
+
+The types of compression for blob storage data.

package/docs/reference/variables/BlobStorageCompressionType.md

@@ -0,0 +1,19 @@
+# Variable: BlobStorageCompressionType
+
+> `const` **BlobStorageCompressionType**: `object`
+
+The types of compression for blob storage data.
+
+## Type declaration
+
+### Gzip
+
+> `readonly` **Gzip**: `"gzip"` = `"gzip"`
+
+Gzip.
+
+### Deflate
+
+> `readonly` **Deflate**: `"deflate"` = `"deflate"`
+
+Deflate.

package/docs/reference/variables/BlobStorageTypes.md

@@ -11,3 +11,9 @@ The types of blob storage data.
 > `readonly` **Entry**: `"BlobStorageEntry"` = `"BlobStorageEntry"`
 
 Represents blob storage entry.
+
+### CompressionType
+
+> `readonly` **CompressionType**: `"BlobStorageCompressionType"` = `"BlobStorageCompressionType"`
+
+Represents blob storage entry compression.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.1-next.34",
+	"version": "0.0.1-next.36",
 	"description": "Models which define the structure of the blob storage contracts and connectors",
 	"repository": {
 		"type": "git",