dobo 2.38.0 → 2.39.1

package/lib/factory/connection.js

@@ -1,109 +1,109 @@
-/**
- * @typedef TOptions
- * @memberof DoboConnection
- * @property {string} [name='default'] - Connection name
- * @property {string[]} models - List of model names to be used with this connection. Use this property to force models to be bound to this connection only.
- */
-
-/**
- * Connection factory
- *
- * @async
- */
-async function connectionFactory () {
-  const { Tools } = this.app.baseClass
-  const { omit } = this.app.lib._
-
-  /**
-   * Connection class definition.
-   *
-   * @class
-   */
-  class DoboConnection extends Tools {
-    constructor (plugin, options = {}) {
-      super(plugin)
-      /**
-       * Adapter object
-       * @type {Object}
-       */
-      this.adapter = undefined
-
-      /**
-       * Client instance
-       * @type {Object}
-       */
-      this.client = undefined
-
-      /**
-       * Connection name
-       * @type {string}
-       */
-      this.name = options.name
-
-      /**
-       * Connection options
-       * @type {DoboConnection.TOptions}
-       */
-      this.options = {
-        models: []
-      }
-
-      /**
-       * Options object from connection defined on ```dobo.config.connections```
-       * @type {Object}
-       */
-      if (options instanceof this.app.baseClass.DoboNullAdapter) {
-        this.adapter = options
-        this.options.connName = 'nulladapter'
-      } else {
-        this.options = omit(options, ['name', 'adapter'])
-        this.options.connName = options.name
-        this.options.models = this.options.models ?? []
-      }
-    }
-
-    /**
-     * Initialize the adapter for this connection. If the adapter is already an instance of `DoboAdapter`,
-     * it will be used directly. Otherwise, it will be retrieved from the plugin's adapter registry
-     * and sanitized with the connection options.
-     * @param {string} name - Adapter name
-     * @async
-     * @returns {Promise<void>}
-     */
-    async initAdapter (name) {
-      if (name instanceof this.app.baseClass.DoboAdapter) this.adapter = name
-      else {
-        this.adapter = this.plugin.getAdapter(name)
-        await this.adapter.sanitizeConnection(this.options)
-      }
-    }
-
-    /**
-     * Establish this connection through the adapter to the actual database system. Adapter developer must
-     * provide a method named `connect()` to connect the underlying database and (optionally)
-     * return its client instance.
-     *
-     * @param {boolean} [noRebuild] - If `true`, the database table/collection won't be build automatically
-     * @retyrns {Promise<void>}
-     */
-    async connect (noRebuild) {
-      const client = await this.adapter.connect(this, noRebuild)
-      if (client) this.client = client
-      this.connected = true
-    }
-
-    /**
-     * Dispose this connection
-     * @async
-     * @returns {Promise<void>}
-     */
-    dispose = async () => {
-      await super.dispose()
-      this.adapter = null
-    }
-  }
-
-  this.app.baseClass.DoboConnection = DoboConnection
-}
-
-export default connectionFactory
+/**
+ * @typedef TOptions
+ * @memberof DoboConnection
+ * @property {string} [name='default'] - Connection name
+ * @property {string[]} models - List of model names to be used with this connection. Use this property to force models to be bound to this connection only.
+ */
+
+/**
+ * Connection factory
+ *
+ * @async
+ */
+async function connectionFactory () {
+  const { Tools } = this.app.baseClass
+  const { omit } = this.app.lib._
+
+  /**
+   * Connection class definition.
+   *
+   * @class
+   */
+  class DoboConnection extends Tools {
+    constructor (plugin, options = {}) {
+      super(plugin)
+      /**
+       * Adapter object
+       * @type {Object}
+       */
+      this.adapter = undefined
+
+      /**
+       * Client instance
+       * @type {Object}
+       */
+      this.client = undefined
+
+      /**
+       * Connection name
+       * @type {string}
+       */
+      this.name = options.name
+
+      /**
+       * Connection options
+       * @type {DoboConnection.TOptions}
+       */
+      this.options = {
+        models: []
+      }
+
+      /**
+       * Options object from connection defined on ```dobo.config.connections```
+       * @type {Object}
+       */
+      if (options instanceof this.app.baseClass.DoboNullAdapter) {
+        this.adapter = options
+        this.options.connName = 'nulladapter'
+      } else {
+        this.options = omit(options, ['name', 'adapter'])
+        this.options.connName = options.name
+        this.options.models = this.options.models ?? []
+      }
+    }
+
+    /**
+     * Initialize the adapter for this connection. If the adapter is already an instance of `DoboAdapter`,
+     * it will be used directly. Otherwise, it will be retrieved from the plugin's adapter registry
+     * and sanitized with the connection options.
+     * @param {string} name - Adapter name
+     * @async
+     * @returns {Promise<void>}
+     */
+    async initAdapter (name) {
+      if (name instanceof this.app.baseClass.DoboAdapter) this.adapter = name
+      else {
+        this.adapter = this.plugin.getAdapter(name)
+        await this.adapter.sanitizeConnection(this.options)
+      }
+    }
+
+    /**
+     * Establish this connection through the adapter to the actual database system. Adapter developer must
+     * provide a method named `connect()` to connect the underlying database and (optionally)
+     * return its client instance.
+     *
+     * @param {boolean} [noRebuild] - If `true`, the database table/collection won't be build automatically
+     * @retyrns {Promise<void>}
+     */
+    async connect (noRebuild) {
+      const client = await this.adapter.connect(this, noRebuild)
+      if (client) this.client = client
+      this.connected = true
+    }
+
+    /**
+     * Dispose this connection
+     * @async
+     * @returns {Promise<void>}
+     */
+    dispose = async () => {
+      await super.dispose()
+      this.adapter = null
+    }
+  }
+
+  this.app.baseClass.DoboConnection = DoboConnection
+}
+
+export default connectionFactory

