@managesome/eposmatic-toolkit 0.4.25 → 0.4.27

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 (60) hide show
  1. package/esm/helpers/materialized-reports/index.js +1 -0
  2. package/esm/helpers/materialized-reports/materialized-credit-bills-helpers.js +9 -4
  3. package/esm/helpers/materialized-reports/materialized-delivery-classification-helpers.js +25 -9
  4. package/esm/helpers/materialized-reports/materialized-delivery-compile-helpers.js +8 -5
  5. package/esm/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +13 -1
  6. package/esm/helpers/materialized-reports/materialized-discount-source-helpers.js +0 -3
  7. package/esm/helpers/materialized-reports/materialized-integer-contract.js +142 -0
  8. package/esm/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +7 -1
  9. package/esm/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +9 -2
  10. package/esm/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +17 -7
  11. package/esm/helpers/materialized-reports/tenant-discount-source-formatter.js +36 -6
  12. package/esm/helpers/materialized-reports/tenant-sales-overview-helpers.js +4 -2
  13. package/esm/helpers/utils/duration-conversion.js +31 -0
  14. package/esm/helpers/utils/index.js +2 -0
  15. package/esm/helpers/utils/percentage-conversion.js +69 -0
  16. package/esm/schemas/models/materialized_tenant_discount_sources.js +5 -1
  17. package/esm/schemas/models/tenant_hr_shift_schedules.js +4 -0
  18. package/esm/schemas/models/tenant_hr_shifts.js +4 -0
  19. package/lib/helpers/materialized-reports/index.d.ts +1 -0
  20. package/lib/helpers/materialized-reports/index.js +1 -0
  21. package/lib/helpers/materialized-reports/materialized-credit-bills-helpers.js +9 -4
  22. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.js +25 -9
  23. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +8 -5
  24. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.d.ts +18 -0
  25. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +14 -2
  26. package/lib/helpers/materialized-reports/materialized-discount-source-helpers.js +0 -3
  27. package/lib/helpers/materialized-reports/materialized-integer-contract.d.ts +68 -0
  28. package/lib/helpers/materialized-reports/materialized-integer-contract.js +147 -0
  29. package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +7 -1
  30. package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.js +9 -2
  31. package/lib/helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers.js +17 -7
  32. package/lib/helpers/materialized-reports/tenant-discount-source-formatter.d.ts +15 -5
  33. package/lib/helpers/materialized-reports/tenant-discount-source-formatter.js +36 -6
  34. package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.js +4 -2
  35. package/lib/helpers/types/materialized-reports-apis.d.ts +11 -3
  36. package/lib/helpers/utils/duration-conversion.d.ts +19 -0
  37. package/lib/helpers/utils/duration-conversion.js +37 -0
  38. package/lib/helpers/utils/index.d.ts +2 -0
  39. package/lib/helpers/utils/index.js +2 -0
  40. package/lib/helpers/utils/percentage-conversion.d.ts +49 -0
  41. package/lib/helpers/utils/percentage-conversion.js +76 -0
  42. package/lib/schemas/models/materialized_tenant_discount_sources.d.ts +0 -3
  43. package/lib/schemas/models/materialized_tenant_discount_sources.js +5 -1
  44. package/lib/schemas/models/tenant_hr_shift_schedules.js +4 -0
  45. package/lib/schemas/models/tenant_hr_shifts.js +4 -0
  46. package/lib/schemas/types/materialized_tenant_discount_entries.d.ts +11 -4
  47. package/lib/schemas/types/materialized_tenant_discount_sources.d.ts +23 -4
  48. package/lib/tests/materialized-reports/fixtures.d.ts +15 -1
  49. package/lib/tests/materialized-reports/fixtures.js +118 -8
  50. package/lib/tests/materialized-reports/materialized-discount-classification.test.js +34 -24
  51. package/lib/tests/materialized-reports/materialized-discount-sources.test.js +14 -10
  52. package/lib/tests/materialized-reports/materialized-integer-contract.test.d.ts +1 -0
  53. package/lib/tests/materialized-reports/materialized-integer-contract.test.js +223 -0
  54. package/lib/tests/materialized-reports/materialized-write-paths-inventory.test.d.ts +1 -0
  55. package/lib/tests/materialized-reports/materialized-write-paths-inventory.test.js +58 -0
  56. package/lib/tests/materialized-reports/materialized-writers-integer-only.test.d.ts +1 -0
  57. package/lib/tests/materialized-reports/materialized-writers-integer-only.test.js +150 -0
  58. package/lib/tests/materialized-reports/sales-overview-baseline.test.js +51 -51
  59. package/lib/tests/materialized-reports/tenant-discount-source-formatter.test.js +108 -5
  60. package/package.json +1 -1
