dymo-api 1.0.42 → 1.0.44

package/dist/cjs/branches/private.js

@@ -28,22 +28,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRandom = exports.sendEmail = exports.isValidData = void 0;
 const axios_1 = __importDefault(require("axios"));
+const react_1 = __importDefault(require("react"));
+const { twi, twj } = require("tw-to-css");
 const config_1 = __importStar(require("../config"));
 const render_1 = require("@react-email/render");
 const customError = (code, message) => {
     return Object.assign(new Error(), { code, message: `[${config_1.default.lib.name}] ${message}` });
 };
+const convertTailwindToInlineCss = (htmlContent) => {
+    return htmlContent.replace(/class="([^"]+)"/g, (match, classList) => {
+        return match.replace(classList, twi(classList, { minify: true, merge: true }));
+    });
+};
+/**
+ * Validates the provided data using a secure verification endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the Validator interface, containing at least one of the following fields:
+ *               email, phone, domain, creditCard, ip, or wallet.
+ *
+ * @returns A promise that resolves to the response data from the verification endpoint.
+ *
+ * @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) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");
-    let i = false;
-    for (const key in data) {
-        if (data.hasOwnProperty(key) && (key === "email" || key === "phone" || key === "domain" || key === "creditCard" || key === "ip" || key === "wallet")) {
-            i = true;
-            break;
-        }
-    }
-    if (!i)
+    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 } });
@@ -54,6 +66,19 @@ const isValidData = async (token, data) => {
     }
 };
 exports.isValidData = isValidData;
+/**
+ * Sends an email using the configured email client settings.
+ *
+ * This method requires a valid private token to be set.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the SendEmail interface, containing the following fields:
+ *               from, to, subject, html, and optionally react and options.
+ *
+ * @returns 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.
+ */
 const sendEmail = async (token, data) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");
@@ -63,7 +88,7 @@ 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)
+    if (!data.html && !data.react && !react_1.default.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.");
@@ -73,6 +98,8 @@ const sendEmail = async (token, data) => {
             data.html = await (0, render_1.render)(data.react);
             delete data.react;
         }
+        if (data.options && data.options.composeTailwindClasses)
+            data.html = convertTailwindToInlineCss(data.html);
     }
     catch (error) {
         throw customError(1500, `An error occurred while rendering your React component. Details: ${error}`);
@@ -86,6 +113,19 @@ const sendEmail = async (token, data) => {
     }
 };
 exports.sendEmail = sendEmail;
+/**
+ * Retrieves a random number within a specified range using a secure endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the SRNG interface, containing 'min' and 'max' fields,
+ *               which define the inclusive range within which the random number should be generated.
+ *
+ * @returns A promise that resolves to the response data containing the random number.
+ *
+ * @throws Will throw an error if the token is null, if 'min' or 'max' are not defined,
+ *         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) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");

package/dist/cjs/dymo-api.js

@@ -169,8 +169,10 @@ class DymoAPI {
      * @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 {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 {boolean} [data.options.composeTailwindClasses] - Whether to compose tailwind classes.
      * @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.
      */
@@ -261,3 +263,5 @@ class DymoAPI {
     }
 }
 exports.default = DymoAPI;
+//@ts-ignore
+module.exports = DymoAPI;

package/dist/esm/branches/private.js

@@ -28,22 +28,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRandom = exports.sendEmail = exports.isValidData = void 0;
 const axios_1 = __importDefault(require("axios"));
+const react_1 = __importDefault(require("react"));
+const { twi, twj } = require("tw-to-css");
 const config_1 = __importStar(require("../config"));
 const render_1 = require("@react-email/render");
 const customError = (code, message) => {
     return Object.assign(new Error(), { code, message: `[${config_1.default.lib.name}] ${message}` });
 };
+const convertTailwindToInlineCss = (htmlContent) => {
+    return htmlContent.replace(/class="([^"]+)"/g, (match, classList) => {
+        return match.replace(classList, twi(classList, { minify: true, merge: true }));
+    });
+};
+/**
+ * Validates the provided data using a secure verification endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the Validator interface, containing at least one of the following fields:
+ *               email, phone, domain, creditCard, ip, or wallet.
+ *
+ * @returns A promise that resolves to the response data from the verification endpoint.
+ *
+ * @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) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");
-    let i = false;
-    for (const key in data) {
-        if (data.hasOwnProperty(key) && (key === "email" || key === "phone" || key === "domain" || key === "creditCard" || key === "ip" || key === "wallet")) {
-            i = true;
-            break;
-        }
-    }
-    if (!i)
+    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 } });
@@ -54,6 +66,19 @@ const isValidData = async (token, data) => {
     }
 };
 exports.isValidData = isValidData;
+/**
+ * Sends an email using the configured email client settings.
+ *
+ * This method requires a valid private token to be set.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the SendEmail interface, containing the following fields:
+ *               from, to, subject, html, and optionally react and options.
+ *
+ * @returns 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.
+ */
 const sendEmail = async (token, data) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");
