bajo 0.3.10 → 1.0.2

package/boot/build-config.js

@@ -1,99 +0,0 @@
-/**
- * @module boot/buildConfig
- */
-
-import os from 'os'
-import fs from 'fs-extra'
-import { get, set, pick, values, keys, uniq, without, filter, map, isEmpty, trim } from 'lodash-es'
-import omitDeep from 'omit-deep'
-import resolvePath from './helper/resolve-path.js'
-import readConfig from './helper/read-config.js'
-import getKeyByValue from './helper/get-key-by-value.js'
-import envs from './helper/envs.js'
-import defaultsDeep from './helper/defaults-deep.js'
-import parseArgsArgv from './lib/parse-args-argv.js'
-import parseEnv from './lib/parse-env.js'
-import error from './helper/error.js'
-import currentLoc from './helper/current-loc.js'
-
-const configFilePick = ['log', 'plugins', 'env', 'run', 'exitHandler']
-const configFileOmit = ['tool', 'spawn', 'cwd', 'name', 'alias']
-
-const defConfig = {
-  dir: {},
-  log: {
-    dateFormat: 'YYYY-MM-DDTHH:MM:ss.SSS[Z]',
-    report: [],
-    tool: false
-  },
-  lang: Intl.DateTimeFormat().resolvedOptions().lang ?? 'en-US',
-  plugins: ['app'],
-  env: 'dev',
-  tool: false,
-  exitHandler: true
-}
-
-/**
- * Building configuration object. Read configurtion file from app data directory, program
- * arguments and envoronment variables with following priority: ```Env > Args > Config file >
- * defaults config```
- *
- * If data directory is provided and doesn't exist yet, it will be automatically created.
- *
- * Config file must be located in: ```<data dir>/config/bajo.<format>```, and support either
- * ```.json``` or ```.js``` format. JS format must be a nodejs module that wrap an async
- * function and return an object
- *
- * If app run tool, by default log is in silent. To activate, set log.tool to true
- *
- * By default, if 'app' is a bajo app, it is always the last plugins to boot. To overide this
- * behavior, you should configure it at plugin level (i.e. using .bootorder file)
- *
- * @instance
- * @async
- * @throws Will throw if data directory is not provided
- *
- * @returns {Object} config
- */
-
-async function buildConfig (cwd) {
-  const { args, argv } = await parseArgsArgv()
-  const env = parseEnv()
-  const envArgv = defaultsDeep({}, env.root, argv.root)
-  envArgv.name = 'bajo'
-  envArgv.alias = 'bajo'
-  // directories
-  set(envArgv, 'dir.base', cwd)
-  set(envArgv, 'dir.pkg', resolvePath(currentLoc(import.meta).dir + '/..'))
-  if (!get(envArgv, 'dir.data')) set(envArgv, 'dir.data', `${envArgv.dir.base}/data`)
-  envArgv.dir.data = resolvePath(envArgv.dir.data)
-  if (!envArgv.dir.tmp) {
-    envArgv.dir.tmp = resolvePath(os.tmpdir()) + '/bajo'
-    fs.ensureDirSync(envArgv.dir.tmp)
-  }
-  // config merging
-  let resp = await readConfig.call(this, `${envArgv.dir.data}/config/bajo.*`, { ignoreError: true })
-  resp = omitDeep(pick(resp, configFilePick), configFileOmit)
-  const config = defaultsDeep({}, envArgv, resp, defConfig)
-  // force init
-  config.args = args
-  config.env = config.env.toLowerCase()
-  if (values(envs).includes(config.env)) config.env = getKeyByValue(envs, config.env)
-  if (!keys(envs).includes(config.env)) config.env = 'dev'
-  process.env.NODE_ENV = envs[config.env]
-  if (!config.log.level) config.log.level = config.env === 'dev' ? 'debug' : 'info'
-  if (config.silent) config.log.level = 'silent'
-  // sanitize plugins
-  config.plugins = without(config.plugins, 'app')
-  // if (fs.existsSync(`${config.dir.base}/app/bajo`)) config.plugins.push('app')
-  config.plugins.push('app')
-  config.plugins = filter(uniq(map(config.plugins, b => trim(b))), b => !isEmpty(b))
-  if (config.tool) {
-    if (!config.plugins.includes('bajo-cli')) throw error('Sidetool needs to have \'bajo-cli\' package loaded first')
-    if (!config.log.tool) config.log.level = 'silent'
-    config.exitHandler = false
-  }
-  this.bajo.config = config
-}
-
-export default buildConfig

