@putiikkipalvelu/storefront-sdk 0.2.1 → 0.2.3

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
+      });
     }
   };
 }
@@ -688,11 +711,12 @@ function createCustomerResource(fetcher) {
   return {
     /**
      * Register a new customer account.
-     * After registration, the customer must verify their email before logging in.
+     * A verification email is sent automatically by the server.
+     * The customer must verify their email before logging in.
      *
      * @param data - Registration data (firstName, lastName, email, password)
      * @param fetchOptions - Fetch options
-     * @returns Created customer with verification token
+     * @returns Created customer data and success message
      *
      * @example
      * ```typescript
@@ -703,7 +727,7 @@ function createCustomerResource(fetcher) {
      *   password: 'securePassword123'
      * });
      *
-     * // Send verification email using customer.emailVerificationToken
+     * // Verification email is sent automatically by the server
      * console.log('Account created:', message);
      * ```
      */
@@ -851,21 +875,21 @@ function createCustomerResource(fetcher) {
       );
     },
     /**
-     * Resend the email verification token for an unverified customer.
-     * Generates a new token valid for 24 hours.
+     * Resend the verification email for an unverified customer.
+     * A new verification email is sent automatically by the server.
      *
      * @param customerId - The customer's ID (from failed login response)
      * @param fetchOptions - Fetch options
-     * @returns Updated customer with new verification token
+     * @returns Success message
      * @throws ValidationError if customer is already verified or not found
      *
      * @example
      * ```typescript
      * // After login fails with requiresVerification
-     * const { customer } = await client.customer.resendVerification(customerId);
+     * const { message } = await client.customer.resendVerification(customerId);
      *
-     * // Send new verification email using customer.emailVerificationToken
-     * await sendVerificationEmail(customer.email, customer.emailVerificationToken);
+     * // Verification email is sent automatically by the server
+     * console.log(message); // "Verification email sent."
      * ```
      */
     async resendVerification(customerId, fetchOptions) {
@@ -878,6 +902,77 @@ function createCustomerResource(fetcher) {
         }
       );
     },
+    /**
+     * Request a password reset for a customer account.
+     * The server sends a password reset email directly to the customer.
+     * Returns success even if email doesn't exist (to prevent email enumeration).
+     *
+     * Note: The reset token is never exposed to the client for security.
+     * The email is sent server-side with the reset link.
+     *
+     * @param email - Customer's email address
+     * @param fetchOptions - Fetch options
+     * @returns Generic success message (same whether email exists or not)
+     *
+     * @example
+     * ```typescript
+     * const response = await client.customer.forgotPassword('john@example.com');
+     *
+     * // Always show same message to user (email sent server-side)
+     * console.log(response.message);
+     * // "If an account exists with that email, password reset instructions have been sent."
+     * ```
+     */
+    async forgotPassword(email, fetchOptions) {
+      return fetcher.request(
+        "/api/storefront/v1/customer/(auth)/forgot-password",
+        {
+          method: "POST",
+          body: { email },
+          ...fetchOptions
+        }
+      );
+    },
+    /**
+     * Reset a customer's password using a valid reset token.
+     * The token is sent via email by the forgotPassword endpoint.
+     * After successful reset, all existing sessions are invalidated.
+     *
+     * @param token - Password reset token (from email link)
+     * @param password - New password (minimum 8 characters)
+     * @param fetchOptions - Fetch options
+     * @returns Success confirmation
+     * @throws ValidationError if token is invalid or expired
+     *
+     * @example
+     * ```typescript
+     * // Token comes from the reset email link
+     * const token = searchParams.get('token');
+     *
+     * try {
+     *   const { message } = await client.customer.resetPassword(token, newPassword);
+     *   console.log(message); // "Password reset successful..."
+     *
+     *   // Redirect to login page
+     *   redirect('/login?reset=success');
+     * } catch (error) {
+     *   if (error instanceof ValidationError) {
+     *     // Token invalid or expired
+     *     console.error('Please request a new password reset');
+     *   }
+     * }
+     * ```
+     */
+    async resetPassword(token, password, fetchOptions) {
+      return fetcher.request(
+        "/api/storefront/v1/customer/(auth)/reset-password",
+        {
+          method: "POST",
+          body: { token, password },
+          ...fetchOptions
+        }
+      );
+    },
     // =========================================================================
     // Profile Management Methods
     // =========================================================================