docs: re-run docs

panva · Feb 6, 2025 · 17b531a · 17b531a
1 parent db9fd94
commit 17b531a
Show file tree

Hide file tree

Showing 23 changed files with 35 additions and 35 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -28,7 +28,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Advanced Configuration
 
-- [allowInsecureRequests](functions/allowInsecureRequests.md)
+- [~~allowInsecureRequests~~](functions/allowInsecureRequests.md)
 - [enableDecryptingResponses](functions/enableDecryptingResponses.md)
 - [enableDetachedSignatureResponseChecks](functions/enableDetachedSignatureResponseChecks.md)
 - [enableNonRepudiationChecks](functions/enableNonRepudiationChecks.md)
@@ -141,5 +141,5 @@ Support from the community to continue maintaining and improving this module is
 - [clockTolerance](variables/clockTolerance.md)
 - [customFetch](variables/customFetch.md)
 - [modifyAssertion](variables/modifyAssertion.md)
-- [skipStateCheck](variables/skipStateCheck.md)
-- [skipSubjectCheck](variables/skipSubjectCheck.md)
+- [~~skipStateCheck~~](variables/skipStateCheck.md)
+- [~~skipSubjectCheck~~](variables/skipSubjectCheck.md)
diff --git a/docs/classes/Configuration.md b/docs/classes/Configuration.md
@@ -59,7 +59,7 @@ let config = new client.Configuration(server, clientId, clientSecret)
 | ------ | ------ | ------ |
 | `server` | [`ServerMetadata`](../interfaces/ServerMetadata.md) | Authorization Server Metadata |
 | `clientId` | `string` | Client Identifier at the Authorization Server |
