waibu-mpa 2.15.2 → 2.17.0

package/extend/bajo/hook.js

@@ -0,0 +1,41 @@
+async function checkLang (req, reply) {
+  if (!req.session) return
+  if (req.langDetector) {
+    req.session.lang = req.lang
+    return
+  }
+  if (req.session.lang) req.lang = req.session.lang
+}
+
+async function checkDark (req, reply) {
+  const { isSet } = this.app.lib.aneka
+  const key = this.config.darkMode.qsKey
+  const value = this.config.darkMode.set ?? req.query[key]
+  if (isSet(value)) {
+    req.darkMode = value
+    if (req.session) req.session.darkMode = req.darkMode
+    return
+  }
+  if (isSet(req.session.darkMode)) req.darkMode = req.session.darkMode
+}
+
+async function hook () {
+  return [{
+    level: 9,
+    name: 'waibuMpa:preParsing',
+    handler: async function (req, reply) {
+      const { importModule } = this.app.bajo
+      const attachIntl = await importModule('waibu:/lib/webapp-scope/attach-intl.js')
+      await attachIntl.call(this, this.config.intl.detectors, req, reply)
+      await checkLang.call(this, req, reply)
+      await checkDark.call(this, req, reply)
+    }
+  }, {
+    name: 'waibuMpa.theme:afterInjectScripts',
+    handler: async function ({ items }) {
+      // items.push(`${this.ns}.virtual:/json2csv/json2csv.js`)
+    }
+  }]
+}
+
+export default hook

package/extend/bajoTemplate/template/wmpa.js

