@managesome/eposmatic-toolkit 0.4.10 → 0.4.11

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 (90) hide show
  1. package/esm/constants/MATERIALIZED_REPORTS.js +7 -0
  2. package/esm/constants/enums/delivery.js +8 -0
  3. package/esm/helpers/materialized-reports/materialized-cash-classification-helpers.js +5 -43
  4. package/esm/helpers/materialized-reports/materialized-cash-close-day-helpers.js +3 -3
  5. package/esm/helpers/materialized-reports/materialized-cash-compile-helpers.js +5 -4
  6. package/esm/helpers/materialized-reports/materialized-delivery-classification-helpers.js +6 -2
  7. package/esm/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +3 -2
  8. package/esm/helpers/materialized-reports/materialized-delivery-compile-helpers.js +10 -8
  9. package/esm/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +2 -1
  10. package/esm/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +7 -3
  11. package/esm/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +2 -1
  12. package/esm/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +15 -14
  13. package/esm/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +2 -2
  14. package/esm/helpers/materialized-reports/materialized-reports-scope-group-helpers.js +9 -6
  15. package/esm/helpers/materialized-reports/materialized-reports-selection-helpers.js +4 -4
  16. package/esm/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +5 -6
  17. package/esm/helpers/materialized-reports/tenant-cash-in-out-formatter.js +2 -1
  18. package/esm/helpers/materialized-reports/tenant-delivery-formatter.js +2 -2
  19. package/esm/helpers/materialized-reports/tenant-discount-formatter.js +2 -2
  20. package/esm/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +3 -2
  21. package/esm/helpers/materialized-reports/tenant-payments-comparison-formatter.js +7 -4
  22. package/esm/helpers/materialized-reports/tenant-sales-comparison-formatter.js +7 -4
  23. package/esm/helpers/reporting-contract/overview-contract.js +5 -4
  24. package/esm/helpers/rider-earnings/rider-earnings.js +0 -6
  25. package/esm/helpers/rider-reports/rider-daily-report.js +2 -2
  26. package/esm/helpers/store/common-order-actions.js +3 -2
  27. package/esm/schemas/models/deliveries.js +11 -5
  28. package/esm/schemas/models/materialized_credit_bills.js +1 -1
  29. package/esm/schemas/models/materialized_tenant_sales_overview_reports.js +1 -1
  30. package/lib/constants/MATERIALIZED_REPORTS.d.ts +6 -0
  31. package/lib/constants/MATERIALIZED_REPORTS.js +9 -2
  32. package/lib/constants/enums/delivery.d.ts +7 -0
  33. package/lib/constants/enums/delivery.js +9 -1
  34. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.d.ts +55 -3
  35. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.js +4 -42
  36. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.d.ts +2 -1
  37. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.js +2 -2
  38. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.d.ts +3 -2
  39. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.js +4 -3
  40. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.d.ts +32 -3
  41. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.js +5 -1
  42. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.d.ts +2 -1
  43. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +8 -7
  44. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.d.ts +4 -3
  45. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +8 -6
  46. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +2 -1
  47. package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +6 -2
  48. package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +2 -1
  49. package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.d.ts +34 -2
  50. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.d.ts +7 -5
  51. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +14 -13
  52. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.d.ts +2 -1
  53. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +1 -1
  54. package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.d.ts +6 -3
  55. package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.js +8 -5
  56. package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.js +2 -2
  57. package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +3 -4
  58. package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.js +2 -1
  59. package/lib/helpers/materialized-reports/tenant-delivery-formatter.js +1 -1
  60. package/lib/helpers/materialized-reports/tenant-discount-formatter.js +1 -1
  61. package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +3 -2
  62. package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.js +7 -4
  63. package/lib/helpers/materialized-reports/tenant-prep-time-formatter.d.ts +2 -1
  64. package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.js +7 -4
  65. package/lib/helpers/reporting-contract/overview-contract.js +5 -4
  66. package/lib/helpers/rider-earnings/rider-earnings.d.ts +0 -7
  67. package/lib/helpers/rider-earnings/rider-earnings.js +0 -7
  68. package/lib/helpers/rider-reports/rider-daily-report.d.ts +4 -2
  69. package/lib/helpers/rider-reports/rider-daily-report.js +1 -1
  70. package/lib/helpers/store/common-order-actions.js +3 -2
  71. package/lib/helpers/types/materialized-reports-apis.d.ts +3 -0
  72. package/lib/schemas/models/deliveries.d.ts +10 -7
  73. package/lib/schemas/models/deliveries.js +10 -4
  74. package/lib/schemas/models/materialized_credit_bills.d.ts +3 -3
  75. package/lib/schemas/models/materialized_credit_bills.js +1 -1
  76. package/lib/schemas/models/materialized_tenant_sales_overview_reports.d.ts +3 -3
  77. package/lib/schemas/models/materialized_tenant_sales_overview_reports.js +1 -1
  78. package/lib/schemas/types/deliveries.d.ts +2 -2
  79. package/lib/schemas/types/materialized_tenant_sales_overview_reports.d.ts +7 -0
  80. package/lib/tests/deliveries-schema.test.d.ts +1 -0
  81. package/lib/tests/deliveries-schema.test.js +70 -0
  82. package/lib/tests/materialized-reports/materialized-cash-compile.test.js +2 -1
  83. package/lib/tests/materialized-reports/materialized-cash-formatter.test.js +2 -1
  84. package/lib/tests/materialized-reports/materialized-delivery-compile.test.js +7 -6
  85. package/lib/tests/materialized-reports/materialized-delivery-formatter.test.js +2 -1
  86. package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.js +7 -6
  87. package/lib/tests/materialized-reports/materialized-reports-scope-group-helpers.test.js +13 -13
  88. package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.js +2 -1
  89. package/lib/tests/rider-daily-report.test.js +3 -3
  90. package/package.json +1 -1
