@wix/headless-stores 0.0.41 → 0.0.42

package/dist/services/products-list-service.d.ts

@@ -1,5 +1,6 @@
 import { type Signal } from "@wix/services-definitions/core-services/signals";
 import { productsV3 } from "@wix/stores";
+export declare const DEFAULT_QUERY_LIMIT = 100;
 /**
  * Configuration interface for the Products List service.
  * Contains the initial products data, search options, and metadata.
@@ -10,7 +11,7 @@ export type ProductsListServiceConfig = {
     /** Array of product objects to initialize the service with */
     products: productsV3.V3Product[];
     /** Search options used to fetch the products */
-    searchOptions: Parameters<typeof productsV3.searchProducts>[0];
+    searchOptions: productsV3.V3ProductSearch;
     /** Pagination metadata from the search response */
     pagingMetadata: productsV3.CommonCursorPagingMetadata;
     /** Aggregation data containing filters, facets, and counts */
@@ -21,7 +22,7 @@ export type ProductsListServiceConfig = {
  * This function is designed to be used during Server-Side Rendering (SSR) to preload
  * a list of products based on search criteria.
  *
- * @param {Parameters<typeof productsV3.searchProducts>[0]} searchOptions - The search options for querying products
+ * @param {productsV3.V3ProductSearch} searchOptions - The search options for querying products
  * @returns {Promise<ProductsListServiceConfig>} Promise that resolves to the products list configuration
  *
  * @example
@@ -99,7 +100,7 @@ export type ProductsListServiceConfig = {
  * }
  * ```
  */
-export declare function loadProductsListServiceConfig(searchOptions: Parameters<typeof productsV3.searchProducts>[0]): Promise<ProductsListServiceConfig>;
+export declare function loadProductsListServiceConfig(searchOptions: productsV3.V3ProductSearch): Promise<ProductsListServiceConfig>;
 /**
  * Service definition for the Products List service.
  * This defines the reactive API contract for managing a list of products with search, pagination, and filtering capabilities.
@@ -115,13 +116,17 @@ export declare const ProductsListServiceDefinition: string & {
         /** Reactive signal containing pagination metadata */
         pagingMetadata: Signal<productsV3.CommonCursorPagingMetadata>;
         /** Reactive signal containing current search options */
-        searchOptions: Signal<Parameters<typeof productsV3.searchProducts>[0]>;
+        searchOptions: Signal<productsV3.V3ProductSearch>;
         /** Reactive signal indicating if products are currently being loaded */
         isLoading: Signal<boolean>;
         /** Reactive signal containing any error message, or null if no error */
         error: Signal<string | null>;
         /** Function to update search options and trigger a new search */
-        setSearchOptions: (searchOptions: Parameters<typeof productsV3.searchProducts>[0]) => void;
+        setSearchOptions: (searchOptions: productsV3.V3ProductSearch) => void;
+        /** Function to update only the sort part of search options */
+        setSort: (sort: productsV3.V3ProductSearch["sort"]) => void;
+        /** Function to update only the filter part of search options */
+        setFilter: (filter: productsV3.V3ProductSearch["filter"]) => void;
     };
     __config: ProductsListServiceConfig;
     isServiceDefinition?: boolean;
@@ -133,13 +138,17 @@ export declare const ProductsListServiceDefinition: string & {
     /** Reactive signal containing pagination metadata */
     pagingMetadata: Signal<productsV3.CommonCursorPagingMetadata>;
     /** Reactive signal containing current search options */
-    searchOptions: Signal<Parameters<typeof productsV3.searchProducts>[0]>;
+    searchOptions: Signal<productsV3.V3ProductSearch>;
     /** Reactive signal indicating if products are currently being loaded */
     isLoading: Signal<boolean>;
     /** Reactive signal containing any error message, or null if no error */
     error: Signal<string | null>;
     /** Function to update search options and trigger a new search */
-    setSearchOptions: (searchOptions: Parameters<typeof productsV3.searchProducts>[0]) => void;
+    setSearchOptions: (searchOptions: productsV3.V3ProductSearch) => void;
+    /** Function to update only the sort part of search options */
+    setSort: (sort: productsV3.V3ProductSearch["sort"]) => void;
+    /** Function to update only the filter part of search options */
+    setFilter: (filter: productsV3.V3ProductSearch["filter"]) => void;
 };
 /**
  * Implementation of the Products List service that manages reactive products data.
@@ -204,13 +213,17 @@ export declare const ProductListService: import("@wix/services-definitions").Ser
         /** Reactive signal containing pagination metadata */
         pagingMetadata: Signal<productsV3.CommonCursorPagingMetadata>;
         /** Reactive signal containing current search options */
-        searchOptions: Signal<Parameters<typeof productsV3.searchProducts>[0]>;
+        searchOptions: Signal<productsV3.V3ProductSearch>;
         /** Reactive signal indicating if products are currently being loaded */
         isLoading: Signal<boolean>;
         /** Reactive signal containing any error message, or null if no error */
         error: Signal<string | null>;
         /** Function to update search options and trigger a new search */
-        setSearchOptions: (searchOptions: Parameters<typeof productsV3.searchProducts>[0]) => void;
+        setSearchOptions: (searchOptions: productsV3.V3ProductSearch) => void;
+        /** Function to update only the sort part of search options */
+        setSort: (sort: productsV3.V3ProductSearch["sort"]) => void;
+        /** Function to update only the filter part of search options */
+        setFilter: (filter: productsV3.V3ProductSearch["filter"]) => void;
     };
     __config: ProductsListServiceConfig;
     isServiceDefinition?: boolean;
@@ -222,11 +235,15 @@ export declare const ProductListService: import("@wix/services-definitions").Ser
     /** Reactive signal containing pagination metadata */
     pagingMetadata: Signal<productsV3.CommonCursorPagingMetadata>;
     /** Reactive signal containing current search options */
-    searchOptions: Signal<Parameters<typeof productsV3.searchProducts>[0]>;
+    searchOptions: Signal<productsV3.V3ProductSearch>;
     /** Reactive signal indicating if products are currently being loaded */
     isLoading: Signal<boolean>;
     /** Reactive signal containing any error message, or null if no error */
     error: Signal<string | null>;
     /** Function to update search options and trigger a new search */
-    setSearchOptions: (searchOptions: Parameters<typeof productsV3.searchProducts>[0]) => void;
+    setSearchOptions: (searchOptions: productsV3.V3ProductSearch) => void;
+    /** Function to update only the sort part of search options */
+    setSort: (sort: productsV3.V3ProductSearch["sort"]) => void;
+    /** Function to update only the filter part of search options */
+    setFilter: (filter: productsV3.V3ProductSearch["filter"]) => void;
 }, ProductsListServiceConfig>;

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

@@ -1,12 +1,13 @@
 import { defineService, implementService } from "@wix/services-definitions";
 import { SignalsServiceDefinition, } from "@wix/services-definitions/core-services/signals";
 import { productsV3, readOnlyVariantsV3 } from "@wix/stores";
+export const DEFAULT_QUERY_LIMIT = 100;
 /**
  * Loads products list service configuration from the Wix Stores API for SSR initialization.
  * This function is designed to be used during Server-Side Rendering (SSR) to preload
  * a list of products based on search criteria.
  *
- * @param {Parameters<typeof productsV3.searchProducts>[0]} searchOptions - The search options for querying products
+ * @param {productsV3.V3ProductSearch} searchOptions - The search options for querying products
  * @returns {Promise<ProductsListServiceConfig>} Promise that resolves to the products list configuration
  *
  * @example
@@ -85,12 +86,17 @@ import { productsV3, readOnlyVariantsV3 } from "@wix/stores";
  * ```
  */
 export async function loadProductsListServiceConfig(searchOptions) {
-    const result = await fetchProducts(searchOptions);
+    const searchWithoutFilter = { ...searchOptions, filter: {} };
+    const [resultWithoutFilter, resultWithFilter] = await Promise.all([
+        fetchProducts(searchWithoutFilter),
+        fetchProducts(searchOptions),
+    ]);
+    const products = resultWithFilter?.products ?? resultWithoutFilter?.products ?? [];
     return {
-        products: result.products ?? [],
+        products,
         searchOptions,
-        pagingMetadata: result.pagingMetadata,
-        aggregations: result.aggregationData,
+        pagingMetadata: resultWithFilter.pagingMetadata,
+        aggregations: resultWithoutFilter.aggregationData ?? {},
     };
 }
 /**
@@ -136,7 +142,7 @@ const fetchMissingVariants = async (products) => {
         const res = await readOnlyVariantsV3
             .queryVariants({})
             .in("productData.productId", productIds)
-            .limit(100)
+            .limit(DEFAULT_QUERY_LIMIT)
             .find();
         items.push(...res.items);
         let nextRes = res;
@@ -284,6 +290,20 @@ export const ProductListService = implementService.withConfig()(ProductsListServ
         pagingMetadata: pagingMetadataSignal,
         aggregations: aggregationsSignal,
         setSearchOptions: (searchOptions) => searchOptionsSignal.set(searchOptions),
+        setSort: (sort) => {
+            const currentOptions = searchOptionsSignal.peek();
+            searchOptionsSignal.set({
+                ...currentOptions,
+                sort,
+            });
+        },
+        setFilter: (filter) => {
+            const currentOptions = searchOptionsSignal.peek();
+            searchOptionsSignal.set({
+                ...currentOptions,
+                filter,
+            });
+        },
         isLoading: isLoadingSignal,
         error: errorSignal,
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/headless-stores",
-  "version": "0.0.41",
+  "version": "0.0.42",
   "type": "module",
   "scripts": {
     "prebuild": "cd ../media && yarn build && cd ../ecom && yarn build",
@@ -56,7 +56,7 @@
     "@wix/auto_sdk_stores_inventory-items-v-3": "^1.0.26",
     "@wix/auto_sdk_stores_products-v-3": "^1.0.53",
     "@wix/auto_sdk_stores_read-only-variants-v-3": "^1.0.23",
-    "@wix/ecom": "^1.0.1238",
+    "@wix/ecom": "^1.0.1278",
     "@wix/essentials": "^0.1.24",
     "@wix/headless-ecom": "^0.0.11",
     "@wix/headless-media": "^0.0.8",

package/cjs/dist/services/products-list-filters-service.d.ts

@@ -1,309 +0,0 @@
-import { type Signal } from "@wix/services-definitions/core-services/signals";
-import { customizationsV3 } from "@wix/stores";
-/**
- * Interface representing a product option (like Size, Color, etc.).
- * Contains the option metadata and available choices.
- *
- * @interface ProductOption
- */
-export interface ProductOption {
-    /** Unique identifier for the product option */
-    id: string;
-    /** Display name of the option (e.g., "Size", "Color") */
-    name: string;
-    /** Array of available choices for this option */
-    choices: ProductChoice[];
-    /** Optional render type for UI display purposes */
-    optionRenderType?: string;
-}
-/**
- * Interface representing a choice within a product option.
- * For example, "Red" would be a choice within a "Color" option.
- *
- * @interface ProductChoice
- */
-export interface ProductChoice {
-    /** Unique identifier for the choice */
-    id: string;
-    /** Display name of the choice (e.g., "Red", "Large") */
-    name: string;
-    /** Optional color code for color-based choices */
-    colorCode?: string;
-}
-/**
- * Enumeration of inventory status types available for filtering.
- * Maps to the Wix Stores API inventory availability statuses.
- *
- * @enum {string}
- */
-export declare enum InventoryStatusType {
-    /** Product is in stock and available for purchase */
-    IN_STOCK = "IN_STOCK",
-    /** Product is out of stock */
-    OUT_OF_STOCK = "OUT_OF_STOCK",
-    /** Product is partially out of stock (some variants available) */
-    PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
-}
-/**
- * Configuration interface for the Products List Filters service.
- * Contains customizations data used to build filter options.
- *
- * @interface ProductsListFiltersServiceConfig
- */
-export type ProductsListFiltersServiceConfig = {
-    /** Array of product customizations for building filter options */
-    customizations: customizationsV3.Customization[];
-};
-/**
- * Loads products list filters service configuration from the Wix Stores API for SSR initialization.
- * This function fetches customization data that will be used to build product filter options.
- *
- * @returns {Promise<ProductsListFiltersServiceConfig>} Promise that resolves to the filters configuration
- *
- * @example
- * ```astro
- * ---
- * // Astro page example - pages/products.astro
- * import { loadProductsListFiltersServiceConfig } from '@wix/stores/services';
- * import { ProductsListFilters } from '@wix/stores/components';
- *
- * // Load filters configuration during SSR
- * const filtersConfig = await loadProductsListFiltersServiceConfig();
- * ---
- *
- * <ProductsListFilters.Root filtersConfig={filtersConfig}>
- *   <ProductsListFilters.MinPrice>
- *     {({ minPrice, setMinPrice }) => (
- *       <input
- *         type="number"
- *         value={minPrice}
- *         onChange={(e) => setMinPrice(parseFloat(e.target.value))}
- *         placeholder="Min Price"
- *       />
- *     )}
- *   </ProductsListFilters.MinPrice>
- * </ProductsListFilters.Root>
- * ```
- *
- * @example
- * ```tsx
- * // Next.js page example
- * import { GetServerSideProps } from 'next';
- * import { loadProductsListFiltersServiceConfig } from '@wix/stores/services';
- *
- * export const getServerSideProps: GetServerSideProps = async () => {
- *   const filtersConfig = await loadProductsListFiltersServiceConfig();
- *
- *   return {
- *     props: {
- *       filtersConfig,
- *     },
- *   };
- * };
- * ```
- */
-export declare function loadProductsListFiltersServiceConfig(): Promise<ProductsListFiltersServiceConfig>;
-/**
- * Service definition for the Products List Filters service.
- * This defines the reactive API contract for managing product list filtering capabilities
- * including price, inventory status, and product option filters.
- *
- * @constant
- */
-export declare const ProductsListFiltersServiceDefinition: string & {
-    __api: {
-        /** Reactive signal containing the user's selected minimum price filter value */
-        selectedMinPrice: Signal<number>;
-        /** Reactive signal containing the user's selected maximum price filter value */
-        selectedMaxPrice: Signal<number>;
-        /** Reactive signal containing the catalog minimum price (for UI bounds) */
-        availableMinPrice: Signal<number>;
-        /** Reactive signal containing the catalog maximum price (for UI bounds) */
-        availableMaxPrice: Signal<number>;
-        /** Reactive signal containing available inventory status options */
-        availableInventoryStatuses: Signal<InventoryStatusType[]>;
-        /** Reactive signal containing selected inventory status filters */
-        selectedInventoryStatuses: Signal<InventoryStatusType[]>;
-        /** Reactive signal containing available product options for filtering */
-        availableProductOptions: Signal<ProductOption[]>;
-        /** Reactive signal containing selected product option filters */
-        selectedProductOptions: Signal<Record<string, string[]>>;
-        /** Function to set the minimum price filter */
-        setSelectedMinPrice: (minPrice: number) => void;
-        /** Function to set the maximum price filter */
-        setSelectedMaxPrice: (maxPrice: number) => void;
-        /** Function to toggle an inventory status filter */
-        toggleInventoryStatus: (status: InventoryStatusType) => void;
-        /** Function to toggle a product option choice filter */
-        toggleProductOption: (optionId: string, choiceId: string) => void;
-        /** Reactive signal indicating if any filters are currently applied */
-        isFiltered: Signal<boolean>;
-        /** Function to reset all filters to their default state */
-        reset: () => void;
-    };
-    __config: {};
-    isServiceDefinition?: boolean;
-} & {
-    /** Reactive signal containing the user's selected minimum price filter value */
-    selectedMinPrice: Signal<number>;
-    /** Reactive signal containing the user's selected maximum price filter value */
-    selectedMaxPrice: Signal<number>;
-    /** Reactive signal containing the catalog minimum price (for UI bounds) */
-    availableMinPrice: Signal<number>;
-    /** Reactive signal containing the catalog maximum price (for UI bounds) */
-    availableMaxPrice: Signal<number>;
-    /** Reactive signal containing available inventory status options */
-    availableInventoryStatuses: Signal<InventoryStatusType[]>;
-    /** Reactive signal containing selected inventory status filters */
-    selectedInventoryStatuses: Signal<InventoryStatusType[]>;
-    /** Reactive signal containing available product options for filtering */
-    availableProductOptions: Signal<ProductOption[]>;
-    /** Reactive signal containing selected product option filters */
-    selectedProductOptions: Signal<Record<string, string[]>>;
-    /** Function to set the minimum price filter */
-    setSelectedMinPrice: (minPrice: number) => void;
-    /** Function to set the maximum price filter */
-    setSelectedMaxPrice: (maxPrice: number) => void;
-    /** Function to toggle an inventory status filter */
-    toggleInventoryStatus: (status: InventoryStatusType) => void;
-    /** Function to toggle a product option choice filter */
-    toggleProductOption: (optionId: string, choiceId: string) => void;
-    /** Reactive signal indicating if any filters are currently applied */
-    isFiltered: Signal<boolean>;
-    /** Function to reset all filters to their default state */
-    reset: () => void;
-};
-/**
- * Implementation of the Products List Filters service that manages reactive filtering state.
- * This service provides signals for all filter types (price, inventory, product options) and
- * automatically updates the products list search options when filters change.
- *
- * @example
- * ```tsx
- * import { ProductsListFiltersService, ProductsListFiltersServiceDefinition } from '@wix/stores/services';
- * import { useService } from '@wix/services-manager-react';
- *
- * function FiltersComponent({ filtersConfig }) {
- *   return (
- *     <ServiceProvider services={createServicesMap([
- *       [ProductsListFiltersServiceDefinition, ProductsListFiltersService.withConfig(filtersConfig)]
- *     ])}>
- *       <FilterControls />
- *     </ServiceProvider>
- *   );
- * }
- *
- * function FilterControls() {
- *   const filtersService = useService(ProductsListFiltersServiceDefinition);
- *   const minPrice = filtersService.minPrice.get();
- *   const maxPrice = filtersService.maxPrice.get();
- *   const selectedInventoryStatuses = filtersService.selectedInventoryStatuses.get();
- *   const availableProductOptions = filtersService.availableProductOptions.get();
- *   const isFiltered = filtersService.isFiltered.get();
- *
- *   return (
- *     <div>
- *       <div>
- *         <input
- *           type="number"
- *           value={minPrice}
- *           onChange={(e) => filtersService.setMinPrice(parseFloat(e.target.value))}
- *           placeholder="Min Price"
- *         />
- *         <input
- *           type="number"
- *           value={maxPrice}
- *           onChange={(e) => filtersService.setMaxPrice(parseFloat(e.target.value))}
- *           placeholder="Max Price"
- *         />
- *       </div>
- *
- *       {availableProductOptions.map(option => (
- *         <div key={option.id}>
- *           <h4>{option.name}</h4>
- *           {option.choices.map(choice => (
- *             <label key={choice.id}>
- *               <input
- *                 type="checkbox"
- *                 onChange={() => filtersService.toggleProductOption(option.id, choice.id)}
- *               />
- *               {choice.name}
- *             </label>
- *           ))}
- *         </div>
- *       ))}
- *
- *       {isFiltered && (
- *         <button onClick={() => filtersService.reset()}>
- *           Clear All Filters
- *         </button>
- *       )}
- *     </div>
- *   );
- * }
- * }
- * ```
- */
-export declare const ProductsListFiltersService: import("@wix/services-definitions").ServiceFactory<string & {
-    __api: {
-        /** Reactive signal containing the user's selected minimum price filter value */
-        selectedMinPrice: Signal<number>;
-        /** Reactive signal containing the user's selected maximum price filter value */
-        selectedMaxPrice: Signal<number>;
-        /** Reactive signal containing the catalog minimum price (for UI bounds) */
-        availableMinPrice: Signal<number>;
-        /** Reactive signal containing the catalog maximum price (for UI bounds) */
-        availableMaxPrice: Signal<number>;
-        /** Reactive signal containing available inventory status options */
-        availableInventoryStatuses: Signal<InventoryStatusType[]>;
-        /** Reactive signal containing selected inventory status filters */
-        selectedInventoryStatuses: Signal<InventoryStatusType[]>;
-        /** Reactive signal containing available product options for filtering */
-        availableProductOptions: Signal<ProductOption[]>;
-        /** Reactive signal containing selected product option filters */
-        selectedProductOptions: Signal<Record<string, string[]>>;
-        /** Function to set the minimum price filter */
-        setSelectedMinPrice: (minPrice: number) => void;
-        /** Function to set the maximum price filter */
-        setSelectedMaxPrice: (maxPrice: number) => void;
-        /** Function to toggle an inventory status filter */
-        toggleInventoryStatus: (status: InventoryStatusType) => void;
-        /** Function to toggle a product option choice filter */
-        toggleProductOption: (optionId: string, choiceId: string) => void;
-        /** Reactive signal indicating if any filters are currently applied */
-        isFiltered: Signal<boolean>;
-        /** Function to reset all filters to their default state */
-        reset: () => void;
-    };
-    __config: {};
-    isServiceDefinition?: boolean;
-} & {
-    /** Reactive signal containing the user's selected minimum price filter value */
-    selectedMinPrice: Signal<number>;
-    /** Reactive signal containing the user's selected maximum price filter value */
-    selectedMaxPrice: Signal<number>;
-    /** Reactive signal containing the catalog minimum price (for UI bounds) */
-    availableMinPrice: Signal<number>;
-    /** Reactive signal containing the catalog maximum price (for UI bounds) */
-    availableMaxPrice: Signal<number>;
-    /** Reactive signal containing available inventory status options */
-    availableInventoryStatuses: Signal<InventoryStatusType[]>;
-    /** Reactive signal containing selected inventory status filters */
-    selectedInventoryStatuses: Signal<InventoryStatusType[]>;
-    /** Reactive signal containing available product options for filtering */
-    availableProductOptions: Signal<ProductOption[]>;
-    /** Reactive signal containing selected product option filters */
-    selectedProductOptions: Signal<Record<string, string[]>>;
-    /** Function to set the minimum price filter */
-    setSelectedMinPrice: (minPrice: number) => void;
-    /** Function to set the maximum price filter */
-    setSelectedMaxPrice: (maxPrice: number) => void;
-    /** Function to toggle an inventory status filter */
-    toggleInventoryStatus: (status: InventoryStatusType) => void;
-    /** Function to toggle a product option choice filter */
-    toggleProductOption: (optionId: string, choiceId: string) => void;
-    /** Reactive signal indicating if any filters are currently applied */
-    isFiltered: Signal<boolean>;
-    /** Function to reset all filters to their default state */
-    reset: () => void;
-}, ProductsListFiltersServiceConfig>;