@kaapi/oauth2-auth-design 0.0.14 → 0.0.16

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 (246) hide show
  1. package/docs/.nojekyll +1 -0
  2. package/docs/assets/hierarchy.js +1 -0
  3. package/docs/assets/highlight.css +78 -0
  4. package/docs/assets/icons.js +18 -0
  5. package/docs/assets/icons.svg +1 -0
  6. package/docs/assets/main.js +60 -0
  7. package/docs/assets/navigation.js +1 -0
  8. package/docs/assets/search.js +1 -0
  9. package/docs/assets/style.css +1633 -0
  10. package/docs/classes/BearerToken.html +7 -0
  11. package/docs/classes/ClientSecretBasic.html +6 -0
  12. package/docs/classes/ClientSecretJwt.html +10 -0
  13. package/docs/classes/ClientSecretPost.html +6 -0
  14. package/docs/classes/DPoPToken.html +12 -0
  15. package/docs/classes/DefaultJWKSRoute.html +9 -0
  16. package/docs/classes/DefaultOAuth2ACAuthorizationRoute.html +28 -0
  17. package/docs/classes/DefaultOAuth2ACTokenRoute.html +10 -0
  18. package/docs/classes/DefaultOAuth2ClientCredentialsTokenRoute.html +10 -0
  19. package/docs/classes/DefaultOAuth2DeviceAuthTokenRoute.html +10 -0
  20. package/docs/classes/DefaultOAuth2DeviceAuthorizationRoute.html +11 -0
  21. package/docs/classes/DefaultOAuth2RefreshTokenRoute.html +10 -0
  22. package/docs/classes/InMemoryKeyStore.html +12 -0
  23. package/docs/classes/InMemoryReplayStore.html +5 -0
  24. package/docs/classes/JWKSRoute.html +7 -0
  25. package/docs/classes/JwksRotator.html +5 -0
  26. package/docs/classes/JwtAuthority.html +18 -0
  27. package/docs/classes/MultipleFlows.html +30 -0
  28. package/docs/classes/MultipleFlowsBuilder.html +15 -0
  29. package/docs/classes/NoneAuthMethod.html +6 -0
  30. package/docs/classes/OAuth2ACAuthorizationRoute.html +9 -0
  31. package/docs/classes/OAuth2ACTokenRoute.html +7 -0
  32. package/docs/classes/OAuth2AuthDesign.html +49 -0
  33. package/docs/classes/OAuth2AuthorizationCode.html +61 -0
  34. package/docs/classes/OAuth2AuthorizationCodeBuilder.html +30 -0
  35. package/docs/classes/OAuth2ClientCredentials.html +53 -0
  36. package/docs/classes/OAuth2ClientCredentialsBuilder.html +28 -0
  37. package/docs/classes/OAuth2ClientCredentialsTokenRoute.html +7 -0
  38. package/docs/classes/OAuth2DeviceAuthTokenRoute.html +7 -0
  39. package/docs/classes/OAuth2DeviceAuthorization.html +57 -0
  40. package/docs/classes/OAuth2DeviceAuthorizationBuilder.html +30 -0
  41. package/docs/classes/OAuth2DeviceAuthorizationRoute.html +7 -0
  42. package/docs/classes/OAuth2RefreshTokenRoute.html +7 -0
  43. package/docs/classes/OAuth2TokenResponse.html +25 -0
  44. package/docs/classes/OAuth2TokenRoute.html +6 -0
  45. package/docs/classes/OIDCAuthUtil.html +117 -0
  46. package/docs/classes/OIDCAuthorizationCode.html +63 -0
  47. package/docs/classes/OIDCAuthorizationCodeBuilder.html +32 -0
  48. package/docs/classes/OIDCClientCredentials.html +55 -0
  49. package/docs/classes/OIDCClientCredentialsBuilder.html +30 -0
  50. package/docs/classes/OIDCDeviceAuthorization.html +59 -0
  51. package/docs/classes/OIDCDeviceAuthorizationBuilder.html +32 -0
  52. package/docs/classes/PrivateKeyJwt.html +10 -0
  53. package/docs/enums/ClientSecretJwtAlgorithms.html +4 -0
  54. package/docs/enums/PrivateKeyJwtAlgorithms.html +11 -0
  55. package/docs/functions/createIdToken.html +1 -0
  56. package/docs/functions/createInMemoryKeyStore.html +1 -0
  57. package/docs/functions/createInMemoryReplayStore.html +1 -0
  58. package/docs/functions/createJwtAccessToken.html +1 -0
  59. package/docs/functions/createMatchAuthCodeResult.html +1 -0
  60. package/docs/functions/createMatchOAuth2ErrorCode.html +1 -0
  61. package/docs/functions/matchAuthCodeResult.html +1 -0
  62. package/docs/functions/sortTokenEndpointAuthMethods.html +1 -0
  63. package/docs/functions/verifyCodeVerifier.html +2 -0
  64. package/docs/functions/verifyJwt.html +1 -0
  65. package/docs/hierarchy.html +1 -0
  66. package/docs/index.html +2 -0
  67. package/docs/interfaces/ClientAuthMethod.html +6 -0
  68. package/docs/interfaces/DefaultOAuth2TokenRoute.html +8 -0
  69. package/docs/interfaces/IBearerToken.html +5 -0
  70. package/docs/interfaces/IDPoPToken.html +5 -0
  71. package/docs/interfaces/IJWKSRoute.html +3 -0
  72. package/docs/interfaces/IOAuth2ACAuthorizationRoute.html +4 -0
  73. package/docs/interfaces/IOAuth2DeviceAuthorizationRoute.html +3 -0
  74. package/docs/interfaces/IOAuth2TokenResponse.html +2 -0
  75. package/docs/interfaces/IOAuth2TokenRoute.html +3 -0
  76. package/docs/interfaces/JWKSParams.html +2 -0
  77. package/docs/interfaces/JwksKeyStore.html +9 -0
  78. package/docs/interfaces/JwksRotationTimestampStore.html +3 -0
  79. package/docs/interfaces/JwksRotatorOptions.html +5 -0
  80. package/docs/interfaces/KeyGenerator.html +2 -0
  81. package/docs/interfaces/MultipleFlowsArg.html +7 -0
  82. package/docs/interfaces/OAuth2ACAuthorizationParams.html +8 -0
  83. package/docs/interfaces/OAuth2ACTokenParams.html +13 -0
  84. package/docs/interfaces/OAuth2AuthDesignBuilder.html +4 -0
  85. package/docs/interfaces/OAuth2AuthDesignOptions.html +6 -0
  86. package/docs/interfaces/OAuth2AuthorizationCodeArg.html +9 -0
  87. package/docs/interfaces/OAuth2AuthorizationCodeBuilderArg.html +10 -0
  88. package/docs/interfaces/OAuth2ClientCredentialsArg.html +7 -0
  89. package/docs/interfaces/OAuth2ClientCredentialsBuilderArg.html +8 -0
  90. package/docs/interfaces/OAuth2ClientCredentialsTokenParams.html +9 -0
  91. package/docs/interfaces/OAuth2DeviceAuthTokenParams.html +9 -0
  92. package/docs/interfaces/OAuth2DeviceAuthorizationArg.html +9 -0
  93. package/docs/interfaces/OAuth2DeviceAuthorizationBuilderArg.html +10 -0
  94. package/docs/interfaces/OAuth2DeviceAuthorizationParams.html +3 -0
  95. package/docs/interfaces/OAuth2JwksOptions.html +6 -0
  96. package/docs/interfaces/OAuth2JwtPayload.html +24 -0
  97. package/docs/interfaces/OAuth2RefreshTokenParams.html +11 -0
  98. package/docs/interfaces/OAuth2SingleAuthFlow.html +6 -0
  99. package/docs/interfaces/OAuth2SingleAuthFlowBuilder.html +5 -0
  100. package/docs/interfaces/OAuth2TokenParams.html +6 -0
  101. package/docs/interfaces/OAuth2TokenResponseBody.html +8 -0
  102. package/docs/interfaces/OpenIDHelpers.html +3 -0
  103. package/docs/interfaces/ReplayStore.html +4 -0
  104. package/docs/interfaces/TokenType.html +5 -0
  105. package/docs/modules.html +1 -0
  106. package/docs/types/AnyOAuth2ErrorCodeType.html +1 -0
  107. package/docs/types/AuthCodeGenerator.html +2 -0
  108. package/docs/types/AuthCodeGeneratorResult.html +1 -0
  109. package/docs/types/AuthCodeResultMatchHandlers.html +4 -0
  110. package/docs/types/AuthCodeTokenGenerator.html +2 -0
  111. package/docs/types/AuthResponseHandler.html +5 -0
  112. package/docs/types/AuthResponseRenderer.html +1 -0
  113. package/docs/types/ClientAuthMethodResponse.html +5 -0
  114. package/docs/types/ClientCredentialsTokenGenerator.html +2 -0
  115. package/docs/types/DefaultOAuth2DeviceAuthRefreshTokenRoute.html +1 -0
  116. package/docs/types/DeviceAuthTokenGenerator.html +2 -0
  117. package/docs/types/DeviceCodeGenerator.html +2 -0
  118. package/docs/types/DeviceCodeResponse.html +23 -0
  119. package/docs/types/DeviceFlowOAuth2ErrorCodeType.html +1 -0
  120. package/docs/types/ExtendedOAuth2ErrorCodeType.html +1 -0
  121. package/docs/types/IOAuth2ACTokenRoute.html +1 -0
  122. package/docs/types/IOAuth2ClientCredentialsTokenRoute.html +1 -0
  123. package/docs/types/IOAuth2DeviceAuthTokenRoute.html +1 -0
  124. package/docs/types/IOAuth2RefreshTokenRoute.html +1 -0
  125. package/docs/types/JWKSHandler.html +1 -0
  126. package/docs/types/MultipleFlowsBuilderArg.html +1 -0
  127. package/docs/types/OAuth2ACAuthorizationHandler.html +1 -0
  128. package/docs/types/OAuth2ACTokenHandler.html +1 -0
  129. package/docs/types/OAuth2AuthOptions.html +7 -0
  130. package/docs/types/OAuth2ClientAuthentication.html +1 -0
  131. package/docs/types/OAuth2ClientCredentialsTokenHandler.html +1 -0
  132. package/docs/types/OAuth2DeviceAuthTokenHandler.html +1 -0
  133. package/docs/types/OAuth2DeviceAuthorizationHandler.html +1 -0
  134. package/docs/types/OAuth2DeviceCodeTokenErrorBody.html +4 -0
  135. package/docs/types/OAuth2ErrorBody.html +4 -0
  136. package/docs/types/OAuth2ErrorCodeType.html +1 -0
  137. package/docs/types/OAuth2RefreshTokenHandler.html +1 -0
  138. package/docs/types/OAuth2TokenErrorCodeType.html +1 -0
  139. package/docs/types/OAuth2TokenHandler.html +1 -0
  140. package/docs/types/OIDCAuthorizationCodeArg.html +2 -0
  141. package/docs/types/OIDCAuthorizationCodeBuilderArg.html +2 -0
  142. package/docs/types/OIDCClientCredentialsArg.html +2 -0
  143. package/docs/types/OIDCClientCredentialsBuilderArg.html +2 -0
  144. package/docs/types/OIDCDeviceAuthorizationArg.html +2 -0
  145. package/docs/types/OIDCDeviceAuthorizationBuilderArg.html +2 -0
  146. package/docs/types/PathValue.html +1 -0
  147. package/docs/types/ReplayDetector.html +1 -0
  148. package/docs/types/SingleCodeFlow.html +1 -0
  149. package/docs/types/StandardOAuth2ErrorCodeType.html +1 -0
  150. package/docs/types/TokenEndpointAuthMethod.html +1 -0
  151. package/docs/types/TokenGenerator.html +1 -0
  152. package/docs/types/TokenRequestValidation.html +1 -0
  153. package/docs/types/TokenTypeValidation.html +1 -0
  154. package/docs/types/TokenTypeValidationResponse.html +3 -0
  155. package/docs/types/WithRequired.html +1 -0
  156. package/docs/variables/AllOAuth2ErrorCode.html +1 -0
  157. package/docs/variables/AuthCodeResult.html +1 -0
  158. package/docs/variables/DeviceFlowOAuth2ErrorCode.html +1 -0
  159. package/docs/variables/ExtendedOAuth2ErrorCode.html +1 -0
  160. package/docs/variables/OAuth2ErrorCode.html +1 -0
  161. package/docs/variables/OAuth2TokenErrorCode.html +1 -0
  162. package/docs/variables/StandardOAuth2ErrorCode.html +1 -0
  163. package/kaukau.config.mjs +20 -0
  164. package/lib/cli.js +7 -7
  165. package/lib/flows/auth-code/authorization-route.d.ts +61 -10
  166. package/lib/flows/auth-code/authorization-route.js +152 -65
  167. package/lib/flows/auth-code/authorization-route.js.map +1 -1
  168. package/lib/flows/auth-code/authorization-utils.d.ts +35 -0
  169. package/lib/flows/auth-code/authorization-utils.js +44 -0
  170. package/lib/flows/auth-code/authorization-utils.js.map +1 -0
  171. package/lib/flows/auth-code/token-route.d.ts +10 -18
  172. package/lib/flows/auth-code/token-route.js +6 -15
  173. package/lib/flows/auth-code/token-route.js.map +1 -1
  174. package/lib/flows/authorization-code.d.ts +112 -0
  175. package/lib/flows/authorization-code.js +570 -0
  176. package/lib/flows/authorization-code.js.map +1 -0
  177. package/lib/flows/client-credentials.d.ts +79 -39
  178. package/lib/flows/client-credentials.js +324 -257
  179. package/lib/flows/client-credentials.js.map +1 -1
  180. package/lib/flows/client-creds/token-route.d.ts +23 -0
  181. package/lib/flows/client-creds/token-route.js +52 -0
  182. package/lib/flows/client-creds/token-route.js.map +1 -0
  183. package/lib/flows/common.d.ts +265 -28
  184. package/lib/flows/common.js +293 -29
  185. package/lib/flows/common.js.map +1 -1
  186. package/lib/flows/device-auth/authorization-route.d.ts +83 -0
  187. package/lib/flows/device-auth/authorization-route.js +68 -0
  188. package/lib/flows/device-auth/authorization-route.js.map +1 -0
  189. package/lib/flows/device-auth/token-route.d.ts +29 -0
  190. package/lib/flows/device-auth/token-route.js +49 -0
  191. package/lib/flows/device-auth/token-route.js.map +1 -0
  192. package/lib/flows/device-authorization.d.ts +112 -0
  193. package/lib/flows/device-authorization.js +523 -0
  194. package/lib/flows/device-authorization.js.map +1 -0
  195. package/lib/flows/oidc-multiple-flows.d.ts +59 -0
  196. package/lib/flows/oidc-multiple-flows.js +268 -0
  197. package/lib/flows/oidc-multiple-flows.js.map +1 -0
  198. package/lib/index.d.ts +12 -6
  199. package/lib/index.js +12 -6
  200. package/lib/index.js.map +1 -1
  201. package/lib/utils/client-auth-methods.d.ts +2 -2
  202. package/lib/utils/client-auth-methods.js +5 -6
  203. package/lib/utils/client-auth-methods.js.map +1 -1
  204. package/lib/utils/in-memory-key-store.d.ts +12 -0
  205. package/lib/utils/in-memory-key-store.js +46 -0
  206. package/lib/utils/in-memory-key-store.js.map +1 -0
  207. package/lib/utils/jwt-authority.d.ts +81 -0
  208. package/lib/utils/jwt-authority.js +186 -0
  209. package/lib/utils/jwt-authority.js.map +1 -0
  210. package/lib/utils/jwt-utils.d.ts +33 -0
  211. package/lib/utils/jwt-utils.js +24 -0
  212. package/lib/utils/jwt-utils.js.map +1 -0
  213. package/lib/utils/replay-store.d.ts +13 -0
  214. package/lib/utils/{cache-set.js → replay-store.js} +8 -4
  215. package/lib/utils/replay-store.js.map +1 -0
  216. package/lib/utils/token-types.d.ts +6 -3
  217. package/lib/utils/token-types.js +13 -10
  218. package/lib/utils/token-types.js.map +1 -1
  219. package/lib/utils/verify-code-verifier.d.ts +4 -0
  220. package/lib/utils/verify-code-verifier.js +18 -0
  221. package/lib/utils/verify-code-verifier.js.map +1 -0
  222. package/package.json +7 -7
  223. package/typedoc.json +11 -0
  224. package/lib/flows/auth-code/open-id.d.ts +0 -53
  225. package/lib/flows/auth-code/open-id.js +0 -199
  226. package/lib/flows/auth-code/open-id.js.map +0 -1
  227. package/lib/flows/auth-code.ts/open-id.d.ts +0 -52
  228. package/lib/flows/auth-code.ts/open-id.js +0 -169
  229. package/lib/flows/auth-code.ts/open-id.js.map +0 -1
  230. package/lib/flows/authentication-code.d.ts +0 -53
  231. package/lib/flows/authentication-code.js +0 -380
  232. package/lib/flows/authentication-code.js.map +0 -1
  233. package/lib/utils/cache-set.d.ts +0 -12
  234. package/lib/utils/cache-set.js.map +0 -1
  235. package/lib/utils/in-memory-cache.d.ts +0 -5
  236. package/lib/utils/in-memory-cache.js +0 -30
  237. package/lib/utils/in-memory-cache.js.map +0 -1
  238. package/lib/utils/in-memory-jwks-store.d.ts +0 -12
  239. package/lib/utils/in-memory-jwks-store.js +0 -46
  240. package/lib/utils/in-memory-jwks-store.js.map +0 -1
  241. package/lib/utils/jwks-generator.d.ts +0 -58
  242. package/lib/utils/jwks-generator.js +0 -141
  243. package/lib/utils/jwks-generator.js.map +0 -1
  244. package/lib/utils/jwks-store.d.ts +0 -13
  245. package/lib/utils/jwks-store.js +0 -3
  246. package/lib/utils/jwks-store.js.map +0 -1