@@ -88,7 +88,7 @@ describe('buildMaterializedReportScopeGroups', () => {
88
88
  test('RECURRING window → the same hours on every selected day (one localHour group)', () => {
89
89
  const groups = (0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
90
90
  days: ['2026-09-01', '2026-09-02'],
91
- window: { fromHour: 18, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.RECURRING },
91
+ window: { fromHour: 18, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.RECURRING },
92
92
  });
93
93
  expect(groups).toEqual([
94
94
  {
@@ -109,7 +109,7 @@ describe('buildMaterializedReportScopeGroups', () => {
109
109
  test('SPAN window over a month → boundary hours + compacted middle days', () => {
110
110
  const groups = (0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
111
111
  days: range('2026-09-01', '2026-09-30'),
112
- window: { fromHour: 18, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.SPAN },
112
+ window: { fromHour: 18, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.SPAN },
113
113
  });
114
114
  expect(groups).toEqual([
115
115
  {
@@ -162,7 +162,7 @@ describe('buildMaterializedReportScopeGroups', () => {
162
162
  test('SPAN window over two adjacent days → boundary hours only', () => {
163
163
  const groups = (0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
164
164
  days: ['2026-09-10', '2026-09-11'],
165
- window: { fromHour: 18, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.SPAN },
165
+ window: { fromHour: 18, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.SPAN },
166
166
  });
167
167
  const hours = groups?.find((group) => group.scope_context === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_HOUR);
168
168
  expect(hours?.scope_field).toHaveLength(28); // 12 start + 16 end
@@ -174,18 +174,18 @@ describe('buildMaterializedReportScopeGroups', () => {
174
174
  test('SPAN with a NON-CONTIGUOUS day set → null (never read gap days)', () => {
175
175
  expect((0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
176
176
  days: ['2026-09-10', '2026-09-14'],
177
- window: { fromHour: 18, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.SPAN },
177
+ window: { fromHour: 18, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.SPAN },
178
178
  })).toBeNull();
179
179
  // …sorted/gapped input is normalized first — still rejected
180
180
  expect((0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
181
181
  days: ['2026-09-14', '2026-09-10', '2026-09-10'],
182
- window: { fromHour: 18, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.SPAN },
182
+ window: { fromHour: 18, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.SPAN },
183
183
  })).toBeNull();
184
184
  });
185
185
  test('RECURRING tolerates gaps (same hours on every selected day)', () => {
186
186
  const groups = (0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
187
187
  days: ['2026-09-10', '2026-09-14'],
188
- window: { fromHour: 18, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.RECURRING },
188
+ window: { fromHour: 18, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.RECURRING },
189
189
  });
190
190
  expect(groups).toHaveLength(1);
191
191
  expect(groups?.[0].scope_context).toBe(MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_HOUR);
@@ -194,7 +194,7 @@ describe('buildMaterializedReportScopeGroups', () => {
194
194
  test('SPAN with a full-day boundary (x = 06:00) folds the start day into the day set', () => {
195
195
  const groups = (0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
196
196
  days: range('2026-09-01', '2026-09-30'),
197
- window: { fromHour: 6, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.SPAN },
197
+ window: { fromHour: 6, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.SPAN },
198
198
  });
199
199
  // start day full → middle Sep 1–29 compacts; end day 06:00 → 22:00 stays hourly
200
200
  const weeks = groups?.find((group) => group.scope_context === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_WEEK);
@@ -209,7 +209,7 @@ describe('buildMaterializedReportScopeGroups', () => {
209
209
  test('SPAN with a pre-06:00 start belongs to the previous business day tail', () => {
210
210
  const groups = (0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
211
211
  days: ['2026-09-10', '2026-09-11'],
212
- window: { fromHour: 4, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.SPAN },
212
+ window: { fromHour: 4, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.SPAN },
213
213
  });
214
214
  const hours = groups?.find((group) => group.scope_context === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_HOUR);
215
215
  expect(hours?.scope_field).toContain('2026-09-09 04');
@@ -221,7 +221,7 @@ describe('buildMaterializedReportScopeGroups', () => {
221
221
  test('SPAN on a single day with an overnight window (18:00 → 2:00)', () => {
222
222
  const groups = (0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
223
223
  days: ['2026-09-10'],
224
- window: { fromHour: 18, toHour: 2, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.SPAN },
224
+ window: { fromHour: 18, toHour: 2, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.SPAN },
225
225
  });
226
226
  expect(groups).toEqual([
227
227
  {
@@ -243,14 +243,14 @@ describe('buildMaterializedReportScopeGroups', () => {
243
243
  test('SPAN 06:00 → 06:00 on a single day is the full day', () => {
244
244
  const groups = (0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
245
245
  days: ['2026-09-10'],
246
- window: { fromHour: 6, toHour: 6, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.SPAN },
246
+ window: { fromHour: 6, toHour: 6, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.SPAN },
247
247
  });
248
248
  expect(groups).toEqual([{ scope_context: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_DATE, scope_field: ['2026-09-10'] }]);
249
249
  });
250
250
  test('groups never overlap and everything requested is covered exactly once', () => {
251
251
  const groups = (0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
252
252
  days: range('2026-09-01', '2026-09-30'),
253
- window: { fromHour: 18, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.SPAN },
253
+ window: { fromHour: 18, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.SPAN },
254
254
  });
255
255
  const all = (groups ?? []).flatMap((group) => group.scope_field);
256
256
  // no duplicate values across groups
@@ -264,12 +264,12 @@ describe('buildMaterializedReportScopeGroups', () => {
264
264
  expect((0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({ days: ['bad'] })).toBeNull();
265
265
  expect((0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
266
266
  days: ['2026-09-01'],
267
- window: { fromHour: 24, toHour: 22, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.RECURRING },
267
+ window: { fromHour: 24, toHour: 22, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.RECURRING },
268
268
  })).toBeNull();
269
269
  // recurring window crossing the 06:00 business-morning boundary is invalid
270
270
  expect((0, materialized_reports_scope_group_helpers_1.buildMaterializedReportScopeGroups)({
271
271
  days: ['2026-09-01'],
272
- window: { fromHour: 4, toHour: 8, kind: materialized_reports_scope_group_helpers_1.MATERIALIZED_REPORT_WINDOW_KIND.RECURRING },
272
+ window: { fromHour: 4, toHour: 8, kind: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_WINDOW_KIND_ENUM.RECURRING },
273
273
  })).toBeNull();
274
274
  });
275
275
  });
@@ -1,5 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ const ENUMS_1 = require("../../constants/ENUMS");
3
4
  const materialized_sales_comparison_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-sales-comparison-compile-helpers");
4
5
  const materialized_sales_comparison_accumulator_helpers_1 = require("../../helpers/materialized-reports/materialized-sales-comparison-accumulator-helpers");
5
6
  /**
@@ -136,7 +137,7 @@ describe('sales comparison day compile', () => {
136
137
  expect(onPunchDay.skippedForeignOrders).toBe(1);
137
138
  const onSettledDay = compile({ localDate: '2026-09-15', orders: [settled] });
138
139
  expect(onSettledDay.reports[0].scope_field).toBe('2026-09-15');
139
- expect(onSettledDay.reports[0].day_index).toBe('TUE');
140
+ expect(onSettledDay.reports[0].day_index).toBe(ENUMS_1.DAY_INDEX_ENUM.TUE);
140
141
  });
141
142
  it('resolves the tenant-local settled date with the tenant offset', () => {
142
143
  expect((0, materialized_sales_comparison_accumulator_helpers_1.getSalesComparisonSettledLocalDate)({ order_settled_at: new Date('2026-09-14T20:00:00.000Z') }, OFFSET)).toBe('2026-09-15');
@@ -10,7 +10,7 @@ const delivery = (over = {}) => ({
10
10
  expected_delivery_at: '2026-10-19T11:00:00.000Z',
11
11
  delivered_at: '2026-10-19T10:50:00.000Z',
12
12
  rider_revenue: 900,
13
- rider_earnings: { amount: 900, status: 'FINAL' },
13
+ rider_earnings: { amount: 900, status: delivery_1.RIDER_EARNINGS_STATUS_ENUM.FINAL },
14
14
  ...over,
15
15
  });
16
16
  describe('buildRiderDailyReport', () => {
@@ -32,7 +32,7 @@ describe('buildRiderDailyReport', () => {
32
32
  _id: 'c',
33
33
  status: delivery_1.DELIVERY_STATUS_ENUM.CANCELLED,
34
34
  rider_revenue: 0,
35
- rider_earnings: { amount: 0, status: 'VOID' },
35
+ rider_earnings: { amount: 0, status: delivery_1.RIDER_EARNINGS_STATUS_ENUM.VOID },
36
36
  }),
37
37
  ],
38
38
  });
@@ -52,7 +52,7 @@ describe('buildRiderDailyReport', () => {
52
52
  deliveries: [
53
53
  delivery({
54
54
  rider_revenue: 900,
55
- rider_earnings: { amount: 900, status: 'PENDING' },
55
+ rider_earnings: { amount: 900, status: delivery_1.RIDER_EARNINGS_STATUS_ENUM.PENDING },
56
56
  }),
57
57
  ],
58
58
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@managesome/eposmatic-toolkit",
3
- "version": "0.4.10",
3
+ "version": "0.4.11",
4
4
  "description": "A Toolkit Library for Eposmatic",
5
5
  "main": "lib/index.js",
6
6
  "module": "esm/index.js",