@sitecore-content-sdk/events 2.0.0-canary.12

package/types/src/events/page-view/page-view-event.d.ts

@@ -0,0 +1,125 @@
+import type { EPResponse, Infer } from '@sitecore-content-sdk/analytics-core/internal';
+import type { EventAttributesInput, ExtensionData } from '../common-interfaces';
+import type { FlattenedObject, NestedObject } from '@sitecore-content-sdk/analytics-core/utils';
+import { BaseEvent } from '../base-event';
+import type { SendEvent } from '../send-event/sendEvent';
+import { CoreContext } from '@sitecore-content-sdk/core';
+/**
+ * A class that extends from {@link BaseEvent} and has all the required functionality to send a VIEW event
+ */
+export declare class PageViewEvent extends BaseEvent {
+    static isFirstPageView: boolean;
+    config: CoreContext['config'];
+    private sendEvent;
+    private pageViewData?;
+    private extensionData;
+    private urlSearchParams;
+    private includeUTMParameters;
+    /**
+     * A class that extends from {@link BaseEvent} and has all the required functionality to send a VIEW event
+     * @param {PageViewEventArguments} args - Unified object containing the required properties
+     */
+    constructor(args: PageViewEventArguments);
+    /**
+     * Sends the event to Sitecore Edge Proxy
+     * @returns - A promise that resolves with either the Sitecore Edge Proxy response object or null
+     */
+    send(): Promise<EPResponse | null>;
+    /**
+     * 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
+     * @param {string} [pageVariantIdFromPageViewData] - The variant ID from the page view data
+     * @param {string} [pageVariantIdFromExt] - The variant ID from extension data
+     * @returns - variant ID or null
+     */
+    private getPageVariantId;
+    /**
+     * Returns the referrer if exists on page view event else null if 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;
+    /**
+     * Retrieves UTM parameters from the url query string
+     * @returns - an object containing the UTM parameters if they exist
+     */
+    private getUTMParameters;
+}
+/**
+ * Interface of the unified arguments object for page view event
+ * @internal
+ */
+export interface PageViewEventArguments {
+    sendEvent: SendEvent;
+    pageViewData?: PageViewData;
+    id: string;
+    config: CoreContext['config'];
+    infer?: Infer;
+    extensionData?: NestedObject;
+    searchParams: string;
+}
+/**
+ * Type with the required/optional attributes in order to send a view event to the SitecoreCloud API
+ * @public
+ */
+export interface PageViewData extends EventAttributesInput {
+    /**
+     * The ID of a personalized page variant.
+     */
+    pageVariantId?: string;
+    /**
+     * The URI of the webpage that linked to the webpage where the event was captured.
+     *
+     * Default for browser-side events: inferred from document.referrer. If document.referrer is an empty string, the value will be set to null.
+     *
+     * Default for server-side events: null.
+     */
+    referrer?: string;
+    /**
+     * Whether to add every UTM parameter from the URL of the current webpage to the event object.
+     *
+     * Default: `true`.
+     */
+    includeUTMParameters?: boolean;
+    /**
+     * Any custom data to collect about an event in addition to the other attributes provided for the event data.
+     */
+    extensionData?: ExtensionData;
+    /**
+     * Sitecore Search data about the event.
+     * If set, the event and all its data will be available in Sitecore Search.
+     * Construct according to the Sitecore Search Events API reference and data model.
+     */
+    searchData?: NestedObject;
+}
+/**
+ * Interface with the utm_ parameters
+ * @internal
+ */
+interface UtmParameters {
+    [key: `utm_${string}`]: string;
+}
+/**
+ * An interface describing the page view event specific payload to be sent to the API
+ * @internal
+ */
+export interface PageViewEventPayload extends UtmParameters {
+    type: 'VIEW';
+    referrer?: string;
+    ext?: {
+        pageVariantId?: string;
+    } & FlattenedObject;
+    sc_search?: {
+        data: NestedObject;
+        metadata: {
+            ut_api_version: string;
+        };
+    };
+}
+export {};
+//# sourceMappingURL=page-view-event.d.ts.map

