@wix/headless-stores 0.0.41 → 0.0.43

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

@@ -1,179 +0,0 @@
-import { defineService } from "@wix/services-definitions";
-import { implementService } from "@wix/services-definitions";
-import { SignalsServiceDefinition, } from "@wix/services-definitions/core-services/signals";
-import { ProductsListServiceDefinition } from "./products-list-service.js";
-/**
- * Service definition for the Products List Pagination service.
- * This defines the reactive API contract for managing product list pagination state and navigation.
- *
- * @constant
- */
-export const ProductsListPaginationServiceDefinition = defineService("products-list-pagination");
-/**
- * Implementation of the Products List Pagination service that manages reactive pagination state.
- * This service provides signals for pagination state and automatically updates the products list
- * search options when pagination settings change. It supports both cursor-based pagination
- * and load-more functionality.
- *
- * @example
- * ```tsx
- * import { ProductsListPaginationService, ProductsListPaginationServiceDefinition } from '@wix/stores/services';
- * import { useService } from '@wix/services-manager-react';
- *
- * function PaginationComponent() {
- *   return (
- *     <ServiceProvider services={createServicesMap([
- *       [ProductsListPaginationServiceDefinition, ProductsListPaginationService.withConfig({})]
- *     ])}>
- *       <PaginationControls />
- *     </ServiceProvider>
- *   );
- * }
- *
- * function PaginationControls() {
- *   const paginationService = useService(ProductsListPaginationServiceDefinition);
- *   const currentLimit = paginationService.currentLimit.get();
- *   const hasNextPage = paginationService.hasNextPage.get();
- *   const hasPrevPage = paginationService.hasPrevPage.get();
- *
- *   return (
- *     <div>
- *       <div>
- *         Items per page:
- *         <select
- *           value={currentLimit}
- *           onChange={(e) => paginationService.setLimit(parseInt(e.target.value))}
- *         >
- *           <option value={12}>12</option>
- *           <option value={24}>24</option>
- *           <option value={48}>48</option>
- *         </select>
- *       </div>
- *
- *       <div>
- *         <button
- *           onClick={() => paginationService.navigateToFirstPage()}
- *           disabled={!hasPrevPage}
- *         >
- *           First
- *         </button>
- *         <button
- *           onClick={() => paginationService.prevPage()}
- *           disabled={!hasPrevPage}
- *         >
- *           Previous
- *         </button>
- *         <button
- *           onClick={() => paginationService.nextPage()}
- *           disabled={!hasNextPage}
- *         >
- *           Next
- *         </button>
- *       </div>
- *
- *       <button onClick={() => paginationService.loadMore(12)}>
- *         Load More
- *       </button>
- *     </div>
- *   );
- * }
- * ```
- */
-export const ProductsListPaginationService = implementService.withConfig()(ProductsListPaginationServiceDefinition, ({ getService }) => {
-    let firstRun = true;
-    const signalsService = getService(SignalsServiceDefinition);
-    const productsListService = getService(ProductsListServiceDefinition);
-    const currentLimitSignal = signalsService.signal(getCurrentLimit(productsListService.searchOptions.get()));
-    const currentCursorSignal = signalsService.signal(getCurrentCursor(productsListService.searchOptions.get()));
-    // Computed signals derived from paging metadata
-    const hasNextPageSignal = signalsService.computed(() => {
-        const pagingMetadata = productsListService.pagingMetadata.get();
-        return pagingMetadata?.hasNext || false;
-    });
-    const hasPrevPageSignal = signalsService.computed(() => {
-        const pagingMetadata = productsListService.pagingMetadata.get();
-        return typeof pagingMetadata.cursors?.prev !== "undefined";
-    });
-    if (typeof window !== "undefined") {
-        // Watch for changes in pagination settings and update search options
-        signalsService.effect(() => {
-            // CRITICAL: Read the signals FIRST to establish dependencies, even on first run
-            const limit = currentLimitSignal.get();
-            const cursor = currentCursorSignal.get();
-            if (firstRun) {
-                firstRun = false;
-                return;
-            }
-            // Build new search options with updated pagination
-            const newSearchOptions = {
-                ...productsListService.searchOptions.peek(),
-            };
-            // Update cursor paging
-            if (limit > 0) {
-                newSearchOptions.cursorPaging = {
-                    limit,
-                    ...(cursor && { cursor }),
-                };
-            }
-            else {
-                delete newSearchOptions.cursorPaging;
-            }
-            // Use callback to update search options
-            productsListService.setSearchOptions(newSearchOptions);
-        });
-    }
-    return {
-        currentLimit: currentLimitSignal,
-        currentCursor: currentCursorSignal,
-        hasNextPage: hasNextPageSignal,
-        hasPrevPage: hasPrevPageSignal,
-        setLimit: (limit) => {
-            currentLimitSignal.set(limit);
-            // Reset pagination when changing page size
-            currentCursorSignal.set(null);
-        },
-        loadMore: (count) => {
-            const limit = currentLimitSignal.get();
-            currentLimitSignal.set(limit + count);
-        },
-        nextPage: () => {
-            const pagingMetadata = productsListService.pagingMetadata.get();
-            const nextCursor = pagingMetadata?.cursors?.next;
-            if (nextCursor) {
-                currentCursorSignal.set(nextCursor);
-            }
-        },
-        prevPage: () => {
-            const pagingMetadata = productsListService.pagingMetadata.get();
-            const previousCursor = pagingMetadata?.cursors?.prev;
-            if (previousCursor) {
-                currentCursorSignal.set(previousCursor);
-            }
-        },
-        navigateToFirstPage: () => {
-            currentCursorSignal.set(null);
-        },
-    };
-});
-/**
- * Helper function to extract the current limit from search options.
- * Returns the pagination limit or a default value of 100 if not specified.
- *
- * @private
- * @param {Parameters<typeof productsV3.searchProducts>[0]} searchOptions - The search options object
- * @returns {number} The current limit value
- */
-function getCurrentLimit(searchOptions) {
-    return searchOptions.cursorPaging?.limit || 100;
-}
-/**
- * Helper function to extract the current cursor from search options.
- * Returns the cursor string or null if not specified.
- *
- * @private
- * @param {Parameters<typeof productsV3.searchProducts>[0]} searchOptions - The search options object
- * @returns {string | null} The current cursor value or null
- */
-function getCurrentCursor(searchOptions) {
-    return searchOptions.cursorPaging?.cursor || null;
-}

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

