@adobe/ccweb-add-on-sdk-types 1.11.0 → 1.13.0

package/package.json

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

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

@@ -30,61 +30,31 @@ import { mat2d } from "gl-matrix";
  */
 export declare class AddOnData {
     /**
-     * <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
      * Sets a private metadata entry on the node.
      * @param key - The key for the private metadata entry.
      * @param value - The value for the private metadata entry.
      */
     setItem(key: string, value: string): 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
      * Retrieves the private metadata value for the specified key on the node.
      * @param key - The key of the private metadata entry to retrieve.
      * @returns The value of the private metadata entry.
      */
     getItem(key: string): string | undefined;
     /**
-     * <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
      * Removes a single private metadata entry on the node.
      * @param key - The key of the private metadata entry to remove.
      */
     removeItem(key: string): 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
      * Clears all private metadata entries on the node.
      */
     clear(): 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
      * @returns an array of all keys for the private metadata entries on the node.
      */
     keys(): string[];
     /**
-     * <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
      * @returns an object with the remaining quota for private metadata on the node for this add-on.
      * The object contains the following properties:
      * - sizeInBytes: The remaining quota size in bytes (maximum 3KB).
@@ -113,7 +83,9 @@ declare namespace ApiConstants {
         TextAlignment,
         TextType,
         EditorEvent,
-        VisualEffectType
+        VisualEffectType,
+        ParagraphListType,
+        OrderedListNumbering
     };
 }
 
@@ -134,7 +106,13 @@ declare interface ApiModuleExport {
  */
 export declare interface AreaTextLayout {
     type: TextType.area;
+    /**
+     * The width of the text node in pixels.
+     */
     width: number;
+    /**
+     * The height of the text node in pixels.
+     */
     height: number;
 }
 
@@ -177,7 +155,7 @@ export declare class ArtboardList extends RestrictedItemList<ArtboardNode> {
  * Artboards are always contained on a {@link PageNode}; when a page contains multiple artboards, the artboards represent
  * "scenes" in a linear timeline sequence.
  *
- * To create new artboards, see {@link ArtboardList.addArtboard}.
+ * To create a new artboard, see {@link ArtboardList.addArtboard}.
  *
  * Please note that creating and deleting an artboard in a single frame will crash the editor.
  */
@@ -223,6 +201,9 @@ export declare class ArtboardNode extends VisualNode implements IRectangularNode
  */
 export declare interface AutoHeightTextLayout {
     type: TextType.autoHeight;
+    /**
+     * The width of the text node in pixels.
+     */
     width: number;
 }
 
@@ -231,11 +212,6 @@ export declare interface AutoHeightTextLayout {
  */
 export declare class AvailableFont extends BaseFont {
     /**
-     * <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
      * Whether the font is a premium Adobe font.
      */
     get isPremium(): boolean;
@@ -243,11 +219,6 @@ export declare class AvailableFont extends BaseFont {
 }
 
 /**
- * <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
  * Base character styles that can be applied to any range of characters.
  * Excludes font style, which differs between the getter-oriented {@link CharacterStyles} interface and the
  * setter-oriented {@link CharacterStylesInput}.
@@ -279,29 +250,14 @@ declare interface BaseCharacterStyles {
  */
 declare abstract class BaseFont {
     /**
-     * <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
      * The PostScript name of the font.
      */
     get postscriptName(): string;
     /**
-     * <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
      * The font family containing the font.
      */
     get family(): string;
     /**
-     * <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
      * The style of the font within the family.
      */
     get style(): string;
@@ -319,11 +275,6 @@ declare abstract class BaseFont {
  */
 export declare class BaseNode {
     /**
-     * <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
      * Get {@link AddOnData} reference for managing the private metadata on this node for this add-on.
      */
     get addOnData(): AddOnData;
@@ -367,6 +318,47 @@ export declare class BaseNode {
     removeFromParent(): 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
+ * BaseParagraphListStyle interface represents common properties shared between ordered and unordered list types.
+ */
+declare interface BaseParagraphListStyle {
+    /** A value from 0-8 that specifies indent/nesting level. Default is 0 if not provided. */
+    indentLevel?: 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
+ * Base paragraph styles that can be applied to an entire paragraph atomically.
+ * Excludes list style settings, which differ between the getter-oriented {@link ParagraphStyles} interface and the
+ * setter-oriented {@link ParagraphStylesRangeInput}.
+ */
+declare interface BaseParagraphStyles {
+    /**
+     * Space before paragraph (in points). It does not affect the first paragraph. It is additive to previous paragraph's spaceAfter
+     * (adjacent spacing does not merge/collapse together).
+     */
+    spaceBefore: number;
+    /**
+     * Space after paragraph (in points). It does not affect the last paragraph. It is additive to the next paragraph's spaceBefore
+     * (adjacent spacing does not merge/collapse together).
+     */
+    spaceAfter: number;
+    /**
+     * Spacing between lines, aka leading, expressed as a multiple of the font size's default spacing - ex. 1.5 = 150% of normal.
+     * It only affects the space *between* lines, not the space above the first line or below the last line.
+     */
+    lineSpacing: number;
+}
+
 /**
  * Represents a bitmap image resource. Use {@link Editor.loadBitmapImage} to create a BitmapImage, and then {@link Editor.createImageContainer}
  * to display it in the document by creating a MediaContainerNode structure.
@@ -428,11 +420,6 @@ declare enum 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
  * Text styles that can be applied to any range of characters, even a short span like a single word. (Contrast with
  * ParagraphStyles, which must be applied to an entire paragraph atomically).
  */
@@ -441,11 +428,6 @@ export declare interface CharacterStyles extends BaseCharacterStyles {
 }
 
 /**
- * <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
  * Variant of {@link CharacterStyles} with all style fields optional, used for applyCharacterStyles(). When using that API,
  * any fields not specified are left unchanged, preserving the text's existing styles.
  *
@@ -457,13 +439,7 @@ export declare interface CharacterStylesInput extends Partial<BaseCharacterStyle
 }
 
 /**
- * <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 set of {@link CharacterStyles} along with the range of characters they apply to. Seen in the characterStyleRanges
- * getter.
+ * A set of {@link CharacterStyles} along with the range of characters they apply to. Seen in the characterStyleRanges getter.
  *
  * Note that fonts returned by the getter are *not* guaranteed to be ones the user has rights to edit with, even though they
  * are visible in the document.
@@ -471,11 +447,6 @@ export declare interface CharacterStylesInput extends Partial<BaseCharacterStyle
 export declare interface CharacterStylesRange extends CharacterStyles, StyleRange {}
 
 /**
- * <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
  * Variant of {@link CharacterStylesRange} with all style fields optional, along with the range of characters they apply to.
  * Used for the characterStyleRanges setter. When invoking the setter, any fields not specified are reset to their defaults.
  *
@@ -585,6 +556,22 @@ export declare interface ContainerNode extends VisualNode {
  * Contains the user's current selection state, indicating the content they are focused on.
  */
 export declare class Context {
+    /**
+     * Registers a handler for editor events such as selection change.
+     * The registered callback will be invoked when the specified event occurs.
+     * Note: Do not attempt to make changes to the document in response to a selection change callback because it may destabilize the application.
+     * @param eventName - an editor event name.
+     * @param callback - a callback to be registered for an editor event.
+     * @returns a unique ID for the registered event handler.
+     */
+    on(eventName: EditorEvent, callback: EditorEventHandler): EventHandlerId;
+    /**
+     * Unregisters handlers for editor events like selection change.
+     * @param eventName - an editor event name.
+     * @param handlerId - a unique ID returned by `editor.context.on` API.
+     * Callback that was previously registered will be removed and will no more be invoked when the event occurs.
+     */
+    off(eventName: EditorEvent, handlerId: EventHandlerId): void;
     /**
      * @returns the current selection. Nodes that are locked or otherwise non-editable are never included in the selection.
      */
@@ -620,32 +607,6 @@ export declare class Context {
      * @returns The currently viewed page.
      */
     get currentPage(): PageNode;
-    /**
-     * <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
-     * Registers a handler for editor events such as selection change.
-     * The registered callback will be invoked when the specified event occurs.
-     * Note: Do not attempt to make changes to the document in response to a selection change callback because it may destabilize the application.
-     * @param eventName - an editor event name.
-     * @param callback - a callback to be registered for an editor event.
-     * @returns a unique ID for the registered event handler.
-     */
-    on(eventName: EditorEvent, callback: EditorEventHandler): EventHandlerId;
-    /**
-     * <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
-     * Unregisters handlers for editor events like selection change.
-     * @param eventName - an editor event name.
-     * @param handlerId - a unique ID returned by `editor.context.on` API.
-     * Callback that was previously registered will be removed and will no more be invoked when the event occurs.
-     */
-    off(eventName: EditorEvent, handlerId: EventHandlerId): void;
 }
 
 /**
@@ -795,11 +756,6 @@ export declare class Editor {
 export declare const editor: ExpressEditor;
 
 /**
- * <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
  * This enum represents the supported editor events.
  */
 export declare enum EditorEvent {
@@ -807,11 +763,6 @@ export declare enum EditorEvent {
 }
 
 /**
- * <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
  * This type represents function signature for the editor event handler callback.
  */
 export declare type EditorEventHandler = () => void;
@@ -843,11 +794,6 @@ export declare class EllipseNode extends FillableNode {
 }
 
 /**
- * <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
  * This type represents unique id of each event handler callback that is registered.
  */
 export declare type EventHandlerId = string;
@@ -871,7 +817,7 @@ declare class ExpressFonts extends Fonts {}
 export declare class ExpressRootNode extends BaseNode {
     /**
      * The pages of the document. All visual content is contained on artboards within the pages.
-     * To create new pages, see {@link PageList.addPage}.
+     * To create a new page, see {@link PageList.addPage}.
      */
     get pages(): PageList;
 }
@@ -930,11 +876,6 @@ declare enum FillType {
 }
 
 /**
- * <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
  * Represents a font in the document.
  *
  * Note: not every font encountered in the existing content is available for editing.
@@ -947,11 +888,6 @@ export declare type Font = AvailableFont | UnavailableFont;
  */
 export declare class Fonts {
     /**
-     * <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
      * Get an {@link AvailableFont} that exactly matches the given PostScript name, if any. Only fonts that the user has permission to use
      * for editing content are returned, so the result of this call is always safe to apply to a {@link TextContentModel}'s styles.
      *
@@ -1023,6 +959,9 @@ export declare class GroupNode extends Node implements ContainerNode {
      */
     set maskShape(mask: FillableNode | undefined);
     /**
+     * {@inheritDoc VisualNode.boundsLocal}
+     *
+     * @returns
      * Note: If this group has a maskShape, group's bounds are always identical to the maskShape's, regardless of the
      * group's other content.
      */
@@ -1126,7 +1065,7 @@ export declare class ItemList<T extends ListItem> extends RestrictedItemList<T>
 /**
  * A LineNode represents a simple vector line in the scenegraph – a single straight-line segment.
  *
- * To create new lines, see {@link Editor.createLine}.
+ * To create a new line, see {@link Editor.createLine}.
  */
 export declare class LineNode extends StrokableNode {
     static readonly DEFAULT_START_X = 0;
@@ -1313,7 +1252,9 @@ declare class Node extends VisualNode {
     get transformMatrix(): mat2d;
     /**
      * The node's lock/unlock state. Locked nodes are excluded from the selection (see {@link Context.selection}), and
-     * cannot be edited by the user unless they are unlocked first.
+     * cannot be edited by the user in the UI unless they are unlocked first. Operations on locked nodes using the API
+     * are permitted. However, please consider if modifying a locked node would align with user expectations
+     * before using the API to make changes to locked nodes.
      */
     get locked(): boolean;
     set locked(locked: boolean);
@@ -1326,10 +1267,61 @@ declare class Node extends VisualNode {
 }
 export { Node as Node };
 
+/**
+ * <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
+ * Numbering types used to display ordered lists: 1, A, a, I, i 01, 001.
+ */
+export declare enum OrderedListNumbering {
+    numeric = 1,
+    uppercaseAlpha = 2,
+    lowercaseAlpha = 3,
+    uppercaseRomanNum = 4,
+    lowercaseRomanNum = 5,
+    singleZeroPrefixNumeric = 7,
+    doubleZeroPrefixNumeric = 8
+}
+
+/**
+ * <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
+ * OrderedListStyle represents the style of an ordered list.
+ */
+export declare type OrderedListStyle = Required<OrderedListStyleInput>;
+
+/**
+ * <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
+ * Interface for specifying an ordered list style, such as a numbered list.
+ */
+export declare interface OrderedListStyleInput extends BaseParagraphListStyle {
+    type: ParagraphListType.ordered;
+    /**
+     * The numbering style to use. If undefined, it defaults to a different type depending on the paragraph's indent level.
+     * The defaults for increasing indent are 1, a, i, I, and then they repeat.
+     * These markers and the prefix/postfix strings (if any) are displayed using the same font as the start of the
+     * paragraph's text content.
+     */
+    numbering?: OrderedListNumbering;
+    /** Additional string to display before each sequence number/letter, e.g. "(" */
+    prefix?: string;
+    /** Additional string to display after each sequence number/letter, e.g. ")" or "." */
+    postfix?: string;
+}
+
 /**
  * PageList represents an ordered list of PageNodes, all of which are children of the root node of the document's "scenegraph"
  * artwork tree (see {@link ExpressRootNode}). A page contains one or more artboards, representing "scenes" in a linear timeline
- * sequence. Those artboards in turn contain all the visual content of the document.
+ * sequence. Those artboards, in turn, contain all the visual content of the document.
  *
  * PageList also provides APIs for adding/removing pages from the document. PageList is never empty: it is illegal to
  * remove the last remaining page from the list.
@@ -1348,7 +1340,7 @@ export declare class PageList extends RestrictedItemList<PageNode> {
 /**
  * A PageNode represents a page in the document, a child of the root node of the document's "scenegraph" artwork tree
  * (see {@link ExpressRootNode}). A page contains one or more artboards, representing "scenes" in a linear timeline
- * sequence. Those artboards in turn contain all the visual content of the document.
+ * sequence. Those artboards, in turn, contain all the visual content of the document.
  *
  * To create new pages, see {@link PageList.addPage}.
  */
@@ -1384,6 +1376,69 @@ export declare class PageNode extends BaseNode implements Readonly<IRectangularN
     cloneInPlace(): PageNode;
 }
 
+/**
+ * <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
+ * Indicates list type: see {@link UnorderedListStyleInput} and {@link OrderedListStyleInput}.
+ */
+export declare enum ParagraphListType {
+    unordered = 0,
+    ordered = 1
+}
+
+/**
+ * <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
+ * Text styles that must be applied to an entire paragraph atomically. (Contrast with CharacterStyles which can be applied to
+ * any range of characters, even a short span like one single word).
+ */
+export declare interface ParagraphStyles extends BaseParagraphStyles {
+    list?: OrderedListStyle | UnorderedListStyle;
+}
+
+/**
+ * <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
+ * The variant of {@link ParagraphStyles} with all optional style fields is used to apply ParagraphStyles(). When using that API,
+ * any fields not specified are left unchanged, preserving the text's existing styles.
+ */
+export declare interface ParagraphStylesInput extends Partial<BaseParagraphStyles> {
+    list?: OrderedListStyleInput | UnorderedListStyleInput;
+}
+
+/**
+ * <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 set of {@link ParagraphStyles} and the text range they apply to. It is seen in the paragraphStyleRanges getter.
+ */
+export declare interface ParagraphStylesRange extends ParagraphStyles, StyleRange {}
+
+/**
+ * <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 variant of {@link ParagraphStylesRange} with all style fields optional and the text range they apply to. Used for the
+ * paragraphStyleRanges setter. When invoking the setter, any fields not specified are reset to their defaults.
+ *
+ * Paragraphs are separated by newline characters (`\n`). The ranges specified here should align with
+ * those boundaries.
+ */
+export declare interface ParagraphStylesRangeInput extends ParagraphStylesInput, StyleRange {}
+
 /**
  * A PathNode represents a generic vector path shape in the scenegraph. Paths cannot be edited through this API
  * yet, only read.
@@ -1461,7 +1516,7 @@ export declare class ReadOnlyItemList<T extends ListItem> {
     /**
      * All items in the list, as a static array. Mutations that occur later are not reflected in an array returned earlier.
      */
-    toArray(): Readonly<T[]>;
+    toArray(): readonly T[];
 }
 
 declare interface Rect {
@@ -1479,7 +1534,7 @@ export declare interface RectangleGeometry {
 /**
  * A RectangleNode represents a rectangle shape in the scenegraph.
  *
- * To create new rectangles, see {@link Editor.createRectangle}.
+ * To create a new rectangle, see {@link Editor.createRectangle}.
  */
 export declare class RectangleNode extends FillableNode implements IRectangularNode {
     /**
@@ -1770,11 +1825,6 @@ export declare class TextContentModel {
      */
     get id(): string;
     /**
-     * <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
      * Get ordered list of all {@link TextNode}s that display this text content in the scenegraph. The text content
      * starts in the first  {@link TextNode} "frame", and then flows into the second node once it has filled the first one. The ending of the
      * text content may not be visible at all, if the last {@link TextNode} "frame" is not large enough to accommodate it.
@@ -1788,12 +1838,7 @@ export declare class TextContentModel {
     get text(): string;
     set text(textContent: string);
     /**
-     * <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
-     * The character styles applied to different ranges of this text content. When setting character styles, any style
+     * The character styles are applied to different ranges of this text content. When setting character styles, any style
      * properties that are not provided are reset to their defaults (contrast to {@link applyCharacterStyles} which
      * preserves the text's existing styles for any fields not specified). When *getting* styles, all fields are always
      * provided.
@@ -1809,14 +1854,36 @@ export declare class TextContentModel {
      * **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
+     * The styles applied to different paragraphs of this text content.
+     */
+    get paragraphStyleRanges(): readonly ParagraphStylesRange[];
+    /**
+     * <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
+     * Apply styles to different paragraphs of this text content. Any style properties that are not provided are reset to their defaults.
+     * When **getting** styles, all properties are always provided.
+     *
+     * Paragraphs are separated by newline characters (`\n`). The ranges specified here should align with
+     * those boundaries. If multiple ranges provided overlap a single paragraph, the first one to overlap is applied to the
+     * entire paragraph.
+     *
+     * @throws if the text content contains fonts unavailable to the current user and an ordered-list style is being applied.
+     */
+    set paragraphStyleRanges(styles: readonly ParagraphStylesRangeInput[]);
+    /**
      * Apply one or more styles to the characters in the given range, leaving any style properties that were not specified
      * unchanged. Does not modify any styles in the text outside this range. Contrast to the {@link characterStyleRanges}
      * setter, which specifies new style range(s) for the entire text at once, and resets any unspecified properties back to
      * default styles.
 
      * @param styles - The styles to apply.
-     * @param range - The start and length of character sequence to which the styles should be applied.
-     * If not specified the styles will be applied to the entire piece of text content flow.
+     * @param range -The start and length of the character sequence to which the styles should be applied.
+     * The styles will be applied to the entire text content flow if not specified.
+     * If the specified range doesn't align well with the paragraph boundaries, the range will be expanded to cover the
+     * entire paragraphs, it overlaps.
      */
     applyCharacterStyles(
         styles: CharacterStylesInput,
@@ -1825,6 +1892,28 @@ export declare class TextContentModel {
             length: 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
+     * Apply one or more styles to the paragraphs in the given range, leaving any style properties that were not specified
+     * unchanged. Does not modify any styles in the text outside this range. Contrast to the {@link paragraphStyleRanges}
+     * setter, which specifies new style range(s) for the entire text at once, and resets any unspecified properties back to
+     * default styles.
+
+     * @param styles - The styles to apply.
+     * @param range - The start and length of character sequence to which the styles should be applied.
+     * If not specified the styles will be applied to the entire piece of text content flow.
+     */
+    applyParagraphStyles(
+        styles: ParagraphStylesInput,
+        range?: {
+            start: number;
+            length: number;
+        }
+    ): void;
 }
 
 /**
@@ -1836,6 +1925,24 @@ export declare class TextContentModel {
  * multi-frame text flows.
  */
 export declare class TextNode extends Node {
+    /**
+     * {@inheritDoc VisualNode.centerPointLocal}
+     *
+     * @returns
+     * Note: The center of the orphaned TextNode may be different from the center of the node placed on a page. It is
+     * recommended to use this property only when the node is placed on a page.
+     *
+     */
+    get centerPointLocal(): Readonly<Point>;
+    /**
+     * {@inheritDoc VisualNode.topLeftLocal}
+     *
+     * @returns
+     * Note: The top-left of the orphaned TextNode may be different from the top-left of the node placed on a
+     * page. It is recommended to use this property only when the node is placed on a page.
+     *
+     */
+    get topLeftLocal(): Readonly<Point>;
     /**
      * The model containing the complete text string and its styles, only part of which may be visible within the bounds of
      * this specific TextNode "frame." The full text content flow may be split across multiple frames, and/or it may be clipped if a
@@ -1849,11 +1956,6 @@ export declare class TextNode extends Node {
      */
     get fullContent(): TextContentModel;
     /**
-     * <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
      * The next TextNode that text overflowing this node will spill into, if any. If undefined and this TextNode is fixed size
      * ({@link AreaTextLayout}), any text content that does not fit within this node's area will be clipped.
      *
@@ -1880,11 +1982,6 @@ export declare class TextNode extends Node {
     get textAlignment(): TextAlignment;
     set textAlignment(alignment: TextAlignment);
     /**
-     * <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
      * @returns The list of visual effects applied to the TextNode.
      */
     get visualEffects(): readonly VisualEffectType[];
@@ -1906,10 +2003,11 @@ export declare class TextNode extends Node {
      * Sets the layout mode of the TextNode "frame."
      *
      * If this TextNode is part of a multi-frame text content flow, it must be configured to use {@link AreaTextLayout}. Other
-     * layout modes are only available for single-frame text.
+     * layout modes, except for {@link AreaTextLayout}, are only available for single-frame text.
      *
      * @throws if changing text layout to/from {@link TextType.magicFit} or {@link TextType.circular} layout when the text contains font(s) unavailable to the current user.
-     * @throws if TextNode is part of a multi-frame text content flow and the layout is not {@link AreaTextLayout}.
+     * @throws if {@link TextNode} is part of a multi-frame text content flow and the layout is not {@link AreaTextLayout}.
+     * @throws if {@link TextNode} is not a part of a multi-frame text content flow and the layout is {@link AreaTextLayout}.
      */
     set layout(layout: PointTextLayout | AutoHeightTextLayout | AreaTextLayout);
 }
@@ -1945,6 +2043,37 @@ export declare class UnavailableFont extends BaseFont {
  */
 export declare class UnknownNode extends Node {}
 
+/**
+ * <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
+ * UnorderedListStyle represents the style of an unordered list.
+ */
+export declare type UnorderedListStyle = Required<UnorderedListStyleInput>;
+
+/**
+ * <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
+ * Interface for specifying an unordered list style, such as a bullet list.
+ */
+export declare interface UnorderedListStyleInput extends BaseParagraphListStyle {
+    type: ParagraphListType.unordered;
+    /**
+     * Marker symbol to use. If undefined, it defaults to a different symbol depending on the paragraph's indent level.
+     * The defaults for increasing indent are: •, ◦, ◼, ◻, and then they repeat.
+     * Markers are always displayed using the default font (SourceSans3 Regular), regardless of the font(s) used in the
+     * paragraph's text content. A default marker is used instead if the default font does not support the symbol.
+     *
+     * Text or Unicode glyphs are accepted to represent the list marker.
+     */
+    marker?: string;
+}
+
 /**
  * <InlineAlert slots="text" variant="warning"/>
  *
@@ -1962,11 +2091,11 @@ export declare interface UnsupportedTextLayout {
 export declare class Viewport {
     /**
      * Adjusts the viewport to make the node's bounds visible on-screen, assuming all bounds are within the artboard bounds.
-     * Makes the node's {@link ArtboardNode} or {@link PageNode} visible if they were not already
-     * (which may result in {@link Context.selection} being cleared). It is strongly recomended
-     * to further draw user's attention to the node by setting it as the {@link Context.selection} following this call.
+     * Makes the node's {@link ArtboardNode} or {@link PageNode} visible if they were not already visible
+     * (which may result in {@link Context.selection} being cleared). It is strongly recommended
+     * to further draw user's attention to the node, set it as the {@link Context.selection} following this call.
      *
-     * After this call, the value of {@link Context.insertionParent} will always be the node's containing {@link ArtboardNode}.
+     * After this call, the value of {@link Context.insertionParent} will always be the node containing {@link ArtboardNode}.
      *
      * Note that the node might still not appear visible if:
      *   - Its animation settings make it invisible at the beginning of the {@link ArtboardNode} "scene".
@@ -1979,11 +2108,6 @@ export declare class Viewport {
 export declare const viewport: ExpressViewport;
 
 /**
- * <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
  * Visual effects that can be applied to a text node.
  */
 declare enum VisualEffectType {
@@ -2021,8 +2145,7 @@ export declare class VisualNode extends BaseNode {
      */
     get boundsLocal(): Readonly<Rect>;
     /**
-     * Position of the node's centerpoint in its own local coordinate space, i.e. the center of the boundsLocal
-     * box.
+     * Position of the node's centerpoint in its own local coordinate space, i.e. the center of the boundsLocal box.
      */
     get centerPointLocal(): Readonly<Point>;
     /**

package/ui/ui-sdk.d.ts

@@ -238,7 +238,6 @@ declare interface ApplicationBase {
         dragOptions?: DragOptions
     ): DisableDragToDocument;
     /**
-     * @experimental - Experimental API
      * Register iframe with the add-on SDK.
      * @param element - HTMLIframeElement to be registered.
      * @returns UnregisterIframe - Callback to unregister iframe from the add-on SDK.
@@ -745,6 +744,11 @@ declare interface Document_2 {
      * Import a presentation to the document.
      */
     importPresentation(blob: Blob, attributes: MediaAttributes): void;
+    /**
+     * @experimental - Experimental API
+     * Run print quality check
+     */
+    runPrintQualityCheck(options: PrintQualityCheckOptions): void;
 }
 export { Document_2 as Document };
 
@@ -1133,6 +1137,10 @@ export declare interface PageMetadata {
      * Whether page contains timelines
      */
     hasTemporalContent: boolean;
+    /**
+     * Whether the page is blank
+     */
+    isBlank?: boolean;
     /**
      * Pixels per inch of the page
      */
@@ -1141,21 +1149,16 @@ export declare interface PageMetadata {
      * Whether page is ready to print
      */
     isPrintReady?: boolean;
+    /**
+     * Template details of the page
+     */
+    templateDetails?: TemplateDetails;
 }
 
 /**
  * Options for fetching page metadata
  */
-export declare interface PageMetadataOptions {
-    /**
-     * Page range of the document to get the metadata
-     */
-    range: Range_2;
-    /**
-     * Ids of the pages (Only required if the range is "specificPages")
-     */
-    pageIds?: string[];
-}
+export declare interface PageMetadataOptions extends RangeOptions {}
 
 export declare interface PageRendition extends Rendition {
     /**
@@ -1350,6 +1353,12 @@ export declare interface PngRenditionOptions extends RenditionOptions {
     };
 }
 
+/**
+ * @experimental - Experimental API
+ * Options for running print quality check
+ */
+export declare interface PrintQualityCheckOptions extends RangeOptions {}
+
 /**
  * Takes a type and wraps it in a Promise, if it not already is one.
  * This is to avoid `Promise<Promise<T>>`.
@@ -1392,6 +1401,20 @@ declare enum Range_2 {
 }
 export { Range_2 as Range };
 
+/**
+ * Options for providing range of pages
+ */
+export declare interface RangeOptions {
+    /**
+     * Page range of the document
+     */
+    range: Range_2;
+    /**
+     * Ids of the pages (Only required if the range is "specificPages")
+     */
+    pageIds?: string[];
+}
+
 /**
  * Takes the raw type of a remote object or function in the other thread and returns the type as it is visible to
  * the local thread from the proxy return value of `Runtime.apiProxy()`.
@@ -1484,19 +1507,11 @@ export declare enum RenditionIntent {
     print = "print"
 }
 
-export declare interface RenditionOptions {
-    /**
-     * Range of the document to get the rendition
-     */
-    range: Range_2;
+export declare interface RenditionOptions extends RangeOptions {
     /**
      * Format of the rendition
      */
     format: RenditionFormat;
-    /**
-     * Ids of the pages (Only required if the range is "specificPages")
-     */
-    pageIds?: string[];
 }
 
 /**
@@ -1584,6 +1599,20 @@ export declare interface SearchAction extends PanelAction {
 
 export declare type SimpleDialogOptions = AlertDialogOptions | InputDialogOptions;
 
+/**
+ * Represents template data for a page
+ */
+export declare interface TemplateDetails {
+    /**
+     * Unique id of the template
+     */
+    id: string;
+    /**
+     * Creative intent of the template
+     */
+    creativeIntent?: string;
+}
+
 /**
  * Interface that contains methods and properties that are Application UI related.
  */
@@ -1605,7 +1634,6 @@ export declare interface UI {
      */
     readonly locales: string[];
     /**
-     * @experimental - Experimental API
      * Opens an Editor Panel
      * @param panel - one of {@link EditorPanel}
      * @param action - optional action to be performed on the panel {@link PanelAction}
@@ -1629,7 +1657,6 @@ declare type Unpromisify<P> = P extends Promise<infer T> ? T : P;
 declare type UnproxyOrClone<T> = T extends RemoteObject<ProxyMarked> ? Local<T> : T;
 
 /**
- * @experimental - Experimental API
  * Callback to unregister iframe from the add-on SDK.
  */
 declare type UnregisterIframe = () => void;