@sudoplatform/sudo-user 17.1.0 → 17.2.0
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.
- package/cjs/client/amplifyClient.js +0 -1
- package/cjs/client/apiClient.js +0 -1
- package/cjs/client/graphqlClient.js +0 -1
- package/cjs/client/transformer/ErrorTransformer.js +0 -1
- package/cjs/core/api-key-names.js +0 -1
- package/cjs/core/auth-store.js +0 -1
- package/cjs/core/crypto.js +0 -1
- package/cjs/core/key-manager.js +0 -1
- package/cjs/core/protected-store.js +0 -1
- package/cjs/core/publisher.js +0 -1
- package/cjs/core/sdk-config.js +0 -1
- package/cjs/core/subscriber.js +0 -1
- package/cjs/gen/graphql-types.js +0 -1
- package/cjs/index.js +0 -1
- package/cjs/runtimes/browser/browser-crypto.js +0 -1
- package/cjs/runtimes/node/node-crypto.js +0 -1
- package/cjs/sdk.js +0 -1
- package/cjs/user/auth-provider.js +0 -1
- package/cjs/user/auth.js +0 -1
- package/cjs/user/error.js +10 -2
- package/cjs/user/identity-provider.js +0 -1
- package/cjs/user/sign-in-callback.js +0 -1
- package/cjs/user/sign-in-guard.js +0 -1
- package/cjs/user/user-client-interface.js +0 -1
- package/cjs/user/user-client.js +48 -33
- package/cjs/user/user-key-names.js +0 -1
- package/cjs/utils/jwt.js +0 -1
- package/cjs/utils/parse-token.js +0 -1
- package/cjs/utils/resolvable-promise.js +0 -1
- package/cjs/utils/sign-options-builder.js +0 -1
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/highlight.css +1 -1
- package/docs/assets/icons.js +1 -1
- package/docs/assets/icons.svg +1 -1
- package/docs/assets/main.js +4 -4
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +18 -3
- package/docs/classes/AlreadyRegisteredError.html +148 -8
- package/docs/classes/AlreadySignedInError.html +173 -0
- package/docs/classes/DefaultSudoUserClient.html +543 -57
- package/docs/classes/IdentityServiceConfigNotFoundError.html +148 -8
- package/docs/classes/LocalAuthenticationProvider.html +123 -12
- package/docs/classes/SignInGuard.html +107 -8
- package/docs/classes/TESTAuthenticationProvider.html +138 -12
- package/docs/classes/internal.AmplifyClient.html +148 -13
- package/docs/enums/GraphQLClientAuthMode.html +64 -2
- package/docs/functions/internal.getIdentityServiceConfig.html +39 -1
- package/docs/hierarchy.html +42 -1
- package/docs/index.html +37 -2
- package/docs/interfaces/AuthenticationProvider.html +78 -5
- package/docs/interfaces/AuthenticationTokens.html +86 -7
- package/docs/interfaces/GraphQLClient.html +123 -12
- package/docs/interfaces/GraphQLClientOptions.html +92 -8
- package/docs/interfaces/SudoPlatformSignInCallback.html +68 -5
- package/docs/interfaces/SudoUserClient.html +431 -52
- package/docs/interfaces/internal.SudoUserOptions.html +91 -2
- package/docs/modules/internal.html +53 -1
- package/docs/modules.html +52 -1
- package/docs/types/IAMCredentials.html +65 -2
- package/docs/types/TokenProvider.html +33 -1
- package/docs/types/internal.Config.html +35 -1
- package/docs/types/internal.FederatedSignInConfig.html +34 -1
- package/docs/types/internal.IdentityServiceConfig.html +34 -1
- package/docs/variables/internal.Config.html +35 -1
- package/docs/variables/internal.FederatedSignInConfigCodec.html +34 -1
- package/docs/variables/internal.IdentityServiceConfigCodec.html +34 -1
- package/lib/client/amplifyClient.js +0 -1
- package/lib/client/apiClient.js +0 -1
- package/lib/client/graphqlClient.js +0 -1
- package/lib/client/transformer/ErrorTransformer.js +0 -1
- package/lib/core/api-key-names.js +0 -1
- package/lib/core/auth-store.js +0 -1
- package/lib/core/crypto.js +0 -1
- package/lib/core/key-manager.js +0 -1
- package/lib/core/protected-store.js +0 -1
- package/lib/core/publisher.js +0 -1
- package/lib/core/sdk-config.js +0 -1
- package/lib/core/subscriber.js +0 -1
- package/lib/gen/graphql-types.js +0 -1
- package/lib/index.js +0 -1
- package/lib/runtimes/browser/browser-crypto.js +0 -1
- package/lib/runtimes/node/node-crypto.js +0 -1
- package/lib/sdk.js +0 -1
- package/lib/user/auth-provider.js +0 -1
- package/lib/user/auth.js +0 -1
- package/lib/user/error.js +8 -1
- package/lib/user/identity-provider.js +0 -1
- package/lib/user/sign-in-callback.js +0 -1
- package/lib/user/sign-in-guard.js +0 -1
- package/lib/user/user-client-interface.js +0 -1
- package/lib/user/user-client.js +49 -34
- package/lib/user/user-key-names.js +0 -1
- package/lib/utils/jwt.js +0 -1
- package/lib/utils/parse-token.js +0 -1
- package/lib/utils/resolvable-promise.js +0 -1
- package/lib/utils/sign-options-builder.js +0 -1
- package/package.json +36 -35
- package/types/user/error.d.ts +6 -0
- package/types/user/user-client-interface.d.ts +12 -0
- package/types/user/user-client.d.ts +1 -0
- package/cjs/client/amplifyClient.js.map +0 -1
- package/cjs/client/apiClient.js.map +0 -1
- package/cjs/client/graphqlClient.js.map +0 -1
- package/cjs/client/transformer/ErrorTransformer.js.map +0 -1
- package/cjs/core/api-key-names.js.map +0 -1
- package/cjs/core/auth-store.js.map +0 -1
- package/cjs/core/crypto.js.map +0 -1
- package/cjs/core/key-manager.js.map +0 -1
- package/cjs/core/protected-store.js.map +0 -1
- package/cjs/core/publisher.js.map +0 -1
- package/cjs/core/sdk-config.js.map +0 -1
- package/cjs/core/subscriber.js.map +0 -1
- package/cjs/gen/graphql-types.js.map +0 -1
- package/cjs/index.js.map +0 -1
- package/cjs/runtimes/browser/browser-crypto.js.map +0 -1
- package/cjs/runtimes/node/node-crypto.js.map +0 -1
- package/cjs/sdk.js.map +0 -1
- package/cjs/user/auth-provider.js.map +0 -1
- package/cjs/user/auth.js.map +0 -1
- package/cjs/user/error.js.map +0 -1
- package/cjs/user/identity-provider.js.map +0 -1
- package/cjs/user/sign-in-callback.js.map +0 -1
- package/cjs/user/sign-in-guard.js.map +0 -1
- package/cjs/user/user-client-interface.js.map +0 -1
- package/cjs/user/user-client.js.map +0 -1
- package/cjs/user/user-key-names.js.map +0 -1
- package/cjs/utils/jwt.js.map +0 -1
- package/cjs/utils/parse-token.js.map +0 -1
- package/cjs/utils/resolvable-promise.js.map +0 -1
- package/cjs/utils/sign-options-builder.js.map +0 -1
- package/lib/client/amplifyClient.js.map +0 -1
- package/lib/client/apiClient.js.map +0 -1
- package/lib/client/graphqlClient.js.map +0 -1
- package/lib/client/transformer/ErrorTransformer.js.map +0 -1
- package/lib/core/api-key-names.js.map +0 -1
- package/lib/core/auth-store.js.map +0 -1
- package/lib/core/crypto.js.map +0 -1
- package/lib/core/key-manager.js.map +0 -1
- package/lib/core/protected-store.js.map +0 -1
- package/lib/core/publisher.js.map +0 -1
- package/lib/core/sdk-config.js.map +0 -1
- package/lib/core/subscriber.js.map +0 -1
- package/lib/gen/graphql-types.js.map +0 -1
- package/lib/index.js.map +0 -1
- package/lib/runtimes/browser/browser-crypto.js.map +0 -1
- package/lib/runtimes/node/node-crypto.js.map +0 -1
- package/lib/sdk.js.map +0 -1
- package/lib/user/auth-provider.js.map +0 -1
- package/lib/user/auth.js.map +0 -1
- package/lib/user/error.js.map +0 -1
- package/lib/user/identity-provider.js.map +0 -1
- package/lib/user/sign-in-callback.js.map +0 -1
- package/lib/user/sign-in-guard.js.map +0 -1
- package/lib/user/user-client-interface.js.map +0 -1
- package/lib/user/user-client.js.map +0 -1
- package/lib/user/user-key-names.js.map +0 -1
- package/lib/utils/jwt.js.map +0 -1
- package/lib/utils/parse-token.js.map +0 -1
- package/lib/utils/resolvable-promise.js.map +0 -1
- package/lib/utils/sign-options-builder.js.map +0 -1
|
@@ -1,21 +1,107 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-user</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">IdentityServiceConfigNotFoundError</a></li></ul>
|
|
12
|
+
<h1>Class IdentityServiceConfigNotFoundError</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Indicates the configuration related to Identity Service is not found. This may indicate that Identity Service
|
|
2
15
|
is not deployed into your runtime instance or the config file that
|
|
3
16
|
you are using is invalid.</p>
|
|
4
|
-
</div></section
|
|
5
|
-
|
|
17
|
+
</div></section>
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="99">
|
|
19
|
+
<h4>Hierarchy</h4>
|
|
20
|
+
<ul class="tsd-hierarchy">
|
|
21
|
+
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">UserError</span>
|
|
22
|
+
<ul class="tsd-hierarchy">
|
|
23
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">IdentityServiceConfigNotFoundError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
24
|
+
<ul>
|
|
25
|
+
<li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/error.ts#L40">src/user/error.ts:40</a></li></ul></aside>
|
|
26
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
27
|
+
<section class="tsd-panel tsd-index-panel">
|
|
28
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
29
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
30
|
+
<div class="tsd-accordion-details">
|
|
31
|
+
<section class="tsd-index-section">
|
|
32
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
33
|
+
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
34
|
+
</div></section>
|
|
35
|
+
<section class="tsd-index-section">
|
|
36
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
37
|
+
<div class="tsd-index-list"><a href="#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
|
|
6
38
|
<a href="#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
|
|
7
39
|
<a href="#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack?</span></a>
|
|
8
40
|
<a href="#stacktracelimit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
|
9
|
-
</div></section
|
|
41
|
+
</div></section>
|
|
42
|
+
<section class="tsd-index-section">
|
|
43
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
44
|
+
<div class="tsd-index-list"><a href="#capturestacktrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a>
|
|
10
45
|
<a href="#preparestacktrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
|
11
|
-
</div></section></div></details></section></section
|
|
46
|
+
</div></section></div></details></section></section>
|
|
47
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
48
|
+
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
49
|
+
<section>
|
|
50
|
+
<section class="tsd-panel tsd-member">
|
|
51
|
+
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
52
|
+
<ul class="tsd-signatures">
|
|
53
|
+
<li class="">
|
|
54
|
+
<div class="tsd-signature tsd-anchor-link" id="constructoridentityserviceconfignotfounderror"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">IdentityServiceConfigNotFoundError</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">IdentityServiceConfigNotFoundError</a><a href="#constructoridentityserviceconfignotfounderror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
55
|
+
<div class="tsd-description">
|
|
56
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">IdentityServiceConfigNotFoundError</a></h4><aside class="tsd-sources">
|
|
57
|
+
<p>Overrides UserError.constructor</p>
|
|
58
|
+
<ul>
|
|
59
|
+
<li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/error.ts#L41">src/user/error.ts:41</a></li></ul></aside></div></li></ul></section></section></details>
|
|
60
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
61
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
62
|
+
<section>
|
|
63
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
64
|
+
<h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
65
|
+
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
66
|
+
<p>Inherited from UserError.message</p>
|
|
67
|
+
<ul>
|
|
68
|
+
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section>
|
|
69
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
70
|
+
<h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
71
|
+
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
72
|
+
<p>Inherited from UserError.name</p>
|
|
73
|
+
<ul>
|
|
74
|
+
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section>
|
|
75
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
76
|
+
<h3 class="tsd-anchor-link" id="stack"><code class="tsd-tag">Optional</code><span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
77
|
+
<div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
78
|
+
<p>Inherited from UserError.stack</p>
|
|
79
|
+
<ul>
|
|
80
|
+
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section>
|
|
81
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
82
|
+
<h3 class="tsd-anchor-link" id="stacktracelimit"><code class="tsd-tag">Static</code><span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stacktracelimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
|
+
<div class="tsd-signature"><span class="tsd-kind-property">stackTraceLimit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
84
|
+
<div class="tsd-comment tsd-typography"><p>The <code>Error.stackTraceLimit</code> property specifies the number of stack frames
|
|
12
85
|
collected by a stack trace (whether generated by <code>new Error().stack</code> or
|
|
13
86
|
<code>Error.captureStackTrace(obj)</code>).</p>
|
|
14
87
|
<p>The default value is <code>10</code> but may be set to any valid JavaScript number. Changes
|
|
15
88
|
will affect any stack trace captured <em>after</em> the value has been changed.</p>
|
|
16
89
|
<p>If set to a non-number value, or set to a negative number, stack traces will
|
|
17
90
|
not capture any frames.</p>
|
|
18
|
-
</div><aside class="tsd-sources"
|
|
91
|
+
</div><aside class="tsd-sources">
|
|
92
|
+
<p>Inherited from UserError.stackTraceLimit</p>
|
|
93
|
+
<ul>
|
|
94
|
+
<li>Defined in node_modules/@types/node/globals.d.ts:68</li></ul></aside></section></section></details>
|
|
95
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
96
|
+
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
97
|
+
<section>
|
|
98
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
99
|
+
<h3 class="tsd-anchor-link" id="capturestacktrace"><code class="tsd-tag">Static</code><span>capture<wbr/>Stack<wbr/>Trace</span><a href="#capturestacktrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
100
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
101
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
102
|
+
<div class="tsd-signature tsd-anchor-link" id="capturestacktrace-1"><span class="tsd-kind-call-signature">captureStackTrace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">constructorOpt</span><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><a href="#capturestacktrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
103
|
+
<div class="tsd-description">
|
|
104
|
+
<div class="tsd-comment tsd-typography"><p>Creates a <code>.stack</code> property on <code>targetObject</code>, which when accessed returns
|
|
19
105
|
a string representing the location in the code at which
|
|
20
106
|
<code>Error.captureStackTrace()</code> was called.</p>
|
|
21
107
|
<pre><code class="js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myObject</span><span class="hl-1"> = {};</span><br/><span class="hl-3">Error</span><span class="hl-1">.</span><span class="hl-4">captureStackTrace</span><span class="hl-1">(</span><span class="hl-3">myObject</span><span class="hl-1">);</span><br/><span class="hl-3">myObject</span><span class="hl-1">.</span><span class="hl-3">stack</span><span class="hl-1">; </span><span class="hl-5">// Similar to `new Error().stack`</span>
|
|
@@ -31,5 +117,59 @@ details of error generation from the user. For instance:</p>
|
|
|
31
117
|
<pre><code class="js"><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">b</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-4">b</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">c</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-4">c</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-5">// Create an error without stack trace to avoid calculating the stack trace twice.</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">stackTraceLimit</span><span class="hl-1"> } = </span><span class="hl-3">Error</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">Error</span><span class="hl-1">.</span><span class="hl-3">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-6">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">error</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-4">Error</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-3">Error</span><span class="hl-1">.</span><span class="hl-3">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-3">stackTraceLimit</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// Capture the stack trace above function b</span><br/><span class="hl-1"> </span><span class="hl-3">Error</span><span class="hl-1">.</span><span class="hl-4">captureStackTrace</span><span class="hl-1">(</span><span class="hl-3">error</span><span class="hl-1">, </span><span class="hl-3">b</span><span class="hl-1">); </span><span class="hl-5">// Neither function c, nor b is included in the stack trace</span><br/><span class="hl-1"> </span><span class="hl-7">throw</span><span class="hl-1"> </span><span class="hl-3">error</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">a</span><span class="hl-1">();</span>
|
|
32
118
|
</code><button type="button">Copy</button></pre>
|
|
33
119
|
|
|
34
|
-
</div
|
|
35
|
-
|
|
120
|
+
</div>
|
|
121
|
+
<div class="tsd-parameters">
|
|
122
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
123
|
+
<ul class="tsd-parameter-list">
|
|
124
|
+
<li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li>
|
|
125
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div>
|
|
126
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
127
|
+
<p>Inherited from UserError.captureStackTrace</p>
|
|
128
|
+
<ul>
|
|
129
|
+
<li>Defined in node_modules/@types/node/globals.d.ts:52</li></ul></aside></div></li></ul></section>
|
|
130
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
131
|
+
<h3 class="tsd-anchor-link" id="preparestacktrace"><code class="tsd-tag">Static</code><span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#preparestacktrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
132
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
133
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
134
|
+
<div class="tsd-signature tsd-anchor-link" id="preparestacktrace-1"><span class="tsd-kind-call-signature">prepareStackTrace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">stackTraces</span><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><a href="#preparestacktrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
135
|
+
<div class="tsd-description">
|
|
136
|
+
<div class="tsd-parameters">
|
|
137
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
138
|
+
<ul class="tsd-parameter-list">
|
|
139
|
+
<li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li>
|
|
140
|
+
<li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
|
|
141
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
142
|
+
<div class="tsd-comment tsd-typography">
|
|
143
|
+
<div class="tsd-tag-see">
|
|
144
|
+
<h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><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>
|
|
145
|
+
</div></div><aside class="tsd-sources">
|
|
146
|
+
<p>Inherited from UserError.prepareStackTrace</p>
|
|
147
|
+
<ul>
|
|
148
|
+
<li>Defined in node_modules/@types/node/globals.d.ts:56</li></ul></aside></div></li></ul></section></section></details></div>
|
|
149
|
+
<div class="col-sidebar">
|
|
150
|
+
<div class="page-menu">
|
|
151
|
+
<div class="tsd-navigation settings">
|
|
152
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
153
|
+
<h3>Settings</h3></summary>
|
|
154
|
+
<div class="tsd-accordion-details">
|
|
155
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
156
|
+
<ul id="tsd-filter-options">
|
|
157
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
158
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
159
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
160
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
161
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
162
|
+
<h3>On This Page</h3></summary>
|
|
163
|
+
<div class="tsd-accordion-details">
|
|
164
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
165
|
+
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
166
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
167
|
+
<div><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#stacktracelimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a></div></details>
|
|
168
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
169
|
+
<div><a href="#capturestacktrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#preparestacktrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a></div></details></div></details></div>
|
|
170
|
+
<div class="site-menu">
|
|
171
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-user</a>
|
|
172
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
173
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
174
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
175
|
+
<div class="overlay"></div></body></html>
|
|
@@ -1,13 +1,124 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-user</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">LocalAuthenticationProvider</a></li></ul>
|
|
12
|
+
<h1>Class LocalAuthenticationProvider</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Authentication info consisting of a JWT signed using the locally stored private key.</p>
|
|
15
|
+
</div>
|
|
16
|
+
<div class="tsd-comment tsd-typography">
|
|
17
|
+
<div class="tsd-tag-param">
|
|
18
|
+
<h4 class="tsd-anchor-link" id="param-name">Param: name<a href="#param-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>provider name. This name will be used to populate JWT iss (issuer).</p>
|
|
19
|
+
</div>
|
|
20
|
+
<div class="tsd-tag-param">
|
|
21
|
+
<h4 class="tsd-anchor-link" id="param-privatekey">Param: privateKey<a href="#param-privatekey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PEM encoded RSA private key.</p>
|
|
22
|
+
</div>
|
|
23
|
+
<div class="tsd-tag-param">
|
|
24
|
+
<h4 class="tsd-anchor-link" id="param-keyid">Param: keyId<a href="#param-keyid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>key ID.</p>
|
|
25
|
+
</div>
|
|
26
|
+
<div class="tsd-tag-param">
|
|
27
|
+
<h4 class="tsd-anchor-link" id="param-username">Param: username<a href="#param-username" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>username to be associated with the issued authentication info.</p>
|
|
28
|
+
</div>
|
|
29
|
+
<div class="tsd-tag-param">
|
|
30
|
+
<h4 class="tsd-anchor-link" id="param-attributes">Param: attributes<a href="#param-attributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>additional attributes to be added to the issued authentication info.</p>
|
|
31
|
+
</div></div></section>
|
|
32
|
+
<section class="tsd-panel">
|
|
33
|
+
<h4>Implements</h4>
|
|
34
|
+
<ul class="tsd-hierarchy">
|
|
35
|
+
<li><a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></li></ul></section><aside class="tsd-sources">
|
|
36
|
+
<ul>
|
|
37
|
+
<li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/auth-provider.ts#L157">src/user/auth-provider.ts:157</a></li></ul></aside>
|
|
38
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
39
|
+
<section class="tsd-panel tsd-index-panel">
|
|
40
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
41
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
42
|
+
<div class="tsd-accordion-details">
|
|
43
|
+
<section class="tsd-index-section">
|
|
44
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
45
|
+
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
46
|
+
</div></section>
|
|
47
|
+
<section class="tsd-index-section">
|
|
48
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
49
|
+
<div class="tsd-index-list"><a href="#getauthenticationinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Authentication<wbr/>Info</span></a>
|
|
9
50
|
<a href="#reset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a>
|
|
10
|
-
</div></section></div></details></section></section
|
|
11
|
-
|
|
12
|
-
<
|
|
13
|
-
|
|
51
|
+
</div></section></div></details></section></section>
|
|
52
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
53
|
+
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
54
|
+
<section>
|
|
55
|
+
<section class="tsd-panel tsd-member">
|
|
56
|
+
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
57
|
+
<ul class="tsd-signatures">
|
|
58
|
+
<li class="">
|
|
59
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorlocalauthenticationprovider"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">LocalAuthenticationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">privateKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">keyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">username</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">attributes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">LocalAuthenticationProvider</a><a href="#constructorlocalauthenticationprovider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
60
|
+
<div class="tsd-description">
|
|
61
|
+
<div class="tsd-parameters">
|
|
62
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
63
|
+
<ul class="tsd-parameter-list">
|
|
64
|
+
<li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
65
|
+
<li><span><span class="tsd-kind-parameter">privateKey</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
66
|
+
<li><span><span class="tsd-kind-parameter">keyId</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
67
|
+
<li><span><span class="tsd-kind-parameter">username</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
68
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">attributes</span>: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</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">></span></span></li></ul></div>
|
|
69
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LocalAuthenticationProvider</a></h4><aside class="tsd-sources">
|
|
70
|
+
<ul>
|
|
71
|
+
<li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/auth-provider.ts#L158">src/user/auth-provider.ts:158</a></li></ul></aside></div></li></ul></section></section></details>
|
|
72
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
73
|
+
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
74
|
+
<section>
|
|
75
|
+
<section class="tsd-panel tsd-member">
|
|
76
|
+
<h3 class="tsd-anchor-link" id="getauthenticationinfo"><span>get<wbr/>Authentication<wbr/>Info</span><a href="#getauthenticationinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
77
|
+
<ul class="tsd-signatures">
|
|
78
|
+
<li class="">
|
|
79
|
+
<div class="tsd-signature tsd-anchor-link" id="getauthenticationinfo-1"><span class="tsd-kind-call-signature">getAuthenticationInfo</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"><</span><span class="tsd-signature-type">AuthenticationInfo</span><span class="tsd-signature-symbol">></span><a href="#getauthenticationinfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
80
|
+
<div class="tsd-description">
|
|
81
|
+
<div class="tsd-comment tsd-typography"><p>Generates and returns authentication information.</p>
|
|
82
|
+
</div>
|
|
83
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AuthenticationInfo</span><span class="tsd-signature-symbol">></span></h4><p>authentication information.</p>
|
|
84
|
+
<aside class="tsd-sources">
|
|
85
|
+
<p>Implementation of <a href="../interfaces/AuthenticationProvider.html">AuthenticationProvider</a>.<a href="../interfaces/AuthenticationProvider.html#getauthenticationinfo">getAuthenticationInfo</a></p>
|
|
86
|
+
<ul>
|
|
87
|
+
<li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/auth-provider.ts#L166">src/user/auth-provider.ts:166</a></li></ul></aside></div></li></ul></section>
|
|
88
|
+
<section class="tsd-panel tsd-member">
|
|
89
|
+
<h3 class="tsd-anchor-link" id="reset"><span>reset</span><a href="#reset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
90
|
+
<ul class="tsd-signatures">
|
|
91
|
+
<li class="">
|
|
92
|
+
<div class="tsd-signature tsd-anchor-link" id="reset-1"><span class="tsd-kind-call-signature">reset</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#reset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
93
|
+
<div class="tsd-description">
|
|
94
|
+
<div class="tsd-comment tsd-typography"><p>Resets internal state and releases any associated resources.</p>
|
|
95
|
+
</div>
|
|
96
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
97
|
+
<p>Implementation of <a href="../interfaces/AuthenticationProvider.html">AuthenticationProvider</a>.<a href="../interfaces/AuthenticationProvider.html#reset">reset</a></p>
|
|
98
|
+
<ul>
|
|
99
|
+
<li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/auth-provider.ts#L181">src/user/auth-provider.ts:181</a></li></ul></aside></div></li></ul></section></section></details></div>
|
|
100
|
+
<div class="col-sidebar">
|
|
101
|
+
<div class="page-menu">
|
|
102
|
+
<div class="tsd-navigation settings">
|
|
103
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
104
|
+
<h3>Settings</h3></summary>
|
|
105
|
+
<div class="tsd-accordion-details">
|
|
106
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
107
|
+
<ul id="tsd-filter-options">
|
|
108
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
109
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
110
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
111
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
112
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
113
|
+
<h3>On This Page</h3></summary>
|
|
114
|
+
<div class="tsd-accordion-details">
|
|
115
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
116
|
+
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
117
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
118
|
+
<div><a href="#getauthenticationinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Authentication<wbr/>Info</span></a><a href="#reset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a></div></details></div></details></div>
|
|
119
|
+
<div class="site-menu">
|
|
120
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-user</a>
|
|
121
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
122
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
123
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
124
|
+
<div class="overlay"></div></body></html>
|