@budibase/cli 2.3.19 → 2.3.21-alpha.0

package/src/analytics/{index.js → index.ts}

@@ -1,7 +1,7 @@
-const Command = require("../structures/Command")
-const { CommandWords } = require("../constants")
-const { success, error } = require("../utils")
-const AnalyticsClient = require("./Client")
+import { Command } from "../structures/Command"
+import { CommandWord } from "../constants"
+import { success, error } from "../utils"
+import { AnalyticsClient } from "./Client"
 
 const client = new AnalyticsClient()
 
@@ -14,11 +14,10 @@ async function optOut() {
         "Successfully opted out of Budibase analytics. You can opt in at any time by running 'budi analytics opt-in'"
       )
     )
-  } catch (err) {
+  } catch (err: any) {
     console.log(
       error(
-        "Error opting out of Budibase analytics. Please try again later.",
-        err
+        `Error opting out of Budibase analytics. Please try again later - ${err}`
       )
     )
   }
@@ -50,7 +49,7 @@ async function status() {
   }
 }
 
-const command = new Command(`${CommandWords.ANALYTICS}`)
+export default new Command(`${CommandWord.ANALYTICS}`)
   .addHelp("Control the analytics you send to Budibase.")
   .addSubOption("--optin", "Opt in to sending analytics to Budibase", optIn)
   .addSubOption("--optout", "Opt out of sending analytics to Budibase.", optOut)
@@ -59,5 +58,3 @@ const command = new Command(`${CommandWords.ANALYTICS}`)
     "Check whether you are currently opted in to Budibase analytics.",
     status
   )
-
-exports.command = command

package/src/backups/{index.js → index.ts}

@@ -1,28 +1,30 @@
-const Command = require("../structures/Command")
-const { CommandWords } = require("../constants")
-const fs = require("fs")
-const { join } = require("path")
-const { getAllDbs } = require("../core/db")
-const tar = require("tar")
-const { progressBar, httpCall } = require("../utils")
-const {
+import { Command } from "../structures/Command"
+import { CommandWord } from "../constants"
+import fs from "fs"
+import { join } from "path"
+import { getAllDbs } from "../core/db"
+import { progressBar, httpCall } from "../utils"
+import {
   TEMP_DIR,
   COUCH_DIR,
   MINIO_DIR,
   getConfig,
   replication,
   getPouches,
-} = require("./utils")
-const { exportObjects, importObjects } = require("./objectStore")
+} from "./utils"
+import { exportObjects, importObjects } from "./objectStore"
+const tar = require("tar")
 
