dymo-api 1.2.5 → 1.2.7

package/dist/cjs/dymo-api.cjs

@@ -32,10 +32,15 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const config_1 = __importStar(require("./config/index.cjs"));
-const PublicAPI = __importStar(require("./branches/public.cjs"));
-const PrivateAPI = __importStar(require("./branches/private.cjs"));
+const config_1 = __importDefault(require("./config/index.cjs"));
+const PublicAPI = __importStar(require("./branches/public/index.cjs"));
+const PrivateAPI = __importStar(require("./branches/private/index.cjs"));
+const axios_1 = __importDefault(require("axios"));
+const basics_1 = require("./utils/basics.cjs");
 const customError = (code, message) => {
     return Object.assign(new Error(), { code, message: `[${config_1.default.lib.name}] ${message}` });
 };
@@ -54,20 +59,30 @@ class DymoAPI {
      * @example
      * const dymoApi = new DymoAPI({
      *     rootApiKey: "6bfb7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
+     *     apiKey: "dm_4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
      * });
      */
     constructor({ rootApiKey = null, apiKey = null, baseUrl = "https://api.tpeoficial.com", serverEmailConfig = undefined, rules = {} } = {}) {
         this.rules = {
-            email: { deny: ["FRAUD", "INVALID", "NO_MX_RECORDS", "NO_REPLY_EMAIL"] },
-            sensitiveInfo: { deny: ["EMAIL", "PHONE", "CREDIT_CARD"] },
+            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;
         this.apiKey = apiKey;
         this.serverEmailConfig = serverEmailConfig;
         this.baseUrl = baseUrl;
-        (0, config_1.setBaseUrl)(baseUrl);
+        // We created the Axios client with the appropriate settings.
+        this.axiosClient = axios_1.default.create({
+            baseURL: `${(0, basics_1.validBaseURL)(this.baseUrl)}/v1`,
+            headers: {
+                "User-Agent": "DymoAPISDK/1.0.0"
+            }
+        });
+        // We set the authorization in the Axios client to make requests.
+        if (this.rootApiKey || this.apiKey)
+            this.axiosClient.defaults.headers.Authorization = `Bearer ${this.rootApiKey || this.apiKey}`;
     }
     ;
     // FUNCTIONS / Private.
@@ -93,7 +108,7 @@ class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
      */
     async isValidData(data) {
-        return await PrivateAPI.isValidData(this.rootApiKey || this.apiKey, data);
+        return await PrivateAPI.isValidData(this.axiosClient, data);
     }
     ;
     /**
@@ -112,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.rootApiKey || this.apiKey, email, rules);
+        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.
      *
@@ -147,7 +183,7 @@ class DymoAPI {
     async sendEmail(data) {
         if (!this.serverEmailConfig && !this.rootApiKey)
             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 });
+        return await PrivateAPI.sendEmail(this.axiosClient, { serverEmailConfig: this.serverEmailConfig, ...data });
     }
     ;
     /**
@@ -166,7 +202,7 @@ class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/secure-random-number-generator)
      */
     async getRandom(data) {
-        return await PrivateAPI.getRandom(this.rootApiKey || this.apiKey, data);
+        return await PrivateAPI.getRandom(this.axiosClient, data);
     }
     ;
     /**
@@ -182,7 +218,7 @@ class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/textly/text-extraction)
      */
     async extractWithTextly(data) {
-        return await PrivateAPI.extractWithTextly(this.rootApiKey || this.apiKey, data);
+        return await PrivateAPI.extractWithTextly(this.axiosClient, data);
     }
     ;
     // FUNCTIONS / Public.
@@ -201,13 +237,14 @@ class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/prayertimes)
      */
     async getPrayerTimes(data) {
-        return await PublicAPI.getPrayerTimes(data);
+        return await PublicAPI.getPrayerTimes(this.axiosClient, data);
     }
     ;
     /**
      * Satinizes the input, replacing any special characters with their HTML
      * entities.
      *
+     * @deprecated Use `satinize` instead. This feature will be removed soon.
      * @param {Object} data - The data to be sent.
      * @param {string} data.input - The input to be satinized.
      * @returns {Promise<Interfaces.SatinizedInputAnalysis>} A promise that resolves to the response from the server.
@@ -216,7 +253,22 @@ class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/input-satinizer)
      */
     async satinizer(data) {
-        return await PublicAPI.satinizer(data);
+        return await PublicAPI.satinize(this.axiosClient, data.input);
+    }
+    ;
+    /**
+     * Satinizes the input, replacing any special characters with their HTML
+     * entities.
+     *
+     * @param {Object} data - The data to be sent.
+     * @param {string} data.input - The input to be satinized.
+     * @returns {Promise<Interfaces.SatinizedInputAnalysis>} A promise that resolves to the response from the server.
+     * @throws Will throw an error if there is an issue with the satinization process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/input-satinizer)
+     */
+    async satinize(input) {
+        return await PublicAPI.satinize(this.axiosClient, input);
     }
     ;
     /**
@@ -245,7 +297,7 @@ class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/password-validator)
      */
     async isValidPwd(data) {
-        return await PublicAPI.isValidPwd(data);
+        return await PublicAPI.isValidPwd(this.axiosClient, data);
     }
     ;
 }

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

@@ -18,6 +18,7 @@ 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);