@managesome/eposmatic-toolkit 0.4.10 → 0.4.12

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 (98) 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 -6
  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 +12 -14
  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 -5
  26. package/esm/helpers/store/common-order-actions.js +3 -2
  27. package/esm/helpers/utils/delivery-helpers.js +5 -2
  28. package/esm/schemas/models/deliveries.js +11 -10
  29. package/esm/schemas/models/materialized_credit_bills.js +1 -1
  30. package/esm/schemas/models/materialized_rider_daily_reports.js +10 -2
  31. package/esm/schemas/models/materialized_tenant_sales_overview_reports.js +1 -1
  32. package/lib/constants/MATERIALIZED_REPORTS.d.ts +6 -0
  33. package/lib/constants/MATERIALIZED_REPORTS.js +9 -2
  34. package/lib/constants/enums/delivery.d.ts +7 -0
  35. package/lib/constants/enums/delivery.js +9 -1
  36. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.d.ts +55 -3
  37. package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.js +4 -42
  38. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.d.ts +2 -1
  39. package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.js +2 -2
  40. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.d.ts +3 -2
  41. package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.js +4 -3
  42. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.d.ts +35 -3
  43. package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.js +5 -5
  44. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.d.ts +2 -1
  45. package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +8 -7
  46. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.d.ts +4 -3
  47. package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +10 -12
  48. package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +2 -1
  49. package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +6 -2
  50. package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +2 -1
  51. package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.d.ts +34 -2
  52. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.d.ts +7 -5
  53. package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +14 -13
  54. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.d.ts +2 -1
  55. package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +1 -1
  56. package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.d.ts +6 -3
  57. package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.js +8 -5
  58. package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.js +2 -2
  59. package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +3 -4
  60. package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.js +2 -1
  61. package/lib/helpers/materialized-reports/tenant-delivery-formatter.js +1 -1
  62. package/lib/helpers/materialized-reports/tenant-discount-formatter.js +1 -1
  63. package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +3 -2
  64. package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.js +7 -4
  65. package/lib/helpers/materialized-reports/tenant-prep-time-formatter.d.ts +2 -1
  66. package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.js +7 -4
  67. package/lib/helpers/reporting-contract/overview-contract.js +5 -4
  68. package/lib/helpers/rider-earnings/rider-earnings.d.ts +0 -7
  69. package/lib/helpers/rider-earnings/rider-earnings.js +0 -7
  70. package/lib/helpers/rider-reports/rider-daily-report.d.ts +4 -3
  71. package/lib/helpers/rider-reports/rider-daily-report.js +1 -4
  72. package/lib/helpers/store/common-order-actions.js +3 -2
  73. package/lib/helpers/types/materialized-reports-apis.d.ts +3 -0
  74. package/lib/helpers/utils/delivery-helpers.js +5 -2
  75. package/lib/schemas/models/deliveries.d.ts +10 -10
  76. package/lib/schemas/models/deliveries.js +10 -9
  77. package/lib/schemas/models/materialized_credit_bills.d.ts +3 -3
  78. package/lib/schemas/models/materialized_credit_bills.js +1 -1
  79. package/lib/schemas/models/materialized_rider_daily_reports.d.ts +12 -2
  80. package/lib/schemas/models/materialized_rider_daily_reports.js +11 -3
  81. package/lib/schemas/models/materialized_tenant_sales_overview_reports.d.ts +3 -3
  82. package/lib/schemas/models/materialized_tenant_sales_overview_reports.js +1 -1
  83. package/lib/schemas/types/deliveries.d.ts +6 -7
  84. package/lib/schemas/types/materialized_tenant_sales_overview_reports.d.ts +7 -0
  85. package/lib/tests/deliveries-schema.test.d.ts +1 -0
  86. package/lib/tests/deliveries-schema.test.js +72 -0
  87. package/lib/tests/materialized-reports/materialized-cash-compile.test.js +2 -1
  88. package/lib/tests/materialized-reports/materialized-cash-formatter.test.js +2 -1
  89. package/lib/tests/materialized-reports/materialized-delivery-accumulation.test.js +2 -1
  90. package/lib/tests/materialized-reports/materialized-delivery-compile.test.js +9 -8
  91. package/lib/tests/materialized-reports/materialized-delivery-fold.test.js +2 -1
  92. package/lib/tests/materialized-reports/materialized-delivery-formatter.test.js +4 -2
  93. package/lib/tests/materialized-reports/materialized-delivery-plan.test.js +2 -1
  94. package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.js +7 -6
  95. package/lib/tests/materialized-reports/materialized-reports-scope-group-helpers.test.js +13 -13
  96. package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.js +2 -1
  97. package/lib/tests/rider-daily-report.test.js +3 -6
  98. package/package.json +1 -1
@@ -1,12 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getFormattedTenantCashInOutReporting = getFormattedTenantCashInOutReporting;
4
+ const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
4
5
  const price_conversion_1 = require("../utils/price-conversion");
