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

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

@@ -71,10 +71,10 @@ export interface IBlobStorageComponent extends IComponent {
      * @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.
      * @param userIdentity The user identity to use with storage operations.
      * @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, userIdentity?: string): Promise<IBlobStorageEntryList>;
+    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, limit?: number, userIdentity?: string): Promise<IBlobStorageEntryList>;
 }

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

@@ -28,9 +28,9 @@ export interface IBlobStorageListRequest {
          */
         orderByDirection?: SortDirection;
         /**
-         * The number of entries to return per page.
+         * Limit the number of entities to return.
          */
-        pageSize?: number | string;
+        limit?: string;
         /**
          * The cursor to get next chunk of data, returned in previous response.
          */

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/blob-storage-models - Changelog
 
+## [0.0.2-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.4...blob-storage-models-v0.0.2-next.5) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+
+## [0.0.2-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.3...blob-storage-models-v0.0.2-next.4) (2025-10-02)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-models:** Synchronize repo versions
+
 ## [0.0.2-next.3](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.2...blob-storage-models-v0.0.2-next.3) (2025-08-29)
 
 

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -6,6 +6,14 @@ Interface describing an blob storage component.
 
 - `IComponent`
 
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+All methods are optional, so we introduce an index signature to allow
+any additional properties or methods, which removes the TypeScript error where
+the class has no properties in common with the type.
+
 ## Methods
 
 ### create()
@@ -232,7 +240,7 @@ Not found error if the blob cannot be found.
 
 ### query()
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`, `userIdentity?`): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -262,7 +270,7 @@ The direction for the order, defaults to descending.
 
 The cursor to request the next page of entries.
 
-##### pageSize?
+##### limit?
 
 `number`
 

package/docs/reference/interfaces/IBlobStorageConnector.md

@@ -6,6 +6,14 @@ Interface describing an blob storage connector.
 
 - `IComponent`
 
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+All methods are optional, so we introduce an index signature to allow
+any additional properties or methods, which removes the TypeScript error where
+the class has no properties in common with the type.
+
 ## Methods
 
 ### set()

package/docs/reference/interfaces/IBlobStorageListRequest.md

@@ -40,11 +40,11 @@ The order for the results, default to created.
 
 The direction for the order, defaults to desc.
 
-#### pageSize?
+#### limit?
 
-> `optional` **pageSize**: `string` \| `number`
+> `optional` **limit**: `string`
 
-The number of entries to return per page.
+Limit the number of entities to return.
 
 #### cursor?
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.2-next.3",
+	"version": "0.0.2-next.5",
 	"description": "Models which define the structure of the blob storage contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -39,5 +39,24 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"blob-storage",
+		"blob",
+		"storage",
+		"files",
+		"binary",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/blob-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }