@canva/design 2.7.3-beta.0 → 2.7.3

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
@@ -1587,9 +1582,9 @@ export declare namespace DesignEditing {
   };
   /**
    * @public
-   * The result of reading part of a design when the context is the current page.
+   * Session received by the `openDesign` callback when opening the current page.
    */
-  export type CurrentPageResult<
+  export type CurrentPageSession<
     Page = DesignEditing.Page,
     Helpers = DesignEditing.PageHelpers,
   > = Readonly<{
@@ -1602,7 +1597,7 @@ export declare namespace DesignEditing {
      */
     helpers: Helpers;
     /**
-     * Saves any changes made during the session while keeping the transaction open.
+     * Saves any changes made during the session while keeping the session open.
      *
      * @remarks
      * - Any changes in the session are only reflected in the design after this method is called.
@@ -1610,13 +1605,19 @@ export declare namespace DesignEditing {
      */
     sync(): Promise<void>;
   }>;
+  /**
+   * @deprecated The type has been superseded by `CurrentPageSession`.
+   * @public
+   * Session received by the `openDesign` callback when opening the current page.
+   */
+  export type CurrentPageResult = CurrentPageSession;
+
   /**
    * 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<M> = (item: M, index: number) => void;
+  export type ForEachCallback<M> = (item: M) => void;
   /**
    * A function that determines if an item should be included in the result.
    *
@@ -1736,6 +1737,7 @@ export declare namespace DesignEditing {
     ): U[];
     readonly length: number;
     readonly [n: number]: T;
+    at(index: number): T | undefined;
   }
   /**
    * @public
@@ -2692,10 +2694,10 @@ export declare type DesignMetadata = {
 /**
  * @public
  * A callback for reading and updating part of a design.
- * @param session - The result of reading part of a design.
+ * @param session - Session received by the `openDesign` callback.
  */
 export declare type DesignOpenCallback = (
-  session: DesignEditing.CurrentPageResult,
+  session: DesignEditing.CurrentPageSession,
 ) => Promise<void>;
 
 /**
@@ -2926,53 +2928,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 = {
@@ -2982,17 +2970,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
@@ -3223,67 +3200,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.
@@ -4914,11 +4830,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

@@ -2,10 +2,21 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "FakeDesignInteractionClient", {
-    enumerable: true,
-    get: function() {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get FakeDesignInteractionClient () {
         return FakeDesignInteractionClient;
+    },
+    get fakeOpenDesignHelpers () {
+        return fakeOpenDesignHelpers;
+    },
+    get fakePage () {
+        return fakePage;
     }
 });
 class FakeDesignInteractionClient {
@@ -114,14 +125,7 @@ class FakeDesignInteractionClient {
             sync: async ()=>{
                 await this.delay();
             },
-            helpers: {
-                elementStateBuilder: fakeElementStateBuilder,
-                group: fakeAsyncOperations.group,
-                ungroup: fakeAsyncOperations.ungroup,
-                snapshot: ()=>{
-                    return {};
-                }
-            }
+            helpers: fakeOpenDesignHelpers
         });
     }
     constructor(delay){
@@ -360,3 +364,11 @@ const fakeAsyncOperations = {
         ];
     }
 };
+const fakeOpenDesignHelpers = {
+    elementStateBuilder: fakeElementStateBuilder,
+    group: fakeAsyncOperations.group,
+    ungroup: fakeAsyncOperations.ungroup,
+    snapshot: ()=>{
+        return {};
+    }
+};

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

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_export_star(require("./index"), exports);
+const _version = require("./version");
+_export_star(require("./public"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
@@ -16,3 +17,4 @@ function _export_star(from, to) {
     });
     return from;
 }
+window.__canva__?.sdkRegistration?.registerPackageVersion('design', _version.LATEST_VERSION, 'ga');

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

@@ -0,0 +1,11 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "LATEST_VERSION", {
+    enumerable: true,
+    get: function() {
+        return LATEST_VERSION;
+    }
+});
+const LATEST_VERSION = '2.7.3';

package/lib/cjs/sdk/utils/canva_sdk.js

@@ -26,10 +26,8 @@ function getCanvaSdk() {
     return window.canva_sdk;
 }
 function assertIsTestCanvaSdk() {
-    var _window___canva__;
-    if ((_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : _window___canva__.uiKit) {
-        var _getCanvaSdk_error, _getCanvaSdk;
-        const CanvaError = (_getCanvaSdk = getCanvaSdk()) === null || _getCanvaSdk === void 0 ? void 0 : (_getCanvaSdk_error = _getCanvaSdk.error) === null || _getCanvaSdk_error === void 0 ? void 0 : _getCanvaSdk_error.v2.CanvaError;
+    if (window.__canva__?.uiKit) {
+        const CanvaError = getCanvaSdk()?.error?.v2.CanvaError;
         throw new CanvaError({
             code: 'failed_precondition',
             message: "Canva App SDK: You're attempting to call `initTestEnvironment` in a non-test environment, such as in production. This method should be called in test environments, once and only once. For more info refer to https://canva.dev/docs/apps/testing/"

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

@@ -104,14 +104,7 @@ export class FakeDesignInteractionClient {
             sync: async ()=>{
                 await this.delay();
             },
-            helpers: {
-                elementStateBuilder: fakeElementStateBuilder,
-                group: fakeAsyncOperations.group,
-                ungroup: fakeAsyncOperations.ungroup,
-                snapshot: ()=>{
-                    return {};
-                }
-            }
+            helpers: fakeOpenDesignHelpers
         });
     }
     constructor(delay){
@@ -202,7 +195,7 @@ const fakeElementList = {
         return fakeRectElement;
     }
 };
-const fakePage = {
+export const fakePage = {
     type: 'absolute',
     locked: false,
     dimensions: fakePageDimensions,
@@ -350,3 +343,11 @@ const fakeAsyncOperations = {
         ];
     }
 };
+export const fakeOpenDesignHelpers = {
+    elementStateBuilder: fakeElementStateBuilder,
+    group: fakeAsyncOperations.group,
+    ungroup: fakeAsyncOperations.ungroup,
+    snapshot: ()=>{
+        return {};
+    }
+};

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

@@ -0,0 +1,3 @@
+import { LATEST_VERSION } from './version';
+export * from './public';
+window.__canva__?.sdkRegistration?.registerPackageVersion('design', LATEST_VERSION, 'ga');

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

@@ -0,0 +1 @@
+export const LATEST_VERSION = '2.7.3';

package/lib/esm/sdk/utils/canva_sdk.js

@@ -2,10 +2,8 @@ export function getCanvaSdk() {
     return window.canva_sdk;
 }
 export function assertIsTestCanvaSdk() {
-    var _window___canva__;
-    if ((_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : _window___canva__.uiKit) {
-        var _getCanvaSdk_error, _getCanvaSdk;
-        const CanvaError = (_getCanvaSdk = getCanvaSdk()) === null || _getCanvaSdk === void 0 ? void 0 : (_getCanvaSdk_error = _getCanvaSdk.error) === null || _getCanvaSdk_error === void 0 ? void 0 : _getCanvaSdk_error.v2.CanvaError;
+    if (window.__canva__?.uiKit) {
+        const CanvaError = getCanvaSdk()?.error?.v2.CanvaError;
         throw new CanvaError({
             code: 'failed_precondition',
             message: "Canva App SDK: You're attempting to call `initTestEnvironment` in a non-test environment, such as in production. This method should be called in test environments, once and only once. For more info refer to https://canva.dev/docs/apps/testing/"

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@canva/design",
-  "version": "2.7.3-beta.0",
+  "version": "2.7.3",
   "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/beta.js

@@ -1,30 +0,0 @@
-"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) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    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.2', 'beta');

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

@@ -1,7 +0,0 @@
-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.2', 'beta');

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

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