package/lib/factory/feature.js

@@ -1,52 +1,52 @@
-/**
- * Feature factory function.
- *
- * @async
- * @returns {Promise<void>}
- */
-
-async function featureFactory () {
-  const { Tools } = this.app.baseClass
-
-  /**
-   * Feature class definition.
-   *
-   * `this.plugin` should be the one who owned this adapter
-   * @class
-   */
-  class DoboFeature extends Tools {
-    /**
-     * Constructor.
-     */
-    constructor (plugin, options = {}) {
-      super(plugin)
-      /**
-       * Feature name
-       * @type {string}
-       */
-      this.name = options.name
-
-      /**
-       * Feature handler function.
-       * @type {Function}
-       */
-      this.handler = options.handler
-    }
-
-    /**
-     * Dispose the instance and clean up resources.
-     * @async
-     * @method
-     * @returns {Promise<void>}
-     */
-    dispose = async () => {
-      await super.dispose()
-      this.name = null
-      this.handler = null
-    }
-  }
-
-  this.app.baseClass.DoboFeature = DoboFeature
-}
-
-export default featureFactory
+/**
+ * Feature factory function.
+ *
+ * @async
+ * @returns {Promise<void>}
+ */
+
+async function featureFactory () {
+  const { Tools } = this.app.baseClass
+
+  /**
+   * Feature class definition.
+   *
+   * `this.plugin` should be the one who owned this adapter
+   * @class
+   */
+  class DoboFeature extends Tools {
+    /**
+     * Constructor.
+     */
+    constructor (plugin, options = {}) {
+      super(plugin)
+      /**
+       * Feature name
+       * @type {string}
+       */
+      this.name = options.name
+
+      /**
+       * Feature handler function.
+       * @type {Function}
+       */
+      this.handler = options.handler
+    }
+
+    /**
+     * Dispose the instance and clean up resources.
+     * @async
+     * @method
+     * @returns {Promise<void>}
+     */
+    dispose = async () => {
+      await super.dispose()
+      this.name = null
+      this.handler = null
+    }
+  }
+
+  this.app.baseClass.DoboFeature = DoboFeature
+}
+
+export default featureFactory

package/lib/factory/model/aggregate.js

