@sitecore-cloudsdk/core 0.1.1 → 0.1.3

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sitecore-cloudsdk/core",
-    "version": "0.1.1",
+    "version": "0.1.3",
     "license": "Apache-2.0",
     "main": "dist/cjs/src/index.js",
     "module": "dist/esm/src/index.js",

package/dist/cjs/src/index.d.ts

@@ -14,5 +14,5 @@ export { validateSettings } from './lib/settings/validate-settings';
 export { language, pageName } from './lib/infer/infer';
 export { getBrowserIdFromRequest } from './lib/cookie/get-browser-id-from-request';
 export { API_VERSION, COOKIE_NAME_PREFIX, DAILY_SECONDS, DEFAULT_COOKIE_EXPIRY_DAYS, LIBRARY_VERSION, SITECORE_EDGE_URL, } from './lib/consts';
-export type { ICdpResponse, IInfer } from './lib/interfaces';
-export type { ICookieSettings, ISettings, ISettingsParamsBrowser, ISettingsParamsServer, IWebExperiencesSettings, IWebPersonalizationConfig, } from './lib/settings/interfaces';
+export type { EPResponse, Infer } from './lib/interfaces';
+export type { CookieSettings, Settings, SettingsParamsBrowser, SettingsParamsServer } from './lib/settings/interfaces';

package/dist/cjs/src/lib/cookie/create-cookie.d.ts

@@ -1,7 +1,7 @@
-import { ISettings } from '../settings/interfaces';
+import { Settings } from '../settings/interfaces';
 /**
  * Creates and adds the cookie to the document
- * @param settings - The ICookieSettings settings object
+ * @param settings - The CookieSettings settings object
  * @returns - browserId or undefined on error
  */
-export declare function createCookie(settings: ISettings): Promise<void>;
+export declare function createCookie(settings: Settings): Promise<void>;

package/dist/cjs/src/lib/cookie/create-cookie.js

