Interface FidoClient

Reusable client for FIDO operations.

interface FidoClient {
    authenticate(
        options: FidoAuthenticationOptions,
    ): Promise<FidoAuthenticationResult>;
    authenticateForDaVinci(
        daVinci: DaVinciInstance,
        options?: FidoDaVinciAuthenticationOptions,
    ): Promise<FidoDaVinciResult>;
    authenticateForJourney(
        journey: JourneyInstance,
        options?: FidoJourneyAuthenticationOptions,
    ): Promise<FidoJourneyResult>;
    register(options: FidoRegistrationOptions): Promise<FidoRegistrationResult>;
    registerForDaVinci(
        daVinci: DaVinciInstance,
        options?: FidoDaVinciRegistrationOptions,
    ): Promise<FidoDaVinciResult>;
    registerForJourney(
        journey: JourneyInstance,
        options?: FidoJourneyRegistrationOptions,
    ): Promise<FidoJourneyResult>;
}

Index

Methods

authenticate authenticateForDaVinci authenticateForJourney register registerForDaVinci registerForJourney

Methods

authenticate

authenticate(
options: FidoAuthenticationOptions,
): Promise<FidoAuthenticationResult>
Authenticates with an existing FIDO credential using native platform APIs.
Parameters
- options: FidoAuthenticationOptions
  Authentication options payload.
Returns Promise<FidoAuthenticationResult>
A promise that resolves to the authentication result payload.

Throws
FidoError when native authentication fails.
- Defined in packages/fido/src/types/fido.types.ts:295

authenticateForDaVinci

authenticateForDaVinci(
daVinci: DaVinciInstance,
options?: FidoDaVinciAuthenticationOptions,
): Promise<FidoDaVinciResult>
Runs the native FIDO passkey ceremony for an active DaVinci FIDO2 authentication collector.
Parameters
- daVinci: DaVinciInstance
  Active DaVinci instance.
- Optionaloptions: FidoDaVinciAuthenticationOptions
  Optional authentication ceremony options.
Returns Promise<FidoDaVinciResult>
A promise that resolves to the WebAuthn assertion payload. Informational only — submit natively by advancing the flow with daVinci.next({ collectors: [] }).

Throws
FidoError when the ceremony fails or the collector cannot be resolved.
- Defined in packages/fido/src/types/fido.types.ts:344

authenticateForJourney

authenticateForJourney(
journey: JourneyInstance,
options?: FidoJourneyAuthenticationOptions,
): Promise<FidoJourneyResult>
Executes an active Journey FIDO authentication callback.
Parameters
- journey: JourneyInstance
  Active Journey instance.
- Optionaloptions: FidoJourneyAuthenticationOptions
  Optional authentication callback execution options.
Returns Promise<FidoJourneyResult>
A promise that resolves when callback execution succeeds.

Throws
FidoError when native callback execution fails.
- Defined in packages/fido/src/types/fido.types.ts:318

register

register(options: FidoRegistrationOptions): Promise<FidoRegistrationResult>
Registers a new FIDO credential using native platform APIs.
Parameters
- options: FidoRegistrationOptions
  Registration options payload.
Returns Promise<FidoRegistrationResult>
A promise that resolves to the registration result payload.

Throws
FidoError when native registration fails.
- Defined in packages/fido/src/types/fido.types.ts:287

registerForDaVinci

registerForDaVinci(
daVinci: DaVinciInstance,
options?: FidoDaVinciRegistrationOptions,
): Promise<FidoDaVinciResult>
Runs the native FIDO passkey ceremony for an active DaVinci FIDO2 registration collector.
Parameters
- daVinci: DaVinciInstance
  Active DaVinci instance.
- Optionaloptions: FidoDaVinciRegistrationOptions
  Optional registration ceremony options.
Returns Promise<FidoDaVinciResult>
A promise that resolves to the WebAuthn attestation payload. Informational only — submit natively by advancing the flow with daVinci.next({ collectors: [] }).

Throws
FidoError when the ceremony fails or the collector cannot be resolved.
- Defined in packages/fido/src/types/fido.types.ts:331

registerForJourney

registerForJourney(
journey: JourneyInstance,
options?: FidoJourneyRegistrationOptions,
): Promise<FidoJourneyResult>
Executes an active Journey FIDO registration callback.
Parameters
- journey: JourneyInstance
  Active Journey instance.
- Optionaloptions: FidoJourneyRegistrationOptions
  Optional registration callback execution options.
Returns Promise<FidoJourneyResult>
A promise that resolves when callback execution succeeds.

Throws
FidoError when native callback execution fails.
- Defined in packages/fido/src/types/fido.types.ts:306