Interface FederationTokenStore

Readonlykind

attach

• attach(
      sid: string,
      federationName: string,
      tokens: FederationTokens,
  ): Promise<void>

  Persist tokens for a session + federation. Production implementations MUST encrypt refreshToken at rest. Plaintext persistence is supported only as an explicit opt-in — the built-in redis adapter exposes this via encryption.mode = "allow-plaintext" (with a startup warning), and the built-in in-memory adapter is plaintext by design because the process boundary already contains it. Both opt-outs are intended for development / testing use only. See spec Section 5.

  Parameters

  • sid: string
  • federationName: string
  • tokens: FederationTokens

  Returns Promise<void>

delete

• delete(sid: string, federationName: string): Promise<void>

  Delete a specific (sid, federationName) entry. Idempotent.

  Parameters

  • sid: string
  • federationName: string

  Returns Promise<void>

get

• get(sid: string, federationName: string): Promise<FederationTokens | null>

  Parameters

  • sid: string
  • federationName: string

  Returns Promise<FederationTokens | null>

removeBySid

• removeBySid(sid: string): Promise<void>

  Remove all federation entries for a session. Idempotent.

  Verb-aligned with sibling session stores (UserSessionStore, SessionRPRegistry, SessionFamilyIndex, SessionFederationIndex) which all expose removeBySid(sid) for the same "bulk-remove records scoped to a session id" responsibility.

  Renamed from deleteBySession in v0.5.1 (AS-3); the old name is no longer accepted because FederationTokenStore was new in v0.5.0 and the v0.5.1 hotfix policy explicitly permits this rename for interfaces that have had no external consumers.

  Parameters

  • sid: string

  Returns Promise<void>

update

• update(
      sid: string,
      federationName: string,
      tokens: FederationTokens,
  ): Promise<void>

  Atomic replace. Called after a successful federation refresh.

  Parameters

  • sid: string
  • federationName: string
  • tokens: FederationTokens

  Returns Promise<void>