Merge pull request #15182 from Budibase/chore/typing-updates

API typing fixes

packages/server/src/api/controllers/analytics.ts

@@ -1,10 +1,11 @@
-import { events, context } from "@budibase/backend-core"
+import { context, events } from "@budibase/backend-core"
 import {
+  AnalyticsEnabledResponse,
   AnalyticsPingRequest,
+  AnalyticsPingResponse,
   App,
-  PingSource,
   Ctx,
-  AnalyticsEnabledResponse,
+  PingSource,
 } from "@budibase/types"
 import { DocumentType, isDevAppID } from "../../db/utils"
 
@@ -15,9 +16,12 @@ export const isEnabled = async (ctx: Ctx<void, AnalyticsEnabledResponse>) => {
   }
 }
 
-export const ping = async (ctx: Ctx<AnalyticsPingRequest, void>) => {
+export const ping = async (
+  ctx: Ctx<AnalyticsPingRequest, AnalyticsPingResponse>
+) => {
   const body = ctx.request.body
 
+  let pingType: PingSource | undefined
   switch (body.source) {
     case PingSource.APP: {
       const db = context.getAppDB({ skip_setup: true })
@@ -29,13 +33,18 @@ export const ping = async (ctx: Ctx<AnalyticsPingRequest, void>) => {
       } else {
         await events.serve.servedApp(appInfo, body.timezone, body.embedded)
       }
+      pingType = PingSource.APP
       break
     }
     case PingSource.BUILDER: {
       await events.serve.servedBuilder(body.timezone)
+      pingType = PingSource.BUILDER
       break
     }
   }
 
-  ctx.status = 200
+  ctx.body = {
+    message: "pong",
+    source: pingType,
+  }
 }

packages/server/src/api/controllers/application.ts

@@ -68,6 +68,9 @@ import {
   ImportToUpdateAppRequest,
   ImportToUpdateAppResponse,
   SetRevertableAppVersionRequest,
+  AddAppSampleDataResponse,
+  UnpublishAppResponse,
+  SetRevertableAppVersionResponse,
 } from "@budibase/types"
 import { BASE_LAYOUT_PROP_IDS } from "../../constants/layouts"
 import sdk from "../../sdk"
@@ -175,7 +178,9 @@ async function createInstance(appId: string, template: AppTemplate) {
   return { _id: appId }
 }
 
-export const addSampleData = async (ctx: UserCtx<void, void>) => {
+export const addSampleData = async (
+  ctx: UserCtx<void, AddAppSampleDataResponse>
+) => {
   const db = context.getAppDB()
 
   try {
@@ -188,7 +193,7 @@ export const addSampleData = async (ctx: UserCtx<void, void>) => {
     await db.bulkDocs([...defaultDbDocs])
   }
 
-  ctx.status = 200
+  ctx.body = { message: "Sample tables added." }
 }
 
 export async function fetch(ctx: UserCtx<void, FetchAppsResponse>) {
@@ -528,7 +533,6 @@ export async function create(
   await appPostCreate(ctx, newApplication)
   await cache.bustCache(cache.CacheKey.CHECKLIST)
   ctx.body = newApplication
-  ctx.status = 200
 }
 
 // This endpoint currently operates as a PATCH rather than a PUT
@@ -551,7 +555,6 @@ export async function update(
 
   const app = await updateAppPackage(ctx.request.body, ctx.params.appId)
   await events.app.updated(app)
-  ctx.status = 200
   ctx.body = app
   builderSocket?.emitAppMetadataUpdate(ctx, {
     theme: app.theme,
@@ -592,7 +595,6 @@ export async function updateClient(
   }
   const app = await updateAppPackage(appPackageUpdates, ctx.params.appId)
   await events.app.versionUpdated(app, currentVersion, updatedToVersion)
-  ctx.status = 200
   ctx.body = app
 }
 
@@ -624,7 +626,6 @@ export async function revertClient(
   }
   const app = await updateAppPackage(appPackageUpdates, ctx.params.appId)
   await events.app.versionReverted(app, currentVersion, revertedToVersion)
-  ctx.status = 200
   ctx.body = app
 }
 
@@ -689,11 +690,10 @@ export async function destroy(ctx: UserCtx<void, DeleteAppResponse>) {
   await preDestroyApp(ctx)
   const result = await destroyApp(ctx)
   await postDestroyApp(ctx)
-  ctx.status = 200
   ctx.body = result
 }
 
-export async function unpublish(ctx: UserCtx<void, void>) {
+export async function unpublish(ctx: UserCtx<void, UnpublishAppResponse>) {
   const prodAppId = dbCore.getProdAppID(ctx.params.appId)
   const dbExists = await dbCore.dbExists(prodAppId)
 
@@ -705,8 +705,8 @@ export async function unpublish(ctx: UserCtx<void, void>) {
   await preDestroyApp(ctx)
   await unpublishApp(ctx)
   await postDestroyApp(ctx)
-  ctx.status = 204
   builderSocket?.emitAppUnpublish(ctx)
+  ctx.body = { message: "App unpublished." }
 }
 
 export async function sync(ctx: UserCtx<void, SyncAppResponse>) {
@@ -802,7 +802,6 @@ export async function duplicateApp(
     duplicateAppId: newApplication?.appId,
     sourceAppId,
   }
-  ctx.status = 200
 }
 
 export async function updateAppPackage(
@@ -830,7 +829,7 @@ export async function updateAppPackage(
 }
 
 export async function setRevertableVersion(
-  ctx: UserCtx<SetRevertableAppVersionRequest, void>
+  ctx: UserCtx<SetRevertableAppVersionRequest, SetRevertableAppVersionResponse>
 ) {
   if (!env.isDev()) {
     ctx.status = 403
@@ -840,8 +839,7 @@ export async function setRevertableVersion(
   const app = await sdk.applications.metadata.get()
   app.revertableVersion = ctx.request.body.revertableVersion
   await db.put(app)
-
-  ctx.status = 200
+  ctx.body = { message: "Revertable version updated." }
 }
 
 async function migrateAppNavigation() {

packages/server/src/api/controllers/automation.ts

@@ -62,7 +62,6 @@ export async function create(
 
   const createdAutomation = await sdk.automations.create(automation)
 
-  ctx.status = 200
   ctx.body = {
     message: "Automation created successfully",
     automation: createdAutomation,
@@ -84,7 +83,6 @@ export async function update(
 
   const updatedAutomation = await sdk.automations.update(automation)
 
-  ctx.status = 200
   ctx.body = {
     message: `Automation ${automation._id} updated successfully.`,
     automation: updatedAutomation,

packages/server/src/api/controllers/datasource.ts

@@ -182,7 +182,6 @@ export async function update(
     }
   }
 
-  ctx.status = 200
   ctx.message = "Datasource saved successfully."
   ctx.body = {
     datasource: await sdk.datasources.removeSecretSingle(datasource),
@@ -290,8 +289,7 @@ export async function destroy(ctx: UserCtx<void, DeleteDatasourceResponse>) {
   await db.remove(datasourceId, ctx.params.revId)
   await events.datasource.deleted(datasource)
 
-  ctx.message = `Datasource deleted.`
-  ctx.status = 200
+  ctx.body = { message: `Datasource deleted.` }
   builderSocket?.emitDatasourceDeletion(ctx, datasourceId)
 }
 

packages/server/src/api/controllers/layout.ts

@@ -29,7 +29,6 @@ export async function save(
   layout._rev = response.rev
 
   ctx.body = layout
-  ctx.status = 200
 }
 
 export async function destroy(ctx: UserCtx<void, DeleteLayoutResponse>) {
@@ -51,5 +50,4 @@ export async function destroy(ctx: UserCtx<void, DeleteLayoutResponse>) {
   await db.remove(layoutId, layoutRev)
   await events.layout.deleted(layoutId)
   ctx.body = { message: "Layout deleted successfully" }
-  ctx.status = 200
 }

packages/server/src/api/controllers/migrations.ts

@@ -4,25 +4,27 @@ import {
   Ctx,
   FetchOldMigrationResponse,
   GetOldMigrationStatus,
+  RuneOldMigrationResponse,
   RunOldMigrationRequest,
 } from "@budibase/types"
 import {
   getAppMigrationVersion,
   getLatestEnabledMigrationId,
 } from "../../appMigrations"
 
-export async function migrate(ctx: Ctx<RunOldMigrationRequest, void>) {
+export async function migrate(
+  ctx: Ctx<RunOldMigrationRequest, RuneOldMigrationResponse>
+) {
   const options = ctx.request.body
   // don't await as can take a while, just return
   migrationImpl(options)
-  ctx.status = 200
+  ctx.body = { message: "Migration started." }
 }
 
 export async function fetchDefinitions(
   ctx: Ctx<void, FetchOldMigrationResponse>
 ) {
   ctx.body = MIGRATIONS
-  ctx.status = 200
 }
 
 export async function getMigrationStatus(
@@ -41,5 +43,4 @@ export async function getMigrationStatus(
     !latestMigrationId || latestAppliedMigration >= latestMigrationId
 
   ctx.body = { migrated }
-  ctx.status = 200
 }

packages/server/src/api/controllers/permission.ts

@@ -99,7 +99,7 @@ export async function getDependantResources(
 export async function addPermission(ctx: UserCtx<void, AddPermissionResponse>) {
   const params: AddPermissionRequest = ctx.params
   await sdk.permissions.updatePermissionOnRole(params, PermissionUpdateType.ADD)
-  ctx.status = 200
+  ctx.body = { message: "Permission added." }
 }
 
 export async function removePermission(
@@ -110,5 +110,5 @@ export async function removePermission(
     params,
     PermissionUpdateType.REMOVE
   )
-  ctx.status = 200
+  ctx.body = { message: "Permission removed." }
 }

packages/server/src/api/controllers/query/index.ts

@@ -104,7 +104,6 @@ const _import = async (
     ...importResult,
     datasourceId,
   }
-  ctx.status = 200
 }
 export { _import as import }
 
@@ -455,6 +454,5 @@ export async function destroy(ctx: UserCtx<void, DeleteQueryResponse>) {
   const datasource = await sdk.datasources.get(query.datasourceId)
   await db.remove(ctx.params.queryId, ctx.params.revId)
   ctx.body = { message: `Query deleted.` }
-  ctx.status = 200
   await events.query.deleted(datasource, query)
 }

packages/server/src/api/controllers/role.ts

@@ -234,8 +234,7 @@ export async function destroy(ctx: UserCtx<void, DeleteRoleResponse>) {
   // clean up inherits
   await removeRoleFromOthers(roleId)
 
-  ctx.message = `Role ${ctx.params.roleId} deleted successfully`
-  ctx.status = 200
+  ctx.body = { message: `Role ${ctx.params.roleId} deleted successfully` }
   builderSocket?.emitRoleDeletion(ctx, role)
 }
 

packages/server/src/api/controllers/row/index.ts

@@ -71,7 +71,6 @@ export async function patch(
     if (!row) {
       ctx.throw(404, "Row not found")
     }
-    ctx.status = 200
 
     ctx.eventEmitter?.emitRow({
       eventName: EventType.ROW_UPDATE,
@@ -110,7 +109,6 @@ export const save = async (ctx: UserCtx<SaveRowRequest, SaveRowResponse>) => {
     : await quotas.addRow(() =>
         sdk.rows.save(sourceId, ctx.request.body, ctx.user?._id)
       )
-  ctx.status = 200
 
   ctx.eventEmitter?.emitRow({
     eventName: EventType.ROW_SAVE,
@@ -223,7 +221,6 @@ async function deleteRow(ctx: UserCtx<DeleteRowRequest>) {
 
 export async function destroy(ctx: UserCtx<DeleteRowRequest>) {
   let response, row
-  ctx.status = 200
 
   if (isDeleteRows(ctx.request.body)) {
     response = await deleteRows(ctx)
@@ -275,7 +272,6 @@ export async function search(ctx: Ctx<SearchRowRequest, SearchRowResponse>) {
     rows: undefined,
   }
 
-  ctx.status = 200
   ctx.body = await sdk.rows.search(searchParams)
 }
 

packages/server/src/api/controllers/rowAction/run.ts

@@ -1,10 +1,16 @@
-import { RowActionTriggerRequest, Ctx } from "@budibase/types"
+import {
+  RowActionTriggerRequest,
+  Ctx,
+  RowActionTriggerResponse,
+} from "@budibase/types"
 import sdk from "../../../sdk"
 
-export async function run(ctx: Ctx<RowActionTriggerRequest, void>) {
+export async function run(
+  ctx: Ctx<RowActionTriggerRequest, RowActionTriggerResponse>
+) {
   const { tableId, actionId } = ctx.params
   const { rowId } = ctx.request.body
 
   await sdk.rowActions.run(tableId, actionId, rowId, ctx.user)
-  ctx.status = 200
+  ctx.body = { message: "Row action triggered." }
 }

packages/server/src/api/controllers/screen.ts

@@ -123,7 +123,6 @@ export async function destroy(ctx: UserCtx<void, DeleteScreenResponse>) {
   ctx.body = {
     message: "Screen deleted successfully",
   }
-  ctx.status = 200
   builderSocket?.emitScreenDeletion(ctx, id)
 }