Greptile Overview

Greptile Summary

This PR fixes several critical documentation errors in the V8 Migration Guide that would have caused runtime errors if developers followed the incorrect examples:

Corrected Method Names

• Magic Auth: Fixed sendMagicCode() → createMagicAuth() (verified in src/user-management/user-management.ts:713)
• Password Reset: Fixed sendPasswordResetEmail() → createPasswordReset() (verified in src/user-management/user-management.ts:749)

Fixed Session Refresh Pattern

The previous example referenced non-existent refreshSession and sealSession functions. The corrected example properly demonstrates:

1. Using loadSealedSession() to get a CookieSession instance (verified in src/user-management/user-management.ts:212)
2. Calling refresh() on that instance (verified in src/user-management/session.ts:114)
3. Accessing result.sealedSession from the response (verified in src/user-management/interfaces/refresh-and-seal-session-data.interface.ts:27)

Fixed MFA Parameter Name

Changed authenticationFactorId → authenticationChallengeId in the verifyChallenge() example, matching the actual interface definition in src/mfa/interfaces/verify-challenge-options.ts:2.

Markdown Formatting

Added blank lines before code blocks throughout the document for consistent rendering.

All changes have been verified against the actual codebase and are accurate.

Confidence Score: 5/5

• This PR is completely safe to merge - it only fixes documentation errors with no code changes.
• Score of 5 reflects that this is a documentation-only PR that corrects critical errors in the migration guide. All corrections have been thoroughly verified against the actual codebase implementation. The changes prevent developers from following incorrect examples that would cause runtime errors. There are no code changes, no breaking changes, and no security implications.
• No files require special attention - this is a straightforward documentation correction.

Important Files Changed

File Analysis

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant WOS as WorkOS SDK
    participant CS as CookieSession
    participant API as WorkOS API

    Note over Dev,API: Session Refresh Flow (v8)

    Dev->>WOS: loadSealedSession({sessionData, cookiePassword})
    WOS->>CS: new CookieSession(userManagement, sessionData, cookiePassword)
    CS-->>Dev: CookieSession instance

    Dev->>CS: refresh({organizationId})
    CS->>CS: unsealData(sessionData)
    CS->>API: authenticateWithRefreshToken({refreshToken, organizationId})
    API-->>CS: AuthenticationResponse + sealedSession
    CS->>CS: Update internal sessionData
    CS-->>Dev: {authenticated: true, sealedSession, session, ...}

    Note over Dev: result.sealedSession contains<br/>the new sealed session data