mirror of
https://github.com/teamhanko/hanko.git
synced 2025-10-31 08:35:47 +08:00
223 lines
9.9 KiB
HTML
223 lines
9.9 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title> lib/client/UserClient.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/client/UserClient.ts</h1>
|
|
</header>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>import { Me, User, UserInfo } from "../Dto";
|
|
import {
|
|
ConflictError,
|
|
NotFoundError,
|
|
TechnicalError,
|
|
UnauthorizedError,
|
|
} from "../Errors";
|
|
import { Client } from "./Client";
|
|
|
|
/**
|
|
* A class to manage user information.
|
|
*
|
|
* @category SDK
|
|
* @subcategory Clients
|
|
* @extends {Client}
|
|
*/
|
|
class UserClient extends Client {
|
|
/**
|
|
* Fetches basic information about the user identified by the given email address. Can be used while the user is logged out
|
|
* and is helpful in deciding which type of login to choose. For example, if the user's email is not verified, you may
|
|
* want to log in with a passcode, or if no WebAuthn credentials are registered, you may not want to use WebAuthn.
|
|
*
|
|
* @param {string} email - The user's email address.
|
|
* @return {Promise<UserInfo>}
|
|
* @throws {NotFoundError}
|
|
* @throws {RequestTimeoutError}
|
|
* @throws {TechnicalError}
|
|
* @see https://docs.hanko.io/api/public#tag/User-Management/operation/getUserId
|
|
*/
|
|
async getInfo(email: string): Promise<UserInfo> {
|
|
const response = await this.client.post("/user", { email });
|
|
|
|
if (response.status === 404) {
|
|
throw new NotFoundError();
|
|
} else if (!response.ok) {
|
|
throw new TechnicalError();
|
|
}
|
|
|
|
return response.json();
|
|
}
|
|
|
|
/**
|
|
* Creates a new user. Afterwards, verify the email address via passcode. If a 'ConflictError'
|
|
* occurred, you may want to prompt the user to log in.
|
|
*
|
|
* @param {string} email - The email address of the user to be created.
|
|
* @return {Promise<User>}
|
|
* @throws {ConflictError}
|
|
* @throws {RequestTimeoutError}
|
|
* @throws {TechnicalError}
|
|
* @see https://docs.hanko.io/api/public#tag/User-Management/operation/createUser
|
|
*/
|
|
async create(email: string): Promise<User> {
|
|
const response = await this.client.post("/users", { email });
|
|
|
|
if (response.status === 409) {
|
|
throw new ConflictError();
|
|
} else if (!response.ok) {
|
|
throw new TechnicalError();
|
|
}
|
|
|
|
return response.json();
|
|
}
|
|
|
|
/**
|
|
* Fetches the current user.
|
|
*
|
|
* @return {Promise<User>}
|
|
* @throws {UnauthorizedError}
|
|
* @throws {RequestTimeoutError}
|
|
* @throws {TechnicalError}
|
|
* @see https://docs.hanko.io/api/public#tag/User-Management/operation/IsUserAuthorized
|
|
* @see https://docs.hanko.io/api/public#tag/User-Management/operation/listUser
|
|
*/
|
|
async getCurrent(): Promise<User> {
|
|
const meResponse = await this.client.get("/me");
|
|
|
|
if (
|
|
meResponse.status === 400 ||
|
|
meResponse.status === 401 ||
|
|
meResponse.status === 404
|
|
) {
|
|
throw new UnauthorizedError();
|
|
} else if (!meResponse.ok) {
|
|
throw new TechnicalError();
|
|
}
|
|
|
|
const me: Me = meResponse.json();
|
|
const userResponse = await this.client.get(`/users/${me.id}`);
|
|
|
|
if (
|
|
userResponse.status === 400 ||
|
|
userResponse.status === 401 ||
|
|
userResponse.status === 404
|
|
) {
|
|
throw new UnauthorizedError();
|
|
} else if (!userResponse.ok) {
|
|
throw new TechnicalError();
|
|
}
|
|
|
|
return userResponse.json();
|
|
}
|
|
}
|
|
|
|
export { UserClient };
|
|
</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>
|