@wix/headless-stores 0.0.56 → 0.0.58

package/cjs/dist/services/products-list-service.js

@@ -1,8 +1,8 @@
 import { defineService, implementService } from '@wix/services-definitions';
 import { SignalsServiceDefinition, } from '@wix/services-definitions/core-services/signals';
-import { productsV3, readOnlyVariantsV3 } from '@wix/stores';
+import { customizationsV3, productsV3, readOnlyVariantsV3 } from '@wix/stores';
 import { loadCategoriesListServiceConfig } from './categories-list-service.js';
-import { parseUrlToSearchOptions, } from './products-list-search-service.js';
+import { InventoryStatusType, parseUrlToSearchOptions, } from './products-list-search-service.js';
 export const DEFAULT_QUERY_LIMIT = 100;
 /**
  * Loads products list service configuration from the Wix Stores API for SSR initialization.
@@ -118,10 +118,13 @@ export const DEFAULT_QUERY_LIMIT = 100;
  */
 export async function loadProductsListServiceConfig(input) {
     let searchOptions;
+    const { items: customizations = [] } = await customizationsV3
+        .queryCustomizations()
+        .find();
     if (typeof input === 'string') {
         // URL input - parse it
         const categoriesListConfig = await loadCategoriesListServiceConfig();
-        const { searchOptions: parsedOptions } = await parseUrlToSearchOptions(input, categoriesListConfig.categories);
+        const { searchOptions: parsedOptions } = await parseUrlToSearchOptions(input, categoriesListConfig.categories, customizations);
         searchOptions = parsedOptions;
     }
     else {
@@ -139,6 +142,7 @@ export async function loadProductsListServiceConfig(input) {
         searchOptions,
         pagingMetadata: resultWithFilter.pagingMetadata,
         aggregations: resultWithoutFilter.aggregationData ?? {},
+        customizations,
     };
 }
 /**
@@ -292,6 +296,14 @@ export const ProductListService = implementService.withConfig()(ProductsListServ
     const productsSignal = signalsService.signal(config.products);
     const searchOptionsSignal = signalsService.signal(config.searchOptions);
     const pagingMetadataSignal = signalsService.signal(config.pagingMetadata);
+    const minPriceSignal = signalsService.signal(getMinPrice(config.aggregations.results));
+    const maxPriceSignal = signalsService.signal(getMaxPrice(config.aggregations.results));
+    const availableProductOptionsSignal = signalsService.signal(getAvailableProductOptions(config.aggregations.results, config.customizations));
+    const availableInventoryStatusesSignal = signalsService.signal([
+        InventoryStatusType.IN_STOCK,
+        InventoryStatusType.OUT_OF_STOCK,
+        InventoryStatusType.PARTIALLY_OUT_OF_STOCK,
+    ]);
     const aggregationsSignal = signalsService.signal(config.aggregations);
     const isLoadingSignal = signalsService.signal(false);
     const errorSignal = signalsService.signal(null);
@@ -331,7 +343,15 @@ export const ProductListService = implementService.withConfig()(ProductsListServ
         searchOptions: searchOptionsSignal,
         pagingMetadata: pagingMetadataSignal,
         aggregations: aggregationsSignal,
-        setSearchOptions: (searchOptions) => searchOptionsSignal.set(searchOptions),
+        /* Metadata for products list */
+        minPrice: minPriceSignal,
+        maxPrice: maxPriceSignal,
+        availableInventoryStatuses: availableInventoryStatusesSignal,
+        availableProductOptions: availableProductOptionsSignal,
+        /* End of Metadata for products list */
+        setSearchOptions: (searchOptions) => {
+            searchOptionsSignal.set(searchOptions);
+        },
         setSort: (sort) => {
             const currentOptions = searchOptionsSignal.peek();
             searchOptionsSignal.set({
@@ -346,7 +366,108 @@ export const ProductListService = implementService.withConfig()(ProductsListServ
                 filter,
             });
         },
+        resetFilter: () => {
+            const currentOptions = searchOptionsSignal.peek();
+            searchOptionsSignal.set({
+                ...currentOptions,
+                filter: {},
+            });
+        },
+        isFiltered: () => {
+            return signalsService.computed(() => {
+                const currentOptions = searchOptionsSignal.peek();
+                if (!currentOptions.filter)
+                    return false;
+                return (currentOptions.filter !== undefined &&
+                    Object.keys(currentOptions.filter).length > 0);
+            });
+        },
         isLoading: isLoadingSignal,
         error: errorSignal,
+        loadMore: (count) => {
+            const currentOptions = searchOptionsSignal.peek();
+            searchOptionsSignal.set({
+                ...currentOptions,
+                cursorPaging: {
+                    cursor: pagingMetadataSignal.get().cursors?.next,
+                    limit: currentOptions.cursorPaging?.limit ?? 0 + count,
+                },
+            });
+        },
+        hasMoreProducts: signalsService.computed(() => pagingMetadataSignal.get().hasNext ?? false),
     };
 });
