Module recipe/thirdparty

appleRedirectHandlerPOST: undefined | ((input: { formPostInfoFromProvider: {}; options: APIOptions; userContext: UserContext }) => Promise<void>)

authorisationUrlGET: undefined | ((input: { options: APIOptions; provider: TypeProvider; redirectURIOnProviderDashboard: string; tenantId: string; userContext: UserContext }) => Promise<{ pkceCodeVerifier?: string; status: "OK"; urlWithQueryParams: string } | GeneralErrorResponse>)

signInUpPOST: undefined | ((input: { options: APIOptions; provider: TypeProvider; session: SessionContainer | undefined; shouldTryLinkingWithSessionUser: boolean | undefined; tenantId: string; userContext: UserContext } & ({ redirectURIInfo: { pkceCodeVerifier?: string; redirectURIOnProviderDashboard: string; redirectURIQueryParams: any } } | { oAuthTokens: {} })) => Promise<{ createdNewRecipeUser: boolean; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; session: SessionContainer; status: "OK"; user: User } | { status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" } | GeneralErrorResponse>)

appInfo: NormalisedAppinfo

config: TypeNormalisedInput

isInServerlessEnv: boolean

providers: ProviderInput[]

recipeId: string

recipeImplementation: RecipeInterface

req: BaseRequest

res: BaseResponse

getProvider:function

• getProvider(input: { clientType?: string; tenantId: string; thirdPartyId: string; userContext: UserContext }): Promise<undefined | TypeProvider>

• Parameters

  • input: { clientType?: string; tenantId: string; thirdPartyId: string; userContext: UserContext }

    • Optional clientType?: string

    • tenantId: string

    • thirdPartyId: string

    • userContext: UserContext

  Returns Promise<undefined | TypeProvider>

manuallyCreateOrUpdateUser:function

• manuallyCreateOrUpdateUser(input: { email: string; isVerified: boolean; session: SessionContainer | undefined; shouldTryLinkingWithSessionUser: boolean | undefined; tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: UserContext }): Promise<{ createdNewRecipeUser: boolean; recipeUserId: RecipeUserId; status: "OK"; user: User } | { reason: string; status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR" } | { reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" } | { reason: "EMAIL_VERIFICATION_REQUIRED" | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR" | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR" | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"; status: "LINKING_TO_SESSION_USER_FAILED" }>

• Parameters

  • input: { email: string; isVerified: boolean; session: SessionContainer | undefined; shouldTryLinkingWithSessionUser: boolean | undefined; tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: UserContext }

    • email: string

    • isVerified: boolean

    • session: SessionContainer | undefined

    • shouldTryLinkingWithSessionUser: boolean | undefined

    • tenantId: string

    • thirdPartyId: string

    • thirdPartyUserId: string

    • userContext: UserContext

  Returns Promise<{ createdNewRecipeUser: boolean; recipeUserId: RecipeUserId; status: "OK"; user: User } | { reason: string; status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR" } | { reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" } | { reason: "EMAIL_VERIFICATION_REQUIRED" | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR" | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR" | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"; status: "LINKING_TO_SESSION_USER_FAILED" }>

signInUp:function

• signInUp(input: { email: string; isVerified: boolean; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; session: SessionContainer | undefined; shouldTryLinkingWithSessionUser: boolean | undefined; tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: UserContext }): Promise<{ createdNewRecipeUser: boolean; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; recipeUserId: RecipeUserId; status: "OK"; user: User } | { reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" } | { reason: "EMAIL_VERIFICATION_REQUIRED" | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR" | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR" | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"; status: "LINKING_TO_SESSION_USER_FAILED" }>

• Parameters

  • input: { email: string; isVerified: boolean; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; session: SessionContainer | undefined; shouldTryLinkingWithSessionUser: boolean | undefined; tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: UserContext }

    • email: string

    • isVerified: boolean

    • oAuthTokens: {}

      • [key: string]: any

    • rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }

      • Optional fromIdTokenPayload?: {}

        • [key: string]: any

      • Optional fromUserInfoAPI?: {}

        • [key: string]: any

    • session: SessionContainer | undefined

    • shouldTryLinkingWithSessionUser: boolean | undefined

    • tenantId: string

    • thirdPartyId: string

    • thirdPartyUserId: string

    • userContext: UserContext

  Returns Promise<{ createdNewRecipeUser: boolean; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; recipeUserId: RecipeUserId; status: "OK"; user: User } | { reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" } | { reason: "EMAIL_VERIFICATION_REQUIRED" | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR" | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR" | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"; status: "LINKING_TO_SESSION_USER_FAILED" }>

config: ProviderConfigForClientType

id: string

exchangeAuthCodeForOAuthTokens:function

• exchangeAuthCodeForOAuthTokens(input: { redirectURIInfo: { pkceCodeVerifier?: string; redirectURIOnProviderDashboard: string; redirectURIQueryParams: Record<string, string> }; userContext?: UserContext }): Promise<any>

• Parameters

  • input: { redirectURIInfo: { pkceCodeVerifier?: string; redirectURIOnProviderDashboard: string; redirectURIQueryParams: Record<string, string> }; userContext?: UserContext }

    • redirectURIInfo: { pkceCodeVerifier?: string; redirectURIOnProviderDashboard: string; redirectURIQueryParams: Record<string, string> }

      • Optional pkceCodeVerifier?: string

      • redirectURIOnProviderDashboard: string

      • redirectURIQueryParams: Record<string, string>

    • Optional userContext?: UserContext

  Returns Promise<any>

getAuthorisationRedirectURL:function

• getAuthorisationRedirectURL(input: { redirectURIOnProviderDashboard: string; userContext?: UserContext }): Promise<{ pkceCodeVerifier?: string; urlWithQueryParams: string }>

• Parameters

  • input: { redirectURIOnProviderDashboard: string; userContext?: UserContext }

    • redirectURIOnProviderDashboard: string

    • Optional userContext?: UserContext

  Returns Promise<{ pkceCodeVerifier?: string; urlWithQueryParams: string }>

getConfigForClientType:function

• getConfigForClientType(input: { clientType?: string; userContext?: UserContext }): Promise<ProviderConfigForClientType>

• Parameters

  • input: { clientType?: string; userContext?: UserContext }

    • Optional clientType?: string

    • Optional userContext?: UserContext

  Returns Promise<ProviderConfigForClientType>

getUserInfo:function

• getUserInfo(input: { oAuthTokens: any; userContext?: UserContext }): Promise<UserInfo>

• Parameters

  • input: { oAuthTokens: any; userContext?: UserContext }

    • oAuthTokens: any

    • Optional userContext?: UserContext

  Returns Promise<UserInfo>