@bitkyc08/opencodex
Version:
Universal provider proxy for OpenAI Codex & Claude Code — use any LLM with Codex CLI/App/SDK and Claude Code
55 lines (50 loc) • 1.88 kB
text/typescript
/** A management route a capability drives. Path text only; never a handler reference. */
export interface CapabilityRoute {
readonly method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
readonly path: string;
}
export interface CapabilityFlag {
readonly name: string;
readonly value?: "string" | "number" | "boolean";
readonly required?: boolean;
readonly summary: string;
}
/**
* How a capability emits JSON.
*
* - `payload`: the API payload, largely unwrapped.
* - `envelope`: a CLI-shaped object with its own schema.
* - `none`: no `--json` mode.
*/
export type CapabilityJsonMode = "payload" | "envelope" | "none";
export interface Capability {
/** Command path, e.g. `["account", "pause"]`. */
readonly command: readonly string[];
readonly summary: string;
readonly routes: readonly CapabilityRoute[];
readonly flags: readonly CapabilityFlag[];
readonly mutates: boolean;
readonly json: CapabilityJsonMode;
/** Complete CLI usage, including operands, when verified for this leaf. */
readonly usage?: string;
readonly details?: readonly string[];
/**
* Extra banner rows this capability owns, for surfaces the banner shows separately
* from the bare command (`ocx restore back`, `ocx doctor --reclaim-response-temps`).
* Without this the banner cannot equal the capability set: it legitimately carries more
* rows than there are commands.
*/
readonly bannerLines?: readonly string[];
}
/**
* Surfaces resolved in the CLI head, before dispatch.
*
* They belong in `ocx capabilities` output and in the banner, but not in `CLI_COMMANDS`:
* `--version`, `-v`, and `version` are answered at `root.ts` and exit, so none of them is
* a runner key to parity-check against.
*/
export interface HeadCapability {
readonly invocations: readonly string[];
readonly summary: string;
readonly bannerLine: string;
}