@ironbee-ai/cli 0.14.1 → 0.16.0

package/dist/clients/codex/util.d.ts

@@ -0,0 +1,193 @@
+/**
+ * Codex CLI client utilities — stdin parsing, tool classification, TOML
+ * surgical editing, AGENTS.md block merge, auth detection.
+ *
+ * The TOML helpers are intentionally minimal: line-based surgical edits to
+ * known sections (`[features]`, `[mcp_servers.<name>]`). We don't need a
+ * full TOML parser/serializer because the only blocks we write/read have
+ * fixed shapes. User content outside our managed sections is preserved
+ * verbatim.
+ */
+export interface CodexHookStdin {
+    session_id?: string;
+    transcript_path?: string;
+    cwd?: string;
+    hook_event_name?: string;
+    model?: string;
+    turn_id?: string;
+    permission_mode?: string;
+    tool_name?: string;
+    /**
+     * Codex's `tool_input` shape varies by tool kind:
+     *   - `function_call` tools (most MCP, Bash/exec_command, update_plan): a JSON object.
+     *   - `custom_tool_call` tools (apply_patch): a RAW STRING — the patch text directly.
+     *
+     * Adapters that consume specific tool_input fields must runtime-check the
+     * shape (typeof === "string") before treating it as a record.
+     */
+    tool_input?: Record<string, unknown> | string;
+    tool_response?: unknown;
+    tool_use_id?: string;
+    source?: string;
+    prompt?: string;
+    stop_hook_active?: boolean;
+    last_assistant_message?: string;
+}
+export declare function parseCodexHookStdin(raw: string): CodexHookStdin;
+/**
+ * Reverse Codex's `-`→`_` flattening on the server segment. Idempotent: an
+ * already-canonical (hyphenated) name passes through unchanged.
+ */
+export declare function canonicalizeCodexServerName(serverSegment: string): string;
+/**
+ * Reverse Codex's `-`→`_` flattening on a devtools tool action segment.
+ * Rule: keep the first two underscores (prefix + domain separators), turn
+ * every subsequent `_` into `-`. Only applies to known devtools prefixes
+ * (`bdt_` / `ndt_` / `bedt_`); other tool names pass through unchanged.
+ *
+ * Idempotent: input that already contains `-` only flattens further
+ * underscores past the third segment.
+ */
+export declare function canonicalizeCodexToolName(bareToolName: string): string;
+/**
+ * Returns the CANONICAL (hyphen-form) MCP server name for a Codex tool name.
+ *
+ * Codex tool names arrive in TWO shapes depending on the surface:
+ *   1. **Hook stdin** wraps the bare name in `mcp__<server>__<tool>` with the
+ *      `-`→`_` flattening (e.g. `mcp__browser_devtools__bdt_content_start_recording`).
+ *   2. **Rollout JSONL** (`function_call.name`) carries the BARE tool name
+ *      (e.g. `bdt_content_take_screenshot`) — no `mcp__` wrapper at all.
+ *
+ * Both are handled here so downstream comparisons against the registered
+ * server name (`browser-devtools` / `node-devtools` / `backend-devtools`)
+ * work regardless of surface.
+ *
+ * Returns null for non-MCP tools.
+ */
+export declare function extractCodexMcpServer(toolName: string | undefined): string | null;
+/**
+ * Map a Codex / OpenAI tool name to the cross-client canonical (Claude) vocab,
+ * so `tool_call.tool_name` (live + import) AND `session_analytics.tools[*]`
+ * map keys (analytics projection) ALL agree on the same wire string for the
+ * same logical tool. Without this alignment, a backend join of
+ * `session_analytics.tools[k]` against `tool_call.tool_name` breaks on every
+ * Codex session for the affected tools:
+ *
+ *   `apply_patch` → analytics keys `"Edit"`, live/import ship `"apply_patch"`
+ *   `update_plan` → analytics keys `"TodoWrite"`, live/import ship `"update_plan"`
+ *   `read_file`   → analytics keys `"Read"`, live/import ship `"read_file"`
+ *   `web_search`  → analytics keys `"WebSearch"`, live/import ship `"web_search"`
+ *   `web_fetch`   → analytics keys `"WebFetch"`, live/import ship `"web_fetch"`
+ *
+ * Round 67 fix: extend the mapping (was `exec_command → Bash` only) to cover
+ * every alias the analytics projection's `claudeAlias` switch handles. The
+ * projection in `analytics/codex/projection.ts:670` continues to apply the
+ * same mapping for its `tools` map keys (kept there as a defense-in-depth /
+ * documentation aid — the two MUST stay in lockstep). Cross-client
+ * aggregations on `tools["Bash"]` / `tools["Read"]` / etc. now include both
+ * Claude and Codex sources for every alias, not just `Bash`.
+ */
+export declare function normalizeCodexToolName(toolName: string): string;
+export interface ClassifiedCodexTool {
+    tool_type: "mcp" | "skill" | "sub_agent" | null;
+    tool_name: string;
+    mcp_server: string | null;
+}
+export declare function classifyCodexTool(rawToolName: string | undefined): ClassifiedCodexTool;
+/**
+ * Per-tool input whitelist (mirrors `extractClaudeToolInput` / `extractCursorToolInput`).
+ * Default Codex toolset: `Bash`/`exec_command`, `apply_patch`, `update_plan`, MCP tools.
+ * Returns undefined for unknown tools (so the wire shape stays opt-in).
+ */
+export declare function extractCodexToolInput(toolName: string | undefined, toolInput: Record<string, unknown> | string | undefined): Record<string, unknown> | undefined;
+export declare function extractBashBinary(command: string): string | undefined;
+export interface CodexUsage {
+    usageType?: "api" | "subscription";
+    usagePlan?: string;
+    userEmail?: string;
+}
+interface CodexJwtPayload {
+    email?: string;
+    "https://api.openai.com/auth"?: {
+        chatgpt_plan_type?: string;
+    };
+}
+/**
+ * Decode the *payload* of a JWT (`header.payload.signature`).
+ *
+ * We never verify the signature — the token was minted by Codex into the
+ * user's own `~/.codex/auth.json` and we just want to read the claims for
+ * event-tagging. Returns `null` on any malformedness (wrong segment count,
+ * bad base64url, non-JSON payload).
+ */
+export declare function decodeJwtPayload(token: string): CodexJwtPayload | null;
+/**
+ * Read `~/.codex/auth.json` to derive `usage_type` / `usage_plan` /
+ * `user_email` for event base-fields population.
+ *
+ * `auth_mode` values seen in the wild:
+ *   - `"chatgpt"` — ChatGPT browser-login / subscription (Plus / Pro / Team /
+ *     Enterprise). Current default for `codex login`.
+ *   - `"swic"` — older subscription mode alias; kept for back-compat.
+ *   - `"api"` — OpenAI Platform API key.
+ *
+ * `authPath` is optional — defaults to `~/.codex/auth.json`. Tests pass an
+ * explicit path to avoid HOME-env-var caching issues across jest workers.
+ */
+export declare function resolveCodexUsage(authPath?: string): CodexUsage;
+/**
+ * Find the line range [startIdx, endIdx) of a TOML table by exact header
+ * `[<sectionName>]`. Returns null if not found. `endIdx` is the line index
+ * of the next header (or content end). Header itself is included.
+ */
+export declare function findTomlSection(lines: string[], sectionName: string): {
+    startIdx: number;
+    endIdx: number;
+} | null;
+/**
+ * Ensure `[features]` table contains `hooks = true`. Idempotent — merges
+ * into an existing `[features]` table if present (without disturbing other
+ * keys), or appends a fresh table at the end of the file.
+ */
+export declare function ensureFeaturesHooksTrue(content: string): string;
+/**
+ * Insert or replace a `[mcp_servers.<name>]` block with the given body lines.
+ * Body lines should NOT include the header line. Idempotent.
+ */
+export declare function upsertMcpServer(content: string, serverName: string, bodyLines: string[]): string;
+/**
+ * Remove a `[mcp_servers.<name>]` block entirely. Idempotent.
+ *
+ * Preserves the leading blank line that previously separated the removed
+ * block from the prior section — that blank stays as the separator between
+ * the prior section and whatever comes after. Collapses any consecutive
+ * blank lines that arise from the removal so we never end up with more
+ * than one blank line between sections.
+ */
+export declare function removeMcpServer(content: string, serverName: string): string;
+/**
+ * Render a body of inline TOML key=value lines from a record. Strings get
+ * quoted, arrays of strings get inline TOML array syntax, env nested table
+ * gets emitted as an inline table.
+ */
+export declare function tomlBodyFromRecord(record: Record<string, unknown>): string[];
+export declare const AGENTS_MD_START_MARKER: string;
+export declare const AGENTS_MD_END_MARKER: string;
+/**
+ * Upsert the IronBee-managed block in an AGENTS.md file. The block is
+ * delimited by HTML comment markers; user content outside the markers is
+ * preserved verbatim. If markers don't exist, the block is appended.
+ */
+export declare function upsertAgentsMdBlock(existing: string, blockContent: string): string;
+/**
+ * Strip the IronBee-managed block from AGENTS.md. Returns null when the
+ * resulting file would be empty (caller can delete the file). Preserves
+ * any user content outside the markers.
+ */
+export declare function stripAgentsMdBlock(existing: string): string | null;
+export declare function readCodexConfigToml(): string;
+export declare function writeCodexConfigToml(content: string): void;
+export declare function codexConfigTomlPath(): string;
+export declare function codexHooksJsonPath(): string;
+export {};
+//# sourceMappingURL=util.d.ts.map

