@wix/headless-stores 0.0.36 → 0.0.37

package/dist/services/index.js

@@ -1,20 +1,9 @@
-// export {
-//   buyNowServiceBinding,
-//   loadBuyNowServiceInitialData,
-// } from "./buy-now-service.js";
-// export {
-//   payNowServiceBinding,
-//   loadPayNowServiceInitialData,
-// } from "./pay-now-service.js";
-export { CatalogService, CatalogServiceDefinition,
-// loadCatalogServiceConfig,
- } from "./catalog-service.js";
-export { CategoryService, CategoryServiceDefinition, loadCategoriesConfig, } from "./category-service.js";
-export { CollectionService, CollectionServiceDefinition, loadCollectionServiceConfig, } from "./collection-service.js";
-export { FilterService, FilterServiceDefinition, } from "./filter-service.js";
+export { CategoryService, CategoryServiceDefinition, loadCategoryServiceConfig, } from "./category-service.js";
+export { CategoriesListService, CategoriesListServiceDefinition, loadCategoriesListServiceConfig, } from "./categories-list-service.js";
 export { ProductModifiersService, ProductModifiersServiceDefinition, } from "./product-modifiers-service.js";
 export { ProductService, ProductServiceDefinition, loadProductServiceConfig, } from "./product-service.js";
-export { RelatedProductsService, RelatedProductsServiceDefinition, loadRelatedProductsServiceConfig, } from "./related-products-service.js";
 export { SelectedVariantService, SelectedVariantServiceDefinition, } from "./selected-variant-service.js";
 export { ProductListService, ProductsListServiceDefinition, loadProductsListServiceConfig, } from "./products-list-service.js";
-export { SortService, SortServiceDefinition } from "./sort-service.js";
+export { SortType, ProductsListSortService, ProductsListSortServiceDefinition, } from "./products-list-sort-service.js";
+export { InventoryStatusType, ProductsListFiltersService, ProductsListFiltersServiceDefinition, loadProductsListFiltersServiceConfig, } from "./products-list-filters-service.js";
+export { ProductsListPaginationService, ProductsListPaginationServiceDefinition, } from "./products-list-pagination-service.js";

package/dist/services/pay-now-service.d.ts

@@ -1,68 +1,214 @@
 import { type Signal } from "@wix/services-definitions/core-services/signals";
+/**
+ * Service definition for the Pay Now service.
+ * This defines the reactive API contract for managing custom payment checkout functionality.
+ *
+ * @constant
+ */
 export declare const PayNowServiceDefinition: string & {
     __api: {
+        /** Function to redirect to checkout using custom checkout action */
         redirectToCheckout: () => Promise<void>;
+        /** Reactive signal indicating if a checkout redirect is in progress */
         loadingSignal: Signal<boolean>;
+        /** Reactive signal containing any error message, or null if no error */
         errorSignal: Signal<string | null>;
     };
     __config: {};
     isServiceDefinition?: boolean;
 } & {
+    /** Function to redirect to checkout using custom checkout action */
     redirectToCheckout: () => Promise<void>;
+    /** Reactive signal indicating if a checkout redirect is in progress */
     loadingSignal: Signal<boolean>;
+    /** Reactive signal containing any error message, or null if no error */
     errorSignal: Signal<string | null>;
 };
+/**
+ * Configuration interface for the Pay Now service.
+ * Contains an optional custom checkout action function.
+ *
+ * @interface PayNowServiceConfig
+ */
 export interface PayNowServiceConfig {
+    /** Optional custom checkout action that returns a checkout URL or error */
     customCheckoutAction?: () => Promise<{
+        /** The checkout URL to redirect to */
         data: string | undefined;
+        /** Any error that occurred during checkout creation */
         error: unknown;
     }>;
 }
