@sitecore-content-sdk/nextjs 1.3.0-canary.9 → 1.4.0-canary.2

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

@@ -1,80 +1,81 @@
-/* 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) {
-        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 { debug } from '@sitecore-content-sdk/core';
-import { getLocaleRewrite } from '@sitecore-content-sdk/core/i18n';
-import { MiddlewareBase, LOCALE_HEADER_NAME } from './middleware';
-/**
- * Middleware/handler for handling locale-based routing in the Next.js App Router.
- * This middleware is responsible for extracting the locale from the request path and rewriting it if necessary.
- * It also sets the locale header in the response.
- */
-export class LocaleMiddleware extends MiddlewareBase {
-    /**
-     * @param {LocaleMiddlewareConfig} config Locale middleware config
-     */
-    constructor(config) {
-        super(config);
-        this.config = config;
-        this.handle = (req, res) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const { pathname } = req.nextUrl;
-                const localeFromPath = this.getLocaleFromPath(pathname);
-                const locale = localeFromPath || this.getLanguage(req, res);
-                debug.locale('locale middleware start: %o', {
-                    pathname,
-                    locale,
-                });
-                if (this.disabled(req, res)) {
-                    debug.locale('skipped (locale middleware is disabled)');
-                    return res;
-                }
-                if (!localeFromPath) {
-                    // locale is not present in path, we need to rewrite to include the locale segment
-                    const rewritePath = getLocaleRewrite(pathname, locale);
-                    const response = this.rewrite(rewritePath, req, res);
-                    this.setLocaleHeader(response, locale);
-                    debug.locale('locale middleware end, with rewrite: %o', {
-                        pathname,
-                        locale,
-                        rewritePath,
-                    });
-                    return response;
-                }
-                this.setLocaleHeader(res, locale);
-                debug.locale('locale middleware end, no rewrite: %o', {
-                    pathname,
-                    locale,
-                });
-                return res;
-            }
-            catch (error) {
-                console.log('Locale middleware failed:');
-                console.log(error);
-                return res;
-            }
-        });
-    }
-    disabled(req, res) {
-        // ignore files
-        return req.nextUrl.pathname.includes('.') || super.disabled(req, res);
-    }
-    /**
-     * Extract locale from path
-     * @param {string} path request path
-     * @returns {string | undefined} the locale if found
-     */
-    getLocaleFromPath(path) {
-        return this.config.locales.find((locale) => path.includes(`/${locale}/`) || path.endsWith(`/${locale}`));
-    }
-    setLocaleHeader(res, locale) {
-        res.headers.set(LOCALE_HEADER_NAME, locale);
-    }
-}
+/* 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) {
+        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 { debug } from '@sitecore-content-sdk/core';
+import { getLocaleRewrite } from '@sitecore-content-sdk/core/i18n';
+import { MiddlewareBase, LOCALE_HEADER_NAME } from './middleware';
+/**
+ * Middleware/handler for handling locale-based routing in the Next.js App Router.
+ * This middleware is responsible for extracting the locale from the request path and rewriting it if necessary.
+ * It also sets the locale header in the response.
+ * @public
+ */
+export class LocaleMiddleware extends MiddlewareBase {
+    /**
+     * @param {LocaleMiddlewareConfig} config Locale middleware config
+     */
+    constructor(config) {
+        super(config);
+        this.config = config;
+        this.handle = (req, res) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { pathname } = req.nextUrl;
+                const localeFromPath = this.getLocaleFromPath(pathname);
+                const locale = localeFromPath || this.getLanguage(req, res);
+                debug.locale('locale middleware start: %o', {
+                    pathname,
+                    locale,
+                });
+                if (this.disabled(req, res)) {
+                    debug.locale('skipped (locale middleware is disabled)');
+                    return res;
+                }
+                if (!localeFromPath) {
+                    // locale is not present in path, we need to rewrite to include the locale segment
+                    const rewritePath = getLocaleRewrite(pathname, locale);
+                    const response = this.rewrite(rewritePath, req, res);
+                    this.setLocaleHeader(response, locale);
+                    debug.locale('locale middleware end, with rewrite: %o', {
+                        pathname,
+                        locale,
+                        rewritePath,
+                    });
+                    return response;
+                }
+                this.setLocaleHeader(res, locale);
+                debug.locale('locale middleware end, no rewrite: %o', {
+                    pathname,
+                    locale,
+                });
+                return res;
+            }
+            catch (error) {
+                console.log('Locale middleware failed:');
+                console.log(error);
+                return res;
+            }
+        });
+    }
+    disabled(req, res) {
+        // ignore files
+        return req.nextUrl.pathname.includes('.') || super.disabled(req, res);
+    }
+    /**
+     * Extract locale from path
+     * @param {string} path request path
+     * @returns {string | undefined} the locale if found
+     */
+    getLocaleFromPath(path) {
+        return this.config.locales.find((locale) => path.includes(`/${locale}/`) || path.endsWith(`/${locale}`));
+    }
+    setLocaleHeader(res, locale) {
+        res.headers.set(LOCALE_HEADER_NAME, locale);
+    }
+}

