@sitecore-cloudsdk/events 0.1.0-rc.0

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

@@ -0,0 +1,13 @@
+import { ICdpResponse } from '@sitecore-cloudsdk/core';
+import { ExtensionData } from '../common-interfaces';
+import { ICustomEventInput } from './custom-event';
+import { TRequest } 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
+ */
+export declare function eventServer<T extends TRequest>(type: string, eventData: ICustomEventInput, request: T, extensionData?: ExtensionData): Promise<ICdpResponse | null>;

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

@@ -0,0 +1,28 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+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 initializer_1 = require("../../initializer/server/initializer");
+/**
+ * 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
+ */
+function eventServer(type, eventData, request, extensionData) {
+    const { eventApiClient, settings } = (0, initializer_1.getServerDependencies)();
+    const id = (0, core_1.getBrowserIdFromRequest)(request, settings.cookieSettings.cookieName);
+    return new custom_event_1.CustomEvent({
+        eventApiClient,
+        eventData,
+        extensionData,
+        id,
+        settings: settings,
+        type,
+    }).send();
+}
+exports.eventServer = eventServer;

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

@@ -0,0 +1,9 @@
+import { ICdpResponse } 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
+ */
+export declare function form(formId: string, interactionType: 'VIEWED' | 'SUBMITTED'): Promise<ICdpResponse | null>;

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

@@ -0,0 +1,30 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.form = void 0;
+const initializer_1 = require("../../initializer/browser/initializer");
+const custom_event_1 = require("./custom-event");
+/**
+ * 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
+ */
+function form(formId, interactionType) {
+    const { eventApiClient, id, settings } = (0, initializer_1.getDependencies)();
+    const formEvent = new custom_event_1.CustomEvent({
+        eventApiClient,
+        eventData: {},
+        extensionData: {
+            formId,
+            interactionType: interactionType.toUpperCase(),
+        },
+        id,
+        settings,
+        type: 'FORM',
+    });
+    formEvent.page = undefined;
+    return formEvent.send();
+}
+exports.form = form;

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

@@ -0,0 +1,99 @@
+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';
+export declare class IdentityEvent extends BaseEvent {
+    private eventData;
+    private eventApiClient;
+    private extensionData;
+    private numberOfExtensionDataProperties;
+    /**
+     * 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);
+    /**
+     * Function that validates the identifiers object, email and date attributes for CDN users
+     *  * @param eventData - The data to be validated
+     */
+    private validateAttributes;
+    /**
+     * A function that maps the identity event input data with the payload sent to the API
+     * @returns - The payload object
+     */
+    private mapAttributes;
+    /**
+     * Sends the event to Sitecore CDP
+     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     */
+    send(): Promise<ICdpResponse | null>;
+}
+/**
+ * The JSON array of objects that contain the identity identifiers
+ */
+interface ICDPIdentifier {
+    expiry_date?: string;
+    id: string;
+    provider: string;
+}
+/**
+ * Interface with the necessary attributes for the input for sending Identity events
+ */
+export interface IIdentityEventAttributesInput extends IEventAttributesInput {
+    city?: string;
+    country?: string;
+    dob?: string;
+    email?: string;
+    firstName?: string;
+    gender?: string;
+    identifiers: IIdentifier[];
+    lastName?: string;
+    mobile?: string;
+    phone?: string;
+    postalCode?: string;
+    state?: string;
+    street?: string[];
+    title?: string;
+}
+/**
+ * The JSON array of objects that contain the identity identifiers
+ */
+export interface IIdentifier {
+    expiryDate?: string;
+    id: string;
+    provider: string;
+}
+/**
+ *  An interface describing the identity event specific payload to be sent to the API
+ */
+export interface IIdentityEventPayload {
+    city?: string;
+    country?: string;
+    dob?: string;
+    email?: string;
+    firstname?: string;
+    gender?: string;
+    identifiers: ICDPIdentifier[];
+    lastname?: string;
+    mobile?: string;
+    phone?: string;
+    postal_code?: string;
+    state?: string;
+    street?: string[];
+    title?: string;
+    type: 'IDENTITY';
+    ext?: IFlattenedObject;
+}
+/**
+ * Interface of the unified arguments object for identity event
+ */
+export interface IIdentityEventArguments {
+    eventApiClient: IEventApiClient;
+    eventData: IIdentityEventAttributesInput;
+    extensionData?: ExtensionData;
+    id: string;
+    settings: ISettings;
+    infer?: IInfer;
+}
+export {};

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

