@sitecore-jss/sitecore-jss-nextjs 22.1.4-canary.1 → 22.1.4-canary.2

package/dist/cjs/middleware/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MultisiteMiddleware = exports.PersonalizeMiddleware = exports.RedirectsMiddleware = exports.debug = void 0;
+exports.MultisiteMiddleware = exports.PersonalizeMiddleware = exports.RedirectsMiddleware = exports.MiddlewareBase = exports.debug = void 0;
 var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return sitecore_jss_1.debug; } });
+var middleware_1 = require("./middleware");
+Object.defineProperty(exports, "MiddlewareBase", { enumerable: true, get: function () { return middleware_1.MiddlewareBase; } });
 var redirects_middleware_1 = require("./redirects-middleware");
 Object.defineProperty(exports, "RedirectsMiddleware", { enumerable: true, get: function () { return redirects_middleware_1.RedirectsMiddleware; } });
 var personalize_middleware_1 = require("./personalize-middleware");

package/dist/cjs/middleware/redirects-middleware.js

@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedirectsMiddleware = void 0;
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const site_1 = require("@sitecore-jss/sitecore-jss/site");
+const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
 const server_1 = require("next/server");
 const regex_parser_1 = __importDefault(require("regex-parser"));
 const middleware_1 = require("./middleware");
@@ -64,13 +65,14 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                     !(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
                         existsRedirect.target.includes(hostname))) {
                     existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
+                    req.nextUrl.locale = site.language;
                 }
                 const url = this.normalizeUrl(req.nextUrl.clone());
                 if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
                     url.href = existsRedirect.target;
                 }
                 else {
-                    const source = `${url.pathname.replace(/\/*$/gi, '')}${url.search}`;
+                    const source = `${url.pathname.replace(/\/*$/gi, '')}${existsRedirect.matchedQueryString}`;
                     const urlFirstPart = existsRedirect.target.split('/')[1];
                     if (this.locales.includes(urlFirstPart)) {
                         req.nextUrl.locale = urlFirstPart;
@@ -92,18 +94,20 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                     }
                     const prepareNewURL = new URL(`${target[0]}${url.search}`, url.origin);
                     url.href = prepareNewURL.href;
+                    url.pathname = prepareNewURL.pathname;
+                    url.search = prepareNewURL.search;
+                    url.locale = req.nextUrl.locale;
                 }
