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

package/dist/esm/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/esm/src/browser.js

@@ -1,4 +1,5 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-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';
+import './lib/initializer/browser/initializer';

package/dist/esm/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/esm/src/lib/consts.js

@@ -1,20 +1,19 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 /* eslint-disable @typescript-eslint/naming-convention */
 import packageJson from '../../package.json';
-/**
- * Returns the version of the library.
- */
-export const LIBRARY_VERSION = packageJson.version;
+export const PERSONALIZE_NAMESPACE = 'sitecore-cloudsdk:personalize';
+export const PACKAGE_VERSION = packageJson.version;
+export const PACKAGE_NAME = packageJson.name;
+export const UTM_PREFIX = 'utm_';
 export 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 || (ErrorMessages = {}));
-/**
- * Returns the namespace of the library.
- */
-export const PERSONALIZE_NAMESPACE = 'sitecore-cloudsdk:personalize';
-export const UTM_PREFIX = 'utm_';

package/dist/esm/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/esm/src/lib/{initializer → init}/client/initializer.js

@@ -1,12 +1,17 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { ErrorMessages, LIBRARY_VERSION, PERSONALIZE_NAMESPACE } from '../../consts';
-import { debug, getBrowserId, initCore } from '@sitecore-cloudsdk/core';
+import { getBrowserId, getEnabledPackageBrowser as getEnabledPackage } from '@sitecore-cloudsdk/core/internal';
+import { ErrorMessages, PACKAGE_NAME, PACKAGE_VERSION, PERSONALIZE_NAMESPACE } from '../../consts';
+import { debug, initCore } from '@sitecore-cloudsdk/core/internal';
 export let 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 */
 export async function init(settings) {
     if (typeof window === 'undefined')
         throw new Error(ErrorMessages.IE_0001);
@@ -26,7 +31,7 @@ export async function init(settings) {
         getBrowserId: () => getBrowserId(),
         versions: {
             ...window.Engage.versions,
-            personalize: LIBRARY_VERSION
+            personalize: PACKAGE_VERSION
         }
     };
 }
