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

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 2.5.1-beta.2 - 2026-05-28
+
+### Added
+
+- Add multi-page document preview support to Content Publisher
+- Add optional `contentNoun` on Content Publisher `OutputType` so apps can describe what kind of content is published (for example post, email, or publication) and Canva can tailor publish-flow UX accordingly. When omitted, behavior defaults to generic `content`.
+- Add `getContentSummary` action to the Content Publisher
+
+## 2.5.1-beta.1 - 2026-05-12
+
+### Added
+
+- Promote requestAiContent from alpha to beta
+
 ## 2.5.1-beta.0 - 2026-04-10
 
 ### Changed

package/beta.d.ts

@@ -1,3 +1,49 @@
+/**
+ * @beta
+ * Cancelled response where the generation was not completed.
+ * We use only 'cancelled' since we don't expect app developers to handle any statuses further (e.g. blocked, failed).
+ * These will be handled on Canva's AI generation surface.
+ */
+declare type AiContentCancelledResponse = {
+    status: 'cancelled';
+};
+
+/**
+ * @beta
+ * Completed response for AI content generation.
+ * The value is the AI content generated for the app.
+ */
+declare type AiContentCompletedResponse = {
+    status: 'completed';
+    value: string;
+};
+
+/**
+ * @beta
+ * All possible AI content request types.
+ */
+declare type AiContentRequest = SocialCaptionRequest;
+
+/**
+ * @beta
+ * All possible AI content response types.
+ */
+declare type AiContentResponse = AiContentCompletedResponse | AiContentCancelledResponse;
+
+/**
+ * @beta
+ * All possible statuses for an AI content response.
+ *
+ */
+declare type AiContentResponseStatus = 'completed' | 'cancelled';
+
+/**
+ * @beta
+ * Possible content type for AI content generation.
+ * Future types will be added here, e.g. 'hashtags'.
+ */
+declare type AiContentType = 'social_caption';
+
 /**
  * @public
  * A disclosure identifying if the app generated this asset using AI.
@@ -139,6 +185,57 @@ declare type AppErrorInvocationContext = {
     message?: string;
 };
 
+/**
+ * @beta
+ * Content summary for file-destination apps (e.g. Google Drive, Dropbox).
+ */
+declare type AssetContentSummary = BaseContentSummary & {
+    type: 'asset';
+    /** Asset title or filename. */
+    title: string;
+    /** Folder path (e.g. "/My Projects/Designs"). */
+    path?: string;
+};
+
+/**
+ * @beta
+ * Base interface for AI content requests.
+ */
+declare type BaseAiContentRequest = {
+    /**
+     * The type of AI content generation which determines
+     * the kind of content the AI will generate.
+     */
+    type: AiContentType;
+    /**
+     * If a current value exists in the field, the AI content generation
+     * will be an edit-first experience.
+     * i.e. When the user has already entered a value in the field, the AI will
+     * generate a new value using the existing value as a starting point.
+     */
+    currentValue?: string;
+    /**
+     * The label chosen by the app developer for the field.
+     * It will be used in the UI to customize the copy.
+     * Required since it is essential context for the AI to generate the content.
+     */
+    fieldLabel: string;
+};
+
+/**
+ * @beta
+ * Base fields shared by all content summary variants.
+ */
+declare type BaseContentSummary = {
+    /**
+     * The account, page, or list this post was published to.
+     *
+     * For example, a Facebook Page, a mailing list, or a personal profile.
+     * Use the connected account's display name and icon when there is no distinct destination.
+     */
+    destination: Destination;
+};
+
 /**
  * @public
  * Base file requirement interface.
@@ -281,12 +378,6 @@ declare namespace content {
         prepareContentPublisher,
         Disposer,
         PublishContentRequest,
-        Preview,
-        PreviewMedia,
-        RenderPreviewUiInvocationContext,
-        PublishPreviewUiInvocationContext,
-        RenderPreviewUiRequest,
-        ContentPublisherIntent,
         RenderSettingsUiInvocationContext,
         PublishSettingsUiInvocationContext,
         RenderSettingsUiRequest,
@@ -298,6 +389,7 @@ declare namespace content {
         PublishError,
         PublishSettings,
         PublishRefValidityState,
+        ContentNoun,
         UpdatePublishSettingsResponse,
         UpdatePublishSettingsCompleted,
         PublishContentResponse,
@@ -333,9 +425,11 @@ declare namespace content {
         MaxValueRange,
         MinMaxValueRange,
         ValueRange,
-        DocumentPreview,
         DocumentPreviewLoading,
         DocumentPreviewThumbnail,
+        DocumentPreviewUpgrading,
+        DocumentPreviewReady,
+        DocumentPreviewPage,
         DocumentPreviewError,
         ImagePreview,
         ImagePreviewLoading,
@@ -364,7 +458,31 @@ declare namespace content {
         EmailOutputFile,
         ContentMetadata,
         DesignContentMetadata,
-        OutputPageMetadata
+        OutputPageMetadata,
+        AiContentType,
+        SocialCaptionRequest,
+        AiContentRequest,
+        AiContentResponseStatus,
+        AiContentCompletedResponse,
+        AiContentCancelledResponse,
+        AiContentResponse,
+        RequestAiContent,
+        Destination,
+        PostContentSummary,
+        EmailContentSummary,
+        AssetContentSummary,
+        GenericContentSummary,
+        ContentSummary,
+        GetContentSummaryCompleted,
+        GetContentSummaryError,
+        GetContentSummaryResponse,
+        DocumentPreview,
+        Preview,
+        PreviewMedia,
+        RenderPreviewUiInvocationContext,
+        PublishPreviewUiInvocationContext,
+        RenderPreviewUiRequest,
+        ContentPublisherIntent
     }
 }
 export { content }
@@ -375,6 +493,13 @@ export { content }
  */
 declare type ContentMetadata = DesignContentMetadata;
 
