bajo 0.3.10 → 1.0.1

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

package/boot/helper/resolve-tpl-path.js

@@ -1,15 +0,0 @@
-import { trim } from 'lodash-es'
-import fs from 'fs-extra'
-
-function resolveTplPath (name, baseTpl, extTpl = '') {
-  const { getConfig, breakNsPath } = this.bajo.helper
-  const [ns, path] = breakNsPath(name)
-  const cfgNs = getConfig(ns, { full: true })
-  const cfgApp = getConfig('app', { full: true })
-  let file = `${cfgNs.dir.pkg}/${baseTpl}/${trim(path, '/')}${extTpl}`
-  const override = `${cfgApp.dir.pkg}/${baseTpl}/override/${ns}/${trim(path, '/')}${extTpl}`
-  if (fs.existsSync(override)) file = override
-  return file
-}
-
-export default resolveTplPath

package/boot/helper/run-hook.js

@@ -1,49 +0,0 @@
-import { filter, isEmpty, orderBy, pullAt } from 'lodash-es'
-
-/**
- * @module helper/runHook
- */
-
-/**
- * Set hook defined by parameter ```hookName```. Hook name should be in this following format:
- * ```<namespace>:<identifier>``` - where namespace is a valid Bajo name and
- * identifier is a unique string set by Bajo developer to identify a hook inside a Bajo
- *
- * @instance
- * @async
- * @param {string} hookName - Hook's name
- *
- * @example
- * const { runHook } = this.bajo.helper
- * await runHook('myBajo:afterStartApp')
- */
-
-async function runHook (hookName, ...args) {
-  // const { log } = this.bajo.helper
-  // log.trace('Run hook: %s', hookName)
-  const [ns, path] = (hookName ?? '').split(':')
-  let fns = filter(this.bajo.hooks, { ns, path })
-  if (isEmpty(fns)) return
-  fns = orderBy(fns, ['level'])
-  const results = []
-  const removed = []
-  for (const i in fns) {
-    const fn = fns[i]
-    /*
-    if (config.log.report.includes(id)) {
-      log.trace({ args }, 'Call hook: %s', id)
-    }
-    */
-    const res = await fn.handler.call(this, ...args)
-    results.push({
-      hook: hookName,
-      resp: res
-    })
-    if (path.startsWith('once')) removed.push(i)
-  }
-  if (removed.length > 0) pullAt(this.bajo.hooks, removed)
-
-  return results
-}
-
-export default runHook

package/boot/helper/spinner.js

@@ -1,9 +0,0 @@
-import { Print } from '../lib/print.js'
-
-function spinner (options) {
-  const print = new Print(options)
-  print.setScope(this)
-  return print
-}
-
-export default spinner

package/boot/helper/start-plugin.js

@@ -1,7 +0,0 @@
-async function startPlugin (name, ...args) {
-  const { importModule } = this.bajo.helper
-  const start = await importModule(`${name}:/bajo/start.js`)
-  await start.call(this, ...args)
-}
-
-export default startPlugin

package/boot/helper/titleize.js

@@ -1,14 +0,0 @@
-import { words, upperFirst, map, isFunction, concat, uniq } from 'lodash-es'
-
-const defIgnores = ['or', 'and', 'of', 'with']
-
-function titleize (text, { transformer, ignores = [] } = {}) {
-  return map(words(text), t => {
-    if (isFunction(transformer)) return transformer.call(this, t)
-    ignores = uniq(concat(ignores, defIgnores))
-    if (ignores.includes(t)) return t
-    return upperFirst(t)
-  }).join(' ')
-}
-
-export default titleize

package/boot/lib/build-helper.js

