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

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sitecore-cloudsdk/events",
-    "version": "0.3.0",
+    "version": "0.3.1-rc.0",
     "license": "Apache-2.0",
     "homepage": "https://doc.sitecore.com/xmc/en/developers/sdk/latest/cloud-sdk/index.html",
     "exports": {

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.",

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.";
@@ -23,4 +28,5 @@ var ErrorMessages;
     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,4 +1,4 @@
-import { EventData } from '../events';
+import type { EventData } from '../events';
 /**
  * A function that adds event to the queue
  *

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

@@ -2,10 +2,10 @@
 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
  *
@@ -18,7 +18,7 @@ async function addToEventQueue(eventData) {
     const queueEventPayload = {
         eventData,
         id,
-        settings,
+        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

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,14 +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,
                 id: queueEventPayload.id,
                 sendEvent: sendEvent_1.sendEvent,
-                settings: queueEventPayload.settings,
+                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 = 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,4 +1,4 @@
-import { NestedObject } from '@sitecore-cloudsdk/utils';
+import type { NestedObject } from '@sitecore-cloudsdk/utils';
 /**
  * Event data that is sent to Sitecore EP
  */

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, ExtensionData } 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;
@@ -32,6 +32,12 @@ export interface CustomEventArguments {
  * 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,5 +47,6 @@ export interface CustomEventPayload extends NestedObject {
  */
 export interface EventData extends EventAttributesInput, NestedObject {
     type: string;
+    searchData?: NestedObject;
     extensionData?: ExtensionData;
 }

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, type, extensionData, ...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,
-            ...rest,
+            ...rest
         };
         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,5 +1,5 @@
-import { EPResponse } from '@sitecore-cloudsdk/core';
-import { EventData } 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
  *

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

@@ -4,9 +4,9 @@ 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
  *
@@ -21,7 +21,7 @@ async function event(eventData) {
         eventData,
         id,
         sendEvent: sendEvent_1.sendEvent,
-        settings,
+        settings
     }).send();
 }
 exports.event = event;

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

@@ -1,6 +1,6 @@
-import { EPResponse } from '@sitecore-cloudsdk/core';
-import { EventData } 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
  *

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

@@ -4,8 +4,8 @@ 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
  *
@@ -15,12 +15,12 @@ const consts_1 = require("../../consts");
  */
 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,
         id,
         sendEvent: sendEvent_1.sendEvent,
-        settings,
+        settings
     }).send();
 }
 exports.eventServer = eventServer;

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

