@sitecore-cloudsdk/personalize 0.3.1 → 0.4.0-rc.1

package/README.md

@@ -1,12 +1,6 @@
 # personalize
 
-This package provides browser- and server-side functions to run personalization in your app. Personalization is for showing the most relevant content to your users.
-
-## Prerequisites
-
-To use the Sitecore Cloud SDK, you need an XM Cloud project. This project has to be created from the [XM Cloud foundation template](https://github.com/sitecorelabs/xmcloud-foundation-head) and deployed on XM Cloud.
-
-The foundation template contains an XM Cloud JSS Next.js app. You use the Sitecore Cloud SDK in this app. To be able to use the Sitecore Cloud SDK, you need JSS version 21.6.0 or newer.
+This package provides browser- and server-side functions to run personalizations in your app. Personalization is for showing the most relevant content to your users.
 
 ## Installation
 
@@ -16,86 +10,76 @@ npm install @sitecore-cloudsdk/personalize
 
 ## Usage
 
-1. Initialize the package using the `init()` function.
-2. Run personalization using the `personalize()` function.
+1. Initialize the package using the `CloudSDK` function, available in the `core` package.
+2. To run web personalization (browser-side only):
+   1. Initialize the `events` package.
+   2. Enable web personalization during initialization.
+3. To run interactive personalization, use the `personalize` function.
 
 ## Code examples
 
----
-
-**NOTE**
-
-These code examples illustrate how the Sitecore Cloud SDK works in a standalone Next.js app. In production, you implement Sitecore Cloud SDK functionality differently, in a JSS Next.js app. See code examples for that environment in the official documentation.
-
----
-
-Run personalization from the browser side:
+Run personalizations from the browser side:
 
 ```ts
 'use client';
+
 import { useEffect } from 'react';
-import { init, personalize } from '@sitecore-cloudsdk/personalize/browser';
+import { CloudSDK } from '@sitecore-cloudsdk/core/browser';
+import { personalize } from '@sitecore-cloudsdk/personalize/browser';
 
 export default function Home() {
-  useEffect(() => {
-    initPersonalize();
-  }, []);
-
-  const initPersonalize = async () => {
-    await init({
-      sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || '',
-      siteName: process.env.NEXT_PUBLIC_SITENAME || '',
-      enableBrowserCookie: true,
+  const getPersonalizeData = async () => {
+    // Run interactive personalization:
+    const data = await personalize({
+      channel: 'WEB',
+      currency: 'EUR',
+      friendlyId: '<YOUR_EXPERIENCE_FRIENDLY_ID>'
     });
 
-    console.log(`Initialized "@sitecore-cloudsdk/personalize/browser".`);
+    console.log(data);
   };
 
-  const runPersonalization = async () => {
-    const personalizationData = {
-      friendlyId: 'personalize_test',
-    };
-
-    await personalize(personalizationData);
-
-    console.log('Ran personalization.');
-  };
+  useEffect(() => {
+    CloudSDK({
+      /* Initialization settings. See `core` package code examples. */
+    })
+      .addEvents() // Initialize the `events` package to enable web personalization
+      .addPersonalize({ enablePersonalizeCookie: true, webPersonalization: true }) // Enable web personalization
+      .initialize();
+
+    getPersonalizeData();
+  }, []);
 
-  return (
-    <div>
-      <button onClick={runPersonalization}>run personalization</button>
-    </div>
-  );
+  return <></>;
 }
 ```
 
-Run personalization from the server side:
+Run personalizations from the server side:
 
 ```ts
-import { NextResponse } from 'next/server';
-import type { NextRequest } from 'next/server';
-import { init, personalize } from '@sitecore-cloudsdk/personalize/server';
-
-export async function middleware(req: NextRequest) {
-  const res = NextResponse.next();
-
-  await init(req, res, {
-    sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || '',
-    siteName: process.env.NEXT_PUBLIC_SITENAME || '',
-    enableServerCookie: true,
+import type { NextRequest, NextResponse } from 'next/server';
+import { CloudSDK } from '@sitecore-cloudsdk/core/server';
+import { personalize } from '@sitecore-cloudsdk/personalize/server';
+
+export async function middleware(request: NextRequest) {
+  const response = NextResponse.next();
+
+  await CloudSDK(request, response, {
+    /* Initialization settings. See `core` package code examples. */
+  })
+    .addPersonalize({ enablePersonalizeCookie: true })
+    .initialize();
+
+  // Run interactive personalization:
+  const data = await personalize(request, {
+    channel: 'WEB',
+    currency: 'EUR',
+    friendlyId: '<YOUR_EXPERIENCE_FRIENDLY_ID>'
   });
 
-  console.log(`Initialized "@sitecore-cloudsdk/personalize/server".`);
-
-  const personalizationData = {
-    friendlyId: 'personalize_test',
-  };
-
-  await personalize(req, personalizationData);
-
-  console.log('Ran personalization.');
+  console.log(data);
 
-  return res;
+  return response;
 }
 ```
 

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sitecore-cloudsdk/personalize",
-    "version": "0.3.1",
+    "version": "0.4.0-rc.1",
     "license": "Apache-2.0",
     "homepage": "https://doc.sitecore.com/xmc/en/developers/sdk/latest/cloud-sdk/index.html",
     "exports": {
@@ -16,8 +16,9 @@
         }
     },
     "dependencies": {
-        "@sitecore-cloudsdk/core": "^0.3.1",
-        "@sitecore-cloudsdk/utils": "^0.3.1"
+        "@sitecore-cloudsdk/core": "^0.4.0-rc.1",
+        "@sitecore-cloudsdk/events": "^0.4.0-rc.1",
+        "@sitecore-cloudsdk/utils": "^0.4.0-rc.1"
     },
     "scripts": {
         "build": "npm run build:cjs && npm run build:es",

package/dist/cjs/src/browser.d.ts

@@ -1,4 +1,5 @@
-export { init } from './lib/initializer/client/initializer';
+export { init } from './lib/init/client/initializer';
 export { personalize } from './lib/personalization/personalize';
-export { LIBRARY_VERSION, PERSONALIZE_NAMESPACE } from './lib/consts';
+export { PACKAGE_VERSION, PERSONALIZE_NAMESPACE } from './lib/consts';
 export type { PersonalizeData } from './lib/personalization/personalizer';
+import './lib/initializer/browser/initializer';

package/dist/cjs/src/browser.js

@@ -1,11 +1,12 @@
 "use strict";
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PERSONALIZE_NAMESPACE = exports.LIBRARY_VERSION = exports.personalize = exports.init = void 0;
-var initializer_1 = require("./lib/initializer/client/initializer");
+exports.PERSONALIZE_NAMESPACE = exports.PACKAGE_VERSION = exports.personalize = exports.init = void 0;
+var initializer_1 = require("./lib/init/client/initializer");
 Object.defineProperty(exports, "init", { enumerable: true, get: function () { return initializer_1.init; } });
 var personalize_1 = require("./lib/personalization/personalize");
 Object.defineProperty(exports, "personalize", { enumerable: true, get: function () { return personalize_1.personalize; } });
 var consts_1 = require("./lib/consts");
-Object.defineProperty(exports, "LIBRARY_VERSION", { enumerable: true, get: function () { return consts_1.LIBRARY_VERSION; } });
+Object.defineProperty(exports, "PACKAGE_VERSION", { enumerable: true, get: function () { return consts_1.PACKAGE_VERSION; } });
 Object.defineProperty(exports, "PERSONALIZE_NAMESPACE", { enumerable: true, get: function () { return consts_1.PERSONALIZE_NAMESPACE; } });
+require("./lib/initializer/browser/initializer");

package/dist/cjs/src/lib/consts.d.ts

@@ -1,15 +1,12 @@
-/**
- * Returns the version of the library.
- */
-export declare const LIBRARY_VERSION: string;
+export declare const PERSONALIZE_NAMESPACE: "sitecore-cloudsdk:personalize";
+export declare const PACKAGE_VERSION: string;
+export declare const PACKAGE_NAME: string;
+export declare const UTM_PREFIX = "utm_";
 export declare enum ErrorMessages {
-    IE_0001 = "[IE-0001] The \"window\" object is not available on the server side. Use the \"window\" object only on the client side, and in the correct execution context.",
+    IE_0001 = "[IE-0001] You are trying to run a browser-side function on the server side. On the server side, run the server-side equivalent of the function, available in \"server\" modules.",
     IE_0006 = "[IE-0006] You must first initialize the \"personalize/browser\" module. Run the \"init\" function.",
     IE_0007 = "[IE-0007] You must first initialize the \"personalize/server\" module. Run the \"init\" function.",
+    IE_0016 = "[IE-0016] - You must first initialize the Cloud SDK and the \"personalize\" package. First, import \"CloudSDK\" from \"@sitecore-cloudsdk/core/browser\" and import \"@sitecore-cloudsdk/personalize/browser\". Then, run \"CloudSDK().addPersonalize().initialize()\".",
+    IE_0017 = "[IE-0017] - You must first initialize the Cloud SDK and the \"personalize\" package. First, import \"CloudSDK\" from \"@sitecore-cloudsdk/core/server\", and import \"@sitecore-cloudsdk/personalize/server\". Then, run \"await CloudSDK().addPersonalize().initialize()\".",
     MV_0004 = "[MV-0004] \"friendlyId\" is required."
 }
-/**
- * Returns the namespace of the library.
- */
-export declare const PERSONALIZE_NAMESPACE: "sitecore-cloudsdk:personalize";
-export declare const UTM_PREFIX = "utm_";

package/dist/cjs/src/lib/consts.js

@@ -4,23 +4,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UTM_PREFIX = exports.PERSONALIZE_NAMESPACE = exports.ErrorMessages = exports.LIBRARY_VERSION = void 0;
+exports.ErrorMessages = exports.UTM_PREFIX = exports.PACKAGE_NAME = exports.PACKAGE_VERSION = exports.PERSONALIZE_NAMESPACE = void 0;
 /* eslint-disable @typescript-eslint/naming-convention */
 const package_json_1 = __importDefault(require("../../package.json"));
-/**
- * Returns the version of the library.
- */
-exports.LIBRARY_VERSION = package_json_1.default.version;
+exports.PERSONALIZE_NAMESPACE = 'sitecore-cloudsdk:personalize';
+exports.PACKAGE_VERSION = package_json_1.default.version;
+exports.PACKAGE_NAME = package_json_1.default.name;
+exports.UTM_PREFIX = 'utm_';
 var ErrorMessages;
 (function (ErrorMessages) {
     // eslint-disable-next-line max-len
-    ErrorMessages["IE_0001"] = "[IE-0001] The \"window\" object is not available on the server side. Use the \"window\" object only on the client side, and in the correct execution context.";
+    ErrorMessages["IE_0001"] = "[IE-0001] You are trying to run a browser-side function on the server side. On the server side, run the server-side equivalent of the function, available in \"server\" modules.";
     ErrorMessages["IE_0006"] = "[IE-0006] You must first initialize the \"personalize/browser\" module. Run the \"init\" function.";
     ErrorMessages["IE_0007"] = "[IE-0007] You must first initialize the \"personalize/server\" module. Run the \"init\" function.";
+    // eslint-disable-next-line max-len
+    ErrorMessages["IE_0016"] = "[IE-0016] - You must first initialize the Cloud SDK and the \"personalize\" package. First, import \"CloudSDK\" from \"@sitecore-cloudsdk/core/browser\" and import \"@sitecore-cloudsdk/personalize/browser\". Then, run \"CloudSDK().addPersonalize().initialize()\".";
+    // eslint-disable-next-line max-len
+    ErrorMessages["IE_0017"] = "[IE-0017] - You must first initialize the Cloud SDK and the \"personalize\" package. First, import \"CloudSDK\" from \"@sitecore-cloudsdk/core/server\", and import \"@sitecore-cloudsdk/personalize/server\". Then, run \"await CloudSDK().addPersonalize().initialize()\".";
     ErrorMessages["MV_0004"] = "[MV-0004] \"friendlyId\" is required.";
 })(ErrorMessages || (exports.ErrorMessages = ErrorMessages = {}));
-/**
- * Returns the namespace of the library.
- */
-exports.PERSONALIZE_NAMESPACE = 'sitecore-cloudsdk:personalize';
-exports.UTM_PREFIX = 'utm_';

package/dist/cjs/src/lib/{initializer → init}/client/initializer.d.ts

@@ -1,9 +1,11 @@
-import type { BrowserSettings } from '@sitecore-cloudsdk/core';
+import { type BrowserSettings } from '@sitecore-cloudsdk/core/internal';
 export declare let initPromise: Promise<void> | null;
 /**
  * Initiates the Engage library using the global settings added by the developer
  * @param settings - Global settings added by the developer
- * @returns A promise that resolves with an object that handles the library functionality
+ * @returns A promise that resolves with an object that handles the library
+ * The base class for controls that can be rendered.
+ * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
  */
 export declare function init(settings: BrowserSettings): Promise<void>;
 /**

package/dist/cjs/src/lib/{initializer → init}/client/initializer.js

@@ -2,34 +2,39 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.awaitInit = exports.init = exports.initPromise = void 0;
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const internal_1 = require("@sitecore-cloudsdk/core/internal");
 const consts_1 = require("../../consts");
-const core_1 = require("@sitecore-cloudsdk/core");
+const internal_2 = require("@sitecore-cloudsdk/core/internal");
 exports.initPromise = null;
+/* eslint-disable max-len */
 /**
  * Initiates the Engage library using the global settings added by the developer
  * @param settings - Global settings added by the developer
- * @returns A promise that resolves with an object that handles the library functionality
+ * @returns A promise that resolves with an object that handles the library
+ * The base class for controls that can be rendered.
+ * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
  */
+/* eslint-enable max-len */
 async function init(settings) {
     if (typeof window === 'undefined')
         throw new Error(consts_1.ErrorMessages.IE_0001);
     try {
-        exports.initPromise = (0, core_1.initCore)(settings);
+        exports.initPromise = (0, internal_2.initCore)(settings);
         await exports.initPromise;
-        (0, core_1.debug)(consts_1.PERSONALIZE_NAMESPACE)('personalizeClient library initialized');
+        (0, internal_2.debug)(consts_1.PERSONALIZE_NAMESPACE)('personalizeClient library initialized');
     }
     catch (error) {
-        (0, core_1.debug)(consts_1.PERSONALIZE_NAMESPACE)('Error on initializing personalizeClient library with error: %o', error);
+        (0, internal_2.debug)(consts_1.PERSONALIZE_NAMESPACE)('Error on initializing personalizeClient library with error: %o', error);
         exports.initPromise = null;
         throw new Error(error);
     }
     window.Engage ?? (window.Engage = {});
     window.Engage = {
         ...window.Engage,
-        getBrowserId: () => (0, core_1.getBrowserId)(),
+        getBrowserId: () => (0, internal_1.getBrowserId)(),
         versions: {
             ...window.Engage.versions,
-            personalize: consts_1.LIBRARY_VERSION
+            personalize: consts_1.PACKAGE_VERSION
         }
     };
 }
@@ -38,8 +43,10 @@ exports.init = init;
  * A function that handles the async browser init logic. Throws an error or awaits the promise.
  */
 async function awaitInit() {
-    if (exports.initPromise === null)
-        throw new Error(consts_1.ErrorMessages.IE_0006);
+    const initState = (0, internal_1.getEnabledPackageBrowser)(consts_1.PACKAGE_NAME)?.initState;
+    if (exports.initPromise === null && !initState)
+        throw new Error(consts_1.ErrorMessages.IE_0016);
     await exports.initPromise;
+    await initState;
 }
 exports.awaitInit = awaitInit;

package/dist/cjs/src/lib/init/server/initializer.d.ts

@@ -0,0 +1,11 @@
+import type { Request, Response } from '@sitecore-cloudsdk/utils';
+import { type ServerSettings } from '@sitecore-cloudsdk/core/internal';
+/**
+ * Initiates the server Engage library using the global settings added by the developer
+ * @param request - The request object, either a Middleware Request or an HTTP Request
+ * @param response - The response object, either a Middleware Next Response or an HTTP Response
+ * @param settings - Global settings added by the developer
+ * @returns A promise that resolves with an object that handles the library functionality
+ * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
+ */
+export declare function initServer(request: Request, response: Response, settings: ServerSettings): Promise<void>;

package/dist/cjs/src/lib/init/server/initializer.js

@@ -0,0 +1,28 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initServer = void 0;
+const internal_1 = require("@sitecore-cloudsdk/core/internal");
+const consts_1 = require("../../consts");
+const internal_2 = require("@sitecore-cloudsdk/core/internal");
+/* eslint-disable max-len */
+/**
+ * Initiates the server Engage library using the global settings added by the developer
+ * @param request - The request object, either a Middleware Request or an HTTP Request
+ * @param response - The response object, either a Middleware Next Response or an HTTP Response
+ * @param settings - Global settings added by the developer
+ * @returns A promise that resolves with an object that handles the library functionality
+ * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
+ */
+/* eslint-enable max-len */
+async function initServer(request, response, settings) {
+    try {
+        await (0, internal_1.initCoreServer)(settings, request, response);
+        (0, internal_2.debug)(consts_1.PERSONALIZE_NAMESPACE)('personalizeServer library initialized');
+    }
+    catch (error) {
+        (0, internal_2.debug)(consts_1.PERSONALIZE_NAMESPACE)('Error on initializing personalizeServer library with error: %o', error);
+        throw new Error(error);
+    }
+}
+exports.initServer = initServer;

package/dist/cjs/src/lib/initializer/browser/createPersonalizeCookie.d.ts

@@ -0,0 +1,3 @@
+import type { Settings } from '@sitecore-cloudsdk/core/browser';
+import type { PersonalizeSettings } from './interfaces';
+export declare function createPersonalizeCookie(personalizeSettings: PersonalizeSettings, cloudSDKSettings: Settings): Promise<void | boolean>;

package/dist/cjs/src/lib/initializer/browser/createPersonalizeCookie.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPersonalizeCookie = void 0;
+const internal_1 = require("@sitecore-cloudsdk/core/internal");
+const utils_1 = require("@sitecore-cloudsdk/utils");
+async function createPersonalizeCookie(personalizeSettings, cloudSDKSettings) {
+    const cookiesValuesFromEdgeBrowser = (0, internal_1.getCookiesValuesFromEdgeBrowser)();
+    const attributes = (0, internal_1.getDefaultCookieAttributes)(cloudSDKSettings.cookieSettings.expiryDays, cloudSDKSettings.cookieSettings.domain);
+    const guestIdCookieValue = (0, utils_1.getCookieValueClientSide)(personalizeSettings.cookieSettings.name.guestId);
+    const browserIdCookieValue = (0, utils_1.getCookieValueClientSide)(cloudSDKSettings.cookieSettings.name.browserId);
+    if (guestIdCookieValue)
+        return;
+    else if (cookiesValuesFromEdgeBrowser?.guestId)
+        document.cookie = (0, utils_1.createCookieString)(personalizeSettings.cookieSettings.name.guestId, cookiesValuesFromEdgeBrowser.guestId, attributes);
+    else if (browserIdCookieValue) {
+        const guestIdCookieValue = await (0, internal_1.getGuestId)(browserIdCookieValue, cloudSDKSettings.sitecoreEdgeContextId, cloudSDKSettings.sitecoreEdgeUrl);
+        document.cookie = (0, utils_1.createCookieString)(personalizeSettings.cookieSettings.name.guestId, guestIdCookieValue, attributes);
+    }
+}
+exports.createPersonalizeCookie = createPersonalizeCookie;

package/dist/cjs/src/lib/initializer/browser/initializer.d.ts

@@ -0,0 +1,32 @@
+import { CloudSDKBrowserInitializer } from '@sitecore-cloudsdk/core/browser';
+import { type EPResponse } from '@sitecore-cloudsdk/core/internal';
+import type { EventData, IdentityData } from '@sitecore-cloudsdk/events/browser';
+import type { BrowserSettings } from './interfaces';
+export declare function sideEffects(): Promise<void>;
+/**
+ * Makes the functionality of the personalize package available.
+ *
+ * @returns An instance of {@link CloudSDKBrowserInitializer}
+ */
+export declare function addPersonalize(this: CloudSDKBrowserInitializer, settings?: BrowserSettings): CloudSDKBrowserInitializer;
+declare module '@sitecore-cloudsdk/core/browser' {
+    interface CloudSDKBrowserInitializer {
+        addPersonalize: typeof addPersonalize;
+    }
+}
+declare global {
+    interface Personalize {
+        settings?: {
+            async?: boolean;
+            defer?: boolean;
+        };
+        version: string;
+        pageView?: () => Promise<EPResponse | null>;
+        identity?: (identityData: IdentityData) => Promise<EPResponse | null>;
+        form?: (formId: string, interactionType: 'VIEWED' | 'SUBMITTED', componentInstanceId: string) => Promise<EPResponse | null>;
+        event?: (eventData: EventData) => Promise<EPResponse | null>;
+        addToEventQueue?: (eventData: EventData) => Promise<void>;
+        processEventQueue?: () => Promise<void>;
+        clearEventQueue?: () => Promise<void>;
+    }
+}

package/dist/cjs/src/lib/initializer/browser/initializer.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addPersonalize = exports.sideEffects = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const browser_1 = require("@sitecore-cloudsdk/core/browser");
+const internal_1 = require("@sitecore-cloudsdk/core/internal");
+const browser_2 = require("@sitecore-cloudsdk/events/browser");
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const consts_1 = require("../../consts");
+const get_cdn_url_1 = require("../../web-personalization/get-cdn-url");
+const createPersonalizeCookie_1 = require("./createPersonalizeCookie");
+async function sideEffects() {
+    const personalizeSettings = (0, internal_1.getEnabledPackageBrowser)(consts_1.PACKAGE_NAME)?.settings;
+    const cloudSDKSettings = (0, internal_1.getCloudSDKSettingsBrowser)();
+    window.scCloudSDK = {
+        ...window.scCloudSDK,
+        personalize: {
+            version: consts_1.PACKAGE_VERSION
+        }
+    };
+    if (personalizeSettings.webPersonalization) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        window.scCloudSDK.personalize.settings = personalizeSettings.webPersonalization;
+        window.scCloudSDK.personalize = {
+            ...window.scCloudSDK.personalize,
+            addToEventQueue: browser_2.addToEventQueue,
+            clearEventQueue: browser_2.clearEventQueue,
+            event: browser_2.event,
+            form: browser_2.form,
+            identity: browser_2.identity,
+            pageView: browser_2.pageView,
+            processEventQueue: browser_2.processEventQueue
+        };
+        const cdnUrl = await (0, get_cdn_url_1.getCdnUrl)(cloudSDKSettings.sitecoreEdgeContextId, cloudSDKSettings.sitecoreEdgeUrl);
+        if (cdnUrl)
+            (0, utils_1.appendScriptWithAttributes)({ async: personalizeSettings.webPersonalization.async, src: cdnUrl });
+    }
+    (0, internal_1.debug)(consts_1.PERSONALIZE_NAMESPACE)('personalizeClient library initialized');
+    if (!cloudSDKSettings.cookieSettings.enableBrowserCookie || !personalizeSettings.enablePersonalizeCookie)
+        return;
+    await (0, createPersonalizeCookie_1.createPersonalizeCookie)(personalizeSettings, cloudSDKSettings);
+}
+exports.sideEffects = sideEffects;
+/**
+ * Makes the functionality of the personalize package available.
+ *
+ * @returns An instance of {@link CloudSDKBrowserInitializer}
+ */
+function addPersonalize(settings = { enablePersonalizeCookie: false }) {
+    const dependencies = [];
+    const cookieSettings = {
+        name: {
+            guestId: `${internal_1.COOKIE_NAME_PREFIX}${(0, internal_1.getCloudSDKSettingsBrowser)().sitecoreEdgeContextId}_personalize`
+        }
+    };
+    let webPersonalization = false;
+    if (settings.webPersonalization) {
+        dependencies.push({ method: browser_2.PACKAGE_INITIALIZER_METHOD_NAME, name: browser_2.PACKAGE_NAME });
+        webPersonalization = {
+            async: settings.webPersonalization.async ?? true,
+            defer: settings.webPersonalization.defer ?? false
+        };
+    }
+    const personalizeInitializer = new internal_1.PackageInitializer({
+        dependencies,
+        settings: { ...settings, cookieSettings, webPersonalization },
+        sideEffects
+    });
+    internal_1.enabledPackagesBrowser.set(consts_1.PACKAGE_NAME, personalizeInitializer);
+    return this;
+}
+exports.addPersonalize = addPersonalize;
+browser_1.CloudSDKBrowserInitializer.prototype.addPersonalize = addPersonalize;

