Changelog

2026-03-13

Updated

• Create Renditions - Guide now covers VisualNode.createRendition(), which captures individual elements (shapes, groups, text) as PNG or JPEG from the Document Sandbox. Also documents isPresentation() for checking document type before offering PPTX export, which is only available for presentation-type documents.
• Use Text - Guide now covers threaded text APIs (createThreadedText, ThreadedTextList) for multi-frame text flows, and the allTextContent and allDescendants accessors for iterating over text within page or visual node containers.
• Use PDF and PowerPoint - Guide corrected to use importPresentation() method, and clarified that only .pptx format is supported (legacy .ppt not supported).

2026-02-06

Added

We have added new APIs to generate image rendition of visual nodes directly from the document sandbox.

• Experimental VisualNode.createRendition() asynchronous method - Generate a rendition of a visual node and its descendants.

• Experimental CreateRenditionOptions interface - define configuration options for generating renditions.

• Experimental CreateRenditionResult interface - define the structure of the returned rendition data (e.g., blob, metadata).

• Experimental CreateRenditionFormat enumeration - specify supported output formats (e.g., PNG, JPEG, PDF) in the Constants namespace.

• Experimental addOnUISdk.app.document.isPresentation() asynchronous method - Returns true if the document is a presentation, false if not.

2026-01-26

Added

We have added new APIs for threaded text handling across multiple frames, as well as new accessors for retrieving a flattened list of all descendant nodes and text content within the page and visual node containers.

• Experimental Editor.createThreadedText() method - Create a ThreadedTextNode for threaded text handling across multiple frames.
• Experimental ThreadedTextList class - Represents an ordered list of ThreadedTextNode objects, creating a single, continuous text story across multiple frames.
• Experimental allDescendants accessor on PageNode and VisualNode - Returns a flattened, read-only list of all descendant nodes within the container. For text-based nodes, please use the new allTextContent accessor instead.
• Experimental allTextContent accessor on PageNode and VisualNode - Returns a flattened, read-only list of TextContent instances from all text-based nodes within the container.
• Experimental TextContent interface - Represents text content data extracted from text-based nodes.
• Experimental TextFrameAreaGeometry interface - Defines the geometry of a text frame area.

Updated

• Experimental ThreadedTextContentModel.frames property - Updated to properly support the new threaded text implementation with ThreadedTextList.

2026-01-13

Adobe Express Developer MCP Server Updates

• The Adobe Express Add-on MCP Server (Beta) has been replaced by the Adobe Express Developer MCP Server, which is now officially supported and production ready.
• It ships under a new npm package (@adobe/express-developer-mcp) and supersedes the beta version (@adobe/express-add-on-dev-mcp) now deprecated, in all MCP configurations. Learn how to set it up and use it to enhance your development workflow in compatible editors such as Cursor.

Added

• New Add-on Architecture guide with dual-runtime system explanation, SDK imports and usage, and cross-runtime communication patterns.
• New Add-on Project Anatomy & CLI Templates guide with add-on project structure, file organization, and template selection for efficient Adobe Express add-on development.
• New Add-on Development Terminology guide with standardized definitions, decision matrices, and troubleshooting for Adobe Express Add-on development terminology.
• New practical usage guide for Using Add-on UI SDK Constants, focusing on import patterns, common pitfalls, and solutions for UI SDK constants.
• New practical usage guide for Using Document Sandbox Constants to guide on the use of constants in the Document Sandbox environment, including colorUtils integration and practical examples.
• New "SDK Fundamentals" section in navigation under "Learn" to group terminology and constants usage guides for better discoverability.

Updated

• Major restructure of the Add-on UI SDK Constants Reference.
• Improved content and metadata for SEO and AI assistant optimization.
• Breaking change: Removed experimental resize/rescale methods (rescaleProportionalToWidth(), rescaleProportionalToHeight(), resizeToFitWithin(), resizeToCover()) and replaced with unified experimental resize() method offering more flexible behavior control via ResizeBehavior options. The experimentalApis flag is required.

2025-12-28

Added

• SVG image support in addImage() - You can now import SVG files (image/svg+xml) to the document using the addImage() method.

Updated

• getSelectedPageIds() method promoted from experimental to stable - Retrieve the currently selected page IDs in the document. The experimentalApis flag is no longer required to use this API.

2025-11-29

Code Playground Updates

The Adobe Express Code Playground has received a major update with the release of a new set of features and improvements.

