@hasna/connectors 0.5.0 → 0.5.2

package/connectors/connect-ably/src/utils/settings.ts

@@ -0,0 +1,114 @@
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import { join } from 'path';
+import { getConfigDir, ensureConfigDir } from './config';
+
+// ============================================
+// Settings Storage Utility
+// ============================================
+
+/**
+ * TODO: Define your connector-specific settings
+ * Add fields for user preferences, defaults, etc.
+ */
+export interface Settings {
+  // Display settings
+  defaultFormat: 'json' | 'table' | 'pretty';
+
+  // Behavior settings
+  confirmDestructive: boolean;  // Require confirmation for destructive operations
+  verboseOutput: boolean;       // Enable verbose output by default
+
+  // API settings
+  defaultMaxResults: number;    // Default page size for list operations
+  requestTimeout: number;       // Request timeout in ms
+
+  // Add more settings as needed for your connector
+}
+
+const DEFAULT_SETTINGS: Settings = {
+  defaultFormat: 'pretty',
+  confirmDestructive: true,
+  verboseOutput: false,
+  defaultMaxResults: 20,
+  requestTimeout: 30000,
+};
+
+function getSettingsPath(): string {
+  return join(getConfigDir(), 'settings.json');
+}
+
+/**
+ * Load settings from disk, merging with defaults
+ */
+export function loadSettings(): Settings {
+  ensureConfigDir();
+  const filepath = getSettingsPath();
+
+  if (!existsSync(filepath)) {
+    // Create default settings file
+    saveSettings(DEFAULT_SETTINGS);
+    return DEFAULT_SETTINGS;
+  }
+
+  try {
+    const content = readFileSync(filepath, 'utf-8');
+    const loaded = JSON.parse(content);
+    // Merge with defaults to ensure all fields exist
+    return { ...DEFAULT_SETTINGS, ...loaded };
+  } catch {
+    return DEFAULT_SETTINGS;
+  }
+}
+
+/**
+ * Save settings to disk
+ */
+export function saveSettings(settings: Settings): void {
+  ensureConfigDir();
+  const filepath = getSettingsPath();
+  writeFileSync(filepath, JSON.stringify(settings, null, 2));
+}
+
+/**
+ * Get a specific setting value
+ */
+export function getSetting<K extends keyof Settings>(key: K): Settings[K] {
+  return loadSettings()[key];
+}
+
+/**
+ * Set a specific setting value
+ */
+export function setSetting<K extends keyof Settings>(key: K, value: Settings[K]): void {
+  const settings = loadSettings();
+  settings[key] = value;
+  saveSettings(settings);
+}
+
+/**
+ * Reset settings to defaults
+ */
+export function resetSettings(): void {
+  saveSettings(DEFAULT_SETTINGS);
+}
+
+/**
+ * Get default settings (useful for CLI help text)
+ */
+export function getDefaultSettings(): Settings {
+  return { ...DEFAULT_SETTINGS };
+}
+
+/**
+ * Check if verbose output is enabled
+ */
+export function isVerbose(): boolean {
+  return loadSettings().verboseOutput;
+}
+
+/**
+ * Check if destructive operations need confirmation
+ */
+export function needsConfirmation(): boolean {
+  return loadSettings().confirmDestructive;
+}

package/connectors/connect-ably/src/utils/storage.ts

