@hasna/connectors 0.4.2 → 0.5.1

package/connectors/connect-pipedrive/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-pipedrive/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@hasna/connect-pipedrive",
+  "version": "0.0.1",
+  "description": "Pipedrive connector - CRM persons, organizations, deals, and activities",
+  "type": "module",
+  "bin": {
+    "connect-pipedrive": "./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": [
+    "pipedrive",
+    "crm",
+    "sales",
+    "deals",
+    "contacts",
+    "api",
+    "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/open-connectors.git"
+  }
+}

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

@@ -0,0 +1,121 @@
+import type { PipedriveConfig } from '../types';
+import { PipedriveApiError } from '../types';
+
+const DEFAULT_BASE_URL = 'https://api.pipedrive.com/v1';
+
+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>;
+}
+
+export class PipedriveClient {
+  private readonly apiKey: string;
+  private readonly baseUrl: string;
+
+  constructor(config: PipedriveConfig) {
+    if (!config.apiKey) {
+      throw new Error('API key is required');
+    }
+    this.apiKey = config.apiKey;
+    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}`);
+
+    // Pipedrive uses api_token as query parameter
+    url.searchParams.append('api_token', this.apiKey);
+
+    if (params) {
+      Object.entries(params).forEach(([key, value]) => {
+        if (value !== undefined && value !== null && value !== '') {
+          url.searchParams.append(key, String(value));
+        }
+      });
+    }
+
+    return url.toString();
+  }
+
+  async request<T>(path: string, options: RequestOptions = {}): Promise<T> {
+    const { method = 'GET', params, body, headers = {} } = options;
+
+    const url = this.buildUrl(path, params);
+
+    const requestHeaders: Record<string, string> = {
+      '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) {
+      const errorData = data as { error?: string; error_info?: string } | undefined;
+      const errorMessage = errorData?.error || response.statusText;
+      throw new PipedriveApiError(errorMessage, response.status, errorData?.error_info);
+    }
+
+    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>): 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 delete<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'DELETE', params });
+  }
+
+  getApiKeyPreview(): string {
+    if (this.apiKey.length > 10) {
+      return `${this.apiKey.substring(0, 6)}...${this.apiKey.substring(this.apiKey.length - 4)}`;
+    }
+    return '***';
+  }
+}

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

@@ -0,0 +1,306 @@
+import { PipedriveClient } from './client';
+import type {
+  PipedriveConfig,
+  PipedriveResponse,
+  PipedriveListResponse,
+  Person,
+  CreatePersonInput,
+  Organization,
+  CreateOrganizationInput,
+  Deal,
+  CreateDealInput,
+  Lead,
+  CreateLeadInput,
+  Activity,
+  CreateActivityInput,
+  Pipeline,
+  Stage,
+  Note,
+  CreateNoteInput,
+  User,
+} from '../types';
+
+export { PipedriveClient } from './client';
+
+export class Pipedrive {
+  private client: PipedriveClient;
+
+  constructor(config: PipedriveConfig) {
+    this.client = new PipedriveClient(config);
+  }
+
+  // ============================================
+  // Persons
+  // ============================================
+
+  async listPersons(options: { start?: number; limit?: number; sort?: string } = {}): Promise<Person[]> {
+    const response = await this.client.get<PipedriveListResponse<Person>>('/persons', {
+      start: options.start,
+      limit: options.limit || 100,
+      sort: options.sort,
+    });
+    return response.data || [];
+  }
+
+  async getPerson(id: number): Promise<Person> {
+    const response = await this.client.get<PipedriveResponse<Person>>(`/persons/${id}`);
+    return response.data;
+  }
+
+  async createPerson(input: CreatePersonInput): Promise<Person> {
+    const response = await this.client.post<PipedriveResponse<Person>>('/persons', input);
+    return response.data;
+  }
+
+  async updatePerson(id: number, input: Partial<CreatePersonInput>): Promise<Person> {
+    const response = await this.client.put<PipedriveResponse<Person>>(`/persons/${id}`, input);
+    return response.data;
+  }
+
+  async deletePerson(id: number): Promise<void> {
+    await this.client.delete(`/persons/${id}`);
+  }
+
+  async searchPersons(term: string, options: { start?: number; limit?: number } = {}): Promise<Person[]> {
+    const response = await this.client.get<PipedriveListResponse<{ item: Person }>>('/persons/search', {
+      term,
+      start: options.start,
+      limit: options.limit || 100,
+    });
+    return (response.data || []).map(r => r.item);
+  }
+
+  // ============================================
+  // Organizations
+  // ============================================
+
+  async listOrganizations(options: { start?: number; limit?: number; sort?: string } = {}): Promise<Organization[]> {
+    const response = await this.client.get<PipedriveListResponse<Organization>>('/organizations', {
+      start: options.start,
+      limit: options.limit || 100,
+      sort: options.sort,
+    });
+    return response.data || [];
+  }
+
+  async getOrganization(id: number): Promise<Organization> {
+    const response = await this.client.get<PipedriveResponse<Organization>>(`/organizations/${id}`);
+    return response.data;
+  }
+
+  async createOrganization(input: CreateOrganizationInput): Promise<Organization> {
+    const response = await this.client.post<PipedriveResponse<Organization>>('/organizations', input);
+    return response.data;
+  }
+
+  async updateOrganization(id: number, input: Partial<CreateOrganizationInput>): Promise<Organization> {
+    const response = await this.client.put<PipedriveResponse<Organization>>(`/organizations/${id}`, input);
+    return response.data;
+  }
+
+  async deleteOrganization(id: number): Promise<void> {
+    await this.client.delete(`/organizations/${id}`);
+  }
+
+  async searchOrganizations(term: string, options: { start?: number; limit?: number } = {}): Promise<Organization[]> {
+    const response = await this.client.get<PipedriveListResponse<{ item: Organization }>>('/organizations/search', {
+      term,
+      start: options.start,
+      limit: options.limit || 100,
+    });
+    return (response.data || []).map(r => r.item);
+  }
+
+  // ============================================
+  // Deals
+  // ============================================
+
+  async listDeals(options: { start?: number; limit?: number; status?: string; sort?: string } = {}): Promise<Deal[]> {
+    const response = await this.client.get<PipedriveListResponse<Deal>>('/deals', {
+      start: options.start,
+      limit: options.limit || 100,
+      status: options.status,
+      sort: options.sort,
+    });
+    return response.data || [];
+  }
+
+  async getDeal(id: number): Promise<Deal> {
+    const response = await this.client.get<PipedriveResponse<Deal>>(`/deals/${id}`);
+    return response.data;
+  }
+
+  async createDeal(input: CreateDealInput): Promise<Deal> {
+    const response = await this.client.post<PipedriveResponse<Deal>>('/deals', input);
+    return response.data;
+  }
+
+  async updateDeal(id: number, input: Partial<CreateDealInput>): Promise<Deal> {
+    const response = await this.client.put<PipedriveResponse<Deal>>(`/deals/${id}`, input);
+    return response.data;
+  }
+
+  async deleteDeal(id: number): Promise<void> {
+    await this.client.delete(`/deals/${id}`);
+  }
+
+  async searchDeals(term: string, options: { start?: number; limit?: number } = {}): Promise<Deal[]> {
+    const response = await this.client.get<PipedriveListResponse<{ item: Deal }>>('/deals/search', {
+      term,
+      start: options.start,
+      limit: options.limit || 100,
+    });
+    return (response.data || []).map(r => r.item);
+  }
+
+  // ============================================
+  // Leads
+  // ============================================
+
+  async listLeads(options: { start?: number; limit?: number; archived?: boolean } = {}): Promise<Lead[]> {
+    const response = await this.client.get<PipedriveListResponse<Lead>>('/leads', {
+      start: options.start,
+      limit: options.limit || 100,
+      archived_status: options.archived ? 'archived' : 'not_archived',
+    });
+    return response.data || [];
+  }
+
+  async getLead(id: string): Promise<Lead> {
+    const response = await this.client.get<PipedriveResponse<Lead>>(`/leads/${id}`);
+    return response.data;
+  }
+
+  async createLead(input: CreateLeadInput): Promise<Lead> {
+    const response = await this.client.post<PipedriveResponse<Lead>>('/leads', input);
+    return response.data;
+  }
+
+  async updateLead(id: string, input: Partial<CreateLeadInput>): Promise<Lead> {
+    const response = await this.client.request<PipedriveResponse<Lead>>(`/leads/${id}`, {
+      method: 'PATCH',
+      body: input as Record<string, unknown>,
+    });
+    return response.data;
+  }
+
+  async deleteLead(id: string): Promise<void> {
+    await this.client.delete(`/leads/${id}`);
+  }
+
+  // ============================================
+  // Activities
+  // ============================================
+
+  async listActivities(options: { start?: number; limit?: number; done?: boolean; type?: string } = {}): Promise<Activity[]> {
+    const response = await this.client.get<PipedriveListResponse<Activity>>('/activities', {
+      start: options.start,
+      limit: options.limit || 100,
+      done: options.done !== undefined ? (options.done ? 1 : 0) : undefined,
+      type: options.type,
+    });
+    return response.data || [];
+  }
+
+  async getActivity(id: number): Promise<Activity> {
+    const response = await this.client.get<PipedriveResponse<Activity>>(`/activities/${id}`);
+    return response.data;
+  }
+
+  async createActivity(input: CreateActivityInput): Promise<Activity> {
+    const response = await this.client.post<PipedriveResponse<Activity>>('/activities', input);
+    return response.data;
+  }
+
+  async updateActivity(id: number, input: Partial<CreateActivityInput>): Promise<Activity> {
+    const response = await this.client.put<PipedriveResponse<Activity>>(`/activities/${id}`, input);
+    return response.data;
+  }
+
+  async deleteActivity(id: number): Promise<void> {
+    await this.client.delete(`/activities/${id}`);
+  }
+
+  // ============================================
+  // Pipelines
+  // ============================================
+
+  async listPipelines(): Promise<Pipeline[]> {
+    const response = await this.client.get<PipedriveListResponse<Pipeline>>('/pipelines');
+    return response.data || [];
+  }
+
+  async getPipeline(id: number): Promise<Pipeline> {
+    const response = await this.client.get<PipedriveResponse<Pipeline>>(`/pipelines/${id}`);
+    return response.data;
+  }
+
+  // ============================================
+  // Stages
+  // ============================================
+
+  async listStages(pipelineId?: number): Promise<Stage[]> {
+    const response = await this.client.get<PipedriveListResponse<Stage>>('/stages', {
+      pipeline_id: pipelineId,
+    });
+    return response.data || [];
+  }
+
+  async getStage(id: number): Promise<Stage> {
+    const response = await this.client.get<PipedriveResponse<Stage>>(`/stages/${id}`);
+    return response.data;
+  }
+
+  // ============================================
+  // Notes
+  // ============================================
+
+  async listNotes(options: { start?: number; limit?: number; deal_id?: number; person_id?: number; org_id?: number } = {}): Promise<Note[]> {
+    const response = await this.client.get<PipedriveListResponse<Note>>('/notes', {
+      start: options.start,
+      limit: options.limit || 100,
+      deal_id: options.deal_id,
+      person_id: options.person_id,
+      org_id: options.org_id,
+    });
+    return response.data || [];
+  }
+
+  async getNote(id: number): Promise<Note> {
+    const response = await this.client.get<PipedriveResponse<Note>>(`/notes/${id}`);
+    return response.data;
+  }
+
+  async createNote(input: CreateNoteInput): Promise<Note> {
+    const response = await this.client.post<PipedriveResponse<Note>>('/notes', input);
+    return response.data;
+  }
+
+  async updateNote(id: number, input: Partial<CreateNoteInput>): Promise<Note> {
+    const response = await this.client.put<PipedriveResponse<Note>>(`/notes/${id}`, input);
+    return response.data;
+  }
+
+  async deleteNote(id: number): Promise<void> {
+    await this.client.delete(`/notes/${id}`);
+  }
+
+  // ============================================
+  // Users
+  // ============================================
+
+  async listUsers(): Promise<User[]> {
+    const response = await this.client.get<PipedriveListResponse<User>>('/users');
+    return response.data || [];
+  }
+
+  async getUser(id: number): Promise<User> {
+    const response = await this.client.get<PipedriveResponse<User>>(`/users/${id}`);
+    return response.data;
+  }
+
+  async getCurrentUser(): Promise<User> {
+    const response = await this.client.get<PipedriveResponse<User>>('/users/me');
+    return response.data;
+  }
+}