• Open Code Playground with a single click (https://www.adobe.com/go/addon-playground) or find the Code Playground button in the top navigation bar of the How-to guides, Hello World!, Code Playground pages, and other sections. You can also bookmark links that point to either the Script or Add-on Mode.

• The Code Playground now supports multiple sessions backed up in the cloud, allowing you to save your work and resume where you left off anywhere. Check out the More menu to manage your sessions (find, rename, or delete).

• Now you can try out the code blocks (e.g. in the How-to guides) by simply clicking on the Try in playground button.

• The Code Playground documentation has been updated and split into multiple pages for better organization.

  • Overview
  • Script Mode
  • Add-on Mode
  • Workflow & Productivity
  • Troubleshooting

Added

• It's now easier to identify Console logs coming from the CLI or Code Playground, because they automatically include new helpful prefixes such as [Playground: Add-on], [Playground: Script], and [Add-on: <add-on-name>].
• Open Add-on testing window with a single click. Bookmark the URL (https://www.adobe.com/go/addon-cli) to easily access it later.
• New Express-specific Document API classes: ExpressContext, ExpressEditor, and ExpressViewport, which inherit from the corresponding non-specific Classes.
• New Text classes: StandaloneTextContentModel and ThreadedTextContentModel, representing a complete piece of text content contained within a single StandaloneTextNode or split across multiple ThreadedTextNodes.
• Experimental ImageRectangleNode.fetchBitmapImage() method - Fetch the bitmap image associated with the image rectangle node.
• Experimental BitmapImage.data() method - Fetch the bitmap image data as a Blob.

Updated

• The Context.currentPage() method has moved to the new ExpressContext.currentPage().
• The Viewport class has been renamed to ExpressViewport.

2025-11-10

Added

• New Known Issues & Limitations documentation for Chrome Local Network Access restriction (Chrome 142+) that affects local add-on development
• New FAQ entry with troubleshooting steps for the Chrome Local Network Access permission prompt
• Added informational alert in the Browser debugging guide to notify Chrome users about the Local Network Access permission requirement

2025-10-08

Added

• Experimental id property - Unique identifier for text content models
• Experimental TextStyleSource enumeration - Options for text style source matching

Updated

• cloneInPlace() method promoted from experimental to stable - Available on all node types for creating copies with subtrees
• paragraphStyleRanges property promoted from experimental to stable - Get/set paragraph-level styles with ranges
• applyParagraphStyles() method promoted from experimental to stable - Apply styles to specific paragraph ranges
• layout property promoted from experimental to stable - Control text layout modes for standalone text
• layout property promoted from experimental to stable - Control text layout modes for threaded text
• AreaTextLayout interface promoted from experimental to stable - Fixed width and height text layout configuration
• AutoHeightTextLayout interface promoted from experimental to stable - Auto-height text layout configuration
• AutoWidthTextLayout interface promoted from experimental to stable - Auto-width text layout configuration
• UnsupportedTextLayout interface promoted from experimental to stable - Representation of unsupported text layouts
• ParagraphStyles interface promoted from experimental to stable - Complete paragraph style definitions
• ParagraphStylesInput interface promoted from experimental to stable - Input interface for paragraph styles
• ParagraphStylesRange interface promoted from experimental to stable - Paragraph styles with text ranges
• ParagraphStylesRangeInput interface promoted from experimental to stable - Input interface for paragraph style ranges
• BaseParagraphStyles interface promoted from experimental to stable - Base paragraph style properties
• OrderedListStyleInput interface promoted from experimental to stable - Configuration for ordered lists
• UnorderedListStyleInput interface promoted from experimental to stable - Configuration for unordered lists
• OrderedListStyle type promoted from experimental to stable - Type definition for ordered list styles
• UnorderedListStyle type promoted from experimental to stable - Type definition for unordered list styles
• OrderedListNumbering enumeration promoted from experimental to stable - Numbering types for ordered lists
• ParagraphListType enumeration promoted from experimental to stable - List type enumeration with none value added
• Removed experimental warnings from documentation guides for all APIs promoted to stable, including the Use Text guide

2025-10-02

Added

• New ImportAddOnData parameter support for enhanced metadata tracking on imported media in addImage(), addVideo(), addAnimatedImage(), and enableDragToDocument() methods.
• New Handle Element Selection How-to Guide covering selection operations, real-time selection events, UI integration patterns, selection-based actions, and working with locked elements.
• New Manage Pages How-to Guide covering page creation, navigation, and management, positioned in a new Document Structure navigation category.
• MediaAttributes parameter documentation for addVideo() method.

Updated

The following how-to guides have been updated with ImportAddOnData support for enhanced metadata tracking on imported media, including examples and implementation patterns:

• Use Images
• Use Videos
• Drag and Drop
• Element Metadata

2025-09-10

Added

• New Text Replacement APIs: appendText(), deleteText(), insertText(), and replaceText().

data-slots=text

data-variant=warning

data-className=inline-alert-bullet-aligned

• New mediaAddOnData to support additional metadata on the ImageRectangleNode.
• New link property in Character Style ranges CharacterStylesInput to support hyperlinks.
• The Use Text guide has been updated to include the new Text APIs.
• The Use Images guide has been updated to include a replaceMedia() example.

Updated

• Renamed clone() to cloneInPlace().

data-slots=text

data-variant=warning

data-className=inline-alert-bullet-aligned

• Updated maskShape in GridCellNode to readonly.
• The BitmapImage has been converted from an interface to a class.

2025-09-01

Added

Introduced a new guide with the release of our public beta Adobe Express Add-on MCP Server.

With MCP-enabled IDEs (Cursor, Claude Desktop, VS Code etc.), developers can connect to the Adobe Express Add-on MCP Server (Beta) to accelerate their add-on development with contextually-aware responses and reduced hallucinations from their AI-assistants.

2025-08-25

Added

• New experimental getSelectedPageIds() method to the addOnUISdk.app.document API. This method retrieves the currently selected page IDs in the document, useful for getting metadata or performing operations on only the pages that the user has selected.
• New PptxRenditionOptions object for PPTX export support in the createRenditions() API. PPTX export is only available for presentation-type documents in Adobe Express.
• New RenditionFormat.pptx constant added to support PowerPoint presentation export format with MIME type "application/vnd.openxmlformats-officedocument.presentationml.presentation".

Updated

• Page Metadata how-to guide with documentation and examples for the new experimental getSelectedPageIds() method, including usage patterns for getting metadata of only selected pages.
• Create Renditions how-to guide with comprehensive PPTX export support documentation, including developer guidance about font differences and content limitations when exporting to PowerPoint format.
• Add-on Iframe Context guide with additional permissions documentation, including details about oauth, clipboard, microphone, and camera permissions beyond the existing sandbox permissions.
• FAQ with a new comprehensive entry about available add-on permissions and their configuration, plus updated supported file formats for imported content organized by category (Image, Design, Video, Audio).

2025-08-14

Added

• The Code Playground now includes a download feature that allows developers to export their playground code as a zip file containing both the add-on folder structure and a standalone script file. This enables seamless transition from prototyping in the playground to local development using the CLI.

2025-07-27

Added

• New isAnonymousUser() method to the addOnUISdk.app.currentUser API. This method returns a boolean indicating whether the current user is browsing as a guest (not logged in).
• New exportAllowed() method added to the addOnUISdk.app.document API. This method determines whether the current document can be exported based on its review status in collaborative review and approval workflows.
• Enhanced importPdf() method now supports a SourceMimeTypeInfo parameter. When your add-on converts Word documents (.docx) or Google Docs (.gdoc) to PDF before importing, you can now specify the original file's mime type to improve the user experience.
• Enhanced drag-and-drop functionality with SourceMimeTypeInfo support.
• New fileSizeLimit and fileSizeLimitUnit properties added to the PngRenditionOptions object.
• New bitRate and frameRate properties added to the Mp4RenditionOptions object.

Updated

• User Info guide with guidance on handling logged out users (browsing as a guest), with important considerations and limitations.
• Create Renditions guide to include proactive export permission checking using exportAllowed() before creating renditions with RenditionIntent.export or RenditionIntent.print. The guide now demonstrates graceful fallback to preview renditions when export is restricted.
• PDF and PowerPoint guide with information about the sourceMimeType parameter for improved UX when importing converted documents.
• Drag-and-Drop guide with examples of using sourceMimeType when dragging converted documents.
• The Grids add-on tutorial has been updated to use the Adobe Express native Color Picker instead of the hidden <input> element workaround.

2025-07-25

Added

• The Text API has been updated to include Super/SubScript via the baselineShift property of the CharacterStyles interface. The corresponding TextScriptStyle enumerable has been added. The new API has been introduced as stable.
• A new cloneInPlace() method has been added to the Node class and propagated to all its subclasses, which allows you to clone a node and all its children. This new API is still experimental, and requires the experimentalApis flag to be set to true in the add-on's manifest.json.
• New MediaRectangleNode, a base class for a rectangular node that represents the uncropped media within a MediaContainerNode.
• New UnknownMediaRectangleNode, a subclass of MediaRectangleNode for cases where the media type is not yet supported by the API.

2025-07-11

Added

• New Markdown Parser add-on tutorial covering the Text API, while building from scratch an add-on capable of parsing Markdown files and converting them into rich text directly within an Adobe Express document.
• New Resize and Rescale Elements how-to guide, which covers the new Resize/Rescale APIs, and provides examples and code snippets.

2025-06-19

Added

The Page Metadata API now includes new properties to detect audio, video, and animated content on pages. You can retrieve duration information for pages with temporal content (such as timelines). We've also updated the how-to guide to cover these new capabilities.

2025-06-06

Updated

• Enhanced monetization guidelines documentation in the Public add-on Distribution guide with additional clarity on Adobe's requirements and recommendations for monetizing add-ons. Developers are encouraged to carefully review the updated monetization guidelines for the latest information.

2025-05-27

Added

• Four new Resize/Rescale APIs have been added to the Node class as experimental features:

  • rescaleProportionalToHeight()
  • rescaleProportionalToWidth()
  • resizeToCover()
  • resizeToFitWithin()

• Editor.createText() now accepts a String parameter, which sets the text content of the new node. The use without a parameter is deprecated.

• TextNode is now an abstract base class with two specialized subclasses:

  • StandaloneTextNode: displays text in a single frame.
  • ThreadedTextNode: supports text that can flow across multiple frames.

2025-05-26

Added

• Added support for retrieving published (shared) document links via the new LinkOptions enumerable in addOnUISdk.app.document.link(), along with the documentPublishedLinkAvailable event, which is triggered when the published link becomes available. Both updates are reflected in the Document Metadata How-to Guide.

data-slots=text

data-variant=warning

Updates

• @adobe-ccwebext/ccweb-add-on-sdk-types: Type Definitions for the CLI have been updated to version 1.17.0.

2025-05-16

Updated

• We’ve completely revamped the information architecture of the site! 🎉 The new structure is designed to make content easier to navigate, whether you’re just getting started or you’ve been building add-ons for a while. This update aims to reduce friction, surface what matters most, and help both newcomers and experienced developers find their way faster. Among the changes, we have:

  • Rebuilt the Guides navigation from scratch, and grouped the content in new sections (Getting Started, Learn, Build, Support).
  • Introduced a new Developer Journey page.
  • Rewritten and improved the QuickStart guide, now Hello, World!
  • Moved the Tutorials as Complete Projects within the How To Guides, now more visible.
  • Regrouped content into the new Platform Concepts and Advanced Topics sections.
  • Updated screenshots, added animations, and enhanced the overall site usability.

• Note: with the new site structure, some of your bookmarks may be broken. We'll set redirects for the most common links, but please check and update them.

• We're constantly thinking about ways to improve the developer experience; there is more to come, stay tuned and reach out if you want to share your thoughts!

data-variant=info

data-slots=header, text, text2

2025-05-07

Added

• New Using Lit & TypeScript Guide to help developers understand and use Lit and TypeScript in their add-ons.

2025-05-05

Updated

• There are a few notable changes regarding the Color Picker APIs, which have now moved to stable:

  • The initialColor parameter now accepts a string in "#RRGGBB[AA]" format, in addition to the previous HEX number 0xRRGGBB[AA]—both with optional alpha channel.
  • We fixed the return value of the ColorPickerEvent.colorChange event, which now correctly handles the color with or without the alpha channel, depending on the value of the disableAlphaChannel parameter.
  • Breaking change: the ColorPickerEvents enum has been renamed to ColorPickerEvent (singular).

• Renamed the TextType enumerable to TextLayout in the Text APIs.

2025-04-22

Updated

• The Code Playground documentation has been updated with details about the new Script Mode and Local Persistence features, as well as additional details around existing features. The updates include:

  • New sections explaining Script Mode and Add-on Mode.
  • Detailed descriptions of the different tabs available in the Add-on mode and what type of code belongs in each.
  • Information about local persistence and session management.
  • Additional guidance on transitioning code between modes.
  • New keyboard shortcuts for improved productivity.

2025-04-10

Added

• New link() method added to the addOnUISdk.app.document reference and Document Metadata How-to Guide. This method retrieves the document link and triggers a documentLinkAvailable event when the link is available.
• New vue-starter sample add-on to help developers get started using Vue.js in their add-ons.
• Fixes fromRGB() method reference in the Using Color How-to.

2025-04-03

Added

• A new hasUnavailableFonts() method is added to TextContentModel class, which returns true if the text contains any fonts unavailable to the current user.

data-slots=text

data-variant=warning

Updated

The CLI has been updated with the following package versions:

• @adobe/ccweb-add-on-manifest: 3.0.0
• @adobe/create-ccweb-add-on: 3.0.0
• @adobe/ccweb-add-on-scaffolder: 3.0.0
• @adobe/ccweb-add-on-analytics: 3.0.0
• @adobe/ccweb-add-on-core: 3.0.0
• @adobe/ccweb-add-on-scripts: 3.0.0
• @adobe/ccweb-add-on-ssl: 3.0.0
• @adobe/ccweb-add-on-sdk-types: 1.14.0

IMPORTANT: As a result of the above, please be aware of the following:

1. Node-related tooling requirements are now:

• Minimum node version: 18
• Minimum npm version: 10

2. SSL Certificates:

SSL for hosting add-ons is now managed from the following locations:

• Mac: /Users/[user]/Library/Application Support/Adobe/CCWebAddOn/devcert
• Windows: C:\Users\Administrator\AppData\Local\Adobe\CCWebAddOn\devcert

After updating @adobe/ccweb-add-on-scripts to 3.0.0, developers will be asked to re-create their SSL certificate.

For a new add-on created using npx @adobe/create-ccweb-add-on@3.0.0, a new SSL certificate will be set up one-time.

For removing expired SSL certificate or certificate authority, developers can now run: npx @adobe/ccweb-add-on-ssl purge, and re-create them using npx @adobe/ccweb-add-on-ssl setup --hostname localhost

3. Spectrum Web Components

• The version of @swc-react components in the templates based on React has been updated to 1.0.3.

• The version of @spectrum-web-components components in the templates based on SWC has been updated to 1.1.2.

• The theme usage has been updated to use the system attribute instead of theme, ie:

  • SWC: <sp-theme system="express" color="light" scale="medium">
  • React: <Theme system="express" scale="medium" color="light">

2025-03-21

Added

• A native Color Picker is available to add-ons via the showColorPicker() and hideColorPicker() methods of the addOnUiSdk.app object.
• We've updated the Use Color How-to guide, now including a few examples on the Color Picker.
• A new section has been added to the documentation, which provides a reference for the Adobe Express built-in UI components available to add-ons, like the Color Picker.
• A new version of the @adobe/ccweb-add-on-sdk-types package (v1.14.0) has been released for the CLI. Run npm update from the root of your add-on project to update to get the latest typings.

2025-03-07

Added

• A new How-to section replaces the old Use Cases, expanding it to include more detailed guides on specific topics, like using Text, Color, or Geometry. Each guide includes a brief description, example code snippets, and links to relevant API references.

2025-03-06

Added

• An FAQ item was added for a known issue found where the CLI is failing on Windows when running certain versions of Node.js. The FAQ provides a workaround for this issue.

• The following new properties have been added to the AddOnSdk PageMetadata API:

  • isBlank: Allows you to check if a page is blank.
  • templateDetails: Retrieves details about the template used to create the document.

• A new runPrintQualityCheck method has been added to the AddOnSdk App.Document API, which allows you to run a print quality check on the document to ensure that it meets print quality standards.

data-slots=text

data-variant=warning

2025-03-04

Changed

• Stabilized the following HLAPI's:

  • The TextNode API's.
  • The fromPostscriptName() API of Fonts class.
  • The TextContentModel APIs like TextContentModel.characterStyleRanges. The experimentalApis flag is no longer required to use these APIs.

2025-03-03

Changed

• The Per Element Metadata APIs have been stabilized. You can refer to the AddOnData class for details. The experimentalApis flag is no longer required to use these APIs.

• The Selection Change Notification Events APIs have been stabilized. You can refer to the Context class, which provides two methods: on() and off(). These methods allow you to register and un-register notifications for selection changes and selection properties changes. The experimentalApis flag is no longer required to use these APIs.

2025-02-26

Added

New Feature: Add-on Icon Auto-Resizing Support

• Icon Size Requirement: The uploaded icon must be 144 px.

• Auto-Resizing: Once uploaded, the icon will be automatically resized to:

  • Minimized Add-on Module Icon: 36 px
  • Panel Header Icon: 64 px
  • Launchpad Icon: 144 px

API paragraphStyleRanges

Added new TextContentModel.paragraphStyleRanges,i.e. ParagraphStyles API as experimental, to apply styles to different paragraphs of text content.

Changed

Stabilized registerIframe() and openEditorPanel() APIs. The experimentalApis flag is no longer required to utilize these APIs.

2025-02-17

Update

• Starting February 17, 2025: Listings will not be visible in the European Union unless trader information is provided.
• Compliance: Trader information will be displayed publicly on listing detail pages to comply with EU Digital Services Act (DSA) regulations.

Add trader details now.

Fixed

• Fixed an issue where the addAnimatedImage() API was not working as expected.
• Fixed the technical requirements for GIF; the maximum resolution is 1080px.

2025-01-27

Changed

Stabilized importPdf() and importPresentation() APIs. The experimentalApis flag is no longer required to utilize these APIs.

2025-01-17

Added

• A new Viewport class has been added to the Document APIs. Viewport represents the canvas area currently visible on-screen.
• A new API bringIntoView have been added which adjusts the viewport to make the node's bounds visible on-screen, assuming all bounds are within the artboard bounds.

2025-01-13

Added

• Adds a new section in Listing Your Add-on guidelines which describes how to add trader details in the publisher profile.

data-variant=warning

data-slots=text1, text2, text3

2024-11-04

Added

• Adds a new Cross-origin Isolation Handling page which describes an upcoming change to how Adobe Express enforces cross-origin isolation, and the impact it may have on current add-ons, as well as those currently in-development.
• Updates the descriptions for the importPdf() and importPresentation() functions to clarify that when used, the associated PDF or presentation file will be imported as a new Adobe Express document.

2024-10-08

• Adds a brand new version of the UX Guidelines for Adobe Express add-ons.
• Removes the experimental warnings for addAnimatedImage() since it is now stable.
• Adds the author property to MediaAttributes to allow it to be used with the addAudio() API.

2024-09-30

New

• Added many new Text APIs for improved text management.

  • TextNode.fullContent accessor: returns the TextContentModel containing the complete text string and its styles associated to the Text Flow (Threaded Text or Overflow Text).
  • TextNode.nextTextNode accessor: gets the next node that overflowing text will spill into.
  • TextNode.layout accessor: gets and sets the TextType of the text node frame.
  • TextNode.visualEffects accessor: list of VisualEffectType applied to the text node.
  • TextContentModel.characterStyleRanges accessor: list of character style ranges in the text content, controlling the color, font ranges in the text content, controlling the color, fontSize ranges in the text content, controlling the color, letterSpacing ranges in the text content, controlling the color and underline ranges in the text content, controlling the color properties.
  • AvailableFont and UnavailableFont classes.
  • Supporting interfaces, enumerations and type aliases.

• Added Per Element Metadata APIs: with this feature, add-ons can store private metadata to any node of the Express document. This metadata is accessible only to the add-on that has set it. See the AddOnData class and the addOnData accessor for the BaseNode class.

• Added Selection Change Notification Events APIs: add-on can register to be notified when selection and properties in the selection changes on the document. The Context class will expose two on() and off() methods which can be used to register and un-register selection change and selection properties change notifications.

• Added a new GridCellNode class that represents a cell in a grid.

data-slots=text

data-variant=warning

Fixed

• GridLayoutNode.allChildren does not include rectangle nodes.

Deprecated

• TextNode.text is now deprecated; it is still working, but will be removed in a future update. Please use TextNode.fullContent.text instead.

2024-09-24

• Adds a new addAnimatedImage() method which can be used to add animated GIF images to the document (as long as they fit within certain technical constraints).
• Adds a new importPdf() method which can be used to import a PDF as a new Adobe Express document.
• Adds a new importPresentation() method which can be used to import a Powerpoint as a new Adobe Express document.
• Adds notes about specific support and handling for animated GIF images when importing and dragging content. This includes a new FAQ item summarizing the associated use cases.
• Adds all of the new methods mentioned above to the How-to section with example code snippets for each.

data-slots=text

data-variant=warning

2024-09-10

• Added a new replaceMedia() method to the MediaContainerNode class that can be used to replace existing media inline.
• Refactoring done to the Stroke APIs.

2024-07-22

• Added a new format property to the addOnUISdk.app.ui object that reflects the format used to display dates, times, numbers, etc. in the user's environment. It supports a "formatchange" event triggered when the format changes—see an example in the Locale, Supported Locales, and Format section.
• Removed mobile and app as supportedDeviceClass values in the Manifest's requirements.apps object.

2024-05-28

• Added a new experimental openEditorPanel() API to programmatically open and interact with the Editor panel. This method of the addOnUISdk.app.ui allows navigation to specific tabs and collections, as well as performing content searches. The Constants page has been updated accordingly.
• Added a new Cross-Origin-Embedder-Policy FAQ.

2024-05-21

• The Quickstart and Distribute guides have been updated to reflect major UI/UX improvements for in-app workflows, particularly around distribution and listing management.
• The Add-ons tab is now active also in the Adobe Express home page, regardless of whether a project is open or not.
• A new section on Marketplace rejections has been added, highlighting the most common problems found during the add-on review process and how to avoid them.
• The Manifest Reference has been updated with two new permission properties: microphone and camera.

2024-04-10

• A new VisualNode class has been added to the Document APIs, and represents any node that can be visually perceived in the content.

• New Document APIs have been added:

  • currentPage Context accessor: returns the active page.
  • visualRoot accessor: the highest ancestor that still has visual presence in the document—typically, an Artboard.
  • cloneInPlace() method: clones a Page, all artboards within it, and all content within those artboards.
  • Support to Bounds has been added in several classes: boundsInParent; boundsLocal (for both GroupNode and VisualNode); centerPointLocal; topLeftLocal; boundsInNode(); localPointInNode();

• The CLI has been updated to release version 2.0.0, and includes the following:

  • Periodic login and EULA consent are no longer required.
  • Two new templates for creating add-ons with built-in support to Spectrum Web Components have been added and documented: swc-javascript and swc-javascript-with-document-sandbox. Typescript templates have been renamed to swc-typescript and swc-typescript-with-document-sandbox. See this page for details on all the available templates.
  • Typings have been updated to include the latest SDK changes, and other internal packages are now at version 2.0.0.

  NOTE: The new version should be installed by default when you create a new add-on. If, for any reason, it doesn't, you can force it to install by clearing the npx cache first with npx clear-npx-cache or by specifying the version in the command, i.e.: npx @adobe/create-ccweb-add-on@2.0.0 my-add-on.

• The Samples page has been updated to document the existing add-ons in the express-add-on-samples repository, including a newly added audio-recording-addon.

• The Common Use Cases section has been refactored as a sub-menu, grouping similar topics into individual pages. A new Login and Logout flows section has been added. Other minor fixes and improvements have been made to the documentation.

2024-03-19

• Support for Ps and Ai files to be added to the page via the addImage() method. (Note: there were no changes to the drag-n-drop APIs).
• Adds new MediaAttributes parameter to the addImage() method for Ps/Ai file types to pass media attributes like title.
• Adds new Mp4RenditionOptions object to support mp4 renditions.
• Adds new VideoResolution constant to set video resolution options.
• Adds registerIframe() method and unregisterIframe type definition with example usage. NOTE: These APIs are currently experimental.

2024-03-08

• getPagesMetadata(), startPremiumUpgradeIfFreeUser and isPremiumUser have been moved to stable and no longer require the experimentalApis flag to be set.
• New examples have been added to the use cases guide for handling premium content.
• A new video has been added to the grids tutorial to help guide developers in building the grids add-on.

2024-02-21

• New support for monetization details has been added to the public distribution flow and allows you to provide details around monetization options your add-on supports. A selection will now be required when you submit a new add-on to the marketplace or update an existing one. The options include free, one-time payment, recurring subscription, micro-transactions, and other.

  In addition, the monetization guidelines were updated with details to help guide you in communicating your monetization strategy, and include new branding badges you can use to visually indicate when content or features require a purchase or when they are paid and unlocked. Please ensure you review the updated monetization guidelines carefully for specific details. NOTE: Adobe does not currently provide a specific monetization feature, but with this update, provides a way for developers to communicate the monetization details of their add-ons.

• The first phase of add-on analytics support has been released, and allows developers to download insights data for their published add-ons via the Download insights button in the in-app distribution modal.

• A new Concepts guide was added to the Document APIs section to provide a deep-dive into the architecture and key elements of the Adobe Express Document Object Model (DOM).

2024-02-14

• A new id accessor has been added to the BaseNode class in the Document APIs and is inherited by all classes that extend it. The id represents a unique identifier that stays the same when the file is closed and reopened, or if the node is moved to a different part of the document.

2024-02-07

• A new createPath method is now available for allowing you to create a path with the Document APIs.
• Updates descriptions in various methods and classes in the Document APIs.
• Updates to the createRenditions API, including a new print option for RenditionIntent to be be used for generating a print optimized pdf, and an update to PdfRenditionOptions which exposes the ability to customize each PDF Page Box's (MediaBox, BleedBox, CropBox, TrimBox) dimensions using a pageBoxes property.
• Updates to the Using Adobe Spectrum tutorial with additional details on why you should use Spectrum CSS variables to style your add-ons, and additional helpful guidelines for locating and using them.
• The table of contents in each Document API class/interface/constant has been removed since it was a duplicate of the right side navigation menu.

2024-01-31

Added a new tutorial - Building UIs using Adobe's Spectrum Design System.

2024-01-09

New Experimental APIs

• startPremiumUpgradeIfFreeUser() experimental API has been added to the addOnUISdk.app object to display the in-app monetization upgrade flow and returns a value indicating whether the user upgraded to premium or not.

• isPremiumUser() experimental API has been added to the addOnUISdk.app.currentUser object to determine if the current user is a premium or free user.

data-slots=text

data-variant=warning

Additional Updates

• A new PdfRenditionOptions object is now available to be used with the the createRenditions() export API and allows a user to specify an optional bleed object (for printing).
• A new isPrintReady property has been added to the PageMetadata API to indicate if the page is ready to print.
• Updated the FAQ regarding the mime type for exported PDF files. It will now return application/pdf (as opposed to text/plain from an earlier update).

2023-12-07

data-slots=text

data-variant=warning

Breaking changes (experimental APIs)

Some items in the following list of changes may have been mentioned in recent updates but are being listed in this summary again to serve as a reminder.

• The methods in the Document API Editor class to create a color fill and stroke have been renamed to makeColorFill and makeStroke respectively.

• strokes and fills have been renamed to their singular counterpart. (Express does not support multiple strokes or fills). You should use stroke and fill going forward to access them, and they will no longer be ItemList objects, since they represent only a single stroke or fill.

  // Before
  rectangle.fills.append(rectFill);
  ellipse.fills.append(ellipseFill);
  
  // After
  rectangle.fill = rectFill;
  ellipse.fill = ellipseFill;
  

  • fill and stroke.color are just a color object of the form { red, green, blue, alpha }.
  • stroke is an object of the form { color, width, dashPattern, dashOffset }

• Color utilities have moved to colorUtils instead of utils.

  Old<br/> <del>

  import { utils } from "express-document-sdk";
  const color = utils.createColor(1, 0, 0);
  

  </del>

  New<br/>

  import { colorUtils } from "express-document-sdk";
  
  // any of:
  const color = colorUtils.fromRGB(1, 0, 0); // optional alpha
  const color = colorUtils.fromRGB({ red: 1 , green: 0, blue: 0 };); // optional alpha
  const color = colorUtils.fromHex("#ff0000");
  const color = { red: 1, green: 0, blue: 0, alpha: 1 }; // mandatory alpha
  

  • fromHex returns a color from a Hex string -- e.g., colorUtils.fromHex("#FF8040") or colorUtils.fromHex("#FF8040FF") (including the optional alpha);
  • fromRGB returns a color from a set of RGB(A) values (0-1) -- e.g., colorUtils.fromRGB(1,0.5,0.25,1).
  • toHex converts a color object to a Hex string -- e.g., colorUtils.toHex(aColor).

• allChildren returns an iterator, not an Array. However if you want to use array methods (ie: Array#map), you can use Array.from to convert it to an array.

• Strokes and fills will no longer move if you add an existing stroke/fill to another shape (previously the original shape would lose the corresponding stroke or fill). For example:

  // Old way
  const greenFill = editor.createColorFill(colorUtils.fromRGB(0, 0, 1));
  someRect.fills.append(greenFill);
  anotherRect.fills.append(greenFill);
  /* oops, someRect no longer has a green fill, because anotherRect is its parent */
  

  versus:

  // New way
  const greenFill = editor.makeColorFill(colorUtils.fromRGB(0, 0, 1));
  someRect.fill = greenFill;
  anotherRect.fill = greenFill;
  /* both rectangles have a green fill */
  

• Some things that previously didn't make sense will now cause compile errors in typescript, or throw in javascript:

  • Do not assume a node's parent is movable — e.g., an artboard can't be repositioned.
  • Not all shapes support setting opacity or locking (e.g, the document root or an artboard).

• The translateX and translateY properties have been replaced by a single translation object.

  // old
  rectangle.translateX = 100;
  rectangle.translateY = 20;
  
  // new
  rectangle.translation = { x: 100, y: 20 }; // both x,y properties are required
  

• A new BaseNode class has been introduced, and ContainerNode has been moved from a class to an interface.

• The key to load APIs that use the Document APIs has changed, as well as the module names you import APIs from in the Document Sandbox. The old ones will still work, but the CLI and templates have all been updated to use the new names. Please update your add-ons to use the new ones shown below:

  Adobe Express Document APIs SDK import<br/> For access to the Express document and content authoring APIs:

  <del>

  // Old
  import { editor } from "express";
  

  </del>

  // New
  import { editor } from "express-document-sdk";
  

  Document Sandbox SDK import<br/> For access to the document sandbox runtime APIs:

  <del>

  // Old
  import AddOnScriptSdk from "AddOnScriptSdk";
  

  </del>

  // New
  import addOnSandboxSdk from "add-on-sdk-document-sandbox";
  

• The manifest.json entry point for the document sandbox script code reference was renamed from script to documentSandbox, as shown below:

    "entryPoints": [
          {
              "type": "panel",
              "id": "panel1",
              "main": "index.html",
              "documentSandbox": "code.js" // used to be "script": "code.js"
          }
      ]
  

• The apiProxy() method in the addOnSandboxSdk.instance.runtime object now accepts "documentSandbox" as a parameter when referring to the entry point in the manifest where your document sandbox code resides, instead of "script".

• The RuntimeType constant now uses the value of "documentSandbox" in lieu of "script".

  IMPORTANT: The above updates should be considered breaking changes, so any add-ons in development that relied on the experimental APIs may not work correctly until you make changes to use the new/updated ones above. The intention was to ensure these important changes were made prior to marking the APIs stable to 1) make them more intuitive for developers, 2) significantly improve the process of working with colors, strokes and fills, and 3) prevent certain operations from corrupting the document.

