browserwing 0.0.1

package/PUBLISHING.md

@@ -0,0 +1,141 @@
+# NPM Publishing Guide
+
+This document explains how to publish BrowserWing to npm.
+
+## Prerequisites
+
+1. **NPM Account**: Create an account at https://www.npmjs.com
+2. **NPM Authentication**: Login via `npm login`
+3. **GitHub Release**: Create a GitHub release with binaries first
+
+## Publishing Process
+
+### Manual Publishing
+
+1. **Update Version**
+   ```bash
+   cd npm
+   npm version <new-version>  # e.g., npm version 0.0.2
+   ```
+
+2. **Verify Files**
+   ```bash
+   npm pack --dry-run
+   ```
+
+3. **Test Installation Locally**
+   ```bash
+   npm link
+   browserwing --help
+   npm unlink
+   ```
+
+4. **Publish**
+   ```bash
+   ./publish.sh
+   # Or manually:
+   npm publish
+   ```
+
+### Automated Publishing (via GitHub Actions)
+
+When you create a new GitHub Release:
+
+1. Tag format: `v0.0.1` (must start with 'v')
+2. Upload all platform binaries to the release
+3. Publish the release
+4. GitHub Actions will automatically:
+   - Update package.json version
+   - Publish to npm
+   - Add comment to release
+
+**Setup Required:**
+- Add `NPM_TOKEN` to GitHub Secrets
+  1. Generate token at https://www.npmjs.com/settings/[username]/tokens
+  2. Go to GitHub repo → Settings → Secrets → New repository secret
+  3. Name: `NPM_TOKEN`, Value: your token
+
+## Package Structure
+
+```
+npm/
+├── package.json          # NPM package manifest
+├── install.js           # Post-install script (downloads binary)
+├── bin/
+│   └── browserwing      # Node wrapper script
+├── README.md            # NPM package README
+└── .npmignore           # Files to exclude from package
+```
+
+## How It Works
+
+1. User runs `npm install -g browserwing`
+2. NPM downloads the package (without binaries)
+3. `postinstall` script runs (`install.js`)
+4. Script detects OS/architecture
+5. Downloads appropriate binary from GitHub Releases
+6. Places binary in `bin/` directory
+7. NPM creates symlink to `bin/browserwing`
+
+## Testing
+
+### Test Local Package
+
+```bash
+cd npm
+npm pack
+npm install -g browserwing-0.0.1.tgz
+browserwing --version
+npm uninstall -g browserwing
+```
+
+### Test Published Package
+
+```bash
+npm install -g browserwing
+browserwing --version
+npm uninstall -g browserwing
+```
+
+## Troubleshooting
+
+**Binary not downloading:**
+- Check GitHub release exists with correct version
+- Verify binary naming: `browserwing-{platform}-{arch}[.exe]`
+- Check network/proxy settings
+
+**Permission issues:**
+- Use `sudo npm install -g browserwing` on Unix systems
+- Or install without `-g` and use `npx browserwing`
+
+**Platform not supported:**
+- Check `install.js` platform/arch mappings
+- Ensure binaries exist for that platform
+
+## Version Management
+
+- Keep `npm/package.json` version in sync with GitHub releases
+- Use semver format: MAJOR.MINOR.PATCH
+- Tag releases with 'v' prefix: `v0.0.1`
+
+## Maintenance
+
+**Unpublish a version (within 72 hours):**
+```bash
+npm unpublish browserwing@0.0.1
+```
+
+**Deprecate a version:**
+```bash
+npm deprecate browserwing@0.0.1 "Critical bug, use 0.0.2+"
+```
+
+**Update package info without republishing:**
+- Update README, keywords, etc. in package.json
+- Publish new patch version
+
+## References
+
+- NPM Publishing: https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry
+- Semantic Versioning: https://semver.org/
+- Package.json: https://docs.npmjs.com/cli/v10/configuring-npm/package-json

package/README.md

