diff --git a/LICENSE b/LICENSE index 84e05d0..ec1a2ae 100644 --- a/LICENSE +++ b/LICENSE @@ -1,18 +1,21 @@ -ConvertAPI -https://www.convertapi.com -(c) 2011-2018 Baltsoft +MIT License -ConvertAPI.Node -https://github.com/ConvertAPI/convertapi-node -Copyright (c) 2018 Tomas Rutkauskas +Copyright (c) 2012-2026 ConvertAPI -The MIT License -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation -files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, -modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software -is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES -OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR -IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 51aa59c..356dcf0 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ const convertapi = new ConvertAPI('api-token', { conversionTimeout: 60 }); ### File conversion Convert file to PDF example. All supported file formats and options can be found -[here](https://www.convertapi.com/conversions). +[here](https://www.convertapi.com/api). ```javascript convertapi.convert('pdf', { File: '/path/to/my_file.docx' }) @@ -106,7 +106,7 @@ var resultPromise = convertapi.convert('pdf', { File: 'https://website/my_file' #### Additional conversion parameters ConvertAPI accepts additional conversion parameters depending on selected formats. All conversion -parameters and explanations can be found [here](https://www.convertapi.com/conversions). +parameters and explanations can be found [here](https://www.convertapi.com/api). ```javascript var resultPromise = convertapi.convert( @@ -114,14 +114,14 @@ var resultPromise = convertapi.convert( { File: '/path/to/my_file.docx', PageRange: '1-10', - PdfResolution: '150', + Pdfa: true, } ); ``` ### User information -You can always check your conversion counts by fetching [user information](https://www.convertapi.com/doc/user). +You can always check your conversion counts by fetching [user information](https://www.convertapi.com/docs/user-information). ```javascript convertapi.getUser().then(function(info) { @@ -144,10 +144,10 @@ convertapi ### Alternative domain -Set `baseUri` parameter to use other service domains. Dedicated to the region [domain list](https://www.convertapi.com/doc/servers-location). +Set `baseUri` parameter to use other service domains. Dedicated to the region [domain list](https://www.convertapi.com/docs/servers-location). ```js -var convertapi = require('../lib')(process.env.API_TOKEN, { baseUri: 'https://eu-v2.convertapi.com/' }); +var convertapi = require('convertapi')('api-token', { baseUri: 'https://eu-v2.convertapi.com/' }); ``` ### More examples @@ -180,7 +180,7 @@ Releases are published to npm by GitHub Actions, see [RELEASING.md](RELEASING.md ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/ConvertAPI/convertapi-library-node. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/ConvertAPI/convertapi-library-node. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct. ## License diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..7c546b9 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security policy + +## Reporting a vulnerability + +Please do not report security vulnerabilities in public GitHub issues, discussions or pull requests. + +Report them privately on GitHub instead: open the [Security tab](https://github.com/ConvertAPI/convertapi-library-node/security) of this repository and click "Report a vulnerability", or go straight to [the report form](https://github.com/ConvertAPI/convertapi-library-node/security/advisories/new). Only you and the maintainers can see the report. + +Please include: + +- the version of the convertapi npm package and of Node.js you use; +- the steps to reproduce the issue, or a proof of concept; +- what an attacker could do with it. + +We will confirm that we received your report and keep you updated until it is fixed. Please give us reasonable time to release a fix before you disclose the issue publicly. + +You can use the same private route if you are not sure whether the issue is in this SDK or in the ConvertAPI service itself. + +## Supported versions + +Security fixes are released in the latest version of the [convertapi package on npm](https://www.npmjs.com/package/convertapi). Please check that the issue still occurs with the latest version before you report it.