@sitecore-content-sdk/events 2.0.0-canary.12

package/dist/cjs/src/events/custom-event/event.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.event = event;
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const sendEvent_1 = require("../send-event/sendEvent");
+const custom_event_1 = require("./custom-event");
+const core_1 = require("@sitecore-content-sdk/core");
+const plugin_1 = require("../../initialization/plugin");
+/**
+ * A function that sends an event to the SitecoreCloud API with the specified type
+ * @param {EventData} eventData - The required/optional attributes to be sent to the SitecoreCloud API
+ * @returns The response object that Sitecore Edge Proxy returns
+ * @public
+ */
+async function event(eventData) {
+    const coreContext = (0, core_1.getCoreContext)();
+    await coreContext.readyPromise;
+    (0, plugin_1.getEventsPlugin)();
+    const { options, adapter } = (0, internal_1.getAnalyticsPlugin)();
+    const id = adapter.getClientId() || '';
+    return new custom_event_1.CustomEvent({
+        eventData,
+        id,
+        sendEvent: sendEvent_1.sendEvent,
+        config: Object.assign(Object.assign({}, coreContext.config), options),
+    }).send();
+}

package/dist/cjs/src/events/custom-event/form.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.form = form;
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const sendEvent_1 = require("../send-event/sendEvent");
+const custom_event_1 = require("./custom-event");
+const core_1 = require("@sitecore-content-sdk/core");
+const plugin_1 = require("../../initialization/plugin");
+/**
+ * A function that sends a form event to the SitecoreCloud API
+ * @param {string} formId - The required form ID string
+ * @param {'VIEWED' | 'SUBMITTED'} interactionType - The required interaction type string. Possible values: `VIEWED`, `SUBMITTED`
+ * @param {string} componentInstanceId - The required component instance ID string
+ * @returns The response object that Sitecore Edge Proxy returns or null
+ * @public
+ */
+async function form(formId, interactionType, componentInstanceId) {
+    const coreContext = (0, core_1.getCoreContext)();
+    await coreContext.readyPromise;
+    (0, plugin_1.getEventsPlugin)();
+    const { options, adapter } = (0, internal_1.getAnalyticsPlugin)();
+    const id = adapter.getClientId() || '';
+    const formEvent = new custom_event_1.CustomEvent({
+        eventData: {
+            extensionData: {
+                componentInstanceId,
+                formId,
+                interactionType: interactionType.toUpperCase(),
+            },
+            type: 'FORM',
+        },
+        id,
+        sendEvent: sendEvent_1.sendEvent,
+        config: Object.assign(Object.assign({}, coreContext.config), options),
+    });
+    formEvent.page = undefined;
+    return formEvent.send();
+}

