dymo-api 1.0.55 → 1.0.57

package/dist/cjs/branches/private.js

@@ -31,7 +31,7 @@ const path_1 = __importDefault(require("path"));
 const axios_1 = __importDefault(require("axios"));
 const react_1 = __importDefault(require("react"));
 const promises_1 = __importDefault(require("fs/promises"));
-const { twi } = require("tw-to-css");
+const tw_to_css_1 = require("tw-to-css");
 const config_1 = __importStar(require("../config"));
 const render_1 = require("@react-email/render");
 const customError = (code, message) => {
@@ -39,7 +39,7 @@ const customError = (code, message) => {
 };
 const convertTailwindToInlineCss = (htmlContent) => {
     return htmlContent.replace(/class="([^"]+)"/g, (match, classList) => {
-        return match.replace("class", "style").replace(classList, twi(classList, { minify: true, merge: true }));
+        return match.replace("class", "style").replace(classList, (0, tw_to_css_1.twi)(classList, { minify: true, merge: true }));
     });
 };
 /**

package/dist/cjs/dymo-api.js

@@ -269,3 +269,4 @@ class DymoAPI {
         return await PublicAPI.newURLEncrypt(data);
     }
 }
+exports.default = DymoAPI;

package/dist/esm/branches/private.js

@@ -1,41 +1,12 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRandom = exports.sendEmail = exports.isValidData = void 0;
-const path_1 = __importDefault(require("path"));
-const axios_1 = __importDefault(require("axios"));
-const react_1 = __importDefault(require("react"));
-const promises_1 = __importDefault(require("fs/promises"));
-const { twi } = require("tw-to-css");
-const config_1 = __importStar(require("../config"));
-const render_1 = require("@react-email/render");
+import path from "path";
+import axios from "axios";
+import React from "react";
+import fs from "fs/promises";
+import { twi } from "tw-to-css";
+import config, { BASE_URL } from "../config";
+import { render } from "@react-email/render";
 const customError = (code, message) => {
-    return Object.assign(new Error(), { code, message: `[${config_1.default.lib.name}] ${message}` });
+    return Object.assign(new Error(), { code, message: `[${config.lib.name}] ${message}` });
 };
 const convertTailwindToInlineCss = (htmlContent) => {
     return htmlContent.replace(/class="([^"]+)"/g, (match, classList) => {
@@ -54,20 +25,19 @@ const convertTailwindToInlineCss = (htmlContent) => {
  * @throws Will throw an error if the token is null, if none of the required fields are present in the data,
  *         or if an error occurs during the verification request.
  */
-const isValidData = async (token, data) => {
+export const isValidData = async (token, data) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");
     if (!Object.keys(data).some((key) => ["email", "phone", "domain", "creditCard", "ip", "wallet"].includes(key) && data.hasOwnProperty(key)))
         throw customError(1500, "You must provide at least one parameter.");
     try {
-        const response = await axios_1.default.post(`${config_1.BASE_URL}/v1/private/secure/verify`, data, { headers: { "Authorization": token } });
+        const response = await axios.post(`${BASE_URL}/v1/private/secure/verify`, data, { headers: { "Authorization": token } });
         return response.data;
     }
     catch (error) {
         throw customError(5000, error.response?.data?.message || error.message);
     }
 };
-exports.isValidData = isValidData;
 /**
  * Sends an email using a secure sending endpoint.
  *
@@ -81,7 +51,7 @@ exports.isValidData = isValidData;
  *         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.
  */