@@ -0,0 +1,150 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
4
+ const materialized_integer_contract_1 = require("../../helpers/materialized-reports/materialized-integer-contract");
5
+ const materialized_credit_bills_helpers_1 = require("../../helpers/materialized-reports/materialized-credit-bills-helpers");
6
+ const materialized_sales_comparison_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-sales-comparison-compile-helpers");
7
+ const materialized_payments_comparison_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-payments-comparison-compile-helpers");
8
+ const materialized_hourly_comparison_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-hourly-comparison-compile-helpers");
9
+ const materialized_delivery_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-delivery-compile-helpers");
10
+ const fixtures_1 = require("./fixtures");
11
+ /**
12
+ * EVERY materialized writer must emit integer-only documents.
13
+ *
14
+ * The contract: money in CENTS, percentage rates in BASIS POINTS, durations in
15
+ * whole MINUTES, counts as counts — and no stored share, average or ratio.
16
+ *
17
+ * This suite is the per-writer audit: each writer is driven with the live
18
+ * fixtures and its OUTPUT is checked recursively, so a decimal hiding in a
19
+ * nested counter, a key-metric map or a flat row cannot slip through.
20
+ */
21
+ const TENANT = 'basha-istanbul-f7';
22
+ const BRAND = 'basha-istanbul-f7';
23
+ const OFFSET = 5;
24
+ const AT = new Date('2026-09-13T23:00:00.000Z');
25
+ const ordersOf = (localDate) => (0, fixtures_1.loadOrdersDataset)('basha').filter((order) => order.localDate === localDate);
26
+ describe('every materialized writer emits integer-only documents', () => {
27
+ it('the sales comparison writer', () => {
28
+ const compiled = (0, materialized_sales_comparison_compile_helpers_1.compileTenantSalesComparisonReports)({
29
+ tenantId: TENANT,
30
+ brandId: BRAND,
31
+ localDate: '2026-09-13',
32
+ orders: ordersOf('2026-09-13'),
33
+ gmtOffset: OFFSET,
34
+ computedAt: AT,
35
+ });
36
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)(compiled.reports, {
37
+ collection: 'materialized_tenant_sales_comparison_reports',
38
+ });
39
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)(compiled.entries, {
40
+ collection: 'materialized_tenant_sales_comparison_entries',
41
+ });
42
+ });
43
+ it('the payments comparison writer', () => {
44
+ const compiled = (0, materialized_payments_comparison_compile_helpers_1.compileTenantPaymentsComparisonReports)({
45
+ tenantId: TENANT,
46
+ brandId: BRAND,
47
+ localDate: '2026-09-13',
48
+ orders: ordersOf('2026-09-13'),
49
+ gmtOffset: OFFSET,
50
+ computedAt: AT,
51
+ });
52
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)(compiled.reports, {
53
+ collection: 'materialized_tenant_payments_comparison_reports',
54
+ });
55
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)(compiled.entries, {
56
+ collection: 'materialized_tenant_payments_comparison_entries',
57
+ });
58
+ });
59
+ it('the hourly comparison writer', () => {
60
+ const compiled = (0, materialized_hourly_comparison_compile_helpers_1.compileTenantHourlyComparisonReports)({
61
+ tenantId: TENANT,
62
+ brandId: BRAND,
63
+ localDate: '2026-09-13',
64
+ orders: ordersOf('2026-09-13'),
65
+ gmtOffset: OFFSET,
66
+ computedAt: AT,
67
+ });
68
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)(compiled.reports, {
69
+ collection: 'materialized_tenant_hourly_comparison_reports',
70
+ });
71
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)(compiled.entries, {
72
+ collection: 'materialized_tenant_hourly_comparison_entries',
73
+ });
74
+ });
75
+ it('the delivery writer', () => {
76
+ const compiled = (0, materialized_delivery_compile_helpers_1.compileTenantDeliveryReports)({
77
+ tenantId: TENANT,
78
+ brandId: BRAND,
79
+ localDate: '2026-09-13',
80
+ orders: [],
81
+ deliveries: [
82
+ {
83
+ _id: 'd-1',
84
+ tenant_id: TENANT,
85
+ order_id: 'order-1',
86
+ rider_id: 'rider-1',
87
+ rider_name: 'Sam',
88
+ status: 'COMPLETED',
89
+ createdAt: new Date('2026-09-13T10:05:00.000Z'),
90
+ updatedAt: new Date('2026-09-13T10:35:00.000Z'),
91
+ delivered_at: new Date('2026-09-13T10:32:00.000Z'),
92
+ // A distance in METRES — the source float becomes whole metres.
93
+ distance_in_meters_from_store: 3000.4,
94
+ rider_earnings: { amount: 700.4, status: 'FINAL' },
95
+ polyline: [[1, 2]],
96
+ localHour: 10,
97
+ localDate: '2026-09-13',
98
+ },
99
+ ],
100
+ gmtOffset: OFFSET,
101
+ computedAt: AT,
102
+ });
103
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)(compiled.reports, {
104
+ collection: 'materialized_tenant_delivery_reports',
105
+ });
106
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)(compiled.entries, {
107
+ collection: 'materialized_tenant_delivery_entries',
108
+ });
109
+ });
110
+ it('the credit-bill ledger writer', () => {
111
+ const orders = ordersOf('2026-09-13');
112
+ const issued = orders.flatMap((order) => (0, materialized_credit_bills_helpers_1.buildCreditBillIssuedCandidatesFromOrder)(order, '2026-09-13', {
113
+ now: AT,
114
+ gmtOffset: OFFSET,
115
+ }) ?? []);
116
+ const resolution = (0, materialized_credit_bills_helpers_1.resolveCreditBillDay)({
117
+ tenantId: TENANT,
118
+ brandId: BRAND,
119
+ localDate: '2026-09-13',
120
+ issued,
121
+ received_events: [],
122
+ settled_bills: [],
123
+ stored: [],
124
+ computedAt: AT,
125
+ });
126
+ const documents = (0, materialized_credit_bills_helpers_1.buildMaterializedCreditBillDayReports)({
127
+ tenantId: TENANT,
128
+ brandId: BRAND,
129
+ localDate: '2026-09-13',
130
+ resolution,
131
+ computedAt: AT,
132
+ });
133
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)(documents, {
134
+ collection: 'materialized_tenant_credit_bills',
135
+ });
136
+ });
137
+ it('the scope metadata of a materialized document stays integer', () => {
138
+ // `scope_field` is a STRING ("2026", "2026-09-15") — an identifier, not a
139
+ // number — and the contract must not flag it.
140
+ (0, materialized_integer_contract_1.assertIntegerOnlyDocuments)([
141
+ {
142
+ scope_context: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_MONTH,
143
+ scope_field: '2026-09',
144
+ day_index: '2026-09-15',
145
+ row_count: 3,
146
+ schema_version: 1,
147
+ },
148
+ ], { collection: 'materialized_report_drilldown_scopes' });
149
+ });
150
+ });
@@ -43,34 +43,34 @@ describe('sales-overview baseline — basha (2026-09)', () => {
43
43
  const overview = (0, sales_overview_reference_1.computeSalesOverviewReference)(orders, monthFilters);
44
44
  const totalSales = overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0];
45
45
  expect(totalSales).toMatchObject({ _id: BASHA, count: 2916 });
46
- expect(round2(totalSales.grossAmount)).toBe(30556084.25);
46
+ expect(round2(totalSales.grossAmount)).toBe(30556729);
47
47
  const cancelled = overview[constants_1.REPORT_TYPE_ENUM.CANCELLED_ORDERS][0];
48
48
  expect(cancelled).toMatchObject({ _id: BASHA, count: 15 });
49
- expect(round2(cancelled.grossAmount)).toBe(33959);
49
+ expect(round2(cancelled.grossAmount)).toBe(33962);
50
50
  // Every order in the fixture is either a sale or a cancelled order.
51
51
  expect(totalSales.count + cancelled.count).toBe(fixtures_1.ORDERS_DATASETS.basha.orderCount);
52
52
  });
