dobo
Version:
DBMS for Bajo Framework
466 lines (445 loc) • 33.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/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_helper.js</h1></header><article><pre class="prettyprint source lang-js"><code>import path from 'path'
import adapterFactory from './factory/adapter.js'
import connectionFactory from './factory/connection.js'
import featureFactory from './factory/feature.js'
import modelFactory from './factory/model.js'
import actionFactory from './factory/action.js'
/**
* @module Helper
*/
/**
* Sanitizes a property definition for a model, ensuring it adheres to the expected structure and types.
* It handles various property attributes such as type, index, required status, and more.
*
* If the property is virtual, it processes it accordingly; otherwise, it adds it to the model's properties
* and indexes.
* @param {DoboModel} model
* @param {DoboModel.TProperty} prop
* @param {DoboModel.TIndex[]} indexes
*/
async function sanitizeProp (model, prop, indexes) {
const { isEmpty, isString, keys, pick, isArray, isPlainObject, omit, isFunction } = this.app.lib._
const allPropKeys = this.getAllPropertyKeys(model.connection.adapter)
const propType = this.constructor.propertyType
if (isString(prop)) {
let [name, type, maxLength, idx, required] = prop.split(',').map(m => m.trim())
if (isEmpty(type)) type = 'string'
maxLength = isEmpty(maxLength) ? propType.string.maxLength : parseInt(maxLength)
prop = { name, type, maxLength }
if (!isEmpty(idx)) prop.index = idx
prop.required = required === 'true'
}
prop.type = prop.type ?? 'string'
if (isArray(prop.values)) {
prop.values = prop.values.map(item => {
if (isPlainObject(item)) return pick(item, ['value', 'text'])
return { value: item, text: item }
})
} else if (!(isString(prop.values) || isFunction(prop.values))) delete prop.values
if (prop.hidden) model.hidden.push(prop.name)
if (prop.scanable) model.scanables.push(prop.scanable)
if (prop.virtual) {
const keys = Object.keys(propType)
if (!keys.includes(prop.type)) this.fatal('unknownPropType%s%s', `${prop.name}:${prop.type}`, model.name)
for (const key of ['required', 'rules', 'index', 'validator', 'ref', 'rulesMsg', 'immutable']) {
delete prop[key]
}
model.properties.push(prop)
} else {
if (prop.index) {
if (prop.index === true || prop.index === 'true') prop.index = 'index'
const [idx, idxName] = prop.index.split(':')
const index = { name: idxName ?? `${model.collName}_${prop.name}_${idx}`, fields: [prop.name], type: idx }
indexes.push(index)
}
if (keys(propType).includes(prop.type)) model.properties.push(pick(prop, allPropKeys))
else {
const feature = this.getFeature(prop.type)
if (!feature) this.fatal('unknownPropType%s%s', prop.type, model.name)
const opts = omit(prop, ['name', 'type'])
opts.field = prop.name
await applyFeature.call(this, model, feature, opts, indexes)
}
}
}
/**
* Finds and sanitizes all properties for a given model schema, ensuring that the 'id' property is included and
* that all properties are properly processed.
* @param {object} schema - The model schema
* @param {array} inputs - The list of input properties to process
* @param {array} indexes - The list of indexes to update
*/
async function findAllProps (schema, inputs = [], indexes = []) {
const { isPlainObject, cloneDeep } = this.app.lib._
const isIdProp = inputs.find(p => {
return isPlainObject(p) ? p.name === 'id' : p.startsWith('id,')
})
if (!isIdProp) {
const idField = cloneDeep(schema.connection.adapter.idField)
idField.name = 'id'
inputs.unshift(idField)
}
for (const prop of inputs) {
await sanitizeProp.call(this, schema, prop, indexes)
}
}
/**
* Applies a feature to a model schema, adding properties, rules, hooks, and other
* configurations as defined by the feature.
* @param {object} schema - The model schema
* @param {object} feature - The feature to apply
* @param {object} options - The options for the feature
* @param {array} indexes - The list of indexes to update
*/
async function applyFeature (schema, feature, options, indexes) {
const { isArray, findIndex } = this.app.lib._
if (feature.name === 'dobo:unique' && options.field === 'id') {
const idx = findIndex(schema.properties, { name: 'id' })
if (idx > -1) schema.properties.pullAt(idx)
}
const item = await feature.handler(options)
if (item.rules) schema.rules.push(...item.rules)
if (item.scanables) schema.scanables.push(...item.scanables)
if (!isArray(item.properties)) item.properties = [item.properties]
for (const prop of item.properties) {
prop.feature = `${feature.plugin.ns}:${feature.name}`
await sanitizeProp.call(this, schema, prop, indexes)
}
if (item.hooks) {
item.hooks = item.hooks.map(hook => {
hook.level = hook.level ?? 999
return hook
})
schema.hooks.push(...item.hooks)
}
}
/**
* Finds and applies all features for a given model schema, ensuring that each feature is properly processed
* @param {object} schema - The model schema
* @param {array} inputs - The list of features to apply
* @param {array} indexes - The list of indexes to update
*/
async function findAllFeats (schema, inputs = [], indexes = []) {
const { isString, omit } = this.app.lib._
for (let feat of inputs) {
if (isString(feat)) feat = { name: feat }
const featName = feat.name.indexOf(':') === -1 ? `dobo:${feat.name}` : feat.name
const feature = this.app.dobo.getFeature(featName)
if (!feature) this.fatal('invalidFeature%s%s', schema.name, featName)
await applyFeature.call(this, schema, feature, omit(feat, 'name'), indexes)
}
}
/**
* Finds and applies all indexes for a given model schema, ensuring that each index is properly processed
* @param {object} schema - The model schema
* @param {array} inputs - The list of indexes to apply
* @param {array} indexes - The list of existing indexes to update
*/
async function findAllIndexes (schema, inputs = [], indexes = []) {
const items = []
for (const index of inputs) {
index.type = index.type ?? 'index'
index.fields = index.fields ?? []
if (!index.name) index.name = `${schema.name}_${index.fields.join('_')}_${index.type}`
items.push(index)
}
schema.indexes = [...items, ...indexes]
}
/**
* Sanitizes the references in a model schema, ensuring that all references point to valid models and properties.
* It checks for duplicate reference keys and validates the existence of referenced models and properties.
* @async
* @param {object} schema - The model schema to sanitize
* @param {object[]} schemas - The list of all model schemas
* @returns {Promise<void>}
*/
export async function sanitizeRef (schema, schemas) {
const { find, isString, pullAt } = this.app.lib._
const _refKeys = []
for (const prop of schema.properties) {
const ignored = []
for (const key in prop.ref ?? {}) {
_refKeys.push(key)
let ref = prop.ref[key]
if (isString(ref)) {
ref = { field: ref }
}
ref.field = ref.field ?? 'id'
ref.type = ref.type ?? '1:1'
ref.searchField = ref.searchField ?? ref.field
ref.labelField = ref.labelField ?? ref.searchField
const rModel = find(schemas, { name: ref.model })
if (!rModel) {
ignored.push(key)
this.log.warn('notFound%s%s', this.t('model'), ref.model)
continue
}
const rProp = find(rModel.properties, { name: ref.field })
if (!rProp) {
ignored.push(key)
this.log.warn('notFound%s%s', this.t('property'), `${ref.field}@${ref.model}`)
continue
}
ref.fields = ref.fields ?? '*'
if (['*', 'all'].includes(ref.fields)) ref.fields = rModel.properties.map(p => p.name)
if (ref.fields.length > 0 && !ref.fields.includes('id')) ref.fields.unshift('id')
const removed = []
for (const idx in ref.fields) {
const p = find(rModel.properties, { name: ref.fields[idx] })
if (!p) removed.push(ref.fields[idx])
}
pullAt(ref.fields, removed)
prop.ref[key] = ref
}
for (const key of ignored) {
delete prop.ref[key]
}
}
const dupes = _refKeys.filter((item, index) => _refKeys.indexOf(item) !== index)
if (dupes.length > 0) throw this.error('duplicateRefKeys%s%s', schema.name, dupes.join(', '))
}
/**
* Sanitizes all model schemas, ensuring that properties, indexes, and references are properly defined and validated.
* It also determines the sortable fields based on the defined indexes.
* @async
* @param {object} schema - The model schema
* @returns {Promise<void>}
*/
export async function sanitizeAll (schema) {
const { runHook } = this.app.bajo
const { pick, keys, map, uniq, camelCase, filter } = this.app.lib._
const { defaultsDeep } = this.app.lib.aneka
const allPropNames = uniq(map(schema.properties, 'name'))
const propType = this.constructor.propertyType
const indexTypes = this.constructor.indexTypes
await runHook(`dobo.${camelCase(schema.name)}:beforeSanitizeModel`, schema)
// properties
for (const idx in schema.properties) {
let prop = schema.properties[idx]
const def = propType[prop.type]
prop = pick(defaultsDeep(prop, def), this.getPropertyKeysByType(prop.type))
if (!keys(propType).includes(prop.type)) this.fatal('unknownPropType%s%s', `${prop.name}.${def.name}`, prop.type)
if (prop.type === 'string') {
prop.minLength = parseInt(prop.minLength) ?? 0
prop.maxLength = parseInt(prop.maxLength) ?? 255
if (prop.minLength > 0) prop.required = true
if (prop.minLength === 0) delete prop.minLength
}
schema.properties[idx] = prop
}
// indexes
for (const index of schema.indexes) {
if (!indexTypes.includes(index.type)) this.fatal('unknownIndexType%s%s', index.type, schema.name)
for (const field of index.fields) {
if (!allPropNames.includes(field)) this.fatal('unknownPropNameOnIndex%s%s', field, schema.name)
}
}
await runHook(`dobo.${camelCase(schema.name)}:afterSanitizeModel`, schema)
// sorting only possible using these fields
schema.sortables = []
for (const index of schema.indexes) {
schema.sortables.push(...index.fields)
}
schema.hidden = filter(uniq(schema.hidden), prop => allPropNames.includes(prop))
}
/**
* Creates a model schema by sanitizing its properties, features, and indexes, and ensuring that all references are valid.
* It also applies any buildStart and buildEnd handlers defined in the schema.
* @param {object} item - The model definition object
* @returns {object} - The sanitized model schema
*/
async function createSchema (item) {
const { find, orderBy, get } = this.app.lib._
const { mergeObjectsByKey, defaultsDeep, parseObject } = this.app.lib.aneka
const feats = item.features ?? []
const props = item.properties ?? []
const indexes = item.indexes ?? []
item.features = []
item.properties = []
item.indexes = []
item.hidden = item.hidden ?? []
item.rules = item.rules ?? []
item.buildLevel = item.buildLevel ?? 999
item.hooks = item.hooks ?? []
item.disabled = item.disabled ?? []
item.scanables = item.scanables ?? []
if (item.disabled === 'all') item.disabled = ['find', 'get', 'create', 'update', 'remove']
else if (item.disabled === 'readonly') item.disabled = ['create', 'update', 'remove']
const conn = item.connection ?? 'default'
if (!(conn instanceof this.app.baseClass.DoboConnection)) {
item.connection = null
// Is there any overwritten connection?
const newConn = find(this.connections, c => c.options.models.includes(item.name))
if (newConn) item.connection = newConn
else {
item.connection = this.getConnection(conn, true)
if (!item.connection && conn === 'default') item.connection = this.getConnection('memory')
}
if (!item.connection) this.fatal('unknownConn%s%s', conn, item.name)
}
// cache settings
const defCache = defaultsDeep({}, item.connection.options.cache, get(this, 'app.bajoCache.config.default', this.config.default.cache))
if (item.cache === false) item.cache = { ttlDur: 0 }
else if (item.cache === true) item.cache = defCache
else item.cache = defaultsDeep({}, item.cache, defCache)
item.cache = parseObject(item.cache)
if (item.connection.name === 'memory') item.cache.ttlDur = 0
// let's run
await findAllProps.call(this, item, props, indexes)
await findAllFeats.call(this, item, feats, indexes)
await findAllIndexes.call(this, item, indexes)
for (const key of ['properties', 'indexes']) {
item[key] = mergeObjectsByKey(item[key], 'name')
}
item.hooks = orderBy(item.hooks, ['name', 'level'])
delete item.features
await sanitizeAll.call(this, item)
return item
}
/**
* Collects all model schemas from the application, sanitizes them, and creates model instances.
* It also handles any buildStart and buildEnd handlers defined in the model definitions.
* @async
* @method
* @returns {Promise<void>}
*/
export async function collectModels () {
const { eachPlugins, callHandler } = this.app.bajo
const { orderBy, has, omit } = this.app.lib._
await actionFactory.call(this)
await modelFactory.call(this)
this.log.trace('collecting%s', this.t('model'))
const me = this
let schemas = []
await eachPlugins(async function ({ file }) {
const { readConfig, callHandler } = this.app.bajo
const { pascalCase } = this.app.lib.aneka
const { isPlainObject, isEmpty, isArray } = this.app.lib._
let items = await readConfig(file, { ns: this.ns, baseNs: me.ns, merge: true })
if (isEmpty(items)) return undefined
if (isPlainObject(items)) {
items.baseName = items.baseName ?? path.basename(file, path.extname(file))
items.name = items.name ?? pascalCase(`${this.alias} ${items.baseName}`)
}
if (!isArray(items)) items = [items]
for (const item of items) {
if (!item.baseName) me.fatal('missing%s%s', 'baseName', file)
item.name = item.name ?? pascalCase(`${this.alias} ${item.baseName}`)
me.log.trace('- %s', item.name)
item.collName = item.collName ?? item.name
item.options = item.options ?? {}
item.options.attachment = item.options.attachment ?? true
item.options.persistence = item.options.persistence ?? true
item.ns = this.ns
if (item.buildStart) await callHandler(this, item.buildStart, item)
const schema = await createSchema.call(me, item)
schemas.push(schema)
}
}, { glob: ['model/*.*', 'model.*'], prefix: this.ns })
schemas = orderBy(schemas, ['buildLevel', 'name'])
for (const schema of schemas) {
const idProp = schema.properties.find(p => p.name === 'id')
if (!this.constructor.idTypes.includes(idProp.type)) this.fatal('invalidIdType%s%s', schema.name, this.constructor.idTypes.join(', '))
if (idProp.type === 'string' && !has(idProp, 'maxLength')) idProp.maxLength = 50
const plugin = this.app[schema.ns]
await sanitizeRef.call(this, schema, schemas)
for (const item of schema.indexes) {
for (const field of item.fields) {
const prop = schema.properties.find(p => p.name === field)
if (!prop || (prop && prop.virtual)) throw this.error('virtualFieldIn%s%s%s', field, 'index', schema.name)
}
}
for (const field of schema.scanables) {
const prop = schema.properties.find(p => p.name === field)
if (!prop || (prop && prop.virtual)) throw this.error('virtualFieldIn%s%s%s', field, 'scanable', schema.name)
}
const model = new this.app.baseClass.DoboModel(plugin, omit(schema, ['beforeCreate', 'afterCreate']))
me.models.push(model)
if (schema.buildEnd) await callHandler(plugin, schema.buildEnd, model)
}
schemas = []
this.log.debug('collected%s%d', this.t('model'), this.models.length)
}
/**
* Collects all model features from loaded plugins
* @async
* @method
* @returns {Promise<void>}
*/
export async function collectFeatures () {
const { eachPlugins } = this.app.bajo
await featureFactory.call(this)
this.log.trace('collecting%s', this.t('feature'))
const me = this
await eachPlugins(async function ({ file }) {
const { importModule } = this.app.bajo
const { camelCase, isFunction } = this.app.lib._
const name = camelCase(path.basename(file, '.js'))
const handler = await importModule(file)
if (!isFunction(handler)) this.fatal('invalidFeatureHandler%s%s', this.ns, name)
me.features.push(new this.app.baseClass.DoboFeature(this, { name, handler }))
me.log.trace('- %s:%s', this.ns, name)
}, { glob: 'feature/*.js', prefix: this.ns })
this.log.debug('collected%s%d', this.t('feature'), this.features.length)
}
/**
* Collects all database connections from loaded plugins, initializes their adapters, and ensures that a default connection is available.
* It also handles any memory-based connections and merges their models into a single memory connection.
* @async
* @method
* @returns {Promise<void>}
*/
export async function collectConnections () {
const { buildCollections } = this.app.bajo
const { pullAt } = this.app.lib._
const { filterIndex } = this.app.lib.aneka
await connectionFactory.call(this)
async function handler ({ item }) {
const { has } = this.app.lib._
if (!has(item, 'adapter')) this.fatal('unknownDbAdapter%s')
const conn = new this.app.baseClass.DoboConnection(this, item)
await conn.initAdapter(item.adapter)
return conn
}
const memIndexes = filterIndex(this.config.connections, current => current.adapter === 'dobo:memory' || current.name === 'memory')
const models = memIndexes.map(idx => [...(this.config.connections[idx].models ?? [])])
pullAt(this.config.connections, memIndexes)
this.config.connections.push({
adapter: 'dobo:memory',
name: 'memory',
models
})
this.connections = await buildCollections({ ns: this.ns, container: 'connections', handler, dupChecks: ['name'] })
const defConn = this.connections.find(conn => conn.name === 'default')
if (!defConn) this.log.warn('noDefaultConnection')
}
/**
* Collects all database adapters from loaded plugins.
* @async
* @method
* @returns {Promise<void>}
*/
export async function collectAdapters () {
const { eachPlugins, runHook } = this.app.bajo
const { importModule } = this.app.bajo
const { camelCase, isFunction } = this.app.lib._
await adapterFactory.call(this)
this.log.trace('collecting%s', this.t('adapter'))
const me = this
await runHook(`${this.ns}:beforeCollectAdapters`)
await eachPlugins(async function ({ file }) {
const name = camelCase(path.basename(file, '.js'))
const factory = await importModule(file)
if (!isFunction(factory)) this.fatal('invalidAdapterClassFactory%s%s', this.ns, name)
const Cls = await factory.call(this)
const instance = new Cls(this, name)
if (!(instance instanceof this.app.baseClass.DoboAdapter)) this.fatal('invalidAdapterClass%s%s', this.ns, name)
me.adapters.push(instance)
me.log.trace('- %s:%s', this.ns, name)
}, { glob: 'adapter/*.js', prefix: this.ns })
await runHook(`${this.ns}:afterCollectAdapters`)
this.log.debug('collected%s%d', this.t('adapter'), this.adapters.length)
}
</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>