@carboneio/carbone-sdk-js

Carbone Render Javascript

The javascript SDK to use Carbone Render easily into your frontend (Angular, Vuejs, Svelte, React, Ember.js...).

Carbone is a report generator (PDF, DOCX, XLSX, ODT, PPTX, ODS, XML, CSV...) using templates and JSON data. Learn more about the Carbone ecosystem.

Install

npm install https://github.com/carboneio/carbone-sdk-js

or

yarn add https://github.com/carboneio/carbone-sdk-js

Usage

  import carboneSDK from "carbone-sdk-js";
  // SDK constructor, the access token have to be passed as an argument to carboneRenderSDK
  const _carboneService = carboneSDK("eyJhbGc...");
  // Template from a file input OR template ID
  const _template = document.getElementById("inputFile").files[0];
  // Data from an input
  let _data = JSON.parse(document.getElementById("inputData").value);
  // Render the report from a template and a JSON Data
  _carboneService.render(_template, _data).then(({ content, name }) => {
    // name == report name as a String
    // content == report content as a Blob, it can be used to download the file
  });

Checkout an integration example.

Documentation

• SDK API REFERENCE
• SDK quick integration example
• SDK full integration example
• Documentation to design a template

Build for production

To edit build options, look at the file "build.js" for more details.

$ npm run build

After running the command, the script is available on the folder "dist".

Run tests

Build the project

$ npm run build

To run all the tests:

$ npm run test

If you need to test the generation of templateId, you can use the nodejs main.js to test the sha256 generation.

$ node ./tests/generate_template_id.js

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

👤 Author

• @steevepay

Changelog

v1.1.0

• Turn the SDK into a javascript module. The build script creates an ESM file. Instead of accessing the SDK globally through the "window.carboneRenderSDK", it is possible to import it through: import carboneRenderSDK from "carbone-sdk-js"
  • Update the default value of "version", so that, it requests the latest version 3 of Carbone
  • Update comments and examples on the doc folder