@sitecore-cloudsdk/core 0.1.0-rc.0

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

@@ -0,0 +1,31 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { getDefaultCookieAttributes } from './get-default-cookie-attributes';
+import { createCookieString, getCookieServerSide } from '@sitecore-cloudsdk/utils';
+/**
+ * Handles HTTP Cookie operations for setting the browser ID cookie in the request and response.
+ *
+ * @param request - The HTTP Request object containing request headers and data.
+ * @param options - The settings object containing configuration options.
+ * @param response - The Middleware Next Response or HTTP Response object.
+ * @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.
+ */
+export function handleHttpCookie(request, response, options, cookieTempValue) {
+    const { cookieName } = options.cookieSettings;
+    const cookieValueFromRequest = request.headers.cookie;
+    let cookie;
+    let cookieValue;
+    if (cookieValueFromRequest) {
+        cookie = getCookieServerSide(cookieValueFromRequest, cookieName);
+        if (cookie)
+            cookieValue = cookie.value;
+    }
+    if (!cookieValue)
+        cookieValue = cookieTempValue;
+    const defaultCookieAttributes = getDefaultCookieAttributes(options.cookieSettings.cookieExpiryDays, options.cookieSettings.cookieDomain);
+    const cookieString = createCookieString(cookieName, cookieValue, defaultCookieAttributes);
+    if (!cookie)
+        request.headers.cookie = cookieValueFromRequest ? cookieValueFromRequest + '; ' + cookieString : cookieString;
+    response.setHeader('Set-Cookie', cookieString);
+}

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

@@ -0,0 +1,16 @@
+import { IMiddlewareNextResponse, IMiddlewareRequest } from '@sitecore-cloudsdk/utils';
+import { ISettings } 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 'getProxySettings' function
+ * and stores it in the request's cookies with the specified 'defaultCookieAttributes'.
+ *
+ * @param request - The Middleware Request object.
+ * @param cookieName - The name of the cookie to set.
+ * @param options - The settings object containing configuration options.
+ * @param defaultCookieAttributes - The default attributes for the cookie.
+ *
+ * @throws [IE-0003] - This exception is thrown in the case getProxySettings wasn't able to retrieve a browser id and client key.
+ *
+ */
+export declare function handleNextJsMiddlewareCookie(request: IMiddlewareRequest, response: IMiddlewareNextResponse, options: ISettings, cookieTempValue: string): void;

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

@@ -0,0 +1,23 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { getBrowserIdFromMiddlewareRequest } from './get-browser-id-from-middleware-request';
+import { getDefaultCookieAttributes } from './get-default-cookie-attributes';
+/**
+ * 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 'getProxySettings' function
+ * and stores it in the request's cookies with the specified 'defaultCookieAttributes'.
+ *
+ * @param request - The Middleware Request object.
+ * @param cookieName - The name of the cookie to set.
+ * @param options - The settings object containing configuration options.
+ * @param defaultCookieAttributes - The default attributes for the cookie.
+ *
+ * @throws [IE-0003] - This exception is thrown in the case getProxySettings wasn't able to retrieve a browser id and client key.
+ *
+ */
+export function handleNextJsMiddlewareCookie(request, response, options, cookieTempValue) {
+    const { cookieName } = options.cookieSettings;
+    const cookieValue = getBrowserIdFromMiddlewareRequest(request, cookieName) ?? cookieTempValue;
+    const defaultCookieAttributes = getDefaultCookieAttributes(options.cookieSettings.cookieExpiryDays, options.cookieSettings.cookieDomain);
+    request.cookies.set(cookieName, cookieValue, defaultCookieAttributes);
+    response.cookies.set(cookieName, cookieValue, defaultCookieAttributes);
+}

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

