@wix/headless-stores 0.0.57 → 0.0.59

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

@@ -1,7 +1,36 @@
-import { type Signal } from '@wix/services-definitions/core-services/signals';
-import { productsV3 } from '@wix/stores';
-import { type InitialSearchState } from './products-list-search-service.js';
+import { type Signal, type ReadOnlySignal } from '@wix/services-definitions/core-services/signals';
+import { customizationsV3, productsV3 } from '@wix/stores';
+import { type Category } from './category-service.js';
 export declare const DEFAULT_QUERY_LIMIT = 100;
+import { SortType } from './../enums/sort-enums.js';
+export { SortType } from './../enums/sort-enums.js';
+/**
+ * Enumeration of inventory status types available for filtering.
+ * Re-exports the Wix inventory availability status enum values.
+ */
+export declare const InventoryStatusType: typeof productsV3.InventoryAvailabilityStatus;
+/**
+ * Type for inventory status values.
+ * Re-exports the Wix inventory availability status enum type.
+ */
+export type InventoryStatusType = productsV3.InventoryAvailabilityStatus;
+/**
+ * Interface representing a product option (like Size, Color, etc.).
+ */
+export interface ProductOption {
+    id: string;
+    name: string;
+    choices: ProductChoice[];
+    optionRenderType?: string;
+}
+/**
+ * Interface representing a choice within a product option.
+ */
+export interface ProductChoice {
+    id: string;
+    name: string;
+    colorCode?: string;
+}
 /**
  * Configuration interface for the Products List service.
  * Contains the initial products data, search options, and metadata.
@@ -17,6 +46,8 @@ export type ProductsListServiceConfig = {
     pagingMetadata: productsV3.CommonCursorPagingMetadata;
     /** Aggregation data containing filters, facets, and counts */
     aggregations: productsV3.AggregationData;
+    /** Customizations used to fetch the products */
+    customizations: customizationsV3.Customization[];
 };
 /**
  * Loads products list service configuration from the Wix Stores API for SSR initialization.
@@ -132,7 +163,6 @@ export type ProductsListServiceConfig = {
  */
 export declare function loadProductsListServiceConfig(input: string | {
     searchOptions: productsV3.V3ProductSearch;
-    initialSearchState: InitialSearchState;
 }): Promise<ProductsListServiceConfig>;
 /**
  * Service definition for the Products List service.
@@ -154,12 +184,28 @@ export declare const ProductsListServiceDefinition: string & {
         isLoading: Signal<boolean>;
         /** Reactive signal containing any error message, or null if no error */
         error: Signal<string | null>;
+        /** Reactive signal containing the minimum price of the products */
+        minPrice: Signal<number>;
+        /** Reactive signal containing the maximum price of the products */
+        maxPrice: Signal<number>;
+        /** Reactive signal containing the available inventory statuses */
+        availableInventoryStatuses: Signal<InventoryStatusType[]>;
+        /** Reactive signal containing the available product options */
+        availableProductOptions: Signal<ProductOption[]>;
         /** Function to update search options and trigger a new search */
         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;
+        /** Function to reset the filter part of search options */
+        resetFilter: () => void;
+        /** Reactive signal indicating if any filters are currently applied */
+        isFiltered: () => ReadOnlySignal<boolean>;
+        /** Function to load more products */
+        loadMore: (count: number) => void;
+        /** Reactive signal indicating if there are more products to load */
+        hasMoreProducts: ReadOnlySignal<boolean>;
     };
     __config: ProductsListServiceConfig;
     isServiceDefinition?: boolean;
@@ -176,12 +222,28 @@ export declare const ProductsListServiceDefinition: string & {
     isLoading: Signal<boolean>;
     /** Reactive signal containing any error message, or null if no error */
     error: Signal<string | null>;
+    /** Reactive signal containing the minimum price of the products */
+    minPrice: Signal<number>;
+    /** Reactive signal containing the maximum price of the products */
+    maxPrice: Signal<number>;
+    /** Reactive signal containing the available inventory statuses */
+    availableInventoryStatuses: Signal<InventoryStatusType[]>;
+    /** Reactive signal containing the available product options */
+    availableProductOptions: Signal<ProductOption[]>;
     /** Function to update search options and trigger a new search */
     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;
+    /** Function to reset the filter part of search options */
+    resetFilter: () => void;
+    /** Reactive signal indicating if any filters are currently applied */
+    isFiltered: () => ReadOnlySignal<boolean>;
+    /** Function to load more products */
+    loadMore: (count: number) => void;
+    /** Reactive signal indicating if there are more products to load */
+    hasMoreProducts: ReadOnlySignal<boolean>;
 };
 /**
  * Implementation of the Products List service that manages reactive products data.
@@ -251,12 +313,28 @@ export declare const ProductListService: import("@wix/services-definitions").Ser
         isLoading: Signal<boolean>;
         /** Reactive signal containing any error message, or null if no error */
         error: Signal<string | null>;
