@avalix/chroma 0.0.3 → 0.0.5

package/README.md

@@ -2,6 +2,8 @@
 
 End-to-end testing library for Polkadot wallet interactions using Playwright.
 
+> **Current Status**: This library currently supports **Polkadot JS Extension** only. Support for other wallets like Talisman is planned for future releases.
+
 ## Installation
 
 ```bash
@@ -12,7 +14,7 @@ npm install @avalix/chroma @playwright/test
 
 ## Quick Start
 
-### Using Default Polkadot JS Wallet
+### Basic Usage
 
 ```typescript
 import { expect, test } from '@avalix/chroma'
@@ -21,7 +23,8 @@ test('should connect wallet and sign transaction', async ({ page, importAccount,
   // Import a test account
   await importAccount({
     seed: 'bottom drive obey lake curtain smoke basket hold race lonely fit walk',
-    name: 'Test Account'
+    name: 'Test Account',
+    password: 'securePassword123'
   })
 
   // Navigate to your dApp
@@ -33,58 +36,91 @@ test('should connect wallet and sign transaction', async ({ page, importAccount,
 
   // Perform transaction
   await page.click('button:has-text("Send Transaction")')
-  await approveTx()
+  await approveTx({ password: 'securePassword123' })
 
   // Verify transaction success
   await expect(page.locator('.transaction-success')).toBeVisible()
 })
 ```
 
-### Using Different Wallets
+### Custom Configuration
 
 ```typescript
 import { createWalletTest, expect } from '@avalix/chroma'
 
-// Create test with Polkadot JS wallet (default)
-const polkadotTest = createWalletTest({
-  walletType: 'polkadot-js'
-})
-
-// Create test with Talisman wallet (coming soon)
-const talismanTest = createWalletTest({
-  walletType: 'talisman'
-})
-
-// Create test with custom extension path
+// Create test with custom configuration
 const customTest = createWalletTest({
   walletType: 'polkadot-js',
   walletConfig: {
     customPath: './my-custom-extension'
-  }
+  },
+  headless: false,
+  slowMo: 100
 })
 
-polkadotTest('test with Polkadot JS', async ({ page, walletType, walletConfig, importAccount }) => {
-  console.log('Using wallet:', walletType) // 'polkadot-js'
-  // ... your test code
+customTest('test with custom config', async ({ page, importAccount, authorize }) => {
+  // Your test code here
+  await importAccount({
+    seed: 'your seed phrase here...',
+    name: 'My Test Account'
+  })
+  // ... rest of your test
 })
 ```
 
 ## Features
 
 - 🔐 **Automatic Extension Setup**: Downloads and configures Polkadot JS extension automatically
-- 🧪 **Wallet Fixtures**: Ready-to-use fixtures for wallet operations
-- 📝 **Account Management**: Import accounts with seed phrases
-- ✅ **Transaction Approval**: Approve transactions with password
+- 🧪 **Test Fixtures**: Ready-to-use Playwright fixtures for wallet operations
+- 📝 **Account Management**: Import accounts with seed phrases and custom names
+- ✅ **Transaction Approval**: Approve transactions with password authentication
 - 🔗 **dApp Authorization**: Connect wallet to decentralized applications
+- ⚙️ **Configurable**: Custom extension paths, headless mode, and slow motion settings
 
 ## API Reference
 
+### Core Functions
+
+#### `test` (Default Test Function)
+Pre-configured test function with Polkadot JS extension.
+
+```typescript
+import { test } from '@avalix/chroma'
+
+test('my wallet test', async ({ page, importAccount, authorize, approveTx }) => {
+  // Test implementation
+})
+```
+
+#### `createWalletTest(options?: ChromaTestOptions)`
+Create a custom test function with specific configuration.
+
+```typescript
+import { createWalletTest } from '@avalix/chroma'
+
+const customTest = createWalletTest({
+  walletType: 'polkadot-js', // Currently only 'polkadot-js' is supported
+  walletConfig: {
+    customPath: './custom-extension', // Optional: path to custom extension
+    downloadUrl: 'https://...' // Optional: custom download URL
+  },
+  headless: false, // Optional: run in headless mode (default: false)
+  slowMo: 150 // Optional: slow motion delay in ms (default: 150)
+})
+```
+
 ### Test Fixtures
 
 #### `importAccount(options: WalletAccount)`
 Import a wallet account using seed phrase.
 
 ```typescript
+interface WalletAccount {
+  seed: string
+  name?: string // Default: 'Test Account'
+  password?: string // Default: 'h3llop0lkadot!'
+}
+
 await importAccount({
   seed: 'your twelve word seed phrase here...',
   name: 'My Test Account',
@@ -93,7 +129,7 @@ await importAccount({
 ```
 
 #### `authorize()`
-Authorize the dApp to connect with the wallet.
+Authorize the dApp to connect with the wallet. Call this after triggering wallet connection from your dApp.
 
 ```typescript
 await authorize()
@@ -104,6 +140,9 @@ Approve a transaction with the wallet password.
 
 ```typescript
 await approveTx({ password: 'myPassword' })
+
+// Or use default password
+await approveTx()
 ```
 
 ### Utility Functions
@@ -112,23 +151,59 @@ await approveTx({ password: 'myPassword' })
 Download and extract Polkadot JS extension to specified directory.
 
 ```typescript
-import { downloadAndExtractPolkadotExtension } from '@chroma/core'
+import { downloadAndExtractPolkadotExtension } from '@avalix/chroma'
 
 // Download to custom directory
 const extensionPath = await downloadAndExtractPolkadotExtension('./my-extensions')
 
-// Download to default directory (./extensions)
+// Download to default directory (./.chroma)
 const extensionPath = await downloadAndExtractPolkadotExtension()
 ```
 
+### TypeScript Types
+
+```typescript
+import type {
+  ChromaTestOptions,
+  WalletAccount,
+  WalletConfig,
+  WalletFixtures,
+  WalletType
+} from '@avalix/chroma'
+```
+
 ## Configuration
 
-The extension will be automatically downloaded to `./extensions` directory in your project root. You can customize this by passing a different path to the download function.
+### Default Directory
+The Polkadot JS extension will be automatically downloaded to `./.chroma` directory in your project root. You can customize this by:
+
+1. Using `downloadAndExtractPolkadotExtension('./custom-path')`
+2. Using `createWalletTest()` with `walletConfig.customPath`
+
+### Browser Settings
+- **Headless Mode**: Disabled by default for better debugging
+- **Slow Motion**: 150ms delay between actions (configurable)
+- **Extension Loading**: Automatically loads only the Polkadot JS extension
+
+## Supported Wallets
+
+| Wallet | Status | Version |
+|--------|--------|---------|
+| Polkadot JS Extension | ✅ Supported | v0.61.7 |
+| Talisman | ⏳ Planned | - |
+| SubWallet | ⏳ Planned | - |
 
 ## Requirements
 
 - Node.js 18+
-- Playwright
+- @playwright/test ^1.55.0
+
+## Contributing
+
+This project is in active development. Currently focusing on:
+- Polkadot JS Extension support
+- Core testing fixtures
+- Documentation improvements
 
 ## License
 

package/dist/index.js

@@ -8,7 +8,7 @@ import { Extract } from "unzipper";
 //#region src/context-playwright/download-polkadot-js.ts
 const POLKADOT_JS_EXTENSION = "https://github.com/polkadot-js/extension/releases/download/v0.61.7/master-chrome-build.zip";
 async function downloadAndExtractPolkadotExtension(targetDir) {
-	const extensionsDir = targetDir || path.resolve(process.cwd(), "node_modules/.chroma");
+	const extensionsDir = targetDir || path.resolve(process.cwd(), ".chroma");
 	const extensionDir = path.join(extensionsDir, "polkadot-extension-chrome");
 	const zipPath = path.join(extensionsDir, "polkadot-extension.zip");
 	await fs.promises.mkdir(extensionsDir, { recursive: true });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@avalix/chroma",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "End-to-end testing library for Polkadot wallet interactions",
   "author": "Avalix Labs",
   "license": "MIT",