@sitecore-cloudsdk/events 0.1.0-rc.0

package/README.md

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

package/dist/cjs/package.json

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

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

@@ -0,0 +1,10 @@
+export { getBrowserId } from 'packages/core/src/lib/init/get-browser-id';
+export { init } from './lib/initializer/browser/initializer';
+export type { IPageViewEventInput, ICustomEventInput, IIdentityEventAttributesInput } from './lib/events';
+export { addToEventQueue } from './lib/eventStorage/addToEventQueue';
+export { processEventQueue } from './lib/eventStorage/processEventQueue';
+export { clearEventQueue } from './lib/eventStorage/clearEventQueue';
+export { form } from './lib/events/custom-event/form';
+export { event } from './lib/events/custom-event/event';
+export { identity } from './lib/events/identity/identity';
+export { pageView } from './lib/events/page-view/page-view';

package/dist/cjs/src/browser.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pageView = exports.identity = exports.event = exports.form = exports.clearEventQueue = exports.processEventQueue = exports.addToEventQueue = exports.init = exports.getBrowserId = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+var get_browser_id_1 = require("packages/core/src/lib/init/get-browser-id");
+Object.defineProperty(exports, "getBrowserId", { enumerable: true, get: function () { return get_browser_id_1.getBrowserId; } });
+var initializer_1 = require("./lib/initializer/browser/initializer");
+Object.defineProperty(exports, "init", { enumerable: true, get: function () { return initializer_1.init; } });
+var addToEventQueue_1 = require("./lib/eventStorage/addToEventQueue");
+Object.defineProperty(exports, "addToEventQueue", { enumerable: true, get: function () { return addToEventQueue_1.addToEventQueue; } });
+var processEventQueue_1 = require("./lib/eventStorage/processEventQueue");
+Object.defineProperty(exports, "processEventQueue", { enumerable: true, get: function () { return processEventQueue_1.processEventQueue; } });
+var clearEventQueue_1 = require("./lib/eventStorage/clearEventQueue");
+Object.defineProperty(exports, "clearEventQueue", { enumerable: true, get: function () { return clearEventQueue_1.clearEventQueue; } });
+var form_1 = require("./lib/events/custom-event/form");
+Object.defineProperty(exports, "form", { enumerable: true, get: function () { return form_1.form; } });
+var event_1 = require("./lib/events/custom-event/event");
+Object.defineProperty(exports, "event", { enumerable: true, get: function () { return event_1.event; } });
+var identity_1 = require("./lib/events/identity/identity");
+Object.defineProperty(exports, "identity", { enumerable: true, get: function () { return identity_1.identity; } });
+var page_view_1 = require("./lib/events/page-view/page-view");
+Object.defineProperty(exports, "pageView", { enumerable: true, get: function () { return page_view_1.pageView; } });

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

@@ -0,0 +1,4 @@
+export * from './browser';
+export * from './server';
+export { getGuestId } from './lib/getGuestId/getGuestId';
+export { LIBRARY_VERSION } from './lib/consts';

package/dist/cjs/src/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LIBRARY_VERSION = exports.getGuestId = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+__exportStar(require("./browser"), exports);
+__exportStar(require("./server"), exports);
+var getGuestId_1 = require("./lib/getGuestId/getGuestId");
+Object.defineProperty(exports, "getGuestId", { enumerable: true, get: function () { return getGuestId_1.getGuestId; } });
+var consts_1 = require("./lib/consts");
+Object.defineProperty(exports, "LIBRARY_VERSION", { enumerable: true, get: function () { return consts_1.LIBRARY_VERSION; } });

package/dist/cjs/src/lib/cdp/EventApiClient.d.ts

@@ -0,0 +1,24 @@
+import { ICdpResponse } from '@sitecore-cloudsdk/core';
+import type { IBasePayload, IPageViewEventPayload, IIdentityEventPayload, ICustomEventPayload } from '../events';
+export declare class EventApiClient implements IEventApiClient {
+    private targetURL;
+    private readonly eventUrl;
+    constructor(targetURL: string, sitecoreEdgeContextId: string, siteName: string);
+    /**
+     * A function that sends the payload to Sitecore CDP
+     * @param body - The Request body for the Sitecore CDP
+     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     */
+    send(body: TCdpFetchBody & IBasePayload): Promise<ICdpResponse | null>;
+}
+/**
+ * The interface of EventApiClient class
+ */
+export interface IEventApiClient {
+    send(body: TCdpFetchBody & IBasePayload): Promise<ICdpResponse | null>;
+}
+/**
+ * The type describing all possible event payloads
+ */
+type TCdpFetchBody = IPageViewEventPayload | IIdentityEventPayload | ICustomEventPayload;
+export {};

