@managesome/eposmatic-toolkit 0.4.9 → 0.4.10

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