@propeller-commerce/propeller-v2-react-ui 0.4.15 → 0.4.17

package/dist/index.d.cts

@@ -6,10 +6,10 @@ import React__default, { ReactNode, ComponentType } from 'react';
 import { GraphQLClient, Contact, Customer, Cart, CartMainItem, Product, Cluster, AddressType, Gender, YesNo, Address, TransformationsInput, MediaImageProductSearchInput, CartProcessResponse, Crossupsell, CartUpdateAddressInput, CartUpdateInput, CartAddressType, ClusterConfig, Company, CompanyVariables, PurchaseAuthorizationConfigCreateInput, PurchaseAuthorizationConfigUpdateInput, FavoriteList, DateSearchInput, DecimalSearchInput, OrderSortInput, OrderType, OrderSearchFields, Order, ProductTextFilterInput, AttributeFilter, ProductsResponse, Category, CrossupsellType, AttributeResult, RegisterContactInput as RegisterContactInput$1, PurchaseAuthorizationConfig, CartChildItemInput, CartAddress, WarehouseAddress, OrderAddress, CartBaseItem, CartCarrier, CartPaymethod, ClusterOption, ProductInventory, OrderItem, ProductPrice, Bundle, PaginatedMediaDocumentResponse, PaginatedMediaVideoResponse } from '@propeller-commerce/propeller-sdk-v2';
 
 /**
- * Tier 1 — application-wide infrastructure. Bound by `<PropellerDepsProvider>`
+ * Tier 1 — application-wide infrastructure. Bound by `<PropellerDepsProvider>`
  * once at the root of the app. These values are app-singletons: the GraphQL
  * client, the SDK Services bundle wired to it, and the cosmetic / branding
- * defaults (currency, configuration). They do not change per subtree — for
+ * defaults (currency, configuration). They do not change per subtree — for
  * per-scope state (user, companyId, language) use `<PropellerProvider>`.
  *
  * Why split: per-scope state belongs to a routed section (impersonation,
@@ -20,7 +20,7 @@ import { GraphQLClient, Contact, Customer, Cart, CartMainItem, Product, Cluster,
 interface PropellerDeps {
     /**
      * The GraphQL client the consumer constructed. Exposed for code that needs
-     * to pass it back into SDK helpers (rare — most code should use `services`).
+     * to pass it back into SDK helpers (rare — most code should use `services`).
      */
     graphqlClient: GraphQLClient;
     /**
@@ -28,13 +28,13 @@ interface PropellerDeps {
      * `graphqlClient`. Build it via `createServices(graphqlClient)`.
      */
     services: Services;
-    /** Currency symbol used by display components. Default: `'€'`. */
+    /** Currency symbol used by display components. Default: `'€'`. */
     currency: string;
     /** Free-form configuration bag forwarded to components. */
     configuration: unknown;
 }
 /**
- * Tier 2 — per-scope state. Bound by `<PropellerProvider>` and replaceable
+ * Tier 2 — per-scope state. Bound by `<PropellerProvider>` and replaceable
  * by nesting a second provider deeper in the tree.
  */
 interface PropellerScope {
@@ -52,7 +52,7 @@ interface PropellerScope {
      * Shop mode declared in `propeller.json`. Combined with `user` to derive
      * `userMode` on the composite context. Defaults to `'hybrid'` when omitted
      * so existing call sites keep their current branching semantics (any
-     * logged-in Contact → b2b surface).
+     * logged-in Contact → b2b surface).
      */
     shopMode?: ShopMode;
 }
