@sitecore-content-sdk/nextjs 0.1.0-beta.37 → 0.1.0-beta.38

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

@@ -20,14 +20,21 @@ class SitecoreNextjsClient extends client_1.SitecoreClient {
         this.initOptions = initOptions;
         this.componentPropsService = this.getComponentPropsService();
     }
-    // since path rewrite we rely on is only working in nextjs
+    /**
+     * 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 = (0, site_1.getSiteRewriteData)(resolvedPath, this.initOptions.defaultSite);
         // Resolve site by name
-        const site = this.siteResolver.getByName(siteData.siteName);
-        return site;
+        return (this.siteResolver.getByName(siteData.siteName) || {
+            name: siteData.siteName,
+            hostName: '',
+            language: '',
+        });
     }
     /**
      * Normalizes a nextjs path that could have been rewritten
@@ -44,10 +51,11 @@ class SitecoreNextjsClient extends client_1.SitecoreClient {
             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 || (0, personalize_1.getPersonalizedRewriteData)(_super.parsePath.call(this, path));
-            const site = pageOptions.site || this.resolveSiteFromPath(path).name;
+            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,

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

@@ -11,12 +11,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditingRenderMiddleware = exports.isDesignLibraryPreviewData = void 0;
 const core_1 = require("@sitecore-content-sdk/core");
-const layout_1 = require("@sitecore-content-sdk/core/layout");
 const editing_1 = require("@sitecore-content-sdk/core/editing");
+const layout_1 = require("@sitecore-content-sdk/core/layout");
 const utils_1 = require("../utils/utils");
 const render_middleware_1 = require("./render-middleware");
 const utils_2 = require("@sitecore-content-sdk/core/utils");
 const personalize_1 = require("@sitecore-content-sdk/core/personalize");
+const site_1 = require("@sitecore-content-sdk/core/site");
 /**
  * Type guard for Design Library mode
  * @param {object} data preview data to check
@@ -103,7 +104,6 @@ class EditingRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
                     renderingId: query.sc_renderingId,
                     language: query.sc_lang,
                     site: query.sc_site,
-                    pageState: layout_1.LayoutServicePageState.Normal,
                     mode: 'library',
                     dataSourceId: query.sc_datasourceId,
                     version: query.sc_version,
@@ -119,7 +119,7 @@ class EditingRenderMiddleware extends render_middleware_1.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(',')) || [personalize_1.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
@@ -147,6 +147,12 @@ class EditingRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
                     }
                     return cookie;
                 });
+                // Set Preview mode identifier cookie, if the page is rendered in Sitecore Preview mode
+                if (mode === layout_1.LayoutServicePageState.Preview) {
+                    const previewSite = `${site_1.SITE_KEY}=${query.sc_site}; Path=/; HttpOnly; SameSite=None; Secure`;
+                    const previewCookie = `${editing_1.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/cjs/middleware/middleware.js

@@ -27,7 +27,6 @@ class MiddlewareBase extends Middleware {
     constructor(config) {
         super();
         this.config = config;
-        this.SITE_SYMBOL = 'sc_site';
         this.siteResolver = new site_1.SiteResolver(config.sites);
         this.defaultHostname = config.defaultHostname || 'localhost';
     }
@@ -86,18 +85,27 @@ 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_1.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);
     }
     /**

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

@@ -1,4 +1,5 @@
 "use strict";
+/* 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) {
@@ -13,6 +14,7 @@ exports.MultisiteMiddleware = void 0;
 const site_1 = require("@sitecore-content-sdk/core/site");
 const core_1 = require("@sitecore-content-sdk/core");
 const middleware_1 = require("./middleware");
+const editing_1 = require("@sitecore-content-sdk/core/editing");
 /**
  * Middleware / handler for multisite support
  */
