@canva/design 2.7.1-beta.0 → 2.7.1

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

@@ -1015,16 +1015,11 @@ 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.
  */
-declare type ContentType_2 = "richtext";
+export declare type ContentType = "richtext";
 
 /**
  * @public
@@ -2625,6 +2620,7 @@ export declare namespace DesignEditing {
      */
     readonly elements: ElementList;
   };
+
   /**
    * @public
    * A page in a design.
@@ -2635,6 +2631,7 @@ export declare namespace DesignEditing {
    * - Additional page types may be supported in future releases.
    */
   export type Page = AbsolutePage | Unsupported;
+
   {
   }
 }
@@ -2924,53 +2921,39 @@ export declare type DragStartEvent<E extends Element> = Pick<
 };
 
 /**
- * @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 function editContent(
-  options: EditContentOptions & {
-    contentType: "richtext";
-  },
-  callback: (session: RichtextContentSession) => Promise<void> | void,
-): Promise<void>;
-
-/**
- * @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 - Session for reading and updating content in the design.
+ * @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.
+ *
+ * @example Read richtext content
+ * ```typescript
+ * import { editContent } from "@canva/design";
+ *
+ * await editContent(
+ *   { contentType: 'richtext', target: 'current_page' },
+ *   async (session) => {
+ *     // Do something with the richtext content, e.g. `session.contents`
+ *   }
+ * );
+ * ```
  */
-export declare type EditContentCallback = (
-  session: RichtextContentSession | FillContentSession,
-) => Promise<void> | void;
+export declare const editContent: (
+  options: EditContentOptions,
+  callback: EditContentCallback,
+) => Promise<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 = (
+export declare type EditContentCallback = (
   session: RichtextContentSession,
 ) => Promise<void> | void;
 
 /**
- * @beta
+ * @public
  * Options for configuring how the design content is read.
  */
 export declare type EditContentOptions = {
@@ -2980,17 +2963,6 @@ 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
@@ -3221,67 +3193,6 @@ export declare type Fill = {
   asset?: ImageFill | VideoFill;
 };
 
-/**
- * @beta
- * Object for interacting with fill content (images/videos).
- */
-export declare type FillContent =
-  | {
-      type: "image";
-      /**
-       * 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;
-      /**
-       * Indicates whether the object containing this fill has been deleted.
-       */
-      deleted: boolean;
-    }
-  | {
-      type: "video";
-      /**
-       * A unique identifier that points to an video asset in Canva's backend.
-       */
-      ref: VideoRef;
-      /**
-       * A description of the video content.
-       *
-       * @remarks
-       * Use `undefined` for content with no description.
-       */
-      altText?: AltText;
-      /**
-       * Indicates whether the object containing this fill has been deleted.
-       */
-      deleted: boolean;
-    };
-
-/**
- * @beta
- * Session for reading and updating fill content in a user's design.
- */
-export declare interface FillContentSession {
-  /**
-   * Fill content in the design.
-   */
-  readonly contents: readonly FillContent[];
-  /**
-   * Saves any changes made during the session while keeping the transaction open.
-   *
-   * @remarks
-   * - Any changes in the session are only reflected in the design after this method is called.
-   * - Once this method is called, further changes in the session can still be made.
-   */
-  sync(): Promise<void>;
-}
-
 /**
  * @public
  * A reference to a font that can be used in other parts of the SDK.
@@ -3325,6 +3236,7 @@ export declare type FontWeight =
 export declare const getCurrentPageContext: () => Promise<PageContext>;
 
 /**
+ * @deprecated
  * @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
@@ -4911,11 +4823,6 @@ 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/fake/fake_design_interaction_client.js

@@ -9,10 +9,6 @@ Object.defineProperty(exports, "FakeDesignInteractionClient", {
     }
 });
 class FakeDesignInteractionClient {
-    async getDesignTitle() {
-        await this.delay();
-        return 'title';
-    }
     async getDesignToken() {
         await this.delay();
         return {

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

@@ -1,13 +1,7 @@
-"use strict";
+"use strict"
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "editContent", {
-    enumerable: true,
-    get: function() {
-        return editContent;
-    }
-});
 _export_star(require("./public"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
@@ -23,8 +17,4 @@ function _export_star(from, to) {
     return from;
 }
 var _window___canva___sdkRegistration, _window___canva__;
-const { canva_sdk } = window;
-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.7.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.7.0', 'ga');

package/lib/esm/sdk/design/fake/fake_design_interaction_client.js

@@ -1,8 +1,4 @@
 export class FakeDesignInteractionClient {
-    async getDesignTitle() {
-        await this.delay();
-        return 'title';
-    }
     async getDesignToken() {
         await this.delay();
         return {

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

@@ -1,7 +1,3 @@
 var _window___canva___sdkRegistration, _window___canva__;
-const { canva_sdk } = window;
-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.7.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.7.0', 'ga');

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@canva/design",
-  "version": "2.7.1-beta.0",
+  "version": "2.7.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/beta.js",
-  "module": "./lib/esm/sdk/design/beta.js",
+  "main": "./lib/cjs/sdk/design/index.js",
+  "module": "./lib/esm/sdk/design/index.js",
   "exports": {
     ".": {
-      "types": "./beta.d.ts",
-      "require": "./lib/cjs/sdk/design/beta.js",
-      "import": "./lib/esm/sdk/design/beta.js"
+      "types": "./index.d.ts",
+      "require": "./lib/cjs/sdk/design/index.js",
+      "import": "./lib/esm/sdk/design/index.js"
     },
     "./test": {
-      "types": "./test/beta.d.ts",
-      "require": "./lib/cjs/sdk/design/test/beta.js",
-      "import": "./lib/esm/sdk/design/test/beta.js"
+      "types": "./test/index.d.ts",
+      "require": "./lib/cjs/sdk/design/test/index.js",
+      "import": "./lib/esm/sdk/design/test/index.js"
     }
   },
-  "typings": "./beta.d.ts"
+  "typings": "./index.d.ts"
 }

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

@@ -1,18 +0,0 @@
-"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/test/beta.js

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