Merge pull request #127 from AdobeDocs/barranca/doc-link

Barranca/doc link

Author: undavide

src/pages/guides/getting_started/changelog.md

@@ -22,6 +22,16 @@ contributors:
 
 # Changelog
 
+## 2025-05-26
+
+### Added
+
+- Added support for retrieving published (shared) document links via the new [`LinkOptions`](../../references/addonsdk/addonsdk-constants.md) 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](../learn/how_to/document_metadata.md).
+
+### Updates
+
+- [`@adobe-ccwebext/ccweb-add-on-sdk-types`](https://github.com/adobe/create-ccweb-add-on/releases): Type Definitions for the CLI have been updated to version `1.17.0`.
+
 ## 2025-05-16
 
 ### Updated

src/pages/guides/learn/how_to/document_metadata.md

@@ -21,7 +21,7 @@ contributors:
 
 # Use Document Metadata
 
-## Get the Document ID and Title
+## Get the Document ID, Title, and Link
 
 Through the [Add-on UI SDK Document object](../../../references/addonsdk/app-document.md), you can retrieve some information about the current document. Currently, there are asynchronous methods that allow you to retrieve the `id()` of the document and the `title()`. Also, associated events will let you listen for when the Document ID or the Document Title have changed, respectively via the `documentIdAvailable` and `documentTitleChange` events, which you can listen for with the [`addOnUISdk.app.on()`](../../../references/addonsdk/addonsdk-app.md#on) method.
 
@@ -40,7 +40,7 @@ addOnUISdk.ready.then(() => {
   const docTitle = await addOnUISdk.app.document.title();
 
   // Get the document Link
-  const docLink = await addOnUISdk.app.document.link();
+  const docLink = await addOnUISdk.app.document.link("document"); // or "published"
 
   console.log(`Document ID: ${docId}; Document Title: ${docTitle}`; `Document Link: ${docLink}`);
 
@@ -53,6 +53,16 @@ addOnUISdk.ready.then(() => {
   addOnUISdk.app.on("documentTitleChange", data => {
     console.log(`Document title changed to: ${data.documentTitle}`);
   });
+
+  // Listen for document link change
+    addOnUISdk.app.on("documentLinkAvailable", data => {
+      console.log(`Document ID changed to: ${data.documentLink}`);
+    });
+
+  // Listen for document published link change
+    addOnUISdk.app.on("documentPublishedLinkAvailable", data => {
+      console.log(`Document ID changed to: ${data.documentPublishedLink}`);
+    });
 });
 ```
 

src/pages/references/addonsdk/addonsdk-constants.md

@@ -114,6 +114,7 @@ A set of constants used throughout the add-on SDK. These constants are equal to
         <p>The type of link</p>
         <ul>
           <li><strong>document</strong></li>Link to the current document.
+          <li><strong>published</strong></li>Link to the published document.
         </ul>
     </td>
 </tr>

src/pages/references/addonsdk/app-document.md

@@ -92,7 +92,7 @@ A resolved `Promise` containing a [`PageMetadata`](#pagemetadata) array containi
 
 <CodeBlock slots="heading, code" repeat="2" languages="JavaScript, bash" />
 
-## Usage
+#### Usage
 
 ```js
 import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js";
@@ -128,7 +128,7 @@ async function logMetadata() {
 }
 ```
 
-## Output
+#### Output
 
 ```bash
 Page id: 772dc4b6-0df5-469f-b477-2a0c5445a6ef
@@ -250,7 +250,7 @@ A resolved `Promise` containing the `link` of the document.
 
 <InlineAlert slots="text" variant="info"/>
 
-A `documentLinkAvailable` event is triggered when the document link is available in the application. You can listen for this event via the [`addOnUISdk.app.on()`](./addonsdk-app.md#on) method.
+A `documentLinkAvailable` or `documentPublishedLinkAvailable` event is triggered when the document link is available in the application. You can listen for this event via the [`addOnUISdk.app.on()`](./addonsdk-app.md#on) method.
 
 #### Example
 
@@ -263,13 +263,33 @@ import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js";
 
 function setLink(link) { /* ... */ }
 
-addOnUISdk.ready.then(() => setLink(await AddOnSDKAPI.app.document.link("document"));
+addOnUISdk.ready.then(
+  () => setLink(await AddOnSDKAPI.app.document.link("document"))
+);
 
 addOnUISdk.app.on("documentLinkAvailable", data => {
   setLink(data.documentLink);
 });
+
+function setPublishedLink(link) { /* ... */ }
+
+AddOnSDKAPI.ready.then(
+  () => setPublishedLink(await AddOnSDKAPI.app.document.link("published"))
+);
+
+AddOnSDKAPI.app.on("documentPublishedLinkAvailable", data => {
+  setPublishedLink(data.documentPublishedLink);
+});
 ```
 
+#### `LinkOptions`
+
+The options to pass into the link method.
+
+| Name          | Type     | Description                                              |
+| ------------- | -------- | -------------------------------------------------------- |
+| `linkOptions` | `string` | [`LinkOptions`](./addonsdk-constants.md) constant value. |
+
 ## Import Content Methods
 
 ### addImage()

src/pages/references/changelog.md

@@ -22,6 +22,16 @@ contributors:
 
 # Changelog
 
+## 2025-05-26
+
+### Added
+
+- Added support for retrieving published (shared) document links via the new [`LinkOptions`](./addonsdk/addonsdk-constants.md) 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](../guides/learn/how_to/document_metadata.md).
+
+### Updates
+
+- [`@adobe-ccwebext/ccweb-add-on-sdk-types`](https://github.com/adobe/create-ccweb-add-on/releases): Type Definitions for the CLI have been updated to version `1.17.0`.
+
 ## 2025-05-16
 
 ### Updated