@hasna/connectors 0.7.2 → 0.8.0

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

@@ -0,0 +1,213 @@
+import type { ConnectorConfig, OutputFormat } from '../types';
+import { ConnectorApiError, parseApiError } from '../types';
+
+// TODO: Replace with your API's base URL
+const DEFAULT_BASE_URL = 'https://api.example.com';
+
+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>;
+  format?: OutputFormat;
+  /** Number of retries for failed requests (default: 3) */
+  retries?: number;
+  /** Timeout in milliseconds (default: 30000) */
+  timeout?: number;
+}
+
+export class ConnectorClient {
+  private readonly apiKey: string;
+  private readonly apiSecret?: string;
+  private readonly baseUrl: string;
+
+  constructor(config: ConnectorConfig) {
+    // Support both 'apiKey' and 'token' for flexibility
+    // Also support 'accessToken' for OAuth2
+    const key = config.apiKey || config.token || config.accessToken;
+    if (!key) {
+      throw new Error('API key, token, or accessToken is required');
+    }
+    this.apiKey = key;
+    this.apiSecret = config.apiSecret;
+    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();
+  }
+
+  /**
+   * Sleep for a given number of milliseconds
+   */
+  private sleep(ms: number): Promise<void> {
+    return new Promise(resolve => setTimeout(resolve, ms));
+  }
+
+  /**
+   * Calculate delay for exponential backoff
+   */
+  private getRetryDelay(attempt: number, baseDelay: number = 1000): number {
+    // Exponential backoff with jitter: base * 2^attempt + random(0-1000)ms
+    return baseDelay * Math.pow(2, attempt) + Math.random() * 1000;
+  }
+
+  /**
+   * Check if error is retryable
+   */
+  private isRetryableStatus(status: number): boolean {
+    // Retry on rate limit (429) and server errors (5xx)
+    return status === 429 || (status >= 500 && status < 600);
+  }
+
+  /**
+   * Make an authenticated request to the API
+   * TODO: Adjust authentication method for your API:
+   * - Bearer token: Authorization: Bearer <token>
+   * - API Key header: X-API-Key: <key>
+   * - Basic auth: Authorization: Basic <base64(key:secret)>
+   */
+  async request<T>(path: string, options: RequestOptions = {}): Promise<T> {
+    const { method = 'GET', params, body, headers = {}, retries = 3, timeout = 30000 } = options;
+
+    const url = this.buildUrl(path, params);
+
+    // TODO: Adjust authentication header for your API
+    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);
+    }
+
+    let lastError: Error | null = null;
+    let lastStatus: number = 0;
+
+    for (let attempt = 0; attempt <= retries; attempt++) {
+      try {
+        // Create abort controller for timeout
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => controller.abort(), timeout);
+
+        const response = await fetch(url, {
+          ...fetchOptions,
+          signal: controller.signal,
+        });
+
+        clearTimeout(timeoutId);
+        lastStatus = response.status;
+
+        // Handle 204 No Content
+        if (response.status === 204) {
+          return {} as T;
+        }
+
+        // Parse response
+        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();
+        }
+
+        // Handle errors
+        if (!response.ok) {
+          // Check if we should retry
+          if (this.isRetryableStatus(response.status) && attempt < retries) {
+            // Check for Retry-After header
+            const retryAfter = response.headers.get('retry-after');
+            const delay = retryAfter
+              ? parseInt(retryAfter, 10) * 1000
+              : this.getRetryDelay(attempt);
+
+            await this.sleep(delay);
+            continue;
+          }
+
+          throw parseApiError(data, response.status);
+        }
+
+        return data as T;
+      } catch (err) {
+        lastError = err instanceof Error ? err : new Error(String(err));
+
+        // Handle timeout errors
+        if (lastError.name === 'AbortError') {
+          lastError = new Error(`Request timeout after ${timeout}ms`);
+        }
+
+        // Retry on network errors
+        if (attempt < retries && !(err instanceof ConnectorApiError)) {
+          await this.sleep(this.getRetryDelay(attempt));
+          continue;
+        }
+
+        throw err;
+      }
+    }
+
+    // Should not reach here, but just in case
+    throw lastError || new ConnectorApiError('Request failed', lastStatus);
+  }
+
+  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, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'POST', body: body as Record<string, unknown>, params });
+  }
+
+  async put<T>(path: string, body?: Record<string, unknown> | object, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'PUT', body: body as Record<string, unknown>, params });
+  }
+
+  async patch<T>(path: string, body?: Record<string, unknown> | object, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'PATCH', body: body as Record<string, unknown>, params });
+  }
+
+  async delete<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'DELETE', params });
+  }
+
+  /**
+   * Get a preview of the API key (for display/debugging)
+   */
+  getApiKeyPreview(): string {
+    if (this.apiKey.length > 10) {
+      return `${this.apiKey.substring(0, 6)}...${this.apiKey.substring(this.apiKey.length - 4)}`;
+    }
+    return '***';
+  }
+}

