@budibase/cli 1.3.14 → 1.3.15-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@budibase/cli",
-  "version": "1.3.14",
+  "version": "1.3.15-alpha.0",
   "description": "Budibase CLI, for developers, self hosting and migrations.",
   "main": "src/index.js",
   "bin": {
@@ -26,14 +26,18 @@
     "outputPath": "build"
   },
   "dependencies": {
-    "@budibase/backend-core": "^1.3.14",
+    "@budibase/backend-core": "1.3.15-alpha.0",
+    "@budibase/string-templates": "1.3.15-alpha.0",
+    "@budibase/types": "1.3.15-alpha.0",
     "axios": "0.21.2",
     "chalk": "4.1.0",
     "cli-progress": "3.11.2",
     "commander": "7.1.0",
     "docker-compose": "0.23.6",
     "dotenv": "16.0.1",
+    "download": "8.0.0",
     "inquirer": "8.0.0",
+    "joi": "17.6.0",
     "lookpath": "1.1.0",
     "node-fetch": "2",
     "pkg": "5.7.0",
@@ -48,5 +52,5 @@
     "eslint": "^7.20.0",
     "renamer": "^4.0.0"
   },
-  "gitHead": "a38626cf662d66aa8c04fb1d42dc7bc353ce7c31"
+  "gitHead": "38f3c6d1d713f5e1bd18fdd81bdffb9bf7d4f9d3"
 }

package/src/constants.js

