@putiikkipalvelu/storefront-sdk 0.7.3 → 0.8.0

package/dist/index.d.ts

@@ -345,6 +345,8 @@ interface Product {
     saleStartDate: string | null;
     /** Sale end date (ISO 8601), null = no end */
     saleEndDate: string | null;
+    /** True if this product is delivered as a digital download (no shipping) */
+    isDigital?: boolean;
     /** Product variations (minimal fields for listing) */
     variations: ProductVariationListing[];
 }
@@ -362,6 +364,10 @@ interface ProductTicketInfo {
     requiresHolder: boolean;
     /** Maximum uses per ticket (0 = unlimited) */
     maxUses: number;
+    /** Ticket sales start (ISO 8601), null = sales open immediately */
+    salesStart: string | null;
+    /** Ticket sales end (ISO 8601), null = sales never end */
+    salesEnd: string | null;
 }
 interface ProductDetail extends Omit<Product, "variations"> {
     /** Product weight in kg (for shipping calculations) */
@@ -378,6 +384,11 @@ interface ProductDetail extends Omit<Product, "variations"> {
     variations: ProductVariation[];
     /** Ticket info (present if product is a ticket, null otherwise) */
     ticketInfo: ProductTicketInfo | null;
+    /**
+     * HTML instructions shown to the buyer after a digital purchase.
+     * Only populated when isDigital=true; null otherwise.
+     */
+    digitalContent?: string | null;
 }
 /**
  * Response from /sorted-products
@@ -472,6 +483,8 @@ interface CartItem {
     variation?: ProductVariation;
     /** Whether this item is a ticket product (no shipping required) */
     isTicket?: boolean;
+    /** Whether this item is a digital product (no shipping required) */
+    isDigital?: boolean;
 }
 /**
  * Response from GET /cart, POST /cart, PATCH /cart, DELETE /cart
@@ -496,6 +509,8 @@ interface CartValidationChanges {
     quantityAdjusted: number;
     /** Number of items with changed price */
     priceChanged: number;
+    /** Number of ticket items removed because sales window is not open or has ended */
+    ticketSalesWindowRemoved: number;
     /** Whether discount code was removed */
     discountCouponRemoved: boolean;
     /** Reason why discount was removed (only present if discountCouponRemoved is true) */