package/dist/cjs/src/events/identity/identity-event.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdentityEvent = void 0;
+const utils_1 = require("@sitecore-content-sdk/analytics-core/utils");
+const base_event_1 = require("../base-event");
+const consts_1 = require("../consts");
+const core_1 = require("@sitecore-content-sdk/core");
+const { ERROR_MESSAGES } = core_1.constants;
+/**
+ * A class that extends from {@link BaseEvent} and has all the required functionality to send an IDENTITY event
+ */
+class IdentityEvent extends base_event_1.BaseEvent {
+    /**
+     * A class that extends from {@link BaseEvent} and has all the required functionality to send an IDENTITY event
+     * @param {IdentityEventArguments} args - Unified object containing the required properties
+     */
+    constructor(args) {
+        const { channel, currency, language, page, extensionData } = args.identityData;
+        super({ channel, currency, language, page }, args.id);
+        this.extensionData = {};
+        this.numberOfExtensionDataProperties = 0;
+        this.validateAttributes(args.identityData);
+        this.identityData = args.identityData;
+        this.sendEvent = args.sendEvent;
+        this.config = args.config;
+        if (extensionData)
+            this.extensionData = (0, utils_1.flattenObject)({ object: extensionData });
+        this.numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
+        if (this.numberOfExtensionDataProperties > consts_1.MAX_EXT_ATTRIBUTES)
+            throw new Error(ERROR_MESSAGES.IV_006(consts_1.MAX_EXT_ATTRIBUTES));
+    }
+    /**
+     * Sends the event to Sitecore Edge Proxy
+     * @returns - A promise that resolves with either the Sitecore Edge Proxy response object or null
+     */
+    async send() {
+        const baseAttr = this.mapBaseEventPayload();
+        const eventAttrs = this.mapAttributes();
+        const fetchBody = Object.assign({}, eventAttrs, baseAttr);
+        return await this.sendEvent(fetchBody, this.config);
+    }
+    /**
+     * Function that validates the identifiers object, email, and date attributes for CDN users
+     * @param {IdentityData} identityData - The data to be validated
+     */
+    validateAttributes(identityData) {
+        if (identityData.identifiers.length === 0)
+            throw new Error(ERROR_MESSAGES.MV_003);
+        if (identityData.dob !== undefined && !(0, utils_1.isShortISODateString)(identityData.dob))
+            throw new Error(ERROR_MESSAGES.IV_003);
+        identityData.identifiers.forEach((identifier) => {
+            if (identifier.expiryDate && !(0, utils_1.isShortISODateString)(identifier.expiryDate))
+                throw new Error(ERROR_MESSAGES.IV_005);
+        });
+        if (identityData.email && !(0, utils_1.isValidEmail)(identityData.email))
+            throw new Error(ERROR_MESSAGES.IV_004);
+    }
+    /**
+     * A function that maps the identity event input data with the payload sent to the API
+     * @returns - The payload object
+     */
+    mapAttributes() {
+        const identityPayload = {
+            city: this.identityData.city,
+            country: this.identityData.country,
+            dob: this.identityData.dob,
+            email: this.identityData.email,
+            firstname: this.identityData.firstName,
+            gender: this.identityData.gender,
+            identifiers: this.identityData.identifiers.map((value) => {
+                return {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    expiry_date: value.expiryDate,
+                    id: value.id,
+                    provider: value.provider,
+                };
+            }),
+            lastname: this.identityData.lastName,
+            mobile: this.identityData.mobile,
+            phone: this.identityData.phone,
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            postal_code: this.identityData.postalCode,
+            state: this.identityData.state,
+            street: this.identityData.street,
+            title: this.identityData.title,
+            type: 'IDENTITY',
+        };
+        if (this.numberOfExtensionDataProperties > 0)
+            identityPayload.ext = this.extensionData;
+        return identityPayload;
+    }
+}
+exports.IdentityEvent = IdentityEvent;

package/dist/cjs/src/events/identity/identity.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.identity = identity;
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const sendEvent_1 = require("../send-event/sendEvent");
+const identity_event_1 = require("./identity-event");
+const core_1 = require("@sitecore-content-sdk/core");
+const plugin_1 = require("../../initialization/plugin");
+/**
+ * A function that sends an IDENTITY event to the SitecoreCloud API
+ * @param {IdentityData} identityData - The required/optional attributes to be sent to the SitecoreCloud API
+ * @returns The response object that Sitecore Edge Proxy returns
+ * @public
+ */
+async function identity(identityData) {
+    const coreContext = (0, core_1.getCoreContext)();
+    await coreContext.readyPromise;
+    (0, plugin_1.getEventsPlugin)();
+    const { options, adapter } = (0, internal_1.getAnalyticsPlugin)();
+    const id = adapter.getClientId() || '';
+    return new identity_event_1.IdentityEvent({
+        id,
+        identityData,
+        sendEvent: sendEvent_1.sendEvent,
+        config: Object.assign(Object.assign({}, coreContext.config), options),
+    }).send();
+}

package/dist/cjs/src/events/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdentityEvent = exports.CustomEvent = exports.PageViewEvent = exports.BaseEvent = void 0;
+var base_event_1 = require("./base-event");
+Object.defineProperty(exports, "BaseEvent", { enumerable: true, get: function () { return base_event_1.BaseEvent; } });
+var page_view_event_1 = require("./page-view/page-view-event");
+Object.defineProperty(exports, "PageViewEvent", { enumerable: true, get: function () { return page_view_event_1.PageViewEvent; } });
+var custom_event_1 = require("./custom-event/custom-event");
+Object.defineProperty(exports, "CustomEvent", { enumerable: true, get: function () { return custom_event_1.CustomEvent; } });
+var identity_event_1 = require("./identity/identity-event");
+Object.defineProperty(exports, "IdentityEvent", { enumerable: true, get: function () { return identity_event_1.IdentityEvent; } });

package/dist/cjs/src/events/page-view/page-view-event.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageViewEvent = void 0;
+const consts_1 = require("../consts");
+const base_event_1 = require("../base-event");
+const utils_1 = require("@sitecore-content-sdk/analytics-core/utils");
+const core_1 = require("@sitecore-content-sdk/core");
+const { ERROR_MESSAGES } = core_1.constants;
+/**
+ * A class that extends from {@link BaseEvent} and has all the required functionality to send a VIEW event
+ */
+class PageViewEvent extends base_event_1.BaseEvent {
+    /**
+     * A class that extends from {@link BaseEvent} and has all the required functionality to send a VIEW event
+     * @param {PageViewEventArguments} args - Unified object containing the required properties
+     */
+    constructor(args) {
+        var _a;
+        const { channel, currency, language, page, extensionData } = Object.assign({}, args.pageViewData);
+        super({
+            channel,
+            currency,
+            language,
+            page,
+        }, args.id);
+        this.extensionData = {};
+        this.pageViewData = args.pageViewData;
+        this.sendEvent = args.sendEvent;
+        this.config = args.config;
+        this.urlSearchParams = new URLSearchParams(decodeURI(args.searchParams));
+        if (extensionData)
+            this.extensionData = (0, utils_1.flattenObject)({ object: extensionData });
+        const numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
+        if (numberOfExtensionDataProperties > consts_1.MAX_EXT_ATTRIBUTES)
+            throw new Error(ERROR_MESSAGES.IV_006(consts_1.MAX_EXT_ATTRIBUTES));
+        this.includeUTMParameters =
+            (_a = (args.pageViewData && args.pageViewData.includeUTMParameters)) !== null && _a !== void 0 ? _a : true;
+    }
+    /**
+     * Sends the event to Sitecore Edge Proxy
+     * @returns - A promise that resolves with either the Sitecore Edge Proxy response object or null
+     */
+    async send() {
+        const baseAttr = this.mapBaseEventPayload();
+        const eventAttrs = this.mapAttributes();
+        PageViewEvent.isFirstPageView = false;
+        return await this.sendEvent(Object.assign(Object.assign({}, baseAttr), eventAttrs), this.config);
+    }
+    /**
+     * Gets the variant ID from the url if not passed by the developer
+     * Gets the variant ID from the extension data if not found from the url
+     * @param {string} [pageVariantIdFromPageViewData] - The variant ID from the page view data
+     * @param {string} [pageVariantIdFromExt] - The variant ID from extension data
+     * @returns - variant ID or null
+     */
+    getPageVariantId(pageVariantIdFromPageViewData, pageVariantIdFromExt) {
+        if (pageVariantIdFromPageViewData)
+            return pageVariantIdFromPageViewData;
+        const pageVariantIdFromURL = this.urlSearchParams.get('variantid');
+        if (pageVariantIdFromURL)
+            return pageVariantIdFromURL;
+        if (pageVariantIdFromExt)
+            return pageVariantIdFromExt;
+        return null;
+    }
+    /**
+     * Returns the referrer if exists on page view event else null if on server and no referrer is on event, else
+     * returns the href if on client side and the document referrer is different from the window location hostname
+     * @returns - the referrer
+     */
+    getReferrer() {
+        var _a;
+        if ((_a = this.pageViewData) === null || _a === void 0 ? void 0 : _a.referrer)
+            return this.pageViewData.referrer;
+        if (typeof window === 'undefined')
+            return null;
+        if (!PageViewEvent.isFirstPageView || !document.referrer)
+            return null;
+        const { hostname, href } = new URL(document.referrer);
+        return window.location.hostname !== hostname ? href : null;
+    }
+    /**
+     * Maps parameters given as input to corresponding attributes send to the API
+     * @returns the mapped object to be sent as payload
+     */
+    mapAttributes() {
+        var _a;
+        let pageViewPayload = {
+            type: 'VIEW',
+        };
+        const pageVariantId = this.pageViewData &&
+            this.getPageVariantId(this.pageViewData.pageVariantId, this.extensionData.pageVariantId);
+        if (pageVariantId !== null)
+            pageViewPayload.ext = Object.assign(Object.assign({}, pageViewPayload.ext), { pageVariantId });
+        if (Object.keys(this.extensionData).length > 0) {
+            delete this.extensionData.pageVariantId;
+            pageViewPayload.ext = Object.assign(Object.assign({}, pageViewPayload.ext), this.extensionData);
+        }
+        if (this.includeUTMParameters) {
+            const utmParameters = this.getUTMParameters();
+            pageViewPayload = Object.assign(Object.assign({}, pageViewPayload), utmParameters);
+        }
+        const referrer = this.getReferrer();
+        if (referrer !== null)
+            pageViewPayload = Object.assign(Object.assign({}, pageViewPayload), { referrer });
+        if ((_a = this.pageViewData) === null || _a === void 0 ? void 0 : _a.searchData)
+            pageViewPayload.sc_search = {
+                data: this.pageViewData.searchData,
+                metadata: {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    ut_api_version: '1.0',
+                },
+            };
+        return pageViewPayload;
+    }
+    /**
+     * Retrieves UTM parameters from the url query string
+     * @returns - an object containing the UTM parameters if they exist
+     */
+    getUTMParameters() {
+        const utmParameters = {};
+        this.urlSearchParams.forEach((value, key) => {
+            const param = key.toLowerCase();
+            if (param.indexOf(consts_1.UTM_PREFIX) === 0)
+                utmParameters[param] = value;
+        });
+        return utmParameters;
+    }
+}
+exports.PageViewEvent = PageViewEvent;
+PageViewEvent.isFirstPageView = true;

