docs: return hierarchy to markdown docs

panva · Jan 10, 2024 · 7d3b414 · 7d3b414
1 parent b2e62a6
commit 7d3b414
Show file tree

Hide file tree

Showing 19 changed files with 187 additions and 2 deletions.
diff --git a/docs/classes/OperationProcessingError.md b/docs/classes/OperationProcessingError.md
@@ -25,3 +25,9 @@
 #### Returns
 
 [`OperationProcessingError`](OperationProcessingError.md)
+
+## Hierarchy
+
+- [`Error`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error )
+
+  ↳ **`OperationProcessingError`**
diff --git a/docs/classes/UnsupportedOperationError.md b/docs/classes/UnsupportedOperationError.md
@@ -23,3 +23,9 @@
 #### Returns
 
 [`UnsupportedOperationError`](UnsupportedOperationError.md)
+
+## Hierarchy
+
+- [`Error`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error )
+
+  ↳ **`UnsupportedOperationError`**
diff --git a/docs/interfaces/AuthenticatedRequestOptions.md b/docs/interfaces/AuthenticatedRequestOptions.md
@@ -29,3 +29,21 @@ ___
 Private key to use for `private_key_jwt`
 [client authentication](../types/ClientAuthenticationMethod.md). Its algorithm must be compatible with
 a supported [JWS `alg` Algorithm](../types/JWSAlgorithm.md).
+
+## Hierarchy
+
+- [`ExperimentalUseMTLSAliasOptions`](ExperimentalUseMTLSAliasOptions.md)
+
+  ↳ **`AuthenticatedRequestOptions`**
+
+  ↳↳ [`PushedAuthorizationRequestOptions`](PushedAuthorizationRequestOptions.md)
+
+  ↳↳ [`TokenEndpointRequestOptions`](TokenEndpointRequestOptions.md)
+
+  ↳↳ [`ClientCredentialsGrantRequestOptions`](ClientCredentialsGrantRequestOptions.md)
+
+  ↳↳ [`RevocationRequestOptions`](RevocationRequestOptions.md)
+
+  ↳↳ [`IntrospectionRequestOptions`](IntrospectionRequestOptions.md)
+
+  ↳↳ [`DeviceAuthorizationRequestOptions`](DeviceAuthorizationRequestOptions.md)
diff --git a/docs/interfaces/ClientCredentialsGrantRequestOptions.md b/docs/interfaces/ClientCredentialsGrantRequestOptions.md
@@ -77,3 +77,13 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- [`HttpRequestOptions`](HttpRequestOptions.md)
+
+- [`AuthenticatedRequestOptions`](AuthenticatedRequestOptions.md)
+
+- [`DPoPRequestOptions`](DPoPRequestOptions.md)
+
+  ↳ **`ClientCredentialsGrantRequestOptions`**
diff --git a/docs/interfaces/DPoPOptions.md b/docs/interfaces/DPoPOptions.md
@@ -37,3 +37,9 @@ ___
 Server-Provided Nonce to use in the request. This option serves as an override in case the
 self-correcting mechanism does not work with a particular server. Previously received nonces
 will be used automatically.
+
+## Hierarchy
+
+- `CryptoKeyPair`
+
+  ↳ **`DPoPOptions`**
diff --git a/docs/interfaces/DPoPRequestOptions.md b/docs/interfaces/DPoPRequestOptions.md
@@ -15,3 +15,17 @@
 • `Optional` **DPoP**: [`DPoPOptions`](DPoPOptions.md)
 
 DPoP-related options.
