bajo 2.0.2 → 2.2.0

package/extend/bajo/intl/en-US.json

@@ -22,11 +22,11 @@
   "appRunningAsApplet": "App runs in applet mode",
   "setupBootOrder": "Setup boot order",
   "configHandlers%s": "Config handlers: %s",
-  "exited": "Exited",
+  "dataDir%s": "Data dir: %s",
+  "exited%s": "- %s exited",
   "appShutdown": "App shutdown",
   "appletModeActivated": "Applet mode activated",
-  "collected%s%d": "%s collected: %d",
-  "attachMethods": "Attach methods",
+  "collected%s%d": "Collected %s: %d",
   "readConfigs": "Read configurations",
   "checkAliasNameClash": "Checking alias & name clashes",
   "checkDeps": "Checking dependencies",
@@ -126,7 +126,7 @@
   "offlineL": "offline",
   "reconnectingL": "reconnecting",
   "connMustHave%s": "Connection must have '%s'",
-  "notFound%s%s": "%s '%s' not found",
+  "notFound%s%s": "%s|upperFirst '%s' not found",
   "connection": "Connection",
   "file": "File",
   "applet": "Applet",
@@ -174,5 +174,11 @@
   "buildPluginsComplete": "Building plugins completed",
   "pluginPackageNotFound%s": "Plugin package '%s' file not found!",
   "pluginPackageInvalid%s": "`Plugin package '%s' should be an instance of Base class`",
-  "appletNeedsBajoCli": "Applet needs to have 'bajo-cli' loaded"
+  "appletNeedsBajoCli": "Applet needs to have 'bajo-cli' loaded",
+  "unknown%s%s": "Unknown %s|toLower '%s'",
+  "notImplemented%s%s": "%s|upperFirst '%s' not implemented yet",
+  "method": "Method",
+  "exist%s%s": "%s|upperFirst '%s' exists already",
+  "fieldError%s%s": "'%s': %s|lowerFirst",
+  "reservedName%s%s": "%s|upperFirst name '%s' is a reserved name. Please rename to something else"
 }

package/extend/bajo/intl/id.json

@@ -22,11 +22,11 @@
   "appRunningAsApplet": "App berjalan di mode applet",
   "setupBootOrder": "Atur urutan booting",
   "configHandlers%s": "Pengatur konfigurasi: %s",
-  "exited": "Exited",
+  "dataDir%s": "Dir data: %s",
+  "exited%s": "- %s keluar",
   "appShutdown": "Aplikasi ditutup",
   "appletModeActivated": "Mode applet diaktifkan",
-  "collected%s%d": "%s terkoleksi: %d",
-  "attachMethods": "Tempelkan metode",
+  "collected%s%d": "%s|upperFirst terkoleksi: %d",
   "readConfigs": "Baca konfigurasi",
   "checkAliasNameClash": "Cek bentrokan nama dan alias",
   "checkDeps": "Cek ketergantungan",
@@ -126,7 +126,7 @@
   "offlineL": "offline",
   "reconnectingL": "mencoba menghubung kembali",
   "connMustHave%s": "Koneksi harus memiliki '%s'",
-  "notFound%s%s": "%s '%s' tidak ditemukan",
+  "notFound%s%s": "%s|upperFirst '%s' tidak ditemukan",
   "connection": "Koneksi",
   "file": "Berkas",
   "applet": "Applet",
@@ -174,5 +174,11 @@
   "buildPluginsComplete": "Pemuatan plugin komplit",
   "pluginPackageNotFound%s": "Berkas paket plugin '%s' tidak ditemukan!",
   "pluginPackageInvalid%s": "Paket plugin '%s' harus berupa instan dari kelas Base",
-  "appletNeedsBajoCli": "Applet membutuhkan 'bajo-cli' yang harus termuat terlebih dahulu"
+  "appletNeedsBajoCli": "Applet membutuhkan 'bajo-cli' yang harus termuat terlebih dahulu",
+  "unknown%s%s": "%s|upperFirst '%s' tidak dikenal",
+  "notImplemented%s%s": "%s|upperFirst '%s' belum diimplementasikan",
+  "method": "Metode",
+  "exist%s%s": "%s|upperFirst '%s' sudah ada",
+  "fieldError%s%s": "'%s': %s|lowerFirst",
+  "reservedName%s%s": "Nama %s|lowerFirst '%s' adalah nama tang di reserve. Silahkan gunakan nama lainnya"
 }

