Add Cypress.dom.* to TS type declarations

[kylerob]

Closes #4408

User facing changelog

Cypress.dom.isDetached no longer throws a type error in TypeScript projects.

Additional details

We may want to include all Cypress.dom.* functions in the index.d.ts. If so, I can add the rest of them in this PR.

PR Tasks

• Have tests been added/updated? (Not sure which test file covers this)
• Have API changes been updated in the type definitions?

[flotwig]

@kylerob This PR looks good, but it would be helpful to have the rest of the dom methods as well if you want to go ahead and add them.

[kylerob]

@flotwig I just pushed up the rest of the declarations. Some of the functions were tougher to nail down types for, so I'm not 100% confident in all my declarations. Is there a good automated way to test these before we publish them?

[flotwig]

@flotwig I just pushed up the rest of the declarations. Some of the functions were tougher to nail down types for, so I'm not 100% confident in all my declarations. Is there a good automated way to test these before we publish them?

The easiest way to test these definitions is probably to exercise them in actual Typescript. There are already tests for Cypress.dom here:

https://github.com/cypress-io/cypress/tree/develop/packages/driver/test/cypress/integration/dom

You could rename these .js files to .ts, ensure that the type for Cypress.dom is inferred correctly, and ensure that the types that you've created don't cause any type errors in the tests. You should commit it too so that we can have the type tests going forward.

[jennifer-shehane]

Hey @kylerob, did you have time to add tests for these changes? If you no longer have time, please close the PR.

[jennifer-shehane]

@kylerob Unfortunately we have to close this PR due to inactivity.

[rovshenn]

Any plans to continue on this? Seem that PR was almost there :)

[jennifer-shehane]

@rovshenn You are welcome to open a new PR to continue the work. We can't maintain stale PRs that have had no commits in 4 months.

[flotwig]

I can get this one done, it just needs some tests.

[kuceb]

@flotwig the tests for typedefs should go in cli/types/tests. can you add tests to cli/types/tests/cypress-tests.ts ?

[flotwig]

@flotwig the tests for typedefs should go in cli/types/tests. can you add tests to cli/types/tests/cypress-tests.ts ?

sure, i figured converting the existing tests to TS would be enough coverage though

[kuceb]

I don't think we'll enjoy keeping this up to date, and it's not in our docs but I think it can go in

[kuceb]

an alternative would be making Cypress.dom an any type, which would fix the type errors

[rovshenn]

Yes @bkucera , but that reduces the value of the typing :) it is a trade off. Thank you very much @flotwig ! Hopefully I will get my hands dirty with cypress one day

[rovshenn]

@jennifer-shehane could you please tag which release this will be in? Thank you very much for all your assistance!

[jennifer-shehane]

This will go out in 4.1.1 or 4.2.0 depending on whether there are other features that make it in the next release. Either way - that release is scheduled for Mar 13 at the latest.

[rovshenn]

Thank you very much @jennifer-shehane , I am looking forward to that!