@wix/headless-stores 0.0.0

package/dist/services/categories-list-service.d.ts

@@ -0,0 +1,164 @@
+import { type Signal } from '@wix/services-definitions/core-services/signals';
+import { categories } from '@wix/categories';
+export type Category = categories.Category;
+/**
+ * Configuration interface for the Categories List service.
+ * Contains the initial categories data that will be loaded into the service.
+ *
+ * @interface CategoriesListServiceConfig
+ */
+export type CategoriesListServiceConfig = {
+    /** Array of category objects to initialize the service with */
+    categories: Category[];
+};
+/**
+ * Service definition for the Categories List service.
+ * This defines the reactive API contract for managing a list of product categories.
+ *
+ * @constant
+ */
+export declare const CategoriesListServiceDefinition: string & {
+    __api: {
+        /** Reactive signal containing the list of categories */
+        categories: Signal<Category[]>;
+        /** Reactive signal indicating if categories are currently being loaded */
+        isLoading: Signal<boolean>;
+        /** Reactive signal containing any error message, or null if no error */
+        error: Signal<string | null>;
+    };
+    __config: CategoriesListServiceConfig;
+    isServiceDefinition?: boolean;
+} & {
+    /** Reactive signal containing the list of categories */
+    categories: Signal<Category[]>;
+    /** Reactive signal indicating if categories are currently being loaded */
+    isLoading: Signal<boolean>;
+    /** Reactive signal containing any error message, or null if no error */
+    error: Signal<string | null>;
+};
+/**
+ * Implementation of the Categories List service that manages reactive categories data.
+ * This service provides signals for categories data, loading state, and error handling.
+ * The service is initialized with pre-loaded categories and maintains them in reactive signals.
+ *
+ * @example
+ * ```tsx
+ * import { CategoriesListService, CategoriesListServiceDefinition } from '@wix/stores/services';
+ * import { useService } from '@wix/services-manager-react';
+ *
+ * function CategoriesComponent({ categoriesConfig }) {
+ *   return (
+ *     <ServiceProvider services={createServicesMap([
+ *       [CategoriesListServiceDefinition, CategoriesListService.withConfig(categoriesConfig)]
+ *     ])}>
+ *       <CategoriesDisplay />
+ *     </ServiceProvider>
+ *   );
+ * }
+ *
+ * function CategoriesDisplay() {
+ *   const categoriesService = useService(CategoriesListServiceDefinition);
+ *   const categories = categoriesService.categories.get();
+ *   const isLoading = categoriesService.isLoading.get();
+ *   const error = categoriesService.error.get();
+ *
+ *   if (isLoading) return <div>Loading categories...</div>;
+ *   if (error) return <div>Error: {error}</div>;
+ *
+ *   return (
+ *     <ul>
+ *       {categories.map(category => (
+ *         <li key={category._id}>{category.name}</li>
+ *       ))}
+ *     </ul>
+ *   );
+ * }
+ * ```
+ */
+export declare const CategoriesListService: import("@wix/services-definitions").ServiceFactory<string & {
+    __api: {
+        /** Reactive signal containing the list of categories */
+        categories: Signal<Category[]>;
+        /** Reactive signal indicating if categories are currently being loaded */
+        isLoading: Signal<boolean>;
+        /** Reactive signal containing any error message, or null if no error */
+        error: Signal<string | null>;
+    };
+    __config: CategoriesListServiceConfig;
+    isServiceDefinition?: boolean;
+} & {
+    /** Reactive signal containing the list of categories */
+    categories: Signal<Category[]>;
+    /** Reactive signal indicating if categories are currently being loaded */
+    isLoading: Signal<boolean>;
+    /** Reactive signal containing any error message, or null if no error */
+    error: Signal<string | null>;
+}, CategoriesListServiceConfig>;
+/**
+ * Loads categories list service configuration from the Wix Categories API for SSR initialization.
+ * This function is designed to be used during Server-Side Rendering (SSR) to preload
+ * all visible product categories. The "all-products" category is automatically moved to the front of the list.
+ *
+ * @returns {Promise<CategoriesListServiceConfig>} Promise that resolves to the categories configuration
+ *
+ * @example
+ * ```astro
+ * ---
+ * // Astro page example - pages/categories.astro
+ * import { loadCategoriesListServiceConfig } from '@wix/stores/services';
+ * import { CategoryList } from '@wix/stores/components/react';
+ *
+ * // Load categories data during SSR
+ * const categoriesConfig = await loadCategoriesListServiceConfig();
+ * ---
+ *
+ * <CategoryList.Root categoriesConfig={categoriesConfig}>
+ *   <CategoryList.ItemContent>
+ *     {({ category }) => (
+ *       <div>
+ *         <h3>{category.name}</h3>
+ *         <p>{category.description}</p>
+ *       </div>
+ *     )}
+ *   </CategoryList.ItemContent>
+ * </CategoryList.Root>
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Next.js page example - pages/categories.tsx
+ * import { GetServerSideProps } from 'next';
+ * import { loadCategoriesListServiceConfig } from '@wix/stores/services';
+ * import { CategoryList } from '@wix/stores/components/react';
+ *
+ * interface CategoriesPageProps {
+ *   categoriesConfig: Awaited<ReturnType<typeof loadCategoriesListServiceConfig>>;
+ * }
+ *
+ * export const getServerSideProps: GetServerSideProps<CategoriesPageProps> = async () => {
+ *   const categoriesConfig = await loadCategoriesListServiceConfig();
+ *
+ *   return {
+ *     props: {
+ *       categoriesConfig,
+ *     },
+ *   };
+ * };
+ *
+ * export default function CategoriesPage({ categoriesConfig }: CategoriesPageProps) {
+ *   return (
+ *     <CategoryList.Root categoriesConfig={categoriesConfig}>
+ *       <CategoryList.ItemContent>
+ *         {({ category }) => (
+ *           <div>
+ *             <h3>{category.name}</h3>
+ *             <p>{category.description}</p>
+ *           </div>
+ *         )}
+ *       </CategoryList.ItemContent>
+ *     </CategoryList.Root>
+ *   );
+ * }
+ * ```
+ */
+export declare function loadCategoriesListServiceConfig(): Promise<CategoriesListServiceConfig>;

