@cakemail-org/ui-components-v2 2.2.103 → 2.2.105

package/dist/esm/models/eventTracking/index.d.ts

@@ -0,0 +1,31 @@
+import { TEventModel } from "./types";
+export declare class EventModel {
+    readonly eventId: string;
+    readonly eventType: TEventModel["eventType"];
+    readonly entityType: TEventModel["entityType"];
+    readonly entityId: string;
+    readonly sessionId?: string | null;
+    readonly visitorId?: string | null;
+    readonly occurredAt: string;
+    readonly deviceType?: TEventModel["deviceType"];
+    readonly browser?: string | null;
+    readonly os?: string | null;
+    readonly source?: string | null;
+    readonly utmSource?: string | null;
+    readonly utmMedium?: string | null;
+    readonly utmCampaign?: string | null;
+    readonly referrer?: string | null;
+    readonly properties: Record<string, unknown>;
+    readonly scrollDepth?: number | null;
+    readonly elementId?: string | null;
+    readonly popupTrigger?: string | null;
+    readonly pageUrl?: string | null;
+    readonly email?: string | null;
+    readonly listId?: string | null;
+    readonly contactId?: string | null;
+    readonly formId?: string | null;
+    readonly ip?: string | null;
+    constructor(params: TEventModel);
+    toJson(): any;
+}
+export * from "./types";

package/dist/esm/models/eventTracking/types.d.ts

@@ -0,0 +1,47 @@
+export declare enum ETrackedEventType {
+    pageView = "page_view",
+    scrollDepth = "scroll_depth",
+    pageConversion = "page_conversion",
+    pageExit = "page_exit",
+    popupView = "popup_view",
+    popupDismiss = "popup_dismiss",
+    popupConversion = "popup_conversion",
+    click = "click",
+    formSubmit = "form_submit"
+}
+export declare enum ETrackedEntityType {
+    page = "page",
+    popup = "popup"
+}
+export declare enum ETrackedDeviceType {
+    mobile = "mobile",
+    desktop = "desktop",
+    tablet = "tablet"
+}
+export type TEventModel = {
+    eventId: string;
+    eventType: ETrackedEventType | string;
+    entityType: ETrackedEntityType | string;
+    entityId: string;
+    sessionId?: string | null;
+    visitorId?: string | null;
+    occurredAt: string;
+    deviceType?: ETrackedDeviceType | string | null;
+    browser?: string | null;
+    os?: string | null;
+    source?: string | null;
+    utmSource?: string | null;
+    utmMedium?: string | null;
+    utmCampaign?: string | null;
+    referrer?: string | null;
+    properties: Record<string, unknown>;
+    scrollDepth?: number | null;
+    elementId?: string | null;
+    popupTrigger?: string | null;
+    pageUrl?: string | null;
+    email?: string | null;
+    listId?: string | null;
+    contactId?: string | null;
+    formId?: string | null;
+    ip?: string | null;
+};

package/dist/esm/models/index.d.ts

@@ -5,6 +5,7 @@ export * from "./contact";
 export * from "./customDomains";
 export * from "./customer";
 export * from "./emailAPI";
+export * from "./eventTracking";
 export * from "./form";
 export * from "./list";
 export * from "./pages";

package/dist/esm/services/eventTracking/index.d.ts

@@ -0,0 +1,8 @@
+import { TGetEventBreakdown, TGetEventFunnel, TGetEventPropertyKeys, TGetEventSummary, TGetEventTimeseries, TListEvents } from "./types";
+export declare function listEvents({ useImpersonationTree, ...options }: TListEvents): Promise<any>;
+export declare function getEventSummary({ useImpersonationTree, ...options }: TGetEventSummary): Promise<any>;
+export declare function getEventTimeseries({ useImpersonationTree, ...options }: TGetEventTimeseries): Promise<any>;
+export declare function getEventBreakdown({ useImpersonationTree, ...options }: TGetEventBreakdown): Promise<any>;
+export declare function getEventPropertyKeys({ useImpersonationTree, ...options }: TGetEventPropertyKeys): Promise<any>;
+export declare function getEventFunnel({ useImpersonationTree, ...options }: TGetEventFunnel): Promise<any>;
+export * from "./types";

