external-services-automation 1.0.14 → 1.0.16

package/README.md

@@ -1,211 +1,211 @@
-# External Services Automation Library
-
-A TypeScript library for test automation with Playwright, focused on integrations with external services like Kinde (authentication) and Stripe (payments).
-
-## Installation
-
-Install the package via npm:
-
-```bash
-npm install external-services-automation
-```
-
-## Setup
-
-### Configure Your Test Framework
-
-The library can be used with any test framework. Here's an example for Playwright:
-
-```typescript
-// playwright.config.ts
-import { defineConfig } from '@playwright/test';
-
-export default defineConfig({
-  testDir: './tests',
-  use: {
-    baseURL: process.env.BASE_URL || 'https://your-app.com',
-  },
-});
-```
-
-## Usage
-
-### Import Components
-
-```typescript
-import { 
-  ExternalServicesWorld,
-  LoginPage,
-  RegisterPage,
-  KindeAuthService,
-  StripeService,
-  GuerrillaMailClient
-} from 'external-services-automation';
-```
-
-### Use Services and Page Objects
-
-```typescript
-// Authentication with Kinde
-const authService = new KindeAuthService();
-await authService.login(email, password);
-
-// Payment processing with Stripe
-const stripeService = new StripeService();
-await stripeService.upgradeSubscription(planType);
-
-// Page interactions
-const loginPage = new LoginPage(page);
-await loginPage.fillCredentials(email, password);
-```
-
-## Available Components
-
-### Services
-
-#### KindeAuthService
-- `login(email: string, password: string)` - Authenticates user with Kinde
-- `register(email: string, firstName: string, lastName: string)` - Creates new account
-- `verifyEmail(code: string)` - Verifies email with confirmation code
-
-#### StripeService
-- `upgradeSubscription(planType: string)` - Upgrades subscription to specified plan
-- `updatePaymentMethod(cardDetails: object)` - Updates payment method
-- `getCurrentSubscription()` - Retrieves current subscription details
-
-### Page Objects
-
-#### Kinde Pages
-- **LoginPage** - Handles login form interactions
-- **RegisterPage** - Manages account registration
-- **ConfirmCodePage** - Email verification code entry
-- **PasswordSetupPage** - Password creation and setup
-
-#### Stripe Pages
-- **CurrentSubscriptionPage** - Displays current subscription details
-- **UpdateSubscriptionPage** - Subscription plan selection
-- **UpdatePaymentMethodPage** - Payment method management
-- **ConfirmUpdatePage** - Confirmation dialogs
-- **LeftPanelPage** - Navigation and sidebar interactions
-
-### Utilities
-- **GuerrillaMailClient** - Temporary email handling for account verification
-  - `createTempEmail()` - Creates temporary email address
-  - `getVerificationCode()` - Retrieves verification emails
-  - `cleanup()` - Cleans up temporary email resources
-
-### World Extension
-- **ExternalServicesWorld** - Shared state management for test scenarios
-
-## Example Implementation
-
-```typescript
-// In your test files
-import { test, expect } from '@playwright/test';
-import { KindeAuthService, StripeService, GuerrillaMailClient } from 'external-services-automation';
-
-test.describe('External Services Integration', () => {
-  let authService: KindeAuthService;
-  let stripeService: StripeService;
-  let tempEmail: GuerrillaMailClient;
-
-  test.beforeEach(async () => {
-    authService = new KindeAuthService();
-    stripeService = new StripeService();
-  });
-
-  test('should create account and upgrade subscription', async () => {
-    // Create temporary email for account verification
-    tempEmail = new GuerrillaMailClient();
-    const email = await tempEmail.createTempEmail();
-    
-    // Register new account
-    await authService.register(email, 'John', 'Doe');
-    
-    // Verify email
-    const verificationCode = await tempEmail.getVerificationCode();
-    await authService.verifyEmail(verificationCode);
-    
-    // Upgrade subscription
-    await stripeService.upgradeSubscription('premium');
-    
-    // Verify subscription status
-    const subscription = await stripeService.getCurrentSubscription();
-    expect(subscription.status).toBe('active');
-    
-    // Cleanup
-    await tempEmail.cleanup();
-  });
-
-  test('should handle login with existing account', async () => {
-    const result = await authService.login('user@example.com', 'password123');
-    expect(result.success).toBe(true);
-  });
-});
-```
-
-## Updates
-
-To update to the latest version:
-
-```bash
-npm update external-services-automation
-```
-
-## CI/CD
-
-### Bitbucket Pipelines
-
-```yaml
-script:
-  - npm install
-  - npm test
-```
-
-## Dependencies
-
-The library requires the following peer dependencies to be installed in your project:
-
-```bash
-npm install @playwright/test axios-cookiejar-support dotenv tough-cookie
-```
-
-Version requirements:
-- `@playwright/test` ^1.40.0
-- `axios-cookiejar-support` ^6.0.2
-- `dotenv` ^16.4.5
-- `tough-cookie` ^5.1.2
-
-## Troubleshooting
-
-### Package Not Found
-```bash
-npm install external-services-automation
-```
-
-### Import Errors
-Make sure you're importing from the correct package name:
-```typescript
-import { KindeAuthService } from 'external-services-automation';
-```
-
-### Missing Peer Dependencies
-```bash
-npm install @playwright/test axios-cookiejar-support dotenv tough-cookie
-```
-
-## Development
-
-For contributors working on this library:
-
-```bash
-git clone https://bitbucket.org/connectist/external-services-automation.git
-cd external-services-automation
-npm install
-npm run build
-```
-
-## Links
-
-- **NPM Package**: https://www.npmjs.com/package/external-services-automation
+# External Services Automation Library
+
+A TypeScript library for test automation with Playwright, focused on integrations with external services like Kinde (authentication) and Stripe (payments).
+
+## Installation
+
+Install the package via npm:
+
+```bash
+npm install external-services-automation
+```
+
+## Setup
+
+### Configure Your Test Framework
+
+The library can be used with any test framework. Here's an example for Playwright:
+
+```typescript
+// playwright.config.ts
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  testDir: './tests',
+  use: {
+    baseURL: process.env.BASE_URL || 'https://your-app.com',
+  },
+});
+```
+
+## Usage
+
+### Import Components
+
+```typescript
+import { 
+  ExternalServicesWorld,
+  LoginPage,
+  RegisterPage,
+  KindeAuthService,
+  StripeService,
+  GuerrillaMailClient
+} from 'external-services-automation';
+```
+
+### Use Services and Page Objects
+
+```typescript
+// Authentication with Kinde
+const authService = new KindeAuthService();
+await authService.login(email, password);
+
+// Payment processing with Stripe
+const stripeService = new StripeService();
+await stripeService.upgradeSubscription(planType);
+
+// Page interactions
+const loginPage = new LoginPage(page);
+await loginPage.fillCredentials(email, password);
+```
+
+## Available Components
+
+### Services
+
+#### KindeAuthService
+- `login(email: string, password: string)` - Authenticates user with Kinde
+- `register(email: string, firstName: string, lastName: string)` - Creates new account
+- `verifyEmail(code: string)` - Verifies email with confirmation code
+
+#### StripeService
+- `upgradeSubscription(planType: string)` - Upgrades subscription to specified plan
+- `updatePaymentMethod(cardDetails: object)` - Updates payment method
+- `getCurrentSubscription()` - Retrieves current subscription details
+
+### Page Objects
+
+#### Kinde Pages
+- **LoginPage** - Handles login form interactions
+- **RegisterPage** - Manages account registration
+- **ConfirmCodePage** - Email verification code entry
+- **PasswordSetupPage** - Password creation and setup
+
+#### Stripe Pages
+- **CurrentSubscriptionPage** - Displays current subscription details
+- **UpdateSubscriptionPage** - Subscription plan selection
+- **UpdatePaymentMethodPage** - Payment method management
+- **ConfirmUpdatePage** - Confirmation dialogs
+- **LeftPanelPage** - Navigation and sidebar interactions
+
+### Utilities
+- **GuerrillaMailClient** - Temporary email handling for account verification
+  - `createTempEmail()` - Creates temporary email address
+  - `getVerificationCode()` - Retrieves verification emails
+  - `cleanup()` - Cleans up temporary email resources
+
+### World Extension
+- **ExternalServicesWorld** - Shared state management for test scenarios
+
+## Example Implementation
+
+```typescript
+// In your test files
+import { test, expect } from '@playwright/test';
+import { KindeAuthService, StripeService, GuerrillaMailClient } from 'external-services-automation';
+
+test.describe('External Services Integration', () => {
+  let authService: KindeAuthService;
+  let stripeService: StripeService;
+  let tempEmail: GuerrillaMailClient;
+
+  test.beforeEach(async () => {
+    authService = new KindeAuthService();
+    stripeService = new StripeService();
+  });
+
+  test('should create account and upgrade subscription', async () => {
+    // Create temporary email for account verification
+    tempEmail = new GuerrillaMailClient();
+    const email = await tempEmail.createTempEmail();
+    
+    // Register new account
+    await authService.register(email, 'John', 'Doe');
+    
+    // Verify email
+    const verificationCode = await tempEmail.getVerificationCode();
+    await authService.verifyEmail(verificationCode);
+    
+    // Upgrade subscription
+    await stripeService.upgradeSubscription('premium');
+    
+    // Verify subscription status
+    const subscription = await stripeService.getCurrentSubscription();
+    expect(subscription.status).toBe('active');
+    
+    // Cleanup
+    await tempEmail.cleanup();
+  });
+
+  test('should handle login with existing account', async () => {
+    const result = await authService.login('user@example.com', 'password123');
+    expect(result.success).toBe(true);
+  });
+});
+```
+
+## Updates
+
+To update to the latest version:
+
+```bash
+npm update external-services-automation
+```
+
+## CI/CD
+
+### Bitbucket Pipelines
+
+```yaml
+script:
+  - npm install
+  - npm test
+```
+
+## Dependencies
+
+The library requires the following peer dependencies to be installed in your project:
+
+```bash
+npm install @playwright/test axios-cookiejar-support dotenv tough-cookie
+```
+
+Version requirements:
+- `@playwright/test` ^1.40.0
+- `axios-cookiejar-support` ^6.0.2
+- `dotenv` ^16.4.5
+- `tough-cookie` ^5.1.2
+
+## Troubleshooting
+
+### Package Not Found
+```bash
+npm install external-services-automation
+```
+
+### Import Errors
+Make sure you're importing from the correct package name:
+```typescript
+import { KindeAuthService } from 'external-services-automation';
+```
+
+### Missing Peer Dependencies
+```bash
+npm install @playwright/test axios-cookiejar-support dotenv tough-cookie
+```
+
+## Development
+
+For contributors working on this library:
+
+```bash
+git clone https://bitbucket.org/connectist/external-services-automation.git
+cd external-services-automation
+npm install
+npm run build
+```
+
+## Links
+
+- **NPM Package**: https://www.npmjs.com/package/external-services-automation
 - **Repository**: https://bitbucket.org/connectist/external-services-automation 

