dymo-api 1.0.15 → 1.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "Flow system for Dymo API.",
   "main": "dist/index.js",
   "type": "module",
@@ -25,6 +25,8 @@
   },
   "homepage": "https://dymo.tpeoficial.com",
   "dependencies": {
+    "@react-email/render": "1.0.1",
+    "@types/react": "^18.3.5",
     "axios": "^1.6.8"
   },
   "contributors": [

package/src/dymo-api.ts

@@ -4,8 +4,7 @@ import * as PublicAPI from "./public-api";
 import config from "./config";
 
 const customError = (code: number, message: string): Error => {
-    const error = new Error();
-    return Object.assign(error, { code, message: `[${config.lib.name}] ${message}` });
+    return Object.assign(new Error(), { code, message: `[${config.lib.name}] ${message}` });
 };
 
 interface TokensResponse {
@@ -18,17 +17,29 @@ interface Tokens {
     api?: string;
 };
 
+interface ServerEmailConfig {
+    host: string;
+    port: number;
+    secure: boolean;
+    auth: {
+        user: string;
+        pass: string;
+    };
+};
+
 class DymoAPI {
     private rootApiKey: string | null;
     private apiKey: string | null;
     private tokensResponse: TokensResponse | null;
     private lastFetchTime: Date | null;
+    private serverEmailConfig?: ServerEmailConfig;
 
-    constructor({ rootApiKey = null, apiKey = null }: { rootApiKey?: string | null; apiKey?: string | null }) {
+    constructor({ rootApiKey = null, apiKey = null, serverEmailConfig = undefined }: { rootApiKey?: string | null; apiKey?: string | null; serverEmailConfig?: ServerEmailConfig; }) {
         this.rootApiKey = rootApiKey;
         this.apiKey = apiKey;
         this.tokensResponse = null;
         this.lastFetchTime = null;
+        this.serverEmailConfig = serverEmailConfig;
         this.initializeTokens(); // Calls the function to obtain tokens when creating the object.
     }
 
@@ -70,6 +81,11 @@ class DymoAPI {
         return await PrivateAPI.isValidData(this.apiKey, data);
     }
 
+    async sendEmail(data: any): Promise<any> {
+        if (this.serverEmailConfig) throw customError(5000, `You must configure the email client settings.`);
+        return await PrivateAPI.sendEmail(this.apiKey, { serverEmailConfig: this.serverEmailConfig, ...data });
+    }
+
     // FUNCTIONS / Public.
     async getPrayerTimes(data: any): Promise<any> {
         return await PublicAPI.getPrayerTimes(data);

package/src/lib/interfaces.ts

@@ -0,0 +1,23 @@
+import type * as React from "react";
+
+interface PhoneData {
+    iso: any;
+    phone: string;
+};
+
+interface CreditCardData {
+    pan: string | number;
+    expirationDate?: string;
+    cvc?: string | number;
+    cvv?: string | number;
+};
+
+export interface Validator {
+    email?: string;
+    phone?: PhoneData;
+    domain?: string;
+    creditCard?: string | CreditCardData;
+    ip?: string;
+};
+
+export type SendEmail = | { from: string; to: string; subject: string; html: string; react?: never } | { from: string; to: string; subject: string; html?: never; react: React.ReactNode };

package/src/private-api.ts

@@ -1,34 +1,14 @@
 import axios from "axios";
-import config from "./config";
+import config from "./config"; 
+import * as Interfaces from "./lib/interfaces";
+import { renderAsync } from "@react-email/render";
 
 const customError = (code: number, message: string): Error => {
-    const error = new Error();
-    return Object.assign(error, { code, message: `[${config.lib.name}] ${message}` });
+    return Object.assign(new Error(), { code, message: `[${config.lib.name}] ${message}` });
 };
 
-interface PhoneData {
-    iso: any;
-    phone: string;
-};
-
-interface CreditCardData {
-    pan: string | number;
-    expirationDate?: string;
-    cvc?: string | number;
-    cvv?: string | number;
-};
-
-interface Data {
-    email?: string;
-    phone?: PhoneData;
-    domain?: string;
-    creditCard?: string | CreditCardData;
-    ip?: string;
-};
-
-export const isValidData = async (token: string | null, data: Data): Promise<any> => {
+export const isValidData = async (token: string | null, data: Interfaces.Validator): Promise<any> => {
     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")) {
@@ -37,11 +17,32 @@ export const isValidData = async (token: string | null, data: Data): Promise<any
         }
     }
     if (!i) throw customError(1500, "You must provide at least one parameter.");
-    
     try {
         const response = await axios.post("https://api.tpeoficial.com/v1/private/secure/verify", data, { headers: { "Authorization": token } });
         return response.data;
     } catch (error: any) {
         throw customError(5000, error.message);
     }
+};
+
+export const sendEmail = async (token: string | null, data: Interfaces.SendEmail): Promise<any> => {
+    if (token === null) throw customError(3000, "Invalid private token.");
+
+    if (!data.from) throw customError(1500, "You must provide an email address from which the following will be sent.");
+    if (!data.to) 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) 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 {
+        data.html = await renderAsync(data.react as React.ReactElement);
+        delete data.react;
+    } catch (error) {
+        throw customError(1500, "An error occurred while rendering your React component.");
+    }
+    try {
+        const response = await axios.post("https://api.tpeoficial.com/v1/private/sender/sendEmail", data, { headers: { "Authorization": token } });
+        return response.data;
+    } catch (error: any) {
+        throw customError(5000, error.message);
+    }
 };