@openinc/parse-server-opendash 3.28.0 → 3.29.1

package/dist/features/config/helper/customOptions.js

@@ -276,14 +276,7 @@ exports.customoptions = {
         public: true,
         default: "false",
         description: "Enable SMTP for sending e-mails.",
-        dependencies: [
-            "SMTP_HOST",
-            "SMTP_PORT",
-            "SMTP_USER",
-            "SMTP_PASS",
-            "SMTP_FROM",
-            "SMTP_SECURE",
-        ],
+        dependencies: ["SMTP_HOST", "SMTP_PORT", "SMTP_FROM", "SMTP_SECURE"],
     },
     SMTP_HOST: {
         env: "OPENINC_PARSE_SMTP_HOST",

package/dist/features/notifications/index.d.ts

@@ -2,3 +2,6 @@ export { FunctionKeys, NotificationInterface, NotificationMap, } from "./types/N
 export { Notifications } from "./types/Notifications";
 export { RegisteredNotification } from "./states/NotificationClass";
 export { getAllNotifications, default as initNotifications, } from "./services/registerNotification";
+export { EmailState } from "./states/EmailState";
+export { sendSimpleEmail, sendTemplateEmail } from "./services/sendMails";
+export { initEmailTransport } from "./services/initEmailTransport";

package/dist/features/notifications/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initNotifications = exports.getAllNotifications = exports.RegisteredNotification = exports.Notifications = void 0;
+exports.initEmailTransport = exports.sendTemplateEmail = exports.sendSimpleEmail = exports.EmailState = exports.initNotifications = exports.getAllNotifications = exports.RegisteredNotification = exports.Notifications = void 0;
 var Notifications_1 = require("./types/Notifications");
 Object.defineProperty(exports, "Notifications", { enumerable: true, get: function () { return Notifications_1.Notifications; } });
 var NotificationClass_1 = require("./states/NotificationClass");
@@ -11,3 +11,10 @@ Object.defineProperty(exports, "RegisteredNotification", { enumerable: true, get
 var registerNotification_1 = require("./services/registerNotification");
 Object.defineProperty(exports, "getAllNotifications", { enumerable: true, get: function () { return registerNotification_1.getAllNotifications; } });
 Object.defineProperty(exports, "initNotifications", { enumerable: true, get: function () { return __importDefault(registerNotification_1).default; } });
+var EmailState_1 = require("./states/EmailState");
+Object.defineProperty(exports, "EmailState", { enumerable: true, get: function () { return EmailState_1.EmailState; } });
+var sendMails_1 = require("./services/sendMails");
+Object.defineProperty(exports, "sendSimpleEmail", { enumerable: true, get: function () { return sendMails_1.sendSimpleEmail; } });
+Object.defineProperty(exports, "sendTemplateEmail", { enumerable: true, get: function () { return sendMails_1.sendTemplateEmail; } });
+var initEmailTransport_1 = require("./services/initEmailTransport");
+Object.defineProperty(exports, "initEmailTransport", { enumerable: true, get: function () { return initEmailTransport_1.initEmailTransport; } });

package/dist/features/notifications/services/initEmailTransport.d.ts

@@ -0,0 +1 @@
+export declare function initEmailTransport(): Promise<void>;

package/dist/features/notifications/services/initEmailTransport.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initEmailTransport = initEmailTransport;
+const nodemailer_1 = __importDefault(require("nodemailer"));
+const nunjucks_1 = __importDefault(require("nunjucks"));
+const path_1 = require("path");
+const __1 = require("..");
+const config_1 = require("../../config");
+async function initEmailTransport() {
+    try {
+        if (config_1.ConfigInstance.getInstance().getBoolean("SMTP_ENABLED")) {
+            const emailState = __1.EmailState.getInstance();
+            console.log("[@openinc/parse-server-opendash] Initializing email transport...");
+            const transportOptions = {
+                host: config_1.ConfigInstance.getInstance().get("SMTP_HOST"),
+                port: config_1.ConfigInstance.getInstance().getNumber("SMTP_PORT"),
+                secure: config_1.ConfigInstance.getInstance().getBoolean("SMTP_SECURE"),
+                ignoreTLS: config_1.ConfigInstance.getInstance().getBoolean("SMTP_IGNORE_TLS"),
+            };
+            if (config_1.ConfigInstance.getInstance().get("SMTP_USER") &&
+                config_1.ConfigInstance.getInstance().get("SMTP_PASS")) {
+                transportOptions.auth = {
+                    user: config_1.ConfigInstance.getInstance().get("SMTP_USER"),
+                    pass: config_1.ConfigInstance.getInstance().get("SMTP_PASS"),
+                };
+            }
+            const transport = nodemailer_1.default.createTransport(transportOptions);
+            if (config_1.ConfigInstance.getInstance().get("SMTP_USER") &&
+                config_1.ConfigInstance.getInstance().get("SMTP_PASS")) {
+                console.log("[@openinc/parse-server-opendash] Verifying SMTP transport...");
+                await transport.verify();
+            }
+            emailState.setTransport(transport);
+            const templateDir = (0, path_1.resolve)(process.cwd(), config_1.ConfigInstance.getInstance().get("EMAIL_TEMPLATE_DIR"));
+            emailState.setEmailTemplateDir(templateDir);
+            nunjucks_1.default.configure(templateDir, { autoescape: true });
+            console.log("[@openinc/parse-server-opendash] Email transport initialized successfully");
+        }
+        else {
+            console.log("[@openinc/parse-server-opendash] SMTP disabled, skipping email transport initialization");
+        }
+    }
+    catch (error) {
+        console.error(`Parse SMTP Adapter: Error when trying to establish the SMTP connection:`);
+        console.error(error);
+    }
+}

package/dist/features/notifications/services/sendMails.d.ts

@@ -0,0 +1,21 @@
+import { Core_Email } from "../../../types";
+/**
+ * Send a simple email
+ * @param to The recipient email address
+ * @param subject The subject of the email
+ * @param text The plain text content of the email
+ * @returns The saved email object
+ */
+export declare function sendSimpleEmail(to: string, subject: string, text: string): Promise<Core_Email>;
+/**
+ * Send a template email
+ * @param param0
+ * @returns
+ */
+export declare function sendTemplateEmail({ to, subject, fallback, template, data, }: {
+    to: string;
+    subject: string;
+    fallback: string;
+    template: string;
+    data: any;
+}): Promise<Core_Email>;

package/dist/features/notifications/services/sendMails.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendSimpleEmail = sendSimpleEmail;
+exports.sendTemplateEmail = sendTemplateEmail;
+const fs_1 = __importDefault(require("fs"));
+const nunjucks_1 = __importDefault(require("nunjucks"));
+const path_1 = require("path");
+const types_1 = require("../../../types");
+const EmailState_1 = require("../states/EmailState");
+/**
+ * Send a simple email
+ * @param to The recipient email address
+ * @param subject The subject of the email
+ * @param text The plain text content of the email
+ * @returns The saved email object
+ */
+async function sendSimpleEmail(to, subject, text) {
+    const email = new types_1.Core_Email({
+        payload: {
+            to,
+            subject,
+            text,
+        },
+    });
+    await email.save(null, { useMasterKey: true });
+    return email;
+}
+/**
+ * Send a template email
+ * @param param0
+ * @returns
+ */
+async function sendTemplateEmail({ to, subject, fallback, template, data, }) {
+    const email = new types_1.Core_Email({
+        payload: {
+            to,
+            subject: renderEmailTemplate("subject", template, data, subject),
+            text: renderEmailTemplate("txt", template, data, fallback),
+            html: renderEmailTemplate("html", template, data, undefined),
+        },
+    });
+    await email.save(null, { useMasterKey: true });
+    return email;
+}
+/**
+ * Validate if an email template exists in the specified directory
+ * @param templateDir The directory where email templates are stored
+ * @param template The specific template file to validate
+ * @returns Whether the template exists in the directory
+ */
+function validateEmailTemplate(templateDir, template) {
+    const templatePath = (0, path_1.join)(templateDir, template);
+    if (!fs_1.default.existsSync(templateDir)) {
+        return false;
+    }
+    if (!fs_1.default.existsSync(templatePath)) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Render an email template
+ * @param type The type of the email template (txt, html, subject)
+ * @param template The base name of the template file
+ * @param data The data to be used for rendering the template
+ * @param fallback The fallback content if the template is not found
+ * @returns The rendered email content
+ */
+function renderEmailTemplate(type, template, data, fallback) {
+    const emailState = EmailState_1.EmailState.getInstance();
+    const emailTemplateDir = emailState.getEmailTemplateDir();
+    const fullTemplate = template + "." + type;
+    if (validateEmailTemplate(emailTemplateDir, fullTemplate)) {
+        return nunjucks_1.default.render(fullTemplate, data);
+    }
+    if (type === "html") {
+        return renderEmailTemplate("txt", template, data, fallback);
+    }
+    return fallback || "";
+}

package/dist/features/notifications/states/EmailState.d.ts

@@ -0,0 +1,39 @@
+import { Transporter } from "nodemailer";
+import SMTPTransport from "nodemailer/lib/smtp-transport";
+/**
+ * Singleton class to manage email transport and template directory
+ */
+export declare class EmailState {
+    private static instance;
+    emailTemplateDir: string;
+    transport: Transporter<SMTPTransport.SentMessageInfo> | undefined;
+    private constructor();
+    /**
+     * Get the singleton instance
+     */
+    static getInstance(): EmailState;
+    /**
+     * Set the email transport
+     */
+    setTransport(transport: Transporter<SMTPTransport.SentMessageInfo>): void;
+    /**
+     * Get the email transport
+     */
+    getTransport(): Transporter<SMTPTransport.SentMessageInfo> | undefined;
+    /**
+     * Set the email template directory
+     */
+    setEmailTemplateDir(dir: string): void;
+    /**
+     * Get the email template directory
+     */
+    getEmailTemplateDir(): string;
+    /**
+     * Check if email transport is configured and ready
+     */
+    isConfigured(): boolean;
+    /**
+     * Reset the singleton (useful for testing)
+     */
+    static reset(): void;
+}

package/dist/features/notifications/states/EmailState.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailState = void 0;
+/**
+ * Singleton class to manage email transport and template directory
+ */
+class EmailState {
+    constructor() {
+        this.emailTemplateDir = "";
+        this.transport = undefined;
+    }
+    /**
+     * Get the singleton instance
+     */
+    static getInstance() {
+        if (!EmailState.instance) {
+            EmailState.instance = new EmailState();
+        }
+        return EmailState.instance;
+    }
+    /**
+     * Set the email transport
+     */
+    setTransport(transport) {
+        this.transport = transport;
+    }
+    /**
+     * Get the email transport
+     */
+    getTransport() {
+        return this.transport;
+    }
+    /**
+     * Set the email template directory
+     */
+    setEmailTemplateDir(dir) {
+        this.emailTemplateDir = dir;
+    }
+    /**
+     * Get the email template directory
+     */
+    getEmailTemplateDir() {
+        return this.emailTemplateDir;
+    }
+    /**
+     * Check if email transport is configured and ready
+     */
+    isConfigured() {
+        return this.transport !== undefined;
+    }
+    /**
+     * Reset the singleton (useful for testing)
+     */
+    static reset() {
+        EmailState.instance = undefined;
+    }
+}
+exports.EmailState = EmailState;

package/dist/functions/openinc-auth-email-confirmation-request.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = init;
-const __1 = require("..");
+const notifications_1 = require("../features/notifications");
 const transformLogin_1 = require("../helper/transformLogin");
 const openinc_auth_common_1 = require("./openinc-auth.common");
 async function init(name) {
@@ -14,7 +14,7 @@ async function init(name) {
             throw new Parse.Error(Parse.Error.OBJECT_NOT_FOUND, "No user was found with the given email.");
         }
         const { url } = await (0, openinc_auth_common_1.createToken)("verify-email", user.id, request.params.url);
-        await (0, __1.sendTemplateEmail)({
+        await (0, notifications_1.sendTemplateEmail)({
             template: "openinc-auth-email-confirmation",
             subject: "E-Mail Bestätigung / Email confirmation",
             to: email,

package/dist/functions/openinc-auth-login-passwordless.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = init;
-const __1 = require("..");
+const notifications_1 = require("../features/notifications");
 const transformLogin_1 = require("../helper/transformLogin");
 const openinc_auth_common_1 = require("./openinc-auth.common");
 async function init(name) {
@@ -22,7 +22,7 @@ async function init(name) {
         });
         const url = urlTemplate.replace("{{token}}", sessionToken);
         console.log(url);
-        await (0, __1.sendTemplateEmail)({
+        await (0, notifications_1.sendTemplateEmail)({
             template: "openinc-auth-login-passwordless",
             subject: "Passwordless Login",
             to: email,

package/dist/functions/openinc-auth-password-reset-request.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = init;
-const __1 = require("..");
+const notifications_1 = require("../features/notifications");
 const transformLogin_1 = require("../helper/transformLogin");
 const openinc_auth_common_1 = require("./openinc-auth.common");
 async function init(name) {
@@ -14,7 +14,7 @@ async function init(name) {
             throw new Parse.Error(Parse.Error.OBJECT_NOT_FOUND, "No user was found with the given email.");
         }
         const { url } = await (0, openinc_auth_common_1.createToken)("password-reset", user.id, request.params.url);
-        await (0, __1.sendTemplateEmail)({
+        await (0, notifications_1.sendTemplateEmail)({
             template: "openinc-auth-password-reset",
             subject: "Passwort zurücksetzen / Password reset",
             to: email,

package/dist/functions/openinc-mail-test.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = init;
-const __1 = require("..");
+const notifications_1 = require("../features/notifications");
 async function init(name) {
     // sendTestEmail - Sends a test email
     Parse.Cloud.define(name, async (request) => {
@@ -9,7 +9,7 @@ async function init(name) {
             return { message: "Unauthorized" };
         }
         const { to } = request.params;
-        const mail = await (0, __1.sendSimpleEmail)(to, "open.INC Test Mail", "This is a test email from open.INC Stack.");
+        const mail = await (0, notifications_1.sendSimpleEmail)(to, "open.INC Test Mail", "This is a test email from open.INC Stack.");
         return mail;
     }, {
         requireUser: true,

package/dist/hooks/Core_Email.d.ts

@@ -1,11 +1 @@
-import { Core_Email } from "../types";
-export declare function initEmailTransport(): Promise<void>;
-export declare function sendSimpleEmail(to: string, subject: string, text: string): Promise<Core_Email>;
-export declare function sendTemplateEmail({ to, subject, fallback, template, data, }: {
-    to: string;
-    subject: string;
-    fallback: string;
-    template: string;
-    data: any;
-}): Promise<Core_Email>;
 export declare function init(): Promise<void>;

package/dist/hooks/Core_Email.js

@@ -1,92 +1,16 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initEmailTransport = initEmailTransport;
-exports.sendSimpleEmail = sendSimpleEmail;
-exports.sendTemplateEmail = sendTemplateEmail;
 exports.init = init;
-const fs_1 = __importDefault(require("fs"));
-const nodemailer_1 = __importDefault(require("nodemailer"));
-const nunjucks_1 = __importDefault(require("nunjucks"));
-const path_1 = require("path");
 const __1 = require("..");
 const config_1 = require("../features/config");
+const notifications_1 = require("../features/notifications");
 const types_1 = require("../types");
-let emailTemplateDir = "";
-let transport = undefined;
-async function initEmailTransport() {
-    try {
-        if (config_1.ConfigInstance.getInstance().getBoolean("SMTP_ENABLED")) {
-            transport = nodemailer_1.default.createTransport({
-                host: config_1.ConfigInstance.getInstance().get("SMTP_HOST"),
-                port: config_1.ConfigInstance.getInstance().getNumber("SMTP_PORT"),
-                secure: config_1.ConfigInstance.getInstance().getBoolean("SMTP_SECURE"),
-                ignoreTLS: config_1.ConfigInstance.getInstance().getBoolean("SMTP_IGNORE_TLS"),
-                auth: {
-                    user: config_1.ConfigInstance.getInstance().get("SMTP_USER"),
-                    pass: config_1.ConfigInstance.getInstance().get("SMTP_PASS"),
-                },
-            });
-            await transport.verify();
-            emailTemplateDir = (0, path_1.resolve)(process.cwd(), config_1.ConfigInstance.getInstance().get("EMAIL_TEMPLATE_DIR"));
-            nunjucks_1.default.configure(emailTemplateDir, { autoescape: true });
-        }
-    }
-    catch (error) {
-        console.error(`Parse SMTP Adapter: Error when trying to establish the SMTP connection:`);
-        console.error(error);
-        process.exit(1);
-    }
-}
-async function sendSimpleEmail(to, subject, text) {
-    const email = new types_1.Core_Email({
-        payload: {
-            to,
-            subject,
-            text,
-        },
-    });
-    await email.save(null, { useMasterKey: true });
-    return email;
-}
-async function sendTemplateEmail({ to, subject, fallback, template, data, }) {
-    const email = new types_1.Core_Email({
-        payload: {
-            to,
-            subject: renderEmailTemplate("subject", template, data, subject),
-            text: renderEmailTemplate("txt", template, data, fallback),
-            html: renderEmailTemplate("html", template, data, undefined),
-        },
-    });
-    await email.save(null, { useMasterKey: true });
-    return email;
-}
-function validateEmailTemplate(templateDir, template) {
-    const templatePath = (0, path_1.join)(templateDir, template);
-    if (!fs_1.default.existsSync(templateDir)) {
-        return false;
-    }
-    if (!fs_1.default.existsSync(templatePath)) {
-        return false;
-    }
-    return true;
-}
-function renderEmailTemplate(type, template, data, fallback) {
-    const fullTemplate = template + "." + type;
-    if (validateEmailTemplate(emailTemplateDir, fullTemplate)) {
-        return nunjucks_1.default.render(fullTemplate, data);
-    }
-    if (type === "html") {
-        return renderEmailTemplate("txt", template, data, fallback);
-    }
-    return fallback || "";
-}
 async function init() {
     (0, __1.beforeSaveHook)(types_1.Core_Email, async (request) => {
         const { object } = request;
         object.setACL(new Parse.ACL());
+        const emailState = notifications_1.EmailState.getInstance();
+        const transport = emailState.getTransport();
         if (!transport) {
             object.sent = false;
             object.success = false;

package/dist/hooks/Notification.js

@@ -7,6 +7,7 @@ exports.init = init;
 const web_push_1 = __importDefault(require("web-push"));
 const __1 = require("..");
 const config_1 = require("../features/config");
+const notifications_1 = require("../features/notifications");
 const types_1 = require("../types");
 async function init() {
     (0, __1.beforeSaveHook)(types_1.Notification, async (request) => {
@@ -32,7 +33,7 @@ async function init() {
                         body += config_1.ConfigInstance.getInstance().get("APP_URL");
                         body += object.get("data")?.url;
                     }
-                    await (0, __1.sendSimpleEmail)(email, title, body);
+                    await (0, notifications_1.sendSimpleEmail)(email, title, body);
                 }
             }
             // Handle Push

package/dist/hooks/_User.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = init;
 const __1 = require("..");
 const config_1 = require("../features/config");
+const notifications_1 = require("../features/notifications");
 const settings_1 = require("../features/user/settings");
 const transformLogin_1 = require("../helper/transformLogin");
 const types_1 = require("../types");
@@ -111,7 +112,7 @@ async function init() {
                     .equalTo("tenantAdmin", true)
                     .findAll({ useMasterKey: true });
                 for (const admin of admins) {
-                    await (0, __1.sendTemplateEmail)({
+                    await (0, notifications_1.sendTemplateEmail)({
                         template: "openinc-auth-tenant-verification-request",
                         subject: "Ein neuer Nutzer muss verifiziert werden",
                         to: admin.get("email"),
@@ -126,7 +127,7 @@ async function init() {
                 object.get("tenantVerified") === true) {
                 const email = object.get("email");
                 verificationEmailCache[object.id] = true;
-                await (0, __1.sendTemplateEmail)({
+                await (0, notifications_1.sendTemplateEmail)({
                     template: "openinc-auth-tenant-verification",
                     subject: "Dein Account wurde verifiziert",
                     to: email,

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import type { Cloud as ParseCloud } from "parse";
 import { Permission } from "./types";
-export { sendSimpleEmail, sendTemplateEmail } from "./hooks/Core_Email";
 /**
  * Initializes the Cloud Code for open.DASH.
  * This function performs various initialization tasks such as
@@ -194,3 +193,4 @@ export declare function autoloadCloudCode(path: string, regex?: RegExp): Promise
  * @returns The updated or newly created permission.
  */
 export declare function ensurePermission(key: string, acl?: Parse.ACL): Promise<Permission>;
+export {};

package/dist/index.js

@@ -3,7 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendTemplateEmail = exports.sendSimpleEmail = void 0;
 exports.init = init;
 exports.hasPermission = hasPermission;
 exports.requirePermission = requirePermission;
@@ -38,7 +37,6 @@ const types_1 = require("./types");
 const notifications_1 = require("./features/notifications");
 const permissions_1 = require("./features/permissions");
 const settings_1 = require("./features/user/settings");
-const Core_Email_1 = require("./hooks/Core_Email");
 const importDocs_1 = require("./features/documentation/functions/importDocs");
 const openservice_1 = require("./features/openservice");
 const translations_1 = require("./features/translations");
@@ -49,12 +47,8 @@ dayjs_1.default.extend(weekday_1.default);
 dayjs_1.default.extend(dayOfYear_1.default);
 dayjs_1.default.extend(weekOfYear_1.default);
 dayjs_1.default.extend(duration_1.default);
-var Core_Email_2 = require("./hooks/Core_Email");
-Object.defineProperty(exports, "sendSimpleEmail", { enumerable: true, get: function () { return Core_Email_2.sendSimpleEmail; } });
-Object.defineProperty(exports, "sendTemplateEmail", { enumerable: true, get: function () { return Core_Email_2.sendTemplateEmail; } });
 const PREFIX = "OD3_";
 let config;
-// const lang_deu = require("../i18n/deu.json");
 let schema = {};
 /**
  * Initializes the Cloud Code for open.DASH.
@@ -85,7 +79,7 @@ async function init() {
     config = config_1.ConfigInstance.getInstance();
     await config.init(true);
     await (0, translations_1.initTranslations)();
-    await (0, Core_Email_1.initEmailTransport)();
+    await (0, notifications_1.initEmailTransport)();
     await initWebPush();
     await initSchema();
     await initDefaultRoles();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openinc/parse-server-opendash",
-  "version": "3.28.0",
+  "version": "3.29.1",
   "description": "Parse Server Cloud Code for open.INC Stack.",
   "packageManager": "pnpm@10.20.0",
   "keywords": [