@twin.org/blob-storage-service 0.0.1-next.3 → 0.0.1-next.31

package/docs/reference/classes/BlobStorageEntry.md

@@ -0,0 +1,93 @@
+# Class: BlobStorageEntry
+
+Class representing entry for the blob storage.
+
+## Constructors
+
+### Constructor
+
+> **new BlobStorageEntry**(): `BlobStorageEntry`
+
+#### Returns
+
+`BlobStorageEntry`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id for the blob.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time when the entry was created.
+
+***
+
+### dateModified?
+
+> `optional` **dateModified**: `string`
+
+The date/time when the entry was modified.
+
+***
+
+### blobSize
+
+> **blobSize**: `number`
+
+The length of the data in the blob.
+
+***
+
+### blobHash
+
+> **blobHash**: `string`
+
+The hash of the data in the blob.
+
+***
+
+### encodingFormat?
+
+> `optional` **encodingFormat**: `string`
+
+The mime type for the blob.
+
+***
+
+### fileExtension?
+
+> `optional` **fileExtension**: `string`
+
+The extension.
+
+***
+
+### metadata?
+
+> `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

@@ -8,33 +8,23 @@ Service for performing blob storage operations to a connector.
 
 ## Constructors
 
-### new BlobStorageService()
+### Constructor
 
-> **new BlobStorageService**(`options`?): [`BlobStorageService`](BlobStorageService.md)
+> **new BlobStorageService**(`options?`): `BlobStorageService`
 
 Create a new instance of BlobStorageService.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The dependencies for the service.
+[`IBlobStorageServiceConstructorOptions`](../interfaces/IBlobStorageServiceConstructorOptions.md)
 
-• **options.metadataEntityStorageType?**: `string`
-
-The type of the storage connector for the metadata, defaults to "blob-metadata".
-
-• **options.vaultConnectorType?**: `string`
-
-The type of the vault connector for encryption, if undefined no encryption will be performed.
-
-• **options.config?**: [`IBlobStorageServiceConfig`](../interfaces/IBlobStorageServiceConfig.md)
-
-The configuration for the service.
+The options for the service.
 
 #### Returns
 
-[`BlobStorageService`](BlobStorageService.md)
+`BlobStorageService`
 
 ## Properties
 
@@ -60,35 +50,53 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`blob`, `mimeType`?, `extension`?, `metadata`?, `namespace`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `namespace?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
 Create the blob with some metadata.
 
 #### Parameters
 
-• **blob**: `string`
+##### blob
+
+`string`
 
 The data for the blob in base64 format.
 
-• **mimeType?**: `string`
+##### encodingFormat?
+
+`string`
 
 Mime type for the blob, will be detected if left undefined.
 
-• **extension?**: `string`
+##### fileExtension?
+
+`string`
 
 Extension for the blob, will be detected if left undefined.
 
-• **metadata?**: `IJsonLdNodeObject`
+##### metadata?
+
+`IJsonLdNodeObject`
 
 Data for the custom metadata as JSON-LD.
 
-• **namespace?**: `string`
+##### namespace?
+
+`string`
 
 The namespace to use for storing, defaults to component configured namespace.
 