+
+## Hierarchy
+
+- **`DPoPRequestOptions`**
+
+  ↳ [`PushedAuthorizationRequestOptions`](PushedAuthorizationRequestOptions.md)
+
+  ↳ [`ProtectedResourceRequestOptions`](ProtectedResourceRequestOptions.md)
+
+  ↳ [`UserInfoRequestOptions`](UserInfoRequestOptions.md)
+
+  ↳ [`TokenEndpointRequestOptions`](TokenEndpointRequestOptions.md)
+
+  ↳ [`ClientCredentialsGrantRequestOptions`](ClientCredentialsGrantRequestOptions.md)
diff --git a/docs/interfaces/DeviceAuthorizationRequestOptions.md b/docs/interfaces/DeviceAuthorizationRequestOptions.md
@@ -68,3 +68,11 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- [`HttpRequestOptions`](HttpRequestOptions.md)
+
+- [`AuthenticatedRequestOptions`](AuthenticatedRequestOptions.md)
+
+  ↳ **`DeviceAuthorizationRequestOptions`**
diff --git a/docs/interfaces/DiscoveryRequestOptions.md b/docs/interfaces/DiscoveryRequestOptions.md
@@ -54,3 +54,9 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- [`HttpRequestOptions`](HttpRequestOptions.md)
+
+  ↳ **`DiscoveryRequestOptions`**
diff --git a/docs/interfaces/ExperimentalUseMTLSAliasOptions.md b/docs/interfaces/ExperimentalUseMTLSAliasOptions.md
@@ -18,3 +18,11 @@ This is an experimental feature, it is not subject to semantic versioning rules.
 compatible changes or removal may occur in any future release.
 
 See [experimentalUseMtlsAlias](../variables/experimentalUseMtlsAlias.md) for its documentation.
+
+## Hierarchy
+
+- **`ExperimentalUseMTLSAliasOptions`**
+
+  ↳ [`AuthenticatedRequestOptions`](AuthenticatedRequestOptions.md)
+
+  ↳ [`UserInfoRequestOptions`](UserInfoRequestOptions.md)
diff --git a/docs/interfaces/HttpRequestOptions.md b/docs/interfaces/HttpRequestOptions.md
@@ -45,3 +45,23 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- **`HttpRequestOptions`**
+
+  ↳ [`DiscoveryRequestOptions`](DiscoveryRequestOptions.md)
+
+  ↳ [`PushedAuthorizationRequestOptions`](PushedAuthorizationRequestOptions.md)
+
+  ↳ [`UserInfoRequestOptions`](UserInfoRequestOptions.md)
+
+  ↳ [`TokenEndpointRequestOptions`](TokenEndpointRequestOptions.md)
+
+  ↳ [`ClientCredentialsGrantRequestOptions`](ClientCredentialsGrantRequestOptions.md)
+
+  ↳ [`RevocationRequestOptions`](RevocationRequestOptions.md)
+
+  ↳ [`IntrospectionRequestOptions`](IntrospectionRequestOptions.md)
+
+  ↳ [`DeviceAuthorizationRequestOptions`](DeviceAuthorizationRequestOptions.md)
diff --git a/docs/interfaces/IDToken.md b/docs/interfaces/IDToken.md
@@ -76,3 +76,9 @@ ___
 ### nonce
 
 • `Optional` `Readonly` **nonce**: `string`
+
+## Hierarchy
+
+- `JWTPayload`
+
+  ↳ **`IDToken`**
diff --git a/docs/interfaces/IntrospectionRequestOptions.md b/docs/interfaces/IntrospectionRequestOptions.md
@@ -92,3 +92,11 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- [`HttpRequestOptions`](HttpRequestOptions.md)
+
+- [`AuthenticatedRequestOptions`](AuthenticatedRequestOptions.md)
+
+  ↳ **`IntrospectionRequestOptions`**
diff --git a/docs/interfaces/MTLSEndpointAliases.md b/docs/interfaces/MTLSEndpointAliases.md
@@ -64,3 +64,9 @@ ___
 • `Optional` `Readonly` **userinfo\_endpoint**: `string`
 
 URL of the authorization server's UserInfo Endpoint.
