<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>token/baseTokenItem.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Auth.html">Auth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.acquireTokenSilent">acquireTokenSilent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.clearPersistenCache">clearPersistenCache</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.exchange">exchange</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.loginUrl">loginUrl</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.logoutUrl">logoutUrl</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.msGraphRequest">msGraphRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.refreshTokens">refreshTokens</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AzureAuth.html">AzureAuth</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="BaseError.html">BaseError</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Client.html">Client</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.AccessTokenItem.html">AccessTokenItem</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.BaseTokenItem.html">BaseTokenItem</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.RefreshTokenItem.html">RefreshTokenItem</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.Scope.html">Scope</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.TokenCache.html">TokenCache</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="WebAuth.html">WebAuth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="WebAuth.html#.authorize">authorize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="WebAuth.html#.clearSession">clearSession</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#extractIdToken">extractIdToken</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getAllUserTokenKeys">getAllUserTokenKeys</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isIntersects">isIntersects</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isSubsetOf">isSubsetOf</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#request">request</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#serializeParams">serializeParams</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#validate">validate</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">token/baseTokenItem.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import { extractIdToken } from './token'
import { Base64 } from '../utils/base64'
import Scope from './scope'
const TOKEN_CACHE_KEY_DELIMITER = '$'
function normalizeId(id) {
if (!id) {
throw new Error('Id is null or undefined: ', id)
}
if (typeof id === 'string' || id instanceof String) {
return id.toLocaleLowerCase()
}
if (typeof id === 'number') {
return id.toString()
}
throw new Error('Invalid id: ', id)
}
/**
* Class represent basic token cache item
*
* Note: userId is handled in case insencitive way for token cache keys
*
* @namespace TokenCache.BaseTokenItem
*
* @param {Object} tokenResponse
* @param {String} clientId
*
* @class BaseTokenItem
* @memberof TokenCache
*/
export default class BaseTokenItem {
constructor(tokenResponse, clientId) {
this.clientId = clientId
this.rawIdToken = tokenResponse.idToken
let decodedIdToken = extractIdToken(tokenResponse.idToken)
this.userId = decodedIdToken.preferred_username || decodedIdToken.unique_name || decodedIdToken.sub
this.userName = decodedIdToken.name
if (!this.userName && decodedIdToken.given_name && decodedIdToken.family_name) {
this.userName = decodedIdToken.given_name + ' ' + decodedIdToken.family_name
} else if (!this.userName) {
this.userName = this.userId
}
if (decodedIdToken.tid) {
this.tenantId = decodedIdToken.tid
} else if (decodedIdToken.iss) {
const iss = decodedIdToken.iss
const b2cSuffixIndex = iss.indexOf('.b2clogin.com')
// parse then tenant ID out of the issuer claim
this.tenantId = iss.substring('https://'.length, b2cSuffixIndex > 0 ? b2cSuffixIndex : iss.length)
}
this.idTokenExpireOn = parseInt(decodedIdToken.exp)*1000
}
static createRefreshTokenKey(clientId, userId) {
return Base64.encodeURI(clientId) +
TOKEN_CACHE_KEY_DELIMITER +
Base64.encodeURI(normalizeId(userId))
}
static createAccessTokenKey(clientId, userId, scope) {
return Base64.encodeURI(clientId) +
TOKEN_CACHE_KEY_DELIMITER +
Base64.encodeURI(normalizeId(userId)) +
TOKEN_CACHE_KEY_DELIMITER +
Base64.encodeURI(scope.toString())
}
static createTokenKeyPrefix(clientId, userId) {
let prefix = Base64.encodeURI(clientId) + TOKEN_CACHE_KEY_DELIMITER
if (userId) {
prefix = prefix + Base64.encodeURI(normalizeId(userId))
}
return prefix
}
static scopeFromKey(key) {
const keyParts = key.split(TOKEN_CACHE_KEY_DELIMITER)
if (keyParts[2]) {
const scopeStr = Base64.decode(keyParts[2])
return new Scope(scopeStr)
}
return null
}
toString() {
return JSON.stringify(this)
}
static rawObjectFromJson(objStr) {
if (typeof objStr !== 'string' && !(objStr instanceof String) || objStr.length < 5) {
return null
}
try {
return JSON.parse(objStr)
} catch (e) {
console.warn('Incorect JSON token string: ', objStr)
return null
}
}
}</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> on Fri May 13 2022 19:57:35 GMT+0200 (GMT+02:00) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>