waibu-mpa 1.0.0 → 1.0.2

package/README.md

@@ -1,22 +1,29 @@
-# wakatobi-mpa
+# waibu-mpa
 
-Plugin name: **wakatobiMpa**, alias: **wktbmpa**
+Plugin name: **waibuMpa**, alias: **wmpa**
 
-![GitHub package.json version](https://img.shields.io/github/package-json/v/ardhi/wakatobi-mpa) ![NPM Version](https://img.shields.io/npm/v/wakatobi-mpa)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/ardhi/waibu-mpa) ![NPM Version](https://img.shields.io/npm/v/waibu-mpa)
 
 > <br />**Attention**: I do NOT accept any pull request at the moment, thanks!<br /><br />
 
-Multi Pages App (MPA) for [Wakatobi Framework](https://github.com/ardhi/wakatobi)
+Multi Pages App (MPA) for [Waibu Framework](https://github.com/ardhi/waibu)
 
 ## Installation
 
 Goto your ```<bajo-base-dir>``` and type:
 
 ```bash
-$ npm install wakatobi-mpa
+$ npm install waibu-mpa
 ```
 
-Now open your ```<bajo-data-dir>/config/.plugins``` and put ```wakatobi-mpa``` in it
+Now open your ```<bajo-data-dir>/config/.plugins``` and put ```waibu-mpa``` in it
+
+## Documentation
+
+- [Class Instance](docs/instance.md)
+- [Configuration](docs/configuration.md)
+- [App Hook](docs/hook.md)
+- [Component](docs/component.md)
 
 ## License
 

package/bajo/.alias

@@ -0,0 +1 @@
+wmpa

package/bajo/config-dev.json

@@ -0,0 +1,6 @@
+{
+  "minifier": false,
+  "page": {
+    "insertWarning": true
+  }
+}

package/bajo/config-prod.json

@@ -0,0 +1,14 @@
+{
+  "viewEngine": {
+    "cacheMaxAge": 300
+  },
+  "theme": {
+    "component": {
+      "unknownTag": "remove",
+      "cacheMaxAge": 300
+    }
+  },
+  "prettier": false,
+  "compress": {},
+  "rateLimit": {}
+}

package/bajo/config.json

@@ -1,35 +1,82 @@
 {
-  "alias": "wbmpa",
   "title": "Multi Page Webapp",
-  "prefix": "",
-  "mountAppAsRoot": true,
-  "charset": "utf-8",
+  "waibu": {
+    "prefix": ""
+  },
+  "mountMainAsRoot": true,
+  "page": {
+    "charset": "utf-8",
+    "cacheMaxAge": 0,
+    "insertWarning": false
+  },
   "darkMode": {
-    "preset": "light",
-    "qsKey": "dark"
+    "default": false,
+    "qsKey": "dark-mode"
   },
   "i18n": {
     "detectors": ["qs"],
     "defaultNs": ["dobo", "waibuMpa"]
   },
+  "session": {
+    "secret": "f703a74b884b539e78c642a5369fe538",
+    "cookieName": "sid",
+    "cookie": {
+      "secure": "auto"
+    },
+    "saveUninitialized": false
+  },
   "emoji": true,
   "viewEngine": {
-    "default": "default",
-    "cacheMaxAge": 300
+    "cacheMaxAge": 0,
+    "layout": {
+      "default": "waibuMpa:/default.html",
+      "fallback": true
+    }
   },
   "theme": {
-    "autoInsert": ["css", "meta", "scripts"],
+    "default": null,
+    "autoInsert": {
+      "css": true,
+      "meta": true,
+      "scripts": true,
+      "inlineScript": true,
+      "inlineCss": true
+    },
     "component": {
-      "insertCtag": false,
+      "unknownTag": "comment",
       "defaultTag": "div",
-      "cacheMaxAge": 300
+      "cacheMaxAge": 0
+    }
+  },
+  "iconset": {
+    "default": null,
+    "autoInsert": {
+      "css": true,
+      "scripts": true,
+      "inlineScript": true,
+      "inlineCss": true
+    }
+  },
+  "concatResource": {
+    "cacheMaxAge": 0,
+    "excluded": [],
+    "css": false,
+    "scripts": false
+  },
+  "cheerio": {
+    "loadOptions": {
+      "xml": {
+        "xmlMode": false,
+        "decodeEntities": false,
+        "recognizeSelfClosing": true
+      }
     }
   },
   "prettier": {
     "parser": "html",
-    "printWidth": 1000
+    "printWidth": 120
   },
-  "minify": {
+  "minifier": {
     "removeAttributeQuotes": true,
     "removeComments": true,
     "removeCommentsFromCDATA": true,
@@ -46,19 +93,13 @@
     "tableHeadClass": "",
     "tableBodyClass": "table-group-divider"
   },
-  "home": {
-    "action": "redirect",
-    "route": true
-  },
-  "multipart": {
-  },
+  "multipart": {},
   "cors": {},
   "helmet": {
     "contentSecurityPolicy": false
   },
   "compress": false,
   "rateLimit": false,
-  "traceNoTemplate": false,
   "disabled": [],
-  "dependencies": ["waibu", "waibu-static"]
+  "dependencies": ["waibu", "waibu-static", "bajo-markdown"]
 }

package/bajo/hook/dobo.wmpa-session@before-sanitize-schema.js

@@ -0,0 +1,10 @@
+async function doboWmpaSessionBeforeSanitizeSession (schema) {
+  const { find } = this.app.bajo.lib._
+
+  const dobo = this.app.dobo
+  let conn = find(dobo.connections, { name: schema.connection })
+  if (!conn) conn = find(dobo.connections, { name: 'memory' })
+  if (conn) schema.connection = conn.name
+}
+
+export default doboWmpaSessionBeforeSanitizeSession

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

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

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

@@ -1,12 +1,35 @@
-const waibuMpaPreHandler = {
+async function checkLang (req, reply) {
+  if (!req.session) return
+  if (req.langDetector) {
+    req.session.lang = req.lang
+    await req.i18n.changeLanguage(req.session.lang)
+    return
+  }
+  if (req.session.lang) req.lang = req.session.lang
+  await req.i18n.changeLanguage(req.lang)
+}
+
+async function checkDark (req, reply) {
+  const { isSet } = this.app.bajo
+  const key = this.config.darkMode.qsKey
+  const value = 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 (ctx, req, reply) {
+  handler: async function (req, reply) {
     const { importModule } = this.app.bajo
     const attachI18N = await importModule('waibu:/lib/webapp-scope/attach-i18n.js')
     await attachI18N.call(this, this.config.i18n.detectors, req, reply)
-    // darkmode
-    // if (this.config.darkMode.qsKey) req.dark = req.query[this.config.darkMode.qsKey] ? 'dark' : 'light'
+    await checkLang.call(this, req, reply)
+    await checkDark.call(this, req, reply)
   }
 }
 
-export default waibuMpaPreHandler
+export default waibuMpaPreParsing

package/bajo/init.js

@@ -0,0 +1,7 @@
+async function init () {
+  const { trim } = this.app.bajo.lib._
+  this.config.waibu = this.config.waibu ?? {}
+  this.config.waibu.prefix = trim(this.config.waibu.prefix, '/')
+}
+
+export default init

package/bajo/method/attr-to-array.js

@@ -1,6 +1,8 @@
 function attrToArray (text = '', delimiter = ' ') {
-  const { map, trim, without } = this.app.bajo.lib._
-  return without(map(text.split(delimiter), i => trim(i)), '')
+  const { map, trim, without, isArray } = this.app.bajo.lib._
+  if (text === true) text = ''
+  if (isArray(text)) text = text.join(delimiter)
+  return without(map(text.split(delimiter), i => trim(i)), '', undefined, null)
 }
 
 export default attrToArray

package/bajo/method/attr-to-object.js

@@ -1,6 +1,8 @@
 function attrToObject (text = '', delimiter = ';', kvDelimiter = ':') {
-  const { camelCase } = this.app.bajo.lib._
+  const { camelCase, isPlainObject } = this.app.bajo.lib._
   const result = {}
+  if (isPlainObject(text)) text = this.objectToAttr(text)
+  if (text.slice(1, 3) === '%=') return text
   const array = this.attrToArray(text, delimiter)
   array.forEach(item => {
     const [key, val] = this.attrToArray(item, kvDelimiter)

package/bajo/method/attribs/parse.js

@@ -0,0 +1,28 @@
+function attribsParse (text = '', delimiter = ' ', kvDelimiter = '=', camelCasedKey = true) {
+  const { trim, camelCase, map, isPlainObject, forOwn } = this.app.bajo.lib._
+  let attrs = []
+  if (isPlainObject(text)) {
+    forOwn(text, (v, k) => {
+      attrs.push(`${k}${kvDelimiter}"${v}"`)
+    })
+  } else attrs = map(text.split(delimiter), t => trim(t))
+  const result = {}
+  for (const attr of attrs) {
+    let [k, ...v] = map(attr.split(kvDelimiter), a => trim(a))
+    v = v.join(kvDelimiter)
+    v = v.slice(1, v.length - 1)
+    if (v === 'undefined') continue
+    if (k !== 'content' && v === '') v = true
+    // check for retainAttrKey on ALL plugins
+    let retain = false
+    for (const name of this.app.bajo.pluginNames) {
+      const plugin = this.app[name]
+      if (plugin && plugin.retainAttrKey && plugin.retainAttrKey(k)) retain = true
+    }
+    if (!retain && camelCasedKey) k = camelCase(k)
+    result[k] = v
+  }
+  return result
+}
+
+export default attribsParse

package/bajo/method/attribs/stringify.js

@@ -0,0 +1,27 @@
+function attribsStringify (obj = {}, kebabCasedKey = true) {
+  const { isSet } = this.app.bajo
+  const { forOwn, kebabCase, isArray, isPlainObject, isEmpty } = this.app.bajo.lib._
+  const attrs = []
+  forOwn(obj, (v, k) => {
+    let retain = false
+    for (const name of this.app.bajo.pluginNames) {
+      const plugin = this.app[name]
+      if (plugin && plugin.retainAttrKey && plugin.retainAttrKey(k)) retain = true
+    }
+    if (retain) {
+      if (v === true) attrs.push(k)
+      else attrs.push(`${k}="${v}"`)
+      return undefined
+    }
+    if (kebabCasedKey) k = kebabCase(k)
+    if (!isSet(v)) return undefined
+    if (['class', 'style'].includes(k) && isEmpty(v)) return undefined
+    if (isArray(v)) v = this.arrayToAttr(v)
+    if (isPlainObject(v)) v = this.objectToAttr(v)
+    if (k !== 'content' && v === true) attrs.push(k)
+    else attrs.push(`${k}="${v}"`)
+  })
+  return attrs.join(' ')
+}
+
+export default attribsStringify

package/bajo/method/base64-json-decode.js

@@ -0,0 +1,5 @@
+function base64JsonDecode (data = 'e30=') {
+  return JSON.parse(Buffer.from(data, 'base64'))
+}
+
+export default base64JsonDecode

package/bajo/method/base64-json-encode.js

@@ -0,0 +1,5 @@
+function base64JsonEncode (data) {
+  return Buffer.from(JSON.stringify(data)).toString('base64')
+}
+
+export default base64JsonEncode

package/bajo/method/build-url.js

@@ -0,0 +1,27 @@
+function buildUrl ({ exclude = [], prefix = '?', base, url = '', params = {} }) {
+  const { qs } = this.app.waibu
+  const { forOwn, omit, isEmpty } = this.app.bajo.lib._
+  const qsKey = this.app.waibu.config.qsKey
+  let path
+  let hash
+  let query
+  [path = '', hash = ''] = url.split('#')
+  if (hash.includes('?')) [hash, query] = hash.split('?')
+  else [path, query] = path.split('?')
+  query = qs.parse(query) ?? {}
+  forOwn(params, (v, k) => {
+    const key = qsKey[k] ?? k
+    query[key] = v
+  })
+  query = prefix + qs.stringify(omit(query, exclude))
+  if (!isEmpty(hash)) hash = '#' + hash
+  if (!base) return path + query + hash
+  const parts = path.split('/')
+  if (base) {
+    parts.pop()
+    parts.push(base)
+  }
+  return parts.join('/') + query + hash
+}
+
+export default buildUrl

package/bajo/method/get-app-title.js

@@ -0,0 +1,9 @@
+function getAppTitle (name) {
+  const { getPlugin } = this.app.bajo
+  const { get } = this.app.bajo.lib._
+  const plugin = getPlugin(name, true)
+  if (!plugin) return
+  return get(plugin, 'config.waibu.title', plugin.title)
+}
+
+export default getAppTitle

package/bajo/method/get-resource.js

@@ -0,0 +1,12 @@
+const subNses = ['layout', 'template', 'partial']
+
+function getResource (name) {
+  const { ns, path, subNs, subSubNs, qs } = this.app.bajo.breakNsPath(name)
+  const plugin = this.app.bajo.getPlugin(ns)
+  const dir = `${plugin.dir.pkg}/waibuMpa`
+  if (!subNses.includes(subNs)) throw this.error('Unknown resource \'%s\'', name)
+  const fullPath = subSubNs ? `${dir}/${subSubNs}/${subNs}${path}` : `${dir}/${subNs}${path}`
+  return { ns, subNs, subSubNs, path, qs, fullPath }
+}
+
+export default getResource

package/bajo/method/group-attrs.js

@@ -0,0 +1,45 @@
+function groupAttrs (attribs = {}, keys = [], removeEmpty = true) {
+  const { isString, filter, omit, kebabCase, camelCase, isEmpty } = this.app.bajo.lib._
+  if (isString(keys)) keys = [keys]
+  const attr = { _: {} }
+  for (const a in attribs) {
+    for (const k of keys) {
+      if (a === k) {
+        attr._[k] = attribs[a]
+        continue
+      }
+      attr[k] = attr[k] ?? {}
+      attr[k].class = attr[k].class ?? []
+      attr[k].style = attr[k].style ?? {}
+      const _k = kebabCase(k)
+      const name = camelCase(kebabCase(a).slice(_k.length + 1))
+      if (!kebabCase(a).startsWith(k + '-')) {
+        if (!keys.includes(a)) {
+          attr._[a] = attribs[a]
+          if (a === 'class' && isString(attribs[a])) attr._.class = this.attrToArray(attr._.class)
+          if (a === 'style' && isString(attribs[a])) attr._.style = this.attrToObject(attr._.style)
+        }
+        continue
+      }
+      attr[k][name] = attribs[a]
+      if (name === 'class' && isString(attribs[a])) attr[k].class = this.attrToArray(attr[k].class)
+      if (name === 'style' && isString(attribs[a])) attr[k].style = this.attrToObject(attr[k].style)
+    }
+  }
+  const deleted = filter(Object.keys(attr._), m => {
+    let match
+    m = kebabCase(m)
+    for (const k of keys) {
+      if (m.startsWith(k + '-')) match = true
+    }
+    return match
+  })
+  attr._ = omit(attr._, deleted)
+  for (const k of keys) {
+    const item = attr[k]
+    if (removeEmpty && !attr._[k] && Object.keys(item).length === 2 && isEmpty(item.class) && isEmpty(item.style)) delete attr[k]
+  }
+  return attr
+}
+
+export default groupAttrs

package/bajo/method/html-tags.js

@@ -0,0 +1,6 @@
+// taken from: https://stackoverflow.com/questions/52928550/js-get-list-of-all-available-standard-html-tags
+
+const tags = 'a,abbr,address,area,article,aside,audio,b,base,bdi,bdo,blockquote,body,br,button,canvas,caption,cite,code,col,colgroup,data,datalist,dd,del,details,dfn,dialog,div,dl,dt,em,embed,fieldset,figcaption,figure,footer,form,h1,h2,h3,h4,h5,h6,head,header,hgroup,hr,html,i,iframe,img,input,ins,kbd,label,legend,li,link,main,map,mark,menu,meta,meter,nav,noscript,object,ol,optgroup,option,output,p,param,picture,pre,progress,q,rp,rt,ruby,s,samp,script,section,select,slot,small,source,span,strong,style,sub,summary,sup,table,tbody,td,template,textarea,tfoot,th,thead,time,title,tr,track,u,ul,var,video,wbr'
+const htmlTags = tags.split(',')
+
+export default htmlTags