@@ -737,6 +752,11 @@ interface ConfirmationOrderLineItem {
     vatRate: number;
     /** Product images array */
     images: string[];
+    /**
+     * Snapshot of the product's digital instructions at purchase time.
+     * Populated for digital products; null otherwise.
+     */
+    digitalContent?: string | null;
 }
 /**
  * Customer delivery information attached to an order
@@ -1698,6 +1718,80 @@ interface TicketUseResponse {
     ticket: PurchasedTicket;
 }
 
+/**
+ * Digital Downloads Types
+ *
+ * Types for digital product downloads (instructions + downloadable files).
+ */
+/**
+ * A single downloadable file within an order line item.
+ * Snapshotted at purchase time — persists even if the merchant deletes the
+ * original product or file.
+ */
+interface OrderDownload {
+    /** Unique download record ID (pass this to getDownloadUrl) */
+    id: string;
+    /** Merchant-editable file name shown to the customer */
+    displayName: string;
+    /** File size in bytes */
+    sizeBytes: number;
+    /** MIME type, e.g. "application/pdf" */
+    mimeType: string;
+    /** How many times this file has been downloaded on this order */
+    downloadCount: number;
+    /** Max downloads allowed on this order (null = unlimited) */
+    maxDownloads: number | null;
+    /** Downloads remaining (null = unlimited) */
+    remaining: number | null;
+}
+/**
+ * A line item in an order with digital content and/or downloadable files.
+ * Only line items that either have instructions or files are returned by
+ * the downloads list endpoint.
+ */
+interface OrderDownloadLineItem {
+    /** Order line item ID */
+    id: string;
+    /** Product/variation display name */
+    name: string;
+    /** Quantity ordered */
+    quantity: number;
+    /** Sanitized HTML instructions (from merchant's TipTap field). May be null. */
+    digitalContent: string | null;
+    /** Downloadable files attached to this line item. May be empty. */
+    downloads: OrderDownload[];
+}
+/**
+ * Response from GET /order/:id/downloads
+ */
+interface OrderDownloadsResponse {
+    /** Order ID the downloads belong to */
+    orderId: string;
+    /** Line items with digital content and/or downloads */
+    items: OrderDownloadLineItem[];
+}
+/**
+ * Response from POST /order/:id/downloads/:downloadId
+ * Short-lived presigned URL for downloading the file directly from R2.
+ */
+interface DownloadUrlResponse {
+    /** Presigned download URL (typically valid ~5 minutes) */
+    url: string;
+    /** How long the URL stays valid, in seconds */
+    expiresIn: number;
+}
+/**
+ * Options for calling the downloads endpoints.
+ * Authentication is granted via EITHER a token (from order confirmation email)
+ * OR a valid customer session (logged-in customer who owns the order).
+ */
+interface DownloadsAuthOptions {
+    /** Download token from the confirmation email URL. Use this for guest access. */
+    token?: string;
+    /** Customer session token. Use this for logged-in customer access. */
+    sessionId?: string;
+}
+
 /**
  * Putiikkipalvelu Storefront SDK Types
  *
@@ -2567,7 +2661,7 @@ declare function createCustomerResource(fetcher: Fetcher): {
 type CustomerResource = ReturnType<typeof createCustomerResource>;
 
 /**
- * Order resource for fetching order details
+ * Order resource for fetching order details and digital downloads
  *
  * Used for order confirmation pages and viewing order details.
  * For customer order history, use the customer.getOrders() method instead.
@@ -2590,36 +2684,54 @@ declare function createOrderResource(fetcher: Fetcher): {
      * console.log(`Order #${order.orderNumber} - ${order.status}`);
      * console.log(`Total: ${order.totalAmount / 100} EUR`);
      * ```
+     */
+    get(orderId: string, options?: FetchOptions): Promise<Order>;
+    /**
+     * List downloadable files for a paid order.
      *
-     * @example Next.js - with caching
+     * Requires EITHER a download token (from the order confirmation email)
+     * OR a valid customer session (for logged-in customers viewing their own
+     * order history).
+     *
+     * Returns only line items that have digital content or downloadable files.
+     * The order must be paid (status !== PENDING or FAILED).
+     *
+     * @param orderId - The order ID
+     * @param auth - Token (guest) or sessionId (logged-in customer)
+     * @param options - Fetch options
+     *
+     * @example Guest access via email token
      * ```typescript
-     * const order = await client.order.get(orderId, {
-     *   next: { revalidate: 60, tags: ['order', orderId] }
-     * });
+     * const token = new URLSearchParams(location.search).get("token");
+     * const { items } = await client.order.listDownloads(orderId, { token });
      * ```
      *
-     * @example Display line items
+     * @example Logged-in customer
      * ```typescript
-     * const order = await client.order.get(orderId);
-     * order.OrderLineItems.forEach(item => {
-     *   if (item.itemType !== 'SHIPPING') {
-     *     console.log(`${item.name} x${item.quantity} = ${item.totalAmount / 100} EUR`);
-     *   }
-     * });
+     * const { items } = await client.order.listDownloads(orderId, { sessionId });
      * ```
+     */
+    listDownloads(orderId: string, auth?: DownloadsAuthOptions, options?: FetchOptions): Promise<OrderDownloadsResponse>;
+    /**
+     * Issue a short-lived presigned URL to download a specific file from a
+     * paid order. Increments the download counter and records a download
+     * event (IP, user agent) on the server.
+     *
+     * The returned URL is typically valid for ~5 minutes — redirect the
+     * browser to it or trigger a download immediately.
+     *
+     * @param orderId - The order ID
+     * @param downloadId - The OrderDownload.id
+     * @param auth - Token (guest) or sessionId (logged-in customer)
+     * @param options - Fetch options
      *
-     * @example Show tracking info
+     * @example
      * ```typescript
-     * const order = await client.order.get(orderId);
-     * if (order.orderShipmentMethod?.trackingNumber) {
-     *   console.log(`Tracking: ${order.orderShipmentMethod.trackingNumber}`);
-     *   order.orderShipmentMethod.trackingUrls?.forEach(url => {
-     *     console.log(`Track at: ${url}`);
-     *   });
-     * }
+     * const { url } = await client.order.getDownloadUrl(orderId, downloadId, { token });
+     * window.location.href = url;
      * ```
      */