package/dist/pages/kinde/PasswordSetupPage.d.ts

@@ -6,7 +6,6 @@ export declare class PasswordSetupPage {
     readonly confirmPasswordInput: Locator;
     readonly continueButton: Locator;
     readonly dontUseMFAButton: Locator;
-    readonly verifyYourIdentityTitle: Locator;
     constructor(page: Page);
     enterPassword(password: string): Promise<void>;
     enterConfirmPassword(password: string): Promise<void>;

package/dist/pages/kinde/PasswordSetupPage.js

@@ -10,7 +10,6 @@ class PasswordSetupPage {
         this.confirmPasswordInput = page.locator('input[name="p_second_password"]');
         this.continueButton = page.locator('button[type="submit"]:has-text("Continue")');
         this.dontUseMFAButton = page.locator('//button[contains(text(), "multi-factor authentication")]');
-        this.verifyYourIdentityTitle = page.locator('//h1[text()="Verify your identity"]');
     }
     async enterPassword(password) {
         await this.passwordInput.fill(password);
@@ -33,13 +32,10 @@ class PasswordSetupPage {
         await (0, test_1.expect)(this.continueButton).toBeVisible();
     }
     async dontUseMFA() {
-        console.log("entered dontUseMFA");
-        await this.verifyYourIdentityTitle.waitFor({ state: "visible", timeout: 10000 });
-        if (await this.verifyYourIdentityTitle.isVisible()) {
+        await this.page.waitForTimeout(3000);
+        if (await this.dontUseMFAButton.isVisible()) {
             await this.dontUseMFAButton.click();
-            console.log("clicked dontUseMFA");
         }
-        console.log("exited dontUseMFA");
     }
 }
 exports.PasswordSetupPage = PasswordSetupPage;

package/dist/pages/stripe/UpdatePaymentMethodPage.js

@@ -24,12 +24,10 @@ class UpdatePaymentMethodPage {
         const zipCode = '12345';
         try {
             await this.stripeIframe.waitFor({ state: 'visible' });
-            // Get the iframe element and switch to it
             const iframeElement = await this.stripeIframe.elementHandle();
             if (!iframeElement) {
                 throw new Error('Stripe iframe not found');
             }
-            // Switch to the iframe context
             const iframePage = await iframeElement.contentFrame();
             if (!iframePage) {
                 throw new Error('Could not access iframe content');

package/dist/services/KindeAuthService.d.ts

@@ -8,6 +8,6 @@ export declare class KindeAuthService {
     private confirmCodePage;
     private passwordSetupPage;
     constructor(page: Page);
-    createAccountWithEmailVerification(): Promise<void>;
+    createAccountWithEmailVerification(): Promise<string>;
     deleteTemporaryEmail(): Promise<void>;
 }

package/dist/services/KindeAuthService.js

@@ -39,6 +39,7 @@ class KindeAuthService {
         const password = 'TestPassword123!';
         await this.passwordSetupPage.submitPasswordForm(password);
         await this.passwordSetupPage.dontUseMFA();
+        return this.tempEmail;
     }
     async deleteTemporaryEmail() {
         if (this.tempEmail) {

package/dist/utils/temp-email-utils.d.ts

@@ -1,4 +1,3 @@
-/** Structure returned by Guerrilla Mail for a single message */
 export interface GuerrillaEmail {
     mail_id: string;
     mail_subject: string;
@@ -15,34 +14,11 @@ declare class GuerrillaMailClient {
     private emailAddress;
     private client;
     constructor();
-    /**
-     * Function 1: Crea un email temporal. Si se pasa un alias se fuerza ese usuario.
-     * @param alias Nombre de usuario deseado (sin dominio).
-     * @returns Dirección de email completa.
-     */
     createMail(alias?: string): Promise<string>;
-    /**
-     * Function 2: Lee la bandeja y devuelve el email MÁS RECIENTE cuyo subject matchee con subjectRegex.
-     * Hace polling hasta timeout.
-     * @param subjectRegex Expresión regular a matchear con el asunto.
-     * @param timeoutMs Tiempo máximo a esperar (ms).
-     * @param pollMs Intervalo entre consultas (ms).
-     */
     readMailBySubject(subjectRegex: RegExp, timeoutMs?: number, pollMs?: number): Promise<GuerrillaEmail>;
-    /**
-     * Function 3: Elimina un correo específico del servidor.
-     * @param mailId ID retornado por la API (mail_id).
-     */
     deleteMail(mailId: string): Promise<void>;
-    /** Helper interno para descargar cuerpo completo */
     private fetchEmail;
-    /**
-     * Function 4: Crea una nueva instancia de email client para aislamiento entre escenarios
-     */
     static createIsolatedClient(): GuerrillaMailClient;
-    /**
-     * Function 5: Elimina todos los emails del buzón actual
-     */
     clearInbox(): Promise<void>;
 }
 export declare const email: GuerrillaMailClient;

package/dist/utils/temp-email-utils.js

@@ -19,16 +19,10 @@ class GuerrillaMailClient {
             jar,
             withCredentials: true,
             headers: {
-                // Recommended to identify politely
                 'User-Agent': 'qa-automation-utils/1.0',
             },
         }));
     }
-    /**
-     * Function 1: Crea un email temporal. Si se pasa un alias se fuerza ese usuario.
-     * @param alias Nombre de usuario deseado (sin dominio).
-     * @returns Dirección de email completa.
-     */
     async createMail(alias) {
         if (alias) {
             const { data } = await this.client.get(this.API_URL, {
@@ -53,13 +47,6 @@ class GuerrillaMailClient {
         }
         return this.emailAddress;
     }
-    /**
-     * Function 2: Lee la bandeja y devuelve el email MÁS RECIENTE cuyo subject matchee con subjectRegex.
-     * Hace polling hasta timeout.
-     * @param subjectRegex Expresión regular a matchear con el asunto.
-     * @param timeoutMs Tiempo máximo a esperar (ms).
-     * @param pollMs Intervalo entre consultas (ms).
-     */
     async readMailBySubject(subjectRegex, timeoutMs = 60000, pollMs = 5000) {
         const start = Date.now();
         while (Date.now() - start < timeoutMs) {
@@ -73,35 +60,27 @@ class GuerrillaMailClient {
             });
             this.seq = data.seq ?? this.seq;
             const list = data.list ?? [];
-            // Filtrar emails que matchean el subject
             const matches = list.filter(m => subjectRegex.test(m.mail_subject));
             if (matches.length > 0) {
-                // Ordenar por timestamp descendente (más reciente primero)
                 matches.sort((a, b) => b.mail_timestamp - a.mail_timestamp);
-                // Tomar el más reciente
                 const mostRecent = matches[0];
                 const full = await this.fetchEmail(mostRecent.mail_id);
                 return full;
             }
             await new Promise(r => setTimeout(r, pollMs));
         }
-        throw new Error(`Timeout (${timeoutMs} ms) esperando un email con asunto que matchee ${subjectRegex}`);
+        throw new Error(`Timeout (${timeoutMs} ms) waiting for an email with subject matching ${subjectRegex}`);
     }
-    /**
-     * Function 3: Elimina un correo específico del servidor.
-     * @param mailId ID retornado por la API (mail_id).
-     */
     async deleteMail(mailId) {
         await this.client.get(this.API_URL, {
             params: {
                 f: 'del_email',
-                email_ids: `[${mailId}]`, // formato aceptado por la API
+                email_ids: `[${mailId}]`,
                 ip: this.ip,
                 agent: this.agent,
             },
         });
     }
-    /** Helper interno para descargar cuerpo completo */
     async fetchEmail(mailId) {
         const { data } = await this.client.get(this.API_URL, {
             params: {
@@ -113,15 +92,9 @@ class GuerrillaMailClient {
         });
         return data;
     }
-    /**
-     * Function 4: Crea una nueva instancia de email client para aislamiento entre escenarios
-     */
     static createIsolatedClient() {
         return new GuerrillaMailClient();
     }
-    /**
-     * Function 5: Elimina todos los emails del buzón actual
-     */
     async clearInbox() {
         const { data } = await this.client.get(this.API_URL, {
             params: {
@@ -132,7 +105,6 @@ class GuerrillaMailClient {
             },
         });
         const list = data.list ?? [];
-        // Eliminar todos los emails uno por uno
         for (const email of list) {
             try {
                 await this.deleteMail(email.mail_id);

package/package.json

@@ -1,43 +1,43 @@
-{
-  "name": "external-services-automation",
-  "version": "1.0.14",
-  "description": "External services automation library for Playwright and Cucumber",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist/",
-    "README.md",
-    "package.json"
-  ],
-  "keywords": [
-    "playwright",
-    "automation",
-    "testing",
-    "kinde",
-    "stripe",
-    "external-services"
-  ],
-  "author": "Email Awesome Team",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://bitbucket.org/connectist/external-services-automation.git"
-  },
-  "scripts": {
-    "build": "tsc",
-    "build:watch": "tsc --watch",
-    "clean": "rm -rf dist",
-    "prebuild": "npm run clean",
-    "test": "echo \"No tests specified\" && exit 0",
-    "prepublishOnly": "npm run build"
-  },
-  "peerDependencies": {
-    "@playwright/test": "^1.40.0",
-    "axios-cookiejar-support": "^6.0.2",
-    "tough-cookie": "^5.1.2"
-  },
-  "devDependencies": {
-    "@types/node": "^22.5.4",
-    "typescript": "^5.5.4"
-  }
-}
+{
+  "name": "external-services-automation",
+  "version": "1.0.16",
+  "description": "External services automation library for Playwright and Cucumber",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "README.md",
+    "package.json"
+  ],
+  "keywords": [
+    "playwright",
+    "automation",
+    "testing",
+    "kinde",
+    "stripe",
+    "external-services"
+  ],
+  "author": "Email Awesome Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://bitbucket.org/connectist/external-services-automation.git"
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rm -rf dist",
+    "prebuild": "npm run clean",
+    "test": "echo \"No tests specified\" && exit 0",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@playwright/test": "^1.40.0",
+    "axios-cookiejar-support": "^6.0.2",
+    "tough-cookie": "^5.1.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.5.4",
+    "typescript": "^5.5.4"
+  }
+}