Skip to content

Commit 4618d00

Browse files
committed
chore: bump typedoc and typescript
1 parent 2e41ad5 commit 4618d00

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+400
-353
lines changed

conformance/runner.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ export const flow = (options?: MacroOptions) => {
312312
clientAuth,
313313
{
314314
execute,
315+
// @ts-ignore
315316
[client.customFetch]:
316317
mtlsAuth || mtlsConstrain || metadata.use_mtls_endpoint_aliases
317318
? mtlsFetch
@@ -328,6 +329,7 @@ export const flow = (options?: MacroOptions) => {
328329
clientAuth,
329330
{
330331
execute,
332+
// @ts-ignore
331333
[client.customFetch]:
332334
mtlsAuth || mtlsConstrain || metadata.use_mtls_endpoint_aliases
333335
? mtlsFetch

docs/classes/Configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Configuration instances are obtained either through
1515
- (RECOMMENDED) the [discovery](../functions/discovery.md) function that discovers the
1616
[OAuth 2.0 Authorization Server metadata](../interfaces/ServerMetadata.md) using the
1717
Authorization Server's Issuer Identifier, or
18-
- The [Configuration](Configuration.md) constructor if the
18+
- The Configuration constructor if the
1919
[OAuth 2.0 Authorization Server metadata](../interfaces/ServerMetadata.md) is known
2020
upfront
2121

@@ -49,19 +49,19 @@ let config = new client.Configuration(server, clientId, clientSecret)
4949

5050
## Constructors
5151

52-
### new Configuration()
52+
### Constructor
5353

54-
**new Configuration**(`server`, `clientId`, `metadata`?, `clientAuthentication`?): [`Configuration`](Configuration.md)
54+
**new Configuration**(`server`, `clientId`, `metadata?`, `clientAuthentication?`): `Configuration`
5555

5656
#### Parameters
5757

5858
| Parameter | Type | Description |
5959
| ------ | ------ | ------ |
6060
| `server` | [`ServerMetadata`](../interfaces/ServerMetadata.md) | Authorization Server Metadata |
6161
| `clientId` | `string` | Client Identifier at the Authorization Server |
62-
| `metadata`? | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed it is a shorthand for passing just [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret). |
63-
| `clientAuthentication`? | [`ClientAuth`](../type-aliases/ClientAuth.md) | Implementation of the Client's Authentication Method at the Authorization Server. Default is [ClientSecretPost](../functions/ClientSecretPost.md) using the [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret). |
62+
| `metadata?` | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed it is a shorthand for passing just [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret). |
63+
| `clientAuthentication?` | [`ClientAuth`](../type-aliases/ClientAuth.md) | Implementation of the Client's Authentication Method at the Authorization Server. Default is [ClientSecretPost](../functions/ClientSecretPost.md) using the [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret). |
6464

6565
#### Returns
6666

67-
[`Configuration`](Configuration.md)
67+
`Configuration`

docs/classes/ResponseBodyError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Pragma: no-cache
2525

2626
### cause
2727

28-
**cause**: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `undefined` \| [`JsonValue`](../type-aliases/JsonValue.md)\>
28+
**cause**: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`JsonValue`](../type-aliases/JsonValue.md) \| `undefined`\>
2929

3030
The parsed JSON response body
3131

@@ -62,7 +62,7 @@ Error code given in the JSON response
6262
**response**: [`Response`](https://developer.mozilla.org/docs/Web/API/Response)
6363

6464
The "OAuth-style" error [Response](https://developer.mozilla.org/docs/Web/API/Response), its [Response.bodyUsed](https://developer.mozilla.org/docs/Web/API/Response/bodyUsed) is `true` and the JSON
65-
body is available in [ResponseBodyError.cause](ResponseBodyError.md#cause)
65+
body is available in [ResponseBodyError.cause](#cause)
6666

6767
***
6868

docs/functions/ClientSecretBasic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Support from the community to continue maintaining and improving this module is
66

77
***
88

9-
**ClientSecretBasic**(`clientSecret`?): [`ClientAuth`](../type-aliases/ClientAuth.md)
9+
**ClientSecretBasic**(`clientSecret?`): [`ClientAuth`](../type-aliases/ClientAuth.md)
1010

1111
**`client_secret_basic`** uses the HTTP `Basic` authentication scheme to send
1212
`client_id` and `client_secret` in an `Authorization` HTTP Header.
@@ -15,7 +15,7 @@ Support from the community to continue maintaining and improving this module is
1515

1616
| Parameter | Type | Description |
1717
| ------ | ------ | ------ |
18-
| `clientSecret`? | `string` | Client Secret |
18+
| `clientSecret?` | `string` | Client Secret |
1919

2020
## Returns
2121

docs/functions/ClientSecretJwt.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Support from the community to continue maintaining and improving this module is
66

77
***
88

9-
**ClientSecretJwt**(`clientSecret`?, `options`?): [`ClientAuth`](../type-aliases/ClientAuth.md)
9+
**ClientSecretJwt**(`clientSecret?`, `options?`): [`ClientAuth`](../type-aliases/ClientAuth.md)
1010

1111
**`client_secret_jwt`** uses the HTTP request body to send `client_id`,
1212
`client_assertion_type`, and `client_assertion` as
@@ -17,8 +17,8 @@ assertion's authenticity and integrity.
1717

1818
| Parameter | Type | Description |
1919
| ------ | ------ | ------ |
20-
| `clientSecret`? | `string` | Client Secret |
21-
| `options`? | [`ModifyAssertionOptions`](../interfaces/ModifyAssertionOptions.md) | |
20+
| `clientSecret?` | `string` | Client Secret |
21+
| `options?` | [`ModifyAssertionOptions`](../interfaces/ModifyAssertionOptions.md) | |
2222

2323
## Returns
2424

docs/functions/ClientSecretPost.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Support from the community to continue maintaining and improving this module is
66

77
***
88

9-
**ClientSecretPost**(`clientSecret`?): [`ClientAuth`](../type-aliases/ClientAuth.md)
9+
**ClientSecretPost**(`clientSecret?`): [`ClientAuth`](../type-aliases/ClientAuth.md)
1010

1111
**`client_secret_post`** uses the HTTP request body to send `client_id` and
1212
`client_secret` as `application/x-www-form-urlencoded` body parameters
@@ -15,7 +15,7 @@ Support from the community to continue maintaining and improving this module is
1515

1616
| Parameter | Type | Description |
1717
| ------ | ------ | ------ |
18-
| `clientSecret`? | `string` | Client Secret |
18+
| `clientSecret?` | `string` | Client Secret |
1919

2020
## Returns
2121

docs/functions/PrivateKeyJwt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Support from the community to continue maintaining and improving this module is
66

77
***
88

9-
**PrivateKeyJwt**(`clientPrivateKey`, `options`?): [`ClientAuth`](../type-aliases/ClientAuth.md)
9+
**PrivateKeyJwt**(`clientPrivateKey`, `options?`): [`ClientAuth`](../type-aliases/ClientAuth.md)
1010

1111
**`private_key_jwt`** uses the HTTP request body to send `client_id`,
1212
`client_assertion_type`, and `client_assertion` as
@@ -18,7 +18,7 @@ used for the assertion's authenticity and integrity.
1818
| Parameter | Type | Description |
1919
| ------ | ------ | ------ |
2020
| `clientPrivateKey` | [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`PrivateKey`](../interfaces/PrivateKey.md) | |
21-
| `options`? | [`ModifyAssertionOptions`](../interfaces/ModifyAssertionOptions.md) | - |
21+
| `options?` | [`ModifyAssertionOptions`](../interfaces/ModifyAssertionOptions.md) | - |
2222

2323
## Returns
2424

docs/functions/allowInsecureRequests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Function: ~~allowInsecureRequests()~~
1+
# Function: allowInsecureRequests()
22

33
[💗 Help the project](https://github.com/sponsors/panva)
44

docs/functions/authorizationCodeGrant.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Support from the community to continue maintaining and improving this module is
66

77
***
88

9-
**authorizationCodeGrant**(`config`, `currentUrl`, `checks`?, `tokenEndpointParameters`?, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`TokenEndpointResponse`](../interfaces/TokenEndpointResponse.md) & [`TokenEndpointResponseHelpers`](../interfaces/TokenEndpointResponseHelpers.md)\>
9+
**authorizationCodeGrant**(`config`, `currentUrl`, `checks?`, `tokenEndpointParameters?`, `options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`TokenEndpointResponse`](../interfaces/TokenEndpointResponse.md) & [`TokenEndpointResponseHelpers`](../interfaces/TokenEndpointResponseHelpers.md)\>
1010

1111
This method validates the authorization response and then executes the
1212
[Authorization Code Grant](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1) at the Authorization Server's
@@ -23,9 +23,9 @@ token. ID Token and Refresh Token are also optionally issued by the server.
2323
| ------ | ------ | ------ |
2424
| `config` | [`Configuration`](../classes/Configuration.md) | - |
2525
| `currentUrl` | [`URL`](https://developer.mozilla.org/docs/Web/API/URL) \| [`Request`](https://developer.mozilla.org/docs/Web/API/Request) | Current [URL](https://developer.mozilla.org/docs/Web/API/URL) the Authorization Server provided an Authorization Response to or a [Request](https://developer.mozilla.org/docs/Web/API/Request), the [Authorization Code Grant](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1) parameters are extracted from this. |
26-
| `checks`? | [`AuthorizationCodeGrantChecks`](../interfaces/AuthorizationCodeGrantChecks.md) | CSRF Protection checks like PKCE, expected state, or expected nonce |
27-
| `tokenEndpointParameters`? | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> \| [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | Additional parameters that will be sent to the token endpoint, typically used for parameters such as `resource` ([Resource Indicator](https://www.rfc-editor.org/rfc/rfc8707)) in cases where multiple resource indicators were requested but the authorization server only supports issuing an access token with a single audience |
28-
| `options`? | [`AuthorizationCodeGrantOptions`](../interfaces/AuthorizationCodeGrantOptions.md) | - |
26+
| `checks?` | [`AuthorizationCodeGrantChecks`](../interfaces/AuthorizationCodeGrantChecks.md) | CSRF Protection checks like PKCE, expected state, or expected nonce |
27+
| `tokenEndpointParameters?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> \| [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | Additional parameters that will be sent to the token endpoint, typically used for parameters such as `resource` ([Resource Indicator](https://www.rfc-editor.org/rfc/rfc8707)) in cases where multiple resource indicators were requested but the authorization server only supports issuing an access token with a single audience |
28+
| `options?` | [`AuthorizationCodeGrantOptions`](../interfaces/AuthorizationCodeGrantOptions.md) | - |
2929

3030
## Returns
3131

docs/functions/buildAuthorizationUrlWithJAR.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Support from the community to continue maintaining and improving this module is
66

77
***
88

9-
**buildAuthorizationUrlWithJAR**(`config`, `parameters`, `signingKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`URL`](https://developer.mozilla.org/docs/Web/API/URL)\>
9+
**buildAuthorizationUrlWithJAR**(`config`, `parameters`, `signingKey`, `options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`URL`](https://developer.mozilla.org/docs/Web/API/URL)\>
1010

1111
Returns a URL to redirect the user-agent to, in order to request
1212
authorization at the Authorization Server with a prior step of using
@@ -23,7 +23,7 @@ authorization at the Authorization Server with a prior step of using
2323
| `config` | [`Configuration`](../classes/Configuration.md) | - |
2424
| `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 a [JAR](https://www.rfc-editor.org/rfc/rfc9101.html) Request Object |
2525
| `signingKey` | [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`PrivateKey`](../interfaces/PrivateKey.md) | Key to sign the JAR Request Object with. |
26-
| `options`? | [`ModifyAssertionOptions`](../interfaces/ModifyAssertionOptions.md) | - |
26+
| `options?` | [`ModifyAssertionOptions`](../interfaces/ModifyAssertionOptions.md) | - |
2727

2828
## Returns
2929

0 commit comments

Comments
 (0)