@sitecore-jss/sitecore-jss-nextjs 22.2.0-canary.9 → 22.3.0-canary.1

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

@@ -1,4 +1,4 @@
-export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
+export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, MemoryCacheClient, } from '@sitecore-jss/sitecore-jss';
 export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, getContentStylesheetLink, EditMode, } from '@sitecore-jss/sitecore-jss/layout';
 export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
@@ -19,5 +19,4 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder } from './ComponentBuilder';
-export { Context } from './context';
 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';

package/dist/esm/middleware/index.js

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

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

@@ -11,7 +11,8 @@ 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 { init, personalize } from '@sitecore-cloudsdk/personalize/server';
+import { CloudSDK } from '@sitecore-cloudsdk/core/server';
+import { personalize } from '@sitecore-cloudsdk/personalize/server';
 /**
  * Middleware / handler to support Sitecore Personalize
  */
@@ -133,13 +134,15 @@ export class PersonalizeMiddleware extends MiddlewareBase {
     }
     initPersonalizeServer({ hostname, siteName, request, response, }) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield init(request, response, {
+            yield CloudSDK(request, response, {
                 sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
                 sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
                 siteName,
                 cookieDomain: hostname,
                 enableServerCookie: true,
-            });
+            })
+                .addPersonalize()
+                .initialize();
         });
     }
     personalize({ params, friendlyId, language, timeout, variantIds, }, request) {

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "22.2.0-canary.9",
+  "version": "22.3.0-canary.1",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -29,7 +29,8 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "devDependencies": {
-    "@sitecore-cloudsdk/personalize": "^0.3.1",
+    "@sitecore-cloudsdk/core": "^0.4.0",
+    "@sitecore-cloudsdk/personalize": "^0.4.0",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-string": "^1.4.2",
@@ -54,7 +55,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",
@@ -65,16 +66,16 @@
     "typescript": "~4.9.4"
   },
   "peerDependencies": {
-    "@sitecore-cloudsdk/events": "^0.3.1",
-    "@sitecore-cloudsdk/personalize": "^0.3.1",
-    "next": "^14.1.0",
+    "@sitecore-cloudsdk/core": "^0.4.0",
+    "@sitecore-cloudsdk/personalize": "^0.4.0",
+    "next": "^14.2.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^22.2.0-canary.9",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^22.2.0-canary.9",
-    "@sitecore-jss/sitecore-jss-react": "^22.2.0-canary.9",
+    "@sitecore-jss/sitecore-jss": "^22.3.0-canary.1",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^22.3.0-canary.1",
+    "@sitecore-jss/sitecore-jss-react": "^22.3.0-canary.1",
     "@vercel/kv": "^0.2.1",
     "prop-types": "^15.8.1",
     "regex-parser": "^2.2.11",
@@ -82,7 +83,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "843696778d1ce2cb8cb4d0ff21bf60da5df3020e",
+  "gitHead": "204eb3427f26d4ba8c08f44cf9c772f19f2820a8",
   "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/index.d.ts

@@ -1,4 +1,4 @@
-export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
+export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, CacheClient, CacheOptions, MemoryCacheClient, } from '@sitecore-jss/sitecore-jss';
 export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, GraphQLLayoutService, GraphQLLayoutServiceConfig, RestLayoutService, RestLayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, HtmlElementRendering, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, getContentStylesheetLink, EditMode, } from '@sitecore-jss/sitecore-jss/layout';
 export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, OutcomeInstance, EventInstance, PageViewInstance, } from '@sitecore-jss/sitecore-jss/tracking';
@@ -22,5 +22,4 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
-export { Context, ContextConfig, SDK } from './context';
 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';

package/types/middleware/index.d.ts

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

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

@@ -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,32 @@ 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 {NextURL} url
+     * @returns {string} normalize url
+     */
+    private normalizeUrl;
+    /**
+     * Helper function to create a redirect response and remove the x-middleware-next header.
+     * @param {NextURL} url The URL to redirect to.
+     * @param {Response} res The response object.
+     * @param {number} status The HTTP status code of the redirect.
+     * @param {string} statusText The status text of the redirect.
+     * @returns {NextResponse<unknown>} The redirect response.
+     */
+    private createRedirectResponse;
+    /**
+     * Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
+     * It constructs all possible query parameter permutations and tests them against the pattern.
+     * @param {Object} params - The parameters for the URL match.
+     * @param {string} params.pathname - The current URL pathname.
+     * @param {string} params.queryString - The current URL query string.
+     * @param {string} params.pattern - The regex pattern to test the constructed URLs against.
+     * @param {string} [params.locale] - The locale prefix to include in the URL if present.
+     * @returns {string | undefined} - return query string if any of the query permutations match the provided pattern, undefined otherwise.
+     */
+    private isPermutedQueryMatch;
 }

package/context.d.ts

@@ -1 +0,0 @@
-export * from './types/context/index';

package/context.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/context/index');

package/dist/cjs/context/context.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = void 0;
-const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
-/**
- * Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
- */
-class Context {
-    constructor(props) {
-        this.props = props;
-        /**
-         * Indicates whether the Context and SDK(s) have been initialized
-         */
-        this.isInitialized = false;
-        /**
-         * Software Development Kits (SDKs) to be initialized
-         */
-        this.sdks = {};
-        /**
-         * Promises for the SDKs
-         */
-        this.sdkPromises = {};
-        this.sdkErrors = {};
-        /**
-         * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
-         *
-         * @param {string} name SDK name
-         * @returns initialized SDK
-         */
-        this.getSDK = (name) => {
-            if (!this.sdkPromises[name]) {
-                return Promise.reject(`Unknown SDK '${String(name)}'`);
-            }
-            else {
-                return this.sdkPromises[name].then((result) => {
-                    return ((this.sdkErrors[name] && Promise.reject(this.sdkErrors[name])) || Promise.resolve(result));
-                });
-            }
-        };
-        this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
-        this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
-        this.siteName = props.siteName;
-        this.pageState = sitecore_jss_react_1.LayoutServicePageState.Normal;
-    }
-    init(props = {}) {
-        // Context and SDKs are initialized only once
-        if (this.isInitialized)
-            return;
-        this.isInitialized = true;
-        if (props.siteName) {
-            this.siteName = props.siteName;
-        }
-        if (props.pageState) {
-            this.pageState = props.pageState;
-        }
-        // iterate over the SDKs and initialize them
-        for (const sdkName of Object.keys(this.props.sdks)) {
-            this.initSDK(sdkName);
-        }
-    }
-    /**
-     * Initializes the Software Development Kit (SDK)
-     *
-     * @param {T} name SDK name
-     * @returns {void}
-     */
-    initSDK(name) {
-        this.sdkPromises[name] = new Promise((resolve) => {
-            this.props.sdks[name]
-                .init(this)
-                .then(() => {
-                this.sdks[name] = this.props.sdks[name].sdk;
-                resolve(this.sdks[name]);
-            })
-                .catch((e) => {
-                // if init rejects, we mark SDK as failed - so getSDK call would reject with a reason
-                this.sdkErrors[name] = e;
-                resolve(undefined);
-            });
-        });
-    }
-}
-exports.Context = Context;

package/dist/cjs/context/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = void 0;
-var context_1 = require("./context");
-Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });