Merge pull request #32 from funkenstrahlen/patch-1

Fix syntax errors in mail adapter configuration example & use current mailgun adapter setup

Author: mtrezza

.github/workflows/ci.yml

@@ -67,7 +67,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-${{ matrix.NODE_VERSION }}-
       - run: npm ci
-      - run: npm run lint
       - run: npm test
         env:
           CI: true

CHANGELOG.md

@@ -23,42 +23,24 @@ Jump directly to a version:
 *(none)*
 
 ### 🧬 Other Changes
-*(none)*
+- Fixed demo script and README for `mailgun.js` 3.x which requires `form-data` (Stefan Trauth, Manuel Trezza) [#32](https://github.com/mtrezza/parse-server-api-mail-adapter/pull/32)
 
 # 1.0.7
 [Full Changelog](https://github.com/mtrezza/parse-server-api-mail-adapter/compare/1.0.6...1.0.7)
 
-### ⚠️ Breaking Changes
-*(none)*
-
-### 🚀 Notable Changes
-*(none)*
-
 ### 🧬 Other Changes
 - Added supported providers to README (Manuel Trezza) [#34](https://github.com/mtrezza/parse-server-api-mail-adapter/pull/34)
 - Bump postcss from 8.2.9 to 8.2.15 (dependabot) [#37](https://github.com/mtrezza/parse-server-api-mail-adapter/pull/37)
 
 # 1.0.6
 [Full Changelog](https://github.com/mtrezza/parse-server-api-mail-adapter/compare/1.0.5...1.0.6)
 
-### ⚠️ Breaking Changes
-*(none)*
-
-### 🚀 Notable Changes
-*(none)*
-
 ### 🧬 Other Changes
 - Fixes failing to send email in Cloud Code without template (Manuel Trezza) [#26](https://github.com/mtrezza/parse-server-api-mail-adapter/pull/26)
 
 # 1.0.5
 [Full Changelog](https://github.com/mtrezza/parse-server-api-mail-adapter/compare/1.0.4...1.0.5)
 
-### ⚠️ Breaking Changes
-*(none)*
-
-### 🚀 Notable Changes
-*(none)*
-
 ### 🧬 Other Changes
 - Fixes undefined `user` in `localeCallback` when sending email via `Parse.Cloud.sendEmail()` (wlky, Manuel Trezza) [#18](https://github.com/mtrezza/parse-server-api-mail-adapter/pull/18)
 

README.md

@@ -58,8 +58,12 @@ You can modify the script to use any other API you like or debug-step through th
 An example configuration to add the API Mail Adapter to Parse Server could look like this:
 
 ```js
+const Mailgun = require('mailgun.js');
+const formData = require('form-data');
+const { ApiPayloadConverter } = require('parse-server-api-mail-adapter');
+
 // Configure mail client
-const mailgun = require('mailgun.js');
+const mailgun = new Mailgun(formData);
 const mailgunClient = mailgun.client({ username: 'api', key: process.env.MAILGUN_API_KEY });
 const mailgunDomain = process.env.MAILGUN_DOMAIN;
 
@@ -77,24 +81,24 @@ const server = new ParseServer({
                 // The template used by Parse Server to send an email for password
                 // reset; this is a reserved template name.
                 passwordResetEmail: {
-                    subjectPath: './files/password_reset_email_subject.txt'),
-                    textPath: './files/password_reset_email.txt'),
-                    htmlPath: './files/password_reset_email.html')
+                    subjectPath: './files/password_reset_email_subject.txt',
+                    textPath: './files/password_reset_email.txt',
+                    htmlPath: './files/password_reset_email.html'
                 },
                 // The template used by Parse Server to send an email for email
                 // address verification; this is a reserved template name.
                 verificationEmail: {
-                    subjectPath: './files/verification_email_subject.txt'),
-                    textPath: './files/verification_email.txt'),
-                    htmlPath: './files/verification_email.html')
+                    subjectPath: './files/verification_email_subject.txt',
+                    textPath: './files/verification_email.txt',
+                    htmlPath: './files/verification_email.html'
                 },
                 // A custom email template that can be used when sending emails
                 // from Cloud Code; the template name can be chosen freely; it
                 // is possible to add various custom templates.
                 customEmail: {
-                    subjectPath: './files/custom_email_subject.txt'),
-                    textPath: './files/custom_email.txt'),
-                    htmlPath: './files/custom_email.html'),
+                    subjectPath: './files/custom_email_subject.txt',
+                    textPath: './files/custom_email.txt',
+                    htmlPath: './files/custom_email.html',
                     // Placeholders are filled into the template file contents.
                     // For example, the placeholder `{{appName}}` in the email
                     // will be replaced the value defined here.
@@ -144,9 +148,9 @@ Emails are composed using templates. A template defines the paths to its content
 ```js
 templates: {
     exampleTemplate: {
-        subjectPath: './files/custom_email_subject.txt'),
-        textPath: './files/custom_email.txt'),
-        htmlPath: './files/custom_email.html'),
+        subjectPath: './files/custom_email_subject.txt',
+        textPath: './files/custom_email.txt',
+        htmlPath: './files/custom_email.html',
     }
 },
 ```
@@ -300,4 +304,4 @@ const server = new ParseServer({
 # Need help?
 
 - Ask on StackOverflow using the [parse-server](https://stackoverflow.com/questions/tagged/parse-server) tag.
-- Search through existing [issues](https://github.com/mtrezza/parse-server-api-mail-adapter/issues) or open a new issue.
+- Search through existing [issues](https://github.com/mtrezza/parse-server-api-mail-adapter/issues) or open a new issue.

demo/index.js

@@ -1,11 +1,14 @@
+'use strict';
+
 /**
  * ==============================================================
  * Demo script to send an email using the Mailgun API.
  * ==============================================================
  * Instructions:
  *
- * 1. Create a file `mailgun.json` in the root directory with the
- * following keys to configure the test script:
+ * 1. Create a file `mailgun.json` in the directory of this demo
+ * script with the following keys to configure the demo script:
+ *
  * ```
  * {
  *   key: "xxx", // The Mailgun API key.
@@ -16,13 +19,14 @@
  * }
  * ```
  *
- * 2. Run this script with `node ./demo` to send the email.
+ * 2. Run this script with `node ./demo` to send an email. 🤞
  * ==============================================================
  */
 
 const ApiMailAdapter = require('../src/ApiMailAdapter');
 const ApiPayloadConverter = require('../src/ApiPayloadConverter');
-const mailgun = require('mailgun.js');
+const formData = require("form-data");
+const Mailgun = require('mailgun.js');
 const path = require('path');
 
 const {
@@ -32,7 +36,11 @@ const {
   recipient
 } = require('./mailgun.json');
 
-const mailgunClient = mailgun.client({ username: 'api', key: key });
+// Declare mail client
+const mailgun = new Mailgun(formData);
+const mailgunClient = mailgun.client({ username: "api", key });
+
+// Configure mail client
 const filePath = (file) => path.resolve(__dirname, '../spec/templates/', file);
 const config = {
   sender: sender,

package-lock.json

@@ -39,6 +39,7 @@
     "codecov": "3.8.1",
     "eslint": "7.22.0",
     "eslint-plugin-flowtype": "5.4.0",
+    "form-data": "4.0.0",
     "jasmine": "3.6.4",
     "madge": "4.0.2",
     "mailgun.js": "3.2.1",