package/dist/cjs/src/events/page-view/page-view.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pageView = pageView;
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const sendEvent_1 = require("../send-event/sendEvent");
+const page_view_event_1 = require("./page-view-event");
+const core_1 = require("@sitecore-content-sdk/core");
+const plugin_1 = require("../../initialization/plugin");
+/**
+ * A function that sends a VIEW event to the SitecoreCloud API
+ * @param {PageViewData} [pageViewData] - The optional attributes to be sent to the SitecoreCloud API
+ * This object will be flattened and sent in the ext object of the payload
+ * @returns The response object that Sitecore Edge Proxy returns
+ * @public
+ */
+async function pageView(pageViewData) {
+    const coreContext = (0, core_1.getCoreContext)();
+    await coreContext.readyPromise;
+    (0, plugin_1.getEventsPlugin)();
+    const { options, adapter } = (0, internal_1.getAnalyticsPlugin)();
+    const id = adapter.getClientId() || '';
+    const searchParams = adapter.location.getSearchParams();
+    return new page_view_event_1.PageViewEvent({
+        id,
+        pageViewData,
+        searchParams,
+        sendEvent: sendEvent_1.sendEvent,
+        config: Object.assign(Object.assign({}, coreContext.config), options),
+    }).send();
+}

package/dist/cjs/src/events/send-event/sendEvent.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendEvent = sendEvent;
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const consts_1 = require("../../consts");
+const core_1 = require("@sitecore-content-sdk/core");
+const debug_1 = require("../../debug");
+/**
+ * This function sends an event to Sitecore Edge Proxy
+ * @param {EPFetchBody & BasePayload} body - The event data to send
+ * @param {CoreContext['config']} config - The global configuration
+ * @internal
+ */
+async function sendEvent(body, config) {
+    // eslint-disable-next-line max-len
+    const eventUrl = `${config.edgeUrl}/v1/events/${internal_1.API_VERSION}/events?siteId=${config.siteName}`;
+    const fetchOptions = {
+        body: JSON.stringify(body),
+        headers: {
+            'Content-Type': 'application/json',
+            'X-Client-Software-ID': consts_1.X_CLIENT_SOFTWARE_ID,
+            'X-Library-Version': consts_1.PACKAGE_VERSION,
+            'x-sitecore-contextid': config.contextId,
+        },
+        method: 'POST',
+    };
+    const fetcher = new core_1.NativeDataFetcher({ debugger: debug_1.debug.events });
+    return await fetcher
+        .fetch(eventUrl, fetchOptions)
+        .then(async (response) => {
+        return response.data;
+    })
+        .catch(() => {
+        return null;
+    });
+}

package/dist/cjs/src/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eventsPlugin = exports.pageView = exports.identity = exports.event = exports.form = void 0;
+var form_1 = require("./events/custom-event/form");
+Object.defineProperty(exports, "form", { enumerable: true, get: function () { return form_1.form; } });
+var event_1 = require("./events/custom-event/event");
+Object.defineProperty(exports, "event", { enumerable: true, get: function () { return event_1.event; } });
+var identity_1 = require("./events/identity/identity");
+Object.defineProperty(exports, "identity", { enumerable: true, get: function () { return identity_1.identity; } });
+var page_view_1 = require("./events/page-view/page-view");
+Object.defineProperty(exports, "pageView", { enumerable: true, get: function () { return page_view_1.pageView; } });
+var plugin_1 = require("./initialization/plugin");
+Object.defineProperty(exports, "eventsPlugin", { enumerable: true, get: function () { return plugin_1.eventsPlugin; } });

