@ovok/native/auth

Sign-in, registration, password reset, profile and session components and hooks.

Import from @ovok/native/auth.

ComponentsCopy Anchor Link

DeleteAccountButton()Copy Anchor Link

function DeleteAccountButton(__namedParameters): Element;

Button that asks for confirmation, then deletes the account and signs out.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

LogoutButton()Copy Anchor Link

function LogoutButton(__namedParameters): Element;

Button or row that signs the user out.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

ProfileForm()Copy Anchor Link

function ProfileForm(props): Element;

Profile form wrapped in its provider.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

Register()Copy Anchor Link

function Register(props): Element;

Scrollable registration screen layout; compose it with the Register.* parts.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

ResetPassword()Copy Anchor Link

function ResetPassword(props): Element;

Scrollable reset password screen layout; compose it with the ResetPassword.* parts.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

SessionList()Copy Anchor Link

function SessionList(__namedParameters): Element;

Lists the active sessions and lets the user sign out the other devices.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

SignIn()Copy Anchor Link

function SignIn(props): Element;

Scrollable sign-in screen layout; compose it with the SignIn.* parts.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

HooksCopy Anchor Link

useAcceptInviteLink()Copy Anchor Link

function useAcceptInviteLink(__namedParameters): object;

Accepts an invite link, or creates a carer account from a record-share invite.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

useAuthAction()Copy Anchor Link

function useAuthAction<TArgs, TResult>(action): Omit<AuthActionState<TResult>, "run"> & object;

Wraps an async auth action with status, loading and error state; concurrent runs share one call.

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Omit<AuthActionState<TResult>, "run"> & object

useDeleteAccount()Copy Anchor Link

function useDeleteAccount(__namedParameters?): Omit<AuthActionState<void>, "run"> & object;

Deletes the signed-in account and signs out.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Omit<AuthActionState<void>, "run"> & object

useRateLimitCooldown()Copy Anchor Link

function useRateLimitCooldown(until?): number;

Returns the milliseconds left until until (epoch milliseconds), updating every second.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

number

useSession()Copy Anchor Link

function useSession(__namedParameters?): UseSessionResult;

Tracks the current Ovok session, saved accounts and profile.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

UseSessionResult

useSignIn()Copy Anchor Link

function useSignIn(options): object;

Signs in with email and password and verifies the MFA challenge when one is required.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

useSignOut()Copy Anchor Link

function useSignOut(): Omit<AuthActionState<void>, "run"> & object;

Signs out the current session.

ReturnsCopy Anchor Link

Omit<AuthActionState<void>, "run"> & object

useSocialSignIn()Copy Anchor Link

function useSocialSignIn(options): Omit<AuthActionState<Session>, "run"> & object;

Signs in with Google or Apple and exchanges the credentials for an Ovok session.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Omit<AuthActionState<Session>, "run"> & object

FunctionsCopy Anchor Link

getRateLimitDetails()Copy Anchor Link

function getRateLimitDetails(error): RateLimitDetails | undefined;

Supports @ovok/core's typed error while remaining compatible with HTTP 429 adapters.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

RateLimitDetails | undefined

isNetworkError()Copy Anchor Link

function isNetworkError(error, message?): boolean;

Whether the error, or its message, indicates a network failure.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

parseInviteLink()Copy Anchor Link

function parseInviteLink(link): AcceptInviteBody;

Reads invite and code from an …/accept-invite?invite=…&code=… link.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

AcceptInviteBody

parseSignInError()Copy Anchor Link

function parseSignInError(error, options?): ParsedSignInError;

Converts auth transport/server failures to safe, translatable error keys.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

ParsedSignInError

setRateLimitFormError()Copy Anchor Link

function setRateLimitFormError<T>(error, helpers): RateLimitDetails | undefined;

Writes the rate limit error and cooldown deadline to the Formik form; returns the details, or undefined when the error is not a rate limit.

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

RateLimitDetails | undefined

InterfacesCopy Anchor Link

AcceptInviteLinkOptionsCopy Anchor Link

Options of useAcceptInviteLink.

PropertiesCopy Anchor Link

AuthActionStateCopy Anchor Link

State of an auth action.

Type ParametersCopy Anchor Link

PropertiesCopy Anchor Link

DeleteAccountOptionsCopy Anchor Link

Options of useDeleteAccount.

PropertiesCopy Anchor Link

ParsedSignInErrorCopy Anchor Link

Sign-in error and the per-field errors parsed from it.

PropertiesCopy Anchor Link

RateLimitDetailsCopy Anchor Link

Rate limit information extracted from an error.

