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

package/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/types/src/browser.d.ts

@@ -0,0 +1,4 @@
+export { addToEventQueue } from './eventStorage/addToEventQueue';
+export { processEventQueue } from './eventStorage/processEventQueue';
+export { clearEventQueue } from './eventStorage/clearEventQueue';
+//# sourceMappingURL=browser.d.ts.map

package/types/src/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC"}

package/types/src/consts.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The package version.
+ * @internal
+ */
+export declare const PACKAGE_VERSION: string;
+/**
+ * The package version.
+ * @internal
+ */
+export declare const PACKAGE_NAME: string;
+/**
+ * Returns the name & version of the library in a String.
+ */
+export declare const X_CLIENT_SOFTWARE_ID: string;
+//# sourceMappingURL=consts.d.ts.map

package/types/src/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../src/consts.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAsB,CAAC;AACnD;;;GAGG;AACH,eAAO,MAAM,YAAY,QAAmB,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAuC,CAAC"}

package/types/src/debug.d.ts

@@ -0,0 +1,9 @@
+export declare const EVENTS_NAMESPACE = "events";
+/**
+ * Debug module for events package
+ * @public
+ */
+export declare const debug: {
+    events: import("debug").Debugger;
+};
+//# sourceMappingURL=debug.d.ts.map

package/types/src/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/debug.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,gBAAgB,WAAW,CAAC;AACzC;;;GAGG;AACH,eAAO,MAAM,KAAK;;CAEjB,CAAC"}

package/types/src/eventStorage/addToEventQueue.d.ts

@@ -0,0 +1,8 @@
+import type { EventData } from '../events';
+/**
+ * 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 declare function addToEventQueue(eventData: EventData): Promise<void>;
+//# sourceMappingURL=addToEventQueue.d.ts.map

package/types/src/eventStorage/addToEventQueue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addToEventQueue.d.ts","sourceRoot":"","sources":["../../../src/eventStorage/addToEventQueue.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAM3C;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAezE"}

package/types/src/eventStorage/clearEventQueue.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Deletes the queue from session.
+ * @public
+ */
+export declare function clearEventQueue(): Promise<void>;
+//# sourceMappingURL=clearEventQueue.d.ts.map

package/types/src/eventStorage/clearEventQueue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clearEventQueue.d.ts","sourceRoot":"","sources":["../../../src/eventStorage/clearEventQueue.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CAKrD"}

package/types/src/eventStorage/eventStorage.d.ts

@@ -0,0 +1,31 @@
+import type { CustomEventArguments } from '../events';
+declare class EventQueue {
+    /**
+     * Initialize the Event Storage
+     */
+    private key;
+    /**
+     * Adds the required event data to the queue and stores it in the storage.
+     * @param {QueueEventPayload} queueEventPayload - The required event data for the creation of a `CustomEvent`.
+     * Validates by creating a new `CustomEvent`.
+     */
+    enqueueEvent(queueEventPayload: QueueEventPayload): void;
+    /**
+     * Iterates the queue and sends sequentially the custom events to Sitecore Edge Proxy.
+     */
+    sendAllEvents(): Promise<void>;
+    /**
+     * Clears the queue from storage.
+     */
+    clearQueue(): void;
+    /** Returns the stored array of data with type `QueueEventPayload`, or empty array if the given key does not exist. */
+    private getEventQueue;
+    private getSessionStorage;
+}
+/**
+ * @internal
+ */
+export type QueueEventPayload = Pick<CustomEventArguments, 'eventData' | 'config' | 'id'>;
+export declare const eventQueue: EventQueue;
+export {};
+//# sourceMappingURL=eventStorage.d.ts.map

package/types/src/eventStorage/eventStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventStorage.d.ts","sourceRoot":"","sources":["../../../src/eventStorage/eventStorage.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAGtD,cAAM,UAAU;IACd;;OAEG;IACH,OAAO,CAAC,GAAG,CAAgB;IAE3B;;;;OAIG;IACH,YAAY,CAAC,iBAAiB,EAAE,iBAAiB;IAgBjD;;OAEG;IACG,aAAa;IAcnB;;OAEG;IACH,UAAU;IAKV,sHAAsH;IACtH,OAAO,CAAC,aAAa;IAcrB,OAAO,CAAC,iBAAiB;CAG1B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,EAAE,WAAW,GAAG,QAAQ,GAAG,IAAI,CAAC,CAAC;AAE1F,eAAO,MAAM,UAAU,YAAmB,CAAC"}

