@sitecore-content-sdk/nextjs 2.1.0-canary.5 → 2.1.0-canary.6

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

@@ -207,14 +207,34 @@ class RedirectsProxy extends proxy_1.ProxyBase {
             return undefined;
         }
         const { pathname: incomingURL, search: incomingQS = '' } = this.normalizeUrl(req.nextUrl.clone());
-        const locale = this.getLanguage(req);
         const normalizedPath = incomingURL.replace(/\/*$/gi, '').toLowerCase();
         const redirects = await this.redirectsService.fetchRedirects(siteName);
-        const modifyRedirects = structuredClone(redirects);
+        // locale of current request (from URL, headers or otherwise), used to match versioned redirect rules
+        const requestLocale = this.getLanguage(req);
+        const matchedLocaleRedirect = this.matchRedirectItemRedirect(redirects, requestLocale, normalizedPath);
+        if (matchedLocaleRedirect) {
+            return matchedLocaleRedirect;
+        }
+        // locale of the url - if present in the url, used for redirect map matching
+        const urlLocale = req.nextUrl.locale;
+        return this.matchFromRedirectMapRedirect(redirects, urlLocale, incomingURL, incomingQS);
+    }
+    /**
+     * Matches redirect-map rules without a `locale` field against the incoming URL (static or regex patterns).
+     * @param {RedirectResult[]} redirects All redirects from the service (non-locale entries are filtered inside).
+     * @param {string} urlLocale Locale segment from the request URL (`nextUrl.locale`).
+     * @param {string} incomingURL Original pathname used for regex tests.
+     * @param {string} incomingQS Query string including leading `?` if present.
+     * @returns {RedirectResult | undefined} First matching redirect or undefined.
+     * @private
+     */
+    matchFromRedirectMapRedirect(redirects, urlLocale, incomingURL, incomingQS) {
+        const nonLocaleRedirects = redirects.filter((redirect) => !redirect.locale);
         let matchedQueryString;
-        const localePath = `/${locale.toLowerCase()}${normalizedPath}`;
-        return modifyRedirects.length
-            ? modifyRedirects.find((redirect) => {
+        const normalizedPath = incomingURL.replace(/\/*$/gi, '').toLowerCase();
+        const localePath = `/${urlLocale.toLowerCase()}${normalizedPath}`;
+        return nonLocaleRedirects.length
+            ? nonLocaleRedirects.find((redirect) => {
                 // process static URL (non-regex) rules
                 if ((0, tools_1.isRegexOrUrl)(redirect.pattern) === 'url') {
                     const urlArray = redirect.pattern.endsWith('/')
@@ -236,14 +256,14 @@ class RedirectsProxy extends proxy_1.ProxyBase {
                 // 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, tools_1.escapeNonSpecialQuestionMarks)('^' + redirect.pattern.replace(new RegExp(`^[^]?/${locale}/`, 'gi'), '') // ensure function thinks input is regex
+                redirect.pattern = (0, tools_1.escapeNonSpecialQuestionMarks)('^' + redirect.pattern.replace(new RegExp(`^[^]?/${urlLocale}/`, 'gi'), '') // ensure function thinks input is regex
                 );
                 // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
                 redirect.pattern = `/^\/${redirect.pattern
                     .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
                     .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
                     .replace(/^\^|\$$/g, '') // Further cleans up anchors
-                    .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
+                    .replace(/\$\/g$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
                 // Redirect pattern matches the full incoming URL with query string present
                 matchedQueryString = [
                     (0, regex_parser_1.default)(redirect.pattern).test(`/${localePath}${incomingQS}`),
@@ -253,9 +273,27 @@ class RedirectsProxy extends proxy_1.ProxyBase {
                     : undefined;
                 // Save the matched query string (if found) into the redirect object
                 redirect.matchedQueryString = matchedQueryString || '';
-                return (!!((0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${incomingURL}`) ||
+                return (!!((0, regex_parser_1.default)(redirect.pattern).test(`/${urlLocale}${incomingURL}`) ||
                     (0, regex_parser_1.default)(redirect.pattern).test(incomingURL) ||
-                    matchedQueryString) && (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
+                    matchedQueryString) &&
+                    (redirect.locale ? redirect.locale.toLowerCase() === urlLocale.toLowerCase() : true));
+            })
+            : undefined;
+    }
+    /**
+     * Processes redirect rules from redirect items (language-versioned)
+     * @param {RedirectResult[]} redirects redirect entries from Edge
+     * @param {string} locale current request locale
+     * @param {string} currentPath current request path (without locale)
+     * @returns {RedirectResult | undefined} matched redirect item redirect result or undefined
+     * @private
+     */
+    matchRedirectItemRedirect(redirects, locale, currentPath) {
+        return redirects.length
+            ? redirects.find((redirect) => {
+                const patternPath = redirect.pattern.replace(/\/*$/g, '').toLowerCase();
+                // locale rules are easy and nice
+                return redirect.locale === locale && patternPath === currentPath;
             })
             : undefined;
     }

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

@@ -201,14 +201,34 @@ export class RedirectsProxy extends ProxyBase {
             return undefined;
         }
         const { pathname: incomingURL, search: incomingQS = '' } = this.normalizeUrl(req.nextUrl.clone());
-        const locale = this.getLanguage(req);
         const normalizedPath = incomingURL.replace(/\/*$/gi, '').toLowerCase();
         const redirects = await this.redirectsService.fetchRedirects(siteName);
-        const modifyRedirects = structuredClone(redirects);
+        // locale of current request (from URL, headers or otherwise), used to match versioned redirect rules
+        const requestLocale = this.getLanguage(req);
+        const matchedLocaleRedirect = this.matchRedirectItemRedirect(redirects, requestLocale, normalizedPath);
+        if (matchedLocaleRedirect) {
+            return matchedLocaleRedirect;
+        }
+        // locale of the url - if present in the url, used for redirect map matching
+        const urlLocale = req.nextUrl.locale;
+        return this.matchFromRedirectMapRedirect(redirects, urlLocale, incomingURL, incomingQS);
+    }
+    /**
+     * Matches redirect-map rules without a `locale` field against the incoming URL (static or regex patterns).
+     * @param {RedirectResult[]} redirects All redirects from the service (non-locale entries are filtered inside).
+     * @param {string} urlLocale Locale segment from the request URL (`nextUrl.locale`).
+     * @param {string} incomingURL Original pathname used for regex tests.
+     * @param {string} incomingQS Query string including leading `?` if present.
+     * @returns {RedirectResult | undefined} First matching redirect or undefined.
+     * @private
+     */
+    matchFromRedirectMapRedirect(redirects, urlLocale, incomingURL, incomingQS) {
+        const nonLocaleRedirects = redirects.filter((redirect) => !redirect.locale);
         let matchedQueryString;
-        const localePath = `/${locale.toLowerCase()}${normalizedPath}`;
-        return modifyRedirects.length
-            ? modifyRedirects.find((redirect) => {
+        const normalizedPath = incomingURL.replace(/\/*$/gi, '').toLowerCase();
+        const localePath = `/${urlLocale.toLowerCase()}${normalizedPath}`;
+        return nonLocaleRedirects.length
+            ? nonLocaleRedirects.find((redirect) => {
                 // process static URL (non-regex) rules
                 if (isRegexOrUrl(redirect.pattern) === 'url') {
                     const urlArray = redirect.pattern.endsWith('/')
@@ -230,14 +250,14 @@ export class RedirectsProxy extends ProxyBase {
                 // 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(`^[^]?/${locale}/`, 'gi'), '') // ensure function thinks input is regex
+                redirect.pattern = escapeNonSpecialQuestionMarks('^' + redirect.pattern.replace(new RegExp(`^[^]?/${urlLocale}/`, 'gi'), '') // ensure function thinks input is regex
                 );
                 // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
                 redirect.pattern = `/^\/${redirect.pattern
                     .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
                     .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
                     .replace(/^\^|\$$/g, '') // Further cleans up anchors
-                    .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
+                    .replace(/\$\/g$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
                 // Redirect pattern matches the full incoming URL with query string present
                 matchedQueryString = [
                     regexParser(redirect.pattern).test(`/${localePath}${incomingQS}`),
@@ -247,9 +267,27 @@ export class RedirectsProxy extends ProxyBase {
                     : undefined;
                 // Save the matched query string (if found) into the redirect object
                 redirect.matchedQueryString = matchedQueryString || '';
-                return (!!(regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${incomingURL}`) ||
+                return (!!(regexParser(redirect.pattern).test(`/${urlLocale}${incomingURL}`) ||
                     regexParser(redirect.pattern).test(incomingURL) ||
-                    matchedQueryString) && (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
+                    matchedQueryString) &&
+                    (redirect.locale ? redirect.locale.toLowerCase() === urlLocale.toLowerCase() : true));
+            })
+            : undefined;
+    }
+    /**
+     * Processes redirect rules from redirect items (language-versioned)
+     * @param {RedirectResult[]} redirects redirect entries from Edge
+     * @param {string} locale current request locale
+     * @param {string} currentPath current request path (without locale)
+     * @returns {RedirectResult | undefined} matched redirect item redirect result or undefined
+     * @private
+     */
+    matchRedirectItemRedirect(redirects, locale, currentPath) {
+        return redirects.length
+            ? redirects.find((redirect) => {
+                const patternPath = redirect.pattern.replace(/\/*$/g, '').toLowerCase();
+                // locale rules are easy and nice
+                return redirect.locale === locale && patternPath === currentPath;
             })
             : undefined;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/nextjs",
-  "version": "2.1.0-canary.5",
+  "version": "2.1.0-canary.6",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -32,8 +32,8 @@
     "url": "https://github.com/sitecore/content-sdk/issues"
   },
   "devDependencies": {
-    "@sitecore-content-sdk/analytics-core": "2.1.0-canary.5",
-    "@sitecore-content-sdk/personalize": "2.1.0-canary.5",
+    "@sitecore-content-sdk/analytics-core": "2.1.0-canary.6",
+    "@sitecore-content-sdk/personalize": "2.1.0-canary.6",
     "@stylistic/eslint-plugin": "^5.2.2",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.3.0",
@@ -91,10 +91,10 @@
   },
   "dependencies": {
     "@babel/parser": "^7.27.2",
-    "@sitecore-content-sdk/content": "2.1.0-canary.5",
-    "@sitecore-content-sdk/core": "2.1.0-canary.5",
-    "@sitecore-content-sdk/events": "2.1.0-canary.5",
-    "@sitecore-content-sdk/react": "2.1.0-canary.5",
+    "@sitecore-content-sdk/content": "2.1.0-canary.6",
+    "@sitecore-content-sdk/core": "2.1.0-canary.6",
+    "@sitecore-content-sdk/events": "2.1.0-canary.6",
+    "@sitecore-content-sdk/react": "2.1.0-canary.6",
     "recast": "^0.23.11",
     "regex-parser": "^2.3.1",
     "sync-disk-cache": "^2.1.0"
@@ -178,7 +178,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "5fca9e8f3b2a80bc37f18ec7030243242559b151",
+  "gitHead": "2bb9b6503a49b5a3e9b534b0592859f2f86a3fd3",
   "files": [
     "dist",
     "types",

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

@@ -36,6 +36,25 @@ export declare class RedirectsProxy extends ProxyBase {
      * @private
      */
     protected getExistsRedirect(req: NextRequest, siteName: string): Promise<RedirectResult | undefined>;
+    /**
+     * Matches redirect-map rules without a `locale` field against the incoming URL (static or regex patterns).
+     * @param {RedirectResult[]} redirects All redirects from the service (non-locale entries are filtered inside).
+     * @param {string} urlLocale Locale segment from the request URL (`nextUrl.locale`).
+     * @param {string} incomingURL Original pathname used for regex tests.
+     * @param {string} incomingQS Query string including leading `?` if present.
+     * @returns {RedirectResult | undefined} First matching redirect or undefined.
+     * @private
+     */
+    protected matchFromRedirectMapRedirect(redirects: RedirectResult[], urlLocale: string, incomingURL: string, incomingQS: string): RedirectResult | undefined;
+    /**
+     * Processes redirect rules from redirect items (language-versioned)
+     * @param {RedirectResult[]} redirects redirect entries from Edge
+     * @param {string} locale current request locale
+     * @param {string} currentPath current request path (without locale)
+     * @returns {RedirectResult | undefined} matched redirect item redirect result or undefined
+     * @private
+     */
+    protected matchRedirectItemRedirect(redirects: RedirectResult[], locale: string, currentPath: string): RedirectResult | 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.

package/types/proxy/redirects-proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"redirects-proxy.d.ts","sourceRoot":"","sources":["../../src/proxy/redirects-proxy.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EAItB,YAAY,EAEb,MAAM,oCAAoC,CAAC;AAO5C,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAExD,OAAO,EAAE,SAAS,EAAE,eAAe,EAAuB,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAM3C,KAAK,cAAc,GAAG,YAAY,GAAG;IAAE,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,EAAE,OAAO,GAAG,eAAe,CAAC,GACxF,cAAc,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,GAC7B,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GACpD,eAAe,GACf,cAAc,CAAC,WAAW,CAAC,GAAG;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC;AACJ;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,SAAS;IAO/B,SAAS,CAAC,MAAM,EAAE,oBAAoB;IANlD,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpD,OAAO,CAAC,OAAO,CAAW;IAE1B;;OAEG;gBACmB,MAAM,EAAE,oBAAoB;IAmDlD,MAAM,GAAU,KAAK,WAAW,EAAE,KAAK,YAAY,KAAG,OAAO,CAAC,YAAY,CAAC,CA4KzE;IAEF,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS;IAU5E;;;;;;OAMG;cACa,iBAAiB,CAC/B,GAAG,EAAE,WAAW,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IA8EtC;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO;IA6C7C;;;;;;;;;OASG;IACH,SAAS,CAAC,gBAAgB,CACxB,MAAM,EAAE,OAAO,GAAG,MAAM,EACxB,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,YAAY,EACjB,UAAU,UAAQ,GACjB,YAAY;IAkDf;;;;;;;OAOG;IACH,SAAS,CAAC,sBAAsB,CAC9B,GAAG,EAAE,OAAO,GAAG,MAAM,EACrB,GAAG,EAAE,QAAQ,GAAG,SAAS,EACzB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,GACjB,YAAY;CAehB"}
+{"version":3,"file":"redirects-proxy.d.ts","sourceRoot":"","sources":["../../src/proxy/redirects-proxy.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EAItB,YAAY,EAEb,MAAM,oCAAoC,CAAC;AAO5C,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAExD,OAAO,EAAE,SAAS,EAAE,eAAe,EAAuB,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAM3C,KAAK,cAAc,GAAG,YAAY,GAAG;IAAE,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,EAAE,OAAO,GAAG,eAAe,CAAC,GACxF,cAAc,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,GAC7B,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GACpD,eAAe,GACf,cAAc,CAAC,WAAW,CAAC,GAAG;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC;AACJ;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,SAAS;IAO/B,SAAS,CAAC,MAAM,EAAE,oBAAoB;IANlD,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpD,OAAO,CAAC,OAAO,CAAW;IAE1B;;OAEG;gBACmB,MAAM,EAAE,oBAAoB;IAmDlD,MAAM,GAAU,KAAK,WAAW,EAAE,KAAK,YAAY,KAAG,OAAO,CAAC,YAAY,CAAC,CA4KzE;IAEF,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS;IAU5E;;;;;;OAMG;cACa,iBAAiB,CAC/B,GAAG,EAAE,WAAW,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IA2BtC;;;;;;;;OAQG;IACH,SAAS,CAAC,4BAA4B,CACpC,SAAS,EAAE,cAAc,EAAE,EAC3B,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,GACjB,cAAc,GAAG,SAAS;IAsE7B;;;;;;;OAOG;IACH,SAAS,CAAC,yBAAyB,CACjC,SAAS,EAAE,cAAc,EAAE,EAC3B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,GAClB,cAAc,GAAG,SAAS;IAU7B;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO;IA6C7C;;;;;;;;;OASG;IACH,SAAS,CAAC,gBAAgB,CACxB,MAAM,EAAE,OAAO,GAAG,MAAM,EACxB,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,YAAY,EACjB,UAAU,UAAQ,GACjB,YAAY;IAkDf;;;;;;;OAOG;IACH,SAAS,CAAC,sBAAsB,CAC9B,GAAG,EAAE,OAAO,GAAG,MAAM,EACrB,GAAG,EAAE,QAAQ,GAAG,SAAS,EACzB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,GACjB,YAAY;CAehB"}