@sitecore-cloudsdk/personalize 0.1.3 → 0.1.4

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sitecore-cloudsdk/personalize",
-    "version": "0.1.3",
+    "version": "0.1.4",
     "license": "Apache-2.0",
     "exports": {
         "./server": {
@@ -15,8 +15,8 @@
         }
     },
     "dependencies": {
-        "@sitecore-cloudsdk/core": "^0.1.0-rc.2",
-        "@sitecore-cloudsdk/utils": "^0.1.0-rc.2"
+        "@sitecore-cloudsdk/core": "^0.2.0",
+        "@sitecore-cloudsdk/utils": "^0.2.0"
     },
     "scripts": {
         "build": "npm run build:cjs && npm run build:es",
@@ -32,5 +32,9 @@
         "server.cjs",
         "server.js",
         "server.d.ts"
-    ]
+    ],
+    "engines": {
+        "node": ">=18",
+        "npm": ">=9"
+    }
 }

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

@@ -2,3 +2,9 @@
  * Returns the version of the library.
  */
 export declare const LIBRARY_VERSION: string;
+export declare enum ErrorMessages {
+    IE_0001 = "[IE-0001] The \"window\" object is not available on the server side. Use the \"window\" object only on the client side, and in the correct execution context.",
+    IE_0006 = "[IE-0006] You must first initialize the \"personalize/browser\" module. Run the \"init\" function.",
+    IE_0007 = "[IE-0007] You must first initialize the \"personalize/server\" module. Run the \"init\" function.",
+    MV_0004 = "[MV-0004] \"friendlyId\" is required."
+}

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

@@ -4,10 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LIBRARY_VERSION = void 0;
+exports.ErrorMessages = exports.LIBRARY_VERSION = void 0;
 /* eslint-disable @typescript-eslint/naming-convention */
 const package_json_1 = __importDefault(require("../../package.json"));
 /**
  * Returns the version of the library.
  */
 exports.LIBRARY_VERSION = package_json_1.default.version;
+var ErrorMessages;
+(function (ErrorMessages) {
+    ErrorMessages["IE_0001"] = "[IE-0001] The \"window\" object is not available on the server side. Use the \"window\" object only on the client side, and in the correct execution context.";
+    ErrorMessages["IE_0006"] = "[IE-0006] You must first initialize the \"personalize/browser\" module. Run the \"init\" function.";
+    ErrorMessages["IE_0007"] = "[IE-0007] You must first initialize the \"personalize/server\" module. Run the \"init\" function.";
+    ErrorMessages["MV_0004"] = "[MV-0004] \"friendlyId\" is required.";
+})(ErrorMessages || (exports.ErrorMessages = ErrorMessages = {}));

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

@@ -1,28 +1,12 @@
-import { Settings, SettingsParamsBrowser } from '@sitecore-cloudsdk/core';
-import { CallFlowEdgeProxyClient } from '../../personalization/callflow-edge-proxy-client';
-/**
- * Sets the personalize settings to be used by the application.
- *
- * @param settings - The personalize settings to be set, or `null` to clear the settings.
- */
-export declare function setDependencies(settings: BrowserPersonalizeSettings | null): void;
-/**
- * Retrieves the browser personalize settings object.
- *
- * This function ensures that the browser personalize settings have been initialized and contain essential properties like `settings` and `callFlowEPClient`.
- *
- * @returns The browser personalize settings object.
- * @throws Error if the personalize settings haven't been initialized with the required properties.
- */
-export declare function getDependencies(): BrowserPersonalizeSettings;
+import { SettingsParamsBrowser } from '@sitecore-cloudsdk/core';
+export declare let initPromise: Promise<void> | null;
 /**
  * Initiates the Engage library using the global settings added by the developer
  * @param settingsInput - Global settings added by the developer
  * @returns A promise that resolves with an object that handles the library functionality
  */
 export declare function init(settingsInput: SettingsParamsBrowser): Promise<void>;
