api-response-manager 1.0.0

package/README.md

@@ -0,0 +1,356 @@
+# ARM CLI - API Response Manager Command Line Interface
+
+Command-line interface for API Response Manager. Manage tunnels, webhooks, and projects from your terminal.
+
+## Installation
+
+### Option 1: Install from npm (Recommended)
+```bash
+npm install -g @arm/cli
+```
+
+After installation, verify:
+```bash
+arm --version
+arm --help
+```
+
+### Option 2: Install from Source
+```bash
+# Clone the repository
+git clone https://github.com/vijaypurohit322/api-response-manager.git
+cd api-response-manager/cli
+
+# Install dependencies
+npm install
+
+# Link globally
+npm link
+
+# Verify installation
+arm --version
+```
+
+### Option 3: Use with npx (No Installation)
+```bash
+npx @arm/cli login
+npx @arm/cli tunnel 3000
+npx @arm/cli webhook
+```
+
+## Quick Start
+
+### 1. Login
+```bash
+arm login
+# Or provide credentials directly
+arm login -e your@email.com -p yourpassword
+```
+
+### 2. Start a Tunnel
+```bash
+# Expose local port 3000
+arm tunnel 3000
+
+# With custom subdomain
+arm tunnel 3000 --subdomain myapi
+
+# With authentication
+arm tunnel 3000 --auth --rate-limit 100
+```
+
+### 3. Create a Webhook
+```bash
+# Basic webhook
+arm webhook
+
+# With forwarding to URL
+arm webhook --forward http://localhost:4000/webhook
+
+# With forwarding to tunnel
+arm webhook --tunnel <tunnel-id>
+```
+
+## Commands
+
+### Authentication
+
+#### `arm login`
+Authenticate with API Response Manager
+```bash
+arm login
+arm login -e email@example.com -p password
+```
+
+#### `arm logout`
+Logout from API Response Manager
+```bash
+arm logout
+```
+
+### Tunnels
+
+#### `arm tunnel <port>`
+Start a tunnel to expose local server
+```bash
+arm tunnel 3000
+arm tunnel 3000 --subdomain myapi --name "My API"
+arm tunnel 3000 --auth --rate-limit 100
+```
+
+Options:
+- `-s, --subdomain <subdomain>` - Custom subdomain
+- `-n, --name <name>` - Tunnel name
+- `-a, --auth` - Enable basic authentication
+- `-r, --rate-limit <limit>` - Rate limit (requests per minute, default: 60)
+
+#### `arm tunnel:list`
+List all active tunnels
+```bash
+arm tunnel:list
+```
+
+#### `arm tunnel:stop <tunnelId>`
+Stop a tunnel
+```bash
+arm tunnel:stop 507f1f77bcf86cd799439011
+```
+
+#### `arm tunnel:logs <tunnelId>`
+View tunnel request logs
+```bash
+arm tunnel:logs 507f1f77bcf86cd799439011
+arm tunnel:logs 507f1f77bcf86cd799439011 --follow
+arm tunnel:logs 507f1f77bcf86cd799439011 --lines 100
+```
+
+Options:
+- `-f, --follow` - Follow log output (real-time)
+- `-n, --lines <number>` - Number of lines to show (default: 50)
+
+### Webhooks
+
+#### `arm webhook`
+Create a new webhook
+```bash
+arm webhook
+arm webhook --name "GitHub Webhook"
+arm webhook --forward http://localhost:4000/webhook
+arm webhook --tunnel 507f1f77bcf86cd799439011
+arm webhook --expires 48
+```
+
+Options:
+- `-n, --name <name>` - Webhook name
+- `-f, --forward <url>` - Forward URL
+- `-t, --tunnel <tunnelId>` - Forward to tunnel
+- `-e, --expires <hours>` - Expiration time in hours (default: 24)
+
+#### `arm webhook:list`
+List all webhooks
+```bash
+arm webhook:list
+```
+
+#### `arm webhook:delete <webhookId>`
+Delete a webhook
+```bash
+arm webhook:delete a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
+```
+
+#### `arm webhook:logs <webhookId>`
+View webhook request logs
+```bash
+arm webhook:logs a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
+arm webhook:logs a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 --follow
+arm webhook:logs a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 --lines 100
+```
+
+Options:
+- `-f, --follow` - Follow log output (real-time)
+- `-n, --lines <number>` - Number of lines to show (default: 50)
+
+#### `arm webhook:replay <webhookId> <requestId>`
+Replay a webhook request
+```bash
+arm webhook:replay a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 507f1f77bcf86cd799439011
+```
+
+### Projects
+
+#### `arm projects`
+List all projects
+```bash
+arm projects
+```
+
+#### `arm project:create <name>`
+Create a new project
+```bash
+arm project:create "My API Project"
+arm project:create "My API Project" --description "Testing API endpoints"
+```
+
+Options:
+- `-d, --description <description>` - Project description
+
+#### `arm project:share <projectId>`
+Get shareable link for a project
+```bash
+arm project:share 507f1f77bcf86cd799439011
+```
+
+#### `arm project:responses <projectId>`
+View project API responses
+```bash
+arm project:responses 507f1f77bcf86cd799439011
+arm project:responses 507f1f77bcf86cd799439011 --limit 20
+```
+
+Options:
+- `-n, --limit <number>` - Number of responses to show (default: 10)
+
+### Logs
+
+#### `arm logs <id>`
+View logs for tunnels or webhooks (auto-detects type)
+```bash
+arm logs 507f1f77bcf86cd799439011
+arm logs a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 --follow
+```
+
+Options:
+- `-f, --follow` - Follow log output (real-time)
+- `-n, --lines <number>` - Number of lines to show (default: 50)
+
+### Configuration
+
+#### `arm config:set <key> <value>`
+Set configuration value
+```bash
+arm config:set apiUrl http://localhost:5000/api
+arm config:set defaultTunnelPort 8080
+```
+
+#### `arm config:get [key]`
+Get configuration value (omit key to show all)
+```bash
+arm config:get apiUrl
+arm config:get
+```
+
+#### `arm config:delete <key>`
+Delete configuration value
+```bash
+arm config:delete apiUrl
+```
+
+## Configuration
+
+Configuration is stored in `~/.config/arm-cli/config.json`
+
+Default configuration:
+```json
+{
+  "apiUrl": "http://localhost:5000/api",
+  "token": null,
+  "userId": null,
+  "email": null,
+  "defaultTunnelPort": 3000,
+  "defaultWebhookExpiry": 86400
+}
+```
+
+## Examples
+
+### Expose Local Development Server
+```bash
+# Login
+arm login
+
+# Start tunnel on port 3000
+arm tunnel 3000 --subdomain myapp
+
+# Your local server is now accessible at:
+# https://myapp.tunnel.arm.dev
+```
+
+### Test Webhooks Locally
+```bash
+# Create webhook that forwards to local server
+arm webhook --forward http://localhost:4000/webhook --name "Test Webhook"
+
+# Send test request
+curl -X POST <webhook-url> -d '{"test": "data"}'
+
+# View logs
+arm webhook:logs <webhook-id>
+```
+
+### CI/CD Integration
+```bash
+# In your CI/CD pipeline
+export ARM_TOKEN="your-auth-token"
+
+# Start tunnel for testing
+arm tunnel 3000 --subdomain ci-test-${CI_BUILD_ID}
+
+# Run your tests against the public URL
+npm test
+
+# Stop tunnel
+arm tunnel:stop <tunnel-id>
+```
+
+## Troubleshooting
+
+### Authentication Issues
+```bash
+# Check if logged in
+arm config:get email
+
+# Re-login
+arm logout
+arm login
+```
+
+### Connection Issues
+```bash
+# Check API URL
+arm config:get apiUrl
+
+# Update API URL
+arm config:set apiUrl https://your-api-url.com/api
+```
+
+### View All Configuration
+```bash
+arm config:get
+```
+
+## Publishing to npm
+
+See [PUBLISHING.md](./PUBLISHING.md) for detailed instructions on publishing this package to npm.
+
+### Quick Publish
+
+```bash
+# Login to npm
+npm login
+
+# Update version
+npm version patch  # or minor/major
+
+# Publish
+npm publish --access public
+```
+
+## Support
+
+- GitHub: https://github.com/vijaypurohit322/api-response-manager
+- Issues: https://github.com/vijaypurohit322/api-response-manager/issues
+- Email: vijaypurohit322@gmail.com
+
+## License
+
+MIT License - see LICENSE file for details

