@hasna/connectors 1.0.8 → 1.0.9

package/connectors/connect-speechify/src/types/index.ts

@@ -0,0 +1,131 @@
+// Speechify API Types
+
+// ============================================
+// Configuration
+// ============================================
+
+export interface SpeechifyConfig {
+  apiKey: string;
+  baseUrl?: string;
+}
+
+// ============================================
+// Common Types
+// ============================================
+
+export type OutputFormat = 'json' | 'pretty';
+
+// ============================================
+// Voice Types
+// ============================================
+
+export interface Voice {
+  id: string;
+  name: string;
+  type: 'personal' | 'shared' | 'professional';
+  gender?: 'male' | 'female';
+  language?: string;
+  locale?: string;
+  preview_url?: string;
+  sample_url?: string;
+  is_cloned?: boolean;
+  created_at?: string;
+}
+
+export interface VoicesListResponse {
+  voices: Voice[];
+}
+
+export interface VoiceResponse {
+  voice: Voice;
+}
+
+// ============================================
+// Speech Generation Types
+// ============================================
+
+export type AudioFormat = 'mp3' | 'wav' | 'ogg' | 'aac';
+
+export interface GenerateSpeechOptions {
+  voice_id: string;
+  input: string;
+  audio_format?: AudioFormat;
+  sample_rate?: number;
+  speed?: number; // 0.5 to 2.0
+  pitch?: number; // -20 to 20
+}
+
+export interface GenerateSpeechResponse {
+  audio_data: string; // base64 encoded
+  audio_format: string;
+  duration_seconds?: number;
+  characters_used?: number;
+}
+
+export interface StreamSpeechOptions {
+  voice_id: string;
+  input: string;
+  audio_format?: AudioFormat;
+  sample_rate?: number;
+  speed?: number;
+  pitch?: number;
+}
+
+// ============================================
+// Voice Cloning Types
+// ============================================
+
+export interface CloneVoiceOptions {
+  name: string;
+  sample_url?: string;
+  description?: string;
+}
+
+export interface CloneVoiceResponse {
+  voice: Voice;
+}
+
+export interface DeleteVoiceResponse {
+  success: boolean;
+}
+
+// ============================================
+// Usage Types
+// ============================================
+
+export interface UsageResponse {
+  characters_used: number;
+  characters_limit: number;
+  period_start: string;
+  period_end: string;
+}
+
+// ============================================
+// API Error Types
+// ============================================
+
+export interface ApiErrorDetail {
+  code: string;
+  message: string;
+  field?: string;
+}
+
+export class SpeechifyApiError extends Error {
+  public readonly statusCode: number;
+  public readonly errors?: ApiErrorDetail[];
+
+  constructor(message: string, statusCode: number, errors?: ApiErrorDetail[]) {
+    super(message);
+    this.name = 'SpeechifyApiError';
+    this.statusCode = statusCode;
+    this.errors = errors;
+  }
+}
+
+// ============================================
+// Profile Config
+// ============================================
+
+export interface ProfileConfig {
+  apiKey?: string;
+}

package/connectors/connect-speechify/src/utils/config.ts