-async function exportBackup(opts) {
+type BackupOpts = { env?: string; import?: string; export?: string }
+
+async function exportBackup(opts: BackupOpts) {
   const envFile = opts.env || undefined
-  let filename = opts["export"] || opts
+  let filename = opts["export"] || (opts as string)
   if (typeof filename !== "string") {
     filename = `backup-${new Date().toISOString()}.tar.gz`
   }
   const config = await getConfig(envFile)
-  const dbList = await getAllDbs(config["COUCH_DB_URL"])
+  const dbList = (await getAllDbs(config["COUCH_DB_URL"])) as string[]
   const { Remote, Local } = getPouches(config)
   if (fs.existsSync(TEMP_DIR)) {
     fs.rmSync(TEMP_DIR, { recursive: true })
@@ -55,9 +57,9 @@ async function exportBackup(opts) {
   console.log(`Generated export file - ${filename}`)
 }
 
-async function importBackup(opts) {
+async function importBackup(opts: BackupOpts) {
   const envFile = opts.env || undefined
-  const filename = opts["import"] || opts
+  const filename = opts["import"] || (opts as string)
   const config = await getConfig(envFile)
   if (!filename || !fs.existsSync(filename)) {
     console.error("Cannot import without specifying a valid file to import")
@@ -99,7 +101,7 @@ async function importBackup(opts) {
   fs.rmSync(TEMP_DIR, { recursive: true })
 }
 
-async function pickOne(opts) {
+async function pickOne(opts: BackupOpts) {
   if (opts["import"]) {
     return importBackup(opts)
   } else if (opts["export"]) {
@@ -107,7 +109,7 @@ async function pickOne(opts) {
   }
 }
 
-const command = new Command(`${CommandWords.BACKUPS}`)
+export default new Command(`${CommandWord.BACKUPS}`)
   .addHelp(
     "Allows building backups of Budibase, as well as importing a backup to a new instance."
   )
@@ -126,5 +128,3 @@ const command = new Command(`${CommandWords.BACKUPS}`)
     "Provide an environment variable file to configure the CLI.",
     pickOne
   )
-
-exports.command = command

package/src/backups/{objectStore.js → objectStore.ts}

@@ -1,8 +1,8 @@
-const { objectStore } = require("@budibase/backend-core")
-const fs = require("fs")
-const { join } = require("path")
-const { TEMP_DIR, MINIO_DIR } = require("./utils")
-const { progressBar } = require("../utils")
+import { objectStore } from "@budibase/backend-core"
+import fs from "fs"
+import { join } from "path"
+import { TEMP_DIR, MINIO_DIR } from "./utils"
+import { progressBar } from "../utils"
 const {
   ObjectStoreBuckets,
   ObjectStore,
@@ -13,10 +13,10 @@ const {
 
 const bucketList = Object.values(ObjectStoreBuckets)
 
-exports.exportObjects = async () => {
+export async function exportObjects() {
   const path = join(TEMP_DIR, MINIO_DIR)
   fs.mkdirSync(path)
-  let fullList = []
+  let fullList: any[] = []
   let errorCount = 0
   for (let bucket of bucketList) {
     const client = ObjectStore(bucket)
@@ -26,7 +26,7 @@ exports.exportObjects = async () => {
       errorCount++
       continue
     }
-    const list = await client.listObjectsV2().promise()
+    const list = (await client.listObjectsV2().promise()) as { Contents: any[] }
     fullList = fullList.concat(list.Contents.map(el => ({ ...el, bucket })))
   }
   if (errorCount === bucketList.length) {
@@ -48,7 +48,7 @@ exports.exportObjects = async () => {
   bar.stop()
 }
 
-exports.importObjects = async () => {
+export async function importObjects() {
   const path = join(TEMP_DIR, MINIO_DIR)
   const buckets = fs.readdirSync(path)
   let total = 0

package/src/backups/{utils.js → utils.ts}

@@ -1,12 +1,13 @@
-const dotenv = require("dotenv")
-const fs = require("fs")
-const { string } = require("../questions")
-const { getPouch } = require("../core/db")
-const { env: environment } = require("@budibase/backend-core")
+import dotenv from "dotenv"
+import fs from "fs"
+import { string } from "../questions"
+import { getPouch } from "../core/db"
+import { env as environment } from "@budibase/backend-core"
+import PouchDB from "pouchdb"
 
-exports.TEMP_DIR = ".temp"
-exports.COUCH_DIR = "couchdb"
-exports.MINIO_DIR = "minio"
+export const TEMP_DIR = ".temp"
+export const COUCH_DIR = "couchdb"
+export const MINIO_DIR = "minio"
 
 const REQUIRED = [
   { value: "MAIN_PORT", default: "10000" },
@@ -19,7 +20,7 @@ const REQUIRED = [
   { value: "MINIO_SECRET_KEY" },
 ]
 
-exports.checkURLs = config => {
+export function checkURLs(config: Record<string, string>) {
   const mainPort = config["MAIN_PORT"],
     username = config["COUCH_DB_USER"],
     password = config["COUCH_DB_PASSWORD"]
@@ -34,23 +35,23 @@ exports.checkURLs = config => {
   return config
 }
 
-exports.askQuestions = async () => {
+export async function askQuestions() {
   console.log(
     "*** NOTE: use a .env file to load these parameters repeatedly ***"
   )
-  let config = {}
+  let config: Record<string, string> = {}
   for (let property of REQUIRED) {
     config[property.value] = await string(property.value, property.default)
   }
   return config
 }
 
-exports.loadEnvironment = path => {
+export function loadEnvironment(path: string) {
   if (!fs.existsSync(path)) {
     throw "Unable to file specified .env file"
   }
   const env = fs.readFileSync(path, "utf8")
-  const config = exports.checkURLs(dotenv.parse(env))
+  const config = checkURLs(dotenv.parse(env))
   for (let required of REQUIRED) {
     if (!config[required.value]) {
       throw `Cannot find "${required.value}" property in .env file`
@@ -60,12 +61,12 @@ exports.loadEnvironment = path => {
 }
 
 // true is the default value passed by commander
-exports.getConfig = async (envFile = true) => {
+export async function getConfig(envFile: boolean | string = true) {
   let config
   if (envFile !== true) {
-    config = exports.loadEnvironment(envFile)
+    config = loadEnvironment(envFile as string)
   } else {
-    config = await exports.askQuestions()
+    config = await askQuestions()
   }
   // fill out environment
   for (let key of Object.keys(config)) {
@@ -74,20 +75,24 @@ exports.getConfig = async (envFile = true) => {
   return config
 }
 
-exports.replication = (from, to) => {
-  return new Promise((resolve, reject) => {
-    from.replicate
-      .to(to)
-      .on("complete", () => {
-        resolve()
-      })
-      .on("error", err => {
-        reject(err)
-      })
-  })
+export async function replication(
+  from: PouchDB.Database,
+  to: PouchDB.Database
+) {
+  const pouch = getPouch()
+  try {
+    await pouch.replicate(from, to, {
+      batch_size: 1000,
+      batches_limit: 5,
+      // @ts-ignore
+      style: "main_only",
+    })
+  } catch (err) {
+    throw new Error(`Replication failed - ${JSON.stringify(err)}`)
+  }
 }
 
-exports.getPouches = config => {
+export function getPouches(config: Record<string, string>) {
   const Remote = getPouch(config["COUCH_DB_URL"])
   const Local = getPouch()
   return { Remote, Local }

package/src/constants.ts

@@ -0,0 +1,4 @@
+export { CommandWord, InitType, AnalyticsEvent } from "@budibase/types"
+
+export const POSTHOG_TOKEN = "phc_yGOn4i7jWKaCTapdGR6lfA4AvmuEQ2ijn5zAVSFYPlS"
+export const GENERATED_USER_EMAIL = "admin@admin.com"

package/src/core/{db.js → db.ts}

@@ -1,12 +1,12 @@
-const PouchDB = require("pouchdb")
-const { checkSlashesInUrl } = require("../utils")
-const fetch = require("node-fetch")
+import PouchDB from "pouchdb"
+import { checkSlashesInUrl } from "../utils"
+import fetch from "node-fetch"
 
 /**
  * Fully qualified URL including username and password, or nothing for local
  */
-exports.getPouch = (url = undefined) => {
-  let POUCH_DB_DEFAULTS = {}
+export function getPouch(url?: string) {
+  let POUCH_DB_DEFAULTS
   if (!url) {
     POUCH_DB_DEFAULTS = {
       prefix: undefined,
@@ -19,11 +19,12 @@ exports.getPouch = (url = undefined) => {
   }
   const replicationStream = require("pouchdb-replication-stream")
   PouchDB.plugin(replicationStream.plugin)
+  // @ts-ignore
   PouchDB.adapter("writableStream", replicationStream.adapters.writableStream)
-  return PouchDB.defaults(POUCH_DB_DEFAULTS)
+  return PouchDB.defaults(POUCH_DB_DEFAULTS) as PouchDB.Static
 }
 
-exports.getAllDbs = async url => {
+export async function getAllDbs(url: string) {
   const response = await fetch(
     checkSlashesInUrl(encodeURI(`${url}/_all_dbs`)),
     {

package/src/{environment.js → environment.ts}

@@ -1,2 +1,3 @@
 process.env.NO_JS = "1"
 process.env.JS_BCRYPT = "1"
+process.env.DISABLE_JWT_WARNING = "1"

package/src/events.ts

@@ -0,0 +1,11 @@
+import { AnalyticsClient } from "./analytics/Client"
+
+const client = new AnalyticsClient()
+
+export function captureEvent(event: string, properties: any) {
+  client.capture({
+    distinctId: "cli",
+    event,
+    properties,
+  })
+}

package/src/{exec.js → exec.ts}

@@ -1,21 +1,21 @@
-const util = require("util")
-const exec = util.promisify(require("child_process").exec)
+import util from "util"
+const runCommand = util.promisify(require("child_process").exec)
 
-exports.exec = async (command, dir = "./") => {
-  const { stdout } = await exec(command, { cwd: dir })
+export async function exec(command: string, dir = "./") {
+  const { stdout } = await runCommand(command, { cwd: dir })
   return stdout
 }
 
-exports.utilityInstalled = async utilName => {
+export async function utilityInstalled(utilName: string) {
   try {
-    await exports.exec(`${utilName} --version`)
+    await exec(`${utilName} --version`)
     return true
   } catch (err) {
     return false
   }
 }
 
-exports.runPkgCommand = async (command, dir = "./") => {
+export async function runPkgCommand(command: string, dir = "./") {
   const yarn = await exports.utilityInstalled("yarn")
   const npm = await exports.utilityInstalled("npm")
   if (!yarn && !npm) {

package/src/hosting/{genUser.js → genUser.ts}

@@ -2,15 +2,16 @@ const { success } = require("../utils")
 const { updateDockerComposeService } = require("./utils")
 const randomString = require("randomstring")
 const { GENERATED_USER_EMAIL } = require("../constants")
+import { DockerCompose } from "./types"
 
-exports.generateUser = async (password, silent) => {
+export async function generateUser(password: string | null, silent: boolean) {
   const email = GENERATED_USER_EMAIL
   if (!password) {
     password = randomString.generate({ length: 6 })
   }
-  updateDockerComposeService(service => {
+  updateDockerComposeService((service: DockerCompose) => {
     service.environment["BB_ADMIN_USER_EMAIL"] = email
-    service.environment["BB_ADMIN_USER_PASSWORD"] = password
+    service.environment["BB_ADMIN_USER_PASSWORD"] = password as string
   })
   if (!silent) {
     console.log(

package/src/hosting/{index.js → index.ts}

@@ -1,14 +1,14 @@
-const Command = require("../structures/Command")
-const { CommandWords } = require("../constants")
-const { init } = require("./init")
-const { start } = require("./start")
-const { stop } = require("./stop")
-const { status } = require("./status")
-const { update } = require("./update")
-const { generateUser } = require("./genUser")
-const { watchPlugins } = require("./watch")
+import { Command } from "../structures/Command"
+import { CommandWord } from "../constants"
+import { init } from "./init"
+import { start } from "./start"
+import { stop } from "./stop"
+import { status } from "./status"
+import { update } from "./update"
+import { generateUser } from "./genUser"
+import { watchPlugins } from "./watch"
 
-const command = new Command(`${CommandWords.HOSTING}`)
+export default new Command(`${CommandWord.HOSTING}`)
   .addHelp("Controls self hosting on the Budibase platform.")
   .addSubOption(
     "--init [type]",
@@ -46,5 +46,3 @@ const command = new Command(`${CommandWords.HOSTING}`)
     generateUser
   )
   .addSubOption("--single", "Specify this with init to use the single image.")
-
-exports.command = command

package/src/hosting/{init.js → init.ts}

@@ -1,24 +1,25 @@
-const { InitTypes, AnalyticsEvents } = require("../constants")
-const { confirmation } = require("../questions")
-const { captureEvent } = require("../events")
-const makeFiles = require("./makeFiles")
-const axios = require("axios")
-const { parseEnv } = require("../utils")
-const { checkDockerConfigured, downloadFiles } = require("./utils")
-const { watchPlugins } = require("./watch")
-const { generateUser } = require("./genUser")
+import { InitType, AnalyticsEvent } from "../constants"
+import { confirmation } from "../questions"
+import { captureEvent } from "../events"
+import * as makeFiles from "./makeFiles"
+import { parseEnv } from "../utils"
+import { checkDockerConfigured, downloadDockerCompose } from "./utils"
+import { watchPlugins } from "./watch"
+import { generateUser } from "./genUser"
+import fetch from "node-fetch"
 
 const DO_USER_DATA_URL = "http://169.254.169.254/metadata/v1/user-data"
 
-async function getInitConfig(type, isQuick, port) {
-  const config = isQuick ? makeFiles.QUICK_CONFIG : {}
-  if (type === InitTypes.DIGITAL_OCEAN) {
+async function getInitConfig(type: string, isQuick: boolean, port: number) {
+  const config: any = isQuick ? makeFiles.QUICK_CONFIG : {}
+  if (type === InitType.DIGITAL_OCEAN) {
     try {
-      const output = await axios.get(DO_USER_DATA_URL)
-      const response = parseEnv(output.data)
+      const output = await fetch(DO_USER_DATA_URL)
+      const data = await output.text()
+      const response = parseEnv(data)
       for (let [key, value] of Object.entries(makeFiles.ConfigMap)) {
         if (response[key]) {
-          config[value] = response[key]
+          config[value as string] = response[key]
         }
       }
     } catch (err) {
@@ -32,7 +33,7 @@ async function getInitConfig(type, isQuick, port) {
   return config
 }
 
-exports.init = async opts => {
+export async function init(opts: any) {
   let type, isSingle, watchDir, genUser, port, silent
   if (typeof opts === "string") {
     type = opts
@@ -44,7 +45,7 @@ exports.init = async opts => {
     port = opts["port"]
     silent = opts["silent"]
   }
-  const isQuick = type === InitTypes.QUICK || type === InitTypes.DIGITAL_OCEAN
+  const isQuick = type === InitType.QUICK || type === InitType.DIGITAL_OCEAN
   await checkDockerConfigured()
   if (!isQuick) {
     const shouldContinue = await confirmation(
@@ -55,12 +56,12 @@ exports.init = async opts => {
       return
     }
   }
-  captureEvent(AnalyticsEvents.SelfHostInit, {
+  captureEvent(AnalyticsEvent.SelfHostInit, {
     type,
   })
   const config = await getInitConfig(type, isQuick, port)
   if (!isSingle) {
-    await downloadFiles()
+    await downloadDockerCompose()
     await makeFiles.makeEnv(config, silent)
   } else {
     await makeFiles.makeSingleCompose(config, silent)

package/src/hosting/{makeFiles.js → makeFiles.ts}

@@ -1,15 +1,15 @@
-const { number } = require("../questions")
-const { success, stringifyToDotEnv } = require("../utils")
-const fs = require("fs")
-const path = require("path")
+import { number } from "../questions"
+import { success, stringifyToDotEnv } from "../utils"
+import fs from "fs"
+import path from "path"
+import yaml from "yaml"
+import { getAppService } from "./utils"
 const randomString = require("randomstring")
-const yaml = require("yaml")
-const { getAppService } = require("./utils")
 
 const SINGLE_IMAGE = "budibase/budibase:latest"
 const VOL_NAME = "budibase_data"
-const COMPOSE_PATH = path.resolve("./docker-compose.yaml")
-const ENV_PATH = path.resolve("./.env")
+export const COMPOSE_PATH = path.resolve("./docker-compose.yaml")
+export const ENV_PATH = path.resolve("./.env")
 
 function getSecrets(opts = { single: false }) {
   const secrets = [
@@ -19,7 +19,7 @@ function getSecrets(opts = { single: false }) {
     "REDIS_PASSWORD",
     "INTERNAL_API_KEY",
   ]
-  const obj = {}
+  const obj: Record<string, string> = {}
   secrets.forEach(secret => (obj[secret] = randomString.generate()))
   // setup couch creds separately
   if (opts && opts.single) {
@@ -32,7 +32,7 @@ function getSecrets(opts = { single: false }) {
   return obj
 }
 
-function getSingleCompose(port) {
+function getSingleCompose(port: number) {
   const singleComposeObj = {
     version: "3",
     services: {
@@ -53,7 +53,7 @@ function getSingleCompose(port) {
   return yaml.stringify(singleComposeObj)
 }
 
-function getEnv(port) {
+function getEnv(port: number) {
   const partOne = stringifyToDotEnv({
     MAIN_PORT: port,
   })
@@ -77,19 +77,21 @@ function getEnv(port) {
   ].join("\n")
 }
 
-exports.ENV_PATH = ENV_PATH
-exports.COMPOSE_PATH = COMPOSE_PATH
-
-module.exports.ConfigMap = {
+export const ConfigMap = {
   MAIN_PORT: "port",
 }
 
-module.exports.QUICK_CONFIG = {
+export const QUICK_CONFIG = {
   key: "budibase",
   port: 10000,
 }
 
-async function make(path, contentsFn, inputs = {}, silent) {
+async function make(
+  path: string,
+  contentsFn: Function,
+  inputs: any = {},
+  silent: boolean
+) {
   const port =
     inputs.port ||
     (await number(
@@ -107,15 +109,15 @@ async function make(path, contentsFn, inputs = {}, silent) {
   }
 }
 
-module.exports.makeEnv = async (inputs = {}, silent) => {
+export async function makeEnv(inputs: any = {}, silent: boolean) {
   return make(ENV_PATH, getEnv, inputs, silent)
 }
 
-module.exports.makeSingleCompose = async (inputs = {}, silent) => {
+export async function makeSingleCompose(inputs: any = {}, silent: boolean) {
   return make(COMPOSE_PATH, getSingleCompose, inputs, silent)
 }
 
-module.exports.getEnvProperty = property => {
+export function getEnvProperty(property: string) {
   const props = fs.readFileSync(ENV_PATH, "utf8").split(property)
   if (props[0].charAt(0) === "=") {
     property = props[0]
@@ -125,7 +127,7 @@ module.exports.getEnvProperty = property => {
   return property.split("=")[1].split("\n")[0]
 }
 
-module.exports.getComposeProperty = property => {
+export function getComposeProperty(property: string) {
   const { service } = getAppService(COMPOSE_PATH)
   if (property === "port" && Array.isArray(service.ports)) {
     const port = service.ports[0]

package/src/hosting/{start.js → start.ts}

@@ -1,14 +1,10 @@
-const {
-  checkDockerConfigured,
-  checkInitComplete,
-  handleError,
-} = require("./utils")
-const { info, success } = require("../utils")
-const makeFiles = require("./makeFiles")
-const compose = require("docker-compose")
-const fs = require("fs")
+import { checkDockerConfigured, checkInitComplete, handleError } from "./utils"
+import { info, success } from "../utils"
+import * as makeFiles from "./makeFiles"
+import compose from "docker-compose"
+import fs from "fs"
 
-exports.start = async () => {
+export async function start() {
   await checkDockerConfigured()
   checkInitComplete()
   console.log(

package/src/hosting/{status.js → status.ts}

@@ -1,12 +1,8 @@
-const {
-  checkDockerConfigured,
-  checkInitComplete,
-  handleError,
-} = require("./utils")
-const { info } = require("../utils")
-const compose = require("docker-compose")
+import { checkDockerConfigured, checkInitComplete, handleError } from "./utils"
+import { info } from "../utils"
+import compose from "docker-compose"
 
-exports.status = async () => {
+export async function status() {
   await checkDockerConfigured()
   checkInitComplete()
   console.log(info("Budibase status"))

package/src/hosting/{stop.js → stop.ts}

@@ -1,12 +1,8 @@
-const {
-  checkDockerConfigured,
-  checkInitComplete,
-  handleError,
-} = require("./utils")
-const { info, success } = require("../utils")
-const compose = require("docker-compose")
+import { checkDockerConfigured, checkInitComplete, handleError } from "./utils"
+import { info, success } from "../utils"
+import compose from "docker-compose"
 
-exports.stop = async () => {
+export async function stop() {
   await checkDockerConfigured()
   checkInitComplete()
   console.log(info("Stopping services, this may take a moment."))

package/src/hosting/types.ts

@@ -0,0 +1,4 @@
+export interface DockerCompose {
+  environment: Record<string, string>
+  volumes: string[]
+}