opencode-aicodewith-auth 0.1.1 → 0.1.2

package/README.ai.md

@@ -165,21 +165,33 @@ Ensure the `plugin` array includes `opencode-aicodewith-auth`:
 
 ---
 
-## Step 4 — Verify installation
+## Step 4 — Verify installation and check npm registry
 
-Tell the user:
+### 4.1 Check if user is using a non-official npm registry
+
+Run this command to detect the npm registry:
+
+```bash
+npm config get registry
+```
+
+If the output is NOT `https://registry.npmjs.org/` (e.g., shows taobao, cnpm, or other mirrors), **remember to include a warning in your final message**.
+
+### 4.2 Tell the user installation is complete
+
+**If using official npm registry** (https://registry.npmjs.org/):
 
-> "Installation complete! Please restart OpenCode to load the plugin.
-> You can now use any of these models:
+> "安装完成！请重启 OpenCode 以加载插件。
+> 你现在可以使用以下模型：
 > - `gpt-5.2-codex`
 > - `gpt-5.2`
 > - `claude-sonnet-4-5-20250929`
 > - `claude-opus-4-5-20251101`
 > - `gemini-3-pro-high`
 >
-> To test, run: `opencode --model gpt-5.2-codex`"
+> 测试命令: `opencode --model gpt-5.2-codex`"
 
-Or in Chinese:
+**If using a mirror registry** (taobao, cnpm, etc.), add this warning:
 
 > "安装完成！请重启 OpenCode 以加载插件。
 > 你现在可以使用以下模型：
@@ -189,7 +201,14 @@ Or in Chinese:
 > - `claude-opus-4-5-20251101`
 > - `gemini-3-pro-high`
 >
-> 测试命令: `opencode --model gpt-5.2-codex`"
+> 测试命令: `opencode --model gpt-5.2-codex`
+>
+> ⚠️ **注意**: 检测到你使用的是非官方 npm 源。如果启动 OpenCode 时遇到插件加载失败（如 `BunInstallFailedError`），可能是镜像源尚未同步最新版本。解决方法：
+> ```bash
+> # 临时使用官方源重新安装
+> npm config set registry https://registry.npmjs.org/
+> # 重启 OpenCode 后，可以改回原来的源
+> ```"
 
 ---
 
@@ -206,6 +225,18 @@ Or in Chinese:
 
 If the user reports issues:
 
+### "BunInstallFailedError" or plugin fails to load
+This is usually caused by npm mirror sync delays. The user's npm registry may not have synced the latest version yet.
+
+Tell the user:
+> "这个问题通常是因为你的 npm 镜像源还没有同步最新版本。解决方法：
+> ```bash
+> # 临时切换到官方源
+> npm config set registry https://registry.npmjs.org/
+> # 重启 OpenCode
+> # 之后可以改回原来的源
+> ```"
+
 ### "Provider not found: aicodewith"
 - Verify `opencode.json` contains `"plugin": ["opencode-aicodewith-auth"]`
 - Ask user to restart OpenCode
@@ -228,3 +259,4 @@ If the user reports issues:
 4. **NEVER run interactive commands** — Do NOT run `opencode auth login`, it will block. Edit files directly instead.
 5. **ALWAYS verify file writes** — Re-read after writing to confirm valid JSON
 6. **ALWAYS wait for user confirmation** — Don't assume, ask when unclear
+7. **ALWAYS check npm registry and warn if using mirrors** — Run `npm config get registry` and warn user about potential sync issues if not using official registry

package/README.md

@@ -1,6 +1,12 @@
 <!--
 opencode-aicodewith-auth
 An OpenCode auth plugin for AICodewith
+
+📌 MAINTAINER NOTICE:
+Any architecture, feature, or convention changes MUST update:
+1. This file (if affecting overall structure)
+2. Relevant subdirectory's ARCHITECTURE.md
+3. Affected file headers (input/output/pos comments)
 -->
 
 <div align="center">
@@ -8,7 +14,8 @@ An OpenCode auth plugin for AICodewith
 # opencode-aicodewith-auth
 
 **OpenCode 的 AICodewith 认证插件**
-一次登录 → 多模型可用（GPT、Claude、Gemini）
+
+一次登录 → 多模型可用（GPT-5.2、Claude、Gemini）
 
 [![npm version](https://img.shields.io/npm/v/opencode-aicodewith-auth?label=npm&style=flat-square)](https://www.npmjs.com/package/opencode-aicodewith-auth)
 [![npm downloads](https://img.shields.io/npm/dt/opencode-aicodewith-auth?style=flat-square)](https://www.npmjs.com/package/opencode-aicodewith-auth)
@@ -18,59 +25,68 @@ An OpenCode auth plugin for AICodewith
 
 ---
 
-## 这是什么
+## Architecture Overview
 
-OpenCode 支持多种 AI 提供商。这个插件把 **AICodewith** 作为统一的认证层，让你可以：
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                     opencode-aicodewith-auth                     │
+├─────────────────────────────────────────────────────────────────┤
+│  index.ts          Plugin entry, auth hook, config injection    │
+│  provider.ts       Multi-provider factory (OpenAI/Claude/Gemini)│
+├─────────────────────────────────────────────────────────────────┤
+│  lib/              Core library modules                          │
+│  ├── constants.ts      Global constants & header names          │
+│  ├── types.ts          Shared TypeScript interfaces             │
+│  ├── logger.ts         Debug/request logging utilities          │
+│  ├── prompts/          Codex prompt fetching & bridging         │
+│  └── request/          Request transformation & response handling│
+├─────────────────────────────────────────────────────────────────┤
+│  scripts/          Installation automation                       │
+│  └── install-opencode-aicodewith.js   postinstall config writer │
+└─────────────────────────────────────────────────────────────────┘
+```
 
-- 只维护 **一份** 配置
-- 只认证 **一次**
-- 在 OpenCode 里自由切换多个模型
+### Data Flow
 
-如果你需要同时用 OpenAI / Anthropic / Google 的模型，这个插件能让配置变得简单可控。
+```
+User Request → OpenCode → Plugin Auth Hook → Route by Model:
+  ├── gpt-*/codex-* → Codex API (transform + headers)
+  ├── claude-*      → Anthropic API (URL rewrite)
+  └── gemini-*      → Gemini API (headers + URL build)
+```
 
 ---
 
 ## 支持的模型
 
-开箱即用，插件提供以下模型：
-
-- `gpt-5.2-codex`
-- `gpt-5.2`
-- `claude-sonnet-4-5-20250929`
-- `claude-opus-4-5-20251101`
-- `gemini-3-pro-high`
-
-> AICodewith 后续支持更多模型时，插件也会同步更新。
+| 模型 ID | 显示名称 | 适合场景 |
+|---------|---------|---------|
+| `aicodewith/gpt-5.2-codex` | GPT-5.2 Codex | 日常编程、代码生成 |
+| `aicodewith/gpt-5.2` | GPT-5.2 | 架构设计、逻辑推理 |
+| `aicodewith/claude-sonnet-4-5-20250929` | Claude Sonnet 4.5 | 代码审查、文档查询 |
+| `aicodewith/claude-opus-4-5-20251101` | Claude Opus 4.5 | 复杂任务、深度思考 |
+| `aicodewith/gemini-3-pro-high` | Gemini 3 Pro | 前端 UI、多模态任务 |
 
 ---
 
-## 安装
-
-### 第一步：获取 API Key
+## 快速开始
 
-去 **https://aicodewith.com/** 注册账号，注册后会获得 API Key 和体验额度。
-
----
+### 🔥 方案一：完整安装（推荐 - 包含 oh-my-opencode）
 
-### 第二步：让 AI 帮你装（推荐）
+```
+帮我安装配置 opencode-aicodewith-auth 和 oh-my-opencode，按照这个说明操作：https://raw.githubusercontent.com/DaneelOlivaw1/opencode-aicodewith-auth/main/INSTALL-WITH-OMO.md
+```
 
-打开你的 AI 编程助手（OpenCode / Claude Code / Cursor 等），粘贴这句话：
+### 📦 方案二：单独安装
 
 ```
 帮我安装配置 opencode-aicodewith-auth，按照这个说明操作：https://raw.githubusercontent.com/DaneelOlivaw1/opencode-aicodewith-auth/main/README.ai.md
 ```
 
-AI 会引导你完成整个安装流程。
-
----
-
 <details>
 <summary><strong>手动安装</strong></summary>
 
-#### 1. 添加插件
-
-在你的 OpenCode 配置文件中添加插件：
-
+1. 编辑 `~/.config/opencode/opencode.json`:
 ```json
 {
   "$schema": "https://opencode.ai/config.json",
@@ -78,103 +94,40 @@ AI 会引导你完成整个安装流程。
 }
 ```
 
-#### 2. 重启 OpenCode
-
-关闭并重新打开 OpenCode，让插件生效。
-
-#### 3. 运行认证
-
-在终端运行：
-
-```bash
-opencode auth login
-```
-
-按提示操作：
-
-1. 选择 **Other**
-2. 供应商名称填：`aicodewith`
-3. 输入你的 API Key（在 AICodewith 平台创建的 key）
-4. 回车完成
-
-![认证流程](assets/auth-login.png)
+2. 运行 `opencode auth login` → 选择 Other → 输入 `aicodewith` → 输入 API Key
 
 </details>
 
 ---
 
-## Provider 配置
-
-### 自动注入（默认）
-
-安装后，插件会自动在你的 OpenCode 配置中注入 `aicodewith` provider。
-
-如果你想手动管理，可以用这个模板：
-
-```json
-{
-  "provider": {
-    "aicodewith": {
-      "name": "AICodewith",
-      "api": "https://api.openai.com/v1",
-      "env": ["AICODEWITH_API_KEY"],
-      "models": {
-        "gpt-5.2-codex": {},
-        "gpt-5.2": {},
-        "claude-sonnet-4-5-20250929": {},
-        "claude-opus-4-5-20251101": {},
-        "gemini-3-pro-high": {}
-      }
-    }
-  }
-}
-```
-
----
-
 ## 使用
 
-启动时指定模型：
-
 ```bash
-opencode --model gpt-5.2-codex
+opencode --model aicodewith/gpt-5.2-codex
 ```
 
-或者在 OpenCode 界面里切换模型。
-
----
-
-## 常见问题
-
-### "Provider not found: aicodewith"
-
-* 确认 `opencode.json` 中有 `"plugin": ["opencode-aicodewith-auth"]`
-* 修改配置后记得重启 OpenCode
-
 ---
 
 ## 开发
 
-克隆并构建：
-
 ```bash
 git clone https://github.com/DaneelOlivaw1/opencode-aicodewith-auth.git
 cd opencode-aicodewith-auth
 bun install
 bun run build
-```
-
-类型检查：
-
-```bash
 bun run typecheck
 ```
 
-清理：
+---
+
+## File Index
 
-```bash
-bun run clean
-```
+| File | Role | Description |
+|------|------|-------------|
+| `index.ts` | **Entry** | Plugin main, auth hook, config auto-injection |
+| `provider.ts` | **Core** | Multi-provider language model factory |
+| `lib/` | **Library** | See [lib/ARCHITECTURE.md](lib/ARCHITECTURE.md) |
+| `scripts/` | **Tooling** | See [scripts/ARCHITECTURE.md](scripts/ARCHITECTURE.md) |
 
 ---
 

package/dist/index.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file index.ts
+ * @input  OpenCode plugin context, auth credentials
+ * @output Auth hook, config injection, fetch interceptor
+ * @pos    Plugin entry point - orchestrates auth and request routing
+ *
+ * 📌 On change: Update this header + README.md file index
+ */
 import type { Plugin, PluginInput, Hooks } from "@opencode-ai/plugin";
 import { type AicodewithProviderSettings } from "./provider";
 export declare function createAicodewith(input: AicodewithProviderSettings | PluginInput): import("./provider").AicodewithProvider | Hooks;

package/dist/index.js

@@ -1003,13 +1003,14 @@ var PROVIDER_NPM = new URL(`./provider${PROVIDER_EXT}`, import.meta.url).href;
 var DEFAULT_API = "https://api.openai.com/v1";
 var DEFAULT_ENV = ["AICODEWITH_API_KEY"];
 var DEFAULT_OUTPUT_TOKEN_MAX = 32000;
-var ALLOWED_MODEL_IDS = [
-  "gpt-5.2-codex",
-  "gpt-5.2",
-  "claude-sonnet-4-5-20250929",
-  "claude-opus-4-5-20251101",
-  "gemini-3-pro-high"
-];
+var MODEL_CONFIGS = {
+  "gpt-5.2-codex": { name: "GPT-5.2 Codex" },
+  "gpt-5.2": { name: "GPT-5.2" },
+  "claude-sonnet-4-5-20250929": { name: "Claude Sonnet 4.5" },
+  "claude-opus-4-5-20251101": { name: "Claude Opus 4.5" },
+  "gemini-3-pro-high": { name: "Gemini 3 Pro" }
+};
+var ALLOWED_MODEL_IDS = Object.keys(MODEL_CONFIGS);
 var ALLOWED_MODEL_SET = new Set(ALLOWED_MODEL_IDS);
 var homeDir = process.env.OPENCODE_TEST_HOME || os.homedir();
 var configRoot = process.env.XDG_CONFIG_HOME || path.join(homeDir, ".config");
@@ -1017,7 +1018,9 @@ var configDir = path.join(configRoot, "opencode");
 var configPath = path.join(configDir, "opencode.json");
 var ensureConfigPromise;
 var toModelMap = (ids, existing = {}) => ids.reduce((acc, id) => {
-  acc[id] = Object.prototype.hasOwnProperty.call(existing, id) ? existing[id] : {};
+  const existingConfig = Object.prototype.hasOwnProperty.call(existing, id) ? existing[id] : {};
+  const defaultConfig = MODEL_CONFIGS[id] ?? {};
+  acc[id] = { ...defaultConfig, ...typeof existingConfig === "object" ? existingConfig : {} };
   return acc;
 }, {});
 var readJson = async (filePath) => {

package/dist/lib/constants.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file constants.ts
+ * @input  -
+ * @output Global constants (URLs, header names, provider IDs)
+ * @pos    Foundation - imported by most other modules
+ *
+ * 📌 On change: Update this header + lib/ARCHITECTURE.md
+ */
 export declare const PLUGIN_NAME = "opencode-aicodewith-auth";
 export declare const PROVIDER_ID = "aicodewith";
 export declare const AUTH_METHOD_LABEL = "AICodewith API Key";

package/dist/lib/logger.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file logger.ts
+ * @input  Log stage, data objects
+ * @output File logs (~/.opencode/logs/), console debug output
+ * @pos    Utility - debug/request logging for development
+ *
+ * 📌 On change: Update this header + lib/ARCHITECTURE.md
+ */
 export declare const LOGGING_ENABLED: boolean;
 export declare const DEBUG_ENABLED: boolean;
 export declare function logRequest(stage: string, data: Record<string, unknown>): void;

package/dist/lib/prompts/codex-opencode-bridge.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file codex-opencode-bridge.ts
+ * @input  -
+ * @output CODEX_OPENCODE_BRIDGE constant (tool remapping rules)
+ * @pos    Bridge layer - maps Codex tools to OpenCode equivalents
+ *
+ * 📌 On change: Update this header + lib/prompts/ARCHITECTURE.md
+ */
 /**
  * Codex-OpenCode Bridge Prompt
  *

package/dist/lib/prompts/codex.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file codex.ts
+ * @input  Normalized model name
+ * @output Codex system prompt (fetched from GitHub, cached)
+ * @pos    Prompt provider - fetches model-specific instructions from openai/codex repo
+ *
+ * 📌 On change: Update this header + lib/prompts/ARCHITECTURE.md
+ */
 export type ModelFamily = "gpt-5.2-codex" | "codex-max" | "codex" | "gpt-5.2" | "gpt-5.1";
 export declare function getModelFamily(normalizedModel: string): ModelFamily;
 export declare function getCodexInstructions(normalizedModel?: string): Promise<string>;

package/dist/lib/prompts/opencode-codex.d.ts

@@ -1,8 +1,10 @@
 /**
- * OpenCode Codex Prompt Fetcher
+ * @file opencode-codex.ts
+ * @input  -
+ * @output OpenCode's codex.txt prompt (for filtering duplicate system prompts)
+ * @pos    Prompt fetcher - caches OpenCode's system prompt for comparison
  *
- * Fetches and caches the codex.txt system prompt from OpenCode's GitHub repository.
- * Uses ETag-based caching to efficiently track updates.
+ * 📌 On change: Update this header + lib/prompts/ARCHITECTURE.md
  */
 /**
  * Fetch OpenCode's codex.txt prompt with ETag-based caching

package/dist/lib/request/fetch-helpers.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file fetch-helpers.ts
+ * @input  Raw request, API key, RequestInit
+ * @output Transformed headers, URL extraction, response handlers
+ * @pos    Request layer entry - coordinates transformation and response handling
+ *
+ * 📌 On change: Update this header + lib/request/ARCHITECTURE.md
+ */
 import type { RequestBody } from "../types";
 export declare function extractRequestUrl(input: Request | string | URL): string;
 export declare function transformRequestForCodex(init?: RequestInit): Promise<{

package/dist/lib/request/helpers/input-utils.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file input-utils.ts
+ * @input  InputItem[], cached OpenCode prompt
+ * @output Filtered InputItem[] (OpenCode prompts removed, orphaned outputs fixed)
+ * @pos    Helper - message filtering and tool output normalization
+ *
+ * 📌 On change: Update this header + lib/request/helpers/ARCHITECTURE.md
+ */
 import type { InputItem } from "../../types";
 export declare const getContentText: (item: InputItem) => string;
 export declare function isOpenCodeSystemPrompt(item: InputItem, cachedPrompt: string | null): boolean;

package/dist/lib/request/helpers/model-map.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file model-map.ts
+ * @input  Config model ID (e.g., "gpt-5.2-codex-high")
+ * @output Normalized API model name (e.g., "gpt-5.2-codex")
+ * @pos    Helper - static model ID mapping for all supported variants
+ *
+ * 📌 On change: Update this header + lib/request/helpers/ARCHITECTURE.md
+ */
 /**
  * Model Configuration Map
  *

package/dist/lib/request/request-transformer.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file request-transformer.ts
+ * @input  RequestBody from OpenCode
+ * @output Transformed RequestBody for Codex API
+ * @pos    Core transformation - model normalization, reasoning config, input filtering
+ *
+ * 📌 On change: Update this header + lib/request/ARCHITECTURE.md
+ */
 import type { ConfigOptions, InputItem, ReasoningConfig, RequestBody } from "../types";
 export declare function normalizeModel(model: string | undefined): string;
 export declare function filterInput(input: InputItem[] | undefined): InputItem[] | undefined;

package/dist/lib/request/response-handler.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file response-handler.ts
+ * @input  SSE Response stream
+ * @output JSON Response (for non-streaming) or passthrough (for streaming)
+ * @pos    Response layer - SSE parsing and content-type handling
+ *
+ * 📌 On change: Update this header + lib/request/ARCHITECTURE.md
+ */
 /**
  * Convert SSE stream response to JSON for generateText()
  * @param response - Fetch response with SSE stream

package/dist/lib/types.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file types.ts
+ * @input  -
+ * @output TypeScript interfaces (RequestBody, InputItem, etc.)
+ * @pos    Foundation - shared type definitions across lib/
+ *
+ * 📌 On change: Update this header + lib/ARCHITECTURE.md
+ */
 export interface ConfigOptions {
     reasoningEffort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
     reasoningSummary?: "auto" | "concise" | "detailed" | "off" | "on";

package/dist/provider.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @file provider.ts
+ * @input  Provider settings (apiKey, baseURL, headers)
+ * @output Multi-provider language model factory (OpenAI/Anthropic/Google)
+ * @pos    Core provider - routes model requests to appropriate SDK
+ *
+ * 📌 On change: Update this header + README.md file index
+ */
 import type { LanguageModelV2 } from "@ai-sdk/provider";
 import type { FetchFunction } from "@ai-sdk/provider-utils";
 export type AicodewithProviderSettings = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-aicodewith-auth",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "OpenCode plugin for AICodewith authentication - Access GPT-5.2, Claude, and Gemini models through AICodewith API",
   "type": "module",
   "main": "dist/index.js",