@managesome/eposmatic-toolkit 0.4.8 → 0.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (336) hide show
  1. package/esm/constants/MATERIALIZED_REPORTS.js +448 -0
  2. package/esm/constants/enums/communications.js +1 -0
  3. package/esm/helpers/index.js +3 -0
  4. package/esm/helpers/materialized-reports/index.js +32 -0
  5. package/esm/helpers/materialized-reports/materialized-cash-accumulator-helpers.js +114 -0
  6. package/esm/helpers/materialized-reports/materialized-cash-classification-helpers.js +286 -0
  7. package/esm/helpers/materialized-reports/materialized-cash-close-day-helpers.js +396 -0
  8. package/esm/helpers/materialized-reports/materialized-cash-compile-helpers.js +244 -0
  9. package/esm/helpers/materialized-reports/materialized-delivery-accumulator-helpers.js +170 -0
  10. package/esm/helpers/materialized-reports/materialized-delivery-classification-helpers.js +426 -0
  11. package/esm/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +372 -0
  12. package/esm/helpers/materialized-reports/materialized-delivery-compile-helpers.js +214 -0
  13. package/esm/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +318 -0
  14. package/esm/helpers/materialized-reports/materialized-discount-classification-helpers.js +213 -0
  15. package/esm/helpers/materialized-reports/materialized-discount-close-day-helpers.js +604 -0
  16. package/esm/helpers/materialized-reports/materialized-discount-compile-helpers.js +186 -0
  17. package/esm/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.js +155 -0
  18. package/esm/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.js +199 -0
  19. package/esm/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +111 -0
  20. package/esm/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +88 -0
  21. package/esm/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.js +394 -0
  22. package/esm/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.js +167 -0
  23. package/esm/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +215 -0
  24. package/esm/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +476 -0
  25. package/esm/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +201 -0
  26. package/esm/helpers/materialized-reports/materialized-reports-selection-helpers.js +7 -0
  27. package/esm/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +189 -0
  28. package/esm/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +157 -0
  29. package/esm/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.js +588 -0
  30. package/esm/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.js +175 -0
  31. package/esm/helpers/materialized-reports/tenant-cash-in-out-formatter.js +156 -0
  32. package/esm/helpers/materialized-reports/tenant-delivery-formatter.js +230 -0
  33. package/esm/helpers/materialized-reports/tenant-discount-formatter.js +427 -0
  34. package/esm/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +237 -0
  35. package/esm/helpers/materialized-reports/tenant-payments-comparison-formatter.js +279 -0
  36. package/esm/helpers/materialized-reports/tenant-prep-time-formatter.js +228 -0
  37. package/esm/helpers/materialized-reports/tenant-sales-comparison-formatter.js +343 -0
  38. package/esm/helpers/reporting-contract/index.js +2 -0
  39. package/esm/helpers/reporting-contract/overview-contract.js +122 -0
  40. package/esm/helpers/reporting-contract/report-contract.js +228 -0
  41. package/esm/helpers/rider-earnings/index.js +1 -0
  42. package/esm/helpers/rider-earnings/rider-earnings.js +59 -0
  43. package/esm/helpers/rider-reports/index.js +2 -0
  44. package/esm/helpers/rider-reports/rider-daily-report.js +90 -0
  45. package/esm/helpers/rider-reports/rider-report.js +67 -0
  46. package/esm/schemas/models/deliveries.js +75 -0
  47. package/esm/schemas/models/index.js +15 -0
  48. package/esm/schemas/models/materialized_rider_daily_reports.js +39 -0
  49. package/esm/schemas/models/materialized_tenant_cash_entries.js +95 -0
  50. package/esm/schemas/models/materialized_tenant_cash_reports.js +77 -0
  51. package/esm/schemas/models/materialized_tenant_delivery_entries.js +63 -0
  52. package/esm/schemas/models/materialized_tenant_delivery_reports.js +63 -0
  53. package/esm/schemas/models/materialized_tenant_discount_entries.js +156 -0
  54. package/esm/schemas/models/materialized_tenant_discount_reports.js +333 -0
  55. package/esm/schemas/models/materialized_tenant_hourly_comparison_entries.js +87 -0
  56. package/esm/schemas/models/materialized_tenant_hourly_comparison_reports.js +99 -0
  57. package/esm/schemas/models/materialized_tenant_payments_comparison_entries.js +71 -0
  58. package/esm/schemas/models/materialized_tenant_payments_comparison_reports.js +76 -0
  59. package/esm/schemas/models/materialized_tenant_prep_time_entries.js +130 -0
  60. package/esm/schemas/models/materialized_tenant_prep_time_reports.js +109 -0
  61. package/esm/schemas/models/materialized_tenant_sales_comparison_entries.js +130 -0
  62. package/esm/schemas/models/materialized_tenant_sales_comparison_reports.js +154 -0
  63. package/esm/schemas/types/index.js +15 -0
  64. package/esm/schemas/types/materialized_rider_daily_reports.js +1 -0
  65. package/esm/schemas/types/materialized_tenant_cash_entries.js +1 -0
  66. package/esm/schemas/types/materialized_tenant_cash_reports.js +1 -0
  67. package/esm/schemas/types/materialized_tenant_delivery_entries.js +1 -0
  68. package/esm/schemas/types/materialized_tenant_delivery_reports.js +1 -0
  69. package/esm/schemas/types/materialized_tenant_discount_entries.js +1 -0
  70. package/esm/schemas/types/materialized_tenant_discount_reports.js +2 -0
  71. package/esm/schemas/types/materialized_tenant_hourly_comparison_entries.js +1 -0
  72. package/esm/schemas/types/materialized_tenant_hourly_comparison_reports.js +1 -0
  73. package/esm/schemas/types/materialized_tenant_payments_comparison_entries.js +1 -0
  74. package/esm/schemas/types/materialized_tenant_payments_comparison_reports.js +11 -0
  75. package/esm/schemas/types/materialized_tenant_prep_time_entries.js +1 -0
  76. package/esm/schemas/types/materialized_tenant_prep_time_reports.js +1 -0
  77. package/esm/schemas/types/materialized_tenant_sales_comparison_entries.js +1 -0
  78. package/esm/schemas/types/materialized_tenant_sales_comparison_reports.js +14 -0
  79. package/lib/constants/MATERIALIZED_REPORTS.d.ts +339 -2
  80. package/lib/constants/MATERIALIZED_REPORTS.js +450 -1
  81. package/lib/constants/enums/communications.d.ts +1 -0
  82. package/lib/constants/enums/communications.js +2 -1
  83. package/lib/helpers/index.d.ts +3 -0
  84. package/lib/helpers/index.js +3 -0
  85. package/lib/helpers/materialized-reports/index.d.ts +32 -0
  86. package/lib/helpers/materialized-reports/index.js +32 -0
  87. package/lib/helpers/materialized-reports/materialized-cash-accumulator-helpers.d.ts +18 -0
  88. package/lib/helpers/materialized-reports/materialized-cash-accumulator-helpers.js +118 -0
  89. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.d.ts +90 -0
  90. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.js +295 -0
  91. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.d.ts +102 -0
  92. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.js +409 -0
  93. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.d.ts +72 -0
  94. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.js +251 -0
  95. package/lib/helpers/materialized-reports/materialized-delivery-accumulator-helpers.d.ts +7 -0
  96. package/lib/helpers/materialized-reports/materialized-delivery-accumulator-helpers.js +173 -0
  97. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.d.ts +84 -0
  98. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.js +438 -0
  99. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.d.ts +97 -0
  100. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +385 -0
  101. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.d.ts +40 -0
  102. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +218 -0
  103. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.d.ts +52 -0
  104. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +324 -0
  105. package/lib/helpers/materialized-reports/materialized-discount-classification-helpers.d.ts +50 -0
  106. package/lib/helpers/materialized-reports/materialized-discount-classification-helpers.js +222 -0
  107. package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.d.ts +182 -0
  108. package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.js +615 -0
  109. package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.d.ts +47 -0
  110. package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.js +193 -0
  111. package/lib/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.d.ts +64 -0
  112. package/lib/helpers/materialized-reports/materialized-hourly-comparison-close-day-helpers.js +163 -0
  113. package/lib/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.d.ts +61 -0
  114. package/lib/helpers/materialized-reports/materialized-hourly-comparison-compile-helpers.js +207 -0
  115. package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.d.ts +23 -0
  116. package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +116 -0
  117. package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.d.ts +25 -0
  118. package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +98 -0
  119. package/lib/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.d.ts +79 -0
  120. package/lib/helpers/materialized-reports/materialized-payments-comparison-close-day-helpers.js +407 -0
  121. package/lib/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.d.ts +35 -0
  122. package/lib/helpers/materialized-reports/materialized-payments-comparison-compile-helpers.js +173 -0
  123. package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.d.ts +66 -0
  124. package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +224 -0
  125. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.d.ts +128 -0
  126. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +490 -0
  127. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.d.ts +46 -0
  128. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +208 -0
  129. package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.d.ts +8 -0
  130. package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.js +8 -1
  131. package/lib/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.d.ts +48 -0
  132. package/lib/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +204 -0
  133. package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.d.ts +22 -0
  134. package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +161 -0
  135. package/lib/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.d.ts +163 -0
  136. package/lib/helpers/materialized-reports/materialized-sales-comparison-close-day-helpers.js +603 -0
  137. package/lib/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.d.ts +68 -0
  138. package/lib/helpers/materialized-reports/materialized-sales-comparison-compile-helpers.js +182 -0
  139. package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.d.ts +98 -0
  140. package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.js +159 -0
  141. package/lib/helpers/materialized-reports/tenant-delivery-formatter.d.ts +133 -0
  142. package/lib/helpers/materialized-reports/tenant-delivery-formatter.js +233 -0
  143. package/lib/helpers/materialized-reports/tenant-discount-formatter.d.ts +114 -0
  144. package/lib/helpers/materialized-reports/tenant-discount-formatter.js +431 -0
  145. package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.d.ts +60 -0
  146. package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +243 -0
  147. package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.d.ts +75 -0
  148. package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.js +286 -0
  149. package/lib/helpers/materialized-reports/tenant-prep-time-formatter.d.ts +97 -0
  150. package/lib/helpers/materialized-reports/tenant-prep-time-formatter.js +232 -0
  151. package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.d.ts +105 -0
  152. package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.js +349 -0
  153. package/lib/helpers/reporting-contract/index.d.ts +2 -0
  154. package/lib/helpers/reporting-contract/index.js +18 -0
  155. package/lib/helpers/reporting-contract/overview-contract.d.ts +55 -0
  156. package/lib/helpers/reporting-contract/overview-contract.js +126 -0
  157. package/lib/helpers/reporting-contract/report-contract.d.ts +159 -0
  158. package/lib/helpers/reporting-contract/report-contract.js +239 -0
  159. package/lib/helpers/rider-earnings/index.d.ts +1 -0
  160. package/lib/helpers/rider-earnings/index.js +17 -0
  161. package/lib/helpers/rider-earnings/rider-earnings.d.ts +58 -0
  162. package/lib/helpers/rider-earnings/rider-earnings.js +64 -0
  163. package/lib/helpers/rider-reports/index.d.ts +2 -0
  164. package/lib/helpers/rider-reports/index.js +18 -0
  165. package/lib/helpers/rider-reports/rider-daily-report.d.ts +26 -0
  166. package/lib/helpers/rider-reports/rider-daily-report.js +93 -0
  167. package/lib/helpers/rider-reports/rider-report.d.ts +49 -0
  168. package/lib/helpers/rider-reports/rider-report.js +70 -0
  169. package/lib/helpers/types/materialized-reports-apis.d.ts +297 -1
  170. package/lib/schemas/models/deliveries.d.ts +54 -0
  171. package/lib/schemas/models/deliveries.js +75 -0
  172. package/lib/schemas/models/expense_details.d.ts +3 -3
  173. package/lib/schemas/models/index.d.ts +15 -0
  174. package/lib/schemas/models/index.js +15 -0
  175. package/lib/schemas/models/materialized_rider_daily_reports.d.ts +27 -0
  176. package/lib/schemas/models/materialized_rider_daily_reports.js +42 -0
  177. package/lib/schemas/models/materialized_tenant_cash_entries.d.ts +181 -0
  178. package/lib/schemas/models/materialized_tenant_cash_entries.js +98 -0
  179. package/lib/schemas/models/materialized_tenant_cash_reports.d.ts +111 -0
  180. package/lib/schemas/models/materialized_tenant_cash_reports.js +80 -0
  181. package/lib/schemas/models/materialized_tenant_delivery_entries.d.ts +98 -0
  182. package/lib/schemas/models/materialized_tenant_delivery_entries.js +66 -0
  183. package/lib/schemas/models/materialized_tenant_delivery_reports.d.ts +98 -0
  184. package/lib/schemas/models/materialized_tenant_delivery_reports.js +66 -0
  185. package/lib/schemas/models/materialized_tenant_discount_entries.d.ts +199 -0
  186. package/lib/schemas/models/materialized_tenant_discount_entries.js +159 -0
  187. package/lib/schemas/models/materialized_tenant_discount_reports.d.ts +216 -0
  188. package/lib/schemas/models/materialized_tenant_discount_reports.js +336 -0
  189. package/lib/schemas/models/materialized_tenant_hourly_comparison_entries.d.ts +95 -0
  190. package/lib/schemas/models/materialized_tenant_hourly_comparison_entries.js +82 -0
  191. package/lib/schemas/models/materialized_tenant_hourly_comparison_reports.d.ts +105 -0
  192. package/lib/schemas/models/materialized_tenant_hourly_comparison_reports.js +91 -0
  193. package/lib/schemas/models/materialized_tenant_payments_comparison_entries.d.ts +91 -0
  194. package/lib/schemas/models/materialized_tenant_payments_comparison_entries.js +70 -0
  195. package/lib/schemas/models/materialized_tenant_payments_comparison_reports.d.ts +98 -0
  196. package/lib/schemas/models/materialized_tenant_payments_comparison_reports.js +71 -0
  197. package/lib/schemas/models/materialized_tenant_prep_time_entries.d.ts +181 -0
  198. package/lib/schemas/models/materialized_tenant_prep_time_entries.js +133 -0
  199. package/lib/schemas/models/materialized_tenant_prep_time_reports.d.ts +118 -0
  200. package/lib/schemas/models/materialized_tenant_prep_time_reports.js +112 -0
  201. package/lib/schemas/models/materialized_tenant_sales_comparison_entries.d.ts +139 -0
  202. package/lib/schemas/models/materialized_tenant_sales_comparison_entries.js +120 -0
  203. package/lib/schemas/models/materialized_tenant_sales_comparison_reports.d.ts +167 -0
  204. package/lib/schemas/models/materialized_tenant_sales_comparison_reports.js +137 -0
  205. package/lib/schemas/models/tenant_purchase_order_vendor_returns.d.ts +3 -3
  206. package/lib/schemas/models/warehouse_internal_movements.d.ts +6 -6
  207. package/lib/schemas/models/warehouse_purchase_order_receipts.d.ts +3 -3
  208. package/lib/schemas/models/warehouse_purchase_order_vendor_returns.d.ts +3 -3
  209. package/lib/schemas/models/warehouse_sale_deliveries.d.ts +6 -6
  210. package/lib/schemas/models/warehouse_sale_invoices.d.ts +3 -3
  211. package/lib/schemas/types/deliveries.d.ts +40 -1
  212. package/lib/schemas/types/index.d.ts +15 -0
  213. package/lib/schemas/types/index.js +15 -0
  214. package/lib/schemas/types/materialized_rider_daily_reports.d.ts +37 -0
  215. package/lib/schemas/types/materialized_rider_daily_reports.js +2 -0
  216. package/lib/schemas/types/materialized_tenant_cash_entries.d.ts +87 -0
  217. package/lib/schemas/types/materialized_tenant_cash_entries.js +2 -0
  218. package/lib/schemas/types/materialized_tenant_cash_reports.d.ts +144 -0
  219. package/lib/schemas/types/materialized_tenant_cash_reports.js +2 -0
  220. package/lib/schemas/types/materialized_tenant_delivery_entries.d.ts +98 -0
  221. package/lib/schemas/types/materialized_tenant_delivery_entries.js +2 -0
  222. package/lib/schemas/types/materialized_tenant_delivery_reports.d.ts +179 -0
  223. package/lib/schemas/types/materialized_tenant_delivery_reports.js +2 -0
  224. package/lib/schemas/types/materialized_tenant_discount_entries.d.ts +81 -0
  225. package/lib/schemas/types/materialized_tenant_discount_entries.js +2 -0
  226. package/lib/schemas/types/materialized_tenant_discount_reports.d.ts +209 -0
  227. package/lib/schemas/types/materialized_tenant_discount_reports.js +3 -0
  228. package/lib/schemas/types/materialized_tenant_hourly_comparison_entries.d.ts +33 -0
  229. package/lib/schemas/types/materialized_tenant_hourly_comparison_entries.js +2 -0
  230. package/lib/schemas/types/materialized_tenant_hourly_comparison_reports.d.ts +40 -0
  231. package/lib/schemas/types/materialized_tenant_hourly_comparison_reports.js +2 -0
  232. package/lib/schemas/types/materialized_tenant_payments_comparison_entries.d.ts +48 -0
  233. package/lib/schemas/types/materialized_tenant_payments_comparison_entries.js +2 -0
  234. package/lib/schemas/types/materialized_tenant_payments_comparison_reports.d.ts +51 -0
  235. package/lib/schemas/types/materialized_tenant_payments_comparison_reports.js +14 -0
  236. package/lib/schemas/types/materialized_tenant_prep_time_entries.d.ts +88 -0
  237. package/lib/schemas/types/materialized_tenant_prep_time_entries.js +2 -0
  238. package/lib/schemas/types/materialized_tenant_prep_time_reports.d.ts +132 -0
  239. package/lib/schemas/types/materialized_tenant_prep_time_reports.js +2 -0
  240. package/lib/schemas/types/materialized_tenant_sales_comparison_entries.d.ts +43 -0
  241. package/lib/schemas/types/materialized_tenant_sales_comparison_entries.js +2 -0
  242. package/lib/schemas/types/materialized_tenant_sales_comparison_reports.d.ts +74 -0
  243. package/lib/schemas/types/materialized_tenant_sales_comparison_reports.js +17 -0
  244. package/lib/tests/materialized-reports/analytics-growth-helpers.test.d.ts +1 -0
  245. package/lib/tests/materialized-reports/analytics-overview-helpers.test.d.ts +1 -0
  246. package/lib/tests/materialized-reports/analytics-performance-helpers.test.d.ts +1 -0
  247. package/lib/tests/materialized-reports/fixtures.d.ts +15 -1
  248. package/lib/tests/materialized-reports/fixtures.js +1 -0
  249. package/lib/tests/materialized-reports/materialized-cash-compile.test.d.ts +1 -0
  250. package/lib/tests/materialized-reports/materialized-cash-compile.test.js +196 -0
  251. package/lib/tests/materialized-reports/materialized-cash-fold.test.d.ts +1 -0
  252. package/lib/tests/materialized-reports/materialized-cash-fold.test.js +116 -0
  253. package/lib/tests/materialized-reports/materialized-cash-formatter.test.d.ts +1 -0
  254. package/lib/tests/materialized-reports/materialized-cash-formatter.test.js +152 -0
  255. package/lib/tests/materialized-reports/materialized-cash-plan.test.d.ts +1 -0
  256. package/lib/tests/materialized-reports/materialized-cash-plan.test.js +168 -0
  257. package/lib/tests/materialized-reports/materialized-cash-reconciliation.test.d.ts +1 -0
  258. package/lib/tests/materialized-reports/materialized-cash-reconciliation.test.js +267 -0
  259. package/lib/tests/materialized-reports/materialized-delivery-accumulation.test.d.ts +1 -0
  260. package/lib/tests/materialized-reports/materialized-delivery-accumulation.test.js +147 -0
  261. package/lib/tests/materialized-reports/materialized-delivery-compile.test.d.ts +1 -0
  262. package/lib/tests/materialized-reports/materialized-delivery-compile.test.js +241 -0
  263. package/lib/tests/materialized-reports/materialized-delivery-fold.test.d.ts +1 -0
  264. package/lib/tests/materialized-reports/materialized-delivery-fold.test.js +109 -0
  265. package/lib/tests/materialized-reports/materialized-delivery-formatter.test.d.ts +1 -0
  266. package/lib/tests/materialized-reports/materialized-delivery-formatter.test.js +141 -0
  267. package/lib/tests/materialized-reports/materialized-delivery-plan.test.d.ts +1 -0
  268. package/lib/tests/materialized-reports/materialized-delivery-plan.test.js +198 -0
  269. package/lib/tests/materialized-reports/materialized-discount-aggregated-formatter.test.d.ts +1 -0
  270. package/lib/tests/materialized-reports/materialized-discount-aggregated-formatter.test.js +173 -0
  271. package/lib/tests/materialized-reports/materialized-discount-classification.test.d.ts +1 -0
  272. package/lib/tests/materialized-reports/materialized-discount-classification.test.js +339 -0
  273. package/lib/tests/materialized-reports/materialized-discount-close-day.test.d.ts +1 -0
  274. package/lib/tests/materialized-reports/materialized-discount-close-day.test.js +506 -0
  275. package/lib/tests/materialized-reports/materialized-discount-compile.test.d.ts +1 -0
  276. package/lib/tests/materialized-reports/materialized-discount-compile.test.js +161 -0
  277. package/lib/tests/materialized-reports/materialized-discount-counter-rows.test.d.ts +1 -0
  278. package/lib/tests/materialized-reports/materialized-discount-counter-rows.test.js +107 -0
  279. package/lib/tests/materialized-reports/materialized-discount-entries-accumulation.test.d.ts +1 -0
  280. package/lib/tests/materialized-reports/materialized-discount-entries-accumulation.test.js +125 -0
  281. package/lib/tests/materialized-reports/materialized-hourly-comparison-compile.test.d.ts +1 -0
  282. package/lib/tests/materialized-reports/materialized-hourly-comparison-compile.test.js +146 -0
  283. package/lib/tests/materialized-reports/materialized-hourly-comparison-formatter.test.d.ts +1 -0
  284. package/lib/tests/materialized-reports/materialized-hourly-comparison-formatter.test.js +127 -0
  285. package/lib/tests/materialized-reports/materialized-hourly-comparison-plan.test.d.ts +1 -0
  286. package/lib/tests/materialized-reports/materialized-hourly-comparison-plan.test.js +138 -0
  287. package/lib/tests/materialized-reports/materialized-hourly-comparison-selection.test.d.ts +1 -0
  288. package/lib/tests/materialized-reports/materialized-hourly-comparison-selection.test.js +90 -0
  289. package/lib/tests/materialized-reports/materialized-payments-comparison-compile.test.d.ts +1 -0
  290. package/lib/tests/materialized-reports/materialized-payments-comparison-compile.test.js +164 -0
  291. package/lib/tests/materialized-reports/materialized-payments-comparison-formatter.test.d.ts +1 -0
  292. package/lib/tests/materialized-reports/materialized-payments-comparison-formatter.test.js +117 -0
  293. package/lib/tests/materialized-reports/materialized-payments-comparison-plan.test.d.ts +1 -0
  294. package/lib/tests/materialized-reports/materialized-payments-comparison-plan.test.js +149 -0
  295. package/lib/tests/materialized-reports/materialized-prep-time-classification.test.d.ts +1 -0
  296. package/lib/tests/materialized-reports/materialized-prep-time-classification.test.js +273 -0
  297. package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.d.ts +1 -0
  298. package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.js +270 -0
  299. package/lib/tests/materialized-reports/materialized-prep-time-compile.test.d.ts +1 -0
  300. package/lib/tests/materialized-reports/materialized-prep-time-compile.test.js +217 -0
  301. package/lib/tests/materialized-reports/materialized-prep-time-constants.test.d.ts +1 -0
  302. package/lib/tests/materialized-reports/materialized-prep-time-constants.test.js +84 -0
  303. package/lib/tests/materialized-reports/materialized-prep-time-plan.test.d.ts +1 -0
  304. package/lib/tests/materialized-reports/materialized-prep-time-plan.test.js +176 -0
  305. package/lib/tests/materialized-reports/materialized-sales-comparison-baseline.test.d.ts +1 -0
  306. package/lib/tests/materialized-reports/materialized-sales-comparison-baseline.test.js +126 -0
  307. package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.d.ts +1 -0
  308. package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.js +206 -0
  309. package/lib/tests/materialized-reports/materialized-sales-comparison-formatter.test.d.ts +1 -0
  310. package/lib/tests/materialized-reports/materialized-sales-comparison-formatter.test.js +179 -0
  311. package/lib/tests/materialized-reports/materialized-sales-comparison-parity.test.d.ts +1 -0
  312. package/lib/tests/materialized-reports/materialized-sales-comparison-parity.test.js +196 -0
  313. package/lib/tests/materialized-reports/materialized-sales-comparison-plan.test.d.ts +1 -0
  314. package/lib/tests/materialized-reports/materialized-sales-comparison-plan.test.js +241 -0
  315. package/lib/tests/materialized-reports/materialized-tenant-hourly-comparison-schema.test.d.ts +1 -0
  316. package/lib/tests/materialized-reports/materialized-tenant-hourly-comparison-schema.test.js +96 -0
  317. package/lib/tests/materialized-reports/materialized-tenant-payments-comparison-schema.test.d.ts +1 -0
  318. package/lib/tests/materialized-reports/materialized-tenant-payments-comparison-schema.test.js +112 -0
  319. package/lib/tests/materialized-reports/materialized-tenant-sales-comparison-schema.test.d.ts +1 -0
  320. package/lib/tests/materialized-reports/materialized-tenant-sales-comparison-schema.test.js +142 -0
  321. package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.js +8 -1
  322. package/lib/tests/materialized-reports/sales-comparison-reference.d.ts +55 -0
  323. package/lib/tests/materialized-reports/sales-comparison-reference.js +86 -0
  324. package/lib/tests/materialized-reports/tenant-discount-formatter.test.d.ts +1 -0
  325. package/lib/tests/materialized-reports/tenant-discount-formatter.test.js +289 -0
  326. package/lib/tests/materialized-reports/tenant-prep-time-formatter.test.d.ts +1 -0
  327. package/lib/tests/materialized-reports/tenant-prep-time-formatter.test.js +354 -0
  328. package/lib/tests/reporting-contract.test.d.ts +1 -0
  329. package/lib/tests/reporting-contract.test.js +267 -0
  330. package/lib/tests/rider-daily-report.test.d.ts +1 -0
  331. package/lib/tests/rider-daily-report.test.js +86 -0
  332. package/lib/tests/rider-earnings.test.d.ts +1 -0
  333. package/lib/tests/rider-earnings.test.js +65 -0
  334. package/lib/tests/rider-report.test.d.ts +1 -0
  335. package/lib/tests/rider-report.test.js +98 -0
  336. package/package.json +10 -1