package/docs/classes/DefaultOAuth2DeviceAuthTokenRoute.html ADDED
@@ -0,0 +1,10 @@
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>DefaultOAuth2DeviceAuthTokenRoute | @kaapi/oauth2-auth-design - v0.0.15</title><meta name="description" content="Documentation for @kaapi/oauth2-auth-design"/><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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@kaapi/oauth2-auth-design - v0.0.15</a><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"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><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><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">DefaultOAuth2DeviceAuthTokenRoute</a></li></ul><h1>Class DefaultOAuth2DeviceAuthTokenRoute&lt;Refs&gt;</h1></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="refs"><span class="tsd-kind-type-parameter">Refs</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">ReqRef</span> = <span class="tsd-signature-type">ReqRefDefaults</span></span></li></ul></section><section class="tsd-panel tsd-hierarchy" data-refl="1262"><h4>Hierarchy (<a href="../hierarchy.html#DefaultOAuth2DeviceAuthTokenRoute">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="OAuth2DeviceAuthTokenRoute.html" class="tsd-signature-type tsd-kind-class">OAuth2DeviceAuthTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">DefaultOAuth2DeviceAuthTokenRoute</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/DefaultOAuth2TokenRoute.html" class="tsd-signature-type tsd-kind-interface">DefaultOAuth2TokenRoute</a><span class="tsd-signature-symbol">&lt;</span><br/>    <a href="../interfaces/OAuth2DeviceAuthTokenParams.html" class="tsd-signature-type tsd-kind-interface">OAuth2DeviceAuthTokenParams</a><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span><br/>    <a href="../types/OAuth2DeviceCodeTokenErrorBody.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2DeviceCodeTokenErrorBody</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/token-route.ts#L72">packages/oauth2-auth-design/src/flows/device-auth/token-route.ts:72</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><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>
2
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#_handler" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>handler</span></a>
3
+ <a href="#_path" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>path</span></a>
4
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#handler" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>handler</span></a>
5
+ <a href="#path" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>path</span></a>
6
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#generatetoken" 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>generate<wbr/>Token</span></a>
7
+ <a href="#setpath" 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>set<wbr/>Path</span></a>
8
+ <a href="#validate" 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>validate</span></a>
9
+ <a href="#builddefault" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Default</span></a>
10
+ </div></section></div></details></section></section><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><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordefaultoauth2deviceauthtokenroute"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultOAuth2DeviceAuthTokenRoute</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a> <span class="tsd-signature-keyword">extends</span><br/>        <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2DeviceAuthTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructordefaultoauth2deviceauthtokenroute" 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><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="constructordefaultoauth2deviceauthtokenrouterefs"><span class="tsd-kind-type-parameter">Refs</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">ReqRefDefaults</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2DeviceAuthTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Overrides <a href="OAuth2DeviceAuthTokenRoute.html">OAuth2DeviceAuthTokenRoute</a>.<a href="OAuth2DeviceAuthTokenRoute.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/token-route.ts#L81">packages/oauth2-auth-design/src/flows/device-auth/token-route.ts:81</a></li></ul></aside></div></li></ul></section></section></details><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><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="_handler"><code class="tsd-tag">Protected</code><span>_<wbr/>handler</span><a href="#_handler" 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><div class="tsd-signature"><span class="tsd-kind-property">_handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/OAuth2TokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2TokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/OAuth2DeviceAuthTokenParams.html" class="tsd-signature-type tsd-kind-interface">OAuth2DeviceAuthTokenParams</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#_handler">_handler</a></p><p>Inherited from <a href="OAuth2DeviceAuthTokenRoute.html">OAuth2DeviceAuthTokenRoute</a>.<a href="OAuth2DeviceAuthTokenRoute.html#_handler">_handler</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L201">packages/oauth2-auth-design/src/flows/common.ts:201</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="_path"><code class="tsd-tag">Protected</code><span>_<wbr/>path</span><a href="#_path" 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><div class="tsd-signature"><span class="tsd-kind-property">_path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#_path">_path</a></p><p>Inherited from <a href="OAuth2DeviceAuthTokenRoute.html">OAuth2DeviceAuthTokenRoute</a>.<a href="OAuth2DeviceAuthTokenRoute.html#_path">_path</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L200">packages/oauth2-auth-design/src/flows/common.ts:200</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="handler"><span>handler</span><a href="#handler" 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><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="handlerhandler"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">handler</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/OAuth2TokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2TokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenroutep">P</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">ReturnValue</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../types/OAuth2TokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2TokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenroutep">P</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">ReturnValue</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of DefaultOAuth2TokenRoute.handler</p><p>Inherited from OAuth2DeviceAuthTokenRoute.handler</p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L207">packages/oauth2-auth-design/src/flows/common.ts:207</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="path"><span>path</span><a href="#path" 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><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="pathpath"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">path</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of DefaultOAuth2TokenRoute.path</p><p>Inherited from OAuth2DeviceAuthTokenRoute.path</p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L203">packages/oauth2-auth-design/src/flows/common.ts:203</a></li></ul></aside></div></li></ul></section></section></details><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><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="generatetoken"><span>generate<wbr/>Token</span><a href="#generatetoken" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="generatetoken-1"><span class="tsd-kind-call-signature">generateToken</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/DeviceAuthTokenGenerator.html" class="tsd-signature-type tsd-kind-type-alias">DeviceAuthTokenGenerator</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#generatetoken-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/DeviceAuthTokenGenerator.html" class="tsd-signature-type tsd-kind-type-alias">DeviceAuthTokenGenerator</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#generatetoken">generateToken</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/token-route.ts#L112">packages/oauth2-auth-design/src/flows/device-auth/token-route.ts:112</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setpath"><span>set<wbr/>Path</span><a href="#setpath" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setpath-1"><span class="tsd-kind-call-signature">setPath</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">/</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setpath-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">/</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#setpath">setPath</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/token-route.ts#L101">packages/oauth2-auth-design/src/flows/device-auth/token-route.ts:101</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="validate"><span>validate</span><a href="#validate" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="validate-1"><span class="tsd-kind-call-signature">validate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/OAuth2DeviceAuthTokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2DeviceAuthTokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#validate-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/OAuth2DeviceAuthTokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2DeviceAuthTokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#validate">validate</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/token-route.ts#L107">packages/oauth2-auth-design/src/flows/device-auth/token-route.ts:107</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="builddefault"><code class="tsd-tag">Static</code><span>build<wbr/>Default</span><a href="#builddefault" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="builddefault-1"><span class="tsd-kind-call-signature">buildDefault</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#builddefaultrefs">Refs</a> <span class="tsd-signature-keyword">extends</span><br/>        <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2DeviceAuthTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2DeviceAuthTokenRoute.html#builddefaultrefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><a href="#builddefault-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><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="builddefaultrefs"><span class="tsd-kind-type-parameter">Refs</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">ReqRefDefaults</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2DeviceAuthTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2DeviceAuthTokenRoute.html#builddefaultrefs">Refs</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from <a href="OAuth2DeviceAuthTokenRoute.html">OAuth2DeviceAuthTokenRoute</a>.<a href="OAuth2DeviceAuthTokenRoute.html#builddefault">buildDefault</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/token-route.ts#L56">packages/oauth2-auth-design/src/flows/device-auth/token-route.ts:56</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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><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><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><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><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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><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><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><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><div><a href="#_handler" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>handler</span></a><a href="#_path" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>path</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#handler" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>handler</span></a><a href="#path" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>path</span></a></div></details><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><div><a href="#generatetoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Token</span></a><a href="#setpath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Path</span></a><a href="#validate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate</span></a><a href="#builddefault" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Default</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@kaapi/oauth2-auth-design - v0.0.15</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
package/docs/classes/DefaultOAuth2DeviceAuthorizationRoute.html ADDED
@@ -0,0 +1,11 @@
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>DefaultOAuth2DeviceAuthorizationRoute | @kaapi/oauth2-auth-design - v0.0.15</title><meta name="description" content="Documentation for @kaapi/oauth2-auth-design"/><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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@kaapi/oauth2-auth-design - v0.0.15</a><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"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><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><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">DefaultOAuth2DeviceAuthorizationRoute</a></li></ul><h1>Class DefaultOAuth2DeviceAuthorizationRoute&lt;PostRefs&gt;</h1></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="postrefs"><span class="tsd-kind-type-parameter">PostRefs</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">ReqRef</span> = <span class="tsd-signature-type">ReqRefDefaults</span></span></li></ul></section><section class="tsd-panel tsd-hierarchy" data-refl="1183"><h4>Hierarchy (<a href="../hierarchy.html#DefaultOAuth2DeviceAuthorizationRoute">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="OAuth2DeviceAuthorizationRoute.html" class="tsd-signature-type tsd-kind-class">OAuth2DeviceAuthorizationRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">DefaultOAuth2DeviceAuthorizationRoute</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L125">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:125</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><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>
2
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#_handler" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>handler</span></a>
3
+ <a href="#_path" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>path</span></a>
4
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#handler" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>handler</span></a>
5
+ <a href="#path" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>path</span></a>
6
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#generatecode" 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>generate<wbr/>Code</span></a>
7
+ <a href="#setclientid" 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>set<wbr/>Client<wbr/>Id</span></a>
8
+ <a href="#setpath" 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>set<wbr/>Path</span></a>
9
+ <a href="#validate" 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>validate</span></a>
10
+ <a href="#builddefault" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Default</span></a>
11
+ </div></section></div></details></section></section><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><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordefaultoauth2deviceauthorizationroute"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultOAuth2DeviceAuthorizationRoute</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthorizationroutepostrefs">PostRefs</a> <span class="tsd-signature-keyword">extends</span><br/>        <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2DeviceAuthorizationRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructordefaultoauth2deviceauthorizationroute" 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><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="constructordefaultoauth2deviceauthorizationroutepostrefs"><span class="tsd-kind-type-parameter">PostRefs</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">ReqRefDefaults</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2DeviceAuthorizationRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Overrides <a href="OAuth2DeviceAuthorizationRoute.html">OAuth2DeviceAuthorizationRoute</a>.<a href="OAuth2DeviceAuthorizationRoute.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L132">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:132</a></li></ul></aside></div></li></ul></section></section></details><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><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="_handler"><code class="tsd-tag">Protected</code><span>_<wbr/>handler</span><a href="#_handler" 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><div class="tsd-signature"><span class="tsd-kind-property">_handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/OAuth2DeviceAuthorizationHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2DeviceAuthorizationHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><p>Inherited from <a href="OAuth2DeviceAuthorizationRoute.html">OAuth2DeviceAuthorizationRoute</a>.<a href="OAuth2DeviceAuthorizationRoute.html#_handler">_handler</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L41">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="_path"><code class="tsd-tag">Protected</code><span>_<wbr/>path</span><a href="#_path" 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><div class="tsd-signature"><span class="tsd-kind-property">_path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="OAuth2DeviceAuthorizationRoute.html">OAuth2DeviceAuthorizationRoute</a>.<a href="OAuth2DeviceAuthorizationRoute.html#_path">_path</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L40">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:40</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="handler"><span>handler</span><a href="#handler" 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><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="handlerhandler"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">handler</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/OAuth2DeviceAuthorizationHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2DeviceAuthorizationHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2DeviceAuthorizationRoute.html#constructoroauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">ReturnValue</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2DeviceAuthorizationRoute.html#constructoroauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../types/OAuth2DeviceAuthorizationHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2DeviceAuthorizationHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2DeviceAuthorizationRoute.html#constructoroauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">ReturnValue</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2DeviceAuthorizationRoute.html#constructoroauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from OAuth2DeviceAuthorizationRoute.handler</p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L47">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:47</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="path"><span>path</span><a href="#path" 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><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="pathpath"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">path</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from OAuth2DeviceAuthorizationRoute.path</p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L43">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:43</a></li></ul></aside></div></li></ul></section></section></details><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><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="generatecode"><span>generate<wbr/>Code</span><a href="#generatecode" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="generatecode-1"><span class="tsd-kind-call-signature">generateCode</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/DeviceCodeGenerator.html" class="tsd-signature-type tsd-kind-type-alias">DeviceCodeGenerator</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#generatecode-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/DeviceCodeGenerator.html" class="tsd-signature-type tsd-kind-type-alias">DeviceCodeGenerator</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L167">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:167</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setclientid"><span>set<wbr/>Client<wbr/>Id</span><a href="#setclientid" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setclientid-1"><span class="tsd-kind-call-signature">setClientId</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setclientid-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L172">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:172</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setpath"><span>set<wbr/>Path</span><a href="#setpath" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setpath-1"><span class="tsd-kind-call-signature">setPath</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">/</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setpath-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">/</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L156">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:156</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="validate"><span>validate</span><a href="#validate" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="validate-1"><span class="tsd-kind-call-signature">validate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/OAuth2DeviceAuthorizationHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2DeviceAuthorizationHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#validate-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/OAuth2DeviceAuthorizationHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2DeviceAuthorizationHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2deviceauthorizationroutepostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L162">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:162</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="builddefault"><code class="tsd-tag">Static</code><span>build<wbr/>Default</span><a href="#builddefault" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="builddefault-1"><span class="tsd-kind-call-signature">buildDefault</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#builddefaultpostrefs">PostRefs</a> <span class="tsd-signature-keyword">extends</span><br/>        <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2DeviceAuthorizationRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2DeviceAuthorizationRoute.html#builddefaultpostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span><a href="#builddefault-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><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="builddefaultpostrefs"><span class="tsd-kind-type-parameter">PostRefs</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">ReqRefDefaults</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2DeviceAuthorizationRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2DeviceAuthorizationRoute.html#builddefaultpostrefs">PostRefs</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from <a href="OAuth2DeviceAuthorizationRoute.html">OAuth2DeviceAuthorizationRoute</a>.<a href="OAuth2DeviceAuthorizationRoute.html#builddefault">buildDefault</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts#L34">packages/oauth2-auth-design/src/flows/device-auth/authorization-route.ts:34</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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><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><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><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><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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><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><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><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><div><a href="#_handler" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>handler</span></a><a href="#_path" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>path</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#handler" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>handler</span></a><a href="#path" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>path</span></a></div></details><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><div><a href="#generatecode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Code</span></a><a href="#setclientid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Client<wbr/>Id</span></a><a href="#setpath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Path</span></a><a href="#validate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate</span></a><a href="#builddefault" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Default</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@kaapi/oauth2-auth-design - v0.0.15</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
package/docs/classes/DefaultOAuth2RefreshTokenRoute.html ADDED
@@ -0,0 +1,10 @@
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>DefaultOAuth2RefreshTokenRoute | @kaapi/oauth2-auth-design - v0.0.15</title><meta name="description" content="Documentation for @kaapi/oauth2-auth-design"/><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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@kaapi/oauth2-auth-design - v0.0.15</a><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"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><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><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">DefaultOAuth2RefreshTokenRoute</a></li></ul><h1>Class DefaultOAuth2RefreshTokenRoute&lt;Refs, Err&gt;</h1></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="refs"><span class="tsd-kind-type-parameter">Refs</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">ReqRef</span> = <span class="tsd-signature-type">ReqRefDefaults</span></span></li><li><span id="err"><span class="tsd-kind-type-parameter">Err</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> = <a href="../types/OAuth2ErrorBody.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ErrorBody</a></span></li></ul></section><section class="tsd-panel tsd-hierarchy" data-refl="249"><h4>Hierarchy (<a href="../hierarchy.html#DefaultOAuth2RefreshTokenRoute">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="OAuth2RefreshTokenRoute.html" class="tsd-signature-type tsd-kind-class">OAuth2RefreshTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">DefaultOAuth2RefreshTokenRoute</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/DefaultOAuth2TokenRoute.html" class="tsd-signature-type tsd-kind-interface">DefaultOAuth2TokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/OAuth2RefreshTokenParams.html" class="tsd-signature-type tsd-kind-interface">OAuth2RefreshTokenParams</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouteerr">Err</a><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L268">packages/oauth2-auth-design/src/flows/common.ts:268</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><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>
2
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#_handler" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>handler</span></a>
3
+ <a href="#_path" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>path</span></a>
4
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#handler" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>handler</span></a>
5
+ <a href="#path" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>path</span></a>
6
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#generatetoken" 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>generate<wbr/>Token</span></a>
7
+ <a href="#setpath" 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>set<wbr/>Path</span></a>
8
+ <a href="#validate" 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>validate</span></a>
9
+ <a href="#builddefault" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Default</span></a>
10
+ </div></section></div></details></section></section><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><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordefaultoauth2refreshtokenroute"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultOAuth2RefreshTokenRoute</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a> <span class="tsd-signature-keyword">extends</span><br/>        <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouteerr">Err</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">=</span> <a href="../types/OAuth2ErrorBody.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ErrorBody</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2RefreshTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouteerr">Err</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructordefaultoauth2refreshtokenroute" 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><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="constructordefaultoauth2refreshtokenrouterefs"><span class="tsd-kind-type-parameter">Refs</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">ReqRefDefaults</span></span></li><li><span id="constructordefaultoauth2refreshtokenrouteerr"><span class="tsd-kind-type-parameter">Err</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> = <a href="../types/OAuth2ErrorBody.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ErrorBody</a></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2RefreshTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouteerr">Err</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Overrides <a href="OAuth2RefreshTokenRoute.html">OAuth2RefreshTokenRoute</a>.<a href="OAuth2RefreshTokenRoute.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L278">packages/oauth2-auth-design/src/flows/common.ts:278</a></li></ul></aside></div></li></ul></section></section></details><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><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="_handler"><code class="tsd-tag">Protected</code><span>_<wbr/>handler</span><a href="#_handler" 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><div class="tsd-signature"><span class="tsd-kind-property">_handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/OAuth2TokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2TokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/OAuth2RefreshTokenParams.html" class="tsd-signature-type tsd-kind-interface">OAuth2RefreshTokenParams</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#_handler">_handler</a></p><p>Inherited from <a href="OAuth2RefreshTokenRoute.html">OAuth2RefreshTokenRoute</a>.<a href="OAuth2RefreshTokenRoute.html#_handler">_handler</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L201">packages/oauth2-auth-design/src/flows/common.ts:201</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="_path"><code class="tsd-tag">Protected</code><span>_<wbr/>path</span><a href="#_path" 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><div class="tsd-signature"><span class="tsd-kind-property">_path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#_path">_path</a></p><p>Inherited from <a href="OAuth2RefreshTokenRoute.html">OAuth2RefreshTokenRoute</a>.<a href="OAuth2RefreshTokenRoute.html#_path">_path</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L200">packages/oauth2-auth-design/src/flows/common.ts:200</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="handler"><span>handler</span><a href="#handler" 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><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="handlerhandler"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">handler</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/OAuth2TokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2TokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenroutep">P</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">ReturnValue</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../types/OAuth2TokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2TokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenroutep">P</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">ReturnValue</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2TokenRoute.html#constructoroauth2tokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of DefaultOAuth2TokenRoute.handler</p><p>Inherited from OAuth2RefreshTokenRoute.handler</p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L207">packages/oauth2-auth-design/src/flows/common.ts:207</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="path"><span>path</span><a href="#path" 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><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="pathpath"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">path</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of DefaultOAuth2TokenRoute.path</p><p>Inherited from OAuth2RefreshTokenRoute.path</p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L203">packages/oauth2-auth-design/src/flows/common.ts:203</a></li></ul></aside></div></li></ul></section></section></details><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><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="generatetoken"><span>generate<wbr/>Token</span><a href="#generatetoken" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="generatetoken-1"><span class="tsd-kind-call-signature">generateToken</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/TokenGenerator.html" class="tsd-signature-type tsd-kind-type-alias">TokenGenerator</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/OAuth2RefreshTokenParams.html" class="tsd-signature-type tsd-kind-interface">OAuth2RefreshTokenParams</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouteerr">Err</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#generatetoken-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/TokenGenerator.html" class="tsd-signature-type tsd-kind-type-alias">TokenGenerator</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/OAuth2RefreshTokenParams.html" class="tsd-signature-type tsd-kind-interface">OAuth2RefreshTokenParams</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouteerr">Err</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#generatetoken">generateToken</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L291">packages/oauth2-auth-design/src/flows/common.ts:291</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setpath"><span>set<wbr/>Path</span><a href="#setpath" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setpath-1"><span class="tsd-kind-call-signature">setPath</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">/</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setpath-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">/</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#setpath">setPath</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L296">packages/oauth2-auth-design/src/flows/common.ts:296</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="validate"><span>validate</span><a href="#validate" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="validate-1"><span class="tsd-kind-call-signature">validate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/OAuth2RefreshTokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2RefreshTokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#validate-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/OAuth2RefreshTokenHandler.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2RefreshTokenHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructordefaultoauth2refreshtokenrouterefs">Refs</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/DefaultOAuth2TokenRoute.html">DefaultOAuth2TokenRoute</a>.<a href="../interfaces/DefaultOAuth2TokenRoute.html#validate">validate</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L302">packages/oauth2-auth-design/src/flows/common.ts:302</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="builddefault"><code class="tsd-tag">Static</code><span>build<wbr/>Default</span><a href="#builddefault" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="builddefault-1"><span class="tsd-kind-call-signature">buildDefault</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#builddefaultrefs">Refs</a> <span class="tsd-signature-keyword">extends</span><br/>        <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#builddefaulterr">Err</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">=</span> <a href="../types/OAuth2ErrorBody.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ErrorBody</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2RefreshTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2RefreshTokenRoute.html#builddefaultrefs">Refs</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2RefreshTokenRoute.html#builddefaulterr">Err</a><span class="tsd-signature-symbol">&gt;</span><a href="#builddefault-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><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="builddefaultrefs"><span class="tsd-kind-type-parameter">Refs</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type">ReqRefDefaults</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">ReqRefDefaults</span></span></li><li><span id="builddefaulterr"><span class="tsd-kind-type-parameter">Err</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> = <a href="../types/OAuth2ErrorBody.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ErrorBody</a></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DefaultOAuth2RefreshTokenRoute</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2RefreshTokenRoute.html#builddefaultrefs">Refs</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="OAuth2RefreshTokenRoute.html#builddefaulterr">Err</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from <a href="OAuth2RefreshTokenRoute.html">OAuth2RefreshTokenRoute</a>.<a href="OAuth2RefreshTokenRoute.html#builddefault">buildDefault</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/flows/common.ts#L260">packages/oauth2-auth-design/src/flows/common.ts:260</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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><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><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><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><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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><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><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><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><div><a href="#_handler" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>handler</span></a><a href="#_path" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>path</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#handler" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>handler</span></a><a href="#path" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>path</span></a></div></details><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><div><a href="#generatetoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Token</span></a><a href="#setpath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Path</span></a><a href="#validate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate</span></a><a href="#builddefault" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Default</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@kaapi/oauth2-auth-design - v0.0.15</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
package/docs/classes/InMemoryKeyStore.html ADDED
@@ -0,0 +1,12 @@
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>InMemoryKeyStore | @kaapi/oauth2-auth-design - v0.0.15</title><meta name="description" content="Documentation for @kaapi/oauth2-auth-design"/><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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@kaapi/oauth2-auth-design - v0.0.15</a><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"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><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><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">InMemoryKeyStore</a></li></ul><h1>Class InMemoryKeyStore</h1></div><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/JwksKeyStore.html" class="tsd-signature-type tsd-kind-interface">JwksKeyStore</a></li><li><a href="../interfaces/JwksRotationTimestampStore.html" class="tsd-signature-type tsd-kind-interface">JwksRotationTimestampStore</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/utils/in-memory-key-store.ts#L4">packages/oauth2-auth-design/src/utils/in-memory-key-store.ts:4</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><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>
2
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#getlastrotationtimestamp" 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/>Last<wbr/>Rotation<wbr/>Timestamp</span></a>
3
+ <a href="#getprivatekey" 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/>Private<wbr/>Key</span></a>
4
+ <a href="#getpublickeys" 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/>Public<wbr/>Keys</span></a>
5
+ <a href="#setlastrotationtimestamp" 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>set<wbr/>Last<wbr/>Rotation<wbr/>Timestamp</span></a>
6
+ <a href="#storekeypair" 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>store<wbr/>Key<wbr/>Pair</span></a>
7
+ </div></section></div></details></section></section><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><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorinmemorykeystore"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">InMemoryKeyStore</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">InMemoryKeyStore</a><a href="#constructorinmemorykeystore" 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><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">InMemoryKeyStore</a></h4></div></li></ul></section></section></details><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><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getlastrotationtimestamp"><span>get<wbr/>Last<wbr/>Rotation<wbr/>Timestamp</span><a href="#getlastrotationtimestamp" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getlastrotationtimestamp-1"><span class="tsd-kind-call-signature">getLastRotationTimestamp</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">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#getlastrotationtimestamp-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><div class="tsd-description"><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">number</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/JwksRotationTimestampStore.html">JwksRotationTimestampStore</a>.<a href="../interfaces/JwksRotationTimestampStore.html#getlastrotationtimestamp">getLastRotationTimestamp</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/utils/in-memory-key-store.ts#L25">packages/oauth2-auth-design/src/utils/in-memory-key-store.ts:25</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getprivatekey"><span>get<wbr/>Private<wbr/>Key</span><a href="#getprivatekey" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getprivatekey-1"><span class="tsd-kind-call-signature">getPrivateKey</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">object</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getprivatekey-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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the current private key used for signing.</p>
8
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/JwksKeyStore.html">JwksKeyStore</a>.<a href="../interfaces/JwksKeyStore.html#getprivatekey">getPrivateKey</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/utils/in-memory-key-store.ts#L15">packages/oauth2-auth-design/src/utils/in-memory-key-store.ts:15</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getpublickeys"><span>get<wbr/>Public<wbr/>Keys</span><a href="#getpublickeys" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getpublickeys-1"><span class="tsd-kind-call-signature">getPublicKeys</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">object</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#getpublickeys-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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves all valid public keys that have not expired.
9
+ These are used for exposing in JWKS.</p>
10
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/JwksKeyStore.html">JwksKeyStore</a>.<a href="../interfaces/JwksKeyStore.html#getpublickeys">getPublicKeys</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/utils/in-memory-key-store.ts#L19">packages/oauth2-auth-design/src/utils/in-memory-key-store.ts:19</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setlastrotationtimestamp"><span>set<wbr/>Last<wbr/>Rotation<wbr/>Timestamp</span><a href="#setlastrotationtimestamp" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setlastrotationtimestamp-1"><span class="tsd-kind-call-signature">setLastRotationTimestamp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msDate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#setlastrotationtimestamp-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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msDate</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/JwksRotationTimestampStore.html">JwksRotationTimestampStore</a>.<a href="../interfaces/JwksRotationTimestampStore.html#setlastrotationtimestamp">setLastRotationTimestamp</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/utils/in-memory-key-store.ts#L29">packages/oauth2-auth-design/src/utils/in-memory-key-store.ts:29</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="storekeypair"><span>store<wbr/>Key<wbr/>Pair</span><a href="#storekeypair" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="storekeypair-1"><span class="tsd-kind-call-signature">storeKeyPair</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">_kid</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">object</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">publicKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">ttl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#storekeypair-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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stores the current active private key and its corresponding public key.
11
+ The public key will be kept for the duration of the TTL for JWKS purposes.</p>
12
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">_kid</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">privateKey</span>: <span class="tsd-signature-type">object</span></span></li><li><span><span class="tsd-kind-parameter">publicKey</span>: <span class="tsd-signature-type">object</span></span></li><li><span><span class="tsd-kind-parameter">ttl</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/JwksKeyStore.html">JwksKeyStore</a>.<a href="../interfaces/JwksKeyStore.html#storekeypair">storeKeyPair</a></p><ul><li>Defined in <a href="https://github.com/demingongo/kaapi/blob/2457865ff5221a00cb8f7ccb13cff0416b3ce82f/packages/oauth2-auth-design/src/utils/in-memory-key-store.ts#L9">packages/oauth2-auth-design/src/utils/in-memory-key-store.ts:9</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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><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><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><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><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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><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><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><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><div><a href="#getlastrotationtimestamp"><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/>Last<wbr/>Rotation<wbr/>Timestamp</span></a><a href="#getprivatekey"><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/>Private<wbr/>Key</span></a><a href="#getpublickeys"><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/>Public<wbr/>Keys</span></a><a href="#setlastrotationtimestamp"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Last<wbr/>Rotation<wbr/>Timestamp</span></a><a href="#storekeypair"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>store<wbr/>Key<wbr/>Pair</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@kaapi/oauth2-auth-design - v0.0.15</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>