@sitecore-cloudsdk/events 0.1.2 → 0.1.4

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

@@ -1,6 +1,8 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getDependencies } from '../../initializer/browser/initializer';
+import { getBrowserId, getSettings } from '@sitecore-cloudsdk/core';
 import { CustomEvent } from './custom-event';
+import { sendEvent } from '../send-event/sendEvent';
+import { awaitInit } from '../../initializer/browser/initializer';
 /**
  * A function that sends a form event to SitecoreCloud API
  * @param formId - The required form ID string
@@ -8,16 +10,18 @@ import { CustomEvent } from './custom-event';
  *  settings object, you must specify it here
  * @returns The response object that Sitecore EP returns or null
  */
-export function form(formId, interactionType) {
-    const { eventApiClient, id, settings } = getDependencies();
+export async function form(formId, interactionType) {
+    await awaitInit();
+    const settings = getSettings();
+    const id = getBrowserId();
     const formEvent = new CustomEvent({
-        eventApiClient,
         eventData: {},
         extensionData: {
             formId,
             interactionType: interactionType.toUpperCase(),
         },
         id,
+        sendEvent,
         settings,
         type: 'FORM',
     });

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

@@ -1,13 +1,14 @@
 import { BaseEvent } from '../base-event';
 import { ExtensionData, EventAttributesInput } from '../common-interfaces';
-import { EventApiClient } from '../../ep/EventApiClient';
 import { FlattenedObject } from '@sitecore-cloudsdk/utils';
 import { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core';
+import { SendEvent } from '../send-event/sendEvent';
 export declare class IdentityEvent extends BaseEvent {
     private eventData;
-    private eventApiClient;
+    private sendEvent;
     private extensionData;
     private numberOfExtensionDataProperties;
+    private settings;
     /**
      * A class that extends from {@link BaseEvent} and has all the required functionality to send a VIEW event
      * @param args - Unified object containing the required properties
@@ -89,7 +90,7 @@ export interface IdentityEventPayload {
  * Interface of the unified arguments object for identity event
  */
 export interface IdentityEventArguments {
-    eventApiClient: EventApiClient;
+    sendEvent: SendEvent;
     eventData: IdentityEventAttributesInput;
     extensionData?: ExtensionData;
     id: string;

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

@@ -2,6 +2,7 @@
 import { BaseEvent } from '../base-event';
 import { MAX_EXT_ATTRIBUTES } from '../consts';
 import { isShortISODateString, isValidEmail, flattenObject } from '@sitecore-cloudsdk/utils';
+import { ErrorMessages } from '../../consts';
 export class IdentityEvent extends BaseEvent {
     /**
      * A class that extends from {@link BaseEvent} and has all the required functionality to send a VIEW event
@@ -9,17 +10,18 @@ export class IdentityEvent extends BaseEvent {
      */
     constructor(args) {
         const { channel, currency, language, page } = args.eventData;
-        super({ channel, currency, language, page }, args.settings, args.id);
+        super({ channel, currency, language, page }, args.id);
         this.extensionData = {};
         this.numberOfExtensionDataProperties = 0;
         this.validateAttributes(args.eventData);
         this.eventData = args.eventData;
-        this.eventApiClient = args.eventApiClient;
+        this.sendEvent = args.sendEvent;
+        this.settings = args.settings;
         if (args.extensionData)
             this.extensionData = flattenObject({ object: args.extensionData });
         this.numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
         if (this.numberOfExtensionDataProperties > MAX_EXT_ATTRIBUTES)
-            throw new Error(`[IV-0005] This event supports maximum ${MAX_EXT_ATTRIBUTES} attributes. Reduce the number of attributes.`);
+            throw new Error(ErrorMessages.IV_0005);
     }
     /**
      * Function that validates the identifiers object, email and date attributes for CDN users
@@ -27,15 +29,15 @@ export class IdentityEvent extends BaseEvent {
      */
     validateAttributes(eventData) {
         if (eventData.identifiers.length === 0)
-            throw new Error(`[MV-0003] "identifiers" is required.`);
+            throw new Error(ErrorMessages.MV_0003);
         if (eventData.dob !== undefined && !isShortISODateString(eventData.dob))
-            throw new Error(`[IV-0002] Incorrect value for "dob". Format the value according to ISO 8601.`);
+            throw new Error(ErrorMessages.IV_0002);
         eventData.identifiers.forEach((identifier) => {
             if (identifier.expiryDate && !isShortISODateString(identifier.expiryDate))
-                throw new Error(`[IV-0004] Incorrect value for "expiryDate". Format the value according to ISO 8601.`);
+                throw new Error(ErrorMessages.IV_0004);
         });
         if (eventData.email && !isValidEmail(eventData.email))
-            throw new Error(`[IV-0003] Incorrect value for "email". Set the value to a valid email address.`);
+            throw new Error(ErrorMessages.IV_0003);
     }
     /**
      * A function that maps the identity event input data with the payload sent to the API
@@ -79,6 +81,6 @@ export class IdentityEvent extends BaseEvent {
         const baseAttr = this.mapBaseEventPayload();
         const eventAttrs = this.mapAttributes();
         const fetchBody = Object.assign({}, eventAttrs, baseAttr);
-        return await this.eventApiClient.send(fetchBody);
+        return await this.sendEvent(fetchBody, this.settings);
     }
 }

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

@@ -1,6 +1,7 @@
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getDependencies } from '../../initializer/browser/initializer';
+import { getBrowserId, getSettings } from '@sitecore-cloudsdk/core';
 import { IdentityEvent } from './identity-event';
+import { awaitInit } from '../../initializer/browser/initializer';
+import { sendEvent } from '../send-event/sendEvent';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
  * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
@@ -8,13 +9,15 @@ import { IdentityEvent } from './identity-event';
  * This object will be flattened and sent in the ext object of the payload
  * @returns The response object that Sitecore EP returns
  */
-export function identity(eventData, extensionData) {
-    const { eventApiClient, id, settings } = getDependencies();
+export async function identity(eventData, extensionData) {
+    await awaitInit();
+    const settings = getSettings();
+    const id = getBrowserId();
     return new IdentityEvent({
-        eventApiClient,
         eventData,
         extensionData,
         id,
+        sendEvent,
         settings,
     }).send();
 }

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

@@ -1,7 +1,7 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getBrowserIdFromRequest } from '@sitecore-cloudsdk/core';
-import { getServerDependencies } from '../../initializer/server/initializer';
+import { getBrowserIdFromRequest, getSettingsServer } from '@sitecore-cloudsdk/core';
 import { IdentityEvent } from './identity-event';
+import { sendEvent } from '../send-event/sendEvent';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
  * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
@@ -11,13 +11,13 @@ import { IdentityEvent } from './identity-event';
  * @returns The response object that Sitecore EP returns
  */
 export function identityServer(eventData, request, extensionData) {
-    const { eventApiClient, settings } = getServerDependencies();
+    const settings = getSettingsServer();
     const id = getBrowserIdFromRequest(request, settings.cookieSettings.cookieName);
     return new IdentityEvent({
-        eventApiClient,
         eventData,
         extensionData,
         id,
+        sendEvent,
         settings: settings,
     }).send();
 }

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

@@ -1,15 +1,16 @@
 import { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core';
 import { FlattenedObject, NestedObject } from '@sitecore-cloudsdk/utils';
 import { BaseEvent } from '../base-event';
-import { EventApiClient } from '../../ep/EventApiClient';
 import { EventAttributesInput } from '../common-interfaces';
+import { SendEvent } from '../send-event/sendEvent';
 export declare class PageViewEvent extends BaseEvent {
     static isFirstPageView: boolean;
-    private eventApiClient;
+    private sendEvent;
     private eventData;
     private extensionData;
     private urlSearchParams;
     private includeUTMParameters;
+    settings: Settings;
     /**
      * A class that extends from {@link BaseEvent} and has all the required functionality to send a VIEW event
      * @param args - Unified object containing the required properties
@@ -47,7 +48,7 @@ export declare class PageViewEvent extends BaseEvent {
  * Interface of the unified arguments object for page view event
  */
 export interface PageViewEventArguments {
-    eventApiClient: EventApiClient;
+    sendEvent: SendEvent;
     eventData: PageViewEventInput;
     id: string;
     settings: Settings;

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

@@ -1,7 +1,7 @@
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 import { flattenObject } from '@sitecore-cloudsdk/utils';
 import { BaseEvent } from '../base-event';
 import { MAX_EXT_ATTRIBUTES, UTM_PREFIX } from '../consts';
+import { ErrorMessages } from '../../consts';
 export class PageViewEvent extends BaseEvent {
     /**
      * A class that extends from {@link BaseEvent} and has all the required functionality to send a VIEW event
@@ -14,16 +14,17 @@ export class PageViewEvent extends BaseEvent {
             currency,
             language,
             page,
-        }, args.settings, args.id);
+        }, args.id);
         this.extensionData = {};
         this.eventData = args.eventData;
+        this.sendEvent = args.sendEvent;
+        this.settings = args.settings;
         this.urlSearchParams = new URLSearchParams(decodeURI(args.searchParams));
         if (args.extensionData)
             this.extensionData = flattenObject({ object: args.extensionData });
         const numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
         if (numberOfExtensionDataProperties > MAX_EXT_ATTRIBUTES)
-            throw new Error(`[IV-0005] This event supports maximum ${MAX_EXT_ATTRIBUTES} attributes. Reduce the number of attributes.`);
-        this.eventApiClient = args.eventApiClient;
+            throw new Error(ErrorMessages.IV_0005);
         this.includeUTMParameters =
             args.eventData.includeUTMParameters === undefined ? true : args.eventData.includeUTMParameters;
     }
@@ -90,7 +91,7 @@ export class PageViewEvent extends BaseEvent {
         const eventAttrs = this.mapAttributes();
         const fetchBody = Object.assign({}, eventAttrs, baseAttr);
         PageViewEvent.isFirstPageView = false;
-        return await this.eventApiClient.send(fetchBody);
+        return await this.sendEvent(fetchBody, this.settings);
     }
     /**
      * Retrieves UTM parameters from the url query string

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

@@ -1,7 +1,7 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getBrowserIdFromRequest } from '@sitecore-cloudsdk/core';
-import { getServerDependencies } from '../../initializer/server/initializer';
+import { getBrowserIdFromRequest, getSettingsServer } from '@sitecore-cloudsdk/core';
 import { PageViewEvent } from './page-view-event';
+import { sendEvent } from '../send-event/sendEvent';
 /**
  * A function that sends a VIEW event to SitecoreCloud API
  * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
@@ -11,16 +11,16 @@ import { PageViewEvent } from './page-view-event';
  * @returns The response object that Sitecore EP returns
  */
 export function pageViewServer(eventData, request, extensionData) {
-    const { eventApiClient, settings } = getServerDependencies();
+    const settings = getSettingsServer();
     const id = getBrowserIdFromRequest(request, settings.cookieSettings.cookieName);
     // Host is irrelevant but necessary to support relative URL
     const requestUrl = new URL(request.url, `https://localhost`);
     return new PageViewEvent({
-        eventApiClient,
         eventData,
         extensionData,
         id,
         searchParams: requestUrl.search,
+        sendEvent,
         settings,
     }).send();
 }

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

@@ -1,5 +1,8 @@
-import { getDependencies } from '../../initializer/browser/initializer';
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { getBrowserId, getSettings } from '@sitecore-cloudsdk/core';
 import { PageViewEvent } from './page-view-event';
+import { awaitInit } from '../../initializer/browser/initializer';
+import { sendEvent } from '../send-event/sendEvent';
 /**
  * A function that sends a VIEW event to SitecoreCloud API
  * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
@@ -7,14 +10,16 @@ import { PageViewEvent } from './page-view-event';
  * This object will be flattened and sent in the ext object of the payload
  * @returns The response object that Sitecore EP returns
  */
-export function pageView(eventData, extensionData) {
-    const { eventApiClient, id, settings } = getDependencies();
+export async function pageView(eventData, extensionData) {
+    await awaitInit();
+    const settings = getSettings();
+    const id = getBrowserId();
     return new PageViewEvent({
-        eventApiClient,
         eventData,
         extensionData,
         id,
         searchParams: window.location.search,
+        sendEvent,
         settings,
     }).send();
 }

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

@@ -0,0 +1,17 @@
+import { EPResponse, Settings } from '@sitecore-cloudsdk/core';
+import type { BasePayload, PageViewEventPayload, IdentityEventPayload, CustomEventPayload } from '..';
+/**
+ * This factory function sends an event to Edge Proxy
+ * @param body - The event data to send
+ * @param settings - The global settings
+ */
+export declare function sendEvent(body: EPFetchBody & BasePayload, settings: Settings): Promise<EPResponse | null>;
+/**
+ * The type of sendEvent function
+ */
+export type SendEvent = (body: EPFetchBody & BasePayload, settings: Settings) => Promise<EPResponse | null>;
+/**
+ * The type describing all possible event payloads
+ */
+type EPFetchBody = PageViewEventPayload | IdentityEventPayload | CustomEventPayload;
+export {};

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

@@ -0,0 +1,25 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { API_VERSION } from '@sitecore-cloudsdk/core';
+import { LIBRARY_VERSION } from '../../consts';
+/**
+ * This factory function sends an event to Edge Proxy
+ * @param body - The event data to send
+ * @param settings - The global settings
+ */
+export async function sendEvent(body, settings) {
+    const eventUrl = `${settings.sitecoreEdgeUrl}/events/${API_VERSION}/events?sitecoreContextId=${settings.sitecoreEdgeContextId}&siteId=${settings.siteName}`;
+    const fetchOptions = {
+        body: JSON.stringify(body),
+        headers: {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            'Content-Type': 'application/json',
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            'X-Library-Version': LIBRARY_VERSION,
+        },
+        method: 'POST',
+    };
+    return await fetch(eventUrl, fetchOptions)
+        .then((response) => response.json())
+        .then((data) => data)
+        .catch(() => null);
+}

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

@@ -1,12 +1,14 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getGuestId as getGuestIdFromCore } from '@sitecore-cloudsdk/core';
-import { getDependencies } from '../initializer/browser/initializer';
+import { awaitInit } from '../initializer/browser/initializer';
+import { getBrowserId, getGuestId as getGuestIdFromCore, getSettings } from '@sitecore-cloudsdk/core';
 /**
  * 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
  */
-export function getGuestId() {
-    const { id, settings } = getDependencies();
+export async function getGuestId() {
+    await awaitInit();
+    const settings = getSettings();
+    const id = getBrowserId();
     return getGuestIdFromCore(id, settings.sitecoreEdgeContextId, settings.sitecoreEdgeUrl);
 }

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

@@ -1,25 +1,12 @@
-import { EventApiClient } from '../../ep/EventApiClient';
-import { Settings, SettingsParamsBrowser } from '@sitecore-cloudsdk/core';
-import { EventQueue } from '../../eventStorage/eventStorage';
-export declare function setDependencies(settings: BrowserEventsSettings | null): void;
-/**
- * Retrieves the browser event settings object.
- *
- * This function ensures that the browser event settings have been initialized and contain essential properties like `settings`, `eventQueue`, and `eventApiClient`.
- *
- * @returns The browser event settings object.
- * @throws Error if the event settings haven't been initialized with the required properties.
- */
-export declare function getDependencies(): BrowserEventsSettings;
-export interface BrowserEventsSettings {
-    id: string;
-    settings: Settings;
-    eventQueue: EventQueue;
-    eventApiClient: EventApiClient;
-}
+import { SettingsParamsBrowser } from '@sitecore-cloudsdk/core';
+export declare let initPromise: Promise<void> | null;
 /**
  * Initiates the Events library using the global settings added by the developer
  * @param settingsInput - Global settings added by the developer
  * @returns A promise that resolves with an object that handles the library functionality
  */
 export declare function init(settingsInput: SettingsParamsBrowser): 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/initializer/browser/initializer.js

@@ -1,48 +1,23 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { EventApiClient } from '../../ep/EventApiClient';
-import { getBrowserId, getSettings, initCore } from '@sitecore-cloudsdk/core';
-import { LIBRARY_VERSION } from '../../consts';
-import { EventQueue } from '../../eventStorage/eventStorage';
-let dependencies = null;
-export function setDependencies(settings) {
-    dependencies = settings;
-}
-/**
- * Retrieves the browser event settings object.
- *
- * This function ensures that the browser event settings have been initialized and contain essential properties like `settings`, `eventQueue`, and `eventApiClient`.
- *
- * @returns The browser event settings object.
- * @throws Error if the event settings haven't been initialized with the required properties.
- */
-export function getDependencies() {
-    if (!dependencies) {
-        throw Error(`[IE-0004] You must first initialize the "events/browser" module. Run the "init" function.`);
-    }
-    return dependencies;
-}
+import { getBrowserId, initCore } from '@sitecore-cloudsdk/core';
+import { ErrorMessages, LIBRARY_VERSION } from '../../consts';
+export let initPromise = null;
 /**
  * Initiates the Events library using the global settings added by the developer
  * @param settingsInput - Global settings added by the developer
  * @returns A promise that resolves with an object that handles the library functionality
  */
 export async function init(settingsInput) {
-    if (typeof window === 'undefined') {
-        throw new Error(
-        // eslint-disable-next-line max-len
-        `[IE-0001] The "window" object is not available on the server side. Use the "window" object only on the client side, and in the correct execution context.`);
+    if (typeof window === 'undefined')
+        throw new Error(ErrorMessages.IE_0001);
+    try {
+        initPromise = initCore(settingsInput);
+        await initPromise;
+    }
+    catch (error) {
+        initPromise = null;
+        throw new Error(error);
     }
-    await initCore(settingsInput);
-    const settings = getSettings();
-    const id = getBrowserId();
-    const eventApiClient = new EventApiClient(settings.sitecoreEdgeUrl, settingsInput.sitecoreEdgeContextId, settingsInput.siteName);
-    const eventQueue = new EventQueue(sessionStorage, eventApiClient);
-    setDependencies({
-        eventApiClient,
-        eventQueue,
-        id,
-        settings,
-    });
     window.Engage = {
         ...window.Engage,
         getBrowserId: () => getBrowserId(),
@@ -52,3 +27,11 @@ export async function init(settingsInput) {
         },
     };
 }
+/**
+ * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ */
+export async function awaitInit() {
+    if (initPromise === null)
+        throw new Error(ErrorMessages.IE_0004);
+    await initPromise;
+}

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

@@ -1,23 +1,8 @@
-import { Settings, SettingsParamsServer } from '@sitecore-cloudsdk/core';
-import { EventApiClient } from '../../ep/EventApiClient';
+import { SettingsParamsServer } from '@sitecore-cloudsdk/core';
 import { HttpResponse, MiddlewareNextResponse, Request } from '@sitecore-cloudsdk/utils';
-export declare function setServerDependencies(settings: ServerEventsSettings | null): void;
-/**
- * Retrieves the server event settings object.
- *
- * This function ensures that the server event settings have been initialized and contain essential properties like `settings` and `eventApiClient`.
- *
- * @returns The server event settings object.
- * @throws Error if the server event settings haven't been initialized with the required properties.
- */
-export declare function getServerDependencies(): ServerEventsSettings;
 /**
  * Initiates the server 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 initServer<Response extends MiddlewareNextResponse | HttpResponse>(settingsInput: SettingsParamsServer, request: Request, response: Response): Promise<void>;
-export interface ServerEventsSettings {
-    settings: Settings;
-    eventApiClient: EventApiClient;
-}

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

@@ -1,24 +1,5 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getSettingsServer, initCoreServer } from '@sitecore-cloudsdk/core';
-import { EventApiClient } from '../../ep/EventApiClient';
-let serverDependencies = null;
-export function setServerDependencies(settings) {
-    serverDependencies = settings;
-}
-/**
- * Retrieves the server event settings object.
- *
- * This function ensures that the server event settings have been initialized and contain essential properties like `settings` and `eventApiClient`.
- *
- * @returns The server event settings object.
- * @throws Error if the server event settings haven't been initialized with the required properties.
- */
-export function getServerDependencies() {
-    if (!serverDependencies) {
-        throw Error(`[IE-0005] You must first initialize the "events/server" module. Run the "init" function.`);
-    }
-    return serverDependencies;
-}
+import { initCoreServer } from '@sitecore-cloudsdk/core';
 /**
  * Initiates the server Events library using the global settings added by the developer
  * @param settings - Global settings added by the developer
@@ -26,10 +7,4 @@ export function getServerDependencies() {
  */
 export async function initServer(settingsInput, request, response) {
     await initCoreServer(settingsInput, request, response);
-    const settings = getSettingsServer();
-    const eventApiClient = new EventApiClient(settings.sitecoreEdgeUrl, settings.sitecoreEdgeContextId, settings.siteName);
-    setServerDependencies({
-        eventApiClient,
-        settings,
-    });
 }

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

@@ -4,4 +4,3 @@ export { identityServer as identity } from './lib/events/identity/identityServer
 export { pageViewServer as pageView } from './lib/events/page-view/page-view-server';
 export { LIBRARY_VERSION } from './lib/consts';
 export type { PageViewEventInput, CustomEventInput, IdentityEventAttributesInput } from './lib/events';
-export type { ServerEventsSettings as EventsSettings } from './lib/initializer/server/initializer';