@adonis-agora/authkit-react
Version:
Frontend ergonomics over AuthKit for AdonisJS + Inertia + React apps: a typed useAuth() hook, role-gating hooks and gating components.
97 lines (96 loc) • 4.34 kB
TypeScript
import type { AccountAppsResult, AccountLoginMethodsResult, AccountMe, AccountMfaStatus, AccountOrgDetail, AccountOrgInvitationsResult, AccountOrgsResult, AccountPasskeysResult, AccountSecurityOverview, AccountSessionsResult, AccountTokensResult, ChangePasswordInput, CreatedPatResult, CreateTokenInput, EmailChangeResult, OkResult, RemovePasskeyResult, RequestEmailChangeInput, RevokeAllResult, RevokeAppResult, RevokeOthersResult, RevokeSessionResult, RevokeTokenResult, UpdateLoginMethodsResult, UpdateProfileInput, UpdateProfileResult, UserLoginMethodsInput } from '../../client/types.js';
export declare function useMeQueryOptions(): {
queryKey: readonly ["authkit", "account", "me"];
queryFn: () => Promise<AccountMe>;
};
export declare function useSecurityQueryOptions(): {
queryKey: readonly ["authkit", "account", "security"];
queryFn: () => Promise<AccountSecurityOverview>;
};
export declare function useUpdateProfileMutationOptions(): {
mutationKey: string[];
mutationFn: (data: UpdateProfileInput) => Promise<UpdateProfileResult>;
};
export declare function useChangePasswordMutationOptions(): {
mutationKey: string[];
mutationFn: (data: ChangePasswordInput) => Promise<OkResult>;
};
export declare function useEmailChangeMutationOptions(): {
mutationKey: string[];
mutationFn: (data: RequestEmailChangeInput) => Promise<EmailChangeResult>;
};
export declare function useCancelEmailChangeMutationOptions(): {
mutationKey: string[];
mutationFn: () => Promise<OkResult>;
};
export declare function useAccountSessionsQueryOptions(): {
queryKey: readonly ["authkit", "account", "sessions"];
queryFn: () => Promise<AccountSessionsResult>;
};
export declare function useRevokeSessionMutationOptions(): {
mutationKey: string[];
mutationFn: (id: string) => Promise<RevokeSessionResult>;
};
export declare function useRevokeOtherSessionsMutationOptions(): {
mutationKey: string[];
mutationFn: () => Promise<RevokeOthersResult>;
};
export declare function useAccountRevokeAllSessionsMutationOptions(): {
mutationKey: string[];
mutationFn: () => Promise<RevokeAllResult>;
};
export declare function useAppsQueryOptions(): {
queryKey: readonly ["authkit", "account", "apps"];
queryFn: () => Promise<AccountAppsResult>;
};
export declare function useRevokeAppMutationOptions(): {
mutationKey: string[];
mutationFn: (clientId: string) => Promise<RevokeAppResult>;
};
export declare function useMfaQueryOptions(): {
queryKey: readonly ["authkit", "account", "mfa"];
queryFn: () => Promise<AccountMfaStatus>;
};
export declare function useLoginMethodsQueryOptions(): {
queryKey: readonly ["authkit", "account", "login-methods"];
queryFn: () => Promise<AccountLoginMethodsResult>;
};
export declare function useUpdateLoginMethodsMutationOptions(): {
mutationKey: string[];
mutationFn: (data: {
methods: UserLoginMethodsInput;
}) => Promise<UpdateLoginMethodsResult>;
};
export declare function usePasskeysQueryOptions(): {
queryKey: readonly ["authkit", "account", "passkeys"];
queryFn: () => Promise<AccountPasskeysResult>;
};
export declare function useRemovePasskeyMutationOptions(): {
mutationKey: string[];
mutationFn: (id: string) => Promise<RemovePasskeyResult>;
};
export declare function useTokensQueryOptions(): {
queryKey: readonly ["authkit", "account", "tokens"];
queryFn: () => Promise<AccountTokensResult>;
};
export declare function useCreateTokenMutationOptions(): {
mutationKey: string[];
mutationFn: (data?: CreateTokenInput) => Promise<CreatedPatResult>;
};
export declare function useRevokeTokenMutationOptions(): {
mutationKey: string[];
mutationFn: (id: string) => Promise<RevokeTokenResult>;
};
export declare function useAccountOrgsQueryOptions(): {
queryKey: readonly ["authkit", "account", "orgs"];
queryFn: () => Promise<AccountOrgsResult>;
};
export declare function useAccountOrgQueryOptions(id: string): {
queryKey: readonly ["authkit", "account", "orgs", string];
queryFn: () => Promise<AccountOrgDetail>;
enabled: boolean;
};
export declare function useAccountOrgInvitationsQueryOptions(): {
queryKey: readonly ["authkit", "account", "orgs", "invitations"];
queryFn: () => Promise<AccountOrgInvitationsResult>;
};