-    get(orderId: string, options?: FetchOptions): Promise<Order>;
+    getDownloadUrl(orderId: string, downloadId: string, auth?: DownloadsAuthOptions, options?: FetchOptions): Promise<DownloadUrlResponse>;
 };
 /**
  * Type for the order resource
@@ -3224,4 +3336,4 @@ declare class VerificationRequiredError extends StorefrontError {
     constructor(message: string, customerId: string);
 }
 
-export { type AboutBlock, type AccordionBlock, type AccordionItem, type AddToCartParams, type AddToWishlistResponse, type AnalyticsConfig, type AppliedDiscount, type ApplyDiscountParams, type ApplyDiscountResponse, AuthError, type BuyXPayYCampaign, type CalculatedCartItem, type Campaign, type CampaignType, type CarouselContentBlock, type CarouselContentItem, 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 DiscountApplyErrorCode, type DiscountCodeError, type DiscountMessageLocale, type DiscountRemovalReason, type DiscountType, type FeatureFlags, type FetchOptions, type ForgotPasswordResponse, type FormatDiscountOptions, type GalleryBlock, type GalleryItem, type GetDiscountParams, type GetDiscountResponse, type GetOrdersResponse, type GetUserResponse, type HomeDeliveryOption, type ImageAspectRatio, type ImageGridBlock, type ImageGridItem, type LoginOptions, type LoginResponse, type LoginVerificationRequiredResponse, type LogoutResponse, type MarkdownBlock, type NavPage, NotFoundError, type OpeningHours, type OpeningHoursBlock, type OpeningHoursEntry, type Order, type OrderLineItem, type OrderProductInfo, type OrderShipmentMethod, type OrderStatus, type PageBlock, type PageSeo, type PaymentConfig, type PaytrailCheckoutResponse, type PaytrailGroup, type PaytrailProvider, type PickupPointOption, type PriceInfo, type Product, type ProductCountResponse, type ProductDetail, type ProductListParams, type ProductListResponse, type ProductSortOption, type ProductTicketInfo, type ProductVariation, type ProductVariationListing, type PurchasedTicket, RateLimitError, type RegisterData, type RegisterResponse, type RemoveDiscountParams, type RemoveDiscountResponse, type RemoveFromCartParams, type RemoveFromWishlistResponse, type ResendVerificationResponse, type ResetPasswordResponse, type ShipitShippingMethod, type ShipmentMethod, type ShipmentMethodsResponse, type ShowcaseBlock, type ShowcaseItem, type StoreConfig, type StoreInfo, type StorePage, type StoreSeo, type StorefrontClient, type StorefrontClientConfig, StorefrontError, type StripeCheckoutResponse, type TableBlock, type TextGridBlock, type TextGridItem, type TicketEvent, type TicketEventsResponse, type TicketGetResponse, type TicketHolderData, type TicketStatus, type TicketUseResponse, type TicketValidatePinResponse, type UpdateCartQuantityParams, type UpdateProfileData, type UpdateProfileResponse, ValidationError, type VariationOption, VerificationRequiredError, type VerifyEmailResponse, type WishlistItem, type WishlistProduct, type WishlistResponse, type WishlistVariation, type WishlistVariationOption, calculateCartWithCampaigns, calculateDiscountAmount, createStorefrontClient, formatDiscountValue, getDiscountApplyErrorMessage, getDiscountRemovalMessage, getPriceInfo, isSaleActive };
+export { type AboutBlock, type AccordionBlock, type AccordionItem, type AddToCartParams, type AddToWishlistResponse, type AnalyticsConfig, type AppliedDiscount, type ApplyDiscountParams, type ApplyDiscountResponse, AuthError, type BuyXPayYCampaign, type CalculatedCartItem, type Campaign, type CampaignType, type CarouselContentBlock, type CarouselContentItem, 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 DiscountApplyErrorCode, type DiscountCodeError, type DiscountMessageLocale, type DiscountRemovalReason, type DiscountType, type DownloadUrlResponse, type DownloadsAuthOptions, type FeatureFlags, type FetchOptions, type ForgotPasswordResponse, type FormatDiscountOptions, type GalleryBlock, type GalleryItem, type GetDiscountParams, type GetDiscountResponse, type GetOrdersResponse, type GetUserResponse, type HomeDeliveryOption, type ImageAspectRatio, type ImageGridBlock, type ImageGridItem, type LoginOptions, type LoginResponse, type LoginVerificationRequiredResponse, type LogoutResponse, type MarkdownBlock, type NavPage, NotFoundError, type OpeningHours, type OpeningHoursBlock, type OpeningHoursEntry, type Order, type OrderDownload, type OrderDownloadLineItem, type OrderDownloadsResponse, type OrderLineItem, type OrderProductInfo, type OrderShipmentMethod, type OrderStatus, type PageBlock, type PageSeo, type PaymentConfig, type PaytrailCheckoutResponse, type PaytrailGroup, type PaytrailProvider, type PickupPointOption, type PriceInfo, type Product, type ProductCountResponse, type ProductDetail, type ProductListParams, type ProductListResponse, type ProductSortOption, type ProductTicketInfo, type ProductVariation, type ProductVariationListing, type PurchasedTicket, RateLimitError, type RegisterData, type RegisterResponse, type RemoveDiscountParams, type RemoveDiscountResponse, type RemoveFromCartParams, type RemoveFromWishlistResponse, type ResendVerificationResponse, type ResetPasswordResponse, type ShipitShippingMethod, type ShipmentMethod, type ShipmentMethodsResponse, type ShowcaseBlock, type ShowcaseItem, type StoreConfig, type StoreInfo, type StorePage, type StoreSeo, type StorefrontClient, type StorefrontClientConfig, StorefrontError, type StripeCheckoutResponse, type TableBlock, type TextGridBlock, type TextGridItem, type TicketEvent, type TicketEventsResponse, type TicketGetResponse, type TicketHolderData, type TicketStatus, type TicketUseResponse, type TicketValidatePinResponse, type UpdateCartQuantityParams, type UpdateProfileData, type UpdateProfileResponse, ValidationError, type VariationOption, VerificationRequiredError, type VerifyEmailResponse, type WishlistItem, type WishlistProduct, type WishlistResponse, type WishlistVariation, type WishlistVariationOption, calculateCartWithCampaigns, calculateDiscountAmount, createStorefrontClient, formatDiscountValue, getDiscountApplyErrorMessage, getDiscountRemovalMessage, getPriceInfo, isSaleActive };

package/dist/index.js

@@ -847,7 +847,7 @@ function createCustomerResource(fetcher) {
      */
     async register(data, fetchOptions) {
       return fetcher.request(
-        "/api/storefront/v1/customer/(auth)/register",
+        "/api/storefront/v1/customer/register",
         {
           method: "POST",
           body: data,
@@ -894,7 +894,7 @@ function createCustomerResource(fetcher) {
         headers["x-cart-id"] = options.cartId;
       }
       return fetcher.request(
-        "/api/storefront/v1/customer/(auth)/login",
+        "/api/storefront/v1/customer/login",
         {
           method: "POST",
           body: { email, password },
@@ -926,7 +926,7 @@ function createCustomerResource(fetcher) {
      */
     async logout(sessionId, fetchOptions) {
       return fetcher.request(
-        "/api/storefront/v1/customer/(auth)/logout",
+        "/api/storefront/v1/customer/logout",
         {
           method: "POST",
           headers: buildSessionHeaders(sessionId),
@@ -953,7 +953,7 @@ function createCustomerResource(fetcher) {
      */
     async getUser(sessionId, fetchOptions) {
       return fetcher.request(
-        "/api/storefront/v1/customer/(auth)/get-user",
+        "/api/storefront/v1/customer/get-user",
         {
           method: "GET",
           headers: buildSessionHeaders(sessionId),
@@ -980,7 +980,7 @@ function createCustomerResource(fetcher) {
      */
     async verifyEmail(token, fetchOptions) {
       return fetcher.request(
-        "/api/storefront/v1/customer/(auth)/verify-email",
+        "/api/storefront/v1/customer/verify-email",
         {
           method: "GET",
           params: { token },
@@ -1008,7 +1008,7 @@ function createCustomerResource(fetcher) {
      */
     async resendVerification(customerId, fetchOptions) {
       return fetcher.request(
-        "/api/storefront/v1/customer/(auth)/resend-verification",
+        "/api/storefront/v1/customer/resend-verification",
         {
           method: "POST",
           body: { customerId },
@@ -1039,7 +1039,7 @@ function createCustomerResource(fetcher) {
      */
     async forgotPassword(email, fetchOptions) {
       return fetcher.request(
-        "/api/storefront/v1/customer/(auth)/forgot-password",
+        "/api/storefront/v1/customer/forgot-password",
         {
           method: "POST",
           body: { email },
@@ -1079,7 +1079,7 @@ function createCustomerResource(fetcher) {
      */
     async resetPassword(token, password, fetchOptions) {
       return fetcher.request(
-        "/api/storefront/v1/customer/(auth)/reset-password",
+        "/api/storefront/v1/customer/reset-password",
         {
           method: "POST",
           body: { token, password },
@@ -1296,6 +1296,11 @@ function createCustomerResource(fetcher) {
 }
 
 // src/resources/order.ts
+function buildDownloadAuthHeaders(auth) {
+  const headers = {};
+  if (auth?.sessionId) headers["x-session-id"] = auth.sessionId;
+  return headers;
+}
 function createOrderResource(fetcher) {
   return {
     /**
@@ -1315,40 +1320,87 @@ function createOrderResource(fetcher) {
      * console.log(`Order #${order.orderNumber} - ${order.status}`);
      * console.log(`Total: ${order.totalAmount / 100} EUR`);
      * ```
+     */
+    async get(orderId, options) {
+      return fetcher.request(
+        `/api/storefront/v1/order/${encodeURIComponent(orderId)}`,
+        {
+          ...options
+        }
+      );
+    },
+    /**
+     * List downloadable files for a paid order.
      *
-     * @example Next.js - with caching
+     * Requires EITHER a download token (from the order confirmation email)
+     * OR a valid customer session (for logged-in customers viewing their own
+     * order history).
+     *
+     * Returns only line items that have digital content or downloadable files.
+     * The order must be paid (status !== PENDING or FAILED).
+     *
+     * @param orderId - The order ID
+     * @param auth - Token (guest) or sessionId (logged-in customer)
+     * @param options - Fetch options
+     *
+     * @example Guest access via email token
      * ```typescript
-     * const order = await client.order.get(orderId, {
-     *   next: { revalidate: 60, tags: ['order', orderId] }
-     * });
+     * const token = new URLSearchParams(location.search).get("token");
+     * const { items } = await client.order.listDownloads(orderId, { token });
      * ```
      *
-     * @example Display line items
+     * @example Logged-in customer
      * ```typescript
-     * const order = await client.order.get(orderId);
-     * order.OrderLineItems.forEach(item => {
-     *   if (item.itemType !== 'SHIPPING') {
-     *     console.log(`${item.name} x${item.quantity} = ${item.totalAmount / 100} EUR`);
-     *   }
-     * });
+     * const { items } = await client.order.listDownloads(orderId, { sessionId });
      * ```
+     */
+    async listDownloads(orderId, auth, options) {
+      const { headers: extraHeaders, ...restOptions } = options ?? {};
+      return fetcher.request(
+        `/api/storefront/v1/order/${encodeURIComponent(orderId)}/downloads`,
+        {
+          ...restOptions,
+          params: auth?.token ? { token: auth.token } : void 0,
+          headers: {
+            ...buildDownloadAuthHeaders(auth),
+            ...extraHeaders ?? {}
+          }
+        }
+      );
+    },
+    /**
+     * Issue a short-lived presigned URL to download a specific file from a
+     * paid order. Increments the download counter and records a download
+     * event (IP, user agent) on the server.
+     *
+     * The returned URL is typically valid for ~5 minutes — redirect the
+     * browser to it or trigger a download immediately.
+     *
+     * @param orderId - The order ID
+     * @param downloadId - The OrderDownload.id
+     * @param auth - Token (guest) or sessionId (logged-in customer)
+     * @param options - Fetch options
      *
-     * @example Show tracking info
+     * @example
      * ```typescript
-     * const order = await client.order.get(orderId);
-     * if (order.orderShipmentMethod?.trackingNumber) {
-     *   console.log(`Tracking: ${order.orderShipmentMethod.trackingNumber}`);
-     *   order.orderShipmentMethod.trackingUrls?.forEach(url => {
-     *     console.log(`Track at: ${url}`);
-     *   });
-     * }
+     * const { url } = await client.order.getDownloadUrl(orderId, downloadId, { token });
+     * window.location.href = url;
      * ```
      */
-    async get(orderId, options) {
+    async getDownloadUrl(orderId, downloadId, auth, options) {
+      const { headers: extraHeaders, ...restOptions } = options ?? {};
       return fetcher.request(
-        `/api/storefront/v1/order/${encodeURIComponent(orderId)}`,
+        `/api/storefront/v1/order/${encodeURIComponent(
+          orderId
+        )}/downloads/${encodeURIComponent(downloadId)}`,
         {
-          ...options
+          ...restOptions,
+          method: "POST",
+          params: auth?.token ? { token: auth.token } : void 0,
+          headers: {
+            ...buildDownloadAuthHeaders(auth),
+            ...extraHeaders ?? {}
+          }
         }
       );
     }