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

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

@@ -0,0 +1,40 @@
+import { PERSONALIZE_PLUGIN_NAME } from './const';
+import { CLIENT_ID_COOKIE_NAME, COOKIE_NAME_PREFIX, } from '@sitecore-content-sdk/analytics-core/internal';
+import { getPersonalizePlugin } from './shared';
+import { ANALYTICS_PLUGIN_NAME, getAnalyticsPlugin, } from '@sitecore-content-sdk/analytics-core/internal';
+/**
+ * Initializes the personalize plugin with the provided options.
+ * @internal
+ */
+async function init() {
+    const personalizePlugin = getPersonalizePlugin();
+    const personalizeOptions = personalizePlugin.options;
+    const analyticsPlugin = getAnalyticsPlugin();
+    if (analyticsPlugin.options.cookies.enabled && personalizeOptions.cookies.enabled)
+        await personalizePlugin.adapter.setProfileId();
+}
+/**
+ * Creates a personalize server plugin with the provided options.
+ * @param {PersonalizeServerPluginParams} params - The parameters for the personalize plugin.
+ * @returns {PersonalizeServerPlugin} The personalize plugin instance.
+ * @public
+ */
+export function personalizeServerPlugin(params) {
+    var _a;
+    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];
+    const resolvedOptions = {
+        cookies,
+    };
+    return {
+        name: PERSONALIZE_PLUGIN_NAME,
+        init,
+        dependencies,
+        options: resolvedOptions,
+        adapter,
+    };
+}

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

@@ -0,0 +1,86 @@
+import { createCookieString, getCookieServerSide, } 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 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
+ */
+export function personalizeServerAdapter(request, response) {
+    return {
+        type: 'server',
+        getUserAgent: () => request.headers['user-agent'],
+        getProfileId: () => getProfileId(request),
+        setProfileId: async () => {
+            var _a;
+            const coreConfig = getCoreContext().config;
+            const cookieOptions = getAnalyticsPlugin().options.cookies;
+            const clientIdName = cookieOptions.name;
+            const personalizePlugin = getPersonalizePlugin();
+            const profileIdName = personalizePlugin.options.cookies.name;
+            const legacyProfileIdCookieName = `${COOKIE_NAME_PREFIX}${coreConfig.contextId}_personalize`;
+            const cookieAttributes = getDefaultCookieAttributes(cookieOptions.expiryDays, cookieOptions.domain);
+            const legacyProfileIdCookie = 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', [
+                    createCookieString(profileIdName, legacyProfileIdCookie.value, cookieAttributes),
+                    createCookieString(legacyProfileIdCookieName, '', Object.assign(Object.assign({}, cookieAttributes), { maxAge: 0 })),
+                ]);
+                return;
+            }
+            const cookiesValuesFromEdgeServer = getAnalyticsPlugin().options.visitorIds;
+            const profileIdCookie = getCookieServerSide(request.headers.cookie, profileIdName);
+            const clientIdCookie = getCookieServerSide(request.headers.cookie, clientIdName);
+            let profileIdCookieString;
+            if (profileIdCookie)
+                profileIdCookieString = createCookieString(profileIdName, profileIdCookie.value, cookieAttributes);
+            else if (cookiesValuesFromEdgeServer === null || cookiesValuesFromEdgeServer === void 0 ? void 0 : cookiesValuesFromEdgeServer.profileId)
+                profileIdCookieString = createCookieString(profileIdName, cookiesValuesFromEdgeServer.profileId, cookieAttributes);
+            else if (clientIdCookie) {
+                const profileIdCookieValueFromEdgeProxy = await fetchProfileIdFromEdgeProxy(clientIdCookie.value, coreConfig.contextId, coreConfig.edgeUrl);
+                profileIdCookieString = 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 = getCookieServerSide(request.headers.cookie, getPersonalizePlugin().options.cookies.name)) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : null);
+}

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

