@wix/himalaya-cli 0.1610.0 → 0.1612.0

package/templates/branded-lite/tier5-src/himi-branded-lite-loyalty/index.ts

@@ -1,11 +1,18 @@
 // Public Loyalty offering plus the current member's separately verified balance.
+// The member card also carries the one-app `loyalty_status_section` lines (wix-loyalty-mobile
+// StatusSection): tier, points expiry and "Rewards available (N)". They are private like the
+// balance, read only beside it, and each one is blank rather than guessed when its read fails.
 import { defineService } from "../_shared/collection-service.js";
 import { LOADING, loaded, loadFailed, type LoadCopy, type LoadFlags } from "../_shared/branded-load-state.js";
 import { copyParam, copyTemplate } from "../_shared/himi-copy.js";
-import { formatCurrency, formatNumber } from "../_shared/engine-intl.js";
-import { isSingular } from "../_shared/app-locale.js";
+import { calendarDay, formatCurrency, formatDateMedium, formatNumber } from "../_shared/engine-intl.js";
+import { appLocale, isSingular } from "../_shared/app-locale.js";
 import { memberAccess, assertMemberAccess } from "../_shared/member-access.js";
-import { getLoyaltyProgram, listLoyaltyRewards, listLoyaltyEarningRules, getCurrentMemberLoyaltyAccount, type WixLoyaltyReward, type WixLoyaltyEarningRule } from "@himalaya/wix-loyalty";
+import {
+  getLoyaltyProgram, listLoyaltyRewards, listLoyaltyEarningRules, getCurrentMemberLoyaltyAccount, getLoyaltyTiersProgram, listMyLoyaltyCoupons,
+  type WixLoyaltyReward, type WixLoyaltyEarningRule, type WixLoyaltyProgram, type WixLoyaltyAccount, type WixLoyaltyTiersProgram,
+  type WixLoyaltyCoupon, type WixLoyaltyRewardConfig,
+} from "@himalaya/wix-loyalty";
 
 interface Row { id: string; name: string; subtitle: string }
 interface S extends LoadFlags {
@@ -15,8 +22,18 @@ interface S extends LoadFlags {
   rewardError: string; earningError: string; hideRewardError: boolean; hideEarningError: boolean; hideRewardRows: boolean;
   memberPoints: string; memberMessage: string;
   hideMemberCard: boolean; hideMemberSignIn: boolean; hideMemberRetry: boolean;
+  /** "Gold tier"; "" while the tiers program is off or its read failed. */
+  memberTier: string;
+  /** The expiry sentence; urgent (≤ 7 days) goes in its own field so it can be painted danger. */
+  memberExpiry: string; memberExpiryUrgent: string;
+  /** "Rewards available (N)"; hidden when N is 0 or cannot be counted honestly. */
+  memberRewards: string; hideMemberRewards: boolean;
 }
-const PRIVATE_EMPTY = { memberPoints: "", memberMessage: "", hideMemberCard: true, hideMemberSignIn: true, hideMemberRetry: true };
+const PRIVATE_EMPTY = {
+  memberPoints: "", memberMessage: "", hideMemberCard: true, hideMemberSignIn: true, hideMemberRetry: true,
+  memberTier: "", memberExpiry: "", memberExpiryUrgent: "", memberRewards: "", hideMemberRewards: true,
+};
+const PRIVATE_KEYS = Object.keys(PRIVATE_EMPTY) as (keyof typeof PRIVATE_EMPTY)[];
 const INITIAL: S = { ...LOADING, ...PRIVATE_EMPTY, programName: "", unit: "", currency: "", rewards: [], earningRules: [], emptyText: "", earningEmptyText: "", hideCatalog: false, hideEarningHeading: true, inactiveText: "", rewardError: "", earningError: "", hideRewardError: true, hideEarningError: true, hideRewardRows: false };
 
 function amount(value: unknown): value is number { return typeof value === "number" && Number.isFinite(value) && value >= 0; }
@@ -56,6 +73,72 @@ function currencyFrom(s: S, arg: unknown): string {
   const raw = (arg as { currency?: unknown }).currency;
   return typeof raw === "string" && /^[A-Z]{3}$/.test(raw) ? raw : "";
 }
+/** What `reward` costs a member on `tierId` (undefined = the base tier): its row for that tier,
+ *  else the base row, else the legacy flat `requiredPoints`. Undefined when nothing prices it. */
+function memberCost(reward: WixLoyaltyReward, tierId: string | undefined): number | undefined {
+  const configs: WixLoyaltyRewardConfig[] | undefined = reward.discountAmount?.configsByTier ?? reward.couponReward?.fixedAmount?.configsByTier
+    ?? reward.couponReward?.percentage?.configsByTier ?? reward.couponReward?.freeShipping?.configsByTier;
+  if (!configs?.length) return amount(reward.requiredPoints) ? reward.requiredPoints : undefined;
+  const row = (tierId ? configs.find(config => config.tierId === tierId) : undefined) ?? baseConfig(configs);
+  return amount(row?.costInPoints) ? row.costInPoints : undefined;
+}
+/** The one-app `calculateAvailableRewardsToClaim`: active rewards the balance covers on the
+ *  member's tier (an SPI discount prices itself in text, not points, so it is left out), plus
+ *  claimed coupons that are still ACTIVE and not deleted. */
+export function countAvailableRewards(rewards: WixLoyaltyReward[], coupons: WixLoyaltyCoupon[], balance: number, tierId: string | undefined): number {
+  const claimable = rewards.filter(reward => {
+    if (reward.active !== true || reward.type === "SPI_DISCOUNT_AMOUNT") return false;
+    const cost = memberCost(reward, tierId);
+    return cost !== undefined && cost <= balance;
+  }).length;
+  return claimable + coupons.filter(coupon => coupon.status === "ACTIVE" && !coupon.couponReference?.deleted).length;
+}
+/** The member's tier name; "" when the tiers program is not ACTIVE or the tier is unknown. No
+ *  `tier.id` means the base tier, whose name lives in the program settings. */
+export function currentTierName(tiers: WixLoyaltyTiersProgram | undefined, tierId: string | undefined): string {
+  if (tiers?.programSettings?.status !== "ACTIVE") return "";
+  if (!tierId) return (tiers.programSettings.baseTierDefinition?.name ?? "").trim();
+  return (tiers.tiers?.find(tier => tier.id === tierId)?.tierDefinition?.name ?? "").trim();
+}
+const DAY_MS = 86_400_000;
+/** Nothing further out than this is shown (one-app `estimatePointsExpirationDuration`). */
+const EXPIRY_HORIZON_DAYS = 365;
+/** A date beyond this many days, a day count within it. */
+const EXPIRY_DATE_AFTER_DAYS = 30;
+/** Danger at or under this many days. The upstream card paints 10+ days red, which reads inverted. */
+const EXPIRY_URGENT_DAYS = 7;
+/** The expiry sentence and whether it is urgent; `["", false]` when nothing is shown. Counts
+ *  CALENDAR days on the device: at 22:00, points lapsing at 18:00 tomorrow expire tomorrow. */
+export function expirySentence(program: WixLoyaltyProgram | undefined, account: WixLoyaltyAccount | undefined, now: number = Date.now()): [text: string, urgent: boolean] {
+  const policy = program?.pointsExpiration;
+  // An explicit status wins: DISABLED with a leftover percentage is still disabled.
+  const enabled = policy?.status ? policy.status === "ENABLED" : amount(policy?.expiringPointsPercentage) && policy.expiringPointsPercentage > 0;
+  const at = Date.parse(account?.pointsExpiration?.expirationDate ?? "");
+  if (!enabled || program?.premiumFeatures?.pointsExpiration === false || !Number.isFinite(at) || at <= now) return ["", false];
+  const utc = (day: string) => { const [y, m, d] = day.split("-").map(Number); return Date.UTC(y, m - 1, d); };
+  const days = Math.round((utc(calendarDay(new Date(at))) - utc(calendarDay(new Date(now)))) / DAY_MS);
+  if (days > EXPIRY_HORIZON_DAYS) return ["", false];
+  if (days > EXPIRY_DATE_AFTER_DAYS) return [copyTemplate("loyalty.expireOn", "Expire on {date}", { date: formatDateMedium(new Date(at), appLocale()) }), false];
+  if (days <= 0) return [copyParam("loyalty.expireToday", "Expire today"), true];
+  if (days === 1) return [copyParam("loyalty.expireTomorrow", "Expire tomorrow"), true];
+  return [copyTemplate("loyalty.expireInDays", "Expire in {days} days", { days }), days <= EXPIRY_URGENT_DAYS];
+}
+type Settled<T> = { value?: T; failed: boolean };
+const settle = <T>(read: Promise<T>): Promise<Settled<T>> => read.then(value => ({ value, failed: false }), () => ({ value: undefined, failed: true }));
+/** The status lines for a member whose balance is known. A failed tiers read only drops the tier;
+ *  a failed coupon or rewards read drops the count, because a partial total would understate it. */
+function statusLines(program: WixLoyaltyProgram, account: WixLoyaltyAccount, balance: number, tiers: Settled<WixLoyaltyTiersProgram>,
+  coupons: Settled<{ loyaltyCoupons?: WixLoyaltyCoupon[] }>, rewards: WixLoyaltyReward[] | undefined) {
+  const tierId = account.tier?.id || undefined;
+  const tier = tiers.failed ? "" : currentTierName(tiers.value, tierId);
+  const [expiry, urgent] = expirySentence(program, account);
+  const count = coupons.failed || !rewards ? 0 : countAvailableRewards(rewards, coupons.value?.loyaltyCoupons ?? [], balance, tierId);
+  return {
+    memberTier: tier ? copyTemplate("loyalty.memberTier", "{tier} tier", { tier }) : "",
+    memberExpiry: urgent ? "" : expiry, memberExpiryUrgent: urgent ? expiry : "",
+    memberRewards: count > 0 ? copyTemplate("loyalty.rewardsAvailable", "Rewards available ({count})", { count }) : "", hideMemberRewards: count === 0,
+  };
+}
 const COPY: LoadCopy<Row> = {
   prefix: "loyalty", empty: "No rewards to redeem yet.",
   error: "The rewards program couldn't be loaded.", signIn: "The rewards program couldn't be loaded.",
@@ -64,8 +147,8 @@ const COPY: LoadCopy<Row> = {
 
 const svc = defineService<S, { prepare: (s: S) => S; load: (s: S, arg?: unknown) => Promise<S> }>("himiBrandedLoyalty", {
   state: INITIAL,
-  notHydrated: ["memberPoints", "memberMessage", "hideMemberCard", "hideMemberSignIn", "hideMemberRetry"],
-  notPersisted: ["memberPoints", "memberMessage", "hideMemberCard", "hideMemberSignIn", "hideMemberRetry"],
+  notHydrated: PRIVATE_KEYS,
+  notPersisted: PRIVATE_KEYS,
   actions: {
     prepare: s => ({ ...s, ...PRIVATE_EMPTY }),
     load: async (s, arg) => {
@@ -84,10 +167,14 @@ const svc = defineService<S, { prepare: (s: S) => S; load: (s: S, arg?: unknown)
         // Balance failures cannot discard a public offering that loaded correctly.
         const privateStateSupported = !!member.scope && ((globalThis as { himalaya?: { readLifecycleVersion?: number } }).himalaya?.readLifecycleVersion ?? 0) >= 1;
         const accountRead = member.email && privateStateSupported
-          ? getCurrentMemberLoyaltyAccount().then(value => ({ value, failed: false })).catch(() => ({ value: undefined, failed: true }))
+          ? settle(getCurrentMemberLoyaltyAccount())
           : Promise.resolve({ value: undefined, failed: false });
-        const [[rewardResult, earningResult], account] = await Promise.all([
-          Promise.allSettled([listLoyaltyRewards(), listLoyaltyEarningRules()]), accountRead,
+        // The status lines' reads go only where the balance read goes: never for a visitor or an older host.
+        const statusRead = member.email && privateStateSupported
+          ? Promise.all([settle(getLoyaltyTiersProgram()), settle(listMyLoyaltyCoupons())])
+          : Promise.resolve([{ failed: true }, { failed: true }] as [Settled<WixLoyaltyTiersProgram>, Settled<{ loyaltyCoupons?: WixLoyaltyCoupon[] }>]);
+        const [[rewardResult, earningResult], account, [tiers, coupons]] = await Promise.all([
+          Promise.allSettled([listLoyaltyRewards(), listLoyaltyEarningRules()]), accountRead, statusRead,
         ]);
         const rewardResponse = rewardResult.status === "fulfilled" ? rewardResult.value : undefined;
         const earningResponse = earningResult.status === "fulfilled" ? earningResult.value : undefined;
@@ -104,7 +191,10 @@ const svc = defineService<S, { prepare: (s: S) => S; load: (s: S, arg?: unknown)
           try {
             await assertMemberAccess(member);
             const balance = account.value?.account?.points?.balance;
+            const known = typeof balance === "number" && Number.isFinite(balance);
             privateState = { ...PRIVATE_EMPTY, hideMemberCard: false,
+              ...(known && privateStateSupported && !account.failed
+                ? statusLines(program, account.value?.account ?? {}, balance, tiers, coupons, rewardResult.status === "fulfilled" ? (rewardResponse?.rewards ?? []) : undefined) : {}),
               memberPoints: typeof balance === "number" && Number.isFinite(balance) ? points(balance, customUnit) : "",
               memberMessage: !privateStateSupported ? copyParam("loyalty.updateApp", "Update the app to see your points securely.") : account.failed ? copyParam("loyalty.pointsError", "Your points couldn't be loaded.")
                 : typeof balance !== "number" || !Number.isFinite(balance) ? copyParam("loyalty.pointsUnavailable", "Your points aren't available yet.") : "",