@@ -1,4 +1,4 @@
-import { EPResponse } from '@sitecore-cloudsdk/core';
+import type { EPResponse } from '@sitecore-cloudsdk/core';
 /**
  * A function that sends a form event to SitecoreCloud API
  *

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

@@ -4,9 +4,9 @@ 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
  *
@@ -23,13 +23,13 @@ async function form(formId, interactionType) {
         eventData: {
             extensionData: {
                 formId,
-                interactionType: interactionType.toUpperCase(),
+                interactionType: interactionType.toUpperCase()
             },
-            type: 'FORM',
+            type: 'FORM'
         },
         id,
         sendEvent: sendEvent_1.sendEvent,
-        settings,
+        settings
     });
     formEvent.page = undefined;
     return formEvent.send();

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

@@ -1,8 +1,8 @@
+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 identityData;
     private sendEvent;

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

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IdentityEvent = 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 utils_1 = require("@sitecore-cloudsdk/utils");
-const consts_2 = require("../../consts");
+const base_event_1 = require("../base-event");
+const consts_1 = require("../../consts");
+const consts_2 = require("../consts");
 class IdentityEvent extends base_event_1.BaseEvent {
     /**
      * A class that extends from {@link BaseEvent} and has all the required functionality to send a VIEW event
@@ -24,8 +23,8 @@ class IdentityEvent extends base_event_1.BaseEvent {
         if (extensionData)
             this.extensionData = (0, utils_1.flattenObject)({ object: extensionData });
         this.numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
-        if (this.numberOfExtensionDataProperties > consts_1.MAX_EXT_ATTRIBUTES)
-            throw new Error(consts_2.ErrorMessages.IV_0005);
+        if (this.numberOfExtensionDataProperties > consts_2.MAX_EXT_ATTRIBUTES)
+            throw new Error(consts_1.ErrorMessages.IV_0005);
     }
     /**
      * Function that validates the identifiers object, email and date attributes for CDN users
@@ -33,15 +32,15 @@ class IdentityEvent extends base_event_1.BaseEvent {
      */
     validateAttributes(identityData) {
         if (identityData.identifiers.length === 0)
-            throw new Error(consts_2.ErrorMessages.MV_0003);
+            throw new Error(consts_1.ErrorMessages.MV_0003);
         if (identityData.dob !== undefined && !(0, utils_1.isShortISODateString)(identityData.dob))
-            throw new Error(consts_2.ErrorMessages.IV_0002);
+            throw new Error(consts_1.ErrorMessages.IV_0002);
         identityData.identifiers.forEach((identifier) => {
             if (identifier.expiryDate && !(0, utils_1.isShortISODateString)(identifier.expiryDate))
-                throw new Error(consts_2.ErrorMessages.IV_0004);
+                throw new Error(consts_1.ErrorMessages.IV_0004);
         });
         if (identityData.email && !(0, utils_1.isValidEmail)(identityData.email))
-            throw new Error(consts_2.ErrorMessages.IV_0003);
+            throw new Error(consts_1.ErrorMessages.IV_0003);
     }
     /**
      * A function that maps the identity event input data with the payload sent to the API
@@ -60,7 +59,7 @@ class IdentityEvent extends base_event_1.BaseEvent {
                     // eslint-disable-next-line @typescript-eslint/naming-convention
                     expiry_date: value.expiryDate,
                     id: value.id,
-                    provider: value.provider,
+                    provider: value.provider
                 };
             }),
             lastname: this.identityData.lastName,
@@ -71,7 +70,7 @@ class IdentityEvent extends base_event_1.BaseEvent {
             state: this.identityData.state,
             street: this.identityData.street,
             title: this.identityData.title,
-            type: 'IDENTITY',
+            type: 'IDENTITY'
         };
         if (this.numberOfExtensionDataProperties > 0)
             identityPayload.ext = this.extensionData;

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

@@ -1,5 +1,5 @@
-import { EPResponse } from '@sitecore-cloudsdk/core';
-import { IdentityData } 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
  *

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

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.identity = void 0;
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 const core_1 = require("@sitecore-cloudsdk/core");
+const consts_1 = require("../../consts");
 const identity_event_1 = require("./identity-event");
 const initializer_1 = require("../../initializer/browser/initializer");
 const sendEvent_1 = require("../send-event/sendEvent");
-const consts_1 = require("../../consts");
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
  *
@@ -21,7 +21,7 @@ async function identity(identityData) {
         id,
         identityData,
         sendEvent: sendEvent_1.sendEvent,
-        settings,
+        settings
     }).send();
 }
 exports.identity = identity;

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

@@ -1,6 +1,6 @@
-import { Request } from '@sitecore-cloudsdk/utils';
-import { EPResponse } from '@sitecore-cloudsdk/core';
-import { IdentityData } 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
  *

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

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.identityServer = void 0;
 const core_1 = require("@sitecore-cloudsdk/core");
+const consts_1 = require("../../consts");
 const identity_event_1 = require("./identity-event");
 const sendEvent_1 = require("../send-event/sendEvent");
-const consts_1 = require("../../consts");
 /**
  * A function that sends an IDENTITY event to SitecoreCloud API
  *
@@ -15,12 +15,12 @@ const consts_1 = require("../../consts");
  */
 function identityServer(request, identityData) {
     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 identity_event_1.IdentityEvent({
         id,
         identityData,
         sendEvent: sendEvent_1.sendEvent,
-        settings: settings,
+        settings: settings
     }).send();
 }
 exports.identityServer = identityServer;

package/dist/cjs/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, ExtensionData } 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 pageViewData;
+    private pageViewData?;
     private extensionData;
     private urlSearchParams;
     private includeUTMParameters;
