@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.
Files changed (333) hide show
  1. package/esm/constants/MATERIALIZED_REPORTS.js +448 -0
  2. package/esm/helpers/index.js +3 -0
  3. package/esm/helpers/materialized-reports/index.js +32 -0
  4. package/esm/helpers/materialized-reports/materialized-cash-accumulator-helpers.js +114 -0
  5. package/esm/helpers/materialized-reports/materialized-cash-classification-helpers.js +286 -0
  6. package/esm/helpers/materialized-reports/materialized-cash-close-day-helpers.js +396 -0
  7. package/esm/helpers/materialized-reports/materialized-cash-compile-helpers.js +244 -0
  8. package/esm/helpers/materialized-reports/materialized-delivery-accumulator-helpers.js +170 -0
  9. package/esm/helpers/materialized-reports/materialized-delivery-classification-helpers.js +426 -0
  10. package/esm/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +372 -0
  11. package/esm/helpers/materialized-reports/materialized-delivery-compile-helpers.js +214 -0
  12. package/esm/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +318 -0
  13. package/esm/helpers/materialized-reports/materialized-discount-classification-helpers.js +213 -0
  14. package/esm/helpers/materialized-reports/materialized-discount-close-day-helpers.js +604 -0
  15. package/esm/helpers/materialized-reports/materialized-discount-compile-helpers.js +186 -0
  16. package/esm/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.js +155 -0
  17. package/esm/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.js +199 -0
  18. package/esm/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +111 -0
  19. package/esm/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +88 -0
  20. package/esm/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.js +394 -0
  21. package/esm/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.js +167 -0
  22. package/esm/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +215 -0
  23. package/esm/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +476 -0
  24. package/esm/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +201 -0
  25. package/esm/helpers/materialized-reports/materialized-reports-selection-helpers.js +7 -0
  26. package/esm/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +189 -0
  27. package/esm/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +157 -0
  28. package/esm/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.js +588 -0
  29. package/esm/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.js +175 -0
  30. package/esm/helpers/materialized-reports/tenant-cash-in-out-formatter.js +156 -0
  31. package/esm/helpers/materialized-reports/tenant-delivery-formatter.js +230 -0
  32. package/esm/helpers/materialized-reports/tenant-discount-formatter.js +427 -0
  33. package/esm/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +237 -0
  34. package/esm/helpers/materialized-reports/tenant-payments-comparison-formatter.js +279 -0
  35. package/esm/helpers/materialized-reports/tenant-prep-time-formatter.js +228 -0
  36. package/esm/helpers/materialized-reports/tenant-sales-comparison-formatter.js +343 -0
  37. package/esm/helpers/reporting-contract/index.js +2 -0
  38. package/esm/helpers/reporting-contract/overview-contract.js +122 -0
  39. package/esm/helpers/reporting-contract/report-contract.js +228 -0
  40. package/esm/helpers/rider-earnings/index.js +1 -0
  41. package/esm/helpers/rider-earnings/rider-earnings.js +59 -0
  42. package/esm/helpers/rider-reports/index.js +2 -0
  43. package/esm/helpers/rider-reports/rider-daily-report.js +90 -0
  44. package/esm/helpers/rider-reports/rider-report.js +67 -0
  45. package/esm/schemas/models/deliveries.js +75 -0
  46. package/esm/schemas/models/index.js +15 -0
  47. package/esm/schemas/models/materialized_rider_daily_reports.js +39 -0
  48. package/esm/schemas/models/materialized_tenant_cash_entries.js +95 -0
  49. package/esm/schemas/models/materialized_tenant_cash_reports.js +77 -0
  50. package/esm/schemas/models/materialized_tenant_delivery_entries.js +63 -0
  51. package/esm/schemas/models/materialized_tenant_delivery_reports.js +63 -0
  52. package/esm/schemas/models/materialized_tenant_discount_entries.js +156 -0
  53. package/esm/schemas/models/materialized_tenant_discount_reports.js +333 -0
  54. package/esm/schemas/models/materialized_tenant_hourly_comparison_entries.js +87 -0
  55. package/esm/schemas/models/materialized_tenant_hourly_comparison_reports.js +99 -0
  56. package/esm/schemas/models/materialized_tenant_payments_comparison_entries.js +71 -0
  57. package/esm/schemas/models/materialized_tenant_payments_comparison_reports.js +76 -0
  58. package/esm/schemas/models/materialized_tenant_prep_time_entries.js +130 -0
  59. package/esm/schemas/models/materialized_tenant_prep_time_reports.js +109 -0
  60. package/esm/schemas/models/materialized_tenant_sales_comparison_entries.js +130 -0
  61. package/esm/schemas/models/materialized_tenant_sales_comparison_reports.js +154 -0
  62. package/esm/schemas/types/index.js +15 -0
  63. package/esm/schemas/types/materialized_rider_daily_reports.js +1 -0
  64. package/esm/schemas/types/materialized_tenant_cash_entries.js +1 -0
  65. package/esm/schemas/types/materialized_tenant_cash_reports.js +1 -0
  66. package/esm/schemas/types/materialized_tenant_delivery_entries.js +1 -0
  67. package/esm/schemas/types/materialized_tenant_delivery_reports.js +1 -0
  68. package/esm/schemas/types/materialized_tenant_discount_entries.js +1 -0
  69. package/esm/schemas/types/materialized_tenant_discount_reports.js +2 -0
  70. package/esm/schemas/types/materialized_tenant_hourly_comparison_entries.js +1 -0
  71. package/esm/schemas/types/materialized_tenant_hourly_comparison_reports.js +1 -0
  72. package/esm/schemas/types/materialized_tenant_payments_comparison_entries.js +1 -0
  73. package/esm/schemas/types/materialized_tenant_payments_comparison_reports.js +11 -0
  74. package/esm/schemas/types/materialized_tenant_prep_time_entries.js +1 -0
  75. package/esm/schemas/types/materialized_tenant_prep_time_reports.js +1 -0
  76. package/esm/schemas/types/materialized_tenant_sales_comparison_entries.js +1 -0
  77. package/esm/schemas/types/materialized_tenant_sales_comparison_reports.js +14 -0
  78. package/lib/constants/MATERIALIZED_REPORTS.d.ts +339 -2
  79. package/lib/constants/MATERIALIZED_REPORTS.js +450 -1
  80. package/lib/helpers/index.d.ts +3 -0
  81. package/lib/helpers/index.js +3 -0
  82. package/lib/helpers/materialized-reports/index.d.ts +32 -0
  83. package/lib/helpers/materialized-reports/index.js +32 -0
  84. package/lib/helpers/materialized-reports/materialized-cash-accumulator-helpers.d.ts +18 -0
  85. package/lib/helpers/materialized-reports/materialized-cash-accumulator-helpers.js +118 -0
  86. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.d.ts +90 -0
  87. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.js +295 -0
  88. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.d.ts +102 -0
  89. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.js +409 -0
  90. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.d.ts +72 -0
  91. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.js +251 -0
  92. package/lib/helpers/materialized-reports/materialized-delivery-accumulator-helpers.d.ts +7 -0
  93. package/lib/helpers/materialized-reports/materialized-delivery-accumulator-helpers.js +173 -0
  94. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.d.ts +84 -0
  95. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.js +438 -0
  96. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.d.ts +97 -0
  97. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +385 -0
  98. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.d.ts +40 -0
  99. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +218 -0
  100. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.d.ts +52 -0
  101. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +324 -0
  102. package/lib/helpers/materialized-reports/materialized-discount-classification-helpers.d.ts +50 -0
  103. package/lib/helpers/materialized-reports/materialized-discount-classification-helpers.js +222 -0
  104. package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.d.ts +182 -0
  105. package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.js +615 -0
  106. package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.d.ts +47 -0
  107. package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.js +193 -0
  108. package/lib/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.d.ts +64 -0
  109. package/lib/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.js +163 -0
  110. package/lib/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.d.ts +61 -0
  111. package/lib/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.js +207 -0
  112. package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.d.ts +23 -0
  113. package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +116 -0
  114. package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.d.ts +25 -0
  115. package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +98 -0
  116. package/lib/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.d.ts +79 -0
  117. package/lib/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.js +407 -0
  118. package/lib/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.d.ts +35 -0
  119. package/lib/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.js +173 -0
  120. package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.d.ts +66 -0
  121. package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +224 -0
  122. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.d.ts +128 -0
  123. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +490 -0
  124. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.d.ts +46 -0
  125. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +208 -0
  126. package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.d.ts +8 -0
  127. package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.js +8 -1
  128. package/lib/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.d.ts +48 -0
  129. package/lib/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +204 -0
  130. package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.d.ts +22 -0
  131. package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +161 -0
  132. package/lib/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.d.ts +163 -0
  133. package/lib/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.js +603 -0
  134. package/lib/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.d.ts +68 -0
  135. package/lib/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.js +182 -0
  136. package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.d.ts +98 -0
  137. package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.js +159 -0
  138. package/lib/helpers/materialized-reports/tenant-delivery-formatter.d.ts +133 -0
  139. package/lib/helpers/materialized-reports/tenant-delivery-formatter.js +233 -0
  140. package/lib/helpers/materialized-reports/tenant-discount-formatter.d.ts +114 -0
  141. package/lib/helpers/materialized-reports/tenant-discount-formatter.js +431 -0
  142. package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.d.ts +60 -0
  143. package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +243 -0
  144. package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.d.ts +75 -0
  145. package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.js +286 -0
  146. package/lib/helpers/materialized-reports/tenant-prep-time-formatter.d.ts +97 -0
  147. package/lib/helpers/materialized-reports/tenant-prep-time-formatter.js +232 -0
  148. package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.d.ts +105 -0
  149. package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.js +349 -0
  150. package/lib/helpers/reporting-contract/index.d.ts +2 -0
  151. package/lib/helpers/reporting-contract/index.js +18 -0
  152. package/lib/helpers/reporting-contract/overview-contract.d.ts +55 -0
  153. package/lib/helpers/reporting-contract/overview-contract.js +126 -0
  154. package/lib/helpers/reporting-contract/report-contract.d.ts +159 -0
  155. package/lib/helpers/reporting-contract/report-contract.js +239 -0
  156. package/lib/helpers/rider-earnings/index.d.ts +1 -0
  157. package/lib/helpers/rider-earnings/index.js +17 -0
  158. package/lib/helpers/rider-earnings/rider-earnings.d.ts +58 -0
  159. package/lib/helpers/rider-earnings/rider-earnings.js +64 -0
  160. package/lib/helpers/rider-reports/index.d.ts +2 -0
  161. package/lib/helpers/rider-reports/index.js +18 -0
  162. package/lib/helpers/rider-reports/rider-daily-report.d.ts +26 -0
  163. package/lib/helpers/rider-reports/rider-daily-report.js +93 -0
  164. package/lib/helpers/rider-reports/rider-report.d.ts +49 -0
  165. package/lib/helpers/rider-reports/rider-report.js +70 -0
  166. package/lib/helpers/types/materialized-reports-apis.d.ts +297 -1
  167. package/lib/schemas/models/deliveries.d.ts +54 -0
  168. package/lib/schemas/models/deliveries.js +75 -0
  169. package/lib/schemas/models/expense_details.d.ts +3 -3
  170. package/lib/schemas/models/index.d.ts +15 -0
  171. package/lib/schemas/models/index.js +15 -0
  172. package/lib/schemas/models/materialized_rider_daily_reports.d.ts +27 -0
  173. package/lib/schemas/models/materialized_rider_daily_reports.js +42 -0
  174. package/lib/schemas/models/materialized_tenant_cash_entries.d.ts +181 -0
  175. package/lib/schemas/models/materialized_tenant_cash_entries.js +98 -0
  176. package/lib/schemas/models/materialized_tenant_cash_reports.d.ts +111 -0
  177. package/lib/schemas/models/materialized_tenant_cash_reports.js +80 -0
  178. package/lib/schemas/models/materialized_tenant_delivery_entries.d.ts +98 -0
  179. package/lib/schemas/models/materialized_tenant_delivery_entries.js +66 -0
  180. package/lib/schemas/models/materialized_tenant_delivery_reports.d.ts +98 -0
  181. package/lib/schemas/models/materialized_tenant_delivery_reports.js +66 -0
  182. package/lib/schemas/models/materialized_tenant_discount_entries.d.ts +199 -0
  183. package/lib/schemas/models/materialized_tenant_discount_entries.js +159 -0
  184. package/lib/schemas/models/materialized_tenant_discount_reports.d.ts +216 -0
  185. package/lib/schemas/models/materialized_tenant_discount_reports.js +336 -0
  186. package/lib/schemas/models/materialized_tenant_hourly_comparison_entries.d.ts +95 -0
  187. package/lib/schemas/models/materialized_tenant_hourly_comparison_entries.js +82 -0
  188. package/lib/schemas/models/materialized_tenant_hourly_comparison_reports.d.ts +105 -0
  189. package/lib/schemas/models/materialized_tenant_hourly_comparison_reports.js +91 -0
  190. package/lib/schemas/models/materialized_tenant_payments_comparison_entries.d.ts +91 -0
  191. package/lib/schemas/models/materialized_tenant_payments_comparison_entries.js +70 -0
  192. package/lib/schemas/models/materialized_tenant_payments_comparison_reports.d.ts +98 -0
  193. package/lib/schemas/models/materialized_tenant_payments_comparison_reports.js +71 -0
  194. package/lib/schemas/models/materialized_tenant_prep_time_entries.d.ts +181 -0
  195. package/lib/schemas/models/materialized_tenant_prep_time_entries.js +133 -0
  196. package/lib/schemas/models/materialized_tenant_prep_time_reports.d.ts +118 -0
  197. package/lib/schemas/models/materialized_tenant_prep_time_reports.js +112 -0
  198. package/lib/schemas/models/materialized_tenant_sales_comparison_entries.d.ts +139 -0
  199. package/lib/schemas/models/materialized_tenant_sales_comparison_entries.js +120 -0
  200. package/lib/schemas/models/materialized_tenant_sales_comparison_reports.d.ts +167 -0
  201. package/lib/schemas/models/materialized_tenant_sales_comparison_reports.js +137 -0
  202. package/lib/schemas/models/tenant_purchase_order_vendor_returns.d.ts +3 -3
  203. package/lib/schemas/models/warehouse_internal_movements.d.ts +6 -6
  204. package/lib/schemas/models/warehouse_purchase_order_receipts.d.ts +3 -3
  205. package/lib/schemas/models/warehouse_purchase_order_vendor_returns.d.ts +3 -3
  206. package/lib/schemas/models/warehouse_sale_deliveries.d.ts +6 -6
  207. package/lib/schemas/models/warehouse_sale_invoices.d.ts +3 -3
  208. package/lib/schemas/types/deliveries.d.ts +40 -1
  209. package/lib/schemas/types/index.d.ts +15 -0
  210. package/lib/schemas/types/index.js +15 -0
  211. package/lib/schemas/types/materialized_rider_daily_reports.d.ts +37 -0
  212. package/lib/schemas/types/materialized_rider_daily_reports.js +2 -0
  213. package/lib/schemas/types/materialized_tenant_cash_entries.d.ts +87 -0
  214. package/lib/schemas/types/materialized_tenant_cash_entries.js +2 -0
  215. package/lib/schemas/types/materialized_tenant_cash_reports.d.ts +144 -0
  216. package/lib/schemas/types/materialized_tenant_cash_reports.js +2 -0
  217. package/lib/schemas/types/materialized_tenant_delivery_entries.d.ts +98 -0
  218. package/lib/schemas/types/materialized_tenant_delivery_entries.js +2 -0
  219. package/lib/schemas/types/materialized_tenant_delivery_reports.d.ts +179 -0
  220. package/lib/schemas/types/materialized_tenant_delivery_reports.js +2 -0
  221. package/lib/schemas/types/materialized_tenant_discount_entries.d.ts +81 -0
  222. package/lib/schemas/types/materialized_tenant_discount_entries.js +2 -0
  223. package/lib/schemas/types/materialized_tenant_discount_reports.d.ts +209 -0
  224. package/lib/schemas/types/materialized_tenant_discount_reports.js +3 -0
  225. package/lib/schemas/types/materialized_tenant_hourly_comparison_entries.d.ts +33 -0
  226. package/lib/schemas/types/materialized_tenant_hourly_comparison_entries.js +2 -0
  227. package/lib/schemas/types/materialized_tenant_hourly_comparison_reports.d.ts +40 -0
  228. package/lib/schemas/types/materialized_tenant_hourly_comparison_reports.js +2 -0
  229. package/lib/schemas/types/materialized_tenant_payments_comparison_entries.d.ts +48 -0
  230. package/lib/schemas/types/materialized_tenant_payments_comparison_entries.js +2 -0
  231. package/lib/schemas/types/materialized_tenant_payments_comparison_reports.d.ts +51 -0
  232. package/lib/schemas/types/materialized_tenant_payments_comparison_reports.js +14 -0
  233. package/lib/schemas/types/materialized_tenant_prep_time_entries.d.ts +88 -0
  234. package/lib/schemas/types/materialized_tenant_prep_time_entries.js +2 -0
  235. package/lib/schemas/types/materialized_tenant_prep_time_reports.d.ts +132 -0
  236. package/lib/schemas/types/materialized_tenant_prep_time_reports.js +2 -0
  237. package/lib/schemas/types/materialized_tenant_sales_comparison_entries.d.ts +43 -0
  238. package/lib/schemas/types/materialized_tenant_sales_comparison_entries.js +2 -0
  239. package/lib/schemas/types/materialized_tenant_sales_comparison_reports.d.ts +74 -0
  240. package/lib/schemas/types/materialized_tenant_sales_comparison_reports.js +17 -0
  241. package/lib/tests/materialized-reports/analytics-growth-helpers.test.d.ts +1 -0
  242. package/lib/tests/materialized-reports/analytics-overview-helpers.test.d.ts +1 -0
  243. package/lib/tests/materialized-reports/analytics-performance-helpers.test.d.ts +1 -0
  244. package/lib/tests/materialized-reports/fixtures.d.ts +15 -1
  245. package/lib/tests/materialized-reports/fixtures.js +1 -0
  246. package/lib/tests/materialized-reports/materialized-cash-compile.test.d.ts +1 -0
  247. package/lib/tests/materialized-reports/materialized-cash-compile.test.js +196 -0
  248. package/lib/tests/materialized-reports/materialized-cash-fold.test.d.ts +1 -0
  249. package/lib/tests/materialized-reports/materialized-cash-fold.test.js +116 -0
  250. package/lib/tests/materialized-reports/materialized-cash-formatter.test.d.ts +1 -0
  251. package/lib/tests/materialized-reports/materialized-cash-formatter.test.js +152 -0
  252. package/lib/tests/materialized-reports/materialized-cash-plan.test.d.ts +1 -0
  253. package/lib/tests/materialized-reports/materialized-cash-plan.test.js +168 -0
  254. package/lib/tests/materialized-reports/materialized-cash-reconciliation.test.d.ts +1 -0
  255. package/lib/tests/materialized-reports/materialized-cash-reconciliation.test.js +267 -0
  256. package/lib/tests/materialized-reports/materialized-delivery-accumulation.test.d.ts +1 -0
  257. package/lib/tests/materialized-reports/materialized-delivery-accumulation.test.js +147 -0
  258. package/lib/tests/materialized-reports/materialized-delivery-compile.test.d.ts +1 -0
  259. package/lib/tests/materialized-reports/materialized-delivery-compile.test.js +241 -0
  260. package/lib/tests/materialized-reports/materialized-delivery-fold.test.d.ts +1 -0
  261. package/lib/tests/materialized-reports/materialized-delivery-fold.test.js +109 -0
  262. package/lib/tests/materialized-reports/materialized-delivery-formatter.test.d.ts +1 -0
  263. package/lib/tests/materialized-reports/materialized-delivery-formatter.test.js +141 -0
  264. package/lib/tests/materialized-reports/materialized-delivery-plan.test.d.ts +1 -0
  265. package/lib/tests/materialized-reports/materialized-delivery-plan.test.js +198 -0
  266. package/lib/tests/materialized-reports/materialized-discount-aggregated-formatter.test.d.ts +1 -0
  267. package/lib/tests/materialized-reports/materialized-discount-aggregated-formatter.test.js +173 -0
  268. package/lib/tests/materialized-reports/materialized-discount-classification.test.d.ts +1 -0
  269. package/lib/tests/materialized-reports/materialized-discount-classification.test.js +339 -0
  270. package/lib/tests/materialized-reports/materialized-discount-close-day.test.d.ts +1 -0
  271. package/lib/tests/materialized-reports/materialized-discount-close-day.test.js +506 -0
  272. package/lib/tests/materialized-reports/materialized-discount-compile.test.d.ts +1 -0
  273. package/lib/tests/materialized-reports/materialized-discount-compile.test.js +161 -0
  274. package/lib/tests/materialized-reports/materialized-discount-counter-rows.test.d.ts +1 -0
  275. package/lib/tests/materialized-reports/materialized-discount-counter-rows.test.js +107 -0
  276. package/lib/tests/materialized-reports/materialized-discount-entries-accumulation.test.d.ts +1 -0
  277. package/lib/tests/materialized-reports/materialized-discount-entries-accumulation.test.js +125 -0
  278. package/lib/tests/materialized-reports/materialized-hourly-comparison-compile.test.d.ts +1 -0
  279. package/lib/tests/materialized-reports/materialized-hourly-comparison-compile.test.js +146 -0
  280. package/lib/tests/materialized-reports/materialized-hourly-comparison-formatter.test.d.ts +1 -0
  281. package/lib/tests/materialized-reports/materialized-hourly-comparison-formatter.test.js +127 -0
  282. package/lib/tests/materialized-reports/materialized-hourly-comparison-plan.test.d.ts +1 -0
  283. package/lib/tests/materialized-reports/materialized-hourly-comparison-plan.test.js +138 -0
  284. package/lib/tests/materialized-reports/materialized-hourly-comparison-selection.test.d.ts +1 -0
  285. package/lib/tests/materialized-reports/materialized-hourly-comparison-selection.test.js +90 -0
  286. package/lib/tests/materialized-reports/materialized-payments-comparison-compile.test.d.ts +1 -0
  287. package/lib/tests/materialized-reports/materialized-payments-comparison-compile.test.js +164 -0
  288. package/lib/tests/materialized-reports/materialized-payments-comparison-formatter.test.d.ts +1 -0
  289. package/lib/tests/materialized-reports/materialized-payments-comparison-formatter.test.js +117 -0
  290. package/lib/tests/materialized-reports/materialized-payments-comparison-plan.test.d.ts +1 -0
  291. package/lib/tests/materialized-reports/materialized-payments-comparison-plan.test.js +149 -0
  292. package/lib/tests/materialized-reports/materialized-prep-time-classification.test.d.ts +1 -0
  293. package/lib/tests/materialized-reports/materialized-prep-time-classification.test.js +273 -0
  294. package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.d.ts +1 -0
  295. package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.js +270 -0
  296. package/lib/tests/materialized-reports/materialized-prep-time-compile.test.d.ts +1 -0
  297. package/lib/tests/materialized-reports/materialized-prep-time-compile.test.js +217 -0
  298. package/lib/tests/materialized-reports/materialized-prep-time-constants.test.d.ts +1 -0
  299. package/lib/tests/materialized-reports/materialized-prep-time-constants.test.js +84 -0
  300. package/lib/tests/materialized-reports/materialized-prep-time-plan.test.d.ts +1 -0
  301. package/lib/tests/materialized-reports/materialized-prep-time-plan.test.js +176 -0
  302. package/lib/tests/materialized-reports/materialized-sales-comparison-baseline.test.d.ts +1 -0
  303. package/lib/tests/materialized-reports/materialized-sales-comparison-baseline.test.js +126 -0
  304. package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.d.ts +1 -0
  305. package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.js +206 -0
  306. package/lib/tests/materialized-reports/materialized-sales-comparison-formatter.test.d.ts +1 -0
  307. package/lib/tests/materialized-reports/materialized-sales-comparison-formatter.test.js +179 -0
  308. package/lib/tests/materialized-reports/materialized-sales-comparison-parity.test.d.ts +1 -0
  309. package/lib/tests/materialized-reports/materialized-sales-comparison-parity.test.js +196 -0
  310. package/lib/tests/materialized-reports/materialized-sales-comparison-plan.test.d.ts +1 -0
  311. package/lib/tests/materialized-reports/materialized-sales-comparison-plan.test.js +241 -0
  312. package/lib/tests/materialized-reports/materialized-tenant-hourly-comparison-schema.test.d.ts +1 -0
  313. package/lib/tests/materialized-reports/materialized-tenant-hourly-comparison-schema.test.js +96 -0
  314. package/lib/tests/materialized-reports/materialized-tenant-payments-comparison-schema.test.d.ts +1 -0
  315. package/lib/tests/materialized-reports/materialized-tenant-payments-comparison-schema.test.js +112 -0
  316. package/lib/tests/materialized-reports/materialized-tenant-sales-comparison-schema.test.d.ts +1 -0
  317. package/lib/tests/materialized-reports/materialized-tenant-sales-comparison-schema.test.js +142 -0
  318. package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.js +8 -1
  319. package/lib/tests/materialized-reports/sales-comparison-reference.d.ts +55 -0
  320. package/lib/tests/materialized-reports/sales-comparison-reference.js +86 -0
  321. package/lib/tests/materialized-reports/tenant-discount-formatter.test.d.ts +1 -0
  322. package/lib/tests/materialized-reports/tenant-discount-formatter.test.js +289 -0
  323. package/lib/tests/materialized-reports/tenant-prep-time-formatter.test.d.ts +1 -0
  324. package/lib/tests/materialized-reports/tenant-prep-time-formatter.test.js +354 -0
  325. package/lib/tests/reporting-contract.test.d.ts +1 -0
  326. package/lib/tests/reporting-contract.test.js +267 -0
  327. package/lib/tests/rider-daily-report.test.d.ts +1 -0
  328. package/lib/tests/rider-daily-report.test.js +86 -0
  329. package/lib/tests/rider-earnings.test.d.ts +1 -0
  330. package/lib/tests/rider-earnings.test.js +65 -0
  331. package/lib/tests/rider-report.test.d.ts +1 -0
  332. package/lib/tests/rider-report.test.js +98 -0
  333. package/package.json +10 -1
