@sitecore-jss/sitecore-jss-nextjs 21.7.0-canary.5 → 21.7.0-canary.7

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,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Context = void 0;
+/**
+ * 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 = {};
+        this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
+        this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
+        this.siteName = props.siteName;
+    }
+    init(props = {}) {
+        // Context and SDKs are initialized only once
+        if (this.isInitialized)
+            return;
+        this.isInitialized = true;
+        if (props.siteName) {
+            this.siteName = props.siteName;
+        }
+        // iterate over the SDKs and initialize them
+        for (const sdkName of Object.keys(this.props.sdks)) {
+            this.initSDK(sdkName);
+        }
+    }
+    /**
+     * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
+     *
+     * @param {string} name SDK name
+     * @returns initialized SDK
+     */
+    getSDK(name) {
+        return this.sdkPromises[name];
+    }
+    /**
+     * 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/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.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.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.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = void 0;
+exports.FEaaSWrapper = 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.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 = 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; } });
@@ -78,7 +78,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 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");
@@ -116,6 +115,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/middleware.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MiddlewareBase = void 0;
+const server_1 = require("next/server");
 class MiddlewareBase {
     constructor(config) {
         this.config = config;
         this.SITE_SYMBOL = 'sc_site';
+        this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
         this.defaultHostname = config.defaultHostname || 'localhost';
     }
     /**
@@ -65,5 +67,20 @@ class MiddlewareBase {
         const hostname = this.getHostHeader(req) || this.defaultHostname;
         return this.config.siteResolver.getByHost(hostname);
     }
+    /**
+     * Create a rewrite response
+     * @param {string} rewritePath the destionation path
+     * @param {NextRequest} req the current request
+     * @param {NextResponse} res the current response
+     */
+    rewrite(rewritePath, req, res) {
+        // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
+        const rewriteUrl = req.nextUrl.clone();
+        rewriteUrl.pathname = rewritePath;
+        const response = server_1.NextResponse.rewrite(rewriteUrl, res);
+        // Share rewrite path with following executed middlewares
+        response.headers.set(this.REWRITE_HEADER_NAME, rewritePath);
+        return response;
+    }
 }
 exports.MiddlewareBase = MiddlewareBase;

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

@@ -51,14 +51,9 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
             const rewritePath = (0, site_1.getSiteRewrite)(pathname, {
                 siteName,
             });
-            // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
-            const rewriteUrl = req.nextUrl.clone();
-            rewriteUrl.pathname = rewritePath;
-            response = server_1.NextResponse.rewrite(rewriteUrl);
+            response = this.rewrite(rewritePath, req, response);
             // Share site name with the following executed middlewares
             response.cookies.set(this.SITE_SYMBOL, siteName);
-            // Share rewrite path with following executed middlewares
-            response.headers.set('x-sc-rewrite', rewritePath);
             sitecore_jss_1.debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
                 rewritePath,
                 siteName,

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;
@@ -62,30 +61,20 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
                 sitecore_jss_1.debug.personalize('skipped (no personalization configured)');
                 return response;
             }
-            const engageServer = this.initializeEngageServer(hostname, 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;
-            }
+            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,
-            };
             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;
@@ -102,24 +91,10 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
             const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
             // Rewrite to persononalized path
             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);
+            response = this.rewrite(rewritePath, req, 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 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),
@@ -146,17 +121,29 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
             }
         });
     }
-    initializeEngageServer(hostName, 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),
-            cookieDomain: hostName,
-            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