@@ -0,0 +1,46 @@
+# BrowserWing
+
+Native Browser Automation Platform with AI Integration
+
+## Installation
+
+```bash
+# Using npm
+npm install -g browserwing
+
+# Using pnpm
+pnpm add -g browserwing
+
+# Using yarn
+yarn global add browserwing
+```
+
+## Quick Start
+
+```bash
+# Start BrowserWing server
+browserwing --port 8080
+
+# Open in browser
+# http://localhost:8080
+```
+
+## Features
+
+- **Complete Browser Control**: 26+ HTTP API endpoints for full-featured browser automation
+- **Built-in AI Agent**: Direct conversational interface for browser automation tasks
+- **Universal AI Tool Integration**: Native MCP & Skills protocol support
+- **Visual Script Recording**: Record, edit, and replay browser actions
+- **Flexible Export Options**: Convert scripts to MCP commands or Skills files
+- **Intelligent Data Extraction**: LLM-powered semantic extraction
+- **Session Management**: Robust cookie and storage handling
+
+## Documentation
+
+- Website: https://browserwing.com
+- GitHub: https://github.com/browserwing/browserwing
+- Issues: https://github.com/browserwing/browserwing/issues
+
+## License
+
+MIT

package/bin/browserwing

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+
+// Determine binary name based on platform
+const isWindows = process.platform === 'win32';
+const binaryName = isWindows ? 'browserwing.exe' : 'browserwing';
+const binaryPath = path.join(__dirname, binaryName);
+
+// Check if binary exists
+const fs = require('fs');
+if (!fs.existsSync(binaryPath)) {
+  console.error('BrowserWing binary not found. Please reinstall the package.');
+  console.error('Run: npm install browserwing');
+  process.exit(1);
+}
+
+// Spawn the binary with all arguments
+const child = spawn(binaryPath, process.argv.slice(2), {
+  stdio: 'inherit',
+  windowsHide: false
+});
+
+child.on('exit', (code) => {
+  process.exit(code);
+});
+
+child.on('error', (err) => {
+  console.error('Failed to start BrowserWing:', err);
+  process.exit(1);
+});

package/install.js