+function getMinPrice(aggregationData) {
+    const minPriceAggregation = aggregationData.find((data) => data.fieldPath === 'actualPriceRange.minValue.amount');
+    if (minPriceAggregation?.scalar?.value) {
+        return Number(minPriceAggregation.scalar.value) || 0;
+    }
+    return 0;
+}
+function getMaxPrice(aggregationData) {
+    const maxPriceAggregation = aggregationData.find((data) => data.fieldPath === 'actualPriceRange.maxValue.amount');
+    if (maxPriceAggregation?.scalar?.value) {
+        return Number(maxPriceAggregation.scalar.value) || 0;
+    }
+    return 0;
+}
+function getAvailableProductOptions(aggregationData = [], customizations = []) {
+    const matchesAggregationName = (name, aggregationNames) => {
+        return aggregationNames.some((aggName) => aggName.toLowerCase() === name.toLowerCase());
+    };
+    const sortChoicesIntelligently = (choices) => {
+        return [...choices].sort((a, b) => {
+            const aIsNumber = /^\d+$/.test(a.name);
+            const bIsNumber = /^\d+$/.test(b.name);
+            if (aIsNumber && bIsNumber) {
+                return parseInt(a.name) - parseInt(b.name);
+            }
+            if (aIsNumber && !bIsNumber)
+                return -1;
+            if (!aIsNumber && bIsNumber)
+                return 1;
+            return a.name.localeCompare(b.name);
+        });
+    };
+    const optionNames = [];
+    const choiceNames = [];
+    aggregationData.forEach((result) => {
+        if (result.name === 'optionNames' && result.values?.results) {
+            optionNames.push(...result.values.results
+                .map((item) => item.value)
+                .filter((value) => typeof value === 'string'));
+        }
+        if (result.name === 'choiceNames' && result.values?.results) {
+            choiceNames.push(...result.values.results
+                .map((item) => item.value)
+                .filter((value) => typeof value === 'string'));
+        }
+    });
+    const options = customizations
+        .filter((customization) => customization.name &&
+        customization._id &&
+        customization.customizationType ===
+            customizationsV3.CustomizationType.PRODUCT_OPTION &&
+        (optionNames.length === 0 ||
+            matchesAggregationName(customization.name, optionNames)))
+        .map((customization) => {
+        const choices = (customization.choicesSettings?.choices || [])
+            .filter((choice) => choice._id &&
+            choice.name &&
+            (choiceNames.length === 0 ||
+                matchesAggregationName(choice.name, choiceNames)))
+            .map((choice) => ({
+            id: choice._id,
+            name: choice.name,
+            colorCode: choice.colorCode,
+        }));
+        return {
+            id: customization._id,
+            name: customization.name,
+            choices: sortChoicesIntelligently(choices),
+            optionRenderType: customization.customizationRenderType,
+        };
+    })
+        .filter((option) => option.choices.length > 0);
+    return options;
+}

package/cjs/dist/utils/renderChildren.d.ts

@@ -9,6 +9,7 @@ export interface RenderChildrenParams<THTMLElement = HTMLElement, TProps = any>
     props: TProps;
     /** Ref to forward to the rendered element */
     ref: React.Ref<THTMLElement>;
+    content?: string | null;
 }
 /**
  * Utility function to handle children rendering.
@@ -38,4 +39,4 @@ export interface RenderChildrenParams<THTMLElement = HTMLElement, TProps = any>
  * });
  * ```
  */
-export declare function renderChildren<THTMLElement = HTMLElement, TProps = any>({ children, props, ref, }: RenderChildrenParams<THTMLElement, TProps>): React.ReactNode | null;
+export declare function renderChildren<THTMLElement = HTMLElement, TProps = any>({ children, props, ref, content, }: RenderChildrenParams<THTMLElement, TProps>): React.ReactNode | null;

package/cjs/dist/utils/renderChildren.js

