@builder.io/sdk-svelte 0.13.1 → 0.13.3

package/src/blocks/form/form/form.svelte

@@ -0,0 +1,358 @@
+<script context="module" lang="ts">
+  /**
+   * This import is used by the Svelte SDK. Do not remove.
+   */
+
+  export type FormProps = BuilderDataProps &
+    BuilderComponentsProp &
+    BuilderLinkComponentProp & {
+      attributes?: any;
+      name?: string;
+      action?: string;
+      validate?: boolean;
+      method?: string;
+      sendSubmissionsTo?: string;
+      sendSubmissionsToEmail?: string;
+      sendWithJs?: boolean;
+      contentType?: string;
+      customHeaders?: {
+        [key: string]: string;
+      };
+      successUrl?: string;
+      previewState?: FormState;
+      successMessage?: BuilderBlock[];
+      errorMessage?: BuilderBlock[];
+      sendingMessage?: BuilderBlock[];
+      resetFormOnSubmit?: boolean;
+      errorMessagePath?: string;
+    };
+
+  /**
+   * This import is used by the Svelte SDK. Do not remove.
+   */
+
+  export type FormState = "unsubmitted" | "sending" | "success" | "error";
+</script>
+
+<script lang="ts">
+  import Block from "../../../components/block/block.svelte";
+  import Blocks from "../../../components/blocks/blocks.svelte";
+  import { getEnv } from "../../../functions/get-env.js";
+  import { get } from "../../../functions/get.js";
+  import { isEditing } from "../../../functions/is-editing.js";
+  import { set } from "../../../functions/set.js";
+  import type { BuilderBlock } from "../../../types/builder-block.js";
+  import type {
+    BuilderComponentsProp,
+    BuilderDataProps,
+    BuilderLinkComponentProp,
+  } from "../../../types/builder-props.js";
+  import type { Dictionary } from "../../../types/typescript.js";
+  import { filterAttrs } from "../../helpers.js";
+  import { setAttrs } from "../../helpers.js";
+
+  export let js: FormProps["js"];
+  export let builderContext: FormProps["builderContext"];
+  export let previewState: FormProps["previewState"] = undefined;
+  export let sendWithJs: FormProps["sendWithJs"] = undefined;
+  export let sendSubmissionsTo: FormProps["sendSubmissionsTo"] = undefined;
+  export let action: FormProps["action"] = undefined;
+  export let customHeaders: FormProps["customHeaders"] = undefined;
+  export let contentType: FormProps["contentType"] = undefined;
+  export let sendSubmissionsToEmail: FormProps["sendSubmissionsToEmail"] =
+    undefined;
+  export let name: FormProps["name"] = undefined;
+  export let method: FormProps["method"] = undefined;
+  export let errorMessagePath: FormProps["errorMessagePath"] = undefined;
+  export let resetFormOnSubmit: FormProps["resetFormOnSubmit"] = undefined;
+  export let successUrl: FormProps["successUrl"] = undefined;
+  export let validate: FormProps["validate"] = undefined;
+  export let attributes: FormProps["attributes"] = undefined;
+  export let builderBlock: FormProps["builderBlock"];
+  export let builderComponents: FormProps["builderComponents"];
+  export let builderLinkComponent: FormProps["builderLinkComponent"] =
+    undefined;
+  export let errorMessage: FormProps["errorMessage"] = undefined;
+  export let sendingMessage: FormProps["sendingMessage"] = undefined;
+  export let successMessage: FormProps["successMessage"] = undefined;
+
+  function mergeNewRootState(newData: Dictionary<any>) {
+    const combinedState = {
+      ...$builderContext.rootState,
+      ...newData,
+    };
+    if ($builderContext.rootSetState) {
+      $builderContext.rootSetState?.(combinedState);
+    } else {
+      $builderContext.rootState = combinedState;
+    }
+  }
+  function submissionState() {
+    return (isEditing() && previewState) || formState;
+  }
+  function onSubmit(event: any) {
+    const sendWithJsProp = sendWithJs || sendSubmissionsTo === "email";
+    if (sendSubmissionsTo === "zapier") {
+      event.preventDefault();
+    } else if (sendWithJsProp) {
+      if (!(action || sendSubmissionsTo === "email")) {
+        event.preventDefault();
+        return;
+      }
+      event.preventDefault();
+      const el = event.currentTarget;
+      const headers = customHeaders || {};
+      let body: any;
+      const formData = new FormData(el);
+
+      // TODO: maybe support null
+      const formPairs: {
+        key: string;
+        value: File | boolean | number | string | FileList;
+      }[] = Array.from(
+        event.currentTarget.querySelectorAll("input,select,textarea")
+      )
+        .filter((el) => !!(el as HTMLInputElement).name)
+        .map((el) => {
+          let value: any;
+          const key = (el as HTMLImageElement).name;
+          if (el instanceof HTMLInputElement) {
+            if (el.type === "radio") {
+              if (el.checked) {
+                value = el.name;
+                return {
+                  key,
+                  value,
+                };
+              }
+            } else if (el.type === "checkbox") {
+              value = el.checked;
+            } else if (el.type === "number" || el.type === "range") {
+              const num = el.valueAsNumber;
+              if (!isNaN(num)) {
+                value = num;
+              }
+            } else if (el.type === "file") {
+              // TODO: one vs multiple files
+              value = el.files;
+            } else {
+              value = el.value;
+            }
+          } else {
+            value = (el as HTMLInputElement).value;
+          }
+          return {
+            key,
+            value,
+          };
+        });
+      let formContentType = contentType;
+      if (sendSubmissionsTo === "email") {
+        formContentType = "multipart/form-data";
+      }
+      Array.from(formPairs).forEach(({ value }) => {
+        if (
+          value instanceof File ||
+          (Array.isArray(value) && value[0] instanceof File) ||
+          value instanceof FileList
+        ) {
+          formContentType = "multipart/form-data";
+        }
+      });
+
+      // TODO: send as urlEncoded or multipart by default
+      // because of ease of use and reliability in browser API
+      // for encoding the form?
+      if (formContentType !== "application/json") {
+        body = formData;
+      } else {
+        // Json
+        const json = {};
+        Array.from(formPairs).forEach(({ value, key }) => {
+          set(json, key, value);
+        });
+        body = JSON.stringify(json);
+      }
+      if (formContentType && formContentType !== "multipart/form-data") {
+        if (
+          /* Zapier doesn't allow content-type header to be sent from browsers */
+          !(sendWithJsProp && action?.includes("zapier.com"))
+        ) {
+          headers["content-type"] = formContentType;
+        }
+      }
+      const presubmitEvent = new CustomEvent("presubmit", {
+        detail: {
+          body,
+        },
+      });
+      if (formRef) {
+        formRef.dispatchEvent(presubmitEvent);
+        if (presubmitEvent.defaultPrevented) {
+          return;
+        }
+      }
+      formState = "sending";
+      const formUrl = `${
+        getEnv() === "dev" ? "http://localhost:5000" : "https://builder.io"
+      }/api/v1/form-submit?apiKey=${$builderContext.apiKey}&to=${btoa(
+        sendSubmissionsToEmail || ""
+      )}&name=${encodeURIComponent(name || "")}`;
+      fetch(
+        sendSubmissionsTo === "email"
+          ? formUrl
+          : action! /* TODO: throw error if no action URL */,
+        {
+          body,
+          headers,
+          method: method || "post",
+        }
+      ).then(
+        async (res) => {
+          let body;
+          const contentType = res.headers.get("content-type");
+          if (contentType && contentType.indexOf("application/json") !== -1) {
+            body = await res.json();
+          } else {
+            body = await res.text();
+          }
+          if (!res.ok && errorMessagePath) {
+            /* TODO: allow supplying an error formatter function */
+            let message = get(body, errorMessagePath);
+            if (message) {
+              if (typeof message !== "string") {
+                /* TODO: ideally convert json to yaml so it woul dbe like
+           error: - email has been taken */
+                message = JSON.stringify(message);
+              }
+              formErrorMessage = message;
+              mergeNewRootState({
+                formErrorMessage: message,
+              });
+            }
+          }
+          responseData = body;
+          formState = res.ok ? "success" : "error";
+          if (res.ok) {
+            const submitSuccessEvent = new CustomEvent("submit:success", {
+              detail: {
+                res,
+                body,
+              },
+            });
+            if (formRef) {
+              formRef.dispatchEvent(submitSuccessEvent);
+              if (submitSuccessEvent.defaultPrevented) {
+                return;
+              }
+              /* TODO: option to turn this on/off? */
+              if (resetFormOnSubmit !== false) {
+                formRef.reset();
+              }
+            }
+
+            /* TODO: client side route event first that can be preventDefaulted */
+            if (successUrl) {
+              if (formRef) {
+                const event = new CustomEvent("route", {
+                  detail: {
+                    url: successUrl,
+                  },
+                });
+                formRef.dispatchEvent(event);
+                if (!event.defaultPrevented) {
+                  location.href = successUrl;
+                }
+              } else {
+                location.href = successUrl;
+              }
+            }
+          }
+        },
+        (err) => {
+          const submitErrorEvent = new CustomEvent("submit:error", {
+            detail: {
+              error: err,
+            },
+          });
+          if (formRef) {
+            formRef.dispatchEvent(submitErrorEvent);
+            if (submitErrorEvent.defaultPrevented) {
+              return;
+            }
+          }
+          responseData = err;
+          formState = "error";
+        }
+      );
+    }
+  }
+
+  let formRef;
+
+  let formState = "unsubmitted";
+  let responseData = null;
+  let formErrorMessage = "";
+</script>
+
+<form
+  {validate}
+  bind:this={formRef}
+  action={!sendWithJs && action}
+  {method}
+  {name}
+  on:submit={(event) => {
+    onSubmit(event);
+  }}
+  {...filterAttrs(attributes, "on:", false)}
+  use:setAttrs={filterAttrs(attributes, "on:", true)}
+>
+  {#if builderBlock && builderBlock.children}
+    {#each builderBlock?.children as block, idx (`form-block-${idx}`)}
+      <Block
+        {block}
+        context={builderContext}
+        registeredComponents={builderComponents}
+        linkComponent={builderLinkComponent}
+      />
+    {/each}
+  {/if}
+
+  {#if submissionState() === "error"}
+    <Blocks
+      path="errorMessage"
+      blocks={errorMessage}
+      context={builderContext}
+    />
+  {/if}
+
+  {#if submissionState() === "sending"}
+    <Blocks
+      path="sendingMessage"
+      blocks={sendingMessage}
+      context={builderContext}
+    />
+  {/if}
+
+  {#if submissionState() === "error" && responseData}
+    <pre class="builder-form-error-text pre">
+        {JSON.stringify(responseData, null, 2)}
+      </pre>
+  {/if}
+
+  {#if submissionState() === "success"}
+    <Blocks
+      path="successMessage"
+      blocks={successMessage}
+      context={builderContext}
+    />
+  {/if}
+</form>
+
+<style>
+  .pre {
+    padding: 10px;
+    color: red;
+    text-align: center;
+  }
+</style>

package/src/blocks/{input → form/input}/component-info.ts

@@ -1,4 +1,4 @@
-import type { ComponentInfo } from '../../types/components.js';
+import type { ComponentInfo } from '../../../types/components.js';
 export const componentInfo: ComponentInfo = {
   name: 'Form:Input',
   image: 'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2Fad6f37889d9e40bbbbc72cdb5875d6ca',

package/src/blocks/{input → form/input}/input.svelte

@@ -15,9 +15,9 @@
 </script>
 
 <script lang="ts">
-  import { isEditing } from "../../functions/is-editing.js";
-  import { filterAttrs } from "../helpers.js";
-  import { setAttrs } from "../helpers.js";
+  import { isEditing } from "../../../functions/is-editing.js";
+  import { filterAttrs } from "../../helpers.js";
+  import { setAttrs } from "../../helpers.js";
 
   export let attributes: FormInputProps["attributes"] = undefined;
   export let defaultValue: FormInputProps["defaultValue"] = undefined;

package/src/blocks/{select → form/select}/component-info.ts

@@ -1,4 +1,4 @@
-import type { ComponentInfo } from '../../types/components.js';
+import type { ComponentInfo } from '../../../types/components.js';
 export const componentInfo: ComponentInfo = {
   name: 'Form:Select',
   image: 'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2F83acca093fb24aaf94dee136e9a4b045',

package/src/blocks/{select → form/select}/select.svelte

@@ -16,9 +16,9 @@
 </script>
 
 <script lang="ts">
-  import { isEditing } from "../../functions/is-editing.js";
-  import { filterAttrs } from "../helpers.js";
-  import { setAttrs } from "../helpers.js";
+  import { isEditing } from "../../../functions/is-editing.js";
+  import { filterAttrs } from "../../helpers.js";
+  import { setAttrs } from "../../helpers.js";
 
   export let attributes: FormSelectProps["attributes"] = undefined;
   export let value: FormSelectProps["value"] = undefined;

package/src/blocks/{submit-button → form/submit-button}/component-info.ts

@@ -1,4 +1,4 @@
-import type { ComponentInfo } from '../../types/components.js';
+import type { ComponentInfo } from '../../../types/components.js';
 export const componentInfo: ComponentInfo = {
   name: 'Form:SubmitButton',
   image: 'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2Fdf2820ffed1f4349a94c40b3221f5b98',

package/src/blocks/{submit-button → form/submit-button}/submit-button.svelte

@@ -10,8 +10,8 @@
 </script>
 
 <script lang="ts">
-  import { filterAttrs } from "../helpers.js";
-  import { setAttrs } from "../helpers.js";
+  import { filterAttrs } from "../../helpers.js";
+  import { setAttrs } from "../../helpers.js";
 
   export let attributes: ButtonProps["attributes"] = undefined;
   export let text: ButtonProps["text"] = undefined;

package/src/blocks/slot/slot.svelte

@@ -1,19 +1,17 @@
 <script context="module" lang="ts">
-  export interface DropzoneProps {
+  export type DropzoneProps = BuilderDataProps & {
     name: string;
-    builderBlock: BuilderBlock;
-    builderContext: Writable<BuilderContextInterface>;
     attributes: any;
-  }
+  };
 </script>
 
 <script lang="ts">
   import Blocks from "../../components/blocks/blocks.svelte";
-  import type { BuilderContextInterface } from "../../context/types.js";
   import { deoptSignal } from "../../functions/deopt.js";
   import type { BuilderBlock } from "../../types/builder-block.js";
-  import type { Writable } from "svelte/store";
+  import type { BuilderDataProps } from "../../types/builder-props.js";
 
+  export let js: DropzoneProps["js"];
   export let builderContext: DropzoneProps["builderContext"];
   export let name: DropzoneProps["name"];
 

package/src/blocks/symbol/symbol.svelte

@@ -3,7 +3,6 @@
 
   import ContentVariants from "../../components/content-variants/content-variants.svelte";
   import type { BuilderContent } from "../../types/builder-content.js";
-  import type { PropsWithBuilderData } from "../../types/builder-props.js";
   import { filterAttrs } from "../helpers.js";
   import { getClassPropName } from "../../functions/get-class-prop-name.js";
   import type { Nullable } from "../../types/typescript.js";
@@ -11,15 +10,13 @@
   import { fetchSymbolContent } from "./symbol.helpers.js";
   import type { SymbolProps } from "./symbol.types.js";
 
-  export let js: PropsWithBuilderData<SymbolProps>["js"];
-  export let attributes: PropsWithBuilderData<SymbolProps>["attributes"] =
-    undefined;
-  export let symbol: PropsWithBuilderData<SymbolProps>["symbol"] = undefined;
-  export let dynamic: PropsWithBuilderData<SymbolProps>["dynamic"] = undefined;
-  export let builderContext: PropsWithBuilderData<SymbolProps>["builderContext"];
-  export let builderBlock: PropsWithBuilderData<SymbolProps>["builderBlock"];
-  export let builderComponents: PropsWithBuilderData<SymbolProps>["builderComponents"];
-  export let builderLinkComponent: PropsWithBuilderData<SymbolProps>["builderLinkComponent"] =
+  export let attributes: SymbolProps["attributes"] = undefined;
+  export let symbol: SymbolProps["symbol"] = undefined;
+  export let dynamic: SymbolProps["dynamic"] = undefined;
+  export let builderContext: SymbolProps["builderContext"];
+  export let builderBlock: SymbolProps["builderBlock"];
+  export let builderComponents: SymbolProps["builderComponents"];
+  export let builderLinkComponent: SymbolProps["builderLinkComponent"] =
     undefined;
 
   function setContent() {

package/src/blocks/symbol/symbol.types.ts

@@ -1,5 +1,5 @@
 import type { BuilderContent } from '../../types/builder-content.js';
-import type { BuilderComponentsProp, BuilderLinkComponentProp } from '../../types/builder-props.js';
+import type { BuilderComponentsProp, BuilderDataProps, BuilderLinkComponentProp } from '../../types/builder-props.js';
 interface SymbolInfo {
   model?: string;
   entry?: string;
@@ -8,7 +8,7 @@ interface SymbolInfo {
   inline?: boolean;
   dynamic?: boolean;
 }
-export interface SymbolProps extends BuilderComponentsProp, BuilderLinkComponentProp {
+export interface SymbolProps extends BuilderComponentsProp, BuilderDataProps, BuilderLinkComponentProp {
   symbol?: SymbolInfo;
   dataOnly?: boolean;
   dynamic?: boolean;

package/src/components/block/block.svelte

@@ -102,13 +102,15 @@
         builderContext: context,
         ...(blockComponent?.()?.name === "Core:Button" ||
         blockComponent?.()?.name === "Symbol" ||
-        blockComponent?.()?.name === "Columns"
+        blockComponent?.()?.name === "Columns" ||
+        blockComponent?.()?.name === "Form:Form"
           ? {
               builderLinkComponent: linkComponent,
             }
           : {}),
         ...(blockComponent?.()?.name === "Symbol" ||
-        blockComponent?.()?.name === "Columns"
+        blockComponent?.()?.name === "Columns" ||
+        blockComponent?.()?.name === "Form:Form"
           ? {
               builderComponents: registeredComponents,
             }

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

@@ -4,6 +4,7 @@
     block: BuilderBlock;
     context: Writable<BuilderContextInterface>;
     linkComponent: any;
+    children?: any;
   };
 
   /**
@@ -16,13 +17,12 @@
   import { getBlockActions } from "../../../functions/get-block-actions.js";
   import { getBlockProperties } from "../../../functions/get-block-properties.js";
   import type { BuilderBlock } from "../../../types/builder-block.js";
-  import type { PropsWithChildren } from "../../../types/typescript.js";
   import DynamicRenderer from "../../dynamic-renderer/dynamic-renderer.svelte";
   import type { Writable } from "svelte/store";
 
-  export let Wrapper: PropsWithChildren<BlockWrapperProps>["Wrapper"];
-  export let block: PropsWithChildren<BlockWrapperProps>["block"];
-  export let context: PropsWithChildren<BlockWrapperProps>["context"];
+  export let Wrapper: BlockWrapperProps["Wrapper"];
+  export let block: BlockWrapperProps["block"];
+  export let context: BlockWrapperProps["context"];
 </script>
 
 <DynamicRenderer

package/src/components/block/components/component-ref/component-ref.helpers.ts

@@ -2,14 +2,14 @@ import type { Writable } from "svelte/store";
 import type { BuilderContextInterface, RegisteredComponents } from '../../../../context/types.js';
 import { getBlockProperties } from '../../../../functions/get-block-properties.js';
 import type { BuilderBlock } from '../../../../types/builder-block.js';
-import type { PropsWithBuilderData } from '../../../../types/builder-props.js';
+import type { BuilderDataProps } from '../../../../types/builder-props.js';
 import type { InteractiveElementProps } from '../interactive-element.svelte';
-type ComponentOptions = PropsWithBuilderData<{
+type ComponentOptions = BuilderDataProps & {
   [index: string]: any;
   attributes?: {
     [index: string]: any;
   };
-}>;
+};
 export interface ComponentProps {
   componentRef: any;
   componentOptions: ComponentOptions;

package/src/components/block/components/interactive-element.svelte

@@ -5,6 +5,7 @@
     context: Writable<BuilderContextInterface>;
     wrapperProps: Dictionary<any>;
     includeBlockProps: boolean;
+    children?: any;
   };
 </script>
 
@@ -13,17 +14,14 @@
   import { getBlockActions } from "../../../functions/get-block-actions.js";
   import { getBlockProperties } from "../../../functions/get-block-properties.js";
   import type { BuilderBlock } from "../../../types/builder-block.js";
-  import type {
-    Dictionary,
-    PropsWithChildren,
-  } from "../../../types/typescript.js";
+  import type { Dictionary } from "../../../types/typescript.js";
   import type { Writable } from "svelte/store";
 
-  export let Wrapper: PropsWithChildren<InteractiveElementProps>["Wrapper"];
-  export let wrapperProps: PropsWithChildren<InteractiveElementProps>["wrapperProps"];
-  export let includeBlockProps: PropsWithChildren<InteractiveElementProps>["includeBlockProps"];
-  export let block: PropsWithChildren<InteractiveElementProps>["block"];
-  export let context: PropsWithChildren<InteractiveElementProps>["context"];
+  export let Wrapper: InteractiveElementProps["Wrapper"];
+  export let wrapperProps: InteractiveElementProps["wrapperProps"];
+  export let includeBlockProps: InteractiveElementProps["includeBlockProps"];
+  export let block: InteractiveElementProps["block"];
+  export let context: InteractiveElementProps["context"];
 </script>
 
 <svelte:component

package/src/components/blocks/blocks-wrapper.svelte

@@ -12,20 +12,20 @@
      * Additonal props to pass to `blocksWrapper`. Defaults to `{}`.
      */
     BlocksWrapperProps: any;
+    children?: any;
   };
 </script>
 
 <script lang="ts">
   import { isEditing } from "../../functions/is-editing.js";
   import type { BuilderBlock } from "../../types/builder-block.js";
-  import type { PropsWithChildren } from "../../types/typescript.js";
 
-  export let BlocksWrapper: PropsWithChildren<BlocksWrapperProps>["BlocksWrapper"];
-  export let blocks: PropsWithChildren<BlocksWrapperProps>["blocks"];
-  export let parent: PropsWithChildren<BlocksWrapperProps>["parent"];
-  export let path: PropsWithChildren<BlocksWrapperProps>["path"];
-  export let styleProp: PropsWithChildren<BlocksWrapperProps>["styleProp"];
-  export let BlocksWrapperProps: PropsWithChildren<BlocksWrapperProps>["BlocksWrapperProps"];
+  export let BlocksWrapper: BlocksWrapperProps["BlocksWrapper"];
+  export let blocks: BlocksWrapperProps["blocks"];
+  export let parent: BlocksWrapperProps["parent"];
+  export let path: BlocksWrapperProps["path"];
+  export let styleProp: BlocksWrapperProps["styleProp"];
+  export let BlocksWrapperProps: BlocksWrapperProps["BlocksWrapperProps"];
 
   function mitosis_styling(node, vars) {
     Object.entries(vars || {}).forEach(([p, v]) => {

package/src/components/content/content.types.ts

@@ -1,11 +1,5 @@
 import type { BuilderRenderState } from '../../context/types.js';
-import type { EnforcePartials } from '../../types/enforced-partials.js';
-import type { ContentVariantsPrps } from '../content-variants/content-variants.types.js';
-interface InternalRenderProps {
-  showContent: boolean;
-  isSsrAbTest: boolean;
-}
-export type ContentProps = InternalRenderProps & EnforcePartials<ContentVariantsPrps>;
+export type { ContentProps } from './contentProps.types.js';
 export interface BuilderComponentStateChange {
   state: BuilderRenderState;
   ref: {

package/src/components/content/contentProps.types.ts

@@ -0,0 +1,12 @@
+import type { EnforcePartials } from '../../types/enforced-partials.js';
+import type { ContentVariantsPrps } from '../content-variants/content-variants.types.js';
+interface InternalRenderProps {
+  showContent: boolean;
+  isSsrAbTest: boolean;
+}
+
+/**
+ * This is in a separate file so that we can override it (most notably in Vue,
+ * where prop types cannot be wrapped by generics like `EnforcePartials`).
+ */
+export type ContentProps = InternalRenderProps & EnforcePartials<ContentVariantsPrps>