propro-utils 1.3.8

package/notify/README.md

@@ -0,0 +1,110 @@
+# Notification System
+
+This notification system provides a flexible and robust way to send notifications through various channels like SMS and email. It employs the strategy pattern to allow for easy extension and customization of notification methods.
+
+## System Overview
+
+The system is built around a base `NotificationStrategy` class, which different notification strategies extend. Currently, the system supports SMS notifications via Twilio and Mailjet, and email notifications using the Mailgun service.
+
+### Strategies
+
+- `TwilioSMSNotificationStrategy`: Sends SMS using Twilio.
+- `MailjetSMSNotificationStrategy`: Sends SMS using Mailjet.
+- `EmailNotificationStrategy`: Sends emails using the Mailgun service.
+
+### Notification Service
+
+- `NotificationService`: Handles the sending of notifications. It can be configured with any of the available strategies.
+
+## Setup and Configuration
+
+Before using the notification system, ensure that all the necessary dependencies are installed and environment variables are set.
+
+### Dependencies
+
+- `axios`
+- `twilio`
+- `mailgun.js`
+- `form-data`
+- `@react-email/render`
+
+### Environment Variables
+
+Set the following environment variables in your application:
+
+- `TWILIO_ACCOUNT_SID`
+- `TWILIO_AUTH_TOKEN`
+- `TWILIO_PHONE_NUMBER`
+- `MAILJET_MJ_TOKEN`
+- `MAILGUN_API_KEY`
+- `EMAIL_FROM`
+- `EMAIL_DOMAIN`
+
+## Usage
+
+Here's how you can use the different strategies in your application:
+
+### Sending an SMS with Twilio
+
+```javascript
+const {
+  NotificationService,
+  TwilioSMSNotificationStrategy,
+} = require("propro-auth-middleware/notify");
+
+const twilioStrategy = new TwilioSMSNotificationStrategy();
+const notificationService = new NotificationService(twilioStrategy);
+
+notificationService
+  .sendNotification("+1234567890", "Your SMS message here")
+  .then((response) => console.log("SMS sent with SID:", response))
+  .catch((error) => console.error("Error sending SMS:", error));
+```
+
+### Sending an SMS with Mailjet
+
+```javascript
+const {
+  NotificationService,
+  MailjetSMSNotificationStrategy,
+} = require("propro-auth-middleware/notify");
+
+const mailjetStrategy = new MailjetSMSNotificationStrategy();
+const notificationService = new NotificationService(mailjetStrategy);
+
+notificationService
+  .sendNotification("+1234567890", "Your SMS message here")
+  .then((response) => console.log("SMS sent with SID:", response))
+  .catch((error) => console.error("Error sending SMS:", error));
+```
+
+### Sending an email with Mailgun
+
+```javascript
+
+const {
+  NotificationService,
+  EmailNotificationStrategy,
+} = require('propro-auth-middleware/notify');
+
+const emailStrategy = new EmailNotificationStrategy();
+const notificationService = new NotificationService(emailStrategy);
+
+const emailDetails = {
+    template: "template-name",
+    to: "dozie@hubhub.app",
+    additionalData: {
+        name: "Dozie",
+        message: "Your email message here"
+    }
+}:
+
+notificationService
+  .sendNotification(emailDetails)
+  .then((response) => console.log("Email sent with ID:", response))
+  .catch((error) => console.error("Error sending email:", error));
+```
+
+## Extending the System
+
+To add a new notification strategy, simply extend the `NotificationStrategy` class and implement the `sendNotification` method. Then, add the new strategy to the `NotificationService` class.

package/notify/baseStrategy.js

@@ -0,0 +1,13 @@
+/**
+ * Represents a notification strategy.
+ * @class
+ */
+class NotificationStrategy {
+  async sendNotification(to, message) {
+    throw new Error("sendNotification method should be implemented");
+  }
+}
+
+module.exports = {
+  NotificationStrategy,
+};

package/notify/emailStrategy.js

