feat(clients): align awaited type everywhere

egorpavlikhin · May 14, 2022 · 4cc91cf · 4cc91cf
1 parent 292130d
commit 4cc91cf
Show file tree

Hide file tree

Showing 13 changed files with 6,004 additions and 6,091 deletions.
diff --git a/package.json b/package.json
@@ -97,6 +97,7 @@
     "cac": "^6.7.12",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
+    "compare-versions": "^4.1.3",
     "cuid": "^2.1.8",
     "debug": "^4.3.3",
     "esbuild": "^0.14.25",

diff --git a/src/core/generators/axios.ts b/src/core/generators/axios.ts
@@ -159,12 +159,21 @@ export const generateAxiosHeader = ({
   isRequestOptions,
   isMutator,
   noFunction,
+  hasAwaitedType,
 }: {
   title: string;
   isRequestOptions: boolean;
   isMutator: boolean;
   noFunction?: boolean;
-}) => `${
+  hasAwaitedType: boolean;
+}) => `
+${
+  !hasAwaitedType
+    ? `export type AwaitedInput<T> = PromiseLike<T> | T;\n
+    export type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;\n\n`
+    : ''
+}
+${
   isRequestOptions && isMutator
     ? `// eslint-disable-next-line @typescript-eslint/no-explicit-any
   type SecondParameter<T extends (...args: any) => any> = T extends (

diff --git a/src/core/generators/client.ts b/src/core/generators/client.ts
@@ -63,11 +63,7 @@ export const GENERATOR_CLIENT: GeneratorClients = {
         imports,
       };
     },
-    header: (options: {
-      title: string;
-      isMutator: boolean;
-      isRequestOptions: boolean;
-    }) => generateAxiosHeader({ ...options, noFunction: true }),
+    header: (options) => generateAxiosHeader({ ...options, noFunction: true }),
     dependencies: getAxiosDependencies,
     footer: (options) => generateAxiosFooter({ ...options, noFunction: true }),
     title: generateAxiosTitle,
@@ -152,6 +148,7 @@ export const generateClientHeader = ({
   isMutator,
   provideInRoot,
   provideIn,
+  hasAwaitedType,
 }: {
   outputClient?: OutputClient | OutputClientFunc;
   isRequestOptions: boolean;
@@ -161,6 +158,7 @@ export const generateClientHeader = ({
   provideIn: boolean | 'root' | 'any';
   title: string;
   customTitleFunc?: (title: string) => string;
+  hasAwaitedType: boolean;
 }): GeneratorClientExtra => {
   const titles = generateClientTitle(outputClient, title, customTitleFunc);
   const { header } = getGeneratorClient(outputClient);
@@ -172,6 +170,7 @@ export const generateClientHeader = ({
       isMutator,
       provideInRoot,
       provideIn,
+      hasAwaitedType,
     }),
     implementationMSW: `export const ${titles.implementationMSW} = () => [\n`,
   };

diff --git a/src/core/generators/query.ts b/src/core/generators/query.ts
@@ -310,16 +310,18 @@ const generateQueryArguments = ({
 }) => {
   const isMutatorHook = mutator?.isHook;
   const definition = type
-    ? `Use${pascal(type)}Options<AsyncReturnType<${
+    ? `Use${pascal(type)}Options<Awaited<ReturnType<${
         isMutatorHook
           ? `ReturnType<typeof use${pascal(operationName)}Hook>`
           : `typeof ${operationName}`
-      }>, TError, TData>`
-    : `UseMutationOptions<AsyncReturnType<${
+      }>>, TError, TData>`
+    : `UseMutationOptions<Awaited<ReturnType<${
         isMutatorHook
           ? `ReturnType<typeof use${pascal(operationName)}Hook>`
           : `typeof ${operationName}`
-      }>, TError,${definitions ? `{${definitions}}` : 'TVariables'}, TContext>`;
+      }>>, TError,${
+        definitions ? `{${definitions}}` : 'TVariables'
+      }, TContext>`;
 
   if (!isRequestOptions) {
     return `${type ? 'queryOptions' : 'mutationOptions'}?: ${definition}`;
@@ -347,11 +349,11 @@ const generateQueryReturnType = ({
 }) => {
   switch (outputClient) {
     case OutputClient.SVELTE_QUERY:
-      return `Use${pascal(type)}StoreResult<AsyncReturnType<${
+      return `Use${pascal(type)}StoreResult<Awaited<ReturnType<${
         isMutatorHook
           ? `ReturnType<typeof use${pascal(operationName)}Hook>`
           : `typeof ${operationName}`
-      }>, TError, TData, QueryKey>`;
+      }>>, TError, TData, QueryKey>`;
     case OutputClient.VUE_QUERY:
       return ` UseQueryReturnType<TData, TError, Use${pascal(
         type,
@@ -424,12 +426,12 @@ const generateQueryImplementation = ({
   return `
 export type ${pascal(
     name,
-  )}QueryResult = NonNullable<AsyncReturnType<${dataType}>>
+  )}QueryResult = NonNullable<Awaited<ReturnType<${dataType}>>>
 export type ${pascal(name)}QueryError = ${errorType}
 
 export const ${camel(
     `use-${name}`,
-  )} = <TData = AsyncReturnType<${dataType}>, TError = ${errorType}>(\n ${queryProps} ${generateQueryArguments(
+  )} = <TData = Awaited<ReturnType<${dataType}>>, TError = ${errorType}>(\n ${queryProps} ${generateQueryArguments(
     {
       operationName,
       definitions: '',
@@ -459,11 +461,11 @@ export const ${camel(
       : ''
   }
 
-  const queryFn: QueryFunction<AsyncReturnType<${
+  const queryFn: QueryFunction<Awaited<ReturnType<${
     mutator?.isHook
       ? `ReturnType<typeof use${pascal(operationName)}Hook>`
       : `typeof ${operationName}`
-  }>> = (${
+  }>>> = (${
     queryParam && props.some(({ type }) => type === 'queryParam')
       ? `{ signal, pageParam }`
       : '{ signal }'
@@ -477,11 +479,11 @@ export const ${camel(
       : ''
   });
 
-  const query = ${camel(`use-${type}`)}<AsyncReturnType<${
+  const query = ${camel(`use-${type}`)}<Awaited<ReturnType<${
     mutator?.isHook
       ? `ReturnType<typeof use${pascal(operationName)}Hook>`
       : `typeof ${operationName}`
-  }>, TError, TData>(queryKey, queryFn, ${generateQueryOptions({
+  }>>, TError, TData>(queryKey, queryFn, ${generateQueryOptions({
     params,
     options,
     type,
@@ -507,7 +509,7 @@ const generateQueryHook = (
     response,
     operationId,
   }: GeneratorVerbOptions,
-  { route, override: { operations = {} } }: GeneratorOptions,
+  { route, override: { operations = {} }, context }: GeneratorOptions,
   outputClient: OutputClient | OutputClientFunc,
 ) => {
   const query = override?.query;
@@ -606,7 +608,7 @@ const generateQueryHook = (
   return `
     export type ${pascal(
       operationName,
-    )}MutationResult = NonNullable<AsyncReturnType<${dataType}>>
+    )}MutationResult = NonNullable<Awaited<ReturnType<${dataType}>>>
     ${
       body.definition
         ? `export type ${pascal(operationName)}MutationBody = ${
@@ -645,7 +647,7 @@ const generateQueryHook = (
       }
 
 
-      const mutationFn: MutationFunction<AsyncReturnType<${dataType}>, ${
+      const mutationFn: MutationFunction<Awaited<ReturnType<${dataType}>>, ${
     definitions ? `{${definitions}}` : 'TVariables'
   }> = (${properties ? 'props' : ''}) => {
           ${properties ? `const {${properties}} = props ?? {}` : ''};
@@ -661,7 +663,7 @@ const generateQueryHook = (
   })
         }
 
-      return useMutation<AsyncReturnType<typeof ${operationName}>, TError, ${
+      return useMutation<Awaited<ReturnType<typeof ${operationName}>>, TError, ${
     definitions ? `{${definitions}}` : 'TVariables'
   }, TContext>(mutationFn, mutationOptions)
     }
@@ -673,13 +675,18 @@ export const generateQueryTitle = () => '';
 export const generateQueryHeader = ({
   isRequestOptions,
   isMutator,
+  hasAwaitedType,
 }: {
   isRequestOptions: boolean;
   isMutator: boolean;
-}) => `// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type AsyncReturnType<
-T extends (...args: any) => Promise<any>
-> = T extends (...args: any) => Promise<infer R> ? R : any;\n\n
+  hasAwaitedType: boolean;
+}) => {
+  return `${
+    !hasAwaitedType
+      ? `export type AwaitedInput<T> = PromiseLike<T> | T;\n
+      export type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;\n\n`
+      : ''
+  }
 ${
   isRequestOptions && isMutator
     ? `// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -691,6 +698,7 @@ ${
   : never;\n\n`
     : ''
 }`;
+};
 
 export const generateQueryFooter = () => '';
 

diff --git a/src/core/generators/swr.ts b/src/core/generators/swr.ts
@@ -157,7 +157,7 @@ const generateSwrArguments = ({
   mutator?: GeneratorMutator;
   isRequestOptions: boolean;
 }) => {
-  const definition = `SWRConfiguration<AsyncReturnType<typeof ${operationName}>, TError> & {swrKey: Key}`;
+  const definition = `SWRConfiguration<Awaited<ReturnType<typeof ${operationName}>>, TError> & {swrKey: Key}`;
 
   if (!isRequestOptions) {
     return `swrOptions?: ${definition}`;
@@ -210,7 +210,7 @@ const generateSwrImplementation = ({
   return `
 export type ${pascal(
     operationName,
-  )}QueryResult = NonNullable<AsyncReturnType<typeof ${operationName}>>
+  )}QueryResult = NonNullable<Awaited<ReturnType<typeof ${operationName}>>>
 export type ${pascal(operationName)}QueryError = ${errorType}
 
 export const ${camel(
@@ -246,7 +246,7 @@ export const ${camel(
       : ''
   });
 
-  const query = useSwr<AsyncReturnType<typeof swrFn>, TError>(swrKey, swrFn, swrOptions)
+  const query = useSwr<Awaited<ReturnType<typeof swrFn>>, TError>(swrKey, swrFn, swrOptions)
 
   return {
     swrKey,
@@ -307,24 +307,30 @@ export const generateSwrTitle = () => '';
 export const generateSwrHeader = ({
   isRequestOptions,
   isMutator,
+  hasAwaitedType,
 }: {
   isRequestOptions: boolean;
   isMutator: boolean;
-}) => `// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type AsyncReturnType<
-T extends (...args: any) => Promise<any>
-> = T extends (...args: any) => Promise<infer R> ? R : any;\n\n
-${
-  isRequestOptions && isMutator
-    ? `// eslint-disable-next-line @typescript-eslint/no-explicit-any
+  hasAwaitedType: boolean;
+}) =>
+  `
+  ${
+    !hasAwaitedType
+      ? `export type AwaitedInput<T> = PromiseLike<T> | T;\n
+      export type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;\n\n`
+      : ''
+  }
+  ${
+    isRequestOptions && isMutator
+      ? `// eslint-disable-next-line @typescript-eslint/no-explicit-any
   type SecondParameter<T extends (...args: any) => any> = T extends (
   config: any,
   args: infer P,
 ) => any
   ? P
   : never;\n\n`
-    : ''
-}`;
+      : ''
+  }`;
 
 export const generateSwrFooter = () => '';
 

diff --git a/src/core/importers/openApi.ts b/src/core/importers/openApi.ts
@@ -1,6 +1,6 @@
 import omit from 'lodash.omit';
 import { OpenAPIObject } from 'openapi3-ts';
-import { ImportOpenApi, InputOptions } from '../../types';
+import { ContextSpecs, ImportOpenApi, InputOptions } from '../../types';
 import { GeneratorSchema } from '../../types/generator';
 import { WriteSpecsProps } from '../../types/writers';
 import { asyncReduce } from '../../utils/async-reduce';
@@ -60,14 +60,15 @@ export const importOpenApi = async ({
   const schemas = await asyncReduce(
     Object.entries(specs),
     async (acc, [specKey, spec]) => {
-      const context = {
+      const context: ContextSpecs = {
         specKey,
         target,
         workspace,
         specs,
         override: output.override,
         tslint: output.tslint,
         tsconfig: output.tsconfig,
+        packageJson: output.packageJson,
       };
 
       // First version to try to handle non-openapi files
@@ -137,6 +138,7 @@ export const importOpenApi = async ({
       override: output.override,
       tslint: output.tslint,
       tsconfig: output.tsconfig,
+      packageJson: output.packageJson,
     },
   });
 

diff --git a/src/core/writers/target.ts b/src/core/writers/target.ts
@@ -1,3 +1,4 @@
+import { compare } from 'compare-versions';
 import { InfoObject } from 'openapi3-ts';
 import { NormalizedOutputOptions, OutputClient } from '../../types';
 import {
@@ -44,6 +45,11 @@ export const generateTarget = (
         const isMutator = acc.mutators.some((mutator) =>
           isAngularClient ? mutator.hasThirdArg : mutator.hasSecondArg,
         );
+
+        const typescriptVersion =
+          options.packageJson?.dependencies?.['typescript'] ?? '4.4.0';
+        const hasAwaitedType = compare(typescriptVersion, '4.5.0', '>=');
+
         const header = generateClientHeader({
           outputClient: options.client,
           isRequestOptions: options.override.requestOptions !== false,
@@ -53,6 +59,7 @@ export const generateTarget = (
           customTitleFunc: options.override.title,
           provideInRoot: !!options.override.angular.provideIn,
           provideIn: options.override.angular.provideIn,
+          hasAwaitedType,
         });
         acc.implementation = header.implementation + acc.implementation;
         acc.implementationMSW.handler =

diff --git a/src/core/writers/targetTags.ts b/src/core/writers/targetTags.ts
@@ -1,3 +1,4 @@
+import { compare } from 'compare-versions';
 import { NormalizedOutputOptions, OutputClient } from '../../types';
 import {
   GeneratorOperation,
@@ -98,6 +99,10 @@ export const generateTargetForTags = (
             customTitleFunc: options.override.title,
           });
 
+          const typescriptVersion =
+            options.packageJson?.dependencies?.['typescript'] ?? '4.4.0';
+          const hasAwaitedType = compare(typescriptVersion, '4.5.0', '>=');
+
           const header = generateClientHeader({
             outputClient: options.client,
             isRequestOptions: options.override.requestOptions !== false,
@@ -107,6 +112,7 @@ export const generateTargetForTags = (
             customTitleFunc: options.override.title,
             provideInRoot: !!options.override.angular.provideIn,
             provideIn: options.override.angular.provideIn,
+            hasAwaitedType,
           });
 
           acc[tag] = {

diff --git a/src/types/generator.ts b/src/types/generator.ts
@@ -146,6 +146,7 @@ export type ClientHeaderBuilder = (params: {
   isGlobalMutator: boolean;
   provideInRoot: boolean;
   provideIn: boolean | 'root' | 'any';
+  hasAwaitedType: boolean;
 }) => string;
 
 export type ClientFooterBuilder = (params: {