// tslint:disable:jsdoc-format
// tslint:disable:max-line-length
// tslint:disable:no-irregular-whitespace

/*!
* Product: Dynamsoft Web Twain
* Web Site: http://www.dynamsoft.com
*
* Copyright 2019, Dynamsoft Corporation
* Author: Dynamsoft Support Team
*/

declare enum EnumDWT_ConvertMode {
    CM_DEFAULT = 0,
    CM_RENDERALL = 1
}

declare enum EnumDWT_ConverMode {
    CM_DEFAULT = 0,
    CM_RENDERALL = 1
}

/**
 * @class
 */
interface PDF {
    /**
     * Download and install pdf rasterizer add-on on the local system.

     * [Deprecated] Starting in v14.2, the PDF module is installed with Dynamsoft Service.
     * @method Dynamsoft.WebTwain.Addon.PDF#Download

     * @param {string} remoteFile specifies the value of which frame to get.
     * @param {function} optionalAsyncSuccessFunc optional.
     * The function to call when the download succeeds. Please refer to the function prototype OnSuccess.
     * @param {function} optionalAsyncFailureFunc optional.
     * The function to call when the download fails. Please refer to the function prototype OnFailure.
     * @return {boolean}
     */
    Download(remoteFile: string,
        optionalAsyncSuccessFunc?: () => void,
        optionalAsyncFailureFunc?: (errorCode: number, errorString: string) => void): boolean;

    /**
     *  Input the password to decrypt PDF files using PDF Rasterizer add-on.
     * @method Dynamsoft.WebTwain#SetPassword
     * @param {string} password Specifies the PDF password.
     * @return {boolean}
     */
    SetPassword(password: string): boolean;

    /**
     *  Set the image convert mode for PDF Rasterizer in Dynamic Web TWAIN.
     * @method Dynamsoft.WebTwain#SetConvertMode
     * @param {EnumDWT_ConvertMode | EnumDWT_ConverMode} convertMode Specifies the image convert mode.
     * @return {boolean}
     */
    SetConvertMode(convertMode: EnumDWT_ConvertMode | EnumDWT_ConverMode): boolean;

    /**
     *  Set the output resolution for the PDF Rasterizer in Dynamic Web TWAIN.
     * @method Dynamsoft.WebTwain#ReadRect
     * @param {float} fResolution Specifies the resolution for convert image from PDF file.
     * @return {boolean}
     */
    SetResolution(fResolution: number): boolean;

    /**
     * Judges whether the local PDF is text-based or not.
     * @method Dynamsoft.WebTwain#ReadRect
     * @param {string} localFile specifies the local path of the target PDF.
     * @return {boolean}
     */
    IsTextBasedPDF(localFile: string): boolean;

    Write: PDFWrite;
}

interface PDFWrite {
    /**
     * Configures how the PDF generating is done
     * @method Dynamsoft.WebTwain.Addon.PDF.Write#jsonWriteSetting
     * @param {any} jsonWriteSetting detailed settings for PDF writing.
     * @return {boolean}
     */
    Setup(jsonWriteSetting: any): void;
}

interface DynamsoftWebTwainAddon {
    PDF: PDF;
}