@@ -0,0 +1,57 @@
+require("dotenv").config();
+const React = require("react");
+const ReactDOMServer = require("react-dom/server");
+const NotifLocal = require("./NotifLocal");
+const nodemailer = require("nodemailer");
+const mailgun = require("nodemailer-mailgun-transport");
+const { templateData } = require("./template.data");
+const { NotificationStrategy } = require("./baseStrategy");
+
+const mailgunTransport = nodemailer.createTransport(
+  mailgun({
+    host: process.env.SMTP_HOST,
+    auth: {
+      api_key: process.env.MAILGUN_API_KEY,
+      domain: process.env.EMAIL_DOMAIN,
+    },
+  })
+);
+
+/**
+ * Represents a strategy for sending email notifications.
+ */
+class EmailNotificationStrategy extends NotificationStrategy {
+  async sendNotification(to, templateName, templateArgs) {
+    const templates = templateData(templateArgs || {});
+    const selectedTemplate = templates[templateName];
+
+    if (!selectedTemplate) {
+      throw new Error(`Template '${templateName}' not found`);
+    }
+
+    console.log("selectedTemplate", selectedTemplate);
+    console.log("templateData", templateData);
+    // const emailHTML = ReactDOMServer.renderToString(
+    //   React.createElement(NotifLocal, selectedTemplate)
+    // );
+
+    const emailHTML = `<h1>${selectedTemplate.body}</h1>`;
+
+    const message = {
+      from: process.env.EMAIL_FROM,
+      to,
+      subject: selectedTemplate.subject || "New Notification",
+      html: emailHTML,
+    };
+
+    try {
+      console.log("Email Message Object:", message);
+      const info = await mailgunTransport.sendMail(message);
+      console.log("Message sent: %s", info.messageId);
+    } catch (error) {
+      console.error("Error sending email", error);
+    }
+  }
+}
+
+module.exports = { EmailNotificationStrategy };

package/notify/index.js

@@ -0,0 +1,11 @@
+const { EmailNotificationStrategy } = require("./emailStrategy");
+const { MailjetSMSNotificationStrategy } = require("./mailjetStrategy");
+const { TwilioSMSNotificationStrategy } = require("./twilloStrategy");
+const { NotificationService } = require("./NotificationService");
+
+module.exports = {
+  EmailNotificationStrategy,
+  MailjetSMSNotificationStrategy,
+  TwilioSMSNotificationStrategy,
+  NotificationService,
+};

package/notify/mailjetStrategy.js

@@ -0,0 +1,27 @@
+const axios = require("axios");
+const { NotificationStrategy } = require("./baseStrategy");
+
+/**
+ * Mailjet SMS Notification Strategy.
+ * @class
+ * @extends NotificationStrategy
+ */
+class MailjetSMSNotificationStrategy extends NotificationStrategy {
+  async sendNotification(to, message) {
+    const response = await axios.post(
+      "https://api.mailjet.com/v4/sms-send",
+      { Text: message, To: to, From: "ProPro" },
+      {
+        headers: {
+          Authorization: `Bearer ${config.mailjet.MJ_TOKEN}`,
+          "Content-Type": "application/json",
+        },
+      }
+    );
+    return response.data.MessageId;
+  }
+}
+
+module.exports = {
+  MailjetSMSNotificationStrategy,
+};

package/notify/template.data.js

