@sitecore-jss/sitecore-jss-nextjs 21.5.0-canary.9 → 21.5.0

package/LICENSE.txt

@@ -1,202 +1,202 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,9 +1,9 @@
-# Sitecore JavaScript Rendering SDK for Next.js
-
-This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains Next.js components and integration for JSS.
-
-[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/)
+# Sitecore JavaScript Rendering SDK for Next.js
+
+This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains Next.js components and integration for JSS.
+
+[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/)

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

@@ -14,6 +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");
 /**
  * Middleware / handler to support Sitecore Personalize
  */
@@ -25,19 +26,20 @@ 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;
             const startTimestamp = Date.now();
-            let browserId = this.getBrowserId(req);
+            const timeout = this.config.cdpConfig.timeout;
+            // Response will be provided if other middleware is run before us (e.g. redirects)
+            let response = res || server_1.NextResponse.next();
             sitecore_jss_1.debug.personalize('personalize middleware start: %o', {
                 pathname,
                 language,
                 hostname,
-                browserId,
+                headers: this.extractDebugHeaders(req.headers),
             });
-            // Response will be provided if other middleware is run before us (e.g. redirects)
-            let response = res || server_1.NextResponse.next();
             if (this.config.disabled && this.config.disabled(req, response)) {
                 sitecore_jss_1.debug.personalize('skipped (personalize middleware is disabled)');
                 return response;
@@ -48,7 +50,7 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
                 sitecore_jss_1.debug.personalize('skipped (%s)', response.redirected ? 'redirected' : this.isPreview(req) ? 'preview' : 'route excluded');
                 return response;
             }
-            const site = this.getSite(req, res);
+            const site = this.getSite(req, response);
             // Get personalization info from Experience Edge
             const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
             if (!personalizeInfo) {
@@ -60,20 +62,34 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
                 sitecore_jss_1.debug.personalize('skipped (no personalization configured)');
                 return response;
             }
-            if (!browserId) {
-                browserId = yield this.cdpService.generateBrowserId();
-                if (!browserId) {
-                    sitecore_jss_1.debug.personalize('skipped (browser id generation failed)');
-                    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;
             }
-            // Execute targeted experience in CDP
-            const { ua } = (0, server_1.userAgent)(req);
             const params = this.getExperienceParams(req);
-            const pointOfSale = this.config.getPointOfSale
-                ? this.config.getPointOfSale(site, language)
-                : personalize_1.PosResolver.resolve(site, language);
-            const variantId = yield this.cdpService.executeExperience(personalizeInfo.contentId, browserId, ua, pointOfSale, params);
+            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
+            // eslint-disable-next-line no-useless-catch
+            try {
+                variantId = (yield engageServer.personalize(personalizationData, req, timeout)).variantId;
+            }
+            catch (error) {
+                throw error;
+            }
             if (!variantId) {
                 sitecore_jss_1.debug.personalize('skipped (no variant identified)');
                 return response;
@@ -88,20 +104,24 @@ 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);
-            // Set browserId cookie on the response
-            this.setBrowserId(response, browserId);
             // 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,
-                browserId,
                 headers: this.extractDebugHeaders(response.headers),
             });
             return response;
@@ -109,15 +129,6 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
         // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
         // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
         this.personalizeService = new personalize_1.GraphQLPersonalizeService(Object.assign(Object.assign({}, config.edgeConfig), { fetch: fetch }));