+/**
+ * @beta
+ * 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';
+
 /**
  * @public
  * Main interface for implementing the ContentPublisher intent.
@@ -544,8 +669,31 @@ declare type ContentPublisherIntent = {
      */
     publishContent: (request: PublishContentRequest) => Promise<PublishContentResponse>;
 
+    /**
+     * @beta
+     * Extracts a structured summary of the post's content for historical display.
+     *
+     * Called at `createPost` / `updatePost` time while the app is loaded. The returned
+     * snapshot is stored with the post and used to render historical post views in the
+     * content planner (calendar, list views, insights) without re-invoking the app.
+     *
+     * The snapshot is frozen at write time — it reflects what was published, not the
+     * app's current rendering logic. If the app's payload shape or output types change
+     * later, historical views remain accurate.
+     *
+     * @param request - The `publishRef` and `outputType` for the post being published.
+     * @returns A promise resolving to the `ContentSummary`, or an error.
+     */
+    getContentSummary?: (request: GetContentSummaryRequest) => Promise<GetContentSummaryResponse>;
 };
 
+/**
+ * @beta
+ * A structured snapshot of a post's content for historical display.
+ * Discriminated by `type`.
+ */
+declare type ContentSummary = PostContentSummary | EmailContentSummary | AssetContentSummary | GenericContentSummary;
+
 declare namespace data {
     export {
         prepareDataConnector,
@@ -966,6 +1114,17 @@ declare type DesignEditorIntent = {
     render: () => void;
 };
 
+/**
+ * @beta
+ * The publishing destination when distinct from the connected account.
+ */
+declare type Destination = {
+    /** User-facing name (e.g. "Bob's Cool Page", "Product Newsletter"). */
+    displayName: string;
+    /** Avatar or icon URL for the destination. */
+    iconUrl?: string;
+};
+
 /**
  * @public
  * A set of dimensions.
@@ -1031,6 +1190,43 @@ declare interface DocumentPreviewLoading extends SizedPreview {
     status: 'loading';
 }
 
+/**
+ * @beta
+ * Thumbnail for a single page within a document preview.
+ */
+declare interface DocumentPreviewPage {
+    /**
+     * URL to the page thumbnail image.
+     */
+    url: string;
+    /**
+     * Width of the page thumbnail in pixels.
+     */
+    widthPx: number;
+    /**
+     * Height of the page thumbnail in pixels.
+     */
+    heightPx: number;
+}
+
+/**
+ * @beta
+ * Final state after a document preview has been upgraded. Contains thumbnail
+ * URLs for every selected page in the document.
+ */
+declare interface DocumentPreviewReady extends BasePreview {
+    kind: 'document';
+    status: 'ready';
+    /**
+     * Format of the per-page thumbnails.
+     */
+    format: 'png' | 'jpg';
+    /**
+     * Thumbnail pages for each page. Index corresponds to the page number.
+     */
+    pages: DocumentPreviewPage[];
+}
+
 /**
  * @public
  * Document preview with first page thumbnail available.
@@ -1054,6 +1250,20 @@ declare interface DocumentPreviewThumbnail extends SizedPreview {
     thumbnailUrl: string;
 }
 
+/**
+ * @beta
+ * Intermediate state while multi-page document thumbnails are being fetched
+ * via {@link requestPreviewUpgrade}. The single-page thumbnail remains
+ * available for display during the upgrade.
+ */
+declare interface DocumentPreviewUpgrading extends SizedPreview {
+    kind: 'document';
+    status: 'upgrading';
+    thumbnailFormat: 'png' | 'jpg';
+    /** The first-page thumbnail URL, available immediately. */
+    thumbnailUrl: string;
+}
+
 /**
  * @public
  * Document file requirements for a media slot.
@@ -1095,6 +1305,18 @@ declare interface DocumentSelection extends BaseSelection {
  */
 declare type DocumentSize = 'a4' | 'a3' | 'letter' | 'legal';
 
+/**
+ * @beta
+ * Content summary for email sends.
+ */
+declare type EmailContentSummary = BaseContentSummary & {
+    type: 'email';
+    /** Subject line. */
+    subject?: string;
+    /** Email body preview or preheader. */
+    body?: string;
+};
+
 /**
  * @public
  * Exported email file ready for publishing.
@@ -1194,6 +1416,54 @@ declare type ExactValueRange = {
     exact: number;
 };
 
+/**
+ * @beta
+ * Generic content summary for apps that don't fit a more specific type.
+ */
+declare type GenericContentSummary = BaseContentSummary & {
+    type: 'content';
+    /** Title or headline. */
+    title?: string;
+    /** Body text or description. */
+    body?: string;
+};
+
+/**
+ * @beta
+ * Successful response from getContentSummary.
+ */
+declare type GetContentSummaryCompleted = {
+    status: 'completed';
+    contentSummary: ContentSummary;
+};
+
+/**
+ * @beta
+ * Error response from getContentSummary.
+ */
+declare type GetContentSummaryError = AppError_2;
+
+/**
+ * @beta
+ * Request payload for the getContentSummary action.
+ */
+declare type GetContentSummaryRequest = {
+    /** The user's saved publish settings. Parse to retrieve app-specific state. */
+    publishRef?: string;
+    /**
+     * The output type selected for this publish operation.
+     *
+     * Use `id` to distinguish between output types.
+     */
+    outputType: OutputType;
+};
+
+/**
+ * @beta
+ * Response from getContentSummary.
+ */
+declare type GetContentSummaryResponse = GetContentSummaryCompleted | GetContentSummaryError;
+
 /**
  * @public
  * Successful result from `getDataTable` action.
@@ -2005,6 +2275,12 @@ declare type OutputType = {
      * such as a main image, thumbnail, or video.
      */
     mediaSlots: MediaSlot[];
+    /**
+     * @beta
+     * The type of content being published. When set, Canva uses this to tailor and improve the
+     * publish experience. When omitted, defaults to `'content'` (generic behavior).
+     */
+    contentNoun?: ContentNoun;
 };
 
 /**
@@ -2057,6 +2333,26 @@ declare type OutputTypeConfiguration = {
      * do not provide selection data when defining output types.
      */
     mediaSlots: Omit<MediaSlot, 'selection'>[];
+    /**
+     * @beta
+     * The type of content being published. When set, Canva uses this to tailor and improve the
+     * publish experience. When omitted, defaults to `'content'` (generic behavior).
+     */
+    contentNoun?: ContentNoun;
+};
+
+/**
+ * @beta
+ * Content summary for social media posts (e.g. Instagram, Facebook, LinkedIn, YouTube).
+ */
+declare type PostContentSummary = BaseContentSummary & {
+    type: 'post';
+    /** Post heading (e.g. YouTube title, LinkedIn article headline). */
+    title?: string;
+    /** Post caption or body text. */
+    body?: string;
+    /** Hashtags without the leading `#` (e.g. `["fashion", "design"]`). */
+    hashtags?: string[];
 };
 
 /**
@@ -2682,9 +2978,47 @@ declare type RenderSettingsUiRequest = {
     registerOnContextChange: (opts: {
         onContextChange: OnContextChange;
     }) => Disposer;
-
+    /**
+     * @beta
+     * Function to trigger a request for AI content.
+     *
+     * Use this function to trigger a request for AI content.
+     *
+     * @param request - The request for AI content.
+     * @returns A promise resolving to the AI content response with a status of 'completed' or 'cancelled'.
+     * @example Requesting AI content
+     * ```ts
+     * async function onGenerateCaption() {
+     *   const result = await requestAiContent({
+     *     type: 'social_caption',
+     *     currentValue: settings.caption,
+     *     fieldLabel: 'Caption',
+     *     hints: {
+     *       maxLength: 2200,
+     *     },
+     *   });
+     *
+     *   if (result.status !== 'completed') {
+     *     return;
+     *   }
+     *   const nextSettings = { ...settings, caption: result.value };
+     *   // ... set local state
+     *   await updatePublishSettings({
+     *     publishRef: JSON.stringify(nextSettings),
+     *     validityState: 'valid',
+     *   });
+     * }
+     * ```
+     */
+    requestAiContent: RequestAiContent;
 };
 
