Class UnetId

constructor

• new UnetId(options: UnetIdOptions): UnetId

  Parameters

  • options: UnetIdOptions

  Returns UnetId

signIn

• signIn(options?: SignInOptions): Promise<void>

  Redirects the browser to unet.social. Finish with handleRedirectCallback() on the return page.

  Parameters

  • options: SignInOptions = {}

  Returns Promise<void>

isRedirectCallback

• isRedirectCallback(url?: string): boolean

  True if the current URL looks like an authorization response for this app.

  Parameters

  • url: string = globalThis.location.href

  Returns boolean

handleRedirectCallback

• handleRedirectCallback(
      url?: string,
  ): Promise<{ user: UnetUser; returnTo: string }>

  Call on the return page. Validates state, exchanges the code (PKCE, no secret) and loads the profile. Resolves with the user and the returnTo passed to signIn. Throws AccessDenied / StateMismatch / UnetIdError / NetworkError.

  Parameters

  • url: string = globalThis.location.href

  Returns Promise<{ user: UnetUser; returnTo: string }>

restore

• restore(options?: { revalidate?: boolean }): Promise<UnetUser | null>

  Load a previous session (call once on startup). Returns null if signed out.

  Parameters

  • options: { revalidate?: boolean } = {}

  Returns Promise<UnetUser | null>

getUser

• getUser(): UnetUser | null

  Returns UnetUser | null

refreshUser

• refreshUser(): Promise<UnetUser>

  Re-reads the profile from UNET (e.g. after the user changed their name elsewhere).

  Returns Promise<UnetUser>

getGrantedScopes

• getGrantedScopes(): string[] | null

  Scopes the server granted for this session; null if signed out. Falls back to the requested scopes if the server did not say.

  Returns string[] | null

hasScope

• hasScope(scope: string): boolean

  Whether the session has scope — check before calling, instead of catching InsufficientScope.

  Parameters

  • scope: string

  Returns boolean

isSignedIn

• isSignedIn(): boolean

  Returns boolean

getAccessToken

• getAccessToken(force?: boolean): Promise<string>

  A valid access token, refreshed automatically (single in-flight refresh).

  Parameters

  • force: boolean = false

  Returns Promise<string>

signOut

• signOut(): Promise<void>

  Revokes tokens on the server (best effort) and clears local state.

  Returns Promise<void>

onSessionChange

• onSessionChange(cb: (user: UnetUser | null) => void): () => void

  Parameters

  • cb: (user: UnetUser | null) => void

  Returns () => void

Readonlyapi