mirror of
https://github.com/teamhanko/hanko.git
synced 2025-10-31 08:35:47 +08:00
279 lines
11 KiB
HTML
279 lines
11 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title> lib/state/PasscodeState.ts</title>
|
|
|
|
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
|
|
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
|
|
<script src="./build/entry.js"></script>
|
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
|
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
|
|
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
|
|
<link type="text/css" rel="stylesheet" href="">
|
|
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
<body class="layout small-header">
|
|
<div id="stickyNavbarOverlay"></div>
|
|
|
|
|
|
<div class="top-nav">
|
|
<div class="inner">
|
|
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
|
|
<span aria-hidden="true"></span>
|
|
<span aria-hidden="true"></span>
|
|
<span aria-hidden="true"></span>
|
|
</a>
|
|
<div class="logo">
|
|
|
|
|
|
</div>
|
|
<div class="menu">
|
|
|
|
<div class="navigation">
|
|
<a
|
|
href="index.html"
|
|
class="link"
|
|
>
|
|
Documentation
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="main">
|
|
<div
|
|
class="sidebar "
|
|
id="sidebarNav"
|
|
>
|
|
|
|
<nav>
|
|
|
|
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Hanko.html">Hanko</a></li></ul></div><div class="category"><h2>SDK</h2><h3>Classes / Internal</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Headers.html">Headers</a></li><li><a href="HttpClient.html">HttpClient</a></li><li><a href="PasscodeState.html">PasscodeState</a></li><li><a href="PasswordState.html">PasswordState</a></li><li><a href="Response.html">Response</a></li><li><a href="State.html">State</a></li><li><a href="UserState.html">UserState</a></li><li><a href="WebauthnState.html">WebauthnState</a></li></ul><h3>Classes / Clients</h3><ul><li><a href="ConfigClient.html">ConfigClient</a></li><li><a href="EmailClient.html">EmailClient</a></li><li><a href="PasscodeClient.html">PasscodeClient</a></li><li><a href="PasswordClient.html">PasswordClient</a></li><li><a href="UserClient.html">UserClient</a></li><li><a href="WebauthnClient.html">WebauthnClient</a></li></ul><h3>Classes / Errors</h3><ul><li><a href="ConflictError.html">ConflictError</a></li><li><a href="EmailAddressAlreadyExistsError.html">EmailAddressAlreadyExistsError</a></li><li><a href="HankoError.html">HankoError</a></li><li><a href="InvalidPasscodeError.html">InvalidPasscodeError</a></li><li><a href="InvalidPasswordError.html">InvalidPasswordError</a></li><li><a href="InvalidWebauthnCredentialError.html">InvalidWebauthnCredentialError</a></li><li><a href="MaxNumOfEmailAddressesReachedError.html">MaxNumOfEmailAddressesReachedError</a></li><li><a href="MaxNumOfPasscodeAttemptsReachedError.html">MaxNumOfPasscodeAttemptsReachedError</a></li><li><a href="NotFoundError.html">NotFoundError</a></li><li><a href="PasscodeExpiredError.html">PasscodeExpiredError</a></li><li><a href="RequestTimeoutError.html">RequestTimeoutError</a></li><li><a href="TechnicalError.html">TechnicalError</a></li><li><a href="TooManyRequestsError.html">TooManyRequestsError</a></li><li><a href="UnauthorizedError.html">UnauthorizedError</a></li><li><a href="UserVerificationError.html">UserVerificationError</a></li><li><a href="WebauthnRequestCancelledError.html">WebauthnRequestCancelledError</a></li></ul><h3>Classes / Utilities</h3><ul><li><a href="WebauthnSupport.html">WebauthnSupport</a></li></ul><h3>Interfaces / DTO</h3><ul><li><a href="Config.html">Config</a></li><li><a href="Credential.html">Credential</a></li><li><a href="Email.html">Email</a></li><li><a href="EmailConfig.html">EmailConfig</a></li><li><a href="Emails.html">Emails</a></li><li><a href="Passcode.html">Passcode</a></li><li><a href="PasswordConfig.html">PasswordConfig</a></li><li><a href="User.html">User</a></li><li><a href="UserInfo.html">UserInfo</a></li><li><a href="WebauthnCredential.html">WebauthnCredential</a></li><li><a href="WebauthnCredentials.html">WebauthnCredentials</a></li><li><a href="WebauthnFinalized.html">WebauthnFinalized</a></li><li><a href="WebauthnTransports.html">WebauthnTransports</a></li></ul><h3>Interfaces / Internal</h3><ul><li><a href="LocalStorage.html">LocalStorage</a></li><li><a href="LocalStoragePasscode.html">LocalStoragePasscode</a></li><li><a href="LocalStoragePassword.html">LocalStoragePassword</a></li><li><a href="LocalStorageUser.html">LocalStorageUser</a></li><li><a href="LocalStorageUsers.html">LocalStorageUsers</a></li><li><a href="LocalStorageWebauthn.html">LocalStorageWebauthn</a></li></ul></div>
|
|
|
|
</nav>
|
|
</div>
|
|
<div class="core" id="main-content-wrapper">
|
|
<div class="content">
|
|
<header class="page-title">
|
|
<p>Source</p>
|
|
<h1>lib/state/PasscodeState.ts</h1>
|
|
</header>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>import { State } from "./State";
|
|
import { UserState } from "./UserState";
|
|
|
|
/**
|
|
* @interface
|
|
* @category SDK
|
|
* @subcategory Internal
|
|
* @property {string=} id - The UUID of the active passcode.
|
|
* @property {number=} ttl - Timestamp until when the passcode is valid in seconds (since January 1, 1970 00:00:00 UTC).
|
|
* @property {number=} resendAfter - Seconds until a passcode can be resent.
|
|
* @property {emailID=} emailID - The email address ID.
|
|
*/
|
|
export interface LocalStoragePasscode {
|
|
id?: string;
|
|
ttl?: number;
|
|
resendAfter?: number;
|
|
emailID?: string;
|
|
}
|
|
|
|
/**
|
|
* A class that manages passcodes via local storage.
|
|
*
|
|
* @extends UserState
|
|
* @category SDK
|
|
* @subcategory Internal
|
|
*/
|
|
class PasscodeState extends UserState {
|
|
/**
|
|
* Get the passcode state.
|
|
*
|
|
* @private
|
|
* @param {string} userID - The UUID of the user.
|
|
* @return {LocalStoragePasscode}
|
|
*/
|
|
private getState(userID: string): LocalStoragePasscode {
|
|
return (super.getUserState(userID).passcode ||= {});
|
|
}
|
|
|
|
/**
|
|
* Reads the current state.
|
|
*
|
|
* @public
|
|
* @return {PasscodeState}
|
|
*/
|
|
read(): PasscodeState {
|
|
super.read();
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Gets the UUID of the active passcode.
|
|
*
|
|
* @param {string} userID - The UUID of the user.
|
|
* @return {string}
|
|
*/
|
|
getActiveID(userID: string): string {
|
|
return this.getState(userID).id;
|
|
}
|
|
|
|
/**
|
|
* Sets the UUID of the active passcode.
|
|
*
|
|
* @param {string} userID - The UUID of the user.
|
|
* @param {string} passcodeID - The UUID of the passcode to be set as active.
|
|
* @return {PasscodeState}
|
|
*/
|
|
setActiveID(userID: string, passcodeID: string): PasscodeState {
|
|
this.getState(userID).id = passcodeID;
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Gets the UUID of the email address.
|
|
*
|
|
* @param {string} userID - The UUID of the user.
|
|
* @return {string}
|
|
*/
|
|
getEmailID(userID: string): string {
|
|
return this.getState(userID).emailID;
|
|
}
|
|
|
|
/**
|
|
* Sets the UUID of the email address.
|
|
*
|
|
* @param {string} userID - The UUID of the user.
|
|
* @param {string} emailID - The UUID of the email address.
|
|
* @return {PasscodeState}
|
|
*/
|
|
setEmailID(userID: string, emailID: string): PasscodeState {
|
|
this.getState(userID).emailID = emailID;
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Removes the active passcode.
|
|
*
|
|
* @param {string} userID - The UUID of the user.
|
|
* @return {PasscodeState}
|
|
*/
|
|
reset(userID: string): PasscodeState {
|
|
const passcode = this.getState(userID);
|
|
|
|
delete passcode.id;
|
|
delete passcode.ttl;
|
|
delete passcode.resendAfter;
|
|
delete passcode.emailID;
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Gets the TTL in seconds. When the seconds expire, the code is invalid.
|
|
*
|
|
* @param {string} userID - The UUID of the user.
|
|
* @return {number}
|
|
*/
|
|
getTTL(userID: string): number {
|
|
return State.timeToRemainingSeconds(this.getState(userID).ttl);
|
|
}
|
|
|
|
/**
|
|
* Sets the passcode's TTL and stores it to the local storage.
|
|
*
|
|
* @param {string} userID - The UUID of the user.
|
|
* @param {string} seconds - Number of seconds the passcode is valid for.
|
|
* @return {PasscodeState}
|
|
*/
|
|
setTTL(userID: string, seconds: number): PasscodeState {
|
|
this.getState(userID).ttl = State.remainingSecondsToTime(seconds);
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Gets the number of seconds until when the next passcode can be sent.
|
|
*
|
|
* @param {string} userID - The UUID of the user.
|
|
* @return {number}
|
|
*/
|
|
getResendAfter(userID: string): number {
|
|
return State.timeToRemainingSeconds(this.getState(userID).resendAfter);
|
|
}
|
|
|
|
/**
|
|
* Sets the number of seconds until a new passcode can be sent.
|
|
*
|
|
* @param {string} userID - The UUID of the user.
|
|
* @param {string} seconds - Number of seconds the passcode is valid for.
|
|
* @return {PasscodeState}
|
|
*/
|
|
setResendAfter(userID: string, seconds: number): PasscodeState {
|
|
this.getState(userID).resendAfter = State.remainingSecondsToTime(seconds);
|
|
|
|
return this;
|
|
}
|
|
}
|
|
|
|
export { PasscodeState };
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<footer class="footer">
|
|
<div class="content has-text-centered">
|
|
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a></p>
|
|
<p class="sidebar-created-by">
|
|
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
|
|
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
|
|
</p>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div id="side-nav" class="side-nav">
|
|
</div>
|
|
</div>
|
|
<script src="scripts/app.min.js"></script>
|
|
<script>PR.prettyPrint();</script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
|
</body>
|
|
</html>
|