Merge pull request #42 from spira/feature/logout-listener

Added logout listener functionality.

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "ng-jwt-auth",
-  "version": "3.5.1",
+  "version": "3.6.0",
   "description": "Angular JSON Web Token Authentication Module",
   "main": "dist/ngJwtAuth.js",
   "dependencies": {

dist/ngJwtAuth.d.ts

@@ -94,8 +94,8 @@ declare module NgJwtAuth {
     interface IUserFactory {
         (subClaim: string, tokenData: IJwtClaims): ng.IPromise<IUser>;
     }
-    interface ILoginListener {
-        (user: IUser): any;
+    interface IUserEventListener {
+        (user: IUser): void;
     }
     interface IBase64Service {
         encode(string: string): string;
@@ -117,6 +117,7 @@ declare module NgJwtAuth {
         private userFactory;
         private loginPromptFactory;
         private loginListeners;
+        private logoutListeners;
         private userLoggedInPromise;
         private refreshTimerPromise;
         private tokenData;
@@ -343,7 +344,12 @@ declare module NgJwtAuth {
          * Register a login listener function
          * @param loginListener
          */
-        registerLoginListener(loginListener: ILoginListener): void;
+        registerLoginListener(loginListener: IUserEventListener): void;
+        /**
+         * Register a logout listener function
+         * @param logoutListener
+         */
+        registerLogoutListener(logoutListener: IUserEventListener): void;
         /**
          * Get a user's token given their identifier
          * @param userIdentifier

package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-jwt-auth",
-  "version": "3.5.1",
+  "version": "3.6.0",
   "description": "Angular JSON Web Token Authentication Module",
   "main": "dist/ngJwtAuth.js",
   "scripts": {

src/ngJwtAuthInterfaces.ts

@@ -92,8 +92,8 @@ module NgJwtAuth {
         (subClaim:string, tokenData:IJwtClaims): ng.IPromise<IUser>;
     }
 
-    export interface ILoginListener {
-        (user:IUser):any;
+    export interface IUserEventListener {
+        (user:IUser):void;
     }
 
     export interface IBase64Service {

src/ngJwtAuthService.ts

@@ -5,7 +5,8 @@ module NgJwtAuth {
         //private properties
         private userFactory:IUserFactory;
         private loginPromptFactory:ILoginPromptFactory;
-        private loginListeners:ILoginListener[] = [];
+        private loginListeners:IUserEventListener[] = [];
+        private logoutListeners:IUserEventListener[] = [];
         private userLoggedInPromise:ng.IPromise<any>;
 
         private refreshTimerPromise:ng.IPromise<any>;
@@ -513,9 +514,7 @@ module NgJwtAuth {
          */
         private handleLogin(user:IUser):void {
 
-            _.each(this.loginListeners, (listener:ILoginListener) => {
-                listener(user);
-            });
+            _.invoke(this.loginListeners, _.call, null, user);
 
         }
 
@@ -660,6 +659,9 @@ module NgJwtAuth {
         public logout():void {
             this.clearJWTToken();
             this.loggedIn = false;
+
+            //call all logout listeners with user that is logged out
+            _.invoke(this.logoutListeners, _.call, null, this.user);
             this.user = null;
         }
 
@@ -668,10 +670,18 @@ module NgJwtAuth {
          * Register a login listener function
          * @param loginListener
          */
-        public registerLoginListener(loginListener:ILoginListener):void {
+        public registerLoginListener(loginListener:IUserEventListener):void {
             this.loginListeners.push(loginListener);
         }
 
+        /**
+         * Register a logout listener function
+         * @param logoutListener
+         */
+        public registerLogoutListener(logoutListener:IUserEventListener):void {
+            this.logoutListeners.push(logoutListener);
+        }
+
         /**
          * Get a user's token given their identifier
          * @param userIdentifier

test/test.ts

@@ -358,6 +358,28 @@ describe('Service tests', () => {
 
     });
 
+    describe('Logout listening', () => {
+
+        let mockListener = sinon.stub();
+
+        it('should be able to register a logout listener', () => {
+
+            ngJwtAuthService.registerLogoutListener(mockListener);
+
+            expect(mockListener).not.to.have.been.called;
+
+        });
+
+        it('should notify the logout listener', () => {
+
+            ngJwtAuthService.logout();
+
+            expect(mockListener).to.have.been.called;
+
+        });
+
+    });
+
     describe('Failed authentication', () => {