[api-extractor] Upgrade bundled TypeScript to 5.7 (#4815)

* WIP: [api-extractor] Upgrade bundled TypeScript to 5.5 1. Upgrade TypeScript to `5.5.2` 2. Upgrade @typescript-eslint/parser to `7.14.1` 3. Adopt breaking changes of typescript-eslint * rush change * Upgrade API Extractor's bundled TypeScript version to 5.7.2 * Update TypeScriptInternals.ts to reflect changes in TypeScript 5.7.2 NOTE: This is a type signature change that didn't affect the runtime contract; it should be fully backwards compatible * rush update * Fix a warning caused by TypeScript 5.7.2 strict checks complaining about resolve() signatures being inconsistent between @types/node/module.d.ts and lib.dom.d.ts: Warning: C:/Git/rushstack/common/temp/default/node_modules/.pnpm/@types [email protected]/node_modules/@types/node/module.d.ts:210:13 - (TS2386) Overload signatures must all be optional or required. * Temporarily suppress warning caused by TypeScript 5.7.2 being incompatible with @types/[email protected]: Warning: C:\Git\rushstack\common\temp\default\node_modules\.pnpm\@types [email protected]\node_modules\@types\node\ts3.2\globals.d.ts:10:11 - (TS2320) Interface 'Buffer' cannot simultaneously extend types 'Uint8Array<ArrayBuffer>' and 'Uint8Array<ArrayBufferLike>'. Named property 'buffer' of types 'Uint8Array<ArrayBuffer>' and 'Uint8Array<ArrayBufferLike>' are not identical. * rush change --------- Co-authored-by: Qingyu Wang <[email protected]> Co-authored-by: Pete Gonzalez <[email protected]>
microsoft · Jan 7, 2025 · 62825ff · 62825ff
1 parent d716cce
commit 62825ff
Show file tree

Hide file tree

Showing 24 changed files with 61 additions and 42 deletions.
diff --git a/apps/api-extractor/package.json b/apps/api-extractor/package.json
@@ -49,7 +49,7 @@
     "resolve": "~1.22.1",
     "semver": "~7.5.4",
     "source-map": "~0.6.1",
-    "typescript": "5.4.2"
+    "typescript": "5.7.2"
   },
   "devDependencies": {
     "@rushstack/heft-node-rig": "2.6.44",

diff --git a/apps/api-extractor/src/analyzer/TypeScriptInternals.ts b/apps/api-extractor/src/analyzer/TypeScriptInternals.ts
@@ -101,12 +101,12 @@ export class TypeScriptInternals {
    * Gets the mode required for module resolution required with the addition of Node16/nodenext
    */
   public static getModeForUsageLocation(
-    file: { impliedNodeFormat?: ts.SourceFile['impliedNodeFormat'] },
+    file: ts.SourceFile,
     usage: ts.StringLiteralLike,
     compilerOptions: ts.CompilerOptions
   ): ts.ModuleKind.CommonJS | ts.ModuleKind.ESNext | undefined {
     // Compiler internal:
-    // https://github.com/microsoft/TypeScript/blob/v4.7.2/src/compiler/program.ts#L568
+    // https://github.com/microsoft/TypeScript/blob/v5.7.2/src/compiler/program.ts#L940
 
     return ts.getModeForUsageLocation?.(file, usage, compilerOptions);
   }

diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts
@@ -266,7 +266,7 @@ export class ApiModelGenerator {
   }
 
   private _tryFindFunctionDeclaration(astDeclaration: AstDeclaration): ts.FunctionDeclaration | undefined {
-    const children: ts.Node[] = astDeclaration.declaration.getChildren(
+    const children: readonly ts.Node[] = astDeclaration.declaration.getChildren(
       astDeclaration.declaration.getSourceFile()
     );
     return children.find(ts.isFunctionTypeNode) as ts.FunctionDeclaration | undefined;

diff --git a/build-tests/api-documenter-scenarios/tsconfig.json b/build-tests/api-documenter-scenarios/tsconfig.json
@@ -9,7 +9,7 @@
     "experimentalDecorators": true,
     "strictNullChecks": true,
     "types": ["node", "jest"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts"]

diff --git a/build-tests/api-extractor-d-cts-test/tsconfig.json b/build-tests/api-extractor-d-cts-test/tsconfig.json
@@ -9,7 +9,7 @@
     "experimentalDecorators": true,
     "strictNullChecks": true,
     "types": ["node", "jest"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.cts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-d-mts-test/tsconfig.json b/build-tests/api-extractor-d-mts-test/tsconfig.json
@@ -9,7 +9,7 @@
     "experimentalDecorators": true,
     "strictNullChecks": true,
     "types": ["node", "jest"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.mts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-lib1-test/tsconfig.json b/build-tests/api-extractor-lib1-test/tsconfig.json
@@ -7,7 +7,7 @@
     "sourceMap": true,
     "experimentalDecorators": true,
     "strictNullChecks": true,
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts"]

diff --git a/build-tests/api-extractor-lib2-test/tsconfig.json b/build-tests/api-extractor-lib2-test/tsconfig.json
@@ -9,7 +9,7 @@
     "experimentalDecorators": true,
     "strictNullChecks": true,
     "types": ["node", "jest"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-lib3-test/tsconfig.json b/build-tests/api-extractor-lib3-test/tsconfig.json
@@ -9,7 +9,7 @@
     "experimentalDecorators": true,
     "strictNullChecks": true,
     "types": ["node", "jest"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-lib4-test/tsconfig.json b/build-tests/api-extractor-lib4-test/tsconfig.json
@@ -9,7 +9,7 @@
     "experimentalDecorators": true,
     "strictNullChecks": true,
     "types": ["node", "jest"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-lib5-test/tsconfig.json b/build-tests/api-extractor-lib5-test/tsconfig.json
@@ -9,7 +9,7 @@
     "experimentalDecorators": true,
     "strictNullChecks": true,
     "types": ["node", "jest"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-test-01/tsconfig.json b/build-tests/api-extractor-test-01/tsconfig.json
@@ -10,7 +10,7 @@
     "strictNullChecks": true,
     "esModuleInterop": true,
     "types": ["node", "jest"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-test-02/tsconfig.json b/build-tests/api-extractor-test-02/tsconfig.json
@@ -10,7 +10,7 @@
     "strictNullChecks": true,
     "esModuleInterop": true,
     "types": ["node"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-test-03/tsconfig.json b/build-tests/api-extractor-test-03/tsconfig.json
@@ -10,7 +10,7 @@
     "strictNullChecks": true,
     "esModuleInterop": true,
     "types": ["node", "jest"],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-test-04/beta-consumer/tsconfig.json b/build-tests/api-extractor-test-04/beta-consumer/tsconfig.json
@@ -8,7 +8,7 @@
     "declarationMap": true,
     "experimentalDecorators": true,
     "strictNullChecks": true,
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts", "typings/tsd.d.ts"]

diff --git a/build-tests/api-extractor-test-04/tsconfig.json b/build-tests/api-extractor-test-04/tsconfig.json
@@ -10,7 +10,7 @@
     "strictNullChecks": true,
     "esModuleInterop": true,
     "types": [],
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"],
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable"],
     "outDir": "lib"
   },
   "include": ["src/**/*.ts", "typings/tsd.d.ts"]

diff --git a/build-tests/heft-typescript-v2-test/tsconfig.json b/build-tests/heft-typescript-v2-test/tsconfig.json
@@ -18,7 +18,10 @@
 
     "module": "commonjs",
     "target": "es2017",
-    "lib": ["es2017"]
+    "lib": ["es2017"],
+
+    // TODO: REVERT THIS AFTER WE UPGRADE heft-typescript-v2-test TO A NEWER VERSION
+    "skipLibCheck": true
   },
   "include": ["src/**/*.ts", "src/**/*.tsx"],
   "exclude": ["node_modules", "lib"]

diff --git a/common/changes/@microsoft/api-extractor/main_2024-06-27-03-27.json b/common/changes/@microsoft/api-extractor/main_2024-06-27-03-27.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "comment": "Upgrade the bundled compiler engine to TypeScript 5.7.2",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@microsoft/api-extractor"
+}
diff --git a/common/config/subspaces/build-tests-subspace/common-versions.json b/common/config/subspaces/build-tests-subspace/common-versions.json
@@ -97,7 +97,7 @@
       "~4.9.5",
 
       // API Extractor bundles a specific TypeScript version because it calls internal APIs
-      "5.4.2"
+      "5.7.2"
     ],
     "source-map": [
       "~0.6.1" // API Extractor is using an older version of source-map because newer versions are async

diff --git a/common/config/subspaces/build-tests-subspace/pnpm-lock.yaml b/common/config/subspaces/build-tests-subspace/pnpm-lock.yaml
diff --git a/common/config/subspaces/build-tests-subspace/repo-state.json b/common/config/subspaces/build-tests-subspace/repo-state.json
@@ -1,6 +1,6 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "bd75fc59a5df40deec1cf3db51e99ab1a7eb35f6",
+  "pnpmShrinkwrapHash": "cc2a213121844e88f739b521181daa5d860d33b2",
   "preferredVersionsHash": "ce857ea0536b894ec8f346aaea08cfd85a5af648",
-  "packageJsonInjectedDependenciesHash": "3f1f7f2e64fc15d64eef6c0311adc38dff344509"
+  "packageJsonInjectedDependenciesHash": "7b4bb13bdb42ab5aada7a6f5ab8ec6694ea61721"
 }
diff --git a/common/config/subspaces/default/common-versions.json b/common/config/subspaces/default/common-versions.json
@@ -100,7 +100,7 @@
       "~4.9.5",
 
       // API Extractor bundles a specific TypeScript version because it calls internal APIs
-      "5.4.2"
+      "5.7.2"
     ],
     "source-map": [
       "~0.6.1" // API Extractor is using an older version of source-map because newer versions are async

diff --git a/common/config/subspaces/default/pnpm-lock.yaml b/common/config/subspaces/default/pnpm-lock.yaml
diff --git a/common/config/subspaces/default/repo-state.json b/common/config/subspaces/default/repo-state.json
@@ -1,5 +1,5 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "7b913e5ca364b30654436bba1a36ea570496f25c",
+  "pnpmShrinkwrapHash": "77d6789469edc916cd005c6b493ab4d37d68ed64",
   "preferredVersionsHash": "ce857ea0536b894ec8f346aaea08cfd85a5af648"
 }