@inrupt/solid-client-authn-browser 1.11.9-alpha.1 → 1.11.9-alpha.4

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 (262) hide show
  1. package/dist/index.es.js +4 -352
  2. package/dist/index.es.js.map +1 -0
  3. package/dist/index.js +12 -360
  4. package/dist/index.js.map +1 -1
  5. package/dist/solid-client-authn.bundle.js +14 -363
  6. package/dist/solid-client-authn.bundle.js.map +1 -0
  7. package/package.json +8 -5
  8. package/.eslintrc.js +0 -16
  9. package/NOTICE +0 -5
  10. package/coverage/clover.xml +0 -547
  11. package/coverage/coverage-final.json +0 -28
  12. package/coverage/lcov-report/base.css +0 -224
  13. package/coverage/lcov-report/block-navigation.js +0 -87
  14. package/coverage/lcov-report/favicon.png +0 -0
  15. package/coverage/lcov-report/index.html +0 -266
  16. package/coverage/lcov-report/prettify.css +0 -1
  17. package/coverage/lcov-report/prettify.js +0 -2
  18. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  19. package/coverage/lcov-report/sorter.js +0 -196
  20. package/coverage/lcov-report/src/ClientAuthentication.ts.html +0 -631
  21. package/coverage/lcov-report/src/Session.ts.html +0 -1435
  22. package/coverage/lcov-report/src/constant.ts.html +0 -163
  23. package/coverage/lcov-report/src/defaultSession.ts.html +0 -460
  24. package/coverage/lcov-report/src/dependencies.ts.html +0 -400
  25. package/coverage/lcov-report/src/iframe.ts.html +0 -394
  26. package/coverage/lcov-report/src/index.browser.ts.html +0 -157
  27. package/coverage/lcov-report/src/index.html +0 -206
  28. package/coverage/lcov-report/src/login/AggregateLoginHandler.ts.html +0 -226
  29. package/coverage/lcov-report/src/login/index.html +0 -116
  30. package/coverage/lcov-report/src/login/oidc/AggregateOidcHandler.ts.html +0 -226
  31. package/coverage/lcov-report/src/login/oidc/ClientRegistrar.ts.html +0 -415
  32. package/coverage/lcov-report/src/login/oidc/IssuerConfigFetcher.ts.html +0 -646
  33. package/coverage/lcov-report/src/login/oidc/OidcLoginHandler.ts.html +0 -436
  34. package/coverage/lcov-report/src/login/oidc/Redirector.ts.html +0 -229
  35. package/coverage/lcov-report/src/login/oidc/index.html +0 -176
  36. package/coverage/lcov-report/src/login/oidc/oidcHandlers/AuthorizationCodeWithPkceOidcHandler.ts.html +0 -478
  37. package/coverage/lcov-report/src/login/oidc/oidcHandlers/OidcHandlerCanHandleTest.ts.html +0 -319
  38. package/coverage/lcov-report/src/login/oidc/oidcHandlers/index.html +0 -131
  39. package/coverage/lcov-report/src/login/oidc/redirectHandler/AggregateRedirectHandler.ts.html +0 -226
  40. package/coverage/lcov-report/src/login/oidc/redirectHandler/AuthCodeRedirectHandler.ts.html +0 -667
  41. package/coverage/lcov-report/src/login/oidc/redirectHandler/ErrorOidcHandler.ts.html +0 -283
  42. package/coverage/lcov-report/src/login/oidc/redirectHandler/FallbackRedirectHandler.ts.html +0 -265
  43. package/coverage/lcov-report/src/login/oidc/redirectHandler/index.html +0 -161
  44. package/coverage/lcov-report/src/login/oidc/refresh/TokenRefresher.ts.html +0 -385
  45. package/coverage/lcov-report/src/login/oidc/refresh/index.html +0 -116
  46. package/coverage/lcov-report/src/login/webid/WebIdLoginHandler.ts.html +0 -250
  47. package/coverage/lcov-report/src/login/webid/index.html +0 -116
  48. package/coverage/lcov-report/src/logout/GeneralLogoutHandler.ts.html +0 -220
  49. package/coverage/lcov-report/src/logout/index.html +0 -116
  50. package/coverage/lcov-report/src/sessionInfo/SessionInfoManager.ts.html +0 -775
  51. package/coverage/lcov-report/src/sessionInfo/index.html +0 -116
  52. package/coverage/lcov-report/src/storage/BrowserStorage.ts.html +0 -229
  53. package/coverage/lcov-report/src/storage/StorageUtility.ts.html +0 -214
  54. package/coverage/lcov-report/src/storage/index.html +0 -131
  55. package/coverage/lcov-report/src/util/UuidGenerator.ts.html +0 -226
  56. package/coverage/lcov-report/src/util/index.html +0 -131
  57. package/coverage/lcov-report/src/util/urlPath.ts.html +0 -208
  58. package/coverage/lcov.info +0 -1001
  59. package/dist/ClientAuthentication.js +0 -64
  60. package/dist/ClientAuthentication.js.map +0 -1
  61. package/dist/Session.js +0 -165
  62. package/dist/Session.js.map +0 -1
  63. package/dist/constant.js +0 -7
  64. package/dist/constant.js.map +0 -1
  65. package/dist/defaultSession.js +0 -48
  66. package/dist/defaultSession.js.map +0 -1
  67. package/dist/dependencies.js +0 -41
  68. package/dist/dependencies.js.map +0 -1
  69. package/dist/iframe.js +0 -43
  70. package/dist/iframe.js.map +0 -1
  71. package/dist/index.browser.d.ts +0 -1
  72. package/dist/index.browser.js +0 -28
  73. package/dist/index.browser.js.map +0 -1
  74. package/dist/login/AggregateLoginHandler.js +0 -10
  75. package/dist/login/AggregateLoginHandler.js.map +0 -1
  76. package/dist/login/oidc/AggregateOidcHandler.js +0 -10
  77. package/dist/login/oidc/AggregateOidcHandler.js.map +0 -1
  78. package/dist/login/oidc/ClientRegistrar.js +0 -51
  79. package/dist/login/oidc/ClientRegistrar.js.map +0 -1
  80. package/dist/login/oidc/IssuerConfigFetcher.js +0 -124
  81. package/dist/login/oidc/IssuerConfigFetcher.js.map +0 -1
  82. package/dist/login/oidc/OidcLoginHandler.js +0 -40
  83. package/dist/login/oidc/OidcLoginHandler.js.map +0 -1
  84. package/dist/login/oidc/Redirector.js +0 -21
  85. package/dist/login/oidc/Redirector.js.map +0 -1
  86. package/dist/login/oidc/__mocks__/IOidcOptions.d.ts +0 -2
  87. package/dist/login/oidc/__mocks__/IOidcOptions.js +0 -25
  88. package/dist/login/oidc/__mocks__/IOidcOptions.js.map +0 -1
  89. package/dist/login/oidc/oidcHandlers/AuthorizationCodeWithPkceOidcHandler.js +0 -56
  90. package/dist/login/oidc/oidcHandlers/AuthorizationCodeWithPkceOidcHandler.js.map +0 -1
  91. package/dist/login/oidc/oidcHandlers/OidcHandlerCanHandleTest.js +0 -47
  92. package/dist/login/oidc/oidcHandlers/OidcHandlerCanHandleTest.js.map +0 -1
  93. package/dist/login/oidc/redirectHandler/AggregateRedirectHandler.js +0 -10
  94. package/dist/login/oidc/redirectHandler/AggregateRedirectHandler.js.map +0 -1
  95. package/dist/login/oidc/redirectHandler/AuthCodeRedirectHandler.js +0 -92
  96. package/dist/login/oidc/redirectHandler/AuthCodeRedirectHandler.js.map +0 -1
  97. package/dist/login/oidc/redirectHandler/ErrorOidcHandler.js +0 -26
  98. package/dist/login/oidc/redirectHandler/ErrorOidcHandler.js.map +0 -1
  99. package/dist/login/oidc/redirectHandler/FallbackRedirectHandler.js +0 -20
  100. package/dist/login/oidc/redirectHandler/FallbackRedirectHandler.js.map +0 -1
  101. package/dist/login/oidc/refresh/TokenRefresher.js +0 -31
  102. package/dist/login/oidc/refresh/TokenRefresher.js.map +0 -1
  103. package/dist/login/webid/WebIdLoginHandler.js +0 -12
  104. package/dist/login/webid/WebIdLoginHandler.js.map +0 -1
  105. package/dist/logout/GeneralLogoutHandler.js +0 -15
  106. package/dist/logout/GeneralLogoutHandler.js.map +0 -1
  107. package/dist/sessionInfo/SessionInfoManager.js +0 -95
  108. package/dist/sessionInfo/SessionInfoManager.js.map +0 -1
  109. package/dist/solid-client-authn.bundle.js.LICENSE.txt +0 -17
  110. package/dist/storage/BrowserStorage.js +0 -18
  111. package/dist/storage/BrowserStorage.js.map +0 -1
  112. package/dist/storage/StorageUtility.js +0 -10
  113. package/dist/storage/StorageUtility.js.map +0 -1
  114. package/dist/util/UuidGenerator.js +0 -10
  115. package/dist/util/UuidGenerator.js.map +0 -1
  116. package/dist/util/urlPath.js +0 -11
  117. package/dist/util/urlPath.js.map +0 -1
  118. package/docs/api/Makefile +0 -76
  119. package/docs/api/README.md +0 -46
  120. package/docs/api/build/docs-assets/README.md +0 -183
  121. package/docs/api/build/docs-assets/_static/css/inrupt.css +0 -349
  122. package/docs/api/build/docs-assets/_templates/breadcrumb-navigation.html +0 -10
  123. package/docs/api/build/docs-assets/_templates/copyright.html +0 -3
  124. package/docs/api/build/docs-assets/_templates/docs-sidebar.html +0 -32
  125. package/docs/api/build/docs-assets/_templates/docs-version-selector.html +0 -21
  126. package/docs/api/build/docs-assets/_templates/jira-feedback.html +0 -21
  127. package/docs/api/build/docs-assets/_templates/layout.html +0 -34
  128. package/docs/api/build/docs-assets/_templates/matomo.html +0 -18
  129. package/docs/api/build/docs-assets/_templates/navbar-logo.html +0 -5
  130. package/docs/api/build/docs-assets/_templates/navbar-nav.html +0 -44
  131. package/docs/api/build/docs-assets/_templates/prev-next.html +0 -19
  132. package/docs/api/build/docs-assets/_templates/versioned-canonical.html +0 -8
  133. package/docs/api/build/docs-assets/themes/inrupt/theme.conf +0 -18
  134. package/docs/api/build/doctrees/classes/ConfigurationError.doctree +0 -0
  135. package/docs/api/build/doctrees/classes/InMemoryStorage.doctree +0 -0
  136. package/docs/api/build/doctrees/classes/NotImplementedError.doctree +0 -0
  137. package/docs/api/build/doctrees/classes/Session.doctree +0 -0
  138. package/docs/api/build/doctrees/environment.pickle +0 -0
  139. package/docs/api/build/doctrees/functions.doctree +0 -0
  140. package/docs/api/build/doctrees/index.doctree +0 -0
  141. package/docs/api/build/doctrees/interfaces/ILoginInputOptions.doctree +0 -0
  142. package/docs/api/build/doctrees/interfaces/ISessionInfo.doctree +0 -0
  143. package/docs/api/build/doctrees/interfaces/ISessionOptions.doctree +0 -0
  144. package/docs/api/build/doctrees/interfaces/IStorage.doctree +0 -0
  145. package/docs/api/build/html/.buildinfo +0 -4
  146. package/docs/api/build/html/_static/basic.css +0 -905
  147. package/docs/api/build/html/_static/css/blank.css +0 -2
  148. package/docs/api/build/html/_static/css/index.ff1ffe594081f20da1ef19478df9384b.css +0 -6
  149. package/docs/api/build/html/_static/css/inrupt.css +0 -349
  150. package/docs/api/build/html/_static/css/theme.css +0 -120
  151. package/docs/api/build/html/_static/doctools.js +0 -323
  152. package/docs/api/build/html/_static/documentation_options.js +0 -12
  153. package/docs/api/build/html/_static/file.png +0 -0
  154. package/docs/api/build/html/_static/jquery-3.5.1.js +0 -10872
  155. package/docs/api/build/html/_static/jquery.js +0 -2
  156. package/docs/api/build/html/_static/js/index.be7d3bbb2ef33a8344ce.js +0 -32
  157. package/docs/api/build/html/_static/language_data.js +0 -297
  158. package/docs/api/build/html/_static/minus.png +0 -0
  159. package/docs/api/build/html/_static/plus.png +0 -0
  160. package/docs/api/build/html/_static/pygments.css +0 -74
  161. package/docs/api/build/html/_static/searchtools.js +0 -529
  162. package/docs/api/build/html/_static/underscore-1.13.1.js +0 -2042
  163. package/docs/api/build/html/_static/underscore.js +0 -6
  164. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/LICENSE.txt +0 -34
  165. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/css/all.min.css +0 -5
  166. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.eot +0 -0
  167. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.svg +0 -3570
  168. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.ttf +0 -0
  169. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff +0 -0
  170. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2 +0 -0
  171. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.eot +0 -0
  172. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.svg +0 -803
  173. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.ttf +0 -0
  174. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff +0 -0
  175. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff2 +0 -0
  176. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.eot +0 -0
  177. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.svg +0 -4938
  178. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.ttf +0 -0
  179. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff +0 -0
  180. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2 +0 -0
  181. package/docs/api/build/html/_static/webpack-macros.html +0 -25
  182. package/docs/api/build/html/classes/ConfigurationError.html +0 -726
  183. package/docs/api/build/html/classes/InMemoryStorage.html +0 -636
  184. package/docs/api/build/html/classes/NotImplementedError.html +0 -726
  185. package/docs/api/build/html/classes/Session.html +0 -2428
  186. package/docs/api/build/html/functions.html +0 -834
  187. package/docs/api/build/html/genindex.html +0 -311
  188. package/docs/api/build/html/index.html +0 -342
  189. package/docs/api/build/html/interfaces/ILoginInputOptions.html +0 -595
  190. package/docs/api/build/html/interfaces/ISessionInfo.html +0 -481
  191. package/docs/api/build/html/interfaces/ISessionOptions.html +0 -463
  192. package/docs/api/build/html/interfaces/IStorage.html +0 -531
  193. package/docs/api/build/html/objects.inv +0 -0
  194. package/docs/api/build/html/search.html +0 -340
  195. package/docs/api/build/html/searchindex.js +0 -1
  196. package/docs/api/build/source/classes/ConfigurationError.md +0 -159
  197. package/docs/api/build/source/classes/InMemoryStorage.md +0 -112
  198. package/docs/api/build/source/classes/NotImplementedError.md +0 -159
  199. package/docs/api/build/source/classes/Session.md +0 -907
  200. package/docs/api/build/source/functions.md +0 -235
  201. package/docs/api/build/source/index.rst +0 -13
  202. package/docs/api/build/source/interfaces/ILoginInputOptions.md +0 -109
  203. package/docs/api/build/source/interfaces/ISessionInfo.md +0 -63
  204. package/docs/api/build/source/interfaces/ISessionOptions.md +0 -60
  205. package/docs/api/build/source/interfaces/IStorage.md +0 -76
  206. package/docs/api/conf.py +0 -135
  207. package/docs/api/redirects.txt +0 -41
  208. package/docs/api/requirements.txt +0 -5
  209. package/docs/api/source/api/.nojekyll +0 -1
  210. package/docs/api/source/api/classes/ConfigurationError.md +0 -163
  211. package/docs/api/source/api/classes/InMemoryStorage.md +0 -112
  212. package/docs/api/source/api/classes/NotImplementedError.md +0 -163
  213. package/docs/api/source/api/classes/Session.md +0 -1426
  214. package/docs/api/source/api/index.md +0 -251
  215. package/docs/api/source/api/interfaces/ILoginInputOptions.md +0 -109
  216. package/docs/api/source/api/interfaces/ISessionInfo.md +0 -63
  217. package/docs/api/source/api/interfaces/ISessionOptions.md +0 -60
  218. package/docs/api/source/api/interfaces/IStorage.md +0 -76
  219. package/docs/api/source/functions.md +0 -3
  220. package/docs/api/source/index.rst +0 -13
  221. package/examples/demoAuthentiationMonitor/index.js +0 -34
  222. package/examples/demoAuthentiationMonitor/package-lock.json +0 -916
  223. package/examples/demoAuthentiationMonitor/package.json +0 -15
  224. package/examples/demoClientApp/.babelrc +0 -3
  225. package/examples/demoClientApp/package-lock.json +0 -11710
  226. package/examples/demoClientApp/package.json +0 -37
  227. package/examples/demoClientApp/src/DemoClientApp.js +0 -686
  228. package/examples/demoClientApp/src/index.html +0 -142
  229. package/examples/demoClientApp/src/index.js +0 -26
  230. package/examples/demoClientApp/webpack.config.js +0 -39
  231. package/examples/single/bundle/.babelrc +0 -3
  232. package/examples/single/bundle/README.md +0 -11
  233. package/examples/single/bundle/client-app-profile.ttl +0 -10
  234. package/examples/single/bundle/package-lock.json +0 -11196
  235. package/examples/single/bundle/package.json +0 -31
  236. package/examples/single/bundle/src/App.js +0 -123
  237. package/examples/single/bundle/src/index.html +0 -10
  238. package/examples/single/bundle/src/index.js +0 -26
  239. package/examples/single/bundle/webpack.config.js +0 -33
  240. package/examples/single/script/README.md +0 -11
  241. package/examples/single/script/index.html +0 -36
  242. package/examples/single/script/package-lock.json +0 -1293
  243. package/examples/single/script/package.json +0 -20
  244. package/examples/single/script/server.ts +0 -18
  245. package/jest.config.js +0 -10
  246. package/licenses.csv +0 -147
  247. package/rollup.config.js +0 -54
  248. package/sampleFlows/SolidAuthClientArchitecture.png +0 -0
  249. package/sampleFlows/authorization-code-with-pkce.png +0 -0
  250. package/sampleFlows/authorization-code-with-pkce.seqdiag +0 -46
  251. package/sampleFlows/authorization-code.png +0 -0
  252. package/sampleFlows/authorization-code.seqdiag +0 -50
  253. package/sampleFlows/client-credentials.png +0 -0
  254. package/sampleFlows/client-credentials.seqdiag +0 -38
  255. package/sampleFlows/legacy-implicit-flow.png +0 -0
  256. package/sampleFlows/legacy-implicit-flow.seqdiag +0 -43
  257. package/sampleFlows/self-signed.png +0 -0
  258. package/sampleFlows/self-signed.seqdiag +0 -49
  259. package/sampleFlows/signatory-access-control.seqdiag +0 -36
  260. package/sampleFlows/signatory-access-control.svg +0 -1
  261. package/tsconfig.eslint.json +0 -6
  262. package/tsconfig.json +0 -17
