@twin.org/blob-storage-rest-client 0.0.2-next.3 → 0.0.2-next.5

package/dist/cjs/index.cjs

@@ -10,22 +10,17 @@ var web = require('@twin.org/web');
 /**
  * Client for performing blob storage through to REST endpoints.
  */
-class BlobStorageClient extends apiCore.BaseRestClient {
+class BlobStorageRestClient extends apiCore.BaseRestClient {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "BlobStorageClient";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = BlobStorageClient._CLASS_NAME;
+    static CLASS_NAME = "BlobStorageRestClient";
     /**
      * Create a new instance of BlobStorageClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(BlobStorageClient._CLASS_NAME, config, "blob");
+        super(BlobStorageRestClient.CLASS_NAME, config, "blob");
     }
     /**
      * Create the blob with some metadata.
@@ -40,7 +35,7 @@ class BlobStorageClient extends apiCore.BaseRestClient {
      * @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);
+        core.Guards.stringBase64(BlobStorageRestClient.CLASS_NAME, "blob", blob);
         const response = await this.fetch("/", "POST", {
             body: {
                 blob,
@@ -65,7 +60,7 @@ class BlobStorageClient extends apiCore.BaseRestClient {
      * @throws Not found error if the blob cannot be found.
      */
     async get(id, options) {
-        core.Urn.guard(this.CLASS_NAME, "id", id);
+        core.Urn.guard(BlobStorageRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -91,7 +86,7 @@ class BlobStorageClient extends apiCore.BaseRestClient {
      * @throws Not found error if the blob cannot be found.
      */
     async update(id, encodingFormat, fileExtension, metadata) {
-        core.Urn.guard(this.CLASS_NAME, "id", id);
+        core.Urn.guard(BlobStorageRestClient.CLASS_NAME, "id", id);
         await this.fetch("/:id", "PUT", {
             pathParams: {
                 id
@@ -109,7 +104,7 @@ class BlobStorageClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async remove(id) {
-        core.Urn.guard(this.CLASS_NAME, "id", id);
+        core.Urn.guard(BlobStorageRestClient.CLASS_NAME, "id", id);
         await this.fetch("/:id", "DELETE", {
             pathParams: {
                 id
@@ -122,11 +117,11 @@ class BlobStorageClient extends apiCore.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: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -135,7 +130,7 @@ class BlobStorageClient extends apiCore.BaseRestClient {
                 conditions: apiModels.HttpParameterHelper.objectToString(conditions),
                 orderBy,
                 orderByDirection,
-                pageSize,
+                limit: core.Coerce.string(limit),
                 cursor
             }
         });
@@ -149,7 +144,7 @@ class BlobStorageClient extends apiCore.BaseRestClient {
      * @returns The download link.
      */
     createDownloadLink(id, download, filename) {
-        core.Urn.guard(this.CLASS_NAME, "id", id);
+        core.Urn.guard(BlobStorageRestClient.CLASS_NAME, "id", id);
         let link = core.StringHelper.trimTrailingSlashes(this.getEndpointWithPrefix());
         link += `/${id}/content`;
         const downloadQuery = [];
@@ -166,4 +161,4 @@ class BlobStorageClient extends apiCore.BaseRestClient {
     }
 }
 
-exports.BlobStorageClient = BlobStorageClient;
+exports.BlobStorageRestClient = BlobStorageRestClient;

package/dist/esm/index.mjs

@@ -8,22 +8,17 @@ import { HeaderTypes, MimeTypes } from '@twin.org/web';
 /**
  * Client for performing blob storage through to REST endpoints.
  */
-class BlobStorageClient extends BaseRestClient {
+class BlobStorageRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "BlobStorageClient";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = BlobStorageClient._CLASS_NAME;
+    static CLASS_NAME = "BlobStorageRestClient";
     /**
      * Create a new instance of BlobStorageClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(BlobStorageClient._CLASS_NAME, config, "blob");
+        super(BlobStorageRestClient.CLASS_NAME, config, "blob");
     }
     /**
      * Create the blob with some metadata.
@@ -38,7 +33,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 +58,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 +84,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 +102,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 +115,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 +128,7 @@ class BlobStorageClient extends BaseRestClient {
                 conditions: HttpParameterHelper.objectToString(conditions),
                 orderBy,
                 orderByDirection,
-                pageSize,
+                limit: Coerce.string(limit),
                 cursor
             }
         });
@@ -147,7 +142,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 = [];
@@ -164,4 +159,4 @@ class BlobStorageClient extends BaseRestClient {
     }
 }
 
-export { BlobStorageClient };
+export { BlobStorageRestClient };

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

@@ -6,11 +6,11 @@ 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.
      * @param config The configuration for the client.
@@ -70,11 +70,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";

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/blob-storage-rest-client - Changelog
 
+## [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)
+
+
+### 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.2-next.3 to 0.0.2-next.4
+
 ## [0.0.2-next.3](https://github.com/twinfoundation/blob-storage/compare/blob-storage-rest-client-v0.0.2-next.2...blob-storage-rest-client-v0.0.2-next.3) (2025-08-29)
 
 

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,7 +14,7 @@ Client for performing blob storage through to REST endpoints.
 
 ### Constructor
 
-> **new BlobStorageClient**(`config`): `BlobStorageClient`
+> **new BlobStorageRestClient**(`config`): `BlobStorageRestClient`
 
 Create a new instance of BlobStorageClient.
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`BlobStorageClient`
+`BlobStorageRestClient`
 
 #### Overrides
 
@@ -38,14 +38,10 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string` = `BlobStorageClient._CLASS_NAME`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IBlobStorageComponent.CLASS_NAME`
-
 ## Methods
 
 ### create()
@@ -242,7 +238,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 +268,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.3",
+	"version": "0.0.2-next.5",
 	"description": "Blob storage implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,7 @@
 	"dependencies": {
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
-		"@twin.org/blob-storage-models": "0.0.2-next.3",
+		"@twin.org/blob-storage-models": "0.0.2-next.5",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
@@ -40,5 +40,21 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"blob-storage",
+		"blob",
+		"storage",
+		"files",
+		"binary"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/blob-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }