feat(node): declare URL and URLSearchParams as globals

[antongolub]

closes: #34960

NodeJS spec:

• https://nodejs.org/api/url.html#the-whatwg-url-api
• https://nodejs.org/api/url.html#class-urlsearchparams

URL v10.0.0 | The class is now available on the global object.
URLSearchParams v10.0.0 | The class is now available on the global object.

• Use a meaningful title for the pull request. Include the name of the package modified.
• Test the change in your own code. (Compile and run.)
• Add or edit tests to reflect the change.
• Follow the advice from the readme.
• Avoid common mistakes.
• Run npm test <package to test>.

If changing an existing definition:

• Provide a URL to documentation or source code which provides context for the suggested changes: <>

[typescript-bot]

@antongolub Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in this PR

• node — on npm, on unpkg
  • owner-approval: @peterblazejewicz

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

You can test the changes of this PR in the Playground.

Status

• ✅ No merge conflicts
• ✅ Continuous integration tests have passed
• ✅ Most recent commit is approved by type definition owners or DT maintainers

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

---

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 58277,
  "author": "antongolub",
  "headCommitOid": "5f9bcb8fe3c2f9aedc05c9dadc20ee7157f14838",
  "mergeBaseOid": "ba9c5ca17fd39d9e7e3ce89be9fafd6b1bc9e24f",
  "lastPushDate": "2022-01-20T13:03:36.000Z",
  "lastActivityDate": "2022-02-01T08:07:38.000Z",
  "maintainerBlessed": "Waiting for Code Reviews",
  "mergeOfferDate": "2022-01-31T20:07:31.000Z",
  "mergeRequestDate": "2022-02-01T08:07:38.000Z",
  "mergeRequestUser": "antongolub",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "node",
      "kind": "edit",
      "files": [
        {
          "path": "types/node/test/url.ts",
          "kind": "test"
        },
        {
          "path": "types/node/url.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/v12/url.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/v14/test/url.ts",
          "kind": "test"
        },
        {
          "path": "types/node/v14/url.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/v16/test/url.ts",
          "kind": "test"
        },
        {
          "path": "types/node/v16/url.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "Microsoft",
        "DefinitelyTyped",
        "jkomyno",
        "alvis",
        "r3nya",
        "btoueg",
        "smac89",
        "touffy",
        "DeividasBakanas",
        "eyqs",
        "Hannes-Magnusson-CK",
        "hoo29",
        "kjin",
        "ajafff",
        "islishude",
        "mwiktorczyk",
        "mohsen1",
        "n-e",
        "galkin",
        "parambirs",
        "eps1lon",
        "westy92",
        "SimonSchick",
        "ThomasdenH",
        "WilcoBakker",
        "wwwy3y3",
        "samuela",
        "kuehlein",
        "bhongy",
        "chyzwar",
        "trivikr",
        "yoursunny",
        "qwelias",
        "ExE-Boss",
        "peterblazejewicz",
        "addaleax",
        "victorperin",
        "ZYSzys",
        "NodeJS",
        "LinusU",
        "wafuwafu13"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "peterblazejewicz",
      "date": "2022-01-31T20:06:52.000Z",
      "isMaintainer": true
    }
  ],
  "mainBotCommentID": 1015556159,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @microsoft @DefinitelyTyped @jkomyno @alvis @r3nya @btoueg @smac89 @Touffy @DeividasBakanas @eyqs @Hannes-Magnusson-CK @hoo29 @kjin @ajafff @islishude @mwiktorczyk @mohsen1 @n-e @galkin @parambirs @eps1lon @westy92 @SimonSchick @ThomasdenH @WilcoBakker @wwwy3y3 @samuela @kuehlein @bhongy @chyzwar @trivikr @yoursunny @qwelias @ExE-Boss @peterblazejewicz @addaleax @victorperin @ZYSzys @nodejs @LinusU @wafuwafu13 — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

[demurgos]

Thank you very much for sending a PR.

The dom lib defines the global first and then re-exports it through the module. This implementation does the reverse. As long as there are no conflicts I assume it should be fine.

I am really excited for this fix: it will be very helpful!

[typescript-bot]

@antongolub The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

[typescript-bot]

@antongolub The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

[antongolub]

TS lib.dom.d.ts "version": "4.6.0-dev.20220119"

declare var AbortSignal: {
    prototype: AbortSignal;
    new(): AbortSignal;
    abort(reason?: any): AbortSignal;
};

"version": "4.6.0-dev.20220117"

declare var AbortSignal: {
    prototype: AbortSignal;
    new(): AbortSignal;
    // abort(): AbortSignal; - To be re-added in the future
};

microsoft/TypeScript#47507

UPD
Fixed in 4.6.0-dev.20220120

[antongolub]

Ready to merge

[sandersn]

Note: This breaks configs that have lib: ["webworker"] because lib.webworker.d.ts includes both URL and URLSearchParams. sparql-http-client on DT is one example.

[peterblazejewicz]

@sandersn what's the option here we can pick? There are two posts on discussion with same (or similar) problem already

[antongolub]

Interesting...

createObjectURL(object: any): string;
createObjectURL(obj: Blob | MediaSource): string;

more and more interesting:
https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL

[antongolub]

Yet another janky trick:

var URL:
    // For compatibility with "dom" and "webworker" URL declarations
    typeof globalThis extends ({ webkitURL: infer URL } | { TransformStreamDefaultController: infer T, URL: infer URL })
    ? URL
    : typeof _URL;

@sandersn, could you check this plz?

[peterblazejewicz]

afaik it does not work with use case (from your PR branch):

npm test sparql-http-client

(the DT lib declaring webworker lib in tsconfig:

Error: Errors in typescript@3.8 for external dependencies:
../node/url.d.ts(872,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'URL' must be of type '{ new (url: string, base?: string | URL | undefined): URL; prototype: URL; createObjectURL(object: any): string; revokeObjectURL(url: string): void; }', but here has type 'typeof URL'.

[antongolub]

Oops... 3.8 does not provide TransformStreamDefaultController var declaration. Сontinue digging.

[antongolub]

@peterblazejewicz, how about?

        var URL:
            // For compatibility with "dom" and "webworker" URL declarations
            typeof globalThis extends { onmessage: infer O, URL: infer URL }
                ? URL
                : typeof _URL;

[peterblazejewicz]

Yes, this passes the use-case test, but let's have more opinion on what next.

[antongolub]

#58619

[thw0rted]

Anybody that's still watching this, maybe you could weigh in on #59905 where I'm trying to do something similar with another Node "DOM-compatible" API? I'm going to try to use the same pattern you discovered here, if possible.