@canva/design 2.2.1 → 2.3.0-beta.1

package/{index.d.ts → beta.d.ts}

@@ -10,7 +10,7 @@ export declare const addAudioTrack: (audioTrack: AudioTrack) => Promise<void>;
  * Add element to responsive documents, which slot things into a text stream
  */
 export declare const addElementAtCursor: (
-  element: ElementAtCursor
+  element: ElementAtCursor,
 ) => Promise<void>;
 
 /**
@@ -18,7 +18,7 @@ export declare const addElementAtCursor: (
  * Add element to fixed designs, which use a coordinate-based positioning system.
  */
 export declare const addElementAtPoint: (
-  element: DesignElement | ElementAtPoint
+  element: DesignElement | ElementAtPoint,
 ) => Promise<void>;
 
 /**
@@ -28,7 +28,7 @@ export declare const addElementAtPoint: (
  * @param element - The element to add to the user's design.
  */
 export declare const addNativeElement: (
-  element: NativeElement | NativeElementWithBox
+  element: NativeElement | NativeElementWithBox,
 ) => Promise<void>;
 
 /**
@@ -87,8 +87,13 @@ export declare type AppElementChangeHandler<A extends AppElementData> = (
          * The version number of the app.
          */
         version: number;
+        /**
+         * @beta
+         * Function to update the app element data.
+         */
+        update: (opts: AppElementOptions<A>) => Promise<void>;
       }
-    | undefined
+    | undefined,
 ) => void;
 
 /**
@@ -103,6 +108,12 @@ export declare interface AppElementClient<A extends AppElementData> {
    * @param placement - The position, dimensions, and rotation of the app element.
    */
   addOrUpdateElement(appElementData: A, placement?: Placement): Promise<void>;
+  /**
+   * @beta
+   * Adds a new app element to the design.
+   * @param opts - The data and placement of the app element.
+   */
+  addElement(opts: AppElementOptions<A>): Promise<void>;
   /**
    * A callback that runs when:
    *
@@ -132,13 +143,29 @@ export declare type AppElementClientConfiguration<A extends AppElementData> = {
  */
 export declare type AppElementData = Record<string, Value>;
 
+/**
+ * @beta
+ * Used to add or update an app element to the design.
+ * The update function is provided in the AppElementChangeHandler callback (registerOnElementChange).
+ */
+export declare type AppElementOptions<A extends AppElementData> = {
+  /**
+   * The data to attach to the app element.
+   */
+  data: A;
+  /**
+   * The position, dimensions, and rotation of the app element.
+   */
+  placement?: Placement;
+};
+
 /**
  * @public
  * A callback function that renders an app element based on the data it receives.
  * @param appElementData - The data the callback must use to render the app element.
  */
 export declare type AppElementRenderer<A extends AppElementData> = (
-  appElementData: A
+  appElementData: A,
 ) => AppElementRendererOutput;
 
 /**
@@ -328,6 +355,14 @@ export declare interface ContentDraft<T> {
  */
 export declare type ContentType = "richtext";
 
+/**
+ * @public
+ * Options for configuring where content in a design should be queried from.
+ */
+declare type ContextOptions = {
+  target: "current_page";
+};
+
 /**
  * @public
  * A set of X and Y coordinates.
@@ -349,6 +384,730 @@ export declare type Coordinates = {
  */
 export declare const createRichtextRange: () => RichtextRange;
 
