Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 3.47 KB

README.md

File metadata and controls

101 lines (69 loc) · 3.47 KB
Raw

webext-launch-web-auth-flow

Polyfill launchWebAuthFlow with popups or browser tabs.

Installation

Via npm

npm install webext-launch-web-auth-flow
// With ESM Modules
import launchWebAuthFlow from "webext-launch-web-auth-flow";

// With CommonJS
const launchWebAuthFlow = require("webext-launch-web-auth-flow");

If you use TypeScript, you have to install @types/webextension-polyfill:

npm install @types/webextension-polyfill

Pre-built dist

You can find it under the dist folder, or download from unpkg.

Why

  1. Builtin launchWebAuthFlow doesn't reuse the browser session. This library does.
  2. Builtin launchWebAuthFlow doesn't allow custom redirect_uri. This library does.

Permissions

{
 "background": {
    ...
    "persistent": true
  },
  "permissions": [
    "webRequest",
    "webRequestBlocking",
    "webNavigation",
    "https://my.redirect.uri/*"
  ]
}

To polyfill launchWebAuthFlow, this library uses following API/permissions:

  1. windows and tabs - this library launches a window dialog (or tab in Firefox android) to login. Most methods from these APIs can be used without explicitly declaring any permissions in the extension's manifest file, therefore there's no need to mention them in the code above.
  2. webRequest - this library cannot be used with event pages, otherwise you'll get this error. To avoid it, set your background page persistent key to true.
  3. webRequestBlocking this cancels the request to redirect_uri so it won't leak the token/code to redirect_uri (or redirect_uri is unresolveable e.g. the URL from identity.getRedirectURL).
  4. webNavigation - the login dialog is minimized unless there is no redirect. It checks the loading state using webNavigation.onDOMContentLoaded.

Compatibility

This library references the browser global variable, which is from Firefox. To make it work on Chrome (which uses the chrome global variable instead) install webextension-polyfill.

Known issues

API reference

This module exports a single function.

webextLaunchWebAuthFlow

async launchWebAuthFlow({
  url: String,
  redirect_uri: String,
  interactive?: Boolean = false,
  alwaysUseTab?: Boolean = false,
  windowOptions?: Object
}) => finalUrl: String

See the official document for url, redirect_uri, and interactive options. Note that redirect_uri is required in this library.

By default, this library uses a popup to display the login page. If popups are unavailable (which usually happens on mobile browsers), it uses a tab instead. Set alwaysUseTab to true to always use a tab.

Use windowOptions to set extra properties that will be sent to browser.windows.create.

Changelog

  • 0.1.2 (Nov 28, 2022)

    • Add: TypeScript declaration file.

  • 0.1.1 (Feb 18, 2021)

    • Add: alwaysUseTab option.
    • Add: windowOptions option.

  • 0.1.0 (Aug 15, 2020)

    • First release.