@authx-rs/sdk

Generated from packages/authx-sdk-ts/dist/types.

Low-level OIDC, JWKS, PKCE, device, and browser-session helpers.

Modules

• device
• errors
• jwks
• oidc
• pkce
• session

device

DeviceAuthorizationResponse

export interface DeviceAuthorizationResponse {
    device_code: string;
    user_code: string;
    verification_uri: string;
    verification_uri_complete?: string;
    expires_in: number;
    interval: number;
    [key: string]: unknown;
}

DeviceAuthorizationOptions

export interface DeviceAuthorizationOptions {
    endpoint: string;
    clientId: string;
    scope?: string;
}

PollDeviceTokenOptions

export interface PollDeviceTokenOptions {
    tokenEndpoint: string;
    clientId: string;
    deviceCode: string;
    clientSecret?: string;
}

startDeviceAuthorization

export declare function startDeviceAuthorization(options: DeviceAuthorizationOptions): Promise<DeviceAuthorizationResponse>;

pollDeviceToken

export declare function pollDeviceToken(options: PollDeviceTokenOptions): Promise<OidcTokenResponse>;

errors

AuthxErrorBody

export interface AuthxErrorBody {
    error?: string;
    message?: string;
    error_description?: string;
    [key: string]: unknown;
}

AuthxSdkError

export declare class AuthxSdkError extends Error {
    readonly status?: number;
    readonly code?: string;
    readonly details?: unknown;
    constructor(message: string, options?: {
        status?: number;
        code?: string;
        details?: unknown;
    });
}

toAuthxSdkError

export declare function toAuthxSdkError(message: string, options?: {
    status?: number;
    code?: string;
    details?: unknown;
}): AuthxSdkError;

jwks

JwtHeader

export interface JwtHeader {
    alg?: string;
    typ?: string;
    kid?: string;
    [key: string]: unknown;
}

OidcJwk

export interface OidcJwk extends JsonWebKey {
    kid?: string;
    use?: string;
    alg?: string;
    kty: string;
    x5c?: string[];
    [key: string]: unknown;
}

JwksDocument

export interface JwksDocument {
    keys: OidcJwk[];
    [key: string]: unknown;
}

SelectJwkOptions

export interface SelectJwkOptions {
    kid?: string;
    alg?: string;
    use?: string;
    kty?: string;
}

fetchJwks

export declare function fetchJwks(jwksUri: string): Promise<JwksDocument>;

fetchIssuerJwks

export declare function fetchIssuerJwks(issuer: string): Promise<JwksDocument>;

decodeJwtHeader

export declare function decodeJwtHeader(token: string): JwtHeader;

selectJwk

export declare function selectJwk(jwks: JwksDocument, options: SelectJwkOptions): OidcJwk | undefined;

getJwkForJwt

export declare function getJwkForJwt(jwks: JwksDocument, token: string): OidcJwk | undefined;

oidc

OidcDiscoveryDocument

export interface OidcDiscoveryDocument {
    issuer: string;
    authorization_endpoint: string;
    token_endpoint: string;
    userinfo_endpoint?: string;
    jwks_uri?: string;
    revocation_endpoint?: string;
    introspection_endpoint?: string;
    device_authorization_endpoint?: string;
    token_endpoint_auth_methods_supported?: string[];
    response_types_supported?: string[];
    grant_types_supported?: string[];
    scopes_supported?: string[];
    id_token_signing_alg_values_supported?: string[];
    [key: string]: unknown;
}

OidcTokenResponse

export interface OidcTokenResponse {
    access_token: string;
    token_type: string;
    expires_in: number;
    refresh_token?: string;
    scope?: string;
    id_token?: string;
    [key: string]: unknown;
}

IntrospectionResponse

export interface IntrospectionResponse {
    active: boolean;
    scope?: string;
    client_id?: string;
    username?: string;
    token_type?: string;
    exp?: number;
    iat?: number;
    sub?: string;
    iss?: string;
    [key: string]: unknown;
}

BuildAuthorizationUrlOptions