+/**
+ * @beta
+ * Describes a part of a design.
+ */
+export declare type DesignContext = DesignContextOptions["type"];
+
+/**
+ * @beta
+ * Options for configuring which part of a design to read.
+ */
+declare type DesignContextOptions = {
+  /**
+   * The type of context.
+   */
+  type: "current_page";
+};
+
+/**
+ * @beta
+ * Provides methods for reading and updating the structure and content of a design.
+ */
+export declare namespace DesignEditing {
+  /**
+   * @beta
+   * A snapshot containing a fragment of a design's structure and content.
+   */
+  export type DesignDraft<D> = Readonly<D> & {
+    /**
+     * Saves any changes made to the draft.
+     *
+     * @remarks
+     * - Any changes to the draft are only reflected in the design after this method is called.
+     * - Once this method is called, further changes to the draft are not possible.
+     */
+    save(): Promise<void>;
+  };
+  /**
+   * @beta
+   * Options for creating an image fill in the element builder
+   */
+  export type ImageFillOpts = Partial<ImageFill> &
+    Required<Pick<ImageFill, "type" | "imageRef">>;
+  /**
+   * @beta
+   * Options for creating a video fill in the element builder
+   */
+  export type VideoFillOpts = Partial<VideoFill> &
+    Required<Pick<VideoFill, "type" | "videoRef">>;
+  /**
+   * @beta
+   * Options for creating a media fill in the element builder
+   */
+  export type MediaFillOpts = ImageFillOpts | VideoFillOpts;
+  /**
+   * @beta
+   * Options for creating a fill in the element builder
+   */
+  export type FillOpts =
+    | {
+        color: ColorFillOpts;
+        media?: MediaFillOpts;
+      }
+    | {
+        color?: ColorFillOpts;
+        media: MediaFillOpts;
+      };
+  /**
+   * @beta
+   */
+  export type ColorFillOpts = Exclude<ColorFill, Unsupported>;
+  /**
+   * @beta
+   * Options for creating a stroke in the element builder
+   */
+  export type StrokeOpts = Pick<Stroke, "weight"> & {
+    color: ColorFillOpts;
+  };
+  /**
+   * @beta
+   * Options for creating a shape path in the element builder
+   */
+  export type PathOpts = Pick<Path, "d"> & {
+    fill?: FillOpts;
+    stroke?: StrokeOpts;
+  };
+  /**
+   * @beta
+   * Options for creating a rect element.
+   */
+  export type CreateRectElementOpts = Required<
+    Pick<RectElement, "top" | "left" | "width" | "height">
+  > & {
+    fill?: FillOpts;
+  } & {
+    stroke?: StrokeOpts;
+  } & Partial<Omit<RectElement, "fill" | "stroke" | "type">>;
+  /**
+   * @beta
+   * Options for creating a shape element.
+   */
+  export type CreateShapeElementOpts = Required<
+    Pick<ShapeElement, "top" | "left" | "width" | "height" | "viewBox">
+  > & {
+    paths: PathOpts[];
+  } & Partial<Omit<ShapeElement, "type" | "paths">>;
+  /**
+   * @beta
+   * Options for creating an embed element.
+   */
+  export type CreateEmbedElementOpts = Required<
+    Pick<EmbedElement, "top" | "left" | "width" | "height" | "url">
+  > &
+    Partial<Omit<EmbedElement, "type">>;
+  /**
+   * @beta
+   * Options for creating a text element.
+   */
+  export type CreateTextElementOpts = Required<
+    Pick<TextElement, "top" | "left" | "width" | "text">
+  > &
+    Partial<Omit<TextElement, "type" | "height">>;
+  /**
+   * @beta
+   * Provides methods for creating elements.
+   *
+   * @remarks
+   * These methods don't add the elements to the design. They only return elements that can
+   * be added to a design, such as with the `insertAfter` method.
+   */
+  export interface ElementBuilder {
+    /**
+     * Creates a rect element.
+     * @param opts - Options for creating the rect element.
+     */
+    createRectElement(opts: CreateRectElementOpts): RectElement;
+    /**
+     * Creates a shape element.
+     * @param opts - Options for creating the shape element.
+     */
+    createShapeElement(opts: CreateShapeElementOpts): ShapeElement;
+    /**
+     * Creates an embed element.
+     * @param opts - Options for creating the embed element.
+     */
+    createEmbedElement(opts: CreateEmbedElementOpts): EmbedElement;
+    /**
+     * Creates a text element.
+     * @param opts - Options for creating the text element.
+     */
+    createTextElement(opts: CreateTextElementOpts): TextElement;
+    /**
+     * Creates a richtext range.
+     */
+    createRichtextRange(): RichtextRange;
+    /**
+     * Creates a clone of an element.
+     * @returns a new element with the same properties as the argument.
+     */
+    cloneElement(element: RectElement): RectElement;
+    cloneElement(element: ShapeElement): ShapeElement;
+    cloneElement(element: EmbedElement): EmbedElement;
+    cloneElement(element: TextElement): TextElement;
+    cloneElement(
+      element: RectElement | ShapeElement | EmbedElement | TextElement,
+    ): RectElement | ShapeElement | EmbedElement | TextElement;
+  }
+  /**
+   * @beta
+   * The result of reading part of a design when the context is the current page.
+   */
+  export type CurrentPageResult = DesignDraft<{
+    /**
+     * The current page of the design.
+     */
+    page: FixedPage;
+  }>;
+  /**
+   * @beta
+   * The result of reading part of a design.
+   */
+  export type DesignOpenResult = CurrentPageResult;
+  /**
+   * A function called for each item in the list.
+   *
+   * @param item - The current item in the list.
+   * @param index - The index of the current item.
+   */
+  export type ForEachCallback<T> = (item: T, index: number) => void;
+  /**
+   * A function that determines if an item should be included in the result.
+   *
+   * @param item - The item to test.
+   * @returns `true` if the item should be included, otherwise `false`.
+   */
+  export type FilterPredicate<T> = (item: T) => boolean;
+  /**
+   * A type predicate function that determines if an item is of a specific type.
+   *
+   * @param item - The item to test.
+   * @returns `true` if the item is of type `C`, otherwise `false`.
+   */
+  export type TypeFilterPredicate<T, C extends T> = (item: T) => item is C;
+  /**
+   * A list that cannot be changed.
+   */
+  export interface ReadableList<T> {
+    /**
+     * Gets the number of items in the list.
+     *
+     * @returns The number of items.
+     */
+    count(): number;
+    /**
+     * Converts the list to an array.
+     *
+     * @returns An array containing all items. The items are the same as in the list.
+     */
+    toArray(): readonly T[];
+    /**
+     * Executes a function for each item in the list.
+     *
+     * @param callback - The function to run for each item.
+     */
+    forEach(callback: ForEachCallback<T>): void;
+    /**
+     * Creates a new array with items that match a specific type.
+     *
+     * @param filter - A function that checks if an item is of type `C`.
+     * @returns An array of items that are of type `C`.
+     */
+    filter<C extends T>(filter: TypeFilterPredicate<T, C>): readonly C[];
+    /**
+     * Creates a new array with items that pass a test.
+     *
+     * @param filter - A function that tests each item. Returns `true` to keep the item.
+     * @returns An array of items that passed the test.
+     */
+    filter(filter: FilterPredicate<T>): readonly T[];
+  }
+  /**
+   * @beta
+   * A list of items that can be changed.
+   */
+  export interface MutableList<T> {
+    /**
+     * Adds a copy of an item to the list and places it right before another item.
+     *
+     * @param ref - The existing item to place the new item before.
+     * If `ref` is `undefined`, the new item is added at the end of the list.
+     * If `ref` does not exist in the list, the operation fails.
+     *
+     * @param item - The item to add. A copy of this item will be inserted.
+     *
+     * @returns
+     * The added item, or `undefined` if the operation failed.
+     */
+    insertBefore(ref: T | undefined, item: T): T | undefined;
+    /**
+     * Adds a copy of an item to the list and places it right after another item.
+     *
+     * @param ref - The existing item to place the new item after.
+     * If `ref` is `undefined`, the new item is added at the end of the list.
+     * If `ref` does not exist in the list, the operation fails.
+     *
+     * @param item - The item to add. A copy of this item will be inserted.
+     *
+     * @returns
+     * The added item, or `undefined` if the operation failed.
+     */
+    insertAfter(ref: T | undefined, item: T): T | undefined;
+    /**
+     * Moves an existing item to a new position right before another item.
+     *
+     * @param ref - The existing item to move the item before.
+     * If `ref` is `undefined`, the item is moved to the end of the list.
+     * If `ref` does not exist in the list, the operation fails.
+     *
+     * @param item - The item to move.
+     * The operation fails if the item is not already in the list.
+     */
+    moveBefore(ref: T | undefined, item: T): void;
+    /**
+     * Moves an existing item to a new position right after another item.
+     *
+     * @param ref - The existing item to move the item after.
+     * If `ref` is `undefined`, the item is moved to the end of the list.
+     * If `ref` does not exist in the list, the operation fails.
+     *
+     * @param item - The item to move.
+     * The operation fails if the item is not already in the list.
+     */
+    moveAfter(ref: T | undefined, item: T): void;
+    /**
+     * Removes an item from the list.
+     *
+     * @param item - The item to remove from the list.
+     */
+    delete(item: T): void;
+  }
+  /**
+   * @beta
+   * A list of items that can be read and updated.
+   */
+  export interface List<T> extends ReadableList<T>, MutableList<T> {}
+  /**
+   * @beta
+   * Represents an element that's not supported by the Apps SDK.
+   */
+  export interface Unsupported {
+    /**
+     * The type of element.
+     */
+    readonly type: "unsupported";
+  }
+  /**
+   * @beta
+   * A single valid character in a hex code.
+   */
+  export type Hex = `123456790abcdef`[number];
+  /**
+   * @beta
+   * A six-character hexadecimal color code prefixed with a `#`.
+   */
+  export type HexCode = `#${Hex}${Hex}${Hex}${Hex}${Hex}${Hex}`;
+  /**
+   * @beta
+   * A set of dimensions.
+   */
+  export interface Dimensions {
+    /**
+     * A width, in pixels.
+     */
+    readonly width: number;
+    /**
+     * A height, in pixels.
+     */
+    readonly height: number;
+  }
+  /**
+   * @beta
+   * An image that fills the interior of a path.
+   */
+  export interface ImageFill {
+    /**
+     * The type of media.
+     */
+    readonly type: "image";
+    /**
+     * A unique identifier that points to an image asset in Canva's backend.
+     */
+    imageRef: ImageRef;
+    /**
+     * If `true`, the image is flipped horizontally.
+     */
+    flipX: boolean;
+    /**
+     * If `true`, the image is flipped vertically.
+     */
+    flipY: boolean;
+  }
+  /**
+   * @beta
+   * A video that fills the interior of a path.
+   */
+  export interface VideoFill {
+    /**
+     * The type of media.
+     */
+    readonly type: "video";
+    /**
+     * A unique identifier that points to a video asset in Canva's backend.
+     */
+    videoRef: VideoRef;
+    /**
+     * If `true`, the video is flipped horizontally.
+     */
+    flipX: boolean;
+    /**
+     * If `true`, the video is flipped vertically.
+     */
+    flipY: boolean;
+  }
+  /**
+   * @beta
+   * A media item that fills the interior of a path.
+   */
+  export type MediaFill = ImageFill | VideoFill;
+  /**
+   * @beta
+   * A solid color that fills the interior of a path.
+   */
+  export interface SolidFill {
+    /**
+     * The type of color.
+     */
+    readonly type: "solid";
+    /**
+     * The color of the fill, as a hex code.
+     *
+     * @remarks
+     * - Must be six characters long.
+     * - Must start with a `#`.
+     * - Must use lowercase letters.
+     */
+    color: HexCode;
+  }
+  /**
+   * @beta
+   * A color that fills the interior of a path.
+   */
+  export type ColorFill = SolidFill | Unsupported;
+  /**
+   * @beta
+   * Describes how a path is filled with color or media.
+   *
+   * @remarks
+   * If both `media` and `color` are defined, `media` takes precedence.
+   */
+  export interface Fill {
+    /**
+     * The media fill for the path, if any.
+     */
+    media: MediaFill | undefined;
+    /**
+     * The color fill for the path, if any.
+     */
+    color: ColorFill | undefined;
+  }
+  /**
+   * @beta
+   * The scale and cropping of a shape.
+   *
+   * @remarks
+   * This is similar to the `viewBox` attribute of an `SVGElement`.
+   */
+  export type AlignedBox = {
+    /**
+     * The distance of the shape from the top edge of the element, in pixels.
+     */
+    readonly top: number;
+    /**
+     * The distance of the shape from the left edge of the element, in pixels.
+     */
+    readonly left: number;
+    /**
+     * The width of the view box, in pixels.
+     */
+    readonly width: number;
+    /**
+     * The height of the view box, in pixels.
+     */
+    readonly height: number;
+  };
+  /**
+   * @beta
+   * A path that defines the structure of a shape element.
+   */
+  export interface Path {
+    /**
+     * The shape of the path.
+     *
+     * @remarks
+     * This is similar to the `d` attribute of an SVG's `path` element, with some limitations:
+     *
+     * - Must start with an `M` command.
+     * - Only one `M` command is allowed.
+     * - `Q` and `T` commands are not permitted.
+     * - The path must be closed using a `Z` command or matching start and end coordinates.
+     */
+    readonly d: string;
+    /**
+     * The appearance of the path's interior.
+     */
+    readonly fill: Fill;
+    /**
+     * The stroke (outline) of the path, if any.
+     */
+    readonly stroke: Stroke | undefined;
+  }
+  /**
+   * @beta
+   * Represents an outline, such as the border of an element.
+   */
+  export interface Stroke {
+    /**
+     * The weight (thickness) of the stroke.
+     *
+     * @remarks
+     * - Minimum: 0
+     * - Maximum: 100
+     */
+    weight: number;
+    /**
+     * The color of the stroke.
+     */
+    color: ColorFill;
+  }
+  /**
+   * @beta
+   * The basic properties of an element.
+   *
+   * @remarks
+   * These properties are shared by all elements in a design.
+   */
+  export interface Element extends Dimensions {
+    /**
+     * If `true`, the element is locked and cannot be modified.
+     */
+    readonly locked: boolean;
+    /**
+     * The distance from the top edge of the container, in pixels.
+     *
+     * @remarks
+     * - The pixels are relative to their container.
+     * - Minimum: -32768
+     * - Maximum: 32767
+     */
+    top: number;
+    /**
+     * The distance from the left edge of the container, in pixels.
+     *
+     * @remarks
+     * - The pixels are relative to their container.
+     * - Minimum: -32768
+     * - Maximum: 32767
+     */
+    left: number;
+    /**
+     * A rotation, in degrees.
+     *
+     * @remarks
+     * - Minimum: -180
+     * - Maximum: 180
+     */
+    rotation: number;
+    /**
+     * Transparency as a percentage.
+     *
+     * @remarks
+     * - Minimum: 0
+     * - Maximum: 1
+     */
+    transparency: number;
+  }
+  /**
+   * @beta
+   * Represents a rectangular element.
+   */
+  export interface Rect {
+    /**
+     * The type of content.
+     */
+    readonly type: "rect";
+    /**
+     * The appearance of the rectangle's interior.
+     */
+    readonly fill: Fill;
+    /**
+     * The outline of the rectangle.
+     */
+    readonly stroke: Stroke;
+  }
+  /**
+   * @beta
+   * Represents a vector shape element.
+   */
+  export interface Shape {
+    /**
+     * The type of content.
+     */
+    readonly type: "shape";
+    /**
+     * The scale and cropping of the shape.
+     */
+    viewBox: AlignedBox;
+    /**
+     * The paths that define the structure of the shape.
+     *
+     * @remarks
+     * - Must have between 1 and 30 paths.
+     * - Total size of all paths must not exceed 2kb.
+     * - Maximum of 6 unique fill colors across all paths.
+     */
+    readonly paths: ReadableList<Path>;
+  }
+  /**
+   * @beta
+   * Represents group content.
+   */
+  export interface Group<C> {
+    /**
+     * The type of content.
+     */
+    readonly type: "group";
+    /**
+     * The elements that exist within the group.
+     */
+    readonly contents: ReadableList<C>;
+  }
+  /**
+   * @beta
+   * Represents rich media content.
+   */
+  export interface Embed {
+    /**
+     * The type of content.
+     */
+    readonly type: "embed";
+    /**
+     * The URL of the rich media.
+     *
+     * @remarks
+     * This URL must be supported by the Iframely API.
+     */
+    readonly url: string;
+  }
+  /**
+   * @beta
+   * Represents text content.
+   */
+  export interface Text {
+    /**
+     * The type of content.
+     */
+    readonly type: "text";
+    /**
+     * The text content.
+     */
+    readonly text: RichtextRange;
+  }
+  /**
+   * @beta
+   * An element that renders a rectangle.
+   *
+   * @remarks
+   * The rectangle can be filled with image content, video content, or a solid color.
+   */
+  export interface RectElement extends Rect, Element {}
+  /**
+   * @beta
+   * An element that renders a vector shape.
+   */
+  export interface ShapeElement extends Shape, Element {}
+  /**
+   * @beta
+   * An element that renders a group of other elements.
+   */
+  export interface GroupElement extends Group<GroupContentElement>, Element {}
+  /**
+   * @beta
+   * An element that embeds rich media, such as a YouTube video.
+   */
+  export interface EmbedElement extends Embed, Element {}
+  /**
+   * @beta
+   * An element that renders text content.
+   */
+  export interface TextElement extends Text, Element {}
+  /**
+   * @beta
+   * An element that is not supported by the Apps SDK.
+   */
+  export interface UnsupportedElement extends Unsupported, Element {}
+  /**
+   * @beta
+   * An element that can exist in a group element.
+   */
+  export type GroupContentElement =
+    | RectElement
+    | ShapeElement
+    | EmbedElement
+    | TextElement
+    | UnsupportedElement;
+  /**
+   * @beta
+   * An element that can exist on a fixed page.
+   */
+  export type FixedElement =
+    | RectElement
+    | ShapeElement
+    | GroupElement
+    | EmbedElement
+    | TextElement
+    | UnsupportedElement;
+  /**
+   * @beta
+   * A page with fixed dimensions.
+   */
+  export interface FixedPage {
+    /**
+     * The type of page.
+     */
+    readonly type: "fixed";
+    /**
+     * If `true`, the page is locked and cannot be modified.
+     */
+    readonly locked: boolean;
+    /**
+     * The dimensions of the page. `dimensions` is undefined for whiteboard pages.
+     */
+    readonly dimensions: Dimensions | undefined;
+    /**
+     * The background of the page. `background` is undefined for whiteboard pages.
+     */
+    readonly background: Fill | undefined;
+    /**
+     * The elements on the page.
+     *
+     * @remarks
+     * Elements are rendered in the order they appear in the list.
+     * Later elements appear on top of earlier ones.
+     */
+    readonly elements: List<FixedElement>;
+  }
+  /**
+   * @beta
+   * A page in a design.
+   */
+  export type Page = FixedPage | Unsupported;
+
+  {
+  }
+}
+
 /**
  * @public
  * An element that's natively supported by the Canva editor.
@@ -363,6 +1122,28 @@ export declare type DesignElement =
   | RichtextElement
   | TableElement;
 
+/**
+ * @beta
+ * A callback for reading and updating part of a design.
+ * @param draft - The result of reading part of a design.
+ * @param helpers - Helper methods for reading and updating the design.
+ */
+export declare type DesignOpenCallback = (
+  draft: DesignEditing.DesignOpenResult,
+  helpers: {
+    /**
+     * Provides methods for creating elements.
+     */
+    elementBuilder: DesignEditing.ElementBuilder;
+  },
+) => Promise<void> | void;
+
+/**
+ * @beta
+ * Options for configuring which part of a design to read.
+ */
+export declare type DesignOpenOptions = DesignContextOptions;
+
 /**
  * @public
  * Provides methods for managing the lifecycle of overlays, such as selected image overlays.
@@ -440,37 +1221,55 @@ export declare type Dimensions = {
 
 /**
  * @public
- * Callbacks for handling drag and drop events.
+ * An event that occurs when a user starts dragging an HTML element.
  */
