@cesdk/cesdk-js 1.55.0 → 1.56.0-nightly.20250628

package/index.d.ts

@@ -1,8 +1,3 @@
-import { AddImageOptions } from '@cesdk/engine';
-import { AddVideoOptions } from '@cesdk/engine';
-import { AnimationEasing } from '@cesdk/engine';
-import { AnimationEntry } from '@cesdk/engine';
-import { AnimationOptions } from '@cesdk/engine';
 import { AnimationType } from '@cesdk/engine';
 import { AnimationTypeLonghand } from '@cesdk/engine';
 import { AnimationTypeShorthand } from '@cesdk/engine';
@@ -51,7 +46,6 @@ import type { Color } from '@cesdk/engine';
 import { ColorSpace } from '@cesdk/engine';
 import { CompleteAssetResult } from '@cesdk/engine';
 import { ContentFillMode } from '@cesdk/engine';
-import { CreateSceneOptions } from '@cesdk/engine';
 import { default as CreativeEngine } from '@cesdk/engine';
 import { default as CreativeEngine_2 } from '@cesdk/engine';
 import { CutoutOperation } from '@cesdk/engine';
@@ -63,7 +57,6 @@ import { DesignBlockType } from '@cesdk/engine';
 import { DesignBlockTypeLonghand } from '@cesdk/engine';
 import { DesignBlockTypeShorthand } from '@cesdk/engine';
 import { DesignUnit } from '@cesdk/engine';
-import { DropShadowOptions } from '@cesdk/engine';
 import { EditMode } from '@cesdk/engine';
 import { EditorAPI } from '@cesdk/engine';
 import { EffectType } from '@cesdk/engine';
@@ -133,11 +126,9 @@ import { Typeface } from '@cesdk/engine';
 import { TypefaceDefinition } from '@cesdk/engine';
 import { VariableAPI } from '@cesdk/engine';
 import { VerticalBlockAlignment } from '@cesdk/engine';
-import { VideoExportOptions } from '@cesdk/engine';
 import { VideoMimeType } from '@cesdk/engine';
 import { XYWH } from '@cesdk/engine';
 import { ZoomAutoFitAxis } from '@cesdk/engine';
-import { ZoomOptions } from '@cesdk/engine';
 
 /**
  * A11 Settings
@@ -150,16 +141,6 @@ declare type A11y = {
     headingsHierarchyStart: 1 | 2 | 3 | 4 | 5 | 6;
 };
 
-export { AddImageOptions }
-
-export { AddVideoOptions }
-
-export { AnimationEasing }
-
-export { AnimationEntry }
-
-export { AnimationOptions }
-
 export { AnimationType }
 
 export { AnimationTypeLonghand }
@@ -609,39 +590,11 @@ declare const CANVAS_MENU_TEXT_ORDER_DEFAULT: readonly ["ly.img.text.color.canva
 declare const CANVAS_MENU_TRANSFORM_ORDER_DEFAULT: readonly ["ly.img.group.enter.canvasMenu", "ly.img.group.select.canvasMenu", "ly.img.page.moveUp.canvasMenu", "ly.img.page.moveDown.canvasMenu", "ly.img.separator", "ly.img.text.edit.canvasMenu", "ly.img.replace.canvasMenu", "ly.img.separator", "ly.img.placeholder.canvasMenu", "ly.img.separator", "ly.img.bringForward.canvasMenu", "ly.img.sendBackward.canvasMenu", "ly.img.separator", "ly.img.duplicate.canvasMenu", "ly.img.delete.canvasMenu", "ly.img.separator", "ly.img.options.canvasMenu"];
 
 /**
- * A list of the component IDs that can be used in the canvas bar.
- *
- * Includes the following IDs:
- * - 'ly.img.separator'
- * - 'ly.img.spacer'
- * - 'ly.img.settings.canvasBar'
- * - 'ly.img.page.add.canvasBar'
  * @public
  */
 export declare type CanvasBarComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof CANVAS_BAR_ORDER_DEFAULT)[number] | (string & {});
 
 /**
- * A list of the component IDs that can be used in the canvas menu.
- *
- * Includes the following IDs:
- * - 'ly.img.separator'
- * - 'ly.img.spacer'
- * - 'ly.img.group.enter.canvasMenu'
- * - 'ly.img.group.select.canvasMenu'
- * - 'ly.img.page.moveUp.canvasMenu'
- * - 'ly.img.page.moveDown.canvasMenu'
- * - 'ly.img.text.edit.canvasMenu'
- * - 'ly.img.replace.canvasMenu'
- * - 'ly.img.placeholder.canvasMenu'
- * - 'ly.img.bringForward.canvasMenu'
- * - 'ly.img.sendBackward.canvasMenu'
- * - 'ly.img.duplicate.canvasMenu'
- * - 'ly.img.delete.canvasMenu'
- * - 'ly.img.options.canvasMenu'
- * - 'ly.img.text.color.canvasMenu'
- * - 'ly.img.text.bold.canvasMenu'
- * - 'ly.img.text.italic.canvasMenu'
- * - 'ly.img.text.variables.canvasMenu'
  * @public
  */
 export declare type CanvasMenuComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof CANVAS_MENU_TRANSFORM_ORDER_DEFAULT)[number] | (typeof CANVAS_MENU_TEXT_ORDER_DEFAULT)[number] | (string & {});
@@ -759,99 +712,40 @@ export declare type Configuration = Partial<CombinedConfiguration>;
 
 export { ContentFillMode }
 
