🤖 Merge PR DefinitelyTyped#74506 [jsdom] Update type for new resources options in v28 by @seia-soto

Author: seia-soto

types/jsdom/base.d.ts

@@ -5,6 +5,7 @@
 import { EventEmitter } from "events";
 import { Token } from "parse5";
 import * as tough from "tough-cookie";
+import { Dispatcher } from "undici-types";
 import { Context } from "vm";
 
 // Needed to allow adding properties to `DOMWindow` that are only supported
@@ -57,12 +58,6 @@ declare module "jsdom" {
         reconfigure(settings: ReconfigureSettings): void;
     }
 
-    class ResourceLoader {
-        fetch(url: string, options: FetchOptions): AbortablePromise<Buffer> | null;
-
-        constructor(obj?: ResourceLoaderConstructorOptions);
-    }
-
     class VirtualConsole extends EventEmitter {
         on<K extends keyof Console>(method: K, callback: Console[K]): this;
         on(event: "jsdomError", callback: (e: Error) => void): this;
@@ -78,14 +73,6 @@ declare module "jsdom" {
          */
         referrer?: string | undefined;
 
-        /**
-         * userAgent affects the value read from navigator.userAgent, as well as the User-Agent header sent while fetching subresources.
-         *
-         * @default
-         * `Mozilla/5.0 (${process.platform}) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/${jsdomVersion}`
-         */
-        userAgent?: string | undefined;
-
         /**
          * `includeNodeLocations` preserves the location info produced by the HTML parser,
          * allowing you to retrieve it with the nodeLocation() method (described below).
@@ -97,7 +84,7 @@ declare module "jsdom" {
          */
         includeNodeLocations?: boolean | undefined;
         runScripts?: "dangerously" | "outside-only" | undefined;
-        resources?: "usable" | ResourceLoader | undefined;
+        resources?: "usable" | ResourcesOptions | undefined;
         virtualConsole?: VirtualConsole | undefined;
         cookieJar?: CookieJar | undefined;
 
@@ -156,6 +143,16 @@ declare module "jsdom" {
         storageQuota?: number | undefined;
     }
 
+    interface RequestInterceptorContext {
+        element: HTMLElement | null;
+    }
+    type RequestInterceptorCallback = (
+        request: Request,
+        context: RequestInterceptorContext,
+        // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+    ) => void | undefined | Response | Promise<undefined | Response>;
+    function requestInterceptor(fn: RequestInterceptorCallback): Dispatcher.DispatchInterceptor;
+
     type SupportedContentTypes =
         | "text/html"
         | "application/xhtml+xml"
@@ -178,17 +175,16 @@ declare module "jsdom" {
         url?: string | undefined;
     }
 
-    interface FetchOptions {
-        cookieJar?: CookieJar | undefined;
-        referrer?: string | undefined;
-        accept?: string | undefined;
-        element?: HTMLScriptElement | HTMLLinkElement | HTMLIFrameElement | HTMLImageElement | undefined;
-    }
-
-    interface ResourceLoaderConstructorOptions {
-        strictSSL?: boolean | undefined;
-        proxy?: string | undefined;
+    interface ResourcesOptions {
+        /**
+         * userAgent affects the value read from navigator.userAgent, as well as the User-Agent header sent while fetching subresources.
+         *
+         * @default
+         * `Mozilla/5.0 (${process.platform}) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/${jsdomVersion}`
+         */
         userAgent?: string | undefined;
+        dispatcher?: Dispatcher | undefined;
+        interceptors?: Dispatcher.DispatcherComposeInterceptor[] | undefined;
     }
 
     interface DOMWindow extends Omit<Window, "top" | "self" | "window"> {

types/jsdom/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/jsdom",
-    "version": "27.0.9999",
+    "version": "28.0.9999",
     "projects": [
         "https://github.com/jsdom/jsdom"
     ],
@@ -13,7 +13,8 @@
     "dependencies": {
         "@types/node": "*",
         "@types/tough-cookie": "*",
-        "parse5": "^7.0.0"
+        "parse5": "^7.0.0",
+        "undici-types": "^7.21.0"
     },
     "devDependencies": {
         "@types/jsdom": "workspace:."

types/jsdom/test/core.ts

@@ -3,13 +3,13 @@ import {
     ConstructorOptions,
     CookieJar,
     DOMWindow,
-    FetchOptions,
     FileOptions,
     JSDOM,
-    ResourceLoader,
+    requestInterceptor,
     VirtualConsole,
 } from "jsdom";
 import { CookieJar as ToughCookieJar, MemoryCookieStore } from "tough-cookie";
+import { ProxyAgent } from "undici-types";
 import { Script } from "vm";
 
 function test_basic_usage() {
@@ -189,26 +189,32 @@ function test_fragment_serialization() {
     }
 }
 
-function test_custom_resource_loader() {
-    class CustomResourceLoader extends ResourceLoader {
-        fetch(url: string, options: FetchOptions) {
-            if (options.element) {
-                console.log(`Element ${options.element.localName} is requesting the url ${url}`);
-
-                if (options.element.localName === "iframe") {
-                    console.log("Ignoring resource requested by iframe element");
-                    return null;
-                }
-            }
-
-            return super.fetch(url, options);
+function test_request_interceptor() {
+    // $ExpectType DispatchInterceptor
+    requestInterceptor(function(request, { element }) {
+        console.log(`${element?.localName || "XHR"} requested ${request.url}`);
+        if (request.url === "https://example.com/some-specific-script.js") {
+            return new Response("window.someGlobal = 5;", {
+                headers: { "Content-Type": "application/javascript" },
+            });
         }
-    }
-    new JSDOM("", { resources: new CustomResourceLoader() });
+    });
 }
 
-function test_resource_loader_return_type(resourceLoader: ResourceLoader) {
-    resourceLoader.fetch("https://example.com", {}); // $ExpectType AbortablePromise<Buffer> | null
+function test_resources_options() {
+    new JSDOM("", {
+        resources: "usable",
+    });
+    new JSDOM("", {
+        resources: {},
+    });
+    new JSDOM("", {
+        resources: {
+            userAgent: "",
+            dispatcher: new ProxyAgent("http://127.0.0.1:9001"),
+            interceptors: [requestInterceptor(function() {})],
+        },
+    });
 }
 
 function test_createElementDirectTypes() {

types/karma-jsdom-launcher/karma-jsdom-launcher-tests.ts

@@ -1,11 +1,7 @@
-import karma = require("karma");
-import jsdom = require("jsdom");
+import jsdom from "jsdom";
+import karma from "karma";
+import { ProxyAgent } from "undici-types";
 
-const resourceLoader = new jsdom.ResourceLoader({
-    proxy: "http://127.0.0.1:9001",
-    strictSSL: false,
-    userAgent: "Mellblomenator/9000",
-});
 const virtualConsole = new jsdom.VirtualConsole();
 const cookieJar = new jsdom.CookieJar();
 
@@ -15,7 +11,15 @@ module.exports = (config: karma.Config) => {
 
         jsdomLauncher: {
             jsdom: {
-                resources: resourceLoader,
+                resources: {
+                    dispatcher: new ProxyAgent({
+                        uri: "http://127.0.0.1:9001",
+                        connect: {
+                            rejectUnauthorized: false,
+                        },
+                    }),
+                    userAgent: "Mellblomenator/9000",
+                },
                 virtualConsole,
                 cookieJar,
             },

types/karma-jsdom-launcher/package.json

@@ -10,7 +10,8 @@
         "@types/karma": "*"
     },
     "devDependencies": {
-        "@types/karma-jsdom-launcher": "workspace:."
+        "@types/karma-jsdom-launcher": "workspace:.",
+        "undici-types": "^7.22.0"
     },
     "owners": [
         {