@imgly/codesign-mcp 0.1.5 → 0.1.6

package/assets/docs/guide/export-save-publish/store-custom-metadata.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) > [Store Custom Metadata](./export-save-publish/store-custom-metadata.md)
 
@@ -7,42 +7,27 @@
 Attach custom key-value metadata to design blocks in CE.SDK for tracking asset
 origins, storing application state, or linking to external systems.
 
-![Store Custom Metadata example showing an image block with metadata](https://img.ly/docs/cesdk/./assets/browser.hero.webp)
-
 > **Reading time:** 5 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-store-custom-metadata-browser)
-> - [Open in StackBlitz](https://stackblitz.com/github/imgly/cesdk-web-examples/tree/v$UBQ_VERSION$/guides-export-save-publish-store-custom-metadata-browser)
-> - [Live demo](https://img.ly/docs/cesdk/examples/guides-export-save-publish-store-custom-metadata-browser/)
+>
+> - [View source on GitHub](https://github.com/imgly/cesdk-web-examples/tree/release-$UBQ_VERSION$/guides-export-save-publish-store-custom-metadata-server-js)
+>
+> - [Open in StackBlitz](https://stackblitz.com/github/imgly/cesdk-web-examples/tree/v$UBQ_VERSION$/guides-export-save-publish-store-custom-metadata-server-js)
 
 Metadata lets you attach arbitrary string key-value pairs to any design block. This data is invisible to end users but persists with the scene through save/load operations. Common use cases include tracking asset origins, storing application-specific state, and linking blocks to external databases or content management systems.
 
-```typescript file=@cesdk_web_examples/guides-export-save-publish-store-custom-metadata-browser/browser.ts reference-only
-import type { EditorPlugin, 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';
+```typescript file=@cesdk_web_examples/guides-export-save-publish-store-custom-metadata-server-js/server-js.ts reference-only
+import CreativeEngine from '@cesdk/node';
+import { config } from 'dotenv';
+
+// Load environment variables
+config();
 
 /**
- * CE.SDK Plugin: Store Custom Metadata Guide
+ * CE.SDK Server Guide: Store Custom Metadata
  *
  * Demonstrates how to attach, retrieve, and manage custom metadata on design blocks:
  * - Setting metadata key-value pairs
@@ -52,50 +37,19 @@ import packageJson from './package.json';
  * - Removing metadata
  * - Storing structured data as JSON
  */
-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());
-
-    await cesdk.actions.run('scene.create', {
-      page: { width: 800, height: 600, unit: 'Pixel' }
+async function main() {
+  // Initialize the headless Creative Engine
+  const engine = await CreativeEngine.init({
+    baseURL: process.env.IMGLY_LOCAL_ASSETS_URL
+    // license: process.env.CESDK_LICENSE
+  });
+
+  try {
+    // Create a scene with a page
+    engine.scene.create('VerticalStack', {
+      page: { size: { width: 800, height: 600 } }
     });
 
-    const engine = cesdk.engine;
     const page = engine.block.findByType('page')[0];
 
     // Create an image block to attach metadata to
@@ -161,69 +115,45 @@ class Example implements EditorPlugin {
     const remainingKeys = engine.block.findAllMetadata(imageBlock);
     console.log('Remaining metadata keys:', remainingKeys);
 
-    // Select the image block to show it in focus
-    engine.block.select(imageBlock);
-
-    console.log(
-      'Metadata guide initialized. Check the console for metadata operations.'
-    );
+    console.log('Metadata operations completed successfully!');
+  } finally {
+    // Always dispose of the engine to free resources
+    engine.dispose();
   }
 }
 
-export default Example;
+main().catch(console.error);
 ```
 
 This guide covers how to set, retrieve, list, and remove metadata on blocks, as well as how to store structured data as JSON strings.
 
 ## Initialize CE.SDK
 
-We start by initializing CE.SDK with a basic configuration. The metadata APIs are available on the `engine.block` namespace.
+We start by initializing the CE.SDK engine with a basic configuration. The metadata APIs are available on the `engine.block` namespace.
 
 ```typescript highlight-setup
-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());
-
-await cesdk.actions.run('scene.create', {
-  page: { width: 800, height: 600, unit: 'Pixel' }
-});
-
-const engine = cesdk.engine;
-const page = engine.block.findByType('page')[0];
-
-// Create an image block to attach metadata to
-const imageBlock = await engine.block.addImage(
-  'https://img.ly/static/ubq_samples/sample_1.jpg',
-  { size: { width: 400, height: 300 } }
-);
-engine.block.appendChild(page, imageBlock);
-engine.block.setPositionX(imageBlock, 200);
-engine.block.setPositionY(imageBlock, 150);
+  // Initialize the headless Creative Engine
+  const engine = await CreativeEngine.init({
+    baseURL: process.env.IMGLY_LOCAL_ASSETS_URL
+    // license: process.env.CESDK_LICENSE
+  });
+
+  try {
+    // Create a scene with a page
+    engine.scene.create('VerticalStack', {
+      page: { size: { width: 800, height: 600 } }
+    });
+
+    const page = engine.block.findByType('page')[0];
+
+    // Create an image block to attach metadata to
+    const imageBlock = await engine.block.addImage(
+      'https://img.ly/static/ubq_samples/sample_1.jpg',
+      { size: { width: 400, height: 300 } }
+    );
+    engine.block.appendChild(page, imageBlock);
+    engine.block.setPositionX(imageBlock, 200);
+    engine.block.setPositionY(imageBlock, 150);
 ```
 
 ## Set Metadata
@@ -259,15 +189,15 @@ The `hasMetadata()` method returns `true` if the block has metadata for the spec
 Use `engine.block.findAllMetadata()` to get an array of all metadata keys stored on a block.
 
 ```typescript highlight-find-all-metadata
-// List all metadata keys on the block
-const allKeys = engine.block.findAllMetadata(imageBlock);
-console.log('All metadata keys:', allKeys);
-
-// Log all key-value pairs
-for (const key of allKeys) {
-  const value = engine.block.getMetadata(imageBlock, key);
-  console.log(`  ${key}: ${value}`);
-}
+    // List all metadata keys on the block
+    const allKeys = engine.block.findAllMetadata(imageBlock);
+    console.log('All metadata keys:', allKeys);
+
+    // Log all key-value pairs
+    for (const key of allKeys) {
+      const value = engine.block.getMetadata(imageBlock, key);
+      console.log(`  ${key}: ${value}`);
+    }
 ```
 
 This is useful for iterating through all metadata on a block or debugging what metadata is attached.
@@ -277,22 +207,25 @@ This is useful for iterating through all metadata on a block or debugging what m
 Since metadata values must be strings, you can store structured data by serializing it to JSON. Parse the JSON when retrieving the data.
 
 ```typescript highlight-store-structured-data
-// Store structured data as JSON
-const generationInfo = {
-  source: 'ai-generated',
-  model: 'stable-diffusion',
-  timestamp: Date.now()
-};
-engine.block.setMetadata(
-  imageBlock,
-  'generationInfo',
-  JSON.stringify(generationInfo)
-);
-
-// Retrieve and parse structured data
-const retrievedJson = engine.block.getMetadata(imageBlock, 'generationInfo');
-const parsedInfo = JSON.parse(retrievedJson);
-console.log('Parsed generation info:', parsedInfo);
+    // Store structured data as JSON
+    const generationInfo = {
+      source: 'ai-generated',
+      model: 'stable-diffusion',
+      timestamp: Date.now()
+    };
+    engine.block.setMetadata(
+      imageBlock,
+      'generationInfo',
+      JSON.stringify(generationInfo)
+    );
+
+    // Retrieve and parse structured data
+    const retrievedJson = engine.block.getMetadata(
+      imageBlock,
+      'generationInfo'
+    );
+    const parsedInfo = JSON.parse(retrievedJson);
+    console.log('Parsed generation info:', parsedInfo);
 ```
 
 This pattern lets you store complex objects like configuration settings, generation parameters, or any structured information that can be serialized to JSON.
@@ -310,13 +243,13 @@ console.log('Removed metadata key: uploadedBy');
 After removal, you can verify the key was deleted by checking with `hasMetadata()`.
 
 ```typescript highlight-verify-removal
-// Verify the key was removed
-const hasUploadedBy = engine.block.hasMetadata(imageBlock, 'uploadedBy');
-console.log('Has uploadedBy after removal:', hasUploadedBy);
+    // Verify the key was removed
+    const hasUploadedBy = engine.block.hasMetadata(imageBlock, 'uploadedBy');
+    console.log('Has uploadedBy after removal:', hasUploadedBy);
 
-// List remaining keys
-const remainingKeys = engine.block.findAllMetadata(imageBlock);
-console.log('Remaining metadata keys:', remainingKeys);
+    // List remaining keys
+    const remainingKeys = engine.block.findAllMetadata(imageBlock);
+    console.log('Remaining metadata keys:', remainingKeys);
 ```
 
 ## Metadata Persistence
@@ -349,19 +282,21 @@ Metadata is designed for small strings. Very large values may impact performance
 
 ## API Reference
 
-| Method                                        | Description                              |
-| --------------------------------------------- | ---------------------------------------- |
-| `engine.block.setMetadata(block, key, value)` | Set a metadata key-value pair on a block |
-| `engine.block.getMetadata(block, key)`        | Get the value for a metadata key         |
-| `engine.block.hasMetadata(block, key)`        | Check if a metadata key exists           |
-| `engine.block.findAllMetadata(block)`         | List all metadata keys on a block        |
-| `engine.block.removeMetadata(block, key)`     | Remove a metadata key-value pair         |
+| Method                                        | Description                               |
+| --------------------------------------------- | ----------------------------------------- |
+| `engine.block.setMetadata(block, key, value)` | Set a metadata key-value pair on a block  |
+| `engine.block.getMetadata(block, key)`        | Get the value for a metadata key          |
+| `engine.block.hasMetadata(block, key)`        | Check if a metadata key exists            |
+| `engine.block.findAllMetadata(block)`         | List all metadata keys on a block         |
+| `engine.block.removeMetadata(block, key)`     | Remove a metadata key-value pair          |
+
+
 
 ---
 
 ## 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/file-format-support.md

@@ -1,9 +1,13 @@
-> 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:** [Compatibility & Security](./compatibility.md) > [File Format Support](./file-format-support.md)
 
 ---
 
+CreativeEditor SDK (CE.SDK) supports a wide range of modern file types for importing assets and exporting final content. Whether you're working with images, documents, or fonts, CE.SDK provides an editing environment with excellent media compatibility and performance—optimized for modern hardware.
+
+This guide outlines supported formats and known limitations across media types.
+
 ## Importing Media
 
 ### SVG Limitations
@@ -14,21 +18,17 @@
 
 ## Font Formats
 
-## Video & Audio Codecs
-
-CE.SDK supports the most widely adopted video and audio codecs to ensure compatibility across platforms:
-
 ## Size Limits
 
 ### Image Resolution Limits
 
-### Video Resolution & Duration Limits
+
 
 ---
 
 ## 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