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

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

@@ -1,30 +1,37 @@
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 import { BaseEvent } from '../base-event';
-import { flattenObject } from '@sitecore-cloudsdk/utils';
-import { MAX_EXT_ATTRIBUTES } from '../consts';
 import { ErrorMessages } from '../../consts';
+import { MAX_EXT_ATTRIBUTES } from '../consts';
+import { flattenObject } from '@sitecore-cloudsdk/utils';
 export class CustomEvent 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) {
-        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 = flattenObject({ object: args.extensionData });
+        if (extensionData)
+            this.extensionData = flattenObject({ object: extensionData });
         const numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
         if (numberOfExtensionDataProperties > MAX_EXT_ATTRIBUTES)
             throw new Error(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/esm/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/esm/src/lib/events/custom-event/event.js

@@ -1,27 +1,23 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 import { getBrowserId, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core';
 import { CustomEvent } from './custom-event';
+import { ErrorMessages } from '../../consts';
 import { awaitInit } from '../../initializer/browser/initializer';
 import { sendEvent } from '../send-event/sendEvent';
-import { ErrorMessages } from '../../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
  */
-export async function event(type, eventData, extensionData) {
+export async function event(eventData) {
     await awaitInit();
     const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0004);
     const id = getBrowserId();
     return new CustomEvent({
         eventData,
-        extensionData,
         id,
         sendEvent,
-        settings,
-        type,
+        settings
     }).send();
 }

package/dist/esm/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/esm/src/lib/events/custom-event/eventServer.js

@@ -1,25 +1,22 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getBrowserIdFromRequest, getSettingsServer, handleGetSettingsError, } from '@sitecore-cloudsdk/core';
+import { getCookieValueFromRequest, getSettingsServer, handleGetSettingsError } from '@sitecore-cloudsdk/core';
 import { CustomEvent } from './custom-event';
-import { sendEvent } from '../send-event/sendEvent';
 import { ErrorMessages } from '../../consts';
+import { sendEvent } from '../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
  */
-export function eventServer(type, eventData, request, extensionData) {
+export function eventServer(request, eventData) {
     const settings = handleGetSettingsError(getSettingsServer, ErrorMessages.IE_0005);
-    const id = getBrowserIdFromRequest(request, settings.cookieSettings.cookieName);
+    const id = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.browserId);
     return new CustomEvent({
         eventData,
-        extensionData,
         id,
         sendEvent,
-        settings,
-        type,
+        settings
     }).send();
 }

package/dist/esm/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/esm/src/lib/events/custom-event/form.js

@@ -1,11 +1,12 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 import { getBrowserId, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core';
 import { CustomEvent } from './custom-event';
-import { sendEvent } from '../send-event/sendEvent';
-import { awaitInit } from '../../initializer/browser/initializer';
 import { ErrorMessages } from '../../consts';
+import { awaitInit } from '../../initializer/browser/initializer';
+import { sendEvent } from '../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
@@ -16,15 +17,16 @@ export async function form(formId, interactionType) {
     const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0004);
     const id = getBrowserId();
     const formEvent = new CustomEvent({
-        eventData: {},
-        extensionData: {
-            formId,
-            interactionType: interactionType.toUpperCase(),
+        eventData: {
+            extensionData: {
+                formId,
+                interactionType: interactionType.toUpperCase()
+            },
+            type: 'FORM'
         },
         id,
         sendEvent,
-        settings,
-        type: 'FORM',
+        settings
     });
     formEvent.page = undefined;
     return formEvent.send();

package/dist/esm/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;

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

@@ -1,42 +1,42 @@
-// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { flattenObject, isShortISODateString, isValidEmail } from '@sitecore-cloudsdk/utils';
 import { BaseEvent } from '../base-event';
-import { MAX_EXT_ATTRIBUTES } from '../consts';
-import { isShortISODateString, isValidEmail, flattenObject } from '@sitecore-cloudsdk/utils';
 import { ErrorMessages } from '../../consts';
+import { MAX_EXT_ATTRIBUTES } from '../consts';
 export 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) {
-        const { channel, currency, language, page } = args.eventData;
+        const { channel, currency, language, page, extensionData } = args.identityData;
         super({ channel, currency, language, page }, args.id);
         this.extensionData = {};
         this.numberOfExtensionDataProperties = 0;
-        this.validateAttributes(args.eventData);
-        this.eventData = args.eventData;
+        this.validateAttributes(args.identityData);
+        this.identityData = args.identityData;
         this.sendEvent = args.sendEvent;
         this.settings = args.settings;
-        if (args.extensionData)
-            this.extensionData = flattenObject({ object: args.extensionData });
+        if (extensionData)
+            this.extensionData = flattenObject({ object: extensionData });
         this.numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
         if (this.numberOfExtensionDataProperties > MAX_EXT_ATTRIBUTES)
             throw new Error(ErrorMessages.IV_0005);
     }
     /**
      * 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
      */
-    validateAttributes(eventData) {
-        if (eventData.identifiers.length === 0)
+    validateAttributes(identityData) {
+        if (identityData.identifiers.length === 0)
             throw new Error(ErrorMessages.MV_0003);
-        if (eventData.dob !== undefined && !isShortISODateString(eventData.dob))
+        if (identityData.dob !== undefined && !isShortISODateString(identityData.dob))
             throw new Error(ErrorMessages.IV_0002);
-        eventData.identifiers.forEach((identifier) => {
+        identityData.identifiers.forEach((identifier) => {
             if (identifier.expiryDate && !isShortISODateString(identifier.expiryDate))
                 throw new Error(ErrorMessages.IV_0004);
         });
-        if (eventData.email && !isValidEmail(eventData.email))
+        if (identityData.email && !isValidEmail(identityData.email))
             throw new Error(ErrorMessages.IV_0003);
     }
     /**
@@ -45,29 +45,29 @@ export class IdentityEvent extends BaseEvent {
      */
     mapAttributes() {
         const identityPayload = {
-            city: this.eventData.city,
-            country: this.eventData.country,
-            dob: this.eventData.dob,
-            email: this.eventData.email,
-            firstname: this.eventData.firstName,
-            gender: this.eventData.gender,
-            identifiers: this.eventData.identifiers.map((value) => {
+            city: this.identityData.city,
+            country: this.identityData.country,
+            dob: this.identityData.dob,
+            email: this.identityData.email,
+            firstname: this.identityData.firstName,
+            gender: this.identityData.gender,
+            identifiers: this.identityData.identifiers.map((value) => {
                 return {
                     // eslint-disable-next-line @typescript-eslint/naming-convention
                     expiry_date: value.expiryDate,
                     id: value.id,
-                    provider: value.provider,
+                    provider: value.provider
                 };
             }),
-            lastname: this.eventData.lastName,
-            mobile: this.eventData.mobile,
-            phone: this.eventData.phone,
+            lastname: this.identityData.lastName,
+            mobile: this.identityData.mobile,
+            phone: this.identityData.phone,
             // eslint-disable-next-line @typescript-eslint/naming-convention
-            postal_code: this.eventData.postalCode,
-            state: this.eventData.state,
-            street: this.eventData.street,
-            title: this.eventData.title,
-            type: 'IDENTITY',
+            postal_code: this.identityData.postalCode,
+            state: this.identityData.state,
+            street: this.identityData.street,
+            title: this.identityData.title,
+            type: 'IDENTITY'
         };
         if (this.numberOfExtensionDataProperties > 0)
             identityPayload.ext = this.extensionData;

package/dist/esm/src/lib/events/identity/identity.d.ts

@@ -1,11 +1,9 @@
-import { ExtensionData } from '../common-interfaces';
-import { EPResponse } from '@sitecore-cloudsdk/core';
-import { IdentityEventAttributesInput } from './identity-event';
+import type { EPResponse } from '@sitecore-cloudsdk/core';
+import type { IdentityData } from './identity-event';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
+ *
  * @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 identity(eventData: IdentityEventAttributesInput, extensionData?: ExtensionData): Promise<EPResponse | null>;
+export declare function identity(identityData: IdentityData): Promise<EPResponse | null>;

package/dist/esm/src/lib/events/identity/identity.js

@@ -1,24 +1,23 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 import { getBrowserId, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core';
+import { ErrorMessages } from '../../consts';
 import { IdentityEvent } from './identity-event';
 import { awaitInit } from '../../initializer/browser/initializer';
 import { sendEvent } from '../send-event/sendEvent';
-import { ErrorMessages } from '../../consts';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
+ *
  * @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 async function identity(eventData, extensionData) {
+export async function identity(identityData) {
     await awaitInit();
     const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0004);
     const id = getBrowserId();
     return new IdentityEvent({
-        eventData,
-        extensionData,
         id,
+        identityData,
         sendEvent,
-        settings,
+        settings
     }).send();
 }

package/dist/esm/src/lib/events/identity/identityServer.d.ts

@@ -1,13 +1,11 @@
-import { ExtensionData } from '../common-interfaces';
-import { Request } from '@sitecore-cloudsdk/utils';
-import { EPResponse } from '@sitecore-cloudsdk/core';
-import { IdentityEventAttributesInput } from './identity-event';
+import type { EPResponse } from '@sitecore-cloudsdk/core';
+import type { IdentityData } from './identity-event';
+import type { Request } from '@sitecore-cloudsdk/utils';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
- * @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.
- * This object will be flattened and sent in the ext object of the payload
+ * @param identityData - The required/optional attributes in order to be send to SitecoreCloud API
  * @returns The response object that Sitecore EP returns
  */
-export declare function identityServer(eventData: IdentityEventAttributesInput, request: Request, extensionData?: ExtensionData): Promise<EPResponse | null>;
+export declare function identityServer(request: Request, identityData: IdentityData): Promise<EPResponse | null>;

package/dist/esm/src/lib/events/identity/identityServer.js

@@ -1,24 +1,22 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
-import { getBrowserIdFromRequest, getSettingsServer, handleGetSettingsError, } from '@sitecore-cloudsdk/core';
+import { getCookieValueFromRequest, getSettingsServer, handleGetSettingsError } from '@sitecore-cloudsdk/core';
+import { ErrorMessages } from '../../consts';
 import { IdentityEvent } from './identity-event';
 import { sendEvent } from '../send-event/sendEvent';
-import { ErrorMessages } from '../../consts';
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
- * @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.
- * This object will be flattened and sent in the ext object of the payload
+ * @param identityData - The required/optional attributes in order to be send to SitecoreCloud API
  * @returns The response object that Sitecore EP returns
  */
-export function identityServer(eventData, request, extensionData) {
+export function identityServer(request, identityData) {
     const settings = handleGetSettingsError(getSettingsServer, ErrorMessages.IE_0005);
-    const id = getBrowserIdFromRequest(request, settings.cookieSettings.cookieName);
+    const id = getCookieValueFromRequest(request, settings.cookieSettings.cookieNames.browserId);
     return new IdentityEvent({
-        eventData,
-        extensionData,
         id,
+        identityData,
         sendEvent,
-        settings: settings,
+        settings: settings
     }).send();
 }

package/dist/esm/src/lib/events/index.d.ts

@@ -1,9 +1,9 @@
 export { BaseEvent } from './base-event';
 export type { BasePayload } from './base-event';
 export { PageViewEvent } from './page-view/page-view-event';
-export type { PageViewEventInput, PageViewEventPayload } 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 { CustomEventInput, CustomEventPayload, CustomEventArguments } from './custom-event/custom-event';
+export type { EventData, CustomEventPayload, CustomEventArguments } from './custom-event/custom-event';
 export { IdentityEvent } from './identity/identity-event';
-export type { IdentityEventAttributesInput, IdentityEventPayload } from './identity/identity-event';
+export type { IdentityData, IdentityEventPayload } from './identity/identity-event';
 export type { ExtensionData } from './common-interfaces';

package/dist/esm/src/lib/events/page-view/page-view-event.d.ts

@@ -1,12 +1,12 @@
-import { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core';
-import { FlattenedObject, NestedObject } from '@sitecore-cloudsdk/utils';
+import type { EPResponse, Infer, Settings } from '@sitecore-cloudsdk/core';
+import type { EventAttributesInput, ExtensionData } from '../common-interfaces';
+import type { FlattenedObject, NestedObject } from '@sitecore-cloudsdk/utils';
 import { BaseEvent } from '../base-event';
-import { EventAttributesInput } from '../common-interfaces';
-import { SendEvent } from '../send-event/sendEvent';
+import type { SendEvent } from '../send-event/sendEvent';
 export declare class PageViewEvent extends BaseEvent {
     static isFirstPageView: boolean;
     private sendEvent;
-    private eventData;
+    private pageViewData?;
     private extensionData;
     private urlSearchParams;
     private includeUTMParameters;
@@ -49,7 +49,7 @@ export declare class PageViewEvent extends BaseEvent {
  */
 export interface PageViewEventArguments {
     sendEvent: SendEvent;
-    eventData: PageViewEventInput;
+    pageViewData?: PageViewData;
     id: string;
     settings: Settings;
     infer?: Infer;
@@ -59,10 +59,12 @@ export interface PageViewEventArguments {
 /**
  * Type with the required/optional attributes in order to send a view event to SitecoreCloud API
  */
-export interface PageViewEventInput extends EventAttributesInput {
+export interface PageViewData extends EventAttributesInput {
     pageVariantId?: string;
     referrer?: string;
     includeUTMParameters?: boolean;
+    extensionData?: ExtensionData;
+    searchData?: NestedObject;
 }
 /**
  * Interface with the utm_ parameters
@@ -79,5 +81,11 @@ export interface PageViewEventPayload extends UtmParameters {
     ext?: {
         pageVariantId?: string;
     } & FlattenedObject;
+    sc_search?: {
+        data: NestedObject;
+        metadata: {
+            ut_api_version: string;
+        };
+    };
 }
 export {};