@compassdigital/sdk.typescript 4.911.0 → 4.913.0

package/lib/interface/menu.js.map

@@ -1 +1 @@
-{"version":3,"file":"menu.js","sourceRoot":"","sources":["../../src/interface/menu.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,sDAAsD;;;AAqbzC,QAAA,uBAAuB,GAAG;IACtC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;CACL,CAAC"}
+{"version":3,"file":"menu.js","sourceRoot":"","sources":["../../src/interface/menu.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,sDAAsD;;;AA6bzC,QAAA,uBAAuB,GAAG;IACtC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;CACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.911.0",
+	"version": "4.913.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -1434,6 +1434,7 @@ import {
 	GetCentricosSiteResponse,
 	GetCentricosSiteMenuHoursDetailsResponse,
 	GetCentricosSiteClientSettingsResponse,
+	GetCentricosSiteFoodWasteResponse,
 	GetReviewOrderItemsResponse,
 	GetYesterdaysSnapshotResponse,
 	GetCentricosStationResponse,
@@ -16826,6 +16827,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /centricos/site/{siteId}/food-waste - Get a site's food waste for the last 7 days, compared with the 7 days before
+	 *
+	 * @param siteId - ID of the site to summarize Topanga food waste for
+	 * @param options - additional request options
+	 */
+	get_centricos_site_food_waste(
+		siteId: string,
+		options?: RequestOptions,
+	): ResponsePromise<GetCentricosSiteFoodWasteResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/site/{siteId}/food-waste',
+			'GET',
+			`/centricos/site/${siteId}/food-waste`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
 	 *

package/src/interface/centricos.ts

@@ -311,6 +311,33 @@ export interface GetSiteClientSettingsResponse {
 	aggregate_view?: boolean;
 }
 
+export interface FoodWasteWindow {
+	// First UTC day of the window.
+	start: string;
+	// Last UTC day of the window, inclusive.
+	end: string;
+	// Total net waste weight in grams.
+	total_grams: number;
+}
+
+export interface FoodWasteLocation {
+	// Topanga location name. Null for the one entry that groups records with no location name.
+	name: string | null;
+	// Net waste weight in grams in the current window.
+	total_grams: number;
+}
+
+export interface GetSiteFoodWasteResponse {
+	// The 7 UTC days ending yesterday. Null when the site has no valid waste records.
+	current: FoodWasteWindow;
+	// The 7 days before `current`. Null when the fetched records do not cover it.
+	previous: FoodWasteWindow;
+	// Change from the previous total to the current total, in whole percent. Null when `previous` is null or its total is 0.
+	percent_change: number | null;
+	// Up to 5 locations in the current window, heaviest first.
+	top_locations: FoodWasteLocation[];
+}
+
 export interface ReviewOrderItem {
 	// Order id
 	id: string;
@@ -1756,6 +1783,15 @@ export interface GetCentricosSiteClientSettingsPath {
 
 export type GetCentricosSiteClientSettingsResponse = GetSiteClientSettingsResponse;
 
+// GET /centricos/site/{siteId}/food-waste - Get a site's food waste for the last 7 days, compared with the 7 days before
+
+export interface GetCentricosSiteFoodWastePath {
+	// ID of the site to summarize Topanga food waste for
+	siteId: string;
+}
+
+export type GetCentricosSiteFoodWasteResponse = GetSiteFoodWasteResponse;
+
 // GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
 
 export interface GetReviewOrderItemsPath {

package/src/interface/menu.ts

@@ -48,6 +48,8 @@ export interface Menu {
 			id?: string;
 			name?: string;
 			jde_category?: string;
+			// Human-readable JDE category name decoded from jde_category
+			jde_category_label?: string;
 		};
 		// V3 Local Menu Group metadata if menu came from Centric
 		local_menu_group?: {
@@ -216,7 +218,10 @@ export interface Item {
 			primary?: string;
 			secondary?: string;
 		};
+		// JDE category ID: the item or modifier's own, falling back to the brand JDE category when not set
 		jde_category?: string;
+		// Human-readable JDE category name decoded from jde_category
+		jde_category_label?: string;
 	};
 	// @deprecated
 	is_deleted?: boolean;
@@ -287,7 +292,10 @@ export interface Option {
 			primary?: string;
 			secondary?: string;
 		};
+		// JDE category ID: the item or modifier's own, falling back to the brand JDE category when not set
 		jde_category?: string;
+		// Human-readable JDE category name decoded from jde_category
+		jde_category_label?: string;
 	};
 	weight?: {
 		unit?: string;