bajo 2.0.2 → 2.2.0

package/class/bajo.js

@@ -3,21 +3,16 @@ import increment from 'add-filename-increment'
 import fs from 'fs-extra'
 import path from 'path'
 import os from 'os'
-import ms from 'ms'
-import dotenvParseVariables from 'dotenv-parse-variables'
 import emptyDir from 'empty-dir'
 import lodash from 'lodash'
-import currentLoc from '../lib/current-loc.js'
 import { createRequire } from 'module'
 import getGlobalPath from 'get-global-path'
-import { customAlphabet } from 'nanoid'
 import fastGlob from 'fast-glob'
 import querystring from 'querystring'
-import deepFreeze from 'deep-freeze-strict'
-import resolvePath from '../lib/resolve-path.js'
 import importModule from '../lib/import-module.js'
 import logLevels from '../lib/log-levels.js'
 import { types as formatTypes, formats } from '../lib/formats.js'
+import aneka from 'aneka'
 import {
   buildBaseConfig,
   buildExtConfig,
@@ -32,11 +27,13 @@ const require = createRequire(import.meta.url)
 
 const {
   isFunction, map, isObject,
-  trim, filter, isEmpty, orderBy, pullAt, find, camelCase, isNumber,
-  cloneDeep, isPlainObject, isArray, isString, set, omit, keys, indexOf,
+  trim, filter, isEmpty, orderBy, pullAt, find, camelCase,
+  cloneDeep, isPlainObject, isArray, isString, omit, keys, indexOf,
   last, get, has, values, dropRight, pick
 } = lodash
 
+const { resolvePath, currentLoc } = aneka
+
 /**
  * The Core. The main engine. The one and only plugin that control app's boot process and
  * making sure all other plugins working nicely.
@@ -44,12 +41,12 @@ const {
  * @class
  */
 class Bajo extends Plugin {
-  static alias = 'bajo'
   /**
    * @param {App} app - App instance. Usefull to call app method inside a plugin
    */
   constructor (app) {
     super('bajo', app)
+    this.alias = 'bajo'
     this.whiteSpace = [' ', '\t', '\n', '\r']
     /**
      * Config object
@@ -93,37 +90,9 @@ class Bajo extends Plugin {
     await bootOrder.call(this)
     await bootPlugins.call(this)
     await exitHandler.call(this)
-  }
-
-  /**
-   * Resolve file name to filesystem's path. Windows path separator ```\```
-   * is normalized to Unix's ```/```
-   *
-   * @method
-   * @param {string} file - File to resolve
-   * @param {boolean} [asFileUrl=false] - Return as file URL format ```file:///<name>```
-   * @returns {string}
-   */
-  resolvePath = (file, asFileUrl) => {
-    return resolvePath(file, asFileUrl)
-  }
-
-  /**
-   * Freeze object
-   *
-   * @method
-   * @param {Object} obj - Object to freeze
-   * @param {boolean} [shallow=false] - If ```false``` (default), deep freeze object
-   */
-  freeze = (obj, shallow = false) => {
-    if (shallow) Object.freeze(obj)
-    else deepFreeze(obj)
-  }
-
-  setImmediate = async () => {
-    return new Promise((resolve) => {
-      setImmediate(() => resolve())
-    })
+    if (this.app.bajoSpatial) {
+      this.anekaSpatial = await this.importPkg('bajoSpatial:aneka-spatial')
+    }
   }
 
   breakNsPathFromFile = ({ file, dir, baseNs, suffix = '', getType } = {}) => {
@@ -376,10 +345,9 @@ class Bajo extends Plugin {
    */
   eachPlugins = async (handler, options = {}) => {
     if (typeof options === 'string') options = { glob: options }
-    const result = {}
-    const pluginPkgs = cloneDeep(this.app.pluginPkgs) ?? []
     const { glob, useBajo, prefix = '', noUnderscore = true, returnItems } = options
-    if (useBajo) pluginPkgs.unshift('bajo')
+    const pluginPkgs = useBajo ? [...cloneDeep(this.app.pluginPkgs), 'bajo'] : this.app.pluginPkgs
+    const result = {}
     for (const pkgName of pluginPkgs) {
       const ns = camelCase(pkgName)
       let r
@@ -498,8 +466,8 @@ class Bajo extends Plugin {
     if (type === 'auto') {
       if (value instanceof Date) type = 'datetime'
     }
-    if (['float', 'double'].includes(type) && this.app.bajoSpatial) {
-      const { latToDms, lngToDms } = this.app.lib.anekaSpatial
+    if (['float', 'double'].includes(type) && this.anekaSpatial) {
+      const { latToDms, lngToDms } = this.anekaSpatial
       if (options.latitude) return latToDms(value)
       if (options.longitude) return lngToDms(value)
     }
@@ -534,35 +502,12 @@ class Bajo extends Plugin {
   }
 
   /**
-   * Generate unique random characters that can be used as ID. Use {@link https://github.com/ai/nanoid|nanoid} under the hood
+   * Format text according using sprintf with extra ability to run its arguments through a serie of modifiers
    *
-   * @method
-   * @param {(boolean|string|Object)} [options={}] - Options. If set to ```true``` or ```alpha```, it will generate alphaphet only characters. If set to ```int```, it will generate integer only characters. Otherwise:
-   * @param {string} [options.pattern] - Character pattern to use. Defaults to all available alphanumeric characters
-   * @param {number} [options.length=13] - Length of resulted characters
-   * @param {string} [options.case] - If set to ```lower``` to use lower cased pattern only. For upper cased pattern, set it to ```upper```
-   * @param {boolean} [options.returnInstance] - Set to ```true``` to return {@link https://github.com/ai/nanoid|nanoid} instance instead of string
-   * @returns {(string|Object)} Return string or instance of {@link https://github.com/ai/nanoid|nanoid}
+   * @param {string} text - Text to be formatted
+   * @param  {...any} args - Argumennts
+   * @returns {string} Formatted text
    */
-  generateId = (options = {}) => {
-    let type
-    if (options === true) options = 'alpha'
-    if (options === 'int') {
-      type = options
-      options = { pattern: '0123456789', length: 15 }
-    } else if (options === 'alpha') {
-      type = options
-      options = { pattern: 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ', length: 15 }
-    }
-    let { pattern, length = 13, returnInstance } = options
-    pattern = pattern ?? 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
-    if (options.case === 'lower') pattern = pattern.toLowerCase()
-    else if (options.case === 'upper') pattern = pattern.toUpperCase()
-    const nid = customAlphabet(pattern, length)
-    if (returnInstance) return nid
-    const value = nid()
-    return type === 'int' ? parseInt(value) : value
-  }
 
   /**
    * Get NPM global module directory
@@ -607,26 +552,6 @@ class Bajo extends Plugin {
     if (thrown) throw this.error('cantFindMethod%s', name)
   }
 
-  /**
-   * Find item deep in paths
-   *
-   * @method
-   * @param {string} item - Item to find
-   * @param {Array} paths - Array of path to look for
-   * @returns {string}
-   */
-  findDeep = (item, paths) => {
-    let dir
-    for (const p of paths) {
-      const d = `${p}/${item}`
-      if (fs.existsSync(d)) {
-        dir = d
-        break
-      }
-    }
-    return dir
-  }
-
   /**
    * Get module directory, locally and globally
    *
@@ -636,6 +561,7 @@ class Bajo extends Plugin {
    * @returns {string} Return absolute package directory
    */
   getModuleDir = (pkgName, base) => {
+    const { findDeep } = this.app.lib
     if (pkgName === 'main') return resolvePath(this.app.dir)
     if (base === 'main') base = this.app.dir
     else if (this && this.app && this.app[base]) base = this.app[base].pkgName
@@ -644,8 +570,8 @@ class Bajo extends Plugin {
     const gdir = this.getGlobalModuleDir()
     paths.unshift(gdir)
     paths.unshift(resolvePath(path.join(this.app.dir, 'node_modules')))
-    let dir = this.findDeep(pkgPath, paths)
-    if (base && !dir) dir = this.findDeep(`${base}/node_modules/${pkgPath}`, paths)
+    let dir = findDeep(pkgPath, paths)
+    if (base && !dir) dir = findDeep(`${base}/node_modules/${pkgPath}`, paths)
     if (!dir) return null
     return resolvePath(path.dirname(dir))
   }
@@ -670,6 +596,7 @@ class Bajo extends Plugin {
    *
    * - local/absolute file
    * - TNsPath (```myPlugin:/path/to/file.txt```)
+   * - file under node_modules, e.g. ```myPlugin:node_modules/some-package/file.txt```
    *
    * @method
    * @param {string} file - File path, see above for supported types
@@ -683,6 +610,10 @@ class Bajo extends Plugin {
       const { ns, path } = this.breakNsPath(file)
       if (ns !== 'file' && this && this.app && this.app[ns] && ns.length > 1) {
         file = `${this.app[ns].dir.pkg}${path}`
+        if (path.startsWith('node_modules/')) {
+          file = `${this.app[ns].dir.pkg}/${path}`
+          if (!fs.existsSync(file)) file = `${this.app[ns].dir.pkg}/../${path.slice('node_modules/'.length)}`
+        }
       }
     }
     return file
@@ -787,7 +718,7 @@ class Bajo extends Plugin {
       }
       result[name] = mod
     }
-    if (notFound.length > 0) throw this.error('cantFind%s', this.join(notFound))
+    if (notFound.length > 0 && opts.throwNotFound) throw this.error('cantFind%s', this.join(notFound))
     if (opts.asObject) return result
     if (pkgs.length === 1) return result[keys(result)[0]]
     return values(result)
@@ -899,114 +830,6 @@ class Bajo extends Plugin {
     return `${num[0]}${isEmpty(unit) ? defUnit : unit[0]}`
   }
 
-  /**
-   * Parse duration to its millisecond value. Use {@link https://github.com/vercel/ms|ms} under the hood
-   *
-   * @method
-   * @param {(number|string)} dur - If string is given, parse this to its millisecond value. Otherwise returns as is
-   * @returns {number}
-   * @see {@link https://github.com/vercel/ms|ms}
-   */
-  parseDur = (dur) => {
-    return isNumber(dur) ? dur : ms(dur)
-  }
-
-  /**
-   * Parse datetime string as Javascript date object. Please visit {@link https://day.js.org|dayjs} for valid formats and more infos
-   *
-   * @method
-   * @param {string} dt - Datetime string
-   * @returns {Object} Javascript date object
-   * @see {@link https://day.js.org|dayjs}
-   */
-  parseDt = (dt) => {
-    const value = this.app.lib.dayjs(dt)
-    if (!value.isValid()) throw this.error('dtUnparsable%s', dt)
-    return value.toDate()
-  }
-
-  /**
-   * Parse an object and optionally normalize its values recursively. Use {@link https://github.com/ladjs/dotenv-parse-variables}
-   * to parse values, so please have a visit to know how it works
-   *
-   * If ```options.parseValue``` is ```true```, any key ends with ```Dur``` and ```Dt``` will
-   * also be parsed as millisecond and Javascript date time accordingly.
-   *
-   * @method
-   * @param {(Object|string)} input - If string is given, parse it first using JSON.parse
-   * @param {Object} [options={}] - Options
-   * @param {boolean} [options.silent=true] - If ```true``` (default), exception are not thrown and silently ignored
-   * @param {boolean} [options.parseValue=false] - If ```true```, values will be parsed & normalized
-   * @param {string} [options.lang] - If provided, use this language instead of the one in config
-   * @returns {Object}
-   * @see {@link https://github.com/ladjs/dotenv-parse-variables}
-   */
-  parseObject = (input, options = {}) => {
-    const { silent = true, parseValue = false, lang, ns } = options
-    const { isSet } = this.app.lib.aneka
-    const translate = (item) => {
-      const scope = ns ? this.app[ns] : this
-      const [text, ...args] = item.split('|')
-      return scope.t(text, ...args, { lang })
-    }
-    const statics = ['*']
-    if (isString(input)) {
-      try {
-        input = JSON.parse(input)
-      } catch (err) {
-        if (silent) input = {}
-        else throw err
-      }
-    }
-    let obj = cloneDeep(input)
-    const keys = Object.keys(obj)
-    const mutated = []
-    keys.forEach(k => {
-      let v = obj[k]
-      if (isPlainObject(v)) obj[k] = this.parseObject(v, options)
-      else if (isArray(v)) {
-        v.forEach((i, idx) => {
-          if (isPlainObject(i)) obj[k][idx] = this.parseObject(i, options)
-          else if (statics.includes(i)) obj[k][idx] = i
-          else if (parseValue) obj[k][idx] = dotenvParseVariables(set({}, 'item', obj[k][idx]), { assignToProcessEnv: false }).item
-          if (isArray(obj[k][idx])) obj[k][idx] = obj[k][idx].map(item => typeof item === 'string' ? item.trim() : item)
-        })
-      } else if (isSet(v)) {
-        if (isString(v) && v.startsWith('t:') && lang) v = translate(v.slice(2))
-        try {
-          if (statics.includes(v)) obj[k] = v
-          else if (k.startsWith('t:') && isString(v)) {
-            const newK = k.slice(2)
-            if (lang) obj[newK] = translate(v)
-            else obj[newK] = v
-            mutated.push(k)
-          } else if (parseValue) {
-            obj[k] = dotenvParseVariables(set({}, 'item', v), { assignToProcessEnv: false }).item
-            if (isArray(obj[k])) obj[k] = obj[k].map(item => typeof item === 'string' ? item.trim() : item)
-          }
-          if (k.slice(-3) === 'Dur') obj[k] = this.parseDur(v)
-          if (k.slice(-2) === 'Dt') obj[k] = this.parseDt(v)
-        } catch (err) {
-          obj[k] = undefined
-          if (!silent) throw err
-        }
-      }
-    })
-    if (mutated.length > 0) obj = omit(obj, mutated)
-    return obj
-  }
-
-  pick = (obj, items, excludeUnset) => {
-    const { isSet } = this.app.lib.aneka
-    const result = {}
-    for (const item of items) {
-      const [k, nk] = item.split(':')
-      if (excludeUnset && !isSet(obj[k])) continue
-      result[nk ?? k] = obj[k]
-    }
-    return result
-  }
-
   /**
    * Read and parse file as config object. Supported types: ```.js``` and ```.json```.
    * More supports can be added using plugin. {@link https://github.com/ardhi/bajo-config|bajo-config} gives you additional supports for ```.yml```, ```.yaml``` and ```.toml``` file
@@ -1026,6 +849,7 @@ class Bajo extends Plugin {
    * @returns {Object}
    */
   readConfig = async (file, { ns, pattern, globOptions = {}, ignoreError, defValue = {}, opts = {} } = {}) => {
+    const { parseObject } = this.app.lib
     if (!ns) ns = this.ns
     file = resolvePath(this.getPluginFile(file))
     let ext = path.extname(file)
@@ -1033,22 +857,22 @@ class Bajo extends Plugin {
     ext = ext.toLowerCase()
     if (ext === '.js') {
       const { readHandler } = find(this.app.configHandlers, { ext })
-      return this.parseObject(await readHandler.call(this.app[ns], file, opts))
+      return parseObject(await readHandler.call(this.app[ns], file, opts))
     }
     if (ext === '.json') return await this.fromJson(file, null)
     if (!['', '.*'].includes(ext)) {
       const item = find(this.app.configHandlers, { ext })
       if (!item) {
         if (!ignoreError) throw this.error('cantParse%s', file, { code: 'BAJO_CONFIG_NO_PARSER' })
-        return this.parseObject(defValue)
+        return parseObject(defValue)
       }
-      return this.parseObject(await item.readHandler.call(this.app[ns], file, opts))
+      return parseObject(await item.readHandler.call(this.app[ns], file, opts))
     }
     const item = pattern ?? `${fname}.{${map(map(this.app.configHandlers, 'ext'), k => k.slice(1)).join(',')}}`
     const files = await fastGlob(item, globOptions)
     if (files.length === 0) {
       if (!ignoreError) throw this.error('noConfigFileFound', { code: 'BAJO_CONFIG_FILE_NOT_FOUND' })
-      return this.parseObject(defValue)
+      return parseObject(defValue)
     }
     let config = defValue
     for (const f of files) {
@@ -1061,7 +885,7 @@ class Bajo extends Plugin {
       config = await item.readHandler.call(this.app[ns], f, null, opts)
       if (!isEmpty(config)) break
     }
-    return this.parseObject(config)
+    return parseObject(config)
   }
 
   /**
@@ -1073,6 +897,7 @@ class Bajo extends Plugin {
    * @returns {Object}
    */
   readJson = (file, thrownNotFound = false) => {
+    const { parseObject } = this.app.lib
     if (isPlainObject(thrownNotFound)) thrownNotFound = false
     if (!fs.existsSync(file) && thrownNotFound) throw this.error('notFound%s%s', this.t('file'), file)
     let resp
@@ -1080,7 +905,7 @@ class Bajo extends Plugin {
       resp = fs.readFileSync(file, 'utf8')
     } catch (err) {}
     if (isEmpty(resp)) return resp
-    return this.parseObject(JSON.parse(resp))
+    return parseObject(JSON.parse(resp))
   }
 
   fromJson (file, isContent) {
@@ -1130,8 +955,15 @@ class Bajo extends Plugin {
    * @returns {Array} Array of hook execution results
    */
   runHook = async (hookName, ...args) => {
-    const [ns, path] = (hookName ?? '').split(':')
-    let fns = filter(this.app.bajo.hooks, { ns, path })
+    let ns
+    let path
+    let subNs
+    try {
+      ({ ns, subNs, path } = this.breakNsPath(hookName ?? ''))
+    } catch (err) {
+      return
+    }
+    let fns = filter(this.app.bajo.hooks, { ns, subNs, path })
     if (isEmpty(fns)) return []
     fns = orderBy(fns, ['level'])
     const results = []

package/class/base.js

@@ -8,23 +8,25 @@ import Plugin from './plugin.js'
  */
 
 class Base extends Plugin {
-  /**
-   * Dependencies to other plugins. Enter all plugin's package name your plugin dependent from.
-   *
-   * Semver is also supported.
-   *
-   * @constant {string[]}
-   * @memberof Base
-   */
-  static dependencies = []
-
   /**
    * @param {string} pkgName - Package name (the one you use in package.json)
    * @param {Object} app - App instance reference. Usefull to call app method inside a plugin
    */
   constructor (pkgName, app) {
     super(pkgName, app)
+
+    /**
+     * Dependencies to other plugins. Enter all plugin's package name your plugin dependent from.
+     *
+     * Semver is also supported.
+     *
+     * @constant {string[]}
+     * @memberof Base
+     */
+    this.dependencies = []
+
     this.state = {}
+    this.pkg = {}
   }
 
   /**
@@ -36,27 +38,19 @@ class Base extends Plugin {
    */
   loadConfig = async () => {
     const { defaultsDeep } = this.app.lib.aneka
-    const { get, kebabCase, keys, pick } = this.app.lib._
-    const { log, readJson, parseObject, getModuleDir, readAllConfigs } = this.app.bajo
+    const { get, keys, pick } = this.app.lib._
+    const { log, getModuleDir, readAllConfigs } = this.app.bajo
+    const { parseObject } = this.app.lib
+
     const defKeys = keys(this.config)
     log.trace('- %s', this.ns)
     const dir = this.ns === this.app.mainNs ? (`${this.app.bajo.dir.base}/${this.app.mainNs}`) : getModuleDir(this.pkgName)
     let cfg = await readAllConfigs(`${dir}/config`)
-    this.constructor.alias = this.alias ?? (this.pkgName.slice(0, 5) === 'bajo-' ? this.pkgName.slice(5).toLowerCase() : this.ns.toLowerCase())
-    this.constructor.alias = kebabCase(this.alias)
 
     this.dir = {
       pkg: dir,
       data: `${this.app.bajo.dir.data}/plugins/${this.ns}`
     }
-    const file = `${dir + (this.ns === this.app.mainNs ? '/..' : '')}/package.json`
-    const pkgJson = await readJson(file)
-    this.pkg = pick(pkgJson,
-      ['name', 'version', 'description', 'author', 'license', 'homepage'])
-    if (this.ns === this.app.mainNs) {
-      this.constructor.alias = this.app.mainNs
-      this.title = this.title ?? this.alias
-    }
     // merge with config from datadir
     try {
       const altCfg = await readAllConfigs(`${this.app.bajo.dir.data}/config/${this.ns}`)
@@ -100,6 +94,15 @@ class Base extends Plugin {
    * @async
    */
   exit = async () => {
+    this.dispose()
+  }
+
+  /**
+   * Dispose internal references
+   */
+  dispose = () => {
+    super.dispose()
+    this.state = null
   }
 }