• The CLI has been updated to release version 1.1.1, and includes the following:

  • The document sandbox templates have been updated to reflect all of the latest changes to the Document Sandbox APIs, and the experimentalApis flag has been removed. Please review the updated references and changelog entries thoroughly for details on all of the recent changes. You may also want to refer to the document sandbox code samples for additional help on how to use them.
  • Typings support has been added to the javascript templates to enable intellisense features.
  • Manifest property additions.
  • General improvements and bug fixes.

  NOTE: The new version should be installed by default when you create a new add-on. If, for any reason, it doesn't, you can force it to install by clearing the npx cache first with npx clear-npx-cache or by specifying the version in the command, i.e.: npx @adobe/create-ccweb-add-on@1.1.1 my-add-on. You can update any existing add-ons to use this new version by updating the version of the ccweb-add-on-scripts in the package.json to 1.1.1.

• All code samples and the Document API tutorial have also been updated to reflect all of the latest changes to the Adobe Express Document Sandbox APIs listed here.

• Removed all experimental APIs notes/warnings around the Document Sandbox since they are now stable.

data-slots=text

data-variant=warning

Additional Updates

• A new getPagesMetadata() method is now available in the Add-on UI SDK document object and includes an example code snippet. NOTE: This method is still considered experimental only and should not be used in any add-ons you will be distributing until it has been declared stable. To use this method, you will first need to set the experimentalApis flag to true in the requirements section of the manifest.json.

