fix(client): query add return type (#270)

orval-labs · Nov 25, 2021 · 326ed10 · 326ed10 · vercel · Nov 25, 2021
1 parent 9440969
commit 326ed10
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 6 deletions.
diff --git a/src/core/generators/client.ts b/src/core/generators/client.ts
@@ -231,7 +231,7 @@ export const generateClient = (
     verbsOptions,
     async (acc, verbOption) => {
       const { client: generatorClient } = getGeneratorClient(outputClient);
-      const client = generatorClient(verbOption, options);
+      const client = generatorClient(verbOption, options, outputClient);
       const msw = await generateMock(verbOption, options);
 
       return {

diff --git a/src/core/generators/imports.ts b/src/core/generators/imports.ts
@@ -86,7 +86,9 @@ export const addDependency = ({
   specsName: Record<string, string>;
   hasSchemaDir: boolean;
 }) => {
-  const toAdds = exports.filter((e) => implementation.includes(e.name));
+  const toAdds = exports.filter((e) =>
+    implementation.includes(e.alias || e.name),
+  );
 
   if (!toAdds.length) {
     return undefined;
@@ -111,7 +113,9 @@ export const addDependency = ({
       const defaultDep = deps.find((e) => e.default);
 
       const depsString = uniq(
-        deps.filter((e) => !e.default).map(({ name }) => name),
+        deps
+          .filter((e) => !e.default)
+          .map(({ name, alias }) => (alias ? `${name} as ${alias}` : name)),
       ).join(',\n  ');
 
       return `import ${!values ? 'type ' : ''}${

diff --git a/src/core/generators/query.ts b/src/core/generators/query.ts
@@ -1,7 +1,7 @@
 //@ts-ignore
 const esprima = require('esprima');
 import omitBy from 'lodash.omitby';
-import { Verbs } from '../../types';
+import { OutputClient, OutputClientFunc, Verbs } from '../../types';
 import {
   GeneratorDependency,
   GeneratorMutator,
@@ -50,6 +50,9 @@ const SVELTE_QUERY_DEPENDENCIES: GeneratorDependency[] = [
       { name: 'UseMutationOptions' },
       { name: 'QueryFunction' },
       { name: 'MutationFunction' },
+      { name: 'UseQueryStoreResult' },
+      { name: 'UseInfiniteQueryStoreResult' },
+      { name: 'QueryKey' },
     ],
     dependency: '@sveltestack/svelte-query',
   },
@@ -69,6 +72,9 @@ const REACT_QUERY_DEPENDENCIES: GeneratorDependency[] = [
       { name: 'UseMutationOptions' },
       { name: 'QueryFunction' },
       { name: 'MutationFunction' },
+      { name: 'UseQueryResult' },
+      { name: 'UseInfiniteQueryResult' },
+      { name: 'QueryKey' },
     ],
     dependency: 'react-query',
   },
@@ -92,6 +98,9 @@ const VUE_QUERY_DEPENDENCIES: GeneratorDependency[] = [
       { name: 'UseMutationOptions' },
       { name: 'QueryFunction' },
       { name: 'MutationFunction' },
+      { name: 'UseQueryResult' },
+      { name: 'UseInfiniteQueryResult' },
+      { name: 'QueryKey' },
     ],
     dependency: 'vue-query/types',
   },
@@ -308,6 +317,7 @@ const generateQueryImplementation = ({
   mutator,
   isRequestOptions,
   response,
+  outputClient,
 }: {
   queryOption: {
     name: string;
@@ -324,6 +334,7 @@ const generateQueryImplementation = ({
   props: GetterProps;
   response: GetterResponse;
   mutator?: GeneratorMutator;
+  outputClient: OutputClient | OutputClientFunc;
 }) => {
   const isMutatorHook =
     mutator?.name.startsWith('use') && !mutator.mutatorFn.length;
@@ -337,6 +348,15 @@ const generateQueryImplementation = ({
 
   const isMutatorHasSecondArg = !!mutator && mutator.mutatorFn.length > 1;
 
+  const returnType =
+    outputClient !== OutputClient.SVELTE_QUERY
+      ? ` Use${pascal(type)}Result<TData, TError>`
+      : `Use${pascal(type)}StoreResult<AsyncReturnType<${
+          isMutatorHook
+            ? `ReturnType<typeof use${pascal(operationName)}Hook>`
+            : `typeof ${operationName}`
+        }>, TError, TData, QueryKey>`;
+
   return `
 export const ${camel(`use-${name}`)} = <TData = AsyncReturnType<${
     isMutatorHook
@@ -351,7 +371,7 @@ export const ${camel(`use-${name}`)} = <TData = AsyncReturnType<${
     isRequestOptions,
     isMutatorHasSecondArg,
     type,
-  })}\n  ) => {
+  })}\n  ): ${returnType} & { queryKey: QueryKey } => {
 
   ${
     isRequestOptions
@@ -422,6 +442,7 @@ const generateQueryHook = (
     operationId,
   }: GeneratorVerbOptions,
   { route, override: { operations = {} } }: GeneratorOptions,
+  outputClient: OutputClient | OutputClientFunc,
 ) => {
   const query = override?.query;
   const isRequestOptions = override?.requestOptions !== false;
@@ -481,6 +502,7 @@ const generateQueryHook = (
           mutator,
           isRequestOptions,
           response,
+          outputClient,
         }),
       '',
     )}
@@ -586,13 +608,18 @@ export const generateQueryFooter = () => '';
 export const generateQuery = (
   verbOptions: GeneratorVerbOptions,
   options: GeneratorOptions,
+  outputClient: OutputClient | OutputClientFunc,
 ) => {
   const imports = generateVerbImports(verbOptions);
   const functionImplementation = generateQueryRequestFunction(
     verbOptions,
     options,
   );
-  const hookImplementation = generateQueryHook(verbOptions, options);
+  const hookImplementation = generateQueryHook(
+    verbOptions,
+    options,
+    outputClient,
+  );
 
   return {
     implementation: `${functionImplementation}\n\n${hookImplementation}`,

diff --git a/src/types/generator.ts b/src/types/generator.ts
@@ -10,6 +10,7 @@ import {
   NormalizedOperationOptions,
   NormalizedOverrideOutput,
   OutputClient,
+  OutputClientFunc,
   Verbs,
 } from './index';
 
@@ -125,6 +126,7 @@ export type GeneratorMutator = {
 export type ClientBuilder = (
   verbOptions: GeneratorVerbOptions,
   options: GeneratorOptions,
+  outputClient: OutputClient | OutputClientFunc,
 ) => GeneratorClient;
 
 export type ClientHeaderBuilder = (params: {