fix(provider): inject USER_MODEL key to user-authentication provider

README.md

@@ -286,6 +286,12 @@ export class User extends Entity implements IAuthUser {
 }
 ```
 
+Now bind this model to USER_MODEL key in application.ts
+
+```ts
+this.bind(AuthenticationBindings.USER_MODEL).to(User);
+```
+
 Create CRUD repository for the above model. Use loopback CLI.
 
 ```sh
@@ -460,6 +466,12 @@ export class User extends Entity implements IAuthUser {
 }
 ```
 
+Now bind this model to USER_MODEL key in application.ts
+
+```ts
+this.bind(AuthenticationBindings.USER_MODEL).to(User);
+```
+
 Create CRUD repository for the above model. Use loopback CLI.
 
 ```sh
@@ -668,6 +680,12 @@ export class User extends Entity implements IAuthUser {
 }
 ```
 
+Now bind this model to USER_MODEL key in application.ts
+
+```ts
+this.bind(AuthenticationBindings.USER_MODEL).to(User);
+```
+
 Create CRUD repository for both of the above models. Use loopback CLI.
 
 ```sh
@@ -1064,6 +1082,12 @@ export class User extends Entity implements IAuthUser {
 }
 ```
 
+Now bind this model to USER_MODEL key in application.ts
+
+```ts
+this.bind(AuthenticationBindings.USER_MODEL).to(User);
+```
+
 Create CRUD repository for the above model. Use loopback CLI.
 
 ```sh
@@ -1371,6 +1395,12 @@ export class User extends Entity implements IAuthUser {
 }
 ```
 
+Now bind this model to USER_MODEL key in application.ts
+
+```ts
+this.bind(AuthenticationBindings.USER_MODEL).to(User);
+```
+
 Create CRUD repository for the above model. Use loopback CLI.
 
 ```sh
@@ -1676,6 +1706,12 @@ export class User extends Entity implements IAuthUser {
 }
 ```
 
+Now bind this model to USER_MODEL key in application.ts
+
+```ts
+this.bind(AuthenticationBindings.USER_MODEL).to(User);
+```
+
 Create CRUD repository for the above model. Use loopback CLI.
 
 ```sh
@@ -1983,6 +2019,12 @@ export class User extends Entity implements IAuthUser {
 }
 ```
 
+Now bind this model to USER_MODEL key in application.ts
+
+```ts
+this.bind(AuthenticationBindings.USER_MODEL).to(User);
+```
+
 Create CRUD repository for the above model. Use loopback CLI.
 
 ```sh
@@ -2288,6 +2330,12 @@ export class User extends Entity implements IAuthUser {
 }
 ```
 
+Now bind this model to USER_MODEL key in application.ts
+
+```ts
+this.bind(AuthenticationBindings.USER_MODEL).to(User);
+```
+
 Create CRUD repository for the above model. Use loopback CLI.
 
 ```sh

src/models/authuser.model.ts → src/__tests__/fixtures/user-cred.model.ts

@@ -1,7 +1,7 @@
 import {Entity, model, property} from '@loopback/repository';
 
 @model({settings: {strict: false}})
