@hasna/connectors 0.4.0 → 0.4.1

package/connectors/connect-freshdesk/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-freshdesk/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';

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

@@ -0,0 +1,237 @@
+// Scaffold Connector Types
+// Replace CONNECTOR with your API name (e.g., Perplexity, Twitter, etc.)
+
+// ============================================
+// Configuration
+// ============================================
+
+export interface ConnectorConfig {
+  apiKey?: string;      // For API key authentication
+  token?: string;       // Alias for apiKey (some APIs use 'token')
+  apiSecret?: string;   // Optional - some APIs need only a key
+  accessToken?: string; // For OAuth2 authentication
+  baseUrl?: string;     // Override default base URL
+}
+
+// ============================================
+// OAuth2 Types
+// ============================================
+
+export interface OAuth2Config {
+  clientId: string;
+  clientSecret: string;
+  redirectUri?: string;
+}
+
+export interface OAuth2Tokens {
+  accessToken: string;
+  refreshToken?: string;
+  expiresAt: number;
+  tokenType?: string;
+  scope?: string;
+}
+
+// ============================================
+// Common Types
+// ============================================
+
+export type OutputFormat = 'json' | 'pretty';
+
+export interface PaginatedResponse<T> {
+  data: T[];
+  nextToken?: string;
+  hasMore: boolean;
+}
+
+// ============================================
+// Example Resource Types
+// ============================================
+
+// Replace with your API's resource types
+export interface ExampleResource {
+  id: string;
+  name: string;
+  createdAt: string;
+  updatedAt: string;
+  // Add more fields as needed
+}
+
+export interface ExampleListResponse {
+  items: ExampleResource[];
+  nextPageToken?: string;
+  total?: number;
+}
+
+export interface ExampleCreateParams {
+  name: string;
+  // Add more params as needed
+}
+
+// ============================================
+// API Error Types
+// ============================================
+
+export interface ApiErrorDetail {
+  code: string;
+  message: string;
+  field?: string;
+  resource?: string;
+}
+
+export class ConnectorApiError extends Error {
+  public readonly statusCode: number;
+  public readonly errors?: ApiErrorDetail[];
+  public readonly documentationUrl?: string;
+  public readonly requestId?: string;
+
+  constructor(
+    message: string,
+    statusCode: number,
+    options?: {
+      errors?: ApiErrorDetail[];
+      documentationUrl?: string;
+      requestId?: string;
+    }
+  ) {
+    super(message);
+    this.name = 'ConnectorApiError';
+    this.statusCode = statusCode;
+    this.errors = options?.errors;
+    this.documentationUrl = options?.documentationUrl;
+    this.requestId = options?.requestId;
+  }
+
+  /**
+   * Check if this is a rate limit error
+   */
+  isRateLimited(): boolean {
+    return this.statusCode === 429;
+  }
+
+  /**
+   * Check if this is a server error
+   */
+  isServerError(): boolean {
+    return this.statusCode >= 500 && this.statusCode < 600;
+  }
+
+  /**
+   * Check if this is a client error
+   */
+  isClientError(): boolean {
+    return this.statusCode >= 400 && this.statusCode < 500;
+  }
+
+  /**
+   * Check if this is an authentication error
+   */
+  isAuthError(): boolean {
+    return this.statusCode === 401 || this.statusCode === 403;
+  }
+
+  /**
+   * Check if this is a not found error
+   */
+  isNotFound(): boolean {
+    return this.statusCode === 404;
+  }
+
+  /**
+   * Get a user-friendly error message
+   */
+  getUserMessage(): string {
+    switch (this.statusCode) {
+      case 400:
+        return 'Bad request. Please check your input.';
+      case 401:
+        return 'Authentication failed. Please check your API key or login again.';
+      case 403:
+        return 'Access denied. You do not have permission to perform this action.';
+      case 404:
+        return 'Resource not found.';
+      case 429:
+        return 'Rate limit exceeded. Please wait and try again.';
+      case 500:
+        return 'Server error. Please try again later.';
+      case 502:
+      case 503:
+      case 504:
+        return 'Service temporarily unavailable. Please try again later.';
+      default:
+        return this.message;
+    }
+  }
+
+  /**
+   * Convert to JSON for logging/debugging
+   */
+  toJSON(): Record<string, unknown> {
+    return {
+      name: this.name,
+      message: this.message,
+      statusCode: this.statusCode,
+      errors: this.errors,
+      documentationUrl: this.documentationUrl,
+      requestId: this.requestId,
+    };
+  }
+}
+
+/**
+ * Parse an API error response into a ConnectorApiError
+ * Handles various common API error response formats
+ */
+export function parseApiError(
+  response: unknown,
+  statusCode: number
+): ConnectorApiError {
+  // Handle string responses
+  if (typeof response === 'string') {
+    return new ConnectorApiError(response, statusCode);
+  }
+
+  // Handle null/undefined
+  if (!response || typeof response !== 'object') {
+    return new ConnectorApiError(`HTTP ${statusCode} Error`, statusCode);
+  }
+
+  const data = response as Record<string, unknown>;
+
+  // Extract message from various common formats
+  const message =
+    (data.message as string) ||
+    (data.error as string) ||
+    ((data.error as Record<string, unknown>)?.message as string) ||
+    (data.error_description as string) ||
+    (data.detail as string) ||
+    `HTTP ${statusCode} Error`;
+
+  // Extract errors array if present
+  let errors: ApiErrorDetail[] | undefined;
+  if (Array.isArray(data.errors)) {
+    errors = data.errors.map((e: Record<string, unknown>) => ({
+      code: String(e.code || e.error || 'unknown'),
+      message: String(e.message || e.description || 'Unknown error'),
+      field: e.field as string,
+      resource: e.resource as string,
+    }));
+  }
+
+  // Extract documentation URL
+  const documentationUrl =
+    (data.documentation_url as string) ||
+    (data.docs_url as string) ||
+    (data.help_url as string);
+
+  // Extract request ID
+  const requestId =
+    (data.request_id as string) ||
+    (data.requestId as string) ||
+    (data.trace_id as string);
+
+  return new ConnectorApiError(message, statusCode, {
+    errors,
+    documentationUrl,
+    requestId,
+  });
+}