@sridharkikkeri/playwright-common 1.0.21 → 1.0.23

package/CLEAN_IMPORTS.md

@@ -0,0 +1,184 @@
+# Clean Import Guide (v1.0.1+)
+
+## ✅ What Changed in v1.0.1
+
+**Before (v1.0.0):**
+```typescript
+// ❌ Ugly deep imports
+import { test } from '@sridharkikkeri/playwright-common/dist/com/healthedge/common/fixtures/fixtures';
+import { BasePage } from '@sridharkikkeri/playwright-common/dist/com/healthedge/common/core/pages/BasePage';
+```
+
+**After (v1.0.1):**
+```typescript
+// ✅ Clean barrel imports
+import { test, BasePage, VisualTesting } from '@sridharkikkeri/playwright-common';
+```
+
+---
+
+## Usage Examples
+
+### Basic Test
+```typescript
+import { test } from '@sridharkikkeri/playwright-common';
+
+test('My test', async ({ page }) => {
+  await page.goto('https://example.com');
+});
+```
+
+### Page Object Pattern
+```typescript
+import { BasePage } from '@sridharkikkeri/playwright-common';
+import { Page } from '@playwright/test';
+
+export class LoginPage extends BasePage {
+  constructor(page: Page) {
+    super(page, 'LoginPage');
+  }
+
+  private readonly username = this.element('#username');
+  private readonly loginBtn = this.element('button[type="submit"]');
+
+  async login(user: string) {
+    await this.username.fill(user, 'Enter username');
+    await this.loginBtn.click('Click login');
+  }
+}
+```
+
+### Visual Testing
+```typescript
+import { test, VisualTesting } from '@sridharkikkeri/playwright-common';
+
+test('Visual regression', async ({ page }) => {
+  const visual = new VisualTesting(page);
+  await page.goto('/dashboard');
+  await visual.compareFullPage({ name: 'dashboard' });
+});
+```
+
+### API Testing
+```typescript
+import { test, ApiClient } from '@sridharkikkeri/playwright-common';
+
+test('API test', async ({ request }) => {
+  const client = new ApiClient(request);
+  const response = await client.get('/api/users/1');
+  expect(response.status).toBe(200);
+});
+```
+
+### Configuration
+```typescript
+import { ConfigManager } from '@sridharkikkeri/playwright-common';
+
+const config = ConfigManager.getConfig();
+console.log(config.healingEnabled); // true
+console.log(config.environment); // 'dev'
+```
+
+### Localization
+```typescript
+import { Localization } from '@sridharkikkeri/playwright-common';
+
+const message = Localization.get('welcome_message', 'en');
+```
+
+### Allure Reporting
+```typescript
+import { AllureUtil } from '@sridharkikkeri/playwright-common';
+
+await AllureUtil.step('Custom step', async () => {
+  // Your logic
+  AllureUtil.attachJson('Data', { key: 'value' });
+});
+```
+
+---
+
+## All Available Exports
+
+```typescript
+import {
+  // Testing
+  test,
+  
+  // Pages
+  BasePage,
+  LoginPage,
+  
+  // Wrappers
+  ElementWrapper,
+  
+  // Self-Healing
+  ActionOrchestrator,
+  LocatorHealing,
+  ElementProfileStore,
+  
+  // API
+  ApiClient,
+  AuthStrategy,
+  CookieAuth,
+  OAuth2Auth,
+  
+  // Visual
+  VisualTesting,
+  
+  // Config
+  ConfigManager,
+  
+  // i18n
+  Localization,
+  
+  // Reporting
+  AllureUtil,
+  
+  // Utils
+  Logger,
+  ErrorUtils
+} from '@sridharkikkeri/playwright-common';
+```
+
+---
+
+## TypeScript Support
+
+Full TypeScript support with auto-completion:
+
+```typescript
+import { BasePage } from '@sridharkikkeri/playwright-common';
+//       ^
+//       VS Code will show type hints and documentation
+```
+
+---
+
+## Migration from v1.0.0 to v1.0.1
+
+**Find and replace in your project:**
+
+```bash
+# Old pattern
+@sridharkikkeri/playwright-common/dist/com/healthedge/common/
+
+# New pattern
+@sridharkikkeri/playwright-common
+```
+
+**Or use this script:**
+```bash
+find . -name "*.ts" -type f -exec sed -i '' \
+  's|@sridharkikkeri/playwright-common/dist/com/healthedge/common/[^'"'"']*|@sridharkikkeri/playwright-common|g' {} +
+```
+
+---
+
+## Installation
+
+```bash
+npm install @sridharkikkeri/playwright-common@latest
+```
+
+**Package URL:** https://www.npmjs.com/package/@sridharkikkeri/playwright-common

