dymo-api 1.1.5 → 1.1.7

package/dist/cjs/branches/private.cjs

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractWithTextly = exports.getRandom = exports.sendEmail = exports.isValidData = void 0;
+exports.extractWithTextly = exports.getRandom = exports.sendEmail = exports.isValidEmail = exports.isValidData = void 0;
 const path_1 = __importDefault(require("path"));
 const react_1 = __importDefault(require("react"));
 const promises_1 = __importDefault(require("fs/promises"));
@@ -81,6 +81,69 @@ const isValidData = async (token, data) => {
     }
 };
 exports.isValidData = isValidData;
+/**
+ * Validates an email using a secure verification endpoint.
+ *
+ * @param {string | null} token - Authentication token (required).
+ * @param {Interfaces.EmailValidator} email - Email to validate.
+ * @param {Interfaces.EmailValidatorRules} [rules] - Deny rules. Defaults to ["FRAUD", "INVALID", "NO_MX_RECORDS", "NO_REPLY_EMAIL"].
+ *
+ * Deny rules (some are premium ⚠️):
+ * - "FRAUD", "INVALID", "NO_MX_RECORDS" ⚠️, "PROXIED_EMAIL" ⚠️, "FREE_SUBDOMAIN" ⚠️,
+ *   "PERSONAL_EMAIL", "CORPORATE_EMAIL", "NO_REPLY_EMAIL", "ROLE_ACCOUNT", "NO_REACHABLE", "HIGH_RISK_SCORE" ⚠️
+ *
+ * @returns {Promise<boolean>} True if the email passes all deny rules, false otherwise.
+ * @throws Error if token is null, rules are empty, or request fails.
+ *
+ * @example
+ * const valid = await isValidEmail(apiToken, "user@example.com", { deny: ["FRAUD", "NO_MX_RECORDS"] });
+ */
+const isValidEmail = async (token, email, rules) => {
+    if (token === null)
+        throw customError(3000, "Invalid private token.");
+    if (rules.deny.length === 0)
+        throw customError(1500, "You must provide at least one deny rule.");
+    try {
+        const responseEmail = (await config_1.axiosApiUrl.post("/private/secure/verify", {
+            email,
+            plugins: [
+                rules.deny.includes("NO_MX_RECORDS") ? "mxRecords" : undefined,
+                rules.deny.includes("NO_REACHABLE") ? "reachability" : undefined,
+                rules.deny.includes("HIGH_RISK_SCORE") ? "riskScore" : undefined
+            ]
+        }, { headers: { "Content-Type": "application/json", "Authorization": token } })).data.email;
+        if (rules.deny.includes("INVALID") && !responseEmail.valid)
+            return false;
+        if (rules.deny.includes("FRAUD") && responseEmail.fraud)
+            return false;
+        if (rules.deny.includes("PROXIED_EMAIL") && responseEmail.proxiedEmail)
+            return false;
+        if (rules.deny.includes("FREE_SUBDOMAIN") && responseEmail.freeSubdomain)
+            return false;
+        if (rules.deny.includes("PERSONAL_EMAIL") && !responseEmail.corporate)
+            return false;
+        if (rules.deny.includes("CORPORATE_EMAIL") && responseEmail.corporate)
+            return false;
+        if (rules.deny.includes("NO_MX_RECORDS") && responseEmail.plugins.mxRecords.length === 0)
+            return false;
+        if (rules.deny.includes("NO_REPLY_EMAIL") && responseEmail.noReply)
+            return false;
+        if (rules.deny.includes("ROLE_ACCOUNT") && responseEmail.plugins.roleAccount)
+            return false;
+        if (rules.deny.includes("NO_REACHABLE") && !responseEmail.plugins.reachable)
+            return false;
+        if (rules.deny.includes("HIGH_RISK_SCORE") && responseEmail.plugins.riskScore >= 80)
+            return false;
+        return true;
+    }
+    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}`);
+    }
+};
+exports.isValidEmail = isValidEmail;
 /**
  * Sends an email using a secure sending endpoint.
  *

package/dist/cjs/dymo-api.cjs

@@ -57,13 +57,21 @@ class DymoAPI {
      *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
      * });
      */
-    constructor({ rootApiKey = null, apiKey = null, baseUrl = "https://api.tpeoficial.com", serverEmailConfig = undefined } = {}) {
+    constructor({ rootApiKey = null, apiKey = null, baseUrl = "https://api.tpeoficial.com", serverEmailConfig = undefined, rules = {
+        email: {
+            deny: [
+                "FRAUD", "INVALID", "NO_MX_RECORDS", "NO_REPLY_EMAIL"
+            ]
+        }
+    } } = {}) {
         this.rootApiKey = rootApiKey;
         this.apiKey = apiKey;
         this.serverEmailConfig = serverEmailConfig;
+        this.rules = rules;
         this.baseUrl = baseUrl;
         (0, config_1.setBaseUrl)(baseUrl);
     }
+    ;
     // FUNCTIONS / Private.
     /**
      * Validates the given data against the configured validation settings.
@@ -89,6 +97,29 @@ class DymoAPI {
     async isValidData(data) {
         return await PrivateAPI.isValidData(this.rootApiKey || this.apiKey, data);
     }
+    ;
+    /**
+     * Validates the given email 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 {string} [email] - Optional email address to validate.
+     * @param {NegativeEmailRules[]} [rules] - Optional rules for validation. Some rules are premium features.
+     * @important
+     * **⚠️ NO_MX_RECORDS, HIGH_RISK_SCORE and NO_REACHABLE are [PREMIUM](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier) features.**
+     * @returns {Promise<Interfaces.EmailValidatorResponse>} Resolves with the validation response.
+     * @throws Will throw an error if validation cannot be performed.
+     *
+     * @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)
+     */
+    async isValidEmail(email, rules = this.rules.email) {
+        return await PrivateAPI.isValidEmail(this.rootApiKey || this.apiKey, email, rules);
+    }
+    ;
     /**
      * Sends an email using the configured email client settings.
      *
@@ -120,6 +151,7 @@ class DymoAPI {
             console.error(`[${config_1.default.lib.name}] You must configure the email client settings.`);
         return await PrivateAPI.sendEmail(this.rootApiKey || this.apiKey, { serverEmailConfig: this.serverEmailConfig, ...data });
     }
+    ;
     /**
      * Generates a random number between the provided min and max values.
      *
@@ -138,6 +170,7 @@ class DymoAPI {
     async getRandom(data) {
         return await PrivateAPI.getRandom(this.rootApiKey || this.apiKey, data);
     }
+    ;
     /**
      * Extracts structured data from a given string using Textly.
      *
@@ -153,6 +186,7 @@ class DymoAPI {
     async extractWithTextly(data) {
         return await PrivateAPI.extractWithTextly(this.rootApiKey || this.apiKey, data);
     }
+    ;
     // FUNCTIONS / Public.
     /**
      * Retrieves the prayer times for the given location.
@@ -171,6 +205,7 @@ class DymoAPI {
     async getPrayerTimes(data) {
         return await PublicAPI.getPrayerTimes(data);
     }
+    ;
     /**
      * Satinizes the input, replacing any special characters with their HTML
      * entities.
@@ -185,6 +220,7 @@ class DymoAPI {
     async satinizer(data) {
         return await PublicAPI.satinizer(data);
     }
+    ;
     /**
      * Validates a password based on the given parameters.
      *
@@ -213,5 +249,7 @@ class DymoAPI {
     async isValidPwd(data) {
         return await PublicAPI.isValidPwd(data);
     }
+    ;
 }
+;
 exports.default = DymoAPI;

package/dist/cjs/lib/types/data-verifier.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,23 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+;
+;
+;
+;
+;
+__exportStar(require("./rules.cjs"), exports);
+__exportStar(require("./data-verifier.cjs"), exports);

package/dist/cjs/lib/types/primitives.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/{interfaces.cjs → types/rules.cjs}

@@ -1,9 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 ;
-;
-;
-;
-;
-;
-;

package/dist/esm/branches/private.js

@@ -41,6 +41,68 @@ export const isValidData = async (token, data) => {
         throw customError(5000, `Error ${statusCode}: ${errorMessage}. Details: ${errorDetails}`);
     }
 };
+/**
+ * Validates an email using a secure verification endpoint.
+ *
+ * @param {string | null} token - Authentication token (required).
+ * @param {Interfaces.EmailValidator} email - Email to validate.
+ * @param {Interfaces.EmailValidatorRules} [rules] - Deny rules. Defaults to ["FRAUD", "INVALID", "NO_MX_RECORDS", "NO_REPLY_EMAIL"].
+ *
+ * Deny rules (some are premium ⚠️):
+ * - "FRAUD", "INVALID", "NO_MX_RECORDS" ⚠️, "PROXIED_EMAIL" ⚠️, "FREE_SUBDOMAIN" ⚠️,
+ *   "PERSONAL_EMAIL", "CORPORATE_EMAIL", "NO_REPLY_EMAIL", "ROLE_ACCOUNT", "NO_REACHABLE", "HIGH_RISK_SCORE" ⚠️
+ *
+ * @returns {Promise<boolean>} True if the email passes all deny rules, false otherwise.
+ * @throws Error if token is null, rules are empty, or request fails.
+ *
+ * @example
+ * const valid = await isValidEmail(apiToken, "user@example.com", { deny: ["FRAUD", "NO_MX_RECORDS"] });
+ */
+export const isValidEmail = async (token, email, rules) => {
+    if (token === null)
+        throw customError(3000, "Invalid private token.");
+    if (rules.deny.length === 0)
+        throw customError(1500, "You must provide at least one deny rule.");
+    try {
+        const responseEmail = (await axiosApiUrl.post("/private/secure/verify", {
+            email,
+            plugins: [
+                rules.deny.includes("NO_MX_RECORDS") ? "mxRecords" : undefined,
+                rules.deny.includes("NO_REACHABLE") ? "reachability" : undefined,
+                rules.deny.includes("HIGH_RISK_SCORE") ? "riskScore" : undefined
+            ]
+        }, { headers: { "Content-Type": "application/json", "Authorization": token } })).data.email;
+        if (rules.deny.includes("INVALID") && !responseEmail.valid)
+            return false;
+        if (rules.deny.includes("FRAUD") && responseEmail.fraud)
+            return false;
+        if (rules.deny.includes("PROXIED_EMAIL") && responseEmail.proxiedEmail)
+            return false;
+        if (rules.deny.includes("FREE_SUBDOMAIN") && responseEmail.freeSubdomain)
+            return false;
+        if (rules.deny.includes("PERSONAL_EMAIL") && !responseEmail.corporate)
+            return false;
+        if (rules.deny.includes("CORPORATE_EMAIL") && responseEmail.corporate)
+            return false;
+        if (rules.deny.includes("NO_MX_RECORDS") && responseEmail.plugins.mxRecords.length === 0)
+            return false;
+        if (rules.deny.includes("NO_REPLY_EMAIL") && responseEmail.noReply)
+            return false;
+        if (rules.deny.includes("ROLE_ACCOUNT") && responseEmail.plugins.roleAccount)
+            return false;
+        if (rules.deny.includes("NO_REACHABLE") && !responseEmail.plugins.reachable)
+            return false;
+        if (rules.deny.includes("HIGH_RISK_SCORE") && responseEmail.plugins.riskScore >= 80)
+            return false;
+        return true;
+    }
+    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}`);
+    }
+};
 /**
  * Sends an email using a secure sending endpoint.
  *

package/dist/esm/dymo-api.js

@@ -22,13 +22,21 @@ class DymoAPI {
      *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
      * });
      */