package/boot/create-scope.js

@@ -1,36 +0,0 @@
-/**
- * @module boot/createScope
- */
-
-import { isFunction } from 'lodash-es'
-import readJson from './helper/read-json.js'
-import importModule from './helper/import-module.js'
-
-async function defHandler (file) {
-  let mod = await importModule(file)
-  if (isFunction(mod)) mod = await mod.call(this)
-  return mod
-}
-
-const configHandlers = [
-  { ext: '.js', handler: defHandler },
-  { ext: '.mjs', handler: defHandler },
-  { ext: '.json', handler: readJson }
-]
-
-const bajo = {
-  runAt: new Date(),
-  configHandlers
-}
-
-/**
- * @instance
- * @async
- * @returns {Object} scope
- */
-
-function createScope () {
-  return { bajo }
-}
-
-export default createScope

package/boot/helper/break-ns-path.js

@@ -1,20 +0,0 @@
-import { isEmpty, find } from 'lodash-es'
-
-function breakNsPath (item = '', defaultNs = 'bajo') {
-  const { error } = this.bajo.helper
-  let [ns, ...path] = item.split(':')
-  path = path.join(':')
-  if (isEmpty(path)) {
-    path = ns
-    ns = defaultNs
-  }
-  if (ns.length === 1) return [ns, path].join(':') // windows fs
-  if (!this[ns]) {
-    const ref = find(this.bajo.pluginRefs ?? [], { alias: ns })
-    if (ref) ns = ref.plugin
-  }
-  if (!this[ns]) throw error('Unknown plugin \'%s\' or plugin isn\'t loaded yet', ns)
-  return [ns, path]
-}
-
-export default breakNsPath

package/boot/helper/build-collections.js

@@ -1,43 +0,0 @@
-import { filter, isArray, each, pullAt, camelCase, has, find, set, get, cloneDeep } from 'lodash-es'
-
-async function buildCollections (options = {}) {
-  const { getConfig, getPluginName, fatal, runHook, error, join } = this.bajo.helper
-  let { plugin, handler, dupChecks = [], container = 'connections', useDefaultName } = options
-  useDefaultName = useDefaultName ?? true
-  if (!plugin) plugin = getPluginName(4)
-  const config = getConfig()
-  const cfg = getConfig(plugin, { full: true })
-  let data = get(cfg, container)
-  if (!data) return []
-  if (!isArray(data)) data = [data]
-  await runHook(`${plugin}:${camelCase(`before build ${container}`)}`)
-  const deleted = []
-  for (const index in data) {
-    const item = data[index]
-    if (useDefaultName) {
-      if (!has(item, 'name')) {
-        if (find(data, { name: 'default' })) throw error('Collection \'default\' already exists')
-        else item.name = 'default'
-      }
-    }
-    const result = await handler.call(this, { item, index, cfg })
-    if (result) data[index] = result
-    else if (result === false) deleted.push(index)
-    if (config.tool && item.skipOnTool && !deleted.includes(index)) deleted.push(index)
-  }
-  if (deleted.length > 0) pullAt(data, deleted)
-
-  // check for duplicity
-  each(data, c => {
-    each(dupChecks, d => {
-      const checker = set({}, d, c[d])
-      const match = filter(data, checker)
-      if (match.length > 1) fatal('One or more %s shared the same \'%s\'', container, join(dupChecks))
-    })
-  })
-  await runHook(`${plugin}:${camelCase(`after build ${container}`)}`)
-  set(cfg, container, data)
-  return cloneDeep(data)
-}
-
-export default buildCollections

package/boot/helper/build-name.js

@@ -1,17 +0,0 @@
-import path from 'path'
-import { isString, isFunction, keys, camelCase, kebabCase, snakeCase } from 'lodash-es'
-import pascalCase from './pascal-case.js'
-const converter = { camelCase, kebabCase, snakeCase, pascalCase }
-
-function buildName (file, options = {}) {
-  if (isString(options)) options = { base: options }
-  if (!options.base) options.base = path.dirname(file)
-  if (!keys(converter).includes(options.converter)) options.converter = 'camelCase'
-  let name = file.replace(options.base, '')
-  name = name.slice(0, name.indexOf(path.extname(name)))
-  if (isFunction(options.converter)) name = options.converter.call(this, name)
-  else name = converter[options.converter](name)
-  return name
-}
-
-export default buildName

