@cesdk/cesdk-js 1.24.0 → 1.25.0

package/index.d.ts

@@ -2551,12 +2551,14 @@ export declare type BooleanOperation = 'Difference' | 'Intersection' | 'Union' |
  */
 declare interface Builder {
     Button: (id: string, options: ButtonOptions) => void;
+    MediaPreview: (id: string, options: MediaPreviewOptions) => 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;
+    Library: (id: string, options: LibraryOptions) => void;
 }
 
 /**
@@ -3286,6 +3288,18 @@ export declare class EditorAPI {
      * @returns A method to unsubscribe.
      */
     onSettingsChanged: (callback: () => void) => (() => void);
+    /**
+     * Subscribe to changes to the editor role.
+     *
+     * This lets you react to changes in the role of the user and update engine
+     * and editor settings in response.
+     *
+     * @param callback - This function will be called immediately after a role has
+     * been set and the default settings for that role have been applied. This function
+     * will also be called in case the role is set to the same value as before.
+     * @returns A function for unsubscribing
+     */
+    onRoleChanged: (callback: (role: RoleString) => void) => (() => void);
     /**
      * Set a boolean setting.
      * @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`
@@ -3387,7 +3401,7 @@ export declare class EditorAPI {
     getSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`): RGBA;
     /**
      * Set an enum setting.
-     * @param keypath - The settings keypath, e.g. `role`.
+     * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @param value - The enum value as string.
      */
     setSettingEnum<T extends keyof SettingsEnum>(keypath: T, value: SettingsEnum[T]): void;
@@ -3396,7 +3410,7 @@ export declare class EditorAPI {
 
     /**
      * Get an enum setting.
-     * @param keypath - The settings keypath, e.g. `role`.
+     * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @returns The value as string.
      */
     getSettingEnum<T extends keyof SettingsEnum>(keypath: T): SettingsEnum[T];
@@ -3405,12 +3419,20 @@ export declare class EditorAPI {
 
     /**
      * Get the possible enum options for a given enum setting.
-     * @param keypath - The settings keypath, e.g. `role`.
+     * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @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[];
+    /**
+     * Set the role of the user and apply role-dependent defaults for scopes and settings
+     */
+    setRole(role: RoleString): void;
+    /**
+     * Get the current role of the user
+     */
+    getRole(): RoleString;
     /**
      * Returns a list of all the settings available.
      * @returns A list of settings keypaths.
@@ -3418,7 +3440,7 @@ export declare class EditorAPI {
     findAllSettings(): string[];
     /**
      * Returns the type of a setting.
-     * @param keypath - The settings keypath, e.g. `role`.
+     * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @returns The setting type.
      */
     getSettingType(keypath: string): SettingType;
@@ -4166,6 +4188,12 @@ declare type IsEnabledFeatureContext = {
     engine: CreativeEngine;
 };
 
+declare interface LibraryOptions {
+    entries: AssetLibraryEntry[];
+    onSelect?: (asset: CompleteAssetResult) => Promise<void>;
+    searchable?: boolean;
+}
+
 /**
  * e.g. `en`, `de`, etc.
  * @public
@@ -4191,6 +4219,12 @@ export declare const LogLevel: {
     readonly Error: "Error";
 };
 
+declare interface MediaPreviewOptions {
+    size?: 'small' | 'medium';
+    preview?: PreviewType;
+    action?: ButtonOptions;
+}
+
 /** @public */
 declare enum MimeType_2 {
     Png = "image/png",
@@ -4332,6 +4366,18 @@ declare type PluginContext = {
  */
 export declare type PositionMode = 'Absolute' | 'Percent' | 'Auto';
 
+declare type PreviewType = PreviewTypeImage | PreviewTypeColor;
+
+declare type PreviewTypeColor = {
+    type: 'color';
+    color: string;
+};
+
+declare type PreviewTypeImage = {
+    type: 'image';
+    uri: string;
+};
+
 /** @public */
 export declare type PropertyType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum' | 'Struct' | 'Double' | 'SourceSet';
 
@@ -4793,7 +4839,6 @@ export declare type SettingsColorRGBA = SettingsColor;
 
 /** @public */
 export declare type SettingsEnum = {
-    role: RoleString;
     doubleClickSelectionMode: 'Direct' | 'Hierarchical';
     'touch/pinchAction': 'None' | 'Zoom' | 'Scale';
     'touch/rotateAction': 'None' | 'Rotate';