@@ -3,6 +3,7 @@ exports.CommandWords = {
   HOSTING: "hosting",
   ANALYTICS: "analytics",
   HELP: "help",
+  PLUGIN: "plugins",
 }
 
 exports.InitTypes = {

package/src/environment.js

@@ -0,0 +1 @@
+process.env.NO_JS = "1"

package/src/exec.js

@@ -0,0 +1,27 @@
+const util = require("util")
+const exec = util.promisify(require("child_process").exec)
+
+exports.exec = async (command, dir = "./") => {
+  const { stdout } = await exec(command, { cwd: dir })
+  return stdout
+}
+
+exports.utilityInstalled = async utilName => {
+  try {
+    await exports.exec(`${utilName} --version`)
+    return true
+  } catch (err) {
+    return false
+  }
+}
+
+exports.runPkgCommand = async (command, dir = "./") => {
+  const yarn = await exports.utilityInstalled("yarn")
+  const npm = await exports.utilityInstalled("npm")
+  if (!yarn && !npm) {
+    throw new Error("Must have yarn or npm installed to run build.")
+  }
+  const npmCmd = command === "install" ? `npm ${command}` : `npm run ${command}`
+  const cmd = yarn ? `yarn ${command}` : npmCmd
+  await exports.exec(cmd, dir)
+}

package/src/index.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 require("./prebuilds")
+require("./environment")
 const { getCommands } = require("./options")
 const { Command } = require("commander")
 const { getHelpDescription } = require("./utils")

package/src/options.js

@@ -1,7 +1,8 @@
 const analytics = require("./analytics")
 const hosting = require("./hosting")
 const backups = require("./backups")
+const plugins = require("./plugins")
 
 exports.getCommands = () => {
-  return [hosting.command, analytics.command, backups.command]
+  return [hosting.command, analytics.command, backups.command, plugins.command]
 }

package/src/plugins/constants.js

@@ -0,0 +1,6 @@
+exports.PluginTypes = {
+  COMPONENT: "component",
+  DATASOURCE: "datasource",
+}
+
+exports.PLUGIN_TYPES_ARR = Object.values(exports.PluginTypes)

package/src/plugins/index.js

@@ -0,0 +1,132 @@
+const Command = require("../structures/Command")
+const { CommandWords } = require("../constants")
+const { getSkeleton, fleshOutSkeleton } = require("./skeleton")
+const questions = require("../questions")
+const fs = require("fs")
+const { PLUGIN_TYPES_ARR } = require("./constants")
+const { validate } = require("./validate")
+const { runPkgCommand } = require("../exec")
+const { join } = require("path")
+const { success, error, info } = require("../utils")
+
+function checkInPlugin() {
+  if (!fs.existsSync("package.json")) {
+    throw new Error(
+      "Please run in a plugin directory - must contain package.json"
+    )
+  }
+  if (!fs.existsSync("schema.json")) {
+    throw new Error(
+      "Please run in a plugin directory - must contain schema.json"
+    )
+  }
+}
+
+async function init(opts) {
+  const type = opts["init"] || opts
+  if (!type || !PLUGIN_TYPES_ARR.includes(type)) {
+    console.log(
+      error(
+        "Please provide a type to init, either 'component' or 'datasource'."
+      )
+    )
+    return
+  }
+  console.log(info("Lets get some details about your new plugin:"))
+  const name = await questions.string("Name", `budibase-${type}`)
+  if (fs.existsSync(name)) {
+    console.log(
+      error("Directory by plugin name already exists, pick a new name.")
+    )
+    return
+  }
+  const desc = await questions.string(
+    "Description",
+    `An amazing Budibase ${type}!`
+  )
+  const version = await questions.string("Version", "1.0.0")
+  // get the skeleton
+  console.log(info("Retrieving project..."))
+  await getSkeleton(type, name)
+  await fleshOutSkeleton(type, name, desc, version)
+  console.log(info("Installing dependencies..."))
+  await runPkgCommand("install", join(process.cwd(), name))
+  console.log(info(`Plugin created in directory "${name}"`))
+}
+
+async function verify() {
+  // will throw errors if not acceptable
+  checkInPlugin()
+  console.log(info("Verifying plugin..."))
+  const schema = fs.readFileSync("schema.json", "utf8")
+  const pkg = fs.readFileSync("package.json", "utf8")
+  let name, version
+  try {
+    const schemaJson = JSON.parse(schema)
+    const pkgJson = JSON.parse(pkg)
+    if (!pkgJson.name || !pkgJson.version || !pkgJson.description) {
+      throw new Error(
+        "package.json is missing one of 'name', 'version' or 'description'."
+      )
+    }
+    name = pkgJson.name
+    version = pkgJson.version
+    validate(schemaJson)
+    return { name, version }
+  } catch (err) {
+    if (err && err.message && err.message.includes("not valid JSON")) {
+      console.log(error(`schema.json is not valid JSON: ${err.message}`))
+    } else {
+      console.log(error(`Invalid schema/package.json: ${err.message}`))
+    }
+  }
+}
+
+async function build() {
+  const verified = await verify()
+  if (!verified.name) {
+    return
+  }
+  console.log(success("Verified!"))
+  console.log(info("Building plugin..."))
+  await runPkgCommand("build")
+  const output = join("dist", `${verified.name}-${verified.version}.tar.gz`)
+  console.log(success(`Build complete - output in: ${output}`))
+}
+
+async function watch() {
+  const verified = await verify()
+  if (!verified.name) {
+    return
+  }
+  const output = join("dist", `${verified.name}-${verified.version}.tar.gz`)
+  console.log(info(`Watching - build in: ${output}`))
+  try {
+    await runPkgCommand("watch")
+  } catch (err) {
+    // always errors when user escapes
+    console.log(success("Watch exited."))
+  }
+}
+
+const command = new Command(`${CommandWords.PLUGIN}`)
+  .addHelp(
+    "Custom plugins for Budibase, init, build and verify your components and datasources with this tool."
+  )
+  .addSubOption(
+    "--init [type]",
+    "Init a new plugin project, with a type of either component or datasource.",
+    init
+  )
+  .addSubOption(
+    "--build",
+    "Build your plugin, this will verify and produce a final tarball for your project.",
+    build
+  )
+  .addSubOption(
+    "--watch",
+    "Automatically build any changes to your plugin.",
+    watch
+  )
+
+exports.command = command

package/src/plugins/skeleton.js

@@ -0,0 +1,60 @@
+const fetch = require("node-fetch")
+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) {
+  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()
+  for (let asset of json["assets"]) {
+    if (asset.name && asset.name.includes(type)) {
+      return asset["browser_download_url"]
+    }
+  }
+  throw new Error("No skeleton found in latest release.")
+}
+
+exports.getSkeleton = async (type, name) => {
+  const url = await getSkeletonUrl(type)
+  const tarballFile = join(os.tmpdir(), "skeleton.tar.gz")
+
+  // download the full skeleton tarball
+  fs.writeFileSync(tarballFile, await download(url))
+  fs.mkdirSync(name)
+  // extract it and get what we need
+  await tar.extract({
+    file: tarballFile,
+    C: name,
+  })
+  // clear up
+  fs.rmSync(tarballFile)
+}
+
+exports.fleshOutSkeleton = async (type, name, description, version) => {
+  for (let file of HBS_FILES) {
+    const oldFile = join(name, file),
+      newFile = join(name, file.substring(0, file.length - 4))
+    const hbsContents = fs.readFileSync(oldFile, "utf8")
+    if (!hbsContents) {
+      continue
+    }
+    const output = processStringSync(hbsContents, {
+      name,
+      description,
+      version,
+    })
+    // write the updated file and remove the HBS file
+    fs.writeFileSync(newFile, output)
+    fs.rmSync(oldFile)
+  }
+}

