bookshelf/CHANGELOG.md

## Change Log

**0.10.1** - <small>_Jun 29, 2016_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.10.0...0.10.1)

* Allows using knex 0.12 as a peerDependency
* knex instance used by bookshelf may be swapped out

## Change Log

**0.10.0** — <small>_Jun 29, 2016_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.9.5...0.10.0)

**Breaking Changes:**

* Removal/renaming of certain lodash functions from Model and Collection that were removed in lodash 4.
  * Collection Methods
      * removed `CollectionBase#collect` => use `CollectionBase#map` instead
      * removed `CollectionBase#foldl` => use `CollectionBase#reduce` instead
      * removed `CollectionBase#inject` => use `CollectionBase#reduce` instead
      * removed `CollectionBase#foldr` => use `CollectionBase#reduceRight` instead
      * removed `CollectionBase#detect` => use `CollectionBase#find` instead
      * removed `CollectionBase#select` => use `CollectionBase#filter` instead
      * removed `CollectionBase#all` => use `CollectionBase#every` instead
      * removed `CollectionBase#any` => use `CollectionBase#some` instead
      * removed `CollectionBase#include` => use `CollectionBase#includes` instead
      * removed `CollectionBase#contains` => use `CollectionBase#includes` instead
      * removed `CollectionBase#rest` => use `CollectionBase#tail instead`
      * renamed `CollectionBase#invoke` => `CollectionBase#invokeMap`
      * split `CollectionBase#max` into `CollectionBase#maxBy` - see the [lodash docs](https://lodash.com/docs/#max) for more explanation
      * split `CollectionBase#min` into `CollectionBase#minBy` - see the [lodash docs](https://lodash.com/docs/#min) for more explanation
  * Model Methods
      * renamed `ModelBase#pairs` => `ModelBase#toPairs`

**Other Changes:**

* Update to Lodash 4. #1287
* Registry plugin: Better support for custom relations. #1294

**0.9.5** — <small>_May 15, 2016_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.9.4...0.9.5)

* Add pagination plugin. #1183
* Fire {@link Model#event:fetched} on eagerly loaded relations. #1206
* Correct cloning of {@link Model#belongsToMany} decorated relations. #1222
* Update Knex to 0.11.x. #1227
* Update minimum lodash version. #1230

**0.9.4** — <small>_April 3, 2016_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.9.3...0.9.4)

* Include `babel-runtime` as a dependency. #1188

**0.9.3** — <small>_April 3, 2016_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.9.2...0.9.3)

* Bugfix: Restore support for `camelCase` and `color:separated` event names. #1184

**0.9.2** — <small>_February 17, 2016_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.9.1...0.9.2)

* Permit up to Knex 0.11.0 via `peerDependencies`.
* `Model.forge` works for ES6 classes. #924
* Fix `Collection#count` for `hasMany` relations. #1115

**0.9.1** — <small>_November 4, 2015_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.9.0...0.9.1)

* {@link Events#off} can now deregister multiple methods at once. #983
* Permit Knex 0.10.0 via `peerDependencies`. #998

**0.9.0** — <small>_November 1, 2015_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.8.2...0.9.0)

