Merge branch 'develop' into feature-multidomain

cli/types/cypress.d.ts

@@ -2538,7 +2538,7 @@ declare namespace Cypress {
     action: 'select' | 'drag-drop'
   }
 
-  interface BlurOptions extends Loggable, Forceable { }
+  interface BlurOptions extends Loggable, Timeoutable, Forceable { }
 
   interface CheckOptions extends Loggable, Timeoutable, ActionableOptions {
     interval: number

packages/driver/cypress/integration/commands/screenshot_spec.js

@@ -761,9 +761,9 @@ describe('src/cy/commands/screenshot', () => {
         cy.get('.short-element').within(() => {
           cy.screenshot({ capture: 'runner' })
         }).then(() => {
-          // the runner was captured
-          expect(Cypress.action.withArgs('cy:before:screenshot').args[0][1].appOnly).to.be.true
-          expect(Cypress.automation.withArgs('take:screenshot').args[0][1].capture).to.equal('viewport')
+          // the runner was captured ("appOnly === true" means to hide the runner UI)
+          expect(Cypress.action.withArgs('cy:before:screenshot').args[0][1].appOnly).to.be.false
+          expect(Cypress.automation.withArgs('take:screenshot').args[0][1].capture).to.equal('runner')
         })
       })
 

packages/driver/src/cy/commands/actions/focus.ts

@@ -4,16 +4,29 @@ import $dom from '../../../dom'
 import $utils from '../../../cypress/utils'
 import $errUtils from '../../../cypress/error_utils'
 import $elements from '../../../dom/elements'
+import type { Log } from '../../../cypress/log'
+
+interface InternalFocusOptions extends Partial<Cypress.Loggable & Cypress.Timeoutable> {
+  _log?: Log
+  $el: JQuery
+  error: boolean
+  verify: boolean
+}
+
+interface InternalBlurOptions extends Partial<Cypress.BlurOptions> {
+  _log?: Log
+  $el: JQuery
+  $focused: JQuery
+  error: boolean
+  verify: boolean
+}
 
 export default (Commands, Cypress, cy) => {
   return Commands.addAll({ prevSubject: ['element', 'window'] }, {
-    // TODO: any -> Partial<Cypress.Loggable & Cypress.Timeoutable>
-    focus (subject, options: any = {}) {
-      const userOptions = options
-
+    focus (subject, userOptions: Partial<Cypress.Loggable & Cypress.Timeoutable> = {}) {
       // we should throw errors by default!
       // but allow them to be silenced
-      options = _.defaults({}, userOptions, {
+      const options: InternalFocusOptions = _.defaults({}, userOptions, {
         $el: subject,
         error: true,
         log: true,
@@ -85,13 +98,10 @@ export default (Commands, Cypress, cy) => {
       return verifyAssertions()
     },
 
-    // TODO: any -> Partial<Cypress.BlurOptions>
-    blur (subject, options: any = {}) {
-      const userOptions = options
-
+    blur (subject, userOptions: Partial<Cypress.BlurOptions> = {}) {
       // we should throw errors by default!
       // but allow them to be silenced
-      options = _.defaults({}, userOptions, {
+      const options: InternalBlurOptions = _.defaults({}, userOptions, {
         $el: subject,
         $focused: cy.getFocused(),
         error: true,

packages/driver/src/cy/commands/actions/scroll.ts

@@ -5,6 +5,7 @@ import Promise from 'bluebird'
 import $dom from '../../../dom'
 import $utils from '../../../cypress/utils'
 import $errUtils from '../../../cypress/error_utils'
+import type { Log } from '../../../cypress/log'
 
 const findScrollableParent = ($el, win) => {
   const $parent = $dom.getParent($el)
@@ -28,12 +29,26 @@ const isNaNOrInfinity = (item) => {
   return _.isNaN(num) || !_.isFinite(num)
 }
 
+interface InternalScrollIntoViewOptions extends Partial<Cypress.ScrollToOptions> {
+  _log?: Log
+  $el: JQuery
+  $parent: any
+  axis: string
+  offset?: object
+}
+
+interface InternalScrollToOptions extends Partial<Cypress.ScrollToOptions> {
+  _log?: Log
+  $el: any
+  x: number
+  y: number
+  error?: any
+  axis: string
+}
+
 export default (Commands, Cypress, cy, state) => {
   Commands.addAll({ prevSubject: 'element' }, {
-    // TODO: any -> Partial<Cypress.ScrollToOptions>
-    scrollIntoView (subject, options: any = {}) {
-      const userOptions = options
-
+    scrollIntoView (subject, userOptions: Partial<Cypress.ScrollToOptions> = {}) {
       if (!_.isObject(userOptions)) {
         $errUtils.throwErrByPath('scrollIntoView.invalid_argument', { args: { arg: userOptions } })
       }
@@ -49,7 +64,7 @@ export default (Commands, Cypress, cy, state) => {
         $errUtils.throwErrByPath('scrollIntoView.multiple_elements', { args: { num: subject.length } })
       }
 
-      options = _.defaults({}, userOptions, {
+      const options: InternalScrollIntoViewOptions = _.defaults({}, userOptions, {
         $el: subject,
         $parent: state('window'),
         log: true,
@@ -115,9 +130,6 @@ export default (Commands, Cypress, cy, state) => {
       const scrollIntoView = () => {
         return new Promise((resolve, reject) => {
           // scroll our axes
-          // TODO: done() came from jQuery animate(), specifically, EffectsOptions at misc.d.ts
-          // The type definition should be fixed at @types/jquery.scrollto.
-          // @ts-ignore
           return $(options.$parent).scrollTo(options.$el, {
             axis: options.axis,
             easing: options.easing,
@@ -157,10 +169,8 @@ export default (Commands, Cypress, cy, state) => {
   })
 
   Commands.addAll({ prevSubject: ['optional', 'element', 'window'] }, {
-    // TODO: any -> Partial<Cypress.ScrollToOptions>
-    scrollTo (subject, xOrPosition, yOrOptions, options: any = {}) {
+    scrollTo (subject, xOrPosition, yOrOptions, userOptions: Partial<Cypress.ScrollToOptions> = {}) {
       let x; let y
-      let userOptions = options
 
       // check for undefined or null values
       if (xOrPosition === undefined || xOrPosition === null) {
@@ -261,7 +271,7 @@ export default (Commands, Cypress, cy, state) => {
         $errUtils.throwErrByPath('scrollTo.multiple_containers', { args: { num: $container.length } })
       }
 
-      options = _.defaults({}, userOptions, {
+      const options: InternalScrollToOptions = _.defaults({}, userOptions, {
         $el: $container,
         log: true,
         duration: 0,
@@ -361,10 +371,7 @@ export default (Commands, Cypress, cy, state) => {
 
       const scrollTo = () => {
         return new Promise((resolve, reject) => {
-          // scroll our axis'
-          // TODO: done() came from jQuery animate(), specifically, EffectsOptions at misc.d.ts
-          // The type definition should be fixed at @types/jquery.scrollto.
-          // @ts-ignore
+          // scroll our axis
           $(options.$el).scrollTo({ left: x, top: y }, {
             axis: options.axis,
             easing: options.easing,

packages/driver/src/cy/commands/actions/select.ts

@@ -5,13 +5,19 @@ import $dom from '../../../dom'
 import $utils from '../../../cypress/utils'
 import $errUtils from '../../../cypress/error_utils'
 import $elements from '../../../dom/elements'
+import type { Log } from '../../../cypress/log'
 
 const newLineRe = /\n/g
 
+interface InternalSelectOptions extends Partial<Cypress.SelectOptions> {
+  _log?: Log
+  $el: JQuery<HTMLSelectElement>
+  error?: any
+}
+
 export default (Commands, Cypress, cy) => {
   Commands.addAll({ prevSubject: 'element' }, {
-    // TODO: any -> Partial<Cypress.SelectOptions>
-    select (subject, valueOrTextOrIndex, options: any = {}) {
+    select (subject, valueOrTextOrIndex, userOptions: Partial<Cypress.SelectOptions> = {}) {
       if (
         !_.isNumber(valueOrTextOrIndex)
         && !_.isString(valueOrTextOrIndex)
@@ -28,9 +34,7 @@ export default (Commands, Cypress, cy) => {
         $errUtils.throwErrByPath('select.invalid_array_argument', { args: { value: JSON.stringify(valueOrTextOrIndex) } })
       }
 
-      const userOptions = options
-
-      options = _.defaults({}, userOptions, {
+      const options: InternalSelectOptions = _.defaults({}, userOptions, {
         $el: subject,
         log: true,
         force: false,
@@ -55,7 +59,7 @@ export default (Commands, Cypress, cy) => {
           },
         })
 
-        options._log.snapshot('before', { next: 'after' })
+        options._log!.snapshot('before', { next: 'after' })
       }
 
       let node

packages/driver/src/cy/commands/actions/submit.ts

@@ -5,14 +5,17 @@ import $dom from '../../../dom'
 import $utils from '../../../cypress/utils'
 import $errUtils from '../../../cypress/error_utils'
 import $actionability from '../../actionability'
+import type { Log } from '../../../cypress/log'
+
+interface InternalSubmitOptions extends Partial<Cypress.Loggable & Cypress.Timeoutable>{
+  _log?: Log
+  $el: JQuery<HTMLFormElement>
+}
 
 export default (Commands, Cypress, cy) => {
   Commands.addAll({ prevSubject: 'element' }, {
-    // TODO: any -> Partial<Cypress.Loggable & Cypress.Timeoutable>
-    submit (subject, options: any = {}) {
-      const userOptions = options
-
-      options = _.defaults({}, userOptions, {
+    submit (subject: JQuery<HTMLFormElement>, userOptions: Partial<Cypress.Loggable & Cypress.Timeoutable> = {}) {
+      const options: InternalSubmitOptions = _.defaults({}, userOptions, {
         log: true,
         $el: subject,
       })
@@ -35,7 +38,7 @@ export default (Commands, Cypress, cy) => {
           },
         })
 
-        options._log.snapshot('before', { next: 'after' })
+        options._log!.snapshot('before', { next: 'after' })
       }
 
       if (!options.$el.is('form')) {

packages/driver/src/cy/commands/actions/type.ts

@@ -8,23 +8,33 @@ import $utils from '../../../cypress/utils'
 import $errUtils from '../../../cypress/error_utils'
 import $actionability from '../../actionability'
 import $Keyboard from '../../../cy/keyboard'
+import type { Log } from '../../../cypress/log'
+
 import debugFn from 'debug'
 const debug = debugFn('cypress:driver:command:type')
 
+interface InternalTypeOptions extends Partial<Cypress.TypeOptions> {
+  _log?: Log
+  $el: JQuery
+  ensure?: object
+  verify: boolean
+  interval?: number
+}
+
+interface InternalClearOptions extends Partial<Cypress.ClearOptions> {
+  _log?: Log
+  ensure?: object
+}
+
 export default function (Commands, Cypress, cy, state, config) {
   const { keyboard } = cy.devices
 
-  // Note: These "change type of `any` to X" comments are written instead of changing them directly
-  //       because Cypress extends user-given options with Cypress internal options.
-  //       These comments will be removed after removing `// @ts-nocheck` comments in `packages/driver`.
-  // TODO: change the type of `any` to `Partial<Cypress.TypeOptions>`
-  function type (subject, chars, options: any = {}) {
-    const userOptions = options
+  function type (subject, chars, userOptions: Partial<Cypress.TypeOptions> = {}) {
     let updateTable
 
     // allow the el we're typing into to be
     // changed by options -- used by cy.clear()
-    options = _.defaults({}, userOptions, {
+    const options: InternalTypeOptions = _.defaults({}, userOptions, {
       $el: subject,
       log: true,
       verify: true,
@@ -110,7 +120,7 @@ export default function (Commands, Cypress, cy, state, config) {
         },
       })
 
-      options._log.snapshot('before', { next: 'after' })
+      options._log!.snapshot('before', { next: 'after' })
     }
 
     if (options.$el.length > 1) {
@@ -572,11 +582,8 @@ export default function (Commands, Cypress, cy, state, config) {
     })
   }
 
-  // TODO: change the type of `any` to `Partial<ClearOptions>`
-  function clear (subject, options: any = {}) {
-    const userOptions = options
-
-    options = _.defaults({}, userOptions, {
+  function clear (subject, userOptions: Partial<Cypress.ClearOptions> = {}) {
+    const options: InternalClearOptions = _.defaults({}, userOptions, {
       log: true,
       force: false,
       waitForAnimations: config('waitForAnimations'),

packages/driver/src/cy/commands/angular.ts

@@ -3,9 +3,14 @@ import $ from 'jquery'
 import Promise from 'bluebird'
 
 import $errUtils from '../../cypress/error_utils'
+import type { Log } from '../../cypress/log'
 
 const ngPrefixes = ['ng-', 'ng_', 'data-ng-', 'x-ng-']
 
+interface InternalNgOptions extends Partial<Cypress.Loggable & Cypress.Timeoutable> {
+  _log?: Log
+}
+
 export default (Commands, Cypress, cy, state) => {
   const findByNgBinding = (binding, options) => {
     const selector = '.ng-binding'
@@ -89,10 +94,7 @@ export default (Commands, Cypress, cy, state) => {
   }
 
   Commands.addAll({
-    // TODO: Change the options type from `any` to `Partial<Cypress.Loggable & Cypress.Timeoutable>`.
-    ng (type, selector, options: any = {}) {
-      const userOptions = options
-
+    ng (type: string, selector: string, userOptions: Partial<Cypress.Loggable & Cypress.Timeoutable> = {}) {
       // what about requirejs / browserify?
       // we need to intelligently check to see if we're using those
       // and if angular is available through them.  throw a very specific
@@ -102,7 +104,7 @@ export default (Commands, Cypress, cy, state) => {
         $errUtils.throwErrByPath('ng.no_global')
       }
 
-      options = _.defaults({}, userOptions, { log: true })
+      const options: InternalNgOptions = _.defaults({}, userOptions, { log: true })
 
       if (options.log) {
         options._log = Cypress.log({

packages/driver/src/cy/commands/clock.ts

@@ -42,8 +42,7 @@ export default function (Commands, Cypress, cy, state) {
   })
 
   return Commands.addAll({ type: 'utility' }, {
-    // TODO: change the options type from `any` to Partial<Loggable>.
-    clock (subject, now, methods, options: any = {}) {
+    clock (subject, now, methods, options: Partial<Cypress.Loggable> = {}) {
       let userOptions = options
       const ctx = state('ctx')