package/boot/helper/call-helper-or-handler.js

@@ -1,15 +0,0 @@
-import { isString, isFunction } from 'lodash-es'
-import getHelper from './get-helper.js'
-
-async function callHelperOrHandler (nameOrFn, ...args) {
-  let result
-  if (isString(nameOrFn)) {
-    const helper = getHelper.call(this, nameOrFn)
-    if (isFunction(helper)) result = await helper(...args)
-  } else if (isFunction(nameOrFn)) {
-    result = await nameOrFn.call(this, ...args)
-  }
-  return result
-}
-
-export default callHelperOrHandler

package/boot/helper/dump.js

@@ -1,14 +0,0 @@
-import util from 'util'
-import { last } from 'lodash-es'
-
-const dump = (...args) => {
-  const terminate = last(args) === true
-  if (terminate) args.pop()
-  for (const arg of args) {
-    const result = util.inspect(arg, false, null, true)
-    console.log(result)
-  }
-  if (terminate) process.kill(process.pid, 'SIGINT')
-}
-
-export default dump

package/boot/helper/each-plugins.js

@@ -1,106 +0,0 @@
-import { camelCase, isString, omit, trim } from 'lodash-es'
-import fastGlob from 'fast-glob'
-import path from 'path'
-import omittedPluginKeys from '../lib/omitted-plugin-keys.js'
-
-async function _eachPlugins (handler, { key = 'name', glob, ns, useBajo } = {}) {
-  const { getConfig } = this.bajo.helper
-  const config = getConfig()
-  const result = {}
-  const plugins = [...config.plugins]
-  if (useBajo) plugins.unshift('bajo')
-  for (const pkg of plugins) {
-    const plugin = camelCase(pkg)
-    let cfg = getConfig(plugin, { full: true })
-    const { alias, dependencies } = cfg
-    const dir = cfg.dir.pkg
-    cfg = omit(cfg, omittedPluginKeys)
-    let r
-    if (glob) {
-      const base = `${dir}/${ns}`
-      let opts = isString(glob) ? { pattern: [glob] } : glob
-      let pattern = opts.pattern ?? []
-      if (isString(pattern)) pattern = [pattern]
-      opts = omit(opts, ['pattern'])
-      for (const i in pattern) {
-        if (!path.isAbsolute(pattern[i])) pattern[i] = `${base}/${pattern[i]}`
-      }
-      const files = await fastGlob(pattern, opts)
-      for (const f of files) {
-        if (path.basename(f)[0] === '_') continue
-        const resp = await handler.call(this, { plugin, pkg, cfg, alias, file: f, dir: base, dependencies })
-        if (resp === false) break
-        else if (resp === undefined) continue
-        else {
-          result[plugin] = result[plugin] ?? {}
-          result[plugin][f] = resp
-        }
-      }
-    } else {
-      r = await handler.call(this, { plugin, pkg, cfg, dir, alias, dependencies })
-      if (r === false) break
-      else if (r === undefined) continue
-      else result[plugin] = r
-    }
-  }
-  return result
-}
-
-/**
- * @module helper/eachPlugins
- */
-
-/**
- * Callback function that will be executed while walking through all Bajos
- *
- * @callback handlerFn
- * @async
- * @param {Object} argument - Provides information about current Bajo
- * @param {string} argument.name - Bajo's name
- * @param {string} argument.pkgName - Bajo's package name
- * @param {Object} argument.cfg - Bajo's config object
- * @returns {Object|boolean|undefined}
- */
-
-/**
- * Walk through all plugins and execute the callback handler
- *
- * @instance
- * @async
- * @param {function} handlerFn - [The callback]{@link module:helper/eachPlugins~handlerFn}
- * @param {Object} [options] - Optional parameter
- * @param {string} [options.key=name] - Key of Bajo's config object that will be used as the key of returned object
- * @returns {Object} Results from callback execution through all Bajos
- *
- * @example
- * const { eachPlugins } = this.bajo.helper
- * await eachPlugins(async function ({ name }) => {
- *   console.log(name)
- * })
- */
-
-async function eachPlugins (handler, options = {}) {
-  const { getConfig, getPluginName } = this.bajo.helper
-  if (typeof options === 'string') options = { glob: options }
-  let { key = 'name', glob, ns, extend, extendHandler, useBajo } = options
-  if (!extendHandler) extendHandler = handler
-  ns = ns ?? getPluginName(4)
-  const result = await _eachPlugins.call(this, handler, { key, glob, ns, useBajo })
-  if (extend && isString(glob)) {
-    let nsExtend = ns
-    if (isString(extend)) nsExtend += '/' + trim(extend, '/')
-    const cfg = getConfig('app', { full: true })
-    const ext = `${cfg.dir.pkg}/${nsExtend}/extend/*`
-    const exts = await fastGlob(ext, { onlyDirectories: true })
-    for (const e of exts) {
-      const plugin = path.basename(e)
-      const files = await fastGlob(`${e}/${glob}`)
-      for (const file of files) {
-        await extendHandler.call(this, { file, plugin, dir: e })
-      }
-    }
-  }
-  return result // TODO: merge with extender
-}
-
-export default eachPlugins

