semrush-api-client 1.0.3 → 1.0.6

package/dist/client/index.d.ts

@@ -4,6 +4,7 @@ import { getBacklinksOverview, getBacklinks, getAnchors, getIndexedPages, getRef
 import { getRankDifference, getSemrushRank } from "../overview";
 import { getTrafficSummary } from "../trend";
 import { getUrlOverview, getUrlOrganicSearchKeywords, getUrlPaidSearchKeywords } from "../url";
+import { countApiUnits } from "../user";
 export declare class SemrushAPIClient {
     private client;
     private api_key;
@@ -35,4 +36,5 @@ export declare class SemrushAPIClient {
     getUrlOverview: typeof getUrlOverview;
     getUrlOrganicSearchKeywords: typeof getUrlOrganicSearchKeywords;
     getUrlPaidSearchKeywords: typeof getUrlPaidSearchKeywords;
+    countApiUnits: typeof countApiUnits;
 }

package/dist/client/index.js

@@ -11,6 +11,7 @@ const backlinks_1 = require("../backlinks");
 const overview_1 = require("../overview");
 const trend_1 = require("../trend");
 const url_1 = require("../url");
+const user_1 = require("../user");
 class SemrushAPIClient {
     client;
     api_key;
@@ -83,5 +84,7 @@ class SemrushAPIClient {
     getUrlOverview = url_1.getUrlOverview;
     getUrlOrganicSearchKeywords = url_1.getUrlOrganicSearchKeywords;
     getUrlPaidSearchKeywords = url_1.getUrlPaidSearchKeywords;
+    // User methods
+    countApiUnits = user_1.countApiUnits;
 }
 exports.SemrushAPIClient = SemrushAPIClient;

package/dist/domain/getDomainOrganicSearchKeywords.js

@@ -17,7 +17,7 @@ async function getDomainOrganicSearchKeywords({ domain, exportColumns = [
     "Td",
 ], database = "us", displayPosition, displayPositionsType, displayLimit = 10, displayOffset, displaySort, displayFilter, displayDate, exportEscape, exportDecode, outputObj = true, }) {
     if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
-        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+        throw new Error("Invalid displayDate format. Format: YYYYMM15 or YYYYMMDD");
     }
     const params = {
         type: "domain_organic",

package/dist/keyword/getKeywordOrganic.d.ts

@@ -2,9 +2,10 @@ import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
 type KeywordExportColumns = "Po" | "Pt" | "Dn" | "Ur" | "Fk" | "Fp" | "Fl";
 export type KeywordOrganicDisplaySort = "po_asc" | "po_desc" | "tr_asc" | "tr_desc";
-export declare function getKeywordOrganic(this: SemrushAPIClient, { phrase, exportColumns, database, displayLimit, displayOffset, displaySort, displayFilter, exportEscape, exportDecode, outputObj, }: {
+export declare function getKeywordOrganic(this: SemrushAPIClient, { phrase, exportColumns, database, displayLimit, displayOffset, displayDate, displaySort, displayFilter, exportEscape, exportDecode, outputObj, }: {
     phrase: string;
     exportColumns?: KeywordExportColumns[];
+    displayDate?: string;
     database?: Database;
     displayLimit?: number;
     displayOffset?: number;

package/dist/keyword/getKeywordOrganic.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getKeywordOrganic = getKeywordOrganic;
-async function getKeywordOrganic({ phrase, exportColumns = ["Po", "Pt", "Dn", "Ur", "Fk", "Fp", "Fl"], database = "us", displayLimit = 10, displayOffset, displaySort, displayFilter, exportEscape, exportDecode, outputObj = true, }) {
+async function getKeywordOrganic({ phrase, exportColumns = ["Po", "Pt", "Dn", "Ur", "Fk", "Fp", "Fl"], database = "us", displayLimit = 10, displayOffset, displayDate, displaySort, displayFilter, exportEscape, exportDecode, outputObj = true, }) {
     const params = {
         type: "phrase_organic",
         export_columns: exportColumns.join(","),
@@ -9,6 +9,7 @@ async function getKeywordOrganic({ phrase, exportColumns = ["Po", "Pt", "Dn", "U
         database,
         display_limit: displayLimit,
         display_offset: displayOffset,
+        display_date: displayDate,
         display_sort: displaySort,
         display_filter: displayFilter,
         export_escape: exportEscape,

package/dist/keyword/getKeywordOverview.d.ts

@@ -1,7 +1,8 @@
 import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
-type KeywordExportColumns = "Dt" | "Db" | "Ph" | "Nq" | "Cp" | "Co" | "Nr" | "In" | "Kd";
-export declare function getKeywordOverview(this: SemrushAPIClient, { phrase, exportColumns, database, displayDate, exportEscape, exportDecode, outputObj, }: {
+type KeywordExportColumns = "Dt" | "Db" | "Ph" | "Nq" | "Cp" | "Co" | "Nr" | "Td" | "In" | "Kd";
+export declare function getKeywordOverview(this: SemrushAPIClient, { type, phrase, exportColumns, database, displayDate, exportEscape, exportDecode, outputObj, }: {
+    type?: "phrase_all" | "phrase_this";
     phrase: string;
     exportColumns?: KeywordExportColumns[];
     database?: Database;

package/dist/keyword/getKeywordOverview.js

@@ -2,15 +2,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getKeywordOverview = getKeywordOverview;
 const displayDateValidator_1 = require("../utils/displayDateValidator");
-async function getKeywordOverview({ phrase, exportColumns = ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr", "In", "Kd"], database = "us", displayDate, exportEscape, exportDecode, outputObj = true, }) {
+async function getKeywordOverview({ type = "phrase_this", phrase, exportColumns, database = type === "phrase_this" ? "us" : undefined, displayDate, exportEscape, exportDecode, outputObj = true, }) {
     if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
         throw new Error("Invalid displayDate format. Format: YYYYMM15");
     }
+    // Set default export columns dynamically based on the requested report type
+    // Default columns per API documentation
+    const finalExportColumns = exportColumns
+        ? exportColumns
+        : type === "phrase_all"
+            ? ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr", "In", "Kd"]
+            : ["Ph", "Nq", "Cp", "Co", "Nr", "Td", "In", "Kd"];
     const params = {
-        type: "phrase_all",
-        export_columns: exportColumns.join(","),
+        type,
+        export_columns: finalExportColumns.join(","),
         phrase,
-        database,
+        ...(type === "phrase_this" && database ? { database } : {}),
+        ...(type === "phrase_all" && database ? { database } : {}), // Optional filter for phrase_all
         display_date: displayDate,
         export_escape: exportEscape,
         export_decode: exportDecode,

package/dist/user/countApiUnits.d.ts

@@ -0,0 +1,2 @@
+import { SemrushAPIClient } from "../client";
+export declare function countApiUnits(this: SemrushAPIClient): Promise<string>;

package/dist/user/countApiUnits.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.countApiUnits = countApiUnits;
+async function countApiUnits() {
+    const url = "http://www.semrush.com/users/countapiunits.html";
+    return this.get(url, undefined, false);
+}

package/dist/user/index.d.ts

@@ -0,0 +1 @@
+export { countApiUnits } from "./countApiUnits";

package/dist/user/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.countApiUnits = void 0;
+var countApiUnits_1 = require("./countApiUnits");
+Object.defineProperty(exports, "countApiUnits", { enumerable: true, get: function () { return countApiUnits_1.countApiUnits; } });

package/dist/utils/displayDateValidator.js

@@ -4,6 +4,6 @@ exports.displayDateValidator = displayDateValidator;
 function displayDateValidator(displayDate) {
     if (!displayDate)
         return true;
-    const regex = /^\d{4}(0[1-9]|1[0-2])15$/;
+    const regex = /^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$/;
     return regex.test(displayDate);
 }

package/package.json

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