rename and deprecate the AuthorizationURLOptions interfaces #1282
Conversation
This file contains hidden or 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
nholden
approved these changes
May 27, 2025
ericroberts
reviewed
May 27, 2025
ericroberts
approved these changes
May 27, 2025
stacurry
added a commit
that referenced
this pull request
May 30, 2025
## Description version bump that includes: - #1282 - #1288 ## Documentation Does this require changes to the WorkOS Docs? E.g. the [API Reference](https://workos.com/docs/reference) or code snippets need updates. ``` [ ] Yes ``` If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request introduces changes to standardize and clarify the naming of authorization URL options interfaces across the SSO and User Management modules. It also includes minor import adjustments and code cleanup to align with the updated interface names.
Interface Renaming and Deprecation:
AuthorizationURLOptionstoSSOAuthorizationURLOptionsin the SSO module and marked the original interface as deprecated for backward compatibility. (src/sso/interfaces/authorization-url-options.interface.ts: [1] [2]AuthorizationURLOptionstoUserManagementAuthorizationURLOptionsin the User Management module to better reflect its context. (src/user-management/interfaces/authorization-url-options.interface.ts: src/user-management/interfaces/authorization-url-options.interface.tsL1-R1)Code Updates to Use New Interface Names:
SSOclass to useSSOAuthorizationURLOptionsinstead of the deprecatedAuthorizationURLOptions. (src/sso/sso.ts: src/sso/sso.tsL76-R76)UserManagementclass to useUserManagementAuthorizationURLOptionsinstead of the oldAuthorizationURLOptions. (src/user-management/user-management.ts: src/user-management/user-management.tsL997-R997)Import Adjustments and Cleanup:
src/sso/sso.tsandsrc/user-management/user-management.tsto reflect the renamed interfaces and remove unused imports. (src/sso/sso.ts: [1] [2];src/user-management/user-management.ts: [3] [4]These changes improve code clarity and maintainability by aligning interface names with their respective modules and ensuring backward compatibility where necessary.
Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.
fixes #1281