@depict-ai/ui 4.1.4 → 4.1.5

package/latest/index.cjs

@@ -12,6 +12,7 @@ function $parcel$export(e, n, v, s) {
     configurable: true
   });
 }
+$parcel$export(module.exports, "promiseSafeStructuredClone", () => $ac946c6b782bb900$export$83bb9af5671e1dbe);
 $parcel$export(module.exports, "preserve_items_in_history_dot_state", () => $d84fe647b84b5dc5$export$5162a71f252e6122);
 $parcel$export(module.exports, "prefixes_to_preserve_in_history_dot_state", () => $d84fe647b84b5dc5$export$3064e1e8c6513da3);
 $parcel$export(module.exports, "allowNativeNavigation", () => $747421cd28dec5b5$export$29d28dadc2d6b631);
@@ -92,7 +93,76 @@ $parcel$export(module.exports, "defaultCategoryTitlePlugin", () => $a3280f0aad99
 $parcel$export(module.exports, "version", () => $b757f75811f3261f$export$83d89fbfd8236492);
 $parcel$export(module.exports, "SearchField", () => $c0a0659cf97e8eb2$export$316f6f283ae64765);
 /*! Depict.ai search and product listing SDK */
-const $b757f75811f3261f$export$83d89fbfd8236492 = "4.1.4";
+const $b757f75811f3261f$export$83d89fbfd8236492 = "4.1.5";
+
+/**
+ * This is a function that will safely clone an object that may contain promises.
+ * It will use structuredClone to clone the object and then re-apply (copy) any promises that were in the original object to the cloned object.
+ * @param obj Anything to clone
+ */
+function $ac946c6b782bb900$export$83bb9af5671e1dbe(obj) {
+  if (obj instanceof Promise) return obj;
+  // Extract all promises, keep a map of them, and then re-apply them to both the original object and the target object after cloning
+  const seen = new Set();
+  const keyStack = [[]];
+  const valueStack = [obj];
+  const promiseLocationStack = [];
+  while (valueStack.length) {
+    const value = valueStack.pop();
+    const keyPath = keyStack.pop();
+    // Promises can only be in objects and we don't need to check for objects we've already seen (like in circular references)
+    if (typeof value !== "object" || value === null || seen.has(value)) continue;
+    seen.add(value);
+    if (Array.isArray(value)) {
+      for (let i = 0; i < value.length; i++) {
+        const ourValue = value[i];
+        const valuesKeyPath = [...keyPath, i];
+        if (ourValue instanceof Promise) {
+          promiseLocationStack.push([valuesKeyPath, ourValue]);
+          delete value[i]; // This will leave a hole in the array, but it's fine since we'll put it back soon
+          // This way both the indexes will be correct when putting the value back and our for loop doesn't get messed up
+        } else {
+          keyStack.push(valuesKeyPath);
+          valueStack.push(ourValue);
+        }
+      }
+      continue;
+    }
+    for (const innerKey in value) {
+      const ourValue = value[innerKey];
+      const valuesKeyPath = [...keyPath, innerKey];
+      if (ourValue instanceof Promise) {
+        promiseLocationStack.push([valuesKeyPath, ourValue]);
+        delete value[innerKey];
+      } else {
+        keyStack.push(valuesKeyPath);
+        valueStack.push(ourValue);
+      }
+    }
+  }
+  let structuredClonedObject;
+  let error;
+  try {
+    structuredClonedObject = structuredClone(obj);
+  } catch (e) {
+    // We still need to put back the promises in the original object, even if we threw an error
+    error = e;
+  }
+  // Put back the promises in both the original object and the cloned object
+  while (promiseLocationStack.length) {
+    const [keyPath, promise] = promiseLocationStack.pop();
+    let targetInClone = structuredClonedObject;
+    let targetInOriginal = obj;
+    for (let i = 0; i < keyPath.length - 1; i++) {
+      if (!error) targetInClone = targetInClone[keyPath[i]];
+      targetInOriginal = targetInOriginal[keyPath[i]];
+    }
+    if (!error) targetInClone[keyPath[keyPath.length - 1]] = promise;
+    targetInOriginal[keyPath[keyPath.length - 1]] = promise;
+  }
+  if (error) throw error;
+  return structuredClonedObject;
+}
 const $d84fe647b84b5dc5$export$3064e1e8c6513da3 = new Set();
 let $d84fe647b84b5dc5$var$has_ran = false;
 function $d84fe647b84b5dc5$export$5162a71f252e6122() {
@@ -234,12 +304,55 @@ function $b54e6192d0caa293$export$d9f36cf74e24d595(media_query) {
   }) => signal[1](matches)).remove);
   return signal[0];
 }
