mythix-orm 1.5.6 → 1.6.2

package/lib/model.js

@@ -39,7 +39,7 @@ class CacheKey {
 
 function bindStaticWhereToModelClass(ModelClass) {
   const whereProp = {
-    enumberable:  true,
+    enumerable:   true,
     configurable: true,
     set:          function() {},
     get:          function() {
@@ -122,6 +122,7 @@ function bindStaticWhereToModelClass(ModelClass) {
 ///   and instance version. We are only listing the `static`
 ///   versions because the instance versions generally will
 ///   just be proxies to these `static` methods.
+///
 /// Note:
 ///   An underscore prefix on a method in Mythix ORM
 ///   implies that this method should not be overloaded
@@ -142,6 +143,7 @@ class Model {
   /// named `_isMythixModel` that is truthy.
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   value: Function
   ///     Value to check.
@@ -170,6 +172,7 @@ class Model {
   /// (`value.constructor._isMythixModel`)
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   value: any
   ///     Value to check
@@ -195,6 +198,7 @@ class Model {
   /// name alone will be returned as a string.
   ///
   /// Return: string
+  ///
   /// Arguments:
   ///   showFields?: boolean
   ///     If `true`, then list the models fields.
@@ -229,6 +233,7 @@ class Model {
   /// be found).
   ///
   /// Return: <see>Connection</see>
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection that can be provided.
@@ -243,6 +248,7 @@ class Model {
   /// See <see>Model.static _getConnection</see>
   ///
   /// Return: <see>Connection</see>
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection that can be provided.
@@ -252,6 +258,7 @@ class Model {
   ///     if that also fails to find a connection, the finally
   ///     the method will call <see>Model.static _getConnection</see>
   ///     to get the bound connection, if any is available.
+  ///
   /// Note:
   ///   Pay attention that unlike <see>Model.static _getConnection</see>
   ///   this checks the model's instance for `._connection` property. If that is
@@ -283,6 +290,7 @@ class Model {
   /// connection.
   ///
   /// Return: <see>Connection</see>
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection that can be provided.
@@ -320,6 +328,7 @@ class Model {
   ///  a new class that inherited from `this` class.
   ///
   /// Return: class extends <see>Model</see>
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     The connection instance to bind to
@@ -349,7 +358,7 @@ class Model {
     }
 
     const whereProp = {
-      enumberable:  false,
+      enumerable:   false,
       configurable: true,
       get:          () => {
         return ModelClass.getQueryEngine(connection);
@@ -360,7 +369,7 @@ class Model {
     Object.defineProperties(ModelClass, {
       '_mythixBoundConnection': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        connection,
       },
@@ -382,6 +391,7 @@ class Model {
   /// generally be supplied by the connection.
   ///
   /// Return: class <see>QueryEngine</see>
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -402,6 +412,7 @@ class Model {
   /// so make sure you always call it first: `Model.where.unscoped()...`
   ///
   /// Return: <see>QueryEngine</see>
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -454,7 +465,9 @@ class Model {
   ///       return baseQuery.active.EQ(true);
   ///     }
   ///   }
+  ///
   /// Return: <see>QueryEngine</see>
+  ///
   /// Arguments:
   ///   query: <see>QueryEngine</see>
   ///     The query that you should add onto.
@@ -476,6 +489,7 @@ class Model {
   /// the query to the user to start interacting with.
   ///
   /// Return: <see>QueryEngine</see>
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -499,6 +513,7 @@ class Model {
   ///
   /// Return: Map<string, array<object>>
   ///   The format is `Map[modelName] = [ { targetFieldName, sourceFieldName }, ... ]`
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -544,6 +559,7 @@ class Model {
   ///
   /// Return: Map<string, Model>
   ///   The format is `Map[modelName] = Model`
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -583,6 +599,7 @@ class Model {
   ///
   /// Return: Array<string>
   ///   The format is `Array[] = modelName`
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -606,12 +623,13 @@ class Model {
     return this.constructor.getForeignKeysTargetModelNames(connection);
   }
 
-  /// Return all the foreign key target field names.
-  /// This will return the target field names of all
+  /// Return all the foreign key target fields.
+  /// This will return the target fields of all
   /// foreign key fields specified on the model.
   ///
   /// Return: Array<string>
-  ///   The format is `Array[] = modelName`
+  ///   An array of all foreign key field info `Array<{ targetFieldName: string, sourceFieldName: string }>`
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -648,6 +666,7 @@ class Model {
   /// Return: object<{ targetFieldName, sourceFieldName }>
   ///   This will be the relationship info for this foreign key field
   ///   which will be an object of the shape `{ targetFieldName, sourceFieldName }`.
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -688,6 +707,7 @@ class Model {
   /// Return: boolean
   ///   `true` if the specified `modelName` model is pointed
   ///   to by one of the foreign key fields, `false` otherwise.
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -712,6 +732,7 @@ class Model {
   ///
   /// Return: string
   ///   The name of the table for this model.
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection to pass through.
@@ -762,12 +783,16 @@ class Model {
   /// Note:
   ///   This will return the "singular" name of the model
   ///   which is the same as <see>Model.static getModelName</see>.
+  ///
   /// Note:
   ///   This method simply calls <see>Model.static getModelName</see>
   ///   to get the singular model name.
+  ///
   /// Return: string
   ///   The name the model in singular form.
+  ///
   /// See: Model.static getPluralModelName
+  ///
   /// See: Model.static getModelName
   static getSingularName() {
     return this.getModelName();
@@ -785,8 +810,10 @@ class Model {
   ///
   /// Note:
   ///   This will return the "plural" name of the model.
+  ///
   /// Return: string
   ///   The name the model in plural form.
+  ///
   /// See: Model.static getSingularName
   static getPluralModelName() {
     return Inflection.pluralize(this.getSingularName());
@@ -799,12 +826,23 @@ class Model {
   /// Get the Model class for this model.
   ///
   /// Return: class <see>Model</see>
-  static getModel() {
+  static getModel(modelName) {
+    if (modelName) {
+      if (modelName === this.getModelName())
+        return this;
+
+      let connection = this.getConnection();
+      if (!connection)
+        return;
+
+      return connection.getModel(modelName);
+    }
+
     return this;
   }
 
-  getModel() {
-    return this.constructor.getModel();
+  getModel(modelName) {
+    return this.constructor.getModel(modelName);
   }
 
   /// Get the fields for this model. You can optionally
@@ -826,12 +864,15 @@ class Model {
   ///   `columnName`. A model's fields are always initialized when
   ///   the model is first bound to a connection, or when this method
   ///   is first called.
+  ///
   /// Note:
   ///   In Mythix ORM you **never** specify a field via its `columnName`.
   ///   You always use a field's defined `fieldName` to match against
   ///   a field. Using a `columnName` simply won't work, unless `columnName`
   ///   and `fieldName` just happen to have the same value.
+  ///
   /// Return: Array<<see>Field</see>> | Object<string, <see>Field</see>>
+  ///
   /// Arguments:
   ///   fieldNames?: Array<string>
   ///     An array of field names to fetch. If not
@@ -843,13 +884,13 @@ class Model {
       Object.defineProperties(this, {
         'fields': {
           writable:     true,
-          enumberable:  true,
+          enumerable:   true,
           configurable: true,
           value:        fields,
         },
         '_sortedFields': {
           writable:     true,
-          enumberable:  true,
+          enumerable:   true,
           configurable: true,
           value:        null,
         },
@@ -885,7 +926,9 @@ class Model {
   ///   You always use a field's defined `fieldName` to match against
   ///   a field. Using a `columnName` simply won't work, unless `columnName`
   ///   and `fieldName` just happen to have the same value.
+  ///
   /// Return: Array<<see>Field</see>>
+  ///
   /// Arguments:
   ///   fieldNames?: Array<string>
   ///     An array of field names to fetch. If not
@@ -951,7 +994,9 @@ class Model {
   ///   you can also simply provide a raw object with the same shape, and
   ///   it will be automatically converted to a <see>Field</see> instance
   ///   for you.
+  ///
   /// Return: Array<<see>Field</see>> | object<string, <see>Field</see>>
+  ///
   /// Arguments:
   ///   mergeFields?: Array<<see>Field</see>> | Set<<see>Field</see>> | Object<string, <see>Field</see>> | Map<string, <see>Field</see>>
   ///     A list of fields to merge into the current
@@ -1026,7 +1071,9 @@ class Model {
   /// Note:
   ///   The cache for built fields is stored directly on the input `fields`
   ///   argument, under a non-enumerable `_mythixFieldsInitialized` cache key.
+  ///
   /// Return: Array<<see>Field</see>> | object<string, <see>Field</see>>
+  ///
   /// Arguments:
   ///   fields: Array<<see>Field</see>> | Set<<see>Field</see>> | Object<string, <see>Field</see>> | Map<string, <see>Field</see>>
   ///     A list of fields to work off of. When this method is
@@ -1090,13 +1137,13 @@ class Model {
     Object.defineProperties(finalizedFields, {
       '_mythixFieldsInitialized': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        true,
       },
       '_primaryKeyField': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        primaryKeyField,
       },
@@ -1135,6 +1182,7 @@ class Model {
   ///   }
   ///
   /// Return: Array<any>
+  ///
   /// Arguments:
   ///   callback: Function(context: IterationContext)
   ///     A callback method that will be called for
@@ -1265,7 +1313,9 @@ class Model {
   ///   You always use a field's defined `fieldName` to match against
   ///   a field. Using a `columnName` simply won't work, unless `columnName`
   ///   and `fieldName` just happen to have the same value.
+  ///
   /// Return: <see>Field</see>
+  ///
   /// Arguments:
   ///   fieldName: string
   ///     The specified field name to find. This **is not** the `columnName` of the field.
@@ -1299,7 +1349,9 @@ class Model {
   ///   You always use a field's defined `fieldName` to match against
   ///   a field. Using a `columnName` simply won't work, unless `columnName`
   ///   and `fieldName` just happen to have the same value.
+  ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   fieldName: string
   ///     The specified field name to find. This **is not** the `columnName` of the field.
@@ -1346,6 +1398,7 @@ class Model {
   ///   Internally, Mythix ORM will call `this.connection.defaultOrder(options)`,
   ///   which--if not overloaded--will simply call this method from the
   ///   model itself.
+  ///
   /// Note:
   ///   A "fully qualified field name" in Mythix ORM means
   ///   a full field definition, including the model name.
@@ -1355,6 +1408,7 @@ class Model {
   ///   field name* example would be simply `"id"`. Since this
   ///   contains no model prefix, this is "short hand", and is
   ///   **not** a fully qualified field name.
+  ///
   /// Return: Array<string> | null
   ///   An array of fully qualified field names to specify the ORDER.
   ///   Prefix a field name with `+` to specify ASCending order, i.e.
@@ -1373,6 +1427,7 @@ class Model {
   /// Return: <see>QueryEngine</see>
   ///   A <see>QueryEngine</see> instance (a query) for
   ///   this model.
+  ///
   /// Arguments:
   ///   options?: `object { connection: Connection }`
   ///     An object, which if supplied, should contain a
@@ -1401,6 +1456,7 @@ class Model {
   ///
   /// Return: <see>Model</see>
   ///   Return the model instance(s) created.
+  ///
   /// Arguments:
   ///   models: Array<<see>Model</see>> | <see>Model</see> | Array<object> | object
   ///     Specify the model(s) to create.
@@ -1426,6 +1482,7 @@ class Model {
   ///
   /// Return: number
   ///   Return the number of models stored in the database for this model type.
+  ///
   /// Arguments:
   ///   options?: object
   ///     An "options" object to pass off to the underlying <see>Connection</see> methods.
@@ -1443,8 +1500,10 @@ class Model {
   ///   This will fetch ALL rows for the model. If this is not what you want,
   ///   then construct a query first, and call `all` from the query itself, i.e.
   ///   `User.where.firstName.EQ('Bob').all(options)`.
+  ///
   /// Return: Array<<see>Model</see>>
   ///   Return all models of this type from the database.
+  ///
   /// Arguments:
   ///   options?: object
   ///     An "options" object to pass off to the underlying <see>Connection</see> methods.
@@ -1463,6 +1522,10 @@ class Model {
     return this.getWhereWithConnection(options).all(options);
   }
 
+  static fetchAll(options) {
+    return this.all({ ...(options || {}), stream: true });
+  }
+
   /// Get the first (limit) rows from the database for this model type.
   ///
   /// Note:
@@ -1470,6 +1533,7 @@ class Model {
   ///   If you wish to filter, and specify the order, then construct a
   ///   query first, and call the `first` method from the query itself, i.e.
   ///   `User.where.firstName.EQ('Bob').ORDER('+User:firstName').first(options)`
+  ///
   /// Return: <see>Model</see> | Array<<see>Model</see>>
   ///   Return `limit` models of this type from the database. If
   ///   `limit` is `null`, `undefined`, or `1`, then a single model
@@ -1477,6 +1541,7 @@ class Model {
   ///   If the `limit` argument is more than `1`, then an array
   ///   of model instances will be returned, or an empty array if
   ///   nothing is found.
+  ///
   /// Arguments:
   ///   limit?: number = 1
   ///     The number of model instances to fetch from the database.
@@ -1500,10 +1565,12 @@ class Model {
   ///   If you wish to filter, and specify the order, then construct a
   ///   query first, and call the `last` method from the query itself, i.e.
   ///   `User.where.firstName.EQ('Bob').ORDER('+User:firstName').last(options)`
+  ///
   /// Note:
   ///   This works by telling the underlying query generator to invert
   ///   the specified ORDER of the query, and then it selects the first
   ///   `limit` rows from the result.
+  ///
   /// Return: <see>Model</see> | Array<<see>Model</see>>
   ///   Return `limit` models of this type from the database. If
   ///   `limit` is `null`, `undefined`, or `1`, then a single model
@@ -1511,6 +1578,7 @@ class Model {
   ///   If the `limit` argument is more than `1`, then an array
   ///   of model instances will be returned, or an empty array if
   ///   nothing is found.
+  ///
   /// Arguments:
   ///   limit?: number = 1
   ///     The number of model instances to fetch from the database.
@@ -1534,16 +1602,19 @@ class Model {
   ///   If you wish to filter and limit, and specify the order, then construct a
   ///   query first, and call the `pluck` method from the query itself, i.e.
   ///   `User.where.firstName.EQ('Bob').LIMIT(50).ORDER('+User:firstName').pluck([ 'User:firstName' ], options)`
+  ///
   /// Note:
   ///   In Mythix ORM you **never** specify a field via its `columnName`.
   ///   You always use a field's defined `fieldName` to match against
   ///   a field. Using a `columnName` simply won't work, unless `columnName`
   ///   and `fieldName` just happen to have the same value.
+  ///
   /// Return: Array<any> | Array<Array<any>>
   ///   If only a single field is specified, then a flat array
   ///   of values will be returned across all rows. If more than
   ///   one field is specified, then an array of arrays (rows) will
   ///   be returned for the fields specified.
+  ///
   /// Arguments:
   ///   fields?: Array<string>
   ///     An array of fully qualified field names to pluck from the underlying
@@ -1562,6 +1633,7 @@ class Model {
   /// Construct a new <see>Model</see> instance.
   ///
   /// Return: <see>Model</see>
+  ///
   /// Arguments:
   ///   data?: object
   ///     Attributes to provide to the new model instance.
@@ -1597,7 +1669,7 @@ class Model {
     let options = _options || {};
 
     const whereProp = {
-      enumberable:  false,
+      enumerable:   false,
       configurable: true,
       get:          () => {
         return this.constructor.where(this._getConnection());
@@ -1608,66 +1680,66 @@ class Model {
     Object.defineProperties(this, {
       '_options': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        options,
       },
       '_mythixModelInstance': {
         writable:     false,
-        enumberable:  false,
+        enumerable:   false,
         configurable: false,
         value:        true,
       },
       '_connection': {
         writable:     false,
-        enumberable:  false,
+        enumerable:   false,
         configurable: false,
         value:        this._getConnection(options.connection),
       },
       '_fieldData': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        {},
       },
       '_dirtyFieldData': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        {},
       },
       '_typeData': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        {},
       },
-      'dirtyID': {
+      '_dirtyID': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        new CacheKey(),
       },
       '_persisted': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        false,
       },
       '__order': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        0,
       },
       '__assignedRelatedModels': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        new Map(),
       },
       'changes': {
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         get:          () => {
           return this._getDirtyFields();
@@ -1701,6 +1773,7 @@ class Model {
   /// the field values for the model.
   ///
   /// Return: `undefined`
+  ///
   /// Arguments:
   ///   data?: object
   ///     Attributes provided to the model through
@@ -1743,7 +1816,7 @@ class Model {
   _constructField(fieldName, field) {
     Object.defineProperties(this, {
       [fieldName]: {
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         get:          () => {
           return this._getFieldValue(fieldName, field);
@@ -1772,15 +1845,18 @@ class Model {
   /// Note:
   ///   All fields have already been constructed before this
   ///   method is called via <see>Model._constructFields</see>.
+  ///
   /// Note:
   ///   Virtual fields are not constructed against the model instance,
   ///   however, field types *can* modify the instance, and some do.
   ///   For example, the `Types.Model` and `Types.Models` virtual field
   ///   types inject relational methods on the model.
+  ///
   /// Note:
   ///   Only concrete fields are considered "attributes" of the model,
   ///   and can have an initial value provided via the `data` argument
   ///   to the constructor, or via a `defaultValue` property on the field.
+  ///
   /// Arguments:
   ///   data?: object
   ///     Attributes values for fields. Can be nothing, in which case
@@ -1820,6 +1896,7 @@ class Model {
   ///
   /// Return: any
   ///   The value provided, cast to the type of the field.
+  ///
   /// Arguments:
   ///   field: <see>Field</see>
   ///     The field to use to cast the value. The `type` property
@@ -2004,7 +2081,9 @@ class Model {
   ///   the `update` or `insert` "options", then the default value
   ///   for the field will be fetched via the <see>QueryGenerator.getFieldDefaultValue</see>
   ///   method through the provided `connection`.
+  ///
   /// Return: DirtyFieldChangeList
+  ///
   /// Arguments:
   ///   options?: DirtyFieldOptions
   ///     Options to provide to the method.
@@ -2049,7 +2128,7 @@ class Model {
 
       // Does the connection dirtyFieldHelper report that we are
       // dirty?
-      if (connection && typeof connection.dirtyFieldHelper === 'function') {
+      if (connection) {
         let value = connection.dirtyFieldHelper({ options, fieldData, dirtyFieldData, dirtyFields, field, fieldName });
         if (value !== undefined) {
           // Cache this result so subsequent calls
@@ -2112,12 +2191,15 @@ class Model {
   ///   inside a field's `get` method. If you do, you will enter an
   ///   infinite recursive loop. Instead, call the provided `get`
   ///   method (as provided by the context), or call <see>Model.getDataValue</see>.
+  ///
   /// Return: any
+  ///
   /// Arguments:
   ///   fieldName: string
   ///     The name of the field whose value we wish to get.
   ///   field: <see>Field</see>
   ///     The field definition itself for the value we wish to get.
+  ///
   /// See: Field
   _getFieldValue(fieldName, field) {
     let value = this.getDataValue(fieldName);
@@ -2151,17 +2233,21 @@ class Model {
   /// Note:
   ///   This method will mark the field as dirty if the value provided
   ///   differs from the current value the field has.
+  ///
   /// Note:
   ///   Never call this method (or set the model attribute by name), while
   ///   inside a field's `set` method. If you do, you will enter an
   ///   infinite recursive loop. Instead, call the provided `set`
   ///   method (as provided by the context), or call <see>Model.setDataValue</see>.
+  ///
   /// Return: undefined
+  ///
   /// Arguments:
   ///   fieldName: string
   ///     The name of the field whose value we wish to get.
   ///   field: <see>Field</see>
   ///     The field definition itself for the value we wish to get.
+  ///
   /// See: Field
   _setFieldValue(fieldName, field, value) {
     if (typeof field.set === 'function') {
@@ -2193,9 +2279,9 @@ class Model {
     return this._persisted;
   }
 
-  /// Update the `this.dirtyID` cache key of the model.
+  /// Update the `this._dirtyID` cache key of the model.
   /// This is called any time a field is marked as "dirty" on the model.
-  /// The `dirtyID` property of a model is an instance of
+  /// The `_dirtyID` property of a model is an instance of
   /// a <see>CacheKey</see> that is intended to be used for
   /// caching systems. The <see>CacheKey</see> instance can
   /// be used for a key into a WeakMap, which can cache things.
@@ -2204,7 +2290,7 @@ class Model {
   /// any cache for this model will be invalidated as soon
   /// as any field on the model is dirty.
   updateDirtyID() {
-    this.dirtyID = new CacheKey(this.dirtyID);
+    this._dirtyID = new CacheKey(this._dirtyID);
   }
 
   /// Check if the model is dirty or not.
@@ -2215,6 +2301,7 @@ class Model {
   /// one or more fields are marked as "dirty".
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   fieldName?: string
   ///     If provided, check if this one field is dirty. If not
@@ -2254,6 +2341,7 @@ class Model {
   /// the field.
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   fieldName?: string
   ///     If specified, clear only this field's "dirty" status.
@@ -2283,6 +2371,7 @@ class Model {
   ///
   /// Return: Array<<see>Field</see>>
   ///   The dirty fields of the model.
+  ///
   /// Arguments:
   ///   options?: object
   ///     If provided, this will be the "options" supplied to
@@ -2309,6 +2398,7 @@ class Model {
   /// from the underlying `this._fieldData` storage area for field values.
   ///
   /// Return: any
+  ///
   /// Arguments:
   ///   fieldName: string
   ///     The name of the field whose value you wish to fetch.
@@ -2343,7 +2433,9 @@ class Model {
   /// Note:
   ///   This method will always call <see>Model.updateDirtyID</see>,
   ///   invalidating all down-stream cache for this model instance.
+  ///
   /// Return: undefined
+  ///
   /// Arguments:
   ///   fieldName: string
   ///     The name of the field whose value you wish to set.
@@ -2403,6 +2495,7 @@ class Model {
   /// Note:
   ///   Field's with `undefined` values will not be included in the
   ///   resulting object.
+  ///
   /// Return: object
   ///   All models attributes (field values).
   getAttributes() {
@@ -2434,13 +2527,16 @@ class Model {
   /// Note:
   ///   Any `undefined` value in the provided object will be
   ///   ignored, and no update will occur for the field.
+  ///
   /// Note:
   ///   If a raw object instead of a model instance is provided,
   ///   then `hasOwnProperty` is called for each field name,
   ///   and if the provided object doesn't contain its "own"
   ///   property matching the field name, the field will be
   ///   silently skipped, and not set.
+  ///
   /// Return: undefined
+  ///
   /// Arguments:
   ///   attributes: object | Model
   ///     The attributes to set on the model. The keys
@@ -2534,12 +2630,14 @@ class Model {
   ///   anything else. You must provide the implementation of each
   ///   `validate` method directly yourself (which could for example
   ///   use a RegExp to check the field's value).
+  ///
   /// Return: Array<any>
   ///   Results of each `validate` call from each field. Will generally
   ///   be `undefined` for each call. The validation for a field will
   ///   only fail if an exception is thrown. `false` or `null` as a
   ///   return value from a `validate` call is meaningless
   ///   (unless you yourself wish to do something with it).
+  ///
   /// Arguments:
   ///   context: object
   ///     A context object that is provided to all model hooks.
@@ -2775,6 +2873,7 @@ class Model {
   ///   error. Errors will be thrown. `false` simply means that
   ///   the model had no dirty fields, so it was never sent to
   ///   the database.
+  ///
   /// Arguments:
   ///   options?: object
   ///     Options to pass to the underlying connection
@@ -2833,7 +2932,9 @@ class Model {
   ///   A primary key is required on the model for this method
   ///   to work. If you don't have a primary key defined, then
   ///   you will need to create your own "reload" operation.
+  ///
   /// Return: undefined
+  ///
   /// Arguments:
   ///   options?: object
   ///     Options to pass to the underlying <see>QueryEngine.first</see>
@@ -2880,8 +2981,10 @@ class Model {
   ///   A primary key is required on the model for this method
   ///   to work. If you don't have a primary key defined, then
   ///   you will need to create your own "destroy" operation.
+  ///
   /// Return: number
   ///   The number of rows modified in the database.
+  ///
   /// Arguments:
   ///   options?: object
   ///     Options to pass to the underlying <see>QueryEngine.destroy</see>
@@ -2917,6 +3020,7 @@ class Model {
   ///
   /// Return: object
   ///   All model attributes, ready to be serialized.
+  ///
   /// See: Type.serialize
   toJSON() {
     let result  = {};
@@ -2956,4 +3060,4 @@ class Model {
 
 bindStaticWhereToModelClass(Model);
 
-module.exports = Model;
+module.exports = { Model, CacheKey };