@@ -0,0 +1,103 @@
+import { existsSync, readFileSync, writeFileSync, mkdirSync, readdirSync, rmSync } from 'fs';
+import { homedir } from 'os';
+import { join } from 'path';
+
+const CONNECTOR_NAME = 'connect-speechify';
+const DEFAULT_PROFILE = 'default';
+
+export interface ProfileConfig {
+  apiKey?: string;
+}
+
+let profileOverride: string | undefined;
+
+const CONFIG_DIR = join(homedir(), '.connect', CONNECTOR_NAME);
+const PROFILES_DIR = join(CONFIG_DIR, 'profiles');
+const CURRENT_PROFILE_FILE = join(CONFIG_DIR, 'current_profile');
+
+export function setProfileOverride(profile: string | undefined): void {
+  profileOverride = profile;
+}
+
+export function ensureConfigDir(): void {
+  if (!existsSync(CONFIG_DIR)) mkdirSync(CONFIG_DIR, { recursive: true });
+  if (!existsSync(PROFILES_DIR)) mkdirSync(PROFILES_DIR, { recursive: true });
+}
+
+function getProfilePath(profile: string): string {
+  return join(PROFILES_DIR, `${profile}.json`);
+}
+
+export function getCurrentProfile(): string {
+  if (profileOverride) return profileOverride;
+  ensureConfigDir();
+  if (existsSync(CURRENT_PROFILE_FILE)) {
+    try {
+      const profile = readFileSync(CURRENT_PROFILE_FILE, 'utf-8').trim();
+      if (profile && profileExists(profile)) return profile;
+    } catch { /* fall through */ }
+  }
+  return DEFAULT_PROFILE;
+}
+
+export function setCurrentProfile(profile: string): void {
+  ensureConfigDir();
+  if (!profileExists(profile) && profile !== DEFAULT_PROFILE) {
+    throw new Error(`Profile "${profile}" does not exist`);
+  }
+  writeFileSync(CURRENT_PROFILE_FILE, profile);
+}
+
+export function profileExists(profile: string): boolean {
+  return existsSync(getProfilePath(profile));
+}
+
+export function listProfiles(): string[] {
+  ensureConfigDir();
+  if (!existsSync(PROFILES_DIR)) return [];
+  return readdirSync(PROFILES_DIR).filter(f => f.endsWith('.json')).map(f => f.replace('.json', '')).sort();
+}
+
+export function createProfile(profile: string, config: ProfileConfig = {}): boolean {
+  ensureConfigDir();
+  if (profileExists(profile)) return false;
+  if (!/^[a-zA-Z0-9_-]+$/.test(profile)) {
+    throw new Error('Profile name can only contain letters, numbers, hyphens, and underscores');
+  }
+  writeFileSync(getProfilePath(profile), JSON.stringify(config, null, 2));
+  return true;
+}
+
+export function deleteProfile(profile: string): boolean {
+  if (profile === DEFAULT_PROFILE) return false;
+  if (!profileExists(profile)) return false;
+  if (getCurrentProfile() === profile) setCurrentProfile(DEFAULT_PROFILE);
+  rmSync(getProfilePath(profile));
+  return true;
+}
+
+export function loadProfile(profile?: string): ProfileConfig {
+  ensureConfigDir();
+  const profilePath = getProfilePath(profile || getCurrentProfile());
+  if (!existsSync(profilePath)) return {};
+  try { return JSON.parse(readFileSync(profilePath, 'utf-8')); } catch { return {}; }
+}
+
+export function saveProfile(config: ProfileConfig, profile?: string): void {
+  ensureConfigDir();
+  writeFileSync(getProfilePath(profile || getCurrentProfile()), JSON.stringify(config, null, 2));
+}
+
+export function getApiKey(): string | undefined {
+  return process.env.SPEECHIFY_API_KEY || loadProfile().apiKey;
+}
+
+export function setApiKey(apiKey: string): void {
+  const config = loadProfile();
+  config.apiKey = apiKey;
+  saveProfile(config);
+}
+
+export function clearConfig(): void { saveProfile({}); }
+export function getConfigDir(): string { return CONFIG_DIR; }
+export function getActiveProfileName(): string { return getCurrentProfile(); }

package/connectors/connect-speechify/src/utils/output.ts

