@sitecore-cloudsdk/events 0.2.4 → 0.3.1-rc.0

package/README.md

@@ -56,16 +56,7 @@ export default function Home() {
   };
 
   const sendPageViewEvent = async () => {
-    let eventData: any = {
-      channel: 'WEB',
-      currency: 'EUR',
-    };
-
-    let extensionData: any = {
-      customKey: 'customValue',
-    };
-
-    await pageView(eventData, extensionData);
+    await pageView();
 
     console.log('Sent VIEW event.');
   };
@@ -88,28 +79,15 @@ import { init, pageView } from '@sitecore-cloudsdk/events/server';
 export async function middleware(req: NextRequest) {
   const res = NextResponse.next();
 
-  await init(
-    {
-      sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || '',
-      siteName: process.env.NEXT_PUBLIC_SITENAME || '',
-      enableServerCookie: true,
-    },
-    req,
-    res
-  );
+  await init(req, res, {
+    sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || '',
+    siteName: process.env.NEXT_PUBLIC_SITENAME || '',
+    enableServerCookie: true,
+  });
 
   console.log(`Initialized "@sitecore-cloudsdk/events/server".`);
 
-  let eventData: any = {
-    channel: 'WEB',
-    currency: 'EUR',
-  };
-
-  let extensionData: any = {
-    customKey: 'customValue',
-  };
-
-  const pageViewRes = await pageView(eventData, req, extensionData);
+  const pageViewRes = await pageView(req);
 
   console.log('Sent VIEW event.');
 
@@ -119,4 +97,4 @@ export async function middleware(req: NextRequest) {
 
 ## Documentation
 
-[Official Sitecore Cloud SDK documentation](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-cloud-sdk.html)
+[Official Sitecore Cloud SDK documentation](https://doc.sitecore.com/xmc/en/developers/sdk/latest/cloud-sdk/index.html)

package/dist/cjs/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@sitecore-cloudsdk/events",
-    "version": "0.2.4",
+    "version": "0.3.1-rc.0",
     "license": "Apache-2.0",
-    "homepage": "https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-cloud-sdk.html",
+    "homepage": "https://doc.sitecore.com/xmc/en/developers/sdk/latest/cloud-sdk/index.html",
     "exports": {
         "./server": {
             "import": "./server.js",
@@ -16,8 +16,8 @@
         }
     },
     "dependencies": {
-        "@sitecore-cloudsdk/core": "^0.2.4",
-        "@sitecore-cloudsdk/utils": "^0.2.4"
+        "@sitecore-cloudsdk/core": "^0.3.0",
+        "@sitecore-cloudsdk/utils": "^0.3.0"
     },
     "scripts": {
         "build": "npm run build:cjs && npm run build:es",
@@ -35,7 +35,6 @@
         "server.d.ts"
     ],
     "engines": {
-        "node": ">=18",
-        "npm": ">=9"
+        "node": ">=18"
     }
 }

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

@@ -1,6 +1,6 @@
 export { getBrowserId } from '@sitecore-cloudsdk/core';
 export { init } from './lib/initializer/browser/initializer';
-export type { PageViewEventInput, CustomEventInput, IdentityEventAttributesInput } from './lib/events';
+export type { PageViewData, EventData, IdentityData } from './lib/events';
 export { addToEventQueue } from './lib/eventStorage/addToEventQueue';
 export { processEventQueue } from './lib/eventStorage/processEventQueue';
 export { clearEventQueue } from './lib/eventStorage/clearEventQueue';

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

@@ -2,6 +2,10 @@
  * Returns the version of the library.
  */
 export declare const LIBRARY_VERSION: string;
+/**
+ * Returns the name & version of the library in a String.
+ */
+export declare const X_CLIENT_SOFTWARE_ID: string;
 export declare enum ErrorMessages {
     IE_0001 = "[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.",
     IE_0004 = "[IE-0004] You must first initialize the \"events/browser\" module. Run the \"init\" function.",
@@ -9,7 +13,7 @@ export declare enum ErrorMessages {
     IV_0002 = "[IV-0002] Incorrect value for \"dob\". Format the value according to ISO 8601.",
     IV_0003 = "[IV-0003] Incorrect value for \"email\". Set the value to a valid email address.",
     IV_0004 = "[IV-0004] Incorrect value for \"expiryDate\". Format the value according to ISO 8601.",
-    IV_0005 = "[IV-0005] This event supports maximum 50 attributes. Reduce the number of attributes.",
+    IV_0005 = "[IV-0005] \"extensionData\" supports maximum 50 attributes. Reduce the number of attributes.",
     MV_0003 = "[MV-0003] \"identifiers\" is required."
 }
 export declare const EVENTS_NAMESPACE = "sitecore-cloudsdk:events";

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

@@ -3,15 +3,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EVENTS_NAMESPACE = exports.ErrorMessages = exports.LIBRARY_VERSION = void 0;
+exports.EVENTS_NAMESPACE = exports.ErrorMessages = exports.X_CLIENT_SOFTWARE_ID = 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"));
 const consts_1 = require("./events/consts");
+const package_json_1 = __importDefault(require("../../package.json"));
 /**
  * Returns the version of the library.
  */
 exports.LIBRARY_VERSION = package_json_1.default.version;
+/**
+ * Returns the name & version of the library in a String.
+ */
+exports.X_CLIENT_SOFTWARE_ID = `${package_json_1.default.name} ${exports.LIBRARY_VERSION}`;
+/* eslint-disable max-len */
 var ErrorMessages;
 (function (ErrorMessages) {
     ErrorMessages["IE_0001"] = "[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.";
@@ -20,7 +25,8 @@ var ErrorMessages;
     ErrorMessages["IV_0002"] = "[IV-0002] Incorrect value for \"dob\". Format the value according to ISO 8601.";
     ErrorMessages["IV_0003"] = "[IV-0003] Incorrect value for \"email\". Set the value to a valid email address.";
     ErrorMessages["IV_0004"] = "[IV-0004] Incorrect value for \"expiryDate\". Format the value according to ISO 8601.";
-    ErrorMessages["IV_0005"] = "[IV-0005] This event supports maximum 50 attributes. Reduce the number of attributes.";
+    ErrorMessages["IV_0005"] = "[IV-0005] \"extensionData\" supports maximum 50 attributes. Reduce the number of attributes.";
     ErrorMessages["MV_0003"] = "[MV-0003] \"identifiers\" is required.";
 })(ErrorMessages || (exports.ErrorMessages = ErrorMessages = {}));
+/* eslint-enable max-len */
 exports.EVENTS_NAMESPACE = 'sitecore-cloudsdk:events';

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

@@ -1,9 +1,7 @@
-import { CustomEventInput, ExtensionData } from '../events';
+import type { EventData } 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: CustomEventInput, extensionData?: ExtensionData): Promise<void>;
+export declare function addToEventQueue(eventData: EventData): Promise<void>;

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

@@ -2,27 +2,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addToEventQueue = 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");
-const eventStorage_1 = require("./eventStorage");
 const core_1 = require("@sitecore-cloudsdk/core");
 const consts_1 = require("../consts");
+const initializer_1 = require("../initializer/browser/initializer");
+const eventStorage_1 = require("./eventStorage");
 /**
  * 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
  */
-async function addToEventQueue(type, eventData, extensionData) {
+async function addToEventQueue(eventData) {
     await (0, initializer_1.awaitInit)();
     const settings = (0, core_1.handleGetSettingsError)(core_1.getSettings, consts_1.ErrorMessages.IE_0004);
     const id = (0, core_1.getBrowserId)();
     const queueEventPayload = {
         eventData,
-        extensionData,
         id,
-        settings,
-        type,
+        settings
     };
     eventStorage_1.eventQueue.enqueueEvent(queueEventPayload);
 }

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

@@ -1,4 +1,4 @@
-import { CustomEventArguments } from '../events';
+import type { CustomEventArguments } from '../events';
 declare class EventQueue {
     /**
      * Initialize the Event Storage
@@ -30,6 +30,6 @@ export interface Storage {
     setItem(key: string, value: string): void;
     removeItem(key: string): void;
 }
-export type QueueEventPayload = Pick<CustomEventArguments, 'eventData' | 'extensionData' | 'type' | 'settings' | 'id'>;
+export type QueueEventPayload = Pick<CustomEventArguments, 'eventData' | 'settings' | 'id'>;
 export declare const eventQueue: EventQueue;
 export {};

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

@@ -35,7 +35,7 @@ class EventQueue {
         queueEventPayload.eventData.language = queueEventPayload.eventData.language ?? (0, core_1.language)();
         new events_1.CustomEvent({
             sendEvent: sendEvent_1.sendEvent,
-            ...queueEventPayload,
+            ...queueEventPayload
         });
         const eventQueue = this.getEventQueue();
         eventQueue.push(queueEventPayload);
@@ -46,16 +46,13 @@ class EventQueue {
      */
     async sendAllEvents() {
         const eventQueue = this.getEventQueue();
-        for (const queueEventPayload of eventQueue) {
+        for (const queueEventPayload of eventQueue)
             await new events_1.CustomEvent({
                 eventData: queueEventPayload.eventData,
-                extensionData: queueEventPayload.extensionData,
                 id: queueEventPayload.id,
                 sendEvent: sendEvent_1.sendEvent,
-                settings: queueEventPayload.settings,
-                type: queueEventPayload.type,
+                settings: queueEventPayload.settings
             }).send();
-        }
         this.clearQueue();
     }
     /**

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

@@ -1,4 +1,4 @@
-import { EventAttributesInput } from './common-interfaces';
+import type { EventAttributesInput } from './common-interfaces';
 export declare class BaseEvent {
     private baseEventData;
     private readonly browserId;
@@ -29,6 +29,7 @@ export interface BasePayload {
     language?: string;
     page?: string;
     pos: string;
+    requested_at: string;
 }
-type BaseEventData = Partial<EventAttributesInput>;
+type BaseEventData = EventAttributesInput;
 export {};

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

@@ -23,15 +23,16 @@ class BaseEvent {
      */
     mapBaseEventPayload() {
         return {
-            // eslint-disable-next-line @typescript-eslint/naming-convention
+            /* eslint-disable @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: '',
+            requested_at: new Date().toISOString()
+            /* eslint-enable @typescript-eslint/naming-convention */
         };
     }
 }

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

@@ -1,31 +1,14 @@
-import { NestedObject } from '@sitecore-cloudsdk/utils';
-/**
- * Event data received as input to be sent to Sitecore EP
- */
-interface MandatoryInput {
-    channel: string;
-    currency: string;
-}
-type MandatoryEventInput = MandatoryInput;
+import type { NestedObject } from '@sitecore-cloudsdk/utils';
 /**
  * Event data that is sent to Sitecore EP
  */
-interface InferrableInput {
-    /**
-     * To be restored back to MandatoryEventInput Interface
-     * as mandatory input parameter in version 1.0.0
-     */
+export interface EventAttributesInput {
     language?: string;
     page?: string;
-}
-type InferrableEventInput = InferrableInput;
-/**
- * Interface to hold the base event attributes
- */
-export interface EventAttributesInput extends MandatoryEventInput, InferrableEventInput {
+    channel?: string;
+    currency?: string;
 }
 /**
  * Type of the extension data that the developer can pass to events
  */
 export type ExtensionData = NestedObject;
-export {};

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

@@ -1,8 +1,8 @@
+import type { BasicTypes, NestedObject } from '@sitecore-cloudsdk/utils';
+import type { EPResponse, Settings } from '@sitecore-cloudsdk/core';
+import type { EventAttributesInput, ExtensionData } from '../common-interfaces';
 import { BaseEvent } from '../base-event';
-import { EventAttributesInput } from '../common-interfaces';
-import { SendEvent } from '../send-event/sendEvent';
-import { EPResponse, Settings } from '@sitecore-cloudsdk/core';
-import { BasicTypes, NestedObject } from '@sitecore-cloudsdk/utils';
+import type { SendEvent } from '../send-event/sendEvent';
 export declare class CustomEvent extends BaseEvent {
     customEventPayload: CustomEventPayload;
     private sendEvent;
@@ -24,16 +24,20 @@ export declare class CustomEvent extends BaseEvent {
  */
 export interface CustomEventArguments {
     sendEvent: SendEvent;
-    eventData: CustomEventData;
+    eventData: EventData;
     id: string;
-    extensionData?: NestedObject;
     settings: Settings;
-    type: string;
 }
 /**
  * Interface with the required/optional attributes in order to send a custom event to SitecoreCloud API
  */
 export interface CustomEventPayload extends NestedObject {
+    sc_search?: {
+        data: NestedObject;
+        metadata: {
+            ut_api_version: string;
+        };
+    };
     ext?: {
         [key: string]: BasicTypes;
     };
@@ -41,11 +45,8 @@ export interface CustomEventPayload extends NestedObject {
 /**
  * Interface with the required/optional attributes in order to send a custom event to SitecoreCloud API
  */
-export interface CustomEventInput extends EventAttributesInput, NestedObject {
-}
-/**
- * Internal interface with the required/optional attributes in order to send a custom event to SitecoreCloud API
- */
-interface CustomEventData extends Partial<EventAttributesInput>, NestedObject {
+export interface EventData extends EventAttributesInput, NestedObject {
+    type: string;
+    searchData?: NestedObject;
+    extensionData?: ExtensionData;
 }
-export {};

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

@@ -1,33 +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 consts_1 = require("../../consts");
+const consts_2 = require("../consts");
 const utils_1 = require("@sitecore-cloudsdk/utils");
-const consts_1 = require("../consts");
-const consts_2 = 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;
+        const { channel, currency, language, page, type, extensionData, searchData, ...rest } = args.eventData;
         super({ channel, currency, language, page }, args.id);
         this.extensionData = {};
         this.sendEvent = args.sendEvent;
         this.settings = args.settings;
         this.customEventPayload = {
-            type: args.type,
-            ...rest,
+            type,
+            ...rest
         };
-        if (args.extensionData)
-            this.extensionData = (0, utils_1.flattenObject)({ object: args.extensionData });
+        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(consts_2.ErrorMessages.IV_0005);
+        if (numberOfExtensionDataProperties > consts_2.MAX_EXT_ATTRIBUTES)
+            throw new Error(consts_1.ErrorMessages.IV_0005);
         if (numberOfExtensionDataProperties > 0)
             this.customEventPayload.ext = this.extensionData;
+        if (searchData)
+            this.customEventPayload.sc_search = {
+                data: searchData,
+                metadata: {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    ut_api_version: '1.0'
+                }
+            };
     }
     /**
      * Sends the event to Sitecore EP

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

@@ -1,12 +1,9 @@
-import { EPResponse } from '@sitecore-cloudsdk/core';
-import { ExtensionData } from '../common-interfaces';
-import { CustomEventInput } from './custom-event';
+import type { EPResponse } from '@sitecore-cloudsdk/core';
+import type { EventData } 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 EP returns
  */
-export declare function event(type: string, eventData: CustomEventInput, extensionData?: ExtensionData): Promise<EPResponse | null>;
+export declare function event(eventData: EventData): Promise<EPResponse | null>;

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

@@ -4,28 +4,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.event = void 0;
 const core_1 = require("@sitecore-cloudsdk/core");
 const custom_event_1 = require("./custom-event");
+const consts_1 = require("../../consts");
 const initializer_1 = require("../../initializer/browser/initializer");
 const sendEvent_1 = require("../send-event/sendEvent");
-const consts_1 = require("../../consts");
 /**
  * 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 EP returns
  */
-async function event(type, eventData, extensionData) {
+async function event(eventData) {
     await (0, initializer_1.awaitInit)();
     const settings = (0, core_1.handleGetSettingsError)(core_1.getSettings, consts_1.ErrorMessages.IE_0004);
     const id = (0, core_1.getBrowserId)();
     return new custom_event_1.CustomEvent({
         eventData,
-        extensionData,
         id,
         sendEvent: sendEvent_1.sendEvent,
-        settings,
-        type,
+        settings
     }).send();
 }
 exports.event = event;

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

@@ -1,13 +1,11 @@
-import { EPResponse } from '@sitecore-cloudsdk/core';
-import { ExtensionData } from '../common-interfaces';
-import { CustomEventInput } from './custom-event';
-import { Request } from '@sitecore-cloudsdk/utils';
+import type { EPResponse } from '@sitecore-cloudsdk/core';
+import type { EventData } from './custom-event';
+import type { Request } from '@sitecore-cloudsdk/utils';
 /**
  * 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 request - Interface with constraint for extending request
- * @param extensionData - The optional extensionData attributes that will be sent to SitecoreCloud API.
+ * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
  * @returns The response object that Sitecore EP returns
  */
-export declare function eventServer<T extends Request>(type: string, eventData: CustomEventInput, request: T, extensionData?: ExtensionData): Promise<EPResponse | null>;
+export declare function eventServer<T extends Request>(request: T, eventData: EventData): Promise<EPResponse | null>;

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

@@ -4,26 +4,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.eventServer = void 0;
 const core_1 = require("@sitecore-cloudsdk/core");
 const custom_event_1 = require("./custom-event");
-const sendEvent_1 = require("../send-event/sendEvent");
 const consts_1 = require("../../consts");
+const sendEvent_1 = require("../send-event/sendEvent");
 /**
  * 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 request - Interface with constraint for extending request
- * @param extensionData - The optional extensionData attributes that will be sent to SitecoreCloud API.
+ * @param eventData - The required/optional attributes in order to be send to SitecoreCloud API
  * @returns The response object that Sitecore EP returns
  */
-function eventServer(type, eventData, request, extensionData) {
+function eventServer(request, eventData) {
     const settings = (0, core_1.handleGetSettingsError)(core_1.getSettingsServer, consts_1.ErrorMessages.IE_0005);
-    const id = (0, core_1.getBrowserIdFromRequest)(request, settings.cookieSettings.cookieName);
+    const id = (0, core_1.getCookieValueFromRequest)(request, settings.cookieSettings.cookieNames.browserId);
     return new custom_event_1.CustomEvent({
         eventData,
-        extensionData,
         id,
         sendEvent: sendEvent_1.sendEvent,
-        settings,
-        type,
+        settings
     }).send();
 }
 exports.eventServer = eventServer;

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

@@ -1,6 +1,7 @@
-import { EPResponse } from '@sitecore-cloudsdk/core';
+import type { EPResponse } from '@sitecore-cloudsdk/core';
 /**
  * A function that sends a form event to SitecoreCloud API
+ *
  * @param formId - The required form ID string
  * @param interactionType - The required interaction type string. Possible values: "VIEWED", "SUBMITTED"
  *  settings object, you must specify it here

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

@@ -4,11 +4,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.form = void 0;
 const core_1 = require("@sitecore-cloudsdk/core");
 const custom_event_1 = require("./custom-event");
-const sendEvent_1 = require("../send-event/sendEvent");
-const initializer_1 = require("../../initializer/browser/initializer");
 const consts_1 = require("../../consts");
+const initializer_1 = require("../../initializer/browser/initializer");
+const sendEvent_1 = require("../send-event/sendEvent");
 /**
  * A function that sends a form event to SitecoreCloud API
+ *
  * @param formId - The required form ID string
  * @param interactionType - The required interaction type string. Possible values: "VIEWED", "SUBMITTED"
  *  settings object, you must specify it here
@@ -19,15 +20,16 @@ async function form(formId, interactionType) {
     const settings = (0, core_1.handleGetSettingsError)(core_1.getSettings, consts_1.ErrorMessages.IE_0004);
     const id = (0, core_1.getBrowserId)();
     const formEvent = new custom_event_1.CustomEvent({
-        eventData: {},
-        extensionData: {
-            formId,
-            interactionType: interactionType.toUpperCase(),
+        eventData: {
+            extensionData: {
+                formId,
+                interactionType: interactionType.toUpperCase()
+            },
+            type: 'FORM'
         },
         id,
         sendEvent: sendEvent_1.sendEvent,
-        settings,
-        type: 'FORM',
+        settings
     });
     formEvent.page = undefined;
     return formEvent.send();

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

@@ -1,22 +1,23 @@
+import type { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core';
+import type { EventAttributesInput, ExtensionData } from '../common-interfaces';
 import { BaseEvent } from '../base-event';
-import { ExtensionData, EventAttributesInput } from '../common-interfaces';
-import { FlattenedObject } from '@sitecore-cloudsdk/utils';
-import { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core';
-import { SendEvent } from '../send-event/sendEvent';
+import type { FlattenedObject } from '@sitecore-cloudsdk/utils';
+import type { SendEvent } from '../send-event/sendEvent';
 export declare class IdentityEvent extends BaseEvent {
-    private eventData;
+    private identityData;
     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
      */
     constructor(args: IdentityEventArguments);
     /**
      * Function that validates the identifiers object, email and date attributes for CDN users
-     *  * @param eventData - The data to be validated
+     *  * @param identityData - The data to be validated
      */
     private validateAttributes;
     /**
@@ -41,7 +42,7 @@ interface EPIdentifier {
 /**
  * Interface with the necessary attributes for the input for sending Identity events
  */
-export interface IdentityEventAttributesInput extends EventAttributesInput {
+export interface IdentityData extends EventAttributesInput {
     city?: string;
     country?: string;
     dob?: string;
@@ -56,6 +57,7 @@ export interface IdentityEventAttributesInput extends EventAttributesInput {
     state?: string;
     street?: string[];
     title?: string;
+    extensionData?: ExtensionData;
 }
 /**
  * The JSON array of objects that contain the identity identifiers
@@ -91,8 +93,7 @@ export interface IdentityEventPayload {
  */
 export interface IdentityEventArguments {
     sendEvent: SendEvent;
-    eventData: IdentityEventAttributesInput;
-    extensionData?: ExtensionData;
+    identityData: IdentityData;
     id: string;
     settings: Settings;
     infer?: Infer;