@kofile/jwt-client v4.0.1

@kofile/jwt-client

A simple JWT Reader.

Usage

const makeClient = require('@kofile/jwt-client')
const client = makeClient(jwt)

API

client.userId

client.tenantId

client.ort

client.encoded

client.dump()

client.getRoleIdForTenant(tenantId)

client.validate()

Usage Example

const makeClient = require('@kofile/jwt-client')
const payload = {
  id: 123,
  tenantId: '48121',
  ort: 'dsgsgasdgdfhws',
  tenant: {
    48121: {
      authorization: 1
    }
  }
}
const jwt = jsonwebtoken.sign(payload, 'key')

const client = makeClient(jwt)

// get user id
client.userId //=> 123

// get tenant id
client.tenantId //=> 48121

//get ort
client.ort //=> dsgsgasdgdfhws

// get encoded jwt
client.encoded //=> jsonwebtoken.sign(payload, 'key')

// get the entire payload body
client.dump() //=> payload

// get role id for a tenant
client.getRoleIdForTenant(tenantId) //=> 1

// check if an error is a custom JwtError
makeClient.isAJwtError(myError)

// validate that `userId` and `ort` are not null or undefined
//
// - throws a custom JwtError if a key is null or undefined
// - returns true if validations pass
// - pass in the keys of the public API, **not** internal structure
client.validate(['userId', 'ort'])