Skip to content

feat(chrome-remote-interface): update domain types to v0.33#74132

Merged
typescript-bot merged 1 commit intoDefinitelyTyped:masterfrom
hkleungai:chrome-remote-interface-update-domains
Nov 30, 2025
Merged

feat(chrome-remote-interface): update domain types to v0.33#74132
typescript-bot merged 1 commit intoDefinitelyTyped:masterfrom
hkleungai:chrome-remote-interface-update-domains

Conversation

@hkleungai
Copy link
Contributor

@hkleungai hkleungai commented Nov 24, 2025

protocol.json is last updated in Jul 29, 2023. See https://github.com/cyrus-and/chrome-remote-interface/commits/master/lib/protocol.json; The closest release of devtools-protocol to that date is v0.0.1173815, see ChromeDevTools/devtools-protocol@e22d6aa. Hence the devtools-protocol dep is pinned to that specific version.

With the package upgrade, certain changes are brought to StableDomains & ExperimentalDomains interfaces. The updates are based on protocol.json, with its "deprecated": true / "experimental": true marking on each domain entry.

Tests are added for (almost) fully covering .on() events.

Resolves discussion #74129.


Please fill in this template.

Select one of these and delete the others:

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>
  • 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.

@typescript-bot
Copy link
Contributor

typescript-bot commented Nov 24, 2025

@hkleungai Thank you for submitting this PR!

This is a live comment that I will keep updated.

1 package in this PR

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": 74132,
  "author": "hkleungai",
  "headCommitOid": "af8d8432cf21abb56e1232305c1019e0bd1d19ad",
  "mergeBaseOid": "86f44b5ee78b2ea5c25b8deb9f6f5d846042cf56",
  "lastPushDate": "2025-11-24T19:19:44.000Z",
  "lastActivityDate": "2025-11-30T06:06:01.000Z",
  "mergeOfferDate": "2025-11-30T06:01:18.000Z",
  "mergeRequestDate": "2025-11-30T06:06:01.000Z",
  "mergeRequestUser": "hkleungai",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": "chrome-remote-interface",
      "kind": "edit",
      "files": [
        {
          "path": "types/chrome-remote-interface/chrome-remote-interface-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/chrome-remote-interface/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/chrome-remote-interface/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "kazarmy",
        "westy92"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "kazarmy",
      "date": "2025-11-30T06:00:38.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 3572351600,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added the Popular package This PR affects a popular package (as counted by NPM download counts). label Nov 24, 2025
@typescript-bot
Copy link
Contributor

🔔 @kazarmy @westy92 — 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.

@typescript-bot typescript-bot moved this to Waiting for Code Reviews in Pull Request Status Board Nov 24, 2025
Comment on lines +36 to +37
method?: string | undefined;
params?: object | undefined;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are the method and params optional?

@hkleungai hkleungai force-pushed the chrome-remote-interface-update-domains branch from 71ea55a to af8d843 Compare November 30, 2025 04:57
@typescript-bot
Copy link
Contributor

@kazarmy Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

*/
Tethering: ProtocolProxyApi.TetheringApi;
/** @deprecated this API is experimental. */
Tracing: ProtocolProxyApi.TracingApi;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per https://chromedevtools.github.io/devtools-protocol/1-3/, Tracing should be considered stable. I also see some new experimental APIs at https://chromedevtools.github.io/devtools-protocol/tot/ (e.g. BluetoothEmulation) but I suppose https://github.com/cyrus-and/chrome-remote-interface/.../lib/protocol.json needs to be updated as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened an issue few days ago on the source repo, but looks like library author has no intention to keep protocol json file up-to-date. 🤷‍♂️

Copy link
Contributor

@kazarmy kazarmy Nov 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would interpret cyrus-and/chrome-remote-interface#578 (comment) and https://github.com/cyrus-and/chrome-remote-interface/.../README.md#chrome-debugging-protocol-versions to mean that you can ignore the protocol.json file, but I think it would be nice if you can update it for him.

Copy link
Contributor

@kazarmy kazarmy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Descriptions lgtm

@typescript-bot typescript-bot added Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner labels Nov 30, 2025
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Waiting for Author to Merge in Pull Request Status Board Nov 30, 2025
@hkleungai
Copy link
Contributor Author

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in Pull Request Status Board Nov 30, 2025
@typescript-bot typescript-bot merged commit 711df7f into DefinitelyTyped:master Nov 30, 2025
4 checks passed
@hkleungai hkleungai deleted the chrome-remote-interface-update-domains branch November 30, 2025 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Owner Approved A listed owner of this package signed off on the pull request. Popular package This PR affects a popular package (as counted by NPM download counts). Self Merge This PR can now be self-merged by the PR author or an owner

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants