dymo-api 1.0.80 → 1.0.81

package/dist/cjs/branches/public.cjs

@@ -36,16 +36,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.newURLEncrypt = exports.isValidPwd = exports.satinizer = exports.getPrayerTimes = void 0;
+exports.isValidPwd = exports.satinizer = exports.getPrayerTimes = void 0;
 const axios_1 = __importDefault(require("axios"));
 const config_1 = __importStar(require("../config/index.cjs"));
 const customError = (code, message) => {
     return Object.assign(new Error(), { code, message: `[${config_1.default.lib.name}] ${message}` });
 };
-;
-;
-;
-;
 const getPrayerTimes = async (data) => {
     const { lat, lon } = data;
     if (lat === undefined || lon === undefined)
@@ -108,16 +104,3 @@ const isValidPwd = async (data) => {
     }
 };
 exports.isValidPwd = isValidPwd;
-const newURLEncrypt = async (data) => {
-    const { url } = data;
-    if (url === undefined || (!url.startsWith("https://") && !url.startsWith("http://")))
-        throw customError(1500, "You must provide a valid url.");
-    try {
-        const response = await axios_1.default.get(`${config_1.BASE_URL}/v1/public/url-encrypt`, { params: data });
-        return response.data;
-    }
-    catch (error) {
-        throw customError(5000, error.response?.data?.message || error.message);
-    }
-};
-exports.newURLEncrypt = newURLEncrypt;

package/dist/cjs/dymo-api.cjs

@@ -73,8 +73,7 @@ class DymoAPI {
         this.local = rootApiKey ? local : false; // Only allow setting local if rootApiKey is defined.
         (0, config_1.setBaseUrl)(this.local);
         this.autoupdate();
-        if (!DymoAPI.tokensVerified)
-            this.initializeTokens();
+        this.initializeTokens(); // Calls the function to obtain tokens when creating the object.
     }
     /**
      * Retrieves and caches authentication tokens.
@@ -86,17 +85,21 @@ class DymoAPI {
      * 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<Object|undefined>} A promise that resolves to the tokens response
+     * @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.
      */