+/**
+ * Implementation of the Pay Now service that manages custom payment checkout functionality.
+ * This service provides signals for loading state and error handling, along with a method
+ * to redirect to checkout using a custom checkout action.
+ *
+ * @example
+ * ```tsx
+ * import { PayNowServiceImplementation, PayNowServiceDefinition } from '@wix/stores/services';
+ * import { useService } from '@wix/services-manager-react';
+ *
+ * function PayNowComponent({ payNowConfig }) {
+ *   return (
+ *     <ServiceProvider services={createServicesMap([
+ *       [PayNowServiceDefinition, PayNowServiceImplementation.withConfig(payNowConfig)]
+ *     ])}>
+ *       <PayNowButton />
+ *     </ServiceProvider>
+ *   );
+ * }
+ *
+ * function PayNowButton() {
+ *   const payNowService = useService(PayNowServiceDefinition);
+ *   const isLoading = payNowService.loadingSignal.get();
+ *   const error = payNowService.errorSignal.get();
+ *
+ *   const handlePayNow = async () => {
+ *     await payNowService.redirectToCheckout();
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       {error && <div className="error">{error}</div>}
+ *       <button
+ *         onClick={handlePayNow}
+ *         disabled={isLoading}
+ *         className="pay-now-btn"
+ *       >
+ *         {isLoading ? 'Processing...' : 'Pay Now'}
+ *       </button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
 export declare const PayNowServiceImplementation: import("@wix/services-definitions").ServiceFactory<string & {
     __api: {
+        /** Function to redirect to checkout using custom checkout action */
         redirectToCheckout: () => Promise<void>;
+        /** Reactive signal indicating if a checkout redirect is in progress */
         loadingSignal: Signal<boolean>;
+        /** Reactive signal containing any error message, or null if no error */
         errorSignal: Signal<string | null>;
     };
     __config: {};
     isServiceDefinition?: boolean;
 } & {
+    /** Function to redirect to checkout using custom checkout action */
     redirectToCheckout: () => Promise<void>;
+    /** Reactive signal indicating if a checkout redirect is in progress */
     loadingSignal: Signal<boolean>;
+    /** Reactive signal containing any error message, or null if no error */
     errorSignal: Signal<string | null>;
 }, PayNowServiceConfig>;
+/**
+ * Loads pay now service initial data for SSR initialization.
+ * This function returns an empty configuration as the Pay Now service
+ * is typically configured with custom checkout actions at runtime.
+ *
+ * @returns {Promise} Promise that resolves to an empty pay now service configuration
+ *
+ * @example
+ * ```astro
+ * ---
+ * // Astro page example
+ * import { loadPayNowServiceInitialData } from '@wix/stores/services';
+ * import { PayNow } from '@wix/stores/components';
+ *
+ * // Load initial data (empty for PayNow)
+ * const payNowData = await loadPayNowServiceInitialData();
+ * ---
+ *
+ * <PayNow.PayNow payNowConfig={payNowData.PayNow}>
+ *   {({ redirectToCheckout, isLoading, error }) => (
+ *     <button onClick={redirectToCheckout} disabled={isLoading}>
+ *       {isLoading ? 'Processing...' : 'Pay Now'}
+ *     </button>
+ *   )}
+ * </PayNow.PayNow>
+ * ```
+ */
 export declare const loadPayNowServiceInitialData: () => Promise<{
     [PayNowServiceDefinition]: {};
 }>;
