@canva/intents 2.1.2 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 2.2.0 - 2026-02-06
+
+### Added
+
+- Added invocation context to provide initial state when rendering UIs
+
 ## 2.1.2 - 2026-02-03
 
 ### Fixed

package/content/index.d.ts

@@ -986,6 +986,26 @@ export declare type PublishErrorSettingsUiContext = {
  */
 export declare type PublishFileFormat = 'png' | 'jpg' | 'mp4' | 'pdf_standard' | 'html_bundle';
 
+/**
+ * @public
+ * Initial payload provided from cache.
+ */
+export declare type PublishPreviewUiInvocationContext = {
+    /**
+     * Initial preview data and context provided when the preview UI is rendered.
+     */
+    reason: 'publish';
+    /**
+     * Initial preview media to display
+     * This will only be used for scheduling and not caching
+     */
+    previewMedia?: PreviewMedia[];
+    /** Information about the current output type being previewed */
+    outputType?: OutputType;
+    /** Current publish reference, if available */
+    publishRef?: string;
+};
+
 /**
  * @public
  * Validation state indicating whether publish settings are complete and valid.
@@ -1055,6 +1075,21 @@ export declare type PublishSettingsSettingsUiContext = {
     outputType: OutputType;
 };
 
+/**
+ * @public
+ * Initial payload provided from cache.
+ */
+export declare type PublishSettingsUiInvocationContext = {
+    /**
+     * Initial settings and context provided when the settings UI is rendered.
+     */
+    reason: 'publish';
+    /** Current publish reference to populate the UI, if any exist */
+    publishRef?: string;
+    /** Information about the current output type being configured */
+    outputType?: OutputType;
+};
+
 /**
  * @public
  * {@link PublishContentError} indicating failure of the remote request to the external platform.
@@ -1079,6 +1114,13 @@ export declare type RemoteRequestFailedError = {
     status: 'remote_request_failed';
 };
 
+/**
+ * @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;
+
 /**
  * @public
  * Configuration required for rendering the preview UI.
@@ -1086,7 +1128,14 @@ export declare type RemoteRequestFailedError = {
  * Provides callbacks for managing preview media and responding to preview updates.
  */
 export declare type RenderPreviewUiRequest = {
-
+    /**
+     * @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
+     * publish settings needed to properly display the preview interface.
+     */
+    invocationContext: RenderPreviewUiInvocationContext;
     /**
      * Callback to upgrade video thumbnail previews to full video media.
      *
@@ -1148,6 +1197,13 @@ export declare type RenderPreviewUiRequest = {
     }) => void) => Disposer;
 };
 
+/**
+ * @public
+ * Initial payload provided when the publish settings UI is rendered.
+ * Contains the current settings state needed to initialize the settings interface.
+ */
+export declare type RenderSettingsUiInvocationContext = PublishSettingsUiInvocationContext;
+
 /**
  * @public
  * Configuration for the publish settings UI.
@@ -1156,7 +1212,14 @@ export declare type RenderPreviewUiRequest = {
  * a custom publish settings interface where users configure platform-specific options.
  */
 export declare type RenderSettingsUiRequest = {
-
+    /**
+     * @public
+     * The initial settings and context provided when the settings UI is rendered.
+     *
+     * Contains any previously saved publish settings and information about the current output type being configured.
+     * Use this to restore the UI to its previous state or initialise it with appropriate defaults.
+     */
+    invocationContext: RenderSettingsUiInvocationContext;
     /**
      * Callback to save and validate the user's publish settings.
      *

package/index.d.ts

@@ -266,9 +266,13 @@ declare namespace content {
     export {
         prepareContentPublisher,
         ContentPublisherIntent,
+        RenderPreviewUiInvocationContext,
+        PublishPreviewUiInvocationContext,
         RenderPreviewUiRequest,
         Disposer,
         PublishContentRequest,
+        RenderSettingsUiInvocationContext,
+        PublishSettingsUiInvocationContext,
         RenderSettingsUiRequest,
         OnContextChange,
         SettingsUiContext,
@@ -2112,6 +2116,26 @@ declare type PublishErrorSettingsUiContext = {
  */
 declare type PublishFileFormat = 'png' | 'jpg' | 'mp4' | 'pdf_standard' | 'html_bundle';
 
+/**
+ * @public
+ * Initial payload provided from cache.
+ */
+declare type PublishPreviewUiInvocationContext = {
+    /**
+     * Initial preview data and context provided when the preview UI is rendered.
+     */
+    reason: 'publish';
+    /**
+     * Initial preview media to display
+     * This will only be used for scheduling and not caching
+     */
+    previewMedia?: PreviewMedia[];
+    /** Information about the current output type being previewed */
+    outputType?: OutputType;
+    /** Current publish reference, if available */
+    publishRef?: string;
+};
+
 /**
  * @public
  * Validation state indicating whether publish settings are complete and valid.
@@ -2181,6 +2205,21 @@ declare type PublishSettingsSettingsUiContext = {
     outputType: OutputType;
 };
 
+/**
+ * @public
+ * Initial payload provided from cache.
+ */
+declare type PublishSettingsUiInvocationContext = {
+    /**
+     * Initial settings and context provided when the settings UI is rendered.
+     */
+    reason: 'publish';
+    /** Current publish reference to populate the UI, if any exist */
+    publishRef?: string;
+    /** Information about the current output type being configured */
+    outputType?: OutputType;
+};
+
 /**
  * @public
  * {@link GetDataTableError} indicating failure to fetch data from the external source.
@@ -2220,6 +2259,13 @@ declare type RemoteRequestFailedError_2 = {
     status: 'remote_request_failed';
 };
 
+/**
+ * @public
+ * Initial payload provided when the preview UI is rendered.
+ * Contains the preview data and settings needed to initialize the preview interface.
+ */
+declare type RenderPreviewUiInvocationContext = PublishPreviewUiInvocationContext;
+
 /**
  * @public
  * Configuration required for rendering the preview UI.
@@ -2227,7 +2273,14 @@ declare type RemoteRequestFailedError_2 = {
  * Provides callbacks for managing preview media and responding to preview updates.
  */
 declare type RenderPreviewUiRequest = {
-
+    /**
+     * @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
+     * publish settings needed to properly display the preview interface.
+     */
+    invocationContext: RenderPreviewUiInvocationContext;
     /**
      * Callback to upgrade video thumbnail previews to full video media.
      *
@@ -2335,6 +2388,13 @@ declare type RenderSelectionUiRequest = {
     updateDataRef: (dataSourceRef: DataSourceRef) => Promise<UpdateDataRefResponse>;
 };
 
+/**
+ * @public
+ * Initial payload provided when the publish settings UI is rendered.
+ * Contains the current settings state needed to initialize the settings interface.
+ */
+declare type RenderSettingsUiInvocationContext = PublishSettingsUiInvocationContext;
+
 /**
  * @public
  * Configuration for the publish settings UI.
@@ -2343,7 +2403,14 @@ declare type RenderSelectionUiRequest = {
  * a custom publish settings interface where users configure platform-specific options.
  */
 declare type RenderSettingsUiRequest = {
-
+    /**
+     * @public
+     * The initial settings and context provided when the settings UI is rendered.
+     *
+     * Contains any previously saved publish settings and information about the current output type being configured.
+     * Use this to restore the UI to its previous state or initialise it with appropriate defaults.
+     */
+    invocationContext: RenderSettingsUiInvocationContext;
     /**
      * Callback to save and validate the user's publish settings.
      *

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

@@ -19,6 +19,6 @@ _export(exports, {
         return LATEST_VERSION_BETA;
     }
 });
-const LATEST_VERSION = '2.1.2';
-const LATEST_VERSION_BETA = '2.0.2-beta.3';
+const LATEST_VERSION = '2.2.0';
+const LATEST_VERSION_BETA = '2.1.3-beta.0';
 const LATEST_VERSION_ALPHA = 'NONE';

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

@@ -1,3 +1,3 @@
-export const LATEST_VERSION = '2.1.2';
-export const LATEST_VERSION_BETA = '2.0.2-beta.3';
+export const LATEST_VERSION = '2.2.0';
+export const LATEST_VERSION_BETA = '2.1.3-beta.0';
 export const LATEST_VERSION_ALPHA = 'NONE';

package/package.json

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