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

package/dist/cjs/index.cjs

@@ -109,20 +109,22 @@ 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 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.
      * @returns All the entries for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, cursor, pageSize) {
+    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),
-                sortProperties: apiModels.HttpParameterHelper.objectToString(sortProperties),
+                orderBy,
+                orderByDirection,
                 pageSize,
                 cursor
             }

package/dist/esm/index.mjs

@@ -107,20 +107,22 @@ class BlobStorageClient extends BaseRestClient {
     /**
      * 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.
      * @returns All the entries for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, cursor, pageSize) {
+    async query(conditions, orderBy, orderByDirection, cursor, pageSize) {
         const response = await this.fetch("/", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
             },
             query: {
                 conditions: HttpParameterHelper.objectToString(conditions),
-                sortProperties: HttpParameterHelper.objectToString(sortProperties),
+                orderBy,
+                orderByDirection,
                 pageSize,
                 cursor
             }

package/dist/types/blobStorageClient.d.ts

@@ -53,16 +53,14 @@ export declare class BlobStorageClient extends BaseRestClient implements IBlobSt
     /**
      * 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.
      * @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): Promise<IBlobStorageEntryList>;
+    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,5 @@
 # @twin.org/blob-storage-rest-client - Changelog
 
-## v0.0.1-next.13
+## v0.0.1-next.15
 
 - Initial Release

package/docs/reference/classes/BlobStorageClient.md

@@ -184,7 +184,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `cursor`?, `pageSize`?): `Promise`\<`IBlobStorageEntryList`\>
+> **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `cursor`?, `pageSize`?): `Promise`\<`IBlobStorageEntryList`\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -194,9 +194,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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-rest-client",
-	"version": "0.0.1-next.13",
+	"version": "0.0.1-next.15",
 	"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.1-next.13",
+		"@twin.org/blob-storage-models": "0.0.1-next.15",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",