@hasna/connectors 0.4.2 → 0.5.1

package/connectors/connect-groq/CLAUDE.md

@@ -0,0 +1,128 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+scaffold-connector is a TypeScript template for building API connector CLIs. It provides multi-profile configuration, Bearer token authentication (customizable), and a clean CLI structure using Commander.js.
+
+**This is a SCAFFOLD** - meant to be cloned and customized for specific APIs.
+
+## Build & Run Commands
+
+```bash
+# Install dependencies
+bun install
+
+# Run CLI in development
+bun run dev
+
+# Build for distribution
+bun run build
+
+# Type check
+bun run typecheck
+
+# Run specific commands
+bun run dev profile list
+bun run dev config show
+bun run dev example list
+```
+
+## Code Style
+
+- TypeScript with strict mode
+- ESM modules (type: module)
+- Use async/await for all async operations
+- Minimal dependencies: commander, chalk only
+- Type annotations required everywhere
+- Use interfaces for all API types
+
+## Project Structure
+
+```
+src/
+├── api/
+│   ├── client.ts     # HTTP client with authentication
+│   ├── example.ts    # Example API module (template)
+│   └── index.ts      # Main connector class
+├── cli/
+│   └── index.ts      # CLI commands
+├── types/
+│   └── index.ts      # Type definitions
+├── utils/
+│   ├── config.ts     # Multi-profile configuration
+│   └── output.ts     # CLI output formatting
+└── index.ts          # Library exports
+```
+
+## Key Patterns
+
+### Multi-Profile Configuration
+
+Profiles stored in `~/.connect/{connector-name}/profiles/`:
+- Each profile is a separate JSON file
+- `current_profile` file tracks active profile
+- `--profile` flag overrides for single command
+- Environment variables override profile config
+
+### Authentication
+
+Default is Bearer token in `src/api/client.ts`:
+```typescript
+'Authorization': `Bearer ${this.apiKey}`,
+```
+
+Customize for different auth methods:
+- API Key header: `'X-API-Key': this.apiKey`
+- Basic auth: `'Authorization': 'Basic ' + base64(key:secret)`
+- OAuth: Add token refresh logic
+
+### Adding New API Modules
+
+1. Create file in `src/api/` following `example.ts` pattern
+2. Add to exports in `src/api/index.ts`
+3. Add types in `src/types/index.ts`
+4. Add CLI commands in `src/cli/index.ts`
+
+## TODO Markers
+
+When customizing this scaffold, search for `TODO` comments:
+
+- `src/cli/index.ts:22-24` - CONNECTOR_NAME, VERSION, description
+- `src/utils/config.ts:5-6` - CONNECTOR_NAME, env var prefix
+- `src/api/client.ts:5` - DEFAULT_BASE_URL
+- `src/api/client.ts:45-48` - Authentication method
+- `src/api/index.ts:7` - Rename Connector class
+- `src/types/index.ts` - Replace example types
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `CONNECTOR_API_KEY` | API key (overrides profile) |
+| `CONNECTOR_API_SECRET` | API secret (optional) |
+| `CONNECTOR_BASE_URL` | Override base URL |
+
+## Data Storage
+
+```
+~/.connect/{connector-name}/
+├── current_profile   # Active profile name
+└── profiles/
+    ├── default.json  # Default profile
+    └── {name}.json   # Named profiles
+```
+
+Profile JSON structure:
+```json
+{
+  "apiKey": "sk-xxx",
+  "apiSecret": "optional"
+}
+```
+
+## Dependencies
+
+- commander: CLI framework
+- chalk: Terminal styling

package/connectors/connect-groq/README.md

@@ -0,0 +1,193 @@
+# scaffold-connector
+
+A TypeScript scaffold for building API connector CLIs with multi-profile support.
+
+## Features
+
+- Multi-profile configuration (switch between different API keys/accounts)
+- Bearer token authentication (easily customizable)
+- Clean CLI structure with Commander.js
+- Pretty and JSON output formats
+- TypeScript with strict mode
+
+## Quick Start
+
+### 1. Clone and Rename
+
+```bash
+# Clone for your connector
+git clone https://github.com/hasna/scaffold-connector.git connect-yourapi
+cd connect-yourapi
+
+# Update package.json name
+# Change "@hasna/scaffold-connector" to "@hasna/connect-yourapi"
+```
+
+### 2. Update Configuration
+
+Search for `TODO` comments throughout the codebase and update:
+
+- `src/cli/index.ts` - Update `CONNECTOR_NAME` and description
+- `src/utils/config.ts` - Update `CONNECTOR_NAME` and env var names
+- `src/api/client.ts` - Update `DEFAULT_BASE_URL` and authentication method
+- `src/api/index.ts` - Rename `Connector` class to your API name
+- `src/types/index.ts` - Add your API's type definitions
+- `package.json` - Update name, description, bin command
+- `.env.example` - Update environment variable names
+
+### 3. Install and Test
+
+```bash
+# Install dependencies
+bun install
+
+# Run CLI
+bun run dev
+
+# Or run specific commands
+bun run dev profile list
+bun run dev config show
+```
+
+## CLI Structure
+
+```bash
+connector [options] [command]
+
+Options:
+  -k, --api-key <key>      API key (overrides config)
+  -f, --format <format>    Output format (json, pretty)
+  -p, --profile <profile>  Use a specific profile
+
+Commands:
+  profile list             List all profiles
+  profile use <name>       Switch to a profile
+  profile create <name>    Create a new profile
+  profile delete <name>    Delete a profile
+  profile show [name]      Show profile configuration
+
+  config set-key <key>     Set API key for active profile
+  config show              Show current configuration
+  config clear             Clear configuration
+
+  example list             Example API command (replace)
+  example get <id>         Example API command (replace)
+  example create           Example API command (replace)
+```
+
+## Project Structure
+
+```
+src/
+├── api/
+│   ├── client.ts     # HTTP client with authentication
+│   ├── example.ts    # Example API module (replace with your API)
+│   └── index.ts      # Main connector class
+├── cli/
+│   └── index.ts      # CLI commands
+├── types/
+│   └── index.ts      # Type definitions
+├── utils/
+│   ├── config.ts     # Multi-profile configuration
+│   └── output.ts     # CLI output formatting
+└── index.ts          # Library exports
+```
+
+## Multi-Profile Configuration
+
+Profiles are stored in `~/.connect/{connector-name}/profiles/`:
+
+```
+~/.connect/connector/
+├── current_profile   # Name of active profile
+└── profiles/
+    ├── default.json  # Default profile
+    ├── work.json     # Named profile
+    └── personal.json # Named profile
+```
+
+### Profile Commands
+
+```bash
+# Create profiles
+connector profile create work --api-key sk-xxx --use
+connector profile create personal --api-key sk-yyy
+
+# Switch profiles
+connector profile use work
+
+# Use profile for single command
+connector -p personal example list
+
+# List profiles
+connector profile list
+```
+
+## Customizing Authentication
+
+Edit `src/api/client.ts` to change authentication:
+
+```typescript
+// Bearer token (default)
+'Authorization': `Bearer ${this.apiKey}`,
+
+// API Key header
+'X-API-Key': this.apiKey,
+
+// Basic auth
+'Authorization': `Basic ${Buffer.from(`${this.apiKey}:${this.apiSecret}`).toString('base64')}`,
+```
+
+## Adding API Endpoints
+
+1. Create a new file in `src/api/` (e.g., `users.ts`)
+2. Export it from `src/api/index.ts`
+3. Add types in `src/types/index.ts`
+4. Add CLI commands in `src/cli/index.ts`
+
+Example API module:
+
+```typescript
+// src/api/users.ts
+import type { ConnectorClient } from './client';
+
+export class UsersApi {
+  constructor(private readonly client: ConnectorClient) {}
+
+  async list(options?: { limit?: number }) {
+    return this.client.get('/users', { limit: options?.limit });
+  }
+
+  async get(id: string) {
+    return this.client.get(`/users/${id}`);
+  }
+}
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `CONNECTOR_API_KEY` | API key (overrides profile config) |
+| `CONNECTOR_API_SECRET` | API secret (optional) |
+| `CONNECTOR_BASE_URL` | Override base URL (optional) |
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Run CLI in development
+bun run dev
+
+# Build for distribution
+bun run build
+
+# Type check
+bun run typecheck
+```
+
+## License
+
+MIT

