@sitecore-jss/sitecore-jss 21.10.0 → 21.10.1

package/dist/cjs/utils/index.js

@@ -3,13 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapButtonToCommand = exports.DefaultEditFrameButtonIds = exports.DefaultEditFrameButtons = exports.DefaultEditFrameButton = exports.handleEditorAnchors = exports.resetEditorChromes = exports.isEditorActive = exports.HorizonEditor = exports.ExperienceEditor = exports.tryParseEnvValue = exports.isTimeoutError = exports.isAbsoluteUrl = exports.resolveUrl = exports.isServer = void 0;
+exports.mapButtonToCommand = exports.DefaultEditFrameButtonIds = exports.DefaultEditFrameButtons = exports.DefaultEditFrameButton = exports.handleEditorAnchors = exports.resetEditorChromes = exports.isEditorActive = exports.HorizonEditor = exports.ExperienceEditor = exports.tryParseEnvValue = exports.getAllowedOriginsFromEnv = exports.mergeURLSearchParams = exports.escapeNonSpecialQuestionMarks = exports.areURLSearchParamsEqual = exports.isRegexOrUrl = exports.isTimeoutError = exports.isAbsoluteUrl = exports.resolveUrl = exports.isServer = void 0;
 var is_server_1 = require("./is-server");
 Object.defineProperty(exports, "isServer", { enumerable: true, get: function () { return __importDefault(is_server_1).default; } });
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "resolveUrl", { enumerable: true, get: function () { return utils_1.resolveUrl; } });
 Object.defineProperty(exports, "isAbsoluteUrl", { enumerable: true, get: function () { return utils_1.isAbsoluteUrl; } });
 Object.defineProperty(exports, "isTimeoutError", { enumerable: true, get: function () { return utils_1.isTimeoutError; } });
+Object.defineProperty(exports, "isRegexOrUrl", { enumerable: true, get: function () { return utils_1.isRegexOrUrl; } });
+Object.defineProperty(exports, "areURLSearchParamsEqual", { enumerable: true, get: function () { return utils_1.areURLSearchParamsEqual; } });
+Object.defineProperty(exports, "escapeNonSpecialQuestionMarks", { enumerable: true, get: function () { return utils_1.escapeNonSpecialQuestionMarks; } });
+Object.defineProperty(exports, "mergeURLSearchParams", { enumerable: true, get: function () { return utils_1.mergeURLSearchParams; } });
+Object.defineProperty(exports, "getAllowedOriginsFromEnv", { enumerable: true, get: function () { return utils_1.getAllowedOriginsFromEnv; } });
 var env_1 = require("./env");
 Object.defineProperty(exports, "tryParseEnvValue", { enumerable: true, get: function () { return env_1.tryParseEnvValue; } });
 var editing_1 = require("./editing");

