Tests

.editorconfig

@@ -13,6 +13,7 @@ trim_trailing_whitespace = false
 
 [*.{yml,yaml}]
 indent_size = 2
+indent_style = space
 
 [*.{js,ts,mts,vue}]
 indent_size = 2

.github/workflows/cypress.yml

@@ -0,0 +1,58 @@
+name: Cypress Tests with Dependency and Artifact Caching
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  install:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build application
+        run: pnpm build
+
+      - name: Save build folder
+        uses: actions/upload-artifact@v4
+        with:
+          name: build
+          if-no-files-found: error
+          path: ./dist
+
+  cypress-run:
+    runs-on: ubuntu-22.04
+    needs: install
+    steps:
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download the build folder
+        uses: actions/download-artifact@v4
+        with:
+          name: build
+          path: ./dist
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Cypress run
+        uses: cypress-io/github-action@v6
+        with:
+          start: pnpm cy:run
+          component: true
+          browser: chrome

.gitignore

@@ -28,4 +28,11 @@ dist-ssr
 
 src/plugin/**/*.bk.*
 
+# Temp files and directories
+*__TEMP.*
+*__TEMP/
 
+# Cypress
+cypress/downloads
+cypress/screenshots
+cypress/videos

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 
-npx lint-staged && npm run test:build
+# npx lint-staged && npm run test:build
 npx lint-staged

cypress.config.ts

@@ -0,0 +1,26 @@
+import { defineConfig } from 'cypress';
+import customViteConfig from './vite.cypress.config';
+
+export default defineConfig({
+	e2e: {
+		setupNodeEvents(on, config) {
+			config.env = {
+				...process.env,
+				...config.env,
+			};
+			return config;
+		},
+		specPattern: './src/**/*.spec.cy.{js,jsx,ts,tsx}',
+	},
+
+	component: {
+		devServer: {
+			bundler: 'vite',
+			framework: 'vue',
+			viteConfig: customViteConfig,
+		},
+		specPattern: './src/**/*.cy.{js,jsx,ts,tsx}',
+		viewportHeight: 800,
+		viewportWidth: 1920,
+	},
+});

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/plugins/index.ts

@@ -0,0 +1,7 @@
+const path = require('path');
+const { startDevServer } = require('@cypress/vite-dev-server');
+
+module.exports = (on, config) => {
+	config.env.tsconfigPath = path.resolve(__dirname, '../../tsconfig.cypress.json'); // Adjust the path as needed
+	return config;
+};

cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

cypress/support/component-index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width,initial-scale=1.0">
+    <title>Components App</title>
+  </head>
+  <body>
+    <div data-cy-root></div>
+  </body>
+</html>

cypress/support/component.ts

