@canva/intents 2.5.0 → 2.5.1-beta.0

package/CHANGELOG.md

@@ -1,63 +1,46 @@
 # CHANGELOG
 
-## 2.5.0 - 2026-04-09
+## 2.5.1-beta.0 - 2026-04-10
 
 ### Changed
 
-- Increased the `publishRef` size limit from 5KB to 32KB, allowing apps to store more complex publishing settings.
+- Promotion intents from preview to ga
 
-### Added
-
-- Add selection metadata in MediaSelection
-- Enable apps to support transparent PNG exports in publish flow by adding optional allowTransparentBackground capability to ImageRequirement
-
-## 2.4.0 - 2026-03-23
+## 2.4.1-beta.0 - 2026-03-30
 
 ### Added
 
-- Launch the new Email media type to public, enabling publishing and selection of email pages.
+- Added `Selection`, `ImageSelection`, `VideoSelection`, `DocumentSelection`, and `EmailSelection` types representing metadata about user-selected media in a media slot
+- Added optional `selection` field to `MediaSlot`, populated by Canva when returning output types in Settings UI contexts
 
-## 2.3.1 - 2026-03-12
+## 2.2.1-beta.1 - 2026-02-27
 
 ### 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
+- Beta PreviewMedia and Preview types now correctly use full EmailPreview variants throughout RenderPreviewUiRequest, PublishPreviewUiInvocationContext, and ContentPublisherIntent.
 
-## 2.3.0 - 2026-03-06
+## 2.2.1-beta.0 - 2026-02-24
 
 ### Added
 
-- Promoted `Selection`, `ImageSelection`, `VideoSelection`, `DocumentSelection`, `EmailSelection` types and `MediaSlot.selection` field from beta to public
+- Added new html_standalone publish format for single html files
 
-## 2.2.0 - 2026-02-06
+## 2.1.3-beta.0 - 2026-02-03
 
 ### Added
 
-- Added invocation context to provide initial state when rendering UIs
-
-## 2.1.2 - 2026-02-03
+- Added a CHANGELOG.md to track changes
+- **Breaking:** Added enhanced error handling between `publishContent` and the `SettingsUi`
+- Added a new `PublishErrorClearedSettingsUiContext` for when the UI clears an error
+- Include design title in content metadata for the content publisher intent
+- Added `html_bundle` support in content publisher for email media slots
+- Added `InvoctationContext` to provide initial state for content publisher intent
+- Promoted the email requirements in content publisher from alpha to beta
 
 ### Fixed
 
-- Fix missing id and status fields in Content Publisher email preview type
-
-## 2.1.1 - 2026-01-30
-
-### Changed
-
-- Update NPM readme
-
-## 2.1.0 - 2026-01-30
-
-### Added
+- Fixed the `initTestEnvironment` API not mocking some intents
 
-- Added a CHANGELOG.md to track changes.
-- Added a test harness method `initTestEnvionment` which can be imported from `@canva/intents/test`
-- Promoted the Content Publisher Intent API from beta to general availability
-
-## 2.0.0 - 2025-06-12
-
-### Added
+## 2.0.2-beta.3 - 2025-11-11
 
