@sitecore-jss/sitecore-jss-nextjs 21.6.0-canary.4 → 21.6.0-canary.41

package/README.md

@@ -2,11 +2,8 @@
 
 This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains Next.js components and integration for JSS.
 
-<!---
-@TODO: Update to next version docs before release
--->
 [Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/21/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
 
 [Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
 
-[API reference documentation](/ref-docs/sitecore-jss-nextjs/)
+[API reference documentation](/ref-docs/sitecore-jss-nextjs/)

package/context.d.ts

@@ -0,0 +1 @@
+export * from './types/context/index';

package/context.js

@@ -0,0 +1 @@
+module.exports = require('./dist/cjs/context/index');

package/dist/cjs/context/context.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Context = void 0;
+const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
+/**
+ * Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
+ */
+class Context {
+    constructor(props) {
+        this.props = props;
+        /**
+         * Indicates whether the Context and SDK(s) have been initialized
+         */
+        this.isInitialized = false;
+        /**
+         * Software Development Kits (SDKs) to be initialized
+         */
+        this.sdks = {};
+        /**
+         * Promises for the SDKs
+         */
+        this.sdkPromises = {};
+        /**
+         * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
+         *
+         * @param {string} name SDK name
+         * @returns initialized SDK
+         */
+        this.getSDK = (name) => {
+            return this.sdkPromises[name] || Promise.reject(`Unknown SDK '${String(name)}'`);
+        };
+        this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
+        this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
+        this.siteName = props.siteName;
+        this.pageState = sitecore_jss_react_1.LayoutServicePageState.Normal;
+    }
+    init(props = {}) {
+        // Context and SDKs are initialized only once
+        if (this.isInitialized)
+            return;
+        this.isInitialized = true;
+        if (props.siteName) {
+            this.siteName = props.siteName;
+        }
+        if (props.pageState) {
+            this.pageState = props.pageState;
+        }
+        // iterate over the SDKs and initialize them
+        for (const sdkName of Object.keys(this.props.sdks)) {
+            this.initSDK(sdkName);
+        }
+    }
+    /**
+     * Initializes the Software Development Kit (SDK)
+     *
+     * @param {T} name SDK name
+     * @returns {void}
+     */
+    initSDK(name) {
+        this.sdkPromises[name] = new Promise((resolve) => {
+            this.props.sdks[name].init(this).then(() => {
+                this.sdks[name] = this.props.sdks[name].sdk;
+                resolve(this.sdks[name]);
+            });
+        });
+    }
+}
+exports.Context = Context;

package/dist/cjs/context/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Context = void 0;
+var context_1 = require("./context");
+Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });

package/dist/cjs/editing/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QUERY_PARAM_PROTECTION_BYPASS_VERCEL = exports.QUERY_PARAM_PROTECTION_BYPASS_SITECORE = exports.QUERY_PARAM_EDITING_SECRET = void 0;
+exports.QUERY_PARAM_EDITING_SECRET = 'secret';
+exports.QUERY_PARAM_PROTECTION_BYPASS_SITECORE = 'x-sitecore-protection-bypass';
+exports.QUERY_PARAM_PROTECTION_BYPASS_VERCEL = 'x-vercel-protection-bypass';

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

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditingDataMiddleware = void 0;
 const editing_data_cache_1 = require("./editing-data-cache");
 const editing_data_1 = require("./editing-data");
-const editing_data_service_1 = require("./editing-data-service");
+const constants_1 = require("./constants");
 const utils_1 = require("../utils/utils");
 /**
  * Middleware / handler for use in the editing data Next.js API dynamic route (e.g. '/api/editing/data/[key]')
@@ -26,7 +26,7 @@ class EditingDataMiddleware {
         var _a, _b;
         this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
             const { method, query, body } = req;
-            const secret = query[editing_data_service_1.QUERY_PARAM_EDITING_SECRET];
+            const secret = query[constants_1.QUERY_PARAM_EDITING_SECRET];
             const key = query[this.queryParamKey];
             // Validate secret
             if (secret !== (0, utils_1.getJssEditingSecret)()) {

package/dist/cjs/editing/editing-data-service.js

@@ -9,11 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.generateKey = exports.QUERY_PARAM_EDITING_SECRET = void 0;
+exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.generateKey = void 0;
+const constants_1 = require("./constants");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const editing_data_cache_1 = require("./editing-data-cache");
 const utils_1 = require("../utils/utils");
-exports.QUERY_PARAM_EDITING_SECRET = 'secret';
 /**
  * Unique key generator.
  * Need more than just the item GUID since requests are made "live" during editing in EE.
@@ -98,13 +98,14 @@ class ServerlessEditingDataService {
      * @param {string} serverUrl The server url to use for subsequent data API requests
      * @returns {Promise} The {@link EditingPreviewData} containing the generated key and serverUrl to use for retrieval
      */
