@putiikkipalvelu/storefront-sdk 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -573,42 +573,42 @@ interface PickupLocationOpeningHours {
  * Returned from Shipit API with merchant pricing added
  */
 interface PickupLocation {
-    /** Unique location ID */
+    /** Unique location ID from Shipit */
     id: string;
+    /** Shipit service ID */
+    serviceId: string;
     /** Location name */
     name: string;
     /** Street address */
     address1: string;
-    /** Postal code */
-    zipcode: string;
     /** City */
     city: string;
+    /** Postal code */
+    zipcode: string;
     /** Country code (e.g., "FI") */
     countryCode: string;
-    /** Shipit service ID */
-    serviceId: string;
-    /** Carrier name */
+    /** Carrier name (e.g., "Posti", "Matkahuolto") */
     carrier: string;
-    /** Shipit price in cents (may be null) */
-    price: number | null;
-    /** Merchant's price in cents (from store settings) */
-    merchantPrice: number | null;
     /** Carrier logo URL */
     carrierLogo: string;
-    /** Structured opening hours */
-    openingHours: PickupLocationOpeningHours | null;
-    /** Raw opening hours string */
-    openingHoursRaw: string | null;
     /** GPS latitude */
-    latitude: number;
+    latitude?: number;
     /** GPS longitude */
-    longitude: number;
+    longitude?: number;
     /** Distance from postal code in meters */
     distanceInMeters: number;
     /** Distance from postal code in kilometers */
     distanceInKilometers: number;
+    /** Location type */
+    type?: string;
+    /** Structured opening hours */
+    openingHours?: PickupLocationOpeningHours | null;
+    /** Raw opening hours string from Shipit */
+    openingHoursRaw?: string | null;
     /** Additional metadata */
-    metadata: unknown | null;
+    metadata?: unknown | null;
+    /** Merchant's price in cents (from store settings) */
+    merchantPrice: number | null;
 }
 /**
  * Response from GET /shipment-methods
@@ -629,15 +629,49 @@ interface ShipmentMethodsWithLocationsResponse {
 }
 
 /**
- * Customer Types
+ * Order Types
  *
- * Types for customer authentication and account management API endpoints.
+ * Types for fetching order details from the Storefront API.
+ * These types represent the raw order data returned by GET /order/{id}.
+ *
+ * Note: These differ from CustomerOrder types in customer.ts which are
+ * transformed for customer order history display.
  */
 /**
- * Basic customer information returned from most customer endpoints
+ * Item type for order line items
  */
-interface Customer {
-    /** Unique customer ID */
+type ConfirmationItemType = "PRODUCT" | "VARIATION" | "SHIPPING";
+/**
+ * A single line item in an order confirmation
+ * Represents raw data as stored in the database
+ */
+interface ConfirmationOrderLineItem {
+    /** Unique line item ID */
+    id: string;
+    /** Parent order ID */
+    orderId: string;
+    /** Type of item: PRODUCT, VARIATION, or SHIPPING */
+    itemType: ConfirmationItemType;
+    /** Quantity ordered */
+    quantity: number;
+    /** Price per unit in cents */
+    price: number;
+    /** Total amount in cents (price * quantity) */
+    totalAmount: number;
+    /** Product or variation code (ID reference) */
+    productCode: string;
+    /** Display name of the item */
+    name: string;
+    /** VAT rate percentage */
+    vatRate: number;
+    /** Product images array */
+    images: string[];
+}
+/**
+ * Customer delivery information attached to an order
+ */
+interface ConfirmationOrderCustomerData {
+    /** Customer data record ID */
     id: string;
     /** Customer's first name */
     firstName: string;
@@ -645,26 +679,97 @@ interface Customer {
     lastName: string;
     /** Customer's email address */
     email: string;
+    /** Customer's phone number */
+    phone: string | null;
+    /** Delivery street address */
+    address: string;
+    /** Delivery city */
+    city: string;
+    /** Delivery postal code */
+    postalCode: string;
 }
 /**
- * Extended customer information returned after registration
+ * Shipment method information attached to an order
+ * Includes tracking information when available
  */
-interface CustomerWithVerification extends Customer {
-    /** Account creation timestamp */
-    createdAt: string;
-    /** Email verification token (for sending verification emails) */
-    emailVerificationToken: string;
-    /** Token expiration timestamp */
-    emailVerificationExpiresAt: string;
+interface ConfirmationOrderShipmentMethod {
+    /** Shipment method record ID */
+    id: string;
+    /** Carrier service ID (for Shipit integration) */
+    serviceId: string | null;
+    /** Shipment method display name */
+    name: string;
+    /** Description of the shipment method */
+    description: string | null;
+    /** Carrier logo URL */
+    logo: string | null;
+    /** Shipping price in cents */
+    price: number;
+    /** Parent order ID */
+    orderId: string;
+    /** VAT rate percentage */
+    vatRate: number | null;
+    /** Tracking number (when shipped) */
+    trackingNumber: string | null;
+    /** Array of tracking URLs */
+    trackingUrls: string[];
+    /** Shipit shipment number */
+    shipmentNumber: string | null;
+    /** Freight document URLs */
+    freightDoc: string[];
 }
 /**
- * Customer information returned after login
+ * Order status values (matches Prisma OrderStatus enum)
+ */
+type OrderStatus = "PENDING" | "COMPLETED" | "CANCELLED" | "FAILED" | "PAID" | "SHIPPED" | "PARTIALLY_REFUNDED" | "REFUNDED";
+/**
+ * Complete order information returned by GET /order/{id}
+ * Used for order confirmation pages and order detail views
  */
-interface CustomerWithEmailStatus extends Customer {
-    /** Email verification timestamp (null if not verified) */
-    emailVerified: string | null;
-    /** Account creation timestamp */
+interface Order {
+    /** Unique order ID */
+    id: string;
+    /** Store ID this order belongs to */
+    storeId: string;
+    /** Order creation timestamp */
     createdAt: string;
+    /** Total order amount in cents */
+    totalAmount: number;
+    /** Current order status */
+    status: OrderStatus;
+    /** Human-readable order number */
+    orderNumber: number;
+    /** Order line items (products, variations, shipping) */
+    OrderLineItems: ConfirmationOrderLineItem[];
+    /** Customer delivery information */
+    orderCustomerData: ConfirmationOrderCustomerData | null;
+    /** Shipment method with tracking info */
+    orderShipmentMethod: ConfirmationOrderShipmentMethod | null;
+}
+
+/**
+ * Customer Types
+ *
+ * Types for customer authentication and account management API endpoints.
+ */
+
+/**
+ * Customer information returned from API endpoints.
+ * Some fields are optional depending on which endpoint is called.
+ */
+interface Customer {
+    /** Unique customer ID */
+    id: string;
+    /** Customer's first name */
+    firstName: string;
+    /** Customer's last name */
+    lastName: string;
+    /** Customer's email address */
+    email: string;
+    /** Account creation timestamp (included in register, login, edit responses) */
+    createdAt?: string;
+    /** Email verification timestamp - null if not verified (only in login response) */
+    emailVerified?: string | null;
 }
 /**
  * Data required to register a new customer account
@@ -687,13 +792,14 @@ interface LoginOptions {
     cartId?: string;
 }
 /**
- * Response from successful registration
+ * Response from successful registration.
+ * Note: Verification email is sent server-side automatically.
  */
 interface RegisterResponse {
     /** Whether the operation was successful */
     success: true;
-    /** Created customer with verification token */
-    customer: CustomerWithVerification;
+    /** Created customer (verification email sent automatically) */
+    customer: Customer;
     /** Success message */
     message: string;
 }
@@ -703,8 +809,8 @@ interface RegisterResponse {
 interface LoginResponse {
     /** Whether the operation was successful */
     success: true;
-    /** Authenticated customer data */
-    customer: CustomerWithEmailStatus;
+    /** Authenticated customer data (includes emailVerified and createdAt) */
+    customer: Customer;
     /** Success message */
     message: string;
     /** Session token for authenticated requests */
@@ -753,13 +859,12 @@ interface VerifyEmailResponse {
     message: string;
 }
 /**
- * Response from resend verification email
+ * Response from resend verification email.
+ * Note: Verification email is sent server-side automatically.
  */
 interface ResendVerificationResponse {
     /** Whether the operation was successful */
     success: true;
-    /** Updated customer with new verification token */
-    customer: CustomerWithVerification;
     /** Success message */
     message: string;
 }
@@ -774,13 +879,6 @@ interface UpdateProfileData {
     /** Updated email address */
     email?: string;
 }
-/**
- * Extended customer info returned after profile update
- */
-interface CustomerWithCreatedAt extends Customer {
-    /** Account creation timestamp */
-    createdAt: string;
-}
 /**
  * Response from updating profile
  */
@@ -788,7 +886,7 @@ interface UpdateProfileResponse {
     /** Success message */
     message: string;
     /** Updated customer data */
-    customer: CustomerWithCreatedAt;
+    customer: Customer;
 }
 /**
  * Response from deleting account
@@ -856,10 +954,7 @@ interface OrderShipmentMethod {
     /** Carrier logo URL */
     logo: string | null;
 }
-/**
- * Order status values
- */
-type OrderStatus = "PENDING" | "PROCESSING" | "SHIPPED" | "DELIVERED" | "CANCELLED" | "REFUNDED";
+
 /**
  * A customer order
  */
@@ -994,124 +1089,25 @@ interface RemoveFromWishlistResponse {
     /** Success message */
     message: string;
 }
-
-/**
- * Order Types
- *
- * Types for fetching order details from the Storefront API.
- * These types represent the raw order data returned by GET /order/{id}.
- *
- * Note: These differ from CustomerOrder types in customer.ts which are
- * transformed for customer order history display.
- */
-/**
- * Item type for order line items
- */
-type ConfirmationItemType = "PRODUCT" | "VARIATION" | "SHIPPING";
-/**
- * A single line item in an order confirmation
- * Represents raw data as stored in the database
- */
-interface ConfirmationOrderLineItem {
-    /** Unique line item ID */
-    id: string;
-    /** Parent order ID */
-    orderId: string;
-    /** Type of item: PRODUCT, VARIATION, or SHIPPING */
-    itemType: ConfirmationItemType;
-    /** Quantity ordered */
-    quantity: number;
-    /** Price per unit in cents */
-    price: number;
-    /** Total amount in cents (price * quantity) */
-    totalAmount: number;
-    /** Product or variation code (ID reference) */
-    productCode: string;
-    /** Display name of the item */
-    name: string;
-    /** VAT rate percentage */
-    vatRate: number;
-    /** Product images array */
-    images: string[];
-}
 /**
- * Customer delivery information attached to an order
+ * Response from forgot password request.
+ * Always returns same response to prevent email enumeration.
+ * Email with reset link is sent server-side (token never exposed to client).
  */
-interface ConfirmationOrderCustomerData {
-    /** Customer data record ID */
-    id: string;
-    /** Customer's first name */
-    firstName: string;
-    /** Customer's last name */
-    lastName: string;
-    /** Customer's email address */
-    email: string;
-    /** Customer's phone number */
-    phone: string | null;
-    /** Delivery street address */
-    address: string;
-    /** Delivery city */
-    city: string;
-    /** Delivery postal code */
-    postalCode: string;
-}
-/**
- * Shipment method information attached to an order
- * Includes tracking information when available
- */
-interface ConfirmationOrderShipmentMethod {
-    /** Shipment method record ID */
-    id: string;
-    /** Carrier service ID (for Shipit integration) */
-    serviceId: string | null;
-    /** Shipment method display name */
-    name: string;
-    /** Description of the shipment method */
-    description: string | null;
-    /** Carrier logo URL */
-    logo: string | null;
-    /** Shipping price in cents */
-    price: number;
-    /** Parent order ID */
-    orderId: string;
-    /** VAT rate percentage */
-    vatRate: number | null;
-    /** Tracking number (when shipped) */
-    trackingNumber: string | null;
-    /** Array of tracking URLs */
-    trackingUrls: string[];
-    /** Shipit shipment number */
-    shipmentNumber: string | null;
-    /** Freight document URLs */
-    freightDoc: string[];
+interface ForgotPasswordResponse {
+    /** Whether the operation was successful */
+    success: true;
+    /** Success message (same regardless of whether email exists) */
+    message: string;
 }
 /**
- * Order status values
- */
-type ConfirmationOrderStatus = "PENDING" | "PAID" | "SHIPPED" | "DELIVERED" | "CANCELLED" | "REFUNDED";
-/**
- * Complete order information returned by GET /order/{id}
- * Used for order confirmation pages and order detail views
+ * Response from successful password reset
  */
-interface Order {
-    /** Unique order ID */
-    id: string;
-    /** Store ID this order belongs to */
-    storeId: string;
-    /** Order creation timestamp */
-    createdAt: string;
-    /** Total order amount in cents */
-    totalAmount: number;
-    /** Current order status */
-    status: ConfirmationOrderStatus;
-    /** Human-readable order number */
-    orderNumber: number;
-    /** Order line items (products, variations, shipping) */
-    OrderLineItems: ConfirmationOrderLineItem[];
-    /** Customer delivery information */
-    orderCustomerData: ConfirmationOrderCustomerData | null;
-    /** Shipment method with tracking info */
-    orderShipmentMethod: ConfirmationOrderShipmentMethod | null;
+interface ResetPasswordResponse {
+    /** Whether the operation was successful */
+    success: true;
+    /** Success message */
+    message: string;
 }
 
 /**
@@ -1774,11 +1770,12 @@ type ShippingResource = ReturnType<typeof createShippingResource>;
 declare function createCustomerResource(fetcher: Fetcher): {
     /**
      * 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
@@ -1789,7 +1786,7 @@ declare function createCustomerResource(fetcher: Fetcher): {
      *   password: 'securePassword123'
      * });
      *
-     * // Send verification email using customer.emailVerificationToken
+     * // Verification email is sent automatically by the server
      * console.log('Account created:', message);
      * ```
      */
@@ -1887,24 +1884,77 @@ declare function createCustomerResource(fetcher: Fetcher): {
      */
     verifyEmail(token: string, fetchOptions?: FetchOptions): Promise<VerifyEmailResponse>;
     /**
-     * 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."
      * ```
      */
     resendVerification(customerId: string, fetchOptions?: FetchOptions): Promise<ResendVerificationResponse>;
+    /**
+     * 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."
+     * ```
+     */
+    forgotPassword(email: string, fetchOptions?: FetchOptions): Promise<ForgotPasswordResponse>;
+    /**
+     * 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');
+     *   }
+     * }
+     * ```
+     */
+    resetPassword(token: string, password: string, fetchOptions?: FetchOptions): Promise<ResetPasswordResponse>;
     /**
      * Update the authenticated customer's profile.
      *
@@ -2250,10 +2300,6 @@ type CheckoutResource = ReturnType<typeof createCheckoutResource>;
  * The Storefront API client
  */
 interface StorefrontClient {
-    /**
-     * The configured API key (masked for security)
-     */
-    readonly apiKey: string;
     /**
      * The base URL for API requests
      */
@@ -2410,5 +2456,14 @@ declare class NotFoundError extends StorefrontError {
 declare class ValidationError extends StorefrontError {
     constructor(message?: string);
 }
+/**
+ * Error thrown when login fails due to unverified email
+ * Contains customerId for resending verification email
+ */
+declare class VerificationRequiredError extends StorefrontError {
+    readonly requiresVerification: true;
+    readonly customerId: string;
+    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 ConfirmationOrderStatus, type Customer, type CustomerOrder, type CustomerWithCreatedAt, type CustomerWithEmailStatus, type CustomerWithVerification, type DeleteAccountResponse, type FeatureFlags, type FetchOptions, 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 PickupLocationOpeningHours, 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 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, 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 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 };