@khanglvm/llm-router 1.0.8 → 1.1.0

package/CHANGELOG.md

@@ -5,6 +5,40 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2026-03-04
+
+### Added
+- Added full `config --operation=upsert-provider` UX support for subscription providers:
+  - `--type=subscription`
+  - `--subscription-type=chatgpt-codex`
+  - `--subscription-profile=<name>`
+- Added subscription provider coverage tests for config workflows and runtime provider-call behavior.
+- Added `.gitignore` rules for local IDE and deploy temp artifacts (`.idea/`, `.llm-router.deploy.*.wrangler.toml`).
+
+### Changed
+- Updated config summaries and AI-help guidance to include subscription provider details and setup commands.
+- Updated README setup guide with explicit ChatGPT Codex subscription onboarding flow.
+
+### Fixed
+- Fixed subscription status command import path so `llm-router subscription status` works reliably.
+- Fixed subscription provider request path to run standard request translation/mapping before OAuth-backed provider call.
+- Fixed subscription provider config validation and normalization:
+  - subscription providers no longer require `baseUrl`
+  - predefined ChatGPT Codex model list is enforced during normalization.
+
+## [1.0.9] - 2026-03-03
+
+### Added
+- Added dedicated modules for Cloudflare API preflight checks and Wrangler TOML target handling.
+- Added runtime policy and route-debug helpers so stateful routing can be safely disabled by default on Cloudflare Worker.
+- Added reusable timeout-signal utility and start-command port reclaim utilities with test coverage.
+
+### Changed
+- Refactored CLI deploy/runtime handler code into focused modules with cleaner boundaries.
+- Updated provider-call timeout handling to support both `AbortSignal.timeout` and `AbortController` fallback.
+- Documented Worker safety defaults and switched README release/security links to canonical GitHub URLs.
+- Added local start port resolution via `--port`, `LLM_ROUTER_PORT`, or generic `PORT` env variables.
+
 ## [1.0.8] - 2026-02-28
 
 ### Changed

package/README.md

@@ -24,7 +24,7 @@ Run `llm-router ai-help` first, then set up and operate llm-router for me using
 
 ## Main Workflow
 
-1. Add Providers + models into llm-router
+1. Add providers + models into llm-router (standard API-key providers or OAuth subscription providers)
 2. Optionally, group models as alias with load balancing and auto fallback support
 3. Start llm-router server, point your coding tool API and model to llm-router
 
@@ -77,10 +77,32 @@ Then follow this order.
 Flow:
 1. `Config manager`
 2. `Add/Edit provider`
-3. Enter provider name, endpoint, API key
-4. Enter model list
+3. Select provider type:
+   - `standard` -> endpoint + API key + model list
+   - `subscription` -> OAuth profile for predefined ChatGPT Codex models
+4. Enter provider details
 5. Save
 
+### 1b) Add Subscription Provider (ChatGPT Codex)
+Commandline example:
+
+```bash
+llm-router config \
+  --operation=upsert-provider \
+  --provider-id=chatgpt \
+  --name="ChatGPT Subscription" \
+  --type=subscription \
+  --subscription-type=chatgpt-codex \
+  --subscription-profile=default
+
+llm-router subscription login --profile=default
+llm-router subscription status --profile=default
+```
+
+Notes:
+- `chatgpt-codex` subscription providers use predefined model IDs managed by llm-router releases.
+- No provider API key or endpoint probing is required for this provider type.
+
 ### 2) Configure Model Fallback (Optional)
 Flow:
 1. `Config manager`
@@ -127,10 +149,18 @@ Flow:
 llm-router start
 ```
 
+Custom port (optional):
+
+```bash
+llm-router start --port=3001
+# or
+LLM_ROUTER_PORT=3001 llm-router start
+```
+
 Local endpoints:
-- Unified: `http://127.0.0.1:8787/route`
-- Anthropic-style: `http://127.0.0.1:8787/anthropic`
-- OpenAI-style: `http://127.0.0.1:8787/openai`
+- Unified: `http://127.0.0.1:<port>/route`
+- Anthropic-style: `http://127.0.0.1:<port>/anthropic`
+- OpenAI-style: `http://127.0.0.1:<port>/openai`
 
 ## Connect your coding tool
 
