index.d.ts

// Type definitions for mailgen 2.0
// Definitions by: Kiet Thanh Vo <https://github.com/vothanhkiet>, Jordan Farrer <https://github.com/jordanfarrer>, Grzegorz Kawka-Osik <https://github.com/grzegorzkawkaosik>
import Option = Mailgen.Option;
import Content = Mailgen.Content;
/**
 * Created by kiettv on 7/24/16.
 */
declare class Mailgen {
    constructor(opts: Option);

    cacheThemes(): void;

    generate(params: Content): any;

    generatePlaintext(params: Content): any;

    parseParams(params: any): any;
}

declare namespace Mailgen {
    interface Option {
        theme: string | CustomTheme;
        product: Product;
        /**
         * To change the default text direction
         * @default ltr
         */
        textDirection?: 'ltr' | 'rtl' | string;
    }

    interface CustomTheme {
        path: string;
        plaintextPath?: string;
    }

    interface Product {
        name: string;
        link: string;
        logo?: string;
        logoHeight?: string;
        copyright?: string;
    }

    interface Content {
        body: ContentBody;
    }

    interface ContentBody {
        name?: string;
        greeting?: string | boolean;
        signature?: string | boolean;
        title?: string;
        intro?: string | string[];
        action?: Action | Action[];
        table?: Table | Table[];
        dictionary?: any;
        goToAction?: GoToAction;
        outro?: string | string[];
    }

    interface Table {
        title?: string,
        data: any[];
        columns?: ColumnOptions;
    }

    interface ColumnOptions {
        customWidth?: Record<string, string>;
        customAlignment?: Record<string, string>;
    }

    interface GoToAction {
        text: string;
        link: string;
        description: string;
    }

    interface Action {
        instructions: string;
        button: Button;
    }

    interface Button {
        color?: string;
        fallback?: boolean | Fallback;
        text: string;
        link: string;
    }

    interface Fallback {
      text?: string;
    }
}

export = Mailgen;