@@ -0,0 +1,10 @@
+import { type TRequest, type IMiddlewareNextResponse, type IHttpResponse } from '@sitecore-cloudsdk/utils';
+/**
+ * Handles server-side cookie operations based on the provided 'request' and 'response' objects.
+ *
+ * @param request - The request object, either a Middleware Request or an HTTP Request.
+ * @param response - The response object, either a Middleware Next Response or an HTTP Response.
+ * @param options - The settings object containing configuration options.
+ * @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>;

package/dist/esm/src/lib/cookie/handle-server-cookie.js

@@ -0,0 +1,28 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { isNextJsMiddlewareRequest, isNextJsMiddlewareResponse, isHttpRequest, isHttpResponse, } from '@sitecore-cloudsdk/utils';
+import { getSettingsServer } from '../init/init-core-server';
+import { handleNextJsMiddlewareCookie } from './handle-next-js-middleware-cookie';
+import { handleHttpCookie } from './handle-http-cookie';
+import { getProxySettings } from '../init/get-proxy-settings';
+import { BID_PREFIX } from '../consts';
+/**
+ * Handles server-side cookie operations based on the provided 'request' and 'response' objects.
+ *
+ * @param request - The request object, either a Middleware Request or an HTTP Request.
+ * @param response - The response object, either a Middleware Next Response or an HTTP Response.
+ * @param options - The settings object containing configuration options.
+ * @returns A Promise that resolves once the cookie handling is complete.
+ */
+export async function handleServerCookie(request, response, timeout) {
+    const settings = getSettingsServer();
+    const { browserId, clientKey } = await getProxySettings(settings.sitecoreEdgeContextId, timeout);
+    if (!clientKey)
+        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.');
+    settings.cookieSettings.cookieName = `${BID_PREFIX}${clientKey}`;
+    if (isNextJsMiddlewareRequest(request) && isNextJsMiddlewareResponse(response)) {
+        handleNextJsMiddlewareCookie(request, response, settings, browserId);
+    }
+    else if (isHttpRequest(request) && isHttpResponse(response)) {
+        handleHttpCookie(request, response, settings, browserId);
+    }
+}

package/dist/esm/src/lib/infer/infer.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Returns the uppercase language code of the current web page's root HTML element, using the "lang" attribute.
+ * If unavailable or invalid, an undefined is returned.
+ * @returns - Language attribute or undefined
+ */
+export declare function language(): string | undefined;
+/**
+ * Returns the name of the current page extracted from the URL's pathname.
+ * If it's the home page, it returns 'Home Page'.
+ * @returns - Home Page if root or pathname
+ */
+export declare function pageName(): string;

package/dist/esm/src/lib/infer/infer.js

@@ -0,0 +1,21 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+/**
+ * Returns the uppercase language code of the current web page's root HTML element, using the "lang" attribute.
+ * If unavailable or invalid, an undefined is returned.
+ * @returns - Language attribute or undefined
+ */
+export function language() {
+    return typeof window === 'undefined' || window.document.documentElement.lang.length <= 1
+        ? undefined
+        : new Intl.Locale(window.document.documentElement.lang).language.toLocaleUpperCase();
+}
+/**
+ * Returns the name of the current page extracted from the URL's pathname.
+ * If it's the home page, it returns 'Home Page'.
+ * @returns - Home Page if root or pathname
+ */
+export function pageName() {
+    if (typeof window === 'undefined')
+        return '';
+    return window.location.pathname === '/' ? 'Home Page' : window.location.pathname.split('/').pop();
+}

package/dist/esm/src/lib/init/construct-get-proxy-settings-url.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Constructs the URL for retrieving the proxy settings from EDGE events proxy
+ * @param sitecoreEdgeContextId - From global settings
+ * @returns The URL string for retrieving the browser ID and ClientKey
+ */
+export declare function constructGetProxySettingsUrl(sitecoreEdgeContextId: string): string;

package/dist/esm/src/lib/init/construct-get-proxy-settings-url.js

