@builder.io/sdk-svelte 4.2.1 → 4.2.4

package/lib/edge/components/block/components/live-edit-block-styles.svelte

@@ -0,0 +1,114 @@
+<script context="module"></script>
+
+<script>import { getMaxWidthQueryForSize, getSizesForBreakpoints, } from "../../../constants/device-sizes";
+import { TARGET } from "../../../constants/target";
+import { camelToKebabCase } from "../../../functions/camel-to-kebab-case";
+import { getProcessedBlock } from "../../../functions/get-processed-block";
+import { createCssClass } from "../../../helpers/css";
+import { findBlockById } from "../../../helpers/find-block";
+import { checkIsDefined } from "../../../helpers/nullable";
+import InlinedStyles from "../../inlined-styles.svelte";
+export let contextProvider;
+export let id = undefined;
+$: block = () => {
+    return findBlockById(contextProvider.content, id);
+};
+$: processedBlock = () => {
+    const foundBlock = block();
+    if (!foundBlock) {
+        return null;
+    }
+    const blockToUse = foundBlock.repeat?.collection
+        ? foundBlock
+        : getProcessedBlock({
+            block: foundBlock,
+            localState: contextProvider.localState,
+            rootState: contextProvider.rootState,
+            rootSetState: contextProvider.rootSetState,
+            context: contextProvider.context,
+        });
+    return blockToUse;
+};
+$: canShowBlock = () => {
+    if (checkIsDefined(processedBlock?.()?.hide)) {
+        return !processedBlock?.()?.hide;
+    }
+    if (checkIsDefined(processedBlock?.()?.show)) {
+        return processedBlock?.()?.show;
+    }
+    return true;
+};
+$: css = () => {
+    const styles = processedBlock?.()?.responsiveStyles;
+    const content = contextProvider.content;
+    const sizesWithUpdatedBreakpoints = getSizesForBreakpoints(content?.meta?.breakpoints || {});
+    const contentHasXSmallBreakpoint = Boolean(content?.meta?.breakpoints?.xsmall);
+    const largeStyles = styles?.large;
+    const mediumStyles = styles?.medium;
+    const smallStyles = styles?.small;
+    const xsmallStyles = styles?.xsmall;
+    const className = processedBlock?.()?.id;
+    if (!className) {
+        return "";
+    }
+    const largeStylesClass = largeStyles
+        ? createCssClass({
+            className,
+            styles: largeStyles,
+        })
+        : "";
+    const mediumStylesClass = mediumStyles
+        ? createCssClass({
+            className,
+            styles: mediumStyles,
+            mediaQuery: getMaxWidthQueryForSize("medium", sizesWithUpdatedBreakpoints),
+        })
+        : "";
+    const smallStylesClass = smallStyles
+        ? createCssClass({
+            className,
+            styles: smallStyles,
+            mediaQuery: getMaxWidthQueryForSize("small", sizesWithUpdatedBreakpoints),
+        })
+        : "";
+    const xsmallStylesClass = xsmallStyles && contentHasXSmallBreakpoint
+        ? createCssClass({
+            className,
+            styles: xsmallStyles,
+            mediaQuery: getMaxWidthQueryForSize("xsmall", sizesWithUpdatedBreakpoints),
+        })
+        : "";
+    const hoverAnimation = processedBlock().animations &&
+        processedBlock().animations.find((item) => item.trigger === "hover");
+    let hoverStylesClass = "";
+    if (hoverAnimation) {
+        const hoverStyles = hoverAnimation.steps?.[1]?.styles || {};
+        hoverStylesClass =
+            createCssClass({
+                className: `${className}:hover`,
+                styles: {
+                    ...hoverStyles,
+                    transition: `all ${hoverAnimation.duration}s ${camelToKebabCase(hoverAnimation.easing)}`,
+                    transitionDelay: hoverAnimation.delay
+                        ? `${hoverAnimation.delay}s`
+                        : "0s",
+                },
+            }) || "";
+    }
+    return [
+        largeStylesClass,
+        mediumStylesClass,
+        smallStylesClass,
+        xsmallStylesClass,
+        hoverStylesClass,
+    ].join(" ");
+};
+</script>
+
+{#if TARGET === "rsc" && css() && canShowBlock()}
+  <InlinedStyles
+    id="builderio-block"
+    styles={css()}
+    nonce={contextProvider.nonce}
+  />
+{/if}

package/lib/edge/components/block/components/live-edit-block-styles.svelte.d.ts

@@ -0,0 +1,22 @@
+import { SvelteComponent } from "svelte";
+type LiveEditBlockStylesProps = {
+    id?: any;
+    contextProvider: BuilderContextInterface;
+};
+import type { BuilderContextInterface } from "../../../server-index";
+declare const __propDef: {
+    props: {
+        contextProvider: LiveEditBlockStylesProps["contextProvider"];
+        id?: LiveEditBlockStylesProps["id"];
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+type LiveEditBlockStylesProps_ = typeof __propDef.props;
+export { LiveEditBlockStylesProps_ as LiveEditBlockStylesProps };
+export type LiveEditBlockStylesEvents = typeof __propDef.events;
+export type LiveEditBlockStylesSlots = typeof __propDef.slots;
+export default class LiveEditBlockStyles extends SvelteComponent<LiveEditBlockStylesProps, LiveEditBlockStylesEvents, LiveEditBlockStylesSlots> {
+}

package/lib/edge/components/block/components/style-wrapper.svelte

@@ -0,0 +1,25 @@
+<script context="module"></script>
+
+<script>import { getContext, onMount } from "svelte";
+import { TARGET } from "../../../constants/target";
+import { BuilderContext } from "../../../context/index";
+import "../../../server-index";
+import BlockStyles from "./block-styles.svelte";
+import LiveEditBlockStyles from "./live-edit-block-styles.svelte";
+export let block;
+export let context;
+let contextProvider = getContext(BuilderContext.key);
+let isClientEditing = false;
+let isHydrated = false;
+onMount(() => { });
+</script>
+
+{#if isHydrated}
+  {#if TARGET === "rsc" && isClientEditing}
+    <LiveEditBlockStyles id={block.id} contextProvider={$contextProvider} />
+  {:else}
+    <BlockStyles {block} {context} />
+  {/if}
+{:else}
+  <BlockStyles {block} {context} />
+{/if}

package/lib/edge/components/block/components/style-wrapper.svelte.d.ts

@@ -0,0 +1,23 @@
+import { SvelteComponent } from "svelte";
+type StyleWrapperProps = {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+    id?: string;
+};
+import { BuilderBlock, BuilderContextInterface } from "../../../server-index";
+declare const __propDef: {
+    props: {
+        block: StyleWrapperProps["block"];
+        context: StyleWrapperProps["context"];
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+type StyleWrapperProps_ = typeof __propDef.props;
+export { StyleWrapperProps_ as StyleWrapperProps };
+export type StyleWrapperEvents = typeof __propDef.events;
+export type StyleWrapperSlots = typeof __propDef.slots;
+export default class StyleWrapper extends SvelteComponent<StyleWrapperProps, StyleWrapperEvents, StyleWrapperSlots> {
+}

package/lib/edge/components/content/components/enable-editor.svelte

@@ -15,7 +15,7 @@ import { getInteractionPropertiesForEvent } from "../../../functions/track/inter
 import { getDefaultCanTrack } from "../../../helpers/canTrack";
 import { getCookieSync } from "../../../helpers/cookie";
 import "../../../helpers/preview-lru-cache/set";
-import { createEditorListener } from "../../../helpers/subscribe-to-editor";
+import { createEditorListener, } from "../../../helpers/subscribe-to-editor";
 import { setupBrowserForEditing } from "../../../scripts/init-editing";
 import { triggerAnimation } from "../../block/animator";
 import "../../dynamic-div.svelte";
@@ -46,7 +46,7 @@ function stringifyStyles(stylesObj) {
     }
     return styles;
 }
-function mergeNewRootState(newData) {
+function mergeNewRootState(newData, editType) {
     const combinedState = {
         ...$builderContextSignal.rootState,
         ...newData,
@@ -57,8 +57,14 @@ function mergeNewRootState(newData) {
     else {
         $builderContextSignal.rootState = combinedState;
     }
+    if ($builderContextSignal.rootSetState) {
+        $builderContextSignal.rootSetState(combinedState);
+    }
+    else {
+        $builderContextSignal.rootState = combinedState;
+    }
 }
-function mergeNewContent(newContent) {
+function mergeNewContent(newContent, editType) {
     const newContentValue = {
         ...$builderContextSignal.content,
         ...newContent,
@@ -96,11 +102,11 @@ function processMessage(event) {
             animation: (animation) => {
                 triggerAnimation(animation);
             },
-            contentUpdate: (newContent) => {
-                mergeNewContent(newContent);
+            contentUpdate: (newContent, editType) => {
+                mergeNewContent(newContent, editType);
             },
-            stateUpdate: (newState) => {
-                mergeNewRootState(newState);
+            stateUpdate: (newState, editType) => {
+                mergeNewRootState(newState, editType);
             },
         },
     })(event);
@@ -160,11 +166,15 @@ function runHttpRequests() {
                 method: "GET",
             };
         logFetch(JSON.stringify(fetchRequestObj));
-        fetch(fetchRequestObj.url, {
+        const fetchOptions = {
             method: fetchRequestObj.method,
             headers: fetchRequestObj.headers,
             body: fetchRequestObj.body,
-        })
+        };
+        if (fetchRequestObj.method === "GET") {
+            delete fetchOptions.body;
+        }
+        fetch(fetchRequestObj.url, fetchOptions)
             .then((response) => response.json())
             .then((json) => {
             mergeNewRootState({
@@ -268,6 +278,9 @@ $: showContentProps = () => {
 };
 let elementRef;
 let hasExecuted = false;
+let contextValue = $builderContextSignal;
+let prevData = null;
+let prevLocale = "";
 let ContentWrapper = contentWrapper || "div";
 let httpReqsData = {};
 let httpReqsPending = {};
@@ -324,15 +337,23 @@ $: onUpdateFn_1_builderContextSignal_rootState =
 $: onUpdateFn_1(...[onUpdateFn_1_builderContextSignal_rootState]);
 function onUpdateFn_2(..._args) {
     if (data) {
+        if (prevData === data) {
+            return;
+        }
         mergeNewRootState(data);
+        prevData = data;
     }
 }
 $: onUpdateFn_2(...[data]);
 function onUpdateFn_3(..._args) {
     if (locale) {
+        if (prevLocale === locale) {
+            return;
+        }
         mergeNewRootState({
             locale: locale,
         });
+        prevLocale = locale;
     }
 }
 $: onUpdateFn_3(...[locale]);

package/lib/edge/components/live-edit.svelte

@@ -0,0 +1,20 @@
+<script context="module"></script>
+
+<script>import { getContext } from "svelte";
+import { BuilderContext } from "../context/index";
+import { findBlockById } from "../helpers/find-block";
+export let id = undefined;
+export let attributes = undefined;
+export let Wrapper = undefined;
+let context = getContext(BuilderContext.key);
+$: block = () => {
+    return findBlockById($context.content, id);
+};
+$: options = () => {
+    return block?.()?.component?.options || {};
+};
+</script>
+
+<svelte:component this={Wrapper} {...options()} {attributes}
+  ><slot /></svelte:component
+>

package/lib/edge/components/live-edit.svelte.d.ts

@@ -0,0 +1,26 @@
+import { SvelteComponent } from "svelte";
+type LiveEditProps = {
+    children?: any;
+    id?: any;
+    Wrapper?: any;
+    attributes?: any;
+};
+declare const __propDef: {
+    props: {
+        id?: LiveEditProps["id"];
+        attributes?: LiveEditProps["attributes"];
+        Wrapper?: LiveEditProps["Wrapper"];
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {
+        default: {};
+    };
+};
+type LiveEditProps_ = typeof __propDef.props;
+export { LiveEditProps_ as LiveEditProps };
+export type LiveEditEvents = typeof __propDef.events;
+export type LiveEditSlots = typeof __propDef.slots;
+export default class LiveEdit extends SvelteComponent<LiveEditProps, LiveEditEvents, LiveEditSlots> {
+}

package/lib/edge/constants/sdk-version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "4.2.1";
+export declare const SDK_VERSION = "4.2.4";

package/lib/edge/constants/sdk-version.js

@@ -1 +1 @@
-export const SDK_VERSION = "4.2.1";
+export const SDK_VERSION = "4.2.4";

package/lib/edge/functions/get-builder-search-params/index.d.ts

@@ -1,7 +1,13 @@
 import type { QueryObject } from '../../helpers/search/search';
 /**
- * Receives a `URLSearchParams` object or a regular query object, and returns the subset of query params that are
- * relevant to the Builder SDK.
+ * Receives a `URLSearchParams` object or a regular query object, and returns
+ * the subset of query params that are relevant to the Builder SDK.
+ *
+ * Outputs a key-value object to be passed to `fetchOneEntry` or `fetchEntries`
+ * functions as the `options` argument.
+ *
+ * NOTE: This function is generally not needed. Instead, it is recommended to use `isPreviewing()`
+ * to check if the current page requires previewed content.
  *
  * @returns
  */

package/lib/edge/functions/get-builder-search-params/index.js

@@ -3,8 +3,14 @@ import { isBrowser } from '../is-browser';
 const BUILDER_SEARCHPARAMS_PREFIX = 'builder.';
 const BUILDER_OPTIONS_PREFIX = 'options.';
 /**
- * Receives a `URLSearchParams` object or a regular query object, and returns the subset of query params that are
- * relevant to the Builder SDK.
+ * Receives a `URLSearchParams` object or a regular query object, and returns
+ * the subset of query params that are relevant to the Builder SDK.
+ *
+ * Outputs a key-value object to be passed to `fetchOneEntry` or `fetchEntries`
+ * functions as the `options` argument.
+ *
+ * NOTE: This function is generally not needed. Instead, it is recommended to use `isPreviewing()`
+ * to check if the current page requires previewed content.
  *
  * @returns
  */

package/lib/edge/functions/get-content/generate-content-url.js

@@ -20,15 +20,10 @@ export const generateContentUrl = (options) => {
     url.searchParams.set('limit', String(limit));
     url.searchParams.set('noTraverse', String(noTraverse));
     url.searchParams.set('includeRefs', String(true));
-    const finalLocale = locale || userAttributes?.locale;
-    let finalUserAttributes = userAttributes || {};
-    if (finalLocale) {
-        url.searchParams.set('locale', finalLocale);
-        finalUserAttributes = {
-            locale: finalLocale,
-            ...finalUserAttributes
-        };
+    if (locale) {
+        url.searchParams.set('locale', locale);
     }
+    let finalUserAttributes = userAttributes || {};
     if (enrich)
         url.searchParams.set('enrich', String(enrich));
     url.searchParams.set('omit', omit ?? 'meta.componentsUsed');

package/lib/edge/functions/get-content/index.js

@@ -12,6 +12,14 @@ const checkContentHasResults = (content) => 'results' in content;
  * Returns the first content entry that matches the given options.
  */
 export async function fetchOneEntry(options) {
+    const finalLocale = options.locale || options.userAttributes?.locale;
+    if (finalLocale) {
+        options.locale = finalLocale;
+        options.userAttributes = {
+            locale: finalLocale,
+            ...options.userAttributes
+        };
+    }
     const allContent = await fetchEntries({
         ...options,
         limit: 1

package/lib/edge/functions/is-previewing.d.ts

@@ -1,2 +1,12 @@
 import type { Search } from '../helpers/search/search';
-export declare function isPreviewing(_search?: Search): boolean;
+/**
+ * Checks the current URL's search parameters to see if it is attempting to
+ * preview Builder Content.
+ *
+ * When called on the client, it uses `window.location.search`.
+ * When called on the server (SSR), it requires a `search` argument.
+ *
+ * @param search - The search parameters to check. Can be a URL string (containing the search parameters), `URLSearchParams`, or a key-value object containing the search parameters.
+ * @returns `true` if the current page is being previewed, `false` otherwise.
+ */
+export declare function isPreviewing(search?: Search): boolean;

package/lib/edge/functions/is-previewing.js

@@ -1,14 +1,24 @@
 import { getSearchString } from '../helpers/search/search';
 import { isBrowser } from './is-browser';
-export function isPreviewing(_search) {
-    const search = _search || (isBrowser() ? window.location.search : undefined);
+/**
+ * Checks the current URL's search parameters to see if it is attempting to
+ * preview Builder Content.
+ *
+ * When called on the client, it uses `window.location.search`.
+ * When called on the server (SSR), it requires a `search` argument.
+ *
+ * @param search - The search parameters to check. Can be a URL string (containing the search parameters), `URLSearchParams`, or a key-value object containing the search parameters.
+ * @returns `true` if the current page is being previewed, `false` otherwise.
+ */
+export function isPreviewing(search) {
+    const searchToUse = search || (isBrowser() ? window.location.search : undefined);
     /**
      * If this function is called on the server without an explicit `search` argument,
      * then it can't check if the user is previewing, and will return `false`.
      */
-    if (!search) {
+    if (!searchToUse) {
         return false;
     }
-    const normalizedSearch = getSearchString(search);
+    const normalizedSearch = getSearchString(searchToUse);
     return Boolean(normalizedSearch.indexOf('builder.preview=') !== -1);
 }

package/lib/edge/helpers/find-block.d.ts

@@ -0,0 +1,18 @@
+import type { BuilderBlock, BuilderContent } from '../server-index';
+/**
+ * Recursively searches for a block by ID.
+ *
+ * @param content The Builder content to search through.
+ * @param id The ID of the block to search for.
+ * @returns The block if found, otherwise null.
+ */
+export declare const findBlockById: (content: BuilderContent, id: string) => BuilderBlock | null;
+/**
+ * Helper function to recursively search through block tree.
+ *
+ * @param blocks The blocks to search through.
+ * @param id The ID of the block to search for.
+ * @returns The block if found, otherwise null.
+ * @private This is an internal implementation detail.
+ */
+export declare const findBlockInTree: (blocks: BuilderBlock[] | undefined, id: string) => BuilderBlock | null;

package/lib/edge/helpers/find-block.js

@@ -0,0 +1,41 @@
+/**
+ * Recursively searches for a block by ID.
+ *
+ * @param content The Builder content to search through.
+ * @param id The ID of the block to search for.
+ * @returns The block if found, otherwise null.
+ */
+export const findBlockById = (content, id) => {
+    return findBlockInTree(content.data?.blocks, id);
+};
+/**
+ * Helper function to recursively search through block tree.
+ *
+ * @param blocks The blocks to search through.
+ * @param id The ID of the block to search for.
+ * @returns The block if found, otherwise null.
+ * @private This is an internal implementation detail.
+ */
+export const findBlockInTree = (blocks, id) => {
+    if (!blocks)
+        return null;
+    for (const block of blocks) {
+        if (block.id === id)
+            return block;
+        if (block.children) {
+            const child = findBlockInTree(block.children, id);
+            if (child)
+                return child;
+        }
+        if (block.component?.name === 'Columns' && block.component?.options?.columns) {
+            for (const column of block.component.options.columns) {
+                if (column.blocks) {
+                    const child = findBlockInTree(column.blocks, id);
+                    if (child)
+                        return child;
+                }
+            }
+        }
+    }
+    return null;
+};

package/lib/edge/helpers/subscribe-to-editor.d.ts

@@ -2,10 +2,11 @@ import type { ContentProps } from '../components/content/content.types';
 import type { BuilderAnimation } from '../types/builder-block';
 import type { BuilderContent } from '../types/builder-content';
 import type { Dictionary } from '../types/typescript';
+export type EditType = 'client' | 'server' | undefined;
 type ContentListener = Required<Pick<ContentProps, 'model' | 'trustedHosts'>> & {
     callbacks: {
-        contentUpdate: (updatedContent: BuilderContent) => void;
-        stateUpdate: (newState: Dictionary<string>) => void;
+        contentUpdate: (updatedContent: BuilderContent, editType?: EditType) => void;
+        stateUpdate: (newState: Dictionary<string>, editType?: EditType) => void;
         animation: (updatedContent: BuilderAnimation) => void;
         configureSdk: (updatedContent: any) => void;
     };

package/lib/edge/helpers/subscribe-to-editor.js

@@ -25,8 +25,9 @@ export const createEditorListener = ({ model, trustedHosts, callbacks }) => {
                         const messageContent = data.data;
                         const modelName = messageContent.model;
                         const newState = messageContent?.state;
+                        const editType = messageContent.editType;
                         if (modelName === model && newState) {
-                            callbacks.stateUpdate(newState);
+                            callbacks.stateUpdate(newState, editType);
                         }
                         break;
                     }
@@ -35,8 +36,9 @@ export const createEditorListener = ({ model, trustedHosts, callbacks }) => {
                         const messageContent = data.data;
                         const key = messageContent.key || messageContent.alias || messageContent.entry || messageContent.modelName;
                         const contentData = messageContent.data;
+                        const editType = messageContent.editType;
                         if (key === model) {
-                            callbacks.contentUpdate(contentData);
+                            callbacks.contentUpdate(contentData, editType);
                         }
                         break;
                     }

package/lib/node/blocks/form/form/form.svelte

@@ -44,6 +44,9 @@ function mergeNewRootState(newData) {
 function submissionState() {
     return (isEditing() && previewState) || formState;
 }
+function errorResponse(response) {
+    return JSON.stringify(response, null, 2);
+}
 function onSubmit(event) {
     const sendWithJsProp = sendWithJs || sendSubmissionsTo === "email";
     if (sendSubmissionsTo === "zapier") {
@@ -291,11 +294,7 @@ let formErrorMessage = "";
     />
   {/if}
   {#if submissionState() === "error" && responseData}
-    <pre class="builder-form-error-text pre">{JSON.stringify(
-        responseData,
-        null,
-        2
-      )}</pre>
+    <pre class="builder-form-error-text pre">{errorResponse(responseData)}</pre>
   {/if}
   {#if submissionState() === "success"}
     <Blocks

package/lib/node/blocks/img/component-info.js

@@ -1,6 +1,5 @@
 import { IMAGE_FILE_TYPES } from '../../constants/file-types';
 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',
@@ -10,7 +9,38 @@ export const componentInfo = {
             type: 'file',
             allowedFileTypes: IMAGE_FILE_TYPES,
             required: true
+        }, {
+            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: 'title',
+            type: 'string',
+            helperText: 'Text to display when hovering over the asset'
+        }, {
+            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
         }],
-    noWrap: true,
-    static: true
+    noWrap: true
 };