@hitchy/plugin-auth 0.5.0 → 0.5.1

package/api/model/authorization/rule.js

@@ -1,4 +1,4 @@
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 	const { services } = api;
 

package/api/model/role.js

@@ -1,4 +1,4 @@
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 	const { models } = api;
 
@@ -8,7 +8,7 @@ export default function() { // eslint-disable-line require-jsdoc
 	 * @property {string} name unique name of user
 	 *
 	 * @name Hitchy.Plugin.Auth.Role
-	 * @type Hitchy.Plugin.Odem.Model
+	 * @type {Hitchy.Plugin.Odem.Model}
 	 */
 	return {
 		props: {

package/api/model/user.js

@@ -1,6 +1,6 @@
 import Crypto from "node:crypto";
 
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 	const { services, models } = api;
 
@@ -55,7 +55,7 @@ export default function() { // eslint-disable-line require-jsdoc
 
 			async beforeSave( existsAlready, record ) {
 				if ( record.password ) {
-					record.password = await this.hashPassword( record.password ); // eslint-disable-line no-param-reassign
+					record.password = await this.hashPassword( record.password );
 				}
 
 				return record;

package/api/policy/authentication.js

@@ -1,4 +1,4 @@
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 	const { models, service } = api;
 
@@ -76,7 +76,7 @@ export default function() { // eslint-disable-line require-jsdoc
 
 			service.AuthManager.checkAuthentication( parts[1], parts[2] )
 				.then( user => {
-					req.user = user; // eslint-disable-line no-param-reassign
+					req.user = user;
 
 					this.qualifyAuthenticated( req, res, next );
 				} )
@@ -99,7 +99,7 @@ export default function() { // eslint-disable-line require-jsdoc
 
 			req.fetchBody()
 				.then( body => {
-					req.body = body; // eslint-disable-line no-param-reassign
+					req.body = body;
 
 					return new Promise( ( resolve, reject ) => {
 						AuthenticationPassport.authenticate( strategy || defaultStrategy )( req, res, err => {
@@ -146,7 +146,7 @@ export default function() { // eslint-disable-line require-jsdoc
 
 				service.AuthManager.listRolesOfUser( new models.User( uuid ) )
 					.then( roles => {
-						req.user.roles = roles; // eslint-disable-line no-param-reassign
+						req.user.roles = roles;
 
 						logDebug( "authenticated as", req.user.name );
 
@@ -199,7 +199,7 @@ export default function() { // eslint-disable-line require-jsdoc
 							await new Promise( ( resolve, reject ) => req.session.regenerate( error => ( error ? reject( error ) : resolve() ) ) );
 						}
 
-						req.user = undefined; // eslint-disable-line no-param-reassign
+						req.user = undefined;
 
 						res.set( "X-Authenticated-As", undefined );
 						res.set( "X-Authorized-As", undefined );

package/api/policy/user.js

@@ -1,4 +1,4 @@
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 	const { models } = api;
 

package/api/service/auth/manager.js

@@ -1,4 +1,4 @@
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 	const { models, services } = api;
 
@@ -61,7 +61,7 @@ export default function() { // eslint-disable-line require-jsdoc
 			const { Role } = models;
 
 			if ( !( role instanceof Role ) ) {
-				role = String( role ); // eslint-disable-line no-param-reassign
+				role = String( role );
 
 				if ( !/^[a-z_]/i.test( role ) || /\s/.test( role ) ) {
 					throw new TypeError( "missing role information" );

package/api/service/authentication/passport.js

@@ -1,6 +1,6 @@
 import PassportLib from "passport";
 
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 
 	const logAlert = api.log( "hitchy:auth:alert" );
@@ -26,7 +26,7 @@ export default function() { // eslint-disable-line require-jsdoc
 		} );
 
 		passport.deserializeUser( ( uuid, done ) => {
-			/** @type Hitchy.Plugin.Auth.User */
+			/** @type {Hitchy.Plugin.Auth.User} */
 			const user = new User( uuid );
 
 			user.$exists

package/api/service/authentication/strategies.js

@@ -13,7 +13,7 @@ import { Strategy as LocalStrategy } from "passport-local";
  */
 const RemoteAuthCustomData = new Map();
 
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 	const { models, services } = api;
 
@@ -60,7 +60,7 @@ export default function() { // eslint-disable-line require-jsdoc
 		 *
 		 * @param {string} username name of user to authenticate
 		 * @param {string} password named user's password for authentication
-		 * @param {function(Error?, object, object)} done invoked with optional error, authenticated user or some message as feedback
+		 * @param {function(Error?, object, object):void} done invoked with optional error, authenticated user or some message as feedback
 		 * @returns {void}
 		 */
 		static checkAuthentication( username, password, done ) {
@@ -222,10 +222,10 @@ export default function() { // eslint-disable-line require-jsdoc
 		 * supporting OpenID Connect with Authorization Code Flow.
 		 *
 		 * @param {string} strategyName name of resulting strategy in context of your application
-		 * @param {ClientMetaData} config OpenID Connect client configuration
+		 * @param {object} config OpenID Connect client configuration
 		 * @returns {Promise<Strategy>} promises generated strategy for use with passport.js
 		 */
-		static async generateOpenIdConnect( strategyName, config ) { // eslint-disable-line consistent-this
+		static async generateOpenIdConnect( strategyName, config ) {
 			const verifyLocalProfileOnLogin = ( req, tokens, userInfo, done ) => {
 				getLocalProfile( strategyName, userInfo.preferred_username, true, done );
 			};
@@ -246,7 +246,7 @@ export default function() { // eslint-disable-line require-jsdoc
 					return Promise.resolve( false );
 				}
 
-				const state = req.session[key] = generators.state( 32 ); // eslint-disable-line no-param-reassign
+				const state = req.session[key] = generators.state( 32 );
 
 				// redirect user to discovered end_session_url of IdP
 				req.context.response.redirect( 302, client.endSessionUrl( { state } ) );

package/api/service/authorization/node.js

@@ -1,13 +1,13 @@
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	/**
 	 * Implements behavior of a single node in a hierarchy of authorization
 	 * rules.
 	 *
 	 * @property {?AuthorizationNode} parent refers to superordinated node
 	 * @property {?string} name name of segment addressing this node in context of its parent
-	 * @property {{accept: object<string, number>, reject: object<string, number>}} roles maps names of roles into number of rules requesting to accept/reject
-	 * @property {{accept: object<string, number>, reject: object<string, number>}} users lists UUIDs of users to accept/reject in context of node
-	 * @property {object<string,AuthorizationNode>} children maps relative names into subordinated nodes
+	 * @property {{accept: Object<string, number>, reject: Object<string, number>}} roles maps names of roles into number of rules requesting to accept/reject
+	 * @property {{accept: Object<string, number>, reject: Object<string, number>}} users lists UUIDs of users to accept/reject in context of node
+	 * @property {Object<string,AuthorizationNode>} children maps relative names into subordinated nodes
 	 */
 	class AuthorizationNode {
 		/**

package/api/service/authorization/policy-generator.js

@@ -1,4 +1,4 @@
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 
 	const logError = api.log( "hitchy:plugin:auth:error" );

package/api/service/authorization/tree.js

@@ -1,4 +1,4 @@
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 	const { services, models } = api;
 

package/api/service/authorization.js

@@ -1,4 +1,4 @@
-export default function() { // eslint-disable-line require-jsdoc
+export default function() { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 	const { service } = api;
 

package/api/service/session.js

@@ -1,4 +1,4 @@
-export default function( options, HitchyPluginSession ) { // eslint-disable-line require-jsdoc
+export default function( options, HitchyPluginSession ) { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 
 	const logDebug = api.log( "hitchy:auth:debug" );
@@ -91,7 +91,7 @@ export default function( options, HitchyPluginSession ) { // eslint-disable-line
 		 *
 		 * This method is used by passport.
 		 *
-		 * @param {function(error: (Error|undefined)): void} doneFn callback invoked when session has been re-generated or some error occurred
+		 * @param {function((Error|undefined)): void} doneFn callback invoked when session has been re-generated or some error occurred
 		 * @returns {void}
 		 */
 		regenerate( doneFn ) {
@@ -132,7 +132,7 @@ export default function( options, HitchyPluginSession ) { // eslint-disable-line
 		 *
 		 * This method is used by passport.
 		 *
-		 * @param {function(error: (Error|undefined)): void} doneFn callback invoked when session has been saved or some error occurred
+		 * @param {function((Error|undefined)):void} doneFn callback invoked when session has been saved or some error occurred
 		 * @returns {void}
 		 */
 		save( doneFn ) {

package/hash-password.js

@@ -10,7 +10,7 @@ process.stdin.once( "end", () => {
 	UserModel.call( { services: {}, models: {} } )
 		.methods.hashPassword( input )
 		.then( password => {
-			console.log( password );
+			console.log( password ); // eslint-disable-line no-console
 		} )
 		.catch( console.error );
 } );

package/index.js

@@ -1,4 +1,4 @@
-export default function( options, plugins ) { // eslint-disable-line require-jsdoc
+export default function( options, plugins ) { // eslint-disable-line jsdoc/require-jsdoc
 	const api = this;
 
 	const logWarning = api.log( "hitchy:session:warning" );

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hitchy/plugin-auth",
-	"version": "0.5.0",
+	"version": "0.5.1",
 	"description": "user authentication and authorization for Hitchy",
 	"type": "module",
 	"main": "index.js",
@@ -33,12 +33,11 @@
 	},
 	"devDependencies": {
 		"@hitchy/core": "^1.0.1",
-		"@hitchy/server-dev-tools": "^0.8.4",
+		"@hitchy/server-dev-tools": "^0.8.5",
 		"@hitchy/types": "^0.1.3",
 		"c8": "^10.1.2",
-		"eslint": "^8.57.1",
-		"eslint-config-cepharum": "^1.0.14",
-		"eslint-plugin-promise": "^6.6.0",
+		"eslint": "^9.15.0",
+		"eslint-config-cepharum": "^2.0.2",
 		"mermaid": "^11.4.0",
 		"mocha": "^10.8.2",
 		"openid-client": "^5.7.0",