# feathers-authentication-popups

> Server and client utils for implementing popup-based authentication flows

Latest version **0.1.2** (published 2016-11-22) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install feathers-authentication-popups
pnpm add feathers-authentication-popups
yarn add feathers-authentication-popups
bun add feathers-authentication-popups
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2016-11-22 |
| First published | 2016-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.6.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Marshall Thompson |
| Maintainers | daffl, ekryski, marshallswain |
| Keywords | feathers, feathers-plugin |

## Links

- npm: https://www.npmjs.com/package/feathers-authentication-popups
- Repository: https://github.com/feathersjs/feathers-authentication-popups
- Issues: https://github.com/feathersjs/feathers-authentication-popups/issues
- npm.io page: https://npm.io/package/feathers-authentication-popups

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [events](https://npm.io/package/events.md) ^1.1.1
- [feathers-errors](https://npm.io/package/feathers-errors.md) ^2.4.0

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2016-11-22
- 0.1.1 — 2016-11-22
- 0.1.0 — 2016-11-22
- 0.0.9 — 2016-11-09
- 0.0.5 — 2016-10-27
- 0.0.4 — 2016-10-27
- 0.0.3 — 2016-10-27
- 0.0.2 — 2016-10-27
- 0.0.1 — 2016-10-27
- 0.0.0 — 2016-10-27

## README

# feathers-authentication-popups

[![Build Status](https://travis-ci.org/feathersjs/feathers-authentication-popups.png?branch=master)](https://travis-ci.org/feathersjs/feathers-authentication-popups)
[![Code Climate](https://codeclimate.com/github/feathersjs/feathers-authentication-popups/badges/gpa.svg)](https://codeclimate.com/github/feathersjs/feathers-authentication-popups)
[![Test Coverage](https://codeclimate.com/github/feathersjs/feathers-authentication-popups/badges/coverage.svg)](https://codeclimate.com/github/feathersjs/feathers-authentication-popups/coverage)
[![Dependency Status](https://img.shields.io/david/feathersjs/feathers-authentication-popups.svg?style=flat-square)](https://david-dm.org/feathersjs/feathers-authentication-popups)
[![Download Status](https://img.shields.io/npm/dm/feathers-authentication-popups.svg?style=flat-square)](https://www.npmjs.com/package/feathers-authentication-popups)
[![Slack Status](http://slack.feathersjs.com/badge.svg)](http://slack.feathersjs.com)

> Server and client utils for implementing popup-based authentication flows

## Summary

This package includes a few useful tools for implementing popup-based OAuth login flows.  It contains utility functions for the browser and middleware for the server.

## Using the Client Utils
There are two client utilities: one to assist with opening popups, and another to assist in cross-window communication.

## `openLoginPopup(url, options)`
Opens a centered popup window at the given `url`.

```js
import openLoginPopup from 'feathers-authentication-popups';

openLoginPopup('/auth/github');
```

1. **url** `{String}`: The URL of the new window.
2. **options** `{Object}`: optional - allows for customizing the `width` and `height` of the popup window.

The default `options` are:
* `width`: 1024,
* `height`: 630

## `authAgent`

An EventEmitter automatically assigned as a global at `window.authAgent` to allow popup windows to send information back to the main window.  Both windows must be on the same domain for this to work.

**Usage in the primary application window:**

```js
// Adds 
import 'feathers-authentication-popups';

function doSomethingWithToken (token) {
	// Do something with the token
}

window.authAgent.on('login', doSomethingWithToken);
```
The `doSomethingWithToken` function will run when the 'login' event is emitted on `window.authAgent`.

**Usage in the popup window on the same domain:**
```js
var token = readCookie('feathers-jwt');

// Trigger the 'login' event on the main window's `authAgent`
window.opener.authAgent.emit('login', token);
```

### `authAgent.on(eventName, handler)`

Adds an event listener to the `authAgent` whose handler runs every time the event with given `eventName` is triggered.
1. **eventName** `{String}`: The name of the event to subscribe to.
2. **handler** `{Function}`: A function to be executed to handle the event.

### `authAgent.once(eventName, handler)`

Adds an event listener to the `authAgent` whose handler runs only once when the event with given `eventName` is triggered.
1. **eventName** `{String}`: The name of the event to subscribe to.
2. **handler** `{Function}`: A function to be executed to handle the event.

### `authAgent.off(eventName, handler`)

Removes a handler function from the `authAgent`
1. **eventName** `{String}`: The name of the event to unsubscribe from.
2. **handler** `{Function}`: A reference to a previously-subscribed function to be unsubscribed.

### `authAgent.emit(eventName, args)

Triggers the event attached to the provided `eventName` and calls the subscribed handlers with the `args`.
1. **eventName** `{String}`: The name of the event to trigger.
2. **args** `{any}`: arguments to be passed to event handlers, usually authentication-related information (like a JSON Web Token).

## Using the Express Middleware

The Express middleware is meant to be registered as the success callback of a Feathers authentication workflow.

### `successHandler(options|cookieName)`

Creates Express middleware that handles successful auth by returning an HTML page that:
* Pulls the token from the cookie location.
* Sends the token to the parent window through the `authAgent`.
* Closes the popup window.

```js
var successHandler = require('feathers-authentication-popups/middleware');

// Pass an object containing a `name` attribute.
var options = app.get('cookie');
app.get('/auth/success', successHandler(options));

// Or pass a string for the cookie name.
app.get('/auth/success', successHandler('feathers-jwt'));
```

1. **options** `{Object}`: An object with a `name` attribute.
1. **cookieName** `{String}`: The cookie name. 

## License

Copyright (c) 2016

Licensed under the [MIT license](LICENSE).

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