@hasna/connectors 0.4.0 → 0.4.2

package/connectors/connect-linkedin/src/utils/output.ts

@@ -0,0 +1,119 @@
+import chalk from 'chalk';
+
+export type OutputFormat = 'json' | 'table' | 'pretty';
+
+export function formatOutput(data: unknown, format: OutputFormat = 'pretty'): string {
+  switch (format) {
+    case 'json':
+      return JSON.stringify(data, null, 2);
+    case 'table':
+      return formatAsTable(data);
+    case 'pretty':
+    default:
+      return formatPretty(data);
+  }
+}
+
+function formatAsTable(data: unknown): string {
+  if (!Array.isArray(data)) {
+    data = [data];
+  }
+
+  const items = data as Record<string, unknown>[];
+  if (items.length === 0) {
+    return 'No data';
+  }
+
+  const firstItem = items[0];
+  if (!firstItem || typeof firstItem !== 'object') {
+    return 'No data';
+  }
+
+  const keys = Object.keys(firstItem);
+  const colWidths = keys.map(key => {
+    const maxValue = Math.max(
+      key.length,
+      ...items.map(item => String(item[key] ?? '').length)
+    );
+    return Math.min(maxValue, 40);
+  });
+
+  const header = keys.map((key, i) => key.padEnd(colWidths[i] ?? 10)).join(' | ');
+  const separator = colWidths.map(w => '-'.repeat(w)).join('-+-');
+
+  const rows = items.map(item =>
+    keys.map((key, i) => {
+      const value = String(item[key] ?? '');
+      const width = colWidths[i] ?? 10;
+      return value.length > width
+        ? value.substring(0, width - 3) + '...'
+        : value.padEnd(width);
+    }).join(' | ')
+  );
+
+  return [header, separator, ...rows].join('\n');
+}
+
+function formatPretty(data: unknown): string {
+  if (Array.isArray(data)) {
+    return data.map((item, i) => `${chalk.cyan(`[${i + 1}]`)} ${formatPrettyItem(item)}`).join('\n\n');
+  }
+  return formatPrettyItem(data);
+}
+
+function formatPrettyItem(item: unknown, indent = 0): string {
+  if (item === null || item === undefined) {
+    return chalk.gray('null');
+  }
+
+  if (typeof item !== 'object') {
+    return String(item);
+  }
+
+  const spaces = '  '.repeat(indent);
+  const entries = Object.entries(item as Record<string, unknown>);
+
+  return entries
+    .map(([key, value]) => {
+      if (Array.isArray(value)) {
+        if (value.length === 0) {
+          return `${spaces}${chalk.blue(key)}: ${chalk.gray('[]')}`;
+        }
+        if (typeof value[0] === 'object') {
+          return `${spaces}${chalk.blue(key)}:\n${value.map(v => formatPrettyItem(v, indent + 1)).join('\n')}`;
+        }
+        return `${spaces}${chalk.blue(key)}: ${value.join(', ')}`;
+      }
+
+      if (typeof value === 'object' && value !== null) {
+        return `${spaces}${chalk.blue(key)}:\n${formatPrettyItem(value, indent + 1)}`;
+      }
+
+      return `${spaces}${chalk.blue(key)}: ${chalk.white(String(value))}`;
+    })
+    .join('\n');
+}
+
+export function success(message: string): void {
+  console.log(chalk.green('✓'), message);
+}
+
+export function error(message: string): void {
+  console.error(chalk.red('✗'), message);
+}
+
+export function warn(message: string): void {
+  console.warn(chalk.yellow('⚠'), message);
+}
+
+export function info(message: string): void {
+  console.log(chalk.blue('ℹ'), message);
+}
+
+export function heading(message: string): void {
+  console.log(chalk.bold.cyan(`\n${message}\n`));
+}
+
+export function print(data: unknown, format: OutputFormat = 'pretty'): void {
+  console.log(formatOutput(data, format));
+}

package/connectors/connect-linkedin/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["bun-types"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "bin"]
+}

package/connectors/connect-mailchimp/.env.example

@@ -0,0 +1,11 @@
+# API Credentials
+# TODO: Update variable names and instructions for your API
+# Example: PERPLEXITY_API_KEY, OPENAI_API_KEY, etc.
+
+CONNECTOR_API_KEY=your-api-key-here
+
+# Optional: API secret (if your API requires it)
+# CONNECTOR_API_SECRET=your-api-secret-here
+
+# Optional: Custom base URL (if needed)
+# CONNECTOR_BASE_URL=https://api.example.com

package/connectors/connect-mailchimp/CLAUDE.md

