@managesome/eposmatic-toolkit 0.4.61 → 0.4.63

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 (122) hide show
  1. package/esm/constants/MATERIALIZED_REPORTS.js +77 -0
  2. package/esm/constants/MATERIALIZED_SCHEMA_VERSIONS.js +17 -0
  3. package/esm/constants/TENANT_ENUMS.js +15 -0
  4. package/esm/constants/WORKER_ENDPOINTS.js +14 -2
  5. package/esm/helpers/materialized-reports/index.js +4 -0
  6. package/esm/helpers/materialized-reports/materialized-credit-bills-helpers.js +3 -3
  7. package/esm/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +5 -5
  8. package/esm/helpers/materialized-reports/materialized-delivery-compile-helpers.js +2 -2
  9. package/esm/helpers/materialized-reports/materialized-dialer-close-day-helpers.js +5 -5
  10. package/esm/helpers/materialized-reports/materialized-dialer-compile-helpers.js +2 -2
  11. package/esm/helpers/materialized-reports/materialized-dinein-close-day-helpers.js +5 -5
  12. package/esm/helpers/materialized-reports/materialized-dinein-compile-helpers.js +2 -2
  13. package/esm/helpers/materialized-reports/materialized-discount-compile-helpers.js +3 -3
  14. package/esm/helpers/materialized-reports/materialized-document-size.js +2 -2
  15. package/esm/helpers/materialized-reports/materialized-index-bootstrap.js +3 -1
  16. package/esm/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +3 -3
  17. package/esm/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +3 -3
  18. package/esm/helpers/materialized-reports/materialized-report-runs.js +143 -0
  19. package/esm/helpers/materialized-reports/report-compile.js +38 -0
  20. package/esm/helpers/materialized-reports/tenant-sales-overview-bson.js +27 -0
  21. package/esm/helpers/materialized-reports/tenant-sales-overview-helpers.js +3 -22
  22. package/esm/schemas/models/index.js +1 -0
  23. package/esm/schemas/models/materialized_credit_bills.js +2 -1
  24. package/esm/schemas/models/materialized_tenant_delivery_entries.js +2 -1
  25. package/esm/schemas/models/materialized_tenant_delivery_reports.js +2 -1
  26. package/esm/schemas/models/materialized_tenant_dialer_entries.js +2 -1
  27. package/esm/schemas/models/materialized_tenant_dialer_reports.js +2 -1
  28. package/esm/schemas/models/materialized_tenant_dinein_entries.js +2 -1
  29. package/esm/schemas/models/materialized_tenant_dinein_reports.js +2 -1
  30. package/esm/schemas/models/materialized_tenant_report_runs.js +105 -0
  31. package/esm/schemas/models/materialized_tenant_sales_overview_reports.js +2 -1
  32. package/esm/schemas/models/tenant_active_jobs.js +19 -1
  33. package/esm/schemas/types/index.js +1 -0
  34. package/lib/constants/MATERIALIZED_REPORTS.d.ts +69 -0
  35. package/lib/constants/MATERIALIZED_REPORTS.js +78 -1
  36. package/lib/constants/MATERIALIZED_SCHEMA_VERSIONS.d.ts +17 -0
  37. package/lib/constants/MATERIALIZED_SCHEMA_VERSIONS.js +20 -0
  38. package/lib/constants/TENANT_ENUMS.d.ts +14 -0
  39. package/lib/constants/TENANT_ENUMS.js +16 -1
  40. package/lib/constants/WORKER_ENDPOINTS.d.ts +12 -2
  41. package/lib/constants/WORKER_ENDPOINTS.js +14 -2
  42. package/lib/helpers/materialized-reports/index.d.ts +3 -0
  43. package/lib/helpers/materialized-reports/index.js +27 -0
  44. package/lib/helpers/materialized-reports/materialized-credit-bills-helpers.js +4 -4
  45. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +6 -6
  46. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +4 -4
  47. package/lib/helpers/materialized-reports/materialized-dialer-close-day-helpers.js +6 -6
  48. package/lib/helpers/materialized-reports/materialized-dialer-compile-helpers.js +6 -6
  49. package/lib/helpers/materialized-reports/materialized-dinein-close-day-helpers.js +6 -6
  50. package/lib/helpers/materialized-reports/materialized-dinein-compile-helpers.js +6 -6
  51. package/lib/helpers/materialized-reports/materialized-discount-compile-helpers.js +3 -3
  52. package/lib/helpers/materialized-reports/materialized-document-size.js +2 -5
  53. package/lib/helpers/materialized-reports/materialized-index-bootstrap.js +2 -0
  54. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +3 -3
  55. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +3 -3
  56. package/lib/helpers/materialized-reports/materialized-report-runs.d.ts +105 -0
  57. package/lib/helpers/materialized-reports/materialized-report-runs.js +156 -0
  58. package/lib/helpers/materialized-reports/report-compile.d.ts +38 -0
  59. package/lib/helpers/materialized-reports/report-compile.js +87 -0
  60. package/lib/helpers/materialized-reports/tenant-sales-overview-bson.d.ts +12 -0
  61. package/lib/helpers/materialized-reports/tenant-sales-overview-bson.js +33 -0
  62. package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.d.ts +1 -12
  63. package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.js +4 -24
  64. package/lib/helpers/types/workers.d.ts +65 -0
  65. package/lib/schemas/models/index.d.ts +1 -0
  66. package/lib/schemas/models/index.js +1 -0
  67. package/lib/schemas/models/materialized_credit_bills.d.ts +29 -46
  68. package/lib/schemas/models/materialized_credit_bills.js +3 -2
  69. package/lib/schemas/models/materialized_tenant_cash_entries.d.ts +9 -9
  70. package/lib/schemas/models/materialized_tenant_cash_reports.d.ts +9 -9
  71. package/lib/schemas/models/materialized_tenant_delivery_entries.d.ts +11 -10
  72. package/lib/schemas/models/materialized_tenant_delivery_entries.js +3 -2
  73. package/lib/schemas/models/materialized_tenant_delivery_geo_cells.d.ts +9 -9
  74. package/lib/schemas/models/materialized_tenant_delivery_geo_scopes.d.ts +6 -6
  75. package/lib/schemas/models/materialized_tenant_delivery_reports.d.ts +11 -10
  76. package/lib/schemas/models/materialized_tenant_delivery_reports.js +3 -2
  77. package/lib/schemas/models/materialized_tenant_dialer_entries.d.ts +8 -7
  78. package/lib/schemas/models/materialized_tenant_dialer_entries.js +3 -2
  79. package/lib/schemas/models/materialized_tenant_dialer_reports.d.ts +11 -10
  80. package/lib/schemas/models/materialized_tenant_dialer_reports.js +3 -2
  81. package/lib/schemas/models/materialized_tenant_dinein_entries.d.ts +8 -7
  82. package/lib/schemas/models/materialized_tenant_dinein_entries.js +3 -2
  83. package/lib/schemas/models/materialized_tenant_dinein_reports.d.ts +11 -10
  84. package/lib/schemas/models/materialized_tenant_dinein_reports.js +3 -2
  85. package/lib/schemas/models/materialized_tenant_discount_entries.d.ts +9 -9
  86. package/lib/schemas/models/materialized_tenant_discount_reports.d.ts +9 -9
  87. package/lib/schemas/models/materialized_tenant_discount_sources.d.ts +9 -9
  88. package/lib/schemas/models/materialized_tenant_hourly_comparison_entries.d.ts +9 -9
  89. package/lib/schemas/models/materialized_tenant_hourly_comparison_reports.d.ts +9 -9
  90. package/lib/schemas/models/materialized_tenant_payments_comparison_entries.d.ts +9 -9
  91. package/lib/schemas/models/materialized_tenant_payments_comparison_reports.d.ts +9 -9
  92. package/lib/schemas/models/materialized_tenant_prep_time_entries.d.ts +9 -9
  93. package/lib/schemas/models/materialized_tenant_prep_time_reports.d.ts +9 -9
  94. package/lib/schemas/models/materialized_tenant_report_runs.d.ts +97 -0
  95. package/lib/schemas/models/materialized_tenant_report_runs.js +108 -0
  96. package/lib/schemas/models/materialized_tenant_sales_comparison_entries.d.ts +9 -9
  97. package/lib/schemas/models/materialized_tenant_sales_comparison_reports.d.ts +9 -9
  98. package/lib/schemas/models/materialized_tenant_sales_overview_reports.d.ts +11 -35
  99. package/lib/schemas/models/materialized_tenant_sales_overview_reports.js +3 -2
  100. package/lib/schemas/models/tenant_active_jobs.d.ts +12 -3
  101. package/lib/schemas/models/tenant_active_jobs.js +18 -0
  102. package/lib/schemas/types/index.d.ts +1 -0
  103. package/lib/schemas/types/index.js +1 -0
  104. package/lib/schemas/types/materialized_tenant_report_runs.d.ts +55 -0
  105. package/lib/schemas/types/tenant_active_jobs.d.ts +15 -1
  106. package/lib/tests/materialized-reports/materialized-report-runs.test.js +116 -0
  107. package/lib/tests/materialized-reports/tenant-dinein-formatter.test.js +159 -0
  108. package/lib/tests/materialized-reports/tenant-sales-overview-close-day-helpers.test.js +2 -1
  109. package/lib/tests/materialized-reports/tenant-sales-overview-helpers.test.js +5 -4
  110. package/lib/tests/reporting-contract/no-live-transport.test.js +106 -0
  111. package/package.json +2 -1
  112. package/lib/helpers/order/payment-collection.d.ts +0 -25
  113. package/lib/helpers/order/payment-collection.js +0 -51
  114. package/lib/schemas/models/applied_order_discounts.d.ts +0 -80
  115. package/lib/schemas/models/applied_order_discounts.js +0 -106
  116. package/lib/schemas/types/applied_order_discounts.d.ts +0 -22
  117. package/lib/tests/payment-collection-timestamps.test.d.ts +0 -1
  118. package/lib/tests/payment-collection-timestamps.test.js +0 -71
  119. /package/{lib/tests/materialized-reports/analytics-growth-helpers.test.d.ts → esm/schemas/types/materialized_tenant_report_runs.js} +0 -0
  120. /package/lib/schemas/types/{applied_order_discounts.js → materialized_tenant_report_runs.js} +0 -0
  121. /package/lib/tests/materialized-reports/{analytics-overview-helpers.test.d.ts → materialized-report-runs.test.d.ts} +0 -0
  122. /package/lib/tests/{materialized-reports/analytics-performance-helpers.test.d.ts → reporting-contract/no-live-transport.test.d.ts} +0 -0