package/bin/arm.js

@@ -0,0 +1,180 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const chalk = require('chalk');
+const pkg = require('../package.json');
+
+// Check for updates (optional feature, can be added later with dynamic import)
+// const updateNotifier = require('update-notifier');
+// const notifier = updateNotifier({ pkg });
+// notifier.notify();
+
+// Import commands
+const loginCommand = require('../commands/login');
+const logoutCommand = require('../commands/logout');
+const tunnelCommand = require('../commands/tunnel');
+const webhookCommand = require('../commands/webhook');
+const projectCommand = require('../commands/project');
+const logsCommand = require('../commands/logs');
+const configCommand = require('../commands/config');
+
+// CLI setup
+program
+  .name('arm')
+  .description('API Response Manager CLI - Tunneling, Webhooks, and API Testing')
+  .version(pkg.version);
+
+// Login command
+program
+  .command('login')
+  .description('Authenticate with API Response Manager')
+  .option('-e, --email <email>', 'Email address')
+  .option('-p, --password <password>', 'Password')
+  .action(loginCommand);
+
+// Logout command
+program
+  .command('logout')
+  .description('Logout from API Response Manager')
+  .action(logoutCommand);
+
+// Tunnel commands
+program
+  .command('tunnel')
+  .description('Manage tunnels')
+  .argument('[port]', 'Local port to expose')
+  .option('-s, --subdomain <subdomain>', 'Custom subdomain')
+  .option('-n, --name <name>', 'Tunnel name')
+  .option('-a, --auth', 'Enable basic authentication')
+  .option('-r, --rate-limit <limit>', 'Rate limit (requests per minute)', '60')
+  .action(tunnelCommand.start);
+
+program
+  .command('tunnel:list')
+  .description('List all active tunnels')
+  .action(tunnelCommand.list);
+
+program
+  .command('tunnel:stop')
+  .description('Stop a tunnel')
+  .argument('<tunnelId>', 'Tunnel ID to stop')
+  .action(tunnelCommand.stop);
+
+program
+  .command('tunnel:logs')
+  .description('View tunnel request logs')
+  .argument('<tunnelId>', 'Tunnel ID')
+  .option('-f, --follow', 'Follow log output')
+  .option('-n, --lines <number>', 'Number of lines to show', '50')
+  .action(tunnelCommand.logs);
+
+// Webhook commands
+program
+  .command('webhook')
+  .description('Create a new webhook')
+  .option('-n, --name <name>', 'Webhook name')
+  .option('-f, --forward <url>', 'Forward URL')
+  .option('-t, --tunnel <tunnelId>', 'Forward to tunnel')
+  .option('-e, --expires <hours>', 'Expiration time in hours', '24')
+  .action(webhookCommand.create);
+
+program
+  .command('webhook:list')
+  .description('List all webhooks')
+  .action(webhookCommand.list);
+
+program
+  .command('webhook:id')
+  .description('Get webhook ID by name')
+  .argument('<name>', 'Webhook name')
+  .action(webhookCommand.getIdByName);
+
+program
+  .command('webhook:delete')
+  .description('Delete a webhook')
+  .argument('<webhookId>', 'Webhook ID to delete')
+  .action(webhookCommand.delete);
+
+program
+  .command('webhook:logs')
+  .description('View webhook request logs')
+  .argument('<webhookId>', 'Webhook ID')
+  .option('-f, --follow', 'Follow log output')
+  .option('-n, --lines <number>', 'Number of lines to show', '50')
+  .action(webhookCommand.logs);
+
+program
+  .command('webhook:replay')
+  .description('Replay a webhook request')
+  .argument('<webhookId>', 'Webhook ID')
+  .argument('<requestId>', 'Request ID to replay')
+  .action(webhookCommand.replay);
+
+// Project commands
+program
+  .command('projects')
+  .description('List all projects')
+  .action(projectCommand.list);
+
+program
+  .command('project:create')
+  .description('Create a new project')
+  .argument('<name>', 'Project name')
+  .option('-d, --description <description>', 'Project description')
+  .action(projectCommand.create);
+
+program
+  .command('project:id')
+  .description('Get project ID by name')
+  .argument('<name>', 'Project name')
+  .action(projectCommand.getIdByName);
+
+program
+  .command('project:share')
+  .description('Get shareable link for a project')
+  .argument('<projectId>', 'Project ID')
+  .action(projectCommand.share);
+
+program
+  .command('project:responses')
+  .description('View project API responses')
+  .argument('<projectId>', 'Project ID')
+  .option('-n, --limit <number>', 'Number of responses to show', '10')
+  .action(projectCommand.responses);
+
+// Logs command
+program
+  .command('logs')
+  .description('View logs for tunnels or webhooks')
+  .argument('<id>', 'Tunnel or Webhook ID')
+  .option('-f, --follow', 'Follow log output')
+  .option('-n, --lines <number>', 'Number of lines to show', '50')
+  .action(logsCommand);
+
+// Config commands
+program
+  .command('config:set')
+  .description('Set configuration value')
+  .argument('<key>', 'Configuration key')
+  .argument('<value>', 'Configuration value')
+  .action(configCommand.set);
+
+program
+  .command('config:get')
+  .description('Get configuration value')
+  .argument('[key]', 'Configuration key (omit to show all)')
+  .action(configCommand.get);
+
+program
+  .command('config:delete')
+  .description('Delete configuration value')
+  .argument('<key>', 'Configuration key')
+  .action(configCommand.delete);
+
+// Parse arguments
+program.parse(process.argv);
+
+// Show help if no command provided
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}

