- Breaking change: Stop supporting older behavior against layers of a…

…rity one or two

    (will now drop one with no `done`)
- Breaking change: We now catch errors within layers so as to support more
    intuitive passing of errors (when synchronous)
- Breaking change: No longer throws when login is missing a callback (as may use as Promise)
- Breaking change: Only return from `serializeUser`, `deserializeUser` (and `transformAuthInfo`)
    when giving a synchronous serialized result or a Promise (do not do `return done()`)
- Enhancement: Promises for `serializeUser`, `deserializeUser`, `transformAuthInfo`
    (including allowing throwing `new Error('pass')` to pass); avoid need for `done`
- Enhancement: Allow `serializeUser` or `deserializeUser` to return non-`undefined`
    value for sync behavior
- Refactoring: Return Promise from `req.logIn` and from authenticate middleware's
    `strategy.success`
- Makefile: Add missing `clean-cov`
- Testing: Add tests with `req.logIn` and `SessionStrategy` returning without `done`
    (synchronously or with Promise)
- Docs: Show example of a `LocalStrategy` using async/await
- Docs: Avoid showing connect `cookieParser` with `session`;
    use current `expressSession` over `connect.session`
- Linting: jsdoc
- npm/Docs: Add jsdoc with script, along with static server and open-cli to open
- npm: Update devDeps
- npm: Add `test-one` script

.eslintignore

@@ -2,3 +2,4 @@
 coverage/
 node_modules/
 var/
+docs/jsdoc

.eslintrc.js

@@ -8,6 +8,14 @@ module.exports = {
       // Override ash-nazg's current preference for ESM
       'plugin:node/recommended-script'
     ],
+    settings: {
+      polyfills: [
+        // Needing these for some reason to avoid an error
+        "Promise",
+        "Promise.reject",
+        "Promise.resolve"
+      ]
+    },
     overrides: [
       {
         files: ['test/**'],
@@ -61,9 +69,8 @@ module.exports = {
       'no-underscore-dangle': 0,
       'no-param-reassign': 0,
 
-      // Disable until implementing promises and Node version supporting
+      // Disable as middleware approach requires some callbacks
       'promise/prefer-await-to-callbacks': 0,
-      'promise/prefer-await-to-then': 0,
 
       // Disable until ready to tackle
       'require-jsdoc': 0,

.gitignore

@@ -1,4 +1,4 @@
-docs/
+docs/jsdoc
 reports/
 var/
 

Makefile

@@ -8,13 +8,17 @@ LCOVFILE = ./reports/coverage/lcov.info
 
 MOCHAFLAGS = --require ./test/bootstrap/node
 
+COVDIR = ./var/cov/*
 
 view-docs:
 	open ./docs/index.html
 
 view-cov:
 	open ./var/cov/index.html
 
+clean-cov:
+	-rm -r $(COVDIR)
+
 clean: clean-docs clean-cov
 	-rm -r $(REPORTSDIR)
 

README.md

@@ -62,13 +62,15 @@ application must be configured.
 
 ```javascript
 passport.use(new LocalStrategy(
-  function (username, password, done) {
-    User.findOne({ username }, function (err, user) {
-      if (err) { return done(err); }
-      if (!user) { return done(null, false); }
-      if (!user.verifyPassword(password)) { return done(null, false); }
-      return done(null, user);
-    });
+  async function (username, password) {
+    let user;
+    try {
+      user = await User.findOne({ username });
+    } catch (err) {
+      throw err;
+    }
+    if (!user || !user.verifyPassword(password)) { return false; }
+    return user;
   }
 ));
 ```
@@ -88,14 +90,13 @@ as simple as serializing the user ID, and finding the user by ID when
 deserializing.
 
 ```javascript
-passport.serializeUser(function (user, done) {
-  done(null, user.id);
+passport.serializeUser(function (user) {
+  return user.id;
 });
 
-passport.deserializeUser(function (id, done) {
-  User.findById(id, function (err, user) {
-    done(err, user);
-  });
+passport.deserializeUser(async function (id) {
+  const user = await User.findById(id);
+  return user;
 });
 ```
 
@@ -110,7 +111,6 @@ middleware must also be used.
 ```javascript
 const app = express();
 app.use(require('serve-static')(path.join(__dirname, '/../../public')));
-app.use(require('cookie-parser')());
 app.use(require('body-parser').urlencoded({ extended: true }));
 app.use(require('express-session')({ secret: 'keyboard cat', resave: true, saveUninitialized: true }));
 app.use(passport.initialize());

docs/jsdoc-config.js

@@ -0,0 +1,32 @@
+'use strict';
+
+module.exports = {
+  recurseDepth: 10,
+  source: {
+    exclude: [
+      'node_modules',
+      'dist',
+      'var',
+      'coverage',
+      'test'
+    ],
+    // excludePattern: ''
+  },
+  sourceType: 'module',
+  tags: {
+    allowUnknownTags: false
+  },
+  templates: {
+    cleverLinks: true,
+    monospaceLinks: false /* ,
+    default: {
+      layoutFile: 'docs/layout.tmpl'
+    } */
+  },
+  opts: {
+    recurse: true,
+    verbose: true,
+    destination: 'docs/jsdoc',
+    // tutorials: 'docs/tutorials'
+  }
+};