@@ -1,60 +0,0 @@
-import fastGlob from 'fast-glob'
-import path from 'path'
-import { camelCase, isFunction, isPlainObject, forOwn } from 'lodash-es'
-import resolvePath from '../helper/resolve-path.js'
-import importModule from '../helper/import-module.js'
-import readJson from '../helper/read-json.js'
-
-function stackInfo (name, ...args) {
-  const { log, callsites } = this.bajo.helper
-  const config = this.bajo.config
-  if (config.env === 'prod') return
-  if (!config.log.report.includes(`helper:${name}`)) return
-  const info = callsites()[2]
-  const file = info.getFileName()
-  const line = info.getLineNumber()
-  log.trace({ line, file, args }, 'Call helper: %s()', name)
-}
-
-const wrapFn = function (name, handler, bind) {
-  return (...args) => {
-    stackInfo.call(this, name, ...args)
-    if (bind) return handler.call(this, ...args)
-    return handler(...args)
-  }
-}
-
-const wrapAsyncFn = function (name, handler, bind) {
-  return async (...args) => {
-    stackInfo.call(this, name, ...args)
-    if (bind) return await handler.call(this, ...args)
-    return await handler(...args)
-  }
-}
-
-export default async function (dir, pkg = 'bajo') {
-  dir = resolvePath(dir)
-  const files = await fastGlob([`!${dir}/**/_*.{js,json}`, `${dir}/**/*.{js,json}`])
-  const helper = {}
-  for (const f of files) {
-    const ext = path.extname(f)
-    const base = f.replace(dir, '').replace(ext, '')
-    const name = camelCase(base)
-    const fnName = pkg + '.' + name
-    let mod
-    if (ext === '.json') mod = readJson(f)
-    else mod = await importModule(f)
-    if (isFunction(mod)) {
-      if (mod.constructor.name === 'AsyncFunction') mod = wrapAsyncFn.call(this, fnName, mod, true)
-      else mod = wrapFn.call(this, fnName, mod, true)
-    } else if (isPlainObject(mod)) {
-      if (!mod.exec) { // mod.exec offer unbind, nacked function people can band to anything else later
-        forOwn(mod, (v, k) => {
-          if (isFunction(v)) mod[k] = v.bind(this)
-        })
-      }
-    }
-    helper[name] = mod
-  }
-  return helper
-}

package/boot/lib/logger.js

@@ -1,76 +0,0 @@
-import os from 'os'
-import { isEmpty, without, merge, upperFirst, isPlainObject } from 'lodash-es'
-// import pretty from 'prettyjson'
-import getPluginName from '../helper/get-plugin-name.js'
-import levels from '../helper/log-levels.js'
-import isLogInRange from '../helper/is-log-in-range.js'
-import dayjs from 'dayjs'
-
-/*
-const prettyOpts = {
-  noAlign: true,
-  defaultIndentation: 2,
-  renderUndefined: true
-}
-*/
-
-class Log {
-  constructor (scope) {
-    this.scope = scope
-    this.config = scope.bajo.config
-    this.bajoLog = this.config.log.logger ?? 'bajoLogger'
-    this.format = 'YYYY-MM-DDTHH:mm:ss.SSS[Z]'
-  }
-
-  isExtLogger () {
-    return this.scope[this.bajoLog] && this.scope[this.bajoLog].logger
-  }
-
-  child () {
-    if (this.isExtLogger()) return this.scope[this.bajoLog].logger.child()
-    return this.scope
-  }
-
-  formatMsg (level, params) {
-    const { print } = this.scope.bajo.helper
-    let opts = {}
-    if (isPlainObject(params.slice(-1)[0])) opts = params.pop()
-    if (this.config.log.level === 'silent') return
-    if (!isLogInRange.call(this.scope, level)) return
-    let [data, msg, ...args] = params
-    if (typeof data === 'string') {
-      args.unshift(msg)
-      msg = data
-      data = null
-    }
-    args = without(args, undefined)
-    const pkg = opts.pkg ?? getPluginName.call(this.scope, 3)
-    msg = print.__(`[%s] ${msg}`, pkg, ...args)
-    if (this.scope[this.bajoLog] && this.scope[this.bajoLog].logger) {
-      this.scope[this.bajoLog].logger[level](data, msg, ...args)
-    } else {
-      let text
-      const dt = new Date()
-      if (this.config.env === 'prod') {
-        const json = { level: levels[level], time: dt.valueOf(), pid: process.pid, hostname: os.hostname() }
-        if (!isEmpty(data)) merge(json, data)
-        merge(json, { msg })
-        text = JSON.stringify(json)
-      } else {
-        text = `[${dayjs(dt).utc(true).format(this.format)}] ${upperFirst(level)}: ${msg}`
-        if (!isEmpty(data)) text += '\n' + JSON.stringify(data)
-      }
-      console.log(text)
-    }
-  }
-}
-
-Object.keys(levels).forEach(level => {
-  Log.prototype[level] = function (...params) {
-    this.formatMsg(level, params)
-  }
-})
-
-export default function logger () {
-  return new Log(this)
-}