feat: expose types via #nuxt-api-party

johannschopplich · Aug 18, 2023 · 5c5b308 · 5c5b308
1 parent 159b27d
commit 5c5b308
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/src/module.ts b/src/module.ts
@@ -189,14 +189,15 @@ export const ${getDataComposableName(i)} = (...args) => _useApiData('${i}', ...a
       getContents() {
         return `
 // Generated by ${moduleName}
-import type { $Api } from '${relativeTo('runtime/composables/$api')}'
-import type { UseApiData } from '${relativeTo('runtime/composables/useApiData')}'
+import type { $Api, $AnyApi, $OpenApi, AnyApiFetchOptions } from '${relativeTo('runtime/composables/$api')}'
+import type { UseApiData, UseAnyApiData, UseOpenApiData, UseAnyApiDataOptions } from '${relativeTo('runtime/composables/useApiData')}'
 
+export type { $Api, $AnyApi, $OpenApi, AnyApiFetchOptions, UseApiData, UseAnyApiData, UseOpenApiData, UseAnyApiDataOptions }
 ${schemaEndpointIds.map(i => `import type { paths as ${pascalCase(i)}Paths } from '#${moduleName}/${i}'`).join('')}
 
 ${endpointKeys.map(i => `
-export declare const ${getRawComposableName(i)}: $Api${schemaEndpointIds.includes(i) ? `<${pascalCase(i)}Paths>` : ''}
-export declare const ${getDataComposableName(i)}: UseApiData${schemaEndpointIds.includes(i) ? `<${pascalCase(i)}Paths>` : ''}
+export declare const ${getRawComposableName(i)}: ${schemaEndpointIds.includes(i) ? `$OpenApi<${pascalCase(i)}Paths>` : '$AnyApi'}
+export declare const ${getDataComposableName(i)}: ${schemaEndpointIds.includes(i) ? `UseOpenApiData<${pascalCase(i)}Paths>` : 'UseAnyApiData'}
 `.trimStart()).join('').trimEnd()}
 `.trimStart()
       },

diff --git a/src/runtime/composables/$api.ts b/src/runtime/composables/$api.ts
@@ -41,6 +41,7 @@ export interface $OpenApi<Paths extends Record<string, PathItemObject>> {
   ): Promise<OpenApiResponse<Paths[`/${P}`][Lowercase<M>]>>
 }
 
+/** @remarks Prefer using `$AnyApi` and `$OpenApi` directly */
 export type $Api<Paths extends Record<string, PathItemObject> = never> = [Paths] extends [never]
   ? $AnyApi
   : $OpenApi<Paths>

diff --git a/src/runtime/composables/useApiData.ts b/src/runtime/composables/useApiData.ts
@@ -73,6 +73,7 @@ export interface UseOpenApiData<Paths extends Record<string, PathItemObject>> {
   ): AsyncData<OpenApiResponse<Paths[`/${P}`][Lowercase<M>]>, OpenApiError<Paths[`/${P}`][Lowercase<M>]>>
 }
 
+/** @remarks Prefer using `UseAnyApiData` and `UseOpenApiData` directly */
 export type UseApiData<Paths extends Record<string, PathItemObject> = never> = [Paths] extends [never]
   ? UseAnyApiData
   : UseOpenApiData<Paths>