@putiikkipalvelu/storefront-sdk 0.2.5 → 0.4.0

package/dist/index.js

@@ -414,6 +414,138 @@ function createCategoriesResource(fetcher) {
   };
 }
 
+// src/utils/pricing.ts
+function isSaleActive(startDate, endDate) {
+  if (!startDate && !endDate) {
+    return true;
+  }
+  const now = /* @__PURE__ */ new Date();
+  const start = startDate ? new Date(startDate) : null;
+  const end = endDate ? new Date(endDate) : null;
+  if (start && !end) {
+    return now >= start;
+  }
+  if (!start && end) {
+    return now <= end;
+  }
+  if (start && end) {
+    return now >= start && now <= end;
+  }
+  return true;
+}
+function getPriceInfo(product, variation) {
+  if (variation) {
+    const isOnSale2 = isSaleActive(variation.saleStartDate, variation.saleEndDate) && variation.salePrice !== null;
+    const originalPrice2 = variation.price ?? product.price;
+    const effectivePrice2 = isOnSale2 ? variation.salePrice ?? originalPrice2 : originalPrice2;
+    return {
+      effectivePrice: effectivePrice2,
+      originalPrice: originalPrice2,
+      isOnSale: isOnSale2,
+      salePercent: isOnSale2 ? variation.salePercent ?? null : null
+    };
+  }
+  const isOnSale = isSaleActive(product.saleStartDate, product.saleEndDate) && product.salePrice !== null;
+  const originalPrice = product.price;
+  const effectivePrice = isOnSale ? product.salePrice ?? originalPrice : originalPrice;
+  return {
+    effectivePrice,
+    originalPrice,
+    isOnSale,
+    salePercent: isOnSale ? product.salePercent ?? null : null
+  };
+}
+
+// src/utils/cart-calculations.ts
+function calculateCartWithCampaigns(items, campaigns) {
+  const buyXPayYCampaign = campaigns.find(
+    (c) => c.type === "BUY_X_PAY_Y" && c.isActive
+  );
+  const originalTotal = items.reduce((total, { product, variation, cartQuantity }) => {
+    const priceInfo = getPriceInfo(product, variation);
+    return total + priceInfo.effectivePrice * cartQuantity;
+  }, 0);
+  if (!buyXPayYCampaign?.BuyXPayYCampaign) {
+    const calculatedItems2 = items.map((item) => ({
+      item,
+      paidQuantity: item.cartQuantity,
+      freeQuantity: 0,
+      totalQuantity: item.cartQuantity
+    }));
+    return {
+      calculatedItems: calculatedItems2,
+      cartTotal: originalTotal,
+      originalTotal,
+      totalSavings: 0
+    };
+  }
+  const { buyQuantity, payQuantity, applicableCategories } = buyXPayYCampaign.BuyXPayYCampaign;
+  const applicableCategoryIds = new Set(
+    applicableCategories.map((c) => c.id)
+  );
+  const eligibleUnits = items.flatMap((item) => {
+    const { product, variation } = item;
+    const itemCategories = product.categories?.map((cat) => cat.id) || [];
+    const isEligible = itemCategories.some(
+      (id) => applicableCategoryIds.has(id)
+    );
+    if (isEligible) {
+      const priceInfo = getPriceInfo(product, variation);
+      return Array.from({ length: item.cartQuantity }, () => ({
+        price: priceInfo.effectivePrice,
+        productId: product.id,
+        variationId: variation?.id,
+        originalItem: item
+      }));
+    }
+    return [];
+  });
+  if (eligibleUnits.length < buyQuantity) {
+    const calculatedItems2 = items.map((item) => ({
+      item,
+      paidQuantity: item.cartQuantity,
+      freeQuantity: 0,
+      totalQuantity: item.cartQuantity
+    }));
+    return {
+      calculatedItems: calculatedItems2,
+      cartTotal: originalTotal,
+      originalTotal,
+      totalSavings: 0
+    };
+  }
+  eligibleUnits.sort((a, b) => a.price - b.price);
+  const numToMakeFree = buyQuantity - payQuantity;
+  const itemsToMakeFree = eligibleUnits.slice(0, numToMakeFree);
+  const totalSavings = itemsToMakeFree.reduce(
+    (sum, item) => sum + item.price,
+    0
+  );
+  const freeCountMap = /* @__PURE__ */ new Map();
+  for (const freebie of itemsToMakeFree) {
+    const key = `${freebie.productId}${freebie.variationId ? `_${freebie.variationId}` : ""}`;
+    freeCountMap.set(key, (freeCountMap.get(key) || 0) + 1);
+  }
+  const calculatedItems = items.map((item) => {
+    const key = `${item.product.id}${item.variation?.id ? `_${item.variation.id}` : ""}`;
+    const freeQuantity = freeCountMap.get(key) || 0;
+    const paidQuantity = item.cartQuantity - freeQuantity;
+    return {
+      item,
+      paidQuantity: Math.max(0, paidQuantity),
+      freeQuantity,
+      totalQuantity: item.cartQuantity
+    };
+  });
+  const cartTotal = originalTotal - totalSavings;
+  return {
+    calculatedItems,
+    cartTotal,
+    originalTotal,
+    totalSavings
+  };
+}
+
 // src/resources/cart.ts
 function buildCartHeaders(options) {
   const headers = {};
@@ -576,33 +708,49 @@ function createCartResource(fetcher) {
      * Checks product availability, stock levels, and prices.
      * Auto-fixes issues (removes unavailable items, adjusts quantities).
      *
+     * Campaign conflict detection:
+     * - SDK calculates if BuyXPayY campaigns apply using calculateCartWithCampaigns()
+     * - Sends x-campaigns-apply header to backend
+     * - If campaigns apply AND discount code exists, backend removes it
+     * - Returns changes.discountCouponRemoved = true
+     *
      * @param options - Cart session options
+     * @param cartItems - Current cart items for campaign calculation
+     * @param campaigns - Active campaigns for conflict check
      * @param fetchOptions - Fetch options
      * @returns Validated cart with change metadata
      *
      * @example Validate before checkout
      * ```typescript
-     * const { items, hasChanges, changes } = await client.cart.validate({ cartId });
+     * const result = await client.cart.validate(
+     *   { cartId },
+     *   cartItems,
+     *   storeConfig.campaigns
+     * );
      *
-     * if (hasChanges) {
-     *   if (changes.removedItems > 0) {
-     *     notify('Some items were removed (out of stock)');
-     *   }
-     *   if (changes.quantityAdjusted > 0) {
-     *     notify('Some quantities were adjusted');
-     *   }
-     *   if (changes.priceChanged > 0) {
-     *     notify('Some prices have changed');
+     * if (result.hasChanges) {
+     *   if (result.changes.discountCouponRemoved) {
+     *     notify("Alennuskoodi poistettu - kampanja-alennus aktivoitui");
      *   }
+     *   // Handle other changes...
      * }
      * ```
      */
-    async validate(options, fetchOptions) {
+    async validate(options, cartItems, campaigns, fetchOptions) {
+      let campaignsApply = false;
+      if (cartItems && campaigns && cartItems.length > 0) {
+        const campaignResult = calculateCartWithCampaigns(cartItems, campaigns);
+        campaignsApply = campaignResult.totalSavings > 0;
+      }
+      const headers = {
+        ...buildCartHeaders(options),
+        "x-campaigns-apply": campaignsApply ? "true" : "false"
+      };
       return fetcher.request(
         "/api/storefront/v1/cart/validate",
         {
           method: "GET",
-          headers: buildCartHeaders(options),
+          headers,
           ...fetchOptions
         }
       );
@@ -617,48 +765,71 @@ function calculateCartWeight(items) {
     return total + itemWeight * item.cartQuantity;
   }, 0);
 }
+function calculateCartTotal(items) {
+  return items.reduce((total, item) => {
+    const itemPrice = item.variation ? item.variation.salePrice ?? item.variation.price : item.product.salePrice ?? item.product.price;
+    return total + itemPrice * item.cartQuantity;
+  }, 0);
+}
 function createShippingResource(fetcher) {
   return {
     /**
      * Get shipping options for a specific postal code.
-     * Returns home delivery methods and pickup locations.
+     * Returns pickup points and home delivery options in a unified format.
+     *
+     * **Pickup points are returned first** as they are more popular in Finland.
      *
      * @param postalCode - Customer's postal code (e.g., "00100")
      * @param options - Fetch options including optional cartItems for weight-based filtering
-     * @returns Home delivery methods and pickup locations
+     * @returns Unified shipping options (pickupPoints sorted by distance, homeDelivery sorted by price)
      *
      * @example
      * ```typescript
-     * const { homeDeliveryMethods, pickupLocations } = await client.shipping.getWithLocations("00100");
-     *
-     * // Show home delivery options
-     * homeDeliveryMethods.forEach(method => {
-     *   console.log(`${method.name}: ${method.price / 100}€`);
+     * const { pickupPoints, homeDelivery } = await client.shipping.getOptions("00100");
+     *
+     * // Show pickup points (more popular in Finland)
+     * pickupPoints.forEach(point => {
+     *   console.log(`${point.name} - ${point.carrier}`);
+     *   console.log(`  ${point.address}, ${point.city}`);
+     *   console.log(`  ${(point.distance! / 1000).toFixed(1)} km away`);
+     *   console.log(`  Price: ${point.price / 100}€`);
      * });
      *
-     * // Show pickup locations
-     * pickupLocations.forEach(location => {
-     *   console.log(`${location.name} - ${location.carrier}`);
-     *   console.log(`  ${location.address1}, ${location.city}`);
-     *   console.log(`  ${location.distanceInKilometers.toFixed(1)} km away`);
-     *   console.log(`  Price: ${location.price / 100}€`);
+     * // Show home delivery options
+     * homeDelivery.forEach(option => {
+     *   console.log(`${option.name}: ${option.price / 100}€`);
+     *   if (option.estimatedDelivery) {
+     *     console.log(`  Delivery: ${option.estimatedDelivery} days`);
+     *   }
      * });
      * ```
      *
      * @example Weight-based filtering
      * ```typescript
-     * const { homeDeliveryMethods, pickupLocations } = await client.shipping.getWithLocations(
-     *   "00100",
-     *   { cartItems: cartItems }
-     * );
+     * const options = await client.shipping.getOptions("00100", {
+     *   cartItems: cartItems
+     * });
      * // Only shows methods that support the cart's total weight
      * ```
+     *
+     * @example International shipping
+     * ```typescript
+     * const options = await client.shipping.getOptions("112 22", {
+     *   country: "SE"
+     * });
+     * ```
      */
-    async getWithLocations(postalCode, options) {
+    async getOptions(postalCode, options) {
       const params = new URLSearchParams();
       if (options?.cartItems?.length) {
         const cartWeight = calculateCartWeight(options.cartItems);
         params.set("cartWeight", cartWeight.toString());
+        const cartTotal = options.campaigns ? calculateCartWithCampaigns(options.cartItems, options.campaigns).cartTotal : calculateCartTotal(options.cartItems);
+        const finalCartTotal = options.discountAmount ? Math.max(0, cartTotal - options.discountAmount) : cartTotal;
+        params.set("cartTotal", finalCartTotal.toString());
+      }
+      if (options?.country) {
+        params.set("country", options.country);
       }
       const queryString = params.toString();
       const url = `/api/storefront/v1/shipment-methods/${encodeURIComponent(postalCode)}${queryString ? `?${queryString}` : ""}`;
@@ -666,6 +837,12 @@ function createShippingResource(fetcher) {
         method: "GET",
         ...options
       });
+    },
+    /**
+     * @deprecated Use getOptions() instead. This method is kept for backwards compatibility.
+     */
+    async getWithLocations(postalCode, options) {
+      return this.getOptions(postalCode, options);
     }
   };
 }
@@ -1367,6 +1544,102 @@ function createCheckoutResource(fetcher) {
   };
 }
 
+// src/resources/discount-code.ts
+function createDiscountCodeResource(fetcher) {
+  return {
+    /**
+     * Apply a discount code to the cart
+     *
+     * Checks for BuyXPayY campaign conflict before calling API.
+     * Discount codes cannot be used when a campaign discount is active.
+     *
+     * @param params - Parameters including code, session info, and cart/campaign data for conflict check
+     * @returns Applied discount details
+     * @throws {StorefrontError} With code "CAMPAIGN_ACTIVE" if a BuyXPayY campaign is active
+     *
+     * @example
+     * ```typescript
+     * const result = await client.discountCode.apply({
+     *   code: "SUMMER20",
+     *   cartId: cartId,
+     *   cartItems: cart.items,
+     *   campaigns: storeConfig.campaigns,
+     * });
+     * ```
+     */
+    async apply(params) {
+      const { code, cartId, sessionId, cartItems, campaigns } = params;
+      if (cartItems && campaigns && cartItems.length > 0) {
+        const campaignResult = calculateCartWithCampaigns(cartItems, campaigns);
+        if (campaignResult.totalSavings > 0) {
+          throw new StorefrontError(
+            "Alennuskoodia ei voi k\xE4ytt\xE4\xE4 kun kampanja-alennus on voimassa",
+            400,
+            "CAMPAIGN_ACTIVE"
+          );
+        }
+      }
+      const cartTotal = cartItems ? cartItems.reduce((sum, item) => {
+        const priceInfo = getPriceInfo(item.product, item.variation);
+        return sum + priceInfo.effectivePrice * item.cartQuantity;
+      }, 0) : 0;
+      return fetcher.request("/api/storefront/v1/discount-code/apply", {
+        method: "POST",
+        body: { code, cartTotal },
+        headers: {
+          ...cartId && { "x-cart-id": cartId },
+          ...sessionId && { "x-session-id": sessionId }
+        }
+      });
+    },
+    /**
+     * Get the currently applied discount code
+     *
+     * @param params - Session info (cartId or sessionId)
+     * @returns Current discount or null if none applied
+     *
+     * @example
+     * ```typescript
+     * const { discount } = await client.discountCode.get({ cartId });
+     * if (discount) {
+     *   console.log(`Code ${discount.code}: ${discount.discountValue}${discount.discountType === 'PERCENTAGE' ? '%' : '¢'} off`);
+     * }
+     * ```
+     */
+    async get(params = {}) {
+      const { cartId, sessionId } = params;
+      return fetcher.request("/api/storefront/v1/discount-code/apply", {
+        method: "GET",
+        headers: {
+          ...cartId && { "x-cart-id": cartId },
+          ...sessionId && { "x-session-id": sessionId }
+        }
+      });
+    },
+    /**
+     * Remove the currently applied discount code
+     *
+     * @param params - Session info (cartId or sessionId)
+     * @returns Success status
+     *
+     * @example
+     * ```typescript
+     * await client.discountCode.remove({ cartId });
+     * ```
+     */
+    async remove(params = {}) {
+      const { cartId, sessionId } = params;
+      return fetcher.request("/api/storefront/v1/discount-code/apply", {
+        method: "DELETE",
+        headers: {
+          ...cartId && { "x-cart-id": cartId },
+          ...sessionId && { "x-session-id": sessionId }
+        }
+      });
+    }
+  };
+}
+
 // src/client.ts
 function createStorefrontClient(config) {
   if (!config.apiKey) {
@@ -1390,148 +1663,100 @@ function createStorefrontClient(config) {
     shipping: createShippingResource(fetcher),
     customer: createCustomerResource(fetcher),
     order: createOrderResource(fetcher),
-    checkout: createCheckoutResource(fetcher)
+    checkout: createCheckoutResource(fetcher),
+    discountCode: createDiscountCodeResource(fetcher)
   };
 }
 
-// src/utils/pricing.ts
-function isSaleActive(startDate, endDate) {
-  if (!startDate && !endDate) {
-    return true;
+// src/utils/discount.ts
+function formatDiscountValue(discount, options = {}) {
+  const {
+    currencySymbol = "\u20AC",
+    currencyPosition = "after",
+    decimals = 2,
+    showMinus = true
+  } = options;
+  const prefix = showMinus ? "-" : "";
+  if (discount.discountType === "PERCENTAGE") {
+    return `${prefix}${discount.discountValue}%`;
   }
-  const now = /* @__PURE__ */ new Date();
-  const start = startDate ? new Date(startDate) : null;
-  const end = endDate ? new Date(endDate) : null;
-  if (start && !end) {
-    return now >= start;
-  }
-  if (!start && end) {
-    return now <= end;
-  }
-  if (start && end) {
-    return now >= start && now <= end;
+  const amount = (discount.discountValue / 100).toFixed(decimals);
+  const formattedAmount = amount.replace(".", ",");
+  if (currencyPosition === "before") {
+    return `${prefix}${currencySymbol}${formattedAmount}`;
   }
-  return true;
+  return `${prefix}${formattedAmount} ${currencySymbol}`;
 }
-function getPriceInfo(product, variation) {
-  if (variation) {
-    const isOnSale2 = isSaleActive(variation.saleStartDate, variation.saleEndDate) && variation.salePrice !== null;
-    const originalPrice2 = variation.price ?? product.price;
-    const effectivePrice2 = isOnSale2 ? variation.salePrice ?? originalPrice2 : originalPrice2;
-    return {
-      effectivePrice: effectivePrice2,
-      originalPrice: originalPrice2,
-      isOnSale: isOnSale2,
-      salePercent: isOnSale2 ? variation.salePercent ?? null : null
-    };
+function calculateDiscountAmount(subtotal, discount) {
+  if (discount.discountType === "PERCENTAGE") {
+    return Math.round(subtotal * discount.discountValue / 100);
   }
-  const isOnSale = isSaleActive(product.saleStartDate, product.saleEndDate) && product.salePrice !== null;
-  const originalPrice = product.price;
-  const effectivePrice = isOnSale ? product.salePrice ?? originalPrice : originalPrice;
-  return {
-    effectivePrice,
-    originalPrice,
-    isOnSale,
-    salePercent: isOnSale ? product.salePercent ?? null : null
-  };
+  return Math.min(discount.discountValue, subtotal);
 }
-
-// src/utils/cart-calculations.ts
-function calculateCartWithCampaigns(items, campaigns) {
-  const buyXPayYCampaign = campaigns.find(
-    (c) => c.type === "BUY_X_PAY_Y" && c.isActive
-  );
-  const originalTotal = items.reduce((total, { product, variation, cartQuantity }) => {
-    const priceInfo = getPriceInfo(product, variation);
-    return total + priceInfo.effectivePrice * cartQuantity;
-  }, 0);
-  const freeShipping = {
-    isEligible: false,
-    minimumSpend: 0,
-    remainingAmount: 0
-  };
-  if (!buyXPayYCampaign?.BuyXPayYCampaign) {
-    const calculatedItems2 = items.map((item) => ({
-      item,
-      paidQuantity: item.cartQuantity,
-      freeQuantity: 0,
-      totalQuantity: item.cartQuantity
-    }));
-    return {
-      calculatedItems: calculatedItems2,
-      cartTotal: originalTotal,
-      originalTotal,
-      totalSavings: 0,
-      freeShipping
-    };
+var REMOVAL_MESSAGES = {
+  CAMPAIGN_ACTIVE: {
+    fi: "Alennuskoodi poistettu - kampanja-alennus aktivoitui",
+    en: "Discount code removed - campaign discount activated"
+  },
+  MIN_ORDER_NOT_MET: {
+    fi: "Alennuskoodi poistettu - ostoskorin summa alittaa minimitilauksen",
+    en: "Discount code removed - cart total below minimum order"
+  },
+  CODE_INVALID: {
+    fi: "Alennuskoodi poistettu - koodi ei ole en\xE4\xE4 voimassa",
+    en: "Discount code removed - code is no longer valid"
   }
-  const { buyQuantity, payQuantity, applicableCategories } = buyXPayYCampaign.BuyXPayYCampaign;
-  const applicableCategoryIds = new Set(
-    applicableCategories.map((c) => c.id)
-  );
-  const eligibleUnits = items.flatMap((item) => {
-    const { product, variation } = item;
-    const itemCategories = product.categories?.map((cat) => cat.id) || [];
-    const isEligible = itemCategories.some(
-      (id) => applicableCategoryIds.has(id)
-    );
-    if (isEligible) {
-      const priceInfo = getPriceInfo(product, variation);
-      return Array.from({ length: item.cartQuantity }, () => ({
-        price: priceInfo.effectivePrice,
-        productId: product.id,
-        variationId: variation?.id,
-        originalItem: item
-      }));
-    }
-    return [];
-  });
-  if (eligibleUnits.length < buyQuantity) {
-    const calculatedItems2 = items.map((item) => ({
-      item,
-      paidQuantity: item.cartQuantity,
-      freeQuantity: 0,
-      totalQuantity: item.cartQuantity
-    }));
-    return {
-      calculatedItems: calculatedItems2,
-      cartTotal: originalTotal,
-      originalTotal,
-      totalSavings: 0,
-      freeShipping
-    };
+};
+var DEFAULT_REMOVAL_MESSAGE = {
+  fi: "Alennuskoodi poistettu",
+  en: "Discount code removed"
+};
+function getDiscountRemovalMessage(reason, locale = "fi") {
+  if (!reason) {
+    return DEFAULT_REMOVAL_MESSAGE[locale];
   }
-  eligibleUnits.sort((a, b) => a.price - b.price);
-  const numToMakeFree = buyQuantity - payQuantity;
-  const itemsToMakeFree = eligibleUnits.slice(0, numToMakeFree);
-  const totalSavings = itemsToMakeFree.reduce(
-    (sum, item) => sum + item.price,
-    0
-  );
-  const freeCountMap = /* @__PURE__ */ new Map();
-  for (const freebie of itemsToMakeFree) {
-    const key = `${freebie.productId}${freebie.variationId ? `_${freebie.variationId}` : ""}`;
-    freeCountMap.set(key, (freeCountMap.get(key) || 0) + 1);
+  return REMOVAL_MESSAGES[reason]?.[locale] ?? DEFAULT_REMOVAL_MESSAGE[locale];
+}
+var APPLY_ERROR_MESSAGES = {
+  NOT_FOUND: {
+    fi: "Alennuskoodia ei l\xF6ydy",
+    en: "Discount code not found"
+  },
+  INACTIVE: {
+    fi: "Alennuskoodi ei ole k\xE4yt\xF6ss\xE4",
+    en: "Discount code is not active"
+  },
+  NOT_STARTED: {
+    fi: "Alennuskoodi ei ole viel\xE4 voimassa",
+    en: "Discount code is not yet valid"
+  },
+  EXPIRED: {
+    fi: "Alennuskoodi on vanhentunut",
+    en: "Discount code has expired"
+  },
+  MAX_USES_REACHED: {
+    fi: "Alennuskoodi on k\xE4ytetty loppuun",
+    en: "Discount code usage limit reached"
+  },
+  MIN_ORDER_NOT_MET: {
+    fi: "Ostoskorin summa alittaa alennuskoodin minimitilauksen",
+    en: "Cart total is below the minimum order for this code"
+  },
+  CAMPAIGN_ACTIVE: {
+    fi: "Alennuskoodia ei voi k\xE4ytt\xE4\xE4 kun kampanja-alennus on voimassa",
+    en: "Discount code cannot be used when a campaign discount is active"
   }
-  const calculatedItems = items.map((item) => {
-    const key = `${item.product.id}${item.variation?.id ? `_${item.variation.id}` : ""}`;
-    const freeQuantity = freeCountMap.get(key) || 0;
-    const paidQuantity = item.cartQuantity - freeQuantity;
-    return {
-      item,
-      paidQuantity: Math.max(0, paidQuantity),
-      freeQuantity,
-      totalQuantity: item.cartQuantity
-    };
-  });
-  const cartTotal = originalTotal - totalSavings;
-  return {
-    calculatedItems,
-    cartTotal,
-    originalTotal,
-    totalSavings,
-    freeShipping
-  };
+};
+var DEFAULT_APPLY_ERROR = {
+  fi: "Alennuskoodin k\xE4ytt\xF6 ep\xE4onnistui",
+  en: "Failed to apply discount code"
+};
+function getDiscountApplyErrorMessage(errorCode, locale = "fi") {
+  if (!errorCode) {
+    return DEFAULT_APPLY_ERROR[locale];
+  }
+  const messages = APPLY_ERROR_MESSAGES[errorCode];
+  return messages?.[locale] ?? DEFAULT_APPLY_ERROR[locale];
 }
 export {
   AuthError,
@@ -1541,7 +1766,11 @@ export {
   ValidationError,
   VerificationRequiredError,
   calculateCartWithCampaigns,
+  calculateDiscountAmount,
   createStorefrontClient,
+  formatDiscountValue,
+  getDiscountApplyErrorMessage,
+  getDiscountRemovalMessage,
   getPriceInfo,
   isSaleActive
 };