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

package/docs/reference/classes/BlobStorageEntry.md

@@ -78,6 +78,14 @@ The metadata for the blob as JSON-LD.
 
 ***
 
+### isEncrypted
+
+> **isEncrypted**: `boolean`
+
+Is the entry encrypted.
+
+***
+
 ### userIdentity?
 
 > `optional` **userIdentity**: `string`

package/docs/reference/classes/BlobStorageService.md

@@ -50,7 +50,7 @@ Runtime name for the class.
 
 ### 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.
 
@@ -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`
 
@@ -112,7 +128,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `includeContent`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IBlobStorageEntry`\>
+> **get**(`id`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IBlobStorageEntry`\>
 
 Get the blob entry.
 
@@ -124,12 +140,28 @@ Get the blob entry.
 
 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/IBlobStorageServiceConfig.md

@@ -8,13 +8,7 @@ Configuration for the blob storage service.
 
 > `optional` **vaultKeyId**: `string`
 
-The name of the vault key to use for encryption if the service has a vault connector configured.
-
-#### Default
-
-```ts
-blob-storage.
-```
+The name of the vault key to use for encryption, if not configured no encryption will happen.
 
 ***
 

package/docs/reference/interfaces/IBlobStorageServiceConstructorOptions.md

@@ -22,7 +22,7 @@ blob-storage-entry
 
 > `optional` **vaultConnectorType**: `string`
 
-The type of the vault connector for encryption, if undefined no encryption will be performed.
+The type of the vault connector for encryption.
 
 ***
 

package/locales/en.json

@@ -6,7 +6,8 @@
 			"getFailed": "There was a problem getting the blob",
 			"updateFailed": "There was a problem updating the blob",
 			"removeFailed": "There was a problem removing the blob",
-			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the blob storage service \"{namespace}\""
+			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the blob storage service \"{namespace}\"",
+			"vaultConnectorNotConfigured": "The vault connector is not configured, but encryption/decryption was requested."
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-service",
-	"version": "0.0.1-next.33",
+	"version": "0.0.1-next.35",
 	"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.33",
+		"@twin.org/blob-storage-models": "0.0.1-next.35",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",