feat: improve function parameter reusage

plantain-00 · Jan 3, 2022 · 9799a83 · 9799a83
1 parent 1217ff0
commit 9799a83
Show file tree

Hide file tree

Showing 9 changed files with 93 additions and 11 deletions.
diff --git a/demo/cases.gql b/demo/cases.gql
@@ -93,7 +93,6 @@ type TypeIntersection2 {
 type TypeIntersection {
   typeIntersectionMember1: TypeIntersection1!
   typeIntersectionMember2: TypeIntersection2!
-  typeIntersectionMember3: JSON!
 }
 
 type TypeUnionAndIntersection {

diff --git a/demo/cases.json b/demo/cases.json
@@ -702,7 +702,16 @@
         "typeIntersectionMember2": {
           "$ref": "#/definitions/TypeIntersection2"
         },
-        "typeIntersectionMember3": {}
+        "typeIntersectionMember3": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/TypeLiteral"
+            },
+            {
+              "$ref": "#/definitions/Interface"
+            }
+          ]
+        }
       },
       "required": [
         "typeIntersectionMember1",

diff --git a/demo/cases.md b/demo/cases.md
@@ -138,7 +138,7 @@ Field | Required | Type | Description
 --- | --- | --- | ---
 `typeIntersectionMember1` | `true` | [`TypeIntersection1`](#TypeIntersection1) |
 `typeIntersectionMember2` | `true` | [`TypeIntersection2`](#TypeIntersection2) |
-`typeIntersectionMember3` | `true` | `unknown` |
+`typeIntersectionMember3` | `true` | [`TypeLiteral`](#TypeLiteral) | [`Interface`](#Interface) |
 
 ## `TypeUnionAndIntersection`
 

diff --git a/demo/debug.json b/demo/debug.json
@@ -905,6 +905,27 @@
       {
         "name": "typeIntersectionMember3",
         "type": {
+          "kind": "union",
+          "members": [
+            {
+              "kind": "reference",
+              "name": "TypeLiteral",
+              "position": {
+                "file": "demo/cases.ts",
+                "line": 80,
+                "character": 27
+              }
+            },
+            {
+              "kind": "reference",
+              "name": "Interface",
+              "position": {
+                "file": "demo/cases.ts",
+                "line": 80,
+                "character": 41
+              }
+            }
+          ],
           "position": {
             "file": "demo/cases.ts",
             "line": 80,

diff --git a/demo/root-type.ts b/demo/root-type.ts
@@ -90,7 +90,7 @@ export interface TypeIntersection2 {
 export interface TypeIntersection {
   typeIntersectionMember1: TypeIntersection1
   typeIntersectionMember2: TypeIntersection2
-  typeIntersectionMember3: any
+  typeIntersectionMember3: TypeLiteral | Interface
 }
 
 export interface TypeUnionAndIntersection {

diff --git a/demo/typescript.ts b/demo/typescript.ts
@@ -98,7 +98,7 @@ interface TypeIntersection2 {
 interface TypeIntersection {
   typeIntersectionMember1: TypeIntersection1
   typeIntersectionMember2: TypeIntersection2
-  typeIntersectionMember3: unknown
+  typeIntersectionMember3: TypeLiteral | Interface
 }
 
 interface TypeUnionAndIntersection {

diff --git a/src/core.ts b/src/core.ts
@@ -83,3 +83,4 @@ export class Generator {
 export * from './utils'
 export * from './typescript-generator'
 export * from './json-schema-generator'
+export * from './swagger-doc-generator'
diff --git a/src/parser.ts b/src/parser.ts
@@ -526,8 +526,8 @@ export class Parser {
     if (ts.isTypeReferenceNode(type)) {
       return this.getTypeOfTypeReference(type, sourceFile)
     }
-    if (ts.isUnionTypeNode(type)) {
-      return this.getTypeOfUnionType(type, sourceFile)
+    if (ts.isUnionTypeNode(type) || ts.isIntersectionTypeNode(type)) {
+      return this.getTypeOfUnionTypeOrIntersectionType(type, sourceFile)
     }
     if (ts.isLiteralTypeNode(type)) {
       if (type.literal.kind === ts.SyntaxKind.NullKeyword) {
@@ -712,7 +712,7 @@ export class Parser {
     }
   }
 
-  private getTypeOfUnionType(unionType: ts.UnionTypeNode, sourceFile: ts.SourceFile): Type {
+  private getTypeOfUnionTypeOrIntersectionType(unionType: ts.UnionTypeNode | ts.IntersectionTypeNode, sourceFile: ts.SourceFile): Type {
     if (unionType.types.every(u => ts.isLiteralTypeNode(u))) {
       let enumType: EnumValueType | undefined
       const enums: unknown[] = []

diff --git a/src/swagger-doc-generator.ts b/src/swagger-doc-generator.ts
@@ -1,4 +1,4 @@
-import { Context, getReferencesInType } from './utils'
+import { Context, FunctionDeclaration, FunctionParameter, getReferencesInType, TypeDeclaration } from './utils'
 import { getAllDefinitions, getReferencedDefinitions, Definition, getJsonSchemaProperty } from './json-schema-generator'
 
 export function generateSwaggerDoc(context: Context, swaggerBase?: Record<string, unknown>) {
@@ -12,11 +12,12 @@ export function generateSwaggerDoc(context: Context, swaggerBase?: Record<string
         paths[typeDeclaration.path] = {}
       }
       referenceNames.push(...getReferencesInType(typeDeclaration.type).map((r) => r.name))
-      const useFormData = typeDeclaration.parameters.some((p) => p.type.kind === 'file')
+      const declarationParameters = getDeclarationParameters(typeDeclaration, context.declarations)
+      const useFormData = declarationParameters.some((p) => p.type.kind === 'file')
       paths[typeDeclaration.path]![typeDeclaration.method] = {
         consumes: useFormData ? ['multipart/form-data'] : undefined,
         operationId: typeDeclaration.name,
-        parameters: typeDeclaration.parameters.map((parameter) => {
+        parameters: declarationParameters.map((parameter) => {
           referenceNames.push(...getReferencesInType(parameter.type).map((r) => r.name))
           const schema = getJsonSchemaProperty(parameter.type, context)
           return {
@@ -55,3 +56,54 @@ export function generateSwaggerDoc(context: Context, swaggerBase?: Record<string
   }
   return JSON.stringify(result, null, 2)
 }
+
+const allTypes = ['path', 'query', 'body']
+
+/**
+ * @public
+ */
+export function getDeclarationParameters(
+  declaration: FunctionDeclaration,
+  typeDeclarations: TypeDeclaration[],
+) {
+  const result: FunctionParameter[] = []
+  for (const parameter of declaration.parameters) {
+    if (!parameter.in && allTypes.includes(parameter.name)) {
+      const parameterType = parameter.type
+      if (parameterType.kind === 'reference') {
+        const typeDeclaration = typeDeclarations.find((d) => d.name === parameterType.name)
+        if (typeDeclaration && typeDeclaration.kind === 'object') {
+          result.push(...typeDeclaration.members.map((m) => ({
+            ...m,
+            in: parameter.name,
+          })))
+        }
+      } else if (parameterType.kind === 'union') {
+        for (const member of parameterType.members) {
+          if (member.kind === 'reference') {
+            const typeDeclaration = typeDeclarations.find((d) => d.name === member.name)
+            if (typeDeclaration && typeDeclaration.kind === 'object') {
+              result.push(...typeDeclaration.members.map((m) => ({
+                ...m,
+                in: parameter.name,
+              })))
+            }
+          } else if (member.kind === 'object') {
+            result.push(...member.members.map((m) => ({
+              ...m,
+              in: parameter.name,
+            })))
+          }
+        }
+      } else if (parameterType.kind === 'object') {
+        result.push(...parameterType.members.map((m) => ({
+          ...m,
+          in: parameter.name,
+        })))
+      }
+    } else {
+      result.push(parameter)
+    }
+  }
+  return result
+}