53
53
  it('matches the pinned payments breakdown, including legacy CARD_PAYMENT', () => {
54
54
  const overview = (0, sales_overview_reference_1.computeSalesOverviewReference)(orders, monthFilters);
55
55
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_PAYMENT_SALES])).toEqual({
56
- CARD_PAYMENT: { count: 2433, grossAmount: 25798196.75 },
57
- CASH: { count: 459, grossAmount: 4534480.25 },
58
- UNPAID: { count: 20, grossAmount: 220427.25 },
56
+ CARD_PAYMENT: { count: 2433, grossAmount: 25798740 },
57
+ CASH: { count: 459, grossAmount: 4534577 },
58
+ UNPAID: { count: 20, grossAmount: 220432 },
59
59
  COMPLIMENTARY: { count: 4, grossAmount: 2980 },
60
60
  });
61
61
  });
62
62
  it('matches the pinned platform breakdown', () => {
63
63
  const overview = (0, sales_overview_reference_1.computeSalesOverviewReference)(orders, monthFilters);
64
64
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.SALES_BY_PLATFORM])).toEqual({
65
- 'APP_DINE-IN': { count: 2800, grossAmount: 29566435.75 },
66
- 'POS_TAKE-AWAY': { count: 50, grossAmount: 409101.5 },
67
- WEB_DELIVERY: { count: 28, grossAmount: 140931.5 },
68
- POS_DELIVERY: { count: 22, grossAmount: 332336 },
69
- 'WEB_TAKE-AWAY': { count: 5, grossAmount: 24071 },
70
- 'POS_DINE-IN': { count: 4, grossAmount: 14504.75 },
71
- 'POS_DRIVE-THRU': { count: 2, grossAmount: 10391.75 },
72
- POS_KIOSK: { count: 2, grossAmount: 23742.5 },
73
- 'WEB_DINE-IN': { count: 2, grossAmount: 25569.5 },
65
+ 'APP_DINE-IN': { count: 2800, grossAmount: 29567054 },
66
+ 'POS_TAKE-AWAY': { count: 50, grossAmount: 409113 },
67
+ WEB_DELIVERY: { count: 28, grossAmount: 140939 },
68
+ POS_DELIVERY: { count: 22, grossAmount: 332341 },
69
+ 'WEB_TAKE-AWAY': { count: 5, grossAmount: 24072 },
70
+ 'POS_DINE-IN': { count: 4, grossAmount: 14505 },
71
+ 'POS_DRIVE-THRU': { count: 2, grossAmount: 10392 },
72
+ POS_KIOSK: { count: 2, grossAmount: 23743 },
73
+ 'WEB_DINE-IN': { count: 2, grossAmount: 25570 },
74
74
  'POS_WALK-IN': { count: 1, grossAmount: 9000 },
75
75
  });
