From 8c8a973c91ca9ca2f8baf062c98ac2ba718f9454 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Wed, 4 Dec 2024 18:34:16 +0000
Subject: [PATCH 01/15] Auth API typing.

---
 packages/types/src/api/web/auth.ts            | 14 +++++++
 .../worker/src/api/controllers/global/auth.ts | 38 +++++++++++++------
 2 files changed, 40 insertions(+), 12 deletions(-)

diff --git a/packages/types/src/api/web/auth.ts b/packages/types/src/api/web/auth.ts
index d631762b30..0964d71576 100644
--- a/packages/types/src/api/web/auth.ts
+++ b/packages/types/src/api/web/auth.ts
@@ -3,14 +3,28 @@ export interface LoginRequest {
   password: string
 }
 
+export interface LogoutResponse {
+  message: string
+}
+
+export interface SetInitInfoRequest extends Record<string, any> {}
+
+export interface GetInitInfoResponse extends Record<string, any> {}
+
 export interface PasswordResetRequest {
   email: string
 }
+export interface PasswordResetResponse {
+  message: string
+}
 
 export interface PasswordResetUpdateRequest {
   resetCode: string
   password: string
 }
+export interface PasswordResetUpdateResponse {
+  message: string
+}
 
 export interface UpdateSelfRequest {
   firstName?: string
diff --git a/packages/worker/src/api/controllers/global/auth.ts b/packages/worker/src/api/controllers/global/auth.ts
index 530a1df102..1e6b0d3aab 100644
--- a/packages/worker/src/api/controllers/global/auth.ts
+++ b/packages/worker/src/api/controllers/global/auth.ts
@@ -16,8 +16,15 @@ import {
   PasswordResetUpdateRequest,
   GoogleInnerConfig,
   DatasourceAuthCookie,
+  LogoutResponse,
+  UserCtx,
+  SetInitInfoRequest,
+  GetInitInfoResponse,
+  PasswordResetResponse,
+  PasswordResetUpdateResponse,
 } from "@budibase/types"
 import env from "../../../environment"
+import { Next } from "koa"
 
 import * as authSdk from "../../../sdk/auth"
 import * as userSdk from "../../../sdk/users"
@@ -52,7 +59,7 @@ async function passportCallback(
   ctx.set(Header.TOKEN, token)
 }
 
-export const login = async (ctx: Ctx<LoginRequest>, next: any) => {
+export const login = async (ctx: Ctx<LoginRequest, void>, next: Next) => {
   const email = ctx.request.body.username
 
   const user = await userSdk.db.getUserByEmail(email)
@@ -72,7 +79,7 @@ export const login = async (ctx: Ctx<LoginRequest>, next: any) => {
   )(ctx, next)
 }
 
-export const logout = async (ctx: any) => {
+export const logout = async (ctx: UserCtx<void, LogoutResponse>) => {
   if (ctx.user && ctx.user._id) {
     await authSdk.logout({ ctx, userId: ctx.user._id })
   }
@@ -81,13 +88,13 @@ export const logout = async (ctx: any) => {
 
 // INIT
 
-export const setInitInfo = (ctx: any) => {
+export const setInitInfo = (ctx: UserCtx<SetInitInfoRequest, void>) => {
   const initInfo = ctx.request.body
   setCookie(ctx, initInfo, Cookie.Init)
   ctx.status = 200
 }
 
-export const getInitInfo = (ctx: any) => {
+export const getInitInfo = (ctx: UserCtx<void, GetInitInfoResponse>) => {
   try {
     ctx.body = getCookie(ctx, Cookie.Init) || {}
   } catch (err) {
@@ -101,7 +108,9 @@ export const getInitInfo = (ctx: any) => {
 /**
  * Reset the user password, used as part of a forgotten password flow.
  */
-export const reset = async (ctx: Ctx<PasswordResetRequest>) => {
+export const reset = async (
+  ctx: Ctx<PasswordResetRequest, PasswordResetResponse>
+) => {
   const { email } = ctx.request.body
 
   await authSdk.reset(email)
@@ -114,7 +123,9 @@ export const reset = async (ctx: Ctx<PasswordResetRequest>) => {
 /**
  * Perform the user password update if the provided reset code is valid.
  */
-export const resetUpdate = async (ctx: Ctx<PasswordResetUpdateRequest>) => {
+export const resetUpdate = async (
+  ctx: Ctx<PasswordResetUpdateRequest, PasswordResetUpdateResponse>
+) => {
   const { resetCode, password } = ctx.request.body
   try {
     await authSdk.resetUpdate(resetCode, password)
@@ -130,7 +141,10 @@ export const resetUpdate = async (ctx: Ctx<PasswordResetUpdateRequest>) => {
 
 // DATASOURCE
 
-export const datasourcePreAuth = async (ctx: any, next: any) => {
+export const datasourcePreAuth = async (
+  ctx: UserCtx<void, void>,
+  next: Next
+) => {
   const provider = ctx.params.provider
   const { middleware } = require(`@budibase/backend-core`)
   const handler = middleware.datasource[provider]
@@ -147,7 +161,7 @@ export const datasourcePreAuth = async (ctx: any, next: any) => {
   return handler.preAuth(passport, ctx, next)
 }
 
-export const datasourceAuth = async (ctx: any, next: any) => {
+export const datasourceAuth = async (ctx: UserCtx<void, void>, next: Next) => {
   const authStateCookie = getCookie<DatasourceAuthCookie>(
     ctx,
     Cookie.DatasourceAuth
@@ -171,7 +185,7 @@ export async function googleCallbackUrl(config?: GoogleInnerConfig) {
  * The initial call that google authentication makes to take you to the google login screen.
  * On a successful login, you will be redirected to the googleAuth callback route.
  */
-export const googlePreAuth = async (ctx: any, next: any) => {
+export const googlePreAuth = async (ctx: Ctx<void, void>, next: Next) => {
   const config = await configs.getGoogleConfig()
   if (!config) {
     return ctx.throw(400, "Google config not found")
@@ -190,7 +204,7 @@ export const googlePreAuth = async (ctx: any, next: any) => {
   })(ctx, next)
 }
 
-export const googleCallback = async (ctx: any, next: any) => {
+export const googleCallback = async (ctx: Ctx<void, void>, next: Next) => {
   const config = await configs.getGoogleConfig()
   if (!config) {
     return ctx.throw(400, "Google config not found")
@@ -241,7 +255,7 @@ export const oidcStrategyFactory = async (ctx: any) => {
  * The initial call that OIDC authentication makes to take you to the configured OIDC login screen.
  * On a successful login, you will be redirected to the oidcAuth callback route.
  */
-export const oidcPreAuth = async (ctx: Ctx, next: any) => {
+export const oidcPreAuth = async (ctx: Ctx<void, void>, next: Next) => {
   const { configId } = ctx.params
   if (!configId) {
     ctx.throw(400, "OIDC config id is required")
@@ -266,7 +280,7 @@ export const oidcPreAuth = async (ctx: Ctx, next: any) => {
   })(ctx, next)
 }
 
-export const oidcCallback = async (ctx: any, next: any) => {
+export const oidcCallback = async (ctx: Ctx<void, void>, next: Next) => {
   const strategy = await oidcStrategyFactory(ctx)
 
   return passport.authenticate(

From 60e4d3f0e6dedb16cc5e9f9dd53ec8bf62231c92 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Thu, 5 Dec 2024 14:50:50 +0000
Subject: [PATCH 02/15] Config API typing.

---
 packages/types/src/api/web/global/configs.ts  | 39 ++++++++++++++++++-
 .../src/api/controllers/global/configs.ts     | 20 +++++++---
 2 files changed, 52 insertions(+), 7 deletions(-)

diff --git a/packages/types/src/api/web/global/configs.ts b/packages/types/src/api/web/global/configs.ts
index b36d974904..e16ed3c27f 100644
--- a/packages/types/src/api/web/global/configs.ts
+++ b/packages/types/src/api/web/global/configs.ts
@@ -1,4 +1,10 @@
-import { SettingsConfig, SettingsInnerConfig } from "../../../documents"
+import {
+  Config,
+  ConfigType,
+  SettingsBrandingConfig,
+  SettingsConfig,
+  SettingsInnerConfig,
+} from "../../../documents"
 
 /**
  * Settings that aren't stored in the database - enriched at runtime.
@@ -22,3 +28,34 @@ export interface PublicOIDCConfig {
 }
 
 export type GetPublicOIDCConfigResponse = PublicOIDCConfig[]
+
+export interface SaveConfigRequest extends Config {}
+export interface SaveConfigResponse {
+  type: ConfigType
+  _id: string
+  _rev: string
+}
+
+export interface DeleteConfigResponse {
+  message: string
+}
+
+interface ChecklistItem {
+  checked: boolean
+  label: string
+  link: string
+}
+export interface ConfigChecklistResponse {
+  apps: ChecklistItem
+  smtp: ChecklistItem
+  adminUser: ChecklistItem
+  sso: ChecklistItem
+  branding: SettingsBrandingConfig
+}
+
+export type FindConfigResponse = Config | {}
+
+export interface UploadConfigFileResponse {
+  message: string
+  url: string
+}
diff --git a/packages/worker/src/api/controllers/global/configs.ts b/packages/worker/src/api/controllers/global/configs.ts
index b3f02a44c6..a10fce35f6 100644
--- a/packages/worker/src/api/controllers/global/configs.ts
+++ b/packages/worker/src/api/controllers/global/configs.ts
@@ -15,8 +15,11 @@ import {
   AIConfig,
   AIInnerConfig,
   Config,
+  ConfigChecklistResponse,
   ConfigType,
   Ctx,
+  DeleteConfigResponse,
+  FindConfigResponse,
   GetPublicOIDCConfigResponse,
   GetPublicSettingsResponse,
   GoogleInnerConfig,
@@ -29,11 +32,14 @@ import {
   OIDCLogosConfig,
   PASSWORD_REPLACEMENT,
   QuotaUsageType,
+  SaveConfigRequest,
+  SaveConfigResponse,
   SettingsBrandingConfig,
   SettingsInnerConfig,
   SSOConfig,
   SSOConfigType,
   StaticQuotaName,
+  UploadConfigFileResponse,
   UserCtx,
 } from "@budibase/types"
 import * as pro from "@budibase/pro"
@@ -225,7 +231,9 @@ export async function verifyAIConfig(
   }
 }
 
-export async function save(ctx: UserCtx<Config>) {
+export async function save(
+  ctx: UserCtx<SaveConfigRequest, SaveConfigResponse>
+) {
   const body = ctx.request.body
   const type = body.type
   const config = body.config
@@ -337,7 +345,7 @@ function enrichOIDCLogos(oidcLogos: OIDCLogosConfig) {
   )
 }
 
-export async function find(ctx: UserCtx) {
+export async function find(ctx: UserCtx<void, FindConfigResponse>) {
   try {
     // Find the config with the most granular scope based on context
     const type = ctx.params.type
@@ -473,7 +481,7 @@ export async function publicSettings(
   }
 }
 
-export async function upload(ctx: UserCtx) {
+export async function upload(ctx: UserCtx<void, UploadConfigFileResponse>) {
   if (ctx.request.files == null || Array.isArray(ctx.request.files.file)) {
     ctx.throw(400, "One file must be uploaded.")
   }
@@ -518,7 +526,7 @@ export async function upload(ctx: UserCtx) {
   }
 }
 
-export async function destroy(ctx: UserCtx) {
+export async function destroy(ctx: UserCtx<void, DeleteConfigResponse>) {
   const db = tenancy.getGlobalDB()
   const { id, rev } = ctx.params
   try {
@@ -537,14 +545,14 @@ export async function destroy(ctx: UserCtx) {
   }
 }
 
-export async function configChecklist(ctx: Ctx) {
+export async function configChecklist(ctx: Ctx<void, ConfigChecklistResponse>) {
   const tenantId = tenancy.getTenantId()
 
   try {
     ctx.body = await cache.withCache(
       cache.CacheKey.CHECKLIST,
       env.CHECKLIST_CACHE_TTL,
-      async () => {
+      async (): Promise<ConfigChecklistResponse> => {
         let apps = []
         if (!env.MULTI_TENANCY || tenantId) {
           // Apps exist

From cbab77ea240228d86dc86f63669f18d5108256ff Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Thu, 5 Dec 2024 14:59:15 +0000
Subject: [PATCH 03/15] Email API typing.

---
 packages/types/src/api/web/global/email.ts    | 28 +++++++++++++++++++
 packages/types/src/api/web/global/index.ts    |  1 +
 .../src/api/controllers/global/email.ts       | 11 ++++++--
 .../worker/src/api/routes/global/email.ts     |  2 +-
 .../src/api/routes/global/tests/email.spec.ts |  2 +-
 .../api/routes/global/tests/realEmail.spec.ts |  3 +-
 .../api/routes/global/tests/templates.spec.ts |  7 ++---
 packages/worker/src/constants/index.ts        | 10 +------
 .../worker/src/constants/templates/index.ts   |  9 ++----
 packages/worker/src/sdk/auth/auth.ts          |  3 +-
 packages/worker/src/sdk/users/users.ts        |  2 +-
 packages/worker/src/utilities/email.ts        |  9 ++++--
 packages/worker/src/utilities/templates.ts    |  7 ++---
 13 files changed, 57 insertions(+), 37 deletions(-)
 create mode 100644 packages/types/src/api/web/global/email.ts

diff --git a/packages/types/src/api/web/global/email.ts b/packages/types/src/api/web/global/email.ts
new file mode 100644
index 0000000000..a0ca0e8485
--- /dev/null
+++ b/packages/types/src/api/web/global/email.ts
@@ -0,0 +1,28 @@
+import { EmailAttachment, EmailInvite } from "../../../documents"
+
+export enum EmailTemplatePurpose {
+  CORE = "core",
+  BASE = "base",
+  PASSWORD_RECOVERY = "password_recovery",
+  INVITATION = "invitation",
+  WELCOME = "welcome",
+  CUSTOM = "custom",
+}
+
+export interface SendEmailRequest {
+  workspaceId?: string
+  email: string
+  userId: string
+  purpose: EmailTemplatePurpose
+  contents?: string
+  from?: string
+  subject: string
+  cc?: boolean
+  bcc?: boolean
+  automation?: boolean
+  invite?: EmailInvite
+  attachments?: EmailAttachment[]
+}
+export interface SendEmailResponse extends Record<string, any> {
+  message: string
+}
diff --git a/packages/types/src/api/web/global/index.ts b/packages/types/src/api/web/global/index.ts
index c43f2928d8..0cabb97974 100644
--- a/packages/types/src/api/web/global/index.ts
+++ b/packages/types/src/api/web/global/index.ts
@@ -5,3 +5,4 @@ export * from "./configs"
 export * from "./scim"
 export * from "./license"
 export * from "./oldMigration"
+export * from "./email"
diff --git a/packages/worker/src/api/controllers/global/email.ts b/packages/worker/src/api/controllers/global/email.ts
index 74a811376a..ad0fc3fa32 100644
--- a/packages/worker/src/api/controllers/global/email.ts
+++ b/packages/worker/src/api/controllers/global/email.ts
@@ -1,8 +1,15 @@
 import { sendEmail as sendEmailFn } from "../../../utilities/email"
 import { tenancy } from "@budibase/backend-core"
-import { BBContext, User } from "@budibase/types"
+import {
+  UserCtx,
+  User,
+  SendEmailRequest,
+  SendEmailResponse,
+} from "@budibase/types"
 
-export async function sendEmail(ctx: BBContext) {
+export async function sendEmail(
+  ctx: UserCtx<SendEmailRequest, SendEmailResponse>
+) {
   let {
     workspaceId,
     email,
diff --git a/packages/worker/src/api/routes/global/email.ts b/packages/worker/src/api/routes/global/email.ts
index 94e6b9bce5..6b60da47b5 100644
--- a/packages/worker/src/api/routes/global/email.ts
+++ b/packages/worker/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()
diff --git a/packages/worker/src/api/routes/global/tests/email.spec.ts b/packages/worker/src/api/routes/global/tests/email.spec.ts
index 49d7c3bbeb..eb46c501d9 100644
--- a/packages/worker/src/api/routes/global/tests/email.spec.ts
+++ b/packages/worker/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()
diff --git a/packages/worker/src/api/routes/global/tests/realEmail.spec.ts b/packages/worker/src/api/routes/global/tests/realEmail.spec.ts
index 99dfb7f824..bf5ed7b4ee 100644
--- a/packages/worker/src/api/routes/global/tests/realEmail.spec.ts
+++ b/packages/worker/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")
 
diff --git a/packages/worker/src/api/routes/global/tests/templates.spec.ts b/packages/worker/src/api/routes/global/tests/templates.spec.ts
index 982cae28b5..786023101e 100644
--- a/packages/worker/src/api/routes/global/tests/templates.spec.ts
+++ b/packages/worker/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
 
diff --git a/packages/worker/src/constants/index.ts b/packages/worker/src/constants/index.ts
index 17fce666db..309fdeebc1 100644
--- a/packages/worker/src/constants/index.ts
+++ b/packages/worker/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",
diff --git a/packages/worker/src/constants/templates/index.ts b/packages/worker/src/constants/templates/index.ts
index 6dd3f556a6..43c5b0870f 100644
--- a/packages/worker/src/constants/templates/index.ts
+++ b/packages/worker/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(
diff --git a/packages/worker/src/sdk/auth/auth.ts b/packages/worker/src/sdk/auth/auth.ts
index 078ac441e9..82602f58aa 100644
--- a/packages/worker/src/sdk/auth/auth.ts
+++ b/packages/worker/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
 
diff --git a/packages/worker/src/sdk/users/users.ts b/packages/worker/src/sdk/users/users.ts
index 9dc1bac0e9..343108cbeb 100644
--- a/packages/worker/src/sdk/users/users.ts
+++ b/packages/worker/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
diff --git a/packages/worker/src/utilities/email.ts b/packages/worker/src/utilities/email.ts
index bf686f647c..fa9dd7a6fa 100644
--- a/packages/worker/src/utilities/email.ts
+++ b/packages/worker/src/utilities/email.ts
@@ -1,9 +1,14 @@
 import env from "../environment"
-import { EmailTemplatePurpose, TemplateType } from "../constants"
+import { TemplateType } from "../constants"
 import { getTemplateByPurpose, EmailTemplates } from "../constants/templates"
 import { getSettingsTemplateContext } from "./templates"
 import { processString } from "@budibase/string-templates"
-import { User, SendEmailOpts, SMTPInnerConfig } from "@budibase/types"
+import {
+  User,
+  SendEmailOpts,
+  SMTPInnerConfig,
+  EmailTemplatePurpose,
+} from "@budibase/types"
 import { configs, cache, objectStore } from "@budibase/backend-core"
 import ical from "ical-generator"
 import _ from "lodash"
diff --git a/packages/worker/src/utilities/templates.ts b/packages/worker/src/utilities/templates.ts
index c9e86ae4f9..cdfbb9b0ff 100644
--- a/packages/worker/src/utilities/templates.ts
+++ b/packages/worker/src/utilities/templates.ts
@@ -1,9 +1,6 @@
 import { tenancy, configs } from "@budibase/backend-core"
-import {
-  InternalTemplateBinding,
-  LOGO_URL,
-  EmailTemplatePurpose,
-} from "../constants"
+import { EmailTemplatePurpose } from "@budibase/types"
+import { InternalTemplateBinding, LOGO_URL } from "../constants"
 import { checkSlashesInUrl } from "./index"
 
 const BASE_COMPANY = "Budibase"

From c0df3e67b38528a89b3c81bf9bb9037d4439f7b5 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Thu, 5 Dec 2024 15:01:48 +0000
Subject: [PATCH 04/15] Licensing API typing.

---
 packages/types/src/api/web/global/license.ts          | 4 ++++
 packages/worker/src/api/controllers/global/license.ts | 9 ++++++---
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/packages/types/src/api/web/global/license.ts b/packages/types/src/api/web/global/license.ts
index 21d8876412..344ab829c2 100644
--- a/packages/types/src/api/web/global/license.ts
+++ b/packages/types/src/api/web/global/license.ts
@@ -1,5 +1,7 @@
 // LICENSE KEY
 
+import { QuotaUsage } from "../../../documents"
+
 export interface ActivateLicenseKeyRequest {
   licenseKey: string
 }
@@ -23,3 +25,5 @@ export interface GetOfflineLicenseTokenResponse {
 export interface GetOfflineIdentifierResponse {
   identifierBase64: string
 }
+
+export interface GetQuotaUsageResponse extends QuotaUsage {}
diff --git a/packages/worker/src/api/controllers/global/license.ts b/packages/worker/src/api/controllers/global/license.ts
index 111cb5cea3..04f76a6593 100644
--- a/packages/worker/src/api/controllers/global/license.ts
+++ b/packages/worker/src/api/controllers/global/license.ts
@@ -5,6 +5,7 @@ import {
   GetLicenseKeyResponse,
   GetOfflineIdentifierResponse,
   GetOfflineLicenseTokenResponse,
+  GetQuotaUsageResponse,
   UserCtx,
 } from "@budibase/types"
 
@@ -36,7 +37,7 @@ export async function deleteLicenseKey(ctx: UserCtx<void, void>) {
 // OFFLINE LICENSE
 
 export async function activateOfflineLicenseToken(
-  ctx: UserCtx<ActivateOfflineLicenseTokenRequest>
+  ctx: UserCtx<ActivateOfflineLicenseTokenRequest, void>
 ) {
   const { offlineLicenseToken } = ctx.request.body
   await licensing.offline.activateOfflineLicenseToken(offlineLicenseToken)
@@ -70,14 +71,16 @@ export async function getOfflineLicenseIdentifier(
 
 // LICENSES
 
-export const refresh = async (ctx: any) => {
+export const refresh = async (ctx: UserCtx<void, void>) => {
   await licensing.cache.refresh()
   ctx.status = 200
 }
 
 // USAGE
 
-export const getQuotaUsage = async (ctx: any) => {
+export const getQuotaUsage = async (
+  ctx: UserCtx<void, GetQuotaUsageResponse>
+) => {
   ctx.body = await quotas.getQuotaUsage()
   ctx.status = 200
 }

From 54c11e33c5f649f52389e39a77b343d84cec1a62 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Thu, 5 Dec 2024 15:56:04 +0000
Subject: [PATCH 05/15] Role API typing.

---
 packages/types/src/api/web/global/index.ts      |  1 +
 packages/types/src/api/web/global/role.ts       | 17 +++++++++++++++++
 .../worker/src/api/controllers/global/roles.ts  | 14 ++++++++++----
 3 files changed, 28 insertions(+), 4 deletions(-)
 create mode 100644 packages/types/src/api/web/global/role.ts

diff --git a/packages/types/src/api/web/global/index.ts b/packages/types/src/api/web/global/index.ts
index 0cabb97974..e0c585a932 100644
--- a/packages/types/src/api/web/global/index.ts
+++ b/packages/types/src/api/web/global/index.ts
@@ -6,3 +6,4 @@ export * from "./scim"
 export * from "./license"
 export * from "./oldMigration"
 export * from "./email"
+export * from "./role"
diff --git a/packages/types/src/api/web/global/role.ts b/packages/types/src/api/web/global/role.ts
new file mode 100644
index 0000000000..1d45995fd2
--- /dev/null
+++ b/packages/types/src/api/web/global/role.ts
@@ -0,0 +1,17 @@
+import { Role } from "../../../documents"
+
+interface GlobalRoleResponse {
+  roles: Role[]
+  name: string
+  version: string
+  url?: string
+}
+
+export interface FetchGlobalRolesResponse
+  extends Record<string, GlobalRoleResponse> {}
+
+export interface FindGlobalRoleResponse extends GlobalRoleResponse {}
+
+export interface RemoveAppRoleResponse {
+  message: string
+}
diff --git a/packages/worker/src/api/controllers/global/roles.ts b/packages/worker/src/api/controllers/global/roles.ts
index e1a3130924..fb93ab504c 100644
--- a/packages/worker/src/api/controllers/global/roles.ts
+++ b/packages/worker/src/api/controllers/global/roles.ts
@@ -6,9 +6,15 @@ import {
   tenancy,
 } from "@budibase/backend-core"
 import sdk from "../../../sdk"
-import { Ctx, App } from "@budibase/types"
+import {
+  Ctx,
+  App,
+  FetchGlobalRolesResponse,
+  FindGlobalRoleResponse,
+  RemoveAppRoleResponse,
+} from "@budibase/types"
 
-export async function fetch(ctx: Ctx) {
+export async function fetch(ctx: Ctx<void, FetchGlobalRolesResponse>) {
   const tenantId = ctx.user!.tenantId
   // always use the dev apps as they'll be most up to date (true)
   const apps = (await dbCore.getAllApps({ tenantId, all: true })) as App[]
@@ -31,7 +37,7 @@ export async function fetch(ctx: Ctx) {
   ctx.body = response
 }
 
-export async function find(ctx: Ctx) {
+export async function find(ctx: Ctx<void, FindGlobalRoleResponse>) {
   const appId = ctx.params.appId
   await context.doInAppContext(dbCore.getDevAppID(appId), async () => {
     const db = context.getAppDB()
@@ -45,7 +51,7 @@ export async function find(ctx: Ctx) {
   })
 }
 
-export async function removeAppRole(ctx: Ctx) {
+export async function removeAppRole(ctx: Ctx<void, RemoveAppRoleResponse>) {
   const { appId } = ctx.params
   const db = tenancy.getGlobalDB()
   const users = await sdk.users.db.allUsers()

From cdabe324ad928304bdb745a1e10c271a80eec944 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Thu, 5 Dec 2024 16:07:16 +0000
Subject: [PATCH 06/15] Self API typing.

---
 packages/types/src/api/web/global/index.ts    |  1 +
 packages/types/src/api/web/global/self.ts     | 12 ++++++++++
 .../types/src/documents/global/devInfo.ts     |  6 +++++
 packages/types/src/documents/global/index.ts  |  1 +
 .../worker/src/api/controllers/global/self.ts | 24 ++++++++++++-------
 5 files changed, 36 insertions(+), 8 deletions(-)
 create mode 100644 packages/types/src/api/web/global/self.ts
 create mode 100644 packages/types/src/documents/global/devInfo.ts

diff --git a/packages/types/src/api/web/global/index.ts b/packages/types/src/api/web/global/index.ts
index e0c585a932..8359d8cd1a 100644
--- a/packages/types/src/api/web/global/index.ts
+++ b/packages/types/src/api/web/global/index.ts
@@ -7,3 +7,4 @@ export * from "./license"
 export * from "./oldMigration"
 export * from "./email"
 export * from "./role"
+export * from "./self"
diff --git a/packages/types/src/api/web/global/self.ts b/packages/types/src/api/web/global/self.ts
new file mode 100644
index 0000000000..4ba51d2cd5
--- /dev/null
+++ b/packages/types/src/api/web/global/self.ts
@@ -0,0 +1,12 @@
+import { DevInfo, User } from "../../../documents"
+
+export interface GenerateAPIKeyRequest {
+  userId: string
+}
+export interface GenerateAPIKeyResponse extends DevInfo {}
+
+export interface FetchAPIKeyResponse extends DevInfo {}
+
+export interface GetGlobalSelfResponse extends User {
+  flags?: Record<string, string>
+}
diff --git a/packages/types/src/documents/global/devInfo.ts b/packages/types/src/documents/global/devInfo.ts
new file mode 100644
index 0000000000..f993fc5df6
--- /dev/null
+++ b/packages/types/src/documents/global/devInfo.ts
@@ -0,0 +1,6 @@
+import { Document } from "../document"
+
+export interface DevInfo extends Document {
+  userId: string
+  apiKey?: string
+}
diff --git a/packages/types/src/documents/global/index.ts b/packages/types/src/documents/global/index.ts
index 7d2f5a767c..9bf24f078d 100644
--- a/packages/types/src/documents/global/index.ts
+++ b/packages/types/src/documents/global/index.ts
@@ -8,3 +8,4 @@ export * from "./templates"
 export * from "./environmentVariables"
 export * from "./auditLogs"
 export * from "./apikeys"
+export * from "./devInfo"
diff --git a/packages/worker/src/api/controllers/global/self.ts b/packages/worker/src/api/controllers/global/self.ts
index 14a2ce8c73..7f2a139106 100644
--- a/packages/worker/src/api/controllers/global/self.ts
+++ b/packages/worker/src/api/controllers/global/self.ts
@@ -10,6 +10,12 @@ import {
 import env from "../../../environment"
 import { groups } from "@budibase/pro"
 import {
+  Ctx,
+  DevInfo,
+  FetchAPIKeyResponse,
+  GenerateAPIKeyRequest,
+  GenerateAPIKeyResponse,
+  GetGlobalSelfResponse,
   UpdateSelfRequest,
   UpdateSelfResponse,
   User,
@@ -35,22 +41,24 @@ function cleanupDevInfo(info: any) {
   return info
 }
 
-export async function generateAPIKey(ctx: any) {
+export async function generateAPIKey(
+  ctx: UserCtx<GenerateAPIKeyRequest, GenerateAPIKeyResponse>
+) {
   let userId
   let apiKey
   if (env.isTest() && ctx.request.body.userId) {
     userId = ctx.request.body.userId
     apiKey = newTestApiKey()
   } else {
-    userId = ctx.user._id
+    userId = ctx.user._id!
     apiKey = newApiKey()
   }
 
   const db = tenancy.getGlobalDB()
   const id = dbCore.generateDevInfoID(userId)
-  let devInfo
+  let devInfo: DevInfo
   try {
-    devInfo = await db.get<any>(id)
+    devInfo = await db.get<DevInfo>(id)
   } catch (err) {
     devInfo = { _id: id, userId }
   }
@@ -59,9 +67,9 @@ export async function generateAPIKey(ctx: any) {
   ctx.body = cleanupDevInfo(devInfo)
 }
 
-export async function fetchAPIKey(ctx: any) {
+export async function fetchAPIKey(ctx: UserCtx<void, FetchAPIKeyResponse>) {
   const db = tenancy.getGlobalDB()
-  const id = dbCore.generateDevInfoID(ctx.user._id)
+  const id = dbCore.generateDevInfoID(ctx.user._id!)
   let devInfo
   try {
     devInfo = await db.get(id)
@@ -87,11 +95,11 @@ const addSessionAttributesToUser = (ctx: any) => {
   ctx.body.csrfToken = ctx.user.csrfToken
 }
 
-export async function getSelf(ctx: any) {
+export async function getSelf(ctx: UserCtx<void, GetGlobalSelfResponse>) {
   if (!ctx.user) {
     ctx.throw(403, "User not logged in")
   }
-  const userId = ctx.user._id
+  const userId = ctx.user._id!
   ctx.params = {
     id: userId,
   }

From 30717dae6c05fc386b0cfaf5a9678989af77c72e Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Thu, 5 Dec 2024 16:26:57 +0000
Subject: [PATCH 07/15] Template API typing.

---
 packages/types/src/api/web/global/index.ts    |  1 +
 packages/types/src/api/web/global/template.ts | 30 +++++++++++
 .../src/api/controllers/global/templates.ts   | 50 ++++++++++++-------
 .../worker/src/constants/templates/index.ts   | 27 ++++++----
 4 files changed, 81 insertions(+), 27 deletions(-)
 create mode 100644 packages/types/src/api/web/global/template.ts

diff --git a/packages/types/src/api/web/global/index.ts b/packages/types/src/api/web/global/index.ts
index 8359d8cd1a..36dce60b6c 100644
--- a/packages/types/src/api/web/global/index.ts
+++ b/packages/types/src/api/web/global/index.ts
@@ -8,3 +8,4 @@ export * from "./oldMigration"
 export * from "./email"
 export * from "./role"
 export * from "./self"
+export * from "./template"
diff --git a/packages/types/src/api/web/global/template.ts b/packages/types/src/api/web/global/template.ts
new file mode 100644
index 0000000000..0e79cbe62d
--- /dev/null
+++ b/packages/types/src/api/web/global/template.ts
@@ -0,0 +1,30 @@
+import { Document, Template } from "../../../documents"
+
+export interface TemplateDefinition {
+  name: string
+  description: string
+  category: string
+}
+
+export interface TemplateBinding {
+  name: string
+  description: string
+}
+
+export interface FetchTemplateDefinitionResponse {
+  info: Record<string, TemplateDefinition>
+  bindings: Record<string, TemplateBinding[]>
+}
+
+export interface SaveTemplateRequest extends Template {}
+export interface SaveTemplateResponse extends Template {}
+
+export type FetchTemplateResponse = Template[]
+export type FetchTemplateByTypeResponse = Template[]
+export type FetchTemplateByOwnerIDResponse = Template[]
+
+export interface FindTemplateResponse extends Template {}
+
+export interface DeleteTemplateResponse {
+  message: string
+}
diff --git a/packages/worker/src/api/controllers/global/templates.ts b/packages/worker/src/api/controllers/global/templates.ts
index 0abce704c7..5fba215e96 100644
--- a/packages/worker/src/api/controllers/global/templates.ts
+++ b/packages/worker/src/api/controllers/global/templates.ts
@@ -3,10 +3,25 @@ import {
   TemplateBindings,
   GLOBAL_OWNER,
 } from "../../../constants"
-import { getTemplates } from "../../../constants/templates"
+import { getTemplateByID, getTemplates } from "../../../constants/templates"
 import { tenancy, db as dbCore } from "@budibase/backend-core"
+import {
+  DeleteTemplateResponse,
+  FetchTemplateByOwnerIDResponse,
+  FetchTemplateByTypeResponse,
+  FetchTemplateDefinitionResponse,
+  FetchTemplateResponse,
+  FindTemplateResponse,
+  SaveTemplateRequest,
+  SaveTemplateResponse,
+  TemplateBinding,
+  TemplateDefinition,
+  UserCtx,
+} from "@budibase/types"
 
-export async function save(ctx: any) {
+export async function save(
+  ctx: UserCtx<SaveTemplateRequest, SaveTemplateResponse>
+) {
   const db = tenancy.getGlobalDB()
   let template = ctx.request.body
   if (!template.ownerId) {
@@ -23,9 +38,11 @@ export async function save(ctx: any) {
   }
 }
 
-export async function definitions(ctx: any) {
-  const bindings: any = {}
-  const info: any = {}
+export async function definitions(
+  ctx: UserCtx<void, FetchTemplateDefinitionResponse>
+) {
+  const bindings: Record<string, TemplateBinding[]> = {}
+  const info: Record<string, TemplateDefinition> = {}
   for (let template of TemplateMetadata.email) {
     bindings[template.purpose] = template.bindings
     info[template.purpose] = {
@@ -44,34 +61,33 @@ export async function definitions(ctx: any) {
   }
 }
 
-export async function fetch(ctx: any) {
+export async function fetch(ctx: UserCtx<void, FetchTemplateResponse>) {
   ctx.body = await getTemplates()
 }
 
-export async function fetchByType(ctx: any) {
-  // @ts-ignore
+export async function fetchByType(
+  ctx: UserCtx<void, FetchTemplateByTypeResponse>
+) {
   ctx.body = await getTemplates({
     type: ctx.params.type,
   })
 }
 
-export async function fetchByOwner(ctx: any) {
+export async function fetchByOwner(
+  ctx: UserCtx<void, FetchTemplateByOwnerIDResponse>
+) {
   // @ts-ignore
   ctx.body = await getTemplates({
     ownerId: ctx.params.ownerId,
   })
 }
 
-export async function find(ctx: any) {
-  // @ts-ignore
-  ctx.body = await getTemplates({
-    id: ctx.params.id,
-  })
+export async function find(ctx: UserCtx<void, FindTemplateResponse>) {
+  ctx.body = await getTemplateByID(ctx.params.id)
 }
 
-export async function destroy(ctx: any) {
+export async function destroy(ctx: UserCtx<void, DeleteTemplateResponse>) {
   const db = tenancy.getGlobalDB()
   await db.remove(ctx.params.id, ctx.params.rev)
-  ctx.message = `Template ${ctx.params.id} deleted.`
-  ctx.status = 200
+  ctx.body = { message: `Template ${ctx.params.id} deleted.` }
 }
diff --git a/packages/worker/src/constants/templates/index.ts b/packages/worker/src/constants/templates/index.ts
index 43c5b0870f..b2e98afe58 100644
--- a/packages/worker/src/constants/templates/index.ts
+++ b/packages/worker/src/constants/templates/index.ts
@@ -48,8 +48,21 @@ 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, undefined, {
+      include_docs: true,
+    })
+  )
+  let templates = response.rows.map(row => row.doc!)
+  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, {
@@ -58,16 +71,10 @@ export async function getTemplates({
   )
   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)
+  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)
 }

From 95b7b14ff6e3c106171cd0aaf87ba942c04ce721 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Thu, 5 Dec 2024 16:47:06 +0000
Subject: [PATCH 08/15] User API typing.

---
 packages/backend-core/src/cache/invite.ts     | 10 +---
 packages/types/src/api/web/user.ts            | 55 ++++++++++++++++++-
 .../src/api/controllers/global/users.ts       | 55 ++++++++++++++-----
 3 files changed, 96 insertions(+), 24 deletions(-)

diff --git a/packages/backend-core/src/cache/invite.ts b/packages/backend-core/src/cache/invite.ts
index e3d698bcc6..5d896ba04c 100644
--- a/packages/backend-core/src/cache/invite.ts
+++ b/packages/backend-core/src/cache/invite.ts
@@ -3,18 +3,10 @@ import { Duration } from "../utils"
 import env from "../environment"
 import { getTenantId } from "../context"
 import * as redis from "../redis/init"
+import { Invite, InviteWithCode } from "@budibase/types"
 
 const TTL_SECONDS = Duration.fromDays(7).toSeconds()
 
-interface Invite {
-  email: string
-  info: any
-}
-
-interface InviteWithCode extends Invite {
-  code: string
-}
-
 /**
  * Given an invite code and invite body, allow the update an existing/valid invite in redis
  * @param code The invite code for an invite in redis
diff --git a/packages/types/src/api/web/user.ts b/packages/types/src/api/web/user.ts
index e102f136c3..2f83f012b3 100644
--- a/packages/types/src/api/web/user.ts
+++ b/packages/types/src/api/web/user.ts
@@ -1,6 +1,15 @@
-import { User } from "../../documents"
+import { AccountMetadata, PlatformUser, User } from "../../documents"
 import { SearchFilters } from "../../sdk"
 
+export interface Invite {
+  email: string
+  info: any
+}
+
+export interface InviteWithCode extends Invite {
+  code: string
+}
+
 export interface SaveUserResponse {
   _id: string
   _rev: string
@@ -47,6 +56,11 @@ export interface InviteUserRequest {
   email: string
   userInfo: any
 }
+export interface InviteUserResponse {
+  message: string
+  successful: { email: string }[]
+  unsuccessful: { email: string; reason: string }[]
+}
 
 export interface DeleteInviteUserRequest {
   code: string
@@ -54,6 +68,9 @@ export interface DeleteInviteUserRequest {
 
 export type InviteUsersRequest = InviteUserRequest[]
 export type DeleteInviteUsersRequest = DeleteInviteUserRequest[]
+export interface DeleteInviteUsersResponse {
+  message: string
+}
 
 export interface InviteUsersResponse {
   successful: { email: string }[]
@@ -68,6 +85,17 @@ export interface SearchUsersRequest {
   limit?: number
   paginate?: boolean
 }
+export interface SearchUsersResponse {
+  data: User[]
+  hasNextPage?: boolean
+  nextPage?: string
+}
+
+export type FetchUsersResponse = User[]
+
+export interface FindUserResponse extends User {}
+
+export type LookupTenantUserResponse = PlatformUser
 
 export interface CreateAdminUserRequest {
   email: string
@@ -106,3 +134,28 @@ export interface AcceptUserInviteResponse {
 export interface SyncUserRequest {
   previousUser?: User
 }
+
+export interface DeleteUserResponse {
+  message: string
+}
+
+export interface CountUserResponse {
+  userCount: number
+}
+
+export interface CheckInviteResponse {
+  email: string
+}
+
+export type GetUserInvitesResponse = InviteWithCode[]
+
+export interface UpdateInviteRequest extends Omit<Invite, "email"> {
+  email?: string
+  builder?: {
+    apps: string[]
+  }
+  apps: string[]
+}
+export interface UpdateInviteResponse extends Invite {}
+
+export type LookupAccountHolderResponse = AccountMetadata | null
diff --git a/packages/worker/src/api/controllers/global/users.ts b/packages/worker/src/api/controllers/global/users.ts
index e977d5ff5d..1d36dd524c 100644
--- a/packages/worker/src/api/controllers/global/users.ts
+++ b/packages/worker/src/api/controllers/global/users.ts
@@ -6,21 +6,34 @@ import {
   AddSSoUserRequest,
   BulkUserRequest,
   BulkUserResponse,
+  CheckInviteResponse,
+  CountUserResponse,
   CreateAdminUserRequest,
   CreateAdminUserResponse,
   Ctx,
   DeleteInviteUserRequest,
   DeleteInviteUsersRequest,
+  DeleteInviteUsersResponse,
+  DeleteUserResponse,
+  FetchUsersResponse,
+  FindUserResponse,
+  GetUserInvitesResponse,
   Hosting,
   InviteUserRequest,
+  InviteUserResponse,
   InviteUsersRequest,
   InviteUsersResponse,
   LockName,
   LockType,
+  LookupAccountHolderResponse,
+  LookupTenantUserResponse,
   MigrationType,
   PlatformUserByEmail,
   SaveUserResponse,
   SearchUsersRequest,
+  SearchUsersResponse,
+  UpdateInviteRequest,
+  UpdateInviteResponse,
   User,
   UserCtx,
   UserIdentifier,
@@ -80,7 +93,7 @@ export const save = async (ctx: UserCtx<User, SaveUserResponse>) => {
   }
 }
 
-export const addSsoSupport = async (ctx: Ctx<AddSSoUserRequest>) => {
+export const addSsoSupport = async (ctx: Ctx<AddSSoUserRequest, void>) => {
   const { email, ssoId } = ctx.request.body
   try {
     // Status is changed to 404 from getUserDoc if user is not found
@@ -207,7 +220,7 @@ export const adminUser = async (
   })
 }
 
-export const countByApp = async (ctx: any) => {
+export const countByApp = async (ctx: UserCtx<void, CountUserResponse>) => {
   const appId = ctx.params.appId
   try {
     ctx.body = await userSdk.db.countUsersByApp(appId)
@@ -216,7 +229,7 @@ export const countByApp = async (ctx: any) => {
   }
 }
 
-export const destroy = async (ctx: any) => {
+export const destroy = async (ctx: UserCtx<void, DeleteUserResponse>) => {
   const id = ctx.params.id
   if (id === ctx.user._id) {
     ctx.throw(400, "Unable to delete self.")
@@ -239,7 +252,9 @@ export const getAppUsers = async (ctx: Ctx<SearchUsersRequest>) => {
   ctx.body = { data: users }
 }
 
-export const search = async (ctx: Ctx<SearchUsersRequest>) => {
+export const search = async (
+  ctx: Ctx<SearchUsersRequest, SearchUsersResponse>
+) => {
   const body = ctx.request.body
 
   // TODO: for now only two supported search keys; string.email and equal._id
@@ -280,7 +295,7 @@ export const search = async (ctx: Ctx<SearchUsersRequest>) => {
 }
 
 // called internally by app server user fetch
-export const fetch = async (ctx: any) => {
+export const fetch = async (ctx: UserCtx<void, FetchUsersResponse>) => {
   const all = await userSdk.db.allUsers()
   // user hashed password shouldn't ever be returned
   for (let user of all) {
@@ -292,11 +307,13 @@ export const fetch = async (ctx: any) => {
 }
 
 // called internally by app server user find
-export const find = async (ctx: any) => {
+export const find = async (ctx: UserCtx<void, FindUserResponse>) => {
   ctx.body = await userSdk.db.getUser(ctx.params.id)
 }
 
-export const tenantUserLookup = async (ctx: any) => {
+export const tenantUserLookup = async (
+  ctx: UserCtx<void, LookupTenantUserResponse>
+) => {
   const id = ctx.params.id
   // is email, check its valid
   if (id.includes("@") && !emailValidator.validate(id)) {
@@ -314,7 +331,9 @@ export const tenantUserLookup = async (ctx: any) => {
  * This will be paginated to a default of the first 50 users,
  * So the account holder may not be found until further pagination has occurred
  */
-export const accountHolderLookup = async (ctx: Ctx) => {
+export const accountHolderLookup = async (
+  ctx: Ctx<void, LookupAccountHolderResponse>
+) => {
   try {
     const users = await userSdk.core.getAllUsers()
     const response = await userSdk.core.getExistingAccounts(
@@ -366,7 +385,9 @@ export const onboardUsers = async (
   ctx.body = { ...resp, created: true }
 }
 
-export const invite = async (ctx: Ctx<InviteUserRequest>) => {
+export const invite = async (
+  ctx: Ctx<InviteUserRequest, InviteUserResponse>
+) => {
   const request = ctx.request.body
 
   let multiRequest = [request]
@@ -389,12 +410,14 @@ export const invite = async (ctx: Ctx<InviteUserRequest>) => {
   }
 }
 
-export const inviteMultiple = async (ctx: Ctx<InviteUsersRequest>) => {
+export const inviteMultiple = async (
+  ctx: Ctx<InviteUsersRequest, InviteUsersResponse>
+) => {
   ctx.body = await userSdk.invite(ctx.request.body)
 }
 
 export const removeMultipleInvites = async (
-  ctx: Ctx<DeleteInviteUsersRequest>
+  ctx: Ctx<DeleteInviteUsersRequest, DeleteInviteUsersResponse>
 ) => {
   const inviteCodesToRemove = ctx.request.body.map(
     (invite: DeleteInviteUserRequest) => invite.code
@@ -407,7 +430,7 @@ export const removeMultipleInvites = async (
   }
 }
 
-export const checkInvite = async (ctx: any) => {
+export const checkInvite = async (ctx: UserCtx<void, CheckInviteResponse>) => {
   const { code } = ctx.params
   let invite
   try {
@@ -422,7 +445,9 @@ export const checkInvite = async (ctx: any) => {
   }
 }
 
-export const getUserInvites = async (ctx: any) => {
+export const getUserInvites = async (
+  ctx: UserCtx<void, GetUserInvitesResponse>
+) => {
   try {
     // Restricted to the currently authenticated tenant
     ctx.body = await cache.invite.getInviteCodes()
@@ -431,7 +456,9 @@ export const getUserInvites = async (ctx: any) => {
   }
 }
 
-export const updateInvite = async (ctx: any) => {
+export const updateInvite = async (
+  ctx: UserCtx<UpdateInviteRequest, UpdateInviteResponse>
+) => {
   const { code } = ctx.params
   let updateBody = { ...ctx.request.body }
 

From 165ff4e76839f2869b8bfa39af683ead38da18ea Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Thu, 5 Dec 2024 17:02:36 +0000
Subject: [PATCH 09/15] Misc system APIs typing.

---
 packages/types/src/api/web/system/account.ts  |  4 ++
 .../types/src/api/web/system/environment.ts   |  7 ++-
 packages/types/src/api/web/system/index.ts    |  5 ++
 packages/types/src/api/web/system/log.ts      |  1 +
 .../types/src/api/web/system/migration.ts     |  5 ++
 packages/types/src/api/web/system/restore.ts  |  3 ++
 packages/types/src/api/web/system/tenant.ts   |  3 ++
 .../src/api/controllers/global/workspaces.ts  | 53 -------------------
 .../src/api/controllers/system/accounts.ts    | 14 +++--
 .../src/api/controllers/system/environment.ts |  6 +--
 .../worker/src/api/controllers/system/logs.ts |  4 +-
 .../src/api/controllers/system/migrations.ts  | 14 ++++-
 .../src/api/controllers/system/restore.ts     |  6 ++-
 .../src/api/controllers/system/tenants.ts     |  6 +--
 .../src/api/routes/global/workspaces.ts       | 37 -------------
 packages/worker/src/api/routes/index.ts       |  2 -
 16 files changed, 61 insertions(+), 109 deletions(-)
 create mode 100644 packages/types/src/api/web/system/account.ts
 create mode 100644 packages/types/src/api/web/system/log.ts
 create mode 100644 packages/types/src/api/web/system/migration.ts
 create mode 100644 packages/types/src/api/web/system/restore.ts
 create mode 100644 packages/types/src/api/web/system/tenant.ts
 delete mode 100644 packages/worker/src/api/controllers/global/workspaces.ts
 delete mode 100644 packages/worker/src/api/routes/global/workspaces.ts

diff --git a/packages/types/src/api/web/system/account.ts b/packages/types/src/api/web/system/account.ts
new file mode 100644
index 0000000000..d854a632cb
--- /dev/null
+++ b/packages/types/src/api/web/system/account.ts
@@ -0,0 +1,4 @@
+import { Account, AccountMetadata } from "../../../documents"
+
+export interface SaveAccountRequest extends Account {}
+export interface SaveAccountResponse extends AccountMetadata {}
diff --git a/packages/types/src/api/web/system/environment.ts b/packages/types/src/api/web/system/environment.ts
index e27a1338e2..3b6ee9d983 100644
--- a/packages/types/src/api/web/system/environment.ts
+++ b/packages/types/src/api/web/system/environment.ts
@@ -1,8 +1,11 @@
 export interface GetEnvironmentResponse {
   multiTenancy: boolean
+  offlineMode: boolean
   cloud: boolean
-  accountPortalUrl: string
-  baseUrl: string
+  accountPortalUrl?: string
   disableAccountPortal: boolean
+  baseUrl?: string
   isDev: boolean
+  maintenance: { type: string }[]
+  passwordMinLength?: string
 }
diff --git a/packages/types/src/api/web/system/index.ts b/packages/types/src/api/web/system/index.ts
index 0ce2738ddb..9b03ddd438 100644
--- a/packages/types/src/api/web/system/index.ts
+++ b/packages/types/src/api/web/system/index.ts
@@ -1,3 +1,8 @@
 export * from "./environment"
 export * from "./status"
 export * from "./ops"
+export * from "./account"
+export * from "./log"
+export * from "./migration"
+export * from "./restore"
+export * from "./tenant"
diff --git a/packages/types/src/api/web/system/log.ts b/packages/types/src/api/web/system/log.ts
new file mode 100644
index 0000000000..8a8cb6e53d
--- /dev/null
+++ b/packages/types/src/api/web/system/log.ts
@@ -0,0 +1 @@
+export type GetLogResponse = Buffer
diff --git a/packages/types/src/api/web/system/migration.ts b/packages/types/src/api/web/system/migration.ts
new file mode 100644
index 0000000000..f9f6eac48a
--- /dev/null
+++ b/packages/types/src/api/web/system/migration.ts
@@ -0,0 +1,5 @@
+import { MigrationDefinition, MigrationOptions } from "../../../sdk"
+
+export interface RunGlobalMigrationRequest extends MigrationOptions {}
+
+export type FetchMigrationDefinitionsResponse = MigrationDefinition[]
diff --git a/packages/types/src/api/web/system/restore.ts b/packages/types/src/api/web/system/restore.ts
new file mode 100644
index 0000000000..b5e8850051
--- /dev/null
+++ b/packages/types/src/api/web/system/restore.ts
@@ -0,0 +1,3 @@
+export interface SystemRestoreResponse {
+  message: string
+}
diff --git a/packages/types/src/api/web/system/tenant.ts b/packages/types/src/api/web/system/tenant.ts
new file mode 100644
index 0000000000..00ed883499
--- /dev/null
+++ b/packages/types/src/api/web/system/tenant.ts
@@ -0,0 +1,3 @@
+export interface GetTenantInfoResponse {
+  exists: boolean
+}
diff --git a/packages/worker/src/api/controllers/global/workspaces.ts b/packages/worker/src/api/controllers/global/workspaces.ts
deleted file mode 100644
index cf6486fec9..0000000000
--- a/packages/worker/src/api/controllers/global/workspaces.ts
+++ /dev/null
@@ -1,53 +0,0 @@
-import { tenancy, db as dbCore } from "@budibase/backend-core"
-import { BBContext } from "@budibase/types"
-
-export async function save(ctx: BBContext) {
-  const db = tenancy.getGlobalDB()
-  const workspaceDoc = ctx.request.body
-
-  // workspace does not exist yet
-  if (!workspaceDoc._id) {
-    workspaceDoc._id = dbCore.generateWorkspaceID()
-  }
-
-  try {
-    const response = await db.put(workspaceDoc)
-    ctx.body = {
-      _id: response.id,
-      _rev: response.rev,
-    }
-  } catch (err: any) {
-    ctx.throw(err.status, err)
-  }
-}
-
-export async function fetch(ctx: BBContext) {
-  const db = tenancy.getGlobalDB()
-  const response = await db.allDocs(
-    dbCore.getWorkspaceParams(undefined, {
-      include_docs: true,
-    })
-  )
-  ctx.body = response.rows.map(row => row.doc)
-}
-
-export async function find(ctx: BBContext) {
-  const db = tenancy.getGlobalDB()
-  try {
-    ctx.body = await db.get(ctx.params.id)
-  } catch (err: any) {
-    ctx.throw(err.status, err)
-  }
-}
-
-export async function destroy(ctx: BBContext) {
-  const db = tenancy.getGlobalDB()
-  const { id, rev } = ctx.params
-
-  try {
-    await db.remove(id, rev)
-    ctx.body = { message: "Workspace deleted successfully" }
-  } catch (err: any) {
-    ctx.throw(err.status, err)
-  }
-}
diff --git a/packages/worker/src/api/controllers/system/accounts.ts b/packages/worker/src/api/controllers/system/accounts.ts
index 7e6d1b51b8..e02c3f046d 100644
--- a/packages/worker/src/api/controllers/system/accounts.ts
+++ b/packages/worker/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
   )
diff --git a/packages/worker/src/api/controllers/system/environment.ts b/packages/worker/src/api/controllers/system/environment.ts
index 18ecc380db..4b75f49554 100644
--- a/packages/worker/src/api/controllers/system/environment.ts
+++ b/packages/worker/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: [],
diff --git a/packages/worker/src/api/controllers/system/logs.ts b/packages/worker/src/api/controllers/system/logs.ts
index a5607d545a..06ae75407d 100644
--- a/packages/worker/src/api/controllers/system/logs.ts
+++ b/packages/worker/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()
diff --git a/packages/worker/src/api/controllers/system/migrations.ts b/packages/worker/src/api/controllers/system/migrations.ts
index 57a5f6261c..dc66412e42 100644
--- a/packages/worker/src/api/controllers/system/migrations.ts
+++ b/packages/worker/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
 }
diff --git a/packages/worker/src/api/controllers/system/restore.ts b/packages/worker/src/api/controllers/system/restore.ts
index def6d58a5d..de3b4b8ff0 100644
--- a/packages/worker/src/api/controllers/system/restore.ts
+++ b/packages/worker/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.")
   }
diff --git a/packages/worker/src/api/controllers/system/tenants.ts b/packages/worker/src/api/controllers/system/tenants.ts
index 476343a05e..54388bf1fc 100644
--- a/packages/worker/src/api/controllers/system/tenants.ts
+++ b/packages/worker/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)
 }
diff --git a/packages/worker/src/api/routes/global/workspaces.ts b/packages/worker/src/api/routes/global/workspaces.ts
deleted file mode 100644
index 79afb53b96..0000000000
--- a/packages/worker/src/api/routes/global/workspaces.ts
+++ /dev/null
@@ -1,37 +0,0 @@
-import Router from "@koa/router"
-import * as controller from "../../controllers/global/workspaces"
-import { auth } from "@budibase/backend-core"
-import Joi from "joi"
-
-const router: Router = new Router()
-
-function buildWorkspaceSaveValidation() {
-  // prettier-ignore
-  return auth.joiValidator.body(Joi.object({
-    _id: Joi.string().optional(),
-    _rev: Joi.string().optional(),
-    name: Joi.string().required(),
-    users: Joi.array().required(),
-    managers: Joi.array().required(),
-    roles: Joi.object({
-      default: Joi.string().optional(),
-      app: Joi.object()
-        .pattern(/.*/, Joi.string())
-        .required()
-        .unknown(true),
-    }).unknown(true).optional(),
-  }).required().unknown(true))
-}
-
-router
-  .post(
-    "/api/global/workspaces",
-    auth.adminOnly,
-    buildWorkspaceSaveValidation(),
-    controller.save
-  )
-  .delete("/api/global/workspaces/:id", auth.adminOnly, controller.destroy)
-  .get("/api/global/workspaces", controller.fetch)
-  .get("/api/global/workspaces/:id", controller.find)
-
-export default router
diff --git a/packages/worker/src/api/routes/index.ts b/packages/worker/src/api/routes/index.ts
index e6cacf110f..741026543c 100644
--- a/packages/worker/src/api/routes/index.ts
+++ b/packages/worker/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,

From a3df34b3509daa084bf896321846c8d1a85be835 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Fri, 6 Dec 2024 10:50:39 +0000
Subject: [PATCH 10/15] Renaming new type.

---
 .../server/src/api/controllers/templates.ts   |  4 +--
 packages/types/src/api/web/global/template.ts | 26 +++++++--------
 .../src/api/controllers/global/templates.ts   | 32 ++++++++++---------
 .../worker/src/middleware/cloudRestricted.ts  |  4 +--
 4 files changed, 34 insertions(+), 32 deletions(-)

diff --git a/packages/server/src/api/controllers/templates.ts b/packages/server/src/api/controllers/templates.ts
index 8008b63fd3..fd3e28aa55 100644
--- a/packages/server/src/api/controllers/templates.ts
+++ b/packages/server/src/api/controllers/templates.ts
@@ -3,7 +3,7 @@ import { downloadTemplate as dlTemplate } from "../../utilities/fileSystem"
 import env from "../../environment"
 import {
   DownloadTemplateResponse,
-  FetchTemplateResponse,
+  FetchGlobalTemplateResponse,
   UserCtx,
 } from "@budibase/types"
 
@@ -11,7 +11,7 @@ import {
 const DEFAULT_TEMPLATES_BUCKET =
   "prod-budi-templates.s3-eu-west-1.amazonaws.com"
 
-export async function fetch(ctx: UserCtx<void, FetchTemplateResponse>) {
+export async function fetch(ctx: UserCtx<void, FetchGlobalTemplateResponse>) {
   let type = env.TEMPLATE_REPOSITORY
   let response,
     error = false
diff --git a/packages/types/src/api/web/global/template.ts b/packages/types/src/api/web/global/template.ts
index 0e79cbe62d..069e6d3d1b 100644
--- a/packages/types/src/api/web/global/template.ts
+++ b/packages/types/src/api/web/global/template.ts
@@ -1,30 +1,30 @@
-import { Document, Template } from "../../../documents"
+import { Template } from "../../../documents"
 
-export interface TemplateDefinition {
+export interface GlobalTemplateDefinition {
   name: string
   description: string
   category: string
 }
 
-export interface TemplateBinding {
+export interface GlobalTemplateBinding {
   name: string
   description: string
 }
 
-export interface FetchTemplateDefinitionResponse {
-  info: Record<string, TemplateDefinition>
-  bindings: Record<string, TemplateBinding[]>
+export interface FetchGlobalTemplateDefinitionResponse {
+  info: Record<string, GlobalTemplateDefinition>
+  bindings: Record<string, GlobalTemplateBinding[]>
 }
 
-export interface SaveTemplateRequest extends Template {}
-export interface SaveTemplateResponse extends Template {}
+export interface SaveGlobalTemplateRequest extends Template {}
+export interface SaveGlobalTemplateResponse extends Template {}
 
-export type FetchTemplateResponse = Template[]
-export type FetchTemplateByTypeResponse = Template[]
-export type FetchTemplateByOwnerIDResponse = Template[]
+export type FetchGlobalTemplateResponse = Template[]
+export type FetchGlobalTemplateByTypeResponse = Template[]
+export type FetchGlobalTemplateByOwnerIDResponse = Template[]
 
-export interface FindTemplateResponse extends Template {}
+export interface FindGlobalTemplateResponse extends Template {}
 
-export interface DeleteTemplateResponse {
+export interface DeleteGlobalTemplateResponse {
   message: string
 }
diff --git a/packages/worker/src/api/controllers/global/templates.ts b/packages/worker/src/api/controllers/global/templates.ts
index 5fba215e96..e175773723 100644
--- a/packages/worker/src/api/controllers/global/templates.ts
+++ b/packages/worker/src/api/controllers/global/templates.ts
@@ -6,21 +6,21 @@ import {
 import { getTemplateByID, getTemplates } from "../../../constants/templates"
 import { tenancy, db as dbCore } from "@budibase/backend-core"
 import {
-  DeleteTemplateResponse,
-  FetchTemplateByOwnerIDResponse,
-  FetchTemplateByTypeResponse,
-  FetchTemplateDefinitionResponse,
-  FetchTemplateResponse,
-  FindTemplateResponse,
-  SaveTemplateRequest,
-  SaveTemplateResponse,
+  DeleteGlobalTemplateResponse,
+  FetchGlobalTemplateByOwnerIDResponse,
+  FetchGlobalTemplateByTypeResponse,
+  FetchGlobalTemplateDefinitionResponse,
+  FetchGlobalTemplateResponse,
+  FindGlobalTemplateResponse,
+  SaveGlobalTemplateRequest,
+  SaveGlobalTemplateResponse,
   TemplateBinding,
   TemplateDefinition,
   UserCtx,
 } from "@budibase/types"
 
 export async function save(
-  ctx: UserCtx<SaveTemplateRequest, SaveTemplateResponse>
+  ctx: UserCtx<SaveGlobalTemplateRequest, SaveGlobalTemplateResponse>
 ) {
   const db = tenancy.getGlobalDB()
   let template = ctx.request.body
@@ -39,7 +39,7 @@ export async function save(
 }
 
 export async function definitions(
-  ctx: UserCtx<void, FetchTemplateDefinitionResponse>
+  ctx: UserCtx<void, FetchGlobalTemplateDefinitionResponse>
 ) {
   const bindings: Record<string, TemplateBinding[]> = {}
   const info: Record<string, TemplateDefinition> = {}
@@ -61,12 +61,12 @@ export async function definitions(
   }
 }
 
-export async function fetch(ctx: UserCtx<void, FetchTemplateResponse>) {
+export async function fetch(ctx: UserCtx<void, FetchGlobalTemplateResponse>) {
   ctx.body = await getTemplates()
 }
 
 export async function fetchByType(
-  ctx: UserCtx<void, FetchTemplateByTypeResponse>
+  ctx: UserCtx<void, FetchGlobalTemplateByTypeResponse>
 ) {
   ctx.body = await getTemplates({
     type: ctx.params.type,
@@ -74,7 +74,7 @@ export async function fetchByType(
 }
 
 export async function fetchByOwner(
-  ctx: UserCtx<void, FetchTemplateByOwnerIDResponse>
+  ctx: UserCtx<void, FetchGlobalTemplateByOwnerIDResponse>
 ) {
   // @ts-ignore
   ctx.body = await getTemplates({
@@ -82,11 +82,13 @@ export async function fetchByOwner(
   })
 }
 
-export async function find(ctx: UserCtx<void, FindTemplateResponse>) {
+export async function find(ctx: UserCtx<void, FindGlobalTemplateResponse>) {
   ctx.body = await getTemplateByID(ctx.params.id)
 }
 
-export async function destroy(ctx: UserCtx<void, DeleteTemplateResponse>) {
+export async function destroy(
+  ctx: UserCtx<void, DeleteGlobalTemplateResponse>
+) {
   const db = tenancy.getGlobalDB()
   await db.remove(ctx.params.id, ctx.params.rev)
   ctx.body = { message: `Template ${ctx.params.id} deleted.` }
diff --git a/packages/worker/src/middleware/cloudRestricted.ts b/packages/worker/src/middleware/cloudRestricted.ts
index f9ab86e2e9..747510479e 100644
--- a/packages/worker/src/middleware/cloudRestricted.ts
+++ b/packages/worker/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) {

From 17d421f12b34ead9f10ff7d9c3eb30fe82268848 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Fri, 6 Dec 2024 16:14:46 +0000
Subject: [PATCH 11/15] Fixes for types based on CI.

---
 packages/worker/src/api/controllers/global/self.ts      | 1 -
 packages/worker/src/api/controllers/global/templates.ts | 8 ++++----
 2 files changed, 4 insertions(+), 5 deletions(-)

diff --git a/packages/worker/src/api/controllers/global/self.ts b/packages/worker/src/api/controllers/global/self.ts
index 7f2a139106..f8488f526b 100644
--- a/packages/worker/src/api/controllers/global/self.ts
+++ b/packages/worker/src/api/controllers/global/self.ts
@@ -10,7 +10,6 @@ import {
 import env from "../../../environment"
 import { groups } from "@budibase/pro"
 import {
-  Ctx,
   DevInfo,
   FetchAPIKeyResponse,
   GenerateAPIKeyRequest,
diff --git a/packages/worker/src/api/controllers/global/templates.ts b/packages/worker/src/api/controllers/global/templates.ts
index e175773723..d717f47515 100644
--- a/packages/worker/src/api/controllers/global/templates.ts
+++ b/packages/worker/src/api/controllers/global/templates.ts
@@ -14,8 +14,8 @@ import {
   FindGlobalTemplateResponse,
   SaveGlobalTemplateRequest,
   SaveGlobalTemplateResponse,
-  TemplateBinding,
-  TemplateDefinition,
+  GlobalTemplateBinding,
+  GlobalTemplateDefinition,
   UserCtx,
 } from "@budibase/types"
 
@@ -41,8 +41,8 @@ export async function save(
 export async function definitions(
   ctx: UserCtx<void, FetchGlobalTemplateDefinitionResponse>
 ) {
-  const bindings: Record<string, TemplateBinding[]> = {}
-  const info: Record<string, TemplateDefinition> = {}
+  const bindings: Record<string, GlobalTemplateBinding[]> = {}
+  const info: Record<string, GlobalTemplateDefinition> = {}
   for (let template of TemplateMetadata.email) {
     bindings[template.purpose] = template.bindings
     info[template.purpose] = {

From c322e3994cddeb4a05358ef64e88d99fcc90d952 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Fri, 6 Dec 2024 16:32:32 +0000
Subject: [PATCH 12/15] Updating test file - removed API.

---
 packages/worker/src/tests/controllers.ts | 1 -
 1 file changed, 1 deletion(-)

diff --git a/packages/worker/src/tests/controllers.ts b/packages/worker/src/tests/controllers.ts
index bdcf11434b..615e9725f3 100644
--- a/packages/worker/src/tests/controllers.ts
+++ b/packages/worker/src/tests/controllers.ts
@@ -1,5 +1,4 @@
 export * as email from "../api/controllers/global/email"
-export * as workspaces from "../api/controllers/global/workspaces"
 export * as config from "../api/controllers/global/configs"
 export * as templates from "../api/controllers/global/templates"
 export * as users from "../api/controllers/global/users"

From 551c2ecc5ff3a81138d6ffb51296c343ebba43d5 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Fri, 6 Dec 2024 16:40:47 +0000
Subject: [PATCH 13/15] Fixing test case.

---
 .../worker/src/api/routes/system/tests/environment.spec.ts    | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/packages/worker/src/api/routes/system/tests/environment.spec.ts b/packages/worker/src/api/routes/system/tests/environment.spec.ts
index dbe9be7374..58f523648d 100644
--- a/packages/worker/src/api/routes/system/tests/environment.spec.ts
+++ b/packages/worker/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",

From 997daf17d0897050ef87c24fbc78831ba45e9247 Mon Sep 17 00:00:00 2001
From: andz-bb <andrew.thompson@budibase.com>
Date: Mon, 9 Dec 2024 10:29:37 +0000
Subject: [PATCH 14/15] handle cases where datasourceName is undefined when
 sorting datasources

---
 .../controls/DataSourceSelect/DataSourceSelect.svelte        | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/packages/builder/src/components/design/settings/controls/DataSourceSelect/DataSourceSelect.svelte b/packages/builder/src/components/design/settings/controls/DataSourceSelect/DataSourceSelect.svelte
index 9eef8c1c06..e79ed75d76 100644
--- a/packages/builder/src/components/design/settings/controls/DataSourceSelect/DataSourceSelect.svelte
+++ b/packages/builder/src/components/design/settings/controls/DataSourceSelect/DataSourceSelect.svelte
@@ -56,7 +56,10 @@
     .map(table => format.table(table, $datasources.list))
     .sort((a, b) => {
       // sort tables alphabetically, grouped by datasource
-      const dsComparison = a.datasourceName.localeCompare(b.datasourceName)
+      const dsA = a.datasourceName ?? ""
+      const dsB = b.datasourceName ?? ""
+
+      const dsComparison = dsA.localeCompare(dsB)
       if (dsComparison !== 0) {
         return dsComparison
       }

From 30064524a3c8d87a0943c63aaba70127688654a9 Mon Sep 17 00:00:00 2001
From: Budibase Staging Release Bot <>
Date: Mon, 9 Dec 2024 10:43:22 +0000
Subject: [PATCH 15/15] Bump version to 3.2.26

---
 lerna.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lerna.json b/lerna.json
index 4192189369..afd0db6374 100644
--- a/lerna.json
+++ b/lerna.json
@@ -1,6 +1,6 @@
 {
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
-  "version": "3.2.25",
+  "version": "3.2.26",
   "npmClient": "yarn",
   "concurrency": 20,
   "command": {