@canva/intents 2.5.1-beta.2 → 2.6.1-beta.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 2.6.1-beta.0 - 2026-06-18
+
+### Added
+
+- Added `content_export` to the `ContentNoun` type in the content publisher intent
+
 ## 2.5.1-beta.2 - 2026-05-28
 
 ### Added

package/beta.d.ts

@@ -279,7 +279,7 @@ declare interface BasePreview {
     /**
      * Unique identifier for this preview.
      *
-     * Use this ID with `requestPreviewUpgrade` to upgrade video thumbnails.
+     * Use this ID with `requestPreviewUpgrade` to upgrade thumbnails to full previews.
      */
     id: string;
     /**
@@ -425,6 +425,7 @@ declare namespace content {
         MaxValueRange,
         MinMaxValueRange,
         ValueRange,
+        DocumentPreview,
         DocumentPreviewLoading,
         DocumentPreviewThumbnail,
         DocumentPreviewUpgrading,
@@ -476,7 +477,7 @@ declare namespace content {
         GetContentSummaryCompleted,
         GetContentSummaryError,
         GetContentSummaryResponse,
-        DocumentPreview,
+        GetContentSummaryRequest,
         Preview,
         PreviewMedia,
         RenderPreviewUiInvocationContext,
@@ -498,7 +499,7 @@ declare type ContentMetadata = DesignContentMetadata;
  * Describes what kind of content an output type produces. Canva uses this to tailor and improve
  * the publish experience.
  */
-declare type ContentNoun = 'email' | 'post' | 'schedule' | 'asset' | 'draft' | 'publication' | 'content';
+declare type ContentNoun = 'email' | 'post' | 'schedule' | 'asset' | 'draft' | 'publication' | 'content' | 'content_export';
 
 /**
  * @public
@@ -1159,10 +1160,11 @@ declare type DocumentOutputFile = BaseOutputFile;
  * @public
  * Document preview in various states.
  *
- * Documents transition through states: `"loading"` → `"thumbnail"`.
- * Start with a lightweight thumbnail of the first page for quick preview rendering.
+ * Documents transition through states: `"loading"` → `"thumbnail"` → `"upgrading"` → `"ready"`.
+ * Start with a lightweight thumbnail of the first page, then upgrade to full multi-page
+ * preview using `requestPreviewUpgrade`.
  */
-declare type DocumentPreview = DocumentPreviewLoading | DocumentPreviewThumbnail | DocumentPreviewError;
+declare type DocumentPreview = DocumentPreviewLoading | DocumentPreviewThumbnail | DocumentPreviewUpgrading | DocumentPreviewReady | DocumentPreviewError;
 
 /**
  * @public
@@ -1191,7 +1193,7 @@ declare interface DocumentPreviewLoading extends SizedPreview {
 }
 
 /**
- * @beta
+ * @public
  * Thumbnail for a single page within a document preview.
  */
 declare interface DocumentPreviewPage {
@@ -1210,7 +1212,7 @@ declare interface DocumentPreviewPage {
 }
 
 /**
- * @beta
+ * @public
  * Final state after a document preview has been upgraded. Contains thumbnail
  * URLs for every selected page in the document.
  */
@@ -1232,8 +1234,8 @@ declare interface DocumentPreviewReady extends BasePreview {
  * Document preview with first page thumbnail available.
  *
  * This is the initial state for document previews. Show the thumbnail image
- * of the first page along with the page count to give users a preview of
- * the document before publishing.
+ * of the first page to give users a quick preview of the document.
+ * Call `requestPreviewUpgrade` to load all page thumbnails.
  */
 declare interface DocumentPreviewThumbnail extends SizedPreview {
     kind: 'document';
@@ -1251,7 +1253,7 @@ declare interface DocumentPreviewThumbnail extends SizedPreview {
 }
 
 /**
- * @beta
+ * @public
  * Intermediate state while multi-page document thumbnails are being fetched
  * via {@link requestPreviewUpgrade}. The single-page thumbnail remains
  * available for display during the upgrade.
@@ -1259,8 +1261,15 @@ declare interface DocumentPreviewThumbnail extends SizedPreview {
 declare interface DocumentPreviewUpgrading extends SizedPreview {
     kind: 'document';
     status: 'upgrading';
+    /**
+     * Format of the thumbnail image.
+     */
     thumbnailFormat: 'png' | 'jpg';
-    /** The first-page thumbnail URL, available immediately. */
+    /**
+     * URL to the first page thumbnail.
+     *
+     * Continue showing this while the upgrade loads.
+     */
     thumbnailUrl: string;
 }
 
@@ -2786,20 +2795,21 @@ declare type RenderPreviewUiRequest = {
      */
     invocationContext: RenderPreviewUiInvocationContext;
     /**
-     * Callback to upgrade video thumbnail previews to full video media.
+     * Callback to upgrade thumbnail previews to full media.
      *
-     * Call this function when you need full video previews instead of lightweight thumbnails.
-     * This helps optimize performance by deferring full video loading until needed.
+     * Call this function when you need full video or multi-page document previews
+     * instead of lightweight thumbnails. This helps optimize performance by deferring
+     * full media loading until needed.
      *
      * Upgrades may complete asynchronously; listen to `registerOnPreviewChange` for updates
-     * to receive the upgraded video previews.
+     * to receive the upgraded previews.
      *
-     * @param previewIds - Array of preview IDs to upgrade from thumbnail to full video
+     * @param previewIds - Array of preview IDs to upgrade from thumbnail to full media
      *
-     * @example Upgrading video previews on user interaction
+     * @example Upgrading previews on user interaction
      * ```ts
-     * // When user clicks on a video thumbnail, upgrade to full video
-     * if (preview.kind === 'video' && preview.status === 'thumbnail') {
+     * // When user clicks on a thumbnail, upgrade to full preview
+     * if (preview.status === 'thumbnail') {
      *   requestPreviewUpgrade([preview.id]);
      * }
      * ```

package/content/beta.d.ts

@@ -194,7 +194,7 @@ export declare interface BasePreview {
     /**
      * Unique identifier for this preview.
      *
-     * Use this ID with `requestPreviewUpgrade` to upgrade video thumbnails.
+     * Use this ID with `requestPreviewUpgrade` to upgrade thumbnails to full previews.
      */
     id: string;
     /**
@@ -232,10 +232,10 @@ export declare type ContentMetadata = DesignContentMetadata;
  * Describes what kind of content an output type produces. Canva uses this to tailor and improve
  * the publish experience.
  */
-export declare type ContentNoun = 'email' | 'post' | 'schedule' | 'asset' | 'draft' | 'publication' | 'content';
+export declare type ContentNoun = 'email' | 'post' | 'schedule' | 'asset' | 'draft' | 'publication' | 'content' | 'content_export';
 
 /**
- * @beta
+ * @public
  * Main interface for implementing the ContentPublisher intent.
  *
  * Implementing the ContentPublisher intent enables apps to publish contents to external platforms.
@@ -327,13 +327,13 @@ export declare type ContentPublisherIntent = {
      * This action is called after the settings UI is rendered. Your UI should display
      * a preview of how the content will appear on the target platform.
      *
-     * Previews update dynamically as users modify their content or settings. For videos
-     * and documents, start with lightweight thumbnails and use `requestPreviewUpgrade`
-     * to load full previews on demand to optimize performance.
+     * Previews update dynamically as users modify their content or settings. For videos,
+     * start with lightweight thumbnails and use `requestPreviewUpgrade` to load full
+     * video previews on demand to optimize performance.
      *
      * @param request - Configuration and callbacks for the preview UI.
      *
-     * @example Rendering a preview UI with media optimization
+     * @example Rendering a preview UI with video optimization
      * ```ts
      * import { createRoot } from 'react-dom/client';
      * import type { RenderPreviewUiRequest } from '@canva/intents/content';
@@ -476,7 +476,7 @@ export declare type Disposer = () => void;
 export declare type DocumentOutputFile = BaseOutputFile;
 
 /**
- * @beta
+ * @public
  * Document preview in various states.
  *
  * Documents transition through states: `"loading"` → `"thumbnail"` → `"upgrading"` → `"ready"`.
@@ -512,7 +512,7 @@ export declare interface DocumentPreviewLoading extends SizedPreview {
 }
 
 /**
- * @beta
+ * @public
  * Thumbnail for a single page within a document preview.
  */
 export declare interface DocumentPreviewPage {
@@ -531,7 +531,7 @@ export declare interface DocumentPreviewPage {
 }
 
 /**
- * @beta
+ * @public
  * Final state after a document preview has been upgraded. Contains thumbnail
  * URLs for every selected page in the document.
  */
@@ -553,8 +553,8 @@ export declare interface DocumentPreviewReady extends BasePreview {
  * Document preview with first page thumbnail available.
  *
  * This is the initial state for document previews. Show the thumbnail image
- * of the first page along with the page count to give users a preview of
- * the document before publishing.
+ * of the first page to give users a quick preview of the document.
+ * Call `requestPreviewUpgrade` to load all page thumbnails.
  */
 export declare interface DocumentPreviewThumbnail extends SizedPreview {
     kind: 'document';
@@ -572,7 +572,7 @@ export declare interface DocumentPreviewThumbnail extends SizedPreview {
 }
 
 /**
- * @beta
+ * @public
  * Intermediate state while multi-page document thumbnails are being fetched
  * via {@link requestPreviewUpgrade}. The single-page thumbnail remains
  * available for display during the upgrade.
@@ -580,8 +580,15 @@ export declare interface DocumentPreviewThumbnail extends SizedPreview {
 export declare interface DocumentPreviewUpgrading extends SizedPreview {
     kind: 'document';
     status: 'upgrading';
+    /**
+     * Format of the thumbnail image.
+     */
     thumbnailFormat: 'png' | 'jpg';
-    /** The first-page thumbnail URL, available immediately. */
+    /**
+     * URL to the first page thumbnail.
+     *
+     * Continue showing this while the upgrade loads.
+     */
     thumbnailUrl: string;
 }
 
@@ -1256,9 +1263,9 @@ export declare type PostPublishActionRedirect = {
 };
 
 /**
- * @beta
+ * @public
  *
- * Prepares a `ContentPublisherIntent`.
+ * Prepares a {@link ContentPublisherIntent|Content Publisher Intent}.
  *
  * @example
  * ```tsx
@@ -1283,8 +1290,8 @@ export declare type PostPublishActionRedirect = {
 export declare const prepareContentPublisher: (implementation: ContentPublisherIntent) => void;
 
 /**
- * @beta
- * Preview item for an image, video, document, or email.
+ * @public
+ * Preview item for an image or video.
  *
  * Check the `kind` and `status` properties to determine the type and state.
  */
@@ -1297,10 +1304,10 @@ export declare type Preview = ImagePreview | VideoPreview | DocumentPreview | Em
 export declare type PreviewKind = 'image' | 'video' | 'document' | 'email';
 
 /**
- * @beta
+ * @public
  * Preview media for a specific media slot.
  *
- * Contains preview URLs and metadata for images, videos, documents, or emails in the design.
+ * Contains preview URLs and metadata for images or videos in the design.
  */
 export declare type PreviewMedia = {
     /**
@@ -1456,7 +1463,7 @@ export declare type PublishErrorSettingsUiContext = {
 export declare type PublishFileFormat = 'png' | 'jpg' | 'mp4' | 'pdf_standard' | 'html_bundle' | 'html_standalone';
 
 /**
- * @beta
+ * @public
  * Initial payload provided from cache.
  */
 export declare type PublishPreviewUiInvocationContext = {
@@ -1584,21 +1591,21 @@ export declare type RemoteRequestFailedError = {
 };
 
 /**
- * @beta
+ * @public
  * Initial payload provided when the preview UI is rendered.
  * Contains the preview data and settings needed to initialize the preview interface.
  */
 export declare type RenderPreviewUiInvocationContext = PublishPreviewUiInvocationContext;
 
 /**
- * @beta
+ * @public
  * Configuration required for rendering the preview UI.
  *
  * Provides callbacks for managing preview media and responding to preview updates.
  */
 export declare type RenderPreviewUiRequest = {
     /**
-     * @beta
+     * @public
      * The initial preview data and context provided when the preview UI is rendered.
      *
      * Contains the initial preview media, output type information, and any existing
@@ -1606,10 +1613,11 @@ export declare type RenderPreviewUiRequest = {
      */
     invocationContext: RenderPreviewUiInvocationContext;
     /**
-     * Callback to upgrade thumbnail previews to their full media variant.
+     * Callback to upgrade thumbnail previews to full media.
      *
-     * Call this function when you need full previews instead of lightweight thumbnails.
-     * This helps optimize performance by deferring full media loading until needed.
+     * Call this function when you need full video or multi-page document previews
+     * instead of lightweight thumbnails. This helps optimize performance by deferring
+     * full media loading until needed.
      *
      * Upgrades may complete asynchronously; listen to `registerOnPreviewChange` for updates
      * to receive the upgraded previews.
@@ -1618,8 +1626,8 @@ export declare type RenderPreviewUiRequest = {
      *
      * @example Upgrading previews on user interaction
      * ```ts
-     * // When user clicks on a video thumbnail, upgrade to full video
-     * if (preview.kind === 'video' && preview.status === 'thumbnail') {
+     * // When user clicks on a thumbnail, upgrade to full preview
+     * if (preview.status === 'thumbnail') {
      *   requestPreviewUpgrade([preview.id]);
      * }
      * ```
@@ -1632,7 +1640,7 @@ export declare type RenderPreviewUiRequest = {
      *
      * - The design content changes
      * - The output type changes
-     * - Preview media is upgraded from thumbnail to full media
+     * - Preview media is upgraded from thumbnail to full video
      * - Export settings are modified
      *
      * Use this to update your preview UI in real-time as users modify their design.

package/lib/cjs/sdk/intents/content/beta.js

@@ -2,12 +2,6 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "prepareContentPublisher", {
-    enumerable: true,
-    get: function() {
-        return prepareContentPublisher;
-    }
-});
 const _version = require("../version");
 _export_star(require("./public"), exports);
 function _export_star(from, to) {
@@ -23,5 +17,4 @@ function _export_star(from, to) {
     });
     return from;
 }
-const prepareContentPublisher = canva_sdk.intents.v1.content.prepareContentPublisher;
 window.__canva__?.sdkRegistration?.registerPackageVersion('intents/content', _version.LATEST_VERSION_BETA, 'beta');

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

@@ -19,6 +19,6 @@ _export(exports, {
         return LATEST_VERSION_BETA;
     }
 });
-const LATEST_VERSION = '2.5.0';
-const LATEST_VERSION_BETA = '2.5.1-beta.2';
+const LATEST_VERSION = '2.6.0';
+const LATEST_VERSION_BETA = '2.6.1-beta.0';
 const LATEST_VERSION_ALPHA = 'NONE';

package/lib/esm/sdk/intents/content/beta.js

@@ -1,4 +1,3 @@
 import { LATEST_VERSION_BETA } from '../version';
 export * from './public';
-export const prepareContentPublisher = canva_sdk.intents.v1.content.prepareContentPublisher;
 window.__canva__?.sdkRegistration?.registerPackageVersion('intents/content', LATEST_VERSION_BETA, 'beta');

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

@@ -1,3 +1,3 @@
-export const LATEST_VERSION = '2.5.0';
-export const LATEST_VERSION_BETA = '2.5.1-beta.2';
+export const LATEST_VERSION = '2.6.0';
+export const LATEST_VERSION_BETA = '2.6.1-beta.0';
 export const LATEST_VERSION_ALPHA = 'NONE';

package/package.json

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