package/types/src/events/page-view/page-view-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view-event.d.ts","sourceRoot":"","sources":["../../../../src/events/page-view/page-view-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,+CAA+C,CAAC;AACvF,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAC;AAEhG,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAa,MAAM,4BAA4B,CAAC;AAIpE;;GAEG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAC1C,MAAM,CAAC,eAAe,UAAQ;IAC9B,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC9B,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,YAAY,CAAC,CAAe;IACpC,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,oBAAoB,CAAU;IAEtC;;;OAGG;gBACS,IAAI,EAAE,sBAAsB;IA2BxC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IASxC;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAWxB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAWnB;;;OAGG;IACH,OAAO,CAAC,aAAa;IAyCrB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;CAWzB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC9B,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,oBAAoB;IACxD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;OAIG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC;CAC3B;AAED;;;GAGG;AACH,UAAU,aAAa;IACrB,CAAC,GAAG,EAAE,OAAO,MAAM,EAAE,GAAG,MAAM,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,eAAe,CAAC;IACnD,SAAS,CAAC,EAAE;QACV,IAAI,EAAE,YAAY,CAAC;QACnB,QAAQ,EAAE;YAAE,cAAc,EAAE,MAAM,CAAA;SAAE,CAAC;KACtC,CAAC;CACH"}

package/types/src/events/page-view/page-view.d.ts

@@ -0,0 +1,11 @@
+import type { EPResponse } from '@sitecore-content-sdk/analytics-core/internal';
+import type { PageViewData } from './page-view-event';
+/**
+ * A function that sends a VIEW event to the SitecoreCloud API
+ * @param {PageViewData} [pageViewData] - The optional attributes to be sent to the SitecoreCloud API
+ * This object will be flattened and sent in the ext object of the payload
+ * @returns The response object that Sitecore Edge Proxy returns
+ * @public
+ */
+export declare function pageView(pageViewData?: PageViewData): Promise<EPResponse | null>;
+//# sourceMappingURL=page-view.d.ts.map

package/types/src/events/page-view/page-view.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view.d.ts","sourceRoot":"","sources":["../../../../src/events/page-view/page-view.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAGhF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAKtD;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAgBtF"}

package/types/src/events/send-event/sendEvent.d.ts

@@ -0,0 +1,22 @@
+import type { BasePayload, CustomEventPayload, IdentityEventPayload, PageViewEventPayload } from '..';
+import type { EPResponse } from '@sitecore-content-sdk/analytics-core/internal';
+import { CoreContext } from '@sitecore-content-sdk/core';
+/**
+ * This function sends an event to Sitecore Edge Proxy
+ * @param {EPFetchBody & BasePayload} body - The event data to send
+ * @param {CoreContext['config']} config - The global configuration
+ * @internal
+ */
+export declare function sendEvent(body: EPFetchBody & BasePayload, config: CoreContext['config']): Promise<EPResponse | null>;
+/**
+ * The type of sendEvent function
+ * @internal
+ */
+export type SendEvent = (body: EPFetchBody & BasePayload, config: CoreContext['config']) => Promise<EPResponse | null>;
+/**
+ * The type describing all possible event payloads
+ * @internal
+ */
+type EPFetchBody = PageViewEventPayload | IdentityEventPayload | CustomEventPayload;
+export {};
+//# sourceMappingURL=sendEvent.d.ts.map

package/types/src/events/send-event/sendEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendEvent.d.ts","sourceRoot":"","sources":["../../../../src/events/send-event/sendEvent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,IAAI,CAAC;AACZ,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAEhF,OAAO,EAAE,WAAW,EAAqB,MAAM,4BAA4B,CAAC;AAG5E;;;;;GAKG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,WAAW,GAAG,WAAW,EAC/B,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,GAC5B,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAyB5B;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,CACtB,IAAI,EAAE,WAAW,GAAG,WAAW,EAC/B,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,KAC1B,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;AAEhC;;;GAGG;AACH,KAAK,WAAW,GAAG,oBAAoB,GAAG,oBAAoB,GAAG,kBAAkB,CAAC"}

package/types/src/index.d.ts

@@ -0,0 +1,10 @@
+export type { PageViewData, EventData, IdentityData } from './events';
+export type { Identifier } from './events/identity/identity-event';
+export type { EventAttributesInput, ExtensionData } from './events/common-interfaces';
+export { form } from './events/custom-event/form';
+export { event } from './events/custom-event/event';
+export { identity } from './events/identity/identity';
+export { pageView } from './events/page-view/page-view';
+export type { EventsPlugin } from './initialization/types';
+export { eventsPlugin } from './initialization/plugin';
+//# sourceMappingURL=index.d.ts.map