@@ -0,0 +1,97 @@
1
+ import { DAY_INDEX_ENUM } from '../../constants/ENUMS';
2
+ import { IMaterializedTenantPrepTimeReport } from '../../schemas/types/materialized_tenant_prep_time_reports';
3
+ /**
4
+ * Frontend formatter for `materialized_tenant_prep_time_reports` (M2).
5
+ *
6
+ * COVERAGE-FIRST BY CONSTRUCTION: the summary always states how much of the
7
+ * operation was actually OBSERVED (tracked / all items, and own-anchor / tracked)
8
+ * before it states a duration. Reporting an average without its denominator is the
9
+ * single misreading this report exists to prevent - one measured store is 2.9%
10
+ * covered and its blended average understates prep by ~13x.
11
+ *
12
+ * Durations come from the MEASURED bucket only (the accumulator never let a
13
+ * fallback-anchored value in), so the formatter never has to re-apply that rule.
14
+ * `median_bucket` / `p90_bucket` are HISTOGRAM-DERIVED and therefore
15
+ * bucket-approximate - the exact average comes from `sum / count`.
16
+ *
17
+ * Validation convention (same as the other reports): returns `null` instead of
18
+ * throwing on unformattable input (non-array, null entries, mixed key filters or
19
+ * schema versions). An EMPTY list is valid and yields a zero-filled page.
20
+ */
21
+ export interface IFormattedPrepTimeFilters {
22
+ /** Platform component values (e.g. `POS_WALK-IN`); empty or omitted = all. */
23
+ platforms?: string[] | null;
24
+ /** Order-status component values (e.g. `COMPLETED`); empty or omitted = all. */
25
+ order_statuses?: string[] | null;
26
+ /**
27
+ * Weekday filter - only meaningful for DATE-scoped documents, which carry
28
+ * `day_index`. Documents of other scopes are dropped when it is set, exactly
29
+ * like the overview formatter.
30
+ */
31
+ day_indexes?: DAY_INDEX_ENUM[] | null;
32
+ }
33
+ export interface IFormattedPrepTimeSummary {
34
+ items: number;
35
+ ready_items: number;
36
+ tracked_items: number;
37
+ own_anchor_items: number;
38
+ /** tracked / items - how much of the operation is observed at all. */
39
+ coverage_percent: number;
40
+ /** own-anchor / tracked - how much of what we observed is TRUSTWORTHY. */
41
+ own_coverage_percent: number;
42
+ /** MEASURED only; null when nothing was measured. */
43
+ avg_minutes: number | null;
44
+ median_bucket: string | null;
45
+ p90_bucket: string | null;
46
+ /** Share of measured items ready in the same minute prep started. */
47
+ instant_percent: number | null;
48
+ on_time_count: number;
49
+ late_count: number;
50
+ promise_baseline_count: number;
51
+ default_baseline_count: number;
52
+ unmeasurable_count: number;
53
+ }
54
+ export interface IFormattedPrepTimeBucket {
55
+ label: string;
56
+ count: number;
57
+ percent: number;
58
+ }
59
+ export interface IFormattedPrepTimePlatformRow {
60
+ platform: string;
61
+ tracked: number;
62
+ own: number;
63
+ avg_minutes: number | null;
64
+ median_bucket: string | null;
65
+ }
66
+ export interface IFormattedPrepTimePageData {
67
+ tenant_ids: string[];
68
+ summary: IFormattedPrepTimeSummary;
69
+ buckets: IFormattedPrepTimeBucket[];
70
+ by_platform: IFormattedPrepTimePlatformRow[];
71
+ late: {
72
+ count: number;
73
+ worst_delta_minutes: number | null;
74
+ } | null;
75
+ weekday: {
76
+ day_index: DAY_INDEX_ENUM;
77
+ tracked: number;
78
+ own: number;
79
+ avg_minutes: number | null;
80
+ }[] | null;
81
+ }
82
+ /**
83
+ * Formats materialized prep time documents into page-ready data - one entry per
84
+ * tenant (`separate_view_per_tenant`) or one combined entry. Returns null on
85
+ * unformattable input; an empty list yields a zero-filled page.
86
+ */
87
+ export declare function getFormattedTenantPrepTimeReporting(reports: IMaterializedTenantPrepTimeReport[], filters?: IFormattedPrepTimeFilters | null, separate_view_per_tenant?: boolean): [IFormattedPrepTimePageData[], null] | null;
88
+ /**
89
+ * Entry point for the AGGREGATED read (one folded record per tenant, computed
90
+ * inside MongoDB). Delegates to the stored-document formatter after restoring the
91
+ * envelope fields it reads, so both paths share one shaping implementation.
92
+ *
93
+ * The folded record spans scope documents, so it has no single `day_index`;
94
+ * `weekday` therefore comes back null and a weekday filter is REFUSED rather than
95
+ * silently ignored (returning every weekday would be a wrong answer).
96
+ */
97
+ export declare function getFormattedTenantPrepTimeAggregatedReporting(reports: any[], filters?: IFormattedPrepTimeFilters | null, separate_view_per_tenant?: boolean): [IFormattedPrepTimePageData[], null] | null;
@@ -0,0 +1,232 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getFormattedTenantPrepTimeReporting = getFormattedTenantPrepTimeReporting;
4
+ exports.getFormattedTenantPrepTimeAggregatedReporting = getFormattedTenantPrepTimeAggregatedReporting;
5
+ const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
6
+ const key_helpers_1 = require("./key-helpers");
7
+ const materialized_prep_time_classification_helpers_1 = require("./materialized-prep-time-classification-helpers");
8
+ const materialized_prep_time_compile_helpers_1 = require("./materialized-prep-time-compile-helpers");
9
+ const toPercent = (part, whole) => (whole > 0 ? Math.round((part / whole) * 1000) / 10 : 0);
10
+ /**
11
+ * Bucket-approximate percentile: the label of the bucket where the cumulative
12
+ * count first reaches the requested share. Percentiles from a histogram are
13
+ * approximate by nature - which is exactly why the UI renders the histogram.
14
+ */
15
+ const percentileBucket = (buckets, share) => {
16
+ const total = buckets.reduce((sum, bucket) => sum + bucket.count, 0);
17
+ if (total <= 0)
18
+ return null;
19
+ const target = total * share;
20
+ let cumulative = 0;
21
+ for (const bucket of buckets) {
22
+ cumulative += bucket.count;
23
+ if (cumulative >= target)
24
+ return bucket.label;
25
+ }
26
+ return buckets[buckets.length - 1]?.label ?? null;
27
+ };
28
+ /** Key -> its two components, so the platform rollup needs no second pass. */
29
+ const splitKey = (key) => {
30
+ const parsed = (0, key_helpers_1.parseMaterializedReportKey)(key);
31
+ const parts = Array.isArray(parsed) ? parsed : null;
32
+ if (parts == null || parts.length < 2)
33
+ return { status: '', platform: '' };
34
+ return { status: String(parts[0]), platform: String(parts[1]) };
35
+ };
36
+ const matchesFilters = (key, filters) => {
37
+ if (filters == null)
38
+ return true;
39
+ const { status, platform } = splitKey(key);
40
+ const platforms = filters.platforms;
41
+ if (platforms != null && platforms.length > 0 && !platforms.includes(platform))
42
+ return false;
43
+ const statuses = filters.order_statuses;
44
+ if (statuses != null && statuses.length > 0 && !statuses.includes(status))
45
+ return false;
46
+ return true;
47
+ };
48
+ const emptySummary = () => ({
49
+ items: 0,
50
+ ready_items: 0,
51
+ tracked_items: 0,
52
+ own_anchor_items: 0,
53
+ coverage_percent: 0,
54
+ own_coverage_percent: 0,
55
+ avg_minutes: null,
56
+ median_bucket: null,
57
+ p90_bucket: null,
58
+ instant_percent: null,
59
+ on_time_count: 0,
60
+ late_count: 0,
61
+ promise_baseline_count: 0,
62
+ default_baseline_count: 0,
63
+ unmeasurable_count: 0,
64
+ });
65
+ const buildBuckets = (counters) => {
66
+ const total = counters.duration.count;
67
+ return MATERIALIZED_REPORTS_1.MATERIALIZED_PREP_TIME_BUCKETS.map((bucket) => {
68
+ const count = counters.duration.buckets[bucket.label] ?? 0;
69
+ return { label: bucket.label, count, percent: toPercent(count, total) };
70
+ });
71
+ };
72
+ const buildSummary = (counters) => {
73
+ const coverage = counters.coverage;
74
+ const duration = counters.duration;
75
+ const promise = counters.promise;
76
+ const buckets = buildBuckets(counters);
77
+ return {
78
+ items: coverage.item_count,
79
+ ready_items: coverage.ready_item_count,
80
+ tracked_items: coverage.tracked_count,
81
+ own_anchor_items: coverage.own_anchor_count,
82
+ coverage_percent: toPercent(coverage.tracked_count, coverage.item_count),
83
+ own_coverage_percent: toPercent(coverage.own_anchor_count, coverage.tracked_count),
84
+ // Exact, from the sum - never derived from the histogram.
85
+ avg_minutes: duration.count > 0 ? Math.round((duration.sum / duration.count) * 10) / 10 : null,
86
+ median_bucket: percentileBucket(buckets, 0.5),
87
+ p90_bucket: percentileBucket(buckets, 0.9),
88
+ instant_percent: duration.count > 0 ? toPercent(duration.instant_count, duration.count) : null,
89
+ on_time_count: promise.on_time_count,
90
+ late_count: promise.late_count,
91
+ promise_baseline_count: promise.promise_set_count,
92
+ default_baseline_count: promise.default_baseline_count,
93
+ unmeasurable_count: promise.no_target_count,
94
+ };
95
+ };
96
+ const emptyPage = (tenantIds) => {
97
+ const counters = (0, materialized_prep_time_classification_helpers_1.freshMaterializedPrepTimeCounters)();
98
+ return {
99
+ tenant_ids: tenantIds,
100
+ summary: emptySummary(),
101
+ buckets: buildBuckets(counters),
102
+ by_platform: [],
103
+ late: null,
104
+ weekday: null,
105
+ };
106
+ };
107
+ const freshGroup = (tenantId) => ({
108
+ tenantId,
109
+ counters: (0, materialized_prep_time_classification_helpers_1.freshMaterializedPrepTimeCounters)(),
110
+ platforms: new Map(),
111
+ weekday: new Map(),
112
+ sawDayIndex: false,
113
+ });
114
+ const addToGroup = (group, doc, filters) => {
115
+ const dayIndexScoped = MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPES_WITH_DAY_INDEX.includes(doc.scope_context);
116
+ const dayIndex = (doc.day_index ?? null);
117
+ if (dayIndexScoped && dayIndex != null)
118
+ group.sawDayIndex = true;
119
+ for (const [key, counters] of Object.entries(doc.prep_time_counters ?? {})) {
120
+ if (!matchesFilters(key, filters))
121
+ continue;
122
+ (0, materialized_prep_time_compile_helpers_1.mergeMaterializedPrepTimeCounters)(group.counters, counters);
123
+ const platform = splitKey(key).platform;
124
+ const platformBucket = group.platforms.get(platform) ?? (0, materialized_prep_time_classification_helpers_1.freshMaterializedPrepTimeCounters)();
125
+ (0, materialized_prep_time_compile_helpers_1.mergeMaterializedPrepTimeCounters)(platformBucket, counters);
126
+ group.platforms.set(platform, platformBucket);
127
+ if (dayIndexScoped && dayIndex != null) {
128
+ const weekBucket = group.weekday.get(dayIndex) ?? (0, materialized_prep_time_classification_helpers_1.freshMaterializedPrepTimeCounters)();
129
+ (0, materialized_prep_time_compile_helpers_1.mergeMaterializedPrepTimeCounters)(weekBucket, counters);
130
+ group.weekday.set(dayIndex, weekBucket);
131
+ }
132
+ }
133
+ };
134
+ const buildPage = (group) => {
135
+ const byPlatform = [...group.platforms.entries()]
136
+ .map(([platform, counters]) => ({
137
+ platform,
138
+ tracked: counters.coverage.tracked_count,
139
+ own: counters.coverage.own_anchor_count,
140
+ avg_minutes: counters.duration.count > 0 ? Math.round((counters.duration.sum / counters.duration.count) * 10) / 10 : null,
141
+ median_bucket: percentileBucket(buildBuckets(counters), 0.5),
142
+ }))
143
+ .sort((a, b) => b.tracked - a.tracked || a.platform.localeCompare(b.platform));
144
+ const weekday = group.sawDayIndex && group.weekday.size > 0
145
+ ? [...group.weekday.entries()]
146
+ .map(([dayIndex, counters]) => ({
147
+ day_index: dayIndex,
148
+ tracked: counters.coverage.tracked_count,
149
+ own: counters.coverage.own_anchor_count,
150
+ avg_minutes: counters.duration.count > 0
151
+ ? Math.round((counters.duration.sum / counters.duration.count) * 10) / 10
152
+ : null,
153
+ }))
154
+ .sort((a, b) => String(a.day_index).localeCompare(String(b.day_index)))
155
+ : null;
156
+ const lateCount = group.counters.late_items.count;
157
+ const worst = group.counters.late_items.worst_delta;
158
+ return {
159
+ tenant_ids: [group.tenantId],
160
+ summary: buildSummary(group.counters),
161
+ buckets: buildBuckets(group.counters),
162
+ by_platform: byPlatform,
163
+ late: lateCount > 0 ? { count: lateCount, worst_delta_minutes: worst } : null,
164
+ weekday,
165
+ };
166
+ };
167
+ /**
168
+ * Formats materialized prep time documents into page-ready data - one entry per
169
+ * tenant (`separate_view_per_tenant`) or one combined entry. Returns null on
170
+ * unformattable input; an empty list yields a zero-filled page.
171
+ */
172
+ function getFormattedTenantPrepTimeReporting(reports, filters = null, separate_view_per_tenant = false) {
173
+ if (!Array.isArray(reports) || reports.some((report) => report == null))
174
+ return null;
175
+ if (reports.length === 0)
176
+ return [[emptyPage([])], null];
177
+ const schemaVersion = reports[0].schema_version;
178
+ const keyFilterSignature = (reports[0].sale_type_key_filters ?? []).join(':');
179
+ for (const report of reports) {
180
+ if ((report.sale_type_key_filters ?? []).join(':') !== keyFilterSignature)
181
+ return null;
182
+ if (report.schema_version !== schemaVersion)
183
+ return null;
184
+ }
185
+ const groups = new Map();
186
+ for (const report of reports) {
187
+ const tenantId = String(report.tenant_id ?? '');
188
+ const key = separate_view_per_tenant ? tenantId : '__combined__';
189
+ const group = groups.get(key) ?? freshGroup(separate_view_per_tenant ? tenantId : '');
190
+ addToGroup(group, report, filters);
191
+ groups.set(key, group);
192
+ }
193
+ const pages = [...groups.values()].map(buildPage);
194
+ if (!separate_view_per_tenant && pages.length === 1) {
195
+ const all = reports.map((report) => String(report.tenant_id ?? ''));
196
+ pages[0].tenant_ids = [...new Set(all)].sort();
197
+ }
198
+ return [pages, null];
199
+ }
200
+ /**
201
+ * Entry point for the AGGREGATED read (one folded record per tenant, computed
202
+ * inside MongoDB). Delegates to the stored-document formatter after restoring the
203
+ * envelope fields it reads, so both paths share one shaping implementation.
204
+ *
205
+ * The folded record spans scope documents, so it has no single `day_index`;
206
+ * `weekday` therefore comes back null and a weekday filter is REFUSED rather than
207
+ * silently ignored (returning every weekday would be a wrong answer).
208
+ */
209
+ function getFormattedTenantPrepTimeAggregatedReporting(reports, filters = null, separate_view_per_tenant = false) {
210
+ if (!Array.isArray(reports) || reports.some((report) => report == null))
211
+ return null;
212
+ if (filters != null && Array.isArray(filters.day_indexes) && filters.day_indexes.length > 0) {
213
+ return null;
214
+ }
215
+ const asStored = reports.map((report) => ({
216
+ _id: String(report.tenant_id) + '|aggregated',
217
+ tenant_id: report.tenant_id,
218
+ brand_id: report.brand_id,
219
+ scope_context: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_MONTH,
220
+ scope_field: report.tenant_id,
221
+ day_index: null,
222
+ sale_type_key_filters: report.sale_type_key_filters,
223
+ prep_time_counters: report.prep_time_counters,
224
+ prep_time_counter_rows: report.prep_time_counter_rows ?? null,
225
+ schema_version: report.schema_version ?? 1,
226
+ source_watermark: report.max_updated_at ?? new Date(0),
227
+ computed_at: report.max_updated_at ?? new Date(0),
228
+ createdAt: report.max_updated_at ?? new Date(0),
229
+ updatedAt: report.max_updated_at ?? new Date(0),
230
+ }));
231
+ return getFormattedTenantPrepTimeReporting(asStored, filters, separate_view_per_tenant);
232
+ }
@@ -0,0 +1,105 @@
1
+ import { SALES_COMPARISON_METRIC_ENUM } from '../../constants/MATERIALIZED_REPORTS';
2
+ import { IMaterializedSalesComparisonCounters } from '../../schemas/types/materialized_tenant_sales_comparison_reports';
3
+ import { IMaterializedTenantSalesComparisonAggregatedReport } from '../types/materialized-reports-apis';
4
+ import type { IMaterializedTenantSalesComparisonReport } from '../../schemas/types/materialized_tenant_sales_comparison_reports';
5
+ /**
6
+ * Sales Comparison formatter — the page-ready shape of `current` vs
7
+ * `comparison` (see `console/admin-panel/docs/report-sales-comparison-concept.md`).
8
+ *
9
+ * ## The comparison is subtracted HERE, never stored
10
+ *
11
+ * A stored document is one period. `current` and `comparison` are two ordinary
12
+ * reads of the same collection; this formatter subtracts them per key. Storing
13
+ * a delta would need one document per (range x baseline) pair — unbounded.
14
+ *
15
+ * ## Ratios are derived, never stored
16
+ *
17
+ * `average_ticket = net_amount / order_count` in the current scope only. A
18
+ * stored ratio cannot be summed across scopes and would produce "average of
19
+ * averages" on any range read.
20
+ *
21
+ * ## Filters are client-side
22
+ *
23
+ * Platform / order-status filters (and the `Select Field` metric switch) apply
24
+ * to the ALREADY-LOADED counters — changing either must not refetch. The
25
+ * formatter exposes every selectable metric at once so the page can switch
26
+ * without recomputing a request.
27
+ *
28
+ * Money is converted from CENTS to decimals here, like every materialized
29
+ * formatter. Returns `null` (never throws) on invalid input.
30
+ */
31
+ export interface IFormattedSalesComparisonFilters {
32
+ platforms?: string[] | null;
33
+ order_statuses?: string[] | null;
34
+ }
35
+ /** Page-ready counters: money in DECIMALS, the rest exact counts. */
36
+ export interface IFormattedSalesComparisonCounters {
37
+ order_count: number;
38
+ gross_amount: number;
39
+ discount_amount: number;
40
+ net_amount: number;
41
+ tax_amount: number;
42
+ service_charge_amount: number;
43
+ tip_amount: number;
44
+ refund_amount: number;
45
+ void_amount: number;
46
+ item_count: number;
47
+ guest_count: number;
48
+ }
49
+ /** How one selectable metric changed from the comparison to the current series. */
50
+ export interface IFormattedSalesComparisonMetric {
51
+ current: number | null;
52
+ comparison: number | null;
53
+ delta: number | null;
54
+ /** `null` when the comparison value is zero / absent (a percent is undefined). */
55
+ delta_percent: number | null;
56
+ }
57
+ export interface IFormattedSalesComparisonSeries {
58
+ counters: IFormattedSalesComparisonCounters;
59
+ /** Derived: `net_amount / order_count`; `null` with no orders. */
60
+ average_ticket: number | null;
61
+ }
62
+ export interface IFormattedSalesComparisonKeyRow {
63
+ key: string;
64
+ order_status: string | null;
65
+ platform: string | null;
66
+ current: IFormattedSalesComparisonSeries;
67
+ comparison: IFormattedSalesComparisonSeries | null;
68
+ metrics: Record<SALES_COMPARISON_METRIC_ENUM, IFormattedSalesComparisonMetric>;
69
+ }
70
+ export interface IFormattedSalesComparisonPlatformRow {
71
+ platform: string;
72
+ current: IFormattedSalesComparisonSeries;
73
+ comparison: IFormattedSalesComparisonSeries | null;
74
+ metrics: Record<SALES_COMPARISON_METRIC_ENUM, IFormattedSalesComparisonMetric>;
75
+ }
76
+ export interface IFormattedSalesComparisonPageData {
77
+ tenant_ids: string[];
78
+ filters: {
79
+ platforms: string[] | null;
80
+ order_statuses: string[] | null;
81
+ };
82
+ current: IFormattedSalesComparisonSeries;
83
+ /** `null` for `baseline: NONE`; a zeroed series when the baseline had no sales. */
84
+ comparison: IFormattedSalesComparisonSeries | null;
85
+ metrics: Record<SALES_COMPARISON_METRIC_ENUM, IFormattedSalesComparisonMetric>;
86
+ /** Cancelled orders are split out of every total, exactly like the overview. */
87
+ cancelled: IFormattedSalesComparisonSeries;
88
+ rows: IFormattedSalesComparisonKeyRow[];
89
+ by_platform: IFormattedSalesComparisonPlatformRow[];
90
+ /** EXACT count of stored scope documents folded into the current series. */
91
+ matched_documents: number;
92
+ }
93
+ type TSalesComparisonDocument = IMaterializedTenantSalesComparisonAggregatedReport | IMaterializedTenantSalesComparisonReport;
94
+ export declare const formatSalesComparisonSeries: (counters: IMaterializedSalesComparisonCounters | null | undefined) => IFormattedSalesComparisonSeries;
95
+ export declare function buildSalesComparisonMetrics(current: IFormattedSalesComparisonSeries, comparison: IFormattedSalesComparisonSeries | null): Record<SALES_COMPARISON_METRIC_ENUM, IFormattedSalesComparisonMetric>;
96
+ /**
97
+ * Page-ready Sales Comparison data.
98
+ *
99
+ * `currentDocs` are the current series' aggregated records; `comparisonDocs`
100
+ * are the baseline series' records (`null` for `baseline: NONE`, `[]` for a
101
+ * valid baseline with no sales). Changing filters or the selected metric
102
+ * re-derives from the SAME docs — no refetch.
103
+ */
104
+ export declare function getFormattedTenantSalesComparisonReporting(currentDocs: TSalesComparisonDocument[] | null | undefined, comparisonDocs: TSalesComparisonDocument[] | null | undefined, filters?: IFormattedSalesComparisonFilters | null, separate_view_per_tenant?: boolean): [IFormattedSalesComparisonPageData[], null] | null;
105
+ export {};