Support typesVersions in @types/web et al

Author: rbuckton

deploy/createTypesPackages.js

@@ -19,6 +19,8 @@ export const packages = [
     files: [
       { from: "../generated/dom.generated.d.ts", to: "index.d.ts" },
       { from: "../generated/dom.iterable.generated.d.ts", to: "iterable.d.ts", autoImport: true },
+      { from: "../generated/ts5.5/dom.generated.d.ts", to: "ts5.5/index.d.ts" },
+      { from: "../generated/ts5.5/dom.iterable.generated.d.ts", to: "ts5.5/iterable.d.ts", autoImport: true },
     ],
   },
   {
@@ -28,6 +30,8 @@ export const packages = [
     files: [
       { from: "../generated/serviceworker.generated.d.ts", to: "index.d.ts" },
       { from: "../generated/serviceworker.iterable.generated.d.ts", to: "iterable.d.ts", autoImport: true  },
+      { from: "../generated/ts5.5/serviceworker.generated.d.ts", to: "ts5.5/index.d.ts" },
+      { from: "../generated/ts5.5/serviceworker.iterable.generated.d.ts", to: "ts5.5/iterable.d.ts", autoImport: true  },
     ],
   },
   {
@@ -37,6 +41,8 @@ export const packages = [
     files: [
       { from: "../generated/audioworklet.generated.d.ts", to: "index.d.ts" },
       { from: "../generated/audioworklet.iterable.generated.d.ts", to: "iterable.d.ts", autoImport: true  },
+      { from: "../generated/ts5.5/audioworklet.generated.d.ts", to: "ts5.5/index.d.ts" },
+      { from: "../generated/ts5.5/audioworklet.iterable.generated.d.ts", to: "ts5.5/iterable.d.ts", autoImport: true  },
     ],
   },
   {
@@ -46,6 +52,8 @@ export const packages = [
     files: [
       { from: "../generated/sharedworker.generated.d.ts", to: "index.d.ts" },
       { from: "../generated/sharedworker.iterable.generated.d.ts", to: "iterable.d.ts", autoImport: true },
+      { from: "../generated/ts5.5/sharedworker.generated.d.ts", to: "ts5.5/index.d.ts" },
+      { from: "../generated/ts5.5/sharedworker.iterable.generated.d.ts", to: "ts5.5/iterable.d.ts", autoImport: true },
     ],
   },
 ];
@@ -84,10 +92,10 @@ const go = async () => {
 
     // Add the reference files in the config above
     pkg.files.forEach((fileRef) => {
-      fs.copyFileSync(
-        new URL(fileRef.from, import.meta.url),
-        new URL(fileRef.to, packagePath),
-      );
+      const from = new URL(fileRef.from, import.meta.url);
+      const to = new URL(fileRef.to, packagePath);
+      fs.mkdirSync(new URL(".", to), { recursive: true });
+      fs.copyFileSync(from, to);
     });
 
     prependAutoImports(pkg, packagePath);

deploy/template/package.json

@@ -10,6 +10,9 @@
         "type": "git",
         "url": "https://github.com/microsoft/TypeScript-DOM-Lib-Generator.git"
     },
+    "typesVersions": {
+        "<=5.5": { "*": ["ts5.5/*"] }
+    },
     "scripts": {},
     "dependencies": {}
 }

package.json

@@ -15,6 +15,7 @@
     "build": "tsc && node ./lib/build.js",
     "baseline-accept": "cpx \"generated\\*\" baselines\\",
     "lint": "eslint --max-warnings 0 src deploy/*.js && tsc -p deploy/jsconfig.json",
+    "lint-fix": "eslint --max-warnings 0 src deploy/*.js --fix",
     "test": "npm run lint && npm run build && node ./lib/test.js && node ./unittests/index.js",
     "changelog": "tsc && node ./lib/changelog.js",
     "ts-changelog": "node ./deploy/versionChangelog.js",

src/build.ts

@@ -36,6 +36,7 @@ interface EmitOptions {
   global: string[];
   name: string;
   outputFolder: URL;
+  useIteratorObject: boolean;
 }
 
 async function emitFlavor(
@@ -46,19 +47,34 @@ async function emitFlavor(
   const exposed = getExposedTypes(webidl, options.global, forceKnownTypes);
   mergeNamesakes(exposed);
 
-  const result = emitWebIdl(exposed, options.global[0], "");
+  const result = emitWebIdl(
+    exposed,
+    options.global[0],
+    "",
+    options.useIteratorObject,
+  );
   await fs.writeFile(
     new URL(`${options.name}.generated.d.ts`, options.outputFolder),
     result,
   );
 
-  const iterators = emitWebIdl(exposed, options.global[0], "sync");
+  const iterators = emitWebIdl(
+    exposed,
+    options.global[0],
+    "sync",
+    options.useIteratorObject,
+  );
   await fs.writeFile(
     new URL(`${options.name}.iterable.generated.d.ts`, options.outputFolder),
     iterators,
   );
 
-  const asyncIterators = emitWebIdl(exposed, options.global[0], "async");
+  const asyncIterators = emitWebIdl(
+    exposed,
+    options.global[0],
+    "async",
+    options.useIteratorObject,
+  );
   await fs.writeFile(
     new URL(
       `${options.name}.asynciterable.generated.d.ts`,
@@ -94,12 +110,6 @@ async function emitDom() {
     ],
   ];
 
-  // Create output folder
-  await fs.mkdir(outputFolder, {
-    // Doesn't need to be recursive, but this helpfully ignores EEXIST
-    recursive: true,
-  });
-
   const overriddenItems = await readInputJSON("overridingTypes.jsonc");
   const addedItems = await readInputJSON("addedTypes.jsonc");
   const comments = await readInputJSON("comments.json");
@@ -273,31 +283,52 @@ async function emitDom() {
 
   const knownTypes = await readInputJSON("knownTypes.json");
 
-  emitFlavor(webidl, new Set(knownTypes.Window), {
-    name: "dom",
-    global: ["Window"],
-    outputFolder,
-  });
-  emitFlavor(webidl, new Set(knownTypes.Worker), {
-    name: "webworker",
-    global: ["Worker", "DedicatedWorker", "SharedWorker", "ServiceWorker"],
-    outputFolder,
-  });
-  emitFlavor(webidl, new Set(knownTypes.Worker), {
-    name: "sharedworker",
-    global: ["SharedWorker", "Worker"],
-    outputFolder,
-  });
-  emitFlavor(webidl, new Set(knownTypes.Worker), {
-    name: "serviceworker",
-    global: ["ServiceWorker", "Worker"],
-    outputFolder,
-  });
-  emitFlavor(webidl, new Set(knownTypes.Worklet), {
-    name: "audioworklet",
-    global: ["AudioWorklet", "Worklet"],
-    outputFolder,
-  });
+  const emitVariations = [
+    {
+      outputFolder: new URL("./ts5.5/", outputFolder),
+      useIteratorObject: false,
+    },
+    { outputFolder, useIteratorObject: true },
+  ];
+
+  for (const { outputFolder, useIteratorObject } of emitVariations) {
+    // Create output folder
+    await fs.mkdir(outputFolder, {
+      // Doesn't need to be recursive, but this helpfully ignores EEXIST
+      recursive: true,
+    });
+
+    emitFlavor(webidl, new Set(knownTypes.Window), {
+      name: "dom",
+      global: ["Window"],
+      outputFolder,
+      useIteratorObject,
+    });
+    emitFlavor(webidl, new Set(knownTypes.Worker), {
+      name: "webworker",
+      global: ["Worker", "DedicatedWorker", "SharedWorker", "ServiceWorker"],
+      outputFolder,
+      useIteratorObject,
+    });
+    emitFlavor(webidl, new Set(knownTypes.Worker), {
+      name: "sharedworker",
+      global: ["SharedWorker", "Worker"],
+      outputFolder,
+      useIteratorObject,
+    });
+    emitFlavor(webidl, new Set(knownTypes.Worker), {
+      name: "serviceworker",
+      global: ["ServiceWorker", "Worker"],
+      outputFolder,
+      useIteratorObject,
+    });
+    emitFlavor(webidl, new Set(knownTypes.Worklet), {
+      name: "audioworklet",
+      global: ["AudioWorklet", "Worklet"],
+      outputFolder,
+      useIteratorObject,
+    });
+  }
 
   function prune(
     obj: Browser.WebIdl,

src/build/emitter.ts

@@ -136,6 +136,7 @@ export function emitWebIdl(
   webidl: Browser.WebIdl,
   global: string,
   iterator: "" | "sync" | "async",
+  useIteratorObject: boolean,
 ): string {
   // Global print target
   const printer = createTextWriter("\n");
@@ -1535,6 +1536,7 @@ export function emitWebIdl(
   }
 
   function emitSelfIterator(i: Browser.Interface) {
+    if (!useIteratorObject) return;
     const async = i.iterator?.async;
     const name = getName(i);
     const iteratorBaseType = `${async ? "Async" : ""}IteratorObject`;
@@ -1562,10 +1564,14 @@ export function emitWebIdl(
     }
     const async = i.iterator?.async;
     const iteratorType = async
-      ? `${name}AsyncIterator`
-      : subtypes.length !== 1
-        ? `${name}Iterator`
-        : "ArrayIterator";
+      ? !useIteratorObject
+        ? "AsyncIterableIterator"
+        : `${name}AsyncIterator`
+      : !useIteratorObject
+        ? "IterableIterator"
+        : subtypes.length !== 1
+          ? `${name}Iterator`
+          : "ArrayIterator";
     const methods = [];
     methods.push({
       name: `[Symbol.${async ? "asyncIterator" : "iterator"}]`,