cypress 3.1.4 → 3.3.1

package/types/{blob-util.d.ts → cy-blob-util.d.ts}

@@ -3,7 +3,7 @@
 // so that Cypress can get and use the Blob type
 
 // tslint:disable-next-line:no-implicit-dependencies
-import * as blobUtil from 'blob-util'
+import * as blobUtil from './blob-util'
 
 export = BlobUtil
 export as namespace BlobUtil

package/types/{bluebird.d.ts → cy-bluebird.d.ts}

@@ -1,7 +1,7 @@
 // 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 * as BluebirdStatic from 'bluebird'
+import BluebirdStatic = require('./bluebird')
 
 export = Bluebird
 export as namespace Bluebird

package/types/{chai.d.ts → cy-chai.d.ts}

@@ -1,7 +1,6 @@
 // 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
-// tslint:disable-next-line:no-implicit-dependencies
-import * as chai from 'chai'
+/// <reference path="./chai/index.d.ts" />
 
 export = Chai
 export as namespace Chai

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-npm-api.d.ts

@@ -0,0 +1,504 @@
+//
+// Cypress NPM api type declarations
+// https://on.cypress.io/module-api
+// https://github.com/cypress-io/cypress/issues/2141
+//
+// in the future the NPM module itself will be in TypeScript
+// 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 glob pattern of the test files to load.
+     */
+    testFiles: 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
+   * @example
+    ```
+    const cypress = require('cypress')
+    cypress.run({
+      reporter: 'junit',
+      browser: 'chrome',
+      config: {
+        baseUrl: 'http://localhost:8080',
+        chromeWebSecurity: false,
+      },
+      env: {
+        foo: 'bar',
+        baz: 'quux',
+      }
+    })
+    ```
+   */
+  interface CypressRunOptions {
+    /**
+     * Specify different browser to run tests in, either by name or by filesystem path
+    */
+    browser: string
+    /**
+     * Specify a unique identifier for a run to enable grouping or parallelization
+     */
+    ciBuildId: string
+    /**
+     * Specify configuration
+     */
+    config: Partial<CypressConfiguration>
+    /**
+     * Specify environment variables
+     */
+    env: object
+    /**
+     * Group recorded tests together under a single run name
+     */
+    group: string
+    /**
+     * Display the Electron browser instead of running headlessly
+     */
+    headed: boolean
+    /**
+     * Specify your secret record key
+     */
+    key: string
+    /**
+     * Keep Cypress open after all tests run
+     */
+    noExit: boolean
+    /**
+     * Run recorded specs in parallel across multiple machines
+     */
+    parallel: boolean
+    /**
+     * Override default port
+     */
+    port: number
+    /**
+     * Path to a specific project
+     */
+    project: string
+    /**
+     * Whether to record the test run
+     */
+    record: boolean
+    /**
+     * Specify a mocha reporter
+     */
+    reporter: string
+    /**
+     * Specify mocha reporter options
+     */
+    reporterOptions: any
+    /**
+     * Specify the specs to run
+     */
+    spec: string
+  }
+
+  /**
+   * All options that one can pass to "cypress.open"
+   * @see https://on.cypress.io/module-api#cypress-open
+   * @example
+    ```
+    const cypress = require('cypress')
+    cypress.open({
+      env: {
+        username: 'Joe Doe',
+        email: 'joe@acme.co'
+      },
+      project: '~/demos/my-project'
+    })
+    ```
+   */
+  interface CypressOpenOptions {
+    /**
+     * Specify a filesystem path to a custom browser
+     */
+    browser: string
+    /**
+     * Specify configuration
+     */
+    config: Partial<CypressConfiguration>
+    /**
+     * Open Cypress in detached mode
+     */
+    detached: boolean
+    /**
+     * Specify environment variables
+     */
+    env: object
+    /**
+     * Run in global mode
+     */
+    global: boolean
+    /**
+     * Override default port
+     */
+    port: number
+    /**
+     * Path to a specific project
+     */
+    project: string
+  }
+
+  // small utility types to better express meaning of other types
+  type dateTimeISO = string
+  type ms = number
+  type hookId = string
+  type testId = string
+  type pixels = number
+
+  /**
+   * Cypress single test result
+   */
+  interface TestResult {
+    testId: testId
+    title: string[]
+    state: string
+    body: string
+    /**
+     * Error stack string if there is an error
+     */
+    stack: string | null
+    /**
+     * Error message if there is an error
+     */
+    error: string | null
+    timings: any
+    failedFromHookId: hookId | null
+    wallClockStartedAt: dateTimeISO
+    wallClockDuration: ms
+    videoTimestamp: ms
+  }
+
+  /**
+   * Information about a single "before", "beforeEach", "afterEach" and "after" hook.
+  */
+  interface HookInformation {
+    hookId: hookId
+    hookName: 'before' | 'beforeEach' | 'afterEach' | 'after'
+    title: string[]
+    body: string
+  }
+
+  /**
+   * Information about a single screenshot.
+   */
+  interface ScreenshotInformation {
+    screenshotId: string
+    name: string
+    testId: testId
+    takenAt: dateTimeISO
+    /**
+     * Absolute path to the saved image
+     */
+    path: string
+    height: pixels
+    width: pixels
+  }
+
+  /**
+   * Cypress test run result for a single spec.
+  */
+  interface RunResult {
+    /**
+     * Accurate test results collected by Cypress.
+     */
+    stats: {
+      suites: number
+      tests: number
+      passes: number
+      pending: number
+      skipped: number
+      failures: number
+      wallClockStartedAt: dateTimeISO
+      wallClockEndedAt: dateTimeISO
+      wallClockDuration: ms
+    },
+    /**
+     * Reporter name like "spec"
+     */
+    reporter: string
+    /**
+     * This is controlled by the reporter, and Cypress cannot guarantee
+     * the properties. Usually this object has suites, tests, passes, etc
+     */
+    reporterStats: object
+    hooks: HookInformation[]
+    tests: TestResult[]
+    error: string | null
+    video: string | null
+    screenshots: ScreenshotInformation[]
+    /**
+     * information about the spec test file.
+    */
+    spec: {
+      /**
+       * filename like "spec.js"
+       */
+      name: string
+      /**
+       * name relative to the project root, like "cypress/integration/spec.js"
+      */
+      relative: string
+      /**
+       * resolved filename of the spec
+       */
+      absolute: string
+    },
+    shouldUploadVideo: boolean
+  }
+
+  /**
+   * Results returned by the test run.
+   */
+  interface CypressRunResult {
+    startedTestsAt: dateTimeISO
+    endedTestsAt: dateTimeISO
+    totalDuration: ms
+    totalSuites: number
+    totalTests: number
+    totalFailed: number
+    totalPassed: number
+    totalPending: number
+    totalSkipped: number
+    runs: RunResult[]
+    browserPath: string
+    browserName: string
+    browserVersion: string
+    osName: string
+    osVersion: string
+    cypressVersion: string
+    // TODO add resolved object to the configuration
+    config: CypressConfiguration
+  }
+
+  /**
+   * Cypress NPM module interface.
+   * @see https://on.cypress.io/module-api
+   * @example
+    ```
+    const cypress = require('cypress')
+    cypress.run().then(results => ...)
+    ```
+  */
+  interface CypressNpmApi {
+    /**
+     * Execute a headless Cypress test run.
+     * @see https://on.cypress.io/module-api#cypress-run
+     * @example
+     ```
+     const cypress = require('cypress')
+     // runs all spec files matching a wildcard
+     cypress.run({
+       spec: 'cypress/integration/admin*-spec.js'
+     }).then(results => {
+       // inspect results object
+     })
+     ```
+     */
+    run(options?: Partial<CypressRunOptions>): Promise<CypressRunResult>,
+    /**
+     * Opens Cypress GUI. Resolves with void when the
+     * GUI is closed.
+     * @see https://on.cypress.io/module-api#cypress-open
+     */
+    open(options?: Partial<CypressOpenOptions>): Promise<void>
+  }
+
+  // export Cypress NPM module interface
+  const cypress: CypressNpmApi
+  export = cypress
+}