npmpackage.info

@auth0/angular-jwt

Helper library for handling JWTs in Angular apps

5.2.0

2,633

MIT

TypeScript

2.18 kB

45,004,357 5.7

Installations

npm install @auth0/angular-jwt

Pull Requests

Open

4

Total

280

Closed

105

Merged

171

Issues

Open

2

Total

513

Closed

511

Releases

v5.2.0

Published on 31 Oct 2023

v5.1.2

Published on 20 Dec 2022

v5.1.1

Published on 15 Dec 2022

v5.1.0

Published on 03 Oct 2022

v5.0.1

Published on 07 Jul 2020

v5.0.0

Published on 07 Jul 2020

View all 44 releases

Developer

auth0

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

No

Node Version

18.18.2

NPM Version

9.8.1 Statistics

2,633 Stars

529 Commits

485 Forks

86 Watching

11 Branches

102 Contributors

Updated on 27 Nov 2024

Bundle Size

6.02 kB

Minified

2.18 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (93.24%)

JavaScript (5.92%)

HTML (0.66%)

SCSS (0.18%)

Total Downloads

Cumulative downloads

Total Downloads

45,004,357

Last day

-11.4%

40,363

Compared to previous day

Last week

-4.5%

215,629

Compared to previous week

Last month

15.1%

928,093

Compared to previous month

Last year

9,879,967

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

tslib

Peer Dependencies

@angular/common

Versions

Release Downloads

:books: Documentation - :rocket: Getting Started - :computer: API Reference - :speech_balloon: Feedback

Documentation

Examples - code samples for common angular-jwt authentication scenario's.
Docs site - explore our docs site and learn more about Auth0.

This library provides an HttpInterceptor which automatically attaches a JSON Web Token to HttpClient requests.

This library does not have any functionality for (or opinion about) implementing user authentication and retrieving JWTs to begin with. Those details will vary depending on your setup, but in most cases, you will use a regular HTTP request to authenticate your users and then save their JWTs in local storage or in a cookie if successful.

Getting started

Requirements

This project only supports the actively supported versions of Angular as stated in the Angular documentation. Whilst other versions might be compatible they are not actively supported

Installation

1# installation with npm
2npm install @auth0/angular-jwt
3
4# installation with yarn
5yarn add @auth0/angular-jwt

Configure the SDK

Import the JwtModule module and add it to your imports list. Call the forRoot method and provide a tokenGetter function. You must also add any domains to the allowedDomains, that you want to make requests to by specifying an allowedDomains array.

Be sure to import the HttpClientModule as well.

1import { JwtModule } from "@auth0/angular-jwt";
2import { HttpClientModule } from "@angular/common/http";
3
4export function tokenGetter() {
5  return localStorage.getItem("access_token");
6}
7
8@NgModule({
9  bootstrap: [AppComponent],
10  imports: [
11    // ...
12    HttpClientModule,
13    JwtModule.forRoot({
14      config: {
15        tokenGetter: tokenGetter,
16        allowedDomains: ["example.com"],
17        disallowedRoutes: ["http://example.com/examplebadroute/"],
18      },
19    }),
20  ],
21})
22export class AppModule {}

Any requests sent using Angular's HttpClient will automatically have a token attached as an Authorization header.

1import { HttpClient } from "@angular/common/http";
2
3export class AppComponent {
4  constructor(public http: HttpClient) {}
5
6  ping() {
7    this.http.get("http://example.com/api/things").subscribe(
8      (data) => console.log(data),
9      (err) => console.log(err)
10    );
11  }
12}

Using with Standalone Components

If you are using bootstrapApplication to bootstrap your application using a standalone component, you will need a slightly different way to integrate our SDK:

1import { JwtModule } from "@auth0/angular-jwt";
2import { provideHttpClient, withInterceptorsFromDi } from "@angular/common/http";
3
4export function tokenGetter() {
5  return localStorage.getItem("access_token");
6}
7
8bootstrapApplication(AppComponent, {
9    providers: [
10        // ...
11        importProvidersFrom(
12            JwtModule.forRoot({
13                config: {
14                    tokenGetter: tokenGetter,
15                    allowedDomains: ["example.com"],
16                    disallowedRoutes: ["http://example.com/examplebadroute/"],
17                },
18            }),
19        ),
20        provideHttpClient(
21            withInterceptorsFromDi()
22        ),
23    ],
24});

As you can see, the differences are that:

The SDK's module is included trough importProvidersFrom.
In order to use the SDK's interceptor, provideHttpClient needs to be called with withInterceptorsFromDi.

API reference

Read our API reference to get a better understanding on how to use this SDK.

Feedback

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Auth0 Logo

Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?

This project is licensed under the MIT license. See the LICENSE file for more info.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

10

SAST

Determines if the project uses static code analysis.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

7

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

6

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

1

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

5.7

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @auth0/angular-jwt

jwt-decode

4.0.0

Decode JWT tokens, mostly useful for browser applications.

jose

5.9.6

JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes

passport-jwt

4.0.1

Passport authentication strategy using JSON Web Tokens

jsonwebtoken

9.0.2

JSON Web Token implementation (symmetric and asymmetric)