package/connectors/connect-apiary/src/api/example.ts

@@ -0,0 +1,48 @@
+import type { ConnectorClient } from './client';
+import type { ExampleResource, ExampleListResponse, ExampleCreateParams } from '../types';
+
+/**
+ * Example API module - demonstrates the pattern for API modules
+ * TODO: Replace with your actual API endpoints
+ */
+export class ExampleApi {
+  constructor(private readonly client: ConnectorClient) {}
+
+  /**
+   * List resources with optional pagination
+   */
+  async list(options?: { maxResults?: number; pageToken?: string }): Promise<ExampleListResponse> {
+    return this.client.get<ExampleListResponse>('/resources', {
+      max_results: options?.maxResults,
+      page_token: options?.pageToken,
+    });
+  }
+
+  /**
+   * Get a single resource by ID
+   */
+  async get(id: string): Promise<ExampleResource> {
+    return this.client.get<ExampleResource>(`/resources/${id}`);
+  }
+
+  /**
+   * Create a new resource
+   */
+  async create(params: ExampleCreateParams): Promise<ExampleResource> {
+    return this.client.post<ExampleResource>('/resources', params);
+  }
+
+  /**
+   * Update an existing resource
+   */
+  async update(id: string, params: Partial<ExampleCreateParams>): Promise<ExampleResource> {
+    return this.client.patch<ExampleResource>(`/resources/${id}`, params);
+  }
+
+  /**
+   * Delete a resource
+   */
+  async delete(id: string): Promise<void> {
+    await this.client.delete(`/resources/${id}`);
+  }
+}

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

@@ -0,0 +1,51 @@
+import type { ConnectorConfig } from '../types';
+import { ConnectorClient } from './client';
+import { ExampleApi } from './example';
+
+/**
+ * Main Connector class
+ * TODO: Rename to your API name (e.g., Perplexity, Twitter, etc.)
+ */
+export class Connector {
+  private readonly client: ConnectorClient;
+
+  // API modules - add more as needed
+  public readonly example: ExampleApi;
+
+  constructor(config: ConnectorConfig) {
+    this.client = new ConnectorClient(config);
+    this.example = new ExampleApi(this.client);
+  }
+
+  /**
+   * Create a client from environment variables
+   * TODO: Update env var names for your API
+   * Looks for CONNECTOR_API_KEY and optionally CONNECTOR_API_SECRET
+   */
+  static fromEnv(): Connector {
+    const apiKey = process.env.CONNECTOR_API_KEY;
+    const apiSecret = process.env.CONNECTOR_API_SECRET;
+
+    if (!apiKey) {
+      throw new Error('CONNECTOR_API_KEY environment variable is required');
+    }
+    return new Connector({ apiKey, apiSecret });
+  }
+
+  /**
+   * Get a preview of the API key (for debugging)
+   */
+  getApiKeyPreview(): string {
+    return this.client.getApiKeyPreview();
+  }
+
+  /**
+   * Get the underlying client for direct API access
+   */
+  getClient(): ConnectorClient {
+    return this.client;
+  }
+}
+
+export { ConnectorClient } from './client';
+export { ExampleApi } from './example';

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

