
Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
carbone-sdk
Advanced tools
Carbone API NodeJS SDK to generate documents: PDF, DOCX, XLSX, PPTX, ODT, ODP, ODS, CSV, JPG, PNG, invoices, reports, financial, contracts, financial statements and more.
The SDK to use Carbone Cloud API easily.
Carbone is a report generator (PDF, DOCX, XLSX, ODT, PPTX, ODS, XML, CSV...) using templates and JSON data. Learn more about the Carbone ecosystem.
$ npm i --save carbone-sdk
// OR
$ yarn add carbone-sdk
Try the following code to generate a report in 10 seconds. Insert:
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
const path = require('path');
const body = {
data: {
/** YOUR DATA HERE **/
firstname: "John",
lastname: "Wick"
},
convertTo: "pdf"
/** List of other options: https://carbone.io/api-reference.html#render-reports **/
}
/** The template path must be absolute. Use the `path` module to get it. **/
const templateAbsolutePath = path.join(__dirname, 'path', 'to', 'template.odt')
/** Generate the document **/
carboneSDK.render(templateAbsolutePath, body, (err, buffer, filename) => {
/**
* ✅ Document generated, returned values:
* - "buffer": generated document as Buffer
* - "Filename": document name as String
*
* Now you can save the file or Stream it!
**/
})
Note: Each request executed in the SDK is retry once if the first reponse request is a ECONNRESET
errors
To choose a specific version of Carbone Render API, use the following function. It is only possible to set a major version of Carbone.
// Set the version of carbone to 4
carboneSDK.setApiVersion(4)
carboneSDK.setOptions({
// Edit headers for all requests (default)
headers: {
'carbone-template-delete-after': 86400
},
// Edit the default Carbone URL (https://api.carbone.io/) for On-Premise
// WARNING: Add a trailing slash to the end of your URL
carboneUrl: 'https://your-on-premise-carbone-url:4000/'
})
When a template is uploaded, a Template ID
is created which is the unique identifier for the template. If you upload the same template twice, you will have the same Template ID.
From the template you can:
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY');
const path = require('path');
/** The template path must be absolute. Use the `path` module to get it. **/
const templateAbsolutePath = path.join(__dirname, 'path', 'to', 'template.odt')
carboneSDK.addTemplate(templateAbsolutePath, (err, templateId) => {
})
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
carboneSDK.getTemplate('templateId', (err, fileContentAsBuffer) => {
/** Note: The content returned is a buffer and not a string **/
})
You can also get a template with stream.
const writeStream = fs.createWriteStream('tmp.odt')
const carboneStream = carboneSDK.getTemplate('templateId')
carboneStream.on('error', (err) => {
})
writeStream.on('close', () => {
// Get the real filename here
let filename = carboneSDK.getFilename(carboneStream)
})
carboneStream.pipe(writeStream)
The only way to get the filename when using stream is to wait the end of the request execution.
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
carboneSDK.delTemplate('templateId', (err) => {
})
There are multiple ways to render a template.
The first solution is to use a templateId
(previously created from the method "addTemplate").
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
const body = {
data: { /** YOUR DATA HERE **/ },
convertTo: "pdf"
/** List of other options: https://carbone.io/api-reference.html#render-reports **/
}
carboneSDK.render('templateId', body, (err, buffer, filename) => {
})
Or if you don't want the buffer but just the link to download it later, you can set the options isReturningBuffer: false
to the SDK.
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
const body = {
data: { /** YOUR DATA HERE **/ },
convertTo: "pdf"
/** List of other options: https://carbone.io/api-reference.html#render-reports **/
}
carboneSDK.setOptions({
isReturningBuffer: false
})
carboneSDK.render('templateId', body, (err, downloadLink, filename) => {
})
The second solution (and easiest one) is to write the path of your local file, not the template ID. By using this method, if your template does not exist or has been deleted, the SDK will automatically:
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
const body = {
data: {
/** YOUR DATA HERE **/
firstname: "John",
lastname: "Wick"
},
convertTo: "pdf"
/** List of other options: https://carbone.io/api-reference.html#render-reports **/
}
carboneSDK.render('/absolute/path/to/your/template', body, (err, buffer, filename) => {
})
You can also render you template and get result with a stream.
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
const body = {
data: { /** YOUR DATA HERE **/ },
convertTo: "pdf"
/** List of other options: https://carbone.io/api-reference.html#render-reports **/
}
const writeStream = fs.createWriteStream('result.pdf')
const sdkStream = carboneSDK.render('/absolute/path/to/your/template', body)
sdkStream.on('error', (err) => {
})
writeStream.on('close', () => {
// Here you can get the real filename
let filename = carboneSDK.getFilename(sdkStream)
})
sdkStream.pipe(writeStream)
You can also overwrite headers with an optional object. Here is an example to use Carbone webhooks:
const options = {
headers = {
'carbone-webhook-url': 'https://...'
}
}
carboneSDK.render('templateId', body, options, (err, buffer, filename) => {
})
All function of the SDK are also available with promise.
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
carboneSDK.addTemplatePromise('/absolute/path/to/your/template', 'OPTIONAL-PAYLOAD')
.then(templateId => {
})
.catch(err => {
})
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
carboneSDK.getTemplatePromise('templateId')
.then(content => {
})
.catch(err => {
})
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
carboneSDK.delTemplatePromise('templateId', 'OPTIONAL-PAYLOAD')
.then(templateId => {
})
.catch(err => {
})
const carboneSDK = require('carbone-sdk')('YOUR-API-KEY')
const body = {
data: { /** YOUR DATA HERE **/ },
convertTo: "pdf"
/** List of other options: https://carbone.io/api-reference.html#render-reports **/
}
// You can also overwrite headers with an optional object. Here is an example to use Carbone webhooks:
const options = {
headers : {
'carbone-webhook-url': 'https://...' // if you
}
}
carboneSDK.renderPromise('/absolute/path/to/your/template', body [, options])
.then(result => {
// result.content contains the rendered file
// result.filename containes the rendered filename
})
.catch(err => {
})
FAQs
Carbone API NodeJS SDK to generate documents: PDF, DOCX, XLSX, PPTX, ODT, ODP, ODS, CSV, JPG, PNG, invoices, reports, financial, contracts, financial statements and more.
The npm package carbone-sdk receives a total of 473 weekly downloads. As such, carbone-sdk popularity was classified as not popular.
We found that carbone-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
Security News
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.