@codeworksh/aikit 0.5.0 → 0.5.1-dev.20260613074656

package/oauth/openai/codex.d.mts

@@ -1,10 +1,20 @@
 //#region src/oauth/openai/codex.d.ts
 /**
- * OpenAI Codex OAuth helpers.
+ * OpenAI Codex OAuth.
  *
- * This flow is intended for Node.js CLI/server environments. The low-level
- * authorization helpers are storage-free so they can also be used from an
- * existing HTTP server callback route.
+ * Public interface, by use case:
+ *
+ * 1. Server OAuth integration (storage-free, bring your own routes):
+ *    `createOpenAICodexAuthorizationFlow`, `exchangeOpenAICodexAuthorizationCode`,
+ *    `parseOpenAICodexAuthorizationInput`, `refreshOpenAICodexToken`, `getOpenAICodexAccountId`.
+ * 2. CLI / interactive login (localhost callback server, persisted credentials):
+ *    `OpenAICodexOAuthClient`, `JsonOpenAICodexAuthStorage`, `OpenAICodexAuthStorage`.
+ * 3. Application credential access (get key, auto-refresh, request headers):
+ *    `getOpenAICodexApiKey`, `OpenAICodexOAuthClient.getCredentials/getApiKey/getHeaders`,
+ *    `openAICodexHeaders`, `OPENAI_CODEX_API_KEY_ENV`.
+ *
+ * Everything else in this module is an implementation detail and intentionally
+ * not exported.
  */
 type OpenAICodexOAuthCredentials = {
   access: string;
@@ -35,7 +45,7 @@ type OpenAICodexAuthorizationOptions = {
   redirectUri?: string;
   scope?: string;
 };
-type OpenAICodexPrompt = {
+type OpenAICodexLoginPrompt = {
   message: string;
   placeholder?: string;
   allowEmpty?: boolean;
@@ -45,7 +55,7 @@ type OpenAICodexLoginOptions = OpenAICodexAuthorizationOptions & {
     url: string;
     instructions?: string;
   }) => void;
-  onPrompt: (prompt: OpenAICodexPrompt) => Promise<string>;
+  onPrompt: (prompt: OpenAICodexLoginPrompt) => Promise<string>;
   onProgress?: (message: string) => void;
   onManualCodeInput?: () => Promise<string>;
 };
@@ -58,7 +68,6 @@ type JsonOpenAICodexAuthStorageOptions = {
   path?: string;
   providerId?: string;
 };
-declare function defaultOpenAICodexAuthFilePath(): string;
 declare function parseOpenAICodexAuthorizationInput(input: string): {
   code?: string;
   state?: string;
@@ -66,7 +75,6 @@ declare function parseOpenAICodexAuthorizationInput(input: string): {
 declare function getOpenAICodexAccountId(accessToken: string): string | null;
 declare function createOpenAICodexAuthorizationFlow(options?: OpenAICodexAuthorizationOptions): Promise<OpenAICodexAuthorizationFlow>;
 declare function exchangeOpenAICodexAuthorizationCode(code: string, verifier: string, redirectUri?: string): Promise<OpenAICodexTokenResult>;
-declare function loginOpenAICodex(options: OpenAICodexLoginOptions): Promise<OpenAICodexOAuthCredentials>;
 declare function refreshOpenAICodexToken(refreshToken: string): Promise<OpenAICodexOAuthCredentials>;
 declare function openAICodexHeaders(credentials: OpenAICodexOAuthCredentials): Record<string, string>;
 declare class JsonOpenAICodexAuthStorage implements OpenAICodexAuthStorage {
@@ -93,15 +101,16 @@ declare class OpenAICodexOAuthClient {
   getHeaders(): Promise<Record<string, string> | undefined>;
   logout(): Promise<void>;
 }
-declare const openAICodexOAuthProvider: {
-  readonly id: "openai-codex";
-  readonly name: "ChatGPT Plus/Pro (OpenAI Codex)";
-  readonly usesCallbackServer: true;
-  readonly login: (options: OpenAICodexLoginOptions) => Promise<OpenAICodexOAuthCredentials>;
-  readonly refreshToken: (credentials: OpenAICodexOAuthCredentials) => Promise<OpenAICodexOAuthCredentials>;
-  readonly getApiKey: (credentials: OpenAICodexOAuthCredentials) => string;
-  readonly getHeaders: (credentials: OpenAICodexOAuthCredentials) => Record<string, string>;
-};
+declare const OPENAI_CODEX_API_KEY_ENV = "OPENAI_CODEX_API_KEY";
+/**
+ * Resolve the OpenAI Codex API key the same way other provider API keys are
+ * resolved: prefer the OPENAI_CODEX_API_KEY environment variable, then fall
+ * back to stored OAuth credentials (refreshing them when close to expiry).
+ *
+ * The result can be passed directly as `apiKey` to the runtime options or to
+ * `createOpenAICodex`. Returns undefined when no key is available.
+ */
+declare function getOpenAICodexApiKey(options?: OpenAICodexOAuthClientOptions): Promise<string | undefined>;
 //#endregion
-export { JsonOpenAICodexAuthStorage, JsonOpenAICodexAuthStorageOptions, OpenAICodexAuthStorage, OpenAICodexAuthorizationFlow, OpenAICodexAuthorizationOptions, OpenAICodexLoginOptions, OpenAICodexOAuthClient, OpenAICodexOAuthClientOptions, OpenAICodexOAuthCredentials, OpenAICodexPrompt, OpenAICodexTokenFailure, OpenAICodexTokenResult, OpenAICodexTokenSuccess, createOpenAICodexAuthorizationFlow, defaultOpenAICodexAuthFilePath, exchangeOpenAICodexAuthorizationCode, getOpenAICodexAccountId, loginOpenAICodex, openAICodexHeaders, openAICodexOAuthProvider, parseOpenAICodexAuthorizationInput, refreshOpenAICodexToken };
+export { JsonOpenAICodexAuthStorage, JsonOpenAICodexAuthStorageOptions, OPENAI_CODEX_API_KEY_ENV, OpenAICodexAuthStorage, OpenAICodexAuthorizationFlow, OpenAICodexAuthorizationOptions, OpenAICodexLoginOptions, OpenAICodexLoginPrompt, OpenAICodexOAuthClient, OpenAICodexOAuthClientOptions, OpenAICodexOAuthCredentials, OpenAICodexTokenFailure, OpenAICodexTokenResult, OpenAICodexTokenSuccess, createOpenAICodexAuthorizationFlow, exchangeOpenAICodexAuthorizationCode, getOpenAICodexAccountId, getOpenAICodexApiKey, openAICodexHeaders, parseOpenAICodexAuthorizationInput, refreshOpenAICodexToken };
 //# sourceMappingURL=codex.d.mts.map

package/oauth/openai/codex.mjs

@@ -1,2 +1,2 @@
-import { a as exchangeOpenAICodexAuthorizationCode, c as openAICodexHeaders, d as refreshOpenAICodexToken, i as defaultOpenAICodexAuthFilePath, l as openAICodexOAuthProvider, n as OpenAICodexOAuthClient, o as getOpenAICodexAccountId, r as createOpenAICodexAuthorizationFlow, s as loginOpenAICodex, t as JsonOpenAICodexAuthStorage, u as parseOpenAICodexAuthorizationInput } from "../../codex-DfYk740t.mjs";
-export { JsonOpenAICodexAuthStorage, OpenAICodexOAuthClient, createOpenAICodexAuthorizationFlow, defaultOpenAICodexAuthFilePath, exchangeOpenAICodexAuthorizationCode, getOpenAICodexAccountId, loginOpenAICodex, openAICodexHeaders, openAICodexOAuthProvider, parseOpenAICodexAuthorizationInput, refreshOpenAICodexToken };
+import { a as exchangeOpenAICodexAuthorizationCode, c as openAICodexHeaders, i as createOpenAICodexAuthorizationFlow, l as parseOpenAICodexAuthorizationInput, n as OPENAI_CODEX_API_KEY_ENV, o as getOpenAICodexAccountId, r as OpenAICodexOAuthClient, s as getOpenAICodexApiKey, t as JsonOpenAICodexAuthStorage, u as refreshOpenAICodexToken } from "../../codex-C36oU6yH.mjs";
+export { JsonOpenAICodexAuthStorage, OPENAI_CODEX_API_KEY_ENV, OpenAICodexOAuthClient, createOpenAICodexAuthorizationFlow, exchangeOpenAICodexAuthorizationCode, getOpenAICodexAccountId, getOpenAICodexApiKey, openAICodexHeaders, parseOpenAICodexAuthorizationInput, refreshOpenAICodexToken };