* Repo no longer includes built source or generated documentation. Release script updated to include these only in the tagged release commit. #950.
* {@link Model#previous} returned `undefined` instead of `null` for non-existant attributes.
* Update tests and documentation to confirm that `null` (rather than `undefined`) is returned from {@link Model#fetch} and {@link Collection#fetchOne}.
* Fix error in virtual plugin - #936
* Correct error updating parsed/formatted {@link Model#idAttribute} after successful `insert` operation. #955
* Many documentation fixes.

**0.8.2** — <small>_August 20, 2015_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.8.1...0.8.2)

*   ES6/7: Move code base to `/src` — code is now compiled into `/lib` via [Babel](https://babeljs.io/).
*   Add `collection.count`, `model.count` and `Model.count`.
*   Add `model.refresh`. #796
*   Prevent `fetch` and `refresh` from trying to add JSON attributes to a `where` clause. #550 #778
*   Virtuals plugin now supports `{patch: true}` argument to `model.save`. #542
*   Restored `model.clone` and `collection.clone`, which were not previously working. #744
*   Allow `bookshelf.Collection` to be modified and extended by plugins (so that relations and `fetchAll` operations will return the extended instance). #681 #688
*   Fix `model.timestamps` behaviour which deviated from documentation. Also ensure that `createdAt` is set when `{method: "insert"}` is passed explicitly. #787
*   Calling `create` on a `through` relationship no longer tries to make a pivot object. Previously this would attempt to create an object with invalid foreign keys. #768
*   Parse foreign keys set during `create` in a relation. #770

**0.8.1** — <small>_May 12, 2015_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.8.0...0.8.1)

*   Fix for regression in `initialize` not being called in Collection constructor, #737.
*   Fix for regression, removing `omitPivot` in 0.8 #721
*   Added `serialize`, a method which contains toJSON logic for easier customization.

**0.8.0** — <small>_May 1, 2015_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.9...0.8.0)

*   Dropped Backbone dependency
*   More specific errors throughout, #522
*   Support {require: true} for model.destroy #617
*   Add lifecycle events on pivot models for belongsToMany, .through #578
*   Allows for select/column calls in the query builder closure, #633.
*   Added per-constructor error classes #694 (note: this will not work in CoffeeScript).

**Breaking Changes:**

*   Removed the `__super__` internal property on the constructor, this shouldn't have been something you were relying on anyway.

**0.7.9** — <small>_Oct 28, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.8...0.7.9)

*   Fix for regression in columns / eager fetch query constraints, (#510).

**0.7.8** — <small>_Oct 28, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.7...0.7.8)

*   Timestamp `created_at` is now saved with any insert.
*   Fix for regression created by #429.
*   New events, `attaching`, `attached`, `detaching`, `detached` #452.
*   Ability to specify custom column names in morphTo, #454
*   Fix for stack overflow with model list as arguments, #482
*   Modified location of eager fetch query constraints internally.

**0.7.7** — <small>_July 23, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.6...0.7.7)

*   Fix for formatting on polymorphic keys, (#429).
*   Added a resolve method for specifying a custom resolver function for the registry plugin.

**0.7.6** — <small>_June 29, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.5...0.7.6)
 Add `omitPivot` flag on toJSON options for omitting the `_pivot_` keys in `through` and `belongsToMany` relations (#404).

**0.7.5** — <small>_June 23, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.4...0.7.5)
 Fix missing NotFoundError & EmptyError on Model & Collection, respectively (#389, 399).

**0.7.4** — <small>_June 18, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.3...0.7.4)
 Added `bookshelf.model(name, protoProps, [staticProps])` syntax for registry plugin.

**0.7.3** — <small>_June 17, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.2...0.7.3)
 Fix for collection dropping models early in set, #376.

**0.7.2** — <small>_June 12, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.1...0.7.2)
 Pass a cloned copy of the model's attributes to `format` rather than the original, related to #315.

**0.7.1** — <small>_June 10, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.7.0...0.7.1)
 Ensure the knex version >= 0.6.10, where a major regression affecting column names was fixed.

**0.7.0** — <small>_June 9, 2014_</small>

