dymo-api 1.0.84 → 1.0.85

package/dist/cjs/dymo-api.cjs

@@ -32,11 +32,7 @@ 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 axios_1 = __importDefault(require("axios"));
 const PublicAPI = __importStar(require("./branches/public.cjs"));
 const PrivateAPI = __importStar(require("./branches/private.cjs"));
 const config_1 = __importStar(require("./config/index.cjs"));
@@ -44,9 +40,6 @@ const autoupdate_1 = require("./services/autoupdate.cjs");
 const customError = (code, message) => {
     return Object.assign(new Error(), { code, message: `[${config_1.default.lib.name}] ${message}` });
 };
-;
-;
-;
 class DymoAPI {
     /**
      * @param {Object} options - Options to create the DymoAPI instance.
@@ -73,67 +66,6 @@ class DymoAPI {
         this.local = rootApiKey ? local : false; // Only allow setting local if rootApiKey is defined.
         (0, config_1.setBaseUrl)(this.local);
         this.autoupdate();
-        this.initializeTokens(); // Calls the function to obtain tokens when creating the object.
-    }
-    /**
-     * Retrieves and caches authentication tokens.
-     *
-     * This method checks if cached tokens are available and valid. If so, it returns
-     * the cached tokens. Otherwise, it generates new tokens using the provided API keys
-     * and caches them. The tokens are fetched from the server using a POST request.
-     *
-     * The method also handles validation of root and API tokens, throwing errors if
-     * any of the tokens are invalid. Cached tokens are considered valid for 5 minutes.
-     *
-     * @returns {Promise<TokensResponse|undefined>} A promise that resolves to the tokens response
-     * if successful, or undefined if no tokens are available.
-     * @throws Will throw an error if token validation fails, or if there is an issue
-     * with the token retrieval process.
-     */
-    async getTokens() {
-        if (DymoAPI.tokensResponse && DymoAPI.tokensVerified) {
-            console.log(`[${config_1.default.lib.name}] Using cached tokens response.`);
-            return DymoAPI.tokensResponse;
-        }
-        const tokens = {};
-        if (this.rootApiKey)
-            tokens.root = `Bearer ${this.rootApiKey}`;
-        if (this.apiKey)
-            tokens.api = `Bearer ${this.apiKey}`;
-        try {
-            if (Object.keys(tokens).length === 0)
-                return;
-            const response = await axios_1.default.post(`${config_1.BASE_URL}/v1/dvr/tokens`, { tokens });
-            if (tokens.root && response.data.root === false)
-                throw customError(3000, "Invalid root token.");
-            if (tokens.api && response.data.api === false)
-                throw customError(3000, "Invalid API token.");
-            DymoAPI.tokensResponse = response.data;
-            DymoAPI.tokensVerified = true;
-            console.log(`[${config_1.default.lib.name}] Tokens initialized successfully.`);
-            return DymoAPI.tokensResponse;
-        }
-        catch (error) {
-            console.error(error.message);
-            throw new Error(error.message);
-        }
-    }
-    /**
-     * Initializes the tokens response by calling getTokens().
-     *
-     * This method is called in the constructor and will throw an error if the
-     * initialization process fails.
-     *
-     * @throws Will throw an error if there is an issue with the token retrieval
-     * process.
-     */
-    async initializeTokens() {
-        try {
-            await this.getTokens();
-        }
-        catch (error) {
-            console.error(`Error initializing tokens: ${error.message}`);
-        }
     }
     /**
      * Checks for updates and logs a message if a new version is available.
@@ -149,7 +81,7 @@ class DymoAPI {
             await (0, autoupdate_1.checkForUpdates)();
         }
         catch (error) {
-            console.error(`Error checking the latest version in npmjs: ${error.message}`);
+            console.error(`[${config_1.default.lib.name}] Error checking the latest version in npmjs: ${error.message}`);
         }
     }
     // FUNCTIONS / Private.
@@ -169,6 +101,8 @@ class DymoAPI {
      * @param {Interfaces.VerifyPlugins[]} [data.plugins] - Optional array of verification plugins to be used.
      * @returns {Promise<Interfaces.DataValidationAnalysis>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the validation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
      */
     async isValidData(data) {
         return await PrivateAPI.isValidData(this.rootApiKey || this.apiKey, data);
@@ -196,10 +130,12 @@ class DymoAPI {
      * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
      * @returns {Promise<Interfaces.EmailStatus>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the email sending process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/sender-send-email/getting-started)
      */
     async sendEmail(data) {
         if (!this.serverEmailConfig && !this.rootApiKey)
-            console.error("You must configure the email client settings.");
+            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 });
     }
     /**
@@ -214,6 +150,8 @@ class DymoAPI {
      * @param {number} [data.quantity] - The number of random values to generate. Defaults to 1 if not provided.
      * @returns {Promise<Interfaces.SRNSummary>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the random number generation process.
+     *
+     * [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);
@@ -230,6 +168,8 @@ class DymoAPI {
      * @param {number} data.lon - The longitude of the location.
      * @returns {Promise<Interfaces.CountryPrayerTimes | { error: string }>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the prayer times retrieval process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/prayertimes)
      */
     async getPrayerTimes(data) {
         return await PublicAPI.getPrayerTimes(data);
@@ -242,6 +182,8 @@ class DymoAPI {
      * @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 satinizer(data) {
         return await PublicAPI.satinizer(data);
@@ -268,11 +210,11 @@ class DymoAPI {
      * @param {string | string[]} [data.bannedWords] - The list of banned words that the password must not contain.
      * @returns {Promise<Interfaces.PasswordValidationResult>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the password validation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/password-validator)
      */
     async isValidPwd(data) {
         return await PublicAPI.isValidPwd(data);
     }
 }
-DymoAPI.tokensResponse = null;
-DymoAPI.tokensVerified = false;
 exports.default = DymoAPI;

package/dist/cjs/lib/interfaces.cjs

@@ -7,3 +7,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 ;
 ;
 ;
+;

package/dist/esm/dymo-api.js

@@ -1,14 +1,10 @@
-import axios from "axios";
 import * as PublicAPI from "./branches/public.js";
 import * as PrivateAPI from "./branches/private.js";
-import config, { BASE_URL, setBaseUrl } from "./config/index.js";
+import config, { setBaseUrl } from "./config/index.js";
 import { checkForUpdates } from "./services/autoupdate.js";
 const customError = (code, message) => {
     return Object.assign(new Error(), { code, message: `[${config.lib.name}] ${message}` });
 };
-;
-;
-;
 class DymoAPI {
     /**
      * @param {Object} options - Options to create the DymoAPI instance.
@@ -35,67 +31,6 @@ class DymoAPI {
         this.local = rootApiKey ? local : false; // Only allow setting local if rootApiKey is defined.
         setBaseUrl(this.local);
         this.autoupdate();
-        this.initializeTokens(); // Calls the function to obtain tokens when creating the object.
-    }
-    /**
-     * Retrieves and caches authentication tokens.
-     *
-     * This method checks if cached tokens are available and valid. If so, it returns
-     * the cached tokens. Otherwise, it generates new tokens using the provided API keys
-     * and caches them. The tokens are fetched from the server using a POST request.
-     *
-     * The method also handles validation of root and API tokens, throwing errors if
-     * any of the tokens are invalid. Cached tokens are considered valid for 5 minutes.
-     *
-     * @returns {Promise<TokensResponse|undefined>} A promise that resolves to the tokens response
-     * if successful, or undefined if no tokens are available.
-     * @throws Will throw an error if token validation fails, or if there is an issue
-     * with the token retrieval process.
-     */
-    async getTokens() {
-        if (DymoAPI.tokensResponse && DymoAPI.tokensVerified) {
-            console.log(`[${config.lib.name}] Using cached tokens response.`);
-            return DymoAPI.tokensResponse;
-        }
-        const tokens = {};
-        if (this.rootApiKey)
-            tokens.root = `Bearer ${this.rootApiKey}`;
-        if (this.apiKey)
-            tokens.api = `Bearer ${this.apiKey}`;
-        try {
-            if (Object.keys(tokens).length === 0)
-                return;
-            const response = await axios.post(`${BASE_URL}/v1/dvr/tokens`, { tokens });
-            if (tokens.root && response.data.root === false)
-                throw customError(3000, "Invalid root token.");
-            if (tokens.api && response.data.api === false)
-                throw customError(3000, "Invalid API token.");
-            DymoAPI.tokensResponse = response.data;
-            DymoAPI.tokensVerified = true;
-            console.log(`[${config.lib.name}] Tokens initialized successfully.`);
-            return DymoAPI.tokensResponse;
-        }
-        catch (error) {
-            console.error(error.message);
-            throw new Error(error.message);
-        }
-    }
-    /**
-     * Initializes the tokens response by calling getTokens().
-     *
-     * This method is called in the constructor and will throw an error if the
-     * initialization process fails.
-     *
-     * @throws Will throw an error if there is an issue with the token retrieval
-     * process.
-     */
-    async initializeTokens() {
-        try {
-            await this.getTokens();
-        }
-        catch (error) {
-            console.error(`Error initializing tokens: ${error.message}`);
-        }
     }
     /**
      * Checks for updates and logs a message if a new version is available.
@@ -111,7 +46,7 @@ class DymoAPI {
             await checkForUpdates();
         }
         catch (error) {
-            console.error(`Error checking the latest version in npmjs: ${error.message}`);
+            console.error(`[${config.lib.name}] Error checking the latest version in npmjs: ${error.message}`);
         }
     }
     // FUNCTIONS / Private.
@@ -131,6 +66,8 @@ class DymoAPI {
      * @param {Interfaces.VerifyPlugins[]} [data.plugins] - Optional array of verification plugins to be used.
      * @returns {Promise<Interfaces.DataValidationAnalysis>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the validation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
      */
     async isValidData(data) {
         return await PrivateAPI.isValidData(this.rootApiKey || this.apiKey, data);
@@ -158,10 +95,12 @@ class DymoAPI {
      * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
      * @returns {Promise<Interfaces.EmailStatus>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the email sending process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/sender-send-email/getting-started)
      */
     async sendEmail(data) {
         if (!this.serverEmailConfig && !this.rootApiKey)
-            console.error("You must configure the email client settings.");
+            console.error(`[${config.lib.name}] You must configure the email client settings.`);
         return await PrivateAPI.sendEmail(this.rootApiKey || this.apiKey, { serverEmailConfig: this.serverEmailConfig, ...data });
     }
     /**
@@ -176,6 +115,8 @@ class DymoAPI {
      * @param {number} [data.quantity] - The number of random values to generate. Defaults to 1 if not provided.
      * @returns {Promise<Interfaces.SRNSummary>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the random number generation process.
+     *
+     * [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);
@@ -192,6 +133,8 @@ class DymoAPI {
      * @param {number} data.lon - The longitude of the location.
      * @returns {Promise<Interfaces.CountryPrayerTimes | { error: string }>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the prayer times retrieval process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/prayertimes)
      */
     async getPrayerTimes(data) {
         return await PublicAPI.getPrayerTimes(data);
@@ -204,6 +147,8 @@ class DymoAPI {
      * @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 satinizer(data) {
         return await PublicAPI.satinizer(data);
@@ -230,11 +175,11 @@ class DymoAPI {
      * @param {string | string[]} [data.bannedWords] - The list of banned words that the password must not contain.
      * @returns {Promise<Interfaces.PasswordValidationResult>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the password validation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/password-validator)
      */
     async isValidPwd(data) {
         return await PublicAPI.isValidPwd(data);
     }
 }
-DymoAPI.tokensResponse = null;
-DymoAPI.tokensVerified = false;
 export default DymoAPI;

package/dist/esm/lib/interfaces.js

@@ -5,4 +5,5 @@
 ;
 ;
 ;
+;
 export {};

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

@@ -25,7 +25,9 @@ export declare const isValidData: (token: string | null, data: Interfaces.Valida
  *         if the 'react' field is not a valid React element, if the 'attachments' field exceeds the maximum allowed size of 40 MB,
  *         or if an error occurs during the sending request.
  */
-export declare const sendEmail: (token: string | null, data: Interfaces.SendEmail) => Promise<any>;
+export declare const sendEmail: (token: string | null, data: Interfaces.SendEmail & {
+    serverEmailConfig: Interfaces.ServerEmailConfig | undefined;
+}) => Promise<any>;
 /**
  * Retrieves a random number within a specified range using a secure endpoint.
  *

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

@@ -1,25 +1,9 @@
 import * as Interfaces from "./lib/interfaces";
-interface ServerEmailConfig {
-    host: string;
-    port: number;
-    secure: boolean;
-    auth: {
-        user: string;
-        pass: string;
-    };
-    dkim?: {
-        domainName: string;
-        keySelector: string;
-        privateKey: string;
-    };
-}
 declare class DymoAPI {
     private rootApiKey;
     private apiKey;
     private serverEmailConfig?;
     private local;
-    private static tokensResponse;
-    private static tokensVerified;
     /**
      * @param {Object} options - Options to create the DymoAPI instance.
      * @param {string} [options.rootApiKey] - The root API key.
@@ -42,34 +26,8 @@ declare class DymoAPI {
         rootApiKey?: string | null;
         apiKey?: string | null;
         local?: boolean;
-        serverEmailConfig?: ServerEmailConfig;
+        serverEmailConfig?: Interfaces.ServerEmailConfig;
     });
-    /**
-     * Retrieves and caches authentication tokens.
-     *
-     * This method checks if cached tokens are available and valid. If so, it returns
-     * the cached tokens. Otherwise, it generates new tokens using the provided API keys
-     * and caches them. The tokens are fetched from the server using a POST request.
-     *
-     * The method also handles validation of root and API tokens, throwing errors if
-     * any of the tokens are invalid. Cached tokens are considered valid for 5 minutes.
-     *
-     * @returns {Promise<TokensResponse|undefined>} A promise that resolves to the tokens response
-     * if successful, or undefined if no tokens are available.
-     * @throws Will throw an error if token validation fails, or if there is an issue
-     * with the token retrieval process.
-     */
-    private getTokens;
-    /**
-     * Initializes the tokens response by calling getTokens().
-     *
-     * This method is called in the constructor and will throw an error if the
-     * initialization process fails.
-     *
-     * @throws Will throw an error if there is an issue with the token retrieval
-     * process.
-     */
-    private initializeTokens;
     /**
      * Checks for updates and logs a message if a new version is available.
      *
@@ -96,6 +54,8 @@ declare class DymoAPI {
      * @param {Interfaces.VerifyPlugins[]} [data.plugins] - Optional array of verification plugins to be used.
      * @returns {Promise<Interfaces.DataValidationAnalysis>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the validation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
      */
     isValidData(data: Interfaces.Validator): Promise<Interfaces.DataValidationAnalysis>;
     /**
@@ -121,8 +81,10 @@ declare class DymoAPI {
      * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
      * @returns {Promise<Interfaces.EmailStatus>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the email sending process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/sender-send-email/getting-started)
      */
-    sendEmail(data: any): Promise<Interfaces.EmailStatus>;
+    sendEmail(data: Interfaces.SendEmail): Promise<Interfaces.EmailStatus>;
     /**
      * Generates a random number between the provided min and max values.
      *
@@ -135,6 +97,8 @@ declare class DymoAPI {
      * @param {number} [data.quantity] - The number of random values to generate. Defaults to 1 if not provided.
      * @returns {Promise<Interfaces.SRNSummary>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the random number generation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/secure-random-number-generator)
      */
     getRandom(data: Interfaces.SRNG): Promise<Interfaces.SRNSummary>;
     /**
@@ -148,6 +112,8 @@ declare class DymoAPI {
      * @param {number} data.lon - The longitude of the location.
      * @returns {Promise<Interfaces.CountryPrayerTimes | { error: string }>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the prayer times retrieval process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/prayertimes)
      */
     getPrayerTimes(data: Interfaces.PrayerTimesData): Promise<Interfaces.CountryPrayerTimes | {
         error: string;
@@ -160,6 +126,8 @@ declare class DymoAPI {
      * @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)
      */
     satinizer(data: Interfaces.InputSatinizerData): Promise<Interfaces.SatinizedInputAnalysis>;
     /**
@@ -184,6 +152,8 @@ declare class DymoAPI {
      * @param {string | string[]} [data.bannedWords] - The list of banned words that the password must not contain.
      * @returns {Promise<Interfaces.PasswordValidationResult>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the password validation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/password-validator)
      */
     isValidPwd(data: Interfaces.IsValidPwdData): Promise<Interfaces.PasswordValidationResult>;
 }

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

@@ -8,7 +8,7 @@ export interface CreditCardData {
     cvc?: string | number;
     cvv?: string | number;
 }
-export type VerifyPlugins = "compromiseDetector" | "nsfw" | "reputation" | "torNetwork" | "typosquatting" | "urlShortener";
+export type VerifyPlugins = "blocklist" | "compromiseDetector" | "nsfw" | "reputation" | "torNetwork" | "typosquatting" | "urlShortener";
 export interface Validator {
     email?: string;
     phone?: PhoneData;
@@ -29,6 +29,20 @@ export type Attachment = {
     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 interface SendEmail {
     from: string;
     to: string;
@@ -158,6 +172,7 @@ export interface DataValidationAnalysis {
         domain: string;
         roleAccount: boolean;
         plugins: {
+            blocklist?: boolean;
             compromiseDetector?: boolean;
             nsfw?: boolean;
             reputation?: "low" | "medium" | "high" | "very-high" | "education" | "governmental" | "unknown";
@@ -174,7 +189,9 @@ export interface DataValidationAnalysis {
         number: string;
         country: string;
         countryCode: string;
-        plugins: {};
+        plugins: {
+            blocklist?: boolean;
+        };
     };
     domain: {
         valid: boolean;
@@ -183,6 +200,7 @@ export interface DataValidationAnalysis {
         customTLD: boolean;
         domain: string;
         plugins: {
+            blocklist?: boolean;
             compromiseDetector?: boolean;
             nsfw?: boolean;
             reputation?: "low" | "medium" | "high" | "very-high" | "education" | "governmental" | "unknown";
@@ -197,7 +215,9 @@ export interface DataValidationAnalysis {
         test: boolean;
         type: string;
         creditCard: string;
-        plugins: {};
+        plugins: {
+            blocklist?: boolean;
+        };
     };
     ip: {
         valid: boolean;
@@ -226,7 +246,9 @@ export interface DataValidationAnalysis {
         mobile: boolean;
         proxy: boolean;
         hosting: boolean;
-        plugins: {};
+        plugins: {
+            blocklist?: boolean;
+        };
     };
     wallet: {
         valid: boolean;
@@ -234,6 +256,7 @@ export interface DataValidationAnalysis {
         wallet: string;
         type: "Bitcoin" | "Bitcoin (Bech32)" | "Ethereum" | "Litecoin" | "Cardano" | "Binance Smart Chain";
         plugins: {
+            blocklist?: boolean;
             torNetwork?: boolean;
         };
     };

package/package.json

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