@feathersjs/authentication 5.0.0-pre.2 → 5.0.0-pre.20

package/lib/options.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
+exports.authenticationSettingsSchema = exports.defaultOptions = void 0;
+exports.defaultOptions = {
     authStrategies: [],
     jwtOptions: {
         header: { typ: 'access' },
@@ -10,4 +11,108 @@ exports.default = {
         expiresIn: '1d'
     }
 };
+exports.authenticationSettingsSchema = {
+    type: 'object',
+    required: ['secret', 'entity', 'authStrategies'],
+    properties: {
+        secret: {
+            type: 'string',
+            description: 'The JWT signing secret'
+        },
+        entity: {
+            oneOf: [{
+                    type: 'null'
+                }, {
+                    type: 'string'
+                }],
+            description: 'The name of the authentication entity (e.g. user)'
+        },
+        entityId: {
+            type: 'string',
+            description: 'The name of the authentication entity id property'
+        },
+        service: {
+            type: 'string',
+            description: 'The path of the entity service'
+        },
+        authStrategies: {
+            type: 'array',
+            items: { type: 'string' },
+            description: 'A list of authentication strategy names that are allowed to create JWT access tokens'
+        },
+        parseStrategies: {
+            type: 'array',
+            items: { type: 'string' },
+            description: 'A list of authentication strategy names that should parse HTTP headers for authentication information (defaults to `authStrategies`)'
+        },
+        jwtOptions: {
+            type: 'object'
+        },
+        jwt: {
+            type: 'object',
+            properties: {
+                header: {
+                    type: 'string',
+                    default: 'Authorization',
+                    description: 'The HTTP header containing the JWT'
+                },
+                schemes: {
+                    type: 'array',
+                    items: { type: 'string' },
+                    description: 'An array of schemes to support'
+                }
+            }
+        },
+        local: {
+            type: 'object',
+            required: ['usernameField', 'passwordField'],
+            properties: {
+                usernameField: {
+                    type: 'string',
+                    description: 'Name of the username field (e.g. `email`)'
+                },
+                passwordField: {
+                    type: 'string',
+                    description: 'Name of the password field (e.g. `password`)'
+                },
+                hashSize: {
+                    type: 'number',
+                    description: 'The BCrypt salt length'
+                },
+                errorMessage: {
+                    type: 'string',
+                    default: 'Invalid login',
+                    description: 'The error message to return on errors'
+                },
+                entityUsernameField: {
+                    type: 'string',
+                    description: 'Name of the username field on the entity if authentication request data and entity field names are different'
+                },
+                entityPasswordField: {
+                    type: 'string',
+                    description: 'Name of the password field on the entity if authentication request data and entity field names are different'
+                }
+            }
+        },
+        oauth: {
+            type: 'object',
+            properties: {
+                redirect: {
+                    type: 'string'
+                },
+                origins: {
+                    type: 'array',
+                    items: { type: 'string' }
+                },
+                defaults: {
+                    type: 'object',
+                    properties: {
+                        key: { type: 'string' },
+                        secret: { type: 'string' }
+                    }
+                }
+            }
+        }
+    }
+};
 //# sourceMappingURL=options.js.map

package/lib/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,cAAc,EAAE,EAAE;IAClB,UAAU,EAAE;QACV,MAAM,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE;QACzB,QAAQ,EAAE,wBAAwB;QAClC,MAAM,EAAE,UAAU;QAClB,SAAS,EAAE,OAAO;QAClB,SAAS,EAAE,IAAI;KAChB;CACF,CAAC"}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG;IAC5B,cAAc,EAAE,EAAc;IAC9B,UAAU,EAAE;QACV,MAAM,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE;QACzB,QAAQ,EAAE,wBAAwB;QAClC,MAAM,EAAE,UAAU;QAClB,SAAS,EAAE,OAAO;QAClB,SAAS,EAAE,IAAI;KAChB;CACF,CAAC;AAEW,QAAA,4BAA4B,GAAG;IAC1C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,CAAC;IAChD,UAAU,EAAE;QACV,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wBAAwB;SACtC;QACD,MAAM,EAAE;YACN,KAAK,EAAE,CAAC;oBACN,IAAI,EAAE,MAAM;iBACb,EAAE;oBACD,IAAI,EAAE,QAAQ;iBACf,CAAC;YACF,WAAW,EAAE,mDAAmD;SACjE;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mDAAmD;SACjE;QACD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gCAAgC;SAC9C;QACD,cAAc,EAAE;YACd,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACzB,WAAW,EAAE,sFAAsF;SACpG;QACD,eAAe,EAAE;YACf,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACzB,WAAW,EAAE,sIAAsI;SACpJ;QACD,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;SACf;QACD,GAAG,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,eAAe;oBACxB,WAAW,EAAE,oCAAoC;iBAClD;gBACD,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACzB,WAAW,EAAE,gCAAgC;iBAC9C;aACF;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,eAAe,EAAE,eAAe,CAAC;YAC5C,UAAU,EAAE;gBACV,aAAa,EAAE;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2CAA2C;iBACzD;gBACD,aAAa,EAAE;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,8CAA8C;iBAC5D;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wBAAwB;iBACtC;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,eAAe;oBACxB,WAAW,EAAE,uCAAuC;iBACrD;gBACD,mBAAmB,EAAE;oBACnB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,8GAA8G;iBAC5H;gBACD,mBAAmB,EAAE;oBACnB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,8GAA8G;iBAC5H;aACF;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;iBACf;gBACD,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC1B;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBACvB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBAC3B;iBACF;aACF;SACF;KACF;CACO,CAAC"}

