@cesdk/node 1.19.0-rc.0 → 1.19.0

package/README.md

@@ -12,7 +12,7 @@ Visit our [documentation](https://img.ly/docs/cesdk) for more tutorials on how t
 customize the engine for your specific use case.
 
 ## License
-The CreativeEditor SDK is a commercial product. To use it as such and get access to its white-label version - without the watermark in the export - you need to unlock the SDK with a license file. You can purchase a license at https://img.ly/pricing.
+The CreativeEditor SDK is a commercial product. To use it and get access you need to unlock the SDK with a license file. You can purchase a license at https://img.ly/pricing.
 
 ## Usage 
 
@@ -50,8 +50,7 @@ and description of all API methods.
 
 ## License
 
-The CreativeEditor SDK is a commercial product. To use it as such and get
-access to its white label version - without the watermark in the export - you
+The CreativeEditor SDK is a commercial product. To use it you
 need to unlock the SDK with a license file. You can purchase a license at
 https://img.ly/pricing.       
  

package/index.d.ts

@@ -2879,6 +2879,8 @@ export declare class EditorAPI {
      * @throws An error, if the keypath is invalid.
      */
     setSettingBool(keypath: SettingsBool, value: boolean): void;
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    setSettingBool(keypath: `ubq://${SettingsBool}`, value: boolean): void;
 
     /**
      * Get a boolean setting.
@@ -2886,6 +2888,8 @@ export declare class EditorAPI {
      * @throws An error, if the keypath is invalid.
      */
     getSettingBool(keypath: SettingsBool): boolean;
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    getSettingBool(keypath: `ubq://${SettingsBool}`): boolean;
 
     /**
      * Set an integer setting.
@@ -2907,12 +2911,16 @@ export declare class EditorAPI {
      * @throws An error, if the keypath is invalid.
      */
     setSettingFloat(keypath: SettingsFloat, value: number): void;
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    setSettingFloat(keypath: `ubq://${SettingsFloat}`, value: number): void;
     /**
      * Get a float setting.
      * @param keypath - The settings keypath, e.g. `positionSnappingThreshold`
      * @throws An error, if the keypath is invalid.
      */
     getSettingFloat(keypath: SettingsFloat): number;
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    getSettingFloat(keypath: `ubq://${SettingsFloat}`): number;
     /**
      * Set a string setting.
      * @param keypath - The settings keypath, e.g. `license`
@@ -2920,24 +2928,32 @@ export declare class EditorAPI {
      * @throws An error, if the keypath is invalid.
      */
     setSettingString(keypath: SettingsString, value: string): void;
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    setSettingString(keypath: `ubq://${SettingsString}`, value: string): void;
     /**
      * Get a string setting.
      * @param keypath - The settings keypath, e.g. `license`
      * @throws An error, if the keypath is invalid.
      */
     getSettingString(keypath: SettingsString): string;
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    getSettingString(keypath: `ubq://${SettingsString}`): string;
     /**
      * Set a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @param value - The The value to set.
      */
     setSettingColor(keypath: SettingsColor, value: Color): void;
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    setSettingColor(keypath: `ubq://${SettingsColor}`, value: Color): void;
     /**
      * Get a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @throws An error, if the keypath is invalid.
      */
     getSettingColor(keypath: SettingsColor): Color;
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    getSettingColor(keypath: `ubq://${SettingsColor}`): Color;
     /**
      * Set a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
@@ -2947,32 +2963,38 @@ export declare class EditorAPI {
      * @param a - The alpha color component in the range of 0 to 1.
      * @deprecated Use setSettingColor() instead.
      */
-    setSettingColorRGBA(keypath: SettingsColorRGBA, r: number, g: number, b: number, a?: number): void;
+    setSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`, r: number, g: number, b: number, a?: number): void;
     /**
      * Get a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
      * @deprecated Use getSettingColor() instead.
      */
-    getSettingColorRGBA(keypath: SettingsColorRGBA): RGBA;
+    getSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`): RGBA;
     /**
      * Set an enum setting.
      * @param keypath - The settings keypath, e.g. `role`.
      * @param value - The enum value as string.
      */
     setSettingEnum<T extends keyof SettingsEnum>(keypath: T, value: SettingsEnum[T]): void;
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    setSettingEnum<T extends keyof SettingsEnum>(keypath: `ubq://${T}`, value: SettingsEnum[T]): void;
     /**
      * Get an enum setting.
      * @param keypath - The settings keypath, e.g. `role`.
      * @returns The value as string.
      */
     getSettingEnum<T extends keyof SettingsEnum>(keypath: T): SettingsEnum[T];
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    getSettingEnum<T extends keyof SettingsEnum>(keypath: `ubq://${T}`): SettingsEnum[T];
     /**
      * Get the possible enum options for a given enum setting.
      * @param keypath - The settings keypath, e.g. `role`.
      * @returns The possible enum options as strings.
      */
     getSettingEnumOptions<T extends keyof SettingsEnum>(keypath: T): string[];
+    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
+    getSettingEnumOptions<T extends keyof SettingsEnum>(keypath: `ubq://${T}`): string[];
     /**
      * Returns a list of all the settings available.
      * @returns A list of settings keypaths.
@@ -3698,7 +3720,7 @@ export declare type SceneLayout = 'Free' | 'VerticalStack' | 'HorizontalStack' |
 export declare type SceneMode = 'Design' | 'Video';
 
 /** @public */
-export declare type SettingsBool = 'doubleClickToCropEnabled' | 'features/effectsEnabled' | 'features/hspSelectiveAdjustmentsEnabled' | 'features/layerListEnabled' | 'features/singlePageModeEnabled' | 'features/templatingEnabled' | 'mouse/enableZoom' | 'mouse/enableScroll' | 'page/dimOutOfPageAreas' | 'page/title/show' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
+export declare type SettingsBool = 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'mouse/enableZoom' | 'mouse/enableScroll' | 'page/dimOutOfPageAreas' | 'page/title/show' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
 
 /** @public
  */