@@ -0,0 +1,14 @@
+import { getCoreContext, constants } from '@sitecore-content-sdk/core';
+import { PERSONALIZE_PLUGIN_NAME } from './const';
+const { ERROR_MESSAGES } = constants;
+/**
+ * Retrieves the personalize plugin instance from the core context.
+ * @returns {PersonalizePlugin} The personalize plugin instance.
+ * @internal
+ */
+export function getPersonalizePlugin() {
+    const plugin = getCoreContext().plugins.get(PERSONALIZE_PLUGIN_NAME);
+    if (!plugin)
+        throw new Error(ERROR_MESSAGES.IE_004(PERSONALIZE_PLUGIN_NAME));
+    return plugin;
+}

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

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

package/dist/esm/src/internal.js

@@ -0,0 +1,4 @@
+export { getPersonalizePlugin } from './initialization/shared';
+export { PERSONALIZE_PLUGIN_NAME } from './initialization/const';
+export { fetchProfileIdFromEdgeProxy } from './profile-id/fetch-profile-id-from-edge-proxy';
+export { PACKAGE_VERSION } from './consts';

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

@@ -0,0 +1,26 @@
+import { getAnalyticsPlugin } from '@sitecore-content-sdk/analytics-core/internal';
+import { Personalizer } from './personalizer';
+import { getCoreContext } from '@sitecore-content-sdk/core';
+import { getPersonalizePlugin } from '../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
+ */
+export async function personalize(personalizeData, opts) {
+    var _a;
+    const { config, readyPromise } = getCoreContext();
+    await readyPromise;
+    const { adapter: personalizeAdapter } = getPersonalizePlugin();
+    const { adapter: analyticsAdapter } = 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(clientId, profileId).getInteractiveExperienceData(personalizeData, config, searchParams, {
+        userAgent,
+        timeout: opts === null || opts === void 0 ? void 0 : opts.timeout,
+    });
+}

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

@@ -0,0 +1,116 @@
+import { language } from '@sitecore-content-sdk/analytics-core/internal';
+import { UTM_PREFIX } from '../consts';
+import { sendCallFlowsRequest } from './send-call-flows-request';
+import { constants } from '@sitecore-content-sdk/core';
+const { ERROR_MESSAGES } = constants;
+/**
+ * The Personalizer Class runs a flow of interactive experiments.
+ * @internal
+ */
+export 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(UTM_PREFIX) && !((_a = sanitizedInput.params) === null || _a === void 0 ? void 0 : _a.utm)) {
+            sanitizedInput.params = sanitizedInput.params || {};
+            sanitizedInput.params.utm = this.extractUrlParamsWithPrefix(searchParams, UTM_PREFIX);
+        }
+        const mappedData = this.mapPersonalizeInputToEPData(sanitizedInput);
+        if (!mappedData.email && !mappedData.identifiers)
+            mappedData.browserId = this.clientId;
+        return await 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 : 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;
+    }
+}

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