package/src/plugins/validate.js

@@ -0,0 +1,91 @@
+const { PluginTypes } = require("./constants")
+const { DatasourceFieldType, QueryType } = require("@budibase/types")
+const joi = require("joi")
+
+const DATASOURCE_TYPES = [
+  "Relational",
+  "Non-relational",
+  "Spreadsheet",
+  "Object store",
+  "Graph",
+  "API",
+]
+
+function runJoi(validator, schema) {
+  const { error } = validator.validate(schema)
+  if (error) {
+    throw error
+  }
+}
+
+function validateComponent(schema) {
+  const validator = joi.object({
+    type: joi.string().allow("component").required(),
+    metadata: joi.object().unknown(true).required(),
+    hash: joi.string().optional(),
+    version: joi.string().optional(),
+    schema: joi
+      .object({
+        name: joi.string().required(),
+        settings: joi.array().items(joi.object().unknown(true)).required(),
+      })
+      .unknown(true),
+  })
+  runJoi(validator, schema)
+}
+
+function validateDatasource(schema) {
+  const fieldValidator = joi.object({
+    type: joi
+      .string()
+      .allow(...Object.values(DatasourceFieldType))
+      .required(),
+    required: joi.boolean().required(),
+    default: joi.any(),
+    display: joi.string(),
+  })
+
+  const queryValidator = joi
+    .object({
+      type: joi.string().allow(...Object.values(QueryType)),
+      fields: joi.object().pattern(joi.string(), fieldValidator),
+    })
+    .required()
+
+  const validator = joi.object({
+    type: joi.string().allow("datasource").required(),
+    metadata: joi.object().unknown(true).required(),
+    hash: joi.string().optional(),
+    version: joi.string().optional(),
+    schema: joi.object({
+      docs: joi.string(),
+      friendlyName: joi.string().required(),
+      type: joi.string().allow(...DATASOURCE_TYPES),
+      description: joi.string().required(),
+      datasource: joi.object().pattern(joi.string(), fieldValidator).required(),
+      query: joi
+        .object({
+          create: queryValidator,
+          read: queryValidator,
+          update: queryValidator,
+          delete: queryValidator,
+        })
+        .unknown(true)
+        .required(),
+    }),
+  })
+  runJoi(validator, schema)
+}
+
+exports.validate = schema => {
+  switch (schema.type) {
+    case PluginTypes.COMPONENT:
+      validateComponent(schema)
+      break
+    case PluginTypes.DATASOURCE:
+      validateDatasource(schema)
+      break
+    default:
+      throw new Error(`Unknown plugin type - check schema.json: ${schema.type}`)
+  }
+}

package/src/prebuilds.js

@@ -1,11 +1,15 @@
 const os = require("os")
 const { join } = require("path")
 const fs = require("fs")
+const { error } = require("./utils")
 const PREBUILDS = "prebuilds"
 const ARCH = `${os.platform()}-${os.arch()}`
 const PREBUILD_DIR = join(process.execPath, "..", PREBUILDS, ARCH)
 
-checkForBinaries()
+// running as built CLI pkg bundle
+if (!process.argv[0].includes("node")) {
+  checkForBinaries()
+}
 
 function checkForBinaries() {
   const readDir = join(__filename, "..", "..", PREBUILDS, ARCH)
@@ -22,7 +26,15 @@ function checkForBinaries() {
   }
 }
 
-function cleanup() {
+function cleanup(evt) {
+  if (evt && evt.errno) {
+    console.error(
+      error(
+        "Failed to run CLI command - please report with the following message:"
+      )
+    )
+    console.error(error(evt))
+  }
   if (fs.existsSync(PREBUILD_DIR)) {
     fs.rmSync(PREBUILD_DIR, { recursive: true })
   }