package/boot/helper/envs.js

@@ -1,14 +0,0 @@
-/**
- * Supported environment
- *
- * @memberof module:helper
- * @type Object
- * @instance
- */
-
-const envs = {
-  dev: 'development',
-  prod: 'production'
-}
-
-export default envs

package/boot/helper/error.js

@@ -1,77 +0,0 @@
-import { last, isPlainObject, each, isArray, get, isEmpty, merge } from 'lodash-es'
-import getPluginName from './get-plugin-name.js'
-
-/**
- * It's a shortcut to create an instance of Error with message and optional parameter
- * in a single line
- *
- * @memberof helper
- * @type Object
- * @instance
- * @param {string} msg - String that will be used as error message
- * @param {options} [options] - Optional parameter
- * @param {string} [options.code] - Error code
- * @returns {error} Instance of Error
- */
-
-Error.stackTraceLimit = 15
-
-function formatErrorDetails (value, ns) {
-  const { print } = this.bajo.helper
-  const result = {}
-  each(value, (v, i) => {
-    if (!v.context) {
-      v.error = print.__(v.error, { ns })
-      return undefined
-    }
-    v.context.message = v.message
-    if (v.type === 'any.only') v.context.ref = print.__(`field.${get(v, 'context.valids.0.key')}`, { ns })
-    const field = get(v, 'context.key')
-    const val = get(v, 'context.value')
-    value[i] = {
-      field,
-      error: print.__(`validation.${v.type}`, v.context, { ns }),
-      value: val
-    }
-  })
-  return result
-}
-
-function error (msg = 'Internal server error', ...args) {
-  const { print } = this.bajo.helper
-  let payload = last(args)
-  let ns
-  if (isPlainObject(payload)) {
-    payload = args.pop()
-    ns = payload.ns
-  }
-  if (!ns) ns = getPluginName.call(this, 3)
-  const orgMsg = msg
-  args.push({ ns })
-  const message = print.__(msg, ...args)
-  let err
-  if (isPlainObject(payload) && payload.class) err = payload.class(message)
-  else err = Error(message)
-  const stacks = err.stack.split('\n')
-  stacks.splice(1, 1) // this file
-  if (stacks[1].includes('/helper/fatal.js')) stacks.splice(1, 1) // if it goes to fatal.js
-  stacks.splice(1, 1) // for buildHelper.js
-  err.stack = stacks.join('\n')
-  if (isPlainObject(payload)) {
-    delete payload.class
-    delete payload.ns
-    const values = {}
-    for (const key in payload) {
-      const value = payload[key]
-      if (key === 'details' && isArray(value) && orgMsg === 'Validation Error') {
-        const result = formatErrorDetails.call(this, value, ns)
-        if (result) merge(values, result)
-      }
-      err[key] = value
-    }
-    if (!isEmpty(values)) err.values = values
-  }
-  return err
-}
-
-export default error

package/boot/helper/fatal.js

