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

package/dist/types/models/api/IBlobStorageGetRequest.d.ts

@@ -1,7 +1,14 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
  * Request to get an entry from blob storage.
  */
 export interface IBlobStorageGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
     /**
      * The path parameters.
      */
@@ -19,6 +26,16 @@ export interface IBlobStorageGetRequest {
          * Include the content in the response, otherwise only metadata is returned.
          * @default false
          */
-        includeContent?: boolean;
+        includeContent?: boolean | string;
+        /**
+         * If the content should be decompressed, if it was compressed when stored, defaults to true.
+         * @default true
+         */
+        decompress?: boolean | string;
+        /**
+         * Use a different vault key id for decryption, if not provided the default vault key id will be used.
+         * @default undefined
+         */
+        overrideVaultKeyId?: string;
     };
 }

package/dist/types/models/api/IBlobStorageGetResponse.d.ts

@@ -1,27 +1,17 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IBlobStorageEntry } from "../IBlobStorageEntry";
 /**
  * Response to get an entry from blob storage.
  */
 export interface IBlobStorageGetResponse {
     /**
-     * The body parameters.
+     * The headers which can be used to determine the response data type.
      */
-    body: {
-        /**
-         * The mime type of the blob.
-         */
-        mimeType?: string;
-        /**
-         * The extension of the blob.
-         */
-        extension?: string;
-        /**
-         * Custom metadata to associate with the blob as JSON-LD.
-         */
-        metadata?: IJsonLdNodeObject;
-        /**
-         * The blob in base64 format, if the includeContent flag was set in the request.
-         */
-        blob?: string;
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
     };
+    /**
+     * The body parameters.
+     */
+    body: IBlobStorageEntry;
 }

package/dist/types/models/api/IBlobStorageListRequest.d.ts

@@ -0,0 +1,39 @@
+import type { SortDirection } from "@twin.org/entity";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IBlobStorageEntry } from "../IBlobStorageEntry";
+/**
+ * Query the entries from blob storage.
+ */
+export interface IBlobStorageListRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the query.
+     */
+    query?: {
+        /**
+         * The condition for the query as JSON version of EntityCondition type.
+         */
+        conditions?: string;
+        /**
+         * The order for the results, default to created.
+         */
+        orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">;
+        /**
+         * The direction for the order, defaults to desc.
+         */
+        orderByDirection?: SortDirection;
+        /**
+         * The number of entries to return per page.
+         */
+        pageSize?: number | string;
+        /**
+         * The cursor to get next chunk of data, returned in previous response.
+         */
+        cursor?: string;
+    };
+}

package/dist/types/models/api/IBlobStorageListResponse.d.ts

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IBlobStorageEntryList } from "../IBlobStorageEntryList";
+/**
+ * Response to getting the list of entries from a query.
+ */
+export interface IBlobStorageListResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The list of entries from the query.
+     */
+    body: IBlobStorageEntryList;
+}

package/dist/types/models/api/IBlobStorageUpdateRequest.d.ts

