@canva/design 2.2.0-beta.1 → 2.2.1-beta.1

package/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 | TableElement
+  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 | TableElement | RichtextElement
+  element: DesignElement | ElementAtPoint
 ) => Promise<void>;
 
 /**
@@ -145,7 +145,7 @@ export declare type AppElementRenderer<A extends AppElementData> = (
  * @public
  * An array of one or more elements to render as output of an app element.
  */
-export declare type AppElementRendererOutput = NativeSimpleElementWithBox[];
+export declare type AppElementRendererOutput = GroupContentAtPoint[];
 
 /**
  * @public
@@ -225,7 +225,7 @@ export declare type Bounds = {
  * @remarks
  * The position and dimensions are relative to the container.
  */
-export declare type Box = Position & (WidthAndHeight | Width | Height);
+export declare type Box = Point & (WidthAndHeight | Width | Height);
 
 /**
  * @public
@@ -355,7 +355,7 @@ export declare type Coordinates = {
  * @public
  * Creates a new RichtextRange object, which contains methods to manipulate text.
  */
-export declare function createRichtextRange(): RichtextRange;
+export declare const createRichtextRange: () => RichtextRange;
 
 /**
  * @beta
@@ -695,7 +695,7 @@ export declare namespace DesignEditing {
     /**
      * A unique identifier that points to an image asset in Canva's backend.
      */
-    imageRef: string;
+    imageRef: ImageRef;
     /**
      * If `true`, the image is flipped horizontally.
      */