-export { CreateSceneOptions }
-
 /**
- * The main entry point for the Creative Editor SDK.
- *
- * This class provides a comprehensive interface for creating, configuring, and managing
- * creative editing experiences using our ready-made editor. The SDK can be configured to
- * serve a multitude of use cases, offering a wide range of features such as asset management,
- * scene creation, export operations, and plugin management.
- *
- * ## Categories
- * @categoryDescription Members
- * Instance members that allow access to the underlying engine, user interface, and configuration APIs.
- * @categoryDescription Asset Management
- * Methods for registering, managing, and refreshing asset sources including default assets,
- * demo assets, and custom asset libraries.
- * @categoryDescription Scene Creation
- * Methods for creating new scenes from scratch, including design scenes, video scenes,
- * and scenes from existing images.
- * @categoryDescription Scene Loading
- * Methods for loading existing scenes from various sources including strings, URLs,
- * and encoded scene data.
- * @categoryDescription Scene Saving
- * Methods for persisting and exporting scene data as strings or files.
- * @categoryDescription Export Operations
- * Methods for exporting scenes and pages as files in various formats and mimeTypes.
- * @categoryDescription Configuration
- * Methods for configuring SDK behavior, translations, and runtime settings.
- * @categoryDescription Page Management
- * Methods for managing multiple pages within scenes, including navigation and visibility control.
- * @categoryDescription Plugin Management
- * Methods for extending SDK functionality through plugins and custom integrations.
- * @categoryDescription Upload Operations
- * Methods for handling file uploads and asset creation from user-provided files.
- * @categoryDescription Lifecycle Management
- * Methods for SDK initialization, cleanup, and resource management.
- *
  * @public
  */
 declare class CreativeEditorSDK {
     #private;
-    /**
-     * Access to the CreativeEngine instance that powers the editor.
-     * @category Members
-     */
     engine: CreativeEngine_2;
-    /**
-     * Access to the {@link UserInterfaceAPI} for controlling the editor's user interface
-     * @category Members
-     */
     ui: UserInterfaceAPI;
-    /**
-     * Access to the {@link InternationalizationAPI} to control locale and translations
-     * @category Members
-     */
-    i18n: InternationalizationAPI;
-    /**
-     * Access to the {@link FeatureAPI} to control feature availability
-     * @category Members
-     * */
+    i18n: InternationalisationAPI;
     feature: FeatureAPI;
-    /**
-     * The version of the Creative Editor SDK
-     * @category Members
-     */
     version: string;
     /**
-     * Convenience function to register a set of our default asset sources.
-     *
-     * The sources contain our example assets. These are:
+     * Convenience function that registers a set of asset sources containing our
+     * example assets. These are
      *
      * - `'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
+     * - `'ly.img.filter.lut'` - LUT effects of various kinds.
+     * - `'ly.img.filter.duotone'` - Color effects of various kinds.
      *
-     * These assets are parsed from the IMG.LY CDN at `\{\{base_url\}\}/<id>/content.json`, where
-     * `baseURL` defaults to 'https://cdn.img.ly/assets/v3'.
+     * These assets are parsed from the IMG.LY CDN at \{\{base_url\}\}/<id>/content.json, where
+     * `base_url` defaults to 'https://cdn.img.ly/assets/v3'.
      * Each source is created via `addLocalSource` and populated with the parsed assets. To modify the available
      * assets, you may either exclude certain IDs via `excludeAssetSourceIds` or alter the sources after creation.
      *
-     * @category Asset Management
-     * @param baseURL - The source of the asset definitions, must be absolute. Defaults to 'https://cdn.img.ly/assets/v3'.
-     * @param excludeAssetSourceIds - A list of IDs that will be ignored during load.
+     * @param baseURL - The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/v3'`.
+     * @param excludeAssetSourceIds - A list of IDs, that will be ignored during load.
      */
     addDefaultAssetSources({ baseURL, excludeAssetSourceIds }?: {
         baseURL?: string;
         excludeAssetSourceIds?: DefaultAssetSourceId[];
     }): Promise<void>;
     /**
-     * Convenience function that registers a set of demo asset sources
-     *
-     * These contain our example assets. These are not to meant to be used in your production code.
+     * Convenience function that registers a set of demo asset sources containing our
+     * example assets. These are not to meant to be used in your production code.
      *
      * These are
      *
@@ -862,10 +756,8 @@ declare class CreativeEditorSDK {
      * - `'ly.img.video'` - Sample videos
      * - `'ly.img.video.upload'` - Demo source to upload video assets
      *
-     * @category Asset Management
-     * @param baseURL - The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/demo/v2'`.
-     * @param excludeAssetSourceIds - A list of IDs that will be ignored during load.
-     * @param sceneMode - If 'Video', video specific demo asset sources will be loaded as well. Parsed from global configuration if not set.
+     * @param excludeAssetSourceIds - A list of IDs, that will be ignored during load.
+     * @param sceneMode - if 'Video' video specific demo asset sources will be loaded as well. Parsed from global configuration if not set.
      */
     addDemoAssetSources({ baseURL, excludeAssetSourceIds, sceneMode }?: {
         baseURL?: string;
@@ -878,7 +770,6 @@ declare class CreativeEditorSDK {
      * Please note: the `onExport` callback provided in the configuration will be
      * not called. This callback is for exports triggered by an user interaction.
      *
-     * @category Export Operations
      * @param options -  options for the export
      *
      * @returns a promise with an object holding `blobs` of the export pages and the provided `options`.
@@ -889,13 +780,11 @@ declare class CreativeEditorSDK {
     }>;
     /**
      * Create a scene with a single empty page with the given format.
-     * @category Scene Creation
      * @param format - A `PageFormatDefinition` object specifying the page format to use.
      */
     createDesignScene(format?: PageFormatDefinition): Promise<number>;
     /**
      * Create a scene with a single empty page with the given format.
-     * @category Scene Creation
      * @param format - The page format to use. Can be either a string, identifying
      * a page format that has been configured or a `PageFormatDefinition` object.
      */
@@ -903,53 +792,44 @@ declare class CreativeEditorSDK {
     /**
      *  Load an encoded scene from the provided string.
      * @deprecated Use `loadFromString` instead.
-     * @category Scene Loading
      * @param scene -  A string starting with UBQ1 and containing the encoded scene.
      */
     load(scene: string): Promise<number>;
     /**
      * Load an encoded scene from the provided string.
-     * @category Scene Loading
      * @param scene -  A string starting with UBQ1 and containing the encoded scene.
      * @returns a promise which resolves if the scene was successfully loaded.
      */
     loadFromString(scene: string): Promise<number>;
     /**
      * Load the scene stored in the file at the given URL.
-     * @category Scene Loading
      * @param url - The url to fetch to acquire the scene string.
      * @returns a promise which resolves if the scene was successfully loaded.
      */
     loadFromURL(url: string): Promise<number>;
     /**
      * Create a scene from the provided image.
-     * @category Scene Creation
      * @param url - The url of the image
      * @returns a promise which resolves if the scene was successfully loaded.
      */
     createFromImage(url: string): Promise<number>;
     /**
-     * Disable the warning logged when no scene is available.
-     *
      * If no scene is available, 2 seconds after `CreativeEditorSDK.create()`,
      * a warning is shown on the console. This method disables this warning.
      * That can be useful in situation where you are waiting for long running
      * async processes to finish before creating the scene.
-     * @category Configuration
      */
     disableNoSceneWarning(): void;
     /**
      * Save and return a scene as a base64 encoded string.
      *
-     * @category Scene Saving
      * @returns a promise with the scene as a string
      */
     save(): Promise<string>;
     /**
      * Adds translations to be used by the editor.
      *
-     * @category Configuration
-     * @param definition - locale to a translation object
+     * @param translations - locale to a translation object
      *
      * @example
      * ```
@@ -965,46 +845,25 @@ declare class CreativeEditorSDK {
     setTranslations(definition: {
         [locale: string]: object;
     }): void;
-    /**
-     * @category Page Management
-     * @experimental This API is experimental and may change or be removed in future versions.
-     */
     unstable_switchPage(pageId: number): Promise<void>;
-    /**
-     * @category Page Management
-     * @experimental This API is experimental and may change or be removed in future versions.
-     */
     unstable_getPages(): Promise<number[]>;
-    /**
-     * @category Page Management
-     * @experimental This API is experimental and may change or be removed in future versions.
-     */
     unstable_onActivePageChanged(callback: (id: number) => void): () => void;
-    /**
-     * @category Page Management
-     * @experimental This API is experimental and may change or be removed in future versions.
-     */
     unstable_focusPage(pageId: number): Promise<void>;
     /**
      * Adds and initializes a plugin to the editor.
-     * @category Plugin Management
      */
     addPlugin(plugin: EditorPlugin): void;
     /**
      * Returns true if a upload handler was configured. If mime types are given
      * as an argument, it will return true if the upload handler supports all of
      * the given mime types.
-     * @category Upload Operations
-     * @experimental This API is experimental and may change or be removed in future versions.
      */
     unstable_supportsUpload(mimeTypes?: string | string[]): boolean;
     /**
      * Uses the configured upload handler to upload the given file.
      *
-     * @category Upload Operations
      * @param file - The file to upload
      * @param onProgress - A callback to track the progress of the upload
-     * @experimental This API is experimental and may change or be removed in future versions.
      */
     unstable_upload(file: File, onProgress: (progress: number) => void): Promise<AssetDefinition>;
     /**
@@ -1013,12 +872,10 @@ declare class CreativeEditorSDK {
      * @param sourceId - The ID or IDs of the asset sources to refetch. If not provided, all asset sources will be refetched.
      *
      * @deprecated Please use `cesdk.engine.asset.assetSourceContentsChanged` instead.
-     * @category Asset Management
      */
     refetchAssetSources(sourceId?: string | string[]): void;
     /**
      * Disposes the editor and engine if no longer needed.
-     * @category Lifecycle Management
      */
     dispose(): void;
     /**
@@ -1036,7 +893,6 @@ declare class CreativeEditorSDK {
      * load or create an initial scene. Until then the CreativeEditorSDK will
      * display a loading spinner
      *
-     * @category Lifecycle Management
      * @param container -  the container to mount the editor as a HTML element or selector
      * @param config - the initial configuration to create the editor
      *
@@ -1211,8 +1067,6 @@ export declare interface DropdownOptions {
     suffix?: Suffix;
 }
 
-export { DropShadowOptions }
-
 export { EditMode }
 
 export { EditorAPI }
@@ -1224,8 +1078,7 @@ export declare interface EditorPlugin {
     initialize: (context: EditorPluginContext) => void;
 }
 
-/** @public */
-export declare type EditorPluginContext = EnginePluginContext & {
+declare type EditorPluginContext = EnginePluginContext & {
     cesdk?: CreativeEditorSDK;
 };
 
@@ -1443,55 +1296,31 @@ export declare interface ExportOptions extends Pick<EngineExportOptions, 'pngCom
 }
 
 /**
- * Controls the availability of features within the Creative Editor SDK.
- *
- * The FeatureAPI allows you to enable or disable specific functionality
- * within the editor based on custom conditions or user permissions.
- *
- * @categoryDescription Feature Control
- * Methods for enabling and checking the status of editor features based on custom predicates.
+ * A public interface for enable/disable features of the Creative Editor SDK
  *
  * @public
  */
-export declare class FeatureAPI {
+declare class FeatureAPI {
     #private;
     /**
-     * Enables one or more features based on the provided predicate.
-     *
-     * The predicate can be either a boolean value that determines if the feature
-     * is enabled or disabled, a function that receives a context object and
-     * returns a boolean, or omitted to get the default behavior. The context contains
-     * the `isPreviousEnabled` function
-     * which allows you to check if a feature was previously enabled by other
-     * enable calls, including the CE.SDK editor defaults. This enables you to
-     * further restrict features without reimplementing existing logic.
+     * Enables a feature with the given predicate. The predicate is either a
+     * boolean that enforces if the features is enabled or not or a function
+     * that takes a context and returns a boolean value.
      *
-     * To use our defaults you can simply omit passing a predicate when enabling a feature.
-     * ```javascript
-     * cesdk.feature.enable('ly.img.delete');
-     * cesdk.feature.enable('ly.img.duplicate');
-     * ```
-     *
-     * You can also extend the default predicate provided for built-in features.
-     *
-     * ```javascript
-     * cesdk.feature.enable('ly.img.delete', ({ defaultPredicate }) =>
-     *   return defaultPredicate() && (new Date().getHours() >= 22);
-     * );
-     * ```
+     * The context contains the `isPreviousEnable` function that can be used to
+     * query if a feature was enabled before by other `enable` calls, e.g. the
+     * defaults from the CE.SDK editor itself. This can be used to further
+     * restrict a feature without re-implementing the existing logic.
      *
-     * @category Feature Control
-     * @param featureId - The feature ID or array of feature IDs to enable.
-     * @param predicate - The condition that determines if the feature is enabled.
+     * @param featureId - The feature ID to enable
+     * @param predicate - The predicate to enable the feature
      */
     enable(featureId: FeatureId | FeatureId[], predicate?: FeaturePredicate): void;
     /**
-     * Checks if a specific feature is currently enabled.
+     * Queries if the feature is currently enabled.
      *
-     * @category Feature Control
-     * @param featureId - The feature ID to check.
-     * @param context - The context object containing a reference to the underlying engine.
-     * @returns True if the feature is enabled, false otherwise.
+     * @param featureId - The feature ID to query
+     * @param context - The context to query, mainly an instance of the engine
      */
     isEnabled(featureId: FeatureId, context: IsEnabledFeatureContext): boolean;
 }
@@ -1501,7 +1330,7 @@ export declare class FeatureAPI {
  *
  * @public
  */
-export declare type FeatureId = 'ly.img.navigationBar' | 'ly.img.navigate.back' | 'ly.img.navigate.close' | 'ly.img.navigate.undoRedo' | 'ly.img.navigate.zoom' | 'ly.img.navigate.actions' | 'ly.img.delete' | 'ly.img.duplicate' | 'ly.img.placeholder' | 'ly.img.preview' | 'ly.img.page.move' | 'ly.img.page.add' | 'ly.img.group' | 'ly.img.replace' | 'ly.img.text.edit' | 'ly.img.text.typeface' | 'ly.img.text.fontSize' | 'ly.img.text.fontStyle' | 'ly.img.text.alignment' | 'ly.img.text.advanced' | 'ly.img.text.background' | 'ly.img.adjustment' | 'ly.img.filter' | 'ly.img.effect' | 'ly.img.blur' | 'ly.img.shadow' | 'ly.img.cutout' | 'ly.img.fill' | 'ly.img.shape.options' | 'ly.img.combine' | 'ly.img.trim' | 'ly.img.crop' | 'ly.img.volume' | 'ly.img.stroke' | 'ly.img.position' | 'ly.img.animations' | 'ly.img.opacity' | 'ly.img.blendMode' | 'ly.img.videoTimeline' | 'ly.img.video.caption' | 'ly.img.transform.position' | 'ly.img.transform.size' | 'ly.img.transform.rotation' | 'ly.img.transform.flip' | 'ly.img.inspectorBar' | 'ly.img.inspectorToggle' | 'ly.img.page.resize' | 'ly.img.dock' | 'ly.img.canvasBar' | 'ly.img.canvasMenu' | 'ly.img.inspector' | (string & {});
+export declare type FeatureId = 'ly.img.navigationBar' | 'ly.img.navigate.back' | 'ly.img.navigate.close' | 'ly.img.navigate.undoRedo' | 'ly.img.navigate.zoom' | 'ly.img.navigate.actions' | 'ly.img.delete' | 'ly.img.duplicate' | 'ly.img.placeholder' | 'ly.img.preview' | 'ly.img.page.move' | 'ly.img.page.add' | 'ly.img.group' | 'ly.img.replace' | 'ly.img.text.edit' | 'ly.img.text.typeface' | 'ly.img.text.fontSize' | 'ly.img.text.fontStyle' | 'ly.img.text.alignment' | 'ly.img.text.advanced' | 'ly.img.text.background' | 'ly.img.adjustment' | 'ly.img.filter' | 'ly.img.effect' | 'ly.img.blur' | 'ly.img.shadow' | 'ly.img.cutout' | 'ly.img.fill' | 'ly.img.shape.options' | 'ly.img.combine' | 'ly.img.trim' | 'ly.img.crop' | 'ly.img.volume' | 'ly.img.stroke' | 'ly.img.position' | 'ly.img.animations' | 'ly.img.opacity' | 'ly.img.blendMode' | 'ly.img.videoTimeline' | 'ly.img.video.caption' | 'ly.img.transform.position' | 'ly.img.transform.size' | 'ly.img.transform.rotation' | 'ly.img.transform.flip' | 'ly.img.inspectorBar' | 'ly.img.inspectorToggle' | 'ly.img.page.resize' | 'ly.img.dock' | (string & {});
 
 /**
  * The feature predicate is used to enable or disable a feature
@@ -1589,86 +1418,26 @@ declare const INSPECTOR_BAR_TRANSFORM_ORDER_DEFAULT: readonly ["ly.img.spacer",
 declare const INSPECTOR_BAR_TRIM_ORDER_DEFAULT: readonly ["ly.img.trimControls.inspectorBar"];
 
 /**
- * A list of the component IDs that can be used in the inspector bar.
- *
- * Includes the following IDs:
- * - 'ly.img.separator'
- * - 'ly.img.spacer'
- * - 'ly.img.video.caption.inspectorBar',
- * - 'ly.img.shape.options.inspectorBar',
- * - 'ly.img.cutout.type.inspectorBar',
- * - 'ly.img.cutout.offset.inspectorBar',
- * - 'ly.img.cutout.smoothing.inspectorBar',
- * - 'ly.img.group.create.inspectorBar',
- * - 'ly.img.group.ungroup.inspectorBar',
- * - 'ly.img.audio.replace.inspectorBar',
- * - 'ly.img.text.typeFace.inspectorBar',
- * - 'ly.img.text.style.inspectorBar',
- * - 'ly.img.text.bold.inspectorBar',
- * - 'ly.img.text.italic.inspectorBar',
- * - 'ly.img.text.fontSize.inspectorBar',
- * - 'ly.img.text.alignHorizontal.inspectorBar',
- * - 'ly.img.text.advanced.inspectorBar',
- * - 'ly.img.combine.inspectorBar',
- * - 'ly.img.fill.inspectorBar',
- * - 'ly.img.trim.inspectorBar',
- * - 'ly.img.volume.inspectorBar',
- * - 'ly.img.crop.inspectorBar',
- * - 'ly.img.stroke.inspectorBar',
- * - 'ly.img.text.background.inspectorBar',
- * - 'ly.img.animations.inspectorBar',
- * - 'ly.img.adjustment.inspectorBar',
- * - 'ly.img.filter.inspectorBar',
- * - 'ly.img.effect.inspectorBar',
- * - 'ly.img.blur.inspectorBar',
- * - 'ly.img.shadow.inspectorBar',
- * - 'ly.img.opacityOptions.inspectorBar',
- * - 'ly.img.position.inspectorBar',
- * - 'ly.img.inspectorToggle.inspectorBar'
- * - 'ly.img.trimControls.inspectorBar',
- * - 'ly.img.cropControls.inspectorBar'
  * @public
  */
 export declare type InspectorBarComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof INSPECTOR_BAR_TRANSFORM_ORDER_DEFAULT)[number] | (typeof INSPECTOR_BAR_TRIM_ORDER_DEFAULT)[number] | (typeof INSPECTOR_BAR_CROP_ORDER_DEFAULT)[number] | (string & {});
 
-/**
- * Manages localization and internationalization settings for the Creative Editor SDK.
- *
- * The InternationalisationAPI provides methods to get and set the current locale,
- * as well as add custom translations for the editor interface.
- *
- * @categoryDescription Localization
- * Methods for managing locale settings and custom translations within the editor.
- *
- * @public
- */
-export declare class InternationalizationAPI {
+declare class InternationalisationAPI {
     #private;
     /**
-     * Gets the currently active locale.
-     *
-     * @category Localization
-     * @returns The currently set locale as a string, or the fallback locale if none is set.
+     * Returns the currently set locale.
+     * @returns Currently set locale as string
      */
     getLocale(): string;
     /**
-     * Sets the active locale for the editor interface.
-     *
-     * This will **not check** whether translations for the given locale are available.
-     *
-     * @category Localization
-     * @param locale - The locale string to set as active (e.g., 'en', 'de', 'fr').
+     * Updates the current locale to the one passed as parameter.
+     * @param locale - String to which the locale should be updated to
      */
     setLocale: (locale: string) => void;
     /**
-     * Adds custom translations for the editor interface.
-     *
-     * This method allows you to provide custom translations that will be used
-     * by the editor interface. Translations are organized by locale and can
-     * override or extend the default editor translations.
+     * Adds translations to be used by the editor.
      *
-     * @category Localization
-     * @param definition - An object mapping locale strings to translation objects.
+     * @param translations - locale to a translation object
      *
      * @example
      * ```
@@ -1686,8 +1455,7 @@ export declare class InternationalizationAPI {
     }): void;
 }
 
-/** @public */
-export declare type IsEnabledFeatureContext = {
+declare type IsEnabledFeatureContext = {
     engine: CreativeEngine_2;
 };
 
@@ -1725,20 +1493,6 @@ export { MimeType_2 as MimeType }
 declare const NAVIGATION_BAR_ORDER_DEFAULT: readonly ["ly.img.back.navigationBar", "ly.img.undoRedo.navigationBar", "ly.img.pageResize.navigationBar", "ly.img.spacer", "ly.img.title.navigationBar", "ly.img.spacer", "ly.img.zoom.navigationBar", "ly.img.preview.navigationBar", "ly.img.actions.navigationBar", "ly.img.close.navigationBar"];
 
 /**
- * A list of the component IDs that can be used in the navigation bar.
- *
- * Includes the following IDs:
- * - 'ly.img.separator'
- * - 'ly.img.spacer'
- * - 'ly.img.back.navigationBar'
- * - 'ly.img.undoRedo.navigationBar'
- * - 'ly.img.pageResize.navigationBar'
- * - 'ly.img.title.navigationBar'
- * - 'ly.img.zoom.navigationBar'
- * - 'ly.img.preview.navigationBar'
- * - 'ly.img.actions.navigationBar'
- * - 'ly.img.close.navigationBar'
- *
  * @public
  */
 export declare type NavigationBarComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof NAVIGATION_BAR_ORDER_DEFAULT)[number] | (string & {});
@@ -2096,36 +1850,11 @@ export declare interface UserInterface {
 }
 
 /**
- * Control the user interface and behavior of the Creative Editor SDK.
- *
- * The UserInterfaceAPI provides comprehensive methods for managing panels,
- * notifications, dialogs, component registration, UI ordering, asset libraries,
- * and custom interface elements within the editor.
- *
- * @categoryDescription Panel Management
- * Methods for opening, closing, and configuring panels within the editor interface.
- *
- * @categoryDescription Notifications
- * Methods for displaying and managing user notifications and messages.
- *
- * @categoryDescription Dialogs
- * Methods for showing, updating, and closing modal dialogs.
- *
- * @categoryDescription Component Registration
- * Methods for registering custom components and panels in the editor.
- *
- * @categoryDescription UI Layout
- * Methods for controlling the order and arrangement of UI components.
- *
- * @categoryDescription Asset Library
- * Methods for managing asset library entries and configurations.
- *
- * @categoryDescription Experimental Features
- * Experimental APIs that may change or be removed in future versions.
+ * A public interface for controlling the UI of the Creative Editor SDK
  *
  * @public
  */
-export declare class UserInterfaceAPI {
+declare class UserInterfaceAPI {
     #private;
     /**
      * PLEASE NOTE: This contains experimental APIs.
@@ -2137,170 +1866,157 @@ export declare class UserInterfaceAPI {
      */
     experimental: ExperimentalUserInterfaceAPI.UserInterfaceAPI;
     /**
-     * Opens a panel if it exists, is not already open, and is currently registered.
+     * Opens a panel with the given id if and only if it exists, is not open and
+     * currently registered (known to the UI). Otherwise the method does nothing
+     * and is a noop.
      *
-     * If requirements are not met, this is a no-op.
+     * Available panel ids beside custom panel ids:
+     * - `//ly.img.panel/inspector`
+     *   opening the inspector panel for the current selected block
+     * - `//ly.img.panel/assetLibrary.replace`
+     *   opening the library with asset to replace the currently selected block.
+     *   Beware that the library might show nothing depending on how it configured.
      *
-     * Available built-in panel IDs:
-     * - `//ly.img.panel/inspector` - Opens the inspector panel for the selected block
-     * - `//ly.img.panel/assetLibrary.replace` - Opens the asset library for replacing the selected block. Beware that the library might show nothing depending on how it was configured.
-     *
-     * @category Panel Management
-     * @param panelId - The ID of the panel to open.
-     * @param options - Optional configuration for panel position and floating state.
+     * @param panelId - The id of the panel to open.
+     * @param options - Options to override the position and floating state of the panel.
      */
     openPanel<T extends PanelId>(panelId: T, options?: PanelOptions<T>): void;
     /**
-     * Closes a panel if it exists and is currently open.
-     *
+     * Closes a panel with the given id if and only if it exists and is open.
      * Otherwise the method does nothing and is a noop.
      *
-     * Available built-in panel IDs:
-     * - `//ly.img.panel/inspector` - Closes the inspector panel
-     * - `//ly.img.panel/assetLibrary` - Closes the asset library
-     * - `//ly.img.panel/assetLibrary.replace` - Closes the replacement asset library
+     * Available panel ids beside custom panel ids:
+     * - `//ly.img.panel/inspector`
+     *   closing the inspector panel for the current selected block
+     * - `//ly.img.panel/assetLibrary`
+     *   closing the currently open library
+     * - `//ly.img.panel/assetLibrary.replace`
+     *   closing the library with asset to replace the currently selected block.
      *
-     * @category Panel Management
-     * @param panelId - The ID of the panel to close.
+     * @param panelId - The id of the panel to close.
      */
     closePanel(panelId: string): void;
     /**
-     * Checks if a panel is currently open.
+     * Returns `true` if and only if a panel with the given id is open.
      *
-     * Available built-in panel IDs:
-     * - `//ly.img.panel/inspector` - Inspector panel for the selected block
-     * - `//ly.img.panel/assetLibrary` - Asset library panel
-     * - `//ly.img.panel/assetLibrary.replace` - Replacement asset library panel
+     * Available panel ids beside custom panel ids:
+     * - `//ly.img.panel/inspector`
+     *   inspector panel for the current selected block
+     * - `//ly.img.panel/assetLibrary`
+     *   the asset library
+     * - `//ly.img.panel/assetLibrary.replace`
+     *   closing the library with asset to replace the currently selected block.
      *
-     * @category Panel Management
-     * @param panelId - The ID of the panel to check.
-     * @param options - Optional criteria to match against the panel's current state.
-     * @returns True if the panel is open and matches the specified options, false otherwise.
+     * @param panelId - The id of a panel that might be open
+     * @param options - Check if the panel is open with these specific options
      */
     isPanelOpen<T extends PanelId>(panelId: T, options?: PanelOptions<T>): boolean;
     /**
-     * Gets all panel IDs, optionally filtered by state or position.
+     * Returns all panel ids. An optional filter can be applied to only
+     * return panels that are open or have a specific position.
      *
-     * @category Panel Management
-     * @param options - Optional filter criteria for panel state and position.
-     * @returns Array of panel IDs matching the specified criteria.
-     *
-     * @example
+     * E.g.:
      * ```
      * cesdk.ui.findAllPanels();
      * cesdk.ui.findAllPanels({ open: true, position: 'left' });
      * ```
+     *
+     * @param options - Return panel ids with these specific options
+     * @returns All panel ids (that match the given options if provided)
      */
     findAllPanels<T extends PanelId>(options?: PanelOptions<T> & {
         open?: boolean;
     }): string[];
     /**
-     * Sets the position of a panel within the editor interface.
+     * Set the position of the panel in the editor
      *
-     * @category Panel Management
-     * @param panelId - The ID of the panel to position.
-     * @param panelPosition - The position ('left' or 'right') or a function returning the position.
+     * @param panelId - The id of a panel to set the position
+     * @param panelPosition - either `left` or `right`
      */
     setPanelPosition(panelId: string, panelPosition: PanelPosition | (() => PanelPosition)): void;
     /**
-     * Gets the current position of a panel.
+     * Returns the position for a panel either `left` or `right`
      *
-     * @category Panel Management
-     * @param panelId - The ID of the panel.
-     * @returns The panel's position ('left' or 'right').
+     * @param panelId - The id of a panel to get the position
      */
     getPanelPosition(panelId: string): PanelPosition;
     /**
-     * Sets whether a panel floats over the canvas.
+     * Set if the panel is floating over the canvas
      *
-     * @category Panel Management
-     * @param panelId - The ID of the panel to configure.
-     * @param floating - True to make the panel float over the canvas, false to dock it.
+     * @param panelId - The id of a panel to set the position
+     * @param floating - A boolean that determines if the panel is floating over the canvas
      */
     setPanelFloating(panelId: string, floating: boolean | (() => boolean)): void;
     /**
-     * Checks if a panel is currently floating over the canvas.
+     * Returns if the given panel is floating over the canvas
      *
-     * @category Panel Management
-     * @param panelId - The ID of the panel to check.
-     * @returns True if the panel is floating, false if it's docked.
+     * @param panelId - The id of a panel to determine if it is floating
      */
     getPanelFloating(panelId: string): boolean;
     /**
-     * Displays a non-blocking notification message to the user.
-     *
-     * Notifications appear temporarily and can be dismissed by the user.
-     * They support different types (info, success, warning, error) and durations.
+     * Shows a notification to the user. A notification is a non-blocking
+     * message that is shown to the user for a certain amount of time.
+     * The user can dismiss the notification.
      *
-     * @category Notifications
-     * @param notification - The notification content as a string or notification object.
-     * @returns The notification ID for programmatic updates or dismissal.
+     * @param notification - The notification to show. Can be a string or an notification object.
+     * @returns The id of the notification that is shown. Can be used to programmatically update or dismiss the notification.
      */
     showNotification(notification: string | Notification_2): string;
     /**
-     * Dismisses a notification programmatically.
+     * Programmatically dismisses a notification with the given id.
      *
-     * @category Notifications
-     * @param id - The ID of the notification to dismiss.
+     * @param id - The id of the notification to dismiss.
      */
     dismissNotification(id: string): void;
     /**
-     * Updates an existing notification with new content or properties.
+     * Programmatically updates a notification with the given id. The
+     * notification object will be merged into the existing notification.
      *
-     * The notification object will be merged with the existing notification.
-     * If the duration is updated, the timeout will be reset. Updates to
-     * dismissed notifications are ignored.
+     * If the duration is updated, the current timeout will be cleared and set to
+     * the new duration. If the notification is already dismissed, the update is
+     * a noop.
      *
-     * @category Notifications
-     * @param id - The ID of the notification to update.
-     * @param notification - Partial notification properties to merge.
+     * @param id - The id of the notification to dismiss.
+     * @param notification - The partial notification object that will be merged into the notification.
      */
     updateNotification(id: string, notification: Partial<Notification_2>): void;
     /**
-     * Displays a modal dialog with custom content and actions.
+     * Programmatically show a dialog with the given content. The dialog
+     * can be of different types (e.g. `info`, `success`, `warning`, `error`,
+     * `loading`) and can have different actions (e.g. `OK`, `Cancel`).
      *
-     * Dialogs can have different types (info, success, warning, error, loading)
-     * and support custom actions like OK, Cancel, or custom buttons.
-     *
-     * @category Dialogs
-     * @param dialog - The dialog content as a string or dialog object.
-     * @returns The dialog ID for programmatic updates or closure.
+     * @param dialog - The dialog to show. Can be a string or a dialog object.
+     * @returns - The id of the dialog. Can be used to programmatically close or update the dialog.
      */
     showDialog(dialog: string | Dialog): string;
     /**
-     * Updates an existing dialog with new content or properties.
-     *
-     * The dialog properties will be merged with the existing dialog configuration.
+     * Update a dialog with the given id. The dialog will be updated with the
+     * given partial dialog object. The dialog will be merged with the existing dialog.
      *
-     * @category Dialogs
-     * @param id - The ID of the dialog to update.
-     * @param dialog - Partial dialog properties to merge, or a function that receives the current dialog and returns updates.
+     * @param id - The id of the dialog to update.
+     * @param dialog - The partial dialog object that will be merged into the dialog.
      */
     updateDialog(id: string, dialog: Partial<Dialog> | ((dialog: Dialog) => Partial<Dialog>)): void;
     /**
-     * Closes a dialog programmatically.
+     * Programmatically close a registered dialog with the given id. If the dialog is already closed, the close call is a noop.
      *
-     * If the dialog has an onClose callback, it will be executed before removal.
-     * Closing an already closed dialog has no effect.
-     *
-     * @category Dialogs
-     * @param id - The ID of the dialog to close.
+     * @param id - The id of the dialog to close.
      */
     closeDialog(id: string): void;
     /**
-     * Registers a custom panel that hooks into a DOM element for custom UI rendering.
+     * Registeres a custom panel to hook into a dom element and render any
+     * custom UI code.
      *
-     * The onMount function is called when the panel opens, and its return value
-     * (if a function) is called when the panel closes for cleanup.
+     * The `onMount` function will be called if the panel is opened (e.g. via the `openPanel` API).
+     * The returned function of the `onMount` call will be called once the panels closes.
      *
-     * @category Experimental Features
-     * @param panelId - The unique ID for the custom panel.
-     * @param onMount - Function called when the panel is mounted, should return a cleanup function.
-     * @experimental This API may change or be removed in future versions.
+     * Please be aware that this is experimental right now. This API can change or
+     * be replaced or even removed completely in future versions.
      */
     unstable_registerCustomPanel(panelId: string, onMount: CustomPanelMountFunction): void;
     /**
-     * Registers a panel with builder-based rendering system.
+     * Registers a panel which content can be rendered with a panel builder,
+     * comparable to the way we register custom components.
      *
      * The builder render function will be called with a builder and the engine
      * as arguments. The builder object is used to defined what base components
@@ -2308,22 +2024,17 @@ export declare class UserInterfaceAPI {
      * state from the engine. The render function will be re-called if anything
      * in the engine changes regarding the made engine calls.
      *
-     * @category Component Registration
-     * @param panelId - The panel ID for use with panel management APIs.
-     * @param renderPanel - Function that renders the panel content using the builder system.
+     * @param panelId - The id of the panel that can be used in with the Panel APIs.
+     * @param renderPanel - The render function that will be called to render the content of the panel
      */
     registerPanel<P extends ComponentPayload = ComponentPayload>(panelId: string, renderPanel: BuilderRenderFunction<P>): void;
     /**
-     * Registers a panel with builder-based rendering system.
-     *
-     * @category Component Registration
-     * @param panelId - The panel ID for use with panel management APIs.
-     * @param renderComponent - Function that renders the panel content using the builder system.
      * @deprecated Use `registerPanel` instead.
      */
     unstable_registerPanel<P extends ComponentPayload = ComponentPayload>(panelId: string, renderComponent: BuilderRenderFunction<P>): void;
     /**
-     * Registers a component that can be rendered at different UI locations.
+     * Registers a component that can be used and rendered at different
+     * locations in the UI.
      *
      * The builder render function will be called with a builder and the engine
      * as arguments. The builder object is used to defined what base components
@@ -2331,28 +2042,25 @@ export declare class UserInterfaceAPI {
      * state from the engine. The render function will be re-called if anything
      * in the engine changes regarding the made engine calls.
      *
-     * @category Component Registration
-     * @param ids - The component ID or array of IDs for use in ordering APIs.
-     * @param renderComponent - Function that renders the component using the builder system.
+     * @param id - The id of the component that can be used in the order APIs. Might be an array of ids. In this case the component is registered for all ids.
+     * @param renderComponent - The render function that will be called to render the component
      */
     registerComponent<P extends ComponentPayload = ComponentPayload>(ids: string | string[], renderComponent: BuilderRenderFunction<P>): void;
     /**
-     * Sets the rendering order of components in the dock area.
-     *
-     * The ids in this order refer to registered default components or custom components
+     * Defines in what order components are rendered in the dock. The
+     * id in this order refer to registered default components or custom components
      * registered in `registerComponent`.
      *
      * Different orders can be set depending on different contexts. The context
      * consists of the edit mode (e.g. `Transform` or `Text`) right now. If no
      * context is given, the default order is set for the `Transform` edit mode.
      *
-     * @category UI Layout
-     * @param dockOrder - Array of component IDs defining the dock order.
-     * @param orderContext - Optional context specifying when this order applies.
+     * @param dockOrder - The order of components in the dock
+     * @param orderContext - The context in which the order should be set
      */
     setDockOrder(dockOrder: (DockOrderComponentId | DockOrderComponent)[], orderContext?: OrderContext): void;
     /**
-     * Gets the current rendering order of dock components.
+     * Returns the current order of components that are rendered in the dock.
      *
      * The id in this order refer to registered default components or custom components
      * registered in `registerComponent`.
@@ -2362,15 +2070,12 @@ export declare class UserInterfaceAPI {
      * If no context is given, the default order (with `Transform` edit mode) is
      * returned.
      *
-     * @category UI Layout
-     * @param orderContext - Optional context specifying which order to retrieve.
-     * @returns Array of component configurations defining the dock order.
+     * @param orderContext - The context for the requested order
+     * @returns The order of components in the dock
      */
     getDockOrder(orderContext?: OrderContext): DockOrderComponent[];
     /**
-     * Sets the rendering order of components in the inspector bar.
-     *
-     * The
+     * Defines in what order components are rendered in the inspector bar. The
      * id in this order refer to registered default components or custom components
      * registered in `registerComponent`.
      *
@@ -2378,189 +2083,192 @@ export declare class UserInterfaceAPI {
      * consists of the edit mode (e.g. `Transform` or `Text`) right now. If no
      * context is given, the default order is set for the `Transform` edit mode.
      *
-     * @category UI Layout
-     * @param inspectorBarOrder - Array of component IDs defining the inspector bar order.
-     * @param orderContext - Optional context specifying when this order applies.
+     * @param inspectorBarOrder - The order of components in the inspector bar
+     * @param orderContext - The context in which the order should be set
      */
     setInspectorBarOrder(inspectorBarOrder: (InspectorBarComponentId | OrderComponent<InspectorBarComponentId>)[], orderContext?: OrderContext): void;
     /**
-     * Gets the current rendering order of inspector bar components.
+     * Returns the current order of components that are rendered in the inspector bar.
+     *
+     * The id in this order refer to registered default components or custom components
+     * registered in `registerComponent`.
      *
-     * Component IDs refer to built-in components or those registered via
-     * registerComponent. Returns the order for the specified context, or
-     * defaults to Transform mode if no context is provided.
+     * Different orders could have been set depending on different contexts.
+     * The context consists of the edit mode (e.g. `Transform` or `Text`) right now.
+     * If no context is given, the default order (with `Transform` edit mode) is
+     * returned.
      *
-     * @category UI Layout
-     * @param orderContext - Optional context specifying which order to retrieve.
-     * @returns Array of component configurations defining the inspector bar order.
+     * @param orderContext - The context for the requested order
+     * @returns The order of components in the inspector bar
      */
     getInspectorBarOrder(orderContext?: OrderContext): OrderComponent[];
     /**
-     * Sets the rendering order of components in the canvas menu.
+     * Defines what in what order components are rendered in the canvas menu. The
+     * id in this order refer to registered default components or custom components
+     * registered in `registerComponent`.
      *
-     * Component IDs refer to built-in components or those registered via
-     * registerComponent. Different orders can be set for different contexts
-     * (e.g., Transform or Text edit modes). Defaults to Transform mode if no context is provided.
+     * Different orders can be set depending on different contexts. The context
+     * consists of the edit mode (e.g. `Transform` or `Text`) right now. If no
+     * context is given, the default order is set for the `Transform` edit mode.
      *
-     * @category UI Layout
-     * @param canvasMenuOrder - Array of component IDs defining the canvas menu order.
-     * @param orderContext - Optional context specifying when this order applies.
+     * @param canvasMenuOrder - The order of components in the canvas menu
+     * @param orderContext - The context in which the order should be set
      */
     setCanvasMenuOrder(canvasMenuOrder: (CanvasMenuComponentId | OrderComponent<CanvasMenuComponentId>)[], orderContext?: OrderContext): void;
     /**
-     * Gets the current rendering order of canvas menu components.
+     * Returns the current order of components that are rendered in the canvas menu.
+     *
+     * The id in this order refer to registered default components or custom components
+     * registered in `registerComponent`.
      *
-     * Component IDs refer to built-in components or those registered via
-     * registerComponent. Returns the order for the specified context, or
-     * defaults to Transform mode if no context is provided.
+     * Different orders could have been set depending on different contexts.
+     * The context consists of the edit mode (e.g. `Transform` or `Text`) right now.
+     * If no context is given, the default order (with `Transform` edit mode) is
+     * returned.
      *
-     * @category UI Layout
-     * @param orderContext - Optional context specifying which order to retrieve.
-     * @returns Array of component configurations defining the canvas menu order.
+     * @param orderContext - The context for the requested order
+     * @returns The order of components in the canvas menu
      */
     getCanvasMenuOrder(orderContext?: OrderContext): OrderComponent[];
     /**
-     * Sets the rendering order of components in the navigation bar.
+     * Defines the order in which components are rendered in the navigation bar. The
+     * id in this order refer to registered default components or custom components
+     * registered in `registerComponent`.
      *
-     * Component IDs refer to built-in components or those registered via
-     * registerComponent. Different orders can be set for different contexts
-     * (e.g., Transform or Text edit modes). Defaults to Transform mode if no context is provided.
+     * Different orders can be set depending on different contexts. The context
+     * consists of the edit mode (e.g. `Transform` or `Text`) right now. If no
+     * context is given, the default order is set for the `Transform` edit mode.
      *
-     * @category UI Layout
-     * @param navigationBarOrder - Array of component IDs defining the navigation bar order.
-     * @param orderContext - Optional context specifying when this order applies.
+     * @param navigationBarOrder - The order of components in the navigation bar
+     * @param orderContext - The context in which the order should be set
      */
     setNavigationBarOrder(navigationBarOrder: (NavigationBarComponentId | OrderComponent<NavigationBarComponentId>)[], orderContext?: OrderContext): void;
     /**
-     * Gets the current rendering order of navigation bar components.
+     * Returns the current order of components that are rendered in the navigation bar.
+     *
+     * The id in this order refer to registered default components or custom components
+     * registered in `registerComponent`.
      *
-     * Component IDs refer to built-in components or those registered via
-     * registerComponent. Returns the order for the specified context, or
-     * defaults to Transform mode if no context is provided.
+     * Different orders could have been set depending on different contexts.
+     * The context consists of the edit mode (e.g. `Transform` or `Text`) right now.
+     * If no context is given, the default order (with `Transform` edit mode) is
+     * returned.
      *
-     * @category UI Layout
-     * @param orderContext - Optional context specifying which order to retrieve.
-     * @returns Array of component configurations defining the navigation bar order.
+     * @param orderContext - The context for the requested order
+     * @returns The order of components in the navigation bar
      */
     getNavigationBarOrder(orderContext?: OrderContext): OrderComponent[];
     /**
-     * Sets the rendering order of components in the canvas bar.
+     * Defines the order in which components are rendered in the canvas bar. The
+     * id in this order refer to registered default components or custom components
+     * registered in `registerComponent`.
      *
-     * Component IDs refer to built-in components or those registered via
-     * registerComponent. Canvas bars can be positioned at the top or bottom
-     * of the canvas. Different orders can be set for different contexts
-     * (e.g., Transform or Text edit modes). Defaults to Transform mode if no context is provided.
+     * There are two different canvas bar positioned at the top and the bottom
+     * of the canvas. The position can be set with the `position` parameter.
      *
-     * @category UI Layout
-     * @param canvasBarOrder - Array of component IDs defining the canvas bar order.
-     * @param position - The canvas bar position ('top' or 'bottom').
-     * @param orderContext - Optional context specifying when this order applies.
+     * Different orders can be set depending on different contexts. The context
+     * consists of the edit mode (e.g. `Transform` or `Text`) right now. If no
+     * context is given, the default order is set for the `Transform` edit mode.
+     *
+     * @param canvasBarOrder - The order of components in the canvas bar
+     * @param position - The position of the canvas bar (`top` or `bottom`)
+     * @param orderContext - The context in which the order should be set
      */
     setCanvasBarOrder(canvasBarOrder: (CanvasBarComponentId | OrderComponent<CanvasBarComponentId>)[], position: 'top' | 'bottom', orderContext?: OrderContext): void;
     /**
-     * Gets the current rendering order of canvas bar components at the specified position.
+     * Returns the current order of components that are rendered in the canvas bar at
+     * the given position (either `top` or `bottom`).
      *
-     * Component IDs refer to built-in components or those registered via
-     * registerComponent. Returns the order for the specified context, or
-     * defaults to Transform mode if no context is provided.
+     * The id in this order refer to registered default components or custom components
+     * registered in `registerComponent`.
      *
-     * @category UI Layout
-     * @param position - The canvas bar position ('top' or 'bottom').
-     * @param orderContext - Optional context specifying which order to retrieve.
-     * @returns Array of component configurations defining the canvas bar order.
+     * Different orders could have been set depending on different contexts.
+     * The context consists of the edit mode (e.g. `Transform` or `Text`) right now.
+     * If no context is given, the default order (with `Transform` edit mode) is
+     * returned.
+     *
+     * @param position - The position of the canvas bar (`top` or `bottom`)
+     * @param orderContext - The context for the requested order
      */
     getCanvasBarOrder(position: 'top' | 'bottom', orderContext?: OrderContext): OrderComponent[];
     /**
-     * Adds a new asset library entry for display in asset libraries.
-     *
-     * If an entry with the same ID already exists, it will be replaced.
-     * The method validates sorting configurations and warns about duplicates.
+     * Adds a new asset library entry that can be used to be displayed
+     * by an asset library. An existing entry view will be replaced.
      *
-     * @category Asset Library
-     * @param AssetLibraryEntry - The asset library entry configuration to add.
+     * @param AssetLibraryEntry - The asset library entry
      */
     addAssetLibraryEntry(AssetLibraryEntry: AssetLibraryEntry): void;
     /**
-     * Updates an existing asset library entry with new properties.
+     * Updates an asset library entry that can be used to be displayed
+     * by an asset library.
      *
-     * The provided properties will be merged with the existing entry.
-     *
-     * @category Asset Library
-     * @param id - The ID of the asset library entry to update.
-     * @param assetLibraryEntry - Partial entry properties to merge with the existing entry.
+     * @param id - The id of the asset library entry to be updated
+     * @param AssetLibraryEntry - The asset library entry updates
      */
     updateAssetLibraryEntry(id: string, assetLibraryEntry: Partial<Omit<AssetLibraryEntry, 'id'>>): void;
     /**
-     * Removes an asset library entry from the available entries.
+     * Removes an asset library entry that can be used to be displayed
+     * by an asset library.
      *
-     * @category Asset Library
-     * @param id - The ID of the asset library entry to remove.
+     * @param id - The id of the asset library entry to be removed
      */
     removeAssetLibraryEntry(id: string): void;
     /**
-     * Gets a specific asset library entry by its ID.
+     * Returns the current asset library entry that is used to be displayed
+     * by an asset library.
      *
-     * @category Asset Library
-     * @param id - The ID of the asset library entry to retrieve.
-     * @returns The asset library entry configuration, or undefined if not found.
+     * @param id - The id of the asset library entry
+     * @returns The asset library entry
      */
     getAssetLibraryEntry(id: string): AssetLibraryEntry | undefined;
     /**
-     * Gets all currently registered asset library entry IDs.
+     * Returns all currently added asset library entries.
      *
-     * @category Asset Library
-     * @returns Array of asset library entry IDs.
+     * @returns All asset library entries
      */
     findAllAssetLibraryEntries(): string[];
     /**
-     * Sets the asset library entries to use for the background track in video scenes.
+     * Sets the asset library entry ids that should be  used for the background track
      *
-     * This setting only affects video scenes and has no impact on other scene types.
+     * Please note that this has only an effect for video scenes
      *
-     * @category Asset Library
-     * @param backgroundTrackAssetLibraryEntries - Array of asset library entry IDs for the background track.
+     * @param backgroundTrackAssetLibraryEntries - The asset library entry ids that should be used for the background track
      */
     setBackgroundTrackAssetLibraryEntries(backgroundTrackAssetLibraryEntries: string[]): void;
     /**
-     * Gets the asset library entries configured for the background track in video scenes.
+     * Returns the asset library entry ids that should be  used for the background track
      *
-     * This setting only affects video scenes and has no impact on other scene types.
+     * Please note that this has only an effect for video scenes
      *
-     * @category Asset Library
-     * @returns Array of asset library entry IDs configured for the background track.
+     * @returns The asset library entry ids that should be used for the background track
      */
     getBackgroundTrackAssetLibraryEntries(): string[];
     /**
-     * Sets a function that determines which asset library entries to use for replacement operations.
-     *
-     * The function receives context information (like selected blocks or default entry IDs)
-     * and returns the appropriate asset library entry IDs for replacement.
+     * Sets the asset library entry ids that should be  used for replacement. It is a function
+     * that is called with the current context (e.g. selected blocks, or default entry ids).
      *
-     * @category Asset Library
-     * @param replaceAssetLibraryEntries - Function that receives context and returns an array of asset library entry IDs for replacement.
+     * @returns a function that returns an array of asset library entry ids that should be used for replacement
      */
     setReplaceAssetLibraryEntries(replaceAssetLibraryEntries: (context: ReplaceAssetLibraryEntriesContext) => string[]): void;
     /**
-     * Gets the current view style of the editor interface.
+     * Returns the current view of the editor.
      *
-     * @category Experimental Features
-     * @returns The current view style ('default' or 'advanced').
-     * @experimental This API may change or be removed in future versions.
+     * @returns either `default` or `advanced`
      */
     unstable_getView(): ViewStyle;
     /**
-     * Adds a custom icon set to the editor interface.
+     * Adds an icon set to the editor. The icon set is a string containing a SVG
+     * sprite with symbols. The id of each symbol is used to reference the icon
+     * in the editor. These ids need to start with a `@` to be recognized in the
+     * editor.
      *
-     * The icon set should be an SVG sprite containing symbol elements.
-     * Symbol IDs must start with '\@' to be recognized by the editor.
+     * PLEASE NOTE: The SVG sprite will be injected into the (shadow) DOM without
+     * any sanitization. Make sure to only use trusted sources to prevent e.g. XSS
+     * attacks. If you are unsure about the source of the sprite, consider using
+     * libraries like DOMPurify to sanitize the SVG string before adding it.
      *
-     * **Security Warning**: The SVG sprite is injected into the DOM without
-     * sanitization. Only use trusted sources to prevent XSS attacks.
-     * Consider using libraries like DOMPurify for untrusted content.
-     *
-     * @category UI Layout
-     * @param id - The unique identifier for the icon set.
-     * @param svgSprite - The SVG sprite string containing symbol definitions.
+     * @param id - The id of the icon set
+     * @param svgSprite - The SVG sprite containing symbols for icons.
      */
     addIconSet(id: string, svgSprite: string): void;
 }
@@ -2783,8 +2491,6 @@ export { VariableAPI }
 
 export { VerticalBlockAlignment }
 
-export { VideoExportOptions }
-
 export { VideoMimeType }
 
 /** @public */
@@ -2797,6 +2503,4 @@ export { XYWH }
 
 export { ZoomAutoFitAxis }
 
-export { ZoomOptions }
-
 export { }