slidecanvas 1.0.8 → 1.1.0

package/README.md

@@ -151,10 +151,10 @@ export default function MyEditor() {
 
 ### 1. 7-Second S3 Auto-Save (Real-Time Persistence)
 
-To save changes back to S3 after a modifications stop for 7 seconds, use the `PptxExporter` combined with a debounce pattern:
+To save changes back to S3 after a modifications stop for 7 seconds, use the **`PptxBlobExporter`** combined with a debounce pattern. Unlike the regular exporter, this utility returns a `Blob` directly without triggering a browser download.
 
 ```tsx
-import { PptEditor, PptxExporter } from 'slidecanvas';
+import { PptEditor, PptxBlobExporter } from 'slidecanvas';
 import { useRef } from 'react';
 
 export function S3Editor({ s3Key }: { s3Key: string }) {
@@ -166,11 +166,11 @@ export function S3Editor({ s3Key }: { s3Key: string }) {
 
     // 2. Start a new 7-second countdown
     timerRef.current = setTimeout(async () => {
-      console.log('User stopped editing. Exporting and saving to S3...');
+      console.log('User stopped editing. Generating Blob and saving to S3...');
       
-      // 3. Generate the .pptx file binary
-      const exporter = new PptxExporter();
-      const blob = await exporter.export(presentation);
+      // 3. Generate the .pptx file binary as a Blob
+      const exporter = new PptxBlobExporter();
+      const blob = await exporter.exportToBlob(presentation);
       
       // 4. Upload to your backend API which talks to S3
       const formData = new FormData();
@@ -180,7 +180,7 @@ export function S3Editor({ s3Key }: { s3Key: string }) {
       await fetch('/api/save-to-s3', {
         method: 'POST',
         body: formData
-      });
+          });
       
       console.log('Saved successfully!');
     }, 7000); // 7 seconds
@@ -355,20 +355,24 @@ SlideCanvas features a sophisticated 120px high ribbon layout divided into logic
 #### Intelligent Routing
 Use the `onSourceChange` callback to synchronize the editor state with your application's routing. This allows for deep-linking to specific presentations or maintaining "Upload" vs "New" states in the address bar.
 
-### `PptxParser` & `PptxExporter`
+### `PptxParser`, `PptxExporter` & `PptxBlobExporter`
 
 For headless workflows, you can use the internal engine directly:
 
 ```typescript
-import { PptxParser, PptxExporter } from 'slidecanvas';
+import { PptxParser, PptxExporter, PptxBlobExporter } from 'slidecanvas';
 
-// Load
+// 1. Load: Parse a .pptx file into JSON
 const parser = new PptxParser();
-const presentation = await parser.parse(myBlob);
+const presentation = await parser.parse(myArrayBuffer);
 
-// Export
+// 2. Export: Trigger a browser file download
 const exporter = new PptxExporter();
 await exporter.export(presentation);
+
+// 3. Blob Export: Get file data as a Blob (useful for S3/API uploads)
+const blobExporter = new PptxBlobExporter();
+const blob = await blobExporter.exportToBlob(presentation);
 ```
 
 ---

package/dist/index.d.mts

@@ -85,4 +85,20 @@ declare class PptxExporter {
     export(presentation: Presentation): Promise<void>;
 }
 
-export { type BaseElement, type ElementType, type ImageElement, PptEditor, PptxExporter, PptxParser, type Presentation, type PresentationSource, type ShapeElement, type ShapeType, type Slide, type SlideElement, type TextElement };
+/**
+ * A standalone service to convert a Presentation object into a .pptx Blob.
+ * Use this for background processing, S3 uploads, or other non-UI tasks.
+ *
+ * This replicates the logic from PptxExporter but returns a Blob instead of
+ * triggering a browser download.
+ */
+declare class PptxBlobExporter {
+    /**
+     * Converts a Presentation object into a .pptx Blob.
+     * @param presentation The presentation data to export.
+     * @returns A Promise that resolves to a Blob containing the .pptx file.
+     */
+    exportToBlob(presentation: Presentation): Promise<Blob>;
+}
+
+export { type BaseElement, type ElementType, type ImageElement, PptEditor, PptxBlobExporter, PptxExporter, PptxParser, type Presentation, type PresentationSource, type ShapeElement, type ShapeType, type Slide, type SlideElement, type TextElement };

package/dist/index.d.ts

@@ -85,4 +85,20 @@ declare class PptxExporter {
     export(presentation: Presentation): Promise<void>;
 }
 
-export { type BaseElement, type ElementType, type ImageElement, PptEditor, PptxExporter, PptxParser, type Presentation, type PresentationSource, type ShapeElement, type ShapeType, type Slide, type SlideElement, type TextElement };
+/**
+ * A standalone service to convert a Presentation object into a .pptx Blob.
+ * Use this for background processing, S3 uploads, or other non-UI tasks.
+ *
+ * This replicates the logic from PptxExporter but returns a Blob instead of
+ * triggering a browser download.
+ */
+declare class PptxBlobExporter {
+    /**
+     * Converts a Presentation object into a .pptx Blob.
+     * @param presentation The presentation data to export.
+     * @returns A Promise that resolves to a Blob containing the .pptx file.
+     */
+    exportToBlob(presentation: Presentation): Promise<Blob>;
+}
+
+export { type BaseElement, type ElementType, type ImageElement, PptEditor, PptxBlobExporter, PptxExporter, PptxParser, type Presentation, type PresentationSource, type ShapeElement, type ShapeType, type Slide, type SlideElement, type TextElement };