package/dist/cjs/src/lib/initializer/browser/interfaces.d.ts

@@ -0,0 +1,17 @@
+export type WebPersonalizationSettings = {
+    async: boolean;
+    defer: boolean;
+};
+export interface BrowserSettings {
+    webPersonalization?: boolean | Partial<WebPersonalizationSettings>;
+    enablePersonalizeCookie?: boolean;
+}
+export interface PersonalizeSettings {
+    webPersonalization: false | WebPersonalizationSettings;
+    enablePersonalizeCookie?: boolean;
+    cookieSettings: {
+        name: {
+            guestId: string;
+        };
+    };
+}

package/dist/cjs/src/lib/initializer/browser/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/lib/initializer/server/createPersonalizeCookie.d.ts

@@ -0,0 +1,4 @@
+import type { Settings } from '@sitecore-cloudsdk/core/server';
+import { type Request, type Response } from '@sitecore-cloudsdk/utils';
+import type { PersonalizeSettings } from './interfaces';
+export declare function createPersonalizeCookie(request: Request, response: Response, settings: PersonalizeSettings, cloudSDKSettings: Settings): Promise<void>;

package/dist/cjs/src/lib/initializer/server/createPersonalizeCookie.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPersonalizeCookie = void 0;
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const handleHttpCookie_1 = require("./handleHttpCookie");
+const handleNextJsMiddlewareCookie_1 = require("./handleNextJsMiddlewareCookie");
+async function createPersonalizeCookie(request, response, settings, cloudSDKSettings) {
+    if ((0, utils_1.isNextJsMiddlewareRequest)(request) && (0, utils_1.isNextJsMiddlewareResponse)(response))
+        await (0, handleNextJsMiddlewareCookie_1.handleNextJsMiddlewareCookie)(request, response, settings, cloudSDKSettings);
+    else if ((0, utils_1.isHttpRequest)(request) && (0, utils_1.isHttpResponse)(response))
+        await (0, handleHttpCookie_1.handleHttpCookie)(request, response, settings, cloudSDKSettings);
+}
+exports.createPersonalizeCookie = createPersonalizeCookie;

