@cesdk/cesdk-js 1.23.0 → 1.24.0

package/index.d.ts

@@ -2553,6 +2553,10 @@ declare interface Builder {
     Button: (id: string, options: ButtonOptions) => void;
     Section: (id: string, options: SectionOptions) => void;
     Separator: (id: string) => void;
+    TextArea: (id: string, options: TextAreaOptions) => void;
+    TextInput: (id: string, options: TextInputOptions) => void;
+    NumberInput: (id: string, options: NumberInputOptions) => void;
+    Slider: (id: string, options: SliderOptions) => void;
 }
 
 /**
@@ -2753,11 +2757,11 @@ declare class CreativeEditorSDK {
      * - `'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
-     * `base_url` defaults to 'https://cdn.img.ly/assets/v2'.
+     * `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.
      *
-     * @param baseURL - The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/v2'`.
+     * @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 }?: {
@@ -3054,12 +3058,12 @@ export declare class CreativeEngine {
      * - `'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
-     * `base_url` defaults to 'https://cdn.img.ly/assets/v2'.
+     * `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.
      */
     addDefaultAssetSources({ baseURL, excludeAssetSourceIds }?: {
-        /** The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/v2'`. */
+        /** The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/v3'`. */
         baseURL?: string;
         /** A list of IDs, that will be ignored during load. */
         excludeAssetSourceIds?: DefaultAssetSourceId[];
@@ -3461,6 +3465,11 @@ export declare class EditorAPI {
      * @returns The resolved absolute uri or an error if an invalid path was given.
      */
     getAbsoluteURI(relativePath: string): string;
+    /**
+     * Get all available global scopes that can be set.
+     * @returns The names of all available global scopes.
+     */
+    findAllScopes(): string[];
     /**
      * Set a scope to be globally allowed, denied, or deferred to the block-level.
      * @param key - The scope to set.
@@ -4146,6 +4155,13 @@ export declare interface HTMLCreativeEngineCanvasElement extends HTMLElement {
  */
 declare type I18n = Record<string, Translations>;
 
+declare interface InputOptions<T> {
+    label?: string;
+    value: T;
+    setValue: (value: T) => void;
+    isDisabled?: boolean;
+}
+
 declare type IsEnabledFeatureContext = {
     engine: CreativeEngine;
 };
@@ -4212,6 +4228,9 @@ declare type NotificationDuration = number | 'infinite' | 'short' | 'medium' | '
 
 declare type NotificationType = 'success' | 'error' | 'info' | 'warning' | 'loading';
 
+declare interface NumberInputOptions extends InputOptions<number> {
+}
+
 /**
  * The block type IDs for all blocks types in the Creative Engine. Those are the types that can be
  * passed to `cesdk.engine.block.findByType(type)` for example.
@@ -4820,6 +4839,13 @@ export declare type ShapeTypeShorthand = 'rect' | 'line' | 'ellipse' | 'polygon'
  */
 export declare type SizeMode = 'Absolute' | 'Percent' | 'Auto';
 
+declare interface SliderOptions extends InputOptions<number> {
+    min: number;
+    max: number;
+    step?: number;
+    centered?: boolean;
+}
+
 /**
  * A single source width an intrinsic width & height.
  * @public
@@ -4887,11 +4913,17 @@ export declare function supportsVideoExport(): Promise<boolean>;
  */
 export declare function supportsWasm(): boolean;
 
+declare interface TextAreaOptions extends InputOptions<string> {
+}
+
 /**
  * @public
  */
 export declare type TextCase = 'Normal' | 'Uppercase' | 'Lowercase' | 'Titlecase';
 
+declare interface TextInputOptions extends InputOptions<string> {
+}
+
 /** @public */
 declare type Theme = 'light' | 'dark';