@canva/intents 2.3.1 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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

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';
 }
 
 /**
@@ -667,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
@@ -914,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
@@ -1378,6 +1447,7 @@ export declare type RenderSettingsUiRequest = {
     registerOnContextChange: (opts: {
         onContextChange: OnContextChange;
     }) => Disposer;
+
 };
 
 /**

package/index.d.ts

@@ -267,6 +267,12 @@ declare namespace content {
         prepareContentPublisher,
         Disposer,
         PublishContentRequest,
+        Preview,
+        PreviewMedia,
+        RenderPreviewUiInvocationContext,
+        PublishPreviewUiInvocationContext,
+        RenderPreviewUiRequest,
+        ContentPublisherIntent,
         RenderSettingsUiInvocationContext,
         PublishSettingsUiInvocationContext,
         RenderSettingsUiRequest,
@@ -297,6 +303,7 @@ declare namespace content {
         ImageRequirement,
         VideoRequirement,
         DocumentRequirement,
+        EmailRequirement,
         MediaSelection,
         ImageSelection,
         VideoSelection,
@@ -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 }
@@ -918,6 +924,7 @@ declare interface DesignContentMetadata {
      * The pages that make up the exported metadata
      */
     pages: OutputPageMetadata[];
+
 }
 
 /**
@@ -1072,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 EmailPreviewStub extends BasePreview {
+declare interface EmailPreviewLoading extends BasePreview {
     kind: 'email';
+    status: 'loading';
+}
+
+/**
+ * @public
+ * Email preview in a ready state.
+ *
+ * Display the email preview.
+ */
+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';
 }
 
 /**
@@ -1609,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
@@ -2050,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
@@ -2575,6 +2650,7 @@ declare type RenderSettingsUiRequest = {
     registerOnContextChange: (opts: {
         onContextChange: OnContextChange;
     }) => Disposer;
+
 };
 
 /**

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

@@ -19,6 +19,6 @@ _export(exports, {
         return LATEST_VERSION_BETA;
     }
 });
-const LATEST_VERSION = '2.3.1';
+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.1';
+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.1",
+  "version": "2.4.0",
   "description": "The Canva Apps SDK Intents library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",