package/lib/service.d.ts

@@ -1,8 +1,8 @@
-import { AuthenticationBase, AuthenticationResult, AuthenticationRequest } from './core';
+import { AuthenticationBase, AuthenticationResult, AuthenticationRequest, AuthenticationParams } from './core';
 import '@feathersjs/transport-commons';
-import { Params, ServiceMethods, ServiceAddons } from '@feathersjs/feathers';
+import { ServiceMethods, ServiceAddons } from '@feathersjs/feathers';
 declare module '@feathersjs/feathers/lib/declarations' {
-    interface FeathersApplication<ServiceTypes, AppSettings> {
+    interface FeathersApplication<Services, Settings> {
         /**
          * Returns the default authentication service or the
          * authentication service for a given path.
@@ -18,7 +18,7 @@ declare module '@feathersjs/feathers/lib/declarations' {
 }
 export interface AuthenticationService extends ServiceAddons<AuthenticationResult, AuthenticationResult> {
 }
-export declare class AuthenticationService extends AuthenticationBase implements Partial<ServiceMethods<AuthenticationResult>> {
+export declare class AuthenticationService extends AuthenticationBase implements Partial<ServiceMethods<AuthenticationResult, AuthenticationRequest, AuthenticationParams>> {
     constructor(app: any, configKey?: string, options?: {});
     /**
      * Return the payload for a JWT based on the authentication result.
@@ -27,7 +27,9 @@ export declare class AuthenticationService extends AuthenticationBase implements
      * @param _authResult The current authentication result
      * @param params The service call parameters
      */
-    getPayload(_authResult: AuthenticationResult, params: Params): Promise<any>;
+    getPayload(_authResult: AuthenticationResult, params: AuthenticationParams): Promise<{
+        [key: string]: any;
+    }>;
     /**
      * Returns the JWT options based on an authentication result.
      * By default sets the JWT subject to the entity id.
@@ -35,7 +37,7 @@ export declare class AuthenticationService extends AuthenticationBase implements
      * @param authResult The authentication result
      * @param params Service call parameters
      */
-    getTokenOptions(authResult: AuthenticationResult, params: Params): Promise<any>;
+    getTokenOptions(authResult: AuthenticationResult, params: AuthenticationParams): Promise<any>;
     /**
      * Create and return a new JWT for a given authentication request.
      * Will trigger the `login` event.
@@ -43,7 +45,7 @@ export declare class AuthenticationService extends AuthenticationBase implements
      * @param data The authentication request (should include `strategy` key)
      * @param params Service call parameters
      */
-    create(data: AuthenticationRequest, params?: Params): Promise<AuthenticationResult>;
+    create(data: AuthenticationRequest, params?: AuthenticationParams): Promise<AuthenticationResult>;
     /**
      * Mark a JWT as removed. By default only verifies the JWT and returns the result.
      * Triggers the `logout` event.
@@ -51,7 +53,7 @@ export declare class AuthenticationService extends AuthenticationBase implements
      * @param id The JWT to remove or null
      * @param params Service call parameters
      */
-    remove(id: string | null, params?: Params): Promise<AuthenticationResult>;
+    remove(id: string | null, params?: AuthenticationParams): Promise<AuthenticationResult>;
     /**
      * Validates the service configuration.
      */

package/lib/service.js

@@ -1,26 +1,17 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthenticationService = void 0;
-const debug_1 = __importDefault(require("debug"));
 const merge_1 = __importDefault(require("lodash/merge"));
 const errors_1 = require("@feathersjs/errors");
 const core_1 = require("./core");
 const hooks_1 = require("./hooks");
 require("@feathersjs/transport-commons");
+const commons_1 = require("@feathersjs/commons");
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
-const debug = debug_1.default('@feathersjs/authentication/service');
+const debug = (0, commons_1.createDebug)('@feathersjs/authentication/service');
 class AuthenticationService extends core_1.AuthenticationBase {
     constructor(app, configKey = 'authentication', options = {}) {
         super(app, configKey, options);
@@ -39,12 +30,10 @@ class AuthenticationService extends core_1.AuthenticationBase {
      * @param _authResult The current authentication result
      * @param params The service call parameters
      */
-    getPayload(_authResult, params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // Uses `params.payload` or returns an empty payload
-            const { payload = {} } = params;
-            return payload;
-        });
+    async getPayload(_authResult, params) {
+        // Uses `params.payload` or returns an empty payload
+        const { payload = {} } = params;
+        return payload;
     }
     /**
      * Returns the JWT options based on an authentication result.
@@ -53,22 +42,20 @@ class AuthenticationService extends core_1.AuthenticationBase {
      * @param authResult The authentication result
      * @param params Service call parameters
      */
-    getTokenOptions(authResult, params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { service, entity, entityId } = this.configuration;
-            const jwtOptions = merge_1.default({}, params.jwtOptions, params.jwt);
-            const value = service && entity && authResult[entity];
-            // Set the subject to the entity id if it is available
-            if (value && !jwtOptions.subject) {
-                const idProperty = entityId || this.app.service(service).id;
-                const subject = value[idProperty];
-                if (subject === undefined) {
-                    throw new errors_1.NotAuthenticated(`Can not set subject from ${entity}.${idProperty}`);
-                }
-                jwtOptions.subject = `${subject}`;
+    async getTokenOptions(authResult, params) {
+        const { service, entity, entityId } = this.configuration;
+        const jwtOptions = (0, merge_1.default)({}, params.jwtOptions, params.jwt);
+        const value = service && entity && authResult[entity];
+        // Set the subject to the entity id if it is available
+        if (value && !jwtOptions.subject) {
+            const idProperty = entityId || this.app.service(service).id;
+            const subject = value[idProperty];
+            if (subject === undefined) {
+                throw new errors_1.NotAuthenticated(`Can not set subject from ${entity}.${idProperty}`);
             }
-            return jwtOptions;
-        });
+            jwtOptions.subject = `${subject}`;
+        }
+        return jwtOptions;
     }
     /**
      * Create and return a new JWT for a given authentication request.
@@ -77,29 +64,27 @@ class AuthenticationService extends core_1.AuthenticationBase {
      * @param data The authentication request (should include `strategy` key)
      * @param params Service call parameters
      */
-    create(data, params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const authStrategies = params.authStrategies || this.configuration.authStrategies;
-            if (!authStrategies.length) {
-                throw new errors_1.NotAuthenticated('No authentication strategies allowed for creating a JWT (`authStrategies`)');
-            }
-            const authResult = yield this.authenticate(data, params, ...authStrategies);
-            debug('Got authentication result', authResult);
-            if (authResult.accessToken) {
-                return authResult;
+    async create(data, params) {
+        const authStrategies = params.authStrategies || this.configuration.authStrategies;
+        if (!authStrategies.length) {
+            throw new errors_1.NotAuthenticated('No authentication strategies allowed for creating a JWT (`authStrategies`)');
+        }
+        const authResult = await this.authenticate(data, params, ...authStrategies);
+        debug('Got authentication result', authResult);
+        if (authResult.accessToken) {
+            return authResult;
+        }
+        const [payload, jwtOptions] = await Promise.all([
+            this.getPayload(authResult, params),
+            this.getTokenOptions(authResult, params)
+        ]);
+        debug('Creating JWT with', payload, jwtOptions);
+        const accessToken = await this.createAccessToken(payload, jwtOptions, params.secret);
+        return (0, merge_1.default)({ accessToken }, authResult, {
+            authentication: {
+                accessToken,
+                payload: jsonwebtoken_1.default.decode(accessToken)
             }
-            const [payload, jwtOptions] = yield Promise.all([
-                this.getPayload(authResult, params),
-                this.getTokenOptions(authResult, params)
-            ]);
-            debug('Creating JWT with', payload, jwtOptions);
-            const accessToken = yield this.createAccessToken(payload, jwtOptions, params.secret);
-            return merge_1.default({ accessToken }, authResult, {
-                authentication: {
-                    accessToken,
-                    payload: jsonwebtoken_1.default.decode(accessToken)
-                }
-            });
         });
     }
     /**
@@ -109,53 +94,48 @@ class AuthenticationService extends core_1.AuthenticationBase {
      * @param id The JWT to remove or null
      * @param params Service call parameters
      */
-    remove(id, params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { authentication } = params;
-            const { authStrategies } = this.configuration;
-            // When an id is passed it is expected to be the authentication `accessToken`
-            if (id !== null && id !== authentication.accessToken) {
-                throw new errors_1.NotAuthenticated('Invalid access token');
-            }
-            debug('Verifying authentication strategy in remove');
-            return this.authenticate(authentication, params, ...authStrategies);
-        });
+    async remove(id, params) {
+        const { authentication } = params;
+        const { authStrategies } = this.configuration;
+        // When an id is passed it is expected to be the authentication `accessToken`
+        if (id !== null && id !== authentication.accessToken) {
+            throw new errors_1.NotAuthenticated('Invalid access token');
+        }
+        debug('Verifying authentication strategy in remove');
+        return this.authenticate(authentication, params, ...authStrategies);
     }
     /**
      * Validates the service configuration.
      */
-    setup() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // The setup method checks for valid settings and registers the
-            // connection and event (login, logout) hooks
-            const { secret, service, entity, entityId } = this.configuration;
-            if (typeof secret !== 'string') {
-                throw new Error('A \'secret\' must be provided in your authentication configuration');
+    async setup() {
+        await super.setup();
+        // The setup method checks for valid settings and registers the
+        // connection and event (login, logout) hooks
+        const { secret, service, entity, entityId } = this.configuration;
+        if (typeof secret !== 'string') {
+            throw new Error('A \'secret\' must be provided in your authentication configuration');
+        }
+        if (entity !== null) {
+            if (service === undefined) {
+                throw new Error('The \'service\' option is not set in the authentication configuration');
             }
-            if (entity !== null) {
-                if (service === undefined) {
-                    throw new Error('The \'service\' option is not set in the authentication configuration');
-                }
-                if (this.app.service(service) === undefined) {
-                    throw new Error(`The '${service}' entity service does not exist (set to 'null' if it is not required)`);
-                }
-                if (this.app.service(service).id === undefined && entityId === undefined) {
-                    throw new Error(`The '${service}' service does not have an 'id' property and no 'entityId' option is set.`);
-                }
+            if (this.app.service(service) === undefined) {
+                throw new Error(`The '${service}' entity service does not exist (set to 'null' if it is not required)`);
             }
-            this.hooks({
-                after: {
-                    create: [hooks_1.connection('login'), hooks_1.event('login')],
-                    remove: [hooks_1.connection('logout'), hooks_1.event('logout')]
-                }
-            });
-            this.app.on('disconnect', (connection) => __awaiter(this, void 0, void 0, function* () {
-                yield this.handleConnection('disconnect', connection);
-            }));
-            if (typeof this.publish === 'function') {
-                this.publish(() => null);
+            if (this.app.service(service).id === undefined && entityId === undefined) {
+                throw new Error(`The '${service}' service does not have an 'id' property and no 'entityId' option is set.`);
             }
+        }
+        this.hooks({
+            create: [(0, hooks_1.connection)('login'), (0, hooks_1.event)('login')],
+            remove: [(0, hooks_1.connection)('logout'), (0, hooks_1.event)('logout')]
+        });
+        this.app.on('disconnect', async (connection) => {
+            await this.handleConnection('disconnect', connection);
         });
+        if (typeof this.publish === 'function') {
+            this.publish(() => null);
+        }
     }
 }
 exports.AuthenticationService = AuthenticationService;

package/lib/service.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,yDAAiC;AACjC,+CAAsD;AACtD,iCAAyF;AACzF,mCAA4C;AAC5C,yCAAuC;AAEvC,gEAAwC;AAExC,MAAM,KAAK,GAAG,eAAK,CAAC,oCAAoC,CAAC,CAAC;AAsB1D,MAAa,qBAAsB,SAAQ,yBAAkB;IAC3D,YAAa,GAAQ,EAAE,SAAS,GAAG,gBAAgB,EAAE,OAAO,GAAG,EAAE;QAC/D,KAAK,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAE/B,IAAI,OAAO,GAAG,CAAC,qBAAqB,KAAK,UAAU,EAAE;YACnD,GAAG,CAAC,qBAAqB,GAAG,UAAU,QAAiB;gBACrD,MAAM,SAAS,GAAG,GAAG,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;gBACnD,MAAM,IAAI,GAAG,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CACjE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,KAAK,SAAS,CAC9C,CAAC;gBAEF,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC1C,CAAC,CAAC;SACH;IACH,CAAC;IACD;;;;;;OAMG;IACG,UAAU,CAAE,WAAiC,EAAE,MAAc;;YACjE,oDAAoD;YACpD,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;YAEhC,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;OAMG;IACG,eAAe,CAAE,UAAgC,EAAE,MAAc;;YACrE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;YACzD,MAAM,UAAU,GAAG,eAAK,CAAC,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;YAC5D,MAAM,KAAK,GAAG,OAAO,IAAI,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;YAEtD,sDAAsD;YACtD,IAAI,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;gBAChC,MAAM,UAAU,GAAG,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC5D,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;gBAElC,IAAI,OAAO,KAAK,SAAS,EAAE;oBACzB,MAAM,IAAI,yBAAgB,CAAC,4BAA4B,MAAM,IAAI,UAAU,EAAE,CAAC,CAAC;iBAChF;gBAED,UAAU,CAAC,OAAO,GAAG,GAAG,OAAO,EAAE,CAAC;aACnC;YAED,OAAO,UAAU,CAAC;QACpB,CAAC;KAAA;IAED;;;;;;OAMG;IACG,MAAM,CAAE,IAA2B,EAAE,MAAe;;YACxD,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;YAElF,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;gBAC1B,MAAM,IAAI,yBAAgB,CAAC,4EAA4E,CAAC,CAAC;aAC1G;YAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,CAAC;YAE5E,KAAK,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC;YAE/C,IAAI,UAAU,CAAC,WAAW,EAAE;gBAC1B,OAAO,UAAU,CAAC;aACnB;YAED,MAAM,CAAE,OAAO,EAAE,UAAU,CAAE,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChD,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,MAAM,CAAC;gBACnC,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC;aACzC,CAAC,CAAC;YAEH,KAAK,CAAC,mBAAmB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAEhD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAErF,OAAO,eAAK,CAAC,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE;gBACxC,cAAc,EAAE;oBACZ,WAAW;oBACX,OAAO,EAAE,sBAAY,CAAC,MAAM,CAAC,WAAW,CAAC;iBAC5C;aACF,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;OAMG;IACG,MAAM,CAAE,EAAiB,EAAE,MAAe;;YAC9C,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;YAClC,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;YAE9C,6EAA6E;YAC7E,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,cAAc,CAAC,WAAW,EAAE;gBACpD,MAAM,IAAI,yBAAgB,CAAC,sBAAsB,CAAC,CAAC;aACpD;YAED,KAAK,CAAC,6CAA6C,CAAC,CAAC;YAErD,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,CAAC;QACtE,CAAC;KAAA;IAED;;OAEG;IACG,KAAK;;YACT,+DAA+D;YAC/D,6CAA6C;YAC7C,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;YAEjE,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;gBAC9B,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;aACvF;YAED,IAAI,MAAM,KAAK,IAAI,EAAE;gBACnB,IAAI,OAAO,KAAK,SAAS,EAAE;oBACzB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;iBAC1F;gBAED,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE;oBAC3C,MAAM,IAAI,KAAK,CAAC,QAAQ,OAAO,uEAAuE,CAAC,CAAC;iBACzG;gBAED,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,EAAE;oBACxE,MAAM,IAAI,KAAK,CAAC,QAAQ,OAAO,2EAA2E,CAAC,CAAC;iBAC7G;aACF;YAEA,IAAY,CAAC,KAAK,CAAC;gBAClB,KAAK,EAAE;oBACL,MAAM,EAAE,CAAE,kBAAU,CAAC,OAAO,CAAC,EAAE,aAAK,CAAC,OAAO,CAAC,CAAE;oBAC/C,MAAM,EAAE,CAAE,kBAAU,CAAC,QAAQ,CAAC,EAAE,aAAK,CAAC,QAAQ,CAAC,CAAE;iBAClD;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,YAAY,EAAE,CAAO,UAAU,EAAE,EAAE;gBAC7C,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;YACxD,CAAC,CAAA,CAAC,CAAC;YAEH,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE;gBACtC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;aAC1B;QACH,CAAC;KAAA;CACF;AA7JD,sDA6JC"}
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":";;;;;;AAAA,yDAAiC;AACjC,+CAAsD;AACtD,iCAA+G;AAC/G,mCAA4C;AAC5C,yCAAuC;AACvC,iDAAkD;AAElD,gEAAwC;AAExC,MAAM,KAAK,GAAG,IAAA,qBAAW,EAAC,oCAAoC,CAAC,CAAC;AAsBhE,MAAa,qBAAsB,SAAQ,yBAAkB;IAC3D,YAAa,GAAQ,EAAE,SAAS,GAAG,gBAAgB,EAAE,OAAO,GAAG,EAAE;QAC/D,KAAK,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAE/B,IAAI,OAAO,GAAG,CAAC,qBAAqB,KAAK,UAAU,EAAE;YACnD,GAAG,CAAC,qBAAqB,GAAG,UAAU,QAAiB;gBACrD,MAAM,SAAS,GAAG,GAAG,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;gBACnD,MAAM,IAAI,GAAG,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CACjE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,KAAK,SAAS,CAC9C,CAAC;gBAEF,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC1C,CAAC,CAAC;SACH;IACH,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAE,WAAiC,EAAE,MAA4B;QAC/E,oDAAoD;QACpD,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;QAEhC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAE,UAAgC,EAAE,MAA4B;QACnF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QACzD,MAAM,UAAU,GAAG,IAAA,eAAK,EAAC,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,KAAK,GAAG,OAAO,IAAI,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QAEtD,sDAAsD;QACtD,IAAI,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;YAChC,MAAM,UAAU,GAAG,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAC5D,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;YAElC,IAAI,OAAO,KAAK,SAAS,EAAE;gBACzB,MAAM,IAAI,yBAAgB,CAAC,4BAA4B,MAAM,IAAI,UAAU,EAAE,CAAC,CAAC;aAChF;YAED,UAAU,CAAC,OAAO,GAAG,GAAG,OAAO,EAAE,CAAC;SACnC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAE,IAA2B,EAAE,MAA6B;QACtE,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;QAElF,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC1B,MAAM,IAAI,yBAAgB,CAAC,4EAA4E,CAAC,CAAC;SAC1G;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,CAAC;QAE5E,KAAK,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC;QAE/C,IAAI,UAAU,CAAC,WAAW,EAAE;YAC1B,OAAO,UAAU,CAAC;SACnB;QAED,MAAM,CAAE,OAAO,EAAE,UAAU,CAAE,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAChD,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,MAAM,CAAC;YACnC,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC;SACzC,CAAC,CAAC;QAEH,KAAK,CAAC,mBAAmB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEhD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAErF,OAAO,IAAA,eAAK,EAAC,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE;YACxC,cAAc,EAAE;gBACZ,WAAW;gBACX,OAAO,EAAE,sBAAY,CAAC,MAAM,CAAC,WAAW,CAAC;aAC5C;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAE,EAAiB,EAAE,MAA6B;QAC5D,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QAClC,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAE9C,6EAA6E;QAC7E,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,cAAc,CAAC,WAAW,EAAE;YACpD,MAAM,IAAI,yBAAgB,CAAC,sBAAsB,CAAC,CAAC;SACpD;QAED,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAErD,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QAEpB,+DAA+D;QAC/D,6CAA6C;QAC7C,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAEjE,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;SACvF;QAED,IAAI,MAAM,KAAK,IAAI,EAAE;YACnB,IAAI,OAAO,KAAK,SAAS,EAAE;gBACzB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;aAC1F;YAED,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE;gBAC3C,MAAM,IAAI,KAAK,CAAC,QAAQ,OAAO,uEAAuE,CAAC,CAAC;aACzG;YAED,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,EAAE;gBACxE,MAAM,IAAI,KAAK,CAAC,QAAQ,OAAO,2EAA2E,CAAC,CAAC;aAC7G;SACF;QAEA,IAAY,CAAC,KAAK,CAAC;YAClB,MAAM,EAAE,CAAE,IAAA,kBAAU,EAAC,OAAO,CAAC,EAAE,IAAA,aAAK,EAAC,OAAO,CAAC,CAAE;YAC/C,MAAM,EAAE,CAAE,IAAA,kBAAU,EAAC,QAAQ,CAAC,EAAE,IAAA,aAAK,EAAC,QAAQ,CAAC,CAAE;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;YAC7C,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE;YACtC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;SAC1B;IACH,CAAC;CACF;AA7JD,sDA6JC"}

package/lib/strategy.d.ts

@@ -8,5 +8,5 @@ export declare class AuthenticationBaseStrategy implements AuthenticationStrateg
     setApplication(app: Application): void;
     setName(name: string): void;
     get configuration(): any;
-    get entityService(): Service<any>;
+    get entityService(): Service;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@feathersjs/authentication",
   "description": "Add Authentication to your FeathersJS app.",
-  "version": "5.0.0-pre.2",
+  "version": "5.0.0-pre.20",
   "homepage": "https://feathersjs.com",
   "main": "lib/",
   "types": "lib/",
@@ -16,7 +16,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/feathersjs/feathers.git"
+    "url": "git://github.com/feathersjs/feathers.git",
+    "directory": "packages/authentication"
   },
   "author": {
     "name": "Feathers contributors",
@@ -42,8 +43,7 @@
   "scripts": {
     "prepublish": "npm run compile",
     "compile": "shx rm -rf lib/ && tsc",
-    "test": "npm run compile && npm run mocha",
-    "mocha": "mocha --config ../../.mocharc.json --recursive test/**.test.ts test/**/*.test.ts"
+    "test": "mocha --config ../../.mocharc.json --recursive test/**.test.ts test/**/*.test.ts"
   },
   "directories": {
     "lib": "lib"
@@ -52,27 +52,27 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathersjs/errors": "^5.0.0-pre.2",
-    "@feathersjs/feathers": "^5.0.0-pre.2",
-    "@feathersjs/transport-commons": "^5.0.0-pre.2",
-    "@types/jsonwebtoken": "^8.5.1",
-    "debug": "^4.3.1",
+    "@feathersjs/commons": "^5.0.0-pre.20",
+    "@feathersjs/errors": "^5.0.0-pre.20",
+    "@feathersjs/feathers": "^5.0.0-pre.20",
+    "@feathersjs/transport-commons": "^5.0.0-pre.20",
+    "@types/jsonwebtoken": "^8.5.8",
     "jsonwebtoken": "^8.5.1",
     "lodash": "^4.17.21",
     "long-timeout": "^0.1.1",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@feathersjs/adapter-memory": "^5.0.0-pre.2",
-    "@types/debug": "^4.1.5",
-    "@types/lodash": "^4.14.168",
-    "@types/mocha": "^8.2.2",
-    "@types/node": "^14.14.37",
-    "@types/uuid": "^8.3.0",
-    "mocha": "^8.3.2",
-    "shx": "^0.3.3",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.2.3"
+    "@feathersjs/memory": "^5.0.0-pre.20",
+    "@feathersjs/schema": "^5.0.0-pre.20",
+    "@types/lodash": "^4.14.182",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^17.0.31",
+    "@types/uuid": "^8.3.4",
+    "mocha": "^10.0.0",
+    "shx": "^0.3.4",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.4"
   },
-  "gitHead": "6e1f888dc5b612d2d77653177622e3f66245a0fb"
+  "gitHead": "54de749a0b392c7da726c668002b50cafaca530c"
 }

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';
+import { defaultOptions } from './options';
 
-const debug = Debug('@feathersjs/authentication/base');
+const debug = createDebug('@feathersjs/authentication/base');
 
 export interface AuthenticationResult {
   [key: string]: any;
@@ -18,6 +18,14 @@ export interface AuthenticationRequest {
   [key: string]: any;
 }
 
+export interface AuthenticationParams extends Params {
+  payload?: { [key: string]: any };
+  jwtOptions?: SignOptions;
+  authStrategies?: string[];
+  secret?: string;
+  [key: string]: any;
+}
+
 export type ConnectionEvent = 'login' | 'logout' | 'disconnect';
 
 export interface AuthenticationStrategy {
@@ -44,6 +52,12 @@ export interface AuthenticationStrategy {
    * and throw an error if it is invalid.
    */
   verifyConfiguration? (): void;
+  /**
+   * Implement this method to setup this strategy
+   * @param auth The AuthenticationService
+   * @param name The name of the strategy
+   */
+  setup? (auth: AuthenticationBase, name: string): Promise<void>;
   /**
    * Authenticate an authentication request with this strategy.
    * Should throw an error if the strategy did not succeed.
@@ -51,7 +65,7 @@ export interface AuthenticationStrategy {
    * @param authentication The authentication request
    * @param params The service call parameters
    */
-  authenticate? (authentication: AuthenticationRequest, params: Params): Promise<AuthenticationResult>;
+  authenticate? (authentication: AuthenticationRequest, params: AuthenticationParams): Promise<AuthenticationResult>;
   /**
    * Update a real-time connection according to this strategy.
    *
@@ -77,10 +91,9 @@ export interface JwtVerifyOptions extends VerifyOptions {
  */
 export class AuthenticationBase {
   app: Application;
+  strategies: { [key: string]: AuthenticationStrategy };
   configKey: string;
-  strategies: {
-    [key: string]: AuthenticationStrategy;
-  };
+  isReady: boolean;
 
   /**
    * Create a new authentication service.
@@ -97,6 +110,7 @@ export class AuthenticationBase {
     this.app = app;
     this.strategies = {};
     this.configKey = configKey;
+    this.isReady = false;
 
     app.set('defaultAuthentication', app.get('defaultAuthentication') || configKey);
     app.set(configKey, merge({}, app.get(configKey), options));
@@ -143,6 +157,10 @@ export class AuthenticationBase {
 
     // Register strategy as name
     this.strategies[name] = strategy;
+
+    if (this.isReady) {
+      strategy.setup?.(this, name);
+    }
   }
 
   /**
@@ -155,6 +173,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 +228,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);
     }
   }
@@ -212,7 +240,7 @@ export class AuthenticationBase {
    * @param params Service call parameters
    * @param allowed A list of allowed strategy names
    */
-  async authenticate (authentication: AuthenticationRequest, params: Params, ...allowed: string[]) {
+  async authenticate (authentication: AuthenticationRequest, params: AuthenticationParams, ...allowed: string[]) {
     const { strategy } = authentication || {};
     const [ authStrategy ] = this.getStrategies(strategy);
     const strategyAllowed = allowed.includes(strategy);
@@ -265,4 +293,14 @@ export class AuthenticationBase {
 
     return null;
   }
+
+  async setup () {
+    this.isReady = true;
+
+    for (const name of Object.keys(this.strategies)) {
+      const strategy = this.strategies[name];
+
+      await strategy.setup?.(this, name);
+    }
+  }
 }