+/**
+ * Helper function to create a pay now service binding with configuration.
+ * This function simplifies the process of binding the pay now service with its configuration
+ * and allows for additional configuration overrides, particularly for custom checkout actions.
+ *
+ * @template T - Type of the services configurations object
+ * @param {T} servicesConfigs - Object containing service configurations
+ * @param {Partial<PayNowServiceConfig>} [additionalConfig={}] - Additional configuration to override defaults
+ * @returns Tuple containing service definition, implementation, and merged configuration
+ *
+ * @example
+ * ```tsx
+ * import { payNowServiceBinding, loadPayNowServiceInitialData } from '@wix/stores/services';
+ * import { actions } from 'astro:actions';
+ *
+ * // Load initial data
+ * const initialData = await loadPayNowServiceInitialData();
+ *
+ * // Create service binding with custom checkout action
+ * const payNowBinding = payNowServiceBinding(initialData, {
+ *   customCheckoutAction: async () => {
+ *     try {
+ *       const result = await actions.customCheckout();
+ *       return { data: result, error: null };
+ *     } catch (error) {
+ *       return { data: undefined, error };
+ *     }
+ *   }
+ * });
+ *
+ * // Use in service provider
+ * const services = createServicesMap([payNowBinding]);
+ * ```
+ */
 export declare const payNowServiceBinding: <T extends {
     [key: string]: Awaited<ReturnType<typeof loadPayNowServiceInitialData>>[typeof PayNowServiceDefinition];
 }>(servicesConfigs: T, additionalConfig?: Partial<PayNowServiceConfig>) => readonly [string & {
     __api: {
+        /** Function to redirect to checkout using custom checkout action */
         redirectToCheckout: () => Promise<void>;
+        /** Reactive signal indicating if a checkout redirect is in progress */
         loadingSignal: Signal<boolean>;
+        /** Reactive signal containing any error message, or null if no error */
         errorSignal: Signal<string | null>;
     };
     __config: {};
     isServiceDefinition?: boolean;
 } & {
+    /** Function to redirect to checkout using custom checkout action */
     redirectToCheckout: () => Promise<void>;
+    /** Reactive signal indicating if a checkout redirect is in progress */
     loadingSignal: Signal<boolean>;
+    /** Reactive signal containing any error message, or null if no error */
     errorSignal: Signal<string | null>;
 }, import("@wix/services-definitions").ServiceFactory<string & {
     __api: {
+        /** Function to redirect to checkout using custom checkout action */
         redirectToCheckout: () => Promise<void>;
+        /** Reactive signal indicating if a checkout redirect is in progress */
         loadingSignal: Signal<boolean>;
+        /** Reactive signal containing any error message, or null if no error */
         errorSignal: Signal<string | null>;
     };
     __config: {};
     isServiceDefinition?: boolean;
 } & {
+    /** Function to redirect to checkout using custom checkout action */
     redirectToCheckout: () => Promise<void>;
+    /** Reactive signal indicating if a checkout redirect is in progress */
     loadingSignal: Signal<boolean>;
+    /** Reactive signal containing any error message, or null if no error */
     errorSignal: Signal<string | null>;
 }, PayNowServiceConfig>, {
     customCheckoutAction?: () => Promise<{
+        /** The checkout URL to redirect to */
         data: string | undefined;
+        /** Any error that occurred during checkout creation */
         error: unknown;
     }>;
 }];

package/dist/services/pay-now-service.js

@@ -1,6 +1,56 @@
-import { defineService, implementService, } from "@wix/services-definitions";
+import { defineService, implementService } from "@wix/services-definitions";
 import { SignalsServiceDefinition, } from "@wix/services-definitions/core-services/signals";
+/**
+ * Service definition for the Pay Now service.
+ * This defines the reactive API contract for managing custom payment checkout functionality.
+ *
+ * @constant
+ */
 export const PayNowServiceDefinition = defineService("PayNow");
+/**
+ * Implementation of the Pay Now service that manages custom payment checkout functionality.
+ * This service provides signals for loading state and error handling, along with a method
+ * to redirect to checkout using a custom checkout action.
+ *
+ * @example
+ * ```tsx
+ * import { PayNowServiceImplementation, PayNowServiceDefinition } from '@wix/stores/services';
+ * import { useService } from '@wix/services-manager-react';
+ *
+ * function PayNowComponent({ payNowConfig }) {
+ *   return (
+ *     <ServiceProvider services={createServicesMap([
+ *       [PayNowServiceDefinition, PayNowServiceImplementation.withConfig(payNowConfig)]
+ *     ])}>
+ *       <PayNowButton />
+ *     </ServiceProvider>
+ *   );
+ * }
+ *
+ * function PayNowButton() {
+ *   const payNowService = useService(PayNowServiceDefinition);
+ *   const isLoading = payNowService.loadingSignal.get();
+ *   const error = payNowService.errorSignal.get();
+ *
+ *   const handlePayNow = async () => {
+ *     await payNowService.redirectToCheckout();
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       {error && <div className="error">{error}</div>}
+ *       <button
+ *         onClick={handlePayNow}
+ *         disabled={isLoading}
+ *         className="pay-now-btn"
+ *       >
+ *         {isLoading ? 'Processing...' : 'Pay Now'}
+ *       </button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
 export const PayNowServiceImplementation = implementService.withConfig()(PayNowServiceDefinition, ({ getService, config }) => {
     const signalsService = getService(SignalsServiceDefinition);
     const loadingSignal = signalsService.signal(false);
@@ -28,11 +78,72 @@ export const PayNowServiceImplementation = implementService.withConfig()(PayNowS
         errorSignal,
     };
 });
+/**
+ * Loads pay now service initial data for SSR initialization.
+ * This function returns an empty configuration as the Pay Now service
+ * is typically configured with custom checkout actions at runtime.
+ *
+ * @returns {Promise} Promise that resolves to an empty pay now service configuration
+ *
+ * @example
+ * ```astro
+ * ---
+ * // Astro page example
+ * import { loadPayNowServiceInitialData } from '@wix/stores/services';
+ * import { PayNow } from '@wix/stores/components';
+ *
+ * // Load initial data (empty for PayNow)
+ * const payNowData = await loadPayNowServiceInitialData();
+ * ---
+ *
+ * <PayNow.PayNow payNowConfig={payNowData.PayNow}>
+ *   {({ redirectToCheckout, isLoading, error }) => (
+ *     <button onClick={redirectToCheckout} disabled={isLoading}>
+ *       {isLoading ? 'Processing...' : 'Pay Now'}
+ *     </button>
+ *   )}
+ * </PayNow.PayNow>
+ * ```
+ */
 export const loadPayNowServiceInitialData = async () => {
     return {
         [PayNowServiceDefinition]: {},
     };
 };