+/**
+ * @beta
+ * Function to trigger a request for AI content.
+ */
+declare type RequestAiContent = (request: AiContentRequest) => Promise<AiContentResponse>;
+
 /**
  * @public
  * Metadata specific to design content represented by a media selection.
@@ -2728,6 +3062,23 @@ declare interface SizedPreview extends BasePreview {
     heightPx: number;
 }
 
+/**
+ * @beta
+ * Request for social caption generation.
+ */
+declare type SocialCaptionRequest = BaseAiContentRequest & {
+    type: 'social_caption';
+    /**
+     * Hints for how the AI should generate the caption.
+     */
+    hints?: {
+        /**
+         * The maximum length of the caption.
+         */
+        maxLength?: number;
+    };
+};
+
 /**
  * @public
  * Cell containing a text value.

package/content/beta.d.ts

@@ -1,3 +1,49 @@
+/**
+ * @beta
+ * Cancelled response where the generation was not completed.
+ * We use only 'cancelled' since we don't expect app developers to handle any statuses further (e.g. blocked, failed).
+ * These will be handled on Canva's AI generation surface.
+ */
+export declare type AiContentCancelledResponse = {
+    status: 'cancelled';
+};
+
+/**
+ * @beta
+ * Completed response for AI content generation.
+ * The value is the AI content generated for the app.
+ */
+export declare type AiContentCompletedResponse = {
+    status: 'completed';
+    value: string;
+};
+
+/**
+ * @beta
+ * All possible AI content request types.
+ */
+export declare type AiContentRequest = SocialCaptionRequest;
+
+/**
+ * @beta
+ * All possible AI content response types.
+ */
+export declare type AiContentResponse = AiContentCompletedResponse | AiContentCancelledResponse;
+
+/**
+ * @beta
+ * All possible statuses for an AI content response.
+ *
+ */
+export declare type AiContentResponseStatus = 'completed' | 'cancelled';
+
+/**
+ * @beta
+ * Possible content type for AI content generation.
+ * Future types will be added here, e.g. 'hashtags'.
+ */
+export declare type AiContentType = 'social_caption';
+
 /**
  * @public
  * {@link PublishContentError} indicating a custom error occurred in your app's implementation.
@@ -54,6 +100,57 @@ export declare type AppError = {
     errorCause?: ErrorCause;
 };
 
+/**
+ * @beta
+ * Content summary for file-destination apps (e.g. Google Drive, Dropbox).
+ */
+export declare type AssetContentSummary = BaseContentSummary & {
+    type: 'asset';
+    /** Asset title or filename. */
+    title: string;
+    /** Folder path (e.g. "/My Projects/Designs"). */
+    path?: string;
+};
+
+/**
+ * @beta
+ * Base interface for AI content requests.
+ */
+declare type BaseAiContentRequest = {
+    /**
+     * The type of AI content generation which determines
+     * the kind of content the AI will generate.
+     */
+    type: AiContentType;
+    /**
+     * If a current value exists in the field, the AI content generation
+     * will be an edit-first experience.
+     * i.e. When the user has already entered a value in the field, the AI will
+     * generate a new value using the existing value as a starting point.
+     */
+    currentValue?: string;
+    /**
+     * The label chosen by the app developer for the field.
+     * It will be used in the UI to customize the copy.
+     * Required since it is essential context for the AI to generate the content.
+     */
+    fieldLabel: string;
+};
+
+/**
+ * @beta
+ * Base fields shared by all content summary variants.
+ */
+declare type BaseContentSummary = {
+    /**
+     * The account, page, or list this post was published to.
+     *
+     * For example, a Facebook Page, a mailing list, or a personal profile.
+     * Use the connected account's display name and icon when there is no distinct destination.
+     */
+    destination: Destination;
+};
+
 /**
  * @public
  * Base file requirement interface.
@@ -131,7 +228,14 @@ export declare interface BaseSelection {
 export declare type ContentMetadata = DesignContentMetadata;
 
 /**
- * @public
+ * @beta
+ * 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';
+
+/**
+ * @beta
  * Main interface for implementing the ContentPublisher intent.
  *
  * Implementing the ContentPublisher intent enables apps to publish contents to external platforms.
@@ -223,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,
-     * start with lightweight thumbnails and use `requestPreviewUpgrade` to load full
-     * video previews on demand to optimize performance.
+     * 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.
      *
      * @param request - Configuration and callbacks for the preview UI.
      *
-     * @example Rendering a preview UI with video optimization
+     * @example Rendering a preview UI with media optimization
      * ```ts
      * import { createRoot } from 'react-dom/client';
      * import type { RenderPreviewUiRequest } from '@canva/intents/content';
@@ -299,8 +403,31 @@ export declare type ContentPublisherIntent = {
      */
     publishContent: (request: PublishContentRequest) => Promise<PublishContentResponse>;
 
+    /**
+     * @beta
+     * Extracts a structured summary of the post's content for historical display.
+     *
+     * Called at `createPost` / `updatePost` time while the app is loaded. The returned
+     * snapshot is stored with the post and used to render historical post views in the
+     * content planner (calendar, list views, insights) without re-invoking the app.
+     *
+     * The snapshot is frozen at write time — it reflects what was published, not the
+     * app's current rendering logic. If the app's payload shape or output types change
+     * later, historical views remain accurate.
+     *
+     * @param request - The `publishRef` and `outputType` for the post being published.
+     * @returns A promise resolving to the `ContentSummary`, or an error.
+     */
+    getContentSummary?: (request: GetContentSummaryRequest) => Promise<GetContentSummaryResponse>;
 };
 
+/**
+ * @beta
+ * A structured snapshot of a post's content for historical display.
+ * Discriminated by `type`.
+ */
+export declare type ContentSummary = PostContentSummary | EmailContentSummary | AssetContentSummary | GenericContentSummary;
+
 /**
  * @public
  * Metadata specific to design content.
@@ -322,6 +449,17 @@ export declare interface DesignContentMetadata {
 
 }
 
+/**
+ * @beta
+ * The publishing destination when distinct from the connected account.
+ */
+export declare type Destination = {
+    /** User-facing name (e.g. "Bob's Cool Page", "Product Newsletter"). */
+    displayName: string;
+    /** Avatar or icon URL for the destination. */
+    iconUrl?: string;
+};
+
 /**
  * @public
  * A function that can be called to dispose of a callback.
@@ -338,13 +476,14 @@ export declare type Disposer = () => void;
 export declare type DocumentOutputFile = BaseOutputFile;
 
 /**
- * @public
+ * @beta
  * 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`.
  */
