mongoose-event-logs

Plugin for Mongoose which create activitylogs collection and craete automatically mongo documents for activity logs. Automate log creation by utilizing plugins for common libraries such as Mongoose (CRUD logging via model plugin).

Installation

npm install mongoose-event-logs --save

Usage

1var mongooseLogs = require('mongoose-event-logs');
2      AppSchema = new mongoose.Schema({
3         app_id:
4         type: String
5       });
6       AppSchema.plugin(mongooseLog, {
7       schemaName: "app",
8       createAction: "created",
9       updateAction: "updated",
10       deleteAction: "deleted" 
11    });
12     mongoose.model('App', app);

Your payload should have modifiedBy property which contains the refrence id of current user.

 payload.modifiedBy = req.user;
 
 
 

And here's some code example! :+1:

1var express = require('express');
2var app = express();
3var mongoose = require('mongoose');
4var Schema = mongoose.Schema;
5var mongooseLogs = require('mongoose-event-logs');
6
7var BlogPost = new Schema({
8    author    : ObjectId,
9    title     : String,
10    body      : String,
11    date      : Date
12});
13
14var user = new Schema({
15    firstName: String,
16    lastName: String,
17    password: String,
18    email: String  
19});
20
21BlogPost.plugin(mongooseLogs, {
22       schemaName: "blogpost",
23       createAction: "posted",
24       updateAction: "updated",
25       deleteAction: "removed" 
26    }
27/*  Your Payload */
28 req.body={
29    author    : ObjectId,
30    title     : "Post Title",
31    body      : "Post Body",
32    date      :  new Date
33    } 
34    
35app.post('/post', function (req, res) {
36
37/* 
38req.user = {
39firstName:"jhon",
40lastName: "Doe",
41password:"UserPassword",
42email:"UserEmail" 
43}
44*/
45 var poayload = req.body;
46 
47 /*
48 modifiedBy should be user Object that refer to the current authenticated user 
49 who is performing this action. 
50 */
51 
52 payload.modifiedBy = req.user;// or req.session.user;
53 var post = new BlogPost(payload);
54 post.save();
55 
56 /* After save a document will be inserted automatically in your activitylogs collection
57 your activitylog document would be like :
58
59 ::---:: On Create & Delete ::---::
60 
61 {
62  "_id": {
63    "$oid": ""
64  },
65  "collectionType": "",
66  "referenceDocument": {},
67  "action": "updated",
68  "createdAt": {
69    "$date": ""
70  },
71  "__v": 0
72} 
73
74 ::---:: On Update ::---::
75
76 {
77  "_id": {
78    "$oid": ""
79  },
80  "collectionType": "",
81  "referenceDocument": {
82    "old": {},
83    "new": {}
84  },
85  "action": "updated",
86  "createdAt": {
87    "$date": ""
88  },
89  "__v": 0
90}  
91 */
92  res.send('POST request to create a post');
93});

Query ActivityLogs

1var ActivityModel = require('mongoose-event-logs/activity-model');
2
3// find query 
4ActivityModel.find({},function(err,activities){
5
6console.log(activities);
7
8}

License

The MIT License (MIT)

Copyright (c) 2023 chirag_malakiya

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.