@sitecore-jss/sitecore-jss-nextjs 22.2.0-canary.6 → 22.2.0-canary.61

package/dist/cjs/components/NextImage.js

@@ -24,7 +24,9 @@ const sitecore_jss_react_2 = require("@sitecore-jss/sitecore-jss-react");
 const sitecore_jss_react_3 = require("@sitecore-jss/sitecore-jss-react");
 const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
 exports.NextImage = (0, sitecore_jss_react_1.withFieldMetadata)((0, sitecore_jss_react_2.withEmptyFieldEditingComponent)((_a) => {
+    var _b;
     var { editable = true, imageParams, field, mediaUrlPrefix, fill, priority } = _a, otherProps = __rest(_a, ["editable", "imageParams", "field", "mediaUrlPrefix", "fill", "priority"]);
+    const sitecoreContext = react_1.default.useContext(sitecore_jss_react_1.SitecoreContextReactContext);
     // next handles src and we use a custom loader,
     // throw error if these are present
     if (otherProps.src) {
@@ -46,8 +48,11 @@ exports.NextImage = (0, sitecore_jss_react_1.withFieldMetadata)((0, sitecore_jss
     if (!img) {
         return null;
     }
+    // disable image optimization for Edit and Preview, but preserve original value if true
+    const unoptimized = otherProps.unoptimized ||
+        ((_b = sitecoreContext.context) === null || _b === void 0 ? void 0 : _b.pageState) !== layout_1.LayoutServicePageState.Normal;
     const attrs = Object.assign(Object.assign(Object.assign({}, img), otherProps), { fill,
-        priority, src: media_1.mediaApi.updateImageUrl(img.src, imageParams, mediaUrlPrefix) });
+        priority, src: media_1.mediaApi.updateImageUrl(img.src, imageParams, mediaUrlPrefix), unoptimized });
     const imageProps = Object.assign(Object.assign({}, attrs), { 
         // force replace /media with /jssmedia in src since we _know_ we will be adding a 'mw' query string parameter
         // this is required for Sitecore media API resizing to work properly

package/dist/cjs/editing/constants.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EDITING_ALLOWED_ORIGINS = exports.EDITING_PASS_THROUGH_HEADERS = exports.QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = exports.QUERY_PARAM_VERCEL_PROTECTION_BYPASS = exports.QUERY_PARAM_EDITING_SECRET = void 0;
-exports.QUERY_PARAM_EDITING_SECRET = 'secret';
+exports.EDITING_PASS_THROUGH_HEADERS = exports.QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = exports.QUERY_PARAM_VERCEL_PROTECTION_BYPASS = void 0;
 exports.QUERY_PARAM_VERCEL_PROTECTION_BYPASS = 'x-vercel-protection-bypass';
 exports.QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie';
 /**
@@ -9,7 +8,3 @@ exports.QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie';
  * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
  */
 exports.EDITING_PASS_THROUGH_HEADERS = ['authorization', 'cookie'];
-/**
- * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
- */
-exports.EDITING_ALLOWED_ORIGINS = ['https://pages*.cloud', 'https://pages.sitecorecloud.io'];

package/dist/cjs/editing/editing-config-middleware.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditingConfigMiddleware = void 0;
-const constants_1 = require("./constants");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const utils_1 = require("../utils/utils");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
@@ -26,8 +26,8 @@ class EditingConfigMiddleware {
     constructor(config) {
         this.config = config;
         this.handler = (_req, res) => __awaiter(this, void 0, void 0, function* () {
-            const secret = _req.query[constants_1.QUERY_PARAM_EDITING_SECRET];
-            if (!(0, utils_2.enforceCors)(_req, res, constants_1.EDITING_ALLOWED_ORIGINS)) {
+            const secret = _req.query[editing_1.QUERY_PARAM_EDITING_SECRET];
+            if (!(0, utils_2.enforceCors)(_req, res, editing_1.EDITING_ALLOWED_ORIGINS)) {
                 sitecore_jss_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
                 return res.status(401).json({ message: 'Invalid origin' });
             }

package/dist/cjs/editing/editing-data-middleware.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditingDataMiddleware = void 0;
 const editing_data_cache_1 = require("./editing-data-cache");
 const editing_data_1 = require("./editing-data");
-const constants_1 = require("./constants");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const utils_1 = require("../utils/utils");
 const utils_2 = require("@sitecore-jss/sitecore-jss/utils");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
@@ -28,9 +28,9 @@ class EditingDataMiddleware {
         var _a, _b;
         this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
             const { method, query, body } = req;
-            const secret = query[constants_1.QUERY_PARAM_EDITING_SECRET];
+            const secret = query[editing_1.QUERY_PARAM_EDITING_SECRET];
             const key = query[this.queryParamKey];
-            if (!(0, utils_2.enforceCors)(req, res, constants_1.EDITING_ALLOWED_ORIGINS)) {
+            if (!(0, utils_2.enforceCors)(req, res, editing_1.EDITING_ALLOWED_ORIGINS)) {
                 sitecore_jss_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
                 return res.status(401).json({ message: 'Invalid origin' });
             }

package/dist/cjs/editing/editing-data-service.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.generateKey = void 0;
-const constants_1 = require("./constants");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const editing_data_cache_1 = require("./editing-data-cache");
 const utils_1 = require("../utils/utils");
@@ -137,7 +137,7 @@ class ServerlessEditingDataService {
         //  http://localhost:3000/api/editing/data/52961eea-bafd-5287-a532-a72e36bd8a36-qkb4e3fv5x?secret=1234secret
         const apiRoute = (_a = this.apiRoute) === null || _a === void 0 ? void 0 : _a.replace('[key]', key);
         const url = new URL(apiRoute, serverUrl);
-        url.searchParams.append(constants_1.QUERY_PARAM_EDITING_SECRET, (0, utils_1.getJssEditingSecret)());
+        url.searchParams.append(editing_1.QUERY_PARAM_EDITING_SECRET, (0, utils_1.getJssEditingSecret)());
         if (params) {
             for (const key in params) {
                 if ({}.hasOwnProperty.call(params, key)) {

package/dist/cjs/editing/editing-render-middleware.js

@@ -13,8 +13,8 @@ exports.EditingRenderMiddleware = exports.MetadataHandler = exports.isEditingMet
 const constants_1 = require("next/constants");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const editing_data_service_1 = require("./editing-data-service");
-const constants_2 = require("./constants");
 const utils_1 = require("../utils/utils");
 const render_middleware_1 = require("./render-middleware");
 const utils_2 = require("@sitecore-jss/sitecore-jss/utils");
@@ -221,10 +221,10 @@ class MetadataHandler {
             version: query.sc_version,
             editMode: layout_1.EditMode.Metadata,
             pageState: query.mode,
+            layoutKind: query.sc_layoutKind,
         }, 
         // Cache the preview data for 3 seconds to ensure the page is rendered with the correct preview data not the cached one
         {
-            path: query.route,
             maxAge: 3,
         });
         // Cookies with the SameSite=Lax policy set by Next.js setPreviewData function causes CORS issue
@@ -265,7 +265,7 @@ class MetadataHandler {
      * @returns Content-Security-Policy header value
      */
     getSCPHeader() {
-        return `frame-ancestors 'self' ${[(0, utils_2.getAllowedOriginsFromEnv)(), ...constants_2.EDITING_ALLOWED_ORIGINS].join(' ')}`;
+        return `frame-ancestors 'self' ${[(0, utils_2.getAllowedOriginsFromEnv)(), ...editing_1.EDITING_ALLOWED_ORIGINS].join(' ')}`;
     }
 }
 exports.MetadataHandler = MetadataHandler;
@@ -289,14 +289,14 @@ class EditingRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
                 headers,
                 body,
             });
-            if (!(0, utils_2.enforceCors)(req, res, constants_2.EDITING_ALLOWED_ORIGINS)) {
+            if (!(0, utils_2.enforceCors)(req, res, editing_1.EDITING_ALLOWED_ORIGINS)) {
                 sitecore_jss_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
                 return res.status(401).json({
                     html: `<html><body>Requests from origin ${(_a = req.headers) === null || _a === void 0 ? void 0 : _a.origin} not allowed</body></html>`,
                 });
             }
             // Validate secret
-            const secret = (_b = query[constants_2.QUERY_PARAM_EDITING_SECRET]) !== null && _b !== void 0 ? _b : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
+            const secret = (_b = query[editing_1.QUERY_PARAM_EDITING_SECRET]) !== null && _b !== void 0 ? _b : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
             if (secret !== (0, utils_1.getJssEditingSecret)()) {
                 sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
                 return res.status(401).json({

package/dist/cjs/editing/feaas-render-middleware.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FEAASRenderMiddleware = void 0;
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
-const constants_1 = require("./constants");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const utils_1 = require("../utils/utils");
 const render_middleware_1 = require("./render-middleware");
 const utils_2 = require("@sitecore-jss/sitecore-jss/utils");
@@ -37,7 +37,7 @@ class FEAASRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
                 query,
                 headers,
             });
-            if (!(0, utils_2.enforceCors)(req, res, constants_1.EDITING_ALLOWED_ORIGINS)) {
+            if (!(0, utils_2.enforceCors)(req, res, editing_1.EDITING_ALLOWED_ORIGINS)) {
                 sitecore_jss_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
                 return res
                     .status(401)
@@ -49,7 +49,7 @@ class FEAASRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
                 return res.status(405).send(`<html><body>Invalid request method '${method}'</body></html>`);
             }
             // Validate secret
-            const secret = query[constants_1.QUERY_PARAM_EDITING_SECRET];
+            const secret = query[editing_1.QUERY_PARAM_EDITING_SECRET];
             if (secret !== (0, utils_1.getJssEditingSecret)()) {
                 sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
                 return res.status(401).send('<html><body>Missing or invalid secret</body></html>');

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

@@ -13,10 +13,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedirectsMiddleware = void 0;
-const regex_parser_1 = __importDefault(require("regex-parser"));
-const server_1 = require("next/server");
-const site_1 = require("@sitecore-jss/sitecore-jss/site");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
+const site_1 = require("@sitecore-jss/sitecore-jss/site");
+const server_1 = require("next/server");
+const regex_parser_1 = __importDefault(require("regex-parser"));
 const middleware_1 = require("./middleware");
 const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
 const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
@@ -43,6 +43,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                 hostname,
             });
             const createResponse = () => __awaiter(this, void 0, void 0, function* () {
+                var _a;
                 if (this.config.disabled && this.config.disabled(req, res || server_1.NextResponse.next())) {
                     sitecore_jss_1.debug.redirects('skipped (redirects middleware is disabled)');
                     return res || server_1.NextResponse.next();
@@ -64,47 +65,46 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                         existsRedirect.target.includes(hostname))) {
                     existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
                 }
-                const url = req.nextUrl.clone();
+                const url = this.normalizeUrl(req.nextUrl.clone());
                 if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
                     url.href = existsRedirect.target;
                 }
                 else {
-                    const source = `${url.pathname}${url.search}`;
-                    url.search = existsRedirect.isQueryStringPreserved ? url.search : '';
+                    const source = `${url.pathname.replace(/\/*$/gi, '')}${url.search}`;
                     const urlFirstPart = existsRedirect.target.split('/')[1];
                     if (this.locales.includes(urlFirstPart)) {
-                        url.locale = urlFirstPart;
+                        req.nextUrl.locale = urlFirstPart;
                         existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
                     }
                     const target = source
                         .replace((0, regex_parser_1.default)(existsRedirect.pattern), existsRedirect.target)
                         .replace(/^\/\//, '/')
                         .split('?');
-                    url.pathname = target[0];
-                    if (target[1]) {
-                        const newParams = new URLSearchParams(target[1]);
-                        for (const [key, val] of newParams.entries()) {
-                            url.searchParams.append(key, val);
-                        }
+                    if (url.search && existsRedirect.isQueryStringPreserved) {
+                        const targetQueryString = (_a = target[1]) !== null && _a !== void 0 ? _a : '';
+                        url.search = '?' + new URLSearchParams(`${url.search}&${targetQueryString}`).toString();
+                    }
+                    else if (target[1]) {
+                        url.search = '?' + target[1];
+                    }
+                    else {
+                        url.search = '';
                     }
+                    const prepareNewURL = new URL(`${target[0]}${url.search}`, url.origin);
+                    url.href = prepareNewURL.href;
                 }
                 const redirectUrl = decodeURIComponent(url.href);
                 /** return Response redirect with http code of redirect type **/
                 switch (existsRedirect.redirectType) {
-                    case site_1.REDIRECT_TYPE_301:
-                        return server_1.NextResponse.redirect(redirectUrl, {
-                            status: 301,
-                            statusText: 'Moved Permanently',
-                            headers: res === null || res === void 0 ? void 0 : res.headers,
-                        });
-                    case site_1.REDIRECT_TYPE_302:
-                        return server_1.NextResponse.redirect(redirectUrl, {
-                            status: 302,
-                            statusText: 'Found',
-                            headers: res === null || res === void 0 ? void 0 : res.headers,
-                        });
-                    case site_1.REDIRECT_TYPE_SERVER_TRANSFER:
-                        return server_1.NextResponse.rewrite(redirectUrl, res);
+                    case site_1.REDIRECT_TYPE_301: {
+                        return this.createRedirectResponse(redirectUrl, res, 301, 'Moved Permanently');
+                    }
+                    case site_1.REDIRECT_TYPE_302: {
+                        return this.createRedirectResponse(redirectUrl, res, 302, 'Found');
+                    }
+                    case site_1.REDIRECT_TYPE_SERVER_TRANSFER: {
+                        return this.rewrite(redirectUrl, req, res || server_1.NextResponse.next());
+                    }
                     default:
                         return res || server_1.NextResponse.next();
                 }
@@ -149,8 +149,9 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
     getExistsRedirect(req, siteName) {
         return __awaiter(this, void 0, void 0, function* () {
             const redirects = yield this.redirectsService.fetchRedirects(siteName);
-            const tragetURL = req.nextUrl.pathname;
-            const targetQS = req.nextUrl.search || '';
+            const normalizedUrl = this.normalizeUrl(req.nextUrl.clone());
+            const tragetURL = normalizedUrl.pathname;
+            const targetQS = normalizedUrl.search || '';
             const language = this.getLanguage(req);
             const modifyRedirects = structuredClone(redirects);
             return modifyRedirects.length
@@ -163,7 +164,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                         .replace(/(?<!\\)\?/g, '\\?')
                         .replace(/\$\/gi$/g, '')}[\/]?$/gi`;
                     return (((0, regex_parser_1.default)(redirect.pattern).test(tragetURL) ||
-                        (0, regex_parser_1.default)(redirect.pattern).test(`${tragetURL}${targetQS}`) ||
+                        (0, regex_parser_1.default)(redirect.pattern).test(`${tragetURL.replace(/\/*$/gi, '')}${targetQS}`) ||
                         (0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||
                         (0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}${targetQS}`)) &&
                         (redirect.locale
@@ -173,5 +174,64 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                 : undefined;
         });
     }
+    /**
+     * When a user clicks on a link generated by the Link component from next/link,
+     * Next.js adds special parameters in the route called path.
+     * This method removes these special parameters.
+     * @param {URL} url
+     * @returns {string} normalize url
+     */
+    normalizeUrl(url) {
+        if (!url.search) {
+            return url;
+        }
+        /**
+         * Prepare special parameters for exclusion.
+         */
+        const splittedPathname = url.pathname
+            .split('/')
+            .filter((route) => route)
+            .map((route) => `path=${route}`);
+        /**
+         * Remove special parameters(Next.JS)
+         * Example: /about/contact/us
+         * When a user clicks on this link, Next.js should generate a link for the middleware, formatted like this:
+         * http://host/about/contact/us?path=about&path=contact&path=us
+         */
+        const newQueryString = url.search
+            .replace(/^\?/, '')
+            .split('&')
+            .filter((param) => {
+            if (!splittedPathname.includes(param)) {
+                return param;
+            }
+            return false;
+        })
+            .join('&');
+        if (newQueryString) {
+            return new URL(`${url.pathname}?${newQueryString}`, url.origin);
+        }
+        return new URL(`${url.pathname}`, url.origin);
+    }
+    /**
+     * Helper function to create a redirect response and remove the x-middleware-next header.
+     * @param {string} url The URL to redirect to.
+     * @param {Response} res The response object.
+     * @param {number} status The HTTP status code of the redirect.
+     * @param {string} statusText The status text of the redirect.
+     * @returns {NextResponse<unknown>} The redirect response.
+     */
+    createRedirectResponse(url, res, status, statusText) {
+        const redirect = server_1.NextResponse.redirect(url, {
+            status,
+            statusText,
+            headers: res === null || res === void 0 ? void 0 : res.headers,
+        });
+        if (res === null || res === void 0 ? void 0 : res.headers) {
+            redirect.headers.delete('x-middleware-next');
+            redirect.headers.delete('x-middleware-rewrite');
+        }
+        return redirect;
+    }
 }
 exports.RedirectsMiddleware = RedirectsMiddleware;

package/dist/esm/components/NextImage.js

@@ -12,13 +12,15 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 import PropTypes from 'prop-types';
 import React from 'react';
-import { getEEMarkup, withFieldMetadata, } from '@sitecore-jss/sitecore-jss-react';
+import { getEEMarkup, withFieldMetadata, SitecoreContextReactContext, } from '@sitecore-jss/sitecore-jss-react';
 import Image from 'next/image';
 import { withEmptyFieldEditingComponent } from '@sitecore-jss/sitecore-jss-react';
 import { DefaultEmptyFieldEditingComponentImage } from '@sitecore-jss/sitecore-jss-react';
-import { isFieldValueEmpty } from '@sitecore-jss/sitecore-jss/layout';
+import { isFieldValueEmpty, LayoutServicePageState } from '@sitecore-jss/sitecore-jss/layout';
 export const NextImage = withFieldMetadata(withEmptyFieldEditingComponent((_a) => {
+    var _b;
     var { editable = true, imageParams, field, mediaUrlPrefix, fill, priority } = _a, otherProps = __rest(_a, ["editable", "imageParams", "field", "mediaUrlPrefix", "fill", "priority"]);
+    const sitecoreContext = React.useContext(SitecoreContextReactContext);
     // next handles src and we use a custom loader,
     // throw error if these are present
     if (otherProps.src) {
@@ -40,8 +42,11 @@ export const NextImage = withFieldMetadata(withEmptyFieldEditingComponent((_a) =
     if (!img) {
         return null;
     }
+    // disable image optimization for Edit and Preview, but preserve original value if true
+    const unoptimized = otherProps.unoptimized ||
+        ((_b = sitecoreContext.context) === null || _b === void 0 ? void 0 : _b.pageState) !== LayoutServicePageState.Normal;
     const attrs = Object.assign(Object.assign(Object.assign({}, img), otherProps), { fill,
-        priority, src: mediaApi.updateImageUrl(img.src, imageParams, mediaUrlPrefix) });
+        priority, src: mediaApi.updateImageUrl(img.src, imageParams, mediaUrlPrefix), unoptimized });
     const imageProps = Object.assign(Object.assign({}, attrs), { 
         // force replace /media with /jssmedia in src since we _know_ we will be adding a 'mw' query string parameter
         // this is required for Sitecore media API resizing to work properly

package/dist/esm/editing/constants.js

@@ -1,4 +1,3 @@
-export const QUERY_PARAM_EDITING_SECRET = 'secret';
 export const QUERY_PARAM_VERCEL_PROTECTION_BYPASS = 'x-vercel-protection-bypass';
 export const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie';
 /**
@@ -6,7 +5,3 @@ export const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie'
  * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
  */
 export const EDITING_PASS_THROUGH_HEADERS = ['authorization', 'cookie'];
-/**
- * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
- */
-export const EDITING_ALLOWED_ORIGINS = ['https://pages*.cloud', 'https://pages.sitecorecloud.io'];

package/dist/esm/editing/editing-config-middleware.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET } from './constants';
+import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, } from '@sitecore-jss/sitecore-jss/editing';
 import { getJssEditingSecret } from '../utils/utils';
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { EditMode } from '@sitecore-jss/sitecore-jss/layout';

package/dist/esm/editing/editing-data-middleware.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { editingDataDiskCache } from './editing-data-cache';
 import { isEditingData } from './editing-data';
-import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET } from './constants';
+import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, } from '@sitecore-jss/sitecore-jss/editing';
 import { getJssEditingSecret } from '../utils/utils';
 import { enforceCors } from '@sitecore-jss/sitecore-jss/utils';
 import { debug } from '@sitecore-jss/sitecore-jss';

package/dist/esm/editing/editing-data-service.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { QUERY_PARAM_EDITING_SECRET } from './constants';
+import { QUERY_PARAM_EDITING_SECRET } from '@sitecore-jss/sitecore-jss/editing';
 import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
 import { editingDataDiskCache } from './editing-data-cache';
 import { getJssEditingSecret } from '../utils/utils';

package/dist/esm/editing/editing-render-middleware.js

@@ -10,8 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { STATIC_PROPS_ID, SERVER_PROPS_ID } from 'next/constants';
 import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
 import { EditMode } from '@sitecore-jss/sitecore-jss/layout';
+import { QUERY_PARAM_EDITING_SECRET, EDITING_ALLOWED_ORIGINS, } from '@sitecore-jss/sitecore-jss/editing';
 import { editingDataService } from './editing-data-service';
-import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET } from './constants';
 import { getJssEditingSecret } from '../utils/utils';
 import { RenderMiddlewareBase } from './render-middleware';
 import { enforceCors, getAllowedOriginsFromEnv } from '@sitecore-jss/sitecore-jss/utils';
@@ -216,10 +216,10 @@ export class MetadataHandler {
             version: query.sc_version,
             editMode: EditMode.Metadata,
             pageState: query.mode,
+            layoutKind: query.sc_layoutKind,
         }, 
         // Cache the preview data for 3 seconds to ensure the page is rendered with the correct preview data not the cached one
         {
-            path: query.route,
             maxAge: 3,
         });
         // Cookies with the SameSite=Lax policy set by Next.js setPreviewData function causes CORS issue

package/dist/esm/editing/feaas-render-middleware.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { debug } from '@sitecore-jss/sitecore-jss';
-import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET } from './constants';
+import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, } from '@sitecore-jss/sitecore-jss/editing';
 import { getJssEditingSecret } from '../utils/utils';
 import { RenderMiddlewareBase } from './render-middleware';
 import { enforceCors } from '@sitecore-jss/sitecore-jss/utils';

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

@@ -7,10 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import regexParser from 'regex-parser';
-import { NextResponse } from 'next/server';
-import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, } from '@sitecore-jss/sitecore-jss/site';
 import { debug } from '@sitecore-jss/sitecore-jss';
+import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, } from '@sitecore-jss/sitecore-jss/site';
+import { NextResponse } from 'next/server';
+import regexParser from 'regex-parser';
 import { MiddlewareBase } from './middleware';
 const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
 const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
@@ -37,6 +37,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
                 hostname,
             });
             const createResponse = () => __awaiter(this, void 0, void 0, function* () {
+                var _a;
                 if (this.config.disabled && this.config.disabled(req, res || NextResponse.next())) {
                     debug.redirects('skipped (redirects middleware is disabled)');
                     return res || NextResponse.next();
@@ -58,47 +59,46 @@ export class RedirectsMiddleware extends MiddlewareBase {
                         existsRedirect.target.includes(hostname))) {
                     existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
                 }
-                const url = req.nextUrl.clone();
+                const url = this.normalizeUrl(req.nextUrl.clone());
                 if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
                     url.href = existsRedirect.target;
                 }
                 else {
-                    const source = `${url.pathname}${url.search}`;
-                    url.search = existsRedirect.isQueryStringPreserved ? url.search : '';
+                    const source = `${url.pathname.replace(/\/*$/gi, '')}${url.search}`;
                     const urlFirstPart = existsRedirect.target.split('/')[1];
                     if (this.locales.includes(urlFirstPart)) {
-                        url.locale = urlFirstPart;
+                        req.nextUrl.locale = urlFirstPart;
                         existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
                     }
                     const target = source
                         .replace(regexParser(existsRedirect.pattern), existsRedirect.target)
                         .replace(/^\/\//, '/')
                         .split('?');
-                    url.pathname = target[0];
-                    if (target[1]) {
-                        const newParams = new URLSearchParams(target[1]);
-                        for (const [key, val] of newParams.entries()) {
-                            url.searchParams.append(key, val);
-                        }
+                    if (url.search && existsRedirect.isQueryStringPreserved) {
+                        const targetQueryString = (_a = target[1]) !== null && _a !== void 0 ? _a : '';
+                        url.search = '?' + new URLSearchParams(`${url.search}&${targetQueryString}`).toString();
+                    }
+                    else if (target[1]) {
+                        url.search = '?' + target[1];
+                    }
+                    else {
+                        url.search = '';
                     }
+                    const prepareNewURL = new URL(`${target[0]}${url.search}`, url.origin);
+                    url.href = prepareNewURL.href;
                 }
                 const redirectUrl = decodeURIComponent(url.href);
                 /** return Response redirect with http code of redirect type **/
                 switch (existsRedirect.redirectType) {
-                    case REDIRECT_TYPE_301:
-                        return NextResponse.redirect(redirectUrl, {
-                            status: 301,
-                            statusText: 'Moved Permanently',
-                            headers: res === null || res === void 0 ? void 0 : res.headers,
-                        });
-                    case REDIRECT_TYPE_302:
-                        return NextResponse.redirect(redirectUrl, {
-                            status: 302,
-                            statusText: 'Found',
-                            headers: res === null || res === void 0 ? void 0 : res.headers,
-                        });
-                    case REDIRECT_TYPE_SERVER_TRANSFER:
-                        return NextResponse.rewrite(redirectUrl, res);
+                    case REDIRECT_TYPE_301: {
+                        return this.createRedirectResponse(redirectUrl, res, 301, 'Moved Permanently');
+                    }
+                    case REDIRECT_TYPE_302: {
+                        return this.createRedirectResponse(redirectUrl, res, 302, 'Found');
+                    }
+                    case REDIRECT_TYPE_SERVER_TRANSFER: {
+                        return this.rewrite(redirectUrl, req, res || NextResponse.next());
+                    }
                     default:
                         return res || NextResponse.next();
                 }
@@ -143,8 +143,9 @@ export class RedirectsMiddleware extends MiddlewareBase {
     getExistsRedirect(req, siteName) {
         return __awaiter(this, void 0, void 0, function* () {
             const redirects = yield this.redirectsService.fetchRedirects(siteName);
-            const tragetURL = req.nextUrl.pathname;
-            const targetQS = req.nextUrl.search || '';
+            const normalizedUrl = this.normalizeUrl(req.nextUrl.clone());
+            const tragetURL = normalizedUrl.pathname;
+            const targetQS = normalizedUrl.search || '';
             const language = this.getLanguage(req);
             const modifyRedirects = structuredClone(redirects);
             return modifyRedirects.length
@@ -157,7 +158,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
                         .replace(/(?<!\\)\?/g, '\\?')
                         .replace(/\$\/gi$/g, '')}[\/]?$/gi`;
                     return ((regexParser(redirect.pattern).test(tragetURL) ||
-                        regexParser(redirect.pattern).test(`${tragetURL}${targetQS}`) ||
+                        regexParser(redirect.pattern).test(`${tragetURL.replace(/\/*$/gi, '')}${targetQS}`) ||
                         regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||
                         regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}${targetQS}`)) &&
                         (redirect.locale
@@ -167,4 +168,63 @@ export class RedirectsMiddleware extends MiddlewareBase {
                 : undefined;
         });
     }
+    /**
+     * When a user clicks on a link generated by the Link component from next/link,
+     * Next.js adds special parameters in the route called path.
+     * This method removes these special parameters.
+     * @param {URL} url
+     * @returns {string} normalize url
+     */
+    normalizeUrl(url) {
+        if (!url.search) {
+            return url;
+        }
+        /**
+         * Prepare special parameters for exclusion.
+         */
+        const splittedPathname = url.pathname
+            .split('/')
+            .filter((route) => route)
+            .map((route) => `path=${route}`);
+        /**
+         * Remove special parameters(Next.JS)
+         * Example: /about/contact/us
+         * When a user clicks on this link, Next.js should generate a link for the middleware, formatted like this:
+         * http://host/about/contact/us?path=about&path=contact&path=us
+         */
+        const newQueryString = url.search
+            .replace(/^\?/, '')
+            .split('&')
+            .filter((param) => {
+            if (!splittedPathname.includes(param)) {
+                return param;
+            }
+            return false;
+        })
+            .join('&');
+        if (newQueryString) {
+            return new URL(`${url.pathname}?${newQueryString}`, url.origin);
+        }
+        return new URL(`${url.pathname}`, url.origin);
+    }
+    /**
+     * Helper function to create a redirect response and remove the x-middleware-next header.
+     * @param {string} url The URL to redirect to.
+     * @param {Response} res The response object.
+     * @param {number} status The HTTP status code of the redirect.
+     * @param {string} statusText The status text of the redirect.
+     * @returns {NextResponse<unknown>} The redirect response.
+     */
+    createRedirectResponse(url, res, status, statusText) {
+        const redirect = NextResponse.redirect(url, {
+            status,
+            statusText,
+            headers: res === null || res === void 0 ? void 0 : res.headers,
+        });
+        if (res === null || res === void 0 ? void 0 : res.headers) {
+            redirect.headers.delete('x-middleware-next');
+            redirect.headers.delete('x-middleware-rewrite');
+        }
+        return redirect;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "22.2.0-canary.6",
+  "version": "22.2.0-canary.61",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -54,7 +54,7 @@
     "eslint-plugin-react": "^7.32.1",
     "jsdom": "^21.1.0",
     "mocha": "^10.2.0",
-    "next": "^14.1.0",
+    "next": "^14.2.7",
     "nock": "^13.3.0",
     "nyc": "^15.1.0",
     "react": "^18.2.0",
@@ -67,14 +67,14 @@
   "peerDependencies": {
     "@sitecore-cloudsdk/events": "^0.3.1",
     "@sitecore-cloudsdk/personalize": "^0.3.1",
-    "next": "^14.1.0",
+    "next": "^14.2.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^22.2.0-canary.6",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^22.2.0-canary.6",
-    "@sitecore-jss/sitecore-jss-react": "^22.2.0-canary.6",
+    "@sitecore-jss/sitecore-jss": "^22.2.0-canary.61",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^22.2.0-canary.61",
+    "@sitecore-jss/sitecore-jss-react": "^22.2.0-canary.61",
     "@vercel/kv": "^0.2.1",
     "prop-types": "^15.8.1",
     "regex-parser": "^2.2.11",
@@ -82,7 +82,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "081499ff4ca4c753b0762c4b700529c7514ac774",
+  "gitHead": "50eb0f665c2936d8c6262020bb57a8eea359f7b7",
   "files": [
     "dist",
     "types",

package/types/editing/constants.d.ts

@@ -1,4 +1,3 @@
-export declare const QUERY_PARAM_EDITING_SECRET = "secret";
 export declare const QUERY_PARAM_VERCEL_PROTECTION_BYPASS = "x-vercel-protection-bypass";
 export declare const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = "x-vercel-set-bypass-cookie";
 /**
@@ -6,7 +5,3 @@ export declare const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = "x-vercel-set-bypass
  * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
  */
 export declare const EDITING_PASS_THROUGH_HEADERS: string[];
-/**
- * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
- */
-export declare const EDITING_ALLOWED_ORIGINS: string[];

package/types/editing/editing-render-middleware.d.ts

@@ -1,6 +1,7 @@
 import { NextApiRequest, NextApiResponse } from 'next';
 import { AxiosDataFetcher } from '@sitecore-jss/sitecore-jss';
 import { EditMode, LayoutServicePageState } from '@sitecore-jss/sitecore-jss/layout';
+import { RenderMetadataQueryParams, LayoutKind } from '@sitecore-jss/sitecore-jss/editing';
 import { EditingDataService } from './editing-data-service';
 import { RenderMiddlewareBase } from './render-middleware';
 /**
@@ -95,25 +96,11 @@ export declare class ChromesHandler extends RenderMiddlewareBase {
  * Configuration for the Editing Metadata Handler.
  */
 export type EditingRenderMiddlewareMetadataConfig = Pick<EditingRenderMiddlewareConfig, 'resolvePageUrl'>;
-/**
- * Query parameters appended to the page route URL
- * Appended when XMCloud Pages preview (editing) Metadata Edit Mode is used
- */
-export type MetadataQueryParams = {
-    secret: string;
-    sc_lang: string;
-    sc_itemid: string;
-    sc_site: string;
-    route: string;
-    mode: Exclude<LayoutServicePageState, 'normal'>;
-    sc_variant?: string;
-    sc_version?: string;
-};
 /**
  * Next.js API request with Metadata query parameters.
  */
 type MetadataNextApiRequest = NextApiRequest & {
-    query: MetadataQueryParams;
+    query: RenderMetadataQueryParams;
 };
 /**
  * Data for Next.js Preview (Editing) Metadata Edit Mode.
@@ -126,6 +113,7 @@ export type EditingMetadataPreviewData = {
     pageState: Exclude<LayoutServicePageState, 'Normal'>;
     variantIds: string[];
     version?: string;
+    layoutKind?: LayoutKind;
 };
 /**
  * Type guard for EditingMetadataPreviewData

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

@@ -1,5 +1,5 @@
-import { NextResponse, NextRequest } from 'next/server';
 import { GraphQLRedirectsServiceConfig } from '@sitecore-jss/sitecore-jss/site';
+import { NextRequest, NextResponse } from 'next/server';
 import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
 /**
  * extended RedirectsMiddlewareConfig config type for RedirectsMiddleware
@@ -37,4 +37,21 @@ export declare class RedirectsMiddleware extends MiddlewareBase {
      * @private
      */
     private getExistsRedirect;
+    /**
+     * When a user clicks on a link generated by the Link component from next/link,
+     * Next.js adds special parameters in the route called path.
+     * This method removes these special parameters.
+     * @param {URL} url
+     * @returns {string} normalize url
+     */
+    private normalizeUrl;
+    /**
+     * Helper function to create a redirect response and remove the x-middleware-next header.
+     * @param {string} url The URL to redirect to.
+     * @param {Response} res The response object.
+     * @param {number} status The HTTP status code of the redirect.
+     * @param {string} statusText The status text of the redirect.
+     * @returns {NextResponse<unknown>} The redirect response.
+     */
+    private createRedirectResponse;
 }