@sridharkikkeri/playwright-common 1.0.5 → 1.0.12

package/create-healthedge-tests.js

@@ -11,23 +11,38 @@ console.log(`\n🚀 Creating HealthEdge Playwright project: ${projectName}\n`);
 
 // Create project structure
 const dirs = [
+  'src/core/api',
+  'src/core/config',
+  'src/core/i18n',
+  'src/core/pages',
+  'src/core/reporting',
+  'src/core/selfhealing',
+  'src/core/utils',
+  'src/core/visual',
+  'src/core/wrappers',
   'src/pages',
   'src/tests',
   'src/fixtures',
   'src/i18n',
   'src/utils',
   'allure-results',
-  'allure-report'
+  'allure-report',
+  'api-docs/assets',
+  'api-docs/classes',
+  'api-docs/interfaces',
+  'api-docs/types',
+  'api-docs/variables'
 ];
 
-dirs.forEach(dir => {
-  fs.mkdirSync(path.join(projectPath, dir), { recursive: true });
+dirs.forEach(idr => {
+  fs.mkdirSync(path.join(projectPath, idr), { recursive: true });
 });
 
 // package.json
 const packageJson = {
   name: projectName,
   version: '1.0.0',
+  description: 'HealthEdge Playwright Test Project',
   scripts: {
     'test': 'playwright test',
     'test:dev': 'TEST_ENV=dev playwright test',
@@ -40,7 +55,7 @@ const packageJson = {
     'lint:fix': 'eslint . --fix'
   },
   dependencies: {
-    '@sridharkikkeri/playwright-common': '^1.0.5',
+    '@sridharkikkeri/playwright-common': '^1.0.12',
     '@playwright/test': '^1.42.0',
     'allure-playwright': '^3.4.5'
   },
@@ -52,182 +67,120 @@ const packageJson = {
   }
 };
 
-fs.writeFileSync(
-  path.join(projectPath, 'package.json'),
-  JSON.stringify(packageJson, null, 2)
-);
+fs.writeFileSync(path.join(projectPath, 'package.json'), JSON.stringify(packageJson, 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: {
-    baseURL: process.env.BASE_URL || 'https://example.com',
-    trace: 'on-first-retry',
-    screenshot: 'only-on-failure',
-  },
-});
-`;
+// --- CORE BOILERPLATE FILES ---
 
-fs.writeFileSync(path.join(projectPath, 'playwright.config.ts'), playwrightConfig);
+// src/core/api/BaseApiClient.ts
+const baseApiClientTs = `import { ApiClient } from '@sridharkikkeri/playwright-common';
 
-// framework.config.dev.json
-const devConfig = {
-  healingEnabled: true,
-  environment: 'dev',
-  baseUrl: 'https://dev.example.com',
-  apiUrl: 'https://api-dev.example.com',
-  timeout: 30000,
-  retries: 2
-};
-
-fs.writeFileSync(
-  path.join(projectPath, 'framework.config.dev.json'),
-  JSON.stringify(devConfig, null, 2)
-);
+/**
+ * Project-specific Base API Client.
+ * Extend this to add custom headers or shared error handling for your app.
+ */
+export class BaseApiClient extends ApiClient {
+    constructor(baseUrl: string) {
+        super(baseUrl);
+    }
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/api/BaseApiClient.ts'), baseApiClientTs);
 
-// New: src/fixtures/fixtures.ts
-const fixturesTs = `import { test as base } from '@sridharkikkeri/playwright-common';
-import { HomePage } from '../pages/HomePage';
+// src/core/pages/BaseComponent.ts
+const baseComponentTs = `import { Page } from '@playwright/test';
+import { BasePage, ActionOrchestrator } from '@sridharkikkeri/playwright-common';
 
 /**
- * Extended test object for your project.
- * Add your project-specific Page Objects and fixtures here.
+ * Base Component for project-specific reusable UI elements (e.g., Modals, Navbars).
  */
-export const test = base.extend<{
-  homePage: HomePage;
-}>({
-  homePage: async ({ page, orchestrator }, use) => {
-    await use(new HomePage(page, orchestrator));
-  },
-});
+export abstract class BaseComponent extends BasePage {
+    constructor(page: Page, orchestrator?: ActionOrchestrator) {
+        super(page, { pageName: 'BaseComponent', orchestrator });
+    }
+}
+`;
+fs.writeFileSync(path.join(projectPath, 'src/core/pages/BaseComponent.ts'), baseComponentTs);
 
-export { expect } from '@playwright/test';
+// src/core/utils/ProjectUtils.ts
+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));
+    }
+}
 `;
+fs.writeFileSync(path.join(projectPath, 'src/core/utils/ProjectUtils.ts'), projectUtilsTs);
+
+// --- CONFIGURATION ---
+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));
+});
+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' }
+  }); `;
+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';
+  export const test = base.extend < { homePage: HomePage } > ({
+    homePage: async ({ page, orchestrator }, use) => { await use(new HomePage(page, orchestrator)); },
+  });
+  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';
-
-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');
+  import { BasePage, ActionOrchestrator } from '@sridharkikkeri/playwright-common';
+  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');
+    }
   }
-}
-`;
-
+  `;
 fs.writeFileSync(path.join(projectPath, 'src/pages/HomePage.ts'), samplePage);
 
 // Sample Test
 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');
-    
-    // Using the injected homePage fixture
-    await homePage.search('playwright');
-    
-    await expect(page).toHaveTitle(/Playwright/);
-  });
-});
-`;
-
+  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/);
+    });
+  }); `;
 fs.writeFileSync(path.join(projectPath, 'src/tests/sample.spec.ts'), sampleTest);
 
-// Sample i18n file
-const sampleI18n = {
-  "login_welcome": "Welcome to HealthEdge"
-};
+const sampleI18n = { "login_welcome": "Welcome to HealthEdge" };
 fs.writeFileSync(path.join(projectPath, 'src/i18n/en.json'), JSON.stringify(sampleI18n, null, 2));
 
-// tsconfig.json
 const tsConfig = {
-  compilerOptions: {
-    target: 'ES2020',
-    module: 'commonjs',
-    lib: ['ES2020'],
-    strict: true,
-    esModuleInterop: true,
-    skipLibCheck: true,
-    forceConsistentCasingInFileNames: true,
-    resolveJsonModule: true
-  },
+  compilerOptions: { target: 'ES2020', module: 'commonjs', lib: ['ES2020'], strict: true, esModuleInterop: true, skipLibCheck: true, forceConsistentCasingInFileNames: true, resolveJsonModule: true },
   include: ['src/**/*']
 };
+fs.writeFileSync(path.join(projectPath, 'tsconfig.json'), JSON.stringify(tsConfig, null, 2));
 
-fs.writeFileSync(
-  path.join(projectPath, 'tsconfig.json'),
-  JSON.stringify(tsConfig, null, 2)
-);
-
-// .gitignore
-const gitignore = `node_modules/
-allure-results/
-allure-report/
-test-results/
-playwright-report/
-.env
-*.log
-`;
-
+const gitignore = `node_modules /\nallure - results /\nallure - report /\ntest - results /\nplaywright - report /\n.env\n *.log\n`;
 fs.writeFileSync(path.join(projectPath, '.gitignore'), gitignore);
 
-// README
-const readme = `# ${projectName}
-
-Generated with \`npx create-healthedge-tests\`
-
-## Quick Start
-
-\`\`\`bash
-npm install
-npm run test:dev
-npm run report
-\`\`\`
-
-## Key Concepts
-
-### Fixtures
-This project uses an extended \`test\` object defined in \`src/fixtures/fixtures.ts\`. 
-Instead of importing from \`@playwright/test\`, always import from your local fixtures:
-
-\`\`\`typescript
-import { test } from '../fixtures/fixtures';
-\`\`\`
-
-### Page Objects
-Add your pages to \`src/pages\` and register them in \`src/fixtures/fixtures.ts\`.
-
-## Environment-Specific Tests
-
-\`\`\`bash
-npm run test:dev      # Uses framework.config.dev.json
-npm run test:staging  # Uses framework.config.staging.json
-npm run test:prod     # Uses framework.config.prod.json
-\`\`\`
-`;
-
-fs.writeFileSync(path.join(projectPath, 'README.md'), readme);
-
 console.log('✅ Project structure created');
 console.log('\n📦 Installing dependencies...\n');
 
@@ -238,6 +191,6 @@ try {
   console.log('\n⚠️  Run "npm install" manually in the project directory');
 }
 
-console.log(`\n🎉 Project ready! Next steps:\n`);
-console.log(`   cd ${projectName}`);
-console.log(`   npm run test:dev\n`);
+console.log(`\n🎉 Project ready! Next steps: \n`);
+console.log(`   cd \${ projectName } `);
+console.log(`   npm run test: dev\n`);

package/package.json

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