openai-codex-oauth 0.0.0

package/dist/types-Bv0Lf2Og.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @file types.ts
+ *
+ * Core type definitions for the OpenAI Codex OAuth library.
+ * These types define the contract for authentication, token management,
+ * and configuration across all modules.
+ */
+/**
+ * Type alias for the global fetch function signature.
+ * Used to allow custom fetch implementations in various environments.
+ */
+type FetchLike = typeof globalThis.fetch;
+/**
+ * OAuth credentials used to call the OpenAI Codex backend.
+ * Treat these as password-equivalent secrets.
+ */
+type OpenAIOAuthTokens = {
+    /** Bearer token sent to the Codex backend. */
+    accessToken: string;
+    /** Refresh token used to obtain a new access token before expiry. */
+    refreshToken?: string;
+    /** Access-token expiry as epoch milliseconds. */
+    expiresAt?: number;
+    /** Optional OpenID token. Used to derive `accountId` when available. */
+    idToken?: string;
+    /** ChatGPT account id required by the Codex backend. */
+    accountId?: string;
+};
+/** Async storage interface for loading and persisting OAuth credentials. */
+type TokenStore = {
+    /** Load the latest known credentials. Return `undefined` when the user is not signed in. */
+    load(): Promise<OpenAIOAuthTokens | undefined>;
+    /** Persist new credentials after sign-in or refresh. */
+    save(tokens: OpenAIOAuthTokens): Promise<void>;
+};
+/** In-progress OpenAI Codex device authorization flow. */
+type OpenAIDeviceFlow = {
+    providerId: 'openai';
+    /** URL the user should open to authorize the device flow. */
+    url: string;
+    /** User code to enter on the authorization page. */
+    code: string;
+    /** Human-readable instruction string for command-line or app UI. */
+    instructions: string;
+    /** Poll until authorization completes, exchange the grant, and return OAuth tokens. */
+    complete(): Promise<OpenAIOAuthTokens>;
+};
+/** Options for starting OpenAI's Codex device OAuth flow. */
+type OpenAIDeviceFlowOptions = {
+    /** Custom fetch implementation, useful for tests and non-standard runtimes. */
+    fetch?: FetchLike;
+    /** Clock override returning epoch milliseconds. */
+    now?: () => number;
+    /** Sleep override used between polling attempts. */
+    sleep?: (ms: number) => Promise<void>;
+    /** OAuth client id. Defaults to the Codex client id. */
+    clientId?: string;
+    /** OAuth issuer. Defaults to `https://auth.openai.com`. */
+    issuer?: string;
+    /** Optional store that receives tokens after successful authorization. */
+    tokenStore?: TokenStore;
+};
+/** Shared settings for Codex OAuth fetch, client, and AI SDK provider creation. */
+type OpenAIOAuthSettings = {
+    /** Custom fetch implementation for both token refresh and Codex requests. */
+    fetch?: FetchLike;
+    /** Secure token storage used to load and save refreshed credentials. */
+    tokenStore?: TokenStore;
+    /** Inline tokens for scripts/tests. Prefer `tokenStore` for production apps. */
+    tokens?: OpenAIOAuthTokens;
+    /** OAuth client id. Defaults to the Codex client id. */
+    clientId?: string;
+    /** OAuth issuer. Defaults to `https://auth.openai.com`. */
+    issuer?: string;
+    /** Override token endpoint for refresh. */
+    tokenUrl?: string;
+    /** Codex backend base URL. Defaults to `https://chatgpt.com/backend-api/codex`. */
+    baseURL?: string;
+    /** Browser proxy base URL for Codex requests. Defaults to `/api/proxy/openai/codex` in browsers. Pass `false` to disable. */
+    browserProxyBaseUrl?: string | false;
+    /** Additional headers sent to the Codex backend before OAuth headers are applied. */
+    headers?: Record<string, string>;
+    /** Default `instructions` value for Responses requests that omit it. */
+    instructions?: string;
+    /** Default OpenAI Responses `store` value. Defaults to `false`. */
+    store?: boolean;
+    /** Upstream `originator` header. Pass `false` to omit it. */
+    originator?: string | false;
+    /** Refresh access tokens this many milliseconds before expiry. */
+    refreshMarginMs?: number;
+    /** Clock override returning epoch milliseconds. */
+    now?: () => number;
+    /** Called after a successful token refresh. */
+    onTokens?: (tokens: OpenAIOAuthTokens) => void | Promise<void>;
+};
+/** Settings for the AI SDK provider factory. */
+type OpenAIOAuthProviderSettings = OpenAIOAuthSettings & {
+    /** Provider name exposed to AI SDK telemetry and metadata. */
+    name?: string;
+};
+/** Error class used for OAuth, token, and credential setup failures. */
+declare class OpenAIOAuthError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string, options?: ErrorOptions);
+}
+
+export { type FetchLike as F, type OpenAIDeviceFlow as O, type TokenStore as T, type OpenAIDeviceFlowOptions as a, OpenAIOAuthError as b, type OpenAIOAuthProviderSettings as c, type OpenAIOAuthSettings as d, type OpenAIOAuthTokens as e };

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "openai-codex-oauth",
+  "version": "0.0.0",
+  "description": "OpenAI Codex OAuth provider and token helpers for the Vercel AI SDK.",
+  "author": "respectmathias",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RespectMathias/openai-codex-oauth.git"
+  },
+  "bugs": {
+    "url": "https://github.com/RespectMathias/openai-codex-oauth/issues"
+  },
+  "homepage": "https://github.com/RespectMathias/openai-codex-oauth#readme",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./node": {
+      "types": "./dist/node/index.d.ts",
+      "import": "./dist/node/index.js",
+      "default": "./dist/node/index.js"
+    },
+    "./proxy": {
+      "types": "./dist/proxy.d.ts",
+      "import": "./dist/proxy.js",
+      "default": "./dist/proxy.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsup --tsconfig tsconfig.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  },
+  "peerDependencies": {
+    "@ai-sdk/openai": ">=3.0.0",
+    "@ai-sdk/provider": ">=3.0.0",
+    "ai": ">=6.0.0"
+  },
+  "devDependencies": {
+    "@ai-sdk/openai": "^3.0.64",
+    "@ai-sdk/provider": "^3.0.10",
+    "@types/node": "^20.17.24",
+    "ai": "^6.0.184",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "vitest": "^4.1.5"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
+  },
+  "keywords": [
+    "ai-sdk",
+    "openai",
+    "oauth",
+    "codex",
+    "vercel",
+    "chatgpt"
+  ]
+}