@hasna/connectors 0.4.0 → 0.4.2

package/connectors/connect-pinterest/CLAUDE.md

@@ -0,0 +1,115 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code when working with code in this repository.
+
+## Project Overview
+
+connect-pinterest is a TypeScript connector for the Pinterest API v5. It provides CLI and library access to manage pins, boards, sections, and user content.
+
+## 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 user me
+bun run dev board list
+bun run dev pin get <id>
+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 Bearer token auth
+│   └── index.ts      # Pinterest 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
+
+### User Account
+- Get current user info
+- Get user analytics
+
+### Boards
+- List, get, create, update, delete boards
+- List pins in a board
+
+### Board Sections
+- List, create, update, delete sections
+- List pins in a section
+
+### Pins
+- Get, create, update, delete pins
+- Save pin to board
+- Get pin analytics
+
+### Search
+- Search user pins
+- Search user boards
+
+### Following
+- List following boards
+- Follow/unfollow boards
+
+### Media
+- Register media uploads (video)
+
+## Authentication
+
+Uses OAuth 2.0 Bearer token authentication:
+```typescript
+'Authorization': `Bearer ${this.accessToken}`
+```
+
+Requires:
+- Access Token (from Pinterest OAuth flow)
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `PINTEREST_ACCESS_TOKEN` | Access token (overrides profile) |
+
+## Data Storage
+
+```
+~/.connect/connect-pinterest/
+├── current_profile   # Active profile name
+└── profiles/
+    ├── default.json  # Default profile
+    └── {name}.json   # Named profiles
+```
+
+## Dependencies
+
+- commander: CLI framework
+- chalk: Terminal styling

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

@@ -0,0 +1,52 @@
+{
+  "name": "@hasna/connect-pinterest",
+  "version": "0.0.1",
+  "description": "Pinterest connector - Manage pins, boards, and user content",
+  "type": "module",
+  "bin": {
+    "connect-pinterest": "./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": [
+    "pinterest",
+    "social",
+    "pins",
+    "boards",
+    "images",
+    "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-pinterest/src/api/client.ts

@@ -0,0 +1,125 @@
+import type { PinterestConfig, OutputFormat } from '../types';
+import { PinterestApiError } from '../types';
+
+const DEFAULT_BASE_URL = 'https://api.pinterest.com/v5';
+
+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;
+}
+
+export class PinterestClient {
+  private readonly accessToken: string;
+  private readonly baseUrl: string;
+
+  constructor(config: PinterestConfig) {
+    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 { message?: string; code?: number };
+      const errorMessage = errorData?.message ||
+        (typeof data === 'object' && data !== null ? JSON.stringify(data) : String(data || response.statusText));
+      throw new PinterestApiError(errorMessage, response.status, errorData?.code);
+    }
+
+    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 });
+  }
+
+  getAccessTokenPreview(): string {
+    if (this.accessToken.length > 10) {
+      return `${this.accessToken.substring(0, 6)}...${this.accessToken.substring(this.accessToken.length - 4)}`;
+    }
+    return '***';
+  }
+}

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

