@canva/design 2.7.4-beta.0 → 2.7.4-beta.2

package/beta.d.ts

@@ -2758,14 +2758,18 @@ export declare namespace DesignEditing {
   /**
    * @beta
    * A reference to a page.
+   *
+   * @preventInline
    */
   export type PageRef = AbsolutePageRef | Unsupported;
 
   /**
    * @beta
    * A list containing the references to pages in the design.
+   *
+   * @preventInline
    */
-  export type PageRefList = ReadableList<PageRef>;
+  export interface PageRefList extends ReadableList<PageRef> {}
   {
   }
 }
@@ -3323,6 +3327,44 @@ export declare type ExportBlob = {
   url: string;
 };
 
+/**
+ * @beta
+ * The exported file.
+ */
+export declare type ExportBlobWithZippedOptionOutput = {
+  /**
+   * The URL of the exported design.
+   *
+   * @remarks
+   * If a user's design contains multiple pages but is exported in a format that doesn't support multiple pages,
+   * by defaultthis URL will point to a ZIP file that contains each page as a separate file.
+   *
+   * If the user has configured the export to not zip the exported files (using the `zipped` property), this URL will point to a single file.
+   *
+   * For example:
+   *
+   * - If a single-page design is exported as a JPG, the URL will point to a JPG file.
+   * - If a multi-page design is exported as a JPG, the URL will point to a ZIP file that contains a JPG file for each page.
+   * - If a multi-page design is exported as a JPG and the user has set `zipped` to `never` for JPGs, the URL will point to a JPG file and will be one of multiple urls in the exportBlobs array.
+   * - If a multi-page design is exported as a PDF file, the URL will point to a PDF file.
+   * - If a multi-page design is exported as a VIDEO file and the user has set `zipped` to `always` for VIDEOs, the URL will point to a ZIP that contains a VIDEO file.
+   *
+   * The following file types support multiple pages:
+   *
+   * - `"GIF"`
+   * - `"PDF_STANDARD"`
+   * - `"PPTX"`
+   * - `"VIDEO"`
+   *
+   * The following file types do not support multiple pages:
+   *
+   * - `"JPG"`
+   * - `"PNG"`
+   * - `"SVG"`
+   */
+  url: string;
+};
+
 /**
  * @public
  * The result when a user successfully completes an export flow.
@@ -3346,6 +3388,28 @@ export declare type ExportCompleted = {
   exportBlobs: ExportBlob[];
 };
 
+/**
+ * @beta
+ * The result when a user successfully completes an export flow.
+ */
+export declare type ExportCompletedWithZippedOptionOutput = {
+  /**
+   * The status of the export flow.
+   */
+  status: "completed";
+  /**
+   * The title of the design, if set by the user.
+   */
+  title?: string;
+  /**
+   * The exported files.
+   *
+   * @remarks
+   * This array can contain a single link either to a file or a ZIP, or multiple links to individual files.
+   */
+  exportBlobs: ExportBlobWithZippedOptionOutput[];
+};
+
 /**
  * @public
  * The types of files that Canva supports for exported designs.
@@ -3359,6 +3423,19 @@ export declare type ExportFileType =
   | "pptx"
   | "svg";
 
+/**
+ * @beta
+ * Object representation of the supported file types with properties where applicable.
+ */
+export declare type ExportFileTypeWithProperties =
+  | {
+      type: "pdf_standard" | "pptx";
+    }
+  | {
+      type: "png" | "jpg" | "video" | "gif" | "svg";
+      zipped?: ZipBehavior;
+    };
+
 /**
  * @public
  * Options for configuring the export of a design.
@@ -3373,12 +3450,34 @@ export declare type ExportRequest = {
   acceptedFileTypes: ExportFileType[];
 };
 
+/**
+ * @beta
+ * Options for configuring the export of a design.
+ */
+export declare type ExportRequestWithFileTypeProperties = {
+  /**
+   * The types of files the user can export their design as.
+   *
+   * @remarks
+   * You must provide at least one file type.
+   */
+  acceptedFileTypes: (ExportFileType | ExportFileTypeWithProperties)[];
+};
+
 /**
  * @public
  * The result of exporting a design.
  */
 export declare type ExportResponse = ExportCompleted | ExportAborted;
 
+/**
+ * @beta
+ * The result of exporting a design.
+ */
+export declare type ExportResponseWithZippedOptionOutput =
+  | ExportCompletedWithZippedOptionOutput
+  | ExportAborted;
+
 /**
  * @public
  * Image element or content to be added to the design at the end of a drag event.
@@ -4201,13 +4300,13 @@ declare type Point = {
 declare type Primitive = undefined | null | number | boolean | string;
 
 /**
- * @public
+ * @beta
  * Exports the user's design as one or more static files.
  * @param request - The request object containing configurations of the design export.
  */
 export declare const requestExport: (
-  request: ExportRequest,
-) => Promise<ExportResponse>;
+  request: ExportRequestWithFileTypeProperties,
+) => Promise<ExportResponseWithZippedOptionOutput>;
 
 /**
  * @public
@@ -5391,4 +5490,20 @@ declare type WidthAndHeight = {
   height: number;
 };
 
+/**
+ * @beta
+ * The behavior of zipping the exported files.
+ *
+ * @remarks
+ * For `png`, `jpg`, and `svg`:
+ * - `auto` (default): Files are zipped together if the design has multiple pages, unzipped if it has one page.
+ * - `always`: Files are always zipped into a single zip file, regardless of page count.
+ * - `never`: Files are never zipped, providing an array of files.
+ *
+ * For `video` and `gif`:
+ * - `auto` or `never` (default): Files are never zipped together, regardless of count.
+ * - `always`: Files are always zipped into a single file.
+ */
+export declare type ZipBehavior = "auto" | "always" | "never";
+
 export {};

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

@@ -14,6 +14,9 @@ _export(exports, {
     },
     get openDesign () {
         return openDesign;
+    },
+    get requestExport () {
+        return requestExport;
     }
 });
 const _version = require("./version");
@@ -36,4 +39,6 @@ function editContent(options, callback) {
     return canva_sdk.design.v2.designInteraction.editContent(options, (session)=>callback(session));
 }
 const openDesign = canva_sdk.design.v2.designInteraction.openDesign;
+const requestExport = canva_sdk.design.v2.export.requestExport;
 window.__canva__?.sdkRegistration?.registerPackageVersion('design', _version.LATEST_VERSION, 'beta');
+'comment';

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

@@ -8,4 +8,4 @@ Object.defineProperty(exports, "LATEST_VERSION", {
         return LATEST_VERSION;
     }
 });
-const LATEST_VERSION = '2.7.3';
+const LATEST_VERSION = '2.7.4';

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

@@ -4,5 +4,7 @@ export function editContent(options, callback) {
     return canva_sdk.design.v2.designInteraction.editContent(options, (session)=>callback(session));
 }
 export const openDesign = canva_sdk.design.v2.designInteraction.openDesign;
+export const requestExport = canva_sdk.design.v2.export.requestExport;
 export * from './public';
 window.__canva__?.sdkRegistration?.registerPackageVersion('design', LATEST_VERSION, 'beta');
+'comment';

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

@@ -1 +1 @@
-export const LATEST_VERSION = '2.7.3';
+export const LATEST_VERSION = '2.7.4';

package/package.json

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