-                const redirectUrl = decodeURIComponent(url.href);
                 /** return Response redirect with http code of redirect type **/
                 switch (existsRedirect.redirectType) {
                     case site_1.REDIRECT_TYPE_301: {
-                        return this.createRedirectResponse(redirectUrl, res, 301, 'Moved Permanently');
+                        return this.createRedirectResponse(url, res, 301, 'Moved Permanently');
                     }
                     case site_1.REDIRECT_TYPE_302: {
-                        return this.createRedirectResponse(redirectUrl, res, 302, 'Found');
+                        return this.createRedirectResponse(url, res, 302, 'Found');
                     }
                     case site_1.REDIRECT_TYPE_SERVER_TRANSFER: {
-                        return this.rewrite(redirectUrl, req, res || server_1.NextResponse.next());
+                        return this.rewrite(url.href, req, res || server_1.NextResponse.next());
                     }
                     default:
                         return res || server_1.NextResponse.next();
@@ -149,27 +153,58 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
     getExistsRedirect(req, siteName) {
         return __awaiter(this, void 0, void 0, function* () {
             const redirects = yield this.redirectsService.fetchRedirects(siteName);
-            const normalizedUrl = this.normalizeUrl(req.nextUrl.clone());
-            const tragetURL = normalizedUrl.pathname;
-            const targetQS = normalizedUrl.search || '';
+            const { pathname: targetURL, search: targetQS = '', locale } = this.normalizeUrl(req.nextUrl.clone());
             const language = this.getLanguage(req);
             const modifyRedirects = structuredClone(redirects);
             return modifyRedirects.length
                 ? modifyRedirects.find((redirect) => {
+                    // Modify the redirect pattern to ignore the language prefix in the path
                     redirect.pattern = redirect.pattern.replace(RegExp(`^[^]?/${language}/`, 'gi'), '');
+                    // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
                     redirect.pattern = `/^\/${redirect.pattern
-                        .replace(/^\/|\/$/g, '')
-                        .replace(/^\^\/|\/\$$/g, '')
-                        .replace(/^\^|\$$/g, '')
-                        .replace(/(?<!\\)\?/g, '\\?')
-                        .replace(/\$\/gi$/g, '')}[\/]?$/gi`;
-                    return (((0, regex_parser_1.default)(redirect.pattern).test(tragetURL) ||
-                        (0, regex_parser_1.default)(redirect.pattern).test(`${tragetURL.replace(/\/*$/gi, '')}${targetQS}`) ||
-                        (0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||
-                        (0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}${targetQS}`)) &&
-                        (redirect.locale
-                            ? redirect.locale.toLowerCase() === req.nextUrl.locale.toLowerCase()
-                            : true));
+                        .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
+                        .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
+                        .replace(/^\^|\$$/g, '') // Further cleans up anchors
+                        .replace(/(?<!\\)\?/g, '\\?') // Escapes question marks in the pattern
+                        .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
+                    /**
+                     * This line checks whether the current URL query string (and all its possible permutations)
+                     * matches the redirect pattern.
+                     *
+                     * Query parameters in URLs can come in different orders, but logically they represent the
+                     * same information (e.g., "key1=value1&key2=value2" is the same as "key2=value2&key1=value1").
+                     * To account for this, the method `isPermutedQueryMatch` generates all possible permutations
+                     * of the query parameters and checks if any of those permutations match the regex pattern for the redirect.
+                     *
+                     * NOTE: This fix is specifically implemented for Netlify, where query parameters are sometimes
+                     * automatically sorted, which can cause issues with matching redirects if the order of query
+                     * parameters is important. By checking every possible permutation, we ensure that redirects
+                     * work correctly on Netlify despite this behavior.
+                     *
+                     * It passes several pieces of information to the function:
+                     * 1. `pathname`: The normalized URL path without query parameters (e.g., '/about').
+                     * 2. `queryString`: The current query string from the URL, which will be permuted and matched (e.g., '?key1=value1&key2=value2').
+                     * 3. `pattern`: The regex pattern for the redirect that we are trying to match against the URL (e.g., '/about?key1=value1').
+                     * 4. `locale`: The locale part of the URL (if any), which helps support multilingual URLs.
+                     *
+                     * If one of the permutations of the query string matches the redirect pattern, the function
+                     * returns the matched query string, which is stored in `matchedQueryString`. If no match is found,
+                     * it returns `undefined`. The `matchedQueryString` is later used to indicate whether the query
+                     * string contributed to a successful redirect match.
+                     */
+                    const matchedQueryString = this.isPermutedQueryMatch({
+                        pathname: targetURL,
+                        queryString: targetQS,
+                        pattern: redirect.pattern,
+                        locale,
+                    });
+                    // Save the matched query string (if found) into the redirect object
+                    redirect.matchedQueryString = matchedQueryString || '';
+                    // Return the redirect if the URL path or any query string permutation matches the pattern
+                    return (((0, regex_parser_1.default)(redirect.pattern).test(targetURL) ||
+                        (0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${targetURL}`) ||
+                        matchedQueryString) &&
+                        (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
                 })
                 : undefined;
         });
@@ -178,7 +213,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
      * When a user clicks on a link generated by the Link component from next/link,
      * Next.js adds special parameters in the route called path.
      * This method removes these special parameters.
-     * @param {URL} url
+     * @param {NextURL} url
      * @returns {string} normalize url
      */
     normalizeUrl(url) {
@@ -208,14 +243,15 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
             return false;
         })
             .join('&');
-        if (newQueryString) {
-            return new URL(`${url.pathname}?${newQueryString}`, url.origin);
-        }
-        return new URL(`${url.pathname}`, url.origin);
+        const newUrl = new URL(`${url.pathname}?${newQueryString}`, url.origin);
+        url.search = newUrl.search;
+        url.pathname = newUrl.pathname;
+        url.href = newUrl.href;
+        return url;
     }
     /**
      * Helper function to create a redirect response and remove the x-middleware-next header.
-     * @param {string} url The URL to redirect to.
+     * @param {NextURL} url The URL to redirect to.
      * @param {Response} res The response object.
      * @param {number} status The HTTP status code of the redirect.
      * @param {string} statusText The status text of the redirect.
@@ -233,5 +269,24 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
         }
         return redirect;
     }
+    /**
+     * Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
+     * It constructs all possible query parameter permutations and tests them against the pattern.
+     * @param {Object} params - The parameters for the URL match.
+     * @param {string} params.pathname - The current URL pathname.
+     * @param {string} params.queryString - The current URL query string.
+     * @param {string} params.pattern - The regex pattern to test the constructed URLs against.
+     * @param {string} [params.locale] - The locale prefix to include in the URL if present.
+     * @returns {string | undefined} - return query string if any of the query permutations match the provided pattern, undefined otherwise.
+     */
+    isPermutedQueryMatch({ pathname, queryString, pattern, locale, }) {
+        const paramsArray = Array.from(new URLSearchParams(queryString).entries());
+        const listOfPermuted = (0, utils_1.getPermutations)(paramsArray).map((permutation) => '?' + permutation.map(([key, value]) => `${key}=${value}`).join('&'));
+        const normalizedPath = pathname.replace(/\/*$/gi, '');
+        return listOfPermuted.find((query) => [
+            (0, regex_parser_1.default)(pattern).test(`${normalizedPath}${query}`),
+            (0, regex_parser_1.default)(pattern).test(`/${locale}${normalizedPath}${query}`),
+        ].some(Boolean));
+    }
 }
 exports.RedirectsMiddleware = RedirectsMiddleware;

package/dist/esm/middleware/index.js

@@ -1,4 +1,5 @@
 export { debug } from '@sitecore-jss/sitecore-jss';
+export { MiddlewareBase } from './middleware';
 export { RedirectsMiddleware } from './redirects-middleware';
 export { PersonalizeMiddleware } from './personalize-middleware';
 export { MultisiteMiddleware } from './multisite-middleware';

package/dist/esm/middleware/redirects-middleware.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, } from '@sitecore-jss/sitecore-jss/site';
+import { getPermutations } from '@sitecore-jss/sitecore-jss/utils';
 import { NextResponse } from 'next/server';
 import regexParser from 'regex-parser';
 import { MiddlewareBase } from './middleware';
@@ -58,13 +59,14 @@ export class RedirectsMiddleware extends MiddlewareBase {
                     !(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
                         existsRedirect.target.includes(hostname))) {
                     existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
+                    req.nextUrl.locale = site.language;
                 }
                 const url = this.normalizeUrl(req.nextUrl.clone());
                 if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
                     url.href = existsRedirect.target;
                 }
                 else {
-                    const source = `${url.pathname.replace(/\/*$/gi, '')}${url.search}`;
+                    const source = `${url.pathname.replace(/\/*$/gi, '')}${existsRedirect.matchedQueryString}`;
                     const urlFirstPart = existsRedirect.target.split('/')[1];
                     if (this.locales.includes(urlFirstPart)) {
                         req.nextUrl.locale = urlFirstPart;
@@ -86,18 +88,20 @@ export class RedirectsMiddleware extends MiddlewareBase {
                     }
                     const prepareNewURL = new URL(`${target[0]}${url.search}`, url.origin);
                     url.href = prepareNewURL.href;
+                    url.pathname = prepareNewURL.pathname;
+                    url.search = prepareNewURL.search;
+                    url.locale = req.nextUrl.locale;
                 }
-                const redirectUrl = decodeURIComponent(url.href);
                 /** return Response redirect with http code of redirect type **/
                 switch (existsRedirect.redirectType) {
                     case REDIRECT_TYPE_301: {
-                        return this.createRedirectResponse(redirectUrl, res, 301, 'Moved Permanently');
+                        return this.createRedirectResponse(url, res, 301, 'Moved Permanently');
                     }
                     case REDIRECT_TYPE_302: {
-                        return this.createRedirectResponse(redirectUrl, res, 302, 'Found');
+                        return this.createRedirectResponse(url, res, 302, 'Found');
                     }
                     case REDIRECT_TYPE_SERVER_TRANSFER: {
-                        return this.rewrite(redirectUrl, req, res || NextResponse.next());
+                        return this.rewrite(url.href, req, res || NextResponse.next());
                     }
                     default:
                         return res || NextResponse.next();
@@ -143,27 +147,58 @@ export class RedirectsMiddleware extends MiddlewareBase {
     getExistsRedirect(req, siteName) {
         return __awaiter(this, void 0, void 0, function* () {
             const redirects = yield this.redirectsService.fetchRedirects(siteName);
-            const normalizedUrl = this.normalizeUrl(req.nextUrl.clone());
-            const tragetURL = normalizedUrl.pathname;
-            const targetQS = normalizedUrl.search || '';
+            const { pathname: targetURL, search: targetQS = '', locale } = this.normalizeUrl(req.nextUrl.clone());
             const language = this.getLanguage(req);
             const modifyRedirects = structuredClone(redirects);
             return modifyRedirects.length
                 ? modifyRedirects.find((redirect) => {
+                    // Modify the redirect pattern to ignore the language prefix in the path
                     redirect.pattern = redirect.pattern.replace(RegExp(`^[^]?/${language}/`, 'gi'), '');
+                    // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
                     redirect.pattern = `/^\/${redirect.pattern
-                        .replace(/^\/|\/$/g, '')
-                        .replace(/^\^\/|\/\$$/g, '')
-                        .replace(/^\^|\$$/g, '')
-                        .replace(/(?<!\\)\?/g, '\\?')
-                        .replace(/\$\/gi$/g, '')}[\/]?$/gi`;
-                    return ((regexParser(redirect.pattern).test(tragetURL) ||
-                        regexParser(redirect.pattern).test(`${tragetURL.replace(/\/*$/gi, '')}${targetQS}`) ||
-                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||
-                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}${targetQS}`)) &&
-                        (redirect.locale
-                            ? redirect.locale.toLowerCase() === req.nextUrl.locale.toLowerCase()
-                            : true));
+                        .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
+                        .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
+                        .replace(/^\^|\$$/g, '') // Further cleans up anchors
+                        .replace(/(?<!\\)\?/g, '\\?') // Escapes question marks in the pattern
+                        .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
+                    /**
+                     * This line checks whether the current URL query string (and all its possible permutations)
+                     * matches the redirect pattern.
+                     *
+                     * Query parameters in URLs can come in different orders, but logically they represent the
+                     * same information (e.g., "key1=value1&key2=value2" is the same as "key2=value2&key1=value1").
+                     * To account for this, the method `isPermutedQueryMatch` generates all possible permutations
+                     * of the query parameters and checks if any of those permutations match the regex pattern for the redirect.
+                     *
+                     * NOTE: This fix is specifically implemented for Netlify, where query parameters are sometimes
+                     * automatically sorted, which can cause issues with matching redirects if the order of query
+                     * parameters is important. By checking every possible permutation, we ensure that redirects
+                     * work correctly on Netlify despite this behavior.
+                     *
+                     * It passes several pieces of information to the function:
+                     * 1. `pathname`: The normalized URL path without query parameters (e.g., '/about').
+                     * 2. `queryString`: The current query string from the URL, which will be permuted and matched (e.g., '?key1=value1&key2=value2').
+                     * 3. `pattern`: The regex pattern for the redirect that we are trying to match against the URL (e.g., '/about?key1=value1').
+                     * 4. `locale`: The locale part of the URL (if any), which helps support multilingual URLs.
+                     *
+                     * If one of the permutations of the query string matches the redirect pattern, the function
+                     * returns the matched query string, which is stored in `matchedQueryString`. If no match is found,
+                     * it returns `undefined`. The `matchedQueryString` is later used to indicate whether the query
+                     * string contributed to a successful redirect match.
+                     */
+                    const matchedQueryString = this.isPermutedQueryMatch({
+                        pathname: targetURL,
+                        queryString: targetQS,
+                        pattern: redirect.pattern,
+                        locale,
+                    });
+                    // Save the matched query string (if found) into the redirect object
+                    redirect.matchedQueryString = matchedQueryString || '';
+                    // Return the redirect if the URL path or any query string permutation matches the pattern
+                    return ((regexParser(redirect.pattern).test(targetURL) ||
+                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${targetURL}`) ||
+                        matchedQueryString) &&
+                        (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
                 })
                 : undefined;
         });
@@ -172,7 +207,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
      * When a user clicks on a link generated by the Link component from next/link,
      * Next.js adds special parameters in the route called path.
      * This method removes these special parameters.
-     * @param {URL} url
+     * @param {NextURL} url
      * @returns {string} normalize url
      */
     normalizeUrl(url) {
@@ -202,14 +237,15 @@ export class RedirectsMiddleware extends MiddlewareBase {
             return false;
         })
             .join('&');
-        if (newQueryString) {
-            return new URL(`${url.pathname}?${newQueryString}`, url.origin);
-        }
-        return new URL(`${url.pathname}`, url.origin);
+        const newUrl = new URL(`${url.pathname}?${newQueryString}`, url.origin);
+        url.search = newUrl.search;
+        url.pathname = newUrl.pathname;
+        url.href = newUrl.href;
+        return url;
     }
     /**
      * Helper function to create a redirect response and remove the x-middleware-next header.
-     * @param {string} url The URL to redirect to.
+     * @param {NextURL} url The URL to redirect to.
      * @param {Response} res The response object.
      * @param {number} status The HTTP status code of the redirect.
      * @param {string} statusText The status text of the redirect.
@@ -227,4 +263,23 @@ export class RedirectsMiddleware extends MiddlewareBase {
         }
         return redirect;
     }
+    /**
+     * Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
+     * It constructs all possible query parameter permutations and tests them against the pattern.
+     * @param {Object} params - The parameters for the URL match.
+     * @param {string} params.pathname - The current URL pathname.
+     * @param {string} params.queryString - The current URL query string.
+     * @param {string} params.pattern - The regex pattern to test the constructed URLs against.
+     * @param {string} [params.locale] - The locale prefix to include in the URL if present.
+     * @returns {string | undefined} - return query string if any of the query permutations match the provided pattern, undefined otherwise.
+     */
+    isPermutedQueryMatch({ pathname, queryString, pattern, locale, }) {
+        const paramsArray = Array.from(new URLSearchParams(queryString).entries());
+        const listOfPermuted = getPermutations(paramsArray).map((permutation) => '?' + permutation.map(([key, value]) => `${key}=${value}`).join('&'));
+        const normalizedPath = pathname.replace(/\/*$/gi, '');
+        return listOfPermuted.find((query) => [
+            regexParser(pattern).test(`${normalizedPath}${query}`),
+            regexParser(pattern).test(`/${locale}${normalizedPath}${query}`),
+        ].some(Boolean));
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "22.1.4-canary.1",
+  "version": "22.1.4-canary.2",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -72,9 +72,9 @@
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^22.1.4-canary.1",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^22.1.4-canary.1",
-    "@sitecore-jss/sitecore-jss-react": "^22.1.4-canary.1",
+    "@sitecore-jss/sitecore-jss": "^22.1.4-canary.2",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^22.1.4-canary.2",
+    "@sitecore-jss/sitecore-jss-react": "^22.1.4-canary.2",
     "@vercel/kv": "^0.2.1",
     "prop-types": "^15.8.1",
     "regex-parser": "^2.2.11",
@@ -82,7 +82,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "7c36f5d86b9a748e33759219d53e0d93f7b4bfeb",
+  "gitHead": "9c234dbfd9a89e86bc4d2c2371b2e848e2df2291",
   "files": [
     "dist",
     "types",

package/types/middleware/index.d.ts

@@ -1,4 +1,5 @@
 export { debug } from '@sitecore-jss/sitecore-jss';
+export { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
 export { RedirectsMiddleware, RedirectsMiddlewareConfig } from './redirects-middleware';
 export { PersonalizeMiddleware, PersonalizeMiddlewareConfig } from './personalize-middleware';
 export { MultisiteMiddleware, MultisiteMiddlewareConfig } from './multisite-middleware';

package/types/middleware/redirects-middleware.d.ts

@@ -41,17 +41,28 @@ export declare class RedirectsMiddleware extends MiddlewareBase {
      * When a user clicks on a link generated by the Link component from next/link,
      * Next.js adds special parameters in the route called path.
      * This method removes these special parameters.
-     * @param {URL} url
+     * @param {NextURL} url
      * @returns {string} normalize url
      */
     private normalizeUrl;
     /**
      * Helper function to create a redirect response and remove the x-middleware-next header.
-     * @param {string} url The URL to redirect to.
+     * @param {NextURL} url The URL to redirect to.
      * @param {Response} res The response object.
      * @param {number} status The HTTP status code of the redirect.
      * @param {string} statusText The status text of the redirect.
      * @returns {NextResponse<unknown>} The redirect response.
      */
     private createRedirectResponse;
+    /**
+     * Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
+     * It constructs all possible query parameter permutations and tests them against the pattern.
+     * @param {Object} params - The parameters for the URL match.
+     * @param {string} params.pathname - The current URL pathname.
+     * @param {string} params.queryString - The current URL query string.
+     * @param {string} params.pattern - The regex pattern to test the constructed URLs against.
+     * @param {string} [params.locale] - The locale prefix to include in the URL if present.
+     * @returns {string | undefined} - return query string if any of the query permutations match the provided pattern, undefined otherwise.
+     */
+    private isPermutedQueryMatch;
 }