@putiikkipalvelu/storefront-sdk 0.12.0 → 0.14.0

package/dist/index.d.cts

@@ -1,8 +1,180 @@
+/**
+ * Product Types
+ *
+ * Types for product-related API endpoints.
+ */
+
+/**
+ * Product variation option (e.g., Size: Large)
+ */
+interface VariationOption {
+    /** Option value (e.g., "Large", "Red") */
+    value: string;
+    /** Option type information */
+    optionType: {
+        /** Option type name (e.g., "Size", "Color") */
+        name: string;
+    };
+}
+/**
+ * Product variation for listings (minimal fields)
+ */
+interface ProductVariationListing {
+    /** Unique variation identifier */
+    id: string;
+    /** Variation price in cents */
+    price: number;
+    /** Sale price in cents (null if not on sale) */
+    salePrice: number | null;
+    /** Sale discount percentage as string (null if not on sale) */
+    salePercent: string | null;
+    /** Sale start date (ISO 8601), null = immediate */
+    saleStartDate: string | null;
+    /** Sale end date (ISO 8601), null = no end */
+    saleEndDate: string | null;
+}
+/**
+ * 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 */
+    sku: string | null;
+    /** Variation-specific images */
+    images: string[];
+    /** Variation-specific description */
+    description: string | null;
+    /** Whether variation is visible on store */
+    showOnStore: boolean;
+    /** Variation options (size, color, etc.) */
+    options: VariationOption[];
+}
+/**
+ * Product for listing (cards, grids)
+ * Used by: /latest-products, /sorted-products
+ */
+interface Product {
+    /** Unique product identifier */
+    id: string;
+    /** Product display name */
+    name: string;
+    /** URL-friendly slug */
+    slug: string;
+    /** Product description */
+    description: string;
+    /** Base price in cents */
+    price: number;
+    /** Product images (URLs) */
+    images: string[];
+    /** Available quantity (null = unlimited) */
+    quantity: number | null;
+    /** Sale price in cents (null if not on sale) */
+    salePrice: number | null;
+    /** Sale discount percentage as string (null if not on sale) */
+    salePercent: string | null;
+    /** Sale start date (ISO 8601), null = immediate */
+    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[];
+}
+/**
+ * Full product detail (single product page)
+ * Used by: /product/{slug}
+ */
+/**
+ * Ticket info attached to a ticket product
+ */
+interface ProductTicketInfo {
+    /** Ticket info ID */
+    id: string;
+    /** Whether holder name is required per ticket at checkout */
+    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) */
+    weight: number;
+    /** Stock keeping unit */
+    sku: string | null;
+    /** SEO meta title */
+    metaTitle: string | null;
+    /** SEO meta description */
+    metaDescription: string | null;
+    /** Product categories */
+    categories: CategoryReference[];
+    /** Full 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;
+    /** Average rating across approved reviews (null when there are none) */
+    averageRating: number | null;
+    /** Number of approved reviews */
+    reviewCount: number;
+}
+/**
+ * Response from /sorted-products
+ */
+interface ProductListResponse {
+    /** Category/collection name */
+    name: string;
+    /** Products in the list */
+    products: Product[];
+    /** Total count for pagination (only in sorted-products) */
+    totalCount?: number;
+}
+/**
+ * Response from /products-count
+ */
+interface ProductCountResponse {
+    /** Number of products */
+    count: number;
+}
+/**
+ * Sort options for product listing
+ */
+type ProductSortOption = "newest" | "price_asc" | "price_desc" | "popularity" | "relevance"
+/** The merchant's manual per-category order (set in the dashboard). Only
+ *  meaningful within a category; falls back to "newest" on all-products. */
+ | "featured";
+/**
+ * Parameters for sorted products
+ */
+interface ProductListParams {
+    /** Category slugs to filter by (omit for all products) */
+    slugs?: string[];
+    /** Page number (1-based, default: 1) */
+    page?: number;
+    /** Products per page (default: 12, max: 100) */
+    pageSize?: number;
+    /** Sort order */
+    sort?: ProductSortOption;
+    /** Full-text search query */
+    query?: string;
+}
+
 /**
  * Store Configuration Types
  *
  * Types for the store config endpoint response.
  */
+
 /**
  * Complete store configuration returned by the API.
  * Includes business info, SEO settings, payments, campaigns, and feature flags.
@@ -70,6 +242,10 @@ interface StoreInfo {
     logoUrl: string | null;
     /** Product image aspect ratio: SQUARE (1:1) or PORTRAIT (3:4) */
     imageAspectRatio: ImageAspectRatio;