package/dist/cjs/src/lib/cdp/EventApiClient.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventApiClient = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const core_1 = require("@sitecore-cloudsdk/core");
+const consts_1 = require("../consts");
+class EventApiClient {
+    constructor(targetURL, sitecoreEdgeContextId, siteName) {
+        this.targetURL = targetURL;
+        this.eventUrl = `${this.targetURL}/events/${core_1.API_VERSION}/events?sitecoreContextId=${sitecoreEdgeContextId}&siteId=${siteName}`;
+    }
+    /**
+     * A function that sends the payload to Sitecore CDP
+     * @param body - The Request body for the Sitecore CDP
+     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     */
+    async send(body) {
+        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': consts_1.LIBRARY_VERSION,
+            },
+            method: 'POST',
+        };
+        return await fetch(this.eventUrl, fetchOptions)
+            .then((response) => response.json())
+            .then((data) => data)
+            .catch(() => null);
+    }
+}
+exports.EventApiClient = EventApiClient;

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

@@ -0,0 +1,4 @@
+/**
+ * Returns the version of the library.
+ */
+export declare const LIBRARY_VERSION: string;

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

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LIBRARY_VERSION = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+/* eslint-disable @typescript-eslint/naming-convention */
+const package_json_1 = __importDefault(require("../../package.json"));
+/**
+ * Returns the version of the library.
+ */
+exports.LIBRARY_VERSION = package_json_1.default.version;

package/dist/cjs/src/lib/eventStorage/addToEventQueue.d.ts

@@ -0,0 +1,9 @@
+import { ICustomEventInput, ExtensionData } from '../events';
+/**
+ * A function that adds event to the queue
+ * @param type - The required type of the event
+ * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
+ * @param extensionData - The optional extensionData attributes that will be sent to SitecoreCloud API.
+ * This object will be flattened and sent in the ext object of the payload
+ */
+export declare function addToEventQueue(type: string, eventData: ICustomEventInput, extensionData?: ExtensionData): void;

package/dist/cjs/src/lib/eventStorage/addToEventQueue.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addToEventQueue = void 0;
+const initializer_1 = require("../initializer/browser/initializer");
+/**
+ * A function that adds event to the queue
+ * @param type - The required type of the event
+ * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
+ * @param extensionData - The optional extensionData attributes that will be sent to SitecoreCloud API.
+ * This object will be flattened and sent in the ext object of the payload
+ */
+function addToEventQueue(type, eventData, extensionData) {
+    const { id, settings, eventQueue } = (0, initializer_1.getDependencies)();
+    const queueEventPayload = {
+        eventData,
+        extensionData,
+        id,
+        settings,
+        type,
+    };
+    eventQueue.enqueueEvent(queueEventPayload);
+}
+exports.addToEventQueue = addToEventQueue;

package/dist/cjs/src/lib/eventStorage/clearEventQueue.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Deletes the queue from session.
+ */
+export declare function clearEventQueue(): void;

package/dist/cjs/src/lib/eventStorage/clearEventQueue.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearEventQueue = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const initializer_1 = require("../initializer/browser/initializer");
+/**
+ * Deletes the queue from session.
+ */
+function clearEventQueue() {
+    const { eventQueue } = (0, initializer_1.getDependencies)();
+    eventQueue.clearQueue();
+}
+exports.clearEventQueue = clearEventQueue;

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

