Athena

@xylex-group/athena-auth-ui

Main HeroUI component surface for auth flows, settings views, workspace tooling, hooks, and utilities.

Import

import { ExampleExport } from "@xylex-group/athena-auth-ui"

Exported Docs

  • AccountSettings: Groups the built-in account profile and email management cards into the account settings view.
  • AccountSettingsPage: Ready-to-mount page shell for Account Settings with the package's default page layout.
  • ActiveSessions: Lists active sessions and exposes revoke actions from the built-in security settings surface.
  • AdditionalField: Renders plugin-defined auth fields inside the HeroUI forms when a plugin contributes extra field config.
  • AdminCredentialsCard: Workspace card for creating admin API keys and Athena client credentials from the security surface.
  • AuditLogCard: Workspace card that lists recent security and admin actions from Athena Auth.
  • Auth: Routes to the correct authentication screen based on a supplied view or route path.
  • AuthPage: Ready-to-mount page shell for Auth with the package's default page layout.
  • AuthProvider: Wraps the auth context with the HeroUI router bridge and shared toaster used by the package UI.
  • AuthUiProvider: Public HeroUI component for auth ui provider.
  • buildMethodCandidates: Builds fallback Athena method paths so the SDK lab can try both direct and auth.* method shapes.
  • ChangeEmail: Account settings card for changing the signed-in user's email address.
  • ChangePassword: Security settings card for changing the current user's password.
  • DocumentsCard: Workspace card for uploading documents and tracking their processing state.
  • EmailComposerCard: Workspace card for creating or editing outbound auth email records.
  • EmailFailuresCard: Workspace card for reviewing and managing failed email delivery records.
  • EmailTemplatesCard: Workspace card for editing email templates with preview-oriented metadata and variables.
  • ForgotPassword: Built-in card that requests a password reset email for an existing account.
  • ForgotPasswordPage: Ready-to-mount page shell for Forgot Password with the package's default page layout.
  • InboxCard: Workspace card that shows recent inbound support or auth-related mailbox messages.
  • LinkedAccounts: Security settings card for inspecting and unlinking connected social accounts.
  • methodCategory: Maps an Athena auth method path to a coarse category for the SDK lab UI.
  • normalizeMethodPath: Normalizes user-entered SDK lab method paths by trimming whitespace and collapsing spaces.
  • NotificationsCenterCard: Workspace card that shows recent notification history and mark-as-read controls.
  • OAuthAccountsCard: Workspace card for linked OAuth providers and on-demand token bundle lookups.
  • OrganizationCenterCard: Workspace card for organization creation, active-organization switching, members, and invitations.
  • OrganizationSettings: Public HeroUI component for organization settings.
  • PastEmailsCard: Workspace card that shows recently sent account lifecycle and authentication emails.
  • ProviderButton: Renders one social auth provider button with the package styling and provider metadata.
  • ProviderButtons: Renders the configured set of social auth provider buttons for sign-in or sign-up flows.
  • ResetPassword: Built-in card that completes a password reset using a reset token and new password.
  • ResetPasswordPage: Ready-to-mount page shell for Reset Password with the package's default page layout.
  • SdkMethodLabCard: Workspace card for exercising Athena auth and admin SDK methods with session-aware sample payloads.
  • SecuritySettings: Groups the built-in security cards together with any plugin-contributed security surfaces.
  • SecuritySettingsPage: Ready-to-mount page shell for Security Settings with the package's default page layout.
  • Settings: Routes to the correct settings view and renders the responsive settings navigation shell.
  • SettingsPage: Ready-to-mount page shell for Settings with the package's default page layout.
  • SignIn: Built-in email/password sign-in card with social provider buttons and plugin slot support.
  • SignInPage: Ready-to-mount page shell for Sign In with the package's default page layout.
  • SignOut: Sign-out surface that confirms the action and triggers the sign-out mutation.
  • SignOutPage: Ready-to-mount page shell for Sign Out with the package's default page layout.
  • SignUp: Built-in email/password sign-up card with social provider buttons and plugin slot support.
  • SignUpPage: Ready-to-mount page shell for Sign Up with the package's default page layout.
  • useAdminAthenaClients: Query hook for the list of admin-configured Athena clients available to the workspace tools.
  • useAdminAuditLogs: Convenience query hook for recent admin audit logs with a default limit of 20 rows.
  • useAdminAuditLogsQuery: Lower-level audit log query hook that accepts a partial Athena list query and normalizes the default limit.
  • useAdminEmailFailures: Convenience query hook for recent email delivery failures with a default limit of 15 rows.
  • useAdminEmailFailuresQuery: Lower-level email failure query hook that accepts a partial Athena list query and normalizes the default limit.
  • useAdminEmailTemplates: Convenience query hook for email templates with a default limit of 25 rows.
  • useAdminEmailTemplatesQuery: Lower-level email template query hook that accepts a partial Athena list query and normalizes the default limit.
  • useAdminPastEmails: Convenience query hook for recent outbound emails with a default limit of 15 rows.
  • useAdminPastEmailsQuery: Lower-level outbound email query hook that accepts a partial Athena list query and normalizes the default limit.
  • useAuthUiOptions: Public React hook for auth ui options in the workspace toolset.
  • useCreateAdminApiKey: Mutation hook that creates an admin API key through the Athena admin method surface.
  • useCreateAdminAthenaClient: Mutation hook that creates an Athena client and invalidates the Athena client list.
  • useCreateAdminEmailFailure: Mutation hook that creates a new email failure record and invalidates the failure list.
  • useDeleteAdminEmailFailure: Mutation hook that deletes an email failure record and invalidates the failure list.
  • useDeleteAdminEmailRecord: Mutation hook that deletes admin email records and invalidates the related email queries.
  • useDeleteEmailTemplate: Mutation hook that deletes an email template and invalidates the template list.
  • useFetchOAuthTokens: Mutation hook that fetches or refreshes OAuth provider token bundles from the auth client.
  • UserAvatar: Avatar renderer for the current user or another user-like record.
  • UserButton: Authenticated user trigger button that opens the user actions dropdown.
  • useResolvedAuthUiOptions: Public React hook for resolved auth ui options in the workspace toolset.
  • UserProfile: Account settings card for editing the current user profile fields.
  • UserView: Compact signed-in user summary view.
  • useUpdateAdminEmailFailure: Mutation hook that updates existing email failure records and invalidates the failure list.
  • useUpsertAdminEmailRecord: Mutation hook that creates or updates admin email records and invalidates the related email queries.
  • useUpsertEmailTemplate: Mutation hook that creates or updates email templates and invalidates the template list.
  • useWorkspaceRuntime: Stateful runtime hook that hydrates workspace preferences and activity from session data plus local storage.
  • useWorkspaceSession: Thin session hook with a 60 second stale window for the workspace experience.
  • WorkspaceActivityFeedCard: Workspace card that combines notifications, inbox activity, and uploaded documents into one activity stream.
  • WorkspaceCommunicationsPanel: Groups the email composer and template management cards for the workspace communications section.
  • WorkspaceCommunicationsSettings: Standalone settings-tab wrapper for the workspace communications section.
  • WorkspaceControlsCard: Workspace card for feature toggles, notification preferences, and preference snapshot state.
  • WorkspaceDocumentsPanel: Groups the document upload and document state card for the workspace documents section.
  • WorkspaceDocumentsSettings: Standalone settings-tab wrapper for the workspace documents section.
  • WorkspaceLogsPanel: Groups audit logs, email delivery history, and the workspace activity feed for the logs section.
  • WorkspaceLogsSettings: Standalone settings-tab wrapper for the workspace logs section.
  • WorkspaceNotificationsPanel: Groups workspace preferences, recent notifications, and inbox items for the notifications section.
  • WorkspaceNotificationsSettings: Standalone settings-tab wrapper for the workspace notifications section.
  • WorkspaceOperationsPanel: Groups organization and tenant administration tools for the workspace operations section.
  • WorkspaceOperationsSettings: Standalone settings-tab wrapper for the workspace operations section.
  • WorkspaceSdkLabPanel: Groups the Athena SDK experimentation surface for the workspace SDK lab section.
  • WorkspaceSdkLabSettings: Standalone settings-tab wrapper for the workspace sdk lab section.
  • WorkspaceSectionCard: Shared titled card wrapper used to frame the workspace-specific admin surfaces.
  • WorkspaceSecurityPanel: Groups session context, passkeys, API keys, admin credentials, OAuth accounts, and active sessions for the security section.
  • WorkspaceSecuritySettings: Standalone settings-tab wrapper for the workspace security section.
  • WorkspaceSettings: Aggregates the full workspace experience by stacking every workspace panel in a single settings view.