@builder.io/sdk-svelte 0.0.1-3 → 0.0.1-32

package/src/components/render-content/render-content.svelte

@@ -1,228 +1,337 @@
-<script>
-    import { onMount } from 'svelte'
-    import { afterUpdate } from 'svelte'
-    import { onDestroy } from 'svelte'
-    
-  import  {  TARGET  }  from '../../constants/target.js';
-import  BuilderContext,  {  }  from '../../context/builder.context';
-import  {  evaluate  }  from '../../functions/evaluate.js';
-import  {  convertSearchParamsToQueryObject  ,  getBuilderSearchParams  }  from '../../functions/get-builder-search-params/index.js';
-import  {  getContent  }  from '../../functions/get-content/index.js';
-import  {  getFetch  }  from '../../functions/get-fetch.js';
-import  {  isBrowser  }  from '../../functions/is-browser.js';
-import  {  isEditing  }  from '../../functions/is-editing.js';
-import  {  isPreviewing  }  from '../../functions/is-previewing.js';
-import  {  previewingModelName  }  from '../../functions/previewing-model-name.js';
-import  {  track  }  from '../../functions/track.js';
-import  RenderBlocks,  {  }  from '../render-blocks.svelte';
-import  RenderContentStyles,  {  }  from './components/render-styles.svelte';
-
-  
-
-    import { getContext, setContext } from "svelte";
-
-    
-    export let content;
-export let data;
-export let model;
-export let apiKey;
-    
-    function processMessage(event) {
-const {
-  data
-} = event;
-
-if (data) {
-  switch (data.type) {
-    case 'builder.contentUpdate':
-      {
-        const messageContent = data.data;
-        const key = messageContent.key || messageContent.alias || messageContent.entry || messageContent.modelName;
-        const contentData = messageContent.data;
-
-        if (key === model) {
-          overrideContent = contentData;
-        }
-
-        break;
-      }
-
-    case 'builder.patchUpdates':
-      {
-        // TODO
-        break;
-      }
-  }
-}
-}
-
-function evaluateJsCode() {
-// run any dynamic JS code attached to content
-const jsCode = useContent?.()?.data?.jsCode;
-
-if (jsCode) {
-  evaluate({
-    code: jsCode,
-    context: context(),
-    state: contentState()
-  });
-}
-}
-
-function evalExpression(expression) {
-return expression.replace(/{{([^}]+)}}/g, (_match, group) => evaluate({
-  code: group,
-  context: context(),
-  state: contentState()
-}));
-}
-
-function handleRequest({
-url,
-key
-}) {
-const fetchAndSetState = async () => {
-  const fetch = await getFetch();
-  const response = await fetch(url);
-  const json = await response.json();
-  const newOverrideState = { ...overrideState,
-    [key]: json
+<script context="module" lang="ts">
+  export type RenderContentProps = {
+    content?: Nullable<BuilderContent>;
+    model?: string;
+    data?: {
+      [key: string]: any;
+    };
+    context?: BuilderRenderContext;
+    apiKey: string;
+    customComponents?: RegisteredComponent[];
+    canTrack?: boolean;
   };
-  overrideState = newOverrideState;
-};
-
-fetchAndSetState();
-}
-
-function runHttpRequests() {
-const requests = useContent?.()?.data?.httpRequests ?? {};
-Object.entries(requests).forEach(([key, url]) => {
-  if (url && (!httpReqsData()[key] || isEditing())) {
-    const evaluatedUrl = evalExpression(url);
-    handleRequest({
-      url: evaluatedUrl,
-      key
-    });
-  }
-});
-}
 
-function emitStateUpdate() {
-window.dispatchEvent(new CustomEvent('builder:component:stateChange', {
-  detail: {
-    state: contentState(),
+  interface BuilderComponentStateChange {
+    state: BuilderRenderState;
     ref: {
-      name: model
-    }
-  }
-}));
-}
-    $: useContent = () => {
-const mergedContent = { ...content,
-  ...overrideContent,
-  data: { ...content?.data,
-    ...data,
-    ...overrideContent?.data
+      name?: string;
+      props?: {
+        builderBlock?: {
+          id?: string;
+        };
+      };
+    };
   }
-};
-return mergedContent;
-};
-
-$: contentState = () => {
-return { ...content?.data?.state,
-  ...data,
-  ...overrideState
-};
-};
-
-$: context = () => {
-return {};
-};
-
-$: httpReqsData = () => {
-return {};
-};
-
-    
-    setContext(BuilderContext.key, { get content() {
-return useContent();
-}, get state() {
-return contentState();
-}, get context() {
-return context();
-}, get apiKey() {
-return apiKey;
-},});
-    let overrideContent = null;
-let update = 0;
-let overrideState = {};
-
-    onMount(() => { if (isBrowser()) {
-if (isEditing()) {
-  window.addEventListener('message', processMessage);
-  window.addEventListener('builder:component:stateChangeListenerActivated', emitStateUpdate);
-}
-
-if (useContent()) {
-  track('impression', {
-    contentId: useContent().id
+</script>
+
+<script lang="ts">
+  import { onMount } from "svelte";
+  import { afterUpdate } from "svelte";
+  import { onDestroy } from "svelte";
+
+  import { getDefaultRegisteredComponents } from "../../constants/builder-registered-components.js";
+  import { TARGET } from "../../constants/target.js";
+  import BuilderContext from "../../context/builder.context";
+  import { evaluate } from "../../functions/evaluate.js";
+  import { getContent } from "../../functions/get-content/index.js";
+  import { getFetch } from "../../functions/get-fetch.js";
+  import { isBrowser } from "../../functions/is-browser.js";
+  import { isEditing } from "../../functions/is-editing.js";
+  import { isPreviewing } from "../../functions/is-previewing.js";
+  import {
+    components,
+    createRegisterComponentMessage,
+  } from "../../functions/register-component.js";
+  import { track } from "../../functions/track.js";
+  import RenderBlocks from "../render-blocks.svelte";
+  import RenderContentStyles from "./components/render-styles.svelte";
+  import {
+    registerInsertMenu,
+    setupBrowserForEditing,
+  } from "../../scripts/init-editing.js";
+
+  import { getContext, setContext } from "svelte";
+
+  export let elementRef: RenderContentProps["elementRef"];
+  export let content: RenderContentProps["content"];
+  export let data: RenderContentProps["data"];
+  export let canTrack: RenderContentProps["canTrack"];
+  export let context: RenderContentProps["context"];
+  export let customComponents: RenderContentProps["customComponents"];
+  export let model: RenderContentProps["model"];
+  export let apiKey: RenderContentProps["apiKey"];
+
+  setContext(BuilderContext.key, {
+    get content() {
+      return useContent();
+    },
+    get state() {
+      return contentState();
+    },
+    get context() {
+      return contextContext();
+    },
+    get apiKey() {
+      return apiKey;
+    },
+    get registeredComponents() {
+      return allRegisteredComponents();
+    },
   });
-} // override normal content in preview mode
-
-
-if (isPreviewing()) {
-  if (model && previewingModelName() === model) {
-    const currentUrl = new URL(location.href);
-    const previewApiKey = currentUrl.searchParams.get('apiKey');
-
-    if (previewApiKey) {
-      getContent({
-        model: model,
-        apiKey: previewApiKey,
-        options: getBuilderSearchParams(convertSearchParamsToQueryObject(currentUrl.searchParams))
-      }).then(content => {
-        if (content) {
-          overrideContent = content;
+
+  const processMessage = function processMessage(event) {
+    const { data } = event;
+
+    if (data) {
+      switch (data.type) {
+        case "builder.contentUpdate": {
+          const messageContent = data.data;
+          const key =
+            messageContent.key ||
+            messageContent.alias ||
+            messageContent.entry ||
+            messageContent.modelName;
+          const contentData = messageContent.data;
+
+          if (key === model) {
+            overrideContent = contentData;
+          }
+
+          break;
+        }
+
+        case "builder.patchUpdates": {
+          // TODO
+          break;
         }
+      }
+    }
+  };
+
+  const evaluateJsCode = function evaluateJsCode() {
+    // run any dynamic JS code attached to content
+    const jsCode = useContent?.()?.data?.jsCode;
+
+    if (jsCode) {
+      evaluate({
+        code: jsCode,
+        context: contextContext(),
+        state: contentState(),
       });
     }
-  }
-}
+  };
 
-evaluateJsCode();
-runHttpRequests();
-emitStateUpdate();
-} });
+  const onClick = function onClick(_event) {
+    if (useContent()) {
+      track({
+        type: "click",
+        canTrack: canTrackToUse(),
+        contentId: useContent().id,
+        orgId: apiKey,
+      });
+    }
+  };
 
-    afterUpdate(() => { evaluateJsCode(); });afterUpdate(() => { runHttpRequests(); });afterUpdate(() => { emitStateUpdate(); })
+  const evalExpression = function evalExpression(expression) {
+    return expression.replace(/{{([^}]+)}}/g, (_match, group) =>
+      evaluate({
+        code: group,
+        context: contextContext(),
+        state: contentState(),
+      })
+    );
+  };
 
-    onDestroy(() => { if (isBrowser()) {
-window.removeEventListener('message', processMessage);
-window.removeEventListener('builder:component:stateChangeListenerActivated', emitStateUpdate);
-} });
-  </script>
+  const handleRequest = function handleRequest({ url, key }) {
+    const fetchAndSetState = async () => {
+      const fetch = await getFetch();
+      const response = await fetch(url);
+      const json = await response.json();
+      const newOverrideState = { ...overrideState, [key]: json };
+      overrideState = newOverrideState;
+    };
 
-  
-{#if useContent() }
+    fetchAndSetState();
+  };
 
-    
-<div  on:click="{event => track('click', {
-contentId: useContent().id
-})}"  data-builder-content-id={useContent?.()?.id} >
-      
+  const runHttpRequests = function runHttpRequests() {
+    const requests = useContent?.()?.data?.httpRequests ?? {};
+    Object.entries(requests).forEach(([key, url]) => {
+      if (url && (!httpReqsData()[key] || isEditing())) {
+        const evaluatedUrl = evalExpression(url);
+        handleRequest({
+          url: evaluatedUrl,
+          key,
+        });
+      }
+    });
+  };
 
-{#if (useContent?.()?.data?.cssCode || useContent?.()?.data?.customFonts?.length) && TARGET !== 'reactNative' }
-<RenderContentStyles  cssCode={useContent().data.cssCode}  customFonts={useContent().data.customFonts} ></RenderContentStyles>
+  const emitStateUpdate = function emitStateUpdate() {
+    if (isEditing()) {
+      window.dispatchEvent(
+        new CustomEvent("builder:component:stateChange", {
+          detail: {
+            state: contentState(),
+            ref: {
+              name: model,
+            },
+          },
+        })
+      );
+    }
+  };
+  $: useContent = () => {
+    const mergedContent = {
+      ...content,
+      ...overrideContent,
+      data: { ...content?.data, ...data, ...overrideContent?.data },
+    };
+    return mergedContent;
+  };
 
+  $: canTrackToUse = () => {
+    return canTrack || true;
+  };
 
-{/if}
+  $: contentState = () => {
+    return { ...content?.data?.state, ...data, ...overrideState };
+  };
+
+  $: contextContext = () => {
+    return context || {};
+  };
+
+  $: allRegisteredComponents = () => {
+    const allComponentsArray = [
+      ...getDefaultRegisteredComponents(), // While this `components` object is deprecated, we must maintain support for it.
+      // Since users are able to override our default components, we need to make sure that we do not break such
+      // existing usage.
+      // This is why we spread `components` after the default Builder.io components, but before the `customComponents`,
+      // which is the new standard way of providing custom components, and must therefore take precedence.
+      ...components,
+      ...(customComponents || []),
+    ];
+    const allComponents = allComponentsArray.reduce(
+      (acc, curr) => ({ ...acc, [curr.name]: curr }),
+      {}
+    );
+    return allComponents;
+  };
+
+  $: httpReqsData = () => {
+    return {};
+  };
 
-      
-<RenderBlocks  blocks={useContent?.()?.data?.blocks} ></RenderBlocks>
+  $: shouldRenderContentStyles = () => {
+    return Boolean(
+      (useContent?.()?.data?.cssCode ||
+        useContent?.()?.data?.customFonts?.length) &&
+        TARGET !== "reactNative"
+    );
+  };
 
-    </div>
+  let forceReRenderCount = 0;
+  let overrideContent = null;
+  let update = 0;
+  let overrideState = {};
+
+  onMount(() => {
+    if (isBrowser()) {
+      if (isEditing()) {
+        forceReRenderCount = forceReRenderCount + 1; // QWIK-REPLACE: _useMutableProps
+
+        registerInsertMenu();
+        setupBrowserForEditing();
+        Object.values(allRegisteredComponents()).forEach(
+          (registeredComponent) => {
+            const message = createRegisterComponentMessage(registeredComponent);
+            window.parent?.postMessage(message, "*");
+          }
+        );
+        window.addEventListener("message", processMessage);
+        window.addEventListener(
+          "builder:component:stateChangeListenerActivated",
+          emitStateUpdate
+        );
+      }
 
-  
+      if (useContent()) {
+        track({
+          type: "impression",
+          canTrack: canTrackToUse(),
+          contentId: useContent().id,
+          orgId: apiKey,
+        });
+      } // override normal content in preview mode
+
+      if (isPreviewing()) {
+        const searchParams = new URL(location.href).searchParams;
+
+        if (model && searchParams.get("builder.preview") === model) {
+          const previewApiKey =
+            searchParams.get("apiKey") || searchParams.get("builder.space");
+
+          if (previewApiKey) {
+            getContent({
+              model: model,
+              apiKey: previewApiKey,
+            }).then((content) => {
+              if (content) {
+                overrideContent = content;
+              }
+            });
+          }
+        }
+      }
 
+      evaluateJsCode();
+      runHttpRequests();
+      emitStateUpdate();
+    }
+  });
 
-{/if}
+  function onUpdateFn_0() {
+    evaluateJsCode();
+  }
+  $: onUpdateFn_0(...[useContent?.()?.data?.jsCode]);
+  function onUpdateFn_1() {
+    runHttpRequests();
+  }
+  $: onUpdateFn_1(...[useContent?.()?.data?.httpRequests]);
+  function onUpdateFn_2() {
+    emitStateUpdate();
+  }
+  $: onUpdateFn_2(...[contentState()]);
+
+  onDestroy(() => {
+    if (isBrowser()) {
+      window.removeEventListener("message", processMessage);
+      window.removeEventListener(
+        "builder:component:stateChangeListenerActivated",
+        emitStateUpdate
+      );
+    }
+  });
+</script>
+
+{#if useContent()}
+  <div
+    bind:this={elementRef}
+    on:click={(event) => {
+      onClick(event);
+    }}
+    builder-content-id={useContent?.()?.id}
+  >
+    {#if shouldRenderContentStyles()}
+      <RenderContentStyles
+        cssCode={useContent?.()?.data?.cssCode}
+        customFonts={useContent?.()?.data?.customFonts}
+      />
+    {/if}
+    <RenderBlocks
+      blocks={useContent?.()?.data?.blocks}
+      key={forceReRenderCount}
+    />
+  </div>
+{/if}

package/src/components/render-inlined-styles.svelte

@@ -1,49 +1,27 @@
-<script>
-    
-    
-    
-    
-  import  {  TARGET  }  from '../constants/target.js';
-
-  
-
-    
-
-    
-    export let styles;
-    
-    
-    $: injectedStyleScript = () => {
-return `<${tagName()}>${styles}</${tagName()}>`;
-};
-
-$: tagName = () => {
-// NOTE: we have to obfusctate the name of the tag due to a limitation in the svelte-preprocessor plugin.
-// https://github.com/sveltejs/vite-plugin-svelte/issues/315#issuecomment-1109000027
-return 'sty' + 'le';
-};
-
-    
-    
-    
-
-    
-
-    
-
-    
-  </script>
-
-  
-{#if TARGET === 'svelte' }
-
-    
-{@html injectedStyleScript()}
-
-  
-
-
+<script context="module" lang="ts">
+  interface Props {
+    styles: string;
+  }
+</script>
+
+<script lang="ts">
+  import { TARGET } from "../constants/target.js";
+
+  export let styles: Props["styles"];
+
+  $: injectedStyleScript = () => {
+    return `<${tagName()}>${styles}</${tagName()}>`;
+  };
+
+  $: tagName = () => {
+    // NOTE: we have to obfusctate the name of the tag due to a limitation in the svelte-preprocessor plugin.
+    // https://github.com/sveltejs/vite-plugin-svelte/issues/315#issuecomment-1109000027
+    return "sty" + "le";
+  };
+</script>
+
+{#if TARGET === "svelte"}
+  {@html injectedStyleScript()}
 {:else}
-<svelte:component  this={tagName()} >{styles}</svelte:component>
-
-{/if}
+  <svelte:component this={tagName()}>{styles}</svelte:component>
+{/if}

package/src/constants/builder-registered-components.js

@@ -0,0 +1,51 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+import { default as Button } from "../blocks/button/button.svelte";
+import { componentInfo as buttonComponentInfo } from "../blocks/button/component-info";
+import { default as Columns } from "../blocks/columns/columns.svelte";
+import { componentInfo as columnsComponentInfo } from "../blocks/columns/component-info";
+import { componentInfo as fragmentComponentInfo } from "../blocks/fragment/component-info";
+import { default as Fragment } from "../blocks/fragment/fragment.svelte";
+import { componentInfo as imageComponentInfo } from "../blocks/image/component-info";
+import { default as Image } from "../blocks/image/image.svelte";
+import { componentInfo as sectionComponentInfo } from "../blocks/section/component-info";
+import { default as Section } from "../blocks/section/section.svelte";
+import { componentInfo as symbolComponentInfo } from "../blocks/symbol/component-info";
+import { default as Symbol } from "../blocks/symbol/symbol.svelte";
+import { componentInfo as textComponentInfo } from "../blocks/text/component-info";
+import { default as Text } from "../blocks/text/text.svelte";
+import { componentInfo as videoComponentInfo } from "../blocks/video/component-info";
+import { default as Video } from "../blocks/video/video.svelte";
+import { componentInfo as embedComponentInfo } from "../blocks/embed/component-info";
+import { default as embed } from "../blocks/embed/embed.svelte";
+import { default as Img } from "../blocks/img/img.svelte";
+import { componentInfo as imgComponentInfo } from "../blocks/img/component-info";
+const getDefaultRegisteredComponents = () => [
+  __spreadValues({ component: Columns }, columnsComponentInfo),
+  __spreadValues({ component: Image }, imageComponentInfo),
+  __spreadValues({ component: Img }, imgComponentInfo),
+  __spreadValues({ component: Text }, textComponentInfo),
+  __spreadValues({ component: Video }, videoComponentInfo),
+  __spreadValues({ component: Symbol }, symbolComponentInfo),
+  __spreadValues({ component: Button }, buttonComponentInfo),
+  __spreadValues({ component: Section }, sectionComponentInfo),
+  __spreadValues({ component: Fragment }, fragmentComponentInfo),
+  __spreadValues({ component: embed }, embedComponentInfo)
+];
+export {
+  getDefaultRegisteredComponents
+};