@builder.io/sdk-svelte 4.2.1 → 4.2.4

package/lib/node/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/node/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/node/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/node/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/node/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/node/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/node/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/node/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/node/components/awaiter.types.js

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

package/lib/node/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/node/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/node/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/node/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}

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

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

package/lib/node/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/node/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
  */