UNIwise/webviewer-html-proxy-server

Webviewer Html Proxy Server

This is a proxy server to use with HTML sample by PDFTron

Install

npm install @pdftron/webviewer-html-proxy-server

How to use

Call the createServer function in your server component and pass in an object that includes SERVER_ROOT and PORT. You can, optionally, pass in CORS_OPTIONS - an object to configure CORS, COOKIE_SETTING - an object to configure COOKIE and ALLOW_HTTP_PROXY, a boolean value to allow loading localhost files and for unsecured HTTP websites to be proxied.

See: https://expressjs.com/en/resources/middleware/cors.html and https://expressjs.com/en/api.html#res.cookie

Example

const HTMLProxyServer = require('@pdftron/webviewer-html-proxy-server');
HTMLProxyServer.createServer({
    SERVER_ROOT: `http://localhost`,
    PORT: 3100
});

Setting CORS_OPTIONS example:

HTMLProxyServer.createServer({
    SERVER_ROOT: `http://localhost`,
    PORT: 3100,
    CORS_OPTIONS: {
        "origin": "*",
        "methods": "GET,HEAD,PUT,PATCH,POST,DELETE",
        "preflightContinue": false,
        "optionsSuccessStatus": 204
    }
});

Setting COOKIE_SETTING example:

HTMLProxyServer.createServer({
    SERVER_ROOT: `http://localhost`,
    PORT: 3100,
    COOKIE_SETTING: {
        sameSite: 'none',
        secure: true
    }
});

Setting ALLOW_HTTP_PROXY example:

HTMLProxyServer.createServer({
    SERVER_ROOT: `http://localhost`,
    PORT: 3100,
    ALLOW_HTTP_PROXY: true
});

API Endpoints

Proxy a URL

URL : /pdftron-proxy?url=

Query Parameters : url=[string] where url is a publicly accessible link.

Method : GET

Success Response

Condition : If the URL can be successfuly proxied

Code : 200 OK

Content example

{
    "validUrl": "https://www.pdftron.com/"
}

Error Responses

Condition : If URL can not be proxied.

Code : 400

Content : { errorMessage: 'Please enter a valid URL and try again.' }

Download a PDF

URL : /pdftron-download?url=

Query Parameters : url=[string] where url is a publicly accessible link.

Method : GET

Success Response

Condition : If URL can be loaded in puppeteer.

Code : 200 OK

Content example

{
    "buffer": "<some image buffer>",
    "pageDimensions": { "width": 1440, "height": 770 }
}

Error Responses

Condition : If URL can not be loaded in puppeteer.

Code : 400

Content : { errorMessage: 'Error taking screenshot from puppeteer' }