@wix/headless-stores 0.0.57 → 0.0.59

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

@@ -1,287 +0,0 @@
-import type { Signal } from '@wix/services-definitions/core-services/signals';
-import { productsV3, customizationsV3 } from '@wix/stores';
-import { type Category } from './category-service.js';
-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;
-}
-/**
- * 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;
-};
-/**
- * Configuration interface for the Products List Search service.
- */
-export type ProductsListSearchServiceConfig = {
-    customizations: customizationsV3.Customization[];
-    initialSearchState?: InitialSearchState;
-};
-/**
- * Service definition for the Products List Search service.
- * This consolidates sort, pagination, and filtering functionality.
- */
-export declare const ProductsListSearchServiceDefinition: string & {
-    __api: {
-        selectedSortOption: Signal<string>;
-        sortOptions: SortType[];
-        setSelectedSortOption: (sort: string) => void;
-        currentLimit: Signal<number>;
-        currentCursor: Signal<string | null>;
-        hasNextPage: {
-            get: () => boolean;
-        };
-        hasPrevPage: {
-            get: () => boolean;
-        };
-        setLimit: (limit: number) => void;
-        nextPage: () => void;
-        prevPage: () => void;
-        navigateToFirstPage: () => void;
-        loadMore: (count: number) => void;
-        selectedMinPrice: Signal<number>;
-        selectedMaxPrice: Signal<number>;
-        availableMinPrice: Signal<number>;
-        availableMaxPrice: Signal<number>;
-        availableInventoryStatuses: Signal<InventoryStatusType[]>;
-        selectedInventoryStatuses: Signal<InventoryStatusType[]>;
-        availableProductOptions: Signal<ProductOption[]>;
-        selectedProductOptions: Signal<Record<string, string[]>>;
-        selectedCategory: Signal<Category | null>;
-        setSelectedMinPrice: (minPrice: number) => void;
-        setSelectedMaxPrice: (maxPrice: number) => void;
-        toggleInventoryStatus: (status: InventoryStatusType) => void;
-        toggleProductOption: (optionId: string, choiceId: string) => void;
-        setSelectedCategory: (category: Category | null) => void;
-        isFiltered: {
-            get: () => boolean;
-        };
-        reset: () => void;
-    };
-    __config: {};
-    isServiceDefinition?: boolean;
-} & {
-    selectedSortOption: Signal<string>;
-    sortOptions: SortType[];
-    setSelectedSortOption: (sort: string) => void;
-    currentLimit: Signal<number>;
-    currentCursor: Signal<string | null>;
-    hasNextPage: {
-        get: () => boolean;
-    };
-    hasPrevPage: {
-        get: () => boolean;
-    };
-    setLimit: (limit: number) => void;
-    nextPage: () => void;
-    prevPage: () => void;
-    navigateToFirstPage: () => void;
-    loadMore: (count: number) => void;
-    selectedMinPrice: Signal<number>;
-    selectedMaxPrice: Signal<number>;
-    availableMinPrice: Signal<number>;
-    availableMaxPrice: Signal<number>;
-    availableInventoryStatuses: Signal<InventoryStatusType[]>;
-    selectedInventoryStatuses: Signal<InventoryStatusType[]>;
-    availableProductOptions: Signal<ProductOption[]>;
-    selectedProductOptions: Signal<Record<string, string[]>>;
-    selectedCategory: Signal<Category | null>;
-    setSelectedMinPrice: (minPrice: number) => void;
-    setSelectedMaxPrice: (maxPrice: number) => void;
-    toggleInventoryStatus: (status: InventoryStatusType) => void;
-    toggleProductOption: (optionId: string, choiceId: string) => void;
-    setSelectedCategory: (category: Category | null) => void;
-    isFiltered: {
-        get: () => boolean;
-    };
-    reset: () => void;
-};
-/**
- * Convert URL sort format to SortType enum
- */
-export declare function convertUrlSortToSortType(urlSort: string): SortType | null;
-/**
- * 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[], defaultSearchOptions?: productsV3.V3ProductSearch): Promise<{
-    searchOptions: productsV3.V3ProductSearch;
-    initialSearchState: InitialSearchState;
-}>;
-/**
- * Load search service configuration from URL or parsed URL result.
- * This function provides the configuration for the Products List Search service,
- * including customizations and initial search state.
- *
- * @param {string | { searchOptions: productsV3.V3ProductSearch; initialSearchState: InitialSearchState }} input - Either a URL to parse or parsed URL result from parseUrlToSearchOptions
- * @returns {Promise<ProductsListSearchServiceConfig>} Promise that resolves to the search service configuration
- *
- * @example
- * ```tsx
- * // Option 1: Load from URL (will parse filters, sort, pagination from URL params)
- * const searchConfig = await loadProductsListSearchServiceConfig(window.location.href);
- *
- * // Option 2: Custom parsing with defaults
- * const categories = await loadCategoriesListServiceConfig();
- * const parsed = await parseUrlToSearchOptions(
- *   window.location.href,
- *   categories.categories,
- *   {
- *     cursorPaging: { limit: 12 },
- *     filter: { 'categoryIds': ['123'] },
- *     sort: [{ fieldName: 'name' as const, order: 'ASC' as const }]
- *   }
- * );
- * const searchConfig = await loadProductsListSearchServiceConfig(parsed);
- *
- * // Option 3: Performance optimization - use parsed result for both services (no duplicate parsing)
- * const categories = await loadCategoriesListServiceConfig();
- * const parsed = await parseUrlToSearchOptions(url, categories.categories);
- * const [productsConfig, searchConfig] = await Promise.all([
- *   loadProductsListServiceConfig(parsed),
- *   loadProductsListSearchServiceConfig(parsed),
- * ]);
- * ```
- */
-export declare function loadProductsListSearchServiceConfig(input: string | {
-    searchOptions: productsV3.V3ProductSearch;
-    initialSearchState: InitialSearchState;
-}): Promise<ProductsListSearchServiceConfig>;
-/**
- * Implementation of the Products List Search service
- */
-export declare const ProductsListSearchService: import("@wix/services-definitions").ServiceFactory<string & {
-    __api: {
-        selectedSortOption: Signal<string>;
-        sortOptions: SortType[];
-        setSelectedSortOption: (sort: string) => void;
-        currentLimit: Signal<number>;
-        currentCursor: Signal<string | null>;
-        hasNextPage: {
-            get: () => boolean;
-        };
-        hasPrevPage: {
-            get: () => boolean;
-        };
-        setLimit: (limit: number) => void;
-        nextPage: () => void;
-        prevPage: () => void;
-        navigateToFirstPage: () => void;
-        loadMore: (count: number) => void;
-        selectedMinPrice: Signal<number>;
-        selectedMaxPrice: Signal<number>;
-        availableMinPrice: Signal<number>;
-        availableMaxPrice: Signal<number>;
-        availableInventoryStatuses: Signal<InventoryStatusType[]>;
-        selectedInventoryStatuses: Signal<InventoryStatusType[]>;
-        availableProductOptions: Signal<ProductOption[]>;
-        selectedProductOptions: Signal<Record<string, string[]>>;
-        selectedCategory: Signal<Category | null>;
-        setSelectedMinPrice: (minPrice: number) => void;
-        setSelectedMaxPrice: (maxPrice: number) => void;
-        toggleInventoryStatus: (status: InventoryStatusType) => void;
-        toggleProductOption: (optionId: string, choiceId: string) => void;
-        setSelectedCategory: (category: Category | null) => void;
-        isFiltered: {
-            get: () => boolean;
-        };
-        reset: () => void;
-    };
-    __config: {};
-    isServiceDefinition?: boolean;
-} & {
-    selectedSortOption: Signal<string>;
-    sortOptions: SortType[];
-    setSelectedSortOption: (sort: string) => void;
-    currentLimit: Signal<number>;
-    currentCursor: Signal<string | null>;
-    hasNextPage: {
-        get: () => boolean;
-    };
-    hasPrevPage: {
-        get: () => boolean;
-    };
-    setLimit: (limit: number) => void;
-    nextPage: () => void;
-    prevPage: () => void;
-    navigateToFirstPage: () => void;
-    loadMore: (count: number) => void;
-    selectedMinPrice: Signal<number>;
-    selectedMaxPrice: Signal<number>;
-    availableMinPrice: Signal<number>;
-    availableMaxPrice: Signal<number>;
-    availableInventoryStatuses: Signal<InventoryStatusType[]>;
-    selectedInventoryStatuses: Signal<InventoryStatusType[]>;
-    availableProductOptions: Signal<ProductOption[]>;
-    selectedProductOptions: Signal<Record<string, string[]>>;
-    selectedCategory: Signal<Category | null>;
-    setSelectedMinPrice: (minPrice: number) => void;
-    setSelectedMaxPrice: (maxPrice: number) => void;
-    toggleInventoryStatus: (status: InventoryStatusType) => void;
-    toggleProductOption: (optionId: string, choiceId: string) => void;
-    setSelectedCategory: (category: Category | null) => void;
-    isFiltered: {
-        get: () => boolean;
-    };
-    reset: () => void;
-}, ProductsListSearchServiceConfig>;