@@ -0,0 +1,10 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { API_VERSION, TARGET_URL } from '../consts';
+/**
+ * Constructs the URL for retrieving the proxy settings from EDGE events proxy
+ * @param sitecoreEdgeContextId - From global settings
+ * @returns The URL string for retrieving the browser ID and ClientKey
+ */
+export function constructGetProxySettingsUrl(sitecoreEdgeContextId) {
+    return `${TARGET_URL}/events/${API_VERSION}/browser/create.json?sitecoreContextId=${sitecoreEdgeContextId}&client_key=`;
+}

package/dist/esm/src/lib/init/get-browser-id.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get the browser ID from the cookie
+ * @returns The browser ID if the cookie exists
+ */
+export declare function getBrowserId(): string;

package/dist/esm/src/lib/init/get-browser-id.js

@@ -0,0 +1,11 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
+import { getSettings } from './init-core';
+/**
+ * Get the browser ID from the cookie
+ * @returns The browser ID if the cookie exists
+ */
+export function getBrowserId() {
+    const settings = getSettings();
+    return getCookieValueClientSide(settings.cookieSettings.cookieName);
+}

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

@@ -0,0 +1,24 @@
+/**
+ * A function that gets the guest ref from CDP.
+ * @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): Promise<string>;
+interface IGetGuestRefCommon {
+    status: string;
+    version: string;
+    clientKey: string;
+}
+export interface IGetGuestRefResponse extends IGetGuestRefCommon {
+    ref: string;
+    customer: {
+        ref: string;
+    };
+}
+export interface IGetGuestRefResponseError extends IGetGuestRefCommon {
+    error_msg: string;
+    moreInfo: string;
+}
+export {};

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

@@ -0,0 +1,21 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { API_VERSION, LIBRARY_VERSION, TARGET_URL } from '../consts';
+/**
+ * A function that gets the guest ref from CDP.
+ * @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 async function getGuestId(browserId, sitecoreEdgeContextId) {
+    // eslint-disable-next-line max-len
+    const url = `${TARGET_URL}/events/${API_VERSION}/browser/${browserId}/show.json?sitecoreContextId=${sitecoreEdgeContextId}&client_key=&api_token=`;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    const response = await fetch(url, { headers: { 'X-Library-Version': LIBRARY_VERSION } });
+    const data = await response.json();
+    if (!response.ok) {
+        const { error_msg: errorMsg, moreInfo } = data;
+        throw new Error(`${errorMsg}, for more info: ${moreInfo}`);
+    }
+    return data.customer.ref;
+}

package/dist/esm/src/lib/init/get-proxy-settings.d.ts

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

package/dist/esm/src/lib/init/get-proxy-settings.js

@@ -0,0 +1,31 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { fetchWithTimeout } from '@sitecore-cloudsdk/utils';
+import { LIBRARY_VERSION } from '../consts';
+import { constructGetProxySettingsUrl } from './construct-get-proxy-settings-url';
+/**
+ * Gets the browser ID and Client Key from Sitecore Edge Proxy
+ * @param sitecoreEdgeContextId - The sitecoreEdgeContextId
+ * @param timeout - The timeout for the call to proxy
+ * @returns the browser ID and Client Key
+ */
+export async function getProxySettings(sitecoreEdgeContextId, timeout) {
+    const fetchOptions = {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        headers: { 'X-Library-Version': LIBRARY_VERSION },
+    };
+    let response;
+    if (timeout !== undefined) {
+        response = await fetchWithTimeout(constructGetProxySettingsUrl(sitecoreEdgeContextId), timeout, fetchOptions);
+    }
+    else {
+        response = await fetch(constructGetProxySettingsUrl(sitecoreEdgeContextId), fetchOptions)
+            .then((res) => res.json())
+            .then((data) => data)
+            .catch(() => undefined);
+    }
+    if (!response)
+        return { browserId: '', clientKey: '' };
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    const { client_key: clientKey, ref: browserId } = response;
+    return { browserId, clientKey };
+}

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

