sahab-utils 1.8.0 → 1.8.2

package/dist/constants/types.d.ts

@@ -949,6 +949,8 @@ export type WeatherData = {
 };
 export type PaymentConfigs = {
     isCashAllowed: boolean;
+    /** Sahab's surcharge on a cash order, in SAR. Missing, invalid or above MAX_CASH_FEE means no fee. */
+    cashFee?: number;
     isGooglePayAllowed?: boolean;
     /** Tap GoSell merchant id for card / Apple Pay SDK config (optional; falls back in app). */
     tapMerchantId?: string;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './constants/types';
 export * from './ts/broadcast';
 export * from './ts/calcs';
+export * from './ts/cash';
 export * from './ts/cashback';
 export * from './ts/gifts';
 export * from './ts/iban';

package/dist/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./constants/types"), exports);
 __exportStar(require("./ts/broadcast"), exports);
 __exportStar(require("./ts/calcs"), exports);
+__exportStar(require("./ts/cash"), exports);
 __exportStar(require("./ts/cashback"), exports);
 __exportStar(require("./ts/gifts"), exports);
 __exportStar(require("./ts/iban"), exports);

package/dist/ts/calcs.js

@@ -195,16 +195,16 @@ function cashSurcharge(order) {
     var _a;
     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;
 }
-/** Cash `paymentAmount` includes Sahab's surcharge, which is Sahab's revenue not the provider's —
- *  it must come off before comparing to `minimumProviderAmount`, or it's double-counted in getSahabFees/getProviderProfits. */
-function cashSettlementBase(order) {
+/** 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. */
+function settledPaymentAmount(order) {
     var _a;
-    return Math.max(0, (0, utils_1.preventNaN)((_a = order === null || order === void 0 ? void 0 : order.paymentAmount) !== null && _a !== void 0 ? _a : 0) - cashSurcharge(order));
+    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);
 }
 function getProviderTransferAmount(order) {
     var _a, _b;
     const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order);
-    const paymentAmount = (order === null || order === void 0 ? void 0 : order.paymentType) === types_1.OrderPaymentType.CASH ? cashSettlementBase(order) : getCustomerTotalToPay(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 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) {
@@ -217,9 +217,7 @@ function getProviderTransferAmount(order) {
     }
 }
 function getProviderProfits(order) {
-    return (order === null || order === void 0 ? void 0 : order.paymentType) === types_1.OrderPaymentType.CASH
-        ? getCustomerTotalToPay(order) - cashSurcharge(order) + getProviderTransferAmount(order)
-        : getProviderTransferAmount(order);
+    return (order === null || order === void 0 ? void 0 : order.paymentType) === types_1.OrderPaymentType.CASH ? getCustomerTotalToPay(order) + getProviderTransferAmount(order) : getProviderTransferAmount(order);
 }
 function getOnlineProcessingFees(order) {
     var _a;
@@ -232,12 +230,12 @@ function getOnlineProcessingFees(order) {
 function getSahabFees(order) {
     var _a, _b;
     const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order);
-    const paymentAmount = (order === null || order === void 0 ? void 0 : order.paymentType) === types_1.OrderPaymentType.CASH ? cashSettlementBase(order) : getCustomerTotalToPay(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 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.
-    return paymentAmount - minimumProviderAmount + cashSurcharge(order);
+    return paymentAmount - minimumProviderAmount;
 }
 function calcOrdersData(orders) {
     var _a, _b, _c, _d, _e, _f, _g, _h;

package/dist/ts/cash.d.ts

@@ -0,0 +1,13 @@
+import { Order, PaymentConfigs } from '../constants/types';
+/** Cash payment — the shared rules. The fee is set from `payment_methods/configs`; the app only shows it
+ *  and cloudFun is what charges it, so both must reach the same number from the same config. */
+/** A fee above this is read as a typo (5000 for 5.00) and ignored rather than charged to customers. */
+export declare const MAX_CASH_FEE = 50;
+/** What the customer owes ignoring the cash fee, which comes from the payment method and would make a fully discounted order look unpaid. */
+export declare const getOrderTotalWithoutCashFee: (order?: Partial<Order>) => number;
+/** Nothing left to collect: a 100% promo, balance covering everything, or free services. */
+export declare const isFreeOrder: (order?: Partial<Order>) => boolean;
+/** The configured fee in SAR, or 0 when it is missing, not a number, negative or above `MAX_CASH_FEE`. */
+export declare function resolveCashFee(configs?: Pick<PaymentConfigs, 'cashFee'> | null): number;
+/** The fee this order would carry if paid in cash: none when there is nothing to collect. */
+export declare function cashFeeForOrder(order: Partial<Order> | undefined, configs?: Pick<PaymentConfigs, 'cashFee'> | null): number;

package/dist/ts/cash.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFreeOrder = exports.getOrderTotalWithoutCashFee = exports.MAX_CASH_FEE = void 0;
+exports.resolveCashFee = resolveCashFee;
+exports.cashFeeForOrder = cashFeeForOrder;
+const types_1 = require("../constants/types");
+const calcs_1 = require("./calcs");
+/** Cash payment — the shared rules. The fee is set from `payment_methods/configs`; the app only shows it
+ *  and cloudFun is what charges it, so both must reach the same number from the same config. */
+/** A fee above this is read as a typo (5000 for 5.00) and ignored rather than charged to customers. */
+exports.MAX_CASH_FEE = 50;
+/** What the customer owes ignoring the cash fee, which comes from the payment method and would make a fully discounted order look unpaid. */
+const getOrderTotalWithoutCashFee = (order) => (0, calcs_1.getCustomerTotalToPay)(Object.assign(Object.assign({}, (order || {})), { paymentType: types_1.OrderPaymentType.CREDIT, sahabExtraPaymentAmount: 0 }));
+exports.getOrderTotalWithoutCashFee = getOrderTotalWithoutCashFee;
+/** Nothing left to collect: a 100% promo, balance covering everything, or free services. */
+const isFreeOrder = (order) => (0, exports.getOrderTotalWithoutCashFee)(order) <= 0;
+exports.isFreeOrder = isFreeOrder;
+/** The configured fee in SAR, or 0 when it is missing, not a number, negative or above `MAX_CASH_FEE`. */
+function resolveCashFee(configs) {
+    const fee = Number(configs === null || configs === void 0 ? void 0 : configs.cashFee);
+    if (!Number.isFinite(fee) || fee <= 0 || fee > exports.MAX_CASH_FEE)
+        return 0;
+    return Math.round(fee * 100) / 100;
+}
+/** The fee this order would carry if paid in cash: none when there is nothing to collect. */
+function cashFeeForOrder(order, configs) {
+    return (0, exports.isFreeOrder)(order) ? 0 : resolveCashFee(configs);
+}

package/package.json

@@ -1,13 +1,13 @@
 {
 	"name": "sahab-utils",
-	"version": "1.8.0",
+	"version": "1.8.2",
 	"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"
+		"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"
 	},
 	"repository": {
 		"type": "git",