dymo-api 1.2.6 → 1.2.7

package/dist/cjs/branches/private/functions/isValidEmail/index.cjs

@@ -24,6 +24,15 @@ const isValidEmail = async (axiosClient, email, rules) => {
         throw (0, basics_1.customError)(3000, "Invalid private token.");
     if (rules.deny.length === 0)
         throw (0, basics_1.customError)(1500, "You must provide at least one deny rule.");
+    if (rules.mode === "DRY_RUN") {
+        console.warn("[Dymo API] DRY_RUN mode is enabled. No requests with real data will be processed until you switch to LIVE mode.");
+        return {
+            email,
+            allow: true,
+            reasons: [],
+            response: "CHANGE TO LIVE MODE"
+        };
+    }
     try {
         const responseEmail = (await axiosClient.post("/private/secure/verify", {
             email,

package/dist/cjs/branches/private/functions/protectReq/index.cjs

@@ -0,0 +1,74 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.protectReq = void 0;
+const basics_1 = require("../../../../utils/basics.cjs");
+const requestHandler_1 = require("./requestHandler.cjs");
+const Interfaces = __importStar(require("../../../../lib/types/interfaces.cjs"));
+const isWellKnownBot = (ua) => {
+    return Object.values(Interfaces.categories).flat().includes(ua);
+};
+const protectReq = async (axiosClient, req, rules) => {
+    if (!axiosClient.defaults.headers?.Authorization)
+        throw (0, basics_1.customError)(3000, "Invalid private token.");
+    const reqData = (0, requestHandler_1.handleRequest)(req);
+    if (!reqData.userAgent || !reqData.ip)
+        throw (0, basics_1.customError)(1500, "You must provide user agent and ip.");
+    if (rules.mode === "DRY_RUN") {
+        console.warn("[Dymo API] DRY_RUN mode is enabled. No requests with real data will be processed until you switch to LIVE mode.");
+        return {
+            ip: reqData.ip,
+            userAgent: reqData.userAgent,
+            allow: true,
+            reasons: []
+        };
+    }
+    try {
+        const response = await axiosClient.post("/private/waf/verifyRequest", {
+            ip: reqData.ip,
+            userAgent: reqData.userAgent,
+            allowBots: rules.allowBots,
+            deny: rules.deny
+        }, { headers: { "Content-Type": "application/json" } });
+        return response.data;
+    }
+    catch (error) {
+        const statusCode = error.response?.status || 500;
+        const errorMessage = error.response?.data?.message || error.message;
+        const errorDetails = JSON.stringify(error.response?.data || {});
+        throw (0, basics_1.customError)(5000, `Error ${statusCode}: ${errorMessage}. Details: ${errorDetails}`);
+    }
+};
+exports.protectReq = protectReq;

package/dist/cjs/branches/private/functions/protectReq/requestHandler.cjs

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleRequest = void 0;
+// Helpers.
+const getUserAgent = (req) => {
+    return req.headers?.["user-agent"] || req.headers?.["User-Agent"];
+};
+const getIp = (req) => {
+    return (req.ip ||
+        req.headers?.["x-forwarded-for"] ||
+        req.connection?.remoteAddress ||
+        req.socket?.remoteAddress ||
+        req.req?.socket?.remoteAddress);
+};
+const handleRequest = (req) => {
+    return {
+        body: req.body,
+        userAgent: getUserAgent(req),
+        ip: getIp(req)
+    };
+};
+exports.handleRequest = handleRequest;

package/dist/cjs/branches/private/index.cjs

@@ -18,4 +18,5 @@ __exportStar(require("./functions/extractWithTextly/index.cjs"), exports);
 __exportStar(require("./functions/getRandom/index.cjs"), exports);
 __exportStar(require("./functions/isValidData/index.cjs"), exports);
 __exportStar(require("./functions/isValidEmail/index.cjs"), exports);
+__exportStar(require("./functions/protectReq/index.cjs"), exports);
 __exportStar(require("./functions/sendEmail/index.cjs"), exports);

package/dist/cjs/dymo-api.cjs

@@ -64,9 +64,9 @@ class DymoAPI {
      */
     constructor({ rootApiKey = null, apiKey = null, baseUrl = "https://api.tpeoficial.com", serverEmailConfig = undefined, rules = {} } = {}) {
         this.rules = {
-            bot: { mode: "LIVE", allow: [] },
             email: { mode: "LIVE", deny: ["FRAUD", "INVALID", "NO_MX_RECORDS", "NO_REPLY_EMAIL"] },
             sensitiveInfo: { mode: "LIVE", deny: ["EMAIL", "PHONE", "CREDIT_CARD"] },
+            waf: { mode: "LIVE", allowBots: ["CURL", "CATEGORY:SEARCH_ENGINE", "CATEGORY:PREVIEW"], deny: ["FRAUD", "TOR_NETWORK"] },
             ...rules
         };
         this.rootApiKey = rootApiKey;
@@ -127,12 +127,33 @@ class DymoAPI {
      * @example
      * const valid = await dymoClient.isValidEmail("user@example.com", { deny: ["FRAUD", "NO_MX_RECORDS"] });
      *
-     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/request-verifier)
      */
     async isValidEmail(email, rules = this.rules.email) {
         return await PrivateAPI.isValidEmail(this.axiosClient, email, rules);
     }
     ;
+    /**
+     * Protects the given request against the configured rules.
+     *
+     * This method requires either the root API key or the API key to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Object} req - The request object to be protected.
+     * @param {Interfaces.WafRules} [rules] - Optional rules for protection. Some rules are premium features.
+     * @returns {Promise<Interfaces.HTTPRequest>} Resolves with the protected request.
+     * @important
+     * **⚠️ This is a [PREMIUM](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier) and BETA feature.**
+     * @throws Will throw an error if protection cannot be performed.
+     *
+     * @example
+     * const protectedReq = await dymoClient.protectReq(req);
+     *
+     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+    */
+    async protectReq(req, rules = this.rules.waf) {
+        return await PrivateAPI.protectReq(this.axiosClient, req, rules);
+    }
     /**
      * Sends an email using the configured email client settings.
      *

package/dist/cjs/lib/types/interfaces.cjs

@@ -19,4 +19,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 ;
 ;
 __exportStar(require("./rules.cjs"), exports);
+__exportStar(require("./primitives.cjs"), exports);
 __exportStar(require("./data-verifier.cjs"), exports);
+__exportStar(require("./well-known-bots.cjs"), exports);

package/dist/esm/branches/private/functions/isValidEmail/index.js

@@ -21,6 +21,15 @@ export const isValidEmail = async (axiosClient, email, rules) => {
         throw customError(3000, "Invalid private token.");
     if (rules.deny.length === 0)
         throw customError(1500, "You must provide at least one deny rule.");
+    if (rules.mode === "DRY_RUN") {
+        console.warn("[Dymo API] DRY_RUN mode is enabled. No requests with real data will be processed until you switch to LIVE mode.");
+        return {
+            email,
+            allow: true,
+            reasons: [],
+            response: "CHANGE TO LIVE MODE"
+        };
+    }
     try {
         const responseEmail = (await axiosClient.post("/private/secure/verify", {
             email,

package/dist/esm/branches/private/functions/protectReq/index.js

@@ -0,0 +1,37 @@
+import { customError } from "../../../../utils/basics.js";
+import { handleRequest } from "./requestHandler.js";
+import * as Interfaces from "../../../../lib/types/interfaces.js";
+const isWellKnownBot = (ua) => {
+    return Object.values(Interfaces.categories).flat().includes(ua);
+};
+export const protectReq = async (axiosClient, req, rules) => {
+    if (!axiosClient.defaults.headers?.Authorization)
+        throw customError(3000, "Invalid private token.");
+    const reqData = handleRequest(req);
+    if (!reqData.userAgent || !reqData.ip)
+        throw customError(1500, "You must provide user agent and ip.");
+    if (rules.mode === "DRY_RUN") {
+        console.warn("[Dymo API] DRY_RUN mode is enabled. No requests with real data will be processed until you switch to LIVE mode.");
+        return {
+            ip: reqData.ip,
+            userAgent: reqData.userAgent,
+            allow: true,
+            reasons: []
+        };
+    }
+    try {
+        const response = await axiosClient.post("/private/waf/verifyRequest", {
+            ip: reqData.ip,
+            userAgent: reqData.userAgent,
+            allowBots: rules.allowBots,
+            deny: rules.deny
+        }, { headers: { "Content-Type": "application/json" } });
+        return response.data;
+    }
+    catch (error) {
+        const statusCode = error.response?.status || 500;
+        const errorMessage = error.response?.data?.message || error.message;
+        const errorDetails = JSON.stringify(error.response?.data || {});
+        throw customError(5000, `Error ${statusCode}: ${errorMessage}. Details: ${errorDetails}`);
+    }
+};

package/dist/esm/branches/private/functions/protectReq/requestHandler.js

@@ -0,0 +1,18 @@
+// Helpers.
+const getUserAgent = (req) => {
+    return req.headers?.["user-agent"] || req.headers?.["User-Agent"];
+};
+const getIp = (req) => {
+    return (req.ip ||
+        req.headers?.["x-forwarded-for"] ||
+        req.connection?.remoteAddress ||
+        req.socket?.remoteAddress ||
+        req.req?.socket?.remoteAddress);
+};
+export const handleRequest = (req) => {
+    return {
+        body: req.body,
+        userAgent: getUserAgent(req),
+        ip: getIp(req)
+    };
+};

package/dist/esm/branches/private/index.js

@@ -2,4 +2,5 @@ export * from "./functions/extractWithTextly";
 export * from "./functions/getRandom";
 export * from "./functions/isValidData";
 export * from "./functions/isValidEmail";
+export * from "./functions/protectReq";
 export * from "./functions/sendEmail";

package/dist/esm/dymo-api.js

@@ -26,9 +26,9 @@ class DymoAPI {
      */
     constructor({ rootApiKey = null, apiKey = null, baseUrl = "https://api.tpeoficial.com", serverEmailConfig = undefined, rules = {} } = {}) {
         this.rules = {
-            bot: { mode: "LIVE", allow: [] },
             email: { mode: "LIVE", deny: ["FRAUD", "INVALID", "NO_MX_RECORDS", "NO_REPLY_EMAIL"] },
             sensitiveInfo: { mode: "LIVE", deny: ["EMAIL", "PHONE", "CREDIT_CARD"] },
+            waf: { mode: "LIVE", allowBots: ["CURL", "CATEGORY:SEARCH_ENGINE", "CATEGORY:PREVIEW"], deny: ["FRAUD", "TOR_NETWORK"] },
             ...rules
         };
         this.rootApiKey = rootApiKey;
@@ -89,12 +89,33 @@ class DymoAPI {
      * @example
      * const valid = await dymoClient.isValidEmail("user@example.com", { deny: ["FRAUD", "NO_MX_RECORDS"] });
      *
-     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/request-verifier)
      */
     async isValidEmail(email, rules = this.rules.email) {
         return await PrivateAPI.isValidEmail(this.axiosClient, email, rules);
     }
     ;
+    /**
+     * Protects the given request against the configured rules.
+     *
+     * This method requires either the root API key or the API key to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Object} req - The request object to be protected.
+     * @param {Interfaces.WafRules} [rules] - Optional rules for protection. Some rules are premium features.
+     * @returns {Promise<Interfaces.HTTPRequest>} Resolves with the protected request.
+     * @important
+     * **⚠️ This is a [PREMIUM](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier) and BETA feature.**
+     * @throws Will throw an error if protection cannot be performed.
+     *
+     * @example
+     * const protectedReq = await dymoClient.protectReq(req);
+     *
+     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+    */
+    async protectReq(req, rules = this.rules.waf) {
+        return await PrivateAPI.protectReq(this.axiosClient, req, rules);
+    }
     /**
      * Sends an email using the configured email client settings.
      *

package/dist/esm/lib/types/interfaces.js

@@ -3,4 +3,6 @@
 ;
 ;
 export * from "./rules";
+export * from "./primitives";
 export * from "./data-verifier";
+export * from "./well-known-bots";

package/dist/types/branches/private/functions/protectReq/index.d.ts

@@ -0,0 +1,3 @@
+import { type AxiosInstance } from "axios";
+import * as Interfaces from "../../../../lib/types/interfaces";
+export declare const protectReq: <T>(axiosClient: AxiosInstance, req: Interfaces.HTTPRequest, rules: Interfaces.WafRules) => Promise<any>;

package/dist/types/branches/private/functions/protectReq/requestHandler.d.ts

@@ -0,0 +1,22 @@
+type GenericRequest<T = any> = {
+    body?: T;
+    headers?: Record<string, any>;
+    ip?: string;
+    connection?: {
+        remoteAddress?: string;
+    };
+    socket?: {
+        remoteAddress?: string;
+    };
+    req?: {
+        socket?: {
+            remoteAddress?: string;
+        };
+    };
+};
+export declare const handleRequest: <T = any>(req: GenericRequest<T>) => {
+    body: T | undefined;
+    userAgent: string | undefined;
+    ip: string | undefined;
+};
+export {};

package/dist/types/branches/private/index.d.ts

@@ -2,4 +2,5 @@ export * from "./functions/extractWithTextly";
 export * from "./functions/getRandom";
 export * from "./functions/isValidData";
 export * from "./functions/isValidEmail";
+export * from "./functions/protectReq";
 export * from "./functions/sendEmail";

package/dist/types/dymo-api.d.ts

@@ -68,9 +68,28 @@ declare class DymoAPI {
      * @example
      * const valid = await dymoClient.isValidEmail("user@example.com", { deny: ["FRAUD", "NO_MX_RECORDS"] });
      *
-     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/request-verifier)
      */
     isValidEmail(email: Interfaces.EmailValidator, rules?: Interfaces.EmailValidatorRules): Promise<Interfaces.EmailValidatorResponse>;
+    /**
+     * Protects the given request against the configured rules.
+     *
+     * This method requires either the root API key or the API key to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Object} req - The request object to be protected.
+     * @param {Interfaces.WafRules} [rules] - Optional rules for protection. Some rules are premium features.
+     * @returns {Promise<Interfaces.HTTPRequest>} Resolves with the protected request.
+     * @important
+     * **⚠️ This is a [PREMIUM](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier) and BETA feature.**
+     * @throws Will throw an error if protection cannot be performed.
+     *
+     * @example
+     * const protectedReq = await dymoClient.protectReq(req);
+     *
+     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+    */
+    protectReq(req: Interfaces.HTTPRequest, rules?: Interfaces.WafRules): Promise<any>;
     /**
      * Sends an email using the configured email client settings.
      *

package/dist/types/lib/types/interfaces.d.ts

@@ -163,4 +163,6 @@ export interface ExtractWithTextly {
     };
 }
 export * from "./rules";
+export * from "./primitives";
 export * from "./data-verifier";
+export * from "./well-known-bots";

package/dist/types/lib/types/primitives.d.ts

@@ -9,3 +9,10 @@ export interface CreditCard {
     cvc?: string | number;
     cvv?: string | number;
 }
+export interface HTTPRequest {
+    url: string;
+    method: string | "GET" | "POST" | "PUT" | "DELETE";
+    headers?: Record<string, string>;
+    body?: string | object | null;
+    [key: string]: any;
+}

package/dist/types/lib/types/rules.d.ts

@@ -1,9 +1,11 @@
 import * as WellKnownBots from "./well-known-bots";
 import { NegativeEmailRules, NegativeSensitiveInfoRules } from "./data-verifier";
 type Mode = "LIVE" | "DRY_RUN";
-export interface BotRules {
+type NegativeWafRules = "FRAUD" | "VPN" | "PROXY" | "TOR_NETWORK";
+export interface WafRules {
     mode?: Mode;
-    allow?: WellKnownBots.WellKnownBotOrCategory[];
+    allowBots?: WellKnownBots.WellKnownBotOrCategory[];
+    deny?: NegativeWafRules[];
 }
 export interface EmailValidatorRules {
     mode?: Mode;
@@ -14,8 +16,8 @@ export interface SensitiveInfoRules {
     deny: NegativeSensitiveInfoRules[];
 }
 export interface Rules {
-    bot?: BotRules;
     email?: EmailValidatorRules;
     sensitiveInfo?: SensitiveInfoRules;
+    waf?: WafRules;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.2.06",
+  "version": "1.2.7",
   "description": "Flow system for Dymo API.",
   "main": "dist/cjs/dymo-api.js",
   "module": "dist/esm/dymo-api.js",