5.1.X

init(config)

You can customize the Thirdparty module by overwriting the following configs:

ThirdParty.init({
    sessionFeature?: {
        setJwtPayload?: (user: User, thirdPartyAuthCodeResponse: any, action: "signin" | "signup") => 
        Promise<{ [key: string]: any } | undefined>,
        setSessionData?: (user: User, thirdPartyAuthCodeResponse: any, action: "signin" | "signup") => 
        Promise<{ [key: string]: any } | undefined>
    },
    signInAndUpFeature: {
        disableDefaultImplementation?: boolean,
        handlePostSignUpIn?: (user: User, thirdPartyAuthCodeResponse: any) => Promise<void>,
        providers: TypeProvider[]
    },
    signOutFeature?: {
        disableDefaultImplementation?: boolean
    },
    emailVerificationFeature?: {
        disableDefaultImplementation?: boolean,
        getEmailVerificationURL?: (user: User) => Promise<string>,
        createAndSendCustomEmail?: (user: User, emailVerificationURLWithToken: string) => Promise<void>,
        handlePostEmailVerification?: (user: User) => Promise<void>
    }
})

Parameters

  • config
    • sessionFeature
      • setJwtPayload (Optional)
        • type: (user: User, thirdPartyAuthCodeResponse: any, action: "signin" | "signup") => Promise<{ [key: string]: any } | undefined>
        • description: The default value for JWT payload when a session is created is {}. Configuring setJWTPayload allows you to change the default JWT payload value.
      • setSessionData (Optional)
        • type: (user: User, thirdPartyAuthCodeResponse: any, action: "signin" | "signup") => Promise<{ [key: string]: any } | undefined>
        • description: The default value for session data when a session is created is {}. Configuring setSessionData allows you to change the default session data value.
    • signInUpFeature (Optional)
      • disableDefaultImplementation
        • type: boolean
        • description: Disables the default signInUp API.`
      • handlePostSignUpIn (Optional)
        • type: (user: User, thirdPartyAuthCodeResponse: any) => Promise<void>
        • description: Callback excecuted after signup/signin.
      • providers
        • type: TypeProvider[]
          • TypeProvider
          • type: { id: string, get: (redirectURI: string, authCodeFromRequest: string | undefined) => Promise<TypeProviderGetResponse> }
          • description: Object to initialize a thirdparty provider supported by the backend.
    • signOutFeature (Optional)
      • disableDefaultImplementation
        • type: boolean
        • description: Disables the default signout API.
    • emailVerificationFeature
    • disableDefaultImplementation (Optional)
      • type: boolean
      • description: Disables the default email verification APIs.
    • getEmailVerificationURL (Optional)
      • type: (user: User) => Promise<string>
      • description: Callback for the email verification URL
    • createAndSendCustomEmail (Optional)
      • type: (user: User, emailVerificationURLWithToken: string) => Promise<void>
      • description: Callback for creating and sending custom emails for email verification.
← PreviousNext →