package/dist/services/categories-list-service.js

@@ -0,0 +1,148 @@
+import { defineService, implementService } from '@wix/services-definitions';
+import { SignalsServiceDefinition, } from '@wix/services-definitions/core-services/signals';
+import { categories } from '@wix/categories';
+/**
+ * Service definition for the Categories List service.
+ * This defines the reactive API contract for managing a list of product categories.
+ *
+ * @constant
+ */
+export const CategoriesListServiceDefinition = defineService('categories-list');
+/**
+ * Implementation of the Categories List service that manages reactive categories data.
+ * This service provides signals for categories data, loading state, and error handling.
+ * The service is initialized with pre-loaded categories and maintains them in reactive signals.
+ *
+ * @example
+ * ```tsx
+ * import { CategoriesListService, CategoriesListServiceDefinition } from '@wix/stores/services';
+ * import { useService } from '@wix/services-manager-react';
+ *
+ * function CategoriesComponent({ categoriesConfig }) {
+ *   return (
+ *     <ServiceProvider services={createServicesMap([
+ *       [CategoriesListServiceDefinition, CategoriesListService.withConfig(categoriesConfig)]
+ *     ])}>
+ *       <CategoriesDisplay />
+ *     </ServiceProvider>
+ *   );
+ * }
+ *
+ * function CategoriesDisplay() {
+ *   const categoriesService = useService(CategoriesListServiceDefinition);
+ *   const categories = categoriesService.categories.get();
+ *   const isLoading = categoriesService.isLoading.get();
+ *   const error = categoriesService.error.get();
+ *
+ *   if (isLoading) return <div>Loading categories...</div>;
+ *   if (error) return <div>Error: {error}</div>;
+ *
+ *   return (
+ *     <ul>
+ *       {categories.map(category => (
+ *         <li key={category._id}>{category.name}</li>
+ *       ))}
+ *     </ul>
+ *   );
+ * }
+ * ```
+ */
+export const CategoriesListService = implementService.withConfig()(CategoriesListServiceDefinition, ({ getService, config }) => {
+    const signalsService = getService(SignalsServiceDefinition);
+    const categoriesSignal = signalsService.signal(config.categories);
+    const isLoadingSignal = signalsService.signal(false);
+    const errorSignal = signalsService.signal(null);
+    return {
+        categories: categoriesSignal,
+        isLoading: isLoadingSignal,
+        error: errorSignal,
+    };
+});
+/**
+ * Loads categories list service configuration from the Wix Categories API for SSR initialization.
+ * This function is designed to be used during Server-Side Rendering (SSR) to preload
+ * all visible product categories. The "all-products" category is automatically moved to the front of the list.
+ *
+ * @returns {Promise<CategoriesListServiceConfig>} Promise that resolves to the categories configuration
+ *
+ * @example
+ * ```astro
+ * ---
+ * // Astro page example - pages/categories.astro
+ * import { loadCategoriesListServiceConfig } from '@wix/stores/services';
+ * import { CategoryList } from '@wix/stores/components/react';
+ *
+ * // Load categories data during SSR
+ * const categoriesConfig = await loadCategoriesListServiceConfig();
+ * ---
+ *
+ * <CategoryList.Root categoriesConfig={categoriesConfig}>
+ *   <CategoryList.ItemContent>
+ *     {({ category }) => (
+ *       <div>
+ *         <h3>{category.name}</h3>
+ *         <p>{category.description}</p>
+ *       </div>
+ *     )}
+ *   </CategoryList.ItemContent>
+ * </CategoryList.Root>
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Next.js page example - pages/categories.tsx
+ * import { GetServerSideProps } from 'next';
+ * import { loadCategoriesListServiceConfig } from '@wix/stores/services';
+ * import { CategoryList } from '@wix/stores/components/react';
+ *
+ * interface CategoriesPageProps {
+ *   categoriesConfig: Awaited<ReturnType<typeof loadCategoriesListServiceConfig>>;
+ * }
+ *
+ * export const getServerSideProps: GetServerSideProps<CategoriesPageProps> = async () => {
+ *   const categoriesConfig = await loadCategoriesListServiceConfig();
+ *
+ *   return {
+ *     props: {
+ *       categoriesConfig,
+ *     },
+ *   };
+ * };
+ *
+ * export default function CategoriesPage({ categoriesConfig }: CategoriesPageProps) {
+ *   return (
+ *     <CategoryList.Root categoriesConfig={categoriesConfig}>
+ *       <CategoryList.ItemContent>
+ *         {({ category }) => (
+ *           <div>
+ *             <h3>{category.name}</h3>
+ *             <p>{category.description}</p>
+ *           </div>
+ *         )}
+ *       </CategoryList.ItemContent>
+ *     </CategoryList.Root>
+ *   );
+ * }
+ * ```
+ */
+export async function loadCategoriesListServiceConfig() {
+    const categoriesResponse = await categories
+        .queryCategories({
+        treeReference: {
+            appNamespace: '@wix/stores',
+            treeKey: null,
+        },
+    })
+        .eq('visible', true)
+        .find();
+    const fetchedCategories = categoriesResponse.items || [];
+    // Sort categories to put "all-products" first, keep the rest in original order
+    const allProductsCategory = fetchedCategories.find((cat) => cat.slug === 'all-products');
+    const otherCategories = fetchedCategories.filter((cat) => cat.slug !== 'all-products');
+    const allCategories = allProductsCategory
+        ? [allProductsCategory, ...otherCategories]
+        : fetchedCategories;
+    return {
+        categories: allCategories,
+    };
+}

