@twin.org/blob-storage-rest-client 0.0.2-next.4 → 0.0.3-next.1

package/dist/{esm/index.mjs → es/blobStorageRestClient.js}

@@ -1,29 +1,30 @@
-import { BaseRestClient } from '@twin.org/api-core';
-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.
+import { BaseRestClient } from "@twin.org/api-core";
+import { HttpParameterHelper } from "@twin.org/api-models";
+import { Coerce, Guards, Is, StringHelper, Urn } from "@twin.org/core";
+import { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
  * Client for performing blob storage through to REST endpoints.
  */
-class BlobStorageClient extends BaseRestClient {
+export class BlobStorageRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "BlobStorageClient";
+    static CLASS_NAME = "BlobStorageRestClient";
     /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = BlobStorageClient._CLASS_NAME;
-    /**
-     * Create a new instance of BlobStorageClient.
+     * Create a new instance of BlobStorageRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(BlobStorageClient._CLASS_NAME, config, "blob");
+        super(BlobStorageRestClient.CLASS_NAME, config, "blob");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return BlobStorageRestClient.CLASS_NAME;
     }
     /**
      * Create the blob with some metadata.
@@ -38,7 +39,7 @@ class BlobStorageClient extends BaseRestClient {
      * @returns The id of the stored blob in urn format.
      */
     async create(blob, encodingFormat, fileExtension, metadata, options) {
-        Guards.stringBase64(this.CLASS_NAME, "blob", blob);
+        Guards.stringBase64(BlobStorageRestClient.CLASS_NAME, "blob", blob);
         const response = await this.fetch("/", "POST", {
             body: {
                 blob,
@@ -63,7 +64,7 @@ class BlobStorageClient extends BaseRestClient {
      * @throws Not found error if the blob cannot be found.
      */
     async get(id, options) {
-        Urn.guard(this.CLASS_NAME, "id", id);
+        Urn.guard(BlobStorageRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -89,7 +90,7 @@ class BlobStorageClient extends BaseRestClient {
      * @throws Not found error if the blob cannot be found.
      */
     async update(id, encodingFormat, fileExtension, metadata) {
-        Urn.guard(this.CLASS_NAME, "id", id);
+        Urn.guard(BlobStorageRestClient.CLASS_NAME, "id", id);
         await this.fetch("/:id", "PUT", {
             pathParams: {
                 id
@@ -107,7 +108,7 @@ class BlobStorageClient extends BaseRestClient {
      * @returns Nothing.
      */
     async remove(id) {
-        Urn.guard(this.CLASS_NAME, "id", id);
+        Urn.guard(BlobStorageRestClient.CLASS_NAME, "id", id);
         await this.fetch("/:id", "DELETE", {
             pathParams: {
                 id
@@ -120,11 +121,11 @@ class BlobStorageClient extends BaseRestClient {
      * @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.
+     * @param limit 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) {
+    async query(conditions, orderBy, orderByDirection, cursor, limit) {
         const response = await this.fetch("/", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -133,7 +134,7 @@ class BlobStorageClient extends BaseRestClient {
                 conditions: HttpParameterHelper.objectToString(conditions),
                 orderBy,
                 orderByDirection,
-                pageSize,
+                limit: Coerce.string(limit),
                 cursor
             }
         });
@@ -147,7 +148,7 @@ class BlobStorageClient extends BaseRestClient {
      * @returns The download link.
      */
     createDownloadLink(id, download, filename) {
-        Urn.guard(this.CLASS_NAME, "id", id);
+        Urn.guard(BlobStorageRestClient.CLASS_NAME, "id", id);
         let link = StringHelper.trimTrailingSlashes(this.getEndpointWithPrefix());
         link += `/${id}/content`;
         const downloadQuery = [];
@@ -163,5 +164,4 @@ class BlobStorageClient extends BaseRestClient {
         return link;
     }
 }
-
-export { BlobStorageClient };
+//# sourceMappingURL=blobStorageRestClient.js.map

package/dist/es/blobStorageRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blobStorageRestClient.js","sourceRoot":"","sources":["../../src/blobStorageRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EACN,mBAAmB,EAInB,MAAM,sBAAsB,CAAC;AAa9B,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAIvE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAEvD;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACxD;;OAEG;IACI,MAAM,CAAU,UAAU,2BAA2C;IAE5E;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,qBAAqB,CAAC,UAAU,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,MAAM,CAClB,IAAY,EACZ,cAAuB,EACvB,aAAsB,EACtB,QAA4B,EAC5B,OAIC;QAED,MAAM,CAAC,YAAY,CAAC,qBAAqB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAE1E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAA8C,GAAG,EAAE,MAAM,EAAE;YAC3F,IAAI,EAAE;gBACL,IAAI;gBACJ,cAAc;gBACd,aAAa;gBACb,QAAQ;gBACR,iBAAiB,EAAE,OAAO,EAAE,iBAAiB;gBAC7C,kBAAkB,EAAE,OAAO,EAAE,kBAAkB;gBAC/C,SAAS,EAAE,OAAO,EAAE,SAAS;aAC7B;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,GAAG,CACf,EAAU,EACV,OAIC;QAED,GAAG,CAAC,KAAK,CAAC,qBAAqB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE5D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,MAAM,EACN,KAAK,EACL;YACC,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,MAAM;aACtC;YACD,UAAU,EAAE;gBACX,EAAE;aACF;YACD,KAAK,EAAE;gBACN,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,cAAc,CAAC;gBACtD,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC;gBAC9C,kBAAkB,EAAE,OAAO,EAAE,kBAAkB;aAC/C;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,MAAM,CAClB,EAAU,EACV,cAAuB,EACvB,aAAsB,EACtB,QAA4B;QAE5B,GAAG,CAAC,KAAK,CAAC,qBAAqB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE5D,MAAM,IAAI,CAAC,KAAK,CAAgD,MAAM,EAAE,KAAK,EAAE;YAC9E,UAAU,EAAE;gBACX,EAAE;aACF;YACD,IAAI,EAAE;gBACL,cAAc;gBACd,aAAa;gBACb,QAAQ;aACR;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,GAAG,CAAC,KAAK,CAAC,qBAAqB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE5D,MAAM,IAAI,CAAC,KAAK,CAAgD,MAAM,EAAE,QAAQ,EAAE;YACjF,UAAU,EAAE;gBACX,EAAE;aACF;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,KAAK,CACjB,UAA+C,EAC/C,OAAuE,EACvE,gBAAgC,EAChC,MAAe,EACf,KAAc;QAEd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,GAAG,EACH,KAAK,EACL;YACC,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,MAAM;aACtC;YACD,KAAK,EAAE;gBACN,UAAU,EAAE,mBAAmB,CAAC,cAAc,CAAC,UAAU,CAAC;gBAC1D,OAAO;gBACP,gBAAgB;gBAChB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;gBAC3B,MAAM;aACN;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,kBAAkB,CAAC,EAAU,EAAE,QAAkB,EAAE,QAAiB;QAC1E,GAAG,CAAC,KAAK,CAAC,qBAAqB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE5D,IAAI,IAAI,GAAG,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAC1E,IAAI,IAAI,IAAI,EAAE,UAAU,CAAC;QAEzB,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,IAAI,QAAQ,EAAE,CAAC;YACd,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,aAAa,CAAC,IAAI,CAAC,YAAY,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,IAAI,IAAI,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACvC,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport {\n\tHttpParameterHelper,\n\ttype IBaseRestClientConfig,\n\ttype ICreatedResponse,\n\ttype INoContentResponse\n} from \"@twin.org/api-models\";\nimport type {\n\tIBlobStorageComponent,\n\tIBlobStorageCreateRequest,\n\tIBlobStorageEntry,\n\tIBlobStorageEntryList,\n\tIBlobStorageGetRequest,\n\tIBlobStorageGetResponse,\n\tIBlobStorageListRequest,\n\tIBlobStorageListResponse,\n\tIBlobStorageRemoveRequest,\n\tIBlobStorageUpdateRequest\n} from \"@twin.org/blob-storage-models\";\nimport { Coerce, Guards, Is, StringHelper, Urn } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { EntityCondition, SortDirection } from \"@twin.org/entity\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Client for performing blob storage through to REST endpoints.\n */\nexport class BlobStorageRestClient extends BaseRestClient implements IBlobStorageComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<BlobStorageRestClient>();\n\n\t/**\n\t * Create a new instance of BlobStorageRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(BlobStorageRestClient.CLASS_NAME, config, \"blob\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn BlobStorageRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create the blob with some metadata.\n\t * @param blob The data for the blob in base64 format.\n\t * @param encodingFormat Mime type for the blob, will be detected if left undefined.\n\t * @param fileExtension Extension for the blob, will be detected if left undefined.\n\t * @param metadata Data for the custom metadata as JSON-LD.\n\t * @param options Optional options for the creation of the blob.\n\t * @param options.disableEncryption Disables encryption if enabled by default.\n\t * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.\n\t * @param options.namespace The namespace to use for storing, defaults to component configured namespace.\n\t * @returns The id of the stored blob in urn format.\n\t */\n\tpublic async create(\n\t\tblob: string,\n\t\tencodingFormat?: string,\n\t\tfileExtension?: string,\n\t\tmetadata?: IJsonLdNodeObject,\n\t\toptions?: {\n\t\t\tdisableEncryption?: boolean;\n\t\t\toverrideVaultKeyId?: string;\n\t\t\tnamespace?: string;\n\t\t}\n\t): Promise<string> {\n\t\tGuards.stringBase64(BlobStorageRestClient.CLASS_NAME, nameof(blob), blob);\n\n\t\tconst response = await this.fetch<IBlobStorageCreateRequest, ICreatedResponse>(\"/\", \"POST\", {\n\t\t\tbody: {\n\t\t\t\tblob,\n\t\t\t\tencodingFormat,\n\t\t\t\tfileExtension,\n\t\t\t\tmetadata,\n\t\t\t\tdisableEncryption: options?.disableEncryption,\n\t\t\t\toverrideVaultKeyId: options?.overrideVaultKeyId,\n\t\t\t\tnamespace: options?.namespace\n\t\t\t}\n\t\t});\n\n\t\treturn response.headers[HeaderTypes.Location];\n\t}\n\n\t/**\n\t * Get the blob and metadata.\n\t * @param id The id of the blob to get in urn format.\n\t * @param options Optional options for the retrieval of the blob.\n\t * @param options.includeContent Include the content, or just get the metadata.\n\t * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.\n\t * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.\n\t * @returns The metadata and data for the blob if it can be found.\n\t * @throws Not found error if the blob cannot be found.\n\t */\n\tpublic async get(\n\t\tid: string,\n\t\toptions?: {\n\t\t\tincludeContent?: boolean;\n\t\t\tdecompress?: boolean;\n\t\t\toverrideVaultKeyId?: string;\n\t\t}\n\t): Promise<IBlobStorageEntry> {\n\t\tUrn.guard(BlobStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tconst response = await this.fetch<IBlobStorageGetRequest, IBlobStorageGetResponse>(\n\t\t\t\"/:id\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t[HeaderTypes.Accept]: MimeTypes.JsonLd\n\t\t\t\t},\n\t\t\t\tpathParams: {\n\t\t\t\t\tid\n\t\t\t\t},\n\t\t\t\tquery: {\n\t\t\t\t\tincludeContent: Coerce.string(options?.includeContent),\n\t\t\t\t\tdecompress: Coerce.string(options?.decompress),\n\t\t\t\t\toverrideVaultKeyId: options?.overrideVaultKeyId\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Update the blob with metadata.\n\t * @param id The id of the blob metadata to update.\n\t * @param encodingFormat Mime type for the blob, will be detected if left undefined.\n\t * @param fileExtension Extension for the blob, will be detected if left undefined.\n\t * @param metadata Data for the custom metadata as JSON-LD.\n\t * @returns Nothing.\n\t * @throws Not found error if the blob cannot be found.\n\t */\n\tpublic async update(\n\t\tid: string,\n\t\tencodingFormat?: string,\n\t\tfileExtension?: string,\n\t\tmetadata?: IJsonLdNodeObject\n\t): Promise<void> {\n\t\tUrn.guard(BlobStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tawait this.fetch<IBlobStorageUpdateRequest, INoContentResponse>(\"/:id\", \"PUT\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t},\n\t\t\tbody: {\n\t\t\t\tencodingFormat,\n\t\t\t\tfileExtension,\n\t\t\t\tmetadata\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Remove the blob.\n\t * @param id The id of the blob to remove in urn format.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(id: string): Promise<void> {\n\t\tUrn.guard(BlobStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tawait this.fetch<IBlobStorageRemoveRequest, INoContentResponse>(\"/:id\", \"DELETE\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Query all the blob storage entries which match the conditions.\n\t * @param conditions The conditions to match for the entries.\n\t * @param orderBy The order for the results, defaults to created.\n\t * @param orderByDirection The direction for the order, defaults to descending.\n\t * @param cursor The cursor to request the next page of entries.\n\t * @param limit The suggested number of entries to return in each chunk, in some scenarios can return a different amount.\n\t * @returns All the entries for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tpublic async query(\n\t\tconditions?: EntityCondition<IBlobStorageEntry>,\n\t\torderBy?: keyof Pick<IBlobStorageEntry, \"dateCreated\" | \"dateModified\">,\n\t\torderByDirection?: SortDirection,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<IBlobStorageEntryList> {\n\t\tconst response = await this.fetch<IBlobStorageListRequest, IBlobStorageListResponse>(\n\t\t\t\"/\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t[HeaderTypes.Accept]: MimeTypes.JsonLd\n\t\t\t\t},\n\t\t\t\tquery: {\n\t\t\t\t\tconditions: HttpParameterHelper.objectToString(conditions),\n\t\t\t\t\torderBy,\n\t\t\t\t\torderByDirection,\n\t\t\t\t\tlimit: Coerce.string(limit),\n\t\t\t\t\tcursor\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Create a download link for the blob.\n\t * @param id The id of the blob to get in urn format.\n\t * @param download Should the content disposition be set to download.\n\t * @param filename The filename to use for the download.\n\t * @returns The download link.\n\t */\n\tpublic createDownloadLink(id: string, download?: boolean, filename?: string): string {\n\t\tUrn.guard(BlobStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tlet link = StringHelper.trimTrailingSlashes(this.getEndpointWithPrefix());\n\t\tlink += `/${id}/content`;\n\n\t\tconst downloadQuery: string[] = [];\n\t\tif (download) {\n\t\t\tdownloadQuery.push(\"download=true\");\n\t\t}\n\t\tif (Is.stringValue(filename)) {\n\t\t\tdownloadQuery.push(`filename=${encodeURIComponent(filename)}`);\n\t\t}\n\t\tif (downloadQuery.length > 0) {\n\t\t\tlink += `?${downloadQuery.join(\"&\")}`;\n\t\t}\n\n\t\treturn link;\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./blobStorageRestClient.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,4BAA4B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./blobStorageRestClient.js\";\n"]}

package/dist/types/{blobStorageClient.d.ts → blobStorageRestClient.d.ts}

@@ -6,16 +6,21 @@ import type { EntityCondition, SortDirection } from "@twin.org/entity";
 /**
  * Client for performing blob storage through to REST endpoints.
  */
-export declare class BlobStorageClient extends BaseRestClient implements IBlobStorageComponent {
+export declare class BlobStorageRestClient extends BaseRestClient implements IBlobStorageComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of BlobStorageClient.
+     * Create a new instance of BlobStorageRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Create the blob with some metadata.
      * @param blob The data for the blob in base64 format.
@@ -70,11 +75,11 @@ export declare class BlobStorageClient extends BaseRestClient implements IBlobSt
      * @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.
+     * @param limit 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>;
+    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, limit?: number): Promise<IBlobStorageEntryList>;
     /**
      * Create a download link for the blob.
      * @param id The id of the blob to get in urn format.

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./blobStorageClient";
+export * from "./blobStorageRestClient.js";

package/docs/changelog.md

@@ -1,5 +1,40 @@
 # @twin.org/blob-storage-rest-client - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.3-next.0...blob-storage-rest-client-v0.0.3-next.1) (2025-11-11)
+
+
+### Features
+
+* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+* add context id features ([#30](https://github.com/twinfoundation/blob-storage/issues/30)) ([fbf1c92](https://github.com/twinfoundation/blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
+* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+* additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
+* eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
+* 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.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.2-next.4...blob-storage-rest-client-v0.0.2-next.5) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+
 ## [0.0.2-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.2-next.3...blob-storage-rest-client-v0.0.2-next.4) (2025-10-02)
 
 

package/docs/reference/classes/{BlobStorageClient.md → BlobStorageRestClient.md}

@@ -1,4 +1,4 @@
-# Class: BlobStorageClient
+# Class: BlobStorageRestClient
 
 Client for performing blob storage through to REST endpoints.
 
@@ -14,9 +14,9 @@ Client for performing blob storage through to REST endpoints.
 
 ### Constructor
 
-> **new BlobStorageClient**(`config`): `BlobStorageClient`
+> **new BlobStorageRestClient**(`config`): `BlobStorageRestClient`
 
-Create a new instance of BlobStorageClient.
+Create a new instance of BlobStorageRestClient.
 
 #### Parameters
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`BlobStorageClient`
+`BlobStorageRestClient`
 
 #### Overrides
 
@@ -38,15 +38,29 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string` = `BlobStorageClient._CLASS_NAME`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IBlobStorageComponent.CLASS_NAME`
+`IBlobStorageComponent.className`
 
-## Methods
+***
 
 ### create()
 
@@ -242,7 +256,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`): `Promise`\<`IBlobStorageEntryList`\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`): `Promise`\<`IBlobStorageEntryList`\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -272,7 +286,7 @@ The direction for the order, defaults to descending.
 
 The cursor to request the next page of entries.
 
-##### pageSize?
+##### limit?
 
 `number`
 

package/docs/reference/index.md

@@ -2,4 +2,4 @@
 
 ## Classes
 
-- [BlobStorageClient](classes/BlobStorageClient.md)
+- [BlobStorageRestClient](classes/BlobStorageRestClient.md)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-rest-client",
-	"version": "0.0.2-next.4",
+	"version": "0.0.3-next.1",
 	"description": "Blob storage implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -16,27 +16,25 @@
 	"dependencies": {
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
-		"@twin.org/blob-storage-models": "0.0.2-next.4",
+		"@twin.org/blob-storage-models": "0.0.3-next.1",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -52,5 +50,9 @@
 		"storage",
 		"files",
 		"binary"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/blob-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,169 +0,0 @@
-'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');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing blob storage through to REST endpoints.
- */
-class BlobStorageClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     * @internal
-     */
-    static _CLASS_NAME = "BlobStorageClient";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = BlobStorageClient._CLASS_NAME;
-    /**
-     * Create a new instance of BlobStorageClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super(BlobStorageClient._CLASS_NAME, config, "blob");
-    }
-    /**
-     * Create the blob with some metadata.
-     * @param blob The data for the blob in base64 format.
-     * @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 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, encodingFormat, fileExtension, metadata, options) {
-        core.Guards.stringBase64(this.CLASS_NAME, "blob", blob);
-        const response = await this.fetch("/", "POST", {
-            body: {
-                blob,
-                encodingFormat,
-                fileExtension,
-                metadata,
-                disableEncryption: options?.disableEncryption,
-                overrideVaultKeyId: options?.overrideVaultKeyId,
-                namespace: options?.namespace
-            }
-        });
-        return response.headers[web.HeaderTypes.Location];
-    }
-    /**
-     * Get the blob and metadata.
-     * @param id The id of the blob to get in urn format.
-     * @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, 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: core.Coerce.string(options?.includeContent),
-                decompress: core.Coerce.string(options?.decompress),
-                overrideVaultKeyId: options?.overrideVaultKeyId
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Update the blob with metadata.
-     * @param id The id of the blob metadata to update.
-     * @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, encodingFormat, fileExtension, metadata) {
-        core.Urn.guard(this.CLASS_NAME, "id", id);
-        await this.fetch("/:id", "PUT", {
-            pathParams: {
-                id
-            },
-            body: {
-                encodingFormat,
-                fileExtension,
-                metadata
-            }
-        });
-    }
-    /**
-     * Remove the blob.
-     * @param id The id of the blob to remove in urn format.
-     * @returns Nothing.
-     */
-    async remove(id) {
-        core.Urn.guard(this.CLASS_NAME, "id", id);
-        await this.fetch("/:id", "DELETE", {
-            pathParams: {
-                id
-            }
-        });
-    }
-    /**
-     * 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.
-     * @param download Should the content disposition be set to download.
-     * @param filename The filename to use for the download.
-     * @returns The download link.
-     */
-    createDownloadLink(id, download, filename) {
-        core.Urn.guard(this.CLASS_NAME, "id", id);
-        let link = core.StringHelper.trimTrailingSlashes(this.getEndpointWithPrefix());
-        link += `/${id}/content`;
-        const downloadQuery = [];
-        if (download) {
-            downloadQuery.push("download=true");
-        }
-        if (core.Is.stringValue(filename)) {
-            downloadQuery.push(`filename=${encodeURIComponent(filename)}`);
-        }
-        if (downloadQuery.length > 0) {
-            link += `?${downloadQuery.join("&")}`;
-        }
-        return link;
-    }
-}
-
-exports.BlobStorageClient = BlobStorageClient;