waibu 1.2.12 → 2.0.1

package/lib/webapp-scope/attach-intl.js

@@ -1,5 +1,5 @@
 function detect (detector = [], req, reply) {
-  const { get, map, trim, orderBy } = this.lib._
+  const { get, map, trim, orderBy } = this.app.lib._
   const supported = get(this, 'app.bajo.config.intl.supported', [this.app.bajo.config.lang])
   const defLang = get(this, 'app.bajo.config.intl.fallback', this.app.bajo.config.lang)
   let lang = null
@@ -49,12 +49,12 @@ function detect (detector = [], req, reply) {
 }
 
 async function attachIntl (detector = [], req, reply) {
-  const { get } = this.lib._
+  const { get } = this.app.lib._
   detect.call(this, detector, req, reply)
-  const defNs = get(req, 'routeOptions.config.ns', this.name)
+  const defNs = get(req, 'routeOptions.config.ns', this.ns)
   req.t = (text, ...args) => {
     args.push({ lang: req.lang })
-    return this.app[defNs].print.write(text, ...args)
+    return this.app[defNs].t(text, ...args)
     // return result.replaceAll("'", ''').replaceAll('"', '"')
   }
   req.format = (value, type = 'auto', opts = {}) => {

package/lib/webapp-scope/handle-compress.js

@@ -1,7 +1,7 @@
 import compress from '@fastify/compress'
 
 async function handleCompress (ctx, options = {}) {
-  const { defaultsDeep } = this.lib.aneka
+  const { defaultsDeep } = this.app.lib.aneka
   if (options === false) return this.log.warn('middlewareDisabled%s', 'compress')
   const opts = defaultsDeep(options, this.app.waibu.config.compress)
   await ctx.register(compress, opts)

package/lib/webapp-scope/handle-cors.js

@@ -1,7 +1,7 @@
 import cors from '@fastify/cors'
 
 async function handleCors (ctx, options = {}) {
-  const { defaultsDeep } = this.lib.aneka
+  const { defaultsDeep } = this.app.lib.aneka
   if (options === false) return this.log.warn('middlewareDisabled%s', 'cors')
   const opts = defaultsDeep(options, this.app.waibu.config.cors)
   await ctx.register(cors, opts)

package/lib/webapp-scope/handle-helmet.js

@@ -1,7 +1,7 @@
 import helmet from '@fastify/helmet'
 
 async function handleHelmet (ctx, options = {}) {
-  const { defaultsDeep } = this.lib.aneka
+  const { defaultsDeep } = this.app.lib.aneka
   if (options === false) return this.log.warn('middlewareDisabled%s', 'helmet')
   const opts = defaultsDeep(options, this.app.waibu.config.helmet)
   await ctx.register(helmet, opts)

package/lib/webapp-scope/handle-multipart-body.js

@@ -6,7 +6,7 @@ const pump = promisify(pipeline)
 
 async function onFileHandler () {
   const { getPluginDataDir } = this.app.bajo
-  const { fs } = this.lib
+  const { fs } = this.app.lib
   const dir = `${getPluginDataDir('waibu')}/upload`
   return async function (part) {
     // 'this' is the fastify context here
@@ -18,8 +18,8 @@ async function onFileHandler () {
 
 async function handleMultipartBody (ctx, options = {}) {
   const { importPkg } = this.app.bajo
-  const { defaultsDeep, isSet } = this.lib.aneka
-  const { isArray, map, trim, isPlainObject, isEmpty } = this.lib._
+  const { defaultsDeep, isSet } = this.app.lib.aneka
+  const { isArray, map, trim, isPlainObject, isEmpty } = this.app.lib._
   const parseVar = await importPkg('bajo:dotenv-parse-variables')
   if (options === false) return this.log.warn('middlewareDisabled%s', 'multipart')
   const opts = defaultsDeep(options, this.app.waibu.config.multipart)

package/lib/webapp-scope/handle-rate-limit.js

@@ -1,8 +1,8 @@
 import rateLimit from '@fastify/rate-limit'
 
 async function handleRateLimit (ctx, options = {}) {
-  const { cloneDeep } = this.lib._
-  const { defaultsDeep } = this.lib.aneka
+  const { cloneDeep } = this.app.lib._
+  const { defaultsDeep } = this.app.lib.aneka
   if (options === false) return this.log.warn('middlewareDisabled%s', 'rateLimit')
   const opts = defaultsDeep(options, this.app.waibu.config.rateLimit)
   await ctx.register(rateLimit, cloneDeep(opts))

package/lib/webapp-scope/is-route-disabled.js

@@ -5,14 +5,18 @@ function santizeMethods (methods = '*') {
 }
 
 async function isRouteDisabled (url, method, matchers = []) {
-  const { outmatch } = this.lib
-  const { isString, intersection, cloneDeep } = this.lib._
+  const { outmatch } = this.app.lib
+  const { isString, intersection, cloneDeep } = this.app.lib._
   const items = []
   for (let m of cloneDeep(matchers)) {
     if (isString(m)) m = { path: m }
-    m.path = this.app.waibu.routePath(m.path)
-    m.methods = santizeMethods(m.methods)
-    items.push(m)
+    try {
+      m.path = this.app.waibu.routePath(m.path)
+      m.methods = santizeMethods(m.methods)
+      items.push(m)
+    } catch (err) {
+      throw this.error(`${m.path}: ${err.message}`)
+    }
   }
   const matcher = items.find(i => {
     const isMatch = outmatch(i.path)

package/lib/webapp-scope/merge-route-hooks.js

@@ -1,6 +1,6 @@
 async function mergeRouteHooks (def, withHandler = true) {
-  const { last, isFunction } = this.lib._
-  const { hookTypes } = this.app.waibu
+  const { last, isFunction } = this.app.lib._
+  const { hookTypes } = this.app.pluginClass.waibu
   const hooks = [...hookTypes]
   const me = this
   if (withHandler) hooks.push('handler')

package/lib/webapp-scope/route-hook.js

@@ -1,7 +1,7 @@
 async function routeHook (ns) {
   const ctx = this.app[ns].instance
   const { runHook } = this.app.bajo
-  const { hookTypes } = this.app.waibu
+  const { hookTypes } = this.app.pluginClass.waibu
   for (const hook of hookTypes) {
     ctx.addHook(hook, async function (...args) {
       args.push(this)

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "waibu",
-  "version": "1.2.12",
+  "version": "2.0.1",
   "description": "Web Framework for Bajo",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build-doc": "jsdoc -c .jsdoc.conf.json",
+    "test": "mocha"
   },
   "type": "module",
   "bajo": {
@@ -47,5 +48,9 @@
     "fastify-no-icon": "^7.0.0",
     "query-string": "^9.1.1",
     "waibu-fastify-static": "^1.1.0"
+  },
+  "devDependencies": {
+    "clean-jsdoc-theme": "^4.3.0",
+    "jsdoc-plugin-intersection": "^1.0.4"
   }
 }

package/wiki/CONFIG.md

@@ -0,0 +1,45 @@
+# Config Object
+
+| Key Name | Type | Default | Description |
+| ------- | ---- | ----- | ----------- |
+| ```server``` | ```object``` | | |
+|     ```host``` | ```string``` | ```127.0.0.1``` | |
+|     ```port``` | ```number``` | ```7777``` | |
+| ```factory``` | ```object``` | | [Fastify Server](https://fastify.dev/docs/latest/Reference/Server) factory options |
+|     ```trustProxy``` | ```boolean``` | ```true``` | |
+|     ```bodyLimit``` | ```number``` | ```10485760``` | |
+|     ```pluginTimeout``` | ```number``` | ```30000``` | |
+| ```deferLog``` | ```boolean``` | ```false``` | Set ```true``` to defer log at Fastify onResponse |
+| ```prefixVirtual``` | ```string``` | ```~``` | Virtual route prefix to use |
+| ```printRoutes``` | ```boolean``` | ```true``` | Print routes on startup |
+| ```cors``` | ```object``` | | Defaults to [Fastify Cors](https://github.com/fastify/fastify-cors) options |
+| ```compress``` | ```object``` | | Defaults to [Fastify Compress](https://github.com/fastify/fastify-compress) options |
+| ```helmet``` | ```object``` | | Defaults to [Fastify Helmet](https://github.com/fastify/fastify-helmet) options |
+| ```rateLimit``` | ```object``` | | Defaults to [Fastify Rate Limit](https://github.com/fastify/fastify-rate-limit) options |
+| ```multipart``` | ```object``` | | Defaults to [Fastify Multipart](https://github.com/fastify/fastify-multipart) options |
+|     ```attachFieldsToBody``` | ```boolean``` | ```true``` | |
+|     ```limits``` | ```object``` | | |
+|         ```parts``` | ```number``` | ```100``` | |
+| ```noIcon``` | ```boolean``` | ```true``` | |
+| ```underPressure``` | ```object``` | | Defaults to [Fastify Under Pressure](https://github.com/fastify/fastify-under-pressure) options |
+| ```forwardOpts``` | ```object``` | | Options for route forward |
+|     ```disableRequestLogging``` | ```boolean``` | ```true``` | |
+|     ```undici``` | ```object``` | | Defaults to [Undici](https://github.com/nodejs/undici) options |
+|         ```connections``` | ```number``` | ```128``` | |
+|         ```pipelining``` | ```number``` | ```1``` | |
+|         ```keepAliveTimeout``` | ```number``` | ```60000``` | |
+|         ```tls``` | ```object``` | | |
+|             ```rejectUnauthorized``` | ```boolean``` | ```false``` | |
+| ```qsKey``` | ```object``` | | Query string keys used to build model/database filter |
+|     ```bbox``` | ```string``` | ```bbox``` | Key to use for bbox setting |
+|     ```bboxLatField``` | ```string``` | ```bboxLatField``` | Key to use to determine bbox's latitude |
+|     ```bboxLngField``` | ```string``` | ```bboxLngField``` | Key to use to determine bbox's longitude |
+|     ```query``` | ```string``` | ```query``` | Key to use for query |
+|     ```match``` | ```string``` | ```match``` | Key to enter fulltext matching |
+|     ```skip``` | ```string``` | ```skip``` | Key to skip page |
+|     ```page``` | ```string``` | ```page``` | Key to go to page number |
+|     ```limit``` | ```string``` | ```limit``` | Key to limit model per page |
+|     ```sort``` | ```string``` | ```sort``` | Key to sort model |
+|     ```fields``` | ```string``` | ```fields``` | Key to show model fields |
+|     ```lang``` | ```string``` | ```lang``` | Key for language setting |
+

package/wiki/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Thanks very much to everyone who wants to join as a contributor, but I have committed to devoting 100% of my time to this project. Therefore, I'm currently unable to accept pull requests from anyone until the project is large enough for me to manage it independently.
+
+However, I am available if you encounter any bugs that require immediate fixes. Please report your issues in a GitHub issue, and I'll try to address them promptly. I'm also open to criticism and suggestions for improvements or requests for new features.

package/wiki/DEV-GUIDE.md

@@ -0,0 +1 @@
+# Developer Guide

package/wiki/ECOSYSTEM.md

@@ -0,0 +1,19 @@
+# Ecosystem
+
+| Package | Docs | NS | Alias | Description |
+| ------- | ---- | -- | ----- | ----------- |
+| [waibu](https://github.com/ardhi/waibu) | [Docs](https://ardhi.github.io/waibu) | waibu | w |Waibu Web Framework |
+| [waibu-admin](https://github.com/ardhi/waibu-admin) | [Docs](https://ardhi.github.io/waibu-admin) | waibuAdmin | wa | Waibu Admin |
+| [waibu-alpinejs](https://github.com/ardhi/waibu-alpinejs) | [Docs](https://ardhi.github.io/waibu-alpinejs) | waibuAlpinejs | walp | Alpine.js Support |
+| [waibu-blu](https://github.com/ardhi/waibu-blu) | [Docs](https://ardhi.github.io/waibu-blu) | waibuBlu | wblu | Blu theme |
+| [waibu-bootstrap](https://github.com/ardhi/waibu-bootstrap) | [Docs](https://ardhi.github.io/waibu-bootstrap) | waibuBootstrap | wbs | Bootstrap Support |
+| [waibu-bootstrap-icons](https://github.com/ardhi/waibu-bootstrap-icons) | [Docs](https://ardhi.github.io/waibu-bootstrap-icons) | waibuBootstrapIcons | wbsi | Bootstrap Icons Support |
+| [waibu-bootswatch](https://github.com/ardhi/waibu-bootswatch) | [Docs](https://ardhi.github.io/waibu-bootswatch) | waibuBootswatch | wbw | Bootswatch Support |
+| [waibu-db](https://github.com/ardhi/waibu-db) | [Docs](https://ardhi.github.io/waibu-db) | waibuDb | wdb | Database helper |
+| [waibu-extra](https://github.com/ardhi/waibu-extra) | [Docs](https://ardhi.github.io/waibu-extra) | waibuExtra | wx | Most used 3rd party libs |
+| [waibu-maps](https://github.com/ardhi/waibu-maps) | [Docs](https://ardhi.github.io/waibu-maps) | waibuMaps | wmaps | Maps Support |
+| [waibu-mpa](https://github.com/ardhi/waibu-mpa) | [Docs](https://ardhi.github.io/waibu-mpa) | waibuMpa | wmpa | Multi pages app |
+| [waibu-phosphor](https://github.com/ardhi/waibu-phosphor) | [Docs](https://ardhi.github.io/waibu-phosphor) | waibuPhosphor | wpp | Phosphoricons Support |
+| [waibu-rest-api](https://github.com/ardhi/waibu-rest-api) | [Docs](https://ardhi.github.io/waibu-rest-api) | waibuRestApi | wra | Rest API |
+| [waibu-static](https://github.com/ardhi/waibu-static) | [Docs](https://ardhi.github.io/waibu-static) | waibuStatic | wstatic | Static asset |
+| [waibu-swagger](https://github.com/ardhi/waibu-swagger) | [Docs](https://ardhi.github.io/waibu-swagger) | waibuSwagger | wswagger | Rest API Documentation |

package/wiki/GETTING-STARTED.md

@@ -0,0 +1,76 @@
+# Getting Started
+
+> If you're new to the [Waibu Web Framework](https://ardhi.github.io/waibu), we recommend you to read and follow along with [Bajo Tutorial](https://ardhi.github.io/bajo/tutorial-01-getting-started.html) and [Dobo Tutorial](https://ardhi.github.io/dobo/tutorial-01-getting-started.html) first, as this document is the continuation of them
+
+Bajo also has a sub-framework for serving the web called [Waibu](https://ardhi.github.io/waibu).
+
+[Fastify](https://fastify.dev) and its ecosystem have been chosen as the web engine. Fastify is known to be one of the fastest, most solid, and robust web frameworks available for Node.js. Waibu wraps Fastify and its plugins to work like the Bajo plugin system and introduces several methods to make working with Fastify easier and more enjoyable.
+
+To install Waibu and its dependencies, do this:
+
+```bash
+$ npm install waibu bajo-extra
+```
+
+and add ```waibu``` and ```bajo-extra``` to ```data/config/.plugins``` file.
+
+By default, Waibu listens on host ```127.0.0.1``` and port ```7771```, so you can open your favorite browser and point it to the URL ```http://localhost:7771```.
+
+A web framework is a very broad topic on its own. To make it more manageable, Waibu introduces the concept of a web app: a normal Bajo plugin that extends Waibu by providing a very specific task.
+
+### Static Resources
+
+The first web app to note is the one that serves static resources, [waibu-static](https://github.com/ardhi/waibu-static). Installation is very straightforward:
+
+```
+$ npm install waibu-static
+```
+
+and again, don't forget to add ```waibu-static``` to ```data/config/.plugins``` file.
+
+#### Static Assets
+
+This plugin serves static assets:
+- With the route path ```/asset/{ns-prefix}/*```.
+- Static assets are served from the ```{plugin-dir}/extend/waibuStatic/asset``` directory.
+- Where ```{ns-prefix}``` is a prefix string defined by its corresponding plugin. If this prefix is missing, it defaults to the plugin's alias.
+- And ```{plugin-dir}``` is the plugin's base directory.
+
+Now, create the ```main/extend/waibuStatic/asset``` directory and add some static assets to it. For example, let's create ```main/extend/waibuStatic/asset/hello.txt``` and add some text in it.
+
+When you restart your app, your screen should show you a bunch of logs like these:
+
+```bash
+$ node index.js --log-level=trace
+...
+2025-09-19T01:09:42.338Z +11ms INFO: waibu Server is ready
+2025-09-19T01:09:42.346Z +8ms TRACE: waibu Loaded routes
+2025-09-19T01:09:42.346Z +0ms TRACE: waibu - /asset* (OPTIONS)
+2025-09-19T01:09:42.347Z +1ms TRACE: waibu - /asset/main/* (HEAD|GET)
+2025-09-19T01:09:42.347Z +0ms TRACE: waibu - /asset/static/* (HEAD|GET)
+2025-09-19T01:09:42.348Z +1ms TRACE: waibu - /asset/~/bajo/dayjs/* (HEAD|GET)
+...
+
+```
+
+If you visit ```http://localhost:7771/asset/main/hello.txt```, you'll get the same exact content you just added.
+
+#### Virtual Assets
+
+In the app logs above, you might be wondering what route paths starting with ```/asset/~/{ns}``` are all about. In ```waibu-static``` terms, it's called virtual assets. It's a way to export any directory within a plugin to be served as static assets.
+
+Imagine you're writing a plugin that needs a specific package called ```hybrid-pkg``` from npm, and your frontend needs the exact same package. Without virtual assets, you would have to copy the exported files or directory to your plugin's asset directory. With virtual assets, you only need to do the following:
+
+1. Create ```{your-plugin-ns}/extend/waibuStatic/virtual.json```
+2. Enter the following items into the file:
+   ```json
+   [{
+     "prefix": "hybrid-pkg",
+     "root": "node_modules/hybrid-pkg/dist"
+   }]
+   ```
+   The above statement instructs virtual assets to create the route path ```/asset/~/{your-plugin-prefix}/hybrid-pkg/*``` that is mapped to ```{your-plugin-dir}/node_modules/hybrid-pkg/dist```
+3. Restart your app
+
+Now you can use the same resource for frontend. Your request will be in the form of ```http://localhost:7771/asset/~/{your-plugin-prefix}/hybrid-pkg/file.js```
+

package/wiki/USER-GUIDE.md

@@ -0,0 +1 @@
+# User Guide

package/bajo/hook/on-close.js

@@ -1,5 +0,0 @@
-async function onClose () {
-  this.log.info('serverIs%s', this.print.write('closedL'))
-}
-
-export default onClose

package/bajo/hook/on-ready.js

@@ -1,5 +0,0 @@
-async function onReady () {
-  this.log.info('serverIs%s', this.print.write('readyL'))
-}
-
-export default onReady