sahab-utils 1.8.8 → 1.8.9

package/dist/constants/types.d.ts

@@ -64,7 +64,8 @@ export declare enum OrderStatus {
     COMPLETED = 5,// 5
     CANCELLED = 6,// 6
     RATED = 7,// 7
-    STARTED = 8
+    STARTED = 8,// 8
+    PENDING_PAYMENT = 9
 }
 export declare enum OrderPaymentType {
     APPLE_PAY = 0,
@@ -116,7 +117,7 @@ export type Order = {
     paymentCancelationId?: string;
     paymentRefundId?: string;
     paymentCaptureId?: string;
-    canceledBy?: 'provider' | 'client';
+    canceledBy?: 'provider' | 'client' | 'system' | 'admin';
     movementsCreated?: boolean;
     orderNote?: string;
     cancelReason?: string;
@@ -156,6 +157,11 @@ export type Order = {
     visitNumber?: number;
     /** Multi-visit package only: what the customer pays for the whole package, stamped on every visit. */
     originalPrice?: number;
+    paymentLinkId?: string;
+    paymentLinkUrl?: string;
+    payLinkDeadline?: TimestampType;
+    payLinkSmsCount?: number;
+    createdByStaff?: string;
 };
 export type ReduxOrder = {
     orderId?: string;
@@ -190,7 +196,7 @@ export type ReduxOrder = {
     paymentCancelationId?: string;
     paymentRefundId?: string;
     paymentCaptureId?: string;
-    canceledBy?: 'provider' | 'client';
+    canceledBy?: 'provider' | 'client' | 'system' | 'admin';
     movementsCreated?: boolean;
     orderNote?: string;
     cancelReason?: string;

package/dist/constants/types.js

@@ -20,6 +20,7 @@ var OrderStatus;
     OrderStatus[OrderStatus["CANCELLED"] = 6] = "CANCELLED";
     OrderStatus[OrderStatus["RATED"] = 7] = "RATED";
     OrderStatus[OrderStatus["STARTED"] = 8] = "STARTED";
+    OrderStatus[OrderStatus["PENDING_PAYMENT"] = 9] = "PENDING_PAYMENT";
 })(OrderStatus || (exports.OrderStatus = OrderStatus = {}));
 var OrderPaymentType;
 (function (OrderPaymentType) {

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export * from './ts/gifts';
 export * from './ts/iban';
 export * from './ts/loyalty';
 export * from './ts/orderActivity';
+export * from './ts/payLink';
 export * from './ts/push';
 export * from './ts/utils';
 export * from './ts/wheel';

package/dist/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./ts/gifts"), exports);
 __exportStar(require("./ts/iban"), exports);
 __exportStar(require("./ts/loyalty"), exports);
 __exportStar(require("./ts/orderActivity"), exports);
+__exportStar(require("./ts/payLink"), exports);
 __exportStar(require("./ts/push"), exports);
 __exportStar(require("./ts/utils"), exports);
 __exportStar(require("./ts/wheel"), exports);

package/dist/ts/payLink.d.ts

@@ -0,0 +1,61 @@
+import { CarSize, Order, OrderStatus, Provider, ProvidedAddon, ProvidedService } from '../constants/types';
+/** Back-office orders paid by a link — the shared contract between sahab-website and cloudFun. */
+export declare const PAY_LINK_WINDOW_MINUTES = 15;
+export declare const PAY_LINK_CANCEL_REASON = "payment not completed";
+/** Fields a pay-link order carries. Generic over the timestamp because cloudFun stores firebase-admin Timestamps and the
+ *  apps/website read firebase web ones. Server-only bookkeeping (task name, run token) stays in cloudFun. */
+export type PayLinkOrderFields<TTimestamp> = {
+    paymentLinkId?: string;
+    paymentLinkUrl?: string;
+    payLinkDeadline?: TTimestamp;
+    payLinkSmsCount?: number;
+    createdByStaff?: string;
+};
+export type CreatePayLinkOrderRequest = {
+    clientUid: string;
+    carId: string;
+    /** Index into the client's saved `locations`. */
+    locationIndex: number;
+    providerId: string;
+    serviceIds: string[];
+    addonIds?: string[];
+    /** Start of the chosen slot, epoch ms. */
+    orderDate: number;
+    promoCode?: string;
+    /** Text the link from the server. Off by default: staff copy it or share it on WhatsApp. */
+    sendSms?: boolean;
+};
+export type CreatePayLinkOrderResponse = {
+    orderId: string;
+    orderStatus: OrderStatus;
+    /** Absent when the order was free and confirmed without a payment. */
+    paymentLinkUrl?: string;
+    /** Epoch ms after which the unpaid order is cancelled. */
+    payLinkDeadline?: number;
+    smsSent: boolean;
+};
+export type ResendPayLinkRequest = {
+    orderId: string;
+};
+/** The message carrying the link — one wording for the server's SMS and the back office's copy/WhatsApp share. */
+export declare const payLinkMessage: (lang: string | undefined, url: string) => string;
+export declare const payLinkCancelledMessage: (lang: string | undefined) => string;
+/** wa.me wants the international number as digits only; local 05… numbers are Saudi. */
+export declare function whatsAppShareUrl(phone: string | undefined, text: string): string;
+export declare const payLinkDeadlineMs: (createdMs: number) => number;
+/** Checkout amounts are integer minor units; rounding here keeps the link and the webhook check in agreement. */
+export declare const toMinorUnits: (sar: number) => number;
+/** The webhook amount matches the order only to the halala, never "close enough". */
+export declare const isPayLinkAmountExact: (orderTotalSar: number, paidMinor: number, currency?: string) => boolean;
+export type PayLinkLinesResult = {
+    ok: true;
+    lines: Array<ProvidedService | ProvidedAddon>;
+} | {
+    ok: false;
+    reason: 'NO_SERVICE' | 'UNKNOWN_ITEM' | 'NO_PRICE_FOR_SIZE' | 'PACKAGE_NOT_SUPPORTED';
+};
+/** Order lines priced exactly as the customer app's setProvidedService/setProvidedAddon build them: the
+ *  provider's price for this car size plus the client percentage. Hidden items and packages are refused. */
+export declare function buildPayLinkOrderLines(provider: Pick<Provider, 'services' | 'addons'>, carSize: CarSize, serviceIds: string[], addonIds?: string[]): PayLinkLinesResult;
+/** A pay-link order that never took money — still waiting, or cancelled for non-payment. Statements and KPIs leave these out. */
+export declare const isNeverPaidPayLinkOrder: (order?: Pick<Order, "orderStatus" | "cancelReason" | "isPaid">) => boolean;

package/dist/ts/payLink.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNeverPaidPayLinkOrder = exports.isPayLinkAmountExact = exports.toMinorUnits = exports.payLinkDeadlineMs = exports.payLinkCancelledMessage = exports.payLinkMessage = exports.PAY_LINK_CANCEL_REASON = exports.PAY_LINK_WINDOW_MINUTES = void 0;
+exports.whatsAppShareUrl = whatsAppShareUrl;
+exports.buildPayLinkOrderLines = buildPayLinkOrderLines;
+const types_1 = require("../constants/types");
+const calcs_1 = require("./calcs");
+/** Back-office orders paid by a link — the shared contract between sahab-website and cloudFun. */
+exports.PAY_LINK_WINDOW_MINUTES = 15;
+exports.PAY_LINK_CANCEL_REASON = 'payment not completed';
+/** The message carrying the link — one wording for the server's SMS and the back office's copy/WhatsApp share. */
+const payLinkMessage = (lang, url) => lang === 'en'
+    ? `Sahab: pay within ${exports.PAY_LINK_WINDOW_MINUTES} minutes to confirm your car wash booking\n${url}`
+    : `سحاب: ادفع خلال ${exports.PAY_LINK_WINDOW_MINUTES} دقيقة لتأكيد حجز غسيل سيارتك\n${url}`;
+exports.payLinkMessage = payLinkMessage;
+const payLinkCancelledMessage = (lang) => lang === 'en' ? 'Sahab: your booking was cancelled because the payment was not completed.' : 'سحاب: تم إلغاء حجزك لعدم إتمام الدفع.';
+exports.payLinkCancelledMessage = payLinkCancelledMessage;
+/** wa.me wants the international number as digits only; local 05… numbers are Saudi. */
+function whatsAppShareUrl(phone, text) {
+    const digits = (phone !== null && phone !== void 0 ? phone : '').replace(/[^\d]/g, '');
+    const international = digits.startsWith('0') ? `966${digits.slice(1)}` : digits;
+    return `https://wa.me/${international}?text=${encodeURIComponent(text)}`;
+}
+const payLinkDeadlineMs = (createdMs) => createdMs + exports.PAY_LINK_WINDOW_MINUTES * 60000;
+exports.payLinkDeadlineMs = payLinkDeadlineMs;
+/** Checkout amounts are integer minor units; rounding here keeps the link and the webhook check in agreement. */
+const toMinorUnits = (sar) => Math.round(sar * 100);
+exports.toMinorUnits = toMinorUnits;
+/** The webhook amount matches the order only to the halala, never "close enough". */
+const isPayLinkAmountExact = (orderTotalSar, paidMinor, currency) => (currency !== null && currency !== void 0 ? currency : '').toUpperCase() === 'SAR' && Number.isInteger(paidMinor) && paidMinor === (0, exports.toMinorUnits)(orderTotalSar);
+exports.isPayLinkAmountExact = isPayLinkAmountExact;
+/** Order lines priced exactly as the customer app's setProvidedService/setProvidedAddon build them: the
+ *  provider's price for this car size plus the client percentage. Hidden items and packages are refused. */
+function buildPayLinkOrderLines(provider, carSize, serviceIds, addonIds = []) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    if (!serviceIds.length)
+        return { ok: false, reason: 'NO_SERVICE' };
+    const lines = [];
+    for (const id of serviceIds) {
+        const service = (_a = provider.services) === null || _a === void 0 ? void 0 : _a.find((s) => s.serviceId === id && !s.hide);
+        if (!service)
+            return { ok: false, reason: 'UNKNOWN_ITEM' };
+        if (((_b = service.numberOfVisits) !== null && _b !== void 0 ? _b : 1) > 1)
+            return { ok: false, reason: 'PACKAGE_NOT_SUPPORTED' };
+        const price = (_d = (_c = service.prices) === null || _c === void 0 ? void 0 : _c.find((p) => p.size === carSize)) === null || _d === void 0 ? void 0 : _d.price;
+        if (!price)
+            return { ok: false, reason: 'NO_PRICE_FOR_SIZE' };
+        lines.push({
+            serviceId: service.serviceId,
+            name: service.name,
+            imageUrl: service.imageUrl,
+            providerId: service.providerId,
+            description: service.description,
+            price: { size: carSize, price: (0, calcs_1.customerPriceFromProviderPrice)(price) },
+            quantity: 1,
+            type: 'service',
+            time: service.time || 0,
+            includedServices: service.includedServices,
+            numberOfVisits: 1,
+            isDone: false,
+        });
+    }
+    for (const id of addonIds) {
+        const addon = (_e = provider.addons) === null || _e === void 0 ? void 0 : _e.find((a) => a.addonId === id && !a.hide);
+        if (!addon)
+            return { ok: false, reason: 'UNKNOWN_ITEM' };
+        const price = (_g = (_f = addon.prices) === null || _f === void 0 ? void 0 : _f.find((p) => p.size === carSize)) === null || _g === void 0 ? void 0 : _g.price;
+        if (!price)
+            return { ok: false, reason: 'NO_PRICE_FOR_SIZE' };
+        lines.push({
+            addonId: addon.addonId,
+            name: addon.name,
+            providerId: addon.providerId,
+            description: addon.description,
+            price: { size: carSize, price: (0, calcs_1.customerPriceFromProviderPrice)(price) },
+            quantity: 1,
+            type: 'addon',
+            time: addon.time || 0,
+            isDone: false,
+        });
+    }
+    return { ok: true, lines };
+}
+/** A pay-link order that never took money — still waiting, or cancelled for non-payment. Statements and KPIs leave these out. */
+const isNeverPaidPayLinkOrder = (order) => (order === null || order === void 0 ? void 0 : order.orderStatus) === types_1.OrderStatus.PENDING_PAYMENT ||
+    ((order === null || order === void 0 ? void 0 : order.orderStatus) === types_1.OrderStatus.CANCELLED && order.cancelReason === exports.PAY_LINK_CANCEL_REASON && !order.isPaid);
+exports.isNeverPaidPayLinkOrder = isNeverPaidPayLinkOrder;

package/package.json

@@ -1,13 +1,14 @@
 {
 	"name": "sahab-utils",
-	"version": "1.8.8",
+	"version": "1.8.9",
 	"description": "This package contains types and utils functions",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"scripts": {
 		"build": "tsc",
+		"prepublishOnly": "npm run build",
 		"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 && node tests/workingHours.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 && node tests/payLink.test.js"
 	},
 	"repository": {
 		"type": "git",