+
+## Hierarchy
+
+- [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`AuthorizationServer`](AuthorizationServer.md), ``"token_endpoint"`` \| ``"revocation_endpoint"`` \| ``"introspection_endpoint"`` \| ``"device_authorization_endpoint"`` \| ``"userinfo_endpoint"`` \| ``"pushed_authorization_request_endpoint"``\>
+
+  ↳ **`MTLSEndpointAliases`**
diff --git a/docs/interfaces/ProtectedResourceRequestOptions.md b/docs/interfaces/ProtectedResourceRequestOptions.md
@@ -58,3 +58,11 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- [`Omit`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys )\<[`HttpRequestOptions`](HttpRequestOptions.md), ``"headers"``\>
+
+- [`DPoPRequestOptions`](DPoPRequestOptions.md)
+
+  ↳ **`ProtectedResourceRequestOptions`**
diff --git a/docs/interfaces/PushedAuthorizationRequestOptions.md b/docs/interfaces/PushedAuthorizationRequestOptions.md
@@ -77,3 +77,13 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- [`HttpRequestOptions`](HttpRequestOptions.md)
+
+- [`AuthenticatedRequestOptions`](AuthenticatedRequestOptions.md)
+
+- [`DPoPRequestOptions`](DPoPRequestOptions.md)
+
+  ↳ **`PushedAuthorizationRequestOptions`**
diff --git a/docs/interfaces/RevocationRequestOptions.md b/docs/interfaces/RevocationRequestOptions.md
@@ -77,3 +77,11 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- [`HttpRequestOptions`](HttpRequestOptions.md)
+
+- [`AuthenticatedRequestOptions`](AuthenticatedRequestOptions.md)
+
+  ↳ **`RevocationRequestOptions`**
diff --git a/docs/interfaces/TokenEndpointRequestOptions.md b/docs/interfaces/TokenEndpointRequestOptions.md
@@ -86,3 +86,13 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- [`HttpRequestOptions`](HttpRequestOptions.md)
+
+- [`AuthenticatedRequestOptions`](AuthenticatedRequestOptions.md)
+
+- [`DPoPRequestOptions`](DPoPRequestOptions.md)
+
+  ↳ **`TokenEndpointRequestOptions`**
diff --git a/docs/interfaces/UserInfoRequestOptions.md b/docs/interfaces/UserInfoRequestOptions.md
@@ -66,3 +66,13 @@ A 5000ms timeout AbortSignal for every request
 ```js
 const signal = () => AbortSignal.timeout(5_000) // Note: AbortSignal.timeout may not yet be available in all runtimes.
 ```
+
+## Hierarchy
+
+- [`HttpRequestOptions`](HttpRequestOptions.md)
+
+- [`DPoPRequestOptions`](DPoPRequestOptions.md)
+
+- [`ExperimentalUseMTLSAliasOptions`](ExperimentalUseMTLSAliasOptions.md)
+
+  ↳ **`UserInfoRequestOptions`**
diff --git a/patches/typedoc-plugin-markdown+3.17.1.patch b/patches/typedoc-plugin-markdown+3.17.1.patch
@@ -44,7 +44,7 @@ index e332374..1ecd370 100644
          }
          return md.length > 0 ? md.join('\n') : null;
 diff --git a/node_modules/typedoc-plugin-markdown/dist/resources/partials/member.declaration.hbs b/node_modules/typedoc-plugin-markdown/dist/resources/partials/member.declaration.hbs
-index 1ca0b74..2bc3b47 100755
+index 1ca0b74..ac61b79 100755
 --- a/node_modules/typedoc-plugin-markdown/dist/resources/partials/member.declaration.hbs
 +++ b/node_modules/typedoc-plugin-markdown/dist/resources/partials/member.declaration.hbs
 @@ -14,58 +14,4 @@
@@ -106,6 +106,7 @@ index 1ca0b74..2bc3b47 100755
 -{{/if}}
 -
  {{> member.sources}}
+\ No newline at end of file
 diff --git a/node_modules/typedoc-plugin-markdown/dist/resources/partials/member.sources.hbs b/node_modules/typedoc-plugin-markdown/dist/resources/partials/member.sources.hbs
 index a999ee8..3f11cfe 100755
 --- a/node_modules/typedoc-plugin-markdown/dist/resources/partials/member.sources.hbs
@@ -153,7 +154,7 @@ index ba8e5be..6a4e1d3 100644
 \ No newline at end of file
 +[💗 Help the project](https://github.com/sponsors/panva)
 diff --git a/node_modules/typedoc-plugin-markdown/dist/resources/templates/reflection.hbs b/node_modules/typedoc-plugin-markdown/dist/resources/templates/reflection.hbs
-index ce29bc5..471fe38 100755
+index ce29bc5..ef5d6f8 100755
 --- a/node_modules/typedoc-plugin-markdown/dist/resources/templates/reflection.hbs
 +++ b/node_modules/typedoc-plugin-markdown/dist/resources/templates/reflection.hbs
 @@ -24,18 +24,6 @@
@@ -175,3 +176,19 @@ index ce29bc5..471fe38 100755
  {{#if model.implementedTypes}}
 
  ## Implements
+@@ -97,3 +85,15 @@
+ {{> main}}
+
+ {{/with}}
++
++{{#ifShowTypeHierarchy}}
++
++## Hierarchy
++
++{{#with model.typeHierarchy}}
++
++{{{hierarchy 0}}}
++
++{{/with}}
++
++{{/ifShowTypeHierarchy}}