@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,95 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_CASH_IN_OUT_REFS, ALL_CASH_IN_OUT_TYPES } from '../../constants/enums/cash';
4
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, CASH_KEY_FILTERS, MATERIALIZED_CASH_REPORT_SCOPES, } from '../../constants/MATERIALIZED_REPORTS';
5
+ /**
6
+ * Mongoose schema for `materialized_tenant_cash_in_out_entries` - the STATEMENT
7
+ * rows behind the cash report's drill-down (owner decision (e3): SPLIT).
8
+ *
9
+ * Scopes are capped at `LOCAL_MONTH`. Each row mirrors what the POS ledger already
10
+ * renders (Detail / Before / signed Amount / After), and carries the four
11
+ * lifecycle FLAGS computed at compile time so the read never re-derives them.
12
+ */
13
+ /**
14
+ * Version of the cash ENTRY rules. Bump when row semantics change - historical
15
+ * documents must then be re-materialized. PRE-RELEASE: folds into version `1`.
16
+ */
17
+ export const MATERIALIZED_TENANT_CASH_ENTRIES_SCHEMA_VERSION = 1;
18
+ const CashEntrySchema = new Schema({
19
+ cash_in_out_id: { type: String, required: true },
20
+ entry_key: { type: String, required: true },
21
+ drawer_id: { type: String, required: true },
22
+ drawer_name: { type: String, default: null },
23
+ day_id: { type: String, required: true },
24
+ shift_id: { type: String, default: null },
25
+ shift_number: { type: Number, default: null },
26
+ type: { type: String, required: true, enum: ALL_CASH_IN_OUT_TYPES },
27
+ ref_type: { type: String, required: true, enum: ALL_CASH_IN_OUT_REFS },
28
+ ref_id: { type: String, default: null },
29
+ amount: { type: Number, required: true, default: 0 },
30
+ signed_amount: { type: Number, required: true, default: 0 },
31
+ drawer_balance_before: { type: Number, required: true, default: 0 },
32
+ drawer_balance_after: { type: Number, required: true, default: 0 },
33
+ staff_id: { type: String, default: null },
34
+ staff_name: { type: String, default: null },
35
+ note: { type: String, default: null },
36
+ // Computed ONCE at compile time (decision (i3)) - never re-derived on read.
37
+ is_reopen: { type: Boolean, required: true, default: false },
38
+ is_opening_float: { type: Boolean, required: true, default: false },
39
+ is_count_out: { type: Boolean, required: true, default: false },
40
+ is_system_adjustment: { type: Boolean, required: true, default: false },
41
+ created_at: { type: Schema.Types.Date, required: true },
42
+ local_hour: { type: String, default: null },
43
+ }, { _id: false });
44
+ export { CashEntrySchema };
45
+ export const MaterializedTenantCashEntriesSchema = new Schema({
46
+ tenant_id: { type: String, required: true },
47
+ brand_id: { type: String, required: true },
48
+ scope_context: { type: String, required: true, enum: MATERIALIZED_CASH_REPORT_SCOPES },
49
+ scope_field: { type: String, required: true },
50
+ day_index: { type: String, default: null, enum: [...ALL_DAY_INDEX, null] },
51
+ sale_type_key_filters: {
52
+ type: [String],
53
+ required: true,
54
+ default: () => [...CASH_KEY_FILTERS],
55
+ validate: {
56
+ validator: (value) => value.length > 0 &&
57
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
58
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
59
+ },
60
+ },
61
+ cash_entries: { type: Schema.Types.Mixed, required: true, default: null },
62
+ iteration: { type: Number, required: true, min: 1, default: 1 },
63
+ schema_version: {
64
+ type: Number,
65
+ required: true,
66
+ immutable: true,
67
+ default: MATERIALIZED_TENANT_CASH_ENTRIES_SCHEMA_VERSION,
68
+ },
69
+ source_watermark: { type: Schema.Types.Date, required: true },
70
+ computed_at: { type: Schema.Types.Date, required: true },
71
+ createdAt: { type: Schema.Types.Date, required: true, default: () => new Date(), immutable: true },
72
+ updatedAt: { type: Schema.Types.Date, required: true, default: () => new Date() },
73
+ }, { timestamps: true, versionKey: false, minimize: false });
74
+ export const MATERIALIZED_TENANT_CASH_ENTRIES_COLLECTION_NAME = 'materialized_tenant_cash_in_out_entries';
75
+ /**
76
+ * The single UNIQUE compound identity index, like every materialized collection.
77
+ * The `{ tenant_id, scope_context, scope_field }` prefix also serves the
78
+ * drill-down's month-document resolution.
79
+ */
80
+ export const MATERIALIZED_TENANT_CASH_ENTRIES_COLLECTION_INDEXES = {
81
+ _id: { _id: 1 },
82
+ tenant_id__scope_context__scope_field__day_index: {
83
+ tenant_id: 1,
84
+ scope_context: 1,
85
+ scope_field: 1,
86
+ day_index: 1,
87
+ },
88
+ };
89
+ export const MATERIALIZED_TENANT_CASH_ENTRIES_INDEX_OPTIONS = [
90
+ {
91
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
92
+ name: 'tenant_id__scope_context__scope_field__day_index',
93
+ unique: true,
94
+ },
95
+ ];
@@ -0,0 +1,77 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, CASH_KEY_FILTERS, MATERIALIZED_CASH_REPORT_SCOPES, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_cash_in_out_reports` (M3).
6
+ *
7
+ * Counters ONLY - the statement rows live in the SIBLING entries collection
8
+ * (`materialized_tenant_cash_in_out_entries`, decision (e3)).
9
+ *
10
+ * The counters are stored TWICE on purpose: a key-addressed MAP (`cash_counters`, the
11
+ * store + formatter shape) and the SAME counters as an ARRAY OF ROWS
12
+ * (`cash_counter_rows`, the READ shape), so the read aggregation is the canonical
13
+ * unwind/group/direct-sum pattern instead of dynamic-key navigation.
14
+ *
15
+ * Key grammar is `<DRAWER_ID>:<REF_TYPE>` (decision (b3)) - cash has neither an
16
+ * order status nor a platform.
17
+ */
18
+ /**
19
+ * Version of the cash COUNTER rules. Bump when counter semantics change -
20
+ * historical documents must then be re-materialized. PRE-RELEASE: folds into
21
+ * version `1`.
22
+ */
23
+ export const MATERIALIZED_TENANT_CASH_REPORTS_SCHEMA_VERSION = 1;
24
+ export const MaterializedTenantCashReportSchema = new Schema({
25
+ tenant_id: { type: String, required: true },
26
+ brand_id: { type: String, required: true },
27
+ scope_context: { type: String, required: true, enum: MATERIALIZED_CASH_REPORT_SCOPES },
28
+ scope_field: { type: String, required: true },
29
+ day_index: { type: String, default: null, enum: [...ALL_DAY_INDEX, null] },
30
+ sale_type_key_filters: {
31
+ type: [String],
32
+ required: true,
33
+ default: () => [...CASH_KEY_FILTERS],
34
+ validate: {
35
+ validator: (value) => value.length > 0 &&
36
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
37
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
38
+ },
39
+ },
40
+ // { [key]: counters } - pruned per key; never an empty map.
41
+ cash_counters: { type: Schema.Types.Mixed, required: true, default: null },
42
+ // The SAME counters as [{ key, counters }] - the read-path shape.
43
+ cash_counter_rows: { type: Schema.Types.Mixed, required: true, default: null },
44
+ iteration: { type: Number, required: true, min: 1, default: 1 },
45
+ schema_version: {
46
+ type: Number,
47
+ required: true,
48
+ immutable: true,
49
+ default: MATERIALIZED_TENANT_CASH_REPORTS_SCHEMA_VERSION,
50
+ },
51
+ source_watermark: { type: Schema.Types.Date, required: true },
52
+ computed_at: { type: Schema.Types.Date, required: true },
53
+ createdAt: { type: Schema.Types.Date, required: true, default: () => new Date(), immutable: true },
54
+ updatedAt: { type: Schema.Types.Date, required: true, default: () => new Date() },
55
+ }, { timestamps: true, versionKey: false, minimize: false });
56
+ export const MATERIALIZED_TENANT_CASH_REPORTS_COLLECTION_NAME = 'materialized_tenant_cash_in_out_reports';
57
+ /**
58
+ * The single UNIQUE compound identity index. It serves the close-day identity
59
+ * upserts AND the read: the pipeline's TOP-LEVEL `$match` gates on exactly this
60
+ * prefix. No `brand_id` index - a brand's drawers are resolved before the read.
61
+ */
62
+ export const MATERIALIZED_TENANT_CASH_REPORTS_COLLECTION_INDEXES = {
63
+ _id: { _id: 1 },
64
+ tenant_id__scope_context__scope_field__day_index: {
65
+ tenant_id: 1,
66
+ scope_context: 1,
67
+ scope_field: 1,
68
+ day_index: 1,
69
+ },
70
+ };
71
+ export const MATERIALIZED_TENANT_CASH_REPORTS_INDEX_OPTIONS = [
72
+ {
73
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
74
+ name: 'tenant_id__scope_context__scope_field__day_index',
75
+ unique: true,
76
+ },
77
+ ];
@@ -0,0 +1,63 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, DELIVERY_KEY_FILTERS, MATERIALIZED_DELIVERY_REPORT_SCOPES, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_delivery_entries` (M4).
6
+ *
7
+ * `delivery_entries` is `Mixed` on purpose: it is a key-addressed map of
8
+ * bounded sub-documents (rider / area leaderboards with an hour heat map), which Mongoose
9
+ * cannot type precisely without a fixed key set - the keys ARE the data.
10
+ */
11
+ export const MATERIALIZED_TENANT_DELIVERY_ENTRIES_SCHEMA_VERSION = 1;
12
+ export const MaterializedTenantDeliveryEntriesSchema = new Schema({
13
+ tenant_id: { type: String, required: true },
14
+ brand_id: { type: String, required: true },
15
+ scope_context: { type: String, required: true, enum: MATERIALIZED_DELIVERY_REPORT_SCOPES },
16
+ scope_field: { type: String, required: true },
17
+ day_index: { type: String, default: null, enum: [...ALL_DAY_INDEX, null] },
18
+ sale_type_key_filters: {
19
+ type: [String],
20
+ required: true,
21
+ default: () => [...DELIVERY_KEY_FILTERS],
22
+ validate: {
23
+ validator: (value) => value.length > 0 &&
24
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
25
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
26
+ },
27
+ },
28
+ delivery_entries: { type: Schema.Types.Mixed, required: false, default: null },
29
+ /** Delivery ORDERS with no delivery document - carried as a count, not rows. */
30
+ off_app_order_count: { type: Number, required: true, min: 0, default: 0 },
31
+ iteration: { type: Number, required: true, min: 1, default: 1 },
32
+ schema_version: {
33
+ type: Number,
34
+ required: true,
35
+ immutable: true,
36
+ default: MATERIALIZED_TENANT_DELIVERY_ENTRIES_SCHEMA_VERSION,
37
+ },
38
+ source_watermark: { type: Schema.Types.Date, required: true },
39
+ computed_at: { type: Schema.Types.Date, required: true },
40
+ createdAt: { type: Schema.Types.Date, required: true, default: () => new Date(), immutable: true },
41
+ updatedAt: { type: Schema.Types.Date, required: true, default: () => new Date() },
42
+ }, { timestamps: true, versionKey: false, minimize: false });
43
+ export const MATERIALIZED_TENANT_DELIVERY_ENTRIES_COLLECTION_NAME = 'materialized_tenant_delivery_entries';
44
+ /**
45
+ * The single UNIQUE compound identity index, like every materialized collection. No
46
+ * `brand_id` index - a brand's scopes are resolved before the read.
47
+ */
48
+ export const MATERIALIZED_TENANT_DELIVERY_ENTRIES_COLLECTION_INDEXES = {
49
+ _id: { _id: 1 },
50
+ tenant_id__scope_context__scope_field__day_index: {
51
+ tenant_id: 1,
52
+ scope_context: 1,
53
+ scope_field: 1,
54
+ day_index: 1,
55
+ },
56
+ };
57
+ export const MATERIALIZED_TENANT_DELIVERY_ENTRIES_INDEX_OPTIONS = [
58
+ {
59
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
60
+ name: 'tenant_id__scope_context__scope_field__day_index',
61
+ unique: true,
62
+ },
63
+ ];
@@ -0,0 +1,63 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_REPORT_KEY_FILTERS, DELIVERY_KEY_FILTERS, MATERIALIZED_DELIVERY_REPORT_SCOPES, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_delivery_reports` (M4).
6
+ *
7
+ * `delivery_counters` is `Mixed` on purpose: it is a key-addressed map of
8
+ * bounded sub-documents (rider / area leaderboards with an hour heat map), which Mongoose
9
+ * cannot type precisely without a fixed key set - the keys ARE the data.
10
+ */
11
+ export const MATERIALIZED_TENANT_DELIVERY_REPORTS_SCHEMA_VERSION = 1;
12
+ export const MaterializedTenantDeliveryReportSchema = new Schema({
13
+ tenant_id: { type: String, required: true },
14
+ brand_id: { type: String, required: true },
15
+ scope_context: { type: String, required: true, enum: MATERIALIZED_DELIVERY_REPORT_SCOPES },
16
+ scope_field: { type: String, required: true },
17
+ day_index: { type: String, default: null, enum: [...ALL_DAY_INDEX, null] },
18
+ sale_type_key_filters: {
19
+ type: [String],
20
+ required: true,
21
+ default: () => [...DELIVERY_KEY_FILTERS],
22
+ validate: {
23
+ validator: (value) => value.length > 0 &&
24
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
25
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
26
+ },
27
+ },
28
+ delivery_counters: { type: Schema.Types.Mixed, required: true, default: null },
29
+ // The SAME counters as [{ key, counters }] - the read-path shape.
30
+ delivery_counter_rows: { type: Schema.Types.Mixed, required: true, default: null },
31
+ iteration: { type: Number, required: true, min: 1, default: 1 },
32
+ schema_version: {
33
+ type: Number,
34
+ required: true,
35
+ immutable: true,
36
+ default: MATERIALIZED_TENANT_DELIVERY_REPORTS_SCHEMA_VERSION,
37
+ },
38
+ source_watermark: { type: Schema.Types.Date, required: true },
39
+ computed_at: { type: Schema.Types.Date, required: true },
40
+ createdAt: { type: Schema.Types.Date, required: true, default: () => new Date(), immutable: true },
41
+ updatedAt: { type: Schema.Types.Date, required: true, default: () => new Date() },
42
+ }, { timestamps: true, versionKey: false, minimize: false });
43
+ export const MATERIALIZED_TENANT_DELIVERY_REPORTS_COLLECTION_NAME = 'materialized_tenant_delivery_reports';
44
+ /**
45
+ * The single UNIQUE compound identity index, like every materialized collection. No
46
+ * `brand_id` index - a brand's scopes are resolved before the read.
47
+ */
48
+ export const MATERIALIZED_TENANT_DELIVERY_REPORTS_COLLECTION_INDEXES = {
49
+ _id: { _id: 1 },
50
+ tenant_id__scope_context__scope_field__day_index: {
51
+ tenant_id: 1,
52
+ scope_context: 1,
53
+ scope_field: 1,
54
+ day_index: 1,
55
+ },
56
+ };
57
+ export const MATERIALIZED_TENANT_DELIVERY_REPORTS_INDEX_OPTIONS = [
58
+ {
59
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
60
+ name: 'tenant_id__scope_context__scope_field__day_index',
61
+ unique: true,
62
+ },
63
+ ];
@@ -0,0 +1,156 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX } from '../../constants/ENUMS';
3
+ import { ALL_MATERIALIZED_DISCOUNT_ENTRY_KINDS, ALL_MATERIALIZED_DISCOUNT_LEVELS, ALL_MATERIALIZED_DISCOUNT_SLOTS, ALL_MATERIALIZED_DISCOUNT_SUB_KINDS, ALL_MATERIALIZED_REPORT_KEY_FILTERS, DISCOUNTS_KEY_FILTERS, MATERIALIZED_DISCOUNT_REPORT_SCOPES, } from '../../constants/MATERIALIZED_REPORTS';
4
+ /**
5
+ * Mongoose schema for `materialized_tenant_discount_entries` — the ITEMIZED
6
+ * discount rows behind the discounts report's drill-down (owner decision (a):
7
+ * SPLIT). See `schemas/types/materialized_tenant_discount_entries.ts` and
8
+ * `docs/report-discounts-concept.md`.
9
+ *
10
+ * Scopes are capped at `LOCAL_MONTH` so a document can never grow unboundedly.
11
+ * Rows are slim (ids + discount facts); each carries `entry_key`, its stable
12
+ * identity INSIDE an order, so the `(time, order_id, entry_key)` cursor can
13
+ * never collide. Amounts are CENTS; reads pin `schema_version`.
14
+ */
15
+ /**
16
+ * Version of the discount ENTRY rules of this collection. Bump when row
17
+ * semantics change (new kinds, different identity, different money rule) —
18
+ * historical documents must then be re-materialized. PRE-RELEASE: folds into
19
+ * version `1`.
20
+ */
21
+ export const MATERIALIZED_TENANT_DISCOUNT_ENTRIES_SCHEMA_VERSION = 1;
22
+ const DiscountEntrySchema = new Schema({
23
+ kind: { type: String, required: true, enum: ALL_MATERIALIZED_DISCOUNT_ENTRY_KINDS },
24
+ slot: { type: String, default: null, enum: [...ALL_MATERIALIZED_DISCOUNT_SLOTS, null] },
25
+ sub_kind: { type: String, required: true, enum: ALL_MATERIALIZED_DISCOUNT_SUB_KINDS },
26
+ level: { type: String, required: true, enum: ALL_MATERIALIZED_DISCOUNT_LEVELS },
27
+ // Stable identity of the row inside its order — part of the page cursor.
28
+ entry_key: { type: String, required: true },
29
+ order_id: { type: String, required: true },
30
+ order_number: { type: Number, default: null },
31
+ item_id: { type: String, default: null },
32
+ item_name: { type: String, default: null },
33
+ payment_id: { type: String, default: null },
34
+ // Raw slot value (PERCENT for percentage rows) — NEVER money.
35
+ rate: { type: Number, default: null },
36
+ // The MONEY this row applied, cents — what the drill-down renders.
37
+ amount: { type: Number, required: true, default: 0 },
38
+ is_percentage: { type: Boolean, default: null },
39
+ item_value: { type: Number, default: null },
40
+ discount_id: { type: String, default: null },
41
+ name: { type: String, default: null },
42
+ reference_number: { type: String, default: null },
43
+ reason: { type: String, default: null },
44
+ staff_id: { type: String, default: null },
45
+ staff_name: { type: String, default: null },
46
+ order_taker_id: { type: String, default: null },
47
+ order_taker_name: { type: String, default: null },
48
+ order_status: { type: String, required: true },
49
+ platform: { type: String, required: true },
50
+ created_at: { type: Schema.Types.Date, required: true },
51
+ local_hour: { type: String, default: null },
52
+ }, { _id: false });
53
+ export const MaterializedTenantDiscountEntriesSchema = new Schema({
54
+ _id: {
55
+ type: Schema.Types.ObjectId,
56
+ required: true,
57
+ immutable: true,
58
+ },
59
+ tenant_id: {
60
+ type: String,
61
+ required: true,
62
+ },
63
+ brand_id: {
64
+ type: String,
65
+ required: true,
66
+ },
67
+ scope_context: {
68
+ type: String,
69
+ required: true,
70
+ enum: MATERIALIZED_DISCOUNT_REPORT_SCOPES,
71
+ },
72
+ scope_field: {
73
+ type: String,
74
+ required: true,
75
+ },
76
+ day_index: {
77
+ type: String,
78
+ default: null,
79
+ enum: [...ALL_DAY_INDEX, null],
80
+ },
81
+ sale_type_key_filters: {
82
+ type: [String],
83
+ required: true,
84
+ default: () => [...DISCOUNTS_KEY_FILTERS],
85
+ validate: {
86
+ validator: (value) => value.length > 0 &&
87
+ value.every((entry) => ALL_MATERIALIZED_REPORT_KEY_FILTERS.includes(entry)),
88
+ message: 'sale_type_key_filters must be a non-empty subset of the known key filters',
89
+ },
90
+ },
91
+ // { [sale_type_key]: { rows: [...] } } — pruned when a key has no rows.
92
+ discount_entries: {
93
+ type: Schema.Types.Mixed,
94
+ required: true,
95
+ default: null,
96
+ },
97
+ iteration: {
98
+ type: Number,
99
+ required: true,
100
+ min: 1,
101
+ default: 1,
102
+ },
103
+ schema_version: {
104
+ type: Number,
105
+ required: true,
106
+ immutable: true,
107
+ default: MATERIALIZED_TENANT_DISCOUNT_ENTRIES_SCHEMA_VERSION,
108
+ },
109
+ source_watermark: {
110
+ type: Schema.Types.Date,
111
+ required: true,
112
+ },
113
+ computed_at: {
114
+ type: Schema.Types.Date,
115
+ required: true,
116
+ },
117
+ createdAt: {
118
+ type: Schema.Types.Date,
119
+ required: true,
120
+ default: () => new Date(),
121
+ immutable: true,
122
+ },
123
+ updatedAt: {
124
+ type: Schema.Types.Date,
125
+ required: true,
126
+ default: () => new Date(),
127
+ },
128
+ }, {
129
+ timestamps: true,
130
+ versionKey: false,
131
+ minimize: false,
132
+ });
133
+ export { DiscountEntrySchema };
134
+ export const MATERIALIZED_TENANT_DISCOUNT_ENTRIES_COLLECTION_NAME = 'materialized_tenant_discount_entries';
135
+ /**
136
+ * Indexes for `materialized_tenant_discount_entries` — the same single
137
+ * UNIQUE compound identity index as every materialized report collection. The
138
+ * `{ tenant_id, scope_context, scope_field }` prefix also serves the
139
+ * drill-down's month-document resolution.
140
+ */
141
+ export const MATERIALIZED_TENANT_DISCOUNT_ENTRIES_COLLECTION_INDEXES = {
142
+ _id: { _id: 1 },
143
+ tenant_id__scope_context__scope_field__day_index: {
144
+ tenant_id: 1,
145
+ scope_context: 1,
146
+ scope_field: 1,
147
+ day_index: 1,
148
+ },
149
+ };
150
+ export const MATERIALIZED_TENANT_DISCOUNT_ENTRIES_INDEX_OPTIONS = [
151
+ {
152
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
153
+ name: 'tenant_id__scope_context__scope_field__day_index',
154
+ unique: true,
155
+ },
156
+ ];