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

package/docs/open-api/spec.json

@@ -21,10 +21,10 @@
         }
     ],
     "paths": {
-        "/blob": {
+        "/blob-storage": {
             "post": {
                 "operationId": "blobStorageCreate",
-                "summary": "Create a blob in to storage",
+                "summary": "Create an entry in blob storage",
                 "tags": [
                     "Blob Storage"
                 ],
@@ -42,7 +42,7 @@
                                 "$ref": "#/components/schemas/BlobStorageCreateRequest"
                             },
                             "examples": {
-                                "blobStorageCreateExample": {
+                                "blobStorageCreateRequestExample": {
                                     "value": {
                                         "blob": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZw==",
                                         "metadata": {
@@ -128,10 +128,10 @@
                 }
             }
         },
-        "/blob/{id}": {
+        "/blob-storage/{id}": {
             "get": {
                 "operationId": "blobStorageGet",
-                "summary": "Get the blob metadata from storage",
+                "summary": "Get the metadata for an item from blob storage",
                 "tags": [
                     "Blob Storage"
                 ],
@@ -268,7 +268,7 @@
             },
             "put": {
                 "operationId": "blobStorageUpdate",
-                "summary": "Update a blob metadata in storage",
+                "summary": "Update the metadata for an item in blob storage",
                 "tags": [
                     "Blob Storage"
                 ],
@@ -299,7 +299,7 @@
                                 "$ref": "#/components/schemas/BlobStorageUpdateRequest"
                             },
                             "examples": {
-                                "blobStorageUpdateExample": {
+                                "blobStorageUpdateRequestExample": {
                                     "value": {
                                         "metadata": {
                                             "@context": "http://schema.org/",
@@ -377,7 +377,7 @@
             },
             "delete": {
                 "operationId": "blobStorageRemove",
-                "summary": "Remove the blob from storage",
+                "summary": "Remove an item from blob storage",
                 "tags": [
                     "Blob Storage"
                 ],
@@ -484,10 +484,10 @@
                 }
             }
         },
-        "/blob/{id}/content": {
+        "/blob-storage/{id}/content": {
             "get": {
                 "operationId": "blobStorageGetContent",
-                "summary": "Get the blob from storage",
+                "summary": "Get the content for an item in blob storage",
                 "tags": [
                     "Blob Storage"
                 ],

package/docs/reference/classes/BlobMetadata.md

@@ -43,3 +43,19 @@ The extension.
 > `optional` **metadata**: `IJsonLdNodeObject`
 
 The metadata for the blob as JSON-LD.
+
+***
+
+### userIdentity?
+
+> `optional` **userIdentity**: `string`
+
+The user identity that created the blob.
+
+***
+
+### nodeIdentity?
+
+> `optional` **nodeIdentity**: `string`
+
+The node identity that created the blob.

package/docs/reference/classes/BlobStorageService.md

@@ -60,7 +60,7 @@ Runtime name for the class.
 
 ### 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.
 
@@ -86,9 +86,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
 
@@ -104,7 +108,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.
 
@@ -118,9 +122,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
 
@@ -156,7 +164,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.
 
@@ -178,6 +186,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`\>
@@ -196,7 +212,7 @@ Not found error if the blob cannot be found.
 
 ### remove()
 
-> **remove**(`id`): `Promise`\<`void`\>
+> **remove**(`id`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
 
 Remove the blob.
 
@@ -206,6 +222,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/docs/reference/functions/generateRestRoutesBlobStorage.md

@@ -1,6 +1,6 @@
 # Function: generateRestRoutesBlobStorage()
 
-> **generateRestRoutesBlobStorage**(`baseRouteName`, `componentName`): `IRestRoute`[]
+> **generateRestRoutesBlobStorage**(`baseRouteName`, `componentName`, `options`?): `IRestRoute`[]
 
 The REST routes for blob storage.
 
@@ -14,6 +14,18 @@ Prefix to prepend to the paths.
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
+• **options?**
+
+Additional options for the routes.
+
+• **options.typeName?**: `string`
+
+Optional type name to use in the routes, defaults to Blob Storage.
+
+• **options.tagName?**: `string`
+
+Optional name to use in OpenAPI spec for tag.
+
 ## Returns
 
 `IRestRoute`[]

package/docs/reference/interfaces/IBlobStorageServiceConfig.md

@@ -24,3 +24,19 @@ blob-storage.
 
 The namespace of the default storage connector to use.
 Defaults to the first entry in the factory if not provided.
+
+***
+
+### includeNodeIdentity?
+
+> `optional` **includeNodeIdentity**: `boolean`
+
+Include the node identity when performing storage operations, defaults to true.
+
+***
+
+### includeUserIdentity?
+
+> `optional` **includeUserIdentity**: `boolean`
+
+Include the user identity when performing storage operations, defaults to true.

package/docs/reference/variables/restEntryPoints.md

@@ -1,3 +1,7 @@
 # Variable: restEntryPoints
 
 > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+These are dummy entry points for the blob storage service.
+In reality your application would create its own entry points based on the
+blob types it wants to store, using a custom defaultBaseRoute.

package/package.json

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