@sitecore-cloudsdk/core 0.3.1 → 0.4.0-rc.0

package/README.md

@@ -1,3 +1,77 @@
 # core
 
-This is an internal package used by other Sitecore Cloud SDK packages.
+This package is for initializing the Cloud SDK and its other packages in your app.
+
+## Installation
+
+```bash
+npm install @sitecore-cloudsdk/core
+```
+
+To initialize other Cloud SDK packages, first install them:
+
+```bash
+npm install @sitecore-cloudsdk/events
+npm install @sitecore-cloudsdk/personalize
+```
+
+## Usage
+
+1. Import the modules of all installed Cloud SDK packages that you want to initialize.
+2. Initialize the Cloud SDK and its packages using the `CloudSDK` function, available in the `core` package.
+
+## Code examples
+
+Initialize the Cloud SDK and its packages on the browser side:
+
+```tsx
+'use client';
+
+import { useEffect } from 'react';
+import { CloudSDK } from '@sitecore-cloudsdk/core/browser';
+import '@sitecore-cloudsdk/events/browser';
+import '@sitecore-cloudsdk/personalize/browser';
+
+export default function Home() {
+  useEffect(() => {
+    CloudSDK({
+      sitecoreEdgeContextId: '<YOUR_CONTEXT_ID>',
+      siteName: '<YOUR_SITE_NAME>',
+      enableBrowserCookie: true
+    })
+      .addEvents() // Initialize the `events` package.
+      .addPersonalize({ enablePersonalizeCookie: true, webPersonalization: true }) // Initialize the `personalize` package and enable web personalization.
+      .initialize();
+  }, []);
+
+  return <></>;
+}
+```
+
+Initialize the Cloud SDK and its packages on the server side:
+
+```ts
+import type { NextRequest, NextResponse } from 'next/server';
+import { CloudSDK } from '@sitecore-cloudsdk/core/server';
+import '@sitecore-cloudsdk/events/browser';
+import '@sitecore-cloudsdk/personalize/browser';
+
+export async function middleware(request: NextRequest) {
+  const response = NextResponse.next();
+
+  await CloudSDK(request, response, {
+    sitecoreEdgeContextId: '<YOUR_CONTEXT_ID>',
+    siteName: '<YOUR_SITE_NAME>',
+    enableServerCookie: true
+  })
+    .addEvents() // Initialize the `events` package.
+    .addPersonalize({ enablePersonalizeCookie: true }) // Initialize the `personalize` package.
+    .initialize();
+
+  return response;
+}
+```
+
+## Documentation
+
+[Official Sitecore Cloud SDK documentation](https://doc.sitecore.com/xmc/en/developers/sdk/latest/cloud-sdk/index.html)

package/browser.cjs

@@ -0,0 +1,3 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+'use strict';
+module.exports = require('./dist/cjs/src/browser');

package/browser.d.ts

@@ -0,0 +1,2 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+export * from './dist/esm/src/browser';

package/browser.js

@@ -0,0 +1,3 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+'use strict';
+export * from './dist/esm/src/browser';

package/dist/cjs/package.json

@@ -1,22 +1,26 @@
 {
     "name": "@sitecore-cloudsdk/core",
-    "version": "0.3.1",
+    "version": "0.4.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"
+        "./browser": {
+            "import": "./browser.js",
+            "require": "./browser.cjs",
+            "types": "./browser.d.ts"
+        },
+        "./server": {
+            "import": "./server.js",
+            "require": "./server.cjs",
+            "types": "./server.d.ts"
+        },
+        "./internal": {
+            "types": "./internal.d.ts",
+            "import": "./internal.js",
+            "require": "./internal.js"
         }
     },
     "dependencies": {
-        "@sitecore-cloudsdk/utils": "^0.3.1",
+        "@sitecore-cloudsdk/utils": "^0.4.0-rc.0",
         "debug": "^4.3.4"
     },
     "scripts": {
@@ -26,7 +30,16 @@
     },
     "files": [
         "dist",
-        "README.md"
+        "README.md",
+        "browser.js",
+        "browser.cjs",
+        "browser.d.ts",
+        "server.js",
+        "server.cjs",
+        "server.d.ts",
+        "internal.js",
+        "internal.cjs",
+        "internal.d.ts"
     ],
     "engines": {
         "node": ">=18"

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

@@ -0,0 +1,5 @@
+export { CloudSDKBrowserInitializer } from './lib/initializer/browser/initializer';
+export type { Settings } from './lib/initializer/browser/interfaces';
+export { CloudSDK } from './lib/initializer/browser/initializer';
+export { getBrowserId } from './lib/browser-id/get-browser-id';
+export { getGuestId } from './lib/guest-id/get-guest-id';

package/dist/cjs/src/browser.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGuestId = exports.getBrowserId = exports.CloudSDK = exports.CloudSDKBrowserInitializer = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+var initializer_1 = require("./lib/initializer/browser/initializer");
+Object.defineProperty(exports, "CloudSDKBrowserInitializer", { enumerable: true, get: function () { return initializer_1.CloudSDKBrowserInitializer; } });
+var initializer_2 = require("./lib/initializer/browser/initializer");
+Object.defineProperty(exports, "CloudSDK", { enumerable: true, get: function () { return initializer_2.CloudSDK; } });
+var get_browser_id_1 = require("./lib/browser-id/get-browser-id");
+Object.defineProperty(exports, "getBrowserId", { enumerable: true, get: function () { return get_browser_id_1.getBrowserId; } });
+var get_guest_id_1 = require("./lib/guest-id/get-guest-id");
+Object.defineProperty(exports, "getGuestId", { enumerable: true, get: function () { return get_guest_id_1.getGuestId; } });

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

@@ -0,0 +1,38 @@
+export { createCookies } from './lib/cookie/create-cookies';
+export { getCookieValueFromMiddlewareRequest } from './lib/cookie/get-cookie-value-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 { getGuestId } from './lib/init/get-guest-id';
+export { createSettings } from './lib/settings/create-settings';
+export { getSettings, initCore } from './lib/init/init-core';
+export { validateSettings } from './lib/settings/validate-settings';
+export { language, pageName } from './lib/infer/infer';
+export { getCookieValueFromRequest } from './lib/cookie/get-cookie-value-from-request';
+export { handleGetSettingsError } from './lib/settings/handle-get-settings-error';
+export { generateCorrelationId } from './lib/correlation-id/generate-correlation-id';
+export { debug, processDebugResponse } from './lib/debug/debug';
+export { API_VERSION, COOKIE_NAME_PREFIX, DAILY_SECONDS, DEFAULT_COOKIE_EXPIRY_DAYS, LIBRARY_VERSION, SITECORE_EDGE_URL, CORRELATION_ID_HEADER } from './lib/consts';
+export type { EPResponse, Infer, DebugResponse } from './lib/interfaces';
+export type { CookieSettings, Settings, BasicSettings } from './lib/settings/interfaces';
+export { getCloudSDKSettings as getCloudSDKSettingsBrowser } from './lib/initializer/browser/initializer';
+export { getEnabledPackage as getEnabledPackageBrowser } from './lib/initializer/browser/initializer';
+export { enabledPackages as enabledPackagesBrowser } from './lib/initializer/browser/initializer';
+export { builderInstance as builderInstanceBrowser } from './lib/initializer/browser/initializer';
+export type { PackageContextDependency as PackageContextDependencyBrowser } from './lib/initializer/browser/interfaces';
+export { fetchBrowserIdFromEdgeProxy } from './lib/browser-id/fetch-browser-id-from-edge-proxy';
+export { PackageInitializer } from './lib/initializer/browser/package-initializer';
+export { initCoreState } from './lib/initializer/browser/initializer';
+export type { BrowserSettings } from './lib/settings/interfaces';
+export { getBrowserId } from './lib/browser-id/get-browser-id';
+export { getCookiesValuesFromEdge as getCookiesValuesFromEdgeBrowser } from './lib/initializer/browser/initializer';
+export { getCloudSDKSettings as getCloudSDKSettingsServer } from './lib/initializer/server/initializer';
+export { getEnabledPackage as getEnabledPackageServer } from './lib/initializer/server/initializer';
+export { enabledPackages as enabledPackagesServer } from './lib/initializer/server/initializer';
+export { builderInstance as builderInstanceServer } from './lib/initializer/server/initializer';
+export { PackageInitializerServer } from './lib/initializer/server/package-initializer';
+export { getSettingsServer, initCoreServer } from './lib/init/init-core-server';
+export { handleServerCookie } from './lib/cookie/handle-server-cookie';
+export type { ServerSettings } from './lib/settings/interfaces';
+export { getCloudSDKRequest, getCloudSDKResponse } from './lib/initializer/server/initializer';
+export { getCookiesValuesFromEdge as getCookiesValuesFromEdgeServer } from './lib/initializer/server/initializer';

package/dist/cjs/src/{index.js → internal.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CORRELATION_ID_HEADER = exports.SITECORE_EDGE_URL = exports.LIBRARY_VERSION = exports.DEFAULT_COOKIE_EXPIRY_DAYS = exports.DAILY_SECONDS = exports.COOKIE_NAME_PREFIX = exports.API_VERSION = exports.processDebugResponse = exports.debug = exports.generateCorrelationId = exports.handleGetSettingsError = exports.getCookieValueFromRequest = exports.pageName = exports.language = exports.validateSettings = exports.initCoreServer = exports.getSettingsServer = exports.initCore = exports.getSettings = exports.createSettings = exports.getGuestId = exports.fetchBrowserIdFromEdgeProxy = exports.getBrowserId = exports.handleServerCookie = exports.handleNextJsMiddlewareCookie = exports.handleHttpCookie = exports.getDefaultCookieAttributes = exports.getCookieValueFromMiddlewareRequest = exports.createCookies = void 0;
+exports.getCookiesValuesFromEdgeServer = exports.getCloudSDKResponse = exports.getCloudSDKRequest = exports.handleServerCookie = exports.initCoreServer = exports.getSettingsServer = exports.PackageInitializerServer = exports.builderInstanceServer = exports.enabledPackagesServer = exports.getEnabledPackageServer = exports.getCloudSDKSettingsServer = exports.getCookiesValuesFromEdgeBrowser = exports.getBrowserId = exports.initCoreState = exports.PackageInitializer = exports.fetchBrowserIdFromEdgeProxy = exports.builderInstanceBrowser = exports.enabledPackagesBrowser = exports.getEnabledPackageBrowser = exports.getCloudSDKSettingsBrowser = exports.CORRELATION_ID_HEADER = exports.SITECORE_EDGE_URL = exports.LIBRARY_VERSION = exports.DEFAULT_COOKIE_EXPIRY_DAYS = exports.DAILY_SECONDS = exports.COOKIE_NAME_PREFIX = exports.API_VERSION = exports.processDebugResponse = exports.debug = exports.generateCorrelationId = exports.handleGetSettingsError = exports.getCookieValueFromRequest = exports.pageName = exports.language = exports.validateSettings = exports.initCore = exports.getSettings = exports.createSettings = exports.getGuestId = exports.handleNextJsMiddlewareCookie = exports.handleHttpCookie = exports.getDefaultCookieAttributes = exports.getCookieValueFromMiddlewareRequest = exports.createCookies = void 0;
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 var create_cookies_1 = require("./lib/cookie/create-cookies");
 Object.defineProperty(exports, "createCookies", { enumerable: true, get: function () { return create_cookies_1.createCookies; } });
@@ -12,12 +12,6 @@ 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/cookie/get-browser-id");
-Object.defineProperty(exports, "getBrowserId", { enumerable: true, get: function () { return get_browser_id_1.getBrowserId; } });
-var fetch_browser_id_from_edge_proxy_1 = require("./lib/init/fetch-browser-id-from-edge-proxy");
-Object.defineProperty(exports, "fetchBrowserIdFromEdgeProxy", { enumerable: true, get: function () { return fetch_browser_id_from_edge_proxy_1.fetchBrowserIdFromEdgeProxy; } });
 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");
@@ -25,9 +19,6 @@ Object.defineProperty(exports, "createSettings", { enumerable: true, get: functi
 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");
@@ -50,3 +41,43 @@ Object.defineProperty(exports, "DEFAULT_COOKIE_EXPIRY_DAYS", { enumerable: true,
 Object.defineProperty(exports, "LIBRARY_VERSION", { enumerable: true, get: function () { return consts_1.LIBRARY_VERSION; } });
 Object.defineProperty(exports, "SITECORE_EDGE_URL", { enumerable: true, get: function () { return consts_1.SITECORE_EDGE_URL; } });
 Object.defineProperty(exports, "CORRELATION_ID_HEADER", { enumerable: true, get: function () { return consts_1.CORRELATION_ID_HEADER; } });
+// Browser
+var initializer_1 = require("./lib/initializer/browser/initializer");
+Object.defineProperty(exports, "getCloudSDKSettingsBrowser", { enumerable: true, get: function () { return initializer_1.getCloudSDKSettings; } });
+var initializer_2 = require("./lib/initializer/browser/initializer");
+Object.defineProperty(exports, "getEnabledPackageBrowser", { enumerable: true, get: function () { return initializer_2.getEnabledPackage; } });
+var initializer_3 = require("./lib/initializer/browser/initializer");
+Object.defineProperty(exports, "enabledPackagesBrowser", { enumerable: true, get: function () { return initializer_3.enabledPackages; } });
+var initializer_4 = require("./lib/initializer/browser/initializer");
+Object.defineProperty(exports, "builderInstanceBrowser", { enumerable: true, get: function () { return initializer_4.builderInstance; } });
+var fetch_browser_id_from_edge_proxy_1 = require("./lib/browser-id/fetch-browser-id-from-edge-proxy");
+Object.defineProperty(exports, "fetchBrowserIdFromEdgeProxy", { enumerable: true, get: function () { return fetch_browser_id_from_edge_proxy_1.fetchBrowserIdFromEdgeProxy; } });
+var package_initializer_1 = require("./lib/initializer/browser/package-initializer");
+Object.defineProperty(exports, "PackageInitializer", { enumerable: true, get: function () { return package_initializer_1.PackageInitializer; } });
+var initializer_5 = require("./lib/initializer/browser/initializer");
+Object.defineProperty(exports, "initCoreState", { enumerable: true, get: function () { return initializer_5.initCoreState; } });
+var get_browser_id_1 = require("./lib/browser-id/get-browser-id");
+Object.defineProperty(exports, "getBrowserId", { enumerable: true, get: function () { return get_browser_id_1.getBrowserId; } });
+var initializer_6 = require("./lib/initializer/browser/initializer");
+Object.defineProperty(exports, "getCookiesValuesFromEdgeBrowser", { enumerable: true, get: function () { return initializer_6.getCookiesValuesFromEdge; } });
+// Server
+var initializer_7 = require("./lib/initializer/server/initializer");
+Object.defineProperty(exports, "getCloudSDKSettingsServer", { enumerable: true, get: function () { return initializer_7.getCloudSDKSettings; } });
+var initializer_8 = require("./lib/initializer/server/initializer");
+Object.defineProperty(exports, "getEnabledPackageServer", { enumerable: true, get: function () { return initializer_8.getEnabledPackage; } });
+var initializer_9 = require("./lib/initializer/server/initializer");
+Object.defineProperty(exports, "enabledPackagesServer", { enumerable: true, get: function () { return initializer_9.enabledPackages; } });
+var initializer_10 = require("./lib/initializer/server/initializer");
+Object.defineProperty(exports, "builderInstanceServer", { enumerable: true, get: function () { return initializer_10.builderInstance; } });
+var package_initializer_2 = require("./lib/initializer/server/package-initializer");
+Object.defineProperty(exports, "PackageInitializerServer", { enumerable: true, get: function () { return package_initializer_2.PackageInitializerServer; } });
+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 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 initializer_11 = require("./lib/initializer/server/initializer");
+Object.defineProperty(exports, "getCloudSDKRequest", { enumerable: true, get: function () { return initializer_11.getCloudSDKRequest; } });
+Object.defineProperty(exports, "getCloudSDKResponse", { enumerable: true, get: function () { return initializer_11.getCloudSDKResponse; } });
+var initializer_12 = require("./lib/initializer/server/initializer");
+Object.defineProperty(exports, "getCookiesValuesFromEdgeServer", { enumerable: true, get: function () { return initializer_12.getCookiesValuesFromEdge; } });

package/dist/cjs/src/lib/{cookie → browser-id}/get-browser-id.js

@@ -4,12 +4,19 @@ 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/init-core");
+const initializer_1 = require("../initializer/browser/initializer");
 /**
  * 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.cookieNames.browserId);
+    if (initializer_1.initCoreState) {
+        const cloudSDKSettings = (0, initializer_1.getCloudSDKSettings)();
+        return (0, utils_1.getCookieValueClientSide)(cloudSDKSettings.cookieSettings.name.browserId);
+    }
+    else {
+        const settings = (0, init_core_1.getSettings)();
+        return (0, utils_1.getCookieValueClientSide)(settings.cookieSettings.cookieNames.browserId);
+    }
 }
 exports.getBrowserId = getBrowserId;

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

@@ -6,9 +6,12 @@ export declare const API_VERSION = "v1.2";
 export declare const SITECORE_EDGE_URL = "https://edge-platform.sitecorecloud.io";
 export declare const CORRELATION_ID_HEADER = "x-sc-correlation-id";
 export declare enum ErrorMessages {
+    IE_0001 = "[IE-0001] You are trying to run a browser-side function on the server side. On the server side, run the server-side equivalent of the function, available in \"server\" modules.",
     IE_0003 = "[IE-0003] Unable to set the \"sc_{SitecoreEdgeContextId}\" cookie because the browser ID could not be retrieved from the server. Make sure to set the correct values for \"sitecoreEdgeContextId\" and \"siteName\". If the issue persists, try again later or use try-catch blocks to handle this error.",
     IE_0008 = "[IE-0008] You must first initialize the \"core\" package. Run the \"init\" function.",
     IE_0011 = "[IE-0011] Unable to set the \"sc_{SitecoreEdgeContextId}_personalize\" cookie because the guest ID could not be retrieved from the server. Make sure to set the correct values for \"sitecoreEdgeContextId\" and \"siteName\". If the issue persists, try again later or use try-catch blocks to handle this error.",
+    IE_0012 = "[IE-0012] - You must first initialize the Cloud SDK. Import \"CloudSDK\" from \"@sitecore-cloudsdk/core/browser\", then run \"CloudSDK().initialize()\".",
+    IE_0013 = "[IE-0013] - You must first initialize the Cloud SDK. Import \"CloudSDK\" from \"@sitecore-cloudsdk/core/server\", then run \"await CloudSDK().initialize()\".",
     IV_0001 = "[IV-0001] Incorrect value for \"sitecoreEdgeUrl\". Set the value to a valid URL string.",
     MV_0001 = "[MV-0001] \"sitecoreEdgeContextId\" is required.",
     MV_0002 = "[MV-0002] \"siteName\" is required."

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

@@ -17,9 +17,12 @@ exports.CORRELATION_ID_HEADER = 'x-sc-correlation-id';
 /* eslint-disable max-len */
 var ErrorMessages;
 (function (ErrorMessages) {
+    ErrorMessages["IE_0001"] = "[IE-0001] You are trying to run a browser-side function on the server side. On the server side, run the server-side equivalent of the function, available in \"server\" modules.";
     ErrorMessages["IE_0003"] = "[IE-0003] Unable to set the \"sc_{SitecoreEdgeContextId}\" cookie because the browser ID could not be retrieved from the server. Make sure to set the correct values for \"sitecoreEdgeContextId\" and \"siteName\". If the issue persists, try again later or use try-catch blocks to handle this error.";
     ErrorMessages["IE_0008"] = "[IE-0008] You must first initialize the \"core\" package. Run the \"init\" function.";
     ErrorMessages["IE_0011"] = "[IE-0011] Unable to set the \"sc_{SitecoreEdgeContextId}_personalize\" cookie because the guest ID could not be retrieved from the server. Make sure to set the correct values for \"sitecoreEdgeContextId\" and \"siteName\". If the issue persists, try again later or use try-catch blocks to handle this error.";
+    ErrorMessages["IE_0012"] = "[IE-0012] - You must first initialize the Cloud SDK. Import \"CloudSDK\" from \"@sitecore-cloudsdk/core/browser\", then run \"CloudSDK().initialize()\".";
+    ErrorMessages["IE_0013"] = "[IE-0013] - You must first initialize the Cloud SDK. Import \"CloudSDK\" from \"@sitecore-cloudsdk/core/server\", then run \"await CloudSDK().initialize()\".";
     ErrorMessages["IV_0001"] = "[IV-0001] Incorrect value for \"sitecoreEdgeUrl\". Set the value to a valid URL string.";
     ErrorMessages["MV_0001"] = "[MV-0001] \"sitecoreEdgeContextId\" is required.";
     ErrorMessages["MV_0002"] = "[MV-0002] \"siteName\" is required.";

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

@@ -1,11 +1,11 @@
 "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.createCookies = 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 fetch_browser_id_from_edge_proxy_1 = require("../init/fetch-browser-id-from-edge-proxy");
-const get_default_cookie_attributes_1 = require("./get-default-cookie-attributes");
+const fetch_browser_id_from_edge_proxy_1 = require("../browser-id/fetch-browser-id-from-edge-proxy");
 const get_guest_id_1 = require("../init/get-guest-id");
+const get_default_cookie_attributes_1 = require("./get-default-cookie-attributes");
 /**
  * Creates and adds the cookie to the document
  * @param settings - The CookieSettings settings object

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

@@ -1,11 +1,10 @@
 "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 utils_1 = require("@sitecore-cloudsdk/utils");
-const fetch_browser_id_from_edge_proxy_1 = require("../init/fetch-browser-id-from-edge-proxy");
-const get_default_cookie_attributes_1 = require("./get-default-cookie-attributes");
+const fetch_browser_id_from_edge_proxy_1 = require("../browser-id/fetch-browser-id-from-edge-proxy");
 const get_guest_id_1 = require("../init/get-guest-id");
+const get_default_cookie_attributes_1 = require("./get-default-cookie-attributes");
 /**
  * Handles HTTP Cookie operations for setting the browser ID cookie in the request and response.
  *

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

@@ -1,11 +1,10 @@
 "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 fetch_browser_id_from_edge_proxy_1 = require("../init/fetch-browser-id-from-edge-proxy");
+const fetch_browser_id_from_edge_proxy_1 = require("../browser-id/fetch-browser-id-from-edge-proxy");
+const get_guest_id_1 = require("../init/get-guest-id");
 const get_cookie_value_from_middleware_request_1 = require("./get-cookie-value-from-middleware-request");
 const get_default_cookie_attributes_1 = require("./get-default-cookie-attributes");
-const get_guest_id_1 = require("../init/get-guest-id");
 /**
  * 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

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

@@ -0,0 +1,24 @@
+/**
+ * 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 fetchGuestIdFromEdgeProxy(browserId: string, sitecoreEdgeContextId: string, sitecoreEdgeUrl: string): Promise<string>;
+interface GetGuestRefCommon {
+    status: string;
+    version: string;
+    clientKey: string;
+}
+export interface GetGuestRefResponse extends GetGuestRefCommon {
+    ref: string;
+    customer: {
+        ref: string;
+    };
+}
+export interface GetGuestRefResponseError extends GetGuestRefCommon {
+    error_msg: string;
+    moreInfo: string;
+}
+export {};

package/dist/cjs/src/lib/guest-id/fetch-guest-id-from-edge-proxy.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.fetchGuestIdFromEdgeProxy = void 0;
+const consts_1 = require("../consts");
+/**
+ * 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
+ */
+async function fetchGuestIdFromEdgeProxy(browserId, sitecoreEdgeContextId, sitecoreEdgeUrl) {
+    // eslint-disable-next-line max-len
+    const url = `${sitecoreEdgeUrl}/v1/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}`);
+    }
+    if (!data.customer.ref)
+        throw new Error(consts_1.ErrorMessages.IE_0011);
+    return data.customer.ref;
+}
+exports.fetchGuestIdFromEdgeProxy = fetchGuestIdFromEdgeProxy;

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

@@ -0,0 +1,6 @@
+/**
+ * A function that returns the guest ID.
+ * @returns - A promise that resolves with the guest ID
+ * @throws - Will throw an error if the sitecoreEdgeContextId is incorrect
+ */
+export declare function getGuestId(): Promise<string>;

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGuestId = 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 initializer_1 = require("../initializer/browser/initializer");
+const fetch_guest_id_from_edge_proxy_1 = require("./fetch-guest-id-from-edge-proxy");
+/**
+ * A function that returns the guest ID.
+ * @returns - A promise that resolves with the guest ID
+ * @throws - Will throw an error if the sitecoreEdgeContextId is incorrect
+ */
+async function getGuestId() {
+    const settings = (0, initializer_1.getCloudSDKSettings)();
+    const id = (0, utils_1.getCookieValueClientSide)(settings.cookieSettings.name.browserId);
+    return (0, fetch_guest_id_from_edge_proxy_1.fetchGuestIdFromEdgeProxy)(id, settings.sitecoreEdgeContextId, settings.sitecoreEdgeUrl);
+}
+exports.getGuestId = getGuestId;

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

@@ -1,7 +1,7 @@
 "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;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 const consts_1 = require("../consts");
 /**
  * A function that gets the guest ref from EP.

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

@@ -9,6 +9,7 @@ export declare function setCoreSettings(settings: Settings): void;
  *
  * @param settingsInput - The settings input to configure the core settings.
  * @returns A Promise that resolves when initialization is complete.
+ * @deprecated Cloud SDK v0.4 introduces a new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code.The v0.3 initialization logic is now deprecated and will be removed in a future Cloud SDK release.
  */
 export declare function getSettingsServer(): Settings;
 /**

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

@@ -17,6 +17,7 @@ function setCoreSettings(settings) {
     coreSettings = settings;
 }
 exports.setCoreSettings = setCoreSettings;
+/* eslint-disable max-len */
 /**
  * Initializes the core settings for browser-based applications.
  *
@@ -25,7 +26,9 @@ exports.setCoreSettings = setCoreSettings;
  *
  * @param settingsInput - The settings input to configure the core settings.
  * @returns A Promise that resolves when initialization is complete.
+ * @deprecated Cloud SDK v0.4 introduces a new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code.The v0.3 initialization logic is now deprecated and will be removed in a future Cloud SDK release.
  */
+/* eslint-enable max-len */
 function getSettingsServer() {
     if (!coreSettings)
         throw Error(consts_1.ErrorMessages.IE_0008);

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

@@ -17,6 +17,7 @@ export declare function getSettings(): Settings;
  *
  * @param settingsInput - The settings input to configure the core settings.
  * @returns A Promise that resolves when initialization is complete.
+ * @deprecated Cloud SDK v0.4 introduces a new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code.The v0.3 initialization logic is now deprecated and will be removed in a future Cloud SDK release.
  */
 export declare function initCore(settingsInput: BrowserSettings): Promise<void>;
 /**
@@ -24,3 +25,17 @@ export declare function initCore(settingsInput: BrowserSettings): Promise<void>;
  */
 export declare function setCoreSettings(settings: Settings): void;
 export declare function setCookiePromise(promise: Promise<void>): void;
+interface Engage {
+    [key: string]: any;
+    getBrowserId?: () => string;
+    versions?: {
+        personalize?: string | undefined;
+        events?: string | undefined;
+    };
+}
+declare global {
+    interface Window {
+        Engage: Engage;
+    }
+}
+export {};

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

@@ -28,6 +28,7 @@ function getSettings() {
 }
 exports.getSettings = getSettings;
 let createCookiesPromise = null;
+/* eslint-disable max-len */
 /**
  * Initializes the core settings for browser-based applications.
  *
@@ -36,7 +37,9 @@ let createCookiesPromise = null;
  *
  * @param settingsInput - The settings input to configure the core settings.
  * @returns A Promise that resolves when initialization is complete.
+ * @deprecated Cloud SDK v0.4 introduces a new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code.The v0.3 initialization logic is now deprecated and will be removed in a future Cloud SDK release.
  */
+/* eslint-enable max-len */
 async function initCore(settingsInput) {
     (0, debug_1.debug)(namespaces_1.CORE_NAMESPACE)('coreClient library initialized');
     if (coreSettings === null)

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

@@ -0,0 +1,63 @@
+import type { ProxySettings } from '../../interfaces';
+import type { BrowserSettings, Core, Settings } from './interfaces';
+import type { PackageInitializer } from './package-initializer';
+export declare let cloudSDKSettings: Settings;
+export declare const enabledPackages: Map<string, PackageInitializer>;
+export declare let initCoreState: Promise<void> | null;
+export declare let cookiesValuesFromEdge: ProxySettings;
+export declare class CloudSDKBrowserInitializer {
+    /**
+     * Runs the initialization logic. Enables packages and create cookies for CloudSDK.
+     * @param settings - Common settings for the CloudSDK
+     * @throws the following errors:
+     * {@link ErrorMessages.MV_0001}
+     * {@link ErrorMessages.MV_0002}
+     * {@link ErrorMessages.IE_0001}
+     * {@link ErrorMessages.IV_0001}
+     */
+    constructor(settings: BrowserSettings);
+    /**
+     * Runs the initialization logic. Enables packages and create cookies for CloudSDK.
+     */
+    initialize(): void;
+    /**
+     * Runs any necessary side effects.
+     */
+    private sideEffects;
+    /**
+     * 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.
+     *
+     * @throws Error with specific error codes if any required property is missing or empty.
+     */
+    private validateSettings;
+    private createSettings;
+    private createCookies;
+}
+export declare function getCloudSDKSettings(): Settings;
+export declare function getEnabledPackage(packageName: string): PackageInitializer | undefined;
+export declare let builderInstance: null | CloudSDKBrowserInitializer;
+export declare function getCookiesValuesFromEdge(): ProxySettings;
+/**
+ * Runs the initialization logic. Enables packages and create cookies for CloudSDK.
+ * @param settings - Common settings for the CloudSDK
+ * @returns An instance of {@link CloudSDKBrowserInitializer}
+ * @throws the following errors:
+ * {@link ErrorMessages.MV_0001}
+ * {@link ErrorMessages.MV_0002}
+ * {@link ErrorMessages.IE_0001}
+ * {@link ErrorMessages.IV_0001}
+ */
+export declare function CloudSDK(settings: BrowserSettings): CloudSDKBrowserInitializer;
+declare global {
+    interface Personalize {
+    }
+    interface Window {
+        scCloudSDK: {
+            core: Core;
+            personalize: Personalize;
+        };
+    }
+}