76
76
  });
@@ -117,14 +117,14 @@ describe('sales-overview baseline — basha (2026-09)', () => {
117
117
  });
118
118
  const totalSales = overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0];
119
119
  expect(totalSales.count).toBe(2906);
120
- expect(round2(totalSales.grossAmount)).toBe(30496919.25);
120
+ expect(round2(totalSales.grossAmount)).toBe(30497563);
121
121
  // No cancelled orders qualify; the UNPAID bucket carries the credit bills
122
122
  // + settled-later bills whose orders still collected > 0.
123
123
  expect(overview[constants_1.REPORT_TYPE_ENUM.CANCELLED_ORDERS]).toEqual([]);
124
124
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_PAYMENT_SALES])).toEqual({
125
- CARD_PAYMENT: { count: 2433, grossAmount: 25798196.75 },
126
- CASH: { count: 459, grossAmount: 4534480.25 },
127
- UNPAID: { count: 14, grossAmount: 164242.25 },
125
+ CARD_PAYMENT: { count: 2433, grossAmount: 25798740 },
126
+ CASH: { count: 459, grossAmount: 4534577 },
127
+ UNPAID: { count: 14, grossAmount: 164246 },
128
128
  });
129
129
  });
130
130
  it('returns credit bills (deferred settlement) for the sale type', () => {
@@ -133,10 +133,10 @@ describe('sales-overview baseline — basha (2026-09)', () => {
133
133
  saleType: constants_1.REPORT_SALE_TYPE_ENUM.CREDIT_BILLS,
134
134
  });
135
135
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES])).toEqual({
136
- [BASHA]: { count: 8, grossAmount: 97298.75 },
136
+ [BASHA]: { count: 8, grossAmount: 97301 },
137
137
  });
138
138
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_PAYMENT_SALES])).toEqual({
139
- UNPAID: { count: 8, grossAmount: 97298.75 },
139
+ UNPAID: { count: 8, grossAmount: 97301 },
140
140
  });
141
141
  });
142
142
  it('applies platform + order status filters together', () => {
@@ -146,15 +146,15 @@ describe('sales-overview baseline — basha (2026-09)', () => {
146
146
  orderStatuses: [constants_1.ORDER_STATUS_ENUM.COMPLETED, constants_1.ORDER_STATUS_ENUM.READY],
147
147
  });
148
148
  expect(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0]).toMatchObject({ count: 2789 });
149
- expect(round2(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0].grossAmount)).toBe(29422484.25);
149
+ expect(round2(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0].grossAmount)).toBe(29423101);
150
150
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_PAYMENT_SALES])).toEqual({
151
- CARD_PAYMENT: { count: 2355, grossAmount: 25152102.5 },
152
- CASH: { count: 416, grossAmount: 4109963.5 },
153
- UNPAID: { count: 14, grossAmount: 157438.25 },
151
+ CARD_PAYMENT: { count: 2355, grossAmount: 25152628 },
152
+ CASH: { count: 416, grossAmount: 4110051 },
153
+ UNPAID: { count: 14, grossAmount: 157442 },
154
154
  COMPLIMENTARY: { count: 4, grossAmount: 2980 },
155
155
  });
