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

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

@@ -0,0 +1,29 @@
+import { PersonalizeAdapter } from './types';
+import type { IncomingMessage, OutgoingMessage } from 'http';
+/**
+ * Defines the PersonalizeServerAdapter.
+ * @public
+ */
+export interface PersonalizeServerAdapter extends PersonalizeAdapter {
+    /**
+     * The type of the adapter.
+     */
+    type: 'server';
+    /**
+     * Gets the user agent from the request headers.
+     */
+    getUserAgent: PersonalizeAdapter['getUserAgent'];
+}
+/**
+ * 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 declare function personalizeServerAdapter<Request extends IncomingMessage, Response extends OutgoingMessage>(request: Request, response: Response): PersonalizeServerAdapter;
+//# sourceMappingURL=server-adapter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"server-adapter.d.ts","sourceRoot":"","sources":["../../../src/initialization/server-adapter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAS7C,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,kBAAkB,CAAC,cAAc,CAAC,CAAC;CAClD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,SAAS,eAAe,EAC/B,QAAQ,SAAS,eAAe,EAChC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,wBAAwB,CA0FhE"}

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

@@ -0,0 +1,8 @@
+import { PersonalizePlugin } from './types';
+/**
+ * Retrieves the personalize plugin instance from the core context.
+ * @returns {PersonalizePlugin} The personalize plugin instance.
+ * @internal
+ */
+export declare function getPersonalizePlugin(): PersonalizePlugin;
+//# sourceMappingURL=shared.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../src/initialization/shared.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAI5C;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,iBAAiB,CAQxD"}

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

