feat: introduce ErrorTimeout

docs/oidc-client-ts.api.md

@@ -103,6 +103,12 @@ export class ErrorResponse extends Error {
     state?: unknown;
 }
 
+// @public
+export class ErrorTimeout extends Error {
+    constructor(message?: string);
+    readonly name: string;
+}
+
 // @public (undocumented)
 export type ExtraSigninRequestArgs = Pick<CreateSigninRequestArgs, "extraQueryParams" | "extraTokenParams" | "state">;
 

src/errors/ErrorTimeout.ts

@@ -0,0 +1,16 @@
+// Copyright (C) 2021 AuthTS Contributors
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+/**
+ * Error class thrown in case of network timeouts (e.g IFrame time out).
+ *
+ * @public
+ */
+export class ErrorTimeout extends Error {
+    /** Marker to detect class: "ErrorTimeout" */
+    public readonly name: string = "ErrorTimeout";
+
+    public constructor(message?: string) {
+        super(message);
+    }
+}

src/errors/index.ts

@@ -1 +1,2 @@
-export * from "./ErrorResponse";
+export * from "./ErrorResponse";
+export * from "./ErrorTimeout";

src/index.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Brock Allen & Dominick Baier. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
 
-export { ErrorResponse } from "./errors";
+export { ErrorResponse, ErrorTimeout } from "./errors";
 export type { IFrameWindowParams, PopupWindowParams, RedirectParams } from "./navigators";
 export { Log, Logger } from "./utils";
 export type { ILogger, PopupWindowFeatures } from "./utils";

src/navigators/IFrameWindow.ts

@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
 
 import { Logger } from "../utils";
+import { ErrorTimeout } from "../errors";
 import type { NavigateParams, NavigateResponse } from "./IWindow";
 import { AbstractChildWindow } from "./AbstractChildWindow";
 
@@ -45,7 +46,7 @@ export class IFrameWindow extends AbstractChildWindow {
 
     public async navigate(params: NavigateParams): Promise<NavigateResponse> {
         this._logger.debug("navigate: Using timeout of:", this._timeoutInSeconds);
-        const timer = setTimeout(() => this._abort.raise(new Error("IFrame timed out without a response")), this._timeoutInSeconds * 1000);
+        const timer = setTimeout(() => this._abort.raise(new ErrorTimeout("IFrame timed out without a response")), this._timeoutInSeconds * 1000);
         this._disposeHandlers.add(() => clearTimeout(timer));
 
         return await super.navigate(params);