sahab-utils 1.7.0 → 1.7.2

package/dist/constants/types.d.ts

@@ -655,6 +655,17 @@ export type Discount = {
     gift?: {
         giftId: string;
     };
+    /**
+     * Which environment this offer belongs to. Absent means prod, matching every offer created
+     * before this field existed — mirrors `Client.isTest`/`Order.isTest`/`Provider.isTest`.
+     *
+     * Only meaningful for an offer that doesn't otherwise resolve to one environment (see
+     * `loyaltyOfferMatchesTestMode` in `ts/loyalty.ts`): a provider-scoped offer's environment is
+     * really the provider's own `isTest`, and a gift voucher's is really the gift's — this field
+     * is what lets a genuinely Sahab-wide, no-single-provider offer (or a promo code with no
+     * gift/provider scope at all) still declare one explicitly.
+     */
+    isTest?: boolean;
 };
 /**
  * "Buy N washes, get one free" configuration, carried on the `Discount` that represents the
@@ -762,6 +773,12 @@ export type Gift = {
     expiresAt?: TimestampType;
     notifiedAt?: TimestampType;
     notifyChannel?: GiftNotifyChannel;
+    /**
+     * Whether the giver was a test client at purchase — mirrors `Client.isTest`. Stamped once at
+     * creation and never recomputed, same reasoning as `expiresAt`: a client's test/prod status
+     * changing later must not retroactively move a gift someone already paid for.
+     */
+    isTest?: boolean;
 };
 /** One line of a gifted basket, priced when the gift was bought. */
 export type GiftItem = {
@@ -800,6 +817,8 @@ export type GiftConfig = {
      * Bounded on read: a 0 would expire every gift the moment it was sold.
      */
     giftExpiryMonths?: number;
+    /** Charged when the giver adds a personal message to the SMS. Defaults to `GIFT_MESSAGE_SURCHARGE_DEFAULT` when unset. */
+    giftMessageSurcharge?: number;
 };
 export type OrderReview = {
     ratingId: string;

package/dist/ts/gifts.d.ts

@@ -17,6 +17,17 @@ export declare const MIN_GIFT_EXPIRY_MONTHS = 1;
 export declare const MAX_GIFT_EXPIRY_MONTHS = 36;
 /** What the giver pays: every line in the basket. */
 export declare function giftTotal(items?: GiftItem[]): number;
+/** A message longer than this spans more than one Arabic (UCS-2) SMS segment on its own. */
+export declare const GIFT_MESSAGE_MAX_CHARS = 70;
+/** Used when the back office has not set `GiftConfig.giftMessageSurcharge`. */
+export declare const GIFT_MESSAGE_SURCHARGE_DEFAULT = 3;
+/**
+ * What a personal message, if any, adds to the gift's price.
+ *
+ * Zero for a blank or whitespace-only message — writing nothing costs nothing. Otherwise the
+ * back-office amount if one is configured, else the default, same shape as `giftExpiryMonths`.
+ */
+export declare function giftMessageSurcharge(message?: string, config?: GiftConfig): number;
 /** The gifted service ids. */
 export declare function giftServiceIds(gift?: Pick<Gift, 'items'>): string[];
 /** The gifted addon ids. */

package/dist/ts/gifts.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MAX_GIFT_EXPIRY_MONTHS = exports.MIN_GIFT_EXPIRY_MONTHS = exports.DEFAULT_GIFT_EXPIRY_MONTHS = void 0;
+exports.GIFT_MESSAGE_SURCHARGE_DEFAULT = exports.GIFT_MESSAGE_MAX_CHARS = exports.MAX_GIFT_EXPIRY_MONTHS = exports.MIN_GIFT_EXPIRY_MONTHS = exports.DEFAULT_GIFT_EXPIRY_MONTHS = void 0;
 exports.giftTotal = giftTotal;
+exports.giftMessageSurcharge = giftMessageSurcharge;
 exports.giftServiceIds = giftServiceIds;
 exports.giftAddonIds = giftAddonIds;
 exports.giftExpiryMonths = giftExpiryMonths;
@@ -36,6 +37,22 @@ exports.MAX_GIFT_EXPIRY_MONTHS = 36;
 function giftTotal(items) {
     return (items !== null && items !== void 0 ? items : []).reduce((sum, item) => sum + (0, utils_1.preventNaN)(item === null || item === void 0 ? void 0 : item.price), 0);
 }
+/** A message longer than this spans more than one Arabic (UCS-2) SMS segment on its own. */
+exports.GIFT_MESSAGE_MAX_CHARS = 70;
+/** Used when the back office has not set `GiftConfig.giftMessageSurcharge`. */
+exports.GIFT_MESSAGE_SURCHARGE_DEFAULT = 3;
+/**
+ * What a personal message, if any, adds to the gift's price.
+ *
+ * Zero for a blank or whitespace-only message — writing nothing costs nothing. Otherwise the
+ * back-office amount if one is configured, else the default, same shape as `giftExpiryMonths`.
+ */
+function giftMessageSurcharge(message, config) {
+    if (!(message !== null && message !== void 0 ? message : '').trim().length)
+        return 0;
+    const raw = config === null || config === void 0 ? void 0 : config.giftMessageSurcharge;
+    return raw === undefined || raw === null || !isFinite(raw) || raw < 0 ? exports.GIFT_MESSAGE_SURCHARGE_DEFAULT : raw;
+}
 /** The gifted service ids. */
 function giftServiceIds(gift) {
     var _a;
@@ -105,8 +122,10 @@ function giftDiscount(gift, dates) {
     return {
         isPercentage: true,
         amount: 100,
-        // Bounds the discount to the money actually collected, whatever the recipient orders.
-        maxAmount: (0, utils_1.preventNaN)(gift.amount) || giftTotal(gift.items),
+        // Bounds the discount to what the basket is actually worth, whatever the recipient
+        // orders — never to `gift.amount`, which can include a message surcharge that bought
+        // no redeemable service and must not inflate how much the voucher can discount.
+        maxAmount: giftTotal(gift.items),
         clientIds: gift.recipientUid ? [gift.recipientUid] : [],
         providerUids: gift.providerUid ? [gift.providerUid] : [],
         servicesIds: giftServiceIds(gift),
@@ -121,6 +140,7 @@ function giftDiscount(gift, dates) {
         validFrom: dates.validFrom,
         validTo: dates.validTo,
         gift: { giftId: gift.giftId },
+        isTest: gift.isTest,
     };
 }
 /** Every service and addon line on an order, flattened. */

package/dist/ts/loyalty.d.ts

@@ -20,6 +20,19 @@ export declare function isProviderLoyaltyOffer(offer?: Discount): boolean;
 export declare function isSahabLoyaltyOffer(offer?: Discount): boolean;
 /** Whether an offer's provider scope admits a given provider. */
 export declare function loyaltyCoversProvider(offer: Discount | undefined, providerUid?: string): boolean;
+/**
+ * Whether a loyalty offer belongs to the given test/prod environment.
+ *
+ * An offer's environment is decided in priority order:
+ *   1. `offer.isTest`, when the offer declares one explicitly.
+ *   2. `providerIsTest`, for an offer scoped to exactly one provider — resolving that (a
+ *      Firestore read on the provider) is the caller's job, since this stays framework-agnostic.
+ *      Pass it only when `loyaltyProviderScope(offer)` resolves to a single provider.
+ *   3. Prod, otherwise — a genuinely network-wide offer with no explicit flag is exactly the
+ *      shape every offer had before this field existed, so it stays visible to prod and hidden
+ *      from test rather than leaking into both.
+ */
+export declare function loyaltyOfferMatchesTestMode(offer: Discount | undefined, isTest: boolean, providerIsTest?: boolean): boolean;
 /**
  * Whether a finished order earns a stamp.
  *

package/dist/ts/loyalty.js

@@ -4,6 +4,7 @@ exports.loyaltyProviderScope = loyaltyProviderScope;
 exports.isProviderLoyaltyOffer = isProviderLoyaltyOffer;
 exports.isSahabLoyaltyOffer = isSahabLoyaltyOffer;
 exports.loyaltyCoversProvider = loyaltyCoversProvider;
+exports.loyaltyOfferMatchesTestMode = loyaltyOfferMatchesTestMode;
 exports.orderEarnsLoyaltyStamp = orderEarnsLoyaltyStamp;
 exports.giftEarnsLoyaltyStamp = giftEarnsLoyaltyStamp;
 exports.emptyLoyaltyProgress = emptyLoyaltyProgress;
@@ -67,6 +68,25 @@ function loyaltyCoversProvider(offer, providerUid) {
         return true;
     return !!providerUid && scope.includes(providerUid);
 }
+/**
+ * Whether a loyalty offer belongs to the given test/prod environment.
+ *
+ * An offer's environment is decided in priority order:
+ *   1. `offer.isTest`, when the offer declares one explicitly.
+ *   2. `providerIsTest`, for an offer scoped to exactly one provider — resolving that (a
+ *      Firestore read on the provider) is the caller's job, since this stays framework-agnostic.
+ *      Pass it only when `loyaltyProviderScope(offer)` resolves to a single provider.
+ *   3. Prod, otherwise — a genuinely network-wide offer with no explicit flag is exactly the
+ *      shape every offer had before this field existed, so it stays visible to prod and hidden
+ *      from test rather than leaking into both.
+ */
+function loyaltyOfferMatchesTestMode(offer, isTest, providerIsTest) {
+    if (typeof (offer === null || offer === void 0 ? void 0 : offer.isTest) === 'boolean')
+        return offer.isTest === isTest;
+    if (typeof providerIsTest === 'boolean')
+        return providerIsTest === isTest;
+    return !isTest;
+}
 /**
  * Whether a finished order earns a stamp.
  *

package/package.json

@@ -1,37 +1,37 @@
 {
-  "name": "sahab-utils",
-  "version": "1.7.0",
-  "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"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/SahabApp/sahab-utils.git"
-  },
-  "keywords": [
-    "sahab"
-  ],
-  "author": "Sahab",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/SahabApp/sahab-utils/issues"
-  },
-  "homepage": "https://github.com/SahabApp/sahab-utils#readme",
-  "files": [
-    "dist"
-  ],
-  "devDependencies": {
-    "@types/lodash": "^4.17.24",
-    "typescript": "^6.0.2"
-  },
-  "dependencies": {
-    "firebase": "^10.7.1",
-    "lodash": "^4.17.21"
-  },
-  "packageManager": "yarn@4.9.1+sha512.f95ce356460e05be48d66401c1ae64ef84d163dd689964962c6888a9810865e39097a5e9de748876c2e0bf89b232d583c33982773e9903ae7a76257270986538"
+	"name": "sahab-utils",
+	"version": "1.7.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"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/SahabApp/sahab-utils.git"
+	},
+	"keywords": [
+		"sahab"
+	],
+	"author": "Sahab",
+	"license": "ISC",
+	"bugs": {
+		"url": "https://github.com/SahabApp/sahab-utils/issues"
+	},
+	"homepage": "https://github.com/SahabApp/sahab-utils#readme",
+	"files": [
+		"dist"
+	],
+	"devDependencies": {
+		"@types/lodash": "^4.17.24",
+		"typescript": "^6.0.2"
+	},
+	"dependencies": {
+		"firebase": "^10.7.1",
+		"lodash": "^4.17.21"
+	},
+	"packageManager": "yarn@4.9.1+sha512.f95ce356460e05be48d66401c1ae64ef84d163dd689964962c6888a9810865e39097a5e9de748876c2e0bf89b232d583c33982773e9903ae7a76257270986538"
 }