@@ -0,0 +1,168 @@
+import { PluginAdapter } from '@sitecore-content-sdk/core';
+import { PERSONALIZE_PLUGIN_NAME } from './const';
+/**
+ * Represents the web personalization options.
+ * @public
+ */
+export interface WebPersonalizationOptions {
+    /**
+     * Whether to load the web personalization script with the async attribute.
+     */
+    async: boolean;
+    /**
+     * Whether to load the web personalization script with the defer attribute.
+     */
+    defer: boolean;
+    /**
+     * The language to be used for web personalization.
+     */
+    language?: string;
+}
+/**
+ * Parameters for creating a personalize plugin.
+ * @public
+ */
+export interface PersonalizePluginOptions {
+    /**
+     * Whether to set the sc_cid_personalize cookie.
+     *
+     * If using only the browser plugin of the personalize package, set to true.
+     *
+     * If using both the browser and the server plugins of the personalize package, set enablePersonalizeCookie to true either on the browser or the server, and set to false on the other.
+     *
+     * If enableCookie of analytics plugin is false, enablePersonalizeCookie will not be set.
+     *
+     * Default: `false`.
+     */
+    enablePersonalizeCookie?: boolean;
+    /**
+     * Whether to enable web personalization.
+     *
+     * If true, a web personalization script will load in your app with async but without defer.
+     *
+     * To customize the loading of the script, set the value to an object, and in the object, use the async, defer, and language attributes.
+     *
+     * Default: `false`.
+     */
+    webPersonalization?: boolean | Partial<WebPersonalizationOptions>;
+}
+/**
+ * Parameters for creating a personalize server plugin.
+ * @public
+ */
+export type PersonalizeServerPluginOptions = Omit<PersonalizePluginOptions, 'webPersonalization'>;
+/**
+ * Represents the personalize plugin options.
+ * @public
+ */
+export interface PersonalizeOptions {
+    /**
+     * The web personalization options.
+     */
+    webPersonalization: false | WebPersonalizationOptions;
+    /**
+     * The cookie settings for the personalize plugin, including whether the cookie is enabled and the name of the cookie.
+     */
+    cookies: {
+        /**
+         * Whether the sc_cid_personalize cookie is enabled.
+         */
+        enabled: boolean;
+        /**
+         * The name of the sc_cid_personalize cookie.
+         */
+        name: string;
+    };
+}
+/**
+ * Represents the personalize plugin interface.
+ * @public
+ */
+export type PersonalizeServerOptions = Omit<PersonalizeOptions, 'webPersonalization'>;
+/**
+ * Represents the personalize plugin interface.
+ * @internal
+ */
+export interface PersonalizePlugin {
+    options: PersonalizeOptions | PersonalizeServerOptions;
+    init: () => Promise<void>;
+    name: typeof PERSONALIZE_PLUGIN_NAME;
+    dependencies: string[];
+    adapter: PersonalizeAdapter;
+}
+/**
+ * Represents the personalize browser plugin interface.
+ * @public
+ */
+export interface PersonalizeBrowserPlugin {
+    /**
+     * The options for the personalize browser plugin, including web personalization and cookie settings.
+     */
+    options: PersonalizeOptions;
+    /**
+     * Initializes the personalize browser plugin, which may involve setting up necessary configurations, loading scripts, or performing any asynchronous operations required for the plugin to function properly.
+     * @returns A promise that resolves when the initialization is complete.
+     */
+    init: () => Promise<void>;
+    /**
+     * The name of the personalize plugin.
+     */
+    name: typeof PERSONALIZE_PLUGIN_NAME;
+    /**
+     * An array of plugin names that the personalize browser plugin depends on. This ensures that the required plugins are initialized before the personalize plugin is initialized.
+     */
+    dependencies: string[];
+    /**
+     * The adapter for the personalize browser plugin, which provides methods to get and set the profile id, and optionally get the user agent. The adapter allows the personalize plugin to interact with the underlying platform or environment in a consistent way.
+     */
+    adapter: PersonalizeAdapter;
+}
+/**
+ * Represents the personalize server plugin interface.
+ * @public
+ */
+export interface PersonalizeServerPlugin {
+    /**
+     * The options for the personalize server plugin, including cookie settings.
+     */
+    options: PersonalizeServerOptions;
+    /**
+     * Initializes the personalize server plugin, which may involve setting up necessary configurations or performing any asynchronous operations required for the plugin to function properly.
+     * @returns A promise that resolves when the initialization is complete.
+     */
+    init: () => Promise<void>;
+    /**
+     * The name of the personalize plugin.
+     */
+    name: typeof PERSONALIZE_PLUGIN_NAME;
+    /**
+     * An array of plugin names that the personalize server plugin depends on. This ensures that the required plugins are initialized before the personalize plugin is initialized.
+     */
+    dependencies: string[];
+    /**
+     * The adapter for the personalize server plugin, which provides methods to get and set the profile id, and optionally get the user agent. The adapter allows the personalize plugin to interact with the underlying platform or environment in a consistent way.
+     */
+    adapter: PersonalizeAdapter;
+}
+/**
+ * Represents the personalize adapter interface that defines the methods to get and set the profile id, and optionally get the user agent.
+ * @public
+ */
+export interface PersonalizeAdapter extends PluginAdapter {
+    /**
+     * Gets the profile ID. The method returns a string representing the profile ID if it exists, or null if it does not exist.
+     * @returns {string | null} The profile ID or null if not found.
+     */
+    getProfileId: () => string | null;
+    /**
+     * Sets the profile ID. The method may involve asynchronous operations, such as setting cookies or making API calls, and returns a promise that resolves when the profile ID has been set.
+     * @returns {Promise<void>} A promise that resolves when the profile ID has been set.
+     */
+    setProfileId: () => Promise<void>;
+    /**
+     * Optionally gets the user agent string. The method returns a string representing the user agent if it is available, or undefined if it is not available. This method can be used to provide additional context for personalization based on the user's device or browser.
+     * @returns {string | undefined} The user agent string or undefined.
+     */
+    getUserAgent?: () => string | undefined;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/initialization/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACnE;AAED;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAAC,wBAAwB,EAAE,oBAAoB,CAAC,CAAC;AAElG;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,kBAAkB,EAAE,KAAK,GAAG,yBAAyB,CAAC;IACtD;;OAEG;IACH,OAAO,EAAE;QACP;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QACjB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,kBAAkB,GAAG,wBAAwB,CAAC;IACvD,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,IAAI,EAAE,OAAO,uBAAuB,CAAC;IACrC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;;OAGG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B;;OAEG;IACH,IAAI,EAAE,OAAO,uBAAuB,CAAC;IACrC;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC;IAClC;;;OAGG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B;;OAEG;IACH,IAAI,EAAE,OAAO,uBAAuB,CAAC;IACrC;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD;;;OAGG;IACH,YAAY,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IAClC;;;OAGG;IACH,YAAY,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;CACzC"}

package/types/src/internal.d.ts

@@ -0,0 +1,8 @@
+export type { PersonalizePlugin } from './initialization/types';
+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';
+export { PersonalizeAdapter } from './initialization/types';
+export type { PersonalizeBrowserPlugin, PersonalizeServerPlugin, PersonalizeOptions, PersonalizeServerOptions, } from './initialization/types';
+//# sourceMappingURL=internal.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,2BAA2B,EAAE,MAAM,+CAA+C,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EACV,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,wBAAwB,CAAC"}

package/types/src/personalization/personalize.d.ts

@@ -0,0 +1,21 @@
+import type { PersonalizeData } from './personalizer';
+import type { FailedCalledFlowsResponse } from './send-call-flows-request';
+/**
+ * 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 declare function personalize(personalizeData: PersonalizeData, opts?: PersonalizeOpts): Promise<unknown | null | FailedCalledFlowsResponse>;
+/**
+ * Options for the personalize function.
+ * @public
+ */
+export interface PersonalizeOpts {
+    /**
+     * Timeout in milliseconds for the personalize request
+     */
+    timeout?: number;
+}
+//# sourceMappingURL=personalize.d.ts.map

package/types/src/personalization/personalize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personalize.d.ts","sourceRoot":"","sources":["../../../src/personalization/personalize.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAI3E;;;;;;GAMG;AACH,wBAAsB,WAAW,CAC/B,eAAe,EAAE,eAAe,EAChC,IAAI,CAAC,EAAE,eAAe,GACrB,OAAO,CAAC,OAAO,GAAG,IAAI,GAAG,yBAAyB,CAAC,CAqBrD;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/types/src/personalization/personalizer.d.ts

@@ -0,0 +1,177 @@
+import type { NestedObject } from '@sitecore-content-sdk/analytics-core/utils';
+import type { FailedCalledFlowsResponse } from './send-call-flows-request';
+import { CoreContext } from '@sitecore-content-sdk/core';
+/**
+ * The Personalizer Class runs a flow of interactive experiments.
+ * @internal
+ */
+export declare class Personalizer {
+    private clientId;
+    private profileId?;
+    /**
+     * 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: string, profileId?: string | undefined);
+    /**
+     * 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
+     */
+    getInteractiveExperienceData(personalizeData: PersonalizeData, config: CoreContext['config'], searchParams: string, opts?: GetInteractiveExperienceDataOpts): Promise<unknown | null | FailedCalledFlowsResponse>;
+    /**
+     * A function that sanitizes the personalize input data
+     * @param {PersonalizeData} personalizeData - The personalize input data to sanitize
+     * @returns {PersonalizeData} The sanitized object
+     */
+    private sanitizeInput;
+    /**
+     * 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
+     */
+    private mapPersonalizeInputToEPData;
+    /**
+     * A validation method to throw error for the mandatory property for runtime users
+     * @param {PersonalizeData} params - The personalize data object
+     */
+    private validate;
+    /**
+     * 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}`
+     */
+    private extractUrlParamsWithPrefix;
+}
+/**
+ * An interface that describes the geolocation attributes.
+ * @public
+ */
+export interface PersonalizeGeolocation {
+    /**
+     * The site visitor's city.
+     *
+     * Format: title case recommended.
+     */
+    city?: string;
+    /**
+     * The site visitor's country.
+     *
+     * Format: uppercase ISO 3166-1 alpha-2.
+     */
+    country?: string;
+    /**
+     * The site visitor's region.
+     * Depends on the regional structure of the country.
+     *
+     * Format: for example, for Australia, use state and territory abbreviations. For the United States, use ANSI standard INCITS 38:2009.
+     */
+    region?: string;
+}
+/**
+ * An interface that describes the flow execution model attributes input for the library
+ * @public
+ */
+export interface PersonalizeData {
+    /**
+     * The touchpoint where the user interacts with your brand.
+     * For example, for webpages, the channel is "WEB". For mobile app screens, the channel is "MOBILE_APP".
+     *
+     * Format: uppercase.
+     */
+    channel: string;
+    /**
+     * The alphabetic currency code of the currency the site visitor uses in your app.
+     * For example, if the site visitor selects Australian dollars as the currency, the currency is "AUD".
+     *
+     * Format: uppercase ISO 4217.
+     */
+    currency?: string;
+    /**
+     * The site visitor's email address.
+     *
+     * Format: lowercase recommended.
+     */
+    email?: string;
+    /**
+     * The unique identifier of the live interactive experience or experiment to run.
+     * To find the friendly ID in Sitecore Personalize, click the live experience or experiment to run, then click Build summary. The friendly ID is in the Details pane.
+     */
+    friendlyId: string;
+    /**
+     * The site visitor's geolocation data.
+     */
+    geo?: PersonalizeGeolocation;
+    /**
+     * The identifiers used for identifying site visitors.
+     *
+     * If set, the experience or experiment runs only for the identified site visitor.
+     */
+    identifier?: PersonalizeIdentifierInput;
+    /**
+     * The language the site visitor interacts with your brand in.
+     * For example, if the site visitor selects the Japanese language in your app, the language is "JA".
+     *
+     * Format: uppercase ISO 639.
+     *
+     * Default for browser-side events: inferred from the HTML lang attribute. If lang is not specified, the default is an empty string.
+     *
+     * Default for server-side events: empty string.
+     */
+    language?: string;
+    /**
+     * An object of your choice.
+     *
+     * If the URL of the webpage where this function runs contains UTM parameters, those parameters are automatically captured in params.utm.
+     *
+     * To override the automatically captured UTM parameters, specify values manually in params.utm.
+     */
+    params?: PersonalizeInputParams;
+    /**
+     * A list of IDs of personalized page variants.
+     *
+     * Ensures that the correct variants are rendered for personalization.
+     *
+     * If unset or an empty array, this property will not be part of the payload.
+     */
+    pageVariantIds?: string[];
+}
+/**
+ * An interface that describes the identifier model attributes for the library
+ * @public
+ */
+export interface PersonalizeIdentifierInput {
+    /**
+     * The unique guest (site visitor) identifier provided by your organization's identity system, such as a Customer Relationship Management (CRM) system.
+     */
+    id: string;
+    /**
+     * The name of your organization's identity system, external to SitecoreAI, that provided the unique guest (site visitor) identifier.
+     */
+    provider: string;
+}
+/**
+ * A type that describes the params field
+ * @public
+ */
+export type PersonalizeInputParams = NestedObject;
+/**
+ * Options for the getInteractiveExperienceData method
+ * @internal
+ */
+export interface GetInteractiveExperienceDataOpts {
+    /**
+     * Timeout in milliseconds for the personalize request
+     */
+    timeout?: number;
+    /**
+     * Optional user agent string
+     */
+    userAgent?: string | null;
+}
+//# sourceMappingURL=personalizer.d.ts.map

package/types/src/personalization/personalizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personalizer.d.ts","sourceRoot":"","sources":["../../../src/personalization/personalizer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAC;AAE/E,OAAO,KAAK,EAAmB,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAE5F,OAAO,EAAE,WAAW,EAAa,MAAM,4BAA4B,CAAC;AAIpE;;;GAGG;AACH,qBAAa,YAAY;IAMX,OAAO,CAAC,QAAQ;IAAU,OAAO,CAAC,SAAS,CAAC;IALxD;;;;OAIG;gBACiB,QAAQ,EAAE,MAAM,EAAU,SAAS,CAAC,EAAE,MAAM,YAAA;IAEhE;;;;;;;OAOG;IACG,4BAA4B,CAChC,eAAe,EAAE,eAAe,EAChC,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,EAC7B,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,gCAAgC,GACtC,OAAO,CAAC,OAAO,GAAG,IAAI,GAAG,yBAAyB,CAAC;IAgBtD;;;;OAIG;IACH,OAAO,CAAC,aAAa;IA6BrB;;;;OAIG;IACH,OAAO,CAAC,2BAA2B;IAkBnC;;;OAGG;IACH,OAAO,CAAC,QAAQ;IAKhB;;;;;OAKG;IACH,OAAO,CAAC,0BAA0B;CAenC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,sBAAsB,CAAC;IAC7B;;;;OAIG;IACH,UAAU,CAAC,EAAE,0BAA0B,CAAC;IACxC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,YAAY,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B"}

package/types/src/personalization/send-call-flows-request.d.ts

@@ -0,0 +1,78 @@
+import type { NestedObject } from '@sitecore-content-sdk/analytics-core/utils';
+import { GetInteractiveExperienceDataOpts } from './personalizer';
+import { CoreContext } from '@sitecore-content-sdk/core';
+/**
+ * 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 declare function sendCallFlowsRequest(epCallFlowsBody: EPCallFlowsBody, config: CoreContext['config'], opts?: GetInteractiveExperienceDataOpts): Promise<unknown>;
+/**
+ * An interface with the basic functionality that the derived classes needs to implement
+ * @internal
+ */
+export interface PersonalizeClient {
+    config: CoreContext['config'];
+    sendCallFlowsRequest: (epCallFlowAttributes: EPCallFlowsBody, timeout?: number) => Promise<unknown | null | FailedCalledFlowsResponse>;
+}
+/**
+ * An interface that describes the failed response model from Sitecore Edge Proxy
+ * @public
+ */
+export interface FailedCalledFlowsResponse {
+    /**
+     * The status of the response.
+     */
+    status: string;
+    /**
+     * The error code.
+     */
+    code: string;
+    /**
+     * A message describing the error.
+     */
+    message: string;
+    /**
+     * A more detailed message intended for developers.
+     */
+    developerMessage: string;
+    /**
+     * A URL with more information about the error.
+     */
+    moreInfoUrl: string;
+}
+/**
+ * An interface that describes the identifier model attributes for the library
+ * @internal
+ */
+export interface EPIdentifier {
+    id: string;
+    provider: string;
+}
+/**
+ * An interface that describes the payload sent to Sitecore Edge Proxy library
+ * @internal
+ */
+export interface EPCallFlowsBody {
+    browserId?: string;
+    email?: string;
+    friendlyId: string;
+    identifiers?: EPIdentifier;
+    channel: string;
+    clientKey: string;
+    currencyCode?: string;
+    language: string | undefined;
+    params?: EPCallFlowsParams;
+    pointOfSale: string;
+    guestRef?: string;
+    variants?: string[];
+}
+/**
+ * A type that describes the params property of the EPCallFlowsBody
+ * @internal
+ */
+export type EPCallFlowsParams = NestedObject;
+//# sourceMappingURL=send-call-flows-request.d.ts.map

package/types/src/personalization/send-call-flows-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-call-flows-request.d.ts","sourceRoot":"","sources":["../../../src/personalization/send-call-flows-request.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAC;AAE/E,OAAO,EAAE,gCAAgC,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,WAAW,EAAgC,MAAM,4BAA4B,CAAC;AAKvF;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,eAAe,EAChC,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,EAC7B,IAAI,CAAC,EAAE,gCAAgC,oBAmCxC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC9B,oBAAoB,EAAE,CACpB,oBAAoB,EAAE,eAAe,EACrC,OAAO,CAAC,EAAE,MAAM,KACb,OAAO,CAAC,OAAO,GAAG,IAAI,GAAG,yBAAyB,CAAC,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC"}

package/types/src/profile-id/fetch-profile-id-from-edge-proxy.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 declare function fetchProfileIdFromEdgeProxy(clientId: string, contextId: string, edgeUrl: string): Promise<string>;
+/**
+ * Represents the common properties of the response from the Edge Proxy when fetching the profile id.
+ * @internal
+ */
+interface GetProfileIdCommon {
+    status: string;
+    version: string;
+    clientKey: string;
+}
+/**
+ * Represents the successful response from the Edge Proxy when fetching the profile id.
+ * @internal
+ */
+export interface GetProfileIdResponse extends GetProfileIdCommon {
+    ref: string;
+    customer: {
+        ref: string;
+    };
+}
+/**
+ * Represents the error response from the Edge Proxy when fetching the profile id.
+ * @internal
+ */
+export interface GetProfileIdResponseError extends GetProfileIdCommon {
+    error_msg: string;
+    moreInfo: string;
+}
+export {};
+//# sourceMappingURL=fetch-profile-id-from-edge-proxy.d.ts.map

package/types/src/profile-id/fetch-profile-id-from-edge-proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-profile-id-from-edge-proxy.d.ts","sourceRoot":"","sources":["../../../src/profile-id/fetch-profile-id-from-edge-proxy.ts"],"names":[],"mappings":"AAMA;;;;;;;;GAQG;AACH,wBAAsB,2BAA2B,CAC/C,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC,CAqBjB;AAED;;;GAGG;AACH,UAAU,kBAAkB;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC9D,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;IAEnE,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB"}

package/types/src/web-personalization/get-cdn-url.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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 declare function getCdnUrl(contextId: string, edgeUrl: string): Promise<string | null>;
+//# sourceMappingURL=get-cdn-url.d.ts.map

package/types/src/web-personalization/get-cdn-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-cdn-url.d.ts","sourceRoot":"","sources":["../../../src/web-personalization/get-cdn-url.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAsB,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAgB1F"}