cypress 4.3.0 → 4.6.0

package/types/cy-blob-util.d.ts

@@ -0,0 +1,13 @@
+// Shim definition to export a namespace. Cypress is actually a global module
+// so import/export isn't allowed there. We import here and define a global module
+// so that Cypress can get and use the Blob type
+
+// tslint:disable-next-line:no-implicit-dependencies
+import * as blobUtil from './blob-util'
+
+export = BlobUtil
+export as namespace BlobUtil
+
+declare namespace BlobUtil {
+  type BlobUtilStatic = typeof blobUtil
+}

package/types/cy-bluebird.d.ts

@@ -0,0 +1,11 @@
+// Shim definition to export a namespace. Cypress is actually a global module
+// so import/export isn't allowed there. We import here and define a global module
+// so that Cypress can get and use the Blob type
+import BluebirdStatic = require('./bluebird')
+
+export = Bluebird
+export as namespace Bluebird
+
+declare namespace Bluebird {
+  type BluebirdStatic = typeof BluebirdStatic
+}

package/types/cy-chai.d.ts

@@ -0,0 +1,10 @@
+// Shim definition to export a namespace. Cypress is actually a global module
+// so import/export isn't allowed there. We import here and define a global module
+/// <reference path="./chai/index.d.ts" />
+declare namespace Chai {
+  interface Include {
+    html(html: string): Assertion
+    text(text: string): Assertion
+    value(text: string): Assertion
+  }
+}

package/types/cy-minimatch.d.ts

@@ -0,0 +1,96 @@
+// I was trying to avoid relying on "import" of actual module from "minimatch"
+// because it would not work in test project, and the only reliable way
+// to get around type errors finally was to copy the minimal minimatch function
+// definition from "minimatch/index.d.ts" here and just keep it in our code
+
+export = Minimatch
+export as namespace Minimatch
+
+interface MinimatchOptions {
+  /**
+   * Dump a ton of stuff to stderr.
+   *
+   * @default false
+   */
+  debug?: boolean
+
+  /**
+   * Do not expand {a,b} and {1..3} brace sets.
+   *
+   * @default false
+   */
+  nobrace?: boolean
+
+  /**
+   * Disable ** matching against multiple folder names.
+   *
+   * @default false
+   */
+  noglobstar?: boolean
+
+  /**
+   * Allow patterns to match filenames starting with a period,
+   * even if the pattern does not explicitly have a period in that spot.
+   *
+   * @default false
+   */
+  dot?: boolean
+
+  /**
+   * Disable "extglob" style patterns like +(a|b).
+   *
+   * @default false
+   */
+  noext?: boolean
+
+  /**
+   * Perform a case-insensitive match.
+   *
+   * @default false
+   */
+  nocase?: boolean
+
+  /**
+   * When a match is not found by minimatch.match,
+   * return a list containing the pattern itself if this option is set.
+   * Otherwise, an empty list is returned if there are no matches.
+   *
+   * @default false
+   */
+  nonull?: boolean
+
+  /**
+   * If set, then patterns without slashes will be matched against
+   * the basename of the path if it contains slashes.
+   *
+   * @default false
+   */
+  matchBase?: boolean
+
+  /**
+   * Suppress the behavior of treating #
+   * at the start of a pattern as a comment.
+   *
+   * @default false
+   */
+  nocomment?: boolean
+
+  /**
+   * Suppress the behavior of treating a leading ! character as negation.
+   *
+   * @default false
+   */
+  nonegate?: boolean
+
+  /**
+   * Returns from negate expressions the same as if they were not negated.
+   * (Ie, true on a hit, false on a miss.)
+   *
+   * @default false
+   */
+  flipNegate?: boolean
+}
+
+declare namespace Minimatch {
+  function minimatch(target: string, pattern: string, options?: MinimatchOptions): boolean
+}

package/types/cy-moment.d.ts

@@ -0,0 +1,7 @@
+import moment = require('moment')
+export = Moment
+export as namespace Moment
+
+declare namespace Moment {
+  type MomentStatic = typeof moment
+}

package/types/cypress-eventemitter.d.ts

@@ -0,0 +1,8 @@
+// Cypress, cy, Log inherits EventEmitter.
+type EventEmitter2 = import("eventemitter2").EventEmitter2
+
+interface EventEmitter extends EventEmitter2 {
+  proxyTo: (cy: Cypress.cy) => null
+  emitMap: (eventName: string, args: any[]) => Array<(...args: any[]) => any>
+  emitThen: (eventName: string, args: any[]) => Bluebird.BluebirdStatic
+}

