@builder.io/sdk-react-native 1.0.33 → 1.0.35

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

@@ -0,0 +1,129 @@
+import type { ComponentInfo } from '../../types/components';
+export const componentInfo: ComponentInfo = {
+  name: 'Image',
+  static: 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', 'webp'],
+    required: true,
+    defaultValue: 'https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2F72c80f114dc149019051b6852a9e3b7a',
+    onChange: (options: Map<string, any>): void | Promise<void> => {
+      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: 'highPriority',
+    type: 'boolean',
+    advanced: true,
+    helperText: 'Mark this image as high priority compared to other images on the page. This prevents lazy loading of the image and tells the browser to load this image before others on the page.'
+  }, {
+    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,47 @@
+// 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.tsx

@@ -0,0 +1,65 @@
+import * as React from 'react';
+import type { StyleProp,ImageStyle } from 'react-native';
+import { Image as ReactImage, View } from 'react-native';
+import type { ImageProps } from './image.types';
+
+export default function Image(props: ImageProps) {
+  const shouldRenderUnwrappedChildren =
+    props.fitContent && props.builderBlock?.children?.length;
+
+  const imageStyle:StyleProp<ImageStyle> = (props.aspectRatio
+    ? {
+        position: 'absolute',
+        top: 0,
+        bottom: 0,
+        left: 0,
+        right: 0,
+      }
+    : {
+        position: 'relative',
+        ...(props.width ? { width: props.width } : {}),
+        ...(props.height ? { height: props.height } : {}),
+      } ) ;
+
+  const paddingTop = `${props.aspectRatio * 100}%` as const;
+
+  return (
+    <>
+      <React.Fragment>
+        <ReactImage
+          resizeMode={props.backgroundSize || 'contain'}
+          style={imageStyle}
+          source={{ uri: props.image }}
+        />
+        {props.aspectRatio && !shouldRenderUnwrappedChildren ? (
+          <View
+            style={{
+              width: '100%',
+              paddingTop,
+            }}
+          />
+        ) : null}
+      </React.Fragment>
+
+      {shouldRenderUnwrappedChildren && props.children}
+
+      {!props.fitContent && props.children && (
+        // When `fitContent: false`, we wrap image children ssuch that they stretch across the entire image
+        <View
+          style={{
+            display: 'flex',
+            flexDirection: 'column',
+            alignItems: 'stretch',
+            position: 'absolute',
+            top: 0,
+            left: 0,
+            width: '100%',
+            height: '100%',
+          }}
+        >
+          {props.children}
+        </View>
+      )}
+    </>
+  );
+}

package/src/blocks/image/image.types.ts

@@ -0,0 +1,20 @@
+import type { BuilderBlock } from '../../types/builder-block';
+export interface ImageProps {
+  highPriority?: boolean;
+  className?: string;
+  image: string;
+  sizes?: string;
+  lazy?: boolean;
+  height?: number;
+  width?: number;
+  altText?: string;
+  backgroundSize?: 'cover' | 'contain';
+  backgroundPosition?: string;
+  srcset?: string;
+  aspectRatio?: number;
+  children?: any;
+  fitContent?: boolean;
+  builderBlock?: BuilderBlock;
+  noWebp?: boolean;
+  src?: string;
+}

package/src/blocks/image/index.ts

@@ -0,0 +1 @@
+export { default } from './image'

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

@@ -0,0 +1,16 @@
+import type { ComponentInfo } from '../../types/components';
+export const componentInfo: ComponentInfo = {
+  // friendlyName?
+  name: 'Raw:Img',
+  hideFromInsertMenu: 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', 'gif', 'webp'],
+    required: true
+  }],
+  noWrap: true,
+  static: true
+}

package/src/blocks/img/img.tsx

@@ -0,0 +1,55 @@
+import * as React from "react";
+import {
+  FlatList,
+  ScrollView,
+  View,
+  StyleSheet,
+  Image,
+  Text,
+  Pressable,
+  TextInput,
+} from "react-native";
+
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */
+
+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";
+}
+
+import { isEditing } from "../../functions/is-editing";
+import { filterAttrs } from "../helpers";
+import { setAttrs } from "../helpers";
+
+function ImgComponent(props: ImgProps) {
+  return (
+    <View
+      style={{
+        objectFit: props.backgroundSize || "cover",
+        objectPosition: props.backgroundPosition || "center",
+      }}
+      key={(isEditing() && props.imgSrc) || "default-key"}
+      alt={props.altText}
+      src={props.imgSrc || props.image}
+      {...{}}
+      {...props.attributes}
+    />
+  );
+}
+
+export default ImgComponent;

package/src/blocks/img/index.ts

@@ -0,0 +1 @@
+export { default } from './img'

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

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

package/src/blocks/raw-text/index.ts

@@ -0,0 +1 @@
+export { default } from './raw-text'

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

@@ -0,0 +1 @@
+export { default } from '../text/text';

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

