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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/ccweb-add-on-sdk-types",
-  "version": "1.13.0",
+  "version": "1.15.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

@@ -175,6 +175,7 @@ export declare class ArtboardNode extends VisualNode implements IRectangularNode
     get children(): ItemList<Node>;
     /**
      * The background fill of the artboard. Artboards must always have a fill.
+     *
      */
     set fill(fill: Fill);
     get fill(): Readonly<Fill>;
@@ -1885,13 +1886,7 @@ export declare class TextContentModel {
      * 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,
-        range?: {
-            start: number;
-            length: number;
-        }
-    ): void;
+    applyCharacterStyles(styles: CharacterStylesInput, range?: TextRange): void;
     /**
      * <InlineAlert slots="text" variant="warning"/>
      *
@@ -1907,13 +1902,19 @@ export declare class TextContentModel {
      * @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;
+    applyParagraphStyles(styles: ParagraphStylesInput, range?: TextRange): 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 true if this text contains any fonts unavailable to the current user.
+     * Currently, if any unavailable fonts are present, the text content cannot be modified and
+     * certain styling changes are limited as well. To remove these restrictions, you must modify
+     * the character styles to use only AvailableFonts.
+     */
+    hasUnavailableFonts(): boolean;
 }
 
 /**
@@ -2012,23 +2013,31 @@ export declare class TextNode extends Node {
     set layout(layout: PointTextLayout | AutoHeightTextLayout | AreaTextLayout);
 }
 
+/**
+ * A range of text in a {@link TextContentModel}.
+ */
+declare interface TextRange {
+    start: number;
+    length: number;
+}
+
 /**
  * <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.
  */
 declare enum TextType {
+    area = 1,
     /**
-     * Point text
+     * Soft bottom
      */
-    autoWidth = 0,
+    autoHeight = 2,
     /**
-     * Soft bottom
+     * Point text
      */
-    autoHeight = 1,
-    area = 2,
-    magicFit = 3,
-    circular = 4
+    autoWidth = 3,
+    circular = 4,
+    magicFit = 5
 }
 
 /**

package/ui/ui-sdk.d.ts

@@ -151,6 +151,10 @@ export declare enum AppEvent {
      * triggered when the document id is available in the application.
      */
     documentIdAvailable = "documentIdAvailable",
+    /**
+     * triggered when the document link is available in the application.
+     */
+    documentLinkAvailable = "documentLinkAvailable",
     /**
      * triggered when the document title is changed in the application.
      */
@@ -171,6 +175,7 @@ declare interface AppEventsTypeMap {
     [AppEvent.dragend]: AppDragEndEventData;
 
     [AppEvent.documentIdAvailable]: DocumentIdAvailableEventData;
+    [AppEvent.documentLinkAvailable]: DocumentLinkAvailableEventData;
     [AppEvent.documentTitleChange]: DocumentTitleChangeEventData;
 }
 
@@ -252,6 +257,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,9 +537,82 @@ 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,
+        LinkOptions,
         RenditionFormat,
         RenditionType,
         RenditionIntent,
@@ -536,6 +630,8 @@ declare namespace Constants {
         PlatformEnvironment,
         DeviceClass,
         PlatformType,
+        ColorPickerPlacement,
+        ColorPickerEvents,
         AuthorizationStatus
     };
 }
@@ -732,6 +828,11 @@ declare interface Document_2 {
      * Get document id
      */
     id(): Promise<string | undefined>;
+    /**
+     * @experimental - Experimental API
+     * Get document Link
+     */
+    link(options: LinkOptions): Promise<string | undefined>;
     /**
      * Get document name/title
      */
@@ -759,6 +860,13 @@ declare interface DocumentIdAvailableEventData {
     documentId: string | undefined;
 }
 
+/**
+ * The payload data sent to the document link available event handler.
+ */
+declare interface DocumentLinkAvailableEventData {
+    documentLink: string | undefined;
+}
+
 /**
  * The payload data sent to the document title change event handler.
  */
@@ -962,6 +1070,17 @@ export declare interface JpgRenditionOptions extends RenditionOptions {
     };
 }
 
+/**
+ * @experimental - Experimental API
+ * Link options for document link
+ */
+export declare enum LinkOptions {
+    /**
+     * Link to the current document
+     */
+    document = "document"
+}
+
 /**
  * Takes the raw type of a remote object or function as a remote thread would see it through a proxy (e.g. when
  * passed in as a function argument) and returns the type the local thread has to supply.

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"]
-}