-- Added the new `@canva/intents` package at version `2.0.0` with the brand new [Data Connector](https://www.canva.dev/docs/apps/data-connector/) intent.
+- Initial changelog for the Preview Intents SDK.

package/asset/beta.d.ts

@@ -0,0 +1,190 @@
+/**
+ * @beta
+ * Union of all supported asset types.
+ */
+export declare type Asset = ImageAsset | VideoAsset | AudioAsset | DocumentAsset | SheetAsset | GenericAsset;
+
+/**
+ * @beta
+ * Reference to an asset. Used as a unique identifier.
+ */
+export declare type AssetRef = string & {
+    __assetRef: never;
+};
+
+/**
+ * @beta
+ * Audio asset result structure.
+ */
+export declare type AudioAsset = BaseAsset & {
+    type: 'audio';
+    mimeType: 'audio/mpeg' | 'audio/mp4' | 'audio/x-m4a' | 'audio/mp3' | 'audio/ogg' | 'audio/wav' | 'audio/x-wav' | 'audio/x-pn-wav' | 'audio/wave' | 'audio/vnd.wave' | 'audio/webm';
+};
+
+/**
+ * @beta
+ * Base structure for an asset result.
+ */
+export declare type BaseAsset = {
+    name: string;
+    url: string;
+};
+
+/**
+ * @beta
+ * Document asset result structure.
+ */
+export declare type DocumentAsset = BaseAsset & {
+    type: 'document';
+    parentRef?: AssetRef;
+    mimeType: DocumentMimeType;
+};
+
+/**
+ * @beta
+ * Supported mimetype for document assets.
+ */
+export declare type DocumentMimeType = 'application/pdf' | 'application/msword' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'text/plain' | 'text/markdown';
+
+/**
+ * @beta
+ * Request parameters for URL expansion.
+ */
+export declare type ExpandUrlRequest = {
+    url: string;
+    requestConnection: () => Promise<void>;
+};
+
+/**
+ * @beta
+ * Response from URL expansion operation.
+ */
+export declare type ExpandUrlResponse = {
+    status: 'completed';
+    result: ExpandUrlResult;
+} | {
+    status: 'not_found';
+};
+
+/**
+ * @beta
+ * Result of completed URL expansion.
+ */
+export declare type ExpandUrlResult = {
+    ref: UrlExpanderAssetRef;
+};
+
+/**
+ * @beta
+ * Generic asset result structure.
+ * A generic asset is any file that is not already covered by other asset types such as ImageAsset etc.
+ * It is an error to pass a mime type that is covered by another asset type.
+ */
+export declare type GenericAsset = BaseAsset & {
+    type: 'generic';
+    mimeType: string;
+};
+
+/**
+ * @beta
+ * Completed response from content retrieval operation.
+ */
+export declare type GetContentCompletedResponse = {
+    status: 'completed';
+    result: {
+        type: 'asset';
+        asset: Asset;
+    };
+};
+
+/**
+ * @beta
+ * Error response from content retrieval operation.
+ */
+export declare type GetContentErrorResponse = {
+    status: 'app_error';
+    message: string;
+};
+
+/**
+ * @beta
+ * Request parameters for content retrieval.
+ */
+export declare type GetContentRequest = {
+    ref: UrlExpanderAssetRef;
+    requestConnection: () => Promise<void>;
+};
+
+/**
+ * @beta
+ * Response from content retrieval operation.
+ */
+export declare type GetContentResponse = GetContentCompletedResponse | GetContentErrorResponse;
+
+/**
+ * @beta
+ * Image asset result structure.
+ */
+export declare type ImageAsset = BaseAsset & {
+    type: 'image';
+    thumbnailUrl: string;
+    parentRef?: AssetRef;
+    mimeType: 'image/heic' | 'image/jpeg' | 'image/png' | 'image/svg+xml' | 'image/tiff' | 'image/webp';
+};
+
+/**
+ * @beta
+ *
+ * Prepares the `UrlExpanderIntent`.
+ */
+export declare const prepareUrlExpander: (implementation: UrlExpanderIntent) => void;
+
+/**
+ * @beta
+ * Sheet asset result structure.
+ */
+export declare type SheetAsset = BaseAsset & {
+    type: 'sheet';
+    parentRef?: AssetRef;
+    mimeType: SheetMimeType;
+};
+
+/**
+ * @beta
+ * Supported mimetype for sheet assets.
+ */
+export declare type SheetMimeType = 'text/csv' | 'application/vnd.ms-excel' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
+
+/**
+ * @beta
+ * Reference to an asset with metadata.
+ */
+export declare type UrlExpanderAssetRef = {
+    type: 'asset';
+    id: string;
+    name: string;
+    iconUrl?: string;
+    description?: string;
+};
+
+/**
+ * @beta
+ * Intent interface for URL expansion and content retrieval operations.
+ */
+export declare type UrlExpanderIntent = {
+    expandUrl(request: ExpandUrlRequest): Promise<ExpandUrlResponse>;
+    getContent(request: GetContentRequest): Promise<GetContentResponse>;
+};
+
+/**
+ * @beta
+ * Video asset result structure.
+ */
+export declare type VideoAsset = BaseAsset & {
+    type: 'video';
+    thumbnailImageUrl: string;
+    parentRef?: AssetRef;
+    mimeType: 'video/avi' | 'video/x-msvideo' | 'image/gif' | 'video/x-m4v' | 'video/x-matroska' | 'video/quicktime' | 'video/mp4' | 'video/mpeg' | 'video/webm';
+};
+
+export { }

package/asset/index.d.ts

@@ -1 +1 @@
-export { }
+export * from "./beta";