sahab-utils 1.8.5 → 1.8.8

package/dist/constants/types.d.ts

@@ -152,6 +152,10 @@ export type Order = {
     customerNotificationTaskId?: string;
     /** Set on an order created by re-ordering, pointing at the one it was copied from. */
     originalOrderId?: string;
+    /** Multi-visit package only: 1-based position of this order in the package. Every visit is its own order. */
+    visitNumber?: number;
+    /** Multi-visit package only: what the customer pays for the whole package, stamped on every visit. */
+    originalPrice?: number;
 };
 export type ReduxOrder = {
     orderId?: string;

package/dist/index.d.ts

@@ -10,3 +10,4 @@ export * from './ts/orderActivity';
 export * from './ts/push';
 export * from './ts/utils';
 export * from './ts/wheel';
+export * from './ts/workingHours';

package/dist/index.js

@@ -26,3 +26,4 @@ __exportStar(require("./ts/orderActivity"), exports);
 __exportStar(require("./ts/push"), exports);
 __exportStar(require("./ts/utils"), exports);
 __exportStar(require("./ts/wheel"), exports);
+__exportStar(require("./ts/workingHours"), exports);

package/dist/ts/calcs.d.ts

@@ -2,6 +2,10 @@ import { Order } from '../constants/types';
 export declare const SAHAB_PERCENTAGE = 0;
 export declare const ONLINE_SAHAB_PERCENTAGE = 0.03;
 export declare const CLIENT_SAHAB_PERCENTAGE = 0.03;
+/** What the customer sees for a provider's price: `p + pct * p`. The operand order is kept as the apps and server always wrote it. */
+export declare function customerPriceFromProviderPrice(providerPrice: number, percentage?: number): number;
+/** Inverse of `customerPriceFromProviderPrice`: the provider's own price inside a customer-facing figure. */
+export declare function providerPriceFromCustomerPrice(customerPrice: number, percentage?: number): number;
 export declare const PROVIDER_ORDERS_PERCENTAGE_DEFAULT = 0.1;
 export declare const PROVIDER_ORDERS_PERCENTAGE_WITH_SAHAB_LOGO = 0.07;
 export declare function providerOrdersPercentage(hasSahabLogoOnCar: boolean | undefined, storedValue: unknown): number;
@@ -10,6 +14,10 @@ export declare function getSahabDiscountsAmount(order: Order): number;
 export declare function getProviderDiscountsAmount(order: Order): number;
 export declare function getOrderTotalDiscountsAmount(order: Order): number;
 export declare function getCustomerTotalToPay(order: Order): number;
+/** What was actually collected: the washer's cash, which already includes Sahab's surcharge, or the online charge.
+ *  The provider holds all of the cash, so the surcharge must stay in this figure for the transfer to take it back.
+ *  A finished cash order with no recorded amount (every order before the server wrote it) is treated as fully paid. */
+export declare function settledPaymentAmount(order: Order): number;
 export declare function getProviderTransferAmount(order: Order): number;
 export declare function getProviderProfits(order: Order): number;
 export declare function getOnlineProcessingFees(order: Order): number;

package/dist/ts/calcs.js

@@ -4,12 +4,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PROVIDER_ORDERS_PERCENTAGE_WITH_SAHAB_LOGO = exports.PROVIDER_ORDERS_PERCENTAGE_DEFAULT = exports.CLIENT_SAHAB_PERCENTAGE = exports.ONLINE_SAHAB_PERCENTAGE = exports.SAHAB_PERCENTAGE = void 0;
+exports.customerPriceFromProviderPrice = customerPriceFromProviderPrice;
+exports.providerPriceFromCustomerPrice = providerPriceFromCustomerPrice;
 exports.providerOrdersPercentage = providerOrdersPercentage;
 exports.getServicesTotal = getServicesTotal;
 exports.getSahabDiscountsAmount = getSahabDiscountsAmount;
 exports.getProviderDiscountsAmount = getProviderDiscountsAmount;
 exports.getOrderTotalDiscountsAmount = getOrderTotalDiscountsAmount;
 exports.getCustomerTotalToPay = getCustomerTotalToPay;
+exports.settledPaymentAmount = settledPaymentAmount;
 exports.getProviderTransferAmount = getProviderTransferAmount;
 exports.getProviderProfits = getProviderProfits;
 exports.getOnlineProcessingFees = getOnlineProcessingFees;
@@ -23,6 +26,14 @@ const utils_1 = require("./utils");
 exports.SAHAB_PERCENTAGE = 0;
 exports.ONLINE_SAHAB_PERCENTAGE = 0.03;
 exports.CLIENT_SAHAB_PERCENTAGE = 0.03;
+/** What the customer sees for a provider's price: `p + pct * p`. The operand order is kept as the apps and server always wrote it. */
+function customerPriceFromProviderPrice(providerPrice, percentage = exports.CLIENT_SAHAB_PERCENTAGE) {
+    return providerPrice + percentage * providerPrice;
+}
+/** Inverse of `customerPriceFromProviderPrice`: the provider's own price inside a customer-facing figure. */
+function providerPriceFromCustomerPrice(customerPrice, percentage = exports.CLIENT_SAHAB_PERCENTAGE) {
+    return customerPrice / (1 + percentage);
+}
 // `Provider.ordersPercentage` — the provider's own cut of an order, factored into
 // `sahabProviderPercentage` server-side. Only two values are ever valid: the default, or the
 // reduced rate for a provider that's put the Sahab logo on their car.
@@ -196,16 +207,23 @@ function cashSurcharge(order) {
     return (order === null || order === void 0 ? void 0 : order.paymentType) === types_1.OrderPaymentType.CASH ? Math.max(0, (0, utils_1.preventNaN)((_a = order === null || order === void 0 ? void 0 : order.sahabExtraPaymentAmount) !== null && _a !== void 0 ? _a : 0)) : 0;
 }
 /** What was actually collected: the washer's cash, which already includes Sahab's surcharge, or the online charge.
- *  The provider holds all of the cash, so the surcharge must stay in this figure for the transfer to take it back. */
+ *  The provider holds all of the cash, so the surcharge must stay in this figure for the transfer to take it back.
+ *  A finished cash order with no recorded amount (every order before the server wrote it) is treated as fully paid. */
 function settledPaymentAmount(order) {
     var _a;
-    return (order === null || order === void 0 ? void 0 : order.paymentType) === types_1.OrderPaymentType.CASH ? (0, utils_1.preventNaN)((_a = order === null || order === void 0 ? void 0 : order.paymentAmount) !== null && _a !== void 0 ? _a : 0) : getCustomerTotalToPay(order);
+    if ((order === null || order === void 0 ? void 0 : order.paymentType) !== types_1.OrderPaymentType.CASH)
+        return getCustomerTotalToPay(order);
+    const recorded = (0, utils_1.preventNaN)((_a = order === null || order === void 0 ? void 0 : order.paymentAmount) !== null && _a !== void 0 ? _a : 0);
+    if (recorded > 0)
+        return recorded;
+    const finished = (order === null || order === void 0 ? void 0 : order.orderStatus) === types_1.OrderStatus.COMPLETED || (order === null || order === void 0 ? void 0 : order.orderStatus) === types_1.OrderStatus.RATED;
+    return finished ? Math.max(0, (0, utils_1.preventNaN)(getCustomerTotalToPay(order))) : recorded;
 }
 function getProviderTransferAmount(order) {
     var _a, _b;
     const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order);
     const paymentAmount = settledPaymentAmount(order);
-    const originalPrice = orderTotal / (1 + (0, utils_1.preventNaN)((_a = order === null || order === void 0 ? void 0 : order.sahabClientPercentage) !== null && _a !== void 0 ? _a : 0));
+    const originalPrice = providerPriceFromCustomerPrice(orderTotal, (0, utils_1.preventNaN)((_a = order === null || order === void 0 ? void 0 : order.sahabClientPercentage) !== null && _a !== void 0 ? _a : 0));
     const minimumProviderAmount = originalPrice - originalPrice * ((_b = order === null || order === void 0 ? void 0 : order.sahabProviderPercentage) !== null && _b !== void 0 ? _b : 0);
     if ((order === null || order === void 0 ? void 0 : order.paymentType) === types_1.OrderPaymentType.CASH) {
         return minimumProviderAmount - paymentAmount;
@@ -231,7 +249,7 @@ function getSahabFees(order) {
     var _a, _b;
     const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order);
     const paymentAmount = settledPaymentAmount(order);
-    const originalPrice = orderTotal / (1 + (0, utils_1.preventNaN)((_a = order === null || order === void 0 ? void 0 : order.sahabClientPercentage) !== null && _a !== void 0 ? _a : 0));
+    const originalPrice = providerPriceFromCustomerPrice(orderTotal, (0, utils_1.preventNaN)((_a = order === null || order === void 0 ? void 0 : order.sahabClientPercentage) !== null && _a !== void 0 ? _a : 0));
     const minimumProviderAmount = originalPrice - originalPrice * ((_b = order === null || order === void 0 ? void 0 : order.sahabProviderPercentage) !== null && _b !== void 0 ? _b : 0);
     // When a Sahab-funded discount pushes the customer below the provider's entitlement, Sahab is
     // genuinely subsidising the order — reporting a floor of 0 here overstated margin, so the negative figure stands.

package/dist/ts/loyalty.d.ts

@@ -12,8 +12,15 @@ export declare function loyaltyCoversProvider(offer: Discount | undefined, provi
 /** Environment priority: explicit `offer.isTest`, else `providerIsTest` (only valid when the offer
  *  scopes to one provider), else prod — matching every pre-existing offer's implicit shape. */
 export declare function loyaltyOfferMatchesTestMode(offer: Discount | undefined, isTest: boolean, providerIsTest?: boolean): boolean;
-/** Whether a finished order earns a stamp. The minimum is compared against what the customer
- *  actually paid, not the list price, so an order discounted below it doesn't qualify. */
+/** Whether this order spends a loyalty free wash. Redeeming is not buying, so it earns no stamp. */
+export declare function isLoyaltyRedemption(order?: Order): boolean;
+/** Whether this order is one visit of a multi-visit package. Each visit is its own order. */
+export declare function isPackageVisit(order?: Order): boolean;
+/** What the minimum is compared against: what the customer paid. A visit holds only a slice of the
+ *  package, so it uses the package price — otherwise later visits of a qualifying package would not stamp. */
+export declare function loyaltyQualifyingAmount(order: Order): number;
+/** Whether a finished order earns a stamp. For a multi-visit package this is asked per visit: every
+ *  completed visit earns one, not the package once. A redemption order earns none. */
 export declare function orderEarnsLoyaltyStamp(order: Order | undefined, offer: Discount | undefined): boolean;
 /** Whether buying a gift earns the giver a stamp. Awarded at purchase, not redemption — the reward
  *  shouldn't hinge on whether the recipient ever spends it. The minimum is fair here since the giver really paid it. */

package/dist/ts/loyalty.js

@@ -5,6 +5,9 @@ exports.isProviderLoyaltyOffer = isProviderLoyaltyOffer;
 exports.isSahabLoyaltyOffer = isSahabLoyaltyOffer;
 exports.loyaltyCoversProvider = loyaltyCoversProvider;
 exports.loyaltyOfferMatchesTestMode = loyaltyOfferMatchesTestMode;
+exports.isLoyaltyRedemption = isLoyaltyRedemption;
+exports.isPackageVisit = isPackageVisit;
+exports.loyaltyQualifyingAmount = loyaltyQualifyingAmount;
 exports.orderEarnsLoyaltyStamp = orderEarnsLoyaltyStamp;
 exports.giftEarnsLoyaltyStamp = giftEarnsLoyaltyStamp;
 exports.emptyLoyaltyProgress = emptyLoyaltyProgress;
@@ -58,8 +61,24 @@ function loyaltyOfferMatchesTestMode(offer, isTest, providerIsTest) {
         return providerIsTest === isTest;
     return !isTest;
 }
-/** Whether a finished order earns a stamp. The minimum is compared against what the customer
- *  actually paid, not the list price, so an order discounted below it doesn't qualify. */
+/** Whether this order spends a loyalty free wash. Redeeming is not buying, so it earns no stamp. */
+function isLoyaltyRedemption(order) {
+    var _a;
+    return !!((_a = order === null || order === void 0 ? void 0 : order.promoCode) === null || _a === void 0 ? void 0 : _a.loyalty);
+}
+/** Whether this order is one visit of a multi-visit package. Each visit is its own order. */
+function isPackageVisit(order) {
+    return (0, utils_1.preventNaN)(order === null || order === void 0 ? void 0 : order.visitNumber) >= 1;
+}
+/** What the minimum is compared against: what the customer paid. A visit holds only a slice of the
+ *  package, so it uses the package price — otherwise later visits of a qualifying package would not stamp. */
+function loyaltyQualifyingAmount(order) {
+    if (isPackageVisit(order) && (0, utils_1.preventNaN)(order.originalPrice) > 0)
+        return (0, utils_1.preventNaN)(order.originalPrice);
+    return (0, calcs_1.getCustomerTotalToPay)(order);
+}
+/** Whether a finished order earns a stamp. For a multi-visit package this is asked per visit: every
+ *  completed visit earns one, not the package once. A redemption order earns none. */
 function orderEarnsLoyaltyStamp(order, offer) {
     var _a, _b;
     if (!order || !(offer === null || offer === void 0 ? void 0 : offer.loyalty))
@@ -74,8 +93,10 @@ function orderEarnsLoyaltyStamp(order, offer) {
     // Without this, the recipient's total is 0, so any programme with no minimum would wrongly stamp them.
     if ((0, gifts_1.isGiftRedemption)(order))
         return false;
+    if (isLoyaltyRedemption(order))
+        return false;
     const min = (0, utils_1.preventNaN)((_b = offer.loyalty.minOrderAmount) !== null && _b !== void 0 ? _b : 0);
-    if (min > 0 && (0, calcs_1.getCustomerTotalToPay)(order) < min)
+    if (min > 0 && loyaltyQualifyingAmount(order) < min)
         return false;
     return true;
 }

package/dist/ts/workingHours.d.ts

@@ -0,0 +1,8 @@
+import { Provider, WorkingHours } from '../constants/types';
+export declare const emptyWorkingHours: () => WorkingHours;
+export declare const allDayWorkingHours: () => WorkingHours;
+/**
+ * The hours a provider can be booked in. Slot listing and booking validation both read this, so they cannot disagree: a provider
+ * who works 24/7 is open every hour of every day whatever weekly schedule is also stored, and one with none stored is never open.
+ */
+export declare function resolveWorkingHours(provider?: Pick<Provider, 'working247' | 'workingHoursV2'> | null): WorkingHours;

package/dist/ts/workingHours.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allDayWorkingHours = exports.emptyWorkingHours = void 0;
+exports.resolveWorkingHours = resolveWorkingHours;
+/** One shift that covers a whole calendar day; slot building caps a day at midnight, so this is as long as a shift can be. */
+const ALL_DAY_SHIFT = { start: '00:00', end: '23:59' };
+const DAYS = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday'];
+const weekOf = (shifts) => {
+    const week = {};
+    DAYS.forEach((day) => {
+        week[day] = shifts();
+    });
+    return week;
+};
+const emptyWorkingHours = () => weekOf(() => []);
+exports.emptyWorkingHours = emptyWorkingHours;
+const allDayWorkingHours = () => weekOf(() => [Object.assign({}, ALL_DAY_SHIFT)]);
+exports.allDayWorkingHours = allDayWorkingHours;
+/**
+ * The hours a provider can be booked in. Slot listing and booking validation both read this, so they cannot disagree: a provider
+ * who works 24/7 is open every hour of every day whatever weekly schedule is also stored, and one with none stored is never open.
+ */
+function resolveWorkingHours(provider) {
+    var _a;
+    if ((provider === null || provider === void 0 ? void 0 : provider.working247) === true)
+        return (0, exports.allDayWorkingHours)();
+    return (_a = provider === null || provider === void 0 ? void 0 : provider.workingHoursV2) !== null && _a !== void 0 ? _a : (0, exports.emptyWorkingHours)();
+}

package/package.json

@@ -1,13 +1,13 @@
 {
 	"name": "sahab-utils",
-	"version": "1.8.5",
+	"version": "1.8.8",
 	"description": "This package contains types and utils functions",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"scripts": {
 		"build": "tsc",
 		"deploy": "npm run build && npm publish",
-		"test": "npm run build && node tests/loyalty.test.js && node tests/gifts.test.js && node tests/cashback.test.js && node tests/utils.test.js && node tests/wheel.test.js && node tests/calcs.test.js && node tests/orderActivity.test.js && node tests/push.test.js && node tests/broadcast.test.js && node tests/iban.test.js && node tests/cash.test.js"
+		"test": "npm run build && node tests/loyalty.test.js && node tests/gifts.test.js && node tests/cashback.test.js && node tests/utils.test.js && node tests/wheel.test.js && node tests/calcs.test.js && node tests/orderActivity.test.js && node tests/push.test.js && node tests/broadcast.test.js && node tests/iban.test.js && node tests/cash.test.js && node tests/workingHours.test.js"
 	},
 	"repository": {
 		"type": "git",