feat: export OpenAPI TypeScript helper types

johannschopplich · May 14, 2024 · 4cb4a3d · 4cb4a3d
1 parent d7783e7
commit 4cb4a3d
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 4 deletions.
diff --git a/src/module.ts b/src/module.ts
@@ -182,7 +182,7 @@ export default defineNuxtModule<ModuleOptions>({
       config.externals.inline ||= []
       config.externals.inline.push(...[
         resolve('runtime/utils'),
-        resolve('runtime/formData'),
+        resolve('runtime/form-data'),
         resolve('runtime/server/$api'),
       ])
 
@@ -249,6 +249,9 @@ ${schemaEndpointIds.map(i => `
 import type { paths as ${pascalCase(i)}Paths } from '#${moduleName}/${i}'
 `.trimStart()).join('').trimEnd()}
 
+// OpenAPI helpers
+export type { FetchResponseData, FetchResponseError, MethodOption, ParamsOption, RequestBodyOption, FilterMethods } from '${relativeTo('runtime/openapi')}'
+// Clients
 export type { ApiClient, OpenAPIClient, ApiClientFetchOptions, OpenAPIClientFetchOptions, UseApiData, UseOpenAPIData, UseApiDataOptions, UseOpenAPIDataOptions }
 
 ${endpointKeys.map(i => `

diff --git a/src/openapi.ts b/src/openapi.ts
@@ -3,6 +3,7 @@ import { useNuxt } from '@nuxt/kit'
 import type { OpenAPI3, OpenAPITSOptions } from 'openapi-typescript'
 import type { ApiEndpoint } from './module'
 
+// Add types for compatibility between openapi-typescript v6 and v7
 declare module 'openapi-typescript' {
   /** @since openapi-typescript@7 */
   function _astToString(ast: unknown): string

diff --git a/src/runtime/composables/$api.ts b/src/runtime/composables/$api.ts
@@ -3,7 +3,7 @@ import { joinURL } from 'ufo'
 import type { NitroFetchOptions } from 'nitropack'
 import { resolvePathParams } from '../openapi'
 import { headersToObject, serializeMaybeEncodedBody } from '../utils'
-import { isFormData } from '../formData'
+import { isFormData } from '../form-data'
 import type { ModuleOptions } from '../../module'
 import { CACHE_KEY_PREFIX } from '../constants'
 import type { EndpointFetchOptions } from '../types'

diff --git a/src/runtime/composables/useApiData.ts b/src/runtime/composables/useApiData.ts
@@ -8,7 +8,7 @@ import type { ModuleOptions } from '../../module'
 import { CACHE_KEY_PREFIX } from '../constants'
 import { resolvePathParams } from '../openapi'
 import { headersToObject, serializeMaybeEncodedBody } from '../utils'
-import { isFormData } from '../formData'
+import { isFormData } from '../form-data'
 import type { EndpointFetchOptions } from '../types'
 import type { FetchResponseData, FetchResponseError, FilterMethods, ParamsOption, RequestBodyOption } from '../openapi'
 import { useAsyncData, useRequestHeaders, useRuntimeConfig } from '#imports'

diff --git a/src/runtime/formData.ts → src/runtime/form-data.ts b/src/runtime/formData.ts → src/runtime/form-data.ts
diff --git a/src/runtime/utils.ts b/src/runtime/utils.ts
@@ -1,4 +1,4 @@
-import { formDataToObject, isFormData, isSerializedFormData, objectToFormData } from './formData'
+import { formDataToObject, isFormData, isSerializedFormData, objectToFormData } from './form-data'
 import type { ApiClientFetchOptions } from './composables/$api'
 
 export function headersToObject(headers: HeadersInit = {}): Record<string, string> {