@sitecore-cloudsdk/events 0.1.1 → 0.1.3

package/README.md

@@ -2,14 +2,13 @@
 
 © Sitecore Corporation A/S. All rights reserved. Sitecore© is a registered trademark of Sitecore Corporation A/S.
 
-This package provides browser- and server-side functions to ​capture events in your app and send them to Sitecore. Events are for collecting behavioral and transactional data about your users as they interact with your app.
+This package provides browser- and server-side functions to ​capture events in your app and send them to Sitecore. Events are for collecting behavioral data about your users as they interact with your app.
 
 ## Prerequisites
 
-To use the Sitecore Cloud SDK, you need:
+To use the Sitecore Cloud SDK, you need an XM Cloud project. This project has to be created from the [XM Cloud foundation template](https://github.com/sitecorelabs/xmcloud-foundation-head) and deployed on XM Cloud.
 
-- A Next.js 13 app deployed on Sitecore XM Cloud.
-- An XM Cloud Plus subscription.
+The foundation template contains an XM Cloud JSS Next.js app. You use the Sitecore Cloud SDK in this app. To be able to use the Sitecore Cloud SDK, you need JSS version 21.6.0 or newer.
 
 ## Installation
 
@@ -28,12 +27,20 @@ npm install @sitecore-cloudsdk/events
 
 ## Code examples
 
+---
+
+**NOTE**
+
+These code examples illustrate how the Sitecore Cloud SDK works in a standalone Next.js app. In production, you implement Sitecore Cloud SDK functionality differently, in a JSS Next.js app. See code examples for that environment in the official documentation.
+
+---
+
 Capture and send a VIEW event from the browser side:
 
 ```ts
-"use client";
-import { useEffect } from "react";
-import { init, pageView } from "@sitecore-cloudsdk/events/browser";
+'use client';
+import { useEffect } from 'react';
+import { init, pageView } from '@sitecore-cloudsdk/events/browser';
 
 export default function Home() {
   useEffect(() => {
@@ -42,8 +49,8 @@ export default function Home() {
 
   const initEvents = async () => {
     await init({
-      sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || "",
-      siteName: process.env.NEXT_PUBLIC_SITENAME || "",
+      sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || '',
+      siteName: process.env.NEXT_PUBLIC_SITENAME || '',
       enableBrowserCookie: true,
     });
 
@@ -52,17 +59,17 @@ export default function Home() {
 
   const sendPageViewEvent = async () => {
     let eventData: any = {
-      channel: "WEB",
-      currency: "EUR",
+      channel: 'WEB',
+      currency: 'EUR',
     };
 
     let extensionData: any = {
-      customKey: "customValue",
+      customKey: 'customValue',
     };
 
     await pageView(eventData, extensionData);
 
-    console.log("Sent VIEW event.");
+    console.log('Sent VIEW event.');
   };
 
   return (
@@ -76,17 +83,17 @@ export default function Home() {
 Capture and send a VIEW event from the server side:
 
 ```ts
-import { NextResponse } from "next/server";
-import type { NextRequest } from "next/server";
-import { init, pageView } from "@sitecore-cloudsdk/events/server";
+import { NextResponse } from 'next/server';
+import type { NextRequest } from 'next/server';
+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 || "",
+      sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || '',
+      siteName: process.env.NEXT_PUBLIC_SITENAME || '',
       enableServerCookie: true,
     },
     req,
@@ -96,17 +103,17 @@ export async function middleware(req: NextRequest) {
   console.log(`Initialized "@sitecore-cloudsdk/events/server".`);
 
   let eventData: any = {
-    channel: "WEB",
-    currency: "EUR",
+    channel: 'WEB',
+    currency: 'EUR',
   };
 
   let extensionData: any = {
-    customKey: "customValue",
+    customKey: 'customValue',
   };
 
   const pageViewRes = await pageView(eventData, req, extensionData);
 
-  console.log("Sent VIEW event.");
+  console.log('Sent VIEW event.');
 
   return res;
 }
