@nevis-security/nevis-mobile-authentication-sdk-react/src/operations/userverification/FingerprintUserVerificationContext.ts

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

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

import { UserVerificationContext } from './UserVerificationContext';
import type { FingerprintUserVerificationError } from '../../error/userVerification/FingerprintUserVerificationError';
import { FingerprintUserVerificationErrorConverter } from '../../error/userVerification/FingerprintUserVerificationErrorConverter';
import { Authenticator } from '../../localData/Authenticator';

/**
 * The object providing information about the biometric user verification (i.e. the user credential
 * validation) operation to be done.
 *
 * @see {@link FingerprintUserVerifier.verifyFingerprint}
 */
export abstract class FingerprintUserVerificationContext extends UserVerificationContext {
	/**
	 * When a recoverable error occurred during the last credential verification, this returns the
	 * object describing the last error.
	 */
	abstract lastRecoverableError?: FingerprintUserVerificationError;

	/**
	 * Alternate constructor that creates a {@link BiometricUserVerificationContext} from a json.
	 *
	 * @param json contains the source for instance creation.
	 * @returns a {@link BiometricUserVerificationContext} instance.
	 */
	static fromJson(json: any): FingerprintUserVerificationContext {
		return FingerprintUserVerificationContextImpl.fromJson(json);
	}
}

export class FingerprintUserVerificationContextImpl extends FingerprintUserVerificationContext {
	authenticator: Authenticator;
	lastRecoverableError?: FingerprintUserVerificationError;

	constructor(
		authenticator: Authenticator,
		lastRecoverableError?: FingerprintUserVerificationError
	) {
		super();
		this.authenticator = authenticator;
		this.lastRecoverableError = lastRecoverableError;
	}

	static fromJson(json: any): FingerprintUserVerificationContextImpl {
		const authenticator = Authenticator.fromJson(json.authenticator);
		const lastRecoverableError =
			json.lastRecoverableError &&
			new FingerprintUserVerificationErrorConverter(json.lastRecoverableError).convert();
		return new FingerprintUserVerificationContextImpl(authenticator, lastRecoverableError);
	}
}