@sitecore-content-sdk/personalize 2.0.0-canary.12

package/dist/cjs/src/initialization/server-adapter.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.personalizeServerAdapter = personalizeServerAdapter;
+const utils_1 = require("@sitecore-content-sdk/analytics-core/utils");
+const core_1 = require("@sitecore-content-sdk/core");
+const shared_1 = require("./shared");
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const internal_2 = require("@sitecore-content-sdk/analytics-core/internal");
+const fetch_profile_id_from_edge_proxy_1 = require("../profile-id/fetch-profile-id-from-edge-proxy");
+/**
+ * Creates a server-based personalize adapter that reads and writes the profile ID
+ * using cookies and can resolve a new profile ID from the Edge proxy when needed.
+ * The adapter also provides access user agent from the request headers.
+ * @template Request - The HTTP request type extending `IncomingMessage`.
+ * @template Response - The HTTP response type extending `OutgoingMessage`.
+ * @param {Request} request - The HTTP request object.
+ * @param {Response} response - The HTTP response object.
+ * @returns {PersonalizeServerAdapter} An PersonalizeServerAdapter instance.
+ * @public
+ */
+function personalizeServerAdapter(request, response) {
+    return {
+        type: 'server',
+        getUserAgent: () => request.headers['user-agent'],
+        getProfileId: () => getProfileId(request),
+        setProfileId: async () => {
+            var _a;
+            const coreConfig = (0, core_1.getCoreContext)().config;
+            const cookieOptions = (0, internal_2.getAnalyticsPlugin)().options.cookies;
+            const clientIdName = cookieOptions.name;
+            const personalizePlugin = (0, shared_1.getPersonalizePlugin)();
+            const profileIdName = personalizePlugin.options.cookies.name;
+            const legacyProfileIdCookieName = `${internal_1.COOKIE_NAME_PREFIX}${coreConfig.contextId}_personalize`;
+            const cookieAttributes = (0, internal_1.getDefaultCookieAttributes)(cookieOptions.expiryDays, cookieOptions.domain);
+            const legacyProfileIdCookie = (0, utils_1.getCookieServerSide)(request.headers.cookie, legacyProfileIdCookieName);
+            if (legacyProfileIdCookie) {
+                request.headers.cookie = (_a = request.headers.cookie) === null || _a === void 0 ? void 0 : _a.replace(legacyProfileIdCookie.name, profileIdName);
+                response.setHeader('Set-Cookie', [
+                    (0, utils_1.createCookieString)(profileIdName, legacyProfileIdCookie.value, cookieAttributes),
+                    (0, utils_1.createCookieString)(legacyProfileIdCookieName, '', Object.assign(Object.assign({}, cookieAttributes), { maxAge: 0 })),
+                ]);
+                return;
+            }
+            const cookiesValuesFromEdgeServer = (0, internal_2.getAnalyticsPlugin)().options.visitorIds;
+            const profileIdCookie = (0, utils_1.getCookieServerSide)(request.headers.cookie, profileIdName);
+            const clientIdCookie = (0, utils_1.getCookieServerSide)(request.headers.cookie, clientIdName);
+            let profileIdCookieString;
+            if (profileIdCookie)
+                profileIdCookieString = (0, utils_1.createCookieString)(profileIdName, profileIdCookie.value, cookieAttributes);
+            else if (cookiesValuesFromEdgeServer === null || cookiesValuesFromEdgeServer === void 0 ? void 0 : cookiesValuesFromEdgeServer.profileId)
+                profileIdCookieString = (0, utils_1.createCookieString)(profileIdName, cookiesValuesFromEdgeServer.profileId, cookieAttributes);
+            else if (clientIdCookie) {
+                const profileIdCookieValueFromEdgeProxy = await (0, fetch_profile_id_from_edge_proxy_1.fetchProfileIdFromEdgeProxy)(clientIdCookie.value, coreConfig.contextId, coreConfig.edgeUrl);
+                profileIdCookieString = (0, utils_1.createCookieString)(profileIdName, profileIdCookieValueFromEdgeProxy, cookieAttributes);
+            }
+            else
+                return;
+            if (!profileIdCookie)
+                request.headers.cookie = request.headers.cookie
+                    ? request.headers.cookie + '; ' + profileIdCookieString
+                    : profileIdCookieString;
+            let cookieHeader;
+            const currentSetCookieHeader = response.getHeader('Set-Cookie');
+            if (currentSetCookieHeader) {
+                if (Array.isArray(currentSetCookieHeader)) {
+                    cookieHeader = [...currentSetCookieHeader, profileIdCookieString];
+                }
+                else {
+                    cookieHeader = `${currentSetCookieHeader}; ${profileIdCookieString}`;
+                }
+            }
+            else {
+                cookieHeader = profileIdCookieString;
+            }
+            response.setHeader('Set-Cookie', cookieHeader);
+        },
+    };
+}
+/**
+ * Retrieves the profile ID from the request cookies.
+ * @template Request - The HTTP request type extending `IncomingMessage`.
+ * @param {Request} request
+ * @returns {string | null} The profile ID or null if not found.
+ * @internal
+ */
+function getProfileId(request) {
+    var _a, _b;
+    return ((_b = (_a = (0, utils_1.getCookieServerSide)(request.headers.cookie, (0, shared_1.getPersonalizePlugin)().options.cookies.name)) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : null);
+}

package/dist/cjs/src/initialization/shared.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPersonalizePlugin = getPersonalizePlugin;
+const core_1 = require("@sitecore-content-sdk/core");
+const const_1 = require("./const");
+const { ERROR_MESSAGES } = core_1.constants;
+/**
+ * Retrieves the personalize plugin instance from the core context.
+ * @returns {PersonalizePlugin} The personalize plugin instance.
+ * @internal
+ */
+function getPersonalizePlugin() {
+    const plugin = (0, core_1.getCoreContext)().plugins.get(const_1.PERSONALIZE_PLUGIN_NAME);
+    if (!plugin)
+        throw new Error(ERROR_MESSAGES.IE_004(const_1.PERSONALIZE_PLUGIN_NAME));
+    return plugin;
+}

package/dist/cjs/src/initialization/types.js

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

package/dist/cjs/src/internal.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PACKAGE_VERSION = exports.fetchProfileIdFromEdgeProxy = exports.PERSONALIZE_PLUGIN_NAME = exports.getPersonalizePlugin = void 0;
+var shared_1 = require("./initialization/shared");
+Object.defineProperty(exports, "getPersonalizePlugin", { enumerable: true, get: function () { return shared_1.getPersonalizePlugin; } });
+var const_1 = require("./initialization/const");
+Object.defineProperty(exports, "PERSONALIZE_PLUGIN_NAME", { enumerable: true, get: function () { return const_1.PERSONALIZE_PLUGIN_NAME; } });
+var fetch_profile_id_from_edge_proxy_1 = require("./profile-id/fetch-profile-id-from-edge-proxy");
+Object.defineProperty(exports, "fetchProfileIdFromEdgeProxy", { enumerable: true, get: function () { return fetch_profile_id_from_edge_proxy_1.fetchProfileIdFromEdgeProxy; } });
+var consts_1 = require("./consts");
+Object.defineProperty(exports, "PACKAGE_VERSION", { enumerable: true, get: function () { return consts_1.PACKAGE_VERSION; } });

package/dist/cjs/src/personalization/personalize.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.personalize = personalize;
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const personalizer_1 = require("./personalizer");
+const core_1 = require("@sitecore-content-sdk/core");
+const shared_1 = require("../initialization/shared");
+/**
+ * A function that executes an interactive/web experiment over any web-based/mobile application.
+ * @param {PersonalizeData} personalizeData - The required/optional attributes for a flow execution.
+ * @param {PersonalizeOpts} opts - An object containing additional options.
+ * @returns {Promise<unknown | null | FailedCalledFlowsResponse>} A flow execution response.
+ * @public
+ */
+async function personalize(personalizeData, opts) {
+    var _a;
+    const { config, readyPromise } = (0, core_1.getCoreContext)();
+    await readyPromise;
+    const { adapter: personalizeAdapter } = (0, shared_1.getPersonalizePlugin)();
+    const { adapter: analyticsAdapter } = (0, internal_1.getAnalyticsPlugin)();
+    const clientId = analyticsAdapter.getClientId() || '';
+    const profileId = personalizeAdapter.getProfileId() || '';
+    const searchParams = analyticsAdapter.location.getSearchParams();
+    const userAgent = (_a = personalizeAdapter.getUserAgent) === null || _a === void 0 ? void 0 : _a.call(personalizeAdapter);
+    return new personalizer_1.Personalizer(clientId, profileId).getInteractiveExperienceData(personalizeData, config, searchParams, {
+        userAgent,
+        timeout: opts === null || opts === void 0 ? void 0 : opts.timeout,
+    });
+}

package/dist/cjs/src/personalization/personalizer.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Personalizer = void 0;
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const consts_1 = require("../consts");
+const send_call_flows_request_1 = require("./send-call-flows-request");
+const core_1 = require("@sitecore-content-sdk/core");
+const { ERROR_MESSAGES } = core_1.constants;
+/**
+ * The Personalizer Class runs a flow of interactive experiments.
+ * @internal
+ */
+class Personalizer {
+    /**
+     * The Personalizer Class runs a flow of interactive experiments.
+     * @param {string} clientId - The client id of the user
+     * @param {string} [profileId] - The profile id of the user
+     */
+    constructor(clientId, profileId) {
+        this.clientId = clientId;
+        this.profileId = profileId;
+    }
+    /**
+     * A function to make a request to the Sitecore Edge Proxy `/callFlows` API endpoint
+     * @param {PersonalizeData} personalizeData - The personalize input from the developer
+     * @param {CoreContext['config']} config - The configuration that was set during initialization
+     * @param {string} searchParams - The URL search parameters
+     * @param {GetInteractiveExperienceDataOpts} opts - Optional object that contains options for timeout and User Agent
+     * @returns {Promise<unknown | null | FailedCalledFlowsResponse>} A promise that resolves with either the Sitecore Edge Proxy response object or null
+     */
+    async getInteractiveExperienceData(personalizeData, config, searchParams, opts) {
+        var _a;
+        this.validate(personalizeData);
+        const sanitizedInput = this.sanitizeInput(personalizeData);
+        if (searchParams.includes(consts_1.UTM_PREFIX) && !((_a = sanitizedInput.params) === null || _a === void 0 ? void 0 : _a.utm)) {
+            sanitizedInput.params = sanitizedInput.params || {};
+            sanitizedInput.params.utm = this.extractUrlParamsWithPrefix(searchParams, consts_1.UTM_PREFIX);
+        }
+        const mappedData = this.mapPersonalizeInputToEPData(sanitizedInput);
+        if (!mappedData.email && !mappedData.identifiers)
+            mappedData.browserId = this.clientId;
+        return await (0, send_call_flows_request_1.sendCallFlowsRequest)(mappedData, config, opts);
+    }
+    /**
+     * A function that sanitizes the personalize input data
+     * @param {PersonalizeData} personalizeData - The personalize input data to sanitize
+     * @returns {PersonalizeData} The sanitized object
+     */
+    sanitizeInput(personalizeData) {
+        var _a;
+        const sanitizedData = {
+            channel: personalizeData.channel,
+            currency: personalizeData.currency,
+            friendlyId: personalizeData.friendlyId,
+            language: personalizeData.language,
+        };
+        if (personalizeData.identifier &&
+            personalizeData.identifier.id &&
+            personalizeData.identifier.id.trim().length > 0)
+            sanitizedData.identifier = personalizeData.identifier;
+        if (personalizeData.email && personalizeData.email.trim().length > 0)
+            sanitizedData.email = personalizeData.email;
+        if (personalizeData.params && Object.keys(personalizeData.params).length > 0)
+            sanitizedData.params = personalizeData.params;
+        if (personalizeData.geo && Object.keys(personalizeData.geo).length > 0)
+            sanitizedData.params = Object.assign(Object.assign({}, personalizeData.params), { geo: Object.assign({}, personalizeData.geo) });
+        if ((_a = personalizeData.pageVariantIds) === null || _a === void 0 ? void 0 : _a.length)
+            sanitizedData.pageVariantIds = personalizeData.pageVariantIds;
+        return sanitizedData;
+    }
+    /**
+     * A function that maps the personalize input data with the Edge Proxy
+     * @param {PersonalizeData} input - The personalize input data to map
+     * @returns {EPCallFlowsBody} The Edge Proxy object
+     */
+    mapPersonalizeInputToEPData(input) {
+        var _a;
+        const mappedData = {
+            channel: input.channel,
+            clientKey: '',
+            currencyCode: input.currency,
+            email: input.email,
+            friendlyId: input.friendlyId,
+            guestRef: this.profileId,
+            identifiers: input.identifier,
+            language: (_a = input.language) !== null && _a !== void 0 ? _a : (0, internal_1.language)(),
+            params: input.params,
+            pointOfSale: '',
+            variants: input.pageVariantIds,
+        };
+        return mappedData;
+    }
+    /**
+     * A validation method to throw error for the mandatory property for runtime users
+     * @param {PersonalizeData} params - The personalize data object
+     */
+    validate(params) {
+        if (!params.friendlyId || params.friendlyId.trim().length === 0)
+            throw new Error(ERROR_MESSAGES.MV_004);
+    }
+    /**
+     * Retrieves UTM parameters from the url query string e.g. `utm_test1=123&utm_test2=456`
+     * @param {string} urlParams - The url params passed
+     * @param {string} prefix - The prefix we want to extract from the params
+     * @returns {{ [key: string]: string }} An object containing the UTM parameters (if they exist) in the form: `utm: {test1: 123, test2: 456}`
+     */
+    extractUrlParamsWithPrefix(urlParams, prefix) {
+        const urlSearchParams = new URLSearchParams(decodeURI(urlParams));
+        const extractedParams = {};
+        urlSearchParams.forEach((value, key) => {
+            const paramKey = key.toLowerCase();
+            if (paramKey.indexOf(prefix) === 0) {
+                const paramName = paramKey.substring(prefix.length);
+                extractedParams[paramName] = value;
+            }
+        });
+        return extractedParams;
+    }
+}
+exports.Personalizer = Personalizer;

package/dist/cjs/src/personalization/send-call-flows-request.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendCallFlowsRequest = sendCallFlowsRequest;
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const consts_1 = require("../consts");
+const core_1 = require("@sitecore-content-sdk/core");
+const debug_1 = require("../debug");
+const { ERROR_MESSAGES } = core_1.constants;
+/**
+ * A function that sends a CallFlow request to Sitecore Edge Proxy
+ * @param {EPCallFlowsBody} epCallFlowsBody - Properties to be sent to Sitecore Edge Proxy
+ * @param {CoreContext['config']} config - Configuration for the url params
+ * @param {GetInteractiveExperienceDataOpts} opts - Optional configuration object
+ * @returns {Promise<unknown | null | FailedCalledFlowsResponse>} A promise that resolves with either the Sitecore Edge Proxy response object or unknown
+ * @internal
+ */
+async function sendCallFlowsRequest(epCallFlowsBody, config, opts) {
+    // eslint-disable-next-line max-len
+    const requestUrl = `${config.edgeUrl}/v1/personalize?siteId=${config.siteName}`;
+    const fetchOptions = {
+        body: JSON.stringify(epCallFlowsBody),
+        headers: {
+            /* eslint-disable @typescript-eslint/naming-convention */
+            'Content-Type': 'application/json',
+            'X-Library-Version': consts_1.PACKAGE_VERSION,
+            'x-sc-correlation-id': (0, internal_1.generateCorrelationId)(),
+            'x-sitecore-contextid': config.contextId,
+            /* eslint-enable @typescript-eslint/naming-convention */
+        },
+        method: 'POST',
+    };
+    if (opts === null || opts === void 0 ? void 0 : opts.userAgent)
+        fetchOptions.headers['User-Agent'] = opts.userAgent;
+    const fetcher = new core_1.NativeDataFetcher({ timeout: opts === null || opts === void 0 ? void 0 : opts.timeout, debugger: debug_1.debug.personalize });
+    return fetcher
+        .fetch(requestUrl, fetchOptions)
+        .then((response) => {
+        if (!response)
+            return null;
+        return response.data;
+    })
+        .catch((error) => {
+        if (error.message.includes(ERROR_MESSAGES.IV_002) || error.message.includes(ERROR_MESSAGES.IE_003))
+            throw new Error(error.message);
+        return null;
+    });
+}

package/dist/cjs/src/profile-id/fetch-profile-id-from-edge-proxy.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchProfileIdFromEdgeProxy = fetchProfileIdFromEdgeProxy;
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const consts_1 = require("../consts");
+const core_1 = require("@sitecore-content-sdk/core");
+const { ERROR_MESSAGES } = core_1.constants;
+/**
+ * Gets the profile id from Edge Proxy.
+ * @param {string} clientId - The client ID of the client.
+ * @param {string} contextId - The Sitecore Edge context ID.
+ * @param {string} edgeUrl - The Sitecore Edge base URL.
+ * @returns {Promise<string>} A promise that resolves with the profile id.
+ * @throws Will throw an error if the client key or client ID is invalid.
+ * @internal
+ */
+async function fetchProfileIdFromEdgeProxy(clientId, contextId, edgeUrl) {
+    // eslint-disable-next-line max-len
+    const url = `${edgeUrl}/v1/events/${internal_1.API_VERSION}/browser/${clientId}/show.json?client_key=&api_token=`;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    const response = await fetch(url, {
+        headers: {
+            'X-Library-Version': consts_1.PACKAGE_VERSION,
+            'x-sitecore-contextid': contextId,
+        },
+    });
+    const data = await response.json();
+    if (!response.ok) {
+        const { error_msg: errorMsg, moreInfo } = data;
+        throw new Error(`${errorMsg}, for more info: ${moreInfo}`);
+    }
+    if (!data.customer.ref)
+        throw new Error(ERROR_MESSAGES.IE_006);
+    return data.customer.ref;
+}

package/dist/cjs/src/web-personalization/get-cdn-url.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCdnUrl = getCdnUrl;
+/**
+ * Retrieves the CDN URL for web personalization
+ * @param {string} contextId - The Sitecore Edge context ID
+ * @param {string} edgeUrl - The Sitecore Edge URL
+ * @returns {Promise<string | null>} The CDN URL or null if unavailable
+ * @internal
+ */
+async function getCdnUrl(contextId, edgeUrl) {
+    const requestUrl = `${edgeUrl}/v1/personalize/cdn-url?client_key=`;
+    try {
+        const response = await fetch(requestUrl, {
+            headers: {
+                'x-sitecore-contextid': contextId,
+            },
+        });
+        if (!response.ok)
+            return null;
+        return await response.text();
+        // eslint-disable-next-line no-unused-vars
+    }
+    catch (error) {
+        return null;
+    }
+}

package/dist/esm/package.json

@@ -0,0 +1,75 @@
+{
+    "author": {
+        "name": "Sitecore Corporation",
+        "url": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html"
+    },
+    "bugs": {
+        "url": "https://github.com/sitecore/content-sdk/issues"
+    },
+    "dependencies": {
+        "@sitecore-content-sdk/analytics-core": "2.0.0-canary.12",
+        "@sitecore-content-sdk/core": "2.0.0-canary.12",
+        "@sitecore-content-sdk/events": "2.0.0-canary.12",
+        "debug": "^4.4.3"
+    },
+    "description": "Provides personalization capabilities to build tailored experiences for site visitors.",
+    "devDependencies": {
+        "@jest/types": "^29.6.3",
+        "@stylistic/eslint-plugin": "^5.2.2",
+        "@types/debug": "^4.1.12",
+        "@types/jest": "^29.5.12",
+        "@typescript-eslint/eslint-plugin": "8.39.0",
+        "@typescript-eslint/parser": "8.39.0",
+        "del-cli": "^6.0.0",
+        "eslint": "^9.32.0",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-import": "2.32.0",
+        "eslint-plugin-jsdoc": "52.0.3",
+        "eslint-plugin-prettier": "^4.0.0",
+        "jest": "^29.7.0",
+        "jest-environment-jsdom": "^29.7.0",
+        "jest-environment-node": "^29.7.0",
+        "ts-jest": "^29.1.0",
+        "ts-node": "^10.9.2"
+    },
+    "main": "dist/cjs/src/index.js",
+    "module": "dist/esm/src/index.js",
+    "types": "types/src/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/esm/src/index.js",
+            "require": "./dist/cjs/src/index.js",
+            "types": "./types/src/index.d.ts"
+        },
+        "./internal": {
+            "import": "./dist/esm/src/internal.js",
+            "require": "./dist/cjs/src/internal.js",
+            "types": "./types/src/internal.d.ts"
+        }
+    },
+    "files": [
+        "dist",
+        "types",
+        "/*.d.ts"
+    ],
+    "homepage": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html",
+    "license": "Apache-2.0",
+    "name": "@sitecore-content-sdk/personalize",
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "scripts": {
+        "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
+        "clean": "del-cli dist types",
+        "coverage": "jest --config jest.config.ts --coverage",
+        "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/personalize --entryPoints src/internal.ts --entryPoints src/index.ts --githubPages false",
+        "lint": "eslint \"./src/**/*.ts\"",
+        "prepublishOnly": "npm run build",
+        "test": "jest --config jest.config.ts",
+        "api-extractor": "npm run build && api-extractor run --local --verbose",
+        "api-extractor:verify": "api-extractor run"
+    },
+    "version": "2.0.0-canary.12",
+    "gitHead": "4a26005860f4931f25d8c63d765a030e04a5b1f4"
+}

