@adobe/spacecat-shared-content-client 1.7.8 → 1.7.10

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-content-client-v1.7.10](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.7.9...@adobe/spacecat-shared-content-client-v1.7.10) (2025-06-20)
+
+
+### Bug Fixes
+
+* properly identify broken internal link ([#813](https://github.com/adobe/spacecat-shared/issues/813)) ([4e19cbd](https://github.com/adobe/spacecat-shared/commit/4e19cbd632e128d78f996f63a436b1b8578b56a3))
+
+# [@adobe/spacecat-shared-content-client-v1.7.9](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.7.8...@adobe/spacecat-shared-content-client-v1.7.9) (2025-06-19)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/spacecat-helix-content-sdk to v1.4.15 ([#808](https://github.com/adobe/spacecat-shared/issues/808)) ([ae211b9](https://github.com/adobe/spacecat-shared/commit/ae211b9db3692ea53b884de10682ef203ba45877))
+
 # [@adobe/spacecat-shared-content-client-v1.7.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.7.7...@adobe/spacecat-shared-content-client-v1.7.8) (2025-06-14)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-content-client",
-  "version": "1.7.8",
+  "version": "1.7.10",
   "description": "Shared modules of the Spacecat Services - Content Client",
   "type": "module",
   "engines": {
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "@adobe/helix-universal": "5.2.2",
-    "@adobe/spacecat-helix-content-sdk": "1.4.13",
+    "@adobe/spacecat-helix-content-sdk": "1.4.15",
     "@adobe/spacecat-shared-data-access": "2.0.2",
     "@adobe/spacecat-shared-utils": "1.38.0",
     "@aws-sdk/client-secrets-manager": "3.828.0",

package/src/clients/content-client.js

@@ -311,11 +311,7 @@ export default class ContentClient {
     return docPath;
   }
 
-  /**
-   * @param {string} path
-   * @returns {Promise<string>}
-   */
-  async getResourcePath(path) {
+  async #getHelixResourceStatus(path) {
     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(/^\/+/, '')}`;
@@ -325,14 +321,34 @@ export default class ContentClient {
       },
     });
     if (response.ok) {
-      const responseJson = await response.json();
-      return responseJson.resourcePath;
+      return response.json();
     } else {
       const errorMessage = await response.text();
       throw new Error(`Failed to fetch document path for ${path}: ${errorMessage}`);
     }
   }
 
+  /**
+   * @param {string} path
+   * @returns {Promise<string>}
+   */
+  async getResourcePath(path) {
+    const helixResourceStatus = await this.#getHelixResourceStatus(path);
+    return helixResourceStatus?.resourcePath;
+  }
+
+  /**
+   * @param {string} path
+   * @returns {Promise<{liveURL: string, previewURL: string}>}
+   */
+  async getLivePreviewURLs(path) {
+    const helixResourceStatus = await this.#getHelixResourceStatus(path);
+    return {
+      liveURL: helixResourceStatus?.live?.url,
+      previewURL: helixResourceStatus?.preview?.url,
+    };
+  }
+
   async getPageMetadata(path) {
     const startTime = process.hrtime.bigint();
 
@@ -427,6 +443,22 @@ export default class ContentClient {
     this.#logDuration('updateRedirects', startTime);
   }
 
+  async getDocumentLinks(path) {
+    const startTime = process.hrtime.bigint();
+
+    await this.#initClient();
+
+    this.log.info(`Getting document links for ${this.site.getId()} and path ${path}`);
+
+    const docPath = this.#resolveDocPath(path);
+    const document = await this.rawClient.getDocument(docPath);
+    const links = await document.getLinks();
+
+    this.#logDuration('getDocumentLinks', startTime);
+
+    return links;
+  }
+
   async updateBrokenInternalLink(path, brokenLink) {
     const startTime = process.hrtime.bigint();
 

package/src/clients/index.d.ts

@@ -117,4 +117,83 @@ export class ContentClient {
    */
   updateBrokenInternalLink(path: string, brokenLink: { from: string, to: string }):
       Promise<void>;
+
+  /**
+   * Retrieves the resource path for a given content path from the AEM admin API.
+   * The resource path represents the actual file location in the content source
+   * (e.g., Google Drive or OneDrive) that corresponds to 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 resource path for.
+   * Must be a valid path that exists in the content source.
+   * @returns {Promise<string | undefined>} A promise that resolves to the resource path
+   * 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 resourcePath = await client.getResourcePath('/content/page');
+   * console.log(resourcePath); // e.g., '/content/page.docx'
+   * ```
+   */
+  getResourcePath(path: string): Promise<string | undefined>;
+
+  /**
+   * Retrieves the live and preview URLs for a given content path from the AEM admin API.
+   * The live URL represents the published version of the content, while the preview URL
+   * represents the draft/preview version that can be used for testing before publishing.
+   *
+   * 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 URLs for. Must be a valid path
+   * that exists in the content source.
+   * @returns {Promise<{liveURL: string | undefined, previewURL: string | undefined}>}
+   * A promise that resolves to an object containing:
+   * - liveURL: The live/published URL if available, undefined otherwise
+   * - previewURL: The preview URL if available, undefined otherwise
+   * @throws {Error} If the Helix admin API request fails or returns an error response.
+   *
+   * @example
+   * ```typescript
+   * const client = await ContentClient.createFrom(context, site);
+   * const urls = await client.getLivePreviewURLs('/content/page');
+   * console.log(urls.liveURL);    // e.g., 'https://owner--repo.hlx.live/content/page'
+   * console.log(urls.previewURL); // e.g., 'https://main--repo--owner.hlx.page/content/page'
+   * ```
+   */
+  getLivePreviewURLs(path: string):
+       Promise<{ liveURL: string | undefined, previewURL: string | undefined }>;
+
+  /**
+   * Retrieves all links from a document at the specified path.
+   * This method extracts links from the document content, including both internal
+   * and external links, anchors, email links, and other href attributes.
+   *
+   * 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 path to the document to extract links from.
+   * Must be a valid path that exists in the content source.
+   * @returns {Promise<Array<{url: string | null, text: string | null}>>}
+   * A promise that resolves to an array of link objects, where each object contains:
+   * - url: The URL or path the link points to (can be null if not available)
+   * - text: The display text of the link (can be null if not available)
+   * @throws {Error} If there is an issue retrieving the document or extracting links.
+   *
+   * @example
+   * ```typescript
+   * const client = await ContentClient.createFrom(context, site);
+   * const links = await client.getDocumentLinks('/content/page');
+   * console.log(links);
+   * // [
+   * //   { url: 'https://example.com/external', text: 'External Link' },
+   * //   { url: '/internal/page', text: 'Internal Page' },
+   * // ]
+   * ```
+   */
+  getDocumentLinks(path: string): Promise<Array<{ url: string | null, text: string | null }>>;
 }