https://github.com/armandj77-zz/io-email-worker-core
Core Library for mjml email parsing used in IO-Email-Worker and IO-Email-Worker-Utility
https://github.com/armandj77-zz/io-email-worker-core
Last synced: 7 months ago
JSON representation
Core Library for mjml email parsing used in IO-Email-Worker and IO-Email-Worker-Utility
- Host: GitHub
- URL: https://github.com/armandj77-zz/io-email-worker-core
- Owner: ArmandJ77-zz
- License: mit
- Created: 2019-11-09T14:33:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-28T10:44:55.000Z (over 5 years ago)
- Last Synced: 2025-03-20T21:11:20.612Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 241 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Notice: Development has been paused on this project
# IO Email Worker Core
This is a core library used by the [IO-Email-Worker](https://github.com/ArmandJ77/IO-Email-Worker) and [IO-Email-Worker-Utility](https://github.com/ArmandJ77/IO-Email-Worker-Utility) for the parsing, conversion and sending of an mjml template as HTML to predefined smtp accounts using nodemailer.
## How to use
Install:
`npm i io-email-worker-core --save-dev`
Import
`import IO_EWC from 'io-email-worker-core'`
The interface:
```
IO_EWC.validateStructure(rawData, template); => returns a customResponseObject
IO_EWC.validateValues(rawData, template); => returns a customResponseObject
IO_EWC.injectData(rawData, template); => returns a customResponseObject
IO_EWC.generate(rawData, template); => returns a customResponseObject
IO_EWC.send(smtpAccount, emailOptionsCollection); => returns a promise
IO_EWC.generateAndSend(rawData, template); => returns a promise
```
If the modules section is TL;DR simply:
`let result = IO_EWC.generateAndSend(rawData, dataTemplate, emailTemplate);`
gg easy :D, but note this approach uses the DISTRIBUTION_EMAIL_ADDRESS & DISTRIBUTION_EMAIL_PASSWORD configured in the .env file. Later versions would be more generic and support different email providers other than gmail.
## Modules
### Structure Validation Handler
This module uses the raw data json structure and compares it to with the data template json. Validation will fail if nodes are missing.
Currently this does not support multi layered nodes, so keep it to a flat structure and you should be good.
To validate the json structure use:
usage:
`let result = IO_EWC.validateStructure(dataTemplate, rawData);`
result:
```
[
{
index: 0,
isSuccess: true,
errors: null
}
]
```
Failed results have the same data structure as value validation.
### Value Validation Handler
This takes the content of the raw data json and verifies that it adheres to the content types and validation rules of the data template. Like type checks, null checks, required fields, data format ect. Note for date format use the momentjs documentation.
To validate the json structure use:
usage:
`let result = IO_EWC.validateValues(dataTemplate, rawData);`
Success result:
```
{
isSuccess: true,
errors: []
}
```
Example of failed result:
```
{
isSuccess: false,
errors: [
'valueRequired check failed on node 0: Name value ',
'number check failed on node 0: Age value sdfasdfasdf',
'email check failed on node 0: Email value rocketman9000',
'boolean check failed on node 0: HasCarInSpace value qwerty',
'valueRequired check failed on node 1: HasCarInSpace value ',
'boolean check failed on node 1: HasCarInSpace value '
]
}
```
### Data Injection Handler
Takes the raw data and injects it into the handlebars variables
usage:
`let result = IO_EWC.injectData(rawData, emailTemplate);`
result:
```
{
isSuccess: true,
data:
[
{
rawDataIndex: 0,
sendToEmail: 'rocketman9000@marsmail.com',
data: 'Your email template with data injected'
}
]
}
```
### Generation Handler
Takes in a mjml formatted template and parses it to HTML.
Goes without saying that you might want to use the result of the data injection or you could roll your own.
usage:
`let result = IO_EWC.generate(dataInjectionResult.data);`
result:
```
{
isSuccess: true,
data: [
{
rawDataIndex: 0,
sendToEmail: 'rocketman9000@marsmail.com',
data: 'string of your generated html'
}
]
}
```
### Distribution Handler
This handler uses the result of the generate function's data node and returns a promise as the email sending is async
usage:
```
IO_EWC.send(
smtpAccount,
generationResult.data // or an array of emailCollection
)
.then(res => console.log(res))
.catch(ex => console.log(ex));
```
## JSON Data Structure
```
AValidDataStructure:{
data: {
emailTemplate:
'a { text-decoration: none!important; }NAG LANHi! {{Name}} {{Surname}}, Special pre sale informationLorem ipsum dolor sit amet, consectetur adipiscing elit. Proin rutrum enim eget magna efficitur, eu semper augue semper. Aliquam erat volutpat. Proin rutrum enim eget magna efficitur.',
dataTemplate: {
properties: [
{
key: "Email",
validation: {
valueRequired: true,
type: "email"
}
},
{
key: "Name",
validation: {
valueRequired: true,
type: "string"
}
},
{
key: "Surname",
validation: {
valueRequired: true,
type: "string"
}
},
{
key: "Age",
validation: {
valueRequired: true,
type: "number"
}
},
{
key: "HasCarInSpace",
validation: {
valueRequired: true,
type: "boolean"
}
},
{
key: "DOB",
validation: {
valueRequired: true,
type: "date",
format: "YYYY MM DD"
}
}
]
},
rawData: [
{
Name: "Elon",
Surname: "Musk",
Age: 48,
Email: "rocketman9000@marsmail.com",
HasCarInSpace: "true",
DOB: "1971-06-28"
},
{
Name: "Jeff",
Surname: "Bezos",
Age: 55,
Email: "jungleking@amazon.com",
HasCarInSpace: "false",
DOB: "1964-01-12"
}
]
}
```
```
smtpAccount: {
service: "gmail",
auth: {
user: DISTRIBUTION_EMAIL_ADDRESS,
pass: DISTRIBUTION_EMAIL_PASSWORD
}
}
```
```
emailCollection: [
{
from: DISTRIBUTION_EMAIL_ADDRESS,
to: recipient_of_the_mail,
subject: email_subject,
body: the_html_of_your_email
}
}
```
```
customResponseObject:{
isSuccess: bool,
data: object, => if applicable
error: string
}
```