@adobe/ccweb-add-on-sdk-types 1.12.0 → 1.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/ccweb-add-on-sdk-types",
-  "version": "1.12.0",
+  "version": "1.14.0",
   "author": "Adobe",
   "license": "MIT",
   "description": "Type definitions for Adobe Creative Cloud Web Add-on SDK.",
@@ -38,14 +38,15 @@
     "url": "https://github.com/adobe/create-ccweb-add-on"
   },
   "dependencies": {
-    "tslib": "2.6.2",
-    "gl-matrix": "3.3.0"
+    "tslib": "2.7.0",
+    "gl-matrix": "3.3.0",
+    "@swc/helpers": "0.5.12"
   },
   "devDependencies": {
-    "@types/node": "16.18.36",
+    "@types/node": "18.18.2",
     "prettier": "2.8.0",
     "ts-node": "10.9.2",
-    "typescript": "5.4.5"
+    "typescript": "5.7.3"
   },
   "scripts": {
     "clean": "",

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

@@ -83,7 +83,9 @@ declare namespace ApiConstants {
         TextAlignment,
         TextType,
         EditorEvent,
-        VisualEffectType
+        VisualEffectType,
+        ParagraphListType,
+        OrderedListNumbering
     };
 }
 
@@ -104,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;
 }
 
@@ -193,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;
 }
 
@@ -201,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;
@@ -213,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}.
@@ -249,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;
@@ -434,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).
  */
@@ -447,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.
  *
@@ -463,11 +439,6 @@ 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.
  *
  * Note that fonts returned by the getter are *not* guaranteed to be ones the user has rights to edit with, even though they
@@ -476,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.
  *
@@ -910,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.
@@ -927,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.
      *
@@ -1003,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.
      */
@@ -1866,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.
@@ -1884,11 +1838,6 @@ 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 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
@@ -1925,11 +1874,6 @@ export declare class TextContentModel {
      */
     set paragraphStyleRanges(styles: readonly ParagraphStylesRangeInput[]);
     /**
-     * <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 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
@@ -1981,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
@@ -1994,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.
      *
@@ -2025,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[];
@@ -2156,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 {
@@ -2198,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

@@ -252,6 +252,22 @@ declare interface ApplicationBase {
     showModalDialog(dialogOptions: InputDialogOptions): Promise<InputDialogResult>;
     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.
+     * @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>;
+
     /**
      * Triggers/Starts the in-app monetization upgrade flow
      * @returns if the user is premium user or not
@@ -516,6 +532,78 @@ export declare interface ClientStorage {
     clear(): Promise<void>;
 }
 
+/**
+ * @experimental - Experimental API
+ * Custom DOM events dispatched on the anchor element passed to `showColorPicker()` API.
+ */
+export declare enum ColorPickerEvents {
+    /**
+     * Color change event dispatched when a color is selected.
+     * The event detail will contain a 'color' property of type string.
+     */
+    colorChange = "colorpicker-color-change",
+    /**
+     * Color picker closed event dispatched when the color picker is closed.
+     */
+    close = "colorpicker-close"
+}
+
+/**
+ * @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 {
+    /**
+     * Title text displayed in the color picker popover header.
+     * Default title is an empty string.
+     */
+    title?: string;
+    /**
+     * Initial color for the color picker, in 0xRRGGBB format.
+     * Default color is 0xFFFFFF (white).
+     */
+    initialColor?: number;
+    /**
+     * Placement of the color picker popover relative to the anchor element.
+     * Default placement is ColorPickerPlacement.left.
+     */
+    placement?: ColorPickerPlacement;
+    /**
+     * Controls whether the color picker popover should be temporarily hidden while using the EyeDropper tool.
+     * Default value is false.
+     */
+    eyedropperHidesPicker?: boolean;
+    /**
+     * Controls whether the transparency/alpha slider is shown in the color picker.
+     * Default value is false.
+     */
+    disableAlphaChannel?: boolean;
+}
+
+/**
+ * @experimental - Experimental API
+ * Denotes the placement of the color picker popover relative to its anchor element.
+ * Used in the placement option of `showColorPicker()` API.
+ */
+export declare enum ColorPickerPlacement {
+    /**
+     * The color picker popover will be positioned above the anchor element.
+     */
+    top = "top",
+    /**
+     * The color picker popover will be positioned below the anchor element.
+     */
+    bottom = "bottom",
+    /**
+     * The color picker popover will be positioned to the left of the anchor element.
+     */
+    left = "left",
+    /**
+     * The color picker popover will be positioned to the right of the anchor element.
+     */
+    right = "right"
+}
+
 declare namespace Constants {
     export {
         Range_2 as Range,
@@ -536,6 +624,8 @@ declare namespace Constants {
         PlatformEnvironment,
         DeviceClass,
         PlatformType,
+        ColorPickerPlacement,
+        ColorPickerEvents,
         AuthorizationStatus
     };
 }

package/.mocharc.json

@@ -1,5 +0,0 @@
-{
-    "extension": ["ts"],
-    "node-option": ["experimental-specifier-resolution=node", "loader=ts-node/esm", "no-warnings"],
-    "spec": ["test/**/*.spec.ts"]
-}