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

package/src/api/routes/role.ts

@@ -0,0 +1,24 @@
+import Router from "@koa/router"
+import * as controller from "../controllers/role"
+import authorized from "../../middleware/authorized"
+import { permissions } from "@budibase/backend-core"
+import { roleValidator } from "./utils/validators"
+
+const router: Router = new Router()
+
+router
+  .post(
+    "/api/roles",
+    authorized(permissions.BUILDER),
+    roleValidator(),
+    controller.save
+  )
+  .get("/api/roles", authorized(permissions.BUILDER), controller.fetch)
+  .get("/api/roles/:roleId", authorized(permissions.BUILDER), controller.find)
+  .delete(
+    "/api/roles/:roleId/:rev",
+    authorized(permissions.BUILDER),
+    controller.destroy
+  )
+
+export = router

package/src/api/routes/routing.ts

@@ -0,0 +1,14 @@
+import Router from "@koa/router"
+import authorized from "../../middleware/authorized"
+import { permissions } from "@budibase/backend-core"
+import * as controller from "../controllers/routing"
+
+const router: Router = new Router()
+
+router
+  // gets correct structure for user role
+  .get("/api/routing/client", controller.clientFetch)
+  // gets the full structure, not just the correct screen ID for user role
+  .get("/api/routing", authorized(permissions.BUILDER), controller.fetch)
+
+export = router

package/src/api/routes/row.ts

@@ -2,13 +2,11 @@ import Router from "@koa/router"
 import * as rowController from "../controllers/row"
 import authorized from "../../middleware/authorized"
 import { paramResource, paramSubResource } from "../../middleware/resourceId"
-const {
-  PermissionLevel,
-  PermissionType,
-} = require("@budibase/backend-core/permissions")
+import { permissions } from "@budibase/backend-core"
 const { internalSearchValidator } = require("./utils/validators")
+const { PermissionType, PermissionLevel } = permissions
 