@@ -0,0 +1,41 @@
+import type { ComponentInfo } from '../../types/components';
+export const componentInfo: ComponentInfo = {
+  name: 'Core:Section',
+  static: 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/index.ts

@@ -0,0 +1 @@
+export { default } from './section'

package/src/blocks/section/section.tsx

@@ -0,0 +1,39 @@
+import * as React from "react";
+import {
+  FlatList,
+  ScrollView,
+  View,
+  StyleSheet,
+  Image,
+  Text,
+  Pressable,
+  TextInput,
+} from "react-native";
+import { filterAttrs } from "../helpers";
+import type { SectionProps } from "./section.types";
+import { setAttrs } from "../helpers";
+
+function SectionComponent(props: SectionProps) {
+  return (
+    <View
+      {...{}}
+      {...props.attributes}
+      style={{
+        width: "100%",
+        alignSelf: "stretch",
+        flexGrow: 1,
+        boxSizing: "border-box",
+        maxWidth: props.maxWidth || 1200,
+        display: "flex",
+        flexDirection: "column",
+        alignItems: "stretch",
+        marginLeft: "auto",
+        marginRight: "auto",
+      }}
+    >
+      {props.children}
+    </View>
+  );
+}
+
+export default SectionComponent;

package/src/blocks/section/section.types.ts

@@ -0,0 +1,6 @@
+export interface SectionProps {
+  maxWidth?: number;
+  attributes?: any;
+  children?: any;
+  builderBlock?: any;
+}

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

@@ -0,0 +1,15 @@
+import type { ComponentInfo } from '../../types/components';
+export const componentInfo: ComponentInfo = {
+  name: 'Slot',
+  isRSC: true,
+  description: 'Allow child blocks to be inserted into this content when used as a Symbol',
+  docsLink: 'https://www.builder.io/c/docs/symbols-with-blocks',
+  image: 'https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2F3aad6de36eae43b59b52c85190fdef56',
+  // Maybe wrap this for canHaveChildren so bind children to this hm
+  inputs: [{
+    name: 'name',
+    type: 'string',
+    required: true,
+    defaultValue: 'children'
+  }]
+}

package/src/blocks/slot/index.ts

@@ -0,0 +1 @@
+export { default } from './slot'

package/src/blocks/slot/slot.tsx

@@ -0,0 +1,42 @@
+import * as React from "react";
+import {
+  FlatList,
+  ScrollView,
+  View,
+  StyleSheet,
+  Image,
+  Text,
+  Pressable,
+  TextInput,
+} from "react-native";
+
+export type DropzoneProps = BuilderDataProps & {
+  name: string;
+  attributes: any;
+};
+import Blocks from "../../components/blocks/blocks";
+import { deoptSignal } from "../../functions/deopt";
+import type { BuilderBlock } from "../../types/builder-block";
+import type { BuilderDataProps } from "../../types/builder-props";
+
+function Slot(props: DropzoneProps) {
+  return (
+    <View
+      style={{
+        pointerEvents: "auto",
+      }}
+      {...(!props.builderContext.context?.symbolId && {
+        "builder-slot": props.name,
+      })}
+    >
+      <Blocks
+        parent={props.builderContext.context?.symbolId as string}
+        path={`symbol.data.${props.name}`}
+        context={props.builderContext}
+        blocks={props.builderContext.rootState?.[props.name] as BuilderBlock[]}
+      />
+    </View>
+  );
+}
+
+export default Slot;

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

@@ -0,0 +1,35 @@
+import type { ComponentInfo } from '../../types/components';
+export const componentInfo: ComponentInfo = {
+  name: 'Symbol',
+  noWrap: true,
+  static: true,
+  isRSC: true,
+  inputs: [{
+    name: 'symbol',
+    type: 'uiSymbol'
+  }, {
+    name: 'dataOnly',
+    helperText: "Make this a data symbol that doesn't display any UI",
+    type: 'boolean',
+    defaultValue: false,
+    advanced: true,
+    hideFromUI: true
+  }, {
+    name: 'inheritState',
+    helperText: 'Inherit the parent component state and data',
+    type: 'boolean',
+    defaultValue: false,
+    advanced: true
+  }, {
+    name: 'renderToLiquid',
+    helperText: 'Render this symbols contents to liquid. Turn off to fetch with javascript and use custom targeting',
+    type: 'boolean',
+    defaultValue: false,
+    advanced: true,
+    hideFromUI: true
+  }, {
+    name: 'useChildren',
+    hideFromUI: true,
+    type: 'boolean'
+  }]
+}

package/src/blocks/symbol/index.ts

@@ -0,0 +1 @@
+export { default } from './symbol'

package/src/blocks/symbol/symbol.helpers.ts

@@ -0,0 +1,47 @@
+import type { BuilderContextInterface } from '../../context/types';
+import { fetchOneEntry } from '../../functions/get-content/index';
+import { logger } from '../../helpers/logger';
+import type { BuilderContent } from '../../types/builder-content';
+export interface SymbolInfo {
+  model?: string;
+  entry?: string;
+  data?: any;
+  content?: BuilderContent;
+  inline?: boolean;
+  dynamic?: boolean;
+}
+export const fetchSymbolContent = async ({
+  builderContextValue,
+  symbol
+}: {
+  symbol: SymbolInfo | undefined;
+  builderContextValue: BuilderContextInterface;
+}) => {
+  /**
+   * If:
+   * - we have a symbol prop
+   * - yet it does not have any content
+   * - and we have not already stored content from before
+   * - and it has a model name
+   *
+   * then we want to re-fetch the symbol content.
+   */
+  if (symbol?.model &&
+  // This is a hack, we should not need to check for this, but it is needed for Svelte.
+  builderContextValue?.apiKey) {
+    return fetchOneEntry({
+      model: symbol.model,
+      apiKey: builderContextValue.apiKey,
+      apiVersion: builderContextValue.apiVersion,
+      ...(symbol?.entry && {
+        query: {
+          id: symbol.entry
+        }
+      })
+    }).catch(err => {
+      logger.error('Could not fetch symbol content: ', err);
+      return undefined;
+    });
+  }
+  return undefined;
+}