@builder.io/sdk-react-native 4.2.3 → 4.2.4

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

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.SDK_VERSION = void 0;
-const SDK_VERSION = exports.SDK_VERSION = "4.2.3";
+const SDK_VERSION = exports.SDK_VERSION = "4.2.4";
 //# sourceMappingURL=sdk-version.js.map

package/lib/browser/commonjs/functions/get-builder-search-params/index.js

@@ -10,8 +10,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/lib/browser/commonjs/functions/get-builder-search-params/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_search","require","_isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","normalizeSearchParams","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","exports","getBuilderSearchParamsFromWindow","isBrowser","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACA,MAAME,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAG,IAAAC,6BAAqB,EAACF,QAAQ,CAAC;EAC/C,MAAMG,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACJ,OAAO,CAAC,CAACK,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACX,2BAA2B,CAAC,EAAE;MAC/C,MAAMY,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACb,2BAA2B,EAAE,EAAE,CAAC,CAACa,OAAO,CAACZ,sBAAsB,EAAE,EAAE,CAAC;MACnGK,UAAU,CAACM,UAAU,CAAC,GAAGR,OAAO,CAACM,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AAACQ,OAAA,CAAAZ,sBAAA,GAAAA,sBAAA;AACK,MAAMa,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAAC,IAAAC,oBAAS,EAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOnB,sBAAsB,CAACe,YAAY,CAAC;AAC7C,CAAC;AAAAH,OAAA,CAAAC,gCAAA,GAAAA,gCAAA"}
+{"version":3,"names":["_search","require","_isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","normalizeSearchParams","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","exports","getBuilderSearchParamsFromWindow","isBrowser","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACA,MAAME,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAG,IAAAC,6BAAqB,EAACF,QAAQ,CAAC;EAC/C,MAAMG,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACJ,OAAO,CAAC,CAACK,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACX,2BAA2B,CAAC,EAAE;MAC/C,MAAMY,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACb,2BAA2B,EAAE,EAAE,CAAC,CAACa,OAAO,CAACZ,sBAAsB,EAAE,EAAE,CAAC;MACnGK,UAAU,CAACM,UAAU,CAAC,GAAGR,OAAO,CAACM,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AAACQ,OAAA,CAAAZ,sBAAA,GAAAA,sBAAA;AACK,MAAMa,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAAC,IAAAC,oBAAS,EAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOnB,sBAAsB,CAACe,YAAY,CAAC;AAC7C,CAAC;AAAAH,OAAA,CAAAC,gCAAA,GAAAA,gCAAA"}

package/lib/browser/commonjs/functions/is-previewing.js

@@ -4,19 +4,29 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isPreviewing = isPreviewing;
-var _search2 = require("../helpers/search/search");
+var _search = require("../helpers/search/search");
 var _isBrowser = require("./is-browser");
-function isPreviewing(_search) {
-  const search = _search || ((0, _isBrowser.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.
+ */
+function isPreviewing(search) {
+  const searchToUse = search || ((0, _isBrowser.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 = (0, _search2.getSearchString)(search);
+  const normalizedSearch = (0, _search.getSearchString)(searchToUse);
   return Boolean(normalizedSearch.indexOf('builder.preview=') !== -1);
 }
 //# sourceMappingURL=is-previewing.js.map

package/lib/browser/commonjs/functions/is-previewing.js.map

@@ -1 +1 @@
-{"version":3,"names":["_search2","require","_isBrowser","isPreviewing","_search","search","isBrowser","window","location","undefined","normalizedSearch","getSearchString","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":";;;;;;AACA,IAAAA,QAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACO,SAASE,YAAYA,CAACC,OAAgB,EAAE;EAC7C,MAAMC,MAAM,GAAGD,OAAO,KAAK,IAAAE,oBAAS,EAAC,CAAC,GAAGC,MAAM,CAACC,QAAQ,CAACH,MAAM,GAAGI,SAAS,CAAC;;EAE5E;AACF;AACA;AACA;EACE,IAAI,CAACJ,MAAM,EAAE;IACX,OAAO,KAAK;EACd;EACA,MAAMK,gBAAgB,GAAG,IAAAC,wBAAe,EAACN,MAAM,CAAC;EAChD,OAAOO,OAAO,CAACF,gBAAgB,CAACG,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}
+{"version":3,"names":["_search","require","_isBrowser","isPreviewing","search","searchToUse","isBrowser","window","location","undefined","normalizedSearch","getSearchString","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,YAAYA,CAACC,MAAe,EAAE;EAC5C,MAAMC,WAAW,GAAGD,MAAM,KAAK,IAAAE,oBAAS,EAAC,CAAC,GAAGC,MAAM,CAACC,QAAQ,CAACJ,MAAM,GAAGK,SAAS,CAAC;;EAEhF;AACF;AACA;AACA;EACE,IAAI,CAACJ,WAAW,EAAE;IAChB,OAAO,KAAK;EACd;EACA,MAAMK,gBAAgB,GAAG,IAAAC,uBAAe,EAACN,WAAW,CAAC;EACrD,OAAOO,OAAO,CAACF,gBAAgB,CAACG,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}

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

@@ -1,2 +1,2 @@
-export const SDK_VERSION = "4.2.3";
+export const SDK_VERSION = "4.2.4";
 //# sourceMappingURL=sdk-version.js.map

package/lib/browser/module/functions/get-builder-search-params/index.js

@@ -4,8 +4,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/lib/browser/module/functions/get-builder-search-params/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["normalizeSearchParams","isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","getBuilderSearchParamsFromWindow","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":"AACA,SAASA,qBAAqB;AAC9B,SAASC,SAAS;AAClB,MAAMC,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAGN,qBAAqB,CAACK,QAAQ,CAAC;EAC/C,MAAME,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACH,OAAO,CAAC,CAACI,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACV,2BAA2B,CAAC,EAAE;MAC/C,MAAMW,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACZ,2BAA2B,EAAE,EAAE,CAAC,CAACY,OAAO,CAACX,sBAAsB,EAAE,EAAE,CAAC;MACnGI,UAAU,CAACM,UAAU,CAAC,GAAGP,OAAO,CAACK,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AACD,OAAO,MAAMQ,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAACd,SAAS,CAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMe,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOhB,sBAAsB,CAACY,YAAY,CAAC;AAC7C,CAAC"}
+{"version":3,"names":["normalizeSearchParams","isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","getBuilderSearchParamsFromWindow","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":"AACA,SAASA,qBAAqB;AAC9B,SAASC,SAAS;AAClB,MAAMC,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAGN,qBAAqB,CAACK,QAAQ,CAAC;EAC/C,MAAME,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACH,OAAO,CAAC,CAACI,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACV,2BAA2B,CAAC,EAAE;MAC/C,MAAMW,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACZ,2BAA2B,EAAE,EAAE,CAAC,CAACY,OAAO,CAACX,sBAAsB,EAAE,EAAE,CAAC;MACnGI,UAAU,CAACM,UAAU,CAAC,GAAGP,OAAO,CAACK,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AACD,OAAO,MAAMQ,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAACd,SAAS,CAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMe,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOhB,sBAAsB,CAACY,YAAY,CAAC;AAC7C,CAAC"}

package/lib/browser/module/functions/is-previewing.js

@@ -1,16 +1,27 @@
 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);
 }
 //# sourceMappingURL=is-previewing.js.map

package/lib/browser/module/functions/is-previewing.js.map

@@ -1 +1 @@
-{"version":3,"names":["getSearchString","isBrowser","isPreviewing","_search","search","window","location","undefined","normalizedSearch","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":"AACA,SAASA,eAAe;AACxB,SAASC,SAAS;AAClB,OAAO,SAASC,YAAYA,CAACC,OAAgB,EAAE;EAC7C,MAAMC,MAAM,GAAGD,OAAO,KAAKF,SAAS,CAAC,CAAC,GAAGI,MAAM,CAACC,QAAQ,CAACF,MAAM,GAAGG,SAAS,CAAC;;EAE5E;AACF;AACA;AACA;EACE,IAAI,CAACH,MAAM,EAAE;IACX,OAAO,KAAK;EACd;EACA,MAAMI,gBAAgB,GAAGR,eAAe,CAACI,MAAM,CAAC;EAChD,OAAOK,OAAO,CAACD,gBAAgB,CAACE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}
+{"version":3,"names":["getSearchString","isBrowser","isPreviewing","search","searchToUse","window","location","undefined","normalizedSearch","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":"AACA,SAASA,eAAe;AACxB,SAASC,SAAS;;AAElB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,MAAe,EAAE;EAC5C,MAAMC,WAAW,GAAGD,MAAM,KAAKF,SAAS,CAAC,CAAC,GAAGI,MAAM,CAACC,QAAQ,CAACH,MAAM,GAAGI,SAAS,CAAC;;EAEhF;AACF;AACA;AACA;EACE,IAAI,CAACH,WAAW,EAAE;IAChB,OAAO,KAAK;EACd;EACA,MAAMI,gBAAgB,GAAGR,eAAe,CAACI,WAAW,CAAC;EACrD,OAAOK,OAAO,CAACD,gBAAgB,CAACE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}

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

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "4.2.3";
+export declare const SDK_VERSION = "4.2.4";
 //# sourceMappingURL=sdk-version.d.ts.map

package/lib/browser/typescript/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/typescript/functions/get-builder-search-params/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/functions/get-builder-search-params/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAM/D;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,aAAc,WAAW,GAAG,eAAe,GAAG,SAAS,gBAazF,CAAC;AACF,eAAO,MAAM,gCAAgC,mBAM5C,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/functions/get-builder-search-params/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAM/D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,aAAc,WAAW,GAAG,eAAe,GAAG,SAAS,gBAazF,CAAC;AACF,eAAO,MAAM,gCAAgC,mBAM5C,CAAA"}

package/lib/browser/typescript/functions/is-previewing.d.ts

@@ -1,3 +1,13 @@
 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;
 //# sourceMappingURL=is-previewing.d.ts.map

package/lib/browser/typescript/functions/is-previewing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-previewing.d.ts","sourceRoot":"","sources":["../../../../src/functions/is-previewing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAGvD,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,WAY5C"}
+{"version":3,"file":"is-previewing.d.ts","sourceRoot":"","sources":["../../../../src/functions/is-previewing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAIvD;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,WAY3C"}

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

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.SDK_VERSION = void 0;
-const SDK_VERSION = exports.SDK_VERSION = "4.2.3";
+const SDK_VERSION = exports.SDK_VERSION = "4.2.4";
 //# sourceMappingURL=sdk-version.js.map

package/lib/edge/commonjs/functions/get-builder-search-params/index.js

@@ -10,8 +10,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/lib/edge/commonjs/functions/get-builder-search-params/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_search","require","_isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","normalizeSearchParams","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","exports","getBuilderSearchParamsFromWindow","isBrowser","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACA,MAAME,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAG,IAAAC,6BAAqB,EAACF,QAAQ,CAAC;EAC/C,MAAMG,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACJ,OAAO,CAAC,CAACK,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACX,2BAA2B,CAAC,EAAE;MAC/C,MAAMY,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACb,2BAA2B,EAAE,EAAE,CAAC,CAACa,OAAO,CAACZ,sBAAsB,EAAE,EAAE,CAAC;MACnGK,UAAU,CAACM,UAAU,CAAC,GAAGR,OAAO,CAACM,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AAACQ,OAAA,CAAAZ,sBAAA,GAAAA,sBAAA;AACK,MAAMa,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAAC,IAAAC,oBAAS,EAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOnB,sBAAsB,CAACe,YAAY,CAAC;AAC7C,CAAC;AAAAH,OAAA,CAAAC,gCAAA,GAAAA,gCAAA"}
+{"version":3,"names":["_search","require","_isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","normalizeSearchParams","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","exports","getBuilderSearchParamsFromWindow","isBrowser","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACA,MAAME,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAG,IAAAC,6BAAqB,EAACF,QAAQ,CAAC;EAC/C,MAAMG,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACJ,OAAO,CAAC,CAACK,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACX,2BAA2B,CAAC,EAAE;MAC/C,MAAMY,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACb,2BAA2B,EAAE,EAAE,CAAC,CAACa,OAAO,CAACZ,sBAAsB,EAAE,EAAE,CAAC;MACnGK,UAAU,CAACM,UAAU,CAAC,GAAGR,OAAO,CAACM,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AAACQ,OAAA,CAAAZ,sBAAA,GAAAA,sBAAA;AACK,MAAMa,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAAC,IAAAC,oBAAS,EAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOnB,sBAAsB,CAACe,YAAY,CAAC;AAC7C,CAAC;AAAAH,OAAA,CAAAC,gCAAA,GAAAA,gCAAA"}

package/lib/edge/commonjs/functions/is-previewing.js

@@ -4,19 +4,29 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isPreviewing = isPreviewing;
-var _search2 = require("../helpers/search/search");
+var _search = require("../helpers/search/search");
 var _isBrowser = require("./is-browser");
-function isPreviewing(_search) {
-  const search = _search || ((0, _isBrowser.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.
+ */
+function isPreviewing(search) {
+  const searchToUse = search || ((0, _isBrowser.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 = (0, _search2.getSearchString)(search);
+  const normalizedSearch = (0, _search.getSearchString)(searchToUse);
   return Boolean(normalizedSearch.indexOf('builder.preview=') !== -1);
 }
 //# sourceMappingURL=is-previewing.js.map

package/lib/edge/commonjs/functions/is-previewing.js.map

@@ -1 +1 @@
-{"version":3,"names":["_search2","require","_isBrowser","isPreviewing","_search","search","isBrowser","window","location","undefined","normalizedSearch","getSearchString","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":";;;;;;AACA,IAAAA,QAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACO,SAASE,YAAYA,CAACC,OAAgB,EAAE;EAC7C,MAAMC,MAAM,GAAGD,OAAO,KAAK,IAAAE,oBAAS,EAAC,CAAC,GAAGC,MAAM,CAACC,QAAQ,CAACH,MAAM,GAAGI,SAAS,CAAC;;EAE5E;AACF;AACA;AACA;EACE,IAAI,CAACJ,MAAM,EAAE;IACX,OAAO,KAAK;EACd;EACA,MAAMK,gBAAgB,GAAG,IAAAC,wBAAe,EAACN,MAAM,CAAC;EAChD,OAAOO,OAAO,CAACF,gBAAgB,CAACG,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}
+{"version":3,"names":["_search","require","_isBrowser","isPreviewing","search","searchToUse","isBrowser","window","location","undefined","normalizedSearch","getSearchString","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,YAAYA,CAACC,MAAe,EAAE;EAC5C,MAAMC,WAAW,GAAGD,MAAM,KAAK,IAAAE,oBAAS,EAAC,CAAC,GAAGC,MAAM,CAACC,QAAQ,CAACJ,MAAM,GAAGK,SAAS,CAAC;;EAEhF;AACF;AACA;AACA;EACE,IAAI,CAACJ,WAAW,EAAE;IAChB,OAAO,KAAK;EACd;EACA,MAAMK,gBAAgB,GAAG,IAAAC,uBAAe,EAACN,WAAW,CAAC;EACrD,OAAOO,OAAO,CAACF,gBAAgB,CAACG,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}

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

@@ -1,2 +1,2 @@
-export const SDK_VERSION = "4.2.3";
+export const SDK_VERSION = "4.2.4";
 //# sourceMappingURL=sdk-version.js.map

package/lib/edge/module/functions/get-builder-search-params/index.js

@@ -4,8 +4,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/lib/edge/module/functions/get-builder-search-params/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["normalizeSearchParams","isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","getBuilderSearchParamsFromWindow","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":"AACA,SAASA,qBAAqB;AAC9B,SAASC,SAAS;AAClB,MAAMC,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAGN,qBAAqB,CAACK,QAAQ,CAAC;EAC/C,MAAME,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACH,OAAO,CAAC,CAACI,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACV,2BAA2B,CAAC,EAAE;MAC/C,MAAMW,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACZ,2BAA2B,EAAE,EAAE,CAAC,CAACY,OAAO,CAACX,sBAAsB,EAAE,EAAE,CAAC;MACnGI,UAAU,CAACM,UAAU,CAAC,GAAGP,OAAO,CAACK,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AACD,OAAO,MAAMQ,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAACd,SAAS,CAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMe,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOhB,sBAAsB,CAACY,YAAY,CAAC;AAC7C,CAAC"}
+{"version":3,"names":["normalizeSearchParams","isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","getBuilderSearchParamsFromWindow","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":"AACA,SAASA,qBAAqB;AAC9B,SAASC,SAAS;AAClB,MAAMC,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAGN,qBAAqB,CAACK,QAAQ,CAAC;EAC/C,MAAME,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACH,OAAO,CAAC,CAACI,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACV,2BAA2B,CAAC,EAAE;MAC/C,MAAMW,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACZ,2BAA2B,EAAE,EAAE,CAAC,CAACY,OAAO,CAACX,sBAAsB,EAAE,EAAE,CAAC;MACnGI,UAAU,CAACM,UAAU,CAAC,GAAGP,OAAO,CAACK,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AACD,OAAO,MAAMQ,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAACd,SAAS,CAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMe,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOhB,sBAAsB,CAACY,YAAY,CAAC;AAC7C,CAAC"}

package/lib/edge/module/functions/is-previewing.js

@@ -1,16 +1,27 @@
 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);
 }
 //# sourceMappingURL=is-previewing.js.map

package/lib/edge/module/functions/is-previewing.js.map

@@ -1 +1 @@
-{"version":3,"names":["getSearchString","isBrowser","isPreviewing","_search","search","window","location","undefined","normalizedSearch","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":"AACA,SAASA,eAAe;AACxB,SAASC,SAAS;AAClB,OAAO,SAASC,YAAYA,CAACC,OAAgB,EAAE;EAC7C,MAAMC,MAAM,GAAGD,OAAO,KAAKF,SAAS,CAAC,CAAC,GAAGI,MAAM,CAACC,QAAQ,CAACF,MAAM,GAAGG,SAAS,CAAC;;EAE5E;AACF;AACA;AACA;EACE,IAAI,CAACH,MAAM,EAAE;IACX,OAAO,KAAK;EACd;EACA,MAAMI,gBAAgB,GAAGR,eAAe,CAACI,MAAM,CAAC;EAChD,OAAOK,OAAO,CAACD,gBAAgB,CAACE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}
+{"version":3,"names":["getSearchString","isBrowser","isPreviewing","search","searchToUse","window","location","undefined","normalizedSearch","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":"AACA,SAASA,eAAe;AACxB,SAASC,SAAS;;AAElB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,MAAe,EAAE;EAC5C,MAAMC,WAAW,GAAGD,MAAM,KAAKF,SAAS,CAAC,CAAC,GAAGI,MAAM,CAACC,QAAQ,CAACH,MAAM,GAAGI,SAAS,CAAC;;EAEhF;AACF;AACA;AACA;EACE,IAAI,CAACH,WAAW,EAAE;IAChB,OAAO,KAAK;EACd;EACA,MAAMI,gBAAgB,GAAGR,eAAe,CAACI,WAAW,CAAC;EACrD,OAAOK,OAAO,CAACD,gBAAgB,CAACE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}

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

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "4.2.3";
+export declare const SDK_VERSION = "4.2.4";
 //# sourceMappingURL=sdk-version.d.ts.map

package/lib/edge/typescript/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/typescript/functions/get-builder-search-params/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/functions/get-builder-search-params/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAM/D;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,aAAc,WAAW,GAAG,eAAe,GAAG,SAAS,gBAazF,CAAC;AACF,eAAO,MAAM,gCAAgC,mBAM5C,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/functions/get-builder-search-params/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAM/D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,aAAc,WAAW,GAAG,eAAe,GAAG,SAAS,gBAazF,CAAC;AACF,eAAO,MAAM,gCAAgC,mBAM5C,CAAA"}

package/lib/edge/typescript/functions/is-previewing.d.ts

@@ -1,3 +1,13 @@
 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;
 //# sourceMappingURL=is-previewing.d.ts.map

package/lib/edge/typescript/functions/is-previewing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-previewing.d.ts","sourceRoot":"","sources":["../../../../src/functions/is-previewing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAGvD,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,WAY5C"}
+{"version":3,"file":"is-previewing.d.ts","sourceRoot":"","sources":["../../../../src/functions/is-previewing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAIvD;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,WAY3C"}

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

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.SDK_VERSION = void 0;
-const SDK_VERSION = exports.SDK_VERSION = "4.2.3";
+const SDK_VERSION = exports.SDK_VERSION = "4.2.4";
 //# sourceMappingURL=sdk-version.js.map

package/lib/node/commonjs/functions/get-builder-search-params/index.js

@@ -10,8 +10,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/lib/node/commonjs/functions/get-builder-search-params/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_search","require","_isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","normalizeSearchParams","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","exports","getBuilderSearchParamsFromWindow","isBrowser","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACA,MAAME,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAG,IAAAC,6BAAqB,EAACF,QAAQ,CAAC;EAC/C,MAAMG,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACJ,OAAO,CAAC,CAACK,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACX,2BAA2B,CAAC,EAAE;MAC/C,MAAMY,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACb,2BAA2B,EAAE,EAAE,CAAC,CAACa,OAAO,CAACZ,sBAAsB,EAAE,EAAE,CAAC;MACnGK,UAAU,CAACM,UAAU,CAAC,GAAGR,OAAO,CAACM,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AAACQ,OAAA,CAAAZ,sBAAA,GAAAA,sBAAA;AACK,MAAMa,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAAC,IAAAC,oBAAS,EAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOnB,sBAAsB,CAACe,YAAY,CAAC;AAC7C,CAAC;AAAAH,OAAA,CAAAC,gCAAA,GAAAA,gCAAA"}
+{"version":3,"names":["_search","require","_isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","normalizeSearchParams","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","exports","getBuilderSearchParamsFromWindow","isBrowser","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACA,MAAME,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAG,IAAAC,6BAAqB,EAACF,QAAQ,CAAC;EAC/C,MAAMG,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACJ,OAAO,CAAC,CAACK,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACX,2BAA2B,CAAC,EAAE;MAC/C,MAAMY,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACb,2BAA2B,EAAE,EAAE,CAAC,CAACa,OAAO,CAACZ,sBAAsB,EAAE,EAAE,CAAC;MACnGK,UAAU,CAACM,UAAU,CAAC,GAAGR,OAAO,CAACM,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AAACQ,OAAA,CAAAZ,sBAAA,GAAAA,sBAAA;AACK,MAAMa,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAAC,IAAAC,oBAAS,EAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOnB,sBAAsB,CAACe,YAAY,CAAC;AAC7C,CAAC;AAAAH,OAAA,CAAAC,gCAAA,GAAAA,gCAAA"}

package/lib/node/commonjs/functions/is-previewing.js

@@ -4,19 +4,29 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isPreviewing = isPreviewing;
-var _search2 = require("../helpers/search/search");
+var _search = require("../helpers/search/search");
 var _isBrowser = require("./is-browser");
-function isPreviewing(_search) {
-  const search = _search || ((0, _isBrowser.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.
+ */
+function isPreviewing(search) {
+  const searchToUse = search || ((0, _isBrowser.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 = (0, _search2.getSearchString)(search);
+  const normalizedSearch = (0, _search.getSearchString)(searchToUse);
   return Boolean(normalizedSearch.indexOf('builder.preview=') !== -1);
 }
 //# sourceMappingURL=is-previewing.js.map

package/lib/node/commonjs/functions/is-previewing.js.map

@@ -1 +1 @@
-{"version":3,"names":["_search2","require","_isBrowser","isPreviewing","_search","search","isBrowser","window","location","undefined","normalizedSearch","getSearchString","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":";;;;;;AACA,IAAAA,QAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACO,SAASE,YAAYA,CAACC,OAAgB,EAAE;EAC7C,MAAMC,MAAM,GAAGD,OAAO,KAAK,IAAAE,oBAAS,EAAC,CAAC,GAAGC,MAAM,CAACC,QAAQ,CAACH,MAAM,GAAGI,SAAS,CAAC;;EAE5E;AACF;AACA;AACA;EACE,IAAI,CAACJ,MAAM,EAAE;IACX,OAAO,KAAK;EACd;EACA,MAAMK,gBAAgB,GAAG,IAAAC,wBAAe,EAACN,MAAM,CAAC;EAChD,OAAOO,OAAO,CAACF,gBAAgB,CAACG,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}
+{"version":3,"names":["_search","require","_isBrowser","isPreviewing","search","searchToUse","isBrowser","window","location","undefined","normalizedSearch","getSearchString","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,YAAYA,CAACC,MAAe,EAAE;EAC5C,MAAMC,WAAW,GAAGD,MAAM,KAAK,IAAAE,oBAAS,EAAC,CAAC,GAAGC,MAAM,CAACC,QAAQ,CAACJ,MAAM,GAAGK,SAAS,CAAC;;EAEhF;AACF;AACA;AACA;EACE,IAAI,CAACJ,WAAW,EAAE;IAChB,OAAO,KAAK;EACd;EACA,MAAMK,gBAAgB,GAAG,IAAAC,uBAAe,EAACN,WAAW,CAAC;EACrD,OAAOO,OAAO,CAACF,gBAAgB,CAACG,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}

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

@@ -1,2 +1,2 @@
-export const SDK_VERSION = "4.2.3";
+export const SDK_VERSION = "4.2.4";
 //# sourceMappingURL=sdk-version.js.map

package/lib/node/module/functions/get-builder-search-params/index.js

@@ -4,8 +4,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/lib/node/module/functions/get-builder-search-params/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["normalizeSearchParams","isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","getBuilderSearchParamsFromWindow","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":"AACA,SAASA,qBAAqB;AAC9B,SAASC,SAAS;AAClB,MAAMC,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAGN,qBAAqB,CAACK,QAAQ,CAAC;EAC/C,MAAME,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACH,OAAO,CAAC,CAACI,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACV,2BAA2B,CAAC,EAAE;MAC/C,MAAMW,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACZ,2BAA2B,EAAE,EAAE,CAAC,CAACY,OAAO,CAACX,sBAAsB,EAAE,EAAE,CAAC;MACnGI,UAAU,CAACM,UAAU,CAAC,GAAGP,OAAO,CAACK,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AACD,OAAO,MAAMQ,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAACd,SAAS,CAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMe,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOhB,sBAAsB,CAACY,YAAY,CAAC;AAC7C,CAAC"}
+{"version":3,"names":["normalizeSearchParams","isBrowser","BUILDER_SEARCHPARAMS_PREFIX","BUILDER_OPTIONS_PREFIX","getBuilderSearchParams","_options","options","newOptions","Object","keys","forEach","key","startsWith","trimmedKey","replace","getBuilderSearchParamsFromWindow","searchParams","URLSearchParams","window","location","search"],"sourceRoot":"../../../../../src","sources":["functions/get-builder-search-params/index.ts"],"mappings":"AACA,SAASA,qBAAqB;AAC9B,SAASC,SAAS;AAClB,MAAMC,2BAA2B,GAAG,UAAU;AAC9C,MAAMC,sBAAsB,GAAG,UAAU;;AAEzC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAIC,QAAmD,IAAK;EAC7F,IAAI,CAACA,QAAQ,EAAE;IACb,OAAO,CAAC,CAAC;EACX;EACA,MAAMC,OAAO,GAAGN,qBAAqB,CAACK,QAAQ,CAAC;EAC/C,MAAME,UAAuB,GAAG,CAAC,CAAC;EAClCC,MAAM,CAACC,IAAI,CAACH,OAAO,CAAC,CAACI,OAAO,CAACC,GAAG,IAAI;IAClC,IAAIA,GAAG,CAACC,UAAU,CAACV,2BAA2B,CAAC,EAAE;MAC/C,MAAMW,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACZ,2BAA2B,EAAE,EAAE,CAAC,CAACY,OAAO,CAACX,sBAAsB,EAAE,EAAE,CAAC;MACnGI,UAAU,CAACM,UAAU,CAAC,GAAGP,OAAO,CAACK,GAAG,CAAC;IACvC;EACF,CAAC,CAAC;EACF,OAAOJ,UAAU;AACnB,CAAC;AACD,OAAO,MAAMQ,gCAAgC,GAAGA,CAAA,KAAM;EACpD,IAAI,CAACd,SAAS,CAAC,CAAC,EAAE;IAChB,OAAO,CAAC,CAAC;EACX;EACA,MAAMe,YAAY,GAAG,IAAIC,eAAe,CAACC,MAAM,CAACC,QAAQ,CAACC,MAAM,CAAC;EAChE,OAAOhB,sBAAsB,CAACY,YAAY,CAAC;AAC7C,CAAC"}

package/lib/node/module/functions/is-previewing.js

@@ -1,16 +1,27 @@
 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);
 }
 //# sourceMappingURL=is-previewing.js.map

package/lib/node/module/functions/is-previewing.js.map

@@ -1 +1 @@
-{"version":3,"names":["getSearchString","isBrowser","isPreviewing","_search","search","window","location","undefined","normalizedSearch","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":"AACA,SAASA,eAAe;AACxB,SAASC,SAAS;AAClB,OAAO,SAASC,YAAYA,CAACC,OAAgB,EAAE;EAC7C,MAAMC,MAAM,GAAGD,OAAO,KAAKF,SAAS,CAAC,CAAC,GAAGI,MAAM,CAACC,QAAQ,CAACF,MAAM,GAAGG,SAAS,CAAC;;EAE5E;AACF;AACA;AACA;EACE,IAAI,CAACH,MAAM,EAAE;IACX,OAAO,KAAK;EACd;EACA,MAAMI,gBAAgB,GAAGR,eAAe,CAACI,MAAM,CAAC;EAChD,OAAOK,OAAO,CAACD,gBAAgB,CAACE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}
+{"version":3,"names":["getSearchString","isBrowser","isPreviewing","search","searchToUse","window","location","undefined","normalizedSearch","Boolean","indexOf"],"sourceRoot":"../../../../src","sources":["functions/is-previewing.ts"],"mappings":"AACA,SAASA,eAAe;AACxB,SAASC,SAAS;;AAElB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,MAAe,EAAE;EAC5C,MAAMC,WAAW,GAAGD,MAAM,KAAKF,SAAS,CAAC,CAAC,GAAGI,MAAM,CAACC,QAAQ,CAACH,MAAM,GAAGI,SAAS,CAAC;;EAEhF;AACF;AACA;AACA;EACE,IAAI,CAACH,WAAW,EAAE;IAChB,OAAO,KAAK;EACd;EACA,MAAMI,gBAAgB,GAAGR,eAAe,CAACI,WAAW,CAAC;EACrD,OAAOK,OAAO,CAACD,gBAAgB,CAACE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE"}

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

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "4.2.3";
+export declare const SDK_VERSION = "4.2.4";
 //# sourceMappingURL=sdk-version.d.ts.map

package/lib/node/typescript/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/typescript/functions/get-builder-search-params/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/functions/get-builder-search-params/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAM/D;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,aAAc,WAAW,GAAG,eAAe,GAAG,SAAS,gBAazF,CAAC;AACF,eAAO,MAAM,gCAAgC,mBAM5C,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/functions/get-builder-search-params/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAM/D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,aAAc,WAAW,GAAG,eAAe,GAAG,SAAS,gBAazF,CAAC;AACF,eAAO,MAAM,gCAAgC,mBAM5C,CAAA"}

package/lib/node/typescript/functions/is-previewing.d.ts

@@ -1,3 +1,13 @@
 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;
 //# sourceMappingURL=is-previewing.d.ts.map

package/lib/node/typescript/functions/is-previewing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-previewing.d.ts","sourceRoot":"","sources":["../../../../src/functions/is-previewing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAGvD,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,WAY5C"}
+{"version":3,"file":"is-previewing.d.ts","sourceRoot":"","sources":["../../../../src/functions/is-previewing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAIvD;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,WAY3C"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@builder.io/sdk-react-native",
   "description": "Builder.io SDK for React Native",
-  "version": "4.2.3",
+  "version": "4.2.4",
   "homepage": "https://github.com/BuilderIO/builder/tree/main/packages/sdks/output/react-native",
   "repository": {
     "type": "git",

package/src/constants/sdk-version.ts

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

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);
 }