package/dist/esm/src/consts.js

@@ -0,0 +1,8 @@
+import packageJson from '../package.json';
+/**
+ * The package version.
+ * @internal
+ */
+export const PACKAGE_VERSION = packageJson.version;
+export const PACKAGE_NAME = packageJson.name;
+export const UTM_PREFIX = 'utm_';

package/dist/esm/src/debug.js

@@ -0,0 +1,9 @@
+import { debugNamespace, debugModule } from '@sitecore-content-sdk/core';
+export const PERSONALIZE_NAMESPACE = 'personalize';
+/**
+ * Debug module for personalize package
+ * @public
+ */
+export const debug = {
+    personalize: debugModule(`${debugNamespace}:${PERSONALIZE_NAMESPACE}`),
+};

package/dist/esm/src/index.js

@@ -0,0 +1,5 @@
+export { personalize } from './personalization/personalize';
+export { personalizeServerPlugin } from './initialization/plugin-server';
+export { personalizeServerAdapter } from './initialization/server-adapter';
+export { personalizeBrowserPlugin } from './initialization/plugin-browser';
+export { personalizeBrowserAdapter } from './initialization/browser-adapter';

package/dist/esm/src/initialization/browser-adapter.js

@@ -0,0 +1,45 @@
+import { createCookieString, getCookieValueClientSide, } from '@sitecore-content-sdk/analytics-core/utils';
+import { getCoreContext } from '@sitecore-content-sdk/core';
+import { getPersonalizePlugin } from './shared';
+import { COOKIE_NAME_PREFIX, getDefaultCookieAttributes, } from '@sitecore-content-sdk/analytics-core/internal';
+import { getAnalyticsPlugin } from '@sitecore-content-sdk/analytics-core/internal';
+import { fetchProfileIdFromEdgeProxy } from '../profile-id/fetch-profile-id-from-edge-proxy';
+/**
+ * Creates a browser-based personalize adapter that reads and writes the profile ID
+ * using cookies and can resolve a new profile ID from the Edge proxy when needed.
+ * @returns {PersonalizeBrowserAdapter} An PersonalizeBrowserAdapter instance.
+ * @public
+ */
+export function personalizeBrowserAdapter() {
+    return {
+        type: 'browser',
+        getProfileId: () => {
+            return getCookieValueClientSide(getPersonalizePlugin().options.cookies.name);
+        },
+        setProfileId: async () => {
+            const coreConfig = getCoreContext().config;
+            const analyticsOptions = getAnalyticsPlugin().options;
+            const personalizePlugin = getPersonalizePlugin();
+            const profileIdCookieName = personalizePlugin.options.cookies.name;
+            const legacyProfileIdCookieName = `${COOKIE_NAME_PREFIX}${coreConfig.contextId}_personalize`;
+            const cookieAttributes = getDefaultCookieAttributes(analyticsOptions.cookies.expiryDays, analyticsOptions.cookies.domain);
+            const legacyProfileIdCookie = getCookieValueClientSide(legacyProfileIdCookieName);
+            if (legacyProfileIdCookie) {
+                document.cookie = createCookieString(profileIdCookieName, legacyProfileIdCookie, cookieAttributes);
+                document.cookie = createCookieString(legacyProfileIdCookieName, '', Object.assign(Object.assign({}, cookieAttributes), { maxAge: 0 }));
+                return;
+            }
+            const cookiesValuesFromEdgeBrowser = getAnalyticsPlugin().options.visitorIds;
+            const profileIdCookieValue = getCookieValueClientSide(profileIdCookieName);
+            const clientIdCookieValue = getCookieValueClientSide(analyticsOptions.cookies.name);
+            if (profileIdCookieValue)
+                return;
+            else if (cookiesValuesFromEdgeBrowser === null || cookiesValuesFromEdgeBrowser === void 0 ? void 0 : cookiesValuesFromEdgeBrowser.profileId)
+                document.cookie = createCookieString(profileIdCookieName, cookiesValuesFromEdgeBrowser.profileId, cookieAttributes);
+            else if (clientIdCookieValue) {
+                const profileIdCookieValue = await fetchProfileIdFromEdgeProxy(clientIdCookieValue, coreConfig.contextId, coreConfig.edgeUrl);
+                document.cookie = createCookieString(profileIdCookieName, profileIdCookieValue, cookieAttributes);
+            }
+        },
+    };
+}