package/NPM_PUBLISHING.md

@@ -0,0 +1,213 @@
+# NPM Publishing Guide
+
+## Package Information
+- **Name**: `@healthedge/playwright-common`
+- **Version**: `1.0.0`
+- **Size**: ~34 KB (compressed)
+
+---
+
+## Pre-Publish Checklist
+
+✅ TypeScript compiled to `dist/`  
+✅ Type definitions generated  
+✅ Documentation included (README, HEALING_CACHE_STRATEGY, VISUAL_TESTING)  
+✅ Project generator script included  
+✅ Test files excluded from package  
+
+---
+
+## Publishing Steps
+
+### 1. Enable 2FA on NPM Account (Web Interface)
+**NPM no longer supports TOTP via CLI. Use web interface:**
+
+1. Go to https://www.npmjs.com/settings/YOUR_USERNAME/tfa
+2. Click "Add 2FA Method"
+3. Choose "Authenticator App" or "Security Key"
+4. Follow setup instructions
+5. Save backup codes
+
+**OR use Automation Token (recommended for publishing):**
+1. Go to https://www.npmjs.com/settings/YOUR_USERNAME/tokens
+2. Click "Generate New Token"
+3. Select **"Automation"** type (bypasses 2FA)
+4. Copy token and save securely
+5. Use token for publishing:
+```bash
+npm config set //registry.npmjs.org/:_authToken YOUR_TOKEN
+```
+
+### 2. Test Package Locally
+```bash
+# Build the package
+npm run build
+
+# Test package contents
+npm pack --dry-run
+
+# Create tarball for local testing
+npm pack
+```
+
+### 3. Test in Another Project
+```bash
+# In another project directory
+npm install /path/to/healthedge-playwright-common-1.0.0.tgz
+
+# Test imports
+import { BasePage, VisualTesting, test } from '@healthedge/playwright-common';
+```
+
+### 4. Login to NPM
+```bash
+# If using automation token, skip this step
+# Token is already configured in step 1
+
+# If using 2FA with authenticator app:
+npm login
+# Enter credentials + 2FA code when prompted
+```
+
+### 5. Publish to NPM
+```bash
+# With automation token (no 2FA prompt)
+npm publish --access public
+
+# With 2FA authenticator (enter code when prompted)
+npm publish --access public
+```
+
+### 6. Verify Publication
+```bash
+npm view @healthedge/playwright-common
+```
+
+---
+
+## Installation (After Publishing)
+
+### For End Users
+```bash
+# Install the framework
+npm install @healthedge/playwright-common
+
+# Create new project
+npx create-healthedge-tests my-project
+```
+
+### Usage
+```typescript
+import { test, BasePage, VisualTesting } from '@healthedge/playwright-common';
+
+test('My test', async ({ page }) => {
+  // Use framework features
+});
+```
+
+---
+
+## Version Management
+
+### Update Version
+```bash
+# Patch (1.0.0 -> 1.0.1)
+npm version patch
+
+# Minor (1.0.0 -> 1.1.0)
+npm version minor
+
+# Major (1.0.0 -> 2.0.0)
+npm version major
+```
+
+### Publish Update
+```bash
+npm run build
+npm publish
+```
+
+---
+
+## CI/CD Publishing (GitHub Actions)
+
+```yaml
+name: Publish to NPM
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          registry-url: 'https://registry.npmjs.org'
+      
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+```
+
+---
+
+## Troubleshooting
+
+### Issue: 403 Forbidden - 2FA required
+**Solution**: Use Automation Token (easiest)
+1. Go to https://www.npmjs.com/settings/YOUR_USERNAME/tokens
+2. Generate "Automation" token
+3. Configure:
+```bash
+npm config set //registry.npmjs.org/:_authToken YOUR_TOKEN
+npm publish --access public
+```
+
+### Issue: TOTP 2FA no longer supported via CLI
+**Solution**: NPM deprecated CLI-based 2FA setup. Use web interface at https://www.npmjs.com/settings/YOUR_USERNAME/tfa or use Automation tokens instead.
+
+### Issue: Package name already exists
+**Solution**: Change package name in `package.json` or use scoped name like `@yourorg/playwright-common`
+
+### Issue: Build fails
+**Solution**: Run `npm run build` and fix TypeScript errors
+
+### Issue: Large package size
+**Solution**: Check `.npmignore` to exclude unnecessary files
+
+---
+
+## Package Registry Alternatives
+
+### GitHub Packages
+```bash
+# Update package.json
+"publishConfig": {
+  "registry": "https://npm.pkg.github.com"
+}
+
+# Publish
+npm publish
+```
+
+### Private Registry (Artifactory, Verdaccio)
+```bash
+npm config set registry https://your-registry.com
+npm publish
+```
+
+---
+
+## Post-Publish
+
+1. Update README with installation instructions
+2. Create GitHub release with changelog
+3. Announce on team channels
+4. Update documentation site
+5. Monitor npm download stats: `npm view @healthedge/playwright-common`

