@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.
- package/esm/constants/MATERIALIZED_REPORTS.js +7 -0
- package/esm/constants/enums/delivery.js +8 -0
- package/esm/helpers/materialized-reports/materialized-cash-classification-helpers.js +5 -43
- package/esm/helpers/materialized-reports/materialized-cash-close-day-helpers.js +3 -3
- package/esm/helpers/materialized-reports/materialized-cash-compile-helpers.js +5 -4
- package/esm/helpers/materialized-reports/materialized-delivery-classification-helpers.js +6 -2
- package/esm/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +3 -2
- package/esm/helpers/materialized-reports/materialized-delivery-compile-helpers.js +10 -8
- package/esm/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +2 -1
- package/esm/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +7 -3
- package/esm/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +2 -1
- package/esm/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +15 -14
- package/esm/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +2 -2
- package/esm/helpers/materialized-reports/materialized-reports-scope-group-helpers.js +9 -6
- package/esm/helpers/materialized-reports/materialized-reports-selection-helpers.js +4 -4
- package/esm/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +5 -6
- package/esm/helpers/materialized-reports/tenant-cash-in-out-formatter.js +2 -1
- package/esm/helpers/materialized-reports/tenant-delivery-formatter.js +2 -2
- package/esm/helpers/materialized-reports/tenant-discount-formatter.js +2 -2
- package/esm/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +3 -2
- package/esm/helpers/materialized-reports/tenant-payments-comparison-formatter.js +7 -4
- package/esm/helpers/materialized-reports/tenant-sales-comparison-formatter.js +7 -4
- package/esm/helpers/reporting-contract/overview-contract.js +5 -4
- package/esm/helpers/rider-earnings/rider-earnings.js +0 -6
- package/esm/helpers/rider-reports/rider-daily-report.js +2 -2
- package/esm/helpers/store/common-order-actions.js +3 -2
- package/esm/schemas/models/deliveries.js +11 -5
- package/esm/schemas/models/materialized_credit_bills.js +1 -1
- package/esm/schemas/models/materialized_tenant_sales_overview_reports.js +1 -1
- package/lib/constants/MATERIALIZED_REPORTS.d.ts +6 -0
- package/lib/constants/MATERIALIZED_REPORTS.js +9 -2
- package/lib/constants/enums/delivery.d.ts +7 -0
- package/lib/constants/enums/delivery.js +9 -1
- package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.d.ts +55 -3
- package/lib/helpers/materialized-reports/materialized-cash-classification-helpers.js +4 -42
- package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.d.ts +2 -1
- package/lib/helpers/materialized-reports/materialized-cash-close-day-helpers.js +2 -2
- package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.d.ts +3 -2
- package/lib/helpers/materialized-reports/materialized-cash-compile-helpers.js +4 -3
- package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.d.ts +32 -3
- package/lib/helpers/materialized-reports/materialized-delivery-classification-helpers.js +5 -1
- package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.d.ts +2 -1
- package/lib/helpers/materialized-reports/materialized-delivery-close-day-helpers.js +8 -7
- package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.d.ts +4 -3
- package/lib/helpers/materialized-reports/materialized-delivery-compile-helpers.js +8 -6
- package/lib/helpers/materialized-reports/materialized-discount-accumulator-helpers.js +2 -1
- package/lib/helpers/materialized-reports/materialized-hourly-comparison-selection-helpers.js +6 -2
- package/lib/helpers/materialized-reports/materialized-payments-comparison-accumulator-helpers.js +2 -1
- package/lib/helpers/materialized-reports/materialized-prep-time-classification-helpers.d.ts +34 -2
- package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.d.ts +7 -5
- package/lib/helpers/materialized-reports/materialized-prep-time-close-day-helpers.js +14 -13
- package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.d.ts +2 -1
- package/lib/helpers/materialized-reports/materialized-prep-time-compile-helpers.js +1 -1
- package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.d.ts +6 -3
- package/lib/helpers/materialized-reports/materialized-reports-scope-group-helpers.js +8 -5
- package/lib/helpers/materialized-reports/materialized-reports-selection-helpers.js +2 -2
- package/lib/helpers/materialized-reports/materialized-sales-comparison-baseline-helpers.js +3 -4
- package/lib/helpers/materialized-reports/tenant-cash-in-out-formatter.js +2 -1
- package/lib/helpers/materialized-reports/tenant-delivery-formatter.js +1 -1
- package/lib/helpers/materialized-reports/tenant-discount-formatter.js +1 -1
- package/lib/helpers/materialized-reports/tenant-hourly-comparison-formatter.js +3 -2
- package/lib/helpers/materialized-reports/tenant-payments-comparison-formatter.js +7 -4
- package/lib/helpers/materialized-reports/tenant-prep-time-formatter.d.ts +2 -1
- package/lib/helpers/materialized-reports/tenant-sales-comparison-formatter.js +7 -4
- package/lib/helpers/reporting-contract/overview-contract.js +5 -4
- package/lib/helpers/rider-earnings/rider-earnings.d.ts +0 -7
- package/lib/helpers/rider-earnings/rider-earnings.js +0 -7
- package/lib/helpers/rider-reports/rider-daily-report.d.ts +4 -2
- package/lib/helpers/rider-reports/rider-daily-report.js +1 -1
- package/lib/helpers/store/common-order-actions.js +3 -2
- package/lib/helpers/types/materialized-reports-apis.d.ts +3 -0
- package/lib/schemas/models/deliveries.d.ts +10 -7
- package/lib/schemas/models/deliveries.js +10 -4
- package/lib/schemas/models/materialized_credit_bills.d.ts +3 -3
- package/lib/schemas/models/materialized_credit_bills.js +1 -1
- package/lib/schemas/models/materialized_tenant_sales_overview_reports.d.ts +3 -3
- package/lib/schemas/models/materialized_tenant_sales_overview_reports.js +1 -1
- package/lib/schemas/types/deliveries.d.ts +2 -2
- package/lib/schemas/types/materialized_tenant_sales_overview_reports.d.ts +7 -0
- package/lib/tests/deliveries-schema.test.d.ts +1 -0
- package/lib/tests/deliveries-schema.test.js +70 -0
- package/lib/tests/materialized-reports/materialized-cash-compile.test.js +2 -1
- package/lib/tests/materialized-reports/materialized-cash-formatter.test.js +2 -1
- package/lib/tests/materialized-reports/materialized-delivery-compile.test.js +7 -6
- package/lib/tests/materialized-reports/materialized-delivery-formatter.test.js +2 -1
- package/lib/tests/materialized-reports/materialized-prep-time-close-day.test.js +7 -6
- package/lib/tests/materialized-reports/materialized-reports-scope-group-helpers.test.js +13 -13
- package/lib/tests/materialized-reports/materialized-sales-comparison-compile.test.js +2 -1
- package/lib/tests/rider-daily-report.test.js +3 -3
- package/package.json +1 -1
|
@@ -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 ===
|
|
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(
|
|
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 + (
|
|
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 ===
|
|
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 ===
|
|
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
|
|
89
|
-
const collected = metric
|
|
90
|
-
const credit = metric
|
|
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,7 +7,8 @@ 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
|
-
|
|
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;
|
|
@@ -15,7 +17,7 @@ export interface IRiderDailySourceDelivery {
|
|
|
15
17
|
rider_revenue?: number | null;
|
|
16
18
|
rider_earnings?: {
|
|
17
19
|
amount?: number | null;
|
|
18
|
-
status?:
|
|
20
|
+
status?: RIDER_EARNINGS_STATUS_ENUM | null;
|
|
19
21
|
} | null;
|
|
20
22
|
}
|
|
21
23
|
export declare function buildRiderDailyReport({ rider_id, local_date, deliveries, computedAt, }: {
|
|
@@ -7,7 +7,7 @@ const completedOrCancelled = (status) => status === delivery_1.DELIVERY_STATUS_E
|
|
|
7
7
|
const finalEarnings = (delivery) => {
|
|
8
8
|
const earnings = delivery.rider_earnings;
|
|
9
9
|
if (earnings != null) {
|
|
10
|
-
return earnings.status ===
|
|
10
|
+
return earnings.status === delivery_1.RIDER_EARNINGS_STATUS_ENUM.FINAL ? Number(earnings.amount) || 0 : 0;
|
|
11
11
|
}
|
|
12
12
|
return Number(delivery.rider_revenue) || 0;
|
|
13
13
|
};
|
|
@@ -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 (
|
|
342
|
-
delete
|
|
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 }`
|
|
@@ -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,6 +38,7 @@ 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
43
|
rider_revenue?: number | null | undefined;
|
|
43
44
|
pickup_food_image_url?: string | null | undefined;
|
|
@@ -52,9 +53,9 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
|
|
|
52
53
|
delivery_minutes?: number | null | undefined;
|
|
53
54
|
rider_earnings?: {
|
|
54
55
|
version: number;
|
|
55
|
-
status:
|
|
56
|
+
status: RIDER_EARNINGS_STATUS_ENUM;
|
|
56
57
|
amount: number;
|
|
57
|
-
rule_type:
|
|
58
|
+
rule_type: RIDER_FEE_TYPE_ENUM;
|
|
58
59
|
per_meter: number;
|
|
59
60
|
distance_step: number;
|
|
60
61
|
distance_meters: number;
|
|
@@ -95,6 +96,7 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
|
|
|
95
96
|
0?: number | null | undefined;
|
|
96
97
|
1?: number | null | undefined;
|
|
97
98
|
}>;
|
|
99
|
+
localDate?: string | null | undefined;
|
|
98
100
|
cancel_reason?: string | null | undefined;
|
|
99
101
|
rider_revenue?: number | null | undefined;
|
|
100
102
|
pickup_food_image_url?: string | null | undefined;
|
|
@@ -109,9 +111,9 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
|
|
|
109
111
|
delivery_minutes?: number | null | undefined;
|
|
110
112
|
rider_earnings?: {
|
|
111
113
|
version: number;
|
|
112
|
-
status:
|
|
114
|
+
status: RIDER_EARNINGS_STATUS_ENUM;
|
|
113
115
|
amount: number;
|
|
114
|
-
rule_type:
|
|
116
|
+
rule_type: RIDER_FEE_TYPE_ENUM;
|
|
115
117
|
per_meter: number;
|
|
116
118
|
distance_step: number;
|
|
117
119
|
distance_meters: number;
|
|
@@ -152,6 +154,7 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
|
|
|
152
154
|
0?: number | null | undefined;
|
|
153
155
|
1?: number | null | undefined;
|
|
154
156
|
}>;
|
|
157
|
+
localDate?: string | null | undefined;
|
|
155
158
|
cancel_reason?: string | null | undefined;
|
|
156
159
|
rider_revenue?: number | null | undefined;
|
|
157
160
|
pickup_food_image_url?: string | null | undefined;
|
|
@@ -166,9 +169,9 @@ export declare const DeliveriesSchema: Schema<any, import("mongoose").Model<any,
|
|
|
166
169
|
delivery_minutes?: number | null | undefined;
|
|
167
170
|
rider_earnings?: {
|
|
168
171
|
version: number;
|
|
169
|
-
status:
|
|
172
|
+
status: RIDER_EARNINGS_STATUS_ENUM;
|
|
170
173
|
amount: number;
|
|
171
|
-
rule_type:
|
|
174
|
+
rule_type: RIDER_FEE_TYPE_ENUM;
|
|
172
175
|
per_meter: number;
|
|
173
176
|
distance_step: number;
|
|
174
177
|
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,
|
|
@@ -149,14 +155,14 @@ exports.DeliveriesSchema = new mongoose_1.Schema({
|
|
|
149
155
|
status: {
|
|
150
156
|
type: String,
|
|
151
157
|
required: true,
|
|
152
|
-
enum:
|
|
153
|
-
default:
|
|
158
|
+
enum: constants_1.ALL_RIDER_EARNINGS_STATUS,
|
|
159
|
+
default: constants_1.RIDER_EARNINGS_STATUS_ENUM.PENDING,
|
|
154
160
|
},
|
|
155
161
|
rule_type: {
|
|
156
162
|
type: String,
|
|
157
163
|
required: true,
|
|
158
|
-
enum:
|
|
159
|
-
default:
|
|
164
|
+
enum: constants_1.ALL_RIDER_FEE_TYPES,
|
|
165
|
+
default: constants_1.RIDER_FEE_TYPE_ENUM.NONE,
|
|
160
166
|
},
|
|
161
167
|
per_meter: { type: Number, required: true, min: 0, default: 0 },
|
|
162
168
|
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: {
|
|
@@ -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;
|
|
@@ -51,7 +51,7 @@ export interface IDelivery {
|
|
|
51
51
|
export interface IRiderEarningsSnapshot {
|
|
52
52
|
/** CENTS. */
|
|
53
53
|
amount: number;
|
|
54
|
-
status:
|
|
54
|
+
status: RIDER_EARNINGS_STATUS_ENUM;
|
|
55
55
|
rule_type: RIDER_FEE_TYPE_ENUM;
|
|
56
56
|
/** Raw tenant value, scaled by 100000. */
|
|
57
57
|
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 {};
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const delivery_1 = require("../constants/enums/delivery");
|
|
4
|
+
const deliveries_1 = require("../schemas/models/deliveries");
|
|
5
|
+
/**
|
|
6
|
+
* IDelivery and DeliveriesSchema are a contract pair. Keep this list aligned
|
|
7
|
+
* with the interface so a field cannot silently exist on only one side.
|
|
8
|
+
*/
|
|
9
|
+
const IDELIVERY_TOP_LEVEL_FIELDS = [
|
|
10
|
+
'order_id',
|
|
11
|
+
'order_number',
|
|
12
|
+
'rider_id',
|
|
13
|
+
'tenant_id',
|
|
14
|
+
'rider_name',
|
|
15
|
+
'tenant_name',
|
|
16
|
+
'tenant_image_url',
|
|
17
|
+
'tenant_coordinates',
|
|
18
|
+
'tenant_currency_symbol',
|
|
19
|
+
'tenant_address',
|
|
20
|
+
'tenant_phone_numbers',
|
|
21
|
+
'status',
|
|
22
|
+
'cancel_reason',
|
|
23
|
+
'localDate',
|
|
24
|
+
'polyline',
|
|
25
|
+
'distance_in_meters_from_store',
|
|
26
|
+
'rider_revenue',
|
|
27
|
+
'pickup_food_image_url',
|
|
28
|
+
'dropoff_food_image_url',
|
|
29
|
+
'tracking_enabled',
|
|
30
|
+
'assigned_at',
|
|
31
|
+
'picked_up_at',
|
|
32
|
+
'expected_delivery_at',
|
|
33
|
+
'delivered_at',
|
|
34
|
+
'cancelled_at',
|
|
35
|
+
'status_updated_count',
|
|
36
|
+
'delivery_minutes',
|
|
37
|
+
'rider_earnings',
|
|
38
|
+
'createdAt_mins',
|
|
39
|
+
'createdAt',
|
|
40
|
+
'updatedAt',
|
|
41
|
+
];
|
|
42
|
+
const IDRIDER_EARNINGS_FIELDS = [
|
|
43
|
+
'amount',
|
|
44
|
+
'status',
|
|
45
|
+
'rule_type',
|
|
46
|
+
'per_meter',
|
|
47
|
+
'distance_step',
|
|
48
|
+
'distance_meters',
|
|
49
|
+
'delivery_charge',
|
|
50
|
+
'calculated_at',
|
|
51
|
+
'version',
|
|
52
|
+
];
|
|
53
|
+
describe('IDelivery / DeliveriesSchema sync', () => {
|
|
54
|
+
it('defines every IDelivery top-level field on the model', () => {
|
|
55
|
+
for (const field of IDELIVERY_TOP_LEVEL_FIELDS) {
|
|
56
|
+
expect(deliveries_1.DeliveriesSchema.path(field)).toBeDefined();
|
|
57
|
+
}
|
|
58
|
+
});
|
|
59
|
+
it('defines every rider_earnings field on the nested model', () => {
|
|
60
|
+
const nested = deliveries_1.DeliveriesSchema.path('rider_earnings');
|
|
61
|
+
expect(nested).toBeDefined();
|
|
62
|
+
for (const field of IDRIDER_EARNINGS_FIELDS) {
|
|
63
|
+
expect(nested.schema.path(field)).toBeDefined();
|
|
64
|
+
}
|
|
65
|
+
const statusPath = nested.schema.path('status');
|
|
66
|
+
const ruleTypePath = nested.schema.path('rule_type');
|
|
67
|
+
expect(statusPath.enumValues).toEqual(delivery_1.ALL_RIDER_EARNINGS_STATUS);
|
|
68
|
+
expect(ruleTypePath.enumValues).toEqual(delivery_1.ALL_RIDER_FEE_TYPES);
|
|
69
|
+
});
|
|
70
|
+
});
|
|
@@ -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_cash_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-cash-compile-helpers");
|
|
4
5
|
/**
|
|
5
6
|
* M3 day compile.
|
|
@@ -107,7 +108,7 @@ describe('M3 day compile', () => {
|
|
|
107
108
|
const report = compiled.reports[0];
|
|
108
109
|
expect(report.scope_context).toBe('localDate');
|
|
109
110
|
expect(report.scope_field).toBe(DAY);
|
|
110
|
-
expect(report.day_index).toBe(
|
|
111
|
+
expect(report.day_index).toBe(ENUMS_1.DAY_INDEX_ENUM.MON);
|
|
111
112
|
expect(report.sale_type_key_filters).toEqual(['DRAWER_ID', 'REF_TYPE']);
|
|
112
113
|
// the map and the rows must describe the SAME counters.
|
|
113
114
|
const rows = report.cash_counter_rows;
|
|
@@ -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_cash_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-cash-compile-helpers");
|
|
4
5
|
const tenant_cash_in_out_formatter_1 = require("../../helpers/materialized-reports/tenant-cash-in-out-formatter");
|
|
5
6
|
/**
|
|
@@ -111,7 +112,7 @@ describe('M3 formatter', () => {
|
|
|
111
112
|
expect(page.variance_trend[0].variance).toBe(10);
|
|
112
113
|
expect(page.weekday).not.toBeNull();
|
|
113
114
|
// 2026-09-14 is a Monday
|
|
114
|
-
expect(page.weekday[0].day_index).toBe(
|
|
115
|
+
expect(page.weekday[0].day_index).toBe(ENUMS_1.DAY_INDEX_ENUM.MON);
|
|
115
116
|
});
|
|
116
117
|
it('leaves the trend null for a period-only selection instead of guessing', () => {
|
|
117
118
|
const compiled = closedDay(12000);
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const delivery_1 = require("../../constants/enums/delivery");
|
|
3
4
|
const materialized_delivery_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-delivery-compile-helpers");
|
|
4
5
|
/**
|
|
5
6
|
* M4 day compile.
|
|
@@ -194,7 +195,7 @@ describe('M4 day compile', () => {
|
|
|
194
195
|
const snapshot = (status) => ({
|
|
195
196
|
amount: 900,
|
|
196
197
|
status,
|
|
197
|
-
rule_type:
|
|
198
|
+
rule_type: delivery_1.RIDER_FEE_TYPE_ENUM.DISTANCE_ONE_WAY,
|
|
198
199
|
per_meter: 5000,
|
|
199
200
|
distance_step: 1000,
|
|
200
201
|
distance_meters: 3000,
|
|
@@ -208,14 +209,14 @@ describe('M4 day compile', () => {
|
|
|
208
209
|
});
|
|
209
210
|
return Object.values(compiled.entries[0].delivery_entries).flatMap((section) => section.rows)[0];
|
|
210
211
|
};
|
|
211
|
-
expect(rowFor(
|
|
212
|
-
expect(rowFor(
|
|
212
|
+
expect(rowFor(delivery_1.RIDER_EARNINGS_STATUS_ENUM.PENDING).rider_revenue).toBeNull();
|
|
213
|
+
expect(rowFor(delivery_1.RIDER_EARNINGS_STATUS_ENUM.FINAL).rider_revenue).toBe(900);
|
|
213
214
|
});
|
|
214
215
|
it('counts only FINAL rider payouts, never a pending estimate', () => {
|
|
215
216
|
const snapshot = (status) => ({
|
|
216
217
|
amount: 900,
|
|
217
218
|
status,
|
|
218
|
-
rule_type:
|
|
219
|
+
rule_type: delivery_1.RIDER_FEE_TYPE_ENUM.DISTANCE_ONE_WAY,
|
|
219
220
|
per_meter: 5000,
|
|
220
221
|
distance_step: 1000,
|
|
221
222
|
distance_meters: 3000,
|
|
@@ -224,11 +225,11 @@ describe('M4 day compile', () => {
|
|
|
224
225
|
version: 1,
|
|
225
226
|
});
|
|
226
227
|
const pending = compile({
|
|
227
|
-
deliveries: [delivery({ rider_revenue: 900, rider_earnings: snapshot(
|
|
228
|
+
deliveries: [delivery({ rider_revenue: 900, rider_earnings: snapshot(delivery_1.RIDER_EARNINGS_STATUS_ENUM.PENDING) })],
|
|
228
229
|
});
|
|
229
230
|
expect(Object.values(pending.reports[0].delivery_counters)[0].money.rider_revenue_amount).toBe(0);
|
|
230
231
|
const final = compile({
|
|
231
|
-
deliveries: [delivery({ rider_revenue: 900, rider_earnings: snapshot(
|
|
232
|
+
deliveries: [delivery({ rider_revenue: 900, rider_earnings: snapshot(delivery_1.RIDER_EARNINGS_STATUS_ENUM.FINAL) })],
|
|
232
233
|
});
|
|
233
234
|
expect(Object.values(final.reports[0].delivery_counters)[0].money.rider_revenue_amount).toBe(900);
|
|
234
235
|
});
|
|
@@ -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_delivery_compile_helpers_1 = require("../../helpers/materialized-reports/materialized-delivery-compile-helpers");
|
|
4
5
|
const tenant_delivery_formatter_1 = require("../../helpers/materialized-reports/tenant-delivery-formatter");
|
|
5
6
|
/**
|
|
@@ -121,7 +122,7 @@ describe('M4 formatter', () => {
|
|
|
121
122
|
const o = order();
|
|
122
123
|
const page = format([o], [delivery(String(o._id))])[0][0];
|
|
123
124
|
expect(page.weekday).not.toBeNull();
|
|
124
|
-
expect(page.weekday[0].day_index).toBe(
|
|
125
|
+
expect(page.weekday[0].day_index).toBe(ENUMS_1.DAY_INDEX_ENUM.MON);
|
|
125
126
|
expect(page.weekday[0].deliveries).toBe(1);
|
|
126
127
|
});
|
|
127
128
|
it('splits one view per tenant when asked', () => {
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
|
|
3
4
|
const materialized_prep_time_close_day_helpers_1 = require("../../helpers/materialized-reports/materialized-prep-time-close-day-helpers");
|
|
4
5
|
const scope_helpers_1 = require("../../helpers/materialized-reports/scope-helpers");
|
|
5
6
|
/**
|
|
@@ -184,7 +185,7 @@ describe('foldMaterializedPrepTimePeriodCounters', () => {
|
|
|
184
185
|
}),
|
|
185
186
|
];
|
|
186
187
|
const folded = (0, materialized_prep_time_close_day_helpers_1.foldMaterializedPrepTimePeriodCounters)({
|
|
187
|
-
periodScope:
|
|
188
|
+
periodScope: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_MONTH,
|
|
188
189
|
periodScopeField: '2026-09',
|
|
189
190
|
dayDocuments: days,
|
|
190
191
|
periodFieldsOfDay: fieldsOf,
|
|
@@ -205,7 +206,7 @@ describe('foldMaterializedPrepTimePeriodCounters', () => {
|
|
|
205
206
|
dayDoc('2026-08-13', { coverage: { item_count: 99 } }),
|
|
206
207
|
];
|
|
207
208
|
const folded = (0, materialized_prep_time_close_day_helpers_1.foldMaterializedPrepTimePeriodCounters)({
|
|
208
|
-
periodScope:
|
|
209
|
+
periodScope: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_MONTH,
|
|
209
210
|
periodScopeField: '2026-09',
|
|
210
211
|
dayDocuments: days,
|
|
211
212
|
periodFieldsOfDay: fieldsOf,
|
|
@@ -219,7 +220,7 @@ describe('foldMaterializedPrepTimePeriodCounters', () => {
|
|
|
219
220
|
// The caller supplies the AUTHORITATIVE day set, so a re-close passes the day
|
|
220
221
|
// once (not twice) - the fold sees one entry per day by construction.
|
|
221
222
|
const folded = (0, materialized_prep_time_close_day_helpers_1.foldMaterializedPrepTimePeriodCounters)({
|
|
222
|
-
periodScope:
|
|
223
|
+
periodScope: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_MONTH,
|
|
223
224
|
periodScopeField: '2026-09',
|
|
224
225
|
dayDocuments: [day],
|
|
225
226
|
periodFieldsOfDay: fieldsOf,
|
|
@@ -234,7 +235,7 @@ describe('foldMaterializedPrepTimePeriodCounters', () => {
|
|
|
234
235
|
dayDoc('2026-09-20', { coverage: { item_count: 7 } }),
|
|
235
236
|
];
|
|
236
237
|
const folded = (0, materialized_prep_time_close_day_helpers_1.foldMaterializedPrepTimePeriodCounters)({
|
|
237
|
-
periodScope:
|
|
238
|
+
periodScope: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_WEEK,
|
|
238
239
|
periodScopeField: '2026-09-13',
|
|
239
240
|
dayDocuments: days,
|
|
240
241
|
periodFieldsOfDay: fieldsOf,
|
|
@@ -243,7 +244,7 @@ describe('foldMaterializedPrepTimePeriodCounters', () => {
|
|
|
243
244
|
});
|
|
244
245
|
it('returns an empty map for a period with no days', () => {
|
|
245
246
|
const folded = (0, materialized_prep_time_close_day_helpers_1.foldMaterializedPrepTimePeriodCounters)({
|
|
246
|
-
periodScope:
|
|
247
|
+
periodScope: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_MONTH,
|
|
247
248
|
periodScopeField: '2026-12',
|
|
248
249
|
dayDocuments: [dayDoc('2026-09-13')],
|
|
249
250
|
periodFieldsOfDay: fieldsOf,
|
|
@@ -260,7 +261,7 @@ describe('foldMaterializedPrepTimePeriodRows', () => {
|
|
|
260
261
|
prep_time_entries: { K: { rows: [row({ order_id: orderId })] } },
|
|
261
262
|
});
|
|
262
263
|
const sections = (0, materialized_prep_time_close_day_helpers_1.foldMaterializedPrepTimePeriodRows)({
|
|
263
|
-
periodScope:
|
|
264
|
+
periodScope: MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_MONTH,
|
|
264
265
|
periodScopeField: '2026-09',
|
|
265
266
|
dayDocuments: [dayEntries('2026-09-13', 'd1'), dayEntries('2026-09-14', 'd2')],
|
|
266
267
|
periodFieldsOfDay: fieldsOf,
|