UNPKG

dobo

Version:

DBMS for Bajo Framework

285 lines (271 loc) 23.8 kB
<!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/validate.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_validate.js</h1></header><article><pre class="prettyprint source lang-js"><code>import joi from 'joi' const excludedTypes = ['object'] const excludedNames = [] /** * List of available string validators to check against model's properties and rules * @typedef {string[]} TValidatorString * @memberof DoboModel * @property {string} 0=alphanum * @property {string} 1=base64 * @property {string} 2=case * @property {string} 3=creditCard * @property {string} 4=dataUri * @property {string} 5=email * @property {string} 6=guid * @property {string} 7=uuid * @property {string} 8=hex * @property {string} 9=hostname * @property {string} 10=insenstive * @property {string} 11=ip * @property {string} 12=isoDate * @property {string} 13=isoDuration * @property {string} 14=length * @property {string} 15=lowercase * @property {string} 16=max * @property {string} 17=min * @property {string} 18=normalize * @property {string} 19=pattern * @property {string} 20=regex * @property {string} 21=replace * @property {string} 22=token * @property {string} 23=trim * @property {string} 24=truncate * @property {string} 25=upercase * @property {string} 26=uri */ /** * List of available number validators to check against model's properties and rules * @typedef {string[]} TValidatorNumber * @memberof DoboModel * @property {string} 0=great * @property {string} 1=less * @property {string} 2=max * @property {string} 3=min * @property {string} 4=multiple * @property {string} 5=negative * @property {string} 6=port * @property {string} 7=positive * @property {string} 8=sign * @property {string} 9=unsafe */ /** * List of available boolean validators to check against model's properties and rules * @typedef {string[]} TValidatorBoolean * @memberof DoboModel * @property {string} 0=falsy * @property {string} 1=sensitive * @property {string} 2=truthy */ /** * List of available date validators to check against model's properties and rules * @typedef {string[]} TValidatorDate * @memberof DoboModel * @property {string} 0=greater * @property {string} 1=iso * @property {string} 2=less * @property {string} 3=max * @property {string} 4=min */ /** * List of available timestamp validators to check against model's properties and rules * @typedef {string[]} TValidatorTimestamp * @memberof DoboModel * @property {string} 0=timestamp */ /** * All available validators to check against model's properties and rules * @typedef {Object} TValidator * @memberof DoboModel * @property {TValidatorString} string * @property {TValidatorNumber} number * @property {TValidatorBoolean} boolean * @property {TValidatorDate} date * @property {TValidatorTimestamp} timestamp * @property {TValidatorArray} array */ /** * List of available array validators to check against model's properties and rules * @typedef {string[]} TValidatorArray * @memberof DoboModel * @property {string} 0=length * @property {string} 1=max * @property {string} 2=min */ const validator = { string: ['alphanum', 'base64', 'case', 'creditCard', 'dataUri', 'domain', 'email', 'guid', 'uuid', 'hex', 'hostname', 'insensitive', 'ip', 'isoDate', 'isoDuration', 'length', 'lowercase', 'max', 'min', 'normalize', 'pattern', 'regex', 'replace', 'token', 'trim', 'truncate', 'uppercase', 'uri'], number: ['great', 'less', 'max', 'min', 'multiple', 'negative', 'port', 'positive', 'sign', 'unsafe'], boolean: ['falsy', 'sensitive', 'truthy'], date: ['greater', 'iso', 'less', 'max', 'min'], timestamp: ['timestamp'], array: ['length', 'max', 'min'] } /** * Build JOI model from database model's properties and rules * @method * @memberof DoboModel * @async * @param {object} [options={}] - Options object * @param {Array} [options.fields=[]] - If not empty, only these fields will be included in the JOI model * @param {object} [options.rule={}] - Custom rules to override model's rules * @param {Array} [options.extFields=[]] - Additional fields to include in the JOI model * @param {boolean} [options.partial=false] - If `true`, only the fields present in the body will be validated * @returns {object|boolean} Returns JOI model object or `false` if no properties to validate */ async function buildFromDbModel (options = {}) { const { isPlainObject, get, isEmpty, isString, keys, find, has, without } = this.app.lib._ const { fields = [], rule = {}, extFields = [] } = options const obj = {} const { propertyType: propType } = this.app.baseClass.Dobo const refs = [] const me = this function getRuleKv (kvRule) { let key let value let columns if (isPlainObject(kvRule)) { key = kvRule.rule value = kvRule.params columns = kvRule.fields } else if (isString(kvRule)) { [key, value, columns] = kvRule.split(':') } return { key, value, columns } } async function applyFieldRules (prop, obj) { const minMax = { min: false, max: false } const rules = get(rule, prop.name, prop.rules ?? []) if (!Array.isArray(rules)) return rules for (const r of rules) { const types = validator[propType[prop.type].validator] const { key, value } = getRuleKv(r) if (keys(minMax).includes(key)) minMax[key] = true if (key === 'ref') { refs.push(prop.name) obj = joi.ref(value) continue } if (!key || !types.includes(key)) continue obj = obj[key](value) } if (refs.includes(prop.name)) return obj if (['string', 'text'].includes(prop.type)) { for (const k in minMax) { if (minMax[k]) continue if (has(prop, `${k}Length`)) obj = obj[k](prop[`${k}Length`]) } } if (!['id'].includes(prop.name) &amp;&amp; prop.required) obj = obj.required() if (prop.values) { const values = await me.buildPropValues(prop, options) const items = values.map(item => item.value) if (prop.type === 'array') { obj = obj.items(joi.string().valid(...items)) } else obj = obj.valid(...items) } if (prop.rulesMsg) { const msgs = {} for (const k in prop.rulesMsg) { msgs[k] = '~' + prop.rulesMsg[k] // note: to tell bajo error formatter that this is a custom error message } obj = obj.messages(msgs) } return obj } const props = [...this.properties, ...extFields] for (const p of props) { if (excludedTypes.includes(p.type) || excludedNames.includes(p.name)) continue if (options.partial &amp;&amp; fields.length > 0 &amp;&amp; !fields.includes(p.name)) continue let item switch (p.type) { case 'text': case 'string': { item = await applyFieldRules(p, joi.string()) break } case 'smallint': case 'integer': item = await applyFieldRules(p, joi.number().integer()) break case 'float': case 'double': if (p.precision) item = await applyFieldRules(p, joi.number().precision(p.precision)) else item = await applyFieldRules(p, joi.number()) break case 'time': case 'date': case 'datetime': item = await applyFieldRules(p, joi.date()) break case 'timestamp': item = await applyFieldRules(p, joi.number().integer()) break case 'boolean': item = await applyFieldRules(p, joi.boolean()) break case 'array': item = await applyFieldRules(p, joi.array()) break } if (item) { if (item.$_root &amp;&amp; !p.required) obj[p.name] = item.allow(null, '') else obj[p.name] = item } } if (isEmpty(obj)) return false for (const r of this.rules) { for (const k of without(keys(obj), ...refs)) { const prop = find(props, { name: k }) if (!prop) continue const types = validator[propType[prop.type].validator] const { key, value, columns = [] } = getRuleKv(r) if (!types.includes(key)) continue if (columns.length === 0 || columns.includes(k)) obj[k] = obj[k][key](value) } } const result = joi.object(obj) for (const k of ['with', 'xor', 'without']) { const item = get(this, `extRule.${k}`) if (item) result[k](...item) } return result } /** * Validate body object against JOI model * * @method * @memberof DoboModel * @async * @param {Object} body - Body object to validate * @param {Object} joiModel - JOI model * @param {Object} [options={}] - Options object * @param {Array} [options.extFields=[]] * @param {boolean} [options.partial=false] - If `true`, only the fields present in the body will be validated * @param {Object} [options.params={}] - Validation parameters. See {@tutorial config} and {@link https://joi.dev/api/?v=17.13.3#anyvalidateasyncvalue-options|JOI validate's options} * @returns {Object} */ async function validate (body, joiModel, options = {}) { const { defaultsDeep } = this.app.lib.aneka const { isEmpty } = this.app.lib._ let { extFields = [], params = {}, partial } = options params = defaultsDeep(params, this.app.dobo.config.validationParams) const { rule = {} } = params delete params.rule const fields = partial ? Object.keys(body) : [...options.fields] if (isEmpty(joiModel)) joiModel = await buildFromDbModel.call(this, { fields, rule, extFields, partial }) if (!joiModel) return { value: body } try { return await joiModel.validateAsync(body, params) } catch (err) { const payload = { details: err.details, statusCode: 422, code: 'DB_VALIDATION', model: this.name } if (err.values) payload.values = err.values throw this.plugin.error('validationError', payload) } } export default validate </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>