npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@superfaceai/passport-twitter-oauth2

v1.2.4

Published

Twitter OAuth 2.0 authentication strategy for Passport.

Downloads

21,447

Readme

Twitter OAuth 2.0 Strategy for Passport

@superfaceai/passport-twitter-oauth2

npm license TypeScript GitHub Discussions

Passport strategy for authenticating with Twitter using OAuth 2.0.

This module lets you authenticate using Twitter in your Node.js applications. By plugging into Passport, Twitter authentication can be integrated into any application or framework that supports Connect-style middleware, including Express.

Twitter announced OAuth 2.0 general availability on December 14 2021 and encourages developers to use Twitter API v2.0 with OAuth 2.0 authentication.

Twitter OAuth 2.0 implementation specifics:

  • PKCE is required
  • OAuth2 client credentials must be passed via Authorization header for confidential client types

Install

npm install @superfaceai/passport-twitter-oauth2

Usage

Note Check our blog for a complete tutorial with code explanation.

Create an Application

Before using @superfaceai/passport-twitter-oauth2, you must register a project and an application with Twitter by following these steps:

  1. go to https://developer.twitter.com/ and either sign up for a new account or sign in with existing one
  2. sign up for Essential access; you will need to verify a phone number for your Twitter account
  3. create a project and application (Essential account is limited to a single project and application)
  4. in application settings generate OAuth 2.0 Client ID and Client Secret; mind that you cannot view the secret again later, only regenerate it

Configure Strategy

Provide OAuth 2.0 Client ID and Client Secret (from previous step) to the strategy constructor. The strategy also requires a verify callback, which receives the access token and refresh token as arguments, as well as profile which contains the authenticated user's Twitter profile. The verify callback must call cb providing a user to complete authentication.

passport.use(
  new TwitterStrategy(
    {
      clientType: 'confidential', //depends on your Twitter app settings, valid values are `confidential` or `public`
      clientID: TWITTER_CLIENT_ID,
      clientSecret: TWITTER_CLIENT_SECRET,
      callbackURL: 'http://127.0.0.1:3000/auth/twitter/callback',
    },
    function (accessToken, refreshToken, profile, done) {
      User.findOrCreate({ twitterId: profile.id }, function (err, user) {
        return done(err, user);
      });
    }
  )
);

Authenticate Requests

Use passport.authenticate(), specifying the 'twitter' strategy, to authenticate requests.

Do not forget to configure scopes required by your application.

For example, you can use authenticate function as an Express route middleware:

app.get('/auth/twitter', passport.authenticate('twitter'));

app.get(
  '/auth/twitter/callback',
  passport.authenticate('twitter', {
    failureRedirect: '/login',
    scope: ['tweet.read', 'tweet.write', 'users.read'],
  }),
  function (req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  }
);

Examples

Check the examples directory for minimal working projects:

Where It's Being Used

  • twitter-demo – Demo of social media profiles for Twitter with Superface OneSDK uses this strategy to generate access tokens.
  • social-media-demo – Demo application handling access to multiple social media sites, content publishing, reading timelines and more.

Related Projects

Development

When developing, start with cloning the repository using git clone https://github.com/superfaceai/passport-twitter-oauth2.git.

After cloning, install the dependencies with npm i.

Now the repository is ready for code changes.

The package.json also contains scripts (runnable by calling npm run <script-name>):

  • build - transpile TypeScript into JavaScript
  • format - check the code formatting
  • format:fix - fix the code formatting
  • lint - run linter
  • test - run tests

Contributing

Please open an issue first if you want to make larger changes

Feel free to contribute! Please follow the Contribution Guide.

Maintainers

License

@superfaceai/passport-twitter-oauth2 project is licensed under the MIT license.

© 2023 Superface s.r.o.