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

DBMS for Bajo Framework

import { getFilterAndOptions, execHook, execValidation, execModelHook, execDynHook, getRefs, handleReq, clearCache } from './_util.js'
import { onlyTypes } from './create-record.js'
const action = 'updateRecord'

/**
 * @typedef {Object} TRecordUpdateOptions
 * @see Model#updateRecord
 * @property {boolean} [dataOnly=true] - If ```true``` (default) returns record's object. Otherwise {@link TRecordUpdateResult}
 * @property {boolean} [noHook=false] - If ```true```, no model's hook will be executed
 * @property {boolean} [noModelHook=false] - If ```true```, no model's hook will be executed
 * @property {boolean} [noValidation=false] - If ```true```, no validation of data payload performed
 * @property {boolean} [noCheckUnique=false] - If ```true```, no unique validation for ID performed
 * @property {boolean} [noBodySanitizer=false] - If ```true```, accept data payload as is without sanitization
 * @property {boolean} [noRecordSanitizer=false] - If ```true```, accept result payload as is without sanitization
 * @property {boolean} [noResult=false] - If ```true```, returns nothing
 * @property {boolean} [truncateString=true] - If ```true``` (default), string is truncated to its model's ```maxLength```
 * @property {boolean} [partial=true] - If ```true``` (default), only updated values are saved. Otherwise replace all existing values with given payload
 * @property {boolean} [fields=[]] - If not empty, return only these fields EXCLUDING hidden fields
 * @property {boolean} [hidden=[]] - Additional fields to hide, in addition the one set in model's model
 * @property {boolean} [forceNoHidden=false] - If ```true```, hidden fields will be ignored and ALL fields will be returned
 */

/**
 * Update a record by it's ID and body payload
 *
 * Example:
 * ```javascript
 * const { recordUpdate } = this.app.dobo
 * const { body } = {
 *   name: 'Republic of Indonesia',
 *   phoneCode: '+62'
 * }
 * const result = await recordUpdate('CdbCountry', 'ID', body)
 * ```
 *
 * @method
 * @memberof Dobo
 * @async
 * @instance
 * @name recordUpdate
 * @param {string} name - Model's name
 * @param {(string|number)} id - Record's ID
 * @param {Object} body - Body payload
 * @param {TRecordUpdateOptions} [options={}]
 * @returns {(TRecordUpdateResult|Object)} Returns updated record if ```options.dataOnly``` is set. {@link TRecordUpdateResult} otherwise
 */
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 { cloneDeep, get, omit } = this.app.lib._
  opts.dataOnly = opts.dataOnly ?? true
  const { dataOnly } = opts
  const { options } = await getFilterAndOptions.call(this, null, opts, action)
  options.partial = options.partial ?? true
  const { truncateString, noResult, noBodySanitizer, noResultSanitizer, noValidation, partial } = options
  const extFields = get(options, 'validation.extFields', [])
  id = this.sanitizeId(id)

  let input = noBodySanitizer ? cloneDeep(body) : await this.sanitizeBody({ body, extFields, strict: true, truncateString, partial, onlyTypes, action })
  const immutables = this.properties.filter(prop => prop.immutable)
  if (immutables.length > 0) input = omit(input, immutables)
  delete input.id
  await execHook.call(this, 'beforeUpdateRecord', id, input, options)
  await execModelHook.call(this, 'beforeUpdateRecord', id, input, options)
  await execDynHook.call(this, 'beforeUpdateRecord', id, input, options)
  if (!noValidation) await execValidation.call(this, input, options)
  const result = await this.driver._updateRecord(this, id, input, options)
  if (noResult) return
  await handleReq.call(this, result.data.id, 'updated', options)
  await clearCache.call(this, id)
  const { warnings } = getDefaultValues(options)
  if (!warnings) delete result.warnings
  if (isSet(options.refs)) await getRefs.call(this, [result.data], options)
  if (!noResultSanitizer) {
    result.data = await this.sanitizeRecord(result.data, options)
    result.oldData = await this.sanitizeRecord(result.oldData, options)
  }
  await execDynHook.call(this, 'afterUpdateRecord', id, input, result, options)
  await execModelHook.call(this, 'afterUpdateRecord', id, input, result, options)
  await execHook.call(this, 'afterUpdateRecord', id, input, result, options)
  return dataOnly ? result.data : result
}

export default updateRecord