@@ -49,7 +49,7 @@ export declare class PageViewEvent extends BaseEvent {
  */
 export interface PageViewEventArguments {
     sendEvent: SendEvent;
-    pageViewData: PageViewData;
+    pageViewData?: PageViewData;
     id: string;
     settings: Settings;
     infer?: Infer;
@@ -64,6 +64,7 @@ export interface PageViewData extends EventAttributesInput {
     referrer?: string;
     includeUTMParameters?: boolean;
     extensionData?: ExtensionData;
+    searchData?: NestedObject;
 }
 /**
  * Interface with the utm_ parameters
@@ -80,5 +81,11 @@ export interface PageViewEventPayload extends UtmParameters {
     ext?: {
         pageVariantId?: string;
     } & FlattenedObject;
+    sc_search?: {
+        data: NestedObject;
+        metadata: {
+            ut_api_version: string;
+        };
+    };
 }
 export {};

package/dist/cjs/src/lib/events/page-view/page-view-event.js

@@ -1,22 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PageViewEvent = void 0;
-const utils_1 = require("@sitecore-cloudsdk/utils");
-const base_event_1 = require("../base-event");
 const consts_1 = require("../consts");
+const base_event_1 = require("../base-event");
 const consts_2 = require("../../consts");
+const utils_1 = require("@sitecore-cloudsdk/utils");
 class PageViewEvent 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, extensionData } = args.pageViewData;
+        const { channel, currency, language, page, extensionData } = { ...args.pageViewData };
         super({
             channel,
             currency,
             language,
-            page,
+            page
         }, args.id);
         this.extensionData = {};
         this.pageViewData = args.pageViewData;
@@ -28,8 +28,7 @@ class PageViewEvent extends base_event_1.BaseEvent {
         const numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
         if (numberOfExtensionDataProperties > consts_1.MAX_EXT_ATTRIBUTES)
             throw new Error(consts_2.ErrorMessages.IV_0005);
-        this.includeUTMParameters =
-            args.pageViewData.includeUTMParameters === undefined ? true : args.pageViewData.includeUTMParameters;
+        this.includeUTMParameters = (args.pageViewData && args.pageViewData.includeUTMParameters) ?? true;
     }
     /**
      * Gets the variant ID from the url if not passed by the developer
@@ -52,7 +51,7 @@ class PageViewEvent extends base_event_1.BaseEvent {
      * @returns - the referrer
      */
     getReferrer() {
-        if (this.pageViewData.referrer)
+        if (this.pageViewData?.referrer)
             return this.pageViewData.referrer;
         if (typeof window === 'undefined')
             return null;
@@ -66,24 +65,33 @@ class PageViewEvent extends base_event_1.BaseEvent {
      * @returns the mapped object to be sent as payload
      */
     mapAttributes() {
-        let viewPayload = {
-            type: 'VIEW',
+        let pageViewPayload = {
+            type: 'VIEW'
         };
-        const pageVariantId = this.getPageVariantId(this.pageViewData.pageVariantId, this.extensionData['pageVariantId']);
+        const pageVariantId = this.pageViewData &&
+            this.getPageVariantId(this.pageViewData.pageVariantId, this.extensionData['pageVariantId']);
         if (pageVariantId !== null)
-            viewPayload.ext = { ...viewPayload.ext, pageVariantId };
+            pageViewPayload.ext = { ...pageViewPayload.ext, pageVariantId };
         if (Object.keys(this.extensionData).length > 0) {
             delete this.extensionData['pageVariantId'];
-            viewPayload.ext = { ...viewPayload.ext, ...this.extensionData };
+            pageViewPayload.ext = { ...pageViewPayload.ext, ...this.extensionData };
         }
         if (this.includeUTMParameters) {
             const utmParameters = this.getUTMParameters();
-            viewPayload = { ...viewPayload, ...utmParameters };
+            pageViewPayload = { ...pageViewPayload, ...utmParameters };
         }
         const referrer = this.getReferrer();
         if (referrer !== null)
-            viewPayload = { ...viewPayload, referrer };
-        return viewPayload;
+            pageViewPayload = { ...pageViewPayload, referrer };
+        if (this.pageViewData?.searchData)
+            pageViewPayload.sc_search = {
+                data: this.pageViewData.searchData,
+                metadata: {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    ut_api_version: '1.0'
+                }
+            };
+        return pageViewPayload;
     }
     /**
      * Sends the event to Sitecore EP
@@ -92,9 +100,8 @@ class PageViewEvent extends base_event_1.BaseEvent {
     async send() {
         const baseAttr = this.mapBaseEventPayload();
         const eventAttrs = this.mapAttributes();
-        const fetchBody = Object.assign({}, eventAttrs, baseAttr);
         PageViewEvent.isFirstPageView = false;
-        return await this.sendEvent(fetchBody, this.settings);
+        return await this.sendEvent({ ...baseAttr, ...eventAttrs }, this.settings);
     }
     /**
      * Retrieves UTM parameters from the url query string

package/dist/cjs/src/lib/events/page-view/page-view-server.d.ts

@@ -1,6 +1,6 @@
-import { EPResponse } from '@sitecore-cloudsdk/core';
-import { Request } from '@sitecore-cloudsdk/utils';
-import { PageViewData } from './page-view-event';
+import type { EPResponse } from '@sitecore-cloudsdk/core';
+import type { PageViewData } from './page-view-event';
+import type { Request } from '@sitecore-cloudsdk/utils';
 /**
  * A function that sends a VIEW event to SitecoreCloud API
  *
@@ -8,4 +8,4 @@ import { PageViewData } from './page-view-event';
  * @param pageViewData - The required/optional attributes in order to be send to SitecoreCloud API
  * @returns The response object that Sitecore EP returns
  */
-export declare function pageViewServer<T extends Request>(request: T, pageViewData: PageViewData): Promise<EPResponse | null>;
+export declare function pageViewServer<T extends Request>(request: T, pageViewData?: PageViewData): Promise<EPResponse | null>;