@imgly/codesign-mcp 0.1.5 → 0.1.6

package/assets/docs/guide/to-v1-10.md

@@ -1,131 +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:** [Upgrading](./upgrade.md) > [To v1.10](./to-v1-10.md)
-
----
-
-Version v1.10 introduced major changes to how and where engine and the UI store assets.
-This guide helps you navigate those changes and explains what you need to do to bring your integration up to speed.
-
-## 1. Scene Uploads are no longer serialized
-
-Image uploads are no longer stored in the scene and will not reappear upon scene load. To offer specific assets in your editor, configure and [add an asset source](./serve-assets.md) containing the desired assets.
-
-## 2. Deprecating Extensions
-
-Starting with `v1.10` we fully embrace [Asset Sources](./import-media/from-remote-source/unsplash.md) as our standard interface for asset management.
-We're deprecating extension packs, previously stored in `/assets/extensions` and indexed via `manifest.json` files.
-
-**Fonts are not affected by this deprecation yet, but will receive the same treatment in an upcoming version.**
-
-We'll deprecate the `config.extensions` field for `CreativeEditorSDK`.
-As part of this deprecation, we'll **no longer ship** the following packs in the `/assets/extensions` directory in our `npm` packages:
-
-- `ly.img.cesdk.images.samples`
-- `ly.img.cesdk.shapes.default`
-- `ly.img.cesdk.stickers.doodle`
-- `ly.img.cesdk.stickers.emoji`
-- `ly.img.cesdk.stickers.emoticons`
-- `ly.img.cesdk.stickers.hand`
-- `ly.img.cesdk.vectorpaths`
-- `ly.img.cesdk.vectorpaths.abstract`
-
-To keep offering the contained assets in your deployment, use our new [convenience functions](#making-use-of-default-and-demo-asset-sources) to instantiate asset sources holding these assets.
-If you have existing scenes where an asset from an extension pack might be included, you must make sure you're still serving the corresponding files from your baseURL, so that `<baseURL>/extensions/…` paths still resolve properly.
-You can acquire a copy of the extension packs shipped in `v1.9.2` [from our CDN](https://cdn.img.ly/packages/imgly/cesdk-engine/1.9.2/assets/extensions.zip).
-Otherwise your scenes will **render missing asset alerts**.
-
-### 2.1 Making use of Default and Demo Asset Sources
-
-We still want to offer a package, that has all batteries included and quickly gets you up to speed.
-To do so, we introduced two new convenience functions, that can be used to add a set of predefined asset sources to your integration:
-
-#### `addDefaultAssetSources`
-
-Adds a set of asset sources containing our default assets.
-
-These assets may be used in production and [served from your own servers](./serve-assets.md).
-The assets are parsed from the IMG.LY CDN at `{{base_url}}/<id>/content.json`, where `base_url` defaults to `https://cdn.img.ly/assets/v1`.
-Each source is created via `addLocalSource` and populated with the parsed assets.
-You can specify your own `base_url` or exclude certain source IDs.
-
-The following sources are added:
-
-| ID                        | Description                     |
-| ------------------------- | ------------------------------- |
-| `'ly.img.sticker'`        | Various stickers                |
-| `'ly.img.vectorpath'`     | Shapes and arrows               |
-| `'ly.img.filter.lut'`     | LUT effects of various kinds.   |
-| `'ly.img.filter.duotone'` | Color effects of various kinds. |
-
-#### `addDemoAssetSources`
-
-Registers a set of demo asset sources containing our example assets.
-These are not to meant to be used in your production code.
-
-The assets are parsed from the IMG.LY CDN at `https://cdn.img.ly/assets/demo/v1`.
-The `sceneMode` and `withUploadAssetSources` parameters control whether audio/video and upload sources are added.
-
-The following sources are added:
-
-| ID                      | Description                        |
-| ----------------------- | ---------------------------------- |
-| `'ly.img.image'`        | Sample images                      |
-| `'ly.img.image.upload'` | Demo source to upload image assets |
-| `'ly.img.audio'`        | Sample audios                      |
-| `'ly.img.audio.upload'` | Demo source to upload audio assets |
-| `'ly.img.video'`        | Sample audios                      |
-| `'ly.img.video.upload'` | Demo source to upload video assets |
-
-#### Modifying Default & Demo Sources
-
-After registration you can freely modify the contained assets using the Asset APIs.
-You can add or remove entire asset sources or individual assets.
-
-#### Upload Asset Sources
-
-The upload asset sources and library entries for video and audio were added to the default configuration from `addDefaultAssetSources`. If you have added these sources manually (like mentioned in our video docs) you can remove them now.
-
-## 3. AssetAPI Changes
-
-To further streamline interaction, the following breaking changes were made to the AssetAPI:
-
-- The `applyAsset` callbacks and `defaultApplyAsset` API now return an optional design block id in their callback if they created a new block.
-- `thumbUri` and `size` properties in `AssetDefinition` and `AssetResult` are now part of the `meta` property dictionary.
-- Values of the `blockType` asset meta property must now be design block type ids (e.g. `//ly.img.ubq/image`)
-
-## 4. A New Way to Add Images
-
-Instead of specifying additional images for the `CreativeEditorSDK` in `config.presets.images`, you should make use of `asset.addAsset` and add your images into the `ly.img.image` asset source.
-
-## 5. General API Changes
-
-The `blockType` `meta` property for assets changed from `ly.img.<type>` to fully qualified block types: E.g. `'ly.img.image'` now needs to be `'//ly.img.ubq/image'`.
-
-As we're starting to apply the 'fill' concept to more parts of the interface, we deprecated various fill color related APIs:
-
-- Deprecated `hasFillColor`, use `hasFill` and query `block.getEnum(id, 'fill/type')` for `Solid` type instead.
-- Deprecated `get/setFillColorRGBA`, use `setFillSolidColor`instead..
-- Deprecated `isFillColorEnabled`, use `isFillEnabled` instead.
-- Deprecated `setFillType` and `setFillGradientType`, use `createFill`, e.g., with type 'color' and then apply the fill block with `setFill` to the block instead. If the block has a fill, it should be removed with `getFill` and `destroy`.
-- Deprecated `getFillType` and `getFillGradientType`, query `block.getEnum(id, 'fill/type')` and `block.getEnum(id, 'fill/gradient/type')` instead instead
-- Deprecated `add/removeFillGradientColorStop` and `get/setFillGradientColorStops`.
-- Deprecated `get/setFillGradientControlPointX/Y`, use `block.getFloat(fill, keypath)` and `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' instead.
-- Deprecated `get/setFillGradientRadius`, use `block.getFloat(fill, 'fill/gradient/radial/radius')` and `block.setFloat(fill, 'fill/gradient/radial/radius', value)` instead."
-
-`camera/clearColor` property was replaced it with a global `clearColor` setting to allow controlling the clear color before loading a scene.
-
-Properties affecting playback that existed on both `Audio` and `VideoFill` where moved to a common `playback/` namespace:
-
-- `'fill/video/looping'` and `'audio/looping'` are now `'playback/looping'`
-- `'fill/video/volume'` and `'audio/volume'` are now `'playback/volume'`
-- `'fill/video/muted'` and `'audio/muted'` are now `'playback/muted'`
-
----
-
-## 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/to-v1-13.md

@@ -1,165 +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:** [Upgrading](./upgrade.md) > [To v1.13](./to-v1-13.md)
-
----
-
-In version v1.13, the way the CreativeEngine and
-CreativeEditor SDK are configured has changed. Several configuration options
-that were previously passed to `CreativeEngine.init()` or `CreativeEditor
-SDK.init()` have been removed or replaced. This document will explain the
-changes and describe the steps you can take to adapt them to your setup.
-
-#### CreativeEditorSDK initialization
-
-We are also introducing a new way of instantiating the CreativeEditorSDK, that
-provides more precise control over the initialization. Using
-`CreativeEditorSDK.create()`, you have the chance to configure the SDK before
-loading or creating a scene. This was not possible before. When using
-`CreativeEditorSDK.init()`, the SDK would create the initial scene before giving
-you the option to perform additional configuration via the API.
-
-The `create()` method will not create an initial scene for you. You need to do
-that yourself, using either the Scene API at `cesdk.editor.scene`, or one of the
-methods on the CreativeEditorSDK instance itself (`createDesignScene`,
-`createVideoScene`, `loadFromUrl`, `loadFromString`).
-
-### Rationale
-
-Over time the number options you could pass into the call to
-`CreativeEngine.init({...config})` has grown quite a bit. Initially this was the
-only place where you could configure the behavior and settings of the
-CreativeEngine, but over the past year we introduced several new APIs. One of those APIs
-is the EditorAPI, which lets you
-
-[adjust](./settings.md) many
-[settings](./settings.md) at runtime, not just at the launch of the app.
-
-To improve consistency of our APIs, we decided to scale back the options
-available in the configuration object in favor of changing settings via the
-EditorAPI. The only options that remain are those that are strictly necessary
-for the initialization of the CreativeEngine, such as the `baseUrl` and
-`license`.
-
-These changes were performed with the Creative Engine in mind, but since the
-CreativeEditor SDK shares a lot of the same code, the changes described in this
-document also apply to the configuration for the CE.SDK.
-
-### Changed configuration options
-
-The following is a list of all configuration options that have been changed or
-removed, along with instructions on how to migrate the use of these options in
-your codebase:
-
-- `scene` options (`dpi`, `pixelScaleFactor`) have been removed.
-  `scene/dpi` and `scene/pixelScaleFactor` can now be found as [properties on the scene in the BlockAPI](./concepts/blocks.md).
-- `page` options have been removed.
-  - `page.title.show` has been replaced with `cesdk.engine.editor.setSettingBool('page/title/show', enabled)`
-  - `page.title.fontFileUri` has been replaced with `cesdk.engine.editor.setSettingString('page/title/fontFileUri', uri)`
-  - `page.dimOutOfPageAreas` has been replaced with `cesdk.engine.editor.setSettingBool('page/dimOutOfPageAreas', dimEnabled)`
-- `assetSources` have been removed. To add asset sources, use the AssetAPI at `cesdk.engine.asset`.
-- `preset.colors` has been removed as it was never used, previously.
-- `presets.colorPalettes` has been removed from CreativeEngine as it was not used. It has been moved to `ui.colorPalette` in the CESDK.
-- `presets.images` has been removed. To add assets and asset sources, use the AssetAPI at `cesdk.engine.asset`.
-- `presets.pageFormats` has been removed from the CreativeEngine as it was not used. Is has been moved to `ui.pageFormats` in the CESDK.
-  Previously it was possible to mark a page format as default by setting `meta: {default: true}` in it.
-  In `ui.pageFormats`, this has been simplified, to just `default: true`.
-- `variables` has been removed. Use the [VariableAPI](./create-templates/add-dynamic-content/text-variables.md) instead.
-- `callbacks.log` has been moved to `logger`. Previously the logger callback would take
-  a `Loglevel` enum as a second parameter. This enum has been removed. Instead you can
-  define the loglevel with plain strings `'Warning' | 'Error' | 'Info' `
-
-### Change initialization code
-
-To ensure your users perceive a consistent UI experience, settings that have been moved
-to api calls should be made immediately after initializing the CreativeEngine.
-For the Creative Editor SDK, use the `create()` method, instead of `init()`
-
-#### CreativeEngine
-
-```
-const engine = await CreativeEngine.init(config);
-// 1. Configure Engine
-engine.editor.setSettingEnum('doubleClickSelectionMode', 'Direct');
-// ... other settings
-
-// 2. Create/load scene
-const sceneId = await engine.scene.create();
-
-// 3. Append Engine canvas element to the DOM
-document.getElementById('my-engine-container').append(engine.element);
-
-// ... your application code
-```
-
-#### CreativeEngine SDK
-
-```
-const cesdk = await CreativeEditorSDK.create('my-engine-container', config);
-// 1. Configure SDK
-cesdk.engine.asset.addSource(myAssetSource);
-// ... other settings
-
-// 2. Create/load scene
-const sceneId = await cesdk.createDesignScene(myPageFormats[pageFormatId]);
-
-// ... your application code
-```
-
-### Fallback and warnings
-
-The CreativeEngine and CreativeEditor SDK still interpret the config object with
-its previous settings.
-If removed configuration options are detected during intialization, a warning is
-printed to the console, with individual instructions on how to migrate them.
-It is recommended to adjust your configuration as described above for the best
-compatibility with future developments and to get rid of these warnings.
-
-The fallback mechanism is not enabled for the new `CreativeEditorSDK.create()`
-method! Passing removed configuration options to `create()` will cause that
-option to be ignored and an error will be printed to the console.
-
-### CreativeEngine Typescript definitions
-
-The more complex parts of our configuration (such as the page format definitions)
-were previously exporting type definitions under the `ConfigTypes` namespace
-in the CreativeEngine package. This namespace and all the types in it have been removed or moved elsewhere.
-
-For now we still export `ConfigTypes`, but have marked it and its members as `@deprecated`.
-Most of them are not used at all anymore, the rest have been moved elsewhere:
-
-- `ConfigTypes.Color` can now be imported directly as `PaletteColor`
-- `ConfigTypes.TypefaceDefinition` can be imported directly, as `TypefaceDefinition`.
-- `ConfigTypes.PageFormatDefinition` can be imported directly as `PageFormatDefinition` (CE.SDK only).
-- `ConfigTypes.Logger` can be imported directly as `Logger`
-
-The `LogLevel` enum that was previously used by `Logger` has been replaced with
-a string union (`'Warning' | 'Error' | 'Info'`).
-
-### CreativeEditorSDK Typescript definitions
-
-The CreativeEditor SDK package still _does_ export a `ConfigTypes` namespace.
-
-For use with the new `CreativeEditorSDK.create()`, we are offering a new type
-`CreateConfiguration`, which is lacking all of the removed keys instead of
-marking them as deprecated.
-
-### Demo asset sources
-
-When adding demo asset sources using `cesdk.addDemoAssetSources()`, or
-`engine.addDemoAssetSources()`, make sure to specify the correct scene mode. The
-installed demo asset sources vary between Design and Video modes.
-
-If you don't specify a scene mode, `addDemoAssetSources()` will try to add the
-correct sources based on the current scene, and default to `'Design'`. If you
-call `addDemoAssetSources()` _without_ a scene mode, and _before_ loading or
-creating a video scene, the audio and video asset sources will not be added.
-
----
-
-## 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/to-v1-32.md

@@ -1,110 +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:** [Upgrading](./upgrade.md) > [To v1.32](./to-v1-32.md)
-
----
-
-Version v1.32 introduced powerful new APIs for customizing the CE.SDK web editor. These new APIs render some of the existing configurations obsolete, requiring code migration to leverage the more flexible new options.
-
-This guide will help you navigate these changes and explain what you need to do to update your integration.
-
-## Configuring the Dock
-
-Until version 1.32, the dock was configured by two configuration options (although most users only used one of them and kept the others default):
-
-- `config.ui.elements.libraries.insert.entries` and
-- `config.ui.elements.dock`
-
-If your configuration adapted one of these two (mostly `config.ui.elements.libraries.insert.entries`), you are affected by this change. For now, it is only deprecated and we will try to do an internal migration for you, but this still might include a breaking change depending on how you used the configuration options before.
-
-### Breaking Change
-
-`config.ui.elements.libraries.insert.entries` was called repeatedly with a context of currently selected blocks. Most users and configurations have not used this behavior and just returned the same static list of entries for every call. In this case, your configuration should work as before, but if you have relied on this fact, you have to migrate your configuration to the new API, listen to selection changes, and update the asset library entries accordingly.
-
-### Migration to new APIs
-
-Defining the dock is now done by our new APIs in a consistent way to all other customizable locations of the editor. With the [Dock API](./user-interface/customization/dock.md), you now have much greater control of how and what is displayed in the dock. This does not only include dock buttons to open asset libraries but also arbitrary buttons and other elements. Please take a look at the [Dock API](./user-interface/customization/dock.md) or learn about the general concept [here](./user-interface/overview.md).
-
-If you aren't affected by the breaking change mentioned above, the easiest way to migrate is to first copy your current dock order after the editor has been inialized. This can be done by calling the new `cesdk.ui.getDockOrder()` method. Now you can take this order and set it during the initialization of the editor by using `cesdk.ui.setDockOrder(copiedDockOrder)`. The old configuration (`config.ui.elements.libraries.insert.entries` and `config.ui.elements.dock`) can be removed afterwards.
-
-Of course, you could also just remove the old configuration and use the new API to define the dock order from scratch.
-
-Please note, that changes to the asset library entries are now done by the [Asset Library Entry API](./import-media/asset-panel/basics.md) and the dock order is just referring to these. So if you, for instance, want to add an asset source id to be shown in a library, you have to add this asset source id to the asset library entry and not to the dock order.
-
-```javascript
-// Before
-// ======
-const config: Configuration = {
-  ui: {
-    elements: {
-      libraries: {
-        insert: {
-          entries: (defaultEntries) => {
-            return [
-              // Changing some of the default entries
-              ...defaultEntries.map((entry) => {
-                if (entry.id === 'ly.img.image') {
-                  entry.sourceIds.push('my-own-image-source');
-                }
-                return entry;
-              }),
-              // Adding a new entry
-              {
-                id: 'my-own-entry',
-                sourceIds: ['my-own-source']
-              }
-            ];
-          }
-        }
-      }
-    }
-  }
-};
-
-// After
-// ======
-cesdk.ui.setDockOrder([
-  ...cesdk.ui.getDockOrder(),
-  // Add a new button referencing your new entry
-  {
-    id: 'ly.img.assetLibrary.dock',
-    label: 'My Own Entry',
-    icon: [...],
-    entries: ['my-own-entry']
-  }
-]);
-
-// Adding your custom entry
-cesdk.ui.addAssetLibraryEntry({
-  id: 'my-own-entry',
-  sourceIds: ['my-own-source']
-});
-
-// Updating an existing default entry
-cesdk.ui.updateAssetLibraryEntry('ly.img.image', {
-  sourceIds: ({ currentIds }) => [...currentIds, 'my-own-image-source']
-});
-```
-
-## Configuring the Asset Replacement Panel
-
-Similar to the definition of the dock, we deprecate the configuration `config.ui.elements.libraries.replace.entries` of the asset library entries for the replacement panel. This method is deprecated but we will try to migrate your configuration internally until it is removed. We recommend you to migrate to the new API as soon as possible.
-
-The new API is similar with subtle differences. With `cesdk.ui.setReplaceAssetLibraryEntries` you register a function that is called with the current context (of selected blocks) but only returns ids of entries.
-
-### Breaking Change
-
-With the `config.ui.elements.libraries.replace.entries` it was possible to take the default entries and modify them. In theory, you could change the entries and have different "default" entries for insert or replace. Now a change to a default entry provided by the editor via the [Asset Library Entry API](./import-media/asset-panel/basics.md) will be reflected in both the insert and replace entries. To solve this you can just copy one entry for replacement, modify it, and return its id instead.
-
-### Migration to new APIs
-
-Take the function from `config.ui.elements.libraries.replace.entries` and use it in `cesdk.ui.setReplaceAssetLibraryEntries` by replacing the entries with their ids. If you have made changes to the default entries or added new custom ones you need to add or change them via the [Asset Library Entry API](./import-media/asset-panel/basics.md) on initialization of the editor.
-
----
-
-## 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