@@ -1,23 +1,23 @@
-import { getFilterAndOptions, execHook, execModelHook, execDynHook } from './helper.js'
-const action = 'aggregate'
-
-async function aggregate (...args) {
-  if (args.length === 0) return this.action(action, ...args)
-  const [_filter = {}, params = {}, opts = {}] = args
-  opts.dataOnly = opts.dataOnly ?? true
-  const { dataOnly } = opts
-  const { filter, options } = await getFilterAndOptions.call(this, _filter, opts, action)
-  const { getDefaultValues } = this.app.dobo
-  await execHook.call(this, 'beforeAggregate', filter, params, options)
-  await execModelHook.call(this, 'beforeAggregate', filter, params, options)
-  await execDynHook.call(this, 'beforeAggregate', filter, params, options)
-  const result = (await this.adapter._aggregate(this, filter, params, options)) ?? {}
-  const { warnings } = getDefaultValues(options)
-  if (!warnings) delete result.warnings
-  await execDynHook.call(this, 'afterAggregate', filter, params, result, options)
-  await execModelHook.call(this, 'afterAggregate', filter, params, result, options)
-  await execHook.call(this, 'afterAggregate', filter, params, result, options)
-  return dataOnly ? result.data : result
-}
-
-export default aggregate
+import { getFilterAndOptions, execHook, execModelHook, execDynHook } from './helper.js'
+const action = 'aggregate'
+
+async function aggregate (...args) {
+  if (args.length === 0) return this.action(action, ...args)
+  const [_filter = {}, params = {}, opts = {}] = args
+  opts.dataOnly = opts.dataOnly ?? true
+  const { dataOnly } = opts
+  const { filter, options } = await getFilterAndOptions.call(this, _filter, opts, action)
+  const { getDefaultValues } = this.app.dobo
+  await execHook.call(this, 'beforeAggregate', filter, params, options)
+  await execModelHook.call(this, 'beforeAggregate', filter, params, options)
+  await execDynHook.call(this, 'beforeAggregate', filter, params, options)
+  const result = (await this.adapter._aggregate(this, filter, params, options)) ?? {}
+  const { warnings } = getDefaultValues(options)
+  if (!warnings) delete result.warnings
+  await execDynHook.call(this, 'afterAggregate', filter, params, result, options)
+  await execModelHook.call(this, 'afterAggregate', filter, params, result, options)
+  await execHook.call(this, 'afterAggregate', filter, params, result, options)
+  return dataOnly ? result.data : result
+}
+
+export default aggregate

package/lib/factory/model/build.js

@@ -1,25 +1,25 @@
-import { getFilterAndOptions, execHook, execModelHook } from './helper.js'
-const action = 'build'
-
-/**
- * Build a model's definition based on its properties and rules.
- *
- * @async
- * @memberof DoboModel
- * @method
- * @param {DoboModel.TOptions} opts - The options for building the model
- * @returns {DoboModel.TResultRecord|DoboModel.TRecord}
- */
-async function build (opts = {}) {
-  opts.dataOnly = opts.dataOnly ?? true
-  const { dataOnly } = opts
-  const { options } = await getFilterAndOptions.call(this, null, opts, action)
-  await execHook.call(this, 'beforeBuildModel', options)
-  await execModelHook.call(this, 'beforeBuildModel', options)
-  const result = (await this.adapter._buildModel(this, options)) ?? {}
-  await execModelHook.call(this, 'afterBuildModel', result, options)
-  await execHook.call(this, 'afterBuildModel', result, options)
-  return dataOnly ? result.data : result
-}
-
-export default build
+import { getFilterAndOptions, execHook, execModelHook } from './helper.js'
+const action = 'build'
+
+/**
+ * Build a model's definition based on its properties and rules.
+ *
+ * @async
+ * @memberof DoboModel
+ * @method
+ * @param {DoboModel.TOptions} opts - The options for building the model
+ * @returns {DoboModel.TResultRecord|DoboModel.TRecord}
+ */
+async function build (opts = {}) {
+  opts.dataOnly = opts.dataOnly ?? true
+  const { dataOnly } = opts
+  const { options } = await getFilterAndOptions.call(this, null, opts, action)
+  await execHook.call(this, 'beforeBuildModel', options)
+  await execModelHook.call(this, 'beforeBuildModel', options)
+  const result = (await this.adapter._buildModel(this, options)) ?? {}
+  await execModelHook.call(this, 'afterBuildModel', result, options)
+  await execHook.call(this, 'afterBuildModel', result, options)
+  return dataOnly ? result.data : result
+}
+
+export default build

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

