@budibase/server 1.0.123 → 1.0.125

package/src/api/controllers/table/{utils.js → utils.ts}

@@ -1,34 +1,34 @@
-const csvParser = require("../../../utilities/csvParser")
-const {
+import { transform } from "../../../utilities/csvParser"
+import {
   getRowParams,
   generateRowID,
   InternalTables,
   getTableParams,
   BudibaseInternalDB,
-} = require("../../../db/utils")
-const { isEqual } = require("lodash")
-const { AutoFieldSubTypes, FieldTypes } = require("../../../constants")
-const {
+} from "../../../db/utils"
+import { isEqual } from "lodash"
+import { AutoFieldSubTypes, FieldTypes } from "../../../constants"
+import {
   inputProcessing,
   cleanupAttachments,
-} = require("../../../utilities/rowProcessor")
-const {
+} from "../../../utilities/rowProcessor"
+import {
   USERS_TABLE_SCHEMA,
   SwitchableTypes,
   CanSwitchTypes,
-} = require("../../../constants")
-const {
+} from "../../../constants"
+import {
   isExternalTable,
   breakExternalTableId,
   isSQL,
-} = require("../../../integrations/utils")
-const { getViews, saveView } = require("../view/utils")
-const viewTemplate = require("../view/viewBuilder")
-const usageQuota = require("../../../utilities/usageQuota")
+} from "../../../integrations/utils"
+import { getViews, saveView } from "../view/utils"
+import viewTemplate from "../view/viewBuilder"
 const { getAppDB } = require("@budibase/backend-core/context")
-const { cloneDeep } = require("lodash/fp")
+import { cloneDeep } from "lodash/fp"
+import { quotas, QuotaUsageType, StaticQuotaName } from "@budibase/pro"
 
