Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
CommunitySolidServer/docs/classes/BaseAccountStore.html
RubenVerborgh 561f4663e3 deploy: 216788e225960bf42a74d22ba237a70deb09f77c
2021-10-15 09:28:28 +00:00

42 lines
41 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>BaseAccountStore | Community Solid Server - v2.0.0</title><meta name="description" content="Documentation for Community Solid Server - v2.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Community Solid Server - v2.0.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Community Solid Server - v2.0.0</a></li><li><a href="BaseAccountStore.html">BaseAccountStore</a></li></ul><h1>Class BaseAccountStore</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>A EmailPasswordStore that uses a KeyValueStorage
to persist its information.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BaseAccountStore</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/AccountStore.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountStore</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="BaseAccountStore.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#saltRounds" class="tsd-kind-icon">salt<wbr/>Rounds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#storage" class="tsd-kind-icon">storage</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#authenticate" class="tsd-kind-icon">authenticate</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#changePassword" class="tsd-kind-icon">change<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#deleteAccount" class="tsd-kind-icon">delete<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#deleteForgotPasswordRecord" class="tsd-kind-icon">delete<wbr/>Forgot<wbr/>Password<wbr/>Record</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#generateForgotPasswordRecord" class="tsd-kind-icon">generate<wbr/>Forgot<wbr/>Password<wbr/>Record</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#getAccountPayload" class="tsd-kind-icon">get<wbr/>Account<wbr/>Payload</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#getAccountResourceIdentifier" class="tsd-kind-icon">get<wbr/>Account<wbr/>Resource<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#getForgotPasswordRecord" class="tsd-kind-icon">get<wbr/>Forgot<wbr/>Password<wbr/>Record</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#getForgotPasswordRecordResourceIdentifier" class="tsd-kind-icon">get<wbr/>Forgot<wbr/>Password<wbr/>Record<wbr/>Resource<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#getSettings" class="tsd-kind-icon">get<wbr/>Settings</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#updateSettings" class="tsd-kind-icon">update<wbr/>Settings</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#verify" class="tsd-kind-icon">verify</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Base<wbr/>Account<wbr/>Store<span class="tsd-signature-symbol">(</span>storage<span class="tsd-signature-symbol">: </span><a href="../interfaces/KeyValueStorage.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyValueStorage</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#EmailPasswordData" class="tsd-signature-type" data-tsd-kind="Type alias">EmailPasswordData</a><span class="tsd-signature-symbol">&gt;</span>, saltRounds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BaseAccountStore.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAccountStore</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L36">src/identity/interaction/email-password/storage/BaseAccountStore.ts:36</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>storage: <a href="../interfaces/KeyValueStorage.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyValueStorage</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#EmailPasswordData" class="tsd-signature-type" data-tsd-kind="Type alias">EmailPasswordData</a><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>saltRounds: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="BaseAccountStore.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAccountStore</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="saltRounds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> salt<wbr/>Rounds</h3><div class="tsd-signature tsd-kind-icon">salt<wbr/>Rounds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L34">src/identity/interaction/email-password/storage/BaseAccountStore.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="storage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> storage</h3><div class="tsd-signature tsd-kind-icon">storage<span class="tsd-signature-symbol">:</span> <a href="../interfaces/KeyValueStorage.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyValueStorage</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#EmailPasswordData" class="tsd-signature-type" data-tsd-kind="Type alias">EmailPasswordData</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L33">src/identity/interaction/email-password/storage/BaseAccountStore.ts:33</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="authenticate" class="tsd-anchor"></a><h3>authenticate</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">authenticate<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#authenticate">authenticate</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L75">src/identity/interaction/email-password/storage/BaseAccountStore.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Authenticate if the username and password are correct and return the WebID
if it is. Throw an error if it is not.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5></li><li><h5>password: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The user&#39;s WebID.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="changePassword" class="tsd-anchor"></a><h3>change<wbr/>Password</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">change<wbr/>Password<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#changePassword">changePassword</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L104">src/identity/interaction/email-password/storage/BaseAccountStore.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Changes the password.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5></li><li><h5>password: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="create" class="tsd-anchor"></a><h3>create</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, webId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, settings<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#create">create</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L82">src/identity/interaction/email-password/storage/BaseAccountStore.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a new account.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5></li><li><h5>webId: <span class="tsd-signature-type">string</span></h5></li><li><h5>password: <span class="tsd-signature-type">string</span></h5></li><li><h5>settings: <a href="../interfaces/AccountSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSettings</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="deleteAccount" class="tsd-anchor"></a><h3>delete<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Account<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#deleteAccount">deleteAccount</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L122">src/identity/interaction/email-password/storage/BaseAccountStore.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Delete the account.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="deleteForgotPasswordRecord" class="tsd-anchor"></a><h3>delete<wbr/>Forgot<wbr/>Password<wbr/>Record</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Forgot<wbr/>Password<wbr/>Record<span class="tsd-signature-symbol">(</span>recordId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#deleteForgotPasswordRecord">deleteForgotPasswordRecord</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L146">src/identity/interaction/email-password/storage/BaseAccountStore.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Deletes the Forgot Password Confirmation Record</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>recordId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="generateForgotPasswordRecord" class="tsd-anchor"></a><h3>generate<wbr/>Forgot<wbr/>Password<wbr/>Record</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">generate<wbr/>Forgot<wbr/>Password<wbr/>Record<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#generateForgotPasswordRecord">generateForgotPasswordRecord</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L130">src/identity/interaction/email-password/storage/BaseAccountStore.ts:130</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a Forgot Password Confirmation Record. This will be to remember that
a user has made a request to reset a password. Throws an error if the email doesn&#39;t
exist</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The record id. This should be included in the reset password link.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="getAccountPayload" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Account<wbr/>Payload</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Payload<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, checkExistence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountPayload.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountPayload</a><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Payload<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, checkExistence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">?: </span><a href="../interfaces/AccountPayload.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountPayload</a><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L62">src/identity/interaction/email-password/storage/BaseAccountStore.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Helper function that converts the given e-mail to an account identifier
and retrieves the account data from the internal storage.</p>
</div><div><p>Will error if <code>checkExistence</code> is true and the account does not exist.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5></li><li><h5>checkExistence: <span class="tsd-signature-type">true</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountPayload.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountPayload</a><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L64">src/identity/interaction/email-password/storage/BaseAccountStore.ts:64</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5></li><li><h5>checkExistence: <span class="tsd-signature-type">false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">?: </span><a href="../interfaces/AccountPayload.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountPayload</a><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="getAccountResourceIdentifier" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Account<wbr/>Resource<wbr/>Identifier</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Resource<wbr/>Identifier<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L44">src/identity/interaction/email-password/storage/BaseAccountStore.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Generates a ResourceIdentifier to store data for the given email.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getForgotPasswordRecord" class="tsd-anchor"></a><h3>get<wbr/>Forgot<wbr/>Password<wbr/>Record</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Forgot<wbr/>Password<wbr/>Record<span class="tsd-signature-symbol">(</span>recordId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#getForgotPasswordRecord">getForgotPasswordRecord</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L140">src/identity/interaction/email-password/storage/BaseAccountStore.ts:140</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Gets the email associated with the forgot password confirmation record or undefined
if it&#39;s not present</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>recordId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The user&#39;s email.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="getForgotPasswordRecordResourceIdentifier" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Forgot<wbr/>Password<wbr/>Record<wbr/>Resource<wbr/>Identifier</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Forgot<wbr/>Password<wbr/>Record<wbr/>Resource<wbr/>Identifier<span class="tsd-signature-symbol">(</span>recordId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L51">src/identity/interaction/email-password/storage/BaseAccountStore.ts:51</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Generates a ResourceIdentifier to store data for the given recordId.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>recordId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getSettings" class="tsd-anchor"></a><h3>get<wbr/>Settings</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Settings<span class="tsd-signature-symbol">(</span>webId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSettings</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#getSettings">getSettings</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L110">src/identity/interaction/email-password/storage/BaseAccountStore.ts:110</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Gets the settings associated with this account.
Errors if there is no matching account.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>webId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSettings</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="updateSettings" class="tsd-anchor"></a><h3>update<wbr/>Settings</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<wbr/>Settings<span class="tsd-signature-symbol">(</span>webId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, settings<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#updateSettings">updateSettings</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L116">src/identity/interaction/email-password/storage/BaseAccountStore.ts:116</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Updates the settings associated with this account.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>webId: <span class="tsd-signature-type">string</span></h5></li><li><h5>settings: <a href="../interfaces/AccountSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSettings</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="verify" class="tsd-anchor"></a><h3>verify</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">verify<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AccountStore.html">AccountStore</a>.<a href="../interfaces/AccountStore.html#verify">verify</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/interaction/email-password/storage/BaseAccountStore.ts#L98">src/identity/interaction/email-password/storage/BaseAccountStore.ts:98</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Verifies the account creation. This can be used with, for example, e-mail verification.
The account can only be used after it is verified.
In case verification is not required, this should be called immediately after the <code>create</code> call.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="BaseAccountStore.html" class="tsd-kind-icon">Base<wbr/>Account<wbr/>Store</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="BaseAccountStore.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#saltRounds" class="tsd-kind-icon">salt<wbr/>Rounds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#storage" class="tsd-kind-icon">storage</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#authenticate" class="tsd-kind-icon">authenticate</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#changePassword" class="tsd-kind-icon">change<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#deleteAccount" class="tsd-kind-icon">delete<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#deleteForgotPasswordRecord" class="tsd-kind-icon">delete<wbr/>Forgot<wbr/>Password<wbr/>Record</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#generateForgotPasswordRecord" class="tsd-kind-icon">generate<wbr/>Forgot<wbr/>Password<wbr/>Record</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#getAccountPayload" class="tsd-kind-icon">get<wbr/>Account<wbr/>Payload</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#getAccountResourceIdentifier" class="tsd-kind-icon">get<wbr/>Account<wbr/>Resource<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#getForgotPasswordRecord" class="tsd-kind-icon">get<wbr/>Forgot<wbr/>Password<wbr/>Record</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BaseAccountStore.html#getForgotPasswordRecordResourceIdentifier" class="tsd-kind-icon">get<wbr/>Forgot<wbr/>Password<wbr/>Record<wbr/>Resource<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#getSettings" class="tsd-kind-icon">get<wbr/>Settings</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#updateSettings" class="tsd-kind-icon">update<wbr/>Settings</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BaseAccountStore.html#verify" class="tsd-kind-icon">verify</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink