@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,244 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getHourlyComparisonBusinessIndex = exports.getHourlyComparisonHourLabel = void 0;
4
+ exports.getFormattedTenantHourlyComparisonReporting = getFormattedTenantHourlyComparisonReporting;
5
+ const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
6
+ const ENUMS_1 = require("../../constants/ENUMS");
7
+ const tenant_sales_comparison_formatter_1 = require("./tenant-sales-comparison-formatter");
8
+ const materialized_sales_comparison_accumulator_helpers_1 = require("./materialized-sales-comparison-accumulator-helpers");
9
+ const key_helpers_1 = require("./key-helpers");
10
+ /** `'YYYY-MM-DD HH'` → hour, or null. */
11
+ const hourOfScopeField = (scopeField) => {
12
+ if (typeof scopeField !== 'string')
13
+ return null;
14
+ const match = /^\d{4}-\d{2}-\d{2} ([01]\d|2[0-3])$/.exec(scopeField);
15
+ return match == null ? null : Number(match[1]);
16
+ };
17
+ /**
18
+ * Accepts BOTH read shapes: an aggregated profile record (`hour_counters`) and
19
+ * a STORED hour document (`sales_counters` + `scope_field`) — the same dual
20
+ * input every document-shaped materialized formatter accepts, so a stored
21
+ * document and a read record go down one code path.
22
+ */
23
+ const normalizeHourlyDocument = (doc) => {
24
+ if (doc == null)
25
+ return null;
26
+ const keyFilters = (doc.sale_type_key_filters ?? []);
27
+ if ('hour_counters' in doc && doc.hour_counters != null) {
28
+ return {
29
+ tenant_id: String(doc.tenant_id),
30
+ brand_id: String(doc.brand_id ?? ''),
31
+ sale_type_key_filters: keyFilters,
32
+ hour_counters: doc.hour_counters,
33
+ matched_documents: Number(doc.matched_documents ?? 1) || 1,
34
+ max_updated_at: doc.max_updated_at == null ? null : new Date(doc.max_updated_at),
35
+ };
36
+ }
37
+ const stored = doc;
38
+ if (stored.sales_counters == null)
39
+ return null;
40
+ const hour = hourOfScopeField(stored.scope_field);
41
+ if (hour == null)
42
+ return null;
43
+ return {
44
+ tenant_id: String(stored.tenant_id),
45
+ brand_id: String(stored.brand_id ?? ''),
46
+ sale_type_key_filters: keyFilters,
47
+ hour_counters: { [String(hour)]: stored.sales_counters },
48
+ matched_documents: 1,
49
+ max_updated_at: stored.updatedAt == null ? null : new Date(stored.updatedAt),
50
+ };
51
+ };
52
+ /** `'HH:00–HH+1:00'` (end wraps at midnight). */
53
+ const getHourlyComparisonHourLabel = (hour) => {
54
+ const pad = (value) => String(value).padStart(2, '0');
55
+ return `${pad(hour)}:00–${pad((hour + 1) % 24)}:00`;
56
+ };
57
+ exports.getHourlyComparisonHourLabel = getHourlyComparisonHourLabel;
58
+ /** Business-hour index: 06 → 0, …, 23 → 17, 00 → 18, …, 05 → 23. */
59
+ const getHourlyComparisonBusinessIndex = (hour) => (hour + 18) % 24;
60
+ exports.getHourlyComparisonBusinessIndex = getHourlyComparisonBusinessIndex;
61
+ const isCancelled = (status) => status === ENUMS_1.ORDER_STATUS_ENUM.CANCELLED;
62
+ const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes(ENUMS_1.ORDER_STATUS_ENUM.CANCELLED);
63
+ const parseKey = (key, keyFilters) => {
64
+ const components = (0, key_helpers_1.parseMaterializedReportKey)(key);
65
+ if (components == null || components.length !== keyFilters.length)
66
+ return null;
67
+ let orderStatus = null;
68
+ let platform = null;
69
+ for (let index = 0; index < keyFilters.length; index += 1) {
70
+ if (keyFilters[index] === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_KEY_FILTER_ENUM.ORDER_STATUS) {
71
+ orderStatus = components[index];
72
+ }
73
+ else if (keyFilters[index] === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_KEY_FILTER_ENUM.PLATFORM) {
74
+ platform = components[index];
75
+ }
76
+ }
77
+ return { order_status: orderStatus, platform };
78
+ };
79
+ const keyMatchesFilters = (parsed, filters) => {
80
+ if (filters.platforms != null &&
81
+ filters.platforms.length > 0 &&
82
+ (parsed.platform == null || !filters.platforms.includes(parsed.platform))) {
83
+ return false;
84
+ }
85
+ if (filters.order_statuses != null &&
86
+ filters.order_statuses.length > 0 &&
87
+ (parsed.order_status == null || !filters.order_statuses.includes(parsed.order_status))) {
88
+ return false;
89
+ }
90
+ return true;
91
+ };
92
+ const emptyFold = () => ({
93
+ byHour: new Map(),
94
+ cancelledByHour: new Map(),
95
+ keyFilters: [],
96
+ matchedDocuments: 0,
97
+ maxUpdatedAt: null,
98
+ });
99
+ const foldDocs = (docs, filters, includeCancelledInTotals) => {
100
+ const fold = emptyFold();
101
+ for (const doc of docs ?? []) {
102
+ if (doc == null)
103
+ continue;
104
+ if (fold.keyFilters.length === 0)
105
+ fold.keyFilters = doc.sale_type_key_filters ?? [];
106
+ fold.matchedDocuments += Number(doc.matched_documents ?? 1) || 0;
107
+ const updatedAt = doc.max_updated_at == null ? null : new Date(doc.max_updated_at);
108
+ if (updatedAt != null &&
109
+ !Number.isNaN(updatedAt.getTime()) &&
110
+ (fold.maxUpdatedAt == null || updatedAt.getTime() > fold.maxUpdatedAt.getTime())) {
111
+ fold.maxUpdatedAt = updatedAt;
112
+ }
113
+ for (const [hourKey, countersByKey] of Object.entries(doc.hour_counters ?? {})) {
114
+ const hour = Number(hourKey);
115
+ if (!Number.isInteger(hour) || hour < 0 || hour > 23)
116
+ continue;
117
+ for (const [key, counters] of Object.entries(countersByKey ?? {})) {
118
+ const parsed = parseKey(key, fold.keyFilters);
119
+ if (parsed == null || !keyMatchesFilters(parsed, filters))
120
+ continue;
121
+ if (isCancelled(parsed.order_status) && !includeCancelledInTotals) {
122
+ const cancelled = fold.cancelledByHour.get(hour) ?? (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
123
+ (0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(cancelled, counters);
124
+ fold.cancelledByHour.set(hour, cancelled);
125
+ continue;
126
+ }
127
+ const byKey = fold.byHour.get(hour) ?? new Map();
128
+ const existing = byKey.get(key) ?? (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
129
+ (0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(existing, counters);
130
+ byKey.set(key, existing);
131
+ fold.byHour.set(hour, byKey);
132
+ }
133
+ }
134
+ }
135
+ return fold;
136
+ };
137
+ /** Sums every non-cancelled hour into one totals block. */
138
+ const totalOf = (fold) => {
139
+ const total = (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
140
+ for (const byKey of fold.byHour.values()) {
141
+ for (const counters of byKey.values())
142
+ (0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(total, counters);
143
+ }
144
+ return total;
145
+ };
146
+ /** Sums the cancelled hour blocks. */
147
+ const cancelledTotalOf = (fold) => {
148
+ const total = (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
149
+ for (const counters of fold.cancelledByHour.values())
150
+ (0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(total, counters);
151
+ return total;
152
+ };
153
+ const buildPage = (group, filters) => {
154
+ const includeCancelled = includesCancelled(filters);
155
+ const currentFold = foldDocs(group.currentDocs, filters, includeCancelled);
156
+ const comparisonFold = group.comparisonDocs == null ? null : foldDocs(group.comparisonDocs, filters, includeCancelled);
157
+ const hours = [];
158
+ for (let businessIndex = 0; businessIndex < 24; businessIndex += 1) {
159
+ // business order 06…23, 00…05
160
+ const hour = (businessIndex + 6) % 24;
161
+ const current = (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(sumHour(currentFold.byHour.get(hour)));
162
+ const comparison = comparisonFold == null ? null : (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(sumHour(comparisonFold.byHour.get(hour)));
163
+ hours.push({
164
+ hour,
165
+ label: (0, exports.getHourlyComparisonHourLabel)(hour),
166
+ business_index: businessIndex,
167
+ current,
168
+ comparison,
169
+ metrics: (0, tenant_sales_comparison_formatter_1.buildSalesComparisonMetrics)(current, comparison),
170
+ });
171
+ }
172
+ const current = (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(totalOf(currentFold));
173
+ const comparison = comparisonFold == null ? null : (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(totalOf(comparisonFold));
174
+ return {
175
+ tenant_ids: [...group.tenantIds].sort(),
176
+ filters: {
177
+ platforms: filters.platforms != null && filters.platforms.length > 0 ? [...filters.platforms] : null,
178
+ order_statuses: filters.order_statuses != null && filters.order_statuses.length > 0 ? [...filters.order_statuses] : null,
179
+ },
180
+ current,
181
+ comparison,
182
+ metrics: (0, tenant_sales_comparison_formatter_1.buildSalesComparisonMetrics)(current, comparison),
183
+ cancelled: (0, tenant_sales_comparison_formatter_1.formatSalesComparisonSeries)(cancelledTotalOf(currentFold)),
184
+ hours,
185
+ hours_with_data: hours.filter((entry) => entry.current.counters.order_count > 0).length,
186
+ matched_documents: currentFold.matchedDocuments,
187
+ max_updated_at: currentFold.maxUpdatedAt,
188
+ };
189
+ };
190
+ const sumHour = (byKey) => {
191
+ const total = (0, materialized_sales_comparison_accumulator_helpers_1.createEmptySalesComparisonCounters)();
192
+ if (byKey != null)
193
+ for (const counters of byKey.values())
194
+ (0, materialized_sales_comparison_accumulator_helpers_1.addSalesComparisonCounters)(total, counters);
195
+ return total;
196
+ };
197
+ /**
198
+ * Page-ready Hourly Comparison data.
199
+ *
200
+ * `comparisonDocs` is `null` for `baseline: NONE`; an empty array is a valid
201
+ * baseline window with no sales (a zero profile).
202
+ */
203
+ function getFormattedTenantHourlyComparisonReporting(currentDocs, comparisonDocs, filters = null, separate_view_per_tenant = false) {
204
+ if (!Array.isArray(currentDocs) || currentDocs.length === 0)
205
+ return null;
206
+ if (currentDocs.some((doc) => doc == null))
207
+ return null;
208
+ if (comparisonDocs != null && !Array.isArray(comparisonDocs))
209
+ return null;
210
+ if (filters != null) {
211
+ if (filters.platforms != null && !Array.isArray(filters.platforms))
212
+ return null;
213
+ if (filters.order_statuses != null && !Array.isArray(filters.order_statuses))
214
+ return null;
215
+ }
216
+ const resolvedFilters = filters ?? {};
217
+ const normalizedCurrent = currentDocs.map(normalizeHourlyDocument);
218
+ if (normalizedCurrent.some((doc) => doc == null))
219
+ return null;
220
+ const normalizedComparison = comparisonDocs == null ? null : comparisonDocs.map(normalizeHourlyDocument);
221
+ if (normalizedComparison != null && normalizedComparison.some((doc) => doc == null))
222
+ return null;
223
+ const usableCurrent = normalizedCurrent;
224
+ if (usableCurrent.length === 0)
225
+ return null;
226
+ const signature = (usableCurrent[0].sale_type_key_filters ?? []).join(':');
227
+ for (const doc of [...usableCurrent, ...(normalizedComparison ?? [])]) {
228
+ if ((doc.sale_type_key_filters ?? []).join(':') !== signature)
229
+ return null;
230
+ }
231
+ const allTenantIds = [...new Set(usableCurrent.map((doc) => String(doc.tenant_id)))].sort();
232
+ const scopes = separate_view_per_tenant ? allTenantIds.map((tenantId) => [tenantId]) : [allTenantIds];
233
+ const pages = [];
234
+ for (const scope of scopes) {
235
+ const currentForScope = usableCurrent.filter((doc) => scope.includes(String(doc.tenant_id)));
236
+ if (currentForScope.length === 0)
237
+ continue;
238
+ const comparisonForScope = normalizedComparison == null
239
+ ? null
240
+ : normalizedComparison.filter((doc) => scope.includes(String(doc.tenant_id)));
241
+ pages.push(buildPage({ tenantIds: scope, currentDocs: currentForScope, comparisonDocs: comparisonForScope }, resolvedFilters));
242
+ }
243
+ return pages.length === 0 ? null : [pages, null];
244
+ }
@@ -0,0 +1,75 @@
1
+ import { PAYMENTS_COMPARISON_METRIC_ENUM } from '../../constants/MATERIALIZED_REPORTS';
2
+ import { IMaterializedPaymentsComparisonCounters, IMaterializedTenantPaymentsComparisonReport } from '../../schemas/types/materialized_tenant_payments_comparison_reports';
3
+ import { IMaterializedTenantPaymentsComparisonAggregatedReport } from '../types/materialized-reports-apis';
4
+ /**
5
+ * Payments Comparison formatter — the page-ready shape of `current` vs
6
+ * `comparison`, keyed `<PAYMENT_METHOD>:<ORDER_STATUS>`.
7
+ *
8
+ * Payment amounts are DECIMALS here; counts stay exact. `average_payment` is
9
+ * derived (`payment_amount / payment_count`), never stored. Filters and the
10
+ * metric switch are client-side: the document already carries every counter, so
11
+ * neither may trigger a refetch.
12
+ *
13
+ * Cancelled keys are split out of the totals (unless explicitly filtered), the
14
+ * same rule as Sales Comparison. Returns `null` on invalid input.
15
+ */
16
+ type TPaymentsDocument = IMaterializedTenantPaymentsComparisonAggregatedReport | IMaterializedTenantPaymentsComparisonReport;
17
+ export interface IFormattedPaymentsComparisonFilters {
18
+ payment_methods?: string[] | null;
19
+ order_statuses?: string[] | null;
20
+ }
21
+ export interface IFormattedPaymentsComparisonCounters {
22
+ payment_count: number;
23
+ payment_amount: number;
24
+ amount_due: number;
25
+ amount_paid: number;
26
+ amount_refunded: number;
27
+ card_charges: number;
28
+ refund_count: number;
29
+ unpaid_count: number;
30
+ }
31
+ export interface IFormattedPaymentsComparisonMetric {
32
+ current: number | null;
33
+ comparison: number | null;
34
+ delta: number | null;
35
+ delta_percent: number | null;
36
+ }
37
+ export interface IFormattedPaymentsComparisonSeries {
38
+ counters: IFormattedPaymentsComparisonCounters;
39
+ /** Derived: `payment_amount / payment_count`; `null` with no payments. */
40
+ average_payment: number | null;
41
+ }
42
+ export interface IFormattedPaymentsComparisonKeyRow {
43
+ key: string;
44
+ payment_method: string | null;
45
+ order_status: string | null;
46
+ current: IFormattedPaymentsComparisonSeries;
47
+ comparison: IFormattedPaymentsComparisonSeries | null;
48
+ metrics: Record<PAYMENTS_COMPARISON_METRIC_ENUM, IFormattedPaymentsComparisonMetric>;
49
+ }
50
+ export interface IFormattedPaymentsComparisonMethodRow {
51
+ payment_method: string;
52
+ current: IFormattedPaymentsComparisonSeries;
53
+ comparison: IFormattedPaymentsComparisonSeries | null;
54
+ metrics: Record<PAYMENTS_COMPARISON_METRIC_ENUM, IFormattedPaymentsComparisonMetric>;
55
+ }
56
+ export interface IFormattedPaymentsComparisonPageData {
57
+ tenant_ids: string[];
58
+ filters: {
59
+ payment_methods: string[] | null;
60
+ order_statuses: string[] | null;
61
+ };
62
+ current: IFormattedPaymentsComparisonSeries;
63
+ comparison: IFormattedPaymentsComparisonSeries | null;
64
+ metrics: Record<PAYMENTS_COMPARISON_METRIC_ENUM, IFormattedPaymentsComparisonMetric>;
65
+ cancelled: IFormattedPaymentsComparisonSeries;
66
+ rows: IFormattedPaymentsComparisonKeyRow[];
67
+ by_method: IFormattedPaymentsComparisonMethodRow[];
68
+ matched_documents: number;
69
+ max_updated_at: Date | null;
70
+ }
71
+ export declare const createEmptyPaymentsComparisonFormattedCounters: () => IFormattedPaymentsComparisonCounters;
72
+ export declare const formatPaymentsComparisonSeries: (counters: IMaterializedPaymentsComparisonCounters | null | undefined) => IFormattedPaymentsComparisonSeries;
73
+ export declare function buildPaymentsComparisonMetrics(current: IFormattedPaymentsComparisonSeries, comparison: IFormattedPaymentsComparisonSeries | null): Record<PAYMENTS_COMPARISON_METRIC_ENUM, IFormattedPaymentsComparisonMetric>;
74
+ export declare function getFormattedTenantPaymentsComparisonReporting(currentDocs: TPaymentsDocument[] | null | undefined, comparisonDocs: TPaymentsDocument[] | null | undefined, filters?: IFormattedPaymentsComparisonFilters | null, separate_view_per_tenant?: boolean): [IFormattedPaymentsComparisonPageData[], null] | null;
75
+ export {};
@@ -0,0 +1,289 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.formatPaymentsComparisonSeries = exports.createEmptyPaymentsComparisonFormattedCounters = void 0;
4
+ exports.buildPaymentsComparisonMetrics = buildPaymentsComparisonMetrics;
5
+ exports.getFormattedTenantPaymentsComparisonReporting = getFormattedTenantPaymentsComparisonReporting;
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 METRICS = [
13
+ MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_AMOUNT,
14
+ MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_COUNT,
15
+ MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.AVERAGE_PAYMENT,
16
+ MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.CARD_CHARGES,
17
+ MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.REFUNDED_AMOUNT,
18
+ MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.AMOUNT_DUE,
19
+ ];
20
+ const toDecimal = (cents) => (0, price_conversion_1.convertPriceFromCents)(cents ?? 0);
21
+ const createEmptyPaymentsComparisonFormattedCounters = () => ({
22
+ payment_count: 0,
23
+ payment_amount: 0,
24
+ amount_due: 0,
25
+ amount_paid: 0,
26
+ amount_refunded: 0,
27
+ card_charges: 0,
28
+ refund_count: 0,
29
+ unpaid_count: 0,
30
+ });
31
+ exports.createEmptyPaymentsComparisonFormattedCounters = createEmptyPaymentsComparisonFormattedCounters;
32
+ const formatCounters = (counters) => ({
33
+ payment_count: counters?.payment_count ?? 0,
34
+ payment_amount: toDecimal(counters?.payment_amount),
35
+ amount_due: toDecimal(counters?.amount_due),
36
+ amount_paid: toDecimal(counters?.amount_paid),
37
+ amount_refunded: toDecimal(counters?.amount_refunded),
38
+ card_charges: toDecimal(counters?.card_charges),
39
+ refund_count: counters?.refund_count ?? 0,
40
+ unpaid_count: counters?.unpaid_count ?? 0,
41
+ });
42
+ const formatPaymentsComparisonSeries = (counters) => {
43
+ const formatted = formatCounters(counters);
44
+ return {
45
+ counters: formatted,
46
+ average_payment: formatted.payment_count > 0 ? formatted.payment_amount / formatted.payment_count : null,
47
+ };
48
+ };
49
+ exports.formatPaymentsComparisonSeries = formatPaymentsComparisonSeries;
50
+ const seriesMetric = (series, metric) => {
51
+ switch (metric) {
52
+ case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_AMOUNT:
53
+ return series.counters.payment_amount;
54
+ case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_COUNT:
55
+ return series.counters.payment_count;
56
+ case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.AVERAGE_PAYMENT:
57
+ return series.average_payment;
58
+ case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.CARD_CHARGES:
59
+ return series.counters.card_charges;
60
+ case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.REFUNDED_AMOUNT:
61
+ return series.counters.amount_refunded;
62
+ case MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.AMOUNT_DUE:
63
+ return series.counters.amount_due;
64
+ default:
65
+ return null;
66
+ }
67
+ };
68
+ const percentDelta = (current, comparison) => {
69
+ if (current == null || comparison == null)
70
+ return null;
71
+ if (comparison === 0)
72
+ return current === 0 ? 0 : null;
73
+ return ((current - comparison) / Math.abs(comparison)) * 100;
74
+ };
75
+ function buildPaymentsComparisonMetrics(current, comparison) {
76
+ const metrics = {};
77
+ for (const metric of METRICS) {
78
+ const currentValue = seriesMetric(current, metric);
79
+ const comparisonValue = comparison == null ? null : seriesMetric(comparison, metric);
80
+ metrics[metric] = {
81
+ current: currentValue,
82
+ comparison: comparisonValue,
83
+ delta: currentValue == null || comparisonValue == null ? null : currentValue - comparisonValue,
84
+ delta_percent: percentDelta(currentValue, comparisonValue),
85
+ };
86
+ }
87
+ return metrics;
88
+ }
89
+ const parseKey = (key, keyFilters) => {
90
+ const components = (0, key_helpers_1.parseMaterializedReportKey)(key);
91
+ if (components == null || components.length !== keyFilters.length)
92
+ return null;
93
+ let paymentMethod = null;
94
+ let orderStatus = null;
95
+ for (let index = 0; index < keyFilters.length; index += 1) {
96
+ if (keyFilters[index] === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_KEY_FILTER_ENUM.PAYMENT_METHOD) {
97
+ paymentMethod = components[index];
98
+ }
99
+ else if (keyFilters[index] === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_KEY_FILTER_ENUM.ORDER_STATUS) {
100
+ orderStatus = components[index];
101
+ }
102
+ }
103
+ return { payment_method: paymentMethod, order_status: orderStatus };
104
+ };
105
+ const isCancelled = (orderStatus) => orderStatus === ENUMS_1.ORDER_STATUS_ENUM.CANCELLED;
106
+ const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes(ENUMS_1.ORDER_STATUS_ENUM.CANCELLED);
107
+ const matchesFilters = (parsed, filters) => {
108
+ if (filters.payment_methods != null &&
109
+ filters.payment_methods.length > 0 &&
110
+ (parsed.payment_method == null || !filters.payment_methods.includes(parsed.payment_method))) {
111
+ return false;
112
+ }
113
+ if (filters.order_statuses != null &&
114
+ filters.order_statuses.length > 0 &&
115
+ (parsed.order_status == null || !filters.order_statuses.includes(parsed.order_status))) {
116
+ return false;
117
+ }
118
+ return true;
119
+ };
120
+ const buildPage = (group, filters) => {
121
+ const keyFilters = (group.currentDocs[0]?.sale_type_key_filters ?? []);
122
+ const includeCancelled = includesCancelled(filters);
123
+ const fold = (docs) => {
124
+ const byKey = new Map();
125
+ const total = createEmptyPaymentsComparisonFormattedCountersRaw();
126
+ const cancelled = createEmptyPaymentsComparisonFormattedCountersRaw();
127
+ let matchedDocuments = 0;
128
+ let maxUpdatedAt = null;
129
+ for (const doc of docs ?? []) {
130
+ if (doc == null)
131
+ continue;
132
+ matchedDocuments += matchedDocumentsOf(doc);
133
+ const updatedAt = updatedAtOf(doc);
134
+ if (updatedAt != null) {
135
+ const date = new Date(updatedAt);
136
+ if (!Number.isNaN(date.getTime()) && (maxUpdatedAt == null || date.getTime() > maxUpdatedAt.getTime())) {
137
+ maxUpdatedAt = date;
138
+ }
139
+ }
140
+ for (const [key, counters] of Object.entries(doc.payment_counters ?? {})) {
141
+ const parsed = parseKey(key, keyFilters);
142
+ if (parsed == null || !matchesFilters(parsed, filters))
143
+ continue;
144
+ const target = byKey.get(key) ?? createEmptyPaymentsComparisonFormattedCountersRaw();
145
+ addRaw(target, counters);
146
+ byKey.set(key, target);
147
+ if (isCancelled(parsed.order_status) && !includeCancelled) {
148
+ addRaw(cancelled, counters);
149
+ }
150
+ else {
151
+ addRaw(total, counters);
152
+ }
153
+ }
154
+ }
155
+ return { byKey, total, cancelled, matchedDocuments, maxUpdatedAt };
156
+ };
157
+ const currentFold = fold(group.currentDocs);
158
+ const comparisonFold = group.comparisonDocs == null ? null : fold(group.comparisonDocs);
159
+ const rows = [];
160
+ for (const key of currentFold.byKey.keys()) {
161
+ const parsed = parseKey(key, keyFilters);
162
+ if (parsed == null)
163
+ continue;
164
+ const current = (0, exports.formatPaymentsComparisonSeries)(currentFold.byKey.get(key));
165
+ const comparison = comparisonFold == null ? null : (0, exports.formatPaymentsComparisonSeries)(comparisonFold.byKey.get(key));
166
+ rows.push({
167
+ key,
168
+ payment_method: parsed.payment_method,
169
+ order_status: parsed.order_status,
170
+ current,
171
+ comparison,
172
+ metrics: buildPaymentsComparisonMetrics(current, comparison),
173
+ });
174
+ }
175
+ rows.sort((a, b) => b.current.counters.payment_amount - a.current.counters.payment_amount || a.key.localeCompare(b.key));
176
+ const methodRows = new Map();
177
+ for (const row of rows) {
178
+ if (row.payment_method == null)
179
+ continue;
180
+ if (isCancelled(row.order_status) && !includeCancelled)
181
+ continue;
182
+ const existing = methodRows.get(row.payment_method) ?? {
183
+ payment_method: row.payment_method,
184
+ current: (0, exports.formatPaymentsComparisonSeries)(undefined),
185
+ comparison: comparisonFold == null ? null : (0, exports.formatPaymentsComparisonSeries)(undefined),
186
+ metrics: {},
187
+ };
188
+ existing.current = sumFormattedSeries(existing.current, row.current);
189
+ if (existing.comparison != null && row.comparison != null) {
190
+ existing.comparison = sumFormattedSeries(existing.comparison, row.comparison);
191
+ }
192
+ methodRows.set(row.payment_method, existing);
193
+ }
194
+ for (const methodRow of methodRows.values()) {
195
+ methodRow.metrics = buildPaymentsComparisonMetrics(methodRow.current, methodRow.comparison);
196
+ }
197
+ const current = (0, exports.formatPaymentsComparisonSeries)(currentFold.total);
198
+ const comparison = comparisonFold == null ? null : (0, exports.formatPaymentsComparisonSeries)(comparisonFold.total);
199
+ return {
200
+ tenant_ids: [...group.tenantIds].sort(),
201
+ filters: {
202
+ payment_methods: filters.payment_methods != null && filters.payment_methods.length > 0 ? [...filters.payment_methods] : null,
203
+ order_statuses: filters.order_statuses != null && filters.order_statuses.length > 0 ? [...filters.order_statuses] : null,
204
+ },
205
+ current,
206
+ comparison,
207
+ metrics: buildPaymentsComparisonMetrics(current, comparison),
208
+ cancelled: (0, exports.formatPaymentsComparisonSeries)(currentFold.cancelled),
209
+ rows,
210
+ by_method: [...methodRows.values()].sort((a, b) => b.current.counters.payment_amount - a.current.counters.payment_amount ||
211
+ a.payment_method.localeCompare(b.payment_method)),
212
+ matched_documents: currentFold.matchedDocuments,
213
+ max_updated_at: currentFold.maxUpdatedAt,
214
+ };
215
+ };
216
+ function createEmptyPaymentsComparisonFormattedCountersRaw() {
217
+ return {
218
+ payment_count: 0,
219
+ payment_amount: 0,
220
+ amount_due: 0,
221
+ amount_paid: 0,
222
+ amount_refunded: 0,
223
+ card_charges: 0,
224
+ refund_count: 0,
225
+ unpaid_count: 0,
226
+ };
227
+ }
228
+ function addRaw(target, source) {
229
+ target.payment_count += source.payment_count ?? 0;
230
+ target.payment_amount += source.payment_amount ?? 0;
231
+ target.amount_due += source.amount_due ?? 0;
232
+ target.amount_paid += source.amount_paid ?? 0;
233
+ target.amount_refunded += source.amount_refunded ?? 0;
234
+ target.card_charges += source.card_charges ?? 0;
235
+ target.refund_count += source.refund_count ?? 0;
236
+ target.unpaid_count += source.unpaid_count ?? 0;
237
+ }
238
+ function sumFormattedSeries(a, b) {
239
+ const counters = {
240
+ payment_count: a.counters.payment_count + b.counters.payment_count,
241
+ payment_amount: a.counters.payment_amount + b.counters.payment_amount,
242
+ amount_due: a.counters.amount_due + b.counters.amount_due,
243
+ amount_paid: a.counters.amount_paid + b.counters.amount_paid,
244
+ amount_refunded: a.counters.amount_refunded + b.counters.amount_refunded,
245
+ card_charges: a.counters.card_charges + b.counters.card_charges,
246
+ refund_count: a.counters.refund_count + b.counters.refund_count,
247
+ unpaid_count: a.counters.unpaid_count + b.counters.unpaid_count,
248
+ };
249
+ return {
250
+ counters,
251
+ average_payment: counters.payment_count > 0 ? counters.payment_amount / counters.payment_count : null,
252
+ };
253
+ }
254
+ function getFormattedTenantPaymentsComparisonReporting(currentDocs, comparisonDocs, filters = null, separate_view_per_tenant = false) {
255
+ if (!Array.isArray(currentDocs) || currentDocs.length === 0)
256
+ return null;
257
+ if (currentDocs.some((doc) => doc == null))
258
+ return null;
259
+ if (comparisonDocs != null && !Array.isArray(comparisonDocs))
260
+ return null;
261
+ if (filters != null) {
262
+ if (filters.payment_methods != null && !Array.isArray(filters.payment_methods))
263
+ return null;
264
+ if (filters.order_statuses != null && !Array.isArray(filters.order_statuses))
265
+ return null;
266
+ }
267
+ const resolvedFilters = filters ?? {};
268
+ const signature = (currentDocs[0].sale_type_key_filters ?? []).join(':');
269
+ for (const doc of [...currentDocs, ...(comparisonDocs ?? [])]) {
270
+ if ((doc.sale_type_key_filters ?? []).join(':') !== signature)
271
+ return null;
272
+ }
273
+ const usableCurrent = currentDocs.filter((doc) => doc.payment_counters != null);
274
+ if (usableCurrent.length === 0)
275
+ return null;
276
+ const allTenantIds = [...new Set(usableCurrent.map((doc) => String(doc.tenant_id)))].sort();
277
+ const scopes = separate_view_per_tenant ? allTenantIds.map((tenantId) => [tenantId]) : [allTenantIds];
278
+ const pages = [];
279
+ for (const scope of scopes) {
280
+ const currentForScope = usableCurrent.filter((doc) => scope.includes(String(doc.tenant_id)));
281
+ if (currentForScope.length === 0)
282
+ continue;
283
+ const comparisonForScope = comparisonDocs == null ? null : comparisonDocs.filter((doc) => scope.includes(String(doc.tenant_id)));
284
+ const page = buildPage({ tenantIds: scope, currentDocs: currentForScope, comparisonDocs: comparisonForScope }, resolvedFilters);
285
+ if (page != null)
286
+ pages.push(page);
287
+ }
288
+ return pages.length === 0 ? null : [pages, null];
289
+ }