-exports.clearColumns = async (table, columnNames) => {
+export async function clearColumns(table: any, columnNames: any) {
   const db = getAppDB()
   const rows = await db.allDocs(
     getRowParams(table._id, null, {
@@ -36,18 +36,18 @@ exports.clearColumns = async (table, columnNames) => {
     })
   )
   return db.bulkDocs(
-    rows.rows.map(({ doc }) => {
-      columnNames.forEach(colName => delete doc[colName])
+    rows.rows.map(({ doc }: any) => {
+      columnNames.forEach((colName: any) => delete doc[colName])
       return doc
     })
   )
 }
 
-exports.checkForColumnUpdates = async (oldTable, updatedTable) => {
+export async function checkForColumnUpdates(oldTable: any, updatedTable: any) {
   const db = getAppDB()
   let updatedRows = []
   const rename = updatedTable._rename
-  let deletedColumns = []
+  let deletedColumns: any = []
   if (oldTable && oldTable.schema && updatedTable.schema) {
     deletedColumns = Object.keys(oldTable.schema).filter(
       colName => updatedTable.schema[colName] == null
@@ -61,14 +61,14 @@ exports.checkForColumnUpdates = async (oldTable, updatedTable) => {
         include_docs: true,
       })
     )
-    const rawRows = rows.rows.map(({ doc }) => doc)
-    updatedRows = rawRows.map(row => {
+    const rawRows = rows.rows.map(({ doc }: any) => doc)
+    updatedRows = rawRows.map((row: any) => {
       row = cloneDeep(row)
       if (rename) {
         row[rename.updated] = row[rename.old]
         delete row[rename.old]
       } else if (deletedColumns.length !== 0) {
-        deletedColumns.forEach(colName => delete row[colName])
+        deletedColumns.forEach((colName: any) => delete row[colName])
       }
       return row
     })
@@ -76,14 +76,14 @@ exports.checkForColumnUpdates = async (oldTable, updatedTable) => {
     // cleanup any attachments from object storage for deleted attachment columns
     await cleanupAttachments(updatedTable, { oldTable, rows: rawRows })
     // Update views
-    await exports.checkForViewUpdates(updatedTable, rename, deletedColumns)
+    await checkForViewUpdates(updatedTable, rename, deletedColumns)
     delete updatedTable._rename
   }
   return { rows: updatedRows, table: updatedTable }
 }
 
 // makes sure the passed in table isn't going to reset the auto ID
-exports.makeSureTableUpToDate = (table, tableToSave) => {
+export function makeSureTableUpToDate(table: any, tableToSave: any) {
   if (!table) {
     return tableToSave
   }
@@ -91,7 +91,9 @@ exports.makeSureTableUpToDate = (table, tableToSave) => {
   tableToSave._rev = table._rev
   // make sure auto IDs are always updated - these are internal
   // so the client may not know they have changed
-  for (let [field, column] of Object.entries(table.schema)) {
+  let field: any
+  let column: any
+  for ([field, column] of Object.entries(table.schema)) {
     if (
       column.autocolumn &&
       column.subtype === AutoFieldSubTypes.AUTO_ID &&
@@ -103,30 +105,32 @@ exports.makeSureTableUpToDate = (table, tableToSave) => {
   return tableToSave
 }
 
-exports.handleDataImport = async (user, table, dataImport) => {
+export async function handleDataImport(user: any, table: any, dataImport: any) {
   if (!dataImport || !dataImport.csvString) {
     return table
   }
 
   const db = getAppDB()
   // Populate the table with rows imported from CSV in a bulk update
-  const data = await csvParser.transform({
+  const data = await transform({
     ...dataImport,
     existingTable: table,
   })
 
-  let finalData = []
+  let finalData: any = []
   for (let i = 0; i < data.length; i++) {
     let row = data[i]
     row._id = generateRowID(table._id)
     row.tableId = table._id
-    const processed = inputProcessing(user, table, row, {
+    const processed: any = inputProcessing(user, table, row, {
       noAutoRelationships: true,
     })
     table = processed.table
     row = processed.row
 
-    for (let [fieldName, schema] of Object.entries(table.schema)) {
+    let fieldName: any
+    let schema: any
+    for ([fieldName, schema] of Object.entries(table.schema)) {
       // check whether the options need to be updated for inclusion as part of the data import
       if (
         schema.type === FieldTypes.OPTIONS &&
@@ -143,17 +147,13 @@ exports.handleDataImport = async (user, table, dataImport) => {
     finalData.push(row)
   }
 
-  await usageQuota.update(usageQuota.Properties.ROW, finalData.length, {
-    dryRun: true,
-  })
-  await db.bulkDocs(finalData)
-  await usageQuota.update(usageQuota.Properties.ROW, finalData.length)
+  await quotas.addRows(finalData.length, () => db.bulkDocs(finalData))
   let response = await db.put(table)
   table._rev = response._rev
   return table
 }
 
-exports.handleSearchIndexes = async table => {
+export async function handleSearchIndexes(table: any) {
   const db = getAppDB()
   // create relevant search indexes
   if (table.indexes && table.indexes.length > 0) {
@@ -161,12 +161,12 @@ exports.handleSearchIndexes = async table => {
     const indexName = `search:${table._id}`
 
     const existingIndex = currentIndexes.indexes.find(
-      existing => existing.name === indexName
+      (existing: any) => existing.name === indexName
     )
 
     if (existingIndex) {
       const currentFields = existingIndex.def.fields.map(
-        field => Object.keys(field)[0]
+        (field: any) => Object.keys(field)[0]
       )
 
       // if index fields have changed, delete the original index
@@ -197,7 +197,7 @@ exports.handleSearchIndexes = async table => {
   return table
 }
 
-exports.checkStaticTables = table => {
+export function checkStaticTables(table: any) {
   // check user schema has all required elements
   if (table._id === InternalTables.USER_METADATA) {
     for (let [key, schema] of Object.entries(USERS_TABLE_SCHEMA.schema)) {
@@ -211,7 +211,13 @@ exports.checkStaticTables = table => {
 }
 
 class TableSaveFunctions {
-  constructor({ user, oldTable, dataImport }) {
+  db: any
+  user: any
+  oldTable: any
+  dataImport: any
+  rows: any
+
+  constructor({ user, oldTable, dataImport }: any) {
     this.db = getAppDB()
     this.user = user
     this.oldTable = oldTable
@@ -221,25 +227,25 @@ class TableSaveFunctions {
   }
 
   // before anything is done
-  async before(table) {
+  async before(table: any) {
     if (this.oldTable) {
-      table = exports.makeSureTableUpToDate(this.oldTable, table)
+      table = makeSureTableUpToDate(this.oldTable, table)
     }
-    table = exports.checkStaticTables(table)
+    table = checkStaticTables(table)
     return table
   }
 
   // when confirmed valid
-  async mid(table) {
-    let response = await exports.checkForColumnUpdates(this.oldTable, table)
+  async mid(table: any) {
+    let response = await checkForColumnUpdates(this.oldTable, table)
     this.rows = this.rows.concat(response.rows)
     return table
   }
 
   // after saving
-  async after(table) {
-    table = await exports.handleSearchIndexes(table)
-    table = await exports.handleDataImport(this.user, table, this.dataImport)
+  async after(table: any) {
+    table = await handleSearchIndexes(table)
+    table = await handleDataImport(this.user, table, this.dataImport)
     return table
   }
 
@@ -248,21 +254,21 @@ class TableSaveFunctions {
   }
 }
 
-exports.getAllInternalTables = async () => {
+export async function getAllInternalTables() {
   const db = getAppDB()
   const internalTables = await db.allDocs(
     getTableParams(null, {
       include_docs: true,
     })
   )
-  return internalTables.rows.map(tableDoc => ({
+  return internalTables.rows.map((tableDoc: any) => ({
     ...tableDoc.doc,
     type: "internal",
     sourceId: BudibaseInternalDB._id,
   }))
 }
 
-exports.getAllExternalTables = async datasourceId => {
+export async function getAllExternalTables(datasourceId: any) {
   const db = getAppDB()
   const datasource = await db.get(datasourceId)
   if (!datasource || !datasource.entities) {
@@ -271,24 +277,28 @@ exports.getAllExternalTables = async datasourceId => {
   return datasource.entities
 }
 
-exports.getExternalTable = async (datasourceId, tableName) => {
-  const entities = await exports.getAllExternalTables(datasourceId)
+export async function getExternalTable(datasourceId: any, tableName: any) {
+  const entities = await getAllExternalTables(datasourceId)
   return entities[tableName]
 }
 
-exports.getTable = async tableId => {
+export async function getTable(tableId: any) {
   const db = getAppDB()
   if (isExternalTable(tableId)) {
     let { datasourceId, tableName } = breakExternalTableId(tableId)
     const datasource = await db.get(datasourceId)
-    const table = await exports.getExternalTable(datasourceId, tableName)
+    const table = await getExternalTable(datasourceId, tableName)
     return { ...table, sql: isSQL(datasource) }
   } else {
     return db.get(tableId)
   }
 }
 
-exports.checkForViewUpdates = async (table, rename, deletedColumns) => {
+export async function checkForViewUpdates(
+  table: any,
+  rename: any,
+  deletedColumns: any
+) {
   const views = await getViews()
   const tableViews = views.filter(view => view.meta.tableId === table._id)
 
@@ -312,7 +322,7 @@ exports.checkForViewUpdates = async (table, rename, deletedColumns) => {
 
       // Update filters if required
       if (view.meta.filters) {
-        view.meta.filters.forEach(filter => {
+        view.meta.filters.forEach((filter: any) => {
           if (filter.key === rename.old) {
             filter.key = rename.updated
             needsUpdated = true
@@ -320,7 +330,7 @@ exports.checkForViewUpdates = async (table, rename, deletedColumns) => {
         })
       }
     } else if (deletedColumns) {
-      deletedColumns.forEach(column => {
+      deletedColumns.forEach((column: any) => {
         // Remove calculation statement if required
         if (view.meta.field === column) {
           delete view.meta.field
@@ -338,7 +348,7 @@ exports.checkForViewUpdates = async (table, rename, deletedColumns) => {
         // Remove filters referencing deleted field if required
         if (view.meta.filters && view.meta.filters.length) {
           const initialLength = view.meta.filters.length
-          view.meta.filters = view.meta.filters.filter(filter => {
+          view.meta.filters = view.meta.filters.filter((filter: any) => {
             return filter.key !== column
           })
           if (initialLength !== view.meta.filters.length) {
@@ -360,16 +370,20 @@ exports.checkForViewUpdates = async (table, rename, deletedColumns) => {
   }
 }
 
-exports.generateForeignKey = (column, relatedTable) => {
+export function generateForeignKey(column: any, relatedTable: any) {
   return `fk_${relatedTable.name}_${column.fieldName}`
 }
 
-exports.generateJunctionTableName = (column, table, relatedTable) => {
+export function generateJunctionTableName(
+  column: any,
+  table: any,
+  relatedTable: any
+) {
   return `jt_${table.name}_${relatedTable.name}_${column.name}_${column.fieldName}`
 }
 
-exports.foreignKeyStructure = (keyName, meta = null) => {
-  const structure = {
+export function foreignKeyStructure(keyName: any, meta = null) {
+  const structure: any = {
     type: FieldTypes.NUMBER,
     constraints: {},
     name: keyName,
@@ -380,7 +394,7 @@ exports.foreignKeyStructure = (keyName, meta = null) => {
   return structure
 }
 
-exports.areSwitchableTypes = (type1, type2) => {
+export function areSwitchableTypes(type1: any, type2: any) {
   if (
     SwitchableTypes.indexOf(type1) === -1 &&
     SwitchableTypes.indexOf(type2) === -1
@@ -397,21 +411,24 @@ exports.areSwitchableTypes = (type1, type2) => {
   return false
 }
 
-exports.hasTypeChanged = (table, oldTable) => {
+export function hasTypeChanged(table: any, oldTable: any) {
   if (!oldTable) {
     return false
   }
-  for (let [key, field] of Object.entries(oldTable.schema)) {
+  let key: any
+  let field: any
+  for ([key, field] of Object.entries(oldTable.schema)) {
     const oldType = field.type
     if (!table.schema[key]) {
       continue
     }
     const newType = table.schema[key].type
-    if (oldType !== newType && !exports.areSwitchableTypes(oldType, newType)) {
+    if (oldType !== newType && !areSwitchableTypes(oldType, newType)) {
       return true
     }
   }
   return false
 }
 
-exports.TableSaveFunctions = TableSaveFunctions
+const _TableSaveFunctions = TableSaveFunctions
+export { _TableSaveFunctions as TableSaveFunctions }

package/src/api/index.js

@@ -4,12 +4,14 @@ const {
   auditLog,
   buildTenancyMiddleware,
 } = require("@budibase/backend-core/auth")
+const { errors } = require("@budibase/backend-core")
 const currentApp = require("../middleware/currentapp")
 const compress = require("koa-compress")
 const zlib = require("zlib")
 const { mainRoutes, staticRoutes, publicRoutes } = require("./routes")
 const pkg = require("../../package.json")
 const env = require("../environment")
+const { middleware: pro } = require("@budibase/pro")
 
 const router = new Router()
 
@@ -52,6 +54,7 @@ router
     })
   )
   .use(currentApp)
+  .use(pro.licensing())
   .use(auditLog)
 
 // error handling middleware
@@ -60,10 +63,12 @@ router.use(async (ctx, next) => {
     await next()
   } catch (err) {
     ctx.status = err.status || err.statusCode || 500
+    const error = errors.getPublicError(err)
     ctx.body = {
       message: err.message,
       status: ctx.status,
       validationErrors: err.validation,
+      error,
     }
     if (env.NODE_ENV !== "jest") {
       ctx.log.error(err)

package/src/api/routes/{application.js → application.ts}

@@ -1,14 +1,13 @@
-const Router = require("@koa/router")
-const controller = require("../controllers/application")
-const authorized = require("../../middleware/authorized")
-const { BUILDER } = require("@budibase/backend-core/permissions")
-const usage = require("../../middleware/usageQuota")
+import Router from "@koa/router"
+import * as controller from "../controllers/application"
+import authorized from "../../middleware/authorized"
+import { BUILDER } from "@budibase/backend-core/permissions"
 
-const router = Router()
+const router = new Router()
 
 router
   .post("/api/applications/:appId/sync", authorized(BUILDER), controller.sync)
-  .post("/api/applications", authorized(BUILDER), usage, controller.create)
+  .post("/api/applications", authorized(BUILDER), controller.create)
   .get("/api/applications/:appId/definition", controller.fetchAppDefinition)
   .get("/api/applications", controller.fetch)
   .get("/api/applications/:appId/appPackage", controller.fetchAppPackage)
@@ -23,11 +22,6 @@ router
     authorized(BUILDER),
     controller.revertClient
   )
-  .delete(
-    "/api/applications/:appId",
-    authorized(BUILDER),
-    usage,
-    controller.delete
-  )
+  .delete("/api/applications/:appId", authorized(BUILDER), controller.destroy)
 
-module.exports = router
+export default router

package/src/api/routes/index.ts

@@ -0,0 +1,60 @@
+import authRoutes from "./auth"
+import layoutRoutes from "./layout"
+import screenRoutes from "./screen"
+import userRoutes from "./user"
+import applicationRoutes from "./application"
+import tableRoutes from "./table"
+import rowRoutes from "./row"
+import viewRoutes from "./view"
+import componentRoutes from "./component"
+import automationRoutes from "./automation"
+import webhookRoutes from "./webhook"
+import roleRoutes from "./role"
+import deployRoutes from "./deploy"
+import apiKeysRoutes from "./apikeys"
+import templatesRoutes from "./templates"
+import analyticsRoutes from "./analytics"
+import routingRoutes from "./routing"
+import integrationRoutes from "./integration"
+import permissionRoutes from "./permission"
+import datasourceRoutes from "./datasource"
+import queryRoutes from "./query"
+import backupRoutes from "./backup"
+import metadataRoutes from "./metadata"
+import devRoutes from "./dev"
+import cloudRoutes from "./cloud"
+import migrationRoutes from "./migrations"
+
+export { default as staticRoutes } from "./static"
+export { default as publicRoutes } from "./public"
+
+export const mainRoutes = [
+  authRoutes,
+  deployRoutes,
+  layoutRoutes,
+  screenRoutes,
+  userRoutes,
+  applicationRoutes,
+  automationRoutes,
+  viewRoutes,
+  componentRoutes,
+  roleRoutes,
+  apiKeysRoutes,
+  templatesRoutes,
+  analyticsRoutes,
+  webhookRoutes,
+  routingRoutes,
+  integrationRoutes,
+  permissionRoutes,
+  datasourceRoutes,
+  queryRoutes,
+  backupRoutes,
+  metadataRoutes,
+  devRoutes,
+  cloudRoutes,
+  // these need to be handled last as they still use /api/:tableId
+  // this could be breaking as koa may recognise other routes as this
+  tableRoutes,
+  rowRoutes,
+  migrationRoutes,
+]

package/src/api/routes/public/index.ts

@@ -3,7 +3,6 @@ import queryEndpoints from "./queries"
 import tableEndpoints from "./tables"
 import rowEndpoints from "./rows"
 import userEndpoints from "./users"
-import usage from "../../../middleware/usageQuota"
 import authorized from "../../../middleware/authorized"
 import publicApi from "../../../middleware/publicApi"
 import { paramResource, paramSubResource } from "../../../middleware/resourceId"
@@ -114,8 +113,6 @@ function applyRoutes(
   // add the authorization middleware, using the correct perm type
   addMiddleware(endpoints.read, authorized(permType, PermissionLevels.READ))
   addMiddleware(endpoints.write, authorized(permType, PermissionLevels.WRITE))
-  // add the usage quota middleware
-  addMiddleware(endpoints.write, usage)
   // add the output mapper middleware
   addMiddleware(endpoints.read, mapperMiddleware, { output: true })
   addMiddleware(endpoints.write, mapperMiddleware, { output: true })
@@ -130,4 +127,4 @@ applyRoutes(queryEndpoints, PermissionTypes.QUERY, "queryId")
 // needs to be applied last for routing purposes, don't override other endpoints
 applyRoutes(rowEndpoints, PermissionTypes.TABLE, "tableId", "rowId")
 
-module.exports = publicRouter
+export default publicRouter

package/src/api/routes/{row.js → row.ts}

@@ -1,18 +1,14 @@
-const Router = require("@koa/router")
-const rowController = require("../controllers/row")
-const authorized = require("../../middleware/authorized")
-const usage = require("../../middleware/usageQuota")
-const {
-  paramResource,
-  paramSubResource,
-} = require("../../middleware/resourceId")
+import Router from "@koa/router"
+import * as rowController from "../controllers/row"
+import authorized from "../../middleware/authorized"
+import { paramResource, paramSubResource } from "../../middleware/resourceId"
 const {
   PermissionLevels,
   PermissionTypes,
 } = require("@budibase/backend-core/permissions")
 const { internalSearchValidator } = require("./utils/validators")
 
-const router = Router()
+const router = new Router()
 
 router
   /**
@@ -180,7 +176,6 @@ router
     "/api/:tableId/rows",
     paramResource("tableId"),
     authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
-    usage,
     rowController.save
   )
   /**
@@ -195,7 +190,6 @@ router
     "/api/:tableId/rows",
     paramResource("tableId"),
     authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
-    usage,
     rowController.patch
   )
   /**
@@ -248,7 +242,6 @@ router
     "/api/:tableId/rows",
     paramResource("tableId"),
     authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
-    usage,
     rowController.destroy
   )
 
@@ -269,8 +262,7 @@ router
     "/api/:tableId/rows/exportRows",
     paramResource("tableId"),
     authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
-    usage,
-    rowController.export
+    rowController.exportRows
   )
 
-module.exports = router
+export default router

package/src/api/routes/{static.js → static.ts}

@@ -1,19 +1,19 @@
-const Router = require("@koa/router")
-const controller = require("../controllers/static")
-const { budibaseTempDir } = require("../../utilities/budibaseDir")
-const authorized = require("../../middleware/authorized")
-const {
+import Router from "@koa/router"
+import * as controller from "../controllers/static"
+import { budibaseTempDir } from "../../utilities/budibaseDir"
+import authorized from "../../middleware/authorized"
+import {
   BUILDER,
   PermissionTypes,
   PermissionLevels,
-} = require("@budibase/backend-core/permissions")
-const env = require("../../environment")
-const { paramResource } = require("../../middleware/resourceId")
+} from "@budibase/backend-core/permissions"
+import * as env from "../../environment"
+import { paramResource } from "../../middleware/resourceId"
 
-const router = Router()
+const router = new Router()
 
 /* istanbul ignore next */
-router.param("file", async (file, ctx, next) => {
+router.param("file", async (file: any, ctx: any, next: any) => {
   ctx.file = file && file.includes(".") ? file : "index.html"
   if (!ctx.file.startsWith("budibase-client")) {
     return next()
@@ -52,4 +52,4 @@ router
     controller.getSignedUploadURL
   )
 
-module.exports = router
+export default router