package/dist/services/index.d.ts

@@ -0,0 +1,5 @@
+export { CategoriesListService, CategoriesListServiceDefinition, loadCategoriesListServiceConfig, CategoriesListServiceConfig, } from './categories-list-service.js';
+export { ProductModifiersService, ProductModifiersServiceDefinition, } from './product-modifiers-service.js';
+export { ProductService, ProductServiceDefinition, loadProductServiceConfig, } from './product-service.js';
+export { SelectedVariantService, SelectedVariantServiceDefinition, } from './selected-variant-service.js';
+export { ProductListService, ProductsListServiceDefinition, loadProductsListServiceConfig, ProductsListServiceConfig, ProductOption, ProductChoice, InventoryStatusType, SortType, InitialSearchState, parseUrlToSearchOptions, convertUrlSortToSortType, } from './products-list-service.js';

package/dist/services/index.js

@@ -0,0 +1,5 @@
+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 { SelectedVariantService, SelectedVariantServiceDefinition, } from './selected-variant-service.js';
+export { ProductListService, ProductsListServiceDefinition, loadProductsListServiceConfig, InventoryStatusType, SortType, parseUrlToSearchOptions, convertUrlSortToSortType, } from './products-list-service.js';

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

@@ -0,0 +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;
+    }>;
+}];