@compassdigital/sdk.typescript 4.690.0 → 4.694.0

package/lib/messages/commands/UpdateOrderStatusCommand.d.ts

@@ -8,7 +8,7 @@ export interface UpdateOrderStatusCommand {
     };
     payload: {
         orderId: string;
-        status: 'accepted' | 'in_progress' | 'ready' | 'out_for_delivery' | 'delivered' | 'see_kitchen';
+        status: 'accepted' | 'in_progress' | 'ready' | 'out_for_delivery' | 'delivered' | 'collected' | 'no_show' | 'see_kitchen';
         reason?: string;
         updateSource: string;
     };

package/lib/messages/commands/UpdateOrderStatusCommand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UpdateOrderStatusCommand.d.ts","sourceRoot":"","sources":["../../../src/messages/commands/UpdateOrderStatusCommand.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,wBAAwB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EACH,UAAU,GACV,aAAa,GACb,OAAO,GACP,kBAAkB,GAClB,WAAW,GACX,aAAa,CAAC;QAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"UpdateOrderStatusCommand.d.ts","sourceRoot":"","sources":["../../../src/messages/commands/UpdateOrderStatusCommand.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,wBAAwB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EACH,UAAU,GACV,aAAa,GACb,OAAO,GACP,kBAAkB,GAClB,WAAW,GACX,WAAW,GACX,SAAS,GACT,aAAa,CAAC;QAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.690.0",
+	"version": "4.694.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.60.0",
+		"@compassdigital/sdk.typescript.cli": "^4.61.0",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^30.0.0",

package/src/base.ts

@@ -414,6 +414,13 @@ export abstract class BaseServiceClient {
 	 * Determine the base url to use.
 	 */
 	private base_url(service: string, { base_url, stage }: RequestOptions): string {
+		// An empty base_url falls back to the runtime origin (browser/jsdom),
+		// resolving requests the way a browser fetch would; in Node there is
+		// no origin, so the url stays relative.
+		if (base_url === '') {
+			const global: { location?: { origin?: string } } = globalThis;
+			return this.clean_url(global.location?.origin ?? '');
+		}
 		// use the base url if one was provided.
 		if (typeof base_url === 'string') {
 			return this.clean_url(base_url);

package/src/index.ts

@@ -1585,7 +1585,12 @@ import {
 	GetForecastingHealthResponse,
 } from './interface/forecasting';
 
-import { GetDeliveryHealthResponse, PostDeliveryOrderReadyResponse } from './interface/delivery';
+import {
+	GetDeliveryHealthResponse,
+	PostDeliveryOrderReadyResponse,
+	PostDeliveryOrderOpenLidResponse,
+	PostDeliveryOrderCloseLidResponse,
+} from './interface/delivery';
 
 import { BaseServiceClient, RequestOptions, ServiceClientOptions, ResponsePromise } from './base';
 export * from './base';
@@ -18035,4 +18040,44 @@ export class ServiceClient extends BaseServiceClient {
 			options,
 		);
 	}
+
+	/**
+	 * POST /delivery/order/{id}/open - Open the lid of an AVRIDE order
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	post_delivery_order_open_lid(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<PostDeliveryOrderOpenLidResponse> {
+		return this.request(
+			'delivery',
+			'/delivery/order/{id}/open',
+			'POST',
+			`/delivery/order/${id}/open`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /delivery/order/{id}/close - Close the lid of an AVRIDE order
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	post_delivery_order_close_lid(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<PostDeliveryOrderCloseLidResponse> {
+		return this.request(
+			'delivery',
+			'/delivery/order/{id}/close',
+			'POST',
+			`/delivery/order/${id}/close`,
+			null,
+			options,
+		);
+	}
 }

package/src/interface/consumer.ts

@@ -1765,6 +1765,61 @@ export interface ConsumerGetActiveMenusResponse {
 	menus: ConsumerMenuHours[];
 }
 
+export interface MenuRecipeAllergenConsumer {
+	// Allergen key for localization, icons, and filtering
+	key?: string;
+	// Allergen name
+	name?: string;
+	// Allergen contains status: 'Yes' or 'AtRisk'
+	contains?: 'Yes' | 'AtRisk';
+}
+
+export interface GetMenuItemRecipeConsumerV2 {
+	// Smart tags
+	smart_tags?: string[];
+	// Allergen tags
+	allergen_tags?: string[];
+	// MenuWorks MRN
+	mrn?: string;
+	// MenuWorks unit ID
+	unit_id?: string;
+	// MenuWorks portion quantity
+	portion_quantity?: number;
+	// MenuWorks portion unit name
+	portion_unit_name?: string;
+	// MenuWorks grams
+	grams?: number;
+	// MenuWorks cost per serving
+	cost?: number;
+	// MenuWorks ingredients
+	ingredients?: string[];
+	// MenuWorks allergens with contains field
+	allergens?: MenuRecipeAllergenConsumer[];
+}
+
+export interface GetMenuItemMetaConsumerV2 {
+	// Barcodes of the item
+	barcodes?: string[];
+	// Recipe metadata
+	recipe?: GetMenuItemRecipeConsumerV2;
+	superplate?: {
+		type_id?: number;
+		type?: string;
+	};
+	// Chit sort order
+	sort_number?: number;
+	// Menu sort order
+	menu_sort_number?: number;
+	// Unique ID of the entity
+	unique_id?: number;
+	tax?: {
+		tax_tag_code?: string;
+		tax_jwo_code?: string;
+		tax_rate?: number;
+		tax_amount?: number;
+	};
+}
+
 export interface ConsumerOption {
 	// Metadata for the option
 	meta?: Record<string, any>;
@@ -1838,7 +1893,7 @@ export interface ConsumerOptionsGroup {
 
 export interface ConsumerItem {
 	// Metadata for the item
-	meta?: Record<string, any>;
+	meta?: GetMenuItemMetaConsumerV2;
 	id?: string;
 	label?: {
 		en?: string;
@@ -2120,15 +2175,6 @@ export interface GetMenuItemOptionsGroupConsumer {
 	meta?: GetMenuItemGroupMetaConsumer;
 }
 
-export interface MenuRecipeAllergenConsumer {
-	// Allergen key for localization, icons, and filtering
-	key?: string;
-	// Allergen name
-	name?: string;
-	// Allergen contains status: 'Yes' or 'AtRisk'
-	contains?: 'Yes' | 'AtRisk';
-}
-
 export interface GetMenuItemRecipeConsumer {
 	// Smart tags
 	smart_tags?: string[];
@@ -2508,52 +2554,6 @@ export interface GetMenuItemOptionsGroupConsumerV2 {
 	meta?: GetMenuItemGroupMetaConsumerV2;
 }
 
-export interface GetMenuItemRecipeConsumerV2 {
-	// Smart tags
-	smart_tags?: string[];
-	// Allergen tags
-	allergen_tags?: string[];
-	// MenuWorks MRN
-	mrn?: string;
-	// MenuWorks unit ID
-	unit_id?: string;
-	// MenuWorks portion quantity
-	portion_quantity?: number;
-	// MenuWorks portion unit name
-	portion_unit_name?: string;
-	// MenuWorks grams
-	grams?: number;
-	// MenuWorks cost per serving
-	cost?: number;
-	// MenuWorks ingredients
-	ingredients?: string[];
-	// MenuWorks allergens with contains field
-	allergens?: MenuRecipeAllergenConsumer[];
-}
-
-export interface GetMenuItemMetaConsumerV2 {
-	// Barcodes of the item
-	barcodes?: string[];
-	// Recipe metadata
-	recipe?: GetMenuItemRecipeConsumerV2;
-	superplate?: {
-		type_id?: number;
-		type?: string;
-	};
-	// Chit sort order
-	sort_number?: number;
-	// Menu sort order
-	menu_sort_number?: number;
-	// Unique ID of the entity
-	unique_id?: number;
-	tax?: {
-		tax_tag_code?: string;
-		tax_jwo_code?: string;
-		tax_rate?: number;
-		tax_amount?: number;
-	};
-}
-
 export interface GetMenuItemIsConsumerV2 {
 	// Is the item disabled
 	disabled?: boolean;

package/src/interface/delivery.ts

@@ -46,13 +46,83 @@ export interface ErrorData {
 	displayMessage: ErrorDisplayMessage;
 }
 
-export interface Error {
-	// business error code
-	code: number;
-	// business error description
-	message: string;
-	// additional error data
-	data: ErrorData;
+export type Error = Record<string, any>;
+
+export interface LocationDto {
+	// Street address
+	address?: string;
+	// External identifier for the location
+	extId?: string;
+	// Latitude
+	lat?: number;
+	// Longitude
+	lon?: number;
+}
+
+export interface EtaDto {
+	// Estimated drop-off time
+	dropOff?: string;
+	// Estimated pick-up time
+	pickUp?: string;
+	// Estimated return time
+	return?: string;
+}
+
+export interface RequestLocationDto {
+	// Street address
+	address: string;
+}
+
+export interface RequestDto {
+	// Client name
+	clientName?: string;
+	dst?: RequestLocationDto;
+	src?: RequestLocationDto;
+}
+
+export interface RobotPositionDto {
+	// Latitude
+	lat: number;
+	// Longitude
+	lon: number;
+	// Heading, in degrees
+	yaw: number;
+}
+
+export interface RoutePointDto {
+	// Latitude
+	lat: number;
+	// Longitude
+	lon: number;
+}
+
+export interface RobotDto {
+	// Whether the robot is delivering other orders
+	deliveringOtherOrders?: boolean;
+	// Robot name
+	name?: string;
+	position?: RobotPositionDto;
+	route?: RoutePointDto[];
+}
+
+export interface OrderOpenLidResponseDto {
+	// Order creation time
+	createdAt?: string;
+	dst: LocationDto;
+	eta: EtaDto;
+	// External identifier for the order
+	extId?: string;
+	// Order identifier
+	id: string;
+	// Whether the lid is ready to be opened
+	ready: boolean;
+	request?: RequestDto;
+	robots?: RobotDto[];
+	// Scheduled pick-up time
+	scheduledPickUp?: string;
+	src?: LocationDto;
+	// Order status
+	status: string;
 }
 
 // GET /delivery/health - Delivery service readiness check
@@ -70,3 +140,27 @@ export interface PostDeliveryOrderReadyPath {
 export type PostDeliveryOrderReadyResponse = OrderReadyResponseDto;
 
 export interface PostDeliveryOrderReadyRequest extends BaseRequest, PostDeliveryOrderReadyPath {}
+
+// POST /delivery/order/{id}/open - Open the lid of an AVRIDE order
+
+export interface PostDeliveryOrderOpenLidPath {
+	id: string;
+}
+
+export type PostDeliveryOrderOpenLidResponse = OrderOpenLidResponseDto;
+
+export interface PostDeliveryOrderOpenLidRequest
+	extends BaseRequest,
+		PostDeliveryOrderOpenLidPath {}
+
+// POST /delivery/order/{id}/close - Close the lid of an AVRIDE order
+
+export interface PostDeliveryOrderCloseLidPath {
+	id: string;
+}
+
+export type PostDeliveryOrderCloseLidResponse = OrderOpenLidResponseDto;
+
+export interface PostDeliveryOrderCloseLidRequest
+	extends BaseRequest,
+		PostDeliveryOrderCloseLidPath {}

package/src/interface/location.ts

@@ -108,6 +108,7 @@ export interface SoftwareIntegrations {
 	};
 	transact?: {
 		enabled?: boolean;
+		integration_id?: string;
 	};
 	grubhub?: {
 		enabled?: boolean;

package/src/interface/menu.ts

@@ -619,6 +619,12 @@ export interface UnauthorizedErrorDTO {
 	[index: string]: any;
 }
 
+export interface ForbiddenErrorDTO {
+	number: number;
+	message: string;
+	[index: string]: any;
+}
+
 export interface InternalServerErrorDTO {
 	number: number;
 	message: string;

package/src/messages/commands/UpdateOrderStatusCommand.ts

@@ -16,6 +16,8 @@ export interface UpdateOrderStatusCommand {
 			| 'ready'
 			| 'out_for_delivery'
 			| 'delivered'
+			| 'collected'
+			| 'no_show'
 			| 'see_kitchen';
 		// Reason if the status is see_kitchen
 		reason?: string;