-export declare type DragCallback = {
-  /**
-   * A callback that runs at the start of a drag event.
-   * @param element - The element being dragged.
-   */
-  onDragStart: (element: HTMLElement) => void;
-  /**
-   * A callback that runs at the end of a drag event.
-   * @param element - The element being dragged.
-   */
-  onDragEnd: (element: HTMLElement) => void;
+export declare type DragStartEvent<E extends Element> = Pick<
+  DragEvent,
+  "dataTransfer" | "currentTarget" | "preventDefault" | "clientX" | "clientY"
+> & {
+  currentTarget: E;
 };
 
 /**
  * @public
- * Options for adding drag and drop behavior to an `HTMLElement`.
+ * Reads and edits content of the specified type from the user's design.
+ * @param options - Options for configuring how a design is read.
+ * @param callback - A callback for operating on the read content.
  */
-export declare type DraggableElementData = ElementData | ImageElementData;
+export declare const editContent: (
+  options: EditContentOptions,
+  callback: EditContentCallback,
+) => Promise<void>;
 
 /**
  * @public
- * An event that occurs when a user starts dragging an HTML element.
+ * A callback for reading and updating the requested design content.
+ * @param session - The result of reading the content in the design.
  */
-export declare type DragStartEvent<E extends Element> = Pick<
-  DragEvent,
-  "dataTransfer" | "currentTarget" | "preventDefault" | "clientX" | "clientY"
-> & {
-  currentTarget: E;
-};
+export declare type EditContentCallback = (session: {
+  /**
+   * The individual content items returned by a query.
+   */
+  readonly contents: readonly RichtextContentRange[];
+  /**
+   * Commits any changes made to the items in the `contents` array.
+   *
+   * @remarks
+   * An app must call this method for any changes to be reflected in the user's design.
+   */
+  sync(): Promise<void>;
+}) => Promise<void> | void;
+
+/**
+ * @public
+ * Options for configuring how the design content is read.
+ */
+export declare type EditContentOptions = {
+  /**
+   * The type of content to edit from the user's design
+   */
+  contentType: ContentType;
+} & ContextOptions;
 
 /**
  * @public
@@ -497,17 +1296,6 @@ export declare type ElementAtPoint =
   | GroupElementAtPoint
   | RichtextElementAtPoint;
 
-/**
- * @public
- * Options for adding drag and drop behavior to an `HTMLElement`.
- */
-export declare type ElementData = DragCallback & {
-  /**
-   * The `HTMLElement` to be made draggable.
-   */
-  node: HTMLElement;
-};
-
 /**
  * @public
  * Embed element to be added to the design at the end of a drag event.
@@ -843,6 +1631,9 @@ export declare type ImageElement = {
   type: "image";
   /**
    * A description of the image content.
+   *
+   * @remarks
+   * Use `undefined` for content with no description.
    */
   altText: AltText | undefined;
 } & (
@@ -876,17 +1667,6 @@ export declare type ImageElementAtPoint = ImageElement &
   Point &
   (WidthAndHeight | Width | Height);
 
-/**
- * @public
- * Options for adding drag and drop behavior to an `HTMLImageElement`.
- */
-export declare type ImageElementData = DragCallback & {
-  /**
-   * The `HTMLImageElement` to be made draggable.
-   */
-  node: HTMLImageElement;
-};
-
 /**
  * @public
  * An image asset that fills a path's interior.
@@ -900,6 +1680,13 @@ export declare type ImageFill = {
    * A unique identifier that points to an image asset in Canva's backend.
    */
   ref: ImageRef;
+  /**
+   * A description of the image content.
+   *
+   * @remarks
+   * Use `undefined` for content with no description.
+   */
+  altText?: AltText;
 };
 
 /**
@@ -911,11 +1698,11 @@ export declare type ImageRef = string & {
 };
 
 /**
- * @public
+ * @beta
  * @param appElementConfig - Configuration for an AppElementClient
  */
 export declare const initAppElement: <A extends AppElementData>(
-  appElementConfig: AppElementClientConfiguration<A>
+  appElementConfig: AppElementClientConfiguration<A>,
 ) => AppElementClient<A>;
 
 /**
@@ -1097,6 +1884,23 @@ export declare type NativeVideoElementWithBox = VideoElementAtPoint;
  */
 declare type ObjectPrimitive = Boolean | String;
 
