dobo 2.13.0 → 2.14.1

package/index.js

@@ -150,13 +150,14 @@ async function factory (pkgName) {
           filter: {
             limit: 25, // num of records per page
             maxLimit: 200, // max num of records per page
-            hardCap: 10000, // max returned records
             maxPage: 50, // max allowed page number
             sort: ['dt:-1', 'updatedAt:-1', 'updated_at:-1', 'createdAt:-1', 'createdAt:-1', 'ts:-1', 'username', 'name']
           },
           cache: {
             ttlDur: '10s'
-          }
+          },
+          hardCap: 10000, // max returned records
+          warnings: true
         },
         memDb: {
           autoSaveDur: '1s'
@@ -497,12 +498,13 @@ async function factory (pkgName) {
     getDefaultValues = (options = {}) => {
       const { get } = this.app.lib._
       const config = this.app.dobo.config
-      const limit = get(options, 'req.site.setting.dobo.default.limit', config.default.filter.limit)
-      const maxLimit = get(options, 'req.site.setting.dobo.default.maxLimit', config.default.filter.maxLimit)
-      const hardCap = get(options, 'req.site.setting.dobo.default.hardCap', config.default.filter.hardCap)
-      const maxPage = get(options, 'req.site.setting.dobo.default.maxPage', config.default.filter.maxPage)
+      const limit = get(options, 'req.site.setting.dobo.default.filter.limit', config.default.filter.limit)
+      const maxLimit = get(options, 'req.site.setting.dobo.default.filter.maxLimit', config.default.filter.maxLimit)
+      const maxPage = get(options, 'req.site.setting.dobo.default.filter.maxPage', config.default.filter.maxPage)
+      const hardCap = get(options, 'req.site.setting.dobo.default.hardCap', config.default.hardCap)
+      const warnings = get(options, 'req.site.setting.dobo.default.warnings', config.default.warnings)
       const t = options.req ? options.req.t : this.t
-      return { limit, maxLimit, hardCap, maxPage, t }
+      return { limit, maxLimit, hardCap, maxPage, warnings, t }
     }
 
     handleLastPage = (params = {}, options = {}) => {

package/lib/factory/model/_util.js

@@ -236,6 +236,22 @@ export async function getMultiRefs (records = [], options = {}) {
   }
 }
 
+export function parseNql (text) {
+  const sanitized = text.split('+').map(item => {
+    const [key, ...rest] = item.split(':').map(i => i.trim())
+    let value = rest.join(':')
+    const neg = value[1] === '-' ? '-' : ''
+    if ((value[0] === '{' || value[1] === '{') && value[value.length - 1] === '}') {
+      if (value[0] === '-') value = value.slice(1)
+      const items = value.slice(1, -1).split(',')
+      value = `${neg}>=${items[0]}+${key}:${neg}<=${items[1]}`
+    }
+    return `${key}:${value}`
+  }).join('+')
+
+  return nql(sanitized).parse()
+}
+
 export function buildFilterQuery (filter = {}) {
   const { trim, find, isString, isPlainObject } = this.app.lib._
   let query = filter.query ?? {}
@@ -244,7 +260,7 @@ export function buildFilterQuery (filter = {}) {
     try {
       query = trim(query)
       if (query.startsWith('{')) q = JSON.parse(query) // JSON formatted query
-      else if (query.includes(':')) q = nql(query).parse() // NQL
+      else if (query.includes(':')) q = parseNql.call(this, query) // NQL
       else {
         let scanables = [...this.scanables]
         if (scanables.length === 0) scanables = [...this.sortables]

package/lib/factory/model/count-record.js

@@ -16,8 +16,11 @@ async function countRecord (...args) {
     result.warnings = result.warnings ?? []
     result.warnings.push(t('hardCapWarning%s%s', result.data, hardCap))
     result.orgCount = result.data
+    result.hardCapped = true
     result.data = hardCap
   }
+  const { warnings } = getDefaultValues(options)
+  if (!warnings) delete result.warnings
   await execDynHook.call(this, 'afterCountRecord', filter, result, options)
   await execModelHook.call(this, 'afterCountRecord', filter, result, options)
   await execHook.call(this, 'afterCountRecord', filter, result, options)

package/lib/factory/model/create-aggregate.js

@@ -6,10 +6,13 @@ async function createAggregate (...args) {
   const [_filter = {}, params = {}, opts = {}] = args
   const { dataOnly = true } = opts
   const { filter, options } = await getFilterAndOptions.call(this, _filter, opts, action)
+  const { getDefaultValues } = this.app.dobo
   await execHook.call(this, 'beforeCreateAggregate', filter, params, options)
   await execModelHook.call(this, 'beforeCreateAggregate', filter, params, options)
   await execDynHook.call(this, 'beforeCreateAggregate', filter, params, options)
   const result = (await this.driver._createAggregate(this, filter, params, options)) ?? {}
+  const { warnings } = getDefaultValues(options)
+  if (!warnings) delete result.warnings
   await execDynHook.call(this, 'afterCreateAggregate', filter, params, result, options)
   await execModelHook.call(this, 'afterCreateAggregate', filter, params, result, options)
   await execHook.call(this, 'afterCreateAggregate', filter, params, result, options)

package/lib/factory/model/create-histogram.js

@@ -6,10 +6,13 @@ async function createHistogram (...args) {
   const [_filter = {}, params = {}, opts = {}] = args
   const { dataOnly = true } = opts
   const { filter, options } = await getFilterAndOptions.call(this, _filter, opts, action)
+  const { getDefaultValues } = this.app.dobo
   await execHook.call(this, 'beforeCreateHistogram', filter, params, options)
   await execModelHook.call(this, 'beforeCreateHistogram', filter, params, options)
   await execDynHook.call(this, 'beforeCreateHistogram', filter, params, options)
   const result = (await this.driver._createHistogram(this, filter, params, options)) ?? {}
+  const { warnings } = getDefaultValues(options)
+  if (!warnings) delete result.warnings
   await execDynHook.call(this, 'afterCreateHistogram', filter, params, result, options)
   await execModelHook.call(this, 'afterCreateHistogram', filter, params, result, options)
   await execHook.call(this, 'afterCreateHistogram', filter, params, result, options)

package/lib/factory/model/create-record.js

@@ -6,6 +6,7 @@ const action = 'createRecord'
 async function createRecord (...args) {
   if (args.length === 0) return this.action(action, ...args)
   const [body = {}, opts = {}] = args
+  const { getDefaultValues } = this.app.dobo
   const { isSet } = this.app.lib.aneka
   const { runHook } = this.app.bajo
   const { cloneDeep, get } = this.app.lib._
@@ -24,6 +25,8 @@ async function createRecord (...args) {
     return
   }
   result = result ?? {}
+  const { warnings } = getDefaultValues(options)
+  if (!warnings) delete result.warnings
   if (!noResultSanitizer) result.data = await this.sanitizeRecord(result.data, options)
   if (isSet(options.refs)) await getSingleRef.call(this, result.data, options)
   await handleReq.call(this, result.data.id, 'created', options)

package/lib/factory/model/find-all-record.js

@@ -3,11 +3,13 @@ const action = 'findAllRecord'
 
 async function native (...args) {
   const { isSet } = this.app.lib.aneka
-  const { cloneDeep } = this.app.lib._
+  const { getDefaultValues, t } = this.app.dobo
+  const { cloneDeep, pick, omit } = this.app.lib._
   const [params = {}, opts = {}] = args
   const { dataOnly = true } = opts
   const { get: getCache, set: setCache } = this.app.bajoCache ?? {}
   const { filter, options } = await getFilterAndOptions.call(this, params, opts, action)
+  const { hardCap, warnings } = getDefaultValues(options)
   if (dataOnly) options.count = false
   let { noResultSanitizer, noCache } = options
   await execHook.call(this, 'beforeFindRecord', filter, options)
@@ -25,7 +27,19 @@ async function native (...args) {
       return dataOnly ? result.data : result
     }
   }
-  const result = options.record ?? (await this.driver._findAllRecord(this, filter, options)) ?? {}
+  let result = options.record ?? (await this.driver._findAllRecord(this, filter, options)) ?? {}
+  result.limit = filter.limit
+  result.filter = pick(filter, ['query', 'match', 'sort'])
+  result.warnings = result.warnings ?? []
+  if (!options.count) result = omit(result, ['count', 'pages'])
+  else if (options.count && result.count > hardCap) {
+    result.warnings.push(t('hardCapWarning%s%s', result.count, hardCap))
+    result.count = hardCap
+    result.hardCapped = true
+  }
+  result.pages = options.count ? Math.ceil(result.count / filter.limit) : undefined
+  if (!warnings) delete result.warnings
+
   if (!noResultSanitizer) {
     for (const idx in result.data) {
       result.data[idx] = await this.sanitizeRecord(result.data[idx], options)
@@ -48,7 +62,7 @@ async function loop (...args) {
   const [params = {}, opts = {}] = args
   const { dataOnly = true } = opts
   const { filter, options } = await getFilterAndOptions.call(this, params, opts, action)
-  const { maxLimit, hardCap } = getDefaultValues(options)
+  const { maxLimit, hardCap, warnings: showWarnings } = getDefaultValues(options)
   const nFilter = cloneDeep(filter || {})
   const nOptions = cloneOptions.call(this, options)
   nOptions.count = false
@@ -71,7 +85,9 @@ async function loop (...args) {
     count = count + result.data.length
     nFilter.page++
   }
-  return dataOnly ? data : { data, count, warnings }
+  const result = { data, count, warnings }
+  if (!showWarnings) delete result.warnings
+  return dataOnly ? data : result
 }
 
 async function findAllRecord (...args) {

package/lib/factory/model/find-one-record.js

@@ -4,6 +4,7 @@ const action = 'findOneRecord'
 
 async function findOneRecord (...args) {
   if (args.length === 0) return this.action(action, ...args)
+  const { getDefaultValues } = this.app.dobo
   const [params = {}, opts = {}] = args
   const { cloneDeep } = this.app.lib._
   const { dataOnly = true } = opts
@@ -13,9 +14,12 @@ async function findOneRecord (...args) {
   nOptions.count = false
   nOptions.dataOnly = false
   nFilter.limit = 1
-  const result = await this.findRecord(nFilter, nOptions)
-  const data = result.data[0]
-  return dataOnly ? data : { data, cached: result.cached, warnings: result.warnings }
+  const { warnings } = getDefaultValues(nOptions)
+  const resp = await this.findRecord(nFilter, nOptions)
+  const data = resp.data[0]
+  const result = { data, cached: resp.cached, warnings: resp.warnings }
+  if (!warnings) delete result.warnings
+  return dataOnly ? data : result
 }
 
 export default findOneRecord

package/lib/factory/model/find-record.js

@@ -73,7 +73,7 @@ async function findRecord (...args) {
   const { dataOnly = true } = opts
   const { get: getCache, set: setCache } = this.app.bajoCache ?? {}
   const { filter, options } = await getFilterAndOptions.call(this, params, opts, action)
-  const { hardCap } = getDefaultValues(options)
+  const { hardCap, warnings } = getDefaultValues(options)
   if (dataOnly) options.count = false
   let { noResultSanitizer, noCache } = options
   await execHook.call(this, 'beforeFindRecord', filter, options)
@@ -100,8 +100,10 @@ async function findRecord (...args) {
   else if (options.count && result.count > hardCap) {
     result.warnings.push(t('hardCapWarning%s%s', result.count, hardCap))
     result.count = hardCap
+    result.hardCapped = true
   }
   result.pages = options.count ? Math.ceil(result.count / filter.limit) : undefined
+  if (!warnings) delete result.warnings
 
   if (!noResultSanitizer) {
     for (const idx in result.data) {

package/lib/factory/model/get-record.js

@@ -45,6 +45,7 @@ const action = 'getRecord'
 async function getRecord (...args) {
   if (args.length === 0) return this.action(action, ...args)
   let [id, opts = {}] = args
+  const { getDefaultValues } = this.app.dobo
   const { isEmpty } = this.app.lib._
   const { isSet } = this.app.lib.aneka
   const { get: getCache, set: setCache } = this.app.bajoCache ?? {}
@@ -66,6 +67,8 @@ async function getRecord (...args) {
     }
   }
   const result = options.record ?? (await this.driver._getRecord(this, id, options)) ?? {}
+  const { warnings } = getDefaultValues(options)
+  if (!warnings) delete result.warnings
   if (isEmpty(result.data) && !options.throwNotFound) return dataOnly ? undefined : { data: undefined }
   if (!noResultSanitizer) result.data = await this.sanitizeRecord(result.data, options)
   if (isSet(options.refs)) await getSingleRef.call(this, result.data, options)

package/lib/factory/model/remove-record.js

@@ -34,6 +34,7 @@ const action = 'removeRecord'
 async function removeRecord (...args) {
   if (args.length === 0) return this.action(action, ...args)
   let [id, opts = {}] = args
+  const { getDefaultValues } = this.app.dobo
   const { isSet } = this.app.lib.aneka
   const { runHook } = this.app.bajo
   const { dataOnly = true } = opts
@@ -48,6 +49,8 @@ async function removeRecord (...args) {
     await runHook('cache:clear', this, 'remove', id)
     return
   }
+  const { warnings } = getDefaultValues(options)
+  if (!warnings) delete result.warnings
   if (!noResultSanitizer) result.oldData = await this.sanitizeRecord(result.oldData, options)
   if (isSet(options.refs)) await getSingleRef.call(this, result.data, options)
   await handleReq.call(this, result.oldData.id, 'removed', options)

package/lib/factory/model/sanitize-record.js

@@ -11,9 +11,11 @@
  */
 async function sanitizeRecord (record = {}, opts = {}) {
   const { fields = [], hidden = [], forceNoHidden } = opts
-  const { isEmpty, map, without } = this.app.lib._
+  const { isEmpty, map, without, isArray } = this.app.lib._
   const { fillObject } = this.app.lib.aneka
-  const allHidden = forceNoHidden ? [] : without([...this.hidden, ...hidden], 'id')
+  let allHidden = without([...this.hidden, ...hidden], 'id')
+  if (forceNoHidden === true) allHidden = []
+  else if (isArray(forceNoHidden)) allHidden = without(allHidden, ...forceNoHidden)
   let newFields = [...fields]
   if (isEmpty(newFields)) newFields = map(this.properties, prop => prop.name)
   if (!newFields.includes('id')) newFields.unshift('id')

package/lib/factory/model/update-record.js

@@ -47,6 +47,7 @@ const action = 'updateRecord'
 async function updateRecord (...args) {
   if (args.length === 0) return this.action(action, ...args)
   let [id, body = {}, opts = {}] = args
+  const { getDefaultValues } = this.app.dobo
   const { isSet } = this.app.lib.aneka
   const { runHook } = this.app.bajo
   const { cloneDeep, get, omit } = this.app.lib._
@@ -69,6 +70,8 @@ async function updateRecord (...args) {
     await runHook('cache:clear', this, 'update', id, body)
     return
   }
+  const { warnings } = getDefaultValues(options)
+  if (!warnings) delete result.warnings
   if (!noResultSanitizer) {
     result.data = await this.sanitizeRecord(result.data, options)
     result.oldData = await this.sanitizeRecord(result.oldData, options)

package/lib/factory/model/upsert-record.js

@@ -3,6 +3,7 @@ const action = 'upsertRecord'
 
 async function native (body = {}, opts = {}) {
   const { isSet } = this.app.lib.aneka
+  const { getDefaultValues } = this.app.dobo
   const { runHook } = this.app.bajo
   const { cloneDeep, get } = this.app.lib._
   const { dataOnly = true } = opts
@@ -19,6 +20,8 @@ async function native (body = {}, opts = {}) {
     await runHook('cache:clear', this, 'upsert', body)
     return
   }
+  const { warnings } = getDefaultValues(options)
+  if (!warnings) delete result.warnings
   if (!noResultSanitizer) result.data = await this.sanitizeRecord(result.data, options)
   if (isSet(options.refs)) await getSingleRef.call(this, result.data, options)
   await handleReq.call(this, result.data.id, 'upserted', options)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dobo",
-  "version": "2.13.0",
+  "version": "2.14.1",
   "description": "DBMS for Bajo Framework",
   "main": "index.js",
   "scripts": {

package/wiki/CHANGES.md

@@ -1,5 +1,9 @@
 # Changes
 
+## 2026-04-01
+
+- [2.14.0] Add ```between``` as custom query, since it doesn't exists in NQL
+
 ## 2026-03-30
 
 - [2.12.0] Add ```.bootorder``` level 10