Merge pull request #59 from ctrl-hub/fix-sort-direction-ts

Fix sort direction ts

Author: jgreaves8

dist/index.js

@@ -1331,10 +1331,15 @@ class RequestBuilder {
     return this;
   }
   withSort(sort) {
-    this.requestOptions.sort = sort.map((sortOption) => ({
-      key: sortOption.key,
-      direction: sortOption.direction || "asc"
-    }));
+    this.requestOptions.sort = sort.map((sortOption) => {
+      if (sortOption.direction && sortOption.direction !== "asc" && sortOption.direction !== "desc") {
+        throw new Error(`Sort direction must be either 'asc' or 'desc', got: ${sortOption.direction}`);
+      }
+      return {
+        key: sortOption.key,
+        direction: sortOption.direction
+      };
+    });
     return this;
   }
   withFilters(filters) {

dist/utils/RequestBuilder.d.ts

@@ -1,11 +1,11 @@
 import { RequestOptions } from "../utils/RequestOptions";
-import type { RequestOptionsType } from "../utils/RequestOptions";
+import type { RequestOptionsType, SortDirection } from "../utils/RequestOptions";
 export declare class RequestBuilder {
     protected requestOptions: RequestOptionsType;
     withIncludes(includes: string[]): this;
     withSort(sort: Array<{
         key: string;
-        direction?: 'asc' | 'desc';
+        direction?: SortDirection;
     }>): this;
     withFilters(filters: Array<{
         key: string;

dist/utils/RequestBuilder.js

@@ -6,10 +6,15 @@ export class RequestBuilder {
         return this;
     }
     withSort(sort) {
-        this.requestOptions.sort = sort.map(sortOption => ({
-            key: sortOption.key,
-            direction: sortOption.direction || 'asc'
-        }));
+        this.requestOptions.sort = sort.map(sortOption => {
+            if (sortOption.direction && sortOption.direction !== 'asc' && sortOption.direction !== 'desc') {
+                throw new Error(`Sort direction must be either 'asc' or 'desc', got: ${sortOption.direction}`);
+            }
+            return {
+                key: sortOption.key,
+                direction: sortOption.direction
+            };
+        });
         return this;
     }
     withFilters(filters) {

dist/utils/RequestOptions.d.ts

@@ -1,6 +1,7 @@
+export type SortDirection = 'asc' | 'desc' | string;
 type Sort = {
     key: string;
-    direction?: 'asc' | 'desc';
+    direction?: SortDirection;
 };
 type Filter = {
     key: string;

package.json

@@ -4,7 +4,7 @@
         "type": "git",
         "url": "https://github.com/ctrl-hub/sdk.ts"
     },
-    "version": "0.1.134",
+    "version": "0.1.135",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "type": "module",

src/utils/RequestBuilder.ts

@@ -1,5 +1,5 @@
 import {RequestOptions} from "../utils/RequestOptions";
-import type {RequestOptionsType} from "../utils/RequestOptions";
+import type {RequestOptionsType, SortDirection} from "../utils/RequestOptions";
 
 export class RequestBuilder {
     protected requestOptions: RequestOptionsType = {};
@@ -9,11 +9,18 @@ export class RequestBuilder {
         return this;
     }
 
-    withSort(sort: Array<{ key: string, direction?: 'asc' | 'desc' }>): this {
-        this.requestOptions.sort = sort.map(sortOption => ({
-            key: sortOption.key,
-            direction: sortOption.direction || 'asc'
-        }));
+    withSort(sort: Array<{ key: string, direction?: SortDirection }>): this {
+        this.requestOptions.sort = sort.map(sortOption => {
+
+            if (sortOption.direction && sortOption.direction !== 'asc' && sortOption.direction !== 'desc') {
+                throw new Error(`Sort direction must be either 'asc' or 'desc', got: ${sortOption.direction}`);
+            }
+
+            return {
+                key: sortOption.key,
+                direction: sortOption.direction
+            };
+        });
         return this;
     }
 

src/utils/RequestOptions.ts

@@ -1,6 +1,8 @@
+export type SortDirection = 'asc' | 'desc' | string;
+
 type Sort = {
     key: string;
-    direction?: 'asc' | 'desc';
+    direction?: SortDirection;
 };
 
 type Filter = {
@@ -115,4 +117,4 @@ export class RequestOptions {
 
         return requestOptions;
     }
-}
+}