PropertiesCopy Anchor Link

SignInCredentialsCopy Anchor Link

Email and password to sign in with.

PropertiesCopy Anchor Link

UseSessionOptionsCopy Anchor Link

Options of useSession.

PropertiesCopy Anchor Link

UseSessionResultCopy Anchor Link

Session state and actions returned by useSession.

ExtendsCopy Anchor Link

• SessionSnapshot

PropertiesCopy Anchor Link

Type AliasesCopy Anchor Link

AppleLoginPropsCopy Anchor Link

type AppleLoginProps = Omit<TouchableOpacityProps, "onPress" | "onPressIn" | "onPressOut" | "onLongPress" | "children"> & object;

Props of SignIn.SocialLogins.AppleLogin.

Type DeclarationCopy Anchor Link

AuthActionStatusCopy Anchor Link

type AuthActionStatus = "idle" | "loading" | "success" | "error";

Stage of an auth action.

FooterPropsCopy Anchor Link

type FooterProps = object;

Props of the sign-in footer.

PropertiesCopy Anchor Link

testID?Copy Anchor Link

testID?: string;

Test identifier of the footer.

GoogleLoginPropsCopy Anchor Link

type GoogleLoginProps = Omit<TouchableOpacityProps, "onPress" | "onPressIn" | "onPressOut" | "onLongPress" | "children"> & object;

Props of SignIn.SocialLogins.GoogleLogin.

Type DeclarationCopy Anchor Link

LoginFormPropsCopy Anchor Link

type LoginFormProps = object & (
  | {
  onError?: (error) => void;
  onSubmit?: undefined;
  onSuccess?: (response) => void;
}
  | {
  onError?: undefined;
  onSubmit?: (values, formikHelpers) => Promise<void>;
  onSuccess?: undefined;
}) & (
  | {
  loginType: "Patient" | "RelatedPerson";
  tenantCode: string;
}
  | {
  loginType: "Practitioner";
  tenantCode?: string;
});

Props of the sign-in form.

Type DeclarationCopy Anchor Link

LoginWithSeparatorPropsCopy Anchor Link

type LoginWithSeparatorProps = object;

Props of the sign-in separator.

PropertiesCopy Anchor Link

lineColor?Copy Anchor Link

lineColor?: string;

Color of the separator lines.

testID?Copy Anchor Link

testID?: string;

Test identifier of the separator.

textColor?Copy Anchor Link

textColor?: string;

Color of the separator text.

ProfileFormFieldCopy Anchor Link

type ProfileFormField = ProfileFormFieldBase & (
  | {
  options: object[];
  type: "select";
}
  | {
  display?: DateFieldProps["display"];
  formatValue?: DateFieldProps["formatValue"];
  initialDate?: DateFieldProps["initialDate"];
  locale?: DateFieldProps["locale"];
  maximumDate?: DateFieldProps["maximumDate"];
  minimumDate?: DateFieldProps["minimumDate"];
  mode?: DateFieldProps["mode"];
  type: "date";
}
  | {
  inputProps?: TextInputFieldProps;
  keyboardType?: TextInputProps["keyboardType"];
  type: "text";
}
  | {
  options: object[];
  type: "choice";
}
  | {
  countryName?: (code, language) => string;
  defaultCountry: CountryCode;
  type: "phone";
});

Field definition of the profile form, discriminated by type.

ProfileFormPropsCopy Anchor Link

type ProfileFormProps = object;

Props of the profile form.

PropertiesCopy Anchor Link

fieldsCopy Anchor Link

fields: ProfileFormField[];

Fields to render and edit.

onError?Copy Anchor Link

onError?: (error) => void;

Called when saving fails.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

onSubmit?Copy Anchor Link

onSubmit?: (values, formikHelpers) => Promise<void> | void;

Replaces the default save; use it to handle the submitted values yourself.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void> | void

onSuccess?Copy Anchor Link

onSuccess?: (response, values) => Promise<void> | void;

Called with the updated patient and the submitted values after a successful save.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void> | void

style?Copy Anchor Link

style?: StyleProp<ViewStyle>;

Style of the form container.

testID?Copy Anchor Link

testID?: string;

Test identifier of the form.

ProfileFormValuesCopy Anchor Link

type ProfileFormValues = object;

Profile form values keyed by field name.

IndexableCopy Anchor Link

[key: string]: string

PropertiesCopy Anchor Link

submitCopy Anchor Link

submit: string;

Holds the submit error message.

RegisterFormValuesCopy Anchor Link

type RegisterFormValues = PatientRegistration & object;