156
156
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.SALES_BY_PLATFORM])).toEqual({
157
- 'APP_DINE-IN': { count: 2789, grossAmount: 29422484.25 },
157
+ 'APP_DINE-IN': { count: 2789, grossAmount: 29423101 },
158
158
  });
159
159
  expect(overview[constants_1.REPORT_TYPE_ENUM.CANCELLED_ORDERS]).toEqual([]);
160
160
  });
@@ -177,22 +177,22 @@ describe('sales-overview baseline — bruzo (2026-09)', () => {
177
177
  const overview = (0, sales_overview_reference_1.computeSalesOverviewReference)(orders, monthFilters);
178
178
  const totalSales = overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0];
179
179
  expect(totalSales).toMatchObject({ _id: BRUZO, count: 2070 });
180
- expect(round2(totalSales.grossAmount)).toBe(2662179.24);
180
+ expect(round2(totalSales.grossAmount)).toBe(2662177);
181
181
  const cancelled = overview[constants_1.REPORT_TYPE_ENUM.CANCELLED_ORDERS][0];
182
182
  expect(cancelled).toMatchObject({ _id: BRUZO, count: 96 });
183
- expect(round2(cancelled.grossAmount)).toBe(112570.95);
183
+ expect(round2(cancelled.grossAmount)).toBe(112571);
184
184
  expect(totalSales.count + cancelled.count).toBe(fixtures_1.ORDERS_DATASETS.bruzo.orderCount);
185
185
  });
186
186
  it('matches the pinned payments breakdown (aggregator + legacy payment types pass through)', () => {
187
187
  const overview = (0, sales_overview_reference_1.computeSalesOverviewReference)(orders, monthFilters);
188
188
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_PAYMENT_SALES])).toEqual({
189
- CASH: { count: 770, grossAmount: 936933.67 },
190
- ONLINE: { count: 511, grossAmount: 577492.97 },
191
- CARD_PAYMENT: { count: 353, grossAmount: 600670.94 },
192
- FOODPANDA: { count: 309, grossAmount: 372893.56 },
193
- PLAZA: { count: 61, grossAmount: 83809.65 },
189
+ CASH: { count: 770, grossAmount: 936932 },
190
+ ONLINE: { count: 511, grossAmount: 577493 },
191
+ CARD_PAYMENT: { count: 353, grossAmount: 600671 },
192
+ FOODPANDA: { count: 309, grossAmount: 372894 },
193
+ PLAZA: { count: 61, grossAmount: 83809 },
194
194
  COMPLIMENTARY: { count: 41, grossAmount: 43165 },
195
- UNPAID: { count: 19, grossAmount: 29067.45 },
195
+ UNPAID: { count: 19, grossAmount: 29067 },
196
196
  MARKETING: { count: 4, grossAmount: 15078 },
197
197
  GOLOOTLO: { count: 2, grossAmount: 3068 },
198
198
  });
@@ -200,15 +200,15 @@ describe('sales-overview baseline — bruzo (2026-09)', () => {
200
200
  it('matches the pinned platform breakdown', () => {
201
201
  const overview = (0, sales_overview_reference_1.computeSalesOverviewReference)(orders, monthFilters);
202
202
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.SALES_BY_PLATFORM])).toEqual({
203
- 'POS_TAKE-AWAY': { count: 414, grossAmount: 465827.39 },
203
+ 'POS_TAKE-AWAY': { count: 414, grossAmount: 465826 },
204
204
  APP_DELIVERY: { count: 395, grossAmount: 496541 },
205
- 'POS_DINE-IN': { count: 388, grossAmount: 640803.04 },
206
- WEB_DELIVERY: { count: 342, grossAmount: 391438.95 },
207
- 'FOODPANDA_TAKE-AWAY': { count: 311, grossAmount: 375639.56 },
205
+ 'POS_DINE-IN': { count: 388, grossAmount: 640803 },
206
+ WEB_DELIVERY: { count: 342, grossAmount: 391439 },
207
+ 'FOODPANDA_TAKE-AWAY': { count: 311, grossAmount: 375640 },
208
208
  'APP_DINE-IN': { count: 80, grossAmount: 132715 },
209
209
  'APP_TAKE-AWAY': { count: 63, grossAmount: 73220 },
210
- POS_DELIVERY: { count: 41, grossAmount: 50899.7 },
211
- 'WEB_TAKE-AWAY': { count: 28, grossAmount: 26567.6 },
210
+ POS_DELIVERY: { count: 41, grossAmount: 50899 },
211
+ 'WEB_TAKE-AWAY': { count: 28, grossAmount: 26567 },
212
212
  FOODPANDA_DELIVERY: { count: 2, grossAmount: 2286 },
213
213
  'POS_WALK-IN': { count: 2, grossAmount: 1186 },
214
214
  TALABAT_DELIVERY: { count: 2, grossAmount: 2146 },
@@ -265,17 +265,17 @@ describe('sales-overview baseline — bruzo (2026-09)', () => {
265
265
  saleType: constants_1.REPORT_SALE_TYPE_ENUM.AMOUNT_COLLECTED,
266
266
  });
267
267
  expect(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0].count).toBe(2023);
268
- expect(round2(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0].grossAmount)).toBe(2613397.24);
268
+ expect(round2(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0].grossAmount)).toBe(2613395);
269
269
  expect(overview[constants_1.REPORT_TYPE_ENUM.CANCELLED_ORDERS]).toEqual([]);
