@hasna/connectors 0.3.16 → 0.4.0

package/connectors/connect-trello/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
+
+Apache-2.0

package/connectors/connect-trello/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@hasna/connect-trello",
+  "version": "0.1.0",
+  "description": "Trello connector - Boards, lists, cards, and checklists management",
+  "type": "module",
+  "bin": {
+    "connect-trello": "./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": [
+    "hasna",
+    "trello",
+    "project-management",
+    "boards",
+    "cards",
+    "kanban",
+    "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/connectors.git"
+  }
+}

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

@@ -0,0 +1,128 @@
+import type { TrelloConfig } from '../types';
+import { TrelloApiError } from '../types';
+
+const DEFAULT_BASE_URL = 'https://api.trello.com/1';
+
+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 TrelloClient {
+  private readonly apiKey: string;
+  private readonly token: string;
+  private readonly baseUrl: string;
+
+  constructor(config: TrelloConfig) {
+    if (!config.apiKey) {
+      throw new Error('API key is required');
+    }
+    if (!config.token) {
+      throw new Error('Token is required');
+    }
+    this.apiKey = config.apiKey;
+    this.token = config.token;
+    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}`);
+
+    // Trello uses key and token as query parameters
+    url.searchParams.append('key', this.apiKey);
+    url.searchParams.append('token', this.token);
+
+    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 errorMessage = typeof data === 'string'
+        ? data
+        : (data as { message?: string })?.message || response.statusText;
+      throw new TrelloApiError(errorMessage, response.status);
+    }
+
+    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-trello/src/api/index.ts

@@ -0,0 +1,278 @@
+import { TrelloClient } from './client';
+import type {
+  TrelloConfig,
+  Member,
+  Board,
+  CreateBoardInput,
+  List,
+  CreateListInput,
+  Card,
+  CreateCardInput,
+  Label,
+  CreateLabelInput,
+  Checklist,
+  CheckItem,
+  CreateChecklistInput,
+  CreateCheckItemInput,
+  Action,
+  Attachment,
+  Organization,
+} from '../types';
+
+export { TrelloClient } from './client';
+
+export class Trello {
+  private client: TrelloClient;
+
+  constructor(config: TrelloConfig) {
+    this.client = new TrelloClient(config);
+  }
+
+  // ============================================
+  // Members
+  // ============================================
+
+  async getMe(): Promise<Member> {
+    return this.client.get<Member>('/members/me');
+  }
+
+  async getMember(idOrUsername: string): Promise<Member> {
+    return this.client.get<Member>(`/members/${idOrUsername}`);
+  }
+
+  async getMemberBoards(idOrUsername: string): Promise<Board[]> {
+    return this.client.get<Board[]>(`/members/${idOrUsername}/boards`);
+  }
+
+  async getMemberOrganizations(idOrUsername: string): Promise<Organization[]> {
+    return this.client.get<Organization[]>(`/members/${idOrUsername}/organizations`);
+  }
+
+  // ============================================
+  // Boards
+  // ============================================
+
+  async getBoard(id: string): Promise<Board> {
+    return this.client.get<Board>(`/boards/${id}`);
+  }
+
+  async createBoard(input: CreateBoardInput): Promise<Board> {
+    return this.client.post<Board>('/boards', undefined, input as unknown as Record<string, string>);
+  }
+
+  async updateBoard(id: string, input: Partial<CreateBoardInput>): Promise<Board> {
+    return this.client.put<Board>(`/boards/${id}`, undefined, input as unknown as Record<string, string>);
+  }
+
+  async deleteBoard(id: string): Promise<void> {
+    await this.client.delete(`/boards/${id}`);
+  }
+
+  async getBoardLists(boardId: string, filter: 'all' | 'open' | 'closed' = 'open'): Promise<List[]> {
+    return this.client.get<List[]>(`/boards/${boardId}/lists`, { filter });
+  }
+
+  async getBoardCards(boardId: string, filter: 'all' | 'open' | 'closed' | 'visible' = 'open'): Promise<Card[]> {
+    return this.client.get<Card[]>(`/boards/${boardId}/cards`, { filter });
+  }
+
+  async getBoardLabels(boardId: string): Promise<Label[]> {
+    return this.client.get<Label[]>(`/boards/${boardId}/labels`);
+  }
+
+  async getBoardMembers(boardId: string): Promise<Member[]> {
+    return this.client.get<Member[]>(`/boards/${boardId}/members`);
+  }
+
+  async addMemberToBoard(boardId: string, email: string, type: 'admin' | 'normal' | 'observer' = 'normal'): Promise<Member> {
+    return this.client.put<Member>(`/boards/${boardId}/members`, undefined, { email, type });
+  }
+
+  async removeMemberFromBoard(boardId: string, memberId: string): Promise<void> {
+    await this.client.delete(`/boards/${boardId}/members/${memberId}`);
+  }
+
+  // ============================================
+  // Lists
+  // ============================================
+
+  async getList(id: string): Promise<List> {
+    return this.client.get<List>(`/lists/${id}`);
+  }
+
+  async createList(input: CreateListInput): Promise<List> {
+    return this.client.post<List>('/lists', undefined, input as unknown as Record<string, string>);
+  }
+
+  async updateList(id: string, input: Partial<{ name: string; closed: boolean; pos: 'top' | 'bottom' | number }>): Promise<List> {
+    return this.client.put<List>(`/lists/${id}`, undefined, input as unknown as Record<string, string>);
+  }
+
+  async archiveList(id: string): Promise<List> {
+    return this.client.put<List>(`/lists/${id}/closed`, undefined, { value: 'true' });
+  }
+
+  async getListCards(listId: string): Promise<Card[]> {
+    return this.client.get<Card[]>(`/lists/${listId}/cards`);
+  }
+
+  // ============================================
+  // Cards
+  // ============================================
+
+  async getCard(id: string): Promise<Card> {
+    return this.client.get<Card>(`/cards/${id}`);
+  }
+
+  async createCard(input: CreateCardInput): Promise<Card> {
+    return this.client.post<Card>('/cards', undefined, input as unknown as Record<string, string>);
+  }
+
+  async updateCard(id: string, input: Partial<CreateCardInput & { closed: boolean; idList: string }>): Promise<Card> {
+    return this.client.put<Card>(`/cards/${id}`, undefined, input as unknown as Record<string, string>);
+  }
+
+  async deleteCard(id: string): Promise<void> {
+    await this.client.delete(`/cards/${id}`);
+  }
+
+  async archiveCard(id: string): Promise<Card> {
+    return this.client.put<Card>(`/cards/${id}`, undefined, { closed: 'true' });
+  }
+
+  async moveCard(id: string, idList: string, pos?: 'top' | 'bottom' | number): Promise<Card> {
+    return this.client.put<Card>(`/cards/${id}`, undefined, {
+      idList,
+      pos: pos?.toString(),
+    });
+  }
+
+  async addLabelToCard(cardId: string, labelId: string): Promise<void> {
+    await this.client.post(`/cards/${cardId}/idLabels`, undefined, { value: labelId });
+  }
+
+  async removeLabelFromCard(cardId: string, labelId: string): Promise<void> {
+    await this.client.delete(`/cards/${cardId}/idLabels/${labelId}`);
+  }
+
+  async addMemberToCard(cardId: string, memberId: string): Promise<void> {
+    await this.client.post(`/cards/${cardId}/idMembers`, undefined, { value: memberId });
+  }
+
+  async removeMemberFromCard(cardId: string, memberId: string): Promise<void> {
+    await this.client.delete(`/cards/${cardId}/idMembers/${memberId}`);
+  }
+
+  async getCardAttachments(cardId: string): Promise<Attachment[]> {
+    return this.client.get<Attachment[]>(`/cards/${cardId}/attachments`);
+  }
+
+  async getCardActions(cardId: string, filter?: string): Promise<Action[]> {
+    return this.client.get<Action[]>(`/cards/${cardId}/actions`, { filter });
+  }
+
+  // ============================================
+  // Labels
+  // ============================================
+
+  async getLabel(id: string): Promise<Label> {
+    return this.client.get<Label>(`/labels/${id}`);
+  }
+
+  async createLabel(input: CreateLabelInput): Promise<Label> {
+    return this.client.post<Label>('/labels', undefined, input as unknown as Record<string, string>);
+  }
+
+  async updateLabel(id: string, input: Partial<{ name: string; color: string }>): Promise<Label> {
+    return this.client.put<Label>(`/labels/${id}`, undefined, input as unknown as Record<string, string>);
+  }
+
+  async deleteLabel(id: string): Promise<void> {
+    await this.client.delete(`/labels/${id}`);
+  }
+
+  // ============================================
+  // Checklists
+  // ============================================
+
+  async getChecklist(id: string): Promise<Checklist> {
+    return this.client.get<Checklist>(`/checklists/${id}`);
+  }
+
+  async createChecklist(input: CreateChecklistInput): Promise<Checklist> {
+    return this.client.post<Checklist>('/checklists', undefined, input as unknown as Record<string, string>);
+  }
+
+  async updateChecklist(id: string, name: string): Promise<Checklist> {
+    return this.client.put<Checklist>(`/checklists/${id}`, undefined, { name });
+  }
+
+  async deleteChecklist(id: string): Promise<void> {
+    await this.client.delete(`/checklists/${id}`);
+  }
+
+  async getChecklistItems(checklistId: string): Promise<CheckItem[]> {
+    return this.client.get<CheckItem[]>(`/checklists/${checklistId}/checkItems`);
+  }
+
+  async createCheckItem(checklistId: string, input: CreateCheckItemInput): Promise<CheckItem> {
+    return this.client.post<CheckItem>(`/checklists/${checklistId}/checkItems`, undefined, input as unknown as Record<string, string>);
+  }
+
+  async updateCheckItem(cardId: string, checkItemId: string, input: Partial<{ name: string; state: 'complete' | 'incomplete'; pos: 'top' | 'bottom' | number }>): Promise<CheckItem> {
+    return this.client.put<CheckItem>(`/cards/${cardId}/checkItem/${checkItemId}`, undefined, input as unknown as Record<string, string>);
+  }
+
+  async deleteCheckItem(checklistId: string, checkItemId: string): Promise<void> {
+    await this.client.delete(`/checklists/${checklistId}/checkItems/${checkItemId}`);
+  }
+
+  // ============================================
+  // Comments
+  // ============================================
+
+  async addComment(cardId: string, text: string): Promise<Action> {
+    return this.client.post<Action>(`/cards/${cardId}/actions/comments`, undefined, { text });
+  }
+
+  async updateComment(cardId: string, actionId: string, text: string): Promise<Action> {
+    return this.client.put<Action>(`/cards/${cardId}/actions/${actionId}/comments`, undefined, { text });
+  }
+
+  async deleteComment(cardId: string, actionId: string): Promise<void> {
+    await this.client.delete(`/cards/${cardId}/actions/${actionId}/comments`);
+  }
+
+  // ============================================
+  // Organizations
+  // ============================================
+
+  async getOrganization(id: string): Promise<Organization> {
+    return this.client.get<Organization>(`/organizations/${id}`);
+  }
+
+  async getOrganizationBoards(orgId: string): Promise<Board[]> {
+    return this.client.get<Board[]>(`/organizations/${orgId}/boards`);
+  }
+
+  async getOrganizationMembers(orgId: string): Promise<Member[]> {
+    return this.client.get<Member[]>(`/organizations/${orgId}/members`);
+  }
+
+  // ============================================
+  // Search
+  // ============================================
+
+  async search(query: string, options: {
+    idBoards?: string;
+    modelTypes?: string;
+    board_fields?: string;
+    boards_limit?: number;
+    card_fields?: string;
+    cards_limit?: number;
+    cards_page?: number;
+    partial?: boolean;
+  } = {}): Promise<{ boards?: Board[]; cards?: Card[]; members?: Member[]; organizations?: Organization[] }> {
+    return this.client.get('/search', { query, ...options });
+  }
+}