@@ -0,0 +1,292 @@
+const templateData = ({ ...args }) => ({
+  "new-account": {
+    subject: "Welcome to ProPro",
+    body: "Thank you for signing up to ProPro. Please click the link below to verify your email address.",
+    button: {
+      label: "Verify Your Email",
+      url: "{{domain}}?token={{content.verification_token}}",
+    },
+  },
+  "duplicate-user": {
+    subject: "Important! Your ProPro Account",
+    body: "We noticed you already have a registered account with ProPro. To prevent confusion, your original password remains unchanged.",
+    button: {
+      label: "Sign In",
+      url: "{{domain}}/signin",
+    },
+  },
+  new_plan: {
+    subject: "Your ProPro Plan",
+    body: "Thank you for choosing the {{content.plan}} plan. Your card has been successfully charged {{content.price}}.",
+    button: {
+      label: "Your Dashboard",
+      url: "{{domain}}/dashboard",
+    },
+  },
+  "new-user": {
+    subject: "Welcome to ProPro",
+    body: "Thank you for signing up to ProPro. Please click the link below to verify your email address.",
+    button: {
+      label: "Verify Your Email",
+      url: "{{domain}}?token={{content.verification_token}}",
+    },
+  },
+  "plan-updated": {
+    subject: "Your Billing Plan Updated",
+    body: "Confirmation: Your billing plan has been updated to the {{content.plan}} plan.",
+    button: {
+      label: "Manage Your Plan",
+      url: "{{domain}}/account/billing",
+    },
+  },
+  "card-updated": {
+    subject: "Credit Card Information Updated",
+    body: "Confirmation: Your credit card information has been updated. Contact us immediately if you did not authorize this change.",
+    button: {
+      label: "Contact Support",
+      url: "mailto:support@yourdomain.com",
+    },
+  },
+  "account-closed": {
+    subject: "Account Closure Confirmation",
+    body: "Your account has been closed and all associated data has been removed from our servers. You're welcome to rejoin ProPro anytime.",
+    button: {
+      label: "Sign Up",
+      url: "{{domain}}/signup",
+    },
+  },
+  "invite-accepted": {
+    subject: "Team Invitation Accepted",
+    body: "Great news! {{content.friend}} has accepted your invitation to join your ProPro team.",
+    button: {
+      label: "Invite More Friends",
+      url: "{{domain}}/account/users",
+    },
+  },
+  "password-updated": {
+    subject: "Password Change Confirmation",
+    body: "Your ProPro password has been changed. If you did not initiate this change, please contact our support team immediately.",
+    button: {
+      label: "Contact Support",
+      url: "mailto:support@yourdomain.com",
+    },
+  },
+  "password-reset": {
+    subject: "Password Reset Request",
+    title: "Forgot Your ProPro Password?",
+    body: "To reset your password, click the link below.",
+    button: {
+      label: "Reset Password",
+      url: "{{domain}}?token={{content.token}}",
+    },
+  },
+  invite: {
+    subject: "Team Invitation from a Friend",
+    body: "You've been invited by {{content.friend}} to join their ProPro team. Sign up now to collaborate.",
+    button: {
+      label: "Sign Up Now",
+      url: "{{domain}}?id={{content.id}}&email={{content.email}}",
+    },
+  },
+  contact: {
+    subject: "New Contact Form Submission",
+    body: "You've received a new message from {{content.name}}: <br><br> {{content.message}}",
+    button: {
+      label: "Respond Now",
+      url: "mailto:{{content.email}}",
+    },
+  },
+  feedback: {
+    subject: "New App Feedback Received",
+    body: "New feedback for your ProPro app: <br><br> Rating: {{content.rating}} <br><br>{{content.comment}}",
+    button: {
+      label: "View Now",
+      url: "{{content.url}}",
+    },
+  },
+  magic_signin: {
+    subject: "Your ProPro Magic Sign-In Link",
+    body: "You requested a magic sign-in link for ProPro. Click below to sign in without a password.",
+    button: {
+      label: "Sign In",
+      url: "{{domain}}?token={{content.token}}",
+    },
+  },
+  new_signin: {
+    subject: "New Sign-In Alert for ProPro",
+    body: "A new sign-in to your ProPro account was detected: \n\n{{content.browser}} on {{content.device}}\n\nIP: {{content.ip}}\n\nTime: {{content.time}}\n\nIf this was you, no action is needed. If not, please secure your account.",
+    button: {
+      label: "Secure My Account",
+      url: "{{domain}}/account/security",
+    },
+  },
+  blocked_signin: {
+    subject: "Blocked Suspicious Sign-In Attempt",
+    body: "A suspicious sign-in attempt to your ProPro account was blocked. If this was you, use the link below to sign in securely.",
+    button: {
+      label: "Sign In Securely",
+      url: "{{domain}}?token={{content.token}}",
+    },
+  },
+  help: {
+    subject: "New Support Request Received",
+    body: "A new support request has been submitted by {{content.name}}: <br><br> {{content.message}}",
+    button: {
+      label: "Respond Now",
+      url: "mailto:{{content.email}}",
+    },
+  },
+  "new-log": {
+    subject: "New Log Recorded in ProPro",
+    body: "A new log has been recorded in your ProPro application. Check Mission Control for details.",
+    button: {
+      label: "View Log",
+      url: "{{domain}}/missioncontrol/logs/{{content.id}}",
+    },
+  },
+  email_verification: {
+    subject: "Verify Your ProPro Email",
+    body: "Thanks for signing up to ProPro. Click the link below to verify your email address.",
+    button: {
+      label: "Verify Your Email",
+      url: "{{domain}}?token={{content.verification_token}}",
+    },
+  },
+  email_verification_complete: {
+    subject: "Email Verified - Welcome to ProPro",
+    body: "Your email address has been verified. Your ProPro account is now active.",
+    button: {
+      label: "Open Dashboard",
+      url: "{{domain}}/dashboard",
+    },
+  },
+  "new-email": {
+    subject: "Email Address Change Confirmation",
+    body: "You have changed your email address for your ProPro account. If you did not authorize this change, please contact us immediately.",
+    button: {
+      label: "Contact Support",
+      url: "mailto:support@yourdomain.com",
+    },
+  },
+  otp_request: {
+    subject: "Your ProPro One-Time Password",
+    body: "Your ProPro one-time password (OTP) is: {{content.otp}}",
+    additionalInfo: "This password will expire in 10 minutes.",
+  },
+  subscription_expiry: {
+    subject: "Your ProPro Subscription is Expiring",
+    body: "Your ProPro subscription will expire in {{content.days}} days. Renew now to continue enjoying our services.",
+    button: {
+      label: "Renew Subscription",
+      url: "{{domain}}/account/billing",
+    },
+  },
+  payment_failure: {
+    subject: "Your ProPro Payment Failed",
+    body: "We were unable to process your payment. Please update your billing information to avoid interruption of your ProPro services.",
+    button: {
+      label: "Update Billing Information",
+      url: "{{domain}}/account/billing",
+    },
+  },
+  account_recovery: {
+    subject: "ProPro Account Recovery",
+    body: "To recover your ProPro account, please click the link below.",
+    button: {
+      label: "Recover Account",
+      url: "{{domain}}?token={{content.token}}",
+    },
+  },
+  account_verified: {
+    subject: "Your ProPro Account is Verified",
+    body: "Your ProPro account is now verified. You can now use all the features available.",
+    button: {
+      label: "Get Started",
+      url: "{{domain}}/dashboard",
+    },
+  },
+  account_verification_failed: {
+    subject: "ProPro Account Verification Failed",
+    body: "Your attempt to verify your ProPro account failed. Please try again or contact support if you continue to have issues.",
+    button: {
+      label: "Contact Support",
+      url: "mailto:support@yourdomain.com",
+    },
+  },
+  report_ready: {
+    subject: "Your ProPro Report is Ready",
+    body: "Your requested report from ProPro is now ready for download.",
+    button: {
+      label: "Download Report",
+      url: "{{domain}}/report/{{content.id}}",
+    },
+  },
+  welcome_message: {
+    subject: "Welcome to ProPro!",
+    body: "We're excited to have you on board. Discover the possibilities and features available with ProPro.",
+    button: {
+      label: "Get Started",
+      url: "{{domain}}/dashboard",
+    },
+  },
+  congratulations: {
+    subject: "Congratulations from ProPro",
+    body: "Congratulations on reaching a new milestone with ProPro!",
+    button: {
+      label: "Celebrate Now",
+      url: "{{domain}}/rewards",
+    },
+  },
+  newsletter: {
+    subject: "ProPro Newsletter - {{content.month}}",
+    body: "Catch up on the latest news and updates from ProPro in our monthly newsletter.",
+    button: {
+      label: "Read Now",
+      url: "{{domain}}/newsletter/{{content.id}}",
+    },
+  },
+  security_alert: {
+    subject: "Security Alert: New Device Signed in to ProPro",
+    body: "A new device has just signed into your ProPro account. If this was you, you can safely ignore this email. If it wasn't you, please secure your account.",
+    button: {
+      label: "Secure My Account",
+      url: "{{domain}}/account/security",
+    },
+  },
+  promotion: {
+    subject: "Special Promotion Just for You from ProPro",
+    body: "We have a special promotion just for you. Unlock your exclusive deal from ProPro now.",
+    button: {
+      label: "Unlock Now",
+      url: "{{domain}}/promotions",
+    },
+  },
+  thank_you: {
+    subject: "Thank You for Choosing ProPro",
+    body: "Thank you for being a valued member of the ProPro community. We're glad to have you with us.",
+    button: {
+      label: "Explore More",
+      url: "{{domain}}/dashboard",
+    },
+  },
+  goodbye: {
+    subject: "Goodbye from ProPro",
+    body: "We're sad to see you go. If you ever decide to come back, ProPro will be here waiting for you.",
+    button: {
+      label: "Come Back",
+      url: "{{domain}}/signup",
+    },
+  },
+  confirmation: {
+    subject: "Action Required: Confirm Your Action",
+    body: "Please confirm your action by clicking the button below.",
+    button: {
+      label: "Confirm",
+      url: "{{domain}}?token={{content.token}}",
+    },
+  },
+});
+
+module.exports = {
+  templateData,
+};