+/**
+ * Helper function to create a pay now service binding with configuration.
+ * This function simplifies the process of binding the pay now service with its configuration
+ * and allows for additional configuration overrides, particularly for custom checkout actions.
+ *
+ * @template T - Type of the services configurations object
+ * @param {T} servicesConfigs - Object containing service configurations
+ * @param {Partial<PayNowServiceConfig>} [additionalConfig={}] - Additional configuration to override defaults
+ * @returns Tuple containing service definition, implementation, and merged configuration
+ *
+ * @example
+ * ```tsx
+ * import { payNowServiceBinding, loadPayNowServiceInitialData } from '@wix/stores/services';
+ * import { actions } from 'astro:actions';
+ *
+ * // Load initial data
+ * const initialData = await loadPayNowServiceInitialData();
+ *
+ * // Create service binding with custom checkout action
+ * const payNowBinding = payNowServiceBinding(initialData, {
+ *   customCheckoutAction: async () => {
+ *     try {
+ *       const result = await actions.customCheckout();
+ *       return { data: result, error: null };
+ *     } catch (error) {
+ *       return { data: undefined, error };
+ *     }
+ *   }
+ * });
+ *
+ * // Use in service provider
+ * const services = createServicesMap([payNowBinding]);
+ * ```
+ */
 export const payNowServiceBinding = (servicesConfigs, additionalConfig = {}) => {
     return [
         PayNowServiceDefinition,

package/dist/services/product-service.d.ts

@@ -1,29 +1,100 @@
 import { type Signal } from "@wix/services-definitions/core-services/signals";
 import * as productsV3 from "@wix/auto_sdk_stores_products-v-3";
+/**
+ * API interface for the Product service, providing reactive product data management.
+ * This service handles loading and managing a single product's data, loading state, and errors.
+ *
+ * @interface ProductServiceAPI
+ */
 export interface ProductServiceAPI {
+    /** Reactive signal containing the current product data */
     product: Signal<productsV3.V3Product>;
+    /** Reactive signal indicating if a product is currently being loaded */
     isLoading: Signal<boolean>;
+    /** Reactive signal containing any error message, or null if no error */
     error: Signal<string | null>;
+    /** Function to load a product by its slug */
     loadProduct: (slug: string) => Promise<void>;
 }
+/**
+ * Service definition for the Product service.
+ * This defines the contract that the ProductService must implement.
+ *
+ * @constant
+ */
 export declare const ProductServiceDefinition: string & {
     __api: ProductServiceAPI;
     __config: {};
     isServiceDefinition?: boolean;
 } & ProductServiceAPI;
+/**
+ * Configuration interface required to initialize the ProductService.
+ * Contains the initial product data that will be loaded into the service.
+ *
+ * @interface ProductServiceConfig
+ */
 export interface ProductServiceConfig {
+    /** The initial product data to configure the service with */
     product: productsV3.V3Product;
 }
+/**
+ * Implementation of the Product service that manages reactive product data.
+ * This service provides signals for product data, loading state, and error handling,
+ * along with methods to dynamically load products.
+ *
+ * @example
+ * ```tsx
+ * import { ProductService, ProductServiceDefinition } from '@wix/stores/services';
+ * import { useService } from '@wix/services-manager-react';
+ *
+ * function ProductComponent({ productConfig }) {
+ *   return (
+ *     <ServiceProvider services={createServicesMap([
+ *       [ProductServiceDefinition, ProductService.withConfig(productConfig)]
+ *     ])}>
+ *       <ProductDisplay />
+ *     </ServiceProvider>
+ *   );
+ * }
+ *
+ * function ProductDisplay() {
+ *   const productService = useService(ProductServiceDefinition);
+ *   const product = productService.product.get();
+ *   const isLoading = productService.isLoading.get();
+ *   const error = productService.error.get();
+ *
+ *   if (isLoading) return <div>Loading...</div>;
+ *   if (error) return <div>Error: {error}</div>;
+ *
+ *   return <h1>{product.name}</h1>;
+ * }
+ * ```
+ */
 export declare const ProductService: import("@wix/services-definitions").ServiceFactory<string & {
     __api: ProductServiceAPI;
     __config: {};
     isServiceDefinition?: boolean;
 } & ProductServiceAPI, ProductServiceConfig>;
+/**
+ * Success result interface for product service configuration loading.
+ * Returned when a product is successfully found and loaded.
+ *
+ * @interface SuccessProductServiceConfigResult
+ */
 export interface SuccessProductServiceConfigResult {
+    /** Type "success" means that the product was found and the config is valid */
     type: "success";
+    /** The product config containing the loaded product data */
     config: ProductServiceConfig;
 }
+/**
+ * Not found result interface for product service configuration loading.
+ * Returned when a product with the given slug cannot be found.
+ *
+ * @interface NotFoundProductServiceConfigResult
+ */
 export interface NotFoundProductServiceConfigResult {
+    /** Type "notFound" means that the product was not found */
     type: "notFound";
 }
 /**

package/dist/services/product-service.js

@@ -1,7 +1,46 @@
 import { defineService, implementService } from "@wix/services-definitions";
 import { SignalsServiceDefinition, } from "@wix/services-definitions/core-services/signals";
 import * as productsV3 from "@wix/auto_sdk_stores_products-v-3";
+/**
+ * Service definition for the Product service.
+ * This defines the contract that the ProductService must implement.
+ *
+ * @constant
+ */
 export const ProductServiceDefinition = defineService("product");
+/**
+ * Implementation of the Product service that manages reactive product data.
+ * This service provides signals for product data, loading state, and error handling,
+ * along with methods to dynamically load products.
+ *
+ * @example
+ * ```tsx
+ * import { ProductService, ProductServiceDefinition } from '@wix/stores/services';
+ * import { useService } from '@wix/services-manager-react';
+ *
+ * function ProductComponent({ productConfig }) {
+ *   return (
+ *     <ServiceProvider services={createServicesMap([
+ *       [ProductServiceDefinition, ProductService.withConfig(productConfig)]
+ *     ])}>
+ *       <ProductDisplay />
+ *     </ServiceProvider>
+ *   );
+ * }
+ *
+ * function ProductDisplay() {
+ *   const productService = useService(ProductServiceDefinition);
+ *   const product = productService.product.get();
+ *   const isLoading = productService.isLoading.get();
+ *   const error = productService.error.get();
+ *
+ *   if (isLoading) return <div>Loading...</div>;
+ *   if (error) return <div>Error: {error}</div>;
+ *
+ *   return <h1>{product.name}</h1>;
+ * }
+ * ```
+ */
 export const ProductService = implementService.withConfig()(ProductServiceDefinition, ({ getService, config }) => {
     const signalsService = getService(SignalsServiceDefinition);
     const product = signalsService.signal(config.product);
@@ -26,6 +65,14 @@ export const ProductService = implementService.withConfig()(ProductServiceDefini
         loadProduct,
     };
 });
+/**
+ * Internal helper function to load a product by its slug from the Wix Products API.
+ * Fetches comprehensive product data including description, categories, media, etc.
+ *
+ * @private
+ * @param {string} slug - The product slug to load
+ * @returns {Promise} Product response from the API
+ */
 const loadProductBySlug = async (slug) => {
     const productResponse = await productsV3.getProductBySlug(slug, {
         fields: [