cypress-playwright-data-gen 1.0.4 → 1.0.6

package/README.md

@@ -1,9 +1,7 @@
-🧠 cypress-playwright-data-gen
-
+cypress-playwright-data-gen 🥰
 A lightweight fake data generator for Cypress and Playwright tests — create realistic test data like users, cards, institutions, and more in seconds!
 
-🚀 Installation
-
+🚀 Installation steps:
 Install using npm or yarn:
 
 npm install cypress-playwright-data-gen
@@ -12,9 +10,9 @@ or
 
 yarn add cypress-playwright-data-gen
 
+##############################################################################
 
-🧪 Usage
-In Cypress
+🧪 Usage In Cypress
 
 Add the commands in your cypress/support/e2e.js (or commands.js):
 
@@ -23,12 +21,128 @@ import 'cypress-playwright-data-gen/cypress/commands';
 
 Then you can use the custom commands anywhere in your tests:
 
-  it('should create fake user and card data', () => {
-    const user = cy.generateUser();
-    const card = cy.generateCard();
+describe('OrangeHRM Demo Login', () => {
+  beforeEach(() => {
+    cy.visit('https://opensource-demo.orangehrmlive.com/web/index.php/auth/login');
+  });
+
+
+  it('uses generated user data for a signup-style test', () => {
+    cy.generateUser().then((user) => {
+      /**
+       * Just an example — OrangeHRM doesn’t have public signup, so let’s imagine we were testing a form or registration flow:
+       */ 
+      cy.visit('https://example.com/register');
+      cy.get('#firstName').type(user.firstName);
+      cy.get('#lastName').type(user.lastName);
+      cy.get('#email').type(user.email);
+      cy.get('#password').type(user.password);
+      cy.get('#submit').click();
+      cy.log(`Generated user: ${user.firstName} ${user.lastName}, email: ${user.email}`);
+    });
+  });
+
+  it('generates card data for payment-related tests', () => {
+    cy.generateCard().then((card) => {
+      cy.log(`Card Number: ${card.number}`);
+      cy.log(`Expiry: ${card.expiryMonth}/${card.expiryYear}`);
+      cy.log(`CVV: ${card.cvv}`);
+    });
+  });
+});
+
+
+##############################################################################
 
-    cy.log(JSON.stringify(user));
-    cy.log(JSON.stringify(card));
+🧪 Usage In Playwright
+
+Import the utility functions in your test file (or a setup file):
+import { generateUser, generateCard, generateAddress, generateTransaction, generateInstitution } from 'cypress-playwright-data-gen/playwright/utils';
+
+
+Then you can use them anywhere in your Playwright tests:
+
+import { test, expect } from '@playwright/test';
+import { generateUser, generateCard } from 'cypress-playwright-data-gen/playwright/utils';
+
+test.describe('OrangeHRM Demo Login', () => {
+  test.beforeEach(async ({ page }) => {
+    await page.goto('https://opensource-demo.orangehrmlive.com/web/index.php/auth/login');
   });
 
+  test('uses generated user data for a signup-style test', async ({ page }) => {
+    const user = generateUser();
+
+    /**
+     * Just an example — OrangeHRM doesn’t have public signup,
+     * so let’s imagine we were testing a form or registration flow:
+     */
+    await page.goto('https://example.com/register');
+    await page.fill('#firstName', user.firstName);
+    await page.fill('#lastName', user.lastName);
+    await page.fill('#email', user.email);
+    await page.fill('#password', user.password);
+    await page.click('#submit');
+
+    console.log(`Generated user: ${user.firstName} ${user.lastName}, email: ${user.email}`);
+  });
+
+  test('generates card data for payment-related tests', async () => {
+    const card = generateCard();
+    console.log(`Card Number: ${card.number}`);
+    console.log(`Expiry: ${card.expiryMonth}/${card.expiryYear}`);
+    console.log(`CVV: ${card.cvv}`);
+  });
+});
+
+
+
+##############################################################################
+
+
+🧩 Available Generators & Their Attributes:
+
+🧍‍♂️generateUser()
+fullName
+firstName
+lastName
+username
+password
+userId
+avatar
+email
+phone
+address
+
+💳 generateCard()
+cardNumber
+cvv
+expiry
+
+🏠 generateAddress()
+street
+city
+state
+postalCode
+country
+
+🏦 generateInstitution()
+institutionId
+name
+type
+country
+branchCode
+contactEmail
+phone
+
+💰 generateTransaction()
+amount
+currency
+type
+date
+merchant
+transactionId
+status
+
+
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-playwright-data-gen",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "A simple Cypress & Playwright plugin for generating realistic test data using Faker.js.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,9 +13,17 @@
       "import": "./dist/cypress/commands.js",
       "require": "./dist/cypress/commands.js"
     },
+    "./cypress/commands": {
+      "import": "./dist/cypress/commands.js",
+      "require": "./dist/cypress/commands.js"
+    },
     "./playwright": {
       "import": "./dist/playwright/utils.js",
       "require": "./dist/playwright/utils.js"
+    },
+    "./playwright/utils": {
+      "import": "./dist/playwright/utils.js",
+      "require": "./dist/playwright/utils.js"
     }
   },
   "scripts": {