package/index.js

@@ -1,5 +1,6 @@
 import App from './class/app.js'
-import shim from './lib/shim.js'
+import { shim } from 'aneka'
+import fs from 'fs-extra'
 
 shim()
 
@@ -25,6 +26,13 @@ shim()
  * @returns {App}
  */
 async function boot (cwd) {
+  if (!cwd) cwd = process.cwd()
+  const pkgFile = `${cwd}/package.json`
+  const pkg = fs.readJsonSync(pkgFile)
+  if (pkg.type !== 'module') {
+    console.error(`Please turn on ES6 parsing by adding "type": "module" to ${pkgFile}!`)
+    process.exit(1)
+  }
   const app = new App(cwd)
   return await app.boot()
 }

package/lib/find-deep.js

@@ -0,0 +1,24 @@
+import fs from 'fs'
+
+/**
+ * Find item deep in paths
+ *
+ * @method
+ * @memberof module:Lib
+ * @param {string} item - Item to find
+ * @param {Array} paths - Array of path to look for
+ * @returns {string}
+ */
+function findDeep (item, paths) {
+  let dir
+  for (const p of paths) {
+    const d = `${p}/${item}`
+    if (fs.existsSync(d)) {
+      dir = d
+      break
+    }
+  }
+  return dir
+}
+
+export default findDeep

package/lib/freeze.js

@@ -0,0 +1,16 @@
+import deepFreezeStrict from 'deep-freeze-strict'
+
+/**
+ * Freeze object
+ *
+ * @method
+ * @memberof module:Lib
+ * @param {Object} obj - Object to freeze
+ * @param {boolean} [shallow=false] - If ```false``` (default), deep freeze object
+ */
+function freeze (obj, shallow = false) {
+  if (shallow) Object.freeze(obj)
+  else deepFreezeStrict(obj)
+}
+
+export default freeze

package/lib/import-module.js

@@ -1,6 +1,8 @@
-import resolvePath from './resolve-path.js'
 import fs from 'fs-extra'
 import lodash from 'lodash'
+import aneka from 'aneka'
+
+const { resolvePath } = aneka
 const { isFunction, isPlainObject } = lodash
 
 /**
@@ -32,8 +34,8 @@ const { isFunction, isPlainObject } = lodash
  * @returns {any}
  * @see Bajo#importModule
  */
