index.js

  1. /**
  2.  * https://github.com/ecomclub/transactional-mails
  3.  * @author E-Com Club <ti@e-com.club>
  4.  * @license MIT
  5.  */
  7. 'use strict'
  9. // Node.js i18n support
  10. require('./intl')
  12. // template render function
  13. const render = require('./lib/render')
  15. /**
  16.  * Default transactional email templates for E-Com Plus stores.
  17.  * @module @ecomplus/transactional-mails
  18.  * @exports {@link templates}
  19.  * @example
  20.  * const transactionalMails = require('@ecomplus/transactional-mails')
  21.  */
  23. module.exports = {
  25.   /**
  26.    * @method
  27.    * @memberof transactionalMails
  28.    * @description Returns HTML markup for customer welcome email.
  29.    * @param {object} store - Store body object
  30.    * @param {object} customer - Customer body object
  31.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  32.    * @param {string} [customMessage] - Custom text for the main template phrase
  33.    * @returns {Promise}
  34.    *
  35.    * @example
  37. transactionalMails.welcome(store, customer, 'pt_br', 'Hello {name}, welcome to our Shop!')
  38.   .then(html => sendEmail(html, options))
  39.   .catch(err => console.error(err))
  41.    */
  43.   welcome (store, customer, lang, customMessage) {
  44.     return render('welcome', {
  45.       store,
  46.       customer,
  47.       custom_message: customMessage
  48.     }, store, lang)
  49.   },
  51.   /**
  52.    * @method
  53.    * @memberof transactionalMails
  54.    * @description Returns HTML markup for abandoned cart email.
  55.    * @param {object} store - Store body object
  56.    * @param {object} customer - Customer body object
  57.    * @param {object} cart - Cart body object
  58.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  59.    * @param {string} [customMessage] - Custom text for the main template phrase
  60.    * @returns {Promise}
  61.    *
  62.    * @example
  64. transactionalMails.abandonedCart(store, customer, cart, 'pt_br')
  65.   .then(html => sendEmail(html, options))
  66.   .catch(err => console.error(err))
  68.    */
  70.   abandonedCart (store, customer, cart, lang, customMessage) {
  71.     return render('abandoned-cart', {
  72.       store,
  73.       customer,
  74.       cart,
  75.       custom_message: customMessage
  76.     }, store, lang)
  77.   },
  79.   /**
  80.    * @method
  81.    * @memberof transactionalMails
  82.    * @description Returns HTML markup for pending payment email.
  83.    * @param {object} store - Store body object
  84.    * @param {object} customer - Customer body object
  85.    * @param {object} order - Order body object
  86.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  87.    * @param {string} [customMessage] - Custom text for the main template phrase
  88.    * @returns {Promise}
  89.    *
  90.    * @example
  92. transactionalMails.pending(store, customer, order, 'pt_br')
  93.   .then(html => sendEmail(html, options))
  94.   .catch(err => console.error(err))
  96.    */
  98.   pending (store, customer, order, lang, customMessage) {
  99.     return render('pending', {
  100.       store,
  101.       customer,
  102.       order,
  103.       custom_message: customMessage
  104.     }, store, lang)
  105.   },
  107.   /**
  108.    * @method
  109.    * @memberof transactionalMails
  110.    * @description Returns HTML markup for delivered order email.
  111.    * @param {object} store - Store body object
  112.    * @param {object} customer - Customer body object
  113.    * @param {object} order - Order body object
  114.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  115.    * @param {string} [customMessage] - Custom text for the main template phrase
  116.    * @returns {Promise}
  117.    *
  118.    * @example
  120. transactionalMails.delivered(store, customer, order, 'pt_br')
  121.   .then(html => sendEmail(html, options))
  122.   .catch(err => console.error(err))
  124.    */
  126.   delivered (store, customer, order, lang, customMessage) {
  127.     return render('delivered', {
  128.       store,
  129.       customer,
  130.       order,
  131.       custom_message: customMessage
  132.     }, store, lang)
  133.   },
  135.   /**
  136.    * @method
  137.    * @memberof transactionalMails
  138.    * @description Returns HTML markup for order shipped email.
  139.    * @param {object} store - Store body object
  140.    * @param {object} customer - Customer body object
  141.    * @param {object} order - Order body object
  142.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  143.    * @param {string} [customMessage] - Custom text for the main template phrase
  144.    * @returns {Promise}
  145.    *
  146.    * @example
  148. transactionalMails.shipped(store, customer, order, 'pt_br')
  149.   .then(html => sendEmail(html, options))
  150.   .catch(err => console.error(err))
  152.    */
  154.   shipped (store, customer, order, lang, customMessage) {
  155.     return render('shipped', {
  156.       store,
  157.       customer,
  158.       order,
  159.       custom_message: customMessage
  160.     }, store, lang)
  161.   },
  163.   /**
  164.    * @method
  165.    * @memberof transactionalMails
  166.    * @description Returns HTML markup for payment unauthorized email.
  167.    * @param {object} store - Store body object
  168.    * @param {object} customer - Customer body object
  169.    * @param {object} order - Order body object
  170.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  171.    * @param {string} [customMessage] - Custom text for the main template phrase
  172.    * @returns {Promise}
  173.    *
  174.    * @example
  176. transactionalMails.unauthorized(store, customer, order, 'pt_br')
  177.   .then(html => sendEmail(html, options))
  178.   .catch(err => console.error(err))
  180.    */
  182.   unauthorized (store, customer, order, lang, customMessage) {
  183.     return render('unauthorized', {
  184.       store,
  185.       customer,
  186.       order,
  187.       custom_message: customMessage
  188.     }, store, lang)
  189.   },
  191.   /**
  192.    * @method
  193.    * @memberof transactionalMails
  194.    * @description Returns HTML markup for order voided email.
  195.    * @param {object} store - Store body object
  196.    * @param {object} customer - Customer body object
  197.    * @param {object} order - Order body object
  198.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  199.    * @param {string} [customMessage] - Custom text for the main template phrase
  200.    * @returns {Promise}
  201.    *
  202.    * @example
  204. transactionalMails.voided(store, customer, order, 'pt_br')
  205.   .then(html => sendEmail(html, options))
  206.   .catch(err => console.error(err))
  208.    */
  210.   voided (store, customer, order, lang, customMessage) {
  211.     return render('voided', {
  212.       store,
  213.       customer,
  214.       order,
  215.       custom_message: customMessage
  216.     }, store, lang)
  217.   },
  219.   /**
  220.    * @method
  221.    * @memberof transactionalMails
  222.    * @description Returns HTML markup for new order email.
  223.    * @param {object} store - Store body object
  224.    * @param {object} customer - Customer body object
  225.    * @param {object} order - Order body object
  226.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  227.    * @param {string} [customMessage] - Custom text for the main template phrase
  228.    * @returns {Promise}
  229.    *
  230.    * @example
  232. transactionalMails.underAnalysis(store, customer, order, 'pt_br')
  233.   .then(html => sendEmail(html, options))
  234.   .catch(err => console.error(err))
  236.    */
  238.   underAnalysis (store, customer, order, lang, customMessage) {
  239.     return render('under_analysis', {
  240.       store,
  241.       customer,
  242.       order,
  243.       custom_message: customMessage
  244.     }, store, lang)
  245.   },
  247.   /**
  248.    * @method
  249.    * @memberof transactionalMails
  250.    * @description Returns HTML markup for partially paid order email.
  251.    * @param {object} store - Store body object
  252.    * @param {object} customer - Customer body object
  253.    * @param {object} order - Order body object
  254.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  255.    * @param {string} [customMessage] - Custom text for the main template phrase
  256.    * @returns {Promise}
  257.    *
  258.    * @example
  260. transactionalMails.partiallyPaid(store, customer, order, 'pt_br')
  261.   .then(html => sendEmail(html, options))
  262.   .catch(err => console.error(err))
  264.    */
  266.   partiallyPaid (store, customer, order, lang, customMessage) {
  267.     return render('partially_paid', {
  268.       store,
  269.       customer,
  270.       order,
  271.       custom_message: customMessage
  272.     }, store, lang)
  273.   },
  275.   /**
  276.    * @method
  277.    * @memberof transactionalMails
  278.    * @description Returns HTML markup for paid order email.
  279.    * @param {object} store - Store body object
  280.    * @param {object} customer - Customer body object
  281.    * @param {object} order - Order body object
  282.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  283.    * @param {string} [customMessage] - Custom text for the main template phrase
  284.    * @returns {Promise}
  285.    *
  286.    * @example
  288. transactionalMails.paid(store, customer, order, 'pt_br')
  289.   .then(html => sendEmail(html, options))
  290.   .catch(err => console.error(err))
  292.    */
  294.   paid (store, customer, order, lang, customMessage) {
  295.     return render('paid', {
  296.       store,
  297.       customer,
  298.       order,
  299.       custom_message: customMessage
  300.     }, store, lang)
  301.   },
  303.   /**
  304.    * @method
  305.    * @memberof transactionalMails
  306.    * @description Returns HTML markup for order in dispute email.
  307.    * @param {object} store - Store body object
  308.    * @param {object} customer - Customer body object
  309.    * @param {object} order - Order body object
  310.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  311.    * @param {string} [customMessage] - Custom text for the main template phrase
  312.    * @returns {Promise}
  313.    *
  314.    * @example
  316. transactionalMails.inDispute(store, customer, order, 'pt_br')
  317.   .then(html => sendEmail(html, options))
  318.   .catch(err => console.error(err))
  320.    */
  322.   inDispute (store, customer, order, lang, customMessage) {
  323.     return render('in_dispute', {
  324.       store,
  325.       customer,
  326.       order,
  327.       custom_message: customMessage
  328.     }, store, lang)
  329.   },
  331.   /**
  332.    * @method
  333.    * @memberof transactionalMails
  334.    * @description Returns HTML markup for partially refunded email.
  335.    * @param {object} store - Store body object
  336.    * @param {object} customer - Customer body object
  337.    * @param {object} order - Order body object
  338.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  339.    * @param {string} [customMessage] - Custom text for the main template phrase
  340.    * @returns {Promise}
  341.    *
  342.    * @example
  344. transactionalMails.partiallyRefunded(store, customer, order, 'pt_br')
  345.   .then(html => sendEmail(html, options))
  346.   .catch(err => console.error(err))
  348.    */
  350.   partiallyRefunded (store, customer, order, lang, customMessage) {
  351.     return render('partially_refunded', {
  352.       store,
  353.       customer,
  354.       order,
  355.       custom_message: customMessage
  356.     }, store, lang)
  357.   },
  359.   /**
  360.    * @method
  361.    * @memberof transactionalMails
  362.    * @description Returns HTML markup for refunded order email.
  363.    * @param {object} store - Store body object
  364.    * @param {object} customer - Customer body object
  365.    * @param {object} order - Order body object
  366.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  367.    * @param {string} [customMessage] - Custom text for the main template phrase
  368.    * @returns {Promise}
  369.    *
  370.    * @example
  372. transactionalMails.refunded(store, customer, order, 'pt_br')
  373.   .then(html => sendEmail(html, options))
  374.   .catch(err => console.error(err))
  376.    */
  378.   refunded (store, customer, order, lang, customMessage) {
  379.     return render('refunded', {
  380.       store,
  381.       customer,
  382.       order,
  383.       custom_message: customMessage
  384.     }, store, lang)
  385.   },
  387.   /**
  388.    * @method
  389.    * @memberof transactionalMails
  390.    * @description Returns HTML markup for order invoice issued email.
  391.    * @param {object} store - Store body object
  392.    * @param {object} customer - Customer body object
  393.    * @param {object} order - Order body object
  394.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  395.    * @param {string} [customMessage] - Custom text for the main template phrase
  396.    * @returns {Promise}
  397.    *
  398.    * @example
  400. transactionalMails.invoiceIssued(store, customer, order, 'pt_br')
  401.   .then(html => sendEmail(html, options))
  402.   .catch(err => console.error(err))
  404.    */
  406.   invoiceIssued (store, customer, order, lang, customMessage) {
  407.     return render('invoice_issued', {
  408.       store,
  409.       customer,
  410.       order,
  411.       custom_message: customMessage
  412.     }, store, lang)
  413.   },
  415.   /**
  416.    * @method
  417.    * @memberof transactionalMails
  418.    * @description Returns HTML markup for order in production email.
  419.    * @param {object} store - Store body object
  420.    * @param {object} customer - Customer body object
  421.    * @param {object} order - Order body object
  422.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  423.    * @param {string} [customMessage] - Custom text for the main template phrase
  424.    * @returns {Promise}
  425.    *
  426.    * @example
  428. transactionalMails.inProduction(store, customer, order, 'pt_br')
  429.   .then(html => sendEmail(html, options))
  430.   .catch(err => console.error(err))
  432.    */
  434.   inProduction (store, customer, order, lang, customMessage) {
  435.     return render('in_production', {
  436.       store,
  437.       customer,
  438.       order,
  439.       custom_message: customMessage
  440.     }, store, lang)
  441.   },
  443.   /**
  444.    * @method
  445.    * @memberof transactionalMails
  446.    * @description Returns HTML markup for order in separation email.
  447.    * @param {object} store - Store body object
  448.    * @param {object} customer - Customer body object
  449.    * @param {object} order - Order body object
  450.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  451.    * @param {string} [customMessage] - Custom text for the main template phrase
  452.    * @returns {Promise}
  453.    *
  454.    * @example
  456. transactionalMails.inSeparation(store, customer, order, 'pt_br')
  457.   .then(html => sendEmail(html, options))
  458.   .catch(err => console.error(err))
  460.    */
  462.   inSeparation (store, customer, order, lang, customMessage) {
  463.     return render('in_separation', {
  464.       store,
  465.       customer,
  466.       order,
  467.       custom_message: customMessage
  468.     }, store, lang)
  469.   },
  471.   /**
  472.    * @method
  473.    * @memberof transactionalMails
  474.    * @description Returns HTML markup for order ready for shipping email.
  475.    * @param {object} store - Store body object
  476.    * @param {object} customer - Customer body object
  477.    * @param {object} order - Order body object
  478.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  479.    * @param {string} [customMessage] - Custom text for the main template phrase
  480.    * @returns {Promise}
  481.    *
  482.    * @example
  484. transactionalMails.readyForShipping(store, customer, order, 'pt_br')
  485.   .then(html => sendEmail(html, options))
  486.   .catch(err => console.error(err))
  488.    */
  490.   readyForShipping (store, customer, order, lang, customMessage) {
  491.     return render('ready_for_shipping', {
  492.       store,
  493.       customer,
  494.       order,
  495.       custom_message: customMessage
  496.     }, store, lang)
  497.   },
  499.   /**
  500.    * @method
  501.    * @memberof transactionalMails
  502.    * @description Returns HTML markup for partially shipped order email.
  503.    * @param {object} store - Store body object
  504.    * @param {object} customer - Customer body object
  505.    * @param {object} order - Order body object
  506.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  507.    * @param {string} [customMessage] - Custom text for the main template phrase
  508.    * @returns {Promise}
  509.    *
  510.    * @example
  512. transactionalMails.partiallyShipped(store, customer, order, 'pt_br')
  513.   .then(html => sendEmail(html, options))
  514.   .catch(err => console.error(err))
  516.    */
  518.   partiallyShipped (store, customer, order, lang, customMessage) {
  519.     return render('partially_shipped', {
  520.       store,
  521.       customer,
  522.       order,
  523.       custom_message: customMessage
  524.     }, store, lang)
  525.   },
  527.   /**
  528.    * @method
  529.    * @memberof transactionalMails
  530.    * @description Returns HTML markup for partially delivered order email.
  531.    * @param {object} store - Store body object
  532.    * @param {object} customer - Customer body object
  533.    * @param {object} order - Order body object
  534.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  535.    * @param {string} [customMessage] - Custom text for the main template phrase
  536.    * @returns {Promise}
  537.    *
  538.    * @example
  540. transactionalMails.partiallyDelivered(store, customer, order, 'pt_br')
  541.   .then(html => sendEmail(html, options))
  542.   .catch(err => console.error(err))
  544.    */
  546.   partiallyDelivered (store, customer, order, lang, customMessage) {
  547.     return render('partially_delivered', {
  548.       store,
  549.       customer,
  550.       order,
  551.       custom_message: customMessage
  552.     }, store, lang)
  553.   },
  555.   /**
  556.    * @method
  557.    * @memberof transactionalMails
  558.    * @description Returns HTML markup for order returned for exchange email.
  559.    * @param {object} store - Store body object
  560.    * @param {object} customer - Customer body object
  561.    * @param {object} order - Order body object
  562.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  563.    * @param {string} [customMessage] - Custom text for the main template phrase
  564.    * @returns {Promise}
  565.    *
  566.    * @example
  568. transactionalMails.returnedForExchange(store, customer, order, 'pt_br')
  569.   .then(html => sendEmail(html, options))
  570.   .catch(err => console.error(err))
  572.    */
  574.   returnedForExchange (store, customer, order, lang, customMessage) {
  575.     return render('returned_for_exchange', {
  576.       store,
  577.       customer,
  578.       order,
  579.       custom_message: customMessage
  580.     }, store, lang)
  581.   },
  583.   /**
  584.    * @method
  585.    * @memberof transactionalMails
  586.    * @description Returns HTML markup for order received for exchange email.
  587.    * @param {object} store - Store body object
  588.    * @param {object} customer - Customer body object
  589.    * @param {object} order - Order body object
  590.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  591.    * @param {string} [customMessage] - Custom text for the main template phrase
  592.    * @returns {Promise}
  593.    *
  594.    * @example
  596. transactionalMails.receivedForExchange(store, customer, order, 'pt_br')
  597.   .then(html => sendEmail(html, options))
  598.   .catch(err => console.error(err))
  600.    */
  602.   receivedForExchange (store, customer, order, lang, customMessage) {
  603.     return render('received_for_exchange', {
  604.       store,
  605.       customer,
  606.       order,
  607.       custom_message: customMessage
  608.     }, store, lang)
  609.   },
  611.   /**
  612.    * @method
  613.    * @memberof transactionalMails
  614.    * @description Returns HTML markup for returned order email.
  615.    * @param {object} store - Store body object
  616.    * @param {object} customer - Customer body object
  617.    * @param {object} order - Order body object
  618.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  619.    * @param {string} [customMessage] - Custom text for the main template phrase
  620.    * @returns {Promise}
  621.    *
  622.    * @example
  624. transactionalMails.returned(store, customer, order, 'pt_br')
  625.   .then(html => sendEmail(html, options))
  626.   .catch(err => console.error(err))
  628.    */
  630.   returned (store, customer, order, lang, customMessage) {
  631.     return render('returned', {
  632.       store,
  633.       customer,
  634.       order,
  635.       custom_message: customMessage
  636.     }, store, lang)
  637.   },
  639.   /**
  640.    * @method
  641.    * @memberof transactionalMails
  642.    * @description Returns HTML markup for authorized payment email.
  643.    * @param {object} store - Store body object
  644.    * @param {object} customer - Customer body object
  645.    * @param {object} order - Order body object
  646.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  647.    * @param {string} [customMessage] - Custom text for the main template phrase
  648.    * @returns {Promise}
  649.    *
  650.    * @example
  652.   transactionalMails.authorized(store, customer, order, 'pt_br')
  653.     .then(html => sendEmail(html, options))
  654.     .catch(err => console.error(err))
  656.      */
  658.   authorized (store, customer, order, lang, customMessage) {
  659.     return render('authorized', {
  660.       store,
  661.       customer,
  662.       order,
  663.       custom_message: customMessage
  664.     }, store, lang)
  665.   },
  667.   /**
  668.    * @method
  669.    * @memberof transactionalMails
  670.    * @description Returns HTML markup for new order email.
  671.    * @param {object} store - Store body object
  672.    * @param {object} customer - Customer body object
  673.    * @param {object} order - Order body object
  674.    * @param {string} [lang='en_us'] - Snake case language code, eg.: 'en_us', 'pt_br'
  675.    * @param {string} [customMessage] - Custom text for the main template phrase
  676.    * @returns {Promise}
  677.    *
  678.    * @example
  680.   transactionalMails.authorized(store, customer, order, 'pt_br')
  681.     .then(html => sendEmail(html, options))
  682.     .catch(err => console.error(err))
  684.      */
  686.   new_order (store, customer, order, lang, customMessage) {
  687.     return render('new_order', {
  688.       store,
  689.       customer,
  690.       order,
  691.       custom_message: customMessage
  692.     }, store, lang)
  693.   }
  694. }
  696. /**
  697.  * @namespace transactionalMails
  698.  */