@adobe/spacecat-shared-ahrefs-client 1.10.3 → 1.10.5

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-ahrefs-client-v1.10.5](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-ahrefs-client-v1.10.4...@adobe/spacecat-shared-ahrefs-client-v1.10.5) (2026-01-29)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-universal to v5.4.0 ([#1295](https://github.com/adobe/spacecat-shared/issues/1295)) ([5c1595b](https://github.com/adobe/spacecat-shared/commit/5c1595bd7cba9b7053da867b8f46e302f8683eba))
+
+# [@adobe/spacecat-shared-ahrefs-client-v1.10.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-ahrefs-client-v1.10.3...@adobe/spacecat-shared-ahrefs-client-v1.10.4) (2026-01-20)
+
+
+### Bug Fixes
+
+* getPaidPages was missing parameter mode ([#1271](https://github.com/adobe/spacecat-shared/issues/1271)) ([09e597f](https://github.com/adobe/spacecat-shared/commit/09e597ff7ede8f9c9752dc1b35cd81539a48019a))
+
 # [@adobe/spacecat-shared-ahrefs-client-v1.10.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-ahrefs-client-v1.10.2...@adobe/spacecat-shared-ahrefs-client-v1.10.3) (2025-11-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-ahrefs-client",
-  "version": "1.10.3",
+  "version": "1.10.5",
   "description": "Shared modules of the Spacecat Services - Ahrefs Client",
   "type": "module",
   "engines": {
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "@adobe/fetch": "4.2.3",
-    "@adobe/helix-universal": "5.3.0",
+    "@adobe/helix-universal": "5.4.0",
     "@adobe/spacecat-shared-utils": "1.81.1"
   },
   "devDependencies": {

package/src/index.d.ts

@@ -90,8 +90,9 @@ export default class AhrefsAPIClient {
    * @param url - The target URL
    * @param date - Optional date in YYYY-MM-DD format, defaults to today
    * @param limit - Maximum number of results to return (max: 1000)
+   * @param mode - Search mode: 'exact' for exact domain match, 'prefix' for domain and all subpages (default: 'prefix')
    */
-  getPaidPages(url: string, date?: string, limit?: number):
+  getPaidPages(url: string, date?: string, limit?: number, mode?: 'exact' | 'prefix' | 'domain' | 'subdomains'):
       Promise<{ result: object, fullAuditRef: string }>;
 
   /**

package/src/index.js

@@ -277,6 +277,8 @@ export default class AhrefsAPIClient {
    * @param {string} [date] - The date for the analysis in YYYY-MM-DD format.
    *                          Defaults to today's date.
    * @param {number} [limit=200] - Maximum number of results to return (max: 1000)
+   * @param {string} [mode='prefix'] - Search mode: 'exact' for exact domain match,
+   *                                   'prefix' for domain and all subpages
    * @returns {Promise<{result: Object, fullAuditRef: string}>} Response object containing:
    *   - result.pages: Array of paid page objects with properties:
    *     - url: The page URL
@@ -291,10 +293,14 @@ export default class AhrefsAPIClient {
    *     - value: The estimated cost of a page's monthly paid search traffic, in USD cents.
    *   - fullAuditRef: Full URL of the API request for reference
    * @example
-   * const result = await client.getPaidPages('example.com', '2025-11-10', 50);
+   * // Using defaults (today's date, limit 200, prefix mode)
+   * const result = await client.getPaidPages('example.com');
+   *
+   * // With custom parameters
+   * const result = await client.getPaidPages('example.com', '2025-11-10', 50, 'exact');
    * console.log(result.result.pages); // Array of paid pages
    */
-  async getPaidPages(url, date = new Date().toISOString().split('T')[0], limit = 200) {
+  async getPaidPages(url, date = new Date().toISOString().split('T')[0], limit = 200, mode = 'prefix') {
     const queryParams = {
       target: url,
       date,
@@ -309,6 +315,7 @@ export default class AhrefsAPIClient {
       ].join(','),
       order_by: 'sum_traffic:desc',
       limit: getLimit(limit, 1000),
+      mode,
       output: 'json',
     };