Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salmanzafar949/sequelize-model-trail
Package that helps you track changes to your models, for auditing or versioning. See how a model looked at any stage in its life-cycle and also allows you to Record the user who created the version.
https://github.com/salmanzafar949/sequelize-model-trail
audit-trail auditing mariadb model-trail mysql nodejs paper-trail revision sequelize sequelize-extension sequelize-library sequelize-model-trail sequelize-mysql sequelize-orm sequelizejs
Last synced: about 1 month ago
JSON representation
Package that helps you track changes to your models, for auditing or versioning. See how a model looked at any stage in its life-cycle and also allows you to Record the user who created the version.
- Host: GitHub
- URL: https://github.com/salmanzafar949/sequelize-model-trail
- Owner: salmanzafar949
- License: mit
- Created: 2022-08-21T16:03:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-21T23:08:17.000Z (about 2 years ago)
- Last Synced: 2024-10-01T15:04:20.880Z (about 2 months ago)
- Topics: audit-trail, auditing, mariadb, model-trail, mysql, nodejs, paper-trail, revision, sequelize, sequelize-extension, sequelize-library, sequelize-model-trail, sequelize-mysql, sequelize-orm, sequelizejs
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Sequelize Model Trail
> Package that helps you track changes to your models, for auditing or versioning. See how a model looked at any stage in its life-cycle and also allows you to Record the user who created the version.
[](https://www.npmjs.org/package/sequelize-model-trail)
[](https://www.npmjs.org/package/sequelize-model-trail)
[](https://www.npmjs.org/package/sequelize-model-trail)
[](https://www.npmjs.org/package/sequelize-model-trail)
[]()
[](https://www.npmjs.org/package/sequelize-model-trail)
[](https://github.com/salmanzafar949/sequelize-model-trail/blob/master/LICENSE)
## Table of Contents
- [Sequelize Model Trail](#sequelize-model-trail)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
- [User Tracking](#user-tracking)
- [Contributing](#contributing)
- [Author](#author)
- [Upcoming Features](#Upcoming-features)
- [Support](#support)
- [Thanks](#thanks)
## Installation
```bash
npm install --save sequelize-model-trail
```
## Usage
Sequelize Model Trail assumes that you have already set up your Sequelize connection, for example, like this:
```javascript
const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password');
```
then adding Sequelize Model Trail is as easy as:
```javascript
const ModelTrail = require('sequelize-model-trail').init(sequelize);
ModelTrail.enableAndLoadModelTrail();
```
which loads the Model Trail library, and the `enableAndLoadModelTrail()` method sets up a `revisions` table and Model.
*Note: You need to Pass userId as options if you want to enable user tracking*
## User Tracking
Currently, there is only one step to enable user tracking, ie, recording the user who created a particular revision.
```javascript
Model.update({
/* ... */
}, {
userId: user.id
}).then(() {
/* ... */
});
```
## How data is stored
+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+
| id | model | document | operation | documentId | createdAt | updatedAt | userId |
+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+
| 1 | users | {"id": [1, null], "name": ["Salman", null]} | create | 1 | 2022-08-22 01:17:34 | 2022-08-22 01:17:34 | NULL |
+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+
+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+
| 2 | users | {"name": ["Salman Zafar", "Salman"]} | update | 1 | 2022-08-22 01:20:10 | 2022-08-22 01:20:10 | 1 |
+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+
+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+
| 3 | users | {} | destroy | 1 | 2022-08-22 01:21:30 | 2022-08-22 01:21:30 | 1 |
+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Author
© [Salman Zafar](https://github.com/salmanzafar949) – [@salmanzafar949](https://twitter.com/salmanzafar949)
Distributed under the MIT license. See ``LICENSE`` for more information.
[https://github.com/salmanzafar949/sequelize-model-trail](https://github.com/salmanzafar949/)
Contributors:
[https://github.com/salmanzafar949/sequelize-paper-trail/graphs/contributors](https://github.com/nielsgl/sequelize-model-trail/graphs/contributors)
## example
* [Example application](https://github.com/salmanzafar949/sequelize-model-trail-example)
## Upcoming features
- Specify Models for Model Trails
- UUID
- CUSTOM MODEL/TABLE NAME
- CUSTOM OPTIONS
## Support
*If this project help you reduce time to develop, you can give me a cup of coffee :)*
Please use:
* GitHub's [issue tracker](https://github.com/salmanzafar949/sequelize-model-trail/issues)
* [Buy me a coffee](https://paypal.me/salmanzafar949)
## Thanks
This project was inspired by:
* [sequelize-paper-trail](https://github.com/nielsgl/sequelize-paper-trail)
## Happy Coding.!