@propeller-commerce/propeller-v2-react-ui 0.11.4 → 0.13.0

package/CHANGELOG.md

@@ -8,6 +8,71 @@ once it reaches 1.0. Until then (the `0.x` line) the public API may change
 between minor versions; breaking changes are called out below and in
 [MIGRATION.md](./MIGRATION.md).
 
+## [0.13.0] - 2026-08-05
+
+### Added
+
+- **Availability filter on `<GridFilters>`** — an opt-in section below the
+  price block with two checkboxes, In stock and Out of stock, wired to the
+  server-side stock filter the SDK exposes on `CategoryProductSearchInput`.
+  New props: `showAvailabilityFilter` (defaults `false`),
+  `activeAvailability` and `onAvailabilityChange`. Nothing selected sends no
+  filter, so the default listing is unchanged.
+
+  Selecting both buckets means "in stock or out of stock", which is every
+  product. The filter has no OR operator and the union is the unfiltered set
+  anyway, so both-selected sends no filter — the same as selecting neither.
+  The checkboxes stay ticked; only the request collapses.
+
+  The mapping lives in `propeller-v2-core-ui`'s `buildInventoryFilter`, so
+  this package never restates the operator semantics. Requires
+  `propeller-v2-core-ui` >= 0.5.0 and `propeller-sdk-v2` >= 0.15.0, where the
+  inventory filter was added.
+
+- **`availability` and `onAvailabilityFilterRemove` on `<GridToolbar>`** —
+  the active-filter row now renders one removable chip per selected bucket,
+  so a stock-filtered listing shows why its results are narrowed and can be
+  undone from the results area. One chip per bucket, matching the attribute
+  chips rather than the price chip which covers a whole range. The row's
+  active check accounts for availability, so it appears when availability is
+  the only active filter.
+
+- **`availability` on `<ProductGrid>`** — forwards the selection to
+  `useProductSearch`, which applies it to both the grid fetch and the
+  typeahead preview. Filtering only the grid would let the preview offer
+  products the grid then hides.
+
+### Changed
+
+- The availability section is hidden for anonymous visitors in a semi-closed
+  portal, the same rule the price filter already follows. Hosts should pass
+  their own "show stock" setting through `showAvailabilityFilter`: filtering
+  by stock reads as broken when the cards display no stock to filter on.
+
+## [0.12.0] - 2026-07-31
+
+### Added
+
+- **`productTrackAttributes` on `<ProductGrid>`, `<SearchBar>` and
+  `useProductSearch`.** Pass the attribute names a card renders — e.g.
+  `productTrackAttributes={['MPN']}` — and they arrive on
+  `product.attributes` for every item in the result, ready to read from a
+  card slot like `belowName`. `useProductInfo` has had an option of this name
+  since the PDP work; the grid side simply never forwarded one, so hosts that
+  set it in their portal config saw it silently ignored on listings and had
+  to fetch attributes themselves in a second request.
+
+  Requires `propeller-sdk-v2` >= 0.16.0, where the `category` and `products`
+  operations gained `$attributeResultSearchInput` and `ProductGridFields`
+  gained the matching `attributes(input:)` selection.
+
+  Naming the attributes you render is not just a payload optimisation — it is
+  the correct behaviour. With no input the server returns the *first page* of
+  a product's attributes (12 per product), so on a product carrying more than
+  12 the ones on later pages are missing with no error. Filtering to the names
+  you need also cut a 24-product category response from ~168 KB to ~124 KB in
+  our testing.
+
 ## [0.11.4] - 2026-07-31
 
 ### Fixed

package/dist/index.cjs

@@ -2090,7 +2090,7 @@ function useProductInfo(options) {
     if (options.user && "customerId" in options.user) input.customerId = options.user.customerId;
     return input;
   }
