# passport-playstrategy

> PlayStrategy authentication strategy for Passport.

Latest version **1.0.1** (published 2023-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install passport-playstrategy
pnpm add passport-playstrategy
yarn add passport-playstrategy
bun add passport-playstrategy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-03-01 |
| First published | 2023-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.4.0 |
| Dependencies | 1 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Thibault Duplessis |
| Maintainers | theyobotsgithub |
| Keywords | passport, playstrategy, games, auth, authn, authentication, identity |

## Links

- npm: https://www.npmjs.com/package/passport-playstrategy
- Repository: https://github.com/TheYoBots/passport-lishogi.git#playstrategy
- Homepage: https://github.com/TheYoBots/passport-lishogi/tree/playstrategy#readme
- Issues: http://github.com/TheYoBots/passport-lishogi/issues
- npm.io page: https://npm.io/package/passport-playstrategy

## Dependencies (1)

- [passport-oauth2](https://npm.io/package/passport-oauth2.md) 1.x.x

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-03-01
- 1.0.0 — 2023-03-01

## README

# passport-lishogi

[*Based on passport-lichess*](https://github.com/ornicar/passport-lichess)

[![npm](https://img.shields.io/npm/v/passport-shogi)](https://www.npmjs.com/package/passport-shogi)

[Passport](http://passportjs.org/) strategy for authenticating with [Lishogi](https://lishogi.org)
using the OAuth 2.0 API.

This module lets you authenticate using Lishogi in your Node.js applications.
By plugging into Passport, Lishogi 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-shogi
```

## Usage

#### Configure Strategy

The Lishogi authentication strategy authenticates users using a Lishogi account
and OAuth 2.0 tokens. The client ID and secret obtained when creating an
application are supplied as options when creating the strategy. The strategy
also requires a `verify` callback, which receives the access token and optional
refresh token, as well as `profile` which contains the authenticated user's
Lishogi profile. The `verify` callback must call `cb` providing a user to
complete authentication.

```js
var LishogiStrategy = require('passport-shogi').Strategy;

passport.use(
  new LishogiStrategy(
    {
      clientID: 'arbitrary-unique-id',
      callbackURL: 'http://127.0.0.1:3000/auth/lishogi/callback',
    },
    function (accessToken, refreshToken, profile, cb) {
      User.findOrCreate({ lishogiId: profile.id }, function (err, user) {
        return cb(err, user);
      });
    }
  )
);
```

#### Authenticate Requests

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

For example, as route middleware in an [Express](http://expressjs.com/)
application:

```js
app.get('/auth/lishogi', passport.authenticate('lishogi'));

app.get('/auth/lishogi/callback', passport.authenticate('lishogi', { failureRedirect: '/login' }), function (req, res) {
  // Successful authentication, redirect home.
  res.redirect('/');
});
```

## Examples

Developers using the popular [Express](http://expressjs.com/) web framework can
refer to an [example](https://github.com/passport/express-4.x-facebook-example)
as a starting point for their own web applications. The example shows how to
authenticate users using Facebook. However, because both Facebook and Lishogi
use OAuth 2.0, the code is similar. Simply replace references to Facebook with
corresponding references to Lishogi.

## Credits

This library is a based on [Jared Hanson's passport-github](https://github.com/jaredhanson/passport-github).

---
_Source: https://npm.io/package/passport-playstrategy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._