{"id":15285359,"url":"https://github.com/salmanzafar949/sequelize-model-trail","last_synced_at":"2026-01-05T11:47:37.608Z","repository":{"id":57728864,"uuid":"527256271","full_name":"salmanzafar949/sequelize-model-trail","owner":"salmanzafar949","description":"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.","archived":false,"fork":false,"pushed_at":"2022-08-21T23:08:17.000Z","size":11,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T00:50:06.516Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/salmanzafar949.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":["https://paypal.me/salmanzafar949"]}},"created_at":"2022-08-21T16:03:45.000Z","updated_at":"2023-03-07T11:42:40.000Z","dependencies_parsed_at":"2022-09-09T09:31:14.786Z","dependency_job_id":null,"html_url":"https://github.com/salmanzafar949/sequelize-model-trail","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salmanzafar949%2Fsequelize-model-trail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salmanzafar949%2Fsequelize-model-trail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salmanzafar949%2Fsequelize-model-trail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salmanzafar949%2Fsequelize-model-trail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/salmanzafar949","download_url":"https://codeload.github.com/salmanzafar949/sequelize-model-trail/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245152771,"owners_count":20569399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["audit-trail","auditing","mariadb","model-trail","mysql","nodejs","paper-trail","revision","sequelize","sequelize-extension","sequelize-library","sequelize-model-trail","sequelize-mysql","sequelize-orm","sequelizejs"],"created_at":"2024-09-30T15:04:21.281Z","updated_at":"2026-01-05T11:47:37.564Z","avatar_url":"https://github.com/salmanzafar949.png","language":"JavaScript","funding_links":["https://paypal.me/salmanzafar949"],"categories":[],"sub_categories":[],"readme":"# Sequelize Model Trail\n\n\n\u003e 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.\n\n\n\u003c!-- [![NPM](https://nodei.co/npm/sequelize-model-trail.png?downloads=true)](https://nodei.co/npm/sequelize-model-trail/) --\u003e\n\n[![node-version](https://img.shields.io/node/v/sequelize-model-trail.svg)](https://www.npmjs.org/package/sequelize-model-trail)\n[![npm-version](https://img.shields.io/npm/v/sequelize-model-trail.svg)](https://www.npmjs.org/package/sequelize-model-trail)\n\n[![GitHub release](https://img.shields.io/github/release/salmanzafar949/sequelize-model-trail.svg)](https://www.npmjs.org/package/sequelize-model-trail)\n[![GitHub tag](https://img.shields.io/github/tag/salmanzafar949/sequelize-model-trail.svg)](https://www.npmjs.org/package/sequelize-model-trail)\n[![GitHub commits](https://img.shields.io/github/commits-since/salmanzafar949/sequelize-model-trail/1.2.0.svg)]()\n[![npm-downloads](https://img.shields.io/npm/dt/sequelize-model-trail.svg)](https://www.npmjs.org/package/sequelize-model-trail)\n\n[![license](https://img.shields.io/github/license/salmanzafar949/sequelize-model-trail.svg)](https://github.com/salmanzafar949/sequelize-model-trail/blob/master/LICENSE)\n![GitHub Sponsor](https://img.shields.io/github/sponsors/salmanzafar949?label=Sponsor\u0026logo=GitHub)\n\n## Table of Contents\n\n- [Sequelize Model Trail](#sequelize-model-trail)\n    - [Table of Contents](#table-of-contents)\n    - [Installation](#installation)\n    - [Usage](#usage)\n        - [Example](#example)\n    - [User Tracking](#user-tracking)\n    - [Contributing](#contributing)\n    - [Author](#author)\n    - [Upcoming Features](#Upcoming-features)\n    - [Support](#support)\n    - [Thanks](#thanks)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Installation\n\n```bash\nnpm install --save sequelize-model-trail\n```\n\n## Usage\n\nSequelize Model Trail assumes that you have already set up your Sequelize connection, for example, like this:\n```javascript\nconst Sequelize = require('sequelize');\nconst sequelize = new Sequelize('database', 'username', 'password');\n```\n\nthen adding Sequelize Model Trail is as easy as:\n\n```javascript\nconst ModelTrail = require('sequelize-model-trail').init(sequelize);\nModelTrail.enableAndLoadModelTrail();\n```\n\nwhich loads the Model Trail library, and the `enableAndLoadModelTrail()` method sets up a `revisions` table and Model.\n\n*Note: You need to Pass userId as options if you want to enable user tracking*\n\n## User Tracking\n\nCurrently, there is only one step to enable user tracking, ie, recording the user who created a particular revision.\n\n```javascript\nModel.update({\n  /* ... */\n}, {\n  userId: user.id\n}).then(() {\n  /* ... */\n});\n```\n\n## How data is stored\n\n+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+\n| id | model | document                             | operation | documentId | createdAt           | updatedAt           | userId |\n+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+\n|  1 | users | {\"id\": [1, null], \"name\": [\"Salman\", null]} | create | 1      | 2022-08-22 01:17:34 | 2022-08-22 01:17:34 | NULL   |\n+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+\n+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+\n|  2 | users | {\"name\": [\"Salman Zafar\", \"Salman\"]} | update    |          1 | 2022-08-22 01:20:10  | 2022-08-22 01:20:10 |   1   |\n+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+\n+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+\n|  3 | users | {}                                   | destroy   |          1 | 2022-08-22 01:21:30 | 2022-08-22 01:21:30 |    1   |\n+----+-------+--------------------------------------+-----------+------------+---------------------+---------------------+--------+\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Added some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## Author\n\n© [Salman Zafar](https://github.com/salmanzafar949) – [@salmanzafar949](https://twitter.com/salmanzafar949)\n\nDistributed under the MIT license. See ``LICENSE`` for more information.\n[https://github.com/salmanzafar949/sequelize-model-trail](https://github.com/salmanzafar949/)\n\nContributors:\n[https://github.com/salmanzafar949/sequelize-paper-trail/graphs/contributors](https://github.com/nielsgl/sequelize-model-trail/graphs/contributors)\n\n## example\n* [Example application](https://github.com/salmanzafar949/sequelize-model-trail-example)\n\n## Upcoming features\n\n- Specify Models for Model Trails \n- UUID\n- CUSTOM MODEL/TABLE NAME\n- CUSTOM OPTIONS\n\n## Support\n*If this project help you reduce time to develop, you can give me a cup of coffee :)*\n\nPlease use:\n* GitHub's [issue tracker](https://github.com/salmanzafar949/sequelize-model-trail/issues)\n\n* [Buy me a coffee](https://paypal.me/salmanzafar949)\n\n## Thanks\nThis project was inspired by:\n* [sequelize-paper-trail](https://github.com/nielsgl/sequelize-paper-trail)\n\n## Happy Coding.!\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalmanzafar949%2Fsequelize-model-trail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsalmanzafar949%2Fsequelize-model-trail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalmanzafar949%2Fsequelize-model-trail/lists"}