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