Merge pull request #94 from AdobeDocs/vchiluka/doc-updates

Doc updates for Document Sandbox APIs

Author: undavide

README.md

@@ -22,7 +22,7 @@ This section outlines the steps that should be taken to format the generated Doc
 
 3. The API signatures generated in `classes`, `enumerations`, `interfaces`, `namespaces`, and `type-aliases` is indented. In these directories, find and replace all occurrences of `newline + > + space` with `newline + • + space`, ensuring no code example or closing tag is replaced.
 
-4. Find and replace all \`mat2d\` --> \[\`mat2d\`\]\(https://glmatrix.net/docs/module-mat2d.html\)
+4. Find and replace all \`mat2d\` --> \[\`mat2d\`\]\(https://glmatrix.net/docs/module-mat2d.html)
 
 5. Fix any `[iterator]` links to remove the brackets from the link references to ensure they work. For instance: `ArtboardList.md#%5Biterator%5D` should be `ArtboardList.md#iterator`. To fix, use Search again with a regex string of `.md#%5Biterator%5D` and replace with `.md#iterator`.
 

gatsby-config.js

@@ -126,6 +126,10 @@ module.exports = {
                 title: "Classes",
                 path: "references/document-sandbox/document-apis/classes/Editor.md",
                 pages: [
+                  {
+                    title: "AddOnData",
+                    path: "references/document-sandbox/document-apis/classes/AddOnData.md",
+                  },
                   {
                     title: "ArtboardList",
                     path: "references/document-sandbox/document-apis/classes/ArtboardList.md",
@@ -134,6 +138,14 @@ module.exports = {
                     title: "ArtboardNode",
                     path: "references/document-sandbox/document-apis/classes/ArtboardNode.md",
                   },
+                  {
+                    title: "AvailableFont",
+                    path: "references/document-sandbox/document-apis/classes/AvailableFont.md",
+                  },
+                  {
+                    title: "BaseFont",
+                    path: "references/document-sandbox/document-apis/classes/BaseFont.md",
+                  },
                   {
                     title: "BaseNode",
                     path: "references/document-sandbox/document-apis/classes/BaseNode.md",
@@ -166,6 +178,14 @@ module.exports = {
                     title: "FillableNode",
                     path: "references/document-sandbox/document-apis/classes/FillableNode.md",
                   },
+                  {
+                    title: "Fonts",
+                    path: "references/document-sandbox/document-apis/classes/Fonts.md",
+                  },
+                  {
+                    title: "GridCellNode",
+                    path: "references/document-sandbox/document-apis/classes/GridCellNode.md",
+                  },
                   {
                     title: "GridLayoutNode",
                     path: "references/document-sandbox/document-apis/classes/GridLayoutNode.md",
@@ -230,10 +250,18 @@ module.exports = {
                     title: "StrokeShapeNode",
                     path: "references/document-sandbox/document-apis/classes/StrokeShapeNode.md",
                   },
+                  {
+                    title: "TextContentModel",
+                    path: "references/document-sandbox/document-apis/classes/TextContentModel.md",
+                  },
                   {
                     title: "TextNode",
                     path: "references/document-sandbox/document-apis/classes/TextNode.md",
                   },
+                  {
+                    title: "UnavailableFont",
+                    path: "references/document-sandbox/document-apis/classes/UnavailableFont.md",
+                  },
                   {
                     title: "UnknownNode",
                     path: "references/document-sandbox/document-apis/classes/UnknownNode.md",
@@ -246,12 +274,36 @@ module.exports = {
               },
               {
                 title: "Interfaces",
-                path: "references/document-sandbox/document-apis/interfaces/BitmapImage.md",
+                path: "references/document-sandbox/document-apis/interfaces/AreaTextLayout.md",
                 pages: [
+                  {
+                    title: "AreaTextLayout",
+                    path: "references/document-sandbox/document-apis/interfaces/AreaTextLayout.md",
+                  },
+                  {
+                    title: "AutoHeightTextLayout",
+                    path: "references/document-sandbox/document-apis/interfaces/AutoHeightTextLayout.md",
+                  },
                   {
                     title: "BitmapImage",
                     path: "references/document-sandbox/document-apis/interfaces/BitmapImage.md",
                   },
+                  {
+                    title: "CharacterStyles",
+                    path: "references/document-sandbox/document-apis/interfaces/CharacterStyles.md",
+                  },
+                  {
+                    title: "CharacterStylesInput",
+                    path: "references/document-sandbox/document-apis/interfaces/CharacterStylesInput.md",
+                  },
+                  {
+                    title: "CharacterStylesRange",
+                    path: "references/document-sandbox/document-apis/interfaces/CharacterStylesRange.md",
+                  },
+                  {
+                    title: "CharacterStylesRangeInput",
+                    path: "references/document-sandbox/document-apis/interfaces/CharacterStylesRangeInput.md",
+                  },
                   {
                     title: "Color",
                     path: "references/document-sandbox/document-apis/interfaces/Color.md",
@@ -292,6 +344,14 @@ module.exports = {
                     title: "Point",
                     path: "references/document-sandbox/document-apis/interfaces/Point.md",
                   },
+                  {
+                    title: "PointTextLayout",
+                    path: "references/document-sandbox/document-apis/interfaces/PointTextLayout.md",
+                  },
+                  {
+                    title: "Rect",
+                    path: "references/document-sandbox/document-apis/interfaces/Rect.md",
+                  },
                   {
                     title: "RectangleGeometry",
                     path: "references/document-sandbox/document-apis/interfaces/RectangleGeometry.md",
@@ -300,6 +360,14 @@ module.exports = {
                     title: "Stroke",
                     path: "references/document-sandbox/document-apis/interfaces/Stroke.md",
                   },
+                  {
+                    title: "StyleRange",
+                    path: "references/document-sandbox/document-apis/interfaces/StyleRange.md",
+                  },
+                  {
+                    title: "UnsupportedTextLayout",
+                    path: "references/document-sandbox/document-apis/interfaces/UnsupportedTextLayout.md",
+                  },
                 ],
               },
               {
@@ -314,6 +382,10 @@ module.exports = {
                     title: "BlendMode",
                     path: "references/document-sandbox/document-apis/enumerations/BlendMode.md",
                   },
+                  {
+                    title: "EditorEvent",
+                    path: "references/document-sandbox/document-apis/enumerations/EditorEvent.md",
+                  },
                   {
                     title: "FillRule",
                     path: "references/document-sandbox/document-apis/enumerations/FillRule.md",
@@ -338,12 +410,32 @@ module.exports = {
                     title: "TextAlignment",
                     path: "references/document-sandbox/document-apis/enumerations/TextAlignment.md",
                   },
+                  {
+                    title: "TextType",
+                    path: "references/document-sandbox/document-apis/enumerations/TextType.md",
+                  },
+                  {
+                    title: "VisualEffectType",
+                    path: "references/document-sandbox/document-apis/enumerations/VisualEffectType.md",
+                  },
                 ],
               },
               {
                 title: "Types",
-                path: "references/document-sandbox/document-apis/type-aliases/SolidColorStrokeWithOptionalType.md",
+                path: "references/document-sandbox/document-apis/type-aliases/EditorEventHandler.md",
                 pages: [
+                  {
+                    title: "EditorEventHandler",
+                    path: "references/document-sandbox/document-apis/type-aliases/EditorEventHandler.md",
+                  },
+                  {
+                    title: "EventHandlerId",
+                    path: "references/document-sandbox/document-apis/type-aliases/EventHandlerId.md",
+                  },
+                  {
+                    title: "Font",
+                    path: "references/document-sandbox/document-apis/type-aliases/Font.md",
+                  },
                   {
                     title: "SolidColorStrokeWithOptionalType",
                     path: "references/document-sandbox/document-apis/type-aliases/SolidColorStrokeWithOptionalType.md",

src/pages/references/changelog.md

@@ -21,6 +21,34 @@ contributors:
 
 # Changelog
 
+## 2024-09-30
+
+### New
+
+- Added many new **Text APIs** for improved text management.
+  - [`TextNode.fullContent`](./document-sandbox/document-apis/classes/TextNode.md#fullcontent) accessor: returns the [`TextContentModel`](./document-sandbox/document-apis/classes/TextContentModel.md) containing the complete text string and its styles associated to the Text Flow (Threaded Text or Overflow Text).
+  - [`TextNode.nextTextNode`](./document-sandbox/document-apis/classes/TextNode.md#nexttextnode) accessor: gets the next node that overflowing text will spill into.
+  - [`TextNode.layout`](./document-sandbox/document-apis/classes/TextNode.md#layout) accessor: gets and sets the [`TextType`](./document-sandbox/document-apis/enumerations/TextType.md) of the text node frame.
+  - [`TextNode.visualEffects`](./document-sandbox/document-apis/classes/TextNode.md#visualeffects) accessor: list of [`VisualEffectType`](./document-sandbox/document-apis/enumerations/VisualEffectType.md) applied to the text node.
+  - [`TextContentModel.characterStyleRanges`](./document-sandbox/document-apis/classes/TextContentModel.md#characterstyleranges) accessor: list of [character style](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#color), [`font`](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#font), [`fontSize`](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#fontsize), [`tracking`](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#tracking) and [`underline`](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#underline) properties.
+  - [AvailableFont](./document-sandbox/document-apis/classes/AvailableFont.md) and [UnavailableFont](./document-sandbox/document-apis/classes/UnavailableFont.md) 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`](./document-sandbox/document-apis/classes/AddOnData.md) class and the [`addOnData`](./document-sandbox/document-apis/classes/BaseNode.md#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`](./document-sandbox/document-apis/classes/Context.md) class will expose two [`on()`](./document-sandbox/document-apis/classes/Context.md#on) and [`off()`](./document-sandbox/document-apis/classes/Context.md#off) methods which can be used to register and un-register selection change and selection properties change notifications.
+- Added a new [`GridCellNode`](./document-sandbox/document-apis/classes/GridCellNode.md) class that represents a **cell in a grid**.
+
+<InlineAlert slots="text" variant="warning"/>
+
+**IMPORTANT:** This round of new APIs is currently ***experimental only*** with the exception of `TextNode.fullContent.text`, and should not be used in any add-ons you will be distributing until it has been declared stable. To use them, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../references/manifest/index.md#requirements) section of the `manifest.json`.
+
+### Fixed
+
+- [`GridLayoutNode.allChildren`](../references/document-sandbox/document-apis/classes/GridLayoutNode.md#allchildren) does not include rectangle nodes.
+
+### Deprecated
+
+- [`TextNode.text`](../references/document-sandbox/document-apis/classes/TextNode.md#text) is now deprecated; it is still working, but will be removed in a future update. Please use [`TextNode.fullContent.text`](../references/document-sandbox/document-apis/classes/TextNode.md#fullcontent) instead.
+
 ## 2024-09-24
 
 -   Adds a new [`addAnimatedImage()`](./addonsdk/app-document.md#addanimatedimage) method which can be used to add **animated GIF** images to the document (as long as they fit within certain [technical constraints](./addonsdk/app-document.md#image-requirements)).

src/pages/references/document-sandbox/document-apis/classes/AddOnData.md

@@ -0,0 +1,131 @@
+[@express-document-sdk](../overview.md) / AddOnData
+
+# Class: AddOnData
+
+AddOnData class provides APIs to read, write, remove private metadata to a Node.
+This metadata is accessible only to the add-on that has set it.
+
+<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`.
+
+## Accessors
+
+### remainingQuota
+
+• `get` **remainingQuota**(): `Readonly`<`object`\>
+
+#### Returns
+
+`Readonly`<`object`\>
+
+an object with the remaining quota for private metadata on the node for this add-on.
+The object contains the following properties:
+
+- sizeInBytes: The remaining quota size in bytes (maximum 3KB).
+- numKeys: The remaining quota for the number of keys (maximum 20 keys).
+
+##### numKeys
+
+• **numKeys**: `number`
+
+##### sizeInBytes
+
+• **sizeInBytes**: `number`
+
+## Methods
+
+### `[iterator]`()
+
+• **\[iterator\]**(): `Iterator`<[`string`, `string`], `any`, `undefined`\>
+
+#### Returns
+
+`Iterator`<[`string`, `string`], `any`, `undefined`\>
+
+an iterator for all the private metadata entries on the node.
+The iterator yields the metadata key-value pairs.
+
+---
+
+### clear()
+
+• **clear**(): `void`
+
+Clears all private metadata entries on the node.
+
+#### Returns
+
+`void`
+
+---
+
+### getItem()
+
+• **getItem**(`key`): `undefined` \| `string`
+
+Retrieves the private metadata value for the specified key on the node.
+
+#### Parameters
+
+• **key**: `string`
+
+The key of the private metadata entry to retrieve.
+
+#### Returns
+
+`undefined` \| `string`
+
+The value of the private metadata entry.
+
+---
+
+### keys()
+
+• **keys**(): `string`[]
+
+#### Returns
+
+`string`[]
+
+an array of all keys for the private metadata entries on the node.
+
+---
+
+### removeItem()
+
+• **removeItem**(`key`): `void`
+
+Removes a single private metadata entry on the node.
+
+#### Parameters
+
+• **key**: `string`
+
+The key of the private metadata entry to remove.
+
+#### Returns
+
+`void`
+
+---
+
+### setItem()
+
+• **setItem**(`key`, `value`): `void`
+
+Sets a private metadata entry on the node.
+
+#### Parameters
+
+• **key**: `string`
+
+The key for the private metadata entry.
+
+• **value**: `string`
+
+The value for the private metadata entry.
+
+#### Returns
+
+`void`