@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,93 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.buildRiderDailyReport = buildRiderDailyReport;
4
+ const delivery_1 = require("../../constants/enums/delivery");
5
+ const materialized_rider_daily_reports_1 = require("../../schemas/models/materialized_rider_daily_reports");
6
+ const completedOrCancelled = (status) => status === delivery_1.DELIVERY_STATUS_ENUM.COMPLETED || status === delivery_1.DELIVERY_STATUS_ENUM.CANCELLED;
7
+ const finalEarnings = (delivery) => {
8
+ const earnings = delivery.rider_earnings;
9
+ if (earnings != null) {
10
+ return earnings.status === 'FINAL' ? Number(earnings.amount) || 0 : 0;
11
+ }
12
+ return Number(delivery.rider_revenue) || 0;
13
+ };
14
+ function buildRiderDailyReport({ rider_id, local_date, deliveries, computedAt = new Date(), }) {
15
+ if (rider_id.trim() === '' || local_date.trim() === '')
16
+ return null;
17
+ const rows = (deliveries ?? []).filter((delivery) => completedOrCancelled(delivery?.status));
18
+ if (rows.length === 0)
19
+ return null;
20
+ const tenants = {};
21
+ let deliveriesCount = 0;
22
+ let completed = 0;
23
+ let cancelled = 0;
24
+ let earnings = 0;
25
+ let distanceMeters = 0;
26
+ let onTime = 0;
27
+ let late = 0;
28
+ let firstDeliveryAt = null;
29
+ let lastDeliveryAt = null;
30
+ for (const delivery of rows) {
31
+ const tenantId = delivery.tenant_id == null ? '' : String(delivery.tenant_id);
32
+ if (tenantId === '')
33
+ continue;
34
+ const isCompleted = delivery.status === delivery_1.DELIVERY_STATUS_ENUM.COMPLETED;
35
+ const isCancelled = delivery.status === delivery_1.DELIVERY_STATUS_ENUM.CANCELLED;
36
+ const earning = finalEarnings(delivery);
37
+ const distance = Number(delivery.distance_in_meters_from_store) || 0;
38
+ const tenant = (tenants[tenantId] ?? (tenants[tenantId] = {
39
+ deliveries: 0,
40
+ completed: 0,
41
+ cancelled: 0,
42
+ earnings: 0,
43
+ distance_meters: 0,
44
+ }));
45
+ tenant.deliveries += 1;
46
+ tenant.completed += isCompleted ? 1 : 0;
47
+ tenant.cancelled += isCancelled ? 1 : 0;
48
+ tenant.earnings += earning;
49
+ tenant.distance_meters += distance;
50
+ deliveriesCount += 1;
51
+ completed += isCompleted ? 1 : 0;
52
+ cancelled += isCancelled ? 1 : 0;
53
+ earnings += earning;
54
+ distanceMeters += distance;
55
+ const expected = delivery.expected_delivery_at == null ? null : new Date(delivery.expected_delivery_at);
56
+ const delivered = delivery.delivered_at == null ? null : new Date(delivery.delivered_at);
57
+ if (expected != null &&
58
+ !Number.isNaN(expected.getTime()) &&
59
+ delivered != null &&
60
+ !Number.isNaN(delivered.getTime())) {
61
+ if (delivered <= expected)
62
+ onTime += 1;
63
+ else
64
+ late += 1;
65
+ }
66
+ const createdAt = delivery.createdAt == null ? null : new Date(delivery.createdAt);
67
+ if (createdAt != null && !Number.isNaN(createdAt.getTime())) {
68
+ if (firstDeliveryAt == null || createdAt < firstDeliveryAt)
69
+ firstDeliveryAt = createdAt;
70
+ if (lastDeliveryAt == null || createdAt > lastDeliveryAt)
71
+ lastDeliveryAt = createdAt;
72
+ }
73
+ }
74
+ if (deliveriesCount === 0)
75
+ return null;
76
+ return {
77
+ rider_id,
78
+ local_date,
79
+ deliveries: deliveriesCount,
80
+ completed,
81
+ cancelled,
82
+ earnings,
83
+ distance_meters: distanceMeters,
84
+ on_time: onTime,
85
+ late,
86
+ tenants,
87
+ first_delivery_at: firstDeliveryAt,
88
+ last_delivery_at: lastDeliveryAt,
89
+ schema_version: materialized_rider_daily_reports_1.MATERIALIZED_RIDER_DAILY_REPORTS_SCHEMA_VERSION,
90
+ source_watermark: computedAt,
91
+ computed_at: computedAt,
92
+ };
93
+ }
@@ -0,0 +1,49 @@
1
+ import { IMaterializedRiderDailyReport } from '../../schemas/types/materialized_rider_daily_reports';
2
+ /** Shared response shape for the rider-scoped, cross-tenant self report. */
3
+ export interface IRiderReportDay {
4
+ local_date: string;
5
+ deliveries: number;
6
+ completed: number;
7
+ cancelled: number;
8
+ earnings: number;
9
+ distance_meters: number;
10
+ on_time: number;
11
+ late: number;
12
+ }
13
+ export interface IRiderReportTenant {
14
+ tenant_id: string;
15
+ tenant_name: string | null;
16
+ deliveries: number;
17
+ completed: number;
18
+ cancelled: number;
19
+ earnings: number;
20
+ distance_meters: number;
21
+ }
22
+ export interface IRiderReport {
23
+ rider_id: string;
24
+ from: string;
25
+ to: string;
26
+ totals: {
27
+ deliveries: number;
28
+ completed: number;
29
+ cancelled: number;
30
+ earnings: number;
31
+ distance_meters: number;
32
+ on_time: number;
33
+ late: number;
34
+ active_days: number;
35
+ };
36
+ days: IRiderReportDay[];
37
+ tenants: IRiderReportTenant[];
38
+ }
39
+ /**
40
+ * Pure mapping from materialized rider-day documents to the rider app report.
41
+ * The tenant-name lookup stays in the backend adapter.
42
+ */
43
+ export declare function buildRiderReport({ rider_id, from, to, documents, tenantNames, }: {
44
+ rider_id: string;
45
+ from: string;
46
+ to: string;
47
+ documents: IMaterializedRiderDailyReport[];
48
+ tenantNames?: Record<string, string | null>;
49
+ }): IRiderReport;
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.buildRiderReport = buildRiderReport;
4
+ /**
5
+ * Pure mapping from materialized rider-day documents to the rider app report.
6
+ * The tenant-name lookup stays in the backend adapter.
7
+ */
8
+ function buildRiderReport({ rider_id, from, to, documents, tenantNames = {}, }) {
9
+ const days = [];
10
+ const tenants = new Map();
11
+ const totals = {
12
+ deliveries: 0,
13
+ completed: 0,
14
+ cancelled: 0,
15
+ earnings: 0,
16
+ distance_meters: 0,
17
+ on_time: 0,
18
+ late: 0,
19
+ active_days: 0,
20
+ };
21
+ for (const doc of documents ?? []) {
22
+ const localDate = String(doc.local_date ?? '');
23
+ if (localDate === '')
24
+ continue;
25
+ const day = {
26
+ local_date: localDate,
27
+ deliveries: Number(doc.deliveries) || 0,
28
+ completed: Number(doc.completed) || 0,
29
+ cancelled: Number(doc.cancelled) || 0,
30
+ earnings: Number(doc.earnings) || 0,
31
+ distance_meters: Number(doc.distance_meters) || 0,
32
+ on_time: Number(doc.on_time) || 0,
33
+ late: Number(doc.late) || 0,
34
+ };
35
+ days.push(day);
36
+ for (const [tenantId, row] of Object.entries(doc.tenants ?? {})) {
37
+ const tenant = tenants.get(tenantId) ?? {
38
+ tenant_id: tenantId,
39
+ tenant_name: tenantNames[tenantId] ?? null,
40
+ deliveries: 0,
41
+ completed: 0,
42
+ cancelled: 0,
43
+ earnings: 0,
44
+ distance_meters: 0,
45
+ };
46
+ tenant.deliveries += Number(row.deliveries) || 0;
47
+ tenant.completed += Number(row.completed) || 0;
48
+ tenant.cancelled += Number(row.cancelled) || 0;
49
+ tenant.earnings += Number(row.earnings) || 0;
50
+ tenant.distance_meters += Number(row.distance_meters) || 0;
51
+ tenants.set(tenantId, tenant);
52
+ }
53
+ totals.deliveries += day.deliveries;
54
+ totals.completed += day.completed;
55
+ totals.cancelled += day.cancelled;
56
+ totals.earnings += day.earnings;
57
+ totals.distance_meters += day.distance_meters;
58
+ totals.on_time += day.on_time;
59
+ totals.late += day.late;
60
+ }
61
+ totals.active_days = days.length;
62
+ return {
63
+ rider_id,
64
+ from,
65
+ to,
66
+ totals,
67
+ days,
68
+ tenants: [...tenants.values()].sort((a, b) => b.earnings - a.earnings),
69
+ };
70
+ }
@@ -1,5 +1,9 @@
1
1
  import { MATERIALIZED_REPORT_SCOPE_ENUM, MATERIALIZED_REPORT_TYPE_ENUM, REPORT_SALE_TYPE_ENUM } from '../../constants';