-export interface BrowserPersonalizeSettings {
-    id: string;
-    settings: Settings;
-    callFlowEdgeProxyClient: CallFlowEdgeProxyClient;
-}
+/**
+ * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ */
+export declare function awaitInit(): Promise<void>;

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

@@ -1,56 +1,27 @@
 "use strict";
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.init = exports.getDependencies = exports.setDependencies = void 0;
+exports.awaitInit = exports.init = exports.initPromise = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 const core_1 = require("@sitecore-cloudsdk/core");
 const consts_1 = require("../../consts");
-const callflow_edge_proxy_client_1 = require("../../personalization/callflow-edge-proxy-client");
-let dependencies = null;
-/**
- * Sets the personalize settings to be used by the application.
- *
- * @param settings - The personalize settings to be set, or `null` to clear the settings.
- */
-function setDependencies(settings) {
-    dependencies = settings;
-}
-exports.setDependencies = setDependencies;
-/**
- * Retrieves the browser personalize settings object.
- *
- * This function ensures that the browser personalize settings have been initialized and contain essential properties like `settings` and `callFlowEPClient`.
- *
- * @returns The browser personalize settings object.
- * @throws Error if the personalize settings haven't been initialized with the required properties.
- */
-function getDependencies() {
-    if (!dependencies) {
-        throw Error(`[IE-0006] You must first initialize the "personalize/browser" module. Run the "init" function.`);
-    }
-    return dependencies;
-}
-exports.getDependencies = getDependencies;
+exports.initPromise = null;
 /**
  * Initiates the Engage library using the global settings added by the developer
  * @param settingsInput - Global settings added by the developer
  * @returns A promise that resolves with an object that handles the library functionality
  */
 async function init(settingsInput) {
-    if (typeof window === 'undefined') {
-        throw new Error(
-        // eslint-disable-next-line max-len
-        `[IE-0001] The "window" object is not available on the server side. Use the "window" object only on the client side, and in the correct execution context.`);
+    if (typeof window === 'undefined')
+        throw new Error(consts_1.ErrorMessages.IE_0001);
+    try {
+        exports.initPromise = (0, core_1.initCore)(settingsInput);
+        await exports.initPromise;
+    }
+    catch (error) {
+        exports.initPromise = null;
+        throw new Error(error);
     }
-    await (0, core_1.initCore)(settingsInput);
-    const settings = (0, core_1.getSettings)();
-    const id = (0, core_1.getBrowserId)();
-    const callFlowEdgeProxyClient = new callflow_edge_proxy_client_1.CallFlowEdgeProxyClient(settings);
     window.Engage ?? (window.Engage = {});
-    setDependencies({
-        callFlowEdgeProxyClient,
-        id,
-        settings,
-    });
     window.Engage = {
         ...window.Engage,
         getBrowserId: () => (0, core_1.getBrowserId)(),
@@ -61,3 +32,12 @@ async function init(settingsInput) {
     };
 }
 exports.init = init;
+/**
+ * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ */
+async function awaitInit() {
+    if (exports.initPromise === null)
+        throw new Error(consts_1.ErrorMessages.IE_0006);
+    await exports.initPromise;
+}
+exports.awaitInit = awaitInit;

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

@@ -1,23 +1,8 @@
 import { SettingsParamsServer } from '@sitecore-cloudsdk/core';
-import { BrowserPersonalizeSettings } from '../client/initializer';
 import { HttpResponse, MiddlewareNextResponse, Request } from '@sitecore-cloudsdk/utils';
-/**
- * Sets the personalize settings to be used by the application.
- *
- * @param settings - The personalize settings to be set, or `null` to clear the settings.
- */
-export declare function setDependencies(settings: ServerPersonalize | null): void;
-/**
- * Retrieves the personalize server settings used by the application.
- *
- * @returns The personalize server settings.
- * @throws Error if the personalize server settings haven't been initialized.
- */
-export declare function getServerDependencies(): ServerPersonalize;
 /**
  * Initiates the server Engage library using the global settings added by the developer
  * @param settings - Global settings added by the developer
  * @returns A promise that resolves with an object that handles the library functionality
  */
 export declare function initServer<Response extends MiddlewareNextResponse | HttpResponse>(settingsInput: SettingsParamsServer, request: Request, response: Response): Promise<void>;
-export type ServerPersonalize = Omit<BrowserPersonalizeSettings, 'id'>;

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

@@ -1,32 +1,8 @@
 "use strict";
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initServer = exports.getServerDependencies = exports.setDependencies = void 0;
+exports.initServer = void 0;
 const core_1 = require("@sitecore-cloudsdk/core");
-const callflow_edge_proxy_client_1 = require("../../personalization/callflow-edge-proxy-client");
-let serverDependencies = null;
-/**
- * Sets the personalize settings to be used by the application.
- *
- * @param settings - The personalize settings to be set, or `null` to clear the settings.
- */
-function setDependencies(settings) {
-    serverDependencies = settings;
-}
-exports.setDependencies = setDependencies;
-/**
- * Retrieves the personalize server settings used by the application.
- *
- * @returns The personalize server settings.
- * @throws Error if the personalize server settings haven't been initialized.
- */
-function getServerDependencies() {
-    if (!serverDependencies) {
-        throw Error(`[IE-0007] You must first initialize the "personalize/server" module. Run the "init" function.`);
-    }
-    return serverDependencies;
-}
-exports.getServerDependencies = getServerDependencies;
 /**
  * Initiates the server Engage library using the global settings added by the developer
  * @param settings - Global settings added by the developer
@@ -34,11 +10,5 @@ exports.getServerDependencies = getServerDependencies;
  */
 async function initServer(settingsInput, request, response) {
     await (0, core_1.initCoreServer)(settingsInput, request, response);
-    const settings = (0, core_1.getSettingsServer)();
-    const callFlowEdgeProxyClient = new callflow_edge_proxy_client_1.CallFlowEdgeProxyClient(settings);
-    setDependencies({
-        callFlowEdgeProxyClient,
-        settings: settings,
-    });
 }
 exports.initServer = initServer;

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

@@ -1,4 +1,4 @@
-import { FailedCalledFlowsResponse } from './callflow-edge-proxy-client';
+import { FailedCalledFlowsResponse } from './send-call-flows-request';
 import { PersonalizerInput } from './personalizer';
 /**
  * A function that executes an interactive experiment or web experiment over any web-based or mobile application.

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

@@ -1,9 +1,9 @@
 "use strict";
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.personalize = void 0;
-const initializer_1 = require("../initializer/client/initializer");
+const core_1 = require("@sitecore-cloudsdk/core");
 const personalizer_1 = require("./personalizer");
+const initializer_1 = require("../initializer/client/initializer");
 /**
  * A function that executes an interactive experiment or web experiment over any web-based or mobile application.
  * @param personalizeData - The required/optional attributes in order to create a flow execution
@@ -11,8 +11,10 @@ const personalizer_1 = require("./personalizer");
  * Used to abort the request to execute an interactive experiment or web experiment.
  * @returns A flow execution response
  */
-function personalize(personalizeData, timeout) {
-    const { callFlowEdgeProxyClient, id } = (0, initializer_1.getDependencies)();
-    return new personalizer_1.Personalizer(callFlowEdgeProxyClient, id).getInteractiveExperienceData(personalizeData, timeout);
+async function personalize(personalizeData, timeout) {
+    await (0, initializer_1.awaitInit)();
+    const id = (0, core_1.getBrowserId)();
+    const settings = (0, core_1.getSettings)();
+    return new personalizer_1.Personalizer(id).getInteractiveExperienceData(personalizeData, settings, timeout);
 }
 exports.personalize = personalize;

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

@@ -1,4 +1,4 @@
-import { FailedCalledFlowsResponse } from './callflow-edge-proxy-client';
+import { FailedCalledFlowsResponse } from './send-call-flows-request';
 import { Request } from '@sitecore-cloudsdk/utils';
 import { PersonalizerInput } from './personalizer';
 /**

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

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.personalizeServer = void 0;
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 const core_1 = require("@sitecore-cloudsdk/core");
-const initializer_1 = require("../initializer/server/initializer");
 const personalizer_1 = require("./personalizer");
 /**
  * A function that executes an interactive experiment or web experiment over any web-based or mobile application.
@@ -14,8 +13,8 @@ const personalizer_1 = require("./personalizer");
  * @returns A flow execution response
  */
 function personalizeServer(personalizeData, request, timeout) {
-    const { callFlowEdgeProxyClient, settings } = (0, initializer_1.getServerDependencies)();
+    const settings = (0, core_1.getSettingsServer)();
     const id = (0, core_1.getBrowserIdFromRequest)(request, settings.cookieSettings.cookieName);
-    return new personalizer_1.Personalizer(callFlowEdgeProxyClient, id).getInteractiveExperienceData(personalizeData, timeout);
+    return new personalizer_1.Personalizer(id).getInteractiveExperienceData(personalizeData, settings, timeout);
 }
 exports.personalizeServer = personalizeServer;

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

@@ -1,20 +1,20 @@
-import { FailedCalledFlowsResponse, PersonalizeClient } from './callflow-edge-proxy-client';
+import { Settings } from '@sitecore-cloudsdk/core';
+import { FailedCalledFlowsResponse } from './send-call-flows-request';
 import { NestedObject } from '@sitecore-cloudsdk/utils';
 export declare class Personalizer {
-    private personalizeClient;
     private id;
     /**
      * The Personalizer Class runs a flow of interactive experiments.
      * @param personalizeClient - The data to be send to Sitecore EP
      * @param infer - The source of methods to estimate language and page parameters
      */
-    constructor(personalizeClient: PersonalizeClient, id: string);
+    constructor(id: string);
     /**
      * A function to make a request to the Sitecore EP /callFlows API endpoint
      * @param timeout - Optional timeout in milliseconds to cancel the request
      * @returns - A promise that resolves with either the Sitecore EP response object or null
      */
-    getInteractiveExperienceData(personalizeInput: PersonalizerInput, timeout?: number): Promise<unknown | null | FailedCalledFlowsResponse>;
+    getInteractiveExperienceData(personalizeInput: PersonalizerInput, settings: Settings, timeout?: number): Promise<unknown | null | FailedCalledFlowsResponse>;
     /**
      * A function that sanitizes the personalize input data
      * @returns - The sanitized object

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

@@ -1,17 +1,18 @@
 "use strict";
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Personalizer = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 const core_1 = require("@sitecore-cloudsdk/core");
+const send_call_flows_request_1 = require("./send-call-flows-request");
 const utils_1 = require("@sitecore-cloudsdk/utils");
+const consts_1 = require("../consts");
 class Personalizer {
     /**
      * The Personalizer Class runs a flow of interactive experiments.
      * @param personalizeClient - The data to be send to Sitecore EP
      * @param infer - The source of methods to estimate language and page parameters
      */
-    constructor(personalizeClient, id) {
-        this.personalizeClient = personalizeClient;
+    constructor(id) {
         this.id = id;
     }
     /**
@@ -19,14 +20,17 @@ class Personalizer {
      * @param timeout - Optional timeout in milliseconds to cancel the request
      * @returns - A promise that resolves with either the Sitecore EP response object or null
      */
-    async getInteractiveExperienceData(personalizeInput, timeout) {
+    async getInteractiveExperienceData(personalizeInput, settings, timeout) {
         this.validate(personalizeInput);
         const sanitizedInput = this.sanitizeInput(personalizeInput);
         const mappedData = this.mapPersonalizeInputToEPData(sanitizedInput);
         if (!mappedData.email && !mappedData.identifiers)
             mappedData.browserId = this.id;
-        const response = await this.personalizeClient.sendCallFlowsRequest(mappedData, timeout);
-        return response;
+        return (0, send_call_flows_request_1.sendCallFlowsRequest)(mappedData, settings, timeout)
+            .then((payload) => payload)
+            .catch((err) => {
+            throw err;
+        });
     }
     /**
      * A function that sanitizes the personalize input data
@@ -72,7 +76,7 @@ class Personalizer {
      */
     validate({ friendlyId }) {
         if (!friendlyId || friendlyId.trim().length === 0)
-            throw new Error(`[MV-0004] "friendlyId" is required.`);
+            throw new Error(consts_1.ErrorMessages.MV_0004);
     }
 }
 exports.Personalizer = Personalizer;

package/dist/cjs/src/lib/personalization/{callflow-edge-proxy-client.d.ts → send-call-flows-request.d.ts}

@@ -1,21 +1,13 @@
 import { Settings } from '@sitecore-cloudsdk/core';
 import { NestedObject } from '@sitecore-cloudsdk/utils';
-export declare class CallFlowEdgeProxyClient implements PersonalizeClient {
-    settings: Settings;
-    /**
-     * A helper class which handles the functionality for sending CALLFLOW requests
-     * @param personalizeData - The mandatory payload to be send to Sitecore EP
-     * @param settings - The global settings
-     */
-    constructor(settings: Settings);
-    /**
-     * A function that sends a CallFlow request to Sitecore EP
-     * @param personalizeData - Properties to be send to Sitecore EP
-     * @param timeout - Optional timeout in milliseconds to cancel the request
-     * @returns - A promise that resolves with either the Sitecore EP response object or unknown
-     */
-    sendCallFlowsRequest(epCallFlowsBody: EPCallFlowsBody, timeout?: number): Promise<any>;
-}
+/**
+ * A function that sends a CallFlow request to Sitecore EP
+ * @param personalizeData - Properties to be send to Sitecore EP
+ * @param settings - settings for the url params
+ * @param timeout - Optional timeout in milliseconds to cancel the request
+ * @returns - A promise that resolves with either the Sitecore EP response object or unknown
+ */
+export declare function sendCallFlowsRequest(epCallFlowsBody: EPCallFlowsBody, settings: Settings, timeout?: number): Promise<any>;
 /**
  * An interface with the basic functionality that the derived classes needs to implement
  */

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

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendCallFlowsRequest = void 0;
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const consts_1 = require("../consts");
+/**
+ * A function that sends a CallFlow request to Sitecore EP
+ * @param personalizeData - Properties to be send to Sitecore EP
+ * @param settings - settings for the url params
+ * @param timeout - Optional timeout in milliseconds to cancel the request
+ * @returns - A promise that resolves with either the Sitecore EP response object or unknown
+ */
+async function sendCallFlowsRequest(epCallFlowsBody, settings, timeout) {
+    const requestUrl = `${settings.sitecoreEdgeUrl}/personalize/v2/callFlows?sitecoreContextId=${settings.sitecoreEdgeContextId}&siteId=${settings.siteName}`;
+    const fetchOptions = {
+        body: JSON.stringify(epCallFlowsBody),
+        headers: {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            'Content-Type': 'application/json',
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            'X-Library-Version': consts_1.LIBRARY_VERSION,
+        },
+        method: 'POST',
+    };
+    if (timeout === undefined)
+        return fetch(requestUrl, fetchOptions)
+            .then((response) => response.json())
+            .catch(() => {
+            return null;
+        });
+    return (0, utils_1.fetchWithTimeout)(requestUrl, timeout, fetchOptions)
+        .then((response) => {
+        return (response && response.json()) || null;
+    })
+        .catch((err) => {
+        if (err.message.includes('IV-0006') || err.message.includes('IE-0002')) {
+            throw new Error(err.message);
+        }
+        return null;
+    });
+}
+exports.sendCallFlowsRequest = sendCallFlowsRequest;