@canva/intents 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 2.4.0 - 2026-03-23
+
+### Added
+
+- Launch the new Email media type to public, enabling publishing and selection of email pages.
+
+## 2.3.1 - 2026-03-12
+
+### Fixed
+
+- Re-export data types from the intents/data public API that were accidentally removed during a refactor
+- Rename `Selection` type to `MediaSelection` for clarity
+
 ## 2.3.0 - 2026-03-06
 
 ### Added

package/content/index.d.ts

@@ -305,6 +305,7 @@ export declare interface DesignContentMetadata {
      * The pages that make up the exported metadata
      */
     pages: OutputPageMetadata[];
+
 }
 
 /**
@@ -422,10 +423,75 @@ export declare type DocumentSelection = {
 export declare type DocumentSize = 'a4' | 'a3' | 'letter' | 'legal';
 
 /**
- * Email preview stub used before beta preview type is fully supported.
+ * @public
+ * Exported email file ready for publishing.
+ *
+ * Contains the final HTML bundle that should be uploaded to your platform.
+ */
+export declare type EmailOutputFile = BaseOutputFile;
+
+/**
+ * @public
+ * Email preview in various states.
+ *
+ * Display a loading state until the preview transitions to `"ready"` or `"error"`.
+ */
+export declare type EmailPreview = EmailPreviewLoading | EmailPreviewReady | EmailPreviewError;
+
+/**
+ * @public
+ * Email preview in an error state.
+ *
+ * Display an error state to the user.
+ */
+export declare interface EmailPreviewError extends BasePreview {
+    kind: 'email';
+    status: 'error';
+    message: string;
+}
+
+/**
+ * @public
+ * Email preview in a loading state.
+ *
+ * Display a loading spinner until the preview transitions to `"ready"` or `"error"`.
+ */
+export declare interface EmailPreviewLoading extends BasePreview {
+    kind: 'email';
+    status: 'loading';
+}
+
+/**
+ * @public
+ * Email preview in a ready state.
+ *
+ * Display the email preview.
  */
-declare interface EmailPreviewStub extends BasePreview {
+export declare interface EmailPreviewReady extends BasePreview {
     kind: 'email';
+    status: 'ready';
+    /**
+     * URL to the single html file that represents the email.
+     */
+    url: string;
+}
+
+/**
+ * @public
+ * Email file requirements for a media slot, currently only supports HTML bundle format.
+ *
+ * Note: Email output types use html_standalone previews in the preview UI.
+ * The actual email file is only generated for the final output in OutputMedia.
+ *
+ * @example Email bundle requirements
+ * ```ts
+ * const emailReq: EmailRequirement = {
+ *   format: 'html_bundle',
+ * };
+ * ```
+ */
+export declare interface EmailRequirement extends BaseFileRequirement {
+    format: 'html_bundle' | 'html_standalone';
 }
 
 /**
@@ -600,6 +666,15 @@ export declare type MaxValueRange = {
     max: number;
 };
 
+/**
+ * @public
+ * Metadata about a selected media item in a media slot.
+ *
+ * Canva populates this when returning {@link OutputType} in Settings UI contexts.
+ * Apps should not set this value.
+ */
+export declare type MediaSelection = ImageSelection | VideoSelection | DocumentSelection | EmailSelection;
+
 /**
  * @public
  * Configuration for a media slot within an output type.
@@ -658,7 +733,10 @@ export declare type MediaSlot = {
         image?: ImageRequirement;
         video?: VideoRequirement;
         document?: DocumentRequirement;
-
+        /**
+         * Email output types will show a single html file (canva hosted assets) preview in preview UI
+         */
+        email?: EmailRequirement;
     };
     /**
      * @public
@@ -669,7 +747,7 @@ export declare type MediaSlot = {
      * Apps should not set this value when defining output types in
      * {@link ContentPublisherIntent.getPublishConfiguration}.
      */
-    readonly selection?: readonly Selection_2[];
+    readonly selection?: readonly MediaSelection[];
 };
 
 /**
@@ -905,7 +983,7 @@ export declare const prepareContentPublisher: (implementation: ContentPublisherI
  *
  * Check the `kind` and `status` properties to determine the type and state.
  */
