# mongoose-history

> Keeps a history of all changes of a document.

Latest version **0.8.0** (published 2018-10-29) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install mongoose-history
pnpm add mongoose-history
yarn add mongoose-history
bun add mongoose-history
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.0 |
| Published | 2018-10-29 |
| First published | 2013-10-06 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nassor Paulino da Silva |
| Maintainers | nassor |
| Keywords | mongoose, history, safe, cqrs, backup |

## Links

- npm: https://www.npmjs.com/package/mongoose-history
- Repository: https://github.com/nassor/mongoose-history
- Homepage: https://github.com/nassor/mongoose-history#readme
- Issues: https://github.com/nassor/mongoose-history/issues
- npm.io page: https://npm.io/package/mongoose-history

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 0.8.0 (latest) — 2018-10-29
- 0.7.0 — 2018-10-26
- 0.6.0 — 2018-02-05
- 0.4.2 — 2015-10-07
- 0.4.1 — 2015-08-04
- 0.4.0 — 2015-04-16
- 0.3.3 — 2014-11-28
- 0.3.2 — 2014-09-19
- 0.3.1 — 2014-04-08
- 0.1.0 — 2013-10-09
- 0.0.3 — 2013-10-06
- 0.0.2 — 2013-10-06
- 0.0.1 — 2013-10-06

## README

# Mongoose History Plugin

[![Build Status](https://travis-ci.org/nassor/mongoose-history.svg?branch=master)](https://travis-ci.org/nassor/mongoose-history)

Keeps a history of all changes of a document.

## Installation

```bash
npm install mongoose-history
```

Or add it to your package.json

## Usage

For starting history of your collection, you need to simply add the mongoose-history plugin:

```javascript
var mongoose        = require('mongoose')
  , mongooseHistory = require('mongoose-history')
  , Schema          = mongoose.Schema

var Post = new Schema({
    title:       String
  , message:     String
  , updated_for: String
})

Post.plugin(mongooseHistory)
```
This will generate a log from al your changes on this schema.

The plugin will create a new collection with format: originalCollectionName +  **_history**, in example: __posts_history__. You can also change the name of the collection by setting the configuration customCollectionName:

```javascript
var options = {customCollectionName: "post_hst"}
Post.plugin(mongooseHistory, options)
```

The history documents have the format:

```javascript
{
    _id:  ObjectId,
    t: Date // when history was made
    o: "i" (insert) | "u" (update) | "r" (remove) // what happens with document
    d: {  // changed document data
        _id:         ObjectId
      , title:       String
      , message:     String
      , updated_for: String
    }
}
```

### Indexes
To improve queries perfomance in history collection you can define indexes, for example:

```javascript
var options = {indexes: [{'t': -1, 'd._id': 1}]};
Post.plugin(mongooseHistory, options)
```

### Send history to another database
You can keep your history collection far away from your primary database or replica set. This can be useful for improve the architecture of your system.

Just create another connection to the new database and link the reference in __historyConnection__:

```javascript
var secondConn = mongoose.createConnection('mongodb://localhost/another_conn');
var options = {historyConnection: secondConn}
Post.plugin(mongooseHistory, options)
```

### Store metadata
If you need to store aditionnal data, use the ```metadata``` option
It accepts a collection of objects. The parameters ```key``` and ```value``` are required. 
You can specify mongoose options using the parameter ```schema``` (defaults to ```{type: mongoose.Schema.Types.Mixed}```)
```value``` can be either a String (resolved from the updated object), or a function, sync or async

```javascript
var options = {
  metadata: [
    {key: 'title', value: 'title'},
    {key: 'titleFunc', value: function(original, newObject){return newObject.title}},
    {key: 'titleAsync', value: function(original, newObject, cb){cb(null, newObject.title)}}
  ]
};
PostSchema.plugin(history,options);
module.exports = mongoose.model('Post_meta', PostSchema);
```

### Statics
All modules with history plugin have following methods:

#### Model.historyModel()
Get History Model of Model;

#### Model.clearHistory()
Clear all History collection;

## Development

### Testing

The tests run against a local mongodb installation and use the following databases: `mongoose-history-test` and `mongoose-history-test-second`.

Custom connection uris can be provided via environment variables for e.g. using a username and password:
```
CONNECTION_URI='mongodb://username:password@localhost/mongoose-history-test' SECONDARY_CONNECTION_URI='mongodb://username:password@localhost/mongoose-history-test-second' mocha
```

### In progress
* Plugin rewriting.
* update, findOneAndUpdate, findOneAndRemove support.

## TODO
* **TTL documents**

## LICENSE

Copyright (c) 2013-2016, Nassor Paulino da Silva <nassor@gmail.com>
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

---
_Source: https://npm.io/package/mongoose-history · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._