dobo
Version:
DBMS for Bajo Framework
579 lines (552 loc) • 35.1 kB
HTML
<!DOCTYPE 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: lib/factory/model/helper.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">Dobo 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="Dobo.html">Dobo</a></div><div class="sidebar-section-children"><a href="DoboAction.html">DoboAction</a></div><div class="sidebar-section-children"><a href="DoboAdapter.html">DoboAdapter</a></div><div class="sidebar-section-children"><a href="DoboConnection.html">DoboConnection</a></div><div class="sidebar-section-children"><a href="DoboFeature.html">DoboFeature</a></div><div class="sidebar-section-children"><a href="DoboModel.html">DoboModel</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-Helper.html">Helper</a></div><div class="sidebar-section-children"><a href="module-Helper_Model.html">Helper/Model</a></div><div class="sidebar-section-children"><a href="module-Hook.html">Hook</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-Tools.html">Tools</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#actionFactory">actionFactory</a></div><div class="sidebar-section-children"><a href="global.html#adapterFactory">adapterFactory</a></div><div class="sidebar-section-children"><a href="global.html#connectionFactory">connectionFactory</a></div><div class="sidebar-section-children"><a href="global.html#featureFactory">featureFactory</a></div><div class="sidebar-section-children"><a href="global.html#modelFactory">modelFactory</a></div><div class="sidebar-section-children"><a href="global.html#pluginFactory">pluginFactory</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/dobo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/dobo" target="">Github</a></div><div class="navbar-item"><a id="" href="https://dobo.bajo.app/" target="">Dobo</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">lib_factory_model_helper.js</h1></header><article><pre class="prettyprint source lang-js"><code>import path from 'path'
/**
* Helper functions for model operations in the Dobo framework.
*
* @module Helper/Model
*/
/**
* Clone options object and omit some keys to avoid reference issues
*
* @method
* @name cloneOptions
* @memberof module:Helper/Model
* @param {DoboModel.TOptions} [options={}]
* @returns {DoboModel.TOptions} Cloned options object
*/
export function cloneOptions (options = {}) {
const { cloneDeep, omit } = this.app.lib._
const omittedOptionsKeys = ['req', 'reply', 'trx']
const nOptions = cloneDeep(omit(options, omittedOptionsKeys))
for (const key of omittedOptionsKeys) {
nOptions[key] = options[key]
}
return nOptions
}
/**
* Executes a hook function with the provided name and arguments.
* @async
* @memberof module:Helper/Model
* @method
* @name execHook
* @param {string} name - The name of the hook to execute.
* @param {...any} args - Arguments to pass to the hook function.
* @returns {Promise<void>}
*/
export async function execHook (name, ...args) {
const { runHook } = this.app.bajo
const { camelCase, last, kebabCase } = this.app.lib._
const { noHook } = last(args)
const { ns } = this.app.dobo
let [prefix, ...action] = kebabCase(name).split('-')
action = camelCase(action.join(' '))
if (!noHook) {
if (prefix === 'before') await runHook(`${ns}:beforeAction`, action, this.name, ...args)
await runHook(`${ns}:${name}`, this.name, ...args)
if (prefix === 'after') await runHook(`${ns}:afterAction`, action, this.name, ...args)
if (prefix === 'before') await runHook(`${ns}.${camelCase(this.name)}:beforeAction`, action, ...args)
await runHook(`${ns}.${camelCase(this.name)}:${name}`, ...args)
if (prefix === 'after') await runHook(`${ns}.${camelCase(this.name)}:afterAction`, action, ...args)
}
}
/**
* Executes a model hook function with the provided name and arguments.
* @async
* @memberof module:Helper/Model
* @method
* @name execModelHook
* @param {string} name - The name of the model hook to execute.
* @param {...any} args - Arguments to pass to the model hook function.
* @returns {Promise<void>}
*/
export async function execModelHook (name, ...args) {
const { last } = this.app.lib._
const { runModelHook } = this.app.dobo
const { noModelHook } = last(args)
if (!noModelHook) await runModelHook(this, name, ...args)
}
/**
* Executes a dynamic hook function with the provided name and arguments.
* @async
* @memberof module:Helper/Model
* @method
* @name execDynHook
* @param {string} name - The name of the dynamic hook to execute.
* @param {...any} args - Arguments to pass to the dynamic hook function.
* @returns {Promise<void>}
*/
export async function execDynHook (name, ...args) {
const { last, orderBy } = this.app.lib._
const opts = last(args)
const results = []
if (!opts.noDynHook) {
const hooks = orderBy((opts.dynHooks ?? []).filter(hook => hook.name === name), ['level'])
for (const hook of hooks) {
if (hook.noWait) hook.handler.call(this, ...args)
else await hook.handler.call(this, ...args)
}
}
return results
}
/**
* Executes validation on the provided body with the given options.
* @async
* @memberof module:Helper/Model
* @method
* @name execValidation
* @param {Object} body - The data to validate.
* @param {DoboModel.TOptions} [options={}] - Validation options.
* @returns {Promise<Object>} The result of the validation.
*/
export async function execValidation (body, options = {}) {
const { uniq } = this.app.lib._
const { validation = {} } = options
const fields = uniq([...Object.keys(body), ...(options.fields ?? [])])
await execHook.call(this, 'beforeRecordValidation', body, options)
await execModelHook.call(this, 'beforeRecordValidation', body, options)
const result = await this.validate(body, validation, { fields, ...options })
await execModelHook.call(this, 'afterRecordValidation', body, result, options)
await execHook.call(this, 'afterRecordValidation', body, result, options)
return result
}
/**
* Prepares and returns the filter and options for a given action.
* @async
* @memberof module:Helper/Model
* @method
* @name getFilterAndOptions
* @param {DoboModel.TFilter} filter - The filter criteria.
* @param {DoboModel.TOptions} options - The options for the action.
* @param {string} action - The action being performed.
* @returns {Promise<{filter: DoboModel.TFilter, options: DoboModel.TOptions}>} The prepared filter and options.
*/
export async function getFilterAndOptions (filter = {}, options = {}, action) {
const { cloneDeep } = this.app.lib._
const nFilter = cloneDeep(filter || {})
const nOptions = cloneOptions.call(this, options)
if (options.noMagic) {
nOptions.noHook = true
nOptions.noDynHook = true
nOptions.noValidation = true
nOptions.noCache = true
nOptions.throwNotFound = false
delete options.noMagic
delete nOptions.noMagic
}
nOptions.action = action
nOptions.dataOnly = false
nOptions.truncateString = nOptions.truncateString ?? false
nOptions.throwNotFound = nOptions.throwNotFound ?? true
nFilter.orgQuery = nFilter.query
nFilter.orgSearch = nFilter.search
nFilter.query = buildFilterQuery.call(this, nFilter) ?? {}
nFilter.search = buildFilterSearch.call(this, nFilter) ?? {}
const { limit, page, skip, sort } = preparePagination.call(this, nFilter, nOptions)
nFilter.limit = limit
nFilter.page = page
nFilter.skip = skip
nFilter.sort = sort
if (nOptions.queryHandler) {
const scope = nOptions.req ? this.app[nOptions.req.ns] : this.plugin
nFilter.query = await options.queryHandler.call(scope, nFilter.query, nOptions.req)
}
return { filter: nFilter, options: nOptions }
}
/**
* Handles a request for a given action trigger.
* @async
* @memberof module:Helper/Model
* @method
* @name handleReq
* @param {string|number} id - The ID of the record.
* @param {string} trigger - The action trigger (e.g., 'created', 'updated', 'removed').
* @param {DoboModel.TOptions} [options={}] - Additional options for handling the request.
* @returns {Promise<void>}
*/
export async function handleReq (id, trigger, options = {}) {
const { upperFirst } = this.app.lib._
if (options.req) {
if (options.req.file && trigger !== 'removed') await handleAttachmentUpload.call(this, id, trigger, options)
if (options.req.flash && !options.noFlash) options.req.flash('notify', options.req.t(`record${upperFirst(trigger)}`))
}
}
/**
* Merges attachment information into the given record.
* @async
* @memberof module:Helper/Model
* @method
* @name mergeAttachmentInfo
* @param {Object} rec - The record to merge attachment info into.
* @param {string} source - The source file path of the attachment.
* @param {Object} options - Additional options including mimeType, stats, and fullPath.
* @returns {Promise<void>}
*/
export async function mergeAttachmentInfo (rec, source, options = {}) {
if (!this.app.waibu) return
const { mimeType, stats, fullPath } = options
const { importPkg } = this.app.bajo
const { fs } = this.app.lib
const { pick } = this.app.lib._
const mime = await importPkg('waibu:mime')
if (mimeType) rec.mimeType = mime.getType(rec.file)
if (fullPath) rec.fullPath = source
if (stats) {
const s = fs.statSync(source)
rec.stats = pick(s, ['size', 'atime', 'ctime', 'mtime'])
}
}
/**
* Gets the attachment path for a given record and field.
* @async
* @memberof module:Helper/Model
* @method
* @name getAttachmentPath
* @param {string|number} id - The ID of the record.
* @param {string} field - The field name of the attachment.
* @param {string} file - The file name of the attachment.
* @param {Object} options - Additional options, including dirOnly.
* @returns {Promise<string>} The path to the attachment.
*/
export async function getAttachmentPath (id, field, file, options = {}) {
const { fs } = this.app.lib
const dir = `${this.app.getPluginDataDir(this.app.dobo.ns)}/attachment/${this.name}/${id}`
if (options.dirOnly) return dir
const path = field ? `${dir}/${field}/${file}` : `${dir}/${file}`
if (!fs.existsSync(path)) throw this.app.dobo.error('notFound')
return path
}
/**
* Copies attachments for a given record.
* @name copyAttachment
* @async
* @memberof module:Helper/Model
* @method
* @param {string|number} id - The ID of the record.
* @param {Object} options - Additional options for copying attachments.
* @returns {Promise<Array>} The copied attachment records.
*/
export async function copyAttachment (id, options = {}) {
if (!this.app.waibu) return
if (!this.options.attachment) return
const { fs } = this.app.lib
const { req, setField, setFile, mimeType, stats } = options
const { dir, files } = await this.app.waibu.getUploadedFiles(req.id, false, true)
const result = []
if (files.length === 0) return result
for (const f of files) {
let [field, ...parts] = path.basename(f).split('@')
if (parts.length === 0) continue
field = setField ?? field
const file = setFile ?? parts.join('@')
const opts = { source: f, field, file, mimeType, stats, req }
const rec = await this.createAttachment(id, opts)
if (!rec) continue
delete rec.dir
result.push(rec)
if (setField || setFile) break
}
fs.removeSync(dir)
return result
}
/**
* Handles attachment uploads for a given record and trigger.
* @async
* @memberof module:Helper/Model
* @method
* @name handleAttachmentUpload
* @param {string|number} id - The ID of the record.
* @param {string} trigger - The action trigger (e.g., 'added', 'removed').
* @param {Object} options - Additional options for handling the upload.
* @returns {Promise<void>}
*/
export async function handleAttachmentUpload (id, trigger, options = {}) {
if (!this.options.attachment) return
const { fs } = this.app.lib
const { req, mimeType, stats, setFile, setField } = options
if (trigger === 'removed') {
const dir = `${this.app.getPluginDataDir(this.app.dobo.ns)}/attachment/${this.name}/${id}`
await fs.remove(dir)
return
}
return copyAttachment.call(this, id, { req, mimeType, stats, setFile, setField })
}
/**
* Gets reference records for the given records.
* @async
* @memberof module:Helper/Model
* @method
* @name getRefs
* @param {Array<Object>} records - The records to get references for.
* @param {Object} options - Additional options for fetching references.
* @returns {Promise<void>}
*/
export async function getRefs (records = [], options = {}) {
const { isSet } = this.app.lib.aneka
const { uniq, without, get } = this.app.lib._
const { parseQuery } = this.app.dobo
const props = this.getNonVirtualProperties().filter(p => isSet(p.ref) && !(options.hidden ?? []).includes(p.name))
options.refs = options.refs ?? []
if (props.length > 0) {
for (const prop of props) {
for (const key in prop.ref) {
try {
if (records.length === 0) return
const isValues = Array.isArray(records[0][prop.name])
if (get(records, `0._ref.${key}`)) return
const ref = prop.ref[key]
const rModel = this.app.dobo.getModel(ref.model, true)
if (!rModel) return
let matches = []
for (const rec of records) {
const items = isValues ? [...(rec[prop.name] ?? [])] : (rec[prop.name] ? [rec[prop.name]] : [])
matches.push(...items.map(item => prop.name === 'id' ? rModel.sanitizeId(item) : item))
}
matches = uniq(without(matches, undefined, null, NaN)).map(i => i + '')
let query = {}
query[ref.field] = { $in: matches }
const siteIdProp = this.properties.find(item => item.name === 'siteId')
const siteIdRProp = rModel.properties.find(item => item.name === 'siteId')
if (siteIdProp && siteIdRProp) query.siteId = records[0].siteId
if (ref.query) query = { $and: [query, parseQuery(ref.query, rModel)] }
const filter = { query, limit: matches.length }
if (!((typeof options.refs === 'string' && ['*', 'all'].includes(options.refs)) || options.refs.includes(key))) return
if (ref.fields.length === 0) return
const { fmt, req } = options
const fields = [...ref.fields]
if (!fields.includes(prop.name)) fields.push(prop.name)
const rOptions = { dataOnly: true, refs: [], fmt, req, fields }
const results = await rModel.findRecord(filter, rOptions)
for (const i in records) {
records[i]._ref = records[i]._ref ?? {}
const rec = records[i]
let items = isValues ? [...(rec[prop.name] ?? [])] : (rec[prop.name] ? [rec[prop.name]] : [])
items = items.map(item => item + '')
const res = results.filter(r => items.includes(r[ref.field] + ''))
if (res.length === 0) records[i]._ref[key] = isValues ? [] : {}
else records[i]._ref[key] = isValues ? res : res[0]
}
} catch (err) {
if (this.app.bajo.config.log.level === 'trace') console.error(err)
}
}
}
}
}
/**
* Builds a sanitized filter query for the given filter.
* @memberof module:Helper/Model
* @method
* @name buildFilterQuery
* @param {Object} filter - The filter object containing query parameters.
* @returns {Object} The sanitized query object.
*/
export function buildFilterQuery (filter = {}) {
const { parseQuery } = this.app.dobo
const query = parseQuery(filter.query ?? {}, this, false)
return sanitizeQuery.call(this, query)
}
/**
* Sanitizes a query object by ensuring that its fields and values conform to the model's schema.
* @memberof module:Helper/Model
* @method
* @name sanitizeQuery
* @param {Object} query - The query object to sanitize.
* @param {string} parent - The parent field name, if applicable.
* @returns {Object} The sanitized query object.
*/
export function sanitizeQuery (query = {}, parent) {
const { isPlainObject, isArray, find, cloneDeep } = this.app.lib._
const { isSet } = this.app.lib.aneka
const { dayjs } = this.app.lib
const obj = cloneDeep(query)
const keys = Object.keys(obj)
const sanitizeField = (prop, val) => {
if (!prop) return val
if (val instanceof RegExp) return val
if (['datetime'].includes(prop.type)) {
const dt = dayjs(val)
return dt.isValid() ? dt.toDate() : val
} else if (['smallint', 'integer'].includes(prop.type)) return parseInt(val) || val
else if (['float', 'double'].includes(prop.type)) return parseFloat(val) || val
else if (['boolean'].includes(prop.type)) return !!val
else if (['string', 'text'].includes(prop.type)) return val + ''
return val
}
const sanitizeChild = (key, val, p) => {
if (!isSet(val)) return val
const prop = find(this.properties, { name: key.startsWith('$') ? p : key })
if (!prop) return val
return sanitizeField(prop, val)
}
keys.forEach(k => {
const v = obj[k]
const props = this.getProperties({ noVirtual: true })
const fields = props.map(p => p.name)
const prop = find(props, { name: k })
if (k[0] !== '$' && !fields.includes(k)) {
delete keys[k]
} else {
if (isPlainObject(v)) obj[k] = sanitizeQuery.call(this, v, k)
else if (isArray(v)) {
v.forEach((i, idx) => {
if (isPlainObject(i)) obj[k][idx] = sanitizeQuery.call(this, i, k)
else obj[k][idx] = sanitizeField(prop, i)
})
} else obj[k] = sanitizeChild(k, v, parent)
}
})
return obj
}
/**
* Builds a search filter from the given filter object.
* @memberof module:Helper/Model
* @method
* @name buildFilterSearch
* @param {Object} filter - The filter object containing search parameters.
* @returns {Object} The constructed search filter.
*/
export function buildFilterSearch (filter = {}) {
const { isPlainObject, trim, has, uniq } = this.app.lib._
const search = filter.search ?? {}
let input = search
if (isPlainObject(input)) return input
const split = (value) => {
let [field, val] = value.split(':').map(i => i.trim())
if (!val) {
val = field
field = '*'
}
return { field, value: val }
}
input = trim(input)
let items = {}
if (isPlainObject(input)) items = input
else if (input[0] === '{') {
try {
items = JSON.parse(input)
} catch (err) {}
} else {
for (const item of input.split('+').map(i => i.trim())) {
const part = split(item, ' ')
if (!items[part.field]) items[part.field] = []
items[part.field].push(...part.value.split(' ').filter(v => ![''].includes(v)))
}
}
let s = {}
for (const index of this.indexes.filter(i => i.type === 'fulltext')) {
for (const f of index.fields) {
const value = []
if (typeof items[f] === 'string') items[f] = [items[f]]
if (has(items, f)) value.push(...items[f])
if (!s[f]) s[f] = []
s[f] = uniq([...s[f], ...value])
}
}
if (has(items, '*')) s['*'] = items['*']
if (this.adapter.idField.name !== 'id') {
const search = JSON.stringify(s).replaceAll('"id"', `"${this.adapter.idField.name}"`)
try {
s = JSON.parse(search)
} catch (err) {}
}
return s
}
/**
* Prepare pagination parameters for a query:
* - Ensures that the limit does not exceed the maximum allowed limit.
* - Ensures that the page number is within the allowed range.
* - Calculates the number of records to skip based on the page and limit.
* - Builds the sort order based on the provided sort input.
*
* @async
* @memberof module:Helper/Model
* @method
* @name preparePagination
* @param {DoboModel.TFilter} filter - The filter object containing pagination parameters.
* @param {DoboModel.TOptions} options - Additional options for pagination.
* @returns {Object} The prepared pagination parameters including limit, page, skip, and sort.
*/
export function preparePagination (filter = {}, options = {}) {
const { isEmpty, map, each, isPlainObject, isString, trim, keys } = this.app.lib._
const { getDefaultValues, config } = this.app.dobo
const { limit: defLimit, maxLimit: defMaxLimit, maxPage: defMaxPage } = getDefaultValues(options)
const buildPageSkipLimit = (filter) => {
let limit = parseInt(filter.limit) || defLimit
if (limit === -1) limit = defMaxLimit
if (limit > defMaxLimit) {
options.warnings = options.warnings ?? []
options.warnings.push(options.req ? options.req.t('maxLimitWarning%s%s', limit, defMaxLimit) : this.plugin.t('maxLimitWarning%s', limit, defMaxLimit))
limit = defMaxLimit // TODO: notify as warning in response object
}
if (limit < 1) limit = 1
let page = parseInt(filter.page) || 1
if (page < 1) page = 1
if (page > defMaxPage) throw this.plugin.error('maxPageError%s%s', page, defMaxPage)
let skip = (page - 1) * limit
if (filter.skip) {
skip = parseInt(filter.skip) || skip
page = undefined
}
if (skip < 0) skip = 0
return { page, skip, limit }
}
const buildSort = (input, allowSortUnindexed) => {
let sort
if (isEmpty(input)) {
const columns = map(this.properties ?? [], 'name')
each(config.default.filter.sort, s => {
const [col] = s.split(':')
if (columns.includes(col)) {
input = s
return false
}
})
}
if (!isEmpty(input)) {
if (isPlainObject(input)) sort = input
else if (isString(input)) {
const item = {}
each(input.split('+'), text => {
let [col, dir] = map(trim(text).split(':'), i => trim(i))
dir = (dir ?? '').toUpperCase()
dir = dir === 'DESC' ? -1 : parseInt(dir) || 1
item[col] = dir / Math.abs(dir)
})
sort = item
}
const items = keys(sort)
each(items, i => {
if (!this.sortables.includes(i) && !allowSortUnindexed) throw this.app.dobo.error('sortOnUnindexedField%s%s', i, this.name)
// if (model.fullText.fields.includes(i)) throw this.error('Can\'t sort on full-text index: \'%s@%s\'', i, model.name)
})
}
return sort
}
const { page, skip, limit } = buildPageSkipLimit(filter)
let sortInput = filter.sort
try {
sortInput = JSON.parse(sortInput)
} catch (err) {
}
const sort = buildSort(sortInput, options.allowSortUnindexed)
return { limit, page, skip, sort }
}
/**
* Clears the cache for a specific record ID and related find operations.
* @async
* @memberof module:Helper/Model
* @method
* @name clearCache
* @param {string|number} id - The ID of the record for which to clear the cache.
* @returns {Promise<void>}
*/
export async function clearCache (id) {
const { clear } = this.app.bajoCache ?? {}
if (!clear) return
await clear({ key: `dobo|${this.name}|getRecord|${id}` })
await clear({ key: `dobo|${this.name}|findRecord` })
await clear({ key: `dobo|${this.name}|findAllRecord` })
await clear({ key: `dobo|${this.name}|findOneRecord` })
}
</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">Dobo API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/dobo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/dobo" target="">Github</a></div><div class="navbar-item"><a id="" href="https://dobo.bajo.app/" target="">Dobo</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="Dobo.html">Dobo</a></div><div class="sidebar-section-children"><a href="DoboAction.html">DoboAction</a></div><div class="sidebar-section-children"><a href="DoboAdapter.html">DoboAdapter</a></div><div class="sidebar-section-children"><a href="DoboConnection.html">DoboConnection</a></div><div class="sidebar-section-children"><a href="DoboFeature.html">DoboFeature</a></div><div class="sidebar-section-children"><a href="DoboModel.html">DoboModel</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-Helper.html">Helper</a></div><div class="sidebar-section-children"><a href="module-Helper_Model.html">Helper/Model</a></div><div class="sidebar-section-children"><a href="module-Hook.html">Hook</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-Tools.html">Tools</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#actionFactory">actionFactory</a></div><div class="sidebar-section-children"><a href="global.html#adapterFactory">adapterFactory</a></div><div class="sidebar-section-children"><a href="global.html#connectionFactory">connectionFactory</a></div><div class="sidebar-section-children"><a href="global.html#featureFactory">featureFactory</a></div><div class="sidebar-section-children"><a href="global.html#modelFactory">modelFactory</a></div><div class="sidebar-section-children"><a href="global.html#pluginFactory">pluginFactory</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>