@builder.io/sdk-solid 4.2.3 → 4.2.4

package/dist/index.d.ts

@@ -803,7 +803,17 @@ type Search = URLSearchParams | string | QueryObject;
 
 declare function isEditing(search?: Search): boolean;
 
-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.
+ */
+declare function isPreviewing(search?: Search): boolean;
 
 declare const createRegisterComponentMessage: (info: ComponentInfo) => {
     type: string;
@@ -852,8 +862,14 @@ type Settings = {
 declare function setEditorSettings(newSettings: Settings): void;
 
 /**
- * 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/dev.js

@@ -1047,12 +1047,12 @@ function BlockWrapper(props) {
 var block_wrapper_default = BlockWrapper;
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -1157,7 +1157,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/browser/dev.jsx

@@ -1039,12 +1039,12 @@ import { Show as Show2, on, createEffect, createMemo as createMemo2, createSigna
 import { Dynamic as Dynamic3 } from "solid-js/web";
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -1149,7 +1149,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/browser/index.js

@@ -1038,12 +1038,12 @@ function BlockWrapper(props) {
 var block_wrapper_default = BlockWrapper;
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -1147,7 +1147,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/browser/index.jsx

@@ -1032,12 +1032,12 @@ import { Show as Show2, on, createEffect, createMemo as createMemo2, createSigna
 import { Dynamic as Dynamic3 } from "solid-js/web";
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -1141,7 +1141,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/edge/dev.js

@@ -4228,12 +4228,12 @@ function BlockWrapper(props) {
 var block_wrapper_default = BlockWrapper;
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -4338,7 +4338,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/edge/dev.jsx

@@ -4222,12 +4222,12 @@ import { Show as Show2, on, createEffect, createMemo as createMemo2, createSigna
 import { Dynamic as Dynamic3 } from "solid-js/web";
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -4332,7 +4332,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/edge/index.js

@@ -4219,12 +4219,12 @@ function BlockWrapper(props) {
 var block_wrapper_default = BlockWrapper;
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -4328,7 +4328,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/edge/index.jsx

@@ -4215,12 +4215,12 @@ import { Show as Show2, on, createEffect, createMemo as createMemo2, createSigna
 import { Dynamic as Dynamic3 } from "solid-js/web";
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -4324,7 +4324,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/node/dev.js

@@ -1216,12 +1216,12 @@ function BlockWrapper(props) {
 var block_wrapper_default = BlockWrapper;
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -1326,7 +1326,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/node/dev.jsx

@@ -1210,12 +1210,12 @@ import { Show as Show2, on, createEffect, createMemo as createMemo2, createSigna
 import { Dynamic as Dynamic3 } from "solid-js/web";
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -1320,7 +1320,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/node/index.js

@@ -1207,12 +1207,12 @@ function BlockWrapper(props) {
 var block_wrapper_default = BlockWrapper;
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -1316,7 +1316,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/lib/node/index.jsx

@@ -1203,12 +1203,12 @@ import { Show as Show2, on, createEffect, createMemo as createMemo2, createSigna
 import { Dynamic as Dynamic3 } from "solid-js/web";
 
 // src/functions/is-previewing.ts
-function isPreviewing(_search) {
-  const search = _search || (isBrowser() ? window.location.search : void 0);
-  if (!search) {
+function isPreviewing(search) {
+  const searchToUse = search || (isBrowser() ? window.location.search : void 0);
+  if (!searchToUse) {
     return false;
   }
-  const normalizedSearch = getSearchString(search);
+  const normalizedSearch = getSearchString(searchToUse);
   return Boolean(normalizedSearch.indexOf("builder.preview=") !== -1);
 }
 
@@ -1312,7 +1312,7 @@ var getBuilderSearchParamsFromWindow = () => {
 };
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "4.2.3";
+var SDK_VERSION = "4.2.4";
 
 // src/helpers/sdk-headers.ts
 var getSdkHeaders = () => ({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@builder.io/sdk-solid",
-  "version": "4.2.3",
+  "version": "4.2.4",
   "description": "",
   "files": [
     "dist",