export interface BuildAuthorizationUrlOptions {
    authorizationEndpoint: string;
    clientId: string;
    redirectUri: string;
    scope?: string;
    state?: string;
    nonce?: string;
    codeChallenge?: string;
    codeChallengeMethod?: "S256";
    extraParams?: Record<string, string | undefined>;
}

ExchangeCodeOptions

export interface ExchangeCodeOptions {
    tokenEndpoint: string;
    clientId: string;
    code: string;
    redirectUri: string;
    codeVerifier?: string;
    clientSecret?: string;
}

RefreshTokenOptions

export interface RefreshTokenOptions {
    tokenEndpoint: string;
    clientId: string;
    refreshToken: string;
    scope?: string;
    clientSecret?: string;
}

RevokeTokenOptions

export interface RevokeTokenOptions {
    revocationEndpoint: string;
    clientId: string;
    token: string;
    tokenTypeHint?: string;
    clientSecret?: string;
}

IntrospectTokenOptions

export interface IntrospectTokenOptions {
    introspectionEndpoint: string;
    clientId: string;
    token: string;
    tokenTypeHint?: string;
    clientSecret?: string;
}

UserInfoClaims

export interface UserInfoClaims {
    sub: string;
    email?: string;
    email_verified?: boolean;
    preferred_username?: string;
    [key: string]: unknown;
}

discoverIssuer

export declare function discoverIssuer(issuer: string): Promise<OidcDiscoveryDocument>;

buildAuthorizationUrl

export declare function buildAuthorizationUrl(options: BuildAuthorizationUrlOptions): string;

exchangeAuthorizationCode

export declare function exchangeAuthorizationCode(options: ExchangeCodeOptions): Promise<OidcTokenResponse>;

refreshToken

export declare function refreshToken(options: RefreshTokenOptions): Promise<OidcTokenResponse>;

revokeToken

export declare function revokeToken(options: RevokeTokenOptions): Promise<void>;

introspectToken

export declare function introspectToken(options: IntrospectTokenOptions): Promise<IntrospectionResponse>;

fetchUserInfo

export declare function fetchUserInfo(userInfoEndpoint: string, accessToken: string): Promise<UserInfoClaims>;

pkce

PkcePair

export interface PkcePair {
    codeVerifier: string;
    codeChallenge: string;
    codeChallengeMethod: "S256";
}

randomString

export declare function randomString(byteLength?: number): string;

createPkcePair

export declare function createPkcePair(byteLength?: number): Promise<PkcePair>;

randomState

export declare function randomState(byteLength?: number): string;

session

SessionUser

export interface SessionUser {
    id?: string;
    user_id?: string;
    email?: string;
    email_verified?: boolean;
    username?: string | null;
    [key: string]: unknown;
}

SessionRecord

export interface SessionRecord {
    id?: string;
    session_id?: string;
    user_id?: string;
    ip_address?: string;
    org_id?: string | null;
    expires_at?: string;
    created_at?: string;
    [key: string]: unknown;
}

SignInResult

export interface SignInResult {
    user_id: string;
    session_id: string;
    token: string;
    [key: string]: unknown;
}

SignUpResult

export interface SignUpResult {
    user_id: string;
    email: string;
    [key: string]: unknown;
}

SessionEnvelope

export interface SessionEnvelope {
    user?: SessionUser;
    session?: SessionRecord;
    [key: string]: unknown;
}

BrowserSessionClientOptions

export interface BrowserSessionClientOptions {
    baseUrl: string;
    credentials?: RequestCredentials;
    headers?: HeadersInit;
}

CredentialInput

export interface CredentialInput {
    email: string;
    password: string;
}

BrowserSessionClient

export declare class BrowserSessionClient {
    constructor(options: BrowserSessionClientOptions);
    signUp(body: CredentialInput): Promise<SignUpResult>;
    signIn(body: CredentialInput): Promise<SignInResult>;
    signOut(): Promise<void>;
    signOutAll(): Promise<void>;
    session(): Promise<SessionEnvelope>;
    sessions(): Promise<SessionRecord[]>;
}