@adobe/ccweb-add-on-sdk-types 1.18.0 → 1.20.0

package/package.json

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

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

@@ -82,6 +82,7 @@ declare namespace ApiConstants {
         StrokeType,
         TextAlignment,
         TextLayout,
+        TextScriptStyle,
         EditorEvent,
         VisualEffectType,
         ParagraphListType,
@@ -190,12 +191,14 @@ export declare class ArtboardNode extends VisualNode implements Readonly<IRectan
     get parent(): PageNode | undefined;
     /**
      * The width of the artboard.
-     * Shares the same dimensions as the parent page and other artboards within the parent page.
+     * Shares the same dimensions as the parent {@link PageNode} and other artboards within the parent {@link PageNode}.
+     * To resize an artboard, resize the parent {@link PageNode}.
      */
     get width(): number;
     /**
      * The height of the artboard.
-     * Shares the same dimensions as the parent page and other artboards within the parent page.
+     * Shares the same dimensions as the parent {@link PageNode} and other artboards within the parent {@link PageNode}.
+     * To resize an artboard, resize the parent {@link PageNode}.
      */
     get height(): number;
 }
@@ -261,6 +264,15 @@ declare interface BaseCharacterStyles {
      * Adds an underline to text.
      */
     underline: boolean;
+    /**
+     * URL for the hyperlink.
+     * A link can be removed by setting it to undefined
+     */
+    link: string | undefined;
+    /**
+     * Sets a superscript or subscript style.
+     */
+    baselineShift: TextScriptStyle;
 }
 
 /**
@@ -930,7 +942,19 @@ export declare const fonts: ExpressFonts;
  * GridCellNodes cannot be translated or rotated directly. This implementation translates and rotates the
  * MediaRectangle child of the GridCellNode when those actions are applied.
  */
-export declare class GridCellNode extends MediaContainerNode {}
+export declare class GridCellNode extends MediaContainerNode {
+    /**
+     * <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
+     * Always throws as it's not possible to clone a single grid slot.
+     * Use the parent grid container instead.
+     *
+     */
+    clone(): never;
+}
 
 /**
  * A GridLayoutNode represents a grid layout in the scenegraph. The GridLayoutNode is used to create
@@ -1007,27 +1031,14 @@ declare interface IFillableNode {
 }
 
 /**
- * ImageRectangleNode is a rectangular node that displays the image media part of a MediaContainerNode. It can only exist
- * within that container parent. Cropping can be adjusted by changing this media's position/rotation (as well as its mask
- * shape sibling node).
+ * ImageRectangleNode is a rectangular node that displays the image media part of a {@link MediaContainerNode}. It can only
+ * exist within that container parent. Cropping can be adjusted by changing this rectangle's position/rotation (as well as
+ * its maskShape sibling node).
  *
  * ImageRectangleNodes cannot be created directly; use {@link Editor.createImageContainer} to create the entire
  * container structure together.
  */
-export declare class ImageRectangleNode extends Node implements Readonly<IRectangularNode> {
-    /**
-     * Current width of the "full frame" image rectangle, which may not be fully visible due to cropping/clipping by the
-     * enclosing media container's maskShape. This size may be different from the original bitmap's size in pixels, but
-     * will always match its aspect ratio.
-     */
-    get width(): number;
-    /**
-     * Current height of the "full frame" image rectangle, which may not be fully visible due to cropping/clipping by the
-     * enclosing media container's maskShape. This size may be different from the original bitmap's size in pixels, but
-     * will always match its aspect ratio.
-     */
-    get height(): number;
-}
+export declare class ImageRectangleNode extends MediaRectangleNode {}
 
 /**
  * Interface for nodes with width and height properties.
@@ -1173,10 +1184,10 @@ export declare interface ListItem {}
 export declare class MediaContainerNode extends Node {
     /**
      * The rectangular node representing the entire, uncropped bounds of the media (e.g. image, GIFs, or video). The media's position and
-     * rotation can be changed, but it cannot be resized yet via this API. Media types other than images will yield a plain Node object
-     * for now.
+     * rotation can be changed, but it cannot be resized yet via this API. Media types other than images will yield an UnknownMediaRectangleNode
+     * object for now.
      */
