docs: use GitHub Flavored Markdown for notes and warnings

panva · panva · commit a2482c71f8de · 2025-05-28T11:12:17.000+02:00
diff --git a/docs/functions/authorizationCodeGrant.md b/docs/functions/authorizationCodeGrant.md
@@ -13,9 +13,9 @@ This method validates the authorization response and then executes the
 [token endpoint](../interfaces/ServerMetadata.md#token_endpoint) to obtain an access
 token. ID Token and Refresh Token are also optionally issued by the server.
 
-Note:
-[URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/buildAuthorizationUrl.md b/docs/functions/buildAuthorizationUrl.md
@@ -11,12 +11,13 @@ Support from the community to continue maintaining and improving this module is
 Returns a URL to redirect the user-agent to, in order to request
 authorization at the Authorization Server
 
-Note:
-[URL of the authorization server's authorization endpoint](../interfaces/ServerMetadata.md#authorization_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's authorization endpoint](../interfaces/ServerMetadata.md#authorization_endpoint)
+> must be configured.
 
-Note: When used, PKCE code challenge, state, and nonce parameter values must
-always be random and be tied to the user-agent.
+> [!NOTE]\
+> When used, PKCE code challenge, state, and nonce parameter values must always
+> be random and be tied to the user-agent.
 
 ## Parameters
 
diff --git a/docs/functions/buildAuthorizationUrlWithJAR.md b/docs/functions/buildAuthorizationUrlWithJAR.md
@@ -12,9 +12,9 @@ Returns a URL to redirect the user-agent to, in order to request
 authorization at the Authorization Server with a prior step of using
 [JAR](https://www.rfc-editor.org/rfc/rfc9101.html)
 
-Note:
-[URL of the authorization server's authorization endpoint](../interfaces/ServerMetadata.md#authorization_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's authorization endpoint](../interfaces/ServerMetadata.md#authorization_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/buildAuthorizationUrlWithPAR.md b/docs/functions/buildAuthorizationUrlWithPAR.md
@@ -12,13 +12,13 @@ Returns a URL to redirect the user-agent to, in order to request
 authorization at the Authorization Server with a prior step of using
 [PAR](https://www.rfc-editor.org/rfc/rfc9126.html)
 
-Note:
-[URL of the authorization server's authorization endpoint](../interfaces/ServerMetadata.md#authorization_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's authorization endpoint](../interfaces/ServerMetadata.md#authorization_endpoint)
+> must be configured.
 
-Note:
-[URL of the authorization server's pushed authorization request endpoint](../interfaces/ServerMetadata.md#pushed_authorization_request_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's pushed authorization request endpoint](../interfaces/ServerMetadata.md#pushed_authorization_request_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/buildEndSessionUrl.md b/docs/functions/buildEndSessionUrl.md
@@ -12,9 +12,9 @@ Returns a URL to redirect the user-agent to after they log out to trigger
 [RP-Initiated Logout](https://openid.net/specs/openid-connect-rpinitiated-1_0-final.html#RPLogout)
 at the Authorization Server.
 
-Note:
-[URL of the authorization server's end session endpoint](../interfaces/ServerMetadata.md#end_session_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's end session endpoint](../interfaces/ServerMetadata.md#end_session_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/clientCredentialsGrant.md b/docs/functions/clientCredentialsGrant.md
@@ -12,9 +12,9 @@ Performs an OAuth 2.0 [Client Credentials Grant](https://datatracker.ietf.org/do
 Server's [token endpoint](../interfaces/ServerMetadata.md#token_endpoint) using parameters
 from the `parameters` argument
 
-Note:
-[URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/discovery.md b/docs/functions/discovery.md
@@ -19,11 +19,12 @@ This has the same effect as calling the [Configuration](../classes/Configuration
 except that the server metadata is discovered from its own Authorization
 Server Metadata discovery document.
 
-Note: This method also accepts a URL pointing directly to the Authorization
-Server's discovery document, doing so is merely a shorthand for using
-[fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) and passing the discovered JSON metadata (as
-[ServerMetadata](../interfaces/ServerMetadata.md)) into the [Configuration](../classes/Configuration.md) constructor. Doing so is
-NOT RECOMMENDED as it disables the [ServerMetadata.issuer](../interfaces/ServerMetadata.md#issuer) validation.
+> [!NOTE]\
+> This method also accepts a URL pointing directly to the Authorization
+> Server's discovery document, doing so is merely a shorthand for using
+> [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) and passing the discovered JSON metadata (as
+> [ServerMetadata](../interfaces/ServerMetadata.md)) into the [Configuration](../classes/Configuration.md) constructor. Doing so is
+> NOT RECOMMENDED as it disables the [ServerMetadata.issuer](../interfaces/ServerMetadata.md#issuer) validation.
 
 ## Parameters
 
diff --git a/docs/functions/dynamicClientRegistration.md b/docs/functions/dynamicClientRegistration.md
@@ -13,15 +13,17 @@ Client Registration at the discovered Authorization Server's
 [ServerMetadata.registration\_endpoint](../interfaces/ServerMetadata.md#registration_endpoint) using the provided client
 metadata.
 
-Note: This method also accepts a URL pointing directly to the Authorization
-Server's discovery document. Doing so is NOT RECOMMENDED as it disables the
-[ServerMetadata.issuer](../interfaces/ServerMetadata.md#issuer) validation.
-
-Note: The method does not contain any logic to default the registered
-"token_endpoint_auth_method" based on
-[ServerMetadata.token\_endpoint\_auth\_methods\_supported](../interfaces/ServerMetadata.md#token_endpoint_auth_methods_supported), nor does it
-default the "clientAuthentication" argument value beyond what its description
-says.
+> [!NOTE]\
+> This method also accepts a URL pointing directly to the Authorization
+> Server's discovery document. Doing so is NOT RECOMMENDED as it disables the
+> [ServerMetadata.issuer](../interfaces/ServerMetadata.md#issuer) validation.
+
+> [!NOTE]\
+> The method does not contain any logic to default the registered
+> "token_endpoint_auth_method" based on
+> [ServerMetadata.token\_endpoint\_auth\_methods\_supported](../interfaces/ServerMetadata.md#token_endpoint_auth_methods_supported), nor does it
+> default the "clientAuthentication" argument value beyond what its description
+> says.
 
 ## Parameters
 
diff --git a/docs/functions/enableDecryptingResponses.md b/docs/functions/enableDecryptingResponses.md
@@ -24,7 +24,8 @@ The following JWE Key Management Algorithms are supported
 - RSA-OAEP-384
 - RSA-OAEP-512
 
-Note: ECDH algorithms only allow P-256 or X25519 key curve to be used
+> [!NOTE]\
+> ECDH algorithms only allow P-256 or X25519 key curve to be used
 
 The following JWE Content Encryption Algorithms are supported
 
diff --git a/docs/functions/enableNonRepudiationChecks.md b/docs/functions/enableNonRepudiationChecks.md
@@ -12,18 +12,20 @@ Enables validating the JWS Signature of either a JWT [Response.body](https://dev
 [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
-the client and a TLS-secured endpoint (which it is here) is not mandatory
-since the TLS server validation is used to validate the issuer instead of
-checking the token signature. You only need to use this method for
-non-repudiation purposes.
-
-Note:
-[URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
-must be configured.
-
-Note: Supports only digital signatures using
-[these supported JWS Algorithms](../type-aliases/JWSAlgorithm.md).
+> [!NOTE]\
+> Validating signatures of JWTs received via direct communication between the
+> client and a TLS-secured endpoint (which it is here) is not mandatory since
+> the TLS server validation is used to validate the issuer instead of checking
+> the token signature. You only need to use this method for non-repudiation
+> purposes.
+
+> [!NOTE]\
+> [URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
+> must be configured.
+
+> [!NOTE]\
+> Supports only digital signatures using
+> [these supported JWS Algorithms](../type-aliases/JWSAlgorithm.md).
 
 ## Parameters
 
diff --git a/docs/functions/fetchUserInfo.md b/docs/functions/fetchUserInfo.md
@@ -15,9 +15,9 @@ parsed UserInfo claims from either its JSON or JWT response.
 Authorization Header is used to transmit the Access Token value. No other
 Access Token means of transport are supported.
 
-Note:
-[URL of authorization server's UserInfo endpoint](../interfaces/ServerMetadata.md#userinfo_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of authorization server's UserInfo endpoint](../interfaces/ServerMetadata.md#userinfo_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/genericGrantRequest.md b/docs/functions/genericGrantRequest.md
@@ -13,9 +13,9 @@ Performs any Grant request at the
 able to execute grant requests such as Token Exchange Grant, JWT Bearer Token
 Grant, SAML 2.0 Bearer Assertion Grant, or any other grant.
 
-Note:
-[URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/getDPoPHandle.md b/docs/functions/getDPoPHandle.md
@@ -23,8 +23,9 @@ This wrapper / handle also keeps track of server-issued nonces, allowing this
 module to automatically retry requests with a fresh nonce when the server
 indicates the need to use one.
 
-Note: Public Clients that use DPoP will also get their Refresh Token
-sender-constrained, this binding is not indicated in the response.
+> [!NOTE]\
+> Public Clients that use DPoP will also get their Refresh Token
+> sender-constrained, this binding is not indicated in the response.
 
 ## Parameters
 
diff --git a/docs/functions/getJwksCache.md b/docs/functions/getJwksCache.md
@@ -17,9 +17,10 @@ This function is intended for cloud computing runtimes that cannot keep an in
 memory cache between their code's invocations. Use in runtimes where an in
 memory cache between requests is available is not desirable.
 
-Note: the client only uses the authorization server's JWK Set when
-[enableNonRepudiationChecks](enableNonRepudiationChecks.md), [useJwtResponseMode](useJwtResponseMode.md),
-[useCodeIdTokenResponseType](useCodeIdTokenResponseType.md), or [useIdTokenResponseType](useIdTokenResponseType.md) is used.
+> [!NOTE]\
+> The client only uses the authorization server's JWK Set when
+> [enableNonRepudiationChecks](enableNonRepudiationChecks.md), [useJwtResponseMode](useJwtResponseMode.md),
+> [useCodeIdTokenResponseType](useCodeIdTokenResponseType.md), or [useIdTokenResponseType](useIdTokenResponseType.md) is used.
 
 ## Parameters
 
diff --git a/docs/functions/implicitAuthentication.md b/docs/functions/implicitAuthentication.md
@@ -12,12 +12,13 @@ This method validates the authorization server's
 [Implicit Authentication Flow](https://openid.net/specs/openid-connect-core-1_0-errata2.html#ImplicitFlowAuth)
 Response.
 
-Note:
-[URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
+> must be configured.
 
-Note: Only `response_type=id_token` responses are supported and prior use of
-[useIdTokenResponseType](useIdTokenResponseType.md) is required.
+> [!NOTE]\
+> Only `response_type=id_token` responses are supported and prior use of
+> [useIdTokenResponseType](useIdTokenResponseType.md) is required.
 
 ## Parameters
 
diff --git a/docs/functions/initiateBackchannelAuthentication.md b/docs/functions/initiateBackchannelAuthentication.md
@@ -11,9 +11,9 @@ Support from the community to continue maintaining and improving this module is
 Initiates a [Client-Initiated Backchannel Authentication Grant](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0-final.html) using
 parameters from the `parameters` argument.
 
-Note:
-[URL of the authorization server's backchannel authentication endpoint](../interfaces/ServerMetadata.md#backchannel_authentication_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's backchannel authentication endpoint](../interfaces/ServerMetadata.md#backchannel_authentication_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/initiateDeviceAuthorization.md b/docs/functions/initiateDeviceAuthorization.md
@@ -11,9 +11,9 @@ Support from the community to continue maintaining and improving this module is
 Initiates a [Device Authorization Grant](https://www.rfc-editor.org/rfc/rfc8628.html) using parameters from the
 `parameters` argument.
 
-Note:
-[URL of the authorization server's device authorization endpoint](../interfaces/ServerMetadata.md#device_authorization_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's device authorization endpoint](../interfaces/ServerMetadata.md#device_authorization_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/pollBackchannelAuthenticationGrant.md b/docs/functions/pollBackchannelAuthenticationGrant.md
@@ -12,9 +12,9 @@ Continuously polls the [token endpoint](../interfaces/ServerMetadata.md#token_en
 until the end-user finishes the
 [Client-Initiated Backchannel Authentication Grant](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0-final.html) process
 
-Note:
-[URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/pollDeviceAuthorizationGrant.md b/docs/functions/pollDeviceAuthorizationGrant.md
@@ -12,9 +12,9 @@ Continuously polls the [token endpoint](../interfaces/ServerMetadata.md#token_en
 until the end-user finishes the [Device Authorization Grant](https://www.rfc-editor.org/rfc/rfc8628.html) process
 on their secondary device
 
-Note:
-[URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/refreshTokenGrant.md b/docs/functions/refreshTokenGrant.md
@@ -13,9 +13,9 @@ Server's [token endpoint](../interfaces/ServerMetadata.md#token_endpoint) using
 from the `parameters` argument, allowing a client to obtain a new access
 token using a valid refresh token.
 
-Note:
-[URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's token endpoint](../interfaces/ServerMetadata.md#token_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/setJwksCache.md b/docs/functions/setJwksCache.md
@@ -8,9 +8,10 @@ Support from the community to continue maintaining and improving this module is
 
 ▸ **setJwksCache**(`config`, `jwksCache`): `void`
 
-DANGER ZONE - Use of this function has security implications that must be
-understood, assessed for applicability, and accepted before use. It is
-critical that the JSON Web Key Set cache only be writable by your own code.
+> [!WARNING]\
+> Use of this function has security implications that must be understood,
+> assessed for applicability, and accepted before use. It is critical that the
+> JSON Web Key Set cache only be writable by your own code.
 
 This option is intended for cloud computing runtimes that cannot keep an in
 memory cache between their code's invocations. Use in runtimes where an in
diff --git a/docs/functions/tokenIntrospection.md b/docs/functions/tokenIntrospection.md
@@ -13,9 +13,9 @@ Queries the
 obtain the status and metadata of a given token. The range of metadata
 returned is at the discretion of the authorization server.
 
-Note:
-[URL of the authorization server's token introspection endpoint](../interfaces/ServerMetadata.md#introspection_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's token introspection endpoint](../interfaces/ServerMetadata.md#introspection_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/tokenRevocation.md b/docs/functions/tokenRevocation.md
@@ -13,9 +13,9 @@ Attempts revocation of an OAuth 2.0 token by making a request to the
 the token gets revoked, and the effect of that revocation is at the
 discretion of the authorization server.
 
-Note:
-[URL of the authorization server's token revocation endpoint](../interfaces/ServerMetadata.md#revocation_endpoint)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's token revocation endpoint](../interfaces/ServerMetadata.md#revocation_endpoint)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/useCodeIdTokenResponseType.md b/docs/functions/useCodeIdTokenResponseType.md
@@ -13,9 +13,9 @@ expects the authorization server response passed to
 [authorizationCodeGrant](authorizationCodeGrant.md) to be one described by
 [OpenID Connect 1.0 Hybrid Flow](https://openid.net/specs/openid-connect-core-1_0-errata2.html#HybridFlowAuth).
 
-Note:
-[URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/useIdTokenResponseType.md b/docs/functions/useIdTokenResponseType.md
@@ -14,9 +14,9 @@ subsequently requires that the authorization server response be passed to
 for it to be one described by
 [OpenID Connect 1.0 Implicit Flow](https://openid.net/specs/openid-connect-core-1_0-errata2.html#ImplicitFlowAuth).
 
-Note:
-[URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/functions/useJwtResponseMode.md b/docs/functions/useJwtResponseMode.md
@@ -12,9 +12,9 @@ This changes the `response_mode` used by the client to be `jwt` and expects
 the authorization server response passed to [authorizationCodeGrant](authorizationCodeGrant.md) to
 be one described by [JARM](https://openid.net/specs/oauth-v2-jarm-final.html).
 
-Note:
-[URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
-must be configured.
+> [!NOTE]\
+> [URL of the authorization server's JWK Set document](../interfaces/ServerMetadata.md#jwks_uri)
+> must be configured.
 
 ## Parameters
 
diff --git a/docs/interfaces/AuthorizationCodeGrantChecks.md b/docs/interfaces/AuthorizationCodeGrantChecks.md
diff --git a/docs/interfaces/DiscoveryRequestOptions.md b/docs/interfaces/DiscoveryRequestOptions.md
diff --git a/docs/interfaces/DynamicClientRegistrationRequestOptions.md b/docs/interfaces/DynamicClientRegistrationRequestOptions.md
diff --git a/docs/interfaces/TokenEndpointResponseHelpers.md b/docs/interfaces/TokenEndpointResponseHelpers.md
diff --git a/docs/variables/skipStateCheck.md b/docs/variables/skipStateCheck.md
diff --git a/docs/variables/skipSubjectCheck.md b/docs/variables/skipSubjectCheck.md
diff --git a/src/index.ts b/src/index.ts
