@budibase/worker 2.1.22-alpha.6 → 2.1.22-alpha.7

package/src/constants/{index.js → index.ts}

@@ -1,97 +1,97 @@
-const { Configs } = require("@budibase/backend-core/constants")
+import { constants } from "@budibase/backend-core"
 
-exports.LOGO_URL =
+export const LOGO_URL =
   "https://d33wubrfki0l68.cloudfront.net/aac32159d7207b5085e74a7ef67afbb7027786c5/2b1fd/img/logo/bb-emblem.svg"
 
-exports.UserStatus = {
-  ACTIVE: "active",
-  INACTIVE: "inactive",
+export enum UserStatus {
+  ACTIVE = "active",
+  INACTIVE = "inactive",
 }
 
-exports.Configs = Configs
+export const Config = constants.Config
 
-exports.ConfigUploads = {
-  LOGO: "logo",
-  OIDC_LOGO: "oidc_logo",
+export enum ConfigUpload {
+  LOGO = "logo",
+  OIDC_LOGO = "oidc_logo",
 }
 
-const TemplateTypes = {
-  EMAIL: "email",
+export enum TemplateType {
+  EMAIL = "email",
 }
 
-const EmailTemplatePurpose = {
-  BASE: "base",
-  PASSWORD_RECOVERY: "password_recovery",
-  INVITATION: "invitation",
-  WELCOME: "welcome",
-  CUSTOM: "custom",
+export enum EmailTemplatePurpose {
+  BASE = "base",
+  PASSWORD_RECOVERY = "password_recovery",
+  INVITATION = "invitation",
+  WELCOME = "welcome",
+  CUSTOM = "custom",
 }
 
-const InternalTemplateBindings = {
-  PLATFORM_URL: "platformUrl",
-  COMPANY: "company",
-  LOGO_URL: "logoUrl",
-  EMAIL: "email",
-  USER: "user",
-  REQUEST: "request",
-  DOCS_URL: "docsUrl",
-  LOGIN_URL: "loginUrl",
-  CURRENT_YEAR: "currentYear",
-  CURRENT_DATE: "currentDate",
-  BODY: "body",
-  STYLES: "styles",
-  RESET_URL: "resetUrl",
-  RESET_CODE: "resetCode",
-  INVITE_URL: "inviteUrl",
-  INVITE_CODE: "inviteUrl",
-  CONTENTS: "contents",
+export enum InternalTemplateBinding {
+  PLATFORM_URL = "platformUrl",
+  COMPANY = "company",
+  LOGO_URL = "logoUrl",
+  EMAIL = "email",
+  USER = "user",
+  REQUEST = "request",
+  DOCS_URL = "docsUrl",
+  LOGIN_URL = "loginUrl",
+  CURRENT_YEAR = "currentYear",
+  CURRENT_DATE = "currentDate",
+  BODY = "body",
+  STYLES = "styles",
+  RESET_URL = "resetUrl",
+  RESET_CODE = "resetCode",
+  INVITE_URL = "inviteUrl",
+  INVITE_CODE = "inviteUrl",
+  CONTENTS = "contents",
 }
 
-const TemplateBindings = {
+export const TemplateBindings = {
   PLATFORM_URL: {
-    name: InternalTemplateBindings.PLATFORM_URL,
+    name: InternalTemplateBinding.PLATFORM_URL,
     description: "The URL used to access the budibase platform",
   },
   COMPANY: {
-    name: InternalTemplateBindings.COMPANY,
+    name: InternalTemplateBinding.COMPANY,
     description: "The name of your organization",
   },
   LOGO_URL: {
-    name: InternalTemplateBindings.LOGO_URL,
+    name: InternalTemplateBinding.LOGO_URL,
     description: "The URL of your organizations logo.",
   },
   EMAIL: {
-    name: InternalTemplateBindings.EMAIL,
+    name: InternalTemplateBinding.EMAIL,
     description: "The recipients email address.",
   },
   USER: {
-    name: InternalTemplateBindings.USER,
+    name: InternalTemplateBinding.USER,
     description: "The recipients user object.",
   },
   REQUEST: {
-    name: InternalTemplateBindings.REQUEST,
+    name: InternalTemplateBinding.REQUEST,
     description: "Additional request metadata.",
   },
   DOCS_URL: {
-    name: InternalTemplateBindings.DOCS_URL,
+    name: InternalTemplateBinding.DOCS_URL,
     description: "Organization documentation URL.",
   },
   LOGIN_URL: {
-    name: InternalTemplateBindings.LOGIN_URL,
+    name: InternalTemplateBinding.LOGIN_URL,
     description: "The URL used to log into the organization budibase instance.",
   },
   CURRENT_YEAR: {
-    name: InternalTemplateBindings.CURRENT_YEAR,
+    name: InternalTemplateBinding.CURRENT_YEAR,
     description: "The current year.",
   },
   CURRENT_DATE: {
-    name: InternalTemplateBindings.CURRENT_DATE,
+    name: InternalTemplateBinding.CURRENT_DATE,
     description: "The current date.",
   },
 }
 
-const TemplateMetadata = {
-  [TemplateTypes.EMAIL]: [
+export const TemplateMetadata = {
+  [TemplateType.EMAIL]: [
     {
       name: "Base format",
       description:
@@ -100,11 +100,11 @@ const TemplateMetadata = {
       purpose: EmailTemplatePurpose.BASE,
       bindings: [
         {
-          name: InternalTemplateBindings.BODY,
+          name: InternalTemplateBinding.BODY,
           description: "The main body of another email template.",
         },
         {
-          name: InternalTemplateBindings.STYLES,
+          name: InternalTemplateBinding.STYLES,
           description: "The contents of the Styling email template.",
         },
       ],
@@ -117,12 +117,12 @@ const TemplateMetadata = {
       purpose: EmailTemplatePurpose.PASSWORD_RECOVERY,
       bindings: [
         {
-          name: InternalTemplateBindings.RESET_URL,
+          name: InternalTemplateBinding.RESET_URL,
           description:
             "The URL the recipient must click to reset their password.",
         },
         {
-          name: InternalTemplateBindings.RESET_CODE,
+          name: InternalTemplateBinding.RESET_CODE,
           description:
             "The temporary password reset code used in the recipients password reset URL.",
         },
@@ -144,12 +144,12 @@ const TemplateMetadata = {
       purpose: EmailTemplatePurpose.INVITATION,
       bindings: [
         {
-          name: InternalTemplateBindings.INVITE_URL,
+          name: InternalTemplateBinding.INVITE_URL,
           description:
             "The URL the recipient must click to accept the invitation and activate their account.",
         },
         {
-          name: InternalTemplateBindings.INVITE_CODE,
+          name: InternalTemplateBinding.INVITE_CODE,
           description:
             "The temporary invite code used in the recipients invitation URL.",
         },
@@ -163,7 +163,7 @@ const TemplateMetadata = {
       purpose: EmailTemplatePurpose.CUSTOM,
       bindings: [
         {
-          name: InternalTemplateBindings.CONTENTS,
+          name: InternalTemplateBinding.CONTENTS,
           description: "Custom content body.",
         },
       ],
@@ -172,12 +172,5 @@ const TemplateMetadata = {
 }
 
 // all purpose combined
-exports.TemplatePurpose = {
-  ...EmailTemplatePurpose,
-}
-exports.TemplateTypes = TemplateTypes
-exports.EmailTemplatePurpose = EmailTemplatePurpose
-exports.TemplateMetadata = TemplateMetadata
-exports.TemplateBindings = TemplateBindings
-exports.InternalTemplateBindings = InternalTemplateBindings
-exports.GLOBAL_OWNER = "global"
+export { EmailTemplatePurpose as TemplatePurpose }
+export const GLOBAL_OWNER = "global"

package/src/constants/templates/index.js

@@ -1,7 +1,7 @@
 const { readStaticFile } = require("../../utilities/fileSystem")
 const {
   EmailTemplatePurpose,
-  TemplateTypes,
+  TemplateType,
   TemplatePurpose,
   GLOBAL_OWNER,
 } = require("../index")
@@ -26,7 +26,7 @@ exports.EmailTemplates = {
 exports.addBaseTemplates = (templates, type = null) => {
   let purposeList
   switch (type) {
-    case TemplateTypes.EMAIL:
+    case TemplateType.EMAIL:
       purposeList = Object.values(EmailTemplatePurpose)
       break
     default:

package/src/middleware/cloudRestricted.js

@@ -1,5 +1,5 @@
 const env = require("../environment")
-const { Headers } = require("@budibase/backend-core/constants")
+const { Header } = require("@budibase/backend-core/constants")
 
 /**
  * This is a restricted endpoint in the cloud.
@@ -7,7 +7,7 @@ const { Headers } = require("@budibase/backend-core/constants")
  */
 module.exports = async (ctx, next) => {
   if (!env.SELF_HOSTED && !env.DISABLE_ACCOUNT_PORTAL) {
-    const apiKey = ctx.request.headers[Headers.API_KEY]
+    const apiKey = ctx.request.headers[Header.API_KEY]
     if (apiKey !== env.INTERNAL_API_KEY) {
       ctx.throw(403, "Unauthorized")
     }

package/src/middleware/tests/tenancy.spec.ts

@@ -20,18 +20,18 @@ describe("tenancy middleware", () => {
     const user = await config.createTenant()
     await config.createSession(user)
     const res = await config.api.self.getSelf(user)
-    expect(res.headers[constants.Headers.TENANT_ID]).toBe(user.tenantId)
+    expect(res.headers[constants.Header.TENANT_ID]).toBe(user.tenantId)
   })
 
   it("should get tenant id from header", async () => {
     const tenantId = structures.uuid()
     const headers = {
-      [constants.Headers.TENANT_ID]: tenantId,
+      [constants.Header.TENANT_ID]: tenantId,
     }
     const res = await config.request
       .get(`/api/global/configs/checklist`)
       .set(headers)
-    expect(res.headers[constants.Headers.TENANT_ID]).toBe(tenantId)
+    expect(res.headers[constants.Header.TENANT_ID]).toBe(tenantId)
   })
 
   it("should get tenant id from query param", async () => {
@@ -39,7 +39,7 @@ describe("tenancy middleware", () => {
     const res = await config.request.get(
       `/api/global/configs/checklist?tenantId=${tenantId}`
     )
-    expect(res.headers[constants.Headers.TENANT_ID]).toBe(tenantId)
+    expect(res.headers[constants.Header.TENANT_ID]).toBe(tenantId)
   })
 
   it("should get tenant id from subdomain", async () => {
@@ -50,7 +50,7 @@ describe("tenancy middleware", () => {
     const res = await config.request
       .get(`/api/global/configs/checklist`)
       .set(headers)
-    expect(res.headers[constants.Headers.TENANT_ID]).toBe(tenantId)
+    expect(res.headers[constants.Header.TENANT_ID]).toBe(tenantId)
   })
 
   it("should get tenant id from path variable", async () => {
@@ -61,13 +61,13 @@ describe("tenancy middleware", () => {
         username: user.email,
         password: user.password,
       })
-    expect(res.headers[constants.Headers.TENANT_ID]).toBe(user.tenantId)
+    expect(res.headers[constants.Header.TENANT_ID]).toBe(user.tenantId)
   })
 
   it("should throw when no tenant id is found", async () => {
     const res = await config.request.get(`/api/global/configs/checklist`)
     expect(res.status).toBe(403)
     expect(res.text).toBe("Tenant id not set")
-    expect(res.headers[constants.Headers.TENANT_ID]).toBe(undefined)
+    expect(res.headers[constants.Header.TENANT_ID]).toBe(undefined)
   })
 })

package/src/tests/TestConfiguration.ts

@@ -4,12 +4,10 @@ dbConfig.init()
 import env from "../environment"
 import controllers from "./controllers"
 const supertest = require("supertest")
-import { Configs } from "../constants"
+import { Config } from "../constants"
 import {
   users,
   tenancy,
-  Cookies,
-  Headers,
   sessions,
   auth,
   constants,
@@ -131,7 +129,7 @@ class TestConfiguration {
     const userRes = await this.api.users.getUser(res.userId, {
       headers: {
         ...this.internalAPIHeaders(),
-        [constants.Headers.TENANT_ID]: res.tenantId,
+        [constants.Header.TENANT_ID]: res.tenantId,
       },
     })
 
@@ -188,8 +186,8 @@ class TestConfiguration {
     const authCookie = auth.jwt.sign(authToken, env.JWT_SECRET)
     return {
       Accept: "application/json",
-      ...this.cookieHeader([`${Cookies.Auth}=${authCookie}`]),
-      [Headers.CSRF_TOKEN]: CSRF_TOKEN,
+      ...this.cookieHeader([`${constants.Cookie.Auth}=${authCookie}`]),
+      [constants.Header.CSRF_TOKEN]: CSRF_TOKEN,
     }
   }
 
@@ -205,7 +203,7 @@ class TestConfiguration {
   }
 
   internalAPIHeaders() {
-    return { [constants.Headers.API_KEY]: env.INTERNAL_API_KEY }
+    return { [constants.Header.API_KEY]: env.INTERNAL_API_KEY }
   }
 
   adminOnlyResponse = () => {
@@ -274,7 +272,7 @@ class TestConfiguration {
   // CONFIGS - SETTINGS
 
   async saveSettingsConfig() {
-    await this.deleteConfig(Configs.SETTINGS)
+    await this.deleteConfig(Config.SETTINGS)
     await this._req(
       structures.configs.settings(),
       null,
@@ -285,14 +283,19 @@ class TestConfiguration {
   // CONFIGS - GOOGLE
 
   async saveGoogleConfig() {
-    await this.deleteConfig(Configs.GOOGLE)
+    await this.deleteConfig(Config.GOOGLE)
     await this._req(structures.configs.google(), null, controllers.config.save)
   }
 
   // CONFIGS - OIDC
 
+  getOIDConfigCookie(configId: string) {
+    const token = auth.jwt.sign(configId, env.JWT_SECRET)
+    return this.cookieHeader([[`${constants.Cookie.OIDC_CONFIG}=${token}`]])
+  }
+
   async saveOIDCConfig() {
-    await this.deleteConfig(Configs.OIDC)
+    await this.deleteConfig(Config.OIDC)
     const config = structures.configs.oidc()
 
     await this._req(config, null, controllers.config.save)
@@ -302,12 +305,12 @@ class TestConfiguration {
   // CONFIGS - SMTP
 
   async saveSmtpConfig() {
-    await this.deleteConfig(Configs.SMTP)
+    await this.deleteConfig(Config.SMTP)
     await this._req(structures.configs.smtp(), null, controllers.config.save)
   }
 
   async saveEtherealSmtpConfig() {
-    await this.deleteConfig(Configs.SMTP)
+    await this.deleteConfig(Config.SMTP)
     await this._req(
       structures.configs.smtpEthereal(),
       null,

package/src/tests/structures/configs.js

@@ -1,9 +1,9 @@
-const { Configs } = require("../../constants")
+const { Config } = require("../../constants")
 const { utils } = require("@budibase/backend-core")
 
 exports.oidc = conf => {
   return {
-    type: Configs.OIDC,
+    type: Config.OIDC,
     config: {
       configs: [
         {
@@ -23,7 +23,7 @@ exports.oidc = conf => {
 
 exports.google = conf => {
   return {
-    type: Configs.GOOGLE,
+    type: Config.GOOGLE,
     config: {
       clientID: "clientId",
       clientSecret: "clientSecret",
@@ -35,7 +35,7 @@ exports.google = conf => {
 
 exports.smtp = conf => {
   return {
-    type: Configs.SMTP,
+    type: Config.SMTP,
     config: {
       port: 12345,
       host: "smtptesthost.com",
@@ -49,7 +49,7 @@ exports.smtp = conf => {
 
 exports.smtpEthereal = () => {
   return {
-    type: Configs.SMTP,
+    type: Config.SMTP,
     config: {
       port: 587,
       host: "smtp.ethereal.email",
@@ -65,7 +65,7 @@ exports.smtpEthereal = () => {
 
 exports.settings = conf => {
   return {
-    type: Configs.SETTINGS,
+    type: Config.SETTINGS,
     config: {
       platformUrl: "http://localhost:10000",
       logoUrl: "",

package/src/utilities/appService.js

@@ -1,5 +1,5 @@
 const fetch = require("node-fetch")
-const { Headers } = require("@budibase/backend-core/constants")
+const { Header } = require("@budibase/backend-core/constants")
 const { getTenantId, isTenantIdSet } = require("@budibase/backend-core/tenancy")
 const { checkSlashesInUrl } = require("../utilities")
 const env = require("../environment")
@@ -9,9 +9,9 @@ async function makeAppRequest(url, method, body) {
     return
   }
   const request = { headers: {} }
-  request.headers[Headers.API_KEY] = env.INTERNAL_API_KEY
+  request.headers[Header.API_KEY] = env.INTERNAL_API_KEY
   if (isTenantIdSet()) {
-    request.headers[Headers.TENANT_ID] = getTenantId()
+    request.headers[Header.TENANT_ID] = getTenantId()
   }
   if (body) {
     request.headers["Content-Type"] = "application/json"

package/src/utilities/{email.js → email.ts}

@@ -1,15 +1,33 @@
+import env from "../environment"
+import { EmailTemplatePurpose, TemplateType, Config } from "../constants"
+import { getTemplateByPurpose } from "../constants/templates"
+import { getSettingsTemplateContext } from "./templates"
+import { processString } from "@budibase/string-templates"
+import { getResetPasswordCode, getInviteCode } from "./redis"
+import { User, Database } from "@budibase/types"
+import { tenancy, db as dbCore } from "@budibase/backend-core"
 const nodemailer = require("nodemailer")
-const env = require("../environment")
-const { getScopedConfig } = require("@budibase/backend-core/db")
-const { EmailTemplatePurpose, TemplateTypes, Configs } = require("../constants")
-const { getTemplateByPurpose } = require("../constants/templates")
-const { getSettingsTemplateContext } = require("./templates")
-const { processString } = require("@budibase/string-templates")
-const { getResetPasswordCode, getInviteCode } = require("../utilities/redis")
-const { getGlobalDB } = require("@budibase/backend-core/tenancy")
+
+type SendEmailOpts = {
+  // workspaceId If finer grain controls being used then this will lookup config for workspace.
+  workspaceId?: string
+  // user If sending to an existing user the object can be provided, this is used in the context.
+  user: User
+  // from If sending from an address that is not what is configured in the SMTP config.
+  from?: string
+  // contents If sending a custom email then can supply contents which will be added to it.
+  contents?: string
+  // subject A custom subject can be specified if the config one is not desired.
+  subject?: string
+  // info Pass in a structure of information to be stored alongside the invitation.
+  info?: any
+  cc?: boolean
+  bcc?: boolean
+  automation?: boolean
+}
 
 const TEST_MODE = false
-const TYPE = TemplateTypes.EMAIL
+const TYPE = TemplateType.EMAIL
 
 const FULL_EMAIL_PURPOSES = [
   EmailTemplatePurpose.INVITATION,
@@ -18,8 +36,8 @@ const FULL_EMAIL_PURPOSES = [
   EmailTemplatePurpose.CUSTOM,
 ]
 
-function createSMTPTransport(config) {
-  let options
+function createSMTPTransport(config: any) {
+  let options: any
   let secure = config.secure
   // default it if not specified
   if (secure == null) {
@@ -52,10 +70,15 @@ function createSMTPTransport(config) {
   return nodemailer.createTransport(options)
 }
 
-async function getLinkCode(purpose, email, user, info = null) {
+async function getLinkCode(
+  purpose: EmailTemplatePurpose,
+  email: string,
+  user: User,
+  info: any = null
+) {
   switch (purpose) {
     case EmailTemplatePurpose.PASSWORD_RECOVERY:
-      return getResetPasswordCode(user._id, info)
+      return getResetPasswordCode(user._id!, info)
     case EmailTemplatePurpose.INVITATION:
       return getInviteCode(email, info)
     default:
@@ -72,7 +95,12 @@ async function getLinkCode(purpose, email, user, info = null) {
  * @param {string|null} contents if using a custom template can supply contents for context.
  * @return {Promise<string>} returns the built email HTML if all provided parameters were valid.
  */
-async function buildEmail(purpose, email, context, { user, contents } = {}) {
+async function buildEmail(
+  purpose: EmailTemplatePurpose,
+  email: string,
+  context: any,
+  { user, contents }: any = {}
+) {
   // this isn't a full email
   if (FULL_EMAIL_PURPOSES.indexOf(purpose) === -1) {
     throw `Unable to build an email of type ${purpose}`
@@ -113,15 +141,19 @@ async function buildEmail(purpose, email, context, { user, contents } = {}) {
  * @param {boolean|null} automation Whether or not the configuration is being fetched for an email automation.
  * @return {Promise<object|null>} returns the SMTP configuration if it exists
  */
-async function getSmtpConfiguration(db, workspaceId = null, automation) {
-  const params = {
-    type: Configs.SMTP,
+async function getSmtpConfiguration(
+  db: Database,
+  workspaceId?: string,
+  automation?: boolean
+) {
+  const params: any = {
+    type: Config.SMTP,
   }
   if (workspaceId) {
     params.workspace = workspaceId
   }
 
-  const customConfig = await getScopedConfig(db, params)
+  const customConfig = await dbCore.getScopedConfig(db, params)
 
   if (customConfig) {
     return customConfig
@@ -146,12 +178,12 @@ async function getSmtpConfiguration(db, workspaceId = null, automation) {
  * Checks if a SMTP config exists based on passed in parameters.
  * @return {Promise<boolean>} returns true if there is a configuration that can be used.
  */
-exports.isEmailConfigured = async (workspaceId = null) => {
+export async function isEmailConfigured(workspaceId?: string) {
   // when "testing" or smtp fallback is enabled simply return true
   if (TEST_MODE || env.SMTP_FALLBACK_ENABLED) {
     return true
   }
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
   const config = await getSmtpConfiguration(db, workspaceId)
   return config != null
 }
@@ -161,48 +193,49 @@ exports.isEmailConfigured = async (workspaceId = null) => {
  * send an email using it.
  * @param {string} email The email address to send to.
  * @param {string} purpose The purpose of the email being sent (e.g. reset password).
- * @param {string|undefined} workspaceId If finer grain controls being used then this will lookup config for workspace.
- * @param {object|undefined} user If sending to an existing user the object can be provided, this is used in the context.
- * @param {string|undefined} from If sending from an address that is not what is configured in the SMTP config.
- * @param {string|undefined} contents If sending a custom email then can supply contents which will be added to it.
- * @param {string|undefined} subject A custom subject can be specified if the config one is not desired.
- * @param {object|undefined} info Pass in a structure of information to be stored alongside the invitation.
- * @param {boolean|undefined} disableFallback Prevent email being sent from SMTP fallback to avoid spam.
+ * @param {object} opts The options for sending the email.
  * @return {Promise<object>} returns details about the attempt to send email, e.g. if it is successful; based on
  * nodemailer response.
  */
-exports.sendEmail = async (
-  email,
-  purpose,
-  { workspaceId, user, from, contents, subject, info, cc, bcc, automation } = {}
-) => {
-  const db = getGlobalDB()
-  let config = (await getSmtpConfiguration(db, workspaceId, automation)) || {}
+export async function sendEmail(
+  email: string,
+  purpose: EmailTemplatePurpose,
+  opts: SendEmailOpts
+) {
+  const db = tenancy.getGlobalDB()
+  let config =
+    (await getSmtpConfiguration(db, opts?.workspaceId, opts?.automation)) || {}
   if (Object.keys(config).length === 0 && !TEST_MODE) {
     throw "Unable to find SMTP configuration."
   }
   const transport = createSMTPTransport(config)
   // if there is a link code needed this will retrieve it
-  const code = await getLinkCode(purpose, email, user, info)
-  const context = await getSettingsTemplateContext(purpose, code)
+  const code = await getLinkCode(purpose, email, opts.user, opts?.info)
+  let context
+  if (code) {
+    context = await getSettingsTemplateContext(purpose, code)
+  }
 
-  let message = {
-    from: from || config.from,
+  let message: any = {
+    from: opts?.from || config.from,
     html: await buildEmail(purpose, email, context, {
-      user,
-      contents,
+      user: opts?.user,
+      contents: opts?.contents,
     }),
   }
 
   message = {
     ...message,
     to: email,
-    cc: cc,
-    bcc: bcc,
+    cc: opts?.cc,
+    bcc: opts?.bcc,
   }
 
-  if (subject || config.subject) {
-    message.subject = await processString(subject || config.subject, context)
+  if (opts?.subject || config.subject) {
+    message.subject = await processString(
+      opts?.subject || config.subject,
+      context
+    )
   }
   const response = await transport.sendMail(message)
   if (TEST_MODE) {
@@ -216,7 +249,7 @@ exports.sendEmail = async (
  * @param {object} config an SMTP configuration - this is based on the nodemailer API.
  * @return {Promise<boolean>} returns true if the configuration is valid.
  */
-exports.verifyConfig = async config => {
+export async function verifyConfig(config: any) {
   const transport = createSMTPTransport(config)
   await transport.verify()
 }