-async function importModule (file, { asDefaultImport, asHandler, noCache } = {}) {
-  const load = async (file, asDefaultImport = true, noCache = false) => {
+async function importModule (file, { asDefaultImport = true, asHandler, noCache } = {}) {
+  const load = async (file, asDefaultImport, noCache = false) => {
     file = resolvePath(file, true)
     if (noCache) file += `?_=${Date.now()}`
     const imported = await import(file)

package/lib/index.js

@@ -0,0 +1,6 @@
+/**
+ * External helpers you can use by importing its file directly
+ *
+ * @name Lib
+ * @module Lib
+ */

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "bajo",
-  "version": "2.0.2",
+  "version": "2.2.0",
   "description": "The ultimate framework for whipping up massive apps in no time",
   "main": "index.js",
   "scripts": {
     "build-doc": "jsdoc -c .jsdoc.conf.json",
-    "test": "mocha"
+    "test": "mocha --recursive"
   },
   "type": "module",
   "repository": {
@@ -26,29 +26,23 @@
   "homepage": "https://github.com/ardhi/bajo#readme",
   "dependencies": {
     "add-filename-increment": "^1.0.0",
-    "aneka": "^0.1.5",
+    "aneka": "^0.10.0",
     "chalk": "^5.6.0",
     "dayjs": "^1.11.13",
     "deep-freeze-strict": "^1.1.1",
     "delay": "^6.0.0",
-    "dotenv": "^17.2.1",
-    "dotenv-parse-variables": "^2.0.0",
     "empty-dir": "^3.0.0",
     "fast-glob": "^3.3.3",
-    "flat": "^6.0.1",
     "fs-extra": "^11.3.1",
     "get-global-path": "^0.0.1",
     "lodash": "^4.17.21",
-    "ms": "^2.1.3",
-    "nanoid": "^5.1.5",
     "omit-deep": "^0.3.0",
     "ora": "^8.2.0",
     "outmatch": "^1.0.0",
-    "semver": "^7.7.2",
-    "sprintf-js": "^1.1.3",
-    "yargs": "^18.0.0"
+    "semver": "^7.7.2"
   },
   "devDependencies": {
+    "chai": "^6.2.1",
     "clean-jsdoc-theme": "^4.3.0",
     "docdash": "^2.0.2"
   }

package/test/base.test.js

@@ -0,0 +1,108 @@
+import { expect } from 'chai'
+import Base from '../class/base.js'
+
+function makeMockApp ({ mainNs = 'app-main', throwOnDataConfig = false } = {}) {
+  // small lodash-like helpers used by Base.loadConfig
+  const _ = {
+    get: (obj, path, defVal) => {
+      if (!obj) return defVal
+      const parts = String(path).split('.')
+      let cur = obj
+      for (const p of parts) {
+        if (cur == null) return defVal
+        cur = cur[p]
+      }
+      return cur === undefined ? defVal : cur
+    },
+    kebabCase: s => String(s).replace(/([a-z0-9])([A-Z])/g, '$1-$2').replace(/[\s_]+/g, '-').toLowerCase(),
+    keys: obj => obj ? Object.keys(obj) : [],
+    pick: (obj, keys) => {
+      const out = {}
+      if (!obj) return out
+      for (const k of keys) if (k in obj) out[k] = obj[k]
+      return out
+    }
+  }
+
+  // simple defaultsDeep-ish helper suitable for these tests:
+  // later objects in args take precedence over earlier ones (shallow)
+  const defaultsDeep = (...objs) => Object.assign({}, ...objs.filter(Boolean))
+
+  // bajo helpers (file reads etc). readAllConfigs will be called twice by Base.loadConfig:
+  //  - once for module dir config
+  //  - once for data dir config (may throw)
+  let readAllCalls = 0
+  const readAllConfigs = async (path) => {
+    readAllCalls += 1
+    if (throwOnDataConfig && readAllCalls === 2) throw new Error('readAllConfigs data dir error')
+    // return a small config object to test merge/path logic
+    return { alpha: 'file', title: 'FromFile', other: 'ignore-me' }
+  }
+
+  return {
+    mainNs,
+    lib: { aneka: { defaultsDeep }, _ },
+    bajo: {
+      dir: { base: '/base', data: '/data' },
+      readAllConfigs,
+      readJson: async (p) => ({ name: 'bajo-foo', version: '1.2.3', description: 'pkg' }),
+      parseObject: (o) => o,
+      getModuleDir: (pkgName) => `/modules/${pkgName}`,
+      log: { trace: () => {} }
+    },
+    env: {},
+    argv: {}
+  }
+}
+
+describe('Base.loadConfig', () => {
+  it('derives alias from pkgName starting with "bajo-" using kebabCase', async () => {
+    const app = makeMockApp()
+    const inst = new Base('bajo-MyPlugin', app)
+    // ensure namespace used by loadConfig
+    inst.ns = 'myplugin'
+    // set an initial config shape so defKeys isn't empty
+    inst.config = { alpha: 'default', title: 'Default' }
+
+    await inst.loadConfig()
+
+    // alias is stored on the constructor
+    expect(inst.constructor.alias).to.equal('my-plugin')
+    // dir pkg should be set according to mainNs mismatch
+    expect(inst.dir.pkg).to.equal('/modules/bajo-MyPlugin')
+    // config should keep keys only from defKeys (alpha & title), parseObject ran (no throw)
+    expect(Object.keys(inst.config)).to.include('alpha')
+    expect(Object.keys(inst.config)).to.include('title')
+  })
+
+  it('when ns === app.mainNs uses app.mainNs as alias and sets title to alias', async () => {
+    const app = makeMockApp({ mainNs: 'mainns' })
+    const inst = new Base('bajo-mainpkg', app)
+    inst.ns = 'mainns'
+    inst.config = { title: undefined } // start with no title
+
+    await inst.loadConfig()
+
+    expect(inst.constructor.alias).to.equal('mainns')
+    // title should be set to alias when ns is mainNs
+    expect(inst.title).to.equal(inst.constructor.alias)
+  })
+
+  it('continues when readAllConfigs for data dir throws (tolerant behavior)', async () => {
+    const app = makeMockApp({ throwOnDataConfig: true })
+    const inst = new Base('bajo-throwtest', app)
+    inst.ns = 'throwtest'
+    inst.config = { alpha: 'start' }
+
+    // should not throw even if second readAllConfigs throws
+    let threw = false
+    try {
+      await inst.loadConfig()
+    } catch (err) {
+      threw = true
+    }
+    expect(threw).to.equal(false)
+    // config should still be an object and title present (or undefined but not crash)
+    expect(inst.config).to.be.an('object')
+  })
+})

package/wiki/CHANGES.md

@@ -0,0 +1,63 @@
+# Changes
+
+## 2026-01-11
+
+- [2.2.0] Simplify numerous things by putting most of static properties back as normal class properties
+
+## 2025-12-29
+
+- [2.2.0] Add ```this.selfBind()``` to class ```Plugin```
+
+## 2025-12-27
+
+- [2.2.0] Add some translations
+
+## 2025-12-27
+
+- [2.2.0] Add config object ```this.config.runtime``` to adjust some runtime settings
+
+## 2025-12-24
+
+- [2.2.0] Pass ```true``` to ```this.app.exit()``` to exit abruptly. Defaults to ```SIGINT```
+- [2.2.0] Add ```detailsMessage``` to ```Err``` class if error object has ```details``` in payload
+- [2.2.0] Upgrade ```aneka@0.10.0```
+- [2.2.0] Bugfix: program arguments should not parsed as object
+
+## 2025-12-21
+
+- [2.2.0] ```runHook()``` now accept both ```alias``` & ```ns``` prefixed name
+- [2.2.0] In case of unknown plugin or plugin isn't loaded, ```runHook``` simply exit silently
+- [2.2.0] ```this.app.pluginClass``` is now ```this.app.baseClass``` and all containing class definition keys are pascal cased to match with their constructor names
+
+## 2025-12-20
+
+- [2.2.0] Removing dynamically attached methods because its problematic and leads to confusion
+
+## 2025-12-19
+
+- [2.2.0] Upgrade to ```aneka@0.9.0```
+
+## 2025-12-13
+
+- [2.2.0] Add ```app.lib.formatText()```
+- [2.2.0] Move most bajo methods that doesn't relate to Bajo to app.lib functions
+
+## 2025-12-11
+
+- [2.1.1] Upgrade to ```aneka@0.5.0```
+
+## 2025-12-09
+
+- [2.1.1] Upgrade to ```aneka@0.2.3```
+- [2.1.1] Some organizatory file location changes
+- [2.1.1] Typo on class ```Tools```
+
+## 2025-12-05
+
+- [2.1.1] Upgrade to ```aneka@0.2.1```
+- [2.1.1] New class ```Tools```, serves as anchestor for ```Err``` & ```Print```
+
+## 2025-12-03
+
+- [2.1.1] Add method ```getPkgInfo()``` to plugins main class.
+- [2.1.1] Now you can put your plugins either in ```{dataDir}/config/.plugins``` or directly as an array in your app ```package.json``` under the ```bajo.plugins``` tree. The later takes precedence.

package/wiki/CONFIG.md

@@ -7,9 +7,15 @@ The following table shows the default app settings. To change these to suit your
 | ```log``` | ```object``` | | |
 |     ```dateFormat``` | ```string``` | ```YYYY-MM-DDTHH:MM:ss.SSS[Z]```| See [dayjs string & format](https://day.js.org/docs/en/parse/string-format) for more info |
 |     ```timeTaken``` | ```boolean``` | ```false```| Show time taken from previous activity in ms |
-|     ```localDate``` | ```boolean``` | ```false```| Use local date, defaults: UTC |
+|     ```useUtc``` | ```boolean``` | ```false```| Use UTC, defaults: local date/time |
 |     ```pretty``` | ```boolean``` | ```false```| Colorful, pretty styling |
 |     ```applet``` | ```boolean``` | ```false```| Show log even in applet mode |
+|     ```save``` | ```boolean``` | ```false```| Save log in '{dataDir}/log' |
+|     ```rotation``` | ```object``` | | Log rotation config if ```save``` is true  |
+|         ```cycle``` | ```string``` | ```none``` | Available values: ```none```, ```daily```, ```weekly```, ```monthly``` |
+|         ```compressOld``` | ```boolean``` | ```false``` | Set to ```true``` to compress old logs |
+|         ```byPlugin``` | ```boolean``` | ```false``` | Split log by plugin's name |
+|         ```retain``` | ```integer``` | ```5``` | How many old logs will be kept/retained |
 | ```lang``` | ```string``` | Auto detected | Valid language code e.g: 'en-US', 'id', etc. |
 | ```intl``` | ```object``` | | Internationalization settings |
 |     ```supported``` | ```array``` | ```['en-US', 'id']``` | Supported languages |

package/wiki/GETTING-STARTED.md

@@ -139,7 +139,7 @@ This file is the main plugin factory. It gets created automatically if it's not
 async function factory (pkgName) {
   const me = this
 
-  return class Main extends this.app.pluginClass.base {
+  return class Main extends this.app.baseClass.Base {
     constructor () {
       super(pkgName, me.app)
       this.config = {}

package/lib/current-loc.js

@@ -1,33 +0,0 @@
-import path from 'path'
-import resolvePath from './resolve-path.js'
-import { fileURLToPath } from 'url'
-
-/**
- * Get current directory & file. An attempt to brings back the old ```__dirname``` and ```__filename```
- * to the ES6 era.
- *
- * Returns object with the following keys:
- * - ```__dirname``` (aliases to ```dir```) - current directory name
- * - ```__filename``` (aliases to ```file```) - current file path
- *
- * Example:
- * ```javascript
- * const { importModule } = this.app.bajo
- * const currentLoc = await importModule('bajo:/lib/current-loc.js')
- *
- * const { __dirname, __filename } = currentLoc(import.meta)
- * console.log(__dirname, __filename)
- * ```
- *
- * @method
- * @memberof module:Lib
- * @param {Object} metaImport - ```import.meta``` object
- * @returns {Object}
- */
-const currentLoc = (metaImport) => {
-  const file = resolvePath(fileURLToPath(metaImport.url))
-  const dir = path.dirname(file)
-  return { dir, file, __dirname: dir, __filename: file }
-}
-
-export default currentLoc

package/lib/parse-args-argv.js

@@ -1,80 +0,0 @@
-import yargs from 'yargs'
-import { Parser } from 'yargs/helpers'
-import { unflatten } from 'flat'
-import dotenvParseVariables from 'dotenv-parse-variables'
-import lodash from 'lodash'
-import fs from 'fs-extra'
-import path from 'path'
-
-const { find, each, set, camelCase, forOwn } = lodash
-const delimiter = '-'
-const splitter = ':'
-
-const parseItem = (data, delimiter) => {
-  return unflatten(data, {
-    delimiter,
-    safe: true,
-    overwrite: true
-  })
-}
-
-async function parseWithParser () {
-  return Parser(process.argv.slice(2), {
-    configuration: {
-      'camel-case-expansion': false
-    }
-  })
-}
-
-async function parseWithYargs () {
-  const pkg = fs.readJSONSync(`${this.dir}/package.json`)
-  let name = `node ${pkg.main}`
-  if (pkg.bin) name = path.basename(pkg.bin, '.js')
-  const cli = yargs(process.argv.slice(2))
-    .usage('Usage: $0 [args...]')
-    .scriptName(name)
-    .positional('args', {
-      describe: 'Optional one or more arguments'
-    })
-    .parserConfiguration({
-      'camel-case-expansion': false
-    })
-    .version(pkg.version).alias('version', 'v')
-    .help().alias('help', 'h')
-    .alias('applet', 'a')
-  if (pkg.homepage) cli.epilog(`For more information please visit ${pkg.homepage}`)
-  return cli.argv
-}
-
-/**
- * Parse program arguments (args) & options (argv). See {@link App#args|args} & {@link App#argv|argv} for examples
- *
- * @method
- * @async
- * @memberof module:Lib
- * @param {boolean} [useParser] - If ```true```, skip {@link https://github.com/yargs/yargs|yargs}
- * @returns {{args: Array, argv: Object}} An object containing ```args``` and ```argv```
- * @see App#args
- * @see App#argv
- */
-async function parseArgsArgv (useParser) {
-  if (!useParser) useParser = find(process.argv, a => a.startsWith('--spawn'))
-  let argv = useParser ? await parseWithParser.call(this) : await parseWithYargs.call(this)
-  const args = argv._
-  delete argv._
-  delete argv.$0
-  argv = dotenvParseVariables(argv)
-  const all = { _: {} }
-  each(argv, (v, k) => {
-    const parts = k.split(splitter)
-    if (!parts[1]) all._[parts[0]] = v
-    else set(all, `${camelCase(parts[0])}.${parts[1]}`, v)
-  })
-  const result = {}
-  forOwn(all, (v, k) => {
-    result[k] = parseItem(v, delimiter)
-  })
-  return { args, argv: this.bajo.parseObject(result, { parseValue: true }) }
-}
-
-export default parseArgsArgv

package/lib/parse-env.js

@@ -1,50 +0,0 @@
-import dotenvParseVariables from 'dotenv-parse-variables'
-import { unflatten } from 'flat'
-import dotEnv from 'dotenv'
-import lodash from 'lodash'
-
-const { each, set, camelCase, forOwn } = lodash
-const parse = (data, delimiter) => {
-  return unflatten(data, {
-    delimiter,
-    safe: true,
-    overwrite: true,
-    transformKey: k => {
-      return camelCase(k.toLowerCase())
-    }
-  })
-}
-
-const delimiter = '__'
-const splitter = '.'
-
-/**
- * Parse environment variables. See {@link App#envVars|envVars} for examples
- *
- * @method
- * @memberof module:Lib
- * @returns {Object}
- * @see App#envVars
- */
-function parseEnv () {
-  let env
-  try {
-    env = dotEnv.config({ quiet: true })
-  } catch (err) {
-  }
-  env = dotenvParseVariables(process.env, { assignToProcessEnv: false })
-  const all = { _: {} }
-  each(env, (v, k) => {
-    const parts = k.split(splitter)
-    if (!parts[1]) all._[parts[0]] = v
-    else set(all, `${camelCase(parts[0])}.${parts[1]}`, v)
-  })
-  const result = {}
-  forOwn(all, (v, k) => {
-    result[k] = parse(v, delimiter)
-  })
-  if (result._.lang) result._.lang = result._.lang.split('.')[0].replaceAll('_', '-')
-  return this.bajo.parseObject(result, { parseValue: true })
-}
-
-export default parseEnv

package/lib/resolve-path.js

@@ -1,24 +0,0 @@
-import path from 'path'
-import { fileURLToPath } from 'url'
-import os from 'os'
-
-/**
- * Resolve file name to filesystem's path. Windows path separator ```\```
- * is normalized to Unix's ```/```
- *
- * @memberof module:Lib
- * @param {string} file - File to resolve
- * @param {boolean} [asFileUrl=false] - Return as file URL format ```file:///<name>```
- * @returns {string}
- */
-function resolvePath (item, asFileUrl) {
-  if (item.startsWith('file://')) item = fileURLToPath(item)
-  item = path.resolve(item)
-  if (os.platform() === 'win32') {
-    item = item.replace(/\\/g, '/')
-  }
-  if (asFileUrl) item = `file:///${item}`
-  return item
-}
-
-export default resolvePath