@feathersjs/authentication 5.0.0-pre.1 → 5.0.0-pre.15

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@feathersjs/authentication",
   "description": "Add Authentication to your FeathersJS app.",
-  "version": "5.0.0-pre.1",
+  "version": "5.0.0-pre.15",
   "homepage": "https://feathersjs.com",
   "main": "lib/",
   "types": "lib/",
@@ -37,7 +37,7 @@
     "url": "https://github.com/feathersjs/feathers/issues"
   },
   "engines": {
-    "node": ">= 10"
+    "node": ">= 12"
   },
   "scripts": {
     "prepublish": "npm run compile",
@@ -52,27 +52,26 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathersjs/errors": "^5.0.0-pre.1",
-    "@feathersjs/feathers": "^5.0.0-pre.1",
-    "@feathersjs/transport-commons": "^5.0.0-pre.1",
-    "@types/jsonwebtoken": "^8.5.0",
-    "debug": "^4.3.1",
+    "@feathersjs/commons": "^5.0.0-pre.15",
+    "@feathersjs/errors": "^5.0.0-pre.15",
+    "@feathersjs/feathers": "^5.0.0-pre.15",
+    "@feathersjs/transport-commons": "^5.0.0-pre.15",
+    "@types/jsonwebtoken": "^8.5.5",
     "jsonwebtoken": "^8.5.1",
-    "lodash": "^4.17.20",
+    "lodash": "^4.17.21",
     "long-timeout": "^0.1.1",
-    "uuid": "^8.3.1"
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@feathersjs/adapter-memory": "^5.0.0-pre.1",
-    "@types/debug": "^4.1.5",
-    "@types/lodash": "^4.14.165",
-    "@types/mocha": "^8.0.4",
-    "@types/node": "^14.14.10",
-    "@types/uuid": "^8.3.0",
-    "mocha": "^8.2.1",
+    "@feathersjs/memory": "^5.0.0-pre.15",
+    "@types/lodash": "^4.14.176",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.11.6",
+    "@types/uuid": "^8.3.1",
+    "mocha": "^9.1.3",
     "shx": "^0.3.3",
-    "ts-node": "^9.1.0",
-    "typescript": "^4.1.2"
+    "ts-node": "^10.4.0",
+    "typescript": "^4.4.4"
   },
-  "gitHead": "3756506935c520fc50d4be416ff649c2158afdac"
+  "gitHead": "8008bf4f8529a2a40b6a2f976c1f43ae13675693"
 }

package/src/core.ts

@@ -2,12 +2,12 @@ import merge from 'lodash/merge';
 import jsonwebtoken, { SignOptions, Secret, VerifyOptions } from 'jsonwebtoken';
 import { v4 as uuidv4 } from 'uuid';
 import { NotAuthenticated } from '@feathersjs/errors';
-import Debug from 'debug';
+import { createDebug } from '@feathersjs/commons';
 import { Application, Params } from '@feathersjs/feathers';
 import { IncomingMessage, ServerResponse } from 'http';
 import defaultOptions from './options';
 
