@builder.io/sdk-svelte 4.2.1 → 4.2.4

package/lib/browser/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/browser/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/browser/constants/sdk-version.js

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

package/lib/browser/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/browser/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/browser/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/browser/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/browser/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/browser/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/browser/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/browser/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/browser/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/browser/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/edge/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/edge/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
 };

package/lib/edge/blocks/img/img.svelte

@@ -6,13 +6,15 @@
 <script>import { isEditing } from "../../functions/is-editing";
 import { filterAttrs } from "../helpers";
 import { getSrcSet } from "../image/image.helpers";
-import { setAttrs } from "../helpers";
+import { getClassPropName } from "../../functions/get-class-prop-name";
 export let imgSrc = undefined;
 export let image = undefined;
+export let attributes = undefined;
+export let altText = undefined;
+export let title = undefined;
 export let backgroundSize = undefined;
 export let backgroundPosition = undefined;
-export let altText = undefined;
-export let attributes = undefined;
+export let aspectRatio = undefined;
 function stringifyStyles(stylesObj) {
     let styles = "";
     for (let key in stylesObj) {
@@ -34,6 +36,15 @@ $: srcSetToUse = () => {
     }
     return getSrcSet(url);
 };
+$: imgAttrs = () => {
+    const attrs = {
+        ...filterAttrs(attributes, "on:", false),
+        ...filterAttrs(attributes, "on:", true),
+        [getClassPropName()]: `builder-raw-img ${attributes[getClassPropName()] || ""}`,
+    };
+    delete attrs.style;
+    return attrs;
+};
 </script>
 
 {#key (isEditing() && imgSrc) || "default-key"}
@@ -41,12 +52,13 @@ $: srcSetToUse = () => {
     style={stringifyStyles({
       objectFit: backgroundSize || "cover",
       objectPosition: backgroundPosition || "center",
+      aspectRatio: aspectRatio || undefined,
+      ...(attributes?.style || {}),
     })}
     loading="lazy"
     alt={altText}
+    {title}
     src={imgSrc || image}
-    srcSet={srcSetToUse()}
-    {...filterAttrs(attributes, "on:", false)}
-    use:setAttrs={filterAttrs(attributes, "on:", true)}
+    {...imgAttrs()}
   />
 {/key}

package/lib/edge/blocks/symbol/symbol.svelte

@@ -6,11 +6,11 @@ import { getClassPropName } from "../../functions/get-class-prop-name";
 import { setAttrs } from "../helpers";
 import { fetchSymbolContent } from "./symbol.helpers";
 export let symbol = undefined;
+export let builderComponents;
 export let attributes = undefined;
 export let dynamic = undefined;
 export let builderContext;
 export let builderBlock;
-export let builderComponents;
 export let builderLinkComponent = undefined;
 function setContent() {
     if (contentToUse && symbolEntry === symbol?.entry)
@@ -31,6 +31,9 @@ $: blocksWrapper = () => {
 $: contentWrapper = () => {
     return "div";
 };
+$: customComponents = () => {
+    return Object.values(builderComponents);
+};
 $: className = () => {
     return [
         ...[attributes[getClassPropName()]],
@@ -67,7 +70,7 @@ $: onUpdateFn_0(...[symbol]);
       ...$builderContext.context,
       symbolId: builderBlock?.id,
     }}
-    customComponents={Object.values(builderComponents)}
+    customComponents={customComponents()}
     data={{
       ...symbol?.data,
       ...$builderContext.localState,

package/lib/edge/blocks/symbol/symbol.svelte.d.ts

@@ -3,11 +3,11 @@ import type { SymbolProps } from "./symbol.types";
 declare const __propDef: {
     props: {
         symbol?: SymbolProps["symbol"];
+        builderComponents: SymbolProps["builderComponents"];
         attributes?: SymbolProps["attributes"];
         dynamic?: SymbolProps["dynamic"];
         builderContext: SymbolProps["builderContext"];
         builderBlock: SymbolProps["builderBlock"];
-        builderComponents: SymbolProps["builderComponents"];
         builderLinkComponent?: SymbolProps["builderLinkComponent"];
     };
     events: {

package/lib/edge/blocks/symbol/symbol.types.d.ts

@@ -1,6 +1,6 @@
 import type { BuilderContent } from '../../types/builder-content';
 import type { BuilderComponentsProp, BuilderDataProps, BuilderLinkComponentProp } from '../../types/builder-props';
-interface SymbolInfo {
+export interface SymbolInfo {
     model?: string;
     entry?: string;
     data?: any;
@@ -16,4 +16,3 @@ export interface SymbolProps extends BuilderComponentsProp, BuilderDataProps, Bu
     inheritState?: boolean;
     renderToLiquid?: boolean;
 }
-export {};

package/lib/edge/blocks/tabs/tabs.svelte

@@ -1,9 +1,9 @@
 <script>import Blocks from "../../components/blocks/blocks.svelte";
 export let defaultActiveTab = undefined;
 export let tabs;
+export let activeTabStyle = undefined;
 export let collapsible = undefined;
 export let tabHeaderLayout = undefined;
-export let activeTabStyle = undefined;
 export let builderBlock;
 export let builderContext;
 export let builderComponents;
@@ -21,6 +21,9 @@ function stringifyStyles(stylesObj) {
 function activeTabContent(active) {
     return tabs && tabs[active].content;
 }
+function getTabStyle(index) {
+    return index === activeTab ? activeTabStyle : {};
+}
 function onClick(index) {
     if (index === activeTab && collapsible) {
         activeTab = -1;
@@ -44,9 +47,7 @@ let activeTab = defaultActiveTab ? defaultActiveTab - 1 : 0;
   >
     {#each tabs as tab, index (index)}
       <span
-        style={stringifyStyles({
-          ...(activeTab === index ? activeTabStyle : {}),
-        })}
+        style={stringifyStyles(getTabStyle(index))}
         class={`builder-tab-wrap ${
           activeTab === index ? "builder-tab-active" : ""
         }`}

package/lib/edge/blocks/tabs/tabs.svelte.d.ts

@@ -4,9 +4,9 @@ declare const __propDef: {
     props: {
         defaultActiveTab?: TabsProps["defaultActiveTab"];
         tabs: TabsProps["tabs"];
+        activeTabStyle?: TabsProps["activeTabStyle"];
         collapsible?: TabsProps["collapsible"];
         tabHeaderLayout?: TabsProps["tabHeaderLayout"];
-        activeTabStyle?: TabsProps["activeTabStyle"];
         builderBlock: TabsProps["builderBlock"];
         builderContext: TabsProps["builderContext"];
         builderComponents: TabsProps["builderComponents"];

package/lib/edge/blocks/text/component-info.js

@@ -6,7 +6,6 @@ export const componentInfo = {
     } : {},
     name: 'Text',
     static: true,
-    isRSC: 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',

package/lib/edge/components/awaiter.types.d.ts

@@ -0,0 +1,7 @@
+export type AwaiterProps = {
+    load: () => Promise<any>;
+    props?: any;
+    attributes?: any;
+    fallback?: any;
+    children?: any;
+};

package/lib/edge/components/awaiter.types.js

@@ -0,0 +1 @@
+export {};

package/lib/edge/components/block/block.svelte

@@ -8,10 +8,10 @@ import "../../server-index";
 import "../dynamic-div.svelte";
 import { bindAnimations } from "./animator";
 import { generateKey, getComponent, getRepeatItemData, provideBuilderBlock, provideBuilderContext, provideLinkComponent, provideRegisteredComponents, } from "./block.helpers";
-import BlockStyles from "./components/block-styles.svelte";
 import BlockWrapper from "./components/block-wrapper.svelte";
 import ComponentRef from "./components/component-ref/component-ref.svelte";
 import RepeatedBlock from "./components/repeated-block.svelte";
+import StyleWrapper from "./components/style-wrapper.svelte";
 export let block;
 export let context;
 export let registeredComponents;
@@ -109,7 +109,7 @@ afterUpdate(() => { });
 </script>
 
 {#if canShowBlock()}
-  <BlockStyles block={processedBlock()} context={$context} />
+  <StyleWrapper block={processedBlock()} context={$context} id={block.id} />
 
   {#if !blockComponent?.()?.noWrap}
     {#if !repeatItem()}

package/lib/edge/components/block/components/component-ref/component-ref.svelte

@@ -2,19 +2,17 @@
 import Block from "../../block.svelte";
 import InteractiveElement from "../interactive-element.svelte";
 import { getWrapperProps } from "./component-ref.helpers";
-export let componentOptions;
-export let blockChildren;
 export let isInteractive;
 export let componentRef;
+export let componentOptions;
 export let builderBlock;
 export let context;
 export let linkComponent;
 export let includeBlockProps;
+export let blockChildren;
 export let registeredComponents;
 let shouldUpdate = false;
 let Wrapper = isInteractive ? InteractiveElement : componentRef;
-function onUpdateFn_0(..._args) { }
-$: onUpdateFn_0(...[componentOptions, blockChildren]);
 </script>
 
 {#if componentRef}
@@ -31,8 +29,10 @@ $: onUpdateFn_0(...[componentOptions, blockChildren]);
       contextValue: $context,
     })}
   >
-    {#each blockChildren as child (child.id)}
-      <Block block={child} {context} {registeredComponents} {linkComponent} />
-    {/each}
-  </svelte:component>
+    {#if componentRef}
+      {#each blockChildren as child (child.id)}
+        <Block block={child} {context} {registeredComponents} {linkComponent} />
+      {/each}
+    {/if}</svelte:component
+  >
 {/if}

package/lib/edge/components/block/components/component-ref/component-ref.svelte.d.ts

@@ -2,14 +2,14 @@ import { SvelteComponent } from "svelte";
 import type { ComponentProps } from "./component-ref.helpers";
 declare const __propDef: {
     props: {
-        componentOptions: ComponentProps["componentOptions"];
-        blockChildren: ComponentProps["blockChildren"];
         isInteractive: ComponentProps["isInteractive"];
         componentRef: ComponentProps["componentRef"];
+        componentOptions: ComponentProps["componentOptions"];
         builderBlock: ComponentProps["builderBlock"];
         context: ComponentProps["context"];
         linkComponent: ComponentProps["linkComponent"];
         includeBlockProps: ComponentProps["includeBlockProps"];
+        blockChildren: ComponentProps["blockChildren"];
         registeredComponents: ComponentProps["registeredComponents"];
     };
     events: {

package/lib/edge/components/block/components/interactive-element.svelte

@@ -1,8 +1,11 @@
 <script context="module"></script>
 
-<script>import { getBlockActions } from "../../../functions/get-block-actions";
+<script>import { TARGET } from "../../../constants/target";
+import { getBlockActions } from "../../../functions/get-block-actions";
 import { getBlockProperties } from "../../../functions/get-block-properties";
+import { isEditing } from "../../../server-index";
 import Awaiter from "../../awaiter.svelte";
+import LiveEdit from "../../live-edit.svelte";
 export let wrapperProps;
 export let block;
 export let includeBlockProps;
@@ -40,6 +43,10 @@ $: onUpdateFn_0(...[wrapperProps, block?.component?.options]);
     props={wrapperProps}
     attributes={attributes()}><slot /></Awaiter
   >
+{:else if TARGET === "rsc" && isEditing()}
+  <LiveEdit {Wrapper} id={block.id || ""} attributes={attributes()}
+    ><slot /></LiveEdit
+  >
 {:else}
   <svelte:component
     this={Wrapper}