@sridharkikkeri/playwright-common 1.0.14 → 1.0.17

package/create-healthedge-tests.js

@@ -9,9 +9,9 @@ const projectPath = path.join(process.cwd(), projectName);
 
 console.log(`\n🚀 Creating HealthEdge Playwright project: ${projectName}\n`);
 
-// Create project structure
+// Comprehensive Directory Structure
 const dirs = [
-  'src/core/api',
+  'src/core/api/auth',
   'src/core/config',
   'src/core/i18n',
   'src/core/pages',
@@ -38,11 +38,11 @@ dirs.forEach(idr => {
   fs.mkdirSync(path.join(projectPath, idr), { recursive: true });
 });
 
-// package.json
+// package.json for the NEW project
 const packageJson = {
   name: projectName,
   version: '1.0.0',
-  description: 'HealthEdge Playwright Test Project',
+  description: 'HealthEdge Enterprise Playwright Test Project',
   scripts: {
     'test': 'playwright test',
     'test:dev': 'TEST_ENV=dev playwright test',
@@ -50,12 +50,13 @@ const packageJson = {
     'test:auto': 'TEST_ENV=auto playwright test',
     'test:staging': 'TEST_ENV=staging playwright test',
     'test:prod': 'TEST_ENV=prod playwright test',
+    'test:visual': 'playwright test src/tests/visual.spec.ts',
     'report': 'allure generate allure-results --clean -o allure-report && allure open allure-report',
     'lint': 'eslint .',
     'lint:fix': 'eslint . --fix'
   },
   dependencies: {
-    '@sridharkikkeri/playwright-common': '^1.0.14',
+    '@sridharkikkeri/playwright-common': '^1.0.17',
     '@playwright/test': '^1.42.0',
     'allure-playwright': '^3.4.5'
   },
@@ -69,27 +70,48 @@ const packageJson = {
 
 fs.writeFileSync(path.join(projectPath, 'package.json'), JSON.stringify(packageJson, null, 2));
 
-// --- CORE BOILERPLATE FILES ---
+// --- CORE EXTENSION BOILERPLATE ---
 
 const baseApiClientTs = `import { ApiClient } from '@sridharkikkeri/playwright-common';
 
-/**
- * Project-specific Base API Client.
- */
 export class BaseApiClient extends ApiClient {
     constructor(baseUrl: string) {
         super(baseUrl);
     }
+    // Add shared project-specific headers or logic here
 }
 `;
 fs.writeFileSync(path.join(projectPath, 'src/core/api/BaseApiClient.ts'), baseApiClientTs);
 
+const projectAuthTs = `import { CookieAuth, AuthStrategy } from '@sridharkikkeri/playwright-common';
+
+export class ProjectAuth {
+    static async setupSession(auth: AuthStrategy) {
+        // Implement custom complex auth setup if needed
+    }
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/api/auth/ProjectAuth.ts'), projectAuthTs);
+
+const envConfigTs = `import { ConfigManager } from '@sridharkikkeri/playwright-common';
+
+export class ProjectConfig extends ConfigManager {
+    static getClientName() { return 'HealthEdge'; }
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/config/ProjectConfig.ts'), envConfigTs);
+
+const localizationTs = `import { Localization } from '@sridharkikkeri/playwright-common';
+
+export class ProjectLocalization extends Localization {
+    static getAvailableLocales() { return ['en', 'fr']; }
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/i18n/ProjectLocalization.ts'), localizationTs);
+
 const baseComponentTs = `import { Page } from '@playwright/test';
 import { BasePage, ActionOrchestrator } from '@sridharkikkeri/playwright-common';
 
-/**
- * Base Component for project-specific reusable UI elements.
- */
 export abstract class BaseComponent extends BasePage {
     constructor(page: Page, orchestrator?: ActionOrchestrator) {
         super(page, { pageName: 'BaseComponent', orchestrator });
@@ -98,52 +120,92 @@ export abstract class BaseComponent extends BasePage {
 `;
 fs.writeFileSync(path.join(projectPath, 'src/core/pages/BaseComponent.ts'), baseComponentTs);
 
-const projectUtilsTs = `/**
- * Shared utility functions for this specific test project.
- */
-export class ProjectUtils {
-    static async sleep(ms: number) {
-        return new Promise(resolve => setTimeout(resolve, ms));
+const reporterTs = `import { AllureUtil } from '@sridharkikkeri/playwright-common';
+
+export class ProjectReporter {
+    static async logEnterpriseStep(name: string) {
+        console.log(\`[ENTERPRISE] \${name}\`);
     }
 }
 `;
+fs.writeFileSync(path.join(projectPath, 'src/core/reporting/ProjectReporter.ts'), reporterTs);
+
+const healingTs = `import { LocatorHealing } from '@sridharkikkeri/playwright-common';
+
+export class ProjectHealer extends LocatorHealing {
+    // Override framework healing logic here
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/selfhealing/ProjectHealer.ts'), healingTs);
+
+const visualTs = `import { VisualTesting } from '@sridharkikkeri/playwright-common';
+
+export class ProjectVisuals extends VisualTesting {
+    // Custom exclusions or thresholds
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/visual/ProjectVisuals.ts'), visualTs);
+
+const wrapperTs = `import { ElementWrapper } from '@sridharkikkeri/playwright-common';
+
+export class ProjectElement extends ElementWrapper {
+    // Extend element behaviors (e.g., custom scrolls)
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/wrappers/ProjectElement.ts'), wrapperTs);
+
+const projectUtilsTs = `export class ProjectUtils {
+    static generateRandomID() { return Math.random().toString(36).substring(7); }
+}
+`;
 fs.writeFileSync(path.join(projectPath, 'src/core/utils/ProjectUtils.ts'), projectUtilsTs);
 
-// --- CONFIGURATION ---
+// --- UTILS & I18N POPULATION ---
+const stringUtilsTs = `export class StringUtils {
+    static capitalize(str: string) { return str.charAt(0).toUpperCase() + str.slice(1); }
+}`;
+fs.writeFileSync(path.join(projectPath, 'src/utils/StringUtils.ts'), stringUtilsTs);
+
+const dateUtilsTs = `export class DateUtils {
+    static now() { return new Date().toISOString(); }
+}`;
+fs.writeFileSync(path.join(projectPath, 'src/utils/DateUtils.ts'), dateUtilsTs);
+
+fs.writeFileSync(path.join(projectPath, 'src/i18n/en.json'), JSON.stringify({ "welcome": "Welcome to HealthEdge" }, null, 2));
+fs.writeFileSync(path.join(projectPath, 'src/i18n/fr.json'), JSON.stringify({ "welcome": "Bienvenue chez HealthEdge" }, null, 2));
+
+// --- DOCUMENTATION ---
+fs.writeFileSync(path.join(projectPath, 'api-docs/assets/style.css'), 'body { font-family: sans-serif; padding: 20px; }');
+fs.writeFileSync(path.join(projectPath, 'api-docs/index.html'), `
+<html>
+<head><link rel="stylesheet" href="assets/style.css"></head>
+<body>
+    <h1>${projectName} - API Documentation</h1>
+    <p>This folder is ready to host your TypeDoc or custom API documentation.</p>
+</body>
+</html>`);
+['classes', 'interfaces', 'types', 'variables'].forEach(fold => {
+  fs.writeFileSync(path.join(projectPath, `api-docs/${fold}/README.md`), `# ${fold}\nDocumentation for your project ${fold} goes here.`);
+});
+
+// --- STANDARD CONFIG & EXAMPLES ---
 const baseConfig = { healingEnabled: true, environment: 'dev', baseUrl: 'https://example.com', apiUrl: 'https://api.example.com', timeout: 30000, retries: 2 };
 const environments = ['dev', 'qa', 'auto', 'staging', 'prod'];
-
 environments.forEach(env => {
-  const config = {
-    ...baseConfig,
-    environment: env,
-    baseUrl: `https://${env}.example.com`,
-    apiUrl: `https://api-${env}.example.com`
-  };
+  const config = { ...baseConfig, environment: env, baseUrl: `https://${env}.example.com`, apiUrl: `https://api-${env}.example.com` };
   fs.writeFileSync(path.join(projectPath, `framework.config.${env}.json`), JSON.stringify(config, null, 2));
 });
 fs.writeFileSync(path.join(projectPath, 'framework.config.json'), JSON.stringify(baseConfig, null, 2));
 
-// playwright.config.ts
 const playwrightConfig = `import { defineConfig } from '@playwright/test';
-
 export default defineConfig({
   testDir: './src/tests',
   timeout: 30000,
-  retries: process.env.CI ? 2 : 0,
-  workers: process.env.CI ? 1 : undefined,
-  reporter: [
-    ['html'], 
-    ['allure-playwright', { outputFolder: 'allure-results' }]
-  ],
-  use: { 
-    trace: 'on-first-retry', 
-    screenshot: 'only-on-failure' 
-  }
+  reporter: [['html'], ['allure-playwright', { outputFolder: 'allure-results' }]],
+  use: { trace: 'on-first-retry', screenshot: 'only-on-failure' }
 });`;
 fs.writeFileSync(path.join(projectPath, 'playwright.config.ts'), playwrightConfig);
 
-// src/fixtures/fixtures.ts
 const fixturesTs = `import { test as base } from '@sridharkikkeri/playwright-common';
 import { HomePage } from '../pages/HomePage';
 
@@ -156,7 +218,6 @@ export const test = base.extend<{ homePage: HomePage }>({
 export { expect } from '@playwright/test';`;
 fs.writeFileSync(path.join(projectPath, 'src/fixtures/fixtures.ts'), fixturesTs);
 
-// Sample Page Object
 const samplePage = `import { Page } from '@playwright/test';
 import { BasePage, ActionOrchestrator } from '@sridharkikkeri/playwright-common';
 
@@ -164,33 +225,33 @@ export class HomePage extends BasePage {
   constructor(page: Page, orchestrator?: ActionOrchestrator) { 
     super(page, { pageName: 'HomePage', orchestrator }); 
   }
-
-  private readonly searchInput = this.element('[data-testid="search"]');
   private readonly searchBtn = this.element('button[type="submit"]');
-
-  async search(query: string) {
-    await this.searchInput.fill(query, 'Enter search query');
-    await this.searchBtn.click('Click search button');
-  }
+  async clickSearch() { await this.searchBtn.click('Click Search Button'); }
 }
 `;
 fs.writeFileSync(path.join(projectPath, 'src/pages/HomePage.ts'), samplePage);
 
-// Sample Test
+const visualTest = `import { test, expect } from '../fixtures/fixtures';
+
+test.describe('Enterprise Visual Regression', () => {
+    test('HP Visual Verification', async ({ page }) => {
+        await page.goto('https://playwright.dev');
+        await expect(page).toHaveScreenshot('homepage.png', {
+            mask: [page.locator('.navbar')],
+            threshold: 0.1
+        });
+    });
+});`;
+fs.writeFileSync(path.join(projectPath, 'src/tests/visual.spec.ts'), visualTest);
+
 const sampleTest = `import { test, expect } from '../fixtures/fixtures';
 
-test.describe('HealthEdge Framework Demo', () => {
-  test('Search functionality with Fixtures', async ({ page, homePage }) => {
-    await page.goto('https://playwright.dev');
-    await homePage.search('playwright');
-    await expect(page).toHaveTitle(/Playwright/);
-  });
+test('Standard Smoke Test', async ({ page }) => {
+  await page.goto('https://playwright.dev');
+  await expect(page).toHaveTitle(/Playwright/);
 });`;
 fs.writeFileSync(path.join(projectPath, 'src/tests/sample.spec.ts'), sampleTest);
 
-const sampleI18n = { "login_welcome": "Welcome to HealthEdge" };
-fs.writeFileSync(path.join(projectPath, 'src/i18n/en.json'), JSON.stringify(sampleI18n, null, 2));
-
 const tsConfig = {
   compilerOptions: {
     target: 'ES2020',
@@ -199,7 +260,6 @@ const tsConfig = {
     strict: true,
     esModuleInterop: true,
     skipLibCheck: true,
-    forceConsistentCasingInFileNames: true,
     resolveJsonModule: true
   },
   include: ['src/**/*']
@@ -213,19 +273,36 @@ test-results/
 playwright-report/
 .env
 *.log
+dist/
 `;
 fs.writeFileSync(path.join(projectPath, '.gitignore'), gitignore);
 
-console.log('✅ Project structure created');
+const readme = `# ${projectName}
+
+## Overview
+Enterprise automation test project powered by **@sridharkikkeri/playwright-common**.
+
+## Getting Started
+\`\`\`bash
+npm install
+npm run test:dev
+\`\`\`
+
+## Features
+- **Self-Healing**: Enabled by default
+- **Visual Regression**: \`npm run test:visual\`
+- **Enterprise Reporting**: Allure integration
+`;
+fs.writeFileSync(path.join(projectPath, 'README.md'), readme);
+
+console.log('✅ Comprehensive Project Structure Created');
 console.log('\n📦 Installing dependencies...\n');
 
 try {
   execSync('npm install', { cwd: projectPath, stdio: 'inherit' });
   console.log('\n✅ Dependencies installed');
 } catch (error) {
-  console.log('\n⚠️  Run "npm install" manually in the project directory');
+  console.log('\n⚠️ npm install failed. Please run manually.');
 }
 
-console.log(`\n🎉 Project ready! Next steps:\n`);
-console.log(`   cd ${projectName}`);
-console.log(`   npm run test:dev\n`);
+console.log(`\n🎉 Project ready! cd ${projectName} and try: npm run test:dev\n`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sridharkikkeri/playwright-common",
-  "version": "1.0.14",
+  "version": "1.0.17",
   "description": "Production-grade Playwright framework with AI-powered self-healing, visual regression, and enterprise features",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",