package/types/src/eventStorage/processEventQueue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A function that sends all queue events to the SitecoreCloud API.
+ * Clears the queue upon completion.
+ * @public
+ */
+export declare function processEventQueue(): Promise<void>;
+//# sourceMappingURL=processEventQueue.d.ts.map

package/types/src/eventStorage/processEventQueue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"processEventQueue.d.ts","sourceRoot":"","sources":["../../../src/eventStorage/processEventQueue.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAKvD"}

package/types/src/events/base-event.d.ts

@@ -0,0 +1,35 @@
+import type { EventAttributesInput } from './common-interfaces';
+export declare class BaseEvent {
+    private baseEventData;
+    page: string;
+    private readonly clientId;
+    private readonly language;
+    /**
+     * The base event class that has all the shared functions between Events
+     * @param {BaseEventData} baseEventData - The event data to send
+     * @param {string} id - The client id
+     */
+    constructor(baseEventData: BaseEventData, id: string);
+    /**
+     *  A function that returns the properties for sending events to the Sitecore Edge Proxy.
+     * @returns an object that is required
+     */
+    protected mapBaseEventPayload(): BasePayload;
+}
+/**
+ *  An interface describing the basic payload to be sent to the API
+ * @internal
+ */
+export interface BasePayload {
+    browser_id: string;
+    channel?: string;
+    client_key: string;
+    currency?: string;
+    language?: string;
+    page?: string;
+    pos: string;
+    requested_at: string;
+}
+type BaseEventData = EventAttributesInput;
+export {};
+//# sourceMappingURL=base-event.d.ts.map

package/types/src/events/base-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-event.d.ts","sourceRoot":"","sources":["../../../src/events/base-event.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,qBAAa,SAAS;IASR,OAAO,CAAC,aAAa;IAR1B,IAAI,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C;;;;OAIG;gBACiB,aAAa,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM;IAM5D;;;OAGG;IACH,SAAS,CAAC,mBAAmB,IAAI,WAAW;CAY7C;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,KAAK,aAAa,GAAG,oBAAoB,CAAC"}

package/types/src/events/common-interfaces.d.ts

@@ -0,0 +1,53 @@
+import type { NestedObject } from '@sitecore-content-sdk/analytics-core/utils';
+/**
+ * Event data that is sent to Sitecore Edge Proxy.
+ * @public
+ */
+export interface EventAttributesInput {
+    /**
+     * The language the site visitor interacts with your brand in.
+     *
+     * For example, if the site visitor selects the Japanese language in your app, the language is "JA".
+     *
+     * Format: uppercase ISO 639.
+     *
+     * Default for browser-side events: inferred from the HTML lang attribute. If lang is not specified, the default is an empty string.
+     *
+     * Default for server-side events: empty string.
+     */
+    language?: string;
+    /**
+     * The name of the webpage where the interaction with your brand takes place.
+     *
+     * Default for browser-side events: for the website root page, "Home Page". For other webpages, inferred from the URL pathname.
+     *
+     * Default for server-side events: empty string.
+     */
+    page?: string;
+    /**
+     * The touchpoint where the user interacts with your brand.
+     *
+     * For example, for webpages, the channel is "WEB". For mobile app screens, the channel is "MOBILE_APP".
+     *
+     * Format: uppercase.
+     *
+     * If unset, this property will not be part of the payload.
+     */
+    channel?: string;
+    /**
+     * The alphabetic currency code of the currency the site visitor uses in your app.
+     *
+     * For example, if the site visitor selects Australian dollars as the currency, the currency is "AUD".
+     *
+     * Format: uppercase ISO 4217.
+     *
+     * If unset, this property will not be part of the payload.
+     */
+    currency?: string;
+}
+/**
+ * Type of the extension data that the developer can pass to events.
+ * @public
+ */
+export type ExtensionData = NestedObject;
+//# sourceMappingURL=common-interfaces.d.ts.map

package/types/src/events/common-interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-interfaces.d.ts","sourceRoot":"","sources":["../../../src/events/common-interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAC;AAE/E;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,CAAC"}

package/types/src/events/consts.d.ts

