@managesome/eposmatic-toolkit 0.4.9 → 0.4.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/constants/MATERIALIZED_REPORTS.js +448 -0
- package/esm/helpers/index.js +3 -0
- package/esm/helpers/materialized-reports/index.js +32 -0
- package/esm/helpers/materialized-reports/materialized-cash-accumulator-helpers.js +114 -0
- package/esm/helpers/materialized-reports/materialized-cash-classification-helpers.js +286 -0
- package/esm/helpers/materialized-reports/materialized-cash-close-day-helpers.js +396 -0
- package/esm/helpers/materialized-reports/materialized-cash-compile-helpers.js +244 -0
- package/esm/helpers/materialized-reports/materialized-delivery-accumulator-helpers.js +170 -0
- package/esm/helpers/materialized-reports/materialized-delivery-classification-helpers.js +426 -0
- package/esm/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +372 -0
- package/esm/helpers/materialized-reports/materialized-delivery-compile-helpers.js +214 -0
- package/esm/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +318 -0
- package/esm/helpers/materialized-reports/materialized-discount-classification-helpers.js +213 -0
- package/esm/helpers/materialized-reports/materialized-discount-close-day-helpers.js +604 -0
- package/esm/helpers/materialized-reports/materialized-discount-compile-helpers.js +186 -0
- package/esm/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.js +155 -0
- package/esm/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.js +199 -0
- package/esm/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +111 -0
- package/esm/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +88 -0
- package/esm/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.js +394 -0
- package/esm/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.js +167 -0
- package/esm/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +215 -0
- package/esm/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +476 -0
- package/esm/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +201 -0
- package/esm/helpers/materialized-reports/materialized-reports-selection-helpers.js +7 -0
- package/esm/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +189 -0
- package/esm/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +157 -0
- package/esm/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.js +588 -0
- package/esm/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.js +175 -0
- package/esm/helpers/materialized-reports/tenant-cash-in-out-formatter.js +156 -0
- package/esm/helpers/materialized-reports/tenant-delivery-formatter.js +230 -0
- package/esm/helpers/materialized-reports/tenant-discount-formatter.js +427 -0
- package/esm/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +237 -0
- package/esm/helpers/materialized-reports/tenant-payments-comparison-formatter.js +279 -0
- package/esm/helpers/materialized-reports/tenant-prep-time-formatter.js +228 -0
- package/esm/helpers/materialized-reports/tenant-sales-comparison-formatter.js +343 -0
- package/esm/helpers/reporting-contract/index.js +2 -0
- package/esm/helpers/reporting-contract/overview-contract.js +122 -0
- package/esm/helpers/reporting-contract/report-contract.js +228 -0
- package/esm/helpers/rider-earnings/index.js +1 -0
- package/esm/helpers/rider-earnings/rider-earnings.js +59 -0
- package/esm/helpers/rider-reports/index.js +2 -0
- package/esm/helpers/rider-reports/rider-daily-report.js +90 -0
- package/esm/helpers/rider-reports/rider-report.js +67 -0
- package/esm/schemas/models/deliveries.js +75 -0
- package/esm/schemas/models/index.js +15 -0
- package/esm/schemas/models/materialized_rider_daily_reports.js +39 -0
- package/esm/schemas/models/materialized_tenant_cash_entries.js +95 -0
- package/esm/schemas/models/materialized_tenant_cash_reports.js +77 -0
- package/esm/schemas/models/materialized_tenant_delivery_entries.js +63 -0
- package/esm/schemas/models/materialized_tenant_delivery_reports.js +63 -0
- package/esm/schemas/models/materialized_tenant_discount_entries.js +156 -0
- package/esm/schemas/models/materialized_tenant_discount_reports.js +333 -0
- package/esm/schemas/models/materialized_tenant_hourly_comparison_entries.js +87 -0
- package/esm/schemas/models/materialized_tenant_hourly_comparison_reports.js +99 -0
- package/esm/schemas/models/materialized_tenant_payments_comparison_entries.js +71 -0
- package/esm/schemas/models/materialized_tenant_payments_comparison_reports.js +76 -0
- package/esm/schemas/models/materialized_tenant_prep_time_entries.js +130 -0
- package/esm/schemas/models/materialized_tenant_prep_time_reports.js +109 -0
- package/esm/schemas/models/materialized_tenant_sales_comparison_entries.js +130 -0
- package/esm/schemas/models/materialized_tenant_sales_comparison_reports.js +154 -0
- package/esm/schemas/types/index.js +15 -0
- package/esm/schemas/types/materialized_rider_daily_reports.js +1 -0
- package/esm/schemas/types/materialized_tenant_cash_entries.js +1 -0
- package/esm/schemas/types/materialized_tenant_cash_reports.js +1 -0
- package/esm/schemas/types/materialized_tenant_delivery_entries.js +1 -0
- package/esm/schemas/types/materialized_tenant_delivery_reports.js +1 -0
- package/esm/schemas/types/materialized_tenant_discount_entries.js +1 -0
- package/esm/schemas/types/materialized_tenant_discount_reports.js +2 -0
- package/esm/schemas/types/materialized_tenant_hourly_comparison_entries.js +1 -0
- package/esm/schemas/types/materialized_tenant_hourly_comparison_reports.js +1 -0
- package/esm/schemas/types/materialized_tenant_payments_comparison_entries.js +1 -0
- package/esm/schemas/types/materialized_tenant_payments_comparison_reports.js +11 -0
- package/esm/schemas/types/materialized_tenant_prep_time_entries.js +1 -0
- package/esm/schemas/types/materialized_tenant_prep_time_reports.js +1 -0
- package/esm/schemas/types/materialized_tenant_sales_comparison_entries.js +1 -0
- package/esm/schemas/types/materialized_tenant_sales_comparison_reports.js +14 -0
- package/lib/constants/MATERIALIZED_REPORTS.d.ts +339 -2
- package/lib/constants/MATERIALIZED_REPORTS.js +450 -1
- package/lib/helpers/index.d.ts +3 -0
- package/lib/helpers/index.js +3 -0
- package/lib/helpers/materialized-reports/index.d.ts +32 -0
- package/lib/helpers/materialized-reports/index.js +32 -0
- package/lib/helpers/materialized-reports/materialized-cash-accumulator-helpers.d.ts +18 -0
- package/lib/helpers/materialized-reports/materialized-cash-accumulator-helpers.js +118 -0
- package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.d.ts +90 -0
- package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.js +295 -0
- package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.d.ts +102 -0
- package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.js +409 -0
- package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.d.ts +72 -0
- package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.js +251 -0
- package/lib/helpers/materialized-reports/materialized-delivery-accumulator-helpers.d.ts +7 -0
- package/lib/helpers/materialized-reports/materialized-delivery-accumulator-helpers.js +173 -0
- package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.d.ts +84 -0
- package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.js +438 -0
- package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.d.ts +97 -0
- package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +385 -0
- package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.d.ts +40 -0
- package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +218 -0
- package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.d.ts +52 -0
- package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +324 -0
- package/lib/helpers/materialized-reports/materialized-discount-classification-helpers.d.ts +50 -0
- package/lib/helpers/materialized-reports/materialized-discount-classification-helpers.js +222 -0
- package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.d.ts +182 -0
- package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.js +615 -0
- package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.d.ts +47 -0
- package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.js +193 -0
- package/lib/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.d.ts +64 -0
- package/lib/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.js +163 -0
- package/lib/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.d.ts +61 -0
- package/lib/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.js +207 -0
- package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.d.ts +23 -0
- package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +116 -0
- package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.d.ts +25 -0
- package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +98 -0
- package/lib/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.d.ts +79 -0
- package/lib/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.js +407 -0
- package/lib/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.d.ts +35 -0
- package/lib/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.js +173 -0
- package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.d.ts +66 -0
- package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +224 -0
- package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.d.ts +128 -0
- package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +490 -0
- package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.d.ts +46 -0
- package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +208 -0
- package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.d.ts +8 -0
- package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.js +8 -1
- package/lib/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.d.ts +48 -0
- package/lib/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +204 -0
- package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.d.ts +22 -0
- package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +161 -0
- package/lib/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.d.ts +163 -0
- package/lib/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.js +603 -0
- package/lib/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.d.ts +68 -0
- package/lib/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.js +182 -0
- package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.d.ts +98 -0
- package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.js +159 -0
- package/lib/helpers/materialized-reports/tenant-delivery-formatter.d.ts +133 -0
- package/lib/helpers/materialized-reports/tenant-delivery-formatter.js +233 -0
- package/lib/helpers/materialized-reports/tenant-discount-formatter.d.ts +114 -0
- package/lib/helpers/materialized-reports/tenant-discount-formatter.js +431 -0
- package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.d.ts +60 -0
- package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +243 -0
- package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.d.ts +75 -0
- package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.js +286 -0
- package/lib/helpers/materialized-reports/tenant-prep-time-formatter.d.ts +97 -0
- package/lib/helpers/materialized-reports/tenant-prep-time-formatter.js +232 -0
- package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.d.ts +105 -0
- package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.js +349 -0
- package/lib/helpers/reporting-contract/index.d.ts +2 -0
- package/lib/helpers/reporting-contract/index.js +18 -0
- package/lib/helpers/reporting-contract/overview-contract.d.ts +55 -0
- package/lib/helpers/reporting-contract/overview-contract.js +126 -0
- package/lib/helpers/reporting-contract/report-contract.d.ts +159 -0
- package/lib/helpers/reporting-contract/report-contract.js +239 -0
- package/lib/helpers/rider-earnings/index.d.ts +1 -0
- package/lib/helpers/rider-earnings/index.js +17 -0
- package/lib/helpers/rider-earnings/rider-earnings.d.ts +58 -0
- package/lib/helpers/rider-earnings/rider-earnings.js +64 -0
- package/lib/helpers/rider-reports/index.d.ts +2 -0
- package/lib/helpers/rider-reports/index.js +18 -0
- package/lib/helpers/rider-reports/rider-daily-report.d.ts +26 -0
- package/lib/helpers/rider-reports/rider-daily-report.js +93 -0
- package/lib/helpers/rider-reports/rider-report.d.ts +49 -0
- package/lib/helpers/rider-reports/rider-report.js +70 -0
- package/lib/helpers/types/materialized-reports-apis.d.ts +297 -1
- package/lib/schemas/models/deliveries.d.ts +54 -0
- package/lib/schemas/models/deliveries.js +75 -0
- package/lib/schemas/models/expense_details.d.ts +3 -3
- package/lib/schemas/models/index.d.ts +15 -0
- package/lib/schemas/models/index.js +15 -0
- package/lib/schemas/models/materialized_rider_daily_reports.d.ts +27 -0
- package/lib/schemas/models/materialized_rider_daily_reports.js +42 -0
- package/lib/schemas/models/materialized_tenant_cash_entries.d.ts +181 -0
- package/lib/schemas/models/materialized_tenant_cash_entries.js +98 -0
- package/lib/schemas/models/materialized_tenant_cash_reports.d.ts +111 -0
- package/lib/schemas/models/materialized_tenant_cash_reports.js +80 -0
- package/lib/schemas/models/materialized_tenant_delivery_entries.d.ts +98 -0
- package/lib/schemas/models/materialized_tenant_delivery_entries.js +66 -0
- package/lib/schemas/models/materialized_tenant_delivery_reports.d.ts +98 -0
- package/lib/schemas/models/materialized_tenant_delivery_reports.js +66 -0
- package/lib/schemas/models/materialized_tenant_discount_entries.d.ts +199 -0
- package/lib/schemas/models/materialized_tenant_discount_entries.js +159 -0
- package/lib/schemas/models/materialized_tenant_discount_reports.d.ts +216 -0
- package/lib/schemas/models/materialized_tenant_discount_reports.js +336 -0
- package/lib/schemas/models/materialized_tenant_hourly_comparison_entries.d.ts +95 -0
- package/lib/schemas/models/materialized_tenant_hourly_comparison_entries.js +82 -0
- package/lib/schemas/models/materialized_tenant_hourly_comparison_reports.d.ts +105 -0
- package/lib/schemas/models/materialized_tenant_hourly_comparison_reports.js +91 -0
- package/lib/schemas/models/materialized_tenant_payments_comparison_entries.d.ts +91 -0
- package/lib/schemas/models/materialized_tenant_payments_comparison_entries.js +70 -0
- package/lib/schemas/models/materialized_tenant_payments_comparison_reports.d.ts +98 -0
- package/lib/schemas/models/materialized_tenant_payments_comparison_reports.js +71 -0
- package/lib/schemas/models/materialized_tenant_prep_time_entries.d.ts +181 -0
- package/lib/schemas/models/materialized_tenant_prep_time_entries.js +133 -0
- package/lib/schemas/models/materialized_tenant_prep_time_reports.d.ts +118 -0
- package/lib/schemas/models/materialized_tenant_prep_time_reports.js +112 -0
- package/lib/schemas/models/materialized_tenant_sales_comparison_entries.d.ts +139 -0
- package/lib/schemas/models/materialized_tenant_sales_comparison_entries.js +120 -0
- package/lib/schemas/models/materialized_tenant_sales_comparison_reports.d.ts +167 -0
- package/lib/schemas/models/materialized_tenant_sales_comparison_reports.js +137 -0
- package/lib/schemas/models/tenant_purchase_order_vendor_returns.d.ts +3 -3
- package/lib/schemas/models/warehouse_internal_movements.d.ts +6 -6
- package/lib/schemas/models/warehouse_purchase_order_receipts.d.ts +3 -3
- package/lib/schemas/models/warehouse_purchase_order_vendor_returns.d.ts +3 -3
- package/lib/schemas/models/warehouse_sale_deliveries.d.ts +6 -6
- package/lib/schemas/models/warehouse_sale_invoices.d.ts +3 -3
- package/lib/schemas/types/deliveries.d.ts +40 -1
- package/lib/schemas/types/index.d.ts +15 -0
- package/lib/schemas/types/index.js +15 -0
- package/lib/schemas/types/materialized_rider_daily_reports.d.ts +37 -0
- package/lib/schemas/types/materialized_rider_daily_reports.js +2 -0
- package/lib/schemas/types/materialized_tenant_cash_entries.d.ts +87 -0
- package/lib/schemas/types/materialized_tenant_cash_entries.js +2 -0
- package/lib/schemas/types/materialized_tenant_cash_reports.d.ts +144 -0
- package/lib/schemas/types/materialized_tenant_cash_reports.js +2 -0
- package/lib/schemas/types/materialized_tenant_delivery_entries.d.ts +98 -0
- package/lib/schemas/types/materialized_tenant_delivery_entries.js +2 -0
- package/lib/schemas/types/materialized_tenant_delivery_reports.d.ts +179 -0
- package/lib/schemas/types/materialized_tenant_delivery_reports.js +2 -0
- package/lib/schemas/types/materialized_tenant_discount_entries.d.ts +81 -0
- package/lib/schemas/types/materialized_tenant_discount_entries.js +2 -0
- package/lib/schemas/types/materialized_tenant_discount_reports.d.ts +209 -0
- package/lib/schemas/types/materialized_tenant_discount_reports.js +3 -0
- package/lib/schemas/types/materialized_tenant_hourly_comparison_entries.d.ts +33 -0
- package/lib/schemas/types/materialized_tenant_hourly_comparison_entries.js +2 -0
- package/lib/schemas/types/materialized_tenant_hourly_comparison_reports.d.ts +40 -0
- package/lib/schemas/types/materialized_tenant_hourly_comparison_reports.js +2 -0
- package/lib/schemas/types/materialized_tenant_payments_comparison_entries.d.ts +48 -0
- package/lib/schemas/types/materialized_tenant_payments_comparison_entries.js +2 -0
- package/lib/schemas/types/materialized_tenant_payments_comparison_reports.d.ts +51 -0
- package/lib/schemas/types/materialized_tenant_payments_comparison_reports.js +14 -0
- package/lib/schemas/types/materialized_tenant_prep_time_entries.d.ts +88 -0
- package/lib/schemas/types/materialized_tenant_prep_time_entries.js +2 -0
- package/lib/schemas/types/materialized_tenant_prep_time_reports.d.ts +132 -0
- package/lib/schemas/types/materialized_tenant_prep_time_reports.js +2 -0
- package/lib/schemas/types/materialized_tenant_sales_comparison_entries.d.ts +43 -0
- package/lib/schemas/types/materialized_tenant_sales_comparison_entries.js +2 -0
- package/lib/schemas/types/materialized_tenant_sales_comparison_reports.d.ts +74 -0
- package/lib/schemas/types/materialized_tenant_sales_comparison_reports.js +17 -0
- package/lib/tests/materialized-reports/analytics-growth-helpers.test.d.ts +1 -0
- package/lib/tests/materialized-reports/analytics-overview-helpers.test.d.ts +1 -0
- package/lib/tests/materialized-reports/analytics-performance-helpers.test.d.ts +1 -0
- package/lib/tests/materialized-reports/fixtures.d.ts +15 -1
- package/lib/tests/materialized-reports/fixtures.js +1 -0
- package/lib/tests/materialized-reports/materialized-cash-compile.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-cash-compile.test.js +196 -0
- package/lib/tests/materialized-reports/materialized-cash-fold.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-cash-fold.test.js +116 -0
- package/lib/tests/materialized-reports/materialized-cash-formatter.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-cash-formatter.test.js +152 -0
- package/lib/tests/materialized-reports/materialized-cash-plan.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-cash-plan.test.js +168 -0
- package/lib/tests/materialized-reports/materialized-cash-reconciliation.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-cash-reconciliation.test.js +267 -0
- package/lib/tests/materialized-reports/materialized-delivery-accumulation.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-delivery-accumulation.test.js +147 -0
- package/lib/tests/materialized-reports/materialized-delivery-compile.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-delivery-compile.test.js +241 -0
- package/lib/tests/materialized-reports/materialized-delivery-fold.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-delivery-fold.test.js +109 -0
- package/lib/tests/materialized-reports/materialized-delivery-formatter.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-delivery-formatter.test.js +141 -0
- package/lib/tests/materialized-reports/materialized-delivery-plan.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-delivery-plan.test.js +198 -0
- package/lib/tests/materialized-reports/materialized-discount-aggregated-formatter.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-discount-aggregated-formatter.test.js +173 -0
- package/lib/tests/materialized-reports/materialized-discount-classification.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-discount-classification.test.js +339 -0
- package/lib/tests/materialized-reports/materialized-discount-close-day.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-discount-close-day.test.js +506 -0
- package/lib/tests/materialized-reports/materialized-discount-compile.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-discount-compile.test.js +161 -0
- package/lib/tests/materialized-reports/materialized-discount-counter-rows.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-discount-counter-rows.test.js +107 -0
- package/lib/tests/materialized-reports/materialized-discount-entries-accumulation.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-discount-entries-accumulation.test.js +125 -0
- package/lib/tests/materialized-reports/materialized-hourly-comparison-compile.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-hourly-comparison-compile.test.js +146 -0
- package/lib/tests/materialized-reports/materialized-hourly-comparison-formatter.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-hourly-comparison-formatter.test.js +127 -0
- package/lib/tests/materialized-reports/materialized-hourly-comparison-plan.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-hourly-comparison-plan.test.js +138 -0
- package/lib/tests/materialized-reports/materialized-hourly-comparison-selection.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-hourly-comparison-selection.test.js +90 -0
- package/lib/tests/materialized-reports/materialized-payments-comparison-compile.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-payments-comparison-compile.test.js +164 -0
- package/lib/tests/materialized-reports/materialized-payments-comparison-formatter.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-payments-comparison-formatter.test.js +117 -0
- package/lib/tests/materialized-reports/materialized-payments-comparison-plan.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-payments-comparison-plan.test.js +149 -0
- package/lib/tests/materialized-reports/materialized-prep-time-classification.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-prep-time-classification.test.js +273 -0
- package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.js +270 -0
- package/lib/tests/materialized-reports/materialized-prep-time-compile.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-prep-time-compile.test.js +217 -0
- package/lib/tests/materialized-reports/materialized-prep-time-constants.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-prep-time-constants.test.js +84 -0
- package/lib/tests/materialized-reports/materialized-prep-time-plan.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-prep-time-plan.test.js +176 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-baseline.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-baseline.test.js +126 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.js +206 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-formatter.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-formatter.test.js +179 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-parity.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-parity.test.js +196 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-plan.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-sales-comparison-plan.test.js +241 -0
- package/lib/tests/materialized-reports/materialized-tenant-hourly-comparison-schema.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-tenant-hourly-comparison-schema.test.js +96 -0
- package/lib/tests/materialized-reports/materialized-tenant-payments-comparison-schema.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-tenant-payments-comparison-schema.test.js +112 -0
- package/lib/tests/materialized-reports/materialized-tenant-sales-comparison-schema.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-tenant-sales-comparison-schema.test.js +142 -0
- package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.js +8 -1
- package/lib/tests/materialized-reports/sales-comparison-reference.d.ts +55 -0
- package/lib/tests/materialized-reports/sales-comparison-reference.js +86 -0
- package/lib/tests/materialized-reports/tenant-discount-formatter.test.d.ts +1 -0
- package/lib/tests/materialized-reports/tenant-discount-formatter.test.js +289 -0
- package/lib/tests/materialized-reports/tenant-prep-time-formatter.test.d.ts +1 -0
- package/lib/tests/materialized-reports/tenant-prep-time-formatter.test.js +354 -0
- package/lib/tests/reporting-contract.test.d.ts +1 -0
- package/lib/tests/reporting-contract.test.js +267 -0
- package/lib/tests/rider-daily-report.test.d.ts +1 -0
- package/lib/tests/rider-daily-report.test.js +86 -0
- package/lib/tests/rider-earnings.test.d.ts +1 -0
- package/lib/tests/rider-earnings.test.js +65 -0
- package/lib/tests/rider-report.test.d.ts +1 -0
- package/lib/tests/rider-report.test.js +98 -0
- package/package.json +10 -1
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const materialized_sales_comparison_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-sales-comparison-compile-helpers");
|
|
4
|
+
const materialized_sales_comparison_accumulator_helpers_1 = require("../../helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers");
|
|
5
|
+
/**
|
|
6
|
+
* Sales Comparison — the day compile.
|
|
7
|
+
*
|
|
8
|
+
* Two invariants define this report and are pinned here:
|
|
9
|
+
*
|
|
10
|
+
* 1. **The anchor is the SETTLED day.** An order punched on one day and
|
|
11
|
+
* collected on a later one belongs to the COLLECTION day. Using
|
|
12
|
+
* `order.localDate` (the punch day) would silently move deferred bills.
|
|
13
|
+
* 2. **Counters and rows come from one pass**, so the map, the read-path rows
|
|
14
|
+
* and the drill-down can never disagree.
|
|
15
|
+
*/
|
|
16
|
+
const TENANT = 'tenant-1';
|
|
17
|
+
const BRAND = 'brand-1';
|
|
18
|
+
const DAY = '2026-09-14';
|
|
19
|
+
const OFFSET = 5;
|
|
20
|
+
const order = (id, over = {}) => ({
|
|
21
|
+
_id: id,
|
|
22
|
+
tenant_id: TENANT,
|
|
23
|
+
platform: 'POS_DINE-IN',
|
|
24
|
+
order_status: 'COMPLETED',
|
|
25
|
+
order_number: 100,
|
|
26
|
+
price: 10000,
|
|
27
|
+
total_discount_applied: 0,
|
|
28
|
+
gst_amount: 0,
|
|
29
|
+
tax_amount: 0,
|
|
30
|
+
tip_amount: 0,
|
|
31
|
+
amount_earned: 10000,
|
|
32
|
+
amount_collected: 10000,
|
|
33
|
+
order_settled_at: new Date('2026-09-14T12:00:00.000Z'),
|
|
34
|
+
createdAt: new Date('2026-09-14T11:00:00.000Z'),
|
|
35
|
+
updatedAt: new Date('2026-09-14T12:00:00.000Z'),
|
|
36
|
+
localDate: DAY,
|
|
37
|
+
categories: [
|
|
38
|
+
{
|
|
39
|
+
name: 'Mains',
|
|
40
|
+
category_id: 'cat-1',
|
|
41
|
+
items: [{ _id: 'i1', item_id: 'm1', quantity: 1, subtotal: 10000, _gross_amount: 10000, _net_amount: 10000 }],
|
|
42
|
+
},
|
|
43
|
+
],
|
|
44
|
+
payments: [],
|
|
45
|
+
...over,
|
|
46
|
+
});
|
|
47
|
+
const compile = (over = {}) => (0, materialized_sales_comparison_compile_helpers_1.compileTenantSalesComparisonReports)({
|
|
48
|
+
tenantId: TENANT,
|
|
49
|
+
brandId: BRAND,
|
|
50
|
+
localDate: DAY,
|
|
51
|
+
orders: [],
|
|
52
|
+
gmtOffset: OFFSET,
|
|
53
|
+
computedAt: new Date('2026-09-14T23:00:00.000Z'),
|
|
54
|
+
...over,
|
|
55
|
+
});
|
|
56
|
+
describe('sales comparison day compile', () => {
|
|
57
|
+
it('maps every counter from its authoritative order field', () => {
|
|
58
|
+
const compiled = compile({
|
|
59
|
+
orders: [
|
|
60
|
+
order('a', {
|
|
61
|
+
price: 10000,
|
|
62
|
+
total_discount_applied: 1000,
|
|
63
|
+
gst_amount: 450,
|
|
64
|
+
tax_amount: 25,
|
|
65
|
+
service_fee_amount: 200,
|
|
66
|
+
surcharge_amount: 50,
|
|
67
|
+
tip_amount: 300,
|
|
68
|
+
payments: [{ payment_type: 'CARD', payment_status: 'SETTLED', amount_refunded: 100 }],
|
|
69
|
+
dinein_details: { num_of_guests: 4 },
|
|
70
|
+
categories: [
|
|
71
|
+
{
|
|
72
|
+
category_id: 'c1',
|
|
73
|
+
items: [
|
|
74
|
+
{ _id: 'i1', item_id: 'm1', quantity: 2, subtotal: 6000, _gross_amount: 6000 },
|
|
75
|
+
{ _id: 'i2', item_id: 'm2', quantity: 1, subtotal: 4000, _gross_amount: 4000 },
|
|
76
|
+
],
|
|
77
|
+
},
|
|
78
|
+
],
|
|
79
|
+
}),
|
|
80
|
+
],
|
|
81
|
+
});
|
|
82
|
+
const counters = compiled.reports[0].sales_counters['COMPLETED:POS_DINE-IN'];
|
|
83
|
+
expect(counters).toEqual({
|
|
84
|
+
order_count: 1,
|
|
85
|
+
gross_amount: 10000,
|
|
86
|
+
discount_amount: 1000,
|
|
87
|
+
net_amount: 9000,
|
|
88
|
+
tax_amount: 475,
|
|
89
|
+
service_charge_amount: 250,
|
|
90
|
+
tip_amount: 300,
|
|
91
|
+
refund_amount: 100,
|
|
92
|
+
void_amount: 0,
|
|
93
|
+
item_count: 3,
|
|
94
|
+
guest_count: 4,
|
|
95
|
+
});
|
|
96
|
+
});
|
|
97
|
+
it('falls back to order_discount_details.total_discount when total_discount_applied is absent', () => {
|
|
98
|
+
const compiled = compile({
|
|
99
|
+
orders: [
|
|
100
|
+
order('a', {
|
|
101
|
+
total_discount_applied: undefined,
|
|
102
|
+
order_discount_details: { total_discount: 750, special_discount: 750 },
|
|
103
|
+
}),
|
|
104
|
+
],
|
|
105
|
+
});
|
|
106
|
+
expect(compiled.reports[0].sales_counters['COMPLETED:POS_DINE-IN'].discount_amount).toBe(750);
|
|
107
|
+
expect(compiled.reports[0].sales_counters['COMPLETED:POS_DINE-IN'].net_amount).toBe(9250);
|
|
108
|
+
});
|
|
109
|
+
it('keeps a real 0 discount (does not fall through to the details object)', () => {
|
|
110
|
+
const compiled = compile({
|
|
111
|
+
orders: [
|
|
112
|
+
order('a', {
|
|
113
|
+
total_discount_applied: 0,
|
|
114
|
+
order_discount_details: { total_discount: 999, special_discount: 999 },
|
|
115
|
+
}),
|
|
116
|
+
],
|
|
117
|
+
});
|
|
118
|
+
expect(compiled.reports[0].sales_counters['COMPLETED:POS_DINE-IN'].discount_amount).toBe(0);
|
|
119
|
+
});
|
|
120
|
+
it('values a CANCELLED order as void and keys it CANCELLED:*', () => {
|
|
121
|
+
const compiled = compile({
|
|
122
|
+
orders: [order('c', { order_status: 'CANCELLED', platform: 'POS_TAKE-AWAY', amount_earned: 500 })],
|
|
123
|
+
});
|
|
124
|
+
const counters = compiled.reports[0].sales_counters['CANCELLED:POS_TAKE-AWAY'];
|
|
125
|
+
expect(counters.void_amount).toBe(500);
|
|
126
|
+
expect(counters.order_count).toBe(1);
|
|
127
|
+
});
|
|
128
|
+
it('anchors on the SETTLED day, never the punch day', () => {
|
|
129
|
+
// Punched 2026-09-01, settled 2026-09-14 20:00 UTC = 2026-09-15 01:00 +05.
|
|
130
|
+
const settled = order('later', {
|
|
131
|
+
localDate: '2026-09-01',
|
|
132
|
+
order_settled_at: new Date('2026-09-14T20:00:00.000Z'),
|
|
133
|
+
});
|
|
134
|
+
const onPunchDay = compile({ localDate: '2026-09-01', orders: [settled] });
|
|
135
|
+
expect(onPunchDay.reports).toHaveLength(0);
|
|
136
|
+
expect(onPunchDay.skippedForeignOrders).toBe(1);
|
|
137
|
+
const onSettledDay = compile({ localDate: '2026-09-15', orders: [settled] });
|
|
138
|
+
expect(onSettledDay.reports[0].scope_field).toBe('2026-09-15');
|
|
139
|
+
expect(onSettledDay.reports[0].day_index).toBe('TUE');
|
|
140
|
+
});
|
|
141
|
+
it('resolves the tenant-local settled date with the tenant offset', () => {
|
|
142
|
+
expect((0, materialized_sales_comparison_accumulator_helpers_1.getSalesComparisonSettledLocalDate)({ order_settled_at: new Date('2026-09-14T20:00:00.000Z') }, OFFSET)).toBe('2026-09-15');
|
|
143
|
+
expect((0, materialized_sales_comparison_accumulator_helpers_1.getSalesComparisonSettledLocalDate)({ order_settled_at: new Date('2026-09-14T20:00:00.000Z') }, 0)).toBe('2026-09-14');
|
|
144
|
+
expect((0, materialized_sales_comparison_accumulator_helpers_1.getSalesComparisonSettledLocalDate)({}, OFFSET)).toBeNull();
|
|
145
|
+
});
|
|
146
|
+
it('skips unsettled, deleted, foreign-tenant and unkeyable orders', () => {
|
|
147
|
+
const compiled = compile({
|
|
148
|
+
orders: [
|
|
149
|
+
order('a'),
|
|
150
|
+
order('deleted', { is_deleted: true }),
|
|
151
|
+
order('foreign', { tenant_id: 'someone-else' }),
|
|
152
|
+
order('unsettled', { order_settled_at: null }),
|
|
153
|
+
order('bad-status', { order_status: null }),
|
|
154
|
+
],
|
|
155
|
+
});
|
|
156
|
+
expect(compiled.contributingOrders).toBe(1);
|
|
157
|
+
expect(compiled.skippedUnsettledOrders).toBe(1);
|
|
158
|
+
expect(compiled.skippedUnkeyableOrders).toBe(1);
|
|
159
|
+
expect(compiled.reports[0].sales_counters['COMPLETED:POS_DINE-IN'].order_count).toBe(1);
|
|
160
|
+
});
|
|
161
|
+
it('writes the counters TWICE with identical content', () => {
|
|
162
|
+
const compiled = compile({ orders: [order('a'), order('b', { order_status: 'COMPLETED' })] });
|
|
163
|
+
const map = compiled.reports[0].sales_counters;
|
|
164
|
+
const rows = compiled.reports[0].sales_counter_rows;
|
|
165
|
+
expect(rows.map((row) => row.key)).toEqual(Object.keys(map));
|
|
166
|
+
for (const row of rows)
|
|
167
|
+
expect(row.counters).toEqual(map[row.key]);
|
|
168
|
+
});
|
|
169
|
+
it('writes one drill-down row per order, newest-first', () => {
|
|
170
|
+
const compiled = compile({
|
|
171
|
+
orders: [
|
|
172
|
+
order('older', {
|
|
173
|
+
order_number: 1,
|
|
174
|
+
order_settled_at: new Date('2026-09-14T08:00:00.000Z'),
|
|
175
|
+
updatedAt: new Date('2026-09-14T08:00:00.000Z'),
|
|
176
|
+
}),
|
|
177
|
+
order('newer', {
|
|
178
|
+
order_number: 2,
|
|
179
|
+
order_settled_at: new Date('2026-09-14T10:00:00.000Z'),
|
|
180
|
+
updatedAt: new Date('2026-09-14T10:00:00.000Z'),
|
|
181
|
+
price: 4000,
|
|
182
|
+
total_discount_applied: 400,
|
|
183
|
+
}),
|
|
184
|
+
],
|
|
185
|
+
});
|
|
186
|
+
const rows = compiled.entries[0].sales_entries['COMPLETED:POS_DINE-IN'].rows;
|
|
187
|
+
expect(rows.map((row) => row.order_id)).toEqual(['newer', 'older']);
|
|
188
|
+
expect(rows[0].net_amount).toBe(3600);
|
|
189
|
+
expect(rows[0].discount_amount).toBe(400);
|
|
190
|
+
expect(rows[0].order_number).toBe(2);
|
|
191
|
+
expect(compiled.entries[0].source_watermark.getTime()).toBe(new Date('2026-09-14T10:00:00.000Z').getTime());
|
|
192
|
+
});
|
|
193
|
+
it('returns EMPTY arrays for an order-less day (the plan retires the stored doc)', () => {
|
|
194
|
+
const compiled = compile();
|
|
195
|
+
expect(compiled.reports).toEqual([]);
|
|
196
|
+
expect(compiled.entries).toEqual([]);
|
|
197
|
+
expect(compiled.contributingOrders).toBe(0);
|
|
198
|
+
});
|
|
199
|
+
it('returns null on malformed input', () => {
|
|
200
|
+
expect((0, materialized_sales_comparison_compile_helpers_1.compileTenantSalesComparisonReports)(null)).toBeNull();
|
|
201
|
+
expect(compile({ tenantId: '' })).toBeNull();
|
|
202
|
+
expect(compile({ brandId: '' })).toBeNull();
|
|
203
|
+
expect(compile({ localDate: 'not-a-date' })).toBeNull();
|
|
204
|
+
expect(compile({ orders: null })).toBeNull();
|
|
205
|
+
});
|
|
206
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const tenant_sales_comparison_formatter_1 = require("../../helpers/materialized-reports/tenant-sales-comparison-formatter");
|
|
4
|
+
const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
|
|
5
|
+
/**
|
|
6
|
+
* Sales Comparison formatter.
|
|
7
|
+
*
|
|
8
|
+
* The report's contract in one line: `current` and `comparison` are ordinary
|
|
9
|
+
* reads subtracted HERE, and every selectable metric is already present so
|
|
10
|
+
* switching it cannot trigger a refetch.
|
|
11
|
+
*/
|
|
12
|
+
const TENANT = 'tenant-1';
|
|
13
|
+
const counters = (over = {}) => ({
|
|
14
|
+
order_count: 0,
|
|
15
|
+
gross_amount: 0,
|
|
16
|
+
discount_amount: 0,
|
|
17
|
+
net_amount: 0,
|
|
18
|
+
tax_amount: 0,
|
|
19
|
+
service_charge_amount: 0,
|
|
20
|
+
tip_amount: 0,
|
|
21
|
+
refund_amount: 0,
|
|
22
|
+
void_amount: 0,
|
|
23
|
+
item_count: 0,
|
|
24
|
+
guest_count: 0,
|
|
25
|
+
...over,
|
|
26
|
+
});
|
|
27
|
+
const record = (sales_counters, tenantId = TENANT) => ({
|
|
28
|
+
tenant_id: tenantId,
|
|
29
|
+
brand_id: 'brand-1',
|
|
30
|
+
max_iteration: 1,
|
|
31
|
+
max_updated_at: null,
|
|
32
|
+
matched_documents: 1,
|
|
33
|
+
sale_type_key_filters: ['ORDER_STATUS', 'PLATFORM'],
|
|
34
|
+
sales_counters,
|
|
35
|
+
sales_counter_rows: [],
|
|
36
|
+
first_scope_field: null,
|
|
37
|
+
last_scope_field: null,
|
|
38
|
+
});
|
|
39
|
+
const current = record({
|
|
40
|
+
'COMPLETED:POS_DINE-IN': counters({
|
|
41
|
+
order_count: 2,
|
|
42
|
+
gross_amount: 10000,
|
|
43
|
+
discount_amount: 1000,
|
|
44
|
+
net_amount: 9000,
|
|
45
|
+
tax_amount: 500,
|
|
46
|
+
tip_amount: 200,
|
|
47
|
+
item_count: 5,
|
|
48
|
+
guest_count: 4,
|
|
49
|
+
}),
|
|
50
|
+
'COMPLETED:POS_TAKE-AWAY': counters({
|
|
51
|
+
order_count: 1,
|
|
52
|
+
gross_amount: 3000,
|
|
53
|
+
net_amount: 3000,
|
|
54
|
+
tax_amount: 150,
|
|
55
|
+
item_count: 2,
|
|
56
|
+
}),
|
|
57
|
+
'CANCELLED:POS_TAKE-AWAY': counters({
|
|
58
|
+
order_count: 1,
|
|
59
|
+
gross_amount: 1000,
|
|
60
|
+
net_amount: 1000,
|
|
61
|
+
void_amount: 1000,
|
|
62
|
+
}),
|
|
63
|
+
});
|
|
64
|
+
const comparison = record({
|
|
65
|
+
'COMPLETED:POS_DINE-IN': counters({
|
|
66
|
+
order_count: 1,
|
|
67
|
+
gross_amount: 5000,
|
|
68
|
+
discount_amount: 500,
|
|
69
|
+
net_amount: 4500,
|
|
70
|
+
tax_amount: 250,
|
|
71
|
+
item_count: 2,
|
|
72
|
+
}),
|
|
73
|
+
'COMPLETED:POS_TAKE-AWAY': counters({
|
|
74
|
+
order_count: 2,
|
|
75
|
+
gross_amount: 6000,
|
|
76
|
+
net_amount: 6000,
|
|
77
|
+
tax_amount: 300,
|
|
78
|
+
item_count: 4,
|
|
79
|
+
}),
|
|
80
|
+
});
|
|
81
|
+
const format = (filters = null, split = false) => (0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)([current], [comparison], filters, split);
|
|
82
|
+
describe('sales comparison formatter', () => {
|
|
83
|
+
it('subtracts the two series and derives the average ticket', () => {
|
|
84
|
+
const page = format()[0][0];
|
|
85
|
+
expect(page.current.counters.net_amount).toBe(120);
|
|
86
|
+
expect(page.comparison.counters.net_amount).toBe(105);
|
|
87
|
+
expect(page.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.NET_SALES]).toEqual({
|
|
88
|
+
current: 120,
|
|
89
|
+
comparison: 105,
|
|
90
|
+
delta: 15,
|
|
91
|
+
delta_percent: (15 / 105) * 100,
|
|
92
|
+
});
|
|
93
|
+
// 12000 cents / 3 orders = 4000 cents = 40.00
|
|
94
|
+
expect(page.current.average_ticket).toBe(40);
|
|
95
|
+
expect(page.comparison.average_ticket).toBe(35);
|
|
96
|
+
expect(page.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.AVERAGE_TICKET].delta).toBe(5);
|
|
97
|
+
});
|
|
98
|
+
it('exposes every selectable metric from the SAME documents', () => {
|
|
99
|
+
const page = format()[0][0];
|
|
100
|
+
expect(page.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.GROSS_SALES].current).toBe(130);
|
|
101
|
+
expect(page.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.DISCOUNTS].current).toBe(10);
|
|
102
|
+
expect(page.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.ORDER_COUNT].current).toBe(3);
|
|
103
|
+
expect(page.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.ITEMS_SOLD].current).toBe(7);
|
|
104
|
+
// The metrics are all present at once, so the page's Select Field can
|
|
105
|
+
// switch without another request.
|
|
106
|
+
expect(Object.keys(page.metrics).sort()).toEqual(['AVERAGE_TICKET', 'DISCOUNTS', 'GROSS_SALES', 'ITEMS_SOLD', 'NET_SALES', 'ORDER_COUNT'].sort());
|
|
107
|
+
});
|
|
108
|
+
it('splits cancelled orders out of every sales total', () => {
|
|
109
|
+
const page = format()[0][0];
|
|
110
|
+
expect(page.current.counters.order_count).toBe(3); // the cancelled order is NOT in the 3
|
|
111
|
+
expect(page.current.counters.void_amount).toBe(0);
|
|
112
|
+
expect(page.cancelled.counters.order_count).toBe(1);
|
|
113
|
+
expect(page.cancelled.counters.void_amount).toBe(10);
|
|
114
|
+
expect(page.rows.find((row) => row.order_status === 'CANCELLED')).toBeDefined();
|
|
115
|
+
// the platform breakdown reconciles with the total: the cancelled row is not folded in
|
|
116
|
+
const takeAway = page.by_platform.find((row) => row.platform === 'POS_TAKE-AWAY');
|
|
117
|
+
expect(takeAway.current.counters.order_count).toBe(1);
|
|
118
|
+
expect(takeAway.current.counters.net_amount).toBe(30);
|
|
119
|
+
});
|
|
120
|
+
it('filters platforms and statuses client-side', () => {
|
|
121
|
+
const page = format({ platforms: ['POS_DINE-IN'] })[0][0];
|
|
122
|
+
expect(page.current.counters.order_count).toBe(2);
|
|
123
|
+
expect(page.current.counters.net_amount).toBe(90);
|
|
124
|
+
expect(page.comparison.counters.net_amount).toBe(45);
|
|
125
|
+
expect(page.rows.every((row) => row.platform === 'POS_DINE-IN')).toBe(true);
|
|
126
|
+
const cancelledOnly = format({ order_statuses: ['CANCELLED'] })[0][0];
|
|
127
|
+
// An explicit CANCELLED selection opts cancelled revenue into the totals.
|
|
128
|
+
expect(cancelledOnly.current.counters.order_count).toBe(1);
|
|
129
|
+
expect(cancelledOnly.current.counters.void_amount).toBe(10);
|
|
130
|
+
});
|
|
131
|
+
it('builds a per-platform breakdown from the same rows', () => {
|
|
132
|
+
const page = format()[0][0];
|
|
133
|
+
const dineIn = page.by_platform.find((row) => row.platform === 'POS_DINE-IN');
|
|
134
|
+
expect(dineIn.current.counters.net_amount).toBe(90);
|
|
135
|
+
expect(dineIn.comparison.counters.net_amount).toBe(45);
|
|
136
|
+
});
|
|
137
|
+
it('distinguishes "no baseline" (null) from "baseline with no sales" ([])', () => {
|
|
138
|
+
const none = (0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)([current], null, null, false)[0][0];
|
|
139
|
+
expect(none.comparison).toBeNull();
|
|
140
|
+
expect(none.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.NET_SALES].comparison).toBeNull();
|
|
141
|
+
const empty = (0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)([current], [], null, false)[0][0];
|
|
142
|
+
expect(empty.comparison).not.toBeNull();
|
|
143
|
+
expect(empty.comparison.counters.net_amount).toBe(0);
|
|
144
|
+
expect(empty.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.NET_SALES].current).toBe(120);
|
|
145
|
+
expect(empty.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.NET_SALES].delta).toBe(120);
|
|
146
|
+
// a percentage against zero is undefined, never Infinity
|
|
147
|
+
expect(empty.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.NET_SALES].delta_percent).toBeNull();
|
|
148
|
+
});
|
|
149
|
+
it('folds multiple tenants into one page, or splits on request', () => {
|
|
150
|
+
const other = record({
|
|
151
|
+
'COMPLETED:POS_WALK-IN': counters({ order_count: 1, gross_amount: 2000, net_amount: 2000 }),
|
|
152
|
+
}, 'tenant-2');
|
|
153
|
+
const combined = (0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)([current, other], null, null, false)[0];
|
|
154
|
+
expect(combined).toHaveLength(1);
|
|
155
|
+
expect(combined[0].tenant_ids).toEqual(['tenant-1', 'tenant-2']);
|
|
156
|
+
expect(combined[0].current.counters.net_amount).toBe(140);
|
|
157
|
+
const split = (0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)([current, other], null, null, true)[0];
|
|
158
|
+
expect(split).toHaveLength(2);
|
|
159
|
+
expect(split.map((page) => page.tenant_ids[0])).toEqual(['tenant-1', 'tenant-2']);
|
|
160
|
+
});
|
|
161
|
+
it('handles a comparison-only key (current zero)', () => {
|
|
162
|
+
const withDisappeared = record({
|
|
163
|
+
'COMPLETED:POS_KIOSK': counters({ order_count: 1, net_amount: 2500 }),
|
|
164
|
+
});
|
|
165
|
+
const page = (0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)([current], [withDisappeared], null, false)[0][0];
|
|
166
|
+
const row = page.rows.find((entry) => entry.key === 'COMPLETED:POS_KIOSK');
|
|
167
|
+
expect(row.current.counters.order_count).toBe(0);
|
|
168
|
+
expect(row.comparison.counters.net_amount).toBe(25);
|
|
169
|
+
expect(row.metrics[MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.NET_SALES].delta).toBe(-25);
|
|
170
|
+
});
|
|
171
|
+
it('returns null on invalid input', () => {
|
|
172
|
+
expect((0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)([], null)).toBeNull();
|
|
173
|
+
expect((0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)(null, null)).toBeNull();
|
|
174
|
+
expect((0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)([record({ 'COMPLETED:POS': counters({ net_amount: 100 }) })], null, { platforms: 'POS' })).toBeNull();
|
|
175
|
+
const noCounters = record({});
|
|
176
|
+
noCounters.sales_counters = null;
|
|
177
|
+
expect((0, tenant_sales_comparison_formatter_1.getFormattedTenantSalesComparisonReporting)([noCounters], null, null, false)).toBeNull();
|
|
178
|
+
});
|
|
179
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const fixtures_1 = require("./fixtures");
|
|
4
|
+
const sales_comparison_reference_1 = require("./sales-comparison-reference");
|
|
5
|
+
const materialized_sales_comparison_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-sales-comparison-compile-helpers");
|
|
6
|
+
const materialized_sales_comparison_close_day_helpers_1 = require("../../helpers/materialized-reports/materialized-sales-comparison-close-day-helpers");
|
|
7
|
+
const key_helpers_1 = require("../../helpers/materialized-reports/key-helpers");
|
|
8
|
+
/**
|
|
9
|
+
* PARITY: materialized Sales Comparison vs the legacy
|
|
10
|
+
* `/analytics/sales-comparison` reference over a full fixture month.
|
|
11
|
+
*
|
|
12
|
+
* The legacy endpoint is pinned to SETTLED (the documented trap). Every
|
|
13
|
+
* counter is compared leaf by leaf:
|
|
14
|
+
*
|
|
15
|
+
* | materialized | legacy leaf |
|
|
16
|
+
* | --- | --- |
|
|
17
|
+
* | order_count | total_orders |
|
|
18
|
+
* | gross_amount | price |
|
|
19
|
+
* | discount_amount | total_discount_amount |
|
|
20
|
+
* | net_amount | price − total_discount_amount (derived) |
|
|
21
|
+
* | tax_amount | tax_amount + gst_amount (one counter, both tax buckets) |
|
|
22
|
+
* | service_charge_amount | service_fee_amount + surcharge_amount |
|
|
23
|
+
* | tip_amount | tip_amount |
|
|
24
|
+
* | guest_count | num_of_guests |
|
|
25
|
+
* | void_amount | cancelled_orders_amount |
|
|
26
|
+
* | item_count / refund_amount | derived from the same orders (no legacy leaf) |
|
|
27
|
+
*
|
|
28
|
+
* This is the M1/M2 parity pattern: a pure reference computed from raw orders,
|
|
29
|
+
* independent of the materialization helpers.
|
|
30
|
+
*/
|
|
31
|
+
const MONTH = '2026-09';
|
|
32
|
+
const FROM = '2026-09-01';
|
|
33
|
+
const TO = '2026-09-30';
|
|
34
|
+
const TOLERANCE = 1e-6;
|
|
35
|
+
const addCounters = (target, source) => {
|
|
36
|
+
target.order_count += source.order_count;
|
|
37
|
+
target.gross_amount += source.gross_amount;
|
|
38
|
+
target.discount_amount += source.discount_amount;
|
|
39
|
+
target.net_amount += source.net_amount;
|
|
40
|
+
target.tax_amount += source.tax_amount;
|
|
41
|
+
target.service_charge_amount += source.service_charge_amount;
|
|
42
|
+
target.tip_amount += source.tip_amount;
|
|
43
|
+
target.refund_amount += source.refund_amount;
|
|
44
|
+
target.void_amount += source.void_amount;
|
|
45
|
+
target.item_count += source.item_count;
|
|
46
|
+
target.guest_count += source.guest_count;
|
|
47
|
+
};
|
|
48
|
+
const emptyCounters = () => ({
|
|
49
|
+
order_count: 0,
|
|
50
|
+
gross_amount: 0,
|
|
51
|
+
discount_amount: 0,
|
|
52
|
+
net_amount: 0,
|
|
53
|
+
tax_amount: 0,
|
|
54
|
+
service_charge_amount: 0,
|
|
55
|
+
tip_amount: 0,
|
|
56
|
+
refund_amount: 0,
|
|
57
|
+
void_amount: 0,
|
|
58
|
+
item_count: 0,
|
|
59
|
+
guest_count: 0,
|
|
60
|
+
});
|
|
61
|
+
const expectClose = (actual, expected, label) => {
|
|
62
|
+
expect(`${label}: ${Math.abs(actual - expected) <= TOLERANCE}`).toBe(`${label}: true`);
|
|
63
|
+
};
|
|
64
|
+
describe.each(fixtures_1.ALL_ORDERS_DATASET_NAMES)('sales comparison parity: %s', (datasetName) => {
|
|
65
|
+
const info = fixtures_1.ORDERS_DATASETS[datasetName];
|
|
66
|
+
const orders = (0, fixtures_1.loadOrdersDataset)(datasetName);
|
|
67
|
+
const settledDayOf = (order) => (0, sales_comparison_reference_1.salesComparisonReferenceLocalDate)(order, info.gmtOffset);
|
|
68
|
+
it('compiles every settled order in the month exactly once', () => {
|
|
69
|
+
const days = new Set();
|
|
70
|
+
for (const order of orders) {
|
|
71
|
+
const day = settledDayOf(order);
|
|
72
|
+
if (day != null && day >= FROM && day <= TO)
|
|
73
|
+
days.add(day);
|
|
74
|
+
}
|
|
75
|
+
let compiledOrders = 0;
|
|
76
|
+
for (const day of [...days].sort()) {
|
|
77
|
+
const dayOrders = orders.filter((order) => settledDayOf(order) === day);
|
|
78
|
+
const compiled = (0, materialized_sales_comparison_compile_helpers_1.compileTenantSalesComparisonReports)({
|
|
79
|
+
tenantId: info.tenantId,
|
|
80
|
+
brandId: 'brand',
|
|
81
|
+
localDate: day,
|
|
82
|
+
orders: dayOrders,
|
|
83
|
+
gmtOffset: info.gmtOffset,
|
|
84
|
+
computedAt: new Date(`${day}T23:00:00.000Z`),
|
|
85
|
+
});
|
|
86
|
+
compiledOrders += compiled.contributingOrders;
|
|
87
|
+
}
|
|
88
|
+
const reference = (0, sales_comparison_reference_1.buildSalesComparisonReferenceTotals)({
|
|
89
|
+
orders: orders,
|
|
90
|
+
gmtOffset: info.gmtOffset,
|
|
91
|
+
fromDay: FROM,
|
|
92
|
+
toDay: TO,
|
|
93
|
+
});
|
|
94
|
+
expect(compiledOrders).toBe(reference.total_orders + reference.total_cancelled_orders);
|
|
95
|
+
});
|
|
96
|
+
it('folds quarter, semester and year identically (the scope correction)', () => {
|
|
97
|
+
const dayDocuments = [];
|
|
98
|
+
const days = new Set();
|
|
99
|
+
for (const order of orders) {
|
|
100
|
+
const day = settledDayOf(order);
|
|
101
|
+
if (day != null && day >= FROM && day <= TO)
|
|
102
|
+
days.add(day);
|
|
103
|
+
}
|
|
104
|
+
for (const day of [...days].sort()) {
|
|
105
|
+
const dayOrders = orders.filter((order) => settledDayOf(order) === day);
|
|
106
|
+
const compiled = (0, materialized_sales_comparison_compile_helpers_1.compileTenantSalesComparisonReports)({
|
|
107
|
+
tenantId: info.tenantId,
|
|
108
|
+
brandId: 'brand',
|
|
109
|
+
localDate: day,
|
|
110
|
+
orders: dayOrders,
|
|
111
|
+
gmtOffset: info.gmtOffset,
|
|
112
|
+
computedAt: new Date(`${day}T23:00:00.000Z`),
|
|
113
|
+
});
|
|
114
|
+
dayDocuments.push(...compiled.reports);
|
|
115
|
+
}
|
|
116
|
+
const month = (0, materialized_sales_comparison_close_day_helpers_1.foldMaterializedSalesComparisonPeriodCounters)({
|
|
117
|
+
periodScope: 'localMonth',
|
|
118
|
+
periodScopeField: MONTH,
|
|
119
|
+
dayDocuments,
|
|
120
|
+
});
|
|
121
|
+
const monthTotal = Object.values(month).reduce((sum, counters) => sum + counters.order_count, 0);
|
|
122
|
+
for (const [scope, field] of [
|
|
123
|
+
['localQuarter', '2026-Q3'],
|
|
124
|
+
['localSemester', '2026-S2'],
|
|
125
|
+
['localYear', '2026'],
|
|
126
|
+
]) {
|
|
127
|
+
const folded = (0, materialized_sales_comparison_close_day_helpers_1.foldMaterializedSalesComparisonPeriodCounters)({
|
|
128
|
+
periodScope: scope,
|
|
129
|
+
periodScopeField: field,
|
|
130
|
+
dayDocuments,
|
|
131
|
+
});
|
|
132
|
+
const total = Object.values(folded).reduce((sum, counters) => sum + counters.order_count, 0);
|
|
133
|
+
// The fixture covers only September, so each wider period equals it.
|
|
134
|
+
expect(`${scope}:${total}`).toBe(`${scope}:${monthTotal}`);
|
|
135
|
+
}
|
|
136
|
+
});
|
|
137
|
+
it('matches the legacy reference leaf by leaf for the month', () => {
|
|
138
|
+
const reference = (0, sales_comparison_reference_1.buildSalesComparisonReferenceTotals)({
|
|
139
|
+
orders: orders,
|
|
140
|
+
gmtOffset: info.gmtOffset,
|
|
141
|
+
fromDay: FROM,
|
|
142
|
+
toDay: TO,
|
|
143
|
+
});
|
|
144
|
+
const dayDocuments = [];
|
|
145
|
+
const days = new Set();
|
|
146
|
+
for (const order of orders) {
|
|
147
|
+
const day = settledDayOf(order);
|
|
148
|
+
if (day != null && day >= FROM && day <= TO)
|
|
149
|
+
days.add(day);
|
|
150
|
+
}
|
|
151
|
+
for (const day of [...days].sort()) {
|
|
152
|
+
const dayOrders = orders.filter((order) => settledDayOf(order) === day);
|
|
153
|
+
const compiled = (0, materialized_sales_comparison_compile_helpers_1.compileTenantSalesComparisonReports)({
|
|
154
|
+
tenantId: info.tenantId,
|
|
155
|
+
brandId: 'brand',
|
|
156
|
+
localDate: day,
|
|
157
|
+
orders: dayOrders,
|
|
158
|
+
gmtOffset: info.gmtOffset,
|
|
159
|
+
computedAt: new Date(`${day}T23:00:00.000Z`),
|
|
160
|
+
});
|
|
161
|
+
dayDocuments.push(...compiled.reports);
|
|
162
|
+
}
|
|
163
|
+
const monthCounters = (0, materialized_sales_comparison_close_day_helpers_1.foldMaterializedSalesComparisonPeriodCounters)({
|
|
164
|
+
periodScope: 'localMonth',
|
|
165
|
+
periodScopeField: MONTH,
|
|
166
|
+
dayDocuments,
|
|
167
|
+
});
|
|
168
|
+
const sales = emptyCounters();
|
|
169
|
+
const cancelled = emptyCounters();
|
|
170
|
+
for (const [key, counters] of Object.entries(monthCounters)) {
|
|
171
|
+
const components = (0, key_helpers_1.parseMaterializedReportKey)(key);
|
|
172
|
+
const status = components[0];
|
|
173
|
+
// The key grammar is ORDER_STATUS:PLATFORM - the status is component 0.
|
|
174
|
+
if (status === 'CANCELLED')
|
|
175
|
+
addCounters(cancelled, counters);
|
|
176
|
+
else
|
|
177
|
+
addCounters(sales, counters);
|
|
178
|
+
}
|
|
179
|
+
// Non-cancelled leaves.
|
|
180
|
+
expectClose(sales.order_count, reference.total_orders, 'order_count');
|
|
181
|
+
expectClose(sales.gross_amount, reference.price, 'gross_amount = legacy price');
|
|
182
|
+
expectClose(sales.discount_amount, reference.total_discount_amount, 'discount_amount');
|
|
183
|
+
expectClose(sales.net_amount, reference.price - reference.total_discount_amount, 'net_amount = price - discount');
|
|
184
|
+
expectClose(sales.tax_amount, reference.tax_amount + reference.gst_amount, 'tax_amount = tax + gst');
|
|
185
|
+
expectClose(sales.service_charge_amount, reference.service_fee_amount + reference.surcharge_amount, 'service_charge_amount = service fee + surcharge');
|
|
186
|
+
expectClose(sales.tip_amount, reference.tip_amount, 'tip_amount');
|
|
187
|
+
expectClose(sales.guest_count, reference.num_of_guests, 'guest_count');
|
|
188
|
+
expectClose(sales.item_count, reference.items_quantity, 'item_count');
|
|
189
|
+
expectClose(sales.refund_amount, reference.refund_amount, 'refund_amount');
|
|
190
|
+
// The cancelled key carries the legacy cancelled_orders_amount as a void.
|
|
191
|
+
expectClose(cancelled.order_count, reference.total_cancelled_orders, 'cancelled order_count');
|
|
192
|
+
expectClose(cancelled.void_amount, reference.cancelled_orders_amount, 'void_amount');
|
|
193
|
+
// And the two sides cover the whole dataset.
|
|
194
|
+
expect(sales.order_count + cancelled.order_count).toBe(reference.total_orders + reference.total_cancelled_orders);
|
|
195
|
+
});
|
|
196
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|