-        // NOTE: same here, we provide NativeDataFetcher for compatibility on Next.js Edge Runtime
-        this.cdpService = new personalize_1.CdpService(Object.assign(Object.assign({}, config.cdpConfig), { dataFetcherResolver: ({ timeout, headers, }) => {
-                const fetcher = new sitecore_jss_1.NativeDataFetcher({
-                    debugger: sitecore_jss_1.debug.personalize,
-                    timeout,
-                    headers,
-                });
-                return (url, data) => fetcher.fetch(url, data);
-            } }));
     }
     /**
      * Gets the Next.js middleware handler with error handling
@@ -135,31 +146,31 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
             }
         });
     }
-    get browserIdCookieName() {
-        // Each user should have saved identifier to connect between session, CDP uses bid cookies + local storage
-        return `BID_${this.config.cdpConfig.clientKey}`;
-    }
-    getBrowserId(req) {
-        var _a;
-        return ((_a = req.cookies.get(this.browserIdCookieName)) === null || _a === void 0 ? void 0 : _a.value) || undefined;
-    }
-    setBrowserId(res, browserId) {
-        const expiryDate = new Date(new Date().setFullYear(new Date().getFullYear() + 2));
-        const options = { expires: expiryDate, secure: true };
-        res.cookies.set(this.browserIdCookieName, browserId, options);
+    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,
+        });
+        return engageServer;
     }
     getExperienceParams(req) {
+        const utm = {
+            campaign: req.nextUrl.searchParams.get('utm_campaign') || undefined,
+            content: req.nextUrl.searchParams.get('utm_content') || undefined,
+            medium: req.nextUrl.searchParams.get('utm_medium') || undefined,
+            source: req.nextUrl.searchParams.get('utm_source') || undefined,
+        };
         return {
             // It's expected that the header name "referer" is actually a misspelling of the word "referrer"
             // req.referrer is used during fetching to determine the value of the Referer header of the request being made,
             // used as a fallback
             referrer: req.headers.get('referer') || req.referrer,
-            utm: {
-                campaign: req.nextUrl.searchParams.get('utm_campaign'),
-                content: req.nextUrl.searchParams.get('utm_content'),
-                medium: req.nextUrl.searchParams.get('utm_medium'),
-                source: req.nextUrl.searchParams.get('utm_source'),
-            },
+            utm: utm,
         };
     }
     excludeRoute(pathname) {

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

@@ -141,7 +141,8 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                     redirect.pattern = `/^\/${redirect.pattern
                         .replace(/^\/|\/$/g, '')
                         .replace(/^\^\/|\/\$$/g, '')
-                        .replace(/^\^|\$$/g, '')}$/gi`;
+                        .replace(/^\^|\$$/g, '')
+                        .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/esm/middleware/personalize-middleware.js

@@ -7,10 +7,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { NextResponse, userAgent } from 'next/server';
-import { GraphQLPersonalizeService, CdpService, getPersonalizedRewrite, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
-import { debug, NativeDataFetcher } from '@sitecore-jss/sitecore-jss';
+import { NextResponse } from 'next/server';
+import { GraphQLPersonalizeService, getPersonalizedRewrite, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
+import { debug } from '@sitecore-jss/sitecore-jss';
 import { MiddlewareBase } from './middleware';
+import { initServer } from '@sitecore/engage';
 /**
  * Middleware / handler to support Sitecore Personalize
  */
@@ -22,19 +23,20 @@ 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;
             const startTimestamp = Date.now();
-            let browserId = this.getBrowserId(req);
+            const timeout = this.config.cdpConfig.timeout;
+            // Response will be provided if other middleware is run before us (e.g. redirects)
+            let response = res || NextResponse.next();
             debug.personalize('personalize middleware start: %o', {
                 pathname,
                 language,
                 hostname,
-                browserId,
+                headers: this.extractDebugHeaders(req.headers),
             });
-            // Response will be provided if other middleware is run before us (e.g. redirects)
-            let response = res || NextResponse.next();
             if (this.config.disabled && this.config.disabled(req, response)) {
                 debug.personalize('skipped (personalize middleware is disabled)');
                 return response;
@@ -45,7 +47,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 debug.personalize('skipped (%s)', response.redirected ? 'redirected' : this.isPreview(req) ? 'preview' : 'route excluded');
                 return response;
             }
-            const site = this.getSite(req, res);
+            const site = this.getSite(req, response);
             // Get personalization info from Experience Edge
             const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
             if (!personalizeInfo) {
@@ -57,20 +59,34 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 debug.personalize('skipped (no personalization configured)');
                 return response;
             }
