https://github.com/idiocc/facebook
The Facebook OAuth Login Routes For The Idio Web Server.
https://github.com/idiocc/facebook
Last synced: 10 months ago
JSON representation
The Facebook OAuth Login Routes For The Idio Web Server.
- Host: GitHub
- URL: https://github.com/idiocc/facebook
- Owner: idiocc
- License: mit
- Created: 2018-12-10T08:50:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-13T19:21:34.000Z (over 7 years ago)
- Last Synced: 2025-07-06T02:47:01.394Z (12 months ago)
- Language: JavaScript
- Homepage: https://idio.cc
- Size: 48.8 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @idio/facebook
[](https://npmjs.org/package/@idio/facebook)
`@idio/facebook` is The Facebook OAth Login Routes For The Idio Web Server.
```sh
yarn add -E @idio/facebook
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`facebook(router: Router, config: Config)`](#facebookrouter-routerconfig-config-void)
* [`Config`](#type-config)
* [finish](#finish)
- [Copyright](#copyright)
## API
The package is available by importing its default function:
```js
import facebook from '@idio/facebook'
```
## `facebook(`
`router: Router,`
`config: Config,`
`): void`
Sets up the `/auth/facebook` and `/auth/facebook/redirect` paths on the router to enable Facebook App Login. The `session` middleware needs to be installed to remember the `state`. The state is destroyed after the redirect.
__`Config`__: Options for the program.
| Name | Type | Description | Default |
| ------------------ | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- |
| __client_id*__ | _string_ | The app's client id. | - |
| __client_secret*__ | _string_ | The app's client secret. | - |
| path | _string_ | The server path to start the login flaw and use for redirect (`${path}/redirect`). | `/auth/facebook` |
| scope | _string_ | The scope to ask permissions for. | - |
| finish | _(ctx, token, data) => {}_ | The function to complete the authentication that receives the token and the data about the user, such as name and id. The default function redirects to `/`. | `setSession; redirect;` |
```js
import facebook from '@idio/facebook'
import idioCore from '@idio/core'
const Server = async () => {
const { url, router, app } = await idioCore({
session: { use: true, keys: [process.env.SESSION_KEY || 'dev'] },
logger: { use: true },
}, { port: 5000 })
router.get('/', (ctx) => {
ctx.body = 'hello world'
})
facebook(router, {
client_id: process.env.CLIENT_ID,
client_secret: process.env.SECRET,
scope: 'manage_pages',
})
app.use(router.routes())
return { app, url }
}
```
```
http://localhost:5000
<-- GET /auth/facebook
--> GET /auth/facebook 302 19ms 385b
{ body: 'Redirecting to https://www.facebook.com/dialog/oauth?client_id=273790443337044&redirect_uri=http%3A%2F%2Flocalhost%3A5000%2Fauth%2Ffacebook%2Fredirect&state=5190&scope=manage_pages.',
headers:
{ location: 'https://www.facebook.com/dialog/oauth?client_id=273790443337044&redirect_uri=http%3A%2F%2Flocalhost%3A5000%2Fauth%2Ffacebook%2Fredirect&state=5190&scope=manage_pages',
'content-type': 'text/html; charset=utf-8',
'content-length': '385',
'set-cookie':
[ 'koa:sess=eyJzdGF0ZSI6NTE5MCwiX2V4cGlyZSI6MTU0NDUyNTE1OTMzNCwiX21heEFnZSI6ODY0MDAwMDB9; path=/; httponly',
'koa:sess.sig=xhelrdB1iw6iAPnzfii_i9BTvF8; path=/; httponly' ],
date: 'Mon, 10 Dec 2018 10:45:59 GMT',
connection: 'close' },
statusCode: 302,
statusMessage: 'Found' }
> Redirect to Dialog https://www.facebook.com/dialog/oauth?client_id=273790443337044&redirect_uri=http%3A%2F%2Flocalhost%3A5000%2Fauth%2Ffacebook%2Fredirect&state=5190&scope=manage_pages
```
### finish
The config allows to set the `finish` function that can be used to alter the logic of setting the token on the session or performing additional operations such as storing a new user in the database. The default sets the token on the `ctx.session` and also sets the user data such as name and id in the `ctx.session.user` property.
```js
finish = /* async */ (ctx, token, user, /* next */) => {
ctx.session.token = token
ctx.session.user = user
ctx.redirect('/')
// await storeInDb(token, user)
// await next()
},
```
## Copyright
(c) [Idio][1] 2018
[1]: https://idio.cc
