waibu-db
Version:
249 lines (235 loc) • 21.1 kB
HTML
<html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: index.js</title><!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">WaibuDb API</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="WaibuDb.html">WaibuDb</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-CRUDHandler.html">CRUDHandler</a></div><div class="sidebar-section-children"><a href="module-CRUDHandler_Helper.html">CRUDHandler/Helper</a></div><div class="sidebar-section-children"><a href="module-Helper.html">Helper</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="external-DoboModel.html">DoboModel</a></div><div class="sidebar-section-children"><a href="external-TFilter.html">TFilter</a></div><div class="sidebar-section-children"><a href="external-TOptions.html">TOptions</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#TConfig">TConfig</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/waibu-db" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/waibu-db" target="">Github</a></div><div class="navbar-item"><a id="" href="https://waibu.bajo.app/" target="">Waibu</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">index.js</h1></header><article><pre class="prettyprint source lang-js"><code>import countRecord from './lib/method/count-record.js'
import createAggregate from './lib/method/create-aggregate.js'
import createHistogram from './lib/method/create-histogram.js'
import createRecord from './lib/method/create-record.js'
import findOneRecord from './lib/method/find-one-record.js'
import findRecord from './lib/method/find-record.js'
import getSchemaExt from './lib/method/get-schema-ext.js'
import getRecord from './lib/method/get-record.js'
import removeRecord from './lib/method/remove-record.js'
import updateRecord from './lib/method/update-record.js'
import findAllRecord from './lib/method/find-all-record.js'
import config from './lib/config.js'
/**
* Plugin factory.
*
* **Never** call this function directly!!! It's only-meant to be called by the {@link https://ardhi.github.io/bajo|Bajo framework} during plugin initialization.
*
* @param {string} pkgName - NPM package name
* @returns {WaibuDb} WaibuDb class
*/
async function factory (pkgName) {
const me = this
/**
* WaibuDb class definition.
*
* @class
*/
class WaibuDb extends this.app.baseClass.Base {
/**
* Constructor.
*/
constructor () {
super(pkgName, me.app)
/**
* Configuration object.
* @type {TConfig}
*/
this.config = config
/**
* Method map for CRUD operations.
* @type {object}
* @property {string} [create='POST'] - HTTP method for create operation
* @property {string} [find='GET'] - HTTP method for find operation
* @property {string} [get='GET'] - HTTP method for get operation
* @property {string} [update='PUT'] - HTTP method for update operation
* @property {string} [remove='DELETE'] - HTTP method for remove operation
*/
this.methodMap = {
create: 'POST',
find: 'GET',
get: 'GET',
update: 'PUT',
remove: 'DELETE'
}
this.selfBind([
'countRecord',
'createAggregate',
'createHistogram',
'createRecord',
'findOneRecord',
'findRecord',
'getSchemaExt',
'getRecord',
'removeRecord',
'updateRecord',
'findAllRecord'
])
}
/**
* Export data and save it as a file you can download later.
* This method is intended to be called by a worker process.
*
* If sumba is loaded, file download is handled by sumba download management which provides
* you a slick UI to monitor the download progress and status.
*
* If not, file is saved in standard bajo download directory.
* @async
* @method
* @param {object} params
* @returns {string} Path to the exported file
*/
exportData = async (params) => {
const { get } = this.app.lib._
const { fs } = this.app.lib
const { exportTo } = this.app.doboExtra
const model = get(params, 'payload.data.name')
const fields = get(params, 'payload.data.opts.fields')
const { id, file } = get(params, 'payload.data.download', {})
let dest = `${this.app.bajo.getDownloadDir()}/${file}`
const options = {
filter: get(params, 'payload.data.filter', {}),
ensureDir: true,
fields
}
options.filter.sort = 'id:1' // TODO: make this configurable
if (!this.app.sumba || !id) {
await exportTo(model, dest, options)
return dest
}
const { downloadDir } = this.app.sumba
dest = `${downloadDir}/${file}`
const dmodel = this.app.dobo.getModel('SumbaDownload')
try {
await dmodel.updateRecord(id, { status: 'PROCESSING' })
await exportTo(model, dest, options)
const { size } = fs.statSync(dest)
await dmodel.updateRecord(id, { size, status: 'COMPLETE' })
} catch (err) {
await dmodel.updateRecord(id, { status: 'FAIL' })
}
return dest
}
/**
* Get all models that will be automatically included in the WaibuAdmin menu.
* @method
* @returns {Array} List of models
*/
getAutoModels = () => {
const { filter, get, map, isArray } = this.app.lib._
const { pascalCase } = this.app.lib.aneka
const allModels = this.app.dobo.models
const models = filter(allModels, s => {
const byModelFind = !s.disabled.includes('find')
const disabled = get(this, `app.${s.plugin.ns}.config.waibuAdmin.modelDisabled`, [])
let modelDisabled = []
if (['*', 'all'].includes(disabled)) modelDisabled = map(filter(allModels, m => m.plugin.ns === s.plugin.ns), 'name')
else if (isArray(disabled)) modelDisabled = map(disabled, m => pascalCase(`${this.app[s.plugin.ns].alias} ${m}`))
const byDbDisabled = !modelDisabled.includes(s.name)
return byModelFind && byDbDisabled
})
return models
}
/**
* Build menu for WaibuAdmin
* @param {object} locals - Locals object
* @param {object} req - Request object
* @returns {Array<object>} Menu structure
*/
adminMenu = async (locals, req) => {
const { getPluginPrefix } = this.app.waibu
const { getPluginTitle } = this.app.waibuMpa
const { camelCase, map, groupBy, keys, kebabCase } = this.app.lib._
const prefix = getPluginPrefix(this.ns)
const models = this.getAutoModels()
const omenu = groupBy(map(models, s => {
const item = { name: s.name, ns: s.plugin.ns }
item.nsTitle = getPluginTitle(s.plugin.ns, req)
return item
}), 'nsTitle')
const menu = []
for (const k of keys(omenu).sort()) {
const items = omenu[k]
const plugin = this.app[items[0].ns]
menu.push({
title: req.t(k),
children: map(items, item => {
const params = {
model: kebabCase(item.name),
action: 'list'
}
return {
title: camelCase(item.name.slice(plugin.alias.length)),
href: `waibuAdmin:/${prefix}/:model/:action`,
params
}
})
})
}
return menu
}
/**
* Collect all available parameters from the request object.
* @method
* @param {object} req - Request object
* @param {...string} items - List of parameter names
* @returns {object} Collected parameters
*/
getParams = (req, ...items) => {
const { map, trim, get } = this.app.lib._
let fields
req.query = req.query ?? {}
req.params = req.params ?? {}
if (req.query.fields) fields = map((req.query.fields ?? '').split(','), i => trim(i))
const params = {
fields,
count: get(this, 'config.dbModel.count', false),
body: req.body
}
items.forEach(i => {
params[i] = req.params[i]
})
return params
}
/**
* Get lookup data for a specific model and field based on provided options.
* @method
* @async
* @param {object} opts - Options for the lookup
* @param {string} opts.model - Model name
* @param {object} opts.req - Request object
* @param {Array<object>} opts.data - Data array
* @param {string} [opts.id='id'] - ID field name
* @param {string} opts.field - Field name to lookup
* @param {object} [opts.query] - Optional query object
* @returns {Promise<Array<object>>} Lookup results
*/
getLookupData = async (opts = {}) => {
const { model, req, data, id = 'id', field, query } = opts
const { set, map } = this.app.lib._
const $in = map(data, id)
const q = query ?? set({}, field, { $in })
const options = {
dataOnly: true,
query: q
}
return await this.findAllRecord({ model, req, options })
}
countRecord = countRecord
createAggregate = createAggregate
createHistogram = createHistogram
createRecord = createRecord
findOneRecord = findOneRecord
findRecord = findRecord
findAllRecord = findAllRecord
getSchemaExt = getSchemaExt
getRecord = getRecord
removeRecord = removeRecord
updateRecord = updateRecord
}
return WaibuDb
}
export default factory
</code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">WaibuDb API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/waibu-db" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/waibu-db" target="">Github</a></div><div class="navbar-item"><a id="" href="https://waibu.bajo.app/" target="">Waibu</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="WaibuDb.html">WaibuDb</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-CRUDHandler.html">CRUDHandler</a></div><div class="sidebar-section-children"><a href="module-CRUDHandler_Helper.html">CRUDHandler/Helper</a></div><div class="sidebar-section-children"><a href="module-Helper.html">Helper</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="external-DoboModel.html">DoboModel</a></div><div class="sidebar-section-children"><a href="external-TFilter.html">TFilter</a></div><div class="sidebar-section-children"><a href="external-TOptions.html">TOptions</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#TConfig">TConfig</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>