@imgly/codesign-mcp 0.1.5 → 0.1.6

package/assets/docs/guide/user-interface/ai-integration/proxy-server.md

@@ -1,99 +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:** [Guides](./guides.md) > [AI Integration](./user-interface/ai-integration.md) > [Proxy Server](./user-interface/ai-integration/proxy-server.md)
-
----
-
-> **Prefer not to run a proxy?:** The [IMG.LY AI Gateway](./user-interface/ai-integration/gateway-provider.md) is the recommended path for most integrations. We run the proxy, authentication, model routing, and billing for you — no server required beyond a short-lived JWT-minting endpoint. Use the steps below when you need to self-host the proxy or forward requests through your own infrastructure.
-
-For security reasons, you should never include your AI service API keys directly in client-side code. Instead, you should set up proxy services that securely forward requests to AI providers while keeping your API keys secure on the server side.
-
-Each AI provider configuration requires a `proxyUrl` parameter, which should point to your server-side endpoint that handles authentication and forwards requests to the AI service:
-
-```typescript
-text2image: FalAiImage.RecraftV3({
-  proxyUrl: 'http://your-proxy-server.com/api/proxy'
-});
-
-// Or use Recraft20b with icon style support:
-// text2image: FalAiImage.Recraft20b({
-//     proxyUrl: 'http://your-proxy-server.com/api/proxy'
-// });
-```
-
-## Proxy Implementation Requirements
-
-Your proxy should implement specific requirements for each AI service:
-
-### 1. Anthropic Proxy
-
-- **Target URL**: `https://api.anthropic.com/`
-- **Authentication Header**: Add `X-Api-Key` header with your Anthropic API key
-- **Request Handling**: Forward request body as-is to Anthropic API
-- **Response Handling**: Remove `content-encoding` headers to handle compressed responses correctly
-
-### 2. fal.ai Proxy
-
-- **Dynamic URL**: Use a special header called `x-fal-target-url` to determine the actual endpoint
-- **Authentication Header**: Add `Authorization: Key YOUR_FAL_KEY` header
-- **Request Forwarding**: Preserve the complete request body and query parameters
-- For more information on the requirements, refer to fal.ai's [documentation](https://docs.fal.ai/model-endpoints/server-side/#the-proxy-formula).
-
-### 3. ElevenLabs Proxy
-
-- **Target URL**: `https://api.elevenlabs.io/`
-- **Authentication Header**: Add `xi-api-key` header with your ElevenLabs API key
-- **Headers**: Add an `Accept: audio/mpeg` header for audio requests.
-- **Response Handling**: Remove `content-encoding` headers to handle compressed responses correctly
-
-### 4. OpenAI Proxy
-
-- **Target URL**: `https://api.openai.com/v1/`
-- **Authentication Header**: Add `Authorization: Bearer YOUR_OPENAI_API_KEY` header
-- **Response Handling**: Remove `content-encoding` headers to handle compressed responses correctly
-- **Rate Limiting**: Implement rate limiting based on your OpenAI plan tier (recommended)
-- For more information on the requirements, refer to OpenAI's [documentation](https://platform.openai.com/docs/api-reference/debugging-requests)
-
-## Important Information for All Proxies
-
-**Response Streaming**
-
-To handle large responses efficiently, response streaming should be enabled for all proxies. Common approaches include:
-
-- **Axios**: `responseType: 'stream'`
-- **Fetch API**: Access `response.body` as a `ReadableStream`
-- **Node.js native HTTP clients**: Use stream-based responses
-- **Other HTTP clients**: Check documentation for streaming support
-
-## General Proxy Design
-
-A well-designed proxy service should:
-
-1. **Route requests** to the appropriate AI service based on the endpoint path
-2. **Add authentication** headers containing your API keys
-3. **Forward the request body** to maintain payload integrity
-4. **Handle response streaming** for services that support it (like Anthropic)
-5. **Implement proper CORS headers** to allow browser requests
-6. **Add appropriate error handling** and logging
-7. **Consider rate limiting** to protect your API keys from overuse
-
-## Security Considerations
-
-When implementing your proxy:
-
-- Store API keys securely as environment variables
-- Implement request validation to prevent abuse
-- Consider adding user authentication to your proxy endpoints
-- Monitor usage to detect unusual patterns
-- Implement proper error handling without leaking sensitive information
-
-This approach ensures your API keys remain secure while still allowing your application to utilize AI services. For a complete example of a proxy implementation, you can find various proxy templates online that can be adapted for your specific needs.
-
----
-
-## 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

