waibu-db 2.0.0 → 2.0.1

package/extend/waibuBootstrap/theme/component/factory/echarts.js

@@ -28,7 +28,7 @@ async function echarts () {
 
     _build = ({ setting = {}, onLoad = [] } = {}) => {
       const { jsonStringify } = this.plugin.app.waibuMpa
-      const { merge, isArray } = this.plugin.app.bajo.lib._
+      const { merge, isArray } = this.app.lib._
       if (!isArray(onLoad)) onLoad = [onLoad]
       const option = merge({}, this.defSetting, this.setting, setting)
       this.component.addScriptBlock('alpineInit', `

package/extend/waibuBootstrap/theme/component/factory/form.js

@@ -5,7 +5,7 @@ async function form () {
 
   return class WdbForm extends WdbBase {
     build = async () => {
-      const { get, find, filter, forOwn, isEmpty } = this.plugin.lib._
+      const { get, find, filter, forOwn, isEmpty } = this.app.lib._
       const { base64JsonEncode } = this.plugin.app.waibuMpa
       const schema = get(this, 'component.locals.schema', {})
       const body = []

package/extend/waibuBootstrap/theme/component/factory/pagination.js

@@ -1,7 +1,7 @@
 import wdbBase from '../wdb-base.js'
 
 export function getUrlOpts (params = {}) {
-  const { get } = this.plugin.app.bajo.lib._
+  const { get } = this.app.lib._
   return {
     params,
     excludes: [
@@ -18,7 +18,7 @@ async function pagination () {
     build = async () => {
       const { req } = this.component
       const { attrToObject, paginationLayout, groupAttrs } = this.plugin.app.waibuMpa
-      const { get, isNumber } = this.plugin.app.bajo.lib._
+      const { get, isNumber } = this.app.lib._
       const schema = get(this, 'component.locals.schema', {})
       if (schema.view.disabled.includes('find')) {
         this.params.html = ''

package/extend/waibuBootstrap/theme/component/factory/query.js

@@ -7,7 +7,7 @@ async function query () {
     build = async () => {
       const { generateId } = this.plugin.app.bajo
       const { jsonStringify } = this.plugin.app.waibuMpa
-      const { find, get, without, isEmpty, filter, upperFirst } = this.plugin.app.bajo.lib._
+      const { find, get, without, isEmpty, filter, upperFirst } = this.app.lib._
       const qsKey = this.plugin.app.waibu.config.qsKey
       const schema = get(this, 'component.locals.schema', {})
       if (schema.view.disabled.includes('find')) {

package/extend/waibuBootstrap/theme/component/factory/recs-info.js

@@ -8,7 +8,7 @@ async function recsInfo () {
     build = async () => {
       const { req } = this.component
       const { attrToObject, groupAttrs, attrToArray } = this.plugin.app.waibuMpa
-      const { get, isEmpty, omit, merge } = this.plugin.app.bajo.lib._
+      const { get, isEmpty, omit, merge } = this.app.lib._
       const schema = get(this, 'component.locals.schema', {})
       if (schema.view.disabled.includes('find')) {
         this.params.html = ''

package/extend/waibuBootstrap/theme/component/factory/table.js

@@ -5,7 +5,7 @@ async function table () {
 
   return class WdbTable extends WdbBase {
     isRightAligned = (field, schema) => {
-      const { get, find } = this.plugin.app.bajo.lib._
+      const { get, find } = this.app.lib._
       const prop = find(schema.properties, { name: field })
       if (!prop) return false
       let value = get(schema, 'view.alignEnd', []).includes(field)
@@ -15,12 +15,12 @@ async function table () {
 
     isNoWrap = (field, schema, bodyNowrap) => {
       if (bodyNowrap) return true
-      const { get } = this.plugin.app.bajo.lib._
+      const { get } = this.app.lib._
       return get(schema, 'view.noWrap', []).includes(field)
     }
 
     _defFormatter = async ({ req, key, value, data, schema }) => {
-      const { get, find } = this.plugin.lib._
+      const { get, find } = this.app.lib._
       const { escape } = this.plugin.app.waibu
       const prop = find(schema.properties, { name: key })
       if (!prop) return value
@@ -38,7 +38,7 @@ async function table () {
       const { escape } = this.plugin.app.waibu
       const { formatRecord } = this.plugin.app.waibuDb
       const { attrToArray, groupAttrs } = this.plugin.app.waibuMpa
-      const { get, omit, set, find, isEmpty, without, merge } = this.plugin.lib._
+      const { get, omit, set, find, isEmpty, without, merge } = this.app.lib._
       const group = groupAttrs(this.params.attr, ['body', 'head', 'foot'])
       this.params.attr = group._
       const prettyUrl = this.params.attr.prettyUrl

package/extend/waibuRestApi/route/@model/find.js

@@ -1,5 +1,5 @@
 async function find (req, reply) {
-  const { isSet } = this.lib.aneka
+  const { isSet } = this.app.lib.aneka
   const { parseObject } = this.app.bajo
   let { fields, count } = this.getParams(req)
   let rels = []

package/index.js

@@ -1,11 +1,23 @@
+/**
+ * Plugin factory
+ *
+ * @param {string} pkgName - NPM package name
+ * @returns {class}
+ */
 async function factory (pkgName) {
   const me = this
 
-  return class WaibuDb extends this.lib.Plugin {
+  /**
+   * WaibuDb class
+   *
+   * @class
+   */
+  class WaibuDb extends this.app.pluginClass.base {
+    static alias = 'wdb'
+    static dependencies = ['dobo', 'waibu', 'bajo-queue', 'dobo-extra']
+
     constructor () {
       super(pkgName, me.app)
-      this.alias = 'wdb'
-      this.dependencies = ['dobo', 'waibu', 'bajo-queue', 'dobo-extra']
       this.config = {
         waibu: {
           prefix: 'db',
@@ -28,8 +40,8 @@ async function factory (pkgName) {
 
     exportData = async (params) => {
       const { getPlugin } = this.app.bajo
-      const { get } = this.lib._
-      const { fs } = this.lib
+      const { get } = this.app.lib._
+      const { fs } = this.app.lib
       const { recordUpdate } = this.app.dobo
       const { exportTo } = this.app.doboExtra
       const { downloadDir } = getPlugin('sumba')
@@ -56,11 +68,11 @@ async function factory (pkgName) {
 
     adminMenu = async (locals, req) => {
       const { getPluginPrefix } = this.app.waibu
-      const { pascalCase } = this.lib.aneka
+      const { pascalCase } = this.app.lib.aneka
       const { getAppTitle } = this.app.waibuMpa
-      const { camelCase, map, pick, groupBy, keys, kebabCase, filter, get } = this.lib._
+      const { camelCase, map, pick, groupBy, keys, kebabCase, filter, get } = this.app.lib._
 
-      const prefix = getPluginPrefix(this.name)
+      const prefix = getPluginPrefix(this.ns)
       const schemas = filter(this.app.dobo.schemas, s => {
         const byModelFind = !s.disabled.includes('find')
         let modelDisabled = get(this, `app.${s.ns}.config.waibuAdmin.modelDisabled`)
@@ -94,6 +106,8 @@ async function factory (pkgName) {
       return menu
     }
   }
+
+  return WaibuDb
 }
 
 export default factory

package/lib/crud/add-handler.js

@@ -1,9 +1,9 @@
 async function addHandler ({ req, reply, model, params = {}, template, addOnsHandler, templateDisabled = 'waibuDb.template:/disabled.html', options = {} } = {}) {
-  const { pascalCase } = this.lib.aneka
+  const { pascalCase } = this.app.lib.aneka
   const { recordCreate, recordGet, getSchemaExt } = this.app.waibuDb
   const { buildUrl } = this.app.waibuMpa
-  const { defaultsDeep } = this.lib.aneka
-  const { pick, map, merge, omit, isEmpty } = this.lib._
+  const { defaultsDeep } = this.app.lib.aneka
+  const { pick, map, merge, omit, isEmpty } = this.app.lib._
   const opts = {}
   model = model ?? pascalCase(req.params.model)
   const { schema } = await getSchemaExt(model, 'add', merge({}, { params }, options))

package/lib/crud/all-handler.js

@@ -18,7 +18,7 @@ const handler = {
 }
 
 async function allHandler ({ model, action, req, reply, template, params = {}, options = {} }) {
-  const { upperFirst, merge, keys } = this.lib._
+  const { upperFirst, merge, keys } = this.app.lib._
   if (!keys(handler).includes(action)) throw this.error('_notFound')
   if (['delete', 'export'].includes(action)) {
     if (req.method === 'GET') throw this.error('_notFound')

package/lib/crud/delete-handler.js

@@ -1,8 +1,8 @@
 async function deleteHandler ({ req, reply, model, params = {}, templateDisabled = 'waibuDb.template:/disabled.html', options = {} } = {}) {
-  const { pascalCase } = this.lib.aneka
+  const { pascalCase } = this.app.lib.aneka
   const { recordRemove, getSchemaExt } = this.app.waibuDb
   const { buildUrl } = this.app.waibuMpa
-  const { reduce, merge } = this.lib._
+  const { reduce, merge } = this.app.lib._
   const opts = {}
   model = model ?? pascalCase(req.params.model)
   const { schema } = await getSchemaExt(model, 'add', merge({}, { params }, options))

package/lib/crud/details-handler.js

@@ -1,9 +1,9 @@
 import attachmentHandler from './helper/attachment-handler.js'
 
 async function detailsHandler ({ req, reply, model, params = {}, id, template, addOnsHandler, templateDisabled = 'waibuDb.template:/disabled.html', options } = {}) {
-  const { pascalCase } = this.lib.aneka
+  const { pascalCase } = this.app.lib.aneka
   const { recordGet, getSchemaExt } = this.app.waibuDb
-  const { merge } = this.lib._
+  const { merge } = this.app.lib._
   const opts = { rels: '*' }
   model = model ?? pascalCase(req.params.model)
   const { schema } = await getSchemaExt(model, 'details', merge({}, { params }, options))

package/lib/crud/edit-handler.js

@@ -1,13 +1,13 @@
 import attachmentHandler from './helper/attachment-handler.js'
 
 async function editHandler ({ req, reply, model, id, params = {}, template, addOnsHandler, templateDisabled = 'waibuDb.template:/disabled.html', options = {} } = {}) {
-  const { pascalCase } = this.lib.aneka
+  const { pascalCase } = this.app.lib.aneka
   const { getPluginDataDir } = this.app.bajo
   const { recordUpdate, recordGet, getSchemaExt } = this.app.waibuDb
   const { buildUrl } = this.app.waibuMpa
-  const { fs } = this.lib
-  const { defaultsDeep } = this.lib.aneka
-  const { merge, isEmpty, omit } = this.lib._
+  const { fs } = this.app.lib
+  const { defaultsDeep } = this.app.lib.aneka
+  const { merge, isEmpty, omit } = this.app.lib._
   const opts = {}
   let error
   let resp

package/lib/crud/export-handler.js

@@ -2,9 +2,9 @@ import prepCrud from '../prep-crud.js'
 
 async function exportHandler ({ req, reply, model, params = {}, templateDisabled = 'waibuDb.template:/disabled.html', options = {} } = {}) {
   const { getPlugin } = this.app.bajo
-  const { dayjs } = this.lib
-  const { omit, kebabCase, get, merge } = this.lib._
-  const { pascalCase } = this.lib.aneka
+  const { dayjs } = this.app.lib
+  const { omit, kebabCase, get, merge } = this.app.lib._
+  const { pascalCase } = this.app.lib.aneka
   const { getSchemaExt } = this.app.waibuDb
   const { buildUrl } = this.app.waibuMpa
   const { pushDownload } = getPlugin('sumba')
@@ -13,7 +13,7 @@ async function exportHandler ({ req, reply, model, params = {}, templateDisabled
   if (schema.disabled.includes('find')) return await reply.view(templateDisabled, { action: 'list' })
   const data = prepCrud.call(getPlugin('waibuDb'), { model, req, reply, args: ['model'] })
   data.opts = omit(data.opts, ['req', 'reply'])
-  const source = `${this.name}:/export-handler`
+  const source = `${this.ns}:/export-handler`
   const worker = 'waibuDb:exportData'
   const type = get(data, 'input.ftype', 'json')
   const settings = get(data, 'input.options', '').split(',')

package/lib/crud/helper/add-ons-handler.js

@@ -2,7 +2,7 @@ async function addOnsHandler ({ req, reply, data, schema, options = {} }) {
   const { escape } = this.app.waibu
   const { base64JsonEncode } = this.app.waibuMpa
   const { statAggregate } = this.app.waibuDb
-  const { get, map, pick, pullAt } = this.lib._
+  const { get, map, pick, pullAt } = this.app.lib._
   const opts = map(get(schema, 'view.stat.aggregate', []), item => {
     const dbOpts = pick(item, ['fields', 'group', 'aggregate'])
     const name = item.name ?? `field.${item.fields[0]}`

package/lib/crud/helper/build-params.js

@@ -1,5 +1,5 @@
 function buildParams ({ model, req, reply, action, options = {} }) {
-  const { camelCase, kebabCase, map, upperFirst, get } = this.lib._
+  const { camelCase, kebabCase, map, upperFirst, get } = this.app.lib._
   const { getSchema } = this.app.dobo
   const [, ...names] = map(kebabCase(model).split('-'), n => upperFirst(n))
   const schema = getSchema(camelCase(model), false)

package/lib/crud/list-handler.js

@@ -1,7 +1,7 @@
 async function listHandler ({ req, reply, model, template, params = {}, addOnsHandler, templateDisabled = 'waibuDb.template:/disabled.html', options = {} } = {}) {
-  const { pascalCase } = this.lib.aneka
+  const { pascalCase } = this.app.lib.aneka
   const { recordFind, getSchemaExt } = this.app.waibuDb
-  const { get, merge, isArray, upperFirst } = this.lib._
+  const { get, merge, isArray, upperFirst } = this.app.lib._
   const qsKey = this.app.waibu.config.qsKey
   model = model ?? pascalCase(req.params.model)
   const { schema } = await getSchemaExt(model, 'list', merge({}, { params }, options))

package/lib/prep-crud.js

@@ -1,8 +1,8 @@
 function prepCrud ({ model, body, id, req, reply, options = {}, args }) {
   const { parseFilter } = this.app.waibu
   const { buildQuery, getInfo } = this.app.dobo
-  const { pascalCase } = this.lib.aneka
-  const { cloneDeep, has } = this.lib._
+  const { pascalCase } = this.app.lib.aneka
+  const { cloneDeep, has } = this.app.lib._
   const cfgWeb = this.app.waibu.getConfig()
   const opts = cloneDeep(options)
   const params = this.getParams(req, ...args)

package/method/format-record.js

@@ -1,5 +1,5 @@
 async function formatRow ({ data, req, schema, options = {} }) {
-  const { get, find, isFunction, cloneDeep } = this.lib._
+  const { get, find, isFunction, cloneDeep } = this.app.lib._
   const { format, callHandler } = this.app.bajo
   const { escape } = this.app.waibu
   const fields = get(schema, 'view.fields', Object.keys(schema.properties))
@@ -28,7 +28,7 @@ async function formatRow ({ data, req, schema, options = {} }) {
 }
 
 async function formatRecord ({ data, req, schema, options = {} }) {
-  const { isArray } = this.lib._
+  const { isArray } = this.app.lib._
   if (!isArray(data)) return await formatRow.call(this, { data, req, schema, options })
   const items = []
   for (const d of data) {

package/method/get-lookup-data.js

@@ -1,5 +1,5 @@
 async function getLookupData ({ model, req, data, id = 'id', field, query }) {
-  const { set, map } = this.lib._
+  const { set, map } = this.app.lib._
   const $in = map(data, id)
   const q = query ?? set({}, field, { $in })
   const options = {

package/method/get-params.js

@@ -1,5 +1,5 @@
 function getParams (req, ...items) {
-  const { map, trim, get } = this.lib._
+  const { map, trim, get } = this.app.lib._
   let fields
   req.query = req.query ?? {}
   req.params = req.params ?? {}

package/method/get-schema-ext.js

@@ -5,8 +5,8 @@ const defReadonly = ['id', 'createdAt', 'updatedAt']
 const defFormatter = {}
 
 function getCommons (action, schema, ext, options = {}) {
-  const { defaultsDeep } = this.lib.aneka
-  const { merge, map, get, set, without, uniq, pull } = this.lib._
+  const { defaultsDeep } = this.app.lib.aneka
+  const { merge, map, get, set, without, uniq, pull } = this.app.lib._
   const calcFields = get(ext, `view.${action}.calcFields`, get(ext, 'common.calcFields', []))
   const forceVisible = get(ext, `view.${action}.forceVisible`, get(ext, 'common.forceVisible', []))
   const widget = defaultsDeep(get(ext, `view.${action}.widget`), get(ext, 'common.widget', {}))
@@ -54,7 +54,7 @@ function getCommons (action, schema, ext, options = {}) {
 }
 
 function autoLayout ({ action, schema, ext, layout }) {
-  const { forOwn, keys } = this.lib._
+  const { forOwn, keys } = this.app.lib._
   const matches = ['id', 'createdAt', 'updatedAt']
   const meta = []
   const general = []
@@ -70,8 +70,8 @@ function autoLayout ({ action, schema, ext, layout }) {
 }
 
 function customLayout ({ action, schema, ext, layout, readonly }) {
-  const { defaultsDeep } = this.lib.aneka
-  const { isEmpty } = this.lib._
+  const { defaultsDeep } = this.app.lib.aneka
+  const { isEmpty } = this.app.lib._
   const items = [...layout]
   for (const item of items) {
     for (const idx in item.fields) {
@@ -88,8 +88,8 @@ function customLayout ({ action, schema, ext, layout, readonly }) {
 }
 
 function applyLayout (action, schema, ext) {
-  const { defaultsDeep } = this.lib.aneka
-  const { set, get, isEmpty, find, kebabCase } = this.lib._
+  const { defaultsDeep } = this.app.lib.aneka
+  const { set, get, isEmpty, find, kebabCase } = this.app.lib._
   const { fields, card, calcFields } = getCommons.call(this, action, schema, ext)
   const layout = get(ext, `view.${action}.layout`, get(ext, 'common.layout', []))
   const readonly = get(ext, `view.${action}.readonly`, get(ext, 'common.readonly', defReadonly))
@@ -140,7 +140,7 @@ function applyLayout (action, schema, ext) {
 
 const handler = {
   list: async function (schema, ext, options) {
-    const { get, set } = this.lib._
+    const { get, set } = this.app.lib._
     const { fields } = getCommons.call(this, 'list', schema, ext, options)
     const qsFields = []
     for (const f of get(schema, 'view.qs.fields', '').split(',')) {
@@ -169,9 +169,9 @@ const handler = {
 
 async function getSchemaExt (model, view, options = {}) {
   const { readConfig } = this.app.bajo
-  const { defaultsDeep } = this.lib.aneka
+  const { defaultsDeep } = this.app.lib.aneka
   const { getSchema } = this.app.dobo
-  const { pick } = this.lib._
+  const { pick } = this.app.lib._
 
   let schema = getSchema(model)
   const base = path.basename(schema.file, path.extname(schema.file))

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "waibu-db",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "DB Helper",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build-doc": "jsdoc -c .jsdoc.conf.json",
+    "test": "mocha"
   },
   "type": "module",
   "bajo": {
@@ -29,5 +30,9 @@
   "bugs": {
     "url": "https://github.com/ardhi/waibu-db/issues"
   },
-  "homepage": "https://github.com/ardhi/waibu-db#readme"
+  "homepage": "https://github.com/ardhi/waibu-db#readme",
+  "devDependencies": {
+    "clean-jsdoc-theme": "^4.3.0",
+    "jsdoc-plugin-intersection": "^1.0.4"
+  }
 }

package/wiki/CONFIG.md

@@ -0,0 +1,3 @@
+# Config Object
+
+TBD

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.