@@ -42,7 +42,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                 hostname,
             });
             const createResponse = () => __awaiter(this, void 0, void 0, function* () {
-                if (this.config.disabled && this.config.disabled(req, server_1.NextResponse.next())) {
+                if (this.config.disabled && this.config.disabled(req, res || server_1.NextResponse.next())) {
                     sitecore_jss_1.debug.redirects('skipped (redirects middleware is disabled)');
                     return res || server_1.NextResponse.next();
                 }
@@ -82,19 +82,24 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                 /** return Response redirect with http code of redirect type **/
                 switch (existsRedirect.redirectType) {
                     case site_1.REDIRECT_TYPE_301:
-                        return server_1.NextResponse.redirect(redirectUrl, 301);
+                        return server_1.NextResponse.redirect(redirectUrl, {
+                            status: 301,
+                            statusText: 'Moved Permanently',
+                            headers: res === null || res === void 0 ? void 0 : res.headers,
+                        });
                     case site_1.REDIRECT_TYPE_302:
-                        return server_1.NextResponse.redirect(redirectUrl, 302);
+                        return server_1.NextResponse.redirect(redirectUrl, {
+                            status: 302,
+                            statusText: 'Found',
+                            headers: res === null || res === void 0 ? void 0 : res.headers,
+                        });
                     case site_1.REDIRECT_TYPE_SERVER_TRANSFER:
-                        return server_1.NextResponse.rewrite(redirectUrl);
+                        return server_1.NextResponse.rewrite(redirectUrl, res);
                     default:
-                        return server_1.NextResponse.next();
+                        return res || server_1.NextResponse.next();
                 }
             });
             const response = yield createResponse();
-            // Share site name with the following executed middlewares
-            // Don't need to set when middleware is disabled
-            site && response.cookies.set(this.SITE_SYMBOL, site.name);
             sitecore_jss_1.debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
                 redirected: response.redirected,
                 status: response.status,

package/dist/esm/context/context.js

@@ -0,0 +1,59 @@
+/**
+ * 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 = {};
+        this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
+        this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
+        this.siteName = props.siteName;
+    }
+    init(props = {}) {
+        // Context and SDKs are initialized only once
+        if (this.isInitialized)
+            return;
+        this.isInitialized = true;
+        if (props.siteName) {
+            this.siteName = props.siteName;
+        }
+        // iterate over the SDKs and initialize them
+        for (const sdkName of Object.keys(this.props.sdks)) {
+            this.initSDK(sdkName);
+        }
+    }
+    /**
+     * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
+     *
+     * @param {string} name SDK name
+     * @returns initialized SDK
+     */
+    getSDK(name) {
+        return this.sdkPromises[name];
+    }
+    /**
+     * 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/index.js

@@ -24,7 +24,7 @@ export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChi
 export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
 export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
-export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
+export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
 export { ComponentPropsService } from './services/component-props-service';
 export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
 export { GraphQLSitemapService, } from './services/graphql-sitemap-service';
@@ -41,4 +41,5 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder } from './ComponentBuilder';
+export { Context } from './context';
 export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getFEAASLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';

package/dist/esm/middleware/middleware.js

@@ -1,7 +1,9 @@
+import { NextResponse } from 'next/server';
 export class MiddlewareBase {
     constructor(config) {
         this.config = config;
         this.SITE_SYMBOL = 'sc_site';
+        this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
         this.defaultHostname = config.defaultHostname || 'localhost';
     }
     /**
@@ -62,4 +64,19 @@ export class MiddlewareBase {
         const hostname = this.getHostHeader(req) || this.defaultHostname;
         return this.config.siteResolver.getByHost(hostname);
     }
+    /**
+     * Create a rewrite response
+     * @param {string} rewritePath the destionation path
+     * @param {NextRequest} req the current request
+     * @param {NextResponse} res the current response
+     */
+    rewrite(rewritePath, req, res) {
+        // 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);
+        return response;
+    }
 }

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

@@ -48,14 +48,9 @@ export class MultisiteMiddleware extends MiddlewareBase {
             const rewritePath = getSiteRewrite(pathname, {
                 siteName,
             });
-            // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
-            const rewriteUrl = req.nextUrl.clone();
-            rewriteUrl.pathname = rewritePath;
-            response = NextResponse.rewrite(rewriteUrl);
+            response = this.rewrite(rewritePath, req, response);
             // Share site name with the following executed middlewares
             response.cookies.set(this.SITE_SYMBOL, siteName);
-            // Share rewrite path with following executed middlewares
-            response.headers.set('x-sc-rewrite', rewritePath);
             debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
                 rewritePath,
                 siteName,

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

@@ -8,10 +8,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { NextResponse } from 'next/server';
-import { GraphQLPersonalizeService, getPersonalizedRewrite, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
+import { GraphQLPersonalizeService, getPersonalizedRewrite, } from '@sitecore-jss/sitecore-jss/personalize';
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { MiddlewareBase } from './middleware';
-import { initServer } from '@sitecore/engage';
+import { init, personalize } from '@sitecore-cloudsdk/personalize/server';
 /**
  * Middleware / handler to support Sitecore Personalize
  */
@@ -23,7 +23,6 @@ export class PersonalizeMiddleware extends 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;
@@ -59,30 +58,20 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 debug.personalize('skipped (no personalization configured)');
                 return response;
             }
-            const engageServer = this.initializeEngageServer(hostname, 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) {
-                debug.personalize('skipped (browser id generation failed)');
-                throw error;
-            }
+            yield this.initPersonalizeServer({
+                hostname,
+                siteName: site.name,
+                request: req,
+                response,
+            });
             const params = this.getExperienceParams(req);
             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,
-            };
             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;
