@cesdk/cesdk-js 1.44.0 → 1.45.0

package/index.d.ts

@@ -155,7 +155,10 @@ export { AssetEnumProperty }
 
 export { AssetGroups }
 
-declare type AssetLibraryDockComponent = {
+/**
+ * @public
+ */
+export declare type AssetLibraryDockComponent = {
     id: 'ly.img.assetLibrary.dock';
     key?: string;
     label?: string;
@@ -173,7 +176,7 @@ declare type AssetLibraryEntries = AssetLibraryEntry[] | ((currentAssetLibraryEn
 }) => AssetLibraryEntry[]);
 
 /** @public */
-declare interface AssetLibraryEntry extends AssetLibraryEntryData, AssetLibraryEntryView {
+export declare interface AssetLibraryEntry extends AssetLibraryEntryData, AssetLibraryEntryView {
 }
 
 /** @public */
@@ -325,7 +328,10 @@ declare interface AssetLibraryEntryView {
     }[];
 }
 
-declare type AssetLibraryPanelPayload = {
+/**
+ * @public
+ */
+export declare type AssetLibraryPanelPayload = {
     title?: string | string[];
     entries?: string[];
 };
@@ -392,8 +398,9 @@ export { Buffer }
  * Interface for all available builder. Depending on the context different
  * implementation might be used. A "Button" in the canvas menu might render
  * different component than a button in the topbar or a panel.
+ * @public
  */
-declare interface Builder {
+export declare interface Builder {
     Button: (id: string, options: ButtonOptions) => void;
     ButtonGroup: (id: string, options: ButtonGroupOptions) => void;
     Checkbox: (id: string, options: CheckboxOptions) => void;
@@ -414,10 +421,15 @@ declare interface Builder {
 
 /**
  * Function that defines a component with the help of the passed builder object.
+ *
+ * @public
  */
-declare type BuilderRenderFunction<P = {}> = (context: BuilderRenderFunctionContext<P>) => void;
+export declare type BuilderRenderFunction<P = {}> = (context: BuilderRenderFunctionContext<P>) => void;
 
-declare interface BuilderRenderFunctionContext<P> {
+/**
+ * @public
+ */
+export declare interface BuilderRenderFunctionContext<P> {
     builder: Builder;
     engine: CreativeEngine_2;
     /**
@@ -487,14 +499,20 @@ declare interface BuilderRenderFunctionContext<P> {
     renderOptimizedSmallViewport: boolean;
 }
 
-declare interface ButtonGroupOptions {
+/**
+ * @public
+ */
+export declare interface ButtonGroupOptions {
     inputLabel?: string | string[];
     inputLabelPosition?: 'top' | 'left';
     children?: () => void;
     suffix?: Suffix;
 }
 
-declare interface ButtonOptions {
+/**
+ * @public
+ */
+export declare interface ButtonOptions {
     inputLabel?: string | string[];
     inputLabelPosition?: 'top' | 'left';
     label?: string | string[];
@@ -505,6 +523,7 @@ declare interface ButtonOptions {
     color?: 'accent' | 'danger';
     size?: 'normal' | 'large';
     icon?: CustomIcon;
+    trailingIcon?: CustomIcon;
     isActive?: boolean;
     isSelected?: boolean;
     isDisabled?: boolean;
@@ -537,9 +556,15 @@ declare const CANVAS_MENU_TEXT_ORDER_DEFAULT: readonly ["ly.img.text.color.canva
 
 declare const CANVAS_MENU_TRANSFORM_ORDER_DEFAULT: readonly ["ly.img.group.enter.canvasMenu", "ly.img.group.select.canvasMenu", "ly.img.page.moveUp.canvasMenu", "ly.img.page.moveDown.canvasMenu", "ly.img.separator", "ly.img.text.edit.canvasMenu", "ly.img.replace.canvasMenu", "ly.img.separator", "ly.img.placeholder.canvasMenu", "ly.img.separator", "ly.img.duplicate.canvasMenu", "ly.img.delete.canvasMenu"];
 
-declare type CanvasBarComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof CANVAS_BAR_ORDER_DEFAULT)[number] | (string & {});
+/**
+ * @public
+ */
+export declare type CanvasBarComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof CANVAS_BAR_ORDER_DEFAULT)[number] | (string & {});
 
-declare type CanvasMenuComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof CANVAS_MENU_TRANSFORM_ORDER_DEFAULT)[number] | (typeof CANVAS_MENU_TEXT_ORDER_DEFAULT)[number] | (string & {});
+/**
+ * @public
+ */
+export declare type CanvasMenuComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof CANVAS_MENU_TRANSFORM_ORDER_DEFAULT)[number] | (typeof CANVAS_MENU_TEXT_ORDER_DEFAULT)[number] | (string & {});
 
 /** @public */
 declare type CardBackground = {
@@ -579,7 +604,10 @@ export declare namespace CESDKConfiguration {
     };
 }
 
-declare interface CheckboxOptions extends InputOptions<boolean, 'left' | 'right'> {
+/**
+ * @public
+ */
+export declare interface CheckboxOptions extends InputOptions<boolean, 'left' | 'right'> {
     icon?: CustomIcon;
 }
 
@@ -587,7 +615,10 @@ export { CMYK }
 
 export { CMYKColor }
 
-declare interface ColorInputOptions extends InputOptions<Color> {
+/**
+ * @public
+ */
+export declare interface ColorInputOptions extends InputOptions<Color> {
     label?: string | string[];
 }
 
@@ -598,9 +629,15 @@ declare type CombinedConfiguration = CESDKConfiguration & Omit<_EngineConfigurat
 
 export { CompleteAssetResult }
 
-declare type ComponentId = DockOrderComponentId | CanvasMenuComponentId | NavigationBarComponentId | CanvasBarComponentId | InspectorBarComponentId;
+/**
+ * @public
+ */
+export declare type ComponentId = DockOrderComponentId | CanvasMenuComponentId | NavigationBarComponentId | CanvasBarComponentId | InspectorBarComponentId;
 
-declare interface ComponentPayload {
+/**
+ * @public
+ */
+export declare interface ComponentPayload {
     [key: string]: unknown;
 }
 
@@ -859,7 +896,10 @@ declare type CustomCardSvgVectorPathBackground = {
     clipRule?: 'nonzero' | 'evenodd';
 };
 
-declare interface CustomDockComponent extends ComponentPayload {
+/**
+ * @public
+ */
+export declare interface CustomDockComponent extends ComponentPayload {
     id: ComponentId;
 }
 
@@ -869,7 +909,10 @@ declare type CustomIcon = string | (({ theme, iconSize }: {
     iconSize: 'normal' | 'large';
 }) => string);
 
-declare type CustomPanelMountFunction = (domElement: HTMLDivElement) => PanelDisposer;
+/**
+ * @public
+ */
+export declare type CustomPanelMountFunction = (domElement: HTMLDivElement) => PanelDisposer;
 
 export { CutoutOperation }
 
@@ -889,7 +932,10 @@ export { DesignBlockTypeShorthand }
 
 export { DesignUnit }
 
-declare interface Dialog {
+/**
+ * @public
+ */
+export declare interface Dialog {
     type?: DialogType;
     size?: DialogSize;
     content: DialogContent;
@@ -900,7 +946,10 @@ declare interface Dialog {
     clickOutsideToClose?: boolean;
 }
 
-declare type DialogAction = {
+/**
+ * @public
+ */
+export declare type DialogAction = {
     variant?: 'regular' | 'plain';
     color?: 'accent' | 'danger';
     label: string;
@@ -909,19 +958,31 @@ declare type DialogAction = {
     }) => void;
 };
 
-declare type DialogContent = string | {
+/**
+ * @public
+ */
+export declare type DialogContent = string | {
     title?: string;
     message: string | string[];
 };
 
-declare type DialogProgress = number | 'indeterminate' | {
+/**
+ * @public
+ */
+export declare type DialogProgress = number | 'indeterminate' | {
     value: number;
     max: number;
 };
 
-declare type DialogSize = 'regular' | 'large';
+/**
+ * @public
+ */
+export declare type DialogSize = 'regular' | 'large';
 
-declare type DialogType = 'regular' | 'success' | 'error' | 'info' | 'warning' | 'loading';
+/**
+ * @public
+ */
+export declare type DialogType = 'regular' | 'success' | 'error' | 'info' | 'warning' | 'loading';
 
 /**
  * @public
@@ -933,15 +994,27 @@ declare interface DockGroup {
     entryIds?: string[];
 }
 
-declare type DockOrderComponent = CustomDockComponent | AssetLibraryDockComponent;
+/**
+ * @public
+ */
+export declare type DockOrderComponent = CustomDockComponent | AssetLibraryDockComponent;
 
-declare type DockOrderComponentId = 'ly.img.separator' | 'ly.img.spacer' | (string & {});
+/**
+ * @public
+ */
+export declare type DockOrderComponentId = 'ly.img.separator' | 'ly.img.spacer' | (string & {});
 
-declare interface DropdownChildrenContext {
+/**
+ * @public
+ */
+export declare interface DropdownChildrenContext {
     close: () => void;
 }
 
-declare interface DropdownOptions {
+/**
+ * @public
+ */
+export declare interface DropdownOptions {
     inputLabel?: string | string[];
     inputLabelPosition?: 'top' | 'left';
     label?: string | string[];
@@ -1067,7 +1140,10 @@ export { GradientColorStop }
 
 export { GradientstopRGBA }
 
-declare interface HeadingOptions {
+/**
+ * @public
+ */
+export declare interface HeadingOptions {
     content: string;
 }
 
@@ -1086,7 +1162,10 @@ export { HTMLCreativeEngineCanvasElement }
  */
 declare type I18n = Record<string, Translations>;
 
-declare interface InputOptions<T, P = 'top' | 'left'> {
+/**
+ * @public
+ */
+export declare interface InputOptions<T, P = 'top' | 'left'> {
     inputLabel?: string | string[];
     inputLabelPosition?: P;
     value: T;
@@ -1101,7 +1180,10 @@ declare const INSPECTOR_BAR_TRANSFORM_ORDER_DEFAULT: readonly ["ly.img.text.type
 
 declare const INSPECTOR_BAR_TRIM_ORDER_DEFAULT: readonly ["ly.img.trimControls.inspectorBar"];
 
-declare type InspectorBarComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof INSPECTOR_BAR_TRANSFORM_ORDER_DEFAULT)[number] | (typeof INSPECTOR_BAR_TRIM_ORDER_DEFAULT)[number] | (typeof INSPECTOR_BAR_CROP_ORDER_DEFAULT)[number] | (string & {});
+/**
+ * @public
+ */
+export declare type InspectorBarComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof INSPECTOR_BAR_TRANSFORM_ORDER_DEFAULT)[number] | (typeof INSPECTOR_BAR_TRIM_ORDER_DEFAULT)[number] | (typeof INSPECTOR_BAR_CROP_ORDER_DEFAULT)[number] | (string & {});
 
 declare class InternationalisationAPI {
     #private;
@@ -1140,7 +1222,10 @@ declare type IsEnabledFeatureContext = {
     engine: CreativeEngine_2;
 };
 
-declare interface LibraryOptions {
+/**
+ * @public
+ */
+export declare interface LibraryOptions {
     /**
      * `AssetLibraryEntry[]` is deprecated and will be removed in the future;
      * use `string[]` instead to pass a list of the asset library entries.
@@ -1157,7 +1242,10 @@ export { Logger }
 
 export { LogLevel }
 
-declare interface MediaPreviewOptions {
+/**
+ * @public
+ */
+export declare interface MediaPreviewOptions {
     size?: 'small' | 'medium';
     preview?: PreviewType;
     action?: ButtonOptions;
@@ -1167,7 +1255,10 @@ export { MimeType_2 as MimeType }
 
 declare const NAVIGATION_BAR_ORDER_DEFAULT: readonly ["ly.img.back.navigationBar", "ly.img.undoRedo.navigationBar", "ly.img.spacer", "ly.img.title.navigationBar", "ly.img.spacer", "ly.img.zoom.navigationBar", "ly.img.preview.navigationBar", "ly.img.actions.navigationBar", "ly.img.close.navigationBar"];
 
-declare type NavigationBarComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof NAVIGATION_BAR_ORDER_DEFAULT)[number] | (string & {});
+/**
+ * @public
+ */
+export declare type NavigationBarComponentId = 'ly.img.separator' | 'ly.img.spacer' | (typeof NAVIGATION_BAR_ORDER_DEFAULT)[number] | (string & {});
 
 /** @public */
 declare enum NavigationPosition {
@@ -1175,6 +1266,9 @@ declare enum NavigationPosition {
     Bottom = "bottom"
 }
 
+/**
+ * @public
+ */
 declare interface Notification_2 {
     type?: NotificationType;
     message: string;
@@ -1187,12 +1281,22 @@ declare interface Notification_2 {
         }) => void;
     };
 }
+export { Notification_2 as Notification }
 
-declare type NotificationDuration = number | 'infinite' | 'short' | 'medium' | 'long';
+/**
+ * @public
+ */
+export declare type NotificationDuration = number | 'infinite' | 'short' | 'medium' | 'long';
 
-declare type NotificationType = 'success' | 'error' | 'info' | 'warning' | 'loading';
+/**
+ * @public
+ */
+export declare type NotificationType = 'success' | 'error' | 'info' | 'warning' | 'loading';
 
-declare interface NumberInputOptions extends InputOptions<number> {
+/**
+ * @public
+ */
+export declare interface NumberInputOptions extends InputOptions<number> {
     min?: number;
     max?: number;
     step?: number;
@@ -1220,11 +1324,17 @@ declare type OnUploadOptions = {
  */
 export declare type Optional<T, K extends keyof T> = Omit<T, K> & Partial<T>;
 
-declare interface OrderComponent<I = ComponentId> extends ComponentPayload {
+/**
+ * @public
+ */
+export declare interface OrderComponent<I = ComponentId> extends ComponentPayload {
     id: I;
 }
 
-declare interface OrderContext {
+/**
+ * @public
+ */
+export declare interface OrderContext {
     editMode: EditMode;
 }
 
@@ -1239,35 +1349,56 @@ export declare type PageFormatDefinition = {
 
 export { PaletteColor }
 
-declare type PanelDisposer = () => void;
+/**
+ * @public
+ */
+export declare type PanelDisposer = () => void;
 
-declare type PanelId = '//ly.img.panel/assetLibrary' | '//ly.img.panel/assetLibrary.replace' | '//ly.img.panel/settings' | '//ly.img.panel/inspector' | (string & {});
+/**
+ * @public
+ */
+export declare type PanelId = '//ly.img.panel/assetLibrary' | '//ly.img.panel/assetLibrary.replace' | '//ly.img.panel/settings' | '//ly.img.panel/inspector' | (string & {});
 
-declare type PanelOptions<T extends PanelId> = {
+/**
+ * @public
+ */
+export declare type PanelOptions<T extends PanelId> = {
     closableByUser?: boolean;
     position?: PanelPosition;
     floating?: boolean;
     payload?: PanelPayload<T>;
 };
 
-declare type PanelPayload<T extends PanelId> = T extends '//ly.img.panel/assetLibrary' ? AssetLibraryPanelPayload : UnknownPanelPayload;
+/**
+ * @public
+ */
+export declare type PanelPayload<T extends PanelId> = T extends '//ly.img.panel/assetLibrary' ? AssetLibraryPanelPayload : UnknownPanelPayload;
 
 /** @public */
-declare enum PanelPosition {
+export declare enum PanelPosition {
     Left = "left",
     Right = "right"
 }
 
 export { PositionMode }
 
-declare type PreviewType = PreviewTypeImage | PreviewTypeColor;
+/**
+ * @public
+ */
+export declare type PreviewType = PreviewTypeImage | PreviewTypeColor;
 
-declare type PreviewTypeColor = {
+/**
+ * @public
+ */
+export declare type PreviewTypeColor = {
     type: 'color';
     color: string;
 };
 
-declare type PreviewTypeImage = {
+/**
+ * @public
+ */
+export declare type PreviewTypeImage = {
     type: 'image';
     uri: string;
 };
@@ -1277,7 +1408,7 @@ export { PropertyType }
 export { Range_2 as Range }
 
 /** @public */
-declare interface ReplaceAssetLibraryEntriesContext {
+export declare interface ReplaceAssetLibraryEntriesContext {
     selectedBlocks: {
         id: DesignBlockId;
         blockType: DesignBlockTypeLonghand;
@@ -1308,12 +1439,18 @@ export { SceneMode }
 
 export { Scope }
 
-declare interface SectionOptions {
+/**
+ * @public
+ */
+export declare interface SectionOptions {
     title?: string;
     children?: () => void;
 }
 
-declare interface SelectOptions extends InputOptions<SelectValue> {
+/**
+ * @public
+ */
+export declare interface SelectOptions extends InputOptions<SelectValue> {
     icon?: CustomIcon;
     inputLabel?: string | string[];
     tooltip?: string | string[];
@@ -1324,7 +1461,10 @@ declare interface SelectOptions extends InputOptions<SelectValue> {
     values: SelectValue[];
 }
 
-declare interface SelectValue {
+/**
+ * @public
+ */
+export declare interface SelectValue {
     id: string;
     label: string | string[];
     icon?: CustomIcon;
@@ -1352,7 +1492,10 @@ export { ShapeTypeShorthand }
 
 export { SizeMode }
 
-declare interface SliderOptions extends InputOptions<number> {
+/**
+ * @public
+ */
+export declare interface SliderOptions extends InputOptions<number> {
     min: number;
     max: number;
     step?: number;
@@ -1371,7 +1514,10 @@ export { StrokePosition }
 
 export { StrokeStyle }
 
-declare type Suffix = Partial<Omit<ButtonOptions, 'label' | 'inputLabel' | 'inputLabelPosition' | 'suffix'>>;
+/**
+ * @public
+ */
+export declare type Suffix = Partial<Omit<ButtonOptions, 'label' | 'inputLabel' | 'inputLabelPosition' | 'suffix'>>;
 
 export { supportsBrowser }
 
@@ -1381,15 +1527,24 @@ export { supportsVideoExport }
 
 export { supportsWasm }
 
-declare interface TextAreaOptions extends Omit<InputOptions<string>, 'suffix'> {
+/**
+ * @public
+ */
+export declare interface TextAreaOptions extends Omit<InputOptions<string>, 'suffix'> {
 }
 
 export { TextCase }
 
-declare interface TextInputOptions extends InputOptions<string> {
+/**
+ * @public
+ */
+export declare interface TextInputOptions extends InputOptions<string> {
 }
 
-declare interface TextOptions {
+/**
+ * @public
+ */
+export declare interface TextOptions {
     content: string;
     align?: 'left' | 'center' | 'right';
 }
@@ -1420,7 +1575,10 @@ declare interface UIOptionsPerDesignUnit {
     in: UIOptionsForSingleDesignUnit;
 }
 
-declare type UnknownPanelPayload = {
+/**
+ * @public
+ */
+export declare type UnknownPanelPayload = {
     [key: string]: unknown;
 };
 
@@ -2087,7 +2245,7 @@ export { VariableAPI }
 export { VerticalBlockAlignment }
 
 /** @public */
-declare enum ViewStyle {
+export declare enum ViewStyle {
     Advanced = "advanced",
     Default = "default"
 }