@managesome/eposmatic-toolkit 0.4.8 → 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/constants/enums/communications.js +1 -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/constants/enums/communications.d.ts +1 -0
- package/lib/constants/enums/communications.js +2 -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,233 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getFormattedTenantDeliveryReporting = getFormattedTenantDeliveryReporting;
|
|
4
|
+
const price_conversion_1 = require("../utils/price-conversion");
|
|
5
|
+
const materialized_delivery_classification_helpers_1 = require("./materialized-delivery-classification-helpers");
|
|
6
|
+
const materialized_delivery_accumulator_helpers_1 = require("./materialized-delivery-accumulator-helpers");
|
|
7
|
+
const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
|
|
8
|
+
const toDecimal = (cents) => (0, price_conversion_1.convertPriceFromCents)(cents ?? 0);
|
|
9
|
+
const km = (meters) => Math.round(((meters ?? 0) / 1000) * 100) / 100;
|
|
10
|
+
const safeAverage = (total, count) => count > 0 ? Math.round((total / count) * 100) / 100 : null;
|
|
11
|
+
const isDayScope = (scopeContext) => String(scopeContext) === 'localDate';
|
|
12
|
+
/** True when a key passes the caller-supplied platform / city filters. */
|
|
13
|
+
function keyPassesFilters(key, filters) {
|
|
14
|
+
const parsed = (0, materialized_delivery_classification_helpers_1.parseMaterializedDeliveryKey)(key);
|
|
15
|
+
if (parsed == null)
|
|
16
|
+
return true; // never hide a key we cannot parse
|
|
17
|
+
const platforms = filters.platforms;
|
|
18
|
+
if (platforms != null && platforms.length > 0 && !platforms.includes(parsed.platform))
|
|
19
|
+
return false;
|
|
20
|
+
const cities = filters.cities;
|
|
21
|
+
if (cities != null && cities.length > 0 && !cities.includes(parsed.city))
|
|
22
|
+
return false;
|
|
23
|
+
return true;
|
|
24
|
+
}
|
|
25
|
+
/** True when a rider row survives the rider filter (no filter = everything). */
|
|
26
|
+
function riderPassesFilters(riderId, filters) {
|
|
27
|
+
const riders = filters.rider_ids;
|
|
28
|
+
if (riders == null || riders.length === 0)
|
|
29
|
+
return true;
|
|
30
|
+
return riders.includes(riderId);
|
|
31
|
+
}
|
|
32
|
+
/** Accumulates one page for ONE view (a tenant, or the folded brand). */
|
|
33
|
+
function buildPageForTenant(tenantIds, docs, filters) {
|
|
34
|
+
const total = (0, materialized_delivery_classification_helpers_1.freshDeliveryCounters)();
|
|
35
|
+
const byPlatform = new Map();
|
|
36
|
+
const byCity = new Map();
|
|
37
|
+
const weekday = new Map();
|
|
38
|
+
let sawDayScope = false;
|
|
39
|
+
for (const doc of docs) {
|
|
40
|
+
if (isDayScope(doc.scope_context))
|
|
41
|
+
sawDayScope = true;
|
|
42
|
+
for (const [key, block] of Object.entries(doc.delivery_counters ?? {})) {
|
|
43
|
+
if (!keyPassesFilters(key, filters))
|
|
44
|
+
continue;
|
|
45
|
+
const parsed = (0, materialized_delivery_classification_helpers_1.parseMaterializedDeliveryKey)(key);
|
|
46
|
+
const platform = parsed?.platform ?? materialized_delivery_classification_helpers_1.DELIVERY_UNKNOWN_TOKEN;
|
|
47
|
+
const city = parsed?.city ?? materialized_delivery_classification_helpers_1.DELIVERY_UNKNOWN_TOKEN;
|
|
48
|
+
const blockCounters = block;
|
|
49
|
+
(0, materialized_delivery_accumulator_helpers_1.mergeMaterializedDeliveryCounters)(total, blockCounters);
|
|
50
|
+
const platformBlock = byPlatform.get(platform) ?? (0, materialized_delivery_classification_helpers_1.freshDeliveryCounters)();
|
|
51
|
+
(0, materialized_delivery_accumulator_helpers_1.mergeMaterializedDeliveryCounters)(platformBlock, blockCounters);
|
|
52
|
+
byPlatform.set(platform, platformBlock);
|
|
53
|
+
const cityBlock = byCity.get(city) ?? (0, materialized_delivery_classification_helpers_1.freshDeliveryCounters)();
|
|
54
|
+
(0, materialized_delivery_accumulator_helpers_1.mergeMaterializedDeliveryCounters)(cityBlock, blockCounters);
|
|
55
|
+
byCity.set(city, cityBlock);
|
|
56
|
+
}
|
|
57
|
+
if (isDayScope(doc.scope_context)) {
|
|
58
|
+
const dayIndex = doc.day_index == null ? null : String(doc.day_index);
|
|
59
|
+
if (dayIndex != null) {
|
|
60
|
+
let dayDeliveries = 0;
|
|
61
|
+
let dayCompleted = 0;
|
|
62
|
+
let dayRevenue = 0;
|
|
63
|
+
for (const [key, block] of Object.entries(doc.delivery_counters ?? {})) {
|
|
64
|
+
if (!keyPassesFilters(key, filters))
|
|
65
|
+
continue;
|
|
66
|
+
const counters = block;
|
|
67
|
+
dayDeliveries += Number(counters.deliveries?.count) || 0;
|
|
68
|
+
dayCompleted += Number(counters.deliveries?.completed_count) || 0;
|
|
69
|
+
dayRevenue += Number(counters.money?.rider_revenue_amount) || 0;
|
|
70
|
+
}
|
|
71
|
+
const bucket = weekday.get(dayIndex) ?? { deliveries: 0, completed: 0, revenue: 0 };
|
|
72
|
+
bucket.deliveries += dayDeliveries;
|
|
73
|
+
bucket.completed += dayCompleted;
|
|
74
|
+
bucket.revenue += dayRevenue;
|
|
75
|
+
weekday.set(dayIndex, bucket);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
const adoption = total.adoption;
|
|
80
|
+
const deliveries = total.deliveries;
|
|
81
|
+
const money = total.money;
|
|
82
|
+
const distance = total.distance;
|
|
83
|
+
const timing = total.timing;
|
|
84
|
+
const completedForTiming = Number(deliveries.completed_count) || 0;
|
|
85
|
+
const exactCompletions = Number(timing?.exact_completion_count) || 0;
|
|
86
|
+
const riders = [];
|
|
87
|
+
for (const [riderId, row] of Object.entries(total.riders ?? {})) {
|
|
88
|
+
if (!riderPassesFilters(riderId, filters))
|
|
89
|
+
continue;
|
|
90
|
+
riders.push({
|
|
91
|
+
rider_id: riderId,
|
|
92
|
+
rider_name: row.rider_name ?? null,
|
|
93
|
+
deliveries: Number(row.count) || 0,
|
|
94
|
+
completed: Number(row.completed_count) || 0,
|
|
95
|
+
cancelled: Number(row.cancelled_count) || 0,
|
|
96
|
+
rider_revenue: toDecimal(row.rider_revenue_amount),
|
|
97
|
+
avg_distance_km: safeAverage(km(row.distance_sum_meters), Number(row.count) || 0),
|
|
98
|
+
last_delivery_at: row.last_delivery_at == null ? null : new Date(row.last_delivery_at),
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
riders.sort((a, b) => b.deliveries - a.deliveries);
|
|
102
|
+
const hotAreas = [];
|
|
103
|
+
for (const [city, row] of Object.entries(total.areas ?? {})) {
|
|
104
|
+
for (const [hour, count] of Object.entries(row.by_hour ?? {})) {
|
|
105
|
+
const numeric = Number(count) || 0;
|
|
106
|
+
if (numeric === 0)
|
|
107
|
+
continue;
|
|
108
|
+
hotAreas.push({ city, hour: Number(hour) || 0, deliveries: numeric });
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
hotAreas.sort((a, b) => b.deliveries - a.deliveries);
|
|
112
|
+
const totalDistance = Number(distance.sum_meters) || 0;
|
|
113
|
+
const distanceCount = Number(distance.count) || 0;
|
|
114
|
+
return {
|
|
115
|
+
tenant_ids: tenantIds,
|
|
116
|
+
adoption: {
|
|
117
|
+
delivery_orders: Number(adoption.delivery_order_count) || 0,
|
|
118
|
+
via_app: Number(adoption.delivered_via_app_count) || 0,
|
|
119
|
+
off_app: Number(adoption.off_app_count) || 0,
|
|
120
|
+
// NULL, not 0, when there were no delivery orders at all: "0%" would claim the
|
|
121
|
+
// app covered nothing when the truth is there was nothing to cover.
|
|
122
|
+
adoption_percent: Number(adoption.delivery_order_count) > 0
|
|
123
|
+
? Math.round(((Number(adoption.delivered_via_app_count) || 0) / Number(adoption.delivery_order_count)) * 1000) / 10
|
|
124
|
+
: null,
|
|
125
|
+
tracking_enabled: Number(adoption.tracking_enabled_count) || 0,
|
|
126
|
+
with_pickup_proof: Number(adoption.proof_pickup_count) || 0,
|
|
127
|
+
with_dropoff_proof: Number(adoption.proof_dropoff_count) || 0,
|
|
128
|
+
},
|
|
129
|
+
summary: {
|
|
130
|
+
deliveries: Number(deliveries.count) || 0,
|
|
131
|
+
completed: completedForTiming,
|
|
132
|
+
cancelled: Number(deliveries.cancelled_count) || 0,
|
|
133
|
+
in_progress: Number(deliveries.in_progress_count) || 0,
|
|
134
|
+
rider_revenue: toDecimal(money.rider_revenue_amount),
|
|
135
|
+
net_sale: toDecimal(money.net_sale_amount),
|
|
136
|
+
collected: toDecimal(money.collected_amount),
|
|
137
|
+
charges_levied: toDecimal(money.delivery_charge_amount),
|
|
138
|
+
tips: toDecimal(money.tip_amount),
|
|
139
|
+
discounts: toDecimal(money.discount_amount),
|
|
140
|
+
refunds: toDecimal(money.refund_amount),
|
|
141
|
+
tax: toDecimal(money.tax_amount),
|
|
142
|
+
total_distance_km: km(totalDistance),
|
|
143
|
+
average_distance_km: safeAverage(km(totalDistance), distanceCount),
|
|
144
|
+
average_rider_revenue: safeAverage(toDecimal(money.rider_revenue_amount), Number(money.rider_revenue_count) || 0),
|
|
145
|
+
average_dispatch_lag_minutes: safeAverage(Number(timing?.dispatch_lag_sum_minutes) || 0, Number(timing?.graded_count) || 0),
|
|
146
|
+
average_complete_minutes: safeAverage(Number(timing?.complete_sum_minutes) || 0, Number(timing?.graded_count) || 0),
|
|
147
|
+
average_total_minutes: safeAverage(Number(timing?.total_sum_minutes) || 0, Number(timing?.graded_count) || 0),
|
|
148
|
+
average_assignment_minutes: safeAverage(Number(timing?.assignment_sum_minutes) || 0, Number(timing?.assignment_count) || 0),
|
|
149
|
+
average_pickup_wait_minutes: safeAverage(Number(timing?.pickup_wait_sum_minutes) || 0, Number(timing?.pickup_wait_count) || 0),
|
|
150
|
+
average_transit_minutes: safeAverage(Number(timing?.transit_sum_minutes) || 0, Number(timing?.transit_count) || 0),
|
|
151
|
+
average_cancel_minutes: safeAverage(Number(timing?.cancel_sum_minutes) || 0, Number(timing?.cancel_count) || 0),
|
|
152
|
+
average_status_updates: safeAverage(Number(timing?.status_updates_sum) || 0, Number(timing?.status_updates_count) || 0),
|
|
153
|
+
cancelled_after_pickup: Number(timing?.cancelled_after_pickup_count) || 0,
|
|
154
|
+
promise_known: Number(timing?.promise_known_count) || 0,
|
|
155
|
+
on_time: Number(timing?.on_time_count) || 0,
|
|
156
|
+
on_time_percent: Number(timing?.promise_known_count) > 0
|
|
157
|
+
? Math.round(((Number(timing?.on_time_count) || 0) / Number(timing?.promise_known_count)) * 1000) / 10
|
|
158
|
+
: null,
|
|
159
|
+
late: Number(timing?.late_count) || 0,
|
|
160
|
+
late_minutes: Number(timing?.late_minutes_sum) || 0,
|
|
161
|
+
},
|
|
162
|
+
by_platform: [...byPlatform.entries()]
|
|
163
|
+
.map(([platform, block]) => ({
|
|
164
|
+
platform,
|
|
165
|
+
deliveries: Number(block.deliveries?.count) || 0,
|
|
166
|
+
completed: Number(block.deliveries?.completed_count) || 0,
|
|
167
|
+
net_sale: toDecimal(block.money?.net_sale_amount),
|
|
168
|
+
charges_levied: toDecimal(block.money?.delivery_charge_amount),
|
|
169
|
+
rider_revenue: toDecimal(block.money?.rider_revenue_amount),
|
|
170
|
+
avg_distance_km: safeAverage(km(Number(block.distance.sum_meters) || 0), Number(block.distance.count) || 0),
|
|
171
|
+
}))
|
|
172
|
+
.sort((a, b) => b.deliveries - a.deliveries),
|
|
173
|
+
by_area: [...byCity.entries()]
|
|
174
|
+
.map(([city, block]) => ({
|
|
175
|
+
city,
|
|
176
|
+
deliveries: Number(block.deliveries?.count) || 0,
|
|
177
|
+
completed: Number(block.deliveries?.completed_count) || 0,
|
|
178
|
+
net_sale: toDecimal(block.money?.net_sale_amount),
|
|
179
|
+
charges_levied: toDecimal(block.money?.delivery_charge_amount),
|
|
180
|
+
rider_revenue: toDecimal(block.money?.rider_revenue_amount),
|
|
181
|
+
avg_distance_km: safeAverage(km(Number(block.distance.sum_meters) || 0), Number(block.distance.count) || 0),
|
|
182
|
+
}))
|
|
183
|
+
.sort((a, b) => b.deliveries - a.deliveries),
|
|
184
|
+
by_rider: riders,
|
|
185
|
+
distance_buckets: MATERIALIZED_REPORTS_1.MATERIALIZED_DELIVERY_DISTANCE_BUCKETS.map((bucket) => ({
|
|
186
|
+
label: bucket.key,
|
|
187
|
+
count: Number(distance[bucket.key]) || 0,
|
|
188
|
+
percent: distanceCount > 0 ? Math.round(((Number(distance[bucket.key]) || 0) / distanceCount) * 1000) / 10 : 0,
|
|
189
|
+
})),
|
|
190
|
+
hot_areas: hotAreas.length > 0 ? hotAreas.slice(0, 50) : null,
|
|
191
|
+
weekday: sawDayScope
|
|
192
|
+
? [...weekday.entries()].map(([dayIndex, bucket]) => ({
|
|
193
|
+
day_index: dayIndex,
|
|
194
|
+
deliveries: bucket.deliveries,
|
|
195
|
+
completed: bucket.completed,
|
|
196
|
+
rider_revenue: toDecimal(bucket.revenue),
|
|
197
|
+
}))
|
|
198
|
+
: null,
|
|
199
|
+
// Approximate as soon as ONE completion leaned on the proxy, and never claimed when
|
|
200
|
+
// nothing was graded at all (no evidence is not the same as approximate evidence).
|
|
201
|
+
timing_approximate: exactCompletions < completedForTiming,
|
|
202
|
+
};
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* Formats delivery documents into page data.
|
|
206
|
+
*
|
|
207
|
+
* `separate_view_per_tenant` yields one entry per tenant; otherwise every tenant folds
|
|
208
|
+
* into a single brand view. Returns null on unusable input rather than an empty page, so
|
|
209
|
+
* the caller can tell "no data" from "malformed request".
|
|
210
|
+
*/
|
|
211
|
+
function getFormattedTenantDeliveryReporting(docs, filters, separate_view_per_tenant) {
|
|
212
|
+
if (!Array.isArray(docs) || docs.length === 0)
|
|
213
|
+
return null;
|
|
214
|
+
const usable = docs.filter((doc) => doc != null && doc.delivery_counters != null);
|
|
215
|
+
if (usable.length === 0)
|
|
216
|
+
return null;
|
|
217
|
+
const resolvedFilters = filters ?? {};
|
|
218
|
+
if (separate_view_per_tenant === true) {
|
|
219
|
+
const byTenant = new Map();
|
|
220
|
+
for (const doc of usable) {
|
|
221
|
+
const tenantId = String(doc.tenant_id);
|
|
222
|
+
const bucket = byTenant.get(tenantId) ?? [];
|
|
223
|
+
bucket.push(doc);
|
|
224
|
+
byTenant.set(tenantId, bucket);
|
|
225
|
+
}
|
|
226
|
+
return [
|
|
227
|
+
[...byTenant.entries()].map(([tenantId, tenantDocs]) => buildPageForTenant([tenantId], tenantDocs, resolvedFilters)),
|
|
228
|
+
null,
|
|
229
|
+
];
|
|
230
|
+
}
|
|
231
|
+
const tenantIds = [...new Set(usable.map((doc) => String(doc.tenant_id)))].sort();
|
|
232
|
+
return [[buildPageForTenant(tenantIds, usable, resolvedFilters)], null];
|
|
233
|
+
}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import { DAY_INDEX_ENUM } from '../../constants/ENUMS';
|
|
2
|
+
import { MATERIALIZED_DISCOUNT_LEVEL_ENUM, MATERIALIZED_DISCOUNT_SLOT_ENUM, MATERIALIZED_DISCOUNT_SUB_KIND_ENUM } from '../../constants/MATERIALIZED_REPORTS';
|
|
3
|
+
import { IMaterializedTenantDiscountReport } from '../../schemas/types/materialized_tenant_discount_reports';
|
|
4
|
+
import { IMaterializedTenantDiscountAggregatedReport } from '../types/materialized-reports-apis';
|
|
5
|
+
/**
|
|
6
|
+
* Frontend formatter for `materialized_tenant_discount_reports` (M1).
|
|
7
|
+
*
|
|
8
|
+
* The read API returns raw counter documents; this formatter derives the view:
|
|
9
|
+
* - money converts CENTS → decimals; counts stay integers;
|
|
10
|
+
* - platform / order-status filters apply to the key map client-side (zero
|
|
11
|
+
* refetches — the documents already carry every dimension);
|
|
12
|
+
* - `CANCELLED:*` keys split into their own facet, like the overview;
|
|
13
|
+
* - **money is always `resolved_amount`** — the RAW slot value is exposed only
|
|
14
|
+
* as the percentage/rate display data, never as an amount (a raw-only
|
|
15
|
+
* rendering would show "25" for a 25 % discount);
|
|
16
|
+
* - weekday views group on the denormalized `day_index` (date/hour scopes only)
|
|
17
|
+
* and hour series order by business-hour index (`06…23, 00…05`).
|
|
18
|
+
*
|
|
19
|
+
* Validation convention: returns `null` instead of throwing when the input
|
|
20
|
+
* cannot be formatted (non-array, mixed key filters / schema versions). An
|
|
21
|
+
* EMPTY document list is valid and yields a zero-filled page.
|
|
22
|
+
*/
|
|
23
|
+
export interface IFormattedDiscountsFilters {
|
|
24
|
+
/** Platform component values (e.g. `POS_WALK-IN`); empty or omitted = all. */
|
|
25
|
+
platforms?: string[] | null;
|
|
26
|
+
/** Order-status component values (e.g. `COMPLETED`); empty or omitted = all. */
|
|
27
|
+
order_statuses?: string[] | null;
|
|
28
|
+
/** Weekday filter for date/hour scopes (documents without `day_index` drop). */
|
|
29
|
+
day_indexes?: DAY_INDEX_ENUM[] | null;
|
|
30
|
+
}
|
|
31
|
+
/** One display row of the discounts breakdown. */
|
|
32
|
+
export interface IFormattedDiscountSection {
|
|
33
|
+
/** Stable identity of the row (kind + sub-kind). */
|
|
34
|
+
sub_kind: MATERIALIZED_DISCOUNT_SUB_KIND_ENUM;
|
|
35
|
+
slot: MATERIALIZED_DISCOUNT_SLOT_ENUM | null;
|
|
36
|
+
level: MATERIALIZED_DISCOUNT_LEVEL_ENUM;
|
|
37
|
+
label: string;
|
|
38
|
+
count: number;
|
|
39
|
+
/** RESOLVED money, decimals — what the page renders. */
|
|
40
|
+
amount: number;
|
|
41
|
+
/** Average raw rate of the row's occurrences (percent rows), else null. */
|
|
42
|
+
rate: number | null;
|
|
43
|
+
/** Share of the total discount (0 when the total is 0). */
|
|
44
|
+
share_percent: number;
|
|
45
|
+
}
|
|
46
|
+
export interface IFormattedDiscountsSummary {
|
|
47
|
+
total_discount: number;
|
|
48
|
+
order_level_discount: number;
|
|
49
|
+
item_level_discount: number;
|
|
50
|
+
discount_count: number;
|
|
51
|
+
item_discount_count: number;
|
|
52
|
+
unattributed_discount: number;
|
|
53
|
+
free_item_count: number;
|
|
54
|
+
free_item_value: number;
|
|
55
|
+
complimentary_count: number;
|
|
56
|
+
complimentary_amount: number;
|
|
57
|
+
}
|
|
58
|
+
export interface IFormattedDiscountsPageData {
|
|
59
|
+
tenant_ids: string[];
|
|
60
|
+
summary: IFormattedDiscountsSummary;
|
|
61
|
+
/** Order-level slot totals (resolved money + the raw rate for display). */
|
|
62
|
+
order_slots: {
|
|
63
|
+
slot: MATERIALIZED_DISCOUNT_SLOT_ENUM;
|
|
64
|
+
count: number;
|
|
65
|
+
amount: number;
|
|
66
|
+
rate: number | null;
|
|
67
|
+
}[];
|
|
68
|
+
sections: IFormattedDiscountSection[];
|
|
69
|
+
cancelled: {
|
|
70
|
+
total_discount: number;
|
|
71
|
+
discount_count: number;
|
|
72
|
+
} | null;
|
|
73
|
+
weekday: {
|
|
74
|
+
day_index: DAY_INDEX_ENUM;
|
|
75
|
+
total_discount: number;
|
|
76
|
+
discount_count: number;
|
|
77
|
+
}[] | null;
|
|
78
|
+
hourly: {
|
|
79
|
+
local_date: string;
|
|
80
|
+
hour: number;
|
|
81
|
+
business_hour_index: number;
|
|
82
|
+
total_discount: number;
|
|
83
|
+
discount_count: number;
|
|
84
|
+
}[] | null;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Formats materialized discount documents into page-ready data — one entry per
|
|
88
|
+
* tenant (`separate_view_per_tenant`) or one combined entry. Returns `null` on
|
|
89
|
+
* unformattable input; an empty list yields a zero-filled page.
|
|
90
|
+
*/
|
|
91
|
+
export declare function getFormattedTenantDiscountsReporting(reports: IMaterializedTenantDiscountReport[], filters?: IFormattedDiscountsFilters | null, separate_view_per_tenant?: boolean): [IFormattedDiscountsPageData[], null] | null;
|
|
92
|
+
/**
|
|
93
|
+
* Frontend formatter for the AGGREGATED discounts read
|
|
94
|
+
* (`POST /reports/discounts` returns `IMaterializedTenantDiscountAggregatedReport[]`
|
|
95
|
+
* - one record per tenant, folded inside MongoDB).
|
|
96
|
+
*
|
|
97
|
+
* The aggregated record carries the SAME `discount_counters` map as a stored
|
|
98
|
+
* document, so this delegates to the stored-document formatter: one code path,
|
|
99
|
+
* no duplicated shaping. The envelope fields it reads are supplied here.
|
|
100
|
+
*
|
|
101
|
+
* `scope_field` carries the TENANT. The formatter's duplicate-identity guard
|
|
102
|
+
* (`scope_context|scope_field`) exists to catch the same stored scope document
|
|
103
|
+
* being fed twice; for folded records the meaningful identity IS the tenant, so
|
|
104
|
+
* one record per tenant keeps that guard useful instead of tripping on every
|
|
105
|
+
* record sharing an absent scope.
|
|
106
|
+
*
|
|
107
|
+
* LIMITATION - no `weekday` / `hourly` breakdowns. Those group on a stored
|
|
108
|
+
* document's `day_index` / `scope_field` hour, and a folded record spans many
|
|
109
|
+
* scope documents, so the fold has no single value to group on. A weekday or
|
|
110
|
+
* day-index filter is therefore REFUSED (`null`, the unformattable convention)
|
|
111
|
+
* rather than silently ignored; `weekday` and `hourly` come back `null`. The
|
|
112
|
+
* summary, order slots and sections are exact.
|
|
113
|
+
*/
|
|
114
|
+
export declare function getFormattedTenantDiscountsAggregatedReporting(reports: IMaterializedTenantDiscountAggregatedReport[], filters?: IFormattedDiscountsFilters | null, separate_view_per_tenant?: boolean): [IFormattedDiscountsPageData[], null] | null;
|