package/dist/cjs/utils/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTimeoutError = exports.isAbsoluteUrl = exports.resolveUrl = void 0;
+exports.mergeURLSearchParams = exports.escapeNonSpecialQuestionMarks = exports.areURLSearchParamsEqual = exports.isRegexOrUrl = exports.getAllowedOriginsFromEnv = exports.isTimeoutError = exports.isAbsoluteUrl = exports.resolveUrl = void 0;
 const is_server_1 = __importDefault(require("./is-server"));
 /**
  * note: encodeURIComponent is available via browser (window) or natively in node.js
@@ -72,3 +72,82 @@ const isTimeoutError = (error) => {
         error.name === 'AbortError');
 };
 exports.isTimeoutError = isTimeoutError;
+/**
+ * Gets allowed origins from JSS_ALLOWED_ORIGINS env variable
+ * @returns {string[]} list of allowed origins from JSS_ALLOWED_ORIGINS env variable
+ */
+const getAllowedOriginsFromEnv = () => process.env.JSS_ALLOWED_ORIGINS
+    ? process.env.JSS_ALLOWED_ORIGINS.replace(' ', '').split(',')
+    : [];
+exports.getAllowedOriginsFromEnv = getAllowedOriginsFromEnv;
+/**
+ * Determines whether the given input is a regular expression or resembles a URL.
+ * @param {string} input - The input string to evaluate.
+ * @returns {'regex' | 'url'} - Returns 'url' if the input looks like a URL, otherwise 'regex'.
+ */
+const isRegexOrUrl = (input) => {
+    // Remove the trailing slash.
+    input = input.slice(0, -1);
+    // Check if the string resembles a URL.
+    const isUrlLike = /^\/[a-zA-Z0-9\-\/]+(\?([a-zA-Z0-9\-_]+=[a-zA-Z0-9\-_]+)(&[a-zA-Z0-9\-_]+=[a-zA-Z0-9\-_]+)*)?$/.test(input);
+    if (isUrlLike) {
+        return 'url';
+    }
+    // If it doesn't resemble a URL, it's likely a regular expression.
+    return 'regex';
+};
+exports.isRegexOrUrl = isRegexOrUrl;
+/**
+ * Compares two URLSearchParams objects to determine if they are equal.
+ * @param {URLSearchParams} params1 - The first set of URL search parameters.
+ * @param {URLSearchParams} params2 - The second set of URL search parameters.
+ * @returns {boolean} - Returns true if the parameters are equal, otherwise false.
+ */
+const areURLSearchParamsEqual = (params1, params2) => {
+    // Generates a sorted string representation of URL search parameters.
+    const getSortedParamsString = (params) => {
+        return [...params.entries()]
+            .sort(([keyA], [keyB]) => keyA.localeCompare(keyB))
+            .map(([key, value]) => `${key}=${value}`)
+            .join('&');
+    };
+    // Compare the sorted strings of both parameter sets.
+    return getSortedParamsString(params1) === getSortedParamsString(params2);
+};
+exports.areURLSearchParamsEqual = areURLSearchParamsEqual;
+/**
+ * Escapes non-special "?" characters in a string or regex.
+ * - For regular strings, it escapes all unescaped "?" characters by adding a backslash (`\`).
+ * - For regex patterns (strings enclosed in `/.../`), it analyzes each "?" to determine if it has special meaning
+ *   (e.g., `?` in `(abc)?`, `.*?`, `(?!...)`) or is just a literal character. Only literal "?" characters are escaped.
+ * @param {string} input - The input string or regex pattern.
+ * @returns {string} - The modified string or regex with non-special "?" characters escaped.
+ */
+const escapeNonSpecialQuestionMarks = (input) => {
+    // If the input is already a regex pattern (starts with ^ or ends with $), return it unchanged
+    if (input.startsWith('^') || input.endsWith('$')) {
+        return input;
+    }
+    // For non-regex strings, escape literal "?" characters
+    return input.replace(/\?/g, '\\?');
+};
+exports.escapeNonSpecialQuestionMarks = escapeNonSpecialQuestionMarks;
+/**
+ * Merges two URLSearchParams objects. If both objects contain the same key, the value from the second object overrides the first.
+ * @param {URLSearchParams} params1 - The first set of URL search parameters.
+ * @param {URLSearchParams} params2 - The second set of URL search parameters.
+ * @returns {string} - A string representation of the merged URL search parameters.
+ */
+const mergeURLSearchParams = (params1, params2) => {
+    const merged = new URLSearchParams();
+    // Add all keys and values from the first object.
+    for (const [key, value] of params1.entries()) {
+        merged.set(key, value);
+    }
+    // Add all keys and values from the second object, replacing existing ones.
+    for (const [key, value] of params2.entries()) {
+        merged.set(key, value);
+    }
+    return merged.toString();
+};
+exports.mergeURLSearchParams = mergeURLSearchParams;

package/dist/esm/utils/index.js

@@ -1,5 +1,5 @@
 export { default as isServer } from './is-server';
