@chili-publish/studio-sdk 0.121.0

package/lib/src/controllers/FrameController.d.ts

@@ -0,0 +1,369 @@
+import type { EditorAPI, Id } from '../types/CommonTypes';
+import { BlendMode, FitMode, FrameLayoutType, FrameType, FrameTypeEnum, UpdateZIndexMethod, VerticalAlign } from '../types/FrameTypes';
+import { ColorUsage } from '../types/ColorStyleTypes';
+import { ShapeType } from '../types/ShapeTypes';
+/**
+ * The FrameController is responsible for all communication regarding Frames.
+ * Methods inside this controller can be called by `window.SDK.frame.{method-name}`
+ */
+export declare class FrameController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI);
+    /**
+     * This variable helps to redirect shapes related methods to newly introduced ShapeController
+     * to avoid any breaking changes
+     */
+    private shapeController;
+    /**
+     * This method returns the list of frames
+     * @returns
+     */
+    getFrames: () => Promise<import("../types/CommonTypes").EditorResponse<FrameType[]>>;
+    /**
+     * This method returns the list of selected frames
+     * @returns
+     */
+    getSelectedFrames: () => Promise<import("../types/CommonTypes").EditorResponse<FrameType[]>>;
+    /**
+     * This method returns the list of frames by pageId
+     * @param pageId The ID of a specific page
+     * @returns
+     */
+    getFramesByPageId: (pageId: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameType[]>>;
+    /**
+     * This method returns a frame by its name
+     * @param name The name of a specific frame
+     * @returns
+     */
+    getFrameByName: (name: string) => Promise<import("../types/CommonTypes").EditorResponse<FrameType>>;
+    /**
+     * This method returns a frame by its id
+     * @param id The ID of a specific frame
+     * @returns
+     */
+    getFrameById: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameType>>;
+    /**
+     * This method returns all frame properties on current layout
+     * @returns
+     */
+    getFramePropertiesOnSelectedLayout: () => Promise<import("../types/CommonTypes").EditorResponse<FrameLayoutType[]>>;
+    /**
+     * This method returns frame properties for a given frame and layout
+     * @param frameId The ID of a specific frame
+     * @param layoutId The ID of a specific layout
+     * @returns
+     */
+    getFramePropertiesByFrameId: (frameId: Id, layoutId?: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameLayoutType>>;
+    /**
+     * This method returns frame properties for a given layout
+     * @param layoutId The ID of a specific layout
+     * @returns
+     */
+    getFramesProperties: (layoutId: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameLayoutType[]>>;
+    /**
+     * This method will reset the frame size (width and height) to the frame's original value
+     * @param frameId The ID of a specific frame
+     * @returns
+     */
+    resetFrameSize: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will select a specific frame
+     * @param frameId The ID of a specific frame
+     * @returns
+     */
+    selectFrame: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will select multipleFrames
+     * @param frameIds An array of all IDs you want to select
+     * @returns
+     */
+    selectMultipleFrames: (frameIds: Id[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method changes the order of frames in the z-index list.
+     * @param orderIndex The index in the list to move to
+     * @param frameIdsToMove An array of all IDs you want to move to the given index
+     * @returns
+     */
+    reorderFrames: (orderIndex: number, frameIdsToMove: Id[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will update the z-index of a frame.
+     * @param frameId The ID of the frame you want to change the z-index of
+     * @param method The z-index update method to perform
+     * @returns
+     */
+    setFrameZIndex: (frameId: Id, method: UpdateZIndexMethod) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the height of a specific frame
+     * @param frameId The ID of a specific frame
+     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @returns
+     */
+    setFrameHeight: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    /**
+     * This method will set the rotation angle of a specific frame
+     * @param frameId The ID of a specific frame
+     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @returns
+     */
+    setFrameRotation: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    /**
+     * This method will set the width of a specific frame
+     * @param frameId The ID of a specific frame
+     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @returns
+     */
+    setFrameWidth: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    /**
+     * This method will set the x value of a specific frame
+     * @param frameId The ID of a specific frame
+     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @returns
+     */
+    setFrameX: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    /**
+     * This method will set the y value of a specific frame
+     * @param frameId The ID of a specific frame
+     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @returns
+     */
+    setFrameY: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    /**
+     * This method will update the name of a specific frame
+     * @param frameId The ID of a specific frame
+     * @param frameName The new name that the frame should receive
+     * @returns
+     */
+    setFrameName: (frameId: Id, frameName: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset properties of a specific frame to their original values
+     * @param frameId The ID of the frame that needs to get reset
+     * @returns
+     */
+    resetFrame: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the x value of a specific frame to its original value
+     * @param frameId The ID of the frame that needs to get reset
+     * @returns
+     */
+    resetFrameX: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the y value of a specific frame to its original value
+     * @param frameId The ID of the frame that needs to get reset
+     * @returns
+     */
+    resetFrameY: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the rotation value of a specific frame to its original value
+     * @param frameId The ID of the frame that needs to get reset
+     * @returns
+     */
+    resetFrameRotation: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the width of a specific frame to its original value
+     * @param frameId The ID of the frame that needs to get reset
+     * @returns
+     */
+    resetFrameWidth: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the height of a specific frame to its original value
+     * @param frameId The ID of the frame that needs to get reset
+     * @returns
+     */
+    resetFrameHeight: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the fitMode property of a specific frame to its original value
+     * @param frameId The ID of the frame that needs to get reset
+     * @returns
+     */
+    resetImageFrameFitMode: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the visibility property of a specified frame. If set to false the frame will be invisible and vice versa.
+     * @param frameId The ID of the frame that needs to get updated
+     * @param value True means the frame gets visible, false means the frame gets invisible
+     * @returns
+     */
+    setFrameVisibility: (frameId: Id, value: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will remove a specific frame using the Id.
+     * @param frameId The ID of the frame that needs to be deleted
+     * @returns
+     */
+    removeFrame: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will add a new frame of 'frameType' to the template positioned on the requested
+     * coordinates.
+     * @param frameType The type of frame to create
+     * @param x X coordinate of the new frame within the template
+     * @param y Y coordinate of the new frame within the template
+     * @param width Width of the new frame within the template
+     * @param height Height of the new frame within the template
+     * @returns The newly created frame's ID
+     */
+    addFrame: (frameType: FrameTypeEnum, x: number, y: number, width: number, height: number) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    /**
+     * This method will add a new frame of 'shapeType' type to the template positioned on the requested
+     * coordinates.
+     * @param shapeType The type of frame to create
+     * @param x X coordinate of the new frame within the template
+     * @param y Y coordinate of the new frame within the template
+     * @param width Width of the new frame within the template
+     * @param height Height of the new frame within the template
+     * @returns The newly created frame's ID
+     */
+    addShapeFrame: (shapeType: ShapeType, x: number, y: number, width: number, height: number) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    /**
+     * This method sets or removes the image source to the ImageFrame
+     * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
+     * @param src A new image source
+     * @returns
+     */
+    private updateImageSource;
+    /**
+     * This method removes the image source from the ImageFrame
+     * @param imageFrameId The ID of the imageFrame where an image needs to be removed from
+     */
+    removeImageSource: (imageFrameId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will assign an image from a mediaConnector to the correct ImageFrame
+     * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
+     * @param connectorId Unique Id of the media connector
+     * @param resourceId Unique Id of the asset that you want to assign to the imageFrame
+     * @returns
+     */
+    setImageFromConnector: (imageFrameId: Id, connectorId: string, resourceId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will assign an image from url to the correct ImageFrame
+     * Make sure the url can be accessed by the editor.
+     * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
+     * @param url A valid image uri
+     * @returns
+     */
+    setImageFromUrl: (imageFrameId: Id, url: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the fitMode property of a specified image frame.
+     * @param imageFrameId The ID of the imageFrame that needs to get updated.
+     * @param fitMode The new fitMode that you want to set to the imageFrame.
+     * @returns
+     */
+    setImageFrameFitMode: (imageFrameId: Id, fitMode: FitMode) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the constrainProportions property of a specified frame.
+     * @param frameId The ID of the frame that needs to get updated.
+     * @param constrainProportions The new constraint that you want to set to the frame.
+     * @returns
+     */
+    setFrameConstrainProportions: (frameId: Id, constrainProportions: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the vertical alignment property of a specified frame.
+     * @param frameId The ID of the frame that needs to get updated
+     * @param verticalAlign The new vertical alignment to be set to the frame.
+     * @returns
+     */
+    setVerticalAlignment: (frameId: Id, verticalAlign: VerticalAlign) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the min copyFitting property of a specified frame.
+     * @param frameId The ID of the frame that needs to get updated
+     * @param value The new min copyFitting value to be set to the frame.
+     * @returns
+     */
+    setMinCopyfitting: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    /**
+     * This method will set the max copyFitting property of a specified frame.
+     * @param frameId The ID of the frame that needs to get updated
+     * @param value The new max copyFitting value to be set to the frame.
+     * @returns
+     */
+    setMaxCopyfitting: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    /**
+     * This method will enable copyFitting on a specified frame.
+     * @param frameId The ID of the frame that needs to get updated
+     * @param value The new value to be set to the frame.
+     * @returns
+     */
+    setEnableCopyfitting: (frameId: Id, value: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the frame minCopyfitting to the frame's original value
+     * @param frameId The ID of a specific frame
+     * @returns
+     */
+    resetMinCopyfitting: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the frame maxCopyfitting to the frame's original value
+     * @param frameId The ID of a specific frame
+     * @returns
+     */
+    resetMaxCopyfitting: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the frame enableCopyfitting to the frame's original value
+     * @param frameId The ID of a specific frame
+     * @returns
+     */
+    resetEnableCopyfitting: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the visibility of the shape fill.
+     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
+     * @param enableFill Whether the shape fill is visible.
+     * @returns
+     */
+    setShapeFrameEnableFill: (shapeFrameId: Id, enableFill: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the shape fill color of a specified shape frame.
+     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
+     * @param fillColor The new shape fill color that you want to set to the shapeFrame.
+     * @returns
+     */
+    setShapeFrameFillColor: (shapeFrameId: Id, fillColor: ColorUsage) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the visibility of the shape stroke.
+     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
+     * @param enableStroke Whether the shape stroke is visible.
+     * @returns
+     */
+    setShapeFrameEnableStroke: (shapeFrameId: Id, enableStroke: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the shape stroke color of a specified shape frame.
+     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
+     * @param strokeColor The new shape stroke color that you want to set to the shapeFrame.
+     * @returns
+     */
+    setShapeFrameStrokeColor: (shapeFrameId: Id, strokeColor: ColorUsage) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the shape stroke weight of a specified shape frame.
+     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
+     * @param strokeWeight The new shape stroke weight that you want to set to the shapeFrame.
+     * @returns
+     */
+    setShapeFrameStrokeWeight: (shapeFrameId: Id, strokeWeight: number) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will set the blend mode of a specified shape frame
+     * @param frameId The ID of a specific frame
+     * @param blendMode The blend mode
+     * @returns
+     */
+    setFrameBlendMode: (frameId: Id, blendMode: BlendMode) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will make the specified image frame go into cropping mode.
+     * @param frameId The ID of a specific image frame
+     * @returns
+     */
+    enterCropMode: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will exit cropping mode while saving the applied crop.
+     * @returns
+     */
+    applyCropMode: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will reset the currently applied crop mode and apply the last selected fit mode again.
+     * @param frameId The ID of a specific image frame
+     * @returns
+     */
+    resetCropMode: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will exit cropping mode without saving the applied crop.
+     * @returns
+     */
+    cancelCropMode: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+}