diff --git a/docs/variables/clockSkew.md b/docs/variables/clockSkew.md index 9bdc7640..c4aaae95 100644 --- a/docs/variables/clockSkew.md +++ b/docs/variables/clockSkew.md @@ -2,4 +2,4 @@ [💗 Help the project](https://github.com/sponsors/panva) -• `Const` **clockSkew**: typeof [`clockSkew`](clockSkew.md) +• `Const` **clockSkew**: unique `symbol` diff --git a/docs/variables/clockTolerance.md b/docs/variables/clockTolerance.md index 49587f8f..fe5f5793 100644 --- a/docs/variables/clockTolerance.md +++ b/docs/variables/clockTolerance.md @@ -2,4 +2,4 @@ [💗 Help the project](https://github.com/sponsors/panva) -• `Const` **clockTolerance**: typeof [`clockTolerance`](clockTolerance.md) +• `Const` **clockTolerance**: unique `symbol` diff --git a/docs/variables/customFetch.md b/docs/variables/customFetch.md index 81c380a3..ce11e95a 100644 --- a/docs/variables/customFetch.md +++ b/docs/variables/customFetch.md @@ -2,7 +2,7 @@ [💗 Help the project](https://github.com/sponsors/panva) -• `Const` **customFetch**: typeof [`customFetch`](customFetch.md) +• `Const` **customFetch**: unique `symbol` When configured on an interface that extends [HttpRequestOptions](../interfaces/HttpRequestOptions.md), that's every `options` parameter for functions that trigger HTTP Requests, this replaces the use of global fetch. As a diff --git a/docs/variables/expectNoNonce.md b/docs/variables/expectNoNonce.md index 04ca233a..866f0b32 100644 --- a/docs/variables/expectNoNonce.md +++ b/docs/variables/expectNoNonce.md @@ -2,7 +2,7 @@ [💗 Help the project](https://github.com/sponsors/panva) -• `Const` **expectNoNonce**: typeof [`expectNoNonce`](expectNoNonce.md) +• `Const` **expectNoNonce**: unique `symbol` Use this as a value to [processAuthorizationCodeOpenIDResponse](../functions/processAuthorizationCodeOpenIDResponse.md) `expectedNonce` parameter to indicate no `nonce` ID Token claim value is expected, i.e. no `nonce` parameter value was sent diff --git a/docs/variables/expectNoState.md b/docs/variables/expectNoState.md index 49653645..79dea6aa 100644 --- a/docs/variables/expectNoState.md +++ b/docs/variables/expectNoState.md @@ -2,7 +2,7 @@ [💗 Help the project](https://github.com/sponsors/panva) -• `Const` **expectNoState**: typeof [`expectNoState`](expectNoState.md) +• `Const` **expectNoState**: unique `symbol` Use this as a value to [validateAuthResponse](../functions/validateAuthResponse.md) `expectedState` parameter to indicate no `state` parameter value is expected, i.e. no `state` parameter value was sent with the diff --git a/docs/variables/skipAuthTimeCheck.md b/docs/variables/skipAuthTimeCheck.md index 81180f92..091efc55 100644 --- a/docs/variables/skipAuthTimeCheck.md +++ b/docs/variables/skipAuthTimeCheck.md @@ -2,7 +2,7 @@ [💗 Help the project](https://github.com/sponsors/panva) -• `Const` **skipAuthTimeCheck**: typeof [`skipAuthTimeCheck`](skipAuthTimeCheck.md) +• `Const` **skipAuthTimeCheck**: unique `symbol` Use this as a value to [processAuthorizationCodeOpenIDResponse](../functions/processAuthorizationCodeOpenIDResponse.md) `maxAge` parameter to indicate no `auth_time` ID Token claim value check should be performed. diff --git a/docs/variables/skipStateCheck.md b/docs/variables/skipStateCheck.md index 24522ff9..04895380 100644 --- a/docs/variables/skipStateCheck.md +++ b/docs/variables/skipStateCheck.md @@ -2,7 +2,7 @@ [💗 Help the project](https://github.com/sponsors/panva) -• `Const` **skipStateCheck**: typeof [`skipStateCheck`](skipStateCheck.md) +• `Const` **skipStateCheck**: unique `symbol` DANGER ZONE diff --git a/docs/variables/skipSubjectCheck.md b/docs/variables/skipSubjectCheck.md index 534b8c46..d0a90732 100644 --- a/docs/variables/skipSubjectCheck.md +++ b/docs/variables/skipSubjectCheck.md @@ -2,7 +2,7 @@ [💗 Help the project](https://github.com/sponsors/panva) -• `Const` **skipSubjectCheck**: typeof [`skipSubjectCheck`](skipSubjectCheck.md) +• `Const` **skipSubjectCheck**: unique `symbol` DANGER ZONE diff --git a/docs/variables/useMtlsAlias.md b/docs/variables/useMtlsAlias.md index a845239a..501e7c93 100644 --- a/docs/variables/useMtlsAlias.md +++ b/docs/variables/useMtlsAlias.md @@ -2,7 +2,7 @@ [💗 Help the project](https://github.com/sponsors/panva) -• `Const` **useMtlsAlias**: typeof [`useMtlsAlias`](useMtlsAlias.md) +• `Const` **useMtlsAlias**: unique `symbol` When combined with [customFetch](customFetch.md) (to use a Fetch API implementation that supports client certificates) this can be used to target FAPI 2.0 profiles that utilize Mutual-TLS for either diff --git a/src/index.ts b/src/index.ts index f62b62fd..2e96ed88 100644 --- a/src/index.ts +++ b/src/index.ts @@ -194,8 +194,8 @@ interface JWK { readonly [parameter: string]: JsonValue | undefined } -export const clockSkew = Symbol() -export const clockTolerance = Symbol() +export const clockSkew: unique symbol = Symbol() +export const clockTolerance: unique symbol = Symbol() /** * When configured on an interface that extends {@link HttpRequestOptions}, that's every `options` @@ -280,7 +280,7 @@ export const clockTolerance = Symbol() * }) * ``` */ -export const customFetch = Symbol() +export const customFetch: unique symbol = Symbol() /** * When combined with {@link customFetch} (to use a Fetch API implementation that supports client @@ -344,7 +344,7 @@ export const customFetch = Symbol() * * @see [RFC 8705 - OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://www.rfc-editor.org/rfc/rfc8705.html) */ -export const useMtlsAlias = Symbol() +export const useMtlsAlias: unique symbol = Symbol() /** * Authorization Server Metadata @@ -2288,7 +2288,7 @@ async function getPublicSigKeyFromIssuerJwksUri( * * @see [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse) */ -export const skipSubjectCheck = Symbol() +export const skipSubjectCheck: unique symbol = Symbol() function getContentType(response: Response) { return response.headers.get('content-type')?.split(';')[0] @@ -2879,13 +2879,13 @@ export interface ClientCredentialsGrantResponse { * indicate no `nonce` ID Token claim value is expected, i.e. no `nonce` parameter value was sent * with the authorization request. */ -export const expectNoNonce = Symbol() +export const expectNoNonce: unique symbol = Symbol() /** * Use this as a value to {@link processAuthorizationCodeOpenIDResponse} `maxAge` parameter to * indicate no `auth_time` ID Token claim value check should be performed. */ -export const skipAuthTimeCheck = Symbol() +export const skipAuthTimeCheck: unique symbol = Symbol() /** * (OpenID Connect only) Validates Authorization Code Grant Response instance to be one coming from @@ -3904,14 +3904,14 @@ function getURLSearchParameter(parameters: URLSearchParams, name: string): strin * [draft-bradley-oauth-jwt-encoded-state-09](https://datatracker.ietf.org/doc/html/draft-bradley-oauth-jwt-encoded-state-09). * It is expected you'll validate such `state` value yourself. */ -export const skipStateCheck = Symbol() +export const skipStateCheck: unique symbol = Symbol() /** * Use this as a value to {@link validateAuthResponse} `expectedState` parameter to indicate no * `state` parameter value is expected, i.e. no `state` parameter value was sent with the * authorization request. */ -export const expectNoState = Symbol() +export const expectNoState: unique symbol = Symbol() /** * Validates an OAuth 2.0 Authorization Response or Authorization Error Response message returned