@vulkano/core 1.20.2 → 1.22.1

package/examples/models/Example.js

@@ -53,6 +53,7 @@ module.exports = {
     const defaultProps = {
       sort: 'createdAt|DESC',
       searchBy: ['name'],
+      fields: ['name', 'age', 'active', 'createdAt', 'updatedAt'],
       filter: {
         active: true
       },
@@ -145,16 +146,45 @@ module.exports = {
 
   },
 
+  /**
+   * Before validate callback — runs before beforeSave, as part of obj.save()
+   * (create() above). Does NOT run for update()/delete(): Mongoose's update
+   * validators (runValidators) validate each changed path directly and never
+   * go through this callback, even when a validator rejects the value.
+   * @param {Callback} cb
+   */
+  beforeValidate(cb) {
+
+    console.log('Running callback before validate');
+
+    // All good!
+    cb();
+
+  },
+
+  /**
+   * Callback after validate
+   * @param {Callback} cb
+   */
+  afterValidate(cb) {
+
+    console.log('Running callback after validate');
+
+    // All good!
+    cb();
+
+  },
+
   /**
    * Before save callback
    * @param {Callback} cb
    */
   beforeSave(cb) {
 
-    const data = this;
+    const doc = this;
 
     console.log('Running callback before save');
-    console.log(data);
+    console.log(doc);
 
     // All good!
     cb();
@@ -165,10 +195,40 @@ module.exports = {
    * Callback after save
    * @param {Callback} cb
    */
-  afterSave(data, cb) {
+  afterSave(doc, cb) {
 
     console.log('Running callback after save');
-    console.log(data);
+    console.log(doc);
+
+    // All good!
+    cb();
+
+  },
+
+  /**
+   * Before findOneAndUpdate callback — runs on update() and delete() above,
+   * since both call Example.findOneAndUpdate() directly. `this` is the Query,
+   * not the document.
+   * @param {Callback} cb
+   */
+  beforeFindOneAndUpdate(cb) {
+
+    console.log('Running callback before findOneAndUpdate');
+
+    // All good!
+    cb();
+
+  },
+
+  /**
+   * Callback after findOneAndUpdate
+   * @param {Object} doc Updated document
+   * @param {Callback} cb
+   */
+  afterFindOneAndUpdate(doc, cb) {
+
+    console.log('Running callback after findOneAndUpdate');
+    console.log(doc);
 
     // All good!
     cb();

package/examples/routes.js

@@ -0,0 +1,55 @@
+/* global app */
+
+/**
+ * Alias Route Mappings
+ *
+ * Your routes map URLs to views and controllers.
+ *
+ * Notes: Vulkano automatically matches the URL to a controller
+ * and HTTP method (get, post, put, delete) ;)
+ *
+ * Example:
+ * - GET /users/ -> File: UsersController, Method: 'get': (req, res) => {}
+ * - GET /users/123 -> File: UsersController, Method: 'get :id': (req, res) => {}
+ * - POST /users/ -> File: UsersController, Method: 'post': (req, res) => {}
+ * - PUT /users/123 -> File: UsersController, Method: 'put :id': (req, res) => {}
+ * - DELETE /users/123 -> File: UsersController, Method: 'delete :id': (req, res) => {}
+ *
+ * With nested folders, the same rules apply:
+ * - GET /api/users/123 -> Folder: api -> File: UsersController, Method: 'get :id': (req, res) => {}
+ *
+ * But you can write your own routes manually :P
+ *
+ */
+
+module.exports = {
+
+  // Routes as string - Simple and easy to use
+  '/about-me': 'AboutController.get',
+
+  // Catch-all for React/Vue Router (SPA)
+  '/admin*': 'AdminController.get',
+
+  // Routes as definition - Most flexible
+  '/test': (req, res) => {
+    res.json({ message: 'Hello, world!' });
+  },
+
+  // Routes as method - More Advanced
+  custom() {
+
+    app.vulkano.get('/test', (req, res) => {
+      res.json({ hello: 'world' });
+    });
+
+    app.vulkano.get('/test2', (req, res) => {
+      res.json({ hello: 'world2' });
+    });
+
+    app.vulkano.get('/test3', (req, res) => {
+      res.json({ hello: 'world3' });
+    });
+
+  }
+
+};

package/examples/services/Auth.js

@@ -0,0 +1,111 @@
+/* global User, Auth, VSError */
+
+const bcrypt = require('bcryptjs');
+
+module.exports = {
+
+  SESSION_MS: 1000 * 60 * 60 * 24 * 365 * 10,
+
+  /**
+   * Verify a plain-text password against a stored hash.
+   * @param {String} plain
+   * @param {String} hash
+   * @returns {Boolean}
+   */
+  verifyPassword(plain, hash) {
+    return bcrypt.compareSync(`${process.env.SALT_KEY || ''}-${plain}`, hash);
+  },
+
+  /**
+   * Look up a user by email and verify their password. The only place in
+   * the model that explicitly loads the password hash.
+   * @param {String} email
+   * @param {String} password
+   * @returns {Promise<Object>} the authenticated User document
+   */
+  login({ email, password }) {
+
+    const normalizedEmail = String(email || '')
+      .toLowerCase()
+      .trim();
+
+    return User.findOne({ email: normalizedEmail, active: true })
+      .select('+password')
+      .then((user) => {
+
+        if (!user || !Auth.verifyPassword(password || '', user.password)) {
+          return VSError.reject('Invalid credentials', 401);
+        }
+
+        return Auth.setToken(user);
+      });
+
+  },
+
+  /**
+   *  Generate token
+   * @param {Object} props
+   * @returns {Object}
+   */
+  setToken(u) {
+
+    const {
+      _id
+    } = u || {};
+
+    if (!_id) {
+      return VSError.reject('The user and/or password are incorrect', 400);
+    }
+
+    return Promise.resolve({
+
+      user: {
+        _id: u._id || '',
+        name: u.name || ''
+      },
+
+      token: Jwt.encode({
+        _id: u._id || '',
+        name: u.name || '',
+        email: u.email,
+        role: u.role || '',
+        expiration: Auth.SESSION_MS + Date.now()
+      })
+
+    });
+  },
+
+  /**
+   * Get current user logged
+   *
+   * @param {Object} auth
+   * @returns Promise
+   */
+  getCurrent(auth) {
+
+    const {
+      _id
+    } = auth || {};
+
+    if (!_id) {
+      return VSError.reject('Invalid token', 401);
+    }
+
+    return User
+      .getUser(_id)
+      .then( (u) => {
+
+        const {
+          active
+        } = u || {};
+
+        if (String(active || '') !== 'true' || !_id) {
+          return VSError.reject('Invalid ID. User not found', 401);
+        }
+
+        return u;
+
+      });
+
+  }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vulkano/core",
-  "version": "1.20.2",
+  "version": "1.22.1",
   "description": "A MVC framework using Express 4",
   "license": "MIT",
   "author": "Vulkano Team",
@@ -44,6 +44,7 @@
   "dependencies": {
     "@socket.io/mongo-adapter": "^0.4.0",
     "@socket.io/redis-adapter": "^8.3.0",
+    "bcryptjs": "^3.0.3",
     "compression": "^1.8.1",
     "connect-timeout": "^1.9.1",
     "cookie-parser": "^1.4.7",
@@ -69,4 +70,4 @@
     "socket.io-adapter": "^2.5.8",
     "undici": "^7.28.0"
   }
-}
+}