@@ -0,0 +1,21 @@
+import { IHttpResponse, IMiddlewareNextResponse, TRequest } from '@sitecore-cloudsdk/utils';
+import { ISettings, ISettingsParamsServer } from '../settings/interfaces';
+export declare function setCoreSettings(settings: ISettings): void;
+/**
+ * Initializes the core settings for browser-based applications.
+ *
+ * This function initializes core settings for the application, including creating settings and handling cookies if enabled.
+ *
+ * @param settingsInput - The settings input to configure the core settings.
+ * @returns A Promise that resolves when initialization is complete.
+ */
+export declare function getSettingsServer(): ISettings;
+/**
+ * Initializes the core settings for browser-based applications.
+ *
+ * This function initializes core settings for the application, including creating settings and handling cookies if enabled.
+ *
+ * @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>;

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

@@ -0,0 +1,41 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { handleServerCookie } from '../cookie/handle-server-cookie';
+import { createSettings } from '../settings/create-settings';
+/**
+ * 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;
+export function setCoreSettings(settings) {
+    coreSettings = settings;
+}
+/**
+ * Initializes the core settings for browser-based applications.
+ *
+ * This function initializes core settings for the application, including creating settings and handling cookies if enabled.
+ *
+ * @param settingsInput - The settings input to configure the core settings.
+ * @returns A Promise that resolves when initialization is complete.
+ */
+export function getSettingsServer() {
+    if (!coreSettings) {
+        throw Error('[IE-0005] You must first initialize the "core" module. Run the "initServer" function.');
+    }
+    return coreSettings;
+}
+/**
+ * Initializes the core settings for browser-based applications.
+ *
+ * This function initializes core settings for the application, including creating settings and handling cookies if enabled.
+ *
+ * @param settingsInput - The settings input to configure the core settings.
+ * @returns A Promise that resolves when initialization is complete.
+ */
+export async function initCoreServer(settingsInput, request, response) {
+    if (!coreSettings)
+        coreSettings = createSettings(settingsInput);
+    if (settingsInput.enableServerCookie) {
+        await handleServerCookie(request, response, settingsInput.timeout);
+    }
+}

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

@@ -0,0 +1,32 @@
+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;
+/**
+ * Retrieves the core settings object.
+ *
+ * This function ensures that the core settings have been initialized and contain essential properties like `clientKey`, `cookieSettings`, and `targetURL`.
+ *
+ * @returns The core settings object.
+ * @throws Error if the core settings haven't been initialized with the required properties.
+ */
+export declare function getSettings(): ISettings;
+/**
+ * Initializes the core settings for browser-based applications.
+ *
+ * This function initializes core settings for the application, including creating settings and handling cookies if enabled.
+ *
+ * @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>;

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

@@ -0,0 +1,62 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { createCookie } from '../cookie/create-cookie';
+import { createSettings } from '../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
+export 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 || (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;
+export function setInitStatus(status) {
+    initStatus = status;
+}
+export function setCoreSettings(settings) {
+    coreSettings = settings;
+}
+/**
+ * Retrieves the core settings object.
+ *
+ * This function ensures that the core settings have been initialized and contain essential properties like `clientKey`, `cookieSettings`, and `targetURL`.
+ *
+ * @returns The core settings object.
+ * @throws Error if the core settings haven't been initialized with the required properties.
+ */
+export function getSettings() {
+    if (!coreSettings) {
+        throw Error(`[IE-0004] You must first initialize the "core" module. Run the "init" function.`);
+    }
+    return coreSettings;
+}
+/**
+ * Initializes the core settings for browser-based applications.
+ *
+ * This function initializes core settings for the application, including creating settings and handling cookies if enabled.
+ *
+ * @param settingsInput - The settings input to configure the core settings.
+ * @returns A Promise that resolves when initialization is complete.
+ */
+export async function initCore(settingsInput) {
+    if (initStatus != INIT_STATUSES.NOT_STARTED)
+        return;
+    setInitStatus(INIT_STATUSES.INITIALIZING);
+    coreSettings = createSettings(settingsInput);
+    setCoreSettings(coreSettings);
+    if (settingsInput.enableBrowserCookie) {
+        await createCookie(coreSettings);
+    }
+    setInitStatus(INIT_STATUSES.DONE);
+}

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

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

