@builder.io/sdk-svelte 2.0.31 → 3.0.1

package/src/components/content/components/enable-editor.svelte

@@ -45,6 +45,7 @@
     BuilderComponentStateChange,
     ContentProps,
   } from "../content.types";
+  import { needsElementRefDivForEditing } from "./enable-editor.helpers";
   import { getWrapperClassName } from "./styles.helpers";
   import type { Writable } from "svelte/store";
 
@@ -65,6 +66,17 @@
   export let contentWrapperProps: BuilderEditorProps["contentWrapperProps"] =
     undefined;
 
+  function stringifyStyles(stylesObj) {
+    let styles = "";
+    for (let key in stylesObj) {
+      const dashedKey = key.replace(/[A-Z]/g, function (match) {
+        return "-" + match.toLowerCase();
+      });
+      styles += dashedKey + ":" + stylesObj[key] + ";";
+    }
+    return styles;
+  }
+
   function mergeNewRootState(newData: Dictionary<any>) {
     const combinedState = {
       ...$builderContextSignal.rootState,
@@ -220,8 +232,14 @@
     });
     Object.values<ComponentInfo>($builderContextSignal.componentInfos).forEach(
       (registeredComponent) => {
-        const message = createRegisterComponentMessage(registeredComponent);
-        window.parent?.postMessage(message, "*");
+        if (
+          !model ||
+          !registeredComponent.models?.length ||
+          registeredComponent.models.includes(model)
+        ) {
+          const message = createRegisterComponentMessage(registeredComponent);
+          window.parent?.postMessage(message, "*");
+        }
       }
     );
     window.addEventListener(
@@ -362,9 +380,15 @@
   });
 </script>
 