@@ -24,7 +26,7 @@ class MultisiteMiddleware extends middleware_1.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) {
                 core_1.debug.multisite('skipped (multisite middleware is disabled globally)');
                 return res;
@@ -47,12 +49,21 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
                     core_1.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(editing_1.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_1.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_1.SITE_KEY) ||
+                            (this.config.useCookieResolution &&
+                                this.config.useCookieResolution(req) &&
+                                ((_c = req.cookies.get(site_1.SITE_KEY)) === null || _c === void 0 ? void 0 : _c.value)) ||
+                            this.siteResolver.getByHost(hostname).name;
+                }
                 // Rewrite to site specific path
                 const rewritePath = (0, site_1.getSiteRewrite)(pathname, {
                     siteName,
@@ -65,7 +76,7 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
                     sameSite: 'none',
                 };
                 // Share site name with the following executed middlewares
-                response.cookies.set(this.SITE_SYMBOL, siteName, defaultCookieAttributes);
+                response.cookies.set(site_1.SITE_KEY, siteName, defaultCookieAttributes);
                 core_1.debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
                     rewritePath,
                     siteName,

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

@@ -17,14 +17,21 @@ export class SitecoreNextjsClient extends SitecoreClient {
         this.initOptions = initOptions;
         this.componentPropsService = this.getComponentPropsService();
     }
-    // since path rewrite we rely on is only working in nextjs
+    /**
+     * 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
-        const site = this.siteResolver.getByName(siteData.siteName);
-        return site;
+        return (this.siteResolver.getByName(siteData.siteName) || {
+            name: siteData.siteName,
+            hostName: '',
+            language: '',
+        });
     }
     /**
      * Normalizes a nextjs path that could have been rewritten
@@ -41,10 +48,11 @@ export class SitecoreNextjsClient extends SitecoreClient {
             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 || this.resolveSiteFromPath(path).name;
+            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,

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

@@ -8,12 +8,13 @@ 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 Design Library mode
  * @param {object} data preview data to check
@@ -99,7 +100,6 @@ export class EditingRenderMiddleware extends RenderMiddlewareBase {
                     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,
@@ -115,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
@@ -143,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/middleware/middleware.js

@@ -7,7 +7,7 @@ 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';
@@ -23,7 +23,6 @@ export class MiddlewareBase extends Middleware {
     constructor(config) {
         super();
         this.config = config;
-        this.SITE_SYMBOL = 'sc_site';
         this.siteResolver = new SiteResolver(config.sites);
         this.defaultHostname = config.defaultHostname || 'localhost';
     }
@@ -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);
     }
     /**

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/nextjs",
-  "version": "0.1.0-beta.37",
+  "version": "0.1.0-beta.38",
   "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.37",
-    "@sitecore-content-sdk/react": "0.1.0-beta.37",
+    "@sitecore-content-sdk/core": "0.1.0-beta.38",
+    "@sitecore-content-sdk/react": "0.1.0-beta.38",
     "@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": "a2ec7a7854734141e897689e5aa12156cd15a87c",
+  "gitHead": "0309249c0004a7eb8d9c8a371b1fe6550ed3051d",
   "files": [
     "dist",
     "types",

package/types/client/sitecore-nextjs-client.d.ts

@@ -3,7 +3,6 @@ import { ComponentPropsCollection, NextjsJssComponent } from '../sharedTypes/com
 import { GetServerSidePropsContext, GetStaticPropsContext, PreviewData } from 'next';
 import { LayoutServiceData } from '@sitecore-content-sdk/core/layout';
 import { ComponentPropsService } from '../services/component-props-service';
-import { SiteInfo } from '../site';
 import { ComponentMap } from '@sitecore-content-sdk/react';
 export type NextjsPage = Page & {
     componentProps?: ComponentPropsCollection;
@@ -13,7 +12,12 @@ export declare class SitecoreNextjsClient extends SitecoreClient {
     protected initOptions: SitecoreClientInit;
     protected componentPropsService: ComponentPropsService;
     constructor(initOptions: SitecoreClientInit);
-    resolveSiteFromPath(path: string | string[]): SiteInfo;
+    /**
+     * 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: string | string[]): import("@sitecore-content-sdk/core/site").SiteInfo;
     /**
      * Normalizes a nextjs path that could have been rewritten
      * @param {string | string[]} path nextjs path

package/types/middleware/middleware.d.ts

@@ -40,7 +40,6 @@ export declare abstract class Middleware {
  */
 export declare abstract class MiddlewareBase extends Middleware {
     protected config: MiddlewareBaseConfig;
-    protected SITE_SYMBOL: string;
     protected defaultHostname: string;
     protected siteResolver: SiteResolver;
     constructor(config: MiddlewareBaseConfig);
@@ -78,8 +77,9 @@ export declare abstract class MiddlewareBase extends Middleware {
      */
     protected getHostHeader(req: NextRequest): string | undefined;
     /**
-     * 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