@cemiar/cemiarlink-sdk 1.0.8 → 1.0.10

package/dist/models/mail/EmailAttachment.d.ts

@@ -0,0 +1,5 @@
+export interface EmailAttachment {
+    filename: string;
+    path: string;
+    cid?: string;
+}

package/dist/models/mail/EmailAttachment.js

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

package/dist/models/mail/EmailReport.d.ts

@@ -0,0 +1,10 @@
+export interface EmailReport {
+    emailId: string;
+    recipient: string;
+    buffer?: Buffer;
+    subject: string;
+    date: string;
+    extension?: string;
+    textContent: string;
+    from: string;
+}

package/dist/models/mail/EmailReport.js

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

package/dist/models/mail/GetEmailReportOptions.d.ts

@@ -0,0 +1,5 @@
+export default interface GetEmailReportOptions {
+    includeRead?: boolean;
+    skipRead?: boolean;
+    subfolders?: string[];
+}

package/dist/models/mail/GetEmailReportOptions.js

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

package/dist/models/mail/GmailMail.d.ts

@@ -0,0 +1,8 @@
+export interface GmailElement {
+    id: string;
+    threadId: string;
+}
+export interface GMailFolder {
+    id: string;
+    name: string;
+}

package/dist/models/mail/GmailMail.js

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

package/dist/models/mail/TransactionWatchList.d.ts

@@ -0,0 +1,7 @@
+export interface TransactionWatch {
+    itemNumbers: string[];
+    clientCode: string;
+    financement: string;
+    from: string;
+    transfert: boolean;
+}

package/dist/models/mail/TransactionWatchList.js

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

package/dist/services/Mail.d.ts

@@ -0,0 +1,48 @@
+import { AxiosInstance } from 'axios';
+import nodemailer from 'nodemailer';
+import { EmailAttachment } from '../models/mail/EmailAttachment';
+import { EmailReport } from '../models/mail/EmailReport';
+import GetEmailReportOptions from '../models/mail/GetEmailReportOptions';
+import { GMailFolder } from '../models/mail/GmailMail';
+import { TransactionWatch } from '../models/mail/TransactionWatchList';
+export declare class MailService {
+    user?: string;
+    axiosInstance: AxiosInstance;
+    transporter: nodemailer.Transporter;
+    constructor(mailUrl: string | undefined, headers: any, user?: string, password?: string);
+    getEmailFolders(): Promise<GMailFolder[]>;
+    getEmailMessageIds(filter: object): Promise<string[]>;
+    updateEmailMetadata(mailId: string, payload: object): Promise<void>;
+    private getEmailContent;
+    private findAttachment;
+    private findData;
+    private fetchAttachment;
+    private extractSubject;
+    private extractTextContent;
+    private extractRecipientEmail;
+    private extractReturnAddress;
+    private extractTransactionWatchData;
+    private buildQueryString;
+    /**
+     * Asynchronously retrieves an email report based on the provided mail object and attachment type.
+     *
+     * @param to - email recipient
+     * @param subjectType
+     * @param {GetEmailReportOptions | undefined} options - The options for fetching email report.
+     * @returns {object | undefined} - The data of the retrieved report or undefined if not found or an error occurs.
+     * @throws {Error} - If an error occurs during the process.
+     */
+    getEmailReport(to: string, subjectType: string, options?: GetEmailReportOptions): Promise<void>;
+    /**
+     * Asynchronously retrieves all emails' reports based on a date.
+     *
+     * @param {Date} date - The date of email reports to fetch.
+     * @param {GetEmailReportOptions | undefined} options - The options for fetching email report.
+     * @returns {EmailReport[]} - The list of reports.
+     * @throws {Error} - If an error occurs during the process.
+     */
+    getEmailReports(date: Date, options?: GetEmailReportOptions): Promise<EmailReport[]>;
+    getTransactionWatchList(to: string, subjectType: string): Promise<TransactionWatch[]>;
+    deleteEmail(id: string): Promise<void>;
+    sendMail(subject: string, text: string, html: string, to: string[], attachments?: EmailAttachment[], cc?: string[]): Promise<void>;
+}

package/dist/services/Mail.js