-const debug = Debug('@feathersjs/authentication/base');
+const debug = createDebug('@feathersjs/authentication/base');
 
 export interface AuthenticationResult {
   [key: string]: any;
@@ -155,6 +155,16 @@ export class AuthenticationBase {
       .filter(current => !!current);
   }
 
+  /**
+   * Returns a single strategy by name
+   * 
+   * @param name The strategy name
+   * @returns The authentication strategy or undefined
+   */
+  getStrategy (name: string) {
+    return this.strategies[name];
+  }
+
   /**
    * Create a new access token with payload and options.
    *
@@ -200,7 +210,7 @@ export class AuthenticationBase {
       const verified = jsonwebtoken.verify(accessToken, jwtSecret, options);
 
       return verified as any;
-    } catch (error) {
+    } catch (error: any) {
       throw new NotAuthenticated(error.message, error);
     }
   }

package/src/hooks/authenticate.ts

@@ -1,10 +1,10 @@
 import flatten from 'lodash/flatten';
 import omit from 'lodash/omit';
-import { HookContext } from '@feathersjs/feathers';
+import { HookContext, NextFunction } from '@feathersjs/feathers';
 import { NotAuthenticated } from '@feathersjs/errors';
-import Debug from 'debug';
+import { createDebug } from '@feathersjs/commons';
 
-const debug = Debug('@feathersjs/authentication/hooks/authenticate');
+const debug = createDebug('@feathersjs/authentication/hooks/authenticate');
 
 export interface AuthenticateHookSettings {
   service?: string;
@@ -20,7 +20,8 @@ export default (originalSettings: string | AuthenticateHookSettings, ...original
     throw new Error('The authenticate hook needs at least one allowed strategy');
   }
 
-  return async (context: HookContext) => {
+  return async (context: HookContext, _next?: NextFunction) => {
+    const next = typeof _next === 'function' ? _next : async () => context;
     const { app, params, type, path, service } = context;
     const { strategies } = settings;
     const { provider, authentication } = params;
@@ -42,7 +43,7 @@ export default (originalSettings: string | AuthenticateHookSettings, ...original
     }
 
     if (params.authenticated === true) {
-      return context;
+      return next();
     }
 
     if (authentication) {
@@ -53,12 +54,10 @@ export default (originalSettings: string | AuthenticateHookSettings, ...original
       const authResult = await authService.authenticate(authentication, authParams, ...strategies);
 
       context.params = Object.assign({}, params, omit(authResult, 'accessToken'), { authenticated: true });
-
-      return context;
     } else if (provider) {
       throw new NotAuthenticated('Not authenticated');
     }
 
-    return context;
+    return next();
   };
 };

package/src/hooks/connection.ts

@@ -1,19 +1,17 @@
-import { HookContext } from '@feathersjs/feathers';
+import { HookContext, NextFunction } from '@feathersjs/feathers';
 import omit from 'lodash/omit';
 import { AuthenticationBase, ConnectionEvent } from '../core';
 
-export default (event: ConnectionEvent) => async (context: HookContext) => {
-  const { result, params: { connection } } = context;
-
-  if (!connection) {
-    return context;
-  }
+export default (event: ConnectionEvent) => async (context: HookContext, next: NextFunction) => {
+  await next();
 
-  const service = context.service as unknown as AuthenticationBase;
+  const { result, params: { connection } } = context;
 
-  Object.assign(connection, omit(result, 'accessToken', 'authentication'));
+  if (connection) {
+    const service = context.service as unknown as AuthenticationBase;
 
-  await service.handleConnection(event, connection, result);
+    Object.assign(connection, omit(result, 'accessToken', 'authentication'));
 
-  return context;
+    await service.handleConnection(event, connection, result);
+  }
 };

package/src/hooks/event.ts

@@ -1,16 +1,16 @@
-import Debug from 'debug';
-import { HookContext } from '@feathersjs/feathers';
+import { HookContext, NextFunction } from '@feathersjs/feathers';
+import { createDebug } from '@feathersjs/commons';
 import { ConnectionEvent } from '../core';
 
-const debug = Debug('@feathersjs/authentication/hooks/connection');
+const debug = createDebug('@feathersjs/authentication/hooks/connection');
+
+export default (event: ConnectionEvent) => async (context: HookContext, next: NextFunction) => {
+  await next();
 
-export default (event: ConnectionEvent) => async (context: HookContext) => {
   const { app, result, params } = context;
 
   if (params.provider && result) {
     debug(`Sending authentication event '${event}'`);
     app.emit(event, result, params, context);
   }
-
-  return context;
 };

package/src/index.ts

@@ -1,9 +1,5 @@
-import * as hooks from './hooks';
-
-const { authenticate } = hooks;
-
-export { hooks };
-export { authenticate };
+export * as hooks from './hooks';
+export { authenticate } from './hooks';
 export {
   AuthenticationBase,
   AuthenticationRequest,

package/src/jwt.ts

@@ -1,16 +1,16 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import Debug from 'debug';
 import omit from 'lodash/omit';
 import { IncomingMessage } from 'http';
 import { NotAuthenticated } from '@feathersjs/errors';
 import { Params } from '@feathersjs/feathers';
+import { createDebug } from '@feathersjs/commons';
 // @ts-ignore
 import lt from 'long-timeout';
 
 import { AuthenticationBaseStrategy } from './strategy';
 import { AuthenticationRequest, AuthenticationResult, ConnectionEvent } from './core';
 
-const debug = Debug('@feathersjs/authentication/jwt');
+const debug = createDebug('@feathersjs/authentication/jwt');
 const SPLIT_HEADER = /(\S+)\s+(\S+)/;
 
 export class JWTStrategy extends AuthenticationBaseStrategy {
@@ -147,7 +147,10 @@ export class JWTStrategy extends AuthenticationBaseStrategy {
     };
   }
 
-  async parse (req: IncomingMessage) {
+  async parse (req: IncomingMessage): Promise<{
+    strategy: string;
+    accessToken: string;
+  } | null> {
     const { header, schemes }: { header: string, schemes: string[] } = this.configuration;
     const headerValue = req.headers && req.headers[header.toLowerCase()];
 

package/src/service.ts

@@ -1,24 +1,23 @@
-import Debug from 'debug';
 import merge from 'lodash/merge';
 import { NotAuthenticated } from '@feathersjs/errors';
 import { AuthenticationBase, AuthenticationResult, AuthenticationRequest } from './core';
 import { connection, event } from './hooks';
 import '@feathersjs/transport-commons';
-import { Application, Params, ServiceMethods, ServiceAddons } from '@feathersjs/feathers';
+import { createDebug } from '@feathersjs/commons';
+import { Params, ServiceMethods, ServiceAddons } from '@feathersjs/feathers';
 import jsonwebtoken from 'jsonwebtoken';
 
-const debug = Debug('@feathersjs/authentication/service');
+const debug = createDebug('@feathersjs/authentication/service');
 
 declare module '@feathersjs/feathers/lib/declarations' {
-  interface Application<ServiceTypes = {}> { // eslint-disable-line
-
+  interface FeathersApplication<Services, Settings> { // eslint-disable-line
     /**
      * Returns the default authentication service or the
      * authentication service for a given path.
      *
      * @param location The service path to use (optional)
      */
-    defaultAuthentication (location?: string): AuthenticationService;
+    defaultAuthentication? (location?: string): AuthenticationService;
   }
 
   interface Params {
@@ -28,10 +27,10 @@ declare module '@feathersjs/feathers/lib/declarations' {
 }
 
 // eslint-disable-next-line
-export interface AuthenticationService extends ServiceAddons<AuthenticationResult> {}
+export interface AuthenticationService extends ServiceAddons<AuthenticationResult, AuthenticationResult> {}
 
 export class AuthenticationService extends AuthenticationBase implements Partial<ServiceMethods<AuthenticationResult>> {
-  constructor (app: Application, configKey = 'authentication', options = {}) {
+  constructor (app: any, configKey = 'authentication', options = {}) {
     super(app, configKey, options);
 
     if (typeof app.defaultAuthentication !== 'function') {
@@ -93,7 +92,7 @@ export class AuthenticationService extends AuthenticationBase implements Partial
    * @param data The authentication request (should include `strategy` key)
    * @param params Service call parameters
    */
-  async create (data: AuthenticationRequest, params: Params) {
+  async create (data: AuthenticationRequest, params?: Params) {
     const authStrategies = params.authStrategies || this.configuration.authStrategies;
 
     if (!authStrategies.length) {
@@ -132,7 +131,7 @@ export class AuthenticationService extends AuthenticationBase implements Partial
    * @param id The JWT to remove or null
    * @param params Service call parameters
    */
-  async remove (id: string | null, params: Params) {
+  async remove (id: string | null, params?: Params) {
     const { authentication } = params;
     const { authStrategies } = this.configuration;
 
@@ -149,7 +148,7 @@ export class AuthenticationService extends AuthenticationBase implements Partial
   /**
    * Validates the service configuration.
    */
-  setup () {
+  async setup () {
     // The setup method checks for valid settings and registers the
     // connection and event (login, logout) hooks
     const { secret, service, entity, entityId } = this.configuration;
@@ -172,11 +171,9 @@ export class AuthenticationService extends AuthenticationBase implements Partial
       }
     }
 
-    this.hooks({
-      after: {
-        create: [ connection('login'), event('login') ],
-        remove: [ connection('logout'), event('logout') ]
-      }
+    (this as any).hooks({
+      create: [ connection('login'), event('login') ],
+      remove: [ connection('logout'), event('logout') ]
     });
 
     this.app.on('disconnect', async (connection) => {

package/src/strategy.ts

@@ -22,7 +22,7 @@ export class AuthenticationBaseStrategy implements AuthenticationStrategy {
     return this.authentication.configuration[this.name];
   }
 
-  get entityService (): Service<any> {
+  get entityService (): Service {
     const { service } = this.configuration;
 
     if (!service) {