cypress 15.2.0 → 15.4.0

package/types/cypress-automation.d.ts

@@ -12,7 +12,8 @@ declare namespace Cypress {
   'Tab' |
   'Backspace' |
   'Delete' |
-  'Insert'
+  'Insert' |
+  'Escape'
 
   type SupportedKey = SupportedNamedKey | string | number
 }

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

@@ -68,6 +68,10 @@ declare namespace CypressCommandLine {
      * Override default port
      */
     port: number
+    /**
+     * Use POSIX exit codes for error handling
+     */
+    posixExitCodes: boolean
     /**
      * Run quietly, using only the configured reporter
      */

package/types/cypress.d.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 /// <reference path="./cypress-npm-api.d.ts" />
 /// <reference path="./cypress-eventemitter.d.ts" />
 /// <reference path="./cypress-type-helpers.d.ts" />
@@ -59,6 +58,9 @@ declare namespace Cypress {
   interface ObjectLike {
     [key: string]: any
   }
+  interface PromptOptions {
+    placeholders?: Record<string, string>
+  }
   interface Auth {
     username: string
     password: string
@@ -684,21 +686,22 @@ declare namespace Cypress {
     Keyboard: {
       defaults(options: Partial<KeyboardDefaultsOptions>): void
       Keys: {
-        DOWN: 'ArrowDown',
-        LEFT: 'ArrowLeft',
-        RIGHT: 'ArrowRight',
-        UP: 'ArrowUp',
-        END: 'End',
-        HOME: 'Home',
-        PAGEDOWN: 'PageDown',
-        PAGEUP: 'PageUp',
-        ENTER: 'Enter',
-        TAB: 'Tab',
-        BACKSPACE: 'Backspace',
-        SPACE: 'Space',
-        DELETE: 'Delete',
-        INSERT: 'Insert',
-      },
+        DOWN: 'ArrowDown'
+        LEFT: 'ArrowLeft'
+        RIGHT: 'ArrowRight'
+        UP: 'ArrowUp'
+        END: 'End'
+        HOME: 'Home'
+        PAGEDOWN: 'PageDown'
+        PAGEUP: 'PageUp'
+        ENTER: 'Enter'
+        TAB: 'Tab'
+        BACKSPACE: 'Backspace'
+        SPACE: 'Space'
+        DELETE: 'Delete'
+        INSERT: 'Insert'
+        ESC: 'Escape'
+      }
     }
 
     /**
@@ -754,7 +757,7 @@ declare namespace Cypress {
      * Trigger action
      * @private
      */
-    action: <T = (any[] | void) >(action: string, ...args: any[]) => T
+    action: <T = (any[] | void)>(action: string, ...args: any[]) => T
 
     /**
      * Load files
@@ -1690,7 +1693,7 @@ declare namespace Cypress {
      *      cy.get('h1').should('equal', 'Example Domain')
      *    })
      */
-    origin<T extends any>(urlOrDomain: string, fn: () => void): Chainable<T>
+    origin<T>(urlOrDomain: string, fn: () => void): Chainable<T>
 
     /**
      * Enables running Cypress commands in a secondary origin.
@@ -1701,7 +1704,7 @@ declare namespace Cypress {
      *      expect(foo).to.equal('foo')
      *    })
      */
-    origin<T, S extends any>(urlOrDomain: string, options: {
+    origin<T, S>(urlOrDomain: string, options: {
       args: T
     }, fn: (args: T) => void): Chainable<S>
 
@@ -1848,7 +1851,12 @@ declare namespace Cypress {
      * @see https://on.cypress.io/prevuntil
      */
     prevUntil<E extends Node = HTMLElement>(element: E | JQuery<E>, filter?: string, options?: Partial<Loggable & Timeoutable>): Chainable<JQuery<E>>
-
+    /**
+     * An AI-powered command that generates Cypress commands from natural language test steps.
+     *
+     * @see https://on.cypress.io/prompt
+     */
+    prompt<T>(steps: string[], options?: PromptOptions): Chainable<T>
     /**
      * Read a file and yield its contents.
      *
@@ -2897,8 +2905,8 @@ declare namespace Cypress {
   }
 
   type RetryStrategyWithModeSpecs = RetryStrategy & {
-    openMode: boolean; // defaults to false
-    runMode: boolean; // defaults to true
+    openMode: boolean // defaults to false
+    runMode: boolean // defaults to true
   }
 
   type RetryStrategy =
@@ -2906,18 +2914,18 @@ declare namespace Cypress {
     | RetryStrategyDetectFlakeButAlwaysFailType
 
   interface RetryStrategyDetectFlakeAndPassOnThresholdType {
-    experimentalStrategy: "detect-flake-and-pass-on-threshold"
+    experimentalStrategy: 'detect-flake-and-pass-on-threshold'
     experimentalOptions?: {
-      maxRetries: number; // defaults to 2 if experimentalOptions is not provided, must be a whole number > 0
-      passesRequired: number; // defaults to 2 if experimentalOptions is not provided, must be a whole number > 0 and <= maxRetries
+      maxRetries: number // defaults to 2 if experimentalOptions is not provided, must be a whole number > 0
+      passesRequired: number // defaults to 2 if experimentalOptions is not provided, must be a whole number > 0 and <= maxRetries
     }
   }
 
   interface RetryStrategyDetectFlakeButAlwaysFailType {
-    experimentalStrategy: "detect-flake-but-always-fail"
+    experimentalStrategy: 'detect-flake-but-always-fail'
     experimentalOptions?: {
-      maxRetries: number; // defaults to 2 if experimentalOptions is not provided, must be a whole number > 0
-      stopIfAnyPassed: boolean; // defaults to false if experimentalOptions is not provided
+      maxRetries: number // defaults to 2 if experimentalOptions is not provided, must be a whole number > 0
+      stopIfAnyPassed: boolean // defaults to false if experimentalOptions is not provided
     }
   }
   interface ResolvedConfigOptions<ComponentDevServerOpts = any> {
@@ -3139,7 +3147,7 @@ declare namespace Cypress {
      * @see https://on.cypress.io/experiments#Experimental-CSP-Allow-List
      * @default false
      */
-    experimentalCspAllowList: boolean | experimentalCspAllowedDirectives[],
+    experimentalCspAllowList: boolean | experimentalCspAllowedDirectives[]
     /**
      * Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode.
      * @default false
@@ -3271,6 +3279,11 @@ declare namespace Cypress {
      * @default false
      */
     experimentalOriginDependencies?: boolean
+    /**
+     * Enables support for `cy.prompt`, an AI-powered command that turns natural language steps into executable Cypress test code.
+     * @default false
+     */
+    experimentalPromptCommand?: boolean
   }
 
   /**

package/index.mjs

@@ -1,17 +0,0 @@
-import module from 'module'
-
-const require = module.createRequire(import.meta.url)
-
-const cypress = require('./lib/cypress')
-
-export default cypress
-
-export const defineConfig = cypress.defineConfig
-
-export const defineComponentFramework = cypress.defineComponentFramework
-
-export const run = cypress.run
-
-export const open = cypress.open
-
-export const cli = cypress.cli

package/lib/exec/spawn.js

@@ -1,285 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const lodash_1 = __importDefault(require("lodash"));
-const os_1 = __importDefault(require("os"));
-const child_process_1 = __importDefault(require("child_process"));
-const path_1 = __importDefault(require("path"));
-const bluebird_1 = __importDefault(require("bluebird"));
-const debug_1 = __importDefault(require("debug"));
-const util_1 = __importDefault(require("../util"));
-const state_1 = __importDefault(require("../tasks/state"));
-const xvfb_1 = __importDefault(require("./xvfb"));
-const verify_1 = __importDefault(require("../tasks/verify"));
-const errors_1 = require("../errors");
-const readline_1 = __importDefault(require("readline"));
-const debug = (0, debug_1.default)('cypress:cli');
-function isPlatform(platform) {
-    return os_1.default.platform() === platform;
-}
-function needsStderrPiped(needsXvfb) {
-    return lodash_1.default.some([
-        isPlatform('darwin'),
-        (needsXvfb && isPlatform('linux')),
-        util_1.default.isPossibleLinuxWithIncorrectDisplay(),
-    ]);
-}
-function needsEverythingPipedDirectly() {
-    return isPlatform('win32');
-}
-function getStdio(needsXvfb) {
-    if (needsEverythingPipedDirectly()) {
-        return 'pipe';
-    }
-    // https://github.com/cypress-io/cypress/issues/921
-    // https://github.com/cypress-io/cypress/issues/1143
-    // https://github.com/cypress-io/cypress/issues/1745
-    if (needsStderrPiped(needsXvfb)) {
-        // returning pipe here so we can massage stderr
-        // and remove garbage from Xlib and libuv
-        // due to starting the Xvfb process on linux
-        return ['inherit', 'inherit', 'pipe'];
-    }
-    return 'inherit';
-}
-const spawnModule = {
-    start(args, options = {}) {
-        const needsXvfb = xvfb_1.default.isNeeded();
-        let executable = state_1.default.getPathToExecutable(state_1.default.getBinaryDir());
-        if (util_1.default.getEnv('CYPRESS_RUN_BINARY')) {
-            executable = path_1.default.resolve(util_1.default.getEnv('CYPRESS_RUN_BINARY'));
-        }
-        debug('needs to start own Xvfb?', needsXvfb);
-        // Always push cwd into the args
-        // which additionally acts as a signal to the
-        // binary that it was invoked through the NPM module
-        args = args || [];
-        if (typeof args === 'string') {
-            args = [args];
-        }
-        args = [...args, '--cwd', process.cwd(), '--userNodePath', process.execPath, '--userNodeVersion', process.versions.node];
-        lodash_1.default.defaults(options, {
-            dev: false,
-            env: process.env,
-            detached: false,
-            stdio: getStdio(needsXvfb),
-        });
-        const spawn = (overrides = {}) => {
-            return new bluebird_1.default((resolve, reject) => {
-                lodash_1.default.defaults(overrides, {
-                    onStderrData: false,
-                });
-                const { onStderrData } = overrides;
-                const envOverrides = util_1.default.getEnvOverrides(options);
-                const electronArgs = [];
-                const node11WindowsFix = isPlatform('win32');
-                let startScriptPath;
-                if (options.dev) {
-                    executable = 'node';
-                    // if we're in dev then reset
-                    // the launch cmd to be 'npm run dev'
-                    startScriptPath = path_1.default.resolve(__dirname, '..', '..', '..', 'scripts', 'start.js');
-                    debug('in dev mode the args became %o', args);
-                }
-                if (!options.dev && verify_1.default.needsSandbox()) {
-                    electronArgs.push('--no-sandbox');
-                }
-                // strip dev out of child process options
-                /**
-                 * @type {import('child_process').ForkOptions}
-                 */
-                let stdioOptions = lodash_1.default.pick(options, 'env', 'detached', 'stdio');
-                // figure out if we're going to be force enabling or disabling colors.
-                // also figure out whether we should force stdout and stderr into thinking
-                // it is a tty as opposed to a pipe.
-                stdioOptions.env = lodash_1.default.extend({}, stdioOptions.env, envOverrides);
-                if (node11WindowsFix) {
-                    stdioOptions = lodash_1.default.extend({}, stdioOptions, { windowsHide: false });
-                }
-                if (util_1.default.isPossibleLinuxWithIncorrectDisplay()) {
-                    // make sure we use the latest DISPLAY variable if any
-                    debug('passing DISPLAY', process.env.DISPLAY);
-                    stdioOptions.env.DISPLAY = process.env.DISPLAY;
-                }
-                if (stdioOptions.env.ELECTRON_RUN_AS_NODE) {
-                    // Since we are running electron as node, we need to add an entry point file.
-                    startScriptPath = path_1.default.join(state_1.default.getBinaryPkgPath(path_1.default.dirname(executable)), '..', 'index.js');
-                }
-                else {
-                    // Start arguments with "--" so Electron knows these are OUR
-                    // arguments and does not try to sanitize them. Otherwise on Windows
-                    // an url in one of the arguments crashes it :(
-                    // https://github.com/cypress-io/cypress/issues/5466
-                    args = [...electronArgs, '--', ...args];
-                }
-                if (startScriptPath) {
-                    args.unshift(startScriptPath);
-                }
-                if (process.env.CYPRESS_INTERNAL_DEV_DEBUG) {
-                    args.unshift(process.env.CYPRESS_INTERNAL_DEV_DEBUG);
-                }
-                debug('spawn args %o %o', args, lodash_1.default.omit(stdioOptions, 'env'));
-                debug('spawning Cypress with executable: %s', executable);
-                const child = child_process_1.default.spawn(executable, args, stdioOptions);
-                function resolveOn(event) {
-                    return function (code, signal) {
-                        debug('child event fired %o', { event, code, signal });
-                        if (code === null) {
-                            const errorObject = errors_1.errors.childProcessKilled(event, signal);
-                            return (0, errors_1.getError)(errorObject).then(reject);
-                        }
-                        resolve(code);
-                    };
-                }
-                child.on('close', resolveOn('close'));
-                child.on('exit', resolveOn('exit'));
-                child.on('error', reject);
-                if (isPlatform('win32')) {
-                    const rl = readline_1.default.createInterface({
-                        input: process.stdin,
-                        output: process.stdout,
-                    });
-                    // on windows, SIGINT does not propagate to the child process when ctrl+c is pressed
-                    // this makes sure all nested processes are closed(ex: firefox inside the server)
-                    rl.on('SIGINT', function () {
-                        return __awaiter(this, void 0, void 0, function* () {
-                            const kill = (yield Promise.resolve().then(() => __importStar(require('tree-kill')))).default;
-                            kill(child.pid, 'SIGINT');
-                        });
-                    });
-                }
-                // if stdio options is set to 'pipe', then
-                //   we should set up pipes:
-                //  process STDIN (read stream) => child STDIN (writeable)
-                //  child STDOUT => process STDOUT
-                //  child STDERR => process STDERR with additional filtering
-                if (child.stdin) {
-                    debug('piping process STDIN into child STDIN');
-                    process.stdin.pipe(child.stdin);
-                }
-                if (child.stdout) {
-                    debug('piping child STDOUT to process STDOUT');
-                    child.stdout.pipe(process.stdout);
-                }
-                // if this is defined then we are manually piping for linux
-                // to filter out the garbage
-                if (child.stderr) {
-                    debug('piping child STDERR to process STDERR');
-                    child.stderr.on('data', (data) => {
-                        const str = data.toString();
-                        // if we have a callback and this explicitly returns
-                        // false then bail
-                        if (onStderrData && onStderrData(str)) {
-                            return;
-                        }
-                        // else pass it along!
-                        process.stderr.write(data);
-                    });
-                }
-                // https://github.com/cypress-io/cypress/issues/1841
-                // https://github.com/cypress-io/cypress/issues/5241
-                // In some versions of node, it will throw on windows
-                // when you close the parent process after piping
-                // into the child process. unpiping does not seem
-                // to have any effect. so we're just catching the
-                // error here and not doing anything.
-                process.stdin.on('error', (err) => {
-                    if (['EPIPE', 'ENOTCONN'].includes(err.code)) {
-                        return;
-                    }
-                    throw err;
-                });
-                if (stdioOptions.detached) {
-                    child.unref();
-                }
-            });
-        };
-        const spawnInXvfb = () => {
-            return xvfb_1.default
-                .start()
-                .then(userFriendlySpawn)
-                .finally(xvfb_1.default.stop);
-        };
-        const userFriendlySpawn = (linuxWithDisplayEnv) => {
-            debug('spawning, should retry on display problem?', Boolean(linuxWithDisplayEnv));
-            let brokenGtkDisplay;
-            const overrides = {};
-            if (linuxWithDisplayEnv) {
-                lodash_1.default.extend(overrides, {
-                    electronLogging: true,
-                    onStderrData(str) {
-                        // if we receive a broken pipe anywhere
-                        // then we know that's why cypress exited early
-                        if (util_1.default.isBrokenGtkDisplay(str)) {
-                            brokenGtkDisplay = true;
-                        }
-                    },
-                });
-            }
-            return spawn(overrides)
-                .then((code) => {
-                if (code !== 0 && brokenGtkDisplay) {
-                    util_1.default.logBrokenGtkDisplayWarning();
-                    return spawnInXvfb();
-                }
-                return code;
-            })
-                // we can format and handle an error message from the code above
-                // prevent wrapping error again by using "known: undefined" filter
-                .catch({ known: undefined }, (0, errors_1.throwFormErrorText)(errors_1.errors.unexpected));
-        };
-        if (needsXvfb) {
-            return spawnInXvfb();
-        }
-        // if we are on linux and there's already a DISPLAY
-        // set, then we may need to rerun cypress after
-        // spawning our own Xvfb server
-        const linuxWithDisplayEnv = util_1.default.isPossibleLinuxWithIncorrectDisplay();
-        return userFriendlySpawn(linuxWithDisplayEnv);
-    },
-};
-exports.default = spawnModule;