-    get mediaRectangle(): ImageRectangleNode | Node;
+    get mediaRectangle(): ImageRectangleNode | UnknownMediaRectangleNode;
     /**
      * The mask used for cropping/clipping the media. The bounds of this shape are entire visible bounds of the container.
      * The shape's geometric properties (position, rotation, size, etc.) can be changed, but it cannot be replaced by a
@@ -1193,6 +1204,38 @@ export declare class MediaContainerNode extends Node {
     replaceMedia(media: BitmapImage): void;
 }
 
+/**
+ * MediaRectangleNode is the base class for a rectangular node that represents the *uncropped* media within a
+ * {@link MediaContainerNode}. Specific subclasses such as {@link ImageRectangleNode} exist for each media type and
+ * may provide additional media-specific APIs. Cropping can be adjusted by changing this rectangle's position/rotation
+ * (as well as its maskShape sibling node).
+ */
+export declare abstract class MediaRectangleNode extends Node implements Readonly<IRectangularNode> {
+    /**
+     * Current width of the "full frame" uncropped media, which may not be fully visible due to cropping/clipping by the
+     * enclosing media container's maskShape. This size may be different from the original image/video size in pixels, but
+     * will always match its aspect ratio.
+     */
+    get width(): number;
+    /**
+     * Current height of the "full frame" uncropped media, which may not be fully visible due to cropping/clipping by the
+     * enclosing media container's maskShape. This size may be different from the original image/video size in pixels, but
+     * will always match its aspect ratio.
+     */
+    get height(): number;
+    /**
+     * <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
+     * Always throws as it's not possible to clone just the media rectangle alone.
+     * Clone the entire parent MediaContainerNode instead.
+     *
+     */
+    clone(): never;
+}
+
 /**
  * A Node represents an object in the scenegraph, the document's visual content tree. Most tangible visual content is a
  * subclass of Node, but note that some abstract top-level structural nodes (such as PageNode) only extend the more
@@ -1334,6 +1377,15 @@ declare class Node extends VisualNode {
      * If the node doesn't have a fixed aspect ratio then this will resize the node to the given width and height.
      */
     resizeToCover(width: number, height: number): 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
+     * Creates an orphaned copy of this node, including all persistent attributes and descendants.
+     */
+    clone(): typeof this;
 }
 export { Node as Node };
 
