@wix/headless-stores 0.0.58 → 0.0.60

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

@@ -1,128 +0,0 @@
-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;
-/**
- * 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 = {
-    initialSearchState?: InitialSearchState;
-};
-/**
- * Service definition for the Products List Search service.
- * This consolidates sort, pagination, and filtering functionality.
- */
-export declare const ProductsListSearchServiceDefinition: string & {
-    __api: {};
-    __config: {};
-    isServiceDefinition?: boolean;
-};
-/**
- * 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[], customizations: customizationsV3.Customization[], 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: {};
-    __config: {};
-    isServiceDefinition?: boolean;
-}, ProductsListSearchServiceConfig>;

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

@@ -1,507 +1 @@
-import { defineService, implementService } from '@wix/services-definitions';
-import { SignalsServiceDefinition } from '@wix/services-definitions/core-services/signals';
-import { DEFAULT_QUERY_LIMIT } from './products-list-service.js';
-import { productsV3, customizationsV3 } from '@wix/stores';
-import { loadCategoriesListServiceConfig } from './categories-list-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 const InventoryStatusType = productsV3.InventoryAvailabilityStatus;
-/**
- * Service definition for the Products List Search service.
- * This consolidates sort, pagination, and filtering functionality.
- */
-export const ProductsListSearchServiceDefinition = defineService('products-list-search');
-/**
- * Convert SortType enum to URL format
- */
-function convertSortTypeToUrl(sortType) {
-    switch (sortType) {
-        case SortType.NAME_ASC:
-            return 'name';
-        case SortType.NAME_DESC:
-            return 'name:desc';
-        case SortType.PRICE_ASC:
-            return 'price';
-        case SortType.PRICE_DESC:
-            return 'price:desc';
-        case SortType.NEWEST:
-            return 'newest';
-        case SortType.RECOMMENDED:
-            return 'recommended';
-        default:
-            return 'name';
-    }
-}
-/**
- * Convert URL sort format to SortType enum
- */
-export function convertUrlSortToSortType(urlSort) {
-    const sortParts = urlSort.split(':');
-    const field = sortParts[0]?.toLowerCase();
-    const order = sortParts[1]?.toLowerCase() === 'desc' ? 'desc' : 'asc';
-    switch (field) {
-        case 'name':
-            return order === 'desc' ? SortType.NAME_DESC : SortType.NAME_ASC;
-        case 'price':
-            return order === 'desc' ? SortType.PRICE_DESC : SortType.PRICE_ASC;
-        case 'newest':
-        case 'created':
-            return SortType.NEWEST;
-        case 'recommended':
-            return SortType.RECOMMENDED;
-        default:
-            return null;
-    }
-}
-/**
- * Update URL with current search state (sort, filters, pagination)
- */
-//@ts-expect-error
-function updateUrlWithSearchState(searchState) {
-    if (typeof window === 'undefined')
-        return;
-    const { sort, filters, customizations, catalogBounds, categorySlug } = searchState;
-    // Convert filter IDs back to human-readable names for URL
-    const humanReadableOptions = {};
-    for (const [optionId, choiceIds] of Object.entries(filters?.productOptions ?? {})) {
-        const option = customizations.find((c) => c._id === optionId);
-        if (option && option.name) {
-            const choiceNames = [];
-            for (const choiceId of choiceIds) {
-                const choice = option.choicesSettings?.choices?.find((c) => c._id === choiceId);
-                if (choice && choice.name) {
-                    choiceNames.push(choice.name);
-                }
-            }
-            if (choiceNames.length > 0) {
-                humanReadableOptions[option.name] = choiceNames;
-            }
-        }
-    }
-    // Start with current URL parameters to preserve non-search parameters
-    const params = new URLSearchParams(window.location.search);
-    // Define search-related parameters that we manage
-    const searchParams = [
-        'sort',
-        'limit',
-        'cursor',
-        'minPrice',
-        'maxPrice',
-        'inventoryStatus',
-        'visible',
-        'productType',
-        // Product option names will be dynamically added below
-        // Note: category is NOT included here as it's handled in the URL path
-    ];
-    // Remove existing search parameters first
-    searchParams.forEach((param) => params.delete(param));
-    // Remove existing product option parameters (they have dynamic names)
-    for (const customization of customizations) {
-        if (customization.customizationType ===
-            customizationsV3.CustomizationType.PRODUCT_OPTION &&
-            customization.name) {
-            params.delete(customization.name);
-        }
-    }
-    // Add sort parameter (only if not default)
-    const urlSort = convertSortTypeToUrl(sort);
-    if (sort !== SortType.NAME_ASC) {
-        params.set('sort', urlSort);
-    }
-    // Add price range parameters only if they differ from catalog bounds
-    if (filters.priceRange?.min &&
-        filters.priceRange.min > catalogBounds.minPrice) {
-        params.set('minPrice', filters.priceRange.min.toString());
-    }
-    if (filters.priceRange?.max &&
-        filters.priceRange.max < catalogBounds.maxPrice) {
-        params.set('maxPrice', filters.priceRange.max.toString());
-    }
-    // Add inventory status parameters
-    if (filters.inventoryStatuses && filters.inventoryStatuses.length > 0) {
-        params.set('inventoryStatus', filters.inventoryStatuses.join(','));
-    }
-    // Add visibility filter (only if explicitly false, since true is default)
-    if (filters.visible === false) {
-        params.set('visible', 'false');
-    }
-    // Add product type filter
-    if (filters.productType) {
-        params.set('productType', filters.productType);
-    }
-    // Add product options as individual parameters (Color=Red,Blue&Size=Large)
-    for (const [optionName, values] of Object.entries(humanReadableOptions)) {
-        if (values.length > 0) {
-            params.set(optionName, values.join(','));
-        }
-    }
-    // Handle URL path construction with category
-    let baseUrl = window.location.pathname;
-    // If categorySlug is provided, replace the last path segment (which represents the category)
-    if (categorySlug) {
-        const pathSegments = baseUrl.split('/').filter(Boolean);
-        if (pathSegments.length > 0) {
-            // Replace the last segment with the new category slug
-            pathSegments[pathSegments.length - 1] = categorySlug;
-            baseUrl = '/' + pathSegments.join('/');
-        }
-        else {
-            // If no segments, just use the category slug
-            baseUrl = `/${categorySlug}`;
-        }
-    }
-    // Build the new URL
-    const newUrl = params.toString()
-        ? `${baseUrl}?${params.toString()}`
-        : baseUrl;
-    // Only update if URL actually changed
-    if (newUrl !== window.location.pathname + window.location.search) {
-        window.history.pushState(null, '', newUrl);
-    }
-}
-/**
- * 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 async function parseUrlToSearchOptions(url, categoriesList, customizations, defaultSearchOptions) {
-    const urlObj = new URL(url);
-    const searchParams = urlObj.searchParams;
-    // Build search options
-    const searchOptions = {
-        cursorPaging: {
-            limit: DEFAULT_QUERY_LIMIT,
-        },
-        ...defaultSearchOptions,
-    };
-    // Initialize search state for service
-    const initialSearchState = {};
-    // Extract category slug from URL path
-    // The category slug is always the last segment of the path
-    const pathSegments = urlObj.pathname.split('/').filter(Boolean);
-    let category = undefined;
-    if (pathSegments.length > 0) {
-        const lastSegment = pathSegments[pathSegments.length - 1];
-        // Check if the last segment matches any category in the categories list
-        category = categoriesList.find((cat) => cat.slug === lastSegment);
-        if (category) {
-            initialSearchState.category = category;
-        }
-    }
-    // Handle text search (q parameter)
-    const query = searchParams.get('q');
-    if (query) {
-        searchOptions.search = {
-            expression: query,
-        };
-    }
-    // Handle sorting
-    const sort = searchParams.get('sort');
-    if (sort) {
-        const sortType = convertUrlSortToSortType(sort);
-        if (sortType) {
-            initialSearchState.sort = sortType;
-            // Apply sort to search options
-            switch (sortType) {
-                case SortType.NAME_ASC:
-                    searchOptions.sort = [
-                        { fieldName: 'name', order: productsV3.SortDirection.ASC },
-                    ];
-                    break;
-                case SortType.NAME_DESC:
-                    searchOptions.sort = [
-                        { fieldName: 'name', order: productsV3.SortDirection.DESC },
-                    ];
-                    break;
-                case SortType.PRICE_ASC:
-                    searchOptions.sort = [
-                        {
-                            fieldName: 'actualPriceRange.minValue.amount',
-                            order: productsV3.SortDirection.ASC,
-                        },
-                    ];
-                    break;
-                case SortType.PRICE_DESC:
-                    searchOptions.sort = [
-                        {
-                            fieldName: 'actualPriceRange.minValue.amount',
-                            order: productsV3.SortDirection.DESC,
-                        },
-                    ];
-                    break;
-                case SortType.RECOMMENDED:
-                    searchOptions.sort = [
-                        {
-                            fieldName: 'name',
-                            order: productsV3.SortDirection.DESC,
-                        },
-                    ];
-                    break;
-            }
-        }
-    }
-    // Handle pagination
-    const limit = searchParams.get('limit');
-    const cursor = searchParams.get('cursor');
-    if (limit || cursor) {
-        searchOptions.cursorPaging = {};
-        if (limit) {
-            const limitNum = parseInt(limit, 10);
-            if (!isNaN(limitNum) && limitNum > 0) {
-                searchOptions.cursorPaging.limit = limitNum;
-                initialSearchState.limit = limitNum;
-            }
-        }
-        if (cursor) {
-            searchOptions.cursorPaging.cursor = cursor;
-            initialSearchState.cursor = cursor;
-        }
-    }
-    // Handle filtering for search options
-    const filter = {};
-    const visible = searchParams.get('visible');
-    if (visible !== null) {
-        filter['visible'] = visible === 'true';
-        initialSearchState.visible = visible === 'true';
-    }
-    const productType = searchParams.get('productType');
-    if (productType) {
-        filter['productType'] = productType;
-        initialSearchState.productType = productType;
-    }
-    // Add category filter if found
-    if (category) {
-        filter['allCategoriesInfo.categories'] = {
-            $matchItems: [{ _id: { $in: [category._id] } }],
-        };
-    }
-    // Price range filtering
-    const minPrice = searchParams.get('minPrice');
-    const maxPrice = searchParams.get('maxPrice');
-    if (minPrice || maxPrice) {
-        initialSearchState.priceRange = {};
-        if (minPrice) {
-            const minPriceNum = parseFloat(minPrice);
-            if (!isNaN(minPriceNum)) {
-                filter['actualPriceRange.minValue.amount'] = { $gte: minPriceNum };
-                initialSearchState.priceRange.min = minPriceNum;
-            }
-        }
-        if (maxPrice) {
-            const maxPriceNum = parseFloat(maxPrice);
-            if (!isNaN(maxPriceNum)) {
-                filter['actualPriceRange.maxValue.amount'] = { $lte: maxPriceNum };
-                initialSearchState.priceRange.max = maxPriceNum;
-            }
-        }
-    }
-    const inventoryStatus = searchParams.get('inventoryStatus');
-    if (inventoryStatus) {
-        filter['inventory.availabilityStatus'] = {
-            $in: inventoryStatus.split(','),
-        };
-    }
-    // Parse product options from URL parameters
-    const reservedParams = [
-        'minPrice',
-        'maxPrice',
-        'inventory_status',
-        'inventoryStatus',
-        'visible',
-        'productType',
-        'q',
-        'limit',
-        'cursor',
-        'sort',
-    ];
-    const productOptionsById = {};
-    for (const [optionName, optionValues] of searchParams.entries()) {
-        if (reservedParams.includes(optionName))
-            continue;
-        // Find the option by name in customizations
-        const option = customizations.find((c) => c.name === optionName &&
-            c.customizationType ===
-                customizationsV3.CustomizationType.PRODUCT_OPTION);
-        if (option && option._id) {
-            const choiceValues = optionValues.split(',').filter(Boolean);
-            const choiceIds = [];
-            // Convert choice names to IDs
-            for (const choiceName of choiceValues) {
-                const choice = option.choicesSettings?.choices?.find((c) => c.name === choiceName);
-                if (choice && choice._id) {
-                    choiceIds.push(choice._id);
-                }
-            }
-            if (choiceIds.length > 0) {
-                productOptionsById[option._id] = choiceIds;
-            }
-        }
-    }
-    if (Object.keys(productOptionsById).length > 0) {
-        initialSearchState.productOptions = productOptionsById;
-        // Add product option filter to search options
-        filter[`options.choicesSettings.choices.choiceId`] = {
-            $hasSome: Object.values(productOptionsById).flat(),
-        };
-    }
-    // Add filter to search options if any filters were set
-    if (Object.keys(filter).length > 0) {
-        searchOptions.filter = filter;
-    }
-    // Add aggregations for getting filter options
-    searchOptions.aggregations = [
-        {
-            name: 'minPrice',
-            fieldPath: 'actualPriceRange.minValue.amount',
-            type: 'SCALAR',
-            scalar: { type: 'MIN' },
-        },
-        {
-            name: 'maxPrice',
-            fieldPath: 'actualPriceRange.maxValue.amount',
-            type: 'SCALAR',
-            scalar: { type: 'MAX' },
-        },
-        {
-            name: 'optionNames',
-            fieldPath: 'options.name',
-            type: productsV3.SortType.VALUE,
-            value: {
-                limit: 20,
-                sortType: productsV3.SortType.VALUE,
-                sortDirection: productsV3.SortDirection.ASC,
-            },
-        },
-        {
-            name: 'choiceNames',
-            fieldPath: 'options.choicesSettings.choices.name',
-            type: productsV3.SortType.VALUE,
-            value: {
-                limit: 50,
-                sortType: productsV3.SortType.VALUE,
-                sortDirection: productsV3.SortDirection.ASC,
-            },
-        },
-        {
-            name: 'inventoryStatus',
-            fieldPath: 'inventory.availabilityStatus',
-            type: productsV3.SortType.VALUE,
-            value: {
-                limit: 10,
-                sortType: productsV3.SortType.VALUE,
-                sortDirection: productsV3.SortDirection.ASC,
-            },
-        },
-    ];
-    return { searchOptions, 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 async function loadProductsListSearchServiceConfig(input) {
-    let initialSearchState;
-    if (typeof input === 'string') {
-        // URL input - parse it
-        const categoriesListConfig = await loadCategoriesListServiceConfig();
-        const { items: customizations = [] } = await customizationsV3
-            .queryCustomizations()
-            .find();
-        const { initialSearchState: parsedState } = await parseUrlToSearchOptions(input, categoriesListConfig.categories, customizations);
-        initialSearchState = parsedState;
-    }
-    else {
-        // Parsed URL result - use initialSearchState directly (no duplicate work)
-        initialSearchState = input.initialSearchState;
-    }
-    return {
-        initialSearchState,
-    };
-}
-/**
- * Implementation of the Products List Search service
- */
-export const ProductsListSearchService = implementService.withConfig()(ProductsListSearchServiceDefinition, ({ getService }) => {
-    let firstRun = true;
-    const signalsService = getService(SignalsServiceDefinition);
-    if (typeof window !== 'undefined') {
-        // Watch for changes in any search parameters and update search options
-        signalsService.effect(() => {
-            // Read all signals to establish dependencies
-            if (firstRun) {
-                firstRun = false;
-                return;
-            }
-            // TODO fix it blat
-            // const currentFilters = {
-            //   ...(selectedVisible !== null && { visible: selectedVisible }),
-            //   ...(selectedProductType && { productType: selectedProductType }),
-            // };
-            // updateUrlWithSearchState({
-            //   sort,
-            //   filters: currentFilters,
-            //   customizations,
-            //   catalogBounds,
-            //   categorySlug: selectedCategory?.slug || undefined,
-            // });
-        });
-    }
-    return {};
-});
+"use strict";