refactor(core,schemas): refactor the register flow

[simeng-li]

Summary

This PR refactors the register interaction flow.

In a register interaction event:

1. The user can prepend any verified profile through POST /profile API. All the pending user info will be stored in the interaction profile data.
2. Call the createUser method to create a new user account using the pending user info stored in the interaction profile.
3. A mandatory profile guard will be applied to make sure all the mandatory user identifiers and verification methods are provided.
4. Interaction will become identified once the new user account is successfully created. The pending interaction profile data will be cleared.
5. If a verificationId parameter is provided, this method will update the pending profile data first using the profile retrieved from the given verification record.

In a registration flow, a user profile can be provided either by calling POST /profile endpoint or directly passing a verificationId to the POST /identification method. The createUser method will retrieve all the pending user data from the profile record and create a new user account in Logto.

See the following samples:

sequenceDiagram

    actor  U as User
    participant I as Interaction

    U->>I: PUT /experience/ Register
    U->>I: POST /experience/profile username
    I->>U: 200 OK
    U->>I: POST /experience/identification
    I->>U: 422 missing password
    U->>I: POST /experience/profile password
    I->>U: 200 OK
    U->>I: POST /experience/identification
    I->>U: 200 OK

Loading

sequenceDiagram
    actor  U as User
    participant I as Interaction

    U->>I: PUT /experience/ register
    U->>I: POST /experience/verifications/social
    I->>U: 200 OK
    U->>I: POST /experience/verifications/social/verify
    I->>U: 200 OK
    U->>I: POST /experience/identify {verificationId}
    I->>U: 422 missing email
    U->>I: POST /experience/verifications/code-verification
    U->>I: POST /experience/verifications/code-verification/verify
    I->>U: 200 OK
    U->>I: POST /experience/profile {type: 'email', verificaitonId}
    I->>U: 200 OK
    U->>I: POST /experience/identify
    I->>U: 200 OK

Loading

Testing

Checklist

• .changeset
• unit tests
• integration tests
• necessary TSDoc comments

[github-actions]

COMPARE TO master

Total Size Diff 📈 +2 KB

Diff by File

Name	Diff
packages/core/src/routes/experience/classes/experience-interaction.test.ts	📈 +2 Bytes
packages/core/src/routes/experience/classes/experience-interaction.ts	📈 +593 Bytes
packages/core/src/routes/experience/classes/libraries/profile-validator.ts	📈 +34 Bytes
packages/core/src/routes/experience/classes/libraries/sign-in-experience-validator.test.ts	📈 +4.75 KB
packages/core/src/routes/experience/classes/libraries/sign-in-experience-validator.ts	📈 +1.31 KB
packages/core/src/routes/experience/classes/profile.ts	📈 +1.74 KB
packages/core/src/routes/experience/classes/verifications/new-password-identity-verification.ts	📈 +1 Bytes
packages/core/src/routes/experience/classes/verifications/web-authn-verification.ts	📈 +60 Bytes
packages/core/src/routes/experience/index.ts	📈 +510 Bytes
packages/core/src/routes/experience/profile-routes.ts	📈 +697 Bytes
packages/core/src/routes/experience/types.ts	📈 +72 Bytes
packages/core/src/routes/experience/verification-routes/new-password-identity-verification.ts	📈 +175 Bytes
packages/core/src/routes/experience/verification-routes/web-authn-verification.ts	📈 +40 Bytes
packages/integration-tests/src/client/experience/index.ts	📈 +5 Bytes
packages/integration-tests/src/helpers/experience/index.ts	📈 +168 Bytes
packages/integration-tests/src/tests/api/experience-api/register-interaction/username-password.test.ts	📈 +1.52 KB
packages/integration-tests/src/tests/api/experience-api/register-interaction/verification-code.test.ts	📈 +1.71 KB
packages/integration-tests/src/tests/api/experience-api/sign-in-interaction/enterprise-sso.test.ts	📈 +2.04 KB
packages/integration-tests/src/tests/api/experience-api/sign-in-interaction/social.test.ts	📈 +4.67 KB
packages/integration-tests/src/tests/api/experience-api/verifications/new-password-identity-verification.test.ts	📈 +1.16 KB
packages/schemas/src/types/interactions.ts	📈 +172 Bytes