@builder.io/sdk-react 0.2.3-3 → 0.2.3

package/dist/sdk/blocks/image/image.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="react" />
+export interface ImageProps {
+    className?: string;
+    image: string;
+    sizes?: string;
+    lazy?: boolean;
+    height?: number;
+    width?: number;
+    altText?: string;
+    backgroundSize?: "cover" | "contain";
+    backgroundPosition?: string;
+    srcset?: string;
+    aspectRatio?: number;
+    children?: JSX.Element;
+    fitContent?: boolean;
+    builderBlock?: BuilderBlock;
+    noWebp?: boolean;
+    src?: string;
+}
+import type { BuilderBlock } from "../../types/builder-block.js";
+declare function Image(props: ImageProps): JSX.Element;
+export default Image;

package/dist/sdk/blocks/image/image.helpers.d.ts

@@ -0,0 +1 @@
+export declare function getSrcSet(url: string): string;

package/dist/sdk/blocks/image/image.helpers.js

@@ -0,0 +1,56 @@
+// 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) {
+    return path.replace(/http(s)?:/, '');
+}
+function updateQueryParam(uri = '', key, value) {
+    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, size) {
+    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) {
+    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/dist/sdk/blocks/image/image.js

@@ -0,0 +1,82 @@
+"use client";
+import * as React from "react";
+import { getSrcSet } from "./image.helpers.js";
+function Image(props) {
+    function srcSetToUse() {
+        const imageToUse = props.image || props.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 props.srcset;
+        }
+        if (props.srcset && props.image?.includes("builder.io/api/v1/image")) {
+            if (!props.srcset.includes(props.image.split("?")[0])) {
+                console.debug("Removed given srcset");
+                return getSrcSet(url);
+            }
+        }
+        else if (props.image && !props.srcset) {
+            return getSrcSet(url);
+        }
+        return getSrcSet(url);
+    }
+    function webpSrcSet() {
+        if (srcSetToUse?.()?.match(/builder\.io/) && !props.noWebp) {
+            return srcSetToUse().replace(/\?/g, "?format=webp&");
+        }
+        else {
+            return "";
+        }
+    }
+    function aspectRatioCss() {
+        const aspectRatioStyles = {
+            position: "absolute",
+            height: "100%",
+            width: "100%",
+            left: "0px",
+            top: "0px",
+        };
+        const out = props.aspectRatio ? aspectRatioStyles : undefined;
+        return out;
+    }
+    return (React.createElement(React.Fragment, null,
+        React.createElement(React.Fragment, null,
+            React.createElement("picture", null,
+                webpSrcSet() ? (React.createElement(React.Fragment, null,
+                    React.createElement("source", { type: "image/webp", srcSet: webpSrcSet() }))) : null,
+                React.createElement("img", { loading: "lazy", alt: props.altText, role: props.altText ? "presentation" : undefined, style: {
+                        objectPosition: props.backgroundPosition || "center",
+                        objectFit: props.backgroundSize || "cover",
+                        ...aspectRatioCss(),
+                    }, className: "builder-image" +
+                        (props.className ? " " + props.className : "") +
+                        " img-3c135cd4", src: props.image, srcSet: srcSetToUse(), sizes: props.sizes })),
+            props.aspectRatio &&
+                !(props.builderBlock?.children?.length && props.fitContent) ? (React.createElement(React.Fragment, null,
+                React.createElement("div", { className: "builder-image-sizer div-3c135cd4", style: {
+                        paddingTop: props.aspectRatio * 100 + "%",
+                    } }))) : null,
+            props.builderBlock?.children?.length && props.fitContent ? (React.createElement(React.Fragment, null, props.children)) : null,
+            !props.fitContent && props.children ? (React.createElement(React.Fragment, null,
+                React.createElement("div", { className: "div-3c135cd4-2" }, props.children))) : null),
+        React.createElement("style", null, `.img-3c135cd4 {
+  opacity: 1;
+  transition: opacity 0.2s ease-in-out;
+}.div-3c135cd4 {
+  width: 100%;
+  pointer-events: none;
+  font-size: 0;
+}.div-3c135cd4-2 {
+  display: flex;
+  flex-direction: column;
+  align-items: stretch;
+  position: absolute;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+}`)));
+}
+export default Image;

package/dist/sdk/blocks/img/component-info.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components';
+export declare const componentInfo: ComponentInfo;

package/dist/sdk/blocks/img/component-info.js

@@ -0,0 +1,17 @@
+export const 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'],
+            required: true,
+        },
+    ],
+    noWrap: true,
+    static: true,
+};

package/dist/sdk/blocks/img/img.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+export interface ImgProps {
+    attributes?: any;
+    imgSrc?: string;
+    image?: string;
+    altText?: string;
+    backgroundSize?: "cover" | "contain";
+    backgroundPosition?: "center" | "top" | "left" | "right" | "bottom" | "top left" | "top right" | "bottom left" | "bottom right";
+}
+declare function ImgComponent(props: ImgProps): JSX.Element;
+export default ImgComponent;

