@sudoplatform/sudo-user 9.0.2 → 10.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/docs/.nojekyll +1 -0
  2. package/docs/assets/highlight.css +22 -0
  3. package/docs/assets/icons.css +1043 -0
  4. package/docs/assets/{images/icons.png → icons.png} +0 -0
  5. package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  6. package/docs/assets/main.js +52 -0
  7. package/docs/assets/search.js +1 -0
  8. package/docs/assets/style.css +1388 -0
  9. package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  10. package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  11. package/docs/classes/AlreadyRegisteredError.html +8 -0
  12. package/docs/classes/DefaultSudoUserClient.html +68 -0
  13. package/docs/classes/IdentityServiceConfigNotFoundError.html +10 -0
  14. package/docs/classes/LocalAuthenticationProvider.html +12 -0
  15. package/docs/classes/TESTAuthenticationProvider.html +11 -0
  16. package/docs/index.html +44 -159
  17. package/docs/interfaces/AuthenticationProvider.html +6 -0
  18. package/docs/interfaces/AuthenticationTokens.html +7 -0
  19. package/docs/interfaces/SudoUserClient.html +90 -0
  20. package/docs/modules.html +1 -143
  21. package/lib/client/apiClient.js +9 -6
  22. package/lib/core/auth-store.js +5 -1
  23. package/lib/core/key-manager.js +2 -1
  24. package/lib/core/sdk-config.d.ts +17 -3
  25. package/lib/core/sdk-config.js +23 -8
  26. package/lib/gen/graphql-types.d.ts +9 -9
  27. package/lib/index.d.ts +1 -1
  28. package/lib/index.js +20 -15
  29. package/lib/sdk.d.ts +1 -0
  30. package/lib/sdk.js +18 -0
  31. package/lib/user/auth-provider.js +1 -1
  32. package/lib/user/auth.d.ts +1 -0
  33. package/lib/user/auth.js +6 -3
  34. package/lib/user/error.d.ts +13 -1
  35. package/lib/user/error.js +31 -4
  36. package/lib/user/identity-provider.js +6 -4
  37. package/lib/user/user-client.js +19 -16
  38. package/package.json +49 -46
  39. package/docs/assets/css/main.css +0 -2660
  40. package/docs/assets/js/main.js +0 -248
  41. package/docs/assets/js/search.js +0 -1
  42. package/docs/classes/alreadyregisterederror.html +0 -346
  43. package/docs/classes/defaultsudouserclient.html +0 -1045
  44. package/docs/classes/localauthenticationprovider.html +0 -287
  45. package/docs/classes/testauthenticationprovider.html +0 -317
  46. package/docs/interfaces/authenticationprovider.html +0 -216
  47. package/docs/interfaces/authenticationtokens.html +0 -233
  48. package/docs/interfaces/sudouserclient.html +0 -855
  49. package/lib/core/protected-store.d.ts +0 -5
  50. package/lib/runtimes/browser/browser-crypto.d.ts +0 -2