5
6
  const materialized_cash_compile_helpers_1 = require("./materialized-cash-compile-helpers");
6
7
  const materialized_cash_classification_helpers_1 = require("./materialized-cash-classification-helpers");
7
8
  const materialized_cash_accumulator_helpers_1 = require("./materialized-cash-accumulator-helpers");
8
9
  const toDecimal = (cents) => (0, price_conversion_1.convertPriceFromCents)(cents ?? 0);
9
- const isDayScope = (scopeContext) => String(scopeContext) === 'localDate';
10
+ const isDayScope = (scopeContext) => String(scopeContext) === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_DATE;
10
11
  /** True when a key passes the caller-supplied drawer / ref-type filters. */
11
12
  function keyPassesFilters(key, filters) {
12
13
  const parsed = (0, materialized_cash_compile_helpers_1.parseMaterializedCashKey)(key);
@@ -8,7 +8,7 @@ const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
8
8
  const toDecimal = (cents) => (0, price_conversion_1.convertPriceFromCents)(cents ?? 0);
9
9
  const km = (meters) => Math.round(((meters ?? 0) / 1000) * 100) / 100;
10
10
  const safeAverage = (total, count) => count > 0 ? Math.round((total / count) * 100) / 100 : null;
11
- const isDayScope = (scopeContext) => String(scopeContext) === 'localDate';
11
+ const isDayScope = (scopeContext) => String(scopeContext) === MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_DATE;
12
12
  /** True when a key passes the caller-supplied platform / city filters. */
13
13
  function keyPassesFilters(key, filters) {
14
14
  const parsed = (0, materialized_delivery_classification_helpers_1.parseMaterializedDeliveryKey)(key);
@@ -63,7 +63,7 @@ const isCancelledKey = (components, keyFilters) => {
63
63
  const statusIndex = keyFilters.indexOf(MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_KEY_FILTER_ENUM.ORDER_STATUS);
64
64
  if (statusIndex === -1)
65
65
  return false;
66
- return components[statusIndex] === 'CANCELLED';
66
+ return components[statusIndex] === ENUMS_1.ORDER_STATUS_ENUM.CANCELLED;
67
67
  };
68
68
  const emptyScopeAccumulator = () => ({
69
69
  summary: {
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getHourlyComparisonBusinessIndex = exports.getHourlyComparisonHourLabel = void 0;
4
4
  exports.getFormattedTenantHourlyComparisonReporting = getFormattedTenantHourlyComparisonReporting;
5
5
  const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
6
+ const ENUMS_1 = require("../../constants/ENUMS");
6
7
  const tenant_sales_comparison_formatter_1 = require("./tenant-sales-comparison-formatter");
7
8
  const materialized_sales_comparison_accumulator_helpers_1 = require("./materialized-sales-comparison-accumulator-helpers");
8
9
  const key_helpers_1 = require("./key-helpers");
@@ -57,8 +58,8 @@ exports.getHourlyComparisonHourLabel = getHourlyComparisonHourLabel;
57
58
  /** Business-hour index: 06 → 0, …, 23 → 17, 00 → 18, …, 05 → 23. */
58
59
  const getHourlyComparisonBusinessIndex = (hour) => (hour + 18) % 24;
59
60
  exports.getHourlyComparisonBusinessIndex = getHourlyComparisonBusinessIndex;
60
- const isCancelled = (status) => status === 'CANCELLED';
61
- const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes('CANCELLED');
61
+ const isCancelled = (status) => status === ENUMS_1.ORDER_STATUS_ENUM.CANCELLED;
62
+ const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes(ENUMS_1.ORDER_STATUS_ENUM.CANCELLED);
62
63
  const parseKey = (key, keyFilters) => {
63
64
  const components = (0, key_helpers_1.parseMaterializedReportKey)(key);
64
65
  if (components == null || components.length !== keyFilters.length)
@@ -4,8 +4,11 @@ exports.formatPaymentsComparisonSeries = exports.createEmptyPaymentsComparisonFo
4
4
  exports.buildPaymentsComparisonMetrics = buildPaymentsComparisonMetrics;
5
5
  exports.getFormattedTenantPaymentsComparisonReporting = getFormattedTenantPaymentsComparisonReporting;
6
6
  const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
7
+ const ENUMS_1 = require("../../constants/ENUMS");
7
8
  const key_helpers_1 = require("./key-helpers");
8
9
  const price_conversion_1 = require("../utils/price-conversion");
10
+ const matchedDocumentsOf = (doc) => ('matched_documents' in doc ? doc.matched_documents : 1);
11
+ const updatedAtOf = (doc) => 'max_updated_at' in doc ? doc.max_updated_at : doc.updatedAt;
9
12
  const METRICS = [
10
13
  MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_AMOUNT,
11
14
  MATERIALIZED_REPORTS_1.PAYMENTS_COMPARISON_METRIC_ENUM.PAYMENT_COUNT,
@@ -99,8 +102,8 @@ const parseKey = (key, keyFilters) => {
99
102
  }
100
103
  return { payment_method: paymentMethod, order_status: orderStatus };
101
104
  };
102
- const isCancelled = (orderStatus) => orderStatus === 'CANCELLED';
103
- const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes('CANCELLED');
105
+ const isCancelled = (orderStatus) => orderStatus === ENUMS_1.ORDER_STATUS_ENUM.CANCELLED;
106
+ const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes(ENUMS_1.ORDER_STATUS_ENUM.CANCELLED);
104
107
  const matchesFilters = (parsed, filters) => {
105
108
  if (filters.payment_methods != null &&
106
109
  filters.payment_methods.length > 0 &&
@@ -126,8 +129,8 @@ const buildPage = (group, filters) => {
126
129
  for (const doc of docs ?? []) {
127
130
  if (doc == null)
128
131
  continue;
129
- matchedDocuments += Number(doc.matched_documents ?? 1) || 0;
130
- const updatedAt = doc.max_updated_at ?? doc.updatedAt ?? null;
132
+ matchedDocuments += matchedDocumentsOf(doc);
133
+ const updatedAt = updatedAtOf(doc);
131
134
  if (updatedAt != null) {
132
135
  const date = new Date(updatedAt);
133
136
  if (!Number.isNaN(date.getTime()) && (maxUpdatedAt == null || date.getTime() > maxUpdatedAt.getTime())) {
@@ -1,3 +1,4 @@
1
+ import { IMaterializedTenantPrepTimeAggregatedReport } from '../types/materialized-reports-apis';
1
2
  import { DAY_INDEX_ENUM } from '../../constants/ENUMS';
2
3
  import { IMaterializedTenantPrepTimeReport } from '../../schemas/types/materialized_tenant_prep_time_reports';
3
4
  /**
@@ -94,4 +95,4 @@ export declare function getFormattedTenantPrepTimeReporting(reports: IMaterializ
94
95
  * `weekday` therefore comes back null and a weekday filter is REFUSED rather than
95
96
  * silently ignored (returning every weekday would be a wrong answer).
96
97
  */
97
- export declare function getFormattedTenantPrepTimeAggregatedReporting(reports: any[], filters?: IFormattedPrepTimeFilters | null, separate_view_per_tenant?: boolean): [IFormattedPrepTimePageData[], null] | null;
98
+ export declare function getFormattedTenantPrepTimeAggregatedReporting(reports: IMaterializedTenantPrepTimeAggregatedReport[], filters?: IFormattedPrepTimeFilters | null, separate_view_per_tenant?: boolean): [IFormattedPrepTimePageData[], null] | null;
@@ -4,8 +4,11 @@ exports.formatSalesComparisonSeries = void 0;
4
4
  exports.buildSalesComparisonMetrics = buildSalesComparisonMetrics;
5
5
  exports.getFormattedTenantSalesComparisonReporting = getFormattedTenantSalesComparisonReporting;
6
6
  const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
7
+ const ENUMS_1 = require("../../constants/ENUMS");
7
8
  const key_helpers_1 = require("./key-helpers");
8
9
  const price_conversion_1 = require("../utils/price-conversion");
10
+ const matchedDocumentsOf = (doc) => 'matched_documents' in doc ? doc.matched_documents : 1;
11
+ const updatedAtOf = (doc) => 'max_updated_at' in doc ? doc.max_updated_at : doc.updatedAt;
9
12
  const ALL_METRICS = [
10
13
  MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.NET_SALES,
11
14
  MATERIALIZED_REPORTS_1.SALES_COMPARISON_METRIC_ENUM.GROSS_SALES,
@@ -141,9 +144,9 @@ const parseKey = (key, keyFilters) => {
141
144
  }
142
145
  return { order_status: orderStatus, platform };
143
146
  };
144
- const isCancelled = (orderStatus) => orderStatus === 'CANCELLED';
147
+ const isCancelled = (orderStatus) => orderStatus === ENUMS_1.ORDER_STATUS_ENUM.CANCELLED;
145
148
  /** True when a filter list explicitly asks for `CANCELLED`. */
146
- const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes('CANCELLED');
149
+ const includesCancelled = (filters) => Array.isArray(filters.order_statuses) && filters.order_statuses.includes(ENUMS_1.ORDER_STATUS_ENUM.CANCELLED);
147
150
  const foldDocs = (docs, filters, target) => {
148
151
  for (const doc of docs ?? []) {
149
152
  if (doc == null || doc.sales_counters == null)
@@ -189,7 +192,7 @@ const buildGroup = (tenantIds, currentDocs, comparisonDocs, filters) => {
189
192
  comparisonCancelled: createRawCounters(),
190
193
  hasComparisonDocuments,
191
194
  includeCancelledInTotals: includesCancelled(filters),
192
- matchedDocuments: currentDocs.reduce((sum, doc) => sum + (Number(doc.matched_documents ?? 1) || 0), 0),
195
+ matchedDocuments: currentDocs.reduce((sum, doc) => sum + matchedDocumentsOf(doc), 0),
193
196
  tenantIds: new Set(tenantIds),
194
197
  };
195
198
  const includeCancelledInTotals = group.includeCancelledInTotals;
@@ -242,7 +245,7 @@ const buildPage = (group, filters) => {
242
245
  continue;
243
246
  // The platform breakdown must reconcile with the page's total: cancelled
244
247
  // revenue is excluded there unless the filter explicitly asked for it.
245
- if (row.order_status === 'CANCELLED' && !group.includeCancelledInTotals)
248
+ if (row.order_status === ENUMS_1.ORDER_STATUS_ENUM.CANCELLED && !group.includeCancelledInTotals)
246
249
  continue;
247
250
  const existing = platformRows.get(row.platform) ?? {
248
251
  platform: row.platform,
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.normalizeOverviewAggregatedRecord = normalizeOverviewAggregatedRecord;
4
4
  exports.normalizeOverviewAggregatedShape = normalizeOverviewAggregatedShape;
5
+ const ENUMS_1 = require("../../constants/ENUMS");
5
6
  const key_helpers_1 = require("../materialized-reports/key-helpers");
6
7
  const emptySummary = () => ({
7
8
  order_count: 0,
@@ -33,7 +34,7 @@ function normalizeOverviewAggregatedRecord(record) {
33
34
  continue;
34
35
  const [status, platform] = components;
35
36
  const orderMetric = metric?.TOTAL_SALES?.orders;
36
- if (status === 'CANCELLED') {
37
+ if (status === ENUMS_1.ORDER_STATUS_ENUM.CANCELLED) {
37
38
  summary.cancelled_order_count += Number(orderMetric?.count ?? 0);
38
39
  continue;
39
40
  }
@@ -85,9 +86,9 @@ function normalizeOverviewAggregatedRecord(record) {
85
86
  function normalizeOverviewAggregatedShape(record) {
86
87
  const metrics = {};
87
88
  for (const [key, metric] of Object.entries(record.sale_type_metrics ?? {})) {
88
- const total = metric?.TOTAL_SALES ?? {};
89
- const collected = metric?.AMOUNT_COLLECTED ?? {};
90
- const credit = metric?.CREDIT_BILLS ?? {};
89
+ const total = metric.TOTAL_SALES;
90
+ const collected = metric.AMOUNT_COLLECTED;
91
+ const credit = metric.CREDIT_BILLS;
91
92
  const issued = credit.issued ?? {};
92
93
  const received = credit.received ?? {};
93
94
  metrics[key] = {
@@ -49,10 +49,3 @@ export interface IRiderFeeResult {
49
49
  */
50
50
  export declare function roundRiderFeeDistance(distanceMeters: number, stepMeters: number): number;
51
51
  export declare function calculateRiderFee(input: IRiderFeeInput): IRiderFeeResult;
52
- /** Status written on a newly created delivery; amount is not final yet. */
53
- export declare const RIDER_EARNINGS_STATUS: {
54
- readonly PENDING: "PENDING";
55
- readonly FINAL: "FINAL";
56
- readonly VOID: "VOID";
57
- };
58
- export type TRiderEarningsStatus = (typeof RIDER_EARNINGS_STATUS)[keyof typeof RIDER_EARNINGS_STATUS];
@@ -1,6 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.RIDER_EARNINGS_STATUS = void 0;
4
3
  exports.roundRiderFeeDistance = roundRiderFeeDistance;
5
4
  exports.calculateRiderFee = calculateRiderFee;
6
5
  const delivery_1 = require("../../constants/enums/delivery");
@@ -56,9 +55,3 @@ function calculateRiderFee(input) {
56
55
  delivery_charge_cents: deliveryCharge,
57
56
  };
58
57
  }
59
- /** Status written on a newly created delivery; amount is not final yet. */
60
- exports.RIDER_EARNINGS_STATUS = {
61
- PENDING: 'PENDING',
62
- FINAL: 'FINAL',
63
- VOID: 'VOID',
64
- };
@@ -1,3 +1,4 @@
1
+ import { DELIVERY_STATUS_ENUM, RIDER_EARNINGS_STATUS_ENUM } from '../../constants/enums/delivery';
1
2
  import { IMaterializedRiderDailyReport } from '../../schemas/types/materialized_rider_daily_reports';
2
3
  /**
3
4
  * Builds one rider-day materialized document from delivery source rows.
@@ -6,16 +7,16 @@ import { IMaterializedRiderDailyReport } from '../../schemas/types/materialized_
6
7
  * the payout/totals/tenant-breakdown rules are unit-testable without Mongo.
7
8
  */
8
9
  export interface IRiderDailySourceDelivery {
9
- status?: string | null;
10
+ _id?: string;
11
+ status?: DELIVERY_STATUS_ENUM | null;
10
12
  tenant_id?: string | null;
11
13
  createdAt?: Date | string | null;
12
14
  distance_in_meters_from_store?: number | null;
13
15
  expected_delivery_at?: Date | string | null;
14
16
  delivered_at?: Date | string | null;
15
- rider_revenue?: number | null;
16
17
  rider_earnings?: {
17
18
  amount?: number | null;
18
- status?: string | null;
19
+ status?: RIDER_EARNINGS_STATUS_ENUM | null;
19
20
  } | null;
20
21
  }
21
22
  export declare function buildRiderDailyReport({ rider_id, local_date, deliveries, computedAt, }: {
@@ -6,10 +6,7 @@ const materialized_rider_daily_reports_1 = require("../../schemas/models/materia
6
6
  const completedOrCancelled = (status) => status === delivery_1.DELIVERY_STATUS_ENUM.COMPLETED || status === delivery_1.DELIVERY_STATUS_ENUM.CANCELLED;
7
7
  const finalEarnings = (delivery) => {
8
8
  const earnings = delivery.rider_earnings;
9
- if (earnings != null) {
10
- return earnings.status === 'FINAL' ? Number(earnings.amount) || 0 : 0;
11
- }
12
- return Number(delivery.rider_revenue) || 0;
9
+ return earnings?.status === delivery_1.RIDER_EARNINGS_STATUS_ENUM.FINAL ? Number(earnings.amount) || 0 : 0;
13
10
  };
14
11
  function buildRiderDailyReport({ rider_id, local_date, deliveries, computedAt = new Date(), }) {
15
12
  if (rider_id.trim() === '' || local_date.trim() === '')
@@ -337,9 +337,10 @@ function generateOrderIteration(order, partial = true, skipItemMetadata, previou
337
337
  };
338
338
  if (partial) {
339
339
  // delete all undefined keys
340
+ const mutable = iteration;
340
341
  Object.keys(iteration).forEach((key) => {
341
- if (iteration[key] === undefined) {
342
- delete iteration[key];
342
+ if (mutable[key] === undefined) {
343
+ delete mutable[key];
343
344
  }
344
345
  });
345
346
  }
@@ -280,6 +280,9 @@ export interface IMaterializedTenantPrepTimeAggregatedReport {
280
280
  key: string;
281
281
  counters: IMaterializedPrepTimeCounters;
282
282
  }[];
283
+ /** Freshness of the folded data, when the aggregation exposes it. */
284
+ schema_version?: number;
285
+ max_updated_at?: Date | null;
283
286
  }
284
287
  /**
285
288
  * Body of `POST /reports/sales-comparison` — the shared `{ tenants, selection }`
@@ -12,9 +12,12 @@ function getDeliveryWithPrice(delivery, writeable) {
12
12
  const convertToPrice = writeable ? price_conversion_1.convertPriceToCents : price_conversion_1.convertPriceFromCents;
13
13
  return {
14
14
  ...delivery,
15
- ...(delivery.rider_revenue != null
15
+ ...(delivery.rider_earnings != null
16
16
  ? {
17
- rider_revenue: convertToPrice(delivery.rider_revenue ?? 0),
17
+ rider_earnings: {
18
+ ...delivery.rider_earnings,
19
+ amount: convertToPrice(delivery.rider_earnings.amount),
20
+ },
18
21
  }
19
22
  : {}),
20
23
  };
@@ -1,5 +1,5 @@
1
1
  import { Schema } from 'mongoose';
2
- import { CURRENCY_SYMBOL_ENUM, DELIVERY_STATUS_ENUM } from '../../constants';
2
+ import { CURRENCY_SYMBOL_ENUM, DELIVERY_STATUS_ENUM, RIDER_EARNINGS_STATUS_ENUM, RIDER_FEE_TYPE_ENUM } from '../../constants';
3
3
  export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
4
4
  timestamps: true;
5
5
  versionKey: false;
@@ -38,8 +38,8 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
38
38
  0?: number | null | undefined;
39
39
  1?: number | null | undefined;
40
40
  }>;
41
+ localDate?: string | null | undefined;
41
42
  cancel_reason?: string | null | undefined;
42
- rider_revenue?: number | null | undefined;
43
43
  pickup_food_image_url?: string | null | undefined;
44
44
  dropoff_food_image_url?: string | null | undefined;
45
45
  tracking_enabled?: boolean | null | undefined;
@@ -52,9 +52,9 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
52
52
  delivery_minutes?: number | null | undefined;
53
53
  rider_earnings?: {
54
54
  version: number;
55
- status: string;
55
+ status: RIDER_EARNINGS_STATUS_ENUM;
56
56
  amount: number;
57
- rule_type: string;
57
+ rule_type: RIDER_FEE_TYPE_ENUM;
58
58
  per_meter: number;
59
59
  distance_step: number;
60
60
  distance_meters: number;
@@ -95,8 +95,8 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
95
95
  0?: number | null | undefined;
96
96
  1?: number | null | undefined;
97
97
  }>;
98
+ localDate?: string | null | undefined;
98
99
  cancel_reason?: string | null | undefined;
99
- rider_revenue?: number | null | undefined;
100
100
  pickup_food_image_url?: string | null | undefined;
101
101
  dropoff_food_image_url?: string | null | undefined;
102
102
  tracking_enabled?: boolean | null | undefined;
@@ -109,9 +109,9 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
109
109
  delivery_minutes?: number | null | undefined;
110
110
  rider_earnings?: {
111
111
  version: number;
112
- status: string;
112
+ status: RIDER_EARNINGS_STATUS_ENUM;
113
113
  amount: number;
114
- rule_type: string;
114
+ rule_type: RIDER_FEE_TYPE_ENUM;
115
115
  per_meter: number;
116
116
  distance_step: number;
117
117
  distance_meters: number;
@@ -152,8 +152,8 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
152
152
  0?: number | null | undefined;
153
153
  1?: number | null | undefined;
154
154
  }>;
155
+ localDate?: string | null | undefined;
155
156
  cancel_reason?: string | null | undefined;
156
- rider_revenue?: number | null | undefined;
157
157
  pickup_food_image_url?: string | null | undefined;
158
158
  dropoff_food_image_url?: string | null | undefined;
159
159
  tracking_enabled?: boolean | null | undefined;
@@ -166,9 +166,9 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
166
166
  delivery_minutes?: number | null | undefined;
167
167
  rider_earnings?: {
168
168
  version: number;
169
- status: string;
169
+ status: RIDER_EARNINGS_STATUS_ENUM;
170
170
  amount: number;
171
- rule_type: string;
171
+ rule_type: RIDER_FEE_TYPE_ENUM;
172
172
  per_meter: number;
173
173
  distance_step: number;
174
174
  distance_meters: number;
@@ -67,6 +67,12 @@ exports.DeliveriesSchema = new mongoose_1.Schema({
67
67
  type: String,
68
68
  required: false,
69
69
  },
70
+ /** Tenant-local business date, copied from the order at creation. */
71
+ localDate: {
72
+ type: String,
73
+ required: false,
74
+ default: null,
75
+ },
70
76
  polyline: {
71
77
  type: [[Number, Number]],
72
78
  required: true,
@@ -76,11 +82,6 @@ exports.DeliveriesSchema = new mongoose_1.Schema({
76
82
  type: Number,
77
83
  default: 0,
78
84
  },
79
- rider_revenue: {
80
- type: Number,
81
- min: 0,
82
- required: false,
83
- },
84
85
  pickup_food_image_url: {
85
86
  type: String,
86
87
  required: false,
@@ -149,14 +150,14 @@ exports.DeliveriesSchema = new mongoose_1.Schema({
149
150
  status: {
150
151
  type: String,
151
152
  required: true,
152
- enum: ['PENDING', 'FINAL', 'VOID'],
153
- default: 'PENDING',
153
+ enum: constants_1.ALL_RIDER_EARNINGS_STATUS,
154
+ default: constants_1.RIDER_EARNINGS_STATUS_ENUM.PENDING,
154
155
  },
155
156
  rule_type: {
156
157
  type: String,
157
158
  required: true,
158
- enum: ['NONE', 'DELIVERY_CHARGES_FULL', 'DISTANCE_ONE_WAY', 'DISTANCE_RETURN'],
159
- default: 'NONE',
159
+ enum: constants_1.ALL_RIDER_FEE_TYPES,
160
+ default: constants_1.RIDER_FEE_TYPE_ENUM.NONE,
160
161
  },
161
162
  per_meter: { type: Number, required: true, min: 0, default: 0 },
162
163
  distance_step: { type: Number, required: true, min: 0, default: 0 },
@@ -31,7 +31,7 @@ export declare const MaterializedTenantCreditBillsReportSchema: Schema<any, impo
31
31
  createdAt: NativeDate;
32
32
  updatedAt: NativeDate;
33
33
  brand_id: string;
34
- day_index: import("../../constants/ENUMS").DAY_INDEX_ENUM;
34
+ day_index: import("../../constants/ENUMS").DAY_INDEX_ENUM | null;
35
35
  iteration: number;
36
36
  scope_context: import("../../constants/MATERIALIZED_REPORTS").MATERIALIZED_REPORT_SCOPE_ENUM;
37
37
  scope_field: string;
@@ -118,7 +118,7 @@ export declare const MaterializedTenantCreditBillsReportSchema: Schema<any, impo
118
118
  createdAt: NativeDate;
119
119
  updatedAt: NativeDate;
120
120
  brand_id: string;
121
- day_index: import("../../constants/ENUMS").DAY_INDEX_ENUM;
121
+ day_index: import("../../constants/ENUMS").DAY_INDEX_ENUM | null;
122
122
  iteration: number;
123
123
  scope_context: import("../../constants/MATERIALIZED_REPORTS").MATERIALIZED_REPORT_SCOPE_ENUM;
124
124
  scope_field: string;
@@ -205,7 +205,7 @@ export declare const MaterializedTenantCreditBillsReportSchema: Schema<any, impo
205
205
  createdAt: NativeDate;
206
206
  updatedAt: NativeDate;
207
207
  brand_id: string;
208
- day_index: import("../../constants/ENUMS").DAY_INDEX_ENUM;
208
+ day_index: import("../../constants/ENUMS").DAY_INDEX_ENUM | null;
209
209
  iteration: number;
210
210
  scope_context: import("../../constants/MATERIALIZED_REPORTS").MATERIALIZED_REPORT_SCOPE_ENUM;
211
211
  scope_field: string;
@@ -166,7 +166,7 @@ exports.MaterializedTenantCreditBillsReportSchema = new mongoose_1.Schema({
166
166
  // null elsewhere.
167
167
  day_index: {
168
168
  type: String,
169
- enum: ENUMS_1.ALL_DAY_INDEX,
169
+ enum: [...ENUMS_1.ALL_DAY_INDEX, null],
170
170
  default: null,
171
171
  },
172
172
  sale_type_key_filters: {
@@ -17,10 +17,20 @@ export declare const MaterializedRiderDailyReportSchema: Schema<IMaterializedRid
17
17
  }> & {
18
18
  __v: number;
19
19
  }>;
20
+ /** Index patterns for `.hint()` reads. */
21
+ export declare const MATERIALIZED_RIDER_DAILY_REPORTS_COLLECTION_INDEXES: {
22
+ readonly _id: {
23
+ readonly _id: 1;
24
+ };
25
+ readonly rider_id__local_date: {
26
+ readonly rider_id: 1;
27
+ readonly local_date: 1;
28
+ };
29
+ };
20
30
  export declare const MATERIALIZED_RIDER_DAILY_REPORTS_INDEX_OPTIONS: {
21
31
  key: {
22
- rider_id: number;
23
- local_date: number;
32
+ readonly rider_id: 1;
33
+ readonly local_date: 1;
24
34
  };
25
35
  name: string;
26
36
  unique: boolean;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.MATERIALIZED_RIDER_DAILY_REPORTS_INDEX_OPTIONS = exports.MaterializedRiderDailyReportSchema = exports.MATERIALIZED_RIDER_DAILY_REPORTS_COLLECTION_NAME = exports.MATERIALIZED_RIDER_DAILY_REPORTS_SCHEMA_VERSION = void 0;
3
+ exports.MATERIALIZED_RIDER_DAILY_REPORTS_INDEX_OPTIONS = exports.MATERIALIZED_RIDER_DAILY_REPORTS_COLLECTION_INDEXES = exports.MaterializedRiderDailyReportSchema = exports.MATERIALIZED_RIDER_DAILY_REPORTS_COLLECTION_NAME = exports.MATERIALIZED_RIDER_DAILY_REPORTS_SCHEMA_VERSION = void 0;
4
4
  const mongoose_1 = require("mongoose");
5
5
  /**
6
6
  * Mongoose schema for `materialized_rider_daily_reports`.
@@ -32,10 +32,18 @@ exports.MaterializedRiderDailyReportSchema = new mongoose_1.Schema({
32
32
  source_watermark: { type: mongoose_1.Schema.Types.Date, required: true },
33
33
  computed_at: { type: mongoose_1.Schema.Types.Date, required: true },
34
34
  }, { timestamps: true, versionKey: false, minimize: false });
35
- exports.MaterializedRiderDailyReportSchema.index({ rider_id: 1, local_date: 1 }, { unique: true, name: 'rider_id__local_date' });
35
+ /** Index patterns for `.hint()` reads. */
36
+ exports.MATERIALIZED_RIDER_DAILY_REPORTS_COLLECTION_INDEXES = {
37
+ _id: { _id: 1 },
38
+ rider_id__local_date: { rider_id: 1, local_date: 1 },
39
+ };
40
+ exports.MaterializedRiderDailyReportSchema.index(exports.MATERIALIZED_RIDER_DAILY_REPORTS_COLLECTION_INDEXES.rider_id__local_date, {
41
+ unique: true,
42
+ name: 'rider_id__local_date',
43
+ });
36
44
  exports.MATERIALIZED_RIDER_DAILY_REPORTS_INDEX_OPTIONS = [
37
45
  {
38
- key: { rider_id: 1, local_date: 1 },
46
+ key: exports.MATERIALIZED_RIDER_DAILY_REPORTS_COLLECTION_INDEXES.rider_id__local_date,
39
47
  name: 'rider_id__local_date',
40
48
  unique: true,
41
49
  },
@@ -38,7 +38,7 @@ export declare const MaterializedTenantSalesOverviewReportSchema: Schema<any, im
38
38
  createdAt: NativeDate;
39
39
  updatedAt: NativeDate;
40
40
  brand_id: string;
41
- day_index: import("../../constants").DAY_INDEX_ENUM;
41
+ day_index: import("../../constants").DAY_INDEX_ENUM | null;
42
42
  iteration: number;
43
43
  scope_context: import("../../constants").MATERIALIZED_REPORT_SCOPE_ENUM;
44
44
  scope_field: string;
@@ -153,7 +153,7 @@ export declare const MaterializedTenantSalesOverviewReportSchema: Schema<any, im
153
153
  createdAt: NativeDate;
154
154
  updatedAt: NativeDate;
155
155
  brand_id: string;
156
- day_index: import("../../constants").DAY_INDEX_ENUM;
156
+ day_index: import("../../constants").DAY_INDEX_ENUM | null;
157
157
  iteration: number;
158
158
  scope_context: import("../../constants").MATERIALIZED_REPORT_SCOPE_ENUM;
159
159
  scope_field: string;
@@ -268,7 +268,7 @@ export declare const MaterializedTenantSalesOverviewReportSchema: Schema<any, im
268
268
  createdAt: NativeDate;
269
269
  updatedAt: NativeDate;
270
270
  brand_id: string;
271
- day_index: import("../../constants").DAY_INDEX_ENUM;
271
+ day_index: import("../../constants").DAY_INDEX_ENUM | null;
272
272
  iteration: number;
273
273
  scope_context: import("../../constants").MATERIALIZED_REPORT_SCOPE_ENUM;
274
274
  scope_field: string;
@@ -226,7 +226,7 @@ exports.MaterializedTenantSalesOverviewReportSchema = new mongoose_1.Schema({
226
226
  // all-time accumulator document (see MATERIALIZED_REPORTS.md).
227
227
  day_index: {
228
228
  type: String,
229
- enum: ENUMS_1.ALL_DAY_INDEX,
229
+ enum: [...ENUMS_1.ALL_DAY_INDEX, null],
230
230
  default: null,
231
231
  },
232
232
  sale_type_key_filters: {
@@ -1,4 +1,4 @@
1
- import { CURRENCY_SYMBOL_ENUM, DELIVERY_STATUS_ENUM, RIDER_FEE_TYPE_ENUM } from '../../constants';
1
+ import { CURRENCY_SYMBOL_ENUM, DELIVERY_STATUS_ENUM, RIDER_EARNINGS_STATUS_ENUM, RIDER_FEE_TYPE_ENUM } from '../../constants';
2
2
  import { IOrder } from './orders';
3
3
  export interface IDelivery {
4
4
  _id: string;
@@ -19,7 +19,6 @@ export interface IDelivery {
19
19
  localDate?: string | null;
20
20
  polyline: [number, number][];
21
21
  distance_in_meters_from_store: number;
22
- rider_revenue?: number | null;
23
22
  pickup_food_image_url?: string | null;
24
23
  dropoff_food_image_url?: string | null;
25
24
  tracking_enabled?: boolean;
@@ -38,10 +37,10 @@ export interface IDelivery {
38
37
  /** Stored duration at COMPLETED (minutes). */
39
38
  delivery_minutes?: number | null;
40
39
  /**
41
- * Server-owned rider payout snapshot. The customer delivery fee is NOT this
42
- * number: for distance-based rules the rider fee is independent of the order.
43
- * Kept alongside `rider_revenue` so historical pay does not move when tenant
44
- * settings change.
40
+ * Server-owned rider payout snapshot — the SINGLE stored payout value.
41
+ * The customer delivery fee is NOT this number: for distance-based rules the
42
+ * rider fee is independent of the order. API/report surfaces that still expose
43
+ * `rider_revenue` derive it from this snapshot.
45
44
  */
46
45
  rider_earnings?: IRiderEarningsSnapshot | null;
47
46
  createdAt_mins: number;
@@ -51,7 +50,7 @@ export interface IDelivery {
51
50
  export interface IRiderEarningsSnapshot {
52
51
  /** CENTS. */
53
52
  amount: number;
54
- status: 'PENDING' | 'FINAL' | 'VOID';
53
+ status: RIDER_EARNINGS_STATUS_ENUM;
55
54
  rule_type: RIDER_FEE_TYPE_ENUM;
56
55
  /** Raw tenant value, scaled by 100000. */
57
56
  per_meter: number;
@@ -120,6 +120,13 @@ export interface IMaterializedReportCreditBills {
120
120
  amount: number;
121
121
  settled_count: number;
122
122
  settled_amount: number;
123
+ /** Range-pure extras added by the read aggregation, never stored. */
124
+ outstanding_count?: number;
125
+ outstanding_amount?: number;
126
+ outstanding_now_count?: number;
127
+ outstanding_now_amount?: number;
128
+ collected_at_issue_count?: number;
129
+ collected_at_issue_amount?: number;
123
130
  };
124
131
  received: {
125
132
  count: number;
@@ -0,0 +1 @@
1
+ export {};