Skip to content

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

Open
@abisalehalliprasan

Description

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 :

  • Fork and clone the repository (typescript branch).
  • Run npm install for dependencies.
  • Test all your changes.
  • Run npm test to execute all specs.

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.

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions