Add generic Userinfo to createFusionAuth for vue sdk #143
Conversation
There was a problem hiding this comment.
We need the option to specify the type in conjunction with createFusionAuth and useFusionAuth. So we need the end result to look something like:
type Whatever = {
// ...etc
};
const { userInfo } = createFusionAuth<Whatever>(config);
const { userInfo } = useFusionAuth<Whatever>();
// Where `userInfo` is inferred to be of type `Whatever`.We will need to update the following definitions:
FusionAuthto accept an optional generic whereuserInfoandgetUserInforeference thatTtype.createFusionAuthto accept the same optional generic argument where userInfo andgetUserInfocan referenceT.useFusionAuthto accept the same so it can returnuserInfoandgetUserInfoas the generic passed in.
If it's done correctly, you should be able to consume a local build in the quickstart and get strong typing for a custom userinfo type you pass in.
Please let me know if this is helpful or needs clarifying! Also happy to pair, since I've already done this for the other frameworks, it could go pretty fast.
|
|
||
| export const useFusionAuth = (): FusionAuth => { | ||
| export const useFusionAuth = <T extends FusionAuth<UserInfo>>(): FusionAuth => { |
There was a problem hiding this comment.
Perhaps try <T = UserInfo>(): FusionAuth<T> here. That would define T as the generic, with UserInfo being the default value for T if none is provided. Then make sure to pass it along to the FusionAuth return type. That's what will give it the strong typing!
| const user = { | ||
| given_name: 'JSON', | ||
| family_name: 'Bourne', | ||
| customTrait: 'additional info', |
There was a problem hiding this comment.
Is there a reason for this change? I believe we can use this test to cover what we're implementing here, but I'm not sure this is doing it. Here's an example
| import { SDKCore } from '@fusionauth-sdk/core'; | ||
| import { FusionAuth, FusionAuthConfig, UserInfo } from '#/types'; | ||
|
|
||
| import { NuxtUseCookieAdapter } from './NuxtUseCookieAdapter'; | ||
|
|
||
| export const createFusionAuth = (config: FusionAuthConfig): FusionAuth => { | ||
| export const createFusionAuth = <T extends UserInfo>( |
There was a problem hiding this comment.
We want <T = UserInfo> not extends. I haven't used extends much but I believe this would mean T is constrained to have all the properties defined on UserInfo, which is not what we want.
| @@ -19,16 +21,16 @@ export const createFusionAuth = (config: FusionAuthConfig): FusionAuth => { | |||
| }); | |||
|
|
|||
| const isLoggedIn = ref<boolean>(core.isLoggedIn); | |||
| const userInfo = ref<UserInfo | null>(null); | |||
| const userInfo = ref<T | null>(null) as Ref<UserInfo>; | |||
There was a problem hiding this comment.
Can we please use const userInfo Ref<T | null> = ref(null)?
This thread has an answer from a vue contributor explaining that ref<>() with generic types causes issues.
| import { FusionAuth, FusionAuthConfig } from './types.ts'; | ||
| import * as components from './components/index.ts'; | ||
| import { fusionAuthKey } from './injectionSymbols.ts'; | ||
| import { createFusionAuth } from './createFusionAuth/index.ts'; | ||
| import { UserInfo } from '@fusionauth-sdk/core'; |
There was a problem hiding this comment.
This should be UserInfo from ./types.ts
What is this PR and why do we need it?
#139 -- adding an optional generic type to createFusionAuth so that
UserInfocan be custom typed. Defaults toUserInfoPre-Merge Checklist (if applicable)