270
270
  // COMPLIMENTARY orders drop out of the collected view; the UNPAID bucket
271
271
  // carries the credit bills + settled-later bills whose orders collected > 0.
272
272
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_PAYMENT_SALES])).toEqual({
273
- CASH: { count: 770, grossAmount: 936933.67 },
274
- ONLINE: { count: 511, grossAmount: 577492.97 },
275
- CARD_PAYMENT: { count: 353, grossAmount: 600670.94 },
276
- FOODPANDA: { count: 309, grossAmount: 372893.56 },
277
- PLAZA: { count: 61, grossAmount: 83809.65 },
278
- UNPAID: { count: 13, grossAmount: 23450.45 },
273
+ CASH: { count: 770, grossAmount: 936932 },
274
+ ONLINE: { count: 511, grossAmount: 577493 },
275
+ CARD_PAYMENT: { count: 353, grossAmount: 600671 },
276
+ FOODPANDA: { count: 309, grossAmount: 372894 },
277
+ PLAZA: { count: 61, grossAmount: 83809 },
278
+ UNPAID: { count: 13, grossAmount: 23450 },
279
279
  MARKETING: { count: 4, grossAmount: 15078 },
280
280
  GOLOOTLO: { count: 2, grossAmount: 3068 },
281
281
  });
@@ -286,10 +286,10 @@ describe('sales-overview baseline — bruzo (2026-09)', () => {
286
286
  saleType: constants_1.REPORT_SALE_TYPE_ENUM.CREDIT_BILLS,
287
287
  });
288
288
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES])).toEqual({
289
- [BRUZO]: { count: 8, grossAmount: 13948.45 },
289
+ [BRUZO]: { count: 8, grossAmount: 13948 },
290
290
  });
291
291
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_PAYMENT_SALES])).toEqual({
292
- UNPAID: { count: 8, grossAmount: 13948.45 },
292
+ UNPAID: { count: 8, grossAmount: 13948 },
293
293
  });
294
294
  });
295
295
  it('applies platform + order status filters together (aggregator store)', () => {
@@ -299,14 +299,14 @@ describe('sales-overview baseline — bruzo (2026-09)', () => {
299
299
  orderStatuses: [constants_1.ORDER_STATUS_ENUM.COMPLETED, constants_1.ORDER_STATUS_ENUM.CANCELLED],
300
300
  });
301
301
  expect(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0]).toMatchObject({ count: 310 });
302
- expect(round2(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0].grossAmount)).toBe(374990.56);
302
+ expect(round2(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_SALES][0].grossAmount)).toBe(374991);
303
303
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.TOTAL_PAYMENT_SALES])).toEqual({
304
- FOODPANDA: { count: 308, grossAmount: 372244.56 },
304
+ FOODPANDA: { count: 308, grossAmount: 372245 },
305
305
  PLAZA: { count: 1, grossAmount: 1648 },
306
306
  UNPAID: { count: 1, grossAmount: 1098 },
307
307
  });
308
308
  expect(toSummaryMap(overview[constants_1.REPORT_TYPE_ENUM.SALES_BY_PLATFORM])).toEqual({
309
- 'FOODPANDA_TAKE-AWAY': { count: 310, grossAmount: 374990.56 },
309
+ 'FOODPANDA_TAKE-AWAY': { count: 310, grossAmount: 374991 },
310
310
  });
311
311
  const cancelled = overview[constants_1.REPORT_TYPE_ENUM.CANCELLED_ORDERS][0];
