0.1.1 • Published 3 years ago

@utagritech/firebasedeviceflow v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Firebase Device Flow

forthebadge forthebadge

Firebase authentication via OAuth2 'Device Flow' for Node.js CLI applications on limited input devices (i.e. IoT).

Build Status

Providers Currently Implemented

Example Usage

See test.ts.

  1. Import FirebaseDeviceFlow.
  2. Initialize your Firebase app.
  3. Pass Firebase app reference and OAuth config object to DeviceFlowUI constructor. If any parameters are absent from the OAuth config object, the relevant auth provider will be excluded from the UI.
  4. Execute DeviceFlowUI.signIn(). This will return a Promise\<UserCredential>.

How It Works

Google has a great resource on "OAuth 2.0 for TV and Limited-Input Device Applications".

Device Flow Diagram

Development

Build and test with the usual npm run build, npm run test. For testing, you will have to initialize your own Firebase app and provider support.

Requirements

  • Node.js and npm
  • Dependencies (install with npm install)

Todo

  • Convert to Typescript
  • Change package structure for easier import (currently import { DeviceFlowUI } from 'FirebaseDeviceFlow/dist/FirebaseDeviceFlow';)
  • Fix testing
  • 'Slow down' error code handling?
  • Add more providers?

firebase