@xylex-group/athena-auth-ui/plugins
HeroUI-specific plugin helpers plus standalone components that are primarily used when those plugins are enabled.
Import
import { ExampleExport } from "@xylex-group/athena-auth-ui/plugins"Exported Docs
- AdminCredentialsCard: Workspace card for creating admin API keys and Athena client credentials from the security surface.
- apiKeyPlugin: HeroUI plugin wrapper that mounts the API keys security card on top of the core API key plugin behavior.
- ApiKeys: Security card for listing, creating, and revoking API keys when the API key plugin is enabled.
- Appearance: Account settings card for browsing and changing the current UI theme.
- AuditLogCard: Workspace card that lists recent security and admin actions from Athena Auth.
- 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. - DangerZone: Security settings card that exposes destructive account deletion actions from the delete-user plugin.
- DeleteUser: Standalone delete-user confirmation surface used by the delete-user plugin.
- deleteUserPlugin: HeroUI plugin wrapper that mounts the delete-user danger zone inside security settings.
- 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.
- InboxCard: Workspace card that shows recent inbound support or auth-related mailbox messages.
- MagicLink: Passwordless sign-in card that sends a magic link email instead of collecting a password.
- magicLinkPlugin: HeroUI plugin wrapper that registers the magic-link view, button, and passwordless sign-in fallback.
- ManageAccount: Single account row/card used by the multi-session account management surface.
- ManageAccounts: Account settings card for browsing and managing multiple signed-in sessions.
- methodCategory: Maps an Athena auth method path to a coarse category for the SDK lab UI.
- multiSessionPlugin: HeroUI plugin wrapper that adds account management cards and user-menu session switching.
- 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.
- organizationPlugin: HeroUI pass-through wrapper around the core organization plugin so consumers can keep plugin imports local to this package.
- OrganizationSettings: Public HeroUI component for organization settings.
- passkeyPlugin: HeroUI plugin wrapper that adds passkey buttons to auth flows and passkey management to security settings.
- Passkeys: Security settings card for listing, registering, and deleting WebAuthn passkeys.
- PastEmailsCard: Workspace card that shows recently sent account lifecycle and authentication emails.
- SdkMethodLabCard: Workspace card for exercising Athena auth and admin SDK methods with session-aware sample payloads.
- SignInUsername: Username-based sign-in card registered by the username plugin.
- SwitchAccountSubmenu: User menu entry that opens the multi-session account switcher submenu.
- SwitchAccountSubmenuContent: Dropdown content container for the multi-session account switcher submenu.
- SwitchAccountSubmenuItem: Individual selectable session row used inside the account switcher submenu.
- themePlugin: HeroUI plugin wrapper that bridges theme state into account cards and the authenticated user menu.
- ThemeToggleItem: User menu item that lets the current user switch themes from the authenticated dropdown.
- 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.
- useResolvedAuthUiOptions: Public React hook for resolved auth ui options in the workspace toolset.
- UsernameField: HeroUI field renderer injected when the username plugin adds a username field to auth forms.
- usernamePlugin: HeroUI plugin wrapper that swaps in a username field renderer and a username-based sign-in 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.
- workspacePlugin: HeroUI plugin wrapper that registers the workspace settings tabs, localized labels, and custom workspace view paths.
- 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.