cypress 10.3.0 → 10.5.0

package/react/dist/getDisplayName.d.ts

@@ -1,4 +1,4 @@
-import { JSX } from './mount';
+import { JSX } from './createMount';
 /**
  * Gets the display name of the component when possible.
  * @param type {JSX} The type object returned from creating the react element.

package/react/dist/index.d.ts

@@ -1,2 +1,4 @@
+export * from './createMount';
 export * from './mount';
 export * from './mountHook';
+export * from './types';

package/react/dist/mount.d.ts

@@ -1,143 +1,7 @@
 /// <reference types="cypress" />
-import * as React from 'react';
-import * as ReactDOM from 'react-dom';
-import { StyleOptions } from '@cypress/mount-utils';
-/**
- * Mount a React component in a blank document; register it as an alias
- * To access: use an alias or original component reference
- * @function   mount
- * @param      {React.ReactElement}  jsx - component to mount
- * @param      {MountOptions}  [options] - options, like alias, styles
- * @see https://github.com/bahmutov/@cypress/react
- * @see https://glebbahmutov.com/blog/my-vision-for-component-tests/
- * @example
- ```
-  import Hello from './hello.jsx'
-  import { mount } from '@cypress/react'
-  it('works', () => {
-    mount(<Hello onClick={cy.stub()} />)
-    // use Cypress commands
-    cy.contains('Hello').click()
-  })
- ```
- **/
-export declare const mount: (jsx: React.ReactNode, options?: MountOptions) => globalThis.Cypress.Chainable<MountReturn>;
-/**
- * Removes the mounted component. Notice this command automatically
- * queues up the `unmount` into Cypress chain, thus you don't need `.then`
- * to call it.
- * @see https://github.com/cypress-io/cypress/tree/develop/npm/react/cypress/component/basic/unmount
- * @example
-  ```
-  import { mount, unmount } from '@cypress/react'
-  it('works', () => {
-    mount(...)
-    // interact with the component using Cypress commands
-    // whenever you want to unmount
-    unmount()
-  })
-  ```
- */
-export declare const unmount: (options?: {
+import React from 'react';
+import type { MountOptions } from './types';
+export declare function mount(jsx: React.ReactNode, options?: MountOptions, rerenderKey?: string): Cypress.Chainable<import("./types").MountReturn>;
+export declare function unmount(options?: {
     log: boolean;
-}) => globalThis.Cypress.Chainable<JQuery<HTMLElement>>;
-/**
- * Creates new instance of `mount` function with default options
- * @function   createMount
- * @param      {MountOptions}  [defaultOptions] - defaultOptions for returned `mount` function
- * @returns    new instance of `mount` with assigned options
- * @example
- * ```
- * import Hello from './hello.jsx'
- * import { createMount } from '@cypress/react'
- *
- * const mount = createMount({ strict: true, cssFile: 'path/to/any/css/file.css' })
- *
- * it('works', () => {
- *   mount(<Hello />)
- *   // use Cypress commands
- *   cy.get('button').should('have.css', 'color', 'rgb(124, 12, 109)')
- * })
- ```
- **/
-export declare const createMount: (defaultOptions: MountOptions) => (element: React.ReactElement, options?: Partial<StyleOptions & MountReactComponentOptions> | undefined) => globalThis.Cypress.Chainable<MountReturn>;
-/** @deprecated Should be removed in the next major version */
-export default mount;
-export interface ReactModule {
-    name: string;
-    type: string;
-    location: string;
-    source: string;
-}
-export interface MountReactComponentOptions {
-    alias: string;
-    ReactDom: typeof ReactDOM;
-    /**
-     * Log the mounting command into Cypress Command Log,
-     * true by default.
-     */
-    log: boolean;
-    /**
-     * Render component in React [strict mode](https://reactjs.org/docs/strict-mode.html)
-     * It activates additional checks and warnings for child components.
-     */
-    strict: boolean;
-}
-export declare type MountOptions = Partial<StyleOptions & MountReactComponentOptions>;
-export interface MountReturn {
-    /**
-     * The component that was rendered.
-     */
-    component: React.ReactNode;
-    /**
-     * Rerenders the specified component with new props. This allows testing of components that store state (`setState`)
-     * or have asynchronous updates (`useEffect`, `useLayoutEffect`).
-     */
-    rerender: (component: React.ReactNode) => globalThis.Cypress.Chainable<MountReturn>;
-    /**
-     * Removes the mounted component.
-     * @see `unmount`
-     */
-    unmount: () => globalThis.Cypress.Chainable<JQuery<HTMLElement>>;
-}
-/**
- * The `type` property from the transpiled JSX object.
- * @example
- * const { type } = React.createElement('div', null, 'Hello')
- * const { type } = <div>Hello</div>
- */
-export interface JSX extends Function {
-    displayName: string;
-}
-export declare namespace Cypress {
-    interface Cypress {
-        stylesCache: any;
-        React: string;
-        ReactDOM: string;
-        Styles: string;
-        modules: ReactModule[];
-    }
-    interface Chainable<Subject> {
-        state: (key: string) => any;
-        /**
-         * Mount a React component in a blank document; register it as an alias
-         * To access: use an alias or original component reference
-         *  @function   cy.mount
-         *  @param      {Object}  jsx - component to mount
-         *  @param      {string}  [Component] - alias to use later
-         *  @example
-        ```
-        import Hello from './hello.jsx'
-        // mount and access by alias
-        cy.mount(<Hello />, 'Hello')
-        // using default alias
-        cy.get('@Component')
-        // using specified alias
-        cy.get('@Hello').its('state').should(...)
-        // using original component
-        cy.get(Hello)
-        ```
-        **/
-        get<S = any>(alias: string | symbol | Function, options?: Partial<any>): Chainable<any>;
-    }
-}
+}): Cypress.Chainable<undefined>;

