@canva/design 2.6.1 → 2.6.2-beta.1

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

@@ -348,11 +348,16 @@ export declare interface ContentDraft<T> {
   save(): Promise<void>;
 }
 
+/**
+ * @beta
+ */
+export declare type ContentType = "richtext" | "fill";
+
 /**
  * @public
  * A type of content that can be read from a user's design.
  */
-export declare type ContentType = "richtext";
+declare type ContentType_2 = "richtext";
 
 /**
  * @public
@@ -1911,6 +1916,40 @@ export declare type DesignElement =
   | RichtextElement
   | TableElement;
 
+/**
+ * @beta
+ * Information about the design.
+ */
+export declare type DesignMetadata = {
+  /**
+   * The title of the user's design.
+   * @remarks
+   * This is optional and will be `undefined` if the user hasn't set a title.
+   */
+  title?: string;
+  /**
+   * 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.
+   * @remarks
+   * This is optional and will be `undefined` if the design is unbounded (e.g. Whiteboard or Doc).
+   */
+  defaultPageDimensions?: PageDimensions;
+  /**
+   * The information associated with each page of the design.
+   * @remarks
+   * The order of pages is not guaranteed.
+   */
+  pageMetadata: Iterable<PageContext>;
+  /**
+   * The duration of the whole design in seconds.
+   * @remarks
+   * This is the precise value, which differs from what is displayed in the UI as duration in Canva UI is formatted differently.
+   */
+  durationInSeconds: number;
+};
+
 /**
  * @public
  * A callback for reading and updating part of a design.
@@ -2013,27 +2052,53 @@ export declare type DragStartEvent<E extends Element> = Pick<
 };
 
 /**
- * @public
- * 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.
+ * @beta
+ * Reads and edits richtext content from the user's design.
+ * @param options - Options for configuring how a design is read. Must specify `contentType: 'richtext'`.
+ * @param callback - A callback that receives a `RichtextContentSession` for editing.
+ * @returns A promise that resolves when editing is complete.
  */