@@ -1422,14 +1474,30 @@ export declare class PageNode extends BaseNode implements IRectangularNode {
     get artboards(): ArtboardList;
     /**
      * The width of the node.
-     * All Artboards within a page share the same dimensions.
+     *
+     * All Artboards within a page share the same dimensions, so changing this value will also automatically adjust the
+     * size of every child {@link ArtboardNode}.
+     *
+     * Note: changing the page's size does not adjust the size or position of any of visual content inside any child
+     * {@link ArtboardNode}. Callers should use their own layout logic to update the content for the new bounds as
+     * desired. For example, making the size smaller could result in content being clipped and hard to access if it is
+     * not adjusted to be visible again.
+     *
      * Must be at least {@link MIN_PAGE_DIMENSION} and no larger than {@link MAX_PAGE_DIMENSION}.
      */
     get width(): number;
     set width(value: number);
     /**
      * The height of the node.
-     * All Artboards within a page share the same dimensions.
+     *
+     * All Artboards within a page share the same dimensions, so changing this value will also automatically adjust the
+     * size of every child {@link ArtboardNode}.
+     *
+     * Note: changing the page's size does not adjust the size or position of any of visual content inside any child
+     * {@link ArtboardNode}. Callers should use their own layout logic to update the content for the new bounds as
+     * desired. For example, making the size smaller could result in content being clipped and hard to access if it is
+     * not adjusted to be visible again.
+     *
      * Must be at least {@link MIN_PAGE_DIMENSION} and no larger than {@link MAX_PAGE_DIMENSION}.
      */
     get height(): number;
@@ -2167,6 +2235,18 @@ declare interface TextRange {
     length: number;
 }
 
+/**
+ * Represents a text script style.
+ */
+export declare enum TextScriptStyle {
+    /** text appears at the standard baseline */
+    none = 0,
+    /** text appears above the baseline */
+    superscript = 1,
+    /** text appears below the baseline */
+    subscript = 2
+}
+
 /**
  * A ThreadedTextNode represents a text display frame in the scenegraph. It is a subset of longer text that flows across
  * multiple TextNode "frames". Because of this, the TextNode does not directly hold the text content and styles –
@@ -2175,6 +2255,15 @@ declare interface TextRange {
  * APIs are not yet available to create multi-frame text flows.
  */
 export declare class ThreadedTextNode extends TextNode {
+    /**
+     * <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
+     * Always throws as it's not possible to clone only a single "frame" of threaded text.
+     */
+    clone(): never;
     get nextTextNode(): ThreadedTextNode | undefined;
     get layout(): Readonly<AreaTextLayout>;
     /**
@@ -2199,6 +2288,13 @@ export declare class UnavailableFont extends BaseFont {
     get availableForEditing(): false;
 }
 
+/**
+ * UnknownMediaRectangleNode is a rectangular node that represents the *uncropped* media within a {@link MediaContainerNode}
+ * for cases where the media type is not yet supported by this API. Cropping can still be adjusted by changing this
+ * rectangle's position/rotation (as well as its maskShape sibling node).
+ */
+export declare class UnknownMediaRectangleNode extends MediaRectangleNode {}
+
 /**
  * An UnknownNode is a node with limited support and therefore treated as a leaf node.
  */

package/ui/ui-sdk.d.ts

@@ -38,6 +38,11 @@ export declare interface AddOn extends AddOnBase {
      * Local-persisted storage per user per addon.
      */
     readonly clientStorage: ClientStorage;
+
+    /**
+     * Current active entrypoint that the add-on is loaded in.
+     */
+    readonly entrypointType: EntrypointType;
 }
 
 /**
@@ -446,6 +451,40 @@ export declare type AuthorizeWithOwnRedirectRequest = AuthorizationRequest & {
     state: string;
 };
 
+/**
+ * Bit rate in bits per second
+ */
+export declare enum BitRate {
+    /**
+     * 4 Mbps
+     */
+    mbps4 = 4000000,
+    /**
+     * 8 Mbps
+     */
+    mbps8 = 8000000,
+    /**
+     * 10 Mbps
+     */
+    mbps10 = 10000000,
+    /**
+     * 12 Mbps
+     */
+    mbps12 = 12000000,
+    /**
+     * 15 Mbps
+     */
+    mbps15 = 15000000,
+    /**
+     * 25 Mbps
+     */
+    mbps25 = 25000000,
+    /**
+     * 50 Mbps
+     */
+    mbps50 = 50000000
+}
+
 /**
  * Bleed for the page.
  * In printing, bleed is printing that goes beyond the edge of where the sheet will be trimmed.
@@ -630,6 +669,8 @@ declare namespace Constants {
         RuntimeType,
         BleedUnit,
         VideoResolution,
+        FrameRate,
+        BitRate,
         EditorPanel,
         MediaTabs,
         ElementsTabs,
@@ -638,6 +679,7 @@ declare namespace Constants {
         DeviceClass,
         PlatformType,
         ColorPickerPlacement,
+        FileSizeLimitUnit,
         AuthorizationStatus
     };
 }
@@ -678,6 +720,10 @@ export declare interface CurrentUser {
      * @returns if the current user is a premium user
      */
     isPremiumUser(): Promise<boolean>;
+    /**
+     * @returns if the current user is an anonymous (guest) user
+     */
+    isAnonymousUser(): Promise<boolean>;
 }
 
 /**
@@ -1008,6 +1054,61 @@ export declare enum ElementsTabs {
     charts = "charts"
 }
 
+/**
+ * Types of entrypoints that add-ons support.
+ */
+export declare enum EntrypointType {
+    /**
+     * Widget entrypoint type.
+     */
+    WIDGET = "widget",
+    /**
+     * Script entrypoint type.
+     * add-ons with script entrypoint type can use only the document sandbox APIs.
+     */
+    SCRIPT = "script",
+    /**
+     * Panel entrypoint type.
+     */
+    PANEL = "panel",
+    /**
+     * Share entrypoint type.
+     */
+    SHARE = "share",
+    /**
+     * Content hub entrypoint type.
+     */
+    CONTENT_HUB = "content-hub",
+    /**
+     * Mobile media audio entrypoint type.
+     */
+    MOBILE_MEDIA_AUDIO = "mobile.media.audio",
+    /**
+     * Mobile your stuff files entrypoint type.
+     */
+    MOBILE_YOUR_STUFF_FILES = "mobile.your-stuff.files",
+    /**
+     * Mobile more entrypoint type.
+     */
+    MOBILE_MORE = "mobile.more",
+    /**
+     * Schedule entrypoint type.
+     */
+    SCHEDULE = "schedule",
+    /**
+     * Contextual replace entrypoint type.
+     */
+    CONTEXTUAL_REPLACE = "contextual.replace",
+    /**
+     * Contextual upload entrypoint type.
+     */
+    CONTEXTUAL_UPLOAD = "contextual.upload",
+    /**
+     * Contextual bulk create entrypoint type.
+     */
+    CONTEXTUAL_BULK_CREATE = "contextual.bulk-create"
+}
+
 export declare interface Field {
     /**
      * Label
@@ -1037,6 +1138,50 @@ export declare enum FieldType {
     text = "text"
 }
 
+/**
+ * Units for the file size limit.
+ */
+export declare enum FileSizeLimitUnit {
+    /**
+     * Kilobyte
+     */
+    KB = "KB",
+    /**
+     * Megabyte
+     */
+    MB = "MB"
+}
+
+/**
+ * Frame rate in frames per second
+ */
+export declare enum FrameRate {
+    /**
+     * 23.976 frames per second
+     */
+    fps23_976 = 23.976,
+    /**
+     * 24 frames per second
+     */
+    fps24 = 24,
+    /**
+     * 25 frames per second
+     */
+    fps25 = 25,
+    /**
+     * 29.97 frames per second
+     */
+    fps29_97 = 29.97,
+    /**
+     * 30 frames per second
+     */
+    fps30 = 30,
+    /**
+     * 60 frames per second
+     */
+    fps60 = 60
+}
+
 /**
  * Type of input dialog data passed from the add-on.
  */
@@ -1212,6 +1357,15 @@ export declare interface Mp4RenditionOptions extends RenditionOptions {
      * Custom Resolution (in pixel)
      */
     customResolution?: number;
+
+    /**
+     * Frame rate in frames per second
+     */
+    frameRate?: FrameRate;
+    /**
+     * Bit rate in mbps
+     */
+    bitRate?: BitRate;
 }
 
 /**
@@ -1514,6 +1668,15 @@ export declare interface PngRenditionOptions extends RenditionOptions {
         width?: number;
         height?: number;
     };
+
+    /**
+     * File size limit for the rendition
+     */
+    fileSizeLimit?: number;
+    /**
+     * Unit of the file size limit
+     */
+    fileSizeLimitUnit?: FileSizeLimitUnit;
 }
 
 /**
@@ -1889,6 +2052,14 @@ export declare enum VideoResolution {
      * FHD 1080p video resolution
      */
     fhd1080p = "1080p",
+    /**
+     * QHD 1440p video resolution
+     */
+    qhd1440p = "1440p",
+    /**
+     * UHD 4K video resolution
+     */
+    uhd2160p = "2160p",
     /**
      * Custom video resolution
      */