@builder.io/sdk-svelte 4.2.3 → 5.0.0

package/lib/browser/components/content/content.svelte

@@ -14,12 +14,12 @@ import EnableEditor from "./components/enable-editor.svelte";
 import ContentStyles from "./components/styles.svelte";
 import { getContentInitialValue, getRootStateInitialValue, } from "./content.helpers";
 import "./wrap-component-ref";
-export let apiKey;
-export let context = undefined;
 export let content;
-export let customComponents = undefined;
 export let data = undefined;
 export let locale = undefined;
+export let apiKey;
+export let context = undefined;
+export let customComponents = undefined;
 export let canTrack = undefined;
 export let apiVersion = undefined;
 export let blocksWrapper = undefined;
@@ -100,6 +100,30 @@ if (jsCode) {
         isExpression: false,
     });
 }
+function onUpdateFn_0(..._args) {
+    const updateContentAndRootState = () => {
+        const nextId = content?.id;
+        const currentId = $builderContextSignal.content?.id;
+        if (nextId && nextId !== currentId) {
+            // Update content and root state to reflect the new entry
+            $builderContextSignal.content = getContentInitialValue({
+                content: content,
+                data: data,
+            });
+            $builderContextSignal.rootState = getRootStateInitialValue({
+                content: content,
+                data: data,
+                locale: locale,
+            });
+            // Update AB-test visibility script
+            scriptStr = getUpdateVariantVisibilityScript({
+                variationId: content?.testVariationId || "",
+                contentId: nextId,
+            });
+        }
+    };
+}
+$: onUpdateFn_0(...[content, data, locale]);
 setContext(ComponentsContext.key, {
     registeredComponents: registeredComponents,
 });

package/lib/browser/components/content/content.svelte.d.ts

@@ -2,12 +2,12 @@ import { SvelteComponent } from "svelte";
 import type { ContentProps } from "./content.types";
 declare const __propDef: {
     props: {
-        apiKey: ContentProps["apiKey"];
-        context?: ContentProps["context"];
         content: ContentProps["content"];
-        customComponents?: ContentProps["customComponents"];
         data?: ContentProps["data"];
         locale?: ContentProps["locale"];
+        apiKey: ContentProps["apiKey"];
+        context?: ContentProps["context"];
+        customComponents?: ContentProps["customComponents"];
         canTrack?: ContentProps["canTrack"];
         apiVersion?: ContentProps["apiVersion"];
         blocksWrapper?: ContentProps["blocksWrapper"];

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

@@ -1 +1 @@
-export declare const SDK_VERSION = "4.2.3";
+export declare const SDK_VERSION = "5.0.0";

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

@@ -1 +1 @@
-export const SDK_VERSION = "4.2.3";
+export const SDK_VERSION = "5.0.0";

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/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/edge/components/content/content.svelte

@@ -14,12 +14,12 @@ import EnableEditor from "./components/enable-editor.svelte";
 import ContentStyles from "./components/styles.svelte";
 import { getContentInitialValue, getRootStateInitialValue, } from "./content.helpers";
 import "./wrap-component-ref";
-export let apiKey;
-export let context = undefined;
 export let content;
-export let customComponents = undefined;
 export let data = undefined;
 export let locale = undefined;
+export let apiKey;
+export let context = undefined;
+export let customComponents = undefined;
 export let canTrack = undefined;
 export let apiVersion = undefined;
 export let blocksWrapper = undefined;
@@ -100,6 +100,30 @@ if (jsCode) {
         isExpression: false,
     });
 }
+function onUpdateFn_0(..._args) {
+    const updateContentAndRootState = () => {
+        const nextId = content?.id;
+        const currentId = $builderContextSignal.content?.id;
+        if (nextId && nextId !== currentId) {
+            // Update content and root state to reflect the new entry
+            $builderContextSignal.content = getContentInitialValue({
+                content: content,
+                data: data,
+            });
+            $builderContextSignal.rootState = getRootStateInitialValue({
+                content: content,
+                data: data,
+                locale: locale,
+            });
+            // Update AB-test visibility script
+            scriptStr = getUpdateVariantVisibilityScript({
+                variationId: content?.testVariationId || "",
+                contentId: nextId,
+            });
+        }
+    };
+}
+$: onUpdateFn_0(...[content, data, locale]);
 setContext(ComponentsContext.key, {
     registeredComponents: registeredComponents,
 });

package/lib/edge/components/content/content.svelte.d.ts

@@ -2,12 +2,12 @@ import { SvelteComponent } from "svelte";
 import type { ContentProps } from "./content.types";
 declare const __propDef: {
     props: {
-        apiKey: ContentProps["apiKey"];
-        context?: ContentProps["context"];
         content: ContentProps["content"];
-        customComponents?: ContentProps["customComponents"];
         data?: ContentProps["data"];
         locale?: ContentProps["locale"];
+        apiKey: ContentProps["apiKey"];
+        context?: ContentProps["context"];
+        customComponents?: ContentProps["customComponents"];
         canTrack?: ContentProps["canTrack"];
         apiVersion?: ContentProps["apiVersion"];
         blocksWrapper?: ContentProps["blocksWrapper"];

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

@@ -1 +1 @@
-export declare const SDK_VERSION = "4.2.3";
+export declare const SDK_VERSION = "5.0.0";

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

@@ -1 +1 @@
-export const SDK_VERSION = "4.2.3";
+export const SDK_VERSION = "5.0.0";

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/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/node/components/content/content.svelte

@@ -14,12 +14,12 @@ import EnableEditor from "./components/enable-editor.svelte";
 import ContentStyles from "./components/styles.svelte";
 import { getContentInitialValue, getRootStateInitialValue, } from "./content.helpers";
 import "./wrap-component-ref";
-export let apiKey;
-export let context = undefined;
 export let content;
-export let customComponents = undefined;
 export let data = undefined;
 export let locale = undefined;
+export let apiKey;
+export let context = undefined;
+export let customComponents = undefined;
 export let canTrack = undefined;
 export let apiVersion = undefined;
 export let blocksWrapper = undefined;
@@ -100,6 +100,30 @@ if (jsCode) {
         isExpression: false,
     });
 }
