pptx2json

https://github.com/x1-/pptx2json
Admin
pptx2json is a pure JavaScript library that parses PowerPoint files to JSON format and reconstructs...
Tokens:4,764
Snippets:34
Trust Score:6.8
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install pptx2json

Source: https://github.com/x1-/pptx2json/blob/master/README.md

Use npm to install the package.

```sh
$ npm install pptx2json
```

--------------------------------

### Get slide layout type hash

Source: https://github.com/x1-/pptx2json/blob/master/README.md

Retrieve a hash mapping slide layout types to their corresponding XML file paths.

```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

const json = await pptx2json.toJson(testPPTX);
const table = pptx2json.getSlideLayoutTypeHash(json);
// {
//    'title': 'ppt/slideLayouts/slideLayout1.xml',
//    'blank': 'ppt/slideLayouts/slideLayout7.xml'
// }
```

--------------------------------

### Get Maximum Slide IDs

Source: https://context7.com/x1-/pptx2json/llms.txt

Retrieve the highest slide and relationship IDs to ensure unique identifiers when adding new slides.

```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

async function getSlideIds() {
  const json = await pptx2json.toJson('./presentation.pptx');
  const ids = pptx2json.getMaxSlideIds(json);

  console.log('Max slide id:', ids.id);   // e.g., 267
  console.log('Max relationship id:', ids.rid); // e.g., 7

  // Use these to create a new slide with unique IDs
  const newSlideId = ids.id + 1;    // 268
  const newSlideRid = ids.rid + 1;  // 8

  return ids;
}

getSlideIds();
// Output: { id: 267, rid: 7 }
```

--------------------------------

### Get max slide IDs

Source: https://github.com/x1-/pptx2json/blob/master/README.md

Retrieve the maximum slide ID and relationship ID from the parsed JSON.

```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

const json = await pptx2json.toJson(testPPTX);
const ids = pptx2json.getMaxSlideIds(json);
// {'id': 5, 'rid': 3}
```

--------------------------------

### getMaxSlideIds - Get Maximum Slide IDs

Source: https://context7.com/x1-/pptx2json/llms.txt

Retrieves the maximum slide ID and relationship ID from a presentation's slide list, useful for generating unique IDs for new slides.

```APIDOC
## getMaxSlideIds - Get Maximum Slide IDs

### Description
Retrieves the maximum `id` and `r:id` values from the presentation's slide list. Useful when programmatically adding new slides to ensure unique identifiers.

### Method
`getMaxSlideIds(json: object): { id: number, rid: number }`

### Endpoint
N/A (This is a library method, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **json** (object) - Required - The JSON object representing the parsed PowerPoint file (output from `toJson` or `buffer2json`).

### Request Example
```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

async function getSlideIds() {
  const json = await pptx2json.toJson('./presentation.pptx');
  const ids = pptx2json.getMaxSlideIds(json);

  console.log('Max slide id:', ids.id);   // e.g., 267
  console.log('Max relationship id:', ids.rid); // e.g., 7

  // Use these to create a new slide with unique IDs
  const newSlideId = ids.id + 1;    // 268
  const newSlideRid = ids.rid + 1;  // 8

  return ids;
}

getSlideIds();
// Output: { id: 267, rid: 7 }
```

### Response
#### Success Response (200)
- **ids** (object) - An object containing the maximum slide ID and relationship ID.
  - **id** (number) - The highest slide `id` found.
  - **rid** (number) - The highest slide relationship `r:id` found.

#### Response Example
```json
{
  "id": 267,
  "rid": 7
}
```

### Error Handling
None specified.
```

--------------------------------

### Initialize PPTX2Json Instance

Source: https://context7.com/x1-/pptx2json/llms.txt

Create a new instance with default settings or custom configuration for browser-based environments.

```javascript
const PPTX2Json = require('pptx2json');

// Default configuration (uses nodebuffer for binary content)
const pptx2json = new PPTX2Json();

// Custom configuration for browser environments
const pptx2jsonBrowser = new PPTX2Json({
  jszipBinary: 'arraybuffer',      // Options: nodebuffer, blob, arraybuffer, uint8array, nodestream
  jszipGenerateType: 'arraybuffer' // Options: nodebuffer, blob, arraybuffer, uint8array, nodestream
});
```

