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

package/LICENSE.txt

@@ -1,202 +1,202 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,12 +1,12 @@
-# Sitecore JavaScript Rendering SDK for Next.js
-
-This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains Next.js components and integration for JSS.
-
-<!---
-@TODO: Update to next version docs before release
--->
-[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/22/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
-
-[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
-
+# Sitecore JavaScript Rendering SDK for Next.js
+
+This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains Next.js components and integration for JSS.
+
+<!---
+@TODO: Update to next version docs before release
+-->
+[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/22/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
+
+[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
+
 [API reference documentation](/ref-docs/sitecore-jss-nextjs/)

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.3",
+  "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.3",
-    "@sitecore-jss/sitecore-jss-dev-tools": "22.1.3",
-    "@sitecore-jss/sitecore-jss-react": "22.1.3",
+    "@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": "d070f807465c0c39f6b12406c28ee7649a8128fd",
+  "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;
 }