@@ -0,0 +1,198 @@
+import { existsSync, readFileSync, writeFileSync, mkdirSync, readdirSync, unlinkSync } from 'fs';
+import { join } from 'path';
+import { getConfigDir } from './config';
+
+// ============================================
+// Generic Data Storage Utility
+// ============================================
+
+/**
+ * Base interface for storable entities
+ * All stored entities should have an id field
+ */
+export interface Storable {
+  id: string;
+  createdAt?: string;
+  updatedAt?: string;
+}
+
+/**
+ * Get the storage directory for an entity type
+ */
+function getStorageDir(entityType: string): string {
+  const dir = join(getConfigDir(), 'data', entityType);
+  if (!existsSync(dir)) {
+    mkdirSync(dir, { recursive: true });
+  }
+  return dir;
+}
+
+/**
+ * Convert an ID to a safe filename
+ */
+function idToFilename(id: string): string {
+  return id.toLowerCase().replace(/[^a-z0-9]/g, '_') + '.json';
+}
+
+/**
+ * Get the file path for an entity
+ */
+function getEntityPath(entityType: string, id: string): string {
+  return join(getStorageDir(entityType), idToFilename(id));
+}
+
+/**
+ * Save an entity to storage
+ */
+export function saveEntity<T extends Storable>(entityType: string, entity: T): void {
+  const filepath = getEntityPath(entityType, entity.id);
+  const now = new Date().toISOString();
+
+  const existing = getEntity<T>(entityType, entity.id);
+
+  const data: T = {
+    ...entity,
+    createdAt: existing?.createdAt || now,
+    updatedAt: now,
+  };
+
+  writeFileSync(filepath, JSON.stringify(data, null, 2));
+}
+
+/**
+ * Get an entity by ID
+ */
+export function getEntity<T extends Storable>(entityType: string, id: string): T | null {
+  const filepath = getEntityPath(entityType, id);
+
+  if (!existsSync(filepath)) {
+    return null;
+  }
+
+  try {
+    const content = readFileSync(filepath, 'utf-8');
+    return JSON.parse(content) as T;
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Check if an entity exists
+ */
+export function entityExists(entityType: string, id: string): boolean {
+  return existsSync(getEntityPath(entityType, id));
+}
+
+/**
+ * Get all entities of a type
+ */
+export function getAllEntities<T extends Storable>(entityType: string): T[] {
+  const storageDir = getStorageDir(entityType);
+  const files = readdirSync(storageDir).filter(f => f.endsWith('.json'));
+
+  const entities: T[] = [];
+  for (const file of files) {
+    try {
+      const content = readFileSync(join(storageDir, file), 'utf-8');
+      entities.push(JSON.parse(content) as T);
+    } catch {
+      // Skip invalid files
+    }
+  }
+
+  return entities.sort((a, b) => a.id.localeCompare(b.id));
+}
+
+/**
+ * Delete an entity
+ */
+export function deleteEntity(entityType: string, id: string): boolean {
+  const filepath = getEntityPath(entityType, id);
+
+  if (existsSync(filepath)) {
+    unlinkSync(filepath);
+    return true;
+  }
+  return false;
+}
+
+/**
+ * Search entities by a predicate function
+ */
+export function searchEntities<T extends Storable>(
+  entityType: string,
+  predicate: (entity: T) => boolean
+): T[] {
+  const all = getAllEntities<T>(entityType);
+  return all.filter(predicate);
+}
+
+/**
+ * Search entities by text match across all string fields
+ */
+export function searchEntitiesByText<T extends Storable>(
+  entityType: string,
+  query: string,
+  fields?: (keyof T)[]
+): T[] {
+  const all = getAllEntities<T>(entityType);
+  const q = query.toLowerCase();
+
+  return all.filter(entity => {
+    const searchFields = fields || (Object.keys(entity) as (keyof T)[]);
+    return searchFields.some(field => {
+      const value = entity[field];
+      if (typeof value === 'string') {
+        return value.toLowerCase().includes(q);
+      }
+      return false;
+    });
+  });
+}
+
+/**
+ * Count entities of a type
+ */
+export function countEntities(entityType: string): number {
+  const storageDir = getStorageDir(entityType);
+  if (!existsSync(storageDir)) {
+    return 0;
+  }
+  return readdirSync(storageDir).filter(f => f.endsWith('.json')).length;
+}
+
+/**
+ * Clear all entities of a type
+ */
+export function clearEntities(entityType: string): number {
+  const storageDir = getStorageDir(entityType);
+  if (!existsSync(storageDir)) {
+    return 0;
+  }
+
+  const files = readdirSync(storageDir).filter(f => f.endsWith('.json'));
+  for (const file of files) {
+    unlinkSync(join(storageDir, file));
+  }
+
+  return files.length;
+}
+
+/**
+ * Create a typed storage helper for a specific entity type
+ * This provides a cleaner API for working with a single entity type
+ */
+export function createStorage<T extends Storable>(entityType: string) {
+  return {
+    save: (entity: T) => saveEntity<T>(entityType, entity),
+    get: (id: string) => getEntity<T>(entityType, id),
+    exists: (id: string) => entityExists(entityType, id),
+    getAll: () => getAllEntities<T>(entityType),
+    delete: (id: string) => deleteEntity(entityType, id),
+    search: (predicate: (entity: T) => boolean) => searchEntities<T>(entityType, predicate),
+    searchByText: (query: string, fields?: (keyof T)[]) => searchEntitiesByText<T>(entityType, query, fields),
+    count: () => countEntities(entityType),
+    clear: () => clearEntities(entityType),
+  };
+}

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