2
- import { MATERIALIZED_REPORT_KEY_FILTER_ENUM } from '../../constants/MATERIALIZED_REPORTS';
2
+ import { MATERIALIZED_DISCOUNT_ENTRY_KIND_ENUM, MATERIALIZED_DISCOUNT_LEVEL_ENUM, MATERIALIZED_DISCOUNT_SLOT_ENUM, MATERIALIZED_DISCOUNT_SUB_KIND_ENUM, MATERIALIZED_REPORT_KEY_FILTER_ENUM, SALES_COMPARISON_BASELINE_ENUM } from '../../constants/MATERIALIZED_REPORTS';
3
+ import { IMaterializedDiscountOrderCounters } from '../../schemas/types/materialized_tenant_discount_reports';
4
+ import { IMaterializedPrepTimeCounters } from '../../schemas/types/materialized_tenant_prep_time_reports';
5
+ import { IMaterializedSalesComparisonCounters, IMaterializedSalesComparisonCounterRow } from '../../schemas/types/materialized_tenant_sales_comparison_reports';
6
+ import { IMaterializedPaymentsComparisonCounters } from '../../schemas/types/materialized_tenant_payments_comparison_reports';
3
7
  import { IMaterializedReportOrderMetric, IMaterializedReportPaymentMetric } from '../../schemas/types/materialized_tenant_sales_overview_reports';
