@hasna/connectors 0.3.16 → 0.4.1

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

@@ -0,0 +1,52 @@
+{
+  "name": "@hasna/connect-asana",
+  "version": "0.1.0",
+  "description": "Asana connector - Projects, tasks, workspaces, and teams management",
+  "type": "module",
+  "bin": {
+    "connect-asana": "./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",
+    "asana",
+    "project-management",
+    "tasks",
+    "projects",
+    "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-asana/src/api/client.ts

@@ -0,0 +1,119 @@
+import type { AsanaConfig } from '../types';
+import { AsanaApiError } from '../types';
+
+const DEFAULT_BASE_URL = 'https://app.asana.com/api/1.0';
+
+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 AsanaClient {
+  private readonly accessToken: string;
+  private readonly baseUrl: string;
+
+  constructor(config: AsanaConfig) {
+    if (!config.accessToken) {
+      throw new Error('Access token is required');
+    }
+    this.accessToken = config.accessToken;
+    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.accessToken}`,
+      '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 { errors?: { message: string }[] } | undefined;
+      const errorMessage = errorData?.errors?.[0]?.message || response.statusText;
+      throw new AsanaApiError(errorMessage, response.status, errorData?.errors as any);
+    }
+
+    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 });
+  }
+
+  getAccessTokenPreview(): string {
+    if (this.accessToken.length > 10) {
+      return `${this.accessToken.substring(0, 6)}...${this.accessToken.substring(this.accessToken.length - 4)}`;
+    }
+    return '***';
+  }
+}

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

@@ -0,0 +1,319 @@
+import { AsanaClient } from './client';
+import type {
+  AsanaConfig,
+  AsanaResponse,
+  AsanaListResponse,
+  Workspace,
+  User,
+  Team,
+  Project,
+  CreateProjectInput,
+  Section,
+  CreateSectionInput,
+  Task,
+  CreateTaskInput,
+  Tag,
+  CreateTagInput,
+  Story,
+  CreateStoryInput,
+  Attachment,
+} from '../types';
+
+export { AsanaClient } from './client';
+
+export class Asana {
+  private client: AsanaClient;
+
+  constructor(config: AsanaConfig) {
+    this.client = new AsanaClient(config);
+  }
+
+  // ============================================
+  // Workspaces
+  // ============================================
+
+  async listWorkspaces(): Promise<Workspace[]> {
+    const response = await this.client.get<AsanaListResponse<Workspace>>('/workspaces');
+    return response.data;
+  }
+
+  async getWorkspace(gid: string): Promise<Workspace> {
+    const response = await this.client.get<AsanaResponse<Workspace>>(`/workspaces/${gid}`);
+    return response.data;
+  }
+
+  // ============================================
+  // Users
+  // ============================================
+
+  async getMe(): Promise<User> {
+    const response = await this.client.get<AsanaResponse<User>>('/users/me');
+    return response.data;
+  }
+
+  async getUser(gid: string): Promise<User> {
+    const response = await this.client.get<AsanaResponse<User>>(`/users/${gid}`);
+    return response.data;
+  }
+
+  async listUsersInWorkspace(workspaceGid: string): Promise<User[]> {
+    const response = await this.client.get<AsanaListResponse<User>>(`/workspaces/${workspaceGid}/users`);
+    return response.data;
+  }
+
+  // ============================================
+  // Teams
+  // ============================================
+
+  async listTeamsInWorkspace(workspaceGid: string): Promise<Team[]> {
+    const response = await this.client.get<AsanaListResponse<Team>>(`/organizations/${workspaceGid}/teams`);
+    return response.data;
+  }
+
+  async getTeam(gid: string): Promise<Team> {
+    const response = await this.client.get<AsanaResponse<Team>>(`/teams/${gid}`);
+    return response.data;
+  }
+
+  async listTeamsForUser(userGid: string, organizationGid: string): Promise<Team[]> {
+    const response = await this.client.get<AsanaListResponse<Team>>(`/users/${userGid}/teams`, {
+      organization: organizationGid,
+    });
+    return response.data;
+  }
+
+  // ============================================
+  // Projects
+  // ============================================
+
+  async listProjects(options: { workspace?: string; team?: string; archived?: boolean; limit?: number } = {}): Promise<Project[]> {
+    const params: Record<string, string | number | boolean | undefined> = {
+      limit: options.limit || 100,
+      archived: options.archived,
+    };
+
+    let path = '/projects';
+    if (options.workspace) {
+      path = `/workspaces/${options.workspace}/projects`;
+    } else if (options.team) {
+      path = `/teams/${options.team}/projects`;
+    }
+
+    const response = await this.client.get<AsanaListResponse<Project>>(path, params);
+    return response.data;
+  }
+
+  async getProject(gid: string): Promise<Project> {
+    const response = await this.client.get<AsanaResponse<Project>>(`/projects/${gid}`);
+    return response.data;
+  }
+
+  async createProject(input: CreateProjectInput): Promise<Project> {
+    const response = await this.client.post<AsanaResponse<Project>>('/projects', { data: input });
+    return response.data;
+  }
+
+  async updateProject(gid: string, input: Partial<CreateProjectInput>): Promise<Project> {
+    const response = await this.client.put<AsanaResponse<Project>>(`/projects/${gid}`, { data: input });
+    return response.data;
+  }
+
+  async deleteProject(gid: string): Promise<void> {
+    await this.client.delete(`/projects/${gid}`);
+  }
+
+  // ============================================
+  // Sections
+  // ============================================
+
+  async listSections(projectGid: string): Promise<Section[]> {
+    const response = await this.client.get<AsanaListResponse<Section>>(`/projects/${projectGid}/sections`);
+    return response.data;
+  }
+
+  async getSection(gid: string): Promise<Section> {
+    const response = await this.client.get<AsanaResponse<Section>>(`/sections/${gid}`);
+    return response.data;
+  }
+
+  async createSection(projectGid: string, input: CreateSectionInput): Promise<Section> {
+    const response = await this.client.post<AsanaResponse<Section>>(`/projects/${projectGid}/sections`, { data: input });
+    return response.data;
+  }
+
+  async updateSection(gid: string, name: string): Promise<Section> {
+    const response = await this.client.put<AsanaResponse<Section>>(`/sections/${gid}`, { data: { name } });
+    return response.data;
+  }
+
+  async deleteSection(gid: string): Promise<void> {
+    await this.client.delete(`/sections/${gid}`);
+  }
+
+  // ============================================
+  // Tasks
+  // ============================================
+
+  async listTasks(options: { project?: string; section?: string; assignee?: string; workspace?: string; completed_since?: string; limit?: number } = {}): Promise<Task[]> {
+    const params: Record<string, string | number | boolean | undefined> = {
+      limit: options.limit || 100,
+      completed_since: options.completed_since,
+    };
+
+    let path = '/tasks';
+    if (options.project) {
+      path = `/projects/${options.project}/tasks`;
+    } else if (options.section) {
+      path = `/sections/${options.section}/tasks`;
+    } else if (options.assignee && options.workspace) {
+      params.assignee = options.assignee;
+      params.workspace = options.workspace;
+    }
+
+    const response = await this.client.get<AsanaListResponse<Task>>(path, params);
+    return response.data;
+  }
+
+  async getTask(gid: string): Promise<Task> {
+    const response = await this.client.get<AsanaResponse<Task>>(`/tasks/${gid}`);
+    return response.data;
+  }
+
+  async createTask(input: CreateTaskInput): Promise<Task> {
+    const response = await this.client.post<AsanaResponse<Task>>('/tasks', { data: input });
+    return response.data;
+  }
+
+  async updateTask(gid: string, input: Partial<CreateTaskInput>): Promise<Task> {
+    const response = await this.client.put<AsanaResponse<Task>>(`/tasks/${gid}`, { data: input });
+    return response.data;
+  }
+
+  async deleteTask(gid: string): Promise<void> {
+    await this.client.delete(`/tasks/${gid}`);
+  }
+
+  async getSubtasks(taskGid: string): Promise<Task[]> {
+    const response = await this.client.get<AsanaListResponse<Task>>(`/tasks/${taskGid}/subtasks`);
+    return response.data;
+  }
+
+  async createSubtask(taskGid: string, input: CreateTaskInput): Promise<Task> {
+    const response = await this.client.post<AsanaResponse<Task>>(`/tasks/${taskGid}/subtasks`, { data: input });
+    return response.data;
+  }
+
+  async addTaskToProject(taskGid: string, projectGid: string, sectionGid?: string): Promise<void> {
+    await this.client.post(`/tasks/${taskGid}/addProject`, {
+      data: {
+        project: projectGid,
+        section: sectionGid,
+      },
+    });
+  }
+
+  async removeTaskFromProject(taskGid: string, projectGid: string): Promise<void> {
+    await this.client.post(`/tasks/${taskGid}/removeProject`, {
+      data: { project: projectGid },
+    });
+  }
+
+  async setTaskDependencies(taskGid: string, dependsOn: string[]): Promise<void> {
+    await this.client.post(`/tasks/${taskGid}/addDependencies`, {
+      data: { dependencies: dependsOn },
+    });
+  }
+
+  // ============================================
+  // Tags
+  // ============================================
+
+  async listTags(workspaceGid: string): Promise<Tag[]> {
+    const response = await this.client.get<AsanaListResponse<Tag>>(`/workspaces/${workspaceGid}/tags`);
+    return response.data;
+  }
+
+  async getTag(gid: string): Promise<Tag> {
+    const response = await this.client.get<AsanaResponse<Tag>>(`/tags/${gid}`);
+    return response.data;
+  }
+
+  async createTag(input: CreateTagInput): Promise<Tag> {
+    const response = await this.client.post<AsanaResponse<Tag>>('/tags', { data: input });
+    return response.data;
+  }
+
+  async addTagToTask(taskGid: string, tagGid: string): Promise<void> {
+    await this.client.post(`/tasks/${taskGid}/addTag`, { data: { tag: tagGid } });
+  }
+
+  async removeTagFromTask(taskGid: string, tagGid: string): Promise<void> {
+    await this.client.post(`/tasks/${taskGid}/removeTag`, { data: { tag: tagGid } });
+  }
+
+  // ============================================
+  // Stories (Comments)
+  // ============================================
+
+  async listStories(taskGid: string): Promise<Story[]> {
+    const response = await this.client.get<AsanaListResponse<Story>>(`/tasks/${taskGid}/stories`);
+    return response.data;
+  }
+
+  async getStory(gid: string): Promise<Story> {
+    const response = await this.client.get<AsanaResponse<Story>>(`/stories/${gid}`);
+    return response.data;
+  }
+
+  async createStory(taskGid: string, input: CreateStoryInput): Promise<Story> {
+    const response = await this.client.post<AsanaResponse<Story>>(`/tasks/${taskGid}/stories`, { data: input });
+    return response.data;
+  }
+
+  async updateStory(gid: string, text: string): Promise<Story> {
+    const response = await this.client.put<AsanaResponse<Story>>(`/stories/${gid}`, { data: { text } });
+    return response.data;
+  }
+
+  async deleteStory(gid: string): Promise<void> {
+    await this.client.delete(`/stories/${gid}`);
+  }
+
+  // ============================================
+  // Attachments
+  // ============================================
+
+  async listAttachments(taskGid: string): Promise<Attachment[]> {
+    const response = await this.client.get<AsanaListResponse<Attachment>>(`/tasks/${taskGid}/attachments`);
+    return response.data;
+  }
+
+  async getAttachment(gid: string): Promise<Attachment> {
+    const response = await this.client.get<AsanaResponse<Attachment>>(`/attachments/${gid}`);
+    return response.data;
+  }
+
+  async deleteAttachment(gid: string): Promise<void> {
+    await this.client.delete(`/attachments/${gid}`);
+  }
+
+  // ============================================
+  // Search
+  // ============================================
+
+  async searchTasks(workspaceGid: string, options: {
+    text?: string;
+    'projects.any'?: string;
+    'assignee.any'?: string;
+    completed?: boolean;
+    is_subtask?: boolean;
+    sort_by?: 'due_date' | 'created_at' | 'completed_at' | 'likes' | 'modified_at';
+    sort_ascending?: boolean;
+  } = {}): Promise<Task[]> {
+    const params: Record<string, string | number | boolean | undefined> = {
+      ...options,
+    };
+    const response = await this.client.get<AsanaListResponse<Task>>(`/workspaces/${workspaceGid}/tasks/search`, params);
+    return response.data;
+  }
+}