package/dist/cjs/src/initialization/const.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVENTS_PLUGIN_NAME = void 0;
+/**
+ * The name of the Events plugin.
+ * @public
+ */
+exports.EVENTS_PLUGIN_NAME = 'EventsPlugin';

package/dist/cjs/src/initialization/plugin.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eventsPlugin = eventsPlugin;
+exports.getEventsPlugin = getEventsPlugin;
+const core_1 = require("@sitecore-content-sdk/core");
+const const_1 = require("./const");
+const consts_1 = require("../consts");
+const event_1 = require("../events/custom-event/event");
+const form_1 = require("../events/custom-event/form");
+const identity_1 = require("../events/identity/identity");
+const page_view_1 = require("../events/page-view/page-view");
+const addToEventQueue_1 = require("../eventStorage/addToEventQueue");
+const clearEventQueue_1 = require("../eventStorage/clearEventQueue");
+const processEventQueue_1 = require("../eventStorage/processEventQueue");
+const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
+const { ERROR_MESSAGES } = core_1.constants;
+/**
+ * Initializes the events plugin with the provided options.
+ * @internal
+ */
+async function init() {
+    if (typeof window !== 'undefined')
+        window.scContentSDK = Object.assign(Object.assign({}, window.scContentSDK), { events: {
+                addToEventQueue: addToEventQueue_1.addToEventQueue,
+                clearEventQueue: clearEventQueue_1.clearEventQueue,
+                event: event_1.event,
+                form: form_1.form,
+                identity: identity_1.identity,
+                pageView: page_view_1.pageView,
+                processEventQueue: processEventQueue_1.processEventQueue,
+                version: consts_1.PACKAGE_VERSION,
+            } });
+}
+/**
+ * Creates an events plugin with the provided options.
+ * @returns {EventsPlugin} The events plugin instance.
+ * @public
+ */
+function eventsPlugin() {
+    return {
+        name: const_1.EVENTS_PLUGIN_NAME,
+        init,
+        dependencies: [internal_1.ANALYTICS_PLUGIN_NAME],
+    };
+}
+/**
+ * Retrieves the events plugin instance from the core context.
+ * @returns {EventsPlugin} The events plugin instance.
+ * @internal
+ */
+function getEventsPlugin() {
+    const plugin = (0, core_1.getCoreContext)().plugins.get(const_1.EVENTS_PLUGIN_NAME);
+    if (!plugin)
+        throw new Error(ERROR_MESSAGES.IE_004(const_1.EVENTS_PLUGIN_NAME));
+    return plugin;
+}

package/dist/cjs/src/initialization/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/internal.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PACKAGE_NAME = exports.PACKAGE_VERSION = exports.EVENTS_PLUGIN_NAME = void 0;
+var const_1 = require("./initialization/const");
+Object.defineProperty(exports, "EVENTS_PLUGIN_NAME", { enumerable: true, get: function () { return const_1.EVENTS_PLUGIN_NAME; } });
+var consts_1 = require("./consts");
+Object.defineProperty(exports, "PACKAGE_VERSION", { enumerable: true, get: function () { return consts_1.PACKAGE_VERSION; } });
+Object.defineProperty(exports, "PACKAGE_NAME", { enumerable: true, get: function () { return consts_1.PACKAGE_NAME; } });

package/dist/esm/package.json