Registration values plus form-only fields.

Type DeclarationCopy Anchor Link

ResetPasswordButtonPropsCopy Anchor Link

type ResetPasswordButtonProps = AuthSubmitButtonProps;

Props of the reset password submit button.

ResetPasswordContextTypeCopy Anchor Link

type ResetPasswordContextType = ReturnType<typeof useFormik> & object;

Formik state of the reset password form.

Type DeclarationCopy Anchor Link

ResetPasswordFormValuesCopy Anchor Link

type ResetPasswordFormValues = object;

Values of the reset password form.

PropertiesCopy Anchor Link

emailCopy Anchor Link

email: string;

Account email.

submitCopy Anchor Link

submit: string;

Holds the submit error message.

typeCopy Anchor Link

type: "Patient" | "Practitioner" | "RelatedPerson";

Profile type of the account.

ResetPasswordHeaderPropsCopy Anchor Link

type ResetPasswordHeaderProps = AuthHeaderProps;

Props of the reset password header.

ResetPasswordPropsCopy Anchor Link

type ResetPasswordProps = KeyboardAwareScrollViewProps;

Props of ResetPassword.

SessionListPropsCopy Anchor Link

type SessionListProps = ViewProps & object;

Props of SessionList: view props plus an error callback.

Type DeclarationCopy Anchor Link

SigninButtonPropsCopy Anchor Link

type SigninButtonProps = AuthSubmitButtonProps;

Props of the sign-in submit button.

SignInErrorCopy Anchor Link

type SignInError = Error & object;

Error enriched with the HTTP status and request details of a failed sign-in.

Type DeclarationCopy Anchor Link

SigninFormForgotPasswordPropsCopy Anchor Link

type SigninFormForgotPasswordProps<TVariant> = TouchableOpacityProps & object;

Props of the forgot password link.

Type ParametersCopy Anchor Link

Type DeclarationCopy Anchor Link

SignInHeaderPropsCopy Anchor Link

type SignInHeaderProps = AuthHeaderProps;

Props of the sign-in header.

SignInOptionsCopy Anchor Link

type SignInOptions =
  | {
  tenantCode: string;
  type: "Patient" | "RelatedPerson";
}
  | {
  tenantCode?: string;
  type: "Practitioner";
};

Profile type and tenant to sign in to.

Union MembersCopy Anchor Link

Type LiteralCopy Anchor Link

{
  tenantCode: string;
  type: "Patient" | "RelatedPerson";
}

Type LiteralCopy Anchor Link

{
  tenantCode?: string;
  type: "Practitioner";
}

SignInPropsCopy Anchor Link

type SignInProps = KeyboardAwareScrollViewProps;

Props of SignIn.

SocialLoginsPropsCopy Anchor Link

type SocialLoginsProps = object;

Props of SocialLogins.

PropertiesCopy Anchor Link

style?Copy Anchor Link

style?: StyleProp<ViewStyle>;

Style of the container.

testID?Copy Anchor Link

testID?: string;

Test identifier of the container.

SocialSignInOptionsCopy Anchor Link

type SocialSignInOptions =
  | {
  googleIosClientId: string;
  googleWebClientId: string;
  internalId: string;
  provider: "google";
}
  | {
  internalId: string;
  provider: "apple";
};

Social provider and its configuration.

Union MembersCopy Anchor Link

Type LiteralCopy Anchor Link

{
  googleIosClientId: string;
  googleWebClientId: string;
  internalId: string;
  provider: "google";
}

Type LiteralCopy Anchor Link

{
  internalId: string;
  provider: "apple";
}

SpacingPropsCopy Anchor Link

type SpacingProps = ViewProps & object;

Props of Spacing: view props plus the flex share.

Type DeclarationCopy Anchor Link

VariablesCopy Anchor Link

DEFAULT_RATE_LIMIT_RETRY_MSCopy Anchor Link

const DEFAULT_RATE_LIMIT_RETRY_MS: 60000 = 60_000;

Retry delay used when the error carries none.

GOOGLE_RETURN_PAGE_HTMLCopy Anchor Link

const GOOGLE_RETURN_PAGE_HTML: string;

The page Google returns to when GoogleLogin signs in on the web.

Serve it as a static file at the redirect URI, by default /oauth/google.html. It keeps Google's answer for this tab and sends the tab back to the sign-in screen, so the token never stays in the address.

RATE_LIMIT_MESSAGE_KEYCopy Anchor Link

const RATE_LIMIT_MESSAGE_KEY: "auth.rate-limit" = "auth.rate-limit";

Translation key of the rate limit message.