@hasna/connectors 0.9.3 → 1.0.0

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

@@ -0,0 +1,342 @@
+import { existsSync, readFileSync, writeFileSync, mkdirSync, readdirSync, rmSync } from 'fs';
+import { homedir } from 'os';
+import { join } from 'path';
+import type { OAuth2Tokens, CliConfig } from '../types';
+
+const CONNECTOR_NAME = 'connect-googleads';
+const DEFAULT_PROFILE = 'default';
+const CURRENT_PROFILE_FILE = 'current_profile';
+const PROFILES_DIR = 'profiles';
+
+// Store for --profile flag override
+let profileOverride: string | undefined;
+
+function resolveBaseConfigDir(): string {
+  return join(homedir(), '.connect', CONNECTOR_NAME);
+}
+
+const BASE_CONFIG_DIR = resolveBaseConfigDir();
+
+// ============================================
+// Profile Management
+// ============================================
+
+export function setProfileOverride(profile: string | undefined): void {
+  profileOverride = profile;
+}
+
+export function getProfileOverride(): string | undefined {
+  return profileOverride;
+}
+
+function ensureBaseConfigDir(): void {
+  if (!existsSync(BASE_CONFIG_DIR)) {
+    mkdirSync(BASE_CONFIG_DIR, { recursive: true });
+  }
+}
+
+function getProfilesDir(): string {
+  return join(BASE_CONFIG_DIR, PROFILES_DIR);
+}
+
+function getCurrentProfileFile(): string {
+  return join(BASE_CONFIG_DIR, CURRENT_PROFILE_FILE);
+}
+
+export function profileExists(profile: string): boolean {
+  ensureProfilesDir();
+  const profileDir = join(getProfilesDir(), profile);
+  return existsSync(profileDir);
+}
+
+function ensureProfilesDir(): void {
+  const profilesDir = getProfilesDir();
+  if (!existsSync(profilesDir)) {
+    mkdirSync(profilesDir, { recursive: true });
+  }
+}
+
+export function getCurrentProfile(): string {
+  if (profileOverride) {
+    return profileOverride;
+  }
+
+  ensureBaseConfigDir();
+  ensureProfilesDir();
+
+  const currentProfileFile = getCurrentProfileFile();
+  if (existsSync(currentProfileFile)) {
+    try {
+      const profile = readFileSync(currentProfileFile, 'utf-8').trim();
+      if (profile && profileExists(profile)) {
+        return profile;
+      }
+    } catch {
+      // Fall through to default
+    }
+  }
+
+  return DEFAULT_PROFILE;
+}
+
+export function setCurrentProfile(profile: string): void {
+  ensureBaseConfigDir();
+  ensureProfilesDir();
+
+  if (!profileExists(profile) && profile !== DEFAULT_PROFILE) {
+    throw new Error(`Profile "${profile}" does not exist`);
+  }
+
+  writeFileSync(getCurrentProfileFile(), profile);
+}
+
+export function listProfiles(): string[] {
+  ensureBaseConfigDir();
+  ensureProfilesDir();
+
+  const profilesDir = getProfilesDir();
+  if (!existsSync(profilesDir)) {
+    return [];
+  }
+
+  return readdirSync(profilesDir, { withFileTypes: true })
+    .filter(dirent => dirent.isDirectory())
+    .map(dirent => dirent.name)
+    .sort();
+}
+
+export function createProfile(profile: string): boolean {
+  ensureBaseConfigDir();
+  ensureProfilesDir();
+
+  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');
+  }
+
+  const profileDir = join(getProfilesDir(), profile);
+  mkdirSync(profileDir, { recursive: true });
+
+  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);
+  }
+
+  const profileDir = join(getProfilesDir(), profile);
+  rmSync(profileDir, { recursive: true });
+  return true;
+}
+
+function resolveConfigDir(): string {
+  ensureBaseConfigDir();
+  ensureProfilesDir();
+
+  const profile = getCurrentProfile();
+  const profileDir = join(getProfilesDir(), profile);
+
+  if (!existsSync(profileDir)) {
+    mkdirSync(profileDir, { recursive: true });
+  }
+
+  return profileDir;
+}
+
+function getConfigDirInternal(): string {
+  return resolveConfigDir();
+}
+
+export function getConfigDir(): string {
+  return getConfigDirInternal();
+}
+
+export function getBaseConfigDir(): string {
+  return BASE_CONFIG_DIR;
+}
+
+export function ensureConfigDir(): void {
+  const configDir = getConfigDirInternal();
+  if (!existsSync(configDir)) {
+    mkdirSync(configDir, { recursive: true });
+  }
+}
+
+// ============================================
+// OAuth2 Credentials (shared across profiles)
+// ============================================
+
+function loadBaseConfig(): CliConfig {
+  ensureBaseConfigDir();
+  const configFile = join(BASE_CONFIG_DIR, 'credentials.json');
+
+  if (!existsSync(configFile)) {
+    return {};
+  }
+
+  try {
+    return JSON.parse(readFileSync(configFile, 'utf-8'));
+  } catch {
+    return {};
+  }
+}
+
+function saveBaseConfig(config: CliConfig): void {
+  ensureBaseConfigDir();
+  const configFile = join(BASE_CONFIG_DIR, 'credentials.json');
+  writeFileSync(configFile, JSON.stringify(config, null, 2));
+}
+
+export function getClientId(): string | undefined {
+  return process.env.GOOGLE_ADS_CLIENT_ID || loadBaseConfig().clientId;
+}
+
+export function getClientSecret(): string | undefined {
+  return process.env.GOOGLE_ADS_CLIENT_SECRET || loadBaseConfig().clientSecret;
+}
+
+export function getDeveloperToken(): string | undefined {
+  return process.env.GOOGLE_ADS_DEVELOPER_TOKEN || loadBaseConfig().developerToken;
+}
+
+export function setCredentials(clientId: string, clientSecret: string): void {
+  const config = loadBaseConfig();
+  config.clientId = clientId;
+  config.clientSecret = clientSecret;
+  saveBaseConfig(config);
+}
+
+export function setDeveloperToken(token: string): void {
+  const config = loadBaseConfig();
+  config.developerToken = token;
+  saveBaseConfig(config);
+}
+
+// ============================================
+// OAuth2 Tokens (per profile)
+// ============================================
+
+export function loadTokens(): OAuth2Tokens | null {
+  ensureConfigDir();
+  const tokensFile = join(getConfigDirInternal(), 'tokens.json');
+
+  if (!existsSync(tokensFile)) {
+    return null;
+  }
+
+  try {
+    return JSON.parse(readFileSync(tokensFile, 'utf-8'));
+  } catch {
+    return null;
+  }
+}
+
+export function saveTokens(tokens: OAuth2Tokens): void {
+  ensureConfigDir();
+  const tokensFile = join(getConfigDirInternal(), 'tokens.json');
+  writeFileSync(tokensFile, JSON.stringify(tokens, null, 2), { mode: 0o600 });
+}
+
+export function clearTokens(): void {
+  const tokensFile = join(getConfigDirInternal(), 'tokens.json');
+  if (existsSync(tokensFile)) {
+    rmSync(tokensFile);
+  }
+}
+
+export function isTokenExpired(): boolean {
+  const tokens = loadTokens();
+  if (!tokens) return true;
+  return Date.now() >= tokens.expiresAt - 5 * 60 * 1000;
+}
+
+export function isAuthenticated(): boolean {
+  const tokens = loadTokens();
+  return tokens !== null && tokens.accessToken !== undefined && tokens.refreshToken !== undefined;
+}
+
+// ============================================
+// Profile Config (customer ID, etc.)
+// ============================================
+
+interface ProfileConfig {
+  customerId?: string;
+  loginCustomerId?: string;
+  accountName?: string;
+}
+
+function loadProfileConfig(): ProfileConfig {
+  ensureConfigDir();
+  const configFile = join(getConfigDirInternal(), 'config.json');
+
+  if (!existsSync(configFile)) {
+    return {};
+  }
+
+  try {
+    return JSON.parse(readFileSync(configFile, 'utf-8'));
+  } catch {
+    return {};
+  }
+}
+
+function saveProfileConfig(config: ProfileConfig): void {
+  ensureConfigDir();
+  const configFile = join(getConfigDirInternal(), 'config.json');
+  writeFileSync(configFile, JSON.stringify(config, null, 2));
+}
+
+export function getCustomerId(): string | undefined {
+  return process.env.GOOGLE_ADS_CUSTOMER_ID || loadProfileConfig().customerId;
+}
+
+export function setCustomerId(customerId: string): void {
+  const config = loadProfileConfig();
+  config.customerId = customerId;
+  saveProfileConfig(config);
+}
+
+export function getLoginCustomerId(): string | undefined {
+  return process.env.GOOGLE_ADS_LOGIN_CUSTOMER_ID || loadProfileConfig().loginCustomerId || loadBaseConfig().loginCustomerId;
+}
+
+export function setLoginCustomerId(customerId: string): void {
+  const config = loadProfileConfig();
+  config.loginCustomerId = customerId;
+  saveProfileConfig(config);
+}
+
+export function getAccountName(): string | undefined {
+  return loadProfileConfig().accountName;
+}
+
+export function setAccountName(name: string): void {
+  const config = loadProfileConfig();
+  config.accountName = name;
+  saveProfileConfig(config);
+}
+
+export function getAccessToken(): string | undefined {
+  if (process.env.GOOGLE_ADS_ACCESS_TOKEN) {
+    return process.env.GOOGLE_ADS_ACCESS_TOKEN;
+  }
+  const tokens = loadTokens();
+  return tokens?.accessToken;
+}
+
+export function clearConfig(): void {
+  saveProfileConfig({});
+  clearTokens();
+}

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

