@managesome/eposmatic-toolkit 0.4.9 → 0.4.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (351) hide show
  1. package/esm/constants/MATERIALIZED_REPORTS.js +455 -0
  2. package/esm/constants/enums/delivery.js +8 -0
  3. package/esm/helpers/index.js +3 -0
  4. package/esm/helpers/materialized-reports/index.js +32 -0
  5. package/esm/helpers/materialized-reports/materialized-cash-accumulator-helpers.js +114 -0
  6. package/esm/helpers/materialized-reports/materialized-cash-classification-helpers.js +248 -0
  7. package/esm/helpers/materialized-reports/materialized-cash-close-day-helpers.js +396 -0
  8. package/esm/helpers/materialized-reports/materialized-cash-compile-helpers.js +245 -0
  9. package/esm/helpers/materialized-reports/materialized-delivery-accumulator-helpers.js +170 -0
  10. package/esm/helpers/materialized-reports/materialized-delivery-classification-helpers.js +430 -0
  11. package/esm/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +373 -0
  12. package/esm/helpers/materialized-reports/materialized-delivery-compile-helpers.js +216 -0
  13. package/esm/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +319 -0
  14. package/esm/helpers/materialized-reports/materialized-discount-classification-helpers.js +213 -0
  15. package/esm/helpers/materialized-reports/materialized-discount-close-day-helpers.js +604 -0
  16. package/esm/helpers/materialized-reports/materialized-discount-compile-helpers.js +186 -0
  17. package/esm/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.js +155 -0
  18. package/esm/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.js +199 -0
  19. package/esm/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +115 -0
  20. package/esm/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +89 -0
  21. package/esm/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.js +394 -0
  22. package/esm/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.js +167 -0
  23. package/esm/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +215 -0
  24. package/esm/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +477 -0
  25. package/esm/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +201 -0
  26. package/esm/helpers/materialized-reports/materialized-reports-scope-group-helpers.js +9 -6
  27. package/esm/helpers/materialized-reports/materialized-reports-selection-helpers.js +11 -4
  28. package/esm/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +189 -0
  29. package/esm/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +156 -0
  30. package/esm/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.js +588 -0
  31. package/esm/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.js +175 -0
  32. package/esm/helpers/materialized-reports/tenant-cash-in-out-formatter.js +157 -0
  33. package/esm/helpers/materialized-reports/tenant-delivery-formatter.js +230 -0
  34. package/esm/helpers/materialized-reports/tenant-discount-formatter.js +427 -0
  35. package/esm/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +238 -0
  36. package/esm/helpers/materialized-reports/tenant-payments-comparison-formatter.js +282 -0
  37. package/esm/helpers/materialized-reports/tenant-prep-time-formatter.js +228 -0
  38. package/esm/helpers/materialized-reports/tenant-sales-comparison-formatter.js +346 -0
  39. package/esm/helpers/reporting-contract/index.js +2 -0
  40. package/esm/helpers/reporting-contract/overview-contract.js +123 -0
  41. package/esm/helpers/reporting-contract/report-contract.js +228 -0
  42. package/esm/helpers/rider-earnings/index.js +1 -0
  43. package/esm/helpers/rider-earnings/rider-earnings.js +53 -0
  44. package/esm/helpers/rider-reports/index.js +2 -0
  45. package/esm/helpers/rider-reports/rider-daily-report.js +90 -0
  46. package/esm/helpers/rider-reports/rider-report.js +67 -0
  47. package/esm/helpers/store/common-order-actions.js +3 -2
  48. package/esm/schemas/models/deliveries.js +82 -1
  49. package/esm/schemas/models/index.js +15 -0
  50. package/esm/schemas/models/materialized_credit_bills.js +1 -1
  51. package/esm/schemas/models/materialized_rider_daily_reports.js +39 -0
  52. package/esm/schemas/models/materialized_tenant_cash_entries.js +95 -0
  53. package/esm/schemas/models/materialized_tenant_cash_reports.js +77 -0
  54. package/esm/schemas/models/materialized_tenant_delivery_entries.js +63 -0
  55. package/esm/schemas/models/materialized_tenant_delivery_reports.js +63 -0
  56. package/esm/schemas/models/materialized_tenant_discount_entries.js +156 -0
  57. package/esm/schemas/models/materialized_tenant_discount_reports.js +333 -0
  58. package/esm/schemas/models/materialized_tenant_hourly_comparison_entries.js +87 -0
  59. package/esm/schemas/models/materialized_tenant_hourly_comparison_reports.js +99 -0
  60. package/esm/schemas/models/materialized_tenant_payments_comparison_entries.js +71 -0
  61. package/esm/schemas/models/materialized_tenant_payments_comparison_reports.js +76 -0
  62. package/esm/schemas/models/materialized_tenant_prep_time_entries.js +130 -0
  63. package/esm/schemas/models/materialized_tenant_prep_time_reports.js +109 -0
  64. package/esm/schemas/models/materialized_tenant_sales_comparison_entries.js +130 -0
  65. package/esm/schemas/models/materialized_tenant_sales_comparison_reports.js +154 -0
  66. package/esm/schemas/models/materialized_tenant_sales_overview_reports.js +1 -1
  67. package/esm/schemas/types/index.js +15 -0
  68. package/esm/schemas/types/materialized_rider_daily_reports.js +1 -0
  69. package/esm/schemas/types/materialized_tenant_cash_entries.js +1 -0
  70. package/esm/schemas/types/materialized_tenant_cash_reports.js +1 -0
  71. package/esm/schemas/types/materialized_tenant_delivery_entries.js +1 -0
  72. package/esm/schemas/types/materialized_tenant_delivery_reports.js +1 -0
  73. package/esm/schemas/types/materialized_tenant_discount_entries.js +1 -0
  74. package/esm/schemas/types/materialized_tenant_discount_reports.js +2 -0
  75. package/esm/schemas/types/materialized_tenant_hourly_comparison_entries.js +1 -0
  76. package/esm/schemas/types/materialized_tenant_hourly_comparison_reports.js +1 -0
  77. package/esm/schemas/types/materialized_tenant_payments_comparison_entries.js +1 -0
  78. package/esm/schemas/types/materialized_tenant_payments_comparison_reports.js +11 -0
  79. package/esm/schemas/types/materialized_tenant_prep_time_entries.js +1 -0
  80. package/esm/schemas/types/materialized_tenant_prep_time_reports.js +1 -0
  81. package/esm/schemas/types/materialized_tenant_sales_comparison_entries.js +1 -0
  82. package/esm/schemas/types/materialized_tenant_sales_comparison_reports.js +14 -0
  83. package/lib/constants/MATERIALIZED_REPORTS.d.ts +345 -2
  84. package/lib/constants/MATERIALIZED_REPORTS.js +457 -1
  85. package/lib/constants/enums/delivery.d.ts +7 -0
  86. package/lib/constants/enums/delivery.js +9 -1
  87. package/lib/helpers/index.d.ts +3 -0
  88. package/lib/helpers/index.js +3 -0
  89. package/lib/helpers/materialized-reports/index.d.ts +32 -0
  90. package/lib/helpers/materialized-reports/index.js +32 -0
  91. package/lib/helpers/materialized-reports/materialized-cash-accumulator-helpers.d.ts +18 -0
  92. package/lib/helpers/materialized-reports/materialized-cash-accumulator-helpers.js +118 -0
  93. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.d.ts +142 -0
  94. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.js +257 -0
  95. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.d.ts +103 -0
  96. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.js +409 -0
  97. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.d.ts +73 -0
  98. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.js +252 -0
  99. package/lib/helpers/materialized-reports/materialized-delivery-accumulator-helpers.d.ts +7 -0
  100. package/lib/helpers/materialized-reports/materialized-delivery-accumulator-helpers.js +173 -0
  101. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.d.ts +113 -0
  102. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.js +442 -0
  103. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.d.ts +98 -0
  104. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +386 -0
  105. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.d.ts +41 -0
  106. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +220 -0
  107. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.d.ts +52 -0
  108. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +325 -0
  109. package/lib/helpers/materialized-reports/materialized-discount-classification-helpers.d.ts +50 -0
  110. package/lib/helpers/materialized-reports/materialized-discount-classification-helpers.js +222 -0
  111. package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.d.ts +182 -0
  112. package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.js +615 -0
  113. package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.d.ts +47 -0
  114. package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.js +193 -0
  115. package/lib/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.d.ts +64 -0
  116. package/lib/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.js +163 -0
  117. package/lib/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.d.ts +61 -0
  118. package/lib/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.js +207 -0
  119. package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.d.ts +23 -0
  120. package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +120 -0
  121. package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.d.ts +25 -0
  122. package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +99 -0
  123. package/lib/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.d.ts +79 -0
  124. package/lib/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.js +407 -0
  125. package/lib/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.d.ts +35 -0
  126. package/lib/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.js +173 -0
  127. package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.d.ts +98 -0
  128. package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +224 -0
  129. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.d.ts +130 -0
  130. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +491 -0
  131. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.d.ts +47 -0
  132. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +208 -0
  133. package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.d.ts +6 -3
  134. package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.js +8 -5
  135. package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.d.ts +8 -0
  136. package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.js +10 -3
  137. package/lib/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.d.ts +48 -0
  138. package/lib/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +204 -0
  139. package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.d.ts +22 -0
  140. package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +160 -0
  141. package/lib/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.d.ts +163 -0
  142. package/lib/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.js +603 -0
  143. package/lib/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.d.ts +68 -0
  144. package/lib/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.js +182 -0
  145. package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.d.ts +98 -0
  146. package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.js +160 -0
  147. package/lib/helpers/materialized-reports/tenant-delivery-formatter.d.ts +133 -0
  148. package/lib/helpers/materialized-reports/tenant-delivery-formatter.js +233 -0
  149. package/lib/helpers/materialized-reports/tenant-discount-formatter.d.ts +114 -0
  150. package/lib/helpers/materialized-reports/tenant-discount-formatter.js +431 -0
  151. package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.d.ts +60 -0
  152. package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +244 -0
  153. package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.d.ts +75 -0
  154. package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.js +289 -0
  155. package/lib/helpers/materialized-reports/tenant-prep-time-formatter.d.ts +98 -0
  156. package/lib/helpers/materialized-reports/tenant-prep-time-formatter.js +232 -0
  157. package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.d.ts +105 -0
  158. package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.js +352 -0
  159. package/lib/helpers/reporting-contract/index.d.ts +2 -0
  160. package/lib/helpers/reporting-contract/index.js +18 -0
  161. package/lib/helpers/reporting-contract/overview-contract.d.ts +55 -0
  162. package/lib/helpers/reporting-contract/overview-contract.js +127 -0
  163. package/lib/helpers/reporting-contract/report-contract.d.ts +159 -0
  164. package/lib/helpers/reporting-contract/report-contract.js +239 -0
  165. package/lib/helpers/rider-earnings/index.d.ts +1 -0
  166. package/lib/helpers/rider-earnings/index.js +17 -0
  167. package/lib/helpers/rider-earnings/rider-earnings.d.ts +51 -0
  168. package/lib/helpers/rider-earnings/rider-earnings.js +57 -0
  169. package/lib/helpers/rider-reports/index.d.ts +2 -0
  170. package/lib/helpers/rider-reports/index.js +18 -0
  171. package/lib/helpers/rider-reports/rider-daily-report.d.ts +28 -0
  172. package/lib/helpers/rider-reports/rider-daily-report.js +93 -0
  173. package/lib/helpers/rider-reports/rider-report.d.ts +49 -0
  174. package/lib/helpers/rider-reports/rider-report.js +70 -0
  175. package/lib/helpers/store/common-order-actions.js +3 -2
  176. package/lib/helpers/types/materialized-reports-apis.d.ts +300 -1
  177. package/lib/schemas/models/deliveries.d.ts +58 -1
  178. package/lib/schemas/models/deliveries.js +81 -0
  179. package/lib/schemas/models/expense_details.d.ts +3 -3
  180. package/lib/schemas/models/index.d.ts +15 -0
  181. package/lib/schemas/models/index.js +15 -0
  182. package/lib/schemas/models/materialized_credit_bills.d.ts +3 -3
  183. package/lib/schemas/models/materialized_credit_bills.js +1 -1
  184. package/lib/schemas/models/materialized_rider_daily_reports.d.ts +27 -0
  185. package/lib/schemas/models/materialized_rider_daily_reports.js +42 -0
  186. package/lib/schemas/models/materialized_tenant_cash_entries.d.ts +181 -0
  187. package/lib/schemas/models/materialized_tenant_cash_entries.js +98 -0
  188. package/lib/schemas/models/materialized_tenant_cash_reports.d.ts +111 -0
  189. package/lib/schemas/models/materialized_tenant_cash_reports.js +80 -0
  190. package/lib/schemas/models/materialized_tenant_delivery_entries.d.ts +98 -0
  191. package/lib/schemas/models/materialized_tenant_delivery_entries.js +66 -0
  192. package/lib/schemas/models/materialized_tenant_delivery_reports.d.ts +98 -0
  193. package/lib/schemas/models/materialized_tenant_delivery_reports.js +66 -0
  194. package/lib/schemas/models/materialized_tenant_discount_entries.d.ts +199 -0
  195. package/lib/schemas/models/materialized_tenant_discount_entries.js +159 -0
  196. package/lib/schemas/models/materialized_tenant_discount_reports.d.ts +216 -0
  197. package/lib/schemas/models/materialized_tenant_discount_reports.js +336 -0
  198. package/lib/schemas/models/materialized_tenant_hourly_comparison_entries.d.ts +95 -0
  199. package/lib/schemas/models/materialized_tenant_hourly_comparison_entries.js +82 -0
  200. package/lib/schemas/models/materialized_tenant_hourly_comparison_reports.d.ts +105 -0
  201. package/lib/schemas/models/materialized_tenant_hourly_comparison_reports.js +91 -0
  202. package/lib/schemas/models/materialized_tenant_payments_comparison_entries.d.ts +91 -0
  203. package/lib/schemas/models/materialized_tenant_payments_comparison_entries.js +70 -0
  204. package/lib/schemas/models/materialized_tenant_payments_comparison_reports.d.ts +98 -0
  205. package/lib/schemas/models/materialized_tenant_payments_comparison_reports.js +71 -0
  206. package/lib/schemas/models/materialized_tenant_prep_time_entries.d.ts +181 -0
  207. package/lib/schemas/models/materialized_tenant_prep_time_entries.js +133 -0
  208. package/lib/schemas/models/materialized_tenant_prep_time_reports.d.ts +118 -0
  209. package/lib/schemas/models/materialized_tenant_prep_time_reports.js +112 -0
  210. package/lib/schemas/models/materialized_tenant_sales_comparison_entries.d.ts +139 -0
  211. package/lib/schemas/models/materialized_tenant_sales_comparison_entries.js +120 -0
  212. package/lib/schemas/models/materialized_tenant_sales_comparison_reports.d.ts +167 -0
  213. package/lib/schemas/models/materialized_tenant_sales_comparison_reports.js +137 -0
  214. package/lib/schemas/models/materialized_tenant_sales_overview_reports.d.ts +3 -3
  215. package/lib/schemas/models/materialized_tenant_sales_overview_reports.js +1 -1
  216. package/lib/schemas/models/tenant_purchase_order_vendor_returns.d.ts +3 -3
  217. package/lib/schemas/models/warehouse_internal_movements.d.ts +6 -6
  218. package/lib/schemas/models/warehouse_purchase_order_receipts.d.ts +3 -3
  219. package/lib/schemas/models/warehouse_purchase_order_vendor_returns.d.ts +3 -3
  220. package/lib/schemas/models/warehouse_sale_deliveries.d.ts +6 -6
  221. package/lib/schemas/models/warehouse_sale_invoices.d.ts +3 -3
  222. package/lib/schemas/types/deliveries.d.ts +40 -1
  223. package/lib/schemas/types/index.d.ts +15 -0
  224. package/lib/schemas/types/index.js +15 -0
  225. package/lib/schemas/types/materialized_rider_daily_reports.d.ts +37 -0
  226. package/lib/schemas/types/materialized_rider_daily_reports.js +2 -0
  227. package/lib/schemas/types/materialized_tenant_cash_entries.d.ts +87 -0
  228. package/lib/schemas/types/materialized_tenant_cash_entries.js +2 -0
  229. package/lib/schemas/types/materialized_tenant_cash_reports.d.ts +144 -0
  230. package/lib/schemas/types/materialized_tenant_cash_reports.js +2 -0
  231. package/lib/schemas/types/materialized_tenant_delivery_entries.d.ts +98 -0
  232. package/lib/schemas/types/materialized_tenant_delivery_entries.js +2 -0
  233. package/lib/schemas/types/materialized_tenant_delivery_reports.d.ts +179 -0
  234. package/lib/schemas/types/materialized_tenant_delivery_reports.js +2 -0
  235. package/lib/schemas/types/materialized_tenant_discount_entries.d.ts +81 -0
  236. package/lib/schemas/types/materialized_tenant_discount_entries.js +2 -0
  237. package/lib/schemas/types/materialized_tenant_discount_reports.d.ts +209 -0
  238. package/lib/schemas/types/materialized_tenant_discount_reports.js +3 -0
  239. package/lib/schemas/types/materialized_tenant_hourly_comparison_entries.d.ts +33 -0
  240. package/lib/schemas/types/materialized_tenant_hourly_comparison_entries.js +2 -0
  241. package/lib/schemas/types/materialized_tenant_hourly_comparison_reports.d.ts +40 -0
  242. package/lib/schemas/types/materialized_tenant_hourly_comparison_reports.js +2 -0
  243. package/lib/schemas/types/materialized_tenant_payments_comparison_entries.d.ts +48 -0
  244. package/lib/schemas/types/materialized_tenant_payments_comparison_entries.js +2 -0
  245. package/lib/schemas/types/materialized_tenant_payments_comparison_reports.d.ts +51 -0
  246. package/lib/schemas/types/materialized_tenant_payments_comparison_reports.js +14 -0
  247. package/lib/schemas/types/materialized_tenant_prep_time_entries.d.ts +88 -0
  248. package/lib/schemas/types/materialized_tenant_prep_time_entries.js +2 -0
  249. package/lib/schemas/types/materialized_tenant_prep_time_reports.d.ts +132 -0
  250. package/lib/schemas/types/materialized_tenant_prep_time_reports.js +2 -0
  251. package/lib/schemas/types/materialized_tenant_sales_comparison_entries.d.ts +43 -0
  252. package/lib/schemas/types/materialized_tenant_sales_comparison_entries.js +2 -0
  253. package/lib/schemas/types/materialized_tenant_sales_comparison_reports.d.ts +74 -0
  254. package/lib/schemas/types/materialized_tenant_sales_comparison_reports.js +17 -0
  255. package/lib/schemas/types/materialized_tenant_sales_overview_reports.d.ts +7 -0
  256. package/lib/tests/deliveries-schema.test.d.ts +1 -0
  257. package/lib/tests/deliveries-schema.test.js +70 -0
  258. package/lib/tests/materialized-reports/analytics-growth-helpers.test.d.ts +1 -0
  259. package/lib/tests/materialized-reports/analytics-overview-helpers.test.d.ts +1 -0
  260. package/lib/tests/materialized-reports/analytics-performance-helpers.test.d.ts +1 -0
  261. package/lib/tests/materialized-reports/fixtures.d.ts +15 -1
  262. package/lib/tests/materialized-reports/fixtures.js +1 -0
  263. package/lib/tests/materialized-reports/materialized-cash-compile.test.d.ts +1 -0
  264. package/lib/tests/materialized-reports/materialized-cash-compile.test.js +197 -0
  265. package/lib/tests/materialized-reports/materialized-cash-fold.test.d.ts +1 -0
  266. package/lib/tests/materialized-reports/materialized-cash-fold.test.js +116 -0
  267. package/lib/tests/materialized-reports/materialized-cash-formatter.test.d.ts +1 -0
  268. package/lib/tests/materialized-reports/materialized-cash-formatter.test.js +153 -0
  269. package/lib/tests/materialized-reports/materialized-cash-plan.test.d.ts +1 -0
  270. package/lib/tests/materialized-reports/materialized-cash-plan.test.js +168 -0
  271. package/lib/tests/materialized-reports/materialized-cash-reconciliation.test.d.ts +1 -0
  272. package/lib/tests/materialized-reports/materialized-cash-reconciliation.test.js +267 -0
  273. package/lib/tests/materialized-reports/materialized-delivery-accumulation.test.d.ts +1 -0
  274. package/lib/tests/materialized-reports/materialized-delivery-accumulation.test.js +147 -0
  275. package/lib/tests/materialized-reports/materialized-delivery-compile.test.d.ts +1 -0
  276. package/lib/tests/materialized-reports/materialized-delivery-compile.test.js +242 -0
  277. package/lib/tests/materialized-reports/materialized-delivery-fold.test.d.ts +1 -0
  278. package/lib/tests/materialized-reports/materialized-delivery-fold.test.js +109 -0
  279. package/lib/tests/materialized-reports/materialized-delivery-formatter.test.d.ts +1 -0
  280. package/lib/tests/materialized-reports/materialized-delivery-formatter.test.js +142 -0
  281. package/lib/tests/materialized-reports/materialized-delivery-plan.test.d.ts +1 -0
  282. package/lib/tests/materialized-reports/materialized-delivery-plan.test.js +198 -0
  283. package/lib/tests/materialized-reports/materialized-discount-aggregated-formatter.test.d.ts +1 -0
  284. package/lib/tests/materialized-reports/materialized-discount-aggregated-formatter.test.js +173 -0
  285. package/lib/tests/materialized-reports/materialized-discount-classification.test.d.ts +1 -0
  286. package/lib/tests/materialized-reports/materialized-discount-classification.test.js +339 -0
  287. package/lib/tests/materialized-reports/materialized-discount-close-day.test.d.ts +1 -0
  288. package/lib/tests/materialized-reports/materialized-discount-close-day.test.js +506 -0
  289. package/lib/tests/materialized-reports/materialized-discount-compile.test.d.ts +1 -0
  290. package/lib/tests/materialized-reports/materialized-discount-compile.test.js +161 -0
  291. package/lib/tests/materialized-reports/materialized-discount-counter-rows.test.d.ts +1 -0
  292. package/lib/tests/materialized-reports/materialized-discount-counter-rows.test.js +107 -0
  293. package/lib/tests/materialized-reports/materialized-discount-entries-accumulation.test.d.ts +1 -0
  294. package/lib/tests/materialized-reports/materialized-discount-entries-accumulation.test.js +125 -0
  295. package/lib/tests/materialized-reports/materialized-hourly-comparison-compile.test.d.ts +1 -0
  296. package/lib/tests/materialized-reports/materialized-hourly-comparison-compile.test.js +146 -0
  297. package/lib/tests/materialized-reports/materialized-hourly-comparison-formatter.test.d.ts +1 -0
  298. package/lib/tests/materialized-reports/materialized-hourly-comparison-formatter.test.js +127 -0
  299. package/lib/tests/materialized-reports/materialized-hourly-comparison-plan.test.d.ts +1 -0
  300. package/lib/tests/materialized-reports/materialized-hourly-comparison-plan.test.js +138 -0
  301. package/lib/tests/materialized-reports/materialized-hourly-comparison-selection.test.d.ts +1 -0
  302. package/lib/tests/materialized-reports/materialized-hourly-comparison-selection.test.js +90 -0
  303. package/lib/tests/materialized-reports/materialized-payments-comparison-compile.test.d.ts +1 -0
  304. package/lib/tests/materialized-reports/materialized-payments-comparison-compile.test.js +164 -0
  305. package/lib/tests/materialized-reports/materialized-payments-comparison-formatter.test.d.ts +1 -0
  306. package/lib/tests/materialized-reports/materialized-payments-comparison-formatter.test.js +117 -0
  307. package/lib/tests/materialized-reports/materialized-payments-comparison-plan.test.d.ts +1 -0
  308. package/lib/tests/materialized-reports/materialized-payments-comparison-plan.test.js +149 -0
  309. package/lib/tests/materialized-reports/materialized-prep-time-classification.test.d.ts +1 -0
  310. package/lib/tests/materialized-reports/materialized-prep-time-classification.test.js +273 -0
  311. package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.d.ts +1 -0
  312. package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.js +271 -0
  313. package/lib/tests/materialized-reports/materialized-prep-time-compile.test.d.ts +1 -0
  314. package/lib/tests/materialized-reports/materialized-prep-time-compile.test.js +217 -0
  315. package/lib/tests/materialized-reports/materialized-prep-time-constants.test.d.ts +1 -0
  316. package/lib/tests/materialized-reports/materialized-prep-time-constants.test.js +84 -0
  317. package/lib/tests/materialized-reports/materialized-prep-time-plan.test.d.ts +1 -0
  318. package/lib/tests/materialized-reports/materialized-prep-time-plan.test.js +176 -0
  319. package/lib/tests/materialized-reports/materialized-reports-scope-group-helpers.test.js +13 -13
  320. package/lib/tests/materialized-reports/materialized-sales-comparison-baseline.test.d.ts +1 -0
  321. package/lib/tests/materialized-reports/materialized-sales-comparison-baseline.test.js +126 -0
  322. package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.d.ts +1 -0
  323. package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.js +207 -0
  324. package/lib/tests/materialized-reports/materialized-sales-comparison-formatter.test.d.ts +1 -0
  325. package/lib/tests/materialized-reports/materialized-sales-comparison-formatter.test.js +179 -0
  326. package/lib/tests/materialized-reports/materialized-sales-comparison-parity.test.d.ts +1 -0
  327. package/lib/tests/materialized-reports/materialized-sales-comparison-parity.test.js +196 -0
  328. package/lib/tests/materialized-reports/materialized-sales-comparison-plan.test.d.ts +1 -0
  329. package/lib/tests/materialized-reports/materialized-sales-comparison-plan.test.js +241 -0
  330. package/lib/tests/materialized-reports/materialized-tenant-hourly-comparison-schema.test.d.ts +1 -0
  331. package/lib/tests/materialized-reports/materialized-tenant-hourly-comparison-schema.test.js +96 -0
  332. package/lib/tests/materialized-reports/materialized-tenant-payments-comparison-schema.test.d.ts +1 -0
  333. package/lib/tests/materialized-reports/materialized-tenant-payments-comparison-schema.test.js +112 -0
  334. package/lib/tests/materialized-reports/materialized-tenant-sales-comparison-schema.test.d.ts +1 -0
  335. package/lib/tests/materialized-reports/materialized-tenant-sales-comparison-schema.test.js +142 -0
  336. package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.js +8 -1
  337. package/lib/tests/materialized-reports/sales-comparison-reference.d.ts +55 -0
  338. package/lib/tests/materialized-reports/sales-comparison-reference.js +86 -0
  339. package/lib/tests/materialized-reports/tenant-discount-formatter.test.d.ts +1 -0
  340. package/lib/tests/materialized-reports/tenant-discount-formatter.test.js +289 -0
  341. package/lib/tests/materialized-reports/tenant-prep-time-formatter.test.d.ts +1 -0
  342. package/lib/tests/materialized-reports/tenant-prep-time-formatter.test.js +354 -0
  343. package/lib/tests/reporting-contract.test.d.ts +1 -0
  344. package/lib/tests/reporting-contract.test.js +267 -0
  345. package/lib/tests/rider-daily-report.test.d.ts +1 -0
  346. package/lib/tests/rider-daily-report.test.js +86 -0
  347. package/lib/tests/rider-earnings.test.d.ts +1 -0
  348. package/lib/tests/rider-earnings.test.js +65 -0
  349. package/lib/tests/rider-report.test.d.ts +1 -0
  350. package/lib/tests/rider-report.test.js +98 -0
  351. package/package.json +10 -1