+        /** Reactive signal containing the minimum price of the products */
+        minPrice: Signal<number>;
+        /** Reactive signal containing the maximum price of the products */
+        maxPrice: Signal<number>;
+        /** Reactive signal containing the available inventory statuses */
+        availableInventoryStatuses: Signal<InventoryStatusType[]>;
+        /** Reactive signal containing the available product options */
+        availableProductOptions: Signal<ProductOption[]>;
         /** Function to update search options and trigger a new search */
         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;
+        /** Function to reset the filter part of search options */
+        resetFilter: () => void;
+        /** Reactive signal indicating if any filters are currently applied */
+        isFiltered: () => ReadOnlySignal<boolean>;
+        /** Function to load more products */
+        loadMore: (count: number) => void;
+        /** Reactive signal indicating if there are more products to load */
+        hasMoreProducts: ReadOnlySignal<boolean>;
     };
     __config: ProductsListServiceConfig;
     isServiceDefinition?: boolean;
@@ -273,10 +351,78 @@ export declare const ProductListService: import("@wix/services-definitions").Ser
     isLoading: Signal<boolean>;
     /** Reactive signal containing any error message, or null if no error */
     error: Signal<string | null>;
+    /** Reactive signal containing the minimum price of the products */
+    minPrice: Signal<number>;
+    /** Reactive signal containing the maximum price of the products */
+    maxPrice: Signal<number>;
+    /** Reactive signal containing the available inventory statuses */
+    availableInventoryStatuses: Signal<InventoryStatusType[]>;
+    /** Reactive signal containing the available product options */
+    availableProductOptions: Signal<ProductOption[]>;
     /** Function to update search options and trigger a new search */
     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;
+    /** Function to reset the filter part of search options */
+    resetFilter: () => void;
+    /** Reactive signal indicating if any filters are currently applied */
+    isFiltered: () => ReadOnlySignal<boolean>;
+    /** Function to load more products */
+    loadMore: (count: number) => void;
+    /** Reactive signal indicating if there are more products to load */
+    hasMoreProducts: ReadOnlySignal<boolean>;
 }, ProductsListServiceConfig>;
+/**
+ * Initial search state that can be loaded from URL parameters.
+ */
+export type InitialSearchState = {
+    sort?: SortType;
+    limit?: number;
+    cursor?: string | null;
+    priceRange?: {
+        min?: number;
+        max?: number;
+    };
+    inventoryStatuses?: InventoryStatusType[];
+    productOptions?: Record<string, string[]>;
+    category?: Category;
+    visible?: boolean;
+    productType?: string;
+};
+/**
+ * Parse URL and build complete search options with all filters, sort, and pagination.
+ * This function extracts search parameters, filters, sorting, and pagination from a URL
+ * and converts them into the format expected by the Wix Stores API.
+ *
+ * @param {string} url - The URL to parse search parameters from
+ * @param {Category[]} categoriesList - List of available categories for category slug resolution
+ * @param {productsV3.V3ProductSearch} [defaultSearchOptions] - Default search options to merge with parsed URL parameters
+ * @returns {Promise<{searchOptions: productsV3.V3ProductSearch, initialSearchState: InitialSearchState}>}
+ *   Object containing both API-ready search options and UI-ready initial state
+ *
+ * @example
+ * ```tsx
+ * // Parse URL with filters, sort, and pagination
+ * const categories = await loadCategoriesListServiceConfig();
+ * const { searchOptions, initialSearchState } = await parseUrlToSearchOptions(
+ *   'https://example.com/products?sort=price:desc&Color=red,blue&minPrice=50',
+ *   categories.categories
+ * );
+ *
+ * // Use searchOptions for API calls
+ * const products = await productsV3.searchProducts(searchOptions);
+ *
+ * // Use initialSearchState for UI initialization
+ * const filterState = initialSearchState.productOptions; // { colorId: ['red-id', 'blue-id'] }
+ * ```
+ */
+export declare function parseUrlToSearchOptions(url: string, categoriesList: Category[], customizations: customizationsV3.Customization[], defaultSearchOptions?: productsV3.V3ProductSearch): Promise<{
+    searchOptions: productsV3.V3ProductSearch;
+    initialSearchState: InitialSearchState;
+}>;
+/**
+ * Convert URL sort format to SortType enum
+ */
+export declare function convertUrlSortToSortType(urlSort: string): SortType | null;