@hasna/connectors 0.3.16 → 0.4.1

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

@@ -0,0 +1,52 @@
+{
+  "name": "@hasna/connect-todoist",
+  "version": "0.1.0",
+  "description": "Todoist connector - Projects, tasks, sections, labels, and comments management",
+  "type": "module",
+  "bin": {
+    "connect-todoist": "./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",
+    "todoist",
+    "tasks",
+    "todo",
+    "productivity",
+    "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-todoist/src/api/client.ts

@@ -0,0 +1,117 @@
+import type { TodoistConfig, TodoistError } from '../types';
+import { TodoistApiError } from '../types';
+
+const DEFAULT_BASE_URL = 'https://api.todoist.com/rest/v2';
+
+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 TodoistClient {
+  private readonly apiKey: string;
+  private readonly baseUrl: string;
+
+  constructor(config: TodoistConfig) {
+    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}`);
+
+    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> = {
+      '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);
+    }
+
+    const response = await fetch(url, fetchOptions);
+
+    if (response.status === 204) {
+      return {} as T;
+    }
+
+    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();
+    }
+
+    if (!response.ok) {
+      const errorData = data as TodoistError | null;
+      const errorMessage = errorData?.error || response.statusText;
+      throw new TodoistApiError(
+        errorMessage,
+        response.status,
+        errorData?.error_code,
+        errorData?.error_tag
+      );
+    }
+
+    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 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-todoist/src/api/index.ts

@@ -0,0 +1,188 @@
+// Todoist Connector
+// Projects, tasks, sections, labels, and comments management
+
+import { TodoistClient } from './client';
+import type {
+  TodoistConfig,
+  Project,
+  Section,
+  Task,
+  Label,
+  Comment,
+  Collaborator,
+  CreateProjectInput,
+  UpdateProjectInput,
+  CreateSectionInput,
+  UpdateSectionInput,
+  CreateTaskInput,
+  UpdateTaskInput,
+  CreateLabelInput,
+  UpdateLabelInput,
+  CreateCommentInput,
+  UpdateCommentInput,
+} from '../types';
+
+export { TodoistClient } from './client';
+
+export class Todoist {
+  private client: TodoistClient;
+
+  constructor(config: TodoistConfig) {
+    this.client = new TodoistClient(config);
+  }
+
+  // ============================================
+  // Project Operations
+  // ============================================
+
+  async listProjects(): Promise<Project[]> {
+    return this.client.get<Project[]>('/projects');
+  }
+
+  async getProject(projectId: string): Promise<Project> {
+    return this.client.get<Project>(`/projects/${projectId}`);
+  }
+
+  async createProject(input: CreateProjectInput): Promise<Project> {
+    return this.client.post<Project>('/projects', input);
+  }
+
+  async updateProject(projectId: string, input: UpdateProjectInput): Promise<Project> {
+    return this.client.post<Project>(`/projects/${projectId}`, input);
+  }
+
+  async deleteProject(projectId: string): Promise<void> {
+    await this.client.delete(`/projects/${projectId}`);
+  }
+
+  async getCollaborators(projectId: string): Promise<Collaborator[]> {
+    return this.client.get<Collaborator[]>(`/projects/${projectId}/collaborators`);
+  }
+
+  // ============================================
+  // Section Operations
+  // ============================================
+
+  async listSections(projectId?: string): Promise<Section[]> {
+    return this.client.get<Section[]>('/sections', { project_id: projectId });
+  }
+
+  async getSection(sectionId: string): Promise<Section> {
+    return this.client.get<Section>(`/sections/${sectionId}`);
+  }
+
+  async createSection(input: CreateSectionInput): Promise<Section> {
+    return this.client.post<Section>('/sections', input);
+  }
+
+  async updateSection(sectionId: string, input: UpdateSectionInput): Promise<Section> {
+    return this.client.post<Section>(`/sections/${sectionId}`, input);
+  }
+
+  async deleteSection(sectionId: string): Promise<void> {
+    await this.client.delete(`/sections/${sectionId}`);
+  }
+
+  // ============================================
+  // Task Operations
+  // ============================================
+
+  async listTasks(options?: {
+    project_id?: string;
+    section_id?: string;
+    label?: string;
+    filter?: string;
+    lang?: string;
+    ids?: string[];
+  }): Promise<Task[]> {
+    const params: Record<string, string | undefined> = {
+      project_id: options?.project_id,
+      section_id: options?.section_id,
+      label: options?.label,
+      filter: options?.filter,
+      lang: options?.lang,
+      ids: options?.ids?.join(','),
+    };
+    return this.client.get<Task[]>('/tasks', params);
+  }
+
+  async getTask(taskId: string): Promise<Task> {
+    return this.client.get<Task>(`/tasks/${taskId}`);
+  }
+
+  async createTask(input: CreateTaskInput): Promise<Task> {
+    return this.client.post<Task>('/tasks', input);
+  }
+
+  async updateTask(taskId: string, input: UpdateTaskInput): Promise<Task> {
+    return this.client.post<Task>(`/tasks/${taskId}`, input);
+  }
+
+  async closeTask(taskId: string): Promise<void> {
+    await this.client.post(`/tasks/${taskId}/close`);
+  }
+
+  async reopenTask(taskId: string): Promise<void> {
+    await this.client.post(`/tasks/${taskId}/reopen`);
+  }
+
+  async deleteTask(taskId: string): Promise<void> {
+    await this.client.delete(`/tasks/${taskId}`);
+  }
+
+  // ============================================
+  // Label Operations
+  // ============================================
+
+  async listLabels(): Promise<Label[]> {
+    return this.client.get<Label[]>('/labels');
+  }
+
+  async getLabel(labelId: string): Promise<Label> {
+    return this.client.get<Label>(`/labels/${labelId}`);
+  }
+
+  async createLabel(input: CreateLabelInput): Promise<Label> {
+    return this.client.post<Label>('/labels', input);
+  }
+
+  async updateLabel(labelId: string, input: UpdateLabelInput): Promise<Label> {
+    return this.client.post<Label>(`/labels/${labelId}`, input);
+  }
+
+  async deleteLabel(labelId: string): Promise<void> {
+    await this.client.delete(`/labels/${labelId}`);
+  }
+
+  // ============================================
+  // Comment Operations
+  // ============================================
+
+  async listComments(options: { task_id?: string; project_id?: string }): Promise<Comment[]> {
+    return this.client.get<Comment[]>('/comments', options);
+  }
+
+  async getComment(commentId: string): Promise<Comment> {
+    return this.client.get<Comment>(`/comments/${commentId}`);
+  }
+
+  async createComment(input: CreateCommentInput): Promise<Comment> {
+    return this.client.post<Comment>('/comments', input);
+  }
+
+  async updateComment(commentId: string, input: UpdateCommentInput): Promise<Comment> {
+    return this.client.post<Comment>(`/comments/${commentId}`, input);
+  }
+
+  async deleteComment(commentId: string): Promise<void> {
+    await this.client.delete(`/comments/${commentId}`);
+  }
+
+  // ============================================
+  // Utility Methods
+  // ============================================
+
+  getClient(): TodoistClient {
+    return this.client;
+  }
+}