-const router = new Router()
+const router: Router = new Router()
 
 router
   /**

package/src/api/routes/screen.ts

@@ -0,0 +1,23 @@
+import Router from "@koa/router"
+import * as controller from "../controllers/screen"
+import authorized from "../../middleware/authorized"
+import { permissions } from "@budibase/backend-core"
+import { screenValidator } from "./utils/validators"
+
+const router: Router = new Router()
+
+router
+  .get("/api/screens", authorized(permissions.BUILDER), controller.fetch)
+  .post(
+    "/api/screens",
+    authorized(permissions.BUILDER),
+    screenValidator(),
+    controller.save
+  )
+  .delete(
+    "/api/screens/:screenId/:screenRev",
+    authorized(permissions.BUILDER),
+    controller.destroy
+  )
+
+export = router

package/src/api/routes/script.ts

@@ -0,0 +1,10 @@
+import Router from "@koa/router"
+import * as controller from "../controllers/script"
+import authorized from "../../middleware/authorized"
+import { permissions } from "@budibase/backend-core"
+
+const router: Router = new Router()
+
+router.post("/api/script", authorized(permissions.BUILDER), controller.save)
+
+export = router

package/src/api/routes/static.ts

@@ -2,15 +2,12 @@ import Router from "@koa/router"
 import * as controller from "../controllers/static"
 import { budibaseTempDir } from "../../utilities/budibaseDir"
 import authorized from "../../middleware/authorized"
-import {
-  BUILDER,
-  PermissionType,
-  PermissionLevel,
-} from "@budibase/backend-core/permissions"
+import { permissions } from "@budibase/backend-core"
 import * as env from "../../environment"
 import { paramResource } from "../../middleware/resourceId"
+const { BUILDER, PermissionType, PermissionLevel } = permissions
 
-const router = new Router()
+const router: Router = new Router()
 
 /* istanbul ignore next */
 router.param("file", async (file: any, ctx: any, next: any) => {
@@ -65,4 +62,4 @@ router
     controller.getSignedUploadURL
   )
 
-export default router
+export = router

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

@@ -1,15 +1,12 @@
-const Router = require("@koa/router")
-const tableController = require("../controllers/table")
-const authorized = require("../../middleware/authorized")
-const { paramResource, bodyResource } = require("../../middleware/resourceId")
-const {
-  BUILDER,
-  PermissionLevel,
-  PermissionType,
-} = require("@budibase/backend-core/permissions")
-const { tableValidator } = require("./utils/validators")
+import Router from "@koa/router"
+import * as tableController from "../controllers/table"
+import authorized from "../../middleware/authorized"
+import { paramResource, bodyResource } from "../../middleware/resourceId"
+import { permissions } from "@budibase/backend-core"
+import { tableValidator } from "./utils/validators"
+const { BUILDER, PermissionLevel, PermissionType } = permissions
 
-const router = new Router()
+const router: Router = new Router()
 
 router
   /**
@@ -193,4 +190,4 @@ router
     tableController.bulkImport
   )
 
-module.exports = router
+export = router

package/src/api/routes/templates.ts

@@ -0,0 +1,16 @@
+import Router from "@koa/router"
+import * as controller from "../controllers/templates"
+import authorized from "../../middleware/authorized"
+import { permissions } from "@budibase/backend-core"
+
+const router: Router = new Router()
+
+router
+  .get("/api/templates", authorized(permissions.BUILDER), controller.fetch)
+  .get(
+    "/api/templates/:type/:name",
+    authorized(permissions.BUILDER),
+    controller.downloadTemplate
+  )
+
+export = router

package/src/api/routes/tests/backup.spec.js

@@ -1,4 +1,12 @@
-jest.mock("../../../utilities/fileSystem/utilities")
+jest.mock("@budibase/backend-core", () => {
+  const core = jest.requireActual("@budibase/backend-core")
+  return {
+    ...core,
+    objectStore: {
+      budibaseTempDir: core.objectStore.budibaseTempDir,
+    },
+  }
+})
 
 const { checkBuilderEndpoint } = require("./utilities/TestFunctions")
 const setup = require("./utilities")

package/src/api/routes/tests/permissions.spec.js

@@ -1,6 +1,7 @@
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
+const { roles } = require("@budibase/backend-core")
 const setup = require("./utilities")
 const { basicRow } = setup.structures
+const { BUILTIN_ROLE_IDS } = roles
 
 const HIGHER_ROLE_ID = BUILTIN_ROLE_IDS.BASIC
 const STD_ROLE_ID = BUILTIN_ROLE_IDS.PUBLIC

package/src/api/routes/tests/role.spec.js

@@ -1,10 +1,8 @@
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
-const {
-  BuiltinPermissionID,
-} = require("@budibase/backend-core/permissions")
+const { roles, events, permissions } = require("@budibase/backend-core")
 const setup = require("./utilities")
 const { basicRole } = setup.structures
-const { events } = require("@budibase/backend-core")
+const { BUILTIN_ROLE_IDS } = roles
+const { BuiltinPermissionID } = permissions
 
 describe("/roles", () => {
   let request = setup.getRequest()

package/src/api/routes/tests/routing.spec.js

@@ -1,7 +1,8 @@
 const setup = require("./utilities")
 const { basicScreen } = setup.structures
 const { checkBuilderEndpoint, runInProd } = require("./utilities/TestFunctions")
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
+const { roles } = require("@budibase/backend-core")
+const { BUILTIN_ROLE_IDS } = roles
 
 const route = "/test"
 

package/src/api/routes/tests/row.spec.js

@@ -1,8 +1,7 @@
 const { outputProcessing } = require("../../../utilities/rowProcessor")
 const setup = require("./utilities")
 const { basicRow } = setup.structures
-const { doInAppContext } = require("@budibase/backend-core/context")
-const { doInTenant } = require("@budibase/backend-core/tenancy")
+const { context, tenancy } = require("@budibase/backend-core")
 const {
   quotas,
 } = require("@budibase/pro")
@@ -447,7 +446,7 @@ describe("/rows", () => {
 
   describe("fetchEnrichedRows", () => {
     it("should allow enriching some linked rows", async () => {
-      const { table, firstRow, secondRow } = await doInTenant(
+      const { table, firstRow, secondRow } = await tenancy.doInTenant(
         setup.structures.TENANT_ID,
         async () => {
           const table = await config.createLinkedTable()
@@ -507,7 +506,7 @@ describe("/rows", () => {
       })
       // the environment needs configured for this
       await setup.switchToSelfHosted(async () => {
-        doInAppContext(config.getAppId(), async () => {
+        context.doInAppContext(config.getAppId(), async () => {
           const enriched = await outputProcessing(table, [row])
           expect(enriched[0].attachment[0].url).toBe(
             `/prod-budi-app-assets/${config.getAppId()}/attachments/test/thing.csv`

package/src/api/routes/tests/user.spec.js

@@ -1,6 +1,7 @@
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
+const { roles } = require("@budibase/backend-core")
 const { checkPermissionsEndpoint } = require("./utilities/TestFunctions")
 const setup = require("./utilities")
+const { BUILTIN_ROLE_IDS } = roles
 
 jest.mock("../../../utilities/workerRequests", () => ({
   getGlobalUsers: jest.fn(() => {

package/src/api/routes/tests/utilities/TestFunctions.ts

@@ -1,10 +1,8 @@
 import * as rowController from "../../../controllers/row"
 import * as appController from "../../../controllers/application"
 import { AppStatus } from "../../../../db/utils"
-import { BUILTIN_ROLE_IDS } from "@budibase/backend-core/roles"
-import { doInTenant } from "@budibase/backend-core/tenancy"
+import { roles, tenancy, context } from "@budibase/backend-core"
 import { TENANT_ID } from "../../../../tests/utilities/structures"
-import { getAppDB, doInAppContext } from "@budibase/backend-core/context"
 import * as env from "../../../../environment"
 
 class Request {
@@ -21,7 +19,7 @@ class Request {
 }
 
 function runRequest(appId: any, controlFunc: any, request?: any) {
-  return doInAppContext(appId, async () => {
+  return context.doInAppContext(appId, async () => {
     return controlFunc(request)
   })
 }
@@ -33,7 +31,7 @@ export const getAllTableRows = async (config: any) => {
 }
 
 export const clearAllApps = async (tenantId = TENANT_ID) => {
-  await doInTenant(tenantId, async () => {
+  await tenancy.doInTenant(tenantId, async () => {
     const req: any = { query: { status: AppStatus.DEV }, user: { tenantId } }
     await appController.fetch(req)
     const apps = req.body
@@ -51,7 +49,7 @@ export const clearAllApps = async (tenantId = TENANT_ID) => {
 export const clearAllAutomations = async (config: any) => {
   const automations = await config.getAllAutomations()
   for (let auto of automations) {
-    await doInAppContext(config.appId, async () => {
+    await context.doInAppContext(config.appId, async () => {
       await config.deleteAutomation(auto)
     })
   }
@@ -110,7 +108,7 @@ export const checkPermissionsEndpoint = async ({
     .expect(200)
 
   let failHeader
-  if (failRole === BUILTIN_ROLE_IDS.PUBLIC) {
+  if (failRole === roles.BUILTIN_ROLE_IDS.PUBLIC) {
     failHeader = config.publicHeaders({ prodApp: true })
   } else {
     failHeader = await config.login({
@@ -127,7 +125,7 @@ export const checkPermissionsEndpoint = async ({
 }
 
 export const getDB = () => {
-  return getAppDB()
+  return context.getAppDB()
 }
 
 export const testAutomation = async (config: any, automation: any) => {

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

@@ -1,12 +1,10 @@
-const Router = require("@koa/router")
-const controller = require("../controllers/user")
-const authorized = require("../../middleware/authorized")
-const {
-  PermissionLevel,
-  PermissionType,
-} = require("@budibase/backend-core/permissions")
+import Router from "@koa/router"
+import * as controller from "../controllers/user"
+import authorized from "../../middleware/authorized"
+import { permissions } from "@budibase/backend-core"
+const { PermissionType, PermissionLevel } = permissions
 
-const router = new Router()
+const router: Router = new Router()
 
 router
   .get(
@@ -50,4 +48,4 @@ router
     controller.getFlags
   )
 
-module.exports = router
+export = router

package/src/api/routes/utils/{validators.js → validators.ts}

@@ -1,20 +1,16 @@
-const { joiValidator } = require("@budibase/backend-core/auth")
-const { DataSourceOperation } = require("../../../constants")
-const {
-  BuiltinPermissionID,
-  PermissionLevel,
-} = require("@budibase/backend-core/permissions")
-const { WebhookActionType } = require("@budibase/types")
-const Joi = require("joi")
+import { auth, permissions } from "@budibase/backend-core"
+import { DataSourceOperation } from "../../../constants"
+import { WebhookActionType } from "@budibase/types"
+import Joi from "joi"
 
 const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("")
 const OPTIONAL_NUMBER = Joi.number().optional().allow(null)
 const OPTIONAL_BOOLEAN = Joi.boolean().optional().allow(null)
 const APP_NAME_REGEX = /^[\w\s]+$/
 
-exports.tableValidator = () => {
+export function tableValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
     type: OPTIONAL_STRING.valid("table", "internal", "external"),
@@ -26,16 +22,16 @@ exports.tableValidator = () => {
   }).unknown(true))
 }
 
-exports.nameValidator = () => {
+export function nameValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     name: OPTIONAL_STRING,
   }))
 }
 
-exports.datasourceValidator = () => {
+export function datasourceValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     _id: Joi.string(),
     _rev: Joi.string(),
     type: OPTIONAL_STRING.allow("datasource_plus"),
@@ -64,9 +60,9 @@ function filterObject() {
   }).unknown(true)
 }
 
-exports.internalSearchValidator = () => {
+export function internalSearchValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     tableId: OPTIONAL_STRING,
     query: filterObject(),
     limit: OPTIONAL_NUMBER,
@@ -78,8 +74,8 @@ exports.internalSearchValidator = () => {
   }))
 }
 
-exports.externalSearchValidator = () => {
-  return joiValidator.body(
+export function externalSearchValidator() {
+  return auth.joiValidator.body(
     Joi.object({
       query: filterObject(),
       paginate: Joi.boolean().optional(),
@@ -96,9 +92,9 @@ exports.externalSearchValidator = () => {
   )
 }
 
-exports.datasourceQueryValidator = () => {
+export function datasourceQueryValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     endpoint: Joi.object({
       datasourceId: Joi.string().required(),
       operation: Joi.string().required().valid(...Object.values(DataSourceOperation)),
@@ -117,9 +113,9 @@ exports.datasourceQueryValidator = () => {
   }))
 }
 
-exports.webhookValidator = () => {
+export function webhookValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     live: Joi.bool(),
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
@@ -132,15 +128,15 @@ exports.webhookValidator = () => {
   }).unknown(true))
 }
 
-exports.roleValidator = () => {
-  const permLevelArray = Object.values(PermissionLevel)
+export function roleValidator() {
+  const permLevelArray = Object.values(permissions.PermissionLevel)
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
     name: Joi.string().required(),
     // this is the base permission ID (for now a built in)
-    permissionId: Joi.string().valid(...Object.values(BuiltinPermissionID)).required(),
+    permissionId: Joi.string().valid(...Object.values(permissions.BuiltinPermissionID)).required(),
     permissions: Joi.object()
       .pattern(/.*/, [Joi.string().valid(...permLevelArray)])
       .optional(),