-    static async getTokens(rootApiKey, apiKey) {
+    async getTokens() {
+        if (DymoAPI.tokensResponse && DymoAPI.tokensVerified) {
+            console.log(`[${config_1.default.lib.name}] Using cached tokens response.`);
+            return DymoAPI.tokensResponse;
+        }
         const tokens = {};
-        if (rootApiKey)
-            tokens.root = `Bearer ${rootApiKey}`;
-        if (apiKey)
-            tokens.api = `Bearer ${apiKey}`;
+        if (this.rootApiKey)
+            tokens.root = `Bearer ${this.rootApiKey}`;
+        if (this.apiKey)
+            tokens.api = `Bearer ${this.apiKey}`;
         try {
             if (Object.keys(tokens).length === 0)
                 return;
@@ -111,7 +114,8 @@ class DymoAPI {
             return DymoAPI.tokensResponse;
         }
         catch (error) {
-            throw customError(5000, error.message);
+            console.error(error.message);
+            throw new Error(error.message);
         }
     }
     /**
@@ -125,13 +129,10 @@ class DymoAPI {
      */
     async initializeTokens() {
         try {
-            if (!DymoAPI.tokensVerified)
-                await DymoAPI.getTokens(this.rootApiKey, this.apiKey);
-            else
-                console.log(`[${config_1.default.lib.name}] Tokens already verified.`);
+            await this.getTokens();
         }
         catch (error) {
-            throw customError(5000, `Error initializing tokens: ${error.message}`);
+            console.error(`Error initializing tokens: ${error.message}`);
         }
     }
     /**
@@ -148,7 +149,7 @@ class DymoAPI {
             await (0, autoupdate_1.checkForUpdates)();
         }
         catch (error) {
-            throw customError(5000, `Error checking the latest version in npmjs: ${error.message}`);
+            console.error(`Error checking the latest version in npmjs: ${error.message}`);
         }
     }
     // FUNCTIONS / Private.
@@ -159,7 +160,14 @@ class DymoAPI {
      * If neither is set, it will throw an error.
      *
      * @param {Object} data - The data to be validated.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @param {string} [data.email] - Optional email address to be validated.
+     * @param {Interfaces.PhoneData} [data.phone] - Optional phone number data to be validated.
+     * @param {string} [data.domain] - Optional domain name to be validated.
+     * @param {string|Interfaces.CreditCardData} [data.creditCard] - Optional credit card number or data to be validated.
+     * @param {string} [data.ip] - Optional IP address to be validated.
+     * @param {string} [data.wallet] - Optional wallet address to be validated.
+     * @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.
      */
     async isValidData(data) {
@@ -186,12 +194,12 @@ class DymoAPI {
      * @param {string} [data.attachments[].path] - The path or URL of the attached file. Either this or `content` must be provided.
      * @param {Buffer} [data.attachments[].content] - The content of the attached file as a Buffer. Either this or `path` must be provided.
      * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async sendEmail(data) {
         if (!this.serverEmailConfig && !this.rootApiKey)
-            throw customError(5000, "You must configure the email client settings.");
+            console.error("You must configure the email client settings.");
         return await PrivateAPI.sendEmail(this.rootApiKey || this.apiKey, { serverEmailConfig: this.serverEmailConfig, ...data });
     }
     /**
@@ -200,10 +208,11 @@ class DymoAPI {
      * 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} data - The data to be sent.
+     * @param {Interfaces.SRNG} data - The data to be sent.
      * @param {number} data.min - The minimum value of the range.
      * @param {number} data.max - The maximum value of the range.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async getRandom(data) {
@@ -219,7 +228,7 @@ class DymoAPI {
      * @param {Object} data - The data to be sent.
      * @param {number} data.lat - The latitude of the location.
      * @param {number} data.lon - The longitude of the location.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async getPrayerTimes(data) {
@@ -231,7 +240,7 @@ class DymoAPI {
      *
      * @param {Object} data - The data to be sent.
      * @param {string} data.input - The input to be satinized.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async satinizer(data) {
@@ -252,27 +261,18 @@ class DymoAPI {
      *  - The password must not contain any of the given banned words.
      *
      * @param {Object} data - The data to be sent.
+     * @param {number} [data.min] - Minimum length of the password. Defaults to 8 if not provided.
+     * @param {number} [data.max] - Maximum length of the password. Defaults to 32 if not provided.
+     * @param {string} [data.email] - Optional email associated with the password.
      * @param {string} data.password - The password to be validated.
-     * @param {string[]} [data.bannedWords] - The list of banned words that the password must not contain.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async isValidPwd(data) {
         return await PublicAPI.isValidPwd(data);
     }
-    /**
-     * Encrypts a URL using the configured encryption settings.
-     *
-     * This method requires the URL to be provided in the data object.
-     * If the URL is not provided, it will throw an error.
-     *
-     * @param {Object} data - The data to be sent.
-     * @param {string} data.url - The URL to be encrypted.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the URL encryption process.
-     */
-    async newURLEncrypt(data) {
-        return await PublicAPI.newURLEncrypt(data);
-    }
 }
+DymoAPI.tokensResponse = null;
+DymoAPI.tokensVerified = false;
 exports.default = DymoAPI;

package/dist/cjs/lib/interfaces.cjs

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

package/dist/esm/branches/public.js

@@ -3,10 +3,6 @@ import config, { BASE_URL } from "../config/index.js";
 const customError = (code, message) => {
     return Object.assign(new Error(), { code, message: `[${config.lib.name}] ${message}` });
 };
-;
-;
-;
-;
 export const getPrayerTimes = async (data) => {
     const { lat, lon } = data;
     if (lat === undefined || lon === undefined)
@@ -66,15 +62,3 @@ export const isValidPwd = async (data) => {
         throw customError(5000, error.response?.data?.message || error.message);
     }
 };
-export const newURLEncrypt = async (data) => {
-    const { url } = data;
-    if (url === undefined || (!url.startsWith("https://") && !url.startsWith("http://")))
-        throw customError(1500, "You must provide a valid url.");
-    try {
-        const response = await axios.get(`${BASE_URL}/v1/public/url-encrypt`, { params: data });
-        return response.data;
-    }
-    catch (error) {
-        throw customError(5000, error.response?.data?.message || error.message);
-    }
-};

package/dist/esm/dymo-api.js

@@ -35,8 +35,7 @@ class DymoAPI {
         this.local = rootApiKey ? local : false; // Only allow setting local if rootApiKey is defined.
         setBaseUrl(this.local);
         this.autoupdate();
-        if (!DymoAPI.tokensVerified)
-            this.initializeTokens();
+        this.initializeTokens(); // Calls the function to obtain tokens when creating the object.
     }
     /**
      * Retrieves and caches authentication tokens.
@@ -48,17 +47,21 @@ class DymoAPI {
      * 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<Object|undefined>} A promise that resolves to the tokens response
+     * @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.
      */
-    static async getTokens(rootApiKey, apiKey) {
+    async getTokens() {
+        if (DymoAPI.tokensResponse && DymoAPI.tokensVerified) {
+            console.log(`[${config.lib.name}] Using cached tokens response.`);
+            return DymoAPI.tokensResponse;
+        }
         const tokens = {};
-        if (rootApiKey)
-            tokens.root = `Bearer ${rootApiKey}`;
-        if (apiKey)
-            tokens.api = `Bearer ${apiKey}`;
+        if (this.rootApiKey)
+            tokens.root = `Bearer ${this.rootApiKey}`;
+        if (this.apiKey)
+            tokens.api = `Bearer ${this.apiKey}`;
         try {
             if (Object.keys(tokens).length === 0)
                 return;
@@ -73,7 +76,8 @@ class DymoAPI {
             return DymoAPI.tokensResponse;
         }
         catch (error) {
-            throw customError(5000, error.message);
+            console.error(error.message);
+            throw new Error(error.message);
         }
     }
     /**
@@ -87,13 +91,10 @@ class DymoAPI {
      */
     async initializeTokens() {
         try {
-            if (!DymoAPI.tokensVerified)
-                await DymoAPI.getTokens(this.rootApiKey, this.apiKey);
-            else
-                console.log(`[${config.lib.name}] Tokens already verified.`);
+            await this.getTokens();
         }
         catch (error) {
-            throw customError(5000, `Error initializing tokens: ${error.message}`);
+            console.error(`Error initializing tokens: ${error.message}`);
         }
     }
     /**
@@ -110,7 +111,7 @@ class DymoAPI {
             await checkForUpdates();
         }
         catch (error) {
-            throw customError(5000, `Error checking the latest version in npmjs: ${error.message}`);
+            console.error(`Error checking the latest version in npmjs: ${error.message}`);
         }
     }
     // FUNCTIONS / Private.
@@ -121,7 +122,14 @@ class DymoAPI {
      * If neither is set, it will throw an error.
      *
      * @param {Object} data - The data to be validated.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @param {string} [data.email] - Optional email address to be validated.
+     * @param {Interfaces.PhoneData} [data.phone] - Optional phone number data to be validated.
+     * @param {string} [data.domain] - Optional domain name to be validated.
+     * @param {string|Interfaces.CreditCardData} [data.creditCard] - Optional credit card number or data to be validated.
+     * @param {string} [data.ip] - Optional IP address to be validated.
+     * @param {string} [data.wallet] - Optional wallet address to be validated.
+     * @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.
      */
     async isValidData(data) {
@@ -148,12 +156,12 @@ class DymoAPI {
      * @param {string} [data.attachments[].path] - The path or URL of the attached file. Either this or `content` must be provided.
      * @param {Buffer} [data.attachments[].content] - The content of the attached file as a Buffer. Either this or `path` must be provided.
      * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async sendEmail(data) {
         if (!this.serverEmailConfig && !this.rootApiKey)
-            throw customError(5000, "You must configure the email client settings.");
+            console.error("You must configure the email client settings.");
         return await PrivateAPI.sendEmail(this.rootApiKey || this.apiKey, { serverEmailConfig: this.serverEmailConfig, ...data });
     }
     /**
@@ -162,10 +170,11 @@ class DymoAPI {
      * 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} data - The data to be sent.
+     * @param {Interfaces.SRNG} data - The data to be sent.
      * @param {number} data.min - The minimum value of the range.
      * @param {number} data.max - The maximum value of the range.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async getRandom(data) {
@@ -181,7 +190,7 @@ class DymoAPI {
      * @param {Object} data - The data to be sent.
      * @param {number} data.lat - The latitude of the location.
      * @param {number} data.lon - The longitude of the location.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async getPrayerTimes(data) {
@@ -193,7 +202,7 @@ class DymoAPI {
      *
      * @param {Object} data - The data to be sent.
      * @param {string} data.input - The input to be satinized.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async satinizer(data) {
@@ -214,27 +223,18 @@ class DymoAPI {
      *  - The password must not contain any of the given banned words.
      *
      * @param {Object} data - The data to be sent.
+     * @param {number} [data.min] - Minimum length of the password. Defaults to 8 if not provided.
+     * @param {number} [data.max] - Maximum length of the password. Defaults to 32 if not provided.
+     * @param {string} [data.email] - Optional email associated with the password.
      * @param {string} data.password - The password to be validated.
-     * @param {string[]} [data.bannedWords] - The list of banned words that the password must not contain.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
     async isValidPwd(data) {
         return await PublicAPI.isValidPwd(data);
     }
-    /**
-     * Encrypts a URL using the configured encryption settings.
-     *
-     * This method requires the URL to be provided in the data object.
-     * If the URL is not provided, it will throw an error.
-     *
-     * @param {Object} data - The data to be sent.
-     * @param {string} data.url - The URL to be encrypted.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the URL encryption process.
-     */
-    async newURLEncrypt(data) {
-        return await PublicAPI.newURLEncrypt(data);
-    }
 }
+DymoAPI.tokensResponse = null;
+DymoAPI.tokensVerified = false;
 export default DymoAPI;

package/dist/esm/lib/interfaces.js

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

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

@@ -1,22 +1,4 @@
-interface PrayerTimesData {
-    lat?: number;
-    lon?: number;
-}
-interface InputSatinizerData {
-    input?: string;
-}
-interface IsValidPwdData {
-    email?: string;
-    password?: string;
-    bannedWords?: string | string[];
-    min?: number;
-    max?: number;
-}
-interface NewURLEncryptData {
-    url?: string;
-}
-export declare const getPrayerTimes: (data: PrayerTimesData) => Promise<any>;
-export declare const satinizer: (data: InputSatinizerData) => Promise<any>;
-export declare const isValidPwd: (data: IsValidPwdData) => Promise<any>;
-export declare const newURLEncrypt: (data: NewURLEncryptData) => Promise<any>;
-export {};
+import * as Interfaces from "../lib/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,3 +1,4 @@
+import * as Interfaces from "./lib/interfaces";
 interface ServerEmailConfig {
     host: string;
     port: number;
@@ -15,10 +16,10 @@ interface ServerEmailConfig {
 declare class DymoAPI {
     private rootApiKey;
     private apiKey;
-    private static tokensResponse;
-    private static tokensVerified;
     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.
@@ -53,12 +54,12 @@ declare class DymoAPI {
      * 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<Object|undefined>} A promise that resolves to the tokens response
+     * @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 static getTokens;
+    private getTokens;
     /**
      * Initializes the tokens response by calling getTokens().
      *
@@ -86,10 +87,17 @@ declare class DymoAPI {
      * If neither is set, it will throw an error.
      *
      * @param {Object} data - The data to be validated.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @param {string} [data.email] - Optional email address to be validated.
+     * @param {Interfaces.PhoneData} [data.phone] - Optional phone number data to be validated.
+     * @param {string} [data.domain] - Optional domain name to be validated.
+     * @param {string|Interfaces.CreditCardData} [data.creditCard] - Optional credit card number or data to be validated.
+     * @param {string} [data.ip] - Optional IP address to be validated.
+     * @param {string} [data.wallet] - Optional wallet address to be validated.
+     * @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.
      */
-    isValidData(data: any): Promise<any>;
+    isValidData(data: Interfaces.Validator): Promise<Interfaces.DataValidationAnalysis>;
     /**
      * Sends an email using the configured email client settings.
      *
@@ -111,23 +119,24 @@ declare class DymoAPI {
      * @param {string} [data.attachments[].path] - The path or URL of the attached file. Either this or `content` must be provided.
      * @param {Buffer} [data.attachments[].content] - The content of the attached file as a Buffer. Either this or `path` must be provided.
      * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
-    sendEmail(data: any): Promise<any>;
+    sendEmail(data: any): Promise<Interfaces.EmailStatus>;
     /**
      * Generates a random number between the provided min and max values.
      *
      * 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} data - The data to be sent.
+     * @param {Interfaces.SRNG} data - The data to be sent.
      * @param {number} data.min - The minimum value of the range.
      * @param {number} data.max - The maximum value of the range.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
-    getRandom(data: any): Promise<any>;
+    getRandom(data: Interfaces.SRNG): Promise<Interfaces.SRNSummary>;
     /**
      * Retrieves the prayer times for the given location.
      *
@@ -137,20 +146,22 @@ declare class DymoAPI {
      * @param {Object} data - The data to be sent.
      * @param {number} data.lat - The latitude of the location.
      * @param {number} data.lon - The longitude of the location.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
-    getPrayerTimes(data: any): Promise<any>;
+    getPrayerTimes(data: Interfaces.PrayerTimesData): Promise<Interfaces.CountryPrayerTimes | {
+        error: string;
+    }>;
     /**
      * 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<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
-    satinizer(data: any): Promise<any>;
+    satinizer(data: Interfaces.InputSatinizerData): Promise<Interfaces.SatinizedInputAnalysis>;
     /**
      * Validates a password based on the given parameters.
      *
@@ -166,23 +177,14 @@ declare class DymoAPI {
      *  - The password must not contain any of the given banned words.
      *
      * @param {Object} data - The data to be sent.
+     * @param {number} [data.min] - Minimum length of the password. Defaults to 8 if not provided.
+     * @param {number} [data.max] - Maximum length of the password. Defaults to 32 if not provided.
+     * @param {string} [data.email] - Optional email associated with the password.
      * @param {string} data.password - The password to be validated.
-     * @param {string[]} [data.bannedWords] - The list of banned words that the password must not contain.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
+     * @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.
      */
-    isValidPwd(data: any): Promise<any>;
-    /**
-     * Encrypts a URL using the configured encryption settings.
-     *
-     * This method requires the URL to be provided in the data object.
-     * If the URL is not provided, it will throw an error.
-     *
-     * @param {Object} data - The data to be sent.
-     * @param {string} data.url - The URL to be encrypted.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the URL encryption process.
-     */
-    newURLEncrypt(data: any): Promise<any>;
+    isValidPwd(data: Interfaces.IsValidPwdData): Promise<Interfaces.PasswordValidationResult>;
 }
 export default DymoAPI;

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

@@ -1,13 +1,14 @@
-interface PhoneData {
+export interface PhoneData {
     iso: any;
     phone: string;
 }
-interface CreditCardData {
+export interface CreditCardData {
     pan: string | number;
     expirationDate?: string;
     cvc?: string | number;
     cvv?: string | number;
 }
+export type VerifyPlugins = "compromiseDetector" | "nsfw" | "reputation" | "torNetwork" | "typosquatting" | "urlShortener";
 export interface Validator {
     email?: string;
     phone?: PhoneData;
@@ -15,6 +16,7 @@ export interface Validator {
     creditCard?: string | CreditCardData;
     ip?: string;
     wallet?: string;
+    plugins?: VerifyPlugins[];
 }
 export interface SRNG {
     min: number;
@@ -37,7 +39,186 @@ export interface SendEmail {
         priority?: "high" | "normal" | "low" | undefined;
         composeTailwindClasses?: boolean;
         compileToCssSafe?: boolean;
+        onlyVerifiedEmails?: boolean;
     };
     attachments?: Attachment[];
 }
-export {};
+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 {
+    email: {
+        valid: boolean;
+        fraud: boolean;
+        proxiedEmail: boolean;
+        freeSubdomain: boolean;
+        corporate: boolean;
+        email: string;
+        realUser: string;
+        didYouMean: string | null;
+        customTLD: boolean;
+        domain: string;
+        roleAccount: boolean;
+        plugins: {};
+    };
+    phone: {
+        valid: boolean;
+        fraud: boolean;
+        phone: string;
+        prefix: string;
+        number: string;
+        country: string;
+        countryCode: string;
+        plugins: {};
+    };
+    domain: {
+        valid: boolean;
+        fraud: boolean;
+        freeSubdomain: boolean;
+        customTLD: boolean;
+        domain: string;
+        plugins: {};
+    };
+    creditCard: {
+        valid: boolean;
+        fraud: boolean;
+        test: boolean;
+        type: string;
+        creditCard: string;
+        plugins: {};
+    };
+    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: {};
+    };
+    wallet: {
+        valid: boolean;
+        fraud: boolean;
+        wallet: string;
+        type: "Bitcoin" | "Bitcoin (Bech32)" | "Ethereum" | "Litecoin" | "Cardano" | "Binance Smart Chain";
+        plugins: {};
+    };
+}

package/package.json

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