312
312
  expect(cancelled).toMatchObject({ count: 2 });
@@ -15,7 +15,10 @@ const row = (over = {}) => ({
15
15
  level: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_LEVEL_ENUM.ORDER,
16
16
  slot: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_SLOT_ENUM.SPECIAL,
17
17
  sub_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_SUB_KIND_ENUM.COLLECTION,
18
- rate: 15,
18
+ // NO stored rate: the source keeps the integer SUM of its percentage rates
19
+ // (in BASIS POINTS, 1% = 100 bps) and the COUNT of its percentage rows.
20
+ percentage_rate_sum: 15000,
21
+ percentage_row_count: 10,
19
22
  rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.PERCENTAGE,
20
23
  order_count: 10,
21
24
  row_count: 10,
@@ -44,7 +47,8 @@ describe('getFormattedTenantDiscountSources', () => {
44
47
  source_name: 'Manual / quick discount',
45
48
  source_class: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_SOURCE_CLASS_ENUM.MANUAL,
46
49
  discount_amount: 50000,
47
- rate: null,
50
+ percentage_rate_sum: null,
51
+ percentage_row_count: null,
48
52
  rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.MIXED,
49
53
  }),
50
54
  row({
@@ -81,15 +85,17 @@ describe('getFormattedTenantDiscountSources', () => {
81
85
  it('renders rate labels: percentage, mixed and fixed', () => {
82
86
  const formatted = (0, tenant_discount_source_formatter_1.getFormattedTenantDiscountSources)([
83
87
  report([
84
- row({ rate: 15, rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.PERCENTAGE }),
88
+ row({ percentage_rate_sum: 15000, percentage_row_count: 10, rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.PERCENTAGE }),
85
89
  row({
86
90
  source_key: 'manual:item',
87
- rate: null,
91
+ percentage_rate_sum: null,
92
+ percentage_row_count: null,
88
93
  rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.MIXED,
89
94
  }),
90
95
  row({
91
96
  source_key: 'price_override:item',
92
- rate: null,
97
+ percentage_rate_sum: null,
98
+ percentage_row_count: null,
93
99
  rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.FIXED,
94
100
  }),
95
101
  ]),
@@ -97,6 +103,78 @@ describe('getFormattedTenantDiscountSources', () => {
97
103
  expect(formatted.sources.find((source) => source.source_key === 'discount:a')?.rate_label).toBe('15%');
98
104
  expect(formatted.sources.find((source) => source.source_key === 'manual:item')?.rate_label).toBe('mixed');
99
105
  expect(formatted.sources.find((source) => source.source_key === 'price_override:item')?.rate_label).toBe('—');
106
+ // The rate kind has its own label so a view can show it without parsing.
107
+ expect(formatted.sources.find((source) => source.source_key === 'discount:a')?.rate_kind_label).toBe('Percentage');
108
+ expect(formatted.sources.find((source) => source.source_key === 'manual:item')?.rate_kind_label).toBe('Mixed');
109
+ expect(formatted.sources.find((source) => source.source_key === 'price_override:item')?.rate_kind_label).toBe('Fixed');
110
+ });
111
+ it('derives the rate from the integer sum/count (5000 / 1 -> 50%)', () => {
112
+ const formatted = (0, tenant_discount_source_formatter_1.getFormattedTenantDiscountSources)([
113
+ report([
114
+ row({
115
+ percentage_rate_sum: 5000,
116
+ percentage_row_count: 1,
117
+ rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.PERCENTAGE,
118
+ }),
119
+ ]),
120
+ ]);
121
+ const source = formatted.sources[0];
122
+ expect(source.rate_label).toBe('50%');
123
+ expect(source.rate_percent).toBe(50);
124
+ // The formatted rate is the DERIVED average (basis points), not a stored field.
125
+ expect(source.rate).toBe(5000);
126
+ });
127
+ it('derives 2000 / 2 -> 10% from the integer sum/count', () => {
128
+ // 2000 basis points is the SUM of two 10% rows -> 1000 bps -> 10%.
129
+ const formatted = (0, tenant_discount_source_formatter_1.getFormattedTenantDiscountSources)([
130
+ report([
131
+ row({
132
+ percentage_rate_sum: 2000,
133
+ percentage_row_count: 2,
134
+ rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.PERCENTAGE,
135
+ }),
136
+ ]),
137
+ ]);
138
+ const source = formatted.sources[0];
139
+ expect(source.rate_percent).toBe(10);
140
+ expect(source.rate_label).toBe('10%');
141
+ });
142
+ it('derives the EXACT average from the integer sum/count', () => {
143
+ const formatted = (0, tenant_discount_source_formatter_1.getFormattedTenantDiscountSources)([
144
+ report([
145
+ row({
146
+ percentage_rate_sum: 5000,
147
+ percentage_row_count: 3,
148
+ rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.PERCENTAGE,
149
+ }),
150
+ ]),
151
+ ]);
152
+ const source = formatted.sources[0];
153
+ // 5000 / 3 bps = 16.6667% — the formatter derives it from the integers.
154
+ expect(source.rate_percent).toBeCloseTo(16.6667, 4);
155
+ expect(source.rate_label).toBe('16.67%');
156
+ });
157
+ it('keeps "mixed" and "—" when normalising (the rate kind wins)', () => {
158
+ const formatted = (0, tenant_discount_source_formatter_1.getFormattedTenantDiscountSources)([
159
+ report([
160
+ row({ source_key: 'discount:a', percentage_rate_sum: null, percentage_row_count: null, rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.MIXED }),
161
+ row({
162
+ source_key: 'discount:b',
163
+ percentage_rate_sum: null,
164
+ percentage_row_count: null,
165
+ rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.PERCENTAGE,
166
+ }),
167
+ row({
168
+ source_key: 'discount:c',
169
+ percentage_rate_sum: null,
170
+ percentage_row_count: null,
171
+ rate_kind: MATERIALIZED_REPORTS_1.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM.FIXED,
172
+ }),
173
+ ]),
174
+ ]);
175
+ expect(formatted.sources.find((source) => source.source_key === 'discount:a')?.rate_label).toBe('mixed');
176
+ expect(formatted.sources.find((source) => source.source_key === 'discount:b')?.rate_label).toBe('—');
177
+ expect(formatted.sources.find((source) => source.source_key === 'discount:c')?.rate_label).toBe('—');
100
178
  });
101
179
  it('folds multiple tenants into ONE page', () => {
102
180
  const formatted = (0, tenant_discount_source_formatter_1.getFormattedTenantDiscountSources)([
@@ -177,6 +255,31 @@ describe('getFormattedTenantDiscountSources', () => {
177
255
  expect((0, tenant_discount_source_formatter_1.getFormattedTenantDiscountSources)([null])).toBeNull();
178
256
  });
179
257
  });
258
+ describe('the stored rate is BASIS POINTS (no magnitude heuristic)', () => {
259
+ it('converts every production rate shape', () => {
260
+ const formatted = (0, tenant_discount_source_formatter_1.getFormattedTenantDiscountSources)([
261
+ report([
262
+ row({ source_key: 'a', percentage_rate_sum: 5000, percentage_row_count: 1 }),
263
+ row({ source_key: 'b', percentage_rate_sum: 2000, percentage_row_count: 1 }),
264
+ row({ source_key: 'c', percentage_rate_sum: 1500, percentage_row_count: 1 }),
265
+ row({ source_key: 'd', percentage_rate_sum: 10000, percentage_row_count: 1 }),
266
+ row({ source_key: 'e', percentage_rate_sum: 15000, percentage_row_count: 10 }),
267
+ row({ source_key: 'f', percentage_rate_sum: null, percentage_row_count: null }),
268
+ ]),
269
+ ]);
270
+ const labels = Object.fromEntries(formatted.sources.map((source) => [source.source_key, source.rate_label]));
271
+ expect(labels).toEqual({ a: '50%', b: '20%', c: '15%', d: '100%', e: '15%', f: '—' });
272
+ });
273
+ it('never guesses the unit from the magnitude of a value', () => {
274
+ // 100 bps is 1% — NOT "100%" and not "1". The unit is fixed by the
275
+ // contract, so the same division applies to every value.
276
+ const formatted = (0, tenant_discount_source_formatter_1.getFormattedTenantDiscountSources)([
277
+ report([row({ percentage_rate_sum: 100, percentage_row_count: 1 })]),
278
+ ]);
279
+ expect(formatted.sources[0].rate_label).toBe('1%');
280
+ expect(formatted.sources[0].rate_percent).toBe(1);
281
+ });
282
+ });
180
283
  describe('getDiscountSourceShareReconciliation', () => {
181
284
  it('reports an unattributed GAP when summary > source', () => {
182
285
  const result = (0, tenant_discount_source_formatter_1.getDiscountSourceShareReconciliation)(3000, 1500);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@managesome/eposmatic-toolkit",
3
- "version": "0.4.25",
3
+ "version": "0.4.27",
4
4
  "description": "A Toolkit Library for Eposmatic",
5
5
  "main": "lib/index.js",
6
6
  "module": "esm/index.js",