@octokit/oauth-authorization-url

v7.1.1

Universal library to retrieve GitHubâs identity URL for the OAuth web flow For more information about how to use this package see README

Latest version published 7 months ago

License: MIT

NPM

GitHub

Package Health Score

85 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
7.1.1	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.0.1	\|	02/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.0.2	\|	06/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.0.0	\|	07/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.3.3	\|	08/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (947,751)

GitHub Stars: 16
Forks: 13
Contributors: 20

Direct Usage Popularity

The npm package @octokit/oauth-authorization-url receives a total of 947,751 downloads a week. As such, we scored @octokit/oauth-authorization-url popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @octokit/oauth-authorization-url, we found that it has been starred 16 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the @octokit/oauth-authorization-url repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 1
Last Release: 7 months ago
Last Commit: 10 days ago

Further analysis of the maintenance status of @octokit/oauth-authorization-url based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @octokit/oauth-authorization-url demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 18

Age: 5 years
Dependencies: 0 Direct
Versions: 22
Install Size: 12.8 kB
Dist-tags: 2
# of Files: 6
Maintainers: 4
TS Typings: Yes

@octokit/oauth-authorization-url has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

oauth-authorization-url.js

> Universal library to retrieve GitHub’s identity URL for the OAuth web flow

See GitHub’s Developer Guide for the OAuth App web application flow. Note that the OAuth web application flow for GitHub Apps is slightly different. GitHub Apps do not support scopes for its user access tokens (they are called user-to-server tokens for GitHub Apps), instead they inherit the user permissions from the GitHub App's registration and the repository/organization access and permissions from the respective installation.

Usage
- For OAuth Apps
- For GitHub Apps
Options
Result
Types
License

Usage

Browsers

Browsers	Load `@octokit/oauth-authorization-url` directly from esm.sh
Node	Install with `npm install @octokit/oauth-authorization-url` `const { oauthAuthorizationUrl } = require("@octokit/oauth-authorization-url"); // or: import { oauthAuthorizationUrl } from "@octokit/oauth-authorization-url";`

Load @octokit/oauth-authorization-url directly from esm.sh

Node

Install with npm install @octokit/oauth-authorization-url

const { oauthAuthorizationUrl } = require("@octokit/oauth-authorization-url");
// or: import { oauthAuthorizationUrl } from "@octokit/oauth-authorization-url";

> [!IMPORTANT] > As we use conditional exports, you will need to adapt your tsconfig.json by setting "moduleResolution": "node16", "module": "node16". > > See the TypeScript docs on package.json "exports".
> See this helpful guide on transitioning to ESM from @sindresorhus

For OAuth Apps

const { url, clientId, redirectUrl, login, scopes, state } =
  oauthAuthorizationUrl({
    clientType: "oauth-app",
    clientId: "1234567890abcdef1234",
    redirectUrl: "https://example.com",
    login: "octocat",
    scopes: ["repo", "admin:org"],
    state: "secret123",
  });

For GitHub Apps

const { url, clientId, redirectUrl, login, state } = oauthAuthorizationUrl({
  clientType: "github-app",
  clientId: "lv1.1234567890abcdef",
  redirectUrl: "https://example.com",
  login: "octocat",
  state: "secret123",
});

Options

name	description
`clientId`	Required. The client ID you received from GitHub when you registered.
`clientType`	Must be set to either `"oauth-app"` or `"github-app"`. Defaults to `"oauth-app"`.
`redirectUrl`	The URL in your application where users will be sent after authorization. See Redirect URLs in GitHub’s Developer Guide.
`login`	Suggests a specific account to use for signing in and authorizing the app.
`scopes`	Only relevant when `clientType` is set to `"oauth-app"`. An array of scope names (or: space-delimited list of scopes). If not provided, scope defaults to an empty list for users that have not authorized any scopes for the application. For users who have authorized scopes for the application, the user won't be shown the OAuth authorization page with the list of scopes. Instead, this step of the flow will automatically complete with the set of scopes the user has authorized for the application. For example, if a user has already performed the web flow twice and has authorized one token with user scope and another token with repo scope, a third web flow that does not provide a scope will receive a token with user and repo scope. Defaults to `[]` if `clientType` is set to `"oauth-app"`.
`state`	An unguessable random string. It is used to protect against cross-site request forgery attacks. Defaults to `Math.random().toString(36).substr(2)`.
`allowSignup`	Whether or not unauthenticated users will be offered an option to sign up for GitHub during the OAuth flow. Use `false` in the case that a policy prohibits signups. Defaults to `true`.
`baseUrl`	When using GitHub Enterprise Server, set the baseUrl to the origin, e.g. `https://github.my-enterprise.com`.

Result

oauthAuthorizationUrl() returns an object with the following properties

name	description
`allowSignup`	Returns `options.allowSignup` if it was set. Defaults to `true`.
`clientType`	Returns `options.clientType`. Defaults to `"oauth-app"`.
`clientId`	Returns `options.clientId`.
`login`	Returns `options.login` if it was set. Defaults to `null`.
`redirectUrl`	Returns `options.redirectUrl` if it was set. Defaults to `null`.
`scopes`	Only set if `options.clientType` is set to `"oauth-app"`. Returns an array of strings. Returns `options.scopes` if it was set and turns the string into an array if a string was passed, otherwise `[]`.
`state`	Returns `options.state` if it was set. Defaults to Defaults to `Math.random().toString(36).substr(2)`.
`url`	The authorization URL

Types

import {
  ClientType,
  OAuthAppOptions,
  OAuthAppResult,
  GitHubAppOptions,
  GitHubAppResult,
} from "@octokit/oauth-authorization-url";

License

MIT

@octokit/oauth-authorization-url development dependencies

@octokit/tsconfig @types/jest esbuild glob jest prettier ts-jest typescript

FAQs

What is @octokit/oauth-authorization-url?

Universal library to retrieve GitHubâs identity URL for the OAuth web flow. Visit Snyk Advisor to see a full health score report for @octokit/oauth-authorization-url, including popularity, security, maintenance & community analysis.

Is @octokit/oauth-authorization-url popular?

The npm package @octokit/oauth-authorization-url receives a total of 947,751 weekly downloads. As such, @octokit/oauth-authorization-url popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @octokit/oauth-authorization-url well maintained?

We found that @octokit/oauth-authorization-url demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @octokit/oauth-authorization-url safe to use?

The npm package @octokit/oauth-authorization-url was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 7 November-2024, at 05:31 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (947,751)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

oauth-authorization-url.js

Usage

For OAuth Apps

For GitHub Apps

Options

Result

Types

License

@octokit/oauth-authorization-url development dependencies

FAQs

What is @octokit/oauth-authorization-url?

Is @octokit/oauth-authorization-url popular?

Is @octokit/oauth-authorization-url well maintained?

Is @octokit/oauth-authorization-url safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues