@managesome/eposmatic-toolkit 0.2.777 → 0.2.778

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.
@@ -1,2 +1,41 @@
1
+ import moment from 'moment';
1
2
  import { IDelivery, IDeliveryOrder } from '../../schemas';
2
3
  export declare function getDeliveryWithPrice<T extends IDelivery | IDeliveryOrder | Partial<IDelivery> | Partial<IDeliveryOrder>>(delivery: T, writeable?: boolean): T;
4
+ /**
5
+ * Calculate the expected delivery time for a delivery order.
6
+ *
7
+ * Priority:
8
+ * 1. `order.delivery_details.estimated_delivery_time` - the promised ETA.
9
+ * 2. ASAP orders (null ETA): `createdAt` + the tenant's default `delivery_time` in milliseconds -
10
+ * the same value used as `now + delivery_time` when the order is punched.
11
+ * 3. Distance-based fallback (only when the tenant setting is unavailable): travel time at
12
+ * 2 minutes per km plus the tenant's default `default_prep_minutes`; a flat 25 minutes when
13
+ * the distance is unknown (0 m).
14
+ *
15
+ * @param deliveryTimeMs Tenant's default `delivery_time` settings value, in milliseconds.
16
+ * @param prepMinutes Tenant's default `default_prep_minutes` settings value, in minutes - added
17
+ * to the distance-based travel estimate.
18
+ */
19
+ export declare const getDeliveryExpectedTime: (delivery: IDeliveryOrder, deliveryTimeMs?: number | null, prepMinutes?: number | null) => {
20
+ expectedTime: moment.Moment;
21
+ isCalculated: boolean;
22
+ };
23
+ /**
24
+ * Completion tag for a finished delivery, based on how `updatedAt` (treated as the completion
25
+ * time) compares to the expected delivery time from `getDeliveryExpectedTime`.
26
+ *
27
+ * - Completed at least 1 minute before the expected time -> "Good" (success).
28
+ * - Completed within 1 minute of the expected time -> "Slight Delay" (warning).
29
+ * - Completed more than 1 minute after the expected time -> "Late" (error).
30
+ *
31
+ * `completionTime` is the total delivery duration (`updatedAt` - `createdAt`) formatted as
32
+ * `Xm` or `Xh Ym`. Returns `null` for deliveries that are not completed.
33
+ *
34
+ * @param deliveryTimeMs Tenant's default `delivery_time` settings value, in milliseconds.
35
+ * @param prepMinutes Tenant's default `default_prep_minutes` settings value, in minutes.
36
+ */
37
+ export declare const getDeliveryCompletionTag: (delivery: IDeliveryOrder, deliveryTimeMs?: number | null, prepMinutes?: number | null) => {
38
+ label: string;
39
+ color: "success" | "warning" | "error";
40
+ completionTime: string;
41
+ } | null;
@@ -1,6 +1,12 @@
1
1
  "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
2
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.getDeliveryCompletionTag = exports.getDeliveryExpectedTime = void 0;
3
7
  exports.getDeliveryWithPrice = getDeliveryWithPrice;
8
+ const moment_1 = __importDefault(require("moment"));
9
+ const constants_1 = require("../../constants");
4
10
  const price_conversion_1 = require("./price-conversion");
5
11
  function getDeliveryWithPrice(delivery, writeable) {
6
12
  const convertToPrice = writeable ? price_conversion_1.convertPriceToCents : price_conversion_1.convertPriceFromCents;
@@ -13,3 +19,78 @@ function getDeliveryWithPrice(delivery, writeable) {
13
19
  : {}),
14
20
  };
15
21
  }
22
+ /** Distance-based fallback: 0 m -> 25 minutes; otherwise prep minutes + 2 minutes per km. */
23
+ const FALLBACK_ZERO_DISTANCE_MINUTES = 25;
24
+ const FALLBACK_MINUTES_PER_KM = 2;
25
+ /**
26
+ * Calculate the expected delivery time for a delivery order.
27
+ *
28
+ * Priority:
29
+ * 1. `order.delivery_details.estimated_delivery_time` - the promised ETA.
30
+ * 2. ASAP orders (null ETA): `createdAt` + the tenant's default `delivery_time` in milliseconds -
31
+ * the same value used as `now + delivery_time` when the order is punched.
32
+ * 3. Distance-based fallback (only when the tenant setting is unavailable): travel time at
33
+ * 2 minutes per km plus the tenant's default `default_prep_minutes`; a flat 25 minutes when
34
+ * the distance is unknown (0 m).
35
+ *
36
+ * @param deliveryTimeMs Tenant's default `delivery_time` settings value, in milliseconds.
37
+ * @param prepMinutes Tenant's default `default_prep_minutes` settings value, in minutes - added
38
+ * to the distance-based travel estimate.
39
+ */
40
+ const getDeliveryExpectedTime = (delivery, deliveryTimeMs, prepMinutes) => {
41
+ const expectedTimeValue = delivery.order?.delivery_details?.estimated_delivery_time;
42
+ if (expectedTimeValue) {
43
+ return { expectedTime: (0, moment_1.default)(expectedTimeValue), isCalculated: false };
44
+ }
45
+ const createdAt = (0, moment_1.default)(delivery.createdAt);
46
+ // ASAP case: same value used when punching the order (now + delivery_time).
47
+ if (deliveryTimeMs != null && deliveryTimeMs > 0) {
48
+ return { expectedTime: createdAt.clone().add(deliveryTimeMs, 'milliseconds'), isCalculated: true };
49
+ }
50
+ const distanceInMeters = delivery.order?.delivery_details?.distance_in_meters_from_store || 0;
51
+ const prepOffsetMinutes = prepMinutes != null && prepMinutes > 0 ? prepMinutes : 0;
52
+ const deliveryMinutes = distanceInMeters === 0
53
+ ? FALLBACK_ZERO_DISTANCE_MINUTES
54
+ : prepOffsetMinutes + (distanceInMeters / 1000) * FALLBACK_MINUTES_PER_KM;
55
+ return { expectedTime: createdAt.clone().add(deliveryMinutes, 'minutes'), isCalculated: true };
56
+ };
57
+ exports.getDeliveryExpectedTime = getDeliveryExpectedTime;
58
+ /**
59
+ * Completion tag for a finished delivery, based on how `updatedAt` (treated as the completion
60
+ * time) compares to the expected delivery time from `getDeliveryExpectedTime`.
61
+ *
62
+ * - Completed at least 1 minute before the expected time -> "Good" (success).
63
+ * - Completed within 1 minute of the expected time -> "Slight Delay" (warning).
64
+ * - Completed more than 1 minute after the expected time -> "Late" (error).
65
+ *
66
+ * `completionTime` is the total delivery duration (`updatedAt` - `createdAt`) formatted as
67
+ * `Xm` or `Xh Ym`. Returns `null` for deliveries that are not completed.
68
+ *
69
+ * @param deliveryTimeMs Tenant's default `delivery_time` settings value, in milliseconds.
70
+ * @param prepMinutes Tenant's default `default_prep_minutes` settings value, in minutes.
71
+ */
72
+ const getDeliveryCompletionTag = (delivery, deliveryTimeMs, prepMinutes) => {
73
+ if (delivery.status !== constants_1.DELIVERY_STATUS_ENUM.COMPLETED)
74
+ return null;
75
+ const completedAt = (0, moment_1.default)(delivery.updatedAt);
76
+ const createdAt = (0, moment_1.default)(delivery.createdAt);
77
+ const { expectedTime } = (0, exports.getDeliveryExpectedTime)(delivery, deliveryTimeMs, prepMinutes);
78
+ const diffMinutes = completedAt.diff(expectedTime, 'minutes');
79
+ const totalSeconds = completedAt.diff(createdAt, 'seconds');
80
+ const hours = Math.floor(totalSeconds / 3600);
81
+ const minutes = Math.floor((totalSeconds % 3600) / 60);
82
+ const completionTime = hours > 0 ? `${hours}h ${minutes}m` : `${minutes}m`;
83
+ if (diffMinutes <= -1) {
84
+ // Completed before expected time by at least 1 minute.
85
+ return { label: 'Good', color: 'success', completionTime };
86
+ }
87
+ else if (diffMinutes <= 1) {
88
+ // Completed within 1 minute of expected time.
89
+ return { label: 'Slight Delay', color: 'warning', completionTime };
90
+ }
91
+ else {
92
+ // Completed after expected time by more than 1 minute.
93
+ return { label: 'Late', color: 'error', completionTime };
94
+ }
95
+ };
96
+ exports.getDeliveryCompletionTag = getDeliveryCompletionTag;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,80 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const constants_1 = require("../constants");
4
+ const delivery_helpers_1 = require("../helpers/utils/delivery-helpers");
5
+ const CREATED_AT = new Date('2026-09-22T10:00:00.000Z');
6
+ const delivery = ({ estimatedDeliveryTime = null, distanceInMeters = 0, createdAt = CREATED_AT, updatedAt = new Date(CREATED_AT.getTime() + 20 * 60000), status = constants_1.DELIVERY_STATUS_ENUM.COMPLETED, } = {}) => ({
7
+ createdAt,
8
+ updatedAt,
9
+ status,
10
+ order: {
11
+ delivery_details: {
12
+ estimated_delivery_time: estimatedDeliveryTime,
13
+ distance_in_meters_from_store: distanceInMeters,
14
+ },
15
+ },
16
+ });
17
+ describe('getDeliveryExpectedTime', () => {
18
+ it('uses the promised estimated_delivery_time as-is', () => {
19
+ const eta = new Date('2026-09-22T11:00:00.000Z');
20
+ const { expectedTime, isCalculated } = (0, delivery_helpers_1.getDeliveryExpectedTime)(delivery({ estimatedDeliveryTime: eta }), 3600000);
21
+ expect(expectedTime.valueOf()).toBe(eta.getTime());
22
+ expect(isCalculated).toBe(false);
23
+ });
24
+ it('uses createdAt + delivery_time for ASAP orders when the tenant setting is available', () => {
25
+ const { expectedTime, isCalculated } = (0, delivery_helpers_1.getDeliveryExpectedTime)(delivery({ distanceInMeters: 4000 }), 45 * 60000);
26
+ expect(expectedTime.valueOf()).toBe(CREATED_AT.getTime() + 45 * 60000);
27
+ expect(isCalculated).toBe(true);
28
+ });
29
+ it('falls back to 25 minutes for 0 distance when the tenant setting is unavailable', () => {
30
+ const { expectedTime, isCalculated } = (0, delivery_helpers_1.getDeliveryExpectedTime)(delivery({ distanceInMeters: 0 }));
31
+ expect(expectedTime.valueOf()).toBe(CREATED_AT.getTime() + 25 * 60000);
32
+ expect(isCalculated).toBe(true);
33
+ });
34
+ it('falls back to 2 minutes per km when the tenant setting is unavailable', () => {
35
+ const { expectedTime } = (0, delivery_helpers_1.getDeliveryExpectedTime)(delivery({ distanceInMeters: 3000 }), null);
36
+ expect(expectedTime.valueOf()).toBe(CREATED_AT.getTime() + 6 * 60000);
37
+ });
38
+ it('ignores a zero tenant delivery_time and falls back to distance', () => {
39
+ const { expectedTime } = (0, delivery_helpers_1.getDeliveryExpectedTime)(delivery({ distanceInMeters: 3000 }), 0);
40
+ expect(expectedTime.valueOf()).toBe(CREATED_AT.getTime() + 6 * 60000);
41
+ });
42
+ it('adds the tenant prep minutes to the per-km travel estimate', () => {
43
+ const { expectedTime } = (0, delivery_helpers_1.getDeliveryExpectedTime)(delivery({ distanceInMeters: 3000 }), null, 15);
44
+ expect(expectedTime.valueOf()).toBe(CREATED_AT.getTime() + 21 * 60000);
45
+ });
46
+ it('keeps the flat default for 0 distance even when prep minutes are provided', () => {
47
+ const { expectedTime } = (0, delivery_helpers_1.getDeliveryExpectedTime)(delivery({ distanceInMeters: 0 }), null, 15);
48
+ expect(expectedTime.valueOf()).toBe(CREATED_AT.getTime() + 25 * 60000);
49
+ });
50
+ });
51
+ describe('getDeliveryCompletionTag', () => {
52
+ // With a 25 minute delivery_time the expected ETA is 10:25 for CREATED_AT.
53
+ const DELIVERY_TIME_MS = 25 * 60000;
54
+ const at = (minutes) => new Date(CREATED_AT.getTime() + minutes * 60000);
55
+ it('returns null for deliveries that are not completed', () => {
56
+ const tag = (0, delivery_helpers_1.getDeliveryCompletionTag)(delivery({ status: constants_1.DELIVERY_STATUS_ENUM.IN_PROGRESS }), DELIVERY_TIME_MS);
57
+ expect(tag).toBeNull();
58
+ });
59
+ it('tags a delivery completed early as Good', () => {
60
+ const tag = (0, delivery_helpers_1.getDeliveryCompletionTag)(delivery({ updatedAt: at(20) }), DELIVERY_TIME_MS);
61
+ expect(tag).toEqual({ label: 'Good', color: 'success', completionTime: '20m' });
62
+ });
63
+ it('tags a delivery completed within one minute of the ETA as Slight Delay', () => {
64
+ const tag = (0, delivery_helpers_1.getDeliveryCompletionTag)(delivery({ updatedAt: at(25) }), DELIVERY_TIME_MS);
65
+ expect(tag).toEqual({ label: 'Slight Delay', color: 'warning', completionTime: '25m' });
66
+ });
67
+ it('tags a late delivery with the total completion time', () => {
68
+ const tag = (0, delivery_helpers_1.getDeliveryCompletionTag)(delivery({ updatedAt: at(51) }), DELIVERY_TIME_MS);
69
+ expect(tag).toEqual({ label: 'Late', color: 'error', completionTime: '51m' });
70
+ });
71
+ it('reports completion times over an hour as Xh Ym', () => {
72
+ const tag = (0, delivery_helpers_1.getDeliveryCompletionTag)(delivery({ updatedAt: at(65) }), DELIVERY_TIME_MS);
73
+ expect(tag).toEqual({ label: 'Late', color: 'error', completionTime: '1h 5m' });
74
+ });
75
+ it('includes prep minutes in the expected time used for the completion tag', () => {
76
+ // Expected: 10:00 + 20 prep + 2 (1 km) = 10:22; completed 10:25 -> 3 min late.
77
+ const tag = (0, delivery_helpers_1.getDeliveryCompletionTag)(delivery({ distanceInMeters: 1000, updatedAt: at(25) }), null, 20);
78
+ expect(tag).toEqual({ label: 'Late', color: 'error', completionTime: '25m' });
79
+ });
80
+ });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@managesome/eposmatic-toolkit",
3
- "version": "0.2.777",
3
+ "version": "0.2.778",
4
4
  "description": "A Toolkit Library for Eposmatic",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",