@@ -0,0 +1,80 @@
+{
+    "author": {
+        "name": "Sitecore Corporation",
+        "url": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html"
+    },
+    "bugs": {
+        "url": "https://github.com/Sitecore/content-sdk/issues"
+    },
+    "dependencies": {
+        "@sitecore-content-sdk/analytics-core": "2.0.0-canary.12",
+        "@sitecore-content-sdk/core": "2.0.0-canary.12",
+        "debug": "^4.4.3"
+    },
+    "description": "Enables real-time, unified tracking to send events to Sitecore.",
+    "devDependencies": {
+        "@jest/globals": "^30.2.0",
+        "@jest/types": "^29.6.3",
+        "@stylistic/eslint-plugin": "^5.2.2",
+        "@types/debug": "^4.1.12",
+        "@types/jest": "^29.5.12",
+        "@typescript-eslint/eslint-plugin": "8.39.0",
+        "@typescript-eslint/parser": "8.39.0",
+        "del-cli": "^6.0.0",
+        "eslint": "^9.32.0",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-import": "2.32.0",
+        "eslint-plugin-jsdoc": "52.0.3",
+        "eslint-plugin-prettier": "^4.0.0",
+        "jest": "^29.7.0",
+        "jest-environment-jsdom": "^29.7.0",
+        "jest-environment-node": "^29.7.0",
+        "ts-jest": "^29.4.6",
+        "ts-node": "^10.9.2"
+    },
+    "main": "dist/cjs/index.js",
+    "module": "dist/esm/index.js",
+    "types": "types/src/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/esm/src/index.js",
+            "require": "./dist/cjs/src/index.js",
+            "types": "./types/src/index.d.ts"
+        },
+        "./browser": {
+            "import": "./dist/esm/src/browser.js",
+            "require": "./dist/cjs/src/browser.js",
+            "types": "./types/src/browser.d.ts"
+        },
+        "./internal": {
+            "import": "./dist/esm/src/internal.js",
+            "require": "./dist/cjs/src/internal.js",
+            "types": "./types/src/internal.d.ts"
+        }
+    },
+    "files": [
+        "dist",
+        "types",
+        "/*.d.ts"
+    ],
+    "homepage": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html",
+    "license": "Apache-2.0",
+    "name": "@sitecore-content-sdk/events",
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "scripts": {
+        "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
+        "clean": "del-cli dist types",
+        "coverage": "jest --config jest.config.ts --coverage",
+        "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/events --entryPoints src/browser.ts --entryPoints src/internal.ts --entryPoints src/index.ts --githubPages false",
+        "lint": "eslint \"./src/**/*.ts\"",
+        "prepublishOnly": "npm run build",
+        "test": "jest --config jest.config.ts",
+        "api-extractor": "npm run build && api-extractor run --local --verbose",
+        "api-extractor:verify": "api-extractor run"
+    },
+    "version": "2.0.0-canary.12",
+    "gitHead": "4a26005860f4931f25d8c63d765a030e04a5b1f4"
+}

package/dist/esm/src/browser.js

@@ -0,0 +1,3 @@
+export { addToEventQueue } from './eventStorage/addToEventQueue';
+export { processEventQueue } from './eventStorage/processEventQueue';
+export { clearEventQueue } from './eventStorage/clearEventQueue';

package/dist/esm/src/consts.js

@@ -0,0 +1,15 @@
+import packageJson from '../package.json';
+/**
+ * The package version.
+ * @internal
+ */
+export const PACKAGE_VERSION = packageJson.version;
+/**
+ * The package version.
+ * @internal
+ */
+export const PACKAGE_NAME = packageJson.name;
+/**
+ * Returns the name & version of the library in a String.
+ */
+export const X_CLIENT_SOFTWARE_ID = `${PACKAGE_NAME} ${PACKAGE_VERSION}`;

package/dist/esm/src/debug.js

@@ -0,0 +1,9 @@
+import { debugNamespace, debugModule } from '@sitecore-content-sdk/core';
+export const EVENTS_NAMESPACE = 'events';
+/**
+ * Debug module for events package
+ * @public
+ */
+export const debug = {
+    events: debugModule(`${debugNamespace}:${EVENTS_NAMESPACE}`),
+};

package/dist/esm/src/eventStorage/addToEventQueue.js

@@ -0,0 +1,22 @@
+import { getAnalyticsPlugin } from '@sitecore-content-sdk/analytics-core/internal';
+import { eventQueue } from './eventStorage';
+import { getCoreContext } from '@sitecore-content-sdk/core';
+import { getEventsPlugin } from '../initialization/plugin';
+/**
+ * A function that adds an event to the queue
+ * @param {EventData} eventData - The required/optional attributes in order to be sent to SitecoreCloud API
+ * @public
+ */
+export async function addToEventQueue(eventData) {
+    const coreContext = getCoreContext();
+    await coreContext.readyPromise;
+    getEventsPlugin();
+    const { options, adapter } = getAnalyticsPlugin();
+    const id = adapter.getClientId() || '';
+    const queueEventPayload = {
+        eventData,
+        id,
+        config: Object.assign(Object.assign({}, coreContext.config), options),
+    };
+    eventQueue.enqueueEvent(queueEventPayload);
+}

package/dist/esm/src/eventStorage/clearEventQueue.js

@@ -0,0 +1,12 @@
+import { getCoreContext } from '@sitecore-content-sdk/core';
+import { eventQueue } from './eventStorage';
+import { getEventsPlugin } from '../initialization/plugin';
+/**
+ * Deletes the queue from session.
+ * @public
+ */
+export async function clearEventQueue() {
+    await getCoreContext().readyPromise;
+    getEventsPlugin();
+    eventQueue.clearQueue();
+}