@sitecore-content-sdk/nextjs 0.1.0-beta.29 → 0.1.0-beta.30

package/dist/cjs/middleware/middleware.js

@@ -9,10 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineMiddleware = exports.MiddlewareBase = exports.Middleware = void 0;
+exports.defineMiddleware = exports.MiddlewareBase = exports.Middleware = exports.REWRITE_HEADER_NAME = void 0;
 const site_1 = require("@sitecore-content-sdk/core/site");
 const core_1 = require("@sitecore-content-sdk/core");
 const server_1 = require("next/server");
+exports.REWRITE_HEADER_NAME = 'x-sc-rewrite';
 /**
  * Middleware class to be extended by all middleware implementations
  */
@@ -27,7 +28,6 @@ class MiddlewareBase extends Middleware {
         super();
         this.config = config;
         this.SITE_SYMBOL = 'sc_site';
-        this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
         this.siteResolver = new site_1.SiteResolver(config.sites);
         this.defaultHostname = config.defaultHostname || 'localhost';
     }
@@ -105,14 +105,17 @@ class MiddlewareBase extends Middleware {
      * @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

@@ -104,7 +104,7 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
                     return res;
                 }
                 // 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);
                 const response = this.rewrite(rewritePath, req, res);

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

@@ -72,6 +72,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                         core_1.debug.redirects('skipped (redirect does not exist)');
                         return res;
                     }
+                    core_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) &&
@@ -118,7 +119,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                             return this.createRedirectResponse(url, res, 302, 'Found');
                         }
                         case site_1.REDIRECT_TYPE_SERVER_TRANSFER: {
-                            return this.rewrite(url.href, req, res);
+                            return this.rewrite(url.href, req, res, true);
                         }
                         default:
                             return res;
@@ -153,23 +154,35 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
      */
     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 { 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.toLowerCase()}${normalizedPath}`;
             return modifyRedirects.length
                 ? modifyRedirects.find((redirect) => {
-                    var _a;
+                    // process static URL (non-regex) rules
                     if ((0, utils_1.isRegexOrUrl)(redirect.pattern) === 'url') {
-                        const parseUrlPattern = redirect.pattern.endsWith('/')
+                        const urlArray = 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)));
+                        const patternQS = urlArray[1];
+                        let patternPath = urlArray[0];
+                        // nextjs routes are case-sensitive, but locales should be compared case-insensitively
+                        const patternParts = patternPath.split('/');
+                        const maybeLocale = patternParts[1].toLowerCase();
+                        // case insensitive lookup of locales
+                        if (new RegExp(this.locales.join('|'), 'i').test(maybeLocale)) {
+                            patternPath = patternPath.replace(`/${patternParts[1]}`, `/${maybeLocale}`);
+                        }
+                        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'), ''));
@@ -179,16 +192,17 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                         .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(`${normalizedPath}${targetQS}`),
-                        (0, regex_parser_1.default)(redirect.pattern).test(`/${locale}${normalizedPath}${targetQS}`),
+                        (0, regex_parser_1.default)(redirect.pattern).test(`/${localePath}${incomingQS}`),
+                        (0, regex_parser_1.default)(redirect.pattern).test(`${normalizedPath}${incomingQS}`),
                     ].some(Boolean)
-                        ? targetQS
+                        ? 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(targetURL) ||
-                        (0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${targetURL}`) ||
+                    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;
@@ -251,6 +265,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/middleware/middleware.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { SiteResolver } from '@sitecore-content-sdk/core/site';
 import { debug } from '@sitecore-content-sdk/core';
 import { NextResponse } from 'next/server';
+export const REWRITE_HEADER_NAME = 'x-sc-rewrite';
 /**
  * Middleware class to be extended by all middleware implementations
  */
@@ -23,7 +24,6 @@ export class MiddlewareBase extends Middleware {
         super();
         this.config = config;
         this.SITE_SYMBOL = 'sc_site';
-        this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
         this.siteResolver = new SiteResolver(config.sites);
         this.defaultHostname = config.defaultHostname || 'localhost';
     }