@@ -0,0 +1,184 @@
+import './commands';
+import AppTemplate from '../templates/App.vue';
+import vuetify from "../../src/plugins/vuetify";
+import { h } from "vue";
+import { mount } from 'cypress/vue';
+import VStepperForm from '../../src/plugin/VStepperForm.vue';
+import * as DATA from '../templates/testData';
+import type { Component } from 'vue';
+import "cypress-real-events";
+
+
+// declare global {
+// 	namespace Cypress {
+// 		interface Chainable {
+// 			baseIconClass(icon: string): string;
+// 			getBaseStepperElements(excluded: string[]): Chainable;
+// 			getDataCy(value: string): Chainable<JQuery<HTMLElement>>;
+// 			mount: typeof mount;
+// 			mountComponent(options: any): Chainable;
+// 		}
+// 	}
+// }
+
+Cypress.Commands.add('mount', (component: Component, options: any = {}) => {
+	// Ensure global settings are defined
+	options.global = options.global || {};
+	options.global.stubs = options.global.stubs || {};
+	options.global.stubs['transition'] = false;
+	options.global.components = options.global.components || {};
+	options.global.plugins = options.global.plugins || [vuetify];
+
+	// Process slots to ensure they are functions
+	const slots = options.slots
+		? Object.fromEntries(
+			Object.entries(options.slots).map(([key, value]) => [
+				key,
+				// Convert strings or other non-function values into functions
+				typeof value === 'function'
+					? value
+					: () => (typeof value === 'string' ? h('div', value) : h(value as any)),
+			])
+		)
+		: {};
+
+	// Mount AppTemplate as the root and render `component` inside it
+	return mount(AppTemplate, {
+		...options,
+		slots: {
+			// Render the main component in the default slot of AppTemplate
+			default: () => h(component, options.props, slots),
+		},
+	}) as Cypress.Chainable;
+});
+
+
+Cypress.Commands.add('getDataCy', (name: string) => {
+	return cy.get(`[data-cy="${name}"]`);
+});
+
+const answers = {
+	buttonField: null,
+};
+
+const buttonField = DATA.buttonFieldOptions;
+
+const fieldDefault = {
+	label: 'Button Field Question',
+	name: 'buttonField',
+	options: buttonField.options.basic,
+	type: 'buttons' as const,
+};
+
+const globalOptions = {
+	validateOn: 'blur',
+};
+
+interface MountComponentOptions {
+	modelValue?: Record<string, any>;
+	field?: Partial<typeof fieldDefault>;
+	globalProps?: Record<string, any>;
+	stepperProps?: Record<string, any>;
+}
+
+Cypress.Commands.add('mountComponent', (options: MountComponentOptions = {}) => {
+	const { modelValue = {}, field = {}, globalProps = {}, stepperProps = {} } = options;
+
+	const localModelValue = { ...answers, ...modelValue };
+
+	return cy.then(() => {
+		cy.mount(VStepperForm as any, {
+			props: {
+				modelValue: localModelValue,
+				pages: [{ fields: [{ ...fieldDefault, ...field, }], }],
+				onSubmit: stepperProps.onSubmit ?? undefined,
+				validationSchema: stepperProps.validationSchema ?? undefined,
+				...stepperProps,
+			},
+			global: { provide: { globalOptions: { ...globalOptions, ...globalProps }, }, },
+		}).as('wrapper');
+	});
+});
+
+
+Cypress.Commands.add('getBaseStepperElements', (excluded = []) => {
+	// Stepper Form //
+	cy.get('[data-cy="vsf-stepper-form"]').as('stepperForm');
+	cy.get('@stepperForm')
+		.should('exist')
+		.and('be.visible');
+
+	// Stepper Header //
+	cy.getDataCy('vsf-stepper-header').as('stepperHeader');
+	cy.get('@stepperHeader')
+		.should('exist')
+		.and('be.visible');
+
+	cy.get('@stepperHeader')
+		.find('.v-stepper-item')
+		.as('stepperHeaderItems');
+
+	// Application Wrap //
+	cy.get('.v-application__wrap').as('appWrap');
+
+	// Submit Button //
+	if (!excluded.includes('buttonsField')) {
+		cy.getDataCy('vsf-submit-button')
+			.should('exist')
+			.and('be.visible');
+
+		// Field Group and Buttons //
+		cy.getDataCy('vsf-field-group-buttonField').as('fieldGroup');
+		cy.getDataCy('vsf-field-group-buttonField').find('button').as('fieldButtons');
+	}
+});
+
+cy.baseIconClass = (icon: string) => {
+	return icon.replace(/^mdi:/, '');
+};
+
+
+
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Navigation //
+Cypress.Commands.add('navigationMountComponent', (options = {}) => {
+	const { editable = true, jumpAhead = true, pages, validationSchema = undefined } = options || {};
+	const answers = DATA.navigationTest.answers;
+
+	cy.mount(VStepperForm as any, {
+		props: {
+			answers,
+			editable,
+			jumpAhead,
+			modelValue: answers,
+			pages,
+			validationSchema,
+		},
+		global: DATA.navigationTest.global,
+	});
+});
+
+Cypress.Commands.add('navigationGetButtons', () => {
+	cy.getBaseStepperElements(['buttonsField']);
+	cy.getDataCy('vsf-next-button').as('nextButton');
+	cy.getDataCy('vsf-previous-button').as('previousButton');
+});
+
+Cypress.Commands.add('checkedEnabledDisabledHeaderItems', ({ enabled, disabled, pages }) => {
+	pages.forEach((_, index) => {
+		if (enabled.includes(index)) {
+			cy.get('@stepperHeaderItems')
+				.eq(index)
+				.should('be.enabled');
+		}
+
+		if (disabled.includes(index)) {
+			cy.get('@stepperHeaderItems')
+				.eq(index)
+				.should('be.disabled');
+		}
+	});
+});
+
+cy.cloneArray = (array: any[]): any[] => {
+	return JSON.parse(JSON.stringify(array));
+};

cypress/support/e2e.ts

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')