-• **nodeIdentity?**: `string`
+##### 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,45 +112,41 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `includeContent`, `nodeIdentity`?): `Promise`\<`object`\>
+> **get**(`id`, `includeContent`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IBlobStorageEntry`\>
 
-Get the blob and metadata.
+Get the blob entry.
 
 #### Parameters
 
-• **id**: `string`
+##### id
 
-The id of the blob to get in urn format.
-
-• **includeContent**: `boolean`
+`string`
 
-Include the content, or just get the metadata.
+The id of the blob to get in urn format.
 
-• **nodeIdentity?**: `string`
+##### includeContent
 
-The node identity which controls the vault key.
+`boolean`
 
-#### Returns
+Include the content, or just get the metadata.
 
-`Promise`\<`object`\>
+##### userIdentity?
 
-The metadata and data for the blob if it can be found.
+`string`
 
-##### blob?
+The user identity to use with storage operations.
 
-> `optional` **blob**: `string`
+##### nodeIdentity?
 
-##### mimeType?
+`string`
 
-> `optional` **mimeType**: `string`
+The node identity to use with storage operations.
 
-##### extension?
+#### Returns
 
-> `optional` **extension**: `string`
+`Promise`\<`IBlobStorageEntry`\>
 
-##### metadata?
-
-> `optional` **metadata**: `IJsonLdNodeObject`
+The entry and data for the blob if it can be found.
 
 #### Throws
 
@@ -156,28 +160,48 @@ Not found error if the blob cannot be found.
 
 ### update()
 
-> **update**(`id`, `mimeType`?, `extension`?, `metadata`?): `Promise`\<`void`\>
+> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Update the blob with metadata.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
-The id of the blob metadata to update.
+The id of the blob entry to update.
 
-• **mimeType?**: `string`
+##### encodingFormat?
+
+`string`
 
 Mime type for the blob, will be detected if left undefined.
 
-• **extension?**: `string`
+##### fileExtension?
+
+`string`
 
 Extension for the blob, will be detected if left undefined.
 
-• **metadata?**: `IJsonLdNodeObject`
+##### metadata?
+
+`IJsonLdNodeObject`
 
 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,16 +220,30 @@ Not found error if the blob cannot be found.
 
 ### remove()
 
-> **remove**(`id`): `Promise`\<`void`\>
+> **remove**(`id`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Remove the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 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`\>
@@ -215,3 +253,66 @@ Nothing.
 #### Implementation of
 
 `IBlobStorageComponent.remove`
+
+***
+
+### query()
+
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IBlobStorageEntryList`\>
+
+Query all the blob storage entries which match the conditions.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<`IBlobStorageEntry`\>
+
+The conditions to match for the entries.
+
+##### orderBy?
+
+The order for the results, defaults to created.
+
+`"dateCreated"` | `"dateModified"`
+
+##### orderByDirection?
+
+`SortDirection`
+
+The direction for the order, defaults to descending.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entries.
+
+##### pageSize?
+
+`number`
+
+The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
+
+##### userIdentity?
+
+`string`
+
+The user identity to use with storage operations.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use with storage operations.
+
+#### Returns
+
+`Promise`\<`IBlobStorageEntryList`\>
+
+All the entries for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Implementation of
+
+`IBlobStorageComponent.query`

package/docs/reference/functions/blobStorageCreate.md

@@ -6,15 +6,21 @@ Create a blob in storage.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IBlobStorageCreateRequest`
+### request
+
+`IBlobStorageCreateRequest`
 
 The request.
 

package/docs/reference/functions/blobStorageGet.md

@@ -6,15 +6,21 @@ Get the blob from storage.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IBlobStorageGetRequest`
+### request
+
+`IBlobStorageGetRequest`
 
 The request.
 

package/docs/reference/functions/blobStorageGetContent.md

@@ -6,15 +6,21 @@ Get the blob from storage.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IBlobStorageGetContentRequest`
+### request
+
+`IBlobStorageGetContentRequest`
 
 The request.
 

package/docs/reference/functions/blobStorageList.md

@@ -0,0 +1,31 @@
+# Function: blobStorageList()
+
+> **blobStorageList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IBlobStorageListResponse`\>
+
+List the entries from blob storage.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IBlobStorageListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IBlobStorageListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/blobStorageRemove.md

@@ -6,15 +6,21 @@ Remove the blob from storage.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IBlobStorageRemoveRequest`
+### request
+
+`IBlobStorageRemoveRequest`
 
 The request.
 

package/docs/reference/functions/blobStorageUpdate.md

@@ -6,15 +6,21 @@ Update the blob storage metadata.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IBlobStorageUpdateRequest`
+### request
+
+`IBlobStorageUpdateRequest`
 
 The request.
 

package/docs/reference/functions/generateRestRoutesBlobStorage.md

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

package/docs/reference/index.md

@@ -3,11 +3,12 @@
 ## Classes
 
 - [BlobStorageService](classes/BlobStorageService.md)
-- [BlobMetadata](classes/BlobMetadata.md)
+- [BlobStorageEntry](classes/BlobStorageEntry.md)
 
 ## Interfaces
 
 - [IBlobStorageServiceConfig](interfaces/IBlobStorageServiceConfig.md)
+- [IBlobStorageServiceConstructorOptions](interfaces/IBlobStorageServiceConstructorOptions.md)
 
 ## Variables
 
@@ -22,4 +23,5 @@
 - [blobStorageGetContent](functions/blobStorageGetContent.md)
 - [blobStorageUpdate](functions/blobStorageUpdate.md)
 - [blobStorageRemove](functions/blobStorageRemove.md)
+- [blobStorageList](functions/blobStorageList.md)
 - [initSchema](functions/initSchema.md)

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/interfaces/IBlobStorageServiceConstructorOptions.md

@@ -0,0 +1,33 @@
+# Interface: IBlobStorageServiceConstructorOptions
+
+Options for the Blob Storage Service constructor.
+
+## Properties
+
+### entryEntityStorageType?
+
+> `optional` **entryEntityStorageType**: `string`
+
+The type of the storage connector for the metadata.
+
+#### Default
+
+```ts
+blob-storage-entry
+```
+
+***
+
+### vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+The type of the vault connector for encryption, if undefined no encryption will be performed.
+
+***
+
+### config?
+
+> `optional` **config**: [`IBlobStorageServiceConfig`](IBlobStorageServiceConfig.md)
+
+The configuration for the service.

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.