vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-12 13:00:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

pdfmake - update v0.1.65 (#42814)

Browse Source 
* add missing types and tests

* lint

* Remove enums from module

* spaces not tabs

* tslint indent rule

* update pdfmake version

* Remove minor version
This commit is contained in:
Andrew Casey
2020-03-05 10:54:36 -08:00
committed by GitHub
parent ae7eb3a2db
commit 9e887e9e2a
3 changed files with 212 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/pdfmake/index.d.ts
Vendored
+72 -59
View File
@@ -4,6 +4,7 @@
// Rajab Shakirov <https://github.com/radziksh>
// Enzo Volkmann <https://github.com/evolkmann>
// Andi Pätzold <https://github.com/andipaetzold>
// Neal Mummau <https://github.com/nmummau>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0
@@ -26,61 +27,25 @@ declare module "pdfmake/build/pdfmake" {
vfs?: any
): TCreatedPdf;
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 PageSize =
"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"|
"RA1"|"RA2"|"RA3"|"RA4"|
"SRA1"|"SRA2"|"SRA3"|"SRA4"|
"EXECUTIVE"|"FOLIO"|"LEGAL"|"LETTER"|"TABLOID";
enum PageOrientation {
PORTRAIT = "PORTRAIT",
LANDSCAPE = "LANDSCAPE"
}
type PageOrientation = "portrait" | "landscape";
type Layout = "noBorders" | "headerLineOnly" | "lightHorizontalLines";
type Alignment = "left" | "center" | "right";
type Decoration = "underline" | "lineThrough" | "overline";
type DecorationStyle = "dashed" | "dotted" | "double" | "wavy";
type PageBreak = "before" | "after";
let pdfMake: pdfMakeStatic;
@@ -96,9 +61,13 @@ declare module "pdfmake/build/pdfmake" {
}
interface TDocumentInformation {
/** the title of the document */
title?: string;
/** the name of the author */
author?: string;
/** the subject of the document */
subject?: string;
/** keywords associated with the document */
keywords?: string;
}
@@ -110,25 +79,39 @@ declare module "pdfmake/build/pdfmake" {
type Margins = number | [number, number] | [number, number, number, number];
type Alignment = "left" | "right" | "justify" | "center" | string;
interface Style {
/** name of the font */
font?: any;
/** size of the font in pt */
fontSize?: number;
fontFeatures?: any;
/** whether to use bold text (default: false) */
bold?: boolean;
/** whether to use italic text (default: false) */
italics?: boolean;
/** the alignment of the text */
alignment?: Alignment;
/** the color of the text (color name e.g., ‘blue’ or hexadecimal color e.g., ‘#ff5500’) */
color?: string;
/** optional space between columns */
columnGap?: any;
/** the background color of a table cell */
fillColor?: string;
decoration?: any;
decorationany?: any;
/** the background opacity of a table cell */
fillOpacity?: string;
/** the text decoration to applu (‘underline’ or ‘lineThrough’ or ‘overline’) */
decoration?: Decoration;
/** (‘dashed’ or ‘dotted’ or ‘double’ or ‘wavy’) */
decorationStyle?: DecorationStyle;
/** the color of the text decoration, see color */
decorationColor?: string;
/** the background color of the text */
background?: any;
/** the line height (default: 1) */
lineHeight?: number;
characterSpacing?: number;
noWrap?: boolean;
/** the color of the bullets in a buletted list */
markerColor?: string;
leadingIndent?: any;
[additionalProperty: string]: any;
@@ -166,23 +149,35 @@ declare module "pdfmake/build/pdfmake" {
}
interface Content {
layout?: Layout;
style?: string | string[];
margin?: Margins;
text?: string | string[] | Content[];
columns?: Content[];
stack?: Content[];
image?: string;
svg?: string;
width?: string | number;
height?: string | number;
fit?: [number, number];
pageBreak?: "before" | "after";
pageBreak?: PageBreak;
alignment?: Alignment;
table?: Table;
/** to treat a paragraph as a bulleted list, set an array of items under the ul key */
ul?: Content[];
/** for numbered lists set the ol key */
ol?: Content[];
qr?: string;
toc?: TableOfContent;
tocItem?: boolean | string | string[];
[additionalProperty: string]: any;
}
interface TableOfContent {
id?: string;
title: Content;
}
interface TDocumentDefinitions {
background?: string | ((currentPage: number, pageSize: PageSize) => string | Content | null);
compress?: boolean;
@@ -202,6 +197,7 @@ declare module "pdfmake/build/pdfmake" {
pageOrientation?: PageOrientation;
pageSize?: PageSize | { width: number; height: number };
styles?: Style;
watermark?: Watermark;
}
interface CurrentNode {
@@ -277,4 +273,21 @@ declare module "pdfmake/build/pdfmake" {
fonts: { [name: string]: TFontFamilyTypes };
createPdf(documentDefinitions: TDocumentDefinitions): TCreatedPdf;
}
interface Watermark {
/** watermark text */
text?: string;
/** color of text */
color?: string;
/** opacity of text */
opacity?: number;
/** bold style of text */
bold?: boolean;
/** italics style of text */
italics?: true;
/** own font size of text (ideal size is calculated automatically) (minimal version: 0.1.60) */
fontSize?: number;
/** angle of text rotation (minimal version: 0.1.60) */
angle?: number;
}
}
types/pdfmake/pdfmake-tests.ts
+139 -8
View File
@@ -1,7 +1,7 @@
import * as pdfMake from 'pdfmake/build/pdfmake';
import * as pdfFonts from 'pdfmake/build/vfs_fonts';
const definitions = [
const definitions: pdfMake.TDocumentDefinitions[] = [
{
content: [
'First paragraph',
@@ -1320,15 +1320,146 @@ const definitions = [
{
compress: false,
content: ['This document does not use compression']
},
// Table of Contents tests
{
content: [
{
toc: {
title: {text: 'INDEX', style: 'header'}
}
}
]
},
{
content: [
{
toc: {
id: 'mainToc',
title: {text: 'INDEX', style: 'header'}
}
},
{
text: 'This is a header',
style: 'header',
tocItem: true,
},
{
text: 'This is a header',
style: 'header',
tocItem: 'mainToc' // if is used id in toc
},
{
text: 'This is a header',
style: 'header',
tocItem: ['mainToc', 'subToc'] // for multiple tocs
}
]
},
// Watermark tests
{
content: "Watermark content",
watermark: {
text: "Test Environment",
color: "red",
opacity: 0.3,
bold: true,
italics: true,
fontSize: 20,
angle: 70
}
}
];
const createPdf = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
const downloadPdf = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
for (const definition of definitions) {
const typedDefinition: pdfMake.TDocumentDefinitions = definition;
pdfMake.createPdf(typedDefinition).download();
}
for (const def of definitions) {
pdfMake.createPdf(def).download();
}
};
const openPdf = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
for (const def of definitions) {
pdfMake.createPdf(def).open();
}
};
const openPdfInSameWindow = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
for (const def of definitions) {
pdfMake.createPdf(def).open({}, window);
}
};
const printPdf = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
for (const def of definitions) {
pdfMake.createPdf(def).print();
}
};
const printPdfInSameWindow = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
for (const def of definitions) {
pdfMake.createPdf(def).print({}, window);
}
};
const pdfAsBaseSixtyFourData = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
for (const def of definitions) {
const pdfDocGenerator = pdfMake.createPdf(def);
pdfDocGenerator.getBase64((data) => {
alert(data);
});
}
};
const pdfAsBuffer = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
for (const def of definitions) {
const pdfDocGenerator = pdfMake.createPdf(def);
pdfDocGenerator.getBuffer((buffer) => {
// ...
});
}
};
const pdfAsBlob = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
for (const def of definitions) {
const pdfDocGenerator = pdfMake.createPdf(def);
pdfDocGenerator.getBlob((blob) => {
// ...
});
}
};
const getPdfKitDocumentObject = () => {
const pdf = pdfMake;
pdf.vfs = pdfFonts.pdfMake.vfs;
for (const def of definitions) {
const pdfDocGenerator = pdfMake.createPdf(def);
pdfDocGenerator.getStream((gs) => {
// ...
});
}
};
types/pdfmake/tslint.json
+1
View File
@@ -1,6 +1,7 @@
{
"extends": "dtslint/dt.json",
"rules": {
"indent": [true, "spaces", 4],
"no-declare-current-package": false
}
}