bajo 0.1.0 → 0.2.0

package/boot/helper/error.js

@@ -1,4 +1,4 @@
-import { last, isPlainObject } from 'lodash-es'
+import { last, isPlainObject, each, isArray, get } from 'lodash-es'
 import print from './print.js'
 import getPluginName from './get-plugin-name.js'
 
@@ -17,6 +17,21 @@ import getPluginName from './get-plugin-name.js'
 
 Error.stackTraceLimit = 15
 
+function formatErrorDetails (value, ns) {
+  each(value, (v, i) => {
+    if (!v.context) {
+      v.error = print._format.call(this, ns, v.error, {})
+      return undefined
+    }
+    v.context.message = v.message
+    if (v.type === 'any.only') v.context.ref = print._format.call(this, ns, `field.${get(v, 'context.valids.0.key')}`, {})
+    value[i] = {
+      field: get(v, 'context.key'),
+      error: print._format.call(this, ns, `validation.${v.type}`, v.context, {})
+    }
+  })
+}
+
 function error (msg = 'Internal server error', ...args) {
   let payload = last(args)
   let ns
@@ -25,6 +40,7 @@ function error (msg = 'Internal server error', ...args) {
     ns = payload.ns
   }
   if (!ns) ns = getPluginName.call(this, 3)
+  const orgMsg = msg
   const message = print._format.call(this, ns, msg, ...args)
   let err
   if (isPlainObject(payload) && payload.class) err = payload.class(message)
@@ -38,7 +54,11 @@ function error (msg = 'Internal server error', ...args) {
     delete payload.class
     delete payload.ns
     for (const key in payload) {
-      err[key] = payload[key]
+      const value = payload[key]
+      if (key === 'details' && isArray(value) && orgMsg === 'Validation Error') {
+        formatErrorDetails.call(this, value, ns)
+      }
+      err[key] = value
     }
   }
   return err

package/boot/helper/generate-id.js

@@ -1,7 +1,8 @@
 import { cloneDeep, isPlainObject } from 'lodash-es'
 import { customAlphabet } from 'nanoid'
 
-const generateId = ({ pattern, length = 21, returnInstance } = {}) => {
+const generateId = (options = {}) => {
+  let { pattern, length = 21, returnInstance } = options
   let opts = {}
   if (isPlainObject(pattern)) {
     opts = cloneDeep(pattern)
@@ -10,8 +11,8 @@ const generateId = ({ pattern, length = 21, returnInstance } = {}) => {
     pattern = opts.pattern
   }
   pattern = pattern ?? 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
-  if (opts.lowerCase) pattern = 'abcdefghijklmnopqrstuvwxyz0123456789'
-  else if (opts.upperCase) pattern = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
+  if (opts.lowerCase) pattern = pattern.toLowerCase()
+  else if (opts.upperCase) pattern = pattern.toUpperCase()
   const nid = customAlphabet(pattern, length)
   return returnInstance ? nid : nid()
 }

package/boot/helper/get-config.js

@@ -1,7 +1,8 @@
 import { isEmpty, isPlainObject, cloneDeep, omit, find } from 'lodash-es'
 import omittedPluginKeys from '../lib/omitted-plugin-keys.js'
 
-function getConfig (name, { full, clone } = {}) {
+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
@@ -9,7 +10,7 @@ function getConfig (name, { full, clone } = {}) {
   }
   const ref = find(this.bajo.pluginRefs ?? [], { alias: name })
   if (ref) {
-    const cfg = clone ? cloneDeep(this[ref.name].config) : this[ref.name].config
+    const cfg = clone ? cloneDeep(this[ref.plugin].config) : this[ref.plugin].config
     return full ? cfg : omit(cfg, omittedPluginKeys)
   }
   return {}

package/boot/helper/get-global-module-dir.js

@@ -10,7 +10,7 @@ const getGlobalModuleDir = (pkgName, silent = true) => {
     const npmPath = globalModulesPath.getPath('npm')
     if (!npmPath) {
       if (silent) return
-      throw error(`Can't locate npm global module directory`, { code: 'BAJO_CANT_LOCATE_NPM_GLOBAL_DIR' })
+      throw error('Can\'t locate npm global module directory', { code: 'BAJO_CANT_LOCATE_NPM_GLOBAL_DIR' })
     }
     nodeModulesDir = dropRight(resolvePath(npmPath).split('/'), 1).join('/')
     process.env.BAJO_GLOBAL_MODULE_DIR = nodeModulesDir
@@ -19,7 +19,7 @@ const getGlobalModuleDir = (pkgName, silent = true) => {
   const dir = `${nodeModulesDir}/${pkgName}`
   if (!fs.existsSync(dir)) {
     if (silent) return
-    throw error(`Can't locate '%s' global module directory`, pkgName, { code: 'BAJO_CANT_LOCATE_MODULE_GLOBAL_DIR' })
+    throw error('Can\'t locate \'%s\' global module directory', pkgName, { code: 'BAJO_CANT_LOCATE_MODULE_GLOBAL_DIR' })
   }
   return dir
 }

package/boot/helper/get-helper.js

@@ -1,8 +1,9 @@
 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] = name.split(':')
+  const [plugin, method] = breakNsPath(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)

package/boot/helper/get-plugin-data-dir.js

@@ -0,0 +1,12 @@
+import fs from 'fs-extra'
+
+function getPluginDataDir (name, ensureDir = true) {
+  const { getPlugin, getConfig } = this.bajo.helper
+  const plugin = getPlugin(name)
+  const cfg = getConfig()
+  const dir = `${cfg.dir.data}/plugins/${plugin.config.name}`
+  if (ensureDir) fs.ensureDirSync(dir)
+  return dir
+}
+
+export default getPluginDataDir

package/boot/helper/get-plugin.js

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

package/boot/helper/paginate.js

@@ -0,0 +1,26 @@
+import { isEmpty, isPlainObject, orderBy, forOwn } from 'lodash-es'
+
+function paginate (collection, { page = 1, limit = 25, sort } = {}) {
+  const count = collection.length
+  const offset = (page - 1) * limit
+  const fields = []
+  const dirs = []
+  if (isPlainObject(sort)) {
+    forOwn(sort, (v, k) => {
+      fields.push(k)
+      dirs.push(v < 0 ? 'desc' : 'asc')
+    })
+  }
+  if (!isEmpty(fields)) collection = orderBy(collection, fields, dirs)
+  const data = collection.slice(offset, offset + limit)
+
+  return {
+    data,
+    page,
+    limit,
+    count,
+    pages: Math.ceil(collection.length / limit)
+  }
+}
+
+export default paginate

package/boot/helper/print.js

@@ -1,6 +1,6 @@
 import bora from '../lib/bora.js'
 import Sprintf from 'sprintf-js'
-import { last, isPlainObject, get } from 'lodash-es'
+import { last, isPlainObject, get, merge, upperFirst } from 'lodash-es'
 import defaultsDeep from './defaults-deep.js'
 import getPluginName from './get-plugin-name.js'
 
@@ -21,7 +21,17 @@ function format (...args) {
   if (!msg) return ''
   const i18n = get(this, 'bajoI18N.instance')
   if (i18n) {
-    if (isPlainObject(params[0])) return i18n.t(msg, params[0])
+    if (isPlainObject(params[0])) {
+      const ctx = merge({}, params[0] ?? {}, { ns })
+      if (msg.startsWith('validation') && ctx.message && !i18n.exists(msg, { ns })) {
+        const message = ctx.message
+          .replace(/".*?" /, '')
+          .replace(/^is /, '')
+        return upperFirst(message)
+      }
+      if (msg === 'field.username') console.log(ctx)
+      return i18n.t(msg, ctx)
+    }
     return i18n.t(msg, { ns, pkg: opts.pkg, postProcess: 'sprintf', sprintf: params })
   }
   return sprintf(msg, ...params)

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

@@ -1,19 +1,13 @@
-import { isEmpty, trim } from 'lodash-es'
+import { trim } from 'lodash-es'
 import fs from 'fs-extra'
 
 function resolveTplPath (name, baseTpl, extTpl = '') {
-  const { error, getConfig } = this.bajo.helper
-  let [ns, path] = name.split(':')
-  if (isEmpty(path)) {
-    path = ns
-    ns = 'app'
-  }
-  if (path.startsWith('.')) throw error('Path \'%s\' must be an absolute path', path)
-  if (!this[ns]) throw error('Unknown plugin \'%s\' or plugin isn\'t loaded yet', ns)
+  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}/${baseTpl}/${trim(path, '/')}${extTpl}`
-  const override = `${cfgApp.dir}/${baseTpl}/override/${ns}/${trim(path, '/')}${extTpl}`
+  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
 }

package/boot/helper/save-as-download.js

@@ -4,10 +4,9 @@ import { trim } from 'lodash-es'
 import increment from 'add-filename-increment'
 
 async function saveAsDownload (file, obj, printSaved = true) {
-  const { print, getPluginName, resolvePath } = this.bajo.helper
-  const config = this.bajo.config
+  const { print, getPluginName, getPluginDataDir } = this.bajo.helper
   const plugin = getPluginName(4)
-  const fname = resolvePath(increment(`${config.dir.data}/plugins/${plugin}/${trim(file, '/')}`, { fs: true }))
+  const fname = increment(`${getPluginDataDir(plugin)}/${trim(file, '/')}`, { fs: true })
   const dir = path.dirname(fname)
   if (!fs.existsSync(dir)) fs.ensureDirSync(dir)
   await fs.writeFile(fname, obj, 'utf8')

package/boot/helper/titleize.js

@@ -0,0 +1,14 @@
+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

@@ -45,8 +45,7 @@ export default async function (dir, { pkg = 'bajo', exclude = [] } = {}) {
       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 (isFunction(mod.class)) mod = new mod.class(this)
-      else {
+      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)
         })

package/boot/plugins/build-config.js

@@ -2,6 +2,7 @@ import { camelCase, pick, isString, omit, pull, each } from 'lodash-es'
 import fs from 'fs-extra'
 import lockfile from 'proper-lockfile'
 import omittedPluginKeys from '../lib/omitted-plugin-keys.js'
+import titleize from '../helper/titleize.js'
 
 export async function readAllConfigs (base, name) {
   const { readConfig, getConfig } = this.bajo.helper
@@ -31,12 +32,18 @@ async function runner (pkg, { singles, argv, env }) {
   const dir = pkg === 'app' ? (config.dir.base + '/app') : getModuleDir(pkg)
   if (pkg !== 'app' && !fs.existsSync(`${dir}/bajo`)) throw error('Package \'%s\' isn\'t a valid Bajo package', pkg, { code: 'BAJO_INVALID_PACKAGE' })
   let cfg = await readAllConfigs.call(this, `${dir}/bajo/config`, name)
-  cfg.dir = dir
+  cfg.dir = {
+    pkg: dir,
+    data: `${config.dir.data}/plugins/${name}`
+  }
   const pkgJson = await readJson(`${dir + (pkg === 'app' ? '/..' : '')}/package.json`)
   cfg.pkg = pick(pkgJson,
     ['name', 'version', 'description', 'author', 'license', 'homepage'])
-  if (cfg.name === 'app') cfg.alias = 'app'
-  else if (!isString(cfg.alias)) cfg.alias = pkg.slice(0, 5) === 'bajo-' ? pkg.slice(5).toLowerCase() : pkg // fix. can't be overriden
+  if (cfg.name === 'app') {
+    cfg.alias = 'app'
+    cfg.title = 'Application'
+  } else if (!isString(cfg.alias)) cfg.alias = pkg.slice(0, 5) === 'bajo-' ? pkg.slice(5).toLowerCase() : pkg // fix. can't be overriden
+  cfg.title = cfg.title ?? titleize.call(this, cfg.alias)
   // merge with config from datadir
   try {
     const altCfg = await readConfig(`${config.dir.data}/config/${cfg.name}.*`)
@@ -50,7 +57,7 @@ async function runner (pkg, { singles, argv, env }) {
     const lockfileDir = `${config.dir.tmp}/lock`
     const lockfilePath = `${lockfileDir}/${name}.lock`
     fs.ensureDirSync(lockfileDir)
-    const file = `${cfg.dir}/package.json`
+    const file = `${dir}/package.json`
     try {
       await lockfile.lock(file, { lockfilePath })
     } catch (err) {

package/boot/plugins/collect-hooks.js

@@ -1,4 +1,4 @@
-import { map, camelCase, merge, filter, groupBy } from 'lodash-es'
+import { map, camelCase, merge, forOwn, groupBy } from 'lodash-es'
 
 async function collectHooks () {
   const { eachPlugins, log, runHook, isLogInRange, importModule } = this.bajo.helper
@@ -7,11 +7,13 @@ async function collectHooks () {
   // collects
   await eachPlugins(async function ({ plugin, dir, file }) {
     const hookName = (file.slice(dir.length + 1) ?? '').split('/')[1]
-    let [ns, path] = map(hookName.replace('.js', '').split('@'), e => camelCase(e))
+    let [ns, path] = hookName.replace('.js', '').split('@')
     if (!path) {
       path = ns
       ns = plugin
     }
+    path = camelCase(path)
+    ns = map(ns.split('.'), (n, i) => i === 1 ? n : camelCase(n)).join('.')
     const mod = await importModule(file, { asHandler: true })
     if (!mod) return undefined
     merge(mod, { ns, path })
@@ -20,13 +22,12 @@ async function collectHooks () {
   await runHook('bajo:afterCollectHooks')
   // for log trace purpose only
   if (!isLogInRange('trace')) return
-  await eachPlugins(async function ({ plugin }) {
-    const hooks = filter(this.bajo.hooks, { ns: plugin })
-    if (hooks.length === 0) return undefined
-    const items = groupBy(hooks, 'path')
-    for (const hook of hooks) {
-      log.trace('Collect hook: %s:%s (%d)', hook.ns, hook.path, items[hook.path].length)
-    }
+  const items = groupBy(this.bajo.hooks, 'ns')
+  forOwn(items, (v, k) => {
+    const hooks = groupBy(v, 'path')
+    forOwn(hooks, (v1, k1) => {
+      log.trace('Collect hook: %s:%s (%d)', k, k1, v1.length)
+    })
   })
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bajo",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A framework to build a giant monstrous app rapidly",
   "main": "boot/index.js",
   "scripts": {

package/boot/helper/index.js

@@ -1,36 +0,0 @@
-/**
- * Bajo Helper is a general-purpose container that consists of functions, objects, or arrays
- * that are accessible across all plugins/Bajos and applications. It also serves as a proxy
- * to some exported third-party libraries.
- *
- * To use it, simply deconstruct the variables you want from Bajo Helper as shown in the
- * example below.
- *
- * @module helper
- * @example
- * module.exports = async function () {
- *  const { fs, getConfig } = this.bajo.helper
- *  const config = getConfig('bajoExtra')
- *  await fs.writeFile('./bajo-extra-config.json', JSON.stringify(config), 'utf8')
- * }
- */
-
-/**
- * | Attached As | Package Name | Usage |
- * |-------------|--------------|-------|
- * | _ | [lodash](https://lodash.com/) | ```const { _ } = this.bajo.helper``` |
- * | callsites | [callsites](https://github.com/sindresorhus/callsites) | ```const { _ } = this.bajo.helper``` |
- * | dateFormat | [dateformat](https://github.com/felixge/node-dateformat) | ```const { dateFormat } = this.bajo.helper``` |
- * | fastGlob | [fast-glob](https://github.com/mrmlnc/fast-glob) | ```const { fastGlob } = this.bajo.helper``` |
- * | flatten | [flat](https://github.com/hughsk/flat) | ```const { flatten } = this.bajo.helper``` |
- * | freeze | [deep-freeze-strict](https://github.com/jsdf/deep-freeze) | ```const { freeze } = this.bajo.helper``` |
- * | fs | [fs-extra](https://github.com/jprichardson/node-fs-extra) | ```const { fs } = this.bajo.helper``` |
- * | lockfile | [proper-lockfile](https://github.com/moxystudio/node-proper-lockfile) | ```const { lockfile } = this.bajo.helper``` |
- * | outmatch | [outmatch](https://github.com/axtgr/outmatch) | ```const { outmatch } = this.bajo.helper``` |
- * | semver | [semver](https://github.com/npm/node-semver) | ```const { semver } = this.bajo.helper``` |
- * | unflatten | [flat](https://github.com/hughsk/flat) | ```const { unflatten } = this.bajo.helper``` |
- *
- * @memberof module:helper/3rdPartyLibs
- * @name 3rd Party Libraries
- * @instance
- */