@adobe/spacecat-shared-content-client 1.7.39 → 1.8.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-content-client-v1.8.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.7.39...@adobe/spacecat-shared-content-client-v1.8.0) (2025-11-04)
+
+
+### Features
+
+* adding getEditURL support for content client ([#1047](https://github.com/adobe/spacecat-shared/issues/1047)) ([ca91f51](https://github.com/adobe/spacecat-shared/commit/ca91f512d3bf074d3fc88a6705f01f4a7661d6bc))
+
 # [@adobe/spacecat-shared-content-client-v1.7.39](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.7.38...@adobe/spacecat-shared-content-client-v1.7.39) (2025-11-04)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-content-client",
-  "version": "1.7.39",
+  "version": "1.8.0",
   "description": "Shared modules of the Spacecat Services - Content Client",
   "type": "module",
   "engines": {

package/src/clients/content-client.js

@@ -311,10 +311,12 @@ export default class ContentClient {
     return docPath;
   }
 
-  async #getHelixResourceStatus(path) {
+  async #getHelixResourceStatus(path, includeEditUrl = false) {
     const { rso } = this.site.getHlxConfig();
-    // https://www.aem.live/docs/admin.html#tag/status
-    const adminEndpointUrl = `https://admin.hlx.page/status/${rso.owner}/${rso.site}/${rso.ref}/${path.replace(/^\/+/, '')}`;
+    // https://www.aem.live/docs/admin.html#tag/status,
+    let adminEndpointUrl = `https://admin.hlx.page/status/${rso.owner}/${rso.site}/${rso.ref}/${path.replace(/^\/+/, '')}`;
+    // ?editUrl=auto for URL of the edit (authoring) document
+    adminEndpointUrl = includeEditUrl ? `${adminEndpointUrl}?editUrl=auto` : adminEndpointUrl;
     const response = await fetch(adminEndpointUrl, {
       headers: {
         Authorization: `token ${this.config.helixAdminToken}`,
@@ -349,6 +351,15 @@ export default class ContentClient {
     };
   }
 
+  /**
+   * @param {string} path
+   * @returns {Promise<string>}
+   */
+  async getEditURL(path) {
+    const helixResourceStatus = await this.#getHelixResourceStatus(path, true);
+    return helixResourceStatus?.edit?.url;
+  }
+
   async getPageMetadata(path) {
     const startTime = process.hrtime.bigint();
 
@@ -391,7 +402,7 @@ export default class ContentClient {
 
     const response = await document.updateMetadata(mergedMetadata);
     if (response?.status !== 200) {
-      throw new Error(`Failed to update metadata for path ${path}`);
+      throw new Error(`Failed to update metadata for path ${path}: ${response.statusText}`);
     }
 
     this.#logDuration('updatePageMetadata', startTime);

package/src/clients/index.d.ts

@@ -168,6 +168,28 @@ export class ContentClient {
   getLivePreviewURLs(path: string):
        Promise<{ liveURL: string | undefined, previewURL: string | undefined }>;
 
+  /**
+   * Retrieves the edit URL for a given content path from the AEM admin API.
+   * The edit URL represents the URL of the document source for the given content path
+   *
+   * The path should stem from a page's URL and is relative to the site's root.
+   * Example: "/path/to/page" (from the full URL: "https://www.example.com/path/to/page").
+   *
+   * @param {string} path The content path to get the edit URL for.
+   *
+   * @returns {Promise<string | undefined>} A promise that resolves to the edit URL
+   * string if found, or undefined if not available.
+   * @throws {Error} If the Helix admin API request fails or returns an error response.
+   *
+   * @example
+   * ```typescript
+   * const client = await ContentClient.createFrom(context, site);
+   * const editURL = await client.getEditURL('/content/page');
+   * console.log(editURL); // e.g., 'https://adobe.sharepoint.com/sites/Projects/_layouts/15/Doc.aspx?sourcedoc=%7xxxxxx-xxxx-xxxx-xxxx-xxxxxx%7D&file=page.docx&action=default'
+   *
+   */
+  getEditURL(path: string): Promise<string | undefined>;
+
   /**
    * Retrieves all links from a document at the specified path.
    * This method extracts links from the document content, including both internal