@hasna/connectors 1.0.8 → 1.1.0

package/connectors/connect-simpletexting/CLAUDE.md

@@ -0,0 +1,272 @@
+# 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), OAuth2 support, 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
+
+# Release (auto-bump patch version and publish)
+bun run release
+bun run release:dry  # Preview only
+```
+
+## 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 auth, retry, timeout
+│   ├── example.ts    # Example API module (template)
+│   └── index.ts      # Main connector class
+├── cli/
+│   └── index.ts      # CLI commands
+├── types/
+│   └── index.ts      # Type definitions
+├── utils/
+│   ├── auth.ts       # OAuth2 authentication
+│   ├── bulk.ts       # Bulk operation utilities
+│   ├── config.ts     # Multi-profile configuration
+│   ├── output.ts     # CLI output formatting
+│   ├── settings.ts   # User preferences storage
+│   └── storage.ts    # Local data storage
+├── index.ts          # Library exports
+scripts/
+└── release.ts        # Release automation
+```
+
+## 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
+
+**Bearer Token (Default)** in `src/api/client.ts`:
+```typescript
+'Authorization': `Bearer ${this.apiKey}`,
+```
+
+**Supported Auth Methods:**
+- Bearer token: `'Authorization': 'Bearer ${token}'`
+- API Key header: `'X-API-Key': ${apiKey}`
+- Basic auth: `'Authorization': 'Basic ' + base64(key:secret)`
+- OAuth2: Use the auth utilities (see below)
+
+### OAuth2 Authentication
+
+For APIs that require OAuth2, use the auth utilities:
+
+```typescript
+import { getAuthUrl, startCallbackServer, getValidAccessToken } from './utils/auth';
+
+// Start OAuth flow
+const authUrl = getAuthUrl({ scopes: 'read write' });
+// Open authUrl in browser
+const result = await startCallbackServer();
+if (result.success) {
+  saveOAuthTokens(result.tokens);
+}
+
+// Get valid access token (auto-refreshes if needed)
+const token = await getValidAccessToken();
+```
+
+### Settings Storage
+
+Store user preferences with the settings utility:
+
+```typescript
+import { getSetting, setSetting, loadSettings } from './utils/settings';
+
+// Get a setting
+const format = getSetting('defaultFormat');
+
+// Set a setting
+setSetting('verboseOutput', true);
+```
+
+### Local Data Storage
+
+Store local data (like contacts, cache) with the storage utility:
+
+```typescript
+import { createStorage, type Storable } from './utils/storage';
+
+interface Contact extends Storable {
+  id: string;
+  email: string;
+  name?: string;
+}
+
+const contacts = createStorage<Contact>('contacts');
+
+// Save
+contacts.save({ id: 'user@example.com', email: 'user@example.com', name: 'User' });
+
+// Get
+const contact = contacts.get('user@example.com');
+
+// Search
+const results = contacts.searchByText('example');
+```
+
+### Bulk Operations
+
+Process multiple items with concurrency control:
+
+```typescript
+import { executeBulk, createProgressReporter } from './utils/bulk';
+
+const result = await executeBulk(
+  {
+    items: users,
+    concurrency: 5,
+    dryRun: false,
+    onProgress: createProgressReporter('Updating users'),
+  },
+  async (user) => {
+    await api.updateUser(user.id, { status: 'active' });
+  }
+);
+
+console.log(`Success: ${result.success}, Failed: ${result.failed}`);
+```
+
+### Retry and Rate Limiting
+
+The HTTP client includes built-in retry logic:
+
+```typescript
+// Retries are automatic for 429 (rate limit) and 5xx errors
+const data = await client.get('/endpoint', { retries: 3, timeout: 30000 });
+```
+
+### 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/utils/auth.ts:10-15` - OAuth URLs and scopes
+- `src/api/client.ts:5` - DEFAULT_BASE_URL
+- `src/api/client.ts:55-60` - 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_TOKEN` | Token (alias for API key) |
+| `CONNECTOR_API_SECRET` | API secret (optional) |
+| `CONNECTOR_BASE_URL` | Override base URL |
+
+## CLI Global Flags
+
+| Flag | Description |
+|------|-------------|
+| `-k, --api-key <key>` | Override API key for this command |
+| `-p, --profile <name>` | Use specific profile |
+| `-f, --format <format>` | Output format (json, pretty, table) |
+| `-v, --verbose` | Enable debug output |
+
+## Data Storage
+
+```
+~/.connect/{connector-name}/
+├── current_profile     # Active profile name
+├── settings.json       # User preferences
+├── data/               # Local data storage
+│   └── {entity}/       # Entity-specific storage
+│       └── *.json
+└── profiles/
+    ├── default.json    # Default profile
+    └── {name}.json     # Named profiles
+```
+
+Profile JSON structure:
+```json
+{
+  "apiKey": "sk-xxx",
+  "token": "sk-xxx",
+  "apiSecret": "optional",
+  "accessToken": "oauth-access-token",
+  "refreshToken": "oauth-refresh-token",
+  "expiresAt": 1234567890,
+  "clientId": "oauth-client-id",
+  "clientSecret": "oauth-client-secret"
+}
+```
+
+## Dependencies
+
+- commander: CLI framework
+- chalk: Terminal styling
+
+## Error Handling
+
+The scaffold includes enhanced error types:
+
+```typescript
+import { ConnectorApiError, parseApiError } from './types';
+
+try {
+  await api.get('/endpoint');
+} catch (err) {
+  if (err instanceof ConnectorApiError) {
+    if (err.isRateLimited()) {
+      // Handle rate limiting
+    }
+    if (err.isAuthError()) {
+      // Handle auth errors
+    }
+    console.log(err.getUserMessage());
+    console.log(err.documentationUrl);
+  }
+}
+```

package/connectors/connect-simpletexting/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/hasnaxyz/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-simpletexting/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@hasna/connect-simpletexting",
+  "version": "0.0.1",
+  "description": "Connector: connect-simpletexting",
+  "type": "module",
+  "bin": {
+    "connector": "./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",
+    "release": "bun run scripts/release.ts",
+    "release:dry": "bun run scripts/release.ts --dry-run"
+  },
+  "keywords": [
+    "api",
+    "connector",
+    "scaffold",
+    "cli",
+    "typescript",
+    "bun",
+    "template"
+  ],
+  "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/scaffold-connector.git"
+  }
+}

package/connectors/connect-simpletexting/scripts/release.ts

@@ -0,0 +1,179 @@
+#!/usr/bin/env bun
+/**
+ * Release script for publishing to npm
+ *
+ * Usage:
+ *   bun run release        # Build, bump version, and publish
+ *   bun run release:dry    # Dry run (preview only)
+ *
+ * Features:
+ *   - Auto-fetches current npm version
+ *   - Bumps patch version if needed
+ *   - Creates git tag
+ *   - Publishes to npm
+ */
+
+import { readFileSync, writeFileSync } from 'fs';
+import { execSync } from 'child_process';
+
+const isDryRun = process.argv.includes('--dry-run');
+
+interface PackageJson {
+  name: string;
+  version: string;
+  [key: string]: unknown;
+}
+
+function exec(command: string, silent = false): string {
+  try {
+    const result = execSync(command, {
+      encoding: 'utf-8',
+      stdio: silent ? 'pipe' : 'inherit',
+    });
+    return result?.trim() || '';
+  } catch (err) {
+    if (silent) {
+      return '';
+    }
+    throw err;
+  }
+}
+
+function log(message: string): void {
+  console.log(`\x1b[36m▸\x1b[0m ${message}`);
+}
+
+function success(message: string): void {
+  console.log(`\x1b[32m✓\x1b[0m ${message}`);
+}
+
+function warn(message: string): void {
+  console.log(`\x1b[33m⚠\x1b[0m ${message}`);
+}
+
+function error(message: string): void {
+  console.error(`\x1b[31m✗\x1b[0m ${message}`);
+}
+
+function parseVersion(version: string): { major: number; minor: number; patch: number } {
+  const [major, minor, patch] = version.split('.').map(Number);
+  return { major, minor, patch };
+}
+
+function bumpPatch(version: string): string {
+  const { major, minor, patch } = parseVersion(version);
+  return `${major}.${minor}.${patch + 1}`;
+}
+
+async function main(): Promise<void> {
+  // Read package.json
+  const packageJsonPath = 'package.json';
+  const packageJson: PackageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+  const { name, version: localVersion } = packageJson;
+
+  log(`Package: ${name}`);
+  log(`Local version: ${localVersion}`);
+
+  // Get current npm version
+  let npmVersion = '';
+  try {
+    npmVersion = exec(`npm view ${name} version 2>/dev/null`, true);
+    log(`npm version: ${npmVersion || 'not published'}`);
+  } catch {
+    log('npm version: not published yet');
+  }
+
+  // Determine new version
+  let newVersion = localVersion;
+  if (npmVersion) {
+    const localParsed = parseVersion(localVersion);
+    const npmParsed = parseVersion(npmVersion);
+
+    // If local version <= npm version, bump from npm version
+    if (
+      localParsed.major < npmParsed.major ||
+      (localParsed.major === npmParsed.major && localParsed.minor < npmParsed.minor) ||
+      (localParsed.major === npmParsed.major &&
+        localParsed.minor === npmParsed.minor &&
+        localParsed.patch <= npmParsed.patch)
+    ) {
+      newVersion = bumpPatch(npmVersion);
+    }
+  }
+
+  if (newVersion !== localVersion) {
+    log(`Bumping version: ${localVersion} → ${newVersion}`);
+
+    if (!isDryRun) {
+      packageJson.version = newVersion;
+      writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + '\n');
+    }
+  } else {
+    log(`Version unchanged: ${newVersion}`);
+  }
+
+  // Run typecheck
+  log('Running typecheck...');
+  if (!isDryRun) {
+    exec('bun run typecheck');
+    success('Typecheck passed');
+  }
+
+  // Build
+  log('Building...');
+  if (!isDryRun) {
+    exec('bun run build');
+    success('Build completed');
+  }
+
+  // Git operations
+  const gitStatus = exec('git status --porcelain', true);
+  if (gitStatus) {
+    log('Staging changes...');
+    if (!isDryRun) {
+      exec('git add package.json');
+      exec(`git commit -m "chore: release v${newVersion}"`);
+    }
+  }
+
+  // Create git tag
+  const tagName = `v${newVersion}`;
+  log(`Creating tag: ${tagName}`);
+  if (!isDryRun) {
+    try {
+      exec(`git tag ${tagName}`);
+      success(`Tag ${tagName} created`);
+    } catch {
+      warn(`Tag ${tagName} already exists`);
+    }
+  }
+
+  // Publish
+  log('Publishing to npm...');
+  if (isDryRun) {
+    warn('Dry run - skipping publish');
+    exec('npm publish --dry-run');
+  } else {
+    exec('npm publish');
+    success(`Published ${name}@${newVersion}`);
+  }
+
+  // Push tags
+  if (!isDryRun) {
+    log('Pushing tags...');
+    try {
+      exec('git push --tags');
+      success('Tags pushed');
+    } catch {
+      warn('Failed to push tags (you may need to push manually)');
+    }
+  }
+
+  console.log('');
+  success(`Release ${isDryRun ? '(dry run) ' : ''}complete: ${name}@${newVersion}`);
+}
+
+main().catch((err) => {
+  error(String(err));
+  process.exit(1);
+});