package/dist/esm/services/eventTracking/types.d.ts

@@ -0,0 +1,92 @@
+import { ETrackedEntityType, ETrackedEventType } from "../../models/eventTracking/types";
+export declare enum EEventBreakdownDimension {
+    deviceType = "device_type",
+    browser = "browser",
+    os = "os",
+    source = "source",
+    utmSource = "utm_source",
+    utmMedium = "utm_medium",
+    utmCampaign = "utm_campaign",
+    entityType = "entity_type",
+    elementId = "element_id",
+    popupTrigger = "popup_trigger",
+    pageUrl = "page_url",
+    listId = "list_id",
+    contactId = "contact_id",
+    formId = "form_id"
+}
+export declare enum EEventTimeseriesGranularity {
+    hour = "hour",
+    day = "day",
+    week = "week",
+    month = "month"
+}
+export declare enum EEventSortField {
+    occurredAt = "occurred_at",
+    eventType = "event_type",
+    entityId = "entity_id",
+    deviceType = "device_type",
+    source = "source"
+}
+export type TEventDateRangeParams = {
+    fromDate?: string;
+    toDate?: string;
+};
+export type TEventEntityFilterParams = {
+    entityId?: string;
+    entityType?: ETrackedEntityType | string;
+};
+export type TEventAttributionFilterParams = {
+    email?: string;
+    listId?: string;
+    contactId?: string;
+    formId?: string;
+    elementId?: string;
+    popupTrigger?: string;
+    pageUrl?: string;
+};
+export type TEventLineageParams = {
+    subLineage?: string;
+    includeSubAccounts?: boolean;
+};
+export type TEventCommonFilterParams = TEventDateRangeParams & TEventEntityFilterParams & TEventAttributionFilterParams & TEventLineageParams;
+export type TListEvents = TEventCommonFilterParams & {
+    eventType?: ETrackedEventType | string | Array<ETrackedEventType | string>;
+    sortBy?: EEventSortField | string;
+    sortOrder?: "asc" | "desc";
+    properties?: string | Record<string, unknown>;
+    scrollDepthGte?: number;
+    scrollDepthLte?: number;
+    limit?: number;
+    offset?: number;
+    useImpersonationTree?: boolean;
+};
+export type TGetEventSummary = TEventCommonFilterParams & {
+    useImpersonationTree?: boolean;
+};
+export type TGetEventTimeseries = TEventCommonFilterParams & {
+    eventType?: ETrackedEventType | string;
+    granularity?: EEventTimeseriesGranularity | string;
+    breakdown?: EEventBreakdownDimension | string;
+    useImpersonationTree?: boolean;
+};
+export type TGetEventBreakdown = TEventCommonFilterParams & {
+    dimension: EEventBreakdownDimension | string;
+    eventType?: ETrackedEventType | string;
+    useImpersonationTree?: boolean;
+};
+export type TGetEventPropertyKeys = TEventDateRangeParams & TEventEntityFilterParams & TEventLineageParams & {
+    eventType?: ETrackedEventType | string;
+    search?: string;
+    email?: string;
+    useImpersonationTree?: boolean;
+};
+export type TEventFunnelStep = {
+    eventType: ETrackedEventType | string;
+    properties?: Record<string, unknown>;
+};
+export type TGetEventFunnel = TEventCommonFilterParams & {
+    steps: TEventFunnelStep[];
+    windowHours?: number;
+    useImpersonationTree?: boolean;
+};

package/dist/esm/services/index.d.ts

@@ -8,6 +8,7 @@ export * from "./contacts";
 export * from "./customDomains";
 export * from "./domains";
 export * from "./emailAPI";
+export * from "./eventTracking";
 export * from "./forms";
 export * from "./hidden";
 export * from "./lists";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cakemail-org/ui-components-v2",
-    "version": "2.2.103",
+    "version": "2.2.105",
     "description": "ui library kit made with material UI",
     "main": "dist/cjs/index.js",
     "module": "dist/esm/index.js",