package/connectors/connect-groq/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@hasna/connect-groq",
+  "version": "0.0.1",
+  "description": "Groq AI connector CLI - Ultra-fast LLM inference with multi-profile support",
+  "type": "module",
+  "bin": {
+    "connect-groq": "./bin/index.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun && bun build ./src/cli/index.ts --outdir ./bin --target bun",
+    "dev": "bun run ./src/cli/index.ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "bun run build"
+  },
+  "keywords": [
+    "groq",
+    "ai",
+    "llm",
+    "chat",
+    "inference",
+    "fast",
+    "connector",
+    "cli",
+    "typescript",
+    "bun"
+  ],
+  "author": "Hasna",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "commander": "^12.1.0",
+    "chalk": "^5.3.0"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hasna/connectors.git"
+  }
+}

package/connectors/connect-groq/src/api/client.ts

@@ -0,0 +1,108 @@
+import type { GroqConfig } from '../types';
+import { GroqApiError } from '../types';
+
+const DEFAULT_BASE_URL = 'https://api.groq.com/openai/v1';
+
+export interface RequestOptions {
+  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+  params?: Record<string, string | number | boolean | undefined>;
+  body?: Record<string, unknown> | unknown[] | string;
+  headers?: Record<string, string>;
+}
+
+export class GroqClient {
+  private readonly apiKey: string;
+  private readonly baseUrl: string;
+
+  constructor(config: GroqConfig) {
+    if (!config.apiKey) {
+      throw new Error('API key is required');
+    }
+    this.apiKey = config.apiKey;
+    this.baseUrl = config.baseUrl || DEFAULT_BASE_URL;
+  }
+
+  private buildUrl(path: string, params?: Record<string, string | number | boolean | undefined>): string {
+    const url = new URL(`${this.baseUrl}${path}`);
+    if (params) {
+      Object.entries(params).forEach(([key, value]) => {
+        if (value !== undefined && value !== null && value !== '') {
+          url.searchParams.append(key, String(value));
+        }
+      });
+    }
+    return url.toString();
+  }
+
+  async request<T>(path: string, options: RequestOptions = {}): Promise<T> {
+    const { method = 'GET', params, body, headers = {} } = options;
+    const url = this.buildUrl(path, params);
+
+    const requestHeaders: Record<string, string> = {
+      'Authorization': `Bearer ${this.apiKey}`,
+      'Accept': 'application/json',
+      ...headers,
+    };
+
+    if (body && ['POST', 'PUT', 'PATCH'].includes(method)) {
+      requestHeaders['Content-Type'] = 'application/json';
+    }
+
+    const fetchOptions: RequestInit = {
+      method,
+      headers: requestHeaders,
+    };
+
+    if (body && ['POST', 'PUT', 'PATCH'].includes(method)) {
+      fetchOptions.body = typeof body === 'string' ? body : JSON.stringify(body);
+    }
+
+    const response = await fetch(url, fetchOptions);
+
+    if (response.status === 204) {
+      return {} as T;
+    }
+
+    let data: unknown;
+    const contentType = response.headers.get('content-type') || '';
+
+    if (contentType.includes('application/json')) {
+      const text = await response.text();
+      if (text) {
+        try {
+          data = JSON.parse(text);
+        } catch {
+          data = text;
+        }
+      }
+    } else {
+      data = await response.text();
+    }
+
+    if (!response.ok) {
+      let errorMessage = String(data || response.statusText);
+      if (typeof data === 'object' && data !== null) {
+        const errorObj = data as { error?: { message?: string }; message?: string };
+        errorMessage = errorObj.error?.message || errorObj.message || JSON.stringify(data);
+      }
+      throw new GroqApiError(errorMessage, response.status);
+    }
+
+    return data as T;
+  }
+
+  async get<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'GET', params });
+  }
+
+  async post<T>(path: string, body?: Record<string, unknown> | unknown[] | string | object): Promise<T> {
+    return this.request<T>(path, { method: 'POST', body: body as Record<string, unknown> });
+  }
+
+  getApiKeyPreview(): string {
+    if (this.apiKey.length > 10) {
+      return `${this.apiKey.substring(0, 6)}...${this.apiKey.substring(this.apiKey.length - 4)}`;
+    }
+    return '***';
+  }
+}