@@ -1,36 +1,36 @@
-import { getFilterAndOptions, execHook, execValidation, execModelHook, execDynHook } from './helper.js'
-
-export const onlyTypes = ['datetime', 'date', 'time', 'timestamp']
-const action = 'bulkCreateRecord'
-
-async function bulkCreateRecord (...args) {
-  if (args.length === 0) return this.action(action, ...args)
-  const [bodies = [], opts = {}] = args
-  const { cloneDeep, get } = this.app.lib._
-  const { options } = await getFilterAndOptions.call(this, null, opts, action)
-  const { truncateString, noBodySanitizer, noValidation } = options
-  const extFields = get(options, 'validation.extFields', [])
-
-  const inputs = cloneDeep(bodies)
-  if (!noBodySanitizer) {
-    for (const idx in inputs) {
-      inputs[idx] = await this.sanitizeBody({ body: inputs[idx], extFields, strict: true, truncateString, onlyTypes })
-    }
-  }
-  await execHook.call(this, 'beforeBulkCreateRecord', inputs, options)
-  await execModelHook.call(this, 'beforeBulkCreateRecord', inputs, options)
-  await execDynHook.call(this, 'beforeBulkCreateRecord', inputs, options)
-  if (!noValidation) {
-    for (const input of inputs) {
-      await execValidation.call(this, input, options)
-    }
-  }
-  // TODO: bulk don't return anything currently, it should return at least a stat
-  await this.adapter._bulkCreateRecord(this, inputs, options)
-  await execDynHook.call(this, 'afterBulkCreateRecord', inputs, options)
-  await execModelHook.call(this, 'afterBulkCreateRecord', inputs, options)
-  await execHook.call(this, 'afterBulkCreateRecord', inputs, options)
-  return []
-}
-
-export default bulkCreateRecord
+import { getFilterAndOptions, execHook, execValidation, execModelHook, execDynHook } from './helper.js'
+
+export const onlyTypes = ['datetime', 'date', 'time', 'timestamp']
+const action = 'bulkCreateRecord'
+
+async function bulkCreateRecord (...args) {
+  if (args.length === 0) return this.action(action, ...args)
+  const [bodies = [], opts = {}] = args
+  const { cloneDeep, get } = this.app.lib._
+  const { options } = await getFilterAndOptions.call(this, null, opts, action)
+  const { truncateString, noBodySanitizer, noValidation } = options
+  const extFields = get(options, 'validation.extFields', [])
+
+  const inputs = cloneDeep(bodies)
+  if (!noBodySanitizer) {
+    for (const idx in inputs) {
+      inputs[idx] = await this.sanitizeBody({ body: inputs[idx], extFields, strict: true, truncateString, onlyTypes })
+    }
+  }
+  await execHook.call(this, 'beforeBulkCreateRecord', inputs, options)
+  await execModelHook.call(this, 'beforeBulkCreateRecord', inputs, options)
+  await execDynHook.call(this, 'beforeBulkCreateRecord', inputs, options)
+  if (!noValidation) {
+    for (const input of inputs) {
+      await execValidation.call(this, input, options)
+    }
+  }
+  // TODO: bulk don't return anything currently, it should return at least a stat
+  await this.adapter._bulkCreateRecord(this, inputs, options)
+  await execDynHook.call(this, 'afterBulkCreateRecord', inputs, options)
+  await execModelHook.call(this, 'afterBulkCreateRecord', inputs, options)
+  await execHook.call(this, 'afterBulkCreateRecord', inputs, options)
+  return []
+}
+
+export default bulkCreateRecord

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

