nitro-web 0.2.6 → 0.2.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nitro-web",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "repository": "github:boycce/nitro-web",
   "homepage": "https://boycce.github.io/nitro-web/",
   "description": "Nitro is a battle-tested, modular base project to turbocharge your projects, styled using Tailwind 🚀",

package/server/email/index.js

@@ -27,6 +27,7 @@ export const optionalEmailConfigKeys = ['emailReplyTo', 'emailTestMode', 'mailgu
  * @param {Config} opts.config - Config object
  * @param {string} [opts.bcc] - BCC, e.g. "Bruce<bruce@wayneenterprises.com>" (not sent in development)
  * @param {object} [opts.data] - template data shared across recipients
+ * @param {object} [opts.swigData] - vars for Nunjucks/Swig render only (not sent to Mailgun)
  * @param {string} [opts.from] - sender address, e.g. "Bruce<bruce@wayneenterprises.com>"
  * @param {string} [opts.replyTo] - reply-to address, e.g. "Bruce<bruce@wayneenterprises.com>"
  * @param {object} [opts.recipientVariables] - Mailgun recipient-variables for batch sending
@@ -40,7 +41,8 @@ export async function sendEmail({
   to, 
   config,
   bcc, 
-  data, 
+  data,
+  swigData,
   from, 
   replyTo, 
   recipientVariables, 
@@ -69,6 +71,17 @@ export async function sendEmail({
   // From, replayTo
   from = from || config.emailFrom
   replyTo = replyTo || config.emailReplyTo || from
+
+  if (swigData) {
+    swigData = {
+      configName: ucFirst(config.name),
+      domain: config.baseUrl,
+      replyToEmail: getNameEmail(replyTo)[1],
+      replyToName: getNameEmail(replyTo)[0],
+      ...swigData,
+    }
+  }
+
   const toSplit = to.split(',')
 
   // Add default recipientVariables
@@ -103,6 +116,7 @@ export async function sendEmail({
     test: isTest,
     to: to,
     url: config.baseUrl,
+    swigData: swigData,
   }
 
   // Grab html and send
@@ -114,36 +128,36 @@ export async function sendEmail({
 async function getTemplate(settings) {
   try {
     var templateName = settings.template
-    if (!templates[templateName] || settings.isDev) {
-      nunjucks.configure({ noCache: settings.isDev })
-      // Setup the nunjucks environment
-      let nunjucksEnv = new nunjucks.Environment([
-        new nunjucks.FileSystemLoader(`${settings.emailTemplateDir}`), // user templates take precedence
-        new nunjucks.FileSystemLoader(`${_dirname}`), // then fallback to nitro default templates
-      ])
-      // Get the template
-      let template = nunjucksEnv.getTemplate(templateName + '.html', true)
-      // Render the template
-      let html = template.render({})
-      if (settings.skipCssInline && settings.test) {
-        templates[templateName] = html
-      } else {
-        try { 
-          // First try to inline the CSS from the user templates directory
-          templates[templateName] = await inlineCssForPath(html, settings.emailTemplateDir)
-        } catch (e) {
-          // If the CSS is not found, use default nitro CSS file
-          if (templateName == 'reset-password' || templateName == 'welcome') {
-            templates[templateName] = await inlineCssForPath(html, `${_dirname}`)
-          } else {
-            throw e
-          }
+    // Return cached template (if there is no swig data)
+    if (templates[templateName] && !settings.isDev && !settings.swigData) {
+      return templates[templateName]
+    }
+    // Setup the nunjucks environment
+    nunjucks.configure({ noCache: settings.isDev })
+    let nunjucksEnv = new nunjucks.Environment([
+      new nunjucks.FileSystemLoader(`${settings.emailTemplateDir}`), // user templates take precedence
+      new nunjucks.FileSystemLoader(`${_dirname}`), // then fallback to nitro default templates
+    ])
+    // Get the template
+    let template = nunjucksEnv.getTemplate(templateName + '.html', true)
+    let html = template.render(settings.swigData || {})
+    // Inline CSS
+    if (!settings.skipCssInline || !settings.test) {
+      try {
+        // First try to inline the CSS from the user templates directory
+        html = await inlineCssForPath(html, settings.emailTemplateDir)
+      } catch (e) {
+        // If the CSS is not found, use default nitro CSS file
+        if (templateName == 'reset-password' || templateName == 'welcome') {
+          html = await inlineCssForPath(html, `${_dirname}`)
+        } else {
+          throw e
         }
       }
-      return templates[templateName]
-    } else {
-      return templates[templateName]
     }
+    // Cache the template (if there is no swig data)
+    if (!settings.swigData) templates[templateName] = html
+    return html
   } catch (e) {
     console.error(`Sendmail: issue retrieving the email template "${templateName}.html"`)
     console.error(e)

package/server/router.js

@@ -140,6 +140,7 @@ export async function setupRouter (config) {
           test: true,
           skipCssInline: true,
           to: 'Ricky<test@gmail.com>',
+          swigData: {},
         })
         res.send(html)
       } catch (e) {

package/types/server/email/index.d.ts

@@ -8,6 +8,7 @@
  * @param {Config} opts.config - Config object
  * @param {string} [opts.bcc] - BCC, e.g. "Bruce<bruce@wayneenterprises.com>" (not sent in development)
  * @param {object} [opts.data] - template data shared across recipients
+ * @param {object} [opts.swigData] - vars for Nunjucks/Swig render only (not sent to Mailgun)
  * @param {string} [opts.from] - sender address, e.g. "Bruce<bruce@wayneenterprises.com>"
  * @param {string} [opts.replyTo] - reply-to address, e.g. "Bruce<bruce@wayneenterprises.com>"
  * @param {object} [opts.recipientVariables] - Mailgun recipient-variables for batch sending
@@ -16,12 +17,13 @@
  * @param {boolean} [opts.test] - enable test mode
  * @returns {Promise<[any, any]>} Resolves with [mailgunErr, mailgunInfo]
  */
-export function sendEmail({ template, to, config, bcc, data, from, replyTo, recipientVariables, subject, skipCssInline, test, }: {
+export function sendEmail({ template, to, config, bcc, data, swigData, from, replyTo, recipientVariables, subject, skipCssInline, test, }: {
     template: string;
     to: string;
     config: Config;
     bcc?: string;
     data?: object;
+    swigData?: object;
     from?: string;
     replyTo?: string;
     recipientVariables?: object;

package/types/server/email/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../server/email/index.js"],"names":[],"mappings":"AAmBA;;;;;;;;;;;;;;;;;GAiBG;AACH,iIAbG;IAAqB,QAAQ,EAArB,MAAM;IACO,EAAE,EAAf,MAAM;IACO,MAAM,EAAnB,MAAM;IACQ,GAAG,GAAjB,MAAM;IACQ,IAAI,GAAlB,MAAM;IACQ,IAAI,GAAlB,MAAM;IACQ,OAAO,GAArB,MAAM;IACQ,kBAAkB,GAAhC,MAAM;IACQ,OAAO,GAArB,MAAM;IACS,aAAa,GAA5B,OAAO;IACQ,IAAI,GAAnB,OAAO;CACf,GAAU,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CA4E/B;AAhGD,+CAA8E;AAC9E,+CAAuG;;;;qBAK1F;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../server/email/index.js"],"names":[],"mappings":"AAmBA;;;;;;;;;;;;;;;;;;GAkBG;AACH,2IAdG;IAAqB,QAAQ,EAArB,MAAM;IACO,EAAE,EAAf,MAAM;IACO,MAAM,EAAnB,MAAM;IACQ,GAAG,GAAjB,MAAM;IACQ,IAAI,GAAlB,MAAM;IACQ,QAAQ,GAAtB,MAAM;IACQ,IAAI,GAAlB,MAAM;IACQ,OAAO,GAArB,MAAM;IACQ,kBAAkB,GAAhC,MAAM;IACQ,OAAO,GAArB,MAAM;IACS,aAAa,GAA5B,OAAO;IACQ,IAAI,GAAnB,OAAO;CACf,GAAU,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAyF/B;AA9GD,+CAA8E;AAC9E,+CAAuG;;;;qBAK1F;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE"}

package/types/server/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../server/router.js"],"names":[],"mappings":"AAoCA,uGAAuG;AACvG,0CADc,OAAO,CAAC;IAAE,MAAM,EAAE,OAAO,MAAM,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,OAAO,SAAS,EAAE,WAAW,CAAA;CAAE,CAAC,CA+HlG;AAkPD,+CAEC;AAED,kEAYC;AAzGD,+BAA+B;AAC/B,yBADW,gBAAgB,CAuF1B;sBAnYY,OAAO,CAAC,OAAO,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAoB,CAAC;CAC7B;uBACS,OAAO,CAAC,QAAQ,GAAG;IAC3B,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACjE,YAAY,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;IACvD,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;IACpD,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;IACnD,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;CACvD;+BACS;IACR,KAAK,EAAE,MAAM,EAAE,CAAC;IACpB,CAAK,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,UAAU,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC;CACnF;oBAtBgB,SAAS"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../server/router.js"],"names":[],"mappings":"AAoCA,uGAAuG;AACvG,0CADc,OAAO,CAAC;IAAE,MAAM,EAAE,OAAO,MAAM,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,OAAO,SAAS,EAAE,WAAW,CAAA;CAAE,CAAC,CAgIlG;AAkPD,+CAEC;AAED,kEAYC;AAzGD,+BAA+B;AAC/B,yBADW,gBAAgB,CAuF1B;sBApYY,OAAO,CAAC,OAAO,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAoB,CAAC;CAC7B;uBACS,OAAO,CAAC,QAAQ,GAAG;IAC3B,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACjE,YAAY,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;IACvD,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;IACpD,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;IACnD,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;CACvD;+BACS;IACR,KAAK,EAAE,MAAM,EAAE,CAAC;IACpB,CAAK,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,UAAU,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC;CACnF;oBAtBgB,SAAS"}