package/assets/docs/guide/user-interface/ai-integration/text-generation.md

@@ -1,498 +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:** [Guides](./guides.md) > [AI Integration](./user-interface/ai-integration.md) > [Text Generation](./user-interface/ai-integration/text-generation.md) > [Plugins](./plugins.md) > [AI: Text Generation](./user-interface/ai-integration/text-generation.md)
-
----
-
-We add AI-powered text generation to CE.SDK applications for creating headlines, descriptions, captions, and marketing content.
-
-![AI Text Generation Interface](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-user-interface-ai-integration-text-generation-browser)
-> - [Open in StackBlitz](https://stackblitz.com/github/imgly/cesdk-web-examples/tree/v$UBQ_VERSION$/guides-user-interface-ai-integration-text-generation-browser)
-> - [Live demo](https://img.ly/docs/cesdk/examples/guides-user-interface-ai-integration-text-generation-browser/)
-
-The text generation plugin provides quick actions for improving writing, fixing spelling and grammar, shortening or lengthening text, changing tone, and translating to different languages.
-
-```typescript file=@cesdk_web_examples/guides-user-interface-ai-integration-text-generation-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 AiApps from '@imgly/plugin-ai-apps-web';
-import Anthropic from '@imgly/plugin-ai-text-generation-web/anthropic';
-import OpenAI from '@imgly/plugin-ai-text-generation-web/open-ai';
-import packageJson from './package.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: {
-        sourceId: 'ly.img.page.presets',
-        assetId: 'ly.img.page.presets.print.iso.a6.landscape'
-      }
-    });
-
-    const engine = cesdk.engine;
-    const page = engine.block.findByType('page')[0]!;
-
-    // Create a text block to demonstrate AI text generation features
-    const textBlock = engine.block.create('text');
-    engine.block.setString(
-      textBlock,
-      'text/text',
-      'Use the AI Quick Actions in the canvas menu to rewrite this text'
-    );
-    engine.block.select(textBlock);
-
-    // Set text block size and center it on the page
-    const pageWidth = engine.block.getWidth(page);
-    const pageHeight = engine.block.getHeight(page);
-    const blockHeight = pageHeight / 4;
-    engine.block.setWidth(textBlock, pageWidth);
-    engine.block.setHeight(textBlock, blockHeight);
-    engine.block.setPositionX(textBlock, 0);
-    engine.block.setPositionY(textBlock, (pageHeight - blockHeight) / 2);
-
-    // Center text horizontally and vertically
-    engine.block.setEnum(textBlock, 'text/horizontalAlignment', 'Center');
-    engine.block.setEnum(textBlock, 'text/verticalAlignment', 'Center');
-
-    // Set larger font size
-    engine.block.setFloat(textBlock, 'text/fontSize', 24);
-
-    engine.block.appendChild(page, textBlock);
-
-    // Configure the AI text generation plugin
-    // NOTE: In production, provide a secure proxy URL that forwards
-    // requests to Anthropic API with your API key
-    const proxyUrl = 'https://your-proxy-server.com/api/anthropic';
-
-    // Configure text generation with both Anthropic and OpenAI using AiApps
-    await cesdk.addPlugin(
-      AiApps({
-        providers: {
-          text2text: [
-            Anthropic.AnthropicProvider({
-              proxyUrl,
-              model: 'claude-sonnet-4-5-20250929',
-              properties: {
-                temperature: { default: 0.7 },
-                maxTokens: { default: 500 }
-              }
-            }) as any,
-            OpenAI.OpenAIProvider({
-              proxyUrl: 'https://your-proxy-server.com/api/openai',
-              model: 'gpt-4.1-nano-2025-04-14',
-              properties: {
-                temperature: { default: 0.7 },
-                maxTokens: { default: 500 }
-              }
-            }) as any
-          ]
-        },
-        // IMPORTANT: dryRun mode simulates generation without API calls
-        // Perfect for testing and development
-        dryRun: true
-      })
-    );
-
-    // Reorder dock to show AI Apps button prominently
-    cesdk.ui.setComponentOrder({ in: 'ly.img.dock' }, [
-      'ly.img.ai.apps.dock',
-      ...cesdk.ui.getComponentOrder({ in: 'ly.img.dock' })
-    ]);
-
-    // Configure canvas menu to show AI text quick actions
-    cesdk.ui.setComponentOrder({ in: 'ly.img.canvas.menu' }, [
-      'ly.img.ai.text.canvasMenu',
-      ...cesdk.ui.getComponentOrder({ in: 'ly.img.canvas.menu' })
-    ]);
-
-    // Customize UI labels for AI text generation features
-    // This demonstrates how to customize the i18n system
-    cesdk.i18n.setTranslations({
-      en: {
-        'ly.img.plugin-ai-text-generation-web.anthropic.quickAction.improve':
-          '✨ Enhance Text',
-        'ly.img.plugin-ai-text-generation-web.anthropic.property.prompt':
-          'Your Custom Instructions'
-      }
-    });
-
-    // Alternative: Configure with single provider
-    /*
-    await cesdk.addPlugin(
-      AiApps({
-        providers: {
-          text2text: [
-            Anthropic.AnthropicProvider({
-              proxyUrl,
-              model: 'claude-sonnet-4-5-20250929',
-              properties: {
-                temperature: { default: 0.7 },
-                maxTokens: { default: 500 }
-              }
-            }) as any
-          ]
-        },
-        dryRun: true
-      })
-    );
-    */
-
-    // Open the AI Apps panel to make the text generation features visible
-    cesdk.ui.openPanel('ly.img.ai.apps.panel');
-  }
-}
-
-export default Example;
-```
-
-This guide covers installing the plugin, configuring AI providers, setting up quick actions, customizing parameters, and testing with dry-run mode.
-
-## Installation
-
-Import the plugin and provider modules from the text generation package.
-
-```typescript highlight-install
-import AiApps from '@imgly/plugin-ai-apps-web';
-import Anthropic from '@imgly/plugin-ai-text-generation-web/anthropic';
-import OpenAI from '@imgly/plugin-ai-text-generation-web/open-ai';
-```
-
-Install `@imgly/plugin-ai-text-generation-web` to access the TextGeneration plugin, Anthropic provider, and OpenAI provider modules:
-
-<Tabs syncKey="package-manager">
-  <TabItem label="npm">
-    ```bash
-    npm install @imgly/plugin-ai-text-generation-web@$UBQ_VERSION$
-
-    ```
-
-  </TabItem>
-
-  <TabItem label="yarn">
-    ```bash
-    yarn add @imgly/plugin-ai-text-generation-web@$UBQ_VERSION$
-
-    ```
-
-  </TabItem>
-
-  <TabItem label="pnpm">
-    ```bash
-    pnpm add @imgly/plugin-ai-text-generation-web@$UBQ_VERSION$
-
-    ```
-
-  </TabItem>
-</Tabs>
-
-## Configuration
-
-Configure the plugin with an Anthropic or OpenAI provider. The provider requires a proxy URL that forwards requests to the AI service with your API key.
-
-For available models, see the provider documentation:
-
-- [Claude Models](https://docs.anthropic.com/en/docs/about-claude/models/overview)
-- [OpenAI Models](https://platform.openai.com/docs/models)
-
-```typescript highlight-basic-config
-await cesdk.addPlugin(
-  AiApps({
-    providers: {
-      text2text: [
-        Anthropic.AnthropicProvider({
-          proxyUrl,
-          model: 'claude-sonnet-4-5-20250929',
-          properties: {
-            temperature: { default: 0.7 },
-            maxTokens: { default: 500 }
-          }
-        }) as any
-      ]
-    },
-    dryRun: true
-  })
-);
-```
-
-We configure the Anthropic provider with Claude Sonnet 4.5, set generation parameters like temperature and max tokens, and enable dry-run mode for testing without API calls.
-
-## Canvas Menu Setup
-
-Add the text generation quick actions to the canvas menu so users can access them when editing text blocks.
-
-```typescript highlight-canvas-menu
-// Configure canvas menu to show AI text quick actions
-cesdk.ui.setComponentOrder({ in: 'ly.img.canvas.menu' }, [
-  'ly.img.ai.text.canvasMenu',
-  ...cesdk.ui.getComponentOrder({ in: 'ly.img.canvas.menu' })
-]);
-```
-
-We prepend `ly.img.ai.text.canvasMenu` to the existing canvas menu order, making text quick actions appear first when users select text blocks.
-
-## Proxy Server
-
-A proxy server protects your API keys by forwarding requests server-side. See the [Proxy Server](./user-interface/ai-integration/proxy-server.md) guide for implementation details and examples.
-
-## Generation Parameters
-
-Customize generation behavior with properties configuration. Control creativity level with temperature (0.0-1.0 for Claude, 0.0-2.0 for GPT) and response length with max_tokens.
-
-```typescript
-TextGeneration({
-  provider: Anthropic.AnthropicProvider({
-    proxyUrl: 'https://your-proxy.com/api/anthropic',
-    properties: {
-      temperature: { default: 0.7 },
-      max_tokens: { default: 500 }
-    }
-  })
-});
-```
-
-Higher temperature values produce more creative output, while lower values generate more focused and deterministic text.
-
-## Quick Actions
-
-Quick actions provide preset text transformations accessible from the canvas menu. Users can improve writing quality, fix spelling and grammar, make text shorter or longer, change tone (professional, casual, friendly), and translate to various languages.
-
-The plugin includes these quick actions by default:
-
-- **Improve** - Enhance clarity and flow
-- **Fix** - Correct spelling and grammar
-- **Shorter** - Reduce text length
-- **Longer** - Expand text content
-- **Tone** - Change style (professional, casual, friendly, empathetic, confident)
-- **Translate** - Convert to different languages
-
-## Multiple Providers
-
-Configure multiple providers to give users choice between different AI models.
-
-```typescript
-TextGeneration({
-  provider: [
-    Anthropic.AnthropicProvider({
-      model: 'claude-3-7-sonnet-20250219',
-      proxyUrl: 'https://your-proxy.com/api/anthropic'
-    }),
-    OpenAIText.OpenAIProvider({
-      model: 'gpt-4o-mini',
-      proxyUrl: 'https://your-proxy.com/api/openai'
-    })
-  ]
-});
-```
-
-Multiple providers trigger automatic provider selection in the UI.
-
-## Feature Visibility
-
-Control which features appear in the UI using the Feature API.
-
-```typescript
-// Disable provider selection
-cesdk.feature.enable(
-  'ly.img.plugin-ai-text-generation-web.providerSelect',
-  false
-);
-
-// Disable all quick actions
-cesdk.feature.enable('ly.img.plugin-ai-text-generation-web.quickAction', false);
-
-// Disable specific quick actions
-cesdk.feature.enable(
-  'ly.img.plugin-ai-text-generation-web.quickAction.translate',
-  false
-);
-```
-
-This restricts user choices when you want to enforce specific models or limit available transformations.
-
-## Custom Labels
-
-Customize UI text using the i18n system. Replace default labels with custom text or add translations for multiple languages.
-
-```typescript highlight-custom-labels
-// Customize UI labels for AI text generation features
-// This demonstrates how to customize the i18n system
-cesdk.i18n.setTranslations({
-  en: {
-    'ly.img.plugin-ai-text-generation-web.anthropic.quickAction.improve':
-      '✨ Enhance Text',
-    'ly.img.plugin-ai-text-generation-web.anthropic.property.prompt':
-      'Your Custom Instructions'
-  }
-});
-```
-
-The example demonstrates customizing the "Improve" quick action label and the prompt input placeholder. Use provider-specific keys for Anthropic or OpenAI, or generic keys to apply across all providers. You can also add translations for multiple languages by including additional language codes like `es`, `de`, or `fr`.
-
-## Middleware
-
-Intercept generation requests and responses with middleware functions. Use middleware for logging, rate limiting, or custom error handling.
-
-```typescript
-import {
-  loggingMiddleware,
-  rateLimitMiddleware
-} from '@imgly/plugin-ai-generation-web';
-
-const logging = loggingMiddleware();
-const rateLimit = rateLimitMiddleware({ maxRequests: 10, windowMs: 60000 });
-
-await cesdk.addPlugin(
-  TextGeneration({
-    provider: Anthropic.AnthropicProvider({ proxyUrl: '...' }),
-    middleware: [logging, rateLimit]
-  })
-);
-```
-
-Middleware receives input, options, and a next callback. Call next to continue the chain or return early to intercept.
-
-## Dry-Run Mode
-
-Test the plugin without making actual API calls using dry-run mode. This simulates generation and returns placeholder text.
-
-```typescript
-await cesdk.addPlugin(
-  TextGeneration({
-    provider: Anthropic.AnthropicProvider({
-      proxyUrl: 'https://your-proxy.com/api/anthropic'
-    }) as any,
-    dryRun: true // Simulate generation without API calls
-  } as any)
-);
-```
-
-Dry-run mode helps during development and testing by avoiding API costs while verifying integration.
-
-## Accessing Generated Text
-
-Generated text appears automatically in text blocks. Access it using the Block API for further manipulation or retrieval.
-
-```typescript
-const textBlocks = engine.block.findByType('text');
-textBlocks.forEach((block) => {
-  const content = engine.block.getString(block, 'text/text');
-  console.log('Text content:', content);
-});
-
-// Modify text programmatically
-engine.block.setString(textBlock, 'text/text', 'New content');
-```
-
-The Block API provides full control over text content after generation.
-
-## Troubleshooting
-
-Common issues when configuring the plugin:
-
-**Plugin not appearing in UI** - Verify plugin installation and `addPlugin()` call completed successfully.
-
-**Quick actions not showing** - Check canvas menu order includes `ly.img.ai.text.canvasMenu`.
-
-**Proxy errors** - Verify proxy URL is accessible and CORS is configured correctly.
-
-**Generation failures** - Confirm API key is valid and proxy forwards requests properly.
-
-**Provider selection not showing** - Multiple providers must be configured in an array.
-
-**Custom translations not applying** - Check translation key format matches the i18n documentation.
-
-**Middleware not executing** - Verify middleware array is passed correctly to the plugin configuration.
-
-**Generated text not appearing** - Ensure text blocks are selected and quick actions are triggered.
-
-**Wrong model being used** - Verify the model parameter in provider configuration matches your intent.
-
-## API Reference
-
-| Method                                                            | Category | Purpose                                            |
-| ----------------------------------------------------------------- | -------- | -------------------------------------------------- |
-| `cesdk.addPlugin()`                                               | Plugin   | Register and initialize the Text Generation plugin |
-| `TextGeneration()`                                                | Plugin   | Create plugin instance with provider configuration |
-| `Anthropic.AnthropicProvider()`                                   | Provider | Configure Claude text generation                   |
-| `OpenAIText.OpenAIProvider()`                                     | Provider | Configure GPT text generation                      |
-| `cesdk.feature.enable()`                                          | Feature  | Control visibility of plugin features              |
-| `cesdk.i18n.setTranslations()`                                    | I18n     | Customize UI labels and translations               |
-| `cesdk.ui.setComponentOrder({ in: 'ly.img.canvas.menu' }, order)` | UI       | Configure canvas menu order for quick actions      |
-| `engine.block.getString()`                                        | Block    | Access generated text content                      |
-| `engine.block.setString()`                                        | Block    | Modify text block content                          |
-
-## Next Steps
-
-- [Proxy Server](./user-interface/ai-integration/proxy-server.md) — Set up secure API communication
-- [Custom Provider](./user-interface/ai-integration/custom-provider.md) — Create custom AI providers
-- [Integrate AI Features](./user-interface/ai-integration/integrate.md) — Overview of AI integration
-- [Audio Generation](./user-interface/ai-integration/audio-generation.md) — AI-powered audio generation
-- [Image Generation](./user-interface/ai-integration/image-generation.md) — AI-powered image generation
-
----
-
-## 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