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