shobhitsharma / pptx-compose Goto Github PK

View Code? Open in Web Editor NEW

78.0 2.0 10.0 3.19 MB

Parser to convert PPTX to JSON format

Home Page: http://officeopenxml.com/prPresentation.php

JavaScript 10.39% TypeScript 89.61%

ppt pptx-parser pptx pptx-json pptx-xml office

pptx-compose's Introduction

pptx-compose

Parses Open Office XML generated PPTX to JSON

Install

$ npm install pptx-compose

See changelog here for API updates and compatibility issues.

Usage

import PPTXCompose from "pptx-compose";

// Initialize repo
const composer = new PPTXCompose(options);

// Parses a PPTX file to JSON
const pptx = await composer.toJSON("/path/to/my.pptx");

// Parses JSON output to PPTX
const json = await composer.toPPTX("/path/to/my.json");

CLI

Composer is able to generate JSON from PPTX source directly from CLI, run:

# Usage: convert [options] <input> <output>
# Options:
#   -V, --version  output the version number
#   -i, --input    PPTX File
#   -o, --output   Output JSON file (optional)
#   -h, --help     display help for command

$ node bin/convert ./path/to/my.pptx path/to/your/directory/generated.json

Options

attribute	type	default
jszipBinary	`"nodebuffer" / "base64" / "text" / "binarystring" /` \ `"array" / "uint8array" / "arraybuffer" / "blob"`	`nodebuffer`
jszipGenerateType	`"nodebuffer" / "base64" / "text" / "binarystring" /` \ `"array" / "uint8array" / "arraybuffer" / "blob"`	`nodebuffer`

Methods

PPTX Composer has following built-in methods:

`.toJSON(<pptx_file_path>, <options{Options & { output: string }}>)`

Parse PowerPoint file to JSON.

const composer = new PPTXCompose();

// Parses a PPTX file to JSON
const pptx = await composer.toJSON("/path/to/my.pptx");

// Convert a PPTX file to JSON file
composer.toJSON("/path/to/my.pptx", {
  output: "/path/to/output/file.pptx",
});

`.toPPTX(<json>, <options{Options & { output: string }}>)`

Convert JSON file to PPTX.

const composer = new PPTXCompose('{ "my": "json" ... }');

// Parses JSON output to PPTX
const json = await composer.toPPTX("/path/to/my.json");

// Convert JSON to PPTX file
composer.toJSON("/path/to/my.json", {
  output: "/path/to/output/file.pptx",
});

License

MIT

pptx-compose's People

Contributors

Stargazers

Watchers

Forkers

enmingzhang won21kr rlingineni ilsx x1- advisr-io jaelys jsstudioist sirine-dachraoui amit08255

pptx-compose's Issues

The automated release is failing 🚨

🚨 The automated release from the `master` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Combine files back to downloadable file/stream

This tool looks useful. I'm trying to figure out if it's capable of generating a file for download which has combined multiple pptx files together at all? It creates an array but it isn't clear if this can be converted to a raw binary file for download? thanks.

PPTXCompose is not a function

No matter how I try referencing PPTXCompose in an express app it keeps returning "PPTXCompose is not a function". Any ideas on what I am doing wrong?

const PPTXCompose = require('pptx-compose')

const composer = PPTXCompose()

const pptx = composer.toJSON('/path/to/file.pptx')

PPTXCompose is not a constructor

Code to reproduce error:
import PPTXCompose from "pptx-compose";
const composer = new PPTXCompose();

Error:
const composer = new PPTXCompose();
^
TypeError: PPTXCompose is not a constructor

System Configuration:
OS: Windows 10
Node: v14.15.1

@shobhitsharma