@@ -1,30 +1,30 @@
-import { getFilterAndOptions, execHook, execModelHook, execDynHook } from './helper.js'
-const action = 'clearRecord'
-
-/**
- * Clears all records from the model's underlying data store.
- *
- * If no arguments are provided, it automatically turns into a chainable {@link DoboAction} object.
- * @async
- * @memberof DoboModel
- * @method
- * @param  {DoboModel.TOptions} [opts={}] - Options object.
- * @returns {DoboAction|DoboModel.TResultRecord|DoboModel.TRecord}
- */
-async function clearRecord (...args) {
-  if (args.length === 0) return this.action(action, ...args)
-  const [opts = {}] = args
-  opts.dataOnly = opts.dataOnly ?? true
-  const { dataOnly } = opts
-  const { options } = await getFilterAndOptions.call(this, null, opts, action)
-  await execHook.call(this, 'beforeClearRecord', options)
-  await execModelHook.call(this, 'beforeClearRecord', options)
-  await execDynHook.call(this, 'beforeClearRecord', options)
-  const result = (await this.adapter._clearRecord(this, options)) ?? {}
-  await execDynHook.call(this, 'afterClearRecord', result, options)
-  await execModelHook.call(this, 'afterClearRecord', result, options)
-  await execHook.call(this, 'afterClearRecord', result, options)
-  return dataOnly ? result.data : result
-}
-
-export default clearRecord
+import { getFilterAndOptions, execHook, execModelHook, execDynHook } from './helper.js'
+const action = 'clearRecord'
+
+/**
+ * Clears all records from the model's underlying data store.
+ *
+ * If no arguments are provided, it automatically turns into a chainable {@link DoboAction} object.
+ * @async
+ * @memberof DoboModel
+ * @method
+ * @param  {DoboModel.TOptions} [opts={}] - Options object.
+ * @returns {DoboAction|DoboModel.TResultRecord|DoboModel.TRecord}
+ */
+async function clearRecord (...args) {
+  if (args.length === 0) return this.action(action, ...args)
+  const [opts = {}] = args
+  opts.dataOnly = opts.dataOnly ?? true
+  const { dataOnly } = opts
+  const { options } = await getFilterAndOptions.call(this, null, opts, action)
+  await execHook.call(this, 'beforeClearRecord', options)
+  await execModelHook.call(this, 'beforeClearRecord', options)
+  await execDynHook.call(this, 'beforeClearRecord', options)
+  const result = (await this.adapter._clearRecord(this, options)) ?? {}
+  await execDynHook.call(this, 'afterClearRecord', result, options)
+  await execModelHook.call(this, 'afterClearRecord', result, options)
+  await execHook.call(this, 'afterClearRecord', result, options)
+  return dataOnly ? result.data : result
+}
+
+export default clearRecord

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

@@ -1,42 +1,42 @@
-import { getFilterAndOptions, execHook, execModelHook, execDynHook } from './helper.js'
-const action = 'countRecord'
-
-/**
- * Counts the number of 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 counting records.
- * @param {DoboModel.TOptions} [opts={}] - Options object.
- * @returns {DoboAction|DoboModel.TResultRecord|DoboModel.TRecord}
- */
-async function countRecord (...args) {
-  const { getDefaultValues } = this.app.dobo
-  if (args.length === 0) return this.action(action, ...args)
-  const [params = {}, opts = {}] = args
-  opts.dataOnly = opts.dataOnly ?? true
-  const { dataOnly } = opts
-  const { filter, options } = await getFilterAndOptions.call(this, params, opts, action)
-  const { hardCap, t } = getDefaultValues(options)
-  await execHook.call(this, 'beforeCountRecord', filter, options)
-  await execModelHook.call(this, 'beforeCountRecord', filter, options)
-  await execDynHook.call(this, 'beforeCountRecord', filter, options)
-  const result = (await this.adapter._countRecord(this, filter, options)) ?? {}
-  if (result.data > hardCap) {
-    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)
-  return dataOnly ? result.data : result
-}
-
-export default countRecord
+import { getFilterAndOptions, execHook, execModelHook, execDynHook } from './helper.js'
+const action = 'countRecord'
+
+/**
+ * Counts the number of 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 counting records.
+ * @param {DoboModel.TOptions} [opts={}] - Options object.
+ * @returns {DoboAction|DoboModel.TResultRecord|DoboModel.TRecord}
+ */
+async function countRecord (...args) {
+  const { getDefaultValues } = this.app.dobo
+  if (args.length === 0) return this.action(action, ...args)
+  const [params = {}, opts = {}] = args
+  opts.dataOnly = opts.dataOnly ?? true
+  const { dataOnly } = opts
+  const { filter, options } = await getFilterAndOptions.call(this, params, opts, action)
+  const { hardCap, t } = getDefaultValues(options)
+  await execHook.call(this, 'beforeCountRecord', filter, options)
+  await execModelHook.call(this, 'beforeCountRecord', filter, options)
+  await execDynHook.call(this, 'beforeCountRecord', filter, options)
+  const result = (await this.adapter._countRecord(this, filter, options)) ?? {}
+  if (result.data > hardCap) {
+    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)
+  return dataOnly ? result.data : result
+}
+
+export default countRecord