bajo 0.0.1 → 0.2.0

package/bajoBook/book/reference/pages/helper/generate-id.md

@@ -0,0 +1,36 @@
+---
+title: function generateId()
+---
+
+ID generator based on [nanoid](https://github.com/ai/nanoid).
+
+By default, ```options.pattern``` is set to ```abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789``` so that resulted ID will be a full alphanumeric characters with the length of ```options.length``` (default: ```21```)
+
+If ```options.pattern``` is an object:
+
+- ```pattern```: characters to use
+- ```lowerCase```: if ```true```, only use lowercase
+- ```upperCase```: if ```true```, only use uppercase
+
+```lowerCase``` and ```upperCase``` is mutually exclusive, first one win.
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+| ```options``` | object |||
+|     ```pattern``` | string or object | all alphanumeric characters | see above |
+|     ```length``` | integer | ```21``` | length of generated ID |
+|     ```returnInstance``` | boolean | ```false``` | Set ```true``` to return a nanoid instance |
+
+###### Returns:
+
+```string``` or ```object```
+
+#### Example
+
+```javascript
+...
+const { generateId } = this.bajo.helper
+console.log(generateId()) // returns: <randomly generated characters>
+```

package/bajoBook/book/reference/pages/helper/get-config.md

@@ -0,0 +1,27 @@
+---
+title: function getConfig()
+---
+
+Get configuration object of **bajo** or its **plugin**
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+| ```name``` | string | ```bajo``` | A valid plugin name |
+| ```options``` | object |||
+|     ```full``` | boolean | ```false``` | If ```true```, returns ALL config objects belonging to named plugin. Otherwise, returns only subset of objects that can be changed through configuration file |
+|     ```clone``` | boolean | ```false``` | If ```true```, returns cloned object |
+
+###### Returns:
+
+```object```
+
+#### Example
+
+```javascript
+...
+const { getConfig } = this.bajo.helper
+const cfg = getConfig('bajoLogger')
+console.log(cfg)
+```

package/bajoBook/book/reference/pages/helper/get-global-module-dir.md

@@ -0,0 +1,13 @@
+---
+title: function getGlobalModuleDir()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/get-helper.md

@@ -0,0 +1,13 @@
+---
+title: function getHelper()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/get-item-by-name.md

@@ -0,0 +1,13 @@
+---
+title: async function getItemByName()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/get-key-by-value.md

@@ -0,0 +1,13 @@
+---
+title: function getKeyByValue()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/get-module-dir.md

@@ -0,0 +1,13 @@
+---
+title: function getModuleDir()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/get-plugin-data-dir.md

@@ -0,0 +1,13 @@
+---
+title: function getPluginDataDir()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/get-plugin-name.md

@@ -0,0 +1,13 @@
+---
+title: function getPluginName()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/get-plugin.md

@@ -0,0 +1,13 @@
+---
+title: function getPlugin()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/import-module.md

@@ -0,0 +1,13 @@
+---
+title: async function importModule()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/import-pkg.md

@@ -0,0 +1,13 @@
+---
+title: async function importPkg()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/is-empty-dir.md

@@ -0,0 +1,13 @@
+---
+title: async function isEmptyDir()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/is-log-in-range.md

@@ -0,0 +1,13 @@
+---
+title: function isLogInRange()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/is-set.md

@@ -0,0 +1,13 @@
+---
+title: function isSet()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/is-valid-app.md

@@ -0,0 +1,13 @@
+---
+title: function isValidApp()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/is-valid-plugin.md

@@ -0,0 +1,13 @@
+---
+title: function isValidPlugin()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/log-levels.md

@@ -0,0 +1,13 @@
+---
+title: object logLevels
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/log.md

@@ -0,0 +1,13 @@
+---
+title: object log
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/paginate.md

@@ -0,0 +1,13 @@
+---
+title: function paginate()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/pascal-case.md

@@ -0,0 +1,13 @@
+---
+title: function pascalCase()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/print.md

@@ -0,0 +1,13 @@
+---
+title: object print
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/read-config.md

@@ -0,0 +1,13 @@
+---
+title: async function readConfig()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/read-json.md

@@ -0,0 +1,13 @@
+---
+title: function readJson()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/resolve-path.md

@@ -0,0 +1,13 @@
+---
+title: function resolvePath()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/resolve-tpl-path.md

@@ -0,0 +1,13 @@
+---
+title: function resolveTplPath()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/run-hook.md

@@ -0,0 +1,13 @@
+---
+title: async function runHook()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/save-as-download.md

@@ -0,0 +1,13 @@
+---
+title: async function saveAsDownload()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/titleize.md

@@ -0,0 +1,13 @@
+---
+title: function titleize()
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/bajoBook/book/reference/pages/helper/white-space.md

@@ -0,0 +1,13 @@
+---
+title: array whiteSpace
+---
+
+###### Parameters:
+
+| Name | Type | Default Value | Description |
+| ---- | ---- | ------------- | ----------- |
+
+###### Returns:
+
+
+#### Example

package/boot/attach-helper.js

@@ -0,0 +1,34 @@
+import buildHelper from './lib/build-helper.js'
+import logger from './lib/logger.js'
+import fs from 'fs-extra'
+import dayjs from 'dayjs'
+import utc from 'dayjs/plugin/utc.js'
+import customParseFormat from 'dayjs/plugin/customParseFormat.js'
+import deepFreeze from 'deep-freeze-strict'
+import currentLoc from './helper/current-loc.js'
+
+dayjs.extend(utc)
+dayjs.extend(customParseFormat)
+
+export default async function () {
+  this.bajo.helper = await buildHelper.call(this, `${currentLoc(import.meta).dir}/helper`)
+  this.bajo.helper.freeze = (o, shallow) => {
+    if (shallow) Object.freeze(o)
+    else deepFreeze(o)
+  }
+  this.bajo.helper.log = logger.call(this)
+  this.bajo.helper.dayjs = dayjs
+  this.bajo.helper.setImmediate = function () {
+    return new Promise((resolve) => {
+      setImmediate(() => resolve())
+    })
+  }
+  this.bajo.helper.freeze(this.bajo.helper, true)
+  // last cleanup
+  if (!fs.existsSync(this.bajo.config.dir.data)) {
+    this.bajo.helper.log.warn('Data directory \'%s\' is not set yet!', this.bajo.config.dir.data)
+  }
+  if (this.bajo.config.env === 'dev') {
+    this.dump = this.bajo.helper.dump
+  }
+}

package/boot/boot-order.js

@@ -0,0 +1,34 @@
+import { reduce, map, isNaN, trim, forOwn, orderBy } from 'lodash-es'
+import fs from 'fs-extra'
+import getModuleDir from './helper/get-module-dir.js'
+
+async function bootOrder () {
+  const { log, envs, error } = this.bajo.helper
+  log.debug('Setup boot order')
+  const config = this.bajo.config
+  const order = reduce(config.plugins, (o, k, i) => {
+    const key = map(k.split(':'), m => trim(m))
+    if (key[1] && !isNaN(Number(key[1]))) o[key[0]] = Number(key[1])
+    else o[key[0]] = 10000 + i
+    return o
+  }, {})
+  const norder = {}
+  for (let n of config.plugins) {
+    n = map(n.split(':'), m => trim(m))[0]
+    const dir = n === 'app' ? (config.dir.base + '/app') : getModuleDir(n)
+    if (n !== 'app' && !fs.existsSync(`${dir}/bajo`)) throw error('Package \'%s\' not found or isn\'t a valid Bajo package', n)
+    norder[n] = NaN
+    try {
+      norder[n] = Number(trim(await fs.readFile(`${dir}/bajo/.bootorder`, 'utf8')))
+    } catch (err) {}
+  }
+  const result = []
+  forOwn(order, (v, k) => {
+    const item = { k, v: isNaN(norder[k]) ? v : norder[k] }
+    result.push(item)
+  })
+  config.plugins = map(orderBy(result, ['v']), 'k')
+  log.info('Run in \'%s\' environment', envs[config.env])
+}
+
+export default bootOrder

package/boot/build-config.js

@@ -0,0 +1,99 @@
+/**
+ * @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']
+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

@@ -0,0 +1,36 @@
+/**
+ * @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