@office-open/pptx 0.4.6 → 0.5.0

package/README.md

@@ -1,6 +1,6 @@
 # @office-open/pptx
 
-> Generate .pptx files with JS/TS with a declarative API.
+> Generate and parse .pptx files with JS/TS with a declarative API.
 
 ## Features
 
@@ -20,6 +20,7 @@
 - **Notes** — Speaker notes for each slide
 - **Group Shapes** — Group multiple shapes together
 - **DrawingML** — Shapes with fills, outlines, shadows, glow, reflection, and 3D effects
+- **Parsing** — Read existing .pptx files with `readPresentation` for round-trip workflows
 
 ## Installation
 
@@ -38,26 +39,42 @@ import { Presentation, Shape, Packer, Paragraph, Run } from "@office-open/pptx";
 import { writeFileSync } from "node:fs";
 
 const pres = new Presentation({
-    slides: [
-        {
-            children: [
-                new Shape({
-                    text: "Hello World",
-                    fill: "4472C4",
-                    x: 100,
-                    y: 100,
-                    width: 600,
-                    height: 400,
-                }),
-            ],
-        },
-    ],
+  slides: [
+    {
+      children: [
+        new Shape({
+          text: "Hello World",
+          fill: "4472C4",
+          x: 100,
+          y: 100,
+          width: 600,
+          height: 400,
+        }),
+      ],
+    },
+  ],
 });
 
 const buffer = await Packer.toBuffer(pres);
 writeFileSync("presentation.pptx", buffer);
 ```
 
+## Parsing
+
+Read existing `.pptx` files and re-create them as `ISlideOptions[]`:
+
+```typescript
+import { readPresentation, Presentation, Packer } from "@office-open/pptx";
+import { readFileSync, writeFileSync } from "node:fs";
+
+const slides = readPresentation(new Uint8Array(readFileSync("input.pptx")));
+
+// Modify parsed data, then re-generate
+const pres = new Presentation({ slides });
+const buffer = await Packer.toBuffer(pres);
+writeFileSync("output.pptx", buffer);
+```
+
 ## Performance
 
 Performance vs [PptxGenJS](https://github.com/gitbrent/PptxGenJS) (higher hz is better, Windows 11 / Node 22):
@@ -82,11 +99,11 @@ Performance vs [PptxGenJS](https://github.com/gitbrent/PptxGenJS) (higher hz is
 
 **Large Files — Create + toBuffer**
 
-| Scenario               | @office-open/pptx | PptxGenJS (DEFLATE) |  Speedup |
-| ---------------------- | ----------------: | ------------------: | -------: |
-| 10 slides × 10 shapes  |         493 ops/s |           475 ops/s | **1.0x** |
-| 50×10 table            |         450 ops/s |           243 ops/s | **1.9x** |
-| 20 slides full         |         450 ops/s |           343 ops/s | **1.3x** |
+| Scenario              | @office-open/pptx | PptxGenJS (DEFLATE) |  Speedup |
+| --------------------- | ----------------: | ------------------: | -------: |
+| 10 slides × 10 shapes |         493 ops/s |           475 ops/s | **1.0x** |
+| 50×10 table           |         450 ops/s |           243 ops/s | **1.9x** |
+| 20 slides full        |         450 ops/s |           343 ops/s | **1.3x** |
 
 ## Examples
 

package/dist/chunk-BY251N0e.mjs

@@ -0,0 +1 @@
+var e=Object.defineProperty,t=Object.getOwnPropertyDescriptor,n=Object.getOwnPropertyNames,r=Object.prototype.hasOwnProperty,i=(e,t)=>()=>(e&&(t=e(e=0)),t),a=(t,n)=>{let r={};for(var i in t)e(r,i,{get:t[i],enumerable:!0});return n||e(r,Symbol.toStringTag,{value:`Module`}),r},o=(i,a,o,s)=>{if(a&&typeof a==`object`||typeof a==`function`)for(var c=n(a),l=0,u=c.length,d;l<u;l++)d=c[l],!r.call(i,d)&&d!==o&&e(i,d,{get:(e=>a[e]).bind(null,d),enumerable:!(s=t(a,d))||s.enumerable});return i},s=(e,t,n)=>(o(e,t,`default`),n&&o(n,t,`default`)),c=t=>r.call(t,`module.exports`)?t[`module.exports`]:o(e({},`__esModule`,{value:!0}),t);export{c as i,a as n,s as r,i as t};