@compassdigital/sdk.typescript 4.418.0 → 4.420.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.418.0",
+	"version": "4.420.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",
@@ -58,7 +58,7 @@
 	},
 	"devDependencies": {
 		"@compassdigital/review": "^7.6.3",
-		"@compassdigital/sdk.typescript.cli": "^4.55.0",
+		"@compassdigital/sdk.typescript.cli": "^4.56.0",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^30.0.0",

package/pipeline.yml

@@ -2,6 +2,7 @@ name: npm-typescript-sdk
 
 flags:
   - DEPENDABOT
+  - P4_V2_TOOLS
 
 test:
   commands:

package/src/base.ts

@@ -15,6 +15,8 @@ export interface RequestOptions {
 	retry?: number;
 	// timeout in milliseconds
 	timeout?: number;
+	// abort signal to cancel the request
+	signal?: AbortSignal;
 	// make requests against this base url.
 	// per-service base urls are configured as an object
 	// eg. { order: 'http://localhost:3000', shoppingcart: 'http://localhost:4000' }
@@ -446,11 +448,10 @@ export abstract class BaseServiceClient {
 			return options.intercept(req, this.fetch.bind(this));
 		}
 		try {
-			let signal: AbortSignal | undefined;
+			let signal = options?.signal;
 			if (options?.timeout) {
-				const controller = new AbortController();
-				setTimeout(() => controller.abort('timeout'), options.timeout);
-				signal = controller.signal;
+				const timeoutSignal = AbortSignal.timeout(options.timeout);
+				signal = signal ? AbortSignal.any([signal, timeoutSignal]) : timeoutSignal;
 			}
 			const res = await fetch(req.url, {
 				method: req.method,

package/src/index.ts

@@ -623,6 +623,8 @@ import {
 	GetMenuV3DraftBrandVerifyPublishResponse,
 	PostMenuV3DraftBrandArchiveResponse,
 	PostMenuV3DraftBrandUnarchiveResponse,
+	PostMenuV3DraftBrandSyncMenuworksQuery,
+	PostMenuV3DraftBrandSyncMenuworksResponse,
 	PostMenuV3BrandQuery,
 	PostMenuV3BrandBody,
 	PostMenuV3BrandResponse,
@@ -4624,12 +4626,12 @@ export class ServiceClient extends BaseServiceClient {
 	}
 
 	/**
-	 * GET /ping - Config Service liveness check
+	 * GET /config/ping - Config Service liveness check
 	 *
 	 * @param options - additional request options
 	 */
 	get_config_ping(options?: RequestOptions): ResponsePromise<GetConfigPingResponse> {
-		return this.request('config', '/ping', 'GET', `/ping`, null, options);
+		return this.request('config', '/config/ping', 'GET', `/config/ping`, null, options);
 	}
 
 	/**
@@ -7404,6 +7406,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v3/draft/brand/{id}/sync-menuworks
+	 *
+	 * @param id - TODO: add parameter to swagger.json
+	 * @param options - additional request options
+	 */
+	post_menu_v3_draft_brand_sync_menuworks(
+		id: string,
+		options?: {
+			query?: PostMenuV3DraftBrandSyncMenuworksQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostMenuV3DraftBrandSyncMenuworksResponse> {
+		return this.request(
+			'menu',
+			'/menu/v3/draft/brand/{id}/sync-menuworks',
+			'POST',
+			`/menu/v3/draft/brand/${id}/sync-menuworks`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v3/brand
 	 *

package/src/interface/config.ts

@@ -300,7 +300,7 @@ export type DeleteConfigPublicResponse = Success;
 
 export interface DeleteConfigPublicRequest extends BaseRequest, DeleteConfigPublicPath {}
 
-// GET /ping - Config Service liveness check
+// GET /config/ping - Config Service liveness check
 
 export type GetConfigPingResponse = PingResponse;
 

package/src/interface/location.ts

@@ -221,6 +221,9 @@ export interface Brand {
 			agilysys_dod?: {
 				enabled?: boolean;
 			};
+			transact?: {
+				enabled?: boolean;
+			};
 		};
 		type_of_kds?: {
 			cdl?: boolean;

package/src/interface/menu.ts

@@ -54,6 +54,13 @@ export interface Menu {
 		};
 		[index: string]: any;
 	};
+	image?: {
+		src?: string;
+		sizes?: {
+			original?: string;
+			thumbnail_80_80?: string;
+		};
+	};
 }
 
 export interface Nutrition {
@@ -169,6 +176,13 @@ export interface Item {
 			smart_tags?: string[];
 			// menuworks allergen tags
 			allergen_tags?: string[];
+			// menuworks allergens with contains field
+			allergens?: {
+				// allergen name
+				name?: string;
+				// allergen contains status: 'Yes' or 'AtRisk'
+				contains?: 'Yes' | 'AtRisk';
+			}[];
 		};
 		// unique id of the entity
 		unique_id?: number;
@@ -325,6 +339,13 @@ export interface Option {
 			smart_tags?: string[];
 			// menuworks allergen tags
 			allergen_tags?: string[];
+			// menuworks allergens with contains field
+			allergens?: {
+				// allergen name
+				name?: string;
+				// allergen contains status: 'Yes' or 'AtRisk'
+				contains?: 'Yes' | 'AtRisk';
+			}[];
 		};
 		// unique id of the entity
 		unique_id?: number;
@@ -4065,6 +4086,28 @@ export interface PostMenuV3DraftBrandUnarchiveRequest
 	extends BaseRequest,
 		PostMenuV3DraftBrandUnarchivePath {}
 
+// POST /menu/v3/draft/brand/{id}/sync-menuworks
+
+export interface PostMenuV3DraftBrandSyncMenuworksPath {
+	// TODO: add parameter to swagger.json
+	id: string;
+}
+
+export interface PostMenuV3DraftBrandSyncMenuworksQuery {
+	brand_id?: string;
+}
+
+export interface PostMenuV3DraftBrandSyncMenuworksResponse {
+	process_id: string;
+	status: string;
+	[index: string]: any;
+}
+
+export interface PostMenuV3DraftBrandSyncMenuworksRequest
+	extends BaseRequest,
+		RequestQuery<PostMenuV3DraftBrandSyncMenuworksQuery>,
+		PostMenuV3DraftBrandSyncMenuworksPath {}
+
 // POST /menu/v3/brand
 
 export interface PostMenuV3BrandQuery {