@sitecore-content-sdk/nextjs 0.1.0-beta.9 → 0.1.0-canary.0

package/dist/esm/client/sitecore-nextjs-client.js

@@ -0,0 +1,113 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { SitecoreClient, } from '@sitecore-content-sdk/core/client';
+import { ComponentPropsService } from '../services/component-props-service';
+import { getSiteRewriteData, normalizeSiteRewrite } from '@sitecore-content-sdk/core/site';
+import { getPersonalizedRewriteData, normalizePersonalizedRewrite, } from '@sitecore-content-sdk/core/personalize';
+export class SitecoreNextjsClient extends SitecoreClient {
+    constructor(initOptions) {
+        super(initOptions);
+        this.initOptions = initOptions;
+        this.componentPropsService = this.getComponentPropsService();
+    }
+    /**
+     * Resolves site based on the provided path
+     * @param {string | string[]} path path to resolve site from
+     * @returns resolved site, or default site info if not found
+     */
+    resolveSiteFromPath(path) {
+        const resolvedPath = super.parsePath(path);
+        // Get site name (from path rewritten in middleware)
+        const siteData = getSiteRewriteData(resolvedPath, this.initOptions.defaultSite);
+        // Resolve site by name
+        return (this.siteResolver.getByName(siteData.siteName) || {
+            name: siteData.siteName,
+            hostName: '',
+            language: '',
+        });
+    }
+    /**
+     * Normalizes a nextjs path that could have been rewritten
+     * @param {string | string[]} path nextjs path
+     * @returns path string without nextjs prefixes
+     */
+    parsePath(path) {
+        const basePath = super.parsePath(path);
+        return normalizeSiteRewrite(normalizePersonalizedRewrite(basePath));
+    }
+    getPage(path, pageOptions, options) {
+        const _super = Object.create(null, {
+            parsePath: { get: () => super.parsePath },
+            getPage: { get: () => super.getPage }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const resolvedPath = this.parsePath(path);
+            // Get variant(s) for personalization (from path), must ensure path is of type string
+            const personalizeData = pageOptions.personalize || getPersonalizedRewriteData(_super.parsePath.call(this, path));
+            const site = pageOptions.site || ((_a = this.resolveSiteFromPath(path)) === null || _a === void 0 ? void 0 : _a.name);
+            const page = yield _super.getPage.call(this, resolvedPath, {
+                locale: pageOptions.locale,
+                site,
+                personalize: personalizeData,
+            }, options);
+            return page;
+        });
+    }
+    /**
+     * Retrieves preview page and layout details
+     * @param {PreviewData} previewData - The editing preview data for metadata mode.
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     */
+    getPreview(previewData, fetchOptions) {
+        const _super = Object.create(null, {
+            getPreview: { get: () => super.getPreview }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.getPreview.call(this, previewData, fetchOptions);
+        });
+    }
+    /**
+     * Parses components from nextjs component map and layoutData, executes getServerProps/getStaticProps methods
+     * and returns resulting props from components
+     * @param {LayoutServiceData} layoutData layout data to parse compnents from
+     * @param {PreviewData} context Nextjs preview data
+     * @param {ComponentMap<NextjsJssComponent>} components component map to get props for
+     * @returns {ComponentPropsCollection} component props
+     */
+    getComponentData(layoutData, context, components) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let componentProps = {};
+            if (!layoutData.sitecore.route)
+                return componentProps;
+            // Retrieve component props using side-effects defined on components level
+            componentProps = yield this.componentPropsService.fetchComponentProps({
+                layoutData: layoutData,
+                context,
+                components,
+            });
+            const errors = Object.keys(componentProps)
+                .map((id) => {
+                const component = componentProps[id];
+                return component.error
+                    ? `\nUnable to get component props for ${component.componentName} (${id}): ${component.error}`
+                    : '';
+            })
+                .join('');
+            if (errors.length) {
+                throw new Error(errors);
+            }
+            return componentProps;
+        });
+    }
+    getComponentPropsService() {
+        return new ComponentPropsService();
+    }
+}

package/dist/esm/components/RichText.js

@@ -13,7 +13,7 @@ import React, { useEffect, useRef } from 'react';
 import PropTypes from 'prop-types';
 import { useRouter } from 'next/router';
 import { RichText as ReactRichText, RichTextPropTypes, } from '@sitecore-content-sdk/react';
