@budibase/worker 2.11.37 → 2.11.38

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.11.37",
+  "version": "2.11.38",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -38,10 +38,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "2.11.37",
-    "@budibase/pro": "2.11.37",
-    "@budibase/string-templates": "2.11.37",
-    "@budibase/types": "2.11.37",
+    "@budibase/backend-core": "2.11.38",
+    "@budibase/pro": "2.11.38",
+    "@budibase/string-templates": "2.11.38",
+    "@budibase/types": "2.11.38",
     "@koa/router": "8.0.8",
     "@techpass/passport-openidconnect": "0.3.2",
     "@types/global-agent": "2.1.1",
@@ -107,5 +107,5 @@
       }
     }
   },
-  "gitHead": "735961cf9cbfe40adbb1c983976a21ee18ba2433"
+  "gitHead": "ec768a59f56e7aabc38e2e8bf0defe9e91a3f7e6"
 }

package/src/utilities/email.ts

@@ -71,12 +71,12 @@ async function getLinkCode(
 
 /**
  * Builds an email using handlebars and the templates found in the system (default or otherwise).
- * @param {string} purpose the purpose of the email being built, e.g. invitation, password reset.
- * @param {string} email the address which it is being sent to for contextual purposes.
- * @param {object} context the context which is being used for building the email (hbs context).
- * @param {object|null} user if being sent to an existing user then the object can be provided for context.
- * @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.
+ * @param purpose the purpose of the email being built, e.g. invitation, password reset.
+ * @param email the address which it is being sent to for contextual purposes.
+ * @param context the context which is being used for building the email (hbs context).
+ * @param user if being sent to an existing user then the object can be provided for context.
+ * @param contents if using a custom template can supply contents for context.
+ * @return returns the built email HTML if all provided parameters were valid.
  */
 async function buildEmail(
   purpose: EmailTemplatePurpose,
@@ -128,7 +128,7 @@ async function buildEmail(
 
 /**
  * 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.
+ * @return returns true if there is a configuration that can be used.
  */
 export async function isEmailConfigured() {
   // when "testing" or smtp fallback is enabled simply return true
@@ -142,10 +142,10 @@ export async function isEmailConfigured() {
 /**
  * Given an email address and an email purpose this will retrieve the SMTP configuration and
  * 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 {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
+ * @param email The email address to send to.
+ * @param purpose The purpose of the email being sent (e.g. reset password).
+ * @param opts The options for sending the email.
+ * @return returns details about the attempt to send email, e.g. if it is successful; based on
  * nodemailer response.
  */
 export async function sendEmail(
@@ -212,8 +212,8 @@ export async function sendEmail(
 
 /**
  * Given an SMTP configuration this runs it through nodemailer to see if it is in fact functional.
- * @param {object} config an SMTP configuration - this is based on the nodemailer API.
- * @return {Promise<boolean>} returns true if the configuration is valid.
+ * @param config an SMTP configuration - this is based on the nodemailer API.
+ * @return returns true if the configuration is valid.
  */
 export async function verifyConfig(config: SMTPInnerConfig) {
   const transport = createSMTPTransport(config)

package/src/utilities/index.ts

@@ -1,8 +1,8 @@
 /**
  * Makes sure that a URL has the correct number of slashes, while maintaining the
  * http(s):// double slashes.
- * @param {string} url The URL to test and remove any extra double slashes.
- * @return {string} The updated url.
+ * @param url The URL to test and remove any extra double slashes.
+ * @return The updated url.
  */
 export function checkSlashesInUrl(url: string) {
   return url.replace(/(https?:\/\/)|(\/)+/g, "$1$2")

package/src/utilities/redis.ts

@@ -37,8 +37,8 @@ async function updateACode(db: string, code: string, value: any) {
 
 /**
  * Given an invite code and invite body, allow the update an existing/valid invite in redis
- * @param {string} inviteCode The invite code for an invite in redis
- * @param {object} value The body of the updated user invitation
+ * @param inviteCode The invite code for an invite in redis
+ * @param value The body of the updated user invitation
  */
 export async function updateInviteCode(inviteCode: string, value: string) {
   await updateACode(redis.utils.Databases.INVITATIONS, inviteCode, value)
@@ -77,9 +77,9 @@ export async function shutdown() {
 /**
  * Given a user ID this will store a code (that is returned) for an hour in redis.
  * The user can then return this code for resetting their password (through their reset link).
- * @param {string} userId the ID of the user which is to be reset.
- * @param {object} info Info about the user/the reset process.
- * @return {Promise<string>} returns the code that was stored to redis.
+ * @param userId the ID of the user which is to be reset.
+ * @param info Info about the user/the reset process.
+ * @return returns the code that was stored to redis.
  */
 export async function getResetPasswordCode(userId: string, info: any) {
   return writeACode(redis.utils.Databases.PW_RESETS, { userId, info })
@@ -87,9 +87,9 @@ export async function getResetPasswordCode(userId: string, info: any) {
 
 /**
  * Given a reset code this will lookup to redis, check if the code is valid and delete if required.
- * @param {string} resetCode The code provided via the email link.
- * @param {boolean} deleteCode If the code is used/finished with this will delete it - defaults to true.
- * @return {Promise<string>} returns the user ID if it is found
+ * @param resetCode The code provided via the email link.
+ * @param deleteCode If the code is used/finished with this will delete it - defaults to true.
+ * @return returns the user ID if it is found
  */
 export async function checkResetPasswordCode(
   resetCode: string,
@@ -104,9 +104,9 @@ export async function checkResetPasswordCode(
 
 /**
  * Generates an invitation code and writes it to redis - which can later be checked for user creation.
- * @param {string} email the email address which the code is being sent to (for use later).
- * @param {object|null} info Information to be carried along with the invitation.
- * @return {Promise<string>} returns the code that was stored to redis.
+ * @param email the email address which the code is being sent to (for use later).
+ * @param info Information to be carried along with the invitation.
+ * @return returns the code that was stored to redis.
  */
 export async function getInviteCode(email: string, info: any) {
   return writeACode(redis.utils.Databases.INVITATIONS, { email, info })
@@ -114,9 +114,9 @@ export async function getInviteCode(email: string, info: any) {
 
 /**
  * Checks that the provided invite code is valid - will return the email address of user that was invited.
- * @param {string} inviteCode the invite code that was provided as part of the link.
- * @param {boolean} deleteCode whether or not the code should be deleted after retrieval - defaults to true.
- * @return {Promise<object>} If the code is valid then an email address will be returned.
+ * @param inviteCode the invite code that was provided as part of the link.
+ * @param deleteCode whether or not the code should be deleted after retrieval - defaults to true.
+ * @return If the code is valid then an email address will be returned.
  */
 export async function checkInviteCode(
   inviteCode: string,