package/dist/esm/src/lib/interfaces.js

@@ -0,0 +1,2 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+export {};

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

@@ -0,0 +1,7 @@
+import { ISettings, ISettingsParams } 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
+ */
+export declare function createSettings(settingsInput: ISettingsParams): ISettings;

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

@@ -0,0 +1,22 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { DEFAULT_COOKIE_EXPIRY_DAYS } from '../consts';
+import { validateSettings } from './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
+ */
+export function createSettings(settingsInput) {
+    validateSettings(settingsInput);
+    const { siteName, sitecoreEdgeContextId, cookieDomain, cookiePath, cookieExpiryDays } = settingsInput;
+    return {
+        cookieSettings: {
+            cookieDomain,
+            cookieExpiryDays: cookieExpiryDays || DEFAULT_COOKIE_EXPIRY_DAYS,
+            cookieName: '',
+            cookiePath: cookiePath || '/',
+        },
+        siteName,
+        sitecoreEdgeContextId,
+    };
+}

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

@@ -0,0 +1,61 @@
+/**
+ * Extends the global settings object with additional properties
+ */
+export interface ISettings extends IBasicSettings {
+    cookieSettings: ICookieSettings;
+}
+export interface ISettingsParamsBrowser extends ISettingsParams {
+    enableBrowserCookie?: boolean;
+}
+export interface ISettingsParamsServer extends ISettingsParams {
+    enableServerCookie?: boolean;
+}
+export interface ISettingsParams extends IBasicSettings, ICookieSettingsInput {
+    timeout?: number;
+}
+/**
+ * Properties for the global settings object
+ */
+interface IBasicSettings {
+    sitecoreEdgeContextId: string;
+    siteName: string;
+}
+interface ICookieSettingsInput {
+    cookiePath?: string;
+    cookieExpiryDays?: number;
+    cookieDomain?: string;
+}
+/**
+ * Properties for the cookie object
+ */
+export interface ICookieSettings {
+    cookieName: string;
+    cookieDomain?: string;
+    cookieExpiryDays: number;
+    cookiePath?: string;
+}
+/**
+ * Properties for the cookie object
+ */
+export interface ICookieSettingsBrowser extends ICookieSettings {
+    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/esm/src/lib/settings/interfaces.js

@@ -0,0 +1,2 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+export {};

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

@@ -0,0 +1,10 @@
+import { ISettingsParams } from './interfaces';
+/**
+ * Validates the core settings to ensure they meet required criteria.
+ *
+ * This function validates the provided core settings object to ensure that essential properties such as "sitecoreEdgeContextId," and "siteName" meet specific criteria and are not empty.
+ *
+ * @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;

package/dist/esm/src/lib/settings/validate-settings.js

@@ -0,0 +1,15 @@
+/**
+ * Validates the core settings to ensure they meet required criteria.
+ *
+ * This function validates the provided core settings object to ensure that essential properties such as "sitecoreEdgeContextId," and "siteName" meet specific criteria and are not empty.
+ *
+ * @param settings - The core settings object to validate.
+ * @throws Error with specific error codes if any required property is missing or empty.
+ */
+export function validateSettings(settings) {
+    const { sitecoreEdgeContextId, siteName } = settings;
+    if (!sitecoreEdgeContextId || sitecoreEdgeContextId.trim().length === 0)
+        throw new Error(`[MV-0001] "sitecoreEdgeContextId" is required.`);
+    if (!siteName || siteName.trim().length === 0)
+        throw new Error(`[MV-0002] "siteName" is required.`);
+}