cypress 13.16.1 → 14.0.0

package/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/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"