@@ -1,106 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.APPLIED_ORDER_DISCOUNTS_COLLECTION_NAME = exports.AppliedOrderDiscountsSchema = void 0;
4
- const mongoose_1 = require("mongoose");
5
- const constants_1 = require("../../constants");
6
- exports.AppliedOrderDiscountsSchema = new mongoose_1.Schema({
7
- _id: {
8
- type: mongoose_1.Schema.Types.ObjectId,
9
- required: true,
10
- immutable: true,
11
- },
12
- tenant_id: {
13
- type: String,
14
- required: true,
15
- immutable: true,
16
- ref: 'tenants',
17
- },
18
- order_id: {
19
- type: mongoose_1.Schema.Types.ObjectId,
20
- required: true,
21
- immutable: true,
22
- },
23
- discount_id: {
24
- type: String,
25
- required: true,
26
- },
27
- type: {
28
- type: String,
29
- required: true,
30
- enum: constants_1.ALL_DISCOUNT_TYPES,
31
- },
32
- applicability: {
33
- type: String,
34
- required: true,
35
- enum: constants_1.ALL_DISCOUNT_APPLICABILITY_TYPES,
36
- },
37
- platform: {
38
- type: String,
39
- enum: constants_1.ALL_PLATFORMS,
40
- required: true,
41
- },
42
- name: {
43
- type: String,
44
- required: true,
45
- },
46
- order_amount: {
47
- type: Number,
48
- required: true,
49
- min: 0,
50
- },
51
- discount_amount: {
52
- type: Number,
53
- required: true,
54
- min: 0,
55
- },
56
- discount_rate: {
57
- type: Number,
58
- required: false,
59
- default: null,
60
- },
61
- reason: {
62
- type: String,
63
- required: true,
64
- },
65
- reference_number: {
66
- type: String,
67
- required: false,
68
- },
69
- staff_id: {
70
- type: String,
71
- required: true,
72
- },
73
- staff_phone: {
74
- type: String,
75
- required: true,
76
- },
77
- staff_name: {
78
- type: String,
79
- required: true,
80
- },
81
- createdAt_mins: {
82
- type: Number,
83
- required: true,
84
- immutable: true,
85
- default: () => {
86
- const date = new Date();
87
- return Math.floor(date.getHours() * 60 + date.getMinutes());
88
- },
89
- },
90
- createdAt: {
91
- type: mongoose_1.Schema.Types.Date,
92
- required: true,
93
- default: () => new Date(),
94
- immutable: true,
95
- },
96
- updatedAt: {
97
- type: mongoose_1.Schema.Types.Date,
98
- required: true,
99
- default: () => new Date(),
100
- },
101
- }, {
102
- timestamps: true,
103
- versionKey: false,
104
- minimize: false,
105
- });
106
- exports.APPLIED_ORDER_DISCOUNTS_COLLECTION_NAME = 'applied_order_discounts';
@@ -1,22 +0,0 @@
1
- import { DISCOUNT_APPLICABILITY_ENUM, DISCOUNT_TYPE_ENUM, PLATFORMS_ENUM } from '../../constants';
2
- export interface IAppliedOrderDiscount {
3
- _id: string;
4
- tenant_id: string;
5
- order_id: string;
6
- discount_id: string;
7
- type: DISCOUNT_TYPE_ENUM;
8
- applicability: DISCOUNT_APPLICABILITY_ENUM;
9
- platform: PLATFORMS_ENUM;
10
- name: string;
11
- order_amount: number;
12
- discount_amount: number;
13
- discount_rate: number | null;
14
- reason: string;
15
- reference_number: string | null;
16
- staff_id: string;
17
- staff_phone: string;
18
- staff_name: string;
19
- createdAt_mins: number;
20
- createdAt: Date;
21
- updatedAt: Date;
22
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1,71 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const constants_1 = require("../constants");
4
- const payment_collection_1 = require("../helpers/order/payment-collection");
5
- const NOW = new Date('2026-10-20T14:00:00.000Z');
6
- const EARLIER = new Date('2026-10-19T10:00:00.000Z');
7
- const payment = (over = {}) => ({
8
- _id: '5f0000000000000000000001',
9
- payment_type: constants_1.PAYMENT_TYPE_ENUM.CASH,
10
- payment_status: constants_1.PAYMENT_STATUS_ENUM.SETTLED,
11
- card_details: null,
12
- amount_paid: 1000,
13
- amount_due: 1000,
14
- amount_refunded: 0,
15
- payment_id: 'pay-1',
16
- ...over,
17
- });
18
- describe('stampPaymentCollectionTimestamps', () => {
19
- it('stamps new collected money and leaves unpaid PAY_LATER empty', () => {
20
- const [paid, credit] = (0, payment_collection_1.stampPaymentCollectionTimestamps)([
21
- payment(),
22
- payment({
23
- _id: '5f0000000000000000000002',
24
- payment_id: 'pay-2',
25
- payment_type: constants_1.PAYMENT_TYPE_ENUM.PAY_LATER,
26
- payment_status: constants_1.PAYMENT_STATUS_ENUM.PENDING,
27
- amount_paid: 0,
28
- amount_due: 5000,
29
- }),
30
- ], null, { now: NOW });
31
- expect(paid.collected_at).toBe(NOW);
32
- expect(credit.collected_at).toBeNull();
33
- });
34
- it('ignores a client-supplied collected_at on create', () => {
35
- const [paid] = (0, payment_collection_1.stampPaymentCollectionTimestamps)([payment({ collected_at: EARLIER })], null, { now: NOW });
36
- expect(paid.collected_at).toBe(NOW);
37
- });
38
- it('preserves the stored timestamp when amount_paid did not increase', () => {
39
- const previous = payment({ collected_at: EARLIER });
40
- const [unchanged] = (0, payment_collection_1.stampPaymentCollectionTimestamps)([payment({ collected_at: null })], [previous], { now: NOW });
41
- expect(unchanged.collected_at).toBe(EARLIER);
42
- });
43
- it('stamps the latest collection when a partial amount is collected', () => {
44
- const previous = payment({ amount_paid: 400, collected_at: EARLIER });
45
- const [partial] = (0, payment_collection_1.stampPaymentCollectionTimestamps)([payment({ amount_paid: 700 })], [previous], { now: NOW });
46
- expect(partial.collected_at).toBe(NOW);
47
- });
48
- it('does not rewrite the timestamp on a refund / amount decrease', () => {
49
- const previous = payment({ amount_paid: 1000, collected_at: EARLIER });
50
- const [refunded] = (0, payment_collection_1.stampPaymentCollectionTimestamps)([payment({ amount_paid: 0, amount_refunded: 1000, payment_status: constants_1.PAYMENT_STATUS_ENUM.REFUNDED })], [previous], { now: NOW });
51
- expect(refunded.collected_at).toBe(EARLIER);
52
- });
53
- it('matches legacy rows by _id when payment_id is null', () => {
54
- const previous = payment({ payment_id: null, collected_at: EARLIER });
55
- const [updated] = (0, payment_collection_1.stampPaymentCollectionTimestamps)([payment({ payment_id: null, amount_paid: 1200 })], [previous], { now: NOW });
56
- expect(updated.collected_at).toBe(NOW);
57
- });
58
- it('preserves the stamp when the server reassigns payment_id but _id is stable', () => {
59
- const previous = payment({ payment_id: 'pay-old', collected_at: EARLIER });
60
- const [updated] = (0, payment_collection_1.stampPaymentCollectionTimestamps)([payment({ payment_id: 'pay-new' })], [previous], { now: NOW });
61
- expect(updated.collected_at).toBe(EARLIER);
62
- });
63
- it('does not stamp a failed payment', () => {
64
- const [failed] = (0, payment_collection_1.stampPaymentCollectionTimestamps)([payment({ payment_status: constants_1.PAYMENT_STATUS_ENUM.FAILED })], null, { now: NOW });
65
- expect(failed.collected_at).toBeNull();
66
- });
67
- it('returns an empty array for empty / invalid input', () => {
68
- expect((0, payment_collection_1.stampPaymentCollectionTimestamps)(null)).toEqual([]);
69
- expect((0, payment_collection_1.stampPaymentCollectionTimestamps)(undefined)).toEqual([]);
70
- });
71
- });