loadUserProfile() no longer typesafe

[freis-hdi]

I just upgraded to version 12 and face an issue with loading the userinfo.

After PR #939 the return type of loadUserProfile() changed from Userinfo to Userinfo | string and now to object.

I thought, I could still at least cast to Userinfo, but weirdly the response is wrapped like this:

{
  "info": {
    "sub": "...",
    "name": "...",
    ...
  }
}

instead of

{
  "sub": "...",
  "name": "...",
  ...
}

so that I would have to call

private userinfoSubject$ = new ReplaySubject<UserInfo>();

...

  this.oauthService.loadUserProfile().then(userinfo => {
    // tslint:disable-next-line
    this.userinfoSubject$.next(userinfo['info'] as UserInfo);
    ...
  }

I would really like to find a cleaner solution to this.

Is the response wrapped in "info" on purpose?
And why did the response type change from Userinfo | string to object?

[jeroenheijmans]

That's a good question indeed! I do not have the answer. I did trace it to the changes (amongst others) here:

bbff95b#diff-685e26c24f3c008856834f8b4a350d5472b6aea01a623c31a8513f6cc599c57fL722-R722

In that PR I also see an open comment (from after the commits were made I think) saying something similar.

[freis-hdi]

@jeroenheijmans Yes, i traced it back to that too and was relieved that I wasn't the only one having problems with this change.

[jeroenheijmans]

We actually ran into this when upgrading the library in one of our applications.

At this point it's probably not useful to revert this breaking change anymore. However, I think it would be good to have the README and relevant release notes mention that the data from loadUserProfile's lambda now needs to be changed to do the .info step to get to the actual data:

      return this.oAuthService.loadUserProfile()
        .then((userProfile: Record<string, unknown>) => {
          const user = new User(userProfile?.info);