Class OIDCAuth

Index

Constructors

Methods

addTokenListener buildAuthCodeUrl devicePoll deviceStart exchangeAuthCode generatePKCE loadConfig passwordGrant refresh removeTokenListener setClient setScope startDeviceAuth fromMintInfo

Constructors

constructor

new OIDCAuth(discoveryUrl: string, opts?: OIDCAuthOptions): OIDCAuth
Parameters
- discoveryUrl: string
- Optionalopts: OIDCAuthOptions
Returns OIDCAuth
- Defined in src/auth/OIDCAuth.ts:102

Methods

addTokenListener

addTokenListener(
fn: (t: TokenResponse, origin: TokenOrigin) => void | Promise<void>,
): void
Subscribe after onTokens, with origin identifying a sign-in or refresh.
Parameters
- fn: (t: TokenResponse, origin: TokenOrigin) => void | Promise<void>
Returns void
- Defined in src/auth/OIDCAuth.ts:122

buildAuthCodeUrl

buildAuthCodeUrl(
    input: {
        codeChallenge: string;
        codeChallengeMethod?: "S256" | "plain";
        redirectUri: string;
        scope?: string;
        state?: string;
    },
): Promise<string>
Build an Authorization Code + PKCE URL.
Parameters
- input: {
      codeChallenge: string;
      codeChallengeMethod?: "S256" | "plain";
      redirectUri: string;
      scope?: string;
      state?: string;
  }
Returns Promise<string>
- Defined in src/auth/OIDCAuth.ts:201

devicePoll

devicePoll(device_code: string, intervalSec?: number): Promise<TokenResponse>
Polls the device-code endpoint until the provider answers.
Parameters
- device_code: string
- intervalSec: number = 5
Returns Promise<TokenResponse>
Deprecated
Removed in v5. Use OIDCAuth.startDeviceAuth, which returns the start fields with poll() and cancel(): this loop cannot be stopped once it is running.
- Defined in src/auth/OIDCAuth.ts:275

deviceStart

deviceStart(): Promise<DeviceStartResponse>
Returns Promise<DeviceStartResponse>
- Defined in src/auth/OIDCAuth.ts:253

exchangeAuthCode

exchangeAuthCode(
input: { code: string; codeVerifier: string; redirectUri: string },
): Promise<TokenResponse>
Exchange an auth code for tokens, using the PKCE verifier.
Parameters
- input: { code: string; codeVerifier: string; redirectUri: string }
Returns Promise<TokenResponse>
- Defined in src/auth/OIDCAuth.ts:237

generatePKCE

generatePKCE(): { challenge: string; verifier: string }
Generate a PKCE verifier and S256 challenge.
- Verifier: base64url of random bytes, length >= 43, RFC 7636 compliant.
- Challenge: base64url(sha256(verifier))
Returns { challenge: string; verifier: string }
- Defined in src/auth/OIDCAuth.ts:185

loadConfig

loadConfig(): Promise<OIDCConfig>
Returns Promise<OIDCConfig>
- Defined in src/auth/OIDCAuth.ts:135

passwordGrant

passwordGrant(username: string, password: string): Promise<TokenResponse>
Parameters
- username: string
- password: string
Returns Promise<TokenResponse>
- Defined in src/auth/OIDCAuth.ts:435

refresh

refresh(refresh_token: string): Promise<TokenResponse>
Refresh tokens and notify the listeners registered when the request starts.
Parameters
- refresh_token: string
Returns Promise<TokenResponse>
- Defined in src/auth/OIDCAuth.ts:403

removeTokenListener

removeTokenListener(
fn: (t: TokenResponse, origin: TokenOrigin) => void | Promise<void>,
): void
Remove a token listener by reference, including from pending refresh delivery.
Parameters
- fn: (t: TokenResponse, origin: TokenOrigin) => void | Promise<void>
Returns void
- Defined in src/auth/OIDCAuth.ts:129

setClient

setClient(id: string): void
Parameters
- id: string
Returns void
- Defined in src/auth/OIDCAuth.ts:111

setScope

setScope(scope?: string): void
Parameters
- Optionalscope: string
Returns void
- Defined in src/auth/OIDCAuth.ts:115

