@wix/headless-stores 0.0.41 → 0.0.43

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

@@ -0,0 +1,220 @@
+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.
+ */
+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: Signal<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: Signal<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
+ */
+export declare function parseUrlForProductsListSearch(url: string, categoriesList: Category[], defaultSearchOptions?: productsV3.V3ProductSearch): Promise<{
+    searchOptions: productsV3.V3ProductSearch;
+    initialSearchState: InitialSearchState;
+}>;
+/**
+ * Load search service configuration from URL
+ */
+export declare function loadProductsListSearchServiceConfig(url: string): 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: Signal<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: Signal<boolean>;
+    reset: () => void;
+}, ProductsListSearchServiceConfig>;