@@ -99,24 +88,10 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
             // Rewrite to persononalized path
             const rewritePath = 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 = NextResponse.rewrite(rewriteUrl, response);
+            response = this.rewrite(rewritePath, req, 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 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);
-            });
             debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
                 rewritePath,
                 headers: this.extractDebugHeaders(response.headers),
@@ -143,17 +118,29 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             }
         });
     }
-    initializeEngageServer(hostName, site, language) {
-        const engageServer = initServer({
-            clientKey: this.config.cdpConfig.clientKey,
-            targetURL: this.config.cdpConfig.endpoint,
-            pointOfSale: this.config.getPointOfSale
-                ? this.config.getPointOfSale(site, language)
-                : PosResolver.resolve(site, language),
-            cookieDomain: hostName,
-            forceServerCookieMode: true,
+    initPersonalizeServer({ hostname, siteName, request, response, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield 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 personalize(personalizationData, request, timeout));
         });
-        return engageServer;
     }
     getExperienceParams(req) {
         const utm = {

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

@@ -36,7 +36,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
                 hostname,
             });
             const createResponse = () => __awaiter(this, void 0, void 0, function* () {
-                if (this.config.disabled && this.config.disabled(req, NextResponse.next())) {
+                if (this.config.disabled && this.config.disabled(req, res || NextResponse.next())) {
                     debug.redirects('skipped (redirects middleware is disabled)');
                     return res || NextResponse.next();
                 }
@@ -76,19 +76,24 @@ export class RedirectsMiddleware extends MiddlewareBase {
                 /** return Response redirect with http code of redirect type **/
                 switch (existsRedirect.redirectType) {
                     case REDIRECT_TYPE_301:
-                        return NextResponse.redirect(redirectUrl, 301);
+                        return NextResponse.redirect(redirectUrl, {
+                            status: 301,
+                            statusText: 'Moved Permanently',
+                            headers: res === null || res === void 0 ? void 0 : res.headers,
+                        });
                     case REDIRECT_TYPE_302:
-                        return NextResponse.redirect(redirectUrl, 302);
+                        return NextResponse.redirect(redirectUrl, {
+                            status: 302,
+                            statusText: 'Found',
+                            headers: res === null || res === void 0 ? void 0 : res.headers,
+                        });
                     case REDIRECT_TYPE_SERVER_TRANSFER:
-                        return NextResponse.rewrite(redirectUrl);
+                        return NextResponse.rewrite(redirectUrl, res);
                     default:
-                        return NextResponse.next();
+                        return res || NextResponse.next();
                 }
             });
             const response = yield createResponse();
-            // Share site name with the following executed middlewares
-            // Don't need to set when middleware is disabled
-            site && response.cookies.set(this.SITE_SYMBOL, site.name);
             debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
                 redirected: response.redirected,
                 status: response.status,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "21.7.0-canary.5",
+  "version": "21.7.0-canary.7",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -11,7 +11,7 @@
     "test": "mocha --require ./test/setup.js \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\" --exit",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --entryPoints src/context/index.ts --entryPoints src/utils/index.ts --entryPoints src/site/index.ts --entryPoints src/graphql/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=12",
@@ -30,7 +30,7 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "devDependencies": {
-    "@sitecore/engage": "^1.4.1",
+    "@sitecore-cloudsdk/personalize": "^0.1.1",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-string": "^1.4.2",
@@ -66,15 +66,16 @@
     "typescript": "~4.9.4"
   },
   "peerDependencies": {
-    "@sitecore/engage": "^1.4.1",
+    "@sitecore-cloudsdk/events": "^0.1.1",
+    "@sitecore-cloudsdk/personalize": "^0.1.1",
     "next": "^13.4.16",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^21.7.0-canary.5",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^21.7.0-canary.5",
-    "@sitecore-jss/sitecore-jss-react": "^21.7.0-canary.5",
+    "@sitecore-jss/sitecore-jss": "^21.7.0-canary.7",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^21.7.0-canary.7",
+    "@sitecore-jss/sitecore-jss-react": "^21.7.0-canary.7",
     "@vercel/kv": "^0.2.1",
     "node-html-parser": "^6.1.4",
     "prop-types": "^15.8.1",
@@ -83,7 +84,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "f076b7e95224d2494ed50ff2aeea664a5282af2e",
+  "gitHead": "c55bf6138cd4388c009a16c17475c65147f4d0b6",
   "files": [
     "dist",
     "types",

package/types/context/context.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Software Development Kit (SDK) instance
+ */
+export type SDK<SDKType = unknown> = {
+    /**
+     * The Software Development Kit (SDK) library instance
+     */
+    sdk: SDKType;
+    /**
+     * Initializes the Software Development Kit (SDK)
+     */
+    init: (props: InitSDKProps) => Promise<void>;
+};
+/**
+ * Software Development Kits (SDKs) to be initialized
+ */
+type SDKModulesType = Record<string, SDK>;
+/**
+ * Properties that are passed to the Context.
+ */
+export interface ContextInitProps {
+    /**
+     * Your Sitecore site name
+     */
+    siteName?: string;
+}
+/**
+ * Configuration that is passed to the Context.
+ */
+export interface ContextConfig<SDKModules extends SDKModulesType> {
+    /**
+     * Your Sitecore Edge URL
+     */
+    sitecoreEdgeUrl: string;
+    /**
+     * Your Sitecore Edge Context ID
+     */
+    sitecoreEdgeContextId: string;
+    /**
+     * Your Sitecore site name
+     */
+    siteName: string;
+    /**
+     * Software Development Kits (SDKs) to be initialized
+     */
+    sdks: {
+        [module in keyof SDKModules]: SDKModules[module];
+    };
+}
+/**
+ * Properties that are passed to the Software Development Kit (SDK) initialization function.
+ */
+type InitSDKProps = Omit<ContextConfig<SDKModulesType>, 'sdks'>;
+/**
+ * Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
+ */
+export declare class Context<SDKModules extends SDKModulesType> {
+    protected props: ContextConfig<SDKModules>;
+    /**
+     * Indicates whether the Context and SDK(s) have been initialized
+     */
+    isInitialized: boolean;
+    /**
+     * The Sitecore Edge URL
+     */
+    readonly sitecoreEdgeUrl: string;
+    /**
+     * The Sitecore Edge Context ID
+     */
+    readonly sitecoreEdgeContextId: string;
+    /**
+     * The Sitecore site name
+     */
+    siteName: string;
+    /**
+     * Software Development Kits (SDKs) to be initialized
+     */
+    readonly sdks: {
+        [module in keyof SDKModules]?: SDKModules[module]['sdk'];
+    };
+    /**
+     * Promises for the SDKs
+     */
+    protected sdkPromises: {
+        [module in keyof SDKModules]?: Promise<SDKModules[module]['sdk']>;
+    };
+    constructor(props: ContextConfig<SDKModules>);
+    init(props?: ContextInitProps): void;
+    /**
+     * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
+     *
+     * @param {string} name SDK name
+     * @returns initialized SDK
+     */
+    getSDK<T extends keyof SDKModules>(name: T): Promise<SDKModules[T]['sdk']> | undefined;
+    /**
+     * Initializes the Software Development Kit (SDK)
+     *
+     * @param {T} name SDK name
+     * @returns {void}
+     */
+    protected initSDK<T extends keyof SDKModules>(name: T): void;
+}
+export {};

package/types/context/index.d.ts

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

package/types/index.d.ts

@@ -12,7 +12,7 @@ export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutService
 export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, OutcomeInstance, EventInstance, PageViewInstance, } from '@sitecore-jss/sitecore-jss/tracking';
 export { DictionaryPhrases, DictionaryService, GraphQLDictionaryService, GraphQLDictionaryServiceConfig, RestDictionaryService, RestDictionaryServiceConfig, } from '@sitecore-jss/sitecore-jss/i18n';
-export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
+export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
 export { ComponentPropsCollection, ComponentPropsError, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
 export { ModuleFactory, Module } from './sharedTypes/module-factory';
 export { ComponentPropsService } from './services/component-props-service';
@@ -32,4 +32,5 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
+export { Context, ContextConfig, SDK } from './context';
 export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getFEAASLibraryStylesheetLinks, File, FileField, RichTextField, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, ComponentConsumerProps, WithSitecoreContextOptions, WithSitecoreContextProps, } from '@sitecore-jss/sitecore-jss-react';

package/types/middleware/middleware.d.ts

@@ -28,6 +28,7 @@ export type MiddlewareBaseConfig = {
 export declare abstract class MiddlewareBase {
     protected config: MiddlewareBaseConfig;
     protected SITE_SYMBOL: string;
+    protected REWRITE_HEADER_NAME: string;
     protected defaultHostname: string;
     constructor(config: MiddlewareBaseConfig);
     /**
@@ -65,4 +66,11 @@ export declare abstract class MiddlewareBase {
      * @returns {SiteInfo} site information
      */
     protected getSite(req: NextRequest, res?: NextResponse): SiteInfo;
+    /**
+     * Create a rewrite response
+     * @param {string} rewritePath the destionation path
+     * @param {NextRequest} req the current request
+     * @param {NextResponse} res the current response
+     */
+    protected rewrite(rewritePath: string, req: NextRequest, res: NextResponse): NextResponse;
 }

package/types/middleware/personalize-middleware.d.ts

@@ -1,17 +1,16 @@
 import { NextResponse, NextRequest } from 'next/server';
-import { GraphQLPersonalizeServiceConfig } from '@sitecore-jss/sitecore-jss/personalize';
-import { SiteInfo } from '@sitecore-jss/sitecore-jss/site';
+import { GraphQLPersonalizeServiceConfig, PersonalizeInfo } from '@sitecore-jss/sitecore-jss/personalize';
 import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
-import { EngageServer } from '@sitecore/engage';
 export type CdpServiceConfig = {
     /**
-     * Your Sitecore CDP API endpoint
+     * Your Sitecore Edge Platform endpoint
+     * Default is https://edge-platform.sitecorecloud.io
      */
-    endpoint: string;
+    sitecoreEdgeUrl?: string;
     /**
-     * The client key to use for authentication
+     * Your unified Sitecore Edge Context Id
      */
-    clientKey: string;
+    sitecoreEdgeContextId: string;
     /**
      * The Sitecore CDP channel to use for events. Uses 'WEB' by default.
      */
@@ -34,13 +33,6 @@ export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
      * Configuration for your Sitecore CDP endpoint
      */
     cdpConfig: CdpServiceConfig;
-    /**
-     * function to resolve point of sale for a site
-     * @param {Siteinfo} site to get info from
-     * @param {string} language to get info for
-     * @returns point of sale value for site/language combination
-     */
-    getPointOfSale?: (site: SiteInfo, language: string) => string;
 };
 /**
  * Object model of Experience Context data
@@ -70,7 +62,20 @@ export declare class PersonalizeMiddleware extends MiddlewareBase {
      * @returns middleware handler
      */
     getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
-    protected initializeEngageServer(hostName: string, site: SiteInfo, language: string): EngageServer;
+    protected initPersonalizeServer({ hostname, siteName, request, response, }: {
+        hostname: string;
+        siteName: string;
+        request: NextRequest;
+        response: NextResponse;
+    }): Promise<void>;
+    protected personalize({ params, personalizeInfo, language, timeout, }: {
+        personalizeInfo: PersonalizeInfo;
+        params: ExperienceParams;
+        language: string;
+        timeout?: number;
+    }, request: NextRequest): Promise<{
+        variantId: string;
+    }>;
     protected getExperienceParams(req: NextRequest): ExperienceParams;
     protected excludeRoute(pathname: string): boolean | undefined;
     private handler;