@imgly/codesign-mcp 0.1.5 → 0.1.7

package/assets/docs/guide/get-started/bun.md

@@ -0,0 +1,219 @@
+> 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:** [Get Started](./get-started/overview.md) > [Quickstart Bun](./get-started/bun.md)
+
+---
+
+This guide walks you through integrating the **CreativeEditor SDK (CE.SDK)
+Engine** in a **Node.js environment using Bun** as the package manager and
+runtime. By the end of this guide, you’ll have a working Node.js script that
+**loads a scene, modifies it, and exports it as an image** using **Bun’s fast
+runtime and bundling capabilities**.
+
+<CesdkOverview />
+
+## Who Is This Guide For?
+
+This guide is for developers who:
+
+- Need to **perform image editing and scene manipulation programmatically** in a **Node.js environment** using **Bun**.
+- Want to use **CE.SDK’s Node.js package** for automation or backend processing **with a fast, modern runtime**.
+
+## What You’ll Achieve
+
+- Install and configure **CE.SDK Engine** for **Node.js using Bun**.
+- Load and manipulate **design scenes** programmatically.
+- Export designs as **PNG images** without requiring a UI.
+
+## Prerequisites
+
+Before getting started, ensure you have:
+
+- [**Bun installed**](https://bun.sh/) (Download Bun).
+- A valid **CE.SDK license key** ([Get a free trial](https://img.ly/forms/free-trial)).
+
+> **Warning:** Node.js executable isn't capable of processing or exporting video.
+
+## Step 1: Set Up Your Project
+
+Initialize your project with Bun, selecting "Blank" for the template:
+
+```bash
+bun init my-cesdk-bun-project
+```
+
+Your project structure should look like this:
+
+```
+/my-cesdk-bun-project
+  ├── node_modules
+  ├── .gitignore
+  ├── bun.lock
+  ├── index.ts
+  ├── package.json
+  ├── README.md
+  └── tsconfig.json
+```
+
+## Step 2: Install CE.SDK for Node.js Using Bun
+
+Navigate into your project folder and install the required packages:
+
+```bash
+# Install the CE.SDK Node.js package with Bun
+bun add @cesdk/node
+```
+
+### index.ts (TypeScript with Bun)
+
+Modify your `index.ts` file to initialize CE.SDK Engine and process a scene **using Bun**:
+
+> **Warning:** **Important**: You must replace `'YOUR_LICENSE_KEY'` with your actual CE.SDK
+> license key. The script fails with initialization errors without a valid
+> license key. [Get a free trial license key](https://img.ly/forms/free-trial).
+
+```tsx
+import { writeFile } from 'fs/promises';
+import CreativeEngine from '@cesdk/node';
+
+const { MimeType } = CreativeEngine as any;
+
+// Configuration for the engine
+const config = {
+  // license: 'YOUR_CESDK_LICENSE_KEY', // Replace with your CE.SDK license key
+  baseURL: `https://cdn.img.ly/packages/imgly/cesdk-node/${CreativeEngine.version}/assets`,
+};
+
+// Initialize CE.SDK Engine
+CreativeEngine.init(config).then(async engine => {
+  console.log('CE.SDK Engine initialized');
+
+  try {
+    // Load a scene from a URL
+    await engine.scene.loadFromURL(
+      'https://cdn.img.ly/assets/demo/v3/ly.img.template/templates/cesdk_instagram_photo_1.scene',
+    );
+
+    // Find the first page in the scene
+    const [page] = engine.block.findByType('page');
+
+    // Export the scene as a PNG image
+    const blob = await engine.block.export(page, {
+      mimeType: 'image/png',
+    });
+    const arrayBuffer = await blob.arrayBuffer();
+
+    // Save the exported image to the file system
+    await writeFile('./example-output.png', Buffer.from(arrayBuffer));
+
+    console.log('Export completed: example-output.png');
+  } catch (error) {
+    console.error('Error processing scene:', error);
+  } finally {
+    // Dispose of the engine to free resources
+    engine.dispose();
+  }
+});
+```
+
+## Step 3: Run the Script Using Bun
+
+Once everything is set up, run your script using:
+
+```bash
+bun run index.ts
+```
+
+This processes the scene and generates an image file named **`example-output.png`** in your project directory.
+
+## Step 4: Optimize Your Bun Project
+
+### 1. Using Bun’s Faster File System API
+
+Bun includes a built-in **fs API** that performs better than Node.js. Replace your existing `index.ts` with this:
+
+```tsx
+import { write } from 'bun';
+import CreativeEngine from '@cesdk/node';
+
+const { MimeType } = CreativeEngine as any;
+
+// Configuration for the engine
+const config = {
+  // license: 'YOUR_CESDK_LICENSE_KEY', // Replace with your CE.SDK license key
+  baseURL: `https://cdn.img.ly/packages/imgly/cesdk-node/${CreativeEngine.version}/assets`,
+};
+
+// Initialize CE.SDK Engine
+CreativeEngine.init(config).then(async engine => {
+  console.log('CE.SDK Engine initialized');
+
+  try {
+    // Load a scene from a URL
+    await engine.scene.loadFromURL(
+      'https://cdn.img.ly/assets/demo/v3/ly.img.template/templates/cesdk_instagram_photo_1.scene',
+    );
+
+    // Find the first page in the scene
+    const [page] = engine.block.findByType('page');
+
+    // Export the scene as a PNG image
+    const blob = await engine.block.export(page, { mimeType: 'image/png' });
+    const arrayBuffer = await blob.arrayBuffer();
+
+    // Save the exported image to the file system
+    await write('./example-output.png', Buffer.from(arrayBuffer));
+
+    console.log('Export completed: example-output.png');
+  } catch (error) {
+    console.error('Error processing scene:', error);
+  } finally {
+    // Dispose of the engine to free resources
+    engine.dispose();
+  }
+});
+```
+
+### 2. Running the Bun Optimized Script
+
+```bash
+bun run index.ts
+```
+
+## Troubleshooting & Common Errors
+
+**❌ Error: `fetch is not defined`**
+
+- **Bun natively supports `fetch`**, so this error **should not occur** unless using an outdated version.
+
+**❌ Error: `Invalid license key`**
+
+- Verify that your **license key** is correct and not expired.
+
+**❌ Error: `Cannot find module '@cesdk/node'`**
+
+- Ensure that **@cesdk/node** is installed correctly using `bun add @cesdk/node`.
+
+**❌ Error: `SyntaxError: Unexpected token 'import'`**
+
+- Ensure your script is named **index.ts** for **TypeScript** support in Bun.
+
+## Next Steps
+
+Congratulations! You’ve successfully integrated **CE.SDK Engine in Node.js using Bun**. Next, explore:
+
+- [Using source sets](./import-media/source-sets.md)
+- [Modifying text variables](./create-templates/add-dynamic-content/text-variables.md)
+- [Defining placeholders](./create-templates/add-dynamic-content/placeholders.md)
+- [Text styling](./text/styling.md)
+
+
+
+---
+
+## More Resources
+
+- **[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](./node.md)** - Interactive documentation with examples
+- **[Support](mailto:support@img.ly)** - Contact IMG.LY support

package/assets/docs/guide/get-started/deno.md

@@ -0,0 +1,161 @@
+> 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:** [Get Started](./get-started/overview.md) > [Quickstart Deno](./get-started/deno.md)
+
+---
+
+This guide walks you through integrating the **CreativeEditor SDK (CE.SDK)
+Engine** in a **Node.js-compatible environment using Deno**, the secure and
+modern runtime for JavaScript and TypeScript. By the end of this guide, you’ll
+have a Deno script that **loads a scene, modifies it, and exports it as an
+image**—all without a UI.
+
+<CesdkOverview />
+
+## Who Is This Guide For?
+
+This guide is for developers who:
+
+- Want to **programmatically edit and export scenes** using CE.SDK in **Deno**.
+- Prefer a **secure and modern runtime** with built-in TypeScript and native fetch support.
+- Need to integrate CE.SDK into **server-side rendering, automation tools, or cloud functions** using Deno.
+
+## What You’ll Achieve
+
+- Install and configure **CE.SDK Engine** in a **Deno project**.
+- Load and manipulate **design scenes** programmatically.
+- Export scenes to **PNG images** without any UI.
+
+## Prerequisites
+
+Before getting started, ensure you have:
+
+- **Deno installed**.
+- A valid **CE.SDK license key** ([Get a free trial](https://img.ly/forms/free-trial)).
+- **Deno v1.28 or later** to ensure compatibility with npm packages.
+
+> **Note:** Node.js executable isn't capable of processing or exporting video.
+
+## Step 1: Initialize Your Deno Project
+
+Create your project structure:
+
+```bash
+deno init my_project
+```
+
+Resulting in the following project structure:
+
+```
+my_project
+├── deno.json
+├── main_test.ts
+└── main.ts
+```
+
+## Step 2: Use CE.SDK Engine via npm Compatibility
+
+In your `main.ts`, use Deno’s npm compatibility to load CE.SDK:
+
+```tsx
+// @deno-types="npm:@cesdk/node"
+import CreativeEngine from 'npm:@cesdk/node';
+import { writeFile } from 'node:fs/promises';
+
+// Fix for TypeScript type resolution in Deno
+const { MimeType } = CreativeEngine as any;
+
+// CE.SDK configuration
+const config = {
+  // license: 'YOUR_CESDK_LICENSE_KEY', // Enter your CE.SDK license key
+  baseURL: `https://cdn.img.ly/packages/imgly/cesdk-node/${CreativeEngine.version}/assets`,
+};
+
+try {
+  const engine = await CreativeEngine.init(config);
+  console.log('CE.SDK Engine initialized (Deno)');
+
+  try {
+    await engine.scene.loadFromURL(
+      'https://cdn.img.ly/assets/demo/v3/ly.img.template/templates/cesdk_instagram_photo_1.scene',
+    );
+
+    const [page] = engine.block.findByType('page');
+
+    const blob = await engine.block.export(page, { mimeType: 'image/png' });
+    const arrayBuffer = await blob.arrayBuffer();
+
+    await writeFile('./example-output.png', new Uint8Array(arrayBuffer));
+    console.log('Export completed: example-output.png');
+  } catch (err) {
+    console.error('Error:', err);
+  } finally {
+    engine.dispose();
+  }
+} catch (initError) {
+  console.error('Failed to initialize CE.SDK Engine:', initError);
+}
+```
+
+> **Warning:** **Important**: You must replace `'YOUR_LICENSE_KEY'` with your actual CE.SDK
+> license key. The script fails with initialization errors without a valid
+> license key. [Get a free trial license key](https://img.ly/forms/free-trial).
+
+## Step 3: Run the Script
+
+Run the script using Deno’s Node.js/npm compatibility by adding the necessary flags:
+
+```bash
+deno run \
+  --allow-read \
+  --allow-write \
+  --allow-net \
+  --unstable-ffi \
+  main.ts
+```
+
+These flags are required to execute `main.ts` for the following reasons:
+
+| Flag             | Required | Why                                                                                                        |
+| ---------------- | -------- | ---------------------------------------------------------------------------------------------------------- |
+| `--allow-read`   | Yes      | Grants permission to read from the file system. Useful if the engine loads local assets or template files. |
+| `--allow-write`  | Yes      | Allows CE.SDK to write the exported image file (`example-output.png`) to disk.                             |
+| `--allow-net`    | Yes      | Required to fetch remote assets and scenes (e.g., from `cdn.img.ly`).                                      |
+| `--unstable-ffi` | Yes      | Enables WebAssembly FFI, which CE.SDK Engine depends on for core rendering and export features.            |
+
+This processes the scene and generates an image file named `example-output.png` in your project directory.
+
+## Troubleshooting & Common Errors
+
+**❌ Error: `Cannot find module '@cesdk/node'`**
+
+- Make sure you’re running with the `-unstable` flag and Deno v1.28 or later.
+- Add `deno.json` or `import_map.json` if managing multiple npm dependencies.
+
+**❌ Error: `Invalid license key`**
+
+- Ensure your license key is correct and not expired.
+
+**❌ TypeScript errors for `MimeType`**
+
+- Use `CreativeEngine as any` or assert type manually to bypass missing type declarations.
+
+## Next Steps
+
+You’ve successfully integrated **CE.SDK Engine in Deno**. Now explore:
+
+- [Using source sets](./import-media/source-sets.md)
+- [Modifying text variables](./create-templates/add-dynamic-content/text-variables.md)
+- [Defining placeholders](./create-templates/add-dynamic-content/placeholders.md)
+- [Text styling](./text/styling.md)
+
+
+
+---
+
+## More Resources
+
+- **[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](./node.md)** - Interactive documentation with examples
+- **[Support](mailto:support@img.ly)** - Contact IMG.LY support

package/assets/docs/guide/get-started/mcp-server.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:** [Get Started](./get-started/overview.md) > [Build with AI](./get-started/build-with-ai.md) > [MCP Server](./get-started/mcp-server.md)
 
@@ -109,11 +109,13 @@ Once configured, your AI assistant will automatically have access to CE.SDK docu
 
 The AI will search our documentation and provide answers based on the latest CE.SDK guides and API references.
 
+
+
 ---
 
 ## 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

package/assets/docs/guide/get-started/overview.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:** [Get Started](./get-started/overview.md)
 
@@ -8,21 +8,26 @@ Everything you need to integrate CE.SDK into your application. Learn what the
 SDK offers, get up and running with starter kits, explore AI-powered
 workflows, and understand our licensing model.
 
+
+
 ---
 
 ## Related Pages
 
-- [Javascript Creative Editor SDK](./what-is-cesdk.md) - CreativeEditor SDK offers a fully-featured JavaScript library for creating and editing rich visual designs directly within the browser.
+- [Node.js Creative Engine](./what-is-cesdk.md) - Learn what CE.SDK is, how it works, and what you can build with its headless API, and real-time design engine.
 - [Capabilities](./capabilities.md) - Explore the full list of CE.SDK capabilities available for your platform, including design, video, image, text, and more.
-- [Quickstart](./get-started/vanilla-js/quickstart.md) - Get started with CE.SDK by choosing a starter kit
+- [Node.js - New Project](./get-started/vanilla.md) - Getting started with CE.SDK Engine in Node.js using Vanilla JS
+- [Deno](./get-started/deno.md) - Getting started with CE.SDK Engine in Node.js using Deno
+- [Bun](./get-started/bun.md) - Getting started with CE.SDK Engine in Node.js using Bun
 - [Build with AI](./get-started/build-with-ai.md) - Give your AI coding assistant context about CE.SDK to generate accurate code and get instant answers.
 - [Licensing](./licensing.md) - Understand CE.SDK’s flexible licensing, trial options, and how keys work across dev, staging, and production.
 
+
 ---
 
 ## 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