refactor(types): Minor Type Improvements for the ThirdParty Recipe
#946
Conversation
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
ITenthusiasm
force-pushed
the
it/types/thirdparty
branch
from
e3d1d38
to
569f404
Compare
rishabhpoddar
requested changes
Oct 14, 2024
rishabhpoddar
requested changes
Oct 18, 2024
It is safe to pass `undefined` for `userContext` in all of these cases. Therefore, to improve the DX for developers not leveraging `UserContext` for these methods, the argument should be optional.
This argument expects an object of strings. This should be clarified to developers so that they don't mistakenly pass, for instance, an instance of `URLSearchParams`.
ITenthusiasm
force-pushed
the
it/types/thirdparty
branch
from
569f404
to
16b1015
Compare
|
Is there anything that I need to do to trigger |
rishabhpoddar
approved these changes
Oct 19, 2024
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.
Summary of changes
This PR is intended to improve the DX for anyone using
supertokens-node/recipe/thirdparty. ItTypeProvidermethodsredirectURIQueryParamsfield of theTypeProvider.exchangeAuthCodeForOAuthTokensmethodRelated issues
N/A. (Can create a separate issue if desired.)
Test Plan
This is just a simple TypeScript types change. So as long as the project builds, everything should be fine.
Documentation changes
N/A
Checklist for important updates
I was uncertain about whether or not I should update
package.json(and friends).coreDriverInterfaceSupported.jsonfile has been updated (if needed)lib/ts/version.tsfrontendDriverInterfaceSupported.jsonfile has been updated (if needed)package.jsonpackage-lock.jsonlib/ts/version.tsnpm run build-prettyIf new thirdparty provider is added,recipe/thirdparty/providers/configUtils.tsfile,createProviderfunction.git tag) in the formatvX.Y.Z, and then find the latest branch (git branch --all) whoseX.Yis greater than the latest released tag.If have added a new web framework, update theadd-ts-no-check.jsfile to include thatIf added a new recipe / api interface, then make sure that the implementation of it uses NON arrow functions only (likesomeFunc: function () {..}).If added a new recipe, then make sure to expose it inside the recipe folder present in the root of this repo. We also need to expose its types.If added a new entry point, then make sure that it is importable by adding it to theexportsinpackage.json