-const sendEmail = async (token, data) => {
+export const sendEmail = async (token, data) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");
     if (!data.from)
@@ -90,14 +60,14 @@ const sendEmail = async (token, data) => {
         throw customError(1500, "You must provide an email to be sent to.");
     if (!data.subject)
         throw customError(1500, "You must provide a subject for the email to be sent.");
-    if (!data.html && !data.react && !react_1.default.isValidElement(data.react))
+    if (!data.html && !data.react && !React.isValidElement(data.react))
         throw customError(1500, "You must provide HTML or a React component.");
     if (data.html && data.react)
         throw customError(1500, "You must provide only HTML or a React component, not both.");
     try {
         if (data.react) {
             //@ts-ignore
-            data.html = await (0, render_1.render)(data.react);
+            data.html = await render(data.react);
             delete data.react;
         }
         if (data.options && data.options.composeTailwindClasses) {
@@ -116,28 +86,27 @@ const sendEmail = async (token, data) => {
                     throw customError(1500, "You must provide either 'path' or 'content', not both.");
                 let contentBuffer;
                 if (attachment.path)
-                    contentBuffer = await promises_1.default.readFile(path_1.default.resolve(attachment.path));
+                    contentBuffer = await fs.readFile(path.resolve(attachment.path));
                 else if (attachment.content)
                     contentBuffer = attachment.content instanceof Buffer ? attachment.content : Buffer.from(attachment.content);
                 totalSize += Buffer.byteLength(contentBuffer);
                 if (totalSize > 40 * 1024 * 1024)
                     throw customError(1500, "Attachments exceed the maximum allowed size of 40 MB.");
                 return {
-                    filename: attachment.filename || path_1.default.basename(attachment.path || ""),
+                    filename: attachment.filename || path.basename(attachment.path || ""),
                     content: contentBuffer,
                     cid: attachment.cid || attachment.filename
                 };
             }));
             data.attachments = processedAttachments;
         }
-        const response = await axios_1.default.post(`${config_1.BASE_URL}/v1/private/sender/sendEmail`, data, { headers: { "Authorization": token } });
+        const response = await axios.post(`${BASE_URL}/v1/private/sender/sendEmail`, data, { headers: { "Authorization": token } });
         return response.data;
     }
     catch (error) {
         throw customError(5000, error.response?.data?.message || error.message);
     }
 };
-exports.sendEmail = sendEmail;
 /**
  * Retrieves a random number within a specified range using a secure endpoint.
  *
@@ -151,7 +120,7 @@ exports.sendEmail = sendEmail;
  *         if 'min' is not less than 'max', if 'min' or 'max' are out of the allowed range,
  *         or if an error occurs during the request to the random number generator endpoint.
  */
