@canva/design 2.4.1-beta.1 → 2.4.1-beta.2

package/beta.d.ts

@@ -1121,6 +1121,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;
+};
+
 /**
  * @beta
  * A callback for reading and updating part of a design.
@@ -1543,6 +1577,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.

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

@@ -2,9 +2,17 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "openDesign", {
-    enumerable: true,
-    get: function() {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    getDesignMetadata: function() {
+        return getDesignMetadata;
+    },
+    openDesign: function() {
         return openDesign;
     }
 });
@@ -25,4 +33,5 @@ function _export_star(from, to) {
 var _window___canva___sdkRegistration, _window___canva__;
 const { canva_sdk } = window;
 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.4.0', 'beta');
+const getDesignMetadata = canva_sdk.design.v2.designInteraction.getDesignMetadata;
+(_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.5.0', 'beta');

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

@@ -9,12 +9,44 @@ Object.defineProperty(exports, "FakeDesignInteractionClient", {
     }
 });
 class FakeDesignInteractionClient {
+    async getDesignTitle() {
+        await this.delay();
+        return 'title';
+    }
     async getDesignToken() {
         await this.delay();
         return {
             token: 'token'
         };
     }
+    async getDesignMetadata() {
+        await this.delay();
+        return {
+            title: 'title',
+            defaultPageDimensions: {
+                width: 800,
+                height: 600
+            },
+            pageMetadata: [
+                {
+                    dimensions: {
+                        width: 800,
+                        height: 600
+                    }
+                },
+                {
+                    dimensions: {
+                        width: 300,
+                        height: 900
+                    }
+                },
+                {
+                    dimensions: undefined
+                }
+            ],
+            durationInSeconds: 30
+        };
+    }
     async addNativeElement(element) {
         await this.delay();
     }
@@ -90,6 +122,9 @@ class FakeDesignInteractionClient {
             elementBuilder: fakeElementBuilder
         });
     }
+    async openDesign2(options, callback) {
+        throw new Error('Not yet implemented');
+    }
     constructor(delay){
         this.delay = delay;
         this.selection = {

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

@@ -1,5 +1,6 @@
 var _window___canva___sdkRegistration, _window___canva__;
 const { canva_sdk } = window;
 export const openDesign = canva_sdk.design.v2.designInteraction.openDesign;
+export const getDesignMetadata = canva_sdk.design.v2.designInteraction.getDesignMetadata;
 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.4.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.5.0', 'beta');

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

@@ -1,10 +1,42 @@
 export class FakeDesignInteractionClient {
+    async getDesignTitle() {
+        await this.delay();
+        return 'title';
+    }
     async getDesignToken() {
         await this.delay();
         return {
             token: 'token'
         };
     }
+    async getDesignMetadata() {
+        await this.delay();
+        return {
+            title: 'title',
+            defaultPageDimensions: {
+                width: 800,
+                height: 600
+            },
+            pageMetadata: [
+                {
+                    dimensions: {
+                        width: 800,
+                        height: 600
+                    }
+                },
+                {
+                    dimensions: {
+                        width: 300,
+                        height: 900
+                    }
+                },
+                {
+                    dimensions: undefined
+                }
+            ],
+            durationInSeconds: 30
+        };
+    }
     async addNativeElement(element) {
         await this.delay();
     }
@@ -80,6 +112,9 @@ export class FakeDesignInteractionClient {
             elementBuilder: fakeElementBuilder
         });
     }
+    async openDesign2(options, callback) {
+        throw new Error('Not yet implemented');
+    }
     constructor(delay){
         this.delay = delay;
         this.selection = {

package/package.json

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