+var $9fe9883b1d8ecccc$var$_tmpl$ = /*#__PURE__*/$gVhhF$solidjsweb.template(`<span>`);
+function $9fe9883b1d8ecccc$export$acb3eaade4b23afd(props) {
+  // Work around https://github.com/solidjs/solid/issues/1980
+  return (() => {
+    var _el$ = $gVhhF$solidjsweb.getNextElement($9fe9883b1d8ecccc$var$_tmpl$);
+    $gVhhF$solidjsweb.effect(_p$ => {
+      var _v$ = `${props.class || ""} depict-placeholder`,
+        _v$2 = props.style;
+      _v$ !== _p$.e && $gVhhF$solidjsweb.className(_el$, _p$.e = _v$);
+      _p$.t = $gVhhF$solidjsweb.style(_el$, _v$2, _p$.t);
+      return _p$;
+    }, {
+      e: undefined,
+      t: undefined
+    });
+    return _el$;
+  })();
+}
+function $061ff5b4c3d36171$export$89c6019e4baa40b1(props) {
+  const style = $gVhhF$solidjs.createMemo(() => {
+    const {
+      style: style,
+      height: height,
+      width: width
+    } = props;
+    return {
+      ...(style || {}),
+      height: height ?? "1em",
+      ...(width && {
+        width: width
+      })
+    };
+  });
+  return $gVhhF$solidjsweb.createComponent((0, $9fe9883b1d8ecccc$export$acb3eaade4b23afd), {
+    get style() {
+      return style();
+    },
+    get ["class"]() {
+      return props.class;
+    }
+  });
+}
 var $6ae613870d3380fc$var$_tmpl$ = /*#__PURE__*/$gVhhF$solidjsweb.template(`<span class="title line-clamp">`),
   $6ae613870d3380fc$var$_tmpl$2 = /*#__PURE__*/$gVhhF$solidjsweb.template(`<span class=brand>`),
   $6ae613870d3380fc$var$_tmpl$3 = /*#__PURE__*/$gVhhF$solidjsweb.template(`<div class="tagline line-clamp">`),
   $6ae613870d3380fc$var$_tmpl$4 = /*#__PURE__*/$gVhhF$solidjsweb.template(`<span class="orig price"><!$><!/><!$><!/><!$><!/>`),