package/commands/config.js

@@ -0,0 +1,76 @@
+const chalk = require('chalk');
+const config = require('../utils/config');
+const Table = require('cli-table3');
+
+// Set config value
+function set(key, value) {
+  try {
+    config.set(key, value);
+    console.log(chalk.green(`\n✓ Configuration updated: ${key} = ${value}\n`));
+  } catch (error) {
+    console.error(chalk.red(`\n✗ Failed to set configuration: ${error.message}\n`));
+    process.exit(1);
+  }
+}
+
+// Get config value
+function get(key) {
+  try {
+    if (key) {
+      const value = config.get(key);
+      if (value === undefined) {
+        console.log(chalk.yellow(`\n⚠ Configuration key '${key}' not found\n`));
+      } else {
+        console.log(chalk.white(`\n${key}: ${value}\n`));
+      }
+    } else {
+      // Show all config
+      const allConfig = config.store;
+      
+      console.log(chalk.blue.bold('\n⚙️  Configuration\n'));
+      
+      const table = new Table({
+        head: ['Key', 'Value'],
+        style: {
+          head: ['cyan']
+        }
+      });
+
+      Object.entries(allConfig).forEach(([key, value]) => {
+        // Hide sensitive values
+        const displayValue = key === 'token' && value 
+          ? value.substring(0, 20) + '...' 
+          : String(value);
+        table.push([key, displayValue]);
+      });
+
+      console.log(table.toString());
+      console.log(chalk.gray(`\nConfig file: ${config.path}\n`));
+    }
+  } catch (error) {
+    console.error(chalk.red(`\n✗ Failed to get configuration: ${error.message}\n`));
+    process.exit(1);
+  }
+}
+
+// Delete config value
+function deleteConfig(key) {
+  try {
+    if (!config.has(key)) {
+      console.log(chalk.yellow(`\n⚠ Configuration key '${key}' not found\n`));
+      return;
+    }
+    
+    config.delete(key);
+    console.log(chalk.green(`\n✓ Configuration deleted: ${key}\n`));
+  } catch (error) {
+    console.error(chalk.red(`\n✗ Failed to delete configuration: ${error.message}\n`));
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  set,
+  get,
+  delete: deleteConfig
+};

package/commands/login.js

@@ -0,0 +1,88 @@
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const ora = require('ora');
+const api = require('../utils/api');
+const config = require('../utils/config');
+
+async function login(options) {
+  console.log(chalk.blue.bold('\n🔐 API Response Manager - Login\n'));
+
+  let email = options.email;
+  let password = options.password;
+
+  // Prompt for credentials if not provided
+  if (!email || !password) {
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'email',
+        message: 'Email:',
+        when: !email,
+        validate: (input) => {
+          if (!input) return 'Email is required';
+          if (!/\S+@\S+\.\S+/.test(input)) return 'Invalid email format';
+          return true;
+        }
+      },
+      {
+        type: 'password',
+        name: 'password',
+        message: 'Password:',
+        when: !password,
+        mask: '*',
+        validate: (input) => {
+          if (!input) return 'Password is required';
+          if (input.length < 6) return 'Password must be at least 6 characters';
+          return true;
+        }
+      }
+    ]);
+
+    email = email || answers.email;
+    password = password || answers.password;
+  }
+
+  const spinner = ora('Authenticating...').start();
+
+  try {
+    const response = await api.login(email, password);
+    
+    if (!response.token) {
+      throw new Error('No token received from server');
+    }
+
+    // Store credentials
+    api.setToken(response.token);
+    
+    const userId = response.user?._id || response.user?.id;
+    const userEmail = response.user?.email || email;
+    
+    if (userId) {
+      config.set('userId', userId);
+    }
+    if (userEmail) {
+      config.set('email', userEmail);
+    }
+
+    spinner.succeed(chalk.green('Login successful!'));
+    
+    console.log(chalk.gray('\nUser:'), chalk.white(userEmail));
+    console.log(chalk.gray('Token saved to:'), chalk.white(config.path));
+    console.log(chalk.green('\n✓ You can now use all ARM CLI commands\n'));
+
+  } catch (error) {
+    spinner.fail(chalk.red('Login failed'));
+    
+    if (error.response?.status === 401) {
+      console.error(chalk.red('\n✗ Invalid email or password\n'));
+    } else if (error.response?.data?.msg) {
+      console.error(chalk.red(`\n✗ ${error.response.data.msg}\n`));
+    } else {
+      console.error(chalk.red(`\n✗ ${error.message}\n`));
+    }
+    
+    process.exit(1);
+  }
+}
+
+module.exports = login;

package/commands/logout.js

@@ -0,0 +1,21 @@
+const chalk = require('chalk');
+const api = require('../utils/api');
+const config = require('../utils/config');
+
+async function logout() {
+  const email = config.get('email');
+  
+  if (!email) {
+    console.log(chalk.yellow('\n⚠ You are not logged in\n'));
+    return;
+  }
+
+  // Clear stored credentials
+  api.clearToken();
+  config.delete('userId');
+  config.delete('email');
+
+  console.log(chalk.green(`\n✓ Logged out successfully (${email})\n`));
+}
+
+module.exports = logout;