cypress 13.16.1 → 14.0.0

package/vue/vue/dist/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="cypress" />
 
 import * as vue from 'vue';
-import { ComponentInternalInstance, FunctionalComponent, ComponentOptions, Component, Directive, Plugin as Plugin$1, AppConfig, VNode, VNodeProps, ComponentPublicInstance, ComputedOptions, MethodOptions, CreateComponentPublicInstance, ComponentCustomProperties, App, ConcreteComponent, Prop, EmitsOptions, ComponentOptionsMixin, ExtractPropTypes, ExtractDefaultPropTypes, DefineComponent, ComponentOptionsWithoutProps, ComponentOptionsWithArrayProps, ComponentPropsOptions, ComponentOptionsWithObjectProps, AllowedComponentProps, ComponentCustomProps } from 'vue';
+import { ComponentInternalInstance, FunctionalComponent, ComponentOptions, Component, Directive, Plugin as Plugin$1, AppConfig, VNode, VNodeProps, ComponentPublicInstance, ComputedOptions, MethodOptions, CreateComponentPublicInstance, App, ConcreteComponent, DefineComponent, Prop, EmitsOptions, ComponentOptionsMixin, ExtractPropTypes, ExtractDefaultPropTypes, ComponentOptionsWithoutProps, ComponentOptionsWithArrayProps, ComponentPropsOptions, ComponentOptionsWithObjectProps, AllowedComponentProps, ComponentCustomProps } from 'vue';
 
 interface RefSelector {
     ref: string;
@@ -22,7 +22,7 @@ type RawProps = VNodeProps & {
     __v_isVNode?: never;
     [Symbol.iterator]?: never;
 } & Record<string, any>;
-interface MountingOptions$1<Props, Data = {}> {
+interface BaseMountingOptions<Props, Data = {}> {
     /**
      * Overrides component's default data. Must be a function.
      * @see https://test-utils.vuejs.org/api/#data
@@ -53,18 +53,32 @@ interface MountingOptions$1<Props, Data = {}> {
      * Provides global mounting options to the component.
      */
     global?: GlobalMountOptions$1;
+    /**
+     * Automatically stub out all the child components.
+     * @default false
+     * @see https://test-utils.vuejs.org/api/#slots
+     */
+    shallow?: boolean;
+}
+/**
+ * Mounting options for `mount` and `shallowMount`
+ */
+interface MountingOptions$1<Props, Data = {}> extends BaseMountingOptions<Props, Data> {
     /**
      * Specify where to mount the component.
      * Can be a valid CSS selector, or an Element connected to the document.
      * @see https://test-utils.vuejs.org/api/#attachto
      */
-    attachTo?: HTMLElement | string;
+    attachTo?: Element | string;
+}
+/**
+ * Mounting options for `renderToString`
+ */
+interface RenderMountingOptions<Props, Data = {}> extends BaseMountingOptions<Props, Data> {
     /**
-     * Automatically stub out all the child components.
-     * @default false
-     * @see https://test-utils.vuejs.org/api/#slots
+     * Attach to is not available in SSR mode
      */
-    shallow?: boolean;
+    attachTo?: never;
 }
 type Stub = boolean | Component | Directive;
 type Stubs = Record<string, Stub> | Array<string>;
@@ -1150,9 +1164,7 @@ declare abstract class BaseWrapper<ElementType extends Node> implements WrapperL
     trigger(eventString: string, options?: TriggerOptions): Promise<void>;
 }
 
-declare class VueWrapper<T extends Omit<ComponentPublicInstance, '$emit' | keyof ComponentCustomProperties> & {
-    $emit: (event: any, ...args: any[]) => void;
-} & ComponentCustomProperties = ComponentPublicInstance> extends BaseWrapper<Node> {
+declare class VueWrapper<VM = unknown, T extends ComponentPublicInstance = VM & ComponentPublicInstance> extends BaseWrapper<Node> {
     private readonly componentVM;
     private readonly rootVM;
     private readonly __app;
@@ -1168,17 +1180,15 @@ declare class VueWrapper<T extends Omit<ComponentPublicInstance, '$emit' | keyof
     findAll<K extends keyof SVGElementTagNameMap>(selector: K): DOMWrapper<SVGElementTagNameMap[K]>[];
     findAll<T extends Element>(selector: string): DOMWrapper<T>[];
     private attachNativeEventListener;
-    get element(): Element;
+    get element(): T['$el'];
     get vm(): T;
-    props(): {
-        [key: string]: any;
-    };
-    props(selector: string): any;
+    props(): T['$props'];
+    props<Selector extends keyof T['$props']>(selector: Selector): T['$props'][Selector];
     emitted<T = unknown>(): Record<string, T[]>;
     emitted<T = unknown[]>(eventName: string): undefined | T[];
     isVisible(): boolean;
     setData(data: Record<string, unknown>): Promise<void>;
-    setProps(props: Record<string, unknown>): Promise<void>;
+    setProps(props: Partial<T['$props']>): Promise<void>;
     setValue(value: unknown, prop?: string): Promise<void>;
     unmount(): void;
 }
@@ -1186,6 +1196,10 @@ declare class VueWrapper<T extends Omit<ComponentPublicInstance, '$emit' | keyof
 type CustomCreateStub = (params: {
     name: string;
     component: ConcreteComponent;
+    registerStub: (config: {
+        source: Component;
+        stub: Component;
+    }) => void;
 }) => ConcreteComponent;
 
 interface GlobalConfigOptions {
@@ -1216,36 +1230,35 @@ declare class Pluggable<Instance = DOMWrapper<Node>> {
     reset(): void;
 }
 
-type PublicProps$1 = VNodeProps & AllowedComponentProps & ComponentCustomProps;
-type ComponentMountingOptions$1<T> = T extends DefineComponent<infer PropsOrPropOptions, any, infer D, any, any> ? MountingOptions$1<Partial<ExtractDefaultPropTypes<PropsOrPropOptions>> & Omit<Readonly<ExtractPropTypes<PropsOrPropOptions>> & PublicProps$1, keyof ExtractDefaultPropTypes<PropsOrPropOptions>>, D> & Record<string, any> : MountingOptions$1<any>;
-declare function renderToString<V extends {}>(originalComponent: {
-    new (...args: any[]): V;
-    __vccOpts: any;
-}, options?: MountingOptions$1<any> & Record<string, any>): Promise<string>;
-declare function renderToString<V extends {}, P>(originalComponent: {
-    new (...args: any[]): V;
-    __vccOpts: any;
-    defaultProps?: Record<string, Prop<any>> | string[];
-}, options?: MountingOptions$1<P & PublicProps$1> & Record<string, any>): Promise<string>;
-declare function renderToString<V extends {}>(originalComponent: {
-    new (...args: any[]): V;
-    registerHooks(keys: string[]): void;
-}, options?: MountingOptions$1<any> & Record<string, any>): Promise<string>;
-declare function renderToString<V extends {}, P>(originalComponent: {
-    new (...args: any[]): V;
-    props(Props: P): any;
-    registerHooks(keys: string[]): void;
-}, options?: MountingOptions$1<P & PublicProps$1> & Record<string, any>): Promise<string>;
-declare function renderToString<Props extends {}, E extends EmitsOptions = {}>(originalComponent: FunctionalComponent<Props, E>, options?: MountingOptions$1<Props & PublicProps$1> & Record<string, any>): Promise<string>;
-declare function renderToString<PropsOrPropOptions = {}, RawBindings = {}, D = {}, C extends ComputedOptions = ComputedOptions, M extends MethodOptions = MethodOptions, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = Record<string, any>, EE extends string = string, PP = PublicProps$1, Props = Readonly<ExtractPropTypes<PropsOrPropOptions>>, Defaults extends {} = ExtractDefaultPropTypes<PropsOrPropOptions>>(component: DefineComponent<PropsOrPropOptions, RawBindings, D, C, M, Mixin, Extends, E, EE, PP, Props, Defaults>, options?: MountingOptions$1<Partial<Defaults> & Omit<Props & PublicProps$1, keyof Defaults>, D> & Record<string, any>): Promise<string>;
-declare function renderToString<T extends DefineComponent<any, any, any, any, any>>(component: T, options?: ComponentMountingOptions$1<T>): Promise<string>;
-declare function renderToString<Props = {}, RawBindings = {}, D extends {} = {}, C extends ComputedOptions = {}, M extends Record<string, Function> = {}, E extends EmitsOptions = Record<string, any>, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, EE extends string = string>(componentOptions: ComponentOptionsWithoutProps<Props, RawBindings, D, C, M, E, Mixin, Extends, EE>, options?: MountingOptions$1<Props & PublicProps$1, D>): Promise<string>;
-declare function renderToString<PropNames extends string, RawBindings, D extends {}, C extends ComputedOptions = {}, M extends Record<string, Function> = {}, E extends EmitsOptions = Record<string, any>, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, EE extends string = string, Props extends Readonly<{
-    [key in PropNames]?: any;
-}> = Readonly<{
-    [key in PropNames]?: any;
-}>>(componentOptions: ComponentOptionsWithArrayProps<PropNames, RawBindings, D, C, M, E, Mixin, Extends, EE, Props>, options?: MountingOptions$1<Props & PublicProps$1, D>): Promise<string>;
-declare function renderToString<PropsOptions extends Readonly<ComponentPropsOptions>, RawBindings, D extends {}, C extends ComputedOptions = {}, M extends Record<string, Function> = {}, E extends EmitsOptions = Record<string, any>, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, EE extends string = string>(componentOptions: ComponentOptionsWithObjectProps<PropsOptions, RawBindings, D, C, M, E, Mixin, Extends, EE>, options?: MountingOptions$1<ExtractPropTypes<PropsOptions> & PublicProps$1, D>): Promise<string>;
+type ComponentProps<T> = T extends new (...args: any) => {
+    $props: infer P;
+} ? NonNullable<P> : T extends (props: infer P, ...args: any) => any ? P : {};
+type ComponentSlots<T> = T extends new (...args: any) => {
+    $slots: infer S;
+} ? NonNullable<S> : T extends (props: any, ctx: {
+    slots: infer S;
+    attrs: any;
+    emit: any;
+}, ...args: any) => any ? NonNullable<S> : {};
+
+type ShimSlotReturnType<T> = T extends (...args: infer P) => any ? (...args: P) => any : never;
+type WithArray<T> = T | T[];
+type ComponentData<T> = T extends {
+    data?(...args: any): infer D;
+} ? D : {};
+type ComponentMountingOptions$1<T, P extends ComponentProps<T> = ComponentProps<T>> = Omit<MountingOptions$1<P, ComponentData<T>>, 'slots'> & {
+    slots?: {
+        [K in keyof ComponentSlots<T>]: WithArray<ShimSlotReturnType<ComponentSlots<T>[K]> | string | VNode | (new () => any) | {
+            template: string;
+        }>;
+    };
+} & Record<string, unknown>;
+
+declare function renderToString<T, C = T extends ((...args: any) => any) | (new (...args: any) => any) ? T : T extends {
+    props?: infer Props;
+} ? DefineComponent<Props extends Readonly<(infer PropNames)[]> | (infer PropNames)[] ? {
+    [key in PropNames extends string ? PropNames : string]?: any;
+} : Props> : DefineComponent>(originalComponent: T, options?: ComponentMountingOptions$1<C> & Pick<RenderMountingOptions<any>, 'attachTo'>): Promise<string>;
 
 declare function createWrapperError<T extends object>(wrapperType: 'DOMWrapper' | 'VueWrapper'): T;
 
@@ -1258,27 +1271,7 @@ declare const VueTestUtils: {
     renderToString: typeof renderToString;
     enableAutoUnmount: typeof enableAutoUnmount;
     disableAutoUnmount: typeof disableAutoUnmount;
-    RouterLinkStub: DefineComponent<{
-        to: {
-            type: (ObjectConstructor | StringConstructor)[];
-            required: true;
-        };
-        custom: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-    }, unknown, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
-        to: {
-            type: (ObjectConstructor | StringConstructor)[];
-            required: true;
-        };
-        custom: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-    }>>, {
-        custom: boolean;
-    }>;
+    RouterLinkStub: any;
     VueWrapper: typeof VueWrapper;
     DOMWrapper: typeof DOMWrapper;
     BaseWrapper: typeof BaseWrapper;
@@ -1378,15 +1371,5 @@ declare function mount<PropsOptions extends Readonly<ComponentPropsOptions>, Raw
     wrapper: VueWrapper<ComponentPublicInstance<ExtractPropTypes<PropsOptions>, RawBindings, D, C, M, E, VNodeProps & ExtractPropTypes<PropsOptions>>>;
     component: VueWrapper<ComponentPublicInstance<ExtractPropTypes<PropsOptions>, RawBindings, D, C, M, E, VNodeProps & ExtractPropTypes<PropsOptions>>>['vm'];
 }>;
-/**
- * Helper function for mounting a component quickly in test hooks.
- * @example
- *  import {mountCallback} from '@cypress/vue'
- *  beforeEach(mountVue(component, options))
- *
- * Removed as of Cypress 11.0.0.
- * @see https://on.cypress.io/migration-11-0-0-component-testing-updates
- */
-declare function mountCallback(component: any, options?: any): () => void;
 
-export { CyMountOptions, VueTestUtils, mount, mountCallback };
+export { CyMountOptions, VueTestUtils, mount };

package/vue/vue/package.json

@@ -18,7 +18,7 @@
     "@cypress/mount-utils": "0.0.0-development",
     "@vitejs/plugin-vue": "5.0.4",
     "@vue/compiler-sfc": "3.2.47",
-    "@vue/test-utils": "2.3.2",
+    "@vue/test-utils": "2.4.6",
     "axios": "0.21.2",
     "cypress": "0.0.0-development",
     "debug": "^4.3.4",
@@ -42,7 +42,7 @@
     "src/**/*.js"
   ],
   "engines": {
-    "node": ">=8"
+    "node": ">=18"
   },
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -82,9 +82,6 @@
   "nx": {
     "targets": {
       "build": {
-        "dependsOn": [
-          "!@cypress/react18:build"
-        ],
         "outputs": [
           "{workspaceRoot}/cli/vue",
           "{projectRoot}/dist"

package/angular-signals/README.md

@@ -1,11 +0,0 @@
-# @cypress/angular-signals
-
-Mount Angular components in the open source [Cypress.io](https://www.cypress.io/) test runner. This package is an extension of `@cypress/angular`, but with [signals](https://angular.dev/guide/signals) support.
-
-> **Note:** This package is bundled with the `cypress` package and should not need to be installed separately. See the [Angular Component Testing Docs](https://docs.cypress.io/guides/component-testing/angular/overview) for mounting Angular components. Installing and importing `mount` from `@cypress/angular-signals` should only be done for advanced use-cases.
-
-## Development
-
-Run `yarn build` to compile and sync packages to the `cypress` cli package.
-
-## [Changelog](./CHANGELOG.md)

package/angular-signals/angular-signals/README.md

@@ -1,11 +0,0 @@
-# @cypress/angular-signals
-
-Mount Angular components in the open source [Cypress.io](https://www.cypress.io/) test runner. This package is an extension of `@cypress/angular`, but with [signals](https://angular.dev/guide/signals) support.
-
-> **Note:** This package is bundled with the `cypress` package and should not need to be installed separately. See the [Angular Component Testing Docs](https://docs.cypress.io/guides/component-testing/angular/overview) for mounting Angular components. Installing and importing `mount` from `@cypress/angular-signals` should only be done for advanced use-cases.
-
-## Development
-
-Run `yarn build` to compile and sync packages to the `cypress` cli package.
-
-## [Changelog](./CHANGELOG.md)

package/angular-signals/angular-signals/dist/index.d.ts

@@ -1,136 +0,0 @@
-/// <reference types="cypress" />
-
-import { InputSignal, WritableSignal, Type } from '@angular/core';
-import { TestModuleMetadata, ComponentFixture, TestComponentRenderer } from '@angular/core/testing';
-
-/**
- * Additional module configurations needed while mounting the component, like
- * providers, declarations, imports and even component @Inputs()
- *
- * @interface MountConfig
- * @see https://angular.io/api/core/testing/TestModuleMetadata
- */
-interface MountConfig<T> extends TestModuleMetadata {
-    /**
-     * @memberof MountConfig
-     * @description flag to automatically create a cy.spy() for every component @Output() property
-     * @example
-     * export class ButtonComponent {
-     *  @Output clicked = new EventEmitter()
-     * }
-     *
-     * cy.mount(ButtonComponent, { autoSpyOutputs: true })
-     * cy.get('@clickedSpy).should('have.been.called')
-     */
-    autoSpyOutputs?: boolean;
-    /**
-     * @memberof MountConfig
-     * @description flag defaulted to true to automatically detect changes in your components
-     */
-    autoDetectChanges?: boolean;
-    /**
-     * @memberof MountConfig
-     * @example
-     * import { ButtonComponent } from 'button/button.component'
-     * it('renders a button with Save text', () => {
-     *  cy.mount(ButtonComponent, { componentProperties: { text: 'Save' }})
-     *  cy.get('button').contains('Save')
-     * })
-     *
-     * it('renders a button with a cy.spy() replacing EventEmitter', () => {
-     *  cy.mount(ButtonComponent, {
-     *    componentProperties: {
-     *      clicked: cy.spy().as('mySpy)
-     *    }
-     *  })
-     *  cy.get('button').click()
-     *  cy.get('@mySpy').should('have.been.called')
-     * })
-     */
-    componentProperties?: Partial<{
-        [P in keyof T]: T[P] extends InputSignal<infer V> ? InputSignal<V> | WritableSignal<V> | V : T[P];
-    }>;
-}
-/**
- * Type that the `mount` function returns
- * @type MountResponse<T>
- */
-type MountResponse<T> = {
-    /**
-     * Fixture for debugging and testing a component.
-     *
-     * @memberof MountResponse
-     * @see https://angular.io/api/core/testing/ComponentFixture
-     */
-    fixture: ComponentFixture<T>;
-    /**
-     * The instance of the root component class
-     *
-     * @memberof MountResponse
-     * @see https://angular.io/api/core/testing/ComponentFixture#componentInstance
-     */
-    component: T;
-};
-declare class CypressTestComponentRenderer extends TestComponentRenderer {
-    insertRootElement(rootElId: string): void;
-    removeAllRootElements(): void;
-}
-/**
- * Mounts an Angular component inside Cypress browser
- *
- * @param component Angular component being mounted or its template
- * @param config configuration used to configure the TestBed
- * @example
- * import { mount } from '@cypress/angular-signals'
- * import { StepperComponent } from './stepper.component'
- * import { MyService } from 'services/my.service'
- * import { SharedModule } from 'shared/shared.module';
- * it('mounts', () => {
- *    mount(StepperComponent, {
- *      providers: [MyService],
- *      imports: [SharedModule]
- *    })
- *    cy.get('[data-cy=increment]').click()
- *    cy.get('[data-cy=counter]').should('have.text', '1')
- * })
- *
- * // or
- *
- * it('mounts with template', () => {
- *   mount('<app-stepper></app-stepper>', {
- *     declarations: [StepperComponent],
- *   })
- * })
- *
- * @see {@link https://on.cypress.io/mounting-angular} for more details.
- *
- * @returns A component and component fixture
- */
-declare function mount<T>(component: Type<T> | string, config?: MountConfig<T>): Cypress.Chainable<MountResponse<T>>;
-/**
- * Creates a new Event Emitter and then spies on it's `emit` method
- *
- * @param {string} alias name you want to use for your cy.spy() alias
- * @returns EventEmitter<T>
- * @example
- * import { StepperComponent } from './stepper.component'
- * import { mount, createOutputSpy } from '@cypress/angular-signals'
- *
- * it('Has spy', () => {
- *   mount(StepperComponent, { componentProperties: { change: createOutputSpy('changeSpy') } })
- *   cy.get('[data-cy=increment]').click()
- *   cy.get('@changeSpy').should('have.been.called')
- * })
- *
- * // Or for use with Angular Signals following the output nomenclature.
- * // see https://v17.angular.io/guide/model-inputs#differences-between-model-and-input/
- *
- * it('Has spy', () => {
- *   mount(StepperComponent, { componentProperties: { count: signal(0), countChange: createOutputSpy('countChange') } })
- *   cy.get('[data-cy=increment]').click()
- *   cy.get('@countChange').should('have.been.called')
- * })
- */
-declare const createOutputSpy: <T>(alias: string) => any;
-
-export { CypressTestComponentRenderer, MountConfig, MountResponse, createOutputSpy, mount };