Issue setting up Strategy [in TypeScript]

[optojack]

Hello, I am trying to setup an app to use this package but I am having issues setting the Strategy; specifically the following:

passport.use(
  new Strategy(
    {
      clientID: env.TWITTER_API_CLIENT_ID,
      clientSecret: env.TWITTER_API_CLIENT_SECRET,
      clientType: 'confidential',
      callbackURL: 'http://localhost:3000/auth/twitter/callback',
    },
    function (accessToken, refreshToken, profile, done) {
      return done(null, profile);
    }
  )
);

I have most commonly seen 2 errors between trying different things to resolve the issues:
1.

Property 'authenticate' is missing in type 'import(".../node_modules/@superfaceai/passport-twitter-oauth2/dist/strategy").Strategy' but required in type 'import(".../node_modules/@types/passport/index").Strategy'.

'Strategy' cannot be used as a value because it was exported using 'export type'.

I will add that I am using typescript (not sure if that should be causing these issues though) and I am working off the example code here

Thanks in advance for any help!!

[jnv]

Thanks for the report. It's possible the current CommonJS exports have some troubles with TypeScript since I focused on keeping the backwards compatibility of default + named export.

Could you please add a rest of your example? Notably, are you using require or import to import the strategy? And in the former case, did you try using import?

[Push-Stack]

I am working on a Nest JS project.
I am getting the same error Strategy' cannot be used as a value because it was exported using 'export type.

import { Strategy, Profile } from '@superfaceai/passport-twitter-oauth2';

@Injectable()
export class TwitterStrategy extends PassportStrategy(Strategy, 'twitter') {
  constructor(
    @Inject(TwitterConfig.KEY) twitter: ConfigType<typeof TwitterConfig>,
  ) {
    super({
      clientID: twitter.clientId,
      clientSecret: twitter.clientSecret,
      callbackURL: twitter.callbackUrl,
      scope: ['tweet.read', 'users.read', 'offline.access'],
    });
  }

  async verify(accessToken: string, refreshToken: string, profile: Profile) {
    console.log(accessToken, refreshToken, profile);

    return { accessToken, refreshToken, profile };
  }
}

[janhalama]

I can confirm that there is an issue in TypeScript support. I have opened PR with fixes.

[janhalama]

@JackLit, @Push-Stack We've just released @superfaceai/passport-twitter-oauth2 v1.2.1 with TypeScript fixes.

[kazuemon]

I am using @superfaceai/passport-twitter-oauth2@1.2.2 and continue to have this problem.
Installing @types/passport-oauth2 at the same time solved the problem.

[jnv]

@kazuemon Thanks for the report. I will reopen this issue.

I see three options how to address it:

1. Add missing dependency on @types/passport-oauth2; easiest, but it has multiple transitive dependencies and it would add extra weight for non-TS users.
2. Make @types/passport-oauth2 an optional dependency and document it needs to be installed.
3. Pull in just the types we need from @types/passport-oauth2 and its transitive dependencies.

Just that types package adds 3,5 MB install size which is why I'm not quite happy with slapping it on as an extra dependency.

[jnv]

I decided to go with optionalDependencies in #32. While it means the types get installed for non-TS users by default, it should be possible to omit them.

[jnv]

Hey folks, I've released v1.2.3 with optional @types dependencies today, so hopefully it should fix this issue for good.