Merge pull request #1892 from hey-api/fix/fetch-spec-options

fix: allow passing fetch options to the request resolving a specification

Author: mrlubos

.changeset/curvy-seas-camp.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: allow passing fetch options to the request resolving a specification

packages/openapi-ts-tests/test/openapi-ts.config.ts

@@ -17,6 +17,11 @@ export default defineConfig(() => {
     input: {
       branch: 'main',
       // exclude: '^#/components/schemas/ModelWithCircularReference$',
+      // fetch: {
+      //   headers: {
+      //     'x-foo': 'bar',
+      //   },
+      // },
       // include:
       //   '^(#/components/schemas/import|#/paths/api/v{api-version}/simple/options)$',
       organization: 'hey-api',

packages/openapi-ts/package.json

@@ -78,7 +78,7 @@
     "node": "^18.18.0 || ^20.9.0 || >=22.10.0"
   },
   "dependencies": {
-    "@hey-api/json-schema-ref-parser": "1.0.3",
+    "@hey-api/json-schema-ref-parser": "1.0.4",
     "c12": "2.0.1",
     "commander": "13.0.0",
     "handlebars": "4.7.8"

packages/openapi-ts/src/createClient.ts

@@ -193,6 +193,7 @@ export const createClient = async ({
 
   Performance.start('spec');
   const { data, error, response } = await getSpec({
+    fetchOptions: config.input.fetch,
     inputPath: inputPath.path,
     timeout,
     watch,

packages/openapi-ts/src/getSpec.ts

@@ -5,6 +5,7 @@ import {
   sendRequest,
 } from '@hey-api/json-schema-ref-parser';
 
+import { mergeHeaders } from './mergeHeaders';
 import type { Config } from './types/config';
 import type { WatchValues } from './types/types';
 
@@ -21,10 +22,12 @@ interface SpecError {
 }
 
 export const getSpec = async ({
+  fetchOptions,
   inputPath,
   timeout,
   watch,
 }: {
+  fetchOptions?: RequestInit;
   inputPath: Config['input']['path'];
   timeout: number;
   watch: WatchValues;
@@ -42,9 +45,10 @@ export const getSpec = async ({
     if (watch.lastValue && watch.isHeadMethodSupported !== false) {
       try {
         const request = await sendRequest({
-          init: {
-            headers: watch.headers,
+          fetchOptions: {
             method: 'HEAD',
+            ...fetchOptions,
+            headers: mergeHeaders(fetchOptions?.headers, watch.headers),
           },
           timeout,
           url: resolvedInput.path,
@@ -118,8 +122,9 @@ export const getSpec = async ({
 
     try {
       const request = await sendRequest({
-        init: {
+        fetchOptions: {
           method: 'GET',
+          ...fetchOptions,
         },
         timeout,
         url: resolvedInput.path,

packages/openapi-ts/src/mergeHeaders.ts

@@ -0,0 +1,32 @@
+// copy-pasted from @hey-api/client-fetch
+export const mergeHeaders = (
+  ...headers: Array<RequestInit['headers'] | undefined>
+): Headers => {
+  const mergedHeaders = new Headers();
+  for (const header of headers) {
+    if (!header || typeof header !== 'object') {
+      continue;
+    }
+
+    const iterator =
+      header instanceof Headers ? header.entries() : Object.entries(header);
+
+    for (const [key, value] of iterator) {
+      if (value === null) {
+        mergedHeaders.delete(key);
+      } else if (Array.isArray(value)) {
+        for (const v of value) {
+          mergedHeaders.append(key, v as string);
+        }
+      } else if (value !== undefined) {
+        // assume object headers are meant to be JSON stringified, i.e. their
+        // content value in OpenAPI specification is 'application/json'
+        mergedHeaders.set(
+          key,
+          typeof value === 'object' ? JSON.stringify(value) : (value as string),
+        );
+      }
+    }
+  }
+  return mergedHeaders;
+};

packages/openapi-ts/src/types/config.d.ts

@@ -49,6 +49,11 @@ interface Input {
    * schema: '^#/components/schemas/Foo$'
    */
   exclude?: string;
+  /**
+   * You pass any valid Fetch API options to the request for fetching your
+   * specification. This is useful if your file is behind auth for example.
+   */
+  fetch?: RequestInit;
   /**
    * Process only parts matching the regular expression. You can select both
    * operations and components by reference within the bundled input. In
@@ -133,7 +138,7 @@ export interface UserConfig {
   input:
     | 'https://get.heyapi.dev/<organization>/<project>'
     | (string & {})
-    | Record<string, unknown>
+    | (Record<string, unknown> & { path?: never })
     | Input;
   /**
    * The relative location of the logs folder