• The createRenditions() export API was updated with the following changes:

  • You can now choose to generate renditions of specific pages via a new Range.specificPages constant value.
  • The returned type now also includes page metadata (see PageMetadata) including useful information such as the id, page size, pixels per inch, and whether the page has premium or temporal (timeline) content or not, (in addition to the existing blob and title). An example is provided in the reference as well as in the use cases.

• A new document metadata use case example has been added to show how to retrieve the document id and title (ie: name), including how to listen for the associated events.

• New tables have been added to the Communication API reference denoting the supported and unsupported data types that can be used across the Communication API layer.

2023-12-04

Updates

• The Document API's were updated to add a new ColorUtils class, which replaces the previous utils module that was used as a color helper with a more enhanced utlility. If you've used the old utils module in your add-ons, it will require you to update them to use the new named import of colorUtils instead of utils. Color creation should now be done using the new colorUtils module. An example of the old way and new way to create a color are shown below for reference:

  // Before
  import { utils } from "express-document-sdk";
  const color = utils.createColor(1, 0, 0);
  
  // After
  import { colorUtils } from "express-document-sdk";
  
  // any of:
  const color = colorUtils.fromRGB(1, 0, 0); // optional alpha
  const color = colorUtils.fromRGB({ red: 1, green: 0, blue: 0 }); // optional alpha
  const color = colorUtils.fromHex("#ff0000");
  const color = { red: 1, green: 0, blue: 0, alpha: 1 }; // mandatory alpha
  

  The code samples have also been updated, so please also refer to those for further details on how to use it. Please note, the example code snippets and samples using fills or strokes off a node class were also updated to use a singular Fill or Stroke object instead of as an ItemList object.

  // Before
  rectangle.fills.append(rectFill);
  ellipse.fills.append(ellipseFill);
  
  // After
  rectangle.fill = rectFill;
  ellipse.fill = ellipseFill;
  