package/dist/cjs/src/lib/initializer/server/handleHttpCookie.d.ts

@@ -0,0 +1,4 @@
+import type { Settings } from '@sitecore-cloudsdk/core/server';
+import { type Request, type Response } from '@sitecore-cloudsdk/utils';
+import type { PersonalizeSettings } from './interfaces';
+export declare function handleHttpCookie(request: Request, response: Response, settings: PersonalizeSettings, cloudSDKSettings: Settings): Promise<void>;

package/dist/cjs/src/lib/initializer/server/handleHttpCookie.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleHttpCookie = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const internal_1 = require("@sitecore-cloudsdk/core/internal");
+const utils_1 = require("@sitecore-cloudsdk/utils");
+async function handleHttpCookie(request, response, settings, cloudSDKSettings) {
+    const httpRequest = request;
+    const httpResponse = response;
+    const cookiesValuesFromEdgeServer = (0, internal_1.getCookiesValuesFromEdgeServer)();
+    const guestIdCookie = (0, utils_1.getCookieServerSide)(httpRequest.headers.cookie, settings.cookieSettings.name.guestId);
+    const browserIdCookie = (0, utils_1.getCookieServerSide)(httpRequest.headers.cookie, cloudSDKSettings.cookieSettings.name.browserId);
+    const defaultCookieAttributes = (0, internal_1.getDefaultCookieAttributes)(cloudSDKSettings.cookieSettings.expiryDays, cloudSDKSettings.cookieSettings.domain);
+    let guestIdCookieString;
+    if (guestIdCookie)
+        guestIdCookieString = (0, utils_1.createCookieString)(settings.cookieSettings.name.guestId, guestIdCookie.value, defaultCookieAttributes);
+    else if (cookiesValuesFromEdgeServer.guestId)
+        guestIdCookieString = (0, utils_1.createCookieString)(settings.cookieSettings.name.guestId, cookiesValuesFromEdgeServer.guestId, defaultCookieAttributes);
+    else if (browserIdCookie) {
+        const guestIdCookieValueFromEdgeProxy = await (0, internal_1.getGuestId)(browserIdCookie.value, cloudSDKSettings.sitecoreEdgeContextId, cloudSDKSettings.sitecoreEdgeUrl);
+        guestIdCookieString = (0, utils_1.createCookieString)(settings.cookieSettings.name.guestId, guestIdCookieValueFromEdgeProxy, defaultCookieAttributes);
+    }
+    else
+        return;
+    if (!guestIdCookie)
+        httpRequest.headers.cookie = httpRequest.headers.cookie
+            ? httpRequest.headers.cookie + '; ' + guestIdCookieString
+            : guestIdCookieString;
+    httpResponse.setHeader('Set-Cookie', guestIdCookieString);
+}
+exports.handleHttpCookie = handleHttpCookie;

