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

package/dist/cjs/index.cjs

@@ -1,6 +1,7 @@
 'use strict';
 
 var apiCore = require('@twin.org/api-core');
+var apiModels = require('@twin.org/api-models');
 var core = require('@twin.org/core');
 var web = require('@twin.org/web');
 
@@ -29,21 +30,26 @@ class BlobStorageClient extends apiCore.BaseRestClient {
     /**
      * Create the blob with some metadata.
      * @param blob The data for the blob in base64 format.
-     * @param mimeType Mime type for the blob, will be detected if left undefined.
-     * @param extension Extension for the blob, will be detected if left undefined.
+     * @param encodingFormat Mime type for the blob, will be detected if left undefined.
+     * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
-     * @param namespace The namespace to use for storing, defaults to component configured namespace.
+     * @param options Optional options for the creation of the blob.
+     * @param options.disableEncryption Disables encryption if enabled by default.
+     * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.
+     * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
      * @returns The id of the stored blob in urn format.
      */
-    async create(blob, mimeType, extension, metadata, namespace) {
+    async create(blob, encodingFormat, fileExtension, metadata, options) {
         core.Guards.stringBase64(this.CLASS_NAME, "blob", blob);
         const response = await this.fetch("/", "POST", {
             body: {
                 blob,
-                mimeType,
-                extension,
+                encodingFormat,
+                fileExtension,
                 metadata,
-                namespace
+                disableEncryption: options?.disableEncryption,
+                overrideVaultKeyId: options?.overrideVaultKeyId,
+                namespace: options?.namespace
             }
         });
         return response.headers[web.HeaderTypes.Location];
@@ -51,45 +57,48 @@ class BlobStorageClient extends apiCore.BaseRestClient {
     /**
      * Get the blob and metadata.
      * @param id The id of the blob to get in urn format.
-     * @param includeContent Include the content, or just get the metadata.
+     * @param options Optional options for the retrieval of the blob.
+     * @param options.includeContent Include the content, or just get the metadata.
+     * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
+     * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
      * @returns The metadata and data for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
-    async get(id, includeContent) {
+    async get(id, options) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
+            headers: {
+                [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
+            },
             pathParams: {
                 id
             },
             query: {
-                includeContent
+                includeContent: core.Coerce.string(options?.includeContent),
+                decompress: core.Coerce.string(options?.decompress),
+                overrideVaultKeyId: options?.overrideVaultKeyId
             }
         });
-        return {
-            blob: response.body.blob,
-            mimeType: response.body.mimeType,
-            extension: response.body.extension,
-            metadata: response.body.metadata
-        };
+        return response.body;
     }
     /**
      * Update the blob with metadata.
      * @param id The id of the blob metadata to update.
-     * @param mimeType Mime type for the blob, will be detected if left undefined.
-     * @param extension Extension for the blob, will be detected if left undefined.
+     * @param encodingFormat Mime type for the blob, will be detected if left undefined.
+     * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    async update(id, mimeType, extension, metadata) {
+    async update(id, encodingFormat, fileExtension, metadata) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
         await this.fetch("/:id", "PUT", {
             pathParams: {
                 id
             },
             body: {
-                mimeType,
-                extension,
+                encodingFormat,
+                fileExtension,
                 metadata
             }
         });
@@ -107,6 +116,31 @@ class BlobStorageClient extends apiCore.BaseRestClient {
             }
         });
     }
+    /**
+     * Query all the blob storage entries which match the conditions.
+     * @param conditions The conditions to match for the entries.
+     * @param orderBy The order for the results, defaults to created.
+     * @param orderByDirection The direction for the order, defaults to descending.
+     * @param cursor The cursor to request the next page of entries.
+     * @param pageSize The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
+     * @returns All the entries for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    async query(conditions, orderBy, orderByDirection, cursor, pageSize) {
+        const response = await this.fetch("/", "GET", {
+            headers: {
+                [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
+            },
+            query: {
+                conditions: apiModels.HttpParameterHelper.objectToString(conditions),
+                orderBy,
+                orderByDirection,
+                pageSize,
+                cursor
+            }
+        });
+        return response.body;
+    }
     /**
      * Create a download link for the blob.
      * @param id The id of the blob to get in urn format.

package/dist/esm/index.mjs

@@ -1,6 +1,7 @@
 import { BaseRestClient } from '@twin.org/api-core';
-import { Guards, Urn, StringHelper, Is } from '@twin.org/core';
-import { HeaderTypes } from '@twin.org/web';
+import { HttpParameterHelper } from '@twin.org/api-models';
+import { Guards, Urn, Coerce, StringHelper, Is } from '@twin.org/core';
+import { HeaderTypes, MimeTypes } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -27,21 +28,26 @@ class BlobStorageClient extends BaseRestClient {
     /**
      * Create the blob with some metadata.
      * @param blob The data for the blob in base64 format.
-     * @param mimeType Mime type for the blob, will be detected if left undefined.
-     * @param extension Extension for the blob, will be detected if left undefined.
+     * @param encodingFormat Mime type for the blob, will be detected if left undefined.
+     * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
-     * @param namespace The namespace to use for storing, defaults to component configured namespace.
+     * @param options Optional options for the creation of the blob.
+     * @param options.disableEncryption Disables encryption if enabled by default.
+     * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.
+     * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
      * @returns The id of the stored blob in urn format.
      */
-    async create(blob, mimeType, extension, metadata, namespace) {
+    async create(blob, encodingFormat, fileExtension, metadata, options) {
         Guards.stringBase64(this.CLASS_NAME, "blob", blob);
         const response = await this.fetch("/", "POST", {
             body: {
                 blob,
-                mimeType,
-                extension,
+                encodingFormat,
+                fileExtension,
                 metadata,
-                namespace
+                disableEncryption: options?.disableEncryption,
+                overrideVaultKeyId: options?.overrideVaultKeyId,
+                namespace: options?.namespace
             }
         });
         return response.headers[HeaderTypes.Location];
@@ -49,45 +55,48 @@ class BlobStorageClient extends BaseRestClient {
     /**
      * Get the blob and metadata.
      * @param id The id of the blob to get in urn format.
-     * @param includeContent Include the content, or just get the metadata.
+     * @param options Optional options for the retrieval of the blob.
+     * @param options.includeContent Include the content, or just get the metadata.
+     * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
+     * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
      * @returns The metadata and data for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
-    async get(id, includeContent) {
+    async get(id, options) {
         Urn.guard(this.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
+            headers: {
+                [HeaderTypes.Accept]: MimeTypes.JsonLd
+            },
             pathParams: {
                 id
             },
             query: {
-                includeContent
+                includeContent: Coerce.string(options?.includeContent),
+                decompress: Coerce.string(options?.decompress),
+                overrideVaultKeyId: options?.overrideVaultKeyId
             }
         });
-        return {
-            blob: response.body.blob,
-            mimeType: response.body.mimeType,
-            extension: response.body.extension,
-            metadata: response.body.metadata
-        };
+        return response.body;
     }
     /**
      * Update the blob with metadata.
      * @param id The id of the blob metadata to update.
-     * @param mimeType Mime type for the blob, will be detected if left undefined.
-     * @param extension Extension for the blob, will be detected if left undefined.
+     * @param encodingFormat Mime type for the blob, will be detected if left undefined.
+     * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    async update(id, mimeType, extension, metadata) {
+    async update(id, encodingFormat, fileExtension, metadata) {
         Urn.guard(this.CLASS_NAME, "id", id);
         await this.fetch("/:id", "PUT", {
             pathParams: {
                 id
             },
             body: {
-                mimeType,
-                extension,
+                encodingFormat,
+                fileExtension,
                 metadata
             }
         });
@@ -105,6 +114,31 @@ class BlobStorageClient extends BaseRestClient {
             }
         });
     }
+    /**
+     * Query all the blob storage entries which match the conditions.
+     * @param conditions The conditions to match for the entries.
+     * @param orderBy The order for the results, defaults to created.
+     * @param orderByDirection The direction for the order, defaults to descending.
+     * @param cursor The cursor to request the next page of entries.
+     * @param pageSize The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
+     * @returns All the entries for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    async query(conditions, orderBy, orderByDirection, cursor, pageSize) {
+        const response = await this.fetch("/", "GET", {
+            headers: {
+                [HeaderTypes.Accept]: MimeTypes.JsonLd
+            },
+            query: {
+                conditions: HttpParameterHelper.objectToString(conditions),
+                orderBy,
+                orderByDirection,
+                pageSize,
+                cursor
+            }
+        });
+        return response.body;
+    }
     /**
      * Create a download link for the blob.
      * @param id The id of the blob to get in urn format.

package/dist/types/blobStorageClient.d.ts

@@ -1,7 +1,8 @@
 import { BaseRestClient } from "@twin.org/api-core";
-import type { IBaseRestClientConfig } from "@twin.org/api-models";
-import type { IBlobStorageComponent } from "@twin.org/blob-storage-models";
+import { type IBaseRestClientConfig } from "@twin.org/api-models";
+import type { IBlobStorageComponent, IBlobStorageEntry, IBlobStorageEntryList } from "@twin.org/blob-storage-models";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { EntityCondition, SortDirection } from "@twin.org/entity";
 /**
  * Client for performing blob storage through to REST endpoints.
  */
@@ -18,42 +19,62 @@ export declare class BlobStorageClient extends BaseRestClient implements IBlobSt
     /**
      * Create the blob with some metadata.
      * @param blob The data for the blob in base64 format.
-     * @param mimeType Mime type for the blob, will be detected if left undefined.
-     * @param extension Extension for the blob, will be detected if left undefined.
+     * @param encodingFormat Mime type for the blob, will be detected if left undefined.
+     * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
-     * @param namespace The namespace to use for storing, defaults to component configured namespace.
+     * @param options Optional options for the creation of the blob.
+     * @param options.disableEncryption Disables encryption if enabled by default.
+     * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.
+     * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
      * @returns The id of the stored blob in urn format.
      */
-    create(blob: string, mimeType?: string, extension?: string, metadata?: IJsonLdNodeObject, namespace?: string): Promise<string>;
+    create(blob: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, options?: {
+        disableEncryption?: boolean;
+        overrideVaultKeyId?: string;
+        namespace?: string;
+    }): Promise<string>;
     /**
      * Get the blob and metadata.
      * @param id The id of the blob to get in urn format.
-     * @param includeContent Include the content, or just get the metadata.
+     * @param options Optional options for the retrieval of the blob.
+     * @param options.includeContent Include the content, or just get the metadata.
+     * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
+     * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
      * @returns The metadata and data for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
-    get(id: string, includeContent: boolean): Promise<{
-        blob?: string;
-        mimeType?: string;
-        extension?: string;
-        metadata?: IJsonLdNodeObject;
-    }>;
+    get(id: string, options?: {
+        includeContent?: boolean;
+        decompress?: boolean;
+        overrideVaultKeyId?: string;
+    }): Promise<IBlobStorageEntry>;
     /**
      * Update the blob with metadata.
      * @param id The id of the blob metadata to update.
-     * @param mimeType Mime type for the blob, will be detected if left undefined.
-     * @param extension Extension for the blob, will be detected if left undefined.
+     * @param encodingFormat Mime type for the blob, will be detected if left undefined.
+     * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    update(id: string, mimeType?: string, extension?: string, metadata?: IJsonLdNodeObject): Promise<void>;
+    update(id: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject): Promise<void>;
     /**
      * Remove the blob.
      * @param id The id of the blob to remove in urn format.
      * @returns Nothing.
      */
     remove(id: string): Promise<void>;
+    /**
+     * Query all the blob storage entries which match the conditions.
+     * @param conditions The conditions to match for the entries.
+     * @param orderBy The order for the results, defaults to created.
+     * @param orderByDirection The direction for the order, defaults to descending.
+     * @param cursor The cursor to request the next page of entries.
+     * @param pageSize The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
+     * @returns All the entries for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, pageSize?: number): Promise<IBlobStorageEntryList>;
     /**
      * Create a download link for the blob.
      * @param id The id of the blob to get in urn format.

package/docs/changelog.md

@@ -1,5 +1,162 @@
 # @twin.org/blob-storage-rest-client - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.2-next.0...blob-storage-rest-client-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))
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+
+## 0.0.1 (2025-07-04)
+
+
+### Features
+
+* release to production ([eacfe75](https://github.com/twinfoundation/blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.37](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.36...blob-storage-rest-client-v0.0.1-next.37) (2025-06-20)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.36 to 0.0.1-next.37
+
+## [0.0.1-next.36](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.35...blob-storage-rest-client-v0.0.1-next.36) (2025-06-19)
+
+
+### Features
+
+* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.35 to 0.0.1-next.36
+
+## [0.0.1-next.35](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.34...blob-storage-rest-client-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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+
+## [0.0.1-next.34](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.33...blob-storage-rest-client-v0.0.1-next.34) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.33 to 0.0.1-next.34
+
+## [0.0.1-next.33](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.32...blob-storage-rest-client-v0.0.1-next.33) (2025-06-03)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.32 to 0.0.1-next.33
+
+## [0.0.1-next.32](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.31...blob-storage-rest-client-v0.0.1-next.32) (2025-05-28)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.31 to 0.0.1-next.32
+
+## [0.0.1-next.31](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.30...blob-storage-rest-client-v0.0.1-next.31) (2025-05-08)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.30 to 0.0.1-next.31
+
+## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.29...blob-storage-rest-client-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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.1-next.28...blob-storage-rest-client-v0.0.1-next.29) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## v0.0.1-next.28
 
 - Initial Release

package/docs/reference/classes/BlobStorageClient.md

@@ -12,21 +12,23 @@ Client for performing blob storage through to REST endpoints.
 
 ## Constructors
 
-### new BlobStorageClient()
+### Constructor
 
-> **new BlobStorageClient**(`config`): [`BlobStorageClient`](BlobStorageClient.md)
+> **new BlobStorageClient**(`config`): `BlobStorageClient`
 
 Create a new instance of BlobStorageClient.
 
 #### Parameters
 
-• **config**: `IBaseRestClientConfig`
+##### config
+
+`IBaseRestClientConfig`
 
 The configuration for the client.
 
 #### Returns
 
-[`BlobStorageClient`](BlobStorageClient.md)
+`BlobStorageClient`
 
 #### Overrides
 
@@ -48,29 +50,55 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`blob`, `mimeType`?, `extension`?, `metadata`?, `namespace`?): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`): `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.
+
+###### namespace?
+
+`string`
 
 The namespace to use for storing, defaults to component configured namespace.
 
@@ -88,41 +116,45 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `includeContent`): `Promise`\<`object`\>
+> **get**(`id`, `options?`): `Promise`\<`IBlobStorageEntry`\>
 
 Get the blob and metadata.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
-• **includeContent**: `boolean`
+##### options?
 
-Include the content, or just get the metadata.
+Optional options for the retrieval of the blob.
 
-#### Returns
+###### includeContent?
 
-`Promise`\<`object`\>
+`boolean`
 
-The metadata and data for the blob if it can be found.
+Include the content, or just get the metadata.
 
-##### blob?
+###### decompress?
 
-> `optional` **blob**: `string`
+`boolean`
 
-##### mimeType?
+If the content should be decompressed, if it was compressed when stored, defaults to true.
 
-> `optional` **mimeType**: `string`
+###### overrideVaultKeyId?
 
-##### extension?
+`string`
 
-> `optional` **extension**: `string`
+Use a different vault key id for decryption, if not provided the default vault key id will be used.
 
-##### metadata?
+#### Returns
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+`Promise`\<`IBlobStorageEntry`\>
+
+The metadata and data for the blob if it can be found.
 
 #### Throws
 
@@ -136,25 +168,33 @@ Not found error if the blob cannot be found.
 
 ### update()
 
-> **update**(`id`, `mimeType`?, `extension`?, `metadata`?): `Promise`\<`void`\>
+> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`): `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.
 
@@ -182,7 +222,9 @@ Remove the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to remove in urn format.
 
@@ -198,23 +240,80 @@ Nothing.
 
 ***
 
+### query()
+
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`): `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.
+
+#### 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`
+
+***
+
 ### createDownloadLink()
 
-> **createDownloadLink**(`id`, `download`?, `filename`?): `string`
+> **createDownloadLink**(`id`, `download?`, `filename?`): `string`
 
 Create a download link for the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
-• **download?**: `boolean`
+##### download?
+
+`boolean`
 
 Should the content disposition be set to download.
 
-• **filename?**: `string`
+##### filename?
+
+`string`
 
 The filename to use for the download.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-rest-client",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Blob storage implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -16,9 +16,10 @@
 	"dependencies": {
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
-		"@twin.org/blob-storage-models": "0.0.1-next.9",
+		"@twin.org/blob-storage-models": "0.0.2-next.1",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
@@ -27,11 +28,11 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",