-  function buildAttributeInput() {
+  function buildAttributeInput2() {
     const names = options.productTrackAttributes;
     if (!names || names.length === 0) return void 0;
     return { attributeDescription: { names } };
@@ -2113,7 +2113,7 @@ function useProductInfo(options) {
         orderlistIds = (orderlists?.items ?? []).map((ol) => ol.id);
       }
       const service = propellerV2CoreUi.createServices(graphqlClient).product;
-      const attributeInput = buildAttributeInput();
+      const attributeInput = buildAttributeInput2();
       const variables = {
         productId,
         language,
@@ -2203,6 +2203,10 @@ function useProductInfo(options) {
   };
 }
 var inflightFetches2 = /* @__PURE__ */ new Set();
+function buildAttributeInput(names) {
+  if (!names || names.length === 0) return void 0;
+  return { attributeDescription: { names } };
+}
 function useProductSearch(options) {
   const { graphqlClient, configuration } = options;
   const isControlled = options.products !== void 0;
@@ -2257,7 +2261,8 @@ function useProductSearch(options) {
       userKey,
       JSON.stringify(options.textFilters ?? []),
       options.priceFilterMin ?? "",
-      options.priceFilterMax ?? ""
+      options.priceFilterMax ?? "",
+      JSON.stringify(options.availability ?? [])
     ].join("|");
     if (inflightFetches2.has(inflightKey)) {
       fetchIdRef.current--;
@@ -2299,6 +2304,7 @@ function useProductSearch(options) {
         }
       ] : [];
       const priceFilter = options.priceFilterMin !== void 0 || options.priceFilterMax !== void 0 ? { from: options.priceFilterMin ?? 0, to: options.priceFilterMax ?? 999999 } : void 0;
+      const inventoryFilter = propellerV2CoreUi.buildInventoryFilter(options.availability);
       const userId = options.user && "contactId" in options.user ? options.user.contactId : options.user && "customerId" in options.user ? options.user.customerId : void 0;
       const contactId = options.user && "contactId" in options.user ? options.user.contactId : void 0;
       const customerId = options.user && "customerId" in options.user ? options.user.customerId : void 0;
@@ -2321,6 +2327,7 @@ function useProductSearch(options) {
         ...options.brand && { manufacturers: [options.brand] },
         ...options.textFilters?.length && { textFilters: options.textFilters },
         ...priceFilter && { price: priceFilter },
+        ...inventoryFilter && { inventory: inventoryFilter },
         ...sortInputs.length && { sortInputs },
         ...options.companyId && { companyId: options.companyId },
         ...userId !== void 0 && { userId },
@@ -2335,6 +2342,7 @@ function useProductSearch(options) {
       const filterAvailableAttributeInput = {
         isSearchable: true
       };
+      const attributeInput = buildAttributeInput(options.productTrackAttributes);
       const variables = {
         categoryId: catId,
         language: lang,
@@ -2342,7 +2350,8 @@ function useProductSearch(options) {
         priceCalculateProductInput,
         filterAvailableAttributeInput,
         imageSearchFilters: configuration?.imageSearchFiltersGrid,
-        imageVariantFilters: configuration?.imageVariantFiltersMedium
+        imageVariantFilters: configuration?.imageVariantFiltersMedium,
+        ...attributeInput && { attributeResultSearchInput: attributeInput }
       };
       const response = await service.getCategory(variables);
       if (thisId !== fetchIdRef.current) return;
@@ -2395,6 +2404,7 @@ function useProductSearch(options) {
     options.textFilters,
     options.priceFilterMin,
     options.priceFilterMax,
+    options.availability,
     options.sortField,
     options.sortOrder,
     options.companyId,
@@ -2403,7 +2413,9 @@ function useProductSearch(options) {
     taxZone,
     pageSize,
     pagination.currentPage,
-    configuration
+    configuration,
+    // Stringified: callers pass an array literal, so identity changes each render.
+    JSON.stringify(options.productTrackAttributes ?? [])
   ]);
   const search = React6.useCallback(
     (term) => {
@@ -2432,6 +2444,7 @@ function useProductSearch(options) {
           const userId = options.user && "contactId" in options.user ? options.user.contactId : options.user && "customerId" in options.user ? options.user.customerId : void 0;
           const contactId = options.user && "contactId" in options.user ? options.user.contactId : void 0;
           const customerId = options.user && "customerId" in options.user ? options.user.customerId : void 0;
+          const inventoryFilter = propellerV2CoreUi.buildInventoryFilter(options.availability);
           const categoryProductSearchInput = {
             language,
             page: 1,
@@ -2443,6 +2456,7 @@ function useProductSearch(options) {
               propellerSdkV2.ProductStatus.S
             ],
             hidden: false,
+            ...inventoryFilter && { inventory: inventoryFilter },
             term,
             searchFields: [
               {
@@ -2482,13 +2496,15 @@ function useProductSearch(options) {
             ...contactId !== void 0 && { contactId },
             ...customerId !== void 0 && { customerId }
           };
+          const attributeInput = buildAttributeInput(options.productTrackAttributes);
           const variables = {
             categoryId: catId,
             language,
             categoryProductSearchInput,
             priceCalculateProductInput,
             imageSearchFilters: configuration?.imageSearchFiltersGrid,
-            imageVariantFilters: configuration?.imageVariantFiltersMedium
+            imageVariantFilters: configuration?.imageVariantFiltersMedium,
+            ...attributeInput && { attributeResultSearchInput: attributeInput }
           };
           const response = await service.getCategory(variables);
           const productsResponse = response?.products;
@@ -2507,7 +2523,7 @@ function useProductSearch(options) {
       }, 300);
     },
     // eslint-disable-next-line react-hooks/exhaustive-deps
-    [graphqlClient, language, configuration, userKey, JSON.stringify(options.orderlistIds ?? []), options.applyOrderlists]
+    [graphqlClient, language, configuration, userKey, JSON.stringify(options.orderlistIds ?? []), options.applyOrderlists, JSON.stringify(options.productTrackAttributes ?? [])]
   );
   React6.useEffect(() => {
     if (!isControlled) fetchProducts();
@@ -2520,6 +2536,7 @@ function useProductSearch(options) {
     JSON.stringify(options.textFilters),
     options.priceFilterMin,
     options.priceFilterMax,
+    options.availability,
     options.sortField,
     options.sortOrder,
     pageSize,
@@ -9034,6 +9051,7 @@ function ProductGrid(rawProps) {
     brand: props.brand,
     orderlistIds: props.orderlistIds,
     applyOrderlists: props.applyOrderlists,
+    productTrackAttributes: props.productTrackAttributes,
     language: props.language,
     taxZone: props.taxZone,
     user: props.user,
@@ -9041,6 +9059,7 @@ function ProductGrid(rawProps) {
     textFilters: props.textFilters,
     priceFilterMin: props.priceFilterMin,
     priceFilterMax: props.priceFilterMax,
+    availability: props.availability,
     sortField: props.sortField,
     sortOrder: props.sortOrder,
     pageSize: props.pageSize,
@@ -9343,11 +9362,18 @@ function GridFilters(rawProps) {
   const [isPending, setIsPending] = React6.useState(() => false);
   const [appliedMin, setAppliedMin] = React6.useState(() => void 0);
   const [appliedMax, setAppliedMax] = React6.useState(() => void 0);
+  const [availability, setAvailability] = React6.useState(
+    () => [...props.activeAvailability || []]
+  );
   function showPriceFilter() {
     const mode = props.portalMode || "open";
     if (mode === "open") return true;
     return !!props.user;
   }
+  function showAvailability() {
+    if (!props.showAvailabilityFilter) return false;
+    return !propellerV2CoreUi.isContentHidden(props.portalMode, props.user);
+  }
   function getFilterName(filter) {
     return filter?.attributeDescription?.name || "";
   }
@@ -9392,6 +9418,13 @@ function GridFilters(rawProps) {
     props.onFilterChange(filter, value);
     if (props.getSelectedFilters) props.getSelectedFilters();
   }
+  function handleAvailabilityToggle(value, checked) {
+    const next = checked ? [...availability, value] : availability.filter((v) => v !== value);
+    setAvailability(next);
+    setIsPending(true);
+    if (props.onAvailabilityChange) props.onAvailabilityChange(next);
+    if (props.getSelectedFilters) props.getSelectedFilters();
+  }
   function handleMinChange(value) {
     const n = value > currentMax ? currentMax : value;
     setCurrentMin(n);
@@ -9465,11 +9498,16 @@ function GridFilters(rawProps) {
     setCurrentMin(props.priceMin || 0);
     setCurrentMax(props.priceMax || 9999);
     setExpandedFilters({});
+    setAvailability([]);
   }, [props.clearSignal, props.priceMin, props.priceMax]);
   React6.useEffect(() => {
     if (!props.activeTextFilters) return;
     setSelectedFilters(props.activeTextFilters);
   }, [props.activeTextFilters]);
+  React6.useEffect(() => {
+    if (!props.activeAvailability) return;
+    setAvailability([...props.activeAvailability]);
+  }, [props.activeAvailability]);
   React6.useEffect(() => {
     if (props.activePriceMin === void 0 && props.activePriceMax === void 0) {
       setCurrentMin(props.priceMin || 0);
@@ -9569,6 +9607,40 @@ function GridFilters(rawProps) {
           " ",
           /* @__PURE__ */ jsxRuntime.jsx("div", { className: "propeller-grid-filters__divider h-px bg-border-subtle" })
         ] }) : null,
+        showAvailability() ? /* @__PURE__ */ jsxRuntime.jsxs(jsxRuntime.Fragment, { children: [
+          /* @__PURE__ */ jsxRuntime.jsxs("div", { className: "propeller-grid-filters__availability space-y-3", children: [
+            /* @__PURE__ */ jsxRuntime.jsx("h3", { className: "propeller-grid-filters__availability-title text-xs font-semibold uppercase tracking-wide text-muted-foreground", children: propellerV2CoreUi.getLabel(props.labels, "availability", "Availability") }),
+            /* @__PURE__ */ jsxRuntime.jsxs("div", { className: "propeller-grid-filters__availability-options space-y-1.5", children: [
+              /* @__PURE__ */ jsxRuntime.jsxs("label", { className: "propeller-grid-filters__option flex items-center gap-2 cursor-pointer group", children: [
+                /* @__PURE__ */ jsxRuntime.jsx(
+                  "input",
+                  {
+                    type: "checkbox",
+                    className: "propeller-grid-filters__checkbox h-4 w-4 rounded border-input text-secondary focus:ring-secondary cursor-pointer flex-shrink-0",
+                    checked: availability.includes("in-stock"),
+                    disabled: !!props.isLoading,
+                    onChange: (e) => handleAvailabilityToggle("in-stock", e.target.checked)
+                  }
+                ),
+                /* @__PURE__ */ jsxRuntime.jsx("span", { className: "propeller-grid-filters__option-label flex-1 text-sm text-muted-foreground leading-none select-none group-hover:text-foreground", children: propellerV2CoreUi.getLabel(props.labels, "inStock", "In stock") })
+              ] }),
+              /* @__PURE__ */ jsxRuntime.jsxs("label", { className: "propeller-grid-filters__option flex items-center gap-2 cursor-pointer group", children: [
+                /* @__PURE__ */ jsxRuntime.jsx(
+                  "input",
+                  {
+                    type: "checkbox",
+                    className: "propeller-grid-filters__checkbox h-4 w-4 rounded border-input text-secondary focus:ring-secondary cursor-pointer flex-shrink-0",
+                    checked: availability.includes("out-of-stock"),
+                    disabled: !!props.isLoading,
+                    onChange: (e) => handleAvailabilityToggle("out-of-stock", e.target.checked)
+                  }
+                ),
+                /* @__PURE__ */ jsxRuntime.jsx("span", { className: "propeller-grid-filters__option-label flex-1 text-sm text-muted-foreground leading-none select-none group-hover:text-foreground", children: propellerV2CoreUi.getLabel(props.labels, "outOfStock", "Out of stock") })
+              ] })
+            ] })
+          ] }),
+          /* @__PURE__ */ jsxRuntime.jsx("div", { className: "propeller-grid-filters__divider h-px bg-border-subtle" })
+        ] }) : null,
         props.filters.length === 0 ? /* @__PURE__ */ jsxRuntime.jsx("p", { className: "propeller-grid-filters__empty text-sm text-foreground-subtle italic", children: propellerV2CoreUi.getLabel(props.labels, "noFiltersAvailable", "No filters available") }) : null,
         getFilteredFilters()?.map((filter) => /* @__PURE__ */ jsxRuntime.jsxs("div", { className: "propeller-grid-filters__group border-b border-border-subtle pb-3 last:border-b-0", "data-expanded": isExpanded(getFilterName(filter)) ? "true" : "false", children: [
           /* @__PURE__ */ jsxRuntime.jsxs(
@@ -9744,6 +9816,8 @@ var DEFAULT_LABELS = {
   results: "results",
   perPage: " per page",
   price: "Price",
+  inStock: "In stock",
+  outOfStock: "Out of stock",
   switchToList: "Switch to list view",
   switchToGrid: "Switch to grid view"
 };
@@ -9772,7 +9846,8 @@ function GridToolbar(rawProps) {
     const text = props.activeTextFilters || {};
     const hasText = Object.keys(text).some((k) => (text[k] || []).length > 0);
     const hasPrice = props.priceFilterMin !== void 0 || props.priceFilterMax !== void 0;
-    return hasText || hasPrice;
+    const hasAvailability = (props.availability || []).length > 0;
+    return hasText || hasPrice || hasAvailability;
   }
   function getActiveFilterBadges() {
     const text = props.activeTextFilters || {};
@@ -9790,6 +9865,9 @@ function GridToolbar(rawProps) {
   function isPriceSortDisabled() {
     return propellerV2CoreUi.isContentHidden(props.portalMode, props.user);
   }
+  function getAvailabilityLabel(value) {
+    return value === "in-stock" ? getLabel56("inStock") : getLabel56("outOfStock");
+  }
   function handleSortFieldChange(field) {
     setCurrentSortField(field);
     if (props.onSortChange) props.onSortChange(field, currentSortOrder);
@@ -9963,6 +10041,20 @@ function GridToolbar(rawProps) {
               ]
             }
           ) : null,
+          (props.availability || []).map((value) => /* @__PURE__ */ jsxRuntime.jsxs(
+            "span",
+            {
+              className: "propeller-grid-toolbar__filter-badge propeller-grid-toolbar__filter-badge--availability inline-flex items-center gap-1 cursor-pointer px-2.5 py-0.5 rounded-full text-xs font-semibold border border-input bg-background hover:bg-primary hover:text-primary-foreground hover:border-primary transition-colors",
+              onClick: (event) => {
+                if (props.onAvailabilityFilterRemove) props.onAvailabilityFilterRemove(value);
+              },
+              children: [
+                getAvailabilityLabel(value),
+                /* @__PURE__ */ jsxRuntime.jsx("span", { className: "propeller-grid-toolbar__filter-badge-remove", children: "\xD7" })
+              ]
+            },
+            value
+          )),
           getActiveFilterBadges()?.map((badge) => /* @__PURE__ */ jsxRuntime.jsxs(
             "span",
             {
@@ -18396,7 +18488,8 @@ function SearchBar(rawProps) {
     user: props.user,
     companyId: props.companyId,
     orderlistIds: props.orderlistIds,
-    applyOrderlists: props.applyOrderlists
+    applyOrderlists: props.applyOrderlists,
+    productTrackAttributes: props.productTrackAttributes
   });
   const results = searchResults.slice(0, maxResults).map((item) => mapToSearchBarResult(item, props.language));
   const itemsFound = searchItemsFound;