@putiikkipalvelu/storefront-sdk 0.2.2 → 0.2.4

package/dist/index.d.ts

@@ -91,7 +91,7 @@ interface FeatureFlags {
     reviewsEnabled: boolean;
 }
 /** Campaign type */
-type CampaignType = "FREE_SHIPPING" | "BUY_X_PAY_Y";
+type CampaignType = "BUY_X_PAY_Y";
 /**
  * Store campaign (promotion)
  */
@@ -116,24 +116,9 @@ interface Campaign {
     createdAt: string;
     /** Last update timestamp (ISO 8601) */
     updatedAt: string;
-    /** Free shipping campaign details (if type is FREE_SHIPPING) */
-    FreeShippingCampaign: FreeShippingCampaign | null;
     /** Buy X Pay Y campaign details (if type is BUY_X_PAY_Y) */
     BuyXPayYCampaign: BuyXPayYCampaign | null;
 }
-/**
- * Free shipping campaign details
- */
-interface FreeShippingCampaign {
-    /** Unique identifier */
-    id: string;
-    /** Parent campaign ID */
-    campaignId: string;
-    /** Minimum spend in cents to qualify for free shipping */
-    minimumSpend: number;
-    /** Shipping methods eligible for free shipping */
-    shipmentMethods: ShipmentMethod[];
-}
 /**
  * Buy X Pay Y campaign details (e.g., "Buy 3, Pay 2")
  */
