- Add support for OIDC session management error status

Author: nimevio-buchner

docs/oidc-client-ts.api.md

@@ -941,6 +941,8 @@ export class UserManagerEvents extends AccessTokenEvents {
     addSilentRenewError(cb: SilentRenewErrorCallback): () => void;
     addUserLoaded(cb: UserLoadedCallback): () => void;
     addUserSessionChanged(cb: UserSessionChangedCallback): () => void;
+    // Warning: (ae-forgotten-export) The symbol "UserSessionErrorCallback" needs to be exported by the entry point index.d.ts
+    addUserSessionError(cb: UserSessionErrorCallback): () => void;
     addUserSignedIn(cb: UserSignedInCallback): () => void;
     addUserSignedOut(cb: UserSignedOutCallback): () => void;
     addUserUnloaded(cb: UserUnloadedCallback): () => void;
@@ -953,12 +955,15 @@ export class UserManagerEvents extends AccessTokenEvents {
     // @internal (undocumented)
     _raiseUserSessionChanged(): void;
     // @internal (undocumented)
+    _raiseUserSessionError(): void;
+    // @internal (undocumented)
     _raiseUserSignedIn(): void;
     // @internal (undocumented)
     _raiseUserSignedOut(): void;
     removeSilentRenewError(cb: SilentRenewErrorCallback): void;
     removeUserLoaded(cb: UserLoadedCallback): void;
     removeUserSessionChanged(cb: UserSessionChangedCallback): void;
+    removeUserSessionError(cb: UserSessionErrorCallback): void;
     removeUserSignedIn(cb: UserSignedInCallback): void;
     removeUserSignedOut(cb: UserSignedOutCallback): void;
     removeUserUnloaded(cb: UserUnloadedCallback): void;

src/UserManagerEvents.test.ts

@@ -59,5 +59,19 @@ describe("UserManagerEvents", () => {
             // assert
             expect(e).toEqual(expected);
         });
+
+        it("should pass error to callback", () => {
+            // arrange
+            const e: Error | null = null;
+            const cb = jest.fn();
+            const expected = new Error("boom");
+
+            // act
+            subject.addUserSessionError(cb);
+            subject._raiseUserSessionError();
+
+            // assert
+            expect(e).toEqual(expected);
+        });
     });
 });

src/UserManagerEvents.ts

@@ -30,7 +30,10 @@ export type UserSignedOutCallback = () => Promise<void> | void;
  * @public
  */
 export type UserSessionChangedCallback = () => Promise<void> | void;
-
+/**
+ * @public
+ */
+export type UserSessionErrorCallback = () => Promise<void> | void;
 /**
  * @public
  */
@@ -43,6 +46,7 @@ export class UserManagerEvents extends AccessTokenEvents {
     private readonly _userSignedIn = new Event<[]>("User signed in");
     private readonly _userSignedOut = new Event<[]>("User signed out");
     private readonly _userSessionChanged = new Event<[]>("User session changed");
+    private readonly _userSessionError = new Event<[]>("User session error");
 
     public constructor(settings: UserManagerSettingsStore) {
         super({ expiringNotificationTimeInSeconds: settings.accessTokenExpiringNotificationTimeInSeconds });
@@ -163,4 +167,23 @@ export class UserManagerEvents extends AccessTokenEvents {
     public _raiseUserSessionChanged(): void {
         this._userSessionChanged.raise();
     }
+    /**
+     * Add callback: Raised when the user session changed (when `monitorSession` is set).
+     * @see {@link UserManagerSettings.monitorSession}
+     */
+    public addUserSessionError(cb: UserSessionErrorCallback): () => void {
+        return this._userSessionError.addHandler(cb);
+    }
+    /**
+     * Remove callback: Raised when the user session changed (when `monitorSession` is set).
+     */
+    public removeUserSessionError(cb: UserSessionErrorCallback): void {
+        this._userSessionError.removeHandler(cb);
+    }
+    /**
+     * @internal
+     */
+    public _raiseUserSessionError(): void {
+        this._userSessionError.raise();
+    }
 }