@builder.io/sdk-svelte 3.0.0 → 3.0.2

package/lib/edge/functions/extract-localized-values.js

@@ -0,0 +1,37 @@
+import { traverse } from './traverse';
+function isLocalizedField(value) {
+    return value && typeof value === 'object' && value['@type'] === '@builder.io/core:LocalizedValue';
+}
+function containsLocalizedValues(data) {
+    if (!data || !Object.getOwnPropertyNames(data).length) {
+        return false;
+    }
+    let hasLocalizedValues = false;
+    traverse(data, value => {
+        if (isLocalizedField(value)) {
+            hasLocalizedValues = true;
+            return;
+        }
+    });
+    return hasLocalizedValues;
+}
+function extractLocalizedValues(data, locale) {
+    if (!data || !Object.getOwnPropertyNames(data).length) {
+        return {};
+    }
+    traverse(data, (value, update) => {
+        if (isLocalizedField(value)) {
+            update(value[locale] ?? undefined);
+        }
+    });
+    return data;
+}
+export function resolveLocalizedValues(block, locale) {
+    if (block.component?.options && containsLocalizedValues(block.component?.options)) {
+        if (!locale) {
+            console.warn('[Builder.io] In order to use localized fields in Builder, you must pass a locale prop to the BuilderComponent or to options object while fetching the content to resolve localized fields. Learn more: https://www.builder.io/c/docs/localization-inline#targeting-and-inline-localization');
+        }
+        block.component.options = extractLocalizedValues(block.component.options, locale ?? 'Default');
+    }
+    return block;
+}

package/lib/edge/functions/get-block-component-options.d.ts

@@ -1,2 +1,3 @@
+import type { BuilderContextInterface } from '../context/types';
 import type { BuilderBlock } from '../types/builder-block';
-export declare function getBlockComponentOptions(block: BuilderBlock): any;
+export declare function getBlockComponentOptions(block: BuilderBlock, context: Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): any;

package/lib/edge/functions/get-block-component-options.js

@@ -1,6 +1,22 @@
-export function getBlockComponentOptions(block) {
+import { evaluate } from './evaluate/evaluate';
+export function getBlockComponentOptions(block, context) {
     return {
         ...block.component?.options,
-        ...block.options
+        ...block.options,
+        ...evaluateTextComponentTextOption(block, context)
     };
 }
+const evaluateTextComponentTextOption = (block, context) => {
+    if (block.component?.name === 'Text' && block.component.options?.text && typeof block.component.options.text === 'string') {
+        return {
+            ...block.component.options,
+            text: block.component.options.text.replace(/{{([^}]+)}}/g, (_match, group) => evaluate({
+                code: group,
+                context,
+                localState: context.localState,
+                rootState: context.rootState,
+                rootSetState: context.rootSetState
+            }))
+        };
+    }
+};

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

@@ -1,7 +1,8 @@
-import { flatten, flattenMongoQuery } from '../../helpers/flatten';
+import { flatten, flattenMongoQuery, unflatten } from '../../helpers/flatten';
 import { normalizeSearchParams } from '../../helpers/search/search';
 import { DEFAULT_API_VERSION } from '../../types/api-version';
 import { getBuilderSearchParamsFromWindow } from '../get-builder-search-params/index';