-export declare type DocumentPreview = DocumentPreviewLoading | DocumentPreviewThumbnail | DocumentPreviewError;
+export declare type DocumentPreview = DocumentPreviewLoading | DocumentPreviewThumbnail | DocumentPreviewUpgrading | DocumentPreviewReady | DocumentPreviewError;
 
 /**
  * @public
@@ -372,6 +511,43 @@ export declare interface DocumentPreviewLoading extends SizedPreview {
     status: 'loading';
 }
 
+/**
+ * @beta
+ * Thumbnail for a single page within a document preview.
+ */
+export declare interface DocumentPreviewPage {
+    /**
+     * URL to the page thumbnail image.
+     */
+    url: string;
+    /**
+     * Width of the page thumbnail in pixels.
+     */
+    widthPx: number;
+    /**
+     * Height of the page thumbnail in pixels.
+     */
+    heightPx: number;
+}
+
+/**
+ * @beta
+ * Final state after a document preview has been upgraded. Contains thumbnail
+ * URLs for every selected page in the document.
+ */
+export declare interface DocumentPreviewReady extends BasePreview {
+    kind: 'document';
+    status: 'ready';
+    /**
+     * Format of the per-page thumbnails.
+     */
+    format: 'png' | 'jpg';
+    /**
+     * Thumbnail pages for each page. Index corresponds to the page number.
+     */
+    pages: DocumentPreviewPage[];
+}
+
 /**
  * @public
  * Document preview with first page thumbnail available.
@@ -395,6 +571,20 @@ export declare interface DocumentPreviewThumbnail extends SizedPreview {
     thumbnailUrl: string;
 }
 
+/**
+ * @beta
+ * Intermediate state while multi-page document thumbnails are being fetched
+ * via {@link requestPreviewUpgrade}. The single-page thumbnail remains
+ * available for display during the upgrade.
+ */
+export declare interface DocumentPreviewUpgrading extends SizedPreview {
+    kind: 'document';
+    status: 'upgrading';
+    thumbnailFormat: 'png' | 'jpg';
+    /** The first-page thumbnail URL, available immediately. */
+    thumbnailUrl: string;
+}
+
 /**
  * @public
  * Document file requirements for a media slot.
@@ -436,6 +626,18 @@ export declare interface DocumentSelection extends BaseSelection {
  */
 export declare type DocumentSize = 'a4' | 'a3' | 'letter' | 'legal';
 