*   Added {@link Model#fetchAll}, for fetching a collection of models from a model.
*   Added {@link Model#where}, as a shortcut for the most commonly used {@linkplain Model#query query method}.
*   Initializing via a plain options object is deprecated, you must now pass in an initialized knex instance.
*   Adding typed errors (#221).
*   Upgrade to support knex 0.6.x

**0.6.12** — <small>_June 5, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.11...0.6.12)
 Fix for eager loaded belongsTo relation bug with custom parse/format (#377).

**0.6.11** — <small>_June 4, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.10...0.6.11)
 Temporarily add knex to `peerDependencies` until 0.7 is released to support knex 0.6 and there exists a better internal method of doing a semver check. Fix for belongsTo relation bug (#353).

**0.6.10** — <small>_April 3, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.9...0.6.10)

*   Bumping dependencies, including upgrading to Bluebird 1.2, trigger-then 0.3, fixing an erroneous "unhandledRejection" (#310).
*   `fetchOne` properly resets the query on the collection, (#300).

**0.6.9** — <small>_April 3, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.8...0.6.9)
 Only prefix model fields with the "tableName" after format has been called, (#308).

**0.6.8** — <small>_March 6, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.7...0.6.8)

*   Virtuals plugin may now accept a hash of attributes to set.
*   Properly fix issue addressed in 0.6.7.

**0.6.7** — <small>_March 2, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.6...0.6.7)
 Bugfix for edge case for eager loaded relations and `relatedData` settings.

**0.6.6** — <small>_March 1, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.5...0.6.6)
 Bugfix for registry plugin, resolving correct models for "through" relations. (#260)

**0.6.5** — <small>_February 28, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.4...0.6.5)

*   Added {@link Collection#reduceThen} as a passthrough to Bluebird's "reduce" method with models.
*   Options are now passed to "plugin" method. (#254)
*   Bugfix for registry plugin. (#259)

**0.6.4** — <small>_February 11, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.3...0.6.4)
 Adds static method {@link Model.collection Model.collection()} as a shortcut for creating a collection with the current model.

**0.6.3** — <small>_February 9, 2014_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.2...0.6.3)

*   Added an` Relation#updatePivot` method for updating tables on a "belongsToMany" relation. (#134, #230)
*   Allow mutating the options for passing constraints to eager loaded relations. (#151)
*   All keys of an object passed into sync are properly prefixed before sync. (#177)
*   Clearer error messages for debugging. (#204, #197)
*   Fixed error message for updates that don't affect rows. (#228)
*   Group by the correct key on "belongsTo.through" relations. (#214)
*   Ability to only use `created_at` or `updated_at` as timestamp properties. (#158)
*   Numerous documentation corrections, clarifications, enhancements.
*   Bumped Bluebird dependency to ~1.0.0.

**Plugins:**

*   Added the `registry` plugin for registering models as strings, helping with the circular dependency problem
*   Added the `virtuals` plugin for getting/setting virtual (computed) properties on the model.
*   Added the `visibility` plugin for specifying a whitelist/blacklist of keys when a model is serialized with toJSON.

**0.6.2** — <small>_December 18, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.1...0.6.2)

*   Debug may now be passed as an option in any sync method, to log queries, including relations.
*   Save now triggers an error in updates with no affected rows. (#119)
*   The `model.id` attribute is only set on insert if it's empty. (#130)
*   Ensure eager loaded relations can use attach/detach. (#120)

**0.6.1** — <small>_November 26, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.6.0...0.6.1)
 Fixes bug with promise code and saving event firing, where promises are not properly resolved with ".all" during saving events.

**0.6.0** — <small>_November 25, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.5.8...0.6.0)

*   Updating dependency to knex.js 0.5.x
*   Switched from when.js to [bluebird](https://github.com/petkaantonov/bluebird) for promise implementation, with shim for backward compatibility.
*   Switched from underscore to lodash, for semver reliability.

**0.5.8** — <small>_November 24, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.5.7...0.5.8)

*   Parse models after all relations have been eager loaded, for appropriate column name matching (thanks [@benesch](https://github.com/benesch)) (#97)
*   Specify table for `withRelated` fetches to prevent column naming conflicts (#96).
*   Fix for polymorphic relation loading (#95).
*   Other documentation tweaks and other internal code cleanup.

**0.5.7** — <small>_October 11, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.5.6...0.5.7)
 The "fetching" event is now fired on eager loaded relation fetches.

**0.5.6** — <small>_October 10, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.5.5...0.5.6)
 The `options.query` now contains the appropriate `knex` instance during the "fetching" event handler.

**0.5.5** — <small>_October 1, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.5.4...0.5.5)
 An eager loaded [morphTo](#Model-morphTo) relation may now have child relations nested beneath it that are properly eager loaded, depending on the parent.

**0.5.4** — <small>_October 1, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.5.3...0.5.4)

*   Fix issue where the `relatedData` context was not appropriately maintained for subsequent {@link Collection#create} calls after an eager load (#77).
*   Documentation improvements, encouraging the use of {@link Model#related} rather than calling a relation method directly, to keep association with the parent model's {@link Model#relations relations} hash.

**0.5.3** — <small>_September 26, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.5.2...0.5.3)
 The `columns` explicitly specified in a fetch are no-longer passed along when eager loading relations, fixes (#70).

**0.5.2** — <small>_September 22, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.5.1...0.5.2)
 Fixed incorrect eager loading in `belongsTo` relations (#65).

**0.5.1** — <small>_September 21, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.5.0...0.5.1)
 Fixed incorrect eager loading in `hasOne` relations (#63).

**0.5.0** — <small>_September 20, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.3.1...0.5.0)
 **Major Breaking Changes:**

*   Global state is no longer stored in the library, an instance is returned from `Bookshelf.initialize`, so you will need to call this once and then reference this `Bookshelf` client elsewhere in your application.
*   Lowercasing of `bookshelf.initialize`, `bookshelf.knex`, `bookshelf.transaction`.
*   During the lifecycle events, such as "fetching", "saving", or "destroying", the model no-longer contains the active query builder instance at the time it is saved. If you need to modify the query builder chain inside of an event handler, you may now use `options.query` inside the event handlers.

**Other Changes:**

*   Added `tableName` for all queries, so joins use the correct id (#61).
*   The `attach` & `detach` now remove models from the associated collection, as appropriate (#59).
*   A `withPivot` no longer accepts an object to specify the keys for the returned pivot items, if you wish to specify how these pivot objects are defined on the object, a custom [toJSON](#Model-toJSON) is your best bet.
*   Added {@link Collection#invokeThen} and {@link Collection#mapThen} as convenience helpers for `Promise.all(collection.invoke(method, args*))` and `Promise.all(collection.map(method, iterator, [context]))`, respectively.
*   Added a `Bookshelf.plugin` method, for a standard way to extend Bookshelf instances.
*   A re-written modular architecture, to move the library toward becoming a database agnostic "data mapper" foundation, with the ablitiy to form relations between different data stores and types, not just SQL (although SQL is the primary focus for now). Also, support for AMD, for eventual use outside of Node.js runtime (with webSQL and likewise).

**0.3.1** — <small>_August 29, 2013_</small> — [Diff](https://github.com/tgriesser/bookshelf/compare/0.3.0...0.3.1) — [Docs](http://htmlpreview.github.com/?https://raw.github.com/tgriesser/bookshelf/0.3.0/index.html)
 Fixed regression in `belongsToMany` custom column name order.

**0.3.0** — <small>_August 28, 2013_</small>
 Support for a {@link Model#through} clause on various model relations. Creating a model from a related collection maintains the appropriate relation data (#35). Support for a `{patch: true}` flag on save, to only update specific saved attributes. Added a `fetchOne` method, for pulling out a single model from a collection, mostly useful for related collection instances. Updated to Knex "0.2.x" syntax for insert / returning, Ability to specify a `morphValue` on {@link Model#morphOne} or {@link Model#morphMany} relations. Internal refactor of relations for more consistent behavior.

**0.2.8** — <small>_August 26, 2013_</small>
 Some minor fixes to make the `Sync` methods more consistent in their behavior when called directly, (#53).

**0.2.7** — <small>_August 21, 2013_</small>
 Timestamp for `created_at` is not set during an "update" query, and the update where clause does not include the `idAttribute` if it isn't present (#51).

**0.2.6** — <small>_August 21, 2013_</small>
 Fixes bug with query function feature added in `0.2.5`, mentioned in (#51).

**0.2.5** — <small>_August 19, 2013_</small>
 The {@link Model#query} method may now accept a function, for even more dynamic query building (#45). Fix for relations not allowing "0" as a valid foreign key value (#49).

**0.2.4** — <small>_July 30, 2013_</small>
 More consistent query resetting, fixing query issues on post-query event handlers. The `toJSON` is only called on a related model if the method exists, allowing for objects or arrays to be manually specified on the `relations` hash and serialized properly on the parent's `toJSON`.

**0.2.3** — <small>_July 7, 2013_</small>
 Fixing bug where `triggerThen` wasn't actually being used for several of the events as noted in 0.2.1 release.

**0.2.2** — <small>_July 2, 2013_</small>
 The Model's `related` method is now a no-op if the model doesn't have the related method. Any `withPivot` columns on many-to-many relations are now prefixed with `_pivot` rather than `pivot` unless named otherwise, for consistency. The `_reset` is not called until after all triggered events so that `hasChanged` can be used on the current model state in the "created", "updated", "saved", and "destroyed" events. Eager queries may be specified as an object with a function, to constrain the eager queries:

    user.fetch({withRelated: ['accounts', {
    'accounts.settings': function(qb) { qb.where('status', 'enabled'); }
    }, 'other_data']}).then(...

**0.2.1** — <small>_June 26, 2013_</small>
 Using `triggerThen` instead of `trigger` for "created", "updated", "saved", "destroyed", and "fetched" events - if any async operations are needed _after_ the model is created but before resolving the original promise.

**0.2.0** — <small>_June 24, 2013_</small>
 Resolve Model's `fetch` promise with `null` rather than undefined. An object of `query`. constraints (e.g. `{where: {...}, orWhere: {...}}`may be passed to the query method (#30). Fix for empty eager relation responses not providing an empty model or collection instance on the `model.relations` object.

**0.1.9** — <small>_June 19, 2013_</small>
 Resolve Model's `fetch` promise with `undefined` if no model was returned. An array of "created at" and "updated at" values may be used for `hasTimestamps`. Format is called on the `Model#fetch` method. Added an `exec` plugin to provide a node callback style interface for any of the promise methods.

**0.1.8** — <small>_June 18, 2013_</small>
 Added support for polymorphic associations, with `morphOne`, `morphMany`, and `morphTo` model methods.

**0.1.7** — <small>_June 15, 2013_</small>
 Bugfix where `detach` may be used with no parameters to detach all related items (#19).

**0.1.6** — <small>_June 15, 2013_</small>
 Fixing bug allowing custom `idAttribute` values to be used in eager loaded many-to-many relations (#18).

**0.1.5** — <small>_June 11, 2013_</small>
 Ensuring each of the `_previousAttribute` and `changed` values are properly reset on related models after sync actions.

**0.1.4** — <small>_June 10, 2013_</small>
 Fixing issue with `idAttribute` not being assigned after database inserts. Removing various aliases {@link Events} methods for clarity.

**0.1.3** — <small>_June 10, 2013_</small>
 Added {@link Model#hasChanged}, {@link Model#previous}, and {@link Model#previousAttributes} methods, for getting the previous value of the model since the last sync. Using `Object.create(null)` for various internal model objects dealing with user values. Calling {@link Model#related} on a model will now create an empty related object if one is not present on the `relations` object. Removed the `{patch: true}` option on save, instead only applying defaults if the object `isNew`, or if `{defaults: true}` is passed. Fix for `model.clone`'s relation responses.

**0.1.2** — <small>_May 17, 2013_</small>
 Added `triggerThen` and `emitThen` for promise based events, used internally in the "creating", "updating", "saving", and "destroying" events. Docs updates, fixing `{patch: true}` on `update` to have intended functionality. A model's `toJSON` is now correctly called on any related properties.

**0.1.1** — <small>_May 16, 2013_</small>
 Fixed bug with eager loaded `belongsTo` relations (#14).

**0.1.0** — <small>_May 13, 2013_</small>
 Initial Bookshelf release.