@managesome/eposmatic-toolkit 0.4.9 → 0.4.11
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 +455 -0
- package/esm/constants/enums/delivery.js +8 -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 +248 -0
- package/esm/helpers/materialized-reports/materialized-cash-close-day-helpers.js +396 -0
- package/esm/helpers/materialized-reports/materialized-cash-compile-helpers.js +245 -0
- package/esm/helpers/materialized-reports/materialized-delivery-accumulator-helpers.js +170 -0
- package/esm/helpers/materialized-reports/materialized-delivery-classification-helpers.js +430 -0
- package/esm/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +373 -0
- package/esm/helpers/materialized-reports/materialized-delivery-compile-helpers.js +216 -0
- package/esm/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +319 -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 +115 -0
- package/esm/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +89 -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 +477 -0
- package/esm/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +201 -0
- package/esm/helpers/materialized-reports/materialized-reports-scope-group-helpers.js +9 -6
- package/esm/helpers/materialized-reports/materialized-reports-selection-helpers.js +11 -4
- package/esm/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +189 -0
- package/esm/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +156 -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 +157 -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 +238 -0
- package/esm/helpers/materialized-reports/tenant-payments-comparison-formatter.js +282 -0
- package/esm/helpers/materialized-reports/tenant-prep-time-formatter.js +228 -0
- package/esm/helpers/materialized-reports/tenant-sales-comparison-formatter.js +346 -0
- package/esm/helpers/reporting-contract/index.js +2 -0
- package/esm/helpers/reporting-contract/overview-contract.js +123 -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 +53 -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/helpers/store/common-order-actions.js +3 -2
- package/esm/schemas/models/deliveries.js +82 -1
- package/esm/schemas/models/index.js +15 -0
- package/esm/schemas/models/materialized_credit_bills.js +1 -1
- 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/models/materialized_tenant_sales_overview_reports.js +1 -1
- 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 +345 -2
- package/lib/constants/MATERIALIZED_REPORTS.js +457 -1
- package/lib/constants/enums/delivery.d.ts +7 -0
- package/lib/constants/enums/delivery.js +9 -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 +142 -0
- package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.js +257 -0
- package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.d.ts +103 -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 +73 -0
- package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.js +252 -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 +113 -0
- package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.js +442 -0
- package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.d.ts +98 -0
- package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +386 -0
- package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.d.ts +41 -0
- package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +220 -0
- package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.d.ts +52 -0
- package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +325 -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 +120 -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 +99 -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 +98 -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 +130 -0
- package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +491 -0
- package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.d.ts +47 -0
- package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +208 -0
- package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.d.ts +6 -3
- package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.js +8 -5
- package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.d.ts +8 -0
- package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.js +10 -3
- 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 +160 -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 +160 -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 +244 -0
- package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.d.ts +75 -0
- package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.js +289 -0
- package/lib/helpers/materialized-reports/tenant-prep-time-formatter.d.ts +98 -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 +352 -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 +127 -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 +51 -0
- package/lib/helpers/rider-earnings/rider-earnings.js +57 -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 +28 -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/store/common-order-actions.js +3 -2
- package/lib/helpers/types/materialized-reports-apis.d.ts +300 -1
- package/lib/schemas/models/deliveries.d.ts +58 -1
- package/lib/schemas/models/deliveries.js +81 -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_credit_bills.d.ts +3 -3
- package/lib/schemas/models/materialized_credit_bills.js +1 -1
- 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/materialized_tenant_sales_overview_reports.d.ts +3 -3
- package/lib/schemas/models/materialized_tenant_sales_overview_reports.js +1 -1
- 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/schemas/types/materialized_tenant_sales_overview_reports.d.ts +7 -0
- package/lib/tests/deliveries-schema.test.d.ts +1 -0
- package/lib/tests/deliveries-schema.test.js +70 -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 +197 -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 +153 -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 +242 -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 +142 -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 +271 -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-reports-scope-group-helpers.test.js +13 -13
- 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 +207 -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
|
@@ -33,6 +33,8 @@ export declare const SaleOrderDeliveriesSchema: Schema<any, import("mongoose").M
|
|
|
33
33
|
doc_kind: import("../../constants").WAREHOUSE_SALE_ORDER_PHYSICAL_DOC_KIND_ENUM;
|
|
34
34
|
sale_order_id: import("mongoose").Types.ObjectId;
|
|
35
35
|
cancel_reason?: string | null | undefined;
|
|
36
|
+
delivered_at?: NativeDate | null | undefined;
|
|
37
|
+
cancelled_at?: NativeDate | null | undefined;
|
|
36
38
|
inventory_consumed?: boolean | null | undefined;
|
|
37
39
|
notes?: string | null | undefined;
|
|
38
40
|
created_by?: {
|
|
@@ -43,9 +45,7 @@ export declare const SaleOrderDeliveriesSchema: Schema<any, import("mongoose").M
|
|
|
43
45
|
_id: string;
|
|
44
46
|
name: string;
|
|
45
47
|
} | null | undefined;
|
|
46
|
-
cancelled_at?: NativeDate | null | undefined;
|
|
47
48
|
applied_to_doc_id?: import("mongoose").Types.ObjectId | null | undefined;
|
|
48
|
-
delivered_at?: NativeDate | null | undefined;
|
|
49
49
|
delivered_by?: {
|
|
50
50
|
_id: string;
|
|
51
51
|
name: string;
|
|
@@ -85,6 +85,8 @@ export declare const SaleOrderDeliveriesSchema: Schema<any, import("mongoose").M
|
|
|
85
85
|
doc_kind: import("../../constants").WAREHOUSE_SALE_ORDER_PHYSICAL_DOC_KIND_ENUM;
|
|
86
86
|
sale_order_id: import("mongoose").Types.ObjectId;
|
|
87
87
|
cancel_reason?: string | null | undefined;
|
|
88
|
+
delivered_at?: NativeDate | null | undefined;
|
|
89
|
+
cancelled_at?: NativeDate | null | undefined;
|
|
88
90
|
inventory_consumed?: boolean | null | undefined;
|
|
89
91
|
notes?: string | null | undefined;
|
|
90
92
|
created_by?: {
|
|
@@ -95,9 +97,7 @@ export declare const SaleOrderDeliveriesSchema: Schema<any, import("mongoose").M
|
|
|
95
97
|
_id: string;
|
|
96
98
|
name: string;
|
|
97
99
|
} | null | undefined;
|
|
98
|
-
cancelled_at?: NativeDate | null | undefined;
|
|
99
100
|
applied_to_doc_id?: import("mongoose").Types.ObjectId | null | undefined;
|
|
100
|
-
delivered_at?: NativeDate | null | undefined;
|
|
101
101
|
delivered_by?: {
|
|
102
102
|
_id: string;
|
|
103
103
|
name: string;
|
|
@@ -137,6 +137,8 @@ export declare const SaleOrderDeliveriesSchema: Schema<any, import("mongoose").M
|
|
|
137
137
|
doc_kind: import("../../constants").WAREHOUSE_SALE_ORDER_PHYSICAL_DOC_KIND_ENUM;
|
|
138
138
|
sale_order_id: import("mongoose").Types.ObjectId;
|
|
139
139
|
cancel_reason?: string | null | undefined;
|
|
140
|
+
delivered_at?: NativeDate | null | undefined;
|
|
141
|
+
cancelled_at?: NativeDate | null | undefined;
|
|
140
142
|
inventory_consumed?: boolean | null | undefined;
|
|
141
143
|
notes?: string | null | undefined;
|
|
142
144
|
created_by?: {
|
|
@@ -147,9 +149,7 @@ export declare const SaleOrderDeliveriesSchema: Schema<any, import("mongoose").M
|
|
|
147
149
|
_id: string;
|
|
148
150
|
name: string;
|
|
149
151
|
} | null | undefined;
|
|
150
|
-
cancelled_at?: NativeDate | null | undefined;
|
|
151
152
|
applied_to_doc_id?: import("mongoose").Types.ObjectId | null | undefined;
|
|
152
|
-
delivered_at?: NativeDate | null | undefined;
|
|
153
153
|
delivered_by?: {
|
|
154
154
|
_id: string;
|
|
155
155
|
name: string;
|
|
@@ -41,6 +41,7 @@ export declare const WarehouseSaleOrderInvoiceSchema: Schema<any, import("mongoo
|
|
|
41
41
|
invoice_type: import("../../constants").WAREHOUSE_SALE_ORDER_INVOICE_TYPE_ENUM;
|
|
42
42
|
amount_paid?: number | null | undefined;
|
|
43
43
|
cancel_reason?: string | null | undefined;
|
|
44
|
+
cancelled_at?: NativeDate | null | undefined;
|
|
44
45
|
is_gst_inclusive?: boolean | null | undefined;
|
|
45
46
|
gst?: number | null | undefined;
|
|
46
47
|
gst_amount?: number | null | undefined;
|
|
@@ -53,7 +54,6 @@ export declare const WarehouseSaleOrderInvoiceSchema: Schema<any, import("mongoo
|
|
|
53
54
|
_id: string;
|
|
54
55
|
name: string;
|
|
55
56
|
} | null | undefined;
|
|
56
|
-
cancelled_at?: NativeDate | null | undefined;
|
|
57
57
|
applied_to_doc_id?: import("mongoose").Types.ObjectId | null | undefined;
|
|
58
58
|
down_payment_value?: number | null | undefined;
|
|
59
59
|
posted_by?: {
|
|
@@ -113,6 +113,7 @@ export declare const WarehouseSaleOrderInvoiceSchema: Schema<any, import("mongoo
|
|
|
113
113
|
invoice_type: import("../../constants").WAREHOUSE_SALE_ORDER_INVOICE_TYPE_ENUM;
|
|
114
114
|
amount_paid?: number | null | undefined;
|
|
115
115
|
cancel_reason?: string | null | undefined;
|
|
116
|
+
cancelled_at?: NativeDate | null | undefined;
|
|
116
117
|
is_gst_inclusive?: boolean | null | undefined;
|
|
117
118
|
gst?: number | null | undefined;
|
|
118
119
|
gst_amount?: number | null | undefined;
|
|
@@ -125,7 +126,6 @@ export declare const WarehouseSaleOrderInvoiceSchema: Schema<any, import("mongoo
|
|
|
125
126
|
_id: string;
|
|
126
127
|
name: string;
|
|
127
128
|
} | null | undefined;
|
|
128
|
-
cancelled_at?: NativeDate | null | undefined;
|
|
129
129
|
applied_to_doc_id?: import("mongoose").Types.ObjectId | null | undefined;
|
|
130
130
|
down_payment_value?: number | null | undefined;
|
|
131
131
|
posted_by?: {
|
|
@@ -185,6 +185,7 @@ export declare const WarehouseSaleOrderInvoiceSchema: Schema<any, import("mongoo
|
|
|
185
185
|
invoice_type: import("../../constants").WAREHOUSE_SALE_ORDER_INVOICE_TYPE_ENUM;
|
|
186
186
|
amount_paid?: number | null | undefined;
|
|
187
187
|
cancel_reason?: string | null | undefined;
|
|
188
|
+
cancelled_at?: NativeDate | null | undefined;
|
|
188
189
|
is_gst_inclusive?: boolean | null | undefined;
|
|
189
190
|
gst?: number | null | undefined;
|
|
190
191
|
gst_amount?: number | null | undefined;
|
|
@@ -197,7 +198,6 @@ export declare const WarehouseSaleOrderInvoiceSchema: Schema<any, import("mongoo
|
|
|
197
198
|
_id: string;
|
|
198
199
|
name: string;
|
|
199
200
|
} | null | undefined;
|
|
200
|
-
cancelled_at?: NativeDate | null | undefined;
|
|
201
201
|
applied_to_doc_id?: import("mongoose").Types.ObjectId | null | undefined;
|
|
202
202
|
down_payment_value?: number | null | undefined;
|
|
203
203
|
posted_by?: {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CURRENCY_SYMBOL_ENUM, DELIVERY_STATUS_ENUM } from '../../constants';
|
|
1
|
+
import { CURRENCY_SYMBOL_ENUM, DELIVERY_STATUS_ENUM, RIDER_EARNINGS_STATUS_ENUM, RIDER_FEE_TYPE_ENUM } from '../../constants';
|
|
2
2
|
import { IOrder } from './orders';
|
|
3
3
|
export interface IDelivery {
|
|
4
4
|
_id: string;
|
|
@@ -15,16 +15,55 @@ export interface IDelivery {
|
|
|
15
15
|
tenant_phone_numbers: string[];
|
|
16
16
|
status: DELIVERY_STATUS_ENUM;
|
|
17
17
|
cancel_reason?: string | null;
|
|
18
|
+
/** Tenant-local business date, copied from the order at creation. */
|
|
19
|
+
localDate?: string | null;
|
|
18
20
|
polyline: [number, number][];
|
|
19
21
|
distance_in_meters_from_store: number;
|
|
20
22
|
rider_revenue?: number | null;
|
|
21
23
|
pickup_food_image_url?: string | null;
|
|
22
24
|
dropoff_food_image_url?: string | null;
|
|
23
25
|
tracking_enabled?: boolean;
|
|
26
|
+
/** status -> ASSIGNED (the rider accepted). */
|
|
27
|
+
assigned_at?: Date | null;
|
|
28
|
+
/** status -> IN_PROGRESS (the food was collected). */
|
|
29
|
+
picked_up_at?: Date | null;
|
|
30
|
+
/** Frozen customer promise, resolved when the delivery is created. */
|
|
31
|
+
expected_delivery_at?: Date | null;
|
|
32
|
+
/** status -> COMPLETED. The only exact completion instant. */
|
|
33
|
+
delivered_at?: Date | null;
|
|
34
|
+
/** status -> CANCELLED. */
|
|
35
|
+
cancelled_at?: Date | null;
|
|
36
|
+
/** Incremented on every status write - churn / reassignment signal. */
|
|
37
|
+
status_updated_count?: number | null;
|
|
38
|
+
/** Stored duration at COMPLETED (minutes). */
|
|
39
|
+
delivery_minutes?: number | null;
|
|
40
|
+
/**
|
|
41
|
+
* Server-owned rider payout snapshot. The customer delivery fee is NOT this
|
|
42
|
+
* number: for distance-based rules the rider fee is independent of the order.
|
|
43
|
+
* Kept alongside `rider_revenue` so historical pay does not move when tenant
|
|
44
|
+
* settings change.
|
|
45
|
+
*/
|
|
46
|
+
rider_earnings?: IRiderEarningsSnapshot | null;
|
|
24
47
|
createdAt_mins: number;
|
|
25
48
|
createdAt: Date;
|
|
26
49
|
updatedAt: Date;
|
|
27
50
|
}
|
|
51
|
+
export interface IRiderEarningsSnapshot {
|
|
52
|
+
/** CENTS. */
|
|
53
|
+
amount: number;
|
|
54
|
+
status: RIDER_EARNINGS_STATUS_ENUM;
|
|
55
|
+
rule_type: RIDER_FEE_TYPE_ENUM;
|
|
56
|
+
/** Raw tenant value, scaled by 100000. */
|
|
57
|
+
per_meter: number;
|
|
58
|
+
/** Distance rounding step in metres (static_rider_revenue_multiplier). */
|
|
59
|
+
distance_step: number;
|
|
60
|
+
/** Distance after the rounding step. */
|
|
61
|
+
distance_meters: number;
|
|
62
|
+
/** Customer delivery fee in CENTS at the time of calculation. */
|
|
63
|
+
delivery_charge: number;
|
|
64
|
+
calculated_at: Date | null;
|
|
65
|
+
version: number;
|
|
66
|
+
}
|
|
28
67
|
export interface IDeliveryOrder extends IDelivery {
|
|
29
68
|
order: IOrder;
|
|
30
69
|
}
|
|
@@ -32,6 +32,15 @@ export * from './item_transactions';
|
|
|
32
32
|
export * from './items';
|
|
33
33
|
export * from './marketing_fingerprints';
|
|
34
34
|
export * from './materialized_credit_bills';
|
|
35
|
+
export * from './materialized_tenant_discount_entries';
|
|
36
|
+
export * from './materialized_tenant_discount_reports';
|
|
37
|
+
export * from './materialized_tenant_cash_entries';
|
|
38
|
+
export * from './materialized_tenant_delivery_entries';
|
|
39
|
+
export * from './materialized_tenant_delivery_reports';
|
|
40
|
+
export * from './materialized_rider_daily_reports';
|
|
41
|
+
export * from './materialized_tenant_cash_reports';
|
|
42
|
+
export * from './materialized_tenant_prep_time_entries';
|
|
43
|
+
export * from './materialized_tenant_prep_time_reports';
|
|
35
44
|
export * from './materialized_tenant_reports_iterations';
|
|
36
45
|
export * from './materialized_tenant_sales_overview_reports';
|
|
37
46
|
export * from './menus';
|
|
@@ -114,3 +123,9 @@ export * from './warehouse_vendors';
|
|
|
114
123
|
export * from './warehouse_void_purchase_order_items';
|
|
115
124
|
export * from './warehouse_void_sale_order_items';
|
|
116
125
|
export * from './warehouses';
|
|
126
|
+
export * from './materialized_tenant_sales_comparison_reports';
|
|
127
|
+
export * from './materialized_tenant_sales_comparison_entries';
|
|
128
|
+
export * from './materialized_tenant_hourly_comparison_reports';
|
|
129
|
+
export * from './materialized_tenant_hourly_comparison_entries';
|
|
130
|
+
export * from './materialized_tenant_payments_comparison_reports';
|
|
131
|
+
export * from './materialized_tenant_payments_comparison_entries';
|
|
@@ -48,6 +48,15 @@ __exportStar(require("./item_transactions"), exports);
|
|
|
48
48
|
__exportStar(require("./items"), exports);
|
|
49
49
|
__exportStar(require("./marketing_fingerprints"), exports);
|
|
50
50
|
__exportStar(require("./materialized_credit_bills"), exports);
|
|
51
|
+
__exportStar(require("./materialized_tenant_discount_entries"), exports);
|
|
52
|
+
__exportStar(require("./materialized_tenant_discount_reports"), exports);
|
|
53
|
+
__exportStar(require("./materialized_tenant_cash_entries"), exports);
|
|
54
|
+
__exportStar(require("./materialized_tenant_delivery_entries"), exports);
|
|
55
|
+
__exportStar(require("./materialized_tenant_delivery_reports"), exports);
|
|
56
|
+
__exportStar(require("./materialized_rider_daily_reports"), exports);
|
|
57
|
+
__exportStar(require("./materialized_tenant_cash_reports"), exports);
|
|
58
|
+
__exportStar(require("./materialized_tenant_prep_time_entries"), exports);
|
|
59
|
+
__exportStar(require("./materialized_tenant_prep_time_reports"), exports);
|
|
51
60
|
__exportStar(require("./materialized_tenant_reports_iterations"), exports);
|
|
52
61
|
__exportStar(require("./materialized_tenant_sales_overview_reports"), exports);
|
|
53
62
|
__exportStar(require("./menus"), exports);
|
|
@@ -130,3 +139,9 @@ __exportStar(require("./warehouse_vendors"), exports);
|
|
|
130
139
|
__exportStar(require("./warehouse_void_purchase_order_items"), exports);
|
|
131
140
|
__exportStar(require("./warehouse_void_sale_order_items"), exports);
|
|
132
141
|
__exportStar(require("./warehouses"), exports);
|
|
142
|
+
__exportStar(require("./materialized_tenant_sales_comparison_reports"), exports);
|
|
143
|
+
__exportStar(require("./materialized_tenant_sales_comparison_entries"), exports);
|
|
144
|
+
__exportStar(require("./materialized_tenant_hourly_comparison_reports"), exports);
|
|
145
|
+
__exportStar(require("./materialized_tenant_hourly_comparison_entries"), exports);
|
|
146
|
+
__exportStar(require("./materialized_tenant_payments_comparison_reports"), exports);
|
|
147
|
+
__exportStar(require("./materialized_tenant_payments_comparison_entries"), exports);
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One rider-day aggregate, deliberately RIDER-SCOPED rather than tenant-scoped.
|
|
3
|
+
*
|
|
4
|
+
* A rider can work for multiple tenants in one day, so the document keeps a
|
|
5
|
+
* bounded per-tenant breakdown alongside the rider's total. No tenant_id is a
|
|
6
|
+
* partition key here; the rider owns the document.
|
|
7
|
+
*/
|
|
8
|
+
export interface IMaterializedRiderDailyTenant {
|
|
9
|
+
deliveries: number;
|
|
10
|
+
completed: number;
|
|
11
|
+
cancelled: number;
|
|
12
|
+
/** Rider payout in CENTS, from FINAL delivery snapshots only. */
|
|
13
|
+
earnings: number;
|
|
14
|
+
distance_meters: number;
|
|
15
|
+
}
|
|
16
|
+
export interface IMaterializedRiderDailyReport {
|
|
17
|
+
_id?: string;
|
|
18
|
+
rider_id: string;
|
|
19
|
+
/** Tenant-local business date, `YYYY-MM-DD`. */
|
|
20
|
+
local_date: string;
|
|
21
|
+
deliveries: number;
|
|
22
|
+
completed: number;
|
|
23
|
+
cancelled: number;
|
|
24
|
+
/** Rider payout in CENTS. */
|
|
25
|
+
earnings: number;
|
|
26
|
+
distance_meters: number;
|
|
27
|
+
on_time: number;
|
|
28
|
+
late: number;
|
|
29
|
+
tenants: Record<string, IMaterializedRiderDailyTenant>;
|
|
30
|
+
first_delivery_at: Date | null;
|
|
31
|
+
last_delivery_at: Date | null;
|
|
32
|
+
schema_version: number;
|
|
33
|
+
source_watermark: Date;
|
|
34
|
+
computed_at: Date;
|
|
35
|
+
createdAt?: Date;
|
|
36
|
+
updatedAt?: Date;
|
|
37
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { DAY_INDEX_ENUM } from '../../constants/ENUMS';
|
|
2
|
+
import { CASH_IN_OUT_REF_ENUM, CASH_IN_OUT_TYPE_ENUM } from '../../constants/enums/cash';
|
|
3
|
+
import { MATERIALIZED_REPORT_KEY_FILTER_ENUM, MATERIALIZED_REPORT_SCOPE_ENUM } from '../../constants/MATERIALIZED_REPORTS';
|
|
4
|
+
/**
|
|
5
|
+
* Types for `materialized_tenant_cash_in_out_entries` (M3, decision (e3)).
|
|
6
|
+
*
|
|
7
|
+
* The STATEMENT rows behind the cash report drill-down - deliberately the same
|
|
8
|
+
* row language the POS ledger already renders (`CashDrawerMovements.tsx`):
|
|
9
|
+
* Detail (time, staff, note) / Before / signed Amount / After. An operator reading
|
|
10
|
+
* the report and an operator reading the drawer screen must see the same shape.
|
|
11
|
+
*
|
|
12
|
+
* Month-capped like the other entry collections: statement volume per month is the
|
|
13
|
+
* largest of any report here.
|
|
14
|
+
*/
|
|
15
|
+
/** One statement row. */
|
|
16
|
+
export interface IMaterializedCashEntry {
|
|
17
|
+
/** The source ledger row id - part of the page cursor. */
|
|
18
|
+
cash_in_out_id: string;
|
|
19
|
+
/**
|
|
20
|
+
* Stable identity INSIDE its drawer-day, used as the cursor tie-breaker. The
|
|
21
|
+
* source id is globally unique, but pairing it with the day keeps a page stable
|
|
22
|
+
* even if a ledger row is ever re-created with a new id.
|
|
23
|
+
*/
|
|
24
|
+
entry_key: string;
|
|
25
|
+
drawer_id: string;
|
|
26
|
+
drawer_name: string | null;
|
|
27
|
+
day_id: string;
|
|
28
|
+
shift_id: string | null;
|
|
29
|
+
shift_number: number | null;
|
|
30
|
+
type: CASH_IN_OUT_TYPE_ENUM;
|
|
31
|
+
ref_type: CASH_IN_OUT_REF_ENUM;
|
|
32
|
+
ref_id: string | null;
|
|
33
|
+
/** CENTS, UNSIGNED - the magnitude as stored. */
|
|
34
|
+
amount: number;
|
|
35
|
+
/** CENTS, SIGNED: positive for CASH_IN, negative for CASH_OUT. */
|
|
36
|
+
signed_amount: number;
|
|
37
|
+
drawer_balance_before: number;
|
|
38
|
+
drawer_balance_after: number;
|
|
39
|
+
staff_id: string | null;
|
|
40
|
+
staff_name: string | null;
|
|
41
|
+
note: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* True when this row is a REOPEN re-baseline: `ref_type = DRAWER` AND
|
|
44
|
+
* `type = CASH_IN` AND the note matches the reopen prefix (decision (i3)).
|
|
45
|
+
* Flagged at COMPILE time so the read never re-derives it - the classifier
|
|
46
|
+
* lives in one place, unit-tested, instead of being spread across the reader.
|
|
47
|
+
*/
|
|
48
|
+
is_reopen: boolean;
|
|
49
|
+
/** True for the OPENING float row (the other `ref_type = DRAWER` / `CASH_IN` case). */
|
|
50
|
+
is_opening_float: boolean;
|
|
51
|
+
/** True for the count-out row written at close. */
|
|
52
|
+
is_count_out: boolean;
|
|
53
|
+
/** True for an over/short sweep written by the close. */
|
|
54
|
+
is_system_adjustment: boolean;
|
|
55
|
+
created_at: Date;
|
|
56
|
+
/** `YYYY-MM-DD HH` punch hour (null when unresolvable). */
|
|
57
|
+
local_hour: string | null;
|
|
58
|
+
}
|
|
59
|
+
/** Per-key row section of one document (rows may be empty, never absent-on-zero). */
|
|
60
|
+
export interface IMaterializedCashKeySection {
|
|
61
|
+
rows: IMaterializedCashEntry[];
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* One `materialized_tenant_cash_in_out_entries` document - tenant x scope context
|
|
65
|
+
* x scope value, capped at `LOCAL_MONTH`.
|
|
66
|
+
*
|
|
67
|
+
* Rows carry no `tenant_id`: the DOCUMENT carries it, and the reads always address
|
|
68
|
+
* documents by tenant.
|
|
69
|
+
*/
|
|
70
|
+
export interface IMaterializedTenantCashEntries {
|
|
71
|
+
_id: string;
|
|
72
|
+
tenant_id: string;
|
|
73
|
+
brand_id: string;
|
|
74
|
+
scope_context: MATERIALIZED_REPORT_SCOPE_ENUM;
|
|
75
|
+
scope_field: string;
|
|
76
|
+
/** Denormalized weekday - set ONLY on `LOCAL_DATE` documents. */
|
|
77
|
+
day_index?: DAY_INDEX_ENUM | null;
|
|
78
|
+
sale_type_key_filters: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
|
|
79
|
+
/** One row section per observed key; null when there are no rows at all. */
|
|
80
|
+
cash_entries: Record<string, IMaterializedCashKeySection> | null;
|
|
81
|
+
iteration?: number;
|
|
82
|
+
schema_version: number;
|
|
83
|
+
source_watermark: Date;
|
|
84
|
+
computed_at: Date;
|
|
85
|
+
createdAt: Date;
|
|
86
|
+
updatedAt: Date;
|
|
87
|
+
}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { DAY_INDEX_ENUM } from '../../constants/ENUMS';
|
|
2
|
+
import { CASH_IN_OUT_REF_ENUM } from '../../constants/enums/cash';
|
|
3
|
+
import { MATERIALIZED_REPORT_KEY_FILTER_ENUM, MATERIALIZED_REPORT_SCOPE_ENUM } from '../../constants/MATERIALIZED_REPORTS';
|
|
4
|
+
/**
|
|
5
|
+
* Types for `materialized_tenant_cash_in_out_reports` (M3).
|
|
6
|
+
*
|
|
7
|
+
* Cash is the one report where a naive "sum of ins minus sum of outs" is WRONG:
|
|
8
|
+
* the ledger contains the opening float, one float-shaped row per reopen, and an
|
|
9
|
+
* over/short sweep written at close. So the report publishes THREE nets side by
|
|
10
|
+
* side and reconciles them explicitly:
|
|
11
|
+
*
|
|
12
|
+
* ledger_net = operator.net + lifecycle.reopen_amount + system.net
|
|
13
|
+
*
|
|
14
|
+
* with two cross-collection checks the harness asserts:
|
|
15
|
+
* operator.net == sessions.net_movements_amount (same quantity, other source)
|
|
16
|
+
* system.net == -sessions.variance_amount (the sweep reverses the variance)
|
|
17
|
+
*
|
|
18
|
+
* SIGN CONVENTION (source-verified at cash-drawer-sessions.ts:543):
|
|
19
|
+
* `closing.difference = expected - counted`, so POSITIVE = SHORT (under) and
|
|
20
|
+
* NEGATIVE = OVER (above) - the opposite of the intuitive counted-minus-expected.
|
|
21
|
+
*/
|
|
22
|
+
/** In/out split of one breakdown bucket (all amounts CENTS, unsigned). */
|
|
23
|
+
export interface IMaterializedCashFlow {
|
|
24
|
+
in_count: number;
|
|
25
|
+
in_amount: number;
|
|
26
|
+
out_count: number;
|
|
27
|
+
out_amount: number;
|
|
28
|
+
}
|
|
29
|
+
/** A flow bucket that also carries its row count and its signed net. */
|
|
30
|
+
export interface IMaterializedCashNetFlow extends IMaterializedCashFlow {
|
|
31
|
+
/** Rows in this bucket (in + out). */
|
|
32
|
+
count: number;
|
|
33
|
+
/** `in_amount - out_amount`, SIGNED. */
|
|
34
|
+
net: number;
|
|
35
|
+
}
|
|
36
|
+
/** The lifecycle (non-operator) rows: the float, every reopen, and the count-out. */
|
|
37
|
+
export interface IMaterializedCashLifecycle {
|
|
38
|
+
/** The opening float - ONE per session, even after reopens. */
|
|
39
|
+
float_count: number;
|
|
40
|
+
float_amount: number;
|
|
41
|
+
/** Reopen re-baselines: one ledger row per reopen. */
|
|
42
|
+
reopen_count: number;
|
|
43
|
+
reopen_amount: number;
|
|
44
|
+
/** The count-out row written at close. */
|
|
45
|
+
countout_count: number;
|
|
46
|
+
countout_amount: number;
|
|
47
|
+
}
|
|
48
|
+
/** Everything the ledger holds, plus the operator-only split. */
|
|
49
|
+
export interface IMaterializedCashMovements {
|
|
50
|
+
/** ALL `tenant_cash_in_out` rows in scope. */
|
|
51
|
+
count: number;
|
|
52
|
+
in_count: number;
|
|
53
|
+
in_amount: number;
|
|
54
|
+
out_count: number;
|
|
55
|
+
out_amount: number;
|
|
56
|
+
/** The STATEMENT net: `in_amount - out_amount`, including lifecycle + system. */
|
|
57
|
+
ledger_net: number;
|
|
58
|
+
/** What the operators actually moved - excludes float, reopens and sweeps. */
|
|
59
|
+
operator: IMaterializedCashNetFlow;
|
|
60
|
+
/** Float + reopen + count-out. */
|
|
61
|
+
lifecycle: IMaterializedCashLifecycle;
|
|
62
|
+
/** SYSTEM_ADJUSTMENT sweeps written at close (over/short). */
|
|
63
|
+
system: IMaterializedCashNetFlow;
|
|
64
|
+
/** One row per ref type - a BREAKDOWN, never an addition to the totals. */
|
|
65
|
+
by_ref: Record<string, IMaterializedCashFlow>;
|
|
66
|
+
/** Distinct `staff_id`s that touched a drawer in scope. */
|
|
67
|
+
staff_count: number;
|
|
68
|
+
/**
|
|
69
|
+
* The distinct staff ids behind `staff_count`, sorted. Present because
|
|
70
|
+
* `staff_count` is NOT additive: summing two days double-counts anyone who
|
|
71
|
+
* worked both, so a PERIOD document unions these instead of summing the
|
|
72
|
+
* counts. Fold-support, exactly like the min/max fold in the prep time report -
|
|
73
|
+
* you cannot add distinct counts, so the fold needs the underlying set.
|
|
74
|
+
* Bounded by the staff per drawer-ref per day, which is small.
|
|
75
|
+
*/
|
|
76
|
+
staff_ids?: string[] | null;
|
|
77
|
+
}
|
|
78
|
+
/** What the SESSION collection says - the second source, independently summed. */
|
|
79
|
+
export interface IMaterializedCashSessions {
|
|
80
|
+
/** Distinct (drawer, day) lives touched. */
|
|
81
|
+
session_count: number;
|
|
82
|
+
/** Sum of `reopened_times`. */
|
|
83
|
+
reopen_count: number;
|
|
84
|
+
/** Sessions reopened at least once. */
|
|
85
|
+
reopened_session_count: number;
|
|
86
|
+
/** Sum of `opening.cash_amount` - counted ONCE per session, reopens included. */
|
|
87
|
+
opening_float_amount: number;
|
|
88
|
+
/** Sum of `session.net_movements` - the write path operator net, reopen-exempt. */
|
|
89
|
+
net_movements_amount: number;
|
|
90
|
+
expected_close_amount: number;
|
|
91
|
+
counted_close_amount: number;
|
|
92
|
+
/** Sum of `closing.difference`, SIGNED (positive = short). */
|
|
93
|
+
variance_amount: number;
|
|
94
|
+
variance_positive_count: number;
|
|
95
|
+
variance_negative_count: number;
|
|
96
|
+
/** Still IN_USE at scope end. */
|
|
97
|
+
open_sessions_count: number;
|
|
98
|
+
/** Closed with no closing record - a data-integrity tripwire. */
|
|
99
|
+
unmatched_close_count: number;
|
|
100
|
+
}
|
|
101
|
+
/** The per-key counter block. */
|
|
102
|
+
export interface IMaterializedCashCounters {
|
|
103
|
+
movements: IMaterializedCashMovements;
|
|
104
|
+
sessions: IMaterializedCashSessions;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* The SAME counters as an ARRAY OF ROWS - the read-path shape, so the aggregation
|
|
108
|
+
* is the canonical unwind/group/direct-sum pattern with no dynamic-key
|
|
109
|
+
* navigation.
|
|
110
|
+
*/
|
|
111
|
+
export interface IMaterializedCashCounterRow {
|
|
112
|
+
key: string;
|
|
113
|
+
counters: IMaterializedCashCounters;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* One `materialized_tenant_cash_in_out_reports` document - tenant x scope context
|
|
117
|
+
* x scope value. Counters only; never rows.
|
|
118
|
+
*/
|
|
119
|
+
export interface IMaterializedTenantCashReport {
|
|
120
|
+
_id: string;
|
|
121
|
+
tenant_id: string;
|
|
122
|
+
/** Required for brand-level reads (the page folds across drawers). */
|
|
123
|
+
brand_id: string;
|
|
124
|
+
scope_context: MATERIALIZED_REPORT_SCOPE_ENUM;
|
|
125
|
+
/** Format depends on `scope_context`. */
|
|
126
|
+
scope_field: string;
|
|
127
|
+
/** Denormalized weekday - set ONLY on `LOCAL_DATE` documents (no hour scope). */
|
|
128
|
+
day_index?: DAY_INDEX_ENUM | null;
|
|
129
|
+
/** The dimensions the key encodes: `DRAWER_ID`, `REF_TYPE`. */
|
|
130
|
+
sale_type_key_filters: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
|
|
131
|
+
/** One counter block per observed `<drawer>:<ref_type>` key; empty map never written. */
|
|
132
|
+
cash_counters: Record<string, IMaterializedCashCounters> | null;
|
|
133
|
+
/** The read-path shape of the SAME counters. */
|
|
134
|
+
cash_counter_rows: IMaterializedCashCounterRow[] | null;
|
|
135
|
+
/** Bumped when the report is re-closed after a correction. */
|
|
136
|
+
iteration?: number;
|
|
137
|
+
schema_version: number;
|
|
138
|
+
source_watermark: Date;
|
|
139
|
+
computed_at: Date;
|
|
140
|
+
createdAt: Date;
|
|
141
|
+
updatedAt: Date;
|
|
142
|
+
}
|
|
143
|
+
/** The ref-type values a key can carry (mirrors the ledger enum). */
|
|
144
|
+
export type TMaterializedCashRefType = CASH_IN_OUT_REF_ENUM;
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { DAY_INDEX_ENUM } from '../../constants/ENUMS';
|
|
2
|
+
import { DELIVERY_STATUS_ENUM } from '../../constants/enums/delivery';
|
|
3
|
+
import { MATERIALIZED_REPORT_KEY_FILTER_ENUM, MATERIALIZED_REPORT_SCOPE_ENUM } from '../../constants/MATERIALIZED_REPORTS';
|
|
4
|
+
/**
|
|
5
|
+
* Types for `materialized_tenant_delivery_entries` (M4, decision (e4)).
|
|
6
|
+
*
|
|
7
|
+
* The statement rows behind the delivery drill-down. The POLYLINE IS NOT STORED: a GPS
|
|
8
|
+
* trace per row would dominate the collection, so a row keeps only its POINT COUNT and a
|
|
9
|
+
* full route view stays a live read from `deliveries`.
|
|
10
|
+
*
|
|
11
|
+
* The order-derived fields (platform, city, address, money) come from the JOIN by
|
|
12
|
+
* `order_id` at compile time, so the read needs no second lookup and the drill-down can
|
|
13
|
+
* show what an operator recognises.
|
|
14
|
+
*
|
|
15
|
+
* Null means UNMEASURED, never zero: `assigned_at` / `delivered_at` are null on any
|
|
16
|
+
* document written before the metrics capture, and every derived duration is null rather
|
|
17
|
+
* than 0 - reporting 0 would claim the delivery was instantaneous.
|
|
18
|
+
*/
|
|
19
|
+
/** One delivery statement row. */
|
|
20
|
+
export interface IMaterializedDeliveryEntry {
|
|
21
|
+
delivery_id: string;
|
|
22
|
+
/** Stable identity inside its scope, used as the cursor tie-breaker. */
|
|
23
|
+
entry_key: string;
|
|
24
|
+
order_id: string;
|
|
25
|
+
order_number: number | null;
|
|
26
|
+
rider_id: string;
|
|
27
|
+
rider_name: string | null;
|
|
28
|
+
status: DELIVERY_STATUS_ENUM;
|
|
29
|
+
cancel_reason: string | null;
|
|
30
|
+
distance_meters: number;
|
|
31
|
+
/** CENTS. */
|
|
32
|
+
rider_revenue: number | null;
|
|
33
|
+
tracking_enabled: boolean;
|
|
34
|
+
has_pickup_proof: boolean;
|
|
35
|
+
has_dropoff_proof: boolean;
|
|
36
|
+
/** Trace SIZE only - the polyline itself is deliberately not stored. */
|
|
37
|
+
polyline_point_count: number;
|
|
38
|
+
platform: string;
|
|
39
|
+
city: string | null;
|
|
40
|
+
state: string | null;
|
|
41
|
+
street: string | null;
|
|
42
|
+
/** CENTS. */
|
|
43
|
+
net_sale_amount: number;
|
|
44
|
+
collected_amount: number;
|
|
45
|
+
delivery_charge: number;
|
|
46
|
+
order_created_at: Date;
|
|
47
|
+
assigned_at: Date | null;
|
|
48
|
+
picked_up_at: Date | null;
|
|
49
|
+
delivered_at: Date | null;
|
|
50
|
+
cancelled_at: Date | null;
|
|
51
|
+
/** `delivery.createdAt - order.createdAt` - precise even without the capture. */
|
|
52
|
+
dispatch_lag_minutes: number | null;
|
|
53
|
+
/** `delivered_at - delivery.createdAt`; null when never completed/observed. */
|
|
54
|
+
complete_minutes: number | null;
|
|
55
|
+
/**
|
|
56
|
+
* True when `complete_minutes` came from an exact `delivered_at`. False when it fell
|
|
57
|
+
* back to the `updatedAt` proxy, which moves on ANY later mutation (a note edit, an
|
|
58
|
+
* image upload) - the approximation the metrics capture exists to remove.
|
|
59
|
+
*/
|
|
60
|
+
completion_is_exact: boolean;
|
|
61
|
+
/** Churn signal: how many status writes this delivery received. */
|
|
62
|
+
status_updated_count: number | null;
|
|
63
|
+
/** `delivery.createdAt`. */
|
|
64
|
+
created_at: Date;
|
|
65
|
+
/** Time-of-day stamp, mirroring the delivery document field. */
|
|
66
|
+
created_at_mins: number | null;
|
|
67
|
+
/** `YYYY-MM-DD HH` punch hour (null when unresolvable). */
|
|
68
|
+
local_hour: string | null;
|
|
69
|
+
}
|
|
70
|
+
/** Per-key row section of one document. */
|
|
71
|
+
export interface IMaterializedDeliveryKeySection {
|
|
72
|
+
rows: IMaterializedDeliveryEntry[];
|
|
73
|
+
}
|
|
74
|
+
/** One `materialized_tenant_delivery_entries` document, capped at `LOCAL_MONTH`. */
|
|
75
|
+
export interface IMaterializedTenantDeliveryEntries {
|
|
76
|
+
_id: string;
|
|
77
|
+
tenant_id: string;
|
|
78
|
+
brand_id: string;
|
|
79
|
+
scope_context: MATERIALIZED_REPORT_SCOPE_ENUM;
|
|
80
|
+
scope_field: string;
|
|
81
|
+
/** Denormalized weekday - set ONLY on `LOCAL_DATE` documents. */
|
|
82
|
+
day_index?: DAY_INDEX_ENUM | null;
|
|
83
|
+
sale_type_key_filters: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
|
|
84
|
+
/** One row section per observed key; null when there are no rows at all. */
|
|
85
|
+
delivery_entries: Record<string, IMaterializedDeliveryKeySection> | null;
|
|
86
|
+
/**
|
|
87
|
+
* Delivery ORDERS that produced NO delivery document in this scope. They cannot be
|
|
88
|
+
* rows (there is no delivery to describe), so the count is carried on the document and
|
|
89
|
+
* the OFF_APP drill-down view answers from it rather than pretending to list rows.
|
|
90
|
+
*/
|
|
91
|
+
off_app_order_count: number;
|
|
92
|
+
iteration?: number;
|
|
93
|
+
schema_version: number;
|
|
94
|
+
source_watermark: Date;
|
|
95
|
+
computed_at: Date;
|
|
96
|
+
createdAt: Date;
|
|
97
|
+
updatedAt: Date;
|
|
98
|
+
}
|