fix(api): simple index info has parameter info

mxsdev · Oct 27, 2022 · 3b477b5 · 3b477b5
1 parent 0f99fe8
commit 3b477b5
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 26 deletions.
diff --git a/packages/api/src/tree.ts b/packages/api/src/tree.ts
@@ -17,7 +17,6 @@ import {
     getIntersectionTypesFlat,
     getSymbolType,
     getTypeId,
-    TSIndexInfoMerged,
     isPureObject,
     wrapSafe,
     isArrayType,
@@ -42,6 +41,7 @@ import {
     TypescriptContext,
     removeDuplicates,
     narrowDeclarationForLocation,
+    TSIndexInfo,
 } from "./util"
 
 const maxDepthExceeded: TypeInfo = { kind: "max_depth", id: getEmptyTypeId() }
@@ -556,7 +556,7 @@ function _generateTypeTree(
         })
     }
 
-    function getIndexInfo(indexInfo: TSIndexInfoMerged): IndexInfo {
+    function getIndexInfo({ info: indexInfo, type }: TSIndexInfo): IndexInfo {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const parameterSymbol: ts.Symbol =
             // @ts-expect-error This info exists on the object but is not publicly exposed by type info
@@ -565,8 +565,9 @@ function _generateTypeTree(
             indexInfo?.parameterType?.getSymbol()
 
         const parameterType =
-            indexInfo?.parameterType ??
-            (parameterSymbol && getSymbolType(tsCtx, parameterSymbol))
+            type === "parameter" &&
+            (indexInfo?.parameterType ??
+                (parameterSymbol && getSymbolType(tsCtx, parameterSymbol)))
 
         return {
             ...(indexInfo.keyType && { keyType: parseType(indexInfo.keyType) }),

diff --git a/packages/api/src/util.ts b/packages/api/src/util.ts
@@ -218,6 +218,9 @@ export type TSIndexInfoMerged = {
     type?: ts.Type
     parameterType?: ts.Type
 }
+
+export type TSIndexInfoType = "simple" | "parameter"
+
 interface MappedType extends ts.Type {
     declaration: ts.MappedTypeNode
     typeParameter?: ts.TypeParameter
@@ -229,12 +232,16 @@ interface MappedType extends ts.Type {
     // containsError?: boolean;
 }
 
+export type TSIndexInfo = { type: TSIndexInfoType; info: TSIndexInfoMerged }
+
 export function getIndexInfos(
     { typeChecker, ts }: TypescriptContext,
     type: ts.Type
 ) {
-    const indexInfos: TSIndexInfoMerged[] = [
-        ...typeChecker.getIndexInfosOfType(type),
+    const indexInfos: TSIndexInfo[] = [
+        ...typeChecker
+            .getIndexInfosOfType(type)
+            .map((info) => ({ type: "simple", info } as const)),
     ]
 
     if (
@@ -247,10 +254,13 @@ export function getIndexInfos(
 
         if (mappedType.typeParameter) {
             indexInfos.push({
-                keyType: mappedType.constraintType,
-                type: mappedType.templateType,
-                parameterType: mappedType.typeParameter,
-                declaration: mappedType.declaration,
+                type: "parameter",
+                info: {
+                    keyType: mappedType.constraintType,
+                    type: mappedType.templateType,
+                    parameterType: mappedType.typeParameter,
+                    declaration: mappedType.declaration,
+                },
             })
         }
     }

diff --git a/tests/baselines/reference/interfaceWithIndex.localized.tree b/tests/baselines/reference/interfaceWithIndex.localized.tree
@@ -68,13 +68,10 @@ interface InterfaceWithIndex {
                     "kindText": "string",
                     "kind": "primitive",
                     "primitiveKind": "string",
-                    "purpose": "index_parameter_type",
+                    "purpose": "index_type",
                     "children": [],
                     "_id": "1"
                 },
-                {
-                    "reference": "1"
-                },
                 {
                     "reference": "1"
                 }

diff --git a/tests/baselines/reference/interfaceWithIndex.tree b/tests/baselines/reference/interfaceWithIndex.tree
@@ -68,10 +68,6 @@ interface InterfaceWithIndex {
                         }
                     }
                 ]
-            },
-            "parameterType": {
-                "kind": "reference",
-                "id": "2"
             }
         }
     ],

diff --git a/tests/baselines/reference/mapped.localized.tree b/tests/baselines/reference/mapped.localized.tree
@@ -65,13 +65,10 @@ type mapped = { [index: string]: number }
                     "kindText": "string",
                     "kind": "primitive",
                     "primitiveKind": "string",
-                    "purpose": "index_parameter_type",
+                    "purpose": "index_type",
                     "children": [],
                     "_id": "1"
                 },
-                {
-                    "reference": "1"
-                },
                 {
                     "kindText": "number",
                     "kind": "primitive",

diff --git a/tests/baselines/reference/mapped.tree b/tests/baselines/reference/mapped.tree
@@ -36,10 +36,6 @@ type mapped = { [index: string]: number }
                         }
                     }
                 ]
-            },
-            "parameterType": {
-                "kind": "reference",
-                "id": "2"
             }
         }
     ],