@teamteanpm2024/dolores-eum-qui

v1.1.5

Published

7 months ago

![Browser library that helps decoding JWT tokens which are Base64Url encoded](https://cdn.auth0.com/website/sdks/banners/@teamteanpm2024/dolores-eum-qui-banner.png)

Downloads

0High
0Medium
0Low

shivamkalsi2024

autoprefixer windows expression tslib require random guid tools ECMAScript 2022 bcrypt io-ts up pose matchAll -0 status fast assertion match break art flags shell es2018 columns picomatch prefix variables sanitization vest exec nodejs wait has cloudwatch helpers react api utils ReactiveExtensions jest ES2018 offset Object set crypto connect sigterm censor ECMAScript 2018 get spinner proxy streams2 minimal gdpr debugger toobject regular expression safe Int8Array mocha module dom-testing-library superagent ECMAScript 7 kinesis classname preprocessor speed logging side tty modules curl ast prototype hash ECMAScript 5 i18n color ECMAScript 2019 logger Array.prototype.flatten bootstrap less ecmascript express phone symbols terminal ES2020 arktype resolve getopt spec syntaxerror bluebird browserlist japanese css less yaml cache merge workspace:*es7 korean .env define variables in css spinners typesafe importexport parents cloudtrail Array.prototype.findLastIndex buffer ie settings traverse inference fast-deep-clone mobile immutable URLSearchParams Object.is javascript waapi toSorted libphonenumber idle sqs code points estree width es6 Promise env accessibility less sorted symlink ender reduce path batch log events getintrinsic robust internal slot indicator eventEmitter array fantasy-land colors regexp fixed-width limit open valid busy sequence https equal hooks compare persistent efficient macos animation dependency manager whatwg test StyleSheet wrap xterm make prune link rate monorepo Reflect.getPrototypeOf xss private css variable setter recursive create file system Rx loadbalancing intrinsic l10n output Uint8ClampedArray 256 nested css postcss installer argument const style gradients css3 styleguide map awesomesauce iteration drop node which equality fast-copy es5 typedarrays delete listeners iterate toArray import is names circular colour pipe auth byteOffset findup harmony Int16Array amazon less mixins fast-deep-copy extra CSS view rapid mimetypes task regular queue eslint-plugin unicode fps full-width less.js balanced stateless structuredClone ES from runtime Array.prototype.includes agent testing figlet babel Array.prototype.contains command BigUint64Array dir trimLeft telephone hardlinks internal dotenv jasmine fastify beanstalk utility js obj slot flag @@toStringTag redux-toolkit group jsdom performant progress toStringTag types deep-clone findLastIndex fetch fs ArrayBuffer.prototype.slice tester simpledb popmotion clone RxJS rgb trimStart ES2015 compile less readable AsyncIterator Uint8Array mime Map reuse emr trimEnd column descriptor remove drag storagegateway invariant es8 workflow metadata WeakMap mkdirs babel-core browserslist Float32Array ES8 syntax flatten chromium handlers deepcopy zero Array.prototype.filter config channel Uint32Array es-shims ES7 ratelimit collection symlinks every prop ajv ansi framework password ES2023 tape sharedarraybuffer moment authentication Observables optimist spring iterator pretty deepclone react-hook-form protobuf web callbind sham bind json-schema-validation wget number sanitize exit look-up jsonpath reducer compiler touch dayjs rm ECMAScript 2017 args watchFile filter watcher fastclone process css search ECMAScript 2021 flatMap file private data throat findLast rangeerror transpile bundler mapreduce ECMAScript 6 less css form-validation ECMAScript 2020 0 deep-copy length getter Object.defineProperty duplex glacier $.extend async url rds computed-types walking classnames groupBy defineProperty ArrayBuffer#slice gradients css nope operating-system s3 typescript characters concurrency dataView properties enumerable wordwrap deep dependencies stylesheet ES2016 qs keys commander Array cloudfront joi xhr Object.entries linux redact json pnpm9 yup negative forms wordbreak consume sort es-abstract 3d console bundling queueMicrotask TypedArray install emoji read bdd _.extend trim BigInt64Array values mru diff postcss-plugin typanion Object.getPrototypeOf browser property endpoint text ESnext loading codes core key uuid eslint shebang east-asian-width visual higher-order extension regular expressions YAML tc39 ajax cloudsearch object stringifier rm -rf banner waf form command-line RegExp#flags date three ec2 bound scheme rfc4122 copy entries pyyaml CSSStyleDeclaration performance exit-code Uint16Array shrinkwrap schema directory trimRight contains Array.prototype.flat last promise coercible cjk String.prototype.trim utilities WebSocket karma arraybuffer make dir character positive package manager curried flat assert extend ES2021 vpc native optimizer irq Observable Array.prototype.findLast Object.values real-time cloudformation linewrap cors point-free collection.es6 Symbol.toStringTag preserve-symlinks JSON-Schema core-js chinese TypeBox ES2022 parser typeerror push shim WeakSet tdd throttle query Object.fromEntries eslintplugin parsing protocol-buffers datastructure buffers validation dynamodb typedarray shared serializer react-testing-library ECMAScript 2016 react pose asserts pure parent css-in-js stream Underscore watch tacit airbnb es2016 arrays swf escape redux isConcatSpreadable formatting validate http 6to5 fsevents callback tostringtag time css nesting less compiler Function.prototype.name deterministic fp symbol warning function sigint Object.keys ebs request jsdiff signals mkdirp dataview writable call-bind lint ECMAScript 2015 input once zod WebSockets JSON stable getOwnPropertyDescriptor chrome ECMAScript 2023 mkdir rmdir getPrototypeOf chai format folder ECMAScript 3 term URL starter byte look jQuery ponyfill omit typed call-bound worker let es2017 write Int32Array call multi-package encryption argparse jwt typed array stringify descriptors autoscaling transpiler RegExp.prototype.flags es ES2017 ascii json-schema typeof ES5 eslintconfig configurable fastcopy description slice sameValueZero ramda dom user-streams glob regex lazy framer jsx package language walk fullwidth accessor proto ArrayBuffer ses generics lesscss tap polyfill querystring concat weakset Stream forEach value streams option var iam util.inspect full matches elb weakmap name readablestream Streams uninstall check Microsoft find [[Prototype]]packages functional npm callbound __proto__Push validator hasOwn package.json environment RFC-6455 ES2019 ES3 quote ReactiveX assign toolkit class-validator Symbol concatMap util mime-db take setPrototypeOf lockfile negative zero styled-components String.prototype.matchAll mixins react animation find-up json-schema-validator serialization watching inspect superstruct emit patch some error signal react-hooks lru sns

IMPORTANT: This library doesn't validate the token, any well-formed JWT can be decoded. You should validate the token in your server-side logic by using something like express-jwt, koa-jwt, Microsoft.AspNetCore.Authentication.JwtBearer, etc.

Release Downloads

:books: Documentation - :rocket: Getting Started - :speech_balloon: Feedback

Documentation

Docs site - explore our docs site and learn more about Auth0.

Getting started

Installation

Install with NPM or Yarn.

Run npm install @teamteanpm2024/dolores-eum-qui or yarn add @teamteanpm2024/dolores-eum-qui to install the library.

Usage

import { jwtDecode } from "@teamteanpm2024/dolores-eum-qui";

const token = "eyJ0eXAiO.../// jwt token";
const decoded = jwtDecode(token);

console.log(decoded);

/* prints:
 * { 
 *   foo: "bar",
 *   exp: 1393286893,
 *   iat: 1393268893  
 * }
 */

// decode header by passing in options (useful for when you need `kid` to verify a JWT):
const decodedHeader = jwtDecode(token, { header: true });
console.log(decodedHeader);

/* prints:
 * { 
 *   typ: "JWT",
 *   alg: "HS256" 
 * }
 */

Note: A falsy or malformed token will throw an InvalidTokenError error; see below for more information on specific errors.

Polyfilling atob

This library relies on atob(), which is a global function available on all modern browsers as well as every supported node environment.

In order to use @teamteanpm2024/dolores-eum-qui in an environment that has no access to atob() (e.g. React Native), ensure to provide the corresponding polyfill in your application by using core-js/stable/atob:

import "core-js/stable/atob";

Alternatively, you can also use base-64 and polyfill global.atob yourself:

import { decode } from "base-64";
global.atob = decode;

Errors

This library works with valid JSON web tokens. The basic format of these token is

[part1].[part2].[part3]

All parts are supposed to be valid base64 (url) encoded json. Depending on the { header: <option> } option it will decode part 1 (only if header: true is specified) or part 2 (default)

Not adhering to the format will result in a InvalidTokenError with one of the following messages:

Invalid token specified: must be a string => the token passed was not a string, this library only works on strings.
Invalid token specified: missing part # => this probably means you are missing a dot (.) in the token
Invalid token specified: invalid base64 for part # => the part could not be base64 decoded (the message should contain the error the base64 decoder gave)
Invalid token specified: invalid json for part # => the part was correctly base64 decoded, however, the decoded value was not valid JSON (the message should contain the error the JSON parser gave)

Use with TypeScript

The return type of the jwtDecode function is determined by the header property of the object passed as the second argument. If omitted (or set to false), it'll use JwtPayload, when true it will use JwtHeader. If needed, you can specify what the expected return type should be by passing a type argument to the jwtDecode function.

You can extend both JwtHeader and JwtPayload to include non-standard claims or properties.

import { jwtDecode } from "@teamteanpm2024/dolores-eum-qui";

const token = "eyJhsw5c";
const decoded = jwtDecode<JwtPayload>(token); // Returns with the JwtPayload type

Use as a CommonJS package

const { jwtDecode } = require('@teamteanpm2024/dolores-eum-qui');
...

Include with a script tag

Copy the file @teamteanpm2024/dolores-eum-qui.js from the root of the build/esm folder to your project somewhere, then import jwtDecode from it inside a script tag that's marked with type="module":

<script type="module">
  import { jwtDecode } from "/path/to/@teamteanpm2024/dolores-eum-qui.js";

  const token = "eyJhsw5c";
  const decoded = jwtDecode(token);
</script>

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.