README.md
# passport-twitch.js
[](https://github.com/semantic-release/semantic-release)
[](https://codeclimate.com/github/Bioblaze/passport-twitch.js)
[](https://discord.gg/T8uVhzU)
[](https://paypal.me/BioblazePayne)
Twitch is a trademark or registered trademark of Twitch Interactive, Inc. in the U.S. and/or other countries. "passport-twitch.js" is not operated by, sponsored by, or affiliated with Twitch Interactive, Inc. in any way.
[Passport](http://passportjs.org/) strategies for authenticating with [Twitch](http://www.twitch.tv/)
using OAuth 2.0 on the New & Old Twitch API.
This module lets you authenticate using Twitch in your Node.js applications.
By plugging into Passport, Twitch authentication can be easily and
unobtrusively integrated into any application or framework that supports
[Connect](http://www.senchalabs.org/connect/)-style middleware, including
[Express](http://expressjs.com/).
## Install
```bash
$ npm install passport-twitch.js
```
## Usage of OAuth 2.0
#### Configure Strategy
The Twitch OAuth 2.0 authentication strategy authenticates users using a Twitch
account and OAuth 2.0 tokens. The strategy requires a `verify` callback, which
accepts these credentials and calls `done` providing a user, as well as
`options` specifying a client ID, client secret, and callback URL.
```javascript
var passport = require("passport");
var twitchStrategy = require("passport-twitch.js").Strategy;
passport.use(new twitchStrategy({
clientID: TWITCH_CLIENT_ID,
clientSecret: TWITCH_CLIENT_SECRET,
callbackURL: "http://127.0.0.1:3000/auth/twitch/callback",
scope: "user_read"
},
function(accessToken, refreshToken, profile, done) {
//Handle Database Query Addition Here.
}
));
```
#### Authenticate Requests
Use `passport.authenticate()`, specifying the `"twitch.js"` strategy, to
authenticate requests.
For example, as route middleware in an [Express](http://expressjs.com/)
application:
```javascript
app.get("/auth/twitch", passport.authenticate("twitch.js"));
app.get("/auth/twitch/callback", passport.authenticate("twitch.js", { failureRedirect: "/" }), function(req, res) {
// Successful authentication, redirect home.
res.redirect("/");
});
```
Optionally, the `forceVerify` option can be set to `true` to indicate
that the user should be re-prompted for authorization:
```javascript
app.get("/auth/twitch", passport.authenticate("twitch.js", {forceVerify: true}));
```
The request to this route should include a GET or POST data with the keys `access_token` and optionally, `refresh_token` set to the credentials you receive from Twitch.
```
GET /auth/twitch?access_token=<TOKEN>
```
## Issues
If you receive a `401 Unauthorized` error, it is most likely because you have wrong access token or not yet specified any application permissions.
Once you refresh access token with new permissions, try to send this access token again.
## Example
```javascript
#!/bin/env node
require('dotenv').config();
var express = require('express');
var session = require('express-session');
var helmet = require('helmet');
var bodyParser = require('body-parser');
var passport = require('passport');
var refresh = require('passport-oauth2-refresh');
var _strategy = require('passport-twitch.js').Strategy;
var app = express();
app.use(session({
key: process.env.SESSION_KEY,
secret: process.env.SESSION_SECRET,
resave: true,
saveUninitialized: true,
cookie: {
secure: true
}
}));
app.use(helmet());
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
passport.serializeUser(function(u, d) {
d(null, u);
});
passport.deserializeUser(function(u, d) {
d(null, u);
});
var TwitchStrategy = new _strategy({
clientID: process.env.TWITCH_ID,
clientSecret: process.env.TWITCH_SECRET,
callbackURL: "http://127.0.0.1:3000/auth/twitch/callback",
scope: ["guilds", "connections", "email"]
}, function(accesstoken, refreshToken, profile, done) {
console.log(profile);
return done(null, profile);
});
passport.use(TwitchStrategy);
refresh.use(TwitchStrategy);
app.get('/', function(req, res) {
if (!req.session.user) {
res.redirect('/login');
} else {
res.send(`Hello ${req.session.user.display_name}`);
}
});
app.get('/login', passport.authenticate('twitch.js'}));
app.get('/auth/twitch/callback', passport.authenticate('twitch.js', { failureRedirect: '/' }), function(req, res) {
req.session.user = req.user;
console.log(req.user);
console.log(req.query);
res.redirect('/');
});
app.listen(process.env.SITE_PORT, process.env.SITE_HOST, function() {
console.log(`Express Started`);
});
```
Projected Maintained by: Randolph Aarseth(Bioblaze Payne)