@scayle/storefront-core/dist/constants/withParameters.d.ts

Collection of essential utilities to work with the Storefront API

import type { BasketWith, ProductWith, SearchWith, WishlistWith } from '../types';
/**
 * Default `with` parameters for product listings.
 * Requests all available attributes, advanced attributes, variants, images,
 * category properties, and price range information.
 */
declare const DEFAULT_WITH_LISTING: {
    items: {
        product: {
            attributes: "all";
            advancedAttributes: "all";
            variants: {
                attributes: "all";
                advancedAttributes: "all";
            };
            images: "all";
            categories: {
                properties: "all";
            };
            priceRange: boolean;
        };
        variant: {
            attributes: "all";
        };
    };
};
/**
 * Minimum required `with` parameters for search requests.
 * Includes essential product attributes, variant attributes, and category properties.
 */
declare const MIN_WITH_PARAMS_SEARCH: SearchWith;
/**
 * Minimum required `with` parameters for single product requests.
 * Includes essential product attributes, variant attributes, images,
 * category properties, and sibling information.
 */
declare const MIN_WITH_PARAMS_PRODUCT: ProductWith;
/**
 * Minimum required `with` parameters for basket requests.
 * Includes essential product and variant information, images, categories,
 * price range, and lowest prior price.
 */
declare const MIN_WITH_PARAMS_BASKET: BasketWith;
/**
 * Minimum required `with` parameters for wishlist requests.
 * Includes essential product and variant attributes, images, categories,
 * price range, and lowest prior price.
 */
declare const MIN_WITH_PARAMS_WISHLIST: WishlistWith;
/**
 * Minimum required `with` parameters for variant requests.
 * Includes size-related attributes.
 */
declare const MIN_WITH_PARAMS_VARIANT: ProductWith;
export { DEFAULT_WITH_LISTING, MIN_WITH_PARAMS_BASKET, MIN_WITH_PARAMS_SEARCH, MIN_WITH_PARAMS_PRODUCT, MIN_WITH_PARAMS_WISHLIST, MIN_WITH_PARAMS_VARIANT, };