refactor: generate cleaner type

Julien-R44 · May 1, 2024 · 9b09b93 · 9b09b93
1 parent 8c9fcc6
commit 9b09b93
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 21 deletions.
diff --git a/packages/core/commands/generate.ts b/packages/core/commands/generate.ts
@@ -1,15 +1,17 @@
 import { Project, QuoteKind } from 'ts-morph'
-import { BaseCommand } from '@adonisjs/core/ace'
+import { BaseCommand, flags } from '@adonisjs/core/ace'
 import type { CommandOptions } from '@adonisjs/core/types/ace'
 
 import { ApiTypesGenerator } from '../src/codegen/api_types_generator.js'
 
 export default class CodegenTypes extends BaseCommand {
   static override commandName = 'tuyau:generate'
   static override description = 'Tuyau generator command'
-
   static override options: CommandOptions = { startApp: true }
 
+  @flags.boolean({ description: 'Verbose logs', default: false, alias: 'v' })
+  declare verbose: boolean
+
   /**
    * Get routes from the router instance
    */

diff --git a/packages/core/src/codegen/api_types_generator.ts b/packages/core/src/codegen/api_types_generator.ts
@@ -147,9 +147,7 @@ export class ApiTypesGenerator {
 
     file.insertText(0, (writer) => {
       writer
-        .writeLine(
-          `import type { MakeOptional, Serialize, Simplify, ConvertReturnTypeToRecordStatusResponse } from '@tuyau/utils/types'`,
-        )
+        .writeLine(`import type { MakeTuyauRequest, MakeTuyauResponse } from '@tuyau/utils/types'`)
         .writeLine(`import type { InferInput } from '@vinejs/vine/types'`)
         .newLine()
         .writeLine(`export interface AdonisApi {`)
@@ -242,8 +240,8 @@ export class ApiTypesGenerator {
           currentLevel['$url'] = {}
           for (const method of methods) {
             currentLevel[method] = {
-              request: schemaImport ? `MakeOptional<${schemaImport}>` : 'unknown',
-              response: `Simplify<Serialize<ConvertReturnTypeToRecordStatusResponse<Awaited<ReturnType<typeof import('${relativePath}').default['prototype']['${routeHandler.method}']>>>>>`,
+              request: schemaImport ? `MakeTuyauRequest<${schemaImport}>` : 'unknown',
+              response: `MakeTuyauResponse<import('${relativePath}').default['${routeHandler.method}']>`,
             }
           }
         }

diff --git a/packages/core/tests/api_types_generator.spec.ts b/packages/core/tests/api_types_generator.spec.ts
@@ -54,7 +54,7 @@ test.group('Api Types Generator', () => {
 
     const file = await fs.contents('./.adonisjs/types/api.d.ts')
     assert.snapshot(file).matchInline(`
-      "import type { MakeOptional, Serialize, Simplify, ConvertReturnTypeToRecordStatusResponse } from '@tuyau/utils/types'
+      "import type { MakeTuyauRequest, MakeTuyauResponse } from '@tuyau/utils/types'
       import type { InferInput } from '@vinejs/vine/types'
 
       export interface AdonisApi {
@@ -63,7 +63,7 @@ test.group('Api Types Generator', () => {
           };
           '$get': {
             'request': unknown;
-            'response': Simplify<Serialize<ConvertReturnTypeToRecordStatusResponse<Awaited<ReturnType<typeof import('../../app/controllers/users_controller.ts').default['prototype']['index']>>>>>;
+            'response': MakeTuyauResponse<import('../../app/controllers/users_controller.ts').default['index']>;
           };
         };
       }
@@ -117,16 +117,16 @@ test.group('Api Types Generator', () => {
 
     const file = await fs.contents('./.adonisjs/types/api.d.ts')
     assert.snapshot(file).matchInline(`
-      "import type { MakeOptional, Serialize, Simplify, ConvertReturnTypeToRecordStatusResponse } from '@tuyau/utils/types'
+      "import type { MakeTuyauRequest, MakeTuyauResponse } from '@tuyau/utils/types'
       import type { InferInput } from '@vinejs/vine/types'
 
       export interface AdonisApi {
         'users': {
           '$url': {
           };
           '$get': {
-            'request': MakeOptional<InferInput<typeof import('../../app/controllers/validator.ts')['getUsersValidator']>>;
-            'response': Simplify<Serialize<ConvertReturnTypeToRecordStatusResponse<Awaited<ReturnType<typeof import('../../app/controllers/users_controller.ts').default['prototype']['index']>>>>>;
+            'request': MakeTuyauRequest<InferInput<typeof import('../../app/controllers/validator.ts')['getUsersValidator']>>;
+            'response': MakeTuyauResponse<import('../../app/controllers/users_controller.ts').default['index']>;
           };
         };
       }

diff --git a/packages/utils/src/types.ts b/packages/utils/src/types.ts
@@ -89,3 +89,15 @@ type UndefinedProps<T extends object> = {
  * type Bar = MakeOptional<Foo> // { a: string, b?: number, c: boolean }
  */
 export type MakeOptional<T extends object> = UndefinedProps<T> & Omit<T, keyof UndefinedProps<T>>
+
+/**
+ * Shortcut for computing the Tuyau response type
+ */
+export type MakeTuyauResponse<T extends (...args: any) => any> = Simplify<
+  Serialize<ConvertReturnTypeToRecordStatusResponse<Awaited<ReturnType<T>>>>
+>
+
+/**
+ * Shortcut for computing the Tuyau request type
+ */
+export type MakeTuyauRequest<T extends object> = MakeOptional<T>
diff --git a/playground/.adonisjs/types/api.d.ts b/playground/.adonisjs/types/api.d.ts
@@ -1,23 +1,37 @@
-import type { MakeOptional, Serialize, Simplify, ConvertReturnTypeToRecordStatusResponse } from '@tuyau/utils/types'
+import type { MakeTuyauRequest, MakeTuyauResponse } from '@tuyau/utils/types'
 import type { InferInput } from '@vinejs/vine/types'
 
 export interface AdonisApi {
   'users': {
-    'get': {
-      'request': MakeOptional<InferInput<typeof import('../../app/validators/main.ts')['getUsersValidator']>>;
-      'response': Simplify<Serialize<ConvertReturnTypeToRecordStatusResponse<Awaited<ReturnType<typeof import('../../app/controllers/users_controller.ts').default['prototype']['index']>>>>>;
+    '$url': {
+    };
+    '$get': {
+      'request': MakeTuyauRequest<InferInput<typeof import('../../app/validators/main.ts')['getUsersValidator']>>;
+      'response': MakeTuyauResponse<import('../../app/controllers/users_controller.ts').default['index']>;
+    };
+    '$head': {
+      'request': MakeTuyauRequest<InferInput<typeof import('../../app/validators/main.ts')['getUsersValidator']>>;
+      'response': MakeTuyauResponse<import('../../app/controllers/users_controller.ts').default['index']>;
     };
   };
   'simple-text': {
-    'get': {
+    '$url': {
+    };
+    '$get': {
       'request': unknown;
-      'response': Simplify<Serialize<ConvertReturnTypeToRecordStatusResponse<Awaited<ReturnType<typeof import('../../app/controllers/users_controller.ts').default['prototype']['simpleText']>>>>>;
+      'response': MakeTuyauResponse<import('../../app/controllers/users_controller.ts').default['simpleText']>;
+    };
+    '$head': {
+      'request': unknown;
+      'response': MakeTuyauResponse<import('../../app/controllers/users_controller.ts').default['simpleText']>;
     };
   };
   'file-upload': {
-    'post': {
-      'request': MakeOptional<InferInput<typeof import('../../app/validators/main.ts')['uploadFileValidator']>>;
-      'response': Simplify<Serialize<ConvertReturnTypeToRecordStatusResponse<Awaited<ReturnType<typeof import('../../app/controllers/users_controller.ts').default['prototype']['fileUpload']>>>>>;
+    '$url': {
+    };
+    '$post': {
+      'request': MakeTuyauRequest<InferInput<typeof import('../../app/validators/main.ts')['uploadFileValidator']>>;
+      'response': MakeTuyauResponse<import('../../app/controllers/users_controller.ts').default['fileUpload']>;
     };
   };
 }