@@ -63,7 +88,7 @@ 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)
+    if (!data.html && !data.react && !react_1.default.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.");
@@ -73,6 +98,8 @@ const sendEmail = async (token, data) => {
             data.html = await (0, render_1.render)(data.react);
             delete data.react;
         }
+        if (data.options && data.options.composeTailwindClasses)
+            data.html = convertTailwindToInlineCss(data.html);
     }
     catch (error) {
         throw customError(1500, `An error occurred while rendering your React component. Details: ${error}`);
@@ -86,6 +113,19 @@ const sendEmail = async (token, data) => {
     }
 };
 exports.sendEmail = sendEmail;
+/**
+ * Retrieves a random number within a specified range using a secure endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the SRNG interface, containing 'min' and 'max' fields,
+ *               which define the inclusive range within which the random number should be generated.
+ *
+ * @returns A promise that resolves to the response data containing the random number.
+ *
+ * @throws Will throw an error if the token is null, if 'min' or 'max' are not defined,
+ *         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) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");

package/dist/esm/dymo-api.js

@@ -169,8 +169,10 @@ class DymoAPI {
      * @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 {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 {boolean} [data.options.composeTailwindClasses] - Whether to compose tailwind classes.
      * @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.
      */
@@ -261,3 +263,5 @@ class DymoAPI {
     }
 }
 exports.default = DymoAPI;
+//@ts-ignore
+module.exports = DymoAPI;

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

@@ -1,4 +1,42 @@
 import * as Interfaces from "../lib/interfaces";
+/**
+ * Validates the provided data using a secure verification endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the Validator interface, containing at least one of the following fields:
+ *               email, phone, domain, creditCard, ip, or wallet.
+ *
+ * @returns A promise that resolves to the response data from the verification endpoint.
+ *
+ * @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.
+ */
 export declare const isValidData: (token: string | null, data: Interfaces.Validator) => Promise<any>;
+/**
+ * Sends an email using the configured email client settings.
+ *
+ * This method requires a valid private token to be set.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the SendEmail interface, containing the following fields:
+ *               from, to, subject, html, and optionally react and options.
+ *
+ * @returns 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.
+ */
 export declare const sendEmail: (token: string | null, data: Interfaces.SendEmail) => Promise<any>;
+/**
+ * Retrieves a random number within a specified range using a secure endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the SRNG interface, containing 'min' and 'max' fields,
+ *               which define the inclusive range within which the random number should be generated.
+ *
+ * @returns A promise that resolves to the response data containing the random number.
+ *
+ * @throws Will throw an error if the token is null, if 'min' or 'max' are not defined,
+ *         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.
+ */
 export declare const getRandom: (token: string | null, data: Interfaces.SRNG) => Promise<any>;

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

@@ -100,8 +100,10 @@ declare class DymoAPI {
      * @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 {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 {boolean} [data.options.composeTailwindClasses] - Whether to compose tailwind classes.
      * @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.
      */

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

@@ -1,4 +1,3 @@
-import type * as React from "react";
 interface PhoneData {
     iso: any;
     phone: string;
@@ -22,17 +21,14 @@ export interface SRNG {
     max: number;
     quantity?: number;
 }
-export type SendEmail = {
+export interface SendEmail {
     from: string;
     to: string;
     subject: string;
-    html: string;
+    html?: string;
     react?: never;
-} | {
-    from: string;
-    to: string;
-    subject: string;
-    html?: never;
-    react: React.ReactNode;
-};
+    options?: {
+        composeTailwindClasses?: boolean;
+    };
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.0.42",
+  "version": "1.0.44",
   "description": "Flow system for Dymo API.",
   "main": "dist/cjs/dymo-api.js",
   "module": "dist/esm/dymo-api.js",
@@ -20,7 +20,7 @@
     "build": "rimraf dist && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json",
     "start": "ts-node src/dymo-api.ts",
     "prepublishOnly": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node --max-old-space-size=4096 test/index.js"
   },
   "repository": {
     "url": "https://github.com/TPEOficial/dymo-api-node"
@@ -41,7 +41,8 @@
     "@react-email/render": "1.0.1",
     "@types/react": "^18.3.5",
     "axios": "^1.6.8",
-    "rimraf": "^6.0.1"
+    "rimraf": "^6.0.1",
+    "tw-to-css": "0.0.12"
   },
   "contributors": [
     "TPEOficial (https://github.com/TPEOficial)",
@@ -49,7 +50,7 @@
   ],
   "devDependencies": {
     "@types/axios": "^0.9.36",
-    "@types/node": "^22.0.2",
+    "@types/node": "^22.9.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4"
   }