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

package/docs/changelog.md

@@ -1,5 +1,26 @@
 # @twin.org/blob-storage-models - Changelog
 
-## v0.0.1-next.3
+## [0.0.1-next.31](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.30...blob-storage-models-v0.0.1-next.31) (2025-05-08)
+
+
+### Features
+
+* use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
+
+## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.29...blob-storage-models-v0.0.1-next.30) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+
+## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.28...blob-storage-models-v0.0.1-next.29) (2025-03-28)
+
+
+### Bug Fixes
+
+* Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
+
+## v0.0.1-next.28
 
 - Initial Release

package/docs/reference/classes/BlobStorageDataTypes.md

@@ -0,0 +1,25 @@
+# Class: BlobStorageDataTypes
+
+Handle all the data types for blob storage.
+
+## Constructors
+
+### Constructor
+
+> **new BlobStorageDataTypes**(): `BlobStorageDataTypes`
+
+#### Returns
+
+`BlobStorageDataTypes`
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -1,17 +1,32 @@
 # @twin.org/blob-storage-models
 
+## Classes
+
+- [BlobStorageDataTypes](classes/BlobStorageDataTypes.md)
+
 ## Interfaces
 
 - [IBlobStorageComponent](interfaces/IBlobStorageComponent.md)
 - [IBlobStorageConnector](interfaces/IBlobStorageConnector.md)
+- [IBlobStorageEntry](interfaces/IBlobStorageEntry.md)
+- [IBlobStorageEntryList](interfaces/IBlobStorageEntryList.md)
 - [IBlobStorageCreateRequest](interfaces/IBlobStorageCreateRequest.md)
 - [IBlobStorageGetContentRequest](interfaces/IBlobStorageGetContentRequest.md)
 - [IBlobStorageGetContentResponse](interfaces/IBlobStorageGetContentResponse.md)
 - [IBlobStorageGetRequest](interfaces/IBlobStorageGetRequest.md)
 - [IBlobStorageGetResponse](interfaces/IBlobStorageGetResponse.md)
+- [IBlobStorageListRequest](interfaces/IBlobStorageListRequest.md)
+- [IBlobStorageListResponse](interfaces/IBlobStorageListResponse.md)
 - [IBlobStorageRemoveRequest](interfaces/IBlobStorageRemoveRequest.md)
 - [IBlobStorageUpdateRequest](interfaces/IBlobStorageUpdateRequest.md)
 
+## Type Aliases
+
+- [BlobStorageContexts](type-aliases/BlobStorageContexts.md)
+- [BlobStorageTypes](type-aliases/BlobStorageTypes.md)
+
 ## Variables
 
 - [BlobStorageConnectorFactory](variables/BlobStorageConnectorFactory.md)
+- [BlobStorageContexts](variables/BlobStorageContexts.md)
+- [BlobStorageTypes](variables/BlobStorageTypes.md)

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -10,35 +10,53 @@ Interface describing an blob storage component.
 
 ### 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?
 
-The node identity which controls the vault key.
+`string`
+
+The node identity to use with storage operations.
 
 #### Returns
 
@@ -50,45 +68,41 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `includeContent`, `nodeIdentity`?): `Promise`\<`object`\>
+> **get**(`id`, `includeContent`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
 Get the blob and metadata.
 
 #### Parameters
 
-• **id**: `string`
-
-The id of the blob to get in urn format.
+##### id
 
-• **includeContent**: `boolean`
-
-Include the content, or just get the metadata.
+`string`
 
-• **nodeIdentity?**: `string`
+The id of the blob to get in urn format.
 
-The node identity which controls the vault key.
+##### includeContent
 
-#### Returns
+`boolean`
 
-`Promise`\<`object`\>
+Include the content, or just get the metadata.
 
-The data and metadata for the blob if it can be found.
+##### userIdentity?
 
-##### blob?
+`string`
 
-> `optional` **blob**: `string`
+The user identity to use with storage operations.
 
-##### mimeType?
+##### nodeIdentity?
 
-> `optional` **mimeType**: `string`
+`string`
 
-##### extension?
+The node identity to use with storage operations.
 
-> `optional` **extension**: `string`
+#### Returns
 
-##### metadata?
+`Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+The data and metadata for the blob if it can be found.
 
 #### Throws
 
@@ -98,28 +112,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.
 
-• **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`\>
@@ -134,16 +168,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`\>
@@ -153,3 +201,62 @@ Nothing.
 #### Throws
 
 Not found error if the blob cannot be found.
+
+***
+
+### query()
+
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
+
+Query all the blob storage entries which match the conditions.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
+
+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`](IBlobStorageEntryList.md)\>
+
+All the entries for the storage matching the conditions,
+and a cursor which can be used to request more entities.

