@propeller-commerce/propeller-v2-react-ui 0.16.0 → 0.18.0

package/dist/index.d.cts

@@ -894,6 +894,13 @@ interface FavoriteListFormData {
     isDefault: boolean;
 }
 /** Options for {@link useFavorites}. */
+/** What a favorite-list mutation did — see `onListChanged`. */
+interface FavoriteListChange {
+    action: 'created' | 'updated' | 'deleted';
+    listId?: string | number;
+    name?: string;
+    isDefault?: boolean;
+}
 interface UseFavoritesOptions {
     /** GraphQL client the hook derives its Services bundle from. */
     graphqlClient: GraphQLClient;
@@ -908,7 +915,15 @@ interface UseFavoritesOptions {
     /** Override: fires instead of the default `deleteFavoriteList` call. */
     onDelete?: (id: string) => void;
     /** Fires after any list create / update / delete completes. */
-    onListChanged?: () => void;
+    /**
+     * Called after a list mutation succeeds.
+     *
+     * The `change` argument is optional so existing zero-argument callbacks keep
+     * working, but without it a host cannot tell a create from a delete — which
+     * makes the hook useless for analytics, audit trails or optimistic UI that
+     * needs to know WHAT happened rather than merely THAT something did.
+     */
+    onListChanged?: (change?: FavoriteListChange) => void;
 }
 /** State and favorite-list actions returned by {@link useFavorites}. */
 interface UseFavoritesReturn {
@@ -1412,6 +1427,9 @@ interface UseProductSearchOptions {
     /** Portal configuration: base category fallback plus image filters. */
     configuration: {
         baseCategoryId?: number;
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
         imageSearchFiltersGrid?: MediaImageProductSearchInput;
         imageVariantFiltersMedium?: TransformationsInput;
     };
@@ -1547,6 +1565,9 @@ interface UseQuickOrderOptions {
         imageVariantFiltersSmall?: TransformationsInput;
         /** Catalog root. Without it the search returns nothing — see `searchProducts`. */
         baseCategoryId?: number;
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
     };
     /** Fires when `submit` creates a fresh cart — persist the cart id. */
     onCartCreated?: (cart: Cart) => void;
@@ -1659,6 +1680,9 @@ interface UseSparePartsOptions {
     pageSize?: number;
     /** Image filter config, mirroring `useProductSearch`'s `configuration`. */
     configuration?: {
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
         imageSearchFiltersGrid?: unknown;
         imageVariantFiltersMedium?: unknown;
     };
@@ -1773,6 +1797,9 @@ interface UseProductSliderOptions {
     companyId?: number;
     /** Portal configuration: image search/variant filters. */
     configuration?: {
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
         imageSearchFiltersGrid?: MediaImageProductSearchInput;
         imageVariantFiltersMedium?: TransformationsInput;
     };
@@ -2779,6 +2806,13 @@ interface AddToCartEvents {
 declare function AddToCart(rawProps: AddToCartProps): React$1.JSX.Element;
 declare const _default$1: React$1.MemoExoticComponent<typeof AddToCart>;
 
+/** Which way the favorite toggle went — see `onFavoriteChanged`. */
+interface FavoriteChange {
+    action: 'added' | 'removed';
+    listId?: string | number;
+    productId?: number;
+    clusterId?: number;
+}
 interface AddToFavoriteProps {
     /** The initialized GraphQL Client instance. Resolved from PropellerProvider when omitted. */
     graphqlClient?: GraphQLClient;
@@ -2793,7 +2827,15 @@ interface AddToFavoriteProps {
     /** UI string overrides */
     labels?: Record<string, string>;
     /** Called after a favorite list mutation (add/remove) succeeds */
-    onFavoriteChanged?: () => void;
+    /**
+     * Called after the favorite toggle succeeds, with which way it went.
+     *
+     * The argument is optional so existing zero-argument callbacks keep working.
+     * Without it an add and a removal are indistinguishable, so a host cannot
+     * report "added to wishlist" without inventing the direction — and a
+     * wishlist metric that also counts removals is worse than none.
+     */
+    onFavoriteChanged?: (change?: FavoriteChange) => void;
 }
 /**
  * Favorite toggle button for a product or cluster: opens a modal to add the
@@ -4531,8 +4573,12 @@ interface FavoriteListsProps {
     }) => void;
     /** Action function triggered when deleting a favorite list. If not provided, the default action is executed */
     onDelete?: (favoriteListId: string) => void;
-    /** Called after any list mutation (create, edit, delete) succeeds */
-    onListChanged?: () => void;
+    /**
+     * Called after any list mutation succeeds, with what it did.
+     *
+     * The argument is optional so existing zero-argument callbacks keep working.
+     */
+    onListChanged?: (change?: FavoriteListChange) => void;
 }
 /**
  * Lists the user's favorite lists with inline edit, delete and create-list
@@ -5418,6 +5464,9 @@ interface QuickOrderProps {
          * has no access to.
          */
         baseCategoryId?: number;
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
     };
     /** Tax zone for price calculation. Defaults to `'NL'`. */
     taxZone?: string;
@@ -5440,6 +5489,12 @@ interface QuickOrderProps {
     parseSpreadsheet?: (file: File) => Promise<QuickOrderUploadLine[]>;
     /** URL to a downloadable XLSX template (shown next to the upload control). */
     templateUrl?: string;
+    /**
+     * Called when the template link is clicked. Navigation is untouched — this is
+     * a notification, not a handler: a buyer fetching the template is a
+     * quick-order intent signal that otherwise leaves no trace at all.
+     */
+    onTemplateDownload?: () => void;
     /** Max upload file size in bytes. Defaults to 2 MB. */
     maxUploadBytes?: number;
     /** Max rows accepted from an upload. Defaults to 500. */
@@ -6312,6 +6367,9 @@ interface ProductGridProps {
      */
     configuration?: {
         baseCategoryId?: number;
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
         imageSearchFiltersGrid?: MediaImageProductSearchInput;
         imageVariantFiltersMedium?: TransformationsInput;
         urls?: {

package/dist/index.d.ts

@@ -894,6 +894,13 @@ interface FavoriteListFormData {
     isDefault: boolean;
 }
 /** Options for {@link useFavorites}. */
+/** What a favorite-list mutation did — see `onListChanged`. */
+interface FavoriteListChange {
+    action: 'created' | 'updated' | 'deleted';
+    listId?: string | number;
+    name?: string;
+    isDefault?: boolean;
+}
 interface UseFavoritesOptions {
     /** GraphQL client the hook derives its Services bundle from. */
     graphqlClient: GraphQLClient;
@@ -908,7 +915,15 @@ interface UseFavoritesOptions {
     /** Override: fires instead of the default `deleteFavoriteList` call. */
     onDelete?: (id: string) => void;
     /** Fires after any list create / update / delete completes. */
-    onListChanged?: () => void;
+    /**
+     * Called after a list mutation succeeds.
+     *
+     * The `change` argument is optional so existing zero-argument callbacks keep
+     * working, but without it a host cannot tell a create from a delete — which
+     * makes the hook useless for analytics, audit trails or optimistic UI that
+     * needs to know WHAT happened rather than merely THAT something did.
+     */
+    onListChanged?: (change?: FavoriteListChange) => void;
 }
 /** State and favorite-list actions returned by {@link useFavorites}. */
 interface UseFavoritesReturn {
@@ -1412,6 +1427,9 @@ interface UseProductSearchOptions {
     /** Portal configuration: base category fallback plus image filters. */
     configuration: {
         baseCategoryId?: number;
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
         imageSearchFiltersGrid?: MediaImageProductSearchInput;
         imageVariantFiltersMedium?: TransformationsInput;
     };
@@ -1547,6 +1565,9 @@ interface UseQuickOrderOptions {
         imageVariantFiltersSmall?: TransformationsInput;
         /** Catalog root. Without it the search returns nothing — see `searchProducts`. */
         baseCategoryId?: number;
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
     };
     /** Fires when `submit` creates a fresh cart — persist the cart id. */
     onCartCreated?: (cart: Cart) => void;
@@ -1659,6 +1680,9 @@ interface UseSparePartsOptions {
     pageSize?: number;
     /** Image filter config, mirroring `useProductSearch`'s `configuration`. */
     configuration?: {
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
         imageSearchFiltersGrid?: unknown;
         imageVariantFiltersMedium?: unknown;
     };
@@ -1773,6 +1797,9 @@ interface UseProductSliderOptions {
     companyId?: number;
     /** Portal configuration: image search/variant filters. */
     configuration?: {
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
         imageSearchFiltersGrid?: MediaImageProductSearchInput;
         imageVariantFiltersMedium?: TransformationsInput;
     };
@@ -2779,6 +2806,13 @@ interface AddToCartEvents {
 declare function AddToCart(rawProps: AddToCartProps): React$1.JSX.Element;
 declare const _default$1: React$1.MemoExoticComponent<typeof AddToCart>;
 
+/** Which way the favorite toggle went — see `onFavoriteChanged`. */
+interface FavoriteChange {
+    action: 'added' | 'removed';
+    listId?: string | number;
+    productId?: number;
+    clusterId?: number;
+}
 interface AddToFavoriteProps {
     /** The initialized GraphQL Client instance. Resolved from PropellerProvider when omitted. */
     graphqlClient?: GraphQLClient;
@@ -2793,7 +2827,15 @@ interface AddToFavoriteProps {
     /** UI string overrides */
     labels?: Record<string, string>;
     /** Called after a favorite list mutation (add/remove) succeeds */
-    onFavoriteChanged?: () => void;
+    /**
+     * Called after the favorite toggle succeeds, with which way it went.
+     *
+     * The argument is optional so existing zero-argument callbacks keep working.
+     * Without it an add and a removal are indistinguishable, so a host cannot
+     * report "added to wishlist" without inventing the direction — and a
+     * wishlist metric that also counts removals is worse than none.
+     */
+    onFavoriteChanged?: (change?: FavoriteChange) => void;
 }
 /**
  * Favorite toggle button for a product or cluster: opens a modal to add the
@@ -4531,8 +4573,12 @@ interface FavoriteListsProps {
     }) => void;
     /** Action function triggered when deleting a favorite list. If not provided, the default action is executed */
     onDelete?: (favoriteListId: string) => void;
-    /** Called after any list mutation (create, edit, delete) succeeds */
-    onListChanged?: () => void;
+    /**
+     * Called after any list mutation succeeds, with what it did.
+     *
+     * The argument is optional so existing zero-argument callbacks keep working.
+     */
+    onListChanged?: (change?: FavoriteListChange) => void;
 }
 /**
  * Lists the user's favorite lists with inline edit, delete and create-list
@@ -5418,6 +5464,9 @@ interface QuickOrderProps {
          * has no access to.
          */
         baseCategoryId?: number;
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
     };
     /** Tax zone for price calculation. Defaults to `'NL'`. */
     taxZone?: string;
@@ -5440,6 +5489,12 @@ interface QuickOrderProps {
     parseSpreadsheet?: (file: File) => Promise<QuickOrderUploadLine[]>;
     /** URL to a downloadable XLSX template (shown next to the upload control). */
     templateUrl?: string;
+    /**
+     * Called when the template link is clicked. Navigation is untouched — this is
+     * a notification, not a handler: a buyer fetching the template is a
+     * quick-order intent signal that otherwise leaves no trace at all.
+     */
+    onTemplateDownload?: () => void;
     /** Max upload file size in bytes. Defaults to 2 MB. */
     maxUploadBytes?: number;
     /** Max rows accepted from an upload. Defaults to 500. */
@@ -6312,6 +6367,9 @@ interface ProductGridProps {
      */
     configuration?: {
         baseCategoryId?: number;
+        /** The channel's anonymous user, seeded by the host. Scopes logged-out
+         *  listings exactly like the SSR seed does (PWP-942 #22). */
+        anonymousUserId?: number;
         imageSearchFiltersGrid?: MediaImageProductSearchInput;
         imageVariantFiltersMedium?: TransformationsInput;
         urls?: {