Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Can't match types definition in @types/passport-jwt@4.0.0 #393

Open
4 tasks done
k725 opened this issue Jan 4, 2024 · 2 comments · May be fixed by #394
Open
4 tasks done

Can't match types definition in @types/passport-jwt@4.0.0 #393

k725 opened this issue Jan 4, 2024 · 2 comments · May be fixed by #394
Labels
bug

Comments

@k725
Copy link

k725 commented Jan 4, 2024

Checklist

  • I have looked into the Readme and Examples, and have not found a suitable solution or answer.
  • I have searched the issues and have not found a suitable solution or answer.
  • I have searched the Auth0 Community forums and have not found a suitable solution or answer.
  • I agree to the terms within the Auth0 Code of Conduct.

Description

It works on @types/passport-jwt@3.0.13, but the build fails on @types/passport-jwt@4.0.0 due to type changes.

This is caused by changes in the following parts.
https://github.com/DefinitelyTyped/DefinitelyTyped/pull/67897/files#diff-b71c8d6ec401ffed807cc36d147e6eda88a0a5eb1a17175172ce9004026d8b79R38-L41

The following patch can be used as a simple change.
https://github.com/auth0/node-jwks-rsa/blob/master/index.d.ts#L68-L74

  /** Types from express-jwt@<=6 */
  type secretType = string|Buffer;
- type SecretCallbackLong = (req: Express.Request, header: any, payload: any, done: (err: any, secret?: secretType) => void) => void;
- type SecretCallback = (req: Express.Request, payload: any, done: (err: any, secret?: secretType) => void) => void;
+ type SecretCallbackLong = (req: Request, header: any, payload: any, done: (err: any, secret?: secretType) => void) => void;
+ type SecretCallback = (req: Request, payload: any, done: (err: any, secret?: secretType) => void) => void;

  /** Types from express-jwt@>=7 */
- type GetVerificationKey = (req: Express.Request, token: Jwt | undefined) => Secret | undefined | Promise<Secret | undefined>;
+ type GetVerificationKey = (req: Request, token: Jwt | undefined) => Secret | undefined | Promise<Secret | undefined>;

Reproduction

import { ExtractJwt, type StrategyOptions } from 'passport-jwt';
import { passportJwtSecret } from 'jwks-rsa';

const assertProp: StrategyOptions = {
  jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
  secretOrKeyProvider: passportJwtSecret({
    jwksUri: 'https://example.com/...',
  }),
};
console.log(assertProp);
src/test.ts:6:3 - error TS2322: Type 'SecretCallback' is not assignable to type 'SecretOrKeyProvider'.
  Types of parameters 'req' and 'request' are incompatible.
    Type 'Request' is missing the following properties from type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>': get, header, accepts, acceptsCharsets, and 100 more.

6   secretOrKeyProvider: passportJwtSecret({
    ~~~~~~~~~~~~~~~~~~~

  ../../node_modules/@types/passport-jwt/index.d.ts:12:5
    12     secretOrKeyProvider?: SecretOrKeyProvider | undefined;
           ~~~~~~~~~~~~~~~~~~~
    The expected type comes from property 'secretOrKeyProvider' which is declared here on type 'StrategyOptions'

Additional context

DefinitelyTyped/DefinitelyTyped#67897

jwks-rsa version

v3.1.0

Node.js version

v20.10.0
@k725 k725 added the bug label Jan 4, 2024
@k725 k725 mentioned this issue Jan 4, 2024
Merged
8 tasks
@zackdotcomputer
Copy link

zackdotcomputer commented Jan 4, 2024 •
edited

Looking at the source code for the passport integration, it appears that the req parameter isn't even used. I think that means that it would be safe to type this as unknown in the type definitions and avoid this issue happening again if Passport integrates the proposed PR to change this type again from Request to IncomingMessage.

Edit: see below. I have opened a PR that changes this parameter to unknown typing to remove the mismatch error for users on both the v3 and v4 typedefs for passport.

@zackdotcomputer zackdotcomputer linked a pull request Jan 4, 2024 that will close this issue
Open
3 tasks
@k725
Copy link
Author

k725 commented Jan 4, 2024

@zackdotcomputer Yes, I think the unknown type is better if it is not used. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
2 participants
@zackdotcomputer @k725