@sridharkikkeri/playwright-common 1.0.21 → 1.0.22

package/create-healthedge-tests.js

@@ -9,17 +9,26 @@ const projectPath = path.join(process.cwd(), projectName);
 
 console.log(`\n🚀 Creating HealthEdge Playwright project: ${projectName}\n`);
 
-// Comprehensive Directory Structure
-const dirs = [
-  'src/core/api/auth',
-  'src/core/config',
-  'src/core/i18n',
-  'src/core/pages',
-  'src/core/reporting',
-  'src/core/selfhealing',
-  'src/core/utils',
-  'src/core/visual',
-  'src/core/wrappers',
+// Recursive Copy Helper
+function copyRecursiveSync(src, dest) {
+  const exists = fs.existsSync(src);
+  const stats = exists && fs.statSync(src);
+  const isDirectory = exists && stats.isDirectory();
+  if (isDirectory) {
+    if (!fs.existsSync(dest)) {
+      fs.mkdirSync(dest, { recursive: true });
+    }
+    fs.readdirSync(src).forEach((childItemName) => {
+      copyRecursiveSync(path.join(src, childItemName), path.join(dest, childItemName));
+    });
+  } else {
+    fs.copyFileSync(src, dest);
+  }
+}
+
+// 1. Create Directories
+const baseDirs = [
+  'src/core',
   'src/pages',
   'src/tests',
   'src/fixtures',
@@ -27,36 +36,55 @@ const dirs = [
   'src/utils',
   'allure-results',
   'allure-report',
-  'api-docs/assets',
-  'api-docs/classes',
-  'api-docs/interfaces',
-  'api-docs/types',
-  'api-docs/variables'
+  'api-docs'
 ];
 
-dirs.forEach(idr => {
-  fs.mkdirSync(path.join(projectPath, idr), { recursive: true });
-});
+baseDirs.forEach(d => fs.mkdirSync(path.join(projectPath, d), { recursive: true }));
+
+// 2. Copy Framework Source (The "As It Is" Magic)
+const frameworkSrc = path.join(__dirname, 'src');
+
+if (fs.existsSync(frameworkSrc)) {
+  console.log('📄 Copying framework source files...');
+
+  // Copy Core files
+  if (fs.existsSync(path.join(frameworkSrc, 'core'))) {
+    copyRecursiveSync(path.join(frameworkSrc, 'core'), path.join(projectPath, 'src/core'));
+  }
+
+  // Copy Fixture templates
+  if (fs.existsSync(path.join(frameworkSrc, 'fixtures'))) {
+    copyRecursiveSync(path.join(frameworkSrc, 'fixtures'), path.join(projectPath, 'src/fixtures'));
+  }
+
+  // Copy Quality Pages to user Pages
+  if (fs.existsSync(path.join(frameworkSrc, 'quality/pages'))) {
+    copyRecursiveSync(path.join(frameworkSrc, 'quality/pages'), path.join(projectPath, 'src/pages'));
+  }
+
+  // Copy Sample Tests
+  if (fs.existsSync(path.join(frameworkSrc, 'tests'))) {
+    copyRecursiveSync(path.join(frameworkSrc, 'tests'), path.join(projectPath, 'src/tests'));
+  }
+} else {
+  console.log('⚠️ Framework source not found in package. Using fallback templates.');
+  // Fallback (minimal)
+  fs.writeFileSync(path.join(projectPath, 'src/core/placeholder.ts'), '// Framework source missing in package');
+}
 
-// package.json for the NEW project
+// 3. package.json for the target project
 const packageJson = {
   name: projectName,
   version: '1.0.0',
-  description: 'HealthEdge Enterprise Playwright Test Project',
+  description: 'HealthEdge Enterprise Test Project',
   scripts: {
     'test': 'playwright test',
     'test:dev': 'TEST_ENV=dev playwright test',
-    'test:qa': 'TEST_ENV=qa playwright test',
-    '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'
+    'lint': 'eslint . --ext .ts'
   },
   dependencies: {
-    '@sridharkikkeri/playwright-common': '^1.0.21',
+    '@sridharkikkeri/playwright-common': '^1.0.22',
     '@playwright/test': '^1.42.0',
     'allure-playwright': '^3.4.5'
   },
@@ -67,223 +95,10 @@ const packageJson = {
     'typescript': '^5.3.0'
   }
 };
-
 fs.writeFileSync(path.join(projectPath, 'package.json'), JSON.stringify(packageJson, null, 2));
 
-// --- "FULL PROXY" CORE EXTENSION BOILERPLATE ---
-
-const apiClientTs = `import { ApiClient as CommonApiClient } from '@sridharkikkeri/playwright-common';
-
-/**
- * Enterprise API Client Extension.
- * Use this to wrap framework API calls with project-specific logic.
- */
-export class ApiClient extends CommonApiClient {
-    constructor(baseUrl: string) {
-        super(baseUrl);
-    }
-
-    async getWithAuth(endpoint: string, token: string) {
-        return this.get(endpoint, {
-            headers: { 'Authorization': \`Bearer \${token}\` }
-        });
-    }
-
-    async postResource(endpoint: string, body: any) {
-        return this.post(endpoint, body);
-    }
-
-    async putResource(endpoint: string, body: any) {
-        return this.put(endpoint, body);
-    }
-
-    async deleteResource(endpoint: string) {
-        return this.delete(endpoint);
-    }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/api/ApiClient.ts'), apiClientTs);
-
-const authStrategyTs = `import { AuthStrategy as CommonAuthStrategy } from '@sridharkikkeri/playwright-common';
-
-export class AuthStrategy extends CommonAuthStrategy {
-    async login(credentials: { user: string; pass: string }): Promise<void> {
-        await this.page.goto('/login');
-        await this.page.fill('#username', credentials.user);
-        await this.page.fill('#password', credentials.pass);
-        await this.page.click('#login-btn');
-    }
-
-    async logout(): Promise<void> {
-        await this.page.click('#logout-btn');
-    }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/api/auth/AuthStrategy.ts'), authStrategyTs);
-
-const configManagerTs = `import { ConfigManager as CommonConfigManager } from '@sridharkikkeri/playwright-common';
-
-export class ConfigManager extends CommonConfigManager {
-    static getEnvironment() { return this.getConfig().environment; }
-    static getBaseUrl() { return this.getConfig().baseUrl; }
-    static getApiUrl() { return this.getConfig().apiUrl; }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/config/ConfigManager.ts'), configManagerTs);
-
-const localizationTs = `import { Localization as CommonLocalization } from '@sridharkikkeri/playwright-common';
-
-export class Localization extends CommonLocalization {
-    static translate(key: string, params?: Record<string, string>) {
-        return this.t(key, params);
-    }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/i18n/Localization.ts'), localizationTs);
-
-const basePageTs = `import { Page } from '@playwright/test';
-import { BasePage as CommonBasePage, ActionOrchestrator } from '@sridharkikkeri/playwright-common';
-
-export abstract class BasePage extends CommonBasePage {
-    constructor(page: Page, options?: { pageName: string; orchestrator?: ActionOrchestrator }) {
-        super(page, options);
-    }
-
-    async navigateTo(path: string) {
-        await this.page.goto(path);
-    }
-
-    async reload() {
-        await this.page.reload();
-    }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/pages/BasePage.ts'), basePageTs);
-
-const allureUtilTs = `import { AllureUtil as CommonAllureUtil } from '@sridharkikkeri/playwright-common';
-
-export class AllureUtil extends CommonAllureUtil {
-    static async logEnterpriseStep(name: string, action: () => Promise<void>) {
-        await this.step(name, action);
-    }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/reporting/AllureUtil.ts'), allureUtilTs);
-
-const locatorHealingTs = `import { LocatorHealing as CommonLocatorHealing } from '@sridharkikkeri/playwright-common';
-
-export class LocatorHealing extends CommonLocatorHealing {
-    // Implement project-specific recovery heuristics here
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/selfhealing/LocatorHealing.ts'), locatorHealingTs);
-
-const actionOrchestratorTs = `import { ActionOrchestrator as CommonActionOrchestrator } from '@sridharkikkeri/playwright-common';
-
-export class ActionOrchestrator extends CommonActionOrchestrator {
-    // Hook into orchestration events for custom logging or metrics
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/selfhealing/ActionOrchestrator.ts'), actionOrchestratorTs);
-
-const visualTestingTs = `import { VisualTesting as CommonVisualTesting } from '@sridharkikkeri/playwright-common';
-
-export class VisualTesting extends CommonVisualTesting {
-    // Custom thresholds or global masking logic
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/visual/VisualTesting.ts'), visualTestingTs);
-
-const elementWrapperTs = `import { ElementWrapper as CommonElementWrapper } from '@sridharkikkeri/playwright-common';
-
-/**
- * Enterprise Element Wrapper Extension.
- * Provides a full interaction set with AI-healing proxies.
- */
-export class ElementWrapper extends CommonElementWrapper {
-    /* --- Interaction Proxies --- */
-    async clickAndLog(intent?: string) { await this.click(intent); }
-    async dblClick(intent?: string) { await this.locator.dblclick(); }
-    async hover(intent?: string) { await this.locator.hover(); }
-    async fillAndLog(val: string, intent?: string) { await this.fill(val, intent); }
-    async press(key: string, intent?: string) { await this.locator.press(key); }
-    
-    /* --- State Proxies --- */
-    async isVisible(): Promise<boolean> { return await this.locator.isVisible(); }
-    async isEnabled(): Promise<boolean> { return await this.locator.isEnabled(); }
-    
-    /* --- Wait Proxies --- */
-    async waitForVisible(timeout = 5000) { await this.locator.waitFor({ state: 'visible', timeout }); }
-    async waitForHidden(timeout = 5000) { await this.locator.waitFor({ state: 'hidden', timeout }); }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/wrappers/ElementWrapper.ts'), elementWrapperTs);
-
-const loggerTs = `import { Logger as CommonLogger } from '@sridharkikkeri/playwright-common';
-
-export class Logger extends CommonLogger {
-    static debug(msg: string) { console.debug(\`[DEBUG] \${msg}\`); }
-    static info(msg: string) { console.log(\`[INFO] \${msg}\`); }
-    static warn(msg: string) { console.warn(\`[WARN] \${msg}\`); }
-    static error(msg: string, err?: Error) { console.error(\`[ERROR] \${msg}\`, err); }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/utils/Logger.ts'), loggerTs);
-
-const errorUtilsTs = `import { ErrorUtils as CommonErrorUtils } from '@sridharkikkeri/playwright-common';
-
-export class ErrorUtils extends CommonErrorUtils {
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/core/utils/ErrorUtils.ts'), errorUtilsTs);
-
-// --- 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: -apple-system, sans-serif; padding: 40px; line-height: 1.6; color: #333; } h1 { color: #007bff; }');
-fs.writeFileSync(path.join(projectPath, 'api-docs/index.html'), `
-<!DOCTYPE html>
-<html>
-<head>
-    <title>${projectName} Service Documentation</title>
-    <link rel="stylesheet" href="assets/style.css">
-</head>
-<body>
-    <h1>🏢 ${projectName} Enterprise Automation</h1>
-    <p>This project leverages the <strong>HealthEdge Playwright Framework</strong> for resilient, AI-powered automation.</p>
-    <hr>
-    <h3>Documentation Modules</h3>
-    <ul>
-        <li><a href="classes/README.md">Class Extensions & Proxies</a></li>
-        <li><a href="interfaces/README.md">Data Interfaces</a></li>
-        <li><a href="variables/README.md">Environment Variables</a></li>
-    </ul>
-</body>
-</html>`);
-
-['classes', 'interfaces', 'types', 'variables'].forEach(fold => {
-  fs.writeFileSync(path.join(projectPath, `api-docs/${fold}/README.md`), `# ${fold.toUpperCase()}\nStructured documentation for ${fold} in project ${projectName}.`);
-});
-
-// --- 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` };
-  fs.writeFileSync(path.join(projectPath, `framework.config.${env}.json`), JSON.stringify(config, null, 2));
-});
+// 4. Configuration Boilerplate
+const baseConfig = { healingEnabled: true, environment: 'dev', baseUrl: 'https://example.com', apiUrl: 'https://api.example.com', timeout: 30000 };
 fs.writeFileSync(path.join(projectPath, 'framework.config.json'), JSON.stringify(baseConfig, null, 2));
 
 const playwrightConfig = `import { defineConfig } from '@playwright/test';
@@ -295,74 +110,6 @@ export default defineConfig({
 });`;
 fs.writeFileSync(path.join(projectPath, 'playwright.config.ts'), playwrightConfig);
 
-const fixturesTs = `import { test as base } from '@sridharkikkeri/playwright-common';
-import { HomePage } from '../pages/HomePage';
-import { LoginPage } from '../pages/LoginPage';
-
-export const test = base.extend<{ homePage: HomePage; loginPage: LoginPage }>({
-  homePage: async ({ page, orchestrator }, use) => { await use(new HomePage(page, orchestrator)); },
-  loginPage: async ({ page, orchestrator }, use) => { await use(new LoginPage(page, orchestrator)); },
-});
-
-export { expect } from '@playwright/test';`;
-fs.writeFileSync(path.join(projectPath, 'src/fixtures/fixtures.ts'), fixturesTs);
-
-const homePageTs = `import { Page } from '@playwright/test';
-import { BasePage } from '../core/pages/BasePage';
-import { ActionOrchestrator } from '../core/selfhealing/ActionOrchestrator';
-
-export class HomePage extends BasePage {
-  constructor(page: Page, orchestrator?: ActionOrchestrator) { 
-    super(page, { pageName: 'HomePage', orchestrator }); 
-  }
-  private readonly searchBtn = this.element('button[type="submit"]');
-  async clickSearch() { await this.searchBtn.click('Click Search Button'); }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/pages/HomePage.ts'), homePageTs);
-
-const loginPageTs = `import { Page } from '@playwright/test';
-import { BasePage } from '../core/pages/BasePage';
-import { ActionOrchestrator } from '../core/selfhealing/ActionOrchestrator';
-
-export class LoginPage extends BasePage {
-  constructor(page: Page, orchestrator?: ActionOrchestrator) { 
-    super(page, { pageName: 'LoginPage', orchestrator }); 
-  }
-  private readonly userBox = this.element('#username');
-  private readonly passBox = this.element('#password');
-  private readonly submit = this.element('button.login');
-
-  async login(u: string, p: string) {
-    await this.userBox.fill(u, 'Enter user');
-    await this.passBox.fill(p, 'Enter pass');
-    await this.submit.click('Submit login');
-  }
-}
-`;
-fs.writeFileSync(path.join(projectPath, 'src/pages/LoginPage.ts'), loginPageTs);
-
-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('Standard Smoke Test', async ({ page, loginPage }) => {
-  await page.goto('https://playwright.dev');
-  await expect(page).toHaveTitle(/Playwright/);
-});`;
-fs.writeFileSync(path.join(projectPath, 'src/tests/sample.spec.ts'), sampleTest);
-
 const tsConfig = {
   compilerOptions: {
     target: 'ES2020', module: 'commonjs', lib: ['ES2020', 'DOM'],
@@ -372,43 +119,17 @@ const tsConfig = {
 };
 fs.writeFileSync(path.join(projectPath, 'tsconfig.json'), JSON.stringify(tsConfig, null, 2));
 
-const gitignore = `node_modules/
-allure-results/
-allure-report/
-test-results/
-playwright-report/
-.env
-*.log
-dist/
-`;
+const gitignore = `node_modules/\nallure-results/\nallure-report/\n.env\n*.log\n`;
 fs.writeFileSync(path.join(projectPath, '.gitignore'), gitignore);
 
-const readme = `# ${projectName}
-
-## Overview
-Enterprise automation test project powered by **@sridharkikkeri/playwright-common**.
-
-## Getting Started
-\`\`\`bash
-npm install
-npm run test:dev
-\`\`\`
-
-## Features
-- **AI Self-Healing**: Powered by ActionOrchestrator
-- **Visual Testing**: Automatic screenshot comparison
-- **Enterprise Reporting**: Built-in Allure integration
-`;
-fs.writeFileSync(path.join(projectPath, 'README.md'), readme);
-
-console.log('✅ Full Enterprise Project Structure Created');
-console.log('\n📦 Installing dependencies...\n');
+console.log('\n✅ Project structure created "as it is" from framework source.');
+console.log('📦 Installing dependencies...\n');
 
 try {
   execSync('npm install', { cwd: projectPath, stdio: 'inherit' });
   console.log('\n✅ Dependencies installed');
 } catch (error) {
-  console.log('\n⚠️ npm install failed. Please run manually.');
+  console.log('\n⚠️ npm install failed. Run manually.');
 }
 
-console.log(`\n🎉 Project ready! cd ${projectName} and try: npm run test:dev\n`);
+console.log(`\n🎉 Project ready! cd ${projectName} and try: npm run test\n`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sridharkikkeri/playwright-common",
-  "version": "1.0.21",
+  "version": "1.0.22",
   "description": "Production-grade Playwright framework with AI-powered self-healing, visual regression, and enterprise features",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,6 +12,7 @@
   },
   "files": [
     "dist",
+    "src",
     "create-healthedge-tests.js",
     "README.md",
     "HEALING_CACHE_STRATEGY.md",