@twin.org/blob-storage-models 0.0.1-next.33 → 0.0.1-next.35

package/dist/cjs/index.cjs

@@ -33,12 +33,19 @@ const BlobStorageTypes = {
     Entry: "BlobStorageEntry"
 };
 
+var $schema = "https://json-schema.org/draft/2020-12/schema";
+var $id = "https://schema.twindev.org/blob-storage/BlobStorageEntry";
+var description = "Interface describing a blob storage entry.";
 var type = "object";
 var properties = {
 	"@context": {
 		type: "array",
 		minItems: 2,
-		items: [
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context.",
+		prefixItems: [
 			{
 				type: "string",
 				"const": "https://schema.twindev.org/blob-storage/"
@@ -47,11 +54,7 @@ var properties = {
 				type: "string",
 				"const": "https://schema.twindev.org/common/"
 			}
-		],
-		additionalItems: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		description: "JSON-LD Context."
+		]
 	},
 	type: {
 		type: "string",
@@ -82,6 +85,10 @@ var properties = {
 		type: "string",
 		description: "The mime type for the blob."
 	},
+	isEncrypted: {
+		type: "boolean",
+		description: "Indicates if the blob is encrypted."
+	},
 	fileExtension: {
 		type: "string",
 		description: "The extension."
@@ -104,13 +111,14 @@ var required = [
 	"blobHash"
 ];
 var additionalProperties = false;
-var description = "Interface describing a blob storage entry.";
 var BlobStorageEntrySchema = {
+	$schema: $schema,
+	$id: $id,
+	description: description,
 	type: type,
 	properties: properties,
 	required: required,
-	additionalProperties: additionalProperties,
-	description: description
+	additionalProperties: additionalProperties
 };
 
 // Copyright 2024 IOTA Stiftung.

package/dist/esm/index.mjs

@@ -31,12 +31,19 @@ const BlobStorageTypes = {
     Entry: "BlobStorageEntry"
 };
 
+var $schema = "https://json-schema.org/draft/2020-12/schema";
+var $id = "https://schema.twindev.org/blob-storage/BlobStorageEntry";
+var description = "Interface describing a blob storage entry.";
 var type = "object";
 var properties = {
 	"@context": {
 		type: "array",
 		minItems: 2,
-		items: [
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context.",
+		prefixItems: [
 			{
 				type: "string",
 				"const": "https://schema.twindev.org/blob-storage/"
@@ -45,11 +52,7 @@ var properties = {
 				type: "string",
 				"const": "https://schema.twindev.org/common/"
 			}
-		],
-		additionalItems: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		description: "JSON-LD Context."
+		]
 	},
 	type: {
 		type: "string",
@@ -80,6 +83,10 @@ var properties = {
 		type: "string",
 		description: "The mime type for the blob."
 	},
+	isEncrypted: {
+		type: "boolean",
+		description: "Indicates if the blob is encrypted."
+	},
 	fileExtension: {
 		type: "string",
 		description: "The extension."
@@ -102,13 +109,14 @@ var required = [
 	"blobHash"
 ];
 var additionalProperties = false;
-var description = "Interface describing a blob storage entry.";
 var BlobStorageEntrySchema = {
+	$schema: $schema,
+	$id: $id,
+	description: description,
 	type: type,
 	properties: properties,
 	required: required,
-	additionalProperties: additionalProperties,
-	description: description
+	additionalProperties: additionalProperties
 };
 
 // Copyright 2024 IOTA Stiftung.

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

@@ -13,22 +13,36 @@ 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.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;
+        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.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 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;
+        disableDecryption?: 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

@@ -41,6 +41,10 @@ export interface IBlobStorageEntry {
      * The mime type for the blob.
      */
     encodingFormat?: string;
+    /**
+     * Indicates if the blob is encrypted.
+     */
+    isEncrypted?: boolean;
     /**
      * The extension.
      */

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

@@ -23,6 +23,16 @@ 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;
+        /**
+         * 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?: {
+        /**
+         * Disables decryption if enabled by default.
+         * @default false
+         */
+        disableDecryption?: 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;
+        /**
+         * Disables decryption if enabled by default.
+         * @default false
+         */
+        disableDecryption?: 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/api/IBlobStorageUpdateRequest.d.ts

@@ -28,5 +28,15 @@ export interface IBlobStorageUpdateRequest {
          * Custom metadata to associate with the blob as JSON-LD.
          */
         metadata?: IJsonLdNodeObject;
+        /**
+         * Disables encryption if enabled by default.
+         * @default false
+         */
+        disableEncryption?: boolean;
+        /**
+         * Use a different vault key id for encryption, if not provided the default vault key id will be used.
+         * @default undefined
+         */
+        overrideVaultKeyId?: string;
     };
 }

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/blob-storage-models - Changelog
 
+## [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)
+
+
+### Features
+
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+
 ## [0.0.1-next.33](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.32...blob-storage-models-v0.0.1-next.33) (2025-06-03)
 
 

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,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`
 
@@ -68,7 +84,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 +96,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.
 
+###### disableDecryption?
+
+`boolean`
+
+Disables decryption if enabled by default.
+
+###### 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,30 @@ 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
+```
+
+#### 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,14 @@ The mime type for the blob.
 
 ***
 
+### isEncrypted?
+
+> `optional` **isEncrypted**: `boolean`
+
+Indicates if the blob is encrypted.
+
+***
+
 ### 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.
 
+#### disableDecryption?
+
+> `optional` **disableDecryption**: `string`
+
+Disables decryption if enabled by default.
+
+##### Default
+
+```ts
+false
+```
+
+#### 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
 ```
+
+#### disableDecryption?
+
+> `optional` **disableDecryption**: `string`
+
+Disables decryption if enabled by default.
+
+##### Default
+
+```ts
+false
+```
+
+#### 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/interfaces/IBlobStorageUpdateRequest.md

@@ -41,3 +41,27 @@ The extension of the blob, will be detected if left undefined.
 > `optional` **metadata**: `IJsonLdNodeObject`
 
 Custom metadata to associate with the blob as JSON-LD.
+
+#### disableEncryption?
+
+> `optional` **disableEncryption**: `boolean`
+
+Disables encryption if enabled by default.
+
+##### Default
+
+```ts
+false
+```
+
+#### 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
+```

package/package.json

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