@@ -152,18 +137,19 @@ interface BuyXPayYCampaign {
 /**
  * Shipit shipping method details
  * Represents a shipping service synced from the Shipit API
+ * Supports multiple carriers in a single method for multi-carrier shipping
  */
 interface ShipitShippingMethod {
     /** Unique ID */
     id: string;
-    /** Shipit service identifier */
-    serviceId: string;
+    /** Shipit service identifiers for all selected carriers */
+    serviceIds: string[];
     /** Service name */
     name: string;
-    /** Carrier name (e.g., "Posti", "Matkahuolto") */
-    carrier: string;
-    /** Carrier logo URL */
-    logo: string;
+    /** Carrier names (e.g., ["Posti", "Matkahuolto"]) */
+    carriers: string[];
+    /** Carrier logo URLs */
+    logos: string[];
     /** Whether pickup is included */
     pickUpIncluded: boolean;
     /** Whether home delivery is available */
@@ -184,16 +170,16 @@ interface ShipitShippingMethod {
     length: number;
     /** Package width in cm */
     width: number;
-    /** Package weight in kg */
+    /** Package weight in kg @deprecated Use maxWeight instead */
     weight: number;
+    /** Maximum package weight in kg for this shipping tier */
+    maxWeight: number;
     /** Service type */
     type: string;
     /** Shipit price in cents */
     price: number;
-    /** Whether pickup point selection is available */
-    pickupPoint: boolean;
-    /** Whether only parcel locker delivery is available */
-    onlyParchelLocker: boolean;
+    /** Whether to show pickup point selector (true) or home delivery only (false) */
+    showPickupPoints: boolean;
     /** Reference to parent shipment method */
     shipmentMethodId: string;
     /** Created timestamp */
@@ -275,6 +261,8 @@ interface ProductVariationListing {
  * Full product variation (for product detail page)
  */
 interface ProductVariation extends ProductVariationListing {
+    /** Variation weight in kg (null = use product weight) */
+    weight: number | null;
     /** Available quantity (null = unlimited) */
     quantity: number | null;
     /** Stock keeping unit */
@@ -323,6 +311,8 @@ interface Product {
  * Used by: /product/{slug}
  */
 interface ProductDetail extends Omit<Product, "variations"> {
+    /** Product weight in kg (for shipping calculations) */
+    weight: number;
     /** Stock keeping unit */
     sku: string | null;
     /** SEO meta title */
@@ -1699,6 +1689,13 @@ type CartResource = ReturnType<typeof createCartResource>;
  * Methods for fetching shipment methods and pickup locations.
  */
 
+/**
+ * Options for fetching shipment methods with weight-based filtering
+ */
+interface GetMethodsOptions extends FetchOptions {
+    /** Cart items - weight will be calculated automatically */
+    cartItems?: CartItem[];
+}
 /**
  * Shipping resource for fetching shipment methods and pickup locations
  */
@@ -1707,7 +1704,7 @@ declare function createShippingResource(fetcher: Fetcher): {
      * Get all available shipment methods for the store.
      * Returns methods without pickup locations - use `getWithLocations` for postal code specific data.
      *
-     * @param options - Fetch options (caching, headers, etc.)
+     * @param options - Fetch options including optional cartItems for weight-based filtering
      * @returns Available shipment methods
      *
      * @example
@@ -1718,14 +1715,22 @@ declare function createShippingResource(fetcher: Fetcher): {
      *   console.log(`${method.name}: ${method.price / 100}€`);
      * });
      * ```
+     *
+     * @example Weight-based filtering
+     * ```typescript
+     * // Pass cart items - SDK calculates weight automatically
+     * const { shipmentMethods } = await client.shipping.getMethods({
+     *   cartItems: cartItems
+     * });
+     * ```
      */
-    getMethods(options?: FetchOptions): Promise<ShipmentMethodsResponse>;
+    getMethods(options?: GetMethodsOptions): Promise<ShipmentMethodsResponse>;
     /**
      * Get shipment methods with pickup locations for a specific postal code.
      * Calls the Shipit API to fetch nearby pickup points (parcel lockers, etc.)
      *
      * @param postalCode - Customer's postal code (e.g., "00100")
-     * @param options - Fetch options (caching, headers, etc.)
+     * @param options - Fetch options including optional cartItems for weight-based filtering
      * @returns Shipment methods and nearby pickup locations with pricing
      *
      * @example
@@ -1741,16 +1746,17 @@ declare function createShippingResource(fetcher: Fetcher): {
      * });
      * ```
      *
-     * @example Filter by carrier
+     * @example Weight-based filtering with postal code
      * ```typescript
-     * const { pricedLocations } = await client.shipping.getWithLocations("00100");
-     *
-     * const postiLocations = pricedLocations.filter(
-     *   loc => loc.carrier === "Posti"
+     * const { shipmentMethods, pricedLocations } = await client.shipping.getWithLocations(
+     *   "00100",
+     *   { cartItems: cartItems }
      * );
+     *
+     * // Only shows methods that support the cart's total weight
      * ```
      */
-    getWithLocations(postalCode: string, options?: FetchOptions): Promise<ShipmentMethodsWithLocationsResponse>;
+    getWithLocations(postalCode: string, options?: GetMethodsOptions): Promise<ShipmentMethodsWithLocationsResponse>;
 };
 /**
  * Type for the shipping resource
@@ -2466,4 +2472,4 @@ declare class VerificationRequiredError extends StorefrontError {
     constructor(message: string, customerId: string);
 }
 
-export { type AddToCartParams, type AddToWishlistResponse, AuthError, type BuyXPayYCampaign, type CalculatedCartItem, type Campaign, type CampaignType, type CartCalculationResult, type CartItem, type CartResponse, type CartSessionOptions, type CartValidationChanges, type CartValidationResponse, type Category, type CategoryReference, type CategoryResponse, type CheckoutCustomerData, type CheckoutErrorCode, type CheckoutErrorDetails, type CheckoutOptions, type CheckoutParams, type CheckoutShipmentMethod, type ConfirmationItemType, type ConfirmationOrderCustomerData, type ConfirmationOrderLineItem, type ConfirmationOrderShipmentMethod, type Customer, type CustomerOrder, type DeleteAccountResponse, type FeatureFlags, type FetchOptions, type ForgotPasswordResponse, type FreeShippingCampaign, type FreeShippingStatus, type GetOrdersResponse, type GetUserResponse, type LoginOptions, type LoginResponse, type LoginVerificationRequiredResponse, type LogoutResponse, NotFoundError, type Order, type OrderLineItem, type OrderProductInfo, type OrderShipmentMethod, type OrderStatus, type PaymentConfig, type PaytrailCheckoutResponse, type PaytrailGroup, type PaytrailProvider, type PickupLocation, type PriceInfo, type Product, type ProductCountResponse, type ProductDetail, type ProductListParams, type ProductListResponse, type ProductSortOption, type ProductVariation, type ProductVariationListing, RateLimitError, type RegisterData, type RegisterResponse, type RemoveFromCartParams, type RemoveFromWishlistResponse, type ResendVerificationResponse, type ResetPasswordResponse, type ShipitShippingMethod, type ShipmentMethod, type ShipmentMethodsResponse, type ShipmentMethodsWithLocationsResponse, type StoreConfig, type StoreInfo, type StoreSeo, type StorefrontClient, type StorefrontClientConfig, StorefrontError, type StripeCheckoutResponse, type UpdateCartQuantityParams, type UpdateProfileData, type UpdateProfileResponse, ValidationError, type VariationOption, VerificationRequiredError, type VerifyEmailResponse, type WishlistItem, type WishlistProduct, type WishlistResponse, type WishlistVariation, type WishlistVariationOption, calculateCartWithCampaigns, createStorefrontClient, getPriceInfo, isSaleActive };
+export { type AddToCartParams, type AddToWishlistResponse, AuthError, type BuyXPayYCampaign, type CalculatedCartItem, type Campaign, type CampaignType, type CartCalculationResult, type CartItem, type CartResponse, type CartSessionOptions, type CartValidationChanges, type CartValidationResponse, type Category, type CategoryReference, type CategoryResponse, type CheckoutCustomerData, type CheckoutErrorCode, type CheckoutErrorDetails, type CheckoutOptions, type CheckoutParams, type CheckoutShipmentMethod, type ConfirmationItemType, type ConfirmationOrderCustomerData, type ConfirmationOrderLineItem, type ConfirmationOrderShipmentMethod, type Customer, type CustomerOrder, type DeleteAccountResponse, type FeatureFlags, type FetchOptions, type ForgotPasswordResponse, type FreeShippingStatus, type GetOrdersResponse, type GetUserResponse, type LoginOptions, type LoginResponse, type LoginVerificationRequiredResponse, type LogoutResponse, NotFoundError, type Order, type OrderLineItem, type OrderProductInfo, type OrderShipmentMethod, type OrderStatus, type PaymentConfig, type PaytrailCheckoutResponse, type PaytrailGroup, type PaytrailProvider, type PickupLocation, type PriceInfo, type Product, type ProductCountResponse, type ProductDetail, type ProductListParams, type ProductListResponse, type ProductSortOption, type ProductVariation, type ProductVariationListing, RateLimitError, type RegisterData, type RegisterResponse, type RemoveFromCartParams, type RemoveFromWishlistResponse, type ResendVerificationResponse, type ResetPasswordResponse, type ShipitShippingMethod, type ShipmentMethod, type ShipmentMethodsResponse, type ShipmentMethodsWithLocationsResponse, type StoreConfig, type StoreInfo, type StoreSeo, type StorefrontClient, type StorefrontClientConfig, StorefrontError, type StripeCheckoutResponse, type UpdateCartQuantityParams, type UpdateProfileData, type UpdateProfileResponse, ValidationError, type VariationOption, VerificationRequiredError, type VerifyEmailResponse, type WishlistItem, type WishlistProduct, type WishlistResponse, type WishlistVariation, type WishlistVariationOption, calculateCartWithCampaigns, createStorefrontClient, getPriceInfo, isSaleActive };

package/dist/index.js

@@ -611,13 +611,19 @@ function createCartResource(fetcher) {
 }
 
 // src/resources/shipping.ts
+function calculateCartWeight(items) {
+  return items.reduce((total, item) => {
+    const itemWeight = item.variation?.weight ?? item.product.weight ?? 0.5;
+    return total + itemWeight * item.cartQuantity;
+  }, 0);
+}
 function createShippingResource(fetcher) {
   return {
     /**
      * Get all available shipment methods for the store.
      * Returns methods without pickup locations - use `getWithLocations` for postal code specific data.
      *
-     * @param options - Fetch options (caching, headers, etc.)
+     * @param options - Fetch options including optional cartItems for weight-based filtering
      * @returns Available shipment methods
      *
      * @example
@@ -628,22 +634,34 @@ function createShippingResource(fetcher) {
      *   console.log(`${method.name}: ${method.price / 100}€`);
      * });
      * ```
+     *
+     * @example Weight-based filtering
+     * ```typescript
+     * // Pass cart items - SDK calculates weight automatically
+     * const { shipmentMethods } = await client.shipping.getMethods({
+     *   cartItems: cartItems
+     * });
+     * ```
      */
     async getMethods(options) {
-      return fetcher.request(
-        "/api/storefront/v1/shipment-methods",
-        {
-          method: "GET",
-          ...options
-        }
-      );
+      const params = new URLSearchParams();
+      if (options?.cartItems?.length) {
+        const cartWeight = calculateCartWeight(options.cartItems);
+        params.set("cartWeight", cartWeight.toString());
+      }
+      const queryString = params.toString();
+      const url = `/api/storefront/v1/shipment-methods${queryString ? `?${queryString}` : ""}`;
+      return fetcher.request(url, {
+        method: "GET",
+        ...options
+      });
     },
     /**
      * Get shipment methods with pickup locations for a specific postal code.
      * Calls the Shipit API to fetch nearby pickup points (parcel lockers, etc.)
      *
      * @param postalCode - Customer's postal code (e.g., "00100")
-     * @param options - Fetch options (caching, headers, etc.)
+     * @param options - Fetch options including optional cartItems for weight-based filtering
      * @returns Shipment methods and nearby pickup locations with pricing
      *
      * @example
@@ -659,23 +677,28 @@ function createShippingResource(fetcher) {
      * });
      * ```
      *
-     * @example Filter by carrier
+     * @example Weight-based filtering with postal code
      * ```typescript
-     * const { pricedLocations } = await client.shipping.getWithLocations("00100");
-     *
-     * const postiLocations = pricedLocations.filter(
-     *   loc => loc.carrier === "Posti"
+     * const { shipmentMethods, pricedLocations } = await client.shipping.getWithLocations(
+     *   "00100",
+     *   { cartItems: cartItems }
      * );
+     *
+     * // Only shows methods that support the cart's total weight
      * ```
      */
     async getWithLocations(postalCode, options) {
-      return fetcher.request(
-        `/api/storefront/v1/shipment-methods/${encodeURIComponent(postalCode)}`,
-        {
-          method: "GET",
-          ...options
-        }
-      );
+      const params = new URLSearchParams();
+      if (options?.cartItems?.length) {
+        const cartWeight = calculateCartWeight(options.cartItems);
+        params.set("cartWeight", cartWeight.toString());
+      }
+      const queryString = params.toString();
+      const url = `/api/storefront/v1/shipment-methods/${encodeURIComponent(postalCode)}${queryString ? `?${queryString}` : ""}`;
+      return fetcher.request(url, {
+        method: "GET",
+        ...options
+      });
     }
   };
 }
@@ -1448,9 +1471,6 @@ function getPriceInfo(product, variation) {
 
 // src/utils/cart-calculations.ts
 function calculateCartWithCampaigns(items, campaigns) {
-  const freeShippingCampaign = campaigns.find(
-    (c) => c.type === "FREE_SHIPPING" && c.isActive
-  );
   const buyXPayYCampaign = campaigns.find(
     (c) => c.type === "BUY_X_PAY_Y" && c.isActive
   );
@@ -1458,6 +1478,11 @@ function calculateCartWithCampaigns(items, campaigns) {
     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,
@@ -1465,16 +1490,12 @@ function calculateCartWithCampaigns(items, campaigns) {
       freeQuantity: 0,
       totalQuantity: item.cartQuantity
     }));
-    const freeShipping2 = calculateFreeShipping(
-      originalTotal,
-      freeShippingCampaign
-    );
     return {
       calculatedItems: calculatedItems2,
       cartTotal: originalTotal,
       originalTotal,
       totalSavings: 0,
-      freeShipping: freeShipping2
+      freeShipping
     };
   }
   const { buyQuantity, payQuantity, applicableCategories } = buyXPayYCampaign.BuyXPayYCampaign;
@@ -1505,16 +1526,12 @@ function calculateCartWithCampaigns(items, campaigns) {
       freeQuantity: 0,
       totalQuantity: item.cartQuantity
     }));
-    const freeShipping2 = calculateFreeShipping(
-      originalTotal,
-      freeShippingCampaign
-    );
     return {
       calculatedItems: calculatedItems2,
       cartTotal: originalTotal,
       originalTotal,
       totalSavings: 0,
-      freeShipping: freeShipping2
+      freeShipping
     };
   }
   eligibleUnits.sort((a, b) => a.price - b.price);
@@ -1541,7 +1558,6 @@ function calculateCartWithCampaigns(items, campaigns) {
     };
   });
   const cartTotal = originalTotal - totalSavings;
-  const freeShipping = calculateFreeShipping(cartTotal, freeShippingCampaign);
   return {
     calculatedItems,
     cartTotal,
@@ -1550,28 +1566,6 @@ function calculateCartWithCampaigns(items, campaigns) {
     freeShipping
   };
 }
-function calculateFreeShipping(cartTotal, campaign) {
-  if (!campaign?.FreeShippingCampaign) {
-    return {
-      isEligible: false,
-      minimumSpend: 0,
-      remainingAmount: 0
-    };
-  }
-  const minimumSpend = campaign.FreeShippingCampaign.minimumSpend;
-  const isEligible = cartTotal >= minimumSpend;
-  const remainingAmount = isEligible ? 0 : minimumSpend - cartTotal;
-  const eligibleShipmentMethodIds = campaign.FreeShippingCampaign.shipmentMethods?.map(
-    (method) => method.id
-  );
-  return {
-    isEligible,
-    minimumSpend,
-    remainingAmount,
-    campaignName: campaign.name,
-    eligibleShipmentMethodIds
-  };
-}
 export {
   AuthError,
   NotFoundError,