interfaces.ts

/*
 * @forgerock/javascript-sdk
 *
 * interfaces.ts
 *
 * Copyright (c) 2020 - 2025 Ping Identity Corporation. All rights reserved.
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

import type HiddenValueCallback from '../fr-auth/callbacks/hidden-value-callback';
import type MetadataCallback from '../fr-auth/callbacks/metadata-callback';
import type TextOutputCallback from '../fr-auth/callbacks/text-output-callback';

enum AttestationType {
  Direct = 'direct',
  Indirect = 'indirect',
  None = 'none',
}

interface DeviceStepState extends StepState {
  value1: number;
  value2: number;
}

enum UserVerificationType {
  Discouraged = 'discouraged',
  Preferred = 'preferred',
  Required = 'required',
}

interface RelyingParty {
  name: string;
  id?: string;
}

interface ResponseCredential {
  response: { clientDataJSON: ArrayBuffer };
}

interface Step<TData, TState> {
  data?: TData;
  state: TState;
  type: StepType;
}

interface StepState {
  authId: string;
}

enum StepType {
  DeviceAuthentication = 'DeviceAuthentication',
  DeviceRegistration = 'DeviceRegistration',
  DeviceRegistrationChoice = 'DeviceRegistrationChoice',
  LoginFailure = 'LoginFailure',
  LoginSuccess = 'LoginSuccess',
  OneTimePassword = 'OneTimePassword',
  SecondFactorChoice = 'SecondFactorChoice',
  Username = 'Username',
  UsernamePassword = 'UsernamePassword',
  UserPassword = 'UserPassword',
}

interface WebAuthnRegistrationMetadata {
  attestationPreference: 'none' | 'indirect' | 'direct';
  authenticatorSelection: string;
  challenge: string;
  excludeCredentials: string;
  pubKeyCredParams: string;
  relyingPartyId: string;
  relyingPartyName: string;
  timeout: number;
  userId: string;
  userName: string;
  displayName?: string;
  supportsJsonResponse?: boolean;
}

interface WebAuthnAuthenticationMetadata {
  _action?: 'webauthn_authentication';
  acceptableCredentials?: string;
  allowCredentials?: string;
  _allowCredentials?: PublicKeyCredentialDescriptor[];
  challenge: string;
  relyingPartyId: string;
  _relyingPartyId?: string;
  timeout: number;
  userVerification: UserVerificationType;
  mediation?: string;
  extensions?: Record<string, unknown>;
  _type?: 'WebAuthn';
  supportsJsonResponse?: boolean;
}

interface WebAuthnCallbacks {
  hiddenCallback?: HiddenValueCallback;
  metadataCallback?: MetadataCallback;
  textOutputCallback?: TextOutputCallback;
}

type WebAuthnTextOutputRegistration = string;

interface ParsedCredential {
  id: ArrayBuffer;
  type: 'public-key';
}

export type {
  DeviceStepState,
  ParsedCredential,
  RelyingParty,
  ResponseCredential,
  Step,
  WebAuthnCallbacks,
  WebAuthnAuthenticationMetadata,
  WebAuthnRegistrationMetadata,
  WebAuthnTextOutputRegistration,
};
export { AttestationType, StepType, UserVerificationType };