package/docs/reference/interfaces/IBlobStorageConnector.md

@@ -16,7 +16,9 @@ Set the blob.
 
 #### Parameters
 
-• **blob**: `Uint8Array`
+##### blob
+
+`Uint8Array`
 
 The data for the blob.
 
@@ -30,19 +32,21 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\>
+> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
 
 Get the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
 #### Returns
 
-`Promise`\<`undefined` \| `Uint8Array`\>
+`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
 
 The data for the blob if it can be found or undefined.
 
@@ -56,7 +60,9 @@ Remove the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to remove in urn format.
 

package/docs/reference/interfaces/IBlobStorageCreateRequest.md

@@ -16,15 +16,15 @@ The body parameters.
 
 The data to store in base64 encoding.
 
-#### mimeType?
+#### encodingFormat?
 
-> `optional` **mimeType**: `string`
+> `optional` **encodingFormat**: `string`
 
 The mime type of the blob, will be detected if left undefined.
 
-#### extension?
+#### fileExtension?
 
-> `optional` **extension**: `string`
+> `optional` **fileExtension**: `string`
 
 The extension of the blob, will be detected if left undefined.
 

package/docs/reference/interfaces/IBlobStorageEntry.md

@@ -0,0 +1,91 @@
+# Interface: IBlobStorageEntry
+
+Interface describing a blob storage entry.
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://schema.twindev.org/blob-storage/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"BlobStorageEntry"`
+
+JSON-LD Type.
+
+***
+
+### 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 size 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.
+
+***
+
+### blob?
+
+> `optional` **blob**: `string`
+
+The blob in base64 format, included if the includeContent flag was set in the request.

package/docs/reference/interfaces/IBlobStorageEntryList.md

@@ -0,0 +1,35 @@
+# Interface: IBlobStorageEntryList
+
+Interface describing an blob storage entry list.
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/blob-storage/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"ItemList"`
+
+JSON-LD Type.
+
+***
+
+### itemListElement
+
+> **itemListElement**: [`IBlobStorageEntry`](IBlobStorageEntry.md)[]
+
+The list of entries.
+
+***
+
+### nextItem?
+
+> `optional` **nextItem**: `string`
+
+The cursor to get the next chunk of entries.

package/docs/reference/interfaces/IBlobStorageGetRequest.md

@@ -4,6 +4,18 @@ Request to get an entry from blob storage.
 
 ## Properties
 
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
 ### pathParams
 
 > **pathParams**: `object`

package/docs/reference/interfaces/IBlobStorageGetResponse.md

@@ -4,32 +4,20 @@ Response to get an entry from blob storage.
 
 ## Properties
 
-### body
-
-> **body**: `object`
-
-The body parameters.
-
-#### mimeType?
+### headers?
 
-> `optional` **mimeType**: `string`
+> `optional` **headers**: `object`
 
-The mime type of the blob.
+The headers which can be used to determine the response data type.
 
-#### extension?
+#### content-type
 
-> `optional` **extension**: `string`
+> **content-type**: `"application/json"` \| `"application/ld+json"`
 
-The extension of the blob.
+***
 
-#### metadata?
-
-> `optional` **metadata**: `IJsonLdNodeObject`
-
-Custom metadata to associate with the blob as JSON-LD.
-
-#### blob?
+### body
 
-> `optional` **blob**: `string`
+> **body**: [`IBlobStorageEntry`](IBlobStorageEntry.md)
 
-The blob in base64 format, if the includeContent flag was set in the request.
+The body parameters.

package/docs/reference/interfaces/IBlobStorageListRequest.md

@@ -0,0 +1,53 @@
+# Interface: IBlobStorageListRequest
+
+Query the entries from blob storage.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The parameters from the query.
+
+#### conditions?
+
+> `optional` **conditions**: `string`
+
+The condition for the query as JSON version of EntityCondition type.
+
+#### orderBy?
+
+> `optional` **orderBy**: `"dateCreated"` \| `"dateModified"`
+
+The order for the results, default to created.
+
+#### orderByDirection?
+
+> `optional` **orderByDirection**: `SortDirection`
+
+The direction for the order, defaults to desc.
+
+#### 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
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body
+
+> **body**: [`IBlobStorageEntryList`](IBlobStorageEntryList.md)
+
+The list of entries from the query.