@depict-ai/react-ui 0.0.93 → 0.0.94

package/dist/index.d.ts

@@ -1,388 +1,394 @@
-import { BaseProductListingConfig, BaseProviderConfig, BaseSearchProviderConfig, BaseSearchPageConfig, BaseCategoryPageConfig, CategoryTitle, embedded_num_products, ImagePlaceholderProps, TextPlaceholderProps } from "@depict-ai/ui";
-import { Display } from "@depict-ai/utilishared";
-import React, { ReactNode, PropsWithChildren, ReactElement } from "react";
-import { Locale } from "@depict-ai/ui/locales";
-export const version = "0.0.93";
-interface PLPConfig<T extends Display> extends BaseProductListingConfig {
-    /**
-     * The product card to use for rendering products.
-     */
-    productCard: DepictProductCard<T>;
-}
-/**
- * The Depict product card props.
- */
-export interface DepictProductCardProps<T extends Display> {
-    /** The display data to render. */
-    display: T | null;
-}
-/**
- * Depict product card to use for rendering products.
- */
-export type DepictProductCard<T extends Display> = (props: DepictProductCardProps<T>) => ReactNode;
-type NavigateFunction = (relativeUrl: string) => void;
-/**
- * The config for the DepictProvider.
- */
-type ProviderConfig = BaseProviderConfig & {
-    /**
-     * The function to use for navigating to a new page.
-     * This function will be used internally by our components to navigate.
-     *
-     * You don't need to provide any in a Next.js context.
-     *
-     * @param relativeUrl - The relative url to navigate to.
-     *
-     * @example
-     * Here is how you would use it with react-router, @reach/router, Gatsby or similar.
-     * ```tsx
-     * import { DepictProvider, Navigation } from "@depict-ai/react-ui";
-     * import { useNavigate } from "react-router-dom";
-     * // import { navigate } from "gatsby";
-     *
-     * function Router() {
-     *   const navigate = useNavigate();
-     *   return (
-     *     <DepictProvider
-     *       merchant="houdini"
-     *       market="en-de"
-     *       navigateFunction={navigate}
-     *       search={{
-     *         searchPagePath: "/search",
-     *       }}
-     *     >
-     *       <Routes>[...]</Routes>
-     *     </DepictProvider>
-     *   );
-     * }
-     * ```
-     * @example
-     * If you're using another library, you can define your own navigate function, that's compatible with the `NavigateFunction` type.
-     * ```tsx
-     * const navigateFunction = (relativeUrl: string) => {
-     *  router.push(relativeUrl);
-     * };
-     * ```
-     */
-    navigateFunction?: NavigateFunction;
-    /**
-     * The locale to use for the Depict components.
-     * @default en
-     */
-    locale?: Locale;
-    /**
-     * Unique ID of the currently logged in user, if applicable.
-     */
-    userId?: string;
-    /**
-     * Custom metadata to be sent with each request to the Depict API. Only necessary if specifically instructed by Depict.
-     */
-    metaData?: Record<string, string>;
-    search?: BaseSearchProviderConfig;
-};
-/**
- * The DepictProvider is a wrapper component that should be used to wrap any component that uses Depict components.
- *
- * Make sure it's mounted on every page where the search modal should be available.
- *
- * @param props -  The props for the DepictProvider.
- *
- * @example
- * ```tsx
- *  const App = () => { *
- *    return (
- *      <DepictProvider
- *        merchant="YOUR_MERCHANT"
- *        market="YOUR_MARKET"
- *        search={{
- *          searchPagePath: "/search",
- *        }}
- *      >
- *        <App />
- *      </DepictProvider>
- *    );
- * };
- * ```
- * @returns {JSX.Element} The DepictProvider.
- */
-export function DepictProvider(props: PropsWithChildren<ProviderConfig>): import("react").FunctionComponentElement<{
-    children?: import("react").ReactNode;
-}>;
-/**
- * A component used to align other Depict components to.
- * @example
- * Align the search modal
- * ```tsx
- * import React from "react";
- * import { ComponentAligner, useSearchModal } from "@depict-ai/react-ui";
- *
- * const App = () => {
- *   const ref = React.createRef();
- *
- *   const { open } = useSearchModal({
- *     location: "aligned",
- *     alignerRef: ref,
- *   });
- *
- *   return (
- *     <div>
- *       <ComponentAligner ref={ref} />
- *       <button onClick={open}>Open</button>
- *     </div>
- *   );
- * };
- * ```
- * @returns {JSX.Element}
- */
-export const ComponentAligner: import("react").ForwardRefExoticComponent<import("react").RefAttributes<unknown>>;
-interface SearchPageConfig<T extends Display> extends BaseSearchPageConfig, PLPConfig<T> {
-}
-/**
- * SearchPage is a component that renders a Depict search results page.
- * @param props - The props for the search page.
- *
- * @example
- * ```tsx
- * import { DepictProductCard, ImagePlaceholder, Display, SearchPage } from '@depict-ai/react-ui'
- *
- * function Search() {
- *    return <SearchPage productCard={MyCustomSearchProductCard} />
- * }
- *
- * interface MyCustomDisplay extends Display {}
- *
- * export const MyCustomSearchProductCard: DepictProductCard<MyCustomDisplay> = ({
- *   display,
- * }) => {
- *   if (!display) {
- *     return <ImagePlaceholder aspectRatio={3 / 4} />
- *   }
- *
- *   return (
- *     <>
- *       <MyCustomProductCard
- *         product={{
- *           id: display.product_id,
- *           name: display.title,
- *           description: display.title,
- *           images: [{ url: display.image_url }],
- *           price: {
- *             value: display.sale_price,
- *           },
- *         }}
- *       />
- *     </>
- *   )
- * }
- *
- * ```
- */
-export function SearchPage<T extends Display>(props: SearchPageConfig<T>): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
-interface CategoryPageConfig<T extends Display> extends BaseCategoryPageConfig, PLPConfig<T> {
-    /**
-     * The category id to show.
-     */
-    categoryId: string;
-    /**
-     * categoryTitlePlugin is an optional plugin that can be used to customize the title of the category page.
-     * @default CategoryTitle
-     *
-     * @example
-     * ```tsx
-     * <CategoryPage categoryId="jeans" productCard={MyCustomCategoryProductCard}  categoryTitlePlugin={CategoryTitle} />
-     * ```
-     */
-    categoryTitlePlugin?: typeof CategoryTitle | typeof embedded_num_products;
-}
-/**
- * CategoryPage is a component that renders a Depict category page.
- * @param props the props for the category page.
- *
- * @example
- * ```tsx
- * import { DepictProductCard, ImagePlaceholder, Display, CategoryPage } from '@depict-ai/react-ui'
- *
- * function Category() {
- *  return <CategoryPage categoryId="jeans" productCard={MyCustomCategoryProductCard} />
- * }
- *
- * interface MyCustomDisplay extends Display {}
- *
- * export const MyCustomCategoryProductCard: DepictProductCard<MyCustomDisplay> = ({
- *   display,
- * }) => {
- *   if (!display) {
- *     return <ImagePlaceholder aspectRatio={3 / 4} />
- *   }
- *
- *   return (
- *     <>
- *       <MyCustomProductCard
- *         product={{
- *           id: display.product_id,
- *           name: display.title,
- *           description: display.title,
- *           images: [{ url: display.image_url }],
- *           price: {
- *             value: display.sale_price,
- *           },
- *         }}
- *       />
- *     </>
- *   )
- * }
- * ```
- */
-export function CategoryPage<T extends Display>(props: CategoryPageConfig<T>): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
-/**
- * BreadCrumbs is the "trail" in the header of a category page.
- */
-export function BreadCrumbs(): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
-/**
- * QuickLinks is a component enabling the user to go sideways and downwards in the category tree.
- */
-export function QuickLinks(): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
-/**
- * A placeholder image that can be used in place of an image that is loading.
- * @param props
- * @returns
- */
-export const ImagePlaceholder: React.FC<ImagePlaceholderProps>;
-/** A placeholder text that can be used in place of a text that is loading. */
-export const TextPlaceholder: React.FC<TextPlaceholderProps>;
-/**
- * Parameters to configure the search modal.
- */
-interface UseSearchModalParams {
-    /**
-     * How the modal should be opened.
-     * Will default to "centered" if nothing else is specified.
-     * - "centered" - The modal will be opened in the center of the screen.
-     * - "aligned" - The modal will be opened aligned to the alignerRef element.
-     */
-    location?: ModalLocation;
-    /**
-     * The ref to the element that the modal should be aligned to.
-     * This is only used when location is "aligned".
-     * @default undefined
-     * @example
-     * ```tsx
-        import React from "react";
-        import { ComponentAligner, useSearchModal } from "@depict-ai/react-ui";
-  
-        const App = () => {
-          const ref = React.createRef();
-  
-          const { open } = useSearchModal({
-            location: "aligned",
-            alignerRef: ref,
-          });
-  
-          return (
-            <div>
-              <ComponentAligner ref={ref} />
-              <button onClick={open}>Open</button>
-            </div>
-          );
-        };
-     * ```
-     */
-    alignerRef?: React.RefObject<HTMLElement>;
-}
-type OpenModal = () => void;
-/**
- * How the modal should be opened.
- */
-type ModalLocation = "centered" | "aligned";
-interface UseSearchModalReturn {
-    open: OpenModal;
-}
-/**
- * Hook used to open the search modal.
- * @example
- * Open a centered modal:
- * ```tsx
- * import React from "react";
- * import { useSearchModal } from "@depict-ai/react-ui";
- *
- * const App = () => {
- *   const { open } = useSearchModal({
- *     location: "centered",
- *   });
- *
- *   return (
- *     <div>
- *       <button onClick={open}>Open</button>
- *     </div>
- *   );
- * };
- * ```
- * @returns {JSX.Element}
- */
-export function useSearchModal(params?: UseSearchModalParams): UseSearchModalReturn;
-interface SearchFieldProps {
-    /**
-     * A reference to the DOM element that the modal should be aligned to.
-     *
-     * The top of the modal will be aligned to the top of the element.
-     *
-     * The height of the search field in the modal will be the same as the height of the element.
-     * If not provided, the modal will be aligned to the search field itself.
-     */
-    alignerRef?: React.RefObject<HTMLElement>;
-}
-interface UseSearchFieldReturn {
-    /**
-     * A React component that renders the search field.
-     */
-    SearchField: () => ReactElement;
-}
-/**
- * Hook used to configure the Depict search field.
- * @example
- * Render a search field that opens a modal aligned to the search field itself:
- * ```tsx
- * import React from "react";
- * import { useSearchField } from "@depict-ai/react-ui";
- *
- * const App = () => {
- *   const { SearchField } = useSearchField();
- *
- *   return (
- *     <div>
- *       <SearchField />
- *     </div>
- *   );
- * };
- * ```
- * @example
- * Render a search field that opens a modal aligned another DOM element:
- * ```tsx
- * import React from "react";
- * import { ComponentAligner, useSearchField } from "@depict-ai/react-ui";
- *
- * const App = () => {
- *   const ref = useRef(null);
- *   const { SearchField } = useSearchField({
- *     alignerRef: ref
- *   });
- *
- *   return (
- *     <div>
- *       <ComponentAligner ref={ref} />
- *       <SearchField />
- *     </div>
- *   );
- * };
- * ```
- * @returns {JSX.Element}
- */
-export const useSearchField: (props?: SearchFieldProps) => UseSearchFieldReturn;
-/**
- * Helper function to navigate to a new page depending on the navigation library used.
- */
-export const Navigation: {
-    nextRouterNavigation: (router: import("next/router").NextRouter) => (relativeUrl: string) => void;
-};
-export { CategoryTitle, embedded_num_products as EmbeddedNumProducts } from "@depict-ai/ui";
-export type { Locale } from "@depict-ai/ui/locales";
+import { BaseProductListingConfig, BaseProviderConfig, BaseSearchProviderConfig, BaseSearchPageConfig, BaseCategoryPageConfig, CategoryTitle, embedded_num_products, ImagePlaceholderProps, TextPlaceholderProps } from "@depict-ai/ui";
+import { Display } from "@depict-ai/utilishared";
+import React, { ReactNode, PropsWithChildren, ReactElement } from "react";
+import { Locale } from "@depict-ai/ui/locales";
+export const version = "0.0.94";
+interface PLPConfig<T extends Display> extends BaseProductListingConfig {
+    /**
+     * The product card to use for rendering products.
+     */
+    productCard: DepictProductCard<T>;
+}
+/**
+ * The Depict product card props.
+ */
+export interface DepictProductCardProps<T extends Display> {
+    /** The display data to render. */
+    display: T | null;
+}
+/**
+ * Depict product card to use for rendering products.
+ */
+export type DepictProductCard<T extends Display> = (props: DepictProductCardProps<T>) => ReactNode;
+/**
+ * relativeUrl: The relative url to navigate to.
+ * replace: Whether to replace the current url or push a new one.
+ */
+type NavigateFunction = (relativeUrl: string, { replace }: {
+    replace: any;
+}) => void;
+/**
+ * The config for the DepictProvider.
+ */
+type ProviderConfig = BaseProviderConfig & {
+    /**
+     * The function to use for navigating to a new page.
+     * This function will be used internally by our components to navigate.
+     *
+     * You don't need to provide any in a Next.js context.
+     *
+     * @param relativeUrl - The relative url to navigate to.
+     *
+     * @example
+     * Here is how you would use it with react-router, @reach/router, Gatsby or similar.
+     * ```tsx
+     * import { DepictProvider, Navigation } from "@depict-ai/react-ui";
+     * import { useNavigate } from "react-router-dom";
+     * // import { navigate } from "gatsby";
+     *
+     * function Router() {
+     *   const navigate = useNavigate();
+     *   return (
+     *     <DepictProvider
+     *       merchant="houdini"
+     *       market="en-de"
+     *       navigateFunction={navigate}
+     *       search={{
+     *         searchPagePath: "/search",
+     *       }}
+     *     >
+     *       <Routes>[...]</Routes>
+     *     </DepictProvider>
+     *   );
+     * }
+     * ```
+     * @example
+     * If you're using another library, you can define your own navigate function, that's compatible with the `NavigateFunction` type.
+     * ```tsx
+     * const navigateFunction = (relativeUrl: string) => {
+     *  router.push(relativeUrl);
+     * };
+     * ```
+     */
+    navigateFunction?: NavigateFunction;
+    /**
+     * The locale to use for the Depict components.
+     * @default en
+     */
+    locale?: Locale;
+    /**
+     * Unique ID of the currently logged in user, if applicable.
+     */
+    userId?: string;
+    /**
+     * Custom metadata to be sent with each request to the Depict API. Only necessary if specifically instructed by Depict.
+     */
+    metaData?: Record<string, string>;
+    search?: BaseSearchProviderConfig;
+};
+/**
+ * The DepictProvider is a wrapper component that should be used to wrap any component that uses Depict components.
+ *
+ * Make sure it's mounted on every page where the search modal should be available.
+ *
+ * @param props -  The props for the DepictProvider.
+ *
+ * @example
+ * ```tsx
+ *  const App = () => { *
+ *    return (
+ *      <DepictProvider
+ *        merchant="YOUR_MERCHANT"
+ *        market="YOUR_MARKET"
+ *        search={{
+ *          searchPagePath: "/search",
+ *        }}
+ *      >
+ *        <App />
+ *      </DepictProvider>
+ *    );
+ * };
+ * ```
+ * @returns {JSX.Element} The DepictProvider.
+ */
+export function DepictProvider(props: PropsWithChildren<ProviderConfig>): import("react").FunctionComponentElement<{
+    children?: import("react").ReactNode;
+}>;
+/**
+ * A component used to align other Depict components to.
+ * @example
+ * Align the search modal
+ * ```tsx
+ * import React from "react";
+ * import { ComponentAligner, useSearchModal } from "@depict-ai/react-ui";
+ *
+ * const App = () => {
+ *   const ref = React.createRef();
+ *
+ *   const { open } = useSearchModal({
+ *     location: "aligned",
+ *     alignerRef: ref,
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <ComponentAligner ref={ref} />
+ *       <button onClick={open}>Open</button>
+ *     </div>
+ *   );
+ * };
+ * ```
+ * @returns {JSX.Element}
+ */
+export const ComponentAligner: import("react").ForwardRefExoticComponent<import("react").RefAttributes<unknown>>;
+interface SearchPageConfig<T extends Display> extends BaseSearchPageConfig, PLPConfig<T> {
+}
+/**
+ * SearchPage is a component that renders a Depict search results page.
+ * @param props - The props for the search page.
+ *
+ * @example
+ * ```tsx
+ * import { DepictProductCard, ImagePlaceholder, Display, SearchPage } from '@depict-ai/react-ui'
+ *
+ * function Search() {
+ *    return <SearchPage productCard={MyCustomSearchProductCard} />
+ * }
+ *
+ * interface MyCustomDisplay extends Display {}
+ *
+ * export const MyCustomSearchProductCard: DepictProductCard<MyCustomDisplay> = ({
+ *   display,
+ * }) => {
+ *   if (!display) {
+ *     return <ImagePlaceholder aspectRatio={3 / 4} />
+ *   }
+ *
+ *   return (
+ *     <>
+ *       <MyCustomProductCard
+ *         product={{
+ *           id: display.product_id,
+ *           name: display.title,
+ *           description: display.title,
+ *           images: [{ url: display.image_url }],
+ *           price: {
+ *             value: display.sale_price,
+ *           },
+ *         }}
+ *       />
+ *     </>
+ *   )
+ * }
+ *
+ * ```
+ */
+export function SearchPage<T extends Display>(props: SearchPageConfig<T>): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
+interface CategoryPageConfig<T extends Display> extends BaseCategoryPageConfig, PLPConfig<T> {
+    /**
+     * The category id to show.
+     */
+    categoryId: string;
+    /**
+     * categoryTitlePlugin is an optional plugin that can be used to customize the title of the category page.
+     * @default CategoryTitle
+     *
+     * @example
+     * ```tsx
+     * <CategoryPage categoryId="jeans" productCard={MyCustomCategoryProductCard}  categoryTitlePlugin={CategoryTitle} />
+     * ```
+     */
+    categoryTitlePlugin?: typeof CategoryTitle | typeof embedded_num_products;
+}
+/**
+ * CategoryPage is a component that renders a Depict category page.
+ * @param props the props for the category page.
+ *
+ * @example
+ * ```tsx
+ * import { DepictProductCard, ImagePlaceholder, Display, CategoryPage } from '@depict-ai/react-ui'
+ *
+ * function Category() {
+ *  return <CategoryPage categoryId="jeans" productCard={MyCustomCategoryProductCard} />
+ * }
+ *
+ * interface MyCustomDisplay extends Display {}
+ *
+ * export const MyCustomCategoryProductCard: DepictProductCard<MyCustomDisplay> = ({
+ *   display,
+ * }) => {
+ *   if (!display) {
+ *     return <ImagePlaceholder aspectRatio={3 / 4} />
+ *   }
+ *
+ *   return (
+ *     <>
+ *       <MyCustomProductCard
+ *         product={{
+ *           id: display.product_id,
+ *           name: display.title,
+ *           description: display.title,
+ *           images: [{ url: display.image_url }],
+ *           price: {
+ *             value: display.sale_price,
+ *           },
+ *         }}
+ *       />
+ *     </>
+ *   )
+ * }
+ * ```
+ */
+export function CategoryPage<T extends Display>(props: CategoryPageConfig<T>): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
+/**
+ * BreadCrumbs is the "trail" in the header of a category page.
+ */
+export function BreadCrumbs(): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
+/**
+ * QuickLinks is a component enabling the user to go sideways and downwards in the category tree.
+ */
+export function QuickLinks(): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
+/**
+ * A placeholder image that can be used in place of an image that is loading.
+ * @param props
+ * @returns
+ */
+export const ImagePlaceholder: React.FC<ImagePlaceholderProps>;
+/** A placeholder text that can be used in place of a text that is loading. */
+export const TextPlaceholder: React.FC<TextPlaceholderProps>;
+/**
+ * Parameters to configure the search modal.
+ */
+interface UseSearchModalParams {
+    /**
+     * How the modal should be opened.
+     * Will default to "centered" if nothing else is specified.
+     * - "centered" - The modal will be opened in the center of the screen.
+     * - "aligned" - The modal will be opened aligned to the alignerRef element.
+     */
+    location?: ModalLocation;
+    /**
+     * The ref to the element that the modal should be aligned to.
+     * This is only used when location is "aligned".
+     * @default undefined
+     * @example
+     * ```tsx
+        import React from "react";
+        import { ComponentAligner, useSearchModal } from "@depict-ai/react-ui";
+  
+        const App = () => {
+          const ref = React.createRef();
+  
+          const { open } = useSearchModal({
+            location: "aligned",
+            alignerRef: ref,
+          });
+  
+          return (
+            <div>
+              <ComponentAligner ref={ref} />
+              <button onClick={open}>Open</button>
+            </div>
+          );
+        };
+     * ```
+     */
+    alignerRef?: React.RefObject<HTMLElement>;
+}
+type OpenModal = () => void;
+/**
+ * How the modal should be opened.
+ */
+type ModalLocation = "centered" | "aligned";
+interface UseSearchModalReturn {
+    open: OpenModal;
+}
+/**
+ * Hook used to open the search modal.
+ * @example
+ * Open a centered modal:
+ * ```tsx
+ * import React from "react";
+ * import { useSearchModal } from "@depict-ai/react-ui";
+ *
+ * const App = () => {
+ *   const { open } = useSearchModal({
+ *     location: "centered",
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={open}>Open</button>
+ *     </div>
+ *   );
+ * };
+ * ```
+ * @returns {JSX.Element}
+ */
+export function useSearchModal(params?: UseSearchModalParams): UseSearchModalReturn;
+interface SearchFieldProps {
+    /**
+     * A reference to the DOM element that the modal should be aligned to.
+     *
+     * The top of the modal will be aligned to the top of the element.
+     *
+     * The height of the search field in the modal will be the same as the height of the element.
+     * If not provided, the modal will be aligned to the search field itself.
+     */
+    alignerRef?: React.RefObject<HTMLElement>;
+}
+interface UseSearchFieldReturn {
+    /**
+     * A React component that renders the search field.
+     */
+    SearchField: () => ReactElement;
+}
+/**
+ * Hook used to configure the Depict search field.
+ * @example
+ * Render a search field that opens a modal aligned to the search field itself:
+ * ```tsx
+ * import React from "react";
+ * import { useSearchField } from "@depict-ai/react-ui";
+ *
+ * const App = () => {
+ *   const { SearchField } = useSearchField();
+ *
+ *   return (
+ *     <div>
+ *       <SearchField />
+ *     </div>
+ *   );
+ * };
+ * ```
+ * @example
+ * Render a search field that opens a modal aligned another DOM element:
+ * ```tsx
+ * import React from "react";
+ * import { ComponentAligner, useSearchField } from "@depict-ai/react-ui";
+ *
+ * const App = () => {
+ *   const ref = useRef(null);
+ *   const { SearchField } = useSearchField({
+ *     alignerRef: ref
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <ComponentAligner ref={ref} />
+ *       <SearchField />
+ *     </div>
+ *   );
+ * };
+ * ```
+ * @returns {JSX.Element}
+ */
+export const useSearchField: (props?: SearchFieldProps) => UseSearchFieldReturn;
+/**
+ * Helper function to navigate to a new page depending on the navigation library used.
+ */
+export const Navigation: {
+    nextRouterNavigation: (router: import("next/router").NextRouter) => (relativeUrl: string) => void;
+};
+export { CategoryTitle, embedded_num_products as EmbeddedNumProducts } from "@depict-ai/ui";
+export type { Locale } from "@depict-ai/ui/locales";