@@ -0,0 +1,346 @@
1
+ import { MATERIALIZED_REPORT_KEY_FILTER_ENUM, SALES_COMPARISON_METRIC_ENUM, } from '../../constants/MATERIALIZED_REPORTS';
2
+ import { ORDER_STATUS_ENUM } from '../../constants/ENUMS';
3
+ import { parseMaterializedReportKey } from './key-helpers';
4
+ import { convertPriceFromCents } from '../utils/price-conversion';
5
+ const matchedDocumentsOf = (doc) => 'matched_documents' in doc ? doc.matched_documents : 1;
6
+ const updatedAtOf = (doc) => 'max_updated_at' in doc ? doc.max_updated_at : doc.updatedAt;
7
+ const ALL_METRICS = [
8
+ SALES_COMPARISON_METRIC_ENUM.NET_SALES,
9
+ SALES_COMPARISON_METRIC_ENUM.GROSS_SALES,
10
+ SALES_COMPARISON_METRIC_ENUM.DISCOUNTS,
11
+ SALES_COMPARISON_METRIC_ENUM.ORDER_COUNT,
12
+ SALES_COMPARISON_METRIC_ENUM.AVERAGE_TICKET,
13
+ SALES_COMPARISON_METRIC_ENUM.ITEMS_SOLD,
14
+ ];
15
+ const toDecimal = (cents) => convertPriceFromCents(cents ?? 0);
16
+ /** A zeroed formatted series. */
17
+ const emptySeries = () => ({
18
+ counters: {
19
+ order_count: 0,
20
+ gross_amount: 0,
21
+ discount_amount: 0,
22
+ net_amount: 0,
23
+ tax_amount: 0,
24
+ service_charge_amount: 0,
25
+ tip_amount: 0,
26
+ refund_amount: 0,
27
+ void_amount: 0,
28
+ item_count: 0,
29
+ guest_count: 0,
30
+ },
31
+ average_ticket: null,
32
+ });
33
+ /** Converts one raw counter block to the page's decimal shape. */
34
+ const formatCounters = (counters) => ({
35
+ order_count: counters?.order_count ?? 0,
36
+ gross_amount: toDecimal(counters?.gross_amount),
37
+ discount_amount: toDecimal(counters?.discount_amount),
38
+ net_amount: toDecimal(counters?.net_amount),
39
+ tax_amount: toDecimal(counters?.tax_amount),
40
+ service_charge_amount: toDecimal(counters?.service_charge_amount),
41
+ tip_amount: toDecimal(counters?.tip_amount),
42
+ refund_amount: toDecimal(counters?.refund_amount),
43
+ void_amount: toDecimal(counters?.void_amount),
44
+ item_count: counters?.item_count ?? 0,
45
+ guest_count: counters?.guest_count ?? 0,
46
+ });
47
+ export const formatSalesComparisonSeries = (counters) => {
48
+ const formatted = formatCounters(counters);
49
+ return {
50
+ counters: formatted,
51
+ average_ticket: formatted.order_count > 0 ? formatted.net_amount / formatted.order_count : null,
52
+ };
53
+ };
54
+ /** Adds raw counters (cents) into an accumulator. */
55
+ const addRaw = (target, source) => {
56
+ if (source == null)
57
+ return;
58
+ target.order_count += source.order_count ?? 0;
59
+ target.gross_amount += source.gross_amount ?? 0;
60
+ target.discount_amount += source.discount_amount ?? 0;
61
+ target.net_amount += source.net_amount ?? 0;
62
+ target.tax_amount += source.tax_amount ?? 0;
63
+ target.service_charge_amount += source.service_charge_amount ?? 0;
64
+ target.tip_amount += source.tip_amount ?? 0;
65
+ target.refund_amount += source.refund_amount ?? 0;
66
+ target.void_amount += source.void_amount ?? 0;
67
+ target.item_count += source.item_count ?? 0;
68
+ target.guest_count += source.guest_count ?? 0;
69
+ };
70
+ const createRawCounters = () => ({
71
+ order_count: 0,
72
+ gross_amount: 0,
73
+ discount_amount: 0,
74
+ net_amount: 0,
75
+ tax_amount: 0,
76
+ service_charge_amount: 0,
77
+ tip_amount: 0,
78
+ refund_amount: 0,
79
+ void_amount: 0,
80
+ item_count: 0,
81
+ guest_count: 0,
82
+ });
83
+ /** The six selectable metrics, read off a formatted series. */
84
+ const seriesMetric = (series, metric) => {
85
+ switch (metric) {
86
+ case SALES_COMPARISON_METRIC_ENUM.NET_SALES:
87
+ return series.counters.net_amount;
88
+ case SALES_COMPARISON_METRIC_ENUM.GROSS_SALES:
89
+ return series.counters.gross_amount;
90
+ case SALES_COMPARISON_METRIC_ENUM.DISCOUNTS:
91
+ return series.counters.discount_amount;
92
+ case SALES_COMPARISON_METRIC_ENUM.ORDER_COUNT:
93
+ return series.counters.order_count;
94
+ case SALES_COMPARISON_METRIC_ENUM.AVERAGE_TICKET:
95
+ return series.average_ticket;
96
+ case SALES_COMPARISON_METRIC_ENUM.ITEMS_SOLD:
97
+ return series.counters.item_count;
98
+ default:
99
+ return null;
100
+ }
101
+ };
102
+ /** Percent change with a zero-safe denominator; `null` when undefined. */
103
+ const percentDelta = (current, comparison) => {
104
+ if (current == null || comparison == null)
105
+ return null;
106
+ if (comparison === 0)
107
+ return current === 0 ? 0 : null;
108
+ return ((current - comparison) / Math.abs(comparison)) * 100;
109
+ };
110
+ export function buildSalesComparisonMetrics(current, comparison) {
111
+ const metrics = {};
112
+ for (const metric of ALL_METRICS) {
113
+ const currentValue = seriesMetric(current, metric);
114
+ const comparisonValue = comparison == null ? null : seriesMetric(comparison, metric);
115
+ metrics[metric] = {
116
+ current: currentValue,
117
+ comparison: comparisonValue,
118
+ delta: currentValue == null || comparisonValue == null ? null : currentValue - comparisonValue,
119
+ delta_percent: percentDelta(currentValue, comparisonValue),
120
+ };
121
+ }
122
+ return metrics;
123
+ }
124
+ /** Parsed key components, mapped by the document's OWN key-filter order. */
125
+ const parseKey = (key, keyFilters) => {
126
+ const components = parseMaterializedReportKey(key);
127
+ if (components == null || components.length !== keyFilters.length)
128
+ return null;
129
+ let orderStatus = null;
130
+ let platform = null;
131
+ for (let index = 0; index < keyFilters.length; index += 1) {
132
+ if (keyFilters[index] === MATERIALIZED_REPORT_KEY_FILTER_ENUM.ORDER_STATUS) {
133
+ orderStatus = components[index];
134
+ }
135
+ else if (keyFilters[index] === MATERIALIZED_REPORT_KEY_FILTER_ENUM.PLATFORM) {
136
+ platform = components[index];
137
+ }
138
+ }
139
+ return { order_status: orderStatus, platform };
140
+ };
141
+ const isCancelled = (orderStatus) => orderStatus === ORDER_STATUS_ENUM.CANCELLED;
142
+ /** True when a filter list explicitly asks for `CANCELLED`. */
143
+ const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes(ORDER_STATUS_ENUM.CANCELLED);
144
+ const foldDocs = (docs, filters, target) => {
145
+ for (const doc of docs ?? []) {
146
+ if (doc == null || doc.sales_counters == null)
147
+ continue;
148
+ const keyFilters = doc.sale_type_key_filters ?? [];
149
+ for (const [key, counters] of Object.entries(doc.sales_counters)) {
150
+ const parsed = parseKey(key, keyFilters);
151
+ if (parsed == null)
152
+ continue;
153
+ if (filters.platforms != null &&
154
+ filters.platforms.length > 0 &&
155
+ (parsed.platform == null || !filters.platforms.includes(parsed.platform))) {
156
+ continue;
157
+ }
158
+ if (filters.order_statuses != null &&
159
+ filters.order_statuses.length > 0 &&
160
+ (parsed.order_status == null || !filters.order_statuses.includes(parsed.order_status))) {
161
+ continue;
162
+ }
163
+ const existing = target.get(key) ?? createRawCounters();
164
+ addRaw(existing, counters);
165
+ target.set(key, existing);
166
+ }
167
+ }
168
+ };
169
+ const buildGroup = (tenantIds, currentDocs, comparisonDocs, filters) => {
170
+ const currentByKey = new Map();
171
+ const comparisonByKey = new Map();
172
+ foldDocs(currentDocs, filters, currentByKey);
173
+ // An ARRAY means a baseline was requested (an empty one is a real zero, not
174
+ // "no baseline"). `null` is reserved for `baseline: NONE`.
175
+ const hasComparisonDocuments = comparisonDocs != null;
176
+ if (comparisonDocs != null) {
177
+ foldDocs(comparisonDocs, filters, comparisonByKey);
178
+ }
179
+ const group = {
180
+ keyFilters: currentDocs[0]?.sale_type_key_filters ?? [],
181
+ currentByKey,
182
+ comparisonByKey,
183
+ currentTotal: createRawCounters(),
184
+ comparisonTotal: createRawCounters(),
185
+ currentCancelled: createRawCounters(),
186
+ comparisonCancelled: createRawCounters(),
187
+ hasComparisonDocuments,
188
+ includeCancelledInTotals: includesCancelled(filters),
189
+ matchedDocuments: currentDocs.reduce((sum, doc) => sum + matchedDocumentsOf(doc), 0),
190
+ tenantIds: new Set(tenantIds),
191
+ };
192
+ const includeCancelledInTotals = group.includeCancelledInTotals;
193
+ for (const [key, counters] of currentByKey) {
194
+ const parsed = parseKey(key, group.keyFilters);
195
+ if (parsed != null && isCancelled(parsed.order_status) && !includeCancelledInTotals) {
196
+ addRaw(group.currentCancelled, counters);
197
+ continue;
198
+ }
199
+ addRaw(group.currentTotal, counters);
200
+ }
201
+ for (const [key, counters] of comparisonByKey) {
202
+ const parsed = parseKey(key, group.keyFilters);
203
+ if (parsed != null && isCancelled(parsed.order_status) && !includeCancelledInTotals) {
204
+ addRaw(group.comparisonCancelled, counters);
205
+ continue;
206
+ }
207
+ addRaw(group.comparisonTotal, counters);
208
+ }
209
+ return group;
210
+ };
211
+ /** Builds one page from one raw group. */
212
+ const buildPage = (group, filters) => {
213
+ const current = formatSalesComparisonSeries(group.currentTotal);
214
+ const comparison = group.hasComparisonDocuments ? formatSalesComparisonSeries(group.comparisonTotal) : null;
215
+ const keys = new Set([...group.currentByKey.keys(), ...group.comparisonByKey.keys()]);
216
+ const rows = [];
217
+ for (const key of keys) {
218
+ const parsed = parseKey(key, group.keyFilters);
219
+ if (parsed == null)
220
+ continue;
221
+ const rowCurrent = formatSalesComparisonSeries(group.currentByKey.get(key));
222
+ const rowComparison = group.hasComparisonDocuments
223
+ ? formatSalesComparisonSeries(group.comparisonByKey.get(key))
224
+ : null;
225
+ rows.push({
226
+ key,
227
+ order_status: parsed.order_status,
228
+ platform: parsed.platform,
229
+ current: rowCurrent,
230
+ comparison: rowComparison,
231
+ metrics: buildSalesComparisonMetrics(rowCurrent, rowComparison),
232
+ });
233
+ }
234
+ // Biggest current sellers first; deterministic tie-break on the key.
235
+ rows.sort((a, b) => b.current.counters.net_amount - a.current.counters.net_amount || a.key.localeCompare(b.key));
236
+ const platformRows = new Map();
237
+ for (const row of rows) {
238
+ if (row.platform == null)
239
+ continue;
240
+ // The platform breakdown must reconcile with the page's total: cancelled
241
+ // revenue is excluded there unless the filter explicitly asked for it.
242
+ if (row.order_status === ORDER_STATUS_ENUM.CANCELLED && !group.includeCancelledInTotals)
243
+ continue;
244
+ const existing = platformRows.get(row.platform) ?? {
245
+ platform: row.platform,
246
+ current: emptySeries(),
247
+ comparison: group.hasComparisonDocuments ? emptySeries() : null,
248
+ metrics: {},
249
+ };
250
+ // Sum the DECIMAL counters of the already-formatted rows. Money rounding is
251
+ // per row before this fold, so a brand-level total can differ from a direct
252
+ // sum of cents by at most a cent per row; the report's exact figures are the
253
+ // page's `current` series, computed from raw cents above.
254
+ existing.current = sumSeries(existing.current, row.current);
255
+ if (existing.comparison != null && row.comparison != null) {
256
+ existing.comparison = sumSeries(existing.comparison, row.comparison);
257
+ }
258
+ platformRows.set(row.platform, existing);
259
+ }
260
+ for (const platformRow of platformRows.values()) {
261
+ platformRow.metrics = buildSalesComparisonMetrics(platformRow.current, platformRow.comparison);
262
+ }
263
+ const byPlatform = [...platformRows.values()].sort((a, b) => b.current.counters.net_amount - a.current.counters.net_amount || a.platform.localeCompare(b.platform));
264
+ return {
265
+ tenant_ids: [...group.tenantIds].sort(),
266
+ filters: {
267
+ platforms: filters.platforms != null && filters.platforms.length > 0 ? [...filters.platforms] : null,
268
+ order_statuses: filters.order_statuses != null && filters.order_statuses.length > 0 ? [...filters.order_statuses] : null,
269
+ },
270
+ current,
271
+ comparison,
272
+ metrics: buildSalesComparisonMetrics(current, comparison),
273
+ cancelled: formatSalesComparisonSeries(group.currentCancelled),
274
+ rows,
275
+ by_platform: byPlatform,
276
+ matched_documents: group.matchedDocuments,
277
+ };
278
+ };
279
+ /** Sums two page-ready series (used only for the platform breakdown). */
280
+ const sumSeries = (a, b) => {
281
+ const counters = {
282
+ order_count: a.counters.order_count + b.counters.order_count,
283
+ gross_amount: a.counters.gross_amount + b.counters.gross_amount,
284
+ discount_amount: a.counters.discount_amount + b.counters.discount_amount,
285
+ net_amount: a.counters.net_amount + b.counters.net_amount,
286
+ tax_amount: a.counters.tax_amount + b.counters.tax_amount,
287
+ service_charge_amount: a.counters.service_charge_amount + b.counters.service_charge_amount,
288
+ tip_amount: a.counters.tip_amount + b.counters.tip_amount,
289
+ refund_amount: a.counters.refund_amount + b.counters.refund_amount,
290
+ void_amount: a.counters.void_amount + b.counters.void_amount,
291
+ item_count: a.counters.item_count + b.counters.item_count,
292
+ guest_count: a.counters.guest_count + b.counters.guest_count,
293
+ };
294
+ return {
295
+ counters,
296
+ average_ticket: counters.order_count > 0 ? counters.net_amount / counters.order_count : null,
297
+ };
298
+ };
299
+ /**
300
+ * Page-ready Sales Comparison data.
301
+ *
302
+ * `currentDocs` are the current series' aggregated records; `comparisonDocs`
303
+ * are the baseline series' records (`null` for `baseline: NONE`, `[]` for a
304
+ * valid baseline with no sales). Changing filters or the selected metric
305
+ * re-derives from the SAME docs — no refetch.
306
+ */
307
+ export function getFormattedTenantSalesComparisonReporting(currentDocs, comparisonDocs, filters = null, separate_view_per_tenant = false) {
308
+ if (!Array.isArray(currentDocs) || currentDocs.length === 0)
309
+ return null;
310
+ if (currentDocs.some((doc) => doc == null))
311
+ return null;
312
+ if (comparisonDocs != null && !Array.isArray(comparisonDocs))
313
+ return null;
314
+ if (filters != null) {
315
+ if (filters.platforms != null && !Array.isArray(filters.platforms))
316
+ return null;
317
+ if (filters.order_statuses != null && !Array.isArray(filters.order_statuses))
318
+ return null;
319
+ }
320
+ const resolvedFilters = filters ?? {};
321
+ // The key grammar must be identical across every document of a read (the
322
+ // backend pins one schema, and a mixed grammar would map components wrongly).
323
+ const signature = (currentDocs[0].sale_type_key_filters ?? []).join(':');
324
+ for (const doc of [...currentDocs, ...(comparisonDocs ?? [])]) {
325
+ if ((doc.sale_type_key_filters ?? []).join(':') !== signature)
326
+ return null;
327
+ }
328
+ const usableCurrent = currentDocs.filter((doc) => doc.sales_counters != null);
329
+ if (usableCurrent.length === 0)
330
+ return null;
331
+ const groupDocs = (docs, tenantId) => (docs ?? []).filter((doc) => doc != null && (tenantId == null || String(doc.tenant_id) === tenantId));
332
+ const pages = [];
333
+ const allTenantIds = [...new Set(usableCurrent.map((doc) => String(doc.tenant_id)))].sort();
334
+ const scopes = separate_view_per_tenant ? allTenantIds.map((tenantId) => [tenantId]) : [allTenantIds];
335
+ for (const scope of scopes) {
336
+ const currentForScope = usableCurrent.filter((doc) => scope.includes(String(doc.tenant_id)));
337
+ if (currentForScope.length === 0)
338
+ continue;
339
+ const comparisonForScope = comparisonDocs == null ? null : groupDocs(comparisonDocs).filter((doc) => scope.includes(String(doc.tenant_id)));
340
+ const group = buildGroup(scope, currentForScope, comparisonForScope, resolvedFilters);
341
+ pages.push(buildPage(group, resolvedFilters));
342
+ }
343
+ if (pages.length === 0)
344
+ return null;
345
+ return [pages, null];
346
+ }
@@ -0,0 +1,2 @@
1
+ export * from './report-contract';
2
+ export * from './overview-contract';
@@ -0,0 +1,123 @@
1
+ import { ORDER_STATUS_ENUM } from '../../constants/ENUMS';
2
+ import { parseMaterializedReportKey } from '../materialized-reports/key-helpers';
3
+ const emptySummary = () => ({
4
+ order_count: 0,
5
+ cancelled_order_count: 0,
6
+ gross_amount: 0,
7
+ discount_amount: 0,
8
+ net_amount: 0,
9
+ tax_amount: 0,
10
+ tip_amount: 0,
11
+ });
12
+ const emptyPayment = (paymentType) => ({
13
+ payment_type: paymentType,
14
+ count: 0,
15
+ gross_amount: 0,
16
+ amount_due: 0,
17
+ amount_paid: 0,
18
+ amount_refunded: 0,
19
+ card_charges: 0,
20
+ });
21
+ export function normalizeOverviewAggregatedRecord(record) {
22
+ if (record == null)
23
+ return null;
24
+ const summary = emptySummary();
25
+ const payments = new Map();
26
+ const platforms = new Map();
27
+ for (const [key, metric] of Object.entries(record.sale_type_metrics ?? {})) {
28
+ const components = parseMaterializedReportKey(key);
29
+ if (components == null || components.length < 2)
30
+ continue;
31
+ const [status, platform] = components;
32
+ const orderMetric = metric?.TOTAL_SALES?.orders;
33
+ if (status === ORDER_STATUS_ENUM.CANCELLED) {
34
+ summary.cancelled_order_count += Number(orderMetric?.count ?? 0);
35
+ continue;
36
+ }
37
+ summary.order_count += Number(orderMetric?.count ?? 0);
38
+ summary.gross_amount += Number(orderMetric?.gross_amount ?? 0);
39
+ summary.discount_amount += Number(orderMetric?.discount_amount ?? 0);
40
+ summary.tax_amount += Number(orderMetric?.tax_amount ?? 0);
41
+ summary.tip_amount += Number(orderMetric?.tip_amount ?? 0);
42
+ const platformRow = platforms.get(platform) ?? {
43
+ platform,
44
+ order_count: 0,
45
+ gross_amount: 0,
46
+ discount_amount: 0,
47
+ net_amount: 0,
48
+ };
49
+ platformRow.order_count += Number(orderMetric?.count ?? 0);
50
+ platformRow.gross_amount += Number(orderMetric?.gross_amount ?? 0);
51
+ platformRow.discount_amount += Number(orderMetric?.discount_amount ?? 0);
52
+ platformRow.net_amount = platformRow.gross_amount - platformRow.discount_amount;
53
+ platforms.set(platform, platformRow);
54
+ for (const payment of metric?.TOTAL_SALES?.payments ?? []) {
55
+ const type = payment.payment_type ?? '';
56
+ const target = payments.get(type) ?? emptyPayment(type);
57
+ target.count += Number(payment.count ?? 0);
58
+ target.gross_amount += Number(payment.gross_amount ?? 0);
59
+ target.amount_due += Number(payment.amount_due ?? 0);
60
+ target.amount_paid += Number(payment.amount_paid ?? 0);
61
+ target.amount_refunded += Number(payment.amount_refunded ?? 0);
62
+ target.card_charges += Number(payment.card_charges ?? 0);
63
+ payments.set(type, target);
64
+ }
65
+ }
66
+ summary.net_amount = summary.gross_amount - summary.discount_amount;
67
+ return {
68
+ tenant_id: record.tenant_id,
69
+ brand_id: record.brand_id,
70
+ summary,
71
+ payments: [...payments.values()].sort((a, b) => b.count - a.count || a.payment_type.localeCompare(b.payment_type)),
72
+ platforms: [...platforms.values()].sort((a, b) => b.gross_amount - a.gross_amount || a.platform.localeCompare(b.platform)),
73
+ };
74
+ }
75
+ /**
76
+ * Compatibility normalizer for the EXISTING Overview page/formatter: returns
77
+ * the historical aggregated-record shape with every credit slot present and
78
+ * AMOUNT_COLLECTED.payments normalized to an empty array. Both the live and
79
+ * historical Overview routes use this, so the old formatter can render either
80
+ * mode from the new envelope without a second code path.
81
+ */
82
+ export function normalizeOverviewAggregatedShape(record) {
83
+ const metrics = {};
84
+ for (const [key, metric] of Object.entries(record.sale_type_metrics ?? {})) {
85
+ const total = metric.TOTAL_SALES;
86
+ const collected = metric.AMOUNT_COLLECTED;
87
+ const credit = metric.CREDIT_BILLS;
88
+ const issued = credit.issued ?? {};
89
+ const received = credit.received ?? {};
90
+ metrics[key] = {
91
+ TOTAL_SALES: {
92
+ orders: total.orders,
93
+ payments: total.payments ?? [],
94
+ },
95
+ AMOUNT_COLLECTED: {
96
+ orders: collected.orders,
97
+ payments: [],
98
+ },
99
+ CREDIT_BILLS: {
100
+ issued: {
101
+ count: Number(issued.count ?? 0),
102
+ amount: Number(issued.amount ?? 0),
103
+ settled_count: Number(issued.settled_count ?? 0),
104
+ settled_amount: Number(issued.settled_amount ?? 0),
105
+ outstanding_count: Number(issued.outstanding_count ?? 0),
106
+ outstanding_amount: Number(issued.outstanding_amount ?? 0),
107
+ outstanding_now_count: Number(issued.outstanding_now_count ?? 0),
108
+ outstanding_now_amount: Number(issued.outstanding_now_amount ?? 0),
109
+ collected_at_issue_count: Number(issued.collected_at_issue_count ?? 0),
110
+ collected_at_issue_amount: Number(issued.collected_at_issue_amount ?? 0),
111
+ },
112
+ received: {
113
+ count: Number(received.count ?? 0),
114
+ amount: Number(received.amount ?? 0),
115
+ },
116
+ },
117
+ };
118
+ }
119
+ return {
120
+ ...record,
121
+ sale_type_metrics: metrics,
122
+ };
123
+ }