mirror of
https://github.com/hanzoai/opencode-openai-codex-auth.git
synced 2026-09-24 17:01:02 +00:00
Numman AliandHanzo Dev
7dae285752
## 🎯 Overview Complete TypeScript rewrite with comprehensive testing, modular architecture, and enhanced user experience. Adds 9 pre-configured model variants matching Codex CLI presets and a beautiful OAuth success page. ## ✨ New Features ### Configuration System - **9 Model Variants**: Pre-configured reasoning levels (Low/Medium/High) for both gpt-5-codex and gpt-5, plus Minimal variants - **Full Config Example**: `config/full-opencode.json` with all variants ready to use - **Minimal Config Example**: `config/minimal-opencode.json` for basic setup - **Config Documentation**: Comprehensive guide in `config/README.md` ### OAuth Enhancement - **Animated Success Page**: Beautiful terminal-style UI with matrix rain effect, animated checkmark, and glowing effects - **Interactive Elements**: Mouse-responsive matrix rain and parallax effects - **Professional Branding**: OpenCode logo with pulse animations ### Developer Experience - **TypeScript Rewrite**: Complete migration from .mjs to .ts with strict typing - **93 Comprehensive Tests**: Full test coverage using Vitest - **Modular Architecture**: 10 focused helper functions, each < 40 lines - **Centralized Constants**: All magic values in `lib/constants.ts` - **CI/CD Pipeline**: GitHub Actions workflow for automated testing ### Documentation - **AGENTS.md**: Complete guide for AI assistants maintaining the codebase - **Enhanced README**: Updated with new configuration options and examples - **Inline JSDoc**: Comprehensive documentation for all public functions ## 🏗️ Technical Changes ### Architecture Improvements - Extracted 10 focused helper functions from monolithic fetch() - Centralized all constants and error messages - Separated concerns: auth, browser, codex, server, etc. - Type-safe discriminated unions for result types ### Build System - TypeScript compilation with declarations and source maps - Automatic HTML asset copying in build process - Test files excluded from distribution bundle - Clean dist/ output with only production code ### Testing Infrastructure - Vitest test runner with UI mode - 93 tests across 7 test files - Mock-based testing for external dependencies - Coverage reporting capability ## 📁 New Structure ``` opencode-openai-codex-auth/ ├── index.ts # Main plugin (TypeScript) ├── lib/ │ ├── auth.ts # OAuth logic │ ├── browser.ts # Platform-specific browser opening │ ├── codex.ts # Codex instructions │ ├── server.ts # OAuth callback server │ ├── fetch-helpers.ts # 10 focused helpers │ ├── constants.ts # All magic values │ ├── types.ts # TypeScript types │ ├── oauth-success.html # Animated success page │ └── ... ├── config/ │ ├── full-opencode.json # Complete config with variants │ ├── minimal-opencode.json # Basic config │ └── README.md # Config docs ├── test/ # 93 comprehensive tests ├── AGENTS.md # AI maintenance guide └── tsconfig.json # TypeScript config ``` ## 🔄 Migration Notes ### Breaking Changes - Plugin now requires TypeScript compilation (dist/ folder) - Configuration structure enhanced (backward compatible) - OAuth success page replaces plain HTML response ### Upgrade Path 1. Use new config from `config/full-opencode.json` for best experience 2. Or continue with minimal config (uses plugin defaults) 3. Rebuild plugin: `npm run build` ## 📊 Metrics - **Lines of Code**: Modular design with functions < 70 lines - **Test Coverage**: 93 tests covering all functionality - **Type Safety**: Strict TypeScript with no `any` types - **Dependencies**: Still minimal (only @openauthjs/openauth) - **Model Variants**: 9 pre-configured options for users ## 🎨 User Experience - **Codex CLI Parity**: Match official CLI reasoning presets - **Beautiful OAuth**: Professional animated success page - **Clear Documentation**: Step-by-step guides and examples - **Flexible Config**: From minimal to comprehensive setups Co-authored-by: Hanzo Dev <[email protected]>
75 lines
2.0 KiB
TypeScript
75 lines
2.0 KiB
TypeScript
/**
|
|
* Constants used throughout the plugin
|
|
* Centralized for easy maintenance and configuration
|
|
*/
|
|
|
|
/** Plugin identifier for logging and error messages */
|
|
export const PLUGIN_NAME = "openai-codex-plugin";
|
|
|
|
/** Base URL for ChatGPT backend API */
|
|
export const CODEX_BASE_URL = "https://chatgpt.com/backend-api";
|
|
|
|
/** Dummy API key used for OpenAI SDK (actual auth via OAuth) */
|
|
export const DUMMY_API_KEY = "chatgpt-oauth";
|
|
|
|
/** Provider ID for opencode configuration */
|
|
export const PROVIDER_ID = "openai";
|
|
|
|
/** HTTP Status Codes */
|
|
export const HTTP_STATUS = {
|
|
OK: 200,
|
|
UNAUTHORIZED: 401,
|
|
} as const;
|
|
|
|
/** OpenAI-specific headers */
|
|
export const OPENAI_HEADERS = {
|
|
BETA: "OpenAI-Beta",
|
|
ACCOUNT_ID: "chatgpt-account-id",
|
|
ORIGINATOR: "originator",
|
|
SESSION_ID: "session_id",
|
|
} as const;
|
|
|
|
/** OpenAI-specific header values */
|
|
export const OPENAI_HEADER_VALUES = {
|
|
BETA_RESPONSES: "responses=experimental",
|
|
ORIGINATOR_CODEX: "codex_cli_rs",
|
|
} as const;
|
|
|
|
/** URL path segments */
|
|
export const URL_PATHS = {
|
|
RESPONSES: "/responses",
|
|
CODEX_RESPONSES: "/codex/responses",
|
|
} as const;
|
|
|
|
/** JWT claim path for ChatGPT account ID */
|
|
export const JWT_CLAIM_PATH = "https://api.openai.com/auth" as const;
|
|
|
|
/** Error messages */
|
|
export const ERROR_MESSAGES = {
|
|
NO_ACCOUNT_ID: "Failed to extract accountId from token",
|
|
TOKEN_REFRESH_FAILED: "Failed to refresh token, authentication required",
|
|
REQUEST_PARSE_ERROR: "Error parsing request",
|
|
} as const;
|
|
|
|
/** Log stages for request logging */
|
|
export const LOG_STAGES = {
|
|
BEFORE_TRANSFORM: "before-transform",
|
|
AFTER_TRANSFORM: "after-transform",
|
|
RESPONSE: "response",
|
|
ERROR_RESPONSE: "error-response",
|
|
} as const;
|
|
|
|
/** Platform-specific browser opener commands */
|
|
export const PLATFORM_OPENERS = {
|
|
darwin: "open",
|
|
win32: "start",
|
|
linux: "xdg-open",
|
|
} as const;
|
|
|
|
/** OAuth authorization labels */
|
|
export const AUTH_LABELS = {
|
|
OAUTH: "ChatGPT Plus/Pro (Codex Subscription)",
|
|
API_KEY: "Manually enter API Key",
|
|
INSTRUCTIONS: "A browser window should open. Complete login to finish.",
|
|
} as const;
|