@@ -1,13 +0,0 @@
-import getPluginName from './get-plugin-name.js'
-
-function fatal (...args) {
-  const { error } = this.bajo.helper
-  const ns = getPluginName.call(this, 3)
-  args.push({ ns })
-  const [msg, ...params] = args
-  const err = error(msg, ...params)
-  console.error(err)
-  process.kill(process.pid, 'SIGINT')
-}
-
-export default fatal

package/boot/helper/get-config.js

@@ -1,19 +0,0 @@
-import { isEmpty, isPlainObject, cloneDeep, omit, find } from 'lodash-es'
-import omittedPluginKeys from '../lib/omitted-plugin-keys.js'
-
-function getConfig (name, options = {}) {
-  const { full, clone } = options
-  if (name === 'bajo' || isEmpty(name)) return this.bajo.config
-  if (this[name] && isPlainObject(this[name].config) && this[name].config.name === name) {
-    const cfg = clone ? cloneDeep(this[name].config) : this[name].config
-    return full ? cfg : omit(cfg, omittedPluginKeys)
-  }
-  const ref = find(this.bajo.pluginRefs ?? [], { alias: name })
-  if (ref) {
-    const cfg = clone ? cloneDeep(this[ref.plugin].config) : this[ref.plugin].config
-    return full ? cfg : omit(cfg, omittedPluginKeys)
-  }
-  return {}
-}
-
-export default getConfig

package/boot/helper/get-helper.js

@@ -1,12 +0,0 @@
-import { get } from 'lodash-es'
-import error from './error.js'
-import breakNsPath from './break-ns-path.js'
-
-function getHelper (name = '', thrown = true) {
-  const [plugin, method] = breakNsPath.call(this, name)
-  const helper = get(this, `${plugin}.helper.${method}`)
-  if (helper) return helper
-  if (thrown) throw error.call(this, 'Can\'t find helper named \'%s\'', name)
-}
-
-export default getHelper

package/boot/helper/get-item-by-name.js

@@ -1,26 +0,0 @@
-import path from 'path'
-
-async function getItemByName (name) {
-  const { resolvePath, getConfig, readConfig, error } = this.bajo.helper
-  const config = getConfig()
-  const [type, ...paths] = name.split(':')
-  let result
-  switch (type) {
-    case 'config': {
-      let file = paths.join(':')
-      if (!path.isAbsolute(file)) file = resolvePath(`${config.dir.data}/config/${file}`)
-      result = await readConfig(file)
-      break
-    }
-    case 'helper': {
-      const [ns, fn] = paths.join(':').split('.')
-      if (!(ns && fn)) throw error('Unknown helper \'%s.%s\'', ns, fn, { code: 'BAJO_UNKNOWN_HELPER' })
-      result = this[ns].helper[fn]
-      break
-    }
-    default: throw error('Unsupported type \'%s\'', type, { code: 'BAJO_UNSUPPORTED_TYPE' })
-  }
-  return result
-}
-
-export default getItemByName

package/boot/helper/get-plugin-file.js

@@ -1,16 +0,0 @@
-import { get } from 'lodash-es'
-import breakNsPath from './break-ns-path.js'
-
-function getPluginFile (file) {
-  if (!get(this, 'bajo.helper')) return file
-  if (file.includes(':')) {
-    const [plugin, path] = breakNsPath.call(this, file)
-    if (plugin !== 'file' && this && this[plugin] && plugin.length > 1) {
-      const dir = get(this[plugin], 'config.dir.pkg')
-      file = `${dir}${path}`
-    }
-  }
-  return file
-}
-
-export default getPluginFile

package/boot/helper/get-plugin-name.js

@@ -1,39 +0,0 @@
-import { isString, isNumber, each, camelCase } from 'lodash-es'
-import callsites from 'callsites'
-import error from './error.js'
-import resolvePath from './resolve-path.js'
-
-/**
- * Get the right Bajo name inside your app or plugins/Bajos. If parameter ```fname```
- * is not provided, it will be set to the actual file this function is called.
- *
- * @memberof helper
- * @instance
- * @param {string} [fname] - File name (relative/absolute)
- * @throws Will throw if Bajo name coldn't be resolved
- * @returns {string} Bajo name
- */
-
-function getPluginName (fname) {
-  const config = this.bajo.config
-  let file
-  if (isString(fname)) file = fname
-  else file = callsites()[isNumber(fname) ? fname : 2].getFileName()
-  if (!file) throw error('Can\'t resolve bajo named \'%s\', sorry!', fname, { code: 'BAJO_UNABLE_TO_RESOLVE_BAJO_NAME' })
-  file = resolvePath(file)
-  let match
-  each(config.plugins, b => {
-    if (file.includes('/bajo/boot/')) {
-      match = 'bajo'
-      return false
-    }
-    if (file.includes('/' + b + '/')) {
-      match = b
-      return false
-    }
-  })
-  if (match) return camelCase(match)
-  return 'bajo'
-}
-
-export default getPluginName

