first commit

Author: mattiamalonni

.eslintrc

@@ -0,0 +1,11 @@
+{
+  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 10,
+    "sourceType": "module"
+  }
+}

.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.node-version
+node_modules

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "arrowParens": "avoid"
+}

README.md

@@ -1 +1,46 @@
-# sequelize-bcrypt
+# sequelize-bcrypt
+
+## Installation
+
+```bash
+npm i sequelize-bcrypt
+```
+
+## Setup
+
+```javascript
+const { Sequelize, DataTypes } = require('sequelize');
+const SequelizeBcrypt = require('sequelize-bcrypt');
+
+const database = new Sequelize({
+  ...sequelizeConnectionOptions,
+});
+
+const User = database.define('User', {
+  email: { type: DataTypes.STRING },
+  password: { type: DataTypes.STRING },
+});
+
+SequelizeBcrypt.useBcrypt(User, options);
+```
+
+## Options
+
+```javascript
+{
+  field: 'password', // secret field to hash, default: 'password'
+  rounds: 12, // used to generate bcrypt salt, default: 12
+  compare: 'authenticate', // method used to compare secrets, default: 'authenticate'
+}
+```
+
+## Usage
+
+```javascript
+User.create({ email: '[email protected]', password: 'SuperSecret!' });
+// { id: 1, email: '[email protected]', password: '$2a$12$VtyL7j5xx6t/GmmAqy53ZuKJ1nwPox5kHLXDaottN9tIQBsEB3EsW' }
+
+const user = await User.findOne({ where: { email: '[email protected]' } });
+user.authenticate('WrongPassword!'); // false
+user.authenticate('SuperSecret!'); // true
+```

index.js

@@ -0,0 +1,42 @@
+const { ValidationError } = require('sequelize');
+const bcrypt = require('bcryptjs');
+
+const DEFAULT_OPTIONS = {
+  field: 'password',
+  rounds: 12,
+  compare: 'authenticate',
+};
+
+class SequelizeBcrypt {
+  static useBcrypt(Model, options = DEFAULT_OPTIONS) {
+    const opts = { ...DEFAULT_OPTIONS, ...options };
+
+    const hashField = function (instance) {
+      try {
+        const changedKey = Array.from(instance._changed).find(key => key === opts.field);
+        if (!changedKey) return;
+
+        const fieldDefinition = instance.rawAttributes[changedKey];
+        if (!fieldDefinition) return;
+
+        const plainValue = instance[changedKey];
+        if (!plainValue) return;
+
+        const salt = bcrypt.genSaltSync(opts.rounds);
+        const hashedValue = bcrypt.hashSync(plainValue, salt);
+        instance[changedKey] = hashedValue;
+      } catch (err) {
+        throw new ValidationError(err.message);
+      }
+    };
+
+    Model.prototype[opts.compare] = function (plainValue) {
+      return bcrypt.compareSync(plainValue, this._previousDataValues[opts.field]);
+    };
+
+    Model.addHook('beforeCreate', hashField);
+    Model.addHook('beforeUpdate', hashField);
+  }
+}
+
+module.exports = SequelizeBcrypt;