@sitecore-jss/sitecore-jss-nextjs 22.5.0 → 22.5.1-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/components/Link.js

@@ -67,14 +67,15 @@ exports.Link = (0, react_1.forwardRef)((props, ref) => {
         const isFileUrl = FILE_EXTENSION_MATCHER.test(href);
         // determine if a link is a route or not. File extensions are not routes and should not be pre-fetched.
         if (isMatching && !isFileUrl) {
-            return (react_1.default.createElement(link_1.default, Object.assign({ href: { pathname: href, query: querystring, hash: anchor }, key: "link", locale: false, title: value.title, target: value.target, className: value.class }, htmlLinkProps, { ref: ref }),
+            return (react_1.default.createElement(link_1.default, Object.assign({ href: { pathname: href, query: querystring, hash: anchor }, key: "link", locale: false, title: value.title, target: value.target, className: value.class, prefetch: props.prefetch }, htmlLinkProps, { ref: ref }),
                 text,
                 children));
         }
     }
-    // prevent passing internalLinkMatcher as it is an invalid DOM element prop
+    // prevent passing internalLinkMatcher or prefetch as it is an invalid DOM element prop
     const reactLinkProps = Object.assign({}, props);
     delete reactLinkProps.internalLinkMatcher;
+    delete reactLinkProps.prefetch;
     return react_1.default.createElement(sitecore_jss_react_1.Link, Object.assign({}, reactLinkProps, { ref: ref }));
 });
 exports.Link.displayName = 'NextLink';

package/dist/cjs/components/RichText.js

@@ -37,12 +37,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RichText = void 0;
+exports.RichText = exports.prefetched = void 0;
 const react_1 = __importStar(require("react"));
 const prop_types_1 = __importDefault(require("prop-types"));
 const router_1 = require("next/router");
 const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
-const prefetched = {};
+exports.prefetched = {};
 const RichText = (props) => {
     const { internalLinksSelector = 'a[href^="/"]', prefetchLinks = true, editable = true } = props, rest = __rest(props, ["internalLinksSelector", "prefetchLinks", "editable"]);
     const hasText = props.field && props.field.value;
@@ -50,7 +50,7 @@ const RichText = (props) => {
     const router = (0, router_1.useRouter)();
     const richTextRef = (0, react_1.useRef)(null);
     (0, react_1.useEffect)(() => {
-        // NOT IN EXPERIENCE EDITOR
+        // NOT IN EDIT MODE
         if (hasText && !isEditing) {
             initializeLinks();
         }
@@ -71,9 +71,21 @@ const RichText = (props) => {
         internalLinks.forEach((link) => {
             if (link.target === '_blank')
                 return;
-            if (prefetchLinks && !prefetched[link.pathname]) {
+            const prefetch = () => {
                 router.prefetch(link.pathname, undefined, { locale: false });
-                prefetched[link.pathname] = true;
+                exports.prefetched[link.pathname] = true;
+            };
+            if (!exports.prefetched[link.pathname] && prefetchLinks !== false) {
+                if (prefetchLinks === true) {
+                    prefetch();
+                }
+                if (prefetchLinks === 'hover') {
+                    const mouseOverHandler = () => {
+                        prefetch();
+                        link.removeEventListener('mouseover', mouseOverHandler);
+                    };
+                    link.addEventListener('mouseover', mouseOverHandler, false);
+                }
             }
             link.addEventListener('click', routeHandler, false);
         });

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

@@ -32,7 +32,84 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
     constructor(config) {
         super(config);
         this.config = config;
-        this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
+        // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
+        // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
+        this.redirectsService = new site_1.GraphQLRedirectsService(Object.assign(Object.assign({}, config), { fetch: fetch }));
+        this.locales = config.locales;
+    }
+    /**
+     * Gets the Next.js middleware handler with error handling
+     * @returns route handler
+     */
+    getHandler() {
+        return (req, res) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                return this.processRedirectRequest(req, res);
+            }
+            catch (error) {
+                console.log('Redirect middleware failed:');
+                console.log(error);
+                return res || server_1.NextResponse.next();
+            }
+        });
+    }
+    /**
+     * Method returns RedirectInfo when matches
+     * @param {NextRequest} req request
+     * @param {string} siteName site name
+     * @returns Promise<RedirectInfo | undefined> The redirect info or undefined if no redirect is found
+     * @protected
+     */
+    getExistsRedirect(req, siteName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { pathname: targetURL, search: targetQS = '', locale } = this.normalizeUrl(req.nextUrl.clone());
+            const normalizedPath = targetURL.replace(/\/*$/gi, '');
+            const redirects = yield this.redirectsService.fetchRedirects(siteName);
+            const language = this.getLanguage(req);
+            const modifyRedirects = structuredClone(redirects);
+            let matchedQueryString;
+            return modifyRedirects.length
+                ? modifyRedirects.find((redirect) => {
+                    var _a;
+                    if ((0, utils_1.isRegexOrUrl)(redirect.pattern) === 'url') {
+                        const parseUrlPattern = redirect.pattern.endsWith('/')
+                            ? redirect.pattern.slice(0, -1).split('?')
+                            : redirect.pattern.split('?');
+                        return ((parseUrlPattern[0] === normalizedPath ||
+                            parseUrlPattern[0] === `/${locale}${normalizedPath}`) &&
+                            (0, utils_1.areURLSearchParamsEqual)(new URLSearchParams((_a = parseUrlPattern[1]) !== null && _a !== void 0 ? _a : ''), new URLSearchParams(targetQS)));
+                    }
+                    // Modify the redirect pattern to ignore the language prefix in the path
+                    // And escapes non-special "?" characters in a string or regex.
+                    redirect.pattern = (0, utils_1.escapeNonSpecialQuestionMarks)(redirect.pattern.replace(new RegExp(`^[^]?/${language}/`, 'gi'), ''));
+                    // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
+                    redirect.pattern = `/^\/${redirect.pattern
+                        .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
+                        .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
+                        .replace(/^\^|\$$/g, '') // Further cleans up anchors
+                        .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
+                    matchedQueryString = [
+                        (0, regex_parser_1.default)(redirect.pattern).test(`${normalizedPath}${targetQS}`),
+                        (0, regex_parser_1.default)(redirect.pattern).test(`/${locale}${normalizedPath}${targetQS}`),
+                    ].some(Boolean)
+                        ? targetQS
+                        : undefined;
+                    // Save the matched query string (if found) into the redirect object
+                    redirect.matchedQueryString = matchedQueryString || '';
+                    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;
+        });
+    }
+    /**
+     * @param {NextRequest} req request
+     * @param {Response} res response
+     * @returns {Promise<NextResponse>} The redirect response.
+     */
+    processRedirectRequest(req, res) {
+        return __awaiter(this, void 0, void 0, function* () {
             const pathname = req.nextUrl.pathname;
             const language = this.getLanguage(req);
             const hostname = this.getHostHeader(req) || this.defaultHostname;
@@ -129,76 +206,6 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
             });
             return response;
         });
-        // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
-        // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
-        this.redirectsService = new site_1.GraphQLRedirectsService(Object.assign(Object.assign({}, config), { fetch: fetch }));
-        this.locales = config.locales;
-    }
-    /**
-     * Gets the Next.js middleware handler with error handling
-     * @returns route handler
-     */
-    getHandler() {
-        return (req, res) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield this.handler(req, res);
-            }
-            catch (error) {
-                console.log('Redirect middleware failed:');
-                console.log(error);
-                return res || server_1.NextResponse.next();
-            }
-        });
-    }
-    /**
-     * Method returns RedirectInfo when matches
-     * @param {NextRequest} req request
-     * @param {string} siteName site name
-     * @returns Promise<RedirectInfo | undefined>
-     * @private
-     */
-    getExistsRedirect(req, siteName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { pathname: targetURL, search: targetQS = '', locale } = this.normalizeUrl(req.nextUrl.clone());
-            const normalizedPath = targetURL.replace(/\/*$/gi, '');
-            const redirects = yield this.redirectsService.fetchRedirects(siteName);
-            const language = this.getLanguage(req);
-            const modifyRedirects = structuredClone(redirects);
-            let matchedQueryString;
-            return modifyRedirects.length
-                ? modifyRedirects.find((redirect) => {
-                    var _a;
-                    if ((0, utils_1.isRegexOrUrl)(redirect.pattern) === 'url') {
-                        const parseUrlPattern = redirect.pattern.endsWith('/')
-                            ? redirect.pattern.slice(0, -1).split('?')
-                            : redirect.pattern.split('?');
-                        return ((parseUrlPattern[0] === normalizedPath ||
-                            parseUrlPattern[0] === `/${locale}${normalizedPath}`) &&
-                            (0, utils_1.areURLSearchParamsEqual)(new URLSearchParams((_a = parseUrlPattern[1]) !== null && _a !== void 0 ? _a : ''), new URLSearchParams(targetQS)));
-                    }
-                    // Modify the redirect pattern to ignore the language prefix in the path
-                    // And escapes non-special "?" characters in a string or regex.
-                    redirect.pattern = (0, utils_1.escapeNonSpecialQuestionMarks)(redirect.pattern.replace(new RegExp(`^[^]?/${language}/`, 'gi'), ''));
-                    // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
-                    redirect.pattern = `/^\/${redirect.pattern
-                        .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
-                        .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
-                        .replace(/^\^|\$$/g, '') // Further cleans up anchors
-                        .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
-                    matchedQueryString = [
-                        (0, regex_parser_1.default)(redirect.pattern).test(`${normalizedPath}${targetQS}`),
-                        (0, regex_parser_1.default)(redirect.pattern).test(`/${locale}${normalizedPath}${targetQS}`),
-                    ].some(Boolean)
-                        ? targetQS
-                        : undefined;
-                    // Save the matched query string (if found) into the redirect object
-                    redirect.matchedQueryString = matchedQueryString || '';
-                    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;
-        });
     }
     /**
      * When a user clicks on a link generated by the Link component from next/link,

package/dist/esm/components/Link.js

@@ -38,14 +38,15 @@ export const Link = forwardRef((props, ref) => {
         const isFileUrl = FILE_EXTENSION_MATCHER.test(href);
         // determine if a link is a route or not. File extensions are not routes and should not be pre-fetched.
         if (isMatching && !isFileUrl) {
-            return (React.createElement(NextLink, Object.assign({ href: { pathname: href, query: querystring, hash: anchor }, key: "link", locale: false, title: value.title, target: value.target, className: value.class }, htmlLinkProps, { ref: ref }),
+            return (React.createElement(NextLink, Object.assign({ href: { pathname: href, query: querystring, hash: anchor }, key: "link", locale: false, title: value.title, target: value.target, className: value.class, prefetch: props.prefetch }, htmlLinkProps, { ref: ref }),
                 text,
                 children));
         }
     }
-    // prevent passing internalLinkMatcher as it is an invalid DOM element prop
+    // prevent passing internalLinkMatcher or prefetch as it is an invalid DOM element prop
     const reactLinkProps = Object.assign({}, props);
     delete reactLinkProps.internalLinkMatcher;
+    delete reactLinkProps.prefetch;
     return React.createElement(ReactLink, Object.assign({}, reactLinkProps, { ref: ref }));
 });
 Link.displayName = 'NextLink';

package/dist/esm/components/RichText.js

@@ -13,7 +13,7 @@ import React, { useEffect, useRef } from 'react';
 import PropTypes from 'prop-types';
 import { useRouter } from 'next/router';
 import { RichText as ReactRichText, RichTextPropTypes, } from '@sitecore-jss/sitecore-jss-react';
-const prefetched = {};
+export const prefetched = {};
 export const RichText = (props) => {
     const { internalLinksSelector = 'a[href^="/"]', prefetchLinks = true, editable = true } = props, rest = __rest(props, ["internalLinksSelector", "prefetchLinks", "editable"]);
     const hasText = props.field && props.field.value;
@@ -21,7 +21,7 @@ export const RichText = (props) => {
     const router = useRouter();
     const richTextRef = useRef(null);
     useEffect(() => {
-        // NOT IN EXPERIENCE EDITOR
+        // NOT IN EDIT MODE
         if (hasText && !isEditing) {
             initializeLinks();
         }
@@ -42,9 +42,21 @@ export const RichText = (props) => {
         internalLinks.forEach((link) => {
             if (link.target === '_blank')
                 return;
-            if (prefetchLinks && !prefetched[link.pathname]) {
+            const prefetch = () => {
                 router.prefetch(link.pathname, undefined, { locale: false });
                 prefetched[link.pathname] = true;
+            };
+            if (!prefetched[link.pathname] && prefetchLinks !== false) {
+                if (prefetchLinks === true) {
+                    prefetch();
+                }
+                if (prefetchLinks === 'hover') {
+                    const mouseOverHandler = () => {
+                        prefetch();
+                        link.removeEventListener('mouseover', mouseOverHandler);
+                    };
+                    link.addEventListener('mouseover', mouseOverHandler, false);
+                }
             }
             link.addEventListener('click', routeHandler, false);
         });

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

@@ -26,7 +26,84 @@ export class RedirectsMiddleware extends MiddlewareBase {
     constructor(config) {
         super(config);
         this.config = config;
-        this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
+        // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
+        // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
+        this.redirectsService = new GraphQLRedirectsService(Object.assign(Object.assign({}, config), { fetch: fetch }));
+        this.locales = config.locales;
+    }
+    /**
+     * Gets the Next.js middleware handler with error handling
+     * @returns route handler
+     */
+    getHandler() {
+        return (req, res) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                return this.processRedirectRequest(req, res);
+            }
+            catch (error) {
+                console.log('Redirect middleware failed:');
+                console.log(error);
+                return res || NextResponse.next();
+            }
+        });
+    }
+    /**
+     * Method returns RedirectInfo when matches
+     * @param {NextRequest} req request
+     * @param {string} siteName site name
+     * @returns Promise<RedirectInfo | undefined> The redirect info or undefined if no redirect is found
+     * @protected
+     */
+    getExistsRedirect(req, siteName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { pathname: targetURL, search: targetQS = '', locale } = this.normalizeUrl(req.nextUrl.clone());
+            const normalizedPath = targetURL.replace(/\/*$/gi, '');
+            const redirects = yield this.redirectsService.fetchRedirects(siteName);
+            const language = this.getLanguage(req);
+            const modifyRedirects = structuredClone(redirects);
+            let matchedQueryString;
+            return modifyRedirects.length
+                ? modifyRedirects.find((redirect) => {
+                    var _a;
+                    if (isRegexOrUrl(redirect.pattern) === 'url') {
+                        const parseUrlPattern = redirect.pattern.endsWith('/')
+                            ? redirect.pattern.slice(0, -1).split('?')
+                            : redirect.pattern.split('?');
+                        return ((parseUrlPattern[0] === normalizedPath ||
+                            parseUrlPattern[0] === `/${locale}${normalizedPath}`) &&
+                            areURLSearchParamsEqual(new URLSearchParams((_a = parseUrlPattern[1]) !== null && _a !== void 0 ? _a : ''), new URLSearchParams(targetQS)));
+                    }
+                    // Modify the redirect pattern to ignore the language prefix in the path
+                    // And escapes non-special "?" characters in a string or regex.
+                    redirect.pattern = escapeNonSpecialQuestionMarks(redirect.pattern.replace(new RegExp(`^[^]?/${language}/`, 'gi'), ''));
+                    // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
+                    redirect.pattern = `/^\/${redirect.pattern
+                        .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
+                        .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
+                        .replace(/^\^|\$$/g, '') // Further cleans up anchors
+                        .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
+                    matchedQueryString = [
+                        regexParser(redirect.pattern).test(`${normalizedPath}${targetQS}`),
+                        regexParser(redirect.pattern).test(`/${locale}${normalizedPath}${targetQS}`),
+                    ].some(Boolean)
+                        ? targetQS
+                        : undefined;
+                    // Save the matched query string (if found) into the redirect object
+                    redirect.matchedQueryString = matchedQueryString || '';
+                    return (!!(regexParser(redirect.pattern).test(targetURL) ||
+                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${targetURL}`) ||
+                        matchedQueryString) && (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
+                })
+                : undefined;
+        });
+    }
+    /**
+     * @param {NextRequest} req request
+     * @param {Response} res response
+     * @returns {Promise<NextResponse>} The redirect response.
+     */
+    processRedirectRequest(req, res) {
+        return __awaiter(this, void 0, void 0, function* () {
             const pathname = req.nextUrl.pathname;
             const language = this.getLanguage(req);
             const hostname = this.getHostHeader(req) || this.defaultHostname;
@@ -123,76 +200,6 @@ export class RedirectsMiddleware extends MiddlewareBase {
             });
             return response;
         });
-        // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
-        // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
-        this.redirectsService = new GraphQLRedirectsService(Object.assign(Object.assign({}, config), { fetch: fetch }));
-        this.locales = config.locales;
-    }
-    /**
-     * Gets the Next.js middleware handler with error handling
-     * @returns route handler
-     */
-    getHandler() {
-        return (req, res) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield this.handler(req, res);
-            }
-            catch (error) {
-                console.log('Redirect middleware failed:');
-                console.log(error);
-                return res || NextResponse.next();
-            }
-        });
-    }
-    /**
-     * Method returns RedirectInfo when matches
-     * @param {NextRequest} req request
-     * @param {string} siteName site name
-     * @returns Promise<RedirectInfo | undefined>
-     * @private
-     */
-    getExistsRedirect(req, siteName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { pathname: targetURL, search: targetQS = '', locale } = this.normalizeUrl(req.nextUrl.clone());
-            const normalizedPath = targetURL.replace(/\/*$/gi, '');
-            const redirects = yield this.redirectsService.fetchRedirects(siteName);
-            const language = this.getLanguage(req);
-            const modifyRedirects = structuredClone(redirects);
-            let matchedQueryString;
-            return modifyRedirects.length
-                ? modifyRedirects.find((redirect) => {
-                    var _a;
-                    if (isRegexOrUrl(redirect.pattern) === 'url') {
-                        const parseUrlPattern = redirect.pattern.endsWith('/')
-                            ? redirect.pattern.slice(0, -1).split('?')
-                            : redirect.pattern.split('?');
-                        return ((parseUrlPattern[0] === normalizedPath ||
-                            parseUrlPattern[0] === `/${locale}${normalizedPath}`) &&
-                            areURLSearchParamsEqual(new URLSearchParams((_a = parseUrlPattern[1]) !== null && _a !== void 0 ? _a : ''), new URLSearchParams(targetQS)));
-                    }
-                    // Modify the redirect pattern to ignore the language prefix in the path
-                    // And escapes non-special "?" characters in a string or regex.
-                    redirect.pattern = escapeNonSpecialQuestionMarks(redirect.pattern.replace(new RegExp(`^[^]?/${language}/`, 'gi'), ''));
-                    // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
-                    redirect.pattern = `/^\/${redirect.pattern
-                        .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
-                        .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
-                        .replace(/^\^|\$$/g, '') // Further cleans up anchors
-                        .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
-                    matchedQueryString = [
-                        regexParser(redirect.pattern).test(`${normalizedPath}${targetQS}`),
-                        regexParser(redirect.pattern).test(`/${locale}${normalizedPath}${targetQS}`),
-                    ].some(Boolean)
-                        ? targetQS
-                        : undefined;
-                    // Save the matched query string (if found) into the redirect object
-                    redirect.matchedQueryString = matchedQueryString || '';
-                    return (!!(regexParser(redirect.pattern).test(targetURL) ||
-                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${targetURL}`) ||
-                        matchedQueryString) && (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
-                })
-                : undefined;
-        });
     }
     /**
      * When a user clicks on a link generated by the Link component from next/link,

package/package.json

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

package/types/components/Link.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="@types/react" />
 import React from 'react';
+import { LinkProps as NextLinkProps } from 'next/link';
 import { LinkProps as ReactLinkProps } from '@sitecore-jss/sitecore-jss-react';
 export type LinkProps = ReactLinkProps & {
     /**
@@ -7,5 +8,9 @@ export type LinkProps = ReactLinkProps & {
      * @default /^\//g
      */
     internalLinkMatcher?: RegExp;
+    /**
+     * Next.js Link prefetch.
+     */
+    prefetch?: NextLinkProps['prefetch'];
 };
 export declare const Link: React.ForwardRefExoticComponent<Omit<LinkProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;

package/types/components/RichText.d.ts

@@ -11,9 +11,15 @@ export type RichTextProps = ReactRichTextProps & {
     /**
      * Controls the prefetch of internal links. This can be beneficial if you have RichText fields
      * with large numbers of internal links in them.
+     * - `true` (default): The full route & its data will be prefetched.
+     * - `hover`: Prefetching will happen on hover.
+     * - `false`: Prefetching will not happen.
      * @default true
      */
-    prefetchLinks?: boolean;
+    prefetchLinks?: boolean | 'hover';
+};
+export declare const prefetched: {
+    [cacheKey: string]: boolean;
 };
 export declare const RichText: {
     (props: RichTextProps): JSX.Element;

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

@@ -1,6 +1,9 @@
-import { GraphQLRedirectsServiceConfig } from '@sitecore-jss/sitecore-jss/site';
+import { GraphQLRedirectsServiceConfig, RedirectInfo } from '@sitecore-jss/sitecore-jss/site';
 import { NextRequest, NextResponse } from 'next/server';
 import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
+type RedirectResult = RedirectInfo & {
+    matchedQueryString?: string;
+};
 /**
  * extended RedirectsMiddlewareConfig config type for RedirectsMiddleware
  */
@@ -28,15 +31,20 @@ export declare class RedirectsMiddleware extends MiddlewareBase {
      * @returns route handler
      */
     getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
-    private handler;
     /**
      * Method returns RedirectInfo when matches
      * @param {NextRequest} req request
      * @param {string} siteName site name
-     * @returns Promise<RedirectInfo | undefined>
-     * @private
+     * @returns Promise<RedirectInfo | undefined> The redirect info or undefined if no redirect is found
+     * @protected
+     */
+    protected getExistsRedirect(req: NextRequest, siteName: string): Promise<RedirectResult | undefined>;
+    /**
+     * @param {NextRequest} req request
+     * @param {Response} res response
+     * @returns {Promise<NextResponse>} The redirect response.
      */
-    private getExistsRedirect;
+    protected processRedirectRequest(req: NextRequest, res?: NextResponse): Promise<NextResponse>;
     /**
      * 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.
@@ -55,3 +63,4 @@ export declare class RedirectsMiddleware extends MiddlewareBase {
      */
     private createRedirectResponse;
 }
+export {};