-export { resolveUrl, isAbsoluteUrl, isTimeoutError } from './utils';
+export { resolveUrl, isAbsoluteUrl, isTimeoutError, isRegexOrUrl, areURLSearchParamsEqual, escapeNonSpecialQuestionMarks, mergeURLSearchParams, getAllowedOriginsFromEnv, } from './utils';
 export { tryParseEnvValue } from './env';
 export { ExperienceEditor, HorizonEditor, isEditorActive, resetEditorChromes, handleEditorAnchors, } from './editing';
 export { DefaultEditFrameButton, DefaultEditFrameButtons, DefaultEditFrameButtonIds, mapButtonToCommand, } from './edit-frame';

package/dist/esm/utils/utils.js

@@ -63,3 +63,77 @@ export const isTimeoutError = (error) => {
         ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 408 ||
         error.name === 'AbortError');
 };
+/**
+ * Gets allowed origins from JSS_ALLOWED_ORIGINS env variable
+ * @returns {string[]} list of allowed origins from JSS_ALLOWED_ORIGINS env variable
+ */
+export const getAllowedOriginsFromEnv = () => process.env.JSS_ALLOWED_ORIGINS
+    ? process.env.JSS_ALLOWED_ORIGINS.replace(' ', '').split(',')
+    : [];
+/**
+ * Determines whether the given input is a regular expression or resembles a URL.
+ * @param {string} input - The input string to evaluate.
+ * @returns {'regex' | 'url'} - Returns 'url' if the input looks like a URL, otherwise 'regex'.
+ */
+export const isRegexOrUrl = (input) => {
+    // Remove the trailing slash.
+    input = input.slice(0, -1);
+    // Check if the string resembles a URL.
+    const isUrlLike = /^\/[a-zA-Z0-9\-\/]+(\?([a-zA-Z0-9\-_]+=[a-zA-Z0-9\-_]+)(&[a-zA-Z0-9\-_]+=[a-zA-Z0-9\-_]+)*)?$/.test(input);
+    if (isUrlLike) {
+        return 'url';
+    }
+    // If it doesn't resemble a URL, it's likely a regular expression.
+    return 'regex';
+};
+/**
+ * Compares two URLSearchParams objects to determine if they are equal.
+ * @param {URLSearchParams} params1 - The first set of URL search parameters.
+ * @param {URLSearchParams} params2 - The second set of URL search parameters.
+ * @returns {boolean} - Returns true if the parameters are equal, otherwise false.
+ */
+export const areURLSearchParamsEqual = (params1, params2) => {
+    // Generates a sorted string representation of URL search parameters.
+    const getSortedParamsString = (params) => {
+        return [...params.entries()]
+            .sort(([keyA], [keyB]) => keyA.localeCompare(keyB))
+            .map(([key, value]) => `${key}=${value}`)
+            .join('&');
+    };
+    // Compare the sorted strings of both parameter sets.
+    return getSortedParamsString(params1) === getSortedParamsString(params2);
+};
+/**
+ * Escapes non-special "?" characters in a string or regex.
+ * - For regular strings, it escapes all unescaped "?" characters by adding a backslash (`\`).
+ * - For regex patterns (strings enclosed in `/.../`), it analyzes each "?" to determine if it has special meaning
+ *   (e.g., `?` in `(abc)?`, `.*?`, `(?!...)`) or is just a literal character. Only literal "?" characters are escaped.
+ * @param {string} input - The input string or regex pattern.
+ * @returns {string} - The modified string or regex with non-special "?" characters escaped.
+ */
+export const escapeNonSpecialQuestionMarks = (input) => {
+    // If the input is already a regex pattern (starts with ^ or ends with $), return it unchanged
+    if (input.startsWith('^') || input.endsWith('$')) {
+        return input;
+    }
+    // For non-regex strings, escape literal "?" characters
+    return input.replace(/\?/g, '\\?');
+};
+/**
+ * Merges two URLSearchParams objects. If both objects contain the same key, the value from the second object overrides the first.
+ * @param {URLSearchParams} params1 - The first set of URL search parameters.
+ * @param {URLSearchParams} params2 - The second set of URL search parameters.
+ * @returns {string} - A string representation of the merged URL search parameters.
+ */
+export const mergeURLSearchParams = (params1, params2) => {
+    const merged = new URLSearchParams();
+    // Add all keys and values from the first object.
+    for (const [key, value] of params1.entries()) {
+        merged.set(key, value);
+    }
+    // Add all keys and values from the second object, replacing existing ones.
+    for (const [key, value] of params2.entries()) {
+        merged.set(key, value);
+    }
+    return merged.toString();
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss",
-  "version": "21.10.0",
+  "version": "21.10.1",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -65,7 +65,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "599ccf7d2789491a0847540adca697fa580d735f",
+  "gitHead": "aaeb09bfb4b3e9a40f2799342feebfaa4cf5f619",
   "files": [
     "dist",
     "types",

package/types/utils/index.d.ts

@@ -1,5 +1,5 @@
 export { default as isServer } from './is-server';
-export { resolveUrl, isAbsoluteUrl, isTimeoutError } from './utils';
+export { resolveUrl, isAbsoluteUrl, isTimeoutError, isRegexOrUrl, areURLSearchParamsEqual, escapeNonSpecialQuestionMarks, mergeURLSearchParams, getAllowedOriginsFromEnv, } from './utils';
 export { tryParseEnvValue } from './env';
 export { ExperienceEditor, HorizonEditor, isEditorActive, resetEditorChromes, handleEditorAnchors, Metadata, } from './editing';
 export { DefaultEditFrameButton, DefaultEditFrameButtons, DefaultEditFrameButtonIds, EditFrameDataSource, ChromeCommand, FieldEditButton, WebEditButton, EditButtonTypes, mapButtonToCommand, } from './edit-frame';

package/types/utils/utils.d.ts

@@ -16,3 +16,37 @@ export declare const isAbsoluteUrl: (url: string) => boolean;
  * @returns {boolean} is timeout error
  */
 export declare const isTimeoutError: (error: unknown) => boolean;
+/**
+ * Gets allowed origins from JSS_ALLOWED_ORIGINS env variable
+ * @returns {string[]} list of allowed origins from JSS_ALLOWED_ORIGINS env variable
+ */
+export declare const getAllowedOriginsFromEnv: () => string[];
+/**
+ * Determines whether the given input is a regular expression or resembles a URL.
+ * @param {string} input - The input string to evaluate.
+ * @returns {'regex' | 'url'} - Returns 'url' if the input looks like a URL, otherwise 'regex'.
+ */
+export declare const isRegexOrUrl: (input: string) => 'regex' | 'url';
+/**
+ * Compares two URLSearchParams objects to determine if they are equal.
+ * @param {URLSearchParams} params1 - The first set of URL search parameters.
+ * @param {URLSearchParams} params2 - The second set of URL search parameters.
+ * @returns {boolean} - Returns true if the parameters are equal, otherwise false.
+ */
+export declare const areURLSearchParamsEqual: (params1: URLSearchParams, params2: URLSearchParams) => boolean;
+/**
+ * Escapes non-special "?" characters in a string or regex.
+ * - For regular strings, it escapes all unescaped "?" characters by adding a backslash (`\`).
+ * - For regex patterns (strings enclosed in `/.../`), it analyzes each "?" to determine if it has special meaning
+ *   (e.g., `?` in `(abc)?`, `.*?`, `(?!...)`) or is just a literal character. Only literal "?" characters are escaped.
+ * @param {string} input - The input string or regex pattern.
+ * @returns {string} - The modified string or regex with non-special "?" characters escaped.
+ */
+export declare const escapeNonSpecialQuestionMarks: (input: string) => string;
+/**
+ * Merges two URLSearchParams objects. If both objects contain the same key, the value from the second object overrides the first.
+ * @param {URLSearchParams} params1 - The first set of URL search parameters.
+ * @param {URLSearchParams} params2 - The second set of URL search parameters.
+ * @returns {string} - A string representation of the merged URL search parameters.
+ */
+export declare const mergeURLSearchParams: (params1: URLSearchParams, params2: URLSearchParams) => string;