+/**
+ * @beta
+ * Reads a specified part of the user's design and returns all elements in that part.
+ *
+ * @param options - Options for configuring how the design is read.
+ * @param callback - A callback for operating on the design.
+ */
+export declare const openDesign: (
+  options: DesignOpenOptions,
+  callback: (
+    draft: DesignEditing.DesignOpenResult,
+    helpers: {
+      elementBuilder: DesignEditing.ElementBuilder;
+    },
+  ) => Promise<void> | void,
+) => Promise<void>;
+
 /**
  * @public
  * An alias for the DesignOverlay interface, providing access to design overlay related functionality
@@ -1271,9 +2075,20 @@ declare type Primitive = undefined | null | number | boolean | string;
  * @param request - The request object containing configurations of the design export.
  */
 export declare const requestExport: (
-  request: ExportRequest
+  request: ExportRequest,
 ) => Promise<ExportResponse>;
 
+/**
+ * @public
+ * Provides methods for interacting with a range of formatted text.
+ */
+export declare interface RichtextContentRange extends RichtextRange {
+  /**
+   * Indicates whether the object containing this richtext range has been deleted.
+   */
+  readonly deleted: boolean;
+}
+
 /**
  * @public
  * An element that renders richtext content.
@@ -1381,7 +2196,7 @@ export declare type RichtextRange = {
    */
   appendText(
     characters: string,
-    formatting?: InlineFormatting
+    formatting?: InlineFormatting,
   ): {
     bounds: Bounds;
   };
