@avalix/chroma 0.0.0

package/README.md

@@ -0,0 +1,135 @@
+# @avalix/chroma
+
+End-to-end testing library for Polkadot wallet interactions using Playwright.
+
+## Installation
+
+```bash
+npm install @avalix/chroma @playwright/test
+```
+
+**Note**: `@playwright/test` is a peer dependency and must be installed separately to avoid conflicts.
+
+## Quick Start
+
+### Using Default Polkadot JS Wallet
+
+```typescript
+import { test, expect } from '@avalix/chroma'
+
+test('should connect wallet and sign transaction', async ({ page, importAccount, authorize, approveTx }) => {
+  // Import a test account
+  await importAccount({
+    seed: 'bottom drive obey lake curtain smoke basket hold race lonely fit walk',
+    name: 'Test Account'
+  })
+
+  // Navigate to your dApp
+  await page.goto('http://localhost:3000')
+
+  // Connect wallet
+  await page.click('button:has-text("Connect Wallet")')
+  await authorize()
+
+  // Perform transaction
+  await page.click('button:has-text("Send Transaction")')
+  await approveTx()
+
+  // Verify transaction success
+  await expect(page.locator('.transaction-success')).toBeVisible()
+})
+```
+
+### Using Different Wallets
+
+```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
+const customTest = createWalletTest({
+  walletType: 'polkadot-js',
+  walletConfig: { 
+    customPath: './my-custom-extension'
+  }
+})
+
+polkadotTest('test with Polkadot JS', async ({ page, walletType, walletConfig, importAccount }) => {
+  console.log('Using wallet:', walletType) // 'polkadot-js'
+  // ... your test code
+})
+```
+
+## 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
+- 🔗 **dApp Authorization**: Connect wallet to decentralized applications
+
+## API Reference
+
+### Test Fixtures
+
+#### `importAccount(options: WalletAccount)`
+Import a wallet account using seed phrase.
+
+```typescript
+await importAccount({
+  seed: 'your twelve word seed phrase here...',
+  name: 'My Test Account',
+  password: 'securePassword123'
+})
+```
+
+#### `authorize()`
+Authorize the dApp to connect with the wallet.
+
+```typescript
+await authorize()
+```
+
+#### `approveTx(options?)`
+Approve a transaction with the wallet password.
+
+```typescript
+await approveTx({ password: 'myPassword' })
+```
+
+### Utility Functions
+
+#### `downloadAndExtractPolkadotExtension(targetDir?)`
+Download and extract Polkadot JS extension to specified directory.
+
+```typescript
+import { downloadAndExtractPolkadotExtension } from '@chroma/core'
+
+// Download to custom directory
+const extensionPath = await downloadAndExtractPolkadotExtension('./my-extensions')
+
+// Download to default directory (./extensions)
+const extensionPath = await downloadAndExtractPolkadotExtension()
+```
+
+## 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.
+
+## Requirements
+
+- Node.js 18+
+- Playwright
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@avalix/chroma",
+  "version": "0.0.0",
+  "description": "End-to-end testing library for Polkadot wallet interactions",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch"
+  },
+  "keywords": [
+    "polkadot",
+    "wallet",
+    "testing",
+    "e2e",
+    "playwright",
+    "automation",
+    "blockchain"
+  ],
+  "author": "Avalix Labs",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/avalix-labs/chroma.git",
+    "directory": "packages/chroma"
+  },
+  "bugs": {
+    "url": "https://github.com/avalix-labs/chroma/issues"
+  },
+  "homepage": "https://github.com/avalix-labs/chroma#readme",
+  "devDependencies": {
+    "@types/node": "^24.3.3",
+    "@types/unzipper": "^0.10.10",
+    "@playwright/test": "^1.55.0",
+    "tsdown": "latest"
+  },
+  "dependencies": {
+    "unzipper": "^0.12.3"
+  },
+  "peerDependencies": {
+    "@playwright/test": "^1.55.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}