@hasna/connectors 0.4.0 → 0.4.2

package/connectors/connect-amplitude/README.md

@@ -0,0 +1,193 @@
+# scaffold-connector
+
+A TypeScript scaffold for building API connector CLIs with multi-profile support.
+
+## Features
+
+- Multi-profile configuration (switch between different API keys/accounts)
+- Bearer token authentication (easily customizable)
+- Clean CLI structure with Commander.js
+- Pretty and JSON output formats
+- TypeScript with strict mode
+
+## Quick Start
+
+### 1. Clone and Rename
+
+```bash
+# Clone for your connector
+git clone https://github.com/hasna/scaffold-connector.git connect-yourapi
+cd connect-yourapi
+
+# Update package.json name
+# Change "@hasna/scaffold-connector" to "@hasna/connect-yourapi"
+```
+
+### 2. Update Configuration
+
+Search for `TODO` comments throughout the codebase and update:
+
+- `src/cli/index.ts` - Update `CONNECTOR_NAME` and description
+- `src/utils/config.ts` - Update `CONNECTOR_NAME` and env var names
+- `src/api/client.ts` - Update `DEFAULT_BASE_URL` and authentication method
+- `src/api/index.ts` - Rename `Connector` class to your API name
+- `src/types/index.ts` - Add your API's type definitions
+- `package.json` - Update name, description, bin command
+- `.env.example` - Update environment variable names
+
+### 3. Install and Test
+
+```bash
+# Install dependencies
+bun install
+
+# Run CLI
+bun run dev
+
+# Or run specific commands
+bun run dev profile list
+bun run dev config show
+```
+
+## CLI Structure
+
+```bash
+connector [options] [command]
+
+Options:
+  -k, --api-key <key>      API key (overrides config)
+  -f, --format <format>    Output format (json, pretty)
+  -p, --profile <profile>  Use a specific profile
+
+Commands:
+  profile list             List all profiles
+  profile use <name>       Switch to a profile
+  profile create <name>    Create a new profile
+  profile delete <name>    Delete a profile
+  profile show [name]      Show profile configuration
+
+  config set-key <key>     Set API key for active profile
+  config show              Show current configuration
+  config clear             Clear configuration
+
+  example list             Example API command (replace)
+  example get <id>         Example API command (replace)
+  example create           Example API command (replace)
+```
+
+## Project Structure
+
+```
+src/
+├── api/
+│   ├── client.ts     # HTTP client with authentication
+│   ├── example.ts    # Example API module (replace with your API)
+│   └── index.ts      # Main connector class
+├── cli/
+│   └── index.ts      # CLI commands
+├── types/
+│   └── index.ts      # Type definitions
+├── utils/
+│   ├── config.ts     # Multi-profile configuration
+│   └── output.ts     # CLI output formatting
+└── index.ts          # Library exports
+```
+
+## Multi-Profile Configuration
+
+Profiles are stored in `~/.connect/{connector-name}/profiles/`:
+
+```
+~/.connect/connector/
+├── current_profile   # Name of active profile
+└── profiles/
+    ├── default.json  # Default profile
+    ├── work.json     # Named profile
+    └── personal.json # Named profile
+```
+
+### Profile Commands
+
+```bash
+# Create profiles
+connector profile create work --api-key sk-xxx --use
+connector profile create personal --api-key sk-yyy
+
+# Switch profiles
+connector profile use work
+
+# Use profile for single command
+connector -p personal example list
+
+# List profiles
+connector profile list
+```
+
+## Customizing Authentication
+
+Edit `src/api/client.ts` to change authentication:
+
+```typescript
+// Bearer token (default)
+'Authorization': `Bearer ${this.apiKey}`,
+
+// API Key header
+'X-API-Key': this.apiKey,
+
+// Basic auth
+'Authorization': `Basic ${Buffer.from(`${this.apiKey}:${this.apiSecret}`).toString('base64')}`,
+```
+
+## Adding API Endpoints
+
+1. Create a new file in `src/api/` (e.g., `users.ts`)
+2. Export it from `src/api/index.ts`
+3. Add types in `src/types/index.ts`
+4. Add CLI commands in `src/cli/index.ts`
+
+Example API module:
+
+```typescript
+// src/api/users.ts
+import type { ConnectorClient } from './client';
+
+export class UsersApi {
+  constructor(private readonly client: ConnectorClient) {}
+
+  async list(options?: { limit?: number }) {
+    return this.client.get('/users', { limit: options?.limit });
+  }
+
+  async get(id: string) {
+    return this.client.get(`/users/${id}`);
+  }
+}
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `CONNECTOR_API_KEY` | API key (overrides profile config) |
+| `CONNECTOR_API_SECRET` | API secret (optional) |
+| `CONNECTOR_BASE_URL` | Override base URL (optional) |
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Run CLI in development
+bun run dev
+
+# Build for distribution
+bun run build
+
+# Type check
+bun run typecheck
+```
+
+## License
+
+MIT

