@adobe/ccweb-add-on-sdk-types 1.15.0 → 1.17.0

package/package.json

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

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

@@ -81,7 +81,7 @@ declare namespace ApiConstants {
         StrokePosition,
         StrokeType,
         TextAlignment,
-        TextType,
+        TextLayout,
         EditorEvent,
         VisualEffectType,
         ParagraphListType,
@@ -105,7 +105,7 @@ declare interface ApiModuleExport {
  * @experimental
  */
 export declare interface AreaTextLayout {
-    type: TextType.area;
+    type: TextLayout.area;
     /**
      * The width of the text node in pixels.
      */
@@ -120,6 +120,11 @@ export declare interface AreaTextLayout {
  * <InlineAlert slots="text" variant="warning"/>
  *
  * *Do not depend on the literal numeric values of these constants*, as they may change. Always reference the enum identifiers in your code.
+ *
+ * <InlineAlert slots="text" variant="warning"/>
+ *
+ * *Additional arrowhead types may be added in the future.* If your code has different branches or cases depending on arrow type,
+ * always have a default/fallback case to handle any unknown values you may encounter.
  */
 declare enum ArrowHeadType {
     none = 0,
@@ -159,7 +164,7 @@ export declare class ArtboardList extends RestrictedItemList<ArtboardNode> {
  *
  * Please note that creating and deleting an artboard in a single frame will crash the editor.
  */
-export declare class ArtboardNode extends VisualNode implements IRectangularNode, ContainerNode {
+export declare class ArtboardNode extends VisualNode implements Readonly<IRectangularNode>, ContainerNode {
     /**
      * Returns a read-only list of all children of the node. General-purpose content containers such as ArtboardNode or
      * GroupNode also provide a mutable {@link ContainerNode.children} list. Other nodes with a more specific structure can
@@ -185,10 +190,12 @@ export declare class ArtboardNode extends VisualNode implements IRectangularNode
     get parent(): PageNode | undefined;
     /**
      * The width of the artboard.
+     * Shares the same dimensions as the parent page and other artboards within the parent page.
      */
     get width(): number;
     /**
      * The height of the artboard.
+     * Shares the same dimensions as the parent page and other artboards within the parent page.
      */
     get height(): number;
 }
@@ -201,13 +208,24 @@ export declare class ArtboardNode extends VisualNode implements IRectangularNode
  * @experimental
  */
 export declare interface AutoHeightTextLayout {
-    type: TextType.autoHeight;
+    type: TextLayout.autoHeight;
     /**
      * The width of the text node in pixels.
      */
     width: 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
+ */
+export declare interface AutoWidthTextLayout {
+    type: TextLayout.autoWidth;
+}
+
 /**
  * Font the current user has access or licensing permissions to create / edit content with.
  */
@@ -650,6 +668,22 @@ export declare class Editor {
      * @returns a Promise that resolves when the lambda has finished running, or rejects if the lambda throws an error.
      */
     queueAsyncEdit(lambda: () => void): Promise<void>;
+    /**
+     * @returns a text node with default styles. The text content is initially empty, so the text node will be
+     * invisible until its `fullContent` property's `text` is set. Creates auto-width text, so the node's width will
+     * automatically adjust to accommodate whatever text is set.
+     * @deprecated - Initial text content is always expected so please use `createText(textContent: string): StandaloneTextNode`.
+     */
+    createText(): StandaloneTextNode;
+    /**
+     * @param textContent - the initial string to show.
+     * @returns a text node with default styles. Creates auto-width text, so the node's width will automatically adjust
+     * to accommodate the given text content.
+     *
+     * Note: the registration point of this text node is not guaranteed to be at the top-left of the bounding box of its
+     * insertion parent. Recommend using `setPositionInParent` over `translation` to set the position.
+     */
+    createText(textContent: string): StandaloneTextNode;
     /**
      * User's current selection context
      */
@@ -735,15 +769,6 @@ export declare class Editor {
      * @returns a stroke configured with the given options.
      */
     makeStroke(options?: Partial<SolidColorStroke>): SolidColorStroke;
-    /**
-     * @returns a text node with default styles. The text content is initially empty, so the text node will be
-     * invisible until its `fullContent` property's `text` is set. Creates point text, so the node's width will automatically
-     * adjust to accommodate whatever text is set.
-     *
-     * Note: the registration point of this text node is not guaranteed to be at the top-left of the bounding box of its
-     * insertion parent. Recommend using `setPositionInParent` over `translation` to set the position.
-     */
-    createText(): TextNode;
     /**
      * @returns a path node with a default stroke and no initial fill.
      * @param path - a string representing any [SVG path element](https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths).
@@ -913,7 +938,7 @@ export declare class GridCellNode extends MediaContainerNode {}
  *
  * APIs to create a new grid layout are not yet available.
  */
-export declare class GridLayoutNode extends Node implements Readonly<IRectangularNode> {
+export declare class GridLayoutNode extends Node implements IRectangularNode {
     /**
      * The Grid's regular children. Does not include rectangles and skips over media constainer nodes to return fill grandchildren.
      * Grid Cells are ordered by the y and then x position of their top left corner, i.e. left to right and top to bottom.
@@ -927,12 +952,16 @@ export declare class GridLayoutNode extends Node implements Readonly<IRectangula
     get fill(): Readonly<Fill>;
     /**
      * The width of the node.
+     * Must be at least {@link MIN_DIMENSION}.
      */
     get width(): number;
+    set width(value: number);
     /**
      * The height of the node.
+     * Must be at least {@link MIN_DIMENSION}.
      */
     get height(): number;
+    set height(value: number);
 }
 
 /**
@@ -1030,7 +1059,7 @@ export declare class ItemList<T extends ListItem> extends RestrictedItemList<T>
      * Add one or more items to the end of the list. The last argument will become the last item in this list. Items are
      * removed from their previous parent, if any – or if an item is already in *this* list, its index is simply changed.
      *
-     * @throws - if item has a different parent and item is a {@link TextNode} that's a part of a Text Flow, or if item's children subtree contains a TextNode who is a part of a Text Flow.
+     * @throws - if item has a different parent and item is a {@link ThreadedTextNode}, or if item's children subtree contains a {@link ThreadedTextNode}.
      */
     append(...items: T[]): void;
     /**
@@ -1042,7 +1071,7 @@ export declare class ItemList<T extends ListItem> extends RestrictedItemList<T>
      * `newItem` is removed from its previous parent, if any – or if it's already in *this* list, its index is simply
      * changed. No-op if both arguments are the same item.
      *
-     * @throws - if newItem has a different parent and newItem is a {@link TextNode} that's a part of a Text Flow, or if newItem's children subtree contains a TextNode who is a part of a Text Flow.
+     * @throws - if newItem has a different parent and newItem is a {@link ThreadedTextNode}, or if newItem's children subtree contains a {@link ThreadedTextNode}.
      */
     replace(oldItem: T, newItem: T): void;
     /**
@@ -1050,7 +1079,7 @@ export declare class ItemList<T extends ListItem> extends RestrictedItemList<T>
      * to occupy, shifting `before` and all later items to higher indices. `newItem` is removed from its previous parent,
      * if any – or if it's already in *this* list, its index is simply changed. No-op if both arguments are the same item.
      *
-     * @throws - if newItem has a different parent and it is a {@link TextNode} that's a part of a Text Flow, or if newItem's children subtree contains a TextNode who is a part of a Text Flow.
+     * @throws - if newItem has a different parent and it is a {@link ThreadedTextNode}, or if newItem's children subtree contains a {@link ThreadedTextNode}.
      */
     insertBefore(newItem: T, before: T): void;
     /**
@@ -1058,7 +1087,7 @@ export declare class ItemList<T extends ListItem> extends RestrictedItemList<T>
      * shifting all later items to higher indices (the index of `after` remains unchanged). `newItem` is removed from its previous parent,
      * if any – or if it's already in *this* list, its index is simply changed. No-op if both arguments are the same item.
      *
-     * @throws - if newItem has a different parent and it is a {@link TextNode} that's a part of a Text Flow, or if newItem's children subtree contains a TextNode who is a part of a Text Flow.
+     * @throws - if newItem has a different parent and it is a {@link ThreadedTextNode}, or if newItem's children subtree contains a {@link ThreadedTextNode}.
      */
     insertAfter(newItem: T, after: T): void;
 }
@@ -1265,6 +1294,46 @@ declare class Node extends VisualNode {
      */
     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
+     * Changes the width to the given value and the height to the given width multiplied by the aspect ratio.
+     */
+    rescaleProportionalToWidth(width: 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
+     * Changes the height to the given value and the width to the given height multiplied by the aspect ratio.
+     */
+    rescaleProportionalToHeight(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
+     * Resizes the node to fit within a box with the given dimensions.
+     *
+     * If the node doesn't have a fixed aspect ratio then this will resize the node to the given width and height.
+     */
+    resizeToFitWithin(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
+     * Resizes the node to cover a box with the given dimensions.
+     *
+     * 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;
 }
 export { Node as Node };
 
@@ -1345,7 +1414,7 @@ export declare class PageList extends RestrictedItemList<PageNode> {
  *
  * To create new pages, see {@link PageList.addPage}.
  */
-export declare class PageNode extends BaseNode implements Readonly<IRectangularNode> {
+export declare class PageNode extends BaseNode implements IRectangularNode {
     /**
      * The artboards or "scenes" of a page, ordered by timeline sequence.
      * To create new artboards, see {@link ArtboardList.addArtboard}.
@@ -1354,13 +1423,17 @@ export declare class PageNode extends BaseNode implements Readonly<IRectangularN
     /**
      * The width of the node.
      * All Artboards within a page share the same dimensions.
+     * 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.
+     * Must be at least {@link MIN_PAGE_DIMENSION} and no larger than {@link MAX_PAGE_DIMENSION}.
      */
     get height(): number;
+    set height(value: number);
     /**
      * The page's name. Displayed as a user-editable label above the current artboard in the UI.
      */
@@ -1469,17 +1542,6 @@ export declare interface Point {
     y: 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
- */
-export declare interface PointTextLayout {
-    type: TextType.autoWidth;
-}
-
 /**
  * ReadOnlyItemList represents an ordered list of API objects, representing items that are all children of the
  * same parent node. (The reverse is not necessarily true, however: this list might not include all
@@ -1520,7 +1582,7 @@ export declare class ReadOnlyItemList<T extends ListItem> {
     toArray(): readonly T[];
 }
 
-declare interface Rect {
+export declare interface Rect {
     x: number;
     y: number;
     width: number;
@@ -1725,6 +1787,31 @@ export declare interface SolidColorStroke extends Stroke {
 export declare type SolidColorStrokeWithOptionalType = Omit<SolidColorStroke, "type"> &
     Partial<Pick<SolidColorStroke, "type">>;
 
+/**
+ * A StandaloneTextNode represents a text display frame in the scenegraph. It displays an entire piece of text.
+ * The StandaloneTextNode does not directly hold the text content and styles – instead it refers to a {@link TextContentModel}.
+ *
+ * To create new a single-frame piece of text, see {@link Editor.createText}.
+ */
+export declare class StandaloneTextNode extends TextNode {
+    get nextTextNode(): undefined;
+    get layout(): Readonly<AutoWidthTextLayout | AutoHeightTextLayout | UnsupportedTextLayout>;
+    /**
+     * <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 the layout mode of the TextNode "frame."
+     *
+     * {@link AreaTextLayout} is not supported by single-frame text.
+     *
+     * @throws if changing text layout to/from {@link TextLayout.magicFit} or {@link TextLayout.circular} layout when the text contains font(s) unavailable to the current user.
+     * @throws if {@link StandaloneTextNode} is not a part of a multi-frame text content flow and the layout is {@link AreaTextLayout}.
+     */
+    set layout(layout: AutoWidthTextLayout | AutoHeightTextLayout);
+}
+
 /**
  * Base class for a Node that can have its own stroke.
  */
@@ -1799,15 +1886,22 @@ declare interface StyleRange {
  * <InlineAlert slots="text" variant="warning"/>
  *
  * *Do not depend on the literal numeric values of these constants*, as they may change. Always reference the enum identifiers in your code.
+ *
+ * <InlineAlert slots="text" variant="warning"/>
+ *
+ * *Additional alignment types may be added in the future.* If your code has different branches or cases depending on text alignment,
+ * always have a default/fallback case to handle any unknown values you may encounter.
  */
 declare enum TextAlignment {
     left = 1,
     right = 2,
-    center = 3
+    center = 3,
+    justifyLeft = 4
 }
 
 /**
- * Represents a complete piece of text content flow, which may be split across multiple {@link TextNode} frames for display.
+ * Represents a complete piece of text content, which may be contained within a single {@link StandaloneTextNode} *or*
+ * split across multiple {@link ThreadedTextNode} frames for display.
  * Use this model to get or modify the text string and the style ranges applied to it.
  */
 export declare class TextContentModel {
@@ -1827,14 +1921,14 @@ export declare class TextContentModel {
     get id(): string;
     /**
      * 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.
+     * starts in the first  {@link ThreadedTextNode} "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 ThreadedTextNode} "frame" is not large enough to accommodate it.
      *
-     * If there are multiple {@link TextNode}s, all of them must be configured to use {@link AreaTextLayout}.
+     * If there are multiple {@link ThreadedTextNode}s, all of them must be configured to use {@link AreaTextLayout}.
      */
     get allTextNodes(): Readonly<Iterable<TextNode>>;
     /**
-     * The complete text string, which may span multiple {@link TextNode} "frames" in the scenegraph.
+     * The complete text string, which may span multiple {@link ThreadedTextNode} "frames" in the scenegraph.
      */
     get text(): string;
     set text(textContent: string);
@@ -1918,14 +2012,58 @@ export declare class TextContentModel {
 }
 
 /**
- * A TextNode represents a text display frame in the scenegraph. It may display an entire piece of text, or sometimes just
- * 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 – instead it refers to a {@link TextContentModel}, which may be shared across multiple TextNode frames.
+ * <InlineAlert slots="text" variant="warning"/>
+ *
+ * *Do not depend on the literal numeric values of these constants*, as they may change. Always reference the enum identifiers in your code.
  *
- * To create new a single-frame piece of text, see {@link Editor.createText}. APIs are not yet available to create
- * multi-frame text flows.
+ * <InlineAlert slots="text" variant="warning"/>
+ *
+ * *Additional text layout types may be added in the future.* If your code has different branches or cases depending on layout type,
+ * always have a default/fallback case to handle any unknown values you may encounter.
+ */
+declare enum TextLayout {
+    /**
+     * Area text: both width and height are explicitly set. If text content is too long to fit, the end of the text will be
+     * clipped. If text content is short, the frame's bounds will occupy extra height that is just blank space.
+     */
+    area = 1,
+    /**
+     * Auto-height text: Width is explicitly set, and text wraps to use as much vertical space as necessary to display the
+     * full content.
+     */
+    autoHeight = 2,
+    /**
+     * Auto-width, aka point text: both width and height are automatically determined based on the content. There is no
+     * automatic line wrapping, so the text will all be on one line unless the text contains explicit newlines.
+     */
+    autoWidth = 3,
+    /**
+     * Text is arranged in a circle or arc. The API does not yet support setting or reading the details of this layout style.
+     */
+    circular = 4,
+    /**
+     * Aka "Dynamic" layout in the UI: text size and styles are automatically varied to create an attractive multi-line layout.
+     * The API does not yet support setting or reading the details of this layout style.
+     */
+    magicFit = 5
+}
+
+/**
+ * TextNode is an abstract base class representing text displayed in the scenegraph, regardless of whether it's a fully
+ * self-contained {@link StandaloneTextNode} or one {@link ThreadedTextNode} "frame" of multiple in a larger flow. The
+ * APIs on TextNode and its {@link TextContentModel} allow you to generically work with text without needing to know
+ * which of those subtypes you are dealing with.
  */
-export declare class TextNode extends Node {
+export declare abstract class TextNode extends Node {
+    /**
+     * {@inheritDoc VisualNode.boundsLocal}
+     *
+     * @returns
+     * Note: The bounding box of the orphaned TextNode may be different from the bounding box of the node placed on a
+     * page. It is recommended to use this property only when the node is placed on a page.
+     *
+     */
+    get boundsLocal(): Readonly<Rect>;
     /**
      * {@inheritDoc VisualNode.centerPointLocal}
      *
@@ -1944,6 +2082,22 @@ export declare class TextNode extends Node {
      *
      */
     get topLeftLocal(): Readonly<Point>;
+    /**
+     * {@inheritDoc Node.boundsInParent}
+     *
+     * @returns
+     * Note: The bounding box of an orphaned TextNode may become different after it is placed on a
+     * page. It is recommended to use this property only when the node is placed on a page.
+     */
+    get boundsInParent(): Readonly<Rect>;
+    /**
+     * {@inheritDoc Node.boundsInNode}
+     *
+     * @returns
+     * Note: The bounding box of an orphaned TextNode may become different after it is placed on a
+     * page. It is recommended to use this method only when the node is placed on a page.
+     */
+    boundsInNode(targetNode: VisualNode): Readonly<Rect>;
     /**
      * 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
@@ -1956,13 +2110,21 @@ export declare class TextNode extends Node {
      *
      */
     get fullContent(): TextContentModel;
+    /**
+     * Helper method to determine if the text is standalone.
+     */
+    isStandaloneText(): this is StandaloneTextNode;
+    /**
+     * Helper method to determine if the text is in a flow.
+     */
+    isThreadedText(): this is ThreadedTextNode;
     /**
      * 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.
      *
      * To get *all* TextNodes that the text content may be split across, use `TextNode.fullContent.allTextNodes`.
      */
-    get nextTextNode(): TextNode | undefined;
+    abstract get nextTextNode(): ThreadedTextNode | undefined;
     /**
      * The text string content which is partially *or* fully displayed in this TextNode "frame."
      * WARNING: If a piece of text content flows across several TextNodes, *each* TextNode's `text` getter will return
@@ -1994,23 +2156,7 @@ export declare class TextNode extends Node {
      * @experimental
      * @returns The layout mode of the TextNode "frame."
      */
-    get layout(): Readonly<PointTextLayout | AutoHeightTextLayout | AreaTextLayout | UnsupportedTextLayout>;
-    /**
-     * <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 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, 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 {@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);
+    get layout(): Readonly<AutoWidthTextLayout | AutoHeightTextLayout | AreaTextLayout | UnsupportedTextLayout>;
 }
 
 /**
@@ -2022,22 +2168,28 @@ declare interface TextRange {
 }
 
 /**
- * <InlineAlert slots="text" variant="warning"/>
+ * 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 –
+ * instead it refers to a {@link TextContentModel}, which may be shared across multiple ThreadedTextNode frames.
  *
- * *Do not depend on the literal numeric values of these constants*, as they may change. Always reference the enum identifiers in your code.
+ * APIs are not yet available to create multi-frame text flows.
  */
-declare enum TextType {
-    area = 1,
+export declare class ThreadedTextNode extends TextNode {
+    get nextTextNode(): ThreadedTextNode | undefined;
+    get layout(): Readonly<AreaTextLayout>;
     /**
-     * Soft bottom
-     */
-    autoHeight = 2,
-    /**
-     * Point text
+     * <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 the layout mode of the TextNode "frame."
+     *
+     * Only {@link AreaTextLayout}, with fully fixed bounds, is currently supported by threaded text.
+     *
+     * @throws if {@link ThreadedTextNode} is part of a multi-frame text content flow and the layout is not {@link AreaTextLayout}.
      */
-    autoWidth = 3,
-    circular = 4,
-    magicFit = 5
+    set layout(layout: AreaTextLayout);
 }
 
 /**
@@ -2091,7 +2243,7 @@ export declare interface UnorderedListStyleInput extends BaseParagraphListStyle
  * @experimental
  */
 export declare interface UnsupportedTextLayout {
-    type: TextType.magicFit | TextType.circular;
+    type: TextLayout.magicFit | TextLayout.circular;
 }
 
 /**

package/ui/ui-sdk.d.ts

@@ -155,6 +155,10 @@ export declare enum AppEvent {
      * triggered when the document link is available in the application.
      */
     documentLinkAvailable = "documentLinkAvailable",
+    /**
+     * triggered when the published document link is available in the application.
+     */
+    documentPublishedLinkAvailable = "documentPublishedLinkAvailable",
     /**
      * triggered when the document title is changed in the application.
      */
@@ -176,6 +180,7 @@ declare interface AppEventsTypeMap {
 
     [AppEvent.documentIdAvailable]: DocumentIdAvailableEventData;
     [AppEvent.documentLinkAvailable]: DocumentLinkAvailableEventData;
+    [AppEvent.documentPublishedLinkAvailable]: DocumentPublishedLinkAvailableEventData;
     [AppEvent.documentTitleChange]: DocumentTitleChangeEventData;
 }
 
@@ -258,17 +263,15 @@ declare interface ApplicationBase {
     showModalDialog(dialogOptions: CustomDialogOptions): Promise<CustomDialogResult>;
 
     /**
-     * @experimental - Experimental API
      * Shows a color picker popover anchored to the specified element.
      * The anchor element must be an instance of HTMLElement.
      * Custom DOM events are dispatched on the anchor element when the color changes or the color picker closes.
-     * See {@link ColorPickerEvents} for more details.
+     * See {@link ColorPickerEvent} for more details.
      * @param anchorElement - The HTML element to anchor the color picker to.
      * @param options - Optional configuration options for customizing the color picker behavior and appearance.
      */
     showColorPicker(anchorElement: HTMLElement, options?: ColorPickerOptions): Promise<void>;
     /**
-     * @experimental - Experimental API
      * Hides the color picker popover if it is currently visible.
      */
     hideColorPicker(): Promise<void>;
@@ -538,10 +541,9 @@ export declare interface ClientStorage {
 }
 
 /**
- * @experimental - Experimental API
  * Custom DOM events dispatched on the anchor element passed to `showColorPicker()` API.
  */
-export declare enum ColorPickerEvents {
+export declare enum ColorPickerEvent {
     /**
      * Color change event dispatched when a color is selected.
      * The event detail will contain a 'color' property of type string.
@@ -554,7 +556,6 @@ export declare enum ColorPickerEvents {
 }
 
 /**
- * @experimental - Experimental API
  * Options that can be passed to the `showColorPicker` API to customize the color picker's behavior and appearance.
  */
 export declare interface ColorPickerOptions {
@@ -564,10 +565,12 @@ export declare interface ColorPickerOptions {
      */
     title?: string;
     /**
-     * Initial color for the color picker, in 0xRRGGBB format.
+     * Initial color for the color picker, in hex format.
+     * Can provide either as a number in 0xRRGGBB or 0xRRGGBBAA format,
+     * or as a string in "#RRGGBB" or "#RRGGBBAA" format.
      * Default color is 0xFFFFFF (white).
      */
-    initialColor?: number;
+    initialColor?: number | string;
     /**
      * Placement of the color picker popover relative to the anchor element.
      * Default placement is ColorPickerPlacement.left.
@@ -586,7 +589,6 @@ export declare interface ColorPickerOptions {
 }
 
 /**
- * @experimental - Experimental API
  * Denotes the placement of the color picker popover relative to its anchor element.
  * Used in the placement option of `showColorPicker()` API.
  */
@@ -631,7 +633,6 @@ declare namespace Constants {
         DeviceClass,
         PlatformType,
         ColorPickerPlacement,
-        ColorPickerEvents,
         AuthorizationStatus
     };
 }
@@ -810,7 +811,7 @@ declare interface Document_2 {
     /**
      * Add video to the current page
      */
-    addVideo(blob: Blob): Promise<void>;
+    addVideo(blob: Blob, attributes?: MediaAttributes): Promise<void>;
     /**
      * Add audio to the current page
      */
@@ -830,7 +831,7 @@ declare interface Document_2 {
     id(): Promise<string | undefined>;
     /**
      * @experimental - Experimental API
-     * Get document Link
+     * Get document Link and Published document Link
      */
     link(options: LinkOptions): Promise<string | undefined>;
     /**
@@ -840,7 +841,7 @@ declare interface Document_2 {
     /**
      * Import a Pdf to the document.
      */
-    importPdf(blob: Blob, attributes: MediaAttributes): void;
+    importPdf(blob: Blob, attributes: MediaAttributes & SourceMimeTypeInfo): void;
     /**
      * Import a presentation to the document.
      */
@@ -856,21 +857,28 @@ export { Document_2 as Document };
 /**
  * The payload data sent to the document id available event handler.
  */
-declare interface DocumentIdAvailableEventData {
+export declare interface DocumentIdAvailableEventData {
     documentId: string | undefined;
 }
 
 /**
  * The payload data sent to the document link available event handler.
  */
-declare interface DocumentLinkAvailableEventData {
+export declare interface DocumentLinkAvailableEventData {
     documentLink: string | undefined;
 }
 
+/**
+ * The payload data sent to the published document link available event handler.
+ */
+declare interface DocumentPublishedLinkAvailableEventData {
+    documentPublishedLink: string | undefined;
+}
+
 /**
  * The payload data sent to the document title change event handler.
  */
-declare interface DocumentTitleChangeEventData {
+export declare interface DocumentTitleChangeEventData {
     documentTitle: string;
 }
 
@@ -907,7 +915,7 @@ export declare interface DragCompletionData {
 /**
  * Interface to provide drag options which can be passed to enableDragToDocument to change the drag behavior.
  */
-declare interface DragOptions {
+export declare interface DragOptions {
     /**
      * Use preview size for the drag image instead of the element size
      */
@@ -1078,7 +1086,11 @@ export declare enum LinkOptions {
     /**
      * Link to the current document
      */
-    document = "document"
+    document = "document",
+    /**
+     * Link to Published document link
+     */
+    published = "published"
 }
 
 /**
@@ -1718,6 +1730,21 @@ export declare interface SearchAction extends PanelAction {
 
 export declare type SimpleDialogOptions = AlertDialogOptions | InputDialogOptions;
 
+/**
+ * Mime type details for importing media
+ */
+export declare interface SourceMimeTypeInfo {
+    /**
+     * Mime type of the source asset
+     */
+    sourceMimeType?: SupportedMimeTypes;
+}
+
+export declare enum SupportedMimeTypes {
+    docx = "docx",
+    gdoc = "gdoc"
+}
+
 /**
  * Represents template data for a page
  */
@@ -1778,7 +1805,7 @@ declare type UnproxyOrClone<T> = T extends RemoteObject<ProxyMarked> ? Local<T>
 /**
  * Callback to unregister iframe from the add-on SDK.
  */
-declare type UnregisterIframe = () => void;
+export declare type UnregisterIframe = () => void;
 
 /**
  * Types of dialog variants supported.