jspdf-dynamo 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,370 @@
+import jsPDF from 'jspdf';
+
+interface ILogger {
+    debug: (message: string, ...args: any | null) => void;
+    error: (message: string, ...args: any | null) => void;
+    info: (message: string, ...args: any | null) => void;
+    trace: (message: string, ...args: any | null) => void;
+    warn: (message: string, ...args: any | null) => void;
+    logLevel?: (newLevel: string | number) => void;
+}
+
+type fontStyleType = "bold" | "italic" | "normal" | "bolditalic";
+type orientationType = "portrait" | "p" | "landscape" | "l";
+type uomType = "mm" | "in" | "pt";
+
+declare const pageSizes: {
+    ledger: {
+        width: number;
+        height: number;
+    };
+    legal: {
+        width: number;
+        height: number;
+    };
+    "junior-legal": {
+        width: number;
+        height: number;
+    };
+    letter: {
+        width: number;
+        height: number;
+    };
+    "government-letter": {
+        width: number;
+        height: number;
+    };
+    "credit-card": {
+        width: number;
+        height: number;
+    };
+    tabloid: {
+        width: number;
+        height: number;
+    };
+    a0: {
+        width: number;
+        height: number;
+    };
+    a1: {
+        width: number;
+        height: number;
+    };
+    a2: {
+        width: number;
+        height: number;
+    };
+    a3: {
+        width: number;
+        height: number;
+    };
+    a4: {
+        width: number;
+        height: number;
+    };
+    a5: {
+        width: number;
+        height: number;
+    };
+    a6: {
+        width: number;
+        height: number;
+    };
+    a7: {
+        width: number;
+        height: number;
+    };
+    a8: {
+        width: number;
+        height: number;
+    };
+    a9: {
+        width: number;
+        height: number;
+    };
+    a10: {
+        width: number;
+        height: number;
+    };
+    b0: {
+        width: number;
+        height: number;
+    };
+    b1: {
+        width: number;
+        height: number;
+    };
+    b2: {
+        width: number;
+        height: number;
+    };
+    b3: {
+        width: number;
+        height: number;
+    };
+    b4: {
+        width: number;
+        height: number;
+    };
+    b5: {
+        width: number;
+        height: number;
+    };
+    b6: {
+        width: number;
+        height: number;
+    };
+    b7: {
+        width: number;
+        height: number;
+    };
+    b8: {
+        width: number;
+        height: number;
+    };
+    b9: {
+        width: number;
+        height: number;
+    };
+    b10: {
+        width: number;
+        height: number;
+    };
+    c0: {
+        width: number;
+        height: number;
+    };
+    c1: {
+        width: number;
+        height: number;
+    };
+    c2: {
+        width: number;
+        height: number;
+    };
+    c3: {
+        width: number;
+        height: number;
+    };
+    c4: {
+        width: number;
+        height: number;
+    };
+    c5: {
+        width: number;
+        height: number;
+    };
+    c6: {
+        width: number;
+        height: number;
+    };
+    c7: {
+        width: number;
+        height: number;
+    };
+    c8: {
+        width: number;
+        height: number;
+    };
+    c9: {
+        width: number;
+        height: number;
+    };
+    c10: {
+        width: number;
+        height: number;
+    };
+    dl: {
+        width: number;
+        height: number;
+    };
+};
+type pageSizeType = keyof typeof pageSizes;
+
+interface IJsPdfOptions {
+    margins: {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
+    pageSize: pageSizeType;
+    orientation: "portrait" | "landscape" | "p" | "l";
+    unit: "mm" | "in" | "pt";
+}
+
+declare class JsPdfProcessor {
+    private _variables;
+    private _bookmarks;
+    private _images;
+    private _logger;
+    private _pdfDocument;
+    get PdfDocument(): jsPDF;
+    private _currentPageNumber;
+    get currentPageNumber(): number;
+    set currentPageNumber(value: number);
+    private _currentUom;
+    get currentUom(): uomType;
+    set currentUom(value: uomType);
+    private _fillColour;
+    get fillColour(): string;
+    private set fillColour(value);
+    private _fontHeight;
+    get fontHeight(): number;
+    private set fontHeight(value);
+    private _fontName;
+    get fontName(): string;
+    set fontName(value: string);
+    private _fontPointSize;
+    get fontPointSize(): number;
+    set fontPointSize(value: number);
+    private get lineHeightFactor();
+    private _fontStyle;
+    get fontStyle(): fontStyleType;
+    private set fontStyle(value);
+    private _lastError;
+    get lastError(): string;
+    set lastError(value: string);
+    private _lastImageAdded;
+    get lastImageAdded(): string;
+    private set lastImageAdded(value);
+    private _LastImageIndex;
+    get lastImageIndex(): number;
+    private set lastImageIndex(value);
+    private _lastResult;
+    get lastResult(): string;
+    set lastResult(value: string);
+    private _lineColour;
+    get lineColour(): string;
+    set lineColour(value: string);
+    private _lineWidth;
+    get lineWidth(): number;
+    set lineWidth(value: number);
+    private _logLevel;
+    private _pageHeight;
+    get pageHeight(): number;
+    private set pageHeight(value);
+    private _pageWidth;
+    get pageWidth(): number;
+    private set pageWidth(value);
+    private _pageOrientation;
+    get pageOrientation(): orientationType;
+    private set pageOrientation(value);
+    private _pageSize;
+    get pageSize(): string;
+    private set pageSize(value);
+    private _marginBottom;
+    private _marginBottomPt;
+    get marginBottom(): number;
+    set marginBottom(value: number);
+    private _marginTop;
+    private _marginTopPt;
+    get marginTop(): number;
+    set marginTop(value: number);
+    private _marginLeft;
+    private _marginLeftPt;
+    get marginLeft(): number;
+    set marginLeft(value: number);
+    private _marginRight;
+    private _marginRightPt;
+    get marginRight(): number;
+    set marginRight(value: number);
+    private _lastObjectHeight;
+    get lastObjectHeight(): number;
+    private set lastObjectHeight(value);
+    private _lastObjectWidth;
+    get lastObjectWidth(): number;
+    private set lastObjectWidth(value);
+    private _posnX;
+    get posnX(): number;
+    set posnX(value: number);
+    private _posnY;
+    get posnY(): number;
+    set posnY(value: number);
+    private _spaceHoz;
+    get spaceHoz(): number;
+    private set spaceHoz(value);
+    private _spaceVert;
+    get spaceVert(): number;
+    private set spaceVert(value);
+    private _textColour;
+    get textColour(): string;
+    private set textColour(value);
+    private get pageCount();
+    constructor(options: Partial<IJsPdfOptions>, logger: ILogger);
+    private logAndParseCommand;
+    addBookmark(input: string): void;
+    addPage(input?: string): void;
+    private calcPageDimensions;
+    addImageFromFile(input: string): void;
+    addImageFromUrl(input: string): Promise<void>;
+    private saveImage;
+    private getContentType;
+    checkPage(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
+    drawBox(input: string): void;
+    drawDebugGrid(input: string): void;
+    drawLine(input: string): void;
+    drawImage(input: string): void;
+    drawText(input: string): void;
+    private checkPosition;
+    drawTextBox(input: string): void;
+    drawTextWrapped(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
+    forEachPage(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
+    ifBlank(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
+    ifEq(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
+    ifNe(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
+    ifGt(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
+    ifNotBlank(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
+    incCurrentX(input: string): void;
+    incCurrentY(input: string): void;
+    incVar(input: string): void;
+    multVar(input: string): void;
+    savePdf(input: string): void;
+    selectPage(input: string): void;
+    private setCurrentFont;
+    setCurrentX(input: string): void;
+    setCurrentY(input: string): void;
+    setDocumentInfo(input: string): void;
+    setFillColour(input: string): void;
+    setFontName(input: string): void;
+    setFontSize(input: string): void;
+    setFontStyle(input: string): void;
+    setLineColour(input: string): void;
+    setLineWidth(input: string): void;
+    setLogLevel(input: string): void;
+    setMargin(input: string): void;
+    private setPageOrientation;
+    private setPageSize;
+    setSpaceHoz(input: string): void;
+    setSpaceVert(input: string): void;
+    setTextColour(input: string): void;
+    copyVar(input: string): void;
+    getVar(variableName: string): string;
+    setVar(input: string): void;
+    substitute(input: string): string;
+    writeLog(input: string): void;
+    private pixelsToUom;
+    private pointsToUom;
+    private uomToPoints;
+    private setFixedDec;
+}
+
+declare class JsPdfDynamo {
+    #private;
+    _processor: JsPdfProcessor;
+    constructor(options?: Partial<IJsPdfOptions>, logger?: ILogger | null);
+    toBlob(): Blob | null;
+    toBlobUrl(): string | null;
+    getVar(variableName: string): string | null;
+    private prepareNewPdf;
+    prepareWrappedString(input: string): string;
+    processCommands(commands: string[]): Promise<void>;
+    private processTemplate;
+    processDot(processor: JsPdfProcessor, currLine: string): Promise<void>;
+    processGroups(processor: JsPdfProcessor, input: string, log?: boolean): Promise<void>;
+    private processGroupsRepeat;
+    private includeFile;
+    private includeUri;
+}
+
+export { JsPdfDynamo };