package/connectors/connect-amplitude/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@hasna/connect-amplitude",
+  "version": "0.0.1",
+  "description": "Amplitude connector - Analytics data, events, users, and cohorts",
+  "type": "module",
+  "bin": {
+    "connect-amplitude": "./bin/index.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun && bun build ./src/cli/index.ts --outdir ./bin --target bun",
+    "dev": "bun run ./src/cli/index.ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "bun run build"
+  },
+  "keywords": [
+    "amplitude",
+    "analytics",
+    "events",
+    "tracking",
+    "cohorts",
+    "connector",
+    "cli",
+    "typescript",
+    "bun"
+  ],
+  "author": "Hasna",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "commander": "^12.1.0",
+    "chalk": "^5.3.0"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hasna/connectors.git"
+  }
+}

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

@@ -0,0 +1,144 @@
+import type { AmplitudeConfig, OutputFormat, AmplitudeErrorResponse } from '../types';
+import { AmplitudeApiError } from '../types';
+
+// Amplitude API endpoints
+const API_BASE_URL = 'https://amplitude.com/api/2';
+const BATCH_API_URL = 'https://api2.amplitude.com/2';
+
+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;
+  useBatchApi?: boolean;
+}
+
+export class AmplitudeClient {
+  private readonly apiKey: string;
+  private readonly secretKey: string;
+
+  constructor(config: AmplitudeConfig) {
+    if (!config.apiKey) {
+      throw new Error('API key is required');
+    }
+    if (!config.secretKey) {
+      throw new Error('Secret key is required');
+    }
+    this.apiKey = config.apiKey;
+    this.secretKey = config.secretKey;
+  }
+
+  private getBaseUrl(useBatchApi?: boolean): string {
+    return useBatchApi ? BATCH_API_URL : API_BASE_URL;
+  }
+
+  private getAuthHeader(): string {
+    const credentials = `${this.apiKey}:${this.secretKey}`;
+    const encoded = Buffer.from(credentials).toString('base64');
+    return `Basic ${encoded}`;
+  }
+
+  private buildUrl(path: string, params?: Record<string, string | number | boolean | undefined>, useBatchApi?: boolean): string {
+    const url = new URL(`${this.getBaseUrl(useBatchApi)}${path}`);
+
+    if (params) {
+      Object.entries(params).forEach(([key, value]) => {
+        if (value !== undefined && value !== null && value !== '') {
+          url.searchParams.append(key, String(value));
+        }
+      });
+    }
+
+    return url.toString();
+  }
+
+  /**
+   * Make an authenticated request to Amplitude API
+   * Uses Basic Auth with API Key and Secret Key
+   */
+  async request<T>(path: string, options: RequestOptions = {}): Promise<T> {
+    const { method = 'GET', params, body, headers = {}, useBatchApi } = options;
+
+    const url = this.buildUrl(path, params, useBatchApi);
+
+    const requestHeaders: Record<string, string> = {
+      'Authorization': this.getAuthHeader(),
+      '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);
+    }
+
+    const response = await fetch(url, fetchOptions);
+
+    // 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) {
+      let errorMessage: string;
+      let errorCode: number | undefined;
+
+      if (typeof data === 'object' && data !== null) {
+        const errorData = data as AmplitudeErrorResponse;
+        errorMessage = errorData.error || errorData.message || JSON.stringify(data);
+        errorCode = errorData.code;
+      } else {
+        errorMessage = String(data || response.statusText);
+      }
+
+      throw new AmplitudeApiError(errorMessage, response.status, errorCode);
+    }
+
+    return data as T;
+  }
+
+  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>, useBatchApi?: boolean): Promise<T> {
+    return this.request<T>(path, { method: 'POST', body: body as Record<string, unknown>, params, useBatchApi });
+  }
+
+  /**
+   * 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-amplitude/src/api/index.ts

@@ -0,0 +1,215 @@
+import type {
+  AmplitudeConfig,
+  Event,
+  BatchEventResponse,
+  UserSearch,
+  UserActivity,
+  Cohort,
+  ListCohortsResult,
+  CohortMembership,
+  ChartData,
+  EventType,
+  EventProperty,
+  UserProperty,
+} from '../types';
+import { AmplitudeClient } from './client';
+
+/**
+ * Amplitude API wrapper
+ */
+export class Amplitude {
+  private readonly client: AmplitudeClient;
+
+  constructor(config: AmplitudeConfig) {
+    this.client = new AmplitudeClient(config);
+  }
+
+  /**
+   * Create a client from environment variables
+   */
+  static fromEnv(): Amplitude {
+    const apiKey = process.env.AMPLITUDE_API_KEY;
+    const secretKey = process.env.AMPLITUDE_SECRET_KEY;
+
+    if (!apiKey) {
+      throw new Error('AMPLITUDE_API_KEY environment variable is required');
+    }
+    if (!secretKey) {
+      throw new Error('AMPLITUDE_SECRET_KEY environment variable is required');
+    }
+    return new Amplitude({ apiKey, secretKey });
+  }
+
+  /**
+   * Get a preview of the API key (for debugging)
+   */
+  getApiKeyPreview(): string {
+    return this.client.getApiKeyPreview();
+  }
+
+  /**
+   * Get the underlying client for direct API access
+   */
+  getClient(): AmplitudeClient {
+    return this.client;
+  }
+
+  // ============================================
+  // Events API
+  // ============================================
+
+  /**
+   * Upload events (batch)
+   * Sends events to Amplitude's batch event upload endpoint
+   */
+  async uploadEvents(events: Event[]): Promise<BatchEventResponse> {
+    return this.client.post<BatchEventResponse>('/httpapi', {
+      api_key: undefined, // Will use Basic Auth instead
+      events,
+    }, undefined, true);
+  }
+
+  /**
+   * Track a single event
+   */
+  async trackEvent(event: Event): Promise<BatchEventResponse> {
+    return this.uploadEvents([event]);
+  }
+
+  // ============================================
+  // Users API
+  // ============================================
+
+  /**
+   * Search for users
+   */
+  async searchUsers(user: string): Promise<UserSearch> {
+    return this.client.get<UserSearch>('/usersearch', { user });
+  }
+
+  /**
+   * Get user activity
+   */
+  async getUserActivity(params: {
+    user?: string;
+    amplitude_id?: number;
+    offset?: number;
+    limit?: number;
+  }): Promise<UserActivity> {
+    return this.client.get<UserActivity>('/useractivity', params as Record<string, string | number | boolean | undefined>);
+  }
+
+  // ============================================
+  // Cohorts API
+  // ============================================
+
+  /**
+   * List all cohorts
+   */
+  async listCohorts(): Promise<ListCohortsResult> {
+    return this.client.get<ListCohortsResult>('/cohorts');
+  }
+
+  /**
+   * Get cohort by ID
+   */
+  async getCohort(cohortId: string): Promise<Cohort> {
+    const result = await this.client.get<{ cohort: Cohort }>(`/cohorts/${cohortId}`);
+    return result.cohort;
+  }
+
+  /**
+   * Get cohort membership
+   * Returns user IDs or amplitude IDs that are members of the cohort
+   */
+  async getCohortMembership(cohortId: string, params?: {
+    props?: number; // 1 to include user properties
+    propKeys?: string; // Comma-separated list of property keys
+  }): Promise<CohortMembership> {
+    return this.client.get<CohortMembership>(`/cohorts/${cohortId}/users`, params as Record<string, string | number | boolean | undefined>);
+  }
+
+  // ============================================
+  // Charts API
+  // ============================================
+
+  /**
+   * Get chart data
+   * Retrieves data from a saved chart
+   */
+  async getChartData(chartId: string, params?: {
+    start?: string; // YYYYMMDD format
+    end?: string;   // YYYYMMDD format
+  }): Promise<ChartData> {
+    return this.client.get<ChartData>(`/chart/${chartId}/query`, params as Record<string, string | number | boolean | undefined>);
+  }
+
+  // ============================================
+  // Taxonomy API
+  // ============================================
+
+  /**
+   * List event types
+   */
+  async listEventTypes(): Promise<{ data: EventType[] }> {
+    return this.client.get<{ data: EventType[] }>('/taxonomy/event');
+  }
+
+  /**
+   * Get event type by name
+   */
+  async getEventType(eventType: string): Promise<{ data: EventType }> {
+    return this.client.get<{ data: EventType }>(`/taxonomy/event/${encodeURIComponent(eventType)}`);
+  }
+
+  /**
+   * List event properties for an event type
+   */
+  async listEventProperties(eventType: string): Promise<{ data: EventProperty[] }> {
+    return this.client.get<{ data: EventProperty[] }>(`/taxonomy/event/${encodeURIComponent(eventType)}/properties`);
+  }
+
+  /**
+   * Get event property
+   */
+  async getEventProperty(eventType: string, propertyName: string): Promise<{ data: EventProperty }> {
+    return this.client.get<{ data: EventProperty }>(`/taxonomy/event/${encodeURIComponent(eventType)}/properties/${encodeURIComponent(propertyName)}`);
+  }
+
+  /**
+   * List user properties
+   */
+  async listUserProperties(): Promise<{ data: UserProperty[] }> {
+    return this.client.get<{ data: UserProperty[] }>('/taxonomy/user-property');
+  }
+
+  /**
+   * Get user property by name
+   */
+  async getUserProperty(propertyName: string): Promise<{ data: UserProperty }> {
+    return this.client.get<{ data: UserProperty }>(`/taxonomy/user-property/${encodeURIComponent(propertyName)}`);
+  }
+
+  // ============================================
+  // Export API
+  // ============================================
+
+  /**
+   * Export raw event data
+   * Returns a URL to download the exported data
+   * Note: This is for the Export API which uses different authentication
+   */
+  async exportData(params: {
+    start: string; // YYYYMMDDTHH format (e.g., "20240101T00")
+    end: string;   // YYYYMMDDTHH format (e.g., "20240101T23")
+  }): Promise<string> {
+    // Export API returns gzipped JSON Lines format
+    const response = await this.client.get<string>('/export', {
+      start: params.start,
+      end: params.end,
+    });
+    return response;
+  }
+}
+
+export { AmplitudeClient } from './client';