@cakemail-org/ui-components-v2 2.2.107 → 2.2.109

package/dist/cjs/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/cjs/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/dist/cjs/types/promisePool.d.ts

@@ -33,8 +33,11 @@ export declare enum EPartialInfoPool {
     "partialUsers" = "partialUsers",
     "partialLists" = "partialLists",
     "partialListReports" = "partialListReports",
-    "partialCampaignReports" = "partialCampaignReports"
+    "partialCampaignReports" = "partialCampaignReports",
+    "partialPageEventSummaries" = "partialPageEventSummaries",
+    "partialPopupEventSummaries" = "partialPopupEventSummaries"
 }
+export type TPromisePoolPartialEventSummary = Partial<Record<string, number>>;
 export type TPromisePoolPartialUser = Pick<TUserModel, "id" | "email" | "status" | "last_activity_on" | "first_name" | "last_name" | "language" | "timezone"> | undefined;
 export type TPromisePoolPartialSender = Pick<TSenderModel, "email" | "name" | "confirmed"> | undefined;
 export type TPromisePoolPartialTemplates = Pick<TTemplateModel | TListTemplateModel, "name" | "thumbnail_url" | "description"> | undefined;

package/dist/esm/components/textField/types.d.ts

@@ -1,7 +1,7 @@
 import { BaseTextFieldProps } from "@mui/material";
 import { ChangeEventHandler } from "react";
 import { TIconName } from "../icon/types";
-export interface TTextField extends Omit<BaseTextFieldProps, "onMouseUp" | "FormHelperTextProps" | "fullWidth" | "select" | "margin" | "component" | "InputLabelProps" | "SelectProps" | "classes" | "size" | "color"> {
+export interface TTextField extends Omit<BaseTextFieldProps, "onMouseUp" | "FormHelperTextProps" | "fullWidth" | "select" | "margin" | "component" | "InputLabelProps" | "SelectProps" | "classes" | "color"> {
     onChange?: TTextFieldChange;
     labelTooltipText?: string;
     useBareBoneInput?: boolean;

package/dist/esm/data/theme/MuiTextField.d.ts

@@ -1,5 +1,32 @@
 import { Theme } from "@mui/material";
 export default function getMuiTextField(theme: Theme): {
+    variants: ({
+        props: {
+            size: string;
+        };
+        style: {
+            ".MuiInputBase-root > input, .MuiInputBase-root > textarea": {
+                padding: string;
+                fontSize: import("csstype").Property.FontSize<string | number> | undefined;
+                lineHeight: import("csstype").Property.LineHeight<string | number> | undefined;
+            };
+            ".MuiSvgIcon-root": {
+                top: string;
+            };
+        };
+    } | {
+        props: {
+            size: string;
+        };
+        style: {
+            ".MuiInputBase-root > input, .MuiInputBase-root > textarea": {
+                padding: string;
+                fontSize?: undefined;
+                lineHeight?: undefined;
+            };
+            ".MuiSvgIcon-root"?: undefined;
+        };
+    })[];
     styleOverrides: {
         root: {
             ".MuiInputLabel-root": {

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

@@ -0,0 +1,14 @@
+import { EventModel } from "../../models/eventTracking";
+import { TGetEventBreakdown, TGetEventFunnel, TGetEventPropertyKeys, TGetEventSummary, TGetEventTimeseries, TListEvents } from "../../services/eventTracking";
+import { TEventBreakdown, TEventFunnel, TEventListResponse, TEventPropertyKeys, TEventSummary, TEventTimeseries } from "./types";
+export declare class EventTrackingFactory {
+    static list({ ...options }: TListEvents): Promise<Omit<TEventListResponse, "items"> & {
+        items: EventModel[];
+    }>;
+    static getSummary({ ...options }: TGetEventSummary): Promise<TEventSummary>;
+    static getTimeseries({ ...options }: TGetEventTimeseries): Promise<TEventTimeseries>;
+    static getBreakdown({ ...options }: TGetEventBreakdown): Promise<TEventBreakdown>;
+    static getPropertyKeys({ ...options }: TGetEventPropertyKeys): Promise<TEventPropertyKeys>;
+    static getFunnel({ ...options }: TGetEventFunnel): Promise<TEventFunnel>;
+}
+export * from "./types";

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

@@ -0,0 +1,91 @@
+import { ETrackedEntityType, ETrackedEventType } from "../../models/eventTracking/types";
+export type TEventRow = {
+    event_id: string;
+    event_type: ETrackedEventType | string;
+    entity_type: ETrackedEntityType | string;
+    entity_id: string;
+    session_id?: string | null;
+    visitor_id?: string | null;
+    occurred_at: string;
+    device_type?: string | null;
+    browser?: string | null;
+    os?: string | null;
+    source?: string | null;
+    utm_source?: string | null;
+    utm_medium?: string | null;
+    utm_campaign?: string | null;
+    referrer?: string | null;
+    properties: Record<string, unknown>;
+    scroll_depth?: number | null;
+    element_id?: string | null;
+    popup_trigger?: string | null;
+    page_url?: string | null;
+    email?: string | null;
+    list_id?: string | null;
+    contact_id?: string | null;
+    form_id?: string | null;
+    ip?: string | null;
+};
+export type TEventListResponse = {
+    total: number;
+    limit: number;
+    offset: number;
+    items: TEventRow[];
+};
+export type TSummaryByEventType = {
+    event_type: string;
+    count: number;
+};
+export type TEventSummary = {
+    total: number;
+    by_event_type: TSummaryByEventType[];
+    new_visitors: number;
+    returning_visitors: number;
+};
+export type TTimeseriesPoint = {
+    timestamp: string;
+    count: number;
+};
+export type TTimeseriesPointBreakdown = {
+    timestamp: string;
+    values: Array<{
+        dimension_value?: string | null;
+        count: number;
+    }>;
+};
+export type TEventTimeseries = {
+    granularity: string;
+    event_type?: string | null;
+    breakdown?: string | null;
+    series: Array<TTimeseriesPoint | TTimeseriesPointBreakdown>;
+};
+export type TBreakdownItem = {
+    value?: string | null;
+    count: number;
+    percentage: number;
+};
+export type TEventBreakdown = {
+    dimension: string;
+    total: number;
+    items: TBreakdownItem[];
+};
+export type TPropertyKey = {
+    key: string;
+    count: number;
+};
+export type TEventPropertyKeys = {
+    keys: TPropertyKey[];
+};
+export type TFunnelStep = {
+    event_type: string;
+    count: number;
+    step_conversion_rate: number;
+    overall_conversion_rate: number;
+};
+export type TEventFunnel = {
+    window_hours: number;
+    steps: TFunnelStep[];
+    total_entered: number;
+    total_completed: number;
+    overall_conversion_rate: number;
+};

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

@@ -6,6 +6,7 @@ export * from "./campaigns";
 export * from "./contacts";
 export * from "./customDomains";
 export * from "./emailAPI";
+export * from "./eventTracking";
 export * from "./forms";
 export * from "./lists";
 export * from "./pages";