package/types/cypress-expect.d.ts

@@ -0,0 +1,3 @@
+// Cypress adds chai expect and assert to global
+declare const expect: Chai.ExpectStatic
+declare const assert: Chai.AssertStatic

package/types/cypress-global-vars.d.ts

@@ -0,0 +1,24 @@
+/// <reference path="./cypress-eventemitter.d.ts" />
+
+/**
+ * Global variables `cy` added by Cypress with all API commands.
+ * @see https://on.cypress.io/api
+ *
+```
+cy.get('button').click()
+cy.get('.result').contains('Expected text')
+```
+ */
+declare const cy: Cypress.cy & EventEmitter
+
+/**
+ * Global variable `Cypress` holds common utilities and constants.
+ * @see https://on.cypress.io/api
+ *
+```
+Cypress.config("pageLoadTimeout") // => 60000
+Cypress.version // => "1.4.0"
+Cypress._ // => Lodash _
+```
+ */
+declare const Cypress: Cypress.Cypress & EventEmitter

package/types/cypress-npm-api.d.ts

@@ -7,203 +7,6 @@
 // but for now describe it as an ambient module
 
 declare module 'cypress' {
-  /**
-   * Cypress configuration object.
-   * @see https://on.cypress.io/configuration
-   */
-  interface CypressConfiguration {
-    //
-    // global options
-    //
-
-    /**
-     * Url used as prefix for `cy.visit()` or `cy.request()` command’s url
-     */
-    baseUrl: string,
-    /**
-     * Any values to be set as environment variables
-     */
-    env: object,
-    /**
-     * A String or Array of glob patterns used to ignore test files
-     * that would otherwise be shown in your list of tests.
-     */
-    ignoreTestFiles: string | string[],
-    /**
-     * The number of tests for which snapshots and command data are kept in memory.
-     * Reduce this number if you are experiencing high memory consumption in your browser during a test run.
-     */
-    numTestsKeptInMemory: number,
-    /**
-     * Port used to host Cypress. Normally this is a randomly generated port
-     */
-    port: number,
-    /**
-     * The reporter used during the `cypress run`. Default is "spec"
-     */
-    reporter: string,
-    /**
-     * A String or Array of string glob pattern of the test files to load.
-     */
-    testFiles: string | string[]
-
-    //
-    // timeouts
-    //
-
-    /**
-     * Time, in milliseconds, to wait until most DOM based commands
-     * are considered timed out.
-     */
-    defaultCommandTimeout: number,
-    /**
-     * Time, in milliseconds, to wait for a system command to
-     * finish executing during a `cy.exec()` command.
-     */
-    execTimeout: number,
-    /**
-     * Time, in milliseconds, to wait for a task to finish executing
-     * during a `cy.task()` command.
-     */
-    taskTimeout: number,
-    /**
-     * Time, in milliseconds, to wait for page transition events or
-     * `cy.visit()`, `cy.go()`, `cy.reload()` commands to fire
-     * their page load events.
-     */
-    pageLoadTimeout: number,
-    /**
-     * Time, in milliseconds, to wait for an XHR request to go out
-     * in a `cy.wait()` command.
-     */
-    requestTimeout: number,
-    /**
-     * Time, in milliseconds, to wait until a response in a
-     * `cy.request()`, `cy.wait()`, `cy.fixture()`, `cy.getCookie()`,
-     * `cy.getCookies()`, `cy.setCookie()`, `cy.clearCookie()`,
-     * `cy.clearCookies()`, and `cy.screenshot()` commands.
-    */
-    responseTimeout: number,
-
-    //
-    // folders and files
-    //
-
-    /**
-     * Path to folder where application files will attempt to be served from.
-     */
-    fileServerFolder: string,
-    /**
-     * Path to folder containing fixture files (Pass `false` to disable).
-     */
-    fixturesFolder: string | false,
-    /**
-     * Path to folder containing integration test files.
-     */
-    integrationFolder: string,
-    /**
-     * Path to plugins file. (Pass `false` to disable)
-     */
-    pluginsFile: string | false,
-    /**
-     * Path to folder where screenshots will be saved from `cy.screenshot()`
-     * command or after a test fails during cypress run.
-     */
-    screenshotsFolder: string,
-    /**
-     * Path to file to load before test files load.
-     * This file is compiled and bundled. (Pass `false` to disable).
-     */
-    supportFile: string | false,
-    /**
-     * Path to folder where videos will be saved during `cypress run`
-     */
-    videosFolder: string,
-
-    //
-    // screenshots
-    //
-
-    /**
-     * Whether Cypress will trash assets within the `screenshotsFolder` and
-     * `videosFolder` before tests run with cypress run. Default is `true`.
-     */
-    trashAssetsBeforeRuns: boolean,
-
-    //
-    // videos
-    //
-
-    /**
-     * The quality setting for the video compression, in Constant Rate Factor (CRF).
-     * The value can be false to disable compression or a value between 0 and 51,
-     * where a lower value results in better quality
-     * (at the expense of a higher file size).
-     */
-    videoCompression: number | false,
-    /**
-     * Whether Cypress will capture a video of the tests run with `cypress run`.
-     */
-    video: boolean,
-    /**
-     * Whether Cypress will upload the video to the Dashboard even if
-     * all tests are passing. This applies only when recording your runs
-     * to the Dashboard. Turn this off if you’d like the video uploaded
-     * only when there are failing tests.
-     */
-    videoUploadOnPasses: boolean,
-
-    //
-    // browser
-    //
-    /**
-     * Whether Chrome Web Security for `same-origin` policy and
-     * `insecure mixed content` is enabled.
-     */
-    chromeWebSecurity: boolean,
-    /**
-     * Enables you to override the default user agent the
-     * browser sends in all request headers.
-     */
-    userAgent: string,
-    /**
-     * A String or Array of hosts that you wish to block traffic for.
-     */
-    blacklistHosts: string | string[],
-    /**
-     * Whether Cypress will search for and replace obstructive JS code
-     * in `.js` or `.html` files.
-     */
-    modifyObstructiveCode: boolean,
-
-    //
-    // viewport
-    //
-    /**
-     * Default height in pixels for the application under tests’ viewport
-     * (Override with `cy.viewport()` command)
-     */
-    viewportHeight: number,
-    /**
-     * Default width in pixels for the application under tests’ viewport.
-     * (Override with `cy.viewport()` command)
-     */
-    viewportWidth: number
-
-    //
-    // animations
-    //
-    /**
-     * The distance in pixels an element must exceed over
-     * time to be considered animating.
-     */
-    animationDistanceThreshold: number
-    /**
-     * Whether to wait for elements to finish animating before executing commands.
-     */
-    waitForAnimations: boolean
-  }
-
   /**
    * All options that one can pass to "cypress.run"
    * @see https://on.cypress.io/module-api#cypress-run
@@ -324,7 +127,7 @@ declare module 'cypress' {
     /**
      * Specify configuration
      */
-    config: Partial<CypressConfiguration>
+    config: Partial<Cypress.ResolvedConfigOptions>
     /**
      * Path to the config file to be used.
      *
@@ -334,7 +137,8 @@ declare module 'cypress' {
      */
     configFile: string | false
     /**
-     * Specify environment variables
+     * Specify environment variables.
+     * TODO: isn't this duplicate of config.env?!
      */
     env: object
     /**
@@ -477,14 +281,12 @@ declare module 'cypress' {
     osName: string
     osVersion: string
     cypressVersion: string
-    // TODO add resolved object to the configuration
-    config: CypressConfiguration
-    /**
+    config: Cypress.ResolvedConfigOptions
+  }
+
+  /**
      * If Cypress fails to run at all (for example, if there are no spec files to run),
-     * then it will set failures to 1 and will have actual error message in the
-     * property "message". Check this property before checking other properties.
-     *
-     * @type {number}
+     * then it will return a CypressFailedRunResult. Check the failures attribute.
      * @example
       ```
       const result = await cypress.run()
@@ -493,15 +295,11 @@ declare module 'cypress' {
         process.exit(result.failures)
       }
       ```
-     */
-    failures?: number
-    /**
-     * If returned result has "failures" set, then this property gives
-     * the error message.
      *
-     * @type {string}
-     */
-    message?: string
+  **/
+  interface CypressFailedRunResult {
+    failures: number
+    message: string
   }
 
   /**
@@ -528,7 +326,7 @@ declare module 'cypress' {
      })
      ```
      */
-    run(options?: Partial<CypressRunOptions>): Promise<CypressRunResult>,
+    run(options?: Partial<CypressRunOptions>): Promise<CypressRunResult | CypressFailedRunResult>,
     /**
      * Opens Cypress GUI. Resolves with void when the
      * GUI is closed.

package/types/cypress-type-helpers.d.ts

@@ -0,0 +1,2 @@
+// type helpers
+type Nullable<T> = T | null