@propeller-commerce/propeller-v2-react-ui 0.21.0 → 0.23.0

package/dist/index.d.cts

@@ -40,6 +40,14 @@ interface PropellerDeps {
 interface PropellerScope {
     /** The authenticated user, or `null` when browsing anonymously. */
     user: Contact | Customer | null;
+    /**
+     * Whether a session exists, independent of whether `user` has loaded yet.
+     * Hosts paint from a cached hint before the profile arrives, so `user` is
+     * null for an authenticated visitor for the first frames; without this,
+     * semi-closed surfaces flash their logged-out state. Optional — omitting it
+     * keeps the previous behaviour.
+     */
+    isAuthenticated?: boolean;
     /** Active company ID for the current session; `undefined` for non-company users. */
     companyId: number | undefined;
     /** Active language code (e.g. `'NL'`). */
@@ -588,7 +596,11 @@ interface UseCartReturn {
     loading: boolean;
     /** Last error message, or `null`. */
     error: string | null;
-    /** `false` when a B2B purchaser's authorization limit is exceeded by the cart total. */
+    /**
+     * `false` when a B2B purchaser's authorization limit is exceeded by the cart
+     * total, and while a seeded `cartId` is still being hydrated — it fails
+     * closed, so gating a checkout button on it holds rather than opens.
+     */
     checkoutAllowed: boolean;
     /** Resolves an existing cart or creates one via the shared `initCart` flow. */
     resolveCart: () => Promise<Cart>;
@@ -1669,6 +1681,15 @@ interface UseSparePartsOptions {
      * parts list need different languages. Set this when they diverge.
      */
     machineLanguage?: string;
+    /**
+     * Extra languages to try when the slug does not resolve in `machineLanguage`.
+     *
+     * A slug resolves only in the language it was authored in, so a tree that is
+     * only half-translated has machines reachable by an NL slug but not an EN
+     * one. `machineLanguage` and `language` are always tried first; list the
+     * shop's other locales here to cover the rest. Order is the try order.
+     */
+    machineLanguages?: string[];
     /** Tax zone for price calculation. */
     taxZone?: string;
     /** Active user — drives `userId` scoping and contact/customer pricing. */
@@ -1737,6 +1758,14 @@ interface UseSparePartsReturn {
     fetchParts: () => Promise<void>;
     /** Navigate to a page. */
     goToPage: (page: number) => void;
+    /**
+     * The slug resolved in none of the candidate languages.
+     *
+     * Distinct from "resolved but has no parts": this node does not exist, and a
+     * host that renders the usual empty listing for it shows a page built
+     * entirely from the URL. Always `false` in controlled mode.
+     */
+    notFound: boolean;
 }
 /**
  * useSpareParts — fetch and paginate a machine node's spare-parts list.
@@ -2181,8 +2210,13 @@ interface ResolveSpecEntry {
      */
     transform?: (gridValue: NonNullable<ProductGridConfig[GridKey]>) => unknown;
 }
-/** Per-prop resolution spec: maps each prop key to its {@link ResolveSpecEntry}. */
-type ResolveSpec<P> = Partial<Record<keyof P, ResolveSpecEntry>>;
+/**
+ * Per-prop resolution spec: maps each prop key to its {@link ResolveSpecEntry}.
+ *
+ * Infra keys are spec'able too, so a component can pull a provider value it
+ * only reads internally without having to publish it as its own prop.
+ */
+type ResolveSpec<P> = Partial<Record<keyof P | keyof PropellerInfra, ResolveSpecEntry>>;
 /**
  * useResolvedProps — resolves props through the two-tier precedence
  * `explicit prop > ProductGrid context > Propeller infra > default`.
@@ -2191,7 +2225,7 @@ type ResolveSpec<P> = Partial<Record<keyof P, ResolveSpecEntry>>;
  * @param spec - per-key resolution rules; keys absent from the spec pass through unchanged.
  * @returns the props with each spec'd key resolved to its highest-precedence value.
  */
-declare function useResolvedProps<P extends object>(rawProps: P, spec: ResolveSpec<P>): P;
+declare function useResolvedProps<P extends object>(rawProps: P, spec: ResolveSpec<P>): P & Partial<PropellerInfra>;
 
 /**
  * Read the SDK services bundle from `<PropellerDepsProvider>`.
@@ -3496,13 +3530,17 @@ interface CartOverviewProps {
         code: string;
         name: string;
     }[];
+    /** Logged-in user — used for the purchase-authorization check. Resolved from PropellerProvider when omitted. */
+    user?: Contact | Customer | null;
+    /** Active company ID — used for the purchase-authorization check. Resolved from PropellerProvider when omitted. */
+    companyId?: number;
 }
 /**
  * Final cart review panel: shows invoice/delivery addresses, payment, carrier
  * and delivery date, with optional reference, notes, terms acceptance and a
  * place-order button.
  */
-declare function CartOverview(props: CartOverviewProps): React$1.JSX.Element;
+declare function CartOverview(rawProps: CartOverviewProps): React$1.JSX.Element;
 
 /**
  * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
@@ -4195,10 +4233,11 @@ declare function ProductCardPrice(props: {
 /** Renders the embedded `AddToCart` control with all pass-through props from
  *  context, or the injected `addToCartComponent` when set.
  *
- *  Note: the default `AddToCartImpl` accepts a richer prop set (graphqlClient,
- *  configuration, etc.) than the public `AddToCartComponentProps` contract.
- *  Injected components only receive the contract surface; the extra infra
- *  props stay default-only. */
+ *  Note: the default `AddToCartImpl` accepts a richer prop set than the public
+ *  `AddToCartComponentProps` contract. Injected components receive the whole
+ *  contract surface; what stays default-only is infra (graphqlClient, user,
+ *  configuration, …), which an injected component resolves from
+ *  `<PropellerProvider>` itself. */
 declare function ProductCardAddToCart(props: {
     /** Override the AddToCart wrapper class. */
     className?: string;
@@ -4270,6 +4309,16 @@ interface MachineGridProps {
     rootTitle?: string;
     /** Language the machine tree is authored in (usually EN). Defaults to `'EN'`. */
     machineLanguage?: string;
+    /**
+     * Other languages the tree may be authored in, tried in order when a slug
+     * does not resolve in `machineLanguage`.
+     *
+     * A slug resolves only in its own language, so a half-translated tree lists a
+     * machine by its NL slug and then cannot open it with `language: 'EN'`. Pass
+     * the shop's locales here; `machineLanguage` and the storefront `language`
+     * are always tried first (PWP-993).
+     */
+    machineLanguages?: string[];
     listing: MachineListingState;
     onListingChange: (next: MachineListingState) => void;
     graphqlClient?: GraphQLClient;
@@ -4309,9 +4358,19 @@ interface MachineGridProps {
     filtersLabels?: Record<string, string>;
     toolbarLabels?: Record<string, string>;
     /**
-     * Labels for the machine side of the grid. Keys read here: `loading` and
-     * `noMachines`. The same object is passed to each `MachineCard` as its
-     * `labels`, which reads `viewMachine` — so all three keys belong in it.
+     * Labels for the machine side of the grid.
+     *
+     * Keys read here: `loading`, `noMachines`, `machineNotFound`,
+     * `quantityInMachine` and `searchParts`. The same object is passed to each
+     * `MachineCard` as its `labels`, which reads `viewMachine` — so all six keys
+     * belong in it.
+     *
+     * `quantityInMachine` and `searchParts` used to be read from `toolbarLabels`,
+     * which is forwarded verbatim to `GridToolbar`: a shop that translated its
+     * toolbar dictionary properly still got "Qty in machine" and "Search parts…"
+     * in English, because those keys belong to no toolbar (PWP-995a). They are
+     * still read from `toolbarLabels` as a fallback so existing hosts keep
+     * working.
      */
     machineCardLabels?: Record<string, string>;
     /**
@@ -4549,6 +4608,8 @@ interface CompanySwitcherProps {
     /** Translated labels keyed by the slugs used inside the component (see
      * `getLabel` calls). Missing keys fall back to the English defaults. */
     labels?: Record<string, string>;
+    /** Additional class name for the switcher's trigger button. */
+    triggerClassName?: string;
 }
 /**
  * Dropdown for switching the active company of a multi-company contact.
@@ -6155,6 +6216,12 @@ interface ProductBulkPricesProps {
      * Defaults to 'open'.
      */
     portalMode?: string;
+    /**
+     * Whether a session exists, independent of whether `user` has loaded yet.
+     * Passed down by the parent alongside `portalMode`; closes the hydration
+     * window in which an authenticated visitor still has a null `user`.
+     */
+    isAuthenticated?: boolean;
     /** Authenticated user — used for semi-closed visibility. */
     user?: Contact | Customer | null;
     /** Tax zone code. Defaults to 'NL'. */
@@ -6694,6 +6761,15 @@ interface ProductInfoProps {
      * Example: ['brand', 'color']
      */
     textLabels?: string[];
+    /** Cart to add into. Omit and pass `createCart` to start one on first add. */
+    cartId?: string;
+    /** If true a new cart is created when no `cartId` is available. */
+    createCart?: boolean;
+    /**
+     * Called when a new cart is created, so the host can persist `cart.cartId`.
+     * WARNING: without it a new cart is created on every add.
+     */
+    onCartCreated?: (cart: Cart) => void;
     showImage?: boolean;
     showBadges?: boolean;
     showFavorite?: boolean;
@@ -6837,6 +6913,12 @@ interface ProductPriceProps {
      * Defaults to 'open'.
      */
     portalMode?: string;
+    /**
+     * Whether a session exists, independent of whether `user` has loaded yet.
+     * Passed down by the parent alongside `portalMode`; closes the hydration
+     * window in which an authenticated visitor still has a null `user`.
+     */
+    isAuthenticated?: boolean;
     /** Authenticated user — used for semi-closed visibility. */
     user?: Contact | Customer | null;
     /**

package/dist/index.d.ts

@@ -40,6 +40,14 @@ interface PropellerDeps {
 interface PropellerScope {
     /** The authenticated user, or `null` when browsing anonymously. */
     user: Contact | Customer | null;
+    /**
+     * Whether a session exists, independent of whether `user` has loaded yet.
+     * Hosts paint from a cached hint before the profile arrives, so `user` is
+     * null for an authenticated visitor for the first frames; without this,
+     * semi-closed surfaces flash their logged-out state. Optional — omitting it
+     * keeps the previous behaviour.
+     */
+    isAuthenticated?: boolean;
     /** Active company ID for the current session; `undefined` for non-company users. */
     companyId: number | undefined;
     /** Active language code (e.g. `'NL'`). */
@@ -588,7 +596,11 @@ interface UseCartReturn {
     loading: boolean;
     /** Last error message, or `null`. */
     error: string | null;
-    /** `false` when a B2B purchaser's authorization limit is exceeded by the cart total. */
+    /**
+     * `false` when a B2B purchaser's authorization limit is exceeded by the cart
+     * total, and while a seeded `cartId` is still being hydrated — it fails
+     * closed, so gating a checkout button on it holds rather than opens.
+     */
     checkoutAllowed: boolean;
     /** Resolves an existing cart or creates one via the shared `initCart` flow. */
     resolveCart: () => Promise<Cart>;
@@ -1669,6 +1681,15 @@ interface UseSparePartsOptions {
      * parts list need different languages. Set this when they diverge.
      */
     machineLanguage?: string;
+    /**
+     * Extra languages to try when the slug does not resolve in `machineLanguage`.
+     *
+     * A slug resolves only in the language it was authored in, so a tree that is
+     * only half-translated has machines reachable by an NL slug but not an EN
+     * one. `machineLanguage` and `language` are always tried first; list the
+     * shop's other locales here to cover the rest. Order is the try order.
+     */
+    machineLanguages?: string[];
     /** Tax zone for price calculation. */
     taxZone?: string;
     /** Active user — drives `userId` scoping and contact/customer pricing. */
@@ -1737,6 +1758,14 @@ interface UseSparePartsReturn {
     fetchParts: () => Promise<void>;
     /** Navigate to a page. */
     goToPage: (page: number) => void;
+    /**
+     * The slug resolved in none of the candidate languages.
+     *
+     * Distinct from "resolved but has no parts": this node does not exist, and a
+     * host that renders the usual empty listing for it shows a page built
+     * entirely from the URL. Always `false` in controlled mode.
+     */
+    notFound: boolean;
 }
 /**
  * useSpareParts — fetch and paginate a machine node's spare-parts list.
@@ -2181,8 +2210,13 @@ interface ResolveSpecEntry {
      */
     transform?: (gridValue: NonNullable<ProductGridConfig[GridKey]>) => unknown;
 }
-/** Per-prop resolution spec: maps each prop key to its {@link ResolveSpecEntry}. */
-type ResolveSpec<P> = Partial<Record<keyof P, ResolveSpecEntry>>;
+/**
+ * Per-prop resolution spec: maps each prop key to its {@link ResolveSpecEntry}.
+ *
+ * Infra keys are spec'able too, so a component can pull a provider value it
+ * only reads internally without having to publish it as its own prop.
+ */
+type ResolveSpec<P> = Partial<Record<keyof P | keyof PropellerInfra, ResolveSpecEntry>>;
 /**
  * useResolvedProps — resolves props through the two-tier precedence
  * `explicit prop > ProductGrid context > Propeller infra > default`.
@@ -2191,7 +2225,7 @@ type ResolveSpec<P> = Partial<Record<keyof P, ResolveSpecEntry>>;
  * @param spec - per-key resolution rules; keys absent from the spec pass through unchanged.
  * @returns the props with each spec'd key resolved to its highest-precedence value.
  */
-declare function useResolvedProps<P extends object>(rawProps: P, spec: ResolveSpec<P>): P;
+declare function useResolvedProps<P extends object>(rawProps: P, spec: ResolveSpec<P>): P & Partial<PropellerInfra>;
 
 /**
  * Read the SDK services bundle from `<PropellerDepsProvider>`.
@@ -3496,13 +3530,17 @@ interface CartOverviewProps {
         code: string;
         name: string;
     }[];
+    /** Logged-in user — used for the purchase-authorization check. Resolved from PropellerProvider when omitted. */
+    user?: Contact | Customer | null;
+    /** Active company ID — used for the purchase-authorization check. Resolved from PropellerProvider when omitted. */
+    companyId?: number;
 }
 /**
  * Final cart review panel: shows invoice/delivery addresses, payment, carrier
  * and delivery date, with optional reference, notes, terms acceptance and a
  * place-order button.
  */
-declare function CartOverview(props: CartOverviewProps): React$1.JSX.Element;
+declare function CartOverview(rawProps: CartOverviewProps): React$1.JSX.Element;
 
 /**
  * @rsc-blocked — Client-only component: interactive state (useState/useReducer).
@@ -4195,10 +4233,11 @@ declare function ProductCardPrice(props: {
 /** Renders the embedded `AddToCart` control with all pass-through props from
  *  context, or the injected `addToCartComponent` when set.
  *
- *  Note: the default `AddToCartImpl` accepts a richer prop set (graphqlClient,
- *  configuration, etc.) than the public `AddToCartComponentProps` contract.
- *  Injected components only receive the contract surface; the extra infra
- *  props stay default-only. */
+ *  Note: the default `AddToCartImpl` accepts a richer prop set than the public
+ *  `AddToCartComponentProps` contract. Injected components receive the whole
+ *  contract surface; what stays default-only is infra (graphqlClient, user,
+ *  configuration, …), which an injected component resolves from
+ *  `<PropellerProvider>` itself. */
 declare function ProductCardAddToCart(props: {
     /** Override the AddToCart wrapper class. */
     className?: string;
@@ -4270,6 +4309,16 @@ interface MachineGridProps {
     rootTitle?: string;
     /** Language the machine tree is authored in (usually EN). Defaults to `'EN'`. */
     machineLanguage?: string;
+    /**
+     * Other languages the tree may be authored in, tried in order when a slug
+     * does not resolve in `machineLanguage`.
+     *
+     * A slug resolves only in its own language, so a half-translated tree lists a
+     * machine by its NL slug and then cannot open it with `language: 'EN'`. Pass
+     * the shop's locales here; `machineLanguage` and the storefront `language`
+     * are always tried first (PWP-993).
+     */
+    machineLanguages?: string[];
     listing: MachineListingState;
     onListingChange: (next: MachineListingState) => void;
     graphqlClient?: GraphQLClient;
@@ -4309,9 +4358,19 @@ interface MachineGridProps {
     filtersLabels?: Record<string, string>;
     toolbarLabels?: Record<string, string>;
     /**
-     * Labels for the machine side of the grid. Keys read here: `loading` and
-     * `noMachines`. The same object is passed to each `MachineCard` as its
-     * `labels`, which reads `viewMachine` — so all three keys belong in it.
+     * Labels for the machine side of the grid.
+     *
+     * Keys read here: `loading`, `noMachines`, `machineNotFound`,
+     * `quantityInMachine` and `searchParts`. The same object is passed to each
+     * `MachineCard` as its `labels`, which reads `viewMachine` — so all six keys
+     * belong in it.
+     *
+     * `quantityInMachine` and `searchParts` used to be read from `toolbarLabels`,
+     * which is forwarded verbatim to `GridToolbar`: a shop that translated its
+     * toolbar dictionary properly still got "Qty in machine" and "Search parts…"
+     * in English, because those keys belong to no toolbar (PWP-995a). They are
+     * still read from `toolbarLabels` as a fallback so existing hosts keep
+     * working.
      */
     machineCardLabels?: Record<string, string>;
     /**
@@ -4549,6 +4608,8 @@ interface CompanySwitcherProps {
     /** Translated labels keyed by the slugs used inside the component (see
      * `getLabel` calls). Missing keys fall back to the English defaults. */
     labels?: Record<string, string>;
+    /** Additional class name for the switcher's trigger button. */
+    triggerClassName?: string;
 }
 /**
  * Dropdown for switching the active company of a multi-company contact.
@@ -6155,6 +6216,12 @@ interface ProductBulkPricesProps {
      * Defaults to 'open'.
      */
     portalMode?: string;
+    /**
+     * Whether a session exists, independent of whether `user` has loaded yet.
+     * Passed down by the parent alongside `portalMode`; closes the hydration
+     * window in which an authenticated visitor still has a null `user`.
+     */
+    isAuthenticated?: boolean;
     /** Authenticated user — used for semi-closed visibility. */
     user?: Contact | Customer | null;
     /** Tax zone code. Defaults to 'NL'. */
@@ -6694,6 +6761,15 @@ interface ProductInfoProps {
      * Example: ['brand', 'color']
      */
     textLabels?: string[];
+    /** Cart to add into. Omit and pass `createCart` to start one on first add. */
+    cartId?: string;
+    /** If true a new cart is created when no `cartId` is available. */
+    createCart?: boolean;
+    /**
+     * Called when a new cart is created, so the host can persist `cart.cartId`.
+     * WARNING: without it a new cart is created on every add.
+     */
+    onCartCreated?: (cart: Cart) => void;
     showImage?: boolean;
     showBadges?: boolean;
     showFavorite?: boolean;
@@ -6837,6 +6913,12 @@ interface ProductPriceProps {
      * Defaults to 'open'.
      */
     portalMode?: string;
+    /**
+     * Whether a session exists, independent of whether `user` has loaded yet.
+     * Passed down by the parent alongside `portalMode`; closes the hydration
+     * window in which an authenticated visitor still has a null `user`.
+     */
+    isAuthenticated?: boolean;
     /** Authenticated user — used for semi-closed visibility. */
     user?: Contact | Customer | null;
     /**