create-appraisejs 0.1.9 → 0.1.10-alpha.1

package/templates/default/automation/steps/actions/wait.step.ts

@@ -0,0 +1,91 @@
+import { When, Then, CustomWorld, expect, SelectorName, resolveLocator, getEnvironment, generateRandomData, RandomDataType } from '../../../packages/cucumber-runtime/src/index.js'
+/**
+ * @name wait
+ * @description Template steps that handles waiting
+ * @type ACTION
+ */
+
+// This file is generated automatically. Add template steps to this group to generate content.
+
+/**
+ * @name wait for page load
+ * @description Template step for waiting till page becomes interactive
+ * @icon WAIT
+ */
+When('the user waits for the current page to be loaded', async function (this: CustomWorld) {
+  try {
+    await this.page.waitForLoadState('domcontentloaded')
+  } catch (error) {
+    throw new Error(`Failed to wait for the current page to be loaded: ${error}`)
+  }
+})
+
+/**
+ * @name wait for url route
+ * @description Template step for waiting for a url route to be loaded
+ * @icon WAIT
+ */
+When('the user waits for the route {string} to be loaded', async function (this: CustomWorld, routeName: string) {
+  try {
+    const baseUrl = getEnvironment(process.env.ENVIRONMENT as string).baseUrl
+    const sanitizedBaseUrl = baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl
+    const sanitizedRouteName = routeName.startsWith('/') ? routeName.slice(1) : routeName
+    const fullRoute = `${sanitizedBaseUrl}/${sanitizedRouteName}`
+    await this.page.waitForURL(fullRoute, { waitUntil: 'domcontentloaded' })
+  } catch (error) {
+    throw new Error(`Failed to wait for the route ${routeName} to be loaded: ${error}`)
+  }
+})
+
+/**
+ * @name wait for element
+ * @description Template step for waiting for element to become visible
+ * @icon WAIT
+ */
+When(
+  'the user waits for the element {string} to become visible',
+  async function (this: CustomWorld, elementName: SelectorName) {
+    try {
+      const selector = await resolveLocator(this.page, elementName)
+      if (!selector) {
+        throw new Error(`Selector ${elementName} not found`)
+      }
+      await this.page.waitForSelector(selector, { state: 'visible' })
+    } catch (error) {
+      throw new Error(`Failed to wait for the element ${elementName} to become visible: ${error}`)
+    }
+  },
+)
+
+/**
+ * @name wait for element to disappear
+ * @description Template step for waiting for an element to disappear from viewport
+ * @icon WAIT
+ */
+When(
+  'the user waits for the {string} element to disappear',
+  async function (this: CustomWorld, elementName: SelectorName) {
+    try {
+      const selector = await resolveLocator(this.page, elementName)
+      if (!selector) {
+        throw new Error(`Selector ${elementName} not found`)
+      }
+      await this.page.waitForSelector(selector, { state: 'hidden' })
+    } catch (error) {
+      throw new Error(`Failed to wait for the ${elementName} element to disappear: ${error}`)
+    }
+  },
+)
+
+/**
+ * @name wait for specific amount of seconds
+ * @description Template step for waiting for for an specific amount of seconds before proceeding with next action
+ * @icon WAIT
+ */
+When('the user waits for {int} seconds', async function (this: CustomWorld, waitTimeInSeconds: number) {
+  try {
+    await this.page.waitForTimeout(waitTimeInSeconds * 1000)
+  } catch (error) {
+    throw new Error(`Failed to wait for ${waitTimeInSeconds} seconds: ${error}`)
+  }
+})

package/templates/default/{src/tests → automation}/steps/validations/active_state_assertion.step.ts

@@ -1,12 +1,9 @@
+import { When, Then, CustomWorld, expect, SelectorName, resolveLocator, getEnvironment, generateRandomData, RandomDataType } from '../../../packages/cucumber-runtime/src/index.js'
 /**
  * @name active state assertion
  * @description Template steps for handling the validation of the active state of an element
  * @type VALIDATION
  */
-import { Then } from '@cucumber/cucumber'
-import { CustomWorld, expect } from '../../config/executor/world.js'
-import { SelectorName } from '@/types/locator/locator.type'
-import { resolveLocator } from '../../utils/locator.util.js'
 
 // This file is generated automatically. Add template steps to this group to generate content.
 

