@budibase/server 2.1.44 → 2.1.46-alpha.0

package/src/utilities/security.ts

@@ -0,0 +1,65 @@
+import { permissions, roles } from "@budibase/backend-core"
+import { DocumentType } from "../db/utils"
+
+export const CURRENTLY_SUPPORTED_LEVELS: string[] = [
+  permissions.PermissionLevel.WRITE,
+  permissions.PermissionLevel.READ,
+  permissions.PermissionLevel.EXECUTE,
+]
+
+export function getPermissionType(resourceId: string) {
+  const docType = Object.values(DocumentType).filter(docType =>
+    resourceId.startsWith(docType)
+  )[0]
+  switch (docType) {
+    case DocumentType.TABLE:
+    case DocumentType.ROW:
+      return permissions.PermissionType.TABLE
+    case DocumentType.AUTOMATION:
+      return permissions.PermissionType.AUTOMATION
+    case DocumentType.WEBHOOK:
+      return permissions.PermissionType.WEBHOOK
+    case DocumentType.QUERY:
+    case DocumentType.DATASOURCE:
+      return permissions.PermissionType.QUERY
+    default:
+      // views don't have an ID, will end up here
+      return permissions.PermissionType.VIEW
+  }
+}
+
+/**
+ *  works out the basic permissions based on builtin roles for a resource, using its ID
+ */
+export function getBasePermissions(resourceId: string) {
+  const type = getPermissionType(resourceId)
+  const basePermissions: { [key: string]: string } = {}
+  for (let [roleId, role] of Object.entries(roles.getBuiltinRoles())) {
+    if (!role.permissionId) {
+      continue
+    }
+    const perms = permissions.getBuiltinPermissionByID(role.permissionId)
+    if (!perms) {
+      continue
+    }
+    const typedPermission = perms.permissions.find(perm => perm.type === type)
+    if (
+      typedPermission &&
+      CURRENTLY_SUPPORTED_LEVELS.indexOf(typedPermission.level) !== -1
+    ) {
+      const level = typedPermission.level
+      basePermissions[level] = roles.lowerBuiltinRoleID(
+        basePermissions[level],
+        roleId
+      )
+      if (permissions.isPermissionLevelHigherThanRead(level)) {
+        basePermissions[permissions.PermissionLevel.READ] =
+          roles.lowerBuiltinRoleID(
+            basePermissions[permissions.PermissionLevel.READ],
+            roleId
+          )
+      }
+    }
+  }
+  return basePermissions
+}

package/src/utilities/{statusCodes.js → statusCodes.ts}