@@ -0,0 +1,251 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MATERIALIZED_CASH_KEY_SEPARATOR = void 0;
4
+ exports.buildMaterializedCashKey = buildMaterializedCashKey;
5
+ exports.parseMaterializedCashKey = parseMaterializedCashKey;
6
+ exports.cashSessionKeyForDrawer = cashSessionKeyForDrawer;
7
+ exports.compileTenantCashReports = compileTenantCashReports;
8
+ const cash_1 = require("../../constants/enums/cash");
9
+ const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
10
+ const materialized_tenant_cash_entries_1 = require("../../schemas/models/materialized_tenant_cash_entries");
11
+ const materialized_tenant_cash_reports_1 = require("../../schemas/models/materialized_tenant_cash_reports");
12
+ const materialized_cash_classification_helpers_1 = require("./materialized-cash-classification-helpers");
13
+ /**
14
+ * M3 cash - key grammar and the day compile.
15
+ *
16
+ * ## The key, and the ONE place this spec needed a decision
17
+ *
18
+ * The key is `<DRAWER_ID>:<REF_TYPE>` (decision (b3)). But a counter block holds BOTH
19
+ * `movements` and `sessions`, and a SESSION document has no `ref_type` at all - so the
20
+ * concept doc does not say which key a session belongs to. Resolved here as:
21
+ *
22
+ * session counters attach to the `<drawer_id>:DRAWER` key.
23
+ *
24
+ * That is the one key it can belong to without inventing a fake ref type: `DRAWER` is
25
+ * a real ledger ref type, and the rows carrying it ARE the session lifecycle (the
26
+ * opening float, every reopen, the count-out). So "drawer lifecycle movements + the
27
+ * session facts behind them" is exactly what that key means, and no read-side special
28
+ * casing or reserved token is needed. Flagged to the owner as a spec gap filled.
29
+ *
30
+ * ## The day compile
31
+ *
32
+ * Cash is NOT order-derived: the scope comes from the movement rows and the session
33
+ * documents directly. One key produces one counter block, and the block is stored
34
+ * TWICE - as a key-addressed map and as an array of rows - so the read is the
35
+ * canonical unwind/group/direct-sum pattern.
36
+ */
37
+ /** The separator between the drawer id and the ref type inside a key. */
38
+ exports.MATERIALIZED_CASH_KEY_SEPARATOR = ':';
39
+ /**
40
+ * Builds a key. The separator cannot appear in either component: a drawer id or ref
41
+ * type containing it would make the key unparseable, so such a row is SKIPPED by the
42
+ * caller rather than silently mis-keyed.
43
+ */
44
+ function buildMaterializedCashKey(drawerId, refType) {
45
+ const drawer = drawerId == null ? '' : String(drawerId).trim();
46
+ const ref = refType == null ? '' : String(refType).trim();
47
+ if (drawer === '' || ref === '')
48
+ return null;
49
+ if (drawer.includes(exports.MATERIALIZED_CASH_KEY_SEPARATOR) || ref.includes(exports.MATERIALIZED_CASH_KEY_SEPARATOR)) {
50
+ return null;
51
+ }
52
+ return drawer + exports.MATERIALIZED_CASH_KEY_SEPARATOR + ref;
53
+ }
54
+ /** Splits a key back into its parts, or null when it is malformed. */
55
+ function parseMaterializedCashKey(key) {
56
+ if (key == null)
57
+ return null;
58
+ const parts = String(key).split(exports.MATERIALIZED_CASH_KEY_SEPARATOR);
59
+ if (parts.length !== 2)
60
+ return null;
61
+ const [drawerId, refType] = parts;
62
+ if (drawerId === '' || refType === '')
63
+ return null;
64
+ return { drawerId, refType };
65
+ }
66
+ /** The key that carries a drawer session counters. */
67
+ function cashSessionKeyForDrawer(drawerId) {
68
+ return buildMaterializedCashKey(drawerId, cash_1.CASH_IN_OUT_REF_ENUM.DRAWER);
69
+ }
70
+ const watermarkOf = (row, fallback) => {
71
+ const raw = row?.updatedAt ?? row?.createdAt;
72
+ const time = raw == null ? NaN : new Date(raw).getTime();
73
+ return Number.isNaN(time) ? fallback : new Date(time);
74
+ };
75
+ /**
76
+ * Compiles one business day into the DATE report document plus the DATE entries
77
+ * document. Returns null when the day has NEITHER a movement NOR a session - an
78
+ * empted day writes nothing, and the close-day planner deletes what is left over.
79
+ */
80
+ function compileTenantCashReports(input) {
81
+ if (input == null)
82
+ return null;
83
+ const { tenantId, brandId, localDate } = input;
84
+ if (typeof tenantId !== 'string' ||
85
+ tenantId === '' ||
86
+ typeof brandId !== 'string' ||
87
+ brandId === '' ||
88
+ typeof localDate !== 'string' ||
89
+ localDate === '') {
90
+ return null;
91
+ }
92
+ const movements = Array.isArray(input.movements) ? input.movements : [];
93
+ const sessions = Array.isArray(input.sessions) ? input.sessions : [];
94
+ const computedAt = input.computedAt ?? new Date();
95
+ // Foreign tenants must never leak into this tenant's documents.
96
+ const ownMovements = movements.filter((row) => String(row?.tenant_id ?? tenantId) === tenantId);
97
+ const ownSessions = sessions.filter((row) => String(row?.tenant_id ?? tenantId) === tenantId);
98
+ if (ownMovements.length === 0 && ownSessions.length === 0)
99
+ return null;
100
+ const accumulators = new Map();
101
+ const entriesByKey = new Map();
102
+ const rowWatermarks = [];
103
+ const accumulatorFor = (key) => {
104
+ const existing = accumulators.get(key);
105
+ if (existing != null)
106
+ return existing;
107
+ const created = (0, materialized_cash_classification_helpers_1.freshCashAccumulator)();
108
+ accumulators.set(key, created);
109
+ return created;
110
+ };
111
+ for (const movement of ownMovements) {
112
+ const key = buildMaterializedCashKey(movement?.drawer_id, movement?.ref_type);
113
+ if (key == null) {
114
+ // An unparseable drawer id or ref type: SKIPPED, never mis-keyed.
115
+ continue;
116
+ }
117
+ (0, materialized_cash_classification_helpers_1.addCashMovement)(accumulatorFor(key), movement);
118
+ rowWatermarks.push(watermarkOf(movement, computedAt));
119
+ const drawerId = String(movement.drawer_id);
120
+ const type = String(movement.type) === cash_1.CASH_IN_OUT_TYPE_ENUM.CASH_IN
121
+ ? cash_1.CASH_IN_OUT_TYPE_ENUM.CASH_IN
122
+ : cash_1.CASH_IN_OUT_TYPE_ENUM.CASH_OUT;
123
+ const amount = Math.abs(Number(movement.amount) || 0);
124
+ const isIn = type === cash_1.CASH_IN_OUT_TYPE_ENUM.CASH_IN;
125
+ const created = new Date(movement?.createdAt ?? computedAt);
126
+ const sourceId = String(movement?.cash_in_out_id ?? movement?._id ?? '');
127
+ const entry = {
128
+ cash_in_out_id: sourceId,
129
+ entry_key: localDate + '|' + sourceId,
130
+ drawer_id: drawerId,
131
+ drawer_name: input.drawerNames?.[drawerId] ?? null,
132
+ day_id: String(movement?.day_id ?? ''),
133
+ shift_id: movement?.shift_id == null ? null : String(movement.shift_id),
134
+ shift_number: movement?.shift_number == null ? null : Number(movement.shift_number) || 0,
135
+ type,
136
+ ref_type: String(movement?.ref_type ?? cash_1.CASH_IN_OUT_REF_ENUM.NONE),
137
+ ref_id: movement?.ref_id == null ? null : String(movement.ref_id),
138
+ amount,
139
+ signed_amount: isIn ? amount : -amount,
140
+ drawer_balance_before: Number(movement?.drawer_balance_before) || 0,
141
+ drawer_balance_after: Number(movement?.drawer_balance_after) || 0,
142
+ staff_id: movement?.staff_id == null ? null : String(movement.staff_id),
143
+ staff_name: movement?.staff_name == null ? null : String(movement.staff_name),
144
+ note: movement?.note == null ? null : String(movement.note),
145
+ ...classifyForEntry(movement),
146
+ created_at: created,
147
+ local_hour: localHourOf(movement),
148
+ };
149
+ const bucket = entriesByKey.get(key);
150
+ if (bucket == null)
151
+ entriesByKey.set(key, [entry]);
152
+ else
153
+ bucket.push(entry);
154
+ }
155
+ for (const session of ownSessions) {
156
+ const key = cashSessionKeyForDrawer(session?.drawer_id);
157
+ if (key == null) {
158
+ // Same posture as the movements: a row we cannot key is skipped.
159
+ continue;
160
+ }
161
+ (0, materialized_cash_classification_helpers_1.addCashSession)(accumulatorFor(key), session);
162
+ rowWatermarks.push(watermarkOf(session, computedAt));
163
+ }
164
+ if (accumulators.size === 0)
165
+ return null;
166
+ const cashCounters = {};
167
+ const cashCounterRows = [];
168
+ for (const key of [...accumulators.keys()].sort()) {
169
+ const counters = (0, materialized_cash_classification_helpers_1.finalizeCashAccumulator)(accumulators.get(key));
170
+ cashCounters[key] = counters;
171
+ cashCounterRows.push({ key, counters });
172
+ }
173
+ // Rows are sorted newest-first WITHIN each key. Merging the keys into one global
174
+ // newest-first statement is the READER's job: the page cursor is
175
+ // {time, cash_in_out_id}, which implies a global order across the keys in scope.
176
+ const cashEntries = {};
177
+ for (const key of [...entriesByKey.keys()].sort()) {
178
+ const rows = entriesByKey.get(key);
179
+ rows.sort((a, b) => b.created_at.getTime() - a.created_at.getTime() || (a.cash_in_out_id < b.cash_in_out_id ? 1 : -1));
180
+ cashEntries[key] = { rows };
181
+ }
182
+ const watermark = rowWatermarks.reduce((latest, current) => (current.getTime() > latest.getTime() ? current : latest), computedAt);
183
+ const reports = [
184
+ {
185
+ _id: undefined,
186
+ tenant_id: tenantId,
187
+ brand_id: brandId,
188
+ scope_context: 'localDate',
189
+ scope_field: localDate,
190
+ day_index: dayIndexOf(localDate),
191
+ sale_type_key_filters: [...MATERIALIZED_REPORTS_1.CASH_KEY_FILTERS],
192
+ cash_counters: cashCounters,
193
+ cash_counter_rows: cashCounterRows,
194
+ schema_version: materialized_tenant_cash_reports_1.MATERIALIZED_TENANT_CASH_REPORTS_SCHEMA_VERSION,
195
+ source_watermark: watermark,
196
+ computed_at: computedAt,
197
+ createdAt: computedAt,
198
+ updatedAt: computedAt,
199
+ },
200
+ ];
201
+ const entries = [
202
+ {
203
+ _id: undefined,
204
+ tenant_id: tenantId,
205
+ brand_id: brandId,
206
+ scope_context: 'localDate',
207
+ scope_field: localDate,
208
+ day_index: dayIndexOf(localDate),
209
+ sale_type_key_filters: [...MATERIALIZED_REPORTS_1.CASH_KEY_FILTERS],
210
+ cash_entries: Object.keys(cashEntries).length === 0 ? null : cashEntries,
211
+ schema_version: materialized_tenant_cash_entries_1.MATERIALIZED_TENANT_CASH_ENTRIES_SCHEMA_VERSION,
212
+ source_watermark: watermark,
213
+ computed_at: computedAt,
214
+ createdAt: computedAt,
215
+ updatedAt: computedAt,
216
+ },
217
+ ];
218
+ return { reports, entries };
219
+ }
220
+ /** The four lifecycle flags, computed ONCE here so the read never re-derives them. */
221
+ function classifyForEntry(row) {
222
+ const p = (0, materialized_cash_classification_helpers_1.classifyCashMovement)(row);
223
+ return {
224
+ is_reopen: p.is_reopen,
225
+ is_opening_float: p.is_opening_float,
226
+ is_count_out: p.is_count_out,
227
+ is_system_adjustment: p.is_system_adjustment,
228
+ };
229
+ }
230
+ /** `YYYY-MM-DD HH` from the local time fields, or null. */
231
+ function localHourOf(row) {
232
+ const explicit = row?.localHour;
233
+ if (typeof explicit === 'number' && Number.isFinite(explicit)) {
234
+ const day = String(row?.localDate ?? '');
235
+ return day === '' ? null : day + ' ' + String(explicit).padStart(2, '0');
236
+ }
237
+ const raw = row?.createdAt;
238
+ if (raw == null)
239
+ return null;
240
+ const date = new Date(raw);
241
+ if (Number.isNaN(date.getTime()))
242
+ return null;
243
+ return date.toISOString().slice(0, 13).replace('T', ' ');
244
+ }
245
+ /** Weekday denormalization for a date document. */
246
+ function dayIndexOf(localDate) {
247
+ const date = new Date(localDate + 'T00:00:00.000Z');
248
+ if (Number.isNaN(date.getTime()))
249
+ return null;
250
+ return ['SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY'][date.getUTCDay()];
251
+ }
@@ -0,0 +1,7 @@
1
+ import { IMaterializedDeliveryCounters } from '../../schemas/types/materialized_tenant_delivery_reports';
2
+ /**
3
+ * Merges `source` into `target`, IN PLACE. Null-safe: a source block missing a sub-object
4
+ * is treated as zeroes rather than throwing, so one malformed historical document cannot
5
+ * break a whole period fold.
6
+ */
7
+ export declare function mergeMaterializedDeliveryCounters(target: IMaterializedDeliveryCounters, source: IMaterializedDeliveryCounters): IMaterializedDeliveryCounters;
@@ -0,0 +1,173 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.mergeMaterializedDeliveryCounters = mergeMaterializedDeliveryCounters;
4
+ const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
5
+ /**
6
+ * M4 delivery - folding counters across days into a PERIOD document.
7
+ *
8
+ * ## What is additive, and what is NOT
9
+ *
10
+ * Additive: every count, every money total, every distance total, every timing sum, and
11
+ * the whole ADOPTION block. Adoption folds safely because each order belongs to exactly
12
+ * one day, so summing `delivery_order_count` / `delivered_via_app_count` / `off_app_count`
13
+ * across days preserves the set relationship - there is no double counting to worry about,
14
+ * which is why this report does NOT need to carry id sets through the fold the way the
15
+ * cash report carries a staff roster.
16
+ *
17
+ * NOT additive, and this is the trap: the rider leaderboard's `first_delivery_at` and
18
+ * `last_delivery_at`. A rider who worked two days must keep the EARLIEST first and the
19
+ * LATEST last, so the fold takes a MINIMUM and a MAXIMUM rather than a sum. Summing them
20
+ * (or taking the last one seen) silently reports a rider's tenure as starting after it
21
+ * did - the same class of error as summing a minimum in the prep time report.
22
+ *
23
+ * The distance HISTOGRAM folds by sum, bucket by bucket, because each delivery lands in
24
+ * exactly one bucket per document.
25
+ */
26
+ const num = (value) => Number(value) || 0;
27
+ const earlierOf = (current, candidate) => {
28
+ const time = candidate == null ? NaN : new Date(candidate).getTime();
29
+ if (Number.isNaN(time))
30
+ return current;
31
+ if (current == null || time < new Date(current).getTime())
32
+ return new Date(time);
33
+ return current;
34
+ };
35
+ const laterOf = (current, candidate) => {
36
+ const time = candidate == null ? NaN : new Date(candidate).getTime();
37
+ if (Number.isNaN(time))
38
+ return current;
39
+ if (current == null || time > new Date(current).getTime())
40
+ return new Date(time);
41
+ return current;
42
+ };
43
+ /** Merges one rider row into another, MIN/MAX on the tenure bounds. */
44
+ function mergeRiderRow(target, source) {
45
+ target.count += num(source?.count);
46
+ target.completed_count += num(source?.completed_count);
47
+ target.cancelled_count += num(source?.cancelled_count);
48
+ target.in_progress_count += num(source?.in_progress_count);
49
+ target.rider_revenue_amount += num(source?.rider_revenue_amount);
50
+ target.distance_sum_meters += num(source?.distance_sum_meters);
51
+ target.rider_name ?? (target.rider_name = source?.rider_name ?? null);
52
+ // MIN / MAX - never a sum, and never just the newest document value.
53
+ target.first_delivery_at = earlierOf(target.first_delivery_at, source?.first_delivery_at);
54
+ target.last_delivery_at = laterOf(target.last_delivery_at, source?.last_delivery_at);
55
+ }
56
+ /** Merges one area row into another, summing the hour heat map. */
57
+ function mergeAreaRow(target, source) {
58
+ target.count += num(source?.count);
59
+ target.completed_count += num(source?.completed_count);
60
+ target.cancelled_count += num(source?.cancelled_count);
61
+ target.rider_revenue_amount += num(source?.rider_revenue_amount);
62
+ target.distance_sum_meters += num(source?.distance_sum_meters);
63
+ target.by_hour ?? (target.by_hour = {});
64
+ for (const [hour, value] of Object.entries(source?.by_hour ?? {})) {
65
+ target.by_hour[hour] = num(target.by_hour[hour]) + num(value);
66
+ }
67
+ }
68
+ /**
69
+ * Merges `source` into `target`, IN PLACE. Null-safe: a source block missing a sub-object
70
+ * is treated as zeroes rather than throwing, so one malformed historical document cannot
71
+ * break a whole period fold.
72
+ */
73
+ function mergeMaterializedDeliveryCounters(target, source) {
74
+ var _a, _b;
75
+ if (target == null || source == null)
76
+ return target;
77
+ const ta = target.adoption;
78
+ const sa = source.adoption;
79
+ if (ta != null && sa != null) {
80
+ ta.delivery_order_count += num(sa.delivery_order_count);
81
+ ta.delivered_via_app_count += num(sa.delivered_via_app_count);
82
+ ta.off_app_count += num(sa.off_app_count);
83
+ ta.tracking_enabled_count += num(sa.tracking_enabled_count);
84
+ ta.proof_pickup_count += num(sa.proof_pickup_count);
85
+ ta.proof_dropoff_count += num(sa.proof_dropoff_count);
86
+ }
87
+ const td = target.deliveries;
88
+ const sd = source.deliveries;
89
+ if (td != null && sd != null) {
90
+ td.count += num(sd.count);
91
+ td.pending_count += num(sd.pending_count);
92
+ td.assigned_count += num(sd.assigned_count);
93
+ td.in_progress_count += num(sd.in_progress_count);
94
+ td.completed_count += num(sd.completed_count);
95
+ td.cancelled_count += num(sd.cancelled_count);
96
+ td.cancel_reason_count += num(sd.cancel_reason_count);
97
+ }
98
+ const tm = target.money;
99
+ const sm = source.money;
100
+ if (tm != null && sm != null) {
101
+ tm.rider_revenue_amount += num(sm.rider_revenue_amount);
102
+ tm.rider_revenue_count += num(sm.rider_revenue_count);
103
+ tm.net_sale_amount += num(sm.net_sale_amount);
104
+ tm.collected_amount += num(sm.collected_amount);
105
+ tm.delivery_charge_amount += num(sm.delivery_charge_amount);
106
+ tm.delivery_charge_count += num(sm.delivery_charge_count);
107
+ tm.tip_amount += num(sm.tip_amount);
108
+ tm.discount_amount += num(sm.discount_amount);
109
+ tm.refund_amount += num(sm.refund_amount);
110
+ tm.tax_amount += num(sm.tax_amount);
111
+ }
112
+ if (target.distance != null && source.distance != null) {
113
+ const tDist = target.distance;
114
+ const sDist = source.distance;
115
+ tDist.sum_meters = num(tDist.sum_meters) + num(sDist.sum_meters);
116
+ tDist.count = num(tDist.count) + num(sDist.count);
117
+ for (const bucket of MATERIALIZED_REPORTS_1.MATERIALIZED_DELIVERY_DISTANCE_BUCKETS) {
118
+ tDist[bucket.key] = num(tDist[bucket.key]) + num(sDist[bucket.key]);
119
+ }
120
+ }
121
+ if (target.timing != null && source.timing != null) {
122
+ const tt = target.timing;
123
+ const st = source.timing;
124
+ tt.graded_count += num(st.graded_count);
125
+ tt.dispatch_lag_sum_minutes += num(st.dispatch_lag_sum_minutes);
126
+ tt.complete_sum_minutes += num(st.complete_sum_minutes);
127
+ tt.total_sum_minutes += num(st.total_sum_minutes);
128
+ tt.exact_completion_count += num(st.exact_completion_count);
129
+ tt.assignment_sum_minutes += num(st.assignment_sum_minutes);
130
+ tt.assignment_count += num(st.assignment_count);
131
+ tt.pickup_wait_sum_minutes += num(st.pickup_wait_sum_minutes);
132
+ tt.pickup_wait_count += num(st.pickup_wait_count);
133
+ tt.transit_sum_minutes += num(st.transit_sum_minutes);
134
+ tt.transit_count += num(st.transit_count);
135
+ tt.cancel_sum_minutes += num(st.cancel_sum_minutes);
136
+ tt.cancel_count += num(st.cancel_count);
137
+ tt.cancelled_after_pickup_count += num(st.cancelled_after_pickup_count);
138
+ tt.status_updates_sum += num(st.status_updates_sum);
139
+ tt.status_updates_count += num(st.status_updates_count);
140
+ tt.promise_known_count += num(st.promise_known_count);
141
+ tt.on_time_count += num(st.on_time_count);
142
+ tt.late_count += num(st.late_count);
143
+ tt.late_minutes_sum += num(st.late_minutes_sum);
144
+ }
145
+ for (const [riderId, row] of Object.entries(source.riders ?? {})) {
146
+ target.riders ?? (target.riders = {});
147
+ (_a = target.riders)[riderId] ?? (_a[riderId] = {
148
+ rider_name: null,
149
+ count: 0,
150
+ completed_count: 0,
151
+ cancelled_count: 0,
152
+ in_progress_count: 0,
153
+ rider_revenue_amount: 0,
154
+ distance_sum_meters: 0,
155
+ first_delivery_at: null,
156
+ last_delivery_at: null,
157
+ });
158
+ mergeRiderRow(target.riders[riderId], row);
159
+ }
160
+ for (const [city, row] of Object.entries(source.areas ?? {})) {
161
+ target.areas ?? (target.areas = {});
162
+ (_b = target.areas)[city] ?? (_b[city] = {
163
+ count: 0,
164
+ completed_count: 0,
165
+ cancelled_count: 0,
166
+ rider_revenue_amount: 0,
167
+ distance_sum_meters: 0,
168
+ by_hour: {},
169
+ });
170
+ mergeAreaRow(target.areas[city], row);
171
+ }
172
+ return target;
173
+ }
@@ -0,0 +1,84 @@
1
+ import { IMaterializedDeliveryCounters } from '../../schemas/types/materialized_tenant_delivery_reports';
2
+ /**
3
+ * M4 delivery - key grammar, the order join, and the accumulators.
4
+ *
5
+ * ## Adoption is the headline, and it needs BOTH populations
6
+ *
7
+ * The `deliveries` collection is written ONLY by the rider app, so for a tenant that does
8
+ * not use it the collection is EMPTY. An empty collection renders as "no deliveries"
9
+ * rather than "no visibility" - which is why the counters always carry
10
+ * `delivery_order_count` (from the ORDERS stage) beside `delivered_via_app_count` (from the
11
+ * DELIVERIES stage). Neither stage alone can compute `off_app_count`.
12
+ *
13
+ * `off_app_count` is NOT an error state: it is the pool the rider app can win.
14
+ *
15
+ * ## The join
16
+ *
17
+ * A delivery document carries neither the platform nor the city, so the key
18
+ * `<PLATFORM>:<CITY>` and every order-derived money figure come from joining by
19
+ * `order_id`. An order with no platform/city details falls into an explicit UNKNOWN
20
+ * bucket rather than being dropped silently - a missing dimension must still show up in
21
+ * the totals.
22
+ *
23
+ * ## One order, N attempts
24
+ *
25
+ * The unique `order_id + rider_id` index allows a re-assignment to create a SECOND
26
+ * delivery for the same order. `deliveries.count` therefore counts ATTEMPTS while
27
+ * `delivery_order_count` counts ORDERS, and the two are deliberately not expected to
28
+ * match. `off_app_count` is computed from a SET difference so a reassigned order is never
29
+ * counted as off-app.
30
+ */
31
+ /** The key token used when a dimension is missing, so nothing is silently dropped. */
32
+ export declare const DELIVERY_UNKNOWN_TOKEN = "UNKNOWN";
33
+ export declare const MATERIALIZED_DELIVERY_KEY_SEPARATOR = ":";
34
+ /** Builds `<PLATFORM>:<CITY>`, substituting UNKNOWN for missing dimensions. */
35
+ export declare function buildMaterializedDeliveryKey(platform: unknown, city: unknown): string;
36
+ /** Splits a key back into its parts, or null when it is malformed. */
37
+ export declare function parseMaterializedDeliveryKey(key: unknown): {
38
+ platform: string;
39
+ city: string;
40
+ } | null;
41
+ /** A zeroed counter block. */
42
+ export declare function freshDeliveryCounters(): IMaterializedDeliveryCounters;
43
+ /** Which fixed distance bucket a metre value falls in. */
44
+ export declare function deliveryDistanceBucketKey(meters: number): string;
45
+ /**
46
+ * A per-key accumulation buffer.
47
+ *
48
+ * The two ID SETS are what make adoption order-independent: `off_app_count` is the set
49
+ * difference between the orders that had a delivery and those that did not, so it does
50
+ * not matter whether the orders stage or the deliveries stage runs first.
51
+ */
52
+ export interface IDeliveryAccumulator {
53
+ counters: IMaterializedDeliveryCounters;
54
+ deliveryOrderIds: Set<string>;
55
+ deliveredOrderIds: Set<string>;
56
+ watermark: Date | null;
57
+ }
58
+ /** A fresh buffer. */
59
+ export declare function freshDeliveryAccumulator(): IDeliveryAccumulator;
60
+ /** True when an order is a DELIVERY order (it has delivery details). */
61
+ export declare function isDeliveryOrder(order: any): boolean;
62
+ /**
63
+ * Consumes ONE delivery ORDER - the ADOPTION half of the join.
64
+ *
65
+ * Order-side money is counted HERE rather than on the delivery, because a cancelled
66
+ * delivery must not lose the order figures the operator recognises.
67
+ */
68
+ export declare function addDeliveryOrder(acc: IDeliveryAccumulator, order: any): void;
69
+ /**
70
+ * Consumes ONE delivery document - the APP-SIDE half of the join.
71
+ *
72
+ * `order` may be null (the order was not staged): the delivery still counts toward
73
+ * adoption and its own fields, but the order-derived money and the area cannot be
74
+ * attributed, so it lands in the UNKNOWN bucket.
75
+ */
76
+ export declare function addDelivery(acc: IDeliveryAccumulator, delivery: any, order: any | null, key: string): void;
77
+ /**
78
+ * Computes the DERIVED adoption figures and prunes the bounded maps.
79
+ *
80
+ * Call ONCE per key, after both stages have been consumed. `off_app_count` is a set
81
+ * difference, so an order reassigned to a second rider is NOT counted as off-app even
82
+ * though there are more deliveries than orders.
83
+ */
84
+ export declare function finalizeDeliveryAccumulator(acc: IDeliveryAccumulator): IMaterializedDeliveryCounters;