fix: Introduce CypressCommandLine namespace to type NPM module api

[sainthkh]

• Closes Types not exported in .d.ts #7309

User facing changelog

Moved types inside 'cypress' module to CypressCmd namespace to make them usable.

Additional details

• Why was this change necessary? Types defined in cypress-npm-api.d.ts weren't usable for users who want to create their own TypeScript commands.
• What is affected by this change? N/A
• Any implementation details to explain? N/A

How has the user experience changed?

N/A

PR Tasks

• Have tests been added/updated?
• Has the original issue been tagged with a release in ZenHub?
• [N/A] Has a PR for user-facing changes been opened in cypress-documentation?
• [N/A] Have API changes been updated in the type definitions?
• [N/A] Have new configuration options been added to the cypress.schema.json?

[cypress-bot]

Thanks for taking the time to open a PR!

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
• Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

[flotwig]

@sainthkh does this make the types exported from the NPM package, or does it only create an ambient global namespace CypressCmd?

[bahmutov]

I think this would be better named CypressCommandLine

[sainthkh]

@flotwig We cannot export interfaces in the module because there is export = cypress. Because of that, I had to create ambient global namespace, CypressCommandLine.

[bahmutov]

looks good, tests are passing, thanks for updating the name

[jennifer-shehane]

Should this be documented somewhere in our TypeScript docs? @sainthkh

[sainthkh]

How about adding types for module api section and an example like below?

cypress.run({ env })
    .then((result: CypressCommandLine.CypressRunResult) => {
      logger.info(result.totalTests);
      logger.info(result.totalFailed);
    });