semrush-api-client 0.0.6 → 0.1.1

package/README.md

@@ -1,8 +1,5 @@
 # semrush-api-client
-
-[![Version badge](https://badgen.net/github/release/RenKoya1/semrush-api-client?refresh)](https://github.com/RenKoya1/semrush-api-client/releases)
-
-[![Package size badge](https://badgen.net/bundlephobia/minzip/semrush-api-client)](https://bundlephobia.com/package/semrush-api-client)
+[![Version badge](https://badgen.net/github/release//RenKoya1/semrush-api-client?refresh)](https://github.com//RenKoya1/semrush-api-client)
 
 A Node.js/TypeScript client for accessing the SEMrush API easily.
 

package/dist/backlinks/backlinksOverview.d.ts

@@ -0,0 +1,9 @@
+import { SemrushAPIClient } from "../client";
+export type BacklinksTargetType = "root_domain" | "domain" | "url";
+export type BacklinkstExportColumns = "ascore" | "total" | "domains_num" | "urls_num" | "ips_num" | "ipclassc_num" | "follows_num" | "nofollows_num" | "sponsored_num" | "ugc_num" | "texts_num" | "images_num" | "forms_num" | "frames_num";
+export declare function backlinksOverview(this: SemrushAPIClient, { target, target_type, export_columns, outputObj, }: {
+    target: string;
+    target_type?: BacklinksTargetType;
+    export_columns?: BacklinkstExportColumns[];
+    outputObj?: boolean;
+}): Promise<string>;

package/dist/backlinks/backlinksOverview.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.backlinksOverview = backlinksOverview;
+async function backlinksOverview({ target, target_type = "domain", export_columns = [
+    "ascore",
+    "total",
+    "domains_num",
+    "urls_num",
+    "ips_num",
+    "ipclassc_num",
+    "follows_num",
+    "nofollows_num",
+    "sponsored_num",
+    "ugc_num",
+    "texts_num",
+    "images_num",
+    "forms_num",
+    "frames_num",
+], outputObj = true, }) {
+    const params = {
+        type: "backlinks_overview",
+        target,
+        target_type,
+        export_columns: export_columns.join(","),
+    };
+    return this.get(this.ANALYTICS_URL, params, outputObj);
+}

package/dist/client/index.d.ts

@@ -0,0 +1,17 @@
+import { getDomainRank } from "../domain/getDomainRank";
+import { getPhraseAll } from "../keyword/getPhrase";
+import { backlinksOverview } from "../backlinks/backlinksOverview";
+export declare class SemrushAPIClient {
+    private client;
+    private api_key;
+    BASE_URL: string;
+    ANALYTICS_URL: string;
+    constructor({ api_key }: {
+        api_key: string;
+    });
+    parseCsvToObjects(csvString: string, delimiter?: string): Record<string, string>[];
+    get<T>(url: string, params?: Record<string, any>, outputObj?: boolean): Promise<T>;
+    getDomainRank: typeof getDomainRank;
+    getPhrase: typeof getPhraseAll;
+    backlinksOverview: typeof backlinksOverview;
+}

package/dist/client/index.js

@@ -7,23 +7,54 @@ exports.SemrushAPIClient = void 0;
 const axios_1 = __importDefault(require("axios"));
 const getDomainRank_1 = require("../domain/getDomainRank");
 const getPhrase_1 = require("../keyword/getPhrase");
+const backlinksOverview_1 = require("../backlinks/backlinksOverview");
 class SemrushAPIClient {
     client;
     api_key;
     BASE_URL = "https://api.semrush.com/";
+    ANALYTICS_URL = "https://api.semrush.com/analytics/v1/";
     constructor({ api_key }) {
         this.api_key = api_key;
         this.client = axios_1.default.create({
-            baseURL: this.BASE_URL,
             timeout: 5000,
         });
     }
-    async get(url, params) {
+    parseCsvToObjects(csvString, delimiter = ";") {
+        const [headerLine, ...lines] = csvString.trim().split("\n");
+        const headers = headerLine
+            .split(delimiter)
+            .map((h) => h.trim().toLowerCase().replace(/\s+/g, "_"));
+        return lines.map((line) => {
+            const values = line.split(delimiter);
+            const obj = {};
+            headers.forEach((key, i) => {
+                obj[key] = values[i]?.trim() ?? "";
+            });
+            return obj;
+        });
+    }
+    async get(url, params, outputObj = true) {
         const allParams = { ...params, key: this.api_key };
-        const response = await this.client.get(url, { params: allParams });
-        return response.data;
+        try {
+            const response = await this.client.get(url, { params: allParams });
+            if (outputObj) {
+                return this.parseCsvToObjects(response.data);
+            }
+            else {
+                return response.data;
+            }
+        }
+        catch (error) {
+            if (axios_1.default.isAxiosError(error)) {
+                throw new Error(`API request failed: ${error.message}`);
+            }
+            else {
+                throw new Error(`Unexpected error: ${error}`);
+            }
+        }
     }
     getDomainRank = getDomainRank_1.getDomainRank;
     getPhrase = getPhrase_1.getPhraseAll;
+    backlinksOverview = backlinksOverview_1.backlinksOverview;
 }
 exports.SemrushAPIClient = SemrushAPIClient;

package/dist/domain/getDomainRank.d.ts

@@ -0,0 +1,10 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+import { ExportColumns } from "../type/general/exportColumns";
+export declare function getDomainRank(this: SemrushAPIClient, { domain, export_columns, database, display_limit, outputObj, }: {
+    domain: string;
+    export_columns?: ExportColumns[];
+    database?: Database;
+    display_limit?: number;
+    outputObj?: boolean;
+}): Promise<string>;

package/dist/domain/getDomainRank.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDomainRank = getDomainRank;
-async function getDomainRank({ domain, export_columns = ["Dn", "Or", "Rk", "Ot", "Oc"], database = "us", display_limit = 1000, }) {
+async function getDomainRank({ domain, export_columns = ["Dn", "Or", "Rk", "Ot", "Oc"], database = "us", display_limit = 1000, outputObj = true, // Default to true for output object
+ }) {
     const params = {
         type: "domain_ranks",
         export_columns: export_columns.join(","),
@@ -9,5 +10,5 @@ async function getDomainRank({ domain, export_columns = ["Dn", "Or", "Rk", "Ot",
         database,
         display_limit,
     };
-    return this.get("", params);
+    return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/dist/keyword/getPhrase.d.ts

@@ -0,0 +1,10 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+type KeywordExportColumns = "Dt" | "Db" | "Ph" | "Nq" | "Cp" | "Co" | "Nr" | "In" | "Kd";
+export declare function getPhraseAll(this: SemrushAPIClient, { phrase, export_columns, database, outputObj, }: {
+    phrase: string;
+    export_columns?: KeywordExportColumns[];
+    database?: Database;
+    outputObj?: boolean;
+}): Promise<string>;
+export {};

package/dist/keyword/getPhrase.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPhraseAll = getPhraseAll;
-async function getPhraseAll({ phrase, export_columns = ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr"], database = "us", }) {
+async function getPhraseAll({ phrase, export_columns = ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr"], database = "us", outputObj = true, // Default to true for output object
+ }) {
     const params = {
         type: "phrase_all",
         export_columns: export_columns.join(","),
         phrase,
         database,
     };
-    return this.get("", params);
+    return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/type/general/database.d.ts

@@ -0,0 +1 @@
+export type Database = "us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa";

package/dist/type/general/exportColumns.d.ts

@@ -0,0 +1 @@
+export type ExportColumns = "Db" | "Dt" | "Dn" | "Rk" | "Or" | "Ot" | "Oc" | "Ad" | "At" | "Ac" | "Sh" | "Sv" | "FKn" | "FPn" | "Sr" | "Srb" | "St" | "Stb" | "Sc" | "Srn" | "Srl";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semrush-api-client",
-  "version": "0.0.6",
+  "version": "0.1.1",
   "description": "",
   "license": "Apache-2.0",
   "main": "dist/index.js",