@@ -148,19 +144,19 @@ exports.roleValidator = () => {
   }).unknown(true))
 }
 
-exports.permissionValidator = () => {
-  const permLevelArray = Object.values(PermissionLevel)
+export function permissionValidator() {
+  const permLevelArray = Object.values(permissions.PermissionLevel)
   // prettier-ignore
-  return joiValidator.params(Joi.object({
+  return auth.joiValidator.params(Joi.object({
     level: Joi.string().valid(...permLevelArray).required(),
     resourceId: Joi.string(),
     roleId: Joi.string(),
   }).unknown(true))
 }
 
-exports.screenValidator = () => {
+export function screenValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     name: Joi.string().required(),
     showNavigation: OPTIONAL_BOOLEAN,
     width: OPTIONAL_STRING,
@@ -181,7 +177,7 @@ exports.screenValidator = () => {
   }).unknown(true))
 }
 
-function generateStepSchema(allowStepTypes) {
+function generateStepSchema(allowStepTypes: string[]) {
   // prettier-ignore
   return Joi.object({
     stepId: Joi.string().required(),
@@ -196,9 +192,9 @@ function generateStepSchema(allowStepTypes) {
   }).unknown(true)
 }
 
-exports.automationValidator = (existing = false) => {
+export function automationValidator(existing = false) {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     _id: existing ? Joi.string().required() : OPTIONAL_STRING,
     _rev: existing ? Joi.string().required() : OPTIONAL_STRING,
     name: Joi.string().required(),
@@ -210,9 +206,9 @@ exports.automationValidator = (existing = false) => {
   }).unknown(true))
 }
 
-exports.applicationValidator = (opts = { isCreate: true }) => {
+export function applicationValidator(opts = { isCreate: true }) {
   // prettier-ignore
-  const base = {
+  const base: any = {
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
     url: OPTIONAL_STRING,
@@ -230,7 +226,7 @@ exports.applicationValidator = (opts = { isCreate: true }) => {
     base.name = appNameValidator.optional()
   }
 
-  return joiValidator.body(
+  return auth.joiValidator.body(
     Joi.object({
       _id: OPTIONAL_STRING,
       _rev: OPTIONAL_STRING,

package/src/api/routes/view.ts

@@ -0,0 +1,34 @@
+import Router from "@koa/router"
+import * as viewController from "../controllers/view"
+import * as rowController from "../controllers/row"
+import authorized from "../../middleware/authorized"
+import { paramResource } from "../../middleware/resourceId"
+import { permissions } from "@budibase/backend-core"
+
+const router: Router = new Router()
+
+router
+  .get(
+    "/api/views/export",
+    authorized(permissions.BUILDER),
+    viewController.exportView
+  )
+  .get(
+    "/api/views/:viewName",
+    paramResource("viewName"),
+    authorized(
+      permissions.PermissionType.VIEW,
+      permissions.PermissionLevel.READ
+    ),
+    rowController.fetchView
+  )
+  .get("/api/views", authorized(permissions.BUILDER), viewController.fetch)
+  .delete(
+    "/api/views/:viewName",
+    paramResource("viewName"),
+    authorized(permissions.BUILDER),
+    viewController.destroy
+  )
+  .post("/api/views", authorized(permissions.BUILDER), viewController.save)
+
+export = router

package/src/api/routes/webhook.ts

@@ -5,7 +5,7 @@ import { permissions } from "@budibase/backend-core"
 import { webhookValidator } from "./utils/validators"
 
 const BUILDER = permissions.BUILDER
-const router = new Router()
+const router: Router = new Router()
 
 router
   .get("/api/webhooks", authorized(BUILDER), controller.fetch)
@@ -24,4 +24,4 @@ router
   // this shouldn't have authorisation, right now its always public
   .post("/api/webhooks/trigger/:instance/:id", controller.trigger)
 
-export default router
+export = router

package/src/app.ts

@@ -19,10 +19,9 @@ const http = require("http")
 const api = require("./api")
 const automations = require("./automations/index")
 const Sentry = require("@sentry/node")
-const { logAlert } = require("@budibase/backend-core/logging")
 const { Thread } = require("./threads")
-import redis from "./utilities/redis"
-import { events } from "@budibase/backend-core"
+import * as redis from "./utilities/redis"
+import { events, logging } from "@budibase/backend-core"
 import { initialise as initialiseWebsockets } from "./websocket"
 import { startup } from "./startup"
 
@@ -93,7 +92,7 @@ process.on("uncaughtException", err => {
     return
   }
   errCode = -1
-  logAlert("Uncaught exception.", err)
+  logging.logAlert("Uncaught exception.", err)
   shutdown()
 })
 

package/src/automations/triggers.js

@@ -8,8 +8,7 @@ const { automationQueue } = require("./bullboard")
 const { checkTestFlag } = require("../utilities/redis")
 const utils = require("./utils")
 const env = require("../environment")
-const { doInAppContext, getAppDB } = require("@budibase/backend-core/context")
-const { getAllApps } = require("@budibase/backend-core/db")
+const { context, db: dbCore } = require("@budibase/backend-core")
 
 const TRIGGER_DEFINITIONS = definitions
 const JOB_OPTS = {
@@ -18,7 +17,7 @@ const JOB_OPTS = {
 }
 
 async function getAllAutomations() {
-  const db = getAppDB()
+  const db = context.getAppDB()
   let automations = await db.allDocs(
     getAutomationParams(null, { include_docs: true })
   )
@@ -30,7 +29,7 @@ async function queueRelevantRowAutomations(event, eventType) {
     throw `No appId specified for ${eventType} - check event emitters.`
   }
 
-  doInAppContext(event.appId, async () => {
+  context.doInAppContext(event.appId, async () => {
     let automations = await getAllAutomations()
 
     // filter down to the correct event type
@@ -122,9 +121,9 @@ exports.rebootTrigger = async () => {
   }
   // iterate through all production apps, find the reboot crons
   // and trigger events for them
-  const appIds = await getAllApps({ dev: false, idsOnly: true })
+  const appIds = await dbCore.getAllApps({ dev: false, idsOnly: true })
   for (let prodAppId of appIds) {
-    await doInAppContext(prodAppId, async () => {
+    await context.doInAppContext(prodAppId, async () => {
       let automations = await getAllAutomations()
       let rebootEvents = []
       for (let automation of automations) {

package/src/constants/index.js

@@ -1,6 +1,4 @@
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
-const { UserStatus } = require("@budibase/backend-core/constants")
-const { objectStore } = require("@budibase/backend-core")
+const { objectStore, roles, constants } = require("@budibase/backend-core")
 
 const FilterTypes = {
   STRING: "string",
@@ -139,7 +137,7 @@ exports.USERS_TABLE_SCHEMA = {
       constraints: {
         type: exports.FieldTypes.STRING,
         presence: false,
-        inclusion: Object.values(BUILTIN_ROLE_IDS),
+        inclusion: Object.values(roles.BUILTIN_ROLE_IDS),
       },
     },
     status: {
@@ -149,7 +147,7 @@ exports.USERS_TABLE_SCHEMA = {
       constraints: {
         type: exports.FieldTypes.STRING,
         presence: false,
-        inclusion: Object.values(UserStatus),
+        inclusion: Object.values(constants.UserStatus),
       },
     },
   },