Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(core): extract helpers and provision methods
extract helpers and provision methods
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| /** | ||
| * @overview This file contains helper functions for the main interaction class. | ||
| * | ||
| * To help reduce the complexity and code amount of the main interaction class, | ||
| * we have moved some of the standalone functions into this file. | ||
| */ | ||
|
|
||
| import { VerificationType, type User } from '@logto/schemas'; | ||
| import { conditional } from '@silverhand/essentials'; | ||
|
|
||
| import RequestError from '#src/errors/RequestError/index.js'; | ||
| import assertThat from '#src/utils/assert-that.js'; | ||
|
|
||
| import type { InteractionProfile } from '../types.js'; | ||
|
|
||
| import { type VerificationRecord } from './verifications/index.js'; | ||
|
|
||
| /** | ||
| * @throws {RequestError} -400 if the verification record type is not supported for user creation. | ||
| * @throws {RequestError} -400 if the verification record is not verified. | ||
| */ | ||
| export const getNewUserProfileFromVerificationRecord = async ( | ||
| verificationRecord: VerificationRecord | ||
| ): Promise<InteractionProfile> => { | ||
| switch (verificationRecord.type) { | ||
| case VerificationType.NewPasswordIdentity: | ||
| case VerificationType.EmailVerificationCode: | ||
| case VerificationType.PhoneVerificationCode: { | ||
| return verificationRecord.toUserProfile(); | ||
| } | ||
| case VerificationType.EnterpriseSso: | ||
| case VerificationType.Social: { | ||
| const identityProfile = await verificationRecord.toUserProfile(); | ||
| const syncedProfile = await verificationRecord.toSyncedProfile(true); | ||
| return { ...identityProfile, ...syncedProfile }; | ||
| } | ||
| default: { | ||
| // Unsupported verification type for user creation, such as MFA verification. | ||
| throw new RequestError({ code: 'session.verification_failed', status: 400 }); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * @throws {RequestError} -400 if the verification record type is not supported for user identification. | ||
| * @throws {RequestError} -400 if the verification record is not verified. | ||
| * @throws {RequestError} -404 if the user is not found. | ||
| */ | ||
| export const identifyUserByVerificationRecord = async ( | ||
| verificationRecord: VerificationRecord, | ||
| linkSocialIdentity?: boolean | ||
| ): Promise<{ | ||
| user: User; | ||
| /** | ||
| * Returns the social/enterprise SSO synced profiled if the verification record is a social/enterprise SSO verification. | ||
| * - For new linked identity, the synced profile will includes the new social or enterprise SSO identity. | ||
| * - For existing social or enterprise SSO identity, the synced profile will return the synced user profile based on connector settings. | ||
| */ | ||
| syncedProfile?: Pick< | ||
| InteractionProfile, | ||
| 'enterpriseSsoIdentity' | 'socialIdentity' | 'avatar' | 'name' | ||
| >; | ||
| }> => { | ||
| // Check verification record can be used to identify a user using the `identifyUser` method. | ||
| // E.g. MFA verification record does not have the `identifyUser` method, cannot be used to identify a user. | ||
| assertThat( | ||
| 'identifyUser' in verificationRecord, | ||
| new RequestError({ code: 'session.verification_failed', status: 400 }) | ||
| ); | ||
|
|
||
| switch (verificationRecord.type) { | ||
| case VerificationType.Password: | ||
| case VerificationType.EmailVerificationCode: | ||
| case VerificationType.PhoneVerificationCode: { | ||
| return { user: await verificationRecord.identifyUser() }; | ||
| } | ||
| case VerificationType.Social: { | ||
| const user = linkSocialIdentity | ||
| ? await verificationRecord.identifyRelatedUser() | ||
| : await verificationRecord.identifyUser(); | ||
|
|
||
| const syncedProfile = { | ||
| ...(await verificationRecord.toSyncedProfile()), | ||
| ...conditional(linkSocialIdentity && (await verificationRecord.toUserProfile())), | ||
| }; | ||
|
|
||
| return { user, syncedProfile }; | ||
| } | ||
| case VerificationType.EnterpriseSso: { | ||
| try { | ||
| const user = await verificationRecord.identifyUser(); | ||
| const syncedProfile = await verificationRecord.toSyncedProfile(); | ||
| return { user, syncedProfile }; | ||
| } catch (error: unknown) { | ||
| // Auto fallback to identify the related user if the user does not exist for enterprise SSO. | ||
| if (error instanceof RequestError && error.code === 'user.identity_not_exist') { | ||
| const user = await verificationRecord.identifyRelatedUser(); | ||
| const syncedProfile = { | ||
| ...(await verificationRecord.toUserProfile()), | ||
| ...(await verificationRecord.toSyncedProfile()), | ||
| }; | ||
| return { user, syncedProfile }; | ||
| } | ||
| throw error; | ||
| } | ||
| } | ||
| } | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.