package/react/dist/types.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="cypress" />
+import type React from 'react';
+import type { StyleOptions } from '@cypress/mount-utils';
+export interface UnmountArgs {
+    log: boolean;
+    boundComponentMessage?: string;
+}
+export declare type MountOptions = Partial<StyleOptions & MountReactComponentOptions>;
+export interface MountReactComponentOptions {
+    alias: string;
+    ReactDom: typeof import('react-dom');
+    /**
+     * Log the mounting command into Cypress Command Log,
+     * true by default.
+     */
+    log: boolean;
+    /**
+     * Render component in React [strict mode](https://reactjs.org/docs/strict-mode.html)
+     * It activates additional checks and warnings for child components.
+     */
+    strict: boolean;
+}
+export interface InternalMountOptions {
+    reactDom: typeof import('react-dom');
+    render: (reactComponent: ReturnType<typeof React.createElement>, el: HTMLElement, reactDomToUse: typeof import('react-dom')) => void;
+    unmount: (options: UnmountArgs) => void;
+    cleanup: () => boolean;
+}
+export interface MountReturn {
+    /**
+     * The component that was rendered.
+     */
+    component: React.ReactNode;
+    /**
+     * Rerenders the specified component with new props. This allows testing of components that store state (`setState`)
+     * or have asynchronous updates (`useEffect`, `useLayoutEffect`).
+     */
+    rerender: (component: React.ReactNode) => globalThis.Cypress.Chainable<MountReturn>;
+    /**
+     * Removes the mounted component.
+     * @see `unmount`
+     */
+    unmount: (payload: UnmountArgs) => void;
+}

package/react/package.json

@@ -14,17 +14,14 @@
     "test": "yarn cy:run",
     "watch": "yarn build --watch --watch.exclude ./dist/**/*"
   },
-  "dependencies": {
-    "debug": "^4.3.2"
-  },
   "devDependencies": {
     "@cypress/mount-utils": "0.0.0-development",
     "@rollup/plugin-commonjs": "^17.1.0",
     "@rollup/plugin-node-resolve": "^11.1.1",
+    "@types/semver": "7.3.9",
     "@vitejs/plugin-react": "1.3.1",
     "axios": "0.21.2",
     "cypress": "0.0.0-development",
-    "cypress-plugin-snapshots": "1.4.4",
     "prop-types": "15.7.2",
     "react": "16.8.6",
     "react-dom": "16.8.6",
@@ -32,8 +29,9 @@
     "react-router-dom": "6.0.0-alpha.1",
     "rollup": "^2.38.5",
     "rollup-plugin-typescript2": "^0.29.0",
+    "semver": "^7.3.2",
     "typescript": "^4.2.3",
-    "vite": "2.9.5",
+    "vite": "3.0.3",
     "vite-plugin-require-transform": "1.0.3"
   },
   "peerDependencies": {

package/react18/CHANGELOG.md

@@ -0,0 +1,6 @@
+# @cypress/react18-v1.0.0 (2022-08-11)
+
+
+### Features
+
+* React 18 support ([#22876](https://github.com/cypress-io/cypress/issues/22876)) ([f0d3a48](https://github.com/cypress-io/cypress/commit/f0d3a4867907bf6e60468510daa883ccc8dcfb63))