@agentclientprotocol/codex-acp 1.1.9 → 1.1.10

package/README.md

@@ -13,8 +13,9 @@ Use [OpenAI Codex](https://github.com/openai/codex) from [Agent Client Protocol]
 - Text prompts, embedded context, images, resource links, and additional workspace directories.
 - Shell command, file change, permission request, MCP tool call, terminal output, reasoning, plan, web search, image generation, image view, token usage, and review events.
 - Subagent launches as standard ACP tool calls, with Codex thread identity and activity details in namespaced `_meta.codex.subagent` metadata.
+- Session-scoped long-running goals through the provider-neutral [goal extension](docs/goal-extension.md).
 - Client-provided MCP servers over command-based stdio config and HTTP transport.
-- Slash commands: `/status`, `/mcp`, `/skills`, `/review`, `/review-branch`, `/review-commit`, `/compact`, and `/logout`, as well as configured skills.
+- Slash commands: `/status`, `/mcp`, `/skills`, `/goal`, `/review`, `/review-branch`, `/review-commit`, `/compact`, and `/logout`, as well as configured skills.
 
 ## Installation
 

package/dist/index.js

@@ -23556,22 +23556,37 @@ function createAgentTextThoughtChunk(text, messageId, meta3) {
   return createAgentThoughtChunk({ type: "text", text }, messageId, meta3);
 }
 
-// src/AcpExtensions.ts
-var LEGACY_SET_SESSION_MODEL_METHOD = "session/set_model";
-var SESSION_STEERING_METHOD = "_session/steering";
-var GOAL_CONTROL_METHOD = "_codex/session/goal_control";
-function isExtMethodRequest(request) {
-  return request.method === "authentication/status" || request.method === "authentication/logout" || request.method === LEGACY_SET_SESSION_MODEL_METHOD || request.method === GOAL_CONTROL_METHOD || request.method === SESSION_STEERING_METHOD;
-}
+// src/GoalExtension.ts
+var GOAL_EXTENSION_VERSION = 1;
+var GOAL_CONTROL_METHOD = "_session/goal";
+var LEGACY_GOAL_CONTROL_METHOD = "_codex/session/goal_control";
+var GOAL_CONTROL_ACTIONS = ["pause", "clear"];
 
 // src/ThreadGoalSnapshot.ts
+function toGoalStatus(status) {
+  switch (status) {
+    case "active":
+    case "paused":
+    case "blocked":
+    case "complete":
+      return status;
+    case "usageLimited":
+    case "budgetLimited":
+      return "limited";
+  }
+}
+function toUnixMilliseconds(timestampSeconds) {
+  return timestampSeconds * 1e3;
+}
 function toThreadGoalSnapshot(goal) {
   return {
     objective: goal.objective.trim(),
-    status: goal.status,
+    status: toGoalStatus(goal.status),
     tokenBudget: goal.tokenBudget,
+    tokensUsed: goal.tokensUsed,
     timeUsedSeconds: goal.timeUsedSeconds,
-    createdAt: goal.createdAt,
+    createdAt: toUnixMilliseconds(goal.createdAt),
+    updatedAt: toUnixMilliseconds(goal.updatedAt),
     controlMethod: GOAL_CONTROL_METHOD
   };
 }
@@ -23809,9 +23824,7 @@ ${event.details}` : "";
       return null;
     }
     this.sessionState.currentGoal = goalSnapshot;
-    return this.createCodexSessionInfoUpdate({
-      goal: goalSnapshot
-    });
+    return this.createGoalSessionInfoUpdate(goalSnapshot);
   }
   createThreadGoalClearedEvent(_event) {
     this.sessionState.goalRevision += 1;
@@ -23819,9 +23832,13 @@ ${event.details}` : "";
       return null;
     }
     this.sessionState.currentGoal = null;
