@compassdigital/sdk.typescript 4.23.1 → 4.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.23.1",
+	"version": "4.25.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",
@@ -22,7 +22,7 @@
 	"jest": {
 		"testEnvironment": "node",
 		"transform": {
-			"^.+\\.tsx?$": "esbuild-jest"
+			"^.+\\.(t|j)sx?$": "@swc/jest"
 		}
 	},
 	"scripts": {
@@ -47,11 +47,12 @@
 	"devDependencies": {
 		"@compassdigital/review": "^7.3.0",
 		"@compassdigital/sdk.typescript.cli": "^4.14.0",
+		"@swc/core": "^1.4.1",
+		"@swc/jest": "^0.2.36",
 		"@types/jest": "^29.2.4",
 		"@types/node": "^20.1.0",
 		"esbuild": "^0.20.0",
-		"esbuild-jest": "^0.5.0",
-		"jest": "^29.3.1",
+		"jest": "^29.7.0",
 		"rimraf": "^5.0.0",
 		"typescript": "^5.0.2"
 	}

package/src/interface/location.ts

@@ -95,10 +95,10 @@ export interface Brand {
   };
   hours?: Hours[];
   deliveryHours?: DeliveryHours[];
-  style?: Record<string, any>;
+  style?: any;
   // pos
   pos?: string;
-  terminals?: Record<string, any>[];
+  terminals?: any[];
   timeslots?: {
     time?: string;
     averagePrepTime?: string;
@@ -145,8 +145,8 @@ export interface Brand {
   // company
   company?: string;
   config?: {
-    private?: Record<string, any>;
-    public?: Record<string, any>;
+    private?: any;
+    public?: any;
   };
   tax_rate?: number;
   meta?: {
@@ -254,8 +254,8 @@ export interface Location {
       en?: string;
       fr?: string;
     };
-    hours?: Record<string, any>;
-    deliveryHours?: Record<string, any>;
+    hours?: any;
+    deliveryHours?: any;
     service_fee?: {
       type?: string;
       value?: number;
@@ -280,7 +280,7 @@ export interface Group {
   meta?: {
     [index: string]: any;
   };
-  style?: Record<string, any>;
+  style?: any;
   timezone?: string;
   [index: string]: any;
 }
@@ -300,7 +300,7 @@ export interface success {
 export interface Error {
   error?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Sector {
@@ -419,7 +419,7 @@ export interface BadRequest {
   error?: string;
 }
 
-export type PartnerStatus = "await_partner" | "await_scout" | "completed";
+export type PartnerStatus = string;
 
 export interface WaitTime {
   // maxium wait time to the next time slot in minutes
@@ -430,7 +430,7 @@ export interface WaitTime {
   ready_time: number;
 }
 
-export type BrandOrMenuState = "open" | "closed" | "preorder";
+export type BrandOrMenuState = string;
 
 export interface MenuAssociations {
   menu_associations?: MenuAssociation[];
@@ -449,6 +449,23 @@ export interface MenuAssociation {
   [index: string]: any;
 }
 
+export interface WaitTimeResponse {
+  // group
+  id?: string;
+  locations?: {
+    // location
+    id?: string;
+    brands?: {
+      // location
+      id?: string;
+      estimated_wait_time?: {
+        delivery?: WaitTime;
+        pickup?: WaitTime;
+      };
+    }[];
+  }[];
+}
+
 // POST /location - Create a new location
 
 export type PostLocationBody = Location;
@@ -473,9 +490,9 @@ export interface GetLocationsRequest extends BaseRequest, RequestQuery<GetLocati
 // GET /location/search - Gets Location within a radius of the provided point
 
 export interface GetLocationSearchQuery {
-  //@deprecated
+  // The latitude to be used
   lat?: number;
-  //@deprecated
+  // The longitude to be used
   long?: number;
   // Operation id to be used
   operation_id?: number;
@@ -500,7 +517,7 @@ export interface GetLocationQuery {
   // When fetching location, brands will come with private and public configs
   include_brands_config?: boolean;
   // active cafes
-  active_cafes?: Record<string, any>[];
+  active_cafes?: any[];
   // show additional hidden properties/entities
   extended?: boolean;
   // Graphql query string
@@ -728,7 +745,7 @@ export interface GetLocationGroupQuery {
   non_market_places?: boolean;
   // return only groups with non-scan & go locations/brands
   non_scan_go?: boolean;
-  //  determine whether to calculate estimated_wait_time
+  //@deprecated
   include_estimated_wait_time?: boolean;
   // Graphql query string
   _query?: string;
@@ -790,6 +807,28 @@ export interface PatchLocationGroupRequest extends BaseRequest, PatchLocationGro
   body: PatchLocationGroupBody;
 }
 
+// GET /location/group/{id}/waittimes - Get an individual Group's estimated wait times based on id
+
+export interface GetLocationGroupWaittimesPath {
+  // group id
+  id: string;
+}
+
+export interface GetLocationGroupWaittimesQuery {
+  // show additional hidden properties/entities
+  extended?: boolean;
+  // Graphql query string
+  _query?: string;
+  nocache?: boolean;
+}
+
+export type GetLocationGroupWaittimesResponse = WaitTimeResponse;
+
+export interface GetLocationGroupWaittimesRequest
+  extends BaseRequest,
+    RequestQuery<GetLocationGroupWaittimesQuery>,
+    GetLocationGroupWaittimesPath {}
+
 // GET /location/group/{id}/deliverydestination - Get all delivery destinations for group
 
 export interface GetLocationGroupDeliverydestinationsPath {
@@ -1234,7 +1273,7 @@ export interface PostLocationCompanyBody {
   name: string;
   // sector
   sector: string;
-  label?: Record<string, any>;
+  label?: any;
   is?: {
     global_images_enabled?: boolean;
   };

package/src/interface/menu.ts

@@ -637,6 +637,7 @@ export interface DraftModifierGroupDTO {
   limit?: number;
   brand_id?: string;
   order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
   is_out_of_stock?: FilterFieldDTO;
   applied_diff_snapshot?: FilterFieldDTO;
   brand?: Record<string, any>;
@@ -682,9 +683,13 @@ export interface DraftModifierDTO {
   reporting?: ReportingMetadataDTO;
   posid_segment?: FilterFieldDTO;
   brand_id?: string;
-  sizing?: FilterFieldDTO[];
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: FilterFieldDTO;
+  price_for_none?: number;
+  price_for_less?: number;
+  price_for_more?: number;
+  pre_surcharge?: number;
+  post_surcharge?: number;
   applied_diff_snapshot?: FilterFieldDTO;
   brand?: Record<string, any>;
   changes?: ModifierChangeDTO[];
@@ -858,8 +863,12 @@ export interface DraftModifierDraftModifierDTO {
   posid?: FilterFieldDTO;
   posid_segment?: FilterFieldDTO;
   brand_id?: FilterFieldDTO;
-  sizing?: FilterFieldDTO[];
   is_out_of_stock?: FilterFieldDTO;
+  price_for_none?: FilterFieldDTO;
+  price_for_less?: FilterFieldDTO;
+  price_for_more?: FilterFieldDTO;
+  pre_surcharge?: FilterFieldDTO;
+  post_surcharge?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -890,6 +899,7 @@ export interface DraftModifierGroupDraftModifierGroupDTO {
   limit?: FilterFieldDTO;
   brand_id?: FilterFieldDTO;
   order_type?: FilterFieldDTO;
+  sizing?: FilterFieldDTO;
   is_out_of_stock?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
@@ -1089,6 +1099,7 @@ export interface PublishedModifierGroupDTO {
   limit?: number;
   brand_id?: string;
   order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
   is_out_of_stock?: boolean;
   permissions?: Record<string, any>;
   [index: string]: any;
@@ -1118,8 +1129,12 @@ export interface PublishedModifierDTO {
   posid?: string;
   posid_segment?: string;
   brand_id?: string;
-  sizing?: Record<string, any>[];
   is_out_of_stock?: boolean;
+  price_for_none?: number;
+  price_for_less?: number;
+  price_for_more?: number;
+  pre_surcharge?: number;
+  post_surcharge?: number;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1648,6 +1663,7 @@ export interface PublishedModifierGroupPublishedModifierGroupDTO {
   limit?: FilterFieldDTO;
   brand_id?: FilterFieldDTO;
   order_type?: FilterFieldDTO;
+  sizing?: FilterFieldDTO;
   is_out_of_stock?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
@@ -1726,9 +1742,13 @@ export interface DraftModifierEntityDTO {
   reporting: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id: string;
-  sizing?: Record<string, any>[];
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
+  price_for_none: number;
+  price_for_less: number;
+  price_for_more: number;
+  pre_surcharge: number;
+  post_surcharge: number;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -1752,8 +1772,12 @@ export interface PublishedModifierPublishedModifierDTO {
   posid?: FilterFieldDTO;
   posid_segment?: FilterFieldDTO;
   brand_id?: FilterFieldDTO;
-  sizing?: FilterFieldDTO[];
   is_out_of_stock?: FilterFieldDTO;
+  price_for_none?: FilterFieldDTO;
+  price_for_less?: FilterFieldDTO;
+  price_for_more?: FilterFieldDTO;
+  pre_surcharge?: FilterFieldDTO;
+  post_surcharge?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -5364,6 +5388,7 @@ export interface PostMenuV3DraftModifierGroupBody {
   limit?: number;
   brand_id: string;
   order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
   is_out_of_stock?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
@@ -5423,6 +5448,7 @@ export interface PatchMenuV3DraftModifierGroupBody {
   limit?: number;
   brand_id?: string;
   order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
   is_out_of_stock?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
@@ -5502,6 +5528,7 @@ export type PostMenuV3DraftModifierGroupsBody = {
   limit?: number;
   brand_id: string;
   order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
   is_out_of_stock?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
@@ -5566,6 +5593,7 @@ export interface PostMenuV3DraftModifierGroupDuplicateResponse {
   limit?: number;
   brand_id: string;
   order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
   is_out_of_stock?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
@@ -5938,9 +5966,13 @@ export interface PostMenuV3DraftModifierBody {
   reporting: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id: string;
-  sizing?: Record<string, any>[];
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
+  price_for_none: number;
+  price_for_less: number;
+  price_for_more: number;
+  pre_surcharge: number;
+  post_surcharge: number;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -6003,9 +6035,13 @@ export interface PatchMenuV3DraftModifierBody {
   reporting?: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id?: string;
-  sizing?: Record<string, any>[];
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
+  price_for_none?: number;
+  price_for_less?: number;
+  price_for_more?: number;
+  pre_surcharge?: number;
+  post_surcharge?: number;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -6086,9 +6122,13 @@ export type PostMenuV3DraftModifiersBody = {
   reporting: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id: string;
-  sizing?: Record<string, any>[];
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
+  price_for_none: number;
+  price_for_less: number;
+  price_for_more: number;
+  pre_surcharge: number;
+  post_surcharge: number;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -6150,9 +6190,13 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
   reporting?: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id?: string;
-  sizing?: Record<string, any>[];
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
+  price_for_none?: number;
+  price_for_less?: number;
+  price_for_more?: number;
+  pre_surcharge?: number;
+  post_surcharge?: number;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   changes?: ModifierChangeDTO[];