@@ -717,7 +717,7 @@ export declare namespace DesignEditing {
     /**
      * A unique identifier that points to a video asset in Canva's backend.
      */
-    videoRef: string;
+    videoRef: VideoRef;
     /**
      * If `true`, the video is flipped horizontally.
      */
@@ -1073,7 +1073,15 @@ export declare namespace DesignEditing {
  * @public
  * An element that's natively supported by the Canva editor.
  */
-export declare type DesignElement = NativeElement;
+export declare type DesignElement =
+  | ImageElement
+  | VideoElement
+  | EmbedElement
+  | TextElement
+  | ShapeElement
+  | GroupElement
+  | RichtextElement
+  | TableElement;
 
 /**
  * @beta
@@ -1223,14 +1231,20 @@ export declare type ElementAtCursor =
   | VideoElement
   | EmbedElement
   | TextElement
-  | RichtextElement;
+  | RichtextElement
+  | TableElement;
 
 /**
  * @public
  * An element that's natively supported by the Canva editor and has positional properties.
  */
 export declare type ElementAtPoint =
-  | NativeElementWithBox
+  | ImageElementAtPoint
+  | VideoElementAtPoint
+  | EmbedElementAtPoint
+  | TextElementAtPoint
+  | ShapeElementAtPoint
+  | GroupElementAtPoint
   | RichtextElementAtPoint;
 
 /**
@@ -1274,13 +1288,27 @@ export declare type EmbedDragConfig = {
  * @public
  * An element that renders rich media, such as a YouTube video.
  */
-export declare type EmbedElement = NativeEmbedElement;
+export declare type EmbedElement = {
+  /**
+   * The type of element.
+   */
+  type: "embed";
+  /**
+   * The URL of the rich media.
+   *
+   * @remarks
+   * This URL must be supported by the Iframely API.
+   */
+  url: string;
+};
 
 /**
  * @public
  * An element that renders rich media, such as a YouTube video, and has positional properties.
  */
-export declare type EmbedElementAtPoint = NativeEmbedElementWithBox;
+export declare type EmbedElementAtPoint = EmbedElement &
+  Point &
+  (WidthAndHeight | Width | Height);
 
 /**
  * @public
@@ -1482,25 +1510,43 @@ export declare const getDefaultPageDimensions: () => Promise<
  * @public
  * Retrieves a signed JWT that contains the Design ID, App ID and User ID.
  */
-export declare function getDesignToken(): Promise<DesignToken>;
+export declare const getDesignToken: () => Promise<DesignToken>;
 
 /**
  * @public
  * An element that's natively supported by the Canva editor, can exist within a group, and has positional properties.
  */
-export declare type GroupContentAtPoint = NativeSimpleElementWithBox;
+export declare type GroupContentAtPoint = Exclude<
+  ElementAtPoint,
+  GroupElementAtPoint
+>;
 
 /**
  * @public
  * An element that contains two or more elements.
  */
-export declare type GroupElement = NativeGroupElement;
+export declare type GroupElement = {
+  /**
+   * The type of element.
+   */
+  type: "group";
+  /**
+   * The elements to render within the group.
+   *
+   * @remarks
+   * - Each element within a group must have dimensions and a position.
+   * - The dimensions and positions are relative to the dimensions and positions of the group.
+   */
+  children: GroupContentAtPoint[];
+};
 
 /**
  * @public
  * An element that contains two or more elements and has positional properties.
  */
-export declare type GroupElementAtPoint = NativeGroupElementWithBox;
+export declare type GroupElementAtPoint = GroupElement &
+  Point &
+  (WidthAndHeight | Width | Height);
 
 /**
  * A set of dimensions with an auto-calculated width.
@@ -1540,13 +1586,45 @@ export declare type ImageDragConfigForElement<E extends Element> =
  * @public
  * An element that renders image content.
  */
-export declare type ImageElement = NativeImageElement;
+export declare type ImageElement = {
+  /**
+   * The type of element.
+   */
+  type: "image";
+  /**
+   * A description of the image content.
+   */
+  altText: AltText | undefined;
+} & (
+  | {
+      /**
+       * A data URL that contains the image data.
+       */
+      dataUrl: string;
+      /**
+       * A unique identifier that points to an image asset in Canva's backend.
+       */
+      ref?: never;
+    }
+  | {
+      /**
+       * A data URL that contains the image data.
+       */
+      dataUrl?: never;
+      /**
+       * A unique identifier that points to an image asset in Canva's backend.
+       */
+      ref: ImageRef;
+    }
+);
 
 /**
  * @public
  * An element that renders image content and has positional properties.
  */
-export declare type ImageElementAtPoint = NativeImageElementWithBox;
+export declare type ImageElementAtPoint = ImageElement &
+  Point &
+  (WidthAndHeight | Width | Height);
 
 /**
  * @public
@@ -1586,9 +1664,9 @@ export declare type ImageRef = string & {
  * @public
  * @param appElementConfig - Configuration for an AppElementClient
  */
-export declare function initAppElement<A extends AppElementData>(
+export declare const initAppElement: <A extends AppElementData>(
   appElementConfig: AppElementClientConfiguration<A>
-): AppElementClient<A>;
+) => AppElementClient<A>;
 
 /**
  * @public
@@ -1636,7 +1714,7 @@ export declare type InlineFormatting = {
 };
 
 /**
- * @deprecated
+ * @deprecated The type has been superseded by `DesignElement`.
  * @public
  * An element that's natively supported by the Canva editor.
  */
@@ -1678,279 +1756,91 @@ export declare type NativeElementWithBox =
  * @public
  * An element that renders rich media, such as a YouTube video.
  */
-export declare type NativeEmbedElement = {
-  /**
-   * The type of element.
-   */
-  type: "embed";
-  /**
-   * The URL of the rich media.
-   *
-   * @remarks
-   * This URL must be supported by the Iframely API.
-   */
-  url: string;
-};
+export declare type NativeEmbedElement = EmbedElement;
 
 /**
  * @deprecated The type has been superseded by `EmbedElementAtPoint`.
  * @public
  * An element that renders rich media, such as a YouTube video, and has positional properties.
  */
-export declare type NativeEmbedElementWithBox = {
-  /**
-   * The type of element.
-   */
-  type: "embed";
-  /**
-   * The URL of the rich media.
-   *
-   * @remarks
-   * This URL must be supported by the Iframely API.
-   */
-  url: string;
-} & Box;
+export declare type NativeEmbedElementWithBox = EmbedElementAtPoint;
 
 /**
  * @deprecated The type has been superseded by `GroupElement`.
  * @public
  * An element that contains two or more elements.
  */
-export declare type NativeGroupElement = {
-  /**
-   * The type of element.
-   */
-  type: "group";
-  /**
-   * The elements to render within the group.
-   *
-   * @remarks
-   * - Each element within a group must have dimensions and a position.
-   * - The dimensions and positions are relative to the dimensions and positions of the group.
-   */
-  children: NativeSimpleElementWithBox[];
-};
+export declare type NativeGroupElement = GroupElement;
 
 /**
  * @deprecated The type has been superseded by `GroupElementAtPoint`.
  * @public
  * An element that contains two or more elements and has positional properties.
  */
-export declare type NativeGroupElementWithBox = {
-  /**
-   * The type of element.
-   */
-  type: "group";
-  /**
-   * The elements to render within the group.
-   *
-   * @remarks
-   * - Each element within a group must have dimensions and a position.
-   * - The dimensions and positions are relative to the dimensions and positions of the group.
-   */
-  children: NativeSimpleElementWithBox[];
-} & Box;
+export declare type NativeGroupElementWithBox = GroupElementAtPoint;
 
 /**
  * @deprecated The type has been superseded by `ImageElement`.
  * @public
  * An element that renders image content.
  */
-export declare type NativeImageElement = {
-  /**
-   * The type of element.
-   */
-  type: "image";
-  /**
-   * A description of the image content.
-   */
-  altText: AltText | undefined;
-} & (
-  | {
-      /**
-       * A data URL that contains the image data.
-       */
-      dataUrl: string;
-      /**
-       * A unique identifier that points to an image asset in Canva's backend.
-       */
-      ref?: never;
-    }
-  | {
-      /**
-       * A data URL that contains the image data.
-       */
-      dataUrl?: never;
-      /**
-       * A unique identifier that points to an image asset in Canva's backend.
-       */
-      ref: ImageRef;
-    }
-);
+export declare type NativeImageElement = ImageElement;
 
 /**
  * @deprecated The type has been superseded by `ImageElementAtPoint`.
  * @public
  * An element that renders image content and has positional properties.
  */
-export declare type NativeImageElementWithBox = NativeImageElement & Box;
+export declare type NativeImageElementWithBox = ImageElementAtPoint;
 
 /**
  * @deprecated The type has been superseded by `ShapeElement`.
  * @public
  * An element that renders a vector shape.
  */
-export declare type NativeShapeElement = {
-  /**
-   * The type of element.
-   */
-  type: "shape";
-  /**
-   * Options for configuring the scale and cropping of the shape.
-   */
-  viewBox: ShapeViewBox;
-  /**
-   * The paths that define the structure of the shape.
-   *
-   * @remarks
-   * - There must be between 1 and 30 paths (inclusive).
-   * - The maximum combined size of all paths must not exceed 2kb.
-   * - The maximum number of unique fill colors across all paths is 6.
-   */
-  paths: ShapePath[];
-};
+export declare type NativeShapeElement = ShapeElement;
 
 /**
  * @deprecated The type has been superseded by `ShapeElementAtPoint`.
  * @public
  * An element that renders a vector shape and has positional properties.
  */
-export declare type NativeShapeElementWithBox = {
-  /**
-   * The type of element.
-   */
-  type: "shape";
-  /**
-   * Options for configuring the scale and cropping of a shape.
-   */
-  viewBox: ShapeViewBox;
-  /**
-   * The paths that define the structure of the shape.
-   *
-   * @remarks
-   * - There must be between 1 and 30 paths (inclusive).
-   * - The maximum combined size of all paths must not exceed 2kb.
-   * - The maximum number of unique fill colors across all paths is 6.
-   */
-  paths: ShapePath[];
-} & Box;
+export declare type NativeShapeElementWithBox = ShapeElementAtPoint;
 
 /**
  * @deprecated The type has been superseded by `GroupContentAtPoint`.
  * @public
  * An element that's natively supported by the Canva editor, can exist within a group, and has positional properties.
  */
-export declare type NativeSimpleElementWithBox = Exclude<
-  NativeElementWithBox,
-  NativeGroupElementWithBox
->;
+export declare type NativeSimpleElementWithBox = GroupContentAtPoint;
 
 /**
  * @deprecated The type has been superseded by `TextElement`.
  * @public
  * An element that renders text content.
  */
-export declare type NativeTextElement = {
-  /**
-   * The type of element.
-   */
-  type: "text";
-  /**
-   * The text content.
-   *
-   * @remarks
-   * Only the first element in this array is used.
-   */
-  children: string[];
-} & TextAttributes;
+export declare type NativeTextElement = TextElement;
 
 /**
  * @deprecated The type has been superseded by `TextElementAtPoint`.
  * @public
  * An element that renders text content and has positional properties.
  */
-export declare type NativeTextElementWithBox = {
-  /**
-   * The type of element.
-   */
-  type: "text";
-  /**
-   * The text content.
-   *
-   * @remarks
-   * Only the first element in this array is used.
-   */
-  children: [string];
-  /**
-   * The width of the element, in pixels.
-   *
-   * @remarks
-   * - Minimum: 0
-   * - Maximum: 32767
-   */
-  width?: number;
-  /**
-   * The distance from the top edge of the container, in pixels.
-   *
-   * @remarks
-   * - Minimum: -32768
-   * - Maximum: 32767
-   */
-  top: number;
-  /**
-   * The distance from the left edge of the container, in pixels.
-   *
-   * @remarks
-   * - Minimum: -32768
-   * - Maximum: 32767
-   */
-  left: number;
-  /**
-   * The rotation of the element, in degrees.
-   *
-   * @remarks
-   * - Minimum: -180
-   * - Maximum: 180
-   */
-  rotation?: number;
-} & TextAttributes;
+export declare type NativeTextElementWithBox = TextElementAtPoint;
 
 /**
  * @deprecated The type has been superseded by `VideoElement`.
  * @public
  * An element that renders video content.
  */
-export declare type NativeVideoElement = {
-  /**
-   * The type of element.
-   */
-  type: "video";
-  /**
-   * A unique identifier that points to a video asset in Canva's backend.
-   */
-  ref: VideoRef;
-  /**
-   * A description of the video content.
-   */
-  altText: AltText | undefined;
-};
+export declare type NativeVideoElement = VideoElement;
 
 /**
  * @deprecated The type has been superseded by `VideoElementAtPoint`.
  * @public
  * An element that renders video content and has positional properties.
  */
-export declare type NativeVideoElementWithBox = NativeVideoElement & Box;
+export declare type NativeVideoElementWithBox = VideoElementAtPoint;
 
 /**
  * An object primitive data type that can be used in app element data.
@@ -2100,13 +1990,12 @@ export declare type PathStroke = {
  * @public
  * A position, set of dimensions, and rotation.
  */
-export declare type Placement = Position & (WidthAndHeight | Width | Height);
+export declare type Placement = Point & (WidthAndHeight | Width | Height);
 
 /**
- * @deprecated
  * A position and rotation.
  */
-declare type Position = {
+declare type Point = {
   /**
    * The distance from the top edge of the container, in pixels.
    *
@@ -2471,13 +2360,33 @@ export declare const setCurrentPageBackground: (
  * @public
  * An element that renders a vector shape.
  */
-export declare type ShapeElement = NativeShapeElement;
+export declare type ShapeElement = {
+  /**
+   * The type of element.
+   */
+  type: "shape";
+  /**
+   * Options for configuring the scale and cropping of the shape.
+   */
+  viewBox: ShapeViewBox;
+  /**
+   * The paths that define the structure of the shape.
+   *
+   * @remarks
+   * - There must be between 1 and 30 paths (inclusive).
+   * - The maximum combined size of all paths must not exceed 2kb.
+   * - The maximum number of unique fill colors across all paths is 6.
+   */
+  paths: ShapePath[];
+};
 
 /**
  * @public
  * An element that renders a vector shape and has positional properties.
  */
-export declare type ShapeElementAtPoint = NativeShapeElementWithBox;
+export declare type ShapeElementAtPoint = ShapeElement &
+  Point &
+  (WidthAndHeight | Width | Height);
 
 /**
  * @public
@@ -2613,39 +2522,15 @@ export declare type TextAttributes = {
  * @public
  * The dimensions, position, and rotation of a text element.
  */
-declare type TextBox = {
+declare type TextBox = Point & {
   /**
-   * The width, in pixels.
+   * The width of the element, in pixels.
    *
    * @remarks
    * - Minimum: 0
    * - Maximum: 32767
    */
   width?: number;
-  /**
-   * The distance from the top edge of the container, in pixels.
-   *
-   * @remarks
-   * - Minimum: -32767
-   * - Maximum: 32767
-   */
-  top: number;
-  /**
-   * The distance from the left edge of the container, in pixels.
-   *
-   * @remarks
-   * - Minimum: -32767
-   * - Maximum: 32767
-   */
-  left: number;
-  /**
-   * The rotation, in degrees.
-   *
-   * @remarks
-   * - Minimum: -180
-   * - Maximum: 180
-   */
-  rotation?: number;
 };
 
 /**
@@ -2692,13 +2577,25 @@ export declare type TextDragConfig = {
  * @public
  * An element that renders text content.
  */
-export declare type TextElement = NativeTextElement;
+export declare type TextElement = {
+  /**
+   * The type of element.
+   */
+  type: "text";
+  /**
+   * The text content.
+   *
+   * @remarks
+   * Only the first element in this array is used.
+   */
+  children: string[];
+} & TextAttributes;
 
 /**
  * @public
  * An element that renders text content and has positional properties.
  */
-export declare type TextElementAtPoint = NativeTextElementWithBox;
+export declare type TextElementAtPoint = TextElement & TextAttributes & TextBox;
 
 /**
  * @public
@@ -2834,13 +2731,28 @@ export declare type VideoDragConfigForElement<E extends Element> =
  * @public
  * An element that renders video content.
  */
-export declare type VideoElement = NativeVideoElement;
+export declare type VideoElement = {
+  /**
+   * The type of element.
+   */
+  type: "video";
+  /**
+   * A unique identifier that points to a video asset in Canva's backend.
+   */
+  ref: VideoRef;
+  /**
+   * A description of the video content.
+   */
+  altText: AltText | undefined;
+};
 
 /**
  * @public
  * An element that renders video content and has positional properties.
  */
-export declare type VideoElementAtPoint = NativeVideoElementWithBox;
+export declare type VideoElementAtPoint = VideoElement &
+  Point &
+  (WidthAndHeight | Width | Height);
 
 /**
  * @public

package/lib/cjs/sdk/design/beta.js

@@ -34,5 +34,4 @@ var _window___canva___sdkRegistration, _window___canva__;
 const { canva_sdk } = window;
 const readContent = canva_sdk.design.v2.designInteraction.readContent;
 const openDesign = canva_sdk.design.v2.designInteraction.openDesign;
-(_window___canva__ =
-window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('design', '2.1.0', 'beta');
+(_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('design', '2.2.1', 'beta');

package/lib/cjs/sdk/design/public.js

@@ -68,12 +68,6 @@ const addElementAtPoint = canva_sdk.design.v2.designInteraction.addElementAtPoin
 const addElementAtCursor = canva_sdk.design.v2.designInteraction.addElementAtCursor;
 const addAudioTrack = canva_sdk.design.v2.designInteraction.addAudioTrack;
 const getCurrentPageContext = canva_sdk.design.v2.designInteraction.getCurrentPageContext;
-function initAppElement(appElementConfig) {
-    return canva_sdk.design.v2.designInteraction.initAppElement(appElementConfig);
-}
-function getDesignToken() {
-    return canva_sdk.design.v2.designInteraction.getDesignToken();
-}
-function createRichtextRange() {
-    return canva_sdk.design.v2.designInteraction.createRichtextRange();
-}
+const initAppElement = canva_sdk.design.v2.designInteraction.initAppElement;
+const getDesignToken = canva_sdk.design.v2.designInteraction.getDesignToken;
+const createRichtextRange = canva_sdk.design.v2.designInteraction.createRichtextRange;

package/lib/esm/sdk/design/beta.js

@@ -3,5 +3,4 @@ const { canva_sdk } = window;
 export const readContent = canva_sdk.design.v2.designInteraction.readContent;
 export const openDesign = canva_sdk.design.v2.designInteraction.openDesign;
 export * from './public';
-(_window___canva__ =
-window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('design', '2.1.0', 'beta');
+(_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('design', '2.2.1', 'beta');

package/lib/esm/sdk/design/public.js

@@ -11,12 +11,6 @@ export const addElementAtPoint = canva_sdk.design.v2.designInteraction.addElemen
 export const addElementAtCursor = canva_sdk.design.v2.designInteraction.addElementAtCursor;
 export const addAudioTrack = canva_sdk.design.v2.designInteraction.addAudioTrack;
 export const getCurrentPageContext = canva_sdk.design.v2.designInteraction.getCurrentPageContext;
-export function initAppElement(appElementConfig) {
-    return canva_sdk.design.v2.designInteraction.initAppElement(appElementConfig);
-}
-export function getDesignToken() {
-    return canva_sdk.design.v2.designInteraction.getDesignToken();
-}
-export function createRichtextRange() {
-    return canva_sdk.design.v2.designInteraction.createRichtextRange();
-}
+export const initAppElement = canva_sdk.design.v2.designInteraction.initAppElement;
+export const getDesignToken = canva_sdk.design.v2.designInteraction.getDesignToken;
+export const createRichtextRange = canva_sdk.design.v2.designInteraction.createRichtextRange;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canva/design",
-  "version": "2.2.0-beta.1",
+  "version": "2.2.1-beta.1",
   "description": "The Canva Apps SDK design library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",