@@ -114,8 +121,8 @@ export async function middleware(req: NextRequest) {
 
 ## Documentation
 
-Coming soon.
+[Official Sitecore Cloud SDK documentation](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-cloud-sdk.html)
 
 ### License
 
-The Sitecore Cloud SDK uses the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
+The Sitecore Cloud SDK uses the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sitecore-cloudsdk/events",
-    "version": "0.1.1",
+    "version": "0.1.3",
     "license": "Apache-2.0",
     "exports": {
         "./server": {

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 { IPageViewEventInput, ICustomEventInput, IIdentityEventAttributesInput } from './lib/events';
+export type { PageViewEventInput, CustomEventInput, IdentityEventAttributesInput } 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/ep/EventApiClient.d.ts

@@ -0,0 +1,18 @@
+import { EPResponse } from '@sitecore-cloudsdk/core';
+import type { BasePayload, PageViewEventPayload, IdentityEventPayload, CustomEventPayload } from '../events';
+export declare class EventApiClient implements EventApiClient {
+    private targetURL;
+    private readonly eventUrl;
+    constructor(targetURL: string, sitecoreEdgeContextId: string, siteName: string);
+}
+/**
+ * The interface of EventApiClient class
+ */
+export interface EventApiClient {
+    send(body: EPFetchBody & BasePayload): Promise<EPResponse | null>;
+}
+/**
+ * The type describing all possible event payloads
+ */
+type EPFetchBody = PageViewEventPayload | IdentityEventPayload | CustomEventPayload;
+export {};

package/dist/cjs/src/lib/{cdp → ep}/EventApiClient.js

@@ -10,9 +10,9 @@ class EventApiClient {
         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
+     * A function that sends the payload to Sitecore EP
+     * @param body - The Request body for the Sitecore EP
+     * @returns - A promise that resolves with either the Sitecore EP response object or null
      */
     async send(body) {
         const fetchOptions = {

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

@@ -1,4 +1,4 @@
-import { ICustomEventInput, ExtensionData } from '../events';
+import { CustomEventInput, ExtensionData } from '../events';
 /**
  * A function that adds event to the queue
  * @param type - The required type of the event
@@ -6,4 +6,4 @@ import { ICustomEventInput, ExtensionData } from '../events';
  * @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;
+export declare function addToEventQueue(type: string, eventData: CustomEventInput, extensionData?: ExtensionData): void;

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

@@ -1,16 +1,16 @@
-import { EventApiClient } from '../cdp/EventApiClient';
-import { ICustomEventArguments } from '../events';
+import { EventApiClient } from '../ep/EventApiClient';
+import { CustomEventArguments } 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 eventApiClient - The API client which sends events to EP
      * @param infer - The instance of the infer class
      */
     private key;
-    constructor(storage: IStorage, eventApiClient: EventApiClient);
+    constructor(storage: Storage, eventApiClient: EventApiClient);
     /** Returns the stored array of data with type QueueEventPayload, or empty array if the given key does not exist. */
     private getEventQueue;
     /**
@@ -20,7 +20,7 @@ export declare class EventQueue {
      */
     enqueueEvent(queueEventPayload: QueueEventPayload): void;
     /**
-     * Iterates the queue, and sends sequently the custom events to Sitecore CDP.
+     * Iterates the queue, and sends sequently the custom events to Sitecore EP.
      */
     sendAllEvents(): Promise<void>;
     /**
@@ -31,9 +31,9 @@ export declare class EventQueue {
 /**
  * This Storage interface represents the required storage functionality.
  */
-export interface IStorage {
+export interface Storage {
     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'>;
+export type QueueEventPayload = Pick<CustomEventArguments, 'eventData' | 'extensionData' | 'type' | 'settings' | 'id'>;

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

@@ -11,7 +11,7 @@ class EventQueue {
         /**
          * Initialize the Event Storage
          * @param storage - Interface that describes the storage functionality
-         * @param eventApiClient - The API client which sends events to CDP
+         * @param eventApiClient - The API client which sends events to EP
          * @param infer - The instance of the infer class
          */
         this.key = 'EventQueue';
@@ -46,7 +46,7 @@ class EventQueue {
         this.storage.setItem(this.key, JSON.stringify(eventQueue));
     }
     /**
-     * Iterates the queue, and sends sequently the custom events to Sitecore CDP.
+     * Iterates the queue, and sends sequently the custom events to Sitecore EP.
      */
     async sendAllEvents() {
         const eventQueue = this.getEventQueue();

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

@@ -1,8 +1,8 @@
-import type { ISettings } from '@sitecore-cloudsdk/core';
-import { IEventAttributesInput } from './common-interfaces';
+import type { Settings } from '@sitecore-cloudsdk/core';
+import { EventAttributesInput } from './common-interfaces';
 export declare class BaseEvent {
     private baseEventData;
-    protected settings: ISettings;
+    protected settings: Settings;
     private readonly browserId;
     private readonly language;
     page: string;
@@ -13,17 +13,17 @@ export declare class BaseEvent {
      * @param id - The browser id
      * @param infer - The source of methods to estimate language and page parameters
      */
-    constructor(baseEventData: IBaseEventData, settings: ISettings, id: string);
+    constructor(baseEventData: BaseEventData, settings: Settings, id: string);
     /**
-     *  A function that returns the properties for sending events to Sitecore CDP
+     *  A function that returns the properties for sending events to Sitecore EP
      * @returns an object that is required
      */
-    protected mapBaseEventPayload(): IBasePayload;
+    protected mapBaseEventPayload(): BasePayload;
 }
 /**
  *  An interface describing the basic payload to be sent to the API
  */
-export interface IBasePayload {
+export interface BasePayload {
     browser_id: string;
     channel?: string;
     client_key: string;
@@ -32,5 +32,5 @@ export interface IBasePayload {
     page?: string;
     pos: string;
 }
-type IBaseEventData = Partial<IEventAttributesInput>;
+type BaseEventData = Partial<EventAttributesInput>;
 export {};

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

@@ -19,7 +19,7 @@ class BaseEvent {
         this.page = this.baseEventData.page ?? (0, core_1.pageName)();
     }
     /**
-     *  A function that returns the properties for sending events to Sitecore CDP
+     *  A function that returns the properties for sending events to Sitecore EP
      * @returns an object that is required
      */
     mapBaseEventPayload() {

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

@@ -1,39 +1,31 @@
-import { BasicTypes, INestedObject } from '@sitecore-cloudsdk/utils';
+import { NestedObject } from '@sitecore-cloudsdk/utils';
 /**
- * Event data received as input to be sent to Sitecore CDP
+ * Event data received as input to be sent to Sitecore EP
  */
-interface IMandatoryInput {
+interface MandatoryInput {
     channel: string;
     currency: string;
 }
-type IMandatoryEventInput = IMandatoryInput;
+type MandatoryEventInput = MandatoryInput;
 /**
- * Event data that is sent to Sitecore CDP
+ * Event data that is sent to Sitecore EP
  */
-interface IInferrableInput {
+interface InferrableInput {
     /**
-     * To be restored back to IMandatoryEventInput Interface
+     * To be restored back to MandatoryEventInput Interface
      * as mandatory input parameter in version 1.0.0
      */
-    pointOfSale?: string;
     language?: string;
     page?: string;
 }
-type IInferrableEventInput = IInferrableInput;
+type InferrableEventInput = InferrableInput;
 /**
  * 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;
+export interface EventAttributesInput extends MandatoryEventInput, InferrableEventInput {
 }
 /**
  * Type of the extension data that the developer can pass to events
  */
-export type ExtensionData = INestedObject;
+export type ExtensionData = NestedObject;
 export {};

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

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

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

@@ -28,8 +28,8 @@ class CustomEvent extends base_event_1.BaseEvent {
             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
+     * Sends the event to Sitecore EP
+     * @returns - A promise that resolves with either the Sitecore EP response object or null
      */
     async send() {
         const baseAttr = this.mapBaseEventPayload();

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

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

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

@@ -10,7 +10,7 @@ const initializer_1 = require("../../initializer/browser/initializer");
  * @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
+ * @returns The response object that Sitecore EP returns
  */
 function event(type, eventData, extensionData) {
     const { eventApiClient, id, settings } = (0, initializer_1.getDependencies)();

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

@@ -1,13 +1,13 @@
-import { ICdpResponse } from '@sitecore-cloudsdk/core';
+import { EPResponse } from '@sitecore-cloudsdk/core';
 import { ExtensionData } from '../common-interfaces';
-import { ICustomEventInput } from './custom-event';
-import { TRequest } from '@sitecore-cloudsdk/utils';
+import { CustomEventInput } from './custom-event';
+import { 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.
- * @returns The response object that Sitecore CDP returns
+ * @returns The response object that Sitecore EP returns
  */
-export declare function eventServer<T extends TRequest>(type: string, eventData: ICustomEventInput, request: T, extensionData?: ExtensionData): Promise<ICdpResponse | null>;
+export declare function eventServer<T extends Request>(type: string, eventData: CustomEventInput, request: T, extensionData?: ExtensionData): Promise<EPResponse | null>;

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

@@ -11,7 +11,7 @@ const initializer_1 = require("../../initializer/server/initializer");
  * @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.
- * @returns The response object that Sitecore CDP returns
+ * @returns The response object that Sitecore EP returns
  */
 function eventServer(type, eventData, request, extensionData) {
     const { eventApiClient, settings } = (0, initializer_1.getServerDependencies)();

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

@@ -1,9 +1,9 @@
-import { ICdpResponse } from '@sitecore-cloudsdk/core';
+import { 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
- * @returns The response object that Sitecore CDP returns or null
+ * @returns The response object that Sitecore EP returns or null
  */
-export declare function form(formId: string, interactionType: 'VIEWED' | 'SUBMITTED'): Promise<ICdpResponse | null>;
+export declare function form(formId: string, interactionType: 'VIEWED' | 'SUBMITTED'): Promise<EPResponse | null>;

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

@@ -9,7 +9,7 @@ const custom_event_1 = require("./custom-event");
  * @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
- * @returns The response object that Sitecore CDP returns or null
+ * @returns The response object that Sitecore EP returns or null
  */
 function form(formId, interactionType) {
     const { eventApiClient, id, settings } = (0, initializer_1.getDependencies)();

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

@@ -1,8 +1,8 @@
 import { BaseEvent } from '../base-event';
-import { ExtensionData, IEventAttributesInput } from '../common-interfaces';
-import { IEventApiClient } from '../../cdp/EventApiClient';
-import { IFlattenedObject } from '@sitecore-cloudsdk/utils';
-import { ICdpResponse, IInfer, ISettings } from '@sitecore-cloudsdk/core';
+import { ExtensionData, EventAttributesInput } from '../common-interfaces';
+import { EventApiClient } from '../../ep/EventApiClient';
+import { FlattenedObject } from '@sitecore-cloudsdk/utils';
+import { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core';
 export declare class IdentityEvent extends BaseEvent {
     private eventData;
     private eventApiClient;
@@ -12,7 +12,7 @@ export declare class IdentityEvent extends 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: IIdentityEventArguments);
+    constructor(args: IdentityEventArguments);
     /**
      * Function that validates the identifiers object, email and date attributes for CDN users
      *  * @param eventData - The data to be validated
@@ -24,15 +24,15 @@ export declare class IdentityEvent extends BaseEvent {
      */
     private mapAttributes;
     /**
-     * Sends the event to Sitecore CDP
-     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     * Sends the event to Sitecore EP
+     * @returns - A promise that resolves with either the Sitecore EP response object or null
      */
-    send(): Promise<ICdpResponse | null>;
+    send(): Promise<EPResponse | null>;
 }
 /**
  * The JSON array of objects that contain the identity identifiers
  */
-interface ICDPIdentifier {
+interface EPIdentifier {
     expiry_date?: string;
     id: string;
     provider: string;
@@ -40,14 +40,14 @@ interface ICDPIdentifier {
 /**
  * Interface with the necessary attributes for the input for sending Identity events
  */
-export interface IIdentityEventAttributesInput extends IEventAttributesInput {
+export interface IdentityEventAttributesInput extends EventAttributesInput {
     city?: string;
     country?: string;
     dob?: string;
     email?: string;
     firstName?: string;
     gender?: string;
-    identifiers: IIdentifier[];
+    identifiers: Identifier[];
     lastName?: string;
     mobile?: string;
     phone?: string;
@@ -59,7 +59,7 @@ export interface IIdentityEventAttributesInput extends IEventAttributesInput {
 /**
  * The JSON array of objects that contain the identity identifiers
  */
-export interface IIdentifier {
+export interface Identifier {
     expiryDate?: string;
     id: string;
     provider: string;
@@ -67,14 +67,14 @@ export interface IIdentifier {
 /**
  *  An interface describing the identity event specific payload to be sent to the API
  */
-export interface IIdentityEventPayload {
+export interface IdentityEventPayload {
     city?: string;
     country?: string;
     dob?: string;
     email?: string;
     firstname?: string;
     gender?: string;
-    identifiers: ICDPIdentifier[];
+    identifiers: EPIdentifier[];
     lastname?: string;
     mobile?: string;
     phone?: string;
@@ -83,17 +83,17 @@ export interface IIdentityEventPayload {
     street?: string[];
     title?: string;
     type: 'IDENTITY';
-    ext?: IFlattenedObject;
+    ext?: FlattenedObject;
 }
 /**
  * Interface of the unified arguments object for identity event
  */
-export interface IIdentityEventArguments {
-    eventApiClient: IEventApiClient;
-    eventData: IIdentityEventAttributesInput;
+export interface IdentityEventArguments {
+    eventApiClient: EventApiClient;
+    eventData: IdentityEventAttributesInput;
     extensionData?: ExtensionData;
     id: string;
-    settings: ISettings;
-    infer?: IInfer;
+    settings: Settings;
+    infer?: Infer;
 }
 export {};

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

@@ -30,7 +30,7 @@ class IdentityEvent extends base_event_1.BaseEvent {
      */
     validateAttributes(eventData) {
         if (eventData.identifiers.length === 0)
-            throw new Error(`[MV-0004] "identifiers" is required.`);
+            throw new Error(`[MV-0003] "identifiers" is required.`);
         if (eventData.dob !== undefined && !(0, utils_1.isShortISODateString)(eventData.dob))
             throw new Error(`[IV-0002] Incorrect value for "dob". Format the value according to ISO 8601.`);
         eventData.identifiers.forEach((identifier) => {
@@ -75,8 +75,8 @@ class IdentityEvent extends base_event_1.BaseEvent {
         return identityPayload;
     }
     /**
-     * Sends the event to Sitecore CDP
-     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     * Sends the event to Sitecore EP
+     * @returns - A promise that resolves with either the Sitecore EP response object or null
      */
     async send() {
         const baseAttr = this.mapBaseEventPayload();