-            if (!browserId) {
-                browserId = yield this.cdpService.generateBrowserId();
-                if (!browserId) {
-                    debug.personalize('skipped (browser id generation failed)');
-                    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;
             }
-            // Execute targeted experience in CDP
-            const { ua } = userAgent(req);
             const params = this.getExperienceParams(req);
-            const pointOfSale = this.config.getPointOfSale
-                ? this.config.getPointOfSale(site, language)
-                : PosResolver.resolve(site, language);
-            const variantId = yield this.cdpService.executeExperience(personalizeInfo.contentId, browserId, ua, pointOfSale, params);
+            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
+            // eslint-disable-next-line no-useless-catch
+            try {
+                variantId = (yield engageServer.personalize(personalizationData, req, timeout)).variantId;
+            }
+            catch (error) {
+                throw error;
+            }
             if (!variantId) {
                 debug.personalize('skipped (no variant identified)');
                 return response;
@@ -85,20 +101,24 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             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 = 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);
-            // Set browserId cookie on the response
-            this.setBrowserId(response, browserId);
             // 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,
-                browserId,
                 headers: this.extractDebugHeaders(response.headers),
             });
             return response;
@@ -106,15 +126,6 @@ export class PersonalizeMiddleware extends MiddlewareBase {
         // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
         // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
         this.personalizeService = new GraphQLPersonalizeService(Object.assign(Object.assign({}, config.edgeConfig), { fetch: fetch }));
-        // NOTE: same here, we provide NativeDataFetcher for compatibility on Next.js Edge Runtime
-        this.cdpService = new CdpService(Object.assign(Object.assign({}, config.cdpConfig), { dataFetcherResolver: ({ timeout, headers, }) => {
-                const fetcher = new NativeDataFetcher({
-                    debugger: debug.personalize,
-                    timeout,
-                    headers,
-                });
-                return (url, data) => fetcher.fetch(url, data);
-            } }));
     }
     /**
      * Gets the Next.js middleware handler with error handling
@@ -132,31 +143,31 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             }
         });
     }
-    get browserIdCookieName() {
-        // Each user should have saved identifier to connect between session, CDP uses bid cookies + local storage
-        return `BID_${this.config.cdpConfig.clientKey}`;
-    }
-    getBrowserId(req) {
-        var _a;
-        return ((_a = req.cookies.get(this.browserIdCookieName)) === null || _a === void 0 ? void 0 : _a.value) || undefined;
-    }
-    setBrowserId(res, browserId) {
-        const expiryDate = new Date(new Date().setFullYear(new Date().getFullYear() + 2));
-        const options = { expires: expiryDate, secure: true };
-        res.cookies.set(this.browserIdCookieName, browserId, options);
+    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,
+        });
+        return engageServer;
     }
     getExperienceParams(req) {
+        const utm = {
+            campaign: req.nextUrl.searchParams.get('utm_campaign') || undefined,
+            content: req.nextUrl.searchParams.get('utm_content') || undefined,
+            medium: req.nextUrl.searchParams.get('utm_medium') || undefined,
+            source: req.nextUrl.searchParams.get('utm_source') || undefined,
+        };
         return {
             // It's expected that the header name "referer" is actually a misspelling of the word "referrer"
             // req.referrer is used during fetching to determine the value of the Referer header of the request being made,
             // used as a fallback
             referrer: req.headers.get('referer') || req.referrer,
-            utm: {
-                campaign: req.nextUrl.searchParams.get('utm_campaign'),
-                content: req.nextUrl.searchParams.get('utm_content'),
-                medium: req.nextUrl.searchParams.get('utm_medium'),
-                source: req.nextUrl.searchParams.get('utm_source'),
-            },
+            utm: utm,
         };
     }
     excludeRoute(pathname) {

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

@@ -135,7 +135,8 @@ export class RedirectsMiddleware extends MiddlewareBase {
                     redirect.pattern = `/^\/${redirect.pattern
                         .replace(/^\/|\/$/g, '')
                         .replace(/^\^\/|\/\$$/g, '')
-                        .replace(/^\^|\$$/g, '')}$/gi`;
+                        .replace(/^\^|\$$/g, '')
+                        .replace(/\$\/gi$/g, '')}$/gi`;
                     return ((regexParser(redirect.pattern).test(tragetURL) ||
                         regexParser(redirect.pattern).test(`${tragetURL}${targetQS}`) ||
                         regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "21.5.0-canary.9",
+  "version": "21.5.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -30,6 +30,7 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "devDependencies": {
+    "@sitecore/engage": "^1.4.1",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-string": "^1.4.2",
@@ -65,14 +66,15 @@
     "typescript": "~4.9.4"
   },
   "peerDependencies": {
+    "@sitecore/engage": "^1.4.1",
     "next": "^13.4.16",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^21.5.0-canary.9",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^21.5.0-canary.9",
-    "@sitecore-jss/sitecore-jss-react": "^21.5.0-canary.9",
+    "@sitecore-jss/sitecore-jss": "21.5.0",
+    "@sitecore-jss/sitecore-jss-dev-tools": "21.5.0",
+    "@sitecore-jss/sitecore-jss-react": "21.5.0",
     "@vercel/kv": "^0.2.1",
     "node-html-parser": "^6.1.4",
     "prop-types": "^15.8.1",
@@ -81,7 +83,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "d04cef72a0eafdaa6654c7741d7fa4ab325a7f38",
+  "gitHead": "cefc81cad1a627e705406a2fb6a663571bd41e56",
   "files": [
     "dist",
     "types",

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

@@ -1,7 +1,30 @@
 import { NextResponse, NextRequest } from 'next/server';
-import { GraphQLPersonalizeServiceConfig, CdpServiceConfig, ExperienceParams } from '@sitecore-jss/sitecore-jss/personalize';
-import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
+import { GraphQLPersonalizeServiceConfig } from '@sitecore-jss/sitecore-jss/personalize';
 import { SiteInfo } from '@sitecore-jss/sitecore-jss/site';
+import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
+import { EngageServer } from '@sitecore/engage';
+export type CdpServiceConfig = {
+    /**
+     * Your Sitecore CDP API endpoint
+     */
+    endpoint: string;
+    /**
+     * The client key to use for authentication
+     */
+    clientKey: string;
+    /**
+     * The Sitecore CDP channel to use for events. Uses 'WEB' by default.
+     */
+    channel?: string;
+    /**
+     * Currency for CDP request. Uses 'USA' as default.
+     */
+    currency?: string;
+    /**
+     * Timeout (ms) for CDP request. Default is 400.
+     */
+    timeout?: number;
+};
 export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
     /**
      * Configuration for your Sitecore Experience Edge endpoint
@@ -10,7 +33,7 @@ export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
     /**
      * Configuration for your Sitecore CDP endpoint
      */
