@appliqation/automation-sdk 2.4.0 → 2.5.0

package/README.md

@@ -3,7 +3,6 @@
 A powerful SDK for integrating Playwright test results with the Appliqation test management portal.
 
 **What it does:**
-- ✅ **Auto-configuration** - Configure with just an API key (NEW!)
 - ✅ Automatically creates test runs in Appliqation
 - ✅ Handles browser authentication with JWT tokens
 - ✅ Reports test results (passed/failed/skipped) to your portal
@@ -42,19 +41,6 @@ Before you begin, ensure you have:
 
 Follow these steps in order to integrate the SDK with your Playwright tests.
 
-> **🎉 NEW: Simplified Configuration**
-> You now only need **one configuration value** to get started! Just provide your API key and the SDK automatically fetches your project ID and environment. This reduces setup from 3 required values to just 1.
->
-> ```bash
-> # Before: 3 required values
-> APPLIQATION_API_KEY=...
-> APPLIQATION_PROJECT_KEY=...        # ❌ No longer required
-> APPLIQATION_ENVIRONMENT=...        # ❌ No longer required
->
-> # After: 1 required value
-> APPLIQATION_API_KEY=...            # ✅ That's it!
-> ```
-
 **📌 Important:** Appliqation reporting is **opt-in**. You must either set `APPQ_ENABLE=1` environment variable or add `-- --appq` flag to your test command to send results to Appliqation. Without enabling reporting, tests run normally but results are not reported.
 
 ### Step 1: Install the SDK
@@ -73,25 +59,20 @@ npm install @appliqation/automation-sdk dotenv
 
 Create a `.env` file in your project root with your Appliqation credentials:
 
-**File:** `.env` (Simplified - Recommended)
+**File:** `.env`
 ```bash
-# 🎉 NEW: Auto-Configuration - Only API key required!
-# The SDK automatically fetches project ID and environment from your API key
+# IMPORTANT: No spaces around = signs, no trailing slashes on URLs
 
 APPLIQATION_API_KEY=appq_live_xxxxxxxxxxxxxxxxxxxx
+APPLIQATION_PROJECT_KEY=your-project-key-here
 TEST_APP_URL=https://www.example.com    # App under test (Playwright baseURL)
 ```
 
-**That's it!** The SDK will automatically:
-- ✅ Fetch your project ID from the API key
-- ✅ Detect available environments
-- ✅ Use the default environment
-
-**How to get your API key:**
-- Go to your Appliqation project settings
-- Navigate to Settings > API Keys
-- Generate a new API key
-- Copy the API key (starts with `appq_live_`)
+**How to get these values:**
+- `APPLIQATION_API_KEY` -     Found in your project settings
+- `APPLIQATION_PROJECT_KEY` - Found in your project settings
+- `TEST_APP_URL` - The site you’re testing (e.g., https://www.amazon.in). Used as Playwright `baseURL`.
+- 
 
 **⚠️ Add .env to .gitignore** to keep credentials secret:
 ```bash
@@ -100,50 +81,20 @@ echo ".env" >> .gitignore
 
 ---
 
-<details>
-<summary><strong>Advanced: Manual Configuration (Optional)</strong></summary>
-
-If you prefer to specify project ID and environment manually (or need backward compatibility), you can use the traditional configuration:
-
-```bash
-# Traditional configuration - Still supported!
-APPLIQATION_API_KEY=appq_live_xxxxxxxxxxxxxxxxxxxx
-APPLIQATION_PROJECT_KEY=1162                    # Optional: Auto-fetched if not provided
-APPLIQATION_ENVIRONMENT=Production              # Optional: Uses default if not provided
-TEST_APP_URL=https://www.example.com
-```
-
-**When to use manual configuration:**
-- You want to override the auto-detected environment
-- You're testing the SDK in development
-- You have specific environment requirements
-- Backward compatibility with existing setups
-
-**Benefits of auto-configuration:**
-- Simpler setup (1 value instead of 3)
-- Less configuration errors
-- Automatic environment validation
-- Easy to get started for new users
-
-</details>
-
----
-
 ### Step 3: Update playwright.config.js
 
 Update your Playwright configuration to use the SDK's built-in features:
 
-**File:** `playwright.config.js` (Simplified)
+**File:** `playwright.config.js`
 
 ```javascript
 const { defineConfig } = require('@playwright/test');
 require('dotenv').config();  // Load .env variables
 
-// SDK configuration - Auto-configuration enabled!
+// SDK configuration
 const appliqationConfig = {
   apiKey: process.env.APPLIQATION_API_KEY,
-  // projectKey: Auto-fetched from API key! ✨
-  // environment: Auto-detected default environment! ✨
+  projectKey: process.env.APPLIQATION_PROJECT_KEY,
 
   // Optional settings
   autoCreateRun: true,           // Automatically create run on test start

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appliqation/automation-sdk",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Appliqation Automation SDK with API key authentication, custom run titles, and framework-specific reporters",
   "main": "src/index.js",
   "types": "src/index.d.ts",