@@ -0,0 +1,119 @@
+import chalk from 'chalk';
+
+export type OutputFormat = 'json' | 'table' | 'pretty';
+
+export function formatOutput(data: unknown, format: OutputFormat = 'pretty'): string {
+  switch (format) {
+    case 'json':
+      return JSON.stringify(data, null, 2);
+    case 'table':
+      return formatAsTable(data);
+    case 'pretty':
+    default:
+      return formatPretty(data);
+  }
+}
+
+function formatAsTable(data: unknown): string {
+  if (!Array.isArray(data)) {
+    data = [data];
+  }
+
+  const items = data as Record<string, unknown>[];
+  if (items.length === 0) {
+    return 'No data';
+  }
+
+  const firstItem = items[0];
+  if (!firstItem || typeof firstItem !== 'object') {
+    return 'No data';
+  }
+
+  const keys = Object.keys(firstItem);
+  const colWidths = keys.map(key => {
+    const maxValue = Math.max(
+      key.length,
+      ...items.map(item => String(item[key] ?? '').length)
+    );
+    return Math.min(maxValue, 40);
+  });
+
+  const header = keys.map((key, i) => key.padEnd(colWidths[i] ?? 10)).join(' | ');
+  const separator = colWidths.map(w => '-'.repeat(w)).join('-+-');
+
+  const rows = items.map(item =>
+    keys.map((key, i) => {
+      const value = String(item[key] ?? '');
+      const width = colWidths[i] ?? 10;
+      return value.length > width
+        ? value.substring(0, width - 3) + '...'
+        : value.padEnd(width);
+    }).join(' | ')
+  );
+
+  return [header, separator, ...rows].join('\n');
+}
+
+function formatPretty(data: unknown): string {
+  if (Array.isArray(data)) {
+    return data.map((item, i) => `${chalk.cyan(`[${i + 1}]`)} ${formatPrettyItem(item)}`).join('\n\n');
+  }
+  return formatPrettyItem(data);
+}
+
+function formatPrettyItem(item: unknown, indent = 0): string {
+  if (item === null || item === undefined) {
+    return chalk.gray('null');
+  }
+
+  if (typeof item !== 'object') {
+    return String(item);
+  }
+
+  const spaces = '  '.repeat(indent);
+  const entries = Object.entries(item as Record<string, unknown>);
+
+  return entries
+    .map(([key, value]) => {
+      if (Array.isArray(value)) {
+        if (value.length === 0) {
+          return `${spaces}${chalk.blue(key)}: ${chalk.gray('[]')}`;
+        }
+        if (typeof value[0] === 'object') {
+          return `${spaces}${chalk.blue(key)}:\n${value.map(v => formatPrettyItem(v, indent + 1)).join('\n')}`;
+        }
+        return `${spaces}${chalk.blue(key)}: ${value.join(', ')}`;
+      }
+
+      if (typeof value === 'object' && value !== null) {
+        return `${spaces}${chalk.blue(key)}:\n${formatPrettyItem(value, indent + 1)}`;
+      }
+
+      return `${spaces}${chalk.blue(key)}: ${chalk.white(String(value))}`;
+    })
+    .join('\n');
+}
+
+export function success(message: string): void {
+  console.log(chalk.green('✓'), message);
+}
+
+export function error(message: string): void {
+  console.error(chalk.red('✗'), message);
+}
+
+export function warn(message: string): void {
+  console.warn(chalk.yellow('⚠'), message);
+}
+
+export function info(message: string): void {
+  console.log(chalk.blue('ℹ'), message);
+}
+
+export function heading(message: string): void {
+  console.log(chalk.bold.cyan(`\n${message}\n`));
+}
+
+export function print(data: unknown, format: OutputFormat = 'pretty'): void {
+  console.log(formatOutput(data, format));
+}

package/connectors/connect-speechify/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["bun-types"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "bin"]
+}

package/connectors/connect-spike/.env.example

@@ -0,0 +1,11 @@
+# API Credentials
+# TODO: Update variable names and instructions for your API
+# Example: PERPLEXITY_API_KEY, OPENAI_API_KEY, etc.
+
+CONNECTOR_API_KEY=your-api-key-here
+
+# Optional: API secret (if your API requires it)
+# CONNECTOR_API_SECRET=your-api-secret-here
+
+# Optional: Custom base URL (if needed)
+# CONNECTOR_BASE_URL=https://api.example.com

package/connectors/connect-spike/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);
+  }
+}
+```