package/docs/api/build/html/functions.html DELETED
@@ -1,834 +0,0 @@
1
-
2
- <!DOCTYPE html>
3
-
4
- <html>
5
- <head>
6
- <meta charset="utf-8" />
7
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
8
- <title>Functions &#8212; Inrupt solid-client-authn-browser API Documentation</title>
9
-
10
- <link href="_static/css/theme.css" rel="stylesheet">
11
- <link href="_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
12
-
13
-
14
- <link rel="stylesheet"
15
- href="_static/vendor/fontawesome/5.13.0/css/all.min.css">
16
- <link rel="preload" as="font" type="font/woff2" crossorigin
17
- href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
18
- <link rel="preload" as="font" type="font/woff2" crossorigin
19
- href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
20
-
21
-
22
-
23
-
24
-
25
- <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
26
- <link rel="stylesheet" type="text/css" href="_static/css/blank.css" />
27
- <link rel="stylesheet" href="_static/css/inrupt.css" type="text/css" />
28
-
29
- <link rel="preload" as="script" href="_static/js/index.be7d3bbb2ef33a8344ce.js">
30
-
31
- <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
32
- <script src="_static/jquery.js"></script>
33
- <script src="_static/underscore.js"></script>
34
- <script src="_static/doctools.js"></script>
35
- <link rel="index" title="Index" href="genindex.html" />
36
- <link rel="search" title="Search" href="search.html" />
37
- <link rel="next" title="Interface: ILoginInputOptions" href="interfaces/ILoginInputOptions.html" />
38
- <link rel="prev" title="Class: Session" href="classes/Session.html" />
39
-
40
- <meta name="robots" content="index" />
41
-
42
-
43
-
44
- <meta name="viewport" content="width=device-width, initial-scale=1" />
45
- <meta name="docsearch:language" content="None">
46
-
47
-
48
- <link rel="icon" sizes="16x16" href="https://docs.inrupt.com/inrupt_stickers_v2-03.png">
49
-
50
-
51
-
52
- <!-- Google Analytics -->
53
-
54
-
55
- <script type="text/javascript"
56
- src="https://inrupt.atlassian.net/s/d41d8cd98f00b204e9800998ecf8427e-T/-egccmf/b/24/a44af77267a987a660377e5c46e0fb64/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector.js?locale=en-US&collectorId=41592d74"></script>
57
- <script type="text/javascript">
58
- window.ATL_JQ_PAGE_PROPS = $.extend(window.ATL_JQ_PAGE_PROPS, {
59
- fieldValues: {
60
- description: 'On page: https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-browser/functions/ \n'
61
- }
62
- });
63
- </script>
64
-
65
- <!-- Matomo -->
66
- <script type="text/javascript">
67
- var _paq = window._paq = window._paq || [];
68
- /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
69
- _paq.push(['trackPageView']);
70
- _paq.push(['enableLinkTracking']);
71
- (function () {
72
- if (navigator.doNotTrack && navigator.doNotTrack === "1") {
73
- return;
74
- }
75
- var u = "https://inrupt.matomo.cloud/";
76
- _paq.push(['setTrackerUrl', u + 'matomo.php']);
77
- _paq.push(['setSiteId', '3']);
78
- var d = document, g = d.createElement('script'), s = d.getElementsByTagName('script')[0];
79
- g.type = 'text/javascript'; g.async = true; g.src = '//cdn.matomo.cloud/inrupt.matomo.cloud/matomo.js'; s.parentNode.insertBefore(g, s);
80
- })();
81
- </script>
82
- <!-- End Matomo Code -->
83
-
84
-
85
- </head>
86
- <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
87
-
88
- <div class="container-fluid" id="banner"></div>
89
-
90
-
91
- <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="container-xl">
92
-
93
- <div id="navbar-start">
94
-
95
- <!-- Override navbar-logo -->
96
-
97
- <a class="navbar-brand" href="https://inrupt.com/">
98
- <img src="https://docs.inrupt.com/inrupt-logo-small.svg" class="logo" alt="Inrupt logo">
99
- </a>
100
-
101
- </div>
102
-
103
- <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
104
- <span class="navbar-toggler-icon"></span>
105
- </button>
106
-
107
-
108
- <div id="navbar-collapsible" class=" collapse navbar-collapse">
109
- <div id="navbar-center" class="mr-auto">
110
-
111
- <div class="navbar-center-item">
112
- <!-- Override navbar-nav -->
113
-
114
- <ul id="navbar-main-elements" class="navbar-nav mr-auto">
115
- <li class="nav-item">
116
- <a class="nav-link" href="https://docs.inrupt.com/">Docs Home</a>
117
- </li>
118
- <li class="nav-item">
119
- <a class="nav-link" href="https://docs.inrupt.com/ess/latest/">Enterprise Solid Server</a>
120
- </li>
121
- <li class="nav-item"><a class="nav-link" href="#">Developer Tools</a>
122
- <ul class="nav-children">
123
- <li class="nav-item nav-childitem">
124
- <a href="https://docs.inrupt.com/developer-tools/javascript/client-libraries/">JavaScript Client Libraries</a>
125
- </li>
126
- <li class="nav-item nav-childitem">
127
- <a href="https://docs.inrupt.com/developer-tools/javascript/react-sdk/">Solid React SDK</a>
128
- </li>
129
- </ul>
130
- </li>
131
- <li class="nav-item">
132
- <a class="nav-link" href="https://docs.inrupt.com/user-interface/podbrowser/">PodBrowser</a>
133
- </li>
134
- <li class="nav-item">
135
- <a class="nav-link" href="https://docs.inrupt.com/pod-spaces/">Pod Spaces</a>
136
- </li>
137
- <li class="nav-item"><a class="nav-link" href="#">API</a>
138
- <ul class="nav-children">
139
- <li class="nav-item nav-childitem">
140
- <a href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client/" >solid-client (JS)</a>
141
- </li>
142
- <li class="nav-item nav-childitem">
143
- <a href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-browser/" >solid-client-authn-browser (JS)</a>
144
- </li>
145
- <li class="nav-item nav-childitem">
146
- <a href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-node/">solid-client-authn-node (JS)</a>
147
- </li>
148
- <li class="nav-item nav-childitem">
149
- <a href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client-notifications/">solid-client-notifications (JS)</a>
150
- </li>
151
- </ul>
152
- </li></ul>
153
- </div>
154
-
155
- </div>
156
-
157
- <div id="navbar-end">
158
-
159
- <div class="navbar-end-item">
160
- <ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
161
- <li class="nav-item">
162
- <a class="nav-link" href="https://twitter.com/inrupt" rel="noopener" target="_blank" title="Inrupt on Twitter">
163
- <span><i class="fab fa-twitter-square"></i></span>
164
- <label class="sr-only">Inrupt on Twitter</label>
165
- </a>
166
- </li>
167
- <li class="nav-item">
168
- <a class="nav-link" href="https://www.linkedin.com/company/inrupt/" rel="noopener" target="_blank" title="Inrupt on LinkedIn">
169
- <span><i class="fab fa-linkedin"></i></span>
170
- <label class="sr-only">Inrupt on LinkedIn</label>
171
- </a>
172
- </li>
173
- <li class="nav-item">
174
- <a class="nav-link" href="https://forum.solidproject.org/" rel="noopener" target="_blank" title="Solid forum">
175
- <span><i class="fas fa-users"></i></span>
176
- <label class="sr-only">Solid forum</label>
177
- </a>
178
- </li>
179
- </ul>
180
- </div>
181
-
182
- </div>
183
- </div>
184
- </div>
185
- </nav>
186
-
187
-
188
- <div class="container-xl">
189
- <div class="row">
190
-
191
-
192
- <!-- Only show if we have sidebars configured, else just a small margin -->
193
- <div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="search.html" method="get">
194
- <i class="icon fas fa-search"></i>
195
- <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
196
- </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
197
- <div class="bd-toc-item active">
198
- <p class="caption">
199
- <a class="reference internal" href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-browser">Inrupt solid-client-authn-browser API</a>
200
- </p>
201
-
202
-
203
- <ul class="current nav bd-sidenav">
204
- <li class="toctree-l1">
205
- <a class="reference internal" href="classes/ConfigurationError.html">
206
- Class: ConfigurationError
207
- </a>
208
- </li>
209
- <li class="toctree-l1">
210
- <a class="reference internal" href="classes/InMemoryStorage.html">
211
- Class: InMemoryStorage
212
- </a>
213
- </li>
214
- <li class="toctree-l1">
215
- <a class="reference internal" href="classes/NotImplementedError.html">
216
- Class: NotImplementedError
217
- </a>
218
- </li>
219
- <li class="toctree-l1">
220
- <a class="reference internal" href="classes/Session.html">
221
- Class: Session
222
- </a>
223
- </li>
224
- <li class="toctree-l1 current active">
225
- <a class="current reference internal" href="#">
226
- Functions
227
- </a>
228
- </li>
229
- <li class="toctree-l1">
230
- <a class="reference internal" href="interfaces/ILoginInputOptions.html">
231
- Interface: ILoginInputOptions
232
- </a>
233
- </li>
234
- <li class="toctree-l1">
235
- <a class="reference internal" href="interfaces/ISessionInfo.html">
236
- Interface: ISessionInfo
237
- </a>
238
- </li>
239
- <li class="toctree-l1">
240
- <a class="reference internal" href="interfaces/ISessionOptions.html">
241
- Interface: ISessionOptions
242
- </a>
243
- </li>
244
- <li class="toctree-l1">
245
- <a class="reference internal" href="interfaces/IStorage.html">
246
- Interface: IStorage
247
- </a>
248
- </li>
249
- </ul>
250
-
251
- </div>
252
- </nav>
253
- </div>
254
-
255
-
256
-
257
-
258
- <div class="d-none d-xl-block col-xl-2 bd-toc">
259
-
260
-
261
- <div class="toc-item">
262
-
263
- <div class="tocsection onthispage pt-5 pb-3">
264
- <i class="fas fa-list"></i> On this page
265
- </div>
266
-
267
- <nav id="bd-toc-nav">
268
- <ul class="visible nav section-nav flex-column">
269
- <li class="toc-h2 nav-item toc-entry">
270
- <a class="reference internal nav-link" href="#table-of-contents">
271
- Table of contents
272
- </a>
273
- <ul class="nav section-nav flex-column">
274
- <li class="toc-h3 nav-item toc-entry">
275
- <a class="reference internal nav-link" href="#id1">
276
- Functions
277
- </a>
278
- </li>
279
- </ul>
280
- </li>
281
- <li class="toc-h2 nav-item toc-entry">
282
- <a class="reference internal nav-link" href="#id2">
283
- Functions
284
- </a>
285
- <ul class="nav section-nav flex-column">
286
- <li class="toc-h3 nav-item toc-entry">
287
- <a class="reference internal nav-link" href="#fetch">
288
- fetch
289
- </a>
290
- <ul class="nav section-nav flex-column">
291
- <li class="toc-h4 nav-item toc-entry">
292
- <a class="reference internal nav-link" href="#parameters">
293
- Parameters
294
- </a>
295
- </li>
296
- <li class="toc-h4 nav-item toc-entry">
297
- <a class="reference internal nav-link" href="#returns">
298
- Returns
299
- </a>
300
- </li>
301
- <li class="toc-h4 nav-item toc-entry">
302
- <a class="reference internal nav-link" href="#defined-in">
303
- Defined in
304
- </a>
305
- </li>
306
- </ul>
307
- </li>
308
- <li class="toc-h3 nav-item toc-entry">
309
- <a class="reference internal nav-link" href="#getclientauthenticationwithdependencies">
310
- getClientAuthenticationWithDependencies
311
- </a>
312
- <ul class="nav section-nav flex-column">
313
- <li class="toc-h4 nav-item toc-entry">
314
- <a class="reference internal nav-link" href="#id3">
315
- Parameters
316
- </a>
317
- </li>
318
- <li class="toc-h4 nav-item toc-entry">
319
- <a class="reference internal nav-link" href="#id4">
320
- Returns
321
- </a>
322
- </li>
323
- <li class="toc-h4 nav-item toc-entry">
324
- <a class="reference internal nav-link" href="#id5">
325
- Defined in
326
- </a>
327
- </li>
328
- </ul>
329
- </li>
330
- <li class="toc-h3 nav-item toc-entry">
331
- <a class="reference internal nav-link" href="#getdefaultsession">
332
- getDefaultSession
333
- </a>
334
- <ul class="nav section-nav flex-column">
335
- <li class="toc-h4 nav-item toc-entry">
336
- <a class="reference internal nav-link" href="#id6">
337
- Returns
338
- </a>
339
- </li>
340
- <li class="toc-h4 nav-item toc-entry">
341
- <a class="reference internal nav-link" href="#id7">
342
- Defined in
343
- </a>
344
- </li>
345
- </ul>
346
- </li>
347
- <li class="toc-h3 nav-item toc-entry">
348
- <a class="reference internal nav-link" href="#handleincomingredirect">
349
- handleIncomingRedirect
350
- </a>
351
- <ul class="nav section-nav flex-column">
352
- <li class="toc-h4 nav-item toc-entry">
353
- <a class="reference internal nav-link" href="#id8">
354
- Parameters
355
- </a>
356
- </li>
357
- <li class="toc-h4 nav-item toc-entry">
358
- <a class="reference internal nav-link" href="#id9">
359
- Returns
360
- </a>
361
- </li>
362
- <li class="toc-h4 nav-item toc-entry">
363
- <a class="reference internal nav-link" href="#id10">
364
- Defined in
365
- </a>
366
- </li>
367
- </ul>
368
- </li>
369
- <li class="toc-h3 nav-item toc-entry">
370
- <a class="reference internal nav-link" href="#login">
371
- login
372
- </a>
373
- <ul class="nav section-nav flex-column">
374
- <li class="toc-h4 nav-item toc-entry">
375
- <a class="reference internal nav-link" href="#id11">
376
- Parameters
377
- </a>
378
- </li>
379
- <li class="toc-h4 nav-item toc-entry">
380
- <a class="reference internal nav-link" href="#id12">
381
- Returns
382
- </a>
383
- </li>
384
- <li class="toc-h4 nav-item toc-entry">
385
- <a class="reference internal nav-link" href="#id13">
386
- Defined in
387
- </a>
388
- </li>
389
- </ul>
390
- </li>
391
- <li class="toc-h3 nav-item toc-entry">
392
- <a class="reference internal nav-link" href="#logout">
393
- logout
394
- </a>
395
- <ul class="nav section-nav flex-column">
396
- <li class="toc-h4 nav-item toc-entry">
397
- <a class="reference internal nav-link" href="#id14">
398
- Returns
399
- </a>
400
- </li>
401
- <li class="toc-h4 nav-item toc-entry">
402
- <a class="reference internal nav-link" href="#id15">
403
- Defined in
404
- </a>
405
- </li>
406
- </ul>
407
- </li>
408
- <li class="toc-h3 nav-item toc-entry">
409
- <a class="reference internal nav-link" href="#onlogin">
410
- onLogin
411
- </a>
412
- <ul class="nav section-nav flex-column">
413
- <li class="toc-h4 nav-item toc-entry">
414
- <a class="reference internal nav-link" href="#id16">
415
- Parameters
416
- </a>
417
- </li>
418
- <li class="toc-h4 nav-item toc-entry">
419
- <a class="reference internal nav-link" href="#id17">
420
- Returns
421
- </a>
422
- </li>
423
- <li class="toc-h4 nav-item toc-entry">
424
- <a class="reference internal nav-link" href="#id18">
425
- Defined in
426
- </a>
427
- </li>
428
- </ul>
429
- </li>
430
- <li class="toc-h3 nav-item toc-entry">
431
- <a class="reference internal nav-link" href="#onlogout">
432
- onLogout
433
- </a>
434
- <ul class="nav section-nav flex-column">
435
- <li class="toc-h4 nav-item toc-entry">
436
- <a class="reference internal nav-link" href="#id19">
437
- Parameters
438
- </a>
439
- </li>
440
- <li class="toc-h4 nav-item toc-entry">
441
- <a class="reference internal nav-link" href="#id20">
442
- Returns
443
- </a>
444
- </li>
445
- <li class="toc-h4 nav-item toc-entry">
446
- <a class="reference internal nav-link" href="#id21">
447
- Defined in
448
- </a>
449
- </li>
450
- </ul>
451
- </li>
452
- <li class="toc-h3 nav-item toc-entry">
453
- <a class="reference internal nav-link" href="#onsessionrestore">
454
- onSessionRestore
455
- </a>
456
- <ul class="nav section-nav flex-column">
457
- <li class="toc-h4 nav-item toc-entry">
458
- <a class="reference internal nav-link" href="#id22">
459
- Parameters
460
- </a>
461
- </li>
462
- <li class="toc-h4 nav-item toc-entry">
463
- <a class="reference internal nav-link" href="#id23">
464
- Returns
465
- </a>
466
- </li>
467
- <li class="toc-h4 nav-item toc-entry">
468
- <a class="reference internal nav-link" href="#id24">
469
- Defined in
470
- </a>
471
- </li>
472
- </ul>
473
- </li>
474
- </ul>
475
- </li>
476
- </ul>
477
-
478
- </nav>
479
- </div>
480
-
481
- <div class="toc-item">
482
-
483
- </div>
484
-
485
-
486
- </div>
487
-
488
-
489
-
490
-
491
-
492
-
493
- <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
494
-
495
-
496
- <div class="related">
497
-
498
- </div>
499
-
500
-
501
- <div>
502
-
503
- <div class="tex2jax_ignore mathjax_ignore section" id="functions">
504
- <h1>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h1>
505
- <div class="section" id="table-of-contents">
506
- <h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h2>
507
- <div class="section" id="id1">
508
- <h3>Functions<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
509
- <ul class="simple">
510
- <li><p><a class="reference external" href="functions.html#fetch">fetch</a></p></li>
511
- <li><p><a class="reference external" href="functions.html#getclientauthenticationwithdependencies">getClientAuthenticationWithDependencies</a></p></li>
512
- <li><p><a class="reference external" href="functions.html#getdefaultsession">getDefaultSession</a></p></li>
513
- <li><p><a class="reference external" href="functions.html#handleincomingredirect">handleIncomingRedirect</a></p></li>
514
- <li><p><a class="reference external" href="functions.html#login">login</a></p></li>
515
- <li><p><a class="reference external" href="functions.html#logout">logout</a></p></li>
516
- <li><p><a class="reference external" href="functions.html#onlogin">onLogin</a></p></li>
517
- <li><p><a class="reference external" href="functions.html#onlogout">onLogout</a></p></li>
518
- <li><p><a class="reference external" href="functions.html#onsessionrestore">onSessionRestore</a></p></li>
519
- </ul>
520
- </div>
521
- </div>
522
- <div class="section" id="id2">
523
- <h2>Functions<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
524
- <div class="section" id="fetch">
525
- <h3>fetch<a class="headerlink" href="#fetch" title="Permalink to this headline">¶</a></h3>
526
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Const</span></code> <strong>fetch</strong>(<code class="docutils literal notranslate"><span class="pre">url</span></code>, <code class="docutils literal notranslate"><span class="pre">init?</span></code>): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">Response</span></code>&gt;</p>
527
- <p>This function’s signature is equal to <code class="docutils literal notranslate"><span class="pre">window.fetch</span></code>, but if the current user is authenticated
528
- (see <a class="reference external" href="classes/Session.html#login">login</a> and <a class="reference external" href="classes/Session.html#handleincomingredirect">handleIncomingRedirect</a>), requests made using it will include that user’s
529
- credentials. If not, this will behave just like the regular <code class="docutils literal notranslate"><span class="pre">window.fetch</span></code>.</p>
530
- <p><strong><code class="docutils literal notranslate"><span class="pre">see</span></code></strong> <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch">https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch</a></p>
531
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.3.0</p>
532
- <div class="section" id="parameters">
533
- <h4>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h4>
534
- <table class="colwidths-auto table">
535
- <thead>
536
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
537
- <th class="text-align:left head"><p>Type</p></th>
538
- </tr>
539
- </thead>
540
- <tbody>
541
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">url</span></code></p></td>
542
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">RequestInfo</span></code></p></td>
543
- </tr>
544
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">init?</span></code></p></td>
545
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">RequestInit</span></code></p></td>
546
- </tr>
547
- </tbody>
548
- </table>
549
- </div>
550
- <div class="section" id="returns">
551
- <h4>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">¶</a></h4>
552
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">Response</span></code>&gt;</p>
553
- </div>
554
- <div class="section" id="defined-in">
555
- <h4>Defined in<a class="headerlink" href="#defined-in" title="Permalink to this headline">¶</a></h4>
556
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/defaultSession.ts#L51">browser/src/defaultSession.ts:51</a></p>
557
- </div>
558
- </div>
559
- <hr class="docutils" />
560
- <div class="section" id="getclientauthenticationwithdependencies">
561
- <h3>getClientAuthenticationWithDependencies<a class="headerlink" href="#getclientauthenticationwithdependencies" title="Permalink to this headline">¶</a></h3>
562
- <p>▸ <strong>getClientAuthenticationWithDependencies</strong>(<code class="docutils literal notranslate"><span class="pre">dependencies</span></code>): <code class="docutils literal notranslate"><span class="pre">ClientAuthentication</span></code></p>
563
- <p><strong><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></strong> This function will be removed from the external API in an upcoming release.</p>
564
- <div class="section" id="id3">
565
- <h4>Parameters<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4>
566
- <table class="colwidths-auto table">
567
- <thead>
568
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
569
- <th class="text-align:left head"><p>Type</p></th>
570
- </tr>
571
- </thead>
572
- <tbody>
573
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">dependencies</span></code></p></td>
574
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">Object</span></code></p></td>
575
- </tr>
576
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">dependencies.insecureStorage?</span></code></p></td>
577
- <td class="text-align:left"><p><a class="reference internal" href="interfaces/IStorage.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">IStorage</span></code></span></a></p></td>
578
- </tr>
579
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">dependencies.secureStorage?</span></code></p></td>
580
- <td class="text-align:left"><p><a class="reference internal" href="interfaces/IStorage.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">IStorage</span></code></span></a></p></td>
581
- </tr>
582
- </tbody>
583
- </table>
584
- </div>
585
- <div class="section" id="id4">
586
- <h4>Returns<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h4>
587
- <p><code class="docutils literal notranslate"><span class="pre">ClientAuthentication</span></code></p>
588
- </div>
589
- <div class="section" id="id5">
590
- <h4>Defined in<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h4>
591
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/dependencies.ts#L52">browser/src/dependencies.ts:52</a></p>
592
- </div>
593
- </div>
594
- <hr class="docutils" />
595
- <div class="section" id="getdefaultsession">
596
- <h3>getDefaultSession<a class="headerlink" href="#getdefaultsession" title="Permalink to this headline">¶</a></h3>
597
- <p>▸ <strong>getDefaultSession</strong>(): <a class="reference internal" href="classes/Session.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
598
- <p>Obtain the <a class="reference internal" href="classes/Session.html"><span class="doc std std-doc">Session</span></a> used when not explicitly instantiating one yourself.</p>
599
- <p>When using the top-level exports <a class="reference external" href="classes/Session.html#fetch">fetch</a>, <a class="reference external" href="classes/Session.html#login">login</a>, <a class="reference external" href="classes/Session.html#logout">logout</a>,
600
- <a class="reference external" href="classes/Session.html#handleincomingredirect">handleIncomingRedirect</a>, <a class="reference external" href="classes/Session.html#onlogin">onLogin</a> and <a class="reference external" href="classes/Session.html#onlogout">onLogout</a>, these apply to an
601
- implicitly-instantiated <a class="reference internal" href="classes/Session.html"><span class="doc std std-doc">Session</span></a>.
602
- This function returns a reference to that Session in order to obtain e.g. the current user’s
603
- WebID.</p>
604
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.3.0</p>
605
- <div class="section" id="id6">
606
- <h4>Returns<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h4>
607
- <p><a class="reference internal" href="classes/Session.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
608
- </div>
609
- <div class="section" id="id7">
610
- <h4>Defined in<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h4>
611
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/defaultSession.ts#L36">browser/src/defaultSession.ts:36</a></p>
612
- </div>
613
- </div>
614
- <hr class="docutils" />
615
- <div class="section" id="handleincomingredirect">
616
- <h3>handleIncomingRedirect<a class="headerlink" href="#handleincomingredirect" title="Permalink to this headline">¶</a></h3>
617
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Const</span></code> <strong>handleIncomingRedirect</strong>(<code class="docutils literal notranslate"><span class="pre">inputOptions?</span></code>): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">undefined</span></code> | <a class="reference internal" href="interfaces/ISessionInfo.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">ISessionInfo</span></code></span></a>&gt;</p>
618
- <p>Completes the login process by processing the information provided by the Solid identity provider through redirect.</p>
619
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.3.0</p>
620
- <div class="section" id="id8">
621
- <h4>Parameters<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h4>
622
- <table class="colwidths-auto table">
623
- <thead>
624
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
625
- <th class="text-align:left head"><p>Type</p></th>
626
- </tr>
627
- </thead>
628
- <tbody>
629
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">inputOptions</span></code></p></td>
630
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">IHandleIncomingRedirectOptions</span></code></p></td>
631
- </tr>
632
- </tbody>
633
- </table>
634
- </div>
635
- <div class="section" id="id9">
636
- <h4>Returns<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h4>
637
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">undefined</span></code> | <a class="reference internal" href="interfaces/ISessionInfo.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">ISessionInfo</span></code></span></a>&gt;</p>
638
- </div>
639
- <div class="section" id="id10">
640
- <h4>Defined in<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h4>
641
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/defaultSession.ts#L85">browser/src/defaultSession.ts:85</a></p>
642
- </div>
643
- </div>
644
- <hr class="docutils" />
645
- <div class="section" id="login">
646
- <h3>login<a class="headerlink" href="#login" title="Permalink to this headline">¶</a></h3>
647
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Const</span></code> <strong>login</strong>(<code class="docutils literal notranslate"><span class="pre">options</span></code>): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">void</span></code>&gt;</p>
648
- <p>Triggers the login process. Note that this method will redirect the user away from your app.</p>
649
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.3.0</p>
650
- <div class="section" id="id11">
651
- <h4>Parameters<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h4>
652
- <table class="colwidths-auto table">
653
- <thead>
654
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
655
- <th class="text-align:left head"><p>Type</p></th>
656
- <th class="text-align:left head"><p>Description</p></th>
657
- </tr>
658
- </thead>
659
- <tbody>
660
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">options</span></code></p></td>
661
- <td class="text-align:left"><p><a class="reference internal" href="interfaces/ILoginInputOptions.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">ILoginInputOptions</span></code></span></a></p></td>
662
- <td class="text-align:left"><p>Parameter to customize the login behaviour. In particular, two options are mandatory: <code class="docutils literal notranslate"><span class="pre">options.oidcIssuer</span></code>, the user’s identity provider, and <code class="docutils literal notranslate"><span class="pre">options.redirectUrl</span></code>, the URL to which the user will be redirected after logging in their identity provider.</p></td>
663
- </tr>
664
- </tbody>
665
- </table>
666
- </div>
667
- <div class="section" id="id12">
668
- <h4>Returns<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h4>
669
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">void</span></code>&gt;</p>
670
- <p>This method should redirect the user away from the app: it does not return anything. The login process is completed by <a class="reference external" href="classes/Session.html#handleincomingredirect">handleIncomingRedirect</a>.</p>
671
- </div>
672
- <div class="section" id="id13">
673
- <h4>Defined in<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h4>
674
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/defaultSession.ts#L63">browser/src/defaultSession.ts:63</a></p>
675
- </div>
676
- </div>
677
- <hr class="docutils" />
678
- <div class="section" id="logout">
679
- <h3>logout<a class="headerlink" href="#logout" title="Permalink to this headline">¶</a></h3>
680
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Const</span></code> <strong>logout</strong>(): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">void</span></code>&gt;</p>
681
- <p>Logs the user out of the application. This does not log the user out of their
682
- Solid identity provider, and should not redirect the user away.</p>
683
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.3.0</p>
684
- <div class="section" id="id14">
685
- <h4>Returns<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h4>
686
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">void</span></code>&gt;</p>
687
- </div>
688
- <div class="section" id="id15">
689
- <h4>Defined in<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h4>
690
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/defaultSession.ts#L74">browser/src/defaultSession.ts:74</a></p>
691
- </div>
692
- </div>
693
- <hr class="docutils" />
694
- <div class="section" id="onlogin">
695
- <h3>onLogin<a class="headerlink" href="#onlogin" title="Permalink to this headline">¶</a></h3>
696
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Const</span></code> <strong>onLogin</strong>(<code class="docutils literal notranslate"><span class="pre">callback</span></code>): <code class="docutils literal notranslate"><span class="pre">void</span></code></p>
697
- <p>Register a callback function to be called when a user completes login.</p>
698
- <p>The callback is called when <a class="reference external" href="classes/Session.html#handleincomingredirect">handleIncomingRedirect</a> completes successfully.</p>
699
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.3.0</p>
700
- <div class="section" id="id16">
701
- <h4>Parameters<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h4>
702
- <table class="colwidths-auto table">
703
- <thead>
704
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
705
- <th class="text-align:left head"><p>Type</p></th>
706
- <th class="text-align:left head"><p>Description</p></th>
707
- </tr>
708
- </thead>
709
- <tbody>
710
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">callback</span></code></p></td>
711
- <td class="text-align:left"><p>() =&gt; <code class="docutils literal notranslate"><span class="pre">unknown</span></code></p></td>
712
- <td class="text-align:left"><p>The function called when a user completes login.</p></td>
713
- </tr>
714
- </tbody>
715
- </table>
716
- </div>
717
- <div class="section" id="id17">
718
- <h4>Returns<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h4>
719
- <p><code class="docutils literal notranslate"><span class="pre">void</span></code></p>
720
- </div>
721
- <div class="section" id="id18">
722
- <h4>Defined in<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h4>
723
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/defaultSession.ts#L100">browser/src/defaultSession.ts:100</a></p>
724
- </div>
725
- </div>
726
- <hr class="docutils" />
727
- <div class="section" id="onlogout">
728
- <h3>onLogout<a class="headerlink" href="#onlogout" title="Permalink to this headline">¶</a></h3>
729
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Const</span></code> <strong>onLogout</strong>(<code class="docutils literal notranslate"><span class="pre">callback</span></code>): <code class="docutils literal notranslate"><span class="pre">void</span></code></p>
730
- <p>Register a callback function to be called when a user logs out:</p>
731
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.3.0</p>
732
- <div class="section" id="id19">
733
- <h4>Parameters<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h4>
734
- <table class="colwidths-auto table">
735
- <thead>
736
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
737
- <th class="text-align:left head"><p>Type</p></th>
738
- <th class="text-align:left head"><p>Description</p></th>
739
- </tr>
740
- </thead>
741
- <tbody>
742
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">callback</span></code></p></td>
743
- <td class="text-align:left"><p>() =&gt; <code class="docutils literal notranslate"><span class="pre">unknown</span></code></p></td>
744
- <td class="text-align:left"><p>The function called when a user completes logout.</p></td>
745
- </tr>
746
- </tbody>
747
- </table>
748
- </div>
749
- <div class="section" id="id20">
750
- <h4>Returns<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h4>
751
- <p><code class="docutils literal notranslate"><span class="pre">void</span></code></p>
752
- </div>
753
- <div class="section" id="id21">
754
- <h4>Defined in<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h4>
755
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/defaultSession.ts#L111">browser/src/defaultSession.ts:111</a></p>
756
- </div>
757
- </div>
758
- <hr class="docutils" />
759
- <div class="section" id="onsessionrestore">
760
- <h3>onSessionRestore<a class="headerlink" href="#onsessionrestore" title="Permalink to this headline">¶</a></h3>
761
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Const</span></code> <strong>onSessionRestore</strong>(<code class="docutils literal notranslate"><span class="pre">callback</span></code>): <code class="docutils literal notranslate"><span class="pre">void</span></code></p>
762
- <p>Register a callback function to be called when a session is restored:</p>
763
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.3.0</p>
764
- <div class="section" id="id22">
765
- <h4>Parameters<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h4>
766
- <table class="colwidths-auto table">
767
- <thead>
768
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
769
- <th class="text-align:left head"><p>Type</p></th>
770
- <th class="text-align:left head"><p>Description</p></th>
771
- </tr>
772
- </thead>
773
- <tbody>
774
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">callback</span></code></p></td>
775
- <td class="text-align:left"><p>(<code class="docutils literal notranslate"><span class="pre">currentUrl</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code>) =&gt; <code class="docutils literal notranslate"><span class="pre">unknown</span></code></p></td>
776
- <td class="text-align:left"><p>The function called when a session is restored.</p></td>
777
- </tr>
778
- </tbody>
779
- </table>
780
- </div>
781
- <div class="section" id="id23">
782
- <h4>Returns<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h4>
783
- <p><code class="docutils literal notranslate"><span class="pre">void</span></code></p>
784
- </div>
785
- <div class="section" id="id24">
786
- <h4>Defined in<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h4>
787
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/defaultSession.ts#L122">browser/src/defaultSession.ts:122</a></p>
788
- </div>
789
- </div>
790
- </div>
791
- </div>
792
-
793
-
794
- </div>
795
-
796
-
797
-
798
-
799
- <!-- Previous / next buttons -->
800
- <div class='prev-next-area'>
801
- <a class='left-prev' id="prev-link" href="classes/Session.html" title="previous page">
802
- <i class="fas fa-angle-left"></i>
803
- <div class="prev-next-info">
804
- <p class="prev-next-title">Class: Session</p>
805
- </div>
806
- </a>
807
- <a class='right-next' id="next-link" href="interfaces/ILoginInputOptions.html" title="next page">
808
- <div class="prev-next-info">
809
- <p class="prev-next-title">Interface: ILoginInputOptions</p>
810
- </div>
811
- <i class="fas fa-angle-right"></i>
812
- </a>
813
- </div>
814
-
815
- </main>
816
-
817
-
818
- </div>
819
- </div>
820
-
821
- <script src="_static/js/index.be7d3bbb2ef33a8344ce.js"></script>
822
- <footer class="footer mt-5 mt-md-0">
823
- <div class="container">
824
-
825
- <div class="footer-item">
826
- <div class="container">
827
- <p>&copy; 2021 Inrupt Inc. </p>
828
- </div>
829
- </div>
830
-
831
- </div>
832
- </footer>
833
- </body>
834
- </html>