4
8
  import { IGetMaterializedReportSelectionSpec } from './report-calendar';
5
9
  /**
@@ -182,3 +186,295 @@ export interface IMaterializedTenantSalesOverviewAggregatedReport {
182
186
  sale_type_key_filters: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
183
187
  sale_type_metrics: Record<string, IMaterializedTenantSalesOverviewAggregatedKeyMetrics>;
184
188
  }
189
+ /**
190
+ * Response of `POST /reports/discounts` — ONE record per matched tenant,
191
+ * computed entirely inside MongoDB. The record's `discount_counters` map is
192
+ * shaped EXACTLY like a stored document's (summed across the matched scope
193
+ * documents, which the read contract guarantees are disjoint), so the toolkit
194
+ * formatter consumes the aggregated record and a stored document through the
195
+ * same code path.
196
+ */
197
+ export interface IMaterializedTenantDiscountAggregatedReport {
198
+ tenant_id: string;
199
+ brand_id: string;
200
+ /** Freshness of the folded data (max across the matched documents). */
201
+ max_iteration: number;
202
+ max_updated_at: Date | null;
203
+ /** EXACT count of stored scope documents folded into this record. */
204
+ matched_documents: number;
205
+ /** The key grammar of the folded documents (never mixed). */
206
+ sale_type_key_filters: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
207
+ /** Per-key counters, summed across the matched scope documents. */
208
+ discount_counters: Record<string, IMaterializedDiscountOrderCounters>;
209
+ /** Lexicographic bounds of the matched `scope_field` values. */
210
+ first_scope_field: string | null;
211
+ last_scope_field: string | null;
212
+ }
213
+ /** One itemized discount row of the drill-down list. */
214
+ export interface IMaterializedDiscountDetailsRow {
215
+ kind: MATERIALIZED_DISCOUNT_ENTRY_KIND_ENUM;
216
+ slot: MATERIALIZED_DISCOUNT_SLOT_ENUM | null;
217
+ sub_kind: MATERIALIZED_DISCOUNT_SUB_KIND_ENUM;
218
+ level: MATERIALIZED_DISCOUNT_LEVEL_ENUM;
219
+ entry_key: string;
220
+ order_id: string;
221
+ order_number: number | null;
222
+ item_id: string | null;
223
+ item_name: string | null;
224
+ /** The MONEY this row applied, in CENTS (the raw rate rides on `rate`). */
225
+ amount: number;
226
+ rate: number | null;
227
+ is_percentage: boolean | null;
228
+ discount_id: string | null;
229
+ name: string | null;
230
+ reference_number: string | null;
231
+ reason: string | null;
232
+ staff_id: string | null;
233
+ staff_name: string | null;
234
+ order_status: string;
235
+ platform: string;
236
+ created_at: Date;
237
+ local_hour: string | null;
238
+ }
239
+ /**
240
+ * Page cursor of the drill-down: strictly-after on
241
+ * `(time DESC, order_id ASC, entry_key ASC)`. `entry_key` is the row's stable
242
+ * identity INSIDE an order, so two rows of one order can never collide.
243
+ */
244
+ export interface IMaterializedDiscountDetailsCursor {
245
+ time: string;
246
+ order_id: string;
247
+ entry_key: string;
248
+ }
249
+ /** Response of `POST /reports/discounts/details`. */
250
+ export interface IMaterializedDiscountDetailsPage {
251
+ /** Stored rows of the page, newest-first. */
252
+ rows: IMaterializedDiscountDetailsRow[];
253
+ /** Cursor to pass as `cursor` for the next page (null at the end). */
254
+ next_cursor: IMaterializedDiscountDetailsCursor | null;
255
+ }
256
+ /**
257
+ * One tenant's prep time READ record (`POST /reports/prep-time`), computed
258
+ * entirely inside MongoDB.
259
+ *
260
+ * The record `prep_time_counters` map is shaped EXACTLY like a stored document's
261
+ * (folded across the matched scope documents, which the read contract guarantees
262
+ * are disjoint), so the toolkit formatter consumes the aggregated record and a
263
+ * stored document through the same code path.
264
+ *
265
+ * NOTE the aggregates: `duration.min` / `duration.max` / `late_items.worst_delta`
266
+ * are FOLDED by the pipeline, never summed - a period's minimum is the minimum of
267
+ * its days.
268
+ */
269
+ export interface IMaterializedTenantPrepTimeAggregatedReport {
270
+ tenant_id: string;
271
+ brand_id: string;
272
+ /** EXACT count of stored scope documents folded into this record. */
273
+ matched_documents: number;
274
+ /** The key grammar of the folded documents (never mixed). */
275
+ sale_type_key_filters: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
276
+ /** Per-key counters, folded across the matched scope documents. */
277
+ prep_time_counters: Record<string, IMaterializedPrepTimeCounters>;
278
+ /** The SAME counters as rows - the shape the pipeline actually folds. */
279
+ prep_time_counter_rows: {
280
+ key: string;
281
+ counters: IMaterializedPrepTimeCounters;
282
+ }[];
283
+ }
284
+ /**
285
+ * Body of `POST /reports/sales-comparison` — the shared `{ tenants, selection }`
286
+ * contract PLUS the baseline to compare against.
287
+ *
288
+ * The SERVER derives the comparison range from `selection` and `baseline`; the
289
+ * client never builds the pairing. `NONE` returns `comparison: null`.
290
+ */
291
+ export interface IGetMaterializedTenantSalesComparisonReportsBody extends IGetMaterializedReportBody {
292
+ baseline: SALES_COMPARISON_BASELINE_ENUM;
293
+ }
294
+ /**
295
+ * ONE tenant's Sales Comparison record for ONE series (current or comparison),
296
+ * computed entirely inside MongoDB and shaped like a stored document's
297
+ * `sales_counters`. Feeding the aggregated record and a stored document through
298
+ * the same toolkit formatter is deliberate.
299
+ */
300
+ export interface IMaterializedTenantSalesComparisonAggregatedReport {
301
+ tenant_id: string;
302
+ brand_id: string;
303
+ /** Freshness of the folded data (max across the matched documents). */
304
+ max_iteration: number;
305
+ max_updated_at: Date | null;
306
+ /** EXACT count of stored scope documents folded into this record. */
307
+ matched_documents: number;
308
+ /** The key grammar of the folded documents (never mixed). */
309
+ sale_type_key_filters: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
310
+ /** Per-key counters, summed across the matched scope documents. */
311
+ sales_counters: Record<string, IMaterializedSalesComparisonCounters>;
312
+ /** The SAME counters as rows - the read-path shape. */
313
+ sales_counter_rows: IMaterializedSalesComparisonCounterRow[];
314
+ /** Lexicographic bounds of the matched `scope_field` values. */
315
+ first_scope_field: string | null;
316
+ last_scope_field: string | null;
317
+ }
318
+ /**
319
+ * Response of `POST /reports/sales-comparison`. The comparison is NEVER a
320
+ * stored delta: both series are ordinary reads; the formatter subtracts them.
321
+ * `comparison` is `null` for `baseline: NONE` and an EMPTY array when the
322
+ * derived window has no documents (a real zero, not missing data).
323
+ */
324
+ export interface IMaterializedTenantSalesComparisonReadResponse {
325
+ tenants: string[];
326
+ current: IMaterializedTenantSalesComparisonAggregatedReport[];
327
+ comparison: IMaterializedTenantSalesComparisonAggregatedReport[] | null;
328
+ }
329
+ /**
330
+ * Body of `POST /reports/sales-comparison/details` — order rows behind the
331
+ * current series. Rows are ORDER rows only: a payment row would double-count a
332
+ * split payment (Payments Comparison is a different report).
333
+ */
334
+ export interface IGetMaterializedSalesComparisonDetailsBody extends IGetMaterializedReportBody {
335
+ /** Optional client-side-style narrowing, applied to the stored rows. */
336
+ platforms?: string[] | null;
337
+ order_statuses?: string[] | null;
338
+ cursor?: IMaterializedSalesComparisonDetailsCursor | null;
339
+ /** Default 10, capped at 50. */
340
+ limit?: number;
341
+ }
342
+ /** Drill-down cursor: strictly-after on `(time DESC, order_id ASC)`. */
343
+ export interface IMaterializedSalesComparisonDetailsCursor {
344
+ /** ISO settled instant of the last row of the previous page. */
345
+ time: string;
346
+ order_id: string;
347
+ }
348
+ /** One order row of the Sales Comparison drill-down. */
349
+ export interface IMaterializedSalesComparisonDetailsRow {
350
+ tenant_id: string;
351
+ order_id: string;
352
+ order_number: number | null;
353
+ /** ISO settled instant. */
354
+ time: string;
355
+ order_status: string;
356
+ platform: string;
357
+ /** CENTS. */
358
+ net_amount: number;
359
+ discount_amount: number;
360
+ item_count: number;
361
+ }
362
+ /** Response of `POST /reports/sales-comparison/details`. */
363
+ export interface IMaterializedSalesComparisonDetailsPage {
364
+ rows: IMaterializedSalesComparisonDetailsRow[];
365
+ next_cursor: IMaterializedSalesComparisonDetailsCursor | null;
366
+ }
367
+ /**
368
+ * Body of `POST /reports/hourly-comparison` — the shared `{ tenants, selection }`
369
+ * contract plus the derived baseline. Live is compiled from current settled
370
+ * orders; historical reads the hour documents written by the close.
371
+ */
372
+ export interface IGetMaterializedTenantHourlyComparisonReportsBody extends IGetMaterializedReportBody {
373
+ baseline: SALES_COMPARISON_BASELINE_ENUM;
374
+ }
375
+ /**
376
+ * ONE tenant's hourly PROFILE for ONE series (current or comparison).
377
+ *
378
+ * `hour_counters` is keyed by the hour-of-day (`'0'`…`'23'`), then by the
379
+ * `ORDER_STATUS:PLATFORM` key. An hour with no documents is ABSENT (= zero),
380
+ * never fabricated.
381
+ */
382
+ export interface IMaterializedTenantHourlyComparisonAggregatedReport {
383
+ tenant_id: string;
384
+ brand_id: string;
385
+ /** EXACT count of stored hour documents folded into this profile. */
386
+ matched_documents: number;
387
+ max_iteration: number;
388
+ max_updated_at: Date | null;
389
+ sale_type_key_filters: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
390
+ hour_counters: Record<string, Record<string, IMaterializedSalesComparisonCounters>>;
391
+ first_scope_field: string | null;
392
+ last_scope_field: string | null;
393
+ }
394
+ /**
395
+ * Response of `POST /reports/hourly-comparison`. `comparison` is `null` for
396
+ * `baseline: NONE` and an EMPTY array for a valid baseline window with no sales.
397
+ */
398
+ export interface IMaterializedTenantHourlyComparisonReadResponse {
399
+ tenants: string[];
400
+ current: IMaterializedTenantHourlyComparisonAggregatedReport[];
401
+ comparison: IMaterializedTenantHourlyComparisonAggregatedReport[] | null;
402
+ }
403
+ /** The drill-down row/cursor are the same ORDER-row contract as Sales Comparison. */
404
+ export type IMaterializedHourlyComparisonDetailsRow = IMaterializedSalesComparisonDetailsRow;
405
+ export type IMaterializedHourlyComparisonDetailsCursor = IMaterializedSalesComparisonDetailsCursor;
406
+ /**
407
+ * Body of `POST /reports/hourly-comparison/details` — `hour` (0–23) is REQUIRED:
408
+ * the drill-down is always one hour-of-day of the current profile.
409
+ */
410
+ export interface IGetMaterializedHourlyComparisonDetailsBody extends IGetMaterializedReportBody {
411
+ hour: number;
412
+ platforms?: string[] | null;
413
+ order_statuses?: string[] | null;
414
+ cursor?: IMaterializedHourlyComparisonDetailsCursor | null;
415
+ limit?: number;
416
+ }
417
+ /** Response of `POST /reports/hourly-comparison/details`. */
418
+ export interface IMaterializedHourlyComparisonDetailsPage {
419
+ rows: IMaterializedHourlyComparisonDetailsRow[];
420
+ next_cursor: IMaterializedHourlyComparisonDetailsCursor | null;
421
+ }
422
+ /** Body of `POST /reports/payments-comparison`. */
423
+ export interface IGetMaterializedTenantPaymentsComparisonReportsBody extends IGetMaterializedReportBody {
424
+ baseline: SALES_COMPARISON_BASELINE_ENUM;
425
+ }
426
+ /** ONE tenant's Payments Comparison record for ONE series. */
427
+ export interface IMaterializedTenantPaymentsComparisonAggregatedReport {
428
+ tenant_id: string;
429
+ brand_id: string;
430
+ matched_documents: number;
431
+ max_iteration: number;
432
+ max_updated_at: Date | null;
433
+ sale_type_key_filters: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
434
+ payment_counters: Record<string, IMaterializedPaymentsComparisonCounters>;
435
+ payment_counter_rows: {
436
+ key: string;
437
+ counters: IMaterializedPaymentsComparisonCounters;
438
+ }[];
439
+ first_scope_field: string | null;
440
+ last_scope_field: string | null;
441
+ }
442
+ /** Response of `POST /reports/payments-comparison`. */
443
+ export interface IMaterializedTenantPaymentsComparisonReadResponse {
444
+ tenants: string[];
445
+ current: IMaterializedTenantPaymentsComparisonAggregatedReport[];
446
+ comparison: IMaterializedTenantPaymentsComparisonAggregatedReport[] | null;
447
+ }
448
+ /** Drill-down cursor: `(time DESC, order_id ASC, payment_id ASC)`. */
449
+ export interface IMaterializedPaymentsComparisonDetailsCursor {
450
+ time: string;
451
+ order_id: string;
452
+ payment_id: string;
453
+ }
454
+ /** One payment row of the drill-down. */
455
+ export interface IMaterializedPaymentsComparisonDetailsRow {
456
+ tenant_id: string;
457
+ order_id: string;
458
+ order_number: number | null;
459
+ payment_id: string;
460
+ time: string;
461
+ payment_type: string;
462
+ order_status: string;
463
+ payment_amount: number;
464
+ amount_due: number;
465
+ amount_paid: number;
466
+ amount_refunded: number;
467
+ card_charges: number;
468
+ }
469
+ /** Body of `POST /reports/payments-comparison/details`. */
470
+ export interface IGetMaterializedPaymentsComparisonDetailsBody extends IGetMaterializedReportBody {
471
+ payment_methods?: string[] | null;
472
+ order_statuses?: string[] | null;
473
+ cursor?: IMaterializedPaymentsComparisonDetailsCursor | null;
474
+ limit?: number;
475
+ }
476
+ /** Response of `POST /reports/payments-comparison/details`. */
477
+ export interface IMaterializedPaymentsComparisonDetailsPage {
478
+ rows: IMaterializedPaymentsComparisonDetailsRow[];
479
+ next_cursor: IMaterializedPaymentsComparisonDetailsCursor | null;
480
+ }
@@ -43,6 +43,24 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
43
43
  pickup_food_image_url?: string | null | undefined;