@@ -0,0 +1,3 @@
+export declare const MAX_EXT_ATTRIBUTES = 50;
+export declare const UTM_PREFIX = "utm_";
+//# sourceMappingURL=consts.d.ts.map

package/types/src/events/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../../src/events/consts.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,KAAK,CAAC;AACrC,eAAO,MAAM,UAAU,SAAS,CAAC"}

package/types/src/events/custom-event/custom-event.d.ts

@@ -0,0 +1,79 @@
+import type { EPResponse } from '@sitecore-content-sdk/analytics-core/internal';
+import type { BasicTypes, NestedObject } from '@sitecore-content-sdk/analytics-core/utils';
+import { BaseEvent } from '../base-event';
+import type { EventAttributesInput, ExtensionData } from '../common-interfaces';
+import type { SendEvent } from '../send-event/sendEvent';
+import { CoreContext } from '@sitecore-content-sdk/core';
+/**
+ * A class that extends from {@link BaseEvent} and has all the required functionality to send a custom event
+ * @internal
+ */
+export declare class CustomEvent extends BaseEvent {
+    customEventPayload: CustomEventPayload;
+    private sendEvent;
+    private extensionData;
+    private config;
+    /**
+     * A class that extends from {@link BaseEvent} and has all the required functionality to send a custom event
+     * @param {CustomEventArguments} args - Unified object containing the required properties
+     */
+    constructor(args: CustomEventArguments);
+    /**
+     * Sends the event to Sitecore Edge Proxy
+     * @returns - A promise that resolves with either the Sitecore Edge Proxy response object or null
+     */
+    send(): Promise<EPResponse | null>;
+}
+/**
+ * Interface of the unified arguments object for custom event
+ * @internal
+ */
+export interface CustomEventArguments {
+    sendEvent: SendEvent;
+    eventData: EventData;
+    id: string;
+    config: CoreContext['config'];
+}
+/**
+ * Interface with the required/optional attributes to send a custom event to the SitecoreCloud API
+ * @internal
+ */
+export interface CustomEventPayload extends NestedObject {
+    sc_search?: {
+        data: NestedObject;
+        metadata: {
+            ut_api_version: string;
+        };
+    };
+    ext?: {
+        [key: string]: BasicTypes;
+    };
+}
+/**
+ * Interface with the required/optional attributes to send a custom event to the SitecoreCloud API
+ * @public
+ */
+export interface EventData extends EventAttributesInput, NestedObject {
+    /**
+     * The type of the event.
+     * To send a custom event using event, or to add a custom event to the event queue using addToEventQueue, set type to a unique value. Do not set type to a reserved event name.
+     *
+     * Recommendation: Include the name of the site in the unique value, for example, "myretailsite:CLICKED_PROMO".
+     */
+    type: string;
+    /**
+     * Sitecore Search data about the event.
+     *
+     * Use only in the following, standard events:
+     * `SC_SEARCH_WIDGET_VIEW`, `SC_SEARCH_WIDGET_CLICK`
+     *
+     * If set, the event and all its data will be available in Sitecore Search.
+     * Construct according to the Sitecore Search Events API reference and data model.
+     */
+    searchData?: NestedObject;
+    /**
+     * Any custom data to collect about an event in addition to the other attributes provided for the event data.
+     */
+    extensionData?: ExtensionData;
+}
+//# sourceMappingURL=custom-event.d.ts.map

package/types/src/events/custom-event/custom-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-event.d.ts","sourceRoot":"","sources":["../../../../src/events/custom-event/custom-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAChF,OAAO,KAAK,EACV,UAAU,EAEV,YAAY,EACb,MAAM,4CAA4C,CAAC;AAEpD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAEhF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAa,MAAM,4BAA4B,CAAC;AAIpE;;;GAGG;AACH,qBAAa,WAAY,SAAQ,SAAS;IACxC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,MAAM,CAAwB;IAEtC;;;OAGG;gBACS,IAAI,EAAE,oBAAoB;IAgCtC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;CAMzC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,SAAS,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,SAAS,CAAC,EAAE;QACV,IAAI,EAAE,YAAY,CAAC;QACnB,QAAQ,EAAE;YAAE,cAAc,EAAE,MAAM,CAAA;SAAE,CAAC;KACtC,CAAC;IACF,GAAG,CAAC,EAAE;QACJ,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;KAC3B,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,oBAAoB,EAAE,YAAY;IACnE;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B"}