package/docs/assets/{images/widgets.png → widgets.png} RENAMED
File without changes
package/docs/classes/AlreadyRegisteredError.html ADDED
@@ -0,0 +1,8 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AlreadyRegisteredError | @sudoplatform/sudo-user</title><meta name="description" content="Documentation for @sudoplatform/sudo-user"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">@sudoplatform/sudo-user</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">@sudoplatform/sudo-user</a></li><li><a href="AlreadyRegisteredError.html">AlreadyRegisteredError</a></li></ul><h1>Class AlreadyRegisteredError</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">
2
+ <p>Indicates the user associated with the client is already registered.</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">UserError</span><ul class="tsd-hierarchy"><li><span class="target">AlreadyRegisteredError</span></li></ul></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 tsd-is-overwrite"><a href="AlreadyRegisteredError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="AlreadyRegisteredError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="AlreadyRegisteredError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="AlreadyRegisteredError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="AlreadyRegisteredError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="AlreadyRegisteredError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-external"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="AlreadyRegisteredError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</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 tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Already<wbr/>Registered<wbr/>Error<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AlreadyRegisteredError.html" class="tsd-signature-type" data-tsd-kind="Class">AlreadyRegisteredError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides UserError.constructor</p><ul><li>Defined in src/user/error.ts:15</li></ul></aside><h4 class="tsd-returns-title">Returns <a href="AlreadyRegisteredError.html" class="tsd-signature-type" data-tsd-kind="Class">AlreadyRegisteredError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3>message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from UserError.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from UserError.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from UserError.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from UserError.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>Optional override for formatting stack traces</p>
5
+ </div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
6
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from UserError.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from UserError.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
+ <p>Create .stack property on a target object</p>
8
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="AlreadyRegisteredError.html" class="tsd-kind-icon">Already<wbr/>Registered<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="AlreadyRegisteredError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="AlreadyRegisteredError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="AlreadyRegisteredError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="AlreadyRegisteredError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="AlreadyRegisteredError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="AlreadyRegisteredError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="AlreadyRegisteredError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><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></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></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="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/classes/DefaultSudoUserClient.html ADDED
@@ -0,0 +1,68 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DefaultSudoUserClient | @sudoplatform/sudo-user</title><meta name="description" content="Documentation for @sudoplatform/sudo-user"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">@sudoplatform/sudo-user</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">@sudoplatform/sudo-user</a></li><li><a href="DefaultSudoUserClient.html">DefaultSudoUserClient</a></li></ul><h1>Class DefaultSudoUserClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">DefaultSudoUserClient</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/SudoUserClient.html" class="tsd-signature-type" data-tsd-kind="Interface">SudoUserClient</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="DefaultSudoUserClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#sudoKeyManager" class="tsd-kind-icon">sudo<wbr/>Key<wbr/>Manager</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="DefaultSudoUserClient.html#clearAuthenticationTokens" class="tsd-kind-icon">clear<wbr/>Authentication<wbr/>Tokens</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#deregister" class="tsd-kind-icon">deregister</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getAccessToken" class="tsd-kind-icon">get<wbr/>Access<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getIdToken" class="tsd-kind-icon">get<wbr/>Id<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getLatestAuthToken" class="tsd-kind-icon">get<wbr/>Latest<wbr/>Auth<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getRefreshToken" class="tsd-kind-icon">get<wbr/>Refresh<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getRefreshTokenExpiry" class="tsd-kind-icon">get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getSubject" class="tsd-kind-icon">get<wbr/>Subject</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getTokenExpiry" class="tsd-kind-icon">get<wbr/>Token<wbr/>Expiry</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getUserClaim" class="tsd-kind-icon">get<wbr/>User<wbr/>Claim</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getUserName" class="tsd-kind-icon">get<wbr/>User<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#globalSignOut" class="tsd-kind-icon">global<wbr/>Sign<wbr/>Out</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#isRegistered" class="tsd-kind-icon">is<wbr/>Registered</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#isSignedIn" class="tsd-kind-icon">is<wbr/>Signed<wbr/>In</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#presentFederatedSignInUI" class="tsd-kind-icon">present<wbr/>Federated<wbr/>Sign<wbr/>InUI</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#presentSignOutUI" class="tsd-kind-icon">present<wbr/>Sign<wbr/>OutUI</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#processFederatedSignInTokens" class="tsd-kind-icon">process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#refreshTokens" class="tsd-kind-icon">refresh<wbr/>Tokens</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#registerWithAuthenticationProvider" class="tsd-kind-icon">register<wbr/>With<wbr/>Authentication<wbr/>Provider</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#reset" class="tsd-kind-icon">reset</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setAuthUI" class="tsd-kind-icon">set<wbr/>AuthUI</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setAuthenticationStore" class="tsd-kind-icon">set<wbr/>Authentication<wbr/>Store</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setIdentityProvider" class="tsd-kind-icon">set<wbr/>Identity<wbr/>Provider</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setLaunchUriFn" class="tsd-kind-icon">set<wbr/>Launch<wbr/>Uri<wbr/>Fn</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setUserName" class="tsd-kind-icon">set<wbr/>User<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#signInWithAuthenticationProvider" class="tsd-kind-icon">sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#signInWithKey" class="tsd-kind-icon">sign<wbr/>In<wbr/>With<wbr/>Key</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 id="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/>Default<wbr/>Sudo<wbr/>User<wbr/>Client<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SudoUserOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DefaultSudoUserClient.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultSudoUserClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:54</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">SudoUserOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="DefaultSudoUserClient.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultSudoUserClient</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="sudoKeyManager" class="tsd-anchor"></a><h3>sudo<wbr/>Key<wbr/>Manager</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> sudoKeyManager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SudoKeyManager</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#sudoKeyManager">sudoKeyManager</a></p><ul><li>Defined in src/user/user-client.ts:106</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Getter to retrieve the SudoKeyManager</p>
3
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SudoKeyManager</span></h4></li></ul></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 id="clearAuthenticationTokens" class="tsd-anchor"></a><h3>clear<wbr/>Authentication<wbr/>Tokens</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">clear<wbr/>Authentication<wbr/>Tokens<span class="tsd-signature-symbol">(</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#clearAuthenticationTokens">clearAuthenticationTokens</a></p><ul><li>Defined in src/user/user-client.ts:398</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>Clears cached authentication tokens.</p>
5
+ </div></div><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 id="deregister" class="tsd-anchor"></a><h3>deregister</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">deregister<span class="tsd-signature-symbol">(</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"><ul><li>Defined in src/user/user-client.ts:392</li></ul></aside><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 id="getAccessToken" class="tsd-anchor"></a><h3>get<wbr/>Access<wbr/>Token</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Access<wbr/>Token<span class="tsd-signature-symbol">(</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getAccessToken">getAccessToken</a></p><ul><li>Defined in src/user/user-client.ts:144</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>Returns the access token cached from the last sign-in.</p>
7
+ </div></div><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getIdToken" class="tsd-anchor"></a><h3>get<wbr/>Id<wbr/>Token</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Id<wbr/>Token<span class="tsd-signature-symbol">(</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getIdToken">getIdToken</a></p><ul><li>Defined in src/user/user-client.ts:140</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>Returns the ID token cached from the last sign-in.</p>
9
+ </div></div><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLatestAuthToken" class="tsd-anchor"></a><h3>get<wbr/>Latest<wbr/>Auth<wbr/>Token</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Latest<wbr/>Auth<wbr/>Token<span class="tsd-signature-symbol">(</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getLatestAuthToken">getLatestAuthToken</a></p><ul><li>Defined in src/user/user-client.ts:235</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>Retrieves the latest ID token. This is to be used by the AWS AppSync client.</p>
11
+ </div></div><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getRefreshToken" class="tsd-anchor"></a><h3>get<wbr/>Refresh<wbr/>Token</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Refresh<wbr/>Token<span class="tsd-signature-symbol">(</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getRefreshToken">getRefreshToken</a></p><ul><li>Defined in src/user/user-client.ts:148</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
12
+ <p>Returns the refresh token cached from the last sign-in.</p>
13
+ </div></div><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getRefreshTokenExpiry" class="tsd-anchor"></a><h3>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Refresh<wbr/>Token<wbr/>Expiry<span class="tsd-signature-symbol">(</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">Date</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getRefreshTokenExpiry">getRefreshTokenExpiry</a></p><ul><li>Defined in src/user/user-client.ts:157</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>Returns the refresh token expiry cached from the last sign-in.</p>
15
+ </div></div><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">Date</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 id="getSubject" class="tsd-anchor"></a><h3>get<wbr/>Subject</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Subject<span class="tsd-signature-symbol">(</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getSubject">getSubject</a></p><ul><li>Defined in src/user/user-client.ts:187</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
16
+ <p>Returns the subject of the user associated with this client.
17
+ Note: This is an internal method used by other Sudo platform SDKs.</p>
18
+ </div></div><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTokenExpiry" class="tsd-anchor"></a><h3>get<wbr/>Token<wbr/>Expiry</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Token<wbr/>Expiry<span class="tsd-signature-symbol">(</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">Date</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getTokenExpiry">getTokenExpiry</a></p><ul><li>Defined in src/user/user-client.ts:152</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>Returns the ID and access token expiry cached from the last sign-in.</p>
20
+ </div></div><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">Date</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 id="getUserClaim" class="tsd-anchor"></a><h3>get<wbr/>User<wbr/>Claim</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>User<wbr/>Claim<span class="tsd-signature-symbol">(</span>name<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">any</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getUserClaim">getUserClaim</a></p><ul><li>Defined in src/user/user-client.ts:181</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
21
+ <p>Returns the specified claim associated with the user&#39;s identity.</p>
22
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <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">any</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 id="getUserName" class="tsd-anchor"></a><h3>get<wbr/>User<wbr/>Name</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>User<wbr/>Name<span class="tsd-signature-symbol">(</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getUserName">getUserName</a></p><ul><li>Defined in src/user/user-client.ts:168</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
23
+ <p>Returns the user name associated with this client. The username maybe needed to contact
24
+ the support team when diagnosing an issue related to a specific user.</p>
25
+ </div></div><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="globalSignOut" class="tsd-anchor"></a><h3>global<wbr/>Sign<wbr/>Out</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">global<wbr/>Sign<wbr/>Out<span class="tsd-signature-symbol">(</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#globalSignOut">globalSignOut</a></p><ul><li>Defined in src/user/user-client.ts:269</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
26
+ <p>Signs out the user from all devices.</p>
27
+ </div></div><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 id="isRegistered" class="tsd-anchor"></a><h3>is<wbr/>Registered</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Registered<span class="tsd-signature-symbol">(</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">boolean</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isRegistered">isRegistered</a></p><ul><li>Defined in src/user/user-client.ts:364</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
28
+ <p>Indicates whether or not this client is registered with Sudo Platform backend.</p>
29
+ </div></div><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">boolean</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 id="isSignedIn" class="tsd-anchor"></a><h3>is<wbr/>Signed<wbr/>In</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Signed<wbr/>In<span class="tsd-signature-symbol">(</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">boolean</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isSignedIn">isSignedIn</a></p><ul><li>Defined in src/user/user-client.ts:191</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
30
+ <p>Indicates whether or not this client is signed in with Sudo Platform backend. The client is
31
+ considered signed in if it cached valid ID, access and refresh tokens.</p>
32
+ </div></div><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">boolean</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 id="presentFederatedSignInUI" class="tsd-anchor"></a><h3>present<wbr/>Federated<wbr/>Sign<wbr/>InUI</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">present<wbr/>Federated<wbr/>Sign<wbr/>InUI<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentFederatedSignInUI">presentFederatedSignInUI</a></p><ul><li>Defined in src/user/user-client.ts:110</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
33
+ <p>Presents the sign in UI for federated sign in using an external identity provider.</p>
34
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="presentSignOutUI" class="tsd-anchor"></a><h3>present<wbr/>Sign<wbr/>OutUI</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">present<wbr/>Sign<wbr/>OutUI<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentSignOutUI">presentSignOutUI</a></p><ul><li>Defined in src/user/user-client.ts:411</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
35
+ <p>Presents the Cognito hosted UI signout endpoint.
36
+ When the endpoint is invoked, the hosted web app&#39;s cookies
37
+ will be invalidated, but the user is not logged out of Cognito.</p>
38
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="processFederatedSignInTokens" class="tsd-anchor"></a><h3>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens<span class="tsd-signature-symbol">(</span>url<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/AuthenticationTokens.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationTokens</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#processFederatedSignInTokens">processFederatedSignInTokens</a></p><ul><li>Defined in src/user/user-client.ts:120</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
39
+ <p>Processes tokens from federated sign in returned to the specified URL.
40
+ The tokens are passed to the web app via a redirect URL.</p>
41
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <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/AuthenticationTokens.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationTokens</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 id="refreshTokens" class="tsd-anchor"></a><h3>refresh<wbr/>Tokens</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">refresh<wbr/>Tokens<span class="tsd-signature-symbol">(</span>refreshToken<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/AuthenticationTokens.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationTokens</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#refreshTokens">refreshTokens</a></p><ul><li>Defined in src/user/user-client.ts:215</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
42
+ <p>Refresh the access and ID tokens using the refresh token.</p>
43
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>refreshToken: <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/AuthenticationTokens.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationTokens</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 id="registerWithAuthenticationProvider" class="tsd-anchor"></a><h3>register<wbr/>With<wbr/>Authentication<wbr/>Provider</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">register<wbr/>With<wbr/>Authentication<wbr/>Provider<span class="tsd-signature-symbol">(</span>authenticationProvider<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a>, registrationId<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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#registerWithAuthenticationProvider">registerWithAuthenticationProvider</a></p><ul><li>Defined in src/user/user-client.ts:277</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
44
+ <p>Registers this client against the backend with an external authentication provider. The caller must
45
+ implement AuthenticationProvider protocol to return the appropriate authentication token required
46
+ to authorize the registration request.</p>
47
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>authenticationProvider: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> registrationId: <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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="reset" class="tsd-anchor"></a><h3>reset</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#reset">reset</a></p><ul><li>Defined in src/user/user-client.ts:415</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
48
+ <p>Resets internal state and clears any cached data.</p>
49
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setAuthUI" class="tsd-anchor"></a><h3>set<wbr/>AuthUI</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>AuthUI<span class="tsd-signature-symbol">(</span>authUI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AuthUI</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:509</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
50
+ <p>Provide a custom auth UI. This is mainly used for unit testing (optional).</p>
51
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>authUI: <span class="tsd-signature-type">AuthUI</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setAuthenticationStore" class="tsd-anchor"></a><h3>set<wbr/>Authentication<wbr/>Store</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Authentication<wbr/>Store<span class="tsd-signature-symbol">(</span>authenticationStore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AuthenticationStore</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:532</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
52
+ <p>Provide a custom authentication store.
53
+ This is mainly used for unit testing (optional).</p>
54
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>authenticationStore: <span class="tsd-signature-type">AuthenticationStore</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setIdentityProvider" class="tsd-anchor"></a><h3>set<wbr/>Identity<wbr/>Provider</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Identity<wbr/>Provider<span class="tsd-signature-symbol">(</span>identityProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IdentityProvider</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:516</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
55
+ <p>Provide a custom identity provider. This is mainly used for unit testing (optional).</p>
56
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>identityProvider: <span class="tsd-signature-type">IdentityProvider</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setLaunchUriFn" class="tsd-anchor"></a><h3>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Launch<wbr/>Uri<wbr/>Fn<span class="tsd-signature-symbol">(</span>launchUriFn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>url<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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:524</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
57
+ <p>Provide a custom function to open the sign in url.
58
+ This is mainly used for unit testing (optional).</p>
59
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>launchUriFn: <span class="tsd-signature-symbol">(</span>url<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><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>url<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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setUserName" class="tsd-anchor"></a><h3>set<wbr/>User<wbr/>Name</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>User<wbr/>Name<span class="tsd-signature-symbol">(</span>name<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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#setUserName">setUserName</a></p><ul><li>Defined in src/user/user-client.ts:176</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
60
+ <p>Sets the user name associated with this client.</p>
61
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <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 id="signInWithAuthenticationProvider" class="tsd-anchor"></a><h3>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider<span class="tsd-signature-symbol">(</span>authenticationProvider<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</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><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationTokens</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signInWithAuthenticationProvider">signInWithAuthenticationProvider</a></p><ul><li>Defined in src/user/user-client.ts:338</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
62
+ <p>Sign into the backend using an external authentication provider. Caller must implement
63
+ <em>AuthenticationProvider</em> interface to return the appropriate authentication token associated with
64
+ the external identity registered with <em>registerWithAuthenticationProvider</em>.</p>
65
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>authenticationProvider: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a></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/AuthenticationTokens.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationTokens</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 id="signInWithKey" class="tsd-anchor"></a><h3>sign<wbr/>In<wbr/>With<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sign<wbr/>In<wbr/>With<wbr/>Key<span class="tsd-signature-symbol">(</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/AuthenticationTokens.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationTokens</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/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signInWithKey">signInWithKey</a></p><ul><li>Defined in src/user/user-client.ts:373</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
66
+ <p>Sign into the backend using a private key. The client must have created a private/public key pair via
67
+ the <em>registerWithAuthenticationProvider</em> method.</p>
68
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationTokens</a><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="DefaultSudoUserClient.html" class="tsd-kind-icon">Default<wbr/>Sudo<wbr/>User<wbr/>Client</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#sudoKeyManager" class="tsd-kind-icon">sudo<wbr/>Key<wbr/>Manager</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#clearAuthenticationTokens" class="tsd-kind-icon">clear<wbr/>Authentication<wbr/>Tokens</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#deregister" class="tsd-kind-icon">deregister</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getAccessToken" class="tsd-kind-icon">get<wbr/>Access<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getIdToken" class="tsd-kind-icon">get<wbr/>Id<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getLatestAuthToken" class="tsd-kind-icon">get<wbr/>Latest<wbr/>Auth<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getRefreshToken" class="tsd-kind-icon">get<wbr/>Refresh<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getRefreshTokenExpiry" class="tsd-kind-icon">get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getSubject" class="tsd-kind-icon">get<wbr/>Subject</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getTokenExpiry" class="tsd-kind-icon">get<wbr/>Token<wbr/>Expiry</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getUserClaim" class="tsd-kind-icon">get<wbr/>User<wbr/>Claim</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getUserName" class="tsd-kind-icon">get<wbr/>User<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#globalSignOut" class="tsd-kind-icon">global<wbr/>Sign<wbr/>Out</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#isRegistered" class="tsd-kind-icon">is<wbr/>Registered</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#isSignedIn" class="tsd-kind-icon">is<wbr/>Signed<wbr/>In</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#presentFederatedSignInUI" class="tsd-kind-icon">present<wbr/>Federated<wbr/>Sign<wbr/>InUI</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#presentSignOutUI" class="tsd-kind-icon">present<wbr/>Sign<wbr/>OutUI</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#processFederatedSignInTokens" class="tsd-kind-icon">process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#refreshTokens" class="tsd-kind-icon">refresh<wbr/>Tokens</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#registerWithAuthenticationProvider" class="tsd-kind-icon">register<wbr/>With<wbr/>Authentication<wbr/>Provider</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#reset" class="tsd-kind-icon">reset</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setAuthUI" class="tsd-kind-icon">set<wbr/>AuthUI</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setAuthenticationStore" class="tsd-kind-icon">set<wbr/>Authentication<wbr/>Store</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setIdentityProvider" class="tsd-kind-icon">set<wbr/>Identity<wbr/>Provider</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setLaunchUriFn" class="tsd-kind-icon">set<wbr/>Launch<wbr/>Uri<wbr/>Fn</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setUserName" class="tsd-kind-icon">set<wbr/>User<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#signInWithAuthenticationProvider" class="tsd-kind-icon">sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#signInWithKey" class="tsd-kind-icon">sign<wbr/>In<wbr/>With<wbr/>Key</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><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></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></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="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/classes/IdentityServiceConfigNotFoundError.html ADDED
@@ -0,0 +1,10 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IdentityServiceConfigNotFoundError | @sudoplatform/sudo-user</title><meta name="description" content="Documentation for @sudoplatform/sudo-user"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">@sudoplatform/sudo-user</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">@sudoplatform/sudo-user</a></li><li><a href="IdentityServiceConfigNotFoundError.html">IdentityServiceConfigNotFoundError</a></li></ul><h1>Class IdentityServiceConfigNotFoundError</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">
2
+ <p>Indicates the configuration related to Identity Service is not found. This may indicate that Identity Service
3
+ is not deployed into your runtime instance or the config file that
4
+ you are using is invalid.</p>
5
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">UserError</span><ul class="tsd-hierarchy"><li><span class="target">IdentityServiceConfigNotFoundError</span></li></ul></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 tsd-is-overwrite"><a href="IdentityServiceConfigNotFoundError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-external"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</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 tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Identity<wbr/>Service<wbr/>Config<wbr/>Not<wbr/>Found<wbr/>Error<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IdentityServiceConfigNotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">IdentityServiceConfigNotFoundError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides UserError.constructor</p><ul><li>Defined in src/user/error.ts:26</li></ul></aside><h4 class="tsd-returns-title">Returns <a href="IdentityServiceConfigNotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">IdentityServiceConfigNotFoundError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3>message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from UserError.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from UserError.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from UserError.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from UserError.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>Optional override for formatting stack traces</p>
7
+ </div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
8
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from UserError.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from UserError.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>Create .stack property on a target object</p>
10
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="IdentityServiceConfigNotFoundError.html" class="tsd-kind-icon">Identity<wbr/>Service<wbr/>Config<wbr/>Not<wbr/>Found<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="IdentityServiceConfigNotFoundError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="IdentityServiceConfigNotFoundError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><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></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></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="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/classes/LocalAuthenticationProvider.html ADDED
@@ -0,0 +1,12 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LocalAuthenticationProvider | @sudoplatform/sudo-user</title><meta name="description" content="Documentation for @sudoplatform/sudo-user"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">@sudoplatform/sudo-user</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">@sudoplatform/sudo-user</a></li><li><a href="LocalAuthenticationProvider.html">LocalAuthenticationProvider</a></li></ul><h1>Class LocalAuthenticationProvider</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">
2
+ <p>Authentication info consisting of a JWT signed using the locally stored private key.</p>
3
+ </div><dl class="tsd-comment-tags"><dt>param name</dt><dd><p>provider name. This name will be used to populate JWT iss (issuer).</p>
4
+ </dd><dt>param privateKey</dt><dd><p>PEM encoded RSA private key.</p>
5
+ </dd><dt>param keyId</dt><dd><p>key ID.</p>
6
+ </dd><dt>param username</dt><dd><p>username to be associated with the issued authentication info.</p>
7
+ </dd><dt>param attributes</dt><dd><p>additional attributes to be added to the issued authentication info.</p>
8
+ </dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">LocalAuthenticationProvider</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</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="LocalAuthenticationProvider.html#constructor" class="tsd-kind-icon">constructor</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="LocalAuthenticationProvider.html#getAuthenticationInfo" class="tsd-kind-icon">get<wbr/>Authentication<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LocalAuthenticationProvider.html#reset" class="tsd-kind-icon">reset</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 id="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/>Local<wbr/>Authentication<wbr/>Provider<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keyId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LocalAuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Class">LocalAuthenticationProvider</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/user/auth-provider.ts:138</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>privateKey: <span class="tsd-signature-type">string</span></h5></li><li><h5>keyId: <span class="tsd-signature-type">string</span></h5></li><li><h5>username: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> attributes: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="LocalAuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Class">LocalAuthenticationProvider</a></h4></li></ul></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 id="getAuthenticationInfo" class="tsd-anchor"></a><h3>get<wbr/>Authentication<wbr/>Info</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Authentication<wbr/>Info<span class="tsd-signature-symbol">(</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">AuthenticationInfo</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/AuthenticationProvider.html">AuthenticationProvider</a>.<a href="../interfaces/AuthenticationProvider.html#getAuthenticationInfo">getAuthenticationInfo</a></p><ul><li>Defined in src/user/auth-provider.ts:146</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>Generates and returns authentication information.</p>
10
+ </div></div><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">AuthenticationInfo</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 id="reset" class="tsd-anchor"></a><h3>reset</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AuthenticationProvider.html">AuthenticationProvider</a>.<a href="../interfaces/AuthenticationProvider.html#reset">reset</a></p><ul><li>Defined in src/user/auth-provider.ts:164</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>Resets internal state and releases any associated resources.</p>
12
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="LocalAuthenticationProvider.html" class="tsd-kind-icon">Local<wbr/>Authentication<wbr/>Provider</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="LocalAuthenticationProvider.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LocalAuthenticationProvider.html#getAuthenticationInfo" class="tsd-kind-icon">get<wbr/>Authentication<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LocalAuthenticationProvider.html#reset" class="tsd-kind-icon">reset</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><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></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></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="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/classes/TESTAuthenticationProvider.html ADDED
@@ -0,0 +1,11 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TESTAuthenticationProvider | @sudoplatform/sudo-user</title><meta name="description" content="Documentation for @sudoplatform/sudo-user"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">@sudoplatform/sudo-user</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">@sudoplatform/sudo-user</a></li><li><a href="TESTAuthenticationProvider.html">TESTAuthenticationProvider</a></li></ul><h1>Class TESTAuthenticationProvider</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">
2
+ <p>Authentication provider for generating authentication info using a TEST registration key.</p>
3
+ </div><dl class="tsd-comment-tags"><dt>param name</dt><dd><p>provider name. This name will be prepended to the generated UUID in JWT sub.</p>
4
+ </dd><dt>param privateKey</dt><dd><p>PEM encoded RSA private key.</p>
5
+ </dd><dt>param keyId</dt><dd><p>key ID of the TEST registration key which is obtained from the admin console.</p>
6
+ </dd><dt>param attributes</dt><dd><p>additional attributes to be added to the issued authentication info.</p>
7
+ </dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">TESTAuthenticationProvider</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</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="TESTAuthenticationProvider.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="TESTAuthenticationProvider.html#testRegistrationAudience" class="tsd-kind-icon">test<wbr/>Registration<wbr/>Audience</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TESTAuthenticationProvider.html#testRegistrationIssuer" class="tsd-kind-icon">test<wbr/>Registration<wbr/>Issuer</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="TESTAuthenticationProvider.html#getAuthenticationInfo" class="tsd-kind-icon">get<wbr/>Authentication<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TESTAuthenticationProvider.html#reset" class="tsd-kind-icon">reset</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 id="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 TESTAuthentication<wbr/>Provider<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keyId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TESTAuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Class">TESTAuthenticationProvider</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/user/auth-provider.ts:77</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>privateKey: <span class="tsd-signature-type">string</span></h5></li><li><h5>keyId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;register_key&#39;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> attributes: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="TESTAuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Class">TESTAuthenticationProvider</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="testRegistrationAudience" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> test<wbr/>Registration<wbr/>Audience</h3><div class="tsd-signature tsd-kind-icon">test<wbr/>Registration<wbr/>Audience<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;testRegisterAudience&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in src/user/auth-provider.ts:76</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="testRegistrationIssuer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> test<wbr/>Registration<wbr/>Issuer</h3><div class="tsd-signature tsd-kind-icon">test<wbr/>Registration<wbr/>Issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;testRegisterIssuer&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in src/user/auth-provider.ts:75</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 id="getAuthenticationInfo" class="tsd-anchor"></a><h3>get<wbr/>Authentication<wbr/>Info</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Authentication<wbr/>Info<span class="tsd-signature-symbol">(</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">AuthenticationInfo</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/AuthenticationProvider.html">AuthenticationProvider</a>.<a href="../interfaces/AuthenticationProvider.html#getAuthenticationInfo">getAuthenticationInfo</a></p><ul><li>Defined in src/user/auth-provider.ts:84</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>Generates and returns authentication information.</p>
9
+ </div></div><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">AuthenticationInfo</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 id="reset" class="tsd-anchor"></a><h3>reset</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/AuthenticationProvider.html">AuthenticationProvider</a>.<a href="../interfaces/AuthenticationProvider.html#reset">reset</a></p><ul><li>Defined in src/user/auth-provider.ts:102</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>Resets internal state and releases any associated resources.</p>
11
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="TESTAuthenticationProvider.html" class="tsd-kind-icon">TESTAuthentication<wbr/>Provider</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="TESTAuthenticationProvider.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TESTAuthenticationProvider.html#testRegistrationAudience" class="tsd-kind-icon">test<wbr/>Registration<wbr/>Audience</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TESTAuthenticationProvider.html#testRegistrationIssuer" class="tsd-kind-icon">test<wbr/>Registration<wbr/>Issuer</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TESTAuthenticationProvider.html#getAuthenticationInfo" class="tsd-kind-icon">get<wbr/>Authentication<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TESTAuthenticationProvider.html#reset" class="tsd-kind-icon">reset</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><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></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></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="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>