@@ -0,0 +1,254 @@
+#!/usr/bin/env bun
+import { Command } from 'commander';
+import chalk from 'chalk';
+import { Connector } 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, warn, setVerboseMode, debug } from '../utils/output';
+
+// TODO: Update connector name and version
+const CONNECTOR_NAME = 'connector';
+const VERSION = '0.1.0';
+
+const program = new Command();
+
+program
+  .name(CONNECTOR_NAME)
+  .description('API connector CLI - TODO: Add your description')
+  .version(VERSION)
+  .option('-k, --api-key <key>', 'API key (overrides config)')
+  .option('-f, --format <format>', 'Output format (json, pretty)', 'pretty')
+  .option('-p, --profile <profile>', 'Use a specific profile')
+  .option('-v, --verbose', 'Enable verbose output for debugging')
+  .hook('preAction', (thisCommand) => {
+    const opts = thisCommand.opts();
+
+    // Enable verbose mode if flag is set
+    if (opts.verbose) {
+      setVerboseMode(true);
+      debug('Verbose mode enabled');
+    }
+
+    // Set profile override before any command runs
+    if (opts.profile) {
+      if (!profileExists(opts.profile)) {
+        error(`Profile "${opts.profile}" does not exist. Create it with "${CONNECTOR_NAME} profile create ${opts.profile}"`);
+        process.exit(1);
+      }
+      setProfileOverride(opts.profile);
+      debug(`Using profile: ${opts.profile}`);
+    }
+
+    // Set API key from flag if provided
+    if (opts.apiKey) {
+      process.env.CONNECTOR_API_KEY = opts.apiKey;
+      debug('API key set from command line flag');
+    }
+  });
+
+// Helper to get output format
+function getFormat(cmd: Command): OutputFormat {
+  const parent = cmd.parent;
+  return (parent?.opts().format || 'pretty') as OutputFormat;
+}
+
+// Helper to get authenticated client
+function getClient(): Connector {
+  const apiKey = getApiKey();
+  if (!apiKey) {
+    error(`No API key configured. Run "${CONNECTOR_NAME} config set-key <key>" or set CONNECTOR_API_KEY environment variable.`);
+    process.exit(1);
+  }
+  return new Connector({ apiKey });
+}
+
+// ============================================
+// Profile Commands
+// ============================================
+const profileCmd = program
+  .command('profile')
+  .description('Manage configuration profiles');
+
+profileCmd
+  .command('list')
+  .description('List all profiles')
+  .action(() => {
+    const profiles = listProfiles();
+    const current = getCurrentProfile();
+
+    if (profiles.length === 0) {
+      info('No profiles found. Use "profile create <name>" to create one.');
+      return;
+    }
+
+    success(`Profiles:`);
+    profiles.forEach(p => {
+      const isActive = p === current ? chalk.green(' (active)') : '';
+      console.log(`  ${p}${isActive}`);
+    });
+  });
+
+profileCmd
+  .command('use <name>')
+  .description('Switch to a profile')
+  .action((name: string) => {
+    if (!profileExists(name)) {
+      error(`Profile "${name}" does not exist. Create it with "profile create ${name}"`);
+      process.exit(1);
+    }
+    setCurrentProfile(name);
+    success(`Switched to profile: ${name}`);
+  });
+
+profileCmd
+  .command('create <name>')
+  .description('Create a new profile')
+  .option('--api-key <key>', 'API key')
+  .option('--use', 'Switch to this profile after creation')
+  .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 a profile')
+  .action((name: string) => {
+    if (name === 'default') {
+      error('Cannot delete the 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 configuration')
+  .action((name?: string) => {
+    const profileName = name || getCurrentProfile();
+    const config = loadProfile(profileName);
+    const active = getCurrentProfile();
+
+    console.log(chalk.bold(`Profile: ${profileName}${profileName === active ? chalk.green(' (active)') : ''}`));
+    info(`API Key: ${config.apiKey ? `${config.apiKey.substring(0, 8)}...` : chalk.gray('not set')}`);
+  });
+
+// ============================================
+// Config Commands
+// ============================================
+const configCmd = program
+  .command('config')
+  .description('Manage CLI configuration (for active profile)');
+
+configCmd
+  .command('set-key <apiKey>')
+  .description('Set API key')
+  .action((apiKey: string) => {
+    setApiKey(apiKey);
+    success(`API key saved to profile: ${getCurrentProfile()}`);
+  });
+
+configCmd
+  .command('show')
+  .description('Show current configuration')
+  .action(() => {
+    const profileName = getCurrentProfile();
+    const apiKey = getApiKey();
+
+    console.log(chalk.bold(`Active Profile: ${profileName}`));
+    info(`Config directory: ${getConfigDir()}`);
+    info(`API Key: ${apiKey ? `${apiKey.substring(0, 8)}...` : chalk.gray('not set')}`);
+  });
+
+configCmd
+  .command('clear')
+  .description('Clear configuration for active profile')
+  .action(() => {
+    clearConfig();
+    success(`Configuration cleared for profile: ${getCurrentProfile()}`);
+  });
+
+// ============================================
+// Example API Commands - TODO: Replace with your API commands
+// ============================================
+const exampleCmd = program
+  .command('example')
+  .description('Example API commands (replace with your commands)');
+
+exampleCmd
+  .command('list')
+  .description('List resources')
+  .option('-n, --max <number>', 'Maximum results', '10')
+  .action(async (opts) => {
+    try {
+      const client = getClient();
+      const result = await client.example.list({ maxResults: parseInt(opts.max) });
+      print(result, getFormat(exampleCmd));
+    } catch (err) {
+      error(String(err));
+      process.exit(1);
+    }
+  });
+
+exampleCmd
+  .command('get <id>')
+  .description('Get a resource by ID')
+  .action(async (id: string) => {
+    try {
+      const client = getClient();
+      const result = await client.example.get(id);
+      print(result, getFormat(exampleCmd));
+    } catch (err) {
+      error(String(err));
+      process.exit(1);
+    }
+  });
+
+exampleCmd
+  .command('create')
+  .description('Create a new resource')
+  .requiredOption('-n, --name <name>', 'Resource name')
+  .action(async (opts) => {
+    try {
+      const client = getClient();
+      const result = await client.example.create({ name: opts.name });
+      success('Resource created!');
+      print(result, getFormat(exampleCmd));
+    } catch (err) {
+      error(String(err));
+      process.exit(1);
+    }
+  });
+
+// Parse and execute
+program.parse();

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

@@ -0,0 +1,103 @@
+// Connector API
+// A TypeScript wrapper for your API - TODO: Update description
+
+export { Connector } from './api';
+export * from './types';
+
+// Re-export individual API classes for advanced usage
+export { ConnectorClient, ExampleApi } from './api';
+
+// Export config utilities
+export {
+  getApiKey,
+  setApiKey,
+  getApiSecret,
+  setApiSecret,
+  getToken,
+  setToken,
+  getCurrentProfile,
+  setCurrentProfile,
+  listProfiles,
+  createProfile,
+  deleteProfile,
+  loadProfile,
+  saveProfile,
+  clearConfig,
+  getOAuthConfig,
+  setOAuthConfig,
+  loadOAuthTokens,
+  saveOAuthTokens,
+  clearOAuthTokens,
+  getAccessToken,
+} from './utils/config';
+
+// Export OAuth2 utilities
+export {
+  getAuthUrl,
+  exchangeCodeForTokens,
+  refreshAccessToken,
+  startCallbackServer,
+  getValidAccessToken,
+  isAuthenticated,
+  getRedirectUri,
+  getRedirectPort,
+  type AuthResult,
+  type AuthUrlOptions,
+} from './utils/auth';
+
+// Export settings utilities
+export {
+  loadSettings,
+  saveSettings,
+  getSetting,
+  setSetting,
+  resetSettings,
+  getDefaultSettings,
+  isVerbose,
+  needsConfirmation,
+  type Settings,
+} from './utils/settings';
+
+// Export storage utilities
+export {
+  saveEntity,
+  getEntity,
+  entityExists,
+  getAllEntities,
+  deleteEntity,
+  searchEntities,
+  searchEntitiesByText,
+  countEntities,
+  clearEntities,
+  createStorage,
+  type Storable,
+} from './utils/storage';
+
+// Export bulk operation utilities
+export {
+  executeBulk,
+  executeSequential,
+  chunkArray,
+  sleep,
+  createProgressReporter,
+  formatBulkResult,
+  type BulkOperationOptions,
+  type BulkOperationResult,
+} from './utils/bulk';
+
+// Export output utilities
+export {
+  formatOutput,
+  success,
+  error,
+  warn,
+  info,
+  heading,
+  print,
+  setVerboseMode,
+  isVerboseMode,
+  debug,
+  debugRequest,
+  debugResponse,
+  type OutputFormat,
+} from './utils/output';