• A new release has landed for the In-App Developer Submission experience in Express. Some highlights from the release:

  Create Add-on flow: You can now create an add-on "container" as your first step in building add-ons within the existing in-app distribution workflow. Creating the container gets you access to a few important settings and data (for instance your unique subdomain, see below) before you continue the development process in the CLI. All existing add-ons will automatically receive a parent container with the associated additional features today.

  Unique Subdomain retrieval: As part of your add-on container, you will now be able to easily retrieve a unique subdomain for your add-on. Simply choose one of your add-ons in the distribution workflow and navigate to the new "Settings" tab and copy the Add-on URL. This URL is handy for addressing issues with CORS by adding the URL as an allowed origin. See our CORS guide for more details.

  Delete Add-ons: The "container" concept allowed us to offer better management and cleanup of your add-ons. You will now find the option to delete an add-on container entirely from the new "Settings" tab of a given add-on.

  NOTE: You can only delete add-ons that have not been published publicly or submitted to our Review team. Please contact us if you need to un-publish an add-on.

  Supported Languages: The version details step for publishing add-ons publicly now includes fields to indicate which languages are supported by your add-ons (beyond the required English). You can choose from any of the languages Express supports, and your designation will be shown to users when they browse your listing details. See our sample for detecting a user's locale to localize your add-on.

