@twin.org/blob-storage-models 0.0.1-next.8 → 0.0.1-next.9

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

@@ -11,19 +11,21 @@ export interface IBlobStorageComponent extends IComponent {
      * @param extension 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 nodeIdentity The node identity which controls the vault key.
+     * @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, mimeType?: string, extension?: string, metadata?: IJsonLdNodeObject, namespace?: string, nodeIdentity?: string): Promise<string>;
+    create(blob: string, mimeType?: string, extension?: string, metadata?: IJsonLdNodeObject, 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 nodeIdentity The node identity which controls the vault key.
+     * @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, nodeIdentity?: string): Promise<{
+    get(id: string, includeContent: boolean, userIdentity?: string, nodeIdentity?: string): Promise<{
         blob?: string;
         mimeType?: string;
         extension?: string;
@@ -35,15 +37,19 @@ export interface IBlobStorageComponent extends IComponent {
      * @param mimeType Mime type for the blob, will be detected if left undefined.
      * @param extension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
+     * @param userIdentity The user identity to use with storage operations.
+     * @param nodeIdentity The node identity to use with storage operations.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    update(id: string, mimeType?: string, extension?: string, metadata?: IJsonLdNodeObject): Promise<void>;
+    update(id: string, mimeType?: string, extension?: string, metadata?: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<void>;
     /**
      * Remove the blob.
      * @param id The id of the blob to remove in urn format.
+     * @param userIdentity The user identity to use with storage operations.
+     * @param nodeIdentity The node identity to use with storage operations.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    remove(id: string): Promise<void>;
+    remove(id: string, userIdentity?: string, nodeIdentity?: string): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/blob-storage-models - Changelog
 
-## v0.0.1-next.8
+## v0.0.1-next.9
 
 - Initial Release

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -10,7 +10,7 @@ Interface describing an blob storage component.
 
 ### create()
 
-> **create**(`blob`, `mimeType`?, `extension`?, `metadata`?, `namespace`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`blob`, `mimeType`?, `extension`?, `metadata`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
 Create the blob with some metadata.
 
@@ -36,9 +36,13 @@ Data for the custom metadata as JSON-LD.
 
 The namespace to use for storing, defaults to component configured namespace.
 
+• **userIdentity?**: `string`
+
+The user identity to use with storage operations.
+
 • **nodeIdentity?**: `string`
 
-The node identity which controls the vault key.
+The node identity to use with storage operations.
 
 #### Returns
 
@@ -50,7 +54,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `includeContent`, `nodeIdentity`?): `Promise`\<`object`\>
+> **get**(`id`, `includeContent`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`object`\>
 
 Get the blob and metadata.
 
@@ -64,9 +68,13 @@ The id of the blob to get in urn format.
 
 Include the content, or just get the metadata.
 
+• **userIdentity?**: `string`
+
+The user identity to use with storage operations.
+
 • **nodeIdentity?**: `string`
 
-The node identity which controls the vault key.
+The node identity to use with storage operations.
 
 #### Returns
 
@@ -98,7 +106,7 @@ Not found error if the blob cannot be found.
 
 ### update()
 
-> **update**(`id`, `mimeType`?, `extension`?, `metadata`?): `Promise`\<`void`\>
+> **update**(`id`, `mimeType`?, `extension`?, `metadata`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
 
 Update the blob with metadata.
 
@@ -120,6 +128,14 @@ Extension for the blob, will be detected if left undefined.
 
 Data for the custom metadata as JSON-LD.
 
+• **userIdentity?**: `string`
+
+The user identity to use with storage operations.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use with storage operations.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -134,7 +150,7 @@ Not found error if the blob cannot be found.
 
 ### remove()
 
-> **remove**(`id`): `Promise`\<`void`\>
+> **remove**(`id`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
 
 Remove the blob.
 
@@ -144,6 +160,14 @@ Remove the blob.
 
 The id of the blob to remove in urn format.
 
+• **userIdentity?**: `string`
+
+The user identity to use with storage operations.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use with storage operations.
+
 #### Returns
 
 `Promise`\<`void`\>

package/package.json

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