@adobe/ccweb-add-on-sdk-types 1.2.1 → 1.4.0

package/README.md

@@ -10,11 +10,8 @@ This package exports type definitions for [@adobe/create-ccweb-add-on](https://w
 
 ## Usage Notes
 
-For TypeScript add-on projects created using [@adobe/create-ccweb-add-on](https://www.npmjs.com/package/@adobe/create-ccweb-add-on), this package is pre-installed. Additionally, the below files are included in the add-on project (based on the selected runtime):
+This package contains Add-on SDK type definitions. However, in itself this package is unusable. You must install [@types/adobe\_\_ccweb-add-on-sdk](https://www.npmjs.com/package/@types/adobe__ccweb-add-on-sdk) instead, to use the Add-on SDK type definitions in your Add-on project.
 
--   [add-on-ui-sdk.d.ts](https://github.com/adobe/create-ccweb-add-on/blob/main/packages/wxp-sdk-types/add-on-ui-sdk.d.ts)
--   [add-on-sandbox-sdk.d.ts](https://github.com/adobe/create-ccweb-add-on/blob/main/packages/wxp-sdk-types/add-on-sandbox-sdk.d.ts)
-
-However, if you are installing this package on your existing add-on project, ensure to include the above type definition files in your `src` directory.
+For add-on projects created using [@adobe/create-ccweb-add-on](https://www.npmjs.com/package/@adobe/create-ccweb-add-on), [@types/adobe\_\_ccweb-add-on-sdk](https://www.npmjs.com/package/@types/adobe__ccweb-add-on-sdk) is pre-installed.
 
 For more information about developing Adobe Express add-ons, check out the [documentation](https://developer.adobe.com/express/add-ons/).

package/package.json

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

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

@@ -121,6 +121,11 @@ export declare class BaseNode {
      */
     get allChildren(): Readonly<Iterable<BaseNode>>;
 
+    /**
+     * A unique identifier for this node that stays the same when the file is closed & reopened, or if the node is
+     * moved to a different part of the document.
+     */
+    get id(): string;
     /**
      * The node's type.
      */
@@ -421,6 +426,14 @@ export declare class Editor {
      * @returns a stroke configured with the given options.
      */
     makeStroke(options?: Partial<Stroke>): Stroke;
+    /**
+     * @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).
+     * Note that the path data will be normalized, and therefore the `path` getter may return a different SVG string from the path creation input.
+     * For example, "M 10 80 Q 52.5 10, 95 80 T 180 80" becomes "M 10 80 C 38.33 33.33 66.67 33.33 95 80...".
+     * Throws if the input is empty or is not legal SVG path syntax.
+     */
+    createPath(path: string): PathNode;
     /**
      * @returns a text node with default styles. The text content is initially empty, so the text node will be
      * invisible until its `text` property is set. Creates point text, so the node's width will automatically
@@ -908,14 +921,16 @@ export declare class PageNode extends BaseNode implements Readonly<IRectangularN
 export declare class PathNode extends FillableNode {
     /**
      * The path definition as an SVG string. The path data is read-only and cannot be modified via this API yet.
-     * Example: "M 0 0 L 10 15".
+     * Note that the path data will be normalized, and therefore the `path` getter may return a different SVG string from the path creation input.
+     * For example, "M 10 80 Q 52.5 10, 95 80 T 180 80" becomes "M 10 80 C 38.33 33.33 66.67 33.33 95 80...".
      */
     get path(): string;
     /**
      * The fill rule specifies how the interior area of a path is determined in cases where the path is self-intersecting or
-     * has multiple disjoint parts. This value is read-only and cannot be modified via this API yet.
+     * has multiple disjoint parts. The default value is nonZero.
      */
     get fillRule(): FillRule;
+    set fillRule(fillRule: FillRule);
 }
 
 /**

package/ui/ui-sdk.d.ts

@@ -25,7 +25,7 @@
 /**
  * Base interface for all type of add-ons
  */
-export declare interface AddOn {
+export declare interface AddOn extends AddOnBase {
     /**
      * Represents the current add-on runtime
      */
@@ -40,6 +40,11 @@ export declare interface AddOn {
     readonly clientStorage: ClientStorage;
 }
 
+/**
+ * Interface that represents the APIs directly exposed by the AddOn interface
+ */
+declare interface AddOnBase {}
+
 /**
  * @public
  * The main API Interface exposed by this SDK to the consuming Add-on code.
@@ -221,7 +226,6 @@ declare interface ApplicationBase {
     showModalDialog(dialogOptions: CustomDialogOptions): Promise<CustomDialogResult>;
 
     /**
-     * @experimental - Experimental API
      * Triggers/Starts the in-app monetization upgrade flow
      * @returns if the user is premium user or not
      */
@@ -462,6 +466,7 @@ declare namespace Constants {
         ButtonType,
         RuntimeType,
         BleedUnit,
+        VideoResolution,
         AuthorizationStatus
     };
 }
@@ -477,7 +482,6 @@ export declare interface CurrentUser {
     userId(): Promise<string>;
 
     /**
-     * @experimental - Experimental API
      * @returns if the current user is a premium user
      */
     isPremiumUser(): Promise<boolean>;
@@ -591,9 +595,9 @@ export declare type DisableDragToDocument = () => void;
  */
 declare interface Document_2 {
     /**
-     * Add image/gif to the current page
+     * Add image/gif/Ps/Ai files to the current page
      */
-    addImage(blob: Blob): Promise<void>;
+    addImage(blob: Blob, attributes?: MediaAttributes): Promise<void>;
     /**
      * Add video to the current page
      */
@@ -607,7 +611,6 @@ declare interface Document_2 {
      */
     createRenditions(renditionOptions: RenditionOptions, renditionIntent?: RenditionIntent): Promise<Rendition[]>;
     /**
-     * @experimental - Experimental API
      * Get metadata of all or range of pages of the document
      */
     getPagesMetadata(options: PageMetadataOptions): Promise<PageMetadata[]>;
@@ -749,8 +752,8 @@ export declare interface JpgRenditionOptions extends RenditionOptions {
      * Requested size
      */
     requestedSize?: {
-        width: number;
-        height: number;
+        width?: number;
+        height?: number;
     };
 }
 
@@ -822,6 +825,21 @@ export declare interface MediaAttributes {
     title: string;
 }
 
+export declare interface Mp4RenditionOptions extends RenditionOptions {
+    /**
+     * mp4 rendition format
+     */
+    format: RenditionFormat.mp4;
+    /**
+     * Video resolution
+     */
+    resolution?: VideoResolution;
+    /**
+     * Custom Resolution (in pixel)
+     */
+    customResolution?: number;
+}
+
 /**
  * OAuth 2.0 middleware for handling user sign-in.
  */
@@ -907,15 +925,78 @@ export declare interface PageRendition extends Rendition {
     metadata: PageMetadata;
 }
 
+/**
+ * Represents a PDF Page box
+ */
+export declare interface PdfPageBox {
+    /**
+     * Margins for a box
+     */
+    margins: PdfPageBoxMargins;
+}
+
+/**
+ * All the PDF Page boxes (MediaBox, BleedBox, CropBox, TrimBox)
+ */
+export declare interface PdfPageBoxes {
+    /**
+     * Media box
+     */
+    mediaBox?: PdfPageBox;
+    /**
+     * Bleed box
+     */
+    bleedBox?: PdfPageBox;
+    /**
+     * Crop box
+     */
+    cropBox?: PdfPageBox;
+    /**
+     * Trim box
+     */
+    trimBox?: PdfPageBox;
+}
+
+/**
+ * Margins for a PDF page box
+ */
+export declare interface PdfPageBoxMargins {
+    /**
+     * Top margin
+     */
+    top?: Bleed;
+    /**
+     * Bottom margin
+     */
+    bottom?: Bleed;
+    /**
+     * Left margin
+     */
+    left?: Bleed;
+    /**
+     * Right margin
+     */
+    right?: Bleed;
+}
+
 export declare interface PdfRenditionOptions extends RenditionOptions {
     /**
      * PDF rendition format
      */
     format: RenditionFormat.pdf;
     /**
-     * Bleed for the page. If undefined, then no bleed (zero).
+     * Bleed for the page.
+     * If bleed is defined, then CropBox and TrimBox will be the size of the express document. BleedBox and MediaBox will be equal to each other,
+     * and they will expand on all sides (left, top, right, bottom) with the amount/unit specified by bleed.
+     * If undefined, then no bleed (zero).
      */
     bleed?: Bleed;
+    /**
+     * Exposes ability to customize each PDF Page Box (MediaBox, BleedBox, CropBox, TrimBox) dimensions,
+     * by defining how much it should expand on each side beyond the express document page size.
+     * If pageBoxes are defined, then PdfRenditionOptions.bleed is ignored.
+     */
+    pageBoxes?: PdfPageBoxes;
 }
 
 export declare interface PngRenditionOptions extends RenditionOptions {
@@ -933,8 +1014,8 @@ export declare interface PngRenditionOptions extends RenditionOptions {
      * Requested size
      */
     requestedSize?: {
-        width: number;
-        height: number;
+        width?: number;
+        height?: number;
     };
 }
 
@@ -1065,7 +1146,11 @@ export declare enum RenditionIntent {
     /**
      * Intent to preview the content
      */
-    preview = "preview"
+    preview = "preview",
+    /**
+     * Intent to export and print the content
+     */
+    print = "print"
 }
 
 export declare interface RenditionOptions {
@@ -1221,4 +1306,26 @@ export declare enum Variant {
     custom = "custom"
 }
 
+/**
+ * Video resolution options for the mp4 renditions
+ */
+export declare enum VideoResolution {
+    /**
+     * SD 480p video resolution
+     */
+    sd480p = "480p",
+    /**
+     * HD 720p video resolution
+     */
+    hd720p = "720p",
+    /**
+     * FHD 1080p video resolution
+     */
+    fhd1080p = "1080p",
+    /**
+     * Custom video resolution
+     */
+    custom = "custom"
+}
+
 export {};