@sitecore-jss/sitecore-jss-nextjs 22.6.0-canary.2 → 22.6.0-canary.20

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/index.js

@@ -23,8 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = exports.NextImage = exports.Placeholder = exports.RichText = exports.Link = exports.useComponentProps = exports.ComponentPropsContext = exports.ComponentPropsReactContext = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSiteInfoService = exports.SiteResolver = exports.GraphQLRobotsService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.MultisiteGraphQLSitemapService = exports.GraphQLSitemapService = exports.DisconnectedSitemapService = exports.ComponentPropsService = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getGroomedVariantIds = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.personalizeLayout = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.mediaApi = exports.EditMode = exports.getContentStylesheetLink = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.MemoryCacheClient = exports.debug = exports.enableDebug = exports.NativeDataFetcher = exports.constants = void 0;
-exports.EditingScripts = exports.withEmptyFieldEditingComponent = exports.withFieldMetadata = exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.DefaultEmptyFieldEditingComponentText = exports.DefaultEmptyFieldEditingComponentImage = exports.File = exports.getComponentLibraryStylesheetLinks = exports.BYOCComponent = void 0;
+exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.Form = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = exports.NextImage = exports.Placeholder = exports.RichText = exports.Link = exports.useComponentProps = exports.ComponentPropsContext = exports.ComponentPropsReactContext = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSiteInfoService = exports.SiteResolver = exports.GraphQLRobotsService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.MultisiteGraphQLSitemapService = exports.GraphQLSitemapService = exports.DisconnectedSitemapService = exports.ComponentPropsService = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getGroomedVariantIds = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.personalizeLayout = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.mediaApi = exports.EditMode = exports.getContentStylesheetLink = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.MemoryCacheClient = exports.debug = exports.enableDebug = exports.NativeDataFetcher = exports.constants = void 0;
+exports.EditingScripts = exports.withEmptyFieldEditingComponent = exports.withFieldMetadata = exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.DefaultEmptyFieldEditingComponentText = exports.DefaultEmptyFieldEditingComponentImage = exports.File = exports.getComponentLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = void 0;
 var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 Object.defineProperty(exports, "constants", { enumerable: true, get: function () { return sitecore_jss_1.constants; } });
 Object.defineProperty(exports, "NativeDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.NativeDataFetcher; } });
@@ -89,6 +89,7 @@ exports.BYOCWrapper = BYOCWrapper;
 var ComponentBuilder_1 = require("./ComponentBuilder");
 Object.defineProperty(exports, "ComponentBuilder", { enumerable: true, get: function () { return ComponentBuilder_1.ComponentBuilder; } });
 var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
+Object.defineProperty(exports, "Form", { enumerable: true, get: function () { return sitecore_jss_react_1.Form; } });
 Object.defineProperty(exports, "Image", { enumerable: true, get: function () { return sitecore_jss_react_1.Image; } });
 Object.defineProperty(exports, "Text", { enumerable: true, get: function () { return sitecore_jss_react_1.Text; } });
 Object.defineProperty(exports, "DateField", { enumerable: true, get: function () { return sitecore_jss_react_1.DateField; } });

package/dist/cjs/middleware/middleware.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MiddlewareBase = void 0;
+exports.MiddlewareBase = exports.REWRITE_HEADER_NAME = void 0;
 const server_1 = require("next/server");
+exports.REWRITE_HEADER_NAME = 'x-sc-rewrite';
 class MiddlewareBase {
     constructor(config) {
         this.config = config;
         this.SITE_SYMBOL = 'sc_site';
-        this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
         this.defaultHostname = config.defaultHostname || 'localhost';
     }
     /**
@@ -84,14 +84,17 @@ class MiddlewareBase {
      * @param {string} rewritePath the destionation path
      * @param {NextRequest} req the current request
      * @param {NextResponse} res the current response
+     * @param {boolean} [skipHeader] don't write 'x-sc-rewrite' header
      */
-    rewrite(rewritePath, req, res) {
+    rewrite(rewritePath, req, res, skipHeader) {
         // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
         const rewriteUrl = req.nextUrl.clone();
         rewriteUrl.pathname = rewritePath;
         const response = server_1.NextResponse.rewrite(rewriteUrl, res);
         // Share rewrite path with following executed middlewares
-        response.headers.set(this.REWRITE_HEADER_NAME, rewritePath);
+        if (!skipHeader) {
+            response.headers.set(exports.REWRITE_HEADER_NAME, rewritePath);
+        }
         return response;
     }
 }

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

@@ -102,7 +102,7 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
                 return response;
             }
             // Path can be rewritten by previously executed middleware
-            const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
+            const basePath = (res === null || res === void 0 ? void 0 : res.headers.get(middleware_1.REWRITE_HEADER_NAME)) || pathname;
             // Rewrite to persononalized path
             const rewritePath = (0, personalize_1.getPersonalizedRewrite)(basePath, identifiedVariantIds);
             response = this.rewrite(rewritePath, req, response);

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

@@ -32,7 +32,91 @@ 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: incomingURL, search: incomingQS = '' } = this.normalizeUrl(req.nextUrl.clone());
+            const locale = this.getLanguage(req);
+            const normalizedPath = incomingURL.replace(/\/*$/gi, '');
+            const redirects = yield this.redirectsService.fetchRedirects(siteName);
+            const language = this.getLanguage(req);
+            const modifyRedirects = structuredClone(redirects);
+            let matchedQueryString;
+            const localePath = `/${locale}${normalizedPath}`.toLowerCase();
+            return modifyRedirects.length
+                ? modifyRedirects.find((redirect) => {
+                    // process static URL (non-regex) rules
+                    if ((0, utils_1.isRegexOrUrl)(redirect.pattern) === 'url') {
+                        const [patternPath, patternQS] = redirect.pattern.endsWith('/')
+                            ? redirect.pattern
+                                .toLowerCase()
+                                .slice(0, -1)
+                                .split('?')
+                            : redirect.pattern.toLowerCase().split('?');
+                        return ((patternPath === localePath || patternPath === normalizedPath) &&
+                            (!patternQS ||
+                                (0, utils_1.areURLSearchParamsEqual)(new URLSearchParams(patternQS), new URLSearchParams(incomingQS))));
+                    }
+                    // process regex rules
+                    // 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
+                    // Redirect pattern matches the full incoming URL with query string present
+                    matchedQueryString = [
+                        (0, regex_parser_1.default)(redirect.pattern).test(`${localePath}${incomingQS}`),
+                        (0, regex_parser_1.default)(redirect.pattern).test(`${normalizedPath}${incomingQS}`),
+                    ].some(Boolean)
+                        ? incomingQS
+                        : undefined;
+                    // Save the matched query string (if found) into the redirect object
+                    redirect.matchedQueryString = matchedQueryString || '';
+                    return (!!((0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${incomingURL}`) ||
+                        (0, regex_parser_1.default)(redirect.pattern).test(incomingURL) ||
+                        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;
@@ -68,6 +152,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                     sitecore_jss_1.debug.redirects('skipped (redirect does not exist)');
                     return response;
                 }
+                sitecore_jss_1.debug.redirects('Matched redirect rule: %o', { existsRedirect });
                 // Find context site language and replace token
                 if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target) &&
                     !(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
@@ -114,7 +199,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                         return this.createRedirectResponse(url, response, 302, 'Found');
                     }
                     case site_1.REDIRECT_TYPE_SERVER_TRANSFER: {
-                        return this.rewrite(url.href, req, response);
+                        return this.rewrite(url.href, req, response, true);
                     }
                     default:
                         return response;
@@ -129,76 +214,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,
@@ -257,6 +272,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
         if (res === null || res === void 0 ? void 0 : res.headers) {
             redirect.headers.delete('x-middleware-next');
             redirect.headers.delete('x-middleware-rewrite');
+            redirect.headers.delete(middleware_1.REWRITE_HEADER_NAME);
         }
         return redirect;
     }

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/index.js

@@ -19,4 +19,4 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder } from './ComponentBuilder';
-export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';
+export { Form, Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';

package/dist/esm/middleware/middleware.js

@@ -1,9 +1,9 @@
 import { NextResponse } from 'next/server';
+export const REWRITE_HEADER_NAME = 'x-sc-rewrite';
 export class MiddlewareBase {
     constructor(config) {
         this.config = config;
         this.SITE_SYMBOL = 'sc_site';
-        this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
         this.defaultHostname = config.defaultHostname || 'localhost';
     }
     /**
@@ -81,14 +81,17 @@ export class MiddlewareBase {
      * @param {string} rewritePath the destionation path
      * @param {NextRequest} req the current request
      * @param {NextResponse} res the current response
+     * @param {boolean} [skipHeader] don't write 'x-sc-rewrite' header
      */
-    rewrite(rewritePath, req, res) {
+    rewrite(rewritePath, req, res, skipHeader) {
         // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
         const rewriteUrl = req.nextUrl.clone();
         rewriteUrl.pathname = rewritePath;
         const response = NextResponse.rewrite(rewriteUrl, res);
         // Share rewrite path with following executed middlewares
-        response.headers.set(this.REWRITE_HEADER_NAME, rewritePath);
+        if (!skipHeader) {
+            response.headers.set(REWRITE_HEADER_NAME, rewritePath);
+        }
         return response;
     }
 }

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

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { NextResponse } from 'next/server';
 import { GraphQLPersonalizeService, getPersonalizedRewrite, CdpHelper, DEFAULT_VARIANT, } from '@sitecore-jss/sitecore-jss/personalize';
 import { debug } from '@sitecore-jss/sitecore-jss';
-import { MiddlewareBase } from './middleware';
+import { MiddlewareBase, REWRITE_HEADER_NAME } from './middleware';
 import { CloudSDK } from '@sitecore-cloudsdk/core/server';
 import { personalize } from '@sitecore-cloudsdk/personalize/server';
 /**
@@ -99,7 +99,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 return response;
             }
             // Path can be rewritten by previously executed middleware
-            const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
+            const basePath = (res === null || res === void 0 ? void 0 : res.headers.get(REWRITE_HEADER_NAME)) || pathname;
             // Rewrite to persononalized path
             const rewritePath = getPersonalizedRewrite(basePath, identifiedVariantIds);
             response = this.rewrite(rewritePath, req, response);

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

@@ -12,7 +12,7 @@ import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT
 import { areURLSearchParamsEqual, escapeNonSpecialQuestionMarks, isRegexOrUrl, mergeURLSearchParams, } from '@sitecore-jss/sitecore-jss/utils';
 import { NextResponse } from 'next/server';
 import regexParser from 'regex-parser';
-import { MiddlewareBase } from './middleware';
+import { MiddlewareBase, REWRITE_HEADER_NAME } from './middleware';
 const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
 const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
 /**
@@ -26,7 +26,91 @@ 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: incomingURL, search: incomingQS = '' } = this.normalizeUrl(req.nextUrl.clone());
+            const locale = this.getLanguage(req);
+            const normalizedPath = incomingURL.replace(/\/*$/gi, '');
+            const redirects = yield this.redirectsService.fetchRedirects(siteName);
+            const language = this.getLanguage(req);
+            const modifyRedirects = structuredClone(redirects);
+            let matchedQueryString;
+            const localePath = `/${locale}${normalizedPath}`.toLowerCase();
+            return modifyRedirects.length
+                ? modifyRedirects.find((redirect) => {
+                    // process static URL (non-regex) rules
+                    if (isRegexOrUrl(redirect.pattern) === 'url') {
+                        const [patternPath, patternQS] = redirect.pattern.endsWith('/')
+                            ? redirect.pattern
+                                .toLowerCase()
+                                .slice(0, -1)
+                                .split('?')
+                            : redirect.pattern.toLowerCase().split('?');
+                        return ((patternPath === localePath || patternPath === normalizedPath) &&
+                            (!patternQS ||
+                                areURLSearchParamsEqual(new URLSearchParams(patternQS), new URLSearchParams(incomingQS))));
+                    }
+                    // process regex rules
+                    // 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
+                    // Redirect pattern matches the full incoming URL with query string present
+                    matchedQueryString = [
+                        regexParser(redirect.pattern).test(`${localePath}${incomingQS}`),
+                        regexParser(redirect.pattern).test(`${normalizedPath}${incomingQS}`),
+                    ].some(Boolean)
+                        ? incomingQS
+                        : undefined;
+                    // Save the matched query string (if found) into the redirect object
+                    redirect.matchedQueryString = matchedQueryString || '';
+                    return (!!(regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${incomingURL}`) ||
+                        regexParser(redirect.pattern).test(incomingURL) ||
+                        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;
@@ -62,6 +146,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
                     debug.redirects('skipped (redirect does not exist)');
                     return response;
                 }
+                debug.redirects('Matched redirect rule: %o', { existsRedirect });
                 // Find context site language and replace token
                 if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target) &&
                     !(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
@@ -108,7 +193,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
                         return this.createRedirectResponse(url, response, 302, 'Found');
                     }
                     case REDIRECT_TYPE_SERVER_TRANSFER: {
-                        return this.rewrite(url.href, req, response);
+                        return this.rewrite(url.href, req, response, true);
                     }
                     default:
                         return response;
@@ -123,76 +208,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,
@@ -251,6 +266,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
         if (res === null || res === void 0 ? void 0 : res.headers) {
             redirect.headers.delete('x-middleware-next');
             redirect.headers.delete('x-middleware-rewrite');
+            redirect.headers.delete(REWRITE_HEADER_NAME);
         }
         return redirect;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "22.6.0-canary.2",
+  "version": "22.6.0-canary.20",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -67,15 +67,16 @@
   },
   "peerDependencies": {
     "@sitecore-cloudsdk/core": "^0.4.2",
+    "@sitecore-cloudsdk/events": "^0.4.2",
     "@sitecore-cloudsdk/personalize": "^0.4.2",
     "next": "^14.2.18",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^22.6.0-canary.2",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^22.6.0-canary.2",
-    "@sitecore-jss/sitecore-jss-react": "^22.6.0-canary.2",
+    "@sitecore-jss/sitecore-jss": "22.6.0-canary.20",
+    "@sitecore-jss/sitecore-jss-dev-tools": "22.6.0-canary.20",
+    "@sitecore-jss/sitecore-jss-react": "22.6.0-canary.20",
     "@vercel/kv": "^0.2.1",
     "prop-types": "^15.8.1",
     "regex-parser": "^2.2.11",
@@ -83,7 +84,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "0e838937f67ad003a2a7bf52fba9e1f686095715",
+  "gitHead": "4e59803c65beb6bab91cc63da0f87635ecc908a7",
   "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/index.d.ts

@@ -22,4 +22,4 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
-export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getComponentLibraryStylesheetLinks, File, FileField, RichTextField, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, WithSitecoreContextOptions, WithSitecoreContextProps, WithSitecoreContextHocProps, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';
+export { ComponentFactory, Form, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getComponentLibraryStylesheetLinks, File, FileField, RichTextField, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, WithSitecoreContextOptions, WithSitecoreContextProps, WithSitecoreContextHocProps, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';

package/types/middleware/middleware.d.ts

@@ -1,5 +1,6 @@
 import { SiteInfo, SiteResolver } from '@sitecore-jss/sitecore-jss/site';
 import { NextRequest, NextResponse } from 'next/server';
+export declare const REWRITE_HEADER_NAME = "x-sc-rewrite";
 export type MiddlewareBaseConfig = {
     /**
      * function, determines if middleware should be turned off, based on cookie, header, or other considerations
@@ -28,7 +29,6 @@ export type MiddlewareBaseConfig = {
 export declare abstract class MiddlewareBase {
     protected config: MiddlewareBaseConfig;
     protected SITE_SYMBOL: string;
-    protected REWRITE_HEADER_NAME: string;
     protected defaultHostname: string;
     constructor(config: MiddlewareBaseConfig);
     /**
@@ -77,6 +77,7 @@ export declare abstract class MiddlewareBase {
      * @param {string} rewritePath the destionation path
      * @param {NextRequest} req the current request
      * @param {NextResponse} res the current response
+     * @param {boolean} [skipHeader] don't write 'x-sc-rewrite' header
      */
-    protected rewrite(rewritePath: string, req: NextRequest, res: NextResponse): NextResponse;
+    protected rewrite(rewritePath: string, req: NextRequest, res: NextResponse, skipHeader?: boolean): NextResponse;
 }

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