-    setEditingData(data, serverUrl) {
+    setEditingData(data, serverUrl, params) {
         return __awaiter(this, void 0, void 0, function* () {
             const key = this.generateKey(data);
-            const url = this.getUrl(serverUrl, key);
+            const url = this.getUrl(serverUrl, key, params);
             const previewData = {
                 key,
                 serverUrl,
+                params,
             };
             sitecore_jss_1.debug.editing('storing editing data for %o: %o', previewData, data);
             return this.dataFetcher.put(url, data).then(() => {
@@ -123,20 +124,27 @@ class ServerlessEditingDataService {
             if (!(editingPreviewData === null || editingPreviewData === void 0 ? void 0 : editingPreviewData.serverUrl)) {
                 return undefined;
             }
-            const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key);
+            const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key, editingPreviewData.params);
             sitecore_jss_1.debug.editing('retrieving editing data for %o', previewData);
             return this.dataFetcher.get(url).then((response) => {
                 return response.data;
             });
         });
     }
-    getUrl(serverUrl, key) {
+    getUrl(serverUrl, key, params) {
         var _a;
         // Example URL format:
         //  http://localhost:3000/api/editing/data/52961eea-bafd-5287-a532-a72e36bd8a36-qkb4e3fv5x?secret=1234secret
         const apiRoute = (_a = this.apiRoute) === null || _a === void 0 ? void 0 : _a.replace('[key]', key);
         const url = new URL(apiRoute, serverUrl);
-        url.searchParams.append(exports.QUERY_PARAM_EDITING_SECRET, (0, utils_1.getJssEditingSecret)());
+        url.searchParams.append(constants_1.QUERY_PARAM_EDITING_SECRET, (0, utils_1.getJssEditingSecret)());
+        if (params) {
+            for (const key in params) {
+                if ({}.hasOwnProperty.call(params, key)) {
+                    url.searchParams.append(key, params[key]);
+                }
+            }
+        }
         return url.toString();
     }
 }

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

@@ -15,6 +15,7 @@ const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
 const node_html_parser_1 = require("node-html-parser");
 const editing_data_service_1 = require("./editing-data-service");
+const constants_2 = require("./constants");
 const utils_1 = require("../utils/utils");
 /**
  * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
@@ -26,6 +27,21 @@ class EditingRenderMiddleware {
      */
     constructor(config) {
         var _a, _b, _c, _d;
+        /**
+         * Gets query parameters that should be passed along to subsequent requests
+         * @param query Object of query parameters from incoming URL
+         * @returns Object of approved query parameters
+         */
+        this.getQueryParamsForPropagation = (query) => {
+            const params = {};
+            if (query[constants_2.QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
+                params[constants_2.QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[constants_2.QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
+            }
+            if (query[constants_2.QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
+                params[constants_2.QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[constants_2.QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
+            }
+            return params;
+        };
         this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
             var _e, _f;
             const { method, query, body, headers } = req;
@@ -44,7 +60,7 @@ class EditingRenderMiddleware {
                 });
             }
             // Validate secret
-            const secret = (_e = query[editing_data_service_1.QUERY_PARAM_EDITING_SECRET]) !== null && _e !== void 0 ? _e : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
+            const secret = (_e = query[constants_2.QUERY_PARAM_EDITING_SECRET]) !== null && _e !== void 0 ? _e : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
             if (secret !== (0, utils_1.getJssEditingSecret)()) {
                 sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
                 return res.status(401).json({
@@ -56,21 +72,28 @@ class EditingRenderMiddleware {
                 const editingData = extractEditingData(req);
                 // Resolve server URL
                 const serverUrl = this.resolveServerUrl(req);
+                // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
+                const params = this.getQueryParamsForPropagation(query);
                 // Stash for use later on (i.e. within getStatic/ServerSideProps).
                 // Note we can't set this directly in setPreviewData since it's stored as a cookie (2KB limit)
                 // https://nextjs.org/docs/advanced-features/preview-mode#previewdata-size-limits)
-                const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl);
+                const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl, params);
                 // Enable Next.js Preview Mode, passing our preview data (i.e. editingData cache key)
                 res.setPreviewData(previewData);
                 // Grab the Next.js preview cookies to send on to the render request
                 const cookies = res.getHeader('Set-Cookie');
-                // Make actual render request for page route, passing on preview cookies.
+                // Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
                 // Note timestamp effectively disables caching the request in Axios (no amount of cache headers seemed to do it)
-                const requestUrl = this.resolvePageUrl(serverUrl, editingData.path);
                 sitecore_jss_1.debug.editing('fetching page route for %s', editingData.path);
-                const queryStringCharacter = requestUrl.indexOf('?') === -1 ? '?' : '&';
+                const requestUrl = new URL(this.resolvePageUrl(serverUrl, editingData.path));
+                for (const key in params) {
+                    if ({}.hasOwnProperty.call(params, key)) {
+                        requestUrl.searchParams.append(key, params[key]);
+                    }
+                }
+                requestUrl.searchParams.append('timestamp', Date.now().toString());
                 const pageRes = yield this.dataFetcher
-                    .get(`${requestUrl}${queryStringCharacter}timestamp=${Date.now()}`, {
+                    .get(requestUrl.toString(), {
                     headers: {
                         Cookie: cookies.join(';'),
                     },
@@ -85,7 +108,7 @@ class EditingRenderMiddleware {
                 });
                 let html = pageRes.data;
                 if (!html || html.length === 0) {
-                    throw new Error(`Failed to render html for ${requestUrl}`);
+                    throw new Error(`Failed to render html for ${editingData.path}`);
                 }
                 // replace phkey attribute with key attribute so that newly added renderings
                 // show correct placeholders, so save and refresh won't be needed after adding each rendering
@@ -101,7 +124,7 @@ class EditingRenderMiddleware {
                     // Handle component rendering. Extract component markup only
                     html = (_f = (0, node_html_parser_1.parse)(html).getElementById(layout_1.EDITING_COMPONENT_ID)) === null || _f === void 0 ? void 0 : _f.innerHTML;
                     if (!html)
-                        throw new Error(`Failed to render component for ${requestUrl}`);
+                        throw new Error(`Failed to render component for ${editingData.path}`);
                 }
                 const body = { html };
                 // Return expected JSON result

package/dist/cjs/graphql/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEdgeProxyContentUrl = exports.GraphQLRequestClient = void 0;
+var graphql_1 = require("@sitecore-jss/sitecore-jss/graphql");
+Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_1.GraphQLRequestClient; } });
+Object.defineProperty(exports, "getEdgeProxyContentUrl", { enumerable: true, get: function () { return graphql_1.getEdgeProxyContentUrl; } });

package/dist/cjs/index.js

@@ -23,8 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NextImage = exports.EditingComponentPlaceholder = exports.Placeholder = exports.RichText = exports.Link = exports.useComponentProps = exports.ComponentPropsContext = exports.ComponentPropsReactContext = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSiteInfoService = exports.SiteResolver = exports.GraphQLRobotsService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.MultisiteGraphQLSitemapService = exports.GraphQLSitemapService = exports.DisconnectedSitemapService = exports.ComponentPropsService = exports.GraphQLRequestClient = exports.PosResolver = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.personalizeLayout = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.mediaApi = exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.tryParseEnvValue = exports.resolveUrl = exports.resetEditorChromes = exports.isEditorActive = exports.getPublicUrl = exports.handleEditorFastRefresh = exports.debug = exports.enableDebug = exports.NativeDataFetcher = exports.AxiosDataFetcher = exports.constants = void 0;
-exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = void 0;
+exports.NextImage = exports.EditingComponentPlaceholder = exports.Placeholder = exports.RichText = exports.Link = exports.useComponentProps = exports.ComponentPropsContext = exports.ComponentPropsReactContext = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSiteInfoService = exports.SiteResolver = exports.GraphQLRobotsService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.MultisiteGraphQLSitemapService = exports.GraphQLSitemapService = exports.DisconnectedSitemapService = exports.ComponentPropsService = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.personalizeLayout = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.mediaApi = exports.getContentStylesheetLink = exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.tryParseEnvValue = exports.resolveUrl = exports.resetEditorChromes = exports.isEditorActive = exports.getPublicUrl = exports.handleEditorFastRefresh = exports.GraphQLRequestClient = exports.debug = exports.enableDebug = exports.NativeDataFetcher = exports.AxiosDataFetcher = exports.constants = void 0;
+exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.Context = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = void 0;
 var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 Object.defineProperty(exports, "constants", { enumerable: true, get: function () { return sitecore_jss_1.constants; } });
 Object.defineProperty(exports, "AxiosDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.AxiosDataFetcher; } });
@@ -33,6 +33,7 @@ Object.defineProperty(exports, "enableDebug", { enumerable: true, get: function
 Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return sitecore_jss_1.debug; } });
 // we will remove the root exports for these later
 // we cannot mark exports as deprected directly, so we're using this hack instead
+const graphql_1 = require("./graphql");
 const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
 const utils_2 = require("./utils");
 /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
@@ -50,6 +51,11 @@ exports.resolveUrl = resolveUrl;
 exports.tryParseEnvValue = tryParseEnvValue;
 exports.handleEditorFastRefresh = handleEditorFastRefresh;
 exports.getPublicUrl = getPublicUrl;
+/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
+const { GraphQLRequestClientDep: GraphQLRequestClient } = {
+    GraphQLRequestClientDep: graphql_1.GraphQLRequestClient,
+};
+exports.GraphQLRequestClient = GraphQLRequestClient;
 var layout_1 = require("@sitecore-jss/sitecore-jss/layout");
 Object.defineProperty(exports, "LayoutServicePageState", { enumerable: true, get: function () { return layout_1.LayoutServicePageState; } });
 Object.defineProperty(exports, "GraphQLLayoutService", { enumerable: true, get: function () { return layout_1.GraphQLLayoutService; } });
@@ -59,6 +65,7 @@ Object.defineProperty(exports, "getFieldValue", { enumerable: true, get: functio
 Object.defineProperty(exports, "RenderingType", { enumerable: true, get: function () { return layout_1.RenderingType; } });
 Object.defineProperty(exports, "EDITING_COMPONENT_PLACEHOLDER", { enumerable: true, get: function () { return layout_1.EDITING_COMPONENT_PLACEHOLDER; } });
 Object.defineProperty(exports, "EDITING_COMPONENT_ID", { enumerable: true, get: function () { return layout_1.EDITING_COMPONENT_ID; } });
+Object.defineProperty(exports, "getContentStylesheetLink", { enumerable: true, get: function () { return layout_1.getContentStylesheetLink; } });
 var media_1 = require("@sitecore-jss/sitecore-jss/media");
 Object.defineProperty(exports, "mediaApi", { enumerable: true, get: function () { return media_1.mediaApi; } });
 var tracking_1 = require("@sitecore-jss/sitecore-jss/tracking");
@@ -72,9 +79,6 @@ Object.defineProperty(exports, "getPersonalizedRewrite", { enumerable: true, get
 Object.defineProperty(exports, "getPersonalizedRewriteData", { enumerable: true, get: function () { return personalize_1.getPersonalizedRewriteData; } });
 Object.defineProperty(exports, "normalizePersonalizedRewrite", { enumerable: true, get: function () { return personalize_1.normalizePersonalizedRewrite; } });
 Object.defineProperty(exports, "CdpHelper", { enumerable: true, get: function () { return personalize_1.CdpHelper; } });
-Object.defineProperty(exports, "PosResolver", { enumerable: true, get: function () { return personalize_1.PosResolver; } });
-var sitecore_jss_2 = require("@sitecore-jss/sitecore-jss");
-Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return sitecore_jss_2.GraphQLRequestClient; } });
 var component_props_service_1 = require("./services/component-props-service");
 Object.defineProperty(exports, "ComponentPropsService", { enumerable: true, get: function () { return component_props_service_1.ComponentPropsService; } });
 var disconnected_sitemap_service_1 = require("./services/disconnected-sitemap-service");
@@ -112,6 +116,8 @@ const BYOCWrapper = __importStar(require("./components/BYOCWrapper"));
 exports.BYOCWrapper = BYOCWrapper;
 var ComponentBuilder_1 = require("./ComponentBuilder");
 Object.defineProperty(exports, "ComponentBuilder", { enumerable: true, get: function () { return ComponentBuilder_1.ComponentBuilder; } });
+var context_1 = require("./context");
+Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });
 var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
 Object.defineProperty(exports, "Image", { enumerable: true, get: function () { return sitecore_jss_react_1.Image; } });
 Object.defineProperty(exports, "Text", { enumerable: true, get: function () { return sitecore_jss_react_1.Text; } });

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

@@ -14,7 +14,7 @@ const server_1 = require("next/server");
 const personalize_1 = require("@sitecore-jss/sitecore-jss/personalize");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const middleware_1 = require("./middleware");
-const engage_1 = require("@sitecore/engage");
+const server_2 = require("@sitecore-cloudsdk/personalize/server");
 /**
  * Middleware / handler to support Sitecore Personalize
  */
@@ -26,7 +26,6 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
         super(config);
         this.config = config;
         this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
-            var _a;
             const pathname = req.nextUrl.pathname;
             const language = this.getLanguage(req);
             const hostname = this.getHostHeader(req) || this.defaultHostname;
@@ -51,16 +50,6 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
                 return response;
             }
             const site = this.getSite(req, response);
-            const engageServer = this.initializeEngageServer(site, language);
-            // creates the browser ID cookie on the server side
-            // and includes the cookie in the response header
-            try {
-                yield engageServer.handleCookie(req, response, timeout);
-            }
-            catch (error) {
-                sitecore_jss_1.debug.personalize('skipped (browser id generation failed)');
-                throw error;
-            }
             // Get personalization info from Experience Edge
             const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
             if (!personalizeInfo) {
@@ -72,20 +61,20 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
                 sitecore_jss_1.debug.personalize('skipped (no personalization configured)');
                 return response;
             }
+            yield this.initPersonalizeServer({
+                hostname,
+                siteName: site.name,
+                request: req,
+                response,
+            });
             const params = this.getExperienceParams(req);
-            sitecore_jss_1.debug.personalize('executing experience for %s %s %o', personalizeInfo.contentId, params);
-            const personalizationData = {
-                channel: this.config.cdpConfig.channel || 'WEB',
-                currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USA',
-                friendlyId: personalizeInfo.contentId,
-                params,
-                language,
-            };
+            sitecore_jss_1.debug.personalize('executing experience for %s %o', personalizeInfo.contentId, params);
             let variantId;
-            // Execute targeted experience in CDP
+            // Execute targeted experience in Personalize SDK
             // eslint-disable-next-line no-useless-catch
             try {
-                variantId = (yield engageServer.personalize(personalizationData, req, timeout)).variantId;
+                const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
+                variantId = personalization.variantId;
             }
             catch (error) {
                 throw error;
@@ -104,15 +93,22 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
             const rewritePath = (0, personalize_1.getPersonalizedRewrite)(basePath, { variantId });
             // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
             const rewriteUrl = req.nextUrl.clone();
+            // Preserve cookies from previous response
+            const cookies = response.cookies.getAll();
             rewriteUrl.pathname = rewritePath;
-            response = server_1.NextResponse.rewrite(rewriteUrl);
+            response = server_1.NextResponse.rewrite(rewriteUrl, response);
             // Disable preflight caching to force revalidation on client-side navigation (personalization may be influenced)
             // See https://github.com/vercel/next.js/issues/32727
             response.headers.set('x-middleware-cache', 'no-cache');
-            // Share rewrite path with following executed middlewares
+            // Share rewrite path with following executed middleware
             response.headers.set('x-sc-rewrite', rewritePath);
             // Share site name with the following executed middlewares
             response.cookies.set(this.SITE_SYMBOL, site.name);
+            // Restore cookies from previous response since
+            // browserId cookie gets omitted after rewrite
+            cookies.forEach((cookie) => {
+                response.cookies.set(cookie);
+            });
             sitecore_jss_1.debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
                 rewritePath,
                 headers: this.extractDebugHeaders(response.headers),
@@ -139,16 +135,29 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
             }
         });
     }
-    initializeEngageServer(site, language) {
-        const engageServer = (0, engage_1.initServer)({
-            clientKey: this.config.cdpConfig.clientKey,
-            targetURL: this.config.cdpConfig.endpoint,
-            pointOfSale: this.config.getPointOfSale
-                ? this.config.getPointOfSale(site, language)
-                : personalize_1.PosResolver.resolve(site, language),
-            forceServerCookieMode: true,
+    initPersonalizeServer({ hostname, siteName, request, response, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield (0, server_2.init)({
+                sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
+                sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
+                siteName,
+                cookieDomain: hostname,
+                enableServerCookie: true,
+            }, request, response);
+        });
+    }
+    personalize({ params, personalizeInfo, language, timeout, }, request) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const personalizationData = {
+                channel: this.config.cdpConfig.channel || 'WEB',
+                currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
+                friendlyId: personalizeInfo.contentId,
+                params,
+                language,
+            };
+            return (yield (0, server_2.personalize)(personalizationData, request, timeout));
         });
-        return engageServer;
     }
     getExperienceParams(req) {
         const utm = {

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

@@ -136,13 +136,16 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
             const redirects = yield this.redirectsService.fetchRedirects(siteName);
             const tragetURL = req.nextUrl.pathname;
             const targetQS = req.nextUrl.search || '';
-            return redirects.length
-                ? redirects.find((redirect) => {
+            const language = this.getLanguage(req);
+            const modifyRedirects = JSON.parse(JSON.stringify(redirects));
+            return modifyRedirects.length
+                ? modifyRedirects.find((redirect) => {
+                    redirect.pattern = redirect.pattern.replace(RegExp(`^[^]?/${language}/`, 'gi'), '');
                     redirect.pattern = `/^\/${redirect.pattern
                         .replace(/^\/|\/$/g, '')
                         .replace(/^\^\/|\/\$$/g, '')
                         .replace(/^\^|\$$/g, '')
-                        .replace(/\$\/gi$/g, '')}$/gi`;
+                        .replace(/\$\/gi$/g, '')}[\/]?$/gi`;
                     return (((0, regex_parser_1.default)(redirect.pattern).test(tragetURL) ||
                         (0, regex_parser_1.default)(redirect.pattern).test(`${tragetURL}${targetQS}`) ||
                         (0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||

package/dist/cjs/services/base-graphql-sitemap-service.js

@@ -195,6 +195,14 @@ class BaseGraphQLSitemapService {
      * @returns {GraphQLClient} implementation
      */
     getGraphQLClient() {
+        if (!this.options.endpoint) {
+            if (!this.options.clientFactory) {
+                throw new Error('You should provide either an endpoint and apiKey, or a clientFactory.');
+            }
+            return this.options.clientFactory({
+                debugger: sitecore_jss_1.debug.sitemap,
+            });
+        }
         return new graphql_1.GraphQLRequestClient(this.options.endpoint, {
             apiKey: this.options.apiKey,
             debugger: sitecore_jss_1.debug.sitemap,

package/dist/cjs/utils/utils.js

@@ -1,10 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getJssEditingSecret = exports.handleEditorFastRefresh = exports.getPublicUrl = void 0;
-const chalk_1 = __importDefault(require("chalk"));
 const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
 /**
  * Get the publicUrl.
@@ -13,27 +9,19 @@ const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
  * VERCEL_URL is provided by Vercel in case if we are in Preview deployment (deployment based on the custom branch),
  * preview deployment has unique url, we don't know exact url.
  * Similarly, DEPLOY_URL is provided by Netlify and would give us the deploy URL
+ * In production non-editing environments it is desirable to use relative urls, so in that case set PUBLIC_URL = ''
  */
 const getPublicUrl = () => {
-    if (process.env.NETLIFY && process.env.DEPLOY_URL)
-        return process.env.DEPLOY_URL;
-    if (process.env.VERCEL_URL)
-        return `https://${process.env.VERCEL_URL}`;
     let url = process.env.PUBLIC_URL;
     if (url === undefined) {
-        console.warn(`${chalk_1.default.yellow.bold('Warning:')} An PUBLIC_URL environment variable is not defined. Falling back to http://localhost:3000.`);
+        if (process.env.NETLIFY && process.env.DEPLOY_URL)
+            return process.env.DEPLOY_URL;
+        if (process.env.VERCEL_URL)
+            return `https://${process.env.VERCEL_URL}`;
         url = 'http://localhost:3000';
     }
-    else {
-        try {
-            new URL(url);
-        }
-        catch (error) {
-            throw new Error(`The PUBLIC_URL environment variable '${url}' is not a valid URL.`);
-        }
-    }
     // Ensure no trailing slash
-    return url.toString().replace(/\/$/, '');
+    return url.replace(/\/$/, '');
 };
 exports.getPublicUrl = getPublicUrl;
 /**

package/dist/esm/context/context.js

@@ -0,0 +1,64 @@
+import { LayoutServicePageState } from '@sitecore-jss/sitecore-jss-react';
+/**
+ * Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
+ */
+export class Context {
+    constructor(props) {
+        this.props = props;
+        /**
+         * Indicates whether the Context and SDK(s) have been initialized
+         */
+        this.isInitialized = false;
+        /**
+         * Software Development Kits (SDKs) to be initialized
+         */
+        this.sdks = {};
+        /**
+         * Promises for the SDKs
+         */
+        this.sdkPromises = {};
+        /**
+         * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
+         *
+         * @param {string} name SDK name
+         * @returns initialized SDK
+         */
+        this.getSDK = (name) => {
+            return this.sdkPromises[name] || Promise.reject(`Unknown SDK '${String(name)}'`);
+        };
+        this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
+        this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
+        this.siteName = props.siteName;
+        this.pageState = LayoutServicePageState.Normal;
+    }
+    init(props = {}) {
+        // Context and SDKs are initialized only once
+        if (this.isInitialized)
+            return;
+        this.isInitialized = true;
+        if (props.siteName) {
+            this.siteName = props.siteName;
+        }
+        if (props.pageState) {
+            this.pageState = props.pageState;
+        }
+        // iterate over the SDKs and initialize them
+        for (const sdkName of Object.keys(this.props.sdks)) {
+            this.initSDK(sdkName);
+        }
+    }
+    /**
+     * Initializes the Software Development Kit (SDK)
+     *
+     * @param {T} name SDK name
+     * @returns {void}
+     */
+    initSDK(name) {
+        this.sdkPromises[name] = new Promise((resolve) => {
+            this.props.sdks[name].init(this).then(() => {
+                this.sdks[name] = this.props.sdks[name].sdk;
+                resolve(this.sdks[name]);
+            });
+        });
+    }
+}

package/dist/esm/context/index.js

@@ -0,0 +1 @@
+export { Context } from './context';

package/dist/esm/editing/constants.js

@@ -0,0 +1,3 @@
+export const QUERY_PARAM_EDITING_SECRET = 'secret';
+export const QUERY_PARAM_PROTECTION_BYPASS_SITECORE = 'x-sitecore-protection-bypass';
+export const QUERY_PARAM_PROTECTION_BYPASS_VERCEL = 'x-vercel-protection-bypass';

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

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { editingDataDiskCache } from './editing-data-cache';
 import { isEditingData } from './editing-data';
-import { QUERY_PARAM_EDITING_SECRET } from './editing-data-service';
+import { QUERY_PARAM_EDITING_SECRET } from './constants';
 import { getJssEditingSecret } from '../utils/utils';
 /**
  * Middleware / handler for use in the editing data Next.js API dynamic route (e.g. '/api/editing/data/[key]')