@compassdigital/sdk.typescript 3.8.0 → 3.10.0

package/src/interface/order.ts

@@ -22,6 +22,7 @@ export interface CreateOrder {
   meta?: {
     // which ui the order was placed on
     source?: string;
+    [index: string]: any;
   };
   pickup?: string;
   pickup_name?: string;
@@ -226,7 +227,9 @@ export interface OrderedItem {
   _loyalty?: {
     amount?: number;
   };
-  meta?: any;
+  meta?: {
+    [index: string]: any;
+  };
   options?: {
     label?: {
       en?: string;

package/src/interface/partner.ts

@@ -163,11 +163,6 @@ export interface ShoppingCart {
     // If an order should be paid with meal exchange. If true, this will calculate meals total.
     mx_cart?: boolean;
   };
-  meta?: {
-    // Raw request from any vendor integrated with CDL
-    vendor?: any;
-    [index: string]: any;
-  };
 }
 
 export type Item = any;
@@ -383,6 +378,12 @@ export interface LocationGroup {
       logo?: string;
       is?: {
         pickup_supported?: boolean;
+        delivery_supported?: boolean;
+      };
+      delivery_details?: {
+        show_single_timeslot?: boolean;
+        show_instructions?: boolean;
+        runner_app_enabled?: boolean;
       };
       pickup_instruction?: {
         en?: string;
@@ -399,7 +400,9 @@ export interface LocationGroup {
     [index: string]: any;
   }[];
   address?: Brand["address"];
-  meta?: any;
+  meta?: {
+    [index: string]: any;
+  };
   style?: any;
   [index: string]: any;
 }
@@ -689,6 +692,8 @@ export interface PostPartnerStandardcognitionShoppingcartBody {
   location_brand: string;
   // CDL shoppingcart id. If provided, items will be added to this shoppingcart
   shoppingcart: string;
+  // Meta data from Standard Cognition shoppingcart
+  meta?: any;
 }
 
 export type PostPartnerStandardcognitionShoppingcartResponse = ShoppingCart;

package/src/interface/payment.ts

@@ -311,7 +311,7 @@ export interface PostPaymentTokenBody {
   // Name on credit card
   nameOnCard: string;
   // FP StoreId
-  storeId: string;
+  storeId: any[];
   // FP TerminalId
   terminalId: string;
 }
@@ -328,7 +328,7 @@ export interface PutPaymentTokenBody {
   // Token information to be saved
   updatedTokenInfo: UpdateTokenInformation;
   // FP StoreId
-  storeId: string;
+  storeId: any[];
   // FP TerminalId
   terminalId: string;
 }
@@ -345,7 +345,7 @@ export interface DeletePaymentTokenBody {
   // Token string to be deleted
   token: string;
   // FP StoreId
-  storeId: string;
+  storeId: any[];
   // FP TerminalId
   terminalId: string;
 }
@@ -360,7 +360,7 @@ export interface DeletePaymentTokenRequest {
 
 export interface GetPaymentMethodsQuery {
   // FP StoreId
-  storeId: string;
+  storeId: any[];
   // FP TerminalId
   terminalId: string;
 }

package/src/interface/permission.ts

@@ -86,7 +86,9 @@ export interface RoleAssignmentBody {
   // role
   role_id: string;
   recipient_id: string;
-  meta?: any;
+  meta?: {
+    [index: string]: any;
+  };
 }
 
 export interface RoleAssignment {
@@ -95,7 +97,9 @@ export interface RoleAssignment {
   // role
   role_id: string;
   recipient_id: string;
-  meta?: any;
+  meta?: {
+    [index: string]: any;
+  };
   last_updated_by?: string;
   date_created?: string;
   date_modified?: string;

package/src/interface/shoppingcart.ts

@@ -221,11 +221,6 @@ export interface ShoppingCart {
     // If an order should be paid with meal exchange. If true, this will calculate meals total.
     mx_cart?: boolean;
   };
-  meta?: {
-    // Raw request from any vendor integrated with CDL
-    vendor?: any;
-    [index: string]: any;
-  };
 }
 
 // POST /shoppingcart/ - Create a new ShoppingCart

package/src/interface/task.ts

@@ -45,7 +45,9 @@ export interface Task {
   // Task Status
   status?: string;
   // Any related metadata information about this Task
-  meta?: any;
+  meta?: {
+    [index: string]: any;
+  };
   // Date when Task was created
   created?: string;
   // Date when task was last modified
@@ -89,7 +91,9 @@ export interface TaskCreate {
   // Task Status
   status: string;
   // Any related metadata information about this Task
-  meta?: any;
+  meta?: {
+    [index: string]: any;
+  };
   // Task Type
   type: string;
 }
@@ -114,7 +118,9 @@ export interface TaskUpdate {
   // Task Status
   status?: string;
   // Any related metadata information about this Task
-  meta?: any;
+  meta?: {
+    [index: string]: any;
+  };
 }
 
 export interface OrderUpdate {
@@ -126,21 +132,6 @@ export interface ActionResponse {
   success?: boolean;
 }
 
-export interface SNSMessage {
-  Type: string;
-  MessageId: string;
-  Token?: string;
-  TopicArn: string;
-  Message: string;
-  SubscribeURL?: string;
-  Timestamp: string;
-  SignatureVersion: string;
-  Signature: string;
-  SigningCertURL: string;
-  Subject?: string;
-  UnsubscribeURL?: string;
-}
-
 // POST /task/ - Create new Task
 
 export type PostTaskBody = TaskCreate;
@@ -308,13 +299,3 @@ export type GetTaskLocationGroupResponse = Tasks;
 export interface GetTaskLocationGroupRequest
   extends GetTaskLocationGroupQuery,
     GetTaskLocationGroupPath {}
-
-// POST /task/apex/sns - Update apex integrated task
-
-export type PostTaskApexSnsBody = SNSMessage;
-
-export type PostTaskApexSnsResponse = ActionResponse;
-
-export interface PostTaskApexSnsRequest {
-  body: PostTaskApexSnsBody;
-}

package/src/interface/vendor.ts

@@ -19,6 +19,7 @@ export interface Vendor {
       staging?: string;
       v1?: string;
     };
+    [index: string]: any;
   };
   domain?: string;
 }

package/src/interface/vote.ts

@@ -16,7 +16,9 @@ export interface CreateVote {
   skip?: boolean;
   idfa?: string;
   session_start_time?: number;
-  meta?: any;
+  meta?: {
+    [index: string]: any;
+  };
 }
 
 export interface Vote {
@@ -32,7 +34,9 @@ export interface Vote {
   skip?: boolean;
   idfa?: string;
   session_start_time?: string;
-  meta?: any;
+  meta?: {
+    [index: string]: any;
+  };
   timestamp?: string;
 }
 

package/test/client.test.ts

@@ -1,5 +1,6 @@
 
-import { ServiceClient, ResponseData, ServiceError, RequestData, InterceptFn } from "../src";
+import { parse as parseURL } from "url";
+import { ServiceClient, ResponseData, ServiceError, InterceptFn } from "../src";
 import { Task } from "../src/interface/task";
 
 describe("ServiceClient", () => {
@@ -16,7 +17,7 @@ describe("ServiceClient", () => {
   }
 
   function interceptor(status: number, body?: any, err?: any): InterceptFn {
-    return (req: RequestData) => Promise.resolve(response(status, body, err));
+    return () => Promise.resolve(response(status, body, err));
   }
 
   test("makes basic request", async () => {
@@ -71,26 +72,26 @@ describe("ServiceClient", () => {
   });
 
   test("client retries on bad status codes", async () => {
-    const intercept = jest.fn(async (req: RequestData) => {
+    const intercept = jest.fn(async () => {
       if (intercept.mock.calls.length === 3) {
         return response(200, "{}");
       }
       return response(500, "something went wrong");
     });
     const api = new ServiceClient({ intercept });
-    const task = await api.get_task("", { retry: 2 });
+    await api.get_task("", { retry: 2 });
     expect(intercept.mock.calls.length).toBe(3);
   });
 
   test("client retries on network error", async () => {
-    const intercept = jest.fn(async (req: RequestData) => {
+    const intercept = jest.fn(async () => {
       if (intercept.mock.calls.length === 3) {
         return response(200, "{}");
       }
       return response(0, "", new Error("network error"));
     });
     const api = new ServiceClient({ intercept });
-    const task = await api.get_task("", { retry: 2 });
+    await api.get_task("", { retry: 2 });
     expect(intercept.mock.calls.length).toBe(3);
   });
 
@@ -102,6 +103,16 @@ describe("ServiceClient", () => {
     expect(intercept.mock.calls.length).toEqual(6);
   });
 
+  test("array query parameters are passed correctly", async () => {
+    const intercept = jest.fn(interceptor(200, {}));
+    const api = new ServiceClient({ intercept });
+    await api.get_menus({ query: { foo: "test", things: [1, 2, 3] }} as any);
+    expect(intercept.mock.calls.length).toBe(1);
+    const req = intercept.mock.calls[0][0];
+    const { query } = parseURL(req.url, true);
+    expect(query).toEqual({ foo: "test", things: ["1","2","3"] });
+  });
+
   describe("ServiceError", () => {
 
     // see: https://github.com/microsoft/TypeScript/issues/13965