@budibase/cli 2.3.20 → 2.3.21-alpha.1

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

@@ -1,20 +1,20 @@
-const {
+import {
   checkDockerConfigured,
   checkInitComplete,
-  downloadFiles,
+  downloadDockerCompose,
   handleError,
   getServices,
-} = require("./utils")
-const { confirmation } = require("../questions")
-const compose = require("docker-compose")
-const { COMPOSE_PATH } = require("./makeFiles")
-const { info, success } = require("../utils")
-const { start } = require("./start")
+} from "./utils"
+import { confirmation } from "../questions"
+import compose from "docker-compose"
+import { COMPOSE_PATH } from "./makeFiles"
+import { info, success } from "../utils"
+import { start } from "./start"
 
 const BB_COMPOSE_SERVICES = ["app-service", "worker-service", "proxy-service"]
 const BB_SINGLE_SERVICE = ["budibase"]
 
-exports.update = async () => {
+export async function update() {
   const { services } = getServices(COMPOSE_PATH)
   const isSingle = Object.keys(services).length === 1
   await checkDockerConfigured()
@@ -23,7 +23,7 @@ exports.update = async () => {
     !isSingle &&
     (await confirmation("Do you wish to update you docker-compose.yaml?"))
   ) {
-    await downloadFiles()
+    await downloadDockerCompose()
   }
   await handleError(async () => {
     const status = await compose.ps()

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

@@ -1,24 +1,24 @@
-const { lookpath } = require("lookpath")
-const fs = require("fs")
-const makeFiles = require("./makeFiles")
-const { logErrorToFile, downloadFile, error } = require("../utils")
-const yaml = require("yaml")
+import { lookpath } from "lookpath"
+import fs from "fs"
+import * as makeFiles from "./makeFiles"
+import { logErrorToFile, downloadFile, error } from "../utils"
+import yaml from "yaml"
+import { DockerCompose } from "./types"
 
 const ERROR_FILE = "docker-error.log"
-const FILE_URLS = [
-  "https://raw.githubusercontent.com/Budibase/budibase/master/hosting/docker-compose.yaml",
-]
+const COMPOSE_URL =
+  "https://raw.githubusercontent.com/Budibase/budibase/master/hosting/docker-compose.yaml"
 
-exports.downloadFiles = async () => {
-  const promises = []
-  for (let url of FILE_URLS) {
-    const fileName = url.split("/").slice(-1)[0]
-    promises.push(downloadFile(url, `./${fileName}`))
+export async function downloadDockerCompose() {
+  const fileName = COMPOSE_URL.split("/").slice(-1)[0]
+  try {
+    await downloadFile(COMPOSE_URL, `./${fileName}`)
+  } catch (err) {
+    console.error(error(`Failed to retrieve compose file - ${err}`))
   }
-  await Promise.all(promises)
 }
 
-exports.checkDockerConfigured = async () => {
+export async function checkDockerConfigured() {
   const error =
     "docker/docker-compose has not been installed, please follow instructions at: https://docs.budibase.com/docs/docker-compose"
   const docker = await lookpath("docker")
@@ -28,7 +28,7 @@ exports.checkDockerConfigured = async () => {
   }
 }
 
-exports.checkInitComplete = () => {
+export function checkInitComplete() {
   if (
     !fs.existsSync(makeFiles.ENV_PATH) &&
     !fs.existsSync(makeFiles.COMPOSE_PATH)
@@ -37,10 +37,10 @@ exports.checkInitComplete = () => {
   }
 }
 
-exports.handleError = async func => {
+export async function handleError(func: Function) {
   try {
     await func()
-  } catch (err) {
+  } catch (err: any) {
     if (err && err.err) {
       logErrorToFile(ERROR_FILE, err.err)
     }
@@ -48,14 +48,14 @@ exports.handleError = async func => {
   }
 }
 
-exports.getServices = path => {
+export function getServices(path: string) {
   const dockerYaml = fs.readFileSync(path, "utf8")
   const parsedYaml = yaml.parse(dockerYaml)
   return { yaml: parsedYaml, services: parsedYaml.services }
 }
 
-exports.getAppService = path => {
-  const { yaml, services } = exports.getServices(path),
+export function getAppService(path: string) {
+  const { yaml, services } = getServices(path),
     serviceList = Object.keys(services)
   let service
   if (services["app-service"]) {
@@ -66,14 +66,17 @@ exports.getAppService = path => {
   return { yaml, service }
 }
 
-exports.updateDockerComposeService = updateFn => {
+export function updateDockerComposeService(
+  // eslint-disable-next-line no-unused-vars
+  updateFn: (service: DockerCompose) => void
+) {
   const opts = ["docker-compose.yaml", "docker-compose.yml"]
   const dockerFilePath = opts.find(name => fs.existsSync(name))
   if (!dockerFilePath) {
     console.log(error("Unable to locate docker-compose YAML."))
     return
   }
-  const { yaml: parsedYaml, service } = exports.getAppService(dockerFilePath)
+  const { yaml: parsedYaml, service } = getAppService(dockerFilePath)
   if (!service) {
     console.log(
       error(

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

@@ -1,9 +1,10 @@
-const { resolve } = require("path")
-const fs = require("fs")
-const { error, success } = require("../utils")
-const { updateDockerComposeService } = require("./utils")
+import { resolve } from "path"
+import fs from "fs"
+import { error, success } from "../utils"
+import { updateDockerComposeService } from "./utils"
+import { DockerCompose } from "./types"
 
-exports.watchPlugins = async (pluginPath, silent) => {
+export async function watchPlugins(pluginPath: string, silent: boolean) {
   const PLUGIN_PATH = "/plugins"
   // get absolute path
   pluginPath = resolve(pluginPath)
@@ -15,7 +16,7 @@ exports.watchPlugins = async (pluginPath, silent) => {
     )
     return
   }
-  updateDockerComposeService(service => {
+  updateDockerComposeService((service: DockerCompose) => {
     // set environment variable
     service.environment["PLUGINS_DIR"] = PLUGIN_PATH
     // add volumes to parsed yaml

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

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
-require("./prebuilds")
-require("./environment")
+import "./prebuilds"
+import "./environment"
+import { getCommands } from "./options"
+import { Command } from "commander"
+import { getHelpDescription } from "./utils"
 const json = require("../package.json")
-const { getCommands } = require("./options")
-const { Command } = require("commander")
-const { getHelpDescription } = require("./utils")
 
 // add hosting config
 async function init() {

package/src/options.ts

@@ -0,0 +1,8 @@
+import analytics from "./analytics"
+import hosting from "./hosting"
+import backups from "./backups"
+import plugins from "./plugins"
+
+export function getCommands() {
+  return [hosting, analytics, backups, plugins]
+}

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

@@ -1,18 +1,22 @@
-const Command = require("../structures/Command")
-const { CommandWords, AnalyticsEvents, InitTypes } = require("../constants")
-const { getSkeleton, fleshOutSkeleton } = require("./skeleton")
-const questions = require("../questions")
-const fs = require("fs")
-const { PLUGIN_TYPE_ARR } = require("@budibase/types")
-const { plugins } = require("@budibase/backend-core")
-const { runPkgCommand } = require("../exec")
-const { join } = require("path")
-const { success, error, info, moveDirectory } = require("../utils")
-const { captureEvent } = require("../events")
+import { Command } from "../structures/Command"
+import { CommandWord, AnalyticsEvent, InitType } from "../constants"
+import { getSkeleton, fleshOutSkeleton } from "./skeleton"
+import * as questions from "../questions"
+import fs from "fs"
+import { PluginType, PLUGIN_TYPE_ARR } from "@budibase/types"
+import { plugins } from "@budibase/backend-core"
+import { runPkgCommand } from "../exec"
+import { join } from "path"
+import { success, error, info, moveDirectory } from "../utils"
+import { captureEvent } from "../events"
+import { GENERATED_USER_EMAIL } from "../constants"
+import { init as hostingInit } from "../hosting/init"
+import { start as hostingStart } from "../hosting/start"
 const fp = require("find-free-port")
-const { GENERATED_USER_EMAIL } = require("../constants")
-const { init: hostingInit } = require("../hosting/init")
-const { start: hostingStart } = require("../hosting/start")
+
+type PluginOpts = {
+  init?: PluginType
+}
 
 function checkInPlugin() {
   if (!fs.existsSync("package.json")) {
@@ -27,7 +31,7 @@ function checkInPlugin() {
   }
 }
 
-async function askAboutTopLevel(name) {
+async function askAboutTopLevel(name: string) {
   const files = fs.readdirSync(process.cwd())
   // we are in an empty git repo, don't ask
   if (files.find(file => file === ".git")) {
@@ -45,8 +49,8 @@ async function askAboutTopLevel(name) {
   }
 }
 
-async function init(opts) {
-  const type = opts["init"] || opts
+async function init(opts: PluginOpts) {
+  const type = opts["init"] || (opts as PluginType)
   if (!type || !PLUGIN_TYPE_ARR.includes(type)) {
     console.log(
       error(
@@ -82,7 +86,7 @@ async function init(opts) {
   } else {
     console.log(info(`Plugin created in directory "${name}"`))
   }
-  captureEvent(AnalyticsEvents.PluginInit, {
+  captureEvent(AnalyticsEvent.PluginInit, {
     type,
     name,
     description,
@@ -109,7 +113,7 @@ async function verify() {
     version = pkgJson.version
     plugins.validate(schemaJson)
     return { name, version }
-  } catch (err) {
+  } catch (err: any) {
     if (err && err.message && err.message.includes("not valid JSON")) {
       console.log(error(`schema.json is not valid JSON: ${err.message}`))
     } else {
@@ -120,7 +124,7 @@ async function verify() {
 
 async function build() {
   const verified = await verify()
-  if (!verified.name) {
+  if (!verified?.name) {
     return
   }
   console.log(success("Verified!"))
@@ -132,7 +136,7 @@ async function build() {
 
 async function watch() {
   const verified = await verify()
-  if (!verified.name) {
+  if (!verified?.name) {
     return
   }
   const output = join("dist", `${verified.name}-${verified.version}.tar.gz`)
@@ -150,7 +154,7 @@ async function dev() {
   const [port] = await fp(10000)
   const password = "admin"
   await hostingInit({
-    init: InitTypes.QUICK,
+    init: InitType.QUICK,
     single: true,
     watchPluginDir: pluginDir,
     genUser: password,
@@ -168,7 +172,7 @@ async function dev() {
   console.log(success("Password: ") + info(password))
 }
 
-const command = new Command(`${CommandWords.PLUGIN}`)
+export default new Command(`${CommandWord.PLUGIN}`)
   .addHelp(
     "Custom plugins for Budibase, init, build and verify your components and datasources with this tool."
   )
@@ -192,5 +196,3 @@ const command = new Command(`${CommandWords.PLUGIN}`)
     "Run a development environment which automatically watches the current directory.",
     dev
   )
-
-exports.command = command

package/src/plugins/{skeleton.js → skeleton.ts}

@@ -1,21 +1,21 @@
-const fetch = require("node-fetch")
+import fetch from "node-fetch"
+import fs from "fs"
+import os from "os"
+import { join } from "path"
+import { processStringSync } from "@budibase/string-templates"
 const download = require("download")
-const fs = require("fs")
-const os = require("os")
-const { join } = require("path")
 const tar = require("tar")
-const { processStringSync } = require("@budibase/string-templates")
 
 const HBS_FILES = ["package.json.hbs", "schema.json.hbs", "README.md.hbs"]
 
-async function getSkeletonUrl(type) {
+async function getSkeletonUrl(type: string) {
   const resp = await fetch(
     "https://api.github.com/repos/budibase/budibase-skeleton/releases/latest"
   )
   if (resp.status >= 300) {
     throw new Error("Failed to retrieve skeleton metadata")
   }
-  const json = await resp.json()
+  const json = (await resp.json()) as { assets: any[] }
   for (let asset of json["assets"]) {
     if (asset.name && asset.name.includes(type)) {
       return asset["browser_download_url"]
@@ -24,7 +24,7 @@ async function getSkeletonUrl(type) {
   throw new Error("No skeleton found in latest release.")
 }
 
-exports.getSkeleton = async (type, name) => {
+export async function getSkeleton(type: string, name: string) {
   const url = await getSkeletonUrl(type)
   const tarballFile = join(os.tmpdir(), "skeleton.tar.gz")
 
@@ -40,7 +40,12 @@ exports.getSkeleton = async (type, name) => {
   fs.rmSync(tarballFile)
 }
 
-exports.fleshOutSkeleton = async (type, name, description, version) => {
+export async function fleshOutSkeleton(
+  type: string,
+  name: string,
+  description: string,
+  version: string
+) {
   for (let file of HBS_FILES) {
     const oldFile = join(name, file),
       newFile = join(name, file.substring(0, file.length - 4))

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

@@ -1,7 +1,8 @@
-const os = require("os")
-const { join } = require("path")
-const fs = require("fs")
-const { error } = require("./utils")
+import os from "os"
+import { join } from "path"
+import fs from "fs"
+import { error } from "./utils"
+
 const PREBUILDS = "prebuilds"
 const ARCH = `${os.platform()}-${os.arch()}`
 const PREBUILD_DIR = join(process.execPath, "..", PREBUILDS, ARCH)
@@ -26,8 +27,8 @@ function checkForBinaries() {
   }
 }
 
-function cleanup(evt) {
-  if (!isNaN(evt)) {
+function cleanup(evt?: number) {
+  if (evt && !isNaN(evt)) {
     return
   }
   if (evt) {

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

@@ -1,6 +1,6 @@
 const inquirer = require("inquirer")
 
-exports.confirmation = async question => {
+export async function confirmation(question: string) {
   const config = {
     type: "confirm",
     message: question,
@@ -10,8 +10,8 @@ exports.confirmation = async question => {
   return (await inquirer.prompt(config)).confirmation
 }
 
-exports.string = async (question, defaultString = null) => {
-  const config = {
+export async function string(question: string, defaultString?: string) {
+  const config: any = {
     type: "input",
     name: "string",
     message: question,
@@ -22,12 +22,12 @@ exports.string = async (question, defaultString = null) => {
   return (await inquirer.prompt(config)).string
 }
 
-exports.number = async (question, defaultNumber) => {
-  const config = {
+export async function number(question: string, defaultNumber?: number) {
+  const config: any = {
     type: "input",
     name: "number",
     message: question,
-    validate: value => {
+    validate: (value: string) => {
       let valid = !isNaN(parseFloat(value))
       return valid || "Please enter a number"
     },

package/src/structures/{Command.js → Command.ts}

@@ -1,19 +1,31 @@
-const {
+import {
   getSubHelpDescription,
   getHelpDescription,
   error,
   capitaliseFirstLetter,
-} = require("../utils")
+} from "../utils"
 
-class Command {
-  constructor(command, func = null) {
+type CommandOpt = {
+  command: string
+  help: string
+  func?: Function
+  extras: any[]
+}
+
+export class Command {
+  command: string
+  opts: CommandOpt[]
+  func?: Function
+  help?: string
+
+  constructor(command: string, func?: Function) {
     // if there are options, need to just get the command name
     this.command = command
     this.opts = []
     this.func = func
   }
 
-  convertToCommander(lookup) {
+  convertToCommander(lookup: string) {
     const parts = lookup.toLowerCase().split("-")
     // camel case, separate out first
     const first = parts.shift()
@@ -22,21 +34,26 @@ class Command {
       .join("")
   }
 
-  addHelp(help) {
+  addHelp(help: string) {
     this.help = help
     return this
   }
 
-  addSubOption(command, help, func, extras = []) {
+  addSubOption(
+    command: string,
+    help: string,
+    func?: Function,
+    extras: any[] = []
+  ) {
     this.opts.push({ command, help, func, extras })
     return this
   }
 
-  configure(program) {
+  configure(program: any) {
     const thisCmd = this
     let command = program.command(thisCmd.command)
     if (this.help) {
-      command = command.description(getHelpDescription(thisCmd.help))
+      command = command.description(getHelpDescription(thisCmd.help!))
     }
     for (let opt of thisCmd.opts) {
       command = command.option(opt.command, getSubHelpDescription(opt.help))
@@ -45,7 +62,7 @@ class Command {
       "--help",
       getSubHelpDescription(`Get help with ${this.command} options`)
     )
-    command.action(async options => {
+    command.action(async (options: Record<string, string>) => {
       try {
         let executed = false,
           found = false
@@ -53,7 +70,7 @@ class Command {
           let lookup = opt.command.split(" ")[0].replace("--", "")
           // need to handle how commander converts watch-plugin-dir to watchPluginDir
           lookup = this.convertToCommander(lookup)
-          found = !executed && options[lookup]
+          found = !executed && !!options[lookup]
           if (found && opt.func) {
             const input =
               Object.keys(options).length > 1 ? options : options[lookup]
@@ -69,11 +86,9 @@ class Command {
           console.log(error(`Unknown ${this.command} option.`))
           command.help()
         }
-      } catch (err) {
+      } catch (err: any) {
         console.log(error(err))
       }
     })
   }
 }
-
-module.exports = Command

package/src/structures/{ConfigManager.js → ConfigManager.ts}

@@ -3,7 +3,9 @@ const path = require("path")
 const os = require("os")
 const { error } = require("../utils")
 
-class ConfigManager {
+export class ConfigManager {
+  path: string
+
   constructor() {
     this.path = path.join(os.homedir(), ".budibase.json")
     if (!fs.existsSync(this.path)) {
@@ -24,26 +26,24 @@ class ConfigManager {
     }
   }
 
-  set config(json) {
+  set config(json: any) {
     fs.writeFileSync(this.path, JSON.stringify(json))
   }
 
-  getValue(key) {
+  getValue(key: string) {
     return this.config[key]
   }
 
-  setValue(key, value) {
+  setValue(key: string, value: any) {
     this.config = {
       ...this.config,
       [key]: value,
     }
   }
 
-  removeKey(key) {
+  removeKey(key: string) {
     const updated = { ...this.config }
     delete updated[key]
     this.config = updated
   }
 }
-
-module.exports = ConfigManager

package/src/utils.ts

@@ -0,0 +1,112 @@
+import chalk from "chalk"
+import fs from "fs"
+import path from "path"
+import { join } from "path"
+import fetch from "node-fetch"
+const progress = require("cli-progress")
+
+export function downloadFile(url: string, filePath: string) {
+  return new Promise((resolve, reject) => {
+    filePath = path.resolve(filePath)
+    fetch(url, {
+      method: "GET",
+    })
+      .then(response => {
+        const writer = fs.createWriteStream(filePath)
+        if (response.body) {
+          response.body.pipe(writer)
+          response.body.on("end", resolve)
+          response.body.on("error", reject)
+        } else {
+          throw new Error(
+            `Unable to retrieve docker-compose file - ${response.status}`
+          )
+        }
+      })
+      .catch(err => {
+        throw err
+      })
+  })
+}
+
+export async function httpCall(url: string, method: string) {
+  const response = await fetch(url, {
+    method,
+  })
+  return response.body
+}
+
+export function getHelpDescription(str: string) {
+  return chalk.cyan(str)
+}
+
+export function getSubHelpDescription(str: string) {
+  return chalk.green(str)
+}
+
+export function error(err: string | number) {
+  process.exitCode = -1
+  return chalk.red(`Error - ${err}`)
+}
+
+export function success(str: string) {
+  return chalk.green(str)
+}
+
+export function info(str: string) {
+  return chalk.cyan(str)
+}
+
+export function logErrorToFile(file: string, error: string) {
+  fs.writeFileSync(path.resolve(`./${file}`), `Budibase Error\n${error}`)
+}
+
+export function parseEnv(env: string) {
+  const lines = env.toString().split("\n")
+  let result: Record<string, string> = {}
+  for (const line of lines) {
+    const match = line.match(/^([^=:#]+?)[=:](.*)/)
+    if (match) {
+      result[match[1].trim()] = match[2].trim()
+    }
+  }
+  return result
+}
+
+export function progressBar(total: number) {
+  const bar = new progress.SingleBar({}, progress.Presets.shades_classic)
+  bar.start(total, 0)
+  return bar
+}
+
+export function checkSlashesInUrl(url: string) {
+  return url.replace(/(https?:\/\/)|(\/)+/g, "$1$2")
+}
+
+export function moveDirectory(oldPath: string, newPath: string) {
+  const files = fs.readdirSync(oldPath)
+  // check any file exists already
+  for (let file of files) {
+    if (fs.existsSync(join(newPath, file))) {
+      throw new Error(
+        "Unable to remove top level directory - some skeleton files already exist."
+      )
+    }
+  }
+  for (let file of files) {
+    fs.renameSync(join(oldPath, file), join(newPath, file))
+  }
+  fs.rmdirSync(oldPath)
+}
+
+export function capitaliseFirstLetter(str: string) {
+  return str.charAt(0).toUpperCase() + str.slice(1)
+}
+
+export function stringifyToDotEnv(json: Record<string, string | number>) {
+  let str = ""
+  for (let [key, value] of Object.entries(json)) {
+    str += `${key}=${value}\n`
+  }
+  return str
+}

package/start.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+dir="$(dirname -- "$(readlink -f "${BASH_SOURCE}")")"
+${dir}/node_modules/ts-node/dist/bin.js ${dir}/src/index.ts $@