@momentiq/dark-factory-cli 0.1.0-alpha.4

package/dist/adapters/codex-sdk.d.ts

@@ -0,0 +1,279 @@
+import { type CriticConfig, type CriticResult, type DoctorCheck, type ReviewPacket } from "@momentiq/dark-factory-schemas";
+import type { CriticAdapter, CriticReviewOptions } from "./critic.js";
+import { type AttemptOutcome } from "./cursor-sdk.js";
+export declare const CODEX_SDK_ADAPTER_ID = "codex-sdk";
+export declare const CODEX_API_KEY_ENV = "CODEX_API_KEY";
+export declare const CODEX_HOME_ENV = "CODEX_HOME";
+export declare const CODEX_AUTH_CHATGPT: "chatgpt";
+export declare const CODEX_AUTH_API: "api";
+export type CodexAuthMode = typeof CODEX_AUTH_CHATGPT | typeof CODEX_AUTH_API;
+export declare const CODEX_AUTH_MODES: readonly CodexAuthMode[];
+/**
+ * Compute the (platform, arch) target triple Codex uses to key its
+ * per-platform binary packages. Returns `null` for unsupported platforms.
+ * Exported for direct unit testing of the resolution logic.
+ */
+export declare function targetTripleForCurrentPlatform(platform?: NodeJS.Platform, arch?: string): string | null;
+/**
+ * Resolve the absolute path to the Codex CLI binary bundled inside
+ * `@openai/codex`'s per-platform optional dependency. Returns `null` when
+ * any step of the resolution fails (so the doctor can fall back to PATH).
+ *
+ * Mirrors `findCodexPath()` in `@openai/codex-sdk@0.130.0` —
+ * `node_modules/@openai/codex-sdk/dist/index.js:368-433`. The SDK does
+ * not export this function publicly, so we replicate the lookup here
+ * using the same `createRequire` + `package.json` walk so the doctor
+ * probes the EXACT binary the SDK will spawn at review time.
+ */
+export declare function resolveBundledCodexCliPath(): string | null;
+/**
+ * Outcome of probing `codex login status`. `loggedIn: true` matches
+ * exit-0 from the CLI regardless of where credentials are stored
+ * (~/.codex/auth.json vs OS keyring), which is the canonical detector
+ * for #1471 P2 #1.
+ */
+export interface CodexAuthProbeOutcome {
+    loggedIn: boolean;
+    detail: string;
+}
+/**
+ * Subprocess hook used by {@link probeCodexLoginStatus}. Production passes
+ * the promisified `child_process.execFile`; tests pass a mock so the
+ * probe can be exercised hermetically. Mirrors the same shape as the
+ * `execCodex` option on {@link CodexSdkAdapterOptions}.
+ */
+export type CodexExecHook = (binaryPath: string, args: readonly string[], options?: {
+    timeout?: number;
+}) => Promise<{
+    stdout: string;
+}>;
+/**
+ * Probe `codex login status` to detect authenticated state regardless of
+ * where credentials are stored (~/.codex/auth.json or OS keyring per
+ * `cli_auth_credentials_store: auto`). The CLI exits 0 when authenticated
+ * and non-zero when not, which is the canonical detector for #1471 P2 #1.
+ *
+ * The `exec` parameter defaults to the promisified `child_process.execFile`
+ * but accepts a test override so the probe can be invoked deterministically.
+ *
+ * Exported and used by {@link CodexSdkAdapter.doctor} (the doctor's
+ * `defaultAuthProbe` routes here with its `execCodex` hook injected).
+ */
+export declare function probeCodexLoginStatus(cliPath: string, exec?: CodexExecHook, timeoutMs?: number): Promise<CodexAuthProbeOutcome>;
+export declare const DEFAULT_REASONING_EFFORT: "high";
+/**
+ * Test-shape compatible with the `@openai/codex-sdk` Codex / Thread
+ * classes. The unit tests pass a mock conforming to this shape; production
+ * passes the real `new Codex({ config: ... })` instance through the
+ * `createCodex` factory on the adapter constructor.
+ *
+ * The shape stays narrow on purpose — the adapter uses ONLY the methods
+ * declared here, so an SDK upgrade that re-shapes other surfaces won't
+ * silently break the adapter.
+ */
+export interface CodexClient {
+    startThread: (options: CodexThreadOptions) => CodexThread;
+}
+export interface CodexThread {
+    /** Populated after the first turn starts. */
+    readonly id: string | null;
+    run: (prompt: string, options: {
+        outputSchema?: unknown;
+        signal?: AbortSignal;
+    }) => Promise<CodexTurnResult>;
+}
+export interface CodexUsage {
+    input_tokens: number;
+    cached_input_tokens: number;
+    output_tokens: number;
+    reasoning_output_tokens: number;
+}
+export interface CodexTurnResult {
+    items: unknown[];
+    /** Last agent_message text; schema-validated JSON when outputSchema is set. */
+    finalResponse: string;
+    usage: CodexUsage | null;
+}
+/**
+ * Thread-construction options the adapter sets when starting a turn.
+ * Mirrors `ThreadOptions` in `@openai/codex-sdk` but typed locally so
+ * the SDK is not required at compile time for test environments that
+ * use the mock factory.
+ */
+export interface CodexThreadOptions {
+    model?: string;
+    sandboxMode?: "read-only" | "workspace-write" | "danger-full-access";
+    approvalPolicy?: "never" | "on-request" | "on-failure" | "untrusted";
+    modelReasoningEffort?: "minimal" | "low" | "medium" | "high" | "xhigh";
+    networkAccessEnabled?: boolean;
+    workingDirectory?: string;
+    skipGitRepoCheck?: boolean;
+}
+/**
+ * Top-level streamed events (mirrors the SDK's `ThreadEvent` union).
+ * Currently unused by the adapter — `thread.run()` returns a `Turn`
+ * directly without a stream — but exported so future event-aware
+ * adapters and tests can lean on a stable type surface.
+ */
+export type CodexThreadEvent = {
+    type: "thread.started";
+    thread_id: string;
+} | {
+    type: "turn.started";
+} | {
+    type: "turn.completed";
+    usage: CodexUsage;
+} | {
+    type: "turn.failed";
+    error: {
+        message: string;
+    };
+} | {
+    type: "item.started";
+    item: unknown;
+} | {
+    type: "item.updated";
+    item: unknown;
+} | {
+    type: "item.completed";
+    item: unknown;
+} | {
+    type: "error";
+    message: string;
+};
+export interface CodexSdkAdapterOptions {
+    /**
+     * Override CODEX_API_KEY env. Production reads from `process.env` —
+     * the constructor option is a test escape hatch.
+     */
+    apiKey?: string;
+    /**
+     * Override `CODEX_HOME` for the auth.json doctor probe. Production
+     * reads from env or defaults to `~/.codex`.
+     */
+    codexHome?: string;
+    /**
+     * Test escape hatch — inject a mock Codex client. Production builds
+     * the real `new Codex({...})` each `review()` call (one client per
+     * call is a no-op since the SDK is a thin wrapper that lazily spawns
+     * the CLI per `thread.run()`).
+     */
+    createCodex?: (options: {
+        apiKey?: string;
+        config?: Record<string, unknown>;
+    }) => CodexClient;
+    /**
+     * Test escape hatch for the retry-loop sleep. When unset the adapter
+     * uses the real `sleepForRetry` (wall-clock + AbortSignal-aware).
+     * Mirrors the same hook on `runRetryLoop` so tests don't have to wait
+     * for 5s + 15s of real backoff to exercise retry behavior.
+     */
+    sleep?: (idx: number, signal: AbortSignal | undefined) => Promise<void>;
+    /**
+     * Test escape hatch for the bundled-binary resolver (#1471 P2 #2).
+     * Production uses {@link resolveBundledCodexCliPath} to mirror the SDK's
+     * `findCodexPath()` lookup. Tests pass a lambda returning `null` (to
+     * exercise the PATH-fallback path) or a fake absolute path (to assert
+     * the resolved binary is what gets probed).
+     */
+    codexCliPathResolver?: () => string | null;
+    /**
+     * Test escape hatch for the `execFile` subprocess invocation
+     * (#1492 + #1471 P2 #2). Production uses the promisified
+     * `child_process.execFile`. Tests pass a mock to (a) avoid spawning the
+     * real `codex` binary and (b) assert WHICH binary path the doctor
+     * probes.
+     *
+     * `args` is a fixed string-array (no shell parsing). Throw an Error with
+     * `code: "ENOENT"` to simulate a missing-binary failure (same shape
+     * `execFile` produces against an unresolved command).
+     */
+    execCodex?: (binaryPath: string, args: readonly string[], options?: {
+        timeout?: number;
+    }) => Promise<{
+        stdout: string;
+    }>;
+    /**
+     * Test escape hatch for the `codex login status` probe (#1471 P2 #1).
+     *
+     * In production, `doctor()` builds a `defaultAuthProbe` that delegates
+     * to the exported {@link probeCodexLoginStatus}, passing the same
+     * `execCodex` hook the rest of the doctor uses so the entire
+     * subprocess surface is uniformly mockable. The probed binary is the
+     * bundled one when resolvable, falling back to PATH `codex` — the
+     * same binary the SDK spawns at review time, so the doctor verdict
+     * reflects runtime truth.
+     *
+     * Tests pass a lambda returning `{ loggedIn: true|false, detail: string }`
+     * to exercise the doctor's three-way auth check (env / file /
+     * keyring-via-status) hermetically without spawning the CLI.
+     */
+    codexAuthProbe?: () => Promise<CodexAuthProbeOutcome>;
+}
+/**
+ * Resolve the Codex reasoning-effort from the critic config's
+ * `model.params`. Falls back to {@link DEFAULT_REASONING_EFFORT} when
+ * unset. Invalid values fall back to the default rather than corrupting
+ * the request body. Coerces string inputs (the config schema's `value`
+ * is `string | number | boolean`; reasoning effort is always a string
+ * enum). Exported for direct unit testing.
+ */
+export declare function resolveCodexReasoningEffort(critic: CriticConfig): string;
+/**
+ * Probe a thrown error for a Codex SDK structured error code. The
+ * Codex SDK surfaces errors as plain `Error` instances; some SDK
+ * upgrades add a `code` field (mirroring openai's `APIError.code`).
+ * The adapter treats:
+ *   - `code` matching {@link PERMANENT_ERROR_CODES} → permanent
+ *   - everything else → retryable
+ * Exported for unit testing.
+ */
+export declare function extractCodexErrorCode(err: unknown): string | null;
+/**
+ * Issue #2103 — strict auth resolver. Validates `critic.auth` against
+ * the codex adapter vocabulary ({@link CODEX_AUTH_MODES}) and surfaces
+ * the missing-key case as a `permanent_failure` so the outer retry
+ * loop returns the error immediately (retrying a configuration
+ * mistake just wastes budget). Returns the resolved mode + an
+ * `apiKey` value that is INTENTIONALLY `undefined` under the
+ * "chatgpt" branch so the caller passes nothing to the SDK
+ * constructor — a stray `CODEX_API_KEY` cannot override the
+ * subscription path.
+ *
+ * Three failure shapes, all permanent (no retry):
+ *
+ *   1. `critic.auth === undefined`: profile didn't pin auth. Surfaces
+ *      as `permanent_failure` with a message naming the critic + the
+ *      config path the operator should edit
+ *      (`profiles.<name>.auth[<critic.id>]`).
+ *
+ *   2. `critic.auth` is set but not in {@link CODEX_AUTH_MODES}:
+ *      typo / unsupported value. The error message enumerates the
+ *      valid set so the operator can self-correct.
+ *
+ *   3. `critic.auth === "api"` AND no `CODEX_API_KEY` in env (and no
+ *      `apiKey` constructor override): the configured source is
+ *      missing. Same shape as the prior "missing key" path, with the
+ *      error explicitly mentioning the `api` auth mode so the
+ *      operator doesn't try to fix it by running `codex login`.
+ */
+export declare function resolveAuthOrFail(critic: CriticConfig, options: {
+    apiKey?: string;
+}, attemptIdx: number): {
+    kind: "ok";
+    mode: CodexAuthMode;
+    apiKey: string | undefined;
+} | Extract<AttemptOutcome, {
+    kind: "permanent_failure";
+}>;
+export declare class CodexSdkAdapter implements CriticAdapter {
+    private readonly options;
+    readonly id = "codex-sdk";
+    readonly requiredEnvVars: readonly string[];
+    private readonly createCodex;
+    constructor(options?: CodexSdkAdapterOptions);
+    review(packet: ReviewPacket, critic: CriticConfig, options: CriticReviewOptions): Promise<CriticResult>;
+    private attemptReview;
+    doctor(critic: CriticConfig): Promise<DoctorCheck[]>;
+}
+//# sourceMappingURL=codex-sdk.d.ts.map