package/types/src/events/custom-event/event.d.ts

@@ -0,0 +1,10 @@
+import type { EPResponse } from '@sitecore-content-sdk/analytics-core/internal';
+import type { EventData } from './custom-event';
+/**
+ * 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
+ */
+export declare function event(eventData: EventData): Promise<EPResponse | null>;
+//# sourceMappingURL=event.d.ts.map

package/types/src/events/custom-event/event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../../../src/events/custom-event/event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAIhF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAIhD;;;;;GAKG;AACH,wBAAsB,KAAK,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAe5E"}

package/types/src/events/custom-event/form.d.ts

@@ -0,0 +1,11 @@
+import type { EPResponse } from '@sitecore-content-sdk/analytics-core/internal';
+/**
+ * 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
+ */
+export declare function form(formId: string, interactionType: 'VIEWED' | 'SUBMITTED', componentInstanceId: string): Promise<EPResponse | null>;
+//# sourceMappingURL=form.d.ts.map

package/types/src/events/custom-event/form.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../../../src/events/custom-event/form.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAOhF;;;;;;;GAOG;AACH,wBAAsB,IAAI,CACxB,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,QAAQ,GAAG,WAAW,EACvC,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CA0B5B"}

package/types/src/events/identity/identity-event.d.ts

@@ -0,0 +1,184 @@
+import type { EPResponse, Infer } from '@sitecore-content-sdk/analytics-core/internal';
+import type { EventAttributesInput, ExtensionData } from '../common-interfaces';
+import { BaseEvent } from '../base-event';
+import type { FlattenedObject } from '@sitecore-content-sdk/analytics-core/utils';
+import type { SendEvent } from '../send-event/sendEvent';
+import { CoreContext } from '@sitecore-content-sdk/core';
+/**
+ * A class that extends from {@link BaseEvent} and has all the required functionality to send an IDENTITY event
+ */
+export declare class IdentityEvent extends BaseEvent {
+    private identityData;
+    private sendEvent;
+    private extensionData;
+    private numberOfExtensionDataProperties;
+    private config;
+    /**
+     * 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: IdentityEventArguments);
+    /**
+     * Sends the event to Sitecore Edge Proxy
+     * @returns - A promise that resolves with either the Sitecore Edge Proxy response object or null
+     */
+    send(): Promise<EPResponse | null>;
+    /**
+     * Function that validates the identifiers object, email, and date attributes for CDN users
+     * @param {IdentityData} identityData - The data to be validated
+     */
+    private validateAttributes;
+    /**
+     * A function that maps the identity event input data with the payload sent to the API
+     * @returns - The payload object
+     */
+    private mapAttributes;
+}
+/**
+ * The JSON array of objects that contain the identity identifiers
+ * @internal
+ */
+interface EPIdentifier {
+    expiry_date?: string;
+    id: string;
+    provider: string;
+}
+/**
+ * Interface with the necessary attributes for the input for sending identity events
+ * @public
+ */
+export interface IdentityData extends EventAttributesInput {
+    /**
+     * The site visitor's city address.
+     *
+     * Format: title case recommended.
+     */
+    city?: string;
+    /**
+     * The site visitor's country address.
+     *
+     * Format: uppercase ISO 3166-1 alpha-2.
+     */
+    country?: string;
+    /**
+     * The site visitor's date of birth.
+     *
+     * Format: ISO 8601.
+     */
+    dob?: string;
+    /**
+     * The site visitor's email address.
+     *
+     * Format: lowercase recommended.
+     */
+    email?: string;
+    /**
+     * The site visitor's first name.
+     *
+     * Format: title case recommended.
+     */
+    firstName?: string;
+    /**
+     * The site visitor's gender.
+     */
+    gender?: string;
+    /**
+     * The identifiers used for identifying site visitors.
+     */
+    identifiers: Identifier[];
+    /**
+     * The site visitor's last name.
+     *
+     * Format: title case recommended.
+     */
+    lastName?: string;
+    /**
+     * The site visitor's mobile number.
+     */
+    mobile?: string;
+    /**
+     * The site visitor's phone number.
+     */
+    phone?: string;
+    /**
+     * The site visitor's postal code.
+     */
+    postalCode?: string;
+    /**
+     * The site visitor's state address.
+     *
+     * Format: title case recommended.
+     */
+    state?: string;
+    /**
+     * The site visitor's street address.
+     *
+     * Format: title case recommended.
+     */
+    street?: string[];
+    /**
+     * The site visitor's title.
+     *
+     * Format: title case.
+     */
+    title?: string;
+    /**
+     * Any custom data to collect about an event in addition to the other attributes provided for the event data.
+     */
+    extensionData?: ExtensionData;
+}
+/**
+ * The JSON array of objects that contain the identity identifiers
+ * @public
+ */
+export interface Identifier {
+    /**
+     * The date the unique guest (site visitor) identifier expires. This is determined by your organization's identity system.
+     *
+     * Format: ISO 8601.
+     */
+    expiryDate?: string;
+    /**
+     * The unique guest (site visitor) identifier provided by your organization's identity system, such as a Customer Relationship Management (CRM) system.
+     */
+    id: string;
+    /**
+     * The name of your organization's identity system, external to SitecoreAI, that provided the unique guest (site visitor) identifier.
+     */
+    provider: string;
+}
+/**
+ *  An interface describing the identity event specific payload to be sent to the API
+ * @internal
+ */
+export interface IdentityEventPayload {
+    city?: string;
+    country?: string;
+    dob?: string;
+    email?: string;
+    firstname?: string;
+    gender?: string;
+    identifiers: EPIdentifier[];
+    lastname?: string;
+    mobile?: string;
+    phone?: string;
+    postal_code?: string;
+    state?: string;
+    street?: string[];
+    title?: string;
+    type: 'IDENTITY';
+    ext?: FlattenedObject;
+}
+/**
+ * Interface of the unified arguments object for the identity event
+ * @internal
+ */
+export interface IdentityEventArguments {
+    sendEvent: SendEvent;
+    identityData: IdentityData;
+    id: string;
+    config: CoreContext['config'];
+    infer?: Infer;
+}
+export {};
+//# sourceMappingURL=identity-event.d.ts.map

