customerio-gist-web/dist/types/types.d.ts

Build beautiful in-app flows with no code and deliver them instantly to your app. http://customer.io

export type GistEnv = 'prod' | 'dev' | 'local';
export type ColorScheme = 'default' | 'auto' | 'system';
export interface GistConfig {
    siteId: string;
    dataCenter?: string;
    env?: GistEnv;
    logging?: boolean;
    experiments?: boolean;
    useAnonymousSession?: boolean;
    isPreviewSession?: boolean;
    colorScheme?: ColorScheme;
}
export interface GistMessage {
    messageId: string;
    queueId?: string;
    instanceId?: string;
    overlay?: boolean;
    elementId?: string | null;
    tooltipPosition?: string;
    firstLoad?: boolean;
    shouldScale?: boolean;
    shouldResizeHeight?: boolean;
    renderStartTime?: number;
    currentRoute?: string;
    position?: string | null;
    savedStepName?: string | null;
    isDisplayChange?: boolean;
    displaySettings?: DisplaySettings;
    properties?: MessageProperties;
}
export interface DisplaySettings {
    displayType?: 'modal' | 'overlay' | 'inline' | 'tooltip';
    modalPosition?: string;
    overlayPosition?: string;
    elementSelector?: string;
    tooltipPosition?: string;
    tooltipArrowColor?: string;
    maxWidth?: number;
    overlayColor?: string;
    dismissOutsideClick?: boolean;
}
export interface StepDisplayConfig {
    stepName: string;
    displaySettings: DisplaySettings;
}
export interface MessageProperties {
    gist?: GistProperties;
    [key: string]: unknown;
}
export interface GistProperties {
    elementId?: string | null;
    position?: string | null;
    messageWidth?: number;
    overlayColor?: string;
    exitClick?: boolean;
    tooltipPosition?: string;
    tooltipArrowColor?: string;
    routeRuleWeb?: string;
    scale?: boolean;
    campaignId?: string | null;
    persistent?: boolean;
    [key: string]: unknown;
}
export interface TextStyle {
    fontSize: number;
    fontWeight: number;
    fontFamily: string;
    color: string;
    lineHeight: number;
}
export interface BoxShadow {
    color: string;
    offsetX: number;
    offsetY: number;
    blur: number;
}
export interface InboxFloatingIcon {
    background: string;
    color: string;
    svg: string;
}
export interface InboxUnreadIndicator {
    showAlert: boolean;
    text: TextStyle;
    background: string;
}
export interface InboxPattern {
    floatingIcon: InboxFloatingIcon;
    background: string;
    cornerRadius: number;
    borderColor: string;
    dividerColor: string;
    shadow: BoxShadow;
    position: string;
    hoverBackground: string;
    unreadIndicator: InboxUnreadIndicator;
}
export type DeepPartial<T> = {
    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
};
export interface Branding {
    theme: unknown;
    patterns: {
        inbox: InboxPattern;
        modes?: {
            dark?: {
                inbox?: DeepPartial<InboxPattern>;
            };
        };
    };
}
export interface ResolvedMessageProperties {
    isEmbedded: boolean;
    elementId: string;
    hasRouteRule: boolean;
    routeRule: string;
    position: string;
    hasPosition: boolean;
    tooltipPosition: string;
    hasTooltipPosition: boolean;
    tooltipArrowColor: string;
    shouldScale: boolean;
    campaignId: string | null;
    messageWidth: number;
    overlayColor: string;
    persistent: boolean;
    exitClick: boolean;
    hasCustomWidth: boolean;
}
export type InboxActionBehavior = 'openUrl' | 'dismiss' | 'openDeeplink' | 'performAction';
export interface InboxActionConfig {
    behavior: InboxActionBehavior;
    action?: string;
    name?: string;
    dismiss?: boolean;
    newTab?: boolean;
}