@canva/design 2.7.2 → 2.7.3

package/index.d.ts

@@ -1582,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<{
@@ -1597,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.
@@ -1605,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.
    *
@@ -1731,6 +1737,7 @@ export declare namespace DesignEditing {
     ): U[];
     readonly length: number;
     readonly [n: number]: T;
+    at(index: number): T | undefined;
   }
   /**
    * @public
@@ -2687,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>;
 
 /**

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/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+const _version = require("./version");
 _export_star(require("./public"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
@@ -16,5 +17,4 @@ 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.7.2', 'ga');
+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

@@ -1,3 +1,3 @@
-var _window___canva___sdkRegistration, _window___canva__;
+import { LATEST_VERSION } from './version';
 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', 'ga');
+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,6 +1,6 @@
 {
   "name": "@canva/design",
-  "version": "2.7.2",
+  "version": "2.7.3",
   "description": "The Canva Apps SDK design library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",