startDeviceAuth

startDeviceAuth(
    intervalSec?: number,
): Promise<
    DeviceStartResponse & {
        cancel: () => void;
        poll: () => Promise<TokenResponse>;
    },
>
One call convenience for Device Code flow.
Parameters
- intervalSec: number = 5
  Desired polling interval in seconds.
Returns Promise<
    DeviceStartResponse & {
        cancel: () => void;
        poll: () => Promise<TokenResponse>;
    },
>
The start fields and helpers to poll or cancel.

Remarks
Polling uses the larger requested interval; cancel settles every poll and aborts pending token requests.
- Defined in src/auth/OIDCAuth.ts:312

`Static`fromMintInfo

fromMintInfo(
    info: {
        nuts: {
            "10"?: { supported: boolean };
            "11"?: { supported: boolean };
            "12"?: { supported: boolean };
            "14"?: { supported: boolean };
            "15"?: { methods: MPPMethod[] };
            "17"?: { supported: WebSocketSupport[] };
            "19"?: {
                cached_endpoints: { method: "GET" | "POST"; path: string }[];
                ttl: number | null;
            };
            "20"?: { supported: boolean };
            "21"?: {
                client_id: string;
                openid_discovery: string;
                protected_endpoints?: { method: "GET" | "POST"; path: string }[];
            };
            "22"?: {
                bat_max_mint: number;
                protected_endpoints: { method: "GET"
                | "POST"; path: string }[];
            };
            "29"?: Nut29Info;
            "4": { disabled: boolean; methods: SwapMethod[] };
            "5": { disabled: boolean; methods: SwapMethod[] };
            "7"?: { supported: boolean };
            "8"?: { supported: boolean };
            "9"?: { supported: boolean };
        };
    },
    opts?: OIDCAuthOptions,
): OIDCAuth
Parameters
- info: {
      nuts: {
          "10"?: { supported: boolean };
          "11"?: { supported: boolean };
          "12"?: { supported: boolean };
          "14"?: { supported: boolean };
          "15"?: { methods: MPPMethod[] };
          "17"?: { supported: WebSocketSupport[] };
          "19"?: {
              cached_endpoints: { method: "GET" | "POST"; path: string }[];
              ttl: number | null;
          };
          "20"?: { supported: boolean };
          "21"?: {
              client_id: string;
              openid_discovery: string;
              protected_endpoints?: { method: "GET" | "POST"; path: string }[];
          };
          "22"?: {
              bat_max_mint: number;
              protected_endpoints: { method: "GET"
              | "POST"; path: string }[];
          };
          "29"?: Nut29Info;
          "4": { disabled: boolean; methods: SwapMethod[] };
          "5": { disabled: boolean; methods: SwapMethod[] };
          "7"?: { supported: boolean };
          "8"?: { supported: boolean };
          "9"?: { supported: boolean };
      };
  }
- Optionalopts: OIDCAuthOptions
Returns OIDCAuth
- Defined in src/auth/OIDCAuth.ts:93

Class OIDCAuth

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OIDCAuth

Methods

addTokenListener

Parameters

Returns void

buildAuthCodeUrl

Parameters

Returns Promise<string>

devicePoll

Parameters

Returns Promise<TokenResponse>

Deprecated

deviceStart

Returns Promise<DeviceStartResponse>

exchangeAuthCode

Parameters

Returns Promise<TokenResponse>

generatePKCE

Returns { challenge: string; verifier: string }

loadConfig

Returns Promise<OIDCConfig>

passwordGrant

Parameters

Returns Promise<TokenResponse>

refresh

Parameters

Returns Promise<TokenResponse>

removeTokenListener

Parameters

Returns void

setClient

Parameters

Returns void

setScope

Parameters

Returns void

startDeviceAuth

Parameters

Returns Promise< DeviceStartResponse & { cancel: () => void; poll: () => Promise<TokenResponse>; },>

Remarks

StaticfromMintInfo

Parameters

Returns OIDCAuth

Settings

On This Page

Returns Promise<
DeviceStartResponse & {
cancel: () => void;
poll: () => Promise<TokenResponse>;
},
>

`Static`fromMintInfo