cypress 8.0.0 → 8.3.1

package/README.md

@@ -1,8 +1,10 @@
 # Cypress
 
+Fast, easy and reliable testing for anything that runs in a browser.
+
 ## What is this?
 
-Cypress comes packaged as an `npm` module, which is all you need to get started.
+[Cypress](https://www.cypress.io/) comes packaged as an `npm` module, which is all you need to get started testing.
 
 After installing you'll be able to:
 
@@ -12,7 +14,7 @@ After installing you'll be able to:
 
 ## Install
 
-Requires Node version >= 10.0.0
+Please check our [system requirements](https://on.cypress.io/installing-cypress).
 
 ```sh
 npm install --save-dev cypress

package/lib/util.js

@@ -263,7 +263,17 @@ const util = {
     .mapValues(value => {
       // stringify to 1 or 0
       return value ? '1' : '0';
-    }).value();
+    }).extend(util.getOriginalNodeOptions(options)).value();
+  },
+
+  getOriginalNodeOptions(options) {
+    if (process.env.NODE_OPTIONS) {
+      return {
+        ORIGINAL_NODE_OPTIONS: process.env.NODE_OPTIONS
+      };
+    }
+
+    return {};
   },
 
   getForceTty() {

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "cypress",
-  "version": "8.0.0",
+  "version": "8.3.1",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",
     "size": "t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";"
   },
   "dependencies": {
-    "@cypress/request": "^2.88.5",
+    "@cypress/request": "^2.88.6",
     "@cypress/xvfb": "^1.2.4",
     "@types/node": "^14.14.31",
     "@types/sinonjs__fake-timers": "^6.0.2",

package/types/cypress.d.ts

@@ -258,6 +258,14 @@ declare namespace Cypress {
      */
     spec: Spec
 
+    /**
+     * Currently executing test runnable instance.
+     */
+    currentTest: {
+      title: string,
+      titlePath: string[]
+    }
+
     /**
      * Information about the browser currently running the tests
      */
@@ -557,6 +565,10 @@ declare namespace Cypress {
     onSpecWindow: (window: Window, specList: string[] | Array<() => Promise<void>>) => void
   }
 
+  interface SessionOptions {
+    validate?: () => false|void
+  }
+
   type CanReturnChainable = void | Chainable | Promise<unknown>
   type ThenReturn<S, R> =
     R extends void ? Chainable<S> :
@@ -952,6 +964,15 @@ declare namespace Cypress {
      */
     debug(options?: Partial<Loggable>): Chainable<Subject>
 
+   /**
+     * Save/Restore browser Cookies, LocalStorage, and SessionStorage data resulting from the supplied `setup` function.
+     *
+     * Only available if the `experimentalSessionSupport` config option is enabled.
+     *
+     * @see https://on.cypress.io/session
+     */
+    session(id: string|object, setup?: SessionOptions['validate'], options?: SessionOptions): Chainable<null>
+
     /**
      * Get the window.document of the page that is currently active.
      *
@@ -961,7 +982,7 @@ declare namespace Cypress {
      *      .its('contentType')
      *      .should('eq', 'text/html')
      */
-    document(options?: Partial<Loggable>): Chainable<Document>
+    document(options?: Partial<Loggable & Timeoutable>): Chainable<Document>
 
     /**
      * Iterate through an array like structure (arrays or objects with a length property).
@@ -1661,7 +1682,7 @@ declare namespace Cypress {
      *    .shadow()
      *    .find('.my-button')
      *    .click()
-     * @see https://on.cypress.io/experimental
+     * @see https://on.cypress.io/shadow
      */
     shadow(): Chainable<Subject>
 
@@ -1937,7 +1958,7 @@ declare namespace Cypress {
      *
      * @see https://on.cypress.io/title
      */
-    title(options?: Partial<Loggable>): Chainable<string>
+    title(options?: Partial<Loggable & Timeoutable>): Chainable<string>
 
     /**
      * Trigger an event on a DOM element.
@@ -2653,6 +2674,11 @@ declare namespace Cypress {
      * @default 'top'
      */
     scrollBehavior: scrollBehaviorOptions
+    /**
+     * Enable experimental session support. See https://on.cypress.io/session
+     * @default false
+     */
+    experimentalSessionSupport: boolean
     /**
      * Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode.
      * @default false
@@ -2717,13 +2743,13 @@ declare namespace Cypress {
      * Override default config options for Component Testing runner.
      * @default {}
      */
-    component: Omit<ResolvedConfigOptions, 'e2e' | 'component'>
+    component: Omit<ResolvedConfigOptions, TestingType>
 
     /**
      * Override default config options for E2E Testing runner.
      * @default {}
      */
-    e2e: Omit<ResolvedConfigOptions, 'e2e' | 'component'>
+    e2e: Omit<ResolvedConfigOptions, TestingType>
   }
 
   /**
@@ -2809,7 +2835,7 @@ declare namespace Cypress {
   /**
    * All configuration items are optional.
    */
-  type CoreConfigOptions = Partial<Omit<ResolvedConfigOptions, 'e2e' | 'component'>>
+  type CoreConfigOptions = Partial<Omit<ResolvedConfigOptions, TestingType>>
   type ConfigOptions = CoreConfigOptions & {e2e?: CoreConfigOptions, component?: CoreConfigOptions }
 
   interface PluginConfigOptions extends ResolvedConfigOptions {
@@ -5509,6 +5535,7 @@ declare namespace Cypress {
 
   interface Log {
     end(): Log
+    error(error: Error): Log
     finish(): void
     get<K extends keyof LogConfig>(attr: K): LogConfig[K]
     get(): LogConfig

package/types/net-stubbing.ts

@@ -267,9 +267,11 @@ interface RequestEvents {
  */
 export interface Interception {
   id: string
+  /* @internal */
+  browserRequestId?: string
   routeId: string
   /* @internal */
-  log?: any
+  setLogFlag: (flag: 'spied' | 'stubbed' | 'reqModified' | 'resModified') => void
   request: CyHttpMessages.IncomingRequest
   /**
    * Was `cy.wait()` used to wait on this request?