@adobe/spacecat-shared-ahrefs-client 1.6.21 → 1.7.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-ahrefs-client-v1.7.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-ahrefs-client-v1.7.0...@adobe/spacecat-shared-ahrefs-client-v1.7.1) (2025-05-31)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#779](https://github.com/adobe/spacecat-shared/issues/779)) ([07f8cce](https://github.com/adobe/spacecat-shared/commit/07f8cce73e33bfb9c61fe14f2ef28012b872437d))
+
+# [@adobe/spacecat-shared-ahrefs-client-v1.7.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-ahrefs-client-v1.6.21...@adobe/spacecat-shared-ahrefs-client-v1.7.0) (2025-05-26)
+
+
+### Features
+
+* Support fetching only unbranded keywords from ahrefs ([#765](https://github.com/adobe/spacecat-shared/issues/765)) ([1fb300b](https://github.com/adobe/spacecat-shared/commit/1fb300bf22e200a31b03c2df50e18d76ed9d882e))
+
 # [@adobe/spacecat-shared-ahrefs-client-v1.6.21](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-ahrefs-client-v1.6.20...@adobe/spacecat-shared-ahrefs-client-v1.6.21) (2025-05-26)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-ahrefs-client",
-  "version": "1.6.21",
+  "version": "1.7.1",
   "description": "Shared modules of the Spacecat Services - Ahrefs Client",
   "type": "module",
   "engines": {
@@ -41,7 +41,7 @@
   "devDependencies": {
     "chai": "5.2.0",
     "chai-as-promised": "8.0.1",
-    "nock": "14.0.4",
+    "nock": "14.0.5",
     "sinon": "20.0.0",
     "sinon-chai": "4.0.0",
     "typescript": "5.8.3"

package/src/index.d.ts

@@ -73,13 +73,15 @@ export default class AhrefsAPIClient {
 
   /**
    * Asynchronous method to get organic keywords.
-   * @param url
-   * @param country
-   * @param keywordFilter
-   * @param limit
-   * @param mode
    */
-  getOrganicKeywords(url: string, country?: string, keywordFilter?: string[],
-                     limit?: number, mode?: string):
+  getOrganicKeywords(
+    url: string,
+    options?: {
+      country?: string,
+      keywordFilter?: string[],
+      limit?: number,
+      mode?: 'exact' | 'prefix',
+      excludeBranded?: boolean,
+    }):
       Promise<{ result: object, fullAuditRef: string }>;
 }

package/src/index.js

@@ -181,7 +181,13 @@ export default class AhrefsAPIClient {
     return this.sendRequest('/site-explorer/metrics-history', queryParams);
   }
 
-  async getOrganicKeywords(url, country = 'us', keywordFilter = [], limit = 10, mode = 'prefix') {
+  async getOrganicKeywords(url, {
+    country = 'us',
+    keywordFilter = [],
+    limit = 10,
+    mode = 'prefix',
+    excludeBranded = false,
+  } = {}) {
     if (!hasText(url)) {
       throw new Error(`Invalid URL: ${url}`);
     }
@@ -215,11 +221,23 @@ export default class AhrefsAPIClient {
       mode,
       output: 'json',
     };
+    let where;
     if (keywordFilter.length > 0) {
+      where = {
+        or: keywordFilter.map((keyword) => ({ field: 'keyword', is: ['iphrase_match', keyword] })),
+      };
+    }
+    if (excludeBranded) {
+      const nonBrandedWhere = { field: 'is_branded', is: ['eq', 0] };
+      if (where) {
+        where = { and: [nonBrandedWhere, where] };
+      } else {
+        where = nonBrandedWhere;
+      }
+    }
+    if (where != null) {
       try {
-        queryParams.where = JSON.stringify({
-          or: keywordFilter.map((keyword) => ({ field: 'keyword', is: ['iphrase_match', keyword] })),
-        });
+        queryParams.where = JSON.stringify(where);
       } catch (e) {
         this.log.error(`Error parsing keyword filter: ${e.message}`);
         throw new Error(`Error parsing keyword filter: ${e.message}`);