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

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

@@ -1,163 +1,207 @@
-<script>
-    
-    
-    
-    
-  import  {  TARGET  }  from '../../constants/target.js';
-import  BuilderContext,  {  }  from '../../context/builder.context';
-import  {  getBlockActions  }  from '../../functions/get-block-actions.js';
-import  {  getBlockComponentOptions  }  from '../../functions/get-block-component-options.js';
-import  {  getBlockProperties  }  from '../../functions/get-block-properties.js';
-import  {  getBlockStyles  }  from '../../functions/get-block-styles.js';
-import  {  getBlockTag  }  from '../../functions/get-block-tag.js';
-import  {  getProcessedBlock  }  from '../../functions/get-processed-block.js';
-import  {  components  }  from '../../functions/register-component.js';
-import  BlockStyles,  {  }  from './block-styles.svelte';
-
-  
-
-    import { getContext, setContext } from "svelte";
-
-    
-    export let block;
-    
-    
-    $: component = () => {
-const componentName = useBlock().component?.name;
-
-if (!componentName) {
-  return null;
-}
-
-const ref = components[componentName];
-
-if (componentName && !ref) {
-  // TODO: Public doc page with more info about this message
-  console.warn(`
+<script context="module" lang="ts">
+  export type RenderBlockProps = {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+  }; // eslint-disable-next-line @builder.io/mitosis/only-default-function-and-imports
+</script>
+
+<script lang="ts">
+  import { getBlockActions } from "../../functions/get-block-actions.js";
+  import { getBlockComponentOptions } from "../../functions/get-block-component-options.js";
+  import { getBlockProperties } from "../../functions/get-block-properties.js";
+  import { getBlockStyles } from "../../functions/get-block-styles.js";
+  import { getBlockTag } from "../../functions/get-block-tag.js";
+  import { getProcessedBlock } from "../../functions/get-processed-block.js";
+  import { evaluate } from "../../functions/evaluate.js";
+  import BlockStyles from "./block-styles.svelte";
+  import { isEmptyHtmlElement } from "./render-block.helpers.js";
+  import RenderComponent from "./render-component.svelte";
+  import RenderRepeatedBlock from "./render-repeated-block.svelte";
+
+  export let block: RenderBlockProps["block"];
+  export let context: RenderBlockProps["context"];
+
+  $: component = () => {
+    const componentName = getProcessedBlock({
+      block: block,
+      state: context.state,
+      context: context.context,
+      shouldEvaluateBindings: false,
+    }).component?.name;
+
+    if (!componentName) {
+      return null;
+    }
+
+    const ref = context.registeredComponents[componentName];
+
+    if (!ref) {
+      // TODO: Public doc page with more info about this message
+      console.warn(`
         Could not find a registered component named "${componentName}". 
         If you registered it, is the file that registered it imported by the file that needs to render it?`);
-}
-
-return ref;
-};
-
-$: componentInfo = () => {
-return component?.()?.info;
-};
-
-$: componentRef = () => {
-return component?.()?.component;
-};
-
-$: tagName = () => {
-return getBlockTag(useBlock());
-};
-
-$: useBlock = () => {
-return getProcessedBlock({
-  block: block,
-  state: builderContext.state,
-  context: builderContext.context
-});
-};
-
-$: propertiesAndActions = () => {
-return { ...getBlockProperties(useBlock()),
-  ...getBlockActions({
-    block: useBlock(),
-    state: builderContext.state,
-    context: builderContext.context
-  })
-};
-};
-
-$: css = () => {
-return getBlockStyles(useBlock());
-};
-
-$: componentOptions = () => {
-return getBlockComponentOptions(useBlock());
-};
-
-$: children = () => {
-// TO-DO: When should `canHaveChildren` dictate rendering?
-// This is currently commented out because some Builder components (e.g. Box) do not have `canHaveChildren: true`,
-// but still receive and need to render children.
-// return componentInfo?.()?.canHaveChildren ? useBlock().children : [];
-return useBlock().children ?? [];
-};
-
-$: noCompRefChildren = () => {
-return componentRef() ? [] : children();
-};
-
-    let builderContext = getContext(BuilderContext.key);
-    
-    
-
-    
-
-    
-
-    
-  </script>
-
-  
-    
-
-{#if !componentInfo?.()?.noWrap }
-
-      
-<svelte:element {...propertiesAndActions()} style={css()}  this={tagName()} >
-        
-
-{#if TARGET === 'vue' || TARGET === 'svelte' }
-
-          
-<BlockStyles  block={useBlock()} ></BlockStyles>
-
-        
-
-
-{/if}
-
-        
-
-{#if componentRef() }
-<svelte:component {...componentOptions()} builderBlock={useBlock()}  this={componentRef()} >
-            
-
-{#each children() as child, index }
-<svelte:self  block={child} ></svelte:self>
-{/each}
-
-
-          </svelte:component>
-
-
-{/if}
-
-        
-
-{#each noCompRefChildren() as child, index }
-<svelte:self  block={child} ></svelte:self>
-{/each}
-
-
-      </svelte:element>
-
-    
-
-
+      return undefined;
+    } else {
+      return ref;
+    }
+  };
+
+  $: componentInfo = () => {
+    if (component()) {
+      const { component: _, ...info } = component();
+      return info;
+    } else {
+      return undefined;
+    }
+  };
+
+  $: componentRef = () => {
+    return component?.()?.component;
+  };
+
+  $: tagName = () => {
+    return getBlockTag(useBlock());
+  };
+
+  $: useBlock = () => {
+    return repeatItemData()
+      ? block
+      : getProcessedBlock({
+          block: block,
+          state: context.state,
+          context: context.context,
+          shouldEvaluateBindings: true,
+        });
+  };
+
+  $: attributes = () => {
+    return {
+      ...getBlockProperties(useBlock()),
+      ...getBlockActions({
+        block: useBlock(),
+        state: context.state,
+        context: context.context,
+      }),
+      style: getBlockStyles(useBlock()),
+    };
+  };
+
+  $: shouldWrap = () => {
+    return !componentInfo?.()?.noWrap;
+  };
+
+  $: componentOptions = () => {
+    return {
+      ...getBlockComponentOptions(useBlock()),
+
+      /**
+       * These attributes are passed to the wrapper element when there is one. If `noWrap` is set to true, then
+       * they are provided to the component itself directly.
+       */
+      ...(shouldWrap()
+        ? {}
+        : {
+            attributes: attributes(),
+          }),
+    };
+  };
+
+  $: renderComponentProps = () => {
+    return {
+      blockChildren: children(),
+      componentRef: componentRef(),
+      componentOptions: componentOptions(),
+      context: context,
+    };
+  };
+
+  $: children = () => {
+    // TO-DO: When should `canHaveChildren` dictate rendering?
+    // This is currently commented out because some Builder components (e.g. Box) do not have `canHaveChildren: true`,
+    // but still receive and need to render children.
+    // return componentInfo?.()?.canHaveChildren ? useBlock().children : [];
+    return useBlock().children ?? [];
+  };
+
+  $: childrenWithoutParentComponent = () => {
+    /**
+     * When there is no `componentRef`, there might still be children that need to be rendered. In this case,
+     * we render them outside of `componentRef`.
+     * NOTE: We make sure not to render this if `repeatItemData` is non-null, because that means we are rendering an array of
+     * blocks, and the children will be repeated within those blocks.
+     */
+    const shouldRenderChildrenOutsideRef = !componentRef() && !repeatItemData();
+    return shouldRenderChildrenOutsideRef ? children() : [];
+  };
+
+  $: repeatItemData = () => {
+    /**
+     * we don't use `useBlock()` here because the processing done within its logic includes evaluating the block's bindings,
+     * which will not work if there is a repeat.
+     */
+    const { repeat, ...blockWithoutRepeat } = block;
+
+    if (!repeat?.collection) {
+      return undefined;
+    }
+
+    const itemsArray = evaluate({
+      code: repeat.collection,
+      state: context.state,
+      context: context.context,
+    });
+
+    if (!Array.isArray(itemsArray)) {
+      return undefined;
+    }
+
+    const collectionName = repeat.collection.split(".").pop();
+    const itemNameToUse =
+      repeat.itemName || (collectionName ? collectionName + "Item" : "item");
+    const repeatArray = itemsArray.map((item, index) => ({
+      context: {
+        ...context,
+        state: {
+          ...context.state,
+          $index: index,
+          $item: item,
+          [itemNameToUse]: item,
+          [`$${itemNameToUse}Index`]: index,
+        },
+      },
+      block: blockWithoutRepeat,
+    }));
+    return repeatArray;
+  };
+</script>
+
+{#if shouldWrap()}
+  {#if !isEmptyHtmlElement(tagName())}
+    <svelte:element this={tagName()} {...attributes()}>
+      {#if repeatItemData()}
+        {#each repeatItemData() as data, index (index)}
+          <RenderRepeatedBlock
+            repeatContext={data.context}
+            block={data.block}
+          />
+        {/each}
+      {/if}
+
+      {#if !repeatItemData()}
+        <RenderComponent {...renderComponentProps()} />
+      {/if}
+
+      {#each childrenWithoutParentComponent() as child ("render-block-" + child.id)}
+        <svelte:self block={child} {context} />
+      {/each}
+
+      {#each childrenWithoutParentComponent() as child ("block-style-" + child.id)}
+        <BlockStyles block={child} {context} />
+      {/each}
+    </svelte:element>
+  {:else}
+    <svelte:element this={tagName()} {...attributes()} />
+  {/if}
 {:else}
-<svelte:component {...componentOptions()} attributes={propertiesAndActions()}  builderBlock={useBlock()}  style={css()}  this={componentRef()} >
-          
-
-{#each children() as child, index }
-<svelte:self  block={child} ></svelte:self>
-{/each}
-
-
-        </svelte:component>
-
-{/if}
+  <RenderComponent {...renderComponentProps()} {context} />
+{/if}

package/src/components/render-block/render-component.svelte

@@ -0,0 +1,30 @@
+<script context="module" lang="ts">
+  export interface RenderComponentProps {
+    componentRef: any;
+    componentOptions: any;
+    blockChildren: BuilderBlock[];
+    context: BuilderContextInterface;
+  } // eslint-disable-next-line @builder.io/mitosis/only-default-function-and-imports
+</script>
+
+<script lang="ts">
+  import BlockStyles from "./block-styles.svelte";
+  import RenderBlock from "./render-block.svelte";
+
+  export let componentRef: RenderComponentProps["componentRef"];
+  export let componentOptions: RenderComponentProps["componentOptions"];
+  export let blockChildren: RenderComponentProps["blockChildren"];
+  export let context: RenderComponentProps["context"];
+</script>
+
+{#if componentRef}
+  <svelte:component this={componentRef} {...componentOptions}>
+    {#each blockChildren as child ("render-block-" + child.id)}
+      <RenderBlock block={child} {context} />
+    {/each}
+
+    {#each blockChildren as child ("block-style-" + child.id)}
+      <BlockStyles block={child} {context} />
+    {/each}
+  </svelte:component>
+{/if}

package/src/components/render-block/render-repeated-block.svelte

@@ -0,0 +1,45 @@
+<script context="module" lang="ts">
+  type Props = {
+    block: BuilderBlock;
+    repeatContext: BuilderContextInterface;
+  };
+  /**
+   * We can't make this a generic `ProvideContext` function because Vue 2 won't support root slots, e.g.
+   *
+   * ```vue
+   * <template>
+   *  <slot></slot>
+   * </template>
+   * ```
+   */
+</script>
+
+<script lang="ts">
+  import BuilderContext from "../../context/builder.context";
+  import RenderBlock from "./render-block.svelte";
+
+  import { getContext, setContext } from "svelte";
+
+  export let block: Props["block"];
+  export let repeatContext: Props["repeatContext"];
+
+  setContext(BuilderContext.key, {
+    get content() {
+      return repeatContext.content;
+    },
+    get state() {
+      return repeatContext.state;
+    },
+    get context() {
+      return repeatContext.context;
+    },
+    get apiKey() {
+      return repeatContext.apiKey;
+    },
+    get registeredComponents() {
+      return repeatContext.registeredComponents;
+    },
+  });
+</script>
+
+<RenderBlock {block} context={repeatContext} />

package/src/components/render-blocks.svelte

@@ -1,82 +1,90 @@
-<script>
-    
-    
-    
-    
-  import  {  isEditing  }  from '../functions/is-editing.js';
-import  RenderBlock,  {  }  from './render-block/render-block.svelte';
-
-  
-
-    
-
-    
-    export let blocks;
-export let parent;
-export let path;
-    
-    function onClick() {
-if (isEditing() && !blocks?.length) {
-  window.parent?.postMessage({
-    type: 'builder.clickEmptyBlocks',
-    data: {
-      parentElementId: parent,
-      dataPath: path
+<script context="module" lang="ts">
+  export type RenderBlockProps = {
+    blocks?: BuilderBlock[];
+    parent?: string;
+    path?: string;
+  };
+</script>
+
+<script lang="ts">
+  import BuilderContext from "../context/builder.context";
+  import { isEditing } from "../functions/is-editing.js";
+  import BlockStyles from "./render-block/block-styles.svelte";
+  import RenderBlock from "./render-block/render-block.svelte";
+
+  import { getContext, setContext } from "svelte";
+
+  export let blocks: RenderBlockProps["blocks"];
+  export let parent: RenderBlockProps["parent"];
+  export let path: RenderBlockProps["path"];
+
+  let builderContext = getContext(BuilderContext.key);
+
+  const onClick = function onClick() {
+    if (isEditing() && !blocks?.length) {
+      window.parent?.postMessage(
+        {
+          type: "builder.clickEmptyBlocks",
+          data: {
+            parentElementId: parent,
+            dataPath: path,
+          },
+        },
+        "*"
+      );
     }
-  }, '*');
-}
-}
-
-function onMouseEnter() {
-if (isEditing() && !blocks?.length) {
-  window.parent?.postMessage({
-    type: 'builder.hoverEmptyBlocks',
-    data: {
-      parentElementId: parent,
-      dataPath: path
+  };
+
+  const onMouseEnter = function onMouseEnter() {
+    if (isEditing() && !blocks?.length) {
+      window.parent?.postMessage(
+        {
+          type: "builder.hoverEmptyBlocks",
+          data: {
+            parentElementId: parent,
+            dataPath: path,
+          },
+        },
+        "*"
+      );
     }
-  }, '*');
-}
-}
-    $: className = () => {
-return 'builder-blocks' + (!blocks?.length ? ' no-blocks' : '');
-};
-
-    
-    
-    
-
-    
-
-    
-
-    
-  </script>
-
-  <div    builder-path={path}  builder-parent-id={parent}  dataSet={{
-class: className()
-}}  on:click="{event => onClick()}"  on:mouseenter="{event => onMouseEnter()}"  class={className()} >
-    
-
-{#if blocks }
-
-      
-
-{#each blocks as block, index }
-<RenderBlock  key={block.id}  block={block} ></RenderBlock>
-{/each}
-
-
-    
-
-
-{/if}
-
-  </div>
-
-  <style>
-    .div { 
-display: flex;
-flex-direction: column;
-align-items: stretch; }
-  </style>
+  };
+  $: className = () => {
+    return "builder-blocks" + (!blocks?.length ? " no-blocks" : "");
+  };
+</script>
+
+<div
+  class={className() + " div"}
+  builder-path={path}
+  builder-parent-id={parent}
+  dataSet={{
+    class: className(),
+  }}
+  on:click={(event) => {
+    onClick();
+  }}
+  on:mouseenter={(event) => {
+    onMouseEnter();
+  }}
+>
+  {#if blocks}
+    {#each blocks as block ("render-block-" + block.id)}
+      <RenderBlock {block} context={builderContext} />
+    {/each}
+  {/if}
+
+  {#if blocks}
+    {#each blocks as block ("block-style-" + block.id)}
+      <BlockStyles {block} context={builderContext} />
+    {/each}
+  {/if}
+</div>
+
+<style>
+  .div {
+    display: flex;
+    flex-direction: column;
+    align-items: stretch;
+  }
+</style>