-    return this.createCodexSessionInfoUpdate({
-      goal: null
-    });
+    return this.createGoalSessionInfoUpdate(null);
+  }
+  createGoalSessionInfoUpdate(goal) {
+    return {
+      sessionUpdate: "session_info_update",
+      _meta: { goal }
+    };
   }
   createReasoningDeltaEvent(event) {
     this.seenReasoningDeltaItemIds.add(event.itemId);
@@ -25350,6 +25367,11 @@ var ChatGptAuthMethod = {
   name: "ChatGPT",
   description: "Use ChatGPT to authenticate"
 };
+var ChatGptDeviceCodeAuthMethod = {
+  id: "chat-gpt-device-code",
+  name: "ChatGPT (device code)",
+  description: "Sign in to ChatGPT by opening a verification page and entering a one-time code"
+};
 var GatewayAuthMethod = {
   id: "gateway",
   name: "Custom model gateway",
@@ -25366,6 +25388,9 @@ function getCodexAuthMethods(clientCapabilities, env = process.env) {
   if (!env["NO_BROWSER"]) {
     authMethods.push(ChatGptAuthMethod);
   }
+  if (clientSupportsUrlElicitation(clientCapabilities)) {
+    authMethods.push(ChatGptDeviceCodeAuthMethod);
+  }
   const supportsGatewayAuth = clientCapabilities?.auth?._meta?.["gateway"] === true;
   if (supportsGatewayAuth) {
     authMethods.push(GatewayAuthMethod);
@@ -25373,7 +25398,7 @@ function getCodexAuthMethods(clientCapabilities, env = process.env) {
   return authMethods;
 }
 function isCodexAuthRequest(request) {
-  return request.methodId === "api-key" || request.methodId === "chat-gpt" || request.methodId === "gateway";
+  return request.methodId === "api-key" || request.methodId === "chat-gpt" || request.methodId === "chat-gpt-device-code" || request.methodId === "gateway";
 }
 
 // node_modules/open/index.js
@@ -26136,7 +26161,7 @@ var package_default = {
   publishConfig: {
     access: "public"
   },
-  version: "1.1.9",
+  version: "1.1.10",
   description: "",
   main: "dist/index.js",
   bin: {
@@ -26197,7 +26222,7 @@ var package_default = {
   },
   dependencies: {
     "@agentclientprotocol/sdk": "^1.3.0",
-    "@openai/codex": "^0.145.0",
+    "@openai/codex": "^0.146.1",
     diff: "^9.0.0",
     open: "^11.0.0",
     "vscode-jsonrpc": "^9.0.1",
@@ -26283,43 +26308,24 @@ var CodexAcpClient = class {
   getHomePath() {
     return this.configPath;
   }
-  async authenticate(authRequest) {
+  async authenticate(authRequest, urlElicitationRequester) {
     if (!isCodexAuthRequest(authRequest)) {
       throw RequestError.invalidRequest();
     }
     this.gatewayConfig = null;
     switch (authRequest.methodId) {
-      case "api-key": {
-        const apiKey = authRequest._meta?.["api-key"]?.apiKey ?? this.readApiKeyFromEnv();
-        return await this.authenticateWithApiKey(apiKey);
-      }
-      case "chat-gpt": {
-        const accountResponse = await this.codexClient.accountRead({ refreshToken: true });
-        if (accountResponse.account?.type === "chatgpt") {
-          return true;
-        }
-        const loginCompletedPromise = this.awaitNextLoginCompleted();
-        const loginResponse = await this.codexClient.accountLogin({ type: "chatgpt" });
-        if (loginResponse.type == "chatgpt") {
-          await open_default(loginResponse.authUrl);
-        }
-        const result = await loginCompletedPromise;
-        return result.success;
-      }
+      case "api-key":
+        return await this.authenticateWithApiKey(authRequest);
+      case "chat-gpt":
+        return await this.authenticateWithChatGpt();
+      case "chat-gpt-device-code":
+        return await this.authenticateWithChatGptDeviceCode(urlElicitationRequester);
       case "gateway":
-        if (!authRequest._meta) throw RequestError.invalidRequest();
-        const gatewaySettings = authRequest._meta["gateway"];
-        if (!gatewaySettings) throw RequestError.invalidRequest();
-        this.applyGatewayConfig({
-          baseUrl: gatewaySettings.baseUrl,
-          apiType: GatewayAuthMethod._meta.gateway.protocol,
-          headers: gatewaySettings.headers,
-          providerName: gatewaySettings.providerName
-        });
-        return true;
+        return this.authenticateWithGateway(authRequest);
     }
   }
-  async authenticateWithApiKey(apiKey) {
+  async authenticateWithApiKey(authRequest) {
+    const apiKey = authRequest._meta?.["api-key"]?.apiKey ?? this.readApiKeyFromEnv();
     const loginCompletedPromise = this.awaitNextLoginCompleted();
     await this.codexClient.accountLogin({
       type: "apiKey",
@@ -26328,6 +26334,56 @@ var CodexAcpClient = class {
     const result = await loginCompletedPromise;
     return result.success;
   }
+  async authenticateWithChatGpt() {
+    const accountResponse = await this.codexClient.accountRead({ refreshToken: true });
+    if (accountResponse.account?.type === "chatgpt") {
+      return true;
+    }
+    const loginCompletedPromise = this.awaitNextLoginCompleted();
+    const loginResponse = await this.codexClient.accountLogin({ type: "chatgpt" });
+    if (loginResponse.type == "chatgpt") {
+      await open_default(loginResponse.authUrl);
+    }
+    const result = await loginCompletedPromise;
+    return result.success;
+  }
+  async authenticateWithChatGptDeviceCode(urlElicitationRequester) {
+    const accountResponse = await this.codexClient.accountRead({ refreshToken: true });
+    if (accountResponse.account?.type === "chatgpt") {
+      return true;
+    }
+    if (!urlElicitationRequester) {
+      throw RequestError.invalidRequest(void 0, "Device code authentication requires URL elicitation support");
+    }
+    const loginCompletedPromise = this.awaitNextLoginCompleted();
+    const loginResponse = await this.codexClient.accountLogin({ type: "chatgptDeviceCode" });
+    if (loginResponse.type !== "chatgptDeviceCode") {
+      return false;
+    }
+    const elicitationResponse = await urlElicitationRequester.elicitUrl({
+      url: loginResponse.verificationUrl,
+      message: `Sign in to ChatGPT and enter this code: ${loginResponse.userCode}`,
+      elicitationId: loginResponse.loginId
+    });
+    if (!CreateElicitationResponse.isAccept(elicitationResponse)) {
+      await this.codexClient.accountLoginCancel({ loginId: loginResponse.loginId });
+      return false;
+    }
+    const result = await loginCompletedPromise;
+    return result.success;
+  }
+  authenticateWithGateway(authRequest) {
+    if (!authRequest._meta) throw RequestError.invalidRequest();
+    const gatewaySettings = authRequest._meta["gateway"];
+    if (!gatewaySettings) throw RequestError.invalidRequest();
+    this.applyGatewayConfig({
+      baseUrl: gatewaySettings.baseUrl,
+      apiType: GatewayAuthMethod._meta.gateway.protocol,
+      headers: gatewaySettings.headers,
+      providerName: gatewaySettings.providerName
+    });
+    return true;
+  }
   readApiKeyFromEnv() {
     for (const envVar of [CODEX_API_KEY_ENV_VAR, OPENAI_API_KEY_ENV_VAR]) {
       const value = process.env[envVar]?.trim();
@@ -28577,6 +28633,13 @@ function numberValue(value) {
   return typeof value === "number" && Number.isFinite(value) ? value : null;
 }
 
+// src/AcpExtensions.ts
+var LEGACY_SET_SESSION_MODEL_METHOD = "session/set_model";
+var SESSION_STEERING_METHOD = "_session/steering";
+function isExtMethodRequest(request) {
+  return request.method === "authentication/status" || request.method === "authentication/logout" || request.method === LEGACY_SET_SESSION_MODEL_METHOD || request.method === GOAL_CONTROL_METHOD || request.method === LEGACY_GOAL_CONTROL_METHOD || request.method === SESSION_STEERING_METHOD;
+}
+
 // src/FastModeConfig.ts
 var FAST_MODE_CONFIG_ID = "fast-mode";
 var FAST_MODE_CATEGORY = "model_config";
@@ -28734,6 +28797,11 @@ var CodexAcpServer = class _CodexAcpServer {
       _meta: {
         steering: {
           supported: true
+        },
+        goal: {
+          version: GOAL_EXTENSION_VERSION,
+          controlMethod: GOAL_CONTROL_METHOD,
+          actions: [...GOAL_CONTROL_ACTIONS]
         }
       }
     };
@@ -28754,7 +28822,8 @@ var CodexAcpServer = class _CodexAcpServer {
         return await this.unstable_setSessionModel(this.parseLegacySetSessionModelParams(methodRequest.params));
       case SESSION_STEERING_METHOD:
         return await this.executeOrQueueSteeringRequest(this.parseSessionSteerParams(methodRequest.params));
-      case GOAL_CONTROL_METHOD: {
+      case GOAL_CONTROL_METHOD:
+      case LEGACY_GOAL_CONTROL_METHOD: {
         const sessionState = this.sessions.get(methodRequest.params.sessionId);
         if (!sessionState) {
           throw RequestError.invalidParams(void 0, `Unknown session: ${methodRequest.params.sessionId}`);
@@ -29105,9 +29174,10 @@ Check ${configPath} and project .codex directories, especially their config.toml
       ...this.createSessionConfigOptionsResponse(this.getSessionState(sessionId))
     };
   }
-  async authenticate(_params) {
+  async authenticate(_params, requestId) {
     logger.log("Authenticate request received");
-    const isAuthenticated = await this.runWithProcessCheck(() => this.codexAcpClient.authenticate(_params));
+    const elicitationRequester = this.createUrlElicitationRequester(requestId);
+    const isAuthenticated = await this.runWithProcessCheck(() => this.codexAcpClient.authenticate(_params, elicitationRequester));
     if (!isAuthenticated) {
       logger.log("Authenticate request failed");
       throw RequestError.invalidParams();
@@ -29116,6 +29186,18 @@ Check ${configPath} and project .codex directories, especially their config.toml
     logger.log("Authenticate request completed");
     return {};
   }
+  createUrlElicitationRequester(requestId) {
+    if (requestId == null || !clientSupportsUrlElicitation(this.clientCapabilities)) {
+      return void 0;
+    }
+    return {
+      elicitUrl: (request) => this.connection.request(methods.client.elicitation.create, {
+        mode: "url",
+        requestId,
+        ...request
+      })
+    };
+  }
   async logout(_params) {
     logger.log("Logout request received");
     await this.runWithProcessCheck(() => this.codexAcpClient.logout());
@@ -29542,9 +29624,7 @@ Check ${configPath} and project .codex directories, especially their config.toml
     await session.update({
       sessionUpdate: "session_info_update",
       _meta: {
-        codex: {
-          goal: snapshot
-        }
+        goal: snapshot
       }
     });
   }
@@ -30178,7 +30258,6 @@ Check ${configPath} and project .codex directories, especially their config.toml
         logger.log("Prompt handled by a command");
         await this.codexAcpClient.waitForSessionNotifications(params.sessionId);
         if (commandResult.turnCompleted?.turn.status === "interrupted") {
-          await this.notifyConversationInterrupted(params.sessionId);
           return this.cancelledPromptResponse(sessionState);
         }
         const error52 = eventHandler.getFailure();
@@ -30251,7 +30330,6 @@ Check ${configPath} and project .codex directories, especially their config.toml
       await this.codexAcpClient.waitForSessionNotifications(params.sessionId);
       if (turnCompleted.turn.status === "interrupted") {
         await eventHandler.flushPendingPlanUpdates();
-        await this.notifyConversationInterrupted(params.sessionId);
         return this.cancelledPromptResponse(sessionState);
       }
       const error51 = eventHandler.getFailure();
@@ -30318,7 +30396,6 @@ Check ${configPath} and project .codex directories, especially their config.toml
           await this.codexAcpClient.waitForSessionNotifications(params.sessionId);
           if (turnCompleted.turn.status === "interrupted") {
             await eventHandler.flushPendingPlanUpdates();
-            await this.notifyConversationInterrupted(params.sessionId);
             return this.cancelledPromptResponse(sessionState);
           }
           const implementationError = eventHandler.getFailure();
@@ -30410,15 +30487,6 @@ Check ${configPath} and project .codex directories, especially their config.toml
       _meta: this.buildQuotaMeta(sessionState)
     };
   }
-  async notifyConversationInterrupted(sessionId) {
-    if (this.sessionIsClosing(sessionId) || !this.sessions.has(sessionId)) {
-      return;
-    }
-    await this.connection.notify(methods.client.session.update, {
-      sessionId,
-      update: createAgentTextMessageChunk("*Conversation interrupted*")
-    });
-  }
   buildQuotaMeta(sessionState) {
     const lastTokenUsage = sessionState.lastTokenUsage;
     const modelName = sessionState.currentModelId.replace(/\[.*?]$/, "");
@@ -30936,6 +31004,9 @@ var CodexAppServerClient = class {
   async accountLogin(params) {
     return await this.sendRequest({ method: "account/login/start", params });
   }
+  async accountLoginCancel(params) {
+    return await this.sendRequest({ method: "account/login/cancel", params });
+  }
   async accountLogout() {
     return await this.sendRequest({ method: "account/logout", params: void 0 });
   }
@@ -31536,5 +31607,5 @@ function startAcpServer() {
         codexAcpServer = null;
       }
     });
-  }).onRequest(methods.agent.initialize, (ctx) => getAgent().initialize(ctx.params)).onRequest(methods.agent.session.new, (ctx) => getAgent().newSession(ctx.params)).onRequest(methods.agent.session.load, (ctx) => getAgent().loadSession(ctx.params)).onRequest(methods.agent.session.list, (ctx) => getAgent().listSessions(ctx.params)).onRequest(methods.agent.session.delete, (ctx) => getAgent().deleteSession(ctx.params)).onRequest(methods.agent.session.resume, (ctx) => getAgent().resumeSession(ctx.params)).onRequest(methods.agent.session.close, (ctx) => getAgent().closeSession(ctx.params)).onRequest(methods.agent.session.setMode, (ctx) => getAgent().setSessionMode(ctx.params)).onRequest(methods.agent.session.setConfigOption, (ctx) => getAgent().setSessionConfigOption(ctx.params)).onRequest(methods.agent.authenticate, (ctx) => getAgent().authenticate(ctx.params)).onRequest(methods.agent.logout, (ctx) => getAgent().logout(ctx.params)).onRequest(methods.agent.providers.list, (ctx) => getAgent().listProviders(ctx.params)).onRequest(methods.agent.providers.set, (ctx) => getAgent().setProvider(ctx.params)).onRequest(methods.agent.providers.disable, (ctx) => getAgent().disableProvider(ctx.params)).onRequest(methods.agent.session.prompt, (ctx) => getAgent().prompt(ctx.params, ctx.signal)).onNotification(methods.agent.session.cancel, (ctx) => getAgent().cancel(ctx.params)).onRequest("authentication/status", emptyExtensionParamsParser, (ctx) => getAgent().extMethod("authentication/status", ctx.params)).onRequest("authentication/logout", emptyExtensionParamsParser, (ctx) => getAgent().extMethod("authentication/logout", ctx.params)).onRequest(LEGACY_SET_SESSION_MODEL_METHOD, legacySetSessionModelParamsParser, (ctx) => getAgent().extMethod(LEGACY_SET_SESSION_MODEL_METHOD, ctx.params)).onRequest(SESSION_STEERING_METHOD, sessionSteerParamsParser, (ctx) => getAgent().extMethod(SESSION_STEERING_METHOD, ctx.params)).onRequest(GOAL_CONTROL_METHOD, goalControlParamsParser, (ctx) => getAgent().extMethod(GOAL_CONTROL_METHOD, ctx.params)).connect(acpJsonStream);
+  }).onRequest(methods.agent.initialize, (ctx) => getAgent().initialize(ctx.params)).onRequest(methods.agent.session.new, (ctx) => getAgent().newSession(ctx.params)).onRequest(methods.agent.session.load, (ctx) => getAgent().loadSession(ctx.params)).onRequest(methods.agent.session.list, (ctx) => getAgent().listSessions(ctx.params)).onRequest(methods.agent.session.delete, (ctx) => getAgent().deleteSession(ctx.params)).onRequest(methods.agent.session.resume, (ctx) => getAgent().resumeSession(ctx.params)).onRequest(methods.agent.session.close, (ctx) => getAgent().closeSession(ctx.params)).onRequest(methods.agent.session.setMode, (ctx) => getAgent().setSessionMode(ctx.params)).onRequest(methods.agent.session.setConfigOption, (ctx) => getAgent().setSessionConfigOption(ctx.params)).onRequest(methods.agent.authenticate, (ctx) => getAgent().authenticate(ctx.params, ctx.requestId)).onRequest(methods.agent.logout, (ctx) => getAgent().logout(ctx.params)).onRequest(methods.agent.providers.list, (ctx) => getAgent().listProviders(ctx.params)).onRequest(methods.agent.providers.set, (ctx) => getAgent().setProvider(ctx.params)).onRequest(methods.agent.providers.disable, (ctx) => getAgent().disableProvider(ctx.params)).onRequest(methods.agent.session.prompt, (ctx) => getAgent().prompt(ctx.params, ctx.signal)).onNotification(methods.agent.session.cancel, (ctx) => getAgent().cancel(ctx.params)).onRequest("authentication/status", emptyExtensionParamsParser, (ctx) => getAgent().extMethod("authentication/status", ctx.params)).onRequest("authentication/logout", emptyExtensionParamsParser, (ctx) => getAgent().extMethod("authentication/logout", ctx.params)).onRequest(LEGACY_SET_SESSION_MODEL_METHOD, legacySetSessionModelParamsParser, (ctx) => getAgent().extMethod(LEGACY_SET_SESSION_MODEL_METHOD, ctx.params)).onRequest(SESSION_STEERING_METHOD, sessionSteerParamsParser, (ctx) => getAgent().extMethod(SESSION_STEERING_METHOD, ctx.params)).onRequest(GOAL_CONTROL_METHOD, goalControlParamsParser, (ctx) => getAgent().extMethod(GOAL_CONTROL_METHOD, ctx.params)).connect(acpJsonStream);
 }

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.1.9",
+  "version": "1.1.10",
   "description": "",
   "main": "dist/index.js",
   "bin": {
@@ -64,7 +64,7 @@
   },
   "dependencies": {
     "@agentclientprotocol/sdk": "^1.3.0",
-    "@openai/codex": "^0.145.0",
+    "@openai/codex": "^0.146.1",
     "diff": "^9.0.0",
     "open": "^11.0.0",
     "vscode-jsonrpc": "^9.0.1",