@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,243 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getHourlyComparisonBusinessIndex = exports.getHourlyComparisonHourLabel = void 0;
|
|
4
|
+
exports.getFormattedTenantHourlyComparisonReporting = getFormattedTenantHourlyComparisonReporting;
|
|
5
|
+
const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
|
|
6
|
+
const tenant_sales_comparison_formatter_1 = require("./tenant-sales-comparison-formatter");
|
|
7
|
+
const materialized_sales_comparison_accumulator_helpers_1 = require("./materialized-sales-comparison-accumulator-helpers");
|
|
8
|
+
const key_helpers_1 = require("./key-helpers");
|
|
9
|
+
/** `'YYYY-MM-DD HH'` → hour, or null. */
|
|
10
|
+
const hourOfScopeField = (scopeField) => {
|
|
11
|
+
if (typeof scopeField !== 'string')
|
|
12
|
+
return null;
|
|
13
|
+
const match = /^\d{4}-\d{2}-\d{2} ([01]\d|2[0-3])$/.exec(scopeField);
|
|
14
|
+
return match == null ? null : Number(match[1]);
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Accepts BOTH read shapes: an aggregated profile record (`hour_counters`) and
|
|
18
|
+
* a STORED hour document (`sales_counters` + `scope_field`) — the same dual
|
|
19
|
+
* input every document-shaped materialized formatter accepts, so a stored
|
|
20
|
+
* document and a read record go down one code path.
|
|
21
|
+
*/
|
|
22
|
+
const normalizeHourlyDocument = (doc) => {
|
|
23
|
+
if (doc == null)
|
|
24
|
+
return null;
|
|
25
|
+
const keyFilters = (doc.sale_type_key_filters ?? []);
|
|
26
|
+
if ('hour_counters' in doc && doc.hour_counters != null) {
|
|
27
|
+
return {
|
|
28
|
+
tenant_id: String(doc.tenant_id),
|
|
29
|
+
brand_id: String(doc.brand_id ?? ''),
|
|
30
|
+
sale_type_key_filters: keyFilters,
|
|
31
|
+
hour_counters: doc.hour_counters,
|
|
32
|
+
matched_documents: Number(doc.matched_documents ?? 1) || 1,
|
|
33
|
+
max_updated_at: doc.max_updated_at == null ? null : new Date(doc.max_updated_at),
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
const stored = doc;
|
|
37
|
+
if (stored.sales_counters == null)
|
|
38
|
+
return null;
|
|
39
|
+
const hour = hourOfScopeField(stored.scope_field);
|
|
40
|
+
if (hour == null)
|
|
41
|
+
return null;
|
|
42
|
+
return {
|
|
43
|
+
tenant_id: String(stored.tenant_id),
|
|
44
|
+
brand_id: String(stored.brand_id ?? ''),
|
|
45
|
+
sale_type_key_filters: keyFilters,
|
|
46
|
+
hour_counters: { [String(hour)]: stored.sales_counters },
|
|
47
|
+
matched_documents: 1,
|
|
48
|
+
max_updated_at: stored.updatedAt == null ? null : new Date(stored.updatedAt),
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
/** `'HH:00–HH+1:00'` (end wraps at midnight). */
|
|
52
|
+
const getHourlyComparisonHourLabel = (hour) => {
|
|
53
|
+
const pad = (value) => String(value).padStart(2, '0');
|
|
54
|
+
return `${pad(hour)}:00–${pad((hour + 1) % 24)}:00`;
|
|
55
|
+
};
|
|
56
|
+
exports.getHourlyComparisonHourLabel = getHourlyComparisonHourLabel;
|
|
57
|
+
/** Business-hour index: 06 → 0, …, 23 → 17, 00 → 18, …, 05 → 23. */
|
|
58
|
+
const getHourlyComparisonBusinessIndex = (hour) => (hour + 18) % 24;
|
|
59
|
+
exports.getHourlyComparisonBusinessIndex = getHourlyComparisonBusinessIndex;
|
|
60
|
+
const isCancelled = (status) => status === 'CANCELLED';
|
|
61
|
+
const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes('CANCELLED');
|
|
62
|
+
const parseKey = (key, keyFilters) => {
|
|
63
|
+
const components = (0, key_helpers_1.parseMaterializedReportKey)(key);
|
|
64
|
+
if (components == null || components.length !== keyFilters.length)
|
|
65
|
+
return null;
|
|
66
|
+
let orderStatus = null;
|
|
67
|
+
let platform = null;
|
|
68
|
+
for (let index = 0; index < keyFilters.length; index += 1) {
|
|
69
|
+
if (keyFilters[index] === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_KEY_FILTER_ENUM.ORDER_STATUS) {
|
|
70
|
+
orderStatus = components[index];
|
|
71
|
+
}
|
|
72
|
+
else if (keyFilters[index] === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_KEY_FILTER_ENUM.PLATFORM) {
|
|
73
|
+
platform = components[index];
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
return { order_status: orderStatus, platform };
|
|
77
|
+
};
|
|
78
|
+
const keyMatchesFilters = (parsed, filters) => {
|
|
79
|
+
if (filters.platforms != null &&
|
|
80
|
+
filters.platforms.length > 0 &&
|
|
81
|
+
(parsed.platform == null || !filters.platforms.includes(parsed.platform))) {
|
|
82
|
+
return false;
|
|
83
|
+
}
|
|
84
|
+
if (filters.order_statuses != null &&
|
|
85
|
+
filters.order_statuses.length > 0 &&
|
|
86
|
+
(parsed.order_status == null || !filters.order_statuses.includes(parsed.order_status))) {
|
|
87
|
+
return false;
|
|
88
|
+
}
|
|
89
|
+
return true;
|
|
90
|
+
};
|
|
91
|
+
const emptyFold = () => ({
|
|
92
|
+
byHour: new Map(),
|
|
93
|
+
cancelledByHour: new Map(),
|
|
94
|
+
keyFilters: [],
|
|
95
|
+
matchedDocuments: 0,
|
|
96
|
+
maxUpdatedAt: null,
|
|
97
|
+
});
|
|
98
|
+
const foldDocs = (docs, filters, includeCancelledInTotals) => {
|
|
99
|
+
const fold = emptyFold();
|
|
100
|
+
for (const doc of docs ?? []) {
|
|
101
|
+
if (doc == null)
|
|
102
|
+
continue;
|
|
103
|
+
if (fold.keyFilters.length === 0)
|
|
104
|
+
fold.keyFilters = doc.sale_type_key_filters ?? [];
|
|
105
|
+
fold.matchedDocuments += Number(doc.matched_documents ?? 1) || 0;
|
|
106
|
+
const updatedAt = doc.max_updated_at == null ? null : new Date(doc.max_updated_at);
|
|
107
|
+
if (updatedAt != null &&
|
|
108
|
+
!Number.isNaN(updatedAt.getTime()) &&
|
|
109
|
+
(fold.maxUpdatedAt == null || updatedAt.getTime() > fold.maxUpdatedAt.getTime())) {
|
|
110
|
+
fold.maxUpdatedAt = updatedAt;
|
|
111
|
+
}
|
|
112
|
+
for (const [hourKey, countersByKey] of Object.entries(doc.hour_counters ?? {})) {
|
|
113
|
+
const hour = Number(hourKey);
|
|
114
|
+
if (!Number.isInteger(hour) || hour < 0 || hour > 23)
|
|
115
|
+
continue;
|
|
116
|
+
for (const [key, counters] of Object.entries(countersByKey ?? {})) {
|
|
117
|
+
const parsed = parseKey(key, fold.keyFilters);
|
|
118
|
+
if (parsed == null || !keyMatchesFilters(parsed, filters))
|
|
119
|
+
continue;
|
|
120
|
+
if (isCancelled(parsed.order_status) && !includeCancelledInTotals) {
|
|
121
|
+
const cancelled = fold.cancelledByHour.get(hour) ?? (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
|
|
122
|
+
(0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(cancelled, counters);
|
|
123
|
+
fold.cancelledByHour.set(hour, cancelled);
|
|
124
|
+
continue;
|
|
125
|
+
}
|
|
126
|
+
const byKey = fold.byHour.get(hour) ?? new Map();
|
|
127
|
+
const existing = byKey.get(key) ?? (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
|
|
128
|
+
(0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(existing, counters);
|
|
129
|
+
byKey.set(key, existing);
|
|
130
|
+
fold.byHour.set(hour, byKey);
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
return fold;
|
|
135
|
+
};
|
|
136
|
+
/** Sums every non-cancelled hour into one totals block. */
|
|
137
|
+
const totalOf = (fold) => {
|
|
138
|
+
const total = (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
|
|
139
|
+
for (const byKey of fold.byHour.values()) {
|
|
140
|
+
for (const counters of byKey.values())
|
|
141
|
+
(0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(total, counters);
|
|
142
|
+
}
|
|
143
|
+
return total;
|
|
144
|
+
};
|
|
145
|
+
/** Sums the cancelled hour blocks. */
|
|
146
|
+
const cancelledTotalOf = (fold) => {
|
|
147
|
+
const total = (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
|
|
148
|
+
for (const counters of fold.cancelledByHour.values())
|
|
149
|
+
(0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(total, counters);
|
|
150
|
+
return total;
|
|
151
|
+
};
|
|
152
|
+
const buildPage = (group, filters) => {
|
|
153
|
+
const includeCancelled = includesCancelled(filters);
|
|
154
|
+
const currentFold = foldDocs(group.currentDocs, filters, includeCancelled);
|
|
155
|
+
const comparisonFold = group.comparisonDocs == null ? null : foldDocs(group.comparisonDocs, filters, includeCancelled);
|
|
156
|
+
const hours = [];
|
|
157
|
+
for (let businessIndex = 0; businessIndex < 24; businessIndex += 1) {
|
|
158
|
+
// business order 06…23, 00…05
|
|
159
|
+
const hour = (businessIndex + 6) % 24;
|
|
160
|
+
const current = (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(sumHour(currentFold.byHour.get(hour)));
|
|
161
|
+
const comparison = comparisonFold == null ? null : (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(sumHour(comparisonFold.byHour.get(hour)));
|
|
162
|
+
hours.push({
|
|
163
|
+
hour,
|
|
164
|
+
label: (0, exports.getHourlyComparisonHourLabel)(hour),
|
|
165
|
+
business_index: businessIndex,
|
|
166
|
+
current,
|
|
167
|
+
comparison,
|
|
168
|
+
metrics: (0, tenant_sales_comparison_formatter_1.buildSalesComparisonMetrics)(current, comparison),
|
|
169
|
+
});
|
|
170
|
+
}
|
|
171
|
+
const current = (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(totalOf(currentFold));
|
|
172
|
+
const comparison = comparisonFold == null ? null : (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(totalOf(comparisonFold));
|
|
173
|
+
return {
|
|
174
|
+
tenant_ids: [...group.tenantIds].sort(),
|
|
175
|
+
filters: {
|
|
176
|
+
platforms: filters.platforms != null && filters.platforms.length > 0 ? [...filters.platforms] : null,
|
|
177
|
+
order_statuses: filters.order_statuses != null && filters.order_statuses.length > 0 ? [...filters.order_statuses] : null,
|
|
178
|
+
},
|
|
179
|
+
current,
|
|
180
|
+
comparison,
|
|
181
|
+
metrics: (0, tenant_sales_comparison_formatter_1.buildSalesComparisonMetrics)(current, comparison),
|
|
182
|
+
cancelled: (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(cancelledTotalOf(currentFold)),
|
|
183
|
+
hours,
|
|
184
|
+
hours_with_data: hours.filter((entry) => entry.current.counters.order_count > 0).length,
|
|
185
|
+
matched_documents: currentFold.matchedDocuments,
|
|
186
|
+
max_updated_at: currentFold.maxUpdatedAt,
|
|
187
|
+
};
|
|
188
|
+
};
|
|
189
|
+
const sumHour = (byKey) => {
|
|
190
|
+
const total = (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
|
|
191
|
+
if (byKey != null)
|
|
192
|
+
for (const counters of byKey.values())
|
|
193
|
+
(0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(total, counters);
|
|
194
|
+
return total;
|
|
195
|
+
};
|
|
196
|
+
/**
|
|
197
|
+
* Page-ready Hourly Comparison data.
|
|
198
|
+
*
|
|
199
|
+
* `comparisonDocs` is `null` for `baseline: NONE`; an empty array is a valid
|
|
200
|
+
* baseline window with no sales (a zero profile).
|
|
201
|
+
*/
|
|
202
|
+
function getFormattedTenantHourlyComparisonReporting(currentDocs, comparisonDocs, filters = null, separate_view_per_tenant = false) {
|
|
203
|
+
if (!Array.isArray(currentDocs) || currentDocs.length === 0)
|
|
204
|
+
return null;
|
|
205
|
+
if (currentDocs.some((doc) => doc == null))
|
|
206
|
+
return null;
|
|
207
|
+
if (comparisonDocs != null && !Array.isArray(comparisonDocs))
|
|
208
|
+
return null;
|
|
209
|
+
if (filters != null) {
|
|
210
|
+
if (filters.platforms != null && !Array.isArray(filters.platforms))
|
|
211
|
+
return null;
|
|
212
|
+
if (filters.order_statuses != null && !Array.isArray(filters.order_statuses))
|
|
213
|
+
return null;
|
|
214
|
+
}
|
|
215
|
+
const resolvedFilters = filters ?? {};
|
|
216
|
+
const normalizedCurrent = currentDocs.map(normalizeHourlyDocument);
|
|
217
|
+
if (normalizedCurrent.some((doc) => doc == null))
|
|
218
|
+
return null;
|
|
219
|
+
const normalizedComparison = comparisonDocs == null ? null : comparisonDocs.map(normalizeHourlyDocument);
|
|
220
|
+
if (normalizedComparison != null && normalizedComparison.some((doc) => doc == null))
|
|
221
|
+
return null;
|
|
222
|
+
const usableCurrent = normalizedCurrent;
|
|
223
|
+
if (usableCurrent.length === 0)
|
|
224
|
+
return null;
|
|
225
|
+
const signature = (usableCurrent[0].sale_type_key_filters ?? []).join(':');
|
|
226
|
+
for (const doc of [...usableCurrent, ...(normalizedComparison ?? [])]) {
|
|
227
|
+
if ((doc.sale_type_key_filters ?? []).join(':') !== signature)
|
|
228
|
+
return null;
|
|
229
|
+
}
|
|
230
|
+
const allTenantIds = [...new Set(usableCurrent.map((doc) => String(doc.tenant_id)))].sort();
|
|
231
|
+
const scopes = separate_view_per_tenant ? allTenantIds.map((tenantId) => [tenantId]) : [allTenantIds];
|
|
232
|
+
const pages = [];
|
|
233
|
+
for (const scope of scopes) {
|
|
234
|
+
const currentForScope = usableCurrent.filter((doc) => scope.includes(String(doc.tenant_id)));
|
|
235
|
+
if (currentForScope.length === 0)
|
|
236
|
+
continue;
|
|
237
|
+
const comparisonForScope = normalizedComparison == null
|
|
238
|
+
? null
|
|
239
|
+
: normalizedComparison.filter((doc) => scope.includes(String(doc.tenant_id)));
|
|
240
|
+
pages.push(buildPage({ tenantIds: scope, currentDocs: currentForScope, comparisonDocs: comparisonForScope }, resolvedFilters));
|
|
241
|
+
}
|
|
242
|
+
return pages.length === 0 ? null : [pages, null];
|
|
243
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { PAYMENTS_COMPARISON_METRIC_ENUM } from '../../constants/MATERIALIZED_REPORTS';
|
|
2
|
+
import { IMaterializedPaymentsComparisonCounters, IMaterializedTenantPaymentsComparisonReport } from '../../schemas/types/materialized_tenant_payments_comparison_reports';
|
|
3
|
+
import { IMaterializedTenantPaymentsComparisonAggregatedReport } from '../types/materialized-reports-apis';
|
|
4
|
+
/**
|
|
5
|
+
* Payments Comparison formatter — the page-ready shape of `current` vs
|
|
6
|
+
* `comparison`, keyed `<PAYMENT_METHOD>:<ORDER_STATUS>`.
|
|
7
|
+
*
|
|
8
|
+
* Payment amounts are DECIMALS here; counts stay exact. `average_payment` is
|
|
9
|
+
* derived (`payment_amount / payment_count`), never stored. Filters and the
|
|
10
|
+
* metric switch are client-side: the document already carries every counter, so
|
|
11
|
+
* neither may trigger a refetch.
|
|
12
|
+
*
|
|
13
|
+
* Cancelled keys are split out of the totals (unless explicitly filtered), the
|
|
14
|
+
* same rule as Sales Comparison. Returns `null` on invalid input.
|
|
15
|
+
*/
|
|
16
|
+
type TPaymentsDocument = IMaterializedTenantPaymentsComparisonAggregatedReport | IMaterializedTenantPaymentsComparisonReport;
|
|
17
|
+
export interface IFormattedPaymentsComparisonFilters {
|
|
18
|
+
payment_methods?: string[] | null;
|
|
19
|
+
order_statuses?: string[] | null;
|
|
20
|
+
}
|
|
21
|
+
export interface IFormattedPaymentsComparisonCounters {
|
|
22
|
+
payment_count: number;
|
|
23
|
+
payment_amount: number;
|
|
24
|
+
amount_due: number;
|
|
25
|
+
amount_paid: number;
|
|
26
|
+
amount_refunded: number;
|
|
27
|
+
card_charges: number;
|
|
28
|
+
refund_count: number;
|
|
29
|
+
unpaid_count: number;
|
|
30
|
+
}
|
|
31
|
+
export interface IFormattedPaymentsComparisonMetric {
|
|
32
|
+
current: number | null;
|
|
33
|
+
comparison: number | null;
|
|
34
|
+
delta: number | null;
|
|
35
|
+
delta_percent: number | null;
|
|
36
|
+
}
|
|
37
|
+
export interface IFormattedPaymentsComparisonSeries {
|
|
38
|
+
counters: IFormattedPaymentsComparisonCounters;
|
|
39
|
+
/** Derived: `payment_amount / payment_count`; `null` with no payments. */
|
|
40
|
+
average_payment: number | null;
|
|
41
|
+
}
|
|
42
|
+
export interface IFormattedPaymentsComparisonKeyRow {
|
|
43
|
+
key: string;
|
|
44
|
+
payment_method: string | null;
|
|
45
|
+
order_status: string | null;
|
|
46
|
+
current: IFormattedPaymentsComparisonSeries;
|
|
47
|
+
comparison: IFormattedPaymentsComparisonSeries | null;
|
|
48
|
+
metrics: Record<PAYMENTS_COMPARISON_METRIC_ENUM, IFormattedPaymentsComparisonMetric>;
|
|
49
|
+
}
|
|
50
|
+
export interface IFormattedPaymentsComparisonMethodRow {
|
|
51
|
+
payment_method: string;
|
|
52
|
+
current: IFormattedPaymentsComparisonSeries;
|
|
53
|
+
comparison: IFormattedPaymentsComparisonSeries | null;
|
|
54
|
+
metrics: Record<PAYMENTS_COMPARISON_METRIC_ENUM, IFormattedPaymentsComparisonMetric>;
|
|
55
|
+
}
|
|
56
|
+
export interface IFormattedPaymentsComparisonPageData {
|
|
57
|
+
tenant_ids: string[];
|
|
58
|
+
filters: {
|
|
59
|
+
payment_methods: string[] | null;
|
|
60
|
+
order_statuses: string[] | null;
|
|
61
|
+
};
|
|
62
|
+
current: IFormattedPaymentsComparisonSeries;
|
|
63
|
+
comparison: IFormattedPaymentsComparisonSeries | null;
|
|
64
|
+
metrics: Record<PAYMENTS_COMPARISON_METRIC_ENUM, IFormattedPaymentsComparisonMetric>;
|
|
65
|
+
cancelled: IFormattedPaymentsComparisonSeries;
|
|
66
|
+
rows: IFormattedPaymentsComparisonKeyRow[];
|
|
67
|
+
by_method: IFormattedPaymentsComparisonMethodRow[];
|
|
68
|
+
matched_documents: number;
|
|
69
|
+
max_updated_at: Date | null;
|
|
70
|
+
}
|
|
71
|
+
export declare const createEmptyPaymentsComparisonFormattedCounters: () => IFormattedPaymentsComparisonCounters;
|
|
72
|
+
export declare const formatPaymentsComparisonSeries: (counters: IMaterializedPaymentsComparisonCounters | null | undefined) => IFormattedPaymentsComparisonSeries;
|
|
73
|
+
export declare function buildPaymentsComparisonMetrics(current: IFormattedPaymentsComparisonSeries, comparison: IFormattedPaymentsComparisonSeries | null): Record<PAYMENTS_COMPARISON_METRIC_ENUM, IFormattedPaymentsComparisonMetric>;
|
|
74
|
+
export declare function getFormattedTenantPaymentsComparisonReporting(currentDocs: TPaymentsDocument[] | null | undefined, comparisonDocs: TPaymentsDocument[] | null | undefined, filters?: IFormattedPaymentsComparisonFilters | null, separate_view_per_tenant?: boolean): [IFormattedPaymentsComparisonPageData[], null] | null;
|
|
75
|
+
export {};
|
|
@@ -0,0 +1,286 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.formatPaymentsComparisonSeries = exports.createEmptyPaymentsComparisonFormattedCounters = void 0;
|
|
4
|
+
exports.buildPaymentsComparisonMetrics = buildPaymentsComparisonMetrics;
|
|
5
|
+
exports.getFormattedTenantPaymentsComparisonReporting = getFormattedTenantPaymentsComparisonReporting;
|
|
6
|
+
const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
|
|
7
|
+
const key_helpers_1 = require("./key-helpers");
|
|
8
|
+
const price_conversion_1 = require("../utils/price-conversion");
|
|
9
|
+
const METRICS = [
|
|
10
|
+
MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_AMOUNT,
|
|
11
|
+
MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_COUNT,
|
|
12
|
+
MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.AVERAGE_PAYMENT,
|
|
13
|
+
MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.CARD_CHARGES,
|
|
14
|
+
MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.REFUNDED_AMOUNT,
|
|
15
|
+
MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.AMOUNT_DUE,
|
|
16
|
+
];
|
|
17
|
+
const toDecimal = (cents) => (0, price_conversion_1.convertPriceFromCents)(cents ?? 0);
|
|
18
|
+
const createEmptyPaymentsComparisonFormattedCounters = () => ({
|
|
19
|
+
payment_count: 0,
|
|
20
|
+
payment_amount: 0,
|
|
21
|
+
amount_due: 0,
|
|
22
|
+
amount_paid: 0,
|
|
23
|
+
amount_refunded: 0,
|
|
24
|
+
card_charges: 0,
|
|
25
|
+
refund_count: 0,
|
|
26
|
+
unpaid_count: 0,
|
|
27
|
+
});
|
|
28
|
+
exports.createEmptyPaymentsComparisonFormattedCounters = createEmptyPaymentsComparisonFormattedCounters;
|
|
29
|
+
const formatCounters = (counters) => ({
|
|
30
|
+
payment_count: counters?.payment_count ?? 0,
|
|
31
|
+
payment_amount: toDecimal(counters?.payment_amount),
|
|
32
|
+
amount_due: toDecimal(counters?.amount_due),
|
|
33
|
+
amount_paid: toDecimal(counters?.amount_paid),
|
|
34
|
+
amount_refunded: toDecimal(counters?.amount_refunded),
|
|
35
|
+
card_charges: toDecimal(counters?.card_charges),
|
|
36
|
+
refund_count: counters?.refund_count ?? 0,
|
|
37
|
+
unpaid_count: counters?.unpaid_count ?? 0,
|
|
38
|
+
});
|
|
39
|
+
const formatPaymentsComparisonSeries = (counters) => {
|
|
40
|
+
const formatted = formatCounters(counters);
|
|
41
|
+
return {
|
|
42
|
+
counters: formatted,
|
|
43
|
+
average_payment: formatted.payment_count > 0 ? formatted.payment_amount / formatted.payment_count : null,
|
|
44
|
+
};
|
|
45
|
+
};
|
|
46
|
+
exports.formatPaymentsComparisonSeries = formatPaymentsComparisonSeries;
|
|
47
|
+
const seriesMetric = (series, metric) => {
|
|
48
|
+
switch (metric) {
|
|
49
|
+
case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_AMOUNT:
|
|
50
|
+
return series.counters.payment_amount;
|
|
51
|
+
case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_COUNT:
|
|
52
|
+
return series.counters.payment_count;
|
|
53
|
+
case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.AVERAGE_PAYMENT:
|
|
54
|
+
return series.average_payment;
|
|
55
|
+
case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.CARD_CHARGES:
|
|
56
|
+
return series.counters.card_charges;
|
|
57
|
+
case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.REFUNDED_AMOUNT:
|
|
58
|
+
return series.counters.amount_refunded;
|
|
59
|
+
case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.AMOUNT_DUE:
|
|
60
|
+
return series.counters.amount_due;
|
|
61
|
+
default:
|
|
62
|
+
return null;
|
|
63
|
+
}
|
|
64
|
+
};
|
|
65
|
+
const percentDelta = (current, comparison) => {
|
|
66
|
+
if (current == null || comparison == null)
|
|
67
|
+
return null;
|
|
68
|
+
if (comparison === 0)
|
|
69
|
+
return current === 0 ? 0 : null;
|
|
70
|
+
return ((current - comparison) / Math.abs(comparison)) * 100;
|
|
71
|
+
};
|
|
72
|
+
function buildPaymentsComparisonMetrics(current, comparison) {
|
|
73
|
+
const metrics = {};
|
|
74
|
+
for (const metric of METRICS) {
|
|
75
|
+
const currentValue = seriesMetric(current, metric);
|
|
76
|
+
const comparisonValue = comparison == null ? null : seriesMetric(comparison, metric);
|
|
77
|
+
metrics[metric] = {
|
|
78
|
+
current: currentValue,
|
|
79
|
+
comparison: comparisonValue,
|
|
80
|
+
delta: currentValue == null || comparisonValue == null ? null : currentValue - comparisonValue,
|
|
81
|
+
delta_percent: percentDelta(currentValue, comparisonValue),
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
return metrics;
|
|
85
|
+
}
|
|
86
|
+
const parseKey = (key, keyFilters) => {
|
|
87
|
+
const components = (0, key_helpers_1.parseMaterializedReportKey)(key);
|
|
88
|
+
if (components == null || components.length !== keyFilters.length)
|
|
89
|
+
return null;
|
|
90
|
+
let paymentMethod = null;
|
|
91
|
+
let orderStatus = null;
|
|
92
|
+
for (let index = 0; index < keyFilters.length; index += 1) {
|
|
93
|
+
if (keyFilters[index] === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_KEY_FILTER_ENUM.PAYMENT_METHOD) {
|
|
94
|
+
paymentMethod = components[index];
|
|
95
|
+
}
|
|
96
|
+
else if (keyFilters[index] === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_KEY_FILTER_ENUM.ORDER_STATUS) {
|
|
97
|
+
orderStatus = components[index];
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
return { payment_method: paymentMethod, order_status: orderStatus };
|
|
101
|
+
};
|
|
102
|
+
const isCancelled = (orderStatus) => orderStatus === 'CANCELLED';
|
|
103
|
+
const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes('CANCELLED');
|
|
104
|
+
const matchesFilters = (parsed, filters) => {
|
|
105
|
+
if (filters.payment_methods != null &&
|
|
106
|
+
filters.payment_methods.length > 0 &&
|
|
107
|
+
(parsed.payment_method == null || !filters.payment_methods.includes(parsed.payment_method))) {
|
|
108
|
+
return false;
|
|
109
|
+
}
|
|
110
|
+
if (filters.order_statuses != null &&
|
|
111
|
+
filters.order_statuses.length > 0 &&
|
|
112
|
+
(parsed.order_status == null || !filters.order_statuses.includes(parsed.order_status))) {
|
|
113
|
+
return false;
|
|
114
|
+
}
|
|
115
|
+
return true;
|
|
116
|
+
};
|
|
117
|
+
const buildPage = (group, filters) => {
|
|
118
|
+
const keyFilters = (group.currentDocs[0]?.sale_type_key_filters ?? []);
|
|
119
|
+
const includeCancelled = includesCancelled(filters);
|
|
120
|
+
const fold = (docs) => {
|
|
121
|
+
const byKey = new Map();
|
|
122
|
+
const total = createEmptyPaymentsComparisonFormattedCountersRaw();
|
|
123
|
+
const cancelled = createEmptyPaymentsComparisonFormattedCountersRaw();
|
|
124
|
+
let matchedDocuments = 0;
|
|
125
|
+
let maxUpdatedAt = null;
|
|
126
|
+
for (const doc of docs ?? []) {
|
|
127
|
+
if (doc == null)
|
|
128
|
+
continue;
|
|
129
|
+
matchedDocuments += Number(doc.matched_documents ?? 1) || 0;
|
|
130
|
+
const updatedAt = doc.max_updated_at ?? doc.updatedAt ?? null;
|
|
131
|
+
if (updatedAt != null) {
|
|
132
|
+
const date = new Date(updatedAt);
|
|
133
|
+
if (!Number.isNaN(date.getTime()) && (maxUpdatedAt == null || date.getTime() > maxUpdatedAt.getTime())) {
|
|
134
|
+
maxUpdatedAt = date;
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
for (const [key, counters] of Object.entries(doc.payment_counters ?? {})) {
|
|
138
|
+
const parsed = parseKey(key, keyFilters);
|
|
139
|
+
if (parsed == null || !matchesFilters(parsed, filters))
|
|
140
|
+
continue;
|
|
141
|
+
const target = byKey.get(key) ?? createEmptyPaymentsComparisonFormattedCountersRaw();
|
|
142
|
+
addRaw(target, counters);
|
|
143
|
+
byKey.set(key, target);
|
|
144
|
+
if (isCancelled(parsed.order_status) && !includeCancelled) {
|
|
145
|
+
addRaw(cancelled, counters);
|
|
146
|
+
}
|
|
147
|
+
else {
|
|
148
|
+
addRaw(total, counters);
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
return { byKey, total, cancelled, matchedDocuments, maxUpdatedAt };
|
|
153
|
+
};
|
|
154
|
+
const currentFold = fold(group.currentDocs);
|
|
155
|
+
const comparisonFold = group.comparisonDocs == null ? null : fold(group.comparisonDocs);
|
|
156
|
+
const rows = [];
|
|
157
|
+
for (const key of currentFold.byKey.keys()) {
|
|
158
|
+
const parsed = parseKey(key, keyFilters);
|
|
159
|
+
if (parsed == null)
|
|
160
|
+
continue;
|
|
161
|
+
const current = (0, exports.formatPaymentsComparisonSeries)(currentFold.byKey.get(key));
|
|
162
|
+
const comparison = comparisonFold == null ? null : (0, exports.formatPaymentsComparisonSeries)(comparisonFold.byKey.get(key));
|
|
163
|
+
rows.push({
|
|
164
|
+
key,
|
|
165
|
+
payment_method: parsed.payment_method,
|
|
166
|
+
order_status: parsed.order_status,
|
|
167
|
+
current,
|
|
168
|
+
comparison,
|
|
169
|
+
metrics: buildPaymentsComparisonMetrics(current, comparison),
|
|
170
|
+
});
|
|
171
|
+
}
|
|
172
|
+
rows.sort((a, b) => b.current.counters.payment_amount - a.current.counters.payment_amount || a.key.localeCompare(b.key));
|
|
173
|
+
const methodRows = new Map();
|
|
174
|
+
for (const row of rows) {
|
|
175
|
+
if (row.payment_method == null)
|
|
176
|
+
continue;
|
|
177
|
+
if (isCancelled(row.order_status) && !includeCancelled)
|
|
178
|
+
continue;
|
|
179
|
+
const existing = methodRows.get(row.payment_method) ?? {
|
|
180
|
+
payment_method: row.payment_method,
|
|
181
|
+
current: (0, exports.formatPaymentsComparisonSeries)(undefined),
|
|
182
|
+
comparison: comparisonFold == null ? null : (0, exports.formatPaymentsComparisonSeries)(undefined),
|
|
183
|
+
metrics: {},
|
|
184
|
+
};
|
|
185
|
+
existing.current = sumFormattedSeries(existing.current, row.current);
|
|
186
|
+
if (existing.comparison != null && row.comparison != null) {
|
|
187
|
+
existing.comparison = sumFormattedSeries(existing.comparison, row.comparison);
|
|
188
|
+
}
|
|
189
|
+
methodRows.set(row.payment_method, existing);
|
|
190
|
+
}
|
|
191
|
+
for (const methodRow of methodRows.values()) {
|
|
192
|
+
methodRow.metrics = buildPaymentsComparisonMetrics(methodRow.current, methodRow.comparison);
|
|
193
|
+
}
|
|
194
|
+
const current = (0, exports.formatPaymentsComparisonSeries)(currentFold.total);
|
|
195
|
+
const comparison = comparisonFold == null ? null : (0, exports.formatPaymentsComparisonSeries)(comparisonFold.total);
|
|
196
|
+
return {
|
|
197
|
+
tenant_ids: [...group.tenantIds].sort(),
|
|
198
|
+
filters: {
|
|
199
|
+
payment_methods: filters.payment_methods != null && filters.payment_methods.length > 0 ? [...filters.payment_methods] : null,
|
|
200
|
+
order_statuses: filters.order_statuses != null && filters.order_statuses.length > 0 ? [...filters.order_statuses] : null,
|
|
201
|
+
},
|
|
202
|
+
current,
|
|
203
|
+
comparison,
|
|
204
|
+
metrics: buildPaymentsComparisonMetrics(current, comparison),
|
|
205
|
+
cancelled: (0, exports.formatPaymentsComparisonSeries)(currentFold.cancelled),
|
|
206
|
+
rows,
|
|
207
|
+
by_method: [...methodRows.values()].sort((a, b) => b.current.counters.payment_amount - a.current.counters.payment_amount ||
|
|
208
|
+
a.payment_method.localeCompare(b.payment_method)),
|
|
209
|
+
matched_documents: currentFold.matchedDocuments,
|
|
210
|
+
max_updated_at: currentFold.maxUpdatedAt,
|
|
211
|
+
};
|
|
212
|
+
};
|
|
213
|
+
function createEmptyPaymentsComparisonFormattedCountersRaw() {
|
|
214
|
+
return {
|
|
215
|
+
payment_count: 0,
|
|
216
|
+
payment_amount: 0,
|
|
217
|
+
amount_due: 0,
|
|
218
|
+
amount_paid: 0,
|
|
219
|
+
amount_refunded: 0,
|
|
220
|
+
card_charges: 0,
|
|
221
|
+
refund_count: 0,
|
|
222
|
+
unpaid_count: 0,
|
|
223
|
+
};
|
|
224
|
+
}
|
|
225
|
+
function addRaw(target, source) {
|
|
226
|
+
target.payment_count += source.payment_count ?? 0;
|
|
227
|
+
target.payment_amount += source.payment_amount ?? 0;
|
|
228
|
+
target.amount_due += source.amount_due ?? 0;
|
|
229
|
+
target.amount_paid += source.amount_paid ?? 0;
|
|
230
|
+
target.amount_refunded += source.amount_refunded ?? 0;
|
|
231
|
+
target.card_charges += source.card_charges ?? 0;
|
|
232
|
+
target.refund_count += source.refund_count ?? 0;
|
|
233
|
+
target.unpaid_count += source.unpaid_count ?? 0;
|
|
234
|
+
}
|
|
235
|
+
function sumFormattedSeries(a, b) {
|
|
236
|
+
const counters = {
|
|
237
|
+
payment_count: a.counters.payment_count + b.counters.payment_count,
|
|
238
|
+
payment_amount: a.counters.payment_amount + b.counters.payment_amount,
|
|
239
|
+
amount_due: a.counters.amount_due + b.counters.amount_due,
|
|
240
|
+
amount_paid: a.counters.amount_paid + b.counters.amount_paid,
|
|
241
|
+
amount_refunded: a.counters.amount_refunded + b.counters.amount_refunded,
|
|
242
|
+
card_charges: a.counters.card_charges + b.counters.card_charges,
|
|
243
|
+
refund_count: a.counters.refund_count + b.counters.refund_count,
|
|
244
|
+
unpaid_count: a.counters.unpaid_count + b.counters.unpaid_count,
|
|
245
|
+
};
|
|
246
|
+
return {
|
|
247
|
+
counters,
|
|
248
|
+
average_payment: counters.payment_count > 0 ? counters.payment_amount / counters.payment_count : null,
|
|
249
|
+
};
|
|
250
|
+
}
|
|
251
|
+
function getFormattedTenantPaymentsComparisonReporting(currentDocs, comparisonDocs, filters = null, separate_view_per_tenant = false) {
|
|
252
|
+
if (!Array.isArray(currentDocs) || currentDocs.length === 0)
|
|
253
|
+
return null;
|
|
254
|
+
if (currentDocs.some((doc) => doc == null))
|
|
255
|
+
return null;
|
|
256
|
+
if (comparisonDocs != null && !Array.isArray(comparisonDocs))
|
|
257
|
+
return null;
|
|
258
|
+
if (filters != null) {
|
|
259
|
+
if (filters.payment_methods != null && !Array.isArray(filters.payment_methods))
|
|
260
|
+
return null;
|
|
261
|
+
if (filters.order_statuses != null && !Array.isArray(filters.order_statuses))
|
|
262
|
+
return null;
|
|
263
|
+
}
|
|
264
|
+
const resolvedFilters = filters ?? {};
|
|
265
|
+
const signature = (currentDocs[0].sale_type_key_filters ?? []).join(':');
|
|
266
|
+
for (const doc of [...currentDocs, ...(comparisonDocs ?? [])]) {
|
|
267
|
+
if ((doc.sale_type_key_filters ?? []).join(':') !== signature)
|
|
268
|
+
return null;
|
|
269
|
+
}
|
|
270
|
+
const usableCurrent = currentDocs.filter((doc) => doc.payment_counters != null);
|
|
271
|
+
if (usableCurrent.length === 0)
|
|
272
|
+
return null;
|
|
273
|
+
const allTenantIds = [...new Set(usableCurrent.map((doc) => String(doc.tenant_id)))].sort();
|
|
274
|
+
const scopes = separate_view_per_tenant ? allTenantIds.map((tenantId) => [tenantId]) : [allTenantIds];
|
|
275
|
+
const pages = [];
|
|
276
|
+
for (const scope of scopes) {
|
|
277
|
+
const currentForScope = usableCurrent.filter((doc) => scope.includes(String(doc.tenant_id)));
|
|
278
|
+
if (currentForScope.length === 0)
|
|
279
|
+
continue;
|
|
280
|
+
const comparisonForScope = comparisonDocs == null ? null : comparisonDocs.filter((doc) => scope.includes(String(doc.tenant_id)));
|
|
281
|
+
const page = buildPage({ tenantIds: scope, currentDocs: currentForScope, comparisonDocs: comparisonForScope }, resolvedFilters);
|
|
282
|
+
if (page != null)
|
|
283
|
+
pages.push(page);
|
|
284
|
+
}
|
|
285
|
+
return pages.length === 0 ? null : [pages, null];
|
|
286
|
+
}
|