package/dist/cjs/src/lib/initializer/server/handleNextJsMiddlewareCookie.d.ts

@@ -0,0 +1,4 @@
+import type { Settings } from '@sitecore-cloudsdk/core/server';
+import type { Request, Response } from '@sitecore-cloudsdk/utils';
+import type { PersonalizeSettings } from './interfaces';
+export declare function handleNextJsMiddlewareCookie(request: Request, response: Response, settings: PersonalizeSettings, cloudSDKSettings: Settings): Promise<void>;

package/dist/cjs/src/lib/initializer/server/handleNextJsMiddlewareCookie.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleNextJsMiddlewareCookie = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const internal_1 = require("@sitecore-cloudsdk/core/internal");
+async function handleNextJsMiddlewareCookie(request, response, settings, cloudSDKSettings) {
+    const middlewareRequest = request;
+    const middlewareResponse = response;
+    const cookiesValuesFromEdgeServer = (0, internal_1.getCookiesValuesFromEdgeServer)();
+    const guestIdCookieValue = (0, internal_1.getCookieValueFromMiddlewareRequest)(middlewareRequest, settings.cookieSettings.name.guestId);
+    const browserIdCookieValue = (0, internal_1.getCookieValueFromMiddlewareRequest)(middlewareRequest, cloudSDKSettings.cookieSettings.name.browserId);
+    const defaultCookieAttributes = (0, internal_1.getDefaultCookieAttributes)(cloudSDKSettings.cookieSettings.expiryDays, cloudSDKSettings.cookieSettings.domain);
+    let guestIdValue;
+    if (guestIdCookieValue)
+        guestIdValue = guestIdCookieValue;
+    else if (cookiesValuesFromEdgeServer.guestId)
+        guestIdValue = cookiesValuesFromEdgeServer.guestId;
+    else if (browserIdCookieValue) {
+        const guestIdCookieValueFromEdgeProxy = await (0, internal_1.getGuestId)(browserIdCookieValue, cloudSDKSettings.sitecoreEdgeContextId, cloudSDKSettings.sitecoreEdgeUrl);
+        guestIdValue = guestIdCookieValueFromEdgeProxy;
+    }
+    else
+        return;
+    middlewareRequest.cookies.set(settings.cookieSettings.name.guestId, guestIdValue, defaultCookieAttributes);
+    middlewareResponse.cookies.set(settings.cookieSettings.name.guestId, guestIdValue, defaultCookieAttributes);
+}
+exports.handleNextJsMiddlewareCookie = handleNextJsMiddlewareCookie;