@managesome/eposmatic-toolkit 0.4.29 → 0.4.30

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 (63) hide show
  1. package/esm/constants/MATERIALIZED_REPORTS.js +9 -12
  2. package/esm/helpers/materialized-reports/index.js +1 -0
  3. package/esm/helpers/materialized-reports/materialized-credit-bills-helpers.js +129 -20
  4. package/esm/helpers/materialized-reports/materialized-discount-classification-helpers.js +10 -3
  5. package/esm/helpers/materialized-reports/materialized-discount-close-day-helpers.js +251 -240
  6. package/esm/helpers/materialized-reports/materialized-discount-compile-helpers.js +2 -1
  7. package/esm/helpers/materialized-reports/materialized-discount-source-helpers.js +176 -0
  8. package/esm/helpers/materialized-reports/materialized-index-bootstrap.js +64 -0
  9. package/esm/helpers/materialized-reports/materialized-integer-contract.js +30 -4
  10. package/esm/helpers/materialized-reports/materialized-report-drilldown-rows.js +4 -2
  11. package/esm/helpers/materialized-reports/materialized-reports-selection-helpers.js +7 -0
  12. package/esm/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.js +284 -43
  13. package/esm/helpers/materialized-reports/tenant-sales-overview-helpers.js +4 -4
  14. package/esm/schemas/models/materialized_report_drilldown_rows.js +39 -12
  15. package/esm/schemas/models/materialized_tenant_discount_entries.js +18 -12
  16. package/esm/schemas/models/materialized_tenant_discount_sources.js +1 -1
  17. package/esm/schemas/models/orders.js +5 -0
  18. package/esm/schemas/models/tenant_calendar.js +12 -0
  19. package/lib/constants/MATERIALIZED_REPORTS.d.ts +9 -12
  20. package/lib/constants/MATERIALIZED_REPORTS.js +11 -14
  21. package/lib/helpers/materialized-reports/index.d.ts +1 -0
  22. package/lib/helpers/materialized-reports/index.js +1 -0
  23. package/lib/helpers/materialized-reports/materialized-credit-bills-helpers.d.ts +38 -0
  24. package/lib/helpers/materialized-reports/materialized-credit-bills-helpers.js +129 -19
  25. package/lib/helpers/materialized-reports/materialized-discount-classification-helpers.js +10 -3
  26. package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.d.ts +23 -61
  27. package/lib/helpers/materialized-reports/materialized-discount-close-day-helpers.js +250 -239
  28. package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.d.ts +4 -4
  29. package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.js +1 -0
  30. package/lib/helpers/materialized-reports/materialized-discount-source-helpers.d.ts +17 -0
  31. package/lib/helpers/materialized-reports/materialized-discount-source-helpers.js +178 -0
  32. package/lib/helpers/materialized-reports/materialized-index-bootstrap.d.ts +7 -0
  33. package/lib/helpers/materialized-reports/materialized-index-bootstrap.js +68 -0
  34. package/lib/helpers/materialized-reports/materialized-integer-contract.d.ts +3 -1
  35. package/lib/helpers/materialized-reports/materialized-integer-contract.js +30 -4
  36. package/lib/helpers/materialized-reports/materialized-report-drilldown-rows.d.ts +2 -2
  37. package/lib/helpers/materialized-reports/materialized-report-drilldown-rows.js +4 -2
  38. package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.js +7 -0
  39. package/lib/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.d.ts +8 -0
  40. package/lib/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.js +283 -42
  41. package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.js +4 -4
  42. package/lib/schemas/models/materialized_report_drilldown_rows.d.ts +40 -6
  43. package/lib/schemas/models/materialized_report_drilldown_rows.js +39 -12
  44. package/lib/schemas/models/materialized_tenant_discount_entries.d.ts +33 -29
  45. package/lib/schemas/models/materialized_tenant_discount_entries.js +18 -12
  46. package/lib/schemas/models/materialized_tenant_discount_sources.d.ts +6 -6
  47. package/lib/schemas/models/materialized_tenant_discount_sources.js +1 -1
  48. package/lib/schemas/models/orders.d.ts +5 -0
  49. package/lib/schemas/models/orders.js +5 -0
  50. package/lib/schemas/models/tenant_calendar.d.ts +13 -0
  51. package/lib/schemas/models/tenant_calendar.js +13 -1
  52. package/lib/schemas/types/materialized_report_drilldown_rows.d.ts +8 -0
  53. package/lib/schemas/types/materialized_tenant_discount_entries.d.ts +9 -5
  54. package/lib/tests/materialized-reports/materialized-credit-bills-helpers.test.js +56 -1
  55. package/lib/tests/materialized-reports/materialized-discount-classification.test.js +17 -0
  56. package/lib/tests/materialized-reports/materialized-discount-close-day.test.js +60 -54
  57. package/lib/tests/materialized-reports/materialized-discount-entries-accumulation.test.js +14 -13
  58. package/lib/tests/materialized-reports/materialized-discount-sources.test.js +76 -0
  59. package/lib/tests/materialized-reports/materialized-integer-contract.test.js +11 -0
  60. package/lib/tests/materialized-reports/materialized-reports-selection-helpers.test.js +2 -2
  61. package/lib/tests/materialized-reports/tenant-sales-overview-close-day-helpers.test.js +152 -7
  62. package/lib/tests/materialized-reports/tenant-sales-overview-helpers.test.js +89 -0
  63. package/package.json +1 -1
