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

discord-oauth2-simple

v1.0.4

Published

Discord OAuth2 client for making dashboard and website linked with discord.

Downloads

29

Readme

discord-oauth2-simple

Library for interacting with Discord OAuth2.0, using passport strategy.

Usage

npm install --save discord-oauth2-simple

Configure Strategy

The Discord authentication strategy authenticates users via a Discord user account and OAuth 2.0 token(s). A Discord API client ID, secret and redirect URL must be supplied when using this strategy. The strategy also requires a verify callback, which receives the access token and an optional refresh token, as well as a profile which contains the authenticated Discord user's profile. The verify callback must also call cb providing a user to complete the authentication.

const DiscordStrategy = require('discord-oauth2-simple').Strategy;

const scopes = ['identify', 'email', 'guilds', 'guilds.join'];

passport.use(new DiscordStrategy({
    clientID: '',
    clientSecret: '',
    callbackURL: 'https://mylovely.website/auth/discord/callback',
    scope: scopes
},
function(accessToken, refreshToken, profile, cb) {
    User.findOrCreate({ discordId: profile.id }, function(err, user) {
        return cb(err, user);
    });
}));

Authentication Requests

Use passport.authenticate(), and specify the 'discord' strategy to authenticate requests.

For example, as a route middleware in an Express app:

app.get('/auth/discord', passport.authenticate('discord')); // Redirects to Discord oauth page.
app.get('/auth/discord/callback', passport.authenticate('discord', {
    failureRedirect: '/'
}), function(req, res) {
    res.redirect('/anonymous-land') // Successful auth
});

If using the bot scope, the permissions option can be set to indicate specific permissions your bot needs on the server (permission codes):

app.get("/auth/discord", passport.authenticate("discord", { permissions: 66321471 }));

Refresh Token Usage

In some use cases where the profile may be fetched more than once or you want to keep the user authenticated, refresh tokens may wish to be used. A package such as passport-oauth2-refresh can assist in doing this.

Example:

npm install passport-oauth2-refresh --save
var DiscordStrategy = require('discord-oauth2-simple').Strategy
  , refresh = require('passport-oauth2-refresh');

var discordStrat = new DiscordStrategy({
    clientID: '656863586756591637',
    clientSecret: '-tWPPY8WEJcCLcJzShjb1Y4KyGgyoVue',
    callbackURL: 'https://my.website/auth/discord/callback'
},
function(accessToken, refreshToken, profile, cb) {
    profile.refreshToken = refreshToken; // store this for later refreshes
    User.findOrCreate({ discordId: profile.id }, function(err, user) {
        if (err)
            return done(err);

        return cb(err, user);
    });
});

passport.use(discordStrat);
refresh.use(discordStrat);

... then if we require refreshing when fetching an update or something ...

refresh.requestNewAccessToken('discord', profile.refreshToken, function(err, accessToken, refreshToken) {
    if (err)
        throw; // boys, we have an error here.
    
    profile.accessToken = accessToken; // store this new one for our new requests!
});

Examples

An Express server example can be found in the /example directory. Be sure to npm install in that directory to get the dependencies.

License

Licensed under the MIT license. The full license text can be found in the root of the project repository.