@twin.org/blob-storage-models 0.0.1-next.10

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -0,0 +1,232 @@
+# Interface: IBlobStorageComponent
+
+Interface describing an blob storage component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create()
+
+> **create**(`blob`, `mimeType`?, `extension`?, `metadata`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+
+Create the blob with some metadata.
+
+#### Parameters
+
+• **blob**: `string`
+
+The data for the blob in base64 format.
+
+• **mimeType?**: `string`
+
+Mime type for the blob, will be detected if left undefined.
+
+• **extension?**: `string`
+
+Extension for the blob, will be detected if left undefined.
+
+• **metadata?**: `IJsonLdNodeObject`
+
+Data for the custom metadata as JSON-LD.
+
+• **namespace?**: `string`
+
+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 to use with storage operations.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the stored blob in urn format.
+
+***
+
+### get()
+
+> **get**(`id`, `includeContent`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`object`\>
+
+Get the blob and metadata.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the blob to get in urn format.
+
+• **includeContent**: `boolean`
+
+Include the content, or just get the metadata.
+
+• **userIdentity?**: `string`
+
+The user identity to use with storage operations.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use with storage operations.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The data and metadata for the blob if it can be found.
+
+##### blob?
+
+> `optional` **blob**: `string`
+
+##### mimeType?
+
+> `optional` **mimeType**: `string`
+
+##### extension?
+
+> `optional` **extension**: `string`
+
+##### metadata?
+
+> `optional` **metadata**: `IJsonLdNodeObject`
+
+#### Throws
+
+Not found error if the blob cannot be found.
+
+***
+
+### update()
+
+> **update**(`id`, `mimeType`?, `extension`?, `metadata`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+
+Update the blob with metadata.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the blob metadata to update.
+
+• **mimeType?**: `string`
+
+Mime type for the blob, will be detected if left undefined.
+
+• **extension?**: `string`
+
+Extension for the blob, will be detected if left undefined.
+
+• **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`\>
+
+Nothing.
+
+#### Throws
+
+Not found error if the blob cannot be found.
+
+***
+
+### remove()
+
+> **remove**(`id`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+
+Remove the blob.
+
+#### Parameters
+
+• **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`\>
+
+Nothing.
+
+#### Throws
+
+Not found error if the blob cannot be found.
+
+***
+
+### query()
+
+> **query**(`conditions`?, `sortProperties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`object`\>
+
+Query all the blob storage entries which match the conditions.
+
+#### Parameters
+
+• **conditions?**: `EntityCondition`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
+
+The conditions to match for the entries.
+
+• **sortProperties?**: `object`[]
+
+The optional sort order.
+
+• **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`\<`object`\>
+
+All the entries for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+##### entities
+
+> **entities**: [`IBlobStorageEntry`](IBlobStorageEntry.md)[]
+
+The entities.
+
+##### cursor?
+
+> `optional` **cursor**: `string`
+
+An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IBlobStorageConnector.md

@@ -0,0 +1,67 @@
+# Interface: IBlobStorageConnector
+
+Interface describing an blob storage connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### set()
+
+> **set**(`blob`): `Promise`\<`string`\>
+
+Set the blob.
+
+#### Parameters
+
+• **blob**: `Uint8Array`
+
+The data for the blob.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the stored blob in urn format.
+
+***
+
+### get()
+
+> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\>
+
+Get the blob.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the blob to get in urn format.
+
+#### Returns
+
+`Promise`\<`undefined` \| `Uint8Array`\>
+
+The data for the blob if it can be found or undefined.
+
+***
+
+### remove()
+
+> **remove**(`id`): `Promise`\<`boolean`\>
+
+Remove the blob.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the blob to remove in urn format.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the blob was found.

package/docs/reference/interfaces/IBlobStorageCreateRequest.md

@@ -0,0 +1,41 @@
+# Interface: IBlobStorageCreateRequest
+
+Request to create an entry in blob storage.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The body parameters.
+
+#### blob
+
+> **blob**: `string`
+
+The data to store in base64 encoding.
+
+#### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The mime type of the blob, will be detected if left undefined.
+
+#### extension?
+
+> `optional` **extension**: `string`
+
+The extension of the blob, will be detected if left undefined.
+
+#### metadata?
+
+> `optional` **metadata**: `IJsonLdNodeObject`
+
+Custom metadata to associate with the blob as JSON-LD.
+
+#### namespace?
+
+> `optional` **namespace**: `string`
+
+The namespace to store the data in, defaults to component configured namespace.

package/docs/reference/interfaces/IBlobStorageEntry.md

@@ -0,0 +1,35 @@
+# Interface: IBlobStorageEntry
+
+Interface describing a blob storage entry.
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id for the blob.
+
+***
+
+### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The mime type for the blob.
+
+***
+
+### extension?
+
+> `optional` **extension**: `string`
+
+The extension.
+
+***
+
+### metadata?
+
+> `optional` **metadata**: `IJsonLdNodeObject`
+
+The metadata for the blob as JSON-LD.

package/docs/reference/interfaces/IBlobStorageGetContentRequest.md

@@ -0,0 +1,45 @@
+# Interface: IBlobStorageGetContentRequest
+
+Request to get the content from blob storage.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the blob to get in urn format.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### download?
+
+> `optional` **download**: `boolean`
+
+Set the download flag which should prompt the browser to save the file.
+Otherwise the browser should show the content inside the page.
+
+##### Default
+
+```ts
+false
+```
+
+#### filename?
+
+> `optional` **filename**: `string`
+
+Set the filename to use when a download is triggered.
+A filename will be generated if not provided.

package/docs/reference/interfaces/IBlobStorageGetContentResponse.md

@@ -0,0 +1,11 @@
+# Interface: IBlobStorageGetContentResponse
+
+Response to get an entry from blob storage.
+
+## Properties
+
+### body
+
+> **body**: `Uint8Array`
+
+The body parameters.

package/docs/reference/interfaces/IBlobStorageGetRequest.md

@@ -0,0 +1,37 @@
+# Interface: IBlobStorageGetRequest
+
+Request to get an entry from blob storage.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the blob to get in urn format.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### includeContent?
+
+> `optional` **includeContent**: `boolean`
+
+Include the content in the response, otherwise only metadata is returned.
+
+##### Default
+
+```ts
+false
+```

package/docs/reference/interfaces/IBlobStorageGetResponse.md

@@ -0,0 +1,35 @@
+# Interface: IBlobStorageGetResponse
+
+Response to get an entry from blob storage.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The body parameters.
+
+#### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The mime type of the blob.
+
+#### extension?
+
+> `optional` **extension**: `string`
+
+The extension of the blob.
+
+#### metadata?
+
+> `optional` **metadata**: `IJsonLdNodeObject`
+
+Custom metadata to associate with the blob as JSON-LD.
+
+#### blob?
+
+> `optional` **blob**: `string`
+
+The blob in base64 format, if the includeContent flag was set in the request.

package/docs/reference/interfaces/IBlobStorageListRequest.md

@@ -0,0 +1,35 @@
+# Interface: IBlobStorageListRequest
+
+Query the entries from blob storage.
+
+## Properties
+
+### query?
+
+> `optional` **query**: `object`
+
+The parameters from the query.
+
+#### conditions?
+
+> `optional` **conditions**: `string`
+
+The condition for the query as JSON version of EntityCondition type.
+
+#### sortProperties?
+
+> `optional` **sortProperties**: `string`
+
+The sort property array as JSON serialization of property,direction.
+
+#### pageSize?
+
+> `optional` **pageSize**: `number`
+
+The number of entries to return per page.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor to get next chunk of data, returned in previous response.

package/docs/reference/interfaces/IBlobStorageListResponse.md

@@ -0,0 +1,23 @@
+# Interface: IBlobStorageListResponse
+
+Response to getting the list of entries from a query.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The list of entries from the query.
+
+#### entities
+
+> **entities**: [`IBlobStorageEntry`](IBlobStorageEntry.md)[]
+
+The entities from the query.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor for the next page.

package/docs/reference/interfaces/IBlobStorageRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IBlobStorageRemoveRequest
+
+Request to remove an entry from blob storage.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the blob to remove in urn format.

package/docs/reference/interfaces/IBlobStorageUpdateRequest.md

@@ -0,0 +1,43 @@
+# Interface: IBlobStorageUpdateRequest
+
+Request to update a blob entry.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the blob to get in urn format.
+
+***
+
+### body
+
+> **body**: `object`
+
+The body parameters.
+
+#### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The mime type of the blob, will be detected if left undefined.
+
+#### extension?
+
+> `optional` **extension**: `string`
+
+The extension of the blob, will be detected if left undefined.
+
+#### metadata?
+
+> `optional` **metadata**: `IJsonLdNodeObject`
+
+Custom metadata to associate with the blob as JSON-LD.

package/docs/reference/variables/BlobStorageConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: BlobStorageConnectorFactory
+
+> `const` **BlobStorageConnectorFactory**: `Factory`\<[`IBlobStorageConnector`](../interfaces/IBlobStorageConnector.md)\>
+
+Factory for creating blob storage connectors.

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+	"name": "@twin.org/blob-storage-models",
+	"version": "0.0.1-next.10",
+	"description": "Models which define the structure of the blob storage contracts and connectors",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/blob-storage.git",
+		"directory": "packages/blob-storage-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}