@sridharkikkeri/playwright-common 1.0.16 → 1.0.18

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.16',
+    '@sridharkikkeri/playwright-common': '^1.0.18',
     '@playwright/test': '^1.42.0',
     'allure-playwright': '^3.4.5'
   },
@@ -69,132 +70,334 @@ const packageJson = {
 
 fs.writeFileSync(path.join(projectPath, 'package.json'), JSON.stringify(packageJson, null, 2));
 
-// --- PROFESSIONAL EXTENSION BOILERPLATE ---
+// --- ENHANCED CORE EXTENSION BOILERPLATE ---
 
-const baseApiClientTs = `import { ApiClient } from '@sridharkikkeri/playwright-common';
-export class BaseApiClient extends ApiClient {
-    constructor(baseUrl: string) { super(baseUrl); }
-}`;
-fs.writeFileSync(path.join(projectPath, 'src/core/api/BaseApiClient.ts'), baseApiClientTs);
+const apiClientTs = `import { ApiClient as CommonApiClient } from '@sridharkikkeri/playwright-common';
 
-const envConfigTs = `import { ConfigManager } from '@sridharkikkeri/playwright-common';
-export class ProjectConfig extends ConfigManager {
-    static getProjectName() { return '${projectName}'; }
-}`;
-fs.writeFileSync(path.join(projectPath, 'src/core/config/ProjectConfig.ts'), envConfigTs);
+/**
+ * Enterprise API Client.
+ * Use this class to add project-specific headers, 
+ * authentication tokens, or shared response validation.
+ */
+export class ApiClient extends CommonApiClient {
+    constructor(baseUrl: string) {
+        super(baseUrl);
+    }
 
-const locTs = `import { Localization } from '@sridharkikkeri/playwright-common';
-export class ProjectLocalization extends Localization {
-    static getDefaultLocale() { return 'en'; }
-}`;
-fs.writeFileSync(path.join(projectPath, 'src/core/i18n/ProjectLocalization.ts'), locTs);
+    async getWithAuth(endpoint: string) {
+        const token = 'YOUR_AUTH_TOKEN'; // Replace with real auth logic
+        return this.get(endpoint, {
+            headers: { 'Authorization': \`Bearer \${token}\` }
+        });
+    }
 
-const baseComponentTs = `import { Page } from '@playwright/test';
-import { BasePage, ActionOrchestrator } from '@sridharkikkeri/playwright-common';
-export abstract class BaseComponent extends BasePage {
-    constructor(page: Page, orchestrator?: ActionOrchestrator) {
-        super(page, { pageName: 'BaseComponent', orchestrator });
+    async postData(endpoint: string, data: any) {
+        return this.post(endpoint, data);
     }
-}`;
-fs.writeFileSync(path.join(projectPath, 'src/core/pages/BaseComponent.ts'), baseComponentTs);
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/api/ApiClient.ts'), apiClientTs);
 
-const reporterTs = `import { AllureUtil } from '@sridharkikkeri/playwright-common';
-export class ProjectReporter {
-    static async logStep(name: string) { console.log(\`[STEP] \${name}\`); }
-}`;
-fs.writeFileSync(path.join(projectPath, 'src/core/reporting/ProjectReporter.ts'), reporterTs);
+const authStrategyTs = `import { CookieAuth, AuthStrategy as CommonAuthStrategy } from '@sridharkikkeri/playwright-common';
 
-const healingTs = `import { LocatorHealing } from '@sridharkikkeri/playwright-common';
-export class ProjectHealer extends LocatorHealing {
-    // Customize project-specific healing logic here
-}`;
-fs.writeFileSync(path.join(projectPath, 'src/core/selfhealing/ProjectHealer.ts'), healingTs);
+export class AuthStrategy extends CommonAuthStrategy {
+    async login(credentials: any): Promise<void> {
+        // Implement project-specific login logic here
+        await this.page.goto('/login');
+        await this.page.fill('#username', credentials.username);
+        await this.page.fill('#password', credentials.password);
+        await this.page.click('#login-btn');
+    }
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/api/auth/AuthStrategy.ts'), authStrategyTs);
 
-const visualTs = `import { VisualTesting } from '@sridharkikkeri/playwright-common';
-export class ProjectVisuals extends VisualTesting {
-    // Custom visual testing overrides
-}`;
-fs.writeFileSync(path.join(projectPath, 'src/core/visual/ProjectVisuals.ts'), visualTs);
+const configManagerTs = `import { ConfigManager as CommonConfigManager } from '@sridharkikkeri/playwright-common';
+
+export class ConfigManager extends CommonConfigManager {
+    static getEnvironmentConfig() {
+        return this.getConfig();
+    }
+    
+    static isSelfHealingEnabled() {
+        return this.getConfig().healingEnabled ?? true;
+    }
+}
+`;
+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 getTranslate(key: string) {
+        return this.t(key);
+    }
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/i18n/Localization.ts'), localizationTs);
 
-const wrapperTs = `import { ElementWrapper } from '@sridharkikkeri/playwright-common';
-export class ProjectElement extends ElementWrapper {
-    // Add custom interaction logic here
+const basePageTs = `import { Page } from '@playwright/test';
+import { BasePage as CommonBasePage, ActionOrchestrator } from '@sridharkikkeri/playwright-common';
+
+/**
+ * Global Base Page for all project Page Objects.
+ */
+export abstract class BasePage extends CommonBasePage {
+    constructor(page: Page, options?: { pageName: string; orchestrator?: ActionOrchestrator }) {
+        super(page, options);
+    }
+
+    async waitForLoadingFinished() {
+        await this.page.waitForSelector('.loading-spinner', { state: 'hidden' });
+    }
+}
+`;
+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 captureStep(name: string, body: () => Promise<void>) {
+        await this.step(name, body);
+    }
+}
+`;
+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 {
+    // Add project-specific healing logic or custom 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 {
+    // Extend orchestration logic here
+}
+`;
+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 {
+    static async verifyFullPage(name: string) {
+        // Custom full page screenshot 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.
+ * Extend this class to add project-specific element interactions.
+ */
+export class ElementWrapper extends CommonElementWrapper {
+    async clickAndLog(stepDescription?: string): Promise<void> {
+        console.log(\`[AUTO-LOG] Clicking element: \${stepDescription || 'unknown'}\`);
+        await this.click(stepDescription);
+    }
+
+    async forceFill(value: string, stepDescription?: string): Promise<void> {
+        await this.locator.fill(value, { force: true });
+    }
+}
+`;
+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 info(message: string) {
+        console.log(\`[INFO] \${message}\`);
+    }
+}
+`;
+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 {
+    // Project-specific error handling
+}
+`;
+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); }
+    static mask(str: string) { return str.replace(/./g, '*'); }
 }`;
-fs.writeFileSync(path.join(projectPath, 'src/core/wrappers/ProjectElement.ts'), wrapperTs);
+fs.writeFileSync(path.join(projectPath, 'src/utils/StringUtils.ts'), stringUtilsTs);
 
-const projectUtilsTs = `export class ProjectUtils {
-    static async sleep(ms: number) { return new Promise(resolve => setTimeout(resolve, ms)); }
+const dateUtilsTs = `export class DateUtils {
+    static now() { return new Date().toISOString(); }
+    static format(date: Date) { return date.toLocaleDateString(); }
 }`;
-fs.writeFileSync(path.join(projectPath, 'src/core/utils/ProjectUtils.ts'), projectUtilsTs);
+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));
 
-fs.writeFileSync(path.join(projectPath, 'api-docs/index.html'), `<html><body><h1>API Documentation for ${projectName}</h1><p>Run <code>npm run docs:generate</code> to populate.</p></body></html>`);
+// --- DOCUMENTATION ---
+fs.writeFileSync(path.join(projectPath, 'api-docs/assets/style.css'), 'body { font-family: sans-serif; padding: 20px; line-height: 1.6; }');
+fs.writeFileSync(path.join(projectPath, 'api-docs/index.html'), \`
+<html>
+<head>
+    <title>\${projectName} API Docs</title>
+    <link rel="stylesheet" href="assets/style.css">
+</head>
+<body>
+    <h1>\${projectName} - Enterprise API Documentation</h1>
+    <p>Welcome to the central documentation hub for your Playwright testing project.</p>
+    <ul>
+        <li><a href="classes/README.md">Class References</a></li>
+        <li><a href="interfaces/README.md">Interfaces</a></li>
+    </ul>
+</body>
+</html>\`);
 
-// --- Standard Project Files ---
+['classes', 'interfaces', 'types', 'variables'].forEach(fold => {
+  fs.writeFileSync(path.join(projectPath, \`api-docs/\${fold}/README.md\`), \`# \${fold.toUpperCase()}\\nDetailed 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));
+  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));
 
-const playwrightConfig = `import { defineConfig } from '@playwright/test';
+const playwrightConfig = \`import { defineConfig } from '@playwright/test';
 export default defineConfig({
-  testDir: './src/tests', timeout: 30000,
+  testDir: './src/tests',
+  timeout: 30000,
+  retries: process.env.CI ? 2 : 0,
   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);
 
-const fixturesTs = `import { test as base } from '@sridharkikkeri/playwright-common';
+const fixturesTs = \`import { test as base } from '@sridharkikkeri/playwright-common';
 import { HomePage } from '../pages/HomePage';
-export const test = base.extend<{ homePage: 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';`;
+
+export { expect } from '@playwright/test';\`;
 fs.writeFileSync(path.join(projectPath, 'src/fixtures/fixtures.ts'), fixturesTs);
 
-const samplePage = `import { Page } from '@playwright/test';
-import { BasePage, ActionOrchestrator } from '@sridharkikkeri/playwright-common';
+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 }); }
+  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'); }
-}`;
-fs.writeFileSync(path.join(projectPath, 'src/pages/HomePage.ts'), samplePage);
+  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 userField = this.element('#user');
+  private readonly passField = this.element('#pass');
+  private readonly loginBtn = this.element('#login');
+
+  async login(u: string, p: string) {
+    await this.userField.fill(u, 'Enter username');
+    await this.passField.fill(p, 'Enter password');
+    await this.loginBtn.click('Click Login');
+  }
+}
+\`;
+fs.writeFileSync(path.join(projectPath, 'src/pages/LoginPage.ts'), loginPageTs);
+
+const visualTest = \`import { test, expect } from '../fixtures/fixtures';
 
-const sampleTest = `import { test, expect } from '../fixtures/fixtures';
-test('Demo Test', async ({ page, homePage }) => {
+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);
 
-fs.writeFileSync(path.join(projectPath, 'src/i18n/en.json'), JSON.stringify({ "welcome": "Hello" }, null, 2));
-
-const tsConfig = { compilerOptions: { target: 'ES2020', module: 'commonjs', lib: ['ES2020'], strict: true, esModuleInterop: true, skipLibCheck: true, resolveJsonModule: true }, include: ['src/**/*'] };
+const tsConfig = { 
+  compilerOptions: { 
+    target: 'ES2020', module: 'commonjs', lib: ['ES2020', 'DOM'], 
+    strict: true, esModuleInterop: true, skipLibCheck: true, resolveJsonModule: true 
+  }, 
+  include: ['src/**/*'] 
+};
 fs.writeFileSync(path.join(projectPath, 'tsconfig.json'), JSON.stringify(tsConfig, null, 2));
 
-const gitignore = `node_modules/
+const gitignore = \`node_modules/
 allure-results/
 allure-report/
+test-results/
+playwright-report/
 .env
 *.log
-`;
+dist/
+\`;
 fs.writeFileSync(path.join(projectPath, '.gitignore'), gitignore);
 
-console.log('✅ Project structure created');
-console.log('\n📦 Installing dependencies...\n');
+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**: Powered by AI Action Orchestrator
+- **Visual Regression**: Built-in screenshot comparison
+- **Enterprise Reporting**: Allure reporting with custom steps
+\`;
+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'); }
+  console.log('\\n✅ Dependencies installed');
+} catch (error) {
+  console.log('\\n⚠️ npm install failed. Please run manually.');
+}
 
-console.log(`\n🎉 Project ready! cd ${projectName} and 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.16",
+  "version": "1.0.18",
   "description": "Production-grade Playwright framework with AI-powered self-healing, visual regression, and enterprise features",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",