@builder.io/sdk-svelte 0.0.4 → 0.0.5

package/src/blocks/image/component-info.ts

@@ -0,0 +1,170 @@
+import type { ComponentInfo } from '../../types/components';
+import { markSerializable } from '../util.js';
+
+export const componentInfo: ComponentInfo = {
+  name: 'Image',
+  static: true,
+  builtIn: true,
+  image:
+    'https://firebasestorage.googleapis.com/v0/b/builder-3b0a2.appspot.com/o/images%2Fbaseline-insert_photo-24px.svg?alt=media&token=4e5d0ef4-f5e8-4e57-b3a9-38d63a9b9dc4',
+  defaultStyles: {
+    position: 'relative',
+    minHeight: '20px',
+    minWidth: '20px',
+    overflow: 'hidden',
+  },
+  canHaveChildren: true,
+  inputs: [
+    {
+      name: 'image',
+      type: 'file',
+      bubble: true,
+      allowedFileTypes: ['jpeg', 'jpg', 'png', 'svg'],
+      required: true,
+      defaultValue:
+        'https://cdn.builder.io/api/v1/image/assets%2Fpwgjf0RoYWbdnJSbpBAjXNRMe9F2%2Ffb27a7c790324294af8be1c35fe30f4d',
+      onChange: markSerializable((options: Map<string, any>) => {
+        const DEFAULT_ASPECT_RATIO = 0.7041;
+        options.delete('srcset');
+        options.delete('noWebp');
+        function loadImage(
+          url: string,
+          timeout = 60000
+        ): Promise<HTMLImageElement> {
+          return new Promise((resolve, reject) => {
+            const img = document.createElement('img');
+            let loaded = false;
+            img.onload = () => {
+              loaded = true;
+              resolve(img);
+            };
+
+            img.addEventListener('error', (event) => {
+              console.warn('Image load failed', event.error);
+              reject(event.error);
+            });
+
+            img.src = url;
+            setTimeout(() => {
+              if (!loaded) {
+                reject(new Error('Image load timed out'));
+              }
+            }, timeout);
+          });
+        }
+
+        function round(num: number) {
+          return Math.round(num * 1000) / 1000;
+        }
+
+        const value = options.get('image');
+        const aspectRatio = options.get('aspectRatio');
+
+        // For SVG images - don't render as webp, keep them as SVG
+        fetch(value)
+          .then((res) => res.blob())
+          .then((blob) => {
+            if (blob.type.includes('svg')) {
+              options.set('noWebp', true);
+            }
+          });
+
+        if (value && (!aspectRatio || aspectRatio === DEFAULT_ASPECT_RATIO)) {
+          return loadImage(value).then((img) => {
+            const possiblyUpdatedAspectRatio = options.get('aspectRatio');
+            if (
+              options.get('image') === value &&
+              (!possiblyUpdatedAspectRatio ||
+                possiblyUpdatedAspectRatio === DEFAULT_ASPECT_RATIO)
+            ) {
+              if (img.width && img.height) {
+                options.set('aspectRatio', round(img.height / img.width));
+                options.set('height', img.height);
+                options.set('width', img.width);
+              }
+            }
+          });
+        }
+      }),
+    },
+    {
+      name: 'backgroundSize',
+      type: 'text',
+      defaultValue: 'cover',
+      enum: [
+        {
+          label: 'contain',
+          value: 'contain',
+          helperText: 'The image should never get cropped',
+        },
+        {
+          label: 'cover',
+          value: 'cover',
+          helperText: "The image should fill it's box, cropping when needed",
+        },
+      ],
+    },
+    {
+      name: 'backgroundPosition',
+      type: 'text',
+      defaultValue: 'center',
+      enum: [
+        'center',
+        'top',
+        'left',
+        'right',
+        'bottom',
+        'top left',
+        'top right',
+        'bottom left',
+        'bottom right',
+      ],
+    },
+    {
+      name: 'altText',
+      type: 'string',
+      helperText: 'Text to display when the user has images off',
+    },
+    {
+      name: 'height',
+      type: 'number',
+      hideFromUI: true,
+    },
+    {
+      name: 'width',
+      type: 'number',
+      hideFromUI: true,
+    },
+    {
+      name: 'sizes',
+      type: 'string',
+      hideFromUI: true,
+    },
+    {
+      name: 'srcset',
+      type: 'string',
+      hideFromUI: true,
+    },
+    {
+      name: 'lazy',
+      type: 'boolean',
+      defaultValue: true,
+      hideFromUI: true,
+    },
+    {
+      name: 'fitContent',
+      type: 'boolean',
+      helperText:
+        "When child blocks are provided, fit to them instead of using the image's aspect ratio",
+      defaultValue: true,
+    },
+    {
+      name: 'aspectRatio',
+      type: 'number',
+      helperText:
+        "This is the ratio of height/width, e.g. set to 1.5 for a 300px wide and 200px tall photo. Set to 0 to not force the image to maintain it's aspect ratio",
+      advanced: true,
+      defaultValue: 0.7041,
+    },
+  ],
+};