@@ -101,14 +101,17 @@ export class MiddlewareBase extends Middleware {
      * @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

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { GraphQLPersonalizeService, getPersonalizedRewrite, CdpHelper, DEFAULT_VARIANT, } from '@sitecore-content-sdk/core/personalize';
 import { debug } from '@sitecore-content-sdk/core';
-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';
 /**
@@ -101,7 +101,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                     return res;
                 }
                 // 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);
                 const response = this.rewrite(rewritePath, req, res);

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-content-sdk/core/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');
 /**
@@ -66,6 +66,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
                         debug.redirects('skipped (redirect does not exist)');
                         return res;
                     }
+                    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) &&
@@ -112,7 +113,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
                             return this.createRedirectResponse(url, res, 302, 'Found');
                         }
                         case REDIRECT_TYPE_SERVER_TRANSFER: {
-                            return this.rewrite(url.href, req, res);
+                            return this.rewrite(url.href, req, res, true);
                         }
                         default:
                             return res;
@@ -147,23 +148,35 @@ export class RedirectsMiddleware extends MiddlewareBase {
      */
     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 { 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.toLowerCase()}${normalizedPath}`;
             return modifyRedirects.length
                 ? modifyRedirects.find((redirect) => {
-                    var _a;
+                    // process static URL (non-regex) rules
                     if (isRegexOrUrl(redirect.pattern) === 'url') {
-                        const parseUrlPattern = redirect.pattern.endsWith('/')
+                        const urlArray = 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)));
+                        const patternQS = urlArray[1];
+                        let patternPath = urlArray[0];
+                        // nextjs routes are case-sensitive, but locales should be compared case-insensitively
+                        const patternParts = patternPath.split('/');
+                        const maybeLocale = patternParts[1].toLowerCase();
+                        // case insensitive lookup of locales
+                        if (new RegExp(this.locales.join('|'), 'i').test(maybeLocale)) {
+                            patternPath = patternPath.replace(`/${patternParts[1]}`, `/${maybeLocale}`);
+                        }
+                        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'), ''));
@@ -173,16 +186,17 @@ export class RedirectsMiddleware extends MiddlewareBase {
                         .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(`${normalizedPath}${targetQS}`),
-                        regexParser(redirect.pattern).test(`/${locale}${normalizedPath}${targetQS}`),
+                        regexParser(redirect.pattern).test(`/${localePath}${incomingQS}`),
+                        regexParser(redirect.pattern).test(`${normalizedPath}${incomingQS}`),
                     ].some(Boolean)
-                        ? targetQS
+                        ? incomingQS
                         : 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}`) ||
+                    return (!!(regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${incomingURL}`) ||
+                        regexParser(redirect.pattern).test(incomingURL) ||
                         matchedQueryString) && (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
                 })
                 : undefined;
@@ -245,6 +259,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-content-sdk/nextjs",
-  "version": "0.1.0-beta.29",
+  "version": "0.1.0-beta.30",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -75,8 +75,8 @@
   },
   "dependencies": {
     "@babel/parser": "^7.26.10",
-    "@sitecore-content-sdk/core": "0.1.0-beta.29",
-    "@sitecore-content-sdk/react": "0.1.0-beta.29",
+    "@sitecore-content-sdk/core": "0.1.0-beta.30",
+    "@sitecore-content-sdk/react": "0.1.0-beta.30",
     "@vercel/kv": "^3.0.0",
     "prop-types": "^15.8.1",
     "recast": "^0.23.11",
@@ -85,7 +85,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "2f4fef1dfc43acdc0221efb4287f62970c24c61b",
+  "gitHead": "418ed952ab73eb1872077c05279d53784c3c6ee3",
   "files": [
     "dist",
     "types",

package/types/middleware/middleware.d.ts

@@ -1,5 +1,6 @@
 import { SiteInfo, SiteResolver } from '@sitecore-content-sdk/core/site';
 import { NextRequest, NextFetchEvent, NextResponse } from 'next/server';
+export declare const REWRITE_HEADER_NAME = "x-sc-rewrite";
 export type MiddlewareBaseConfig = {
     /**
      * function, determines if middleware execution should be skipped, based on cookie, header, or other considerations
@@ -40,7 +41,6 @@ export declare abstract class Middleware {
 export declare abstract class MiddlewareBase extends Middleware {
     protected config: MiddlewareBaseConfig;
     protected SITE_SYMBOL: string;
-    protected REWRITE_HEADER_NAME: string;
     protected defaultHostname: string;
     protected siteResolver: SiteResolver;
     constructor(config: MiddlewareBaseConfig);
@@ -90,8 +90,9 @@ export declare abstract class MiddlewareBase extends Middleware {
      * @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;
 }
 /**
  * Define a middleware with a list of middlewares