copilot-cursor-proxy 1.0.1 → 1.0.2

package/README.md

@@ -81,30 +81,32 @@ Cursor → (HTTPS tunnel) → proxy-router (:4142) → copilot-api (:4141) → G
 
 > **💡 Tip:** Visit the [Dashboard](http://localhost:4142) to see all available models and copy their IDs.
 
-### Tested Models (20/21 passing)
+### Tested Models (15/21 passing)
 
-| Cursor Model Name | Actual Model | API Route |
+| Cursor Model Name | Actual Model | Status |
 |---|---|---|
-| `cus-gpt-4o` | GPT-4o | Chat Completions |
-| `cus-gpt-4.1` | GPT-4.1 | Chat Completions |
-| `cus-gpt-5-mini` | GPT-5 Mini | Chat Completions |
-| `cus-gpt-5.1` | GPT-5.1 | Chat Completions |
-| `cus-gpt-5.2` | GPT-5.2 | Responses API ✨ |
-| `cus-gpt-5.2-codex` | GPT-5.2 Codex | Responses API ✨ |
-| `cus-gpt-5.3-codex` | GPT-5.3 Codex | Responses API ✨ |
-| `cus-gpt-5.4` | GPT-5.4 | Responses API ✨ |
-| `cus-gpt-5.4-mini` | GPT-5.4 Mini | Responses API ✨ |
-| `cus-claude-haiku-4.5` | Claude Haiku 4.5 | Chat Completions |
-| `cus-claude-sonnet-4` | Claude Sonnet 4 | Chat Completions |
-| `cus-claude-sonnet-4.5` | Claude Sonnet 4.5 | Chat Completions |
-| `cus-claude-sonnet-4.6` | Claude Sonnet 4.6 | Chat Completions |
-| `cus-claude-opus-4.5` | Claude Opus 4.5 | Chat Completions |
-| `cus-claude-opus-4.6` | Claude Opus 4.6 | Chat Completions |
-| `cus-claude-opus-4.6-1m` | Claude Opus 4.6 (1M) | Chat Completions |
-| `cus-gemini-2.5-pro` | Gemini 2.5 Pro | Chat Completions |
-| `cus-gemini-3-flash-preview` | Gemini 3 Flash | Chat Completions |
-| `cus-gemini-3.1-pro-preview` | Gemini 3.1 Pro | Chat Completions |
-| `cus-goldeneye` | Goldeneye | Responses API ✨ |
+| `cus-gpt-4o` | GPT-4o | ✅ |
+| `cus-gpt-4.1` | GPT-4.1 | ✅ |
+| `cus-gpt-5-mini` | GPT-5 Mini | ✅ |
+| `cus-gpt-5.1` | GPT-5.1 | ✅ |
+| `cus-gpt-5.2` | GPT-5.2 | ⚠️ See note |
+| `cus-gpt-5.2-codex` | GPT-5.2 Codex | ⚠️ See note |
+| `cus-gpt-5.3-codex` | GPT-5.3 Codex | ⚠️ See note |
+| `cus-gpt-5.4` | GPT-5.4 | ⚠️ See note |
+| `cus-gpt-5.4-mini` | GPT-5.4 Mini | ⚠️ See note |
+| `cus-goldeneye` | Goldeneye | ⚠️ See note |
+| `cus-claude-haiku-4.5` | Claude Haiku 4.5 | ✅ |
+| `cus-claude-sonnet-4` | Claude Sonnet 4 | ✅ |
+| `cus-claude-sonnet-4.5` | Claude Sonnet 4.5 | ✅ |
+| `cus-claude-sonnet-4.6` | Claude Sonnet 4.6 | ✅ |
+| `cus-claude-opus-4.5` | Claude Opus 4.5 | ✅ |
+| `cus-claude-opus-4.6` | Claude Opus 4.6 | ✅ |
+| `cus-claude-opus-4.6-1m` | Claude Opus 4.6 (1M) | ✅ |
+| `cus-gemini-2.5-pro` | Gemini 2.5 Pro | ✅ |
+| `cus-gemini-3-flash-preview` | Gemini 3 Flash | ✅ |
+| `cus-gemini-3.1-pro-preview` | Gemini 3.1 Pro | ✅ |
+
+> **⚠️ GPT-5.2+, GPT-5.x-codex, and goldeneye** are currently broken. These models require the `/v1/responses` API or `max_completion_tokens` instead of `max_tokens`, but `copilot-api` injects `max_tokens` into all requests. The proxy has a Responses API bridge built in, but `copilot-api` no longer exposes the `/v1/responses` endpoint. This will be resolved when `copilot-api` is updated. **All Claude, Gemini, GPT-4.x, GPT-5-mini, and GPT-5.1 models work fine.**
 
 ![Cursor Settings Configuration](./cursor-settings.png)
 
@@ -125,8 +127,8 @@ Cursor → (HTTPS tunnel) → proxy-router (:4142) → copilot-api (:4141) → G
 | `thinking` / `cache_control` blocks | Stripped |
 | `metadata` / `anthropic_version` | Stripped |
 | Images in Claude requests | `[Image Omitted]` placeholder |
-| GPT-5.x Chat Completions requests | **Bridged to Responses API** ✨ |
-| Responses API streaming SSE | **Converted to Chat Completions SSE** ✨ |
+| GPT-5.x `max_tokens` | Converted to `max_completion_tokens` |
+| GPT-5.x Responses API | **Bridge built in** (needs `copilot-api` support) |
 
 ### Supported Workflows
 
@@ -140,23 +142,35 @@ Cursor → (HTTPS tunnel) → proxy-router (:4142) → copilot-api (:4141) → G
 
 ---
 
-## 🔒 Security: API Key Protection
+## 🔒 Security
 
-If you're using a tunnel (exposing to the public internet), set an API key:
+### Dashboard Password
 
-**Config location:**
-- Linux/macOS: `~/.local/share/copilot-api/config.json`
-- Windows: `%USERPROFILE%\.local\share\copilot-api\config.json`
+The dashboard is password-protected. On first visit, set a password to prevent unauthorized access.
 
-```json
-{
-  "auth": {
-    "apiKeys": ["your-secret-key-here"]
-  }
-}
-```
+### API Key Management
+
+Manage API keys directly from the **Endpoint** tab in the dashboard:
+
+1. Toggle **"Require API Key"** to enable authentication
+2. Click **"+ Create Key"** to generate a new `cpk-xxx` key
+3. Copy the key (shown only once!) and paste it into Cursor's **API Key** field
+4. Enable/disable or delete keys as needed
+
+When enabled, all `/v1/*` requests must include `Authorization: Bearer <your-key>`.
+
+![Dashboard](./dashboard-preview.png)
+
+---
+
+## 📊 Dashboard
+
+Access the dashboard at **[http://localhost:4142](http://localhost:4142)**
 
-Then use the same key as the **API Key** in Cursor settings.
+Three tabs:
+- **Endpoint** — Proxy URL, API key management, model list
+- **Usage** — Request stats, token counts, per-model breakdown, recent requests
+- **Console Log** — Real-time proxy logs with color-coded levels
 
 ---
 
@@ -168,7 +182,7 @@ Then use the same key as the **API Key** in Cursor settings.
 | Streaming | ✅ Works |
 | Plan mode | ✅ Works |
 | Agent mode | ✅ Works |
-| GPT-5.x models | ✅ Works (via Responses API bridge) |
+| GPT-5.x models | ⚠️ Blocked by copilot-api `max_tokens` bug |
 | Extended thinking (chain-of-thought) | ❌ Stripped |
 | Prompt caching (`cache_control`) | ❌ Stripped |
 | Claude Vision | ❌ Not supported via Copilot |

package/auth-config.ts

@@ -0,0 +1,61 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+import { homedir } from 'os';
+import { join } from 'path';
+
+export interface ApiKey {
+    id: string;
+    name: string;
+    key: string;
+    active: boolean;
+    createdAt: number;
+}
+
+export interface AuthConfig {
+    requireApiKey: boolean;
+    keys: ApiKey[];
+}
+
+const CONFIG_DIR = join(homedir(), '.copilot-proxy');
+const CONFIG_PATH = join(CONFIG_DIR, 'auth.json');
+
+const DEFAULT_CONFIG: AuthConfig = { requireApiKey: false, keys: [] };
+
+export function loadAuthConfig(): AuthConfig {
+    try {
+        if (!existsSync(CONFIG_PATH)) return { ...DEFAULT_CONFIG, keys: [] };
+        const raw = readFileSync(CONFIG_PATH, 'utf-8');
+        const parsed = JSON.parse(raw);
+        return {
+            requireApiKey: !!parsed.requireApiKey,
+            keys: Array.isArray(parsed.keys) ? parsed.keys : [],
+        };
+    } catch {
+        return { ...DEFAULT_CONFIG, keys: [] };
+    }
+}
+
+export function saveAuthConfig(config: AuthConfig): void {
+    if (!existsSync(CONFIG_DIR)) mkdirSync(CONFIG_DIR, { recursive: true });
+    writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2), 'utf-8');
+}
+
+function randomHex(bytes: number): string {
+    const arr = new Uint8Array(bytes);
+    crypto.getRandomValues(arr);
+    return Array.from(arr, b => b.toString(16).padStart(2, '0')).join('');
+}
+
+export function generateApiKey(name: string): ApiKey {
+    return {
+        id: randomHex(4),            // 8-char hex
+        name,
+        key: 'cpk-' + randomHex(16), // cpk- + 32 hex chars
+        active: true,
+        createdAt: Date.now(),
+    };
+}
+
+export function validateApiKey(key: string): boolean {
+    const config = loadAuthConfig();
+    return config.keys.some(k => k.key === key && k.active);
+}