@@ -1395,7 +2210,7 @@ export declare type RichtextRange = {
   replaceText(
     bounds: Bounds,
     characters: string,
-    formatting?: InlineFormatting
+    formatting?: InlineFormatting,
   ): {
     /**
      * The bounds of the replacement characters within the updated range.
@@ -1533,7 +2348,7 @@ export declare type SelectionValue<Scope extends SelectionScope> = {
  * an image or a video.
  */
 export declare const setCurrentPageBackground: (
-  opts: PageBackgroundFill
+  opts: PageBackgroundFill,
 ) => Promise<void>;
 
 /**
@@ -1746,6 +2561,11 @@ export declare type TextDragConfig = {
    * @defaultValue "none"
    */
   decoration?: "none" | "underline";
+  /**
+   * @beta
+   * A unique identifier that points to a font asset in Canva's backend.
+   */
+  fontRef?: FontRef;
 };
 
 /**
@@ -1770,7 +2590,7 @@ export declare type TextElement = {
  * @public
  * An element that renders text content and has positional properties.
  */
-export declare type TextElementAtPoint = TextElement & TextAttributes & TextBox;
+export declare type TextElementAtPoint = TextElement & TextBox;
 
 /**
  * @public
@@ -1807,7 +2627,7 @@ export declare interface UI {
       | AudioDragConfig
       | EmbedDragConfig
       | VideoDragConfigForElement<E>
-      | ImageDragConfigForElement<E>
+      | ImageDragConfigForElement<E>,
   ): Promise<void>;
   /**
    * @public
@@ -1823,7 +2643,7 @@ export declare interface UI {
       | AudioDragConfig
       | EmbedDragConfig
       | VideoDragConfigForElement<E>
-      | ImageDragConfigForElement<E>
+      | ImageDragConfigForElement<E>,
   ): Promise<void>;
   /**
    * @public
@@ -1837,7 +2657,7 @@ export declare interface UI {
     dragData:
       | EmbedDragConfig
       | VideoDragConfigForElement<E>
-      | ImageDragConfigForElement<E>
+      | ImageDragConfigForElement<E>,
   ): Promise<void>;
 }
 
@@ -1917,6 +2737,9 @@ export declare type VideoElement = {
   ref: VideoRef;
   /**
    * A description of the video content.
+   *
+   * @remarks
+   * Use `undefined` for content with no description.
    */
   altText: AltText | undefined;
 };
@@ -1942,6 +2765,13 @@ export declare type VideoFill = {
    * A unique identifier that points to a video asset in Canva's backend.
    */
   ref: VideoRef;
+  /**
+   * A description of the image content.
+   *
+   * @remarks
+   * Use `undefined` for content with no description.
+   */
+  altText?: AltText;
 };
 
 /**