+/**
+ * @beta
+ * Content summary for email sends.
+ */
+export declare type EmailContentSummary = BaseContentSummary & {
+    type: 'email';
+    /** Subject line. */
+    subject?: string;
+    /** Email body preview or preheader. */
+    body?: string;
+};
+
 /**
  * @public
  * Exported email file ready for publishing.
@@ -535,6 +737,54 @@ export declare type ExactValueRange = {
     exact: number;
 };
 
+/**
+ * @beta
+ * Generic content summary for apps that don't fit a more specific type.
+ */
+export declare type GenericContentSummary = BaseContentSummary & {
+    type: 'content';
+    /** Title or headline. */
+    title?: string;
+    /** Body text or description. */
+    body?: string;
+};
+
+/**
+ * @beta
+ * Successful response from getContentSummary.
+ */
+export declare type GetContentSummaryCompleted = {
+    status: 'completed';
+    contentSummary: ContentSummary;
+};
+
+/**
+ * @beta
+ * Error response from getContentSummary.
+ */
+export declare type GetContentSummaryError = AppError;
+
+/**
+ * @beta
+ * Request payload for the getContentSummary action.
+ */
+export declare type GetContentSummaryRequest = {
+    /** The user's saved publish settings. Parse to retrieve app-specific state. */
+    publishRef?: string;
+    /**
+     * The output type selected for this publish operation.
+     *
+     * Use `id` to distinguish between output types.
+     */
+    outputType: OutputType;
+};
+
+/**
+ * @beta
+ * Response from getContentSummary.
+ */
+export declare type GetContentSummaryResponse = GetContentSummaryCompleted | GetContentSummaryError;
+
 /**
  * @public
  * Successful response from getting publish configuration.
@@ -899,6 +1149,12 @@ export declare type OutputType = {
      * such as a main image, thumbnail, or video.
      */
     mediaSlots: MediaSlot[];