• Updated list of templates and details to include the Document Sandbox template options, and how to still scaffold from one when the --template parameter is not explicitly supplied.

• New FAQ item regarding the mime type for exported PDF files. This is due to an unexpected change made in Adobe Express core to the mime type returned when you generate a PDF using the export createRenditions method. In the past it would return application/pdf, but currently it returns text/plain. This is something to be aware of if you are inspecting the mime type in the response and failing if it's anything other than application/pdf.

• Removed NPS survey.

2023-11-30

Updates

• Adds support to the Add-on UI SDK for retrieving the document id and title, as well as the ability for the add-on to be notified of the associated events.

• Updates the names of the SDK imports for the Document Sandbox and the Document API's SDK:

  Document Sandbox SDK import<br/>

  from:

  import AddOnScriptSdk from "AddOnScriptSdk";

  to:

  import addOnSandboxSdk from "add-on-sdk-document-sandbox";

  which also requires the following line to change in the example code to use the new reference:

  const { runtime } = addOnSandboxSdk.instance; // runtime object provides direct access to the comm methods

  Express Document SDK Import (for accessing the Document APIs<br/>

  from:

  import { editor } from "express";

  to:

  import { editor } from "express-document-sdk";

  NOTE: This includes the named imports for utils and constants modules as well if needed (ie: import { editor, utils, constants } from "express-document-sdk").

• Updates the manifest.json entry for the document sandbox script code reference from script to documentSandbox, as shown below:

    "entryPoints": [
          {
              "type": "panel",
              "id": "panel1",
              "main": "index.html",
              "documentSandbox": "code.js"
          }
      ]
  

• apiProxy() now accepts "documentSandbox" as a parameter when referring to the entry point in the manifest where your document sandbox code resides, instead of "script".

• The RuntimeType constant can now have a value of "documentSandbox" in lieu of "script".

data-slots=text

data-variant=warning

2023-11-28

Updates

• The Web API's in the Document Sandbox Reference were updated to remove the timer methods which are no longer supported (ie: setTimeout(), clearTimeout and setInterval(), clearInterval).

• The Document API References were updated with the following additions and changes:

  New Classes/Interfaces<br/>

  • New RestrictedItemList class
  • New UnknownNode class
  • New SolidColorShapeNode class
  • New Point interface
  • New queueAsyncEdit method added to the Editor class.

  Updates to Node Classes<br/>

The accessors and methods below were removed or replaced with new names in the Node class and classes that extend it. Please refer to the Document API References specifically to learn more about each.

• Removes absoluteRotation accessor
• Removes absoluteTransform accessor
• Removes relativeRotation accessor
• Removes relativeTransform accessor
• Removes translateX accessor
• Removes translateY accessor
• Adds rotation accessor
• Adds rotationInScreen accessor
• Adds transformMatrix accessor
• Adds translation accessor
• Adds setPositionInParent method
• Adds setRotationInParent method

2023-11-27

Updated Document API references to include:

• ComplexShapeNode class
• GridLayoutNode class
• IStrokableNode interface
• FillRule constant

2023-11-6

• Added a new tutorial section to the Getting Started guides, including a new "Building your first add-on with the Document API" tutorial by Davide Barranca.
• Updated the naming conventions from Script Runtime to Document Sandbox and Editor APIs to Adobe Express Document APIs. The Document Sandbox now includes the Communication APIs, Web APIs and the Document APIs.
• Updated sample code snippets to use the addOnUISdk import name (vs AddOnUISDK) similar to what's generated in the templates for consistency.

2023-10-26

Updates

New questions and answers added to the FAQ regarding Adobe's use of add-on data, where to file feature requests and more.

2023-10-10

Updates

Updates to the OAuth APIs to allow for a new optional windowSize parameter to be specified in the AuthorizationRequest object and the AuthorizeWithOwnRedirectRequest to set the desired size of the authorization window.

2023-10-09

Updates

Published new Guidelines and requirements section; including General guidelines, Developer brand guidelines, Monetization guidelines and Generative AI guidelines.

2023-10-03

Updates

New versions of the CLI packages:

  "@adobe-ccwebext/ccweb-add-on-manifest": "1.5.0"
  "@adobe-ccwebext/ccweb-add-on-core": "1.5.0"
  "@adobe-ccwebext/ccweb-add-on-ssl": "1.5.0"
  "@adobe-ccwebext/ccweb-add-on-analytics": "1.5.0"
  "@adobe-ccwebext/ccweb-add-on-developer-terms": "1.5.0"
  "@adobe-ccwebext/create-ccweb-add-on": "1.5.0"
  "@adobe-ccwebext/ccweb-add-on-scaffolder": "1.5.0"
  "@adobe-ccwebext/ccweb-add-on-scripts": "1.5.0"
  "@adobe-ccwebext/ccweb-add-on-sdk-types": "0.3.0"

which include:

• Updated templates for both iframe and document sandbox add-ons:

  • All new add-ons created (other than those based on javascript) use spectrum-web-components with the Express theme pre-set.
  • React-based templates include swc-react setup.
  • The javascript-with-editor-apis template has been removed from the initial template selection in this version but replaced with the option from the CLI to include the document sandbox when creating a new add-on.

• New type support for typescript based add-ons.

• Ability to recreate your SSL certificates.

Documentation updates

• Updated document sandbox Reference docs to reflect the new CLI prompt to include document sandbox (vs the specific template).
• Updated Getting Started guides documentation and screenshots to reflect the new Add-on Launchpad panel update to the new two-tab view for "Discover" and "Your Add-ons".

2023-09-26

Removed

• Removed the experimental APIs notes/warnings around the Audio APIs and User APIs since they are now stable.
• Removed references to the Dropbox sample since the import-images-from-oauth contains the same functionality.

Updated

• Updated the Express add-ons introduction video with a newly created version.

2023-09-25

Updates

The Editor API references have been updated with additional descriptions and details as well as some new and modified APIs:

• Artboard now has a single fill only. Note: it's possible that all node types will move to this model in the near future.
• The name property is now only available on PageNode, not all node types.
• New Node.locked & Context.selectionIncludingNonEditable properties were added for the locking feature that recently shipped in Express.

data-slots=text

data-variant=info

2023-09-19

Added

• New iframe Sandbox Context guide with details on the new subdomain support and CORS handling.
• How-to videos embedded in various guides to help visually show how to use the information in those sections.

Updates

• New Types Package Versions Released <br/>

  • A new version 0.1.6 of the @adobe-ccwebext/ccweb-add-on-sdk-types package with the latest typings for the AddOnSDK (iframe), including new experimental APIs, as well as general improvements and bug fixes.
  • A new version 0.2.0 of the @adobe-ccwebext/ccweb-add-on-sdk-types package with the latest typings for the document sandbox/Editor APIs.

  IMPORTANT: Developers who are NOT using the document sandbox/Editor APIs should update to their types package to 0.1.6 at minimum by changing the version of it to @adobe-ccwebext/ccweb-add-on-sdk-types@0.1.6 in the package.json.

  The new types 0.2.0 types package will be used automatically for any new add-ons created. If you would like to update an existing add-on to the 0.2.0 version, you will need to update the ccweb-add-on-sdk-typings.d.ts file in your add-on with the content here.

• Performance guide updates to include Task Manager and Memory Consumption details for add-ons.

• FAQ update for SharedArrayBuffer.

2023-09-12

Updates

• Added supported file types for import and export to the FAQ.

2023-09-07

Updates

<del>

• The Communication API in the document sandbox reference section was updated to change the example code importing the SDK to a default import rather than a named import as it was previously:

  from:

  import { AddOnSdkApi } from "AddOnSdkApi";

  to:

  import AddOnScriptSdk from "AddOnScriptSdk";

  Note that you can now name the imported module whatever you'd like, but for simplicity in the examples, the name is kept the same. Since these APIs are currently experimental, this change will not impact any in-production add-ons, however, it will require you to update any existing usage of these APIs in progress.

</del>

• A new 1.4.2 version of the CLI was also released with an updated javascript-with-editor-apis template reflecting the default SDK import noted in the first bullet above. The new CLI version will install automatically when you create a new add-on, or you can update existing add-ons by changing the version of the ccweb-add-on-scripts in the package.json to 1.4.2.
• Updated the FAQ with details on Experimental APIs and suppported file types for exported content.

2023-09-05

Added

Added new Audio API documentation. You can now import audio to the current Adobe Express document in two different methods:

1. Using the new addAudio() method, which requires a MediaAttributes object containing the title of the audio content.
2. Using drag and drop, and supplying the MediaAttributes object in the DragCompletionData.

Please note, in both cases, the MediaAttributes object is required for audio content, but optional for video and image content. A new code sample will be supplied in the near future, but in the meantime, please refer to the example usage snippets provided in the SDK Reference and Implementing Common Use Cases Guide.

2023-08-31

Added

Added new code sample to demonstrate how to use SWC-React and set theme properties in add-ons called swc-react-theme-sampler to the Code Samples.

Updated

• Updated the User Interface Guide to add more notes around the recommended use of swc-react over React Spectrum and to point to the new sample mentioned above.

Fixed

• Fixed bug in the locale example.

2023-08-29

• Added currentUser API details and usage example to the SDK References and Implementing Common Use Cases Guide.
• Added a new licensed-addon code sample to illustrate how to implement monetization by leveraging the current userid.
• Added devFlags API details, which can be used to simulate certain behavior during development.

2023-08-17

Bugs and Fixes

• There's currently a bug where addArtboard could crash the application or corrupt the document if there's no fill specified on the artboard. Please ensure you always add a fill in the same frame as the artboard creation until this issue is resolved. Also note, when this bug is fixed, the ArtboardNode will accept a single fill object, rather than an ItemList of fill(s).

• Currently, in the addPage API, a new page is created, but the selected context is not changed to the newly added artboard. As a result, from a UI perspective, the user remains on the previous page. A change will be implemented this week which will change the default context to the artboard child of the newly added page. This results in actual navigation to the newly added page, and all new content which is added using the Editor APIs will be added to this page.

  IMPORTANT: We recommend that you only test the use of these experimental Editor APIs against non-essential documents, due to the potential for loss or corruption.

Updates

• Premium Content handling details have been added to the Implementing Common Use Cases Guide. Note the warning for ensuring that you include the specified permissions in the manifest.json to allow-popups and allow-popups-to-escape-sandbox to ensure the pricing page can be loaded when needed (and note the addition of the renditionPreview flag in the requirements of the manifest when you want to allow premium content to be previewed).

2023-08-09

Added

• Added new references section for the document sandbox APIs.

Important notes on document sandbox APIs (aka Document Sandbox)

• These APIs are experimental!

  • Do not test your add-ons on documents that you care about as these APIs are not currently considered stable.
  • Be sure to only use documented APIs when writing your add-ons. Use of undocumented APIs (which may be prefixed with an underscore, but not always) is not supported and may cause your add-on to fail or lead to document corruption. Visibility of a method or property is visible via console.log is not an indication of whether that field is supported or documented.

• Debugging & Console messages

  • You may see "Empty transaction not added to pendingTransaction" while running code in the document sandbox. You can ignore this for now.
  • You may see "Detected a possible stutter. Excessive ECS Frame duration of ## ms" in the console. You can ignore this for now.
  • If your script code has a syntax error, the console will log an unhelpful error message (similar to Uncaught (in promise) at adobe-internal.js:49). Your add-on panel UI will be visible and continue to be interactive, but it won't be able to communicate with the document sandbox, resulting in what feels like non-responsive UI (e.g., clicking doesn't trigger the expected action). You'll want to configure your editor to highlight any syntax editors so that you can be sure your code is at least syntactically correct before you save.