@@ -34,7 +39,9 @@ export async function init(settings) {
  * A function that handles the async browser init logic. Throws an error or awaits the promise.
  */
 export async function awaitInit() {
-    if (initPromise === null)
-        throw new Error(ErrorMessages.IE_0006);
+    const initState = getEnabledPackage(PACKAGE_NAME)?.initState;
+    if (initPromise === null && !initState)
+        throw new Error(ErrorMessages.IE_0016);
     await initPromise;
+    await initState;
 }

package/dist/esm/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/esm/src/lib/init/server/initializer.js

@@ -0,0 +1,24 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { initCoreServer } from '@sitecore-cloudsdk/core/internal';
+import { PERSONALIZE_NAMESPACE } from '../../consts';
+import { debug } from '@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 */
+export async function initServer(request, response, settings) {
+    try {
+        await initCoreServer(settings, request, response);
+        debug(PERSONALIZE_NAMESPACE)('personalizeServer library initialized');
+    }
+    catch (error) {
+        debug(PERSONALIZE_NAMESPACE)('Error on initializing personalizeServer library with error: %o', error);
+        throw new Error(error);
+    }
+}

package/dist/esm/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/esm/src/lib/initializer/browser/createPersonalizeCookie.js

@@ -0,0 +1,16 @@
+import { getCookiesValuesFromEdgeBrowser, getDefaultCookieAttributes, getGuestId } from '@sitecore-cloudsdk/core/internal';
+import { createCookieString, getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
+export async function createPersonalizeCookie(personalizeSettings, cloudSDKSettings) {
+    const cookiesValuesFromEdgeBrowser = getCookiesValuesFromEdgeBrowser();
+    const attributes = getDefaultCookieAttributes(cloudSDKSettings.cookieSettings.expiryDays, cloudSDKSettings.cookieSettings.domain);
+    const guestIdCookieValue = getCookieValueClientSide(personalizeSettings.cookieSettings.name.guestId);
+    const browserIdCookieValue = getCookieValueClientSide(cloudSDKSettings.cookieSettings.name.browserId);
+    if (guestIdCookieValue)
+        return;
+    else if (cookiesValuesFromEdgeBrowser?.guestId)
+        document.cookie = createCookieString(personalizeSettings.cookieSettings.name.guestId, cookiesValuesFromEdgeBrowser.guestId, attributes);
+    else if (browserIdCookieValue) {
+        const guestIdCookieValue = await getGuestId(browserIdCookieValue, cloudSDKSettings.sitecoreEdgeContextId, cloudSDKSettings.sitecoreEdgeUrl);
+        document.cookie = createCookieString(personalizeSettings.cookieSettings.name.guestId, guestIdCookieValue, attributes);
+    }
+}

package/dist/esm/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/esm/src/lib/initializer/browser/initializer.js

@@ -0,0 +1,68 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { CloudSDKBrowserInitializer } from '@sitecore-cloudsdk/core/browser';
+import { COOKIE_NAME_PREFIX, debug, enabledPackagesBrowser as enabledPackages, getCloudSDKSettingsBrowser as getCloudSDKSettings, getEnabledPackageBrowser, PackageInitializer } from '@sitecore-cloudsdk/core/internal';
+import { addToEventQueue, clearEventQueue, event, PACKAGE_NAME as EVENTS_PACKAGE_NAME, form, identity, PACKAGE_INITIALIZER_METHOD_NAME, pageView, processEventQueue } from '@sitecore-cloudsdk/events/browser';
+import { appendScriptWithAttributes } from '@sitecore-cloudsdk/utils';
+import { PACKAGE_NAME, PACKAGE_VERSION, PERSONALIZE_NAMESPACE } from '../../consts';
+import { getCdnUrl } from '../../web-personalization/get-cdn-url';
+import { createPersonalizeCookie } from './createPersonalizeCookie';
+export async function sideEffects() {
+    const personalizeSettings = getEnabledPackageBrowser(PACKAGE_NAME)?.settings;
+    const cloudSDKSettings = getCloudSDKSettings();
+    window.scCloudSDK = {
+        ...window.scCloudSDK,
+        personalize: {
+            version: 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,
+            clearEventQueue,
+            event,
+            form,
+            identity,
+            pageView,
+            processEventQueue
+        };
+        const cdnUrl = await getCdnUrl(cloudSDKSettings.sitecoreEdgeContextId, cloudSDKSettings.sitecoreEdgeUrl);
+        if (cdnUrl)
+            appendScriptWithAttributes({ async: personalizeSettings.webPersonalization.async, src: cdnUrl });
+    }
+    debug(PERSONALIZE_NAMESPACE)('personalizeClient library initialized');
+    if (!cloudSDKSettings.cookieSettings.enableBrowserCookie || !personalizeSettings.enablePersonalizeCookie)
+        return;
+    await createPersonalizeCookie(personalizeSettings, cloudSDKSettings);
+}
+/**
+ * Makes the functionality of the personalize package available.
+ *
+ * @returns An instance of {@link CloudSDKBrowserInitializer}
+ */
+export function addPersonalize(settings = { enablePersonalizeCookie: false }) {
+    const dependencies = [];
+    const cookieSettings = {
+        name: {
+            guestId: `${COOKIE_NAME_PREFIX}${getCloudSDKSettings().sitecoreEdgeContextId}_personalize`
+        }
+    };
+    let webPersonalization = false;
+    if (settings.webPersonalization) {
+        dependencies.push({ method: PACKAGE_INITIALIZER_METHOD_NAME, name: EVENTS_PACKAGE_NAME });
+        webPersonalization = {
+            async: settings.webPersonalization.async ?? true,
+            defer: settings.webPersonalization.defer ?? false
+        };
+    }
+    const personalizeInitializer = new PackageInitializer({
+        dependencies,
+        settings: { ...settings, cookieSettings, webPersonalization },
+        sideEffects
+    });
+    enabledPackages.set(PACKAGE_NAME, personalizeInitializer);
+    return this;
+}
+CloudSDKBrowserInitializer.prototype.addPersonalize = addPersonalize;

package/dist/esm/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/esm/src/lib/initializer/browser/interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/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/esm/src/lib/initializer/server/createPersonalizeCookie.js

@@ -0,0 +1,9 @@
+import { isHttpRequest, isHttpResponse, isNextJsMiddlewareRequest, isNextJsMiddlewareResponse } from '@sitecore-cloudsdk/utils';
+import { handleHttpCookie } from './handleHttpCookie';
+import { handleNextJsMiddlewareCookie } from './handleNextJsMiddlewareCookie';
+export async function createPersonalizeCookie(request, response, settings, cloudSDKSettings) {
+    if (isNextJsMiddlewareRequest(request) && isNextJsMiddlewareResponse(response))
+        await handleNextJsMiddlewareCookie(request, response, settings, cloudSDKSettings);
+    else if (isHttpRequest(request) && isHttpResponse(response))
+        await handleHttpCookie(request, response, settings, cloudSDKSettings);
+}

package/dist/esm/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/esm/src/lib/initializer/server/handleHttpCookie.js

@@ -0,0 +1,27 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { getCookiesValuesFromEdgeServer, getDefaultCookieAttributes, getGuestId } from '@sitecore-cloudsdk/core/internal';
+import { createCookieString, getCookieServerSide } from '@sitecore-cloudsdk/utils';
+export async function handleHttpCookie(request, response, settings, cloudSDKSettings) {
+    const httpRequest = request;
+    const httpResponse = response;
+    const cookiesValuesFromEdgeServer = getCookiesValuesFromEdgeServer();
+    const guestIdCookie = getCookieServerSide(httpRequest.headers.cookie, settings.cookieSettings.name.guestId);
+    const browserIdCookie = getCookieServerSide(httpRequest.headers.cookie, cloudSDKSettings.cookieSettings.name.browserId);
+    const defaultCookieAttributes = getDefaultCookieAttributes(cloudSDKSettings.cookieSettings.expiryDays, cloudSDKSettings.cookieSettings.domain);
+    let guestIdCookieString;
+    if (guestIdCookie)
+        guestIdCookieString = createCookieString(settings.cookieSettings.name.guestId, guestIdCookie.value, defaultCookieAttributes);
+    else if (cookiesValuesFromEdgeServer.guestId)
+        guestIdCookieString = createCookieString(settings.cookieSettings.name.guestId, cookiesValuesFromEdgeServer.guestId, defaultCookieAttributes);
+    else if (browserIdCookie) {
+        const guestIdCookieValueFromEdgeProxy = await getGuestId(browserIdCookie.value, cloudSDKSettings.sitecoreEdgeContextId, cloudSDKSettings.sitecoreEdgeUrl);
+        guestIdCookieString = 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);
+}

package/dist/esm/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/esm/src/lib/initializer/server/handleNextJsMiddlewareCookie.js

@@ -0,0 +1,23 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { getCookiesValuesFromEdgeServer, getCookieValueFromMiddlewareRequest, getDefaultCookieAttributes, getGuestId } from '@sitecore-cloudsdk/core/internal';
+export async function handleNextJsMiddlewareCookie(request, response, settings, cloudSDKSettings) {
+    const middlewareRequest = request;
+    const middlewareResponse = response;
+    const cookiesValuesFromEdgeServer = getCookiesValuesFromEdgeServer();
+    const guestIdCookieValue = getCookieValueFromMiddlewareRequest(middlewareRequest, settings.cookieSettings.name.guestId);
+    const browserIdCookieValue = getCookieValueFromMiddlewareRequest(middlewareRequest, cloudSDKSettings.cookieSettings.name.browserId);
+    const defaultCookieAttributes = 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 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);
+}

package/dist/esm/src/lib/initializer/server/initializer.d.ts

@@ -1,10 +1,15 @@
-import type { Request, Response } from '@sitecore-cloudsdk/utils';
-import type { ServerSettings } from '@sitecore-cloudsdk/core';
+import { CloudSDKServerInitializer } from '@sitecore-cloudsdk/core/server';
+import type { ServerSettings } from './interfaces';
+export declare function sideEffects(): Promise<void>;
 /**
- * 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
+ * Makes the functionality of the personalize package available.
+ *
+ * @returns An instance of {@link CloudSDKServerInitializer}
+ *
  */
-export declare function initServer(request: Request, response: Response, settings: ServerSettings): Promise<void>;
+export declare function addPersonalize(this: CloudSDKServerInitializer, settings?: ServerSettings): CloudSDKServerInitializer;
+declare module '@sitecore-cloudsdk/core/server' {
+    interface CloudSDKServerInitializer {
+        addPersonalize: typeof addPersonalize;
+    }
+}

package/dist/esm/src/lib/initializer/server/initializer.js

@@ -1,20 +1,33 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { debug, initCoreServer } from '@sitecore-cloudsdk/core';
-import { PERSONALIZE_NAMESPACE } from '../../consts';
+import { COOKIE_NAME_PREFIX, debug, enabledPackagesServer as enabledPackages, getCloudSDKRequest, getCloudSDKResponse, getCloudSDKSettingsServer, getEnabledPackageServer, PackageInitializerServer } from '@sitecore-cloudsdk/core/internal';
+import { CloudSDKServerInitializer } from '@sitecore-cloudsdk/core/server';
+import { PACKAGE_NAME, PERSONALIZE_NAMESPACE } from '../../consts';
+import { createPersonalizeCookie } from './createPersonalizeCookie';
+export async function sideEffects() {
+    const cloudSDKSettings = getCloudSDKSettingsServer();
+    const personalizeSettings = getEnabledPackageServer(PACKAGE_NAME)?.settings;
+    debug(PERSONALIZE_NAMESPACE)('personalizeServer library initialized');
+    if (!cloudSDKSettings.cookieSettings.enableServerCookie || !personalizeSettings.enablePersonalizeCookie)
+        return;
+    await createPersonalizeCookie(getCloudSDKRequest(), getCloudSDKResponse(), personalizeSettings, cloudSDKSettings);
+}
 /**
- * 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
+ * Makes the functionality of the personalize package available.
+ *
+ * @returns An instance of {@link CloudSDKServerInitializer}
+ *
  */
-export async function initServer(request, response, settings) {
-    try {
-        await initCoreServer(settings, request, response);
-        debug(PERSONALIZE_NAMESPACE)('personalizeServer library initialized');
-    }
-    catch (error) {
-        debug(PERSONALIZE_NAMESPACE)('Error on initializing personalizeServer library with error: %o', error);
-        throw new Error(error);
-    }
+export function addPersonalize(settings = { enablePersonalizeCookie: false }) {
+    const cookieSettings = {
+        name: {
+            guestId: `${COOKIE_NAME_PREFIX}${getCloudSDKSettingsServer().sitecoreEdgeContextId}_personalize`
+        }
+    };
+    const personalizeInitializer = new PackageInitializerServer({
+        settings: { ...settings, cookieSettings },
+        sideEffects
+    });
+    enabledPackages.set(PACKAGE_NAME, personalizeInitializer);
+    return this;
 }
+CloudSDKServerInitializer.prototype.addPersonalize = addPersonalize;

package/dist/esm/src/lib/initializer/server/interfaces.d.ts

@@ -0,0 +1,11 @@
+export interface ServerSettings {
+    enablePersonalizeCookie?: boolean;
+}
+export interface PersonalizeSettings {
+    enablePersonalizeCookie?: boolean;
+    cookieSettings: {
+        name: {
+            guestId: string;
+        };
+    };
+}

package/dist/esm/src/lib/initializer/server/interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/src/lib/personalization/personalize.d.ts

@@ -1,5 +1,5 @@
-import type { FailedCalledFlowsResponse } from './send-call-flows-request';
 import type { PersonalizeData } from './personalizer';
+import type { FailedCalledFlowsResponse } from './send-call-flows-request';
 /**
  * A function that executes an interactive experiment or web experiment over any web-based or mobile application.
  * @param personalizeData - The required/optional attributes in order to create a flow execution

package/dist/esm/src/lib/personalization/personalize.js

@@ -1,9 +1,9 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getBrowserId, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core';
-import { ErrorMessages } from '../consts';
-import { Personalizer } from './personalizer';
-import { awaitInit } from '../initializer/client/initializer';
+import { getBrowserId, getCloudSDKSettingsBrowser as getCloudSDKSettings, getEnabledPackageBrowser as getEnabledPackage, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core/internal';
 import { getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
+import { ErrorMessages, PACKAGE_NAME } from '../consts';
+import { awaitInit } from '../init/client/initializer';
+import { Personalizer } from './personalizer';
 /**
  * A function that executes an interactive experiment or web experiment over any web-based or mobile application.
  * @param personalizeData - The required/optional attributes in order to create a flow execution
@@ -12,10 +12,21 @@ import { getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
  */
 export async function personalize(personalizeData, opts) {
     await awaitInit();
-    const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0006);
-    const id = getBrowserId();
-    const guestId = getCookieValueClientSide(settings.cookieSettings.cookieNames.guestId);
-    return new Personalizer(id, guestId).getInteractiveExperienceData(personalizeData, settings, window.location.search, {
-        timeout: opts?.timeout
-    });
+    if (getEnabledPackage(PACKAGE_NAME)?.initState) {
+        const cloudSDKSettings = getCloudSDKSettings();
+        const personalizeSettings = getEnabledPackage(PACKAGE_NAME)?.settings;
+        const browserId = getCookieValueClientSide(cloudSDKSettings.cookieSettings.name.browserId);
+        const guestId = getCookieValueClientSide(personalizeSettings.cookieSettings.name.guestId);
+        return new Personalizer(browserId, guestId).getInteractiveExperienceData(personalizeData, cloudSDKSettings, window.location.search, {
+            timeout: opts?.timeout
+        });
+    }
+    else {
+        const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0016);
+        const browserId = getBrowserId();
+        const guestId = getCookieValueClientSide(settings.cookieSettings.cookieNames.guestId);
+        return new Personalizer(browserId, guestId).getInteractiveExperienceData(personalizeData, settings, window.location.search, {
+            timeout: opts?.timeout
+        });
+    }
 }

