@compassdigital/sdk.typescript 4.83.0 → 4.84.0

package/src/interface/shoppingcart.ts

@@ -497,6 +497,7 @@ export interface DrainOrderType {
 }
 
 export interface TaxRequestDTO {
+	// a unique identifier representing the transaction
 	id: string;
 	// the app to associate the transaction with
 	appName: string;
@@ -516,6 +517,7 @@ export interface TaxRequestDTO {
 }
 
 export interface TaxLocationData {
+	// unique location identifier
 	id: string;
 	// country of transaction
 	country: string;
@@ -530,6 +532,7 @@ export interface TaxLocationData {
 }
 
 export interface TaxItemDTO {
+	// unique item identifier
 	id: string;
 	// indicates a tax rule for an item
 	taxTagCode: string;

package/src/interface/task.ts

@@ -43,9 +43,7 @@ export interface Task {
 	dropoff_details?: TaskLocation;
 	status?: TaskStatus;
 	// Any related metadata information about this Task
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	// Date when Task was created
 	created?: string;
 	// Date when Task expires
@@ -84,9 +82,7 @@ export interface TaskCreate {
 	dropoff_details: TaskLocation;
 	status: TaskStatus;
 	// Any related metadata information about this Task
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	// Task Type
 	type: 'bolter' | 'kds';
 }
@@ -107,9 +103,7 @@ export interface TaskUpdate {
 	status?: TaskStatus;
 	assignee?: string;
 	// Any related metadata information about this Task
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 }
 
 export interface OrderUpdate {
@@ -137,9 +131,7 @@ export interface OrderIssue {
 	id?: string;
 	type?: string;
 	//@deprecated
-	item?: {
-		[index: string]: any;
-	};
+	item?: Record<string, any>;
 	// Array of Items with issues
 	items?: Record<string, any>[];
 	// Optional additional explanation for issue: 5,10,15 for late issues, SOLD_OUT, MODIFICATION, DIETARY_RESTRICTION for see kitchen issues

package/src/interface/util.ts

@@ -1,8 +1,22 @@
 /**
- * Convert number query parameters to string.
+ * Convert a query parameter value to the request type.
+ *
+ * - number types are converted to string
+ * - Array<T> types are converted to Array<T> | T
+ */
+export type RequestQueryParam<T> = T extends undefined
+	? undefined
+	: T extends number
+		? string
+		: T extends any[]
+			? RequestQueryParam<T[number]>[] | RequestQueryParam<T[number]>
+			: T;
+
+/**
+ * Convert the query parameters to the request types.
  */
 export type RequestQuery<T extends object> = {
-	[K in keyof T]: T[K] extends number | undefined ? string : T[K];
+	[K in keyof T]: RequestQueryParam<T[K]>;
 };
 
 /**