package/dist/esm/src/initialization/const.js

@@ -0,0 +1,5 @@
+/**
+ * The name of the Personalize plugin.
+ * @public
+ */
+export const PERSONALIZE_PLUGIN_NAME = 'PersonalizePlugin';

package/dist/esm/src/initialization/get-profile-id.js

@@ -0,0 +1,14 @@
+import { getAnalyticsPlugin } from '@sitecore-content-sdk/analytics-core/internal';
+import { fetchProfileIdFromEdgeProxy } from '../profile-id/fetch-profile-id-from-edge-proxy';
+import { getCoreContext } from '@sitecore-content-sdk/core';
+/**
+ * Returns the profile ID.
+ * @returns {Promise<string>} A promise that resolves with the profile ID.
+ * @throws If the Sitecore Edge context ID is incorrect.
+ * @internal
+ */
+export async function getProfileId() {
+    const { config } = getCoreContext();
+    const clientId = getAnalyticsPlugin().adapter.getClientId() || '';
+    return fetchProfileIdFromEdgeProxy(clientId, config.contextId, config.edgeUrl);
+}

package/dist/esm/src/initialization/plugin-browser.js

@@ -0,0 +1,79 @@
+import { PERSONALIZE_PLUGIN_NAME } from './const';
+import { PACKAGE_VERSION } from '../consts';
+import { CLIENT_ID_COOKIE_NAME, COOKIE_NAME_PREFIX, } from '@sitecore-content-sdk/analytics-core/internal';
+import { EVENTS_PLUGIN_NAME } from '@sitecore-content-sdk/events/internal';
+import { getCoreContext } from '@sitecore-content-sdk/core';
+import { getCdnUrl } from '../web-personalization/get-cdn-url';
+import { appendScriptWithAttributes } from '@sitecore-content-sdk/analytics-core/utils';
+import { getPersonalizePlugin } from './shared';
+import { ANALYTICS_PLUGIN_NAME, getAnalyticsPlugin, } from '@sitecore-content-sdk/analytics-core/internal';
+import { getProfileId } from './get-profile-id';
+import { personalize } from '../personalization/personalize';
+/**
+ * Initializes the personalize plugin with the provided options.
+ * @internal
+ */
+async function init() {
+    var _a;
+    const coreConfig = getCoreContext().config;
+    const personalizePlugin = getPersonalizePlugin();
+    const personalizeOptions = personalizePlugin.options;
+    const analyticsPlugin = getAnalyticsPlugin();
+    if (analyticsPlugin.options.cookies.enabled &&
+        personalizeOptions.cookies.enabled &&
+        (!personalizePlugin.adapter.getProfileId() || personalizePlugin.adapter.type !== 'browser'))
+        await personalizePlugin.adapter.setProfileId();
+    if (typeof window === 'undefined')
+        return;
+    window.scContentSDK = Object.assign(Object.assign({}, window.scContentSDK), { personalize: {
+            personalize,
+            version: PACKAGE_VERSION,
+            options: personalizeOptions.webPersonalization ? personalizeOptions.webPersonalization : {},
+        }, analytics_core: Object.assign(Object.assign({}, (_a = window.scContentSDK) === null || _a === void 0 ? void 0 : _a.analytics_core), { getProfileId }) });
+    if (!personalizeOptions.webPersonalization)
+        return;
+    window.scContentSDK.personalize.options = personalizeOptions.webPersonalization;
+    const cdnUrl = await getCdnUrl(coreConfig.contextId, coreConfig.edgeUrl);
+    if (!cdnUrl)
+        return;
+    appendScriptWithAttributes({
+        async: personalizeOptions.webPersonalization.async,
+        src: cdnUrl,
+    });
+}
+/**
+ * Creates a personalize browser plugin with the provided adapter and options.
+ * @param {PersonalizeBrowserPluginParams} params - The personalize plugin parameters including adapter and options.
+ * @returns {PersonalizeBrowserPlugin} The configured personalize browser plugin.
+ * @public
+ */
+export function personalizeBrowserPlugin(params) {
+    var _a, _b, _c, _d;
+    const { adapter, options } = params;
+    const cookies = {
+        enabled: (_a = options === null || options === void 0 ? void 0 : options.enablePersonalizeCookie) !== null && _a !== void 0 ? _a : false,
+        name: `${COOKIE_NAME_PREFIX}${CLIENT_ID_COOKIE_NAME}_personalize`,
+    };
+    const dependencies = [ANALYTICS_PLUGIN_NAME];
+    let webPersonalization;
+    if (options === null || options === void 0 ? void 0 : options.webPersonalization) {
+        dependencies.push(EVENTS_PLUGIN_NAME);
+        webPersonalization = {
+            async: (_b = options.webPersonalization.async) !== null && _b !== void 0 ? _b : true,
+            defer: (_c = options.webPersonalization.defer) !== null && _c !== void 0 ? _c : false,
+            language: (_d = options.webPersonalization.language) !== null && _d !== void 0 ? _d : undefined,
+        };
+    }
+    webPersonalization !== null && webPersonalization !== void 0 ? webPersonalization : (webPersonalization = false);
+    const resolvedOptions = {
+        webPersonalization,
+        cookies,
+    };
+    return {
+        name: PERSONALIZE_PLUGIN_NAME,
+        init,
+        dependencies,
+        options: resolvedOptions,
+        adapter,
+    };
+}