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

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

@@ -1,10 +1,10 @@
-const { StaticDatabases } = require("@budibase/backend-core/db")
-const { getGlobalDB } = require("@budibase/backend-core/tenancy")
+import { db as dbCore, tenancy } from "@budibase/backend-core"
+import { BBContext, Document } from "@budibase/types"
 
-const KEYS_DOC = StaticDatabases.GLOBAL.docs.apiKeys
+const KEYS_DOC = dbCore.StaticDatabases.GLOBAL.docs.apiKeys
 
 async function getBuilderMainDoc() {
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
   try {
     return await db.get(KEYS_DOC)
   } catch (err) {
@@ -15,24 +15,24 @@ async function getBuilderMainDoc() {
   }
 }
 
-async function setBuilderMainDoc(doc) {
+async function setBuilderMainDoc(doc: Document) {
   // make sure to override the ID
   doc._id = KEYS_DOC
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
   return db.put(doc)
 }
 
-exports.fetch = async function (ctx) {
+export async function fetch(ctx: BBContext) {
   try {
     const mainDoc = await getBuilderMainDoc()
     ctx.body = mainDoc.apiKeys ? mainDoc.apiKeys : {}
-  } catch (err) {
+  } catch (err: any) {
     /* istanbul ignore next */
     ctx.throw(400, err)
   }
 }
 
-exports.update = async function (ctx) {
+export async function update(ctx: BBContext) {
   const key = ctx.params.key
   const value = ctx.request.body.value
 
@@ -47,7 +47,7 @@ exports.update = async function (ctx) {
       _id: resp.id,
       _rev: resp.rev,
     }
-  } catch (err) {
+  } catch (err: any) {
     /* istanbul ignore next */
     ctx.throw(400, err)
   }

package/src/api/controllers/application.ts

@@ -25,8 +25,14 @@ import {
   migrations,
 } from "@budibase/backend-core"
 import { USERS_TABLE_SCHEMA } from "../../constants"
+import { buildDefaultDocs } from "../../db/defaultData/datasource_bb_default"
+
 import { removeAppFromUserRoles } from "../../utilities/workerRequests"
-import { clientLibraryPath, stringToReadStream } from "../../utilities"
+import {
+  clientLibraryPath,
+  stringToReadStream,
+  isQsTrue,
+} from "../../utilities"
 import { getLocksById } from "../../utilities/redis"
 import {
   updateClientLibrary,
@@ -117,7 +123,7 @@ const checkAppName = (
   }
 }
 
-async function createInstance(template: any) {
+async function createInstance(template: any, includeSampleData: boolean) {
   const tenantId = tenancy.isMultiTenant() ? tenancy.getTenantId() : null
   const baseAppId = generateAppID(tenantId)
   const appId = generateDevAppID(baseAppId)
@@ -149,11 +155,23 @@ async function createInstance(template: any) {
   } else {
     // create the users table
     await db.put(USERS_TABLE_SCHEMA)
+
+    if (includeSampleData) {
+      // create ootb stock db
+      await addDefaultTables(db)
+    }
   }
 
   return { _id: appId }
 }
 
+const addDefaultTables = async (db: any) => {
+  const defaultDbDocs = buildDefaultDocs()
+
+  // add in the default db data docs - tables, datasource, rows and links
+  await db.bulkDocs([...defaultDbDocs])
+}
+
 export const fetch = async (ctx: any) => {
   const dev = ctx.query && ctx.query.status === AppStatus.DEV
   const all = ctx.query && ctx.query.status === AppStatus.ALL
@@ -234,7 +252,8 @@ const performAppCreate = async (ctx: any) => {
   if (ctx.request.files && ctx.request.files.templateFile) {
     instanceConfig.file = ctx.request.files.templateFile
   }
-  const instance = await createInstance(instanceConfig)
+  const includeSampleData = isQsTrue(ctx.request.body.sampleData)
+  const instance = await createInstance(instanceConfig, includeSampleData)
   const appId = instance._id
   const db = context.getAppDB()
 

package/src/api/controllers/auth.ts

@@ -3,7 +3,7 @@ import { InternalTables } from "../../db/utils"
 import { getFullUser } from "../../utilities/users"
 import { roles, context } from "@budibase/backend-core"
 import { groups } from "@budibase/pro"
-import { ContextUser, User } from "@budibase/types"
+import { ContextUser, User, Row } from "@budibase/types"
 
 const PUBLIC_ROLE = roles.BUILTIN_ROLE_IDS.PUBLIC
 
@@ -43,7 +43,7 @@ export async function fetchSelf(ctx: any) {
     try {
       const userTable = await db.get(InternalTables.USER_METADATA)
       // specifically needs to make sure is enriched
-      ctx.body = await outputProcessing(userTable, user)
+      ctx.body = await outputProcessing(userTable, user as Row)
     } catch (err: any) {
       let response
       // user didn't exist in app, don't pretend they do

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

@@ -1,26 +1,21 @@
-const actions = require("../../automations/actions")
-const triggers = require("../../automations/triggers")
-const {
+import actions from "../../automations/actions"
+import triggers from "../../automations/triggers"
+import {
   getAutomationParams,
   generateAutomationID,
   DocumentType,
-} = require("../../db/utils")
-const {
+} from "../../db/utils"
+import {
   checkForWebhooks,
   updateTestHistory,
   removeDeprecated,
-} = require("../../automations/utils")
-const { deleteEntityMetadata } = require("../../utilities")
-const { MetadataTypes } = require("../../constants")
-const { setTestFlag, clearTestFlag } = require("../../utilities/redis")
-const {
-  getAppDB,
-  getProdAppDB,
-  doInAppContext,
-} = require("@budibase/backend-core/context")
-const { events } = require("@budibase/backend-core")
-const { app } = require("@budibase/backend-core/cache")
-const { automations } = require("@budibase/pro")
+} from "../../automations/utils"
+import { deleteEntityMetadata } from "../../utilities"
+import { MetadataTypes } from "../../constants"
+import { setTestFlag, clearTestFlag } from "../../utilities/redis"
+import { context, cache, events } from "@budibase/backend-core"
+import { automations } from "@budibase/pro"
+import { Automation, BBContext } from "@budibase/types"
 
 const ACTION_DEFS = removeDeprecated(actions.ACTION_DEFINITIONS)
 const TRIGGER_DEFS = removeDeprecated(triggers.TRIGGER_DEFINITIONS)
@@ -31,7 +26,7 @@ const TRIGGER_DEFS = removeDeprecated(triggers.TRIGGER_DEFINITIONS)
  *                       *
  *************************/
 
-async function cleanupAutomationMetadata(automationId) {
+async function cleanupAutomationMetadata(automationId: string) {
   await deleteEntityMetadata(MetadataTypes.AUTOMATION_TEST_INPUT, automationId)
   await deleteEntityMetadata(
     MetadataTypes.AUTOMATION_TEST_HISTORY,
@@ -39,7 +34,7 @@ async function cleanupAutomationMetadata(automationId) {
   )
 }
 
-function cleanAutomationInputs(automation) {
+function cleanAutomationInputs(automation: Automation) {
   if (automation == null) {
     return automation
   }
@@ -63,14 +58,14 @@ function cleanAutomationInputs(automation) {
   return automation
 }
 
-exports.create = async function (ctx) {
-  const db = getAppDB()
+export async function create(ctx: BBContext) {
+  const db = context.getAppDB()
   let automation = ctx.request.body
   automation.appId = ctx.appId
 
   // call through to update if already exists
   if (automation._id && automation._rev) {
-    return exports.update(ctx)
+    return update(ctx)
   }
 
   automation._id = generateAutomationID()
@@ -97,17 +92,23 @@ exports.create = async function (ctx) {
   }
 }
 
-const getNewSteps = (oldAutomation, automation) => {
+export function getNewSteps(oldAutomation: Automation, automation: Automation) {
   const oldStepIds = oldAutomation.definition.steps.map(s => s.id)
   return automation.definition.steps.filter(s => !oldStepIds.includes(s.id))
 }
 
-const getDeletedSteps = (oldAutomation, automation) => {
+export function getDeletedSteps(
+  oldAutomation: Automation,
+  automation: Automation
+) {
   const stepIds = automation.definition.steps.map(s => s.id)
   return oldAutomation.definition.steps.filter(s => !stepIds.includes(s.id))
 }
 
-const handleStepEvents = async (oldAutomation, automation) => {
+export async function handleStepEvents(
+  oldAutomation: Automation,
+  automation: Automation
+) {
   // new steps
   const newSteps = getNewSteps(oldAutomation, automation)
   for (let step of newSteps) {
@@ -121,8 +122,8 @@ const handleStepEvents = async (oldAutomation, automation) => {
   }
 }
 
-exports.update = async function (ctx) {
-  const db = getAppDB()
+export async function update(ctx: BBContext) {
+  const db = context.getAppDB()
   let automation = ctx.request.body
   automation.appId = ctx.appId
   const oldAutomation = await db.get(automation._id)
@@ -146,9 +147,8 @@ exports.update = async function (ctx) {
   if (oldAutoTrigger && oldAutoTrigger.id !== newAutoTrigger.id) {
     await events.automation.triggerUpdated(automation)
     await deleteEntityMetadata(
-      ctx.appId,
       MetadataTypes.AUTOMATION_TEST_INPUT,
-      automation._id
+      automation._id!
     )
   }
 
@@ -165,8 +165,8 @@ exports.update = async function (ctx) {
   }
 }
 
-exports.fetch = async function (ctx) {
-  const db = getAppDB()
+export async function fetch(ctx: BBContext) {
+  const db = context.getAppDB()
   const response = await db.allDocs(
     getAutomationParams(null, {
       include_docs: true,
@@ -175,13 +175,13 @@ exports.fetch = async function (ctx) {
   ctx.body = response.rows.map(row => row.doc)
 }
 
-exports.find = async function (ctx) {
-  const db = getAppDB()
+export async function find(ctx: BBContext) {
+  const db = context.getAppDB()
   ctx.body = await db.get(ctx.params.id)
 }
 
-exports.destroy = async function (ctx) {
-  const db = getAppDB()
+export async function destroy(ctx: BBContext) {
+  const db = context.getAppDB()
   const automationId = ctx.params.id
   const oldAutomation = await db.get(automationId)
   await checkForWebhooks({
@@ -193,14 +193,14 @@ exports.destroy = async function (ctx) {
   await events.automation.deleted(oldAutomation)
 }
 
-exports.logSearch = async function (ctx) {
+export async function logSearch(ctx: BBContext) {
   ctx.body = await automations.logs.logSearch(ctx.request.body)
 }
 
-exports.clearLogError = async function (ctx) {
+export async function clearLogError(ctx: BBContext) {
   const { automationId, appId } = ctx.request.body
-  await doInAppContext(appId, async () => {
-    const db = getProdAppDB()
+  await context.doInAppContext(appId, async () => {
+    const db = context.getProdAppDB()
     const metadata = await db.get(DocumentType.APP_METADATA)
     if (!automationId) {
       delete metadata.automationErrors
@@ -211,20 +211,20 @@ exports.clearLogError = async function (ctx) {
       delete metadata.automationErrors[automationId]
     }
     await db.put(metadata)
-    await app.invalidateAppMetadata(metadata.appId, metadata)
+    await cache.app.invalidateAppMetadata(metadata.appId, metadata)
     ctx.body = { message: `Error logs cleared.` }
   })
 }
 
-exports.getActionList = async function (ctx) {
+export async function getActionList(ctx: BBContext) {
   ctx.body = ACTION_DEFS
 }
 
-exports.getTriggerList = async function (ctx) {
+export async function getTriggerList(ctx: BBContext) {
   ctx.body = TRIGGER_DEFS
 }
 
-module.exports.getDefinitionList = async function (ctx) {
+export async function getDefinitionList(ctx: BBContext) {
   ctx.body = {
     trigger: TRIGGER_DEFS,
     action: ACTION_DEFS,
@@ -237,8 +237,8 @@ module.exports.getDefinitionList = async function (ctx) {
  *                   *
  *********************/
 
-exports.trigger = async function (ctx) {
-  const db = getAppDB()
+export async function trigger(ctx: BBContext) {
+  const db = context.getAppDB()
   let automation = await db.get(ctx.params.id)
   await triggers.externalTrigger(automation, {
     ...ctx.request.body,
@@ -250,7 +250,7 @@ exports.trigger = async function (ctx) {
   }
 }
 
-function prepareTestInput(input) {
+function prepareTestInput(input: any) {
   // prepare the test parameters
   if (input.id && input.row) {
     input.row._id = input.id
@@ -261,8 +261,8 @@ function prepareTestInput(input) {
   return input
 }
 
-exports.test = async function (ctx) {
-  const db = getAppDB()
+export async function test(ctx: BBContext) {
+  const db = context.getAppDB()
   let automation = await db.get(ctx.params.id)
   await setTestFlag(automation._id)
   const testInput = prepareTestInput(ctx.request.body)

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

@@ -1,14 +1,14 @@
-const env = require("../../environment")
-const { getAllApps, getGlobalDBName } = require("@budibase/backend-core/db")
-const { getGlobalDB } = require("@budibase/backend-core/tenancy")
-const { streamFile } = require("../../utilities/fileSystem")
-const { stringToReadStream } = require("../../utilities")
-const { getDocParams, DocumentType, isDevAppID } = require("../../db/utils")
-const { create } = require("./application")
-const { join } = require("path")
-const sdk = require("../../sdk")
+import env from "../../environment"
+import { db as dbCore, tenancy } from "@budibase/backend-core"
+import { streamFile } from "../../utilities/fileSystem"
+import { stringToReadStream } from "../../utilities"
+import { getDocParams, DocumentType, isDevAppID } from "../../db/utils"
+import { create } from "./application"
+import { join } from "path"
+import { App, BBContext, Database } from "@budibase/types"
+import sdk from "../../sdk"
 
-async function createApp(appName, appDirectory) {
+async function createApp(appName: string, appDirectory: string) {
   const ctx = {
     request: {
       body: {
@@ -25,7 +25,7 @@ async function createApp(appName, appDirectory) {
   return create(ctx)
 }
 
-async function getAllDocType(db, docType) {
+async function getAllDocType(db: Database, docType: string) {
   const response = await db.allDocs(
     getDocParams(docType, null, {
       include_docs: true,
@@ -34,19 +34,19 @@ async function getAllDocType(db, docType) {
   return response.rows.map(row => row.doc)
 }
 
-exports.exportApps = async ctx => {
+export async function exportApps(ctx: BBContext) {
   if (env.SELF_HOSTED || !env.MULTI_TENANCY) {
     ctx.throw(400, "Exporting only allowed in multi-tenant cloud environments.")
   }
-  const apps = await getAllApps({ all: true })
-  const globalDBString = await sdk.backups.exportDB(getGlobalDBName(), {
-    filter: doc => !doc._id.startsWith(DocumentType.USER),
+  const apps = (await dbCore.getAllApps({ all: true })) as App[]
+  const globalDBString = await sdk.backups.exportDB(dbCore.getGlobalDBName(), {
+    filter: (doc: any) => !doc._id.startsWith(DocumentType.USER),
   })
   // only export the dev apps as they will be the latest, the user can republish the apps
   // in their self-hosted environment
   let appMetadata = apps
-    .filter(app => isDevAppID(app.appId || app._id))
-    .map(app => ({ appId: app.appId || app._id, name: app.name }))
+    .filter((app: App) => isDevAppID(app.appId || app._id))
+    .map((app: App) => ({ appId: (app.appId || app._id)!, name: app.name }))
   const tmpPath = await sdk.backups.exportMultipleApps(
     appMetadata,
     globalDBString
@@ -56,25 +56,25 @@ exports.exportApps = async ctx => {
   ctx.body = streamFile(tmpPath)
 }
 
-async function hasBeenImported() {
+async function checkHasBeenImported() {
   if (!env.SELF_HOSTED || env.MULTI_TENANCY) {
     return true
   }
-  const apps = await getAllApps({ all: true })
+  const apps = await dbCore.getAllApps({ all: true })
   return apps.length !== 0
 }
 
-exports.hasBeenImported = async ctx => {
+export async function hasBeenImported(ctx: BBContext) {
   ctx.body = {
-    imported: await hasBeenImported(),
+    imported: await checkHasBeenImported(),
   }
 }
 
-exports.importApps = async ctx => {
+export async function importApps(ctx: BBContext) {
   if (!env.SELF_HOSTED || env.MULTI_TENANCY) {
     ctx.throw(400, "Importing only allowed in self hosted environments.")
   }
-  const beenImported = await hasBeenImported()
+  const beenImported = await checkHasBeenImported()
   if (beenImported || !ctx.request.files || !ctx.request.files.importFile) {
     ctx.throw(
       400,
@@ -90,7 +90,7 @@ exports.importApps = async ctx => {
   const globalDbImport = sdk.backups.getGlobalDBFile(tmpPath)
   const appNames = sdk.backups.getListOfAppsInMulti(tmpPath)
 
-  const globalDb = getGlobalDB()
+  const globalDb = tenancy.getGlobalDB()
   // load the global db first
   await globalDb.load(stringToReadStream(globalDbImport))
   for (let appName of appNames) {

package/src/api/controllers/component.ts

@@ -2,8 +2,9 @@ import { DocumentType } from "../../db/utils"
 import { Plugin } from "@budibase/types"
 import { db as dbCore, context, tenancy } from "@budibase/backend-core"
 import { getComponentLibraryManifest } from "../../utilities/fileSystem"
+import { BBContext } from "@budibase/types"
 
-exports.fetchAppComponentDefinitions = async function (ctx: any) {
+export async function fetchAppComponentDefinitions(ctx: BBContext) {
   try {
     const db = context.getAppDB()
     const app = await db.get(DocumentType.APP_METADATA)