@@ -172,6 +202,11 @@ llm-router deploy
 
 You will be guided in TUI to select account and deploy target.
 
+Worker safety defaults:
+- `LLM_ROUTER_STATE_BACKEND=file` is ignored on Worker (auto-fallback to in-memory state).
+- Stateful timing-dependent routing features (cursor balancing, local quota counters, cooldown persistence) are auto-disabled by default to keep route flow safe across Worker isolates.
+- To opt in to best-effort stateful behavior on Worker, set `LLM_ROUTER_WORKER_ALLOW_BEST_EFFORT_STATEFUL_ROUTING=true`.
+
 ## Config File Location
 
 Local config file:
@@ -180,9 +215,9 @@ Local config file:
 
 ## Security
 
-See [`SECURITY.md`](./SECURITY.md).
+See [`SECURITY.md`](https://github.com/khanglvm/llm-router/blob/master/SECURITY.md).
 
 ## Versioning
 
 - Semver: [Semantic Versioning](https://semver.org/)
-- Release notes: [`CHANGELOG.md`](./CHANGELOG.md)
+- Release notes: [`CHANGELOG.md`](https://github.com/khanglvm/llm-router/blob/master/CHANGELOG.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@khanglvm/llm-router",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "Single gateway endpoint for multi-provider LLMs with unified OpenAI+Anthropic format and seamless fallback",
   "keywords": [
     "llm-router",

package/src/cli/cloudflare-api.js

@@ -0,0 +1,267 @@
+import { buildTimeoutSignal } from "../shared/timeout-signal.js";
+
+const CLOUDFLARE_API_BASE_URL = "https://api.cloudflare.com/client/v4";
+const CLOUDFLARE_VERIFY_TOKEN_URL = `${CLOUDFLARE_API_BASE_URL}/user/tokens/verify`;
+const CLOUDFLARE_MEMBERSHIPS_URL = `${CLOUDFLARE_API_BASE_URL}/memberships`;
+const CLOUDFLARE_ZONES_URL = `${CLOUDFLARE_API_BASE_URL}/zones`;
+const CLOUDFLARE_API_PREFLIGHT_TIMEOUT_MS = 10_000;
+
+export const CLOUDFLARE_API_TOKEN_ENV_NAME = "CLOUDFLARE_API_TOKEN";
+export const CLOUDFLARE_API_TOKEN_ALT_ENV_NAME = "CF_API_TOKEN";
+export const CLOUDFLARE_ACCOUNT_ID_ENV_NAME = "CLOUDFLARE_ACCOUNT_ID";
+const CLOUDFLARE_API_TOKEN_PRESET_NAME = "Edit Cloudflare Workers";
+const CLOUDFLARE_API_TOKEN_DASHBOARD_URL = "https://dash.cloudflare.com/profile/api-tokens";
+const CLOUDFLARE_API_TOKEN_GUIDE_URL = "https://developers.cloudflare.com/fundamentals/api/get-started/create-token/";
+
+function parseJsonSafely(value) {
+  const text = String(value || "").trim();
+  if (!text) return null;
+  try {
+    return JSON.parse(text);
+  } catch {
+    return null;
+  }
+}
+
+export function resolveCloudflareApiTokenFromEnv(env = process.env) {
+  const primary = String(env?.[CLOUDFLARE_API_TOKEN_ENV_NAME] || "").trim();
+  if (primary) {
+    return {
+      token: primary,
+      source: CLOUDFLARE_API_TOKEN_ENV_NAME
+    };
+  }
+
+  const fallback = String(env?.[CLOUDFLARE_API_TOKEN_ALT_ENV_NAME] || "").trim();
+  if (fallback) {
+    return {
+      token: fallback,
+      source: CLOUDFLARE_API_TOKEN_ALT_ENV_NAME
+    };
+  }
+
+  return {
+    token: "",
+    source: "none"
+  };
+}
+
+export function buildCloudflareApiTokenSetupGuide() {
+  return [
+    `Cloudflare deploy requires ${CLOUDFLARE_API_TOKEN_ENV_NAME}.`,
+    `Create a User Profile API token in dashboard: ${CLOUDFLARE_API_TOKEN_DASHBOARD_URL}`,
+    "Do not use Account API Tokens for this deploy flow.",
+    `Token docs: ${CLOUDFLARE_API_TOKEN_GUIDE_URL}`,
+    `Recommended preset: ${CLOUDFLARE_API_TOKEN_PRESET_NAME}.`,
+    `Then set ${CLOUDFLARE_API_TOKEN_ENV_NAME} in your shell/CI environment.`
+  ].join("\n");
+}
+
+export function validateCloudflareApiTokenInput(value) {
+  const candidate = String(value || "").trim();
+  if (!candidate) return `${CLOUDFLARE_API_TOKEN_ENV_NAME} is required for deploy.`;
+  return undefined;
+}
+
+export function buildCloudflareApiTokenTroubleshooting(preflightMessage = "") {
+  return [
+    preflightMessage,
+    "Required token capabilities for wrangler deploy:",
+    "- User details: Read",
+    "- User memberships: Read",
+    `- Account preset/template: ${CLOUDFLARE_API_TOKEN_PRESET_NAME}`,
+    `Verify token manually: curl "${CLOUDFLARE_VERIFY_TOKEN_URL}" -H "Authorization: Bearer $${CLOUDFLARE_API_TOKEN_ENV_NAME}"`,
+    buildCloudflareApiTokenSetupGuide()
+  ].filter(Boolean).join("\n");
+}
+
+function normalizeCloudflareMembershipAccount(entry) {
+  if (!entry || typeof entry !== "object") return null;
+  const accountObj = entry.account && typeof entry.account === "object" ? entry.account : {};
+  const accountId = String(
+    accountObj.id
+    || entry.account_id
+    || entry.accountId
+    || entry.id
+    || ""
+  ).trim();
+  if (!accountId) return null;
+
+  const accountName = String(
+    accountObj.name
+    || entry.account_name
+    || entry.accountName
+    || entry.name
+    || `Account ${accountId.slice(0, 8)}`
+  ).trim();
+
+  return {
+    accountId,
+    accountName: accountName || `Account ${accountId.slice(0, 8)}`
+  };
+}
+
+export function extractCloudflareMembershipAccounts(payload) {
+  const list = Array.isArray(payload?.result) ? payload.result : [];
+  const map = new Map();
+  for (const entry of list) {
+    const normalized = normalizeCloudflareMembershipAccount(entry);
+    if (!normalized) continue;
+    if (!map.has(normalized.accountId)) {
+      map.set(normalized.accountId, normalized);
+    }
+  }
+  return Array.from(map.values());
+}
+
+function cloudflareErrorFromPayload(payload, fallback) {
+  const base = String(fallback || "Unknown Cloudflare API error");
+  if (!payload || typeof payload !== "object") return base;
+
+  const errors = Array.isArray(payload.errors) ? payload.errors : [];
+  const first = errors.find((entry) => entry && typeof entry === "object");
+  if (!first) return base;
+
+  const code = Number.isFinite(first.code) ? `code ${first.code}` : "";
+  const message = String(first.message || first.error || "").trim();
+  if (code && message) return `${message} (${code})`;
+  if (message) return message;
+  if (code) return code;
+  return base;
+}
+
+export function evaluateCloudflareTokenVerifyResult(payload) {
+  const status = String(payload?.result?.status || "").toLowerCase();
+  const active = payload?.success === true && status === "active";
+  if (active) {
+    return { ok: true, message: "Token is active." };
+  }
+  return {
+    ok: false,
+    message: cloudflareErrorFromPayload(
+      payload,
+      "Token verification failed. Ensure token is valid and active."
+    )
+  };
+}
+
+export function evaluateCloudflareMembershipsResult(payload) {
+  if (payload?.success !== true || !Array.isArray(payload?.result)) {
+    return {
+      ok: false,
+      message: cloudflareErrorFromPayload(
+        payload,
+        "Could not list Cloudflare memberships for this token."
+      )
+    };
+  }
+
+  if (payload.result.length === 0) {
+    return {
+      ok: false,
+      message: "Token can authenticate but has no accessible memberships."
+    };
+  }
+
+  const accounts = extractCloudflareMembershipAccounts(payload);
+  return {
+    ok: true,
+    message: `Token has access to ${payload.result.length} membership(s).`,
+    count: payload.result.length,
+    accounts
+  };
+}
+
+async function cloudflareApiGetJson(url, token) {
+  const timeoutControl = buildTimeoutSignal(CLOUDFLARE_API_PREFLIGHT_TIMEOUT_MS);
+  try {
+    const response = await fetch(url, {
+      method: "GET",
+      headers: {
+        Authorization: `Bearer ${token}`
+      },
+      signal: timeoutControl.signal
+    });
+    const rawText = await response.text();
+    const payload = parseJsonSafely(rawText) || {};
+    return {
+      ok: response.ok,
+      status: response.status,
+      payload
+    };
+  } catch (error) {
+    return {
+      ok: false,
+      status: 0,
+      payload: null,
+      error: error instanceof Error ? error.message : String(error)
+    };
+  } finally {
+    timeoutControl.cleanup();
+  }
+}
+
+export async function preflightCloudflareApiToken(token) {
+  const verified = await cloudflareApiGetJson(CLOUDFLARE_VERIFY_TOKEN_URL, token);
+  if (verified.status === 0) {
+    return {
+      ok: false,
+      stage: "verify",
+      message: `Cloudflare token preflight failed while verifying token: ${verified.error || "network error"}`
+    };
+  }
+
+  const verifyEval = evaluateCloudflareTokenVerifyResult(verified.payload);
+  if (!verified.ok || !verifyEval.ok) {
+    return {
+      ok: false,
+      stage: "verify",
+      message: `Cloudflare token verification failed: ${verifyEval.message}`
+    };
+  }
+
+  const memberships = await cloudflareApiGetJson(CLOUDFLARE_MEMBERSHIPS_URL, token);
+  if (memberships.status === 0) {
+    return {
+      ok: false,
+      stage: "memberships",
+      message: `Cloudflare token preflight failed while checking memberships: ${memberships.error || "network error"}`
+    };
+  }
+
+  const membershipEval = evaluateCloudflareMembershipsResult(memberships.payload);
+  if (!memberships.ok || !membershipEval.ok) {
+    return {
+      ok: false,
+      stage: "memberships",
+      message: `Cloudflare memberships check failed: ${membershipEval.message}`
+    };
+  }
+
+  return {
+    ok: true,
+    stage: "ready",
+    message: membershipEval.message,
+    memberships: membershipEval.accounts || []
+  };
+}
+
+function normalizeHostname(value) {
+  return String(value || "")
+    .trim()
+    .toLowerCase()
+    .replace(/^https?:\/\//, "")
+    .replace(/\/.*$/, "")
+    .replace(/:\d+$/, "")
+    .replace(/\.$/, "");
+}
+
+export async function cloudflareListZones(token, accountId = "") {
+  const params = new URLSearchParams({ per_page: "50" });
+  if (accountId) params.set("account.id", accountId);
+  const result = await cloudflareApiGetJson(`${CLOUDFLARE_ZONES_URL}?${params.toString()}`, token);
+  if (!result.ok || !Array.isArray(result.payload?.result)) return [];
+  return result.payload.result
+    .map((zone) => ({ id: String(zone?.id || "").trim(), name: normalizeHostname(zone?.name || "") }))
+    .filter((zone) => zone.id && zone.name);
+}