intuit / oauth-jsclient

Intuit's NodeJS OAuth client provides a set of methods to make it easier to work with OAuth2.0 and Open ID
https://developer.intuit.com/
Apache License 2.0
120 stars 154 forks source link

[typescript][issue]: Passing custom state parameter within typings definition file #103

Open abisalehalliprasan opened 3 years ago

abisalehalliprasan commented 3 years ago

Hacktoberfest is underway right now and we would love for you to contribute πŸš€ . More information on #hacktoberfest is here

Develop-with-Intuit for Hacktoberfest

Problem

SDK should support passing the state parameter. Provide a fix to support this in the typings definitions: index.d.ts file

node_modules/intuit-oauth/index.d.ts:112:9
    112         state?: csrf;
                ~~~~~

The expected type comes from property 'state' which is declared here on type AuthorizeParams const authUri = oauthClient.authorizeUri({scope:[OAuthClient.scopes.Accounting,OAuthClient.scopes.OpenId],state:'testState'});

Errors dissapears if you let SDK provide a csrf using the moule :

const authUri = oauthClient.authorizeUri({scope:[OAuthClient.scopes.Accounting,OAuthClient.scopes.OpenId]});

Fix Needed

The SDK typings definition file should allow custom state parameters ( string ) to be passed.

Instructions to use the sample app

In order to test the typings locally from the sample project, you'll need to link the intuit-oauth package with yarn or npm.

# Link local intuit-oauth branch with typings support to sample typescript project
yarn link
cd sample/typescript
yarn link intuit-oauth

PR Guidelines

Kindly follow the below instructions to submit your PR :

Once ready, please submit a PR to the typescript branch here.
Note : PR's will be merged to the master branch once all the testing is completed.

nsinghal12 commented 3 years ago

@abisalehalliprasan I am picking this up now.

abisalehalliprasan commented 3 years ago

@nsinghal12 : Awesome. Thanks πŸš€

nikhilbhatia08 commented 10 months ago

@abisalehalliprasan I am a beginner can you guide me to fix this issue and can I work on this issue?

rum1887 commented 10 months ago

any updates? is the issue open?