@@ -1,117 +0,0 @@
-import type { Signal } from "@wix/services-definitions/core-services/signals";
-/**
- * Service definition for the Products List Sort service.
- * This defines the reactive API contract for managing product list sorting options.
- *
- * @constant
- */
-export declare const ProductsListSortServiceDefinition: string & {
-    __api: {
-        /** Reactive signal containing the currently selected sort option */
-        selectedSortOption: Signal<string>;
-        /** Function to update the selected sort option */
-        setSelectedSortOption: (sort: string) => void;
-        /** Array of available sort types */
-        sortOptions: SortType[];
-    };
-    __config: {};
-    isServiceDefinition?: boolean;
-} & {
-    /** Reactive signal containing the currently selected sort option */
-    selectedSortOption: Signal<string>;
-    /** Function to update the selected sort option */
-    setSelectedSortOption: (sort: string) => void;
-    /** Array of available sort types */
-    sortOptions: SortType[];
-};
-/**
- * Configuration interface for the Products List Sort service.
- * Currently empty as this service doesn't require initial configuration.
- *
- * @interface ProductsListSortServiceConfig
- */
-export type ProductsListSortServiceConfig = {};
-/**
- * Enumeration of available product sort types.
- * These values correspond to how products can be sorted in the product list.
- *
- * @enum {string}
- */
-export declare enum SortType {
-    /** Sort by newest products first */
-    NEWEST = "newest",
-    /** Sort by product name in ascending order (A-Z) */
-    NAME_ASC = "name_asc",
-    /** Sort by product name in descending order (Z-A) */
-    NAME_DESC = "name_desc",
-    /** Sort by price in ascending order (lowest first) */
-    PRICE_ASC = "price_asc",
-    /** Sort by price in descending order (highest first) */
-    PRICE_DESC = "price_desc",
-    /** Sort by recommended products (algorithm-based) */
-    RECOMMENDED = "recommended"
-}
-/**
- * Implementation of the Products List Sort service that manages reactive sorting state.
- * This service provides signals for the current sort option and automatically updates
- * the products list search options when the sort selection changes.
- *
- * @example
- * ```tsx
- * import { ProductsListSortService, ProductsListSortServiceDefinition, SortType } from '@wix/stores/services';
- * import { useService } from '@wix/services-manager-react';
- *
- * function SortComponent() {
- *   return (
- *     <ServiceProvider services={createServicesMap([
- *       [ProductsListSortServiceDefinition, ProductsListSortService.withConfig({})]
- *     ])}>
- *       <SortSelector />
- *     </ServiceProvider>
- *   );
- * }
- *
- * function SortSelector() {
- *   const sortService = useService(ProductsListSortServiceDefinition);
- *   const selectedSort = sortService.selectedSortOption.get();
- *   const sortOptions = sortService.sortOptions;
- *
- *   return (
- *     <select
- *       value={selectedSort}
- *       onChange={(e) => sortService.setSelectedSortOption(e.target.value)}
- *     >
- *       {sortOptions.map(option => (
- *         <option key={option} value={option}>
- *           {option === SortType.NAME_ASC ? 'Name A-Z' :
- *            option === SortType.NAME_DESC ? 'Name Z-A' :
- *            option === SortType.PRICE_ASC ? 'Price Low to High' :
- *            option === SortType.PRICE_DESC ? 'Price High to Low' :
- *            option === SortType.NEWEST ? 'Newest First' :
- *            'Recommended'}
- *         </option>
- *       ))}
- *     </select>
- *   );
- * }
- * ```
- */
-export declare const ProductsListSortService: import("@wix/services-definitions").ServiceFactory<string & {
-    __api: {
-        /** Reactive signal containing the currently selected sort option */
-        selectedSortOption: Signal<string>;
-        /** Function to update the selected sort option */
-        setSelectedSortOption: (sort: string) => void;
-        /** Array of available sort types */
-        sortOptions: SortType[];
-    };
-    __config: {};
-    isServiceDefinition?: boolean;
-} & {
-    /** Reactive signal containing the currently selected sort option */
-    selectedSortOption: Signal<string>;
-    /** Function to update the selected sort option */
-    setSelectedSortOption: (sort: string) => void;
-    /** Array of available sort types */
-    sortOptions: SortType[];
-}, ProductsListSortServiceConfig>;

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