package/lib/exec/versions.js

@@ -1,61 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bluebird_1 = __importDefault(require("bluebird"));
-const debug_1 = __importDefault(require("debug"));
-const path_1 = __importDefault(require("path"));
-const util_1 = __importDefault(require("../util"));
-const state_1 = __importDefault(require("../tasks/state"));
-const errors_1 = require("../errors");
-const debug = (0, debug_1.default)('cypress:cli');
-const getVersions = () => {
-    return bluebird_1.default.try(() => {
-        if (util_1.default.getEnv('CYPRESS_RUN_BINARY')) {
-            let envBinaryPath = path_1.default.resolve(util_1.default.getEnv('CYPRESS_RUN_BINARY'));
-            return state_1.default.parseRealPlatformBinaryFolderAsync(envBinaryPath)
-                .then((envBinaryDir) => {
-                if (!envBinaryDir) {
-                    return (0, errors_1.throwFormErrorText)(errors_1.errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))();
-                }
-                debug('CYPRESS_RUN_BINARY has binaryDir:', envBinaryDir);
-                return envBinaryDir;
-            })
-                .catch({ code: 'ENOENT' }, (err) => {
-                return (0, errors_1.throwFormErrorText)(errors_1.errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))(err.message);
-            });
-        }
-        return state_1.default.getBinaryDir();
-    })
-        .then(state_1.default.getBinaryPkgAsync)
-        .then((pkg) => {
-        const versions = {
-            binary: state_1.default.getBinaryPkgVersion(pkg),
-            electronVersion: state_1.default.getBinaryElectronVersion(pkg),
-            electronNodeVersion: state_1.default.getBinaryElectronNodeVersion(pkg),
-        };
-        debug('binary versions %o', versions);
-        return versions;
-    })
-        .then((binaryVersions) => {
-        const buildInfo = util_1.default.pkgBuildInfo();
-        let packageVersion = util_1.default.pkgVersion();
-        if (!buildInfo)
-            packageVersion += ' (development)';
-        else if (!buildInfo.stable)
-            packageVersion += ' (pre-release)';
-        const versions = {
-            package: packageVersion,
-            binary: binaryVersions.binary || 'not installed',
-            electronVersion: binaryVersions.electronVersion || 'not found',
-            electronNodeVersion: binaryVersions.electronNodeVersion || 'not found',
-        };
-        debug('combined versions %o', versions);
-        return versions;
-    });
-};
-const versionsModule = {
-    getVersions,
-};
-exports.default = versionsModule;

package/lib/fs.js

@@ -1,8 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bluebird_1 = __importDefault(require("bluebird"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
-exports.default = bluebird_1.default.promisifyAll(fs_extra_1.default);