+import { isBrowser } from '../is-browser';
 const isPositiveNumber = (thing) => typeof thing === 'number' && !isNaN(thing) && thing >= 0;
 export const generateContentUrl = (options) => {
     const { limit = 30, userAttributes, query, model, apiKey, enrich, locale, apiVersion = DEFAULT_API_VERSION, fields, omit, offset, cacheSeconds, staleCacheSeconds, sort, includeUnpublished, apiHost } = options;
@@ -20,7 +21,7 @@ export const generateContentUrl = (options) => {
     url.searchParams.set('noTraverse', String(noTraverse));
     url.searchParams.set('includeRefs', String(true));
     const finalLocale = locale || userAttributes?.locale;
-    let finalUserAttributes = userAttributes;
+    let finalUserAttributes = userAttributes || {};
     if (finalLocale) {
         url.searchParams.set('locale', finalLocale);
         finalUserAttributes = {
@@ -59,11 +60,15 @@ export const generateContentUrl = (options) => {
         ...getBuilderSearchParamsFromWindow(),
         ...normalizeSearchParams(options.options || {})
     };
+    finalUserAttributes = {
+        ...finalUserAttributes,
+        ...getUserAttributesAsJSON(queryOptions)
+    };
     const flattened = flatten(queryOptions);
     for (const key in flattened) {
         url.searchParams.set(key, String(flattened[key]));
     }
-    if (finalUserAttributes) {
+    if (Object.keys(finalUserAttributes).length > 0) {
         url.searchParams.set('userAttributes', JSON.stringify(finalUserAttributes));
     }
     if (query) {
@@ -76,3 +81,23 @@ export const generateContentUrl = (options) => {
     }
     return url;
 };
+const getUserAttributesFromQueryOptions = (queryOptions) => {
+    const newUserAttributes = {};
+    for (const key in queryOptions) {
+        if (key.startsWith('userAttributes.')) {
+            newUserAttributes[key] = queryOptions[key];
+            delete queryOptions[key];
+        }
+    }
+    return newUserAttributes;
+};
+const getUserAttributesAsJSON = (queryOptions) => {
+    if (isBrowser() && queryOptions['preview'] === 'BUILDER_STUDIO') {
+        queryOptions['userAttributes.urlPath'] = window.location.pathname;
+        queryOptions['userAttributes.host'] = window.location.host;
+        const queryOptionsForUserAttributes = getUserAttributesFromQueryOptions(queryOptions);
+        const { userAttributes } = unflatten(queryOptionsForUserAttributes);
+        return userAttributes;
+    }
+    return {};
+};

package/lib/edge/functions/get-processed-block.d.ts

@@ -1,11 +1,6 @@
 import type { BuilderContextInterface } from '../context/types';
 import type { BuilderBlock } from '../types/builder-block';
 export declare function deepCloneWithConditions<T = any>(obj: T): T;
-export declare function getProcessedBlock({ block, context, shouldEvaluateBindings, localState, rootState, rootSetState }: {
+export declare function getProcessedBlock({ block, context, localState, rootState, rootSetState }: {
     block: BuilderBlock;
-    /**
-     * In some cases, we want to avoid evaluating bindings and only want framework-specific block transformation. It is
-     * also sometimes too early to consider bindings, e.g. when we might be looking at a repeated block.
-     */
-    shouldEvaluateBindings: boolean;
 } & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): BuilderBlock;

package/lib/edge/functions/get-processed-block.js

@@ -1,6 +1,7 @@
 import { TARGET } from '../constants/target';
 import { omit } from '../helpers/omit';
 import { evaluate } from './evaluate/index';
+import { resolveLocalizedValues } from './extract-localized-values';
 import { fastClone } from './fast-clone';
 import { set } from './set';
 import { transformBlock } from './transform-block';
@@ -71,18 +72,14 @@ const evaluateBindings = ({ block, context, localState, rootState, rootSetState
     }
     return copied;
 };
-export function getProcessedBlock({ block, context, shouldEvaluateBindings, localState, rootState, rootSetState }) {
-    const transformedBlock = transformBlock(block);
-    if (shouldEvaluateBindings) {
-        return evaluateBindings({
-            block: transformedBlock,
-            localState,
-            rootState,
-            rootSetState,
-            context
-        });
-    }
-    else {
-        return transformedBlock;
-    }
+export function getProcessedBlock({ block, context, localState, rootState, rootSetState }) {
+    let transformedBlock = resolveLocalizedValues(block, rootState.locale);
+    transformedBlock = transformBlock(transformedBlock);
+    return evaluateBindings({
+        block: transformedBlock,
+        localState,
+        rootState,
+        rootSetState,
+        context
+    });
 }

package/lib/edge/functions/register-component.js

@@ -10,8 +10,11 @@ const serializeFn = (fnValue) => {
     // 2. `name(args) => {code}`
     // 3. `(args) => {}`
     // 4. `args => {}`
+    // 5. `async function(args) {code}`
+    // 6. `async (args) => {}`
+    // 7. `async args => {}`
     const isArrowWithoutParens = /^[a-zA-Z0-9_]+\s*=>/i.test(fnStr);
-    const appendFunction = !fnStr.startsWith('function') && !fnStr.startsWith('(') && !isArrowWithoutParens;
+    const appendFunction = !fnStr.startsWith('function') && !fnStr.startsWith('async') && !fnStr.startsWith('(') && !isArrowWithoutParens;
     return `return (${appendFunction ? 'function ' : ''}${fnStr}).apply(this, arguments)`;
 };
 export function serializeIncludingFunctions(info) {

package/lib/edge/functions/traverse.d.ts

@@ -0,0 +1,34 @@
+type TraverseCallback = (value: any, update: (newValue: any) => void) => void;
+/**
+ * Recursively traverses an object or array, invoking a callback on each value.
+ *
+ * @param {any} obj - The object or array to traverse. Can also handle primitives, null, or undefined.
+ * @param {TraverseCallback} callback - The function to invoke on each value. Receives the current value
+ * and an `update` function to modify the value in its parent container.
+ * @param {any} [parent=null] - The parent object or array of the current value. Used internally.
+ * @param {any} [key=null] - The key or index of the current value in its parent. Used internally.
+ * @param {WeakSet} [visited=new WeakSet()] - Tracks visited objects to handle circular references. Used internally.
+ *
+ * @example
+ * // Example: Doubling all numbers in an object
+ * const obj = { a: 1, b: [2, 3, { c: 4 }] };
+ * traverse(obj, (value, update) => {
+ *   if (typeof value === 'number') {
+ *     update(value * 2);
+ *   }
+ * });
+ * console.log(obj); // { a: 2, b: [4, 6, { c: 8 }] }
+ *
+ * @example
+ * // Example: Handling circular references
+ * const obj = { a: 1 };
+ * obj.self = obj;
+ * traverse(obj, (value, update) => {
+ *   if (typeof value === 'number') {
+ *     update(value * 2);
+ *   }
+ * });
+ * console.log(obj.a); // 2
+ */
+export declare function traverse(obj: any, callback: TraverseCallback, parent?: any, key?: any, visited?: WeakSet<WeakKey>): void;
+export {};

package/lib/edge/functions/traverse.js

@@ -0,0 +1,63 @@
+/**
+ * Recursively traverses an object or array, invoking a callback on each value.
+ *
+ * @param {any} obj - The object or array to traverse. Can also handle primitives, null, or undefined.
+ * @param {TraverseCallback} callback - The function to invoke on each value. Receives the current value
+ * and an `update` function to modify the value in its parent container.
+ * @param {any} [parent=null] - The parent object or array of the current value. Used internally.
+ * @param {any} [key=null] - The key or index of the current value in its parent. Used internally.
+ * @param {WeakSet} [visited=new WeakSet()] - Tracks visited objects to handle circular references. Used internally.
+ *
+ * @example
+ * // Example: Doubling all numbers in an object
+ * const obj = { a: 1, b: [2, 3, { c: 4 }] };
+ * traverse(obj, (value, update) => {
+ *   if (typeof value === 'number') {
+ *     update(value * 2);
+ *   }
+ * });
+ * console.log(obj); // { a: 2, b: [4, 6, { c: 8 }] }
+ *
+ * @example
+ * // Example: Handling circular references
+ * const obj = { a: 1 };
+ * obj.self = obj;
+ * traverse(obj, (value, update) => {
+ *   if (typeof value === 'number') {
+ *     update(value * 2);
+ *   }
+ * });
+ * console.log(obj.a); // 2
+ */
+export function traverse(obj, callback, parent = null, key = null, visited = new WeakSet()) {
+    if (obj == null || typeof obj !== 'object') {
+        callback(obj, (newValue) => {
+            if (parent !== null && key !== null) {
+                parent[key] = newValue;
+            }
+        });
+        return;
+    }
+    if (visited.has(obj)) {
+        return;
+    }
+    visited.add(obj);
+    if (Array.isArray(obj)) {
+        obj.forEach((item, index) => {
+            const update = (newValue) => {
+                obj[index] = newValue;
+            };
+            callback(item, update);
+            traverse(item, callback, obj, index, visited);
+        });
+    }
+    else {
+        Object.entries(obj).forEach(([key, value]) => {
+            const update = (newValue) => {
+                obj[key] = newValue;
+            };
+            callback(value, update);
+            traverse(value, callback, obj, key, visited);
+        });
+    }
+}

package/lib/edge/helpers/flatten.d.ts

@@ -14,3 +14,9 @@ export declare function flatten<T extends Record<string, any>>(object: T, path?:
 export declare function flattenMongoQuery(obj: any, _current?: any, _res?: any): {
     [key: string]: string;
 };
+/**
+ * Unflatten a flat object with dot-separated keys back into a nested object.
+ *
+ * { 'foo.bar': 'baz' } -> { foo: { bar: 'baz' }}
+ */
+export declare function unflatten(obj: any): any;

package/lib/edge/helpers/flatten.js

@@ -37,3 +37,26 @@ export function flattenMongoQuery(obj, _current, _res = {}) {
     }
     return _res;
 }
+/**
+ * Unflatten a flat object with dot-separated keys back into a nested object.
+ *
+ * { 'foo.bar': 'baz' } -> { foo: { bar: 'baz' }}
+ */
+export function unflatten(obj) {
+    const result = {};
+    for (const key in obj) {
+        const parts = key.split('.');
+        let current = result;
+        for (let i = 0; i < parts.length; i++) {
+            const part = parts[i];
+            if (i === parts.length - 1) {
+                current[part] = obj[key];
+            }
+            else {
+                current[part] = current[part] || {};
+                current = current[part];
+            }
+        }
+    }
+    return result;
+}

package/lib/edge/server-index.d.ts

@@ -15,7 +15,7 @@ export type { ContentVariantsPrps as ContentProps } from './components/content-v
 /**
  * General Builder types
  */
-export type { RegisteredComponent } from './context/types';
+export type { BuilderContextInterface, RegisteredComponent, RegisteredComponents } from './context/types';
 export type { BuilderBlock } from './types/builder-block';
 export type { BuilderContent } from './types/builder-content';
 export type { ComponentInfo } from './types/components';

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

@@ -146,6 +146,9 @@ export interface ComponentInfo {
          */
         builderLinkComponent?: boolean;
     };
+    meta?: {
+        [key: string]: any;
+    };
 }
 type Permission = 'read' | 'publish' | 'editCode' | 'editDesigns' | 'admin' | 'create';
 export {};

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

@@ -1,3 +1,4 @@
+import { IMAGE_FILE_TYPES } from '../../constants/file-types';
 export const componentInfo = {
     name: 'Image',
     static: true,
@@ -13,7 +14,7 @@ export const componentInfo = {
             name: 'image',
             type: 'file',
             bubble: true,
-            allowedFileTypes: ['jpeg', 'jpg', 'png', 'svg', 'webp'],
+            allowedFileTypes: IMAGE_FILE_TYPES,
             required: true,
             defaultValue: 'https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2F72c80f114dc149019051b6852a9e3b7a',
             onChange: (options) => {

package/lib/node/blocks/image/image.svelte

@@ -29,7 +29,8 @@ $: srcSetToUse = () => {
     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/))) {
+        !(typeof url === "string" &&
+            (url.match(/builder\.io/) || url.match(/cdn\.shopify\.com/)))) {
         return srcset;
     }
     if (noWebp) {

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

@@ -1,3 +1,4 @@
+import { IMAGE_FILE_TYPES } from '../../constants/file-types';
 export const componentInfo = {
     // friendlyName?
     name: 'Raw:Img',
@@ -7,7 +8,7 @@ export const componentInfo = {
             name: 'image',
             bubble: true,
             type: 'file',
-            allowedFileTypes: ['jpeg', 'jpg', 'png', 'svg', 'gif', 'webp'],
+            allowedFileTypes: IMAGE_FILE_TYPES,
             required: true
         }],
     noWrap: true,

package/lib/node/blocks/text/text.svelte

@@ -1,6 +1,4 @@
-<script>import { evaluate } from "../../functions/evaluate/index";
-export let builderContext;
-export let text = undefined;
+<script>export let text = undefined;
 function stringifyStyles(stylesObj) {
     let styles = "";
     for (let key in stylesObj) {
@@ -11,17 +9,6 @@ function stringifyStyles(stylesObj) {
     }
     return styles;
 }
-$: processedText = () => {
-    const context = $builderContext;
-    const { context: contextContext, localState, rootState, rootSetState, } = context;
-    return String(text?.toString() || "").replace(/{{([^}]+)}}/g, (match, group) => evaluate({
-        code: group,
-        context: contextContext,
-        localState,
-        rootState,
-        rootSetState,
-    }));
-};
 </script>
 
 <div
@@ -30,5 +17,5 @@ $: processedText = () => {
   })}
   class="builder-text"
 >
-  {@html processedText()}
+  {@html text?.toString() || ""}
 </div>

package/lib/node/blocks/text/text.svelte.d.ts

@@ -2,7 +2,6 @@ import { SvelteComponent } from "svelte";
 import type { TextProps } from "./text.types";
 declare const __propDef: {
     props: {
-        builderContext: TextProps["builderContext"];
         text?: TextProps["text"];
     };
     events: {

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

@@ -1,3 +1,4 @@
+import { IMAGE_FILE_TYPES, VIDEO_FILE_TYPES } from '../../constants/file-types';
 export const componentInfo = {
     name: 'Video',
     canHaveChildren: true,
@@ -9,14 +10,14 @@ export const componentInfo = {
     inputs: [{
             name: 'video',
             type: 'file',
-            allowedFileTypes: ['mp4'],
+            allowedFileTypes: VIDEO_FILE_TYPES,
             bubble: true,
             defaultValue: 'https://cdn.builder.io/o/assets%2FYJIGb4i01jvw0SRdL5Bt%2Fd27731a526464deba0016216f5f9e570%2Fcompressed?apiKey=YJIGb4i01jvw0SRdL5Bt&token=d27731a526464deba0016216f5f9e570&alt=media&optimized=true',
             required: true
         }, {
             name: 'posterImage',
             type: 'file',
-            allowedFileTypes: ['jpeg', 'png'],
+            allowedFileTypes: IMAGE_FILE_TYPES,
             helperText: 'Image to show before the video plays'
         }, {
             name: 'autoPlay',

package/lib/node/components/block/block.helpers.d.ts

@@ -3,9 +3,10 @@ import type { Writable } from "svelte/store";
 import type { BuilderContextInterface, RegisteredComponent, RegisteredComponents } from '../../context/types';
 import type { BuilderBlock } from '../../types/builder-block';
 import type { RepeatData } from './types';
-export declare const getComponent: ({ block, registeredComponents }: {
+export declare const getComponent: ({ block, registeredComponents, model }: {
     block: BuilderBlock;
     registeredComponents: RegisteredComponents;
+    model: string;
 }) => RegisteredComponent | null | undefined;
 export declare const getRepeatItemData: ({ block, context }: {
     block: BuilderBlock;
@@ -20,8 +21,10 @@ export declare const provideLinkComponent: (block: RegisteredComponent | null |
 } | {
     builderLinkComponent?: undefined;
 };
-export declare const provideRegisteredComponents: (block: RegisteredComponent | null | undefined, registeredComponents: RegisteredComponents) => {
-    builderComponents: RegisteredComponents;
+export declare const provideRegisteredComponents: (block: RegisteredComponent | null | undefined, registeredComponents: RegisteredComponents, model: string) => {
+    builderComponents: {
+        [k: string]: RegisteredComponent;
+    };
 } | {
     builderComponents?: undefined;
 };

package/lib/node/components/block/block.helpers.js

@@ -1,13 +1,20 @@
 import { evaluate } from '../../functions/evaluate/index';
 import { extractTextStyles } from '../../functions/extract-text-styles';
 import { getStyle } from '../../functions/get-style';
-export const getComponent = ({ block, registeredComponents }) => {
+const checkIsComponentRestricted = (component, model) => {
+    if (!component)
+        return true;
+    if (!model)
+        return false;
+    return component.models && component.models.length > 0 && !component.models.includes(model);
+};
+export const getComponent = ({ block, registeredComponents, model }) => {
     const componentName = block.component?.name;
     if (!componentName) {
         return null;
     }
     const ref = registeredComponents[componentName];
-    if (!ref) {
+    if (!ref || checkIsComponentRestricted(ref, model)) {
         // TODO: Public doc page with more info about this message
         console.warn(`
       Could not find a registered component named "${componentName}". 
@@ -71,11 +78,15 @@ export const provideLinkComponent = (block, linkComponent) => {
         };
     return {};
 };
-export const provideRegisteredComponents = (block, registeredComponents) => {
-    if (block?.shouldReceiveBuilderProps?.builderComponents)
+export const provideRegisteredComponents = (block, registeredComponents, model) => {
+    if (block?.shouldReceiveBuilderProps?.builderComponents) {
+        const filteredRegisteredComponents = Object.fromEntries(Object.entries(registeredComponents).filter(([_, component]) => {
+            return !checkIsComponentRestricted(component, model);
+        }));
         return {
-            builderComponents: registeredComponents
+            builderComponents: filteredRegisteredComponents
         };
+    }
     return {};
 };
 export const provideBuilderBlock = (block, builderBlock) => {

package/lib/node/components/block/block.svelte

@@ -31,7 +31,6 @@ $: processedBlock = () => {
             rootState: $context.rootState,
             rootSetState: $context.rootSetState,
             context: $context.context,
-            shouldEvaluateBindings: true,
         });
     return blockToUse;
 };
@@ -39,6 +38,7 @@ $: blockComponent = () => {
     return getComponent({
         block: processedBlock(),
         registeredComponents: registeredComponents,
+        model: $context.model,
     });
 };
 $: Tag = () => {
@@ -77,11 +77,11 @@ $: componentRefProps = () => {
         blockChildren: processedBlock().children ?? [],
         componentRef: blockComponent?.()?.component,
         componentOptions: {
-            ...getBlockComponentOptions(processedBlock()),
+            ...getBlockComponentOptions(processedBlock(), $context),
             ...provideBuilderBlock(blockComponent(), processedBlock()),
             ...provideBuilderContext(blockComponent(), context),
             ...provideLinkComponent(blockComponent(), linkComponent),
-            ...provideRegisteredComponents(blockComponent(), registeredComponents),
+            ...provideRegisteredComponents(blockComponent(), registeredComponents, $context.model),
         },
         context: context,
         linkComponent: linkComponent,

package/lib/node/components/content/components/enable-editor.helpers.d.ts

@@ -0,0 +1,11 @@
+import type { Target } from '../../../types/targets';
+/**
+ * SDKS that use the elementRef approach to enable visual editing.
+ * We don't need to render the div for other SDKs as they attach event listeners to the window.
+ */
+export declare const SDKS_USING_ELEMENT_REF_APPROACH: Target[];
+/**
+ * We need to attach this div only when content exists or isPreviewing/isEditing even when content is null,
+ * as we need to set the elementRef and allow previewing and visual editing
+ */
+export declare const needsElementRefDivForEditing: () => boolean;

package/lib/node/components/content/components/enable-editor.helpers.js

@@ -0,0 +1,15 @@
+import { TARGET } from '../../../constants/target';
+import { isEditing } from '../../../functions/is-editing';
+import { isPreviewing } from '../../../functions/is-previewing';
+/**
+ * SDKS that use the elementRef approach to enable visual editing.
+ * We don't need to render the div for other SDKs as they attach event listeners to the window.
+ */
+export const SDKS_USING_ELEMENT_REF_APPROACH = ['svelte', 'qwik', 'vue'];
+/**
+ * We need to attach this div only when content exists or isPreviewing/isEditing even when content is null,
+ * as we need to set the elementRef and allow previewing and visual editing
+ */
+export const needsElementRefDivForEditing = () => {
+    return SDKS_USING_ELEMENT_REF_APPROACH.includes(TARGET) && (isEditing() || isPreviewing());
+};