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

package/package.json

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

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;
 }
 
@@ -607,6 +612,7 @@ export declare enum ColorPickerPlacement {
 declare namespace Constants {
     export {
         Range_2 as Range,
+        LinkOptions,
         RenditionFormat,
         RenditionType,
         RenditionIntent,
@@ -822,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
      */
@@ -849,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.
  */
@@ -1052,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.