-export class Authuser extends Entity {
+export class UserCred extends Entity {
   @property({
     type: 'string',
     id: true,
@@ -16,19 +16,13 @@ export class Authuser extends Entity {
   })
   password: string;
 
-  // Define well-known properties here
-
-  // Indexer property to allow additional data
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [prop: string]: any;
-
-  constructor(data?: Partial<Authuser>) {
+  constructor(data?: Partial<UserCred>) {
     super(data);
   }
 }
 
-export interface AuthuserRelations {
+export interface UserCredRelations {
   // describe navigational properties here
 }
 
-export type AuthuserWithRelations = Authuser & AuthuserRelations;
+export type AuthuserWithRelations = UserCred & UserCredRelations;

src/__tests__/integration/action-sequence/passport-local/local-passport.integration.ts

@@ -10,7 +10,7 @@ import {Strategies} from '../../../../strategies/keys';
 import {LocalVerifyProvider} from '../../../fixtures/providers/local-password.provider';
 import {AuthenticationBindings} from '../../../../keys';
 import {IAuthUser} from '../../../../types';
-import {Authuser} from '../../../../models';
+import {UserCred} from '../../../fixtures/user-cred.model';
 /**
  * Testing overall flow of authentication with bearer strategy
  */
@@ -25,7 +25,10 @@ describe('Local passport strategy', () => {
     class TestController {
       @post('/auth/local/no-user-data-passed')
       @authenticate(STRATEGY.LOCAL)
-      test(@requestBody({required: true}) body: Authuser) {
+      test(
+        @requestBody({required: true})
+        body: UserCred,
+      ) {
         return 'test successful';
       }
     }
@@ -43,7 +46,7 @@ describe('Local passport strategy', () => {
       @authenticate(STRATEGY.LOCAL)
       test(
         @requestBody()
-        body: Authuser,
+        body: UserCred,
       ) {
         return 'test successful';
       }
@@ -66,7 +69,7 @@ describe('Local passport strategy', () => {
 
       @post('/auth/local/no-options')
       @authenticate(STRATEGY.LOCAL)
-      test(@requestBody() body: {username: string; password: string}) {
+      test(@requestBody() body: UserCred) {
         return this.user;
       }
     }
@@ -94,7 +97,7 @@ describe('Local passport strategy', () => {
 
       @post('/auth/local/pass-req-callback-true')
       @authenticate(STRATEGY.LOCAL, {passReqToCallback: true})
-      async test(@requestBody() body: {username: string; password: string}) {
+      async test(@requestBody() body: UserCred) {
         return this.user;
       }
     }
@@ -122,7 +125,7 @@ describe('Local passport strategy', () => {
 
       @post('/auth/local/pass-req-callback-false')
       @authenticate(STRATEGY.LOCAL, {passReqToCallback: false})
-      async test(@requestBody() body: {username: string; password: string}) {
+      async test(@requestBody() body: UserCred) {
         return this.user;
       }
     }
@@ -144,7 +147,7 @@ describe('Local passport strategy', () => {
 
       @post('/auth/local/null-user')
       @authenticate(STRATEGY.LOCAL)
-      async test(@requestBody() body: {username: string; password: string}) {
+      async test(@requestBody() body: UserCred) {
         return body;
       }
     }
@@ -192,7 +195,7 @@ describe('Local strategy with no verifier', () => {
 
       @post('/auth/local/no-verifier')
       @authenticate(STRATEGY.LOCAL, {passReqToCallback: false})
-      async test(@requestBody() body: {username: string; password: string}) {
+      async test(@requestBody() body: UserCred) {
         return body;
       }
     }

src/__tests__/integration/middleware-sequence/passport-local/local-passport.integration.ts

@@ -10,7 +10,7 @@ import {Strategies} from '../../../../strategies/keys';
 import {LocalVerifyProvider} from '../../../fixtures/providers/local-password.provider';
 import {AuthenticationBindings} from '../../../../keys';
 import {IAuthUser} from '../../../../types';
-import {Authuser} from '../../../../models';
+import {UserCred} from '../../../fixtures/user-cred.model';
 /**
  * Testing overall flow of authentication with bearer strategy
  */
@@ -25,7 +25,10 @@ describe('Local passport strategy using Middleware Sequence', () => {
     class TestController {
       @post('/auth/local/no-user-data-passed')
       @authenticate(STRATEGY.LOCAL)
-      test(@requestBody({required: true}) body: Authuser) {
+      test(
+        @requestBody({required: true})
+        body: UserCred,
+      ) {
         return 'test successful';
       }
     }
@@ -43,7 +46,7 @@ describe('Local passport strategy using Middleware Sequence', () => {
       @authenticate(STRATEGY.LOCAL)
       test(
         @requestBody()
-        body: Authuser,
+        body: UserCred,
       ) {
         return 'test successful';
       }
@@ -66,7 +69,7 @@ describe('Local passport strategy using Middleware Sequence', () => {
 
       @post('/auth/local/no-options')
       @authenticate(STRATEGY.LOCAL)
-      test(@requestBody() body: {username: string; password: string}) {
+      test(@requestBody() body: UserCred) {
         return this.user;
       }
     }
@@ -94,7 +97,7 @@ describe('Local passport strategy using Middleware Sequence', () => {
 
       @post('/auth/local/pass-req-callback-true')
       @authenticate(STRATEGY.LOCAL, {passReqToCallback: true})
-      async test(@requestBody() body: {username: string; password: string}) {
+      async test(@requestBody() body: UserCred) {
         return this.user;
       }
     }
@@ -122,7 +125,7 @@ describe('Local passport strategy using Middleware Sequence', () => {
 
       @post('/auth/local/pass-req-callback-false')
       @authenticate(STRATEGY.LOCAL, {passReqToCallback: false})
-      async test(@requestBody() body: {username: string; password: string}) {
+      async test(@requestBody() body: UserCred) {
         return this.user;
       }
     }
@@ -144,7 +147,7 @@ describe('Local passport strategy using Middleware Sequence', () => {
 
       @post('/auth/local/null-user')
       @authenticate(STRATEGY.LOCAL)
-      async test(@requestBody() body: {username: string; password: string}) {
+      async test(@requestBody() body: UserCred) {
         return body;
       }
     }
@@ -192,7 +195,7 @@ describe('Local strategy with no verifier using Middleware Sequence', () => {
 
       @post('/auth/local/no-verifier')
       @authenticate(STRATEGY.LOCAL, {passReqToCallback: false})
-      async test(@requestBody() body: {username: string; password: string}) {
+      async test(@requestBody() body: UserCred) {
         return body;
       }
     }

src/providers/user-authentication.provider.ts

@@ -1,11 +1,16 @@
-import {Getter, inject, Provider, Setter} from '@loopback/context';
+import {Constructor, Getter, inject, Provider, Setter} from '@loopback/context';
 import {HttpErrors, Request, Response} from '@loopback/rest';
 import {Strategy} from 'passport';
 
 import {AuthErrorKeys} from '../error-keys';
 import {AuthenticationBindings} from '../keys';
 import {StrategyAdapter} from '../strategy-adapter';
-import {AuthenticateFn, IAuthUser, AuthenticationMetadata} from '../types';
+import {
+  AuthenticateFn,
+  IAuthUser,
+  AuthenticationMetadata,
+  EntityWithIdentifier,
+} from '../types';
 
 export class AuthenticateActionProvider
   implements Provider<AuthenticateFn<IAuthUser | undefined>>
@@ -17,6 +22,8 @@ export class AuthenticateActionProvider
     private readonly getMetadata: Getter<AuthenticationMetadata>,
     @inject.setter(AuthenticationBindings.CURRENT_USER)
     readonly setCurrentUser: Setter<IAuthUser | undefined>,
+    @inject(AuthenticationBindings.USER_MODEL, {optional: true})
+    public authUserModel?: Constructor<EntityWithIdentifier & IAuthUser>,
   ) {}
 
   value(): AuthenticateFn<IAuthUser | undefined> {
@@ -45,12 +52,11 @@ export class AuthenticateActionProvider
       authOpts = metadata.authOptions(request);
     }
     const strategyAdapter = new StrategyAdapter<IAuthUser>(strategy);
-    const user = await strategyAdapter.authenticate(
-      request,
-      response,
-      authOpts,
-    );
+    let user = await strategyAdapter.authenticate(request, response, authOpts);
     if (user) {
+      if (this.authUserModel) {
+        user = new this.authUserModel(user);
+      }
       this.setCurrentUser(user);
       return user;
     }