-    cdpConfig: Omit<CdpServiceConfig, 'dataFetcherResolver'>;
+    cdpConfig: CdpServiceConfig;
     /**
      * function to resolve point of sale for a site
      * @param {Siteinfo} site to get info from
@@ -19,13 +42,25 @@ export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
      */
     getPointOfSale?: (site: SiteInfo, language: string) => string;
 };
+/**
+ * Object model of Experience Context data
+ */
+export type ExperienceParams = {
+    referrer: string;
+    utm: {
+        [key: string]: string | undefined;
+        campaign: string | undefined;
+        source: string | undefined;
+        medium: string | undefined;
+        content: string | undefined;
+    };
+};
 /**
  * Middleware / handler to support Sitecore Personalize
  */
 export declare class PersonalizeMiddleware extends MiddlewareBase {
     protected config: PersonalizeMiddlewareConfig;
     private personalizeService;
-    private cdpService;
     /**
      * @param {PersonalizeMiddlewareConfig} [config] Personalize middleware config
      */
@@ -35,9 +70,7 @@ export declare class PersonalizeMiddleware extends MiddlewareBase {
      * @returns middleware handler
      */
     getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
-    protected get browserIdCookieName(): string;
-    protected getBrowserId(req: NextRequest): string | undefined;
-    protected setBrowserId(res: NextResponse, browserId: string): void;
+    protected initializeEngageServer(hostName: string, site: SiteInfo, language: string): EngageServer;
     protected getExperienceParams(req: NextRequest): ExperienceParams;
     protected excludeRoute(pathname: string): boolean | undefined;
     private handler;