@@ -0,0 +1,62 @@
+import chalk from 'chalk';
+
+export type OutputFormat = 'json' | 'pretty';
+
+export function success(message: string): void {
+  console.log(chalk.green('OK'), message);
+}
+
+export function error(message: string): void {
+  console.error(chalk.red('Error'), message);
+}
+
+export function info(message: string): void {
+  console.log(chalk.blue('Info'), message);
+}
+
+export function warn(message: string): void {
+  console.log(chalk.yellow('Warn'), message);
+}
+
+export function print(data: unknown, format: OutputFormat = 'pretty'): void {
+  if (format === 'json') {
+    console.log(JSON.stringify(data, null, 2));
+  } else {
+    console.log(data);
+  }
+}
+
+export function formatMicros(micros: string | number | undefined): string {
+  if (micros === undefined || micros === null) return '$0.00';
+  const num = typeof micros === 'string' ? parseInt(micros, 10) : micros;
+  return `$${(num / 1_000_000).toFixed(2)}`;
+}
+
+export function formatNumber(num: string | number | undefined): string {
+  if (num === undefined || num === null) return '0';
+  const n = typeof num === 'string' ? parseInt(num, 10) : num;
+  if (n >= 1_000_000) {
+    return `${(n / 1_000_000).toFixed(1)}M`;
+  }
+  if (n >= 1_000) {
+    return `${(n / 1_000).toFixed(1)}K`;
+  }
+  return n.toString();
+}
+
+export function formatPercent(num: number | undefined): string {
+  if (num === undefined || num === null) return '0%';
+  return `${(num * 100).toFixed(2)}%`;
+}
+
+export function formatCustomerId(id: string): string {
+  // Format as XXX-XXX-XXXX
+  const clean = id.replace(/\D/g, '');
+  if (clean.length !== 10) return id;
+  return `${clean.slice(0, 3)}-${clean.slice(3, 6)}-${clean.slice(6)}`;
+}
+
+export function parseCustomerId(id: string): string {
+  // Remove dashes and return just digits
+  return id.replace(/\D/g, '');
+}

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