@@ -0,0 +1,310 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MailService = void 0;
+const fs_1 = __importDefault(require("fs"));
+const nodemailer_1 = __importDefault(require("nodemailer"));
+const AxiosClient_1 = require("../utils/AxiosClient");
+class MailService {
+    constructor(mailUrl, headers, user, password) {
+        this.axiosInstance = new AxiosClient_1.AxiosClient(mailUrl, headers).getInstance();
+        this.transporter = nodemailer_1.default.createTransport({
+            service: 'gmail',
+            auth: {
+                user: user,
+                pass: password,
+            },
+        });
+    }
+    async getEmailFolders() {
+        const folders = await this.axiosInstance.get('gmail/folders');
+        return folders.data.labels;
+    }
+    async getEmailMessageIds(filter) {
+        // get messages id from gmail
+        const queryString = this.buildQueryString(filter);
+        const url = `gmail?${queryString}`;
+        const res = await this.axiosInstance.get(url);
+        if (res.data.resultSizeEstimate == 0) {
+            return [];
+        }
+        return res.data.messages.map((message) => message.id);
+    }
+    async updateEmailMetadata(mailId, payload) {
+        // set mail as read
+        await this.axiosInstance.put('gmail/' + mailId, payload);
+    }
+    async getEmailContent(mailId) {
+        const { data } = await this.axiosInstance.get(`gmail/${mailId}?format=FULL`);
+        return data;
+    }
+    findAttachment(parts, attachmentTypes) {
+        if (!parts)
+            return null;
+        let attachment = null;
+        for (const part of parts) {
+            if (part.mimeType === 'multipart/mixed') {
+                for (const subPart of part.parts) {
+                    if (attachmentTypes.some((type) => subPart.filename.includes(`.${type}`))) {
+                        attachment = subPart;
+                        break;
+                    }
+                }
+            }
+            else {
+                if (attachmentTypes.some((type) => part.filename.includes(`.${type}`))) {
+                    attachment = part;
+                    break;
+                }
+            }
+        }
+        return attachment;
+    }
+    async findData(parts) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        let data = '';
+        if (parts) {
+            if ((_b = (_a = parts[0]) === null || _a === void 0 ? void 0 : _a.body) === null || _b === void 0 ? void 0 : _b.data) {
+                data = parts[0].body.data;
+            }
+            if ((_c = parts[0]) === null || _c === void 0 ? void 0 : _c.parts) {
+                if ((_f = (_e = (_d = parts[0]) === null || _d === void 0 ? void 0 : _d.parts[0]) === null || _e === void 0 ? void 0 : _e.body) === null || _f === void 0 ? void 0 : _f.data) {
+                    data = parts[0].parts[0].body.data;
+                }
+                if ((_h = (_g = parts[0]) === null || _g === void 0 ? void 0 : _g.parts[0]) === null || _h === void 0 ? void 0 : _h.parts) {
+                    if ((_m = (_l = (_k = (_j = parts[0]) === null || _j === void 0 ? void 0 : _j.parts[0]) === null || _k === void 0 ? void 0 : _k.parts[0]) === null || _l === void 0 ? void 0 : _l.body) === null || _m === void 0 ? void 0 : _m.data) {
+                        data = parts[0].parts[0].parts[0].body.data;
+                    }
+                }
+            }
+        }
+        return data;
+    }
+    async fetchAttachment(mailId, attachmentId) {
+        const { data } = await this.axiosInstance.get(`gmail/attachment/${mailId}/${attachmentId}`);
+        return data;
+    }
+    extractSubject(headers) {
+        return headers.find((header) => header.name === 'Subject')['value'].toLowerCase();
+    }
+    extractTextContent(parts) {
+        const textPart = parts ? parts.find((p) => p.mimeType === 'text/plain') : undefined;
+        return textPart ? Buffer.from(textPart.body.data, 'base64').toString('binary') : '';
+    }
+    extractRecipientEmail(headers) {
+        const from = headers.find((header) => header.name === 'To')['value'];
+        const emailPattern = /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/;
+        const match = from.match(emailPattern);
+        return match ? match[0] : null;
+    }
+    extractReturnAddress(headers) {
+        const from = headers.find((header) => header.name === 'From')['value'].toLowerCase();
+        try {
+            return from.match(/<(.*)>/)[1];
+        }
+        catch (_a) {
+            return from;
+        }
+    }
+    async extractTransactionWatchData(data, returnAddress) {
+        let transactionWatch = {
+            financement: '',
+            transfert: false,
+            itemNumbers: [],
+            clientCode: '',
+            from: returnAddress,
+        };
+        let buffer = Buffer.from(data, 'base64');
+        let rows = buffer
+            .toString()
+            .split('[')[0]
+            .replace(/[\r ()*]+/g, '')
+            .toLowerCase()
+            .split('\n');
+        for (let row of rows) {
+            if (row.indexOf('codeclient:') !== -1) {
+                transactionWatch.clientCode = row.split(':')[1];
+            }
+            if (row.indexOf('transfertdecrédits') !== -1) {
+                transactionWatch.transfert = true;
+            }
+            if (row.indexOf('financement:') !== -1) {
+                transactionWatch.financement = row.split(':')[1];
+            }
+            if (row.indexOf('numérostransactions:') !== -1) {
+                transactionWatch.itemNumbers = row.split(':')[1].split(',');
+            }
+        }
+        return transactionWatch;
+    }
+    buildQueryString(queryParams) {
+        return Object.entries(queryParams)
+            .map(([key, value]) => `${encodeURIComponent(key)}=${encodeURIComponent(value)}`)
+            .join('&');
+    }
+    /**
+     * Asynchronously retrieves an email report based on the provided mail object and attachment type.
+     *
+     * @param to - email recipient
+     * @param subjectType
+     * @param {GetEmailReportOptions | undefined} options - The options for fetching email report.
+     * @returns {object | undefined} - The data of the retrieved report or undefined if not found or an error occurs.
+     * @throws {Error} - If an error occurs during the process.
+     */
+    async getEmailReport(to, subjectType, options) {
+        const date = new Date();
+        date.setDate(date.getDate());
+        const today = date.toISOString().split('T')[0];
+        date.setDate(date.getDate() + 1);
+        const tomorrow = date.toISOString().split('T')[0];
+        const filter = Object.assign({ q: `to: ${to} after:${today} before:${tomorrow}` }, ((options === null || options === void 0 ? void 0 : options.includeRead) ? {} : { labelIds: 'UNREAD' }));
+        const mails = await this.getEmailMessageIds(filter);
+        for (const mail of mails) {
+            const emailContent = await this.getEmailContent(mail);
+            const subject = this.extractSubject(emailContent.payload.headers);
+            if (subject.indexOf(subjectType) === -1) {
+                continue;
+            }
+            const { payload: { parts }, } = emailContent;
+            const attachment = this.findAttachment(parts, ['xlsx']);
+            if (!attachment || attachment.body.size === 0) {
+                throw new Error(`Could not find the attachment ending in 'xlsx' in the email: ${mail}.`);
+            }
+            const attachmentData = await this.fetchAttachment(mail, attachment.body.attachmentId);
+            let fileType = attachment.filename.split('.')[1];
+            fileType = '.' + fileType;
+            const buffer = Buffer.from(attachmentData.data, 'base64');
+            if (!fs_1.default.existsSync('./temp/')) {
+                fs_1.default.mkdirSync('./temp/');
+            }
+            fs_1.default.writeFileSync(`./temp/Rapport ${subjectType} du ${today}${fileType}`, buffer);
+            if (!(options === null || options === void 0 ? void 0 : options.skipRead))
+                await this.updateEmailMetadata(mail, {
+                    removeLabelIds: ['UNREAD'],
+                });
+        }
+    }
+    /**
+     * Asynchronously retrieves all emails' reports based on a date.
+     *
+     * @param {Date} date - The date of email reports to fetch.
+     * @param {GetEmailReportOptions | undefined} options - The options for fetching email report.
+     * @returns {EmailReport[]} - The list of reports.
+     * @throws {Error} - If an error occurs during the process.
+     */
+    async getEmailReports(date, options) {
+        const today = date.toISOString().split('T')[0];
+        date.setDate(date.getDate() + 1);
+        const tomorrow = date.toISOString().split('T')[0];
+        let q = `after:${today} before:${tomorrow} in:inbox`;
+        if (!(options === null || options === void 0 ? void 0 : options.includeRead))
+            q += ' ' + 'in:unread';
+        let emailIds = await this.getEmailMessageIds({
+            q,
+        });
+        if (options === null || options === void 0 ? void 0 : options.subfolders) {
+            const gMailFolders = await this.getEmailFolders();
+            const folders = gMailFolders.filter((f) => { var _a; return (_a = options === null || options === void 0 ? void 0 : options.subfolders) === null || _a === void 0 ? void 0 : _a.includes(f.name); }).map((f) => f.id);
+            if (folders) {
+                let qu = `after:${today} before:${tomorrow}`;
+                if (!(options === null || options === void 0 ? void 0 : options.includeRead)) {
+                    qu += ' ' + 'in:unread';
+                }
+                const folderEmails = await this.getEmailMessageIds({
+                    q: qu,
+                    labelIds: folders.join(','),
+                });
+                emailIds.push(...folderEmails);
+            }
+        }
+        const emailReports = [];
+        for (const emailId of emailIds) {
+            const emailContent = await this.getEmailContent(emailId);
+            const subject = this.extractSubject(emailContent.payload.headers);
+            const recipient = this.extractRecipientEmail(emailContent.payload.headers);
+            const date = new Date(parseInt(emailContent.internalDate)).toISOString().split('T')[0];
+            const { payload: { parts }, } = emailContent;
+            const textContent = this.extractTextContent(parts);
+            const attachment = this.findAttachment(parts, ['xlsx', 'csv', 'pdf']);
+            if (!recipient)
+                continue;
+            if (!attachment || attachment.body.size === 0) {
+                emailReports.push({
+                    emailId,
+                    recipient: recipient,
+                    subject: subject,
+                    date: date,
+                    textContent: textContent,
+                    extension: undefined,
+                    buffer: undefined,
+                    from: this.extractReturnAddress(emailContent.payload.headers),
+                });
+            }
+            else {
+                const attachmentData = await this.fetchAttachment(emailId, attachment.body.attachmentId);
+                const buffer = Buffer.from(attachmentData.data, 'base64');
+                emailReports.push({
+                    emailId,
+                    recipient,
+                    subject,
+                    buffer,
+                    date,
+                    extension: attachment.filename.split('.').pop(),
+                    textContent,
+                    from: this.extractReturnAddress(emailContent.payload.headers),
+                });
+            }
+            if (!(options === null || options === void 0 ? void 0 : options.skipRead))
+                await this.updateEmailMetadata(emailId, {
+                    removeLabelIds: ['UNREAD'],
+                });
+        }
+        return emailReports.filter((item, index, self) => index ===
+            self.findIndex((t) => t.recipient === item.recipient && t.subject === item.subject && t.date === item.date));
+    }
+    async getTransactionWatchList(to, subjectType) {
+        const date = new Date();
+        date.setDate(date.getDate());
+        const today = date.toISOString().split('T')[0];
+        date.setDate(date.getDate() + 1);
+        const tomorrow = date.toISOString().split('T')[0];
+        const mails = await this.getEmailMessageIds({
+            labelIds: 'UNREAD',
+            q: `to: ${to} OR cc:${to} after:${today} before:${tomorrow}`,
+        });
+        let transactionWatchList = [];
+        for (const mail of mails) {
+            const emailContent = await this.getEmailContent(mail);
+            const subject = this.extractSubject(emailContent.payload.headers);
+            if (subject.indexOf(subjectType) === -1) {
+                continue;
+            }
+            const returnAddress = this.extractReturnAddress(emailContent.payload.headers);
+            const { payload: { parts }, } = emailContent;
+            const data = await this.findData(parts);
+            transactionWatchList.push(await this.extractTransactionWatchData(data, returnAddress));
+            await this.updateEmailMetadata(mail, {
+                removeLabelIds: ['UNREAD'],
+            });
+        }
+        return transactionWatchList;
+    }
+    async deleteEmail(id) {
+        await this.axiosInstance.delete(`gmail/${id}`);
+    }
+    async sendMail(subject, text, html, to, attachments, cc) {
+        const mailOptions = {
+            from: this.user,
+            to,
+            subject,
+            text,
+            html,
+            cc,
+            attachments,
+        };
+        await this.transporter.sendMail(mailOptions);
+    }
+}
+exports.MailService = MailService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cemiar/cemiarlink-sdk",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "CemiarLink SDK to access CemiarLink API services",
   "engines": {
     "npm": ">=9.5.1",
@@ -17,7 +17,10 @@
   "dependencies": {
     "axios": "^1.13.5",
     "path": "^0.12.7",
-    "xlsx": "^0.18.5"
+    "xlsx": "^0.18.5",
+    "nodemailer": "^7.0.11",
+    "fs": "^0.0.1-security",
+    "@types/nodemailer": "^7.0.11"
   },
   "devDependencies": {
     "ts-node": "^10.9.2"