dymo-api 1.0.49 → 1.0.51

package/dist/cjs/branches/private.js

@@ -27,9 +27,10 @@ var __importDefault = (this && this.__importDefault) || function (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"));
-//@ts-ignore
+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");
@@ -68,17 +69,17 @@ 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.
+ * Sends an email using a secure sending endpoint.
  *
  * @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.
+ *               'from', 'to', 'subject', 'html' or 'react', and optionally 'attachments', 'options', 'priority', and 'composeTailwindClasses'.
  *
- * @returns A promise that resolves to the response from the server.
+ * @returns A promise that resolves to the response data from the sending endpoint.
  *
- * @throws Will throw an error if there is an issue with the email sending process.
+ * @throws Will throw an error if the token is null, if any of the required fields are missing,
+ *         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) => {
     if (token === null)
@@ -108,6 +109,27 @@ const sendEmail = async (token, data) => {
         throw customError(1500, `An error occurred while rendering your React component. Details: ${error}`);
     }
     try {
+        let totalSize = 0;
+        if (data.attachments && Array.isArray(data.attachments)) {
+            const processedAttachments = await Promise.all(data.attachments.map(async (attachment) => {
+                if ((attachment.path && attachment.content) || (!attachment.path && !attachment.content))
+                    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));
+                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 || ""),
+                    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 } });
         return response.data;
     }

package/dist/cjs/dymo-api.js

@@ -174,6 +174,11 @@ class DymoAPI {
      * @param {Object} [data.options] - Content configuration options.
      * @param {"high" | "normal" | "low" | undefined} [data.options.priority="normal"] - Email priority (default: normal).
      * @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.
      */

package/dist/esm/branches/private.js

@@ -27,9 +27,10 @@ var __importDefault = (this && this.__importDefault) || function (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"));
-//@ts-ignore
+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");
@@ -68,17 +69,17 @@ 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.
+ * Sends an email using a secure sending endpoint.
  *
  * @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.
+ *               'from', 'to', 'subject', 'html' or 'react', and optionally 'attachments', 'options', 'priority', and 'composeTailwindClasses'.
  *
- * @returns A promise that resolves to the response from the server.
+ * @returns A promise that resolves to the response data from the sending endpoint.
  *
- * @throws Will throw an error if there is an issue with the email sending process.
+ * @throws Will throw an error if the token is null, if any of the required fields are missing,
+ *         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) => {
     if (token === null)
@@ -108,6 +109,27 @@ const sendEmail = async (token, data) => {
         throw customError(1500, `An error occurred while rendering your React component. Details: ${error}`);
     }
     try {
+        let totalSize = 0;
+        if (data.attachments && Array.isArray(data.attachments)) {
+            const processedAttachments = await Promise.all(data.attachments.map(async (attachment) => {
+                if ((attachment.path && attachment.content) || (!attachment.path && !attachment.content))
+                    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));
+                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 || ""),
+                    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 } });
         return response.data;
     }

package/dist/esm/dymo-api.js

@@ -174,6 +174,11 @@ class DymoAPI {
      * @param {Object} [data.options] - Content configuration options.
      * @param {"high" | "normal" | "low" | undefined} [data.options.priority="normal"] - Email priority (default: normal).
      * @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.
      */

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

@@ -13,17 +13,17 @@ import * as Interfaces from "../lib/interfaces";
  */
 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.
+ * Sends an email using a secure sending endpoint.
  *
  * @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.
+ *               'from', 'to', 'subject', 'html' or 'react', and optionally 'attachments', 'options', 'priority', and 'composeTailwindClasses'.
  *
- * @returns A promise that resolves to the response from the server.
+ * @returns A promise that resolves to the response data from the sending endpoint.
  *
- * @throws Will throw an error if there is an issue with the email sending process.
+ * @throws Will throw an error if the token is null, if any of the required fields are missing,
+ *         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>;
 /**

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

@@ -105,6 +105,11 @@ declare class DymoAPI {
      * @param {Object} [data.options] - Content configuration options.
      * @param {"high" | "normal" | "low" | undefined} [data.options.priority="normal"] - Email priority (default: normal).
      * @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.
      */

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

@@ -21,6 +21,12 @@ export interface SRNG {
     max: number;
     quantity?: number;
 }
+export type Attachment = {
+    filename: string;
+    path?: string;
+    content?: string | Buffer;
+    cid?: string;
+};
 export interface SendEmail {
     from: string;
     to: string;
@@ -31,5 +37,6 @@ export interface SendEmail {
         priority?: "high" | "normal" | "low" | undefined;
         composeTailwindClasses?: boolean;
     };
+    attachments?: Attachment[];
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.0.49",
+  "version": "1.0.51",
   "description": "Flow system for Dymo API.",
   "main": "dist/cjs/dymo-api.js",
   "module": "dist/esm/dymo-api.js",
@@ -42,6 +42,7 @@
     "@react-email/render": "1.0.1",
     "@types/react": "^18.3.5",
     "axios": "^1.6.8",
+    "path": "^0.12.7",
     "rimraf": "^6.0.1",
     "tw-to-css": "0.0.12"
   },
@@ -51,7 +52,7 @@
   ],
   "devDependencies": {
     "@types/axios": "^0.9.36",
-    "@types/node": "^22.9.0",
+    "@types/node": "^22.9.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4"
   }