@canva/intents 2.0.1-beta.1 → 2.0.2-beta.3

package/asset/beta.d.ts

@@ -1 +1,236 @@
+/**
+ * @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/content/beta.d.ts

@@ -59,6 +59,10 @@ export declare interface BaseOutputFile {
    * Your app should download from this URL and upload to your platform.
    */
   url: string;
+  /**
+   * Metadata about the source content used to create this exported file.
+   */
+  contentMetadata: ContentMetadata;
 }
 
 /**
@@ -92,6 +96,12 @@ export declare interface BasePreview {
   heightPx: number;
 }
 
+/**
+ * @beta
+ * Metadata about the source content used to create an exported file.
+ */
+export declare type ContentMetadata = DesignContentMetadata;
+
 /**
  * @beta
  * Main interface for implementing the ContentPublisher intent.
@@ -264,12 +274,132 @@ export declare type ContentPublisherIntent = {
   ) => Promise<PublishContentResponse>;
 };
 
+/**
+ * @beta
+ * Metadata specific to design content.
+ */
+export declare interface DesignContentMetadata {
+  type: "design";
+  /**
+   * A signed JWT token containing the design id
+   */
+  designToken: string;
+  /**
+   * The pages that make up the exported metadata
+   */
+  pages: OutputPageMetadata[];
+}
+
 /**
  * @beta
  * A function that can be called to dispose of a callback.
  */
 export declare type Disposer = () => void;
 
+/**
+ * @beta
+ * Exported PDF file ready for publishing.
+ *
+ * Contains the final PDF document that should be uploaded to your platform.
+ * The document format is `pdf_standard` and the file is ready to use.
+ */
+export declare type DocumentOutputFile = BaseOutputFile;
+
+/**
+ * @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.
+ */
+export declare type DocumentPreview =
+  | DocumentPreviewLoading
+  | DocumentPreviewThumbnail
+  | DocumentPreviewError;
+
+/**
+ * @beta
+ * Document preview that failed to generate.
+ *
+ * Display an error state to the user.
+ */
+export declare interface DocumentPreviewError extends BasePreview {
+  kind: "document";
+  status: "error";
+  /**
+   * The error message to display to the user.
+   */
+  message: string;
+}
+
+/**
+ * @beta
+ * Document preview that is currently being generated.
+ *
+ * Display a loading state until the preview transitions to `"thumbnail"` or `"error"`.
+ */
+export declare interface DocumentPreviewLoading extends BasePreview {
+  kind: "document";
+  status: "loading";
+}
+
+/**
+ * @beta
+ * 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.
+ */
+export declare interface DocumentPreviewThumbnail extends BasePreview {
+  kind: "document";
+  status: "thumbnail";
+  /**
+   * Format of the thumbnail image.
+   */
+  thumbnailFormat: "png" | "jpg";
+  /**
+   * URL to the first page thumbnail.
+   *
+   * Display this lightweight image to preview the document content.
+   */
+  thumbnailUrl: string;
+}
+
+/**
+ * @beta
+ * Document file requirements for a media slot.
+ *
+ * Note: Document output types use image previews (PNG thumbnails) in the preview UI.
+ * The actual document file is only generated for the final output in OutputMedia.
+ *
+ * @example Document requirements
+ * ```ts
+ * const documentReq: DocumentRequirement = {
+ *   format: 'pdf_standard',
+ *   size: 'a4',
+ *   maxFileSizeMb: 50
+ * };
+ * ```
+ */
+export declare interface DocumentRequirement extends BaseFileRequirement {
+  /**
+   * Supported document export format.
+   * Currently supports PDF standard format.
+   */
+  format: "pdf_standard";
+  /**
+   * The document size of the export file.
+   */
+  size: DocumentSize;
+}
+
+/**
+ * @beta
+ * Document size for document exports.
+ */
+export declare type DocumentSize = "a4" | "a3" | "letter" | "legal";
+
 /**
  * @beta
  * Exact value range constraint.
@@ -345,9 +475,14 @@ export declare interface ImagePreviewError extends BasePreview {
   kind: "image";
   status: "error";
   /**
+   * @deprecated Use `message` instead.
    * Optional, user-facing error message to display in the preview UI.
    */
   userFacingErrorMessage?: string;
