@builder.io/sdk-solid 0.12.6 → 0.12.8

package/lib/browser/index.jsx

@@ -99,7 +99,7 @@ import { createContext as createContext2 } from "solid-js";
 var components_context_default = createContext2({ registeredComponents: {} });
 
 // src/components/block/block.tsx
-import { Show as Show4, For as For2, createSignal as createSignal4 } from "solid-js";
+import { Show as Show4, For as For2, onMount, createSignal as createSignal4 } from "solid-js";
 
 // src/functions/get-block-component-options.ts
 function getBlockComponentOptions(block) {
@@ -408,6 +408,211 @@ function getProcessedBlock({
   }
 }
 
+// src/components/block/animator.ts
+function throttle(func, wait, options = {}) {
+  let context;
+  let args;
+  let result;
+  let timeout = null;
+  let previous = 0;
+  const later = function() {
+    previous = options.leading === false ? 0 : Date.now();
+    timeout = null;
+    result = func.apply(context, args);
+    if (!timeout)
+      context = args = null;
+  };
+  return function() {
+    const now = Date.now();
+    if (!previous && options.leading === false)
+      previous = now;
+    const remaining = wait - (now - previous);
+    context = this;
+    args = arguments;
+    if (remaining <= 0 || remaining > wait) {
+      if (timeout) {
+        clearTimeout(timeout);
+        timeout = null;
+      }
+      previous = now;
+      result = func.apply(context, args);
+      if (!timeout)
+        context = args = null;
+    } else if (!timeout && options.trailing !== false) {
+      timeout = setTimeout(later, remaining);
+    }
+    return result;
+  };
+}
+function assign(target, ..._args) {
+  const to = Object(target);
+  for (let index = 1; index < arguments.length; index++) {
+    const nextSource = arguments[index];
+    if (nextSource != null) {
+      for (const nextKey in nextSource) {
+        if (Object.prototype.hasOwnProperty.call(nextSource, nextKey)) {
+          to[nextKey] = nextSource[nextKey];
+        }
+      }
+    }
+  }
+  return to;
+}
+var camelCaseToKebabCase = (str) => str ? str.replace(/([A-Z])/g, (g) => `-${g[0].toLowerCase()}`) : "";
+function bindAnimations(animations) {
+  for (const animation of animations) {
+    switch (animation.trigger) {
+      case "pageLoad":
+        triggerAnimation(animation);
+        break;
+      case "hover":
+        bindHoverAnimation(animation);
+        break;
+      case "scrollInView":
+        bindScrollInViewAnimation(animation);
+        break;
+    }
+  }
+}
+function warnElementNotPresent(id) {
+}
+function augmentAnimation(animation, element) {
+  const stylesUsed = getAllStylesUsed(animation);
+  const computedStyle = getComputedStyle(element);
+  const firstStyles = animation.steps[0].styles;
+  const lastStyles = animation.steps[animation.steps.length - 1].styles;
+  const bothStyles = [firstStyles, lastStyles];
+  for (const styles of bothStyles) {
+    for (const style of stylesUsed) {
+      if (!(style in styles)) {
+        styles[style] = computedStyle[style];
+      }
+    }
+  }
+}
+function getAllStylesUsed(animation) {
+  const properties = [];
+  for (const step of animation.steps) {
+    for (const key in step.styles) {
+      if (properties.indexOf(key) === -1) {
+        properties.push(key);
+      }
+    }
+  }
+  return properties;
+}
+function triggerAnimation(animation) {
+  const elements = Array.prototype.slice.call(document.getElementsByClassName(animation.elementId || animation.id || ""));
+  if (!elements.length) {
+    warnElementNotPresent(animation.elementId || animation.id || "");
+    return;
+  }
+  Array.from(elements).forEach((element) => {
+    augmentAnimation(animation, element);
+    element.style.transition = "none";
+    element.style.transitionDelay = "0";
+    assign(element.style, animation.steps[0].styles);
+    setTimeout(() => {
+      element.style.transition = `all ${animation.duration}s ${camelCaseToKebabCase(animation.easing)}`;
+      if (animation.delay) {
+        element.style.transitionDelay = animation.delay + "s";
+      }
+      assign(element.style, animation.steps[1].styles);
+      setTimeout(() => {
+        element.style.transition = "";
+        element.style.transitionDelay = "";
+      }, (animation.delay || 0) * 1e3 + animation.duration * 1e3 + 100);
+    });
+  });
+}
+function bindHoverAnimation(animation) {
+  const elements = Array.prototype.slice.call(document.getElementsByClassName(animation.elementId || animation.id || ""));
+  if (!elements.length) {
+    warnElementNotPresent(animation.elementId || animation.id || "");
+    return;
+  }
+  Array.from(elements).forEach((element) => {
+    augmentAnimation(animation, element);
+    const defaultState = animation.steps[0].styles;
+    const hoverState = animation.steps[1].styles;
+    function attachDefaultState() {
+      assign(element.style, defaultState);
+    }
+    function attachHoverState() {
+      assign(element.style, hoverState);
+    }
+    attachDefaultState();
+    element.addEventListener("mouseenter", attachHoverState);
+    element.addEventListener("mouseleave", attachDefaultState);
+    setTimeout(() => {
+      element.style.transition = `all ${animation.duration}s ${camelCaseToKebabCase(animation.easing)}`;
+      if (animation.delay) {
+        element.style.transitionDelay = animation.delay + "s";
+      }
+    });
+  });
+}
+function bindScrollInViewAnimation(animation) {
+  const elements = Array.prototype.slice.call(document.getElementsByClassName(animation.elementId || animation.id || ""));
+  if (!elements.length) {
+    warnElementNotPresent(animation.elementId || animation.id || "");
+    return;
+  }
+  Array.from(elements).forEach((element) => {
+    augmentAnimation(animation, element);
+    let triggered = false;
+    let pendingAnimation = false;
+    function immediateOnScroll() {
+      if (!triggered && isScrolledIntoView(element)) {
+        triggered = true;
+        pendingAnimation = true;
+        setTimeout(() => {
+          assign(element.style, animation.steps[1].styles);
+          if (!animation.repeat) {
+            document.removeEventListener("scroll", onScroll);
+          }
+          setTimeout(() => {
+            pendingAnimation = false;
+            if (!animation.repeat) {
+              element.style.transition = "";
+              element.style.transitionDelay = "";
+            }
+          }, (animation.duration + (animation.delay || 0)) * 1e3 + 100);
+        });
+      } else if (animation.repeat && triggered && !pendingAnimation && !isScrolledIntoView(element)) {
+        triggered = false;
+        assign(element.style, animation.steps[0].styles);
+      }
+    }
+    const onScroll = throttle(immediateOnScroll, 200, {
+      leading: false
+    });
+    function isScrolledIntoView(elem) {
+      const rect = elem.getBoundingClientRect();
+      const windowHeight = window.innerHeight;
+      const thresholdPercent = (animation.thresholdPercent || 0) / 100;
+      const threshold = thresholdPercent * windowHeight;
+      return rect.bottom > threshold && rect.top < windowHeight - threshold;
+    }
+    const defaultState = animation.steps[0].styles;
+    function attachDefaultState() {
+      assign(element.style, defaultState);
+    }
+    attachDefaultState();
+    setTimeout(() => {
+      element.style.transition = `all ${animation.duration}s ${camelCaseToKebabCase(animation.easing)}`;
+      if (animation.delay) {
+        element.style.transitionDelay = animation.delay + "s";
+      }
+    });
+    document.addEventListener("scroll", onScroll, {
+      capture: true,
+      passive: true
+    });
+    immediateOnScroll();
+  });
+}
+
 // src/components/block/block.helpers.ts
 var getComponent = ({
   block,
@@ -927,6 +1132,18 @@ function Block(props) {
       isInteractive: !blockComponent()?.isRSC
     };
   }
+  onMount(() => {
+    const blockId = processedBlock().id;
+    const animations = processedBlock().animations;
+    if (animations && blockId) {
+      bindAnimations(
+        animations.filter((item) => item.trigger !== "hover").map((animation) => ({
+          ...animation,
+          elementId: blockId
+        }))
+      );
+    }
+  });
   return <Show4 when={canShowBlock()}>
     <Block_styles_default block={props.block} context={props.context} />
     <Show4
@@ -1374,10 +1591,10 @@ function SectionComponent(props) {
 var section_default = SectionComponent;
 
 // src/blocks/symbol/symbol.tsx
-import { onMount as onMount4, on as on3, createEffect as createEffect3, createSignal as createSignal14 } from "solid-js";
+import { onMount as onMount5, on as on3, createEffect as createEffect3, createSignal as createSignal14 } from "solid-js";
 
 // src/components/content-variants/content-variants.tsx
-import { Show as Show11, For as For5, onMount as onMount3, createSignal as createSignal13 } from "solid-js";
+import { Show as Show11, For as For5, onMount as onMount4, createSignal as createSignal13 } from "solid-js";
 
 // src/helpers/url.ts
 var getTopLevelDomain = (host) => {
@@ -1855,12 +2072,12 @@ var componentInfo3 = {
 };
 
 // src/blocks/custom-code/custom-code.tsx
-import { onMount, createSignal as createSignal7 } from "solid-js";
+import { onMount as onMount2, createSignal as createSignal7 } from "solid-js";
 function CustomCode(props) {
   const [scriptsInserted, setScriptsInserted] = createSignal7([]);
   const [scriptsRun, setScriptsRun] = createSignal7([]);
   let elementRef;
-  onMount(() => {
+  onMount2(() => {
     if (!elementRef?.getElementsByTagName || typeof window === "undefined") {
       return;
     }
@@ -2578,7 +2795,7 @@ function InlinedScript(props) {
 var Inlined_script_default = InlinedScript;
 
 // src/components/content/components/enable-editor.tsx
-import { Show as Show9, onMount as onMount2, on as on2, createEffect as createEffect2, createSignal as createSignal10 } from "solid-js";
+import { Show as Show9, onMount as onMount3, on as on2, createEffect as createEffect2, createSignal as createSignal10 } from "solid-js";
 import { Dynamic as Dynamic5 } from "solid-js/web";
 
 // src/helpers/preview-lru-cache/get.ts
@@ -2813,13 +3030,6 @@ async function fetchEntries(options) {
 }
 var getAllContent = fetchEntries;
 
-// src/functions/is-from-trusted-host.ts
-var DEFAULT_TRUSTED_HOSTS = ["*.beta.builder.io", "beta.builder.io", "builder.io", "localhost", "qa.builder.io"];
-function isFromTrustedHost(trustedHosts, e) {
-  const url = new URL(e.origin), hostname = url.hostname;
-  return (trustedHosts || DEFAULT_TRUSTED_HOSTS).findIndex((trustedHost) => trustedHost.startsWith("*.") ? hostname.endsWith(trustedHost.slice(1)) : trustedHost === hostname) > -1;
-}
-
 // src/functions/is-previewing.ts
 function isPreviewing() {
   if (!isBrowser()) {
@@ -3067,8 +3277,15 @@ var getInteractionPropertiesForEvent = (event) => {
   };
 };
 
+// src/functions/is-from-trusted-host.ts
+var DEFAULT_TRUSTED_HOSTS = ["*.beta.builder.io", "beta.builder.io", "builder.io", "localhost", "qa.builder.io"];
+function isFromTrustedHost(trustedHosts, e) {
+  const url = new URL(e.origin), hostname = url.hostname;
+  return (trustedHosts || DEFAULT_TRUSTED_HOSTS).findIndex((trustedHost) => trustedHost.startsWith("*.") ? hostname.endsWith(trustedHost.slice(1)) : trustedHost === hostname) > -1;
+}
+
 // src/constants/sdk-version.ts
-var SDK_VERSION = "0.12.6";
+var SDK_VERSION = "0.12.8";
 
 // src/functions/register.ts
 var registry = {};
@@ -3204,6 +3421,66 @@ var setupBrowserForEditing = (options = {}) => {
   }
 };
 
+// src/helpers/subscribe-to-editor.ts
+var createEditorListener = ({
+  model,
+  trustedHosts,
+  callbacks
+}) => {
+  return (event) => {
+    if (!isFromTrustedHost(trustedHosts, event)) {
+      return;
+    }
+    const {
+      data
+    } = event;
+    if (data) {
+      switch (data.type) {
+        case "builder.configureSdk": {
+          callbacks.configureSdk(data.data);
+          break;
+        }
+        case "builder.triggerAnimation": {
+          callbacks.animation(data.data);
+          break;
+        }
+        case "builder.contentUpdate": {
+          const messageContent = data.data;
+          const key = messageContent.key || messageContent.alias || messageContent.entry || messageContent.modelName;
+          const contentData = messageContent.data;
+          if (key === model) {
+            callbacks.contentUpdate(contentData);
+          }
+          break;
+        }
+      }
+    }
+  };
+};
+var subscribeToEditor = (model, callback, options) => {
+  if (!isBrowser) {
+    logger.warn("`subscribeToEditor` only works in the browser. It currently seems to be running on the server.");
+    return () => {
+    };
+  }
+  setupBrowserForEditing();
+  const listener = createEditorListener({
+    callbacks: {
+      contentUpdate: callback,
+      animation: () => {
+      },
+      configureSdk: () => {
+      }
+    },
+    model,
+    trustedHosts: options?.trustedHosts
+  });
+  window.addEventListener("message", listener);
+  return () => {
+    window.removeEventListener("message", listener);
+  };
+};
+
 // src/components/content/components/enable-editor.tsx
 function EnableEditor(props) {
   const [forceReRenderCount, setForceReRenderCount] = createSignal10(0);
@@ -3249,14 +3526,11 @@ function EnableEditor(props) {
     }));
   }
   function processMessage(event) {
-    if (!isFromTrustedHost(props.trustedHosts, event)) {
-      return;
-    }
-    const { data } = event;
-    if (data) {
-      switch (data.type) {
-        case "builder.configureSdk": {
-          const messageContent = data.data;
+    return createEditorListener({
+      model: props.model,
+      trustedHosts: props.trustedHosts,
+      callbacks: {
+        configureSdk: (messageContent) => {
           const { breakpoints, contentId } = messageContent;
           if (!contentId || contentId !== props.builderContextSignal.content?.id) {
             return;
@@ -3267,22 +3541,18 @@ function EnableEditor(props) {
                 breakpoints
               }
             });
-          }
-          setForceReRenderCount(forceReRenderCount() + 1);
-          break;
-        }
-        case "builder.contentUpdate": {
-          const messageContent = data.data;
-          const key = messageContent.key || messageContent.alias || messageContent.entry || messageContent.modelName;
-          const contentData = messageContent.data;
-          if (key === props.model) {
-            mergeNewContent(contentData);
             setForceReRenderCount(forceReRenderCount() + 1);
           }
-          break;
+        },
+        animation: (animation) => {
+          triggerAnimation(animation);
+        },
+        contentUpdate: (newContent) => {
+          mergeNewContent(newContent);
+          setForceReRenderCount(forceReRenderCount() + 1);
         }
       }
-    }
+    })(event);
   }
   function evaluateJsCode() {
     const jsCode = props.builderContextSignal.content?.data?.jsCode;
@@ -3367,7 +3637,7 @@ function EnableEditor(props) {
     }
   }
   let elementRef;
-  onMount2(() => {
+  onMount3(() => {
     if (isBrowser()) {
       if (isEditing() && true) {
         setForceReRenderCount(forceReRenderCount() + 1);
@@ -3432,7 +3702,7 @@ function EnableEditor(props) {
       }
     }
   });
-  onMount2(() => {
+  onMount3(() => {
     if (!props.apiKey) {
       logger.error(
         "No API key provided to `RenderContent` component. This can cause issues. Please provide an API key using the `apiKey` prop."
@@ -3772,7 +4042,7 @@ function ContentVariants(props) {
       canTrack: getDefaultCanTrack(props.canTrack)
     });
   }
-  onMount3(() => {
+  onMount4(() => {
     setShouldRenderVariants(false);
   });
   return <>
@@ -3884,7 +4154,7 @@ function Symbol(props) {
       }
     });
   }
-  onMount4(() => {
+  onMount5(() => {
     setContent();
   });
   function onUpdateFn_0() {
@@ -3975,5 +4245,6 @@ export {
   isPreviewing,
   register,
   setEditorSettings,
+  subscribeToEditor,
   track
 };