import { runCheckTsdoc } from "./outfitter-qka1skyw.js"; import { CliOutputMode } from "./outfitter-fhahf9f3.js"; import { InternalError, Result, ValidationError } from "@outfitter/contracts"; import { TsDocCheckResult } from "@outfitter/tooling"; /** Validated input for the docs.api action handler. */ interface DocsApiInput { /** Workspace root used to resolve package paths. */ readonly cwd: string; /** Optional jq expression applied to structured output. */ readonly jq?: string | undefined; /** Filter declarations by documentation coverage level. */ readonly level?: "documented" | "partial" | "undocumented" | undefined; readonly outputMode: CliOutputMode; /** Package names to include; empty array means all packages. */ readonly packages: string[]; } interface DocsApiDependencies { readonly runCheckTsdoc?: typeof runCheckTsdoc; } /** * Extract API reference from TSDoc coverage data. * * Delegates to `runCheckTsdoc` with sensible defaults for documentation * output (non-strict, full declaration detail, no minimum coverage). * * @param input - Validated action input * @returns Result containing the TSDoc check result shaped as API reference */ declare function runDocsApi(input: DocsApiInput, dependencies?: DocsApiDependencies): Promise>; /** * Print API reference results in the appropriate output format. * * For structured modes (JSON/JSONL), delegates to the standard output * helper. For human mode, formats as an API reference listing grouped * by package. * * @param result - The TSDoc check result * @param options - Output formatting options */ declare function printDocsApiResults(result: TsDocCheckResult, options?: { mode?: CliOutputMode; jq?: string | undefined; }): Promise; export { DocsApiInput, runDocsApi, printDocsApiResults };