@imgly/codesign-mcp 0.1.5 → 0.1.6

package/assets/docs/guide/starterkits/airtable-image-editor.md

@@ -1,672 +0,0 @@
-> 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).
-
-**Navigation:** [Starter Kits](./starterkits.md) > [Assets](./starterkits/assets.md) > [Airtable Image Editor](./starterkits/airtable-image-editor.md)
-
----
-
-CE.SDK can include assets from third-party libraries accessible via API. Search and browse images from an Airtable spreadsheet in the editor.
-
-![Airtable Image Editor starter kit showing custom Airtable image integration](https://img.ly/docs/cesdk/./assets/browser.hero.webp)
-
-> **Reading time:** 10 minutes
->
-> **Resources:**
->
-> - [Download examples](https://github.com/imgly/starterkit-airtable-asset-source-react-web/archive/refs/tags/release-$UBQ_VERSION$.zip)
-> - [View source on GitHub](https://github.com/imgly/starterkit-airtable-asset-source-react-web/tree/release-$UBQ_VERSION$)
-> - [Open in StackBlitz](https://stackblitz.com/github/imgly/starterkit-airtable-asset-source-react-web/tree/release-$UBQ_VERSION$)
-> - [Live demo](https://img.ly/docs/cesdk/examples/starterkit-airtable-asset-source/)
-
----
-
-## Prerequisites
-
-Before you begin, make sure you have the following:
-
-- **Node.js v20+** and npm installed locally – [Download Node.js](https://nodejs.org/)
-- **Airtable API Key** – Get your API key from your [Airtable account settings](https://support.airtable.com/docs/creating-and-using-api-keys-and-access-tokens)
-- A **supported browser** – Chrome 114+, Edge 114+, Firefox 115+, Safari 15.6+<br />
-  See [Browser Support](./browser-support.md) for the full list.
-
----
-
-<Tabs syncKey="project-type">
-  <TabItem label="New Project">
-    ## Get Started
-
-    Run the Airtable Image Editor starter kit directly with Vite.
-
-    ## Step 1: Clone the Starter Kit
-
-    <TerminalTabs>
-      <TerminalTab label="git">
-        git clone https://github.com/imgly/starterkit-airtable-asset-source-react-web.git
-        cd starterkit-airtable-asset-source-react-web
-      </TerminalTab>
-
-      <TerminalTab label="degit">
-        npx degit imgly/starterkit-airtable-asset-source-react-web my-project
-        cd my-project
-      </TerminalTab>
-    </TerminalTabs>
-
-    ## Step 2: Configure Airtable API Key
-
-    Copy the example environment file and add your Airtable API key:
-
-    <TerminalTabs>
-      <TerminalTab label="bash">
-        cp .env.example .env
-
-        # Edit .env and add your VITE\_AIRTABLE\_API\_KEY
-      </TerminalTab>
-    </TerminalTabs>
-
-    Get your API key from your [Airtable account settings](https://support.airtable.com/docs/creating-and-using-api-keys-and-access-tokens).
-
-    ## Step 3: Install Dependencies
-
-    <TerminalTabs syncKey="package-manager">
-      <TerminalTab label="npm">npm install</TerminalTab>
-      <TerminalTab label="pnpm">pnpm install</TerminalTab>
-      <TerminalTab label="yarn">yarn install</TerminalTab>
-    </TerminalTabs>
-
-    ## Step 4: Download Assets
-
-    CE.SDK requires engine assets (fonts, icons, UI elements) to function. These must be served as static files from your project's `public/` directory.
-
-    <TerminalTabs>
-      <TerminalTab label="Download">
-        curl -O https://cdn.img.ly/packages/imgly/cesdk-js/$UBQ\_VERSION$/imgly-assets.zip
-        unzip imgly-assets.zip -d public/
-        rm imgly-assets.zip
-      </TerminalTab>
-    </TerminalTabs>
-
-    ## Step 5: Run the Development Server
-
-    <TerminalTabs syncKey="package-manager">
-      <TerminalTab label="npm">npm run dev</TerminalTab>
-      <TerminalTab label="pnpm">pnpm dev</TerminalTab>
-      <TerminalTab label="yarn">yarn dev</TerminalTab>
-    </TerminalTabs>
-
-    Open `http://localhost:5173` in your browser. Click "Airtable" in the dock to search and browse your Airtable images.
-
-  </TabItem>
-
-  <TabItem label="Existing Project">
-    ## Get Started
-
-    Integrate the Airtable Image Editor into an existing vanilla JavaScript/TypeScript project. This adds the editor configuration and Airtable asset source to your current project structure.
-
-    ## Step 1: Clone
-
-    <TerminalTabs>
-      <TerminalTab label="Navigate">
-        cd your-project
-      </TerminalTab>
-    </TerminalTabs>
-
-    Clone the starter kit and copy the editor configuration to your project:
-
-    <TerminalTabs>
-      <TerminalTab label="git">
-        git clone https://github.com/imgly/starterkit-airtable-asset-source-react-web.git
-        cp -r starterkit-airtable-asset-source-react-web/src/imgly ./src/imgly
-        rm -rf starterkit-airtable-asset-source-react-web
-      </TerminalTab>
-
-      <TerminalTab label="degit">
-        npx degit imgly/starterkit-airtable-asset-source-react-web/src/imgly ./src/imgly
-      </TerminalTab>
-    </TerminalTabs>
-
-    > **Adjust Path:** The default destination is `./src/imgly`. Adjust the path to match your project structure.
-
-    The `imgly/` folder contains the editor configuration:
-
-    ```
-    imgly/
-    ├── config/
-    │   ├── actions.ts                # Export/import actions
-    │   ├── features.ts               # Feature toggles
-    │   ├── i18n.ts                   # Translations
-    │   ├── plugin.ts                 # Main configuration plugin
-    │   ├── settings.ts               # Engine settings
-    │   └── ui/
-    │       ├── canvas.ts                 # Canvas configuration
-    │       ├── components.ts             # Custom component registration
-    │       ├── dock.ts                   # Dock layout configuration
-    │       ├── index.ts                  # Combines UI customization exports
-    │       ├── inspectorBar.ts           # Inspector bar layout
-    │       ├── navigationBar.ts          # Navigation bar layout
-    │       └── panel.ts                  # Panel configuration
-    ├── index.ts                  # Editor initialization function
-    └── plugins/
-        └── airtable.ts
-    ```
-
-    ## Step 2: Install Dependencies
-
-    Install the required packages for the editor:
-
-    ### Core Editor
-
-    Install the Creative Editor SDK:
-
-    <TerminalTabs syncKey="package-manager">
-      <TerminalTab label="npm">npm install @cesdk/cesdk-js@$UBQ\_VERSION$</TerminalTab>
-      <TerminalTab label="pnpm">pnpm add @cesdk/cesdk-js@$UBQ\_VERSION$</TerminalTab>
-      <TerminalTab label="yarn">yarn add @cesdk/cesdk-js@$UBQ\_VERSION$</TerminalTab>
-    </TerminalTabs>
-
-    ### Airtable Integration
-
-    Install the Airtable JavaScript SDK:
-
-    <TerminalTabs syncKey="package-manager">
-      <TerminalTab label="npm">npm install airtable</TerminalTab>
-      <TerminalTab label="pnpm">pnpm add airtable</TerminalTab>
-      <TerminalTab label="yarn">yarn add airtable</TerminalTab>
-    </TerminalTabs>
-
-    ## Step 3: Configure Airtable API Key
-
-    Set your Airtable API key in one of two ways:
-
-    **Environment Variable (Recommended)**
-
-    ```bash
-    # In your .env file
-    VITE_AIRTABLE_API_KEY=your_api_key_here
-    ```
-
-    **Programmatically**
-
-    ```typescript
-    await initAirtableImageEditor(cesdk, {
-      airtableApiKey: 'your_api_key_here'
-    });
-    ```
-
-    ## Step 4: Download Assets
-
-    CE.SDK requires engine assets (fonts, icons, UI elements) to function. These must be served as static files from your project's `public/` directory.
-
-    <TerminalTabs>
-      <TerminalTab label="Download">
-        curl -O https://cdn.img.ly/packages/imgly/cesdk-js/$UBQ\_VERSION$/imgly-assets.zip
-        unzip imgly-assets.zip -d public/
-        rm imgly-assets.zip
-      </TerminalTab>
-    </TerminalTabs>
-
-    > **Asset Configuration:** The starter kit is pre-configured to load assets from `/assets`. If you place assets in a different location, update the `baseURL` in Step 5: Add a Container Element.
-
-    ## Step 5: Add a Container Element
-
-    Add a container element to your HTML where the editor will be mounted:
-
-    ```html
-    <div id="cesdk_container" style="width: 100%; height: 100vh;"></div>
-    ```
-
-    ## Step 6: Initialize the Editor
-
-    Import and call the initialization function from your entry point:
-
-    ```typescript title="src/index.ts"
-    import CreativeEditorSDK from '@cesdk/cesdk-js';
-    import { initAirtableImageEditor } from './imgly';
-
-    // Get your API key from your Airtable account settings
-    const AIRTABLE_API_KEY = 'YOUR_AIRTABLE_API_KEY';
-
-    const config = {
-      baseURL: '/assets'
-    };
-
-    CreativeEditorSDK.create('#cesdk_container', config)
-      .then(async (cesdk) => {
-        await initAirtableImageEditor(cesdk, { airtableApiKey: AIRTABLE_API_KEY });
-      })
-      .catch((error) => {
-        console.error('Failed to initialize CE.SDK:', error);
-      });
-    ```
-
-  </TabItem>
-</Tabs>
-
-## Using Airtable
-
-The editor integrates Airtable as a custom image source, replacing the default image library.
-
-### Browsing Images
-
-1. Click the "Airtable" button in the dock (left sidebar)
-2. The Airtable library opens showing images from your database
-3. Click any image to add it to your design
-
-### Searching Images
-
-1. Open the Airtable library
-2. Use the search bar at the top of the panel
-3. Type your search query and press Enter
-4. Browse results and click to add images
-
-### Replacing Images
-
-1. Select an existing image in your design
-2. Click "Replace" in the inspector
-3. The Airtable library opens automatically
-4. Select a new image to replace the current one
-
-> **Airtable Setup:** The starter kit uses a demo Airtable database. To use your own database, update the `databaseId` in the plugin options. Your database should have an "Asset sources" table with Name and Image fields.
-
-## Set Up a Scene
-
-CE.SDK offers multiple ways to load content into the editor. Choose the method that matches your use case:
-
-```typescript title="src/index.ts"
-// Create a blank design canvas - starts with an empty design scene
-await cesdk.actions.run('scene.create');
-
-// Load from a template archive - restores a previously saved project
-await cesdk.loadFromArchiveURL('https://example.com/template.zip');
-
-// Load from an image URL - creates a new scene with the image
-await cesdk.createFromImage('https://example.com/image.jpg');
-
-// Load from a scene file - restores a scene from JSON
-await cesdk.loadFromURL('https://example.com/scene.json');
-```
-
-The `createDesignScene()` method is ideal for design workflows, as it creates a blank canvas ready for content.
-
-> **More Loading Options:** See [Open the Editor](./open-the-editor.md) for all available loading methods.
-
-## Customize the Airtable Integration
-
-The Airtable asset source plugin can be customized by modifying `src/imgly/plugins/airtable.ts`:
-
-```typescript title="src/imgly/plugins/airtable.ts"
-export class AirtableAssetSourcePlugin implements EditorPlugin {
-  name = 'cesdk-airtable-asset-source';
-  version = CreativeEditorSDK.version;
-
-  private options: AirtableAssetSourcePluginOptions;
-
-  constructor(options: AirtableAssetSourcePluginOptions = {}) {
-    this.options = options;
-  }
-
-  async initialize({ cesdk }: EditorPluginContext): Promise<void> {
-    // Use API key from options
-    const apiKey = this.options.apiKey ?? '';
-    const databaseId = this.options.databaseId ?? 'appHAZoD6Qj3teOmr';
-
-    // Create and add the asset source
-    const airtableAssetSource = createAirtableAssetSource(apiKey, databaseId);
-    cesdk.engine.asset.addSource(airtableAssetSource);
-
-    // Configure dock to show Airtable instead of default images
-    const currentDockOrder = cesdk.ui.getDockOrder();
-    cesdk.ui.setDockOrder(
-      currentDockOrder.map((component) => {
-        if (component.key === 'ly.img.image') {
-          return {
-            id: 'ly.img.assetLibrary.dock',
-            key: 'airtable',
-            label: 'libraries.airtable.label',
-            entries: ['airtable']
-          };
-        }
-        return component;
-      })
-    );
-  }
-}
-```
-
-> **Asset Source Plugins:** See [Asset Source Plugins](./plugins/asset-sources.md) for building your own asset integrations.
-
-## Configure Actions
-
-Actions are functions that handle user interactions like exporting designs, saving scenes, and importing files. CE.SDK provides built-in actions that you can run directly or override with custom implementations.
-
-**Key built-in actions:**
-
-- `exportDesign` – Export the current design to PNG, JPEG, PDF, or other formats
-- `saveScene` – Save the scene as a JSON string for later editing
-- `importScene` – Import a previously saved scene (supports `.scene` and `.cesdk` formats)
-- `exportScene` – Export the scene as a JSON file or `.cesdk` archive with all assets
-- `uploadFile` – Handle file uploads with progress tracking
-
-Use `cesdk.actions.run()` to execute any action:
-
-```typescript
-// Run a built-in action
-await cesdk.actions.run('exportDesign', { mimeType: 'image/png' });
-```
-
-#### Import from File Picker
-
-```typescript title="src/imgly/config/actions.ts"
-// Let users open images from their device
-cesdk.actions.register('importImage', async () => {
-  const blobURL = await cesdk.utils.loadFile({
-    accept: 'image/*',
-    returnType: 'objectURL'
-  });
-  await cesdk.createFromImage(blobURL);
-});
-```
-
-#### Export and Save
-
-```typescript title="src/imgly/config/actions.ts"
-// Register export action that downloads the edited design
-cesdk.actions.register('exportDesign', async (exportOptions) => {
-  const { blobs, options } = await cesdk.utils.export(exportOptions);
-  await cesdk.utils.downloadFile(blobs[0], options.mimeType);
-});
-```
-
-#### Upload to Your Backend
-
-```typescript title="src/imgly/config/actions.ts"
-// Override the built-in exportDesign action to send to your server
-cesdk.actions.register('exportDesign', async (exportOptions) => {
-  const { blobs } = await cesdk.utils.export(exportOptions);
-
-  const formData = new FormData();
-  formData.append('design', blobs[0], 'design.png');
-
-  const response = await fetch('/api/upload', {
-    method: 'POST',
-    body: formData
-  });
-
-  const { url } = await response.json();
-  console.log('Uploaded to:', url);
-});
-```
-
-> **Learn More:** See [Actions](./actions.md) for the full list of built-in actions, how to run them, and how to register custom actions.
-
----
-
-## Customize (Optional)
-
-### Theming
-
-CE.SDK supports light and dark themes out of the box, plus automatic system preference detection. Switch between themes programmatically:
-
-```typescript title="src/imgly/config/settings.ts"
-// 'light' | 'dark' | 'system' | (() => 'light' | 'dark')
-cesdk.ui.setTheme('dark');
-```
-
-See [Theming](./user-interface/appearance/theming.md) for custom color schemes, CSS variables, and advanced styling options.
-
-### Localization
-
-Customize UI labels and add support for multiple languages. The i18n system supports translation keys for all UI elements:
-
-```typescript title="src/imgly/config/i18n.ts"
-// Override specific labels
-cesdk.i18n.setTranslations({
-  en: {
-    'libraries.airtable.label': 'My Images',
-    'actions.export.image': 'Download Design',
-    'common.cancel': 'Cancel',
-    'common.apply': 'Apply'
-  }
-});
-
-// Add a new language
-cesdk.i18n.setTranslations({
-  de: {
-    'libraries.airtable.label': 'Meine Bilder',
-    'actions.export.image': 'Design herunterladen'
-  }
-});
-
-// Set the active locale
-cesdk.i18n.setLocale('de');
-```
-
-See [Localization](./user-interface/localization.md) for supported languages, translation key reference, and right-to-left language support.
-
-### UI Layout
-
-![CE.SDK Editor UI Areas](https://img.ly/docs/cesdk/../_shared/assets/CESDK-UI.png)
-
-Customize the editor interface by modifying the dock, inspector bar, navigation bar, and canvas menu. CE.SDK provides Order APIs to control which components appear and in what sequence.
-
-```typescript title="src/imgly/config/ui/navigationBar.ts"
-// Get current navigation bar components
-const navOrder = cesdk.ui.getNavigationBarOrder();
-
-// Add a custom button to the navigation bar
-cesdk.ui.insertNavigationBarOrderComponent(
-  'ly.img.spacer',
-  { id: 'my-custom-action' },
-  'after'
-);
-
-// Rearrange dock items
-cesdk.ui.setDockOrder([
-  'ly.img.assetLibrary.dock',
-  'ly.img.separator',
-  'my-custom-dock-item'
-]);
-```
-
-See [Dock](./user-interface/customization/dock.md), [Inspector Bar](./user-interface/customization/inspector-bar.md), [Navigation Bar](./user-interface/customization/navigation-bar.md), [Canvas Menu](./user-interface/customization/canvas-menu.md), and [Canvas](./user-interface/customization/canvas.md) for detailed layout customization options.
-
-### Custom Components
-
-Build custom UI components using the builder system and integrate them in the editor. Custom components receive reactive state updates and can interact with the engine API.
-
-```typescript title="src/imgly/config/ui/components.ts"
-// Register a custom component
-cesdk.ui.registerComponent('my-custom-button', ({ builder, engine }) => {
-  const selectedBlocks = engine.block.findAllSelected();
-
-  builder.Button('apply-effect', {
-    label: 'Apply Effect',
-    isDisabled: selectedBlocks.length === 0,
-    onClick: () => {
-      // Apply custom logic to selected blocks
-    }
-  });
-});
-
-// Add the component to the navigation bar
-cesdk.ui.insertNavigationBarOrderComponent(
-  'ly.img.spacer',
-  'my-custom-button',
-  'after'
-);
-```
-
-Custom components automatically re-render when the engine state they depend on changes—no manual subscription management required.
-
-See [Register New Component](./user-interface/ui-extensions/register-new-component.md) for the complete builder API and component patterns.
-
-### Settings & Features
-
-Fine-tune editor behavior through settings and features.
-
-**Settings** configure core engine behavior—rendering, input handling, and history management:
-
-```typescript title="src/imgly/config/settings.ts"
-cesdk.engine.editor.setSettingBool('page/dimOutOfPageAreas', true);
-cesdk.engine.editor.setSettingBool('mouse/enableZoomControl', true);
-cesdk.engine.editor.setSettingBool('features/undoHistory', true);
-```
-
-**Features** toggle which editing tools and panels appear in the UI:
-
-```typescript title="src/imgly/config/features.ts"
-// Toggle editor features
-cesdk.feature.enable('ly.img.crop', true);
-cesdk.feature.enable('ly.img.filter', true);
-cesdk.feature.enable('ly.img.adjustment', true);
-```
-
-See [Settings](./settings.md) and [Features](./user-interface/customization/disable-or-enable.md) for the complete reference.
-
-### Explore Plugins
-
-CE.SDK has a rich plugin ecosystem that extends the editor with powerful capabilities. Plugins can add new features, integrate third-party services, or customize editor behavior.
-
-#### Background Removal
-
-Add AI-powered background removal that runs entirely client-side. The background removal plugin processes images directly in the browser without sending data to external servers.
-
-```typescript title="src/imgly/config/plugin.ts"
-import BackgroundRemovalPlugin from '@imgly/plugin-background-removal';
-
-// Add background removal capability
-await cesdk.addPlugin(BackgroundRemovalPlugin());
-```
-
-See [Background Removal](./edit-image/remove-bg.md) for setup instructions and configuration options.
-
-#### Print Ready PDF
-
-Export print-ready PDF/X-3 files with CMYK color profiles for professional printing workflows.
-
-```typescript title="src/imgly/config/plugin.ts"
-import PrintReadyPDFPlugin from '@imgly/plugin-print-ready-pdf';
-
-// Add print-ready PDF export capability
-await cesdk.addPlugin(PrintReadyPDFPlugin());
-```
-
-See [Print Ready PDF](./plugins/print-ready-pdf.md) for setup instructions and configuration options.
-
-#### AI Integration
-
-Extend the editor with generative AI capabilities for text-to-image generation, image enhancement, and intelligent editing features. CE.SDK integrates with various AI providers.
-
-```typescript title="src/imgly/config/plugin.ts"
-import AIPlugin from '@imgly/plugin-ai-generation';
-
-// Configure AI generation
-await cesdk.addPlugin(
-  AIPlugin({
-    provider: 'your-ai-provider',
-    apiKey: 'your-api-key'
-  })
-);
-```
-
-See [AI Integration](./user-interface/ai-integration.md) for provider setup and supported AI features.
-
----
-
-## Key Capabilities
-
-The Airtable Image Editor includes custom Airtable image integration plus full design editing capabilities.
-
-<CapabilityGrid
-features={[
-{
-title: 'Airtable Integration',
-description:
-'Browse and search images stored in your Airtable database. Add images to your designs with one click.',
-imageId: 'asset-libraries',
-},
-{
-title: 'Professional Filters',
-description:
-'Apply color grading with LUT filters, duotone effects, and customizable image adjustments.',
-imageId: 'filters',
-},
-{
-title: 'Text & Typography',
-description:
-'Add styled text with comprehensive typography controls, fonts, and visual effects.',
-imageId: 'text-editing',
-},
-{
-title: 'Design Templates',
-description:
-'Start from pre-built templates or create designs from scratch with a full-featured canvas.',
-imageId: 'templating',
-},
-{
-title: 'Privacy-First',
-description:
-'All processing happens locally in the browser. Images are fetched directly from Airtable.',
-imageId: 'client-side',
-},
-{
-title: 'Export Options',
-description:
-'Export to multiple formats including PNG, JPEG, and PDF with quality and size controls.',
-imageId: 'transform',
-},
-]}
-/>
-
-<br />
-
-> **Free Trial:** [Sign up for a free trial](https://img.ly/forms/free-trial) to get a license key and remove the watermark.
-
----
-
-## Troubleshooting
-
-### "Please provide your Airtable API key" alert
-
-- **Set your API key**: Add `VITE_AIRTABLE_API_KEY` to your `.env` file or pass it to `initAirtableImageEditor()`
-- **Get your key**: Get your API key from your [Airtable account settings](https://support.airtable.com/docs/creating-and-using-api-keys-and-access-tokens)
-
-### Editor doesn't load
-
-- **Check the container element exists**: Ensure your container element is in the DOM before calling `create()`
-- **Verify the baseURL**: Assets must be accessible from the CDN or your self-hosted location
-- **Check console errors**: Look for CORS or network errors in browser developer tools
-
-### Assets don't appear
-
-- **Check network requests**: Open DevTools Network tab and look for failed requests to `cdn.img.ly`
-- **Self-host assets for production**: See [Serve Assets](./serve-assets.md) to host assets on your infrastructure
-
-### Airtable images don't load
-
-- **Verify your API key**: Make sure your Airtable API key is valid
-- **Check database permissions**: Ensure your API key has access to the database
-- **Check network requests**: Look for 401 or 403 errors in the Network tab
-
-### Watermark appears in production
-
-- **Add your license key**: Set the `license` property in your configuration
-- **Sign up for a trial**: Get a free trial license at [img.ly/forms/free-trial](https://img.ly/forms/free-trial)
-
----
-
-## Next Steps
-
-- [Asset Source Plugins](./plugins/asset-sources.md) – Build your own asset integrations
-- [Configuration](./configuration.md) – Complete list of initialization options
-- [Serve Assets](./serve-assets.md) – Self-host engine assets for production
-- [Actions](./actions.md) – Build custom export and save workflows
-- [Theming](./user-interface/appearance/theming.md) – Customize colors and appearance
-- [Localization](./user-interface/localization.md) – Add translations and language support
-
----
-
-## More Resources
-
-- **[Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md)** - Browse all Vanilla JS/TS 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