@cesdk/cesdk-js 1.61.0-nightly.20250918 → 1.61.0-nightly.20250921

package/index.d.ts

@@ -579,23 +579,8 @@ export { BlendMode }
 
 export { BlockAPI }
 
-declare type BlockEffectsConfig = {
-    filtersEnabled: boolean;
-    adjustmentsEnabled: boolean;
-    effectsEnabled: boolean;
-    blurEnabled: boolean;
-};
-
 export { BlockEvent }
 
-declare type Blocks = {
-    ['//ly.img.ubq/text']: TextBlockConfig;
-    ['//ly.img.ubq/page']: PageBlockConfig;
-    ['//ly.img.ubq/graphic']: DesignDesignBlockConfig;
-};
-
-declare type BlocksConfig = Omit<Partial<Record<ObjectTypeLonghand, never>>, keyof Blocks> & Blocks;
-
 export { BlockState }
 
 export { BlurType }
@@ -2583,6 +2568,21 @@ declare class CreativeEditorSDK {
      * @category Configuration
      */
     disableNoSceneWarning(): void;
+    /**
+     * Returns the baseURL that was provided in the configuration during editor initialization.
+     *
+     * @returns The original baseURL from the top-level configuration
+     *
+     * @example
+     * ```typescript
+     * const cesdk = await CreativeEditorSDK.create('#editor', {
+     *   baseURL: 'https://my-cdn.example.com/assets/'
+     * });
+     *
+     * console.log(cesdk.getBaseURL()); // 'https://my-cdn.example.com/assets/'
+     * ```
+     */
+    getBaseURL(): string;
     /**
      * Save and return a scene as a base64 encoded string.
      *
@@ -2825,8 +2825,6 @@ export { DesignBlockTypeLonghand }
 
 export { DesignBlockTypeShorthand }
 
-declare type DesignDesignBlockConfig = ImageBlockConfig;
-
 export { DesignUnit }
 
 /**
@@ -3432,10 +3430,6 @@ export { HTMLCreativeEngineCanvasElement }
  */
 declare type I18n = Record<LocaleKey, Partial<Translations>>;
 
-declare type ImageBlockConfig = {
-    cropEnabled: boolean;
-} & BlockEffectsConfig;
-
 export { ImageMimeType }
 
 /**
@@ -3899,13 +3893,6 @@ export declare interface OrderContext {
     editMode: EditMode;
 }
 
-declare type PageBlockConfig = {
-    format: boolean;
-    manage: boolean;
-    maxDuration: number;
-    cropEnabled: boolean;
-} & BlockEffectsConfig;
-
 /**
  * Represents the definition of a page format in the Creative Editor SDK.
  * This interface defines the width, height, unit, and optional fixed orientation for a page format.
@@ -4285,11 +4272,6 @@ export declare interface TextAreaOptions extends InputOptions<string> {
     placeholder?: string;
 }
 
-declare type TextBlockConfig = {
-    advancedEnabled: boolean;
-    colorEnabled: boolean;
-};
-
 export { TextCase }
 
 /**
@@ -4645,17 +4627,36 @@ export declare class UserInterfaceAPI {
      */
     openPanel<T extends PanelId>(panelId: T, options?: PanelOptions<T>): void;
     /**
-     * Closes a panel if it exists and is currently open.
-     *
-     * Otherwise the method does nothing and is a noop.
+     * Closes panels that match the given pattern. Supports wildcard matching.
      *
      * 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
+     * - `//ly.img.panel/inspector` - Inspector panel
+     * - `//ly.img.panel/assetLibrary` - Asset library
+     * - `//ly.img.panel/assetLibrary.replace` - Replacement asset library
      *
      * @category Panel Management
-     * @param panelId - The ID of the panel to close.
+     * @param panelId - The panel ID or pattern to match panels for closing.
+     *
+     * @example
+     * ```javascript
+     * // Close a specific panel by exact ID
+     * cesdk.ui.closePanel('//ly.img.panel/inspector');
+     *
+     * // Close all ly.img panels using wildcard
+     * cesdk.ui.closePanel('//ly.img.*');
+     *
+     * // Close all panels with specific prefix
+     * cesdk.ui.closePanel('//ly.img.panel/*');
+     *
+     * // Close panels matching complex pattern
+     * cesdk.ui.closePanel('//ly.img.panel/' + '*' + '/stroke/' + '*');
+     *
+     * // Close any inspector panels regardless of namespace
+     * cesdk.ui.closePanel('*' + '/inspector');
+     *
+     * // Close all asset library panels
+     * cesdk.ui.closePanel('*assetLibrary*');
+     * ```
      */
     closePanel(panelId: string): void;
     /**
@@ -4897,7 +4898,22 @@ export declare class UserInterfaceAPI {
      */
     removeDockOrderComponent(matcher: OrderComponentMatcher<OrderComponent<DockOrderComponentId>>, orderContext?: OrderContext): {
         removed: number;
-        order: DockOrderComponent[];
+        order: DockOrderComponent[]; /**
+        * Inserts a component into the render order of the dock area.
+        *
+        * This method inserts a new dock order component before, after, or to replace a component matching
+        * the provided matcher. The matcher can be a function or an object describing the component to match.
+        * The location can be 'before', 'after', or 'replace'.
+        *
+        * The insert API can be used in different contexts (such as edit modes).
+        *
+        * @category UI Layout
+        * @param component - The component ID or configuration to insert.
+        * @param matcher - Function or object to match the component to insert relative to.
+        * @param location - Where to insert the new component relative to the matched component ('before' or 'after').
+        * @param orderContext - Optional context specifying which order to update.
+        * @returns The updated dock order array.
+        */
     };
     /**
      * Inserts a component into the render order of the dock area.
@@ -4983,7 +4999,22 @@ export declare class UserInterfaceAPI {
      */
     removeInspectorBarOrderComponent(matcher: OrderComponentMatcher<OrderComponent<InspectorBarComponentId>>, orderContext?: OrderContext): {
         removed: number;
-        order: OrderComponent<InspectorBarComponentId>[];
+        order: OrderComponent<InspectorBarComponentId>[]; /**
+        * Inserts a component into the render order of the dock area.
+        *
+        * This method inserts a new dock order component before, after, or to replace a component matching
+        * the provided matcher. The matcher can be a function or an object describing the component to match.
+        * The location can be 'before', 'after', or 'replace'.
+        *
+        * The insert API can be used in different contexts (such as edit modes).
+        *
+        * @category UI Layout
+        * @param component - The component ID or configuration to insert.
+        * @param matcher - Function or object to match the component to insert relative to.
+        * @param location - Where to insert the new component relative to the matched component ('before' or 'after').
+        * @param orderContext - Optional context specifying which order to update.
+        * @returns The updated dock order array.
+        */
     };
     /**
      * Inserts a component into the render order of the inspector bar.
@@ -5065,7 +5096,22 @@ export declare class UserInterfaceAPI {
      */
     removeCanvasMenuOrderComponent(matcher: OrderComponentMatcher<OrderComponent<CanvasMenuComponentId>>, orderContext?: OrderContext): {
         removed: number;
-        order: OrderComponent<CanvasMenuComponentId>[];
+        order: OrderComponent<CanvasMenuComponentId>[]; /**
+        * Inserts a component into the render order of the dock area.
+        *
+        * This method inserts a new dock order component before, after, or to replace a component matching
+        * the provided matcher. The matcher can be a function or an object describing the component to match.
+        * The location can be 'before', 'after', or 'replace'.
+        *
+        * The insert API can be used in different contexts (such as edit modes).
+        *
+        * @category UI Layout
+        * @param component - The component ID or configuration to insert.
+        * @param matcher - Function or object to match the component to insert relative to.
+        * @param location - Where to insert the new component relative to the matched component ('before' or 'after').
+        * @param orderContext - Optional context specifying which order to update.
+        * @returns The updated dock order array.
+        */
     };
     /**
      * Inserts a component into the render order of the canvas menu.
@@ -5234,7 +5280,22 @@ export declare class UserInterfaceAPI {
      */
     removeCanvasBarOrderComponent(matcher: OrderComponentMatcher<OrderComponent<CanvasBarComponentId>>, position: 'top' | 'bottom', orderContext?: OrderContext): {
         removed: number;
-        order: OrderComponent<CanvasBarComponentId>[];
+        order: OrderComponent<CanvasBarComponentId>[]; /**
+        * Inserts a component into the render order of the dock area.
+        *
+        * This method inserts a new dock order component before, after, or to replace a component matching
+        * the provided matcher. The matcher can be a function or an object describing the component to match.
+        * The location can be 'before', 'after', or 'replace'.
+        *
+        * The insert API can be used in different contexts (such as edit modes).
+        *
+        * @category UI Layout
+        * @param component - The component ID or configuration to insert.
+        * @param matcher - Function or object to match the component to insert relative to.
+        * @param location - Where to insert the new component relative to the matched component ('before' or 'after').
+        * @param orderContext - Optional context specifying which order to update.
+        * @returns The updated dock order array.
+        */
     };
     /**
      * Inserts a component into the render order of the canvas bar.
@@ -5564,6 +5625,7 @@ declare interface UserInterfaceElements_2 {
             floating?: boolean;
         };
     };
+    /** @deprecated Use `cesdk.feature.enable()` instead. */
     blocks?: UserInterfaceInspectorBlocks;
     navigation?: UserInterfaceNavigation;
     inspectorBar?: UserInterfaceElement | boolean;
@@ -5592,6 +5654,7 @@ declare interface UserInterfaceInspector extends UserInterfaceElement {
 /**
  * @public
  * Interface representing a block in the user interface inspector.
+ * @deprecated Use `cesdk.feature.enable()` instead.
  */
 declare interface UserInterfaceInspectorBlock {
 }
@@ -5604,12 +5667,18 @@ declare interface UserInterfaceInspectorBlock {
  * - `adjustments`: Optional element or boolean indicating whether the adjustments section should be shown.
  * - `effects`: Optional element or boolean indicating whether the effects section should be shown.
  * - `blur`: Optional element or boolean indicating whether the blur section should be shown.
+ * @deprecated Use `cesdk.feature.enable()` for graphic-related features instead.
  */
 declare interface UserInterfaceInspectorBlockGraphic extends UserInterfaceInspectorBlock {
+    /** @deprecated Use `cesdk.feature.enable('ly.img.crop')` instead. */
     crop?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.filter')` instead. */
     filters?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.adjustment')` instead. */
     adjustments?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.effect')` instead. */
     effects?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.blur')` instead. */
     blur?: UserInterfaceElement | boolean;
 }
 
@@ -5621,12 +5690,18 @@ declare interface UserInterfaceInspectorBlockGraphic extends UserInterfaceInspec
  * - `adjustments`: Optional element or boolean indicating whether the adjustments section should be shown.
  * - `effects`: Optional element or boolean indicating whether the effects section should be shown.
  * - `blur`: Optional element or boolean indicating whether the blur section should be shown.
+ * @deprecated Use `cesdk.feature.enable()` for image-related features instead.
  */
 declare interface UserInterfaceInspectorBlockImage extends UserInterfaceInspectorBlock {
+    /** @deprecated Use `cesdk.feature.enable('ly.img.crop')` instead. */
     crop?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.filter')` instead. */
     filters?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.adjustment')` instead. */
     adjustments?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.effect')` instead. */
     effects?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.blur')` instead. */
     blur?: UserInterfaceElement | boolean;
 }
 
@@ -5641,18 +5716,27 @@ declare interface UserInterfaceInspectorBlockImage extends UserInterfaceInspecto
  * - `adjustments`: Optional element or boolean indicating whether the adjustments section should be shown.
  * - `effects`: Optional element or boolean indicating whether the effects section should be shown.
  * - `blur`: Optional element or boolean indicating whether the blur section should be shown.
+ * @deprecated Use `cesdk.feature.enable()` for page-related features instead.
  */
 declare interface UserInterfaceInspectorBlockPage extends UserInterfaceInspectorBlock {
+    /** @deprecated Use `cesdk.feature.enable('ly.img.page.resize')` instead. */
     format?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.page.add')`, `cesdk.feature.enable('ly.img.page.move')`, or `cesdk.feature.enable('ly.img.duplicate')` instead. */
     manage?: UserInterfaceElement | boolean;
     /**
+     * @deprecated Use feature API instead.
      * Controls the maximum allowed duration of a page, if in video mode.
      */
     maxDuration?: number;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.crop')` instead. */
     crop?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.filter')` instead. */
     filters?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.adjustment')` instead. */
     adjustments?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.effect')` instead. */
     effects?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.blur')` instead. */
     blur?: UserInterfaceElement | boolean;
 }
 
@@ -5664,12 +5748,18 @@ declare interface UserInterfaceInspectorBlockPage extends UserInterfaceInspector
  * - `adjustments`: Optional element or boolean indicating whether the adjustments section should be shown.
  * - `effects`: Optional element or boolean indicating whether the effects section should be shown.
  * - `blur`: Optional element or boolean indicating whether the blur section should be shown.
+ * @deprecated Use `cesdk.feature.enable()` for shape-related features instead.
  */
 declare interface UserInterfaceInspectorBlockRectShape extends UserInterfaceInspectorBlock {
+    /** @deprecated Use `cesdk.feature.enable('ly.img.crop')` instead. */
     crop?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.filter')` instead. */
     filters?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.adjustment')` instead. */
     adjustments?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.effect')` instead. */
     effects?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.blur')` instead. */
     blur?: UserInterfaceElement | boolean;
 }
 
@@ -5682,13 +5772,20 @@ declare interface UserInterfaceInspectorBlockRectShape extends UserInterfaceInsp
  * - `//ly.img.ubq/text`: Optional text block configuration.
  * - `//ly.img.ubq/page`: Optional page block configuration.
  * - `//ly.img.ubq/graphic`: Optional graphic block configuration.
+ * @deprecated Use `cesdk.feature.enable()` instead.
  */
 declare interface UserInterfaceInspectorBlocks {
+    /** @deprecated Use `cesdk.feature.enable('ly.img.opacity')` instead. */
     opacity?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.transform.position')`, `cesdk.feature.enable('ly.img.transform.size')`, `cesdk.feature.enable('ly.img.transform.rotation')`, or `cesdk.feature.enable('ly.img.transform.flip')` instead. */
     transform?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.trim')` instead. */
     trim?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable()` for text-related features instead. */
     '//ly.img.ubq/text'?: UserInterfaceInspectorBlockText;
+    /** @deprecated Use `cesdk.feature.enable()` for page-related features instead. */
     '//ly.img.ubq/page'?: UserInterfaceInspectorBlockPage;
+    /** @deprecated Use `cesdk.feature.enable()` for graphic-related features instead. */
     '//ly.img.ubq/graphic'?: UserInterfaceInspectorBlockGraphic;
 }
 
@@ -5696,8 +5793,10 @@ declare interface UserInterfaceInspectorBlocks {
  * @public
  * Interface representing a shape block in the user interface inspector.
  * - `crop`: Optional element or boolean indicating whether the crop section should be shown.
+ * @deprecated Use `cesdk.feature.enable()` for shape-related features instead.
  */
 declare interface UserInterfaceInspectorBlockShape extends UserInterfaceInspectorBlock {
+    /** @deprecated Use `cesdk.feature.enable('ly.img.crop')` instead. */
     crop?: UserInterfaceElement | boolean;
 }
 
@@ -5706,9 +5805,12 @@ declare interface UserInterfaceInspectorBlockShape extends UserInterfaceInspecto
  * Interface representing a text block in the user interface inspector.
  * - `advanced`: Optional element or boolean indicating whether the advanced section should be shown.
  * - `color`: Optional element or boolean indicating whether the color section should be shown.
+ * @deprecated Use `cesdk.feature.enable()` for text-related features instead.
  */
 declare interface UserInterfaceInspectorBlockText extends UserInterfaceInspectorBlock {
+    /** @deprecated Use `cesdk.feature.enable('ly.img.text.advanced')` instead. */
     advanced?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.fill')` instead. */
     color?: UserInterfaceElement | boolean;
 }
 
@@ -5720,12 +5822,18 @@ declare interface UserInterfaceInspectorBlockText extends UserInterfaceInspector
  * - `adjustments`: Optional element or boolean indicating whether the adjustments section should be shown.
  * - `effects`: Optional element or boolean indicating whether the effects section should be shown.
  * - `blur`: Optional element or boolean indicating whether the blur section should be shown.
+ * @deprecated Use `cesdk.feature.enable()` for video-related features instead.
  */
 declare interface UserInterfaceInspectorBlockVideoFill extends UserInterfaceInspectorBlock {
+    /** @deprecated Use `cesdk.feature.enable('ly.img.crop')` instead. */
     crop?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.filter')` instead. */
     filters?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.adjustment')` instead. */
     adjustments?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.effect')` instead. */
     effects?: UserInterfaceElement | boolean;
+    /** @deprecated Use `cesdk.feature.enable('ly.img.blur')` instead. */
     blur?: UserInterfaceElement | boolean;
 }