@imgly/codesign-mcp 0.1.5 → 0.1.7

package/assets/docs/guide/export-save-publish/export/to-pdf.md

@@ -1,4 +1,4 @@
-> This is one page of the CE.SDK Vanilla JS/TS documentation. For a complete overview, see the [Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
+> This is one page of the CE.SDK Node.js documentation. For a complete overview, see the [Node.js Documentation Index](https://img.ly/docs/cesdk/node.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
 
 **Navigation:** [Guides](./guides.md) > [Export Media Assets](./export-save-publish/export.md) > [To PDF](./export-save-publish/export/to-pdf.md)
 
@@ -6,211 +6,134 @@
 
 Export your designs as PDF documents with high compatibility mode and underlayer support for special media printing.
 
-![Export to PDF hero image](https://img.ly/docs/cesdk/./assets/browser.hero.webp)
-
 > **Reading time:** 10 minutes
 >
 > **Resources:**
 >
 > - [Download examples](https://github.com/imgly/cesdk-web-examples/archive/refs/tags/release-$UBQ_VERSION$.zip)
-> - [View source on GitHub](https://github.com/imgly/cesdk-web-examples/tree/release-$UBQ_VERSION$/guides-export-save-publish-export-to-pdf-browser)
-> - [Open in StackBlitz](https://stackblitz.com/github/imgly/cesdk-web-examples/tree/v$UBQ_VERSION$/guides-export-save-publish-export-to-pdf-browser)
-> - [Live demo](https://img.ly/docs/cesdk/examples/guides-export-save-publish-export-to-pdf-browser/)
+>
+> - [View source on GitHub](https://github.com/imgly/cesdk-web-examples/tree/release-$UBQ_VERSION$/guides-export-save-publish-export-to-pdf-server-js)
+>
+> - [Open in StackBlitz](https://stackblitz.com/github/imgly/cesdk-web-examples/tree/v$UBQ_VERSION$/guides-export-save-publish-export-to-pdf-server-js)
 
 PDF provides a universal document format for sharing and printing designs. CE.SDK exports PDF files that preserve vector graphics, support multi-page documents, and include options for print compatibility. You can configure high compatibility mode to ensure consistent rendering across different PDF viewers, and generate underlayers for special media printing like fabric, glass, or DTF transfers.
 
-```typescript file=@cesdk_web_examples/guides-export-save-publish-export-to-pdf-browser/browser.ts reference-only
-import { type EditorPlugin, type EditorPluginContext } from '@cesdk/cesdk-js';
-import {
-  BlurAssetSource,
-  ColorPaletteAssetSource,
-  CropPresetsAssetSource,
-  DemoAssetSources,
-  EffectsAssetSource,
-  FiltersAssetSource,
-  PagePresetsAssetSource,
-  StickerAssetSource,
-  TextAssetSource,
-  TextComponentAssetSource,
-  TypefaceAssetSource,
-  UploadAssetSources,
-  VectorShapeAssetSource
-} from '@cesdk/cesdk-js/plugins';
-import { DesignEditorConfig } from './design-editor/plugin';
-import packageJson from './package.json';
-
-/**
- * CE.SDK Plugin: Export to PDF Guide
- *
- * This example demonstrates:
- * - Exporting designs as PDF documents
- * - Configuring high compatibility mode for consistent rendering
- * - Generating underlayers for special media printing
- * - Controlling output dimensions
- * - Using the built-in export action
- */
-class Example implements EditorPlugin {
-  name = packageJson.name;
-
-  version = packageJson.version;
-
-  async initialize({ cesdk }: EditorPluginContext): Promise<void> {
-    if (!cesdk) {
-      throw new Error('CE.SDK instance is required for this plugin');
-    }
-
-    await cesdk.addPlugin(new DesignEditorConfig());
-    // Add asset source plugins
-    await cesdk.addPlugin(new BlurAssetSource());
-    await cesdk.addPlugin(new ColorPaletteAssetSource());
-    await cesdk.addPlugin(new CropPresetsAssetSource());
-    await cesdk.addPlugin(
-      new UploadAssetSources({ include: ['ly.img.image.upload'] })
-    );
-    await cesdk.addPlugin(
-      new DemoAssetSources({
-        include: [
-          'ly.img.templates.blank.*',
-          'ly.img.templates.presentation.*',
-          'ly.img.templates.print.*',
-          'ly.img.templates.social.*',
-          'ly.img.image.*'
-        ]
-      })
-    );
-    await cesdk.addPlugin(new EffectsAssetSource());
-    await cesdk.addPlugin(new FiltersAssetSource());
-    await cesdk.addPlugin(new PagePresetsAssetSource());
-    await cesdk.addPlugin(new StickerAssetSource());
-    await cesdk.addPlugin(new TextAssetSource());
-    await cesdk.addPlugin(new TextComponentAssetSource());
-    await cesdk.addPlugin(new TypefaceAssetSource());
-    await cesdk.addPlugin(new VectorShapeAssetSource());
-
-    const engine = cesdk.engine;
-
-    // Load a template scene and zoom to fit
-    await engine.scene.loadFromURL(
-      'https://cdn.img.ly/assets/demo/v3/ly.img.template/templates/cesdk_postcard_1.scene'
-    );
-    const page = engine.scene.getCurrentPage();
-    if (!page) throw new Error('No page found');
+```typescript file=@cesdk_web_examples/guides-export-save-publish-export-to-pdf-server-js/server-js.ts reference-only
+import CreativeEngine from '@cesdk/node';
+import { config } from 'dotenv';
+import { writeFileSync, mkdirSync, existsSync } from 'fs';
+import { createInterface } from 'readline';
 
-    await engine.scene.zoomToBlock(page, { padding: 40 });
+config();
 
-    // Register a custom export action with PDF-specific options
-    cesdk.actions.register('exportDesign', async () => {
-      // Export the scene block to include all pages in the PDF
-      const scene = engine.scene.get()!;
+// Helper function to prompt for user input
+function prompt(question: string): Promise<string> {
+  const rl = createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
 
-      // Merge PDF-specific defaults with provided options
-      const blob = await engine.block.export(scene, {
-        mimeType: 'application/pdf',
-        exportPdfWithHighCompatibility: true
-      });
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => {
+      rl.close();
+      resolve(answer);
+    });
+  });
+}
+
+// Display export options menu
+console.log('=== PDF Export Options ===\n');
+console.log('1. Default PDF');
+console.log('2. High Compatibility PDF');
+console.log('3. PDF with Underlayer');
+console.log('4. A4 @ 300 DPI PDF');
+console.log('5. All formats\n');
+
+const choice = (await prompt('Select export option (1-5): ')) || '5';
+
+console.log('\n⏳ Initializing engine...');
+
+const engine = await CreativeEngine.init({
+  baseURL: process.env.IMGLY_LOCAL_ASSETS_URL
+});
 
-      await cesdk.utils.downloadFile(blob, 'application/pdf');
+try {
+  await engine.scene.loadFromURL(
+    'https://cdn.img.ly/assets/demo/v3/ly.img.template/templates/cesdk_postcard_1.scene'
+  );
+
+  // Get the scene block for PDF export (includes all pages)
+  const scene = engine.scene.get();
+  if (!scene) throw new Error('No scene found');
+
+  const outputDir = './output';
+  if (!existsSync(outputDir)) {
+    mkdirSync(outputDir, { recursive: true });
+  }
+
+  console.log('⏳ Exporting...\n');
+
+  if (choice === '1' || choice === '5') {
+    // Export scene as PDF (includes all pages)
+    const blob = await engine.block.export(scene, {
+      mimeType: 'application/pdf'
+    });
+    const buffer = Buffer.from(await blob.arrayBuffer());
+    writeFileSync(`${outputDir}/design.pdf`, buffer);
+    console.log(
+      `✓ Default PDF: ${outputDir}/design.pdf (${(blob.size / 1024).toFixed(1)} KB)`
+    );
+  }
+
+  if (choice === '2' || choice === '5') {
+    // Enable high compatibility mode for consistent rendering across PDF viewers
+    const blob = await engine.block.export(scene, {
+      mimeType: 'application/pdf',
+      exportPdfWithHighCompatibility: true
     });
+    const buffer = Buffer.from(await blob.arrayBuffer());
+    writeFileSync(`${outputDir}/design-high-compatibility.pdf`, buffer);
+    console.log(
+      `✓ High Compatibility PDF: ${outputDir}/design-high-compatibility.pdf (${(blob.size / 1024).toFixed(1)} KB)`
+    );
+  }
 
-    // Configure navigation bar with export buttons using insertOrderComponent
-    cesdk.ui.insertOrderComponent(
-      { in: 'ly.img.navigation.bar', position: 'end' },
-      {
-        id: 'ly.img.actions.navigationBar',
-        children: [
-          {
-            id: 'ly.img.action.navigationBar',
-            key: 'export-pdf',
-            label: 'PDF',
-            icon: '@imgly/Download',
-            onClick: async () => {
-              // Export scene to include all pages in the PDF
-              const scene = engine.scene.get()!;
-              // Export scene as PDF (includes all pages)
-              const pdfBlob = await engine.block.export(scene, {
-                mimeType: 'application/pdf'
-              });
-              // Download using CE.SDK utils
-              await cesdk.utils.downloadFile(pdfBlob, 'application/pdf');
-            }
-          },
-          {
-            id: 'ly.img.action.navigationBar',
-            key: 'export-high-compat',
-            label: 'High Compat',
-            icon: '@imgly/Download',
-            onClick: async () => {
-              // Export scene to include all pages in the PDF
-              const scene = engine.scene.get()!;
-              // Enable high compatibility mode for consistent rendering across PDF viewers
-              // This rasterizes complex elements like gradients with transparency at scene DPI
-              const pdfBlob = await engine.block.export(scene, {
-                mimeType: 'application/pdf',
-                exportPdfWithHighCompatibility: true
-              });
-              await cesdk.utils.downloadFile(pdfBlob, 'application/pdf');
-            }
-          },
-          {
-            id: 'ly.img.action.navigationBar',
-            key: 'export-underlayer',
-            label: 'Underlayer',
-            icon: '@imgly/Download',
-            onClick: async () => {
-              // Export scene to include all pages in the PDF
-              const scene = engine.scene.get()!;
-              // Define the underlayer spot color before export
-              // RGB values (0.8, 0.8, 0.8) provide a preview representation
-              engine.editor.setSpotColorRGB('RDG_WHITE', 0.8, 0.8, 0.8);
-
-              // Export with underlayer for special media printing
-              const pdfBlob = await engine.block.export(scene, {
-                mimeType: 'application/pdf',
-                exportPdfWithHighCompatibility: true,
-                exportPdfWithUnderlayer: true,
-                underlayerSpotColorName: 'RDG_WHITE',
-                // Negative offset shrinks underlayer to prevent visible edges
-                underlayerOffset: -2.0
-              });
-              await cesdk.utils.downloadFile(pdfBlob, 'application/pdf');
-            }
-          },
-          {
-            id: 'ly.img.action.navigationBar',
-            key: 'export-a4',
-            label: 'A4 @ 300 DPI',
-            icon: '@imgly/Download',
-            onClick: async () => {
-              // Export scene to include all pages in the PDF
-              const scene = engine.scene.get()!;
-              // Export with specific dimensions for print output
-              const pdfBlob = await engine.block.export(scene, {
-                mimeType: 'application/pdf',
-                targetWidth: 2480, // A4 at 300 DPI (210mm)
-                targetHeight: 3508 // A4 at 300 DPI (297mm)
-              });
-              await cesdk.utils.downloadFile(pdfBlob, 'application/pdf');
-            }
-          },
-          {
-            id: 'ly.img.action.navigationBar',
-            key: 'export-action',
-            label: 'Export',
-            icon: '@imgly/Download',
-            onClick: () => {
-              // Run built-in export with PDF format
-              cesdk.actions.run('exportDesign', {
-                mimeType: 'application/pdf'
-              });
-            }
-          }
-        ]
-      }
+  if (choice === '3' || choice === '5') {
+    engine.editor.setSpotColorRGB('RDG_WHITE', 0.8, 0.8, 0.8);
+
+    // Export with underlayer for special media printing
+    const blob = await engine.block.export(scene, {
+      mimeType: 'application/pdf',
+      exportPdfWithHighCompatibility: true,
+      exportPdfWithUnderlayer: true,
+      underlayerSpotColorName: 'RDG_WHITE',
+      underlayerOffset: -2.0
+    });
+    const buffer = Buffer.from(await blob.arrayBuffer());
+    writeFileSync(`${outputDir}/design-with-underlayer.pdf`, buffer);
+    console.log(
+      `✓ PDF with Underlayer: ${outputDir}/design-with-underlayer.pdf (${(blob.size / 1024).toFixed(1)} KB)`
     );
   }
-}
 
-export default Example;
+  if (choice === '4' || choice === '5') {
+    // Export with specific dimensions for print output
+    const blob = await engine.block.export(scene, {
+      mimeType: 'application/pdf',
+      targetWidth: 2480,
+      targetHeight: 3508
+    });
+    const buffer = Buffer.from(await blob.arrayBuffer());
+    writeFileSync(`${outputDir}/design-a4.pdf`, buffer);
+    console.log(
+      `✓ A4 PDF: ${outputDir}/design-a4.pdf (${(blob.size / 1024).toFixed(1)} KB)`
+    );
+  }
+
+  console.log('\n✓ Export completed');
+} finally {
+  engine.dispose();
+}
 ```
 
 This guide covers exporting designs to PDF format, configuring high compatibility mode, generating underlayers with spot colors, and controlling output dimensions.
@@ -221,7 +144,7 @@ Call `engine.block.export()` with `mimeType: 'application/pdf'` to export any bl
 
 ```typescript highlight=highlight-export-pdf
 // Export scene as PDF (includes all pages)
-const pdfBlob = await engine.block.export(scene, {
+const blob = await engine.block.export(scene, {
   mimeType: 'application/pdf'
 });
 ```
@@ -234,8 +157,7 @@ Enable `exportPdfWithHighCompatibility` to rasterize complex elements like gradi
 
 ```typescript highlight=highlight-high-compatibility
 // Enable high compatibility mode for consistent rendering across PDF viewers
-// This rasterizes complex elements like gradients with transparency at scene DPI
-const pdfBlob = await engine.block.export(scene, {
+const blob = await engine.block.export(scene, {
   mimeType: 'application/pdf',
   exportPdfWithHighCompatibility: true
 });
@@ -258,8 +180,6 @@ Underlayers provide a base ink layer (typically white) for printing on transpare
 Before exporting, define a spot color that represents the underlayer ink. The RGB values provide a preview representation in PDF viewers.
 
 ```typescript highlight=highlight-spot-color
-// Define the underlayer spot color before export
-// RGB values (0.8, 0.8, 0.8) provide a preview representation
 engine.editor.setSpotColorRGB('RDG_WHITE', 0.8, 0.8, 0.8);
 ```
 
@@ -271,12 +191,11 @@ Configure the underlayer spot color name and optional offset. The `underlayerOff
 
 ```typescript highlight=highlight-underlayer
 // Export with underlayer for special media printing
-const pdfBlob = await engine.block.export(scene, {
+const blob = await engine.block.export(scene, {
   mimeType: 'application/pdf',
   exportPdfWithHighCompatibility: true,
   exportPdfWithUnderlayer: true,
   underlayerSpotColorName: 'RDG_WHITE',
-  // Negative offset shrinks underlayer to prevent visible edges
   underlayerOffset: -2.0
 });
 ```
@@ -289,10 +208,10 @@ Use `targetWidth` and `targetHeight` to control the exported PDF dimensions in p
 
 ```typescript highlight=highlight-target-size
 // Export with specific dimensions for print output
-const pdfBlob = await engine.block.export(scene, {
+const blob = await engine.block.export(scene, {
   mimeType: 'application/pdf',
-  targetWidth: 2480, // A4 at 300 DPI (210mm)
-  targetHeight: 3508 // A4 at 300 DPI (297mm)
+  targetWidth: 2480,
+  targetHeight: 3508
 });
 ```
 
@@ -301,76 +220,27 @@ For print output, calculate the target dimensions based on your desired DPI:
 - A4 at 300 DPI: 2480 × 3508 pixels
 - Letter at 300 DPI: 2550 × 3300 pixels
 
-## Built-in Export Action
-
-Run the `exportDesign` action to execute the default export flow programmatically.
-
-```typescript highlight=highlight-trigger-export
-// Run built-in export with PDF format
-cesdk.actions.run('exportDesign', {
-  mimeType: 'application/pdf'
-});
-```
-
-This executes the registered export action, which handles the complete export process including format selection and file download.
-
-## Customize Export Action
-
-Register a custom `exportDesign` action to apply PDF-specific options automatically. This lets you set defaults like high compatibility mode that apply whenever the export action runs.
-
-```typescript highlight=highlight-customize-action
-// Register a custom export action with PDF-specific options
-cesdk.actions.register('exportDesign', async () => {
-  // Export the scene block to include all pages in the PDF
-  const scene = engine.scene.get()!;
-
-  // Merge PDF-specific defaults with provided options
-  const blob = await engine.block.export(scene, {
-    mimeType: 'application/pdf',
-    exportPdfWithHighCompatibility: true
-  });
-
-  await cesdk.utils.downloadFile(blob, 'application/pdf');
-});
-```
-
-The custom action merges your PDF defaults with any options passed when the action runs. This approach centralizes export configuration and ensures consistent behavior across your application.
-
-## Download Export
-
-Use `cesdk.utils.downloadFile()` to trigger the browser's download dialog for the exported blob.
-
-```typescript highlight=highlight-download
-// Download using CE.SDK utils
-await cesdk.utils.downloadFile(pdfBlob, 'application/pdf');
-```
-
-Pass the blob and MIME type to prompt the user to save the file locally.
-
 ## PDF Export Options
 
-| Option                           | Description                                                                              |
-| -------------------------------- | ---------------------------------------------------------------------------------------- |
-| `mimeType`                       | Output format. Must be `'application/pdf'`.                                              |
-| `exportPdfWithHighCompatibility` | Rasterize complex elements at scene DPI for consistent rendering. Defaults to `true`.    |
-| `exportPdfWithUnderlayer`        | Generate an underlayer from design contours. Defaults to `false`.                        |
-| `underlayerSpotColorName`        | Spot color name for the underlayer ink. Required when `exportPdfWithUnderlayer` is true. |
-| `underlayerOffset`               | Size adjustment in design units. Negative values shrink the underlayer inward.           |
-| `targetWidth`                    | Target output width in pixels. Must be used with `targetHeight`.                         |
-| `targetHeight`                   | Target output height in pixels. Must be used with `targetWidth`.                         |
-| `abortSignal`                    | Signal to cancel the export operation.                                                   |
+| Option | Description |
+| ------ | ----------- |
+| `mimeType` | Output format. Must be `'application/pdf'`. |
+| `exportPdfWithHighCompatibility` | Rasterize complex elements at scene DPI for consistent rendering. Defaults to `true`. |
+| `exportPdfWithUnderlayer` | Generate an underlayer from design contours. Defaults to `false`. |
+| `underlayerSpotColorName` | Spot color name for the underlayer ink. Required when `exportPdfWithUnderlayer` is true. |
+| `underlayerOffset` | Size adjustment in design units. Negative values shrink the underlayer inward. |
+| `targetWidth` | Target output width in pixels. Must be used with `targetHeight`. |
+| `targetHeight` | Target output height in pixels. Must be used with `targetWidth`. |
+| `abortSignal` | Signal to cancel the export operation. |
 
 ## API Reference
 
-| Method                                         | Description                                                 |
-| ---------------------------------------------- | ----------------------------------------------------------- |
-| `engine.block.export(blockId, options)`        | Export a block as PDF with format and compatibility options |
-| `engine.editor.setSpotColorRGB(name, r, g, b)` | Define a spot color for underlayer ink                      |
-| `engine.scene.get()`                           | Get the scene for multi-page PDF export                     |
-| `engine.scene.getCurrentPage()`                | Get the current page for single-page export                 |
-| `cesdk.actions.run()`                          | Runs a built-in action like `exportDesign`                  |
-| `cesdk.actions.register()`                     | Registers a custom action to override default behavior      |
-| `cesdk.utils.downloadFile()`                   | Triggers browser download dialog for a blob                 |
+| Method | Description |
+| ------ | ----------- |
+| `engine.block.export(blockId, options)` | Export a block as PDF with format and compatibility options |
+| `engine.editor.setSpotColorRGB(name, r, g, b)` | Define a spot color for underlayer ink |
+| `engine.scene.get()` | Get the scene for multi-page PDF export |
+| `engine.scene.getCurrentPage()` | Get the current page for single-page export |
 
 ## Next Steps
 
@@ -379,11 +249,13 @@ Pass the blob and MIME type to prompt the user to save the file locally.
 - [Spot Colors](./colors/for-print/spot.md) - Define and use spot colors in designs
 - [Export Size Limits](./export-save-publish/export/size-limits.md) - Check device limits before exporting large designs
 
+
+
 ---
 
 ## More Resources
 
-- **[Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md)** - Browse all Vanilla JS/TS documentation
+- **[Node.js Documentation Index](https://img.ly/docs/cesdk/node.md)** - Browse all Node.js documentation
 - **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
-- **[Web Documentation](./js.md)** - Interactive documentation with examples
-- **[Support](mailto:support@img.ly)** - Contact IMG.LY support
+- **[Web Documentation](./node.md)** - Interactive documentation with examples
+- **[Support](mailto:support@img.ly)** - Contact IMG.LY support