@@ -1,144 +0,0 @@
-import { defineService, implementService } from "@wix/services-definitions";
-import { SignalsServiceDefinition } from "@wix/services-definitions/core-services/signals";
-import { ProductsListServiceDefinition } from "./products-list-service.js";
-import { productsV3 } from "@wix/stores";
-/**
- * Service definition for the Products List Sort service.
- * This defines the reactive API contract for managing product list sorting options.
- *
- * @constant
- */
-export const ProductsListSortServiceDefinition = defineService("products-list-sort");
-/**
- * Enumeration of available product sort types.
- * These values correspond to how products can be sorted in the product list.
- *
- * @enum {string}
- */
-export var SortType;
-(function (SortType) {
-    /** Sort by newest products first */
-    SortType["NEWEST"] = "newest";
-    /** Sort by product name in ascending order (A-Z) */
-    SortType["NAME_ASC"] = "name_asc";
-    /** Sort by product name in descending order (Z-A) */
-    SortType["NAME_DESC"] = "name_desc";
-    /** Sort by price in ascending order (lowest first) */
-    SortType["PRICE_ASC"] = "price_asc";
-    /** Sort by price in descending order (highest first) */
-    SortType["PRICE_DESC"] = "price_desc";
-    /** Sort by recommended products (algorithm-based) */
-    SortType["RECOMMENDED"] = "recommended";
-})(SortType || (SortType = {}));
-/**
- * Implementation of the Products List Sort service that manages reactive sorting state.
- * This service provides signals for the current sort option and automatically updates
- * the products list search options when the sort selection changes.
- *
- * @example
- * ```tsx
- * import { ProductsListSortService, ProductsListSortServiceDefinition, SortType } from '@wix/stores/services';
- * import { useService } from '@wix/services-manager-react';
- *
- * function SortComponent() {
- *   return (
- *     <ServiceProvider services={createServicesMap([
- *       [ProductsListSortServiceDefinition, ProductsListSortService.withConfig({})]
- *     ])}>
- *       <SortSelector />
- *     </ServiceProvider>
- *   );
- * }
- *
- * function SortSelector() {
- *   const sortService = useService(ProductsListSortServiceDefinition);
- *   const selectedSort = sortService.selectedSortOption.get();
- *   const sortOptions = sortService.sortOptions;
- *
- *   return (
- *     <select
- *       value={selectedSort}
- *       onChange={(e) => sortService.setSelectedSortOption(e.target.value)}
- *     >
- *       {sortOptions.map(option => (
- *         <option key={option} value={option}>
- *           {option === SortType.NAME_ASC ? 'Name A-Z' :
- *            option === SortType.NAME_DESC ? 'Name Z-A' :
- *            option === SortType.PRICE_ASC ? 'Price Low to High' :
- *            option === SortType.PRICE_DESC ? 'Price High to Low' :
- *            option === SortType.NEWEST ? 'Newest First' :
- *            'Recommended'}
- *         </option>
- *       ))}
- *     </select>
- *   );
- * }
- * ```
- */
-export const ProductsListSortService = implementService.withConfig()(ProductsListSortServiceDefinition, ({ getService }) => {
-    let firstRun = true;
-    const signalsService = getService(SignalsServiceDefinition);
-    const productsListService = getService(ProductsListServiceDefinition);
-    const selectedSortOptionSignal = signalsService.signal("name");
-    if (typeof window !== "undefined") {
-        signalsService.effect(() => {
-            const sort = selectedSortOptionSignal.get();
-            if (firstRun) {
-                firstRun = false;
-                return;
-            }
-            const newSearchOptions = {
-                ...productsListService.searchOptions.peek(),
-            };
-            if (!newSearchOptions.sort) {
-                newSearchOptions.sort = [];
-            }
-            else {
-                // Copy existing filter to avoid mutation
-                newSearchOptions.sort = [...newSearchOptions.sort];
-            }
-            switch (sort) {
-                case SortType.NAME_ASC:
-                    newSearchOptions.sort = [
-                        { fieldName: "name", order: productsV3.SortDirection.ASC },
-                    ];
-                    break;
-                case SortType.NAME_DESC:
-                    newSearchOptions.sort = [
-                        { fieldName: "name", order: productsV3.SortDirection.DESC },
-                    ];
-                    break;
-                case SortType.PRICE_ASC:
-                    newSearchOptions.sort = [
-                        {
-                            fieldName: "actualPriceRange.minValue.amount",
-                            order: productsV3.SortDirection.ASC,
-                        },
-                    ];
-                    break;
-                case SortType.PRICE_DESC:
-                    newSearchOptions.sort = [
-                        {
-                            fieldName: "actualPriceRange.minValue.amount",
-                            order: productsV3.SortDirection.DESC,
-                        },
-                    ];
-                    break;
-                case SortType.RECOMMENDED:
-                    newSearchOptions.sort = [
-                        {
-                            fieldName: "name",
-                            order: productsV3.SortDirection.DESC,
-                        },
-                    ];
-                    break;
-            }
-            productsListService.setSearchOptions(newSearchOptions);
-        });
-    }
-    return {
-        selectedSortOption: selectedSortOptionSignal,
-        sortOptions: Object.values(SortType),
-        setSelectedSortOption: (sort) => selectedSortOptionSignal.set(sort),
-    };
-});