@@ -69,6 +69,95 @@ const makePayLaterOrder = (args) => ({
69
69
  },
70
70
  ],
71
71
  });
72
+ describe('legacy Amount Collected inputs under the UNPAID invariant', () => {
73
+ const makeOrder = (over = {}) => ({
74
+ _id: 'amount-collected-order',
75
+ tenant_id: 'tenant-amount-collected',
76
+ brand_id: 'brand-amount-collected',
77
+ platform: 'POS_WALK-IN',
78
+ order_status: constants_1.ORDER_STATUS_ENUM.COMPLETED,
79
+ order_number: 1,
80
+ amount_earned: 1000,
81
+ amount_collected: 1000,
82
+ grand_total: 1000,
83
+ total_discount_applied: 0,
84
+ gst_amount: 0,
85
+ tax_amount: 0,
86
+ tip_amount: 0,
87
+ tax_invoice_provider_charges: 0,
88
+ is_deleted: false,
89
+ localDate: '2026-09-30',
90
+ createdAt: new Date('2026-09-30T12:00:00.000Z'),
91
+ updatedAt: new Date('2026-09-30T12:00:00.000Z'),
92
+ payments: [],
93
+ ...over,
94
+ });
95
+ const compile = (order) => {
96
+ const compiled = expectNonNull((0, tenant_sales_overview_helpers_1.convertOrdersToMaterializedTenantSalesOverviewReports)('2026-09-30', [order], {
97
+ tenantId: 'tenant-amount-collected',
98
+ brandId: 'brand-amount-collected',
99
+ gmtOffset: 0,
100
+ computedAt: new Date('2026-09-30T23:00:00.000Z'),
101
+ }));
102
+ const dateDoc = compiled.materializedReports.find((doc) => doc.scope_context === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_DATE);
103
+ return getKeyMetrics(expectNonNull(dateDoc), 'COMPLETED:POS_WALK-IN');
104
+ };
105
+ it('keeps amount_earned as the sales basis, excluding the card charge from grand_total', () => {
106
+ const metrics = compile(makeOrder({
107
+ grand_total: 1100,
108
+ amount_earned: 1000,
109
+ amount_collected: 1100,
110
+ payments: [
111
+ {
112
+ _id: 'card-1',
113
+ payment_id: 'card-1',
114
+ payment_type: constants_1.PAYMENT_TYPE_ENUM.CARD,
115
+ payment_status: constants_1.PAYMENT_STATUS_ENUM.SETTLED,
116
+ amount_due: 1100,
117
+ amount_paid: 1100,
118
+ amount_refunded: 0,
119
+ card_details: { payment_provider: 'STRIPE', card_charges: 100 },
120
+ },
121
+ ],
122
+ }));
123
+ expect(metrics[constants_1.REPORT_SALE_TYPE_ENUM.TOTAL_SALES].orders.gross_amount).toBe(1000);
124
+ expect(metrics[constants_1.REPORT_SALE_TYPE_ENUM.AMOUNT_COLLECTED].orders.gross_amount).toBe(1000);
125
+ });
126
+ it('legacy Amount Collected = sales - UNPAID balance when the invariant holds', () => {
127
+ const metrics = compile(makeOrder({
128
+ amount_earned: 1000,
129
+ amount_collected: 400,
130
+ payments: [
131
+ {
132
+ _id: 'cash-1',
133
+ payment_id: 'cash-1',
134
+ payment_type: constants_1.PAYMENT_TYPE_ENUM.CASH,
135
+ payment_status: constants_1.PAYMENT_STATUS_ENUM.SETTLED,
136
+ amount_due: 400,
137
+ amount_paid: 400,
138
+ amount_refunded: 0,
139
+ card_details: null,
140
+ },
141
+ {
142
+ _id: 'unpaid-1',
143
+ payment_id: null,
144
+ payment_type: constants_1.PAYMENT_TYPE_ENUM.UNPAID,
145
+ payment_status: constants_1.PAYMENT_STATUS_ENUM.PENDING,
146
+ amount_due: 600,
147
+ amount_paid: 0,
148
+ amount_refunded: 0,
149
+ card_details: null,
150
+ },
151
+ ],
152
+ }));
153
+ const salesAmount = metrics[constants_1.REPORT_SALE_TYPE_ENUM.TOTAL_SALES].orders.gross_amount;
154
+ const unpaidGross = metrics[constants_1.REPORT_SALE_TYPE_ENUM.TOTAL_SALES].payments.find((payment) => payment.payment_type === constants_1.PAYMENT_TYPE_ENUM.UNPAID)?.gross_amount ?? 0;
155
+ expect(unpaidGross).toBe(600);
156
+ // The legacy UI formula with zero credit receipts:
157
+ const legacyAmountCollected = salesAmount - unpaidGross + 0 + 0;
158
+ expect(legacyAmountCollected).toBe(400);
159
+ });
160
+ });
72
161
  describe('materialized report key helpers', () => {
73
162
  it('builds and parses the ordered key grammar', () => {
74
163
  expect((0, key_helpers_1.buildMaterializedReportKey)(['COMPLETED', 'POS_TAKE-AWAY'])).toBe('COMPLETED:POS_TAKE-AWAY');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@managesome/eposmatic-toolkit",
3
- "version": "0.4.29",
3
+ "version": "0.4.30",
4
4
  "description": "A Toolkit Library for Eposmatic",
5
5
  "main": "lib/index.js",
6
6
  "module": "esm/index.js",