sahab-utils 1.7.9 → 1.8.1

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,8 +1,10 @@
 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';
 export * from './ts/loyalty';
 export * from './ts/orderActivity';
 export * from './ts/push';

package/dist/index.js

@@ -17,8 +17,10 @@ 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);
 __exportStar(require("./ts/loyalty"), exports);
 __exportStar(require("./ts/orderActivity"), exports);
 __exportStar(require("./ts/push"), exports);

package/dist/ts/cash.d.ts

@@ -0,0 +1,15 @@
+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;
+/** A redeemed gift tops up its extras online only; cash is fine once the gift covers everything. */
+export declare function isCashAllowedForOrder(order?: Partial<Order>): boolean;

package/dist/ts/cash.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFreeOrder = exports.getOrderTotalWithoutCashFee = exports.MAX_CASH_FEE = void 0;
+exports.resolveCashFee = resolveCashFee;
+exports.cashFeeForOrder = cashFeeForOrder;
+exports.isCashAllowedForOrder = isCashAllowedForOrder;
+const types_1 = require("../constants/types");
+const calcs_1 = require("./calcs");
+const gifts_1 = require("./gifts");
+/** 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);
+}
+/** A redeemed gift tops up its extras online only; cash is fine once the gift covers everything. */
+function isCashAllowedForOrder(order) {
+    return !((0, gifts_1.isGiftRedemption)(order) && !(0, exports.isFreeOrder)(order));
+}

package/dist/ts/iban.d.ts

@@ -0,0 +1,15 @@
+/** The only transfer percentages a provider can be on. */
+export declare const PROVIDER_PERCENTAGES: readonly ["7%", "10%"];
+export type ProviderPercentage = (typeof PROVIDER_PERCENTAGES)[number];
+export declare const isProviderPercentage: (value: unknown) => value is ProviderPercentage;
+/** Pasted IBANs carry spaces and lower case; every check below expects this form. */
+export declare const normalizeBankAccount: (raw: string) => string;
+export declare const isValidSaudiIban: (value: string) => boolean;
+export declare const isSabAccountNumber: (value: string) => boolean;
+/** What a provider's payout can go to: a Saudi IBAN, or a SAB in-bank account number. */
+export declare const isValidProviderAccount: (value: string) => boolean;
+/** Whether the payout is an in-bank SAB transfer. Decided from the account itself, never from a form flag. */
+export declare const isSabBankAccount: (value: string) => boolean;
+/** The two-digit bank code inside a Saudi IBAN, for showing which bank an account is with. */
+export declare const saudiIbanBankCode: (value: string) => string | undefined;
+export declare const PROVIDER_ACCOUNT_FORMAT_HINT = "A Saudi IBAN (SA + 22 characters) or a SAB account number (SASABB + 12 digits)";

package/dist/ts/iban.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROVIDER_ACCOUNT_FORMAT_HINT = exports.saudiIbanBankCode = exports.isSabBankAccount = exports.isValidProviderAccount = exports.isSabAccountNumber = exports.isValidSaudiIban = exports.normalizeBankAccount = exports.isProviderPercentage = exports.PROVIDER_PERCENTAGES = void 0;
+/** The only transfer percentages a provider can be on. */
+exports.PROVIDER_PERCENTAGES = ['7%', '10%'];
+const isProviderPercentage = (value) => exports.PROVIDER_PERCENTAGES.includes(value);
+exports.isProviderPercentage = isProviderPercentage;
+/** Pasted IBANs carry spaces and lower case; every check below expects this form. */
+const normalizeBankAccount = (raw) => raw.replace(/\s+/g, '').toUpperCase();
+exports.normalizeBankAccount = normalizeBankAccount;
+// SA + 2 check digits + 2-digit bank code + 18 account characters, which may be letters.
+const SAUDI_IBAN_SHAPE = /^SA\d{4}[0-9A-Z]{18}$/;
+// The in-bank account form SAB transfers use instead of an IBAN.
+const SAB_ACCOUNT_NUMBER = /^SASABB\d{12}$/;
+/** ISO 13616 checksum: the rearranged IBAN, letters as 10-35, must leave remainder 1 modulo 97. */
+const hasValidChecksum = (iban) => {
+    const rearranged = iban.slice(4) + iban.slice(0, 4);
+    let remainder = 0;
+    for (const char of rearranged) {
+        const value = parseInt(char, 36);
+        remainder = (value < 10 ? remainder * 10 + value : remainder * 100 + value) % 97;
+    }
+    return remainder === 1;
+};
+const isValidSaudiIban = (value) => SAUDI_IBAN_SHAPE.test(value) && hasValidChecksum(value);
+exports.isValidSaudiIban = isValidSaudiIban;
+const isSabAccountNumber = (value) => SAB_ACCOUNT_NUMBER.test(value);
+exports.isSabAccountNumber = isSabAccountNumber;
+/** What a provider's payout can go to: a Saudi IBAN, or a SAB in-bank account number. */
+const isValidProviderAccount = (value) => (0, exports.isValidSaudiIban)(value) || (0, exports.isSabAccountNumber)(value);
+exports.isValidProviderAccount = isValidProviderAccount;
+/** Whether the payout is an in-bank SAB transfer. Decided from the account itself, never from a form flag. */
+const isSabBankAccount = (value) => (0, exports.isSabAccountNumber)(value);
+exports.isSabBankAccount = isSabBankAccount;
+/** The two-digit bank code inside a Saudi IBAN, for showing which bank an account is with. */
+const saudiIbanBankCode = (value) => ((0, exports.isValidSaudiIban)(value) ? value.slice(4, 6) : undefined);
+exports.saudiIbanBankCode = saudiIbanBankCode;
+exports.PROVIDER_ACCOUNT_FORMAT_HINT = 'A Saudi IBAN (SA + 22 characters) or a SAB account number (SASABB + 12 digits)';

package/package.json

@@ -1,13 +1,13 @@
 {
 	"name": "sahab-utils",
-	"version": "1.7.9",
+	"version": "1.8.1",
 	"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"
+		"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",