Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refresh userinfo data on demand #877

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
+797 −437
Open

refresh userinfo data on demand #877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7f1e762
feat: create ClaimsService
marcoreni Jan 25, 2023
c809d88
feat: move userinfo logic inside userinfo service
marcoreni Jan 25, 2023
532c700
feat: move claimsservice tests
marcoreni Jan 25, 2023
4c5195d
feat: profile is required so that logics are simpler
marcoreni Jan 25, 2023
3fc4137
feat: update tests to new implementation
marcoreni Jan 25, 2023
2316ada
feat: expose userinfo refetch
marcoreni Jan 25, 2023
b927b4a
feat: persist updated user in store and refresh token if expired
marcoreni Feb 6, 2023
e384a84
feat: introduce new mergeClaims behavior
marcoreni Feb 6, 2023
23339dd
feat: validate sub on getuserinfo
marcoreni Feb 6, 2023
32c0b05
chore: add tests
marcoreni Feb 6, 2023
aacc837
chore: better types
marcoreni Feb 6, 2023
885099d
fix: if refreshing token, getUserInfo and storeUser are redundant
marcoreni Feb 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/oidc-client-ts.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,13 +287,19 @@ export interface OidcAddressClaim {
// @public
export class OidcClient {
constructor(settings: OidcClientSettings);
// Warning: (ae-forgotten-export) The symbol "ClaimsService" needs to be exported by the entry point index.d.ts
//
// (undocumented)
protected readonly _claimsService: ClaimsService;
// (undocumented)
clearStaleState(): Promise<void>;
// (undocumented)
createSigninRequest({ state, request, request_uri, request_type, id_token_hint, login_hint, skipUserInfo, nonce, response_type, scope, redirect_uri, prompt, display, max_age, ui_locales, acr_values, resource, response_mode, extraQueryParams, extraTokenParams, }: CreateSigninRequestArgs): Promise<SigninRequest>;
// (undocumented)
createSignoutRequest({ state, id_token_hint, request_type, post_logout_redirect_uri, extraQueryParams, }?: CreateSignoutRequestArgs): Promise<SignoutRequest>;
// (undocumented)
getUserInfo(token: string, profile: IdTokenClaims): Promise<IdTokenClaims>;
// (undocumented)
protected readonly _logger: Logger;
// (undocumented)
readonly metadataService: MetadataService;
Expand Down Expand Up @@ -323,6 +329,10 @@ export class OidcClient {
protected readonly _tokenClient: TokenClient;
// (undocumented)
useRefreshToken({ state, timeoutInSeconds, }: UseRefreshTokenArgs): Promise<SigninResponse>;
// Warning: (ae-forgotten-export) The symbol "UserInfoService" needs to be exported by the entry point index.d.ts
//
// (undocumented)
protected readonly _userInfoService: UserInfoService;
// Warning: (ae-forgotten-export) The symbol "ResponseValidator" needs to be exported by the entry point index.d.ts
//
// (undocumented)
Expand All @@ -345,6 +355,7 @@ export interface OidcClientSettings {
extraTokenParams?: Record<string, unknown>;
fetchRequestCredentials?: RequestCredentials;
filterProtocolClaims?: boolean | string[];
legacyMergeClaimsBehavior?: boolean;
loadUserInfo?: boolean;
max_age?: number;
mergeClaims?: boolean;
Expand Down Expand Up @@ -373,7 +384,7 @@ export interface OidcClientSettings {

// @public
export class OidcClientSettingsStore {
constructor({ authority, metadataUrl, metadata, signingKeys, metadataSeed, client_id, client_secret, response_type, scope, redirect_uri, post_logout_redirect_uri, client_authentication, prompt, display, max_age, ui_locales, acr_values, resource, response_mode, filterProtocolClaims, loadUserInfo, staleStateAgeInSeconds, clockSkewInSeconds, userInfoJwtIssuer, mergeClaims, stateStore, refreshTokenCredentials, revokeTokenAdditionalContentTypes, fetchRequestCredentials, refreshTokenAllowedScope, extraQueryParams, extraTokenParams, }: OidcClientSettings);
constructor({ authority, metadataUrl, metadata, signingKeys, metadataSeed, client_id, client_secret, response_type, scope, redirect_uri, post_logout_redirect_uri, client_authentication, prompt, display, max_age, ui_locales, acr_values, resource, response_mode, filterProtocolClaims, loadUserInfo, staleStateAgeInSeconds, clockSkewInSeconds, userInfoJwtIssuer, mergeClaims, legacyMergeClaimsBehavior, stateStore, refreshTokenCredentials, revokeTokenAdditionalContentTypes, fetchRequestCredentials, refreshTokenAllowedScope, extraQueryParams, extraTokenParams, }: OidcClientSettings);
// (undocumented)
readonly acr_values: string | undefined;
// (undocumented)
Expand All @@ -396,6 +407,7 @@ export class OidcClientSettingsStore {
readonly fetchRequestCredentials: RequestCredentials;
// (undocumented)
readonly filterProtocolClaims: boolean | string[];
readonly legacyMergeClaimsBehavior: boolean;
// (undocumented)
readonly loadUserInfo: boolean;
// (undocumented)
Expand Down Expand Up @@ -903,7 +915,7 @@ export class UserManager {
get events(): UserManagerEvents;
// (undocumented)
protected readonly _events: UserManagerEvents;
getUser(): Promise<User | null>;
getUser(refreshUserInfo?: boolean): Promise<User | null>;
// Warning: (ae-forgotten-export) The symbol "IFrameNavigator" needs to be exported by the entry point index.d.ts
//
// (undocumented)
Expand Down
Loading