Changelog

​

Version 8.7.0

​

Features

• Added resourceTypeSlug to permissions, environment and organization roles (#1502)
• Added deserialization support for feature flag events (#1494)

​

Bug Fixes

• Updated release-please manifest to match actual version 8.6.0 (#1503)

​

Version 8.6.0

​

Version 8.0.0

​

Highlights

• Universal runtime compatibility - Works seamlessly across Node.js, Deno, Bun, and Cloudflare Workers
• PKCE authentication support - Full support for public clients (mobile, CLI, browser apps)
• API modernization - Removed deprecated methods and improved type safety
• Node.js 20+ required - Updated minimum Node version from 16 to 20

​

Breaking Changes

​

Runtime Requirements

• Minimum Node.js version increased from 16 to 20
• Package is now ESM-first with dual CJS/ESM exports

​

Directory Sync

• Removed emails, username, and jobTitle fields from DirectoryUser interface
• Use customAttributes instead

​

User Management

• Removed context field from AuthorizationURLOptions
• Removed deprecated methods: sendMagicAuthCode(), sendPasswordResetEmail(), refreshAndSealSessionData()
• listOrganizationMemberships() now requires either userId or organizationId

​

SSO

• SSOAuthorizationURLOptions converted to discriminated union
• Removed domain field (deprecated)

​

MFA

• Removed verifyFactor() method - use verifyChallenge() instead

​

Organizations

• Removed allowProfilesOutsideOrganization and domains fields
• Use domainData instead of domains

​

Vault

• Removed all *Secret method aliases - use *Object methods instead

​

Events

• Removed dsync.deactivated event type - use dsync.deleted instead

​

New Features

• PKCE authentication - Support for public clients without API keys
• createWorkOS() factory function - Compile-time type safety for client modes
• Enhanced runtime support - Better Deno, Bun, and Cloudflare Workers compatibility

​

Version History

​

Versioning Policy

• Major versions (X.0.0) - Breaking changes that require code updates
• Minor versions (X.Y.0) - New features, backwards compatible
• Patch versions (X.Y.Z) - Bug fixes, backwards compatible

​

Beta Releases

• May contain breaking changes between versions
• Should be pinned to specific versions in production
• Are indicated by -beta or -rc version suffixes

npm install @workos-inc/[email protected]

​

Release Notifications

• Watch the GitHub repository
• Subscribe to npm package updates
• Follow @WorkOS on Twitter

​

Report Issues

• Open an issue on GitHub
• Contact [email protected]