@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,130 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_PREP_TIME_ANCHORS, ALL_MATERIALIZED_PREP_TIME_TARGETS, ALL_MATERIALIZED_REPORT_KEY_FILTERS, MATERIALIZED_PREP_TIME_REPORT_SCOPES, PREP_TIME_KEY_FILTERS, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_prep_time_entries` - the ITEMIZED prep
6
+ * rows behind the prep time report's drill-down (owner decision (a2): SPLIT).
7
+ * See `schemas/types/materialized_tenant_prep_time_entries.ts` and
8
+ * `docs/report-prep-time-concept.md`.
9
+ *
10
+ * Scopes are capped at `LOCAL_MONTH` so a document can never grow unboundedly.
11
+ * Rows are slim; each carries `entry_key`, its stable identity INSIDE an order,
12
+ * so the `(time, order_id, entry_key)` cursor can never collide.
13
+ *
14
+ * Rows are ALSO the only place a fallback-anchored item can be inspected, so
15
+ * each row states its `anchor` - a degenerate 0-minute fallback row is visibly
16
+ * different from a genuinely instant measured one.
17
+ */
18
+ /**
19
+ * Version of the prep time ENTRY rules of this collection. Bump when row
20
+ * semantics change (new fields, different identity, different duration rule) -
21
+ * historical documents must then be re-materialized. PRE-RELEASE: folds into
22
+ * version `1`.
23
+ */
24
+ export const MATERIALIZED_TENANT_PREP_TIME_ENTRIES_SCHEMA_VERSION = 1;
25
+ const PrepTimeEntrySchema = new Schema({
26
+ entry_key: { type: String, required: true },
27
+ order_id: { type: String, required: true },
28
+ order_number: { type: Number, default: null },
29
+ item_id: { type: String, default: null },
30
+ item_name: { type: String, default: null },
31
+ category_name: { type: String, default: null },
32
+ // ---- measurement ----
33
+ anchor: { type: String, required: true, enum: ALL_MATERIALIZED_PREP_TIME_ANCHORS },
34
+ duration_minutes: { type: Number, default: null },
35
+ prep_started_at: { type: Schema.Types.Date, default: null },
36
+ // Reconstructed (= prep_started_at + ready_minutes), MEASURED rows only.
37
+ ready_at: { type: Schema.Types.Date, default: null },
38
+ is_ready: { type: Boolean, required: true, default: false },
39
+ // ---- promise ----
40
+ target_at: { type: Schema.Types.Date, default: null },
41
+ target_source: {
42
+ type: String,
43
+ default: null,
44
+ enum: [...ALL_MATERIALIZED_PREP_TIME_TARGETS, null],
45
+ },
46
+ // SIGNED: positive means the item was ready AFTER its target.
47
+ delta_minutes: { type: Number, default: null },
48
+ // ---- attribution ----
49
+ staff_id: { type: String, default: null },
50
+ staff_name: { type: String, default: null },
51
+ order_status: { type: String, required: true, default: '' },
52
+ platform: { type: String, required: true, default: '' },
53
+ created_at: { type: Schema.Types.Date, required: true },
54
+ local_hour: { type: String, default: null },
55
+ }, { _id: false });
56
+ export { PrepTimeEntrySchema };
57
+ export const MaterializedTenantPrepTimeEntriesSchema = new Schema({
58
+ tenant_id: { type: String, required: true },
59
+ brand_id: { type: String, required: true },
60
+ scope_context: {
61
+ type: String,
62
+ required: true,
63
+ enum: MATERIALIZED_PREP_TIME_REPORT_SCOPES,
64
+ },
65
+ scope_field: { type: String, required: true },
66
+ day_index: {
67
+ type: String,
68
+ default: null,
69
+ enum: [...ALL_DAY_INDEX, null],
70
+ },
71
+ sale_type_key_filters: {
72
+ type: [String],
73
+ required: true,
74
+ default: () => [...PREP_TIME_KEY_FILTERS],
75
+ validate: {
76
+ validator: (value) => value.length > 0 &&
77
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
78
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
79
+ },
80
+ },
81
+ // { [sale_type_key]: { rows: [...] } } - pruned when a key has no rows.
82
+ prep_time_entries: {
83
+ type: Schema.Types.Mixed,
84
+ required: true,
85
+ default: null,
86
+ },
87
+ iteration: { type: Number, required: true, min: 1, default: 1 },
88
+ schema_version: {
89
+ type: Number,
90
+ required: true,
91
+ immutable: true,
92
+ default: MATERIALIZED_TENANT_PREP_TIME_ENTRIES_SCHEMA_VERSION,
93
+ },
94
+ source_watermark: { type: Schema.Types.Date, required: true },
95
+ computed_at: { type: Schema.Types.Date, required: true },
96
+ createdAt: {
97
+ type: Schema.Types.Date,
98
+ required: true,
99
+ default: () => new Date(),
100
+ immutable: true,
101
+ },
102
+ updatedAt: {
103
+ type: Schema.Types.Date,
104
+ required: true,
105
+ default: () => new Date(),
106
+ },
107
+ }, { timestamps: true, versionKey: false, minimize: false });
108
+ export const MATERIALIZED_TENANT_PREP_TIME_ENTRIES_COLLECTION_NAME = 'materialized_tenant_prep_time_entries';
109
+ /**
110
+ * Indexes for `materialized_tenant_prep_time_entries` - the same single UNIQUE
111
+ * compound identity index as every materialized report collection. The
112
+ * `{ tenant_id, scope_context, scope_field }` prefix also serves the
113
+ * drill-down's month-document resolution.
114
+ */
115
+ export const MATERIALIZED_TENANT_PREP_TIME_ENTRIES_COLLECTION_INDEXES = {
116
+ _id: { _id: 1 },
117
+ tenant_id__scope_context__scope_field__day_index: {
118
+ tenant_id: 1,
119
+ scope_context: 1,
120
+ scope_field: 1,
121
+ day_index: 1,
122
+ },
123
+ };
124
+ export const MATERIALIZED_TENANT_PREP_TIME_ENTRIES_INDEX_OPTIONS = [
125
+ {
126
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
127
+ name: 'tenant_id__scope_context__scope_field__day_index',
128
+ unique: true,
129
+ },
130
+ ];
@@ -0,0 +1,109 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, MATERIALIZED_PREP_TIME_REPORT_SCOPES, PREP_TIME_KEY_FILTERS, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_prep_time_reports` (M2).
6
+ *
7
+ * Counters ONLY - the itemized rows live in the SIBLING entries collection
8
+ * (`materialized_tenant_prep_time_entries`, owner decision (a2)). See
9
+ * `schemas/types/materialized_tenant_prep_time_reports.ts` and
10
+ * `docs/report-prep-time-concept.md`.
11
+ *
12
+ * The counters are stored TWICE on purpose: a key-addressed MAP
13
+ * (`prep_time_counters`, the store + formatter shape) and the SAME counters as
14
+ * an ARRAY OF ROWS (`prep_time_counter_rows`, the READ shape). Summing the map
15
+ * inside an aggregation needs nested `$getField` calls (a dotted field name
16
+ * silently matches nothing), `$literal` around every computed field name and an
17
+ * `$arrayToObject` rebuild; with rows the read is the canonical `$unwind` ->
18
+ * `$group` -> direct `$sum` pattern. Both are written from one accumulator pass,
19
+ * so they cannot disagree.
20
+ */
21
+ /**
22
+ * Version of the prep time report COUNTER rules. Bump when counter semantics
23
+ * change (new buckets, a different anchor rule) - historical documents must then
24
+ * be re-materialized. PRE-RELEASE: folds into version `1`.
25
+ */
26
+ export const MATERIALIZED_TENANT_PREP_TIME_REPORTS_SCHEMA_VERSION = 1;
27
+ export const MaterializedTenantPrepTimeReportSchema = new Schema({
28
+ tenant_id: { type: String, required: true },
29
+ brand_id: { type: String, required: true },
30
+ scope_context: {
31
+ type: String,
32
+ required: true,
33
+ enum: MATERIALIZED_PREP_TIME_REPORT_SCOPES,
34
+ },
35
+ scope_field: { type: String, required: true },
36
+ day_index: {
37
+ type: String,
38
+ default: null,
39
+ enum: [...ALL_DAY_INDEX, null],
40
+ },
41
+ sale_type_key_filters: {
42
+ type: [String],
43
+ required: true,
44
+ default: () => [...PREP_TIME_KEY_FILTERS],
45
+ validate: {
46
+ validator: (value) => value.length > 0 &&
47
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
48
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
49
+ },
50
+ },
51
+ // { [sale_type_key]: counters } - pruned per key; never an empty map.
52
+ prep_time_counters: {
53
+ type: Schema.Types.Mixed,
54
+ required: true,
55
+ default: null,
56
+ },
57
+ // The SAME counters as [{ key, counters }] - the read-path shape.
58
+ prep_time_counter_rows: {
59
+ type: Schema.Types.Mixed,
60
+ required: true,
61
+ default: null,
62
+ },
63
+ iteration: { type: Number, required: true, min: 1, default: 1 },
64
+ schema_version: {
65
+ type: Number,
66
+ required: true,
67
+ immutable: true,
68
+ default: MATERIALIZED_TENANT_PREP_TIME_REPORTS_SCHEMA_VERSION,
69
+ },
70
+ source_watermark: { type: Schema.Types.Date, required: true },
71
+ computed_at: { type: Schema.Types.Date, required: true },
72
+ createdAt: {
73
+ type: Schema.Types.Date,
74
+ required: true,
75
+ default: () => new Date(),
76
+ immutable: true,
77
+ },
78
+ updatedAt: {
79
+ type: Schema.Types.Date,
80
+ required: true,
81
+ default: () => new Date(),
82
+ },
83
+ }, { timestamps: true, versionKey: false, minimize: false });
84
+ export const MATERIALIZED_TENANT_PREP_TIME_REPORTS_COLLECTION_NAME = 'materialized_tenant_prep_time_reports';
85
+ /**
86
+ * Indexes for `materialized_tenant_prep_time_reports` - the same single UNIQUE
87
+ * compound identity index as every materialized report collection. It serves the
88
+ * close-day identity upserts AND the read: the read pipeline's TOP-LEVEL `$match`
89
+ * gates on exactly this prefix, with equality or `$in` on the scope values.
90
+ *
91
+ * No `brand_id` index: a brand's tenants are resolved before the read, so
92
+ * `tenant_id` is always the leading key.
93
+ */
94
+ export const MATERIALIZED_TENANT_PREP_TIME_REPORTS_COLLECTION_INDEXES = {
95
+ _id: { _id: 1 },
96
+ tenant_id__scope_context__scope_field__day_index: {
97
+ tenant_id: 1,
98
+ scope_context: 1,
99
+ scope_field: 1,
100
+ day_index: 1,
101
+ },
102
+ };
103
+ export const MATERIALIZED_TENANT_PREP_TIME_REPORTS_INDEX_OPTIONS = [
104
+ {
105
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
106
+ name: 'tenant_id__scope_context__scope_field__day_index',
107
+ unique: true,
108
+ },
109
+ ];
@@ -0,0 +1,130 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, MATERIALIZED_SALES_COMPARISON_REPORT_SCOPES, MATERIALIZED_TENANT_SALES_COMPARISON_ENTRIES_SCHEMA_VERSION, SALES_COMPARISON_KEY_FILTERS, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_sales_comparison_entries` — the
6
+ * ITEMIZED order rows behind the Sales Comparison drill-down.
7
+ *
8
+ * ORDER ROWS ONLY. Sales Comparison and Payments Comparison are different
9
+ * reports: a payment row here would double-count a split payment. Each row is
10
+ * one order, identified by `order_id` — a period document is a fold of its
11
+ * days, so de-duplicating by `order_id` is exact.
12
+ *
13
+ * Rows are slim (ids + money facts); the order document stays the source of
14
+ * truth. Amounts are CENTS; reads pin `schema_version`.
15
+ */
16
+ /** Version of the entry rules of this collection (bump + re-materialize on change). */
17
+ export { MATERIALIZED_TENANT_SALES_COMPARISON_ENTRIES_SCHEMA_VERSION };
18
+ const SalesComparisonEntrySchema = new Schema({
19
+ order_id: { type: String, required: true },
20
+ order_number: { type: Number, default: null },
21
+ /** Tenant-local settled instant, ISO — the drill-down cursor anchor. */
22
+ time: { type: String, required: true },
23
+ order_status: { type: String, required: true },
24
+ platform: { type: String, required: true },
25
+ /** CENTS. */
26
+ net_amount: { type: Number, required: true, default: 0 },
27
+ discount_amount: { type: Number, required: true, default: 0 },
28
+ item_count: { type: Number, required: true, default: 0, min: 0 },
29
+ }, { _id: false });
30
+ export const MaterializedTenantSalesComparisonEntriesSchema = new Schema({
31
+ _id: {
32
+ type: Schema.Types.ObjectId,
33
+ required: true,
34
+ immutable: true,
35
+ },
36
+ tenant_id: {
37
+ type: String,
38
+ required: true,
39
+ },
40
+ brand_id: {
41
+ type: String,
42
+ required: true,
43
+ },
44
+ scope_context: {
45
+ type: String,
46
+ required: true,
47
+ enum: MATERIALIZED_SALES_COMPARISON_REPORT_SCOPES,
48
+ },
49
+ scope_field: {
50
+ type: String,
51
+ required: true,
52
+ },
53
+ day_index: {
54
+ type: String,
55
+ default: null,
56
+ enum: [...ALL_DAY_INDEX, null],
57
+ },
58
+ sale_type_key_filters: {
59
+ type: [String],
60
+ required: true,
61
+ default: () => [...SALES_COMPARISON_KEY_FILTERS],
62
+ validate: {
63
+ validator: (value) => value.length > 0 &&
64
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
65
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
66
+ },
67
+ },
68
+ // { [key]: { rows: [...] } } — pruned when a key has no rows.
69
+ sales_entries: {
70
+ type: Schema.Types.Mixed,
71
+ required: true,
72
+ default: null,
73
+ },
74
+ iteration: {
75
+ type: Number,
76
+ required: true,
77
+ min: 1,
78
+ default: 1,
79
+ },
80
+ schema_version: {
81
+ type: Number,
82
+ required: true,
83
+ immutable: true,
84
+ default: MATERIALIZED_TENANT_SALES_COMPARISON_ENTRIES_SCHEMA_VERSION,
85
+ },
86
+ source_watermark: {
87
+ type: Schema.Types.Date,
88
+ required: true,
89
+ },
90
+ computed_at: {
91
+ type: Schema.Types.Date,
92
+ required: true,
93
+ },
94
+ createdAt: {
95
+ type: Schema.Types.Date,
96
+ required: true,
97
+ default: () => new Date(),
98
+ immutable: true,
99
+ },
100
+ updatedAt: {
101
+ type: Schema.Types.Date,
102
+ required: true,
103
+ default: () => new Date(),
104
+ },
105
+ }, {
106
+ timestamps: true,
107
+ versionKey: false,
108
+ minimize: false,
109
+ });
110
+ export { SalesComparisonEntrySchema };
111
+ /**
112
+ * Indexes for `materialized_tenant_sales_comparison_entries` — the same ONE
113
+ * unique compound identity/read index as every other materialized report.
114
+ */
115
+ export const MATERIALIZED_TENANT_SALES_COMPARISON_ENTRIES_COLLECTION_INDEXES = {
116
+ _id: { _id: 1 },
117
+ tenant_id__scope_context__scope_field__day_index: {
118
+ tenant_id: 1,
119
+ scope_context: 1,
120
+ scope_field: 1,
121
+ day_index: 1,
122
+ },
123
+ };
124
+ export const MATERIALIZED_TENANT_SALES_COMPARISON_ENTRIES_INDEX_OPTIONS = [
125
+ {
126
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
127
+ name: 'tenant_id__scope_context__scope_field__day_index',
128
+ unique: true,
129
+ },
130
+ ];
@@ -0,0 +1,154 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, MATERIALIZED_SALES_COMPARISON_REPORT_SCOPES, MATERIALIZED_TENANT_SALES_COMPARISON_REPORTS_SCHEMA_VERSION, SALES_COMPARISON_KEY_FILTERS, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_sales_comparison_reports` — the
6
+ * COUNTERS of the Sales Comparison report (see
7
+ * `schemas/types/materialized_tenant_sales_comparison_reports.ts` and
8
+ * `console/admin-panel/docs/report-sales-comparison-concept.md`).
9
+ *
10
+ * One document is ONE period's truth: the comparison is NEVER stored. `current`
11
+ * and `comparison` are two ordinary reads of this collection, subtracted in the
12
+ * toolkit formatter, because the pairing is chosen at read time and would need
13
+ * one document per (range x baseline) pair if it were pre-computed.
14
+ *
15
+ * Scopes: date / week / month / quarter / semester / year. NO hour scope (this
16
+ * is not the hourly report) and NO ISO week (owner decision).
17
+ *
18
+ * Amounts are CENTS. The counters are stored TWICE on purpose: the
19
+ * key-addressed MAP is what the formatter and the close-day plan read, and the
20
+ * ROW ARRAY is what the read path `$unwind`s and `$sum`s (a `$facet` cannot
21
+ * walk a map). They must always agree — `verify:demo-data` asserts it.
22
+ */
23
+ /** Version of the counter rules of this collection (bump + re-materialize on change). */
24
+ export { MATERIALIZED_TENANT_SALES_COMPARISON_REPORTS_SCHEMA_VERSION };
25
+ /** One key's counters — every field defaulted so a partial write cannot null a counter. */
26
+ const SalesComparisonCountersSchema = new Schema({
27
+ order_count: { type: Number, required: true, default: 0, min: 0 },
28
+ gross_amount: { type: Number, required: true, default: 0 },
29
+ discount_amount: { type: Number, required: true, default: 0 },
30
+ net_amount: { type: Number, required: true, default: 0 },
31
+ tax_amount: { type: Number, required: true, default: 0 },
32
+ service_charge_amount: { type: Number, required: true, default: 0 },
33
+ tip_amount: { type: Number, required: true, default: 0 },
34
+ refund_amount: { type: Number, required: true, default: 0 },
35
+ void_amount: { type: Number, required: true, default: 0 },
36
+ item_count: { type: Number, required: true, default: 0, min: 0 },
37
+ guest_count: { type: Number, required: true, default: 0, min: 0 },
38
+ }, { _id: false });
39
+ export const MaterializedTenantSalesComparisonReportSchema = new Schema({
40
+ _id: {
41
+ type: Schema.Types.ObjectId,
42
+ required: true,
43
+ immutable: true,
44
+ },
45
+ tenant_id: {
46
+ type: String,
47
+ required: true,
48
+ },
49
+ brand_id: {
50
+ type: String,
51
+ required: true,
52
+ },
53
+ scope_context: {
54
+ type: String,
55
+ required: true,
56
+ enum: MATERIALIZED_SALES_COMPARISON_REPORT_SCOPES,
57
+ },
58
+ scope_field: {
59
+ type: String,
60
+ required: true,
61
+ },
62
+ day_index: {
63
+ type: String,
64
+ default: null,
65
+ enum: [...ALL_DAY_INDEX, null],
66
+ },
67
+ sale_type_key_filters: {
68
+ type: [String],
69
+ required: true,
70
+ default: () => [...SALES_COMPARISON_KEY_FILTERS],
71
+ validate: {
72
+ validator: (value) => value.length > 0 &&
73
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
74
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
75
+ },
76
+ },
77
+ // Key-addressed counters (formatter / close-day reads). Null on an order-less
78
+ // day is never written: the day document itself is dropped instead.
79
+ sales_counters: {
80
+ type: Schema.Types.Mixed,
81
+ required: true,
82
+ default: null,
83
+ },
84
+ // The SAME counters as rows — the read-path shape.
85
+ sales_counter_rows: {
86
+ type: Schema.Types.Mixed,
87
+ required: true,
88
+ default: null,
89
+ },
90
+ iteration: {
91
+ type: Number,
92
+ required: true,
93
+ min: 1,
94
+ default: 1,
95
+ },
96
+ schema_version: {
97
+ type: Number,
98
+ required: true,
99
+ immutable: true,
100
+ default: MATERIALIZED_TENANT_SALES_COMPARISON_REPORTS_SCHEMA_VERSION,
101
+ },
102
+ source_watermark: {
103
+ type: Schema.Types.Date,
104
+ required: true,
105
+ },
106
+ computed_at: {
107
+ type: Schema.Types.Date,
108
+ required: true,
109
+ },
110
+ createdAt: {
111
+ type: Schema.Types.Date,
112
+ required: true,
113
+ default: () => new Date(),
114
+ immutable: true,
115
+ },
116
+ updatedAt: {
117
+ type: Schema.Types.Date,
118
+ required: true,
119
+ default: () => new Date(),
120
+ },
121
+ }, {
122
+ timestamps: true,
123
+ versionKey: false,
124
+ minimize: false,
125
+ });
126
+ export { SalesComparisonCountersSchema };
127
+ /**
128
+ * Indexes for `materialized_tenant_sales_comparison_reports` — ONE compound
129
+ * index carries the whole read story (plus `_id`), identical in shape to every
130
+ * other materialized report collection:
131
+ * `tenant_id__scope_context__scope_field__day_index` — UNIQUE:
132
+ * - identity — one document per (tenant, scope context, scope value);
133
+ * - the read — the `{ tenant_id, scope_context, scope_field }` prefix serves
134
+ * exact and ranged scope-field queries for single tenants and `$in` lists.
135
+ *
136
+ * There are NO `brand_id` indexes: brand-level reads always pass the brand's
137
+ * explicit tenant list (`tenant_id: { $in }`).
138
+ */
139
+ export const MATERIALIZED_TENANT_SALES_COMPARISON_REPORTS_COLLECTION_INDEXES = {
140
+ _id: { _id: 1 },
141
+ tenant_id__scope_context__scope_field__day_index: {
142
+ tenant_id: 1,
143
+ scope_context: 1,
144
+ scope_field: 1,
145
+ day_index: 1,
146
+ },
147
+ };
148
+ export const MATERIALIZED_TENANT_SALES_COMPARISON_REPORTS_INDEX_OPTIONS = [
149
+ {
150
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
151
+ name: 'tenant_id__scope_context__scope_field__day_index',
152
+ unique: true,
153
+ },
154
+ ];
@@ -32,6 +32,15 @@ export * from './item_transactions';
32
32
  export * from './items';