package/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACtE,YAAY,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC"}

package/types/src/initialization/const.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The name of the Events plugin.
+ * @public
+ */
+export declare const EVENTS_PLUGIN_NAME = "EventsPlugin";
+//# sourceMappingURL=const.d.ts.map

package/types/src/initialization/const.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"const.d.ts","sourceRoot":"","sources":["../../../src/initialization/const.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,kBAAkB,iBAAiB,CAAC"}

package/types/src/initialization/plugin.d.ts

@@ -0,0 +1,35 @@
+import { event } from '../events/custom-event/event';
+import { form } from '../events/custom-event/form';
+import { identity } from '../events/identity/identity';
+import { pageView } from '../events/page-view/page-view';
+import { addToEventQueue } from '../eventStorage/addToEventQueue';
+import { clearEventQueue } from '../eventStorage/clearEventQueue';
+import { processEventQueue } from '../eventStorage/processEventQueue';
+import { EventsPlugin } from './types';
+/**
+ * Creates an events plugin with the provided options.
+ * @returns {EventsPlugin} The events plugin instance.
+ * @public
+ */
+export declare function eventsPlugin(): EventsPlugin;
+/**
+ * Retrieves the events plugin instance from the core context.
+ * @returns {EventsPlugin} The events plugin instance.
+ * @internal
+ */
+export declare function getEventsPlugin(): EventsPlugin;
+declare global {
+    interface ScContentSDK {
+        events: {
+            addToEventQueue: typeof addToEventQueue;
+            clearEventQueue: typeof clearEventQueue;
+            event: typeof event;
+            form: typeof form;
+            identity: typeof identity;
+            pageView: typeof pageView;
+            processEventQueue: typeof processEventQueue;
+            version: string;
+        };
+    }
+}
+//# sourceMappingURL=plugin.d.ts.map

package/types/src/initialization/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/initialization/plugin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAEtE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAyBvC;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,YAAY,CAM3C;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAQ9C;AAED,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,YAAY;QACpB,MAAM,EAAE;YACN,eAAe,EAAE,OAAO,eAAe,CAAC;YACxC,eAAe,EAAE,OAAO,eAAe,CAAC;YACxC,KAAK,EAAE,OAAO,KAAK,CAAC;YACpB,IAAI,EAAE,OAAO,IAAI,CAAC;YAClB,QAAQ,EAAE,OAAO,QAAQ,CAAC;YAC1B,QAAQ,EAAE,OAAO,QAAQ,CAAC;YAC1B,iBAAiB,EAAE,OAAO,iBAAiB,CAAC;YAC5C,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH;CACF"}

package/types/src/initialization/types.d.ts

@@ -0,0 +1,22 @@
+import { Plugin } from '@sitecore-content-sdk/core';
+import { EVENTS_PLUGIN_NAME } from './const';
+/**
+ * Defines the structure of the events plugin, including its initialization method, name, and dependencies.
+ * @public
+ */
+export interface EventsPlugin extends Plugin {
+    /**
+     * Initializes the events plugin, which may involve setting up necessary configurations or performing any asynchronous operations required for the plugin to function properly.
+     * @returns A promise that resolves when the initialization is complete.
+     */
+    init: () => Promise<void>;
+    /**
+     * The name of the events plugin.
+     */
+    name: typeof EVENTS_PLUGIN_NAME;
+    /**
+     * An array of plugin names that the events plugin depends on. This ensures that the required plugins are initialized before the events plugin is initialized.
+     */
+    dependencies: string[];
+}
+//# sourceMappingURL=types.d.ts.map

package/types/src/initialization/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/initialization/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C;;;OAGG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B;;OAEG;IACH,IAAI,EAAE,OAAO,kBAAkB,CAAC;IAChC;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB"}

package/types/src/internal.d.ts

@@ -0,0 +1,3 @@
+export { EVENTS_PLUGIN_NAME } from './initialization/const';
+export { PACKAGE_VERSION, PACKAGE_NAME } from './consts';
+//# sourceMappingURL=internal.d.ts.map

package/types/src/internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC"}