auth-client
@rw3iss/auth-client — the browser SDK. Symbols below are grouped by feature; each entry links to its full reference.
Core SDK
AuthClient + the bits you wire up at boot: config, ports, snapshot, events.
Classes
Functions
Interfaces
Type aliases
Variables
Modules
The namespaced module API — client.auth, .account, .sessions, .users, .organizations, .apps, .services, .pools, .audit. The recommended SDK surface.
Classes
AccountModuleAppsModuleAuditModuleAuthModuleOrganizationsModulePoolsModuleServicesModuleSessionsModuleUsersModule
Flows
Internal per-endpoint-group wrappers the modules delegate to — login, registration, password, TOTP, SSO, magic link, sessions, admin, org, impersonation, audit log.
Classes
AdminFlowAppsFlowImpersonationFlowLoginFlowLogoutFlowM2MFlowRefreshFlowRegistrationFlowSsoFlowTotpFlow
Transport & ports
Pluggable adapters: HTTP transport, token stores, storage, crypto, broadcast, clock, logger.
Classes
BroadcastChannelAdapterConsoleLoggerFetchTransportFixedClockLocalStorageStorageLocalStorageTokenStoreMemoryStorageMemoryTokenStoreNoOpBroadcastNoOpLoggerSystemClockWebCryptoAdapter
Functions
Interfaces
BroadcastBroadcastMessageClockCryptoFetchTransportOptionsLoggerRetryOptionsStorageTokenStoreTransportTransportRequestTransportResponse
Errors
Typed exception hierarchy — match on instances rather than strings.
Classes
AuthErrorConflictErrorForbiddenErrorInvalidTokenErrorNetworkErrorNotFoundErrorOfflineModeErrorRateLimitedErrorRequiresTwoFactorErrorServerErrorUnauthenticatedErrorValidationError
Functions
Tokens & PKCE
Token decode, expiry helpers, and PKCE challenge generation.
Functions
Interfaces
Organizations & memberships
Org records, member records, role records, invitations.
Interfaces
AdminUserOrgMembershipCreateInvitationRequestCreateOrgRequestCreateOrgRoleRequestInvitationRecordMyOrgRecordOrganizationOrgMemberRecordOrgRoleRecordUpdateMemberStatusRequestUpdateOrgRequestUpdateOrgRoleRequest
Applications & webhooks
App registry records — pool config, registration policy, outbound webhooks.
User pools
Pool (namespace) catalog + per-user pool DTOs.
Services (m2m)
Machine-credential registry records (client_credentials grant).
Admin & impersonation
User lookup, hard delete, impersonation, assignable permissions.
Interfaces
AssignablePermissionRecordHardDeleteUserRequestImpersonateParamsImpersonateRequestLookupUserRecordLookupUsersRequest
Audit log
Audit-log records, queries, and results.
SSO & magic link
Single sign-on + passwordless email link payloads.
Interfaces
MagicLinkRequestMagicLinkVerifyRequestSsoCompleteRequestSsoStartParamsSsoStartRequestSsoStartResult
Two-factor (TOTP)
TOTP enrollment and disable payloads.
Domain models
Core user / auth / session record types shared with the server.
Interfaces
Type aliases
Roles & JWT claims
Role-code constants, role-label helpers and JWT payload shapes re-exported from @rw3iss/auth-shared.
Functions
Interfaces
AuthenticatedUserBaseJwtClaimsEmailVerificationClaimsImpersonationClaimsPasswordResetClaimsRefreshJwtPayloadRoleLabelOptionsRoleLikeServiceJwtPayloadServicePrincipalUserJwtPayload
Type aliases
Variables
BASE\_USERBUYERKNOWN\_BASE\_ROLE\_LABELSORG\_ADMINORG\_MANAGERORG\_MEMBERSELLERSUPER\_ADMINSYSTEM\_ADMIN
Misc utilities
Optimistic-action runner, HTTP-response decoder, retry options.