feat: allow all of HeadersInit for HttpRequestOptions.headers

panva · Jan 9, 2024 · a5fe73c · a5fe73c
1 parent e9dffe0
commit a5fe73c
Show file tree

Hide file tree

Showing 19 changed files with 173 additions and 132 deletions.
diff --git a/docs/interfaces/ClientCredentialsGrantRequestOptions.md b/docs/interfaces/ClientCredentialsGrantRequestOptions.md
@@ -33,10 +33,9 @@ ___
 
 ### headers
 
-• `Optional` **headers**: [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
+• `Optional` **headers**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `string`\> \| [`string`, `string`][] \| [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
 
-A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-invocation.
+Headers to additionally send with the HTTP Request(s) triggered by this function's invocation.
 
 ___
 

diff --git a/docs/interfaces/DeviceAuthorizationRequestOptions.md b/docs/interfaces/DeviceAuthorizationRequestOptions.md
@@ -24,10 +24,9 @@ ___
 
 ### headers
 
-• `Optional` **headers**: [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
+• `Optional` **headers**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `string`\> \| [`string`, `string`][] \| [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
 
-A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-invocation.
+Headers to additionally send with the HTTP Request(s) triggered by this function's invocation.
 
 ___
 

diff --git a/docs/interfaces/DiscoveryRequestOptions.md b/docs/interfaces/DiscoveryRequestOptions.md
@@ -22,10 +22,9 @@ ___
 
 ### headers
 
-• `Optional` **headers**: [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
+• `Optional` **headers**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `string`\> \| [`string`, `string`][] \| [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
 
-A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-invocation.
+Headers to additionally send with the HTTP Request(s) triggered by this function's invocation.
 
 ___
 

diff --git a/docs/interfaces/HttpRequestOptions.md b/docs/interfaces/HttpRequestOptions.md
@@ -13,10 +13,9 @@
 
 ### headers
 
-• `Optional` **headers**: [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
+• `Optional` **headers**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `string`\> \| [`string`, `string`][] \| [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
 
-A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-invocation.
+Headers to additionally send with the HTTP Request(s) triggered by this function's invocation.
 
 ___
 

diff --git a/docs/interfaces/IntrospectionRequestOptions.md b/docs/interfaces/IntrospectionRequestOptions.md
@@ -34,10 +34,9 @@ ___
 
 ### headers
 
-• `Optional` **headers**: [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
+• `Optional` **headers**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `string`\> \| [`string`, `string`][] \| [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
 
-A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-invocation.
+Headers to additionally send with the HTTP Request(s) triggered by this function's invocation.
 
 ___
 

diff --git a/docs/interfaces/PushedAuthorizationRequestOptions.md b/docs/interfaces/PushedAuthorizationRequestOptions.md
@@ -33,10 +33,9 @@ ___
 
 ### headers
 
-• `Optional` **headers**: [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
+• `Optional` **headers**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `string`\> \| [`string`, `string`][] \| [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
 
-A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-invocation.
+Headers to additionally send with the HTTP Request(s) triggered by this function's invocation.
 
 ___
 

diff --git a/docs/interfaces/RevocationRequestOptions.md b/docs/interfaces/RevocationRequestOptions.md
@@ -33,10 +33,9 @@ ___
 
 ### headers
 
-• `Optional` **headers**: [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
+• `Optional` **headers**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `string`\> \| [`string`, `string`][] \| [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
 
-A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-invocation.
+Headers to additionally send with the HTTP Request(s) triggered by this function's invocation.
 
 ___
 

diff --git a/docs/interfaces/TokenEndpointRequestOptions.md b/docs/interfaces/TokenEndpointRequestOptions.md
@@ -42,10 +42,9 @@ ___
 
 ### headers
 
-• `Optional` **headers**: [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
+• `Optional` **headers**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `string`\> \| [`string`, `string`][] \| [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
 
-A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-invocation.
+Headers to additionally send with the HTTP Request(s) triggered by this function's invocation.
 
 ___
 

diff --git a/docs/interfaces/UserInfoRequestOptions.md b/docs/interfaces/UserInfoRequestOptions.md
@@ -22,10 +22,9 @@ ___
 
 ### headers
 
-• `Optional` **headers**: [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
+• `Optional` **headers**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `string`\> \| [`string`, `string`][] \| [`Headers`]( https://developer.mozilla.org/docs/Web/API/Headers )
 
-A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-invocation.
+Headers to additionally send with the HTTP Request(s) triggered by this function's invocation.
 
 ___
 

diff --git a/src/index.ts b/src/index.ts
@@ -727,11 +727,8 @@ export interface HttpRequestOptions {
    */
   signal?: (() => AbortSignal) | AbortSignal
 
-  /**
-   * A Headers instance to additionally send with the HTTP Request(s) triggered by this function's
-   * invocation.
-   */
-  headers?: Headers
+  /** Headers to additionally send with the HTTP Request(s) triggered by this function's invocation. */
+  headers?: [string, string][] | Record<string, string> | Headers
 }
 
 export interface DiscoveryRequestOptions extends HttpRequestOptions {
@@ -762,9 +759,9 @@ function isJsonObject<T = JsonObject>(input: unknown): input is T {
   return true
 }
 
-function prepareHeaders(input: unknown): Headers {
-  if (input !== undefined && !(input instanceof Headers)) {
-    throw new TypeError('"options.headers" must be an instance of Headers')
+function prepareHeaders(input?: [string, string][] | Record<string, string> | Headers): Headers {
+  if (input instanceof Headers) {
+    input = Object.fromEntries(input.entries())
   }
   const headers = new Headers(input)
   if (USER_AGENT && !headers.has('user-agent')) {

diff --git a/test/authorization_code.test.ts b/test/authorization_code.test.ts
@@ -213,23 +213,29 @@ test('authorizationCodeGrantRequest() w/ Custom Headers', async (t) => {
       },
     })
     .reply(200, { access_token: 'token', token_type: 'Bearer' })
+    .times(3)
 
-  await t.notThrowsAsync(
-    lib.authorizationCodeGrantRequest(
-      tIssuer,
-      tClient,
-      cb('code=authorization_code'),
-      'redirect_uri',
-      'verifier',
-      {
-        headers: new Headers([
-          ['accept', 'will be overwritten'],
-          ['user-agent', 'foo'],
-          ['foo', 'bar'],
-        ]),
-      },
-    ),
-  )
+  const entries = [
+    ['accept', 'will be overwritten'],
+    ['user-agent', 'foo'],
+    ['foo', 'bar'],
+  ]
+  for (const headers of [
+    entries,
+    Object.fromEntries(entries),
+    new Headers(Object.fromEntries(entries)),
+  ]) {
+    await t.notThrowsAsync(
+      lib.authorizationCodeGrantRequest(
+        tIssuer,
+        tClient,
+        cb('code=authorization_code'),
+        'redirect_uri',
+        'verifier',
+        { headers },
+      ),
+    )
+  }
 })
 
 test('authorizationCodeGrantRequest() w/ DPoP', async (t) => {

diff --git a/test/client_credentials.test.ts b/test/client_credentials.test.ts
@@ -104,16 +104,22 @@ test('clientCredentialsGrantRequest() w/ Custom Headers', async (t) => {
       },
     })
     .reply(200, { access_token: 'token', token_type: 'Bearer' })
+    .times(3)
 
-  await t.notThrowsAsync(
-    lib.clientCredentialsGrantRequest(tIssuer, tClient, new URLSearchParams(), {
-      headers: new Headers([
-        ['accept', 'will be overwritten'],
-        ['user-agent', 'foo'],
-        ['foo', 'bar'],
-      ]),
-    }),
-  )
+  const entries = [
+    ['accept', 'will be overwritten'],
+    ['user-agent', 'foo'],
+    ['foo', 'bar'],
+  ]
+  for (const headers of [
+    entries,
+    Object.fromEntries(entries),
+    new Headers(Object.fromEntries(entries)),
+  ]) {
+    await t.notThrowsAsync(
+      lib.clientCredentialsGrantRequest(tIssuer, tClient, new URLSearchParams(), { headers }),
+    )
+  }
 })
 
 test('clientCredentialsGrantRequest() w/ DPoP', async (t) => {

diff --git a/test/device_flow.test.ts b/test/device_flow.test.ts
@@ -82,16 +82,22 @@ test('deviceAuthorizationRequest() w/ Custom Headers', async (t) => {
       },
     })
     .reply(200, '')
+    .times(3)
 
-  await t.notThrowsAsync(
-    lib.deviceAuthorizationRequest(tIssuer, tClient, new URLSearchParams(), {
-      headers: new Headers([
-        ['accept', 'will be overwritten'],
-        ['user-agent', 'foo'],
-        ['foo', 'bar'],
-      ]),
-    }),
-  )
+  const entries = [
+    ['accept', 'will be overwritten'],
+    ['user-agent', 'foo'],
+    ['foo', 'bar'],
+  ]
+  for (const headers of [
+    entries,
+    Object.fromEntries(entries),
+    new Headers(Object.fromEntries(entries)),
+  ]) {
+    await t.notThrowsAsync(
+      lib.deviceAuthorizationRequest(tIssuer, tClient, new URLSearchParams(), { headers }),
+    )
+  }
 })
 
 test('processDeviceAuthorizationResponse()', async (t) => {
@@ -320,16 +326,20 @@ test('deviceCodeGrantRequest() w/ Custom Headers', async (t) => {
       },
     })
     .reply(200, { access_token: 'token', token_type: 'Bearer' })
+    .times(3)
 
-  await t.notThrowsAsync(
-    lib.deviceCodeGrantRequest(tIssuer, tClient, 'device_code', {
-      headers: new Headers([
-        ['accept', 'will be overwritten'],
-        ['user-agent', 'foo'],
-        ['foo', 'bar'],
-      ]),
-    }),
-  )
+  const entries = [
+    ['accept', 'will be overwritten'],
+    ['user-agent', 'foo'],
+    ['foo', 'bar'],
+  ]
+  for (const headers of [
+    entries,
+    Object.fromEntries(entries),
+    new Headers(Object.fromEntries(entries)),
+  ]) {
+    await t.notThrowsAsync(lib.deviceCodeGrantRequest(tIssuer, tClient, 'device_code', { headers }))
+  }
 })
 
 test('deviceCodeGrantRequest() w/ DPoP', async (t) => {

diff --git a/test/discovery.test.ts b/test/discovery.test.ts
@@ -37,15 +37,21 @@ test('discoveryRequest() w/ Custom Headers', async (t) => {
       },
     })
     .reply(200, data)
-
-  const response = await lib.discoveryRequest(new URL(issuer.issuer), {
-    headers: new Headers([
-      ['accept', 'will be overwritten'],
-      ['user-agent', 'foo'],
-      ['foo', 'bar'],
-    ]),
-  })
-  t.true(response instanceof Response)
+    .times(3)
+
+  const entries = [
+    ['accept', 'will be overwritten'],
+    ['user-agent', 'foo'],
+    ['foo', 'bar'],
+  ]
+  for (const headers of [
+    entries,
+    Object.fromEntries(entries),
+    new Headers(Object.fromEntries(entries)),
+  ]) {
+    const response = await lib.discoveryRequest(new URL(issuer.issuer), { headers })
+    t.true(response instanceof Response)
+  }
 })
 
 test('discoveryRequest() - oidc with a pathname', async (t) => {

diff --git a/test/introspection.test.ts b/test/introspection.test.ts
@@ -107,16 +107,20 @@ test('introspectionRequest() w/ Custom Headers', async (t) => {
       },
     })
     .reply(200, { access_token: 'token', token_type: 'Bearer' })
+    .times(3)
 
-  await t.notThrowsAsync(
-    lib.introspectionRequest(tIssuer, tClient, 'token', {
-      headers: new Headers([
-        ['accept', 'will be overwritten'],
-        ['user-agent', 'foo'],
-        ['foo', 'bar'],
-      ]),
-    }),
-  )
+  const entries = [
+    ['accept', 'will be overwritten'],
+    ['user-agent', 'foo'],
+    ['foo', 'bar'],
+  ]
+  for (const headers of [
+    entries,
+    Object.fromEntries(entries),
+    new Headers(Object.fromEntries(entries)),
+  ]) {
+    await t.notThrowsAsync(lib.introspectionRequest(tIssuer, tClient, 'token', { headers }))
+  }
 })
 
 test('introspectionRequest() forced jwt', async (t) => {

diff --git a/test/par.test.ts b/test/par.test.ts
@@ -77,16 +77,21 @@ test('pushedAuthorizationRequest() w/ Custom Headers', async (t) => {
       },
     })
     .reply(200, { request_uri: 'urn:example:uri', expires_in: 60 })
-
-  await t.notThrowsAsync(
-    lib.pushedAuthorizationRequest(tIssuer, tClient, new URLSearchParams(), {
-      headers: new Headers([
-        ['accept', 'will be overwritten'],
-        ['user-agent', 'foo'],
-        ['foo', 'bar'],
-      ]),
-    }),
-  )
+    .times(3)
+  const entries = [
+    ['accept', 'will be overwritten'],
+    ['user-agent', 'foo'],
+    ['foo', 'bar'],
+  ]
+  for (const headers of [
+    entries,
+    Object.fromEntries(entries),
+    new Headers(Object.fromEntries(entries)),
+  ]) {
+    await t.notThrowsAsync(
+      lib.pushedAuthorizationRequest(tIssuer, tClient, new URLSearchParams(), { headers }),
+    )
+  }
 })
 
 test('pushedAuthorizationRequest() w/ DPoP', async (t) => {