@@ -87,7 +87,7 @@ interface PropellerDepsProviderProps {
  *
  * export function Providers({ children }) {
  *   return (
- *     <PropellerDepsProvider value={{ graphqlClient, services, currency: '€', configuration }}>
+ *     <PropellerDepsProvider value={{ graphqlClient, services, currency: '€', configuration }}>
  *       <PropellerProvider value={scopeFromHostStores}>
  *         {children}
  *       </PropellerProvider>
@@ -105,7 +105,7 @@ interface PropellerProviderProps {
 /**
  * Provider for Tier 2 per-scope state (user, companyId, language,
  * includeTax, portalMode). Wrap the routed tree; nest deeper to override
- * scope for a subtree (impersonation, multi-cart, …).
+ * scope for a subtree (impersonation, multi-cart, …).
  */
 declare function PropellerProvider({ value, children }: PropellerProviderProps): React$1.JSX.Element;
 /**
@@ -113,7 +113,7 @@ declare function PropellerProvider({ value, children }: PropellerProviderProps):
  * components stay usable standalone / in tests.
  */
 declare function usePropellerDeps(): PropellerDeps | null;
-/** Throwing variant — call when deps are required. */
+/** Throwing variant — call when deps are required. */
 declare function useRequiredPropellerDeps(): PropellerDeps;
 /**
  * Read the Tier 2 scope. Returns `null` outside the provider so components
@@ -219,9 +219,16 @@ interface ProductGridConfig {
     clusterCardComponent?: ComponentType<{
         cluster: Cluster;
     } & Record<string, unknown>>;
+    /**
+     * Render arbitrary content directly below each card's product name. Receives
+     * the product; return `null`/`undefined` to render nothing. Lets hosts surface
+     * extra per-product info (e.g. package descriptions) across the whole grid
+     * without swapping the entire card.
+     */
+    belowName?: (product: Product) => ReactNode;
 }
 /**
- * Provider — ProductGrid wraps its card subtree with this so descendant
+ * Provider — ProductGrid wraps its card subtree with this so descendant
  * cards read display flags and callbacks via {@link useProductGridConfig}
  * instead of receiving them as threaded props.
  *
@@ -1001,7 +1008,7 @@ type InfraKey$1 = keyof PropellerInfra;
 declare function useInfraProps<P extends Partial<Record<InfraKey$1, unknown>>>(props: P): P & Partial<PropellerInfra>;
 
 /**
- * useMenu (React) — Category tree fetch with depth-configurable recursive GraphQL query.
+ * useMenu (React) — Category tree fetch with depth-configurable recursive GraphQL query.
  *
  * Responsibilities:
  * - Dynamic recursive GraphQL category query (depth-configurable, default 3)
@@ -1045,14 +1052,14 @@ interface UseMenuReturn {
     clearCache: (rootCategoryId: number, language: string, userKey?: string) => void;
 }
 /**
- * useMenu — category-tree fetch with a depth-configurable recursive GraphQL query.
+ * useMenu — category-tree fetch with a depth-configurable recursive GraphQL query.
  *
  * @param options - see {@link UseMenuOptions}.
- * @returns the category tree, loading/error state and fetch/cache actions — see {@link UseMenuReturn}.
+ * @returns the category tree, loading/error state and fetch/cache actions — see {@link UseMenuReturn}.
  *
  * @remarks
  * GraphQL integration: unlike the SDK-service hooks, `fetchMenu` runs a raw query
- * directly via `graphqlClient.query()` — it builds a recursive `categories { ... }`
+ * directly via `graphqlClient.query()` — it builds a recursive `categories { ... }`
  * fragment to the configured `depth` and reads the root category's children.
  * Results are cached in `localStorage` with a 12h TTL under a key scoped by root
  * category, language and `userKey`. A module-level `inflightFetches` map dedups
@@ -1281,6 +1288,18 @@ interface UseProductInfoOptions {
     user?: Contact | Customer | null;
     /** Active company id for company-scoped pricing and orderlist resolution. */
     companyId?: number;
+    /**
+     * Scope the product fetch to specific orderlist IDs (e.g. a chosen B2B
+     * contract). When provided, these override the default behaviour of resolving
+     * and applying ALL of the company's orderlists.
+     */
+    orderlistIds?: number[];
+    /**
+     * Apply the orderlist filter. Defaults to `true` when `orderlistIds` is
+     * non-empty (or resolved from the company), `false` when explicitly set so an
+     * authenticated user without a contract sees the full catalogue.
+     */
+    applyOrderlists?: boolean;
     /** Attribute names to include in attributeResultSearchInput (productTrackAttributes). */
     productTrackAttributes?: string[];
     /** Portal configuration: image search/variant filters per size. */
@@ -1360,6 +1379,14 @@ interface UseProductSearchOptions {
     user?: Contact | Customer | null;
     /** Active company id for company-scoped pricing/visibility. */
     companyId?: number;
+    /** Scope the product fetch to specific orderlist IDs (e.g. a chosen B2B contract). */
+    orderlistIds?: number[];
+    /**
+     * Apply the orderlist filter on the search input. Defaults to `true` when
+     * `orderlistIds` is non-empty, `false` otherwise — so an authenticated user
+     * without a contract still sees the full catalogue.
+     */
+    applyOrderlists?: boolean;
     /** Attribute text filters applied to the category search. */
     textFilters?: ProductTextFilterInput[];
     /** Lower price bound filter. */
@@ -1860,7 +1887,7 @@ declare function useResolvedProps<P extends object>(rawProps: P, spec: ResolveSp
 declare function useServices(): Services;
 
 /**
- * cartInit — 3-step cart initialisation shared by useCart and useProductBundles.
+ * cartInit — 3-step cart initialisation shared by useCart and useProductBundles.
  *
  * Step 1: Search for an existing OPEN cart for this user.
  * Step 2: If none found, create a new cart via startCart.
@@ -1872,14 +1899,14 @@ declare function useServices(): Services;
 /** Configuration object for {@link initCart}. */
 interface CartInitConfig {
     /**
-     * The Services bundle — pass `services` from `usePropellerContext()` / the
+     * The Services bundle — pass `services` from `usePropellerContext()` / the
      * provider's value object. Replaces the previous `graphqlClient` field
      * which forced this util to know how to construct services.
      */
     services: Services;
     /** The current user (Contact or Customer); `null` for anonymous carts. */
     user: AnyUser;
-    /** Active company ID — overrides user's default company for cart lookup and creation */
+    /** Active company ID — overrides user's default company for cart lookup and creation */
     companyId?: number;
     /** Language code for localised cart queries. Defaults to `'NL'`. */
     language?: string;
@@ -1909,7 +1936,7 @@ interface CartInitConfig {
 declare function initCart(config: CartInitConfig): Promise<Cart>;
 
 /**
- * fetchActiveCart — fetches the user's existing OPEN cart filtered by user/company.
+ * fetchActiveCart — fetches the user's existing OPEN cart filtered by user/company.
  *
  * Framework-agnostic helper so login/register pages can reuse the same logic
  * without forcing a state-management store dependency.
@@ -1918,13 +1945,13 @@ declare function initCart(config: CartInitConfig): Promise<Cart>;
 /** Configuration object for {@link fetchActiveCart}. */
 interface FetchActiveCartConfig {
     /**
-     * The Services bundle — pass `services` from `usePropellerContext()` / the
+     * The Services bundle — pass `services` from `usePropellerContext()` / the
      * provider's value object. Replaces the previous `graphqlClient` field.
      */
     services: Services;
     /** The authenticated user (Contact or Customer) whose cart to look up. */
     user: Contact | Customer;
-    /** Active company ID — narrows the cart search for company users. */
+    /** Active company ID — narrows the cart search for company users. */
     companyId?: number;
     /** Language code for the localised cart query. */
     language: string;
@@ -1948,7 +1975,7 @@ interface FetchActiveCartConfig {
 declare function fetchActiveCart(cfg: FetchActiveCartConfig): Promise<Cart | null>;
 
 /**
- * mergeAnonymousCart — copies items from an anonymous cart into a target
+ * mergeAnonymousCart — copies items from an anonymous cart into a target
  * (authenticated) cart by calling CartService.addItemToCart per item.
  *
  * Framework-agnostic.
@@ -1957,7 +1984,7 @@ declare function fetchActiveCart(cfg: FetchActiveCartConfig): Promise<Cart | nul
 /** Configuration object for {@link mergeAnonymousCart}. */
 interface MergeAnonymousCartConfig {
     /**
-     * The Services bundle — pass `services` from `usePropellerContext()` / the
+     * The Services bundle — pass `services` from `usePropellerContext()` / the
      * provider's value object. Replaces the previous `graphqlClient` field.
      */
     services: Services;
@@ -3200,7 +3227,7 @@ interface CartSummaryProps {
 declare function CartSummary(rawProps: CartSummaryProps): React$1.JSX.Element;
 
 /**
- * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
+ * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
  * Must be rendered inside (or below) a Client Component boundary; cannot be
  * imported directly into a React Server Component. The 'use client' header
  * above marks this boundary to Next.js.
@@ -3239,7 +3266,7 @@ interface CategoryDescriptionProps {
 declare function CategoryDescription(props: CategoryDescriptionProps): React$1.JSX.Element;
 
 /**
- * @rsc-safe — Pure display component. No React hooks, no event handlers, no
+ * @rsc-safe — Pure display component. No React hooks, no event handlers, no
  * browser APIs, no context reads. Renders directly from props and can be
  * imported into a React Server Component without a 'use client' boundary.
  * Verified C0.2 (2026-05-20).
@@ -3523,7 +3550,7 @@ interface ClusterConfiguratorProps {
 declare function ClusterConfigurator(props: ClusterConfiguratorProps): React$1.JSX.Element;
 
 /**
- * @rsc-blocked — Client-only component: side effects (useEffect).
+ * @rsc-blocked — Client-only component: side effects (useEffect).
  * Must be rendered inside (or below) a Client Component boundary; cannot be
  * imported directly into a React Server Component. The 'use client' header
  * above marks this boundary to Next.js.
@@ -3548,7 +3575,7 @@ interface ClusterInfoProps {
      */
     graphqlClient?: GraphQLClient;
     /**
-     * Called once the cluster data is loaded — either immediately (when
+     * Called once the cluster data is loaded — either immediately (when
      * `cluster` prop is supplied) or after the internal fetch completes.
      * Use this to hydrate sibling components (configurator, price, gallery, etc.).
      */
@@ -3656,7 +3683,7 @@ interface ClusterOptionsProps {
 declare function ClusterOptions(props: ClusterOptionsProps): React$1.JSX.Element;
 
 /**
- * @rsc-blocked — Client-only component: browser-only APIs (window/document/storage).
+ * @rsc-blocked — Client-only component: browser-only APIs (window/document/storage).
  * Must be rendered inside (or below) a Client Component boundary; cannot be
  * imported directly into a React Server Component. The 'use client' header
  * above marks this boundary to Next.js.
@@ -3719,7 +3746,7 @@ interface DeliveryDateProps {
 declare function DeliveryDate(props: DeliveryDateProps): React$1.JSX.Element;
 
 /**
- * @rsc-blocked — Client-only component: JSX event handlers (onClick/onChange/etc.).
+ * @rsc-blocked — Client-only component: JSX event handlers (onClick/onChange/etc.).
  * Must be rendered inside (or below) a Client Component boundary; cannot be
  * imported directly into a React Server Component. The 'use client' header
  * above marks this boundary to Next.js.
@@ -3738,8 +3765,8 @@ interface GridPaginationProps {
     onPageChange: (page: number) => void;
     /**
      * Pagination display variant.
-     * 'compact' — Previous / "Page X of Y" / Next.
-     * 'full'    — numbered page buttons with ellipsis collapsing + Previous / Next.
+     * 'compact' — Previous / "Page X of Y" / Next.
+     * 'full'    — numbered page buttons with ellipsis collapsing + Previous / Next.
      * Defaults to 'compact'.
      */
     variant?: string;
@@ -4060,7 +4087,7 @@ interface FavoriteListsProps {
 declare function FavoriteLists(rawProps: FavoriteListsProps): React$1.JSX.Element;
 
 /**
- * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
+ * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
  * Must be rendered inside (or below) a Client Component boundary; cannot be
  * imported directly into a React Server Component. The 'use client' header
  * above marks this boundary to Next.js.
@@ -4107,7 +4134,7 @@ interface ForgotPasswordProps {
 declare function ForgotPassword(rawProps: ForgotPasswordProps): React$1.JSX.Element;
 
 /**
- * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
+ * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
  * Must be rendered inside (or below) a Client Component boundary; cannot be
  * imported directly into a React Server Component. The 'use client' header
  * above marks this boundary to Next.js.
@@ -4144,11 +4171,11 @@ interface GridFiltersProps {
     /** Enable mobile-specific behaviour (drops sticky positioning). */
     isMobile?: boolean;
     /**
-     * 'open' — show price filter for all users.
-     * 'semi-closed' — hide price filter for unauthenticated users.
+     * 'open' — show price filter for all users.
+     * 'semi-closed' — hide price filter for unauthenticated users.
      */
     portalMode?: string;
-    /** Authenticated user — price filter visibility depends on this in semi-closed mode. */
+    /** Authenticated user — price filter visibility depends on this in semi-closed mode. */
     user?: Contact | Customer | null;
     /**
      * Whether filter accordions start collapsed.
@@ -4261,6 +4288,11 @@ interface GridToolbarProps {
      * Defaults to all available sort fields.
      */
     sortOptions?: string[];
+    /**
+     * Hide the price-ascending/descending sort options entirely. Default: false.
+     * Useful for closed B2B portals where prices are "by quotation".
+     */
+    hidePriceSort?: boolean;
     /**
      * Active sort — first element is used.
      * Defaults to [{ field: 'CATEGORY_ORDER', order: 'DESC' }].
@@ -4503,6 +4535,13 @@ interface MenuProps {
      * Defaults to 'category/{categoryId}/{slug}'.
      */
     menuLinkFormat?: string;
+    /**
+     * Custom URL builder for category links. Overrides `menuLinkFormat` /
+     * `configuration.urls.getCategoryUrl`. Lets hosts inject dynamic query strings
+     * (e.g. `?contract=…`) that a static format string cannot express.
+     * Mirrors the `getUrl` prop on Breadcrumbs.
+     */
+    getUrl?: (category: Category) => string;
     /**
      * Called when a menu item is clicked.
      * Use for SPA-style routing instead of full-page navigation.
@@ -5161,6 +5200,14 @@ interface ProductCardProps {
     badgesComponent?: React$1.ComponentType<_propeller_commerce_propeller_v2_core_ui.BadgesComponentProps>;
     /** Replaces the default favorite-toggle. Receives `FavoriteComponentProps`. */
     favoriteComponent?: React$1.ComponentType<_propeller_commerce_propeller_v2_core_ui.FavoriteComponentProps>;
+    /**
+     * Render arbitrary content directly below the product name (and above the
+     * short description / price), in both the grid and row layouts. Receives the
+     * product so hosts can surface extra info — e.g. package descriptions, custom
+     * badges — without forking the card. Return `null`/`undefined` to render
+     * nothing for a given product.
+     */
+    belowName?: (product: Product) => React$1.ReactNode;
 }
 /**
  * Root of the `<ProductCard>` compound component. Renders either the
@@ -5238,6 +5285,10 @@ declare function ProductCardStock(props: {
     /** Show only the availability indicator. Defaults to context `showAvailability`. */
     showAvailability?: boolean;
 }): React$1.JSX.Element | null;
+/** Renders host-supplied content directly below the name, via the `belowName`
+ *  render prop (explicit or from grid context). Renders nothing when unset or
+ *  when the render prop returns a nullish value. */
+declare function ProductCardBelowName(): React$1.JSX.Element | null;
 /** Renders the product price via the embedded `ProductPrice` component, or
  *  the injected `priceComponent` from context when set. */
 declare function ProductCardPrice(props: {
@@ -5285,6 +5336,7 @@ type ProductCardComponent = typeof MemoizedRoot & {
     Favorite: typeof ProductCardFavorite;
     Name: typeof ProductCardName;
     Sku: typeof ProductCardSku;
+    BelowName: typeof ProductCardBelowName;
     ShortDescription: typeof ProductCardShortDescription;
     Manufacturer: typeof ProductCardManufacturer;
     TextLabels: typeof ProductCardTextLabels;
@@ -5295,7 +5347,7 @@ type ProductCardComponent = typeof MemoizedRoot & {
 declare const ProductCard: ProductCardComponent;
 
 /**
- * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
+ * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
  * Must be rendered inside (or below) a Client Component boundary; cannot be
  * imported directly into a React Server Component. The 'use client' header
  * above marks this boundary to Next.js.
@@ -5400,7 +5452,7 @@ declare function ProductGallery(props: ProductGalleryProps): React$1.JSX.Element
 interface ProductGridProps {
     /**
      * Initialised Propeller SDK GraphQL client.
-     * Required when `products` is not provided — used for internal data fetching.
+     * Required when `products` is not provided — used for internal data fetching.
      */
     graphqlClient?: GraphQLClient;
     /**
@@ -5420,15 +5472,23 @@ interface ProductGridProps {
      */
     categoryId?: number;
     /**
-     * Search term — passes `term` into categoryProductSearchInput and uses
+     * Search term — passes `term` into categoryProductSearchInput and uses
      * `config.baseCategoryId` so the whole catalog is searched.
      */
     term?: string;
     /**
-     * Manufacturer/brand name — passes `manufacturers: [brand]` into
+     * Manufacturer/brand name — passes `manufacturers: [brand]` into
      * categoryProductSearchInput and uses `config.baseCategoryId`.
      */
     brand?: string;
+    /** Scope the product fetch to specific orderlist IDs (e.g. a chosen B2B contract). */
+    orderlistIds?: number[];
+    /**
+     * Apply the orderlist filter. Defaults to `true` when `orderlistIds` is
+     * non-empty, `false` otherwise — so an authenticated user without a contract
+     * still sees the full catalogue.
+     */
+    applyOrderlists?: boolean;
     /** Number of columns in the grid. Accepts 2, 3, 4, 5, or 6. Defaults to 3. */
     columns?: number;
     /**
@@ -5450,8 +5510,8 @@ interface ProductGridProps {
     renderClusterCard?: (cluster: Cluster) => any;
     /**
      * Controls portal visibility mode.
-     * 'open'        — full e-commerce; AddToCart is visible in product cards.
-     * 'semi-closed' — catalog-only; AddToCart is hidden.
+     * 'open'        — full e-commerce; AddToCart is visible in product cards.
+     * 'semi-closed' — catalog-only; AddToCart is hidden.
      * Defaults to 'open'.
      */
     portalMode?: string;
@@ -5462,16 +5522,16 @@ interface ProductGridProps {
     /**  * Enables stock validation inside AddToCart.  * Blocks add when requested quantity exceeds available stock.  * Defaults to false.  */ stockValidation?: boolean;
     /**  * When false, hides the AddToCart control in product cards.  * ClusterCards always show their "View cluster" navigation button.  * Defaults to true.  */ allowAddToCart?: boolean;
     /**  * Called after each internal data fetch with the filterable attributes  * returned by the API (for driving a sibling FiltersSidebar).  */ onFiltersChange?: (filters: AttributeFilter[]) => void;
-    /**  * Active text filters to apply — built by the parent from FiltersSidebar  * `onFilterChange` callbacks.  Each entry maps to a `textFilters` input  * row in the CategoryService query.  * When this prop changes the grid automatically re-fetches (page resets to 1).  */ textFilters?: ProductTextFilterInput[];
+    /**  * Active text filters to apply — built by the parent from FiltersSidebar  * `onFilterChange` callbacks.  Each entry maps to a `textFilters` input  * row in the CategoryService query.  * When this prop changes the grid automatically re-fetches (page resets to 1).  */ textFilters?: ProductTextFilterInput[];
     /**  * Active price range lower bound from the FiltersSidebar `onPriceChange`.  * Triggers a re-fetch when changed.  */ priceFilterMin?: number;
     /**  * Active price range upper bound from the FiltersSidebar `onPriceChange`.  * Triggers a re-fetch when changed.  */ priceFilterMax?: number;
     /**  * Called when sort state changes internally (for syncing a sibling toolbar).  */ onSortChange?: (field: string, order: string) => void;
-    /**  * Called after each internal data fetch with the min/max price of the  * current product set — use to populate a price range slider in the parent.  */ onPriceBoundsChange?: (min: number, max: number) => void;
-    /**  * Called after each fetch with the total number of products found —  * use to display a result count in the parent toolbar.  */ onItemsFoundChange?: (count: number) => void;
+    /**  * Called after each internal data fetch with the min/max price of the  * current product set — use to populate a price range slider in the parent.  */ onPriceBoundsChange?: (min: number, max: number) => void;
+    /**  * Called after each fetch with the total number of products found —  * use to display a result count in the parent toolbar.  */ onItemsFoundChange?: (count: number) => void;
     /**  * Called after each fetch with the number of items visible on the current page  * (after client-side language filtering).  */ onPageItemCountChange?: (count: number) => void;
-    /**  * Called when the user clicks Previous / Next in the built-in pagination —  * use to keep the parent URL / page state in sync.  */ onPageChange?: (page: number) => void;
-    /**  * Called after each successful internal data fetch with the full  * ProductsResponse object — use to drive an external GridPagination  * component by passing the result as its `products` prop.  */ onProductsResponse?: (products: ProductsResponse) => void;
-    /**  * Called after each successful internal data fetch with the full  * Category object — use to populate sibling components like GridTitle,  * CategoryDescription, and CategoryShortDescription.  */ onCategoryChange?: (category: Category) => void;
+    /**  * Called when the user clicks Previous / Next in the built-in pagination —  * use to keep the parent URL / page state in sync.  */ onPageChange?: (page: number) => void;
+    /**  * Called after each successful internal data fetch with the full  * ProductsResponse object — use to drive an external GridPagination  * component by passing the result as its `products` prop.  */ onProductsResponse?: (products: ProductsResponse) => void;
+    /**  * Called after each successful internal data fetch with the full  * Category object — use to populate sibling components like GridTitle,  * CategoryDescription, and CategoryShortDescription.  */ onCategoryChange?: (category: Category) => void;
     /**  * Called whenever the internal loading state changes.  * Use to disable sibling components (e.g. GridFilters) while a fetch is in flight.  */ onLoadingChange?: (isLoading: boolean) => void;
     /**  * Externally controlled current page.  * When provided, the grid uses this value instead of its internal page  * counter. Wire this to the `onPageChange` callback from a sibling  * GridPagination so the two components stay in sync.  * When changed the grid automatically re-fetches.  */ page?: number;
     /**  * Number of products per page. Defaults to 12.  * When changed the grid automatically re-fetches (page resets to 1).  */ pageSize?: number;
@@ -5479,9 +5539,9 @@ interface ProductGridProps {
     /**  * Sort direction: 'ASC' or 'DESC'.  * Only used when sortField is also provided.  * When changed the grid automatically re-fetches (page resets to 1).  */ sortOrder?: string;
     /**
      * Configuration object providing:
-     *   imageSearchFiltersGrid, imageVariantFiltersMedium — passed to CategoryService
-     *   baseCategoryId — used when querying by term or brand
-     *   urls.getProductUrl / urls.getClusterUrl — for card URL generation
+     *   imageSearchFiltersGrid, imageVariantFiltersMedium — passed to CategoryService
+     *   baseCategoryId — used when querying by term or brand
+     *   urls.getProductUrl / urls.getClusterUrl — for card URL generation
      */
     configuration?: {
         baseCategoryId?: number;
@@ -5497,7 +5557,7 @@ interface ProductGridProps {
     /** Called after AddToCart creates a new cart internally. */ onCartCreated?: (cart: Cart) => void;
     /** Called after every successful add-to-cart operation. */ afterAddToCart?: (cart: Cart, item?: CartMainItem) => void;
     /**  * When true, AddToCart shows a success modal instead of a toast.  * Defaults to false.  */ showModal?: boolean;
-    /**  * Render − / + stepper buttons in AddToCart.  * Defaults to true.  */ allowIncrDecr?: boolean;
+    /**  * Render − / + stepper buttons in AddToCart.  * Defaults to true.  */ allowIncrDecr?: boolean;
     /** Called when "Proceed to checkout" is clicked in the AddToCart modal. */ onProceedToCheckout?: () => void;
     /** Called when "Request a Quote" is clicked in the AddToCart modal. */ onRequestQuoteClick?: (cart: Cart) => void;
     /**  * Label overrides forwarded directly to the embedded AddToCart component.  * Keys: add, adding, addedToCart, outOfStock, noCartId, errorAdding,  *       modalTitle, quantity, continueShopping, proceedToCheckout  */ addToCartLabels?: Record<string, string>;
@@ -5516,8 +5576,8 @@ interface ProductGridProps {
     clusterCardLabels?: Record<string, string>;
     /** Show a heart-icon favourite toggle on each card. */ enableAddFavorite?: boolean;
     /**  * Called when a favourite is toggled on any card.  * Receives the full Product or Cluster object and the new favourite state.  */ onToggleFavorite?: (item: Product | Cluster, isFavorite: boolean) => void;
-    /**  * Called when a cluster card name, image, or "View cluster" button is  * clicked — use for SPA-style routing instead of full-page navigation.  */ onClusterClick?: (cluster: Cluster) => void;
-    /**  * Called when a product card name or image is clicked — use for SPA  * routing instead of full-page navigation.  */ onProductClick?: (product: Product) => void;
+    /**  * Called when a cluster card name, image, or "View cluster" button is  * clicked — use for SPA-style routing instead of full-page navigation.  */ onClusterClick?: (cluster: Cluster) => void;
+    /**  * Called when a product card name or image is clicked — use for SPA  * routing instead of full-page navigation.  */ onProductClick?: (product: Product) => void;
     /** Extra CSS class applied to the root element. */ className?: string;
     /**
      * Compound API: when provided, the grid renders these children inside a
@@ -5543,6 +5603,14 @@ interface ProductGridProps {
     favoriteComponent?: React$1.ComponentType<_propeller_commerce_propeller_v2_core_ui.FavoriteComponentProps>;
     productCardComponent?: React$1.ComponentType<ProductCardProps>;
     clusterCardComponent?: React$1.ComponentType<ClusterCardProps>;
+    /**
+     * Render arbitrary content directly below each card's product name (and above
+     * the short description / price). Receives the product; return `null` to
+     * render nothing. Cascades to every ProductCard via ProductGridConfig — lets
+     * hosts surface extra per-product info (e.g. package descriptions) without
+     * swapping the whole card.
+     */
+    belowName?: (product: Product) => React$1.ReactNode;
     beforeItem?: (item: Product | Cluster, index: number) => React$1.ReactNode;
     afterItem?: (item: Product | Cluster, index: number) => React$1.ReactNode;
 }
@@ -5556,7 +5624,7 @@ interface ProductGridProps {
 declare function ProductGrid(rawProps: ProductGridProps): React$1.JSX.Element;
 /**
  * The items grid. By default renders `<ProductCard>` / `<ClusterCard>` for
- * each item — but `renderItem` is the proper extension point: pass a
+ * each item — but `renderItem` is the proper extension point: pass a
  * function that returns whatever shape you want (compound `<ProductCard>`
  * with custom subcomponents, a fully custom card, a list row, etc.).
  *
@@ -5575,7 +5643,7 @@ declare function ProductGridItems(props: {
 }): React$1.JSX.Element;
 /**
  * Pagination control wired to the parent ProductGrid context. Compact "Prev /
- * Page X of Y / Next" style by default — a future enhancement could expose
+ * Page X of Y / Next" style by default — a future enhancement could expose
  * `style="full"` matching GridPagination. For complex pagination, render
  * GridPagination directly (it accepts the same context fields as props).
  */
@@ -5598,6 +5666,16 @@ interface ProductInfoProps {
      * Overrides default company for price calculation.
      * Triggers a re-fetch when changed. */
     companyId?: number;
+    /**
+     * Scope the product fetch to specific orderlist IDs (e.g. a chosen B2B
+     * contract). Overrides the default resolution of all the company's orderlists.
+     */
+    orderlistIds?: number[];
+    /**
+     * Apply the orderlist filter. Defaults to `true`; set `false` to browse
+     * unscoped (full catalogue) for an authenticated user without a contract.
+     */
+    applyOrderlists?: boolean;
     /**
      * Pre-fetched product object to display.
      * When provided the component skips internal fetching.
@@ -5631,7 +5709,7 @@ interface ProductInfoProps {
      */
     taxZone?: string;
     /**
-     * Called once the product data is loaded — either immediately (when
+     * Called once the product data is loaded — either immediately (when
      * `product` prop is supplied) or after the internal fetch completes.
      * Use this to hydrate sibling components (gallery, price, descriptions, etc.).
      */
@@ -5829,7 +5907,7 @@ declare function ProductPriceDisplay(props: ProductPriceProps): React$1.JSX.Elem
 declare function ProductPriceWithProvider(rawProps: ProductPriceProps): React$1.JSX.Element;
 
 /**
- * @rsc-safe — Pure display component. No React hooks, no event handlers, no
+ * @rsc-safe — Pure display component. No React hooks, no event handlers, no
  * browser APIs, no context reads. The legacy `'use client'` header was
  * removed in C0 once verified pure. Renders directly
  * from props and can be imported into a React Server Component.
@@ -5957,7 +6035,7 @@ interface ProductSliderProps {
 declare function ProductSlider(rawProps: ProductSliderProps): React$1.JSX.Element;
 
 /**
- * @rsc-blocked — Client-only component: side effects (useEffect).
+ * @rsc-blocked — Client-only component: side effects (useEffect).
  * Must be rendered inside (or below) a Client Component boundary; cannot be
  * imported directly into a React Server Component. The 'use client' header
  * above marks this boundary to Next.js.
@@ -5966,7 +6044,7 @@ declare function ProductSlider(rawProps: ProductSliderProps): React$1.JSX.Elemen
 interface ProductSpecificationsProps {
     /**
      * Initialised Propeller SDK GraphQL client.
-     * Required when `productId` is set — used to fetch public attributes.
+     * Required when `productId` is set — used to fetch public attributes.
      */
     graphqlClient?: GraphQLClient;
     /**
@@ -5985,8 +6063,8 @@ interface ProductSpecificationsProps {
     language?: string;
     /**
      * Display layout for the specifications.
-     * 'table' — two-column table (name | value). Default.
-     * 'list'  — vertical label + value stacked rows.
+     * 'table' — two-column table (name | value). Default.
+     * 'list'  — vertical label + value stacked rows.
      */
     layout?: string;
     /**
@@ -5994,6 +6072,11 @@ interface ProductSpecificationsProps {
      * When false or omitted, displays a flat ungrouped table/list. Default: false.
      */
     grouping?: boolean;
+    /**
+     * Optional package-description string (e.g. contents / packaging notes),
+     * rendered above the attribute table. Omitted when empty.
+     */
+    packageDescription?: string;
     /** Extra CSS class applied to the root element. */
     className?: string;
 }
@@ -6091,6 +6174,12 @@ interface ProductTabsProps {
      * Passed as `grouping` to ProductSpecifications.
      */
     specificationsGrouping?: boolean;
+    /**
+     * Extra package-description string rendered in the specifications section
+     * (e.g. contents / packaging notes). Passed as `packageDescription` to
+     * ProductSpecifications.
+     */
+    specificationsPackageDescription?: string;
     /**
      * Override UI strings for the Downloads section.
      * Available keys: title, download
@@ -6267,7 +6356,7 @@ interface QuoteActionsProps {
 declare function QuoteActions(rawProps: QuoteActionsProps): React$1.JSX.Element;
 
 /**
- * @rsc-blocked — Client-only component: browser-only APIs (window/document/storage).
+ * @rsc-blocked — Client-only component: browser-only APIs (window/document/storage).
  * Must be rendered inside (or below) a Client Component boundary; cannot be
  * imported directly into a React Server Component. The 'use client' header
  * above marks this boundary to Next.js.
@@ -6335,7 +6424,7 @@ interface RegisterFormProps {
      * forwarded so the parent can merge it into the new user's cart.
      */
     afterRegistration?: (user: Contact | Customer, accessToken?: string, refreshToken?: string, expiresAt?: string, anonymousCart?: Cart | null) => void;
-    /** Anonymous cart snapshot from the parent's state — forwarded to `afterRegistration`. */
+    /** Anonymous cart snapshot from the parent's state — forwarded to `afterRegistration`. */
     cart?: Cart | null;
     /** Action for the login link click */
     onLoginClick?: () => void;
@@ -6430,6 +6519,14 @@ interface SearchBarProps {
      * Active company ID from the company switcher.
      */
     companyId?: number;
+    /** Scope the autosuggest fetch to specific orderlist IDs (e.g. a chosen B2B contract). */
+    orderlistIds?: number[];
+    /**
+     * Apply the orderlist filter. Defaults to `true` when `orderlistIds` is
+     * non-empty, `false` otherwise — so an authenticated user without a contract
+     * still sees the full catalogue.
+     */
+    applyOrderlists?: boolean;
     /**
      * Bump this counter to clear the search input from outside (e.g. on route
      * change). Each unique value triggers a one-time reset of the local term.