33
33
  export * from './marketing_fingerprints';
34
34
  export * from './materialized_credit_bills';
35
+ export * from './materialized_tenant_discount_entries';
36
+ export * from './materialized_tenant_discount_reports';
37
+ export * from './materialized_tenant_cash_entries';
38
+ export * from './materialized_tenant_delivery_entries';
39
+ export * from './materialized_tenant_delivery_reports';
40
+ export * from './materialized_rider_daily_reports';
41
+ export * from './materialized_tenant_cash_reports';
42
+ export * from './materialized_tenant_prep_time_entries';
43
+ export * from './materialized_tenant_prep_time_reports';
35
44
  export * from './materialized_tenant_reports_iterations';
36
45
  export * from './materialized_tenant_sales_overview_reports';
37
46
  export * from './menus';
@@ -114,3 +123,9 @@ export * from './warehouse_vendors';
114
123
  export * from './warehouse_void_purchase_order_items';
115
124
  export * from './warehouse_void_sale_order_items';
116
125
  export * from './warehouses';
126
+ export * from './materialized_tenant_sales_comparison_reports';
127
+ export * from './materialized_tenant_sales_comparison_entries';
128
+ export * from './materialized_tenant_hourly_comparison_reports';
129
+ export * from './materialized_tenant_hourly_comparison_entries';
130
+ export * from './materialized_tenant_payments_comparison_reports';
131
+ export * from './materialized_tenant_payments_comparison_entries';
@@ -0,0 +1,2 @@
1
+ export {};
2
+ /** Cap of `top_sources` — a bounded display helper, never a totals input. */
@@ -0,0 +1,11 @@
1
+ /** Every additive counter, in display order. Ratios are derived, never listed. */
2
+ export const ALL_MATERIALIZED_PAYMENTS_COMPARISON_COUNTERS = [
3
+ 'payment_count',
4
+ 'payment_amount',
5
+ 'amount_due',
6
+ 'amount_paid',
7
+ 'amount_refunded',
8
+ 'card_charges',
9
+ 'refund_count',
10
+ 'unpaid_count',
11
+ ];
@@ -0,0 +1,14 @@
1
+ /** Every additive counter, in display order. Ratios are derived, never listed here. */
2
+ export const ALL_MATERIALIZED_SALES_COMPARISON_COUNTERS = [
3
+ 'order_count',
4
+ 'gross_amount',
5
+ 'discount_amount',
6
+ 'net_amount',
7
+ 'tax_amount',
8
+ 'service_charge_amount',
9
+ 'tip_amount',
10
+ 'refund_amount',
11
+ 'void_amount',
12
+ 'item_count',
13
+ 'guest_count',
14
+ ];