@@ -8,8 +8,6 @@ class Wmpa {
     this.prefixMain = '<%= prefix.main %>'
     this.accessTokenUrl = '<%= accessTokenUrl %>'
     this.renderUrl = '<%= renderUrl %>'
-    this.theme = '<%= _meta.theme.name %>'
-    this.iconset = '<%= _meta.iconset.name %>'
     this.apiPrefix = '<%= api.prefix %>'
     this.apiExt = '<%= api.ext %>'
     this.apiHeaderKey = '<%= api.headerKey %>'
@@ -59,6 +57,7 @@ class Wmpa {
   }
 
   init = () => {
+    this.reqId = document.querySelector('meta[name="req-id"]').getAttribute('content')
     window.addEventListener('load', evt => {
       if (window.hljs) window.hljs.highlightAll()
     })
@@ -103,7 +102,7 @@ class Wmpa {
   fetchRender = async (body, qs = {}) => {
     if (_.isArray(body)) body = body.join('\n')
     let url = this.renderUrl + '?'
-    _.forOwn(_.omit(qs, ['theme', 'iconset']), (v, k) => {
+    _.forOwn(qs, (v, k) => {
       url += '&' + k + '=' + v
     })
     const opts = {
@@ -111,8 +110,7 @@ class Wmpa {
       headers: {
         'Content-Type': 'text/plain',
         'X-Referer': window.location.href,
-        'X-Theme': this.theme,
-        'X-Iconset': this.iconset
+        'X-Req-Id': this.reqId
       },
       body
     }

package/extend/waibuMpa/route/component/render.js

@@ -1,12 +1,24 @@
 const component = {
   method: 'POST',
+  noCacheReq: true,
   handler: async function (req, reply) {
+    const { merge, get } = this.app.lib._
     req.referer = req.headers['x-referer']
+    const pageId = req.headers['x-req-id']
     const { ext = '.html' } = req.body
+    let params = req.query
     reply.header('Content-Type', `text/html; charset=${this.config.page.charset}`)
     reply.header('Content-Language', req.lang)
-    const opts = { req, reply, partial: true, ext, theme: req.headers['x-theme'], iconset: req.headers['x-iconset'] }
-    return this.renderString(req.body, req.query, opts)
+    if (pageId) {
+      try {
+        const locals = await this.app.cache.load(`${this.ns}.req:/${pageId}-locals.json`, this.config.reqTtlDur)
+        params = merge({}, locals ?? {}, params)
+      } catch (err) {}
+    }
+    const theme = get(req, 'headers.x-theme', get(params, '_meta.theme.name'))
+    const iconset = get(req, 'headers.x-iconset', get(params, '_meta.iconset.name'))
+    const opts = { pageId, req, reply, partial: true, ext, theme, iconset }
+    return this.renderString(req.body, params, opts)
   }
 }
 

package/extend/waibuMpa/route/wmpa.js

@@ -1,6 +1,7 @@
 const wmpa = {
   url: '/wmpa.js',
   method: 'GET',
+  noCacheReq: true,
   handler: async function (req, reply) {
     const { get, trim, cloneDeep } = this.app.lib._
     const { getPluginPrefix } = this.app.waibu

package/index.js

@@ -43,6 +43,7 @@ async function factory (pkgName) {
             ttlDur: 0,
             urls: []
           },
+          refreshDur: '1d',
           insertWarning: false,
           usePluginTitle: false,
           scriptsAtEndOfBody: true
@@ -136,7 +137,8 @@ async function factory (pkgName) {
         },
         compress: false,
         rateLimit: false,
-        disabled: []
+        disabled: [],
+        reqTtlDur: '1d'
       }
 
       this.configDev = {
@@ -495,23 +497,17 @@ async function factory (pkgName) {
       return output
     }
 
-    renderString = async (text, params = {}, opts = {}) => {
-      const { importModule } = this.app.bajo
-      const buildLocals = await importModule('waibu:/lib/build-locals.js')
-      const locals = await buildLocals.call(this, { tpl: null, params, opts })
+    renderString = async (text, locals = {}, opts = {}) => {
       const ve = this.getViewEngine(opts.ext)
       return await ve.renderString(text, locals, opts)
     }
 
-    render = async (tpl, params = {}, opts = {}) => {
-      const { importModule } = this.app.bajo
-      const buildLocals = await importModule('waibu:/lib/build-locals.js')
-      const locals = await buildLocals.call(this, { tpl, params, opts })
+    render = async (tpl, locals = {}, opts = {}) => {
       const ext = path.extname(tpl)
       if (['.json', '.js', '.css'].includes(ext)) opts.partial = true
       opts.ext = ext
-      const viewEngine = this.getViewEngine(ext)
-      return await viewEngine.render(tpl, locals, opts)
+      const ve = this.getViewEngine(ext)
+      return await ve.render(tpl, locals, opts)
     }
 
     stripHtmlTags = (html, options = {}) => {

package/lib/build-page/inject-elements/meta.js

@@ -11,7 +11,19 @@ async function meta (options) {
   const { sprintf } = this.app.lib
   const { $, theme, req, locals } = options ?? {}
   const { page = {} } = locals
-  let items = []
+  let items = [{
+    tag: 'meta',
+    name: 'req-id',
+    content: req.id
+  }]
+  const refreshDur = get(req, 'routeOptions.config.refreshDur', get(this, 'config.page.refreshDur', 0))
+  if (refreshDur > 0) {
+    items.push({
+      tag: 'meta',
+      httpEquiv: 'Refresh',
+      content: Math.floor(refreshDur / 60) + ''
+    })
+  }
   // meta
   for (const attr of keys(omit(locals.page, [...omitted]))) {
     if (!page[attr]) continue

package/lib/build-page/inject-elements.js

@@ -38,7 +38,7 @@ async function injectElements (options) {
   }
   options.inlineScript = rsc.inlineScript
   options.inlineCss = rsc.inlineCss
-  await runHook(`${this.ns}:beforeBuildPageInjectElement`, options)
+  await runHook(`${this.ns}.injectElement:beforeBuildPage`, options)
   await injectMeta.call(this, options)
   await injectLink.call(this, options)
   await injectCss.call(this, options)

package/lib/build-page.js

@@ -33,7 +33,7 @@ async function buildPage ({ text, locals = {}, opts = {} } = {}) {
   const ns = req.ns
   let $ = cheerio.load(text, this.config.cheerio.loadOptions, false)
   if (partial) $('c\\:page-start, c\\:page-end').remove()
-  await runHook(`${this.ns}:beforeBuildPage${partial ? 'Partial' : ''}`, { $, theme, iconset, req, reply, locals, ns, text })
+  await runHook(`${this.ns}${partial ? '.partial' : ''}:beforeBuildPage`, { $, theme, iconset, req, reply, locals, ns, text })
   await attrsMutation.call(this, { $, el: $.root(), req })
   const cmp = await theme.createComponent({ $, iconset, req, reply, locals: cloneDeep(locals), scriptBlock: reqAsset[req.id].scriptBlock, styleBlock: reqAsset[req.id].styleBlock })
   await replaceTag.call(this, { el: $.root(), cmp, opts })

package/lib/build-routes.js

@@ -1,7 +1,7 @@
 import path from 'path'
 
 export async function build ({ files, pathPrefix, dir, ns, cfg, parent, urlPrefix, subRoute }) {
-  const { defaultsDeep } = this.app.lib.aneka
+  const { defaultsDeep, parseObject } = this.app.lib.aneka
   const { importModule, readJson } = this.app.bajo
   const { isFunction, isPlainObject, pick, last, camelCase, omit } = this.app.lib._
   const { titleize } = this.app.lib.aneka
@@ -20,6 +20,12 @@ export async function build ({ files, pathPrefix, dir, ns, cfg, parent, urlPrefi
     if (isFunction(mod)) mod = [{ handler: mod }]
     else if (isPlainObject(mod)) mod = [mod]
     for (let m of mod) {
+      const mhandler = m.handler // parseObject has problem with function
+      const murl = m.url
+      m = parseObject(omit(m, ['handler', 'url'], { parseValue: true }))
+      m.handler = mhandler
+      m.url = murl
+
       m.url = m.url ?? url
       if (isFunction(m.url)) m.url = await m.url.call(this)
       if (m.redirect) {
@@ -48,6 +54,7 @@ export async function build ({ files, pathPrefix, dir, ns, cfg, parent, urlPrefi
       m.config.xSite = m.xSite
       m.config.ns = ns
       m.config.subNs = ''
+      m.config.noCacheReq = m.noCacheReq
       m.config.title = m.title ?? camelCase(last(m.url.split('/')))
       m.config.subRoute = subRoute
       if (m.cache === true) m.cache = omit(me.config.page.cache, ['urls'])

package/lib/class/component.js

@@ -280,7 +280,7 @@ async function componentFactory () {
      * @returns {Promise<string>} The built sentence.
      */
     buildSentence = async (sentence, params = {}, extra = {}) => {
-      const { get } = this.app.lib._
+      const { get, merge } = this.app.lib._
       if (Array.isArray(sentence)) sentence = sentence.join(' ')
       const { minify, renderString } = this.app.waibuMpa
       if (extra.wrapped) sentence = '<w>' + sentence + '</w>'
@@ -292,7 +292,7 @@ async function componentFactory () {
         theme: get(this, 'theme.name', 'default'),
         iconset: get(this, 'iconset.name', 'default')
       }
-      let html = await renderString(sentence, params, opts)
+      let html = await renderString(sentence, merge({}, this.locals, params), opts)
       if (extra.wrapped) html = html.slice(3, html.length - 4)
       if (extra.minify) html = await minify(html)
       return html

package/lib/class/view-engine.js

@@ -24,6 +24,7 @@ async function viewEngineFactory () {
     }
 
     renderString = async (content, locals = {}, opts = {}) => {
+      locals.tpl = null
       this._applySetting(locals, opts)
       return await this.app.bajoTemplate.renderString(content, locals, opts)
     }

package/lib/decorate.js

@@ -19,8 +19,10 @@ async function isCacheable (req, cachedUrls) {
 }
 
 async function decorate () {
+  const { importModule } = this.app.bajo
+  const buildLocals = await importModule('waibu:/lib/build-locals.js')
   const { importPkg } = this.app.bajo
-  const { isString, cloneDeep, isEmpty } = this.app.lib._
+  const { isString, cloneDeep, isEmpty, get } = this.app.lib._
   const { get: getCache, set: setCache } = this.app.bajoCache ?? {}
   const { outmatch } = this.app.lib
   const { routePath } = this.app.waibu
@@ -46,6 +48,7 @@ async function decorate () {
     mimeType += `; charset=${cfg.page.charset}`
     this.header('Content-Type', mimeType)
     this.header('Content-Language', this.request.lang)
+    this.header('X-Req-Id', this.request.id)
     opts.req = this.request
     opts.reply = this
     for (const item of ['theme', 'iconset']) {
@@ -60,7 +63,11 @@ async function decorate () {
         return cached
       }
     }
-    const result = await me.render(tpl, params, opts)
+    const locals = await buildLocals.call(me, { tpl, params, opts })
+    if (!get(this.request, 'routeOptions.config.noCacheReq')) {
+      await me.app.cache.save(`${me.ns}.req:/${opts.req.id}-locals.json`, locals, me.config.reqTtlDur)
+    }
+    const result = await me.render(tpl, locals, opts)
     if (ttl > 0) await setCache({ key, value: result, ttl })
     if (this.request.session) {
       ext = path.extname(this.request.url)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "waibu-mpa",
-  "version": "2.15.2",
+  "version": "2.17.0",
   "description": "MPA support for Waibu Framework",
   "main": "index.js",
   "scripts": {

package/wiki/CHANGES.md

@@ -1,5 +1,15 @@
 # Changes
 
+## 2026-05-28
+
+- [2.17.0] Change hooks to be written in one ```hook.js``` file
+- [2.17.0] Change model schemas to be written in one ```model.js``` file
+
+## 2026-05-25
+
+- [2.16.0] Add theme & iconset auto detection mechanism
+- [2.16.0] Add page expiration & reload through ```routeOptions.config.refreshDur``` or ```config.page.refreshDur```
+
 ## 2026-05-22
 
 - [2.15.2] Bug fix in ```error-handler.js```

package/extend/bajo/hook/waibu-mpa.theme@after-inject-scripts.js

@@ -1,5 +0,0 @@
-async function waibuMpaThemeAfterInjectScripts ({ items }) {
-  // items.push(`${this.ns}.virtual:/json2csv/json2csv.js`)
-}
-
-export default waibuMpaThemeAfterInjectScripts

package/extend/bajo/hook/waibu-mpa@pre-parsing.js

@@ -1,33 +0,0 @@
-async function checkLang (req, reply) {
-  if (!req.session) return
-  if (req.langDetector) {
-    req.session.lang = req.lang
-    return
-  }
-  if (req.session.lang) req.lang = req.session.lang
-}
-
-async function checkDark (req, reply) {
-  const { isSet } = this.app.lib.aneka
-  const key = this.config.darkMode.qsKey
-  const value = this.config.darkMode.set ?? req.query[key]
-  if (isSet(value)) {
-    req.darkMode = value
-    if (req.session) req.session.darkMode = req.darkMode
-    return
-  }
-  if (isSet(req.session.darkMode)) req.darkMode = req.session.darkMode
-}
-
-const waibuMpaPreParsing = {
-  level: 9,
-  handler: async function (req, reply) {
-    const { importModule } = this.app.bajo
-    const attachIntl = await importModule('waibu:/lib/webapp-scope/attach-intl.js')
-    await attachIntl.call(this, this.config.intl.detectors, req, reply)
-    await checkLang.call(this, req, reply)
-    await checkDark.call(this, req, reply)
-  }
-}
-
-export default waibuMpaPreParsing