@twin.org/blob-storage-models 0.0.1-next.13 → 0.0.1-next.15

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

@@ -53,7 +53,8 @@ export interface IBlobStorageComponent extends IComponent {
     /**
      * Query all the blob storage entries which match the conditions.
      * @param conditions The conditions to match for the entries.
-     * @param sortProperties The optional sort order.
+     * @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 userIdentity The user identity to use with storage operations.
@@ -61,8 +62,5 @@ export interface IBlobStorageComponent extends IComponent {
      * @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>, sortProperties?: {
-        property: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">;
-        sortDirection: SortDirection;
-    }[], cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntryList>;
+    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntryList>;
 }

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

@@ -1,4 +1,6 @@
+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.
  */
@@ -18,9 +20,13 @@ export interface IBlobStorageListRequest {
          */
         conditions?: string;
         /**
-         * The sort property array as JSON serialization of property,direction.
+         * The order for the results, default to created.
          */
-        sortProperties?: string;
+        orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">;
+        /**
+         * The direction for the order, defaults to desc.
+         */
+        orderByDirection?: SortDirection;
         /**
          * The number of entries to return per page.
          */

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/blob-storage-models - Changelog
 
-## v0.0.1-next.13
+## v0.0.1-next.15
 
 - Initial Release

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -166,7 +166,7 @@ Not found error if the blob cannot be found.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
+> **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -176,9 +176,13 @@ Query all the blob storage entries which match the conditions.
 
 The conditions to match for the entries.
 
-• **sortProperties?**: `object`[]
+• **orderBy?**: `"dateCreated"` \| `"dateModified"`
 
-The optional sort order.
+The order for the results, defaults to created.
+
+• **orderByDirection?**: `SortDirection`
+
+The direction for the order, defaults to descending.
 
 • **cursor?**: `string`
 

package/docs/reference/interfaces/IBlobStorageListRequest.md

@@ -28,11 +28,17 @@ The parameters from the query.
 
 The condition for the query as JSON version of EntityCondition type.
 
-#### sortProperties?
+#### orderBy?
 
-> `optional` **sortProperties**: `string`
+> `optional` **orderBy**: `"dateCreated"` \| `"dateModified"`
 
-The sort property array as JSON serialization of property,direction.
+The order for the results, default to created.
+
+#### orderByDirection?
+
+> `optional` **orderByDirection**: `SortDirection`
+
+The direction for the order, defaults to desc.
 
 #### pageSize?
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.1-next.13",
+	"version": "0.0.1-next.15",
 	"description": "Models which define the structure of the blob storage contracts and connectors",
 	"repository": {
 		"type": "git",