From c8956a3f912af2dc05b7dd155569ed1eee48d63c Mon Sep 17 00:00:00 2001 From: Laurynas Butkus Date: Sat, 14 Sep 2024 10:43:02 +0300 Subject: [PATCH] Switch to authorization header --- README.md | 10 +++++----- examples/alternative_converter.js | 2 +- examples/conversion_chaining.js | 2 +- examples/convert_base64_content.js | 2 +- examples/convert_stream.js | 2 +- examples/convert_url_to_pdf.js | 2 +- examples/convert_word_to_pdf_and_png.js | 2 +- examples/create_pdf_thumbnail.js | 2 +- examples/get_result_file_stream.js | 2 +- examples/retrieve_user_information.js | 2 +- examples/split_and_merge_pdf.js | 2 +- index.d.ts | 2 +- src/client.js | 3 ++- src/index.js | 6 +++--- test/index.js | 6 +++--- 15 files changed, 24 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index f91755a..6e6df00 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,12 @@ npm install convertapi --save ## Usage -The package needs to be configured with your account's secret key which is available at https://www.convertapi.com/a +The package needs to be configured with your account's secret key or token which is available at https://www.convertapi.com/a Require it with the key's value: ```javascript -var convertapi = require('convertapi')('your-api-secret'); +var convertapi = require('convertapi')('your-api-secret-or-token'); ``` Or using ES modules: @@ -29,13 +29,13 @@ Or using ES modules: ```javascript import ConvertAPI from 'convertapi'; -const convertapi = new ConvertAPI('your-api-secret'); +const convertapi = new ConvertAPI('your-api-secret-or-token'); ``` You can specify additional options, like proxy configuration and timeouts, when initializing the client: ```javascript -var convertapi = require('convertapi')('your-api-secret', { +var convertapi = require('convertapi')('your-api-secret-or-token', { conversionTimeout: 60, uploadTimeout: 60, downloadTimeout: 60, @@ -54,7 +54,7 @@ var convertapi = require('convertapi')('your-api-secret', { If using ES module: ```javascript -const convertapi = new ConvertAPI('your-api-secret', { conversionTimeout: 60 }); +const convertapi = new ConvertAPI('your-api-secret-or-token', { conversionTimeout: 60 }); ``` ### File conversion diff --git a/examples/alternative_converter.js b/examples/alternative_converter.js index c03d1fc..1225525 100644 --- a/examples/alternative_converter.js +++ b/examples/alternative_converter.js @@ -1,6 +1,6 @@ /* eslint-disable no-console */ -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Example of saving Word docx to PDF using OpenOffice converter diff --git a/examples/conversion_chaining.js b/examples/conversion_chaining.js index ca8ce0c..44d8845 100644 --- a/examples/conversion_chaining.js +++ b/examples/conversion_chaining.js @@ -1,6 +1,6 @@ /* eslint-disable no-console */ -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Short example of conversions chaining, the PDF pages extracted and saved as separated JPGs and then ZIP'ed diff --git a/examples/convert_base64_content.js b/examples/convert_base64_content.js index be4a899..7b440af 100644 --- a/examples/convert_base64_content.js +++ b/examples/convert_base64_content.js @@ -1,6 +1,6 @@ /* eslint-disable no-console */ -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Example of using buffer and stream to convert base64 encoded content to pdf diff --git a/examples/convert_stream.js b/examples/convert_stream.js index a27141e..f86c008 100644 --- a/examples/convert_stream.js +++ b/examples/convert_stream.js @@ -2,7 +2,7 @@ var fs = require('fs'); -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Example of using readable stream to convert to pdf diff --git a/examples/convert_url_to_pdf.js b/examples/convert_url_to_pdf.js index 9a303a3..2a77c78 100644 --- a/examples/convert_url_to_pdf.js +++ b/examples/convert_url_to_pdf.js @@ -1,6 +1,6 @@ /* eslint-disable no-console */ -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Example of converting Web Page URL to PDF file diff --git a/examples/convert_word_to_pdf_and_png.js b/examples/convert_word_to_pdf_and_png.js index 15eba76..3f70354 100644 --- a/examples/convert_word_to_pdf_and_png.js +++ b/examples/convert_word_to_pdf_and_png.js @@ -1,6 +1,6 @@ /* eslint-disable no-console */ -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Example of saving Word docx to PDF and to PNG diff --git a/examples/create_pdf_thumbnail.js b/examples/create_pdf_thumbnail.js index adcbf75..16aa46e 100644 --- a/examples/create_pdf_thumbnail.js +++ b/examples/create_pdf_thumbnail.js @@ -1,6 +1,6 @@ /* eslint-disable no-console */ -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Example of extracting first page from PDF and then chaining conversion PDF page to JPG. diff --git a/examples/get_result_file_stream.js b/examples/get_result_file_stream.js index 3892b7f..eb32581 100644 --- a/examples/get_result_file_stream.js +++ b/examples/get_result_file_stream.js @@ -1,6 +1,6 @@ /* eslint-disable no-console */ -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Example of converting Web Page URL to PDF and reading file data as string diff --git a/examples/retrieve_user_information.js b/examples/retrieve_user_information.js index 8eba637..8336179 100644 --- a/examples/retrieve_user_information.js +++ b/examples/retrieve_user_information.js @@ -1,6 +1,6 @@ /* eslint-disable no-console */ -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Retrieve user information diff --git a/examples/split_and_merge_pdf.js b/examples/split_and_merge_pdf.js index 9c2ba9b..755cbff 100644 --- a/examples/split_and_merge_pdf.js +++ b/examples/split_and_merge_pdf.js @@ -1,6 +1,6 @@ /* eslint-disable no-console */ -// set your api secret +// set your api secret or token var convertapi = require('../lib')(process.env.CONVERT_API_SECRET); // Example of extracting first and last pages from PDF and then merging them back to new PDF. diff --git a/index.d.ts b/index.d.ts index 4b55c84..c2bab0f 100644 --- a/index.d.ts +++ b/index.d.ts @@ -40,7 +40,7 @@ export interface Client { export class ConvertAPI { client: Client; - constructor (secret: string, options?: Options); + constructor (credentials: string, options?: Options); convert(toFormat: string, params: object, fromFormat?: string, conversionTimeout?: number): Promise; getUser(): Promise; upload(source: string | NodeJS.ReadableStream, fileName?: string): Promise; diff --git a/src/client.js b/src/client.js index fcb1bee..91a71e7 100644 --- a/src/client.js +++ b/src/client.js @@ -11,6 +11,7 @@ export default class Client { this.defaultHeader = { 'User-Agent': api.userAgent, 'Content-Type': 'application/x-www-form-urlencoded', + Authorization: `Bearer ${api.credentials}`, Accept: 'application/json', }; this.httpsAgent = new https.Agent({ keepAlive: api.keepAlive }); @@ -93,7 +94,7 @@ export default class Client { } url(path) { - return `${this.api.baseUri}${path}?secret=${this.api.secret}`; + return `${this.api.baseUri}${path}`; } buildOptions(options) { diff --git a/src/index.js b/src/index.js index 3caa520..6b183e6 100644 --- a/src/index.js +++ b/src/index.js @@ -4,12 +4,12 @@ import Task from './task'; import Client from './client'; import { getReadableStream, normalizeBaseUri } from './utils'; -function ConvertAPI(secret, options = {}) { +function ConvertAPI(credentials, options = {}) { if (!(this instanceof ConvertAPI)) { - return new ConvertAPI(secret, options); + return new ConvertAPI(credentials, options); } - this.secret = secret; + this.credentials = credentials; this.baseUri = normalizeBaseUri(options.baseUri || 'https://v2.convertapi.com/'); this.conversionTimeout = options.conversionTimeout; this.conversionTimeoutDelta = options.conversionTimeoutDelta || 10; diff --git a/test/index.js b/test/index.js index 032f85a..bf7f4cc 100644 --- a/test/index.js +++ b/test/index.js @@ -10,12 +10,12 @@ const api = new ConvertAPI(process.env.CONVERT_API_SECRET); describe('ConvertAPI', () => { it('should be accessible as function', () => { - expect(ConvertAPI('test').secret).to.equal('test'); + expect(ConvertAPI('test').credentials).to.equal('test'); }); - it('should assign secret', () => { + it('should assign credentials', () => { const expectedVal = process.env.CONVERT_API_SECRET; - expect(api.secret).to.equal(expectedVal); + expect(api.credentials).to.equal(expectedVal); }); it ('should upload file', () => {