@twin.org/api-models 0.0.1-next.5 → 0.0.1-next.7

package/dist/cjs/index.cjs

@@ -121,6 +121,39 @@ class HttpParameterHelper {
             return conditionsList.join(",");
         }
     }
+    /**
+     * Convert the sort string to a list of sort properties.
+     * @param sortProperties The sort properties query string.
+     * @returns The list of sort properties.
+     */
+    static sortPropertiesFromString(sortProperties) {
+        const sortParts = sortProperties?.split(",") ?? [];
+        const sortPropertyList = [];
+        for (const conditionPart of sortParts) {
+            const parts = conditionPart.split("|");
+            if (parts.length === 2) {
+                sortPropertyList.push({
+                    property: parts[0],
+                    sortDirection: parts[1]
+                });
+            }
+        }
+        return sortPropertyList.length === 0 ? undefined : sortPropertyList;
+    }
+    /**
+     * Convert the sort properties to a string parameter.
+     * @param sortProperties The sort properties to convert.
+     * @returns The string version of the sort properties.
+     */
+    static sortPropertiesToString(sortProperties) {
+        if (core.Is.arrayValue(sortProperties)) {
+            const sortPropertyList = [];
+            for (const conditionPart of sortProperties) {
+                sortPropertyList.push(`${conditionPart.property}|${conditionPart.sortDirection}`);
+            }
+            return sortPropertyList.join(",");
+        }
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.

package/dist/esm/index.mjs

@@ -119,6 +119,39 @@ class HttpParameterHelper {
             return conditionsList.join(",");
         }
     }
+    /**
+     * Convert the sort string to a list of sort properties.
+     * @param sortProperties The sort properties query string.
+     * @returns The list of sort properties.
+     */
+    static sortPropertiesFromString(sortProperties) {
+        const sortParts = sortProperties?.split(",") ?? [];
+        const sortPropertyList = [];
+        for (const conditionPart of sortParts) {
+            const parts = conditionPart.split("|");
+            if (parts.length === 2) {
+                sortPropertyList.push({
+                    property: parts[0],
+                    sortDirection: parts[1]
+                });
+            }
+        }
+        return sortPropertyList.length === 0 ? undefined : sortPropertyList;
+    }
+    /**
+     * Convert the sort properties to a string parameter.
+     * @param sortProperties The sort properties to convert.
+     * @returns The string version of the sort properties.
+     */
+    static sortPropertiesToString(sortProperties) {
+        if (Is.arrayValue(sortProperties)) {
+            const sortPropertyList = [];
+            for (const conditionPart of sortProperties) {
+                sortPropertyList.push(`${conditionPart.property}|${conditionPart.sortDirection}`);
+            }
+            return sortPropertyList.join(",");
+        }
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.

package/dist/types/helpers/httpParameterHelper.d.ts

@@ -1,4 +1,4 @@
-import type { IComparator } from "@twin.org/entity";
+import type { IComparator, SortDirection } from "@twin.org/entity";
 /**
  * Class to help with handling http parameters.
  */
@@ -27,4 +27,22 @@ export declare class HttpParameterHelper {
      * @returns The string version of the comparators.
      */
     static conditionsToString(conditions?: IComparator[]): string | undefined;
+    /**
+     * Convert the sort string to a list of sort properties.
+     * @param sortProperties The sort properties query string.
+     * @returns The list of sort properties.
+     */
+    static sortPropertiesFromString<T = unknown>(sortProperties?: string): {
+        property: keyof T;
+        sortDirection: SortDirection;
+    }[] | undefined;
+    /**
+     * Convert the sort properties to a string parameter.
+     * @param sortProperties The sort properties to convert.
+     * @returns The string version of the sort properties.
+     */
+    static sortPropertiesToString<T = unknown>(sortProperties?: {
+        property: keyof T;
+        sortDirection: SortDirection;
+    }[]): string | undefined;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-models - Changelog
 
-## v0.0.1-next.5
+## v0.0.1-next.7
 
 - Initial Release

package/docs/reference/classes/HttpParameterHelper.md

@@ -99,3 +99,51 @@ The conditions to convert.
 `undefined` \| `string`
 
 The string version of the comparators.
+
+***
+
+### sortPropertiesFromString()
+
+> `static` **sortPropertiesFromString**\<`T`\>(`sortProperties`?): `undefined` \| `object`[]
+
+Convert the sort string to a list of sort properties.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **sortProperties?**: `string`
+
+The sort properties query string.
+
+#### Returns
+
+`undefined` \| `object`[]
+
+The list of sort properties.
+
+***
+
+### sortPropertiesToString()
+
+> `static` **sortPropertiesToString**\<`T`\>(`sortProperties`?): `undefined` \| `string`
+
+Convert the sort properties to a string parameter.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **sortProperties?**: `object`[]
+
+The sort properties to convert.
+
+#### Returns
+
+`undefined` \| `string`
+
+The string version of the sort properties.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.1-next.5",
+	"version": "0.0.1-next.7",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",