• Intermittent issues

  • Auto reload of the add-on when a change is detected sometimes fails to work properly. This can result in changes to the UI HTML not being reflected, but can also cause the connection between the panel UI and the document sandbox to not be properly initialized (your UI may appear to be unresponsive as a result). If you encounter this situation, manually reloading the add-on from the developer panel will usually resolve the issue. We're working on a fix.
  • It's occasionally possible to run into a race condition where the communications bridge between the two contexts (panel vs document sandbox) is not set up in time. If you interact with your panel UI immediately after it's reloaded, the click may appear do nothing instead of invoking your script code. We're working on a fix for this.

• Common pitfalls

  • If you split your work on a document over multiple frames, be sure to protect against reentrancy, otherwise you may end up corrupting the user's undo stack. You should disable elements on the panel UI that could allow the user to execute your code before it is complete and then re-enable those elements when the code is done. The issue will be fixed in a future release.
  • When setting up communication between your panel UI code and your script sandbox code, calling apiProxy() with the wrong argument will do nothing without providing any error feedback. If communication is not working, carefully double-check your UI code is requesting the "script" API proxy and your script sandbox code is requesting the "panel" API proxy.

• Unexpected behavior

  • If the user has a selection and your add-on creates new content, the selection is cleared. This will be addressed before release. An API will be added in the future that will allow you to change the selection to content your add-on creates.

  • When you add text content to a document, font substitution is not working correctly. This means that if you use Asian-language characters, the user may see square boxes instead. If the user were to type the content manually, however, they would see the correct rendering. This issue will be fixed before release.

  • Setting a blend mode on a media container node (e.g., after calling editor.createImageContainer) will be visually reflected, but doesn't currently update the "Blend mode" field in the property panel.

  • Setting rotation on an empty group is ignored. Always add content (children) to a group first, and then set its rotation.

  • When removing elements from a parent element, the element may continue to show in the Adobe Express layer stack. This will be addressed in the future. This can also occur if you call clear() to remove all children from an element as well as when using removeFromParent().

  • Shape elements added to the document by users (via the Media tab) do not support fill or stroke properties at this time. Furthermore, you should generally avoid making changes to these shapes (they'll appear as group nodes), as this could corrupt the document. We'll add protections around this in an upcoming release.

  • While the API supports adding multiple strokes to elements, Express currently only supports editing the first stroke added. If you want to change the stroke of an element, remove the existing strokes and then add the new stroke so that the element continues to have a single stroke. For example:

    element.strokes.clear();
    element.strokes.append(newStroke);
    

• Likely API changes

  • Creating colors is currently done via utils.createColor(). We're likely to change how you assign colors to objects, so bear this in mind as you use the experimental APIs. Note that this means you cannot just pass a plain JS object of the form {red, green, blue} to the Editor APIs — it must be a color created using utils.createColor.
  • Editor API constants may be renamed or may change how they are accessed.
  • Fills and strokes can only be assigned to a single parent element. If you try to append a fill from one element to another element, the fill will be moved and not cloned (just like moving a scenenode object from one parent to another). This behavior may change in the future.
  • There is no support for fetch in the document sandbox environment. You can work around this by exposing a method from your panel that your script code can call that does the work of fetching remote content. In the future we may abstract this for you automatically.
  • The strokes API is likely to be modified so that it only supports a single stroke.

• Typings & Typescript

  • Typings and samples showing how to use Typescript will be available in a future release.

2023-08-01

Added

• Added new properties to the manifest reference for renditionPreview in the requirements section, and the script property to the entryPoints section to support the new experimental document sandbox APIs.
• Added DisableDragToDocument and dropCancelReason support to the addonsdk.app reference.

2023-07-11

Added

• UX Guidelines are now available!
• A new requestedSize parameter can now be supplied as part of the JPG and PNG rendition options passed in when exporting content with the createRenditions method.
• A new clipboard permission can now be set with the clipboard-write value in the manifest to allow an add-on to write data to the clipboard.
• Information on using fonts.
• CORS / COEP header handling added to the CORS guide

2023-06-08

Added

• Initial release for the beta version of Adobe Express.