react-native-azure-auth-encrypted
Version:
Azure AD authentication in React Native using encrypted storage
155 lines (127 loc) • 9.07 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>utils/validate.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#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">utils/validate.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import BaseError from './baseError'
export default class ParameterError extends BaseError {
constructor (expected, actual, missing) {
super('Missing required parameters', `Missing required parameters: ${JSON.stringify(missing, null, 2)}`)
this.expected = expected
this.actual = actual
this.missing = missing
}
}
export class ParameterTypeError extends BaseError {
constructor (expected, actual, mistyped) {
super('Incorrectly typed parameters', `Parameters with wrong type: ${JSON.stringify(mistyped, null, 2)}`)
this.expected = expected
this.actual = actual
this.mistyped = mistyped
}
}
/**
* Applies the validtion and transform rules to the given values
*
* Possible rules:
* rules = {
parameters: {
// define rules for needed keys from `values` input object
realm: {} // just declared without rules, not required by default
state: {required: true}, // required
nonce: {required: false, type: 'string'}, // not required, but if given must have type `strng`
clientId: {toName: 'client_id'}, // key name transform rule
},
validate: true | false // if true (default) - pass through only declared params
aliases: {
connection: 'realm',
clientID: 'clientId'
}
}
* Actions:
* - removes not declared in rules values (can be disabled by 'validate: false' parameter)
* - checks if all required values are exist in values ('required: true')
* - cheks if all given typed parameters have a required type
* - all values are optional by default (without "required" rule)
*
* @param { Object } rules
* @param { Object } values
*/
export function validate(rules, values) {
const { validate = true, parameters, aliases = {} } = rules
let mapped = {}
const requiredKeys = Object
.keys(parameters)
.filter((key) => parameters[key].required)
.map((key) => parameters[key].toName || key)
const typed = Object
.keys(parameters)
.filter((key) => {
return parameters[key].type && typeof parameters[key].type === 'string'
})
.reduce((acc, cur) => {
acc[parameters[cur].toName || cur] = parameters[cur].type
return acc
}, {})
for (let key of Object.keys(values)) {
let value = values[key]
let parameterKey = aliases[key] || key
// this approach needed for defined boolean values with 'false'
// it checks for both 'null' and 'undefined'
let valueIsDefined = value != undefined && value != null
let parameter = parameters[parameterKey]
if (parameter && valueIsDefined) {
mapped[parameter.toName || parameterKey] = value
} else if (valueIsDefined && !validate) {
mapped[key] = value
}
}
const incorrectlyTyped = Object
.keys(typed)
.filter((key) => {
return mapped[key] && typeof mapped[key] !== typed[key].toLowerCase()
})
if (incorrectlyTyped.length > 0) {
throw new ParameterTypeError(typed, values, incorrectlyTyped)
}
const missing = requiredKeys.filter((key) => mapped[key] == null)
if (missing.length > 0) {
throw new ParameterError(requiredKeys, values, missing)
}
return mapped
}
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 09 2025 13:24:03 GMT+0200 (Mitteleuropäische Sommerzeit) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>