@@ -27,13 +27,16 @@ import React from 'react';
  * });
  * ```
  */
-export function renderChildren({ children, props, ref, }) {
+export function renderChildren({ children, props, ref, content, }) {
     // Early return if no children provided
     if (!children)
         return null;
     // Handle React element pattern
     if (React.isValidElement(children)) {
-        return children;
+        return React.cloneElement(children, {
+            ref,
+            ...(content ? { children: content } : {}),
+        });
     }
     // Handle render function pattern
     if (typeof children === 'function') {

package/dist/react/Category.d.ts

@@ -25,6 +25,7 @@ export interface CategoryTriggerProps {
         category: Category;
         isSelected: boolean;
         onSelect: () => void;
+        setIsSelected: (isSelected: boolean) => void;
     }>;
     /** Callback when category is selected */
     onSelect?: (category: Category) => void;

package/dist/react/Category.js

@@ -1,10 +1,9 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import React from 'react';
-import { Slot } from '@radix-ui/react-slot';
 import * as CoreCategory from './core/Category.js';
 import { CategoryServiceDefinition, } from '../services/category-service.js';
 import { useService } from '@wix/services-manager-react';
-import { renderChildren } from '../utils/renderChildren.js';
+import { AsChildSlot } from '@wix/headless-utils/react';
 var TestIds;
 (function (TestIds) {
     TestIds["categoryItem"] = "category-item";
@@ -76,19 +75,18 @@ export const Trigger = React.forwardRef((props, ref) => {
     const categoryService = useService(CategoryServiceDefinition);
     const category = categoryService.category.get();
     const isSelected = categoryService.isSelected.get();
+    const setIsSelected = (isSelected) => categoryService.isSelected.set(isSelected);
     const handleSelect = () => {
         if (onSelect) {
             onSelect(category);
         }
     };
-    const Comp = asChild && children ? Slot : 'button';
-    return (_jsx(Comp, { ref: ref, className: className, onClick: handleSelect, "data-testid": TestIds.categoryTrigger, "data-selected": isSelected ? 'true' : 'false', children: asChild && children
-            ? renderChildren({
-                children,
-                props: { category, isSelected, onSelect: handleSelect },
-                ref,
-            })
-            : category.name }));
+    return (_jsx(AsChildSlot, { ref: ref, asChild: asChild, className: className, onClick: handleSelect, "data-testid": TestIds.categoryTrigger, "data-selected": isSelected ? 'true' : 'false', customElement: children, customElementProps: {
+            category,
+            isSelected,
+            onSelect: handleSelect,
+            setIsSelected,
+        }, content: category.name, children: _jsx("button", { children: category.name }) }));
 });
 /**
  * Displays the category name or label.
@@ -121,10 +119,7 @@ export const Label = React.forwardRef((props, ref) => {
     const category = categoryService.category.get();
     const isSelected = categoryService.isSelected.get();
     return (_jsx(CoreCategory.Name, { children: ({ name }) => {
-            const Comp = asChild && children ? Slot : 'span';
-            return (_jsx(Comp, { ref: ref, className: className, "data-testid": TestIds.categoryLabel, "data-selected": isSelected ? 'true' : 'false', children: asChild && children
-                    ? renderChildren({ children, props: { name, category }, ref })
-                    : name }));
+            return (_jsx(AsChildSlot, { ref: ref, asChild: asChild, className: className, "data-testid": TestIds.categoryLabel, "data-selected": isSelected ? 'true' : 'false', customElement: children, customElementProps: { name, category }, content: name, children: _jsx("span", { children: name }) }));
         } }));
 });
 /**
@@ -158,10 +153,7 @@ export const ID = React.forwardRef((props, ref) => {
     const category = categoryService.category.get();
     const isSelected = categoryService.isSelected.get();
     const id = category._id || '';
-    const Comp = asChild && children ? Slot : 'span';
-    return (_jsx(Comp, { ref: ref, className: className || 'sr-only', "data-testid": TestIds.categoryId, "data-selected": isSelected ? 'true' : 'false', children: asChild && children
-            ? renderChildren({ children, props: { id, category }, ref })
-            : id }));
+    return (_jsx(AsChildSlot, { ref: ref, asChild: asChild, className: className || 'sr-only', "data-testid": TestIds.categoryId, "data-selected": isSelected ? 'true' : 'false', customElement: children, customElementProps: { id, category }, content: id, children: _jsx("span", { children: id }) }));
 });
 /**
  * Provides access to the full category data for advanced use cases.
@@ -190,8 +182,5 @@ export const Raw = React.forwardRef((props, ref) => {
     const categoryService = useService(CategoryServiceDefinition);
     const category = categoryService.category.get();
     const isSelected = categoryService.isSelected.get();
-    const Comp = asChild && children ? Slot : 'span';
-    return (_jsx(Comp, { ref: ref, className: className || 'sr-only', "data-testid": TestIds.categoryRaw, "data-selected": isSelected ? 'true' : 'false', children: asChild && children
-            ? renderChildren({ children, props: { category, isSelected }, ref })
-            : JSON.stringify(category) }));
+    return (_jsx(AsChildSlot, { ref: ref, asChild: asChild, className: className || 'sr-only', "data-testid": TestIds.categoryRaw, "data-selected": isSelected ? 'true' : 'false', customElement: children, customElementProps: { category, isSelected }, children: _jsx("span", { children: JSON.stringify(category) }) }));
 });

package/dist/react/CategoryList.js

@@ -1,8 +1,8 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import React from 'react';
-import { Slot } from '@radix-ui/react-slot';
 import * as CoreCategoryList from './core/CategoryList.js';
 import * as Category from './Category.js';
+import { AsChildSlot } from '@wix/headless-utils/react';
 var TestIds;
 (function (TestIds) {
     TestIds["categoryListRoot"] = "category-list";
@@ -56,8 +56,7 @@ export function Root(props) {
  */
 export const Loading = React.forwardRef((props, ref) => {
     const { asChild, children, className } = props;
-    const Comp = asChild && children ? Slot : 'h1';
-    return (_jsx(CoreCategoryList.Loading, { children: _jsx(Comp, { className: className, ref: ref, children: "Loading..." }) }));
+    return (_jsx(CoreCategoryList.Loading, { children: _jsx(AsChildSlot, { ref: ref, asChild: asChild, className: className, customElement: children, children: _jsx("h1", { children: "Loading..." }) }) }));
 });
 /**
  * Repeats for each category in the list, providing individual category context.

package/dist/react/Product.d.ts

@@ -1,6 +1,5 @@
 import type { V3Product } from '@wix/auto_sdk_stores_products-v-3';
 import React from 'react';
-import { type AsChildProps } from '../utils/index.js';
 import { AsContent } from './types.js';
 /**
  * Context for sharing variant options state between components
@@ -56,9 +55,15 @@ export declare function Root(props: ProductRootProps): React.ReactNode;
 /**
  * Props for Product Name component
  */
-export interface NameProps extends AsChildProps<{
-    name: string;
-}> {
+export interface NameProps {
+    /** Whether to render as a child component */
+    asChild?: boolean;
+    /** Custom render function when using asChild */
+    children?: React.ReactNode | React.ForwardRefRenderFunction<HTMLElement, {
+        name: string;
+    }> | React.ForwardRefExoticComponent<any>;
+    /** CSS classes to apply to the default element */
+    className?: string;
 }
 /**
  * Displays the product name with customizable rendering following the documented API.
@@ -88,9 +93,15 @@ export declare const Name: React.ForwardRefExoticComponent<NameProps & React.Ref
 /**
  * Props for Product Description component
  */
-export interface DescriptionProps extends AsChildProps<{
-    description: string;
-}> {
+export interface DescriptionProps {
+    /** Whether to render as a child component */
+    asChild?: boolean;
+    /** Custom render function when using asChild */
+    children?: React.ReactNode | React.ForwardRefRenderFunction<HTMLElement, {
+        description: string;
+    }> | React.ForwardRefExoticComponent<any>;
+    /** CSS classes to apply to the default element */
+    className?: string;
     /** Format of the description content */
     as?: `${AsContent}`;
 }
@@ -121,10 +132,16 @@ export declare const Description: React.ForwardRefExoticComponent<DescriptionPro
 /**
  * Props for Product Price component
  */
-export interface PriceProps extends AsChildProps<{
-    price: string;
-    formattedPrice: string;
-}> {
+export interface PriceProps {
+    /** Whether to render as a child component */
+    asChild?: boolean;
+    /** Custom render function when using asChild */
+    children?: React.ReactNode | React.ForwardRefRenderFunction<HTMLElement, {
+        price: string;
+        formattedPrice: string;
+    }> | React.ForwardRefExoticComponent<any>;
+    /** CSS classes to apply to the default element */
+    className?: string;
 }
 /**
  * Displays the current product price with customizable rendering following the documented API.
@@ -154,10 +171,16 @@ export declare const Price: React.ForwardRefExoticComponent<PriceProps & React.R
 /**
  * Props for Product CompareAtPrice component
  */
-export interface CompareAtPriceProps extends AsChildProps<{
-    price: string;
-    formattedPrice: string;
-}> {
+export interface CompareAtPriceProps {
+    /** Whether to render as a child component */
+    asChild?: boolean;
+    /** Custom render function when using asChild */
+    children?: React.ReactNode | React.ForwardRefRenderFunction<HTMLElement, {
+        price: string;
+        formattedPrice: string;
+    }> | React.ForwardRefExoticComponent<any>;
+    /** CSS classes to apply to the default element */
+    className?: string;
 }
 /**
  * Displays the compare-at (original) price when on sale with customizable rendering following the documented API.
@@ -192,9 +215,15 @@ export declare const CompareAtPrice: React.ForwardRefExoticComponent<CompareAtPr
  * Props for Slug component
  * @interface SlugProps
  */
-export interface SlugProps extends AsChildProps<{
-    slug: string;
-}> {
+export interface SlugProps {
+    /** Whether to render as a child component */
+    asChild?: boolean;
+    /** Custom render function when using asChild */
+    children?: React.ReactNode | React.ForwardRefRenderFunction<HTMLElement, {
+        slug: string;
+    }> | React.ForwardRefExoticComponent<any>;
+    /** CSS classes to apply to the default element */
+    className?: string;
 }
 /**
  * Product Slug component that displays the product's slug
@@ -222,9 +251,15 @@ export declare const Slug: React.ForwardRefExoticComponent<SlugProps & React.Ref
 /**
  * Props for Product Raw component
  */
-export interface RawProps extends AsChildProps<{
-    product: V3Product;
-}> {
+export interface RawProps {
+    /** Whether to render as a child component */
+    asChild?: boolean;
+    /** Custom render function when using asChild */
+    children?: React.ReactNode | React.ForwardRefRenderFunction<HTMLElement, {
+        product: V3Product;
+    }> | React.ForwardRefExoticComponent<any>;
+    /** CSS classes to apply to the default element */
+    className?: string;
 }
 /**
  * Provides access to the raw product data for advanced use cases.
@@ -249,9 +284,13 @@ export declare const Raw: React.ForwardRefExoticComponent<RawProps & React.RefAt
 /**
  * Props for Product Variants container
  */
-export interface VariantsProps extends AsChildProps<{
-    hasOptions: boolean;
-}> {
+export interface VariantsProps {
+    /** Whether to render as a child component */
+    asChild?: boolean;
+    /** Custom render function when using asChild */
+    children: React.ReactNode;
+    /** CSS classes to apply to the default element */
+    className?: string;
 }
 /**
  * Container for product variant selection system.
@@ -331,7 +370,7 @@ export interface VariantOptionsProps {
  * </Product.VariantOptions>
  * ```
  */
