@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/classes/localauthenticationprovider.html DELETED
@@ -1,287 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>LocalAuthenticationProvider | @sudoplatform/sudo-user</title>
7
- <meta name="description" content="Documentation for @sudoplatform/sudo-user">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">@sudoplatform/sudo-user</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- <input type="checkbox" id="tsd-filter-externals" checked />
43
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
- </div>
45
- </div>
46
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
- </div>
48
- </div>
49
- </div>
50
- </div>
51
- <div class="tsd-page-title">
52
- <div class="container">
53
- <ul class="tsd-breadcrumb">
54
- <li>
55
- <a href="../modules.html">@sudoplatform/sudo-user</a>
56
- </li>
57
- <li>
58
- <a href="localauthenticationprovider.html">LocalAuthenticationProvider</a>
59
- </li>
60
- </ul>
61
- <h1>Class LocalAuthenticationProvider</h1>
62
- </div>
63
- </div>
64
- </header>
65
- <div class="container container-main">
66
- <div class="row">
67
- <div class="col-8 col-content">
68
- <section class="tsd-panel tsd-comment">
69
- <div class="tsd-comment tsd-typography">
70
- <div class="lead">
71
- <p>Authentication info consisting of a JWT signed using the locally stored private key.</p>
72
- </div>
73
- <dl class="tsd-comment-tags">
74
- <dt>param</dt>
75
- <dd><p>provider name. This name will be used to populate JWT iss (issuer).</p>
76
- </dd>
77
- <dt>param</dt>
78
- <dd><p>PEM encoded RSA private key.</p>
79
- </dd>
80
- <dt>param</dt>
81
- <dd><p>key ID.</p>
82
- </dd>
83
- <dt>param</dt>
84
- <dd><p>username to be associated with the issued authentication info.</p>
85
- </dd>
86
- <dt>param</dt>
87
- <dd><p>additional attributes to be added to the issued authentication info.</p>
88
- </dd>
89
- </dl>
90
- </div>
91
- </section>
92
- <section class="tsd-panel tsd-hierarchy">
93
- <h3>Hierarchy</h3>
94
- <ul class="tsd-hierarchy">
95
- <li>
96
- <span class="target">LocalAuthenticationProvider</span>
97
- </li>
98
- </ul>
99
- </section>
100
- <section class="tsd-panel">
101
- <h3>Implements</h3>
102
- <ul class="tsd-hierarchy">
103
- <li><a href="../interfaces/authenticationprovider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a></li>
104
- </ul>
105
- </section>
106
- <section class="tsd-panel-group tsd-index-group">
107
- <h2>Index</h2>
108
- <section class="tsd-panel tsd-index-panel">
109
- <div class="tsd-index-content">
110
- <section class="tsd-index-section ">
111
- <h3>Constructors</h3>
112
- <ul class="tsd-index-list">
113
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="localauthenticationprovider.html#constructor" class="tsd-kind-icon">constructor</a></li>
114
- </ul>
115
- </section>
116
- <section class="tsd-index-section ">
117
- <h3>Methods</h3>
118
- <ul class="tsd-index-list">
119
- <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>
120
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="localauthenticationprovider.html#reset" class="tsd-kind-icon">reset</a></li>
121
- </ul>
122
- </section>
123
- </div>
124
- </section>
125
- </section>
126
- <section class="tsd-panel-group tsd-member-group ">
127
- <h2>Constructors</h2>
128
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
129
- <a name="constructor" class="tsd-anchor"></a>
130
- <h3>constructor</h3>
131
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
132
- <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>
133
- </ul>
134
- <ul class="tsd-descriptions">
135
- <li class="tsd-description">
136
- <aside class="tsd-sources">
137
- <ul>
138
- <li>Defined in src/user/auth-provider.ts:137</li>
139
- </ul>
140
- </aside>
141
- <h4 class="tsd-parameters-title">Parameters</h4>
142
- <ul class="tsd-parameters">
143
- <li>
144
- <h5>name: <span class="tsd-signature-type">string</span></h5>
145
- </li>
146
- <li>
147
- <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
148
- </li>
149
- <li>
150
- <h5>keyId: <span class="tsd-signature-type">string</span></h5>
151
- </li>
152
- <li>
153
- <h5>username: <span class="tsd-signature-type">string</span></h5>
154
- </li>
155
- <li>
156
- <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>
157
- </li>
158
- </ul>
159
- <h4 class="tsd-returns-title">Returns <a href="localauthenticationprovider.html" class="tsd-signature-type" data-tsd-kind="Class">LocalAuthenticationProvider</a></h4>
160
- </li>
161
- </ul>
162
- </section>
163
- </section>
164
- <section class="tsd-panel-group tsd-member-group ">
165
- <h2>Methods</h2>
166
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
167
- <a name="getauthenticationinfo" class="tsd-anchor"></a>
168
- <h3>get<wbr>Authentication<wbr>Info</h3>
169
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
170
- <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>
171
- </ul>
172
- <ul class="tsd-descriptions">
173
- <li class="tsd-description">
174
- <aside class="tsd-sources">
175
- <p>Implementation of <a href="../interfaces/authenticationprovider.html">AuthenticationProvider</a>.<a href="../interfaces/authenticationprovider.html#getauthenticationinfo">getAuthenticationInfo</a></p>
176
- <ul>
177
- <li>Defined in src/user/auth-provider.ts:146</li>
178
- </ul>
179
- </aside>
180
- <div class="tsd-comment tsd-typography">
181
- <div class="lead">
182
- <p>Generates and returns authentication information.</p>
183
- </div>
184
- </div>
185
- <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>
186
- </li>
187
- </ul>
188
- </section>
189
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
190
- <a name="reset" class="tsd-anchor"></a>
191
- <h3>reset</h3>
192
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
193
- <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>
194
- </ul>
195
- <ul class="tsd-descriptions">
196
- <li class="tsd-description">
197
- <aside class="tsd-sources">
198
- <p>Implementation of <a href="../interfaces/authenticationprovider.html">AuthenticationProvider</a>.<a href="../interfaces/authenticationprovider.html#reset">reset</a></p>
199
- <ul>
200
- <li>Defined in src/user/auth-provider.ts:164</li>
201
- </ul>
202
- </aside>
203
- <div class="tsd-comment tsd-typography">
204
- <div class="lead">
205
- <p>Resets internal state and releases any associated resources.</p>
206
- </div>
207
- </div>
208
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
209
- </li>
210
- </ul>
211
- </section>
212
- </section>
213
- </div>
214
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
215
- <nav class="tsd-navigation primary">
216
- <ul>
217
- <li class=" ">
218
- <a href="../modules.html">Exports</a>
219
- </li>
220
- </ul>
221
- </nav>
222
- <nav class="tsd-navigation secondary menu-sticky">
223
- <ul class="before-current">
224
- <li class=" tsd-kind-class">
225
- <a href="alreadyregisterederror.html" class="tsd-kind-icon">Already<wbr>Registered<wbr>Error</a>
226
- </li>
227
- <li class=" tsd-kind-class">
228
- <a href="defaultsudouserclient.html" class="tsd-kind-icon">Default<wbr>Sudo<wbr>User<wbr>Client</a>
229
- </li>
230
- </ul>
231
- <ul class="current">
232
- <li class="current tsd-kind-class">
233
- <a href="localauthenticationprovider.html" class="tsd-kind-icon">Local<wbr>Authentication<wbr>Provider</a>
234
- <ul>
235
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
236
- <a href="localauthenticationprovider.html#constructor" class="tsd-kind-icon">constructor</a>
237
- </li>
238
- <li class=" tsd-kind-method tsd-parent-kind-class">
239
- <a href="localauthenticationprovider.html#getauthenticationinfo" class="tsd-kind-icon">get<wbr>Authentication<wbr>Info</a>
240
- </li>
241
- <li class=" tsd-kind-method tsd-parent-kind-class">
242
- <a href="localauthenticationprovider.html#reset" class="tsd-kind-icon">reset</a>
243
- </li>
244
- </ul>
245
- </li>
246
- </ul>
247
- <ul class="after-current">
248
- <li class=" tsd-kind-class">
249
- <a href="testauthenticationprovider.html" class="tsd-kind-icon">TESTAuthentication<wbr>Provider</a>
250
- </li>
251
- <li class=" tsd-kind-interface">
252
- <a href="../interfaces/authenticationprovider.html" class="tsd-kind-icon">Authentication<wbr>Provider</a>
253
- </li>
254
- <li class=" tsd-kind-interface">
255
- <a href="../interfaces/authenticationtokens.html" class="tsd-kind-icon">Authentication<wbr>Tokens</a>
256
- </li>
257
- <li class=" tsd-kind-interface">
258
- <a href="../interfaces/sudouserclient.html" class="tsd-kind-icon">Sudo<wbr>User<wbr>Client</a>
259
- </li>
260
- </ul>
261
- </nav>
262
- </div>
263
- </div>
264
- </div>
265
- <footer class="with-border-bottom">
266
- <div class="container">
267
- <h2>Legend</h2>
268
- <div class="tsd-legend-group">
269
- <ul class="tsd-legend">
270
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
271
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
272
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
273
- </ul>
274
- <ul class="tsd-legend">
275
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
276
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
277
- </ul>
278
- </div>
279
- </div>
280
- </footer>
281
- <div class="container tsd-generator">
282
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
283
- </div>
284
- <div class="overlay"></div>
285
- <script src="../assets/js/main.js"></script>
286
- </body>
287
- </html>
package/docs/classes/testauthenticationprovider.html DELETED
@@ -1,317 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>TESTAuthenticationProvider | @sudoplatform/sudo-user</title>
7
- <meta name="description" content="Documentation for @sudoplatform/sudo-user">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">@sudoplatform/sudo-user</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- <input type="checkbox" id="tsd-filter-externals" checked />
43
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
- </div>
45
- </div>
46
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
- </div>
48
- </div>
49
- </div>
50
- </div>
51
- <div class="tsd-page-title">
52
- <div class="container">
53
- <ul class="tsd-breadcrumb">
54
- <li>
55
- <a href="../modules.html">@sudoplatform/sudo-user</a>
56
- </li>
57
- <li>
58
- <a href="testauthenticationprovider.html">TESTAuthenticationProvider</a>
59
- </li>
60
- </ul>
61
- <h1>Class TESTAuthenticationProvider</h1>
62
- </div>
63
- </div>
64
- </header>
65
- <div class="container container-main">
66
- <div class="row">
67
- <div class="col-8 col-content">
68
- <section class="tsd-panel tsd-comment">
69
- <div class="tsd-comment tsd-typography">
70
- <div class="lead">
71
- <p>Authentication provider for generating authentication info using a TEST registration key.</p>
72
- </div>
73
- <dl class="tsd-comment-tags">
74
- <dt>param</dt>
75
- <dd><p>provider name. This name will be prepended to the generated UUID in JWT sub.</p>
76
- </dd>
77
- <dt>param</dt>
78
- <dd><p>PEM encoded RSA private key.</p>
79
- </dd>
80
- <dt>param</dt>
81
- <dd><p>key ID of the TEST registration key which is obtained from the admin console.</p>
82
- </dd>
83
- <dt>param</dt>
84
- <dd><p>additional attributes to be added to the issued authentication info.</p>
85
- </dd>
86
- </dl>
87
- </div>
88
- </section>
89
- <section class="tsd-panel tsd-hierarchy">
90
- <h3>Hierarchy</h3>
91
- <ul class="tsd-hierarchy">
92
- <li>
93
- <span class="target">TESTAuthenticationProvider</span>
94
- </li>
95
- </ul>
96
- </section>
97
- <section class="tsd-panel">
98
- <h3>Implements</h3>
99
- <ul class="tsd-hierarchy">
100
- <li><a href="../interfaces/authenticationprovider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a></li>
101
- </ul>
102
- </section>
103
- <section class="tsd-panel-group tsd-index-group">
104
- <h2>Index</h2>
105
- <section class="tsd-panel tsd-index-panel">
106
- <div class="tsd-index-content">
107
- <section class="tsd-index-section ">
108
- <h3>Constructors</h3>
109
- <ul class="tsd-index-list">
110
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="testauthenticationprovider.html#constructor" class="tsd-kind-icon">constructor</a></li>
111
- </ul>
112
- </section>
113
- <section class="tsd-index-section ">
114
- <h3>Properties</h3>
115
- <ul class="tsd-index-list">
116
- <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>
117
- <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>
118
- </ul>
119
- </section>
120
- <section class="tsd-index-section ">
121
- <h3>Methods</h3>
122
- <ul class="tsd-index-list">
123
- <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>
124
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="testauthenticationprovider.html#reset" class="tsd-kind-icon">reset</a></li>
125
- </ul>
126
- </section>
127
- </div>
128
- </section>
129
- </section>
130
- <section class="tsd-panel-group tsd-member-group ">
131
- <h2>Constructors</h2>
132
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
133
- <a name="constructor" class="tsd-anchor"></a>
134
- <h3>constructor</h3>
135
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
136
- <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>
137
- </ul>
138
- <ul class="tsd-descriptions">
139
- <li class="tsd-description">
140
- <aside class="tsd-sources">
141
- <ul>
142
- <li>Defined in src/user/auth-provider.ts:76</li>
143
- </ul>
144
- </aside>
145
- <h4 class="tsd-parameters-title">Parameters</h4>
146
- <ul class="tsd-parameters">
147
- <li>
148
- <h5>name: <span class="tsd-signature-type">string</span></h5>
149
- </li>
150
- <li>
151
- <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
152
- </li>
153
- <li>
154
- <h5>keyId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;register_key&#x27;</span></h5>
155
- </li>
156
- <li>
157
- <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>
158
- </li>
159
- </ul>
160
- <h4 class="tsd-returns-title">Returns <a href="testauthenticationprovider.html" class="tsd-signature-type" data-tsd-kind="Class">TESTAuthenticationProvider</a></h4>
161
- </li>
162
- </ul>
163
- </section>
164
- </section>
165
- <section class="tsd-panel-group tsd-member-group ">
166
- <h2>Properties</h2>
167
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
168
- <a name="testregistrationaudience" class="tsd-anchor"></a>
169
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> test<wbr>Registration<wbr>Audience</h3>
170
- <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"> = &#x27;testRegisterAudience&#x27;</span></div>
171
- <aside class="tsd-sources">
172
- <ul>
173
- <li>Defined in src/user/auth-provider.ts:76</li>
174
- </ul>
175
- </aside>
176
- </section>
177
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
178
- <a name="testregistrationissuer" class="tsd-anchor"></a>
179
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> test<wbr>Registration<wbr>Issuer</h3>
180
- <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"> = &#x27;testRegisterIssuer&#x27;</span></div>
181
- <aside class="tsd-sources">
182
- <ul>
183
- <li>Defined in src/user/auth-provider.ts:75</li>
184
- </ul>
185
- </aside>
186
- </section>
187
- </section>
188
- <section class="tsd-panel-group tsd-member-group ">
189
- <h2>Methods</h2>
190
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
191
- <a name="getauthenticationinfo" class="tsd-anchor"></a>
192
- <h3>get<wbr>Authentication<wbr>Info</h3>
193
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
194
- <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>
195
- </ul>
196
- <ul class="tsd-descriptions">
197
- <li class="tsd-description">
198
- <aside class="tsd-sources">
199
- <p>Implementation of <a href="../interfaces/authenticationprovider.html">AuthenticationProvider</a>.<a href="../interfaces/authenticationprovider.html#getauthenticationinfo">getAuthenticationInfo</a></p>
200
- <ul>
201
- <li>Defined in src/user/auth-provider.ts:84</li>
202
- </ul>
203
- </aside>
204
- <div class="tsd-comment tsd-typography">
205
- <div class="lead">
206
- <p>Generates and returns authentication information.</p>
207
- </div>
208
- </div>
209
- <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>
210
- </li>
211
- </ul>
212
- </section>
213
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
214
- <a name="reset" class="tsd-anchor"></a>
215
- <h3>reset</h3>
216
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
217
- <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>
218
- </ul>
219
- <ul class="tsd-descriptions">
220
- <li class="tsd-description">
221
- <aside class="tsd-sources">
222
- <p>Implementation of <a href="../interfaces/authenticationprovider.html">AuthenticationProvider</a>.<a href="../interfaces/authenticationprovider.html#reset">reset</a></p>
223
- <ul>
224
- <li>Defined in src/user/auth-provider.ts:102</li>
225
- </ul>
226
- </aside>
227
- <div class="tsd-comment tsd-typography">
228
- <div class="lead">
229
- <p>Resets internal state and releases any associated resources.</p>
230
- </div>
231
- </div>
232
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
233
- </li>
234
- </ul>
235
- </section>
236
- </section>
237
- </div>
238
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
239
- <nav class="tsd-navigation primary">
240
- <ul>
241
- <li class=" ">
242
- <a href="../modules.html">Exports</a>
243
- </li>
244
- </ul>
245
- </nav>
246
- <nav class="tsd-navigation secondary menu-sticky">
247
- <ul class="before-current">
248
- <li class=" tsd-kind-class">
249
- <a href="alreadyregisterederror.html" class="tsd-kind-icon">Already<wbr>Registered<wbr>Error</a>
250
- </li>
251
- <li class=" tsd-kind-class">
252
- <a href="defaultsudouserclient.html" class="tsd-kind-icon">Default<wbr>Sudo<wbr>User<wbr>Client</a>
253
- </li>
254
- <li class=" tsd-kind-class">
255
- <a href="localauthenticationprovider.html" class="tsd-kind-icon">Local<wbr>Authentication<wbr>Provider</a>
256
- </li>
257
- </ul>
258
- <ul class="current">
259
- <li class="current tsd-kind-class">
260
- <a href="testauthenticationprovider.html" class="tsd-kind-icon">TESTAuthentication<wbr>Provider</a>
261
- <ul>
262
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
263
- <a href="testauthenticationprovider.html#constructor" class="tsd-kind-icon">constructor</a>
264
- </li>
265
- <li class=" tsd-kind-property tsd-parent-kind-class">
266
- <a href="testauthenticationprovider.html#testregistrationaudience" class="tsd-kind-icon">test<wbr>Registration<wbr>Audience</a>
267
- </li>
268
- <li class=" tsd-kind-property tsd-parent-kind-class">
269
- <a href="testauthenticationprovider.html#testregistrationissuer" class="tsd-kind-icon">test<wbr>Registration<wbr>Issuer</a>
270
- </li>
271
- <li class=" tsd-kind-method tsd-parent-kind-class">
272
- <a href="testauthenticationprovider.html#getauthenticationinfo" class="tsd-kind-icon">get<wbr>Authentication<wbr>Info</a>
273
- </li>
274
- <li class=" tsd-kind-method tsd-parent-kind-class">
275
- <a href="testauthenticationprovider.html#reset" class="tsd-kind-icon">reset</a>
276
- </li>
277
- </ul>
278
- </li>
279
- </ul>
280
- <ul class="after-current">
281
- <li class=" tsd-kind-interface">
282
- <a href="../interfaces/authenticationprovider.html" class="tsd-kind-icon">Authentication<wbr>Provider</a>
283
- </li>
284
- <li class=" tsd-kind-interface">
285
- <a href="../interfaces/authenticationtokens.html" class="tsd-kind-icon">Authentication<wbr>Tokens</a>
286
- </li>
287
- <li class=" tsd-kind-interface">
288
- <a href="../interfaces/sudouserclient.html" class="tsd-kind-icon">Sudo<wbr>User<wbr>Client</a>
289
- </li>
290
- </ul>
291
- </nav>
292
- </div>
293
- </div>
294
- </div>
295
- <footer class="with-border-bottom">
296
- <div class="container">
297
- <h2>Legend</h2>
298
- <div class="tsd-legend-group">
299
- <ul class="tsd-legend">
300
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
301
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
302
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
303
- </ul>
304
- <ul class="tsd-legend">
305
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
306
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
307
- </ul>
308
- </div>
309
- </div>
310
- </footer>
311
- <div class="container tsd-generator">
312
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
313
- </div>
314
- <div class="overlay"></div>
315
- <script src="../assets/js/main.js"></script>
316
- </body>
317
- </html>