@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,333 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_DISCOUNT_SLOTS, ALL_MATERIALIZED_DISCOUNT_SUB_KINDS, ALL_MATERIALIZED_REPORT_KEY_FILTERS, DISCOUNTS_KEY_FILTERS, MATERIALIZED_DISCOUNT_REPORT_SCOPES, MATERIALIZED_DISCOUNT_SOURCE_LIMIT, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_discount_reports` — the COUNTERS of
6
+ * the discounts report (M1). See
7
+ * `schemas/types/materialized_tenant_discount_reports.ts` for the counter
8
+ * contract and the raw-vs-resolved amount rule, and
9
+ * `docs/report-discounts-concept.md` for the taxonomy.
10
+ *
11
+ * The documents are COUNTERS ONLY: the itemized rows live in the sibling
12
+ * `materialized_tenant_discount_entries` collection (owner decision (a) —
13
+ * SPLIT, mirroring the credit-bill ledger). Scopes are capped at `LOCAL_MONTH`
14
+ * so no document grows unboundedly. Amounts are CENTS; reads pin
15
+ * `schema_version`.
16
+ */
17
+ /**
18
+ * Version of the discount counter rules of this collection. Bump when the
19
+ * counting semantics change (new sub-kinds, resolution-rule changes, key
20
+ * grammar changes) — historical documents must then be re-materialized.
21
+ * PRE-RELEASE: no live tenants/consumers yet, so every change so far folds into
22
+ * version `1`.
23
+ */
24
+ export const MATERIALIZED_TENANT_DISCOUNT_REPORTS_SCHEMA_VERSION = 1;
25
+ /** Shared shape of every slot counter: count + raw amount + resolved money. */
26
+ const DiscountSlotCounterSchema = new Schema({
27
+ count: { type: Number, required: true, default: 0, min: 0 },
28
+ amount: { type: Number, required: true, default: 0 },
29
+ resolved_amount: { type: Number, required: true, default: 0 },
30
+ }, { _id: false });
31
+ const ItemSpecialCounterSchema = new Schema({
32
+ count: { type: Number, required: true, default: 0, min: 0 },
33
+ amount: { type: Number, required: true, default: 0 },
34
+ resolved_amount: { type: Number, required: true, default: 0 },
35
+ collection_count: { type: Number, required: true, default: 0, min: 0 },
36
+ collection_amount: { type: Number, required: true, default: 0 },
37
+ collection_resolved_amount: { type: Number, required: true, default: 0 },
38
+ manual_count: { type: Number, required: true, default: 0, min: 0 },
39
+ manual_amount: { type: Number, required: true, default: 0 },
40
+ manual_resolved_amount: { type: Number, required: true, default: 0 },
41
+ price_override_count: { type: Number, required: true, default: 0, min: 0 },
42
+ price_override_amount: { type: Number, required: true, default: 0 },
43
+ price_override_resolved_amount: { type: Number, required: true, default: 0 },
44
+ catalog_item_count: { type: Number, required: true, default: 0, min: 0 },
45
+ catalog_item_amount: { type: Number, required: true, default: 0 },
46
+ catalog_item_resolved_amount: { type: Number, required: true, default: 0 },
47
+ other_count: { type: Number, required: true, default: 0, min: 0 },
48
+ other_amount: { type: Number, required: true, default: 0 },
49
+ other_resolved_amount: { type: Number, required: true, default: 0 },
50
+ }, { _id: false });
51
+ const ItemLoyaltyCounterSchema = new Schema({
52
+ count: { type: Number, required: true, default: 0, min: 0 },
53
+ amount: { type: Number, required: true, default: 0 },
54
+ resolved_amount: { type: Number, required: true, default: 0 },
55
+ offer_count: { type: Number, required: true, default: 0, min: 0 },
56
+ offer_amount: { type: Number, required: true, default: 0 },
57
+ offer_resolved_amount: { type: Number, required: true, default: 0 },
58
+ gift_card_count: { type: Number, required: true, default: 0, min: 0 },
59
+ gift_card_amount: { type: Number, required: true, default: 0 },
60
+ gift_card_resolved_amount: { type: Number, required: true, default: 0 },
61
+ wallet_count: { type: Number, required: true, default: 0, min: 0 },
62
+ wallet_amount: { type: Number, required: true, default: 0 },
63
+ wallet_resolved_amount: { type: Number, required: true, default: 0 },
64
+ other_count: { type: Number, required: true, default: 0, min: 0 },
65
+ other_amount: { type: Number, required: true, default: 0 },
66
+ other_resolved_amount: { type: Number, required: true, default: 0 },
67
+ }, { _id: false });
68
+ const ItemVoucherCounterSchema = new Schema({
69
+ count: { type: Number, required: true, default: 0, min: 0 },
70
+ amount: { type: Number, required: true, default: 0 },
71
+ resolved_amount: { type: Number, required: true, default: 0 },
72
+ ref_count: { type: Number, required: true, default: 0, min: 0 },
73
+ offer_count: { type: Number, required: true, default: 0, min: 0 },
74
+ offer_amount: { type: Number, required: true, default: 0 },
75
+ offer_resolved_amount: { type: Number, required: true, default: 0 },
76
+ }, { _id: false });
77
+ /** One key's counters — every field defaulted so a partial write cannot null a slot. */
78
+ const DiscountOrderCountersSchema = new Schema({
79
+ count: { type: Number, required: true, default: 0, min: 0 },
80
+ amount: { type: Number, required: true, default: 0 },
81
+ order_level_amount: { type: Number, required: true, default: 0 },
82
+ item_level_amount: { type: Number, required: true, default: 0 },
83
+ item_discount_count: { type: Number, required: true, default: 0, min: 0 },
84
+ unattributed_amount: { type: Number, required: true, default: 0 },
85
+ order_special: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
86
+ order_loyalty: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
87
+ order_voucher: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
88
+ special_collection: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
89
+ special_manual: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
90
+ special_price_override: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
91
+ special_catalog_item: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
92
+ special_other: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
93
+ loyalty_offer: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
94
+ loyalty_gift_card: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
95
+ loyalty_wallet: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
96
+ loyalty_other: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
97
+ voucher_offer: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
98
+ voucher_other: { type: DiscountSlotCounterSchema, required: true, default: () => ({}) },
99
+ item_special: { type: ItemSpecialCounterSchema, required: true, default: () => ({}) },
100
+ item_loyalty: { type: ItemLoyaltyCounterSchema, required: true, default: () => ({}) },
101
+ item_voucher: { type: ItemVoucherCounterSchema, required: true, default: () => ({}) },
102
+ free_items: {
103
+ type: new Schema({
104
+ count: { type: Number, required: true, default: 0, min: 0 },
105
+ amount: { type: Number, required: true, default: 0 },
106
+ resolved_amount: { type: Number, required: true, default: 0 },
107
+ value: { type: Number, required: true, default: 0 },
108
+ }, { _id: false }),
109
+ required: true,
110
+ default: () => ({}),
111
+ },
112
+ complimentary: {
113
+ type: new Schema({
114
+ payment_count: { type: Number, required: true, default: 0, min: 0 },
115
+ amount: { type: Number, required: true, default: 0 },
116
+ note_count: { type: Number, required: true, default: 0, min: 0 },
117
+ }, { _id: false }),
118
+ required: true,
119
+ default: () => ({}),
120
+ },
121
+ }, { _id: false });
122
+ const DiscountSourceCounterSchema = new Schema({
123
+ sub_kind: { type: String, required: true, enum: ALL_MATERIALIZED_DISCOUNT_SUB_KINDS },
124
+ slot: { type: String, default: null, enum: [...ALL_MATERIALIZED_DISCOUNT_SLOTS, null] },
125
+ count: { type: Number, required: true, default: 0, min: 0 },
126
+ amount: { type: Number, required: true, default: 0 },
127
+ resolved_amount: { type: Number, required: true, default: 0 },
128
+ }, { _id: false });
129
+ export const MaterializedTenantDiscountReportSchema = new Schema({
130
+ _id: {
131
+ type: Schema.Types.ObjectId,
132
+ required: true,
133
+ immutable: true,
134
+ },
135
+ tenant_id: {
136
+ type: String,
137
+ required: true,
138
+ },
139
+ brand_id: {
140
+ type: String,
141
+ required: true,
142
+ },
143
+ scope_context: {
144
+ type: String,
145
+ required: true,
146
+ enum: MATERIALIZED_DISCOUNT_REPORT_SCOPES,
147
+ },
148
+ scope_field: {
149
+ type: String,
150
+ required: true,
151
+ },
152
+ day_index: {
153
+ type: String,
154
+ default: null,
155
+ enum: [...ALL_DAY_INDEX, null],
156
+ },
157
+ sale_type_key_filters: {
158
+ type: [String],
159
+ required: true,
160
+ default: () => [...DISCOUNTS_KEY_FILTERS],
161
+ validate: {
162
+ validator: (value) => value.length > 0 &&
163
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
164
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
165
+ },
166
+ },
167
+ // Counters only — the itemized rows live in
168
+ // `materialized_tenant_discount_entries`. Empty map = a day with no
169
+ // discounts (kept so watermark comparisons stay uniform).
170
+ discount_counters: {
171
+ type: Schema.Types.Mixed,
172
+ required: true,
173
+ default: null,
174
+ },
175
+ // The SAME counters as an ARRAY OF ROWS — the read-path shape (see the type
176
+ // module). Mixed because the counter tree varies per key.
177
+ discount_counter_rows: {
178
+ type: Schema.Types.Mixed,
179
+ required: true,
180
+ default: null,
181
+ },
182
+ top_sources: {
183
+ type: [DiscountSourceCounterSchema],
184
+ default: null,
185
+ validate: {
186
+ validator: (value) => value == null || value.length <= MATERIALIZED_DISCOUNT_SOURCE_LIMIT,
187
+ message: `top_sources must not exceed ${MATERIALIZED_DISCOUNT_SOURCE_LIMIT} entries`,
188
+ },
189
+ },
190
+ iteration: {
191
+ type: Number,
192
+ required: true,
193
+ min: 1,
194
+ default: 1,
195
+ },
196
+ schema_version: {
197
+ type: Number,
198
+ required: true,
199
+ immutable: true,
200
+ default: MATERIALIZED_TENANT_DISCOUNT_REPORTS_SCHEMA_VERSION,
201
+ },
202
+ source_watermark: {
203
+ type: Schema.Types.Date,
204
+ required: true,
205
+ },
206
+ computed_at: {
207
+ type: Schema.Types.Date,
208
+ required: true,
209
+ },
210
+ createdAt: {
211
+ type: Schema.Types.Date,
212
+ required: true,
213
+ default: () => new Date(),
214
+ immutable: true,
215
+ },
216
+ updatedAt: {
217
+ type: Schema.Types.Date,
218
+ required: true,
219
+ default: () => new Date(),
220
+ },
221
+ }, {
222
+ timestamps: true,
223
+ versionKey: false,
224
+ minimize: false,
225
+ });
226
+ export const MATERIALIZED_TENANT_DISCOUNT_REPORTS_COLLECTION_NAME = 'materialized_tenant_discount_reports';
227
+ /**
228
+ * Indexes for `materialized_tenant_discount_reports` — ONE compound index
229
+ * carries the whole read story (plus `_id`), identical in shape to every other
230
+ * materialized report collection:
231
+ * `tenant_id__scope_context__scope_field__day_index` — UNIQUE:
232
+ * - identity — one document per (tenant, scope context, scope value);
233
+ * `day_index` is a deterministic function of `scope_field` (null for period
234
+ * scopes), so uniqueness is exactly on that identity;
235
+ * - the read — the `{ tenant_id, scope_context, scope_field }` prefix serves
236
+ * exact and ranged scope-field queries for single tenants and `$in` lists.
237
+ *
238
+ * There are NO `brand_id` indexes: brand-level reads always pass the brand's
239
+ * explicit tenant list (`tenant_id: { $in }`).
240
+ */
241
+ export const MATERIALIZED_TENANT_DISCOUNT_REPORTS_COLLECTION_INDEXES = {
242
+ _id: { _id: 1 },
243
+ tenant_id__scope_context__scope_field__day_index: {
244
+ tenant_id: 1,
245
+ scope_context: 1,
246
+ scope_field: 1,
247
+ day_index: 1,
248
+ },
249
+ };
250
+ export const MATERIALIZED_TENANT_DISCOUNT_REPORTS_INDEX_OPTIONS = [
251
+ {
252
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
253
+ name: 'tenant_id__scope_context__scope_field__day_index',
254
+ unique: true,
255
+ },
256
+ ];
257
+ /**
258
+ * The discount counter tree's STRUCTURE — every field path, in the order the
259
+ * counters are declared. Exported because the read pipeline must fold stored
260
+ * documents leaf-by-leaf, and deriving that structure at runtime (a recursive
261
+ * aggregation expression) cannot terminate at build time. A structural change
262
+ * to the counters is the ONE thing that must update this list, and the schema
263
+ * contract test asserts it matches the zeroed counter shape.
264
+ */
265
+ export const MATERIALIZED_DISCOUNT_COUNTER_TREE = {
266
+ /** Top-level numeric fields (summed directly). */
267
+ scalars: ['count', 'amount', 'order_level_amount', 'item_level_amount', 'item_discount_count', 'unattributed_amount'],
268
+ /** Nested counter objects: the parent field → its numeric child fields. */
269
+ groups: {
270
+ order_special: ['count', 'amount', 'resolved_amount'],
271
+ order_loyalty: ['count', 'amount', 'resolved_amount'],
272
+ order_voucher: ['count', 'amount', 'resolved_amount'],
273
+ special_collection: ['count', 'amount', 'resolved_amount'],
274
+ special_manual: ['count', 'amount', 'resolved_amount'],
275
+ special_price_override: ['count', 'amount', 'resolved_amount'],
276
+ special_catalog_item: ['count', 'amount', 'resolved_amount'],
277
+ special_other: ['count', 'amount', 'resolved_amount'],
278
+ loyalty_offer: ['count', 'amount', 'resolved_amount'],
279
+ loyalty_gift_card: ['count', 'amount', 'resolved_amount'],
280
+ loyalty_wallet: ['count', 'amount', 'resolved_amount'],
281
+ loyalty_other: ['count', 'amount', 'resolved_amount'],
282
+ voucher_offer: ['count', 'amount', 'resolved_amount'],
283
+ voucher_other: ['count', 'amount', 'resolved_amount'],
284
+ item_special: [
285
+ 'count',
286
+ 'amount',
287
+ 'resolved_amount',
288
+ 'collection_count',
289
+ 'collection_amount',
290
+ 'collection_resolved_amount',
291
+ 'manual_count',
292
+ 'manual_amount',
293
+ 'manual_resolved_amount',
294
+ 'price_override_count',
295
+ 'price_override_amount',
296
+ 'price_override_resolved_amount',
297
+ 'catalog_item_count',
298
+ 'catalog_item_amount',
299
+ 'catalog_item_resolved_amount',
300
+ 'other_count',
301
+ 'other_amount',
302
+ 'other_resolved_amount',
303
+ ],
304
+ item_loyalty: [
305
+ 'count',
306
+ 'amount',
307
+ 'resolved_amount',
308
+ 'offer_count',
309
+ 'offer_amount',
310
+ 'offer_resolved_amount',
311
+ 'gift_card_count',
312
+ 'gift_card_amount',
313
+ 'gift_card_resolved_amount',
314
+ 'wallet_count',
315
+ 'wallet_amount',
316
+ 'wallet_resolved_amount',
317
+ 'other_count',
318
+ 'other_amount',
319
+ 'other_resolved_amount',
320
+ ],
321
+ item_voucher: [
322
+ 'count',
323
+ 'amount',
324
+ 'resolved_amount',
325
+ 'ref_count',
326
+ 'offer_count',
327
+ 'offer_amount',
328
+ 'offer_resolved_amount',
329
+ ],
330
+ free_items: ['count', 'amount', 'resolved_amount', 'value'],
331
+ complimentary: ['payment_count', 'amount', 'note_count'],
332
+ },
333
+ };
@@ -0,0 +1,87 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, HOURLY_COMPARISON_KEY_FILTERS, MATERIALIZED_HOURLY_COMPARISON_REPORT_SCOPES, MATERIALIZED_TENANT_HOURLY_COMPARISON_ENTRIES_SCHEMA_VERSION, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_hourly_comparison_entries` — the
6
+ * order rows behind one hour of the Hourly Comparison drill-down.
7
+ *
8
+ * One entries document per ACTIVE hour; rows are the same slim order rows as
9
+ * Sales Comparison (ids + money facts), ORDER rows only.
10
+ */
11
+ /** Version of the hourly entry rules (bump + re-materialize on change). */
12
+ export { MATERIALIZED_TENANT_HOURLY_COMPARISON_ENTRIES_SCHEMA_VERSION };
13
+ export const MaterializedTenantHourlyComparisonEntriesSchema = new Schema({
14
+ _id: {
15
+ type: Schema.Types.ObjectId,
16
+ required: true,
17
+ immutable: true,
18
+ },
19
+ tenant_id: { type: String, required: true },
20
+ brand_id: { type: String, required: true },
21
+ scope_context: {
22
+ type: String,
23
+ required: true,
24
+ enum: MATERIALIZED_HOURLY_COMPARISON_REPORT_SCOPES,
25
+ },
26
+ scope_field: { type: String, required: true },
27
+ day_index: {
28
+ type: String,
29
+ default: null,
30
+ enum: [...ALL_DAY_INDEX, null],
31
+ },
32
+ sale_type_key_filters: {
33
+ type: [String],
34
+ required: true,
35
+ default: () => [...HOURLY_COMPARISON_KEY_FILTERS],
36
+ validate: {
37
+ validator: (value) => value.length > 0 &&
38
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
39
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
40
+ },
41
+ },
42
+ sales_entries: {
43
+ type: Schema.Types.Mixed,
44
+ required: true,
45
+ default: null,
46
+ },
47
+ iteration: { type: Number, required: true, min: 1, default: 1 },
48
+ schema_version: {
49
+ type: Number,
50
+ required: true,
51
+ immutable: true,
52
+ default: MATERIALIZED_TENANT_HOURLY_COMPARISON_ENTRIES_SCHEMA_VERSION,
53
+ },
54
+ source_watermark: { type: Schema.Types.Date, required: true },
55
+ computed_at: { type: Schema.Types.Date, required: true },
56
+ createdAt: {
57
+ type: Schema.Types.Date,
58
+ required: true,
59
+ default: () => new Date(),
60
+ immutable: true,
61
+ },
62
+ updatedAt: {
63
+ type: Schema.Types.Date,
64
+ required: true,
65
+ default: () => new Date(),
66
+ },
67
+ }, {
68
+ timestamps: true,
69
+ versionKey: false,
70
+ minimize: false,
71
+ });
72
+ export const MATERIALIZED_TENANT_HOURLY_COMPARISON_ENTRIES_COLLECTION_INDEXES = {
73
+ _id: { _id: 1 },
74
+ tenant_id__scope_context__scope_field__day_index: {
75
+ tenant_id: 1,
76
+ scope_context: 1,
77
+ scope_field: 1,
78
+ day_index: 1,
79
+ },
80
+ };
81
+ export const MATERIALIZED_TENANT_HOURLY_COMPARISON_ENTRIES_INDEX_OPTIONS = [
82
+ {
83
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
84
+ name: 'tenant_id__scope_context__scope_field__day_index',
85
+ unique: true,
86
+ },
87
+ ];
@@ -0,0 +1,99 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, HOURLY_COMPARISON_KEY_FILTERS, MATERIALIZED_HOURLY_COMPARISON_REPORT_SCOPES, MATERIALIZED_TENANT_HOURLY_COMPARISON_REPORTS_SCHEMA_VERSION, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_hourly_comparison_reports` — one hour
6
+ * of one tenant-local settled day. See
7
+ * `schemas/types/materialized_tenant_hourly_comparison_reports.ts` and
8
+ * `console/admin-panel/docs/report-hourly-comparison-concept.md`.
9
+ *
10
+ * The counters are the SAME eleven additive counters as Sales Comparison, stored
11
+ * TWICE (key-addressed map + read-path rows). `scope_context` is always
12
+ * `localHour`; the report writes no day or period documents.
13
+ */
14
+ /** Version of the hourly counter rules (bump + re-materialize on change). */
15
+ export { MATERIALIZED_TENANT_HOURLY_COMPARISON_REPORTS_SCHEMA_VERSION };
16
+ export const MaterializedTenantHourlyComparisonReportSchema = new Schema({
17
+ _id: {
18
+ type: Schema.Types.ObjectId,
19
+ required: true,
20
+ immutable: true,
21
+ },
22
+ tenant_id: { type: String, required: true },
23
+ brand_id: { type: String, required: true },
24
+ scope_context: {
25
+ type: String,
26
+ required: true,
27
+ enum: MATERIALIZED_HOURLY_COMPARISON_REPORT_SCOPES,
28
+ },
29
+ scope_field: { type: String, required: true },
30
+ day_index: {
31
+ type: String,
32
+ default: null,
33
+ enum: [...ALL_DAY_INDEX, null],
34
+ },
35
+ sale_type_key_filters: {
36
+ type: [String],
37
+ required: true,
38
+ default: () => [...HOURLY_COMPARISON_KEY_FILTERS],
39
+ validate: {
40
+ validator: (value) => value.length > 0 &&
41
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
42
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
43
+ },
44
+ },
45
+ sales_counters: {
46
+ type: Schema.Types.Mixed,
47
+ required: true,
48
+ default: null,
49
+ },
50
+ sales_counter_rows: {
51
+ type: Schema.Types.Mixed,
52
+ required: true,
53
+ default: null,
54
+ },
55
+ iteration: { type: Number, required: true, min: 1, default: 1 },
56
+ schema_version: {
57
+ type: Number,
58
+ required: true,
59
+ immutable: true,
60
+ default: MATERIALIZED_TENANT_HOURLY_COMPARISON_REPORTS_SCHEMA_VERSION,
61
+ },
62
+ source_watermark: { type: Schema.Types.Date, required: true },
63
+ computed_at: { type: Schema.Types.Date, required: true },
64
+ createdAt: {
65
+ type: Schema.Types.Date,
66
+ required: true,
67
+ default: () => new Date(),
68
+ immutable: true,
69
+ },
70
+ updatedAt: {
71
+ type: Schema.Types.Date,
72
+ required: true,
73
+ default: () => new Date(),
74
+ },
75
+ }, {
76
+ timestamps: true,
77
+ versionKey: false,
78
+ minimize: false,
79
+ });
80
+ /**
81
+ * Indexes — the same ONE unique compound identity/read index as every other
82
+ * materialized report: `tenant_id + scope_context + scope_field + day_index`.
83
+ */
84
+ export const MATERIALIZED_TENANT_HOURLY_COMPARISON_REPORTS_COLLECTION_INDEXES = {
85
+ _id: { _id: 1 },
86
+ tenant_id__scope_context__scope_field__day_index: {
87
+ tenant_id: 1,
88
+ scope_context: 1,
89
+ scope_field: 1,
90
+ day_index: 1,
91
+ },
92
+ };
93
+ export const MATERIALIZED_TENANT_HOURLY_COMPARISON_REPORTS_INDEX_OPTIONS = [
94
+ {
95
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
96
+ name: 'tenant_id__scope_context__scope_field__day_index',
97
+ unique: true,
98
+ },
99
+ ];
@@ -0,0 +1,71 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, MATERIALIZED_PAYMENTS_COMPARISON_REPORT_SCOPES, MATERIALIZED_TENANT_PAYMENTS_COMPARISON_ENTRIES_SCHEMA_VERSION, PAYMENTS_COMPARISON_KEY_FILTERS, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_payments_comparison_entries` — the
6
+ * payment rows behind the Payments Comparison drill-down.
7
+ */
8
+ export { MATERIALIZED_TENANT_PAYMENTS_COMPARISON_ENTRIES_SCHEMA_VERSION };
9
+ export const MaterializedTenantPaymentsComparisonEntriesSchema = new Schema({
10
+ _id: { type: Schema.Types.ObjectId, required: true, immutable: true },
11
+ tenant_id: { type: String, required: true },
12
+ brand_id: { type: String, required: true },
13
+ scope_context: {
14
+ type: String,
15
+ required: true,
16
+ enum: MATERIALIZED_PAYMENTS_COMPARISON_REPORT_SCOPES,
17
+ },
18
+ scope_field: { type: String, required: true },
19
+ day_index: {
20
+ type: String,
21
+ default: null,
22
+ enum: [...ALL_DAY_INDEX, null],
23
+ },
24
+ sale_type_key_filters: {
25
+ type: [String],
26
+ required: true,
27
+ default: () => [...PAYMENTS_COMPARISON_KEY_FILTERS],
28
+ validate: {
29
+ validator: (value) => value.length > 0 &&
30
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
31
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
32
+ },
33
+ },
34
+ payment_entries: { type: Schema.Types.Mixed, required: true, default: null },
35
+ iteration: { type: Number, required: true, min: 1, default: 1 },
36
+ schema_version: {
37
+ type: Number,
38
+ required: true,
39
+ immutable: true,
40
+ default: MATERIALIZED_TENANT_PAYMENTS_COMPARISON_ENTRIES_SCHEMA_VERSION,
41
+ },
42
+ source_watermark: { type: Schema.Types.Date, required: true },
43
+ computed_at: { type: Schema.Types.Date, required: true },
44
+ createdAt: {
45
+ type: Schema.Types.Date,
46
+ required: true,
47
+ default: () => new Date(),
48
+ immutable: true,
49
+ },
50
+ updatedAt: {
51
+ type: Schema.Types.Date,
52
+ required: true,
53
+ default: () => new Date(),
54
+ },
55
+ }, { timestamps: true, versionKey: false, minimize: false });
56
+ export const MATERIALIZED_TENANT_PAYMENTS_COMPARISON_ENTRIES_COLLECTION_INDEXES = {
57
+ _id: { _id: 1 },
58
+ tenant_id__scope_context__scope_field__day_index: {
59
+ tenant_id: 1,
60
+ scope_context: 1,
61
+ scope_field: 1,
62
+ day_index: 1,
63
+ },
64
+ };
65
+ export const MATERIALIZED_TENANT_PAYMENTS_COMPARISON_ENTRIES_INDEX_OPTIONS = [
66
+ {
67
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
68
+ name: 'tenant_id__scope_context__scope_field__day_index',
69
+ unique: true,
70
+ },
71
+ ];
@@ -0,0 +1,76 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, MATERIALIZED_PAYMENTS_COMPARISON_REPORT_SCOPES, MATERIALIZED_TENANT_PAYMENTS_COMPARISON_REPORTS_SCHEMA_VERSION, PAYMENTS_COMPARISON_KEY_FILTERS, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_payments_comparison_reports` — the
6
+ * COUNTERS of the Payments Comparison report.
7
+ *
8
+ * Payment rows, not orders. The key is `<PAYMENT_METHOD>:<ORDER_STATUS>` where
9
+ * the method is an OPEN string (never enum-validated), and counters are stored
10
+ * twice (map + read-path rows). CENTS.
11
+ */
12
+ export { MATERIALIZED_TENANT_PAYMENTS_COMPARISON_REPORTS_SCHEMA_VERSION };
13
+ export const MaterializedTenantPaymentsComparisonReportSchema = new Schema({
14
+ _id: { type: Schema.Types.ObjectId, required: true, immutable: true },
15
+ tenant_id: { type: String, required: true },
16
+ brand_id: { type: String, required: true },
17
+ scope_context: {
18
+ type: String,
19
+ required: true,
20
+ enum: MATERIALIZED_PAYMENTS_COMPARISON_REPORT_SCOPES,
21
+ },
22
+ scope_field: { type: String, required: true },
23
+ day_index: {
24
+ type: String,
25
+ default: null,
26
+ enum: [...ALL_DAY_INDEX, null],
27
+ },
28
+ sale_type_key_filters: {
29
+ type: [String],
30
+ required: true,
31
+ default: () => [...PAYMENTS_COMPARISON_KEY_FILTERS],
32
+ validate: {
33
+ validator: (value) => value.length > 0 &&
34
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
35
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
36
+ },
37
+ },
38
+ payment_counters: { type: Schema.Types.Mixed, required: true, default: null },
39
+ payment_counter_rows: { type: Schema.Types.Mixed, required: true, default: null },
40
+ iteration: { type: Number, required: true, min: 1, default: 1 },
41
+ schema_version: {
42
+ type: Number,
43
+ required: true,
44
+ immutable: true,
45
+ default: MATERIALIZED_TENANT_PAYMENTS_COMPARISON_REPORTS_SCHEMA_VERSION,
46
+ },
47
+ source_watermark: { type: Schema.Types.Date, required: true },
48
+ computed_at: { type: Schema.Types.Date, required: true },
49
+ createdAt: {
50
+ type: Schema.Types.Date,
51
+ required: true,
52
+ default: () => new Date(),
53
+ immutable: true,
54
+ },
55
+ updatedAt: {
56
+ type: Schema.Types.Date,
57
+ required: true,
58
+ default: () => new Date(),
59
+ },
60
+ }, { timestamps: true, versionKey: false, minimize: false });
61
+ export const MATERIALIZED_TENANT_PAYMENTS_COMPARISON_REPORTS_COLLECTION_INDEXES = {
62
+ _id: { _id: 1 },
63
+ tenant_id__scope_context__scope_field__day_index: {
64
+ tenant_id: 1,
65
+ scope_context: 1,
66
+ scope_field: 1,
67
+ day_index: 1,
68
+ },
69
+ };
70
+ export const MATERIALIZED_TENANT_PAYMENTS_COMPARISON_REPORTS_INDEX_OPTIONS = [
71
+ {
72
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
73
+ name: 'tenant_id__scope_context__scope_field__day_index',
74
+ unique: true,
75
+ },
76
+ ];