aloux-iam 0.0.102 → 0.0.104

package/index.js

@@ -1,6 +1,7 @@
 const IAMrouter = require("./lib/router");
 const IAMauth = require("./lib/middleware");
 const awsAloux = require("./lib/controllers/operationsAWS");
+const historyAloux = require("./lib/controllers/history");
 const awsBQ = require("./lib/services/bigQuery");
 const YAML = require("yamljs");
 const path = require("path");
@@ -33,4 +34,5 @@ module.exports = {
 
   AlouxAWS: awsAloux,
   AlouxBQ: awsBQ,
+  AlouxHistory: historyAloux,
 };

package/lib/controllers/history.js

@@ -0,0 +1,71 @@
+const History = require("../models/History");
+const self = module.exports;
+
+self.create = async (data) => {
+  try {
+    const history = new History({
+      method: data.originalMethod,
+      path: data.route.path,
+      payload: data.body,
+      createdAt: Date.now(),
+    });
+    const newHistory = await history.save();
+    return newHistory;
+  } catch (error) {
+    return error;
+  }
+};
+
+self.response = async (_history, response, _createdBy) => {
+  try {
+    if (_createdBy) {
+      await History.updateOne(
+        { _id: _history },
+        { response: response, _createdBy: _createdBy }
+      );
+    } else {
+      await History.updateOne({ _id: _history }, { response: response });
+    }
+    return true;
+  } catch (error) {
+    return error;
+  }
+};
+
+self.retrieve = async (req, res) => {
+  try {
+    const query = {};
+    const response = { items: [], count: 0 };
+
+    if (req.body?.filter?.method) {
+      query = { method: req.body.filter.method };
+    }
+
+    response.count = await History.countDocuments(query);
+    response.items = await History.find(query)
+      .populate({ path: "_createdBy", select: { name: 1, lastName: 1 } })
+      .sort({ createdAt: -1 })
+      .skip((req.body.config.page - 1) * req.body.config.itemsPerPage)
+      .limit(req.body.config.itemsPerPage)
+      .lean();
+
+    res.status(200).send(response);
+  } catch (error) {
+    res.status(400).send(error);
+  }
+};
+
+self.detail = async (req, res) => {
+  try {
+    const history = await History.findOne({ _id: req.params.HISTORY_ID });
+    if (!history) {
+      return res.status(404).send({
+        error: "No se encontró el elemento",
+        suggestion: "Verifica que el id del registro sea correcto",
+      });
+    }
+    res.status(200).send(history);
+  } catch (error) {
+    res.status(400).send(error);
+  }
+};

package/lib/middleware.js

@@ -1,6 +1,7 @@
 const jwt = require("jsonwebtoken");
 const User = require("./models/User");
 const Permission = require("./models/Permission");
+const historyController = require("./controllers/history");
 
 const getAccess = (user, resource) => {
   for (let i in user._functions) {
@@ -21,14 +22,10 @@ const getAccess = (user, resource) => {
 
 const auth = async (req, res, next) => {
   try {
-    if (process.env.LOG === "true") {
-      console.log(
-        new Date().toISOString() +
-          "\t" +
-          req.originalMethod +
-          "\t" +
-          req.route.path
-      );
+    let newHistory;
+    if (process.env.HISTORY === "true") {
+      //Guardar registro en la colección del Historial
+      newHistory = await historyController.create(req);
     }
 
     let token =
@@ -126,6 +123,7 @@ const auth = async (req, res, next) => {
 
     req.user = user;
     req.token = token;
+    req.history = newHistory._id.toString();
     next();
   } catch (error) {
     let obj = error;

package/lib/models/History.js

@@ -0,0 +1,14 @@
+const mongoose = require("mongoose");
+const ObjectId = mongoose.Schema.Types.ObjectId;
+
+const historySchema = mongoose.Schema({
+  method: { type: String, default: false },
+  path: { type: String, default: true },
+  payload: { type: Object, default: {} }, // Guarda cualquier estructura JSON
+  response: { type: Object, default: {} }, // Guarda cualquier estructura JSON
+  _createdBy: { type: ObjectId, required: false, ref: "User" },
+  createdAt: { type: Number, required: true },
+});
+
+const History = mongoose.model("History", historySchema);
+module.exports = History;

package/lib/router.js

@@ -7,6 +7,7 @@ const user           = require('./controllers/user')
 const menu           = require('./controllers/menu')
 const permission     = require('./controllers/permission')
 const functions      = require('./controllers/functions')
+const history        = require('./controllers/history.js')
 
 // User / user self (no auth)
 router.post('/iam/auth/email',                     auth.email)
@@ -39,9 +40,8 @@ router.put('/iam/user/password/:USER_ID',           middleware, user.updatepassw
 router.delete('/iam/user/:USER_ID',                 middleware, user.delete)
 router.get('/iam/user/count/all',                   middleware, user.count)
 
-
 // IAM / Function
-router.post('/iam/functions',                       middleware, functions.create)     
+router.post('/iam/functions',                       middleware, functions.create)
 router.patch('/iam/functions/:FUNCTION_ID',         middleware, functions.update)
 router.put('/iam/functions/:FUNCTION_ID/status',    middleware, functions.status)
 router.get('/iam/functions',                        middleware, functions.retrieve)
@@ -49,9 +49,8 @@ router.get('/iam/functions/:FUNCTION_ID',           middleware, functions.get)
 router.delete('/iam/functions/:FUNCTION_ID',        middleware, functions.delete)
 router.get('/iam/functions/count/all',              middleware, functions.count)
 
-
 // IAM / Permission
-router.post('/iam/permission',                      middleware, permission.create)     
+router.post('/iam/permission',                      middleware, permission.create)
 router.patch('/iam/permission/:PERMISSION_ID',      middleware, permission.update)
 router.put('/iam/permission/:PERMISSION_ID/status', middleware, permission.status)
 router.get('/iam/permission',                       middleware, permission.retrieve)
@@ -59,9 +58,8 @@ router.get('/iam/permission/:PERMISSION_ID',        middleware, permission.get)
 router.delete('/iam/permission/:PERMISSION_ID',     middleware, permission.delete)
 router.get('/iam/permission/count/all',             middleware, permission.count)
 
-
 // IAM / Menu
-router.post('/iam/menu',                            middleware, menu.create)     
+router.post('/iam/menu',                            middleware, menu.create)
 router.patch('/iam/menu/:MENU_ID',                  middleware, menu.update)
 router.put('/iam/menu/:MENU_ID/status',             middleware, menu.status)
 router.get('/iam/menu',                             middleware, menu.retrieve)
@@ -70,7 +68,12 @@ router.delete('/iam/menu/:MENU_ID',                 middleware, menu.delete)
 router.post('/iam/menu/order',                      middleware, menu.order)
 router.get('/iam/menu/count/all',                   middleware, menu.count)
 
+
+// IAM / History
+router.post('/iam/history',                         middleware, history.retrieve)
+router.get('/iam/history/:HISTORY_ID',              middleware, history.detail)
+
 // Utilities
-router.patch('/iam/add/time/:TOKEN',                    user.addTimeToken)
+router.patch('/iam/add/time/:TOKEN',                user.addTimeToken)
 
 module.exports = router

package/lib/swagger.yaml

@@ -1178,4 +1178,52 @@ paths:
                             example: 54
       responses:
         '200':    # status code
-          description: Retorna el resultado de la respuesta
+          description: Retorna el resultado de la respuesta
+  /iam/history:
+    post:
+      summary: Obtener todo el historial paginado
+      tags:
+        - History
+      description: Ordena los elementos de menú
+      security:
+        - bearerAuth: []
+      requestBody:
+        content:
+          'application/json':
+            schema:
+              properties:
+                filter:
+                  type: object
+                  properties:
+                    method:
+                      enum: [ GET, POST, PUT, PATCH, DELETE]
+                config:
+                  type: object
+                  properties:
+                    page:
+                      type: number
+                      example: 1
+                    itemsPerPage:
+                      type: number
+                      example: 10
+      responses:
+        '200':    # status code
+          description: Retorna el resultado de la respuesta
+  /iam/history/{HISTORY_ID}:
+    get:
+      parameters:
+      - name: HISTORY_ID
+        in: path
+        description: ID de un registro de historial
+        required: true
+        schema:
+          type: string
+          format: ObjectId
+      tags:
+        - History
+      description: Detalle de u registro de historial
+      security:
+        - bearerAuth: []
+      responses:
+        '200':    # status code
+          description: Retorna un objeto

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aloux-iam",
-  "version": "0.0.102",
+  "version": "0.0.104",
   "description": "Aloux IAM for APIs ",
   "main": "index.js",
   "scripts": {