Merge pull request #29838 from evolkmann/feature/pdfmake-types

Added detailed type definitions for bpampuch/pdfmake

types/pdfmake/index.d.ts

@@ -2,7 +2,9 @@
 // Project: http://pdfmake.org
 // Definitions by: Milen Stefanov <https://github.com/m1llen1um>
 //                 Rajab Shakirov <https://github.com/radziksh>
+//                 Enzo Volkmann <https://github.com/evolkmann>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.4
 
 declare module 'pdfmake/build/vfs_fonts' {
     let pdfMake: {
@@ -16,15 +18,61 @@ declare module 'pdfmake/build/pdfmake' {
     let fonts: { [name: string]: TFontFamilyTypes };
     function createPdf(documentDefinitions: TDocumentDefinitions): TCreatedPdf;
 
-    type pageSizeType =
-        '4A0' | '2A0' | 'A0' | 'A1' | 'A2' | 'A3' | 'A4' | 'A5' | 'A6' | 'A7' | 'A8' | 'A9' | 'A10' |
-        'B0' | 'B1' | 'B2' | 'B3' | 'B4' | 'B5' | 'B6' | 'B7' | 'B8' | 'B9' | 'B10' |
-        'C0' | 'C1' | 'C2' | 'C3' | 'C4' | 'C5' | 'C6' | 'C7' | 'C8' | 'C9' | 'C10' |
-        'RA0' | 'RA1' | 'RA2' | 'RA3' | 'RA4' |
-        'SRA0' | 'SRA1' | 'SRA2' | 'SRA3' | 'SRA4' |
-        'EXECUTIVE' | 'FOLIO' | 'LEGAL' | 'LETTER' | 'TABLOID';
+    enum PageSize {
+        A0_x_4 = '4A0',
+        A0_x_2 = '2A0',
+        AO = 'A0',
+        A1 = 'A1',
+        A2 = 'A2',
+        A3 = 'A3',
+        A4 = 'A4',
+        A5 = 'A5',
+        A6 = 'A6',
+        A7 = 'A7',
+        A8 = 'A8',
+        A9 = 'A9',
+        A1O = 'A10',
+        BO = 'B0',
+        B1 = 'B1',
+        B2 = 'B2',
+        B3 = 'B3',
+        B4 = 'B4',
+        B5 = 'B5',
+        B6 = 'B6',
+        B7 = 'B7',
+        B8 = 'B8',
+        B9 = 'B9',
+        B1O = 'B10',
+        CO = 'C0',
+        C1 = 'C1',
+        C2 = 'C2',
+        C3 = 'C3',
+        C4 = 'C4',
+        C5 = 'C5',
+        C6 = 'C6',
+        C7 = 'C7',
+        C8 = 'C8',
+        C9 = 'C9',
+        C1O = 'C10',
+        RA1 = 'RA1',
+        RA2 = 'RA2',
+        RA3 = 'RA3',
+        RA4 = 'RA4',
+        SRA1 = 'SRA1',
+        SRA2 = 'SRA2',
+        SRA3 = 'SRA3',
+        SRA4 = 'SRA4',
+        EXECUTIVE = 'EXECUTIVE',
+        FOLIO = 'FOLIO',
+        LEGAL = 'LEGAL',
+        LETTER = 'LETTER',
+        TABLOID = 'TABLOID'
+    }
 
-    type pageOrientationType = "portrait" | "landscape";
+    enum PageOrientation {
+        PORTRAIT = 'PORTRAIT',
+        LANDSCAPE = 'LANDSCAPE'
+    }
 
     let pdfMake: pdfMakeStatic;
 
@@ -48,18 +96,90 @@ declare module 'pdfmake/build/pdfmake' {
 
     type TDocumentHeaderFooterFunction = (currentPage: number, pageCount: number) => any;
 
+    type Margins = number | [number, number] | [number, number, number, number];
+
+    type Alignment = 'left' | 'right' | 'justify' | 'center' | string;
+
+    interface Style {
+        font?: any;
+		fontSize?: number;
+		fontFeatures?: any;
+		bold?: boolean;
+		italics?: boolean;
+		alignment?: Alignment;
+		color?: string;
+		columnGap?: any;
+		fillColor?: string;
+		decoration?: any;
+		decorationany?: any;
+		decorationColor?: string;
+		background?: any;
+		lineHeight?: number;
+		characterSpacing?: number;
+		noWrap?: boolean;
+		markerColor?: string;
+        leadingIndent?: any;
+        [additionalProperty: string]: any;
+    }
+
+    type TableRowFunction = (row: number) => number;
+
+    interface TableLayoutFunctions {
+        hLineWidth?: (i: number, node: any) => number;
+        vLineWidth?: (i: number, node: any) => number;
+        hLineColor?: (i: number, node: any) => string;
+        vLineColor?: (i: number, node: any) => string;
+        fillColor?: (i: number, node: any) => string;
+        paddingLeft?: (i: number, node: any) => number;
+        paddingRight?: (i: number, node: any) => number;
+        paddingTop?: (i: number, node: any) => number;
+        paddingBottom?: (i: number, node: any) => number;
+    }
+
+    interface TableCell {
+        text: string;
+        rowSpan?: number;
+        colSpan?: number;
+        fillColor?: string;
+        border?: [boolean, boolean, boolean, boolean];
+    }
+
+    interface Table {
+        widths?: Array<(string | number)>;
+        heights?: Array<(string | number)> | TableRowFunction;
+        headerRows?: number;
+        body: Content[][] | TableCell[][];
+        layout?: string | TableLayoutFunctions;
+    }
+
+    interface Content {
+        style?: 'string';
+        margin?: Margins;
+        text?: string | string[] | Content[];
+        columns?: Content[];
+        stack?: Content[];
+        image?: string;
+        width?: string | number;
+        height?: string | number;
+        fit?: [number, number];
+        pageBreak?: 'before' | 'after';
+        alignment?: Alignment;
+        table?: Table;
+        ul?: Content[];
+        ol?: Content[];
+        [additionalProperty: string]: any;
+    }
+
     interface TDocumentDefinitions {
         info?: TDocumentInformation;
-        header?: any;
-        footer?: any;
-        content: any;
-        styles?: any;
-        pageSize?: pageSizeType;
-        pageOrientation?: pageOrientationType;
-        pageMargins?: [number, number, number, number];
-        defaultStyle?: {
-            font?: string;
-        };
+        header?: TDocumentHeaderFooterFunction;
+        footer?: TDocumentHeaderFooterFunction;
+        content: string | Content;
+        styles?: Style;
+        pageSize?: PageSize;
+        pageOrientation?: PageOrientation;
+        pageMargins?: Margins;
+        defaultStyle?: Style;
     }
 
     type CreatedPdfParams = (