+  /**
+   * The error message to display to the user.
+   */
+  message: string;
 }
 
 /**
@@ -477,10 +612,12 @@ export declare type MediaSlot = {
    *   must satisfy the corresponding requirement for its media type
    * - To restrict the slot to a single media type, provide only that requirement
    * - `fileCount` applies across all files accepted by the slot regardless of media type
+   * - Document output types will show image previews (PNG thumbnail) in preview UI
    */
   accepts: {
     image?: ImageRequirement;
     video?: VideoRequirement;
+    document?: DocumentRequirement;
   };
 };
 
@@ -514,7 +651,10 @@ export declare type MinValueRange = {
  * @beta
  * Exported file ready for publishing.
  */
-export declare type OutputFile = ImageOutputFile | VideoOutputFile;
+export declare type OutputFile =
+  | ImageOutputFile
+  | VideoOutputFile
+  | DocumentOutputFile;
 
 /**
  * @beta
@@ -537,6 +677,21 @@ export declare type OutputMedia = {
   files: OutputFile[];
 };
 
+/**
+ * @beta
+ * Metadata about a specific page in the exported content.
+ */
+export declare type OutputPageMetadata = {
+  /**
+   * The unique identifier for the page.
+   */
+  pageId: string | undefined;
+  /**
+   * The position of the page within the design, starting from 1 for the first page.
+   */
+  pageNumber: number;
+};
+
 /**
  * @beta
  * Configuration for an output type.
@@ -650,13 +805,13 @@ export declare const prepareContentPublisher: (
  *
  * Check the `kind` and `status` properties to determine the type and state.
  */
-export declare type Preview = ImagePreview | VideoPreview;
+export declare type Preview = ImagePreview | VideoPreview | DocumentPreview;
 
 /**
  * @beta
  * Type of preview media.
  */
-export declare type PreviewKind = "image" | "video";
+export declare type PreviewKind = "image" | "video" | "document";
 
 /**
  * @beta
@@ -796,7 +951,7 @@ export declare type PublishContentResponse =
  * @beta
  * Supported file formats for publishing.
  */
-export declare type PublishFileFormat = "png" | "jpg" | "mp4";
+export declare type PublishFileFormat = "png" | "jpg" | "mp4" | "pdf_standard";
 
 /**
  * @beta
@@ -1098,9 +1253,14 @@ export declare interface VideoPreviewError extends BasePreview {
   kind: "video";
   status: "error";
   /**
+   * @deprecated Use `message` instead.
    * Optional, user-facing error message to display in the preview UI.
    */
   userFacingErrorMessage?: string;
+  /**
+   * The error message to display to the user.
+   */
+  message: string;
 }
 
 /**
@@ -1112,6 +1272,10 @@ export declare interface VideoPreviewError extends BasePreview {
 export declare interface VideoPreviewLoading extends BasePreview {
   kind: "video";
   status: "loading";
+  /**
+   * Video duration in milliseconds.
+   */
+  durationMs?: number;
 }
 
 /**

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

@@ -2,3 +2,13 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+Object.defineProperty(exports, "prepareUrlExpander", {
+    enumerable: true,
+    get: function() {
+        return prepareUrlExpander;
+    }
+});
+const _version = require("../version");
+const { canva_sdk } = window;
+const prepareUrlExpander = canva_sdk.intents.v1.asset.prepareUrlExpander;
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/asset', _version.LATEST_VERSION, 'beta');

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

@@ -8,6 +8,7 @@ Object.defineProperty(exports, "prepareContentPublisher", {
         return prepareContentPublisher;
     }
 });
+const _version = require("../version");
 const { canva_sdk } = window;
 const prepareContentPublisher = canva_sdk.intents.v1.content.prepareContentPublisher;
-window.__canva__?.sdkRegistration?.registerPackageVersion('intents/content', '2.0.1', 'beta');
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/content', _version.LATEST_VERSION, 'beta');

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+const _version = require("../version");
 _export_star(require("./public"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
@@ -16,4 +17,4 @@ function _export_star(from, to) {
     });
     return from;
 }
-window.__canva__?.sdkRegistration?.registerPackageVersion('intents/data', '2.0.1', 'beta');
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/data', _version.LATEST_VERSION, 'beta');

package/lib/cjs/sdk/intents/data/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+const _version = require("../version");
 _export_star(require("./public"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
@@ -16,4 +17,4 @@ function _export_star(from, to) {
     });
     return from;
 }
-window.__canva__?.sdkRegistration?.registerPackageVersion('intents/data', '2.0.0', 'ga');
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/data', _version.LATEST_VERSION, 'ga');

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+const _version = require("../version");
 _export_star(require("./public"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
@@ -16,4 +17,4 @@ function _export_star(from, to) {
     });
     return from;
 }
-window.__canva__?.sdkRegistration?.registerPackageVersion('intents/design', '2.0.1', 'beta');
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/design', _version.LATEST_VERSION, 'beta');

package/lib/cjs/sdk/intents/design/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+const _version = require("../version");
 _export_star(require("./public"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
@@ -16,4 +17,4 @@ function _export_star(from, to) {
     });
     return from;
 }
-window.__canva__?.sdkRegistration?.registerPackageVersion('intents/design', '2.0.0', 'ga');
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/design', _version.LATEST_VERSION, 'ga');

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

@@ -8,4 +8,4 @@ Object.defineProperty(exports, "LATEST_VERSION", {
         return LATEST_VERSION;
     }
 });
-const LATEST_VERSION = '2.0.0';
+const LATEST_VERSION = '2.0.2';

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

@@ -1 +1,4 @@
-export { };
+import { LATEST_VERSION } from '../version';
+const { canva_sdk } = window;
+export const prepareUrlExpander = canva_sdk.intents.v1.asset.prepareUrlExpander;
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/asset', LATEST_VERSION, 'beta');

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

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

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

@@ -1,2 +1,3 @@
+import { LATEST_VERSION } from '../version';
 export * from './public';
-window.__canva__?.sdkRegistration?.registerPackageVersion('intents/data', '2.0.1', 'beta');
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/data', LATEST_VERSION, 'beta');

package/lib/esm/sdk/intents/data/index.js

@@ -1,2 +1,3 @@
+import { LATEST_VERSION } from '../version';
 export * from './public';
-window.__canva__?.sdkRegistration?.registerPackageVersion('intents/data', '2.0.0', 'ga');
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/data', LATEST_VERSION, 'ga');

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

@@ -1,2 +1,3 @@
+import { LATEST_VERSION } from '../version';
 export * from './public';
-window.__canva__?.sdkRegistration?.registerPackageVersion('intents/design', '2.0.1', 'beta');
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/design', LATEST_VERSION, 'beta');

package/lib/esm/sdk/intents/design/index.js

@@ -1,2 +1,3 @@
+import { LATEST_VERSION } from '../version';
 export * from './public';
-window.__canva__?.sdkRegistration?.registerPackageVersion('intents/design', '2.0.0', 'ga');
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/design', LATEST_VERSION, 'ga');

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

@@ -1 +1 @@
-export const LATEST_VERSION = '2.0.0';
+export const LATEST_VERSION = '2.0.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canva/intents",
-  "version": "2.0.1-beta.1",
+  "version": "2.0.2-beta.3",
   "description": "The Canva Apps SDK Intents library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",
@@ -42,4 +42,4 @@
     }
   },
   "typings": "./beta.d.ts"
-}
+}