@sitecore-cloudsdk/core 0.1.0-rc.0

package/README.md

@@ -0,0 +1,11 @@
+# core
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build core` to build the library.
+
+## Running unit tests
+
+Run `nx test core` to execute the unit tests via [Jest](https://jestjs.io).

package/dist/cjs/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "@sitecore-cloudsdk/core",
+    "version": "0.1.0-rc.0",
+    "license": "Apache-2.0",
+    "main": "dist/cjs/src/index.js",
+    "module": "dist/esm/src/index.js",
+    "types": "dist/esm/src/index.d.ts",
+    "exports": {
+        ".": {
+            "types": {
+                "require": "./dist/cjs/src/index.d.ts",
+                "default": "./dist/esm/src/index.d.ts"
+            },
+            "import": "./dist/esm/src/index.js",
+            "require": "./dist/cjs/src/index.js"
+        }
+    },
+    "dependencies": {
+        "@sitecore-cloudsdk/utils": "0.x"
+    },
+    "scripts": {
+        "build": "npm run build:cjs && npm run build:es",
+        "build:cjs": "tsc -b tsconfig.cjs.json",
+        "build:es": "tsc -b ."
+    },
+    "files": [
+        "dist",
+        "README.md"
+    ]
+}

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

@@ -0,0 +1,18 @@
+export { createCookie } from './lib/cookie/create-cookie';
+export { getBrowserIdFromMiddlewareRequest } from './lib/cookie/get-browser-id-from-middleware-request';
+export { getDefaultCookieAttributes } from './lib/cookie/get-default-cookie-attributes';
+export { handleHttpCookie } from './lib/cookie/handle-http-cookie';
+export { handleNextJsMiddlewareCookie } from './lib/cookie/handle-next-js-middleware-cookie';
+export { handleServerCookie } from './lib/cookie/handle-server-cookie';
+export { getBrowserId } from './lib/init/get-browser-id';
+export { getProxySettings } from './lib/init/get-proxy-settings';
+export { getGuestId } from './lib/init/get-guest-id';
+export { createSettings } from './lib/settings/create-settings';
+export { getSettings, initCore } from './lib/init/init-core';
+export { getSettingsServer, initCoreServer } from './lib/init/init-core-server';
+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, BID_PREFIX, DAILY_SECONDS, DEFAULT_COOKIE_EXPIRY_DAYS, LIBRARY_VERSION, TARGET_URL, } from './lib/consts';
+export type { ICdpResponse, IInfer } from './lib/interfaces';
+export type { ICookieSettings, ISettings, ISettingsParamsBrowser, ISettingsParamsServer, IWebExperiencesSettings, IWebPersonalizationConfig, } from './lib/settings/interfaces';

package/dist/cjs/src/index.js

@@ -0,0 +1,44 @@
+"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.TARGET_URL = exports.LIBRARY_VERSION = exports.DEFAULT_COOKIE_EXPIRY_DAYS = exports.DAILY_SECONDS = exports.BID_PREFIX = exports.API_VERSION = exports.getBrowserIdFromRequest = exports.pageName = exports.language = exports.validateSettings = exports.initCoreServer = exports.getSettingsServer = exports.initCore = exports.getSettings = exports.createSettings = exports.getGuestId = exports.getProxySettings = exports.getBrowserId = exports.handleServerCookie = exports.handleNextJsMiddlewareCookie = exports.handleHttpCookie = exports.getDefaultCookieAttributes = exports.getBrowserIdFromMiddlewareRequest = exports.createCookie = void 0;
+var create_cookie_1 = require("./lib/cookie/create-cookie");
+Object.defineProperty(exports, "createCookie", { enumerable: true, get: function () { return create_cookie_1.createCookie; } });
+var get_browser_id_from_middleware_request_1 = require("./lib/cookie/get-browser-id-from-middleware-request");
+Object.defineProperty(exports, "getBrowserIdFromMiddlewareRequest", { enumerable: true, get: function () { return get_browser_id_from_middleware_request_1.getBrowserIdFromMiddlewareRequest; } });
+var get_default_cookie_attributes_1 = require("./lib/cookie/get-default-cookie-attributes");
+Object.defineProperty(exports, "getDefaultCookieAttributes", { enumerable: true, get: function () { return get_default_cookie_attributes_1.getDefaultCookieAttributes; } });
+var handle_http_cookie_1 = require("./lib/cookie/handle-http-cookie");
+Object.defineProperty(exports, "handleHttpCookie", { enumerable: true, get: function () { return handle_http_cookie_1.handleHttpCookie; } });
+var handle_next_js_middleware_cookie_1 = require("./lib/cookie/handle-next-js-middleware-cookie");
+Object.defineProperty(exports, "handleNextJsMiddlewareCookie", { enumerable: true, get: function () { return handle_next_js_middleware_cookie_1.handleNextJsMiddlewareCookie; } });
+var handle_server_cookie_1 = require("./lib/cookie/handle-server-cookie");
+Object.defineProperty(exports, "handleServerCookie", { enumerable: true, get: function () { return handle_server_cookie_1.handleServerCookie; } });
+var get_browser_id_1 = require("./lib/init/get-browser-id");
+Object.defineProperty(exports, "getBrowserId", { enumerable: true, get: function () { return get_browser_id_1.getBrowserId; } });
+var get_proxy_settings_1 = require("./lib/init/get-proxy-settings");
+Object.defineProperty(exports, "getProxySettings", { enumerable: true, get: function () { return get_proxy_settings_1.getProxySettings; } });
+var get_guest_id_1 = require("./lib/init/get-guest-id");
+Object.defineProperty(exports, "getGuestId", { enumerable: true, get: function () { return get_guest_id_1.getGuestId; } });
+var create_settings_1 = require("./lib/settings/create-settings");
+Object.defineProperty(exports, "createSettings", { enumerable: true, get: function () { return create_settings_1.createSettings; } });
+var init_core_1 = require("./lib/init/init-core");
+Object.defineProperty(exports, "getSettings", { enumerable: true, get: function () { return init_core_1.getSettings; } });
+Object.defineProperty(exports, "initCore", { enumerable: true, get: function () { return init_core_1.initCore; } });
+var init_core_server_1 = require("./lib/init/init-core-server");
+Object.defineProperty(exports, "getSettingsServer", { enumerable: true, get: function () { return init_core_server_1.getSettingsServer; } });
+Object.defineProperty(exports, "initCoreServer", { enumerable: true, get: function () { return init_core_server_1.initCoreServer; } });
+var validate_settings_1 = require("./lib/settings/validate-settings");
+Object.defineProperty(exports, "validateSettings", { enumerable: true, get: function () { return validate_settings_1.validateSettings; } });
+var infer_1 = require("./lib/infer/infer");
+Object.defineProperty(exports, "language", { enumerable: true, get: function () { return infer_1.language; } });
+Object.defineProperty(exports, "pageName", { enumerable: true, get: function () { return infer_1.pageName; } });
+var get_browser_id_from_request_1 = require("./lib/cookie/get-browser-id-from-request");
+Object.defineProperty(exports, "getBrowserIdFromRequest", { enumerable: true, get: function () { return get_browser_id_from_request_1.getBrowserIdFromRequest; } });
+var consts_1 = require("./lib/consts");
+Object.defineProperty(exports, "API_VERSION", { enumerable: true, get: function () { return consts_1.API_VERSION; } });
+Object.defineProperty(exports, "BID_PREFIX", { enumerable: true, get: function () { return consts_1.BID_PREFIX; } });
+Object.defineProperty(exports, "DAILY_SECONDS", { enumerable: true, get: function () { return consts_1.DAILY_SECONDS; } });
+Object.defineProperty(exports, "DEFAULT_COOKIE_EXPIRY_DAYS", { enumerable: true, get: function () { return consts_1.DEFAULT_COOKIE_EXPIRY_DAYS; } });
+Object.defineProperty(exports, "LIBRARY_VERSION", { enumerable: true, get: function () { return consts_1.LIBRARY_VERSION; } });
+Object.defineProperty(exports, "TARGET_URL", { enumerable: true, get: function () { return consts_1.TARGET_URL; } });

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

@@ -0,0 +1,6 @@
+export declare const LIBRARY_VERSION: string;
+export declare const BID_PREFIX = "bid_";
+export declare const DEFAULT_COOKIE_EXPIRY_DAYS = 730;
+export declare const DAILY_SECONDS = 86400;
+export declare const API_VERSION = "v1.2";
+export declare const TARGET_URL = "https://edge-platform.sitecorecloud.io";

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

@@ -0,0 +1,15 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TARGET_URL = exports.API_VERSION = exports.DAILY_SECONDS = exports.DEFAULT_COOKIE_EXPIRY_DAYS = exports.BID_PREFIX = exports.LIBRARY_VERSION = void 0;
+/* eslint-disable @typescript-eslint/naming-convention */
+const package_json_1 = __importDefault(require("../../package.json"));
+exports.LIBRARY_VERSION = package_json_1.default.version;
+exports.BID_PREFIX = 'bid_';
+exports.DEFAULT_COOKIE_EXPIRY_DAYS = 730;
+exports.DAILY_SECONDS = 86400;
+exports.API_VERSION = 'v1.2';
+exports.TARGET_URL = 'https://edge-platform.sitecorecloud.io';

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

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

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

@@ -0,0 +1,23 @@
+"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.createCookie = void 0;
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const get_default_cookie_attributes_1 = require("./get-default-cookie-attributes");
+const get_proxy_settings_1 = require("../init/get-proxy-settings");
+const consts_1 = require("../consts");
+/**
+ * Creates and adds the cookie to the document
+ * @param sitecoreEdgeContextId - The sitecoreEdgeContextId from global settings
+ * @param settings - The ICookieSettings settings object
+ * @returns - browserId or undefined on error
+ */
+async function createCookie(settings) {
+    const { browserId, clientKey } = await (0, get_proxy_settings_1.getProxySettings)(settings.sitecoreEdgeContextId);
+    settings.cookieSettings.cookieName = `${consts_1.BID_PREFIX}${clientKey}`;
+    if ((0, utils_1.cookieExists)(window.document.cookie, settings.cookieSettings.cookieName) || !browserId)
+        return;
+    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

@@ -0,0 +1,11 @@
+import { IMiddlewareRequest } 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,
+ * and if not found, it checks for Next.js v13 cookie values.
+ *
+ * @param request - The Middleware Request object.
+ * @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;

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

@@ -0,0 +1,24 @@
+"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.getBrowserIdFromMiddlewareRequest = void 0;
+/**
+ * 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,
+ * and if not found, it checks for Next.js v13 cookie values.
+ *
+ * @param request - The Middleware Request object.
+ * @param cookieName - The name of the cookie to retrieve.
+ * @returns The browser ID extracted from the cookie, or undefined if not found.
+ */
+function getBrowserIdFromMiddlewareRequest(request, cookieName) {
+    const cookieValueFromRequest = request.cookies.get(cookieName);
+    // It checks nextjs v12 cookie values
+    if (typeof cookieValueFromRequest === 'string')
+        return cookieValueFromRequest;
+    // It checks nextjs v13 cookie values
+    if (typeof cookieValueFromRequest === 'object')
+        return cookieValueFromRequest.value;
+    return undefined;
+}
+exports.getBrowserIdFromMiddlewareRequest = getBrowserIdFromMiddlewareRequest;

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

@@ -0,0 +1,9 @@
+import { TRequest } from '@sitecore-cloudsdk/utils';
+/**
+ * Retrieves the browser ID from the provided request object ('T'), using the specified 'cookieName'.
+ *
+ * @param request - The request object, either a Middleware Request or an HTTP Request.
+ * @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;

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBrowserIdFromRequest = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const get_browser_id_from_middleware_request_1 = require("./get-browser-id-from-middleware-request");
+/**
+ * Retrieves the browser ID from the provided request object ('T'), using the specified 'cookieName'.
+ *
+ * @param request - The request object, either a Middleware Request or an HTTP Request.
+ * @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.
+ */
+function getBrowserIdFromRequest(request, cookieName) {
+    let bid = undefined;
+    if ((0, utils_1.isNextJsMiddlewareRequest)(request)) {
+        bid = (0, get_browser_id_from_middleware_request_1.getBrowserIdFromMiddlewareRequest)(request, cookieName);
+    }
+    else if ((0, utils_1.isHttpRequest)(request)) {
+        const cookieHeader = request.headers.cookie;
+        bid = (0, utils_1.getCookieServerSide)(cookieHeader, cookieName)?.value;
+    }
+    return bid ?? '';
+}
+exports.getBrowserIdFromRequest = getBrowserIdFromRequest;

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

@@ -0,0 +1,7 @@
+/**
+ * Gets the default Cookie Attributes
+ * @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;

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

@@ -0,0 +1,21 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+/**
+ * Gets the default Cookie Attributes
+ * @param  maxAge - Set the cookie "Max-Age" attribute in days.
+ * @returns the default configuration settings for the cookie string
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultCookieAttributes = void 0;
+const consts_1 = require("../consts");
+// eslint-disable-next-line max-len
+function getDefaultCookieAttributes(maxAge = consts_1.DEFAULT_COOKIE_EXPIRY_DAYS, cookieDomain) {
+    return {
+        domain: cookieDomain,
+        maxAge: maxAge * consts_1.DAILY_SECONDS,
+        path: '/',
+        sameSite: 'None',
+        secure: true,
+    };
+}
+exports.getDefaultCookieAttributes = getDefaultCookieAttributes;

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

@@ -0,0 +1,13 @@
+import type { IHttpRequest, IHttpResponse } from '@sitecore-cloudsdk/utils';
+import { ISettings } from '../settings/interfaces';
+/**
+ * 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 declare function handleHttpCookie(request: IHttpRequest, response: IHttpResponse, options: ISettings, cookieTempValue: string): void;

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

@@ -0,0 +1,35 @@
+"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.handleHttpCookie = void 0;
+const get_default_cookie_attributes_1 = require("./get-default-cookie-attributes");
+const utils_1 = require("@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.
+ */
+function handleHttpCookie(request, response, options, cookieTempValue) {
+    const { cookieName } = options.cookieSettings;
+    const cookieValueFromRequest = request.headers.cookie;
+    let cookie;
+    let cookieValue;
+    if (cookieValueFromRequest) {
+        cookie = (0, utils_1.getCookieServerSide)(cookieValueFromRequest, cookieName);
+        if (cookie)
+            cookieValue = cookie.value;
+    }
+    if (!cookieValue)
+        cookieValue = cookieTempValue;
+    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)
+        request.headers.cookie = cookieValueFromRequest ? cookieValueFromRequest + '; ' + cookieString : cookieString;
+    response.setHeader('Set-Cookie', cookieString);
+}
+exports.handleHttpCookie = handleHttpCookie;

package/dist/cjs/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/cjs/src/lib/cookie/handle-next-js-middleware-cookie.js

@@ -0,0 +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.handleNextJsMiddlewareCookie = void 0;
+const get_browser_id_from_middleware_request_1 = require("./get-browser-id-from-middleware-request");
+const get_default_cookie_attributes_1 = require("./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.
+ *
+ */
+function handleNextJsMiddlewareCookie(request, response, options, cookieTempValue) {
+    const { cookieName } = options.cookieSettings;
+    const cookieValue = (0, get_browser_id_from_middleware_request_1.getBrowserIdFromMiddlewareRequest)(request, cookieName) ?? cookieTempValue;
+    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);
+}
+exports.handleNextJsMiddlewareCookie = handleNextJsMiddlewareCookie;

package/dist/cjs/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/cjs/src/lib/cookie/handle-server-cookie.js

@@ -0,0 +1,32 @@
+"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.handleServerCookie = void 0;
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const init_core_server_1 = require("../init/init-core-server");
+const handle_next_js_middleware_cookie_1 = require("./handle-next-js-middleware-cookie");
+const handle_http_cookie_1 = require("./handle-http-cookie");
+const get_proxy_settings_1 = require("../init/get-proxy-settings");
+const consts_1 = require("../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.
+ */
+async function handleServerCookie(request, response, timeout) {
+    const settings = (0, init_core_server_1.getSettingsServer)();
+    const { browserId, clientKey } = await (0, get_proxy_settings_1.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 = `${consts_1.BID_PREFIX}${clientKey}`;
+    if ((0, utils_1.isNextJsMiddlewareRequest)(request) && (0, utils_1.isNextJsMiddlewareResponse)(response)) {
+        (0, handle_next_js_middleware_cookie_1.handleNextJsMiddlewareCookie)(request, response, settings, browserId);
+    }
+    else if ((0, utils_1.isHttpRequest)(request) && (0, utils_1.isHttpResponse)(response)) {
+        (0, handle_http_cookie_1.handleHttpCookie)(request, response, settings, browserId);
+    }
+}
+exports.handleServerCookie = handleServerCookie;

package/dist/cjs/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/cjs/src/lib/infer/infer.js

@@ -0,0 +1,26 @@
+"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.pageName = exports.language = void 0;
+/**
+ * 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
+ */
+function language() {
+    return typeof window === 'undefined' || window.document.documentElement.lang.length <= 1
+        ? undefined
+        : new Intl.Locale(window.document.documentElement.lang).language.toLocaleUpperCase();
+}
+exports.language = language;
+/**
+ * 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
+ */
+function pageName() {
+    if (typeof window === 'undefined')
+        return '';
+    return window.location.pathname === '/' ? 'Home Page' : window.location.pathname.split('/').pop();
+}
+exports.pageName = pageName;

package/dist/cjs/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/cjs/src/lib/init/construct-get-proxy-settings-url.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constructGetProxySettingsUrl = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const consts_1 = require("../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
+ */
+function constructGetProxySettingsUrl(sitecoreEdgeContextId) {
+    return `${consts_1.TARGET_URL}/events/${consts_1.API_VERSION}/browser/create.json?sitecoreContextId=${sitecoreEdgeContextId}&client_key=`;
+}
+exports.constructGetProxySettingsUrl = constructGetProxySettingsUrl;

package/dist/cjs/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/cjs/src/lib/init/get-browser-id.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBrowserId = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const init_core_1 = require("./init-core");
+/**
+ * Get the browser ID from the cookie
+ * @returns The browser ID if the cookie exists
+ */
+function getBrowserId() {
+    const settings = (0, init_core_1.getSettings)();
+    return (0, utils_1.getCookieValueClientSide)(settings.cookieSettings.cookieName);
+}
+exports.getBrowserId = getBrowserId;

package/dist/cjs/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/cjs/src/lib/init/get-guest-id.js

@@ -0,0 +1,25 @@
+"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.getGuestId = void 0;
+const consts_1 = require("../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
+ */
+async function getGuestId(browserId, sitecoreEdgeContextId) {
+    // eslint-disable-next-line max-len
+    const url = `${consts_1.TARGET_URL}/events/${consts_1.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': consts_1.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;
+}
+exports.getGuestId = getGuestId;

package/dist/cjs/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/cjs/src/lib/init/get-proxy-settings.js

@@ -0,0 +1,35 @@
+"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.getProxySettings = void 0;
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const consts_1 = require("../consts");
+const construct_get_proxy_settings_url_1 = require("./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
+ */
+async function getProxySettings(sitecoreEdgeContextId, timeout) {
+    const fetchOptions = {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        headers: { 'X-Library-Version': consts_1.LIBRARY_VERSION },
+    };
+    let response;
+    if (timeout !== undefined) {
+        response = await (0, utils_1.fetchWithTimeout)((0, construct_get_proxy_settings_url_1.constructGetProxySettingsUrl)(sitecoreEdgeContextId), timeout, fetchOptions);
+    }
+    else {
+        response = await fetch((0, construct_get_proxy_settings_url_1.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 };
+}
+exports.getProxySettings = getProxySettings;

package/dist/cjs/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>;