--------------------------------

### Execute Full Presentation Workflow

Source: https://context7.com/x1-/pptx2json/llms.txt

Demonstrates parsing an existing presentation, inspecting its structure, adding media, and saving the modified file.

```javascript
const PPTX2Json = require('pptx2json');
const fs = require('fs');

const pptx2json = new PPTX2Json();

async function fullWorkflow() {
  // 1. Parse the original presentation
  const json = await pptx2json.toJson('./input.pptx');

  // 2. Inspect the structure
  console.log('Files in presentation:', Object.keys(json).length);

  // 3. Get current slide information
  const maxIds = pptx2json.getMaxSlideIds(json);
  console.log('Current max IDs:', maxIds);

  // 4. Get available layouts
  const layouts = pptx2json.getSlideLayoutTypeHash(json);
  console.log('Available layouts:', Object.keys(layouts));

  // 5. Add media content
  const imageBuffer = fs.readFileSync('./logo.png');
  json['ppt/media/logo.png'] = imageBuffer;

  // 6. Save the modified presentation
  await pptx2json.toPPTX(json, { file: './output.pptx' });

  console.log('Presentation saved successfully!');
}

fullWorkflow();
```

--------------------------------

### Constructor - PPTX2Json

Source: https://context7.com/x1-/pptx2json/llms.txt

Initializes a new PPTX2Json instance. Allows configuration for binary content handling and output generation types, which is particularly useful for browser environments.

```APIDOC
## Constructor - PPTX2Json

### Description
Creates a new PPTX2Json instance with optional configuration for binary handling and output generation types.

### Method
`new PPTX2Json(options?: object)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **options** (object) - Optional - Configuration object.
  - **jszipBinary** (string) - Optional - Specifies how binary content should be handled. Options: `nodebuffer`, `blob`, `arraybuffer`, `uint8array`, `nodestream`. Defaults to `nodebuffer`.
  - **jszipGenerateType** (string) - Optional - Specifies the output type for generated files. Options: `nodebuffer`, `blob`, `arraybuffer`, `uint8array`, `nodestream`. Defaults to `nodebuffer`.

### Request Example
```javascript
const PPTX2Json = require('pptx2json');

// Default configuration
const pptx2json = new PPTX2Json();

// Custom configuration for browser environments
const pptx2jsonBrowser = new PPTX2Json({
  jszipBinary: 'arraybuffer',
  jszipGenerateType: 'arraybuffer'
});
```

### Response
None (constructor)

### Error Handling
None specified.
```

--------------------------------

### toPPTX - Convert JSON Back to PowerPoint

Source: https://context7.com/x1-/pptx2json/llms.txt

Reconstructs a PowerPoint presentation from a JSON object. The output can be a buffer or written directly to a file.

```APIDOC
## toPPTX - Convert JSON Back to PowerPoint

### Description
Converts a JSON object back to PowerPoint format. Can either return a buffer or write directly to a file.

### Method
`toPPTX(json: object, options?: object): Promise<Buffer | void>`