+    /**
+     * @beta
+     * The type of content being published. When set, Canva uses this to tailor and improve the
+     * publish experience. When omitted, defaults to `'content'` (generic behavior).
+     */
+    contentNoun?: ContentNoun;
 };
 
 /**
@@ -951,6 +1207,26 @@ export declare type OutputTypeConfiguration = {
      * do not provide selection data when defining output types.
      */
     mediaSlots: Omit<MediaSlot, 'selection'>[];
+    /**
+     * @beta
+     * The type of content being published. When set, Canva uses this to tailor and improve the
+     * publish experience. When omitted, defaults to `'content'` (generic behavior).
+     */
+    contentNoun?: ContentNoun;
+};
+
+/**
+ * @beta
+ * Content summary for social media posts (e.g. Instagram, Facebook, LinkedIn, YouTube).
+ */
+export declare type PostContentSummary = BaseContentSummary & {
+    type: 'post';
+    /** Post heading (e.g. YouTube title, LinkedIn article headline). */
+    title?: string;
+    /** Post caption or body text. */
+    body?: string;
+    /** Hashtags without the leading `#` (e.g. `["fashion", "design"]`). */
+    hashtags?: string[];
 };
 
 /**
@@ -980,9 +1256,9 @@ export declare type PostPublishActionRedirect = {
 };
 
 /**
- * @public
+ * @beta
  *
- * Prepares a {@link ContentPublisherIntent|Content Publisher Intent}.
+ * Prepares a `ContentPublisherIntent`.
  *
  * @example
  * ```tsx
@@ -1007,8 +1283,8 @@ export declare type PostPublishActionRedirect = {
 export declare const prepareContentPublisher: (implementation: ContentPublisherIntent) => void;
 
 /**
- * @public
- * Preview item for an image or video.
+ * @beta
+ * Preview item for an image, video, document, or email.
  *
  * Check the `kind` and `status` properties to determine the type and state.
  */