@@ -0,0 +1,44 @@
+import { generateCorrelationId } from '@sitecore-content-sdk/analytics-core/internal';
+import { PACKAGE_VERSION } from '../consts';
+import { NativeDataFetcher, constants } from '@sitecore-content-sdk/core';
+import { debug } from '../debug';
+const { ERROR_MESSAGES } = 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
+ */
+export 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': PACKAGE_VERSION,
+            'x-sc-correlation-id': 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 NativeDataFetcher({ timeout: opts === null || opts === void 0 ? void 0 : opts.timeout, debugger: 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/esm/src/profile-id/fetch-profile-id-from-edge-proxy.js

@@ -0,0 +1,32 @@
+import { API_VERSION } from '@sitecore-content-sdk/analytics-core/internal';
+import { PACKAGE_VERSION } from '../consts';
+import { constants } from '@sitecore-content-sdk/core';
+const { ERROR_MESSAGES } = 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
+ */
+export async function fetchProfileIdFromEdgeProxy(clientId, contextId, edgeUrl) {
+    // eslint-disable-next-line max-len
+    const url = `${edgeUrl}/v1/events/${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': 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/esm/src/web-personalization/get-cdn-url.js

@@ -0,0 +1,24 @@
+/**
+ * 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
+ */
+export 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/internal.d.ts

@@ -0,0 +1 @@
+export * from './types/src/internal';

package/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/types/src/consts.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The package version.
+ * @internal
+ */
+export declare const PACKAGE_VERSION: string;
+export declare const PACKAGE_NAME: string;
+export declare const UTM_PREFIX = "utm_";
+//# sourceMappingURL=consts.d.ts.map

package/types/src/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../src/consts.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAsB,CAAC;AACnD,eAAO,MAAM,YAAY,QAAmB,CAAC;AAC7C,eAAO,MAAM,UAAU,SAAS,CAAC"}

package/types/src/debug.d.ts

@@ -0,0 +1,9 @@
+export declare const PERSONALIZE_NAMESPACE = "personalize";
+/**
+ * Debug module for personalize package
+ * @public
+ */
+export declare const debug: {
+    personalize: import("debug").Debugger;
+};
+//# sourceMappingURL=debug.d.ts.map

package/types/src/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/debug.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,qBAAqB,gBAAgB,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,KAAK;;CAEjB,CAAC"}

package/types/src/index.d.ts

@@ -0,0 +1,15 @@
+export type { PersonalizeData, PersonalizeGeolocation, PersonalizeIdentifierInput, PersonalizeInputParams, } from './personalization/personalizer';
+export type { FailedCalledFlowsResponse } from './personalization/send-call-flows-request';
+export { personalize, type PersonalizeOpts } from './personalization/personalize';
+export type { PersonalizeServerPluginParams } from './initialization/plugin-server';
+export { personalizeServerPlugin } from './initialization/plugin-server';
+export type { PersonalizeServerAdapter } from './initialization/server-adapter';
+export type { PersonalizeServerPlugin } from './initialization/types';
+export { personalizeServerAdapter } from './initialization/server-adapter';
+export type { PersonalizeBrowserPluginParams } from './initialization/plugin-browser';
+export { personalizeBrowserPlugin } from './initialization/plugin-browser';
+export type { PersonalizeBrowserAdapter } from './initialization/browser-adapter';
+export type { PersonalizeBrowserPlugin } from './initialization/types';
+export { personalizeBrowserAdapter } from './initialization/browser-adapter';
+export type { WebPersonalizationOptions, PersonalizePluginOptions, PersonalizeServerPluginOptions, } from './initialization/types';
+//# sourceMappingURL=index.d.ts.map

package/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,eAAe,EACf,sBAAsB,EACtB,0BAA0B,EAC1B,sBAAsB,GACvB,MAAM,gCAAgC,CAAC;AACxC,YAAY,EAAE,yBAAyB,EAAE,MAAM,2CAA2C,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAElF,YAAY,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAChF,YAAY,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,YAAY,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAClF,YAAY,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAE7E,YAAY,EACV,yBAAyB,EACzB,wBAAwB,EACxB,8BAA8B,GAC/B,MAAM,wBAAwB,CAAC"}

package/types/src/initialization/browser-adapter.d.ts

@@ -0,0 +1,19 @@
+import { PersonalizeAdapter } from './types';
+/**
+ * Defines the PersonalizeBrowserAdapter.
+ * @public
+ */
+export interface PersonalizeBrowserAdapter extends PersonalizeAdapter {
+    /**
+     * The type of the adapter.
+     */
+    type: 'browser';
+}
+/**
+ * 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 declare function personalizeBrowserAdapter(): PersonalizeBrowserAdapter;
+//# sourceMappingURL=browser-adapter.d.ts.map

package/types/src/initialization/browser-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-adapter.d.ts","sourceRoot":"","sources":["../../../src/initialization/browser-adapter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAU7C;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;IACnE;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,yBAAyB,CA6DrE"}

package/types/src/initialization/const.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The name of the Personalize plugin.
+ * @public
+ */
+export declare const PERSONALIZE_PLUGIN_NAME = "PersonalizePlugin";
+//# sourceMappingURL=const.d.ts.map

package/types/src/initialization/const.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"const.d.ts","sourceRoot":"","sources":["../../../src/initialization/const.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,uBAAuB,sBAAsB,CAAC"}

package/types/src/initialization/get-profile-id.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 declare function getProfileId(): Promise<string>;
+//# sourceMappingURL=get-profile-id.d.ts.map

package/types/src/initialization/get-profile-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-profile-id.d.ts","sourceRoot":"","sources":["../../../src/initialization/get-profile-id.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,wBAAsB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAMpD"}

package/types/src/initialization/plugin-browser.d.ts

@@ -0,0 +1,37 @@
+import { PersonalizeBrowserPlugin, PersonalizeAdapter, PersonalizePluginOptions, WebPersonalizationOptions } from './types';
+import { getProfileId } from './get-profile-id';
+import { personalize } from '../personalization/personalize';
+/**
+ * Parameters for creating a personalize browser plugin.
+ * @public
+ */
+export interface PersonalizeBrowserPluginParams {
+    /**
+     * The adapter to be used for the personalize browser plugin.
+     */
+    adapter: PersonalizeAdapter;
+    /**
+     * Optional configuration options for the personalize browser plugin.
+     */
+    options?: PersonalizePluginOptions;
+}
+/**
+ * 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 declare function personalizeBrowserPlugin(params: PersonalizeBrowserPluginParams): PersonalizeBrowserPlugin;
+declare global {
+    interface AnalyticsCore {
+        getProfileId: typeof getProfileId;
+    }
+    interface ScContentSDK {
+        personalize: {
+            personalize: typeof personalize;
+            options?: Partial<WebPersonalizationOptions>;
+            version: string;
+        };
+    }
+}
+//# sourceMappingURL=plugin-browser.d.ts.map

package/types/src/initialization/plugin-browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-browser.d.ts","sourceRoot":"","sources":["../../../src/initialization/plugin-browser.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,wBAAwB,EACxB,kBAAkB,EAClB,wBAAwB,EACxB,yBAAyB,EAE1B,MAAM,SAAS,CAAC;AAUjB,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AA+C7D;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC;CACpC;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,8BAA8B,GACrC,wBAAwB,CAkC1B;AAED,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,aAAa;QACrB,YAAY,EAAE,OAAO,YAAY,CAAC;KACnC;IAED,UAAU,YAAY;QACpB,WAAW,EAAE;YACX,WAAW,EAAE,OAAO,WAAW,CAAC;YAChC,OAAO,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC;YAC7C,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH;CACF"}

package/types/src/initialization/plugin-server.d.ts

@@ -0,0 +1,23 @@
+import { PersonalizeAdapter, PersonalizeServerPlugin, PersonalizeServerPluginOptions } from './types';
+/**
+ * Parameters for creating a personalize server plugin.
+ * @public
+ */
+export interface PersonalizeServerPluginParams {
+    /**
+     * The adapter to be used for the personalize server plugin.
+     */
+    adapter: PersonalizeAdapter;
+    /**
+     * Optional configuration options for the personalize server plugin.
+     */
+    options?: PersonalizeServerPluginOptions;
+}
+/**
+ * Creates a personalize server plugin with the provided options.
+ * @param {PersonalizeServerPluginParams} params - The parameters for the personalize plugin.
+ * @returns {PersonalizeServerPlugin} The personalize plugin instance.
+ * @public
+ */
+export declare function personalizeServerPlugin(params: PersonalizeServerPluginParams): PersonalizeServerPlugin;
+//# sourceMappingURL=plugin-server.d.ts.map

package/types/src/initialization/plugin-server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-server.d.ts","sourceRoot":"","sources":["../../../src/initialization/plugin-server.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,8BAA8B,EAE/B,MAAM,SAAS,CAAC;AAoBjB;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,8BAA8B,CAAC;CAC1C;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,6BAA6B,GACpC,uBAAuB,CAoBzB"}