dobo 2.38.0 → 2.39.1

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

@@ -1,82 +1,82 @@
-import { getFilterAndOptions, execHook, execModelHook, execDynHook, getRefs, sanitizeQuery } from './helper.js'
-const action = 'findRecord'
-
-/**
- * @typedef TFilter
- * @type {Object}
- * @memberof DoboModel
- * @see Dobo#recordFind
- * @see Dobo#recordFindOne
- * @see Dobo#recordFindAll
- * @property {(string|Object)} [query={}] - Query definition. See {@tutorial query-language} for more
- * @property {number} limit - Maximum number of records to return
- * @property {number} page - Which page to return
- * @property {number} skip - Records to skip
- * @property {DoboModel.TSort} sort - Sort order info
- */
-
-/**
- * Finds records in the model's underlying data store that match the provided filter criteria.
- *
- * If no arguments are provided, it automatically turns into a chainable {@link DoboAction} object.
- * @async
- * @memberof DoboModel
- * @method
- * @param {DoboModel.TFilter} [filter={}] - The filter criteria to apply when finding records.
- * @param {DoboModel.TOptions} [opts={}] - Options object.
- * @returns {DoboAction|DoboModel.TResultFindRecord|Array.<DoboModel.TRecord>}
- * @see {@link module:Hook.beforeFindRecord}
- * @see {@link module:Hook.afterFindRecord}
- */
-async function findRecord (...args) {
-  if (args.length === 0) return this.action(action, ...args)
-  const { getDefaultValues, t } = this.app.dobo
-  const [params = {}, opts = {}] = args
-  const { isSet } = this.app.lib.aneka
-  const { pick, omit, cloneDeep } = this.app.lib._
-  const { get, set } = this.app.bajoCache ?? {}
-  opts.dataOnly = opts.dataOnly ?? true
-  const { dataOnly } = opts
-  const { filter, options } = await getFilterAndOptions.call(this, params, opts, action)
-  const { hardCap, warnings } = getDefaultValues(options)
-  if (dataOnly) options.count = false
-  const { noResultSanitizer } = options
-  await execHook.call(this, 'beforeFindRecord', filter, options)
-  await execModelHook.call(this, 'beforeFindRecord', filter, options)
-  await execDynHook.call(this, 'beforeFindRecord', filter, options)
-  filter.query = sanitizeQuery.call(this, filter.query)
-  const cFilter = cloneDeep(filter)
-  if (get) {
-    const resp = await get({ model: this, action, filter: cFilter, options })
-    if (resp) {
-      resp.cached = true
-      return dataOnly ? resp.data : resp
-    }
-  }
-  let result = options.record ?? (await this.adapter._findRecord(this, filter, options)) ?? {}
-  result.page = filter.page
-  result.limit = filter.limit
-  result.filter = pick(filter, ['query', 'search', '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 (isSet(options.refs)) await getRefs.call(this, result.data, options)
-  if (!noResultSanitizer) {
-    for (const idx in result.data) {
-      result.data[idx] = await this.sanitizeRecord(result.data[idx], options)
-    }
-  }
-  await execDynHook.call(this, 'afterFindRecord', filter, result, options)
-  await execModelHook.call(this, 'afterFindRecord', filter, result, options)
-  await execHook.call(this, 'afterFindRecord', filter, result, options)
-  if (set) await set({ model: this, action, filter: cFilter, options, result })
-  return dataOnly ? result.data : result
-}
-
-export default findRecord
+import { getFilterAndOptions, execHook, execModelHook, execDynHook, getRefs, sanitizeQuery } from './helper.js'
+const action = 'findRecord'
+
+/**
+ * @typedef TFilter
+ * @type {Object}
+ * @memberof DoboModel
+ * @see Dobo#recordFind
+ * @see Dobo#recordFindOne
+ * @see Dobo#recordFindAll
+ * @property {(string|Object)} [query={}] - Query definition. See {@tutorial query-language} for more
+ * @property {number} limit - Maximum number of records to return
+ * @property {number} page - Which page to return
+ * @property {number} skip - Records to skip
+ * @property {DoboModel.TSort} sort - Sort order info
+ */
+
+/**
+ * Finds records in the model's underlying data store that match the provided filter criteria.
+ *
+ * If no arguments are provided, it automatically turns into a chainable {@link DoboAction} object.
+ * @async
+ * @memberof DoboModel
+ * @method
+ * @param {DoboModel.TFilter} [filter={}] - The filter criteria to apply when finding records.
+ * @param {DoboModel.TOptions} [opts={}] - Options object.
+ * @returns {DoboAction|DoboModel.TResultFindRecord|Array.<DoboModel.TRecord>}
+ * @see {@link module:Hook.beforeFindRecord}
+ * @see {@link module:Hook.afterFindRecord}
+ */
+async function findRecord (...args) {
+  if (args.length === 0) return this.action(action, ...args)
+  const { getDefaultValues, t } = this.app.dobo
+  const [params = {}, opts = {}] = args
+  const { isSet } = this.app.lib.aneka
+  const { pick, omit, cloneDeep } = this.app.lib._
+  const { get, set } = this.app.bajoCache ?? {}
+  opts.dataOnly = opts.dataOnly ?? true
+  const { dataOnly } = opts
+  const { filter, options } = await getFilterAndOptions.call(this, params, opts, action)
+  const { hardCap, warnings } = getDefaultValues(options)
+  if (dataOnly) options.count = false
+  const { noResultSanitizer } = options
+  await execHook.call(this, 'beforeFindRecord', filter, options)
+  await execModelHook.call(this, 'beforeFindRecord', filter, options)
+  await execDynHook.call(this, 'beforeFindRecord', filter, options)
+  filter.query = sanitizeQuery.call(this, filter.query)
+  const cFilter = cloneDeep(filter)
+  if (get) {
+    const resp = await get({ model: this, action, filter: cFilter, options })
+    if (resp) {
+      resp.cached = true
+      return dataOnly ? resp.data : resp
+    }
+  }
+  let result = options.record ?? (await this.adapter._findRecord(this, filter, options)) ?? {}
+  result.page = filter.page
+  result.limit = filter.limit
+  result.filter = pick(filter, ['query', 'search', '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 (isSet(options.refs)) await getRefs.call(this, result.data, options)
+  if (!noResultSanitizer) {
+    for (const idx in result.data) {
+      result.data[idx] = await this.sanitizeRecord(result.data[idx], options)
+    }
+  }
+  await execDynHook.call(this, 'afterFindRecord', filter, result, options)
+  await execModelHook.call(this, 'afterFindRecord', filter, result, options)
+  await execHook.call(this, 'afterFindRecord', filter, result, options)
+  if (set) await set({ model: this, action, filter: cFilter, options, result })
+  return dataOnly ? result.data : result
+}
+
+export default findRecord

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

@@ -1,15 +1,15 @@
-const action = 'getAttachment'
-
-async function getAttachment (...args) {
-  if (!this.options.attachment) return
-  if (args.length === 0) return this.action(action, ...args)
-  let [id, field, file, opts = {}] = args
-  const { find } = this.app.lib._
-  const all = await this.findAttachment(id, opts)
-  if (field === 'null') field = null
-  const data = find(all, { field, file })
-  if (!data) throw this.error('notFound', { statusCode: 404 })
-  return data
-}
-
-export default getAttachment
+const action = 'getAttachment'
+
+async function getAttachment (...args) {
+  if (!this.options.attachment) return
+  if (args.length === 0) return this.action(action, ...args)
+  let [id, field, file, opts = {}] = args
+  const { find } = this.app.lib._
+  const all = await this.findAttachment(id, opts)
+  if (field === 'null') field = null
+  const data = find(all, { field, file })
+  if (!data) throw this.error('notFound', { statusCode: 404 })
+  return data
+}
+
+export default getAttachment

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

@@ -1,52 +1,52 @@
-import { getFilterAndOptions, execHook, execModelHook, execDynHook, getRefs } from './helper.js'
-const action = 'getRecord'
-
-/**
- * Gets a record from the model's underlying data store based on the provided ID.
- *
- * If no arguments are provided, it automatically turns into a chainable {@link DoboAction} object.
- * @async
- * @memberof DoboModel
- * @method
- * @param  {string|number} id - The ID of the record to be retrieved.
- * @param  {DoboModel.TOptions} [opts] - Options object.
- * @returns {DoboAction|DoboModel.TResultGetRecord|DoboModel.TRecord}
- * @see {@link module:Hook.beforeGetRecord}
- * @see {@link module:Hook.afterGetRecord}
- */
-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, set } = this.app.bajoCache ?? {}
-  opts.dataOnly = opts.dataOnly ?? true
-  const { dataOnly } = opts
-  const { options } = await getFilterAndOptions.call(this, null, opts, action)
-  const { noResultSanitizer } = options
-  id = this.sanitizeId(id)
-  await execHook.call(this, 'beforeGetRecord', id, options)
-  await execModelHook.call(this, 'beforeGetRecord', id, options)
-  await execDynHook.call(this, 'beforeGetRecord', id, options)
-  if (get) {
-    const resp = await get({ model: this, action, id, options })
-    if (resp) {
-      resp.cached = true
-      return dataOnly ? resp.data : resp
-    }
-  }
-  const result = options.record ?? (await this.adapter._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 (isSet(options.refs)) await getRefs.call(this, [result.data], options)
-  if (!noResultSanitizer) result.data = await this.sanitizeRecord(result.data, options)
-  await execDynHook.call(this, 'afterGetRecord', id, result, options)
-  await execModelHook.call(this, 'afterGetRecord', id, result, options)
-  await execHook.call(this, 'afterGetRecord', id, result, options)
-  if (set) await set({ model: this, action, id, options, result })
-  return dataOnly ? result.data : result
-}
-
-export default getRecord
+import { getFilterAndOptions, execHook, execModelHook, execDynHook, getRefs } from './helper.js'
+const action = 'getRecord'
+
+/**
+ * Gets a record from the model's underlying data store based on the provided ID.
+ *
+ * If no arguments are provided, it automatically turns into a chainable {@link DoboAction} object.
+ * @async
+ * @memberof DoboModel
+ * @method
+ * @param  {string|number} id - The ID of the record to be retrieved.
+ * @param  {DoboModel.TOptions} [opts] - Options object.
+ * @returns {DoboAction|DoboModel.TResultGetRecord|DoboModel.TRecord}
+ * @see {@link module:Hook.beforeGetRecord}
+ * @see {@link module:Hook.afterGetRecord}
+ */
+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, set } = this.app.bajoCache ?? {}
+  opts.dataOnly = opts.dataOnly ?? true
+  const { dataOnly } = opts
+  const { options } = await getFilterAndOptions.call(this, null, opts, action)
+  const { noResultSanitizer } = options
+  id = this.sanitizeId(id)
+  await execHook.call(this, 'beforeGetRecord', id, options)
+  await execModelHook.call(this, 'beforeGetRecord', id, options)
+  await execDynHook.call(this, 'beforeGetRecord', id, options)
+  if (get) {
+    const resp = await get({ model: this, action, id, options })
+    if (resp) {
+      resp.cached = true
+      return dataOnly ? resp.data : resp
+    }
+  }
+  const result = options.record ?? (await this.adapter._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 (isSet(options.refs)) await getRefs.call(this, [result.data], options)
+  if (!noResultSanitizer) result.data = await this.sanitizeRecord(result.data, options)
+  await execDynHook.call(this, 'afterGetRecord', id, result, options)
+  await execModelHook.call(this, 'afterGetRecord', id, result, options)
+  await execHook.call(this, 'afterGetRecord', id, result, options)
+  if (set) await set({ model: this, action, id, options, result })
+  return dataOnly ? result.data : result
+}
+
+export default getRecord