@@ -0,0 +1,120 @@
+#!/usr/bin/env node
+
+const https = require('https');
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+const REPO = 'browserwing/browserwing';
+const PACKAGE_VERSION = require('./package.json').version;
+
+// Platform mapping
+const PLATFORM_MAP = {
+  darwin: 'darwin',
+  linux: 'linux',
+  win32: 'windows'
+};
+
+const ARCH_MAP = {
+  x64: 'amd64',
+  arm64: 'arm64',
+  arm: 'armv7'
+};
+
+function getPlatform() {
+  const platform = PLATFORM_MAP[process.platform];
+  const arch = ARCH_MAP[process.arch];
+  
+  if (!platform || !arch) {
+    throw new Error(`Unsupported platform: ${process.platform}-${process.arch}`);
+  }
+  
+  return { platform, arch };
+}
+
+function getDownloadURL(version, platform, arch) {
+  const binaryName = platform === 'windows' 
+    ? `browserwing-${platform}-${arch}.exe`
+    : `browserwing-${platform}-${arch}`;
+  
+  return `https://github.com/${REPO}/releases/download/v${version}/${binaryName}`;
+}
+
+function downloadFile(url, dest) {
+  return new Promise((resolve, reject) => {
+    console.log(`Downloading BrowserWing from ${url}...`);
+    
+    const file = fs.createWriteStream(dest);
+    
+    https.get(url, { 
+      headers: { 'User-Agent': 'browserwing-npm-installer' }
+    }, (response) => {
+      // Handle redirects
+      if (response.statusCode === 302 || response.statusCode === 301) {
+        return https.get(response.headers.location, (redirectResponse) => {
+          redirectResponse.pipe(file);
+          file.on('finish', () => {
+            file.close();
+            resolve();
+          });
+        }).on('error', reject);
+      }
+      
+      if (response.statusCode !== 200) {
+        reject(new Error(`Failed to download: ${response.statusCode}`));
+        return;
+      }
+      
+      response.pipe(file);
+      
+      file.on('finish', () => {
+        file.close();
+        resolve();
+      });
+    }).on('error', (err) => {
+      fs.unlink(dest, () => {});
+      reject(err);
+    });
+  });
+}
+
+async function install() {
+  try {
+    const { platform, arch } = getPlatform();
+    console.log(`Installing BrowserWing for ${platform}-${arch}...`);
+    
+    // Create bin directory
+    const binDir = path.join(__dirname, 'bin');
+    if (!fs.existsSync(binDir)) {
+      fs.mkdirSync(binDir, { recursive: true });
+    }
+    
+    // Determine binary name
+    const binaryName = platform === 'windows' ? 'browserwing.exe' : 'browserwing';
+    const binaryPath = path.join(binDir, binaryName);
+    
+    // Download binary
+    const downloadURL = getDownloadURL(PACKAGE_VERSION, platform, arch);
+    await downloadFile(downloadURL, binaryPath);
+    
+    // Make executable on Unix-like systems
+    if (platform !== 'windows') {
+      fs.chmodSync(binaryPath, 0o755);
+    }
+    
+    console.log('BrowserWing installed successfully!');
+    console.log('');
+    console.log('Quick start:');
+    console.log('  browserwing --port 8080');
+    console.log('  Open http://localhost:8080');
+    
+  } catch (error) {
+    console.error('Installation failed:', error.message);
+    console.error('');
+    console.error('You can manually download from:');
+    console.error(`https://github.com/${REPO}/releases`);
+    process.exit(1);
+  }
+}
+
+install();

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "browserwing",
+  "version": "0.0.1",
+  "description": "Native Browser Automation Platform with AI Integration",
+  "keywords": [
+    "browser",
+    "automation",
+    "mcp",
+    "skills",
+    "ai",
+    "llm",
+    "rpa",
+    "web-automation"
+  ],
+  "homepage": "https://browserwing.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/browserwing/browserwing.git"
+  },
+  "bugs": {
+    "url": "https://github.com/browserwing/browserwing/issues"
+  },
+  "license": "MIT",
+  "author": "BrowserWing Team",
+  "bin": {
+    "browserwing": "bin/browserwing"
+  },
+  "scripts": {
+    "postinstall": "node install.js"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ]
+}

package/publish.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+set -e
+
+# NPM Publishing Script for BrowserWing
+
+echo "╔════════════════════════════════════════╗"
+echo "║   BrowserWing NPM Publishing Script   ║"
+echo "╚════════════════════════════════════════╝"
+echo ""
+
+# Check if logged in to npm
+if ! npm whoami &> /dev/null; then
+  echo "Error: Not logged in to npm"
+  echo "Please run: npm login"
+  exit 1
+fi
+
+# Get version from package.json
+VERSION=$(node -p "require('./package.json').version")
+echo "Publishing version: $VERSION"
+echo ""
+
+# Verify the version matches a GitHub release
+echo "Verifying GitHub release exists..."
+RELEASE_URL="https://api.github.com/repos/browserwing/browserwing/releases/tags/v${VERSION}"
+if ! curl -sf "$RELEASE_URL" > /dev/null; then
+  echo "Error: GitHub release v${VERSION} not found"
+  echo "Please create a GitHub release first"
+  exit 1
+fi
+
+echo "✓ GitHub release v${VERSION} found"
+echo ""
+
+# Dry run first
+echo "Running npm publish --dry-run..."
+npm publish --dry-run
+
+echo ""
+echo "Ready to publish to npm?"
+read -p "Continue? (y/N) " -n 1 -r
+echo ""
+
+if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+  echo "Cancelled"
+  exit 1
+fi
+
+# Publish to npm
+echo "Publishing to npm..."
+npm publish
+
+echo ""
+echo "✓ Successfully published browserwing@${VERSION} to npm!"
+echo ""
+echo "Users can now install with:"
+echo "  npm install -g browserwing"
+echo "  pnpm add -g browserwing"