@cesdk/cesdk-js 1.63.0-nightly.20251017 → 1.63.0-nightly.20251018

package/index.d.ts

@@ -2656,7 +2656,7 @@ declare class CreativeEditorSDK {
      * cesdk.resetEditor();
      *
      * // Reconfigure as needed
-     * cesdk.feature.enable('ly.img.navigationBar', true);
+     * cesdk.feature.enable('ly.img.navigation.bar');
      * cesdk.addDefaultAssetSources();
      * ```
      *
@@ -3377,42 +3377,238 @@ export declare class FeatureAPI {
     #private;
 
     /**
-     * Enables one or more features based on the provided predicate.
+     * Enables one or more features using their default predicates.
      *
-     * 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.
+     * This is the recommended way to enable features. Each feature has a sensible
+     * default predicate that determines when it should be available in the UI.
+     * To customize the behavior, use the `set()` method instead.
      *
-     * To use our defaults you can simply omit passing a predicate when enabling a feature.
-     * ```javascript
+     * Supports glob patterns (e.g., 'ly.img.video.*') to enable multiple features at once.
+     * Use `*` as a wildcard to match any sequence of characters.
+     *
+     * @example
+     * Enable single feature with its default predicate:
+     * ```typescript
      * cesdk.feature.enable('ly.img.delete');
-     * cesdk.feature.enable('ly.img.duplicate');
      * ```
      *
-     * You can also extend the default predicate provided for built-in features.
+     * @example
+     * Enable multiple features at once:
+     * ```typescript
+     * cesdk.feature.enable(['ly.img.delete', 'ly.img.duplicate']);
+     * ```
      *
-     * ```javascript
-     * cesdk.feature.enable('ly.img.delete', ({ defaultPredicate }) =>
-     *   return defaultPredicate() && (new Date().getHours() >= 22);
-     * );
+     * @example
+     * Enable all video features using a glob pattern:
+     * ```typescript
+     * cesdk.feature.enable('ly.img.video.*');
+     * ```
+     *
+     * @example
+     * Enable all navigation features:
+     * ```typescript
+     * cesdk.feature.enable('ly.img.navigation.*');
      * ```
      *
      * @category Feature Control
+     * @param featureId - The feature ID, glob pattern, or array of feature IDs to enable.
+     */
+    enable(featureId: FeatureId | FeatureId[]): void;
+    /**
+     * @deprecated Use `cesdk.feature.set(featureId, predicate)` instead.
+     * This overload will be removed in a future version.
+     *
+     * Enables one or more features based on the provided predicate.
+     *
+     * @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.
      */
-    enable(featureId: FeatureId | FeatureId[], predicate?: FeaturePredicate): void;
+    enable(featureId: FeatureId | FeatureId[], predicate: FeaturePredicate): void;
     /**
-     * Checks if a specific feature is currently enabled.
+     * Disables one or more features.
+     *
+     * This is a convenience method that adds a `false` predicate to the feature's
+     * predicate chain, effectively disabling the feature. Disabled features will
+     * not be shown in the UI.
+     *
+     * Supports glob patterns (e.g., 'ly.img.video.*') to disable multiple features at once.
+     * Use `*` as a wildcard to match any sequence of characters.
+     *
+     * @example
+     * Disable a single feature:
+     * ```typescript
+     * cesdk.feature.disable('ly.img.delete');
+     * ```
+     *
+     * @example
+     * Disable multiple features at once:
+     * ```typescript
+     * cesdk.feature.disable([
+     *   'ly.img.delete',
+     *   'ly.img.duplicate',
+     *   'ly.img.group'
+     * ]);
+     * ```
+     *
+     * @example
+     * Disable all video features using a glob pattern:
+     * ```typescript
+     * cesdk.feature.disable('ly.img.video.*');
+     * ```
+     *
+     * @example
+     * Disable all crop features:
+     * ```typescript
+     * cesdk.feature.disable('ly.img.crop.*');
+     * ```
      *
      * @category Feature Control
-     * @param featureId - The feature ID to check.
+     * @param featureId - The feature ID, glob pattern, or array of feature IDs to disable.
+     */
+    disable(featureId: FeatureId | FeatureId[]): void;
+    /**
+     * Sets a feature's enabled state, replacing any existing predicates.
+     *
+     * This method provides a unified way to enable or disable features. When setting
+     * to `true`, the feature's default predicate is used. When setting to `false`,
+     * the feature is explicitly disabled. You can also provide a custom predicate
+     * function for advanced control.
+     *
+     * Supports glob patterns (e.g., 'ly.img.video.*') to set multiple features at once.
+     * Use `*` as a wildcard to match any sequence of characters.
+     *
+     * @example
+     * Enable a feature using its default predicate:
+     * ```typescript
+     * cesdk.feature.set('ly.img.delete', true);
+     * ```
+     *
+     * @example
+     * Disable a feature:
+     * ```typescript
+     * cesdk.feature.set('ly.img.delete', false);
+     * ```
+     *
+     * @example
+     * Set a feature with a custom predicate:
+     * ```typescript
+     * cesdk.feature.set('ly.img.delete', ({ engine }) => {
+     *   return engine.block.findAllSelected().length > 0;
+     * });
+     * ```
+     *
+     * @example
+     * Disable all video features using a glob pattern:
+     * ```typescript
+     * cesdk.feature.set('ly.img.video.*', false);
+     * ```
+     *
+     * @example
+     * Enable all filter features with a custom predicate:
+     * ```typescript
+     * cesdk.feature.set('ly.img.filter.*', ({ engine }) => {
+     *   // Only enable filters for images
+     *   const selected = engine.block.findAllSelected();
+     *   return selected.some(id => engine.block.getType(id) === '//ly.img.ubq/graphic');
+     * });
+     * ```
+     *
+     * @category Feature Control
+     * @param featureId - The feature ID or glob pattern to set.
+     * @param enabled - Boolean to enable/disable, or a predicate function for custom logic.
+     */
+    set(featureId: FeatureId, enabled: boolean | FeaturePredicate): void;
+    /**
+     * Lists all registered feature IDs, optionally filtered by a pattern.
+     *
+     * This method is useful for debugging and discovering which features are currently
+     * registered in the editor. You can provide a glob-style pattern to filter the results.
+     *
+     * @example
+     * List all registered features:
+     * ```typescript
+     * const allFeatures = cesdk.feature.list();
+     * console.log(allFeatures); // ['ly.img.delete', 'ly.img.duplicate', ...]
+     * ```
+     *
+     * @example
+     * List features matching a pattern:
+     * ```typescript
+     * const videoFeatures = cesdk.feature.list({ matcher: 'ly.img.video.*' });
+     * console.log(videoFeatures); // ['ly.img.video.timeline', 'ly.img.video.clips', ...]
+     * ```
+     *
+     * @example
+     * List navigation features:
+     * ```typescript
+     * const navFeatures = cesdk.feature.list({ matcher: 'ly.img.navigation.*' });
+     * ```
+     *
+     * @category Feature Control
+     * @param options - Optional configuration object with a `matcher` property for glob-style pattern filtering (e.g., 'ly.img.video.*').
+     * @returns An array of feature IDs sorted alphabetically.
+     */
+    list(options?: {
+        matcher?: string;
+    }): FeatureId[];
+    /**
+     * Gets the predicate chain for a specific feature.
+     *
+     * This method returns the array of predicates currently registered for a feature,
+     * allowing you to inspect the feature's configuration. Returns `undefined` if the
+     * feature is not registered.
+     *
+     * @example
+     * Get predicates for a feature:
+     * ```typescript
+     * const predicates = cesdk.feature.get('ly.img.delete');
+     * if (predicates) {
+     *   console.log(`Feature has ${predicates.length} predicates`);
+     * }
+     * ```
+     *
+     * @example
+     * Check if a feature is registered:
+     * ```typescript
+     * const isRegistered = cesdk.feature.get('ly.img.delete') !== undefined;
+     * ```
+     *
+     * @category Feature Control
+     * @param featureId - The feature ID to query.
+     * @returns The array of predicates for the feature, or undefined if not registered.
+     */
+    get(featureId: FeatureId): FeaturePredicate[] | undefined;
+    /**
+     * Checks if one or more features are currently enabled.
+     *
+     * Supports glob patterns (e.g., 'ly.img.video.*') to check multiple features at once.
+     * When a glob pattern is used, returns `true` only if **all** matching features are enabled.
+     *
+     * @example
+     * Check if a single feature is enabled:
+     * ```typescript
+     * const isDeleteEnabled = cesdk.feature.isEnabled('ly.img.delete');
+     * ```
+     *
+     * @example
+     * Check if all video features are enabled:
+     * ```typescript
+     * const allVideoFeaturesEnabled = cesdk.feature.isEnabled('ly.img.video.*');
+     * ```
+     *
+     * @example
+     * Check with custom context (useful in predicates):
+     * ```typescript
+     * cesdk.feature.set('ly.img.delete', ({ engine }) => {
+     *   return cesdk.feature.isEnabled('ly.img.duplicate', { engine });
+     * });
+     * ```
+     *
+     * @category Feature Control
+     * @param featureId - The feature ID or glob pattern to check.
      * @param context - The context object containing a reference to the underlying engine.
-     * @returns True if the feature is enabled, false otherwise.
+     * @returns True if the feature (or all matching features for glob patterns) is enabled, false otherwise.
      */
     isEnabled(featureId: FeatureId, context?: IsEnabledFeatureContext): boolean;
 }
@@ -3422,7 +3618,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' | 'ly.img.settings' | 'ly.img.assetLibrary' | (string & {});
+export declare type FeatureId = 'ly.img.navigation.bar' | 'ly.img.navigation.back' | 'ly.img.navigation.close' | 'ly.img.navigation.undoRedo' | 'ly.img.navigation.zoom' | 'ly.img.navigation.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.filter.lut' | 'ly.img.filter.duotone' | '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.crop.size' | 'ly.img.crop.rotation' | 'ly.img.crop.flip' | 'ly.img.crop.fillMode' | 'ly.img.crop.scale' | 'ly.img.crop.position' | 'ly.img.volume' | 'ly.img.stroke' | 'ly.img.position' | 'ly.img.animations' | 'ly.img.opacity' | 'ly.img.blendMode' | 'ly.img.video.timeline' | 'ly.img.video.clips' | 'ly.img.video.overlays' | 'ly.img.video.audio' | 'ly.img.video.addClip' | 'ly.img.video.controls' | 'ly.img.video.controls.toggle' | 'ly.img.video.controls.background' | 'ly.img.video.controls.playback' | 'ly.img.video.controls.loop' | 'ly.img.video.controls.split' | 'ly.img.video.controls.timelineZoom' | 'ly.img.video.caption' | 'ly.img.transform.position' | 'ly.img.transform.size' | 'ly.img.transform.rotation' | 'ly.img.transform.flip' | 'ly.img.inspector.bar' | 'ly.img.inspector.toggle' | 'ly.img.page.resize' | 'ly.img.dock' | 'ly.img.canvas.bar' | 'ly.img.canvas.menu' | 'ly.img.inspector' | 'ly.img.settings' | 'ly.img.library.panel' | (string & {});
 
 /**
  * The feature predicate is used to enable or disable a feature
@@ -3722,6 +3918,8 @@ export declare type LocaleKey = 'en' | 'de' | string;
 
 export { Logger }
 
+declare type Logger_2 = (message: string, level: 'Warning' | 'Error') => void;
+
 export { LogLevel }
 
 /**
@@ -4564,7 +4762,7 @@ export declare interface UserInterface {
      *
      * // Update the asset library entry to use your custom source
      * cesdk.ui.updateAssetLibraryEntry('ly.img.colors', {
-     *   sourceIds: ['ly.img.colors.documentColors', 'my.custom.colors']
+     *   sourceIds: ['ly.img.scene.colors', 'my.custom.colors']
      * });
      * ```
      */
@@ -5823,7 +6021,7 @@ declare interface UserInterfaceElements_2 {
         inspector?: UserInterfaceInspector | boolean;
         /** @deprecated Please use `cesdk.feature.enable('ly.img.settings')`, `cesdk.ui.setPanelPosition('//ly.img.panel/settings')` and `cesdk.ui.setPanelFloating('//ly.img.panel/settings')` instead. */
         settings?: UserInterfaceSettings | boolean;
-        /** @deprecated Please use `cesdk.feature.enable('ly.img.assetLibrary')`, `cesdk.ui.setPanelPosition('//ly.img.panel/assetLibrary')` and `cesdk.ui.setPanelFloating('//ly.img.panel/assetLibrary')` instead. */
+        /** @deprecated Please use `cesdk.feature.enable('ly.img.library.panel')`, `cesdk.ui.setPanelPosition('//ly.img.panel/assetLibrary')` and `cesdk.ui.setPanelFloating('//ly.img.panel/assetLibrary')` instead. */
         assetLibrary?: UserInterfaceAssetLibrary | boolean;
     };
     dock?: {