@@ -1,4 +1,4 @@
-module.exports = {
+export = {
   OK: 200,
   UNAUTHORIZED: 401,
   FORBIDDEN: 403,

package/src/utilities/usageQuota/{rows.js → rows.ts}

@@ -1,23 +1,19 @@
-const { getRowParams, USER_METDATA_PREFIX } = require("../../db/utils")
-const {
-  isDevAppID,
-  getDevelopmentAppID,
-  getProdAppID,
-  doWithDB,
-} = require("@budibase/backend-core/db")
+import { getRowParams, USER_METDATA_PREFIX } from "../../db/utils"
+import { db as dbCore } from "@budibase/backend-core"
+import { Database, Row } from "@budibase/types"
 
 const ROW_EXCLUSIONS = [USER_METDATA_PREFIX]
 
-const getAppPairs = appIds => {
+function getAppPairs(appIds: string[]) {
   // collect the app ids into dev / prod pairs
   // keyed by the dev app id
-  const pairs = {}
+  const pairs: { [key: string]: { devId?: string; prodId?: string } } = {}
   for (let appId of appIds) {
-    const devId = getDevelopmentAppID(appId)
+    const devId = dbCore.getDevelopmentAppID(appId)
     if (!pairs[devId]) {
       pairs[devId] = {}
     }
-    if (isDevAppID(appId)) {
+    if (dbCore.isDevAppID(appId)) {
       pairs[devId].devId = appId
     } else {
       pairs[devId].prodId = appId
@@ -26,9 +22,9 @@ const getAppPairs = appIds => {
   return pairs
 }
 
-const getAppRows = async appId => {
+async function getAppRows(appId: string) {
   // need to specify the app ID, as this is used for different apps in one call
-  return doWithDB(appId, async db => {
+  return dbCore.doWithDB(appId, async (db: Database) => {
     const response = await db.allDocs(
       getRowParams(null, null, {
         include_docs: false,
@@ -52,13 +48,13 @@ const getAppRows = async appId => {
  * The returned rows will be unique on a per dev/prod app basis.
  * Rows duplicates may exist across apps due to data import so they are not filtered out.
  */
-exports.getUniqueRows = async appIds => {
-  let uniqueRows = [],
-    rowsByApp = {}
+export async function getUniqueRows(appIds: string[]) {
+  let uniqueRows: Row[] = [],
+    rowsByApp: { [key: string]: Row[] } = {}
   const pairs = getAppPairs(appIds)
 
   for (let pair of Object.values(pairs)) {
-    let appRows = []
+    let appRows: Row[] = []
     for (let appId of [pair.devId, pair.prodId]) {
       if (!appId) {
         continue
@@ -75,7 +71,7 @@ exports.getUniqueRows = async appIds => {
     // this can't be done on all rows because app import results in
     // duplicate row ids across apps
     // the array pre-concat is important to avoid stack overflow
-    const prodId = getProdAppID(pair.devId || pair.prodId)
+    const prodId = dbCore.getProdAppID((pair.devId || pair.prodId)!)
     rowsByApp[prodId] = [...new Set(appRows)]
     uniqueRows = uniqueRows.concat(rowsByApp[prodId])
   }

package/src/utilities/usageQuota/{usageQuoteReset.js → usageQuoteReset.ts}

@@ -7,7 +7,7 @@ function getNewQuotaReset() {
   return Date.now() + 2592000000
 }
 
-function resetQuotasIfRequired(quota) {
+function resetQuotasIfRequired(quota: { quotaReset: number; usageQuota: any }) {
   // Check if the quota needs reset
   if (Date.now() >= quota.quotaReset) {
     quota.quotaReset = getNewQuotaReset()

package/src/utilities/{users.js → users.ts}

@@ -1,12 +1,11 @@
-const { InternalTables } = require("../db/utils")
-const { getGlobalUser } = require("../utilities/global")
-const { getAppDB } = require("@budibase/backend-core/context")
-const { getProdAppID } = require("@budibase/backend-core/db")
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
+import { InternalTables } from "../db/utils"
+import { getGlobalUser } from "./global"
+import { context, db as dbCore, roles } from "@budibase/backend-core"
+import { BBContext } from "@budibase/types"
 
-exports.getFullUser = async (ctx, userId) => {
+export async function getFullUser(ctx: BBContext, userId: string) {
   const global = await getGlobalUser(userId)
-  let metadata = {}
+  let metadata: any = {}
 
   // always prefer the user metadata _id and _rev
   delete global._id
@@ -14,7 +13,7 @@ exports.getFullUser = async (ctx, userId) => {
 
   try {
     // this will throw an error if the db doesn't exist, or there is no appId
-    const db = getAppDB()
+    const db = context.getAppDB()
     metadata = await db.get(userId)
   } catch (err) {
     // it is fine if there is no user metadata yet
@@ -23,14 +22,14 @@ exports.getFullUser = async (ctx, userId) => {
   return {
     ...metadata,
     ...global,
-    roleId: global.roleId || BUILTIN_ROLE_IDS.PUBLIC,
+    roleId: global.roleId || roles.BUILTIN_ROLE_IDS.PUBLIC,
     tableId: InternalTables.USER_METADATA,
     // make sure the ID is always a local ID, not a global one
     _id: userId,
   }
 }
 
-exports.publicApiUserFix = ctx => {
+export function publicApiUserFix(ctx: BBContext) {
   if (!ctx.request.body) {
     return ctx
   }
@@ -40,10 +39,9 @@ exports.publicApiUserFix = ctx => {
   if (!ctx.request.body.roles) {
     ctx.request.body.roles = {}
   } else {
-    const newRoles = {}
+    const newRoles: { [key: string]: any } = {}
     for (let [appId, role] of Object.entries(ctx.request.body.roles)) {
-      // @ts-ignore
-      newRoles[getProdAppID(appId)] = role
+      newRoles[dbCore.getProdAppID(appId)] = role
     }
     ctx.request.body.roles = newRoles
   }

package/src/utilities/{workerRequests.js → workerRequests.ts}

@@ -1,19 +1,18 @@
-const fetch = require("node-fetch")
-const env = require("../environment")
-const { checkSlashesInUrl } = require("./index")
-const { getProdAppID } = require("@budibase/backend-core/db")
-const { updateAppRole } = require("./global")
-const { Headers } = require("@budibase/backend-core/constants")
-const { getTenantId, isTenantIdSet } = require("@budibase/backend-core/tenancy")
+import fetch from "node-fetch"
+import env from "../environment"
+import { checkSlashesInUrl } from "./index"
+import { db as dbCore, constants, tenancy } from "@budibase/backend-core"
+import { updateAppRole } from "./global"
+import { BBContext, User } from "@budibase/types"
 
-function request(ctx, request) {
+export function request(ctx?: BBContext, request?: any) {
   if (!request.headers) {
     request.headers = {}
   }
   if (!ctx) {
-    request.headers[Headers.API_KEY] = env.INTERNAL_API_KEY
-    if (isTenantIdSet()) {
-      request.headers[Headers.TENANT_ID] = getTenantId()
+    request.headers[constants.Header.API_KEY] = env.INTERNAL_API_KEY
+    if (tenancy.isTenantIdSet()) {
+      request.headers[constants.Header.TENANT_ID] = tenancy.getTenantId()
     }
   }
   if (request.body && Object.keys(request.body).length > 0) {
@@ -31,7 +30,11 @@ function request(ctx, request) {
   return request
 }
 
-async function checkResponse(response, errorMsg, { ctx } = {}) {
+async function checkResponse(
+  response: any,
+  errorMsg: string,
+  { ctx }: { ctx?: BBContext } = {}
+) {
   if (response.status !== 200) {
     let error
     try {
@@ -51,22 +54,20 @@ async function checkResponse(response, errorMsg, { ctx } = {}) {
   return response.json()
 }
 
-exports.request = request
-
 // have to pass in the tenant ID as this could be coming from an automation
-exports.sendSmtpEmail = async (
-  to,
-  from,
-  subject,
-  contents,
-  cc,
-  bcc,
-  automation
-) => {
+export async function sendSmtpEmail(
+  to: string,
+  from: string,
+  subject: string,
+  contents: string,
+  cc: string,
+  bcc: string,
+  automation: boolean
+) {
   // tenant ID will be set in header
   const response = await fetch(
     checkSlashesInUrl(env.WORKER_URL + `/api/global/email/send`),
-    request(null, {
+    request(undefined, {
       method: "POST",
       body: {
         email: to,
@@ -83,7 +84,7 @@ exports.sendSmtpEmail = async (
   return checkResponse(response, "send email")
 }
 
-exports.getGlobalSelf = async (ctx, appId = null) => {
+export async function getGlobalSelf(ctx: BBContext, appId?: string) {
   const endpoint = `/api/global/self`
   const response = await fetch(
     checkSlashesInUrl(env.WORKER_URL + endpoint),
@@ -97,8 +98,8 @@ exports.getGlobalSelf = async (ctx, appId = null) => {
   return json
 }
 
-exports.removeAppFromUserRoles = async (ctx, appId) => {
-  const prodAppId = getProdAppID(appId)
+export async function removeAppFromUserRoles(ctx: BBContext, appId: string) {
+  const prodAppId = dbCore.getProdAppID(appId)
   const response = await fetch(
     checkSlashesInUrl(env.WORKER_URL + `/api/global/roles/${prodAppId}`),
     request(ctx, {
@@ -108,7 +109,7 @@ exports.removeAppFromUserRoles = async (ctx, appId) => {
   return checkResponse(response, "remove app role")
 }
 
-exports.allGlobalUsers = async ctx => {
+export async function allGlobalUsers(ctx: BBContext) {
   const response = await fetch(
     checkSlashesInUrl(env.WORKER_URL + "/api/global/users"),
     // we don't want to use API key when getting self
@@ -117,7 +118,7 @@ exports.allGlobalUsers = async ctx => {
   return checkResponse(response, "get users", { ctx })
 }
 
-exports.saveGlobalUser = async ctx => {
+export async function saveGlobalUser(ctx: BBContext) {
   const response = await fetch(
     checkSlashesInUrl(env.WORKER_URL + "/api/global/users"),
     // we don't want to use API key when getting self
@@ -126,7 +127,7 @@ exports.saveGlobalUser = async ctx => {
   return checkResponse(response, "save user", { ctx })
 }
 
-exports.deleteGlobalUser = async ctx => {
+export async function deleteGlobalUser(ctx: BBContext) {
   const response = await fetch(
     checkSlashesInUrl(
       env.WORKER_URL + `/api/global/users/${ctx.params.userId}`
@@ -134,10 +135,10 @@ exports.deleteGlobalUser = async ctx => {
     // we don't want to use API key when getting self
     request(ctx, { method: "DELETE" })
   )
-  return checkResponse(response, "delete user", { ctx, body: ctx.request.body })
+  return checkResponse(response, "delete user", { ctx })
 }
 
-exports.readGlobalUser = async ctx => {
+export async function readGlobalUser(ctx: BBContext): Promise<User> {
   const response = await fetch(
     checkSlashesInUrl(
       env.WORKER_URL + `/api/global/users/${ctx.params.userId}`
@@ -148,26 +149,30 @@ exports.readGlobalUser = async ctx => {
   return checkResponse(response, "get user", { ctx })
 }
 
-exports.createAdminUser = async (email, password, tenantId) => {
+export async function createAdminUser(
+  email: string,
+  password: string,
+  tenantId: string
+) {
   const response = await fetch(
     checkSlashesInUrl(env.WORKER_URL + "/api/global/users/init"),
-    request(null, { method: "POST", body: { email, password, tenantId } })
+    request(undefined, { method: "POST", body: { email, password, tenantId } })
   )
   return checkResponse(response, "create admin user")
 }
 
-exports.getChecklist = async () => {
+export async function getChecklist() {
   const response = await fetch(
     checkSlashesInUrl(env.WORKER_URL + "/api/global/configs/checklist"),
-    request(null, { method: "GET" })
+    request(undefined, { method: "GET" })
   )
   return checkResponse(response, "get checklist")
 }
 
-exports.generateApiKey = async userId => {
+export async function generateApiKey(userId: string) {
   const response = await fetch(
     checkSlashesInUrl(env.WORKER_URL + "/api/global/self/api_key"),
-    request(null, { method: "POST", body: { userId } })
+    request(undefined, { method: "POST", body: { userId } })
   )
   return checkResponse(response, "generate API key")
 }

package/src/watch.ts

@@ -2,8 +2,7 @@ import path from "path"
 import * as env from "./environment"
 import chokidar from "chokidar"
 import fs from "fs"
-import { tenancy } from "@budibase/backend-core"
-import { DEFAULT_TENANT_ID } from "@budibase/backend-core/constants"
+import { constants, tenancy } from "@budibase/backend-core"
 import { processUploadedPlugin } from "./api/controllers/plugin"
 
 export function watch() {
@@ -23,7 +22,7 @@ export function watch() {
       if (!path?.endsWith(".tar.gz") || !fs.existsSync(path)) {
         return
       }
-      await tenancy.doInTenant(DEFAULT_TENANT_ID, async () => {
+      await tenancy.doInTenant(constants.DEFAULT_TENANT_ID, async () => {
         try {
           const split = path.split("/")
           const name = split[split.length - 1]

package/tsconfig.build.json

@@ -3,7 +3,6 @@
     "target": "es6",
     "module": "commonjs",
     "lib": ["es2020"],
-    "allowJs": true,
     "strict": true,
     "noImplicitAny": true,
     "esModuleInterop": true,
@@ -23,4 +22,4 @@
     "**/*.spec.ts",
     "**/*.spec.js"
   ]
-}
+}

package/tsconfig.json

@@ -8,7 +8,8 @@
     "paths": {
       "@budibase/types": ["../types/src"],
       "@budibase/backend-core": ["../backend-core/src"],
-      "@budibase/backend-core/*": ["../backend-core/*"]
+      "@budibase/backend-core/*": ["../backend-core/*"],
+      "@budibase/pro": ["../../../budibase-pro/packages/pro/src"]
     }
   },
   "ts-node": {
@@ -17,6 +18,7 @@
   "references": [
     { "path": "../types" },
     { "path": "../backend-core" },
+    { "path": "../../../budibase-pro/packages/pro" }
   ],
   "include": [
     "src/**/*",