@depict-ai/react-ui 0.0.106 → 1.0.3

package/dist/index.d.ts

@@ -1,9 +1,9 @@
-import { BaseProductListingConfig, BaseProviderConfig, BaseSearchProviderConfig, BaseSearchPageConfig, BaseCategoryPageConfig, CategoryTitle, embedded_num_products, ImagePlaceholderProps, TextPlaceholderProps } from "@depict-ai/ui";
+import { BaseProductListingConfig, BaseProviderConfig, BaseSearchProviderConfig, BaseSearchPageConfig, BaseCategoryPageConfig, CategoryTitle, embedded_num_products, ImagePlaceholderProps, TextPlaceholderProps, fetchDepictRecommendations, ExclusiveId } from "@depict-ai/ui";
 import { Display } from "@depict-ai/utilishared";
 import React, { ReactNode, PropsWithChildren, ReactElement } from "react";
 import { DPC } from "@depict-ai/dpc";
 import { Locale } from "@depict-ai/ui/locales";
-export const version = "0.0.106";
+export const version = "1.0.3";
 interface PLPConfig<T extends Display> extends BaseProductListingConfig {
     /**
      * The product card to use for rendering products.
@@ -38,7 +38,7 @@ interface UsePerformanceClientReturn {
  *
  *   useEffect(() => {
  *     dpc.setProductId(productId);
- *   }, [dpc]);
+ *   }, [dpc, productId]);
  *
  *   return <div>Showing product {productId}</div>;
  * }
@@ -410,11 +410,80 @@ interface UseSearchFieldReturn {
  * @returns {UseSearchFieldReturn}
  */
 export const useSearchField: (props?: SearchFieldProps) => UseSearchFieldReturn;
+type FetchRecsOptions = Omit<Parameters<typeof fetchDepictRecommendations>[0], "merchant" | "market" | "userId" | "sessionId"> & ExclusiveId;
+interface UseFetchRecommendationsReturn<T extends Display> {
+    /**
+     * Fetch recommendations from the Depict API.
+     * @example
+     * General recommendations for a landing page:
+     * ```tsx
+     * fetchRecommendations({ type: "landing_page" });
+     * ```
+     * @example
+     * Fetch targeted recommendations for a product details page (PDP):
+     * ```tsx
+     * fetchRecommendations({ type: "related", productId: "t-shirt-white" })
+     * ```
+     * @returns {Promise<T[]>}
+     */
+    fetchRecommendations: (opts: FetchRecsOptions) => Promise<T[]>;
+}
+/**
+ * Hook used to fetch Depict recommendations.
+ * @example
+ * Fetch general recommendations for a landing page:
+ * ```tsx
+ * import React from "react";
+ * import { useFetchRecommendations } from "@depict-ai/react-ui";
+ *
+ * export const LandingPage = () => {
+ *   const [recs, setRecs] = React.useState();
+ *   const { fetchRecommendations } = useFetchRecommendations();
+ *
+ *   React.useEffect(() => {
+ *     fetchRecommendations({ type: "landing_page" }).then(setRecs);
+ *   }, [fetchRecommendations]);
+ *
+ *   return (
+ *     <div>
+ *      {recs?.map((display) => (
+ *        <ProductCard display={display} />
+ *      ))}
+ *     </div>
+ *   );
+ * };
+ * ```
+ * @example
+ * Fetch targeted recommendations for a product details page (PDP):
+ * ```tsx
+ * import React from "react";
+ * import { useFetchRecommendations } from "@depict-ai/react-ui";
+ *
+ * export const ProductPage = ({ productId }) => {
+ *   const [recs, setRecs] = React.useState();
+ *   const { fetchRecommendations } = useFetchRecommendations();
+ *
+ *   React.useEffect(() => {
+ *     fetchRecommendations({ type: "related", productId }).then(setRecs);
+ *   }, [fetchRecommendations, productId]);
+ *
+ *   return (
+ *     <div>
+ *      {recs?.map((display) => (
+ *        <ProductCard display={display} />
+ *      ))}
+ *     </div>
+ *   );
+ * };
+ * ```
+ * @returns {UseFetchRecommendationsReturn}
+ */
+export function useFetchRecommendations<T extends Display>(): UseFetchRecommendationsReturn<T>;
 /**
  * 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, fetchDepictRecommendations } from "@depict-ai/ui";
+export { CategoryTitle, embedded_num_products as EmbeddedNumProducts } from "@depict-ai/ui";
 export type { Locale } from "@depict-ai/ui/locales";

package/dist/main.js

@@ -23,15 +23,15 @@ $parcel$export(module.exports, "ImagePlaceholder", () => $df522c8a81ed5a01$expor
 $parcel$export(module.exports, "TextPlaceholder", () => $7c8b440edc188ad5$export$89c6019e4baa40b1);
 $parcel$export(module.exports, "useSearchModal", () => $ae73b15c325f1b21$export$912994940e660d32);
 $parcel$export(module.exports, "useSearchField", () => $913da7f4d0bc77f2$export$9bb30bbe003b82e0);
+$parcel$export(module.exports, "useFetchRecommendations", () => $a134ea100690b628$export$6501da23a2770fc);
 $parcel$export(module.exports, "usePerformanceClient", () => $25c0a91312868994$export$38b98fae14bd1f64);
 $parcel$export(module.exports, "CategoryTitle", () => $b03e4eee8610ebbe$re_export$CategoryTitle);
 $parcel$export(module.exports, "EmbeddedNumProducts", () => $b03e4eee8610ebbe$re_export$EmbeddedNumProducts);
-$parcel$export(module.exports, "fetchDepictRecommendations", () => $b03e4eee8610ebbe$re_export$fetchDepictRecommendations);
 $parcel$export(module.exports, "version", () => $db7b67857900028b$export$83d89fbfd8236492);
 $parcel$export(module.exports, "Navigation", () => $b742053c966024b4$export$b8a61e5c71402559);
 /*! Depict.ai search and product listing react SDK wrapper */ // This is where the actual source of your React stuff should live
 // Note, if you add an export here, also add one in src-server/main.ts
-const $db7b67857900028b$export$83d89fbfd8236492 = "0.0.106";
+const $db7b67857900028b$export$83d89fbfd8236492 = "1.0.3";
 
 
 
@@ -47,6 +47,8 @@ const $0b7cd4fb39fc3502$export$8e769ad4338a911e = {
     category: null,
     api: null,
     dpc: null,
+    merchant: null,
+    market: null,
     userId: undefined,
     sessionId: undefined,
     metaData: undefined,
@@ -64,6 +66,34 @@ const $0b7cd4fb39fc3502$export$8e769ad4338a911e = {
 
 
 
+
+class $d7a14567b529586f$export$d0f82e3ef89b1f22 extends (0, $4GYXz$react.Component) {
+    constructor(props){
+        super(props);
+        this.state = {
+            hasError: false
+        };
+    }
+    static getDerivedStateFromError() {
+        // Update state so the next render will show the fallback UI.
+        return {
+            hasError: true
+        };
+    }
+    componentDidCatch(error) {
+        this.props.on_error(error);
+    }
+    render() {
+        if (this.state.hasError) // You can render any custom fallback UI
+        return (0, $4GYXz$react.createElement)("div", {
+            children: "Component failed"
+        });
+        return this.props.children;
+    }
+}
+
+
+
 let $b4d0d98857ed9934$var$run_on_href_change;
 let $b4d0d98857ed9934$var$old_href = location.href;
 function $b4d0d98857ed9934$export$74f3924c5027fe1d(cb) {
@@ -71,8 +101,7 @@ function $b4d0d98857ed9934$export$74f3924c5027fe1d(cb) {
 }
 (0, $4GYXz$depictaiutilishared.instant_exec_on_suspect_history_change).add((0, $4GYXz$depictaiutilishared.catchify)(()=>{
     const { href: href  } = location;
-    if (!$b4d0d98857ed9934$var$run_on_href_change || $b4d0d98857ed9934$var$old_href === href) return;
-    $b4d0d98857ed9934$var$run_on_href_change?.(href);
+    if ($b4d0d98857ed9934$var$run_on_href_change && $b4d0d98857ed9934$var$old_href !== href) $b4d0d98857ed9934$var$run_on_href_change(href);
     $b4d0d98857ed9934$var$old_href = href;
 }));
 const $b4d0d98857ed9934$export$775e6b3892b5ad52 = (url = location)=>url.pathname == (0, $4GYXz$solidjs.untrack)((0, $0b7cd4fb39fc3502$export$8e769ad4338a911e).search_page_path_[0]); // might have changed therefore get it from globalState
@@ -108,21 +137,31 @@ function $b4d0d98857ed9934$export$e5139bbbb9a05035(component, is_set = (0, $0b7c
 }
 async function $b4d0d98857ed9934$export$79c79419c1ef0081({ display: display , component_portals: component_portals , set_portals: set_portals , react_template: react_template  }) {
     let set_react_has_ran_hooks;
+    let was_cleaned_up = false;
     const react_has_ran_hooks = new Promise((r)=>set_react_has_ran_hooks = r);
     const solid_container = document.createElement("div");
+    const owner = (0, $4GYXz$solidjs.getOwner)();
     const reactProductCard = (0, $4GYXz$reactjsxruntime.jsx)((props)=>{
-        // Sneak in a hook into their product card component
+        // Sneak in a hook into their product card component to know once react has finished rendering and running hooks
         (0, $4GYXz$react.useEffect)(set_react_has_ran_hooks, []);
         return react_template(props);
     }, {
         display: display
     });
-    const portal = $4GYXz$reactdom.createPortal(reactProductCard, solid_container);
+    const reactProductCardInErrorBoundary = (0, $4GYXz$reactjsxruntime.jsx)((0, $d7a14567b529586f$export$d0f82e3ef89b1f22), {
+        children: reactProductCard,
+        on_error: (error)=>(0, $4GYXz$solidjs.runWithOwner)(owner, ()=>{
+                if (was_cleaned_up) return; // Would infinite loop if we'd throw after we've already been cleaned up. That is because the `ErrorBoundary` won't be "registered" with the cleaned-up owner anymore so react would hear about the throw and attempt to re-render the error boundary or something which would throw again, etc.
+                throw new (0, $4GYXz$depictaiui.ProductCardError)(error);
+            })
+    });
+    const portal = $4GYXz$reactdom.createPortal(reactProductCardInErrorBoundary, solid_container);
     component_portals.add(portal);
     set_portals([
         ...component_portals
     ]);
     (0, $4GYXz$solidjs.onCleanup)(()=>{
+        was_cleaned_up = true;
         // this will stop working after any await so be careful to not await before this, or you'll have to carry the owner over with getOwner and runWithOwner
         component_portals.delete(portal);
         set_portals([
@@ -275,6 +314,8 @@ function $24b00503eef73528$export$9fac37a9c21c2f3b(props) {
     (0, $0b7cd4fb39fc3502$export$8e769ad4338a911e).userId = userId;
     (0, $0b7cd4fb39fc3502$export$8e769ad4338a911e).sessionId = sessionId;
     (0, $0b7cd4fb39fc3502$export$8e769ad4338a911e).metaData = metaData;
+    (0, $0b7cd4fb39fc3502$export$8e769ad4338a911e).market = market;
+    (0, $0b7cd4fb39fc3502$export$8e769ad4338a911e).merchant = merchant;
     (0, $25c0a91312868994$export$47e064413edabf36)(merchant, market, userId, sessionId);
     if (!market || !merchant) {
         (0, $0b7cd4fb39fc3502$export$8e769ad4338a911e).required_state_set_[1](false);
@@ -581,6 +622,26 @@ const $913da7f4d0bc77f2$export$9bb30bbe003b82e0 = (props)=>{
 
 
 
+function $a134ea100690b628$export$6501da23a2770fc() {
+    return {
+        fetchRecommendations: $a134ea100690b628$var$fetchRecommendations
+    };
+}
+function $a134ea100690b628$var$fetchRecommendations(opts) {
+    const { merchant: merchant , market: market , userId: userId , sessionId: sessionId  } = (0, $0b7cd4fb39fc3502$export$8e769ad4338a911e);
+    if (!merchant || !market) throw new Error("Depict recommendations are not configured. Wrap your app in a DepictProvider.");
+    return (0, $4GYXz$depictaiui.fetchDepictRecommendations)({
+        merchant: merchant,
+        market: market,
+        userId: userId,
+        sessionId: sessionId,
+        ...opts
+    });
+}
+
+
+
+
 
 
 const $e387bd534de10acd$export$804fac5697cfbe35 = (router)=>(relativeUrl)=>{

package/dist/module.js

@@ -1,7 +1,7 @@
 import {add_to_version_info as $TZSbU$add_to_version_info, catchify as $TZSbU$catchify, queueMacroTask as $TZSbU$queueMacroTask, instant_exec_on_suspect_history_change as $TZSbU$instant_exec_on_suspect_history_change, ContainedPlaceholderImage as $TZSbU$ContainedPlaceholderImage, Placeholder as $TZSbU$Placeholder} from "@depict-ai/utilishared";
-import {CategoryTitle as $43099132aad1ceb6$re_export$CategoryTitle, embedded_num_products as $43099132aad1ceb6$re_export$EmbeddedNumProducts, fetchDepictRecommendations as $43099132aad1ceb6$re_export$fetchDepictRecommendations, DepictAPI as $TZSbU$DepictAPI, DepictSearch as $TZSbU$DepictSearch, DepictCategory as $TZSbU$DepictCategory, get_search_query_updating_blocked_signal as $TZSbU$get_search_query_updating_blocked_signal, SearchPage as $TZSbU$SearchPage, CategoryPage as $TZSbU$CategoryPage, BreadCrumbs as $TZSbU$BreadCrumbs, QuickLinks as $TZSbU$QuickLinks, open_modal_with_alignment as $TZSbU$open_modal_with_alignment, SearchField as $TZSbU$SearchField} from "@depict-ai/ui";
-import {createRoot as $TZSbU$createRoot, untrack as $TZSbU$untrack, createEffect as $TZSbU$createEffect, createComponent as $TZSbU$createComponent, Show as $TZSbU$Show, onCleanup as $TZSbU$onCleanup, createSignal as $TZSbU$createSignal, createComputed as $TZSbU$createComputed, createMemo as $TZSbU$createMemo} from "solid-js";
-import {createElement as $TZSbU$createElement, Fragment as $TZSbU$Fragment, useState as $TZSbU$useState, useRef as $TZSbU$useRef, useEffect as $TZSbU$useEffect, forwardRef as $TZSbU$forwardRef} from "react";
+import {CategoryTitle as $43099132aad1ceb6$re_export$CategoryTitle, embedded_num_products as $43099132aad1ceb6$re_export$EmbeddedNumProducts, DepictAPI as $TZSbU$DepictAPI, DepictSearch as $TZSbU$DepictSearch, DepictCategory as $TZSbU$DepictCategory, ProductCardError as $TZSbU$ProductCardError, get_search_query_updating_blocked_signal as $TZSbU$get_search_query_updating_blocked_signal, SearchPage as $TZSbU$SearchPage, CategoryPage as $TZSbU$CategoryPage, BreadCrumbs as $TZSbU$BreadCrumbs, QuickLinks as $TZSbU$QuickLinks, open_modal_with_alignment as $TZSbU$open_modal_with_alignment, SearchField as $TZSbU$SearchField, fetchDepictRecommendations as $TZSbU$fetchDepictRecommendations} from "@depict-ai/ui";
+import {createRoot as $TZSbU$createRoot, untrack as $TZSbU$untrack, createEffect as $TZSbU$createEffect, createComponent as $TZSbU$createComponent, Show as $TZSbU$Show, getOwner as $TZSbU$getOwner, runWithOwner as $TZSbU$runWithOwner, onCleanup as $TZSbU$onCleanup, createSignal as $TZSbU$createSignal, createComputed as $TZSbU$createComputed, createMemo as $TZSbU$createMemo} from "solid-js";
+import {createElement as $TZSbU$createElement, Fragment as $TZSbU$Fragment, useState as $TZSbU$useState, useRef as $TZSbU$useRef, useEffect as $TZSbU$useEffect, Component as $TZSbU$Component, forwardRef as $TZSbU$forwardRef} from "react";
 import {en as $TZSbU$en} from "@depict-ai/ui/locales";
 import {render as $TZSbU$render} from "solid-js/web";
 import {jsx as $TZSbU$jsx} from "react/jsx-runtime";
@@ -11,7 +11,7 @@ import {DPC as $TZSbU$DPC} from "@depict-ai/dpc";
 
 /*! Depict.ai search and product listing react SDK wrapper */ // This is where the actual source of your React stuff should live
 // Note, if you add an export here, also add one in src-server/main.ts
-const $c9c4d066f9a5b51b$export$83d89fbfd8236492 = "0.0.106";
+const $c9c4d066f9a5b51b$export$83d89fbfd8236492 = "1.0.3";
 
 
 
@@ -27,6 +27,8 @@ const $42858f023ef23dab$export$8e769ad4338a911e = {
     category: null,
     api: null,
     dpc: null,
+    merchant: null,
+    market: null,
     userId: undefined,
     sessionId: undefined,
     metaData: undefined,
@@ -44,6 +46,34 @@ const $42858f023ef23dab$export$8e769ad4338a911e = {
 
 
 
+
+class $d5c9e1f3545b4984$export$d0f82e3ef89b1f22 extends (0, $TZSbU$Component) {
+    constructor(props){
+        super(props);
+        this.state = {
+            hasError: false
+        };
+    }
+    static getDerivedStateFromError() {
+        // Update state so the next render will show the fallback UI.
+        return {
+            hasError: true
+        };
+    }
+    componentDidCatch(error) {
+        this.props.on_error(error);
+    }
+    render() {
+        if (this.state.hasError) // You can render any custom fallback UI
+        return (0, $TZSbU$createElement)("div", {
+            children: "Component failed"
+        });
+        return this.props.children;
+    }
+}
+
+
+
 let $c83ba9ab79386687$var$run_on_href_change;
 let $c83ba9ab79386687$var$old_href = location.href;
 function $c83ba9ab79386687$export$74f3924c5027fe1d(cb) {
@@ -51,8 +81,7 @@ function $c83ba9ab79386687$export$74f3924c5027fe1d(cb) {
 }
 (0, $TZSbU$instant_exec_on_suspect_history_change).add((0, $TZSbU$catchify)(()=>{
     const { href: href  } = location;
-    if (!$c83ba9ab79386687$var$run_on_href_change || $c83ba9ab79386687$var$old_href === href) return;
-    $c83ba9ab79386687$var$run_on_href_change?.(href);
+    if ($c83ba9ab79386687$var$run_on_href_change && $c83ba9ab79386687$var$old_href !== href) $c83ba9ab79386687$var$run_on_href_change(href);
     $c83ba9ab79386687$var$old_href = href;
 }));
 const $c83ba9ab79386687$export$775e6b3892b5ad52 = (url = location)=>url.pathname == (0, $TZSbU$untrack)((0, $42858f023ef23dab$export$8e769ad4338a911e).search_page_path_[0]); // might have changed therefore get it from globalState
@@ -88,21 +117,31 @@ function $c83ba9ab79386687$export$e5139bbbb9a05035(component, is_set = (0, $4285
 }
 async function $c83ba9ab79386687$export$79c79419c1ef0081({ display: display , component_portals: component_portals , set_portals: set_portals , react_template: react_template  }) {
     let set_react_has_ran_hooks;
+    let was_cleaned_up = false;
     const react_has_ran_hooks = new Promise((r)=>set_react_has_ran_hooks = r);
     const solid_container = document.createElement("div");
+    const owner = (0, $TZSbU$getOwner)();
     const reactProductCard = (0, $TZSbU$jsx)((props)=>{
-        // Sneak in a hook into their product card component
+        // Sneak in a hook into their product card component to know once react has finished rendering and running hooks
         (0, $TZSbU$useEffect)(set_react_has_ran_hooks, []);
         return react_template(props);
     }, {
         display: display
     });
-    const portal = $TZSbU$createPortal(reactProductCard, solid_container);
+    const reactProductCardInErrorBoundary = (0, $TZSbU$jsx)((0, $d5c9e1f3545b4984$export$d0f82e3ef89b1f22), {
+        children: reactProductCard,
+        on_error: (error)=>(0, $TZSbU$runWithOwner)(owner, ()=>{
+                if (was_cleaned_up) return; // Would infinite loop if we'd throw after we've already been cleaned up. That is because the `ErrorBoundary` won't be "registered" with the cleaned-up owner anymore so react would hear about the throw and attempt to re-render the error boundary or something which would throw again, etc.
+                throw new (0, $TZSbU$ProductCardError)(error);
+            })
+    });
+    const portal = $TZSbU$createPortal(reactProductCardInErrorBoundary, solid_container);
     component_portals.add(portal);
     set_portals([
         ...component_portals
     ]);
     (0, $TZSbU$onCleanup)(()=>{
+        was_cleaned_up = true;
         // this will stop working after any await so be careful to not await before this, or you'll have to carry the owner over with getOwner and runWithOwner
         component_portals.delete(portal);
         set_portals([
@@ -255,6 +294,8 @@ function $5376eb2a386cd90d$export$9fac37a9c21c2f3b(props) {
     (0, $42858f023ef23dab$export$8e769ad4338a911e).userId = userId;
     (0, $42858f023ef23dab$export$8e769ad4338a911e).sessionId = sessionId;
     (0, $42858f023ef23dab$export$8e769ad4338a911e).metaData = metaData;
+    (0, $42858f023ef23dab$export$8e769ad4338a911e).market = market;
+    (0, $42858f023ef23dab$export$8e769ad4338a911e).merchant = merchant;
     (0, $a00d8f27abd5d0b0$export$47e064413edabf36)(merchant, market, userId, sessionId);
     if (!market || !merchant) {
         (0, $42858f023ef23dab$export$8e769ad4338a911e).required_state_set_[1](false);
@@ -561,6 +602,26 @@ const $2b886cf548a4775c$export$9bb30bbe003b82e0 = (props)=>{
 
 
 
+function $1bb4271dc44722e2$export$6501da23a2770fc() {
+    return {
+        fetchRecommendations: $1bb4271dc44722e2$var$fetchRecommendations
+    };
+}
+function $1bb4271dc44722e2$var$fetchRecommendations(opts) {
+    const { merchant: merchant , market: market , userId: userId , sessionId: sessionId  } = (0, $42858f023ef23dab$export$8e769ad4338a911e);
+    if (!merchant || !market) throw new Error("Depict recommendations are not configured. Wrap your app in a DepictProvider.");
+    return (0, $TZSbU$fetchDepictRecommendations)({
+        merchant: merchant,
+        market: market,
+        userId: userId,
+        sessionId: sessionId,
+        ...opts
+    });
+}
+
+
+
+
 
 
 const $a92aa2beb560b8af$export$804fac5697cfbe35 = (router)=>(relativeUrl)=>{
@@ -588,4 +649,4 @@ const $97603d19204ec48d$export$b8a61e5c71402559 = {
 (0, $TZSbU$add_to_version_info)("react-ui", (0, $c9c4d066f9a5b51b$export$83d89fbfd8236492));
 
 
-export {$b68a14248b7ef667$export$466cdc317043f6cb as QuickLinks, $f866f7ed9f751af4$export$5646050d516e06bc as BreadCrumbs, $421f32789b6f111f$export$80e99ee6b29cadd2 as ComponentAligner, $5376eb2a386cd90d$export$9fac37a9c21c2f3b as DepictProvider, $48d7f568740a317d$export$f7d2f673fc2f091d as CategoryPage, $4a678f0c87b12e78$export$a54ec244c8863715 as SearchPage, $f446a84f85ba06f6$export$3f37af283f8fb843 as ImagePlaceholder, $cbd250061abf11cb$export$89c6019e4baa40b1 as TextPlaceholder, $70344e5e0d0fea06$export$912994940e660d32 as useSearchModal, $2b886cf548a4775c$export$9bb30bbe003b82e0 as useSearchField, $a00d8f27abd5d0b0$export$38b98fae14bd1f64 as usePerformanceClient, $43099132aad1ceb6$re_export$CategoryTitle as CategoryTitle, $43099132aad1ceb6$re_export$EmbeddedNumProducts as EmbeddedNumProducts, $43099132aad1ceb6$re_export$fetchDepictRecommendations as fetchDepictRecommendations, $c9c4d066f9a5b51b$export$83d89fbfd8236492 as version, $97603d19204ec48d$export$b8a61e5c71402559 as Navigation};
+export {$b68a14248b7ef667$export$466cdc317043f6cb as QuickLinks, $f866f7ed9f751af4$export$5646050d516e06bc as BreadCrumbs, $421f32789b6f111f$export$80e99ee6b29cadd2 as ComponentAligner, $5376eb2a386cd90d$export$9fac37a9c21c2f3b as DepictProvider, $48d7f568740a317d$export$f7d2f673fc2f091d as CategoryPage, $4a678f0c87b12e78$export$a54ec244c8863715 as SearchPage, $f446a84f85ba06f6$export$3f37af283f8fb843 as ImagePlaceholder, $cbd250061abf11cb$export$89c6019e4baa40b1 as TextPlaceholder, $70344e5e0d0fea06$export$912994940e660d32 as useSearchModal, $2b886cf548a4775c$export$9bb30bbe003b82e0 as useSearchField, $1bb4271dc44722e2$export$6501da23a2770fc as useFetchRecommendations, $a00d8f27abd5d0b0$export$38b98fae14bd1f64 as usePerformanceClient, $43099132aad1ceb6$re_export$CategoryTitle as CategoryTitle, $43099132aad1ceb6$re_export$EmbeddedNumProducts as EmbeddedNumProducts, $c9c4d066f9a5b51b$export$83d89fbfd8236492 as version, $97603d19204ec48d$export$b8a61e5c71402559 as Navigation};

package/dist-server/index.d.ts

@@ -1,5 +1,7 @@
 import { ReactElement } from "react";
 import { DPC } from "@depict-ai/dpc";
+import { fetchDepictRecommendations, ExclusiveId } from "@depict-ai/ui";
+import { Display } from "@depict-ai/utilishared";
 type OpenModal = () => void;
 interface UseSearchModalReturn {
     open: OpenModal;
@@ -13,8 +15,25 @@ interface UseSearchFieldReturn {
 interface UsePerformanceClientReturn {
     dpc: DPC;
 }
-export const version = "0.0.106";
-export const fetchDepictRecommendations: any;
+type FetchRecsOptions = Omit<Parameters<typeof fetchDepictRecommendations>[0], "merchant" | "market" | "userId" | "sessionId"> & ExclusiveId;
+interface UseFetchRecommendationsReturn<T extends Display> {
+    /**
+     * Fetch recommendations from the Depict API.
+     * @example
+     * General recommendations for a landing page:
+     * ```tsx
+     * fetchRecommendations({ type: "landing_page" });
+     * ```
+     * @example
+     * Fetch targeted recommendations for a product details page (PDP):
+     * ```tsx
+     * fetchRecommendations({ type: "related", productId: "t-shirt-white" })
+     * ```
+     * @returns {Promise<T[]>}
+     */
+    fetchRecommendations: (opts: FetchRecsOptions) => Promise<T[]>;
+}
+export const version = "1.0.3";
 export function DepictProvider(props: any): any;
 export function SearchPage(): any;
 export function CategoryPage(): any;
@@ -32,3 +51,4 @@ export function useSearchField(): UseSearchFieldReturn;
 export function openModal(): void;
 export function useSearchModal(): UseSearchModalReturn;
 export function usePerformanceClient(): UsePerformanceClientReturn;
+export function useFetchRecommendations<T extends Display>(): UseFetchRecommendationsReturn<T>;

package/dist-server/main.js

@@ -5,7 +5,6 @@ function $parcel$export(e, n, v, s) {
   Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
 }
 
-$parcel$export(module.exports, "fetchDepictRecommendations", () => $41e7e5d85b5e0d49$export$58e808b1db15d3bc);
 $parcel$export(module.exports, "DepictProvider", () => $41e7e5d85b5e0d49$export$9fac37a9c21c2f3b);
 $parcel$export(module.exports, "SearchPage", () => $41e7e5d85b5e0d49$export$a54ec244c8863715);
 $parcel$export(module.exports, "CategoryPage", () => $41e7e5d85b5e0d49$export$f7d2f673fc2f091d);
@@ -18,15 +17,13 @@ $parcel$export(module.exports, "useSearchField", () => $41e7e5d85b5e0d49$export$
 $parcel$export(module.exports, "openModal", () => $41e7e5d85b5e0d49$export$a7f6cffb6b8ba11c);
 $parcel$export(module.exports, "useSearchModal", () => $41e7e5d85b5e0d49$export$912994940e660d32);
 $parcel$export(module.exports, "usePerformanceClient", () => $41e7e5d85b5e0d49$export$38b98fae14bd1f64);
+$parcel$export(module.exports, "useFetchRecommendations", () => $41e7e5d85b5e0d49$export$6501da23a2770fc);
 $parcel$export(module.exports, "version", () => $db7b67857900028b$export$83d89fbfd8236492);
 
 
-const $db7b67857900028b$export$83d89fbfd8236492 = "0.0.106";
+const $db7b67857900028b$export$83d89fbfd8236492 = "1.0.3";
 
 
-const $41e7e5d85b5e0d49$export$58e808b1db15d3bc = ()=>{
-    throw new Error("fetchDepictRecommendations is currently not available on the server due to personalisation/user_id related issues. Please only call it on the client");
-};
 function $41e7e5d85b5e0d49$export$9fac37a9c21c2f3b(props) {
     return props.children;
 }
@@ -94,5 +91,12 @@ function $41e7e5d85b5e0d49$export$38b98fae14bd1f64() {
         dpc: new Proxy({}, mock)
     };
 }
+function $41e7e5d85b5e0d49$export$6501da23a2770fc() {
+    return {
+        fetchRecommendations: ()=>{
+            throw new Error("fetchRecommendations is currently not available on the server due to personalisation/user_id related issues. Please only call it on the client.");
+        }
+    };
+}
 
 

package/dist-server/module.js

@@ -3,12 +3,9 @@ import {jsx as $1RlIW$jsx} from "react/jsx-runtime";
 
 
 
-const $c9c4d066f9a5b51b$export$83d89fbfd8236492 = "0.0.106";
+const $c9c4d066f9a5b51b$export$83d89fbfd8236492 = "1.0.3";
 
 
-const $2b1fdeb83610500f$export$58e808b1db15d3bc = ()=>{
-    throw new Error("fetchDepictRecommendations is currently not available on the server due to personalisation/user_id related issues. Please only call it on the client");
-};
 function $2b1fdeb83610500f$export$9fac37a9c21c2f3b(props) {
     return props.children;
 }
@@ -76,6 +73,13 @@ function $2b1fdeb83610500f$export$38b98fae14bd1f64() {
         dpc: new Proxy({}, mock)
     };
 }
+function $2b1fdeb83610500f$export$6501da23a2770fc() {
+    return {
+        fetchRecommendations: ()=>{
+            throw new Error("fetchRecommendations is currently not available on the server due to personalisation/user_id related issues. Please only call it on the client.");
+        }
+    };
+}
 
 
-export {$2b1fdeb83610500f$export$58e808b1db15d3bc as fetchDepictRecommendations, $2b1fdeb83610500f$export$9fac37a9c21c2f3b as DepictProvider, $2b1fdeb83610500f$export$a54ec244c8863715 as SearchPage, $2b1fdeb83610500f$export$f7d2f673fc2f091d as CategoryPage, $2b1fdeb83610500f$export$5646050d516e06bc as BreadCrumbs, $2b1fdeb83610500f$export$466cdc317043f6cb as QuickLinks, $2b1fdeb83610500f$export$80e99ee6b29cadd2 as ComponentAligner, $2b1fdeb83610500f$export$3f37af283f8fb843 as ImagePlaceholder, $2b1fdeb83610500f$export$89c6019e4baa40b1 as TextPlaceholder, $2b1fdeb83610500f$export$9bb30bbe003b82e0 as useSearchField, $2b1fdeb83610500f$export$a7f6cffb6b8ba11c as openModal, $2b1fdeb83610500f$export$912994940e660d32 as useSearchModal, $2b1fdeb83610500f$export$38b98fae14bd1f64 as usePerformanceClient, $c9c4d066f9a5b51b$export$83d89fbfd8236492 as version};
+export {$2b1fdeb83610500f$export$9fac37a9c21c2f3b as DepictProvider, $2b1fdeb83610500f$export$a54ec244c8863715 as SearchPage, $2b1fdeb83610500f$export$f7d2f673fc2f091d as CategoryPage, $2b1fdeb83610500f$export$5646050d516e06bc as BreadCrumbs, $2b1fdeb83610500f$export$466cdc317043f6cb as QuickLinks, $2b1fdeb83610500f$export$80e99ee6b29cadd2 as ComponentAligner, $2b1fdeb83610500f$export$3f37af283f8fb843 as ImagePlaceholder, $2b1fdeb83610500f$export$89c6019e4baa40b1 as TextPlaceholder, $2b1fdeb83610500f$export$9bb30bbe003b82e0 as useSearchField, $2b1fdeb83610500f$export$a7f6cffb6b8ba11c as openModal, $2b1fdeb83610500f$export$912994940e660d32 as useSearchModal, $2b1fdeb83610500f$export$38b98fae14bd1f64 as usePerformanceClient, $2b1fdeb83610500f$export$6501da23a2770fc as useFetchRecommendations, $c9c4d066f9a5b51b$export$83d89fbfd8236492 as version};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@depict-ai/react-ui",
-  "version": "0.0.106",
+  "version": "1.0.3",
   "packageManager": "yarn@3.2.2",
   "source": "src/index.ts",
   "main": "dist/main.js",
@@ -96,10 +96,10 @@
     "/locales"
   ],
   "dependencies": {
-    "@depict-ai/dpc": "^1.0.2",
-    "@depict-ai/plp-styling": "^1.0.2",
-    "@depict-ai/ui": "^1.0.2",
-    "@depict-ai/utilishared": "^1.0.2",
+    "@depict-ai/dpc": "^1.0.4",
+    "@depict-ai/plp-styling": "^1.0.5",
+    "@depict-ai/ui": "^1.0.5",
+    "@depict-ai/utilishared": "^1.0.4",
     "solid-js": "^1.7.3"
   },
   "peerDependencies": {
@@ -112,7 +112,7 @@
     "@babel/preset-typescript": "latest",
     "@babel/runtime": "latest",
     "@babel/runtime-corejs3": "latest",
-    "@depict-ai/plp-styling": "^1.0.2",
+    "@depict-ai/plp-styling": "^1.0.5",
     "@jest/globals": "^29.3.1",
     "@parcel/babel-preset-env": "latest",
     "@parcel/resolver-default": "^2.8.0",