@behio/storefront-sdk 2.7.0 → 2.9.0

package/dist/react.d.ts

@@ -228,6 +228,8 @@ interface CheckoutSettings {
 type PriceDisplay = "INCL_VAT" | "EXCL_VAT" | "CUSTOMER_CHOICE";
 type CurrencyDisplayFormat = "SYMBOL_BEFORE" | "SYMBOL_AFTER" | "CODE";
 interface ShopInfo {
+    /** Merchant default catalog order, normalized to the public sort values. */
+    defaultProductSort?: ProductSortValue;
     currencyDisplayFormat?: CurrencyDisplayFormat;
     account?: {
         passwordMinLength: number;
@@ -561,6 +563,8 @@ interface ProductLabel {
     slug: string;
     name: string;
     color?: string;
+    /** Merchant icon name. Render a trusted local icon, with a safe fallback. */
+    iconName?: string | null;
 }
 /**
  * Resolved availability status of a product. Either a merchant preset
@@ -1128,6 +1132,7 @@ interface FacetLabel {
     slug: string;
     name: string;
     color?: string | null;
+    iconName?: string | null;
     count: number;
 }
 interface FacetCategory {
@@ -1625,7 +1630,13 @@ interface OrderListItem {
 interface OrderItem {
     productName: string;
     sku: string;
-    imageUrl?: string;
+    /** Photo snapshot from checkout, or the product's current photo. */
+    imageUrl?: string | null;
+    /** Product still in the shop (SDK 2.8.0). Null when it was removed since,
+     *  so a template never links to a missing product page. */
+    productId?: string | null;
+    /** URL slug for a link back to the product page (SDK 2.8.0). */
+    productSlug?: string | null;
     quantity: number;
     unitPrice: number;
     totalPrice: number;
@@ -1649,6 +1660,36 @@ interface OrderTracking {
     shippingCountry: string | null;
     items: OrderItem[];
     createdAt: number;
+    /** Order summary, not personal data (SDK 2.8.0). */
+    subtotal?: number;
+    shippingTotal?: number;
+    paymentFee?: number | null;
+    discountTotal?: number;
+    taxTotal?: number;
+    taxBreakdown?: TaxBreakdownLine[];
+    /** Shipping method as the customer chose it (SDK 2.8.0). */
+    shippingMethodName?: string | null;
+    /** Payment method in the order language (SDK 2.8.0). */
+    paymentMethodName?: string | null;
+    /** Pickup point the customer chose, a public place (SDK 2.8.0). */
+    pickupPoint?: OrderPickupPoint | null;
+    /** Parcels the customer can follow (SDK 2.8.0). */
+    shipments?: OrderShipment[];
+}
+/** Pickup point the customer chose for an order (SDK 2.8.0). */
+interface OrderPickupPoint {
+    name: string;
+    street?: string | null;
+    city?: string | null;
+    zip?: string | null;
+    country?: string | null;
+}
+/** A parcel on its way, with the carrier's tracking link (SDK 2.8.0). */
+interface OrderShipment {
+    trackingNumber?: string | null;
+    trackingUrl?: string | null;
+    status: string;
+    createdAt: number;
 }
 interface OrderStatusHistory {
     fromStatus?: OrderStatus;
@@ -1662,6 +1703,14 @@ interface OrderDetail extends OrderListItem {
     contentDeliveryPending?: boolean;
     /** False for an order without physical delivery. */
     requiresShipping?: boolean;
+    /** Shipping method as the customer chose it (SDK 2.8.0). */
+    shippingMethodName?: string | null;
+    /** Payment method in the order language (SDK 2.8.0). */
+    paymentMethodName?: string | null;
+    /** Pickup point the customer chose, a public place (SDK 2.8.0). */
+    pickupPoint?: OrderPickupPoint | null;
+    /** Parcels the customer can follow (SDK 2.8.0). */
+    shipments?: OrderShipment[];
     items: OrderItem[];
     shippingAddress: CheckoutAddress;
     billingAddress: CheckoutAddress;
@@ -2498,6 +2547,7 @@ interface PickupPointsInput {
 }
 /** Public terms of the eshop's loyalty program. */
 interface LoyaltyProgram {
+    enrollmentType?: "AUTO_ON_REGISTER" | "OPT_IN" | "INVITE_ONLY";
     name: string;
     pointName: string;
     pointNamePlural: string;
@@ -2512,6 +2562,8 @@ interface LoyaltyProgram {
 }
 interface LoyaltyBalance {
     currentPoints: number;
+    /** Revoked points to offset before new rewards become spendable. Absent on older servers. */
+    pointsDebt?: number;
     /** `currentPoints` valued in the program currency. */
     currentPointsValue: number;
     lifetimePointsEarned: number;
@@ -2543,10 +2595,13 @@ interface LoyaltyNextTier {
     progressPercent: number;
 }
 interface LoyaltyTransaction {
+    /** Stable identifier on servers supporting cursor history. */
+    id?: string;
     type: string;
     /** Positive = earned, negative = redeemed / expired. */
     points: number;
     balanceAfter: number;
+    debtAfter?: number;
     eventType: string | null;
     description: string | null;
     createdAt: number;
@@ -2558,6 +2613,7 @@ interface LoyaltyTransaction {
  * "join and earn" CTA).
  */
 interface LoyaltySummary {
+    canJoin?: boolean;
     hasProgram: boolean;
     enrolled: boolean;
     program: LoyaltyProgram | null;
@@ -2566,6 +2622,18 @@ interface LoyaltySummary {
     nextTier: LoyaltyNextTier | null;
     referralCode: string | null;
     transactions: LoyaltyTransaction[];
+    /** Follow using getLoyalty({transactionsCursor}); null is the last page. */
+    transactionsNextCursor?: string | null;
+    canApplyReferral?: boolean;
+}
+interface LoyaltyReferralResult {
+    alreadyApplied: boolean;
+    recipientPoints: number;
+}
+interface LoyaltyQuery {
+    transactionsCursor?: string;
+    /** 1 to 50, default 20. */
+    transactionsLimit?: number;
 }
 interface CrossSellItem {
     productId: string;
@@ -2894,6 +2962,55 @@ interface CartLinkClaimed extends Cart {
     /** Code carried by the link, including a refused code. Null means no code was offered. */
     linkDiscountCode: string | null;
 }
+/** Earned merchant badges for the current authenticated customer. */
+interface CustomerBadge {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    iconUrl: string | null;
+    type: "MILESTONE" | "CHALLENGE" | "STREAK" | "ACHIEVEMENT" | "CUSTOM";
+    earnedAt: number;
+}
+interface CustomerChallenge {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    targetType: string;
+    targetValue: number;
+    /** TOTAL_SPEND uses the shop's default currency and stored reference FX rates. */
+    currency: string;
+    startsAt: number;
+    endsAt: number;
+    rewardPoints: number | null;
+    rewardBadgeName: string | null;
+    active: boolean;
+    joined: boolean;
+    currentProgress: number;
+    completedAt: number | null;
+    canJoin: boolean;
+    rewardMembershipRequired: boolean;
+}
+interface CustomerGamificationQuery {
+    badgesPage?: number;
+    challengesPage?: number;
+    /** 1..50, default 20. */
+    limit?: number;
+}
+interface CustomerGamification {
+    badges: CustomerBadge[];
+    badgesTotal: number;
+    badgesPage: number;
+    challenges: CustomerChallenge[];
+    challengesTotal: number;
+    challengesPage: number;
+    limit: number;
+}
+interface GamificationRefreshResult {
+    awarded: number;
+    completed: number;
+}
 
 declare class BehioStorefront {
     private baseUrl;
@@ -3517,7 +3634,17 @@ declare class CustomerModule {
      * value, current tier, next-tier progress, point ratio, referral code,
      * recent transactions). Requires an authenticated customer session.
      */
-    getLoyalty(): Promise<SdkResult<LoyaltySummary>>;
+    getLoyalty(query?: LoyaltyQuery): Promise<SdkResult<LoyaltySummary>>;
+    /** Apply an invitation to the caller's active loyalty membership, once. */
+    applyReferral(code: string): Promise<SdkResult<LoyaltyReferralResult>>;
+    /** Explicit enrollment; invite-only programs require the shop administrator. */
+    joinLoyalty(): Promise<SdkResult<LoyaltySummary>>;
+    /** Authenticated account rewards. Both collections have independent pages. */
+    getGamification(query?: CustomerGamificationQuery): Promise<SdkResult<CustomerGamification>>;
+    /** Join an active challenge; a repeated call preserves the original joinedAt. */
+    joinChallenge(challengeId: string): Promise<SdkResult<GamificationRefreshResult>>;
+    /** Reconcile persisted qualifying activity. Never supplies progress or points. */
+    refreshGamification(): Promise<SdkResult<GamificationRefreshResult>>;
     /**
      * Digital product delivery (GAP-07): list the logged-in customer's download
      * grants across all their orders (file name, product, remaining downloads,

package/dist/react.js

@@ -1655,8 +1655,28 @@ var CustomerModule = class {
    * value, current tier, next-tier progress, point ratio, referral code,
    * recent transactions). Requires an authenticated customer session.
    */
-  async getLoyalty() {
-    return this.client.request("GET", "/customer/loyalty");
+  async getLoyalty(query = {}) {
+    return this.client.request("GET", "/customer/loyalty", { query: { ...query } });
+  }
+  /** Apply an invitation to the caller's active loyalty membership, once. */
+  async applyReferral(code) {
+    return this.client.request("POST", "/customer/loyalty/referral", { body: { code } });
+  }
+  /** Explicit enrollment; invite-only programs require the shop administrator. */
+  async joinLoyalty() {
+    return this.client.request("POST", "/customer/loyalty/join", { body: { consent: true } });
+  }
+  /** Authenticated account rewards. Both collections have independent pages. */
+  async getGamification(query = {}) {
+    return this.client.request("GET", "/customer/gamification", { query: { ...query } });
+  }
+  /** Join an active challenge; a repeated call preserves the original joinedAt. */
+  async joinChallenge(challengeId) {
+    return this.client.request("POST", `/customer/gamification/challenges/${encodeURIComponent(challengeId)}/join`);
+  }
+  /** Reconcile persisted qualifying activity. Never supplies progress or points. */
+  async refreshGamification() {
+    return this.client.request("POST", "/customer/gamification/refresh");
   }
   /**
    * Digital product delivery (GAP-07): list the logged-in customer's download
@@ -4019,16 +4039,19 @@ function errorParams(err) {
   const params = body?.params;
   return params && typeof params === "object" && !Array.isArray(params) ? params : {};
 }
-var FORM_FIELD_ERROR_CODES = /* @__PURE__ */ new Set([
-  "required",
-  "invalid",
-  "tooShort",
-  "tooLong",
-  "min",
-  "max",
-  "notOption",
-  "pattern"
-]);
+var FORM_FIELD_ERROR_CODES = {
+  required: true,
+  invalid: true,
+  tooShort: true,
+  tooLong: true,
+  min: true,
+  max: true,
+  notOption: true,
+  pattern: true,
+  dateNotFuture: true,
+  dateNotPast: true,
+  tooManyFiles: true
+};
 function formFieldErrors(err) {
   if (errorCode(err) !== "be.forms.validationFailed") return [];
   const raw = errorParams(err).errors;
@@ -4040,7 +4063,7 @@ function formFieldErrors(err) {
     if (idx <= 0) continue;
     const key = entry.slice(0, idx);
     const code = entry.slice(idx + 1);
-    if (!FORM_FIELD_ERROR_CODES.has(code)) continue;
+    if (!Object.prototype.hasOwnProperty.call(FORM_FIELD_ERROR_CODES, code)) continue;
     out.push({ key, code });
   }
   return out;

package/dist/react.mjs

@@ -1545,8 +1545,28 @@ var CustomerModule = class {
    * value, current tier, next-tier progress, point ratio, referral code,
    * recent transactions). Requires an authenticated customer session.
    */
-  async getLoyalty() {
-    return this.client.request("GET", "/customer/loyalty");
+  async getLoyalty(query = {}) {
+    return this.client.request("GET", "/customer/loyalty", { query: { ...query } });
+  }
+  /** Apply an invitation to the caller's active loyalty membership, once. */
+  async applyReferral(code) {
+    return this.client.request("POST", "/customer/loyalty/referral", { body: { code } });
+  }
+  /** Explicit enrollment; invite-only programs require the shop administrator. */
+  async joinLoyalty() {
+    return this.client.request("POST", "/customer/loyalty/join", { body: { consent: true } });
+  }
+  /** Authenticated account rewards. Both collections have independent pages. */
+  async getGamification(query = {}) {
+    return this.client.request("GET", "/customer/gamification", { query: { ...query } });
+  }
+  /** Join an active challenge; a repeated call preserves the original joinedAt. */
+  async joinChallenge(challengeId) {
+    return this.client.request("POST", `/customer/gamification/challenges/${encodeURIComponent(challengeId)}/join`);
+  }
+  /** Reconcile persisted qualifying activity. Never supplies progress or points. */
+  async refreshGamification() {
+    return this.client.request("POST", "/customer/gamification/refresh");
   }
   /**
    * Digital product delivery (GAP-07): list the logged-in customer's download
@@ -3909,16 +3929,19 @@ function errorParams(err) {
   const params = body?.params;
   return params && typeof params === "object" && !Array.isArray(params) ? params : {};
 }
-var FORM_FIELD_ERROR_CODES = /* @__PURE__ */ new Set([
-  "required",
-  "invalid",
-  "tooShort",
-  "tooLong",
-  "min",
-  "max",
-  "notOption",
-  "pattern"
-]);
+var FORM_FIELD_ERROR_CODES = {
+  required: true,
+  invalid: true,
+  tooShort: true,
+  tooLong: true,
+  min: true,
+  max: true,
+  notOption: true,
+  pattern: true,
+  dateNotFuture: true,
+  dateNotPast: true,
+  tooManyFiles: true
+};
 function formFieldErrors(err) {
   if (errorCode(err) !== "be.forms.validationFailed") return [];
   const raw = errorParams(err).errors;
@@ -3930,7 +3953,7 @@ function formFieldErrors(err) {
     if (idx <= 0) continue;
     const key = entry.slice(0, idx);
     const code = entry.slice(idx + 1);
-    if (!FORM_FIELD_ERROR_CODES.has(code)) continue;
+    if (!Object.prototype.hasOwnProperty.call(FORM_FIELD_ERROR_CODES, code)) continue;
     out.push({ key, code });
   }
   return out;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@behio/storefront-sdk",
-  "version": "2.7.0",
+  "version": "2.9.0",
   "description": "TypeScript SDK for Behio headless e-commerce: core client + React hooks",
   "author": "Behio",
   "license": "MIT",