package/dist/esm/src/lib/personalization/personalizeServer.d.ts

@@ -1,6 +1,6 @@
+import type { Request } from '@sitecore-cloudsdk/utils';
 import type { PersonalizeData } from './personalizer';
 import type { FailedCalledFlowsResponse } from './send-call-flows-request';
-import type { Request } from '@sitecore-cloudsdk/utils';
 /**
  * A function that executes an interactive experiment or web experiment over any web-based or mobile application.
  * @param request - The request object, either a Middleware Request or an HTTP Request

package/dist/esm/src/lib/personalization/personalizeServer.js

@@ -1,7 +1,8 @@
-import { getCookieValueFromRequest, getSettingsServer, handleGetSettingsError } from '@sitecore-cloudsdk/core';
-import { ErrorMessages } from '../consts';
-import { Personalizer } from './personalizer';
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { builderInstanceServer, getCloudSDKSettingsServer, getCookieValueFromRequest, getEnabledPackageServer, getSettingsServer, handleGetSettingsError } from '@sitecore-cloudsdk/core/internal';
 import { isNextJsMiddlewareRequest } from '@sitecore-cloudsdk/utils';
+import { ErrorMessages, PACKAGE_NAME } from '../consts';
+import { Personalizer } from './personalizer';
 /**
  * A function that executes an interactive experiment or web experiment over any web-based or mobile application.
  * @param request - The request object, either a Middleware Request or an HTTP Request
@@ -11,15 +12,26 @@ import { isNextJsMiddlewareRequest } from '@sitecore-cloudsdk/utils';
  * @returns A flow execution response
  */
 export function personalizeServer(request, personalizeData, opts) {
-    const settings = handleGetSettingsError(getSettingsServer, ErrorMessages.IE_0007);
-    const id = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.browserId);
-    const guestId = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.guestId);
     const requestUrl = new URL(request.url, `https://localhost`);
     const userAgent = isNextJsMiddlewareRequest(request)
         ? request.headers.get('user-agent')
         : request.headers['user-agent'];
     if (!personalizeData.geo && isNextJsMiddlewareRequest(request) && request.geo && Object.keys(request.geo).length)
         personalizeData.geo = request.geo;