@@ -1021,10 +1297,10 @@ export declare type Preview = ImagePreview | VideoPreview | DocumentPreview | Em
 export declare type PreviewKind = 'image' | 'video' | 'document' | 'email';
 
 /**
- * @public
+ * @beta
  * Preview media for a specific media slot.
  *
- * Contains preview URLs and metadata for images or videos in the design.
+ * Contains preview URLs and metadata for images, videos, documents, or emails in the design.
  */
 export declare type PreviewMedia = {
     /**
@@ -1180,7 +1456,7 @@ export declare type PublishErrorSettingsUiContext = {
 export declare type PublishFileFormat = 'png' | 'jpg' | 'mp4' | 'pdf_standard' | 'html_bundle' | 'html_standalone';
 
 /**
- * @public
+ * @beta
  * Initial payload provided from cache.
  */
 export declare type PublishPreviewUiInvocationContext = {
@@ -1308,21 +1584,21 @@ export declare type RemoteRequestFailedError = {
 };
 
 /**
- * @public
+ * @beta
  * 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;
 
 /**
- * @public
+ * @beta
  * Configuration required for rendering the preview UI.
  *
  * Provides callbacks for managing preview media and responding to preview updates.
  */
 export declare type RenderPreviewUiRequest = {
     /**
-     * @public
+     * @beta
      * The initial preview data and context provided when the preview UI is rendered.
      *
      * Contains the initial preview media, output type information, and any existing
@@ -1330,17 +1606,17 @@ export declare type RenderPreviewUiRequest = {
      */
     invocationContext: RenderPreviewUiInvocationContext;
     /**
-     * Callback to upgrade video thumbnail previews to full video media.
+     * Callback to upgrade thumbnail previews to their full media variant.
      *
-     * 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 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') {
@@ -1356,7 +1632,7 @@ export declare type RenderPreviewUiRequest = {
      *
      * - The design content changes
      * - The output type changes
-     * - Preview media is upgraded from thumbnail to full video
+     * - Preview media is upgraded from thumbnail to full media
      * - Export settings are modified
      *
      * Use this to update your preview UI in real-time as users modify their design.
@@ -1476,9 +1752,47 @@ export declare type RenderSettingsUiRequest = {
     registerOnContextChange: (opts: {
         onContextChange: OnContextChange;
     }) => Disposer;
-
+    /**
+     * @beta
+     * Function to trigger a request for AI content.
+     *
+     * Use this function to trigger a request for AI content.
+     *
+     * @param request - The request for AI content.
+     * @returns A promise resolving to the AI content response with a status of 'completed' or 'cancelled'.
+     * @example Requesting AI content
+     * ```ts
+     * async function onGenerateCaption() {
+     *   const result = await requestAiContent({
+     *     type: 'social_caption',
+     *     currentValue: settings.caption,
+     *     fieldLabel: 'Caption',
+     *     hints: {
+     *       maxLength: 2200,
+     *     },
+     *   });
+     *
+     *   if (result.status !== 'completed') {
+     *     return;
+     *   }
+     *   const nextSettings = { ...settings, caption: result.value };
+     *   // ... set local state
+     *   await updatePublishSettings({
+     *     publishRef: JSON.stringify(nextSettings),
+     *     validityState: 'valid',
+     *   });
+     * }
+     * ```
+     */
+    requestAiContent: RequestAiContent;
 };
 
+/**
+ * @beta
+ * Function to trigger a request for AI content.
+ */
+export declare type RequestAiContent = (request: AiContentRequest) => Promise<AiContentResponse>;
+
 /**
  * @public
  * Metadata specific to design content represented by a media selection.
@@ -1522,6 +1836,23 @@ export declare interface SizedPreview extends BasePreview {
     heightPx: number;
 }
 
+/**
+ * @beta
+ * Request for social caption generation.
+ */
+export declare type SocialCaptionRequest = BaseAiContentRequest & {
+    type: 'social_caption';
+    /**
+     * Hints for how the AI should generate the caption.
+     */
+    hints?: {
+        /**
+         * The maximum length of the caption.
+         */
+        maxLength?: number;
+    };
+};
+
 /**
  * @public
  * Successful response from updating the publish settings.

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

@@ -2,6 +2,12 @@
 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) {
@@ -17,4 +23,5 @@ 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

@@ -20,5 +20,5 @@ _export(exports, {
     }
 });
 const LATEST_VERSION = '2.5.0';
-const LATEST_VERSION_BETA = '2.5.1-beta.0';
+const LATEST_VERSION_BETA = '2.5.1-beta.2';
 const LATEST_VERSION_ALPHA = 'NONE';

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

@@ -1,3 +1,4 @@
 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.0';
+export const LATEST_VERSION_BETA = '2.5.1-beta.2';
 export const LATEST_VERSION_ALPHA = 'NONE';

package/package.json

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