package/src/blocks/image/image.helpers.ts

@@ -0,0 +1,75 @@
+// Taken from (and modified) the shopify theme script repo
+// https://github.com/Shopify/theme-scripts/blob/bcfb471f2a57d439e2f964a1bb65b67708cc90c3/packages/theme-images/images.js#L59
+function removeProtocol(path: string) {
+  return path.replace(/http(s)?:/, '');
+}
+
+function updateQueryParam(
+  uri = '',
+  key: string,
+  value: string | number | boolean
+): string {
+  const re = new RegExp('([?&])' + key + '=.*?(&|$)', 'i');
+  const separator = uri.indexOf('?') !== -1 ? '&' : '?';
+  if (uri.match(re)) {
+    return uri.replace(re, '$1' + key + '=' + encodeURIComponent(value) + '$2');
+  }
+
+  return uri + separator + key + '=' + encodeURIComponent(value);
+}
+function getShopifyImageUrl(src: string, size: string): string | null {
+  if (!src || !src?.match(/cdn\.shopify\.com/) || !size) {
+    return src;
+  }
+
+  if (size === 'master') {
+    return removeProtocol(src);
+  }
+
+  const match = src.match(
+    /(_\d+x(\d+)?)?(\.(jpg|jpeg|gif|png|bmp|bitmap|tiff|tif)(\?v=\d+)?)/i
+  );
+
+  if (match) {
+    const prefix = src.split(match[0]);
+    const suffix = match[3];
+    const useSize = size.match('x') ? size : `${size}x`;
+
+    return removeProtocol(`${prefix[0]}_${useSize}${suffix}`);
+  }
+
+  return null;
+}
+
+export function getSrcSet(url: string): string {
+  if (!url) {
+    return url;
+  }
+
+  const sizes = [100, 200, 400, 800, 1200, 1600, 2000];
+
+  if (url.match(/builder\.io/)) {
+    let srcUrl = url;
+    const widthInSrc = Number(url.split('?width=')[1]);
+    if (!isNaN(widthInSrc)) {
+      srcUrl = `${srcUrl} ${widthInSrc}w`;
+    }
+
+    return sizes
+      .filter((size) => size !== widthInSrc)
+      .map((size) => `${updateQueryParam(url, 'width', size)} ${size}w`)
+      .concat([srcUrl])
+      .join(', ');
+  }
+
+  if (url.match(/cdn\.shopify\.com/)) {
+    return sizes
+      .map((size) => [getShopifyImageUrl(url, `${size}x${size}`), size])
+      .filter(([sizeUrl]) => !!sizeUrl)
+      .map(([sizeUrl, size]) => `${sizeUrl} ${size}w`)
+      .concat([url])
+      .join(', ');
+  }
+
+  return url;
+}

package/src/blocks/image/image.svelte