-export declare type Preview = ImagePreview | VideoPreview | DocumentPreview | EmailPreviewStub;
+export declare type Preview = ImagePreview | VideoPreview | DocumentPreview | EmailPreview;
 
 /**
  * @public
@@ -1369,17 +1447,8 @@ export declare type RenderSettingsUiRequest = {
     registerOnContextChange: (opts: {
         onContextChange: OnContextChange;
     }) => Disposer;
-};
 
-/**
- * @public
- * Metadata about a selected media item in a media slot.
- *
- * Canva populates this when returning {@link OutputType} in Settings UI contexts.
- * Apps should not set this value.
- */
-declare type Selection_2 = ImageSelection | VideoSelection | DocumentSelection | EmailSelection;
-export { Selection_2 as Selection }
+};
 
 /**
  * @public

package/data/index.d.ts

@@ -117,7 +117,7 @@ declare type AppErrorInvocationContext = {
  * };
  * ```
  */
-declare type BooleanDataTableCell = {
+export declare type BooleanDataTableCell = {
     /**
      * Indicates this cell contains a boolean value.
      */
@@ -134,7 +134,7 @@ declare type BooleanDataTableCell = {
  * @public
  * Configuration for a table column.
  */
-declare type ColumnConfig = {
+export declare type ColumnConfig = {
     /**
      * Name for the column, displayed as header text.
      *
@@ -330,7 +330,7 @@ export declare type DataSourceRef = {
  * };
  * ```
  */
-declare type DataTable = {
+export declare type DataTable = {
     /**
      * Column definitions with names and data types.
      *
@@ -349,7 +349,7 @@ declare type DataTable = {
  * @public
  * Generic type for table cells that resolves to a specific cell type.
  */
-declare type DataTableCell<T extends DataType = DataType> = {
+export declare type DataTableCell<T extends DataType = DataType> = {
     date: DateDataTableCell;
     string: StringDataTableCell;
     number: NumberDataTableCell;
@@ -361,7 +361,7 @@ declare type DataTableCell<T extends DataType = DataType> = {
  * @public
  * Options for uploading an image asset to the user's private media library.
  */
-declare type DataTableImageUpload = Omit<ImageUploadOptions, 'type' | 'parentRef'> & {
+export declare type DataTableImageUpload = Omit<ImageUploadOptions, 'type' | 'parentRef'> & {
     /**
      * Indicates this value contains options for image uploading.
      */
@@ -372,7 +372,7 @@ declare type DataTableImageUpload = Omit<ImageUploadOptions, 'type' | 'parentRef
  * @public
  * Maximum dimensions for imported data tables.
  */
-declare type DataTableLimit = {
+export declare type DataTableLimit = {
     /**
      * The maximum number of rows allowed.
      *
@@ -430,7 +430,7 @@ export declare type DataTableMetadata = {
  * };
  * ```
  */
-declare type DataTableRow = {
+export declare type DataTableRow = {
     /**
      * Array of cells containing the data values.
      *
@@ -443,7 +443,7 @@ declare type DataTableRow = {
  * @public
  * Options for uploading a video asset to the user's private media library.
  */
-declare type DataTableVideoUpload = Omit<VideoUploadOptions, 'type' | 'parentRef'> & {
+export declare type DataTableVideoUpload = Omit<VideoUploadOptions, 'type' | 'parentRef'> & {
     /**
      * Indicates this value contains options for video uploading.
      */
@@ -454,7 +454,7 @@ declare type DataTableVideoUpload = Omit<VideoUploadOptions, 'type' | 'parentRef
  * @public
  * Data types supported for table cells.
  */
-declare type DataType = 'string' | 'number' | 'date' | 'boolean' | 'media';
+export declare type DataType = 'string' | 'number' | 'date' | 'boolean' | 'media';
 
 /**
  * @public
@@ -475,7 +475,7 @@ declare type DataType = 'string' | 'number' | 'date' | 'boolean' | 'media';
  * };
  * ```
  */
-declare type DateDataTableCell = {
+export declare type DateDataTableCell = {
     /**
      * Indicates this cell contains a date value.
      */
@@ -782,7 +782,7 @@ export declare type InvocationContext = DataSelectionInvocationContext | Outdate
  * };
  * ```
  */
-declare type MediaCollectionDataTableCell = {
+export declare type MediaCollectionDataTableCell = {
     /**
      * Indicates this cell contains a media collection.
      */
@@ -836,7 +836,7 @@ declare type Never<T> = {
  * };
  * ```
  */
-declare type NumberCellMetadata = {
+export declare type NumberCellMetadata = {
     /**
      * Formatting pattern using Office Open XML Format.
      *
@@ -871,7 +871,7 @@ declare type NumberCellMetadata = {
  * };
  * ```
  */
-declare type NumberDataTableCell = {
+export declare type NumberDataTableCell = {
     /**
      * Indicates this cell contains a number value.
      */
@@ -1051,7 +1051,7 @@ export declare type RenderSelectionUiRequest = {
  * };
  * ```
  */
-declare type StringDataTableCell = {
+export declare type StringDataTableCell = {
     /**
      * Indicates this cell contains a string value.
      */

package/index.d.ts

@@ -267,6 +267,12 @@ declare namespace content {
         prepareContentPublisher,
         Disposer,
         PublishContentRequest,
+        Preview,
+        PreviewMedia,
+        RenderPreviewUiInvocationContext,
+        PublishPreviewUiInvocationContext,
+        RenderPreviewUiRequest,
+        ContentPublisherIntent,
         RenderSettingsUiInvocationContext,
         PublishSettingsUiInvocationContext,
         RenderSettingsUiRequest,
@@ -297,7 +303,8 @@ declare namespace content {
         ImageRequirement,
         VideoRequirement,
         DocumentRequirement,
-        Selection_2 as Selection,
+        EmailRequirement,
+        MediaSelection,
         ImageSelection,
         VideoSelection,
         DocumentSelection,
@@ -323,6 +330,10 @@ declare namespace content {
         VideoPreviewUpgrading,
         VideoPreviewReady,
         VideoPreviewError,
+        EmailPreview,
+        EmailPreviewLoading,
+        EmailPreviewReady,
+        EmailPreviewError,
         BasePreview,
         SizedPreview,
         PreviewKind,
@@ -333,15 +344,10 @@ declare namespace content {
         VideoOutputFile,
         BaseOutputFile,
         DocumentOutputFile,
+        EmailOutputFile,
         ContentMetadata,
         DesignContentMetadata,
-        OutputPageMetadata,
-        Preview,
-        PreviewMedia,
-        RenderPreviewUiInvocationContext,
-        PublishPreviewUiInvocationContext,
-        RenderPreviewUiRequest,
-        ContentPublisherIntent
+        OutputPageMetadata
     }
 }
 export { content }
@@ -535,7 +541,21 @@ declare namespace data {
         DataTableMetadata,
         GetDataTableError,
         UpdateDataRefResponse,
-        DataSourceRef
+        DataSourceRef,
+        DataTableLimit,
+        DataType,
+        DataTable,
+        ColumnConfig,
+        DataTableRow,
+        DataTableCell,
+        DateDataTableCell,
+        StringDataTableCell,
+        NumberDataTableCell,
+        NumberCellMetadata,
+        BooleanDataTableCell,
+        MediaCollectionDataTableCell,
+        DataTableImageUpload,
+        DataTableVideoUpload
     }
 }
 export { data }
@@ -904,6 +924,7 @@ declare interface DesignContentMetadata {
      * The pages that make up the exported metadata
      */
     pages: OutputPageMetadata[];
+
 }
 
 /**
@@ -1058,10 +1079,75 @@ declare type DocumentSelection = {
 declare type DocumentSize = 'a4' | 'a3' | 'letter' | 'legal';
 
 /**
- * Email preview stub used before beta preview type is fully supported.
+ * @public
+ * Exported email file ready for publishing.
+ *
+ * Contains the final HTML bundle that should be uploaded to your platform.
+ */
+declare type EmailOutputFile = BaseOutputFile;
+
+/**
+ * @public
+ * Email preview in various states.
+ *
+ * Display a loading state until the preview transitions to `"ready"` or `"error"`.
+ */
+declare type EmailPreview = EmailPreviewLoading | EmailPreviewReady | EmailPreviewError;
+
+/**
+ * @public
+ * Email preview in an error state.
+ *
+ * Display an error state to the user.
+ */
+declare interface EmailPreviewError extends BasePreview {
+    kind: 'email';
+    status: 'error';
+    message: string;
+}
+
+/**
+ * @public
+ * Email preview in a loading state.
+ *
+ * Display a loading spinner until the preview transitions to `"ready"` or `"error"`.
+ */
+declare interface EmailPreviewLoading extends BasePreview {
+    kind: 'email';
+    status: 'loading';
+}
+
+/**
+ * @public
+ * Email preview in a ready state.
+ *
+ * Display the email preview.
  */
-declare interface EmailPreviewStub extends BasePreview {
+declare interface EmailPreviewReady extends BasePreview {
     kind: 'email';
+    status: 'ready';
+    /**
+     * URL to the single html file that represents the email.
+     */
+    url: string;
+}
+
+/**
+ * @public
+ * Email file requirements for a media slot, currently only supports HTML bundle format.
+ *
+ * Note: Email output types use html_standalone previews in the preview UI.
+ * The actual email file is only generated for the final output in OutputMedia.
+ *
+ * @example Email bundle requirements
+ * ```ts
+ * const emailReq: EmailRequirement = {
+ *   format: 'html_bundle',
+ * };
+ * ```
+ */
+declare interface EmailRequirement extends BaseFileRequirement {
+    format: 'html_bundle' | 'html_standalone';
 }
 
 /**
@@ -1528,6 +1614,15 @@ declare type MediaCollectionDataTableCell = {
     value: (DataTableImageUpload | DataTableVideoUpload)[];
 };
 
+/**
+ * @public
+ * Metadata about a selected media item in a media slot.
+ *
+ * Canva populates this when returning {@link OutputType} in Settings UI contexts.
+ * Apps should not set this value.
+ */
+declare type MediaSelection = ImageSelection | VideoSelection | DocumentSelection | EmailSelection;
+
 /**
  * @public
  * Configuration for a media slot within an output type.
@@ -1586,7 +1681,10 @@ declare type MediaSlot = {
         image?: ImageRequirement;
         video?: VideoRequirement;
         document?: DocumentRequirement;
-
+        /**
+         * Email output types will show a single html file (canva hosted assets) preview in preview UI
+         */
+        email?: EmailRequirement;
     };
     /**
      * @public
@@ -1597,7 +1695,7 @@ declare type MediaSlot = {
      * Apps should not set this value when defining output types in
      * {@link ContentPublisherIntent.getPublishConfiguration}.
      */
-    readonly selection?: readonly Selection_2[];
+    readonly selection?: readonly MediaSelection[];
 };
 
 /**
@@ -2027,7 +2125,7 @@ declare const prepareDesignEditor: (implementation: DesignEditorIntent) => void;
  *
  * Check the `kind` and `status` properties to determine the type and state.
  */
-declare type Preview = ImagePreview | VideoPreview | DocumentPreview | EmailPreviewStub;
+declare type Preview = ImagePreview | VideoPreview | DocumentPreview | EmailPreview;
 
 /**
  * @public
@@ -2552,16 +2650,8 @@ declare type RenderSettingsUiRequest = {
     registerOnContextChange: (opts: {
         onContextChange: OnContextChange;
     }) => Disposer;
-};
 
-/**
- * @public
- * Metadata about a selected media item in a media slot.
- *
- * Canva populates this when returning {@link OutputType} in Settings UI contexts.
- * Apps should not set this value.
- */
-declare type Selection_2 = ImageSelection | VideoSelection | DocumentSelection | EmailSelection;
+};
 
 /**
  * @public

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

@@ -19,6 +19,6 @@ _export(exports, {
         return LATEST_VERSION_BETA;
     }
 });
-const LATEST_VERSION = '2.3.0';
+const LATEST_VERSION = '2.4.0';
 const LATEST_VERSION_BETA = '2.2.1-beta.1';
 const LATEST_VERSION_ALPHA = 'NONE';

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

@@ -1,3 +1,3 @@
-export const LATEST_VERSION = '2.3.0';
+export const LATEST_VERSION = '2.4.0';
 export const LATEST_VERSION_BETA = '2.2.1-beta.1';
 export const LATEST_VERSION_ALPHA = 'NONE';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canva/intents",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "The Canva Apps SDK Intents library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",