ilovepdf / ilovepdf-js

iLovePDF Api - JS Library

JavaScript library for iLovePDF Api

You can sign up for a iLovePDF account at https://developer.ilovepdf.com .

Develop and automate PDF processing tasks like Compress PDF, Merge PDF, Split PDF, convert Office to PDF, PDF to JPG, Images to PDF, add Page Numbers, Rotate PDF, Unlock PDF, stamp a Watermark and Repair PDF. Each one with several settings to get your desired results.

Requirements

Requirements to use this library are:

1. NPM - Package built with version @6.14.5 .
2. NodeJS - Package built with version @12.18.2 .

You cand download them here.

Install

You can install the library via NPM. Run the following command:

npm install @ilovepdf/ilovepdf-js

Also, if you are working with old browsers that don't have support for Promise objects, we recomend install the dependency promise-polyfill:

npm install promise-polyfill

Remember that this package needs to be imported somewhere in your project or this polyfill won't be applied.

Getting Started

Using public URLs

import ILovePDFApi from '@ilovepdf/ilovepdf-js';

const instance = new ILovePDFApi('<PUBLIC_KEY>');

// Public and secret key can be found in your developer panel
// at https://developer.ilovepdf.com/user/projects .
const task = instance.newTask('merge');

// Promise-based way to use ILovePDFApi.
task.start()
.then(() => {
    return task.addFile('<PDF_URL1>');
})
.then(() => {
    return task.addFile('<PDF_URL2>');
})
.then(() => {
    return task.process();
})
.then(() => {
    return task.download();
})
.then((data) => {
    console.log('DONE');
});

Using ILovePDFFile class

import ILovePDFApi from '@ilovepdf/ilovepdf-js';
import ILovePDFFile from '@ilovepdf/ilovepdf-js/ILovePDFFile';

const instance = new ILovePDFApi('<PUBLIC_KEY>');

const task = instance.newTask('merge');

task.start()
.then(() => {
    const inputElement = document.getElementById('file-element');
    const file = new ILovePDFFile(inputElement.files![0]);

    return task.addFile(file);
})
.then(() => {
    return task.addFile('<PDF_URL2>');
})
.then(() => {
    return task.process();
})
.then(() => {
    return task.download();
})
.then((data) => {
    console.log('DONE');
});

Use sync calls

Thanks to be a promise-based API it is possible use the await JavaScript operator in order to call Task methods. Here you have an example:

let task = instance.newTask('merge');
task = await task.start();
task = await task.addFile('<PDF_URL1>');
task = await task.addFile('<PDF_URL2>');
task = await task.process();

const data = await task.download();

Get PDF information

On upload a file from an <input type="input"> or URL, you will have access to some PDF information:

import ILovePDFApi from '@ilovepdf/ilovepdf-js';
import ILovePDFFile from '@ilovepdf/ilovepdf-js/ILovePDFFile';

const instance = new ILovePDFApi('<PUBLIC_KEY>');

const task = instance.newTask('merge');

task.start()
.then(() => {
    // File from browser input element.
    const inputElement = document.getElementById('file-element');
    const file = new ILovePDFFile(inputElement.files![0]);

    return task.addFile(file);
})
.then(file1 => {
    // Access to PDF information.
    // file1.pageNumber
    // file1.pageSizes

    // File from URL.
    return task.addFile('<PDF_URL2>');
})
.then(file2 => {
    // Access to PDF information.
    // file2.pageNumber
    // file2.pageSizes
});

Get remaining files

Due to this library is limited by number of uses, you can access to the account remaining files:

const task = instance.newTask('merge');
await task.start();
// After start a task, you can access to the remaining files quantity.
// Before, it's `undefined`.
console.log( task.remainingFiles )

Documentation

Please see https://developer.ilovepdf.com/docs for up-to-date documentation.

ilovepdf-js's Issues

Cannot import IlovePdfJS in browser

On a VueJS 2 project, I try to compress a pdf file before sending it to the server, but I cannot find a way to import without getting an error.

Whenever I try to import it I got the error:

TypeError: Object prototype may only be an Object or null.

I tried to import it the traditionnal way, using:

import ILovePDFApi from '@ilovepdf/ilovepdf-js';
import ILovePDFFile from "@ilovepdf/ilovepdf-js/ILovePDFFile";

but it prevented my vue component to be loaded.

So I try to import it another way:

const iLovePdf = await import('@ilovepdf/ilovepdf-js').then((res) => {
      console.log(res);
      return res.default;
});
const ILoveFile = await import('@ilovepdf/ilovepdf-js/ILovePDFFile').then((res) => {
      console.log(res);
      return res.default;
});

this time my component is mounted, but when I call the code that does the asynchronous import I got the same error.

I'm using node v18.12.0 along with npm 8.19.2.

Any idea on how to make the library works in my browser ? what I could be doing wrong ?

Can I somehow get how many credits I have left on ilovepdf api?

I have a small code to use the api, but i would like to redirect the petitions if we dont have more credits of the api. I'm using it to compres pdfs, and it would be good, that if i cannot compres any more files, simply dont compres it.

` private async getClient() {
const iLovePDFApi: any = await import('@ilovepdf/ilovepdf-nodejs');
return new iLovePDFApi(this.API_KEY, this.API_SECRET);
}

public async compress(file: Buffer): Promise {
const ILovePDFFile: any = await import(
'@ilovepdf/ilovepdf-nodejs/ILovePDFFile'
);
const client = await this.getClient(); //Get how many credits from client
const task = client.newTask('compress');
await task.start();
const dirName = Date.now().toString();
const filePath = await this.saveTmpFile(dirName, file);
const uploadedFile = new ILovePDFFile(filePath);
await task.addFile(uploadedFile);
await task.process();
const compressed = await task.download();
await this.removeTmpFile(dirName);
return Buffer.from(compressed);
}`