package/templates/default/{src/tests → automation}/steps/validations/navigation_assertion.step.ts

@@ -1,10 +1,9 @@
+import { When, Then, CustomWorld, expect, SelectorName, resolveLocator, getEnvironment, generateRandomData, RandomDataType } from '../../../packages/cucumber-runtime/src/index.js'
 /**
  * @name navigation assertion
  * @description Template steps that handles navigation validations
  * @type VALIDATION
  */
-import { Then } from '@cucumber/cucumber'
-import { CustomWorld, expect } from '../../config/executor/world.js'
 
 // This file is generated automatically. Add template steps to this group to generate content.
 

package/templates/default/{src/tests → automation}/steps/validations/text_assertion.step.ts

@@ -1,12 +1,9 @@
+import { When, Then, CustomWorld, expect, SelectorName, resolveLocator, getEnvironment, generateRandomData, RandomDataType } from '../../../packages/cucumber-runtime/src/index.js'
 /**
  * @name text assertion
  * @description Template steps for asserting text inside elements
  * @type VALIDATION
  */
-import { Then } from '@cucumber/cucumber';
-import { CustomWorld, expect } from '../../config/executor/world.js';
-import { SelectorName } from '@/types/locator/locator.type';
-import { resolveLocator } from '../../utils/locator.util.js';
 
 // This file is generated automatically. Add template steps to this group to generate content.
 

package/templates/default/{src/tests → automation}/steps/validations/visibility_assertion.step.ts

@@ -1,12 +1,9 @@
+import { When, Then, CustomWorld, expect, SelectorName, resolveLocator, getEnvironment, generateRandomData, RandomDataType } from '../../../packages/cucumber-runtime/src/index.js'
 /**
  * @name visibility assertion
  * @description Template steps that handles the assertion of element visibility states
  * @type VALIDATION
  */
-import { Then } from '@cucumber/cucumber'
-import { CustomWorld, expect } from '../../config/executor/world.js'
-import { SelectorName } from '@/types/locator/locator.type'
-import { resolveLocator } from '../../utils/locator.util.js'
 
 // This file is generated automatically. Add template steps to this group to generate content.
 

package/templates/default/cucumber.mjs

@@ -1,16 +1,16 @@
 // eslint-disable-next-line import/no-anonymous-default-export
 export default {
-  paths: ['src/tests/features/**/*.feature'],
+  paths: ['automation/features/**/*.feature'],
   import: [
-    'src/tests/support/parameter-types.ts',
-    'src/tests/steps/**/*.ts',
-    'src/tests/hooks/hooks.ts',
-    'src/tests/config/executor/world.ts',
+    'packages/cucumber-runtime/src/parameter-types.ts',
+    'automation/steps/**/*.ts',
+    'packages/cucumber-runtime/src/hooks.ts',
+    'packages/cucumber-runtime/src/world.ts',
   ],
   loader: ['ts-node/esm'],
   format: [
     'pretty',
-    process.env.REPORT_FORMAT ?? `json:${process.env.REPORT_PATH ?? 'src/tests/reports/cucumber.json'}`,
+    process.env.REPORT_FORMAT ?? `json:${process.env.REPORT_PATH ?? 'automation/reports/cucumber.json'}`,
   ],
   publishQuiet: true,
 }

package/templates/default/eslint.config.mjs

@@ -1,13 +1,14 @@
-import nextCoreWebVitals from "eslint-config-next/core-web-vitals";
-import nextTypescript from "eslint-config-next/typescript";
+import nextCoreWebVitals from 'eslint-config-next/core-web-vitals';
+import nextTypescript from 'eslint-config-next/typescript';
 
 const eslintConfig = [
   ...nextCoreWebVitals,
   ...nextTypescript,
   {
     ignores: [
-      "src/tests/steps/**/*.step.ts", // Exclude generated template step files
-      "src/tests/steps/**/*", // Exclude all files in steps directory
+      'automation/steps/**/*.step.ts',
+      'automation/steps/**/*',
+      'packages/cucumber-runtime/dist/**/*',
     ],
   },
 ];