44
44
  dropoff_food_image_url?: string | null | undefined;
45
45
  tracking_enabled?: boolean | null | undefined;
46
+ assigned_at?: NativeDate | null | undefined;
47
+ picked_up_at?: NativeDate | null | undefined;
48
+ expected_delivery_at?: NativeDate | null | undefined;
49
+ delivered_at?: NativeDate | null | undefined;
50
+ cancelled_at?: NativeDate | null | undefined;
51
+ status_updated_count?: number | null | undefined;
52
+ delivery_minutes?: number | null | undefined;
53
+ rider_earnings?: {
54
+ version: number;
55
+ status: string;
56
+ amount: number;
57
+ rule_type: string;
58
+ per_meter: number;
59
+ distance_step: number;
60
+ distance_meters: number;
61
+ delivery_charge: number;
62
+ calculated_at: NativeDate;
63
+ } | null | undefined;
46
64
  }, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
47
65
  createdAt: NativeDate;
48
66
  updatedAt: NativeDate;
@@ -82,6 +100,24 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
82
100
  pickup_food_image_url?: string | null | undefined;
83
101
  dropoff_food_image_url?: string | null | undefined;
84
102
  tracking_enabled?: boolean | null | undefined;
103
+ assigned_at?: NativeDate | null | undefined;
104
+ picked_up_at?: NativeDate | null | undefined;
105
+ expected_delivery_at?: NativeDate | null | undefined;
106
+ delivered_at?: NativeDate | null | undefined;
107
+ cancelled_at?: NativeDate | null | undefined;
108
+ status_updated_count?: number | null | undefined;
109
+ delivery_minutes?: number | null | undefined;
110
+ rider_earnings?: {
111
+ version: number;
112
+ status: string;
113
+ amount: number;
114
+ rule_type: string;
115
+ per_meter: number;
116
+ distance_step: number;
117
+ distance_meters: number;
118
+ delivery_charge: number;
119
+ calculated_at: NativeDate;
120
+ } | null | undefined;
85
121
  }>> & import("mongoose").FlatRecord<{
86
122
  createdAt: NativeDate;
87
123
  updatedAt: NativeDate;
@@ -121,6 +157,24 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
121
157
  pickup_food_image_url?: string | null | undefined;
122
158
  dropoff_food_image_url?: string | null | undefined;
123
159
  tracking_enabled?: boolean | null | undefined;
160
+ assigned_at?: NativeDate | null | undefined;
161
+ picked_up_at?: NativeDate | null | undefined;
162
+ expected_delivery_at?: NativeDate | null | undefined;
163
+ delivered_at?: NativeDate | null | undefined;
164
+ cancelled_at?: NativeDate | null | undefined;
165
+ status_updated_count?: number | null | undefined;
166
+ delivery_minutes?: number | null | undefined;
167
+ rider_earnings?: {
168
+ version: number;
169
+ status: string;
170
+ amount: number;
171
+ rule_type: string;
172
+ per_meter: number;
173
+ distance_step: number;
174
+ distance_meters: number;
175
+ delivery_charge: number;
176
+ calculated_at: NativeDate;
177
+ } | null | undefined;
124
178
  }> & Required<{
125
179
  _id: import("mongoose").Types.ObjectId;
126
180
  }> & {
@@ -93,6 +93,81 @@ exports.DeliveriesSchema = new mongoose_1.Schema({
93
93
  type: Boolean,
94
94
  required: false,
95
95
  },
96
+ // ---- Delivery metrics capture (M4, owner-approved) ----
97
+ //
98
+ // ALL SIX ARE OPTIONAL AND NULLABLE, which is what makes the addition safe:
99
+ // existing documents stay valid, a rider app that has not been updated simply
100
+ // leaves them null, and the report reads null as "not instrumented" rather than
101
+ // as zero - the same honesty rule as the prep time report's UNMEASURED bucket.
102
+ //
103
+ // Each timestamp is stamped ONCE on FIRST ENTRY to its state and never
104
+ // overwritten, mirroring how `closing.difference` is frozen at close in the cash
105
+ // drawer session. `updatedAt` moves on ANY mutation (a note edit, an image
106
+ // upload), which is exactly why these exact instants are needed.
107
+ assigned_at: {
108
+ type: mongoose_1.Schema.Types.Date,
109
+ required: false,
110
+ default: null,
111
+ },
112
+ picked_up_at: {
113
+ type: mongoose_1.Schema.Types.Date,
114
+ required: false,
115
+ default: null,
116
+ },
117
+ expected_delivery_at: {
118
+ type: mongoose_1.Schema.Types.Date,
119
+ required: false,
120
+ default: null,
121
+ },
122
+ delivered_at: {
123
+ type: mongoose_1.Schema.Types.Date,
124
+ required: false,
125
+ default: null,
126
+ },
127
+ cancelled_at: {
128
+ type: mongoose_1.Schema.Types.Date,
129
+ required: false,
130
+ default: null,
131
+ },
132
+ /** Incremented on EVERY status write - detects churn no timestamp can express. */
133
+ status_updated_count: {
134
+ type: Number,
135
+ required: false,
136
+ min: 0,
137
+ default: 0,
138
+ },
139
+ /** Stored duration at COMPLETED, mirroring the proven `ready_minutes` precedent. */
140
+ delivery_minutes: {
141
+ type: Number,
142
+ required: false,
143
+ min: 0,
144
+ default: null,
145
+ },
146
+ rider_earnings: {
147
+ type: new mongoose_1.Schema({
148
+ amount: { type: Number, required: true, min: 0, default: 0 },
149
+ status: {
150
+ type: String,
151
+ required: true,
152
+ enum: ['PENDING', 'FINAL', 'VOID'],
153
+ default: 'PENDING',
154
+ },
155
+ rule_type: {
156
+ type: String,
157
+ required: true,
158
+ enum: ['NONE', 'DELIVERY_CHARGES_FULL', 'DISTANCE_ONE_WAY', 'DISTANCE_RETURN'],
159
+ default: 'NONE',
160
+ },
161
+ per_meter: { type: Number, required: true, min: 0, default: 0 },
162
+ distance_step: { type: Number, required: true, min: 0, default: 0 },
163
+ distance_meters: { type: Number, required: true, min: 0, default: 0 },
164
+ delivery_charge: { type: Number, required: true, min: 0, default: 0 },
165
+ calculated_at: { type: mongoose_1.Schema.Types.Date, default: null },
166
+ version: { type: Number, required: true, min: 1, default: 1 },
167
+ }, { _id: false }),
168
+ required: false,
169
+ default: null,
170
+ },
96
171
  createdAt_mins: {
97
172
  type: Number,
98
173
  required: true,