@cakemail-org/ui-components-v2 2.1.50 → 2.1.51

package/dist/cjs/factories/popups/index.d.ts

@@ -0,0 +1,14 @@
+import { ListPopupModel, PopupModel } from "../../models/popups";
+import { TPopupModel } from "../../models/popups/types";
+import { TGenericListParams, TGenericListReturn } from "../../types";
+export declare class PopupsFactory {
+    static list({ ...params }: TGenericListParams & {
+        name?: string;
+        tags?: string[];
+        enabled?: boolean;
+    }): Promise<TGenericListReturn<ListPopupModel>>;
+    static create({ ...popup }: Partial<TPopupModel>): Promise<PopupModel>;
+    static get({ id }: {
+        id: string;
+    }): Promise<PopupModel>;
+}

package/dist/cjs/index.js

@@ -5331,6 +5331,12 @@ exports.EEvents = void 0;
     EEvents["MFA_DISABLE_FLOW"] = "MFA.Disable.Flow.Started";
     EEvents["MFA_ENABLED"] = "MFA.Enabled";
     EEvents["MFA_DISABLED"] = "MFA.Disabled";
+    EEvents["POPUP_CREATED"] = "Popup.Created";
+    EEvents["POPUP_UPDATED"] = "Popup.Updated";
+    EEvents["POPUP_DELETED"] = "Popup.Deleted";
+    EEvents["POPUP_ENABLED"] = "Popup.Enabled";
+    EEvents["POPUP_DISABLED"] = "Popup.Disabled";
+    EEvents["POPUP_PUBLISHED"] = "Popup.Published";
 })(exports.EEvents || (exports.EEvents = {}));
 function eventCondition(type, disabledEvents) {
     if (disabledEvents === void 0) { disabledEvents = []; }

package/dist/cjs/models/popups/index.d.ts

@@ -0,0 +1,35 @@
+import { TDeleteApiResource } from "../../types";
+import { EPopupBranding, EPopupDisplayFrequency, TPopupContent, TPopupModel, TPopupTargeting, TPopupTrigger, TPopupUser } from "./types";
+export declare class ListPopupModel {
+    id: string;
+    readonly account_id: number;
+    name: string | null;
+    description: string | null;
+    enabled: boolean;
+    readonly created_on: number;
+    updated_on: number;
+    published_on: number | null;
+    branding: EPopupBranding;
+    tags: string[] | null;
+    edited_by: TPopupUser;
+    content: Omit<TPopupContent, "json">;
+    trigger: TPopupTrigger;
+    targeting: TPopupTargeting;
+    display_frequency: EPopupDisplayFrequency;
+    published_content_url: string | null;
+    thumbnail_url: string;
+    constructor(params: TPopupModel);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+    delete(): Promise<TDeleteApiResource>;
+    save({ ...popup }: Partial<TPopupModel>): Promise<PopupModel>;
+    enable(): Promise<PopupModel>;
+    disable(): Promise<PopupModel>;
+    publish(): Promise<PopupModel>;
+    render(): Promise<string>;
+}
+export declare class PopupModel extends ListPopupModel {
+    content: TPopupContent;
+    constructor(params: TPopupModel);
+    toJson(): any;
+}

package/dist/cjs/models/popups/types.d.ts

@@ -0,0 +1,94 @@
+export type TPopupModel = {
+    id: string;
+    account_id: number;
+    name: string | null;
+    description: string | null;
+    enabled: boolean;
+    created_on: number;
+    updated_on: number;
+    published_on: number | null;
+    branding: EPopupBranding;
+    tags: string[] | null;
+    edited_by: TPopupUser;
+    content: TPopupContent;
+    trigger: TPopupTrigger;
+    targeting: TPopupTargeting;
+    display_frequency: EPopupDisplayFrequency;
+    published_content_url: string | null;
+    thumbnail_url: string;
+};
+export type TPopupUser = {
+    id: string;
+    email: string;
+};
+export type TPopupTrigger = {
+    type: EPopupTriggerType;
+    delay_seconds: number | null;
+    scroll_percentage: number | null;
+    selector: string | null;
+    start_date: number | null;
+    end_date: number | null;
+};
+export type TPopupTargeting = {
+    pages: string[] | null;
+    exclude_pages: string[] | null;
+    devices: EPopupDeviceType[] | null;
+    browsers: EPopupBrowserType[] | null;
+    languages: string[] | null;
+    countries: string[] | null;
+    referrers: string[] | null;
+    utm_params: Record<string, string> | null;
+};
+export type TPopupContent = {
+    position: EPopupPosition | null;
+    json?: Record<string, any>;
+};
+export declare enum EPopupTriggerType {
+    on_page_load = "on_page_load",
+    on_exit_intent = "on_exit_intent",
+    on_scroll = "on_scroll",
+    on_time_delay = "on_time_delay",
+    on_click = "on_click"
+}
+export declare enum EPopupDisplayFrequency {
+    once_per_session = "once_per_session",
+    once_per_day = "once_per_day",
+    once_per_week = "once_per_week",
+    always = "always",
+    once = "once"
+}
+export declare enum EPopupDeviceType {
+    desktop = "desktop",
+    mobile = "mobile",
+    tablet = "tablet"
+}
+export declare enum EPopupBrowserType {
+    chrome = "chrome",
+    firefox = "firefox",
+    safari = "safari",
+    edge = "edge",
+    opera = "opera",
+    other = "other"
+}
+export declare enum EPopupPosition {
+    center = "classic-center",
+    top_right = "classic-top-right",
+    top_left = "classic-top-left",
+    top_center = "classic-top-center",
+    bottom_left = "classic-bottom-left",
+    bottom_center = "classic-bottom-center",
+    bottom_right = "classic-bottom-right",
+    drawer_left = "drawer-left",
+    drawer_right = "drawer-right",
+    drawer_top = "bar-top",
+    drawer_bottom = "bar-bottom"
+}
+export declare enum EPopupBranding {
+    smart = "smart",
+    basic = "basic"
+}
+export type TPopupFilters = {
+    name: string;
+    tags: string[];
+    enabled: string;
+};

package/dist/cjs/services/popups/index.d.ts

@@ -0,0 +1,31 @@
+import { TPopupModel } from "../../models/popups/types";
+import { TGenericListParams, TGenericListReturn, TGenericReturn } from "../../types";
+import { TCreateApiResource, TDeleteApiResource, TDisableApiResource, TEnableApiResource, TRenderResponse, TUpdateApiResource } from "../../types/generic";
+export declare function listPopups({ ...options }: TGenericListParams & {
+    name?: string;
+    tags?: string[];
+    enabled?: boolean;
+}): Promise<TGenericListReturn<TPopupModel>>;
+export declare function createPopup({ ...popup }: Partial<TPopupModel>): Promise<TCreateApiResource<TPopupModel>>;
+export declare function getPopup({ id }: {
+    id: string;
+}): Promise<TGenericReturn<TPopupModel>>;
+export declare function deletePopup({ id }: {
+    id: string;
+}): Promise<TDeleteApiResource>;
+export declare function updatePopup({ id, ...popup }: {
+    id: string;
+    popup: Partial<TPopupModel>;
+}): Promise<TUpdateApiResource<TPopupModel>>;
+export declare function enablePopup({ id }: {
+    id: string;
+}): Promise<TEnableApiResource<TPopupModel>>;
+export declare function disablePopup({ id }: {
+    id: string;
+}): Promise<TDisableApiResource<TPopupModel>>;
+export declare function publishPopup({ id }: {
+    id: string;
+}): Promise<TUpdateApiResource<TPopupModel>>;
+export declare function renderPopup({ id }: {
+    id: string;
+}): Promise<TRenderResponse>;

package/dist/cjs/types/generic.d.ts

@@ -112,6 +112,9 @@ export type TCreateApiResource<T> = {
     object: string;
     data: T;
 };
+export type TRenderResponse = {
+    data: string;
+};
 export type TActionApiResource = {
     id: number;
     object: string;

package/dist/cjs/utils/posthog.d.ts

@@ -143,7 +143,13 @@ export declare enum EEvents {
     MFA_ACTIVATION_FLOW = "MFA.Activation.Flow.Started",
     MFA_DISABLE_FLOW = "MFA.Disable.Flow.Started",
     MFA_ENABLED = "MFA.Enabled",
-    MFA_DISABLED = "MFA.Disabled"
+    MFA_DISABLED = "MFA.Disabled",
+    POPUP_CREATED = "Popup.Created",
+    POPUP_UPDATED = "Popup.Updated",
+    POPUP_DELETED = "Popup.Deleted",
+    POPUP_ENABLED = "Popup.Enabled",
+    POPUP_DISABLED = "Popup.Disabled",
+    POPUP_PUBLISHED = "Popup.Published"
 }
 export declare function eventCondition(type: EEvents | string, disabledEvents?: string[]): boolean;
 export declare function trackEvent(type: EEvents | string, data?: any, dataParser?: (event: EEvents | string, data: any) => any, disabledEvents?: string[]): void;

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

@@ -0,0 +1,14 @@
+import { ListPopupModel, PopupModel } from "../../models/popups";
+import { TPopupModel } from "../../models/popups/types";
+import { TGenericListParams, TGenericListReturn } from "../../types";
+export declare class PopupsFactory {
+    static list({ ...params }: TGenericListParams & {
+        name?: string;
+        tags?: string[];
+        enabled?: boolean;
+    }): Promise<TGenericListReturn<ListPopupModel>>;
+    static create({ ...popup }: Partial<TPopupModel>): Promise<PopupModel>;
+    static get({ id }: {
+        id: string;
+    }): Promise<PopupModel>;
+}

package/dist/esm/index.js

@@ -5311,6 +5311,12 @@ var EEvents;
     EEvents["MFA_DISABLE_FLOW"] = "MFA.Disable.Flow.Started";
     EEvents["MFA_ENABLED"] = "MFA.Enabled";
     EEvents["MFA_DISABLED"] = "MFA.Disabled";
+    EEvents["POPUP_CREATED"] = "Popup.Created";
+    EEvents["POPUP_UPDATED"] = "Popup.Updated";
+    EEvents["POPUP_DELETED"] = "Popup.Deleted";
+    EEvents["POPUP_ENABLED"] = "Popup.Enabled";
+    EEvents["POPUP_DISABLED"] = "Popup.Disabled";
+    EEvents["POPUP_PUBLISHED"] = "Popup.Published";
 })(EEvents || (EEvents = {}));
 function eventCondition(type, disabledEvents) {
     if (disabledEvents === void 0) { disabledEvents = []; }

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

@@ -0,0 +1,35 @@
+import { TDeleteApiResource } from "../../types";
+import { EPopupBranding, EPopupDisplayFrequency, TPopupContent, TPopupModel, TPopupTargeting, TPopupTrigger, TPopupUser } from "./types";
+export declare class ListPopupModel {
+    id: string;
+    readonly account_id: number;
+    name: string | null;
+    description: string | null;
+    enabled: boolean;
+    readonly created_on: number;
+    updated_on: number;
+    published_on: number | null;
+    branding: EPopupBranding;
+    tags: string[] | null;
+    edited_by: TPopupUser;
+    content: Omit<TPopupContent, "json">;
+    trigger: TPopupTrigger;
+    targeting: TPopupTargeting;
+    display_frequency: EPopupDisplayFrequency;
+    published_content_url: string | null;
+    thumbnail_url: string;
+    constructor(params: TPopupModel);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+    delete(): Promise<TDeleteApiResource>;
+    save({ ...popup }: Partial<TPopupModel>): Promise<PopupModel>;
+    enable(): Promise<PopupModel>;
+    disable(): Promise<PopupModel>;
+    publish(): Promise<PopupModel>;
+    render(): Promise<string>;
+}
+export declare class PopupModel extends ListPopupModel {
+    content: TPopupContent;
+    constructor(params: TPopupModel);
+    toJson(): any;
+}

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

@@ -0,0 +1,94 @@
+export type TPopupModel = {
+    id: string;
+    account_id: number;
+    name: string | null;
+    description: string | null;
+    enabled: boolean;
+    created_on: number;
+    updated_on: number;
+    published_on: number | null;
+    branding: EPopupBranding;
+    tags: string[] | null;
+    edited_by: TPopupUser;
+    content: TPopupContent;
+    trigger: TPopupTrigger;
+    targeting: TPopupTargeting;
+    display_frequency: EPopupDisplayFrequency;
+    published_content_url: string | null;
+    thumbnail_url: string;
+};
+export type TPopupUser = {
+    id: string;
+    email: string;
+};
+export type TPopupTrigger = {
+    type: EPopupTriggerType;
+    delay_seconds: number | null;
+    scroll_percentage: number | null;
+    selector: string | null;
+    start_date: number | null;
+    end_date: number | null;
+};
+export type TPopupTargeting = {
+    pages: string[] | null;
+    exclude_pages: string[] | null;
+    devices: EPopupDeviceType[] | null;
+    browsers: EPopupBrowserType[] | null;
+    languages: string[] | null;
+    countries: string[] | null;
+    referrers: string[] | null;
+    utm_params: Record<string, string> | null;
+};
+export type TPopupContent = {
+    position: EPopupPosition | null;
+    json?: Record<string, any>;
+};
+export declare enum EPopupTriggerType {
+    on_page_load = "on_page_load",
+    on_exit_intent = "on_exit_intent",
+    on_scroll = "on_scroll",
+    on_time_delay = "on_time_delay",
+    on_click = "on_click"
+}
+export declare enum EPopupDisplayFrequency {
+    once_per_session = "once_per_session",
+    once_per_day = "once_per_day",
+    once_per_week = "once_per_week",
+    always = "always",
+    once = "once"
+}
+export declare enum EPopupDeviceType {
+    desktop = "desktop",
+    mobile = "mobile",
+    tablet = "tablet"
+}
+export declare enum EPopupBrowserType {
+    chrome = "chrome",
+    firefox = "firefox",
+    safari = "safari",
+    edge = "edge",
+    opera = "opera",
+    other = "other"
+}
+export declare enum EPopupPosition {
+    center = "classic-center",
+    top_right = "classic-top-right",
+    top_left = "classic-top-left",
+    top_center = "classic-top-center",
+    bottom_left = "classic-bottom-left",
+    bottom_center = "classic-bottom-center",
+    bottom_right = "classic-bottom-right",
+    drawer_left = "drawer-left",
+    drawer_right = "drawer-right",
+    drawer_top = "bar-top",
+    drawer_bottom = "bar-bottom"
+}
+export declare enum EPopupBranding {
+    smart = "smart",
+    basic = "basic"
+}
+export type TPopupFilters = {
+    name: string;
+    tags: string[];
+    enabled: string;
+};

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

@@ -0,0 +1,31 @@
+import { TPopupModel } from "../../models/popups/types";
+import { TGenericListParams, TGenericListReturn, TGenericReturn } from "../../types";
+import { TCreateApiResource, TDeleteApiResource, TDisableApiResource, TEnableApiResource, TRenderResponse, TUpdateApiResource } from "../../types/generic";
+export declare function listPopups({ ...options }: TGenericListParams & {
+    name?: string;
+    tags?: string[];
+    enabled?: boolean;
+}): Promise<TGenericListReturn<TPopupModel>>;
+export declare function createPopup({ ...popup }: Partial<TPopupModel>): Promise<TCreateApiResource<TPopupModel>>;
+export declare function getPopup({ id }: {
+    id: string;
+}): Promise<TGenericReturn<TPopupModel>>;
+export declare function deletePopup({ id }: {
+    id: string;
+}): Promise<TDeleteApiResource>;
+export declare function updatePopup({ id, ...popup }: {
+    id: string;
+    popup: Partial<TPopupModel>;
+}): Promise<TUpdateApiResource<TPopupModel>>;
+export declare function enablePopup({ id }: {
+    id: string;
+}): Promise<TEnableApiResource<TPopupModel>>;
+export declare function disablePopup({ id }: {
+    id: string;
+}): Promise<TDisableApiResource<TPopupModel>>;
+export declare function publishPopup({ id }: {
+    id: string;
+}): Promise<TUpdateApiResource<TPopupModel>>;
+export declare function renderPopup({ id }: {
+    id: string;
+}): Promise<TRenderResponse>;

package/dist/esm/types/generic.d.ts

@@ -112,6 +112,9 @@ export type TCreateApiResource<T> = {
     object: string;
     data: T;
 };
+export type TRenderResponse = {
+    data: string;
+};
 export type TActionApiResource = {
     id: number;
     object: string;

package/dist/esm/utils/posthog.d.ts

@@ -143,7 +143,13 @@ export declare enum EEvents {
     MFA_ACTIVATION_FLOW = "MFA.Activation.Flow.Started",
     MFA_DISABLE_FLOW = "MFA.Disable.Flow.Started",
     MFA_ENABLED = "MFA.Enabled",
-    MFA_DISABLED = "MFA.Disabled"
+    MFA_DISABLED = "MFA.Disabled",
+    POPUP_CREATED = "Popup.Created",
+    POPUP_UPDATED = "Popup.Updated",
+    POPUP_DELETED = "Popup.Deleted",
+    POPUP_ENABLED = "Popup.Enabled",
+    POPUP_DISABLED = "Popup.Disabled",
+    POPUP_PUBLISHED = "Popup.Published"
 }
 export declare function eventCondition(type: EEvents | string, disabledEvents?: string[]): boolean;
 export declare function trackEvent(type: EEvents | string, data?: any, dataParser?: (event: EEvents | string, data: any) => any, disabledEvents?: string[]): void;

package/package.json

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