@compassdigital/sdk.typescript 4.583.0 → 4.584.0

package/lib/interface/forecasting.d.ts

@@ -22,6 +22,20 @@ export interface ProductionSheetResponseDto {
     items: ProductionSheetItemDto[];
     response_id?: string;
 }
+export interface ProductionSheetPaginatedMetaDto {
+    page: number;
+    pageSize: number;
+    totalItems: number;
+    totalPages: number;
+}
+export interface ProductionSheetPaginatedResultsDto {
+    items: ProductionSheetItemDto[];
+    response_id?: string;
+}
+export interface ProductionSheetPaginatedResponseDto {
+    meta: ProductionSheetPaginatedMetaDto;
+    results: ProductionSheetPaginatedResultsDto;
+}
 export interface ProductionSheetItemForecastDiffDto {
     item_name: string;
     pos_id: string;
@@ -83,6 +97,22 @@ export interface HealthResponseDTO {
 }
 export type ProductionSheetControllerCreateSheetBody = CreateProductionSheetDto;
 export type ProductionSheetControllerCreateSheetResponse = ProductionSheetResponseDto;
+export interface ProductionSheetControllerGetProductionSheetPaginatedQuery {
+    siteId: string;
+    fromDate: string;
+    toDate: string;
+    page?: number;
+    pageSize?: number;
+    brandIds?: string;
+    menuId?: string;
+    itemNameContains?: string;
+    includeBarcodeItems?: boolean;
+    responseId?: string;
+    nocache?: boolean;
+    sortBy?: 'item_name' | 'last_week_amount' | 'forecasted_amount' | 'actual_amount' | 'on_hand' | 'total_to_produce';
+    sortOrder?: 'asc' | 'desc';
+}
+export type ProductionSheetControllerGetProductionSheetPaginatedResponse = ProductionSheetPaginatedResponseDto;
 export interface ProductionSheetControllerGetScheduledMenuDataQuery {
     siteId: string;
     date: string;

package/lib/interface/forecasting.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"forecasting.d.ts","sourceRoot":"","sources":["../../src/interface/forecasting.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,wBAAwB;IAExC,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,MAAM,CAAC;IAEjB,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAC3C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IAC1C,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IAElD,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,uBAAuB,EAAE,MAAM,CAAC;IAEhC,gBAAgB,EAAE,MAAM,CAAC;IAEzB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IAExC,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,qBAAqB,EAAE,MAAM,CAAC;IAE9B,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,kCAAkC,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,wBAAwB;IAExC,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAW;IAE3B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAE9B,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,MAAM,CAAC;IAEhB,OAAO,EAAE,MAAM,CAAC;IAEhB,QAAQ,EAAE,MAAM,CAAC;IAEjB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,QAAQ,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAEnC,IAAI,EAAE,WAAW,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAE/B,OAAO,EAAE,MAAM,CAAC;IAEhB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;IAElC,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAChC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,mBAAmB,EAAE,CAAC;IACpC,QAAQ,EAAE,iBAAiB,CAAC;CAC5B;AAID,MAAM,MAAM,wCAAwC,GAAG,wBAAwB,CAAC;AAEhF,MAAM,MAAM,4CAA4C,GAAG,0BAA0B,CAAC;AAItF,MAAM,WAAW,kDAAkD;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,qDAAqD,GAAG,EAAE,CAAC;AAIvE,MAAM,MAAM,yDAAyD,GAAG,wBAAwB,CAAC;AAEjG,MAAM,MAAM,6DAA6D,GACxE,wBAAwB,CAAC;AAI1B,MAAM,MAAM,4CAA4C,GAAG,cAAc,CAAC;AAE1E,MAAM,MAAM,gDAAgD,GAAG,EAAE,CAAC;AAIlE,MAAM,MAAM,6CAA6C,GAAG,eAAe,CAAC;AAE5E,MAAM,MAAM,iDAAiD,GAAG,EAAE,CAAC;AAInE,MAAM,WAAW,iDAAiD;IACjE,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,oDAAoD,GAAG,EAAE,CAAC;AAItE,MAAM,MAAM,qCAAqC,GAAG,EAAE,CAAC;AAIvD,MAAM,MAAM,uCAAuC,GAAG,cAAc,CAAC;AAErE,MAAM,MAAM,2CAA2C,GAAG,EAAE,CAAC;AAI7D,MAAM,MAAM,4BAA4B,GAAG,iBAAiB,CAAC"}
+{"version":3,"file":"forecasting.d.ts","sourceRoot":"","sources":["../../src/interface/forecasting.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,wBAAwB;IAExC,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,MAAM,CAAC;IAEjB,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAC3C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IAC1C,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,+BAA+B;IAE/C,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kCAAkC;IAClD,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAEhC,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mCAAmC;IACnD,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,kCAAkC,CAAC;CAC5C;AAED,MAAM,WAAW,kCAAkC;IAElD,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,uBAAuB,EAAE,MAAM,CAAC;IAEhC,gBAAgB,EAAE,MAAM,CAAC;IAEzB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IAExC,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,qBAAqB,EAAE,MAAM,CAAC;IAE9B,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,kCAAkC,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,wBAAwB;IAExC,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAW;IAE3B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAE9B,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,MAAM,CAAC;IAEhB,OAAO,EAAE,MAAM,CAAC;IAEhB,QAAQ,EAAE,MAAM,CAAC;IAEjB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,QAAQ,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAEnC,IAAI,EAAE,WAAW,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAE/B,OAAO,EAAE,MAAM,CAAC;IAEhB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;IAElC,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAChC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,mBAAmB,EAAE,CAAC;IACpC,QAAQ,EAAE,iBAAiB,CAAC;CAC5B;AAID,MAAM,MAAM,wCAAwC,GAAG,wBAAwB,CAAC;AAEhF,MAAM,MAAM,4CAA4C,GAAG,0BAA0B,CAAC;AAItF,MAAM,WAAW,yDAAyD;IAEzE,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,MAAM,CAAC;IAEjB,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,MAAM,CAAC,EACJ,WAAW,GACX,kBAAkB,GAClB,mBAAmB,GACnB,eAAe,GACf,SAAS,GACT,kBAAkB,CAAC;IAEtB,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,4DAA4D,GACvE,mCAAmC,CAAC;AAIrC,MAAM,WAAW,kDAAkD;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,qDAAqD,GAAG,EAAE,CAAC;AAIvE,MAAM,MAAM,yDAAyD,GAAG,wBAAwB,CAAC;AAEjG,MAAM,MAAM,6DAA6D,GACxE,wBAAwB,CAAC;AAI1B,MAAM,MAAM,4CAA4C,GAAG,cAAc,CAAC;AAE1E,MAAM,MAAM,gDAAgD,GAAG,EAAE,CAAC;AAIlE,MAAM,MAAM,6CAA6C,GAAG,eAAe,CAAC;AAE5E,MAAM,MAAM,iDAAiD,GAAG,EAAE,CAAC;AAInE,MAAM,WAAW,iDAAiD;IACjE,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,oDAAoD,GAAG,EAAE,CAAC;AAItE,MAAM,MAAM,qCAAqC,GAAG,EAAE,CAAC;AAIvD,MAAM,MAAM,uCAAuC,GAAG,cAAc,CAAC;AAErE,MAAM,MAAM,2CAA2C,GAAG,EAAE,CAAC;AAI7D,MAAM,MAAM,4BAA4B,GAAG,iBAAiB,CAAC"}

package/package.json

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

package/src/index.ts

@@ -1447,6 +1447,8 @@ import {
 import {
 	ProductionSheetControllerCreateSheetBody,
 	ProductionSheetControllerCreateSheetResponse,
+	ProductionSheetControllerGetProductionSheetPaginatedQuery,
+	ProductionSheetControllerGetProductionSheetPaginatedResponse,
 	ProductionSheetControllerGetScheduledMenuDataQuery,
 	ProductionSheetControllerGetScheduledMenuDataResponse,
 	ProductionSheetControllerSaveItemForecastDifferentialBody,
@@ -16263,6 +16265,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /forecasting/production-sheet - Get production sheet page
+	 *
+	 * @param options - additional request options
+	 */
+	ProductionSheetController_getProductionSheetPaginated(
+		options: {
+			query: ProductionSheetControllerGetProductionSheetPaginatedQuery;
+		} & RequestOptions,
+	): ResponsePromise<ProductionSheetControllerGetProductionSheetPaginatedResponse> {
+		return this.request(
+			'forecasting',
+			'/forecasting/production-sheet',
+			'GET',
+			`/forecasting/production-sheet`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /forecasting/scheduled-menu-data - Get scheduled menu data for a site for a given date
 	 *

package/src/interface/forecasting.ts

@@ -35,6 +35,28 @@ export interface ProductionSheetResponseDto {
 	response_id?: string;
 }
 
+export interface ProductionSheetPaginatedMetaDto {
+	// Current page (1-based)
+	page: number;
+	// Page size used for this response
+	pageSize: number;
+	// Total rows after filters (all pages)
+	totalItems: number;
+	// Total pages for current page size
+	totalPages: number;
+}
+
+export interface ProductionSheetPaginatedResultsDto {
+	items: ProductionSheetItemDto[];
+	// Luna session id when present
+	response_id?: string;
+}
+
+export interface ProductionSheetPaginatedResponseDto {
+	meta: ProductionSheetPaginatedMetaDto;
+	results: ProductionSheetPaginatedResultsDto;
+}
+
 export interface ProductionSheetItemForecastDiffDto {
 	// Item name
 	item_name: string;
@@ -139,6 +161,46 @@ export type ProductionSheetControllerCreateSheetBody = CreateProductionSheetDto;
 
 export type ProductionSheetControllerCreateSheetResponse = ProductionSheetResponseDto;
 
+// GET /forecasting/production-sheet - Get production sheet page
+
+export interface ProductionSheetControllerGetProductionSheetPaginatedQuery {
+	// Site ID the production sheet is for
+	siteId: string;
+	// Start date (ISO-8601)
+	fromDate: string;
+	// End date (ISO-8601)
+	toDate: string;
+	// Page number (1-based)
+	page?: number;
+	// Page size
+	pageSize?: number;
+	// Comma-separated brand IDs to include (matches CentricOS brand filter)
+	brandIds?: string;
+	// Menu ID to include
+	menuId?: string;
+	// Case-insensitive substring filter on item_name
+	itemNameContains?: string;
+	// When true, include barcoded items; when false/omitted, exclude rows with a barcode (CentricOS default)
+	includeBarcodeItems?: boolean;
+	// Forwarded to Luna on cache miss only
+	responseId?: string;
+	// When true, skip S3 cache read and rebuild; write replaces any existing object
+	nocache?: boolean;
+	// Sort column before pagination (matches CentricOS DataTable). total_to_produce uses max(0, forecasted_amount - on_hand).
+	sortBy?:
+		| 'item_name'
+		| 'last_week_amount'
+		| 'forecasted_amount'
+		| 'actual_amount'
+		| 'on_hand'
+		| 'total_to_produce';
+	// Sort direction; default desc matches CentricOS default on forecast column
+	sortOrder?: 'asc' | 'desc';
+}
+
+export type ProductionSheetControllerGetProductionSheetPaginatedResponse =
+	ProductionSheetPaginatedResponseDto;
+
 // GET /forecasting/scheduled-menu-data - Get scheduled menu data for a site for a given date
 
 export interface ProductionSheetControllerGetScheduledMenuDataQuery {