-const getRandom = async (token, data) => {
+export const getRandom = async (token, data) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");
     if (!data.min || !data.max)
@@ -163,11 +132,10 @@ const getRandom = async (token, data) => {
     if (data.max < -1000000000 || data.max > 1000000000)
         throw customError(1500, "'max' must be an integer in the interval [-1000000000}, 1000000000].");
     try {
-        const response = await axios_1.default.post(`${config_1.BASE_URL}/v1/private/srng`, data, { headers: { "Authorization": token } });
+        const response = await axios.post(`${BASE_URL}/v1/private/srng`, data, { headers: { "Authorization": token } });
         return response.data;
     }
     catch (error) {
         throw customError(5000, error.response?.data?.message || error.message);
     }
 };
-exports.getRandom = getRandom;

package/dist/esm/branches/public.js

@@ -1,68 +1,37 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importStar(require("../config"));
+import axios from "axios";
+import config, { BASE_URL } from "../config";
 const customError = (code, message) => {
-    return Object.assign(new Error(), { code, message: `[${config_1.default.lib.name}] ${message}` });
+    return Object.assign(new Error(), { code, message: `[${config.lib.name}] ${message}` });
 };
 ;
 ;
 ;
 ;
-const getPrayerTimes = async (data) => {
+export const getPrayerTimes = async (data) => {
     const { lat, lon } = data;
     if (lat === undefined || lon === undefined)
         throw customError(1000, "You must provide a latitude and longitude.");
     try {
-        const response = await axios_1.default.get(`${config_1.BASE_URL}/v1/public/islam/prayertimes`, { params: data });
+        const response = await axios.get(`${BASE_URL}/v1/public/islam/prayertimes`, { params: data });
         return response.data;
     }
     catch (error) {
         throw customError(5000, error.response?.data?.message || error.message);
     }
 };
-exports.getPrayerTimes = getPrayerTimes;
-const satinizer = async (data) => {
+export const satinizer = async (data) => {
     const { input } = data;
     if (input === undefined)
         throw customError(1000, "You must specify at least the input.");
     try {
-        const response = await axios_1.default.get(`${config_1.BASE_URL}/v1/public/inputSatinizer`, { params: { input: encodeURIComponent(input) } });
+        const response = await axios.get(`${BASE_URL}/v1/public/inputSatinizer`, { params: { input: encodeURIComponent(input) } });
         return response.data;
     }
     catch (error) {
         throw customError(5000, error.response?.data?.message || error.message);
     }
 };
-exports.satinizer = satinizer;
-const isValidPwd = async (data) => {
+export const isValidPwd = async (data) => {
     let { email, password, bannedWords, min, max } = data;
     if (password === undefined)
         throw customError(1000, "You must specify at least the password.");
@@ -90,24 +59,22 @@ const isValidPwd = async (data) => {
     if (max !== undefined)
         params.max = max;
     try {
-        const response = await axios_1.default.get(`${config_1.BASE_URL}/v1/public/validPwd`, { params });
+        const response = await axios.get(`${BASE_URL}/v1/public/validPwd`, { params });
         return response.data;
     }
     catch (error) {
         throw customError(5000, error.response?.data?.message || error.message);
     }
 };
-exports.isValidPwd = isValidPwd;
-const newURLEncrypt = async (data) => {
+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_1.default.get(`${config_1.BASE_URL}/v1/public/url-encrypt`, { params: data });
+        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);
     }
 };
-exports.newURLEncrypt = newURLEncrypt;

package/dist/esm/config/index.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BASE_URL = exports.setBaseUrl = void 0;
 const config = {
     lib: {
         name: "Dymo API",
@@ -10,10 +7,9 @@ const config = {
         baseUrl: "https://api.tpeoficial.com"
     }
 };
-exports.default = config;
+export default config;
 let BASE_URL = config.env.baseUrl;
-exports.BASE_URL = BASE_URL;
-const setBaseUrl = (isLocal) => {
-    exports.BASE_URL = BASE_URL = isLocal ? "http://localhost:3050" : config.env.baseUrl;
+export const setBaseUrl = (isLocal) => {
+    BASE_URL = isLocal ? "http://localhost:3050" : config.env.baseUrl;
 };
-exports.setBaseUrl = setBaseUrl;
+export { BASE_URL };

package/dist/esm/dymo-api.js

@@ -1,38 +1,10 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    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"));
-const PrivateAPI = __importStar(require("./branches/private"));
-const config_1 = __importStar(require("./config"));
-const autoupdate_1 = require("./services/autoupdate");
+import axios from "axios";
+import * as PublicAPI from "./branches/public";
+import * as PrivateAPI from "./branches/private";
+import config, { BASE_URL, setBaseUrl } from "./config";
+import { checkForUpdates } from "./services/autoupdate";
 const customError = (code, message) => {
-    return Object.assign(new Error(), { code, message: `[${config_1.default.lib.name}] ${message}` });
+    return Object.assign(new Error(), { code, message: `[${config.lib.name}] ${message}` });
 };
 ;
 ;
@@ -63,7 +35,7 @@ class DymoAPI {
         this.lastFetchTime = null;
         this.serverEmailConfig = serverEmailConfig;
         this.local = rootApiKey ? local : false; // Only allow setting local if rootApiKey is defined.
-        (0, config_1.setBaseUrl)(this.local);
+        setBaseUrl(this.local);
         this.autoupdate();
         this.initializeTokens(); // Calls the function to obtain tokens when creating the object.
     }
@@ -85,7 +57,7 @@ class DymoAPI {
     async getTokens() {
         const currentTime = new Date();
         if (this.tokensResponse && this.lastFetchTime && (currentTime.getTime() - this.lastFetchTime.getTime()) < 5 * 60 * 1000) {
-            console.log(`[${config_1.default.lib.name}] Using cached tokens response.`);
+            console.log(`[${config.lib.name}] Using cached tokens response.`);
             return this.tokensResponse;
         }
         ;
@@ -97,14 +69,14 @@ class DymoAPI {
         try {
             if (Object.keys(tokens).length === 0)
                 return;
-            const response = await axios_1.default.post(`${config_1.BASE_URL}/v1/dvr/tokens`, { tokens });
+            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.");
             this.tokensResponse = response.data;
             this.lastFetchTime = currentTime;
-            console.log(`[${config_1.default.lib.name}] Tokens initialized successfully.`);
+            console.log(`[${config.lib.name}] Tokens initialized successfully.`);
             return this.tokensResponse;
         }
         catch (error) {
@@ -139,7 +111,7 @@ class DymoAPI {
      */
     async autoupdate() {
         try {
-            await (0, autoupdate_1.checkForUpdates)();
+            await checkForUpdates();
         }
         catch (error) {
             throw customError(5000, `Error checking the latest version in npmjs: ${error.message}`);
@@ -269,3 +241,4 @@ class DymoAPI {
         return await PublicAPI.newURLEncrypt(data);
     }
 }
+export default DymoAPI;

package/dist/esm/lib/interfaces.js

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

package/dist/esm/services/autoupdate.js

@@ -1,16 +1,10 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkForUpdates = checkForUpdates;
-const axios_1 = __importDefault(require("axios"));
+import axios from "axios";
 //@ts-ignore
-const child_process_1 = require("child_process");
-const localVersion = (0, child_process_1.execSync)("npm list dymo-api --depth=0").toString().match(new RegExp("dymo-api@(\\d+\\.\\d+\\.\\d+)"))?.[1] || "0.0.0";
-async function checkForUpdates() {
+import { execSync } from "child_process";
+const localVersion = execSync("npm list dymo-api --depth=0").toString().match(new RegExp("dymo-api@(\\d+\\.\\d+\\.\\d+)"))?.[1] || "0.0.0";
+export async function checkForUpdates() {
     try {
-        const response = await axios_1.default.get("https://registry.npmjs.org/dymo-api/latest");
+        const response = await axios.get("https://registry.npmjs.org/dymo-api/latest");
         const latestVersion = response.data.version;
         if (localVersion !== latestVersion)
             console.log(`[Dymo API] A new version of dymo-api is available: ${latestVersion}. You are using ${localVersion}. Consider updating.`);

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

@@ -1 +1,188 @@
-export {};
+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 tokensResponse;
+    private lastFetchTime;
+    private serverEmailConfig?;
+    private local;
+    /**
+     * @param {Object} options - Options to create the DymoAPI instance.
+     * @param {string} [options.rootApiKey] - The root API key.
+     * @param {string} [options.apiKey] - The API key.
+     * @param {boolean} [options.local] - Whether to use a local server instead of the cloud server.
+     * @param {Object} [options.serverEmailConfig] - The server email config.
+     * @description
+     * This is the main class to interact with the Dymo API. It should be
+     * instantiated with the root API key and the API key. The root API key is
+     * used to fetch the tokens and the API key is used to authenticate the
+     * requests.
+     * @example
+     * const dymoApi = new DymoAPI({
+     *     rootApiKey: "6bfb7675-6b69-4f8d-9f43-5a6f7f02c6c5",
+     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5",
+     *     local: true
+     * });
+     */
+    constructor({ rootApiKey, apiKey, local, serverEmailConfig }: {
+        rootApiKey?: string | null;
+        apiKey?: string | null;
+        local?: boolean;
+        serverEmailConfig?: 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<Object|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.
+     *
+     * This method is called in the constructor and will throw an error if the
+     * update check fails.
+     *
+     * @throws Will throw an error if there is an issue with the update check
+     * process.
+     */
+    private autoupdate;
+    /**
+     * Validates the given data against the configured validation settings.
+     *
+     * 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 validated.
+     * @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 validation process.
+     */
+    isValidData(data: any): Promise<any>;
+    /**
+     * Sends an email using the configured email client settings.
+     *
+     * This method requires either the root API key or the server email config to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Object} data - The email data to be sent.
+     * @param {string} data.from - The email address from which the email will be sent.
+     * @param {string} data.to - The email address to which the email will be sent.
+     * @param {string} data.subject - The subject of the email.
+     * @param {string} [data.html] - The HTML content of the email.
+     * @param {React.ReactElement} [data.react] - The React component to be rendered as the email content.
+     * @param {Object} [data.options] - Content configuration options.
+     * @param {"high" | "normal" | "low" | undefined} [data.options.priority="normal"] - Email priority (default: normal).
+     * @param {boolean} [data.options.waitToResponse=true] - Wait until the email is sent (default: true).
+     * @param {boolean} [data.options.composeTailwindClasses] - Whether to compose tailwind classes.
+     * @param {Attachment[]} [data.attachments] - An array of attachments to be included in the email.
+     * @param {string} data.attachments[].filename - The name of the attached file.
+     * @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.
+     * @throws Will throw an error if there is an issue with the email sending process.
+     */
+    sendEmail(data: any): Promise<any>;
+    /**
+     * 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 {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.
+     * @throws Will throw an error if there is an issue with the random number generation process.
+     */
+    getRandom(data: any): Promise<any>;
+    /**
+     * Retrieves the prayer times for the given location.
+     *
+     * This method requires a latitude and longitude to be provided in the
+     * data object. If either of these are not provided, it will throw an error.
+     *
+     * @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.
+     * @throws Will throw an error if there is an issue with the prayer times retrieval process.
+     */
+    getPrayerTimes(data: any): Promise<any>;
+    /**
+     * 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.
+     * @throws Will throw an error if there is an issue with the satinization process.
+     */
+    satinizer(data: any): Promise<any>;
+    /**
+     * Validates a password based on the given parameters.
+     *
+     * This method requires the password to be provided in the data object.
+     * If the password is not provided, it will throw an error. The method
+     * will validate the password against the following rules:
+     *  - The password must be at least 8 characters long.
+     *  - The password must be at most 32 characters long.
+     *  - The password must contain at least one uppercase letter.
+     *  - The password must contain at least one lowercase letter.
+     *  - The password must contain at least one number.
+     *  - The password must contain at least one special character.
+     *  - The password must not contain any of the given banned words.
+     *
+     * @param {Object} data - The data to be sent.
+     * @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.
+     * @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>;
+}
+export default DymoAPI;

package/package.json

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