package/dist/clients/codex/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/clients/codex/util.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AASH,MAAM,WAAW,cAAc;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAO/D;AAoCD;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAStE;AASD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,CAkBjF;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAoB/D;AAED,MAAM,WAAW,mBAAmB;IAChC,SAAS,EAAE,KAAK,GAAG,OAAO,GAAG,WAAW,GAAG,IAAI,CAAC;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,CAsDtF;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACjC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,SAAS,GACxD,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAgJrC;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CA4BrE;AAID,MAAM,WAAW,UAAU;IACvB,SAAS,CAAC,EAAE,KAAK,GAAG,cAAc,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAkBD,UAAU,eAAe;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B,CAAC,EAAE;QAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;CACL;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI,CAetE;AA0BD;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,CAuB/D;AAiBD;;;;GAIG;AACH,wBAAgB,eAAe,CAC3B,KAAK,EAAE,MAAM,EAAE,EACf,WAAW,EAAE,MAAM,GACpB;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAmB7C;AA2BD;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAgC/D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC3B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EAAE,GACpB,MAAM,CAsBR;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAwB3E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CAwC5E;AAID,eAAO,MAAM,sBAAsB,EAAE,MAAiC,CAAC;AACvE,eAAO,MAAM,oBAAoB,EAAE,MAA+B,CAAC;AAEnE;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAalF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAalE;AAID,wBAAgB,mBAAmB,IAAI,MAAM,CAW5C;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAO1D;AAED,wBAAgB,mBAAmB,IAAI,MAAM,CAE5C;AAED,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C"}