fix: Return Value type of WebTorrent client.get()

[TechQuery]

Please fill in this template.

• 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 pnpm test <package to test>.

Select one of these and delete the others:

If adding a new definition:

• The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
• If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
• Create it with dts-gen --dt, not by basing it on an existing project.
• Represents shape of module/library correctly
• tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

If changing an existing definition:

• Provide a URL to documentation or source code which provides context for the suggested changes: wrong Return Value type of client.get() in @types/webtorrent packages webtorrent/webtorrent#2782
• If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the package.json.

If removing a declaration:

• If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
• Delete the package's directory.
• Add it to notNeededPackages.json.

[typescript-bot]

@TechQuery Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

1 package in this PR

• webtorrent — on npm, on unpkg

Code Reviews

This PR can be merged once it's reviewed.

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

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.

Inactive

This PR has been inactive for 17 days — please try to get reviewers!

---

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 69619,
  "author": "TechQuery",
  "headCommitOid": "c6b4b7b7d1f4697c54284be70dd1087c1a1ac120",
  "mergeBaseOid": "bfdcd1c2bad2ed372ebf698103824f4171e5e972",
  "lastPushDate": "2024-05-15T18:07:31.000Z",
  "lastActivityDate": "2024-05-28T19:46:06.000Z",
  "maintainerBlessed": "Waiting for Code Reviews",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "webtorrent",
      "kind": "edit",
      "files": [
        {
          "path": "types/webtorrent/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "niieani",
        "tlaziuk",
        "gjuchault",
        "cheeseandcereal"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [],
  "mainBotCommentID": 2113147370,
  "ciResult": "pass"
}

[typescript-bot]

Hey @TechQuery,

😒 Your PR doesn't modify any tests, so it's hard to know what's being fixed, and your changes might regress in the future. Please consider adding tests to cover the change you're making. Including tests allows this PR to be merged by yourself and the owners of this module.

This can potentially save days of time for you!

[typescript-bot]

🔔 @niieani @tlaziuk @gjuchault @cheeseandcereal — 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.

[TechQuery]

I find that @types/webtorrent's version is at 0.109.x, which is an old version published at 4 years old: https://github.com/webtorrent/webtorrent/tree/v0.109.2

But the latest webtorrent is published at about 1 month ago: https://github.com/webtorrent/webtorrent/releases/tag/v2.2.1

When I use dts-gen to generate .d.ts, I failed with no ESM support:

$ dts-gen -m webtorrent
Unexpected crash! Please log a bug with the commandline you specified.
/home/gitpod/.pnpm/global/5/.pnpm/dts-gen@0.10.2/node_modules/dts-gen/dist/run.js:84
        result = guess.generateModuleDeclarationFile(args.module, require(args.module));
                                                                  ^

Error [ERR_REQUIRE_ESM]: require() of ES Module /home/gitpod/.pnpm/global/5/.pnpm/webtorrent@2.2.1/node_modules/webtorrent/index.js from /home/gitpod/.pnpm/global/5/.pnpm/dts-gen@0.10.2/node_modules/dts-gen/dist/run.js not supported.
Instead change the require of index.js in /home/gitpod/.pnpm/global/5/.pnpm/dts-gen@0.10.2/node_modules/dts-gen/dist/run.js to a dynamic import() which is available in all CommonJS modules.
    at Object.<anonymous> (/home/gitpod/.pnpm/global/5/.pnpm/dts-gen@0.10.2/node_modules/dts-gen/dist/run.js:84:67) {
  code: 'ERR_REQUIRE_ESM'
}

Node.js v20.13.1

[typescript-bot]

Re-ping @niieani, @tlaziuk, @gjuchault, @cheeseandcereal:

This PR has been out for over a week, yet I haven't seen any reviews.

Could someone please give it some attention? Thanks!