@@ -19,11 +19,11 @@ export interface IBlobStorageUpdateRequest {
         /**
          * The mime type of the blob, will be detected if left undefined.
          */
-        mimeType?: string;
+        encodingFormat?: string;
         /**
          * The extension of the blob, will be detected if left undefined.
          */
-        extension?: string;
+        fileExtension?: string;
         /**
          * Custom metadata to associate with the blob as JSON-LD.
          */

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

@@ -0,0 +1,17 @@
+/**
+ * The types of compression for blob storage data.
+ */
+export declare const BlobStorageCompressionType: {
+    /**
+     * Gzip.
+     */
+    readonly Gzip: "gzip";
+    /**
+     * Deflate.
+     */
+    readonly Deflate: "deflate";
+};
+/**
+ * The types of compression for blob storage data.
+ */
+export type BlobStorageCompressionType = (typeof BlobStorageCompressionType)[keyof typeof BlobStorageCompressionType];

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

@@ -0,0 +1,17 @@
+/**
+ * The contexts of blob storage data.
+ */
+export declare const BlobStorageContexts: {
+    /**
+     * The context root for the blob storage types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/blob-storage/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of blob storage data.
+ */
+export type BlobStorageContexts = (typeof BlobStorageContexts)[keyof typeof BlobStorageContexts];

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

@@ -0,0 +1,17 @@
+/**
+ * The types of blob storage data.
+ */
+export declare const BlobStorageTypes: {
+    /**
+     * Represents blob storage entry.
+     */
+    readonly Entry: "BlobStorageEntry";
+    /**
+     * Represents blob storage entry compression.
+     */
+    readonly CompressionType: "BlobStorageCompressionType";
+};
+/**
+ * The types of blob storage data.
+ */
+export type BlobStorageTypes = (typeof BlobStorageTypes)[keyof typeof BlobStorageTypes];

package/docs/changelog.md

@@ -1,5 +1,95 @@
 # @twin.org/blob-storage-models - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.0...blob-storage-models-v0.0.2-next.1) (2025-07-24)
+
+
+### Features
+
+* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+* additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
+* remove includeNodeIdentity flag ([13bc334](https://github.com/twinfoundation/blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
+* update ts-to-schema generation ([03439c7](https://github.com/twinfoundation/blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
+* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+* use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
+
+
+### 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))
+* query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
+
+## 0.0.1 (2025-07-04)
+
+
+### Features
+
+* release to production ([eacfe75](https://github.com/twinfoundation/blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
+
+## [0.0.1-next.37](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.36...blob-storage-models-v0.0.1-next.37) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
+
+## [0.0.1-next.36](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.35...blob-storage-models-v0.0.1-next.36) (2025-06-19)
+
+
+### Features
+
+* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+
+## [0.0.1-next.35](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.34...blob-storage-models-v0.0.1-next.35) (2025-06-17)
+
+
+### Features
+
+* additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
+
+## [0.0.1-next.34](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.33...blob-storage-models-v0.0.1-next.34) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+
+## [0.0.1-next.33](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.32...blob-storage-models-v0.0.1-next.33) (2025-06-03)
+
+
+### Features
+
+* update ts-to-schema generation ([03439c7](https://github.com/twinfoundation/blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
+
+## [0.0.1-next.32](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.31...blob-storage-models-v0.0.1-next.32) (2025-05-28)
+
+
+### Features
+
+* update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
+
+## [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,34 @@
 # @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
+
+- [BlobStorageCompressionType](type-aliases/BlobStorageCompressionType.md)
+- [BlobStorageContexts](type-aliases/BlobStorageContexts.md)
+- [BlobStorageTypes](type-aliases/BlobStorageTypes.md)
+
 ## Variables
 
 - [BlobStorageConnectorFactory](variables/BlobStorageConnectorFactory.md)
+- [BlobStorageCompressionType](variables/BlobStorageCompressionType.md)
+- [BlobStorageContexts](variables/BlobStorageContexts.md)
+- [BlobStorageTypes](variables/BlobStorageTypes.md)

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -10,37 +10,73 @@ Interface describing an blob storage component.
 
 ### create()
 
-> **create**(`blob`, `mimeType`?, `extension`?, `metadata`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`, `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`
+##### options?
+
+Optional options for the creation of the blob.
+
+###### disableEncryption?
+
+`boolean`
+
+Disables encryption if enabled by default.
+
+###### overrideVaultKeyId?
+
+`string`
+
+Use a different vault key id for encryption, if not provided the default vault key id will be used.
+
+###### compress?
+
+[`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
+
+Optional compression type to use for the blob, defaults to no compression.
+
+###### namespace?
+
+`string`
 
 The namespace to use for storing, defaults to component configured namespace.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The user identity to use with storage operations.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use with storage operations.
 
@@ -54,49 +90,57 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `includeContent`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`object`\>
+> **get**(`id`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
 Get the blob and metadata.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
-• **includeContent**: `boolean`
+##### options?
+
+Optional options for the retrieval of the blob.
+
+###### includeContent?
+
+`boolean`
 
 Include the content, or just get the metadata.
 
-• **userIdentity?**: `string`
+###### decompress?
 
-The user identity to use with storage operations.
+`boolean`
 
-• **nodeIdentity?**: `string`
+If the content should be decompressed, if it was compressed when stored, defaults to true.
 
-The node identity to use with storage operations.
+###### overrideVaultKeyId?
 
-#### Returns
+`string`
 
-`Promise`\<`object`\>
+Use a different vault key id for decryption, if not provided the default vault key id will be used.
 
-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
 
@@ -106,35 +150,41 @@ Not found error if the blob cannot be found.
 
 ### update()
 
-> **update**(`id`, `mimeType`?, `extension`?, `metadata`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`, `userIdentity?`): `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.
+##### userIdentity?
 
-• **nodeIdentity?**: `string`
+`string`
 
-The node identity to use with storage operations.
+The user identity to use with storage operations.
 
 #### Returns
 
@@ -150,23 +200,23 @@ Not found error if the blob cannot be found.
 
 ### remove()
 
-> **remove**(`id`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **remove**(`id`, `userIdentity?`): `Promise`\<`void`\>
 
 Remove the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
 
-The id of the blob to remove in urn format.
+`string`
 
-• **userIdentity?**: `string`
+The id of the blob to remove in urn format.
 
-The user identity to use with storage operations.
+##### userIdentity?
 
-• **nodeIdentity?**: `string`
+`string`
 
-The node identity to use with storage operations.
+The user identity to use with storage operations.
 
 #### Returns
 
@@ -177,3 +227,56 @@ Nothing.
 #### Throws
 
 Not found error if the blob cannot be found.
+
+***
+
+### query()
+
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`): `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.
+
+#### 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.