-| `metadata`? | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed in it is a shorthand for passing just [ClientMetadata.client_secret](../interfaces/ClientMetadata.md#client_secret). |
+| `metadata`? | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed in it is a shorthand for passing just [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret). |
 | `clientAuthentication`? | [`ClientAuth`](../type-aliases/ClientAuth.md) | Implementation of the Client's Authentication Method at the Authorization Server. |
 
 #### Returns

diff --git a/docs/functions/TlsClientAuth.md b/docs/functions/TlsClientAuth.md
@@ -11,7 +11,7 @@ Support from the community to continue maintaining and improving this module is
 **`tls_client_auth`** uses the HTTP request body to send only `client_id` as
 `application/x-www-form-urlencoded` body parameter and the mTLS key and
 certificate is configured through
-[ClientMetadata.use_mtls_endpoint_aliases](../interfaces/ClientMetadata.md#use_mtls_endpoint_aliases) and [customFetch](../variables/customFetch.md).
+[ClientMetadata.use\_mtls\_endpoint\_aliases](../interfaces/ClientMetadata.md#use_mtls_endpoint_aliases) and [customFetch](../variables/customFetch.md).
 
 ## Returns
 

diff --git a/docs/functions/buildAuthorizationUrl.md b/docs/functions/buildAuthorizationUrl.md
@@ -20,7 +20,7 @@ must be configured.
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `config` | [`Configuration`](../classes/Configuration.md) | - |
-| `parameters` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> \| [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | Authorization request parameters that will be sent to PAR |
+| `parameters` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> \| [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | Authorization request parameters that will be encoded in the querystring of the URL |
 
 ## Returns
 

diff --git a/docs/functions/discovery.md b/docs/functions/discovery.md
@@ -31,7 +31,7 @@ NOT RECOMMENDED as it disables the [ServerMetadata.issuer](../interfaces/ServerM
 | ------ | ------ | ------ |
 | `server` | [`URL`](https://developer.mozilla.org/docs/Web/API/URL) | URL representation of the Authorization Server's Issuer Identifier |
 | `clientId` | `string` | Client Identifier at the Authorization Server |
-| `metadata`? | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed in it is a shorthand for passing just [ClientMetadata.client_secret](../interfaces/ClientMetadata.md#client_secret) |
+| `metadata`? | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed in it is a shorthand for passing just [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret) |
 | `clientAuthentication`? | [`ClientAuth`](../type-aliases/ClientAuth.md) | - |
 | `options`? | [`DiscoveryRequestOptions`](../interfaces/DiscoveryRequestOptions.md) |  |
 

diff --git a/docs/functions/enableNonRepudiationChecks.md b/docs/functions/enableNonRepudiationChecks.md
@@ -9,7 +9,7 @@ Support from the community to continue maintaining and improving this module is
 ▸ **enableNonRepudiationChecks**(`config`): `void`
 
 Enables validating the JWS Signature of either a JWT [Response.body](https://developer.mozilla.org/docs/Web/API/Response/body) or
-[TokenEndpointResponse.id_token](../interfaces/TokenEndpointResponse.md#id_token) of a processed [Response](https://developer.mozilla.org/docs/Web/API/Response) such as
+[TokenEndpointResponse.id\_token](../interfaces/TokenEndpointResponse.md#id_token) of a processed [Response](https://developer.mozilla.org/docs/Web/API/Response) such as
 JWT UserInfo or JWT Introspection responses.
 
 Note: Validating signatures of JWTs received via direct communication between

diff --git a/docs/functions/getDPoPHandle.md b/docs/functions/getDPoPHandle.md
@@ -13,11 +13,11 @@ negotiating and proving proof-of-possession to sender-constrain OAuth 2.0
 tokens via [DPoP](https://www.rfc-editor.org/rfc/rfc9449.html) at the Authorization Server and Resource Server.
 
 Support for [DPoP](https://www.rfc-editor.org/rfc/rfc9449.html) at the authorization is indicated by
-[ServerMetadata.dpop_signing_alg_values_supported](../interfaces/ServerMetadata.md#dpop_signing_alg_values_supported). Whether the
+[ServerMetadata.dpop\_signing\_alg\_values\_supported](../interfaces/ServerMetadata.md#dpop_signing_alg_values_supported). Whether the
 authorization server ends up sender-constraining the access token is at the
 server's discretion. When an access token is sender-constrained then the
 resulting
-[`token_type` will be `dpop`](../interfaces/TokenEndpointResponse.md#token_type).
+[\`token\_type\` will be \`dpop\`](../interfaces/TokenEndpointResponse.md#token_type).
 
 This wrapper / handle also keeps track of server-issued nonces, allowing this
 module to automatically retry requests with a fresh nonce when the server

diff --git a/docs/interfaces/AuthorizationCodeGrantChecks.md b/docs/interfaces/AuthorizationCodeGrantChecks.md
@@ -45,10 +45,10 @@ Note: When `expectedNonce` or `maxAge` is used this has no effect.
 
 • `optional` **maxAge**: `number`
 
-ID Token [`auth_time`](IDToken.md#auth_time) claim value will be checked
+ID Token [\`auth\_time\`](IDToken.md#auth_time) claim value will be checked
 to be present and conform to this `maxAge` value. Use of this option is
 required if you sent a `max_age` parameter in the authorization request.
-Default is [ClientMetadata.default_max_age](ClientMetadata.md#default_max_age) and falls back to not
+Default is [ClientMetadata.default\_max\_age](ClientMetadata.md#default_max_age) and falls back to not
 checking the claim's value beyond it being a number when present.
 
 ***

diff --git a/docs/interfaces/AuthorizationDetails.md b/docs/interfaces/AuthorizationDetails.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`parameter`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`parameter`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/ClientMetadata.md b/docs/interfaces/ClientMetadata.md
@@ -12,7 +12,7 @@ that has an effect on how the Client functions
 
 ## Indexable
 
- \[`metadata`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`metadata`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 
@@ -46,7 +46,7 @@ See [clockTolerance](../variables/clockTolerance.md).
 
 JWS `alg` algorithm required for signing authorization responses. When not configured the
 default is to allow only algorithms listed in
-[`as.authorization_signing_alg_values_supported`](ServerMetadata.md#authorization_signing_alg_values_supported)
+[\`as.authorization\_signing\_alg\_values\_supported\`](ServerMetadata.md#authorization_signing_alg_values_supported)
 and fall back to `RS256` when the authorization server metadata is not set.
 
 ***
@@ -73,7 +73,7 @@ Default Maximum Authentication Age.
 
 JWS `alg` algorithm required for signing the ID Token issued to this Client. When not
 configured the default is to allow only algorithms listed in
-[`as.id_token_signing_alg_values_supported`](ServerMetadata.md#id_token_signing_alg_values_supported)
+[\`as.id\_token\_signing\_alg\_values\_supported\`](ServerMetadata.md#id_token_signing_alg_values_supported)
 and fall back to `RS256` when the authorization server metadata is not set.
 
 ***
@@ -84,7 +84,7 @@ and fall back to `RS256` when the authorization server metadata is not set.
 
 JWS `alg` algorithm REQUIRED for signed introspection responses. When not configured the
 default is to allow only algorithms listed in
-[`as.introspection_signing_alg_values_supported`](ServerMetadata.md#introspection_signing_alg_values_supported)
+[\`as.introspection\_signing\_alg\_values\_supported\`](ServerMetadata.md#introspection_signing_alg_values_supported)
 and fall back to `RS256` when the authorization server metadata is not set.
 
 ***
@@ -93,7 +93,7 @@ and fall back to `RS256` when the authorization server metadata is not set.
 
 • `optional` **require\_auth\_time**: `boolean`
 
-Boolean value specifying whether the [`auth_time`](IDToken.md#auth_time) Claim in the ID Token
+Boolean value specifying whether the [\`auth\_time\`](IDToken.md#auth_time) Claim in the ID Token
 is REQUIRED. Default is `false`.
 
 ***
@@ -160,5 +160,5 @@ config[client.customFetch] = (...args) =>
 
 JWS `alg` algorithm REQUIRED for signing UserInfo Responses. When not configured the default is
 to allow only algorithms listed in
-[`as.userinfo_signing_alg_values_supported`](ServerMetadata.md#userinfo_signing_alg_values_supported)
+[\`as.userinfo\_signing\_alg\_values\_supported\`](ServerMetadata.md#userinfo_signing_alg_values_supported)
 and fail otherwise.
diff --git a/docs/interfaces/ConfirmationClaims.md b/docs/interfaces/ConfirmationClaims.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/DeviceAuthorizationResponse.md b/docs/interfaces/DeviceAuthorizationResponse.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`parameter`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`parameter`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/IDToken.md b/docs/interfaces/IDToken.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/IntrospectionResponse.md b/docs/interfaces/IntrospectionResponse.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/JWK.md b/docs/interfaces/JWK.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`parameter`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`parameter`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/MTLSEndpointAliases.md b/docs/interfaces/MTLSEndpointAliases.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`metadata`: `string`\]: `undefined` \| `string`
+\[`metadata`: `string`\]: `undefined` \| `string`
 
 ## Properties
 

diff --git a/docs/interfaces/ServerMetadata.md b/docs/interfaces/ServerMetadata.md
@@ -14,7 +14,7 @@ Authorization Server Metadata
 
 ## Indexable
 
- \[`metadata`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`metadata`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/TokenEndpointResponse.md b/docs/interfaces/TokenEndpointResponse.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`parameter`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`parameter`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/TokenEndpointResponseHelpers.md b/docs/interfaces/TokenEndpointResponseHelpers.md
@@ -15,11 +15,11 @@ Helpers attached to any resolved [TokenEndpointResponse](TokenEndpointResponse.m
 ▸ **claims**(): `undefined` \| [`IDToken`](IDToken.md)
 
 Returns the parsed JWT Claims Set of an
-[id_token](TokenEndpointResponse.md#id_token) returned by the
+[id\_token](TokenEndpointResponse.md#id_token) returned by the
 authorization server
 
 Note: Returns `undefined` when
-[expires_in](TokenEndpointResponse.md#expires_in) was not returned by the
+[expires\_in](TokenEndpointResponse.md#expires_in) was not returned by the
 authorization server
 
 #### Returns
@@ -33,12 +33,12 @@ authorization server
 ▸ **expiresIn**(): `undefined` \| `number`
 
 Returns the number of seconds until the
-[access_token](TokenEndpointResponse.md#access_token) expires
+[access\_token](TokenEndpointResponse.md#access_token) expires
 
 Note: Returns `0` when already expired
 
 Note: Returns `undefined` when
-[expires_in](TokenEndpointResponse.md#expires_in) was not returned by the
+[expires\_in](TokenEndpointResponse.md#expires_in) was not returned by the
 authorization server
 
 #### Returns

diff --git a/docs/interfaces/UserInfoAddress.md b/docs/interfaces/UserInfoAddress.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/UserInfoResponse.md b/docs/interfaces/UserInfoResponse.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
+\[`claim`: `string`\]: `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)
 
 ## Properties
 

diff --git a/docs/interfaces/WWWAuthenticateChallengeParameters.md b/docs/interfaces/WWWAuthenticateChallengeParameters.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 ## Indexable
 
- \[`parameter`: [`Lowercase`](https://www.typescriptlang.org/docs/handbook/2/template-literal-types.html#lowercasestringtype)\<`string`\>\]: `undefined` \| `string`
+\[`parameter`: [`Lowercase`](https://www.typescriptlang.org/docs/handbook/2/template-literal-types.html#lowercasestringtype)\<`string`\>\]: `undefined` \| `string`
 
 ## Properties
 

diff --git a/docs/type-aliases/ClientAuth.md b/docs/type-aliases/ClientAuth.md
@@ -11,7 +11,7 @@ Support from the community to continue maintaining and improving this module is
 Implementation of the Client's Authentication Method at the Authorization
 Server.
 
-The default is [ClientSecretPost](../functions/ClientSecretPost.md) if [ClientMetadata.client_secret](../interfaces/ClientMetadata.md#client_secret)
+The default is [ClientSecretPost](../functions/ClientSecretPost.md) if [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret)
 is present, [None](../functions/None.md) otherwise.
 
 Other Client Authentication Methods must be provided explicitly and their