@@ -0,0 +1,127 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code when working with code in this repository.
+
+## Project Overview
+
+connect-mailchimp is a TypeScript connector for the Mailchimp Marketing API v3.0. It provides CLI and library access to manage audiences, members, campaigns, templates, tags, segments, and reports.
+
+## Build & Run Commands
+
+```bash
+# Install dependencies
+bun install
+
+# Run CLI in development
+bun run dev
+
+# Build for distribution
+bun run build
+
+# Type check
+bun run typecheck
+
+# Run specific commands
+bun run dev account info
+bun run dev list ls
+bun run dev member ls <listId>
+bun run dev campaign ls
+bun run dev config show
+```
+
+## Code Style
+
+- TypeScript with strict mode
+- ESM modules (type: module)
+- Use async/await for all async operations
+- Minimal dependencies: commander, chalk only
+- Type annotations required everywhere
+
+## Project Structure
+
+```
+src/
+├── api/
+│   ├── client.ts     # HTTP client with Basic auth
+│   └── index.ts      # Mailchimp API wrapper 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
+```
+
+## API Coverage
+
+### Account
+- Get account information
+- Ping/health check
+
+### Lists/Audiences
+- List, get, create, update, delete audiences
+
+### Members
+- List, get, add, update members
+- Archive/delete members
+- Manage member tags
+
+### Campaigns
+- List, get, create, update, delete campaigns
+- Send, schedule, unschedule campaigns
+- Pause, resume, replicate campaigns
+- Get/set campaign content
+
+### Templates
+- List, get, create, update, delete templates
+- Get template content
+
+### Tags
+- List tags for audience
+- Get/update member tags
+
+### Segments
+- List, get, create, update, delete segments
+
+### Reports
+- List campaign reports
+- Get detailed report
+- Click details, open details, unsubscribes
+
+## Authentication
+
+Uses Basic auth with API key (data center extracted from key):
+```typescript
+// API key format: abc123def456-us1
+// Data center is the suffix after the dash
+'Authorization': `Basic ${base64('anystring:' + apiKey)}`
+```
+
+Base URL is constructed from data center:
+```
+https://{dc}.api.mailchimp.com/3.0
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `MAILCHIMP_API_KEY` | API key (overrides profile) |
+| `MAILCHIMP_SERVER_PREFIX` | Override server prefix/data center |
+
+## Data Storage
+
+```
+~/.connect/connect-mailchimp/
+├── current_profile   # Active profile name
+└── profiles/
+    ├── default.json  # Default profile
+    └── {name}.json   # Named profiles
+```
+
+## Dependencies
+
+- commander: CLI framework
+- chalk: Terminal styling

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

@@ -0,0 +1,52 @@
+{
+  "name": "@hasna/connect-mailchimp",
+  "version": "0.0.2",
+  "description": "Mailchimp connector - Manage audiences, campaigns, templates, and email marketing",
+  "type": "module",
+  "bin": {
+    "connect-mailchimp": "./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": [
+    "mailchimp",
+    "email",
+    "marketing",
+    "newsletter",
+    "campaigns",
+    "audiences",
+    "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-mailchimp/src/api/client.ts

@@ -0,0 +1,162 @@
+import type { MailchimpConfig, OutputFormat } from '../types';
+import { MailchimpApiError } from '../types';
+
+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;
+}
+
+/**
+ * Extract data center from Mailchimp API key
+ * API keys are in format: abc123def456-us1
+ * The suffix after the dash is the data center
+ */
+function extractDataCenter(apiKey: string): string {
+  const parts = apiKey.split('-');
+  if (parts.length < 2) {
+    throw new Error('Invalid Mailchimp API key format. Expected format: key-dc (e.g., abc123-us1)');
+  }
+  return parts[parts.length - 1];
+}
+
+export class MailchimpClient {
+  private readonly apiKey: string;
+  private readonly baseUrl: string;
+
+  constructor(config: MailchimpConfig) {
+    if (!config.apiKey) {
+      throw new Error('API key is required');
+    }
+    this.apiKey = config.apiKey;
+
+    // Extract data center from API key or use provided serverPrefix
+    const serverPrefix = config.serverPrefix || extractDataCenter(config.apiKey);
+    this.baseUrl = `https://${serverPrefix}.api.mailchimp.com/3.0`;
+  }
+
+  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();
+  }
+
+  /**
+   * Make an authenticated request to Mailchimp API
+   * Uses Basic auth with "anystring" as username and API key as password
+   */
+  async request<T>(path: string, options: RequestOptions = {}): Promise<T> {
+    const { method = 'GET', params, body, headers = {} } = options;
+
+    const url = this.buildUrl(path, params);
+
+    // Mailchimp uses Basic auth with "anystring:apiKey"
+    const authString = Buffer.from(`anystring:${this.apiKey}`).toString('base64');
+
+    const requestHeaders: Record<string, string> = {
+      'Authorization': `Basic ${authString}`,
+      '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 - Mailchimp returns detailed error objects
+    if (!response.ok) {
+      const errorData = data as Record<string, unknown> | undefined;
+      const message = errorData?.detail as string || errorData?.title as string || response.statusText;
+      throw new MailchimpApiError(
+        message,
+        response.status,
+        errorData?.type as string,
+        errorData?.title as string,
+        errorData?.detail as string,
+        errorData?.errors as Array<{ field?: string; message: string }>
+      );
+    }
+
+    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 patch<T>(path: string, body?: Record<string, unknown> | object, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'PATCH', 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 });
+  }
+
+  /**
+   * 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 '***';
+  }
+
+  /**
+   * Get the base URL (useful for debugging)
+   */
+  getBaseUrl(): string {
+    return this.baseUrl;
+  }
+}