Definitelytyped: [@types/auth0] passwordGrant() is missing `forwardedFor`

[vicary]

• [x] I tried using the @types/xxxx package and had problems.
• [x] I tried using the latest stable version of tsc. https://www.npmjs.com/package/typescript
• [x] I have a question that is inappropriate for StackOverflow. (Please ask any appropriate questions there).
• [x] [Mention](https://github.com/blog/821-mention-somebody-they-re-notified) the authors (see Definitions by: in index.d.ts) so they can respond.
  
  
  
  • Authors: @donaldpipowitch, @amiram, @wbhob, @pacey, @andy-ms, @westy92, @paulvanbrenk, @jussikinnula, @neshanjo, @akvamalin, @djmc, @dancrumb, @Gus-vcx, @saurabh73, @xTNTx, @segayuu, @ricardo-devis-agullo, @rameshanandakrishnan, @peterblazejewicz, @orangain, @mbfisher, @MengRS, @ashton, @lukasvan3l, @kkirsche, @kainoffke, @JulienDuf, @ianhowe76, @matt-oakes, @matchai, @danielglasgow, @clementheliou, @CatGuardian, @alexbjorlig, @duro, @isabela-morais, @pwrnrd
  
  

First of all, sorry for mentioning every single one of the contributors of @types/auth0 here. Because my questions in the official support forum is simply ignored and I'd like comments from the community.

I believe this issue is broader than the title means.

For example, the ManagementClient#passwordGrant() method in fact allows a second object as argument, while it is totally undocumented, from online discussions I know that at least { forwadedFor } is taken to have the SDK send Auth0-Forwarded-For header.

Shall we dig into the js source and type all of them? Or shall we deliberately ignore them and stick with officially documented features only and let typechecks fails?

[alexbjorlig]

Hi @vicary - no worries about the mention. It's after all only one e-mail, and people can unsubscribe if they don't want to be notified. I think the typings should document the js source - if the documentation is missing that is just another 🐛

[neshanjo]

@vicary The next time, please just mention the _current_ authors listed in https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/auth0/index.d.ts Thanks!

[wbhob]

i haven’t used auth0 in a few years, but my intuition says to stick to officially documented properties. if our types diverge from their docs, then people may open issues asking for explanation of features we don’t fully understand. may be best to wait for official word from auth0

--
Wilson Hobbs

Schedule a meeting: scheduletime.withwilson.xyz ( https://scheduletime.withwilson.xyz )

Sent via Superhuman iOS ( https://sprh.mn/[email protected] )

On Thu, Nov 12 2020 at 2:11 AM, V < [email protected] > wrote:

• I tried using the @types/xxxx package and had problems.

• I tried using the latest stable version of tsc. https://www.npmjs.com/package/typescript

• I have a question that is inappropriate for StackOverflow (
  https://stackoverflow.com/ ). (Please ask any appropriate questions
  there).

• Mention ( https://github.com/blog/821-mention-somebody-they-re-notified )
  the authors (see Definitions by: in index.d.ts ) so they can respond.

• Authors: @donaldpipowitch ( https://github.com/donaldpipowitch ) , @amiram
  ( https://github.com/amiram ) , @wbhob ( https://github.com/wbhob ) , @pacey
  ( https://github.com/pacey ) , @andy-ms ( https://github.com/andy-ms ) , @westy92
  ( https://github.com/westy92 ) , @paulvanbrenk (
  https://github.com/paulvanbrenk ) , @jussikinnula (
  https://github.com/jussikinnula ) , @neshanjo ( https://github.com/neshanjo
  ) , @akvamalin ( https://github.com/akvamalin ) , @djmc (
  https://github.com/djmc ) , @dancrumb ( https://github.com/dancrumb ) , @Gus-vcx
  ( https://github.com/Gus-vcx ) , @saurabh73 ( https://github.com/saurabh73
  ) , @xTNTx ( https://github.com/xTNTx ) , @segayuu (
  https://github.com/segayuu ) , @ricardo-devis-agullo (
  https://github.com/ricardo-devis-agullo ) , @rameshanandakrishnan (
  https://github.com/rameshanandakrishnan ) , @peterblazejewicz (
  https://github.com/peterblazejewicz ) , @orangain (
  https://github.com/orangain ) , @mbfisher ( https://github.com/mbfisher ) ,
  @MengRS ( https://github.com/MengRS ) , @ashton ( https://github.com/ashton
  ) , @lukasvan3l ( https://github.com/lukasvan3l ) , @kkirsche (
  https://github.com/kkirsche ) , @kainoffke ( https://github.com/kainoffke )
  , @JulienDuf ( https://github.com/JulienDuf ) , @ianhowe76 (
  https://github.com/ianhowe76 ) , @matt-oakes (
  https://github.com/matt-oakes ) , @matchai ( https://github.com/matchai ) ,
  @danielglasgow ( https://github.com/danielglasgow ) , @clementheliou (
  https://github.com/clementheliou ) , @CatGuardian (
  https://github.com/CatGuardian ) , @alexbjorlig (
  https://github.com/alexbjorlig ) , @duro ( https://github.com/duro ) , @isabela-morais
  ( https://github.com/isabela-morais ) , @pwrnrd ( https://github.com/pwrnrd
  )

First of all, sorry for mentioning every single one of the contributors of
@types/auth0 here. Because my questions in the official support forum is
simply ignored and I'd like comments from the community.

I believe this issue is broader than the title means.

For example, the ManagementClient#passwordGrant() method in fact allows a
second object as argument, while it is totally undocumented, from online
discussions I know that at least { forwadedFor } is taken to have the SDK
send Auth0-Forwarded-For header.

Shall we dig into the js source and type all of them? Or shall we
deliberately ignore them and stick with officially documented features
only and let typechecks fails?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub (
https://github.com/DefinitelyTyped/DefinitelyTyped/issues/49503 ) , or unsubscribe
(
https://github.com/notifications/unsubscribe-auth/ABB4QETW7WDYWRWYV7ZVWSTSPODDHANCNFSM4TS465YQ
).