@sitecore-cloudsdk/events 0.3.1 → 0.4.0-rc.1

package/dist/esm/src/lib/events/custom-event/form.js

@@ -1,33 +1,55 @@
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getBrowserId, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core';
-import { CustomEvent } from './custom-event';
-import { ErrorMessages } from '../../consts';
-import { awaitInit } from '../../initializer/browser/initializer';
+import { getBrowserId, getCloudSDKSettingsBrowser as getCloudSDKSettings, getEnabledPackageBrowser as getEnabledPackage, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core/internal';
+import { getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
+import { ErrorMessages, PACKAGE_NAME } from '../../consts';
+import { awaitInit } from '../../init/browser/initializer';
 import { sendEvent } from '../send-event/sendEvent';
+import { CustomEvent } from './custom-event';
 /**
  * A function that sends a form event to SitecoreCloud API
  *
  * @param formId - The required form ID string
  * @param interactionType - The required interaction type string. Possible values: "VIEWED", "SUBMITTED"
- *  settings object, you must specify it here
+ * @param componentInstanceId - The required component instance ID string
  * @returns The response object that Sitecore EP returns or null
  */
-export async function form(formId, interactionType) {
+export async function form(formId, interactionType, componentInstanceId) {
     await awaitInit();
-    const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0004);
-    const id = getBrowserId();
-    const formEvent = new CustomEvent({
-        eventData: {
-            extensionData: {
-                formId,
-                interactionType: interactionType.toUpperCase()
+    if (getEnabledPackage(PACKAGE_NAME)?.initState) {
+        const settings = getCloudSDKSettings();
+        const id = getCookieValueClientSide(settings.cookieSettings.name.browserId);
+        const formEvent = new CustomEvent({
+            eventData: {
+                extensionData: {
+                    componentInstanceId,
+                    formId,
+                    interactionType: interactionType.toUpperCase()
+                },
+                type: 'FORM'
+            },
+            id,
+            sendEvent,
+            settings: settings
+        });
+        formEvent.page = undefined;
+        return formEvent.send();
+    }
+    else {
+        const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0014);
+        const id = getBrowserId();
+        const formEvent = new CustomEvent({
+            eventData: {
+                extensionData: {
+                    componentInstanceId,
+                    formId,
+                    interactionType: interactionType.toUpperCase()
+                },
+                type: 'FORM'
             },
-            type: 'FORM'
-        },
-        id,
-        sendEvent,
-        settings
-    });
-    formEvent.page = undefined;
-    return formEvent.send();
+            id,
+            sendEvent,
+            settings
+        });
+        formEvent.page = undefined;
+        return formEvent.send();
+    }
 }

package/dist/esm/src/lib/events/identity/identity-event.d.ts

@@ -1,4 +1,4 @@
-import type { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core';
+import type { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core/internal';
 import type { EventAttributesInput, ExtensionData } from '../common-interfaces';
 import { BaseEvent } from '../base-event';
 import type { FlattenedObject } from '@sitecore-cloudsdk/utils';

package/dist/esm/src/lib/events/identity/identity.d.ts

@@ -1,4 +1,4 @@
-import type { EPResponse } from '@sitecore-cloudsdk/core';
+import type { EPResponse } from '@sitecore-cloudsdk/core/internal';
 import type { IdentityData } from './identity-event';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API

package/dist/esm/src/lib/events/identity/identity.js

@@ -1,9 +1,9 @@
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getBrowserId, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core';
-import { ErrorMessages } from '../../consts';
-import { IdentityEvent } from './identity-event';
-import { awaitInit } from '../../initializer/browser/initializer';
+import { getBrowserId, getCloudSDKSettingsBrowser as getCloudSDKSettings, getEnabledPackageBrowser as getEnabledPackage, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core/internal';
+import { getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
+import { ErrorMessages, PACKAGE_NAME } from '../../consts';
+import { awaitInit } from '../../init/browser/initializer';
 import { sendEvent } from '../send-event/sendEvent';
+import { IdentityEvent } from './identity-event';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
  *
@@ -12,12 +12,24 @@ import { sendEvent } from '../send-event/sendEvent';
  */
 export async function identity(identityData) {
     await awaitInit();
-    const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0004);
-    const id = getBrowserId();
-    return new IdentityEvent({
-        id,
-        identityData,
-        sendEvent,
-        settings
-    }).send();
+    if (getEnabledPackage(PACKAGE_NAME)?.initState) {
+        const settings = getCloudSDKSettings();
+        const id = getCookieValueClientSide(settings.cookieSettings.name.browserId);
+        return new IdentityEvent({
+            id,
+            identityData,
+            sendEvent,
+            settings: settings
+        }).send();
+    }
+    else {
+        const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0014);
+        const id = getBrowserId();
+        return new IdentityEvent({
+            id,
+            identityData,
+            sendEvent,
+            settings
+        }).send();
+    }
 }

package/dist/esm/src/lib/events/identity/identityServer.d.ts

@@ -1,6 +1,6 @@
-import type { EPResponse } from '@sitecore-cloudsdk/core';
-import type { IdentityData } from './identity-event';
+import { type EPResponse } from '@sitecore-cloudsdk/core/internal';
 import type { Request } from '@sitecore-cloudsdk/utils';
+import type { IdentityData } from './identity-event';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
  *

package/dist/esm/src/lib/events/identity/identityServer.js

@@ -1,8 +1,9 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getCookieValueFromRequest, getSettingsServer, handleGetSettingsError } from '@sitecore-cloudsdk/core';
-import { ErrorMessages } from '../../consts';
-import { IdentityEvent } from './identity-event';
+import { builderInstanceServer, getCookieValueFromRequest, handleGetSettingsError } from '@sitecore-cloudsdk/core/internal';
+import { getCloudSDKSettingsServer as getCloudSDKSettings, getEnabledPackageServer as getEnabledPackage, getSettingsServer } from '@sitecore-cloudsdk/core/internal';
+import { ErrorMessages, PACKAGE_NAME } from '../../consts';
 import { sendEvent } from '../send-event/sendEvent';
+import { IdentityEvent } from './identity-event';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
  *
@@ -11,10 +12,20 @@ import { sendEvent } from '../send-event/sendEvent';
  * @returns The response object that Sitecore EP returns
  */
 export function identityServer(request, identityData) {
-    const settings = handleGetSettingsError(getSettingsServer, ErrorMessages.IE_0005);
-    const id = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.browserId);
+    let settings;
+    let browserId;
+    if (builderInstanceServer) {
+        if (!getEnabledPackage(PACKAGE_NAME))
+            throw new Error(ErrorMessages.IE_0015);
+        settings = getCloudSDKSettings();
+        browserId = getCookieValueFromRequest(request, settings.cookieSettings.name.browserId);
+    }
+    else {
+        settings = handleGetSettingsError(getSettingsServer, ErrorMessages.IE_0015);
+        browserId = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.browserId);
+    }
     return new IdentityEvent({
-        id,
+        id: browserId,
         identityData,
         sendEvent,
         settings: settings

package/dist/esm/src/lib/events/page-view/page-view-event.d.ts

@@ -1,4 +1,4 @@
-import type { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core';
+import type { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core/internal';
 import type { EventAttributesInput, ExtensionData } from '../common-interfaces';
 import type { FlattenedObject, NestedObject } from '@sitecore-cloudsdk/utils';
 import { BaseEvent } from '../base-event';

package/dist/esm/src/lib/events/page-view/page-view-server.d.ts

@@ -1,6 +1,6 @@
-import type { EPResponse } from '@sitecore-cloudsdk/core';
-import type { PageViewData } from './page-view-event';
+import { type EPResponse } from '@sitecore-cloudsdk/core/internal';
 import type { Request } from '@sitecore-cloudsdk/utils';
+import type { PageViewData } from './page-view-event';
 /**
  * A function that sends a VIEW event to SitecoreCloud API
  *

package/dist/esm/src/lib/events/page-view/page-view-server.js

@@ -1,8 +1,9 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getCookieValueFromRequest, getSettingsServer, handleGetSettingsError } from '@sitecore-cloudsdk/core';
-import { ErrorMessages } from '../../consts';
-import { PageViewEvent } from './page-view-event';
+import { handleGetSettingsError } from '@sitecore-cloudsdk/core/internal';
+import { builderInstanceServer, getCloudSDKSettingsServer, getCookieValueFromRequest, getEnabledPackageServer as getEnabledPackage, getSettingsServer } from '@sitecore-cloudsdk/core/internal';
+import { ErrorMessages, PACKAGE_NAME } from '../../consts';
 import { sendEvent } from '../send-event/sendEvent';
+import { PageViewEvent } from './page-view-event';
 /**
  * A function that sends a VIEW event to SitecoreCloud API
  *
@@ -11,15 +12,25 @@ import { sendEvent } from '../send-event/sendEvent';
  * @returns The response object that Sitecore EP returns
  */
 export function pageViewServer(request, pageViewData) {
-    const settings = handleGetSettingsError(getSettingsServer, ErrorMessages.IE_0005);
-    const id = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.browserId);
+    let settings;
+    let browserId;
     // Host is irrelevant but necessary to support relative URL
     const requestUrl = new URL(request.url, `https://localhost`);
+    if (builderInstanceServer) {
+        if (!getEnabledPackage(PACKAGE_NAME))
+            throw new Error(ErrorMessages.IE_0015);
+        settings = getCloudSDKSettingsServer();
+        browserId = getCookieValueFromRequest(request, settings.cookieSettings.name.browserId);
+    }
+    else {
+        settings = handleGetSettingsError(getSettingsServer, ErrorMessages.IE_0015);
+        browserId = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.browserId);
+    }
     return new PageViewEvent({
-        id,
+        id: browserId,
         pageViewData,
         searchParams: requestUrl.search,
         sendEvent,
-        settings
+        settings: settings
     }).send();
 }

package/dist/esm/src/lib/events/page-view/page-view.d.ts

@@ -1,4 +1,4 @@
-import type { EPResponse } from '@sitecore-cloudsdk/core';
+import type { EPResponse } from '@sitecore-cloudsdk/core/internal';
 import type { PageViewData } from './page-view-event';
 /**
  * A function that sends a VIEW event to SitecoreCloud API

package/dist/esm/src/lib/events/page-view/page-view.js

@@ -1,9 +1,9 @@
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getBrowserId, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core';
-import { ErrorMessages } from '../../consts';
-import { PageViewEvent } from './page-view-event';
-import { awaitInit } from '../../initializer/browser/initializer';
+import { getBrowserId, getCloudSDKSettingsBrowser as getCloudSDKSettings, getEnabledPackageBrowser as getEnabledPackage, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core/internal';
+import { getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
+import { ErrorMessages, PACKAGE_NAME } from '../../consts';
+import { awaitInit } from '../../init/browser/initializer';
 import { sendEvent } from '../send-event/sendEvent';
+import { PageViewEvent } from './page-view-event';
 /**
  * A function that sends a VIEW event to SitecoreCloud API
  *
@@ -13,13 +13,26 @@ import { sendEvent } from '../send-event/sendEvent';
  */
 export async function pageView(pageViewData) {
     await awaitInit();
-    const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0004);
-    const id = getBrowserId();
-    return new PageViewEvent({
-        id,
-        pageViewData,
-        searchParams: window.location.search,
-        sendEvent,
-        settings
-    }).send();
+    if (getEnabledPackage(PACKAGE_NAME)?.initState) {
+        const settings = getCloudSDKSettings();
+        const id = getCookieValueClientSide(settings.cookieSettings.name.browserId);
+        return new PageViewEvent({
+            id,
+            pageViewData,
+            searchParams: window.location.search,
+            sendEvent,
+            settings: settings
+        }).send();
+    }
+    else {
+        const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0014);
+        const id = getBrowserId();
+        return new PageViewEvent({
+            id,
+            pageViewData,
+            searchParams: window.location.search,
+            sendEvent,
+            settings
+        }).send();
+    }
 }

package/dist/esm/src/lib/events/send-event/sendEvent.d.ts

@@ -1,5 +1,5 @@
 import type { BasePayload, CustomEventPayload, IdentityEventPayload, PageViewEventPayload } from '..';
-import type { EPResponse, Settings } from '@sitecore-cloudsdk/core';
+import type { EPResponse, Settings } from '@sitecore-cloudsdk/core/internal';
 /**
  * This factory function sends an event to Edge Proxy
  * @param body - The event data to send

package/dist/esm/src/lib/events/send-event/sendEvent.js

@@ -1,6 +1,6 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { API_VERSION, debug, processDebugResponse } from '@sitecore-cloudsdk/core';
-import { EVENTS_NAMESPACE, LIBRARY_VERSION, X_CLIENT_SOFTWARE_ID } from '../../consts';
+import { API_VERSION, debug, processDebugResponse } from '@sitecore-cloudsdk/core/internal';
+import { EVENTS_NAMESPACE, PACKAGE_VERSION, X_CLIENT_SOFTWARE_ID } from '../../consts';
 /**
  * This factory function sends an event to Edge Proxy
  * @param body - The event data to send
@@ -17,7 +17,7 @@ export async function sendEvent(body, settings) {
             /* eslint-disable @typescript-eslint/naming-convention */
             'Content-Type': 'application/json',
             'X-Client-Software-ID': X_CLIENT_SOFTWARE_ID,
-            'X-Library-Version': LIBRARY_VERSION
+            'X-Library-Version': PACKAGE_VERSION
             /* eslint-enable @typescript-eslint/naming-convention */
         },
         method: 'POST'

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

@@ -0,0 +1,8 @@
+/**
+ * Get the browser ID from the cookie
+ * @returns The browser ID if the cookie exists
+ * @deprecated Cloud SDK v0.4 introduces a new getBrowserId function. If you are upgrading from v0.3, we recommend that
+ * you use the getBrowserId function that is exposed from \@sitecore-cloudsdk/core/browser. The v0.3 function will be
+ * deprecated and removed in a future Cloud SDK release.
+ */
+export declare function getBrowserId(): string;

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

@@ -0,0 +1,12 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { getBrowserId as getBrowserIdCore } from '@sitecore-cloudsdk/core/browser';
+/**
+ * Get the browser ID from the cookie
+ * @returns The browser ID if the cookie exists
+ * @deprecated Cloud SDK v0.4 introduces a new getBrowserId function. If you are upgrading from v0.3, we recommend that
+ * you use the getBrowserId function that is exposed from \@sitecore-cloudsdk/core/browser. The v0.3 function will be
+ * deprecated and removed in a future Cloud SDK release.
+ */
+export function getBrowserId() {
+    return getBrowserIdCore();
+}

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

@@ -1,6 +1,9 @@
 /**
- * A function that returns the guest id.
- * @returns - A promise that resolves with the guest id
- * @throws - Will throw an error if the clientKey/browser id is invalid
+ * 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
+ * @deprecated Cloud SDK v0.4 introduces a new getGuestId function. If you are upgrading from v0.3, we recommend that
+ * you use the getGuestId function that is exposed from \@sitecore-cloudsdk/core/browser. The v0.3 function will be
+ * deprecated and removed in a future Cloud SDK release.
  */
 export declare function getGuestId(): Promise<string>;

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

@@ -1,15 +1,26 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getBrowserId, getGuestId as getGuestIdFromCore, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core';
-import { ErrorMessages } from '../consts';
-import { awaitInit } from '../initializer/browser/initializer';
+import { getBrowserId, getCloudSDKSettingsBrowser as getCloudSDKSettings, getEnabledPackageBrowser as getEnabledPackage, getGuestId as getGuestIdFromCore, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core/internal';
+import { getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
+import { ErrorMessages, PACKAGE_NAME } from '../consts';
+import { awaitInit } from '../init/browser/initializer';
 /**
- * A function that returns the guest id.
- * @returns - A promise that resolves with the guest id
- * @throws - Will throw an error if the clientKey/browser id is invalid
+ * 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
+ * @deprecated Cloud SDK v0.4 introduces a new getGuestId function. If you are upgrading from v0.3, we recommend that
+ * you use the getGuestId function that is exposed from \@sitecore-cloudsdk/core/browser. The v0.3 function will be
+ * deprecated and removed in a future Cloud SDK release.
  */
 export async function getGuestId() {
     await awaitInit();
-    const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0004);
-    const id = getBrowserId();
-    return getGuestIdFromCore(id, settings.sitecoreEdgeContextId, settings.sitecoreEdgeUrl);
+    if (getEnabledPackage(PACKAGE_NAME)?.initState) {
+        const settings = getCloudSDKSettings();
+        const id = getCookieValueClientSide(settings.cookieSettings.name.browserId);
+        return getGuestIdFromCore(id, settings.sitecoreEdgeContextId, settings.sitecoreEdgeUrl);
+    }
+    else {
+        const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0014);
+        const id = getBrowserId();
+        return getGuestIdFromCore(id, settings.sitecoreEdgeContextId, settings.sitecoreEdgeUrl);
+    }
 }

package/dist/esm/src/lib/init/browser/initializer.d.ts

@@ -0,0 +1,13 @@
+import type { BrowserSettings } from '@sitecore-cloudsdk/core/internal';
+export declare let initPromise: Promise<void> | null;
+/**
+ * Initiates the Events library using the global settings added by the developer
+ * @param settings - Global settings added by the developer
+ * @returns A promise that resolves with an object that handles the library functionality
+ * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
+ */
+export declare function init(settings: BrowserSettings): Promise<void>;
+/**
+ * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ */
+export declare function awaitInit(): Promise<void>;

package/dist/esm/src/lib/init/browser/initializer.js

@@ -0,0 +1,43 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { EVENTS_NAMESPACE, ErrorMessages, PACKAGE_NAME, PACKAGE_VERSION } from '../../consts';
+import { debug, getBrowserId, getEnabledPackageBrowser as getEnabledPackage, initCore } from '@sitecore-cloudsdk/core/internal';
+export let initPromise = null;
+/* eslint-disable max-len */
+/**
+ * Initiates the Events library using the global settings added by the developer
+ * @param settings - Global settings added by the developer
+ * @returns A promise that resolves with an object that handles the library functionality
+ * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
+ */
+/* eslint-enable max-len */
+export async function init(settings) {
+    if (typeof window === 'undefined')
+        throw new Error(ErrorMessages.IE_0001);
+    try {
+        initPromise = initCore(settings);
+        await initPromise;
+        debug(EVENTS_NAMESPACE)('eventsClient library initialized');
+    }
+    catch (error) {
+        debug(EVENTS_NAMESPACE)('Error on initializing eventsClient library: %o', error);
+        initPromise = null;
+        throw new Error(error);
+    }
+    window.Engage = {
+        ...window.Engage,
+        getBrowserId: () => getBrowserId(),
+        versions: {
+            ...window.Engage?.versions,
+            events: PACKAGE_VERSION
+        }
+    };
+}
+/**
+ * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ */
+export async function awaitInit() {
+    const initState = getEnabledPackage(PACKAGE_NAME)?.initState;
+    if (initPromise === null && !initState)
+        throw new Error(ErrorMessages.IE_0014);
+    initPromise ? await initPromise : await initState;
+}

package/dist/esm/src/lib/init/server/initializer.d.ts

@@ -0,0 +1,11 @@
+import type { Request, Response } from '@sitecore-cloudsdk/utils';
+import type { ServerSettings } from '@sitecore-cloudsdk/core/internal';
+/**
+ * Initiates the server Events library using the global settings added by the developer
+ * @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 settings - Global settings added by the developer
+ * @returns A promise that resolves with an object that handles the library functionality
+ * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
+ */
+export declare function initServer(request: Request, response: Response, settings: ServerSettings): Promise<void>;

package/dist/esm/src/lib/init/server/initializer.js

@@ -0,0 +1,22 @@
+import { debug, initCoreServer } from '@sitecore-cloudsdk/core/internal';
+import { EVENTS_NAMESPACE } from '../../consts';
+/* eslint-disable max-len */
+/**
+ * Initiates the server Events library using the global settings added by the developer
+ * @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 settings - Global settings added by the developer
+ * @returns A promise that resolves with an object that handles the library functionality
+ * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
+ */
+/* eslint-enable max-len */
+export async function initServer(request, response, settings) {
+    try {
+        await initCoreServer(settings, request, response);
+        debug(EVENTS_NAMESPACE)('eventsServer library initialized');
+    }
+    catch (error) {
+        debug(EVENTS_NAMESPACE)('Error on initializing eventsServer library with error: %o', error);
+        throw new Error(error);
+    }
+}

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

@@ -1,24 +1,13 @@
-import type { BrowserSettings } from '@sitecore-cloudsdk/core';
-export declare let initPromise: Promise<void> | null;
-declare global {
-    interface Window {
-        Engage: {
-            [x: string]: any;
-            getBrowserId?: () => string;
-            versions?: {
-                personalize?: string;
-                events?: string;
-            };
-        };
-    }
-}
-/**
- * Initiates the Events library using the global settings added by the developer
- * @param settings - Global settings added by the developer
- * @returns A promise that resolves with an object that handles the library functionality
- */
-export declare function init(settings: BrowserSettings): Promise<void>;
+import { CloudSDKBrowserInitializer } from '@sitecore-cloudsdk/core/browser';
+export declare function sideEffects(): Promise<void>;
 /**
- * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ * Makes the functionality of the events package available.
+ *
+ * @returns An instance of {@link CloudSDKBrowserInitializer}
  */
-export declare function awaitInit(): Promise<void>;
+export declare function addEvents(this: CloudSDKBrowserInitializer): CloudSDKBrowserInitializer;
+declare module '@sitecore-cloudsdk/core/browser' {
+    interface CloudSDKBrowserInitializer {
+        addEvents: typeof addEvents;
+    }
+}

package/dist/esm/src/lib/initializer/browser/initializer.js

@@ -1,39 +1,28 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { EVENTS_NAMESPACE, ErrorMessages, LIBRARY_VERSION } from '../../consts';
-import { debug, getBrowserId, initCore } from '@sitecore-cloudsdk/core';
-export let initPromise = null;
-/**
- * Initiates the Events library using the global settings added by the developer
- * @param settings - Global settings added by the developer
- * @returns A promise that resolves with an object that handles the library functionality
- */
-export async function init(settings) {
-    if (typeof window === 'undefined')
-        throw new Error(ErrorMessages.IE_0001);
-    try {
-        initPromise = initCore(settings);
-        await initPromise;
-        debug(EVENTS_NAMESPACE)('eventsClient library initialized');
-    }
-    catch (error) {
-        debug(EVENTS_NAMESPACE)('Error on initializing eventsClient library: %o', error);
-        initPromise = null;
-        throw new Error(error);
-    }
+import { CloudSDKBrowserInitializer } from '@sitecore-cloudsdk/core/browser';
+import { debug, enabledPackagesBrowser as enabledPackages, getCloudSDKSettingsBrowser as getCloudSDKSettings, PackageInitializer } from '@sitecore-cloudsdk/core/internal';
+import { getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
+import { EVENTS_NAMESPACE, PACKAGE_NAME, PACKAGE_VERSION } from '../../consts';
+export async function sideEffects() {
+    window.Engage ?? (window.Engage = {});
     window.Engage = {
         ...window.Engage,
-        getBrowserId: () => getBrowserId(),
+        getBrowserId: () => getCookieValueClientSide(getCloudSDKSettings().cookieSettings.name.browserId),
         versions: {
-            ...window.Engage?.versions,
-            events: LIBRARY_VERSION
+            ...window.Engage.versions,
+            events: PACKAGE_VERSION
         }
     };
+    debug(EVENTS_NAMESPACE)('eventsClient library initialized');
 }
 /**
- * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ * Makes the functionality of the events package available.
+ *
+ * @returns An instance of {@link CloudSDKBrowserInitializer}
  */
-export async function awaitInit() {
-    if (initPromise === null)
-        throw new Error(ErrorMessages.IE_0004);
-    await initPromise;
+export function addEvents() {
+    const eventsInitializer = new PackageInitializer({ sideEffects });
+    enabledPackages.set(PACKAGE_NAME, eventsInitializer);
+    return this;
 }
+CloudSDKBrowserInitializer.prototype.addEvents = addEvents;

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

@@ -1,10 +1,13 @@
-import type { Request, Response } from '@sitecore-cloudsdk/utils';
-import type { ServerSettings } from '@sitecore-cloudsdk/core';
+import { CloudSDKServerInitializer } from '@sitecore-cloudsdk/core/server';
+export declare function sideEffects(): Promise<void>;
 /**
- * Initiates the server Events library using the global settings added by the developer
- * @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 settings - Global settings added by the developer
- * @returns A promise that resolves with an object that handles the library functionality
+ * Makes the functionality of the events package available.
+ *
+ * @returns An instance of {@link CloudSDKServerInitializer}
  */
-export declare function initServer(request: Request, response: Response, settings: ServerSettings): Promise<void>;
+export declare function addEvents(this: CloudSDKServerInitializer): CloudSDKServerInitializer;
+declare module '@sitecore-cloudsdk/core/server' {
+    interface CloudSDKServerInitializer {
+        addEvents: typeof addEvents;
+    }
+}