package/PUBLISHED.md

@@ -0,0 +1,153 @@
+# 🎉 Package Published Successfully!
+
+## Package Details
+- **Name**: `@sridharkikkeri/playwright-common`
+- **Version**: `1.0.0`
+- **Published**: ✅ Live on NPM
+- **Size**: 131.3 kB (unpacked), 33.9 kB (tarball)
+- **NPM Page**: https://www.npmjs.com/package/@sridharkikkeri/playwright-common
+
+---
+
+## Installation
+
+### For End Users
+```bash
+# Install the framework (use latest for clean imports)
+npm install @sridharkikkeri/playwright-common@latest
+
+# Or create new project with generator
+npx create-healthedge-tests my-project
+cd my-project
+npm install
+npm run test:dev
+```
+
+### Clean Imports (v1.0.1+)
+```typescript
+// ✅ Clean barrel imports
+import { test, BasePage, VisualTesting } from '@sridharkikkeri/playwright-common';
+
+// ❌ Don't use deep imports (v1.0.0 style)
+import { test } from '@sridharkikkeri/playwright-common/dist/com/healthedge/common/...';
+```
+
+See [CLEAN_IMPORTS.md](./CLEAN_IMPORTS.md) for complete usage guide.
+
+---
+
+## Usage Examples
+
+### Basic Test
+```typescript
+import { test, BasePage } from '@sridharkikkeri/playwright-common';
+
+test('My first test', async ({ page }) => {
+  await page.goto('https://example.com');
+  // Your test logic
+});
+```
+
+### Visual Regression
+```typescript
+import { test, VisualTesting } from '@sridharkikkeri/playwright-common';
+
+test('Visual check', async ({ page }) => {
+  const visual = new VisualTesting(page);
+  await page.goto('/dashboard');
+  await visual.compareFullPage({ name: 'dashboard' });
+});
+```
+
+### Page Object Pattern
+```typescript
+import { BasePage } from '@sridharkikkeri/playwright-common';
+
+export class LoginPage extends BasePage {
+  constructor(page) {
+    super(page, 'LoginPage');
+  }
+
+  private readonly username = this.element('#username');
+  private readonly password = this.element('#password');
+  private readonly loginBtn = this.element('button[type="submit"]');
+
+  async login(user: string, pass: string) {
+    await this.username.fill(user, 'Enter username');
+    await this.password.fill(pass, 'Enter password');
+    await this.loginBtn.click('Click login');
+  }
+}
+```
+
+---
+
+## Features Included
+
+✅ **AI-Powered Self-Healing** - Automatic locator recovery  
+✅ **Visual Regression Testing** - Built-in snapshot comparison  
+✅ **Environment Configs** - dev, qa, auto, staging, prod  
+✅ **API Testing** - Robust ApiClient with auth strategies  
+✅ **Allure Reporting** - Integrated test reporting  
+✅ **Localization (i18n)** - Multi-language support  
+✅ **Enterprise Fixtures** - Zero-boilerplate test setup  
+✅ **Project Generator** - Bootstrap new projects instantly  
+
+---
+
+## Documentation
+
+- [README](https://github.com/healthedge/playwright-framework#readme)
+- [Healing Cache Strategy](./HEALING_CACHE_STRATEGY.md)
+- [Visual Testing Guide](./VISUAL_TESTING.md)
+- [NPM Publishing Guide](./NPM_PUBLISHING.md)
+
+---
+
+## Next Steps
+
+### Update Package
+```bash
+# Bump version
+npm version patch  # 1.0.0 -> 1.0.1
+npm version minor  # 1.0.0 -> 1.1.0
+npm version major  # 1.0.0 -> 2.0.0
+
+# Rebuild and publish
+npm run build
+npm publish --access public
+```
+
+### Share with Team
+```bash
+# Share installation command
+npm install @sridharkikkeri/playwright-common
+
+# Or share project generator
+npx create-healthedge-tests my-project
+```
+
+---
+
+## Stats & Monitoring
+
+**View package stats:**
+- NPM page: https://www.npmjs.com/package/@sridharkikkeri/playwright-common
+- Download stats: https://npm-stat.com/charts.html?package=@sridharkikkeri/playwright-common
+
+**Monitor usage:**
+```bash
+npm view @sridharkikkeri/playwright-common
+```
+
+---
+
+## Support
+
+For issues or questions:
+- GitHub Issues: https://github.com/healthedge/playwright-framework/issues
+- Email: sridharkikkeri@gmail.com
+
+---
+
+**Congratulations! Your framework is now available to the world! 🚀**

package/QUICK_FIX.md

@@ -0,0 +1,40 @@
+# Quick Fix: NPM Token Issue
+
+## Steps to Publish
+
+1. **Generate NEW Automation Token:**
+   - Go to: https://www.npmjs.com/settings/sridharkikkeri/tokens
+   - Click "Generate New Token"
+   - Select **"Automation"** (NOT Classic or Publish)
+   - Copy the token
+
+2. **Clear old config and set new token:**
+```bash
+npm config delete //registry.npmjs.org/:_authToken
+npm config set //registry.npmjs.org/:_authToken YOUR_NEW_TOKEN_HERE
+```
+
+3. **Verify token works:**
+```bash
+npm whoami
+# Should show: sridharkikkeri
+```
+
+4. **Publish:**
+```bash
+npm publish --access public
+```
+
+## Alternative: Use unscoped name (no @ prefix)
+
+If token issues persist, change package name to unscoped:
+
+In `package.json`:
+```json
+"name": "playwright-common-healthedge"
+```
+
+Then publish:
+```bash
+npm publish
+```

package/api-docs/assets/hierarchy.js

@@ -0,0 +1 @@
+window.hierarchyData = "eJyNj7EOgjAQht/l5qIpIiKbuppo4mgcGjigobZJWwdjeHdbDVAHxaVN7r77v/wP0EpZA/mZJoQm6YWAxkpgYbmSbvwA6h/Jrgg57JRqOW5utgECLZcl5DTOCNy0cNtCMGPQzEdq1tircOhr4whrysifRe9BR4AmQbw/OVnNLNb3QRAv017ApUVdscI5QvSrZeD9suGi1Ch9U0Kzi3dngfvgE+OpaiP1T7U0yN8yg0dW46/0npnI/iizWK19F/cFsr2quZyyDdBUla57Ang3sis="

package/api-docs/assets/highlight.css

@@ -0,0 +1,71 @@
+:root {
+    --light-hl-0: #D73A49;
+    --dark-hl-0: #F97583;
+    --light-hl-1: #24292E;
+    --dark-hl-1: #E1E4E8;
+    --light-hl-2: #032F62;
+    --dark-hl-2: #9ECBFF;
+    --light-hl-3: #6F42C1;
+    --dark-hl-3: #B392F0;
+    --light-hl-4: #E36209;
+    --dark-hl-4: #FFAB70;
+    --light-hl-5: #005CC5;
+    --dark-hl-5: #79B8FF;
+    --light-hl-6: #6A737D;
+    --dark-hl-6: #6A737D;
+    --light-code-background: #fff;
+    --dark-code-background: #24292e;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+pre, code { background: var(--code-background); }