@budibase/worker 3.2.25 → 3.2.27

package/src/api/controllers/system/accounts.ts

@@ -1,7 +1,15 @@
-import { Account, AccountMetadata, Ctx } from "@budibase/types"
+import {
+  Account,
+  AccountMetadata,
+  Ctx,
+  SaveAccountRequest,
+  SaveAccountResponse,
+} from "@budibase/types"
 import * as accounts from "../../../sdk/accounts"
 
-export const save = async (ctx: Ctx<Account, AccountMetadata>) => {
+export const save = async (
+  ctx: Ctx<SaveAccountRequest, SaveAccountResponse>
+) => {
   const account = ctx.request.body as Account
   let metadata: AccountMetadata = {
     _id: accounts.metadata.formatAccountMetadataId(account.accountId),
@@ -14,7 +22,7 @@ export const save = async (ctx: Ctx<Account, AccountMetadata>) => {
   ctx.status = 200
 }
 
-export const destroy = async (ctx: any) => {
+export const destroy = async (ctx: Ctx<void, void>) => {
   const accountId = accounts.metadata.formatAccountMetadataId(
     ctx.params.accountId
   )

package/src/api/controllers/system/environment.ts

@@ -1,4 +1,4 @@
-import { Ctx, MaintenanceType } from "@budibase/types"
+import { Ctx, GetEnvironmentResponse, MaintenanceType } from "@budibase/types"
 import env from "../../../environment"
 import { env as coreEnv, db as dbCore } from "@budibase/backend-core"
 import nodeFetch from "node-fetch"
@@ -38,13 +38,13 @@ async function isSqsMissing() {
   return !(await isSqsAvailable())
 }
 
-export const fetch = async (ctx: Ctx) => {
+export const fetch = async (ctx: Ctx<void, GetEnvironmentResponse>) => {
   ctx.body = {
     multiTenancy: !!env.MULTI_TENANCY,
     offlineMode: !!coreEnv.OFFLINE_MODE,
     cloud: !env.SELF_HOSTED,
     accountPortalUrl: env.ACCOUNT_PORTAL_URL,
-    disableAccountPortal: env.DISABLE_ACCOUNT_PORTAL,
+    disableAccountPortal: !!env.DISABLE_ACCOUNT_PORTAL,
     baseUrl: env.PLATFORM_URL,
     isDev: env.isDev() && !env.isTest(),
     maintenance: [],

package/src/api/controllers/system/logs.ts

@@ -1,7 +1,7 @@
-import { UserCtx } from "@budibase/types"
+import { GetLogResponse, UserCtx } from "@budibase/types"
 import { installation, logging } from "@budibase/backend-core"
 
-export async function getLogs(ctx: UserCtx) {
+export async function getLogs(ctx: UserCtx<void, GetLogResponse>) {
   const logReadStream = logging.system.getLogReadStream()
 
   const { installId } = await installation.getInstall()

package/src/api/controllers/system/migrations.ts

@@ -1,13 +1,23 @@
+import {
+  FetchMigrationDefinitionsResponse,
+  RunGlobalMigrationRequest,
+  UserCtx,
+} from "@budibase/types"
+
 const { migrate, MIGRATIONS } = require("../../../migrations")
 
-export const runMigrations = async (ctx: any) => {
+export const runMigrations = async (
+  ctx: UserCtx<RunGlobalMigrationRequest, void>
+) => {
   const options = ctx.request.body
   // don't await as can take a while, just return
   migrate(options)
   ctx.status = 200
 }
 
-export const fetchDefinitions = async (ctx: any) => {
+export const fetchDefinitions = async (
+  ctx: UserCtx<void, FetchMigrationDefinitionsResponse>
+) => {
   ctx.body = MIGRATIONS
   ctx.status = 200
 }

package/src/api/controllers/system/restore.ts

@@ -1,8 +1,10 @@
 import env from "../../../environment"
-import { BBContext } from "@budibase/types"
+import { SystemRestoreResponse, UserCtx } from "@budibase/types"
 import { cache } from "@budibase/backend-core"
 
-export async function systemRestored(ctx: BBContext) {
+export async function systemRestored(
+  ctx: UserCtx<void, SystemRestoreResponse>
+) {
   if (!env.SELF_HOSTED) {
     ctx.throw(405, "This operation is not allowed in cloud.")
   }

package/src/api/controllers/system/tenants.ts

@@ -1,7 +1,7 @@
-import { UserCtx } from "@budibase/types"
+import { GetTenantInfoResponse, UserCtx } from "@budibase/types"
 import * as tenantSdk from "../../../sdk/tenants"
 
-export async function destroy(ctx: UserCtx) {
+export async function destroy(ctx: UserCtx<void, void>) {
   const user = ctx.user!
   const tenantId = ctx.params.tenantId
 
@@ -18,6 +18,6 @@ export async function destroy(ctx: UserCtx) {
   }
 }
 
-export async function info(ctx: UserCtx) {
+export async function info(ctx: UserCtx<void, GetTenantInfoResponse>) {
   ctx.body = await tenantSdk.tenantInfo(ctx.params.tenantId)
 }

package/src/api/routes/global/email.ts

@@ -1,7 +1,7 @@
 import Router from "@koa/router"
 import * as controller from "../../controllers/global/email"
-import { EmailTemplatePurpose } from "../../../constants"
 import { auth } from "@budibase/backend-core"
+import { EmailTemplatePurpose } from "@budibase/types"
 import Joi from "joi"
 
 const router: Router = new Router()

package/src/api/routes/global/tests/auth.spec.ts

@@ -54,7 +54,7 @@ describe("/api/global/auth", () => {
     describe("POST /api/global/auth/:tenantId/login", () => {
       it("logs in with correct credentials", async () => {
         const tenantId = config.tenantId!
-        const email = config.user?.email!
+        const email = config.user!.email!
         const password = config.userPassword
 
         const response = await config.api.auth.login(tenantId, email, password)
@@ -65,7 +65,7 @@ describe("/api/global/auth", () => {
 
       it("should return 403 with incorrect credentials", async () => {
         const tenantId = config.tenantId!
-        const email = config.user?.email!
+        const email = config.user!.email!
         const password = "incorrect123"
 
         const response = await config.api.auth.login(

package/src/api/routes/global/tests/email.spec.ts

@@ -1,8 +1,8 @@
 jest.mock("nodemailer")
+import { EmailTemplatePurpose } from "@budibase/types"
 import { TestConfiguration, mocks } from "../../../../tests"
 
 const sendMailMock = mocks.email.mock()
-import { EmailTemplatePurpose } from "../../../../constants"
 
 describe("/api/global/email", () => {
   const config = new TestConfiguration()

package/src/api/routes/global/tests/realEmail.spec.ts

@@ -1,11 +1,10 @@
 jest.unmock("node-fetch")
 import { TestConfiguration } from "../../../../tests"
-import { EmailTemplatePurpose } from "../../../../constants"
 import { objectStore } from "@budibase/backend-core"
 import { helpers } from "@budibase/shared-core"
 
 import tk from "timekeeper"
-import { EmailAttachment } from "@budibase/types"
+import { EmailAttachment, EmailTemplatePurpose } from "@budibase/types"
 
 const fetch = require("node-fetch")
 

package/src/api/routes/global/tests/templates.spec.ts

@@ -1,9 +1,6 @@
-import {
-  EmailTemplatePurpose,
-  TemplateMetadata,
-  TemplateType,
-} from "../../../../constants"
+import { TemplateMetadata, TemplateType } from "../../../../constants"
 import { TestConfiguration } from "../../../../tests"
+import { EmailTemplatePurpose } from "@budibase/types"
 
 // TODO
 

package/src/api/routes/global/tests/users.spec.ts

@@ -343,7 +343,7 @@ describe("/api/global/users", () => {
     })
 
     it("should not allow a user to update their own admin/builder status", async () => {
-      const user = (await config.api.users.getUser(config.user?._id!))
+      const user = (await config.api.users.getUser(config.user!._id!))
         .body as User
       await config.api.users.saveUser({
         ...user,

package/src/api/routes/index.ts

@@ -2,7 +2,6 @@ import Router from "@koa/router"
 import { api as pro } from "@budibase/pro"
 import userRoutes from "./global/users"
 import configRoutes from "./global/configs"
-import workspaceRoutes from "./global/workspaces"
 import templateRoutes from "./global/templates"
 import emailRoutes from "./global/email"
 import authRoutes from "./global/auth"
@@ -24,7 +23,6 @@ export const routes: Router[] = [
   configRoutes,
   userRoutes,
   pro.users,
-  workspaceRoutes,
   authRoutes,
   templateRoutes,
   tenantsRoutes,

package/src/api/routes/system/tests/environment.spec.ts

@@ -22,7 +22,7 @@ describe("/api/system/environment", () => {
       const env = await config.api.environment.getEnvironment()
       expect(env.body).toEqual({
         cloud: true,
-        disableAccountPortal: 0,
+        disableAccountPortal: false,
         isDev: false,
         multiTenancy: true,
         baseUrl: "http://localhost:10000",
@@ -36,7 +36,7 @@ describe("/api/system/environment", () => {
         const env = await config.api.environment.getEnvironment()
         expect(env.body).toEqual({
           cloud: false,
-          disableAccountPortal: 0,
+          disableAccountPortal: false,
           isDev: false,
           multiTenancy: true,
           baseUrl: "http://localhost:10000",

package/src/constants/index.ts

@@ -1,4 +1,5 @@
 import { constants } from "@budibase/backend-core"
+import { EmailTemplatePurpose } from "@budibase/types"
 
 export const LOGO_URL =
   "https://d33wubrfki0l68.cloudfront.net/aac32159d7207b5085e74a7ef67afbb7027786c5/2b1fd/img/logo/bb-emblem.svg"
@@ -19,15 +20,6 @@ export enum TemplateType {
   EMAIL = "email",
 }
 
-export enum EmailTemplatePurpose {
-  CORE = "core",
-  BASE = "base",
-  PASSWORD_RECOVERY = "password_recovery",
-  INVITATION = "invitation",
-  WELCOME = "welcome",
-  CUSTOM = "custom",
-}
-
 export enum TemplateMetadataNames {
   BASE = "Base format",
   PASSWORD_RECOVERY = "Password recovery",

package/src/constants/templates/index.ts

@@ -1,13 +1,8 @@
 import { readStaticFile } from "../../utilities/fileSystem"
-import {
-  EmailTemplatePurpose,
-  TemplateType,
-  TemplatePurpose,
-  GLOBAL_OWNER,
-} from "../index"
+import { TemplateType, TemplatePurpose, GLOBAL_OWNER } from "../index"
 import { join } from "path"
 import { db as dbCore, tenancy } from "@budibase/backend-core"
-import { Template } from "@budibase/types"
+import { Template, EmailTemplatePurpose } from "@budibase/types"
 
 export const EmailTemplates = {
   [EmailTemplatePurpose.PASSWORD_RECOVERY]: readStaticFile(
@@ -53,26 +48,33 @@ export function addBaseTemplates(templates: Template[], type?: string) {
 export async function getTemplates({
   ownerId,
   type,
-  id,
-}: { ownerId?: string; type?: string; id?: string } = {}) {
+}: { ownerId?: string; type?: string } = {}) {
   const db = tenancy.getGlobalDB()
   const response = await db.allDocs<Template>(
-    dbCore.getTemplateParams(ownerId || GLOBAL_OWNER, id, {
+    dbCore.getTemplateParams(ownerId || GLOBAL_OWNER, undefined, {
       include_docs: true,
     })
   )
   let templates = response.rows.map(row => row.doc!)
-  // should only be one template with ID
-  if (id) {
-    return templates[0]
-  }
   if (type) {
     templates = templates.filter(template => template.type === type)
   }
   return addBaseTemplates(templates, type)
 }
 
+export async function getTemplateByID(id: string, ownerId?: string) {
+  const db = tenancy.getGlobalDB()
+  const response = await db.allDocs<Template>(
+    dbCore.getTemplateParams(ownerId || GLOBAL_OWNER, id, {
+      include_docs: true,
+    })
+  )
+  let templates = response.rows.map(row => row.doc!)
+  // should only be one template with ID
+  return templates[0]
+}
+
 export async function getTemplateByPurpose(type: string, purpose: string) {
-  const templates = (await getTemplates({ type })) as Template[]
+  const templates = await getTemplates({ type })
   return templates.find((template: Template) => template.purpose === purpose)
 }

package/src/middleware/cloudRestricted.ts

@@ -1,12 +1,12 @@
 import env from "../environment"
 import { constants, utils } from "@budibase/backend-core"
-import { BBContext } from "@budibase/types"
+import { UserCtx } from "@budibase/types"
 
 /**
  * This is a restricted endpoint in the cloud.
  * Ensure that the correct API key has been supplied.
  */
-export default async (ctx: BBContext, next: any) => {
+export default async (ctx: UserCtx, next: any) => {
   if (!env.SELF_HOSTED && !env.DISABLE_ACCOUNT_PORTAL) {
     const apiKey = ctx.request.headers[constants.Header.API_KEY]
     if (!apiKey) {

package/src/middleware/handleScimBody.ts

@@ -1,7 +1,7 @@
 import { Ctx } from "@budibase/types"
 
 export const handleScimBody = (ctx: Ctx, next: any) => {
-  var type = ctx.req.headers["content-type"] || ""
+  let type = ctx.req.headers["content-type"] || ""
   type = type.split(";")[0]
 
   if (type === "application/scim+json") {

package/src/sdk/accounts/metadata.ts

@@ -40,10 +40,7 @@ export const getMetadata = async (
     try {
       return await db.get(accountId)
     } catch (e: any) {
-      if (e.status === 404) {
-        // do nothing
-        return
-      } else {
+      if (e.status !== 404) {
         throw e
       }
     }

package/src/sdk/auth/auth.ts

@@ -8,11 +8,10 @@ import {
   utils as coreUtils,
   cache,
 } from "@budibase/backend-core"
-import { PlatformLogoutOpts, User } from "@budibase/types"
+import { PlatformLogoutOpts, User, EmailTemplatePurpose } from "@budibase/types"
 import jwt from "jsonwebtoken"
 import * as userSdk from "../users"
 import * as emails from "../../utilities/email"
-import { EmailTemplatePurpose } from "../../constants"
 
 // LOGIN / LOGOUT
 

package/src/sdk/users/users.ts

@@ -3,9 +3,9 @@ import {
   InviteUserRequest,
   InviteUsersRequest,
   InviteUsersResponse,
+  EmailTemplatePurpose,
 } from "@budibase/types"
 import { sendEmail } from "../../utilities/email"
-import { EmailTemplatePurpose } from "../../constants"
 
 export async function invite(
   users: InviteUsersRequest

package/src/tests/api/accounts.ts

@@ -1,12 +1,7 @@
 import { Account, AccountMetadata } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 
 export class AccountAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   saveMetadata = async (account: Account) => {
     const res = await this.request
       .put(`/api/system/accounts/${account.accountId}/metadata`)

package/src/tests/api/auditLogs.ts

@@ -1,12 +1,7 @@
 import { AuditLogSearchParams, SearchAuditLogsResponse } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 
 export class AuditLogAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   search = async (search: AuditLogSearchParams) => {
     const res = await this.request
       .post("/api/global/auditlogs/search")

package/src/tests/api/auth.ts

@@ -1,11 +1,6 @@
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI, TestAPIOpts } from "./base"
 
 export class AuthAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   updatePassword = (
     resetCode: string,
     password: string,

package/src/tests/api/base.ts

@@ -10,7 +10,7 @@ export abstract class TestAPI {
   config: TestConfiguration
   request: SuperTest<Test>
 
-  protected constructor(config: TestConfiguration) {
+  constructor(config: TestConfiguration) {
     this.config = config
     this.request = config.request
   }

package/src/tests/api/configs.ts

@@ -1,11 +1,6 @@
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 
 export class ConfigAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   getConfigChecklist = () => {
     return this.request
       .get(`/api/global/configs/checklist`)

package/src/tests/api/email.ts

@@ -1,12 +1,7 @@
 import { EmailAttachment } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 
 export class EmailAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   sendEmail = (purpose: string, attachments?: EmailAttachment[]) => {
     return this.request
       .post(`/api/global/email/send`)
@@ -15,7 +10,7 @@ export class EmailAPI extends TestAPI {
         attachments,
         purpose,
         tenantId: this.config.getTenantId(),
-        userId: this.config.user?._id!,
+        userId: this.config.user!._id!,
       })
       .set(this.config.defaultHeaders())
       .expect("Content-Type", /json/)

package/src/tests/api/environment.ts

@@ -1,11 +1,6 @@
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 
 export class EnvironmentAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   getEnvironment = () => {
     return this.request
       .get(`/api/system/environment`)

package/src/tests/api/groups.ts

@@ -1,12 +1,7 @@
 import { UserGroup } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 
 export class GroupsAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   saveGroup = (
     group: UserGroup,
     { expect }: { expect: number | object } = { expect: 200 }

package/src/tests/api/license.ts

@@ -1,4 +1,3 @@
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 import {
   ActivateLicenseKeyRequest,
@@ -6,10 +5,6 @@ import {
 } from "@budibase/types"
 
 export class LicenseAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   refresh = async () => {
     return this.request
       .post("/api/global/license/refresh")

package/src/tests/api/migrations.ts

@@ -1,11 +1,6 @@
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI, TestAPIOpts } from "./base"
 
 export class MigrationAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   runMigrations = (opts?: TestAPIOpts) => {
     return this.request
       .post(`/api/system/migrations/run`)

package/src/tests/api/restore.ts

@@ -1,11 +1,6 @@
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI, TestAPIOpts } from "./base"
 
 export class RestoreAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   restored = (opts?: TestAPIOpts) => {
     return this.request
       .post(`/api/system/restored`)

package/src/tests/api/roles.ts

@@ -1,11 +1,6 @@
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI, TestAPIOpts } from "./base"
 
 export class RolesAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   get = (opts?: TestAPIOpts) => {
     return this.request
       .get(`/api/global/roles`)

package/src/tests/api/scim/groups.ts

@@ -4,14 +4,9 @@ import {
   ScimGroupResponse,
   ScimUpdateRequest,
 } from "@budibase/types"
-import TestConfiguration from "../../TestConfiguration"
 import { RequestSettings, ScimTestAPI } from "./shared"
 
 export class ScimGroupsAPI extends ScimTestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   get = async (
     requestSettings?: Partial<RequestSettings> & {
       params?: {

package/src/tests/api/scim/shared.ts

@@ -1,4 +1,3 @@
-import TestConfiguration from "../../TestConfiguration"
 import { TestAPI } from "../base"
 
 const defaultConfig: RequestSettings = {
@@ -14,10 +13,6 @@ export type RequestSettings = {
 }
 
 export abstract class ScimTestAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   call = (
     url: string,
     method: "get" | "post" | "patch" | "delete",

package/src/tests/api/scim/users.ts

@@ -4,14 +4,9 @@ import {
   ScimUserResponse,
   ScimUpdateRequest,
 } from "@budibase/types"
-import TestConfiguration from "../../TestConfiguration"
 import { RequestSettings, ScimTestAPI } from "./shared"
 
 export class ScimUsersAPI extends ScimTestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   get = async (
     requestSettings?: Partial<RequestSettings> & {
       params?: {

package/src/tests/api/self.ts

@@ -1,12 +1,7 @@
-import TestConfiguration from "../TestConfiguration"
 import { User } from "@budibase/types"
 import { TestAPI } from "./base"
 
 export class SelfAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   updateSelf = (user: User, update: any) => {
     return this.request
       .post(`/api/global/self`)

package/src/tests/api/status.ts

@@ -1,11 +1,6 @@
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 
 export class StatusAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   getStatus = () => {
     return this.request.get(`/api/system/status`).expect(200)
   }

package/src/tests/api/templates.ts

@@ -1,11 +1,6 @@
-import TestConfiguration from "../TestConfiguration"
 import { TestAPI, TestAPIOpts } from "./base"
 
 export class TemplatesAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   definitions = (opts?: TestAPIOpts) => {
     return this.request
       .get(`/api/global/template/definitions`)