@budibase/server 2.1.32-alpha.1 → 2.1.32-alpha.10

package/src/api/controllers/{datasource.js → datasource.ts}

@@ -1,31 +1,37 @@
-const {
+import {
   generateDatasourceID,
   getDatasourceParams,
   getQueryParams,
   DocumentType,
   BudibaseInternalDB,
   getTableParams,
-} = require("../../db/utils")
-const { BuildSchemaErrors, InvalidColumns } = require("../../constants")
-const { getIntegration } = require("../../integrations")
-const { getDatasourceAndQuery } = require("./row/utils")
-const { invalidateDynamicVariables } = require("../../threads/utils")
-const { getAppDB } = require("@budibase/backend-core/context")
-const { events } = require("@budibase/backend-core")
-
-exports.fetch = async function (ctx) {
+} from "../../db/utils"
+import { destroy as tableDestroy } from "./table/internal"
+import { BuildSchemaErrors, InvalidColumns } from "../../constants"
+import { getIntegration } from "../../integrations"
+import { getDatasourceAndQuery } from "./row/utils"
+import { invalidateDynamicVariables } from "../../threads/utils"
+import { db as dbCore, context, events } from "@budibase/backend-core"
+import { BBContext, Datasource, Row } from "@budibase/types"
+
+export async function fetch(ctx: BBContext) {
   // Get internal tables
-  const db = getAppDB()
+  const db = context.getAppDB()
   const internalTables = await db.allDocs(
     getTableParams(null, {
       include_docs: true,
     })
   )
-  const internal = internalTables.rows.map(row => row.doc)
+
+  const internal = internalTables.rows.reduce((acc: any, row: Row) => {
+    const sourceId = row.doc.sourceId || "bb_internal"
+    acc[sourceId] = acc[sourceId] || []
+    acc[sourceId].push(row.doc)
+    return acc
+  }, {})
 
   const bbInternalDb = {
     ...BudibaseInternalDB,
-    entities: internal,
   }
 
   // Get external datasources
@@ -37,18 +43,24 @@ exports.fetch = async function (ctx) {
     )
   ).rows.map(row => row.doc)
 
-  for (let datasource of datasources) {
+  const allDatasources = [bbInternalDb, ...datasources]
+
+  for (let datasource of allDatasources) {
     if (datasource.config && datasource.config.auth) {
       // strip secrets from response so they don't show in the network request
       delete datasource.config.auth
     }
+
+    if (datasource.type === dbCore.BUDIBASE_DATASOURCE_TYPE) {
+      datasource.entities = internal[datasource._id]
+    }
   }
 
   ctx.body = [bbInternalDb, ...datasources]
 }
 
-exports.buildSchemaFromDb = async function (ctx) {
-  const db = getAppDB()
+export async function buildSchemaFromDb(ctx: BBContext) {
+  const db = context.getAppDB()
   const datasource = await db.get(ctx.params.datasourceId)
   const tablesFilter = ctx.request.body.tablesFilter
 
@@ -59,7 +71,9 @@ exports.buildSchemaFromDb = async function (ctx) {
     }
     for (let key in tables) {
       if (
-        tablesFilter.some(filter => filter.toLowerCase() === key.toLowerCase())
+        tablesFilter.some(
+          (filter: any) => filter.toLowerCase() === key.toLowerCase()
+        )
       ) {
         datasource.entities[key] = tables[key]
       }
@@ -72,7 +86,7 @@ exports.buildSchemaFromDb = async function (ctx) {
   const dbResp = await db.put(datasource)
   datasource._rev = dbResp.rev
 
-  const response = { datasource }
+  const response: any = { datasource }
   if (error) {
     response.error = error
   }
@@ -82,9 +96,9 @@ exports.buildSchemaFromDb = async function (ctx) {
 /**
  * Make sure all datasource entities have a display name selected
  */
-const setDefaultDisplayColumns = datasource => {
+function setDefaultDisplayColumns(datasource: Datasource) {
   //
-  for (let entity of Object.values(datasource.entities)) {
+  for (let entity of Object.values(datasource.entities || {})) {
     if (entity.primaryDisplay) {
       continue
     }
@@ -100,9 +114,12 @@ const setDefaultDisplayColumns = datasource => {
 /**
  * Check for variables that have been updated or removed and invalidate them.
  */
-const invalidateVariables = async (existingDatasource, updatedDatasource) => {
-  const existingVariables = existingDatasource.config.dynamicVariables
-  const updatedVariables = updatedDatasource.config.dynamicVariables
+async function invalidateVariables(
+  existingDatasource: Datasource,
+  updatedDatasource: Datasource
+) {
+  const existingVariables: any = existingDatasource.config?.dynamicVariables
+  const updatedVariables: any = updatedDatasource.config?.dynamicVariables
   const toInvalidate = []
 
   if (!existingVariables) {
@@ -114,9 +131,9 @@ const invalidateVariables = async (existingDatasource, updatedDatasource) => {
     toInvalidate.push(...existingVariables)
   } else {
     // invaldate changed / removed
-    existingVariables.forEach(existing => {
+    existingVariables.forEach((existing: any) => {
       const unchanged = updatedVariables.find(
-        updated =>
+        (updated: any) =>
           existing.name === updated.name &&
           existing.queryId === updated.queryId &&
           existing.value === updated.value
@@ -129,8 +146,8 @@ const invalidateVariables = async (existingDatasource, updatedDatasource) => {
   await invalidateDynamicVariables(toInvalidate)
 }
 
-exports.update = async function (ctx) {
-  const db = getAppDB()
+export async function update(ctx: BBContext) {
+  const db = context.getAppDB()
   const datasourceId = ctx.params.datasourceId
   let datasource = await db.get(datasourceId)
   const auth = datasource.config.auth
@@ -158,8 +175,8 @@ exports.update = async function (ctx) {
   ctx.body = { datasource }
 }
 
-exports.save = async function (ctx) {
-  const db = getAppDB()
+export async function save(ctx: BBContext) {
+  const db = context.getAppDB()
   const plus = ctx.request.body.datasource.plus
   const fetchSchema = ctx.request.body.fetchSchema
 
@@ -189,27 +206,63 @@ exports.save = async function (ctx) {
     }
   }
 
-  const response = { datasource }
+  const response: any = { datasource }
   if (schemaError) {
     response.error = schemaError
   }
   ctx.body = response
 }
 
-exports.destroy = async function (ctx) {
-  const db = getAppDB()
+async function destroyInternalTablesBySourceId(datasourceId: string) {
+  const db = context.getAppDB()
+
+  // Get all internal tables
+  const internalTables = await db.allDocs(
+    getTableParams(null, {
+      include_docs: true,
+    })
+  )
+
+  // Filter by datasource and return the docs.
+  const datasourceTableDocs = internalTables.rows.reduce(
+    (acc: any, table: any) => {
+      if (table.doc.sourceId == datasourceId) {
+        acc.push(table.doc)
+      }
+      return acc
+    },
+    []
+  )
+
+  // Destroy the tables.
+  for (const table of datasourceTableDocs) {
+    await tableDestroy({
+      params: {
+        tableId: table._id,
+      },
+    })
+  }
+}
+
+export async function destroy(ctx: BBContext) {
+  const db = context.getAppDB()
   const datasourceId = ctx.params.datasourceId
 
   const datasource = await db.get(datasourceId)
   // Delete all queries for the datasource
-  const queries = await db.allDocs(getQueryParams(datasourceId, null))
-  await db.bulkDocs(
-    queries.rows.map(row => ({
-      _id: row.id,
-      _rev: row.value.rev,
-      _deleted: true,
-    }))
-  )
+
+  if (datasource.type === dbCore.BUDIBASE_DATASOURCE_TYPE) {
+    await destroyInternalTablesBySourceId(datasourceId)
+  } else {
+    const queries = await db.allDocs(getQueryParams(datasourceId, null))
+    await db.bulkDocs(
+      queries.rows.map((row: any) => ({
+        _id: row.id,
+        _rev: row.value.rev,
+        _deleted: true,
+      }))
+    )
+  }
 
   // delete the datasource
   await db.remove(datasourceId, ctx.params.revId)
@@ -219,28 +272,28 @@ exports.destroy = async function (ctx) {
   ctx.status = 200
 }
 
-exports.find = async function (ctx) {
-  const database = getAppDB()
+export async function find(ctx: BBContext) {
+  const database = context.getAppDB()
   ctx.body = await database.get(ctx.params.datasourceId)
 }
 
 // dynamic query functionality
-exports.query = async function (ctx) {
+export async function query(ctx: BBContext) {
   const queryJson = ctx.request.body
   try {
     ctx.body = await getDatasourceAndQuery(queryJson)
-  } catch (err) {
+  } catch (err: any) {
     ctx.throw(400, err)
   }
 }
 
-function getErrorTables(errors, errorType) {
+function getErrorTables(errors: any, errorType: string) {
   return Object.entries(errors)
     .filter(entry => entry[1] === errorType)
     .map(([name]) => name)
 }
 
-function updateError(error, newError, tables) {
+function updateError(error: any, newError: any, tables: string[]) {
   if (!error) {
     error = ""
   }
@@ -251,7 +304,7 @@ function updateError(error, newError, tables) {
   return error
 }
 
-const buildSchemaHelper = async datasource => {
+async function buildSchemaHelper(datasource: Datasource) {
   const Connector = await getIntegration(datasource.source)
 
   // Connect to the DB and build the schema

package/src/api/controllers/deploy/{Deployment.js → Deployment.ts}

@@ -1,15 +1,20 @@
-const newid = require("../../../db/newid")
-const { getAppId } = require("@budibase/backend-core/context")
+import newid from "../../../db/newid"
+import { context } from "@budibase/backend-core"
 
 /**
  * This is used to pass around information about the deployment that is occurring
  */
-class Deployment {
+export default class Deployment {
+  _id: string
+  verification: any
+  status?: string
+  err?: any
+
   constructor(id = null) {
     this._id = id || newid()
   }
 
-  setVerification(verification) {
+  setVerification(verification: any) {
     if (!verification) {
       return
     }
@@ -20,14 +25,14 @@ class Deployment {
     return this.verification
   }
 
-  setStatus(status, err = null) {
+  setStatus(status: string, err?: any) {
     this.status = status
     if (err) {
       this.err = err
     }
   }
 
-  fromJSON(json) {
+  fromJSON(json: any) {
     if (json.verification) {
       this.setVerification(json.verification)
     }
@@ -37,9 +42,9 @@ class Deployment {
   }
 
   getJSON() {
-    const obj = {
+    const obj: any = {
       _id: this._id,
-      appId: getAppId(),
+      appId: context.getAppId(),
       status: this.status,
     }
     if (this.err) {
@@ -51,5 +56,3 @@ class Deployment {
     return obj
   }
 }
-
-module.exports = Deployment

package/src/api/controllers/{layout.js → layout.ts}

@@ -1,10 +1,10 @@
-const { EMPTY_LAYOUT } = require("../../constants/layouts")
-const { generateLayoutID, getScreenParams } = require("../../db/utils")
-const { getAppDB } = require("@budibase/backend-core/context")
-const { events } = require("@budibase/backend-core")
+import { EMPTY_LAYOUT } from "../../constants/layouts"
+import { generateLayoutID, getScreenParams } from "../../db/utils"
+import { events, context } from "@budibase/backend-core"
+import { BBContext } from "@budibase/types"
 
-exports.save = async function (ctx) {
-  const db = getAppDB()
+export async function save(ctx: BBContext) {
+  const db = context.getAppDB()
   let layout = ctx.request.body
 
   if (!layout.props) {
@@ -24,8 +24,8 @@ exports.save = async function (ctx) {
   ctx.status = 200
 }
 
-exports.destroy = async function (ctx) {
-  const db = getAppDB()
+export async function destroy(ctx: BBContext) {
+  const db = context.getAppDB()
   const layoutId = ctx.params.layoutId,
     layoutRev = ctx.params.layoutRev
 

package/src/api/controllers/{metadata.js → metadata.ts}

@@ -1,15 +1,16 @@
-const { MetadataTypes } = require("../../constants")
-const { generateMetadataID } = require("../../db/utils")
-const { saveEntityMetadata, deleteEntityMetadata } = require("../../utilities")
-const { getAppDB } = require("@budibase/backend-core/context")
+import { MetadataTypes } from "../../constants"
+import { generateMetadataID } from "../../db/utils"
+import { saveEntityMetadata, deleteEntityMetadata } from "../../utilities"
+import { context } from "@budibase/backend-core"
+import { BBContext } from "@budibase/types"
 
-exports.getTypes = async ctx => {
+export async function getTypes(ctx: BBContext) {
   ctx.body = {
     types: MetadataTypes,
   }
 }
 
-exports.saveMetadata = async ctx => {
+export async function saveMetadata(ctx: BBContext) {
   const { type, entityId } = ctx.params
   if (type === MetadataTypes.AUTOMATION_TEST_HISTORY) {
     ctx.throw(400, "Cannot save automation history type")
@@ -17,7 +18,7 @@ exports.saveMetadata = async ctx => {
   ctx.body = await saveEntityMetadata(type, entityId, ctx.request.body)
 }
 
-exports.deleteMetadata = async ctx => {
+export async function deleteMetadata(ctx: BBContext) {
   const { type, entityId } = ctx.params
   await deleteEntityMetadata(type, entityId)
   ctx.body = {
@@ -25,13 +26,13 @@ exports.deleteMetadata = async ctx => {
   }
 }
 
-exports.getMetadata = async ctx => {
+export async function getMetadata(ctx: BBContext) {
   const { type, entityId } = ctx.params
-  const db = getAppDB()
+  const db = context.getAppDB()
   const id = generateMetadataID(type, entityId)
   try {
     ctx.body = await db.get(id)
-  } catch (err) {
+  } catch (err: any) {
     if (err.status === 404) {
       ctx.body = {}
     } else {

package/src/api/controllers/{permission.js → permission.ts}

@@ -1,18 +1,11 @@
-const { getBuiltinPermissions } = require("@budibase/backend-core/permissions")
-const {
-  isBuiltin,
-  getDBRoleID,
-  getExternalRoleID,
-  getBuiltinRoles,
-  checkForRoleResourceArray,
-} = require("@budibase/backend-core/roles")
-const { getRoleParams } = require("../../db/utils")
-const {
+import { permissions, roles, context } from "@budibase/backend-core"
+import { getRoleParams } from "../../db/utils"
+import {
   CURRENTLY_SUPPORTED_LEVELS,
   getBasePermissions,
-} = require("../../utilities/security")
-const { removeFromArray } = require("../../utilities")
-const { getAppDB } = require("@budibase/backend-core/context")
+} from "../../utilities/security"
+import { removeFromArray } from "../../utilities"
+import { BBContext, Database, Role } from "@budibase/types"
 
 const PermissionUpdateType = {
   REMOVE: "remove",
@@ -22,7 +15,7 @@ const PermissionUpdateType = {
 const SUPPORTED_LEVELS = CURRENTLY_SUPPORTED_LEVELS
 
 // utility function to stop this repetition - permissions always stored under roles
-async function getAllDBRoles(db) {
+async function getAllDBRoles(db: Database) {
   const body = await db.allDocs(
     getRoleParams(null, {
       include_docs: true,
@@ -32,21 +25,25 @@ async function getAllDBRoles(db) {
 }
 
 async function updatePermissionOnRole(
-  appId,
-  { roleId, resourceId, level },
-  updateType
+  appId: string,
+  {
+    roleId,
+    resourceId,
+    level,
+  }: { roleId: string; resourceId: string; level: string },
+  updateType: string
 ) {
-  const db = getAppDB()
+  const db = context.getAppDB()
   const remove = updateType === PermissionUpdateType.REMOVE
-  const isABuiltin = isBuiltin(roleId)
-  const dbRoleId = getDBRoleID(roleId)
+  const isABuiltin = roles.isBuiltin(roleId)
+  const dbRoleId = roles.getDBRoleID(roleId)
   const dbRoles = await getAllDBRoles(db)
   const docUpdates = []
 
   // the permission is for a built in, make sure it exists
   if (isABuiltin && !dbRoles.some(role => role._id === dbRoleId)) {
-    const builtin = getBuiltinRoles()[roleId]
-    builtin._id = getDBRoleID(builtin._id)
+    const builtin = roles.getBuiltinRoles()[roleId]
+    builtin._id = roles.getDBRoleID(builtin._id)
     dbRoles.push(builtin)
   }
 
@@ -90,41 +87,44 @@ async function updatePermissionOnRole(
   }
 
   const response = await db.bulkDocs(docUpdates)
-  return response.map(resp => {
-    resp._id = getExternalRoleID(resp.id)
+  return response.map((resp: any) => {
+    resp._id = roles.getExternalRoleID(resp.id)
     delete resp.id
     return resp
   })
 }
 
-exports.fetchBuiltin = function (ctx) {
-  ctx.body = Object.values(getBuiltinPermissions())
+export function fetchBuiltin(ctx: BBContext) {
+  ctx.body = Object.values(permissions.getBuiltinPermissions())
 }
 
-exports.fetchLevels = function (ctx) {
+export function fetchLevels(ctx: BBContext) {
   // for now only provide the read/write perms externally
   ctx.body = SUPPORTED_LEVELS
 }
 
-exports.fetch = async function (ctx) {
-  const db = getAppDB()
-  const roles = await getAllDBRoles(db)
-  let permissions = {}
+export async function fetch(ctx: BBContext) {
+  const db = context.getAppDB()
+  const dbRoles: Role[] = await getAllDBRoles(db)
+  let permissions: any = {}
   // create an object with structure role ID -> resource ID -> level
-  for (let role of roles) {
+  for (let role of dbRoles) {
     if (!role.permissions) {
       continue
     }
-    const roleId = getExternalRoleID(role._id)
+    const roleId = roles.getExternalRoleID(role._id)
+    if (!roleId) {
+      ctx.throw(400, "Unable to retrieve role")
+    }
     for (let [resource, levelArr] of Object.entries(role.permissions)) {
-      const levels = Array.isArray(levelArr) ? [levelArr] : levelArr
-      const perms = {}
-      levels.forEach(level => (perms[level] = roleId))
+      const levels: string[] = Array.isArray(levelArr) ? levelArr : [levelArr]
+      const perms: Record<string, string> = {}
+      levels.forEach(level => (perms[level] = roleId!))
       permissions[resource] = perms
     }
   }
   // apply the base permissions
-  const finalPermissions = {}
+  const finalPermissions: Record<string, Record<string, string>> = {}
   for (let [resource, permission] of Object.entries(permissions)) {
     const basePerms = getBasePermissions(resource)
     finalPermissions[resource] = Object.assign(basePerms, permission)
@@ -132,33 +132,36 @@ exports.fetch = async function (ctx) {
   ctx.body = finalPermissions
 }
 
-exports.getResourcePerms = async function (ctx) {
+export async function getResourcePerms(ctx: BBContext) {
   const resourceId = ctx.params.resourceId
-  const db = getAppDB()
+  const db = context.getAppDB()
   const body = await db.allDocs(
     getRoleParams(null, {
       include_docs: true,
     })
   )
-  const roles = body.rows.map(row => row.doc)
-  let permissions = {}
+  const rolesList = body.rows.map(row => row.doc)
+  let permissions: Record<string, string> = {}
   for (let level of SUPPORTED_LEVELS) {
     // update the various roleIds in the resource permissions
-    for (let role of roles) {
-      const rolePerms = checkForRoleResourceArray(role.permissions, resourceId)
+    for (let role of rolesList) {
+      const rolePerms = roles.checkForRoleResourceArray(
+        role.permissions,
+        resourceId
+      )
       if (
         rolePerms &&
         rolePerms[resourceId] &&
         rolePerms[resourceId].indexOf(level) !== -1
       ) {
-        permissions[level] = getExternalRoleID(role._id)
+        permissions[level] = roles.getExternalRoleID(role._id)!
       }
     }
   }
   ctx.body = Object.assign(getBasePermissions(resourceId), permissions)
 }
 
-exports.addPermission = async function (ctx) {
+export async function addPermission(ctx: BBContext) {
   ctx.body = await updatePermissionOnRole(
     ctx.appId,
     ctx.params,
@@ -166,7 +169,7 @@ exports.addPermission = async function (ctx) {
   )
 }
 
-exports.removePermission = async function (ctx) {
+export async function removePermission(ctx: BBContext) {
   ctx.body = await updatePermissionOnRole(
     ctx.appId,
     ctx.params,

package/src/api/controllers/plugin/index.ts

@@ -1,6 +1,5 @@
 import { npmUpload, urlUpload, githubUpload, fileUpload } from "./uploaders"
-import { getGlobalDB } from "@budibase/backend-core/tenancy"
-import { validate } from "@budibase/backend-core/plugins"
+import { plugins as pluginCore, tenancy } from "@budibase/backend-core"
 import { PluginType, FileType, PluginSource } from "@budibase/types"
 import env from "../../../environment"
 import { ClientAppSocket } from "../../../websocket"
@@ -8,7 +7,7 @@ import { db as dbCore } from "@budibase/backend-core"
 import { plugins } from "@budibase/pro"
 
 export async function getPlugins(type?: PluginType) {
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
   const response = await db.allDocs(
     dbCore.getPluginParams(null, {
       include_docs: true,
@@ -76,7 +75,7 @@ export async function create(ctx: any) {
         break
     }
 
-    validate(metadata?.schema)
+    pluginCore.validate(metadata?.schema)
 
     // Only allow components in cloud
     if (!env.SELF_HOSTED && metadata?.schema?.type !== PluginType.COMPONENT) {
@@ -121,7 +120,7 @@ export async function processUploadedPlugin(
   source?: PluginSource
 ) {
   const { metadata, directory } = await fileUpload(plugin)
-  validate(metadata?.schema)
+  pluginCore.validate(metadata?.schema)
 
   // Only allow components in cloud
   if (!env.SELF_HOSTED && metadata?.schema?.type !== PluginType.COMPONENT) {

package/src/api/controllers/public/tables.ts

@@ -1,6 +1,6 @@
 import { search as stringSearch, addRev } from "./utils"
-import { default as controller } from "../table"
-import { Table } from "../../../definitions/common"
+import * as controller from "../table"
+import { Table } from "@budibase/types"
 
 function fixTable(table: Table, params: any) {
   if (!params || !table) {

package/src/api/controllers/query/import/index.ts

@@ -5,8 +5,7 @@ import { OpenAPI2 } from "./sources/openapi2"
 import { OpenAPI3 } from "./sources/openapi3"
 import { Curl } from "./sources/curl"
 // @ts-ignore
-import { getAppDB } from "@budibase/backend-core/context"
-import { events } from "@budibase/backend-core"
+import { events, context } from "@budibase/backend-core"
 import { Datasource, Query } from "@budibase/types"
 
 interface ImportResult {
@@ -59,7 +58,7 @@ export class RestImporter {
       })
 
     // persist queries
-    const db = getAppDB()
+    const db = context.getAppDB()
     const response = await db.bulkDocs(queries)
 
     // create index to seperate queries and errors