refactor: reorganize experimental features

panva · Jan 11, 2024 · c8479b4 · c8479b4
1 parent 6b6b496
commit c8479b4
Show file tree

Hide file tree

Showing 17 changed files with 215 additions and 164 deletions.
diff --git a/conformance/runner.ts b/conformance/runner.ts
@@ -162,9 +162,9 @@ export const green = test.macro({
     const httpOptions: oauth.ExperimentalUseMTLSAliasOptions = {}
 
     if (usesClientCert(plan.name, variant)) {
-      httpOptions[oauth.experimentalUseMtlsAlias] = true
+      httpOptions[oauth.experimental_useMtlsAlias] = true
       // @ts-expect-error
-      httpOptions[oauth.experimentalCustomFetch] = (...args) => {
+      httpOptions[oauth.experimental_customFetch] = (...args) => {
         return undici.fetch(args[0], {
           ...args[1],
           dispatcher: new undici.Agent({

diff --git a/docs/README.md b/docs/README.md
@@ -62,6 +62,12 @@
 - [OperationProcessingError](classes/OperationProcessingError.md)
 - [UnsupportedOperationError](classes/UnsupportedOperationError.md)
 
+### Experimental
+
+- [experimental\_customFetch](variables/experimental_customFetch.md)
+- [experimental\_useMtlsAlias](variables/experimental_useMtlsAlias.md)
+- [experimental\_validateDetachedSignatureResponse](functions/experimental_validateDetachedSignatureResponse.md)
+
 ### FAPI 1.0 Advanced
 
 - [experimental\_validateDetachedSignatureResponse](functions/experimental_validateDetachedSignatureResponse.md)
@@ -179,8 +185,6 @@
 - [clockTolerance](variables/clockTolerance.md)
 - [expectNoNonce](variables/expectNoNonce.md)
 - [expectNoState](variables/expectNoState.md)
-- [experimentalCustomFetch](variables/experimentalCustomFetch.md)
-- [experimentalUseMtlsAlias](variables/experimentalUseMtlsAlias.md)
 - [skipAuthTimeCheck](variables/skipAuthTimeCheck.md)
 - [skipStateCheck](variables/skipStateCheck.md)
 - [skipSubjectCheck](variables/skipSubjectCheck.md)

diff --git a/docs/interfaces/AuthenticatedRequestOptions.md b/docs/interfaces/AuthenticatedRequestOptions.md
@@ -4,23 +4,26 @@
 
 ## Table of contents
 
+### Experimental
+
+- [[experimental\_useMtlsAlias]](AuthenticatedRequestOptions.md#experimental_usemtlsalias)
+
 ### Properties
 
-- [[experimentalUseMtlsAlias]](AuthenticatedRequestOptions.md#experimentalusemtlsalias)
 - [clientPrivateKey](AuthenticatedRequestOptions.md#clientprivatekey)
 
-## Properties
+## Experimental
 
-### [experimentalUseMtlsAlias]
+### [experimental\_useMtlsAlias]
 
-• `Optional` **[experimentalUseMtlsAlias]**: `boolean`
+• `Optional` **[experimental\_useMtlsAlias]**: `boolean`
 
 This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
 compatible changes or removal may occur in any future release.
 
-See [experimentalUseMtlsAlias](../variables/experimentalUseMtlsAlias.md) for its documentation.
+See [experimental_useMtlsAlias](../variables/experimental_useMtlsAlias.md) for its documentation.
 
-___
+## Properties
 
 ### clientPrivateKey
 

diff --git a/docs/interfaces/ClientCredentialsGrantRequestOptions.md b/docs/interfaces/ClientCredentialsGrantRequestOptions.md
@@ -4,44 +4,47 @@
 
 ## Table of contents
 
+### Experimental
+
+- [[experimental\_customFetch]](ClientCredentialsGrantRequestOptions.md#experimental_customfetch)
+- [[experimental\_useMtlsAlias]](ClientCredentialsGrantRequestOptions.md#experimental_usemtlsalias)
+
 ### Properties
 
 - [DPoP](ClientCredentialsGrantRequestOptions.md#dpop)
-- [[experimentalCustomFetch]](ClientCredentialsGrantRequestOptions.md#experimentalcustomfetch)
-- [[experimentalUseMtlsAlias]](ClientCredentialsGrantRequestOptions.md#experimentalusemtlsalias)
 - [clientPrivateKey](ClientCredentialsGrantRequestOptions.md#clientprivatekey)
 - [headers](ClientCredentialsGrantRequestOptions.md#headers)
 - [signal](ClientCredentialsGrantRequestOptions.md#signal)
 
-## Properties
+## Experimental
 
-### DPoP
+### [experimental\_customFetch]
 
-• `Optional` **DPoP**: [`DPoPOptions`](DPoPOptions.md)
+• `Optional` **[experimental\_customFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
 
-DPoP-related options.
+This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
+compatible changes or removal may occur in any future release.
+
+See [experimental_customFetch](../variables/experimental_customFetch.md) for its documentation.
 
 ___
 
-### [experimentalCustomFetch]
+### [experimental\_useMtlsAlias]
 
-• `Optional` **[experimentalCustomFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
+• `Optional` **[experimental\_useMtlsAlias]**: `boolean`
 
 This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
 compatible changes or removal may occur in any future release.
 
-See [experimentalCustomFetch](../variables/experimentalCustomFetch.md) for its documentation.
+See [experimental_useMtlsAlias](../variables/experimental_useMtlsAlias.md) for its documentation.
 
-___
-
-### [experimentalUseMtlsAlias]
+## Properties
 
-• `Optional` **[experimentalUseMtlsAlias]**: `boolean`
+### DPoP
 
-This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
-compatible changes or removal may occur in any future release.
+• `Optional` **DPoP**: [`DPoPOptions`](DPoPOptions.md)
 
-See [experimentalUseMtlsAlias](../variables/experimentalUseMtlsAlias.md) for its documentation.
+DPoP-related options.
 
 ___
 

diff --git a/docs/interfaces/DeviceAuthorizationRequestOptions.md b/docs/interfaces/DeviceAuthorizationRequestOptions.md
@@ -4,37 +4,40 @@
 
 ## Table of contents
 
+### Experimental
+
+- [[experimental\_customFetch]](DeviceAuthorizationRequestOptions.md#experimental_customfetch)
+- [[experimental\_useMtlsAlias]](DeviceAuthorizationRequestOptions.md#experimental_usemtlsalias)
+
 ### Properties
 
-- [[experimentalCustomFetch]](DeviceAuthorizationRequestOptions.md#experimentalcustomfetch)
-- [[experimentalUseMtlsAlias]](DeviceAuthorizationRequestOptions.md#experimentalusemtlsalias)
 - [clientPrivateKey](DeviceAuthorizationRequestOptions.md#clientprivatekey)
 - [headers](DeviceAuthorizationRequestOptions.md#headers)
 - [signal](DeviceAuthorizationRequestOptions.md#signal)
 
-## Properties
+## Experimental
 
-### [experimentalCustomFetch]
+### [experimental\_customFetch]
 
-• `Optional` **[experimentalCustomFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
+• `Optional` **[experimental\_customFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
 
 This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
 compatible changes or removal may occur in any future release.
 
-See [experimentalCustomFetch](../variables/experimentalCustomFetch.md) for its documentation.
+See [experimental_customFetch](../variables/experimental_customFetch.md) for its documentation.
 
 ___
 
-### [experimentalUseMtlsAlias]
+### [experimental\_useMtlsAlias]
 
-• `Optional` **[experimentalUseMtlsAlias]**: `boolean`
+• `Optional` **[experimental\_useMtlsAlias]**: `boolean`
 
 This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
 compatible changes or removal may occur in any future release.
 
-See [experimentalUseMtlsAlias](../variables/experimentalUseMtlsAlias.md) for its documentation.
+See [experimental_useMtlsAlias](../variables/experimental_useMtlsAlias.md) for its documentation.
 
-___
+## Properties
 
 ### clientPrivateKey
 

diff --git a/docs/interfaces/DiscoveryRequestOptions.md b/docs/interfaces/DiscoveryRequestOptions.md
@@ -4,25 +4,28 @@
 
 ## Table of contents
 
+### Experimental
+
+- [[experimental\_customFetch]](DiscoveryRequestOptions.md#experimental_customfetch)
+
 ### Properties
 
-- [[experimentalCustomFetch]](DiscoveryRequestOptions.md#experimentalcustomfetch)
 - [algorithm](DiscoveryRequestOptions.md#algorithm)
 - [headers](DiscoveryRequestOptions.md#headers)
 - [signal](DiscoveryRequestOptions.md#signal)
 
-## Properties
+## Experimental
 
-### [experimentalCustomFetch]
+### [experimental\_customFetch]
 
-• `Optional` **[experimentalCustomFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
+• `Optional` **[experimental\_customFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
 
 This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
 compatible changes or removal may occur in any future release.
 
-See [experimentalCustomFetch](../variables/experimentalCustomFetch.md) for its documentation.
+See [experimental_customFetch](../variables/experimental_customFetch.md) for its documentation.
 
-___
+## Properties
 
 ### algorithm
 

diff --git a/docs/interfaces/ExperimentalUseMTLSAliasOptions.md b/docs/interfaces/ExperimentalUseMTLSAliasOptions.md
@@ -4,20 +4,20 @@
 
 ## Table of contents
 
-### Properties
+### Experimental
 
-- [[experimentalUseMtlsAlias]](ExperimentalUseMTLSAliasOptions.md#experimentalusemtlsalias)
+- [[experimental\_useMtlsAlias]](ExperimentalUseMTLSAliasOptions.md#experimental_usemtlsalias)
 
-## Properties
+## Experimental
 
-### [experimentalUseMtlsAlias]
+### [experimental\_useMtlsAlias]
 
-• `Optional` **[experimentalUseMtlsAlias]**: `boolean`
+• `Optional` **[experimental\_useMtlsAlias]**: `boolean`
 
 This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
 compatible changes or removal may occur in any future release.
 
-See [experimentalUseMtlsAlias](../variables/experimentalUseMtlsAlias.md) for its documentation.
+See [experimental_useMtlsAlias](../variables/experimental_useMtlsAlias.md) for its documentation.
 
 ## Hierarchy
 

diff --git a/docs/interfaces/HttpRequestOptions.md b/docs/interfaces/HttpRequestOptions.md
@@ -4,24 +4,27 @@
 
 ## Table of contents
 
+### Experimental
+
+- [[experimental\_customFetch]](HttpRequestOptions.md#experimental_customfetch)
+
 ### Properties
 
-- [[experimentalCustomFetch]](HttpRequestOptions.md#experimentalcustomfetch)
 - [headers](HttpRequestOptions.md#headers)
 - [signal](HttpRequestOptions.md#signal)
 
-## Properties
+## Experimental
 
-### [experimentalCustomFetch]
+### [experimental\_customFetch]
 
-• `Optional` **[experimentalCustomFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
+• `Optional` **[experimental\_customFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
 
 This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
 compatible changes or removal may occur in any future release.
 
-See [experimentalCustomFetch](../variables/experimentalCustomFetch.md) for its documentation.
+See [experimental_customFetch](../variables/experimental_customFetch.md) for its documentation.
 
-___
+## Properties
 
 ### headers
 

diff --git a/docs/interfaces/IntrospectionRequestOptions.md b/docs/interfaces/IntrospectionRequestOptions.md
@@ -4,39 +4,42 @@
 
 ## Table of contents
 
+### Experimental
+
+- [[experimental\_customFetch]](IntrospectionRequestOptions.md#experimental_customfetch)
+- [[experimental\_useMtlsAlias]](IntrospectionRequestOptions.md#experimental_usemtlsalias)
+
 ### Properties
 
-- [[experimentalCustomFetch]](IntrospectionRequestOptions.md#experimentalcustomfetch)
-- [[experimentalUseMtlsAlias]](IntrospectionRequestOptions.md#experimentalusemtlsalias)
 - [additionalParameters](IntrospectionRequestOptions.md#additionalparameters)
 - [clientPrivateKey](IntrospectionRequestOptions.md#clientprivatekey)
 - [headers](IntrospectionRequestOptions.md#headers)
 - [requestJwtResponse](IntrospectionRequestOptions.md#requestjwtresponse)
 - [signal](IntrospectionRequestOptions.md#signal)
 
-## Properties
+## Experimental
 
-### [experimentalCustomFetch]
+### [experimental\_customFetch]
 
-• `Optional` **[experimentalCustomFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
+• `Optional` **[experimental\_customFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
 
 This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
 compatible changes or removal may occur in any future release.
 
-See [experimentalCustomFetch](../variables/experimentalCustomFetch.md) for its documentation.
+See [experimental_customFetch](../variables/experimental_customFetch.md) for its documentation.
 
 ___
 
-### [experimentalUseMtlsAlias]
+### [experimental\_useMtlsAlias]
 
-• `Optional` **[experimentalUseMtlsAlias]**: `boolean`
+• `Optional` **[experimental\_useMtlsAlias]**: `boolean`
 
 This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
 compatible changes or removal may occur in any future release.
 
-See [experimentalUseMtlsAlias](../variables/experimentalUseMtlsAlias.md) for its documentation.
+See [experimental_useMtlsAlias](../variables/experimental_useMtlsAlias.md) for its documentation.
 
-___
+## Properties
 
 ### additionalParameters
 

diff --git a/docs/interfaces/ProtectedResourceRequestOptions.md b/docs/interfaces/ProtectedResourceRequestOptions.md
@@ -4,13 +4,27 @@
 
 ## Table of contents
 
+### Experimental
+
+- [[experimental\_customFetch]](ProtectedResourceRequestOptions.md#experimental_customfetch)
+
 ### Properties
 
 - [DPoP](ProtectedResourceRequestOptions.md#dpop)
 - [[clockSkew]](ProtectedResourceRequestOptions.md#clockskew)
-- [[experimentalCustomFetch]](ProtectedResourceRequestOptions.md#experimentalcustomfetch)
 - [signal](ProtectedResourceRequestOptions.md#signal)
 
+## Experimental
+
+### [experimental\_customFetch]
+
+• `Optional` **[experimental\_customFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
+
+This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
+compatible changes or removal may occur in any future release.
+
+See [experimental_customFetch](../variables/experimental_customFetch.md) for its documentation.
+
 ## Properties
 
 ### DPoP
@@ -33,17 +47,6 @@ option is also used.
 
 ___
 
-### [experimentalCustomFetch]
-
-• `Optional` **[experimentalCustomFetch]**: (`input`: `RequestInfo` \| [`URL`]( https://developer.mozilla.org/docs/Web/API/URL ), `init?`: `RequestInit`) => [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Response`]( https://developer.mozilla.org/docs/Web/API/Response )\>
-
-This is an experimental feature, it is not subject to semantic versioning rules. Non-backward
-compatible changes or removal may occur in any future release.
-
-See [experimentalCustomFetch](../variables/experimentalCustomFetch.md) for its documentation.
-
-___
-
 ### signal
 
 • `Optional` **signal**: [`AbortSignal`]( https://developer.mozilla.org/docs/Web/API/AbortSignal ) \| () => [`AbortSignal`]( https://developer.mozilla.org/docs/Web/API/AbortSignal )