package/dist/esm/middleware/middleware.js

@@ -1,186 +1,189 @@
-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 { SITE_KEY, SiteResolver } from '@sitecore-content-sdk/core/site';
-import { debug } from '@sitecore-content-sdk/core';
-import { NextResponse } from 'next/server';
-import { createGraphQLClientFactory, } from '@sitecore-content-sdk/core/client';
-export const REWRITE_HEADER_NAME = 'x-sc-rewrite';
-export const LOCALE_HEADER_NAME = 'x-sc-locale';
-/**
- * Middleware class to be extended by all middleware implementations
- */
-export class Middleware {
-}
-/**
- * Base middleware class with common methods
- */
-export class MiddlewareBase extends Middleware {
-    constructor(config) {
-        super();
-        this.config = config;
-        this.siteResolver = new SiteResolver(config.sites);
-        this.defaultHostname = config.defaultHostname || 'localhost';
-    }
-    /**
-     * Determines if mode is preview
-     * @param {NextRequest} req request
-     * @returns {boolean} is preview
-     */
-    isPreview(req) {
-        var _a, _b;
-        return !!(((_a = req.cookies.get("__prerender_bypass" /* PreviewCookies.PRERENDER_BYPASS */)) === null || _a === void 0 ? void 0 : _a.value) ||
-            ((_b = req.cookies.get("__next_preview_data" /* PreviewCookies.PREVIEW_DATA */)) === null || _b === void 0 ? void 0 : _b.value));
-    }
-    /**
-     * Determines if the application is using the app router based on the locale header
-     * @param {NextResponse} res response
-     * @returns {boolean} true if app router is used
-     */
-    isAppRouter(res) {
-        return !!this.getLanguageFromHeader(res);
-    }
-    /**
-     * Determines if the request is a Next.js (next/link) prefetch request
-     * @param {NextRequest} req request
-     * @returns {boolean} is prefetch
-     */
-    isPrefetch(req) {
-        const isMobile = req.headers.get('sec-ch-ua-mobile') === '?1';
-        const userAgent = req.headers.get('user-agent') || '';
-        const isKnownPlatform = /iPhone|Mac|Linux|Windows|Android/i.test(userAgent);
-        const isKnownDevice = isMobile || isKnownPlatform;
-        const purpose = req.headers.get('purpose');
-        const nextRouterPrefetch = req.headers.get('Next-Router-Prefetch');
-        const middlewarePrefetch = req.headers.get('x-middleware-prefetch');
-        // Some real navigations on different devices may incorrectly include 'prefetch' headers.
-        // To avoid skipping personalization in such cases, we treat 'x-middleware-prefetch' as a more reliable signal of true prefetch behavior.
-        if (isKnownDevice && middlewarePrefetch === '1') {
-            return false;
-        }
-        // Otherwise, standard prefetch detection
-        return purpose === 'prefetch' || nextRouterPrefetch === '1' || middlewarePrefetch === '1';
-    }
-    disabled(req, res) {
-        const { pathname } = req.nextUrl;
-        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.skip && this.config.skip(req, res)));
-    }
-    /**
-     * Safely extract all headers for debug logging
-     * Necessary to avoid middleware issue https://github.com/vercel/next.js/issues/39765
-     * @param {Headers} incomingHeaders Incoming headers
-     * @returns Object with headers as key/value pairs
-     */
-    extractDebugHeaders(incomingHeaders) {
-        const headers = {};
-        incomingHeaders.forEach((value, key) => (headers[key] = value));
-        return headers;
-    }
-    /**
-     * Provides used language
-     * @param {NextRequest} req request
-     * @param {NextResponse} res response
-     * @returns {string} language
-     */
-    getLanguage(req, res) {
-        return (this.getLanguageFromHeader(res) ||
-            req.nextUrl.locale ||
-            req.nextUrl.defaultLocale ||
-            this.config.defaultLanguage ||
-            'en');
-    }
-    /**
-     * Extract language from locale header of the response
-     * set by LocaleMiddleware for app router application
-     * @param {NextResponse} res response
-     * @returns {string | undefined} language or undefined if not found
-     */
-    getLanguageFromHeader(res) {
-        var _a;
-        return (_a = res === null || res === void 0 ? void 0 : res.headers.get(LOCALE_HEADER_NAME)) !== null && _a !== void 0 ? _a : undefined;
-    }
-    /**
-     * Extract 'host' header
-     * @param {NextRequest} req request
-     */
-    getHostHeader(req) {
-        var _a;
-        return (_a = req.headers.get('host')) === null || _a === void 0 ? void 0 : _a.split(':')[0];
-    }
-    /**
-     * 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(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);
-    }
-    getClientFactory(graphQLOptions) {
-        return createGraphQLClientFactory(graphQLOptions);
-    }
-    /**
-     * Create a rewrite response
-     * @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, 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
-        if (!skipHeader) {
-            response.headers.set(REWRITE_HEADER_NAME, rewritePath);
-        }
-        return response;
-    }
-}
-/**
- * Define a middleware with a list of middlewares
- * @param {Middleware[]} middlewares List of middlewares to execute
- */
-export const defineMiddleware = (...middlewares) => {
-    return {
-        /**
-         * Execute all middlewares
-         * @param {NextRequest} req request
-         * @param {NextFetchEvent} ev fetch event
-         * @param {NextResponse} [res] response
-         */
-        exec: (req, ev, res) => __awaiter(void 0, void 0, void 0, function* () {
-            const response = res || NextResponse.next();
-            debug.common('middleware start');
-            const start = Date.now();
-            const middlewareResponse = yield middlewares.reduce((p, middleware) => p.then((res) => middleware.handle(req, res, ev)), Promise.resolve(response));
-            debug.common('middleware end in %dms', Date.now() - start);
-            return middlewareResponse;
-        }),
-    };
-};
+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 { SITE_KEY, SiteResolver } from '@sitecore-content-sdk/core/site';
+import { debug } from '@sitecore-content-sdk/core';
+import { NextResponse } from 'next/server';
+import { createGraphQLClientFactory, } from '@sitecore-content-sdk/core/client';
+export const REWRITE_HEADER_NAME = 'x-sc-rewrite';
+export const LOCALE_HEADER_NAME = 'x-sc-locale';
+/**
+ * Middleware class to be extended by all middleware implementations
+ * @public
+ */
+export class Middleware {
+}
+/**
+ * Base middleware class with common methods
+ * @public
+ */
+export class MiddlewareBase extends Middleware {
+    constructor(config) {
+        super();
+        this.config = config;
+        this.siteResolver = new SiteResolver(config.sites);
+        this.defaultHostname = config.defaultHostname || 'localhost';
+    }
+    /**
+     * Determines if mode is preview
+     * @param {NextRequest} req request
+     * @returns {boolean} is preview
+     */
+    isPreview(req) {
+        var _a, _b;
+        return !!(((_a = req.cookies.get("__prerender_bypass" /* PreviewCookies.PRERENDER_BYPASS */)) === null || _a === void 0 ? void 0 : _a.value) ||
+            ((_b = req.cookies.get("__next_preview_data" /* PreviewCookies.PREVIEW_DATA */)) === null || _b === void 0 ? void 0 : _b.value));
+    }
+    /**
+     * Determines if the application is using the app router based on the locale header
+     * @param {NextResponse} res response
+     * @returns {boolean} true if app router is used
+     */
+    isAppRouter(res) {
+        return !!this.getLanguageFromHeader(res);
+    }
+    /**
+     * Determines if the request is a Next.js (next/link) prefetch request
+     * @param {NextRequest} req request
+     * @returns {boolean} is prefetch
+     */
+    isPrefetch(req) {
+        const isMobile = req.headers.get('sec-ch-ua-mobile') === '?1';
+        const userAgent = req.headers.get('user-agent') || '';
+        const isKnownPlatform = /iPhone|Mac|Linux|Windows|Android/i.test(userAgent);
+        const isKnownDevice = isMobile || isKnownPlatform;
+        const purpose = req.headers.get('purpose');
+        const nextRouterPrefetch = req.headers.get('Next-Router-Prefetch');
+        const middlewarePrefetch = req.headers.get('x-middleware-prefetch');
+        // Some real navigations on different devices may incorrectly include 'prefetch' headers.
+        // To avoid skipping personalization in such cases, we treat 'x-middleware-prefetch' as a more reliable signal of true prefetch behavior.
+        if (isKnownDevice && middlewarePrefetch === '1') {
+            return false;
+        }
+        // Otherwise, standard prefetch detection
+        return purpose === 'prefetch' || nextRouterPrefetch === '1' || middlewarePrefetch === '1';
+    }
+    disabled(req, res) {
+        const { pathname } = req.nextUrl;
+        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.skip && this.config.skip(req, res)));
+    }
+    /**
+     * Safely extract all headers for debug logging
+     * Necessary to avoid middleware issue https://github.com/vercel/next.js/issues/39765
+     * @param {Headers} incomingHeaders Incoming headers
+     * @returns Object with headers as key/value pairs
+     */
+    extractDebugHeaders(incomingHeaders) {
+        const headers = {};
+        incomingHeaders.forEach((value, key) => (headers[key] = value));
+        return headers;
+    }
+    /**
+     * Provides used language
+     * @param {NextRequest} req request
+     * @param {NextResponse} res response
+     * @returns {string} language
+     */
+    getLanguage(req, res) {
+        return (this.getLanguageFromHeader(res) ||
+            req.nextUrl.locale ||
+            req.nextUrl.defaultLocale ||
+            this.config.defaultLanguage ||
+            'en');
+    }
+    /**
+     * Extract language from locale header of the response
+     * set by LocaleMiddleware for app router application
+     * @param {NextResponse} res response
+     * @returns {string | undefined} language or undefined if not found
+     */
+    getLanguageFromHeader(res) {
+        var _a;
+        return (_a = res === null || res === void 0 ? void 0 : res.headers.get(LOCALE_HEADER_NAME)) !== null && _a !== void 0 ? _a : undefined;
+    }
+    /**
+     * Extract 'host' header
+     * @param {NextRequest} req request
+     */
+    getHostHeader(req) {
+        var _a;
+        return (_a = req.headers.get('host')) === null || _a === void 0 ? void 0 : _a.split(':')[0];
+    }
+    /**
+     * 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(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);
+    }
+    getClientFactory(graphQLOptions) {
+        return createGraphQLClientFactory(graphQLOptions);
+    }
+    /**
+     * Create a rewrite response
+     * @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, 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
+        if (!skipHeader) {
+            response.headers.set(REWRITE_HEADER_NAME, rewritePath);
+        }
+        return response;
+    }
+}
+/**
+ * Define a middleware with a list of middlewares
+ * @param {Middleware[]} middlewares List of middlewares to execute
+ * @public
+ */
+export const defineMiddleware = (...middlewares) => {
+    return {
+        /**
+         * Execute all middlewares
+         * @param {NextRequest} req request
+         * @param {NextFetchEvent} ev fetch event
+         * @param {NextResponse} [res] response
+         */
+        exec: (req, ev, res) => __awaiter(void 0, void 0, void 0, function* () {
+            const response = res || NextResponse.next();
+            debug.common('middleware start');
+            const start = Date.now();
+            const middlewareResponse = yield middlewares.reduce((p, middleware) => p.then((res) => middleware.handle(req, res, ev)), Promise.resolve(response));
+            debug.common('middleware end in %dms', Date.now() - start);
+            return middlewareResponse;
+        }),
+    };
+};