+function onUpdateFn_0(..._args) {
+    const updateContentAndRootState = () => {
+        const nextId = content?.id;
+        const currentId = $builderContextSignal.content?.id;
+        if (nextId && nextId !== currentId) {
+            // Update content and root state to reflect the new entry
+            $builderContextSignal.content = getContentInitialValue({
+                content: content,
+                data: data,
+            });
+            $builderContextSignal.rootState = getRootStateInitialValue({
+                content: content,
+                data: data,
+                locale: locale,
+            });
+            // Update AB-test visibility script
+            scriptStr = getUpdateVariantVisibilityScript({
+                variationId: content?.testVariationId || "",
+                contentId: nextId,
+            });
+        }
+    };
+}
+$: onUpdateFn_0(...[content, data, locale]);
 setContext(ComponentsContext.key, {
     registeredComponents: registeredComponents,
 });

package/lib/node/components/content/content.svelte.d.ts

@@ -2,12 +2,12 @@ import { SvelteComponent } from "svelte";
 import type { ContentProps } from "./content.types";
 declare const __propDef: {
     props: {
-        apiKey: ContentProps["apiKey"];
-        context?: ContentProps["context"];
         content: ContentProps["content"];
-        customComponents?: ContentProps["customComponents"];
         data?: ContentProps["data"];
         locale?: ContentProps["locale"];
+        apiKey: ContentProps["apiKey"];
+        context?: ContentProps["context"];
+        customComponents?: ContentProps["customComponents"];
         canTrack?: ContentProps["canTrack"];
         apiVersion?: ContentProps["apiVersion"];
         blocksWrapper?: ContentProps["blocksWrapper"];

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

@@ -1 +1 @@
-export declare const SDK_VERSION = "4.2.3";
+export declare const SDK_VERSION = "5.0.0";

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

@@ -1 +1 @@
-export const SDK_VERSION = "4.2.3";
+export const SDK_VERSION = "5.0.0";

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
  */

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

@@ -1,7 +1,7 @@
 {
   "name": "@builder.io/sdk-svelte",
   "description": "Builder.io SDK for Svelte",
-  "version": "4.2.3",
+  "version": "5.0.0",
   "type": "module",
   "files": [
     "lib",
@@ -48,7 +48,7 @@
     "check": "SDK_ENV=browser svelte-check --tsconfig ./tsconfig.json"
   },
   "dependencies": {
-    "isolated-vm": "^5.0.0"
+    "isolated-vm": "^6.0.0"
   },
   "devDependencies": {
     "@builder.io/sdks": "workspace:*",

package/src/components/content/content.svelte

@@ -28,12 +28,12 @@
   import type { ContentProps } from "./content.types";
   import { wrapComponentRef } from "./wrap-component-ref";
 
-  export let apiKey: ContentProps["apiKey"];
-  export let context: ContentProps["context"] = undefined;
   export let content: ContentProps["content"];
-  export let customComponents: ContentProps["customComponents"] = undefined;
   export let data: ContentProps["data"] = undefined;
   export let locale: ContentProps["locale"] = undefined;
+  export let apiKey: ContentProps["apiKey"];
+  export let context: ContentProps["context"] = undefined;
+  export let customComponents: ContentProps["customComponents"] = undefined;
   export let canTrack: ContentProps["canTrack"] = undefined;
   export let apiVersion: ContentProps["apiVersion"] = undefined;
   export let blocksWrapper: ContentProps["blocksWrapper"] = undefined;
@@ -127,6 +127,33 @@
     });
   }
 
+  function onUpdateFn_0(..._args: any[]) {
+    const updateContentAndRootState = () => {
+      const nextId = content?.id;
+      const currentId = $builderContextSignal.content?.id;
+      if (nextId && nextId !== currentId) {
+        // Update content and root state to reflect the new entry
+        $builderContextSignal.content = getContentInitialValue({
+          content: content,
+          data: data,
+        });
+        $builderContextSignal.rootState = getRootStateInitialValue({
+          content: content,
+          data: data,
+          locale: locale,
+        });
+
+        // Update AB-test visibility script
+        scriptStr = getUpdateVariantVisibilityScript({
+          variationId: content?.testVariationId || "",
+          contentId: nextId,
+        });
+      }
+    };
+  }
+
+  $: onUpdateFn_0(...[content, data, locale]);
+
   setContext(ComponentsContext.key, {
     registeredComponents: registeredComponents,
   });

package/src/constants/sdk-version.ts

@@ -1 +1 @@
-export const SDK_VERSION = "4.2.3"
+export const SDK_VERSION = "5.0.0"

package/src/functions/get-builder-search-params/index.ts

@@ -5,8 +5,14 @@ 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/src/functions/is-previewing.ts

@@ -1,16 +1,27 @@
 import type { Search } from '../helpers/search/search';
 import { getSearchString } from '../helpers/search/search';
 import { isBrowser } from './is-browser';
-export function isPreviewing(_search?: 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?: 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);
 }