-{#if $builderContextSignal.content}
+{#if $builderContextSignal.content || needsElementRefDivForEditing()}
   <svelte:element
     this={ContentWrapper}
+    style={stringifyStyles({
+      display:
+        !$builderContextSignal.content && needsElementRefDivForEditing()
+          ? "none"
+          : undefined,
+    })}
     {...{}}
     bind:this={elementRef}
     on:click={(event) => {

package/src/components/content/content.svelte

@@ -32,7 +32,6 @@
   export let context: ContentProps["context"] = undefined;
   export let content: ContentProps["content"] = undefined;
   export let customComponents: ContentProps["customComponents"] = undefined;
-  export let model: ContentProps["model"] = undefined;
   export let data: ContentProps["data"] = undefined;
   export let locale: ContentProps["locale"] = undefined;
   export let canTrack: ContentProps["canTrack"] = undefined;
@@ -40,6 +39,7 @@
   export let blocksWrapper: ContentProps["blocksWrapper"] = undefined;
   export let blocksWrapperProps: ContentProps["blocksWrapperProps"] = undefined;
   export let nonce: ContentProps["nonce"] = undefined;
+  export let model: ContentProps["model"] = undefined;
   export let apiHost: ContentProps["apiHost"] = undefined;
   export let enrich: ContentProps["enrich"] = undefined;
   export let showContent: ContentProps["showContent"];
@@ -63,11 +63,7 @@
   });
   let registeredComponents = [
     ...getDefaultRegisteredComponents(),
-    ...(customComponents?.filter(({ models }) => {
-      if (!models?.length) return true;
-      if (!model) return true;
-      return models.includes(model);
-    }) || []),
+    ...(customComponents || []),
   ].reduce<RegisteredComponents>(
     (acc, { component, ...info }) => ({
       ...acc,
@@ -96,11 +92,7 @@
     apiVersion: apiVersion,
     componentInfos: [
       ...getDefaultRegisteredComponents(),
-      ...(customComponents?.filter(({ models }) => {
-        if (!models?.length) return true;
-        if (!model) return true;
-        return models.includes(model);
-      }) || []),
+      ...(customComponents || []),
     ].reduce<Dictionary<ComponentInfo>>(
       (acc, { component: _, ...info }) => ({
         ...acc,
@@ -112,6 +104,7 @@
     BlocksWrapper: blocksWrapper || "div",
     BlocksWrapperProps: blocksWrapperProps || {},
     nonce: nonce || "",
+    model: model || "",
   });
   if (!apiKey) {
     logger.error(

package/src/constants/file-types.ts

@@ -0,0 +1,2 @@
+export const IMAGE_FILE_TYPES = ['jpeg', 'jpg', 'png', 'svg', 'webp', 'gif', 'jfif', 'pjpeg', 'pjp', 'apng', 'avif', 'tif', 'tiff', 'heif', 'bmp', 'eps', 'raw', 'cr2', 'nef', 'orf', 'sr2', 'psd', 'heic', 'dib', 'ai'];
+export const VIDEO_FILE_TYPES = ['mp4', 'webm', 'mkv', 'flv', 'vob', 'ogv', 'ogg', 'drc', 'gif', 'gifv', 'mng', 'avi', 'mov', 'qt', 'mts', 'm2ts', 'ts', 'wmv', 'yuv', 'rm', 'rmvb', 'viv', 'asf', 'amv', 'm4p', 'mpeg', 'mpe', 'm2v', 'm4v', 'svi', '3gp', '3g2', 'mxf', 'roq', 'nsv', 'f4v', 'f4p', 'f4a', 'f4b']

package/src/constants/sdk-version.ts

@@ -1 +1 @@
-export const SDK_VERSION = "2.0.31"
+export const SDK_VERSION = "3.0.1"

package/src/context/builder.context.ts

@@ -15,6 +15,7 @@ export default {
     BlocksWrapper: "div",
     BlocksWrapperProps: {},
     nonce: "",
+    model: "",
   }),
   key,
 };

package/src/context/types.ts

@@ -37,5 +37,6 @@ export interface BuilderContextInterface extends Pick<BlocksWrapperProps, 'Block
   // Used to recursively store all CSS coming from a parent that would apply to a Text block
   inheritedStyles: Record<string, unknown>;
   nonce: string;
+  model: string;
   canTrack?: boolean;
 }

package/src/functions/extract-localized-values.ts

@@ -0,0 +1,38 @@
+import type { BuilderBlock } from '../types/builder-block';
+import { traverse } from './traverse';
+function isLocalizedField(value: any) {
+  return value && typeof value === 'object' && value['@type'] === '@builder.io/core:LocalizedValue';
+}
+function containsLocalizedValues(data: Record<string, any>) {
+  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: Record<string, any>, locale: string) {
+  if (!data || !Object.getOwnPropertyNames(data).length) {
+    return {};
+  }
+  traverse(data, (value, update) => {
+    if (isLocalizedField(value)) {
+      update(value[locale] ?? undefined);
+    }
+  });
+  return data;
+}
+export function resolveLocalizedValues(block: BuilderBlock, locale: string | undefined) {
+  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/src/functions/get-content/index.ts

@@ -88,20 +88,15 @@ export const _processContentResult = async (options: GetContentOptions, content:
  * Returns a paginated array of entries that match the given options.
  */
 export async function fetchEntries(options: GetContentOptions) {
-  try {
-    const url = generateContentUrl(options);
-    const content = await _fetchContent(options);
-    if (!checkContentHasResults(content)) {
-      logger.error('Error fetching data. ', {
-        url,
-        content,
-        options
-      });
-      return null;
-    }
-    return _processContentResult(options, content);
-  } catch (error) {
-    logger.error('Error fetching data. ', error);
-    return null;
+  const url = generateContentUrl(options);
+  const content = await _fetchContent(options);
+  if (!checkContentHasResults(content)) {
+    logger.error('Error fetching data. ', {
+      url,
+      content,
+      options
+    });
+    throw content;
   }
+  return _processContentResult(options, content);
 }

package/src/functions/get-processed-block.ts

@@ -3,6 +3,7 @@ import type { BuilderContextInterface } from '../context/types';
 import { omit } from '../helpers/omit';
 import type { BuilderBlock } from '../types/builder-block';
 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';
@@ -96,7 +97,8 @@ export function getProcessedBlock({
    */
   shouldEvaluateBindings: boolean;
 } & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): BuilderBlock {
-  const transformedBlock = transformBlock(block);
+  let transformedBlock = resolveLocalizedValues(block, (rootState.locale as string | undefined));
+  transformedBlock = transformBlock(transformedBlock);
   if (shouldEvaluateBindings) {
     return evaluateBindings({
       block: transformedBlock,

package/src/functions/register-component.ts

@@ -13,8 +13,11 @@ const serializeFn = (fnValue: Function) => {
   // 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: ComponentInfo) {

package/src/functions/traverse.ts

@@ -0,0 +1,64 @@
+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 function traverse(obj: any, callback: TraverseCallback, parent: any = null, key: any = null, visited = new WeakSet()): void {
+  if (obj == null || typeof obj !== 'object') {
+    callback(obj, (newValue: any) => {
+      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: any) => {
+        obj[index] = newValue;
+      };
+      callback(item, update);
+      traverse(item, callback, obj, index, visited);
+    });
+  } else {
+    Object.entries(obj).forEach(([key, value]) => {
+      const update = (newValue: any) => {
+        obj[key] = newValue;
+      };
+      callback(value, update);
+      traverse(value, callback, obj, key, visited);
+    });
+  }
+}

package/src/types/components.ts

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