package/dist/sdk/blocks/input/component-info.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components';
+export declare const componentInfo: ComponentInfo;

package/dist/sdk/blocks/input/component-info.js

@@ -0,0 +1,71 @@
+export const componentInfo = {
+    name: 'Form:Input',
+    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/dist/sdk/blocks/input/input.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+export interface FormInputProps {
+    type?: string;
+    attributes?: any;
+    name?: string;
+    value?: string;
+    placeholder?: string;
+    defaultValue?: string;
+    required?: boolean;
+}
+declare function FormInputComponent(props: FormInputProps): JSX.Element;
+export default FormInputComponent;

package/dist/sdk/blocks/raw-text/component-info.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components';
+export declare const componentInfo: ComponentInfo;

package/dist/sdk/blocks/raw-text/component-info.js

@@ -0,0 +1,12 @@
+export const componentInfo = {
+    name: 'Builder:RawText',
+    hideFromInsertMenu: true,
+    inputs: [
+        {
+            name: 'text',
+            bubble: true,
+            type: 'longText',
+            required: true,
+        },
+    ],
+};

package/dist/sdk/blocks/raw-text/raw-text.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export interface RawTextProps {
+    attributes?: any;
+    text?: string;
+}
+declare function RawText(props: RawTextProps): JSX.Element;
+export default RawText;

package/dist/sdk/blocks/section/component-info.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components';
+export declare const componentInfo: ComponentInfo;

package/dist/sdk/blocks/section/component-info.js

@@ -0,0 +1,45 @@
+export const 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/dist/sdk/blocks/section/section.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+export interface SectionProps {
+    maxWidth?: number;
+    attributes?: any;
+    children?: any;
+    builderBlock?: any;
+}
+declare function SectionComponent(props: SectionProps): JSX.Element;
+export default SectionComponent;

package/dist/sdk/blocks/select/component-info.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components';
+export declare const componentInfo: ComponentInfo;

package/dist/sdk/blocks/select/component-info.js

@@ -0,0 +1,55 @@
+export const componentInfo = {
+    name: 'Form:Select',
+    image: 'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2F83acca093fb24aaf94dee136e9a4b045',
+    defaultStyles: {
+        alignSelf: 'flex-start',
+    },
+    inputs: [
+        {
+            name: 'options',
+            type: 'list',
+            required: true,
+            subFields: [
+                {
+                    name: 'value',
+                    type: 'text',
+                    required: true,
+                },
+                {
+                    name: 'name',
+                    type: 'text',
+                },
+            ],
+            defaultValue: [
+                {
+                    value: 'option 1',
+                },
+                {
+                    value: 'option 2',
+                },
+            ],
+        },
+        {
+            name: 'name',
+            type: 'string',
+            required: true,
+            helperText: 'Every select in a form needs a unique name describing what it gets, e.g. "email"',
+        },
+        {
+            name: 'defaultValue',
+            type: 'string',
+        },
+        {
+            name: 'value',
+            type: 'string',
+            advanced: true,
+        },
+        {
+            name: 'required',
+            type: 'boolean',
+            defaultValue: false,
+        },
+    ],
+    static: true,
+    noWrap: true,
+};

package/dist/sdk/blocks/select/select.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+export interface FormSelectProps {
+    options?: {
+        name?: string;
+        value: string;
+    }[];
+    attributes?: any;
+    name?: string;
+    value?: string;
+    defaultValue?: string;
+}
+declare function SelectComponent(props: FormSelectProps): JSX.Element;
+export default SelectComponent;

package/dist/sdk/blocks/submit-button/component-info.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components';
+export declare const componentInfo: ComponentInfo;

package/dist/sdk/blocks/submit-button/component-info.js

@@ -0,0 +1,28 @@
+export const componentInfo = {
+    name: 'Form:SubmitButton',
+    image: 'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2Fdf2820ffed1f4349a94c40b3221f5b98',
+    defaultStyles: {
+        appearance: 'none',
+        paddingTop: '15px',
+        paddingBottom: '15px',
+        paddingLeft: '25px',
+        paddingRight: '25px',
+        backgroundColor: '#3898EC',
+        color: 'white',
+        borderRadius: '4px',
+        cursor: 'pointer',
+    },
+    inputs: [
+        {
+            name: 'text',
+            type: 'text',
+            defaultValue: 'Click me',
+        },
+    ],
+    static: true,
+    noWrap: true,
+    // TODO: optional children? maybe as optional form input
+    // that only shows if advanced setting is flipped
+    // TODO: defaultChildren
+    // canHaveChildren: true,
+};

package/dist/sdk/blocks/submit-button/submit-button.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export interface ButtonProps {
+    attributes?: any;
+    text?: string;
+}
+declare function SubmitButton(props: ButtonProps): JSX.Element;
+export default SubmitButton;

package/dist/sdk/blocks/symbol/component-info.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components';
+export declare const componentInfo: ComponentInfo;

package/dist/sdk/blocks/symbol/component-info.js

@@ -0,0 +1,39 @@
+export const componentInfo = {
+    name: 'Symbol',
+    noWrap: true,
+    static: 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/dist/sdk/blocks/symbol/symbol.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="react" />
+export interface SymbolInfo {
+    model?: string;
+    entry?: string;
+    data?: any;
+    content?: BuilderContent;
+    inline?: boolean;
+    dynamic?: boolean;
+}
+export interface SymbolProps {
+    symbol?: SymbolInfo;
+    dataOnly?: boolean;
+    dynamic?: boolean;
+    builderBlock?: BuilderBlock;
+    attributes?: any;
+    inheritState?: boolean;
+}
+import type { BuilderContent } from "../../types/builder-content.js";
+import type { BuilderBlock } from "../../types/builder-block.js";
+declare function Symbol(props: SymbolProps): JSX.Element;
+export default Symbol;

package/dist/sdk/blocks/symbol/symbol.js

@@ -0,0 +1,69 @@
+"use client";
+import * as React from "react";
+import { useState, useContext, useEffect } from "react";
+import RenderContent from "../../components/render-content/render-content";
+import BuilderContext from "../../context/builder.context.js";
+import { getContent } from "../../functions/get-content/index.js";
+import { TARGET } from "../../constants/target";
+import { logger } from "../../helpers/logger";
+function Symbol(props) {
+    const [className, setClassName] = useState(() => [
+        ...(TARGET === "vue2" || TARGET === "vue3"
+            ? Object.keys(props.attributes.class)
+            : [props.attributes.class]),
+        "builder-symbol",
+        props.symbol?.inline ? "builder-inline-symbol" : undefined,
+        props.symbol?.dynamic || props.dynamic
+            ? "builder-dynamic-symbol"
+            : undefined,
+    ]
+        .filter(Boolean)
+        .join(" "));
+    const [contentToUse, setContentToUse] = useState(() => props.symbol?.content);
+    function fetchContent() {
+        /**
+         * 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 (!contentToUse &&
+            props.symbol?.model &&
+            // This is a hack, we should not need to check for this, but it is needed for Svelte.
+            builderContext?.apiKey) {
+            getContent({
+                model: props.symbol.model,
+                apiKey: builderContext.apiKey,
+                apiVersion: builderContext.apiVersion,
+                query: {
+                    id: props.symbol.entry,
+                },
+            })
+                .then((response) => {
+                if (response) {
+                    setContentToUse(response);
+                }
+            })
+                .catch((err) => {
+                logger.error("Could not fetch symbol content: ", err);
+            });
+        }
+    }
+    const builderContext = useContext(BuilderContext);
+    useEffect(() => {
+        fetchContent();
+    }, []);
+    useEffect(() => {
+        fetchContent();
+    }, [props.symbol]);
+    return (React.createElement("div", { ...props.attributes, className: className },
+        React.createElement(RenderContent, { apiVersion: builderContext.apiVersion, apiKey: builderContext.apiKey, context: builderContext.context, customComponents: Object.values(builderContext.registeredComponents), data: {
+                ...props.symbol?.data,
+                ...builderContext.state,
+                ...contentToUse?.data?.state,
+            }, model: props.symbol?.model, content: contentToUse })));
+}
+export default Symbol;

package/dist/sdk/blocks/text/component-info.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components';
+export declare const componentInfo: ComponentInfo;

package/dist/sdk/blocks/text/component-info.js

@@ -0,0 +1,20 @@
+export const componentInfo = {
+    name: 'Text',
+    static: true,
+    image: 'https://firebasestorage.googleapis.com/v0/b/builder-3b0a2.appspot.com/o/images%2Fbaseline-text_fields-24px%20(1).svg?alt=media&token=12177b73-0ee3-42ca-98c6-0dd003de1929',
+    inputs: [
+        {
+            name: 'text',
+            type: 'html',
+            required: true,
+            autoFocus: true,
+            bubble: true,
+            defaultValue: 'Enter some text...',
+        },
+    ],
+    defaultStyles: {
+        lineHeight: 'normal',
+        height: 'auto',
+        textAlign: 'center',
+    },
+};

package/dist/sdk/blocks/text/text.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+export interface TextProps {
+    text: string;
+}
+declare function Text(props: TextProps): JSX.Element;
+export default Text;

package/dist/sdk/blocks/textarea/component-info.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components';
+export declare const componentInfo: ComponentInfo;