package/boot/helper/get-plugin.js

@@ -1,14 +0,0 @@
-import { find } from 'lodash-es'
-
-function getPlugin (name) {
-  const { error } = this.bajo.helper
-  if (!this[name]) {
-    // alias?
-    const ref = find(this.bajo.pluginRefs ?? [], { alias: name })
-    if (!ref) throw error('\'%s\' is not loaded', name)
-    name = ref.plugin
-  }
-  return this[name]
-}
-
-export default getPlugin

package/boot/helper/join.js

@@ -1,11 +0,0 @@
-import { isPlainObject } from 'lodash-es'
-import isSet from './is-set.js'
-
-const join = (array, sep) => {
-  if (isSet(sep) && !isPlainObject(sep)) return array.join(sep)
-  const { separator = ', ', joiner = 'and' } = sep ?? {}
-  const last = (array.pop() ?? '').trim()
-  return array.map(a => (a + '').trim()).join(separator) + ` ${joiner} ${last}`
-}
-
-export default join

package/boot/helper/log-levels.js

@@ -1,19 +0,0 @@
-/**
- * Supported logger levels including its level priority
- *
- * @memberof module:helper
- * @type Object
- * @instance
- */
-
-const logLevels = {
-  trace: 10,
-  debug: 20,
-  info: 30,
-  warn: 40,
-  error: 50,
-  fatal: 60,
-  silent: 99
-}
-
-export default logLevels

package/boot/helper/read-config.js

@@ -1,48 +0,0 @@
-import path from 'path'
-import resolvePath from './resolve-path.js'
-import getPluginFile from './get-plugin-file.js'
-import readJson from './read-json.js'
-import parseObject from './parse-object.js'
-import { find, map, isEmpty } from 'lodash-es'
-import error from './error.js'
-import fg from 'fast-glob'
-
-async function readConfig (file, { pattern, globOptions = {}, ignoreError, defValue = {} } = {}) {
-  file = resolvePath(getPluginFile.call(this, file))
-  let ext = path.extname(file)
-  const fname = path.dirname(file) + '/' + path.basename(file, ext)
-  ext = ext.toLowerCase()
-  if (['.mjs', '.js'].includes(ext)) {
-    const { handler } = find(this.bajo.configHandlers, { ext })
-    return parseObject(await handler.call(this, file))
-  }
-  if (ext === '.json') return await readJson(file)
-  if (!['', '.*'].includes(ext)) {
-    const item = find(this.bajo.configHandlers, { ext })
-    if (!item) {
-      if (!ignoreError) throw error.call(this, 'Can\'t parse \'%s\'', file, { code: 'BAJO_CONFIG_NO_PARSER' })
-      return parseObject(defValue)
-    }
-    return parseObject(item.handler.call(this, file))
-  }
-  const item = pattern ?? `${fname}.{${map(map(this.bajo.configHandlers, 'ext'), k => k.slice(1)).join(',')}}`
-  const files = await fg(item, globOptions)
-  if (files.length === 0) {
-    if (!ignoreError) throw error.call(this, 'No config file found', { code: 'BAJO_CONFIG_FILE_NOT_FOUND' })
-    return parseObject(defValue)
-  }
-  let config = defValue
-  for (const f of files) {
-    const ext = path.extname(f).toLowerCase()
-    const item = find(this.bajo.configHandlers, { ext })
-    if (!item) {
-      if (!ignoreError) throw error.call(this, 'Can\'t parse \'%s\'', f, { code: 'BAJO_CONFIG_NO_PARSER' })
-      continue
-    }
-    config = await item.handler.call(this, f)
-    if (!isEmpty(config)) break
-  }
-  return parseObject(config)
-}
-
-export default readConfig