@@ -0,0 +1,88 @@
+"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");
+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
+     * @param args - Unified object containing the required properties
+     */
+    constructor(args) {
+        const { channel, currency, language, page } = args.eventData;
+        super({ channel, currency, language, page }, args.settings, args.id);
+        this.extensionData = {};
+        this.numberOfExtensionDataProperties = 0;
+        this.validateAttributes(args.eventData);
+        this.eventData = args.eventData;
+        this.eventApiClient = args.eventApiClient;
+        if (args.extensionData)
+            this.extensionData = (0, utils_1.flattenObject)({ object: args.extensionData });
+        this.numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
+        if (this.numberOfExtensionDataProperties > consts_1.MAX_EXT_ATTRIBUTES)
+            throw new Error(`[IV-0005] This event supports maximum ${consts_1.MAX_EXT_ATTRIBUTES} attributes. Reduce the number of attributes.`);
+    }
+    /**
+     * Function that validates the identifiers object, email and date attributes for CDN users
+     *  * @param eventData - The data to be validated
+     */
+    validateAttributes(eventData) {
+        if (eventData.identifiers.length === 0)
+            throw new Error(`[MV-0004] "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) => {
+            if (identifier.expiryDate && !(0, utils_1.isShortISODateString)(identifier.expiryDate))
+                throw new Error(`[IV-0004] Incorrect value for "expiryDate". Format the value according to ISO 8601.`);
+        });
+        if (eventData.email && !(0, utils_1.isValidEmail)(eventData.email))
+            throw new Error(`[IV-0003] Incorrect value for "email". Set the value to a valid email address.`);
+    }
+    /**
+     * A function that maps the identity event input data with the payload sent to the API
+     * @returns - The payload object
+     */
+    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) => {
+                return {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    expiry_date: value.expiryDate,
+                    id: value.id,
+                    provider: value.provider,
+                };
+            }),
+            lastname: this.eventData.lastName,
+            mobile: this.eventData.mobile,
+            phone: this.eventData.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',
+        };
+        if (this.numberOfExtensionDataProperties > 0)
+            identityPayload.ext = this.extensionData;
+        return identityPayload;
+    }
+    /**
+     * Sends the event to Sitecore CDP
+     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     */
+    async send() {
+        const baseAttr = this.mapBaseEventPayload();
+        const eventAttrs = this.mapAttributes();
+        const fetchBody = Object.assign({}, eventAttrs, baseAttr);
+        return await this.eventApiClient.send(fetchBody);
+    }
+}
+exports.IdentityEvent = IdentityEvent;

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

@@ -0,0 +1,11 @@
+import { ExtensionData } from '../common-interfaces';
+import { ICdpResponse } from '@sitecore-cloudsdk/core';
+import { IIdentityEventAttributesInput } 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 CDP returns
+ */
+export declare function identity(eventData: IIdentityEventAttributesInput, extensionData?: ExtensionData): Promise<ICdpResponse | null>;

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

@@ -0,0 +1,24 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.identity = void 0;
+const initializer_1 = require("../../initializer/browser/initializer");
+const identity_event_1 = require("./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 CDP returns
+ */
+function identity(eventData, extensionData) {
+    const { eventApiClient, id, settings } = (0, initializer_1.getDependencies)();
+    return new identity_event_1.IdentityEvent({
+        eventApiClient,
+        eventData,
+        extensionData,
+        id,
+        settings,
+    }).send();
+}
+exports.identity = identity;

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

@@ -0,0 +1,13 @@
+import { ExtensionData } from '../common-interfaces';
+import { TRequest } from '@sitecore-cloudsdk/utils';
+import { ICdpResponse } from '@sitecore-cloudsdk/core';
+import { IIdentityEventAttributesInput } 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 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
+ * @returns The response object that Sitecore CDP returns
+ */
+export declare function identityServer(eventData: IIdentityEventAttributesInput, request: TRequest, extensionData?: ExtensionData): Promise<ICdpResponse | null>;

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

@@ -0,0 +1,27 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.identityServer = void 0;
+const core_1 = require("@sitecore-cloudsdk/core");
+const initializer_1 = require("../../initializer/server/initializer");
+const identity_event_1 = require("./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 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
+ * @returns The response object that Sitecore CDP returns
+ */
+function identityServer(eventData, request, extensionData) {
+    const { eventApiClient, settings } = (0, initializer_1.getServerDependencies)();
+    const id = (0, core_1.getBrowserIdFromRequest)(request, settings.cookieSettings.cookieName);
+    return new identity_event_1.IdentityEvent({
+        eventApiClient,
+        eventData,
+        extensionData,
+        id,
+        settings: settings,
+    }).send();
+}
+exports.identityServer = identityServer;

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

@@ -0,0 +1,9 @@
+export { BaseEvent } from './base-event';
+export type { IBasePayload } from './base-event';
+export { PageViewEvent } from './page-view/page-view-event';
+export type { IPageViewEventInput, IPageViewEventPayload } from './page-view/page-view-event';
+export { CustomEvent } from './custom-event/custom-event';
+export type { ICustomEventInput, ICustomEventPayload, ICustomEventArguments } from './custom-event/custom-event';
+export { IdentityEvent } from './identity/identity-event';
+export type { IIdentityEventAttributesInput, IIdentityEventPayload } from './identity/identity-event';
+export type { ExtensionData } from './common-interfaces';

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdentityEvent = exports.CustomEvent = exports.PageViewEvent = exports.BaseEvent = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+var base_event_1 = require("./base-event");
+Object.defineProperty(exports, "BaseEvent", { enumerable: true, get: function () { return base_event_1.BaseEvent; } });
+var page_view_event_1 = require("./page-view/page-view-event");
+Object.defineProperty(exports, "PageViewEvent", { enumerable: true, get: function () { return page_view_event_1.PageViewEvent; } });
+var custom_event_1 = require("./custom-event/custom-event");
+Object.defineProperty(exports, "CustomEvent", { enumerable: true, get: function () { return custom_event_1.CustomEvent; } });
+var identity_event_1 = require("./identity/identity-event");
+Object.defineProperty(exports, "IdentityEvent", { enumerable: true, get: function () { return identity_event_1.IdentityEvent; } });

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

@@ -0,0 +1,75 @@
+import { ICdpResponse, IInfer, ISettings } from '@sitecore-cloudsdk/core';
+import { IFlattenedObject, INestedObject } from '@sitecore-cloudsdk/utils';
+import { BaseEvent } from '../base-event';
+import { IEventApiClient } from '../../cdp/EventApiClient';
+import { IEventAttributesInput } from '../common-interfaces';
+export declare class PageViewEvent extends BaseEvent {
+    static isFirstPageView: boolean;
+    private eventApiClient;
+    private eventData;
+    private extensionData;
+    private urlSearchParams;
+    /**
+     * 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: IPageViewEventArguments);
+    /**
+     * Gets the variant ID from the url if not passed by the developer
+     * Gets the variant ID from the extension data if not found from the url
+     * @returns - variant ID or null
+     */
+    private getPageVariantId;
+    /**
+     * Returns the referrer if exists on page view event else null if we are on server and no referrer is on event, else
+     * returns the href if on client side and the document referrer is different from the window location hostname
+     * @returns - the referrer
+     */
+    private getReferrer;
+    /**
+     * Maps parameters given as input to corresponding attributes send to the API
+     * @returns the mapped object to be sent as payload
+     */
+    private mapAttributes;
+    /**
+     * Sends the event to Sitecore CDP
+     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     */
+    send(): Promise<ICdpResponse | null>;
+}
+/**
+ * Interface of the unified arguments object for page view event
+ */
+export interface IPageViewEventArguments {
+    eventApiClient: IEventApiClient;
+    eventData: IPageViewEventInput;
+    id: string;
+    settings: ISettings;
+    infer?: IInfer;
+    extensionData?: INestedObject;
+    searchParams: string;
+}
+/**
+ * Type with the required/optional attributes in order to send a view event to SitecoreCloud API
+ */
+export interface IPageViewEventInput extends IEventAttributesInput {
+    pageVariantId?: string;
+    referrer?: string;
+}
+/**
+ * Interface with the utm_ parameters
+ */
+interface IUtmParameters {
+    [key: `utm_${string}`]: string;
+}
+/**
+ * An interface describing the page view event specific payload to be sent * to the API
+ */
+export interface IPageViewEventPayload extends IUtmParameters {
+    type: 'VIEW';
+    referrer?: string;
+    ext?: {
+        pageVariantId?: string;
+    } & IFlattenedObject;
+}
+export {};

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

@@ -0,0 +1,94 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+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");
+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 } = args.eventData;
+        super({
+            channel,
+            currency,
+            language,
+            page,
+        }, args.settings, args.id);
+        this.extensionData = {};
+        this.eventData = args.eventData;
+        this.urlSearchParams = new URLSearchParams(decodeURI(args.searchParams));
+        if (args.extensionData)
+            this.extensionData = (0, utils_1.flattenObject)({ object: args.extensionData });
+        const numberOfExtensionDataProperties = Object.entries(this.extensionData).length;
+        if (numberOfExtensionDataProperties > consts_1.MAX_EXT_ATTRIBUTES)
+            throw new Error(`[IV-0005] This event supports maximum ${consts_1.MAX_EXT_ATTRIBUTES} attributes. Reduce the number of attributes.`);
+        this.eventApiClient = args.eventApiClient;
+    }
+    /**
+     * Gets the variant ID from the url if not passed by the developer
+     * Gets the variant ID from the extension data if not found from the url
+     * @returns - variant ID or null
+     */
+    getPageVariantId(pageVariantIdFromEventData, pageVariantIdFromExt) {
+        if (pageVariantIdFromEventData)
+            return pageVariantIdFromEventData;
+        const pageVariantIdFromURL = this.urlSearchParams.get('variantid');
+        if (pageVariantIdFromURL)
+            return pageVariantIdFromURL;
+        if (pageVariantIdFromExt)
+            return pageVariantIdFromExt;
+        return null;
+    }
+    /**
+     * Returns the referrer if exists on page view event else null if we are on server and no referrer is on event, else
+     * returns the href if on client side and the document referrer is different from the window location hostname
+     * @returns - the referrer
+     */
+    getReferrer() {
+        if (this.eventData.referrer)
+            return this.eventData.referrer;
+        if (typeof window === 'undefined')
+            return null;
+        if (!PageViewEvent.isFirstPageView || !document.referrer)
+            return null;
+        const { hostname, href } = new URL(document.referrer);
+        return window.location.hostname !== hostname ? href : null;
+    }
+    /**
+     * Maps parameters given as input to corresponding attributes send to the API
+     * @returns the mapped object to be sent as payload
+     */
+    mapAttributes() {
+        let viewPayload = {
+            type: 'VIEW',
+        };
+        const pageVariantId = this.getPageVariantId(this.eventData.pageVariantId, this.extensionData['pageVariantId']);
+        if (pageVariantId !== null)
+            viewPayload.ext = { ...viewPayload.ext, pageVariantId };
+        if (Object.keys(this.extensionData).length > 0) {
+            delete this.extensionData['pageVariantId'];
+            viewPayload.ext = { ...viewPayload.ext, ...this.extensionData };
+        }
+        const referrer = this.getReferrer();
+        if (referrer !== null)
+            viewPayload = { ...viewPayload, referrer };
+        return viewPayload;
+    }
+    /**
+     * Sends the event to Sitecore CDP
+     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     */
+    async send() {
+        const baseAttr = this.mapBaseEventPayload();
+        const eventAttrs = this.mapAttributes();
+        const fetchBody = Object.assign({}, eventAttrs, baseAttr);
+        PageViewEvent.isFirstPageView = false;
+        return await this.eventApiClient.send(fetchBody);
+    }
+}
+exports.PageViewEvent = PageViewEvent;
+PageViewEvent.isFirstPageView = true;

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

@@ -0,0 +1,12 @@
+import { ICdpResponse } from '@sitecore-cloudsdk/core';
+import { INestedObject, TRequest } from '@sitecore-cloudsdk/utils';
+import { IPageViewEventInput } from './page-view-event';
+/**
+ * A function that sends a VIEW 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
+ * @returns The response object that Sitecore CDP returns
+ */
+export declare function pageViewServer<T extends TRequest>(eventData: IPageViewEventInput, request: T, extensionData?: INestedObject): Promise<ICdpResponse | null>;

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pageViewServer = 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 initializer_1 = require("../../initializer/server/initializer");
+const page_view_event_1 = require("./page-view-event");
+/**
+ * A function that sends a VIEW 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
+ * @returns The response object that Sitecore CDP returns
+ */
+function pageViewServer(eventData, request, extensionData) {
+    const { eventApiClient, settings } = (0, initializer_1.getServerDependencies)();
+    const id = (0, core_1.getBrowserIdFromRequest)(request, settings.cookieSettings.cookieName);
+    // Host is irrelevant but necessary to support relative URL
+    const requestUrl = new URL(request.url, `https://localhost`);
+    return new page_view_event_1.PageViewEvent({
+        eventApiClient,
+        eventData,
+        extensionData,
+        id,
+        searchParams: requestUrl.search,
+        settings,
+    }).send();
+}
+exports.pageViewServer = pageViewServer;

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

@@ -0,0 +1,11 @@
+import { ICdpResponse } from '@sitecore-cloudsdk/core';
+import { INestedObject } from '@sitecore-cloudsdk/utils';
+import { IPageViewEventInput } from './page-view-event';
+/**
+ * A function that sends a VIEW 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 CDP returns
+ */
+export declare function pageView(eventData: IPageViewEventInput, extensionData?: INestedObject): Promise<ICdpResponse | null>;

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pageView = void 0;
+const initializer_1 = require("../../initializer/browser/initializer");
+const page_view_event_1 = require("./page-view-event");
+/**
+ * A function that sends a VIEW 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 CDP returns
+ */
+function pageView(eventData, extensionData) {
+    const { eventApiClient, id, settings } = (0, initializer_1.getDependencies)();
+    return new page_view_event_1.PageViewEvent({
+        eventApiClient,
+        eventData,
+        extensionData,
+        id,
+        searchParams: window.location.search,
+        settings,
+    }).send();
+}
+exports.pageView = pageView;

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

@@ -0,0 +1,6 @@
+/**
+ * A function that returns the guest id.
+ * @returns - A promise that resolves with the guest id
+ * @throws - Will throw an error if the clientKey/browser id is invalid
+ */
+export declare function getGuestId(): Promise<string>;

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

@@ -0,0 +1,16 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGuestId = void 0;
+const core_1 = require("@sitecore-cloudsdk/core");
+const initializer_1 = require("../initializer/browser/initializer");
+/**
+ * A function that returns the guest id.
+ * @returns - A promise that resolves with the guest id
+ * @throws - Will throw an error if the clientKey/browser id is invalid
+ */
+function getGuestId() {
+    const { id, settings } = (0, initializer_1.getDependencies)();
+    return (0, core_1.getGuestId)(id, settings.sitecoreEdgeContextId);
+}
+exports.getGuestId = getGuestId;