package/dist/adapters/codex-sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codex-sdk.d.ts","sourceRoot":"","sources":["../../src/adapters/codex-sdk.ts"],"names":[],"mappings":"AAuEA,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,YAAY,EAClB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAQtE,OAAO,EAGL,KAAK,cAAc,EACpB,MAAM,iBAAiB,CAAC;AAQzB,eAAO,MAAM,oBAAoB,cAAc,CAAC;AAChD,eAAO,MAAM,iBAAiB,kBAAkB,CAAC;AACjD,eAAO,MAAM,cAAc,eAAe,CAAC;AAwB3C,eAAO,MAAM,kBAAkB,EAAG,SAAkB,CAAC;AACrD,eAAO,MAAM,cAAc,EAAG,KAAc,CAAC;AAC7C,MAAM,MAAM,aAAa,GAAG,OAAO,kBAAkB,GAAG,OAAO,cAAc,CAAC;AAC9E,eAAO,MAAM,gBAAgB,EAAE,SAAS,aAAa,EAGpD,CAAC;AA8BF;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,GAAE,MAAM,CAAC,QAA2B,EAC5C,IAAI,GAAE,MAAqB,GAC1B,MAAM,GAAG,IAAI,CAkBf;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,IAAI,MAAM,GAAG,IAAI,CAsB1D;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,CAC1B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,KAC3B,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEjC;;;;;;;;;;;GAWG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,aACsD,EAC5D,SAAS,SAAQ,GAChB,OAAO,CAAC,qBAAqB,CAAC,CAUhC;AAiBD,eAAO,MAAM,wBAAwB,EAAG,MAAe,CAAC;AAKxD;;;;;;;;;GASG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,WAAW,CAAC;CAC3D;AAED,MAAM,WAAW,WAAW;IAC1B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,GAAG,EAAE,CACH,MAAM,EAAE,MAAM,EACd,OAAO,EAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,KACtD,OAAO,CAAC,eAAe,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,uBAAuB,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,+EAA+E;IAC/E,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,WAAW,GAAG,iBAAiB,GAAG,oBAAoB,CAAC;IACrE,cAAc,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,YAAY,GAAG,WAAW,CAAC;IACrE,oBAAoB,CAAC,EAAE,SAAS,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;IACvE,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAC7C;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,GACxB;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,GAC7C;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACzC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvC,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE;QACtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAClC,KAAK,WAAW,CAAC;IAClB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IAC3C;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,CACV,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAC3B,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjC;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACvD;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAQxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAWjE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,EAC5B,UAAU,EAAE,MAAM,GACjB;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,OAAO,CAAC,cAAc,EAAE;IAAE,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC,CA0D1H;AAED,qBAAa,eAAgB,YAAW,aAAa;IAgBvC,OAAO,CAAC,QAAQ,CAAC,OAAO;IAfpC,QAAQ,CAAC,EAAE,eAAwB;IAQnC,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAM;IAEjD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAGV;gBAEW,OAAO,GAAE,sBAA2B;IAY3D,MAAM,CACV,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,YAAY,CAAC;YA+BV,aAAa;IAuTrB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;CAoN3D"}