@@ -0,0 +1,39 @@
+import { EventApiClient } from '../cdp/EventApiClient';
+import { ICustomEventArguments } from '../events';
+export declare class EventQueue {
+    private storage;
+    private eventApiClient;
+    /**
+     * Initialize the Event Storage
+     * @param storage - Interface that describes the storage functionality
+     * @param eventApiClient - The API client which sends events to CDP
+     * @param infer - The instance of the infer class
+     */
+    private key;
+    constructor(storage: IStorage, eventApiClient: EventApiClient);
+    /** Returns the stored array of data with type QueueEventPayload, or empty array if the given key does not exist. */
+    private getEventQueue;
+    /**
+     * Adds the required event data to the queue and stores it in the storage.
+     * @param queueEventPayload - The required event data for the creation of a CustomEvent.
+     * Performs validation by creating a new CustomEvent.
+     */
+    enqueueEvent(queueEventPayload: QueueEventPayload): void;
+    /**
+     * Iterates the queue, and sends sequently the custom events to Sitecore CDP.
+     */
+    sendAllEvents(): Promise<void>;
+    /**
+     * Clears the queue from storage.
+     */
+    clearQueue(): void;
+}
+/**
+ * This Storage interface represents the required storage functionality.
+ */
+export interface IStorage {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+export type QueueEventPayload = Pick<ICustomEventArguments, 'eventData' | 'extensionData' | 'type' | 'settings' | 'id'>;

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

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventQueue = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const core_1 = require("@sitecore-cloudsdk/core");
+const events_1 = require("../events");
+class EventQueue {
+    constructor(storage, eventApiClient) {
+        this.storage = storage;
+        this.eventApiClient = eventApiClient;
+        /**
+         * Initialize the Event Storage
+         * @param storage - Interface that describes the storage functionality
+         * @param eventApiClient - The API client which sends events to CDP
+         * @param infer - The instance of the infer class
+         */
+        this.key = 'EventQueue';
+    }
+    /** Returns the stored array of data with type QueueEventPayload, or empty array if the given key does not exist. */
+    getEventQueue() {
+        const storedQueue = this.storage.getItem(this.key);
+        if (!storedQueue)
+            return [];
+        try {
+            const parsedQueueEvent = JSON.parse(storedQueue);
+            return Array.isArray(parsedQueueEvent) ? parsedQueueEvent : [];
+        }
+        catch {
+            return [];
+        }
+    }
+    /**
+     * Adds the required event data to the queue and stores it in the storage.
+     * @param queueEventPayload - The required event data for the creation of a CustomEvent.
+     * Performs validation by creating a new CustomEvent.
+     */
+    enqueueEvent(queueEventPayload) {
+        queueEventPayload.eventData.page = queueEventPayload.eventData.page ?? (0, core_1.pageName)();
+        queueEventPayload.eventData.language = queueEventPayload.eventData.language ?? (0, core_1.language)();
+        new events_1.CustomEvent({
+            eventApiClient: this.eventApiClient,
+            ...queueEventPayload,
+        });
+        const eventQueue = this.getEventQueue();
+        eventQueue.push(queueEventPayload);
+        this.storage.setItem(this.key, JSON.stringify(eventQueue));
+    }
+    /**
+     * Iterates the queue, and sends sequently the custom events to Sitecore CDP.
+     */
+    async sendAllEvents() {
+        const eventQueue = this.getEventQueue();
+        for (const queueEventPayload of eventQueue) {
+            await new events_1.CustomEvent({
+                eventApiClient: this.eventApiClient,
+                eventData: queueEventPayload.eventData,
+                extensionData: queueEventPayload.extensionData,
+                id: queueEventPayload.id,
+                settings: queueEventPayload.settings,
+                type: queueEventPayload.type,
+            }).send();
+        }
+        this.clearQueue();
+    }
+    /**
+     * Clears the queue from storage.
+     */
+    clearQueue() {
+        this.storage.removeItem(this.key);
+    }
+}
+exports.EventQueue = EventQueue;

package/dist/cjs/src/lib/eventStorage/processEventQueue.d.ts

@@ -0,0 +1,5 @@
+/**
+ * A function that sends all queue events to SitecoreCloud API.
+ * Clears the queue upon completion.
+ */
+export declare function processEventQueue(): void;

package/dist/cjs/src/lib/eventStorage/processEventQueue.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processEventQueue = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const initializer_1 = require("../initializer/browser/initializer");
+/**
+ * A function that sends all queue events to SitecoreCloud API.
+ * Clears the queue upon completion.
+ */
+function processEventQueue() {
+    const { eventQueue } = (0, initializer_1.getDependencies)();
+    eventQueue.sendAllEvents();
+}
+exports.processEventQueue = processEventQueue;

package/dist/cjs/src/lib/events/base-event.d.ts

@@ -0,0 +1,36 @@
+import type { ISettings } from '@sitecore-cloudsdk/core';
+import { IEventAttributesInput } from './common-interfaces';
+export declare class BaseEvent {
+    private baseEventData;
+    protected settings: ISettings;
+    private readonly browserId;
+    private readonly language;
+    page: string;
+    /**
+     * The base event class that has all the shared functions between Events
+     * @param baseEventData - The event data to send
+     * @param settings - The global settings
+     * @param id - The browser id
+     * @param infer - The source of methods to estimate language and page parameters
+     */
+    constructor(baseEventData: IBaseEventData, settings: ISettings, id: string);
+    /**
+     *  A function that returns the properties for sending events to Sitecore CDP
+     * @returns an object that is required
+     */
+    protected mapBaseEventPayload(): IBasePayload;
+}
+/**
+ *  An interface describing the basic payload to be sent to the API
+ */
+export interface IBasePayload {
+    browser_id: string;
+    channel?: string;
+    client_key: string;
+    currency?: string;
+    language?: string;
+    page?: string;
+    pos: string;
+}
+type IBaseEventData = Partial<IEventAttributesInput>;
+export {};

package/dist/cjs/src/lib/events/base-event.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseEvent = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const core_1 = require("@sitecore-cloudsdk/core");
+class BaseEvent {
+    /**
+     * The base event class that has all the shared functions between Events
+     * @param baseEventData - The event data to send
+     * @param settings - The global settings
+     * @param id - The browser id
+     * @param infer - The source of methods to estimate language and page parameters
+     */
+    constructor(baseEventData, settings, id) {
+        this.baseEventData = baseEventData;
+        this.settings = settings;
+        this.browserId = id;
+        this.language = this.baseEventData.language ?? (0, core_1.language)();
+        this.page = this.baseEventData.page ?? (0, core_1.pageName)();
+    }
+    /**
+     *  A function that returns the properties for sending events to Sitecore CDP
+     * @returns an object that is required
+     */
+    mapBaseEventPayload() {
+        return {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            browser_id: this.browserId,
+            channel: this.baseEventData.channel,
+            /* eslint-disable @typescript-eslint/naming-convention */
+            client_key: '',
+            currency: this.baseEventData.currency,
+            language: this.language,
+            page: this.page,
+            pos: '',
+        };
+    }
+}
+exports.BaseEvent = BaseEvent;

package/dist/cjs/src/lib/events/common-interfaces.d.ts

@@ -0,0 +1,39 @@
+import { BasicTypes, INestedObject } from '@sitecore-cloudsdk/utils';
+/**
+ * Event data received as input to be sent to Sitecore CDP
+ */
+interface IMandatoryInput {
+    channel: string;
+    currency: string;
+}
+type IMandatoryEventInput = IMandatoryInput;
+/**
+ * Event data that is sent to Sitecore CDP
+ */
+interface IInferrableInput {
+    /**
+     * To be restored back to IMandatoryEventInput Interface
+     * as mandatory input parameter in version 1.0.0
+     */
+    pointOfSale?: string;
+    language?: string;
+    page?: string;
+}
+type IInferrableEventInput = IInferrableInput;
+/**
+ * Interface to hold the base event attributes
+ */
+export interface IEventAttributesInput extends IMandatoryEventInput, IInferrableEventInput {
+}
+/**
+ * Interface to hold the "ext" data
+ */
+export interface IExtensionData {
+    pageVariantId?: string;
+    [key: string]: BasicTypes;
+}
+/**
+ * Type of the extension data that the developer can pass to events
+ */
+export type ExtensionData = INestedObject;
+export {};

package/dist/cjs/src/lib/events/common-interfaces.js

@@ -0,0 +1,3 @@
+"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 });

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

@@ -0,0 +1,2 @@
+export declare const MAX_EXT_ATTRIBUTES = 50;
+export declare const UTM_PREFIX = "utm_";

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

@@ -0,0 +1,7 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+/* eslint-disable @typescript-eslint/naming-convention */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UTM_PREFIX = exports.MAX_EXT_ATTRIBUTES = void 0;
+exports.MAX_EXT_ATTRIBUTES = 50;
+exports.UTM_PREFIX = 'utm_';

package/dist/cjs/src/lib/events/custom-event/custom-event.d.ts

@@ -0,0 +1,50 @@
+import { BaseEvent } from '../base-event';
+import { IEventAttributesInput } from '../common-interfaces';
+import { IEventApiClient } from '../../cdp/EventApiClient';
+import { ICdpResponse, ISettings } from '@sitecore-cloudsdk/core';
+import { BasicTypes, INestedObject } from '@sitecore-cloudsdk/utils';
+export declare class CustomEvent extends BaseEvent {
+    customEventPayload: ICustomEventPayload;
+    private eventApiClient;
+    private extensionData;
+    /**
+     * 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
+     */
+    constructor(args: ICustomEventArguments);
+    /**
+     * Sends the event to Sitecore CDP
+     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     */
+    send(): Promise<ICdpResponse | null>;
+}
+/**
+ * Interface of the unified arguments object for custom event
+ */
+export interface ICustomEventArguments {
+    eventApiClient: IEventApiClient;
+    eventData: ICustomEventData;
+    id: string;
+    extensionData?: INestedObject;
+    settings: ISettings;
+    type: string;
+}
+/**
+ * Interface with the required/optional attributes in order to send a custom event to SitecoreCloud API
+ */
+export interface ICustomEventPayload extends INestedObject {
+    ext?: {
+        [key: string]: BasicTypes;
+    };
+}
+/**
+ * Interface with the required/optional attributes in order to send a custom event to SitecoreCloud API
+ */
+export interface ICustomEventInput extends IEventAttributesInput, INestedObject {
+}
+/**
+ * Internal interface with the required/optional attributes in order to send a custom event to SitecoreCloud API
+ */
+interface ICustomEventData extends Partial<IEventAttributesInput>, INestedObject {
+}
+export {};

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

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomEvent = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const base_event_1 = require("../base-event");
+const utils_1 = require("@sitecore-cloudsdk/utils");
+const consts_1 = require("../consts");
+class CustomEvent extends base_event_1.BaseEvent {
+    /**
+     * 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
+     */
+    constructor(args) {
+        const { channel, currency, language, page, ...rest } = args.eventData;
+        super({ channel, currency, language, page }, args.settings, args.id);
+        this.extensionData = {};
+        this.eventApiClient = args.eventApiClient;
+        this.customEventPayload = {
+            type: args.type,
+            ...rest,
+        };
+        if (args.extensionData)
+            this.extensionData = (0, utils_1.flattenObject)({ object: args.extensionData });
+        const numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
+        if (numberOfExtensionDataProperties > consts_1.MAX_EXT_ATTRIBUTES)
+            throw new Error(`[IV-0005] This event supports maximum ${consts_1.MAX_EXT_ATTRIBUTES} attributes. Reduce the number of attributes.`);
+        if (numberOfExtensionDataProperties > 0)
+            this.customEventPayload.ext = this.extensionData;
+    }
+    /**
+     * Sends the event to Sitecore CDP
+     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     */
+    async send() {
+        const baseAttr = this.mapBaseEventPayload();
+        const fetchBody = Object.assign({}, this.customEventPayload, baseAttr);
+        return await this.eventApiClient.send(fetchBody);
+    }
+}
+exports.CustomEvent = CustomEvent;

package/dist/cjs/src/lib/events/custom-event/event.d.ts

@@ -0,0 +1,12 @@
+import { ICdpResponse } from '@sitecore-cloudsdk/core';
+import { ExtensionData } from '../common-interfaces';
+import { ICustomEventInput } from './custom-event';
+/**
+ * A function that sends an event to SitecoreCloud API with the specified type
+ * @param type - The required type of the event
+ * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
+ * @param extensionData - The optional extensionData attributes that will be sent to SitecoreCloud API.
+ * This object will be flattened and sent in the ext object of the payload
+ * @returns The response object that Sitecore CDP returns
+ */
+export declare function event(type: string, eventData: ICustomEventInput, extensionData?: ExtensionData): Promise<ICdpResponse | null>;

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

@@ -0,0 +1,26 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.event = void 0;
+const custom_event_1 = require("./custom-event");
+const initializer_1 = require("../../initializer/browser/initializer");
+/**
+ * A function that sends an event to SitecoreCloud API with the specified type
+ * @param type - The required type of the event
+ * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
+ * @param extensionData - The optional extensionData attributes that will be sent to SitecoreCloud API.
+ * This object will be flattened and sent in the ext object of the payload
+ * @returns The response object that Sitecore CDP returns
+ */
+function event(type, eventData, extensionData) {
+    const { eventApiClient, id, settings } = (0, initializer_1.getDependencies)();
+    return new custom_event_1.CustomEvent({
+        eventApiClient,
+        eventData,
+        extensionData,
+        id,
+        settings,
+        type,
+    }).send();
+}
+exports.event = event;