### Endpoint
N/A (This is a library method, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **json** (object) - Required - The JSON object representing the PowerPoint structure.
- **options** (object) - Optional - Configuration for output.
  - **file** (string) - Optional - If provided, the PowerPoint will be written to this file path. If omitted, a Buffer is returned.

### Request Example
```javascript
const PPTX2Json = require('pptx2json');
const fs = require('fs');

const pptx2json = new PPTX2Json();

async function modifyAndSave() {
  // Parse original presentation
  const json = await pptx2json.toJson('./original.pptx');

  // Modify slide content (example: access slide XML structure)
  // json['ppt/slides/slide1.xml']['p:sld']['p:cSld'][0]['p:spTree']...

  // Add a new image to the presentation
  const newImage = fs.readFileSync('./new-image.jpeg');
  json['ppt/media/image6.jpeg'] = newImage;

  // Option 1: Get buffer (for HTTP response, etc.)
  const pptxBuffer = await pptx2json.toPPTX(json);
  console.log('Buffer size:', pptxBuffer.length);

  // Option 2: Write directly to file
  await pptx2json.toPPTX(json, { file: './modified.pptx' });
  console.log('File saved successfully');

  return pptxBuffer;
}

modifyAndSave();
```

### Response
#### Success Response (200)
- **pptxBuffer** (Buffer) - If `options.file` is not provided, returns a Buffer containing the generated PowerPoint file.
- **void** - If `options.file` is provided, the function writes to the file and returns nothing.

#### Response Example
```javascript
// Example for buffer response
// const pptxBuffer = await pptx2json.toPPTX(json);
// console.log(pptxBuffer); // <Buffer ...>

// Example for file write response
// await pptx2json.toPPTX(json, { file: './modified.pptx' });
// console.log('File saved.');
```

### Error Handling
None specified.
```

--------------------------------

### Rebuild PowerPoint from JSON

Source: https://github.com/x1-/pptx2json/blob/master/README.md

Convert a JSON object back into a PowerPoint file, either as a buffer or by writing directly to a file path.

```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

const json = await pptx2json.toJson('path/to/pptx');
:
// return buffer to pptx 
const pptx = await pptx2json.toPPTX(json);
```

```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

const json = await pptx2json.toJson('path/to/pptx');
:
// write pptx to the path 
await pptx2json.toPPTX(json, {'file': 'path/to/output.pptx'});
```

--------------------------------

### Parse PowerPoint File to JSON

Source: https://context7.com/x1-/pptx2json/llms.txt

Convert a local .pptx file into a JSON object containing parsed XML and binary buffers.

```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

async function parsePowerPoint() {
  const json = await pptx2json.toJson('./presentation.pptx');

  // Access presentation metadata
  console.log(json['ppt/presentation.xml']);

  // Access specific slide content
  console.log(json['ppt/slides/slide1.xml']);

  // Access slide relationships
  console.log(json['ppt/slides/_rels/slide1.xml.rels']);

  // Binary content (images) stored as Buffer
  console.log(json['ppt/media/image1.png']); // <Buffer ...>

  return json;
}

parsePowerPoint();
```

--------------------------------

### buffer2json - Parse PowerPoint Buffer to JSON

Source: https://context7.com/x1-/pptx2json/llms.txt

Parses a PowerPoint file directly from a binary buffer, useful for data received from network requests or other buffer sources.

```APIDOC
## buffer2json - Parse PowerPoint Buffer to JSON

### Description
Parses a PowerPoint file from a binary buffer instead of a file path. Useful when receiving files from HTTP requests or other sources.

### Method
`buffer2json(buffer: Buffer): Promise<object>`

### Endpoint
N/A (This is a library method, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **buffer** (Buffer) - Required - The binary buffer containing the PowerPoint file data.

### Request Example
```javascript
const PPTX2Json = require('pptx2json');
const fs = require('fs').promises;

const pptx2json = new PPTX2Json();

async function parseFromBuffer() {
  // Read file as buffer (or receive from HTTP request)
  const buffer = await fs.readFile('./presentation.pptx');

  // Parse buffer directly
  const json = await pptx2json.buffer2json(buffer);

  console.log(Object.keys(json)); // List all files in the presentation
  return json;
}

parseFromBuffer();
```

### Response
#### Success Response (200)
- **json** (object) - A JSON object representing the PowerPoint file structure, similar to the `toJson` method.

#### Response Example
```json
{
  "ppt/presentation.xml": { ... },
  "ppt/slides/slide1.xml": { ... },
  "ppt/media/image1.png": <Buffer ...>
}
```

### Error Handling
None specified.
```

--------------------------------

### Convert JSON Back to PowerPoint

Source: https://context7.com/x1-/pptx2json/llms.txt

Reconstruct a PowerPoint file from a modified JSON object, either returning a buffer or saving to disk.

```javascript
const PPTX2Json = require('pptx2json');
const fs = require('fs');

const pptx2json = new PPTX2Json();

async function modifyAndSave() {
  // Parse original presentation
  const json = await pptx2json.toJson('./original.pptx');

  // Modify slide content (example: access slide XML structure)
  // json['ppt/slides/slide1.xml']['p:sld']['p:cSld'][0]['p:spTree']...

  // Add a new image to the presentation
  const newImage = fs.readFileSync('./new-image.jpeg');
  json['ppt/media/image6.jpeg'] = newImage;

  // Option 1: Get buffer (for HTTP response, etc.)
  const pptxBuffer = await pptx2json.toPPTX(json);
  console.log('Buffer size:', pptxBuffer.length);

  // Option 2: Write directly to file
  await pptx2json.toPPTX(json, { file: './modified.pptx' });
  console.log('File saved successfully');

  return pptxBuffer;
}

modifyAndSave();
```

--------------------------------

### Parse PowerPoint Buffer to JSON

Source: https://context7.com/x1-/pptx2json/llms.txt

Convert a binary buffer directly into a JSON object, suitable for handling files from HTTP requests.

```javascript
const PPTX2Json = require('pptx2json');
const fs = require('fs').promises;

const pptx2json = new PPTX2Json();

async function parseFromBuffer() {
  // Read file as buffer (or receive from HTTP request)
  const buffer = await fs.readFile('./presentation.pptx');

  // Parse buffer directly
  const json = await pptx2json.buffer2json(buffer);

  console.log(Object.keys(json)); // List all files in the presentation
  return json;
}

parseFromBuffer();
```

--------------------------------

### toJson - Parse PowerPoint File to JSON

Source: https://context7.com/x1-/pptx2json/llms.txt

Converts a PowerPoint file from the filesystem into a JSON object. XML content is parsed into JavaScript objects, and binary files are stored as buffers.

```APIDOC
## toJson - Parse PowerPoint File to JSON

### Description
Reads a PowerPoint file from the filesystem and converts it to a JSON object where XML files are parsed into JavaScript objects and binary files are stored as buffers.

### Method
`toJson(filePath: string): Promise<object>`

### Endpoint
N/A (This is a library method, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **filePath** (string) - Required - The path to the PowerPoint file.

### Request Example
```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

async function parsePowerPoint() {
  const json = await pptx2json.toJson('./presentation.pptx');

  // Access presentation metadata
  console.log(json['ppt/presentation.xml']);

  // Access specific slide content
  console.log(json['ppt/slides/slide1.xml']);

  // Access slide relationships
  console.log(json['ppt/slides/_rels/slide1.xml.rels']);

  // Binary content (images) stored as Buffer
  console.log(json['ppt/media/image1.png']); // <Buffer ...>

  return json;
}

parsePowerPoint();
```

### Response
#### Success Response (200)
- **json** (object) - A JSON object representing the PowerPoint file structure. Keys are file paths within the presentation, and values are either parsed XML content (as objects) or binary data (as Buffers).

#### Response Example
```json
{
  "ppt/presentation.xml": { ... },
  "ppt/slides/slide1.xml": { ... },
  "ppt/media/image1.png": <Buffer ...>
}
```

### Error Handling
None specified.
```

--------------------------------

### Retrieve Slide Layout Type Hash

Source: https://context7.com/x1-/pptx2json/llms.txt

Maps slide layout types to their corresponding XML file paths within the presentation structure.

```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

async function getLayoutTypes() {
  const json = await pptx2json.toJson('./presentation.pptx');
  const layoutHash = pptx2json.getSlideLayoutTypeHash(json);

  console.log(layoutHash);
  // Output:
  // {
  //   'title': 'ppt/slideLayouts/slideLayout1.xml',
  //   'obj': 'ppt/slideLayouts/slideLayout2.xml',
  //   'secHead': 'ppt/slideLayouts/slideLayout3.xml',
  //   'twoObj': 'ppt/slideLayouts/slideLayout4.xml',
  //   'blank': 'ppt/slideLayouts/slideLayout7.xml'
  // }

  // Use specific layout for new slides
  const blankLayoutPath = layoutHash['blank'];
  const titleLayoutPath = layoutHash['title'];

  return layoutHash;
}

getLayoutTypes();
```

--------------------------------

### Parse PowerPoint to JSON

Source: https://github.com/x1-/pptx2json/blob/master/README.md

Convert a PowerPoint file into a JSON object.

```javascript
const PPTX2Json = require('pptx2json');
const pptx2json = new PPTX2Json();

const json = await pptx2json.toJson('path/to/pptx');
```
Tokens:
Raw