@nevis-security/nevis-mobile-authentication-sdk-react/src/error/authentication/AuthenticationFidoError.ts

React Native plugin for Nevis Mobile Authentication SDK. Supports only mobile.

/**
 * Copyright © 2023 Nevis Security AG. All rights reserved.
 */

import { AuthenticationError } from './AuthenticationError';
import { SessionProvider } from '../../authorization/SessionProvider';
import { FidoErrorCode } from '../FidoErrorCode';

/**
 * An error that indicates that a FIDO UAF error occurred during an operation.
 */
export class AuthenticationFidoError extends AuthenticationError {
	/**
	 * The FIDO UAF error that occurred.
	 */
	errorCode: FidoErrorCode;

	/**
	 * Provides details about the error that occurred.
	 */
	description: string;

	/**
	 * The exception (if any) that caused this error.
	 */
	cause?: string;

	/**
	 * The {@link SessionProvider} that can be used to continue with the operation.
	 */
	sessionProvider?: SessionProvider;

	/**
	 * The default constructor.
	 *
	 * @param errorCode the FIDO UAF error that occurred.
	 * @param description provides details about the error that occurred.
	 * @param cause the exception (if any) that caused this error.
	 * @param sessionProvider the {@link SessionProvider} that can be used to continue with the operation.
	 */
	constructor(
		errorCode: FidoErrorCode,
		description: string,
		cause?: string,
		sessionProvider?: SessionProvider
	) {
		super();
		this.errorCode = errorCode;
		this.description = description;
		this.cause = cause;
		this.sessionProvider = sessionProvider;
	}
}