@adobe/ccweb-add-on-sdk-types 1.31.0 → 1.33.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/ccweb-add-on-sdk-types",
-  "version": "1.31.0",
+  "version": "1.33.0",
   "author": "Adobe",
   "license": "MIT",
   "description": "Type definitions for Adobe Creative Cloud Web Add-on SDK.",

package/sandbox/express-document-sdk.d.ts

@@ -573,11 +573,6 @@ export declare class ColorUtils {
 export declare const colorUtils: ExpressColorUtilsWrapper;
 
 /**
- * <InlineAlert slots="text" variant="warning"/>
- *
- * **IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`.
- *
- * @experimental
  * An interface for arbitrary resize operations regardless of whether given a width or height when using {@link Node.resize}.
  */
 declare interface CommonResizeOptions {
@@ -1445,7 +1440,36 @@ export declare class MediaContainerNode extends Node implements IMediaContainerN
      * different shape via this API.
      */
     get maskShape(): FillableNode;
+    /**
+     * Replace original media while preserving the existing filter effects. Any generative fill modifications will be removed.
+     * Crop settings are not preserved.
+     * @param media - New content to display. Currently must be a {@link BitmapImage}.
+     */
     replaceMedia(media: BitmapImage): void;
+    /**
+     * <InlineAlert slots="text" variant="warning"/>
+     *
+     * **IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`.
+     *
+     * @experimental
+     * Replace the current media with an edited version of the same media while preserving existing filter effects,
+     * per-element metadata, and asset provenance.
+     *
+     * Use this when the new blob is a modified version of the current image (e.g., an edited,
+     * recolored, or upscaled variant) rather than a completely unrelated image.
+     *
+     * The original per-element metadata (i.e., node.addOnData) and provenance (including attribution IDs, author
+     * information, source information such as Adobe Stock) are preserved.
+     *
+     * If the new image has the same aspect ratio as the original, the previous image’s crop settings
+     * remain unchanged.
+     *
+     * @param blob - A blob containing the transformed bitmap derived from the current media.
+     * @param options.preserveCutoutFilter - If true, preserves the existing cutout filter from
+     * the current media.
+     * @throws If the current media has been generated or modified by generative AI.
+     */
+    replaceMediaWithEditedImage(blob: Blob, options: ReplaceMediaWithEditedImageOptions): Promise<void>;
 }
 
 /**
@@ -1573,11 +1597,6 @@ declare class Node extends VisualNode implements INodeBounds {
     get blendMode(): BlendMode;
     set blendMode(value: BlendMode);
     /**
-     * <InlineAlert slots="text" variant="warning"/>
-     *
-     * **IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`.
-     *
-     * @experimental
      * Resizes this node based on the given {@link ResizeOptions}.
      */
     resize(options: ResizeOptions): void;
@@ -1960,6 +1979,14 @@ declare interface RemoveListStyleInput extends BaseParagraphListStyle {
  * **IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`.
  *
  * @experimental
+ * Options for {@link MediaContainerNode.replaceMediaWithEditedImage}.
+ */
+export declare interface ReplaceMediaWithEditedImageOptions {
+    /** If true, preserves the existing cutout filter from the current media. */
+    preserveCutoutFilter: boolean;
+}
+
+/**
  * An interface for rescaling the node based on a given height when using {@link Node.resize}.
  */
 declare interface RescaleProportionalToHeightOptions extends CommonResizeOptions {
@@ -1970,11 +1997,6 @@ declare interface RescaleProportionalToHeightOptions extends CommonResizeOptions
 }
 
 /**
- * <InlineAlert slots="text" variant="warning"/>
- *
- * **IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`.
- *
- * @experimental
  * An interface for rescaling the node based on a given width when using {@link Node.resize}.
  */
 declare interface RescaleProportionalToWidthOptions extends CommonResizeOptions {
@@ -1985,11 +2007,6 @@ declare interface RescaleProportionalToWidthOptions extends CommonResizeOptions
 }
 
 /**
- * <InlineAlert slots="text" variant="warning"/>
- *
- * **IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`.
- *
- * @experimental
  * An enum for controlling the behavior of {@link Node.resize}.
  */
 export declare enum ResizeBehavior {
@@ -2013,11 +2030,6 @@ export declare enum ResizeBehavior {
 }
 
 /**
- * <InlineAlert slots="text" variant="warning"/>
- *
- * **IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`.
- *
- * @experimental
  * A type union for providing the necessary arguments to {@link Node.resize}.
  *
  * Note that some nodes only support proportional resizing. In some cases this is always true (e.g. images) while in
@@ -2030,11 +2042,6 @@ export declare type ResizeOptions =
     | ResizeUsingHeightOptions;
 
 /**
- * <InlineAlert slots="text" variant="warning"/>
- *
- * **IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`.
- *
- * @experimental
  * An interface for resizing the node based on a given height when using {@link Node.resize}.
  */
 declare interface ResizeUsingHeightOptions extends CommonResizeOptions {
@@ -2045,11 +2052,6 @@ declare interface ResizeUsingHeightOptions extends CommonResizeOptions {
 }
 
 /**
- * <InlineAlert slots="text" variant="warning"/>
- *
- * **IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`.
- *
- * @experimental
  * An interface for resizing the node based on a given width when using {@link Node.resize}.
  */
 declare interface ResizeUsingWidthOptions extends CommonResizeOptions {

package/ui/ui-sdk.d.ts

@@ -175,7 +175,12 @@ export declare enum AppEvent {
     /**
      * triggered when the document's export permission status changes in review and approval workflow.
      */
-    documentExportAllowedChange = "documentExportAllowedChange"
+    documentExportAllowedChange = "documentExportAllowedChange",
+
+    /**
+     * triggered when the host delivers review settings (or related) updates to the add-on.
+     */
+    updateReviewSettings = "updateReviewSettings"
 }
 
 export declare type AppEventHandlerType<Event extends AppEventType> = (data: AppEventsTypeMap[Event]) => void;
@@ -197,6 +202,9 @@ declare interface AppEventsTypeMap {
     [AppEvent.documentPublishedLinkAvailable]: DocumentPublishedLinkAvailableEventData;
     [AppEvent.documentTitleChange]: DocumentTitleChangeEventData;
     [AppEvent.documentExportAllowedChange]: DocumentExportAllowedChangeEventData;
+
+    /** Delivered when the host sends review settings (or related) updates to the add-on. */
+    [AppEvent.updateReviewSettings]: undefined;
 }
 
 export declare type AppEventType = keyof AppEventsTypeMap & string;
@@ -888,6 +896,10 @@ export declare type DisableDragToDocument = () => void;
  * Represents the active document of the host application
  */
 declare interface Document_2 {
+    /**
+     * Review and Approval workflow
+     */
+    readonly reviewAndApproval: ReviewAndApproval;
     /**
      * Add image/PSD/AI/SVG assets to the current page
      */
@@ -1976,6 +1988,12 @@ export declare interface RenditionOptions extends RangeOptions {
     format: RenditionFormat;
 }
 
+/**
+ * Rendition options for review asset export.
+ * Mirrors the service-side RenditionOptions for Review and Approval workflow — no page range, full document only.
+ */
+export declare interface RenditionOptionsReviewAndApproval extends Omit<RenditionOptions, "range" | "pageIds"> {}
+
 /**
  * Rendition Type
  */
@@ -1986,6 +2004,47 @@ export declare enum RenditionType {
     page = "page"
 }
 
+/**
+ * Interface for Review and Approval workflow operations
+ */
+export declare interface ReviewAndApproval {
+    /**
+     * Sets the template review configuration
+     * @param options - Configuration options for template review
+     * @returns Promise resolving to the configuration response
+     */
+    setTemplateReviewConfig(options: SetTemplateReviewConfigOptions): Promise<void>;
+    /**
+     * Deletes the template review configuration
+     * @returns Promise that resolves when configuration is deleted
+     */
+    deleteTemplateReviewConfig(): Promise<void>;
+    /**
+     * Starts a review request
+     * @param options - Options for the review request
+     * @returns Promise resolving to the review request response
+     */
+    startReviewRequest(options: StartReviewRequestOptions): Promise<StartReviewRequestResponse>;
+    /**
+     * Cancels an ongoing review request
+     * @returns Promise that resolves when request is cancelled
+     */
+    cancelReviewRequest(): Promise<void>;
+    /**
+     * Completes an ongoing 3P add-on review request, hides any blocking progress modal, and reloads the document
+     * @returns Promise that resolves when the 3P add-on review is marked complete
+     */
+    completeReviewRequest(): Promise<void>;
+}
+
+export declare enum ReviewStatus {
+    REVIEW_NOT_STARTED = "REVIEW_NOT_STARTED",
+    REVIEW_REQUESTED_IN_PROGRESS = "REVIEW_REQUESTED_IN_PROGRESS",
+    REVIEW_REQUESTED = "REVIEW_REQUESTED",
+    AUTHOR_RE_EDIT = "AUTHOR_RE_EDIT",
+    APPROVED = "APPROVED"
+}
+
 export declare interface Runtime {
     readonly type: RuntimeType;
     /**
@@ -2063,6 +2122,14 @@ export declare interface SearchAction extends PanelAction {
     searchString: string;
 }
 
+/**
+ * Options for setting template review configuration
+ */
+export declare interface SetTemplateReviewConfigOptions {
+    /** Review Workflow ID to configure */
+    reviewWorkflowId: string;
+}
+
 export declare type SimpleDialogOptions = AlertDialogOptions | InputDialogOptions;
 
 /**
@@ -2097,6 +2164,33 @@ export declare interface SourceMimeTypeInfo {
     sourceMimeType?: SupportedMimeTypes;
 }
 
+/**
+ * Options for starting a review request
+ */
+export declare interface StartReviewRequestOptions {
+    /**
+     * Add-on's unique identifier for this review.
+     * Add-on generates this UUID to correlate with their external system.
+     */
+    reviewRequestId: string;
+    /** Rendition options specifying format for exporting review assets */
+    renditionOptions: RenditionOptionsReviewAndApproval;
+}
+
+/**
+ * Response from starting a review request
+ */
+export declare interface StartReviewRequestResponse {
+    /** URL for the add-on to POST review decisions to */
+    decisionSubmissionWebhookUrl: string;
+    /** ID of the document in the review workflow */
+    documentId: string;
+    /** Status after operation */
+    status: ReviewStatus;
+    /** Exported renditions of the document for review */
+    renditions: Blob[];
+}
+
 export declare enum SupportedMimeTypes {
     docx = "docx",
     gdoc = "gdoc"