@@ -7,16 +7,14 @@ const get_default_cookie_attributes_1 = require("./get-default-cookie-attributes
 const fetch_browser_id_from_edge_proxy_1 = require("../init/fetch-browser-id-from-edge-proxy");
 /**
  * Creates and adds the cookie to the document
- * @param settings - The ICookieSettings settings object
+ * @param settings - The CookieSettings settings object
  * @returns - browserId or undefined on error
  */
 async function createCookie(settings) {
     if ((0, utils_1.cookieExists)(window.document.cookie, settings.cookieSettings.cookieName))
         return;
     const { browserId } = await (0, fetch_browser_id_from_edge_proxy_1.fetchBrowserIdFromEdgeProxy)(settings.sitecoreEdgeUrl, settings.sitecoreEdgeContextId);
-    if (browserId) {
-        const attributes = (0, get_default_cookie_attributes_1.getDefaultCookieAttributes)(settings.cookieSettings.cookieExpiryDays, settings.cookieSettings.cookieDomain);
-        document.cookie = (0, utils_1.createCookieString)(settings.cookieSettings.cookieName, browserId, attributes);
-    }
+    const attributes = (0, get_default_cookie_attributes_1.getDefaultCookieAttributes)(settings.cookieSettings.cookieExpiryDays, settings.cookieSettings.cookieDomain);
+    document.cookie = (0, utils_1.createCookieString)(settings.cookieSettings.cookieName, browserId, attributes);
 }
 exports.createCookie = createCookie;

package/dist/cjs/src/lib/cookie/get-browser-id-from-middleware-request.d.ts

@@ -1,4 +1,4 @@
-import { IMiddlewareRequest } from '@sitecore-cloudsdk/utils';
+import { MiddlewareRequest } from '@sitecore-cloudsdk/utils';
 /**
  * Retrieves the browser ID from the provided Middleware Request by extracting the cookie value
  * associated with the specified 'cookieName'. The function first checks for Next.js v12 cookie values,
@@ -8,4 +8,4 @@ import { IMiddlewareRequest } from '@sitecore-cloudsdk/utils';
  * @param cookieName - The name of the cookie to retrieve.
  * @returns The browser ID extracted from the cookie, or undefined if not found.
  */
-export declare function getBrowserIdFromMiddlewareRequest(request: IMiddlewareRequest, cookieName: string): string | undefined;
+export declare function getBrowserIdFromMiddlewareRequest(request: MiddlewareRequest, cookieName: string): string | undefined;

package/dist/cjs/src/lib/cookie/get-browser-id-from-request.d.ts

@@ -1,4 +1,4 @@
-import { TRequest } from '@sitecore-cloudsdk/utils';
+import { Request } from '@sitecore-cloudsdk/utils';
 /**
  * Retrieves the browser ID from the provided request object ('T'), using the specified 'cookieName'.
  *
@@ -6,4 +6,4 @@ import { TRequest } from '@sitecore-cloudsdk/utils';
  * @param cookieName - The name of the cookie to retrieve the browser ID from.
  * @returns The browser ID extracted from the cookie or an empty string if not found.
  */
-export declare function getBrowserIdFromRequest<T extends TRequest>(request: T, cookieName: string): string;
+export declare function getBrowserIdFromRequest<T extends Request>(request: T, cookieName: string): string;

package/dist/cjs/src/lib/cookie/get-default-cookie-attributes.d.ts

@@ -3,5 +3,5 @@
  * @param  maxAge - Set the cookie "Max-Age" attribute in days.
  * @returns the default configuration settings for the cookie string
  */
-import { ICookieProperties } from '@sitecore-cloudsdk/utils';
-export declare function getDefaultCookieAttributes(maxAge?: number, cookieDomain?: string): ICookieProperties;
+import { CookieProperties } from '@sitecore-cloudsdk/utils';
+export declare function getDefaultCookieAttributes(maxAge?: number, cookieDomain?: string): CookieProperties;

package/dist/cjs/src/lib/cookie/handle-http-cookie.d.ts

@@ -1,5 +1,5 @@
-import type { IHttpRequest, IHttpResponse } from '@sitecore-cloudsdk/utils';
-import { ISettings } from '../settings/interfaces';
+import type { HttpRequest, HttpResponse } from '@sitecore-cloudsdk/utils';
+import { Settings } from '../settings/interfaces';
 /**
  * Handles HTTP Cookie operations for setting the browser ID cookie in the request and response.
  *
@@ -9,6 +9,6 @@ import { ISettings } from '../settings/interfaces';
  * @param timeout - The timeout for the call to proxy to get browserId.
  * @returns A Promise that resolves once the browser ID cookie is handled.
  *
- * @throws [IE-0003] - This exception is thrown in the case getBrowserIdFromCdp wasn't able to retrieve a browser id.
+ * @throws [IE-0003] - This exception is thrown in the case getBrowserIdFromEP wasn't able to retrieve a browser id.
  */
-export declare function handleHttpCookie(request: IHttpRequest, response: IHttpResponse, options: ISettings, timeout?: number): Promise<void>;
+export declare function handleHttpCookie(request: HttpRequest, response: HttpResponse, options: Settings, timeout?: number): Promise<void>;

package/dist/cjs/src/lib/cookie/handle-http-cookie.js

@@ -14,7 +14,7 @@ const fetch_browser_id_from_edge_proxy_1 = require("../init/fetch-browser-id-fro
  * @param timeout - The timeout for the call to proxy to get browserId.
  * @returns A Promise that resolves once the browser ID cookie is handled.
  *
- * @throws [IE-0003] - This exception is thrown in the case getBrowserIdFromCdp wasn't able to retrieve a browser id.
+ * @throws [IE-0003] - This exception is thrown in the case getBrowserIdFromEP wasn't able to retrieve a browser id.
  */
 async function handleHttpCookie(request, response, options, timeout) {
     const { cookieName } = options.cookieSettings;
@@ -26,12 +26,9 @@ async function handleHttpCookie(request, response, options, timeout) {
         if (cookie)
             cookieValue = cookie.value;
     }
-    if (!cookieValue) {
-        const { browserId } = await (0, fetch_browser_id_from_edge_proxy_1.fetchBrowserIdFromEdgeProxy)(options.sitecoreEdgeUrl, options.sitecoreEdgeContextId, timeout);
-        if (!browserId)
-            throw new Error('[IE-0003] Unable to set the cookie because the browser ID could not be retrieved from the server. Try again later, or use try-catch blocks to handle this error.');
-        cookieValue = browserId;
-    }
+    if (!cookieValue)
+        cookieValue = (await (0, fetch_browser_id_from_edge_proxy_1.fetchBrowserIdFromEdgeProxy)(options.sitecoreEdgeUrl, options.sitecoreEdgeContextId, timeout))
+            .browserId;
     const defaultCookieAttributes = (0, get_default_cookie_attributes_1.getDefaultCookieAttributes)(options.cookieSettings.cookieExpiryDays, options.cookieSettings.cookieDomain);
     const cookieString = (0, utils_1.createCookieString)(cookieName, cookieValue, defaultCookieAttributes);
     if (!cookie)

package/dist/cjs/src/lib/cookie/handle-next-js-middleware-cookie.d.ts

@@ -1,5 +1,5 @@
-import { IMiddlewareNextResponse, IMiddlewareRequest } from '@sitecore-cloudsdk/utils';
-import { ISettings } from '../settings/interfaces';
+import { MiddlewareNextResponse, MiddlewareRequest } from '@sitecore-cloudsdk/utils';
+import { Settings } from '../settings/interfaces';
 /**
  * Handles the Middleware Request and sets a cookie with the provided 'cookieName' and 'cookieValue'.
  * If 'cookieValue' is not present in the request, it fetches it using the 'fetchBrowserIdFromEdgeProxy' function
@@ -13,4 +13,4 @@ import { ISettings } from '../settings/interfaces';
  * @throws [IE-0003] - This exception is thrown in the case fetchBrowserIdFromEdgeProxy wasn't able to retrieve a browserId.
  *
  */
-export declare function handleNextJsMiddlewareCookie(request: IMiddlewareRequest, response: IMiddlewareNextResponse, options: ISettings, timeout?: number): Promise<void>;
+export declare function handleNextJsMiddlewareCookie(request: MiddlewareRequest, response: MiddlewareNextResponse, options: Settings, timeout?: number): Promise<void>;

package/dist/cjs/src/lib/cookie/handle-next-js-middleware-cookie.js

@@ -21,12 +21,9 @@ const fetch_browser_id_from_edge_proxy_1 = require("../init/fetch-browser-id-fro
 async function handleNextJsMiddlewareCookie(request, response, options, timeout) {
     const { cookieName } = options.cookieSettings;
     let cookieValue = (0, get_browser_id_from_middleware_request_1.getBrowserIdFromMiddlewareRequest)(request, cookieName);
-    if (!cookieValue) {
-        const { browserId } = await (0, fetch_browser_id_from_edge_proxy_1.fetchBrowserIdFromEdgeProxy)(options.sitecoreEdgeUrl, options.sitecoreEdgeContextId, timeout);
-        if (!browserId)
-            throw new Error('[IE-0003] Unable to set the cookie because the browser ID could not be retrieved from the server. Try again later, or use try-catch blocks to handle this error.');
-        cookieValue = browserId;
-    }
+    if (!cookieValue)
+        cookieValue = (await (0, fetch_browser_id_from_edge_proxy_1.fetchBrowserIdFromEdgeProxy)(options.sitecoreEdgeUrl, options.sitecoreEdgeContextId, timeout))
+            .browserId;
     const defaultCookieAttributes = (0, get_default_cookie_attributes_1.getDefaultCookieAttributes)(options.cookieSettings.cookieExpiryDays, options.cookieSettings.cookieDomain);
     request.cookies.set(cookieName, cookieValue, defaultCookieAttributes);
     response.cookies.set(cookieName, cookieValue, defaultCookieAttributes);

package/dist/cjs/src/lib/cookie/handle-server-cookie.d.ts

@@ -1,4 +1,4 @@
-import { type TRequest, type IMiddlewareNextResponse, type IHttpResponse } from '@sitecore-cloudsdk/utils';
+import { type Request, type MiddlewareNextResponse, type HttpResponse } from '@sitecore-cloudsdk/utils';
 /**
  * Handles server-side cookie operations based on the provided 'request' and 'response' objects.
  *
@@ -7,4 +7,4 @@ import { type TRequest, type IMiddlewareNextResponse, type IHttpResponse } from
  * @param timeout - The timeout for the call to proxy to get browserId.
  * @returns A Promise that resolves once the cookie handling is complete.
  */
-export declare function handleServerCookie<T extends TRequest, X extends IMiddlewareNextResponse | IHttpResponse>(request: T, response: X, timeout?: number): Promise<void>;
+export declare function handleServerCookie<T extends Request, X extends MiddlewareNextResponse | HttpResponse>(request: T, response: X, timeout?: number): Promise<void>;

package/dist/cjs/src/lib/init/fetch-browser-id-from-edge-proxy.d.ts

@@ -1,4 +1,4 @@
-import { IProxySettings } from '../interfaces';
+import { ProxySettings } from '../interfaces';
 /**
  * Gets the browser ID and Client Key from Sitecore Edge Proxy
  * @param sitecoreEdgeUrl - The baseURL for the Edge Proxy API.
@@ -6,4 +6,4 @@ import { IProxySettings } from '../interfaces';
  * @param timeout - The timeout for the call to proxy
  * @returns the browser ID
  */
-export declare function fetchBrowserIdFromEdgeProxy(sitecoreEdgeUrl: string, sitecoreEdgeContextId: string, timeout?: number): Promise<IProxySettings>;
+export declare function fetchBrowserIdFromEdgeProxy(sitecoreEdgeUrl: string, sitecoreEdgeContextId: string, timeout?: number): Promise<ProxySettings>;

package/dist/cjs/src/lib/init/fetch-browser-id-from-edge-proxy.js

@@ -18,19 +18,19 @@ async function fetchBrowserIdFromEdgeProxy(sitecoreEdgeUrl, sitecoreEdgeContextI
         headers: { 'X-Library-Version': consts_1.LIBRARY_VERSION },
     };
     const url = (0, construct_get_browser_id_url_1.constructGetBrowserIdUrl)(sitecoreEdgeUrl, sitecoreEdgeContextId);
-    let response;
+    let payload;
     if (timeout !== undefined) {
-        response = await (0, utils_1.fetchWithTimeout)(url, timeout, fetchOptions);
+        payload = await (0, utils_1.fetchWithTimeout)(url, timeout, fetchOptions);
     }
     else {
-        response = await fetch(url, fetchOptions)
+        payload = await fetch(url, fetchOptions)
             .then((res) => res.json())
             .then((data) => data)
             .catch(() => undefined);
     }
-    if (!response)
-        return { browserId: '' };
-    const { ref: browserId } = response;
+    if (!payload?.ref)
+        throw new Error('[IE-0003] Unable to set the cookie because the browser ID could not be retrieved from the server. Try again later, or use try-catch blocks to handle this error.');
+    const { ref: browserId } = payload;
     return { browserId };
 }
 exports.fetchBrowserIdFromEdgeProxy = fetchBrowserIdFromEdgeProxy;

package/dist/cjs/src/lib/init/get-guest-id.d.ts

@@ -1,23 +1,23 @@
 /**
- * A function that gets the guest ref from CDP.
+ * A function that gets the guest ref from EP.
  * @param browserId - The browser id of the client
  * @param sitecoreEdgeContextId - The sitecoreEdgeContextId
  * @returns - A promise that resolves with the guest ref
  * @throws - Will throw an error if the clientKey/browser id is invalid
  */
 export declare function getGuestId(browserId: string, sitecoreEdgeContextId: string, sitecoreEdgeUrl: string): Promise<string>;
-interface IGetGuestRefCommon {
+interface GetGuestRefCommon {
     status: string;
     version: string;
     clientKey: string;
 }
-export interface IGetGuestRefResponse extends IGetGuestRefCommon {
+export interface GetGuestRefResponse extends GetGuestRefCommon {
     ref: string;
     customer: {
         ref: string;
     };
 }
-export interface IGetGuestRefResponseError extends IGetGuestRefCommon {
+export interface GetGuestRefResponseError extends GetGuestRefCommon {
     error_msg: string;
     moreInfo: string;
 }

package/dist/cjs/src/lib/init/get-guest-id.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getGuestId = void 0;
 const consts_1 = require("../consts");
 /**
- * A function that gets the guest ref from CDP.
+ * A function that gets the guest ref from EP.
  * @param browserId - The browser id of the client
  * @param sitecoreEdgeContextId - The sitecoreEdgeContextId
  * @returns - A promise that resolves with the guest ref

package/dist/cjs/src/lib/init/init-core-server.d.ts

@@ -1,6 +1,6 @@
-import { IHttpResponse, IMiddlewareNextResponse, TRequest } from '@sitecore-cloudsdk/utils';
-import { ISettings, ISettingsParamsServer } from '../settings/interfaces';
-export declare function setCoreSettings(settings: ISettings): void;
+import { HttpResponse, MiddlewareNextResponse, Request } from '@sitecore-cloudsdk/utils';
+import { Settings, SettingsParamsServer } from '../settings/interfaces';
+export declare function setCoreSettings(settings: Settings): void;
 /**
  * Initializes the core settings for browser-based applications.
  *
@@ -9,7 +9,7 @@ export declare function setCoreSettings(settings: ISettings): void;
  * @param settingsInput - The settings input to configure the core settings.
  * @returns A Promise that resolves when initialization is complete.
  */
-export declare function getSettingsServer(): ISettings;
+export declare function getSettingsServer(): Settings;
 /**
  * Initializes the core settings for browser-based applications.
  *
@@ -18,4 +18,4 @@ export declare function getSettingsServer(): ISettings;
  * @param settingsInput - The settings input to configure the core settings.
  * @returns A Promise that resolves when initialization is complete.
  */
-export declare function initCoreServer<TResponse extends IMiddlewareNextResponse | IHttpResponse>(settingsInput: ISettingsParamsServer, request: TRequest, response: TResponse): Promise<void>;
+export declare function initCoreServer<Response extends MiddlewareNextResponse | HttpResponse>(settingsInput: SettingsParamsServer, request: Request, response: Response): Promise<void>;

package/dist/cjs/src/lib/init/init-core-server.js

@@ -24,7 +24,7 @@ exports.setCoreSettings = setCoreSettings;
  */
 function getSettingsServer() {
     if (!coreSettings) {
-        throw Error('[IE-0005] You must first initialize the "core" package. Run the "init" function.');
+        throw Error('[IE-0008] You must first initialize the "core" package. Run the "init" function.');
     }
     return coreSettings;
 }

package/dist/cjs/src/lib/init/init-core.d.ts

@@ -1,17 +1,4 @@
-import { ISettings, ISettingsParamsBrowser } from '../settings/interfaces';
-/**
- * Enum representing the initialization statuses.
- * - `NOT_STARTED`: The initialization process has not started.
- * - `INITIALIZING`: The initialization process is in progress.
- * - `DONE`: The initialization process is complete.
- */
-export declare enum INIT_STATUSES {
-    NOT_STARTED = 0,
-    INITIALIZING = 1,
-    DONE = 2
-}
-export declare function setInitStatus(status: INIT_STATUSES): void;
-export declare function setCoreSettings(settings: ISettings): void;
+import { Settings, SettingsParamsBrowser } from '../settings/interfaces';
 /**
  * Retrieves the core settings object.
  *
@@ -20,7 +7,7 @@ export declare function setCoreSettings(settings: ISettings): void;
  * @returns The core settings object.
  * @throws Error if the core settings haven't been initialized with the required properties.
  */
-export declare function getSettings(): ISettings;
+export declare function getSettings(): Settings;
 /**
  * Initializes the core settings for browser-based applications.
  *
@@ -29,4 +16,9 @@ export declare function getSettings(): ISettings;
  * @param settingsInput - The settings input to configure the core settings.
  * @returns A Promise that resolves when initialization is complete.
  */
-export declare function initCore(settingsInput: ISettingsParamsBrowser): Promise<void>;
+export declare function initCore(settingsInput: SettingsParamsBrowser): Promise<void>;
+/**
+ * Helper functions for tests
+ */
+export declare function setCoreSettings(settings: Settings): void;
+export declare function setCookiePromise(promise: Promise<void>): void;

package/dist/cjs/src/lib/init/init-core.js

@@ -1,37 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initCore = exports.getSettings = exports.setCoreSettings = exports.setInitStatus = exports.INIT_STATUSES = void 0;
+exports.setCookiePromise = exports.setCoreSettings = exports.initCore = exports.getSettings = void 0;
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 const create_cookie_1 = require("../cookie/create-cookie");
 const create_settings_1 = require("../settings/create-settings");
-/**
- * Enum representing the initialization statuses.
- * - `NOT_STARTED`: The initialization process has not started.
- * - `INITIALIZING`: The initialization process is in progress.
- * - `DONE`: The initialization process is complete.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-var INIT_STATUSES;
-(function (INIT_STATUSES) {
-    INIT_STATUSES[INIT_STATUSES["NOT_STARTED"] = 0] = "NOT_STARTED";
-    INIT_STATUSES[INIT_STATUSES["INITIALIZING"] = 1] = "INITIALIZING";
-    INIT_STATUSES[INIT_STATUSES["DONE"] = 2] = "DONE";
-})(INIT_STATUSES || (exports.INIT_STATUSES = INIT_STATUSES = {}));
 /**
  * Internal settings object to be used by all functions in module caching.
  * It starts with a null value and is set to the proper object by the  function. *
  * Can be retrieved only through the  function.
  */
 let coreSettings = null;
-let initStatus = INIT_STATUSES.NOT_STARTED;
-function setInitStatus(status) {
-    initStatus = status;
-}
-exports.setInitStatus = setInitStatus;
-function setCoreSettings(settings) {
-    coreSettings = settings;
-}
-exports.setCoreSettings = setCoreSettings;
 /**
  * Retrieves the core settings object.
  *
@@ -42,11 +20,12 @@ exports.setCoreSettings = setCoreSettings;
  */
 function getSettings() {
     if (!coreSettings) {
-        throw Error(`[IE-0004] You must first initialize the "core" package. Run the "init" function.`);
+        throw Error(`[IE-0008] You must first initialize the "core" package. Run the "init" function.`);
     }
     return coreSettings;
 }
 exports.getSettings = getSettings;
+let createCookiePromise = null;
 /**
  * Initializes the core settings for browser-based applications.
  *
@@ -56,14 +35,21 @@ exports.getSettings = getSettings;
  * @returns A Promise that resolves when initialization is complete.
  */
 async function initCore(settingsInput) {
-    if (initStatus != INIT_STATUSES.NOT_STARTED)
-        return;
-    setInitStatus(INIT_STATUSES.INITIALIZING);
-    coreSettings = (0, create_settings_1.createSettings)(settingsInput);
-    setCoreSettings(coreSettings);
-    if (settingsInput.enableBrowserCookie) {
-        await (0, create_cookie_1.createCookie)(coreSettings);
-    }
-    setInitStatus(INIT_STATUSES.DONE);
+    if (coreSettings === null)
+        coreSettings = (0, create_settings_1.createSettings)(settingsInput);
+    if (settingsInput.enableBrowserCookie && createCookiePromise === null)
+        createCookiePromise = (0, create_cookie_1.createCookie)(coreSettings);
+    await createCookiePromise;
 }
 exports.initCore = initCore;
+/**
+ * Helper functions for tests
+ */
+function setCoreSettings(settings) {
+    coreSettings = settings;
+}
+exports.setCoreSettings = setCoreSettings;
+function setCookiePromise(promise) {
+    createCookiePromise = promise;
+}
+exports.setCookiePromise = setCookiePromise;

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

@@ -1,19 +1,19 @@
 /**
- * The response object that Sitecore CDP returns
+ * The response object that Sitecore EP returns
  */
-export interface ICdpResponse {
+export interface EPResponse {
     ref: string;
     status: string;
     version: string;
     client_key: string;
 }
-export interface IProxySettings {
+export interface ProxySettings {
     browserId: string;
 }
 /**
  * Interface for supporting response IncomingMessage http node type
  */
-export interface IInfer {
+export interface Infer {
     language: () => string | undefined;
     pageName: () => string;
 }

package/dist/cjs/src/lib/settings/create-settings.d.ts

@@ -1,7 +1,7 @@
-import { ISettings, ISettingsParams } from './interfaces';
+import { Settings, SettingsParams } from './interfaces';
 /**
  * Creates the global settings object, to be used by the library
  * @param settingsInput - Global settings added by the developer.
- * @returns an ISettings with the settings added by the developer
+ * @returns an Settings with the settings added by the developer
  */
-export declare function createSettings(settingsInput: ISettingsParams): ISettings;
+export declare function createSettings(settingsInput: SettingsParams): Settings;

package/dist/cjs/src/lib/settings/create-settings.js

@@ -7,7 +7,7 @@ const validate_settings_1 = require("./validate-settings");
 /**
  * Creates the global settings object, to be used by the library
  * @param settingsInput - Global settings added by the developer.
- * @returns an ISettings with the settings added by the developer
+ * @returns an Settings with the settings added by the developer
  */
 function createSettings(settingsInput) {
     (0, validate_settings_1.validateSettings)(settingsInput);

package/dist/cjs/src/lib/settings/interfaces.d.ts

@@ -1,28 +1,28 @@
 /**
  * Extends the global settings object with additional properties
  */
-export interface ISettings extends IBasicSettings {
-    cookieSettings: ICookieSettings;
+export interface Settings extends BasicSettings {
+    cookieSettings: CookieSettings;
     sitecoreEdgeUrl: string;
 }
-export interface ISettingsParamsBrowser extends ISettingsParams {
+export interface SettingsParamsBrowser extends SettingsParams {
     enableBrowserCookie?: boolean;
 }
-export interface ISettingsParamsServer extends ISettingsParams {
+export interface SettingsParamsServer extends SettingsParams {
     enableServerCookie?: boolean;
 }
-export interface ISettingsParams extends IBasicSettings, ICookieSettingsInput {
+export interface SettingsParams extends BasicSettings, CookieSettingsInput {
     timeout?: number;
     sitecoreEdgeUrl?: string;
 }
 /**
  * Properties for the global settings object
  */
-interface IBasicSettings {
+interface BasicSettings {
     sitecoreEdgeContextId: string;
     siteName: string;
 }
-interface ICookieSettingsInput {
+interface CookieSettingsInput {
     cookiePath?: string;
     cookieExpiryDays?: number;
     cookieDomain?: string;
@@ -30,7 +30,7 @@ interface ICookieSettingsInput {
 /**
  * Properties for the cookie object
  */
-export interface ICookieSettings {
+export interface CookieSettings {
     cookieName: string;
     cookieDomain?: string;
     cookieExpiryDays: number;
@@ -39,25 +39,7 @@ export interface ICookieSettings {
 /**
  * Properties for the cookie object
  */
-export interface ICookieSettingsBrowser extends ICookieSettings {
+export interface CookieSettingsBrowser extends CookieSettings {
     enableBrowserCookie: boolean;
 }
-/**
- * Properties for the Web Flow configuration
- */
-export interface IWebPersonalizationConfig {
-    asyncScriptLoading?: boolean;
-    deferScriptLoading?: boolean;
-    baseURLOverride?: string;
-}
-export interface IWebExperiencesSettings {
-    targetURL: string;
-    pointOfSale: string;
-    client_key: string;
-    web_flow_config: {
-        async: boolean;
-        defer: boolean;
-    };
-    web_flow_target?: string;
-}
 export {};

package/dist/cjs/src/lib/settings/validate-settings.d.ts

@@ -1,4 +1,4 @@
-import { ISettingsParams } from './interfaces';
+import { SettingsParams } from './interfaces';
 /**
  * Validates the core settings to ensure they meet required criteria.
  *
@@ -7,4 +7,4 @@ import { ISettingsParams } from './interfaces';
  * @param settings - The core settings object to validate.
  * @throws Error with specific error codes if any required property is missing or empty.
  */
-export declare function validateSettings(settings: ISettingsParams): void;
+export declare function validateSettings(settings: SettingsParams): void;