-export declare const VariantOptions: React.ForwardRefExoticComponent<VariantOptionsProps & React.RefAttributes<HTMLElement>>;
+export declare const VariantOptions: React.ForwardRefExoticComponent<VariantOptionsProps & React.RefAttributes<HTMLDivElement>>;
 /**
  * Props for Product VariantOptionRepeater component
  */
@@ -347,9 +386,13 @@ export declare const VariantOptionRepeater: React.ForwardRefExoticComponent<Vari
 /**
  * Props for Product Modifiers container
  */
-export interface ModifiersProps extends AsChildProps<{
-    hasModifiers: boolean;
-}> {
+export interface ModifiersProps {
+    /** Whether to render as a child component */
+    asChild?: boolean;
+    /** Custom render function when using asChild */
+    children: React.ReactNode;
+    /** CSS classes to apply to the default element */
+    className?: string;
 }
 /**
  * Container for product modifier system.
@@ -432,7 +475,7 @@ export interface ModifierOptionsProps {
  * </Product.ModifierOptions>
  * ```
  */
-export declare const ModifierOptions: React.ForwardRefExoticComponent<ModifierOptionsProps & React.RefAttributes<HTMLElement>>;
+export declare const ModifierOptions: React.ForwardRefExoticComponent<ModifierOptionsProps & React.RefAttributes<HTMLDivElement>>;
 /**
  * Props for Product ModifierOptionRepeater component
  */
@@ -485,7 +528,7 @@ export interface ProductMediaGalleryProps {
  * </Product.MediaGallery>
  * ```
  */
-export declare const ProductMediaGallery: React.ForwardRefExoticComponent<ProductMediaGalleryProps & React.RefAttributes<HTMLElement>>;
+export declare const ProductMediaGallery: React.ForwardRefExoticComponent<ProductMediaGalleryProps & React.RefAttributes<HTMLDivElement>>;
 /**
  * Alias for ProductMediaGallery to match the documented API
  */