-    constructor({ rootApiKey = null, apiKey = null, baseUrl = "https://api.tpeoficial.com", serverEmailConfig = undefined } = {}) {
+    constructor({ rootApiKey = null, apiKey = null, baseUrl = "https://api.tpeoficial.com", serverEmailConfig = undefined, rules = {
+        email: {
+            deny: [
+                "FRAUD", "INVALID", "NO_MX_RECORDS", "NO_REPLY_EMAIL"
+            ]
+        }
+    } } = {}) {
         this.rootApiKey = rootApiKey;
         this.apiKey = apiKey;
         this.serverEmailConfig = serverEmailConfig;
+        this.rules = rules;
         this.baseUrl = baseUrl;
         setBaseUrl(baseUrl);
     }
+    ;
     // FUNCTIONS / Private.
     /**
      * Validates the given data against the configured validation settings.
@@ -54,6 +62,29 @@ class DymoAPI {
     async isValidData(data) {
         return await PrivateAPI.isValidData(this.rootApiKey || this.apiKey, data);
     }
+    ;
+    /**
+     * Validates the given email 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 {string} [email] - Optional email address to validate.
+     * @param {NegativeEmailRules[]} [rules] - Optional rules for validation. Some rules are premium features.
+     * @important
+     * **⚠️ NO_MX_RECORDS, HIGH_RISK_SCORE and NO_REACHABLE are [PREMIUM](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier) features.**
+     * @returns {Promise<Interfaces.EmailValidatorResponse>} Resolves with the validation response.
+     * @throws Will throw an error if validation cannot be performed.
+     *
+     * @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)
+     */
+    async isValidEmail(email, rules = this.rules.email) {
+        return await PrivateAPI.isValidEmail(this.rootApiKey || this.apiKey, email, rules);
+    }
+    ;
     /**
      * Sends an email using the configured email client settings.
      *
@@ -85,6 +116,7 @@ class DymoAPI {
             console.error(`[${config.lib.name}] You must configure the email client settings.`);
         return await PrivateAPI.sendEmail(this.rootApiKey || this.apiKey, { serverEmailConfig: this.serverEmailConfig, ...data });
     }
+    ;
     /**
      * Generates a random number between the provided min and max values.
      *
@@ -103,6 +135,7 @@ class DymoAPI {
     async getRandom(data) {
         return await PrivateAPI.getRandom(this.rootApiKey || this.apiKey, data);
     }
+    ;
     /**
      * Extracts structured data from a given string using Textly.
      *
@@ -118,6 +151,7 @@ class DymoAPI {
     async extractWithTextly(data) {
         return await PrivateAPI.extractWithTextly(this.rootApiKey || this.apiKey, data);
     }
+    ;
     // FUNCTIONS / Public.
     /**
      * Retrieves the prayer times for the given location.
@@ -136,6 +170,7 @@ class DymoAPI {
     async getPrayerTimes(data) {
         return await PublicAPI.getPrayerTimes(data);
     }
+    ;
     /**
      * Satinizes the input, replacing any special characters with their HTML
      * entities.
@@ -150,6 +185,7 @@ class DymoAPI {
     async satinizer(data) {
         return await PublicAPI.satinizer(data);
     }
+    ;
     /**
      * Validates a password based on the given parameters.
      *
@@ -178,5 +214,7 @@ class DymoAPI {
     async isValidPwd(data) {
         return await PublicAPI.isValidPwd(data);
     }
+    ;
 }
+;
 export default DymoAPI;

package/dist/esm/lib/types/data-verifier.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,7 @@
+;
+;
+;
+;
+;
+export * from "./rules";
+export * from "./data-verifier";

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

@@ -0,0 +1 @@
+export {};

package/dist/esm/lib/{interfaces.js → types/rules.js}

@@ -1,8 +1,2 @@
 ;
-;
-;
-;
-;
-;
-;
 export {};

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

@@ -1,4 +1,4 @@
-import * as Interfaces from "../lib/interfaces";
+import * as Interfaces from "../lib/types/interfaces";
 /**
  * Validates the provided data using a secure verification endpoint.
  *
@@ -12,6 +12,24 @@ import * as Interfaces from "../lib/interfaces";
  *         or if an error occurs during the verification request.
  */
 export declare const isValidData: (token: string | null, data: Interfaces.Validator) => Promise<any>;
+/**
+ * Validates an email using a secure verification endpoint.
+ *
+ * @param {string | null} token - Authentication token (required).
+ * @param {Interfaces.EmailValidator} email - Email to validate.
+ * @param {Interfaces.EmailValidatorRules} [rules] - Deny rules. Defaults to ["FRAUD", "INVALID", "NO_MX_RECORDS", "NO_REPLY_EMAIL"].
+ *
+ * Deny rules (some are premium ⚠️):
+ * - "FRAUD", "INVALID", "NO_MX_RECORDS" ⚠️, "PROXIED_EMAIL" ⚠️, "FREE_SUBDOMAIN" ⚠️,
+ *   "PERSONAL_EMAIL", "CORPORATE_EMAIL", "NO_REPLY_EMAIL", "ROLE_ACCOUNT", "NO_REACHABLE", "HIGH_RISK_SCORE" ⚠️
+ *
+ * @returns {Promise<boolean>} True if the email passes all deny rules, false otherwise.
+ * @throws Error if token is null, rules are empty, or request fails.
+ *
+ * @example
+ * const valid = await isValidEmail(apiToken, "user@example.com", { deny: ["FRAUD", "NO_MX_RECORDS"] });
+ */
+export declare const isValidEmail: (token: string | null, email: Interfaces.EmailValidator, rules: Interfaces.EmailValidatorRules) => Promise<any>;
 /**
  * Sends an email using a secure sending endpoint.
  *

package/dist/types/branches/public.d.ts

@@ -1,4 +1,4 @@
-import * as Interfaces from "../lib/interfaces";
+import * as Interfaces from "../lib/types/interfaces";
 export declare const getPrayerTimes: (data: Interfaces.PrayerTimesData) => Promise<any>;
 export declare const satinizer: (data: Interfaces.InputSatinizerData) => Promise<any>;
 export declare const isValidPwd: (data: Interfaces.IsValidPwdData) => Promise<any>;

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

@@ -1,8 +1,9 @@
-import * as Interfaces from "./lib/interfaces";
+import * as Interfaces from "./lib/types/interfaces";
 declare class DymoAPI {
     private rootApiKey;
     private apiKey;
     private serverEmailConfig?;
+    private rules;
     private baseUrl;
     /**
      * @param {Object} options - Options to create the DymoAPI instance.
@@ -21,11 +22,12 @@ declare class DymoAPI {
      *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
      * });
      */
-    constructor({ rootApiKey, apiKey, baseUrl, serverEmailConfig }?: {
+    constructor({ rootApiKey, apiKey, baseUrl, serverEmailConfig, rules }?: {
         rootApiKey?: string | null;
         apiKey?: string | null;
         baseUrl?: string;
         serverEmailConfig?: Interfaces.ServerEmailConfig;
+        rules?: Interfaces.Rules;
     });
     /**
      * Validates the given data against the configured validation settings.
@@ -49,6 +51,25 @@ declare class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
      */
     isValidData(data: Interfaces.Validator): Promise<Interfaces.DataValidationAnalysis>;
+    /**
+     * Validates the given email 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 {string} [email] - Optional email address to validate.
+     * @param {NegativeEmailRules[]} [rules] - Optional rules for validation. Some rules are premium features.
+     * @important
+     * **⚠️ NO_MX_RECORDS, HIGH_RISK_SCORE and NO_REACHABLE are [PREMIUM](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier) features.**
+     * @returns {Promise<Interfaces.EmailValidatorResponse>} Resolves with the validation response.
+     * @throws Will throw an error if validation cannot be performed.
+     *
+     * @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)
+     */
+    isValidEmail(email: Interfaces.EmailValidator, rules?: Interfaces.EmailValidatorRules): Promise<Interfaces.EmailValidatorResponse>;
     /**
      * Sends an email using the configured email client settings.
      *

package/dist/types/lib/types/data-verifier.d.ts

@@ -0,0 +1,185 @@
+import { MxRecord } from "dns";
+import { Email, Phone, CreditCard } from "./primitives";
+export type VerifyPlugins = "blocklist" | "compromiseDetector" | "mxRecords" | "nsfw" | "reputation" | "riskScore" | "torNetwork" | "typosquatting" | "urlShortener";
+export type ReputationPlugin = "low" | "medium" | "high" | "very-high" | "education" | "governmental" | "unknown";
+export type TyposquattingPlugin = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+export interface Validator {
+    url?: string;
+    email?: string;
+    phone?: Phone;
+    domain?: string;
+    creditCard?: string | CreditCard;
+    ip?: string;
+    wallet?: string;
+    userAgent?: string;
+    plugins?: VerifyPlugins[];
+}
+export type EmailValidator = Email;
+/**
+ * @typedef {"FRAUD"|"INVALID"|"NO_MX_RECORDS"|"PROXIED_EMAIL"|"FREE_SUBDOMAIN"|"PERSONAL"|"CORPORATE"|"NO_REPLY"|"ROLE_ACCOUNT"|"REACHABLE"|"HIGH_RISK_SCORE"} NegativeEmailRules
+ *
+ * @description
+ * Values indicating why an email is considered negative.
+ * ⚠️ NO_MX_RECORDS, PROXIED_EMAIL, FREE_SUBDOMAIN, CORPORATE, and HIGH_RISK_SCORE are premium features.
+ */
+export type NegativeEmailRules = "FRAUD" | "INVALID" | "NO_MX_RECORDS" | "PROXIED_EMAIL" | "FREE_SUBDOMAIN" | "PERSONAL_EMAIL" | "CORPORATE_EMAIL" | "NO_REPLY_EMAIL" | "ROLE_ACCOUNT" | "NO_REACHABLE" | "HIGH_RISK_SCORE";
+export interface EmailValidatorRules {
+    deny: NegativeEmailRules[];
+}
+export type EmailValidatorResponse = boolean;
+export interface DataValidationAnalysis {
+    url: {
+        valid: boolean;
+        fraud: boolean;
+        freeSubdomain: boolean;
+        customTLD: boolean;
+        url: string;
+        domain: string;
+        plugins: {
+            blocklist?: boolean;
+            compromiseDetector?: boolean;
+            mxRecords: MxRecord[];
+            nsfw?: boolean;
+            reputation?: ReputationPlugin;
+            riskScore?: number;
+            torNetwork?: boolean;
+            typosquatting?: TyposquattingPlugin;
+            urlShortener?: boolean;
+        };
+    };
+    email: {
+        valid: boolean;
+        fraud: boolean;
+        proxiedEmail: boolean;
+        freeSubdomain: boolean;
+        corporate: boolean;
+        email: string;
+        realUser: string;
+        didYouMean: string | null;
+        noReply: boolean;
+        customTLD: boolean;
+        domain: string;
+        roleAccount: boolean;
+        plugins: {
+            blocklist?: boolean;
+            compromiseDetector?: boolean;
+            nsfw?: boolean;
+            reputation?: TyposquattingPlugin;
+            riskScore?: number;
+            torNetwork?: boolean;
+            typosquatting?: TyposquattingPlugin;
+            urlShortener?: boolean;
+        };
+    };
+    phone: {
+        valid: boolean;
+        fraud: boolean;
+        phone: string;
+        prefix: string;
+        number: string;
+        lineType: "PREMIUM_RATE" | "TOLL_FREE" | "SHARED_COST" | "VOIP" | "PERSONAL_NUMBER" | "PAGER" | "UAN" | "VOICEMAIL" | "FIXED_LINE_OR_MOBILE" | "FIXED_LINE" | "MOBILE" | "Unknown";
+        carrierInfo: {
+            carrierName: string;
+            accuracy: number;
+            carrierCountry: string;
+            carrierCountryCode: string;
+        };
+        country: string;
+        countryCode: string;
+        plugins: {
+            blocklist?: boolean;
+            riskScore?: number;
+        };
+    };
+    domain: {
+        valid: boolean;
+        fraud: boolean;
+        freeSubdomain: boolean;
+        customTLD: boolean;
+        domain: string;
+        plugins: {
+            blocklist?: boolean;
+            compromiseDetector?: boolean;
+            nsfw?: boolean;
+            reputation?: "low" | "medium" | "high" | "very-high" | "education" | "governmental" | "unknown";
+            riskScore?: number;
+            torNetwork?: boolean;
+            typosquatting?: TyposquattingPlugin;
+            urlShortener?: boolean;
+        };
+    };
+    creditCard: {
+        valid: boolean;
+        fraud: boolean;
+        test: boolean;
+        type: string;
+        creditCard: string;
+        plugins: {
+            blocklist?: boolean;
+            riskScore?: number;
+        };
+    };
+    ip: {
+        valid: boolean;
+        type: "IPv4" | "IPv6" | "Invalid";
+        class: "A" | "B" | "C" | "D" | "E" | "Unknown" | "None";
+        fraud: boolean;
+        ip: string;
+        continent: string;
+        continentCode: string;
+        country: string;
+        countryCode: string;
+        region: string;
+        regionName: string;
+        city: string;
+        district: string;
+        zipCode: string;
+        lat: number;
+        lon: number;
+        timezone: string;
+        offset: number;
+        currency: string;
+        isp: string;
+        org: string;
+        as: string;
+        asname: string;
+        mobile: boolean;
+        proxy: boolean;
+        hosting: boolean;
+        plugins: {
+            blocklist?: boolean;
+            riskScore?: number;
+        };
+    };
+    wallet: {
+        valid: boolean;
+        fraud: boolean;
+        wallet: string;
+        type: string;
+        plugins: {
+            blocklist?: boolean;
+            riskScore?: number;
+            torNetwork?: boolean;
+        };
+    };
+    userAgent: {
+        valid: boolean;
+        type?: string;
+        clientSlug?: string | null;
+        clientName?: string;
+        version?: string | null;
+        userAgent?: string;
+        fraud?: boolean;
+        bot?: boolean;
+        info?: string;
+        os?: string;
+        device: {
+            type?: string;
+            brand?: string;
+        };
+        plugins?: {
+            blocklist?: boolean;
+            riskScore?: number;
+        };
+    };
+}

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

@@ -0,0 +1,169 @@
+import type * as React from "react";
+export interface SRNG {
+    min: number;
+    max: number;
+    quantity?: number;
+}
+export type Attachment = {
+    filename: string;
+    path?: string;
+    content?: string | Buffer;
+    cid?: string;
+};
+export interface ServerEmailConfig {
+    host: string;
+    port: number;
+    secure: boolean;
+    auth: {
+        user: string;
+        pass: string;
+    };
+    dkim?: {
+        domainName: string;
+        keySelector: string;
+        privateKey: string;
+    };
+}
+export type SendEmail = {
+    from: string;
+    to: string;
+    subject: string;
+    attachments?: Attachment[];
+    options?: {
+        priority?: "high" | "normal" | "low";
+        composeTailwindClasses?: boolean;
+        compileToCssSafe?: boolean;
+        onlyVerifiedEmails?: boolean;
+    };
+} & ({
+    html: string;
+    react?: never;
+} | {
+    react: React.ReactNode;
+    html?: never;
+});
+export interface PrayerTimesData {
+    lat?: number;
+    lon?: number;
+}
+export interface InputSatinizerData {
+    input?: string;
+}
+export interface IsValidPwdData {
+    email?: string;
+    password?: string;
+    bannedWords?: string | string[];
+    min?: number;
+    max?: number;
+}
+export interface SRNComponent {
+    integer: number;
+    float: number;
+}
+export interface SRNSummary {
+    values: SRNComponent[];
+    executionTime: number;
+}
+export interface CountryPrayerTimes {
+    country: string;
+    prayerTimesByTimezone: {
+        timezone: string;
+        prayerTimes: {
+            coordinates: string;
+            date: string;
+            calculationParameters: string;
+            fajr: string;
+            sunrise: string;
+            dhuhr: string;
+            asr: string;
+            sunset: string;
+            maghrib: string;
+            isha: string;
+        };
+    }[];
+}
+export interface SatinizedInputAnalysis {
+    input: string;
+    formats: {
+        ascii: boolean;
+        bitcoinAddress: boolean;
+        cLikeIdentifier: boolean;
+        coordinates: boolean;
+        crediCard: boolean;
+        date: boolean;
+        discordUsername: boolean;
+        doi: boolean;
+        domain: boolean;
+        e164Phone: boolean;
+        email: boolean;
+        emoji: boolean;
+        hanUnification: boolean;
+        hashtag: boolean;
+        hyphenWordBreak: boolean;
+        ipv6: boolean;
+        ip: boolean;
+        jiraTicket: boolean;
+        macAddress: boolean;
+        name: boolean;
+        number: boolean;
+        panFromGstin: boolean;
+        password: boolean;
+        port: boolean;
+        tel: boolean;
+        text: boolean;
+        semver: boolean;
+        ssn: boolean;
+        uuid: boolean;
+        url: boolean;
+        urlSlug: boolean;
+        username: boolean;
+    };
+    includes: {
+        spaces: boolean;
+        hasSql: boolean;
+        hasNoSql: boolean;
+        letters: boolean;
+        uppercase: boolean;
+        lowercase: boolean;
+        symbols: boolean;
+        digits: boolean;
+    };
+}
+export interface EmailStatus {
+    status: boolean;
+    error?: string;
+}
+export interface ValidationDetail {
+    validation: string;
+    message: string;
+    word?: string;
+}
+export interface PasswordValidationResult {
+    valid: boolean;
+    password: string;
+    details: ValidationDetail[];
+}
+export type SchemaType = "string" | "number" | "boolean" | "array" | "object";
+export interface JsonSchemaProperty {
+    type: SchemaType;
+    items?: JsonSchemaProperty;
+    properties?: Record<string, JsonSchemaProperty>;
+    required?: string[];
+    description?: string;
+    format?: string;
+    enum?: unknown[];
+    minimum?: number;
+    maximum?: number;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    [key: string]: unknown;
+}
+export interface ExtractWithTextly {
+    data: string;
+    format: {
+        [key: string]: JsonSchemaProperty;
+    };
+}
+export * from "./rules";
+export * from "./data-verifier";

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

@@ -0,0 +1,11 @@
+export type Email = `${string}@${string}` | string;
+export type Phone = {
+    iso: any;
+    phone: string;
+} | string;
+export interface CreditCard {
+    pan: string | number;
+    expirationDate?: string;
+    cvc?: string | number;
+    cvv?: string | number;
+}

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

@@ -0,0 +1,6 @@
+import { NegativeEmailRules } from "./data-verifier";
+export interface Rules {
+    email: {
+        deny: NegativeEmailRules[];
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.1.05",
+  "version": "1.1.07",
   "description": "Flow system for Dymo API.",
   "main": "dist/cjs/dymo-api.js",
   "module": "dist/esm/dymo-api.js",
@@ -26,7 +26,8 @@
     "build": "rimraf dist && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && node ./scripts/rename.js",
     "start": "ts-node src/dymo-api.ts",
     "prepublishOnly": "npm run build",
-    "test": "node --max-old-space-size=4096 test/index.js"
+    "test": "jest --max-old-space-size=4096",
+    "test:watch": "jest --watch --max-old-space-size=4096"
   },
   "repository": {
     "url": "https://github.com/TPEOficial/dymo-api-node"
@@ -48,7 +49,6 @@
     "@types/react": "^18.3.5",
     "axios": "^1.6.8",
     "path": "^0.12.7",
-    "rimraf": "^6.0.1",
     "tw-to-css": "0.0.12"
   },
   "contributors": [
@@ -57,8 +57,13 @@
   ],
   "devDependencies": {
     "@types/axios": "^0.9.36",
+    "@types/jest": "^30.0.0",
     "@types/node": "^22.9.3",
+    "dotenv": "^17.2.2",
+    "jest": "^30.1.3",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.4.4",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4"
   }
-}
+}

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

@@ -1,344 +0,0 @@
-import type * as React from "react";
-export type PhoneData = {
-    iso: any;
-    phone: string;
-} | string;
-export interface CreditCardData {
-    pan: string | number;
-    expirationDate?: string;
-    cvc?: string | number;
-    cvv?: string | number;
-}
-export type VerifyPlugins = "blocklist" | "compromiseDetector" | "nsfw" | "reputation" | "riskScore" | "torNetwork" | "typosquatting" | "urlShortener";
-export interface Validator {
-    url?: string;
-    email?: string;
-    phone?: PhoneData;
-    domain?: string;
-    creditCard?: string | CreditCardData;
-    ip?: string;
-    wallet?: string;
-    userAgent?: string;
-    plugins?: VerifyPlugins[];
-}
-export interface SRNG {
-    min: number;
-    max: number;
-    quantity?: number;
-}
-export type Attachment = {
-    filename: string;
-    path?: string;
-    content?: string | Buffer;
-    cid?: string;
-};
-export interface ServerEmailConfig {
-    host: string;
-    port: number;
-    secure: boolean;
-    auth: {
-        user: string;
-        pass: string;
-    };
-    dkim?: {
-        domainName: string;
-        keySelector: string;
-        privateKey: string;
-    };
-}
-export type SendEmail = {
-    from: string;
-    to: string;
-    subject: string;
-    attachments?: Attachment[];
-    options?: {
-        priority?: "high" | "normal" | "low";
-        composeTailwindClasses?: boolean;
-        compileToCssSafe?: boolean;
-        onlyVerifiedEmails?: boolean;
-    };
-} & ({
-    html: string;
-    react?: never;
-} | {
-    react: React.ReactNode;
-    html?: never;
-});
-export interface PrayerTimesData {
-    lat?: number;
-    lon?: number;
-}
-export interface InputSatinizerData {
-    input?: string;
-}
-export interface IsValidPwdData {
-    email?: string;
-    password?: string;
-    bannedWords?: string | string[];
-    min?: number;
-    max?: number;
-}
-export interface SRNComponent {
-    integer: number;
-    float: number;
-}
-export interface SRNSummary {
-    values: SRNComponent[];
-    executionTime: number;
-}
-export interface CountryPrayerTimes {
-    country: string;
-    prayerTimesByTimezone: {
-        timezone: string;
-        prayerTimes: {
-            coordinates: string;
-            date: string;
-            calculationParameters: string;
-            fajr: string;
-            sunrise: string;
-            dhuhr: string;
-            asr: string;
-            sunset: string;
-            maghrib: string;
-            isha: string;
-        };
-    }[];
-}
-export interface SatinizedInputAnalysis {
-    input: string;
-    formats: {
-        ascii: boolean;
-        bitcoinAddress: boolean;
-        cLikeIdentifier: boolean;
-        coordinates: boolean;
-        crediCard: boolean;
-        date: boolean;
-        discordUsername: boolean;
-        doi: boolean;
-        domain: boolean;
-        e164Phone: boolean;
-        email: boolean;
-        emoji: boolean;
-        hanUnification: boolean;
-        hashtag: boolean;
-        hyphenWordBreak: boolean;
-        ipv6: boolean;
-        ip: boolean;
-        jiraTicket: boolean;
-        macAddress: boolean;
-        name: boolean;
-        number: boolean;
-        panFromGstin: boolean;
-        password: boolean;
-        port: boolean;
-        tel: boolean;
-        text: boolean;
-        semver: boolean;
-        ssn: boolean;
-        uuid: boolean;
-        url: boolean;
-        urlSlug: boolean;
-        username: boolean;
-    };
-    includes: {
-        spaces: boolean;
-        hasSql: boolean;
-        hasNoSql: boolean;
-        letters: boolean;
-        uppercase: boolean;
-        lowercase: boolean;
-        symbols: boolean;
-        digits: boolean;
-    };
-}
-export interface EmailStatus {
-    status: boolean;
-    error?: string;
-}
-export interface ValidationDetail {
-    validation: string;
-    message: string;
-    word?: string;
-}
-export interface PasswordValidationResult {
-    valid: boolean;
-    password: string;
-    details: ValidationDetail[];
-}
-export interface DataValidationAnalysis {
-    url: {
-        valid: boolean;
-        fraud: boolean;
-        freeSubdomain: boolean;
-        customTLD: boolean;
-        url: string;
-        domain: string;
-        plugins: {
-            blocklist?: boolean;
-            compromiseDetector?: boolean;
-            nsfw?: boolean;
-            reputation?: "low" | "medium" | "high" | "very-high" | "education" | "governmental" | "unknown";
-            riskScore?: number;
-            torNetwork?: boolean;
-            typosquatting?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
-            urlShortener?: boolean;
-        };
-    };
-    email: {
-        valid: boolean;
-        fraud: boolean;
-        proxiedEmail: boolean;
-        freeSubdomain: boolean;
-        corporate: boolean;
-        email: string;
-        realUser: string;
-        didYouMean: string | null;
-        noReply: boolean;
-        customTLD: boolean;
-        domain: string;
-        roleAccount: boolean;
-        plugins: {
-            blocklist?: boolean;
-            compromiseDetector?: boolean;
-            nsfw?: boolean;
-            reputation?: "low" | "medium" | "high" | "very-high" | "education" | "governmental" | "unknown";
-            riskScore?: number;
-            torNetwork?: boolean;
-            typosquatting?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
-            urlShortener?: boolean;
-        };
-    };
-    phone: {
-        valid: boolean;
-        fraud: boolean;
-        phone: string;
-        prefix: string;
-        number: string;
-        lineType: "PREMIUM_RATE" | "TOLL_FREE" | "SHARED_COST" | "VOIP" | "PERSONAL_NUMBER" | "PAGER" | "UAN" | "VOICEMAIL" | "FIXED_LINE_OR_MOBILE" | "FIXED_LINE" | "MOBILE" | "Unknown";
-        carrierInfo: {
-            carrierName: string;
-            accuracy: number;
-            carrierCountry: string;
-            carrierCountryCode: string;
-        };
-        country: string;
-        countryCode: string;
-        plugins: {
-            blocklist?: boolean;
-            riskScore?: number;
-        };
-    };
-    domain: {
-        valid: boolean;
-        fraud: boolean;
-        freeSubdomain: boolean;
-        customTLD: boolean;
-        domain: string;
-        plugins: {
-            blocklist?: boolean;
-            compromiseDetector?: boolean;
-            nsfw?: boolean;
-            reputation?: "low" | "medium" | "high" | "very-high" | "education" | "governmental" | "unknown";
-            riskScore?: number;
-            torNetwork?: boolean;
-            typosquatting?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
-            urlShortener?: boolean;
-        };
-    };
-    creditCard: {
-        valid: boolean;
-        fraud: boolean;
-        test: boolean;
-        type: string;
-        creditCard: string;
-        plugins: {
-            blocklist?: boolean;
-            riskScore?: number;
-        };
-    };
-    ip: {
-        valid: boolean;
-        type: "IPv4" | "IPv6" | "Invalid";
-        class: "A" | "B" | "C" | "D" | "E" | "Unknown" | "None";
-        fraud: boolean;
-        ip: string;
-        continent: string;
-        continentCode: string;
-        country: string;
-        countryCode: string;
-        region: string;
-        regionName: string;
-        city: string;
-        district: string;
-        zipCode: string;
-        lat: number;
-        lon: number;
-        timezone: string;
-        offset: number;
-        currency: string;
-        isp: string;
-        org: string;
-        as: string;
-        asname: string;
-        mobile: boolean;
-        proxy: boolean;
-        hosting: boolean;
-        plugins: {
-            blocklist?: boolean;
-            riskScore?: number;
-        };
-    };
-    wallet: {
-        valid: boolean;
-        fraud: boolean;
-        wallet: string;
-        type: string;
-        plugins: {
-            blocklist?: boolean;
-            riskScore?: number;
-            torNetwork?: boolean;
-        };
-    };
-    userAgent: {
-        valid: boolean;
-        type?: string;
-        clientSlug?: string | null;
-        clientName?: string;
-        version?: string | null;
-        userAgent?: string;
-        fraud?: boolean;
-        bot?: boolean;
-        info?: string;
-        os?: string;
-        device: {
-            type?: string;
-            brand?: string;
-        };
-        plugins?: {
-            blocklist?: boolean;
-            riskScore?: number;
-        };
-    };
-}
-export type SchemaType = "string" | "number" | "boolean" | "array" | "object";
-export interface JsonSchemaProperty {
-    type: SchemaType;
-    items?: JsonSchemaProperty;
-    properties?: Record<string, JsonSchemaProperty>;
-    required?: string[];
-    description?: string;
-    format?: string;
-    enum?: unknown[];
-    minimum?: number;
-    maximum?: number;
-    minLength?: number;
-    maxLength?: number;
-    pattern?: string;
-    [key: string]: unknown;
-}
-export interface ExtractWithTextly {
-    data: string;
-    format: {
-        [key: string]: JsonSchemaProperty;
-    };
-}