+    /** Default product sort for storefront category pages before the shopper
+     *  picks a sort. "featured" = the merchant's manual per-category order.
+     *  Optional for backward compatibility with older backends. */
+    defaultProductSort?: ProductSortOption;
 }
 /**
  * Store SEO and social media configuration
@@ -276,174 +452,6 @@ interface CategoryReference {
     parentId: string | null;
 }
 
-/**
- * Product Types
- *
- * Types for product-related API endpoints.
- */
-
-/**
- * Product variation option (e.g., Size: Large)
- */
-interface VariationOption {
-    /** Option value (e.g., "Large", "Red") */
-    value: string;
-    /** Option type information */
-    optionType: {
-        /** Option type name (e.g., "Size", "Color") */
-        name: string;
-    };
-}
-/**
- * Product variation for listings (minimal fields)
- */
-interface ProductVariationListing {
-    /** Unique variation identifier */
-    id: string;
-    /** Variation price in cents */
-    price: number;
-    /** Sale price in cents (null if not on sale) */
-    salePrice: number | null;
-    /** Sale discount percentage as string (null if not on sale) */
-    salePercent: string | null;
-    /** Sale start date (ISO 8601), null = immediate */
-    saleStartDate: string | null;
-    /** Sale end date (ISO 8601), null = no end */
-    saleEndDate: string | null;
-}
-/**
- * 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 */
-    sku: string | null;
-    /** Variation-specific images */
-    images: string[];
-    /** Variation-specific description */
-    description: string | null;
-    /** Whether variation is visible on store */
-    showOnStore: boolean;
-    /** Variation options (size, color, etc.) */
-    options: VariationOption[];
-}
-/**
- * Product for listing (cards, grids)
- * Used by: /latest-products, /sorted-products
- */
-interface Product {
-    /** Unique product identifier */
-    id: string;
-    /** Product display name */
-    name: string;
-    /** URL-friendly slug */
-    slug: string;
-    /** Product description */
-    description: string;
-    /** Base price in cents */
-    price: number;
-    /** Product images (URLs) */
-    images: string[];
-    /** Available quantity (null = unlimited) */
-    quantity: number | null;
-    /** Sale price in cents (null if not on sale) */
-    salePrice: number | null;
-    /** Sale discount percentage as string (null if not on sale) */
-    salePercent: string | null;
-    /** Sale start date (ISO 8601), null = immediate */
-    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[];
-}
-/**
- * Full product detail (single product page)
- * Used by: /product/{slug}
- */
-/**
- * Ticket info attached to a ticket product
- */
-interface ProductTicketInfo {
-    /** Ticket info ID */
-    id: string;
-    /** Whether holder name is required per ticket at checkout */
-    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) */
-    weight: number;
-    /** Stock keeping unit */
-    sku: string | null;
-    /** SEO meta title */
-    metaTitle: string | null;
-    /** SEO meta description */
-    metaDescription: string | null;
-    /** Product categories */
-    categories: CategoryReference[];
-    /** Full 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;
-    /** Average rating across approved reviews (null when there are none) */
-    averageRating: number | null;
-    /** Number of approved reviews */
-    reviewCount: number;
-}
-/**
- * Response from /sorted-products
- */
-interface ProductListResponse {
-    /** Category/collection name */
-    name: string;
-    /** Products in the list */
-    products: Product[];
-    /** Total count for pagination (only in sorted-products) */
-    totalCount?: number;
-}
-/**
- * Response from /products-count
- */
-interface ProductCountResponse {
-    /** Number of products */
-    count: number;
-}
-/**
- * Sort options for product listing
- */
-type ProductSortOption = "newest" | "price_asc" | "price_desc" | "popularity" | "relevance";
-/**
- * Parameters for sorted products
- */
-interface ProductListParams {
-    /** Category slugs to filter by (omit for all products) */
-    slugs?: string[];
-    /** Page number (1-based, default: 1) */
-    page?: number;
-    /** Products per page (default: 12, max: 100) */
-    pageSize?: number;
-    /** Sort order */
-    sort?: ProductSortOption;
-    /** Full-text search query */
-    query?: string;
-}
-
 /**
  * Category Types
  *

package/dist/index.d.ts

@@ -1,8 +1,180 @@
+/**
+ * Product Types
+ *
+ * Types for product-related API endpoints.
+ */
+
+/**
+ * Product variation option (e.g., Size: Large)
+ */
+interface VariationOption {
+    /** Option value (e.g., "Large", "Red") */
+    value: string;
+    /** Option type information */
+    optionType: {
+        /** Option type name (e.g., "Size", "Color") */
+        name: string;
+    };
+}
+/**
+ * Product variation for listings (minimal fields)
+ */
+interface ProductVariationListing {
+    /** Unique variation identifier */
+    id: string;
+    /** Variation price in cents */
+    price: number;
+    /** Sale price in cents (null if not on sale) */
+    salePrice: number | null;
+    /** Sale discount percentage as string (null if not on sale) */
+    salePercent: string | null;
+    /** Sale start date (ISO 8601), null = immediate */
+    saleStartDate: string | null;
+    /** Sale end date (ISO 8601), null = no end */
+    saleEndDate: string | null;
+}
+/**
+ * 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 */
+    sku: string | null;
+    /** Variation-specific images */
+    images: string[];
+    /** Variation-specific description */
+    description: string | null;
+    /** Whether variation is visible on store */
+    showOnStore: boolean;
+    /** Variation options (size, color, etc.) */
+    options: VariationOption[];
+}
+/**
+ * Product for listing (cards, grids)
+ * Used by: /latest-products, /sorted-products
+ */
+interface Product {
+    /** Unique product identifier */
+    id: string;
+    /** Product display name */
+    name: string;
+    /** URL-friendly slug */
+    slug: string;
+    /** Product description */
+    description: string;
+    /** Base price in cents */
+    price: number;
+    /** Product images (URLs) */
+    images: string[];
+    /** Available quantity (null = unlimited) */
+    quantity: number | null;
+    /** Sale price in cents (null if not on sale) */
+    salePrice: number | null;
+    /** Sale discount percentage as string (null if not on sale) */
+    salePercent: string | null;
+    /** Sale start date (ISO 8601), null = immediate */
+    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[];
+}
+/**
+ * Full product detail (single product page)
+ * Used by: /product/{slug}
+ */
+/**
+ * Ticket info attached to a ticket product
+ */
+interface ProductTicketInfo {
+    /** Ticket info ID */
+    id: string;
+    /** Whether holder name is required per ticket at checkout */
+    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) */
+    weight: number;
+    /** Stock keeping unit */
+    sku: string | null;
+    /** SEO meta title */
+    metaTitle: string | null;
+    /** SEO meta description */
+    metaDescription: string | null;
+    /** Product categories */
+    categories: CategoryReference[];
+    /** Full 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;
+    /** Average rating across approved reviews (null when there are none) */
+    averageRating: number | null;
+    /** Number of approved reviews */
+    reviewCount: number;
+}
+/**
+ * Response from /sorted-products
+ */
+interface ProductListResponse {
+    /** Category/collection name */
+    name: string;
+    /** Products in the list */
+    products: Product[];
+    /** Total count for pagination (only in sorted-products) */
+    totalCount?: number;
+}
+/**
+ * Response from /products-count
+ */
+interface ProductCountResponse {
+    /** Number of products */
+    count: number;
+}
+/**
+ * Sort options for product listing
+ */
+type ProductSortOption = "newest" | "price_asc" | "price_desc" | "popularity" | "relevance"
+/** The merchant's manual per-category order (set in the dashboard). Only
+ *  meaningful within a category; falls back to "newest" on all-products. */
+ | "featured";
+/**
+ * Parameters for sorted products
+ */
+interface ProductListParams {
+    /** Category slugs to filter by (omit for all products) */
+    slugs?: string[];
+    /** Page number (1-based, default: 1) */
+    page?: number;
+    /** Products per page (default: 12, max: 100) */
+    pageSize?: number;
+    /** Sort order */
+    sort?: ProductSortOption;
+    /** Full-text search query */
+    query?: string;
+}
+
 /**
  * Store Configuration Types
  *
  * Types for the store config endpoint response.
  */