@@ -0,0 +1,145 @@
+<script context="module" lang="ts">
+  import type { BuilderBlock } from "../../types/builder-block.js";
+
+  export interface ImageProps {
+    className?: string;
+    image: string;
+    sizes?: string;
+    lazy?: boolean;
+    height?: number;
+    width?: number;
+    altText?: string;
+    backgroundSize?: string;
+    backgroundPosition?: string;
+    srcset?: string;
+    aspectRatio?: number;
+    children?: JSX.Element;
+    fitContent?: boolean;
+    builderBlock?: BuilderBlock;
+    noWebp?: boolean;
+    src?: string;
+  }
+</script>
+
+<script lang="ts">
+  import { getSrcSet } from "./image.helpers.js";
+
+  export let image: ImageProps["image"];
+  export let src: ImageProps["src"];
+  export let srcset: ImageProps["srcset"];
+  export let noWebp: ImageProps["noWebp"];
+  export let altText: ImageProps["altText"];
+  export let backgroundSize: ImageProps["backgroundSize"];
+  export let className: ImageProps["className"];
+  export let sizes: ImageProps["sizes"];
+  export let aspectRatio: ImageProps["aspectRatio"];
+  export let builderBlock: ImageProps["builderBlock"];
+  export let fitContent: ImageProps["fitContent"];
+
+  function mitosis_styling(node, vars) {
+    Object.entries(vars || {}).forEach(([p, v]) => {
+      if (p.startsWith("--")) {
+        node.style.setProperty(p, v);
+      } else {
+        node.style[p] = v;
+      }
+    });
+  }
+
+  $: srcSetToUse = () => {
+    const imageToUse = image || src;
+    const url = imageToUse;
+    if (
+      !url ||
+      // We can auto add srcset for cdn.builder.io and shopify
+      // images, otherwise you can supply this prop manually
+      !(url.match(/builder\.io/) || url.match(/cdn\.shopify\.com/))
+    ) {
+      return srcset;
+    }
+    if (srcset && image?.includes("builder.io/api/v1/image")) {
+      if (!srcset.includes(image.split("?")[0])) {
+        console.debug("Removed given srcset");
+        return getSrcSet(url);
+      }
+    } else if (image && !srcset) {
+      return getSrcSet(url);
+    }
+    return getSrcSet(url);
+  };
+  $: webpSrcSet = () => {
+    if (srcSetToUse?.()?.match(/builder\.io/) && !noWebp) {
+      return srcSetToUse().replace(/\?/g, "?format=webp&");
+    } else {
+      return "";
+    }
+  };
+</script>
+
+<picture>
+  {#if webpSrcSet()}
+    <source type="image/webp" srcset={webpSrcSet()} />
+  {/if}
+  <img
+    use:mitosis_styling={{
+      objectPosition: backgroundSize || "center",
+      objectFit: backgroundSize || "cover",
+    }}
+    loading="lazy"
+    alt={altText}
+    role={altText ? "presentation" : undefined}
+    class={"builder-image" + (className ? " " + className : "") + " img"}
+    src={image}
+    srcset={srcSetToUse()}
+    {sizes}
+  />
+  <source srcset={srcSetToUse()} />
+</picture>
+
+{#if aspectRatio && !(builderBlock?.children?.length && fitContent)}
+  <div
+    use:mitosis_styling={{
+      paddingTop:
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        aspectRatio * 100 + "%",
+    }}
+    class="builder-image-sizer div"
+  />
+{/if}
+
+{#if builderBlock?.children?.length && fitContent}
+  <slot />
+{/if}
+
+{#if !fitContent && $$slots.default}
+  <div class="div-2">
+    <slot />
+  </div>
+{/if}
+
+<style>
+  .img {
+    opacity: 1;
+    transition: opacity 0.2s ease-in-out;
+    position: absolute;
+    height: 100%;
+    width: 100%;
+    top: 0px;
+    left: 0px;
+  }
+  .div {
+    width: 100%;
+    pointer-events: none;
+    font-size: 0;
+  }
+  .div-2 {
+    display: flex;
+    flex-direction: column;
+    align-items: stretch;
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+  }
+</style>

package/src/blocks/img/component-info.ts

@@ -0,0 +1,21 @@
+import type { ComponentInfo } from '../../types/components';
+
+export const componentInfo: ComponentInfo = {
+  // friendlyName?
+  name: 'Raw:Img',
+  hideFromInsertMenu: true,
+  builtIn: true,
+  image:
+    'https://firebasestorage.googleapis.com/v0/b/builder-3b0a2.appspot.com/o/images%2Fbaseline-insert_photo-24px.svg?alt=media&token=4e5d0ef4-f5e8-4e57-b3a9-38d63a9b9dc4',
+  inputs: [
+    {
+      name: 'image',
+      bubble: true,
+      type: 'file',
+      allowedFileTypes: ['jpeg', 'jpg', 'png', 'svg'],
+      required: true,
+    },
+  ],
+  noWrap: true,
+  static: true,
+};

package/src/blocks/img/img.svelte

@@ -0,0 +1,51 @@
+<script context="module" lang="ts">
+  export interface ImgProps {
+    attributes?: any;
+    imgSrc?: string; // TODO(misko): I think this is unused
+    image?: string;
+    altText?: string;
+    backgroundSize?: "cover" | "contain";
+    backgroundPosition?:
+      | "center"
+      | "top"
+      | "left"
+      | "right"
+      | "bottom"
+      | "top left"
+      | "top right"
+      | "bottom left"
+      | "bottom right";
+  }
+</script>
+
+<script lang="ts">
+  import { isEditing } from "../../functions/is-editing.js";
+
+  export let backgroundSize: ImgProps["backgroundSize"];
+  export let backgroundPosition: ImgProps["backgroundPosition"];
+  export let imgSrc: ImgProps["imgSrc"];
+  export let altText: ImgProps["altText"];
+  export let image: ImgProps["image"];
+  export let attributes: ImgProps["attributes"];
+
+  function mitosis_styling(node, vars) {
+    Object.entries(vars || {}).forEach(([p, v]) => {
+      if (p.startsWith("--")) {
+        node.style.setProperty(p, v);
+      } else {
+        node.style[p] = v;
+      }
+    });
+  }
+</script>
+
+<img
+  {...attributes}
+  use:mitosis_styling={{
+    objectFit: backgroundSize || "cover",
+    objectPosition: backgroundPosition || "center",
+  }}
+  key={(isEditing() && imgSrc) || "default-key"}
+  alt={altText}
+  src={imgSrc || image}
+/>

package/src/blocks/input/component-info.ts

@@ -0,0 +1,78 @@
+import type { ComponentInfo } from '../../types/components';
+
+export const componentInfo: ComponentInfo = {
+  name: 'Form:Input',
+  builtIn: true,
+  image:
+    'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2Fad6f37889d9e40bbbbc72cdb5875d6ca',
+  inputs: [
+    {
+      name: 'type',
+      type: 'text',
+      enum: [
+        'text',
+        'number',
+        'email',
+        'url',
+        'checkbox',
+        'radio',
+        'range',
+        'date',
+        'datetime-local',
+        'search',
+        'tel',
+        'time',
+        'file',
+        'month',
+        'week',
+        'password',
+        'color',
+        'hidden',
+      ],
+      defaultValue: 'text',
+    },
+    {
+      name: 'name',
+      type: 'string',
+      required: true,
+      helperText:
+        'Every input in a form needs a unique name describing what it takes, e.g. "email"',
+    },
+    {
+      name: 'placeholder',
+      type: 'string',
+      defaultValue: 'Hello there',
+      helperText: 'Text to display when there is no value',
+    },
+    // TODO: handle value vs default value automatically like ng-model
+    {
+      name: 'defaultValue',
+      type: 'string',
+    },
+    {
+      name: 'value',
+      type: 'string',
+      advanced: true,
+    },
+
+    {
+      name: 'required',
+      type: 'boolean',
+      helperText: 'Is this input required to be filled out to submit a form',
+      defaultValue: false,
+    },
+  ],
+
+  noWrap: true,
+  static: true,
+  defaultStyles: {
+    paddingTop: '10px',
+    paddingBottom: '10px',
+    paddingLeft: '10px',
+    paddingRight: '10px',
+    borderRadius: '3px',
+    borderWidth: '1px',
+    borderStyle: 'solid',
+    borderColor: '#ccc',
+  },
+};

package/src/blocks/input/input.svelte

@@ -0,0 +1,34 @@
+<script context="module" lang="ts">
+  export interface FormInputProps {
+    type?: string;
+    attributes?: any;
+    name?: string;
+    value?: string;
+    placeholder?: string;
+    defaultValue?: string;
+    required?: boolean;
+  }
+</script>
+
+<script lang="ts">
+  import { isEditing } from "../../functions/is-editing.js";
+
+  export let attributes: FormInputProps["attributes"];
+  export let defaultValue: FormInputProps["defaultValue"];
+  export let placeholder: FormInputProps["placeholder"];
+  export let type: FormInputProps["type"];
+  export let name: FormInputProps["name"];
+  export let value: FormInputProps["value"];
+  export let required: FormInputProps["required"];
+</script>
+
+<input
+  {...attributes}
+  key={isEditing() && defaultValue ? defaultValue : "default-key"}
+  {placeholder}
+  {type}
+  {name}
+  {value}
+  {defaultValue}
+  {required}
+/>

package/src/blocks/raw-text/component-info.ts

@@ -0,0 +1,15 @@
+import type { ComponentInfo } from '../../types/components';
+
+export const componentInfo: ComponentInfo = {
+  name: 'Builder:RawText',
+  hideFromInsertMenu: true,
+  builtIn: true,
+  inputs: [
+    {
+      name: 'text',
+      bubble: true,
+      type: 'longText',
+      required: true,
+    },
+  ],
+};

package/src/blocks/raw-text/raw-text.svelte

@@ -0,0 +1,16 @@
+<script context="module" lang="ts">
+  export interface RawTextProps {
+    attributes?: any;
+    text?: string;
+    // builderBlock?: any;
+  }
+</script>
+
+<script lang="ts">
+  export let attributes: RawTextProps["attributes"];
+  export let text: RawTextProps["text"];
+</script>
+
+<span class={attributes?.class || attributes?.className}
+  >{@html text || ""}</span
+>

package/src/blocks/section/component-info.ts

@@ -0,0 +1,50 @@
+import type { ComponentInfo } from '../../types/components';
+
+export const componentInfo: ComponentInfo = {
+  name: 'Core:Section',
+  static: true,
+  builtIn: true,
+  image:
+    'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2F682efef23ace49afac61748dd305c70a',
+  inputs: [
+    {
+      name: 'maxWidth',
+      type: 'number',
+      defaultValue: 1200,
+    },
+    {
+      name: 'lazyLoad',
+      type: 'boolean',
+      defaultValue: false,
+      advanced: true,
+      description: 'Only render this section when in view',
+    },
+  ],
+  defaultStyles: {
+    paddingLeft: '20px',
+    paddingRight: '20px',
+    paddingTop: '50px',
+    paddingBottom: '50px',
+    marginTop: '0px',
+    width: '100vw',
+    marginLeft: 'calc(50% - 50vw)',
+  },
+  canHaveChildren: true,
+
+  defaultChildren: [
+    {
+      '@type': '@builder.io/sdk:Element',
+      responsiveStyles: {
+        large: {
+          textAlign: 'center',
+        },
+      },
+      component: {
+        name: 'Text',
+        options: {
+          text: "<p><b>I am a section! My content keeps from getting too wide, so that it's easy to read even on big screens.</b></p><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur</p>",
+        },
+      },
+    },
+  ],
+};

package/src/blocks/section/section.svelte

@@ -0,0 +1,34 @@
+<script context="module" lang="ts">
+  export interface SectionProps {
+    maxWidth?: number;
+    attributes?: any;
+    children?: any;
+    builderBlock?: any;
+  }
+</script>
+
+<script lang="ts">
+  export let attributes: SectionProps["attributes"];
+  export let maxWidth: SectionProps["maxWidth"];
+
+  function mitosis_styling(node, vars) {
+    Object.entries(vars || {}).forEach(([p, v]) => {
+      if (p.startsWith("--")) {
+        node.style.setProperty(p, v);
+      } else {
+        node.style[p] = v;
+      }
+    });
+  }
+</script>
+
+<section
+  {...attributes}
+  use:mitosis_styling={maxWidth && typeof maxWidth === "number"
+    ? {
+        maxWidth: maxWidth,
+      }
+    : undefined}
+>
+  <slot />
+</section>