@canva/design 1.10.0 → 2.0.0-beta.1

package/index.d.ts

@@ -1,1665 +0,0 @@
-/**
- * Adds an audio track to the user's design.
- * @public
- * @param audioTrack - The audio track to add to the user's design.
- */
-export declare function addAudioTrack(audioTrack: AudioTrack): Promise<void>;
-
-/**
- * @public
- * Adds a native element to the user's design.
- * @param element - The element to add to the user's design.
- */
-export declare function addNativeElement(
-  element: NativeElement | NativeElementWithBox
-): Promise<void>;
-
-/**
- * @public
- * Adds a new page immediately after the currently selected page.
- * @param opts - Configuration for the new page to be added.
- */
-export declare function addPage(opts?: {
-  /**  Elements to be added to the page */
-  elements?: NativeElementWithBox[];
-  /**
-   * The page background. This can be a solid color, an image or a video.
-   **/
-  background?: PageBackgroundFill;
-  /**  A page title which must be no longer than 255 characters */
-  title?: string;
-}): Promise<void>;
-
-/**
- * @public
- * Describes any alt-text that will be added for a11y.
- */
-export declare type AltText = {
-  /**
-   * The text that will appear as alt-text.
-   */
-  text: string;
-  /**
-   * An optional property that will determine whether text is shown in just the editor or both editor and view mode.
-   * If set to true, alt-text will only be rendered inside the editor.
-   * If set to false or omitted, alt-text will be rendered in both the editor and in view only mode.
-   */
-  decorative: boolean | undefined;
-};
-
-/**
- * @public
- * A callback that runs when an app element's data is created or updated,
- * or when the user selects an existing app element.
- */
-export declare type AppElementChangeHandler<A extends AppElementData> = (
-  appElement:
-    | {
-        data: A;
-        version: number;
-      }
-    | undefined
-) => void;
-
-/**
- * @public
- * A client interface for managing app elements and app element data.
- */
-export declare interface AppElementClient<A extends AppElementData> {
-  /**
-   * Attaches data to the selected app element or creates a new app element if one is not selected.
-   * If data already exists, it's overwritten.
-   * @param appElementData - The data to attach to the app element.
-   */
-  addOrUpdateElement(appElementData: A, placement?: Placement): Promise<void>;
-  /**
-   * Registers a callback that runs when the app element's data is created or
-   * updated and when the user selects an existing app element.
-   * @param handler - The callback to run when the app element's data is changed
-   * and when the user selects an existing app element.
-   */
-  registerOnElementChange(handler: AppElementChangeHandler<A>): void;
-}
-
-/**
- * @public
- * Configuration for an AppElementClient
- */
-export declare type AppElementClientConfiguration<A extends AppElementData> = {
-  /**
-   * The AppElementRenderer to use when rendering the app element
-   */
-  render: AppElementRenderer<A>;
-};
-
-/**
- * @public
- * The data an app can attach to an app element.
- */
-export declare type AppElementData = Record<string, Value>;
-
-/**
- * @public
- * A callback that runs when an app's element is changed.
- *
- * @remarks
- * This callback must return one or more elements to render within the app element.
- */
-export declare type AppElementRenderer<A extends AppElementData> = (
-  appElementData: A
-) => AppElementRendererOutput;
-
-/**
- * @public
- * A return value of {@link AppElementRenderer} function.
- * It is an array of elements to render within an app element.
- */
-export declare type AppElementRendererOutput = NativeSimpleElementWithBox[];
-
-/**
- * @public
- * A unique identifier that references an app runtime process
- */
-export declare type AppProcessId = string & {
-  __appProcessId: never;
-};
-
-/**
- * @public
- * Options for defining the drag-and-drop behavior of audio tracks.
- */
-export declare type AudioDragConfig = {
-  /**
-   * The type of element.
-   */
-  type: "AUDIO";
-  /**
-   * A function that returns a reference (ref) to an audio asset in Canva's backend.
-   */
-  resolveAudioRef: () => Promise<{
-    ref: AudioRef;
-  }>;
-  /**
-   * The duration of the audio track, in milliseconds.
-   */
-  durationMs: number;
-  /**
-   * A human readable title for the audio track.
-   */
-  title: string;
-};
-
-/**
- * @public
- * A unique identifier that references an audio asset in Canva's backend.
- */
-export declare type AudioRef = string & {
-  __audioRef: never;
-};
-
-/**
- * @public
- * An audio track that can be added to a user's design.
- */
-export declare type AudioTrack = {
-  /**
-   * A unique identifier that references an audio asset in Canva's backend.
-   */
-  ref: AudioRef;
-};
-
-/**
- * @public
- * The dimensions, position, and rotation of an element.
- *
- * @remarks
- * Units are relative to the parent container both in terms of position and size
- */
-export declare type Box = Position & (WidthAndHeight | Width | Height);
-
-declare type CommonImageDragConfig = {
-  /**
-   * The type of element.
-   */
-  type: "IMAGE";
-  /**
-   * The dimensions of the preview image.
-   *
-   * @remarks
-   * The preview image is the image that users see under their cursor while dragging
-   * it into their design.
-   */
-  previewSize: Dimensions;
-};
-
-/**
- * @public
- * A snapshot of some part of the document content.
- *
- * @remarks
- * You can mutate the values in the `contents` array and then persist those changes with the `save` method.
- */
-export declare interface ContentDraft<T> {
-  /**
-   * The selected content.
-   */
-  readonly contents: readonly T[];
-  /**
-   * Saves changes made to items in the `contents` array.
-   * Once saved, those changes are reflected in the user's design.
-   *
-   * @remarks
-   * Any other changes to the content since calling the `read` method, such as the user editing the content directly, will be overwritten.
-   * Only properties that are different from the original state are written to the design.
-   */
-  save(): Promise<void>;
-}
-
-/**
- * @public
- * Represents X and Y coordinates.
- */
-export declare type Coordinates = {
-  /**
-   * Represents an X coordinate, in pixels.
-   */
-  x: number;
-  /**
-   * Represents a Y coordinate, in pixels.
-   */
-  y: number;
-};
-
-/**
- * @public
- * Provides methods for interacting with design overlay
- */
-export declare type DesignOverlay = {
-  /**
-   * Registers a callback that runs when an overlay canOpen status changed on a particular target.
-   *
-   * @remarks
-   * The callback fires immediately
-   */
-  registerOnCanOpen<Target extends OverlayTarget>(opts: {
-    target: Target;
-    onCanOpen(event: OverlayOpenableEvent<Target>): void;
-  }): () => void;
-};
-
-/**
- * @public
- * Provides methods for interacting with the user's selected content, such as images or text.
- */
-export declare type DesignSelection = {
-  /**
-   * Registers a callback that runs when a user selects an element that contains the specified type of content.
-   *
-   * @remarks
-   * The callback fires immediately if content is already selected.
-   */
-  registerOnChange<Scope extends SelectionScope>(opts: {
-    /**
-     * The type of content that, when selected, triggers the `onChange` callback.
-     */
-    scope: Scope;
-    /**
-     * The callback to run when the selection changes.
-     */
-    onChange(event: SelectionEvent<Scope>): void;
-  }): () => void;
-};
-
-/**
- * @public
- * JWT that contains the Design ID and App ID.
- */
-export declare type DesignToken = {
-  token: string;
-};
-
-/**
- * @public
- * Represents a width and a height.
- */
-export declare type Dimensions = {
-  /**
-   * Represents a width, in pixels.
-   */
-  width: number;
-  /**
-   * Represents a height, in pixels.
-   */
-  height: number;
-};
-
-/**
- * @public
- * Callbacks that run during the lifecycle of a drag-and-drop.
- */
-export declare type DragCallback = {
-  /**
-   * A callback that runs when the user starts dragging an element into their design.
-   *
-   * @param element - The element being dragged into the user's design.
-   */
-  onDragStart: (element: HTMLElement) => void;
-  /**
-   * A callback that runs when the user finishes dragging an element into their design.
-   *
-   * @param element - The element being dragged into the user's design.
-   */
-  onDragEnd: (element: HTMLElement) => void;
-};
-
-/**
- * @public
- * Options for making an element draggable.
- */
-export declare type DraggableElementData = ElementData | ImageElementData;
-
-/**
- * @public
- * Represents a drag start event that occurs when initiating a drag-and-drop behavior inside the app.
- */
-export declare type DragStartEvent<E extends Element> = Pick<
-  DragEvent,
-  "dataTransfer" | "currentTarget" | "preventDefault" | "clientX" | "clientY"
-> & {
-  currentTarget: E;
-};
-
-/**
- * @public
- * Options for making an `HTMLElement` draggable.
- */
-export declare type ElementData = DragCallback & {
-  /**
-   * The element to be made draggable.
-   */
-  node: HTMLElement;
-  /**
-   * Options for defining the drag-and-drop behavior.
-   *
-   * @remarks
-   * This data is required because it can't be inferred from the `node` property.
-   */
-  dragData: UserSuppliedDragData;
-};
-
-/**
- * @public
- *
- * Options for defining the drag-and-drop behaviour for embeds.
- */
-export declare type EmbedDragConfig = {
-  /**
-   * The type of element.
-   */
-  type: "EMBED";
-  /**
-   * The dimensions of the preview image.
-   * The preview image is the image that users see under their cursor
-   * while dragging it into their design.
-   */
-  previewSize: Dimensions;
-  /**
-   * Represents the preview image of the embed.
-   */
-  previewUrl: string;
-  /**
-   * Represents the embed source url.
-   */
-  embedUrl: string;
-};
-
-/**
- * @public
- * Export aborted response
- *
- * @remarks
- * Ane export flow is considered aborted when a user closes
- * the export options menu.
- */
-export declare type ExportAborted = {
-  /**
-   * The status of the export flow when the user has aborted the export menu.
-   */
-  status: "ABORTED";
-};
-
-/**
- * @public
- * The exported file.
- */
-export declare type ExportBlob = {
-  /**
-   * The URL of the exported design.
-   *
-   * @remarks
-   * If the user's design contains multiple pages but is exported in a format that doesn't support multiple pages, the URL will point to a ZIP file that contains each page as a separate file.
-   *
-   * For example:
-   *
-   * - If a single-page design is exported as a JPG, the URL will point to a JPG file
-   * - If a multi-page design is exported as a JPG, the URL will point to a ZIP file that contains a separate JPG file for each page
-   * - If a multi-page design is exported as a PDF, the URL will point to a PDF file that contains all of the pages
-   *
-   * The following file types support multiple pages:
-   *
-   * - `"GIF"`
-   * - `"PDF_STANDARD"`
-   * - `"PPTX"`
-   * - `"VIDEO"`
-   *
-   * The following file types do not support multiple pages:
-   *
-   * - `"JPG"`
-   * - `"PNG"`
-   * - `"SVG"`
-   */
-  url: string;
-};
-
-/**
- * @public
- * Export completed response
- */
-export declare type ExportCompleted = {
-  /**
-   * The status of the export flow when the user has submitted the export menu.
-   */
-  status: "COMPLETED";
-  /**
-   * The title of the successful export of a design, if it has been set by the user.
-   */
-  title?: string;
-  /**
-   * The exported files.
-   *
-   * @remarks
-   * This array only contains one element. This is because, if a multi-page design is exported as multiple files, the files are exported in a ZIP file. In the future, there'll be an option for each file to be a separate element in the array.
-   */
-  exportBlobs: ExportBlob[];
-};
-
-/**
- * @public
- * The types of files that Canva supports for exported designs.
- */
-export declare type ExportFileType =
-  | "PNG"
-  | "JPG"
-  | "PDF_STANDARD"
-  | "VIDEO"
-  | "GIF"
-  | "PPTX"
-  | "SVG";
-
-/**
- * @public
- * The options for configuring the export of a design.
- */
-export declare type ExportRequest = {
-  /**
-   * The types of files the user can export their design as.
-   *
-   * @remarks
-   * You must provide at least one file type.
-   */
-  acceptedFileTypes: ExportFileType[];
-};
-
-/**
- * @public
- * The response of an export request.
- */
-export declare type ExportResponse = ExportCompleted | ExportAborted;
-
-/**
- * @public
- *
- * Options for defining the Drag and Drop behaviour for images uploaded
- * via the Content capability.
- */
-export declare type ExternalImageDragConfig = CommonImageDragConfig & {
-  /**
-   * The function that resolves an image ref
-   * @remarks
-   *
-   * This function will be run during the drag process in order to fetch the media ref of the
-   * external image being fetched. This function should return the result of `upload`
-   * from the content capability.
-   */
-  resolveImageRef: () => Promise<{
-    ref: ImageRef;
-  }>;
-  /**
-   * The URL of the preview image.
-   *
-   * @remarks
-   * The preview image is the image that users see under their cursor while dragging
-   * it into their design.
-   */
-  previewUrl: string;
-  /**
-   * The dimensions of the full-size image.
-   *
-   * @remarks
-   * The full-size image is the image that Canva uploads to the user's account and
-   * adds to their design.
-   *
-   * If omitted, the value of the `previewSize` property is used as a fallback.
-   */
-  fullSize?: Dimensions;
-};
-
-/**
- * @public
- * The appearance of a path's interior.
- */
-export declare type Fill = {
-  /**
-   * Boolean defining whether image or video can be dropped on the fill by the user.
-   * If set to true, images or videos can be dropped on the fill.
-   */
-  dropTarget?: boolean;
-  /**
-   * The color of the fill as a hex code.
-   *
-   * @remarks
-   * The hex code must include all six characters and be prefixed with a # symbol (e.g. #ff0099).
-   * Only one type of fill (color, image or video) can be set.
-   */
-  color?: string;
-  /**
-   * An asset (image or video) that will be used to fill the given path.
-   *
-   * @remarks
-   * Only one type of fill (color, image or video) can be set.
-   */
-  asset?: ImageFill | VideoFill;
-};
-
-/**
- * @public
- * A reference to a font that can be used in other parts of the SDK.
- */
-export declare type FontRef = string & {
-  __fontRef: never;
-};
-
-/**
- * @public
- * Font weights supported in the SDK.
- **/
-export declare type FontWeight =
-  | "normal"
-  | "thin"
-  | "extralight"
-  | "light"
-  | "medium"
-  | "semibold"
-  | "bold"
-  | "ultrabold"
-  | "heavy";
-
-/**
- * Allows to get the context of currently selected page.
- * @public
- * @returns Page context of currently selected page
- */
-export declare function getCurrentPageContext(): Promise<PageContext>;
-
-/**
- * @public
- * Gets the default dimensions that a new page will have when it is added to a design.
- * It is possible for a user to resize a page without resizing the entire design, e.g. by clicking
- * "Expand to Whiteboard". However, there will always be a single set of default dimensions for a
- * design that is applied whenever a new page is created.
- *
- * Returns `undefined` if the design is unbounded (e.g. Whiteboard or Doc).
- */
-export declare function getDefaultPageDimensions(): Promise<
-  Dimensions | undefined
->;
-
-/**
- * @public
- * Retrieves a signed JWT that contains the Design ID, App ID and User ID.
- */
-export declare function getDesignToken(): Promise<DesignToken>;
-
-declare type Height = {
-  width: "auto";
-  height: number;
-};
-
-/**
- * @public
- * Options for defining the drag-and-drop behavior of an image element that can be defined by an
- * app developer.
- */
-export declare type ImageDragConfig = ExternalImageDragConfig;
-
-/**
- * @public
- * Options for defining the drag-and-drop behavior for images.
- */
-export declare type ImageDragConfigForElement<E extends Element> =
-  E extends HTMLImageElement
-    ? Partial<ImageDragConfig> & Pick<ImageDragConfig, "type">
-    : ImageDragConfig;
-
-/**
- * @public
- * Options for making an `HTMLImageElement` draggable.
- */
-export declare type ImageElementData = DragCallback & {
-  /**
-   * The element to be made draggable.
-   */
-  node: HTMLImageElement;
-  /**
-   * Options for defining the drag-and-drop behavior.
-   *
-   * @remarks
-   * If any of this data is omitted, it's inferred from the `node` property.
-   */
-  dragData?:
-    | Partial<UserSuppliedImageDragData>
-    | (Partial<UserSuppliedVideoDragData> &
-        Pick<UserSuppliedVideoDragData, "type" | "resolveVideoRef">);
-};
-
-/**
- * @public
- * An image asset that will be used to fill the given path.
- */
-export declare type ImageFill = {
-  /**
-   * Type of an asset that will be used to fill the given path.
-   */
-  type: "IMAGE";
-  /**
-   * A unique identifier that references an image asset in Canva's backend.
-   */
-  ref: ImageRef;
-};
-
-/**
- * @public
- * A unique identifier that references an image asset in Canva's backend.
- */
-export declare type ImageRef = string & {
-  __imageRef: never;
-};
-
-/**
- * @public
- * @param appElementConfig - Configuration for an AppElementClient
- */
-export declare function initAppElement<A extends AppElementData>(
-  appElementConfig: AppElementClientConfiguration<A>
-): AppElementClient<A>;
-
-/**
- * @public
- * A native element.
- */
-export declare type NativeElement =
-  | NativeImageElement
-  | NativeVideoElement
-  | NativeEmbedElement
-  | NativeTextElement
-  | NativeShapeElement
-  | NativeGroupElement;
-
-/**
- * @public
- * The types of elements an app can add to a user's design.
- */
-export declare type NativeElementType =
-  | "IMAGE"
-  | "EMBED"
-  | "TEXT"
-  | "SHAPE"
-  | "VIDEO";
-
-/**
- * @public
- * An element that exists within an app or group element.
- */
-export declare type NativeElementWithBox =
-  | NativeImageElementWithBox
-  | NativeVideoElementWithBox
-  | NativeEmbedElementWithBox
-  | NativeTextElementWithBox
-  | NativeShapeElementWithBox
-  | NativeGroupElementWithBox;
-
-/**
- * @public
- * An element that renders an embeddable piece of media, such as a YouTube video.
- */
-export declare type NativeEmbedElement = {
-  /**
-   * The type of element.
-   */
-  type: "EMBED";
-  /**
-   * The URL of the embed. This URL must be supported by the Iframely API.
-   */
-  url: string;
-};
-
-/**
- * @public
- * An element that renders an embeddable piece of media, such as a YouTube video.
- *
- * @remarks
- * This type includes properties for controlling the position and dimensions of the
- * element.
- * It will be positioned and sized relative to its parent container.
- * The parent container may be an app element, or the current page.
- */
-export declare type NativeEmbedElementWithBox = {
-  /**
-   * The type of element.
-   */
-  type: "EMBED";
-  /**
-   * The URL of the embed.
-   *
-   * @remarks
-   * This URL must be supported by the Iframely API.
-   */
-  url: string;
-} & Box;
-
-/**
- * @public
- * An element containing two or more {@link NativeElementWithBox}.
- */
-export declare type NativeGroupElement = {
-  /**
-   * The type of element.
-   */
-  type: "GROUP";
-  /**
-   * The inner elements contained by the group element. These elements require a Box as they are
-   * relatively positioned to the outer boundaries of the group element.
-   */
-  children: NativeSimpleElementWithBox[];
-};
-
-/**
- * @public
- * An element containing two or more {@link NativeSimpleElementWithBox}.
- *
- * @remarks
- * This type includes properties for controlling the position and dimensions
- * of the element
- */
-export declare type NativeGroupElementWithBox = {
-  /**
-   * The type of element.
-   */
-  type: "GROUP";
-  /**
-   * The inner elements contained by the group element. These elements require a Box as they are
-   * relatively positioned to the outer boundaries of the group element.
-   */
-  children: NativeSimpleElementWithBox[];
-} & Box;
-
-/**
- * @public
- * An element that renders an image in the user's design.
- */
-export declare type NativeImageElement = {
-  /**
-   * The type of element.
-   */
-  type: "IMAGE";
-  /**
-   * An optional object to describe alt-text that may be applied to an image.
-   */
-  altText?: AltText;
-} & (
-  | {
-      /**
-       * A data URL that contains the image data.
-       */
-      dataUrl: string;
-      /**
-       * A unique identifier that references an image asset in Canva's backend.
-       */
-      ref?: never;
-    }
-  | {
-      /**
-       * A data URL that contains the image data.
-       */
-      dataUrl?: never;
-      /**
-       * A unique identifier that references an image asset in Canva's backend.
-       */
-      ref: ImageRef;
-    }
-);
-
-/**
- * @public
- * An element that renders an image in the user's design.
- *
- * @remarks
- * This type includes properties for controlling the position and dimensions
- * of the element.
- * It will be positioned and sized relative to its parent container.
- * The parent container may be an app element, or the current page.
- */
-export declare type NativeImageElementWithBox = NativeImageElement & Box;
-
-/**
- * @public
- * An element that renders a vector shape.
- */
-export declare type NativeShapeElement = {
-  /**
-   * The type of element.
-   */
-  type: "SHAPE";
-  /**
-   * Properties for configuring the scale and cropping of a shape.
-   *
-   * @remarks
-   * This is similar to the `viewBox` attribute of the <svg> element.
-   */
-  viewBox: ShapeViewBox;
-  /**
-   * The paths that define the shape of the element.
-   *
-   * @remarks
-   * There must be between 1 and 30 paths. The maximum combined size of all paths must
-   * not exceed 2kb. The maximum numbrer of unique fill colors across all paths is 6.
-   */
-  paths: ShapePath[];
-};
-
-/**
- * @public
- * An element that renders a vector shape.
- *
- * @remarks
- * This type includes properties for controlling the position and dimensions of the
- * element.
- * It will be positioned and sized relative to its parent container.
- * The parent container may be an app element, or the current page.
- */
-export declare type NativeShapeElementWithBox = {
-  /**
-   * The type of element.
-   */
-  type: "SHAPE";
-  /**
-   * Properties for configuring the scale and cropping of a shape.
-   *
-   * @remarks
-   * This is similar to the `viewBox` attribute of the <svg> element.
-   */
-  viewBox: ShapeViewBox;
-  /**
-   * The paths that define the shape of the element.
-   */
-  paths: ShapePath[];
-} & Box;
-
-/**
- * @public
- * An element that exists within a group element.
- */
-export declare type NativeSimpleElementWithBox = Exclude<
-  NativeElementWithBox,
-  NativeGroupElementWithBox
->;
-
-/**
- * @public
- * An element that renders text.
- */
-export declare type NativeTextElement = {
-  /**
-   * The type of element.
-   */
-  type: "TEXT";
-  /**
-   * The text to render within the element. In the future, each item in this
-   * array will map to a paragraph. At the moment, only one item is supported.
-   */
-  children: string[];
-} & TextAttributes;
-
-/**
- * @public
- * An element that renders text.
- *
- * @remarks
- * This type includes properties for controlling the position and dimensions of the
- * element.
- * It will be positioned and sized relative to its parent container.
- * The parent container may be an app element, or the current page.
- */
-export declare type NativeTextElementWithBox = {
-  /**
-   * The type of element.
-   */
-  type: "TEXT";
-  /**
-   * The text to render within the element.
-   *
-   * @remarks
-   * In the future, each item in this array will map to a paragraph. At the moment,
-   * only one item is supported.
-   */
-  children: [string];
-  /**
-   * The width of the element. This must be an integer between 0 and 32767.
-   */
-  width?: number;
-  /**
-   * The distance from the top edge of the container.
-   *
-   * @remarks
-   * This must be an integer between -32768 and 32767. This property doesn't have
-   * any effect if the app element only contains a single element.
-   */
-  top: number;
-  /**
-   * The distance from the left edge of the container.
-   *
-   * @remarks
-   * This must be an integer between -32768 and 32767. This property doesn't have
-   * any effect if the app element only contains a single element.
-   */
-  left: number;
-  /**
-   * The rotation of the element, in degrees.
-   *
-   * @remarks
-   * This must be an integer between -180 and 180.
-   */
-  rotation?: number;
-} & TextAttributes;
-
-/**
- * @public
- * An element that renders a video in the user's design.
- */
-export declare type NativeVideoElement = {
-  /**
-   * The type of element.
-   */
-  type: "VIDEO";
-  /**
-   * A unique identifier that references a video asset in Canva's backend.
-   */
-  ref: VideoRef;
-  /**
-   * An optional object to describe alt-text that may be applied to a video.
-   */
-  altText?: AltText;
-};
-
-/**
- * @public
- * An element that renders a video in the user's design.
- *
- * @remarks
- * This type includes properties for controlling the position and dimensions
- * of the element.
- * It will be positioned and sized relative to its parent container.
- * The parent container may be an app element, or the current page.
- */
-export declare type NativeVideoElementWithBox = NativeVideoElement & Box;
-
-/**
- * The types of object primitive values that can be stored within an app element's data.
- */
-declare type ObjectPrimitive = Boolean | String;
-
-/**
- * @public
- * An alias for the DesignOverlay interface, providing access to design overlay related functionality
- */
-export declare const overlay: DesignOverlay;
-
-/**
- * @public
- * Information about whether the overlay can be opened or not on a particular {@link OverlayTarget}
- */
-export declare type OverlayOpenableEvent<Target extends OverlayTarget> = {
-  /**
-   * An event indicating whether the overlay can be opened or not when {@link OverlayTarget} is `"image_selection"`
-   */
-  ["image_selection"]:
-    | OverlayUnopenableEvent
-    | {
-        canOpen: true;
-        /**
-         * Launch a new app process on an overlay on top of the current selected image fill
-         *
-         * @remarks
-         * `launchParameters` specifies the type of data that are provided to an app process at its launch
-         */
-        readonly open: (options: {
-          launchParameters?: any;
-        }) => Promise<AppProcessId>;
-      };
-}[Target];
-
-/**
- * @public
- * The target to check if an overlay can be opened for
- */
-export declare type OverlayTarget = "image_selection";
-
-/**
- * @public
- * Information about the overlay when it can not be opened on a particular {@link OverlayTarget}
- */
-declare type OverlayUnopenableEvent = {
-  canOpen: false;
-  reason: string;
-};
-
-/**
- * @public
- * The appearance of a page's background.
- */
-export declare type PageBackgroundFill = Pick<Fill, "asset" | "color">;
-
-/**
- * @public
- * Page context
- */
-export declare type PageContext = {
-  /**
-   * Page dimensions in px
-   *
-   * @remarks
-   * This value is undefined for Whiteboard and Docs
-   */
-  dimensions: PageDimensions | undefined;
-};
-
-/**
- * @public
- * Page Dimensions
- */
-export declare type PageDimensions = {
-  width: number;
-  height: number;
-};
-
-/**
- * @public
- * The outline of a path.
- */
-export declare type PathStroke = {
-  /**
-   * The weight of the stroke. This must be an integer between 0 and 100.
-   */
-  weight: number;
-  /**
-   * The color of the stroke as a hex code.
-   *
-   * @remarks
-   * The hex code must include all six characters and be prefixed with a # symbol (e.g. #ff0099).
-   */
-  color: string;
-  /**
-   * The alignment of the stroke. The only supported value is 'inset'.
-   */
-  strokeAlign: "inset";
-};
-
-/**
- * @public
- * The dimensions, position, and rotation of an element.
- */
-export declare type Placement = Position & (WidthAndHeight | Width | Height);
-
-declare type Position = {
-  /**
-   * The distance from the top edge of the container.
-   *
-   * @remarks
-   * This must be an integer between -32768 and 32767. This property doesn't
-   * have any effect if the app element only contains a single element.
-   */
-  top: number;
-  /**
-   * The distance from the left edge of the container.
-   *
-   * @remarks
-   * This must be an integer between -32768 and 32767. This property doesn't
-   * have any effect if the app element only contains a single element.
-   */
-  left: number;
-  /**
-   * The rotation of the box, in degrees.
-   *
-   * @remarks
-   * This must be an integer between -180 and 180.
-   */
-  rotation?: number;
-};
-
-/**
- * The types of primitive values that can be stored within an app element's data.
- *
- * @remarks
- * All types of primitives are supported except for symbols and bigints.
- */
-declare type Primitive = undefined | null | number | boolean | string;
-
-/**
- * @public
- * Exports the user's design as one or more static files.
- * @param request - The request object containing configurations of the design export.
- */
-export declare function requestExport(
-  request: ExportRequest
-): Promise<ExportResponse>;
-
-/**
- * @public
- * An alias for the DesignSelection interface, providing access to design selection related functionality
- */
-export declare const selection: DesignSelection;
-
-/**
- * @public
- * Information about the user's selection. To access the selected content, call the `read` method.
- */
-export declare interface SelectionEvent<Scope extends SelectionScope> {
-  /**
-   * The type of content that's selected.
-   */
-  readonly scope: Scope;
-  /**
-   * The number of selected elements.
-   */
-  readonly count: number;
-  /**
-   * Creates a snapshot of the selected content and returns a *draft* object.
-   * The draft has a mutable `contents` property for making changes to the selected content.
-   * Any changes made to `contents` are not immediately persisted or reflected in the user's design.
-   * To persist the changes, call the `save` method that's available via the draft.
-   *
-   * @example Replacing text
-   * ```
-   * const draft = await selectionEvent.read();
-   *
-   * for(const content of draft.contents) {
-   *     // This change won't immediately appear in the user's design
-   *     content.text = "This is the new text";
-   * }
-   *
-   * // The changes will now appear in the user's design
-   * await draft.save();
-   * ```
-   */
-  read(): Promise<ContentDraft<SelectionValue<Scope>>>;
-}
-
-/**
- * @public
- * The type of content that apps can detect selection changes on.
- */
-export declare type SelectionScope = "plaintext" | "image" | "video";
-
-/**
- * @public
- * The selected content.
- *
- * @remarks
- * The value depends on the {@link SelectionScope}.
- */
-export declare type SelectionValue<Scope extends SelectionScope> = {
-  /**
-   * The selected content when {@link SelectionScope} is `"plaintext"`.
-   */
-  ["plaintext"]: {
-    /**
-     * The text content of the element as plain text.
-     */
-    text: string;
-  };
-  /**
-   * The selected content when {@link SelectionScope} is `"image"`.
-   */
-  ["image"]: {
-    /**
-     * A unique identifier that points to an image asset in Canva's backend.
-     */
-    ref: ImageRef;
-  };
-  /**
-   * The selected content when {@link SelectionScope} is `"video"`.
-   */
-  ["video"]: {
-    /**
-     * A unique identifier that points to an video asset in Canva's backend.
-     */
-    ref: VideoRef;
-  };
-}[Scope];
-
-/**
- * @public
- * Updates the background of the user's current page. The background can be a solid color,
- * an image or a video.
- */
-export declare function setCurrentPageBackground(
-  opts: PageBackgroundFill
-): Promise<void>;
-
-/**
- * @public
- * A path that defines the shape of a shape element.
- */
-export declare type ShapePath = {
-  /**
-   * The shape of the path.
-   *
-   * @remarks
-   * This accepts the same value as the `d` attribute of the SVG <path> element,
-   * with some limitations.
-   *
-   * The path must:
-   *
-   * - start with an M command
-   * - not have more than one M command
-   * - not use the Q command
-   * - be closed, either with a Z command at the end or by having the last
-   * coordinate match the first coordinate
-   */
-  d: string;
-  /**
-   * The appearance of the path's interior.
-   */
-  fill: Fill;
-  /**
-   * The outline of the path.
-   */
-  stroke?: PathStroke;
-};
-
-/**
- * @public
- * Properties for configuring the scale and cropping of a shape.
- *
- * @remarks
- * This is similar to the `viewBox` attribute of the <svg> element.
- */
-export declare type ShapeViewBox = {
-  /**
-   * The distance of the shape from the top edge of the element.
-   */
-  top: number;
-  /**
-   * The distance of the shape from the left edge of the element.
-   */
-  left: number;
-  /**
-   * The width of the view box.
-   */
-  width: number;
-  /**
-   * The height of the view box.
-   */
-  height: number;
-};
-
-/**
- * @public
- * Attributes for changing the appearance of text.
- */
-export declare type TextAttributes = {
-  /**
-   * The size of the text.
-   *
-   * @remarks
-   * The default value is 16. This must be an integer between 1 and 1000.
-   * This property will be ignored when adding native text elements without specifying placement.
-   */
-  fontSize?: number;
-  /**
-   * The alignment of the text.
-   * @defaultValue 'start'
-   */
-  textAlign?: "start" | "center" | "end" | "justify";
-  /**
-   * The color of the text as a hex code.
-   *
-   * @remarks
-   * The hex code must include all six characters and be prefixed with a # symbol
-   * (e.g. #ff0099). The default value is #000000.
-   */
-  color?: string;
-  /**
-   * @public
-   * A reference to the font to use for this text element.
-   */
-  fontRef?: FontRef;
-  /**
-   * The weight of the font.
-   * @defaultValue 'normal'
-   */
-  fontWeight?: FontWeight;
-  /**
-   * The style of the font.
-   * @defaultValue 'normal'
-   */
-  fontStyle?: "normal" | "italic";
-  /**
-   * The decoration of the font.
-   * @defaultValue 'none'
-   */
-  decoration?: "none" | "underline";
-};
-
-/**
- * @public
- * Options for defining the drag-and-drop behavior of a text element.
- */
-export declare type TextDragConfig = {
-  /**
-   * The type of element.
-   */
-  type: "TEXT";
-  /**
-   * The text content to drag.
-   */
-  children?: string[];
-  /**
-   * The alignment of the text.
-   * @defaultValue 'start'
-   */
-  textAlign?: "start" | "center" | "end" | "justify";
-  /**
-   * The weight of the font.
-   * @defaultValue 'normal'
-   */
-  fontWeight?: FontWeight;
-  /**
-   * The style of the font.
-   * @defaultValue 'normal'
-   */
-  fontStyle?: "normal" | "italic";
-  /**
-   * The decoration of the font.
-   * @defaultValue 'none'
-   */
-  decoration?: "none" | "underline";
-};
-
-/**
- * @public
- * The methods for adding drag-and-drop behavior to an app.
- */
-export declare interface UI {
-  /**
-   * @public
-   * Makes the specified node draggable.
-   *
-   * @deprecated use `UI.startDrag` instead
-   *
-   * @param options - Options for making an element draggable.
-   */
-  makeDraggable(options: DraggableElementData): void;
-  /**
-   * @public
-   * Handles a drag event initiated inside the app to Canva, enables drag-and_drop interactions with elements outside of the app.
-   * @param event - The drag start event.
-   * @param dragData - The data to be passed to the drag handler.
-   */
-  startDrag<E extends HTMLElement>(
-    event: DragStartEvent<E>,
-    dragData:
-      | TextDragConfig
-      | AudioDragConfig
-      | EmbedDragConfig
-      | VideoDragConfigForElement<E>
-      | ImageDragConfigForElement<E>
-  ): Promise<void>;
-}
-
-/**
- * An alias for the UI interface, providing access to ui related functionality
- * @public
- */
-export declare const ui: UI;
-
-/**
- * @deprecated
- * @public
- * Options for defining the drag-and-drop behavior of audio tracks.
- */
-export declare type UserSuppliedAudioDragData = AudioDragConfig;
-
-/**
- * @deprecated
- * @public
- *
- * Options for defining the Drag and Drop behaviour for images
- * which have been supplied as data urls
- */
-export declare type UserSuppliedDataUrlImageDragData = CommonImageDragConfig & {
-  /**
-   * The dimensions of the full-size image.
-   *
-   * @remarks
-   * The full-size image is the image that Canva uploads to the user's account and
-   * adds to their design.
-   *
-   * If omitted, the value of the `previewSize` property is used as a fallback.
-   */
-  fullSize?: Dimensions;
-  /**
-   * The data URL of the preview image.
-   *
-   * @remarks
-   * The preview image is the image that users see under their cursor while dragging
-   * it into their design.
-   *
-   * If omitted, the value of the `fullSizeSrc` property is used as a fallback.
-   */
-  previewSrc?: string;
-  /**
-   * The data URL of the full-size image.
-   *
-   * @remarks
-   * The full-size image is the image that Canva uploads to the user's account and
-   * adds to their design.
-   */
-  fullSizeSrc: string;
-};
-
-/**
- * @deprecated
- * @public
- * Options for defining the drag-and-drop behavior that can be defined by an app developer.
- */
-export declare type UserSuppliedDragData =
-  | UserSuppliedImageDragData
-  | UserSuppliedTextDragData
-  | UserSuppliedVideoDragData
-  | UserSuppliedAudioDragData;
-
-/**
- * @deprecated
- * @public
- *
- * Options for defining the Drag and Drop behaviour for images uploaded
- * via the Content capability.
- */
-export declare type UserSuppliedExternalImageDragData =
-  CommonImageDragConfig & {
-    /**
-     * The function that resolves an image ref
-     * @remarks
-     *
-     * This function will be run during the drag process in order to fetch the media ref of the
-     * external image being fetched. This function should return the result of `upload`
-     * from the content capability.
-     */
-    resolveImageRef: () => Promise<{
-      ref: ImageRef;
-    }>;
-    /**
-     * The URL of the preview image.
-     *
-     * @remarks
-     * The preview image is the image that users see under their cursor while dragging
-     * it into their design.
-     */
-    previewSrc: string;
-    /**
-     * The dimensions of the full-size image.
-     *
-     * @remarks
-     * The full-size image is the image that Canva uploads to the user's account and
-     * adds to their design.
-     *
-     * If omitted, the value of the `previewSize` property is used as a fallback.
-     */
-    fullSize?: Dimensions;
-  };
-
-/**
- * @deprecated
- * @public
- * Options for defining the drag-and-drop behavior of an image element that can be defined by an
- * app developer.
- */
-export declare type UserSuppliedImageDragData =
-  | UserSuppliedDataUrlImageDragData
-  | UserSuppliedExternalImageDragData;
-
-/**
- * @deprecated
- * @public
- * Options for defining the drag-and-drop behavior of a text element.
- */
-export declare type UserSuppliedTextDragData = TextDragConfig;
-
-/**
- * @deprecated
- * @public
- * Options for defining the drag-and-drop behavior for videos.
- */
-export declare type UserSuppliedVideoDragData = {
-  /**
-   * The type of element.
-   */
-  type: "VIDEO";
-  /**
-   * The function used resolve the video ref.
-   * This is used in conjunction with content import.
-   */
-  resolveVideoRef: () => Promise<{
-    ref: VideoRef;
-  }>;
-  /**
-   * The dimensions of the preview image.
-   * @remarks
-   * The preview image is the image that users see under their cursor
-   * while dragging it into their design.
-   */
-  previewSize: Dimensions;
-  /**
-   * The dimensions of the full-size video.
-   * These dimensions are used when adding the video to the design
-   *
-   * If omitted, the value of the `previewSize` property is
-   * used as a fallback.
-   */
-  fullSize?: Dimensions;
-  /**
-   * The URL of the preview image.
-   *
-   * @remarks
-   * The preview image is the image that users see under their cursor while dragging
-   * it into their design.
-   */
-  previewSrc: string;
-};
-
-/**
- * @public
- * The types of values that can be stored within an app element's data.
- */
-export declare type Value =
-  | Primitive
-  | ObjectPrimitive
-  | Exclude<Value, undefined>[]
-  | {
-      [key: string]: Value;
-    };
-
-/**
- * @public
- * Options for defining the drag-and-drop behavior for videos.
- */
-export declare type VideoDragConfig = {
-  /**
-   * The type of element.
-   */
-  type: "VIDEO";
-  /**
-   * The function used resolve the video ref.
-   * This is used in conjunction with content import.
-   */
-  resolveVideoRef: () => Promise<{
-    ref: VideoRef;
-  }>;
-  /**
-   * The dimensions of the preview image.
-   * @remarks
-   * The preview image is the image that users see under their cursor
-   * while dragging it into their design.
-   */
-  previewSize: Dimensions;
-  /**
-   * The dimensions of the full-size video.
-   * These dimensions are used when adding the video to the design
-   *
-   * If omitted, the value of the `previewSize` property is
-   * used as a fallback.
-   */
-  fullSize?: Dimensions;
-  /**
-   * The URL of the preview image.
-   *
-   * @remarks
-   * The preview image is the image that users see under their cursor while dragging
-   * it into their design.
-   */
-  previewUrl: string;
-};
-
-/**
- * @public
- * Options for defining the drag-and-drop behavior for videos.
- */
-export declare type VideoDragConfigForElement<E extends Element> =
-  E extends HTMLImageElement
-    ? Partial<VideoDragConfig> &
-        Pick<VideoDragConfig, "type" | "resolveVideoRef">
-    : VideoDragConfig;
-
-/**
- * @public
- * A video asset that will be used to fill the given path.
- */
-export declare type VideoFill = {
-  /**
-   * Type of an asset that will be used to fill the given path.
-   */
-  type: "VIDEO";
-  /**
-   * A unique identifier that references a video asset in Canva's backend.
-   */
-  ref: VideoRef;
-};
-
-/**
- * @public
- * A unique identifier that references a video asset in Canva's backend.
- */
-export declare type VideoRef = string & {
-  __videoRef: never;
-};
-
-declare type Width = {
-  width: number;
-  height: "auto";
-};
-
-declare type WidthAndHeight = {
-  /**
-   * The width of the box. If height is a number, this can be set to "auto".
-   * Otherwise, it must be an integer between 0 and 32767.
-   */
-  width: number;
-  /**
-   * The height of the box. If width is a number, this can be set to "auto".
-   * Otherwise, it must be an integer between 0 and 32767.
-   */
-  height: number;
-};
-
-export {};