+
 /**
  * Complete store configuration returned by the API.
  * Includes business info, SEO settings, payments, campaigns, and feature flags.
@@ -70,6 +242,10 @@ interface StoreInfo {
     logoUrl: string | null;
     /** Product image aspect ratio: SQUARE (1:1) or PORTRAIT (3:4) */
     imageAspectRatio: ImageAspectRatio;
+    /** Default product sort for storefront category pages before the shopper
+     *  picks a sort. "featured" = the merchant's manual per-category order.
+     *  Optional for backward compatibility with older backends. */
+    defaultProductSort?: ProductSortOption;
 }
 /**
  * Store SEO and social media configuration
@@ -276,174 +452,6 @@ interface CategoryReference {
     parentId: string | null;
 }
 
-/**
- * Product Types
- *
- * Types for product-related API endpoints.
- */
-
-/**
- * Product variation option (e.g., Size: Large)
- */
-interface VariationOption {
-    /** Option value (e.g., "Large", "Red") */
-    value: string;
-    /** Option type information */
-    optionType: {
-        /** Option type name (e.g., "Size", "Color") */
-        name: string;
-    };
-}
-/**
- * Product variation for listings (minimal fields)
- */
-interface ProductVariationListing {
-    /** Unique variation identifier */
-    id: string;
-    /** Variation price in cents */
-    price: number;
-    /** Sale price in cents (null if not on sale) */
-    salePrice: number | null;
-    /** Sale discount percentage as string (null if not on sale) */
-    salePercent: string | null;
-    /** Sale start date (ISO 8601), null = immediate */
-    saleStartDate: string | null;
-    /** Sale end date (ISO 8601), null = no end */
-    saleEndDate: string | null;
-}
-/**
- * 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 */
-    sku: string | null;
-    /** Variation-specific images */
-    images: string[];
-    /** Variation-specific description */
-    description: string | null;
-    /** Whether variation is visible on store */
-    showOnStore: boolean;
-    /** Variation options (size, color, etc.) */
-    options: VariationOption[];
-}
-/**
- * Product for listing (cards, grids)
- * Used by: /latest-products, /sorted-products
- */
-interface Product {
-    /** Unique product identifier */
-    id: string;
-    /** Product display name */
-    name: string;
-    /** URL-friendly slug */
-    slug: string;
-    /** Product description */
-    description: string;
-    /** Base price in cents */
-    price: number;
-    /** Product images (URLs) */
-    images: string[];
-    /** Available quantity (null = unlimited) */
-    quantity: number | null;
-    /** Sale price in cents (null if not on sale) */
-    salePrice: number | null;
-    /** Sale discount percentage as string (null if not on sale) */
-    salePercent: string | null;
-    /** Sale start date (ISO 8601), null = immediate */
-    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[];
-}
-/**
- * Full product detail (single product page)
- * Used by: /product/{slug}
- */
-/**
- * Ticket info attached to a ticket product
- */
-interface ProductTicketInfo {
-    /** Ticket info ID */
-    id: string;
-    /** Whether holder name is required per ticket at checkout */
-    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) */
-    weight: number;
-    /** Stock keeping unit */
-    sku: string | null;
-    /** SEO meta title */
-    metaTitle: string | null;
-    /** SEO meta description */
-    metaDescription: string | null;
-    /** Product categories */
-    categories: CategoryReference[];
-    /** Full 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;
-    /** Average rating across approved reviews (null when there are none) */
-    averageRating: number | null;
-    /** Number of approved reviews */
-    reviewCount: number;
-}
-/**
- * Response from /sorted-products
- */
-interface ProductListResponse {
-    /** Category/collection name */
-    name: string;
-    /** Products in the list */
-    products: Product[];
-    /** Total count for pagination (only in sorted-products) */
-    totalCount?: number;
-}
-/**
- * Response from /products-count
- */
-interface ProductCountResponse {
-    /** Number of products */
-    count: number;
-}
-/**
- * Sort options for product listing
- */
-type ProductSortOption = "newest" | "price_asc" | "price_desc" | "popularity" | "relevance";
-/**
- * Parameters for sorted products
- */
-interface ProductListParams {
-    /** Category slugs to filter by (omit for all products) */
-    slugs?: string[];
-    /** Page number (1-based, default: 1) */
-    page?: number;
-    /** Products per page (default: 12, max: 100) */
-    pageSize?: number;
-    /** Sort order */
-    sort?: ProductSortOption;
-    /** Full-text search query */
-    query?: string;
-}
-
 /**
  * Category Types
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putiikkipalvelu/storefront-sdk",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "description": "TypeScript SDK for Putiikkipalvelu Storefront API",
   "author": "Putiikkipalvelu",
   "license": "MIT",