-const prefetched = {};
+export const prefetched = {};
 export const RichText = (props) => {
     const { internalLinksSelector = 'a[href^="/"]', prefetchLinks = true, editable = true } = props, rest = __rest(props, ["internalLinksSelector", "prefetchLinks", "editable"]);
     const hasText = props.field && props.field.value;
@@ -42,9 +42,21 @@ export const RichText = (props) => {
         internalLinks.forEach((link) => {
             if (link.target === '_blank')
                 return;
-            if (prefetchLinks && !prefetched[link.pathname]) {
+            const prefetch = () => {
                 router.prefetch(link.pathname, undefined, { locale: false });
                 prefetched[link.pathname] = true;
+            };
+            if (!prefetched[link.pathname] && prefetchLinks !== false) {
+                if (prefetchLinks === true) {
+                    prefetch();
+                }
+                if (prefetchLinks === 'hover') {
+                    const mouseOverHandler = () => {
+                        prefetch();
+                        link.removeEventListener('mouseover', mouseOverHandler);
+                    };
+                    link.addEventListener('mouseover', mouseOverHandler, false);
+                }
             }
             link.addEventListener('click', routeHandler, false);
         });

package/dist/esm/config/define-cli-config.js

@@ -0,0 +1,26 @@
+import { defineCliConfig as defineCliConfigCore, } from '@sitecore-content-sdk/core/config';
+import { byocTemplate } from '../tools/templating/byoc-component';
+import { defaultTemplate } from '../tools/templating/default-component';
+/**
+ * Accepts a `SitecoreCliConfigInput` object and returns the Sitecore Content SDK CLI configuration from the specified file,
+ * updated with the required default values.
+ * @param {SitecoreCliConfigInput} cliConfig the cli configuration provided by the application
+ * @returns {SitecoreCliConfig} full sitecore cli configuration to use with cli
+ */
+export const defineCliConfig = (cliConfig) => {
+    addDefaultScaffoldTemplates(cliConfig);
+    return defineCliConfigCore(cliConfig);
+};
+/**
+ * Adds default scaffold templates to the CLI configuration.
+ * @param {SitecoreCliConfigInput} cliConfig - The CLI configuration object
+ */
+function addDefaultScaffoldTemplates(cliConfig) {
+    if (!cliConfig.scaffold) {
+        cliConfig.scaffold = {};
+    }
+    if (!cliConfig.scaffold.templates) {
+        cliConfig.scaffold.templates = [];
+    }
+    cliConfig.scaffold.templates.unshift(defaultTemplate, byocTemplate);
+}

package/dist/esm/config/index.js

@@ -1 +1,2 @@
 export { defineConfig, } from '@sitecore-content-sdk/core/config';
+export { defineCliConfig } from './define-cli-config';

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

@@ -38,9 +38,7 @@ export class EditingConfigMiddleware {
                 // CORS headers are set by enforceCors
                 return res.status(204).send(null);
             }
-            const components = Array.isArray(this.config.components)
-                ? this.config.components
-                : Array.from(this.config.components.keys());
+            const components = Array.from(this.config.components.keys());
             return res.status(200).json({
                 components,
                 packages: this.config.metadata.packages,

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

@@ -8,19 +8,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { debug } from '@sitecore-content-sdk/core';
+import { QUERY_PARAM_EDITING_SECRET, EDITING_ALLOWED_ORIGINS, PREVIEW_KEY, } from '@sitecore-content-sdk/core/editing';
 import { LayoutServicePageState } from '@sitecore-content-sdk/core/layout';
-import { QUERY_PARAM_EDITING_SECRET, EDITING_ALLOWED_ORIGINS, } from '@sitecore-content-sdk/core/editing';
 import { getJssEditingSecret } from '../utils/utils';
 import { RenderMiddlewareBase } from './render-middleware';
 import { enforceCors, getAllowedOriginsFromEnv } from '@sitecore-content-sdk/core/utils';
 import { DEFAULT_VARIANT } from '@sitecore-content-sdk/core/personalize';
+import { SITE_KEY } from '@sitecore-content-sdk/core/site';
 /**
- * Type guard for Component Library mode
+ * Type guard for Design Library mode
  * @param {object} data preview data to check
  * @returns true if the data is EditingPreviewData
  * @see EditingPreviewData
  */
-export const isComponentLibraryPreviewData = (data) => {
+export const isDesignLibraryPreviewData = (data) => {
     return (typeof data === 'object' &&
         data !== null &&
         'mode' in data &&
@@ -93,15 +94,12 @@ export class EditingRenderMiddleware extends RenderMiddlewareBase {
                 });
             }
             if (mode === 'library') {
-                // dedicated route and layout to SSR component library
-                query.route = '/component-library/render';
                 res.setPreviewData({
                     itemId: query.sc_itemid,
                     componentUid: query.sc_uid,
                     renderingId: query.sc_renderingId,
                     language: query.sc_lang,
                     site: query.sc_site,
-                    pageState: LayoutServicePageState.Normal,
                     mode: 'library',
                     dataSourceId: query.sc_datasourceId,
                     version: query.sc_version,
@@ -117,7 +115,7 @@ export class EditingRenderMiddleware extends RenderMiddlewareBase {
                     // for sc_variantId we may employ multiple variants (page-layout + component level)
                     variantIds: ((_c = query.sc_variant) === null || _c === void 0 ? void 0 : _c.split(',')) || [DEFAULT_VARIANT],
                     version: query.sc_version,
-                    pageState: query.mode,
+                    mode: 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
@@ -145,6 +143,12 @@ export class EditingRenderMiddleware extends RenderMiddlewareBase {
                     }
                     return cookie;
                 });
+                // Set Preview mode identifier cookie, if the page is rendered in Sitecore Preview mode
+                if (mode === LayoutServicePageState.Preview) {
+                    const previewSite = `${SITE_KEY}=${query.sc_site}; Path=/; HttpOnly; SameSite=None; Secure`;
+                    const previewCookie = `${PREVIEW_KEY}=true; Path=/; HttpOnly; SameSite=None; Secure`;
+                    modifiedCookies.push(previewSite, previewCookie);
+                }
                 res.setHeader('Set-Cookie', modifiedCookies);
             }
             const route = ((_e = (_d = this.config) === null || _d === void 0 ? void 0 : _d.resolvePageUrl) === null || _e === void 0 ? void 0 : _e.call(_d, query.route)) || query.route;

package/dist/esm/editing/index.js

@@ -1,5 +1,5 @@
 export { GraphQLEditingService } from '@sitecore-content-sdk/core/editing';
-export { EditingRenderMiddleware, isComponentLibraryPreviewData, } from './editing-render-middleware';
+export { EditingRenderMiddleware, isDesignLibraryPreviewData, } from './editing-render-middleware';
 export { FEAASRenderMiddleware } from './feaas-render-middleware';
 export { EditingConfigMiddleware, } from './editing-config-middleware';
 export { RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-content-sdk/core/layout';

package/dist/esm/index.js

@@ -1,14 +1,13 @@
 export { constants, 
 // generic data access
 NativeDataFetcher, enableDebug, debug, MemoryCacheClient, } from '@sitecore-content-sdk/core';
-export { LayoutServicePageState, GraphQLLayoutService, getChildPlaceholder, getFieldValue, getContentStylesheetLink, EditMode, } from '@sitecore-content-sdk/core/layout';
+export { LayoutServicePageState, GraphQLLayoutService, getChildPlaceholder, getFieldValue, getContentStylesheetLink, EditMode, RenderingType, } from '@sitecore-content-sdk/core/layout';
 export { RestComponentLayoutService } from '@sitecore-content-sdk/core/editing';
 export { mediaApi } from '@sitecore-content-sdk/core/media';
 export { GraphQLDictionaryService, } from '@sitecore-content-sdk/core/i18n';
 export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, getGroomedVariantIds, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-content-sdk/core/personalize';
 export { ComponentPropsService } from './services/component-props-service';
-export { GraphQLSitemapService, } from './services/graphql-sitemap-service';
-export { MultisiteGraphQLSitemapService, } from './services/mutisite-graphql-sitemap-service';
+export { GraphQLSitePathService, } from '@sitecore-content-sdk/core/site';
 export { GraphQLSitemapXmlService, GraphQLErrorPagesService, GraphQLRobotsService, SiteResolver, GraphQLSiteInfoService, getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, } from '@sitecore-content-sdk/core/site';
 export { ComponentPropsReactContext, ComponentPropsContext, useComponentProps, } from './components/ComponentPropsContext';
 export { Link } from './components/Link';
@@ -19,5 +18,4 @@ import * as FEaaSWrapper from './components/FEaaSWrapper';
 import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
 export { BYOCWrapper };
-export { ComponentBuilder } from './ComponentBuilder';
-export { Image, Text, DateField, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, ComponentLibraryLayout, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-content-sdk/react';
+export { Image, Text, DateField, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getDesignLibraryStylesheetLinks, File, DesignLibrary, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, Form, } from '@sitecore-content-sdk/react';

package/dist/esm/middleware/index.js

@@ -3,3 +3,4 @@ export { MiddlewareBase, Middleware, defineMiddleware } from './middleware';
 export { RedirectsMiddleware } from './redirects-middleware';
 export { PersonalizeMiddleware } from './personalize-middleware';
 export { MultisiteMiddleware } from './multisite-middleware';
+export { SitemapMiddleware } from './sitemap-middleware';

package/dist/esm/middleware/middleware.js

@@ -7,9 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { SiteResolver } from '@sitecore-content-sdk/core/site';
+import { SITE_KEY, 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
  */
@@ -22,8 +23,6 @@ export class MiddlewareBase extends Middleware {
     constructor(config) {
         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';
     }
@@ -52,7 +51,7 @@ export class MiddlewareBase extends Middleware {
         return (pathname.startsWith('/api/') || // Ignore Next.js API calls
             pathname.startsWith('/sitecore/') || // Ignore Sitecore API calls
             pathname.startsWith('/_next') || // Ignore next service calls
-            (this.config.disabled && this.config.disabled(req, res)));
+            (this.config.skip && this.config.skip(req, res)));
     }
     /**
      * Safely extract all headers for debug logging
@@ -71,7 +70,7 @@ export class MiddlewareBase extends Middleware {
      * @returns {string} language
      */
     getLanguage(req) {
-        return req.nextUrl.locale || req.nextUrl.defaultLocale || 'en';
+        return req.nextUrl.locale || req.nextUrl.defaultLocale || this.config.defaultLanguage || 'en';
     }
     /**
      * Extract 'host' header
@@ -82,18 +81,27 @@ export class MiddlewareBase extends Middleware {
         return (_a = req.headers.get('host')) === null || _a === void 0 ? void 0 : _a.split(':')[0];
     }
     /**
-     * Get site information.
-     * Can not be used in **Preview** mode, since site will not be resolved
+     * Get site information. If site name is stored in cookie, use it, otherwise resolve by hostname
+     * - If site can't be resolved by site name cookie use default site info based on provided parameters
+     * - If site can't be resolved by hostname throw an error
      * @param {NextRequest} req request
      * @param {NextResponse} [res] response
      * @returns {SiteInfo} site information
      */
     getSite(req, res) {
         var _a;
-        const siteNameCookie = (_a = res === null || res === void 0 ? void 0 : res.cookies.get(this.SITE_SYMBOL)) === null || _a === void 0 ? void 0 : _a.value;
-        if (siteNameCookie)
-            return this.siteResolver.getByName(siteNameCookie);
+        const siteNameCookie = (_a = res === null || res === void 0 ? void 0 : res.cookies.get(SITE_KEY)) === null || _a === void 0 ? void 0 : _a.value;
         const hostname = this.getHostHeader(req) || this.defaultHostname;
+        if (siteNameCookie) {
+            // Usually we should be able to resolve site by cookie
+            // in case of Sitecore Preview mode, there can be a case that new site was created
+            // but it's not present in the sitemap, so we fallback to default site info
+            return (this.siteResolver.getByName(siteNameCookie) || {
+                name: siteNameCookie,
+                language: this.getLanguage(req),
+                hostName: '*',
+            });
+        }
         return this.siteResolver.getByHost(hostname);
     }
     /**
@@ -101,14 +109,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/multisite-middleware.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -7,9 +8,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { getSiteRewrite } from '@sitecore-content-sdk/core/site';
+import { getSiteRewrite, SITE_KEY } from '@sitecore-content-sdk/core/site';
 import { debug } from '@sitecore-content-sdk/core';
 import { MiddlewareBase } from './middleware';
+import { PREVIEW_KEY } from '@sitecore-content-sdk/core/editing';
 /**
  * Middleware / handler for multisite support
  */
@@ -21,7 +23,7 @@ export class MultisiteMiddleware extends MiddlewareBase {
         super(config);
         this.config = config;
         this.handle = (req, res) => __awaiter(this, void 0, void 0, function* () {
-            var _a;
+            var _a, _b, _c;
             if (!this.config.enabled) {
                 debug.multisite('skipped (multisite middleware is disabled globally)');
                 return res;
@@ -44,12 +46,21 @@ export class MultisiteMiddleware extends MiddlewareBase {
                     debug.multisite('skipped (preview)');
                     return res;
                 }
-                // Site name can be forced by query string parameter or cookie
-                const siteName = req.nextUrl.searchParams.get(this.SITE_SYMBOL) ||
-                    (this.config.useCookieResolution &&
-                        this.config.useCookieResolution(req) &&
-                        ((_a = req.cookies.get(this.SITE_SYMBOL)) === null || _a === void 0 ? void 0 : _a.value)) ||
-                    this.siteResolver.getByHost(hostname).name;
+                let siteName;
+                const isSitecorePreview = (_a = req.cookies.get(PREVIEW_KEY)) === null || _a === void 0 ? void 0 : _a.value;
+                if (isSitecorePreview) {
+                    // This cookie is required to be set in the Sitecore Preview mode
+                    siteName = (_b = req.cookies.get(SITE_KEY)) === null || _b === void 0 ? void 0 : _b.value;
+                }
+                else {
+                    // Site name can be forced by query string parameter or cookie
+                    siteName =
+                        req.nextUrl.searchParams.get(SITE_KEY) ||
+                            (this.config.useCookieResolution &&
+                                this.config.useCookieResolution(req) &&
+                                ((_c = req.cookies.get(SITE_KEY)) === null || _c === void 0 ? void 0 : _c.value)) ||
+                            this.siteResolver.getByHost(hostname).name;
+                }
                 // Rewrite to site specific path
                 const rewritePath = getSiteRewrite(pathname, {
                     siteName,
@@ -62,7 +73,7 @@ export class MultisiteMiddleware extends MiddlewareBase {
                     sameSite: 'none',
                 };
                 // Share site name with the following executed middlewares
-                response.cookies.set(this.SITE_SYMBOL, siteName, defaultCookieAttributes);
+                response.cookies.set(SITE_KEY, siteName, defaultCookieAttributes);
                 debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
                     rewritePath,
                     siteName,

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';
 /**
@@ -32,7 +32,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 const language = this.getLanguage(req);
                 const hostname = this.getHostHeader(req) || this.defaultHostname;
                 const startTimestamp = Date.now();
-                const timeout = this.config.cdpTimeout;
+                const cdpTimeout = this.config.cdpTimeout;
                 debug.personalize('personalize middleware start: %o', {
                     pathname,
                     language,
@@ -84,7 +84,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                     variantIds: execution.variantIds,
                     params,
                     language,
-                    timeout,
+                    timeout: cdpTimeout,
                 }, req).then((personalization) => {
                     const variantId = personalization.variantId;
                     if (variantId) {
@@ -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/dist/esm/middleware/sitemap-middleware.js

@@ -0,0 +1,43 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * Middleware for handling sitemap requests in a Next.js application.
+ * Encapsulates all HTTP-related logic for sitemap generation and delivery.
+ */
+export class SitemapMiddleware {
+    constructor(client) {
+        this.client = client;
+    }
+    getHandler() {
+        return this.handler.bind(this);
+    }
+    handler(req, res) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const id = Array.isArray(req.query.id) ? req.query.id[0] : req.query.id;
+            const reqHost = req.headers.host || '';
+            const reqProtocol = req.headers['x-forwarded-proto'] || 'https';
+            const site = this.client.resolveSite(reqHost);
+            const options = { reqHost, reqProtocol, id, siteName: site.name };
+            try {
+                const xmlContent = yield this.client.getSiteMap(options);
+                res.setHeader('Content-Type', 'text/xml;charset=utf-8');
+                res.send(xmlContent);
+            }
+            catch (error) {
+                if (error instanceof Error && error.message === 'REDIRECT_404') {
+                    res.redirect('/404');
+                }
+                else {
+                    res.status(500).send('Internal Server Error');
+                }
+            }
+        });
+    }
+}