-export declare const editContent: (
-  options: EditContentOptions,
-  callback: EditContentCallback,
-) => Promise<void>;
+export declare function editContent(
+  options: EditContentOptions & {
+    contentType: "richtext";
+  },
+  callback: (session: RichtextContentSession) => Promise<void> | void,
+): Promise<void>;
 
 /**
- * @public
+ * @beta
+ * Reads and edits fill content from the user's design.
+ * @param options - Options for configuring how a design is read. Must specify `contentType: 'fill'`.
+ * @param callback - A callback that receives a `FillContentSession` for editing.
+ * @returns A promise that resolves when editing is complete.
+ */
+export declare function editContent(
+  options: EditContentOptions & {
+    contentType: "fill";
+  },
+  callback: (session: FillContentSession) => Promise<void> | void,
+): Promise<void>;
+
+/**
+ * @beta
  * A callback for reading and updating the requested design content.
  * @param session - The result of reading the content in the design.
  */
 export declare type EditContentCallback = (
-  session: RichtextContentSession,
+  session: RichtextContentSession | FillContentSession,
 ) => Promise<void> | void;
 
 /**
  * @public
+ * A callback for reading and updating the requested design content.
+ * @param session - The result of reading the content in the design.
+ */
+declare type EditContentCallback_2 = (
+  session: RichtextContentSession,
+) => Promise<void> | void;
+
+/**
+ * @beta
  * Options for configuring how the design content is read.
  */
 export declare type EditContentOptions = {
@@ -2043,6 +2108,17 @@ export declare type EditContentOptions = {
   contentType: ContentType;
 } & ContextOptions;
 
+/**
+ * @public
+ * Options for configuring how the design content is read.
+ */
+declare type EditContentOptions_2 = {
+  /**
+   * The type of content to edit from the user's design
+   */
+  contentType: ContentType_2;
+} & ContextOptions;
+
 /**
  * @public
  * Elements targeting a cursor are a subset of the base Element
@@ -2273,6 +2349,31 @@ export declare type Fill = {
   asset?: ImageFill | VideoFill;
 };
 
+/**
+ * @beta
+ * Object for interacting with fill content (images/videos).
+ */
+export declare type FillContent =
+  | {
+      type: "image";
+      ref: ImageRef;
+      deleted: boolean;
+    }
+  | {
+      type: "video";
+      ref: VideoRef;
+      deleted: boolean;
+    };
+
+/**
+ * @beta
+ * Session for reading and updating fill content in a user's design.
+ */
+export declare interface FillContentSession {
+  readonly contents: readonly FillContent[];
+  sync(): Promise<void>;
+}
+
 /**
  * @public
  * A reference to a font that can be used in other parts of the SDK.
@@ -2316,6 +2417,12 @@ export declare const getDefaultPageDimensions: () => Promise<
   Dimensions | undefined
 >;
 
+/**
+ * @beta
+ * Retrieves information about the design.
+ */
+export declare const getDesignMetadata: () => Promise<DesignMetadata>;
+
 /**
  * @public
  * Retrieves a signed JWT that contains the Design ID, App ID and User ID.
@@ -3338,6 +3445,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;
 };
 
 /**

package/lib/cjs/sdk/design/{index.js → beta.js}

@@ -1,7 +1,21 @@
-"use strict"
+"use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get editContent () {
+        return editContent;
+    },
+    get getDesignMetadata () {
+        return getDesignMetadata;
+    }
+});
 _export_star(require("./public"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
@@ -17,4 +31,9 @@ function _export_star(from, to) {
     return from;
 }
 var _window___canva___sdkRegistration, _window___canva__;
-(_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.6.1', 'ga');
+const { canva_sdk } = window;
+const getDesignMetadata = canva_sdk.design.v2.designInteraction.getDesignMetadata;
+function editContent(options, callback) {
+    return canva_sdk.design.v2.designInteraction.editContent(options, (session)=>callback(session));
+}
+(_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.6.2', 'beta');

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

@@ -0,0 +1,18 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./index"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/lib/esm/sdk/design/{index.js → beta.js}

@@ -1,3 +1,8 @@
 var _window___canva___sdkRegistration, _window___canva__;
+const { canva_sdk } = window;
+export const getDesignMetadata = canva_sdk.design.v2.designInteraction.getDesignMetadata;
+export function editContent(options, callback) {
+    return canva_sdk.design.v2.designInteraction.editContent(options, (session)=>callback(session));
+}
 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.6.1', 'ga');
+(_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.6.2', 'beta');

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

@@ -0,0 +1 @@
+export * from './index';

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@canva/design",
-  "version": "2.6.1",
+  "version": "2.6.2-beta.1",
   "description": "The Canva Apps SDK design library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",
   "peerDependencies": {
     "@canva/error": "^2.0.0"
   },
-  "main": "./lib/cjs/sdk/design/index.js",
-  "module": "./lib/esm/sdk/design/index.js",
+  "main": "./lib/cjs/sdk/design/beta.js",
+  "module": "./lib/esm/sdk/design/beta.js",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "require": "./lib/cjs/sdk/design/index.js",
-      "import": "./lib/esm/sdk/design/index.js"
+      "types": "./beta.d.ts",
+      "require": "./lib/cjs/sdk/design/beta.js",
+      "import": "./lib/esm/sdk/design/beta.js"
     },
     "./test": {
-      "types": "./test/index.d.ts",
-      "require": "./lib/cjs/sdk/design/test/index.js",
-      "import": "./lib/esm/sdk/design/test/index.js"
+      "types": "./test/beta.d.ts",
+      "require": "./lib/cjs/sdk/design/test/beta.js",
+      "import": "./lib/esm/sdk/design/test/beta.js"
     }
   },
-  "typings": "./index.d.ts"
-}
+  "typings": "./beta.d.ts"
+}