package/notify/testemail.js

@@ -0,0 +1,15 @@
+const { EmailNotificationStrategy } = require("./emailStrategy");
+const { NotificationService } = require("./notificationService");
+
+const notificationService = new NotificationService(
+  new EmailNotificationStrategy()
+);
+
+notificationService
+  .sendNotification("chidosiky2015@gmail.com", "new-account")
+  .then(() => {
+    console.log("Email sent");
+  })
+  .catch((error) => {
+    console.log("Error sending email", error);
+  });

package/notify/twilloStrategy.js

@@ -0,0 +1,30 @@
+const twilio = require("twilio");
+const { NotificationStrategy } = require("./baseStrategy");
+
+/**
+ * Twilio SMS Notification Strategy class.
+ * @class
+ * @extends NotificationStrategy
+ */
+class TwilioSMSNotificationStrategy extends NotificationStrategy {
+  constructor() {
+    super();
+    this.twilioClient = twilio(
+      process.env.TWILIO_ACCOUNT_SID,
+      process.env.TWILIO_AUTH_TOKEN
+    );
+  }
+
+  async sendNotification(to, message) {
+    const response = await this.twilioClient.messages.create({
+      to,
+      from: process.env.TWILIO_PHONE_NUMBER,
+      body: message,
+    });
+    return response.sid;
+  }
+}
+
+module.exports = {
+  TwilioSMSNotificationStrategy,
+};

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "propro-utils",
+  "version": "1.3.8",
+  "description": "Auth middleware for propro-auth",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "email": "email dev ",
+    "build": "babel notify --out-dir dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/propro-productions/propro-auth-middleware.git"
+  },
+  "keywords": [
+    "auth",
+    "middleware",
+    "propro-auth"
+  ],
+  "author": "ProPro",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/propro-productions/propro-auth-middleware/issues"
+  },
+  "presets": [
+    "@babel/preset-env",
+    "@babel/preset-react"
+  ],
+  "babel": {
+    "presets": [
+      "@babel/preset-env",
+      "@babel/preset-react"
+    ]
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.23.4",
+    "@babel/core": "^7.23.5",
+    "@babel/preset-env": "^7.23.5",
+    "@babel/preset-react": "^7.23.3"
+  },
+  "homepage": "https://github.com/propro-productions/propro-auth-middleware#readme",
+  "dependencies": {
+    "@react-email/button": "0.0.9",
+    "@react-email/column": "^0.0.8",
+    "@react-email/components": "^0.0.11",
+    "@react-email/container": "0.0.8",
+    "@react-email/font": "^0.0.4",
+    "@react-email/head": "^0.0.6",
+    "@react-email/heading": "^0.0.9",
+    "@react-email/hr": "^0.0.6",
+    "@react-email/html": "0.0.4",
+    "@react-email/img": "0.0.5",
+    "@react-email/link": "^0.0.6",
+    "@react-email/markdown": "^0.0.7",
+    "@react-email/preview": "^0.0.7",
+    "@react-email/render": "0.0.7",
+    "@react-email/row": "^0.0.6",
+    "@react-email/section": "0.0.9",
+    "@react-email/tailwind": "^0.0.12",
+    "@react-email/text": "0.0.5",
+    "axios": "^1.6.1",
+    "dotenv": "^16.3.1",
+    "express-rate-limit": "^7.1.4",
+    "nodemailer": "^6.9.7",
+    "nodemailer-mailgun-transport": "^2.1.5",
+    "querystring": "^0.2.1",
+    "react-email": "^1.9.5"
+  }
+}

package/src/.env.example

@@ -0,0 +1,5 @@
+CLIENT_ID=07929acf-f4ef-458f-889f-db49f37ba54c
+CLIENT_SECRET=$2a$10$FK5KnYQXfXHAIO2d8U4QgO9q5wl/hdiNthIgK91.HbqebSgsQb2Eq
+REDIRECT_URI=localhost:8182/api/v1/auth/callback
+AUTH_URL=localhost:8182/api/v1/auth
+CLIENT_URL=localhost:3000

package/src/client/index.js

@@ -0,0 +1,24 @@
+import axios from 'axios';
+
+const setupClientMiddleware = () => {
+  axios.interceptors.request.use(function (config) {
+    const token = localStorage.getItem('token');
+    if (token) {
+      config.headers.Authorization = `Bearer ${token}`;
+    }
+    return config;
+  }, function (error) {
+    return Promise.reject(error);
+  });
+
+  axios.interceptors.response.use(function (response) {
+    return response;
+  }, function (error) {
+    if (error.response.status === 401) {
+      localStorage.removeItem('token');
+    }
+    return Promise.reject(error);
+  });
+};
+
+export default setupClientMiddleware;