@@ -0,0 +1,203 @@
+import type {
+  PinterestConfig,
+  UserAccount,
+  Board,
+  BoardListResponse,
+  BoardCreateParams,
+  BoardUpdateParams,
+  Pin,
+  PinListResponse,
+  PinCreateParams,
+  PinUpdateParams,
+  BoardSection,
+  BoardSectionListResponse,
+  BoardSectionCreateParams,
+  MediaUpload,
+  PinAnalytics,
+  UserAnalytics,
+} from '../types';
+import { PinterestClient } from './client';
+
+export class Pinterest {
+  private readonly client: PinterestClient;
+
+  constructor(config: PinterestConfig) {
+    this.client = new PinterestClient(config);
+  }
+
+  static fromEnv(): Pinterest {
+    const accessToken = process.env.PINTEREST_ACCESS_TOKEN;
+
+    if (!accessToken) {
+      throw new Error('PINTEREST_ACCESS_TOKEN environment variable is required');
+    }
+    return new Pinterest({ accessToken });
+  }
+
+  getAccessTokenPreview(): string {
+    return this.client.getAccessTokenPreview();
+  }
+
+  getClient(): PinterestClient {
+    return this.client;
+  }
+
+  // ============================================
+  // User Account Methods
+  // ============================================
+
+  async getUserAccount(): Promise<UserAccount> {
+    return this.client.get<UserAccount>('/user_account');
+  }
+
+  async getUserAnalytics(params?: {
+    start_date: string;
+    end_date: string;
+    metric_types?: string[];
+    app_types?: string;
+    split_field?: string;
+  }): Promise<UserAnalytics> {
+    return this.client.get<UserAnalytics>('/user_account/analytics', {
+      ...params,
+      metric_types: params?.metric_types?.join(','),
+    });
+  }
+
+  // ============================================
+  // Board Methods
+  // ============================================
+
+  async listBoards(params?: { bookmark?: string; page_size?: number; privacy?: string }): Promise<BoardListResponse> {
+    return this.client.get<BoardListResponse>('/boards', params);
+  }
+
+  async getBoard(boardId: string): Promise<Board> {
+    return this.client.get<Board>(`/boards/${boardId}`);
+  }
+
+  async createBoard(params: BoardCreateParams): Promise<Board> {
+    return this.client.post<Board>('/boards', params);
+  }
+
+  async updateBoard(boardId: string, params: BoardUpdateParams): Promise<Board> {
+    return this.client.patch<Board>(`/boards/${boardId}`, params);
+  }
+
+  async deleteBoard(boardId: string): Promise<void> {
+    return this.client.delete<void>(`/boards/${boardId}`);
+  }
+
+  async listBoardPins(boardId: string, params?: { bookmark?: string; page_size?: number }): Promise<PinListResponse> {
+    return this.client.get<PinListResponse>(`/boards/${boardId}/pins`, params);
+  }
+
+  // ============================================
+  // Board Section Methods
+  // ============================================
+
+  async listBoardSections(boardId: string, params?: { bookmark?: string; page_size?: number }): Promise<BoardSectionListResponse> {
+    return this.client.get<BoardSectionListResponse>(`/boards/${boardId}/sections`, params);
+  }
+
+  async createBoardSection(boardId: string, params: BoardSectionCreateParams): Promise<BoardSection> {
+    return this.client.post<BoardSection>(`/boards/${boardId}/sections`, params);
+  }
+
+  async updateBoardSection(boardId: string, sectionId: string, params: BoardSectionCreateParams): Promise<BoardSection> {
+    return this.client.patch<BoardSection>(`/boards/${boardId}/sections/${sectionId}`, params);
+  }
+
+  async deleteBoardSection(boardId: string, sectionId: string): Promise<void> {
+    return this.client.delete<void>(`/boards/${boardId}/sections/${sectionId}`);
+  }
+
+  async listBoardSectionPins(boardId: string, sectionId: string, params?: { bookmark?: string; page_size?: number }): Promise<PinListResponse> {
+    return this.client.get<PinListResponse>(`/boards/${boardId}/sections/${sectionId}/pins`, params);
+  }
+
+  // ============================================
+  // Pin Methods
+  // ============================================
+
+  async getPin(pinId: string): Promise<Pin> {
+    return this.client.get<Pin>(`/pins/${pinId}`);
+  }
+
+  async createPin(params: PinCreateParams): Promise<Pin> {
+    return this.client.post<Pin>('/pins', params);
+  }
+
+  async updatePin(pinId: string, params: PinUpdateParams): Promise<Pin> {
+    return this.client.patch<Pin>(`/pins/${pinId}`, params);
+  }
+
+  async deletePin(pinId: string): Promise<void> {
+    return this.client.delete<void>(`/pins/${pinId}`);
+  }
+
+  async savePin(pinId: string, boardId: string, boardSectionId?: string): Promise<Pin> {
+    return this.client.post<Pin>(`/pins/${pinId}/save`, {
+      board_id: boardId,
+      board_section_id: boardSectionId,
+    });
+  }
+
+  async getPinAnalytics(pinId: string, params: {
+    start_date: string;
+    end_date: string;
+    metric_types: string[];
+    app_types?: string;
+    split_field?: string;
+  }): Promise<PinAnalytics> {
+    return this.client.get<PinAnalytics>(`/pins/${pinId}/analytics`, {
+      ...params,
+      metric_types: params.metric_types.join(','),
+    });
+  }
+
+  // ============================================
+  // Media Upload Methods
+  // ============================================
+
+  async registerMediaUpload(mediaType: 'video'): Promise<MediaUpload> {
+    return this.client.post<MediaUpload>('/media', {
+      media_type: mediaType,
+    });
+  }
+
+  // ============================================
+  // Search Methods
+  // ============================================
+
+  async searchUserPins(query: string, params?: { bookmark?: string; page_size?: number }): Promise<PinListResponse> {
+    return this.client.get<PinListResponse>('/search/pins', {
+      query,
+      ...params,
+    });
+  }
+
+  async searchUserBoards(query: string, params?: { bookmark?: string; page_size?: number }): Promise<BoardListResponse> {
+    return this.client.get<BoardListResponse>('/search/boards', {
+      query,
+      ...params,
+    });
+  }
+
+  // ============================================
+  // Following Methods
+  // ============================================
+
+  async listFollowingBoards(params?: { bookmark?: string; page_size?: number }): Promise<BoardListResponse> {
+    return this.client.get<BoardListResponse>('/user_account/following/boards', params);
+  }
+
+  async followBoard(boardId: string): Promise<void> {
+    return this.client.post<void>(`/boards/${boardId}/followers`);
+  }
+
+  async unfollowBoard(boardId: string): Promise<void> {
+    return this.client.delete<void>(`/boards/${boardId}/followers`);
+  }
+}
+
+export { PinterestClient } from './client';