package/connectors/connect-groq/src/api/index.ts

@@ -0,0 +1,36 @@
+import type { GroqConfig, ChatRequest, ChatResponse, ModelsResponse } from '../types';
+import { GroqClient } from './client';
+
+export class Groq {
+  private readonly client: GroqClient;
+
+  constructor(config: GroqConfig) {
+    this.client = new GroqClient(config);
+  }
+
+  static fromEnv(): Groq {
+    const apiKey = process.env.GROQ_API_KEY;
+    if (!apiKey) {
+      throw new Error('GROQ_API_KEY environment variable is required');
+    }
+    return new Groq({ apiKey });
+  }
+
+  getApiKeyPreview(): string {
+    return this.client.getApiKeyPreview();
+  }
+
+  async chat(request: ChatRequest): Promise<ChatResponse> {
+    return this.client.post<ChatResponse>('/chat/completions', request);
+  }
+
+  async listModels(): Promise<ModelsResponse> {
+    return this.client.get<ModelsResponse>('/models');
+  }
+
+  getClient(): GroqClient {
+    return this.client;
+  }
+}
+
+export { GroqClient } from './client';

package/connectors/connect-groq/src/cli/index.ts

@@ -0,0 +1,171 @@
+#!/usr/bin/env bun
+import { Command } from 'commander';
+import chalk from 'chalk';
+import { Groq } from '../api';
+import {
+  getApiKey, setApiKey, clearConfig, getConfigDir, setProfileOverride,
+  getCurrentProfile, setCurrentProfile, listProfiles, createProfile,
+  deleteProfile, profileExists, loadProfile,
+} from '../utils/config';
+import type { OutputFormat } from '../utils/output';
+import { success, error, info, print } from '../utils/output';
+
+const CONNECTOR_NAME = 'connect-groq';
+const VERSION = '0.0.1';
+
+const program = new Command();
+
+program
+  .name(CONNECTOR_NAME)
+  .description('Groq AI connector CLI - Ultra-fast LLM inference')
+  .version(VERSION)
+  .option('-f, --format <format>', 'Output format (json, pretty)', 'pretty')
+  .option('-p, --profile <profile>', 'Use a specific profile')
+  .hook('preAction', (thisCommand) => {
+    const opts = thisCommand.opts();
+    if (opts.profile) {
+      if (!profileExists(opts.profile)) {
+        error(`Profile "${opts.profile}" does not exist`);
+        process.exit(1);
+      }
+      setProfileOverride(opts.profile);
+    }
+  });
+
+function getFormat(cmd: Command): OutputFormat {
+  const parent = cmd.parent;
+  return (parent?.opts().format || 'pretty') as OutputFormat;
+}
+
+function getClient(): Groq {
+  const apiKey = getApiKey();
+  if (!apiKey) {
+    error(`No API key configured. Run "${CONNECTOR_NAME} config set-key <key>" or set GROQ_API_KEY`);
+    process.exit(1);
+  }
+  return new Groq({ apiKey });
+}
+
+// Profile Commands
+const profileCmd = program.command('profile').description('Manage profiles');
+
+profileCmd.command('list').description('List profiles').action(() => {
+  const profiles = listProfiles();
+  const current = getCurrentProfile();
+  if (profiles.length === 0) { info('No profiles found'); return; }
+  profiles.forEach(p => {
+    console.log(`  ${p}${p === current ? chalk.green(' (active)') : ''}`);
+  });
+});
+
+profileCmd.command('use <name>').description('Switch profile').action((name: string) => {
+  if (!profileExists(name)) { error(`Profile "${name}" does not exist`); process.exit(1); }
+  setCurrentProfile(name);
+  success(`Switched to profile: ${name}`);
+});
+
+profileCmd.command('create <name>').description('Create profile')
+  .option('--api-key <key>', 'API key')
+  .option('--use', 'Switch to this profile')
+  .action((name: string, opts) => {
+    if (profileExists(name)) { error(`Profile "${name}" already exists`); process.exit(1); }
+    createProfile(name, { apiKey: opts.apiKey });
+    success(`Profile "${name}" created`);
+    if (opts.use) { setCurrentProfile(name); info(`Switched to profile: ${name}`); }
+  });
+
+profileCmd.command('delete <name>').description('Delete profile').action((name: string) => {
+  if (name === 'default') { error('Cannot delete default profile'); process.exit(1); }
+  if (deleteProfile(name)) { success(`Profile "${name}" deleted`); }
+  else { error(`Profile "${name}" not found`); process.exit(1); }
+});
+
+profileCmd.command('show [name]').description('Show profile').action((name?: string) => {
+  const profileName = name || getCurrentProfile();
+  const config = loadProfile(profileName);
+  console.log(chalk.bold(`Profile: ${profileName}`));
+  info(`API Key: ${config.apiKey ? config.apiKey.substring(0, 8) + '...' : chalk.gray('not set')}`);
+});
+
+// Config Commands
+const configCmd = program.command('config').description('Manage configuration');
+
+configCmd.command('set-key <apiKey>').description('Set API key').action((apiKey: string) => {
+  setApiKey(apiKey);
+  success(`API key saved`);
+});
+
+configCmd.command('show').description('Show config').action(() => {
+  console.log(chalk.bold(`Profile: ${getCurrentProfile()}`));
+  info(`Config dir: ${getConfigDir()}`);
+  const apiKey = getApiKey();
+  info(`API Key: ${apiKey ? apiKey.substring(0, 8) + '...' : chalk.gray('not set')}`);
+});
+
+configCmd.command('clear').description('Clear config').action(() => {
+  clearConfig();
+  success('Config cleared');
+});
+
+// Chat Command
+program.command('chat <message>')
+  .description('Send a chat message')
+  .option('-m, --model <model>', 'Model (default: llama3-8b-8192)', 'llama3-8b-8192')
+  .option('-t, --temperature <temp>', 'Temperature')
+  .option('--max-tokens <n>', 'Max tokens')
+  .option('-s, --system <prompt>', 'System prompt')
+  .action(async (message: string, opts) => {
+    try {
+      const client = getClient();
+      const messages: { role: 'system' | 'user'; content: string }[] = [];
+      if (opts.system) messages.push({ role: 'system', content: opts.system });
+      messages.push({ role: 'user', content: message });
+
+      const result = await client.chat({
+        model: opts.model,
+        messages,
+        temperature: opts.temperature ? parseFloat(opts.temperature) : undefined,
+        max_tokens: opts.maxTokens ? parseInt(opts.maxTokens) : undefined,
+      });
+
+      if (getFormat(program) === 'json') {
+        print(result, 'json');
+      } else {
+        console.log(chalk.green('\nResponse:'));
+        console.log(result.choices[0]?.message?.content || '');
+        if (result.usage) {
+          info(`\nTokens: ${result.usage.prompt_tokens} in, ${result.usage.completion_tokens} out`);
+          if (result.usage.total_time) {
+            info(`Time: ${(result.usage.total_time * 1000).toFixed(0)}ms`);
+          }
+        }
+      }
+    } catch (err) {
+      error(String(err));
+      process.exit(1);
+    }
+  });
+
+// Models Command
+program.command('models')
+  .description('List available models')
+  .action(async () => {
+    try {
+      const client = getClient();
+      const result = await client.listModels();
+      if (getFormat(program) === 'json') {
+        print(result.data, 'json');
+      } else {
+        result.data.forEach(m => {
+          console.log(chalk.cyan(`\n${m.id}`));
+          if (m.owned_by) console.log(`  Owner: ${m.owned_by}`);
+          if (m.context_window) console.log(`  Context: ${m.context_window}`);
+        });
+      }
+    } catch (err) {
+      error(String(err));
+      process.exit(1);
+    }
+  });
+
+program.parse();

package/connectors/connect-groq/src/index.ts

@@ -0,0 +1,19 @@
+// Groq Connector
+// TypeScript wrapper for Groq AI API
+
+export { Groq } from './api';
+export * from './types';
+export { GroqClient } from './api';
+
+export {
+  getApiKey,
+  setApiKey,
+  getCurrentProfile,
+  setCurrentProfile,
+  listProfiles,
+  createProfile,
+  deleteProfile,
+  loadProfile,
+  saveProfile,
+  clearConfig,
+} from './utils/config';