package/types/src/events/identity/identity-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity-event.d.ts","sourceRoot":"","sources":["../../../../src/events/identity/identity-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,+CAA+C,CAAC;AACvF,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAMhF,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4CAA4C,CAAC;AAElF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAa,MAAM,4BAA4B,CAAC;AAIpE;;GAEG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAC1C,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,+BAA+B,CAAK;IAC5C,OAAO,CAAC,MAAM,CAAwB;IAEtC;;;OAGG;gBACS,IAAI,EAAE,sBAAsB;IAmBxC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAQxC;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAe1B;;;OAGG;IACH,OAAO,CAAC,aAAa;CA+BtB;AAED;;;GAGG;AACH,UAAU,YAAY;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,oBAAoB;IACxD;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,YAAY,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,CAAC,EAAE,eAAe,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC9B,KAAK,CAAC,EAAE,KAAK,CAAC;CACf"}

package/types/src/events/identity/identity.d.ts

@@ -0,0 +1,10 @@
+import type { EPResponse } from '@sitecore-content-sdk/analytics-core/internal';
+import type { IdentityData } from './identity-event';
+/**
+ * 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
+ */
+export declare function identity(identityData: IdentityData): Promise<EPResponse | null>;
+//# sourceMappingURL=identity.d.ts.map

package/types/src/events/identity/identity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../../../../src/events/identity/identity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAGhF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAKrD;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAerF"}

package/types/src/events/index.d.ts

@@ -0,0 +1,10 @@
+export { BaseEvent } from './base-event';
+export type { BasePayload } from './base-event';
+export { PageViewEvent } from './page-view/page-view-event';
+export type { PageViewData, PageViewEventPayload } from './page-view/page-view-event';
+export { CustomEvent } from './custom-event/custom-event';
+export type { EventData, CustomEventPayload, CustomEventArguments, } from './custom-event/custom-event';
+export { IdentityEvent } from './identity/identity-event';
+export type { IdentityData, IdentityEventPayload } from './identity/identity-event';
+export type { ExtensionData } from './common-interfaces';
+//# sourceMappingURL=index.d.ts.map

package/types/src/events/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEtF,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,YAAY,EACV,SAAS,EACT,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEpF,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}