@appliqation/automation-sdk 2.1.10 → 2.1.11

package/README.md

@@ -125,7 +125,7 @@ module.exports = defineConfig({
     ['html'],  // HTML report
 
     // Appliqation reporter for result submission
-    ['@appliqation/automation-sdk/playwright', appliqationConfig]
+    ['@appliqation/automation-sdk/playwright/reporter', appliqationConfig]
   ],
 
   projects: [
@@ -410,7 +410,7 @@ your-playwright-project/
 │   ├── globalSetup: require.resolve('@appliqation/automation-sdk/playwright/global-setup')
 │   ├── globalTeardown: require.resolve('@appliqation/automation-sdk/playwright/global-teardown')
 │   ├── use: { storageState: '.auth/jwt.json' }
-│   └── reporter: ['@appliqation/automation-sdk/playwright', config]
+│   └── reporter: ['@appliqation/automation-sdk/playwright/reporter', config]
 │
 ├── tests/
 │   ├── login.spec.js               # YOUR TESTS (Step 4)
@@ -727,18 +727,18 @@ Connection test: { success: true, message: 'Connected to Appliqation portal' }
 
 For long-running test suites, use the SDK's custom fixture to automatically refresh JWT tokens:
 
-**File:** `playwright.config.js`
+**File:** `tests/example.spec.js`
 ```javascript
-const { test: base } = require('@playwright/test');
-const { createAppliqationFixture } = require('@appliqation/automation-sdk/playwright');
-
-// Extend Playwright's base test with SDK fixture
-const test = createAppliqationFixture(base, {
-  baseUrl: process.env.APPLIQATION_BASE_URL,
-  apiKey: process.env.APPLIQATION_API_KEY
+// Use the SDK's test fixture instead of Playwright's default
+const { test, expect } = require('@appliqation/automation-sdk/playwright');
+
+test.describe('Authenticated Tests', () => {
+  test('should have valid JWT throughout test', async ({ page }) => {
+    // JWT is automatically refreshed if < 5 minutes remaining
+    await page.goto('/dashboard');
+    // Your test logic...
+  });
 });
-
-module.exports = { test };
 ```
 
 **What it does:**
@@ -806,7 +806,7 @@ Most commonly used SDK exports:
 
 **Reporter (for playwright.config.js):**
 ```javascript
-['@appliqation/automation-sdk/playwright', config]
+['@appliqation/automation-sdk/playwright/reporter', config]
 ```
 
 **Global Setup/Teardown:**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appliqation/automation-sdk",
-  "version": "2.1.10",
+  "version": "2.1.11",
   "description": "Appliqation Automation SDK with API key authentication, custom run titles, and framework-specific reporters",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -10,6 +10,10 @@
       "import": "./src/index.js"
     },
     "./playwright": {
+      "require": "./src/playwright/index.js",
+      "import": "./src/playwright/index.js"
+    },
+    "./playwright/reporter": {
       "require": "./src/reporters/playwright/index.js",
       "import": "./src/reporters/playwright/index.js"
     },
@@ -17,6 +21,10 @@
       "require": "./src/playwright/global-setup.js",
       "import": "./src/playwright/global-setup.js"
     },
+    "./playwright/global-teardown": {
+      "require": "./src/playwright/global-teardown.js",
+      "import": "./src/playwright/global-teardown.js"
+    },
     "./playwright/fixture": {
       "require": "./src/playwright/fixture.js",
       "import": "./src/playwright/fixture.js"

package/src/playwright/global-teardown.js

@@ -0,0 +1,42 @@
+/**
+ * Global Teardown for Playwright Tests
+ *
+ * This module performs cleanup operations after all tests have completed.
+ * It complements global-setup.js which handles JWT authentication setup.
+ *
+ * What it does:
+ * - Logs completion message
+ * - Cleans up environment variables
+ * - (Optionally) Removes authentication state files
+ *
+ * @module playwright/global-teardown
+ */
+
+/**
+ * Cleanup after all tests complete
+ *
+ * @param {Object} config - Playwright config object
+ * @returns {Promise<void>}
+ */
+async function globalTeardown(config) {
+  console.log('\n🧹 Global Teardown: Cleaning up test environment...\n');
+
+  // Clean up JWT token from environment (but keep .auth/jwt.json for debugging)
+  if (process.env.APPLIQATION_JWT_TOKEN) {
+    delete process.env.APPLIQATION_JWT_TOKEN;
+    console.log('  ✓ JWT token removed from environment');
+  }
+
+  // Optional: Uncomment to remove authentication state after tests
+  // const fs = require('fs');
+  // const path = require('path');
+  // const authPath = path.resolve('.auth/jwt.json');
+  // if (fs.existsSync(authPath)) {
+  //   fs.unlinkSync(authPath);
+  //   console.log('  ✓ Authentication state file removed');
+  // }
+
+  console.log('\n✅ Teardown complete!\n');
+}
+
+module.exports = globalTeardown;