+    let settings, id, guestId;
+    const personalizeSettings = getEnabledPackageServer(PACKAGE_NAME)?.settings;
+    if (builderInstanceServer) {
+        if (!getEnabledPackageServer(PACKAGE_NAME))
+            throw new Error(ErrorMessages.IE_0017);
+        settings = getCloudSDKSettingsServer();
+        id = getCookieValueFromRequest(request, settings.cookieSettings.name.browserId);
+        guestId = getCookieValueFromRequest(request, personalizeSettings.cookieSettings.name.guestId);
+    }
+    else {
+        settings = handleGetSettingsError(getSettingsServer, ErrorMessages.IE_0017);
+        id = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.browserId);
+        guestId = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.guestId);
+    }
     return new Personalizer(id, guestId).getInteractiveExperienceData(personalizeData, settings, requestUrl.search, {
         timeout: opts?.timeout,
         userAgent

package/dist/esm/src/lib/personalization/personalizer.d.ts

@@ -1,15 +1,15 @@
-import type { FailedCalledFlowsResponse } from './send-call-flows-request';
+import type { Settings } from '@sitecore-cloudsdk/core/internal';
 import type { NestedObject } from '@sitecore-cloudsdk/utils';
-import type { Settings } from '@sitecore-cloudsdk/core';
+import type { FailedCalledFlowsResponse } from './send-call-flows-request';
 export declare class Personalizer {
     private browserId;
-    private guestId;
+    private guestId?;
     /**
      * The Personalizer Class runs a flow of interactive experiments.
      * @param browserId - The browser id of the user
      * @param guestId - The guestRef of the user
      */
-    constructor(browserId: string, guestId: string);
+    constructor(browserId: string, guestId?: string | undefined);
     /**
      * A function to make a request to the Sitecore EP /callFlows API endpoint
      * @param personalizeData - The personalize input from the developer