-  $6ae613870d3380fc$var$_tmpl$5 = /*#__PURE__*/$gVhhF$solidjsweb.template(`<a class=instant-card><div class=img-part><!$><!/><!$><!/></div><div class=right-part><!$><!/><div class=price-container><!$><!/><span class=price><!$><!/><!$><!/><!$><!/>`),
-  $6ae613870d3380fc$var$_tmpl$6 = /*#__PURE__*/$gVhhF$solidjsweb.template(`<div class=title-brand-tagline>`);
+  $6ae613870d3380fc$var$_tmpl$5 = /*#__PURE__*/$gVhhF$solidjsweb.template(`<span class=price><!$><!/><!$><!/><!$><!/>`),
+  $6ae613870d3380fc$var$_tmpl$6 = /*#__PURE__*/$gVhhF$solidjsweb.template(`<a class=instant-card><div class=img-part><!$><!/><!$><!/></div><div class=right-part><!$><!/><div class=price-container><!$><!/><!$><!/>`),
+  $6ae613870d3380fc$var$_tmpl$7 = /*#__PURE__*/$gVhhF$solidjsweb.template(`<div class=title-brand-tagline>`);
 const $6ae613870d3380fc$export$b05c0ae390cf3e06 = ({
   display_: display_,
   router_: router_,
@@ -253,7 +366,10 @@ const $6ae613870d3380fc$export$b05c0ae390cf3e06 = ({
   const [get_selected_index_, set_selected_index_] = selected_index_ || [];
   const variant = display_.variant_displays[display_.variant_index];
   const href = $gVhhF$solidjs.createMemo(() => variant.page_url); // <- could be made reactive getter in displayTransformers, read it in memo here since it might create computations (for example in the preview-brower), and there's no owner in the onClick handler
-  const is_sale = variant.sale_price !== variant.original_price;
+  // Prices can be promises, for example in our shopify app. Always assume they are (will work the same when they aren't)
+  const [salePrice] = $gVhhF$solidjs.createResource(() => variant.sale_price);
+  const [originalPrice] = $gVhhF$solidjs.createResource(() => variant.original_price);
+  const isOnSale = $gVhhF$solidjs.createMemo(() => salePrice() !== originalPrice());
   const supports_hover = $b54e6192d0caa293$export$d9f36cf74e24d595("(hover: hover) and (pointer: fine)");
   const [isSelected, selectedDueToKeyboardNavigation] = selected_index_ ? $f144ea315d9e4caa$export$fb40a80c530e5f2b(get_selected_index_, keyboardNavigationGroupIndex_, index_) : [];
   const secondary_image_url = variant.image_urls?.[1] || variant.secondary_image_url || variant.alternative_display_image_url;
@@ -275,25 +391,20 @@ const $6ae613870d3380fc$export$b05c0ae390cf3e06 = ({
     })();
   })())];
   return (() => {
-    var _el$4 = $gVhhF$solidjsweb.getNextElement($6ae613870d3380fc$var$_tmpl$5),
+    var _el$4 = $gVhhF$solidjsweb.getNextElement($6ae613870d3380fc$var$_tmpl$6),
       _el$5 = _el$4.firstChild,
       _el$6 = _el$5.firstChild,
       [_el$7, _co$] = $gVhhF$solidjsweb.getNextMarker(_el$6.nextSibling),
       _el$8 = _el$7.nextSibling,
       [_el$9, _co$2] = $gVhhF$solidjsweb.getNextMarker(_el$8.nextSibling),
       _el$10 = _el$5.nextSibling,
-      _el$28 = _el$10.firstChild,
-      [_el$29, _co$10] = $gVhhF$solidjsweb.getNextMarker(_el$28.nextSibling),
-      _el$11 = _el$29.nextSibling,
+      _el$30 = _el$10.firstChild,
+      [_el$31, _co$11] = $gVhhF$solidjsweb.getNextMarker(_el$30.nextSibling),
+      _el$11 = _el$31.nextSibling,
       _el$26 = _el$11.firstChild,
       [_el$27, _co$9] = $gVhhF$solidjsweb.getNextMarker(_el$26.nextSibling),
-      _el$19 = _el$27.nextSibling,
-      _el$20 = _el$19.firstChild,
-      [_el$21, _co$6] = $gVhhF$solidjsweb.getNextMarker(_el$20.nextSibling),
-      _el$22 = _el$21.nextSibling,
-      [_el$23, _co$7] = $gVhhF$solidjsweb.getNextMarker(_el$22.nextSibling),
-      _el$24 = _el$23.nextSibling,
-      [_el$25, _co$8] = $gVhhF$solidjsweb.getNextMarker(_el$24.nextSibling);
+      _el$28 = _el$27.nextSibling,
+      [_el$29, _co$10] = $gVhhF$solidjsweb.getNextMarker(_el$28.nextSibling);
     $gVhhF$solidjsweb.use(element => $f144ea315d9e4caa$export$12761f53d7ab7f27(element, () => selectedDueToKeyboardNavigation?.() ?? false), _el$4);
     $gVhhF$solidjsweb.addEventListener(_el$4, "mouseleave", $gVhhF$depictaiutilishared.catchify(() => set_selected_index_?.()));
     $gVhhF$solidjsweb.addEventListener(_el$4, "mouseenter", $gVhhF$depictaiutilishared.catchify(() => set_selected_index_?.([keyboardNavigationGroupIndex_(), index_()])));
@@ -318,12 +429,14 @@ const $6ae613870d3380fc$export$b05c0ae390cf3e06 = ({
       }
     }), _el$9, _co$2);
     $gVhhF$solidjsweb.insert(_el$10, selected_index_ ? $gVhhF$solidjsweb.createComponent(TitleBrandTagline, {}) : (() => {
-      var _el$30 = $gVhhF$solidjsweb.getNextElement($6ae613870d3380fc$var$_tmpl$6);
-      $gVhhF$solidjsweb.insert(_el$30, $gVhhF$solidjsweb.createComponent(TitleBrandTagline, {}));
-      return _el$30;
-    })(), _el$29, _co$10);
+      var _el$32 = $gVhhF$solidjsweb.getNextElement($6ae613870d3380fc$var$_tmpl$7);
+      $gVhhF$solidjsweb.insert(_el$32, $gVhhF$solidjsweb.createComponent(TitleBrandTagline, {}));
+      return _el$32;
+    })(), _el$31, _co$11);
     $gVhhF$solidjsweb.insert(_el$11, $gVhhF$solidjsweb.createComponent((0, $gVhhF$solidjs.Show), {
-      when: is_sale,
+      get when() {
+        return isOnSale();
+      },
       get children() {
         var _el$12 = $gVhhF$solidjsweb.getNextElement($6ae613870d3380fc$var$_tmpl$4),
           _el$13 = _el$12.firstChild,
@@ -335,7 +448,7 @@ const $6ae613870d3380fc$export$b05c0ae390cf3e06 = ({
         $gVhhF$solidjsweb.insert(_el$12, () => i18n_.price_formatting_().pre_, _el$14, _co$3);
         $gVhhF$solidjsweb.insert(_el$12, $gVhhF$solidjsweb.createComponent((0, $d659702496cb72ea$export$a71e92cfbb498adc), {
           get price_() {
-            return variant.original_price;
+            return originalPrice();
           },
           get price_formatting_() {
             return i18n_.price_formatting_();
@@ -345,17 +458,39 @@ const $6ae613870d3380fc$export$b05c0ae390cf3e06 = ({
         return _el$12;
       }
     }), _el$27, _co$9);
-    _el$19.classList.toggle("sales-price", !!is_sale);
-    $gVhhF$solidjsweb.insert(_el$19, () => i18n_.price_formatting_().pre_, _el$21, _co$6);
-    $gVhhF$solidjsweb.insert(_el$19, $gVhhF$solidjsweb.createComponent((0, $d659702496cb72ea$export$a71e92cfbb498adc), {
-      get price_() {
-        return variant.sale_price;
+    $gVhhF$solidjsweb.insert(_el$11, $gVhhF$solidjsweb.createComponent((0, $gVhhF$solidjs.Show), {
+      get when() {
+        return !salePrice.loading && salePrice.latest;
       },
-      get price_formatting_() {
-        return i18n_.price_formatting_();
+      get fallback() {
+        return $gVhhF$solidjsweb.createComponent((0, $061ff5b4c3d36171$export$89c6019e4baa40b1), {
+          width: "5ch",
+          height: "1em",
+          "class": "price"
+        });
+      },
+      get children() {
+        var _el$19 = $gVhhF$solidjsweb.getNextElement($6ae613870d3380fc$var$_tmpl$5),
+          _el$20 = _el$19.firstChild,
+          [_el$21, _co$6] = $gVhhF$solidjsweb.getNextMarker(_el$20.nextSibling),
+          _el$22 = _el$21.nextSibling,
+          [_el$23, _co$7] = $gVhhF$solidjsweb.getNextMarker(_el$22.nextSibling),
+          _el$24 = _el$23.nextSibling,
+          [_el$25, _co$8] = $gVhhF$solidjsweb.getNextMarker(_el$24.nextSibling);
+        $gVhhF$solidjsweb.insert(_el$19, () => i18n_.price_formatting_().pre_, _el$21, _co$6);
+        $gVhhF$solidjsweb.insert(_el$19, $gVhhF$solidjsweb.createComponent((0, $d659702496cb72ea$export$a71e92cfbb498adc), {
+          get price_() {
+            return salePrice();
+          },
+          get price_formatting_() {
+            return i18n_.price_formatting_();
+          }
+        }), _el$23, _co$7);
+        $gVhhF$solidjsweb.insert(_el$19, () => i18n_.price_formatting_().post_, _el$25, _co$8);
+        $gVhhF$solidjsweb.effect(() => _el$19.classList.toggle("sales-price", !!isOnSale()));
+        return _el$19;
       }
-    }), _el$23, _co$7);
-    $gVhhF$solidjsweb.insert(_el$19, () => i18n_.price_formatting_().post_, _el$25, _co$8);
+    }), _el$29, _co$10);
     $gVhhF$solidjsweb.effect(_p$ => {
       var _v$ = href(),
         _v$2 = display_.search_result_id,
@@ -374,24 +509,6 @@ const $6ae613870d3380fc$export$b05c0ae390cf3e06 = ({
   })();
 };
 $gVhhF$solidjsweb.delegateEvents(["click"]);
-var $9fe9883b1d8ecccc$var$_tmpl$ = /*#__PURE__*/$gVhhF$solidjsweb.template(`<span>`);
-function $9fe9883b1d8ecccc$export$acb3eaade4b23afd(props) {
-  // Work around https://github.com/solidjs/solid/issues/1980
-  return (() => {
-    var _el$ = $gVhhF$solidjsweb.getNextElement($9fe9883b1d8ecccc$var$_tmpl$);
-    $gVhhF$solidjsweb.effect(_p$ => {
-      var _v$ = `${props.class || ""} depict-placeholder`,
-        _v$2 = props.style;
-      _v$ !== _p$.e && $gVhhF$solidjsweb.className(_el$, _p$.e = _v$);
-      _p$.t = $gVhhF$solidjsweb.style(_el$, _v$2, _p$.t);
-      return _p$;
-    }, {
-      e: undefined,
-      t: undefined
-    });
-    return _el$;
-  })();
-}
 function $3bc4a89b971a3af5$export$3f37af283f8fb843(props) {
   const style = $gVhhF$solidjs.createMemo(() => {
     const {
@@ -423,30 +540,6 @@ function $3bc4a89b971a3af5$export$3f37af283f8fb843(props) {
     }
   });
 }
-function $061ff5b4c3d36171$export$89c6019e4baa40b1(props) {
-  const style = $gVhhF$solidjs.createMemo(() => {
-    const {
-      style: style,
-      height: height,
-      width: width
-    } = props;
-    return {
-      ...(style || {}),
-      height: height ?? "1em",
-      ...(width && {
-        width: width
-      })
-    };
-  });
-  return $gVhhF$solidjsweb.createComponent((0, $9fe9883b1d8ecccc$export$acb3eaade4b23afd), {
-    get style() {
-      return style();
-    },
-    get ["class"]() {
-      return props.class;
-    }
-  });
-}
 var $6f604560873e4f69$var$_tmpl$ = /*#__PURE__*/$gVhhF$solidjsweb.template(`<div class=instant-card><div class=img-part></div><div class=right-part><div class=title-brand-tagline><span class=title></span></div><div class=price-container>`);
 const $6f604560873e4f69$export$8a2234b5b1a5ebd4 = "--image-aspect-ratio";
 function $6f604560873e4f69$export$ee1733d9a8495996() {
@@ -555,7 +648,12 @@ function $a73063cc642f3e5f$export$43f0fb951fcb0c54({
         // We had a case on singular where they popped an image url and due to use caching after some time there was no image
         // Attempt cloning the displays if possible (99.9% of the cases probably) and if not, just use the original display
         try {
-          display = structuredClone(display);
+          // Use promiseSafeStructuredClone so that:
+          // 1. When fetching for example prices from an API, one can start that API request
+          // 2. Add the promise to the display
+          // 3. Already render the product card with placeholders for prices while the price loads
+          // 4. When the price loads, re-render the display with the new price
+          display = $ac946c6b782bb900$export$83bb9af5671e1dbe(display);
         } catch (e) {
           if (!$a73063cc642f3e5f$var$printedCloneError) {
             $a73063cc642f3e5f$var$printedCloneError = true;
@@ -613,7 +711,7 @@ function $a73063cc642f3e5f$export$43f0fb951fcb0c54({
 // Modified futher to bias towards saying objects are equal non-primitive objects differ
 function $a73063cc642f3e5f$var$deep_equal(obj1, obj2) {
   const stack = [[obj1, obj2]];
-  while (stack.length > 0) {
+  while (stack.length) {
     const [currentObj1, currentObj2] = stack.pop();
     if (currentObj1 === currentObj2) continue;
     if (Array.isArray(currentObj1) && Array.isArray(currentObj2)) {
@@ -2541,10 +2639,10 @@ function $19950faaac026e09$export$6e5611bc7e57e477(props) {
   const src_options = $gVhhF$solidjs.createMemo(() => {
     const {
       src: src,
-      customGenerateImageUrl_: customGenerateImageUrl_
+      customUrls: customUrls
     } = props;
-    const fallback_src = (customGenerateImageUrl_ || $19950faaac026e09$export$1d6267828870adda)(src, 400);
-    const srcset = $19950faaac026e09$var$make_srcset(props.src, props.resolutions || [64, 128, 256, 300, 400, 512, 640, 768, 1024, 1280, 1536, 2048, 2560, 3072, 3584, 4096], customGenerateImageUrl_);
+    const fallback_src = (customUrls || $19950faaac026e09$export$1d6267828870adda)(src, 400);
+    const srcset = $19950faaac026e09$var$make_srcset(props.src, props.resolutions || [64, 128, 256, 300, 400, 512, 640, 768, 1024, 1280, 1536, 2048, 2560, 3072, 3584, 4096], customUrls);
     // The order here *might* matter - I've seen mobile safari always start with loading the 400px version when it was reversed
     return {
       srcset: srcset,
@@ -2553,7 +2651,9 @@ function $19950faaac026e09$export$6e5611bc7e57e477(props) {
   });
   // Work around https://github.com/solidjs/solid/issues/1828
   const img = new Image(); // Need to use new Image or browser might not start loading image before it's in the DOM
-  const [, otherAttributes] = $gVhhF$solidjs.splitProps(props, ["resolutions", "size", "src", "srcSet", "loading"]);
+  const [, otherAttributes] = $gVhhF$solidjs.splitProps(props, ["resolutions", "size", "src", "srcSet", "loading", "customUrls" // Can't have properties ending on underscore because the property name mangling will get confused by this <-
+  ]);
+
   const [hasSetSize, setHasSetSize] = $gVhhF$solidjs.createSignal(false);
   const [hasDecoded, setHasDecoded] = $gVhhF$solidjs.createSignal(false);
   const productCardIndexAccessor = $129b9b9c010039d0$export$e3faf4d95300054f();
@@ -2749,7 +2849,7 @@ function $e8327f98c8ee28d7$export$9d4a4b669b1929ab(props) {
     get imgProps() {
       return {
         ...props.imgProps,
-        customGenerateImageUrl_: (url, width // Apparently don't have to encode url for CF's service
+        customUrls: (url, width // Apparently don't have to encode url for CF's service
         ) => {
           if (url.startsWith("https://cdn.shopify.com"))
             // The shopify image resizing CDN blocks Cloudflare's image resizer. It's possible that we can't detect shopify image URLs sometimes because they go to the merchant's domain,

package/latest/index.d.ts

@@ -10,7 +10,13 @@ import { ProductListingRequestV3 } from "@depict-ai/types/api/ProductListingRequ
 import { GetListingRequest } from "@depict-ai/types/api/GetListingRequest";
 import { BaseSearchRequestV3 } from "@depict-ai/types/api/BaseSearchRequestV3";
 import { SearchFilter as _SearchFilter3 } from "@depict-ai/types/api/SearchRequestV2";
-export const version = "4.1.4";
+export const version = "4.1.5";
+/**
+ * This is a function that will safely clone an object that may contain promises.
+ * It will use structuredClone to clone the object and then re-apply (copy) any promises that were in the original object to the cloned object.
+ * @param obj Anything to clone
+ */
+export function promiseSafeStructuredClone<T>(obj: T): T;
 export const prefixes_to_preserve_in_history_dot_state: Set<string>;
 /**
  * Prevent, usually SPAs, from deleting our stuff from history.state when they call history.pushState with a new object they have constructed. This will only run once no matter how often it's called.
@@ -436,7 +442,7 @@ export function ShopifyResponsiveImg(props: {
   size: Accessor<number>;
   src: string;
   loading?: "eager" | "lazy" | "force-lazy";
-  customGenerateImageUrl_?: (url: string, width: number) => string;
+  customUrls?: (url: string, width: number) => string;
 } & Omit<JSX.ImgHTMLAttributes<HTMLImageElement>, "srcset" | "src" | "sizes" | "loading">): JSX.Element;
 type ImagePlaceholderBaseOptions = {
   style?: JSX.CSSProperties;