[codex] Enable API Extractor

[nick-pape]

Summary

• Enables API Extractor in the shared Heft rig.
• Adds shared API Extractor base config that writes API reports to common/reviews.
• Adds per-package API Extractor configs for all Heft library projects.
• Adds package-level TSDoc and public API documentation across the generated API surface.
• Fixes API Extractor forgotten-export warnings in @fledgling/tools-mcp-node and @fledgling/workspace-nodepod.
• Checks in regenerated API report baselines with no undocumented markers or API Extractor warnings.

Validation

• node common\scripts\install-run-rush.js update
• node common\scripts\install-run-rush.js build
• rg -n "\(undocumented\)|Warning:|No @packageDocumentation" common\reviews returned no matches

[Copilot]

Pull request overview

This PR enables API Extractor across the monorepo via the shared Heft rig, standardizes a shared API Extractor base configuration that writes API reports to common/reviews, and updates packages to provide package-level TSDoc / public API documentation with checked-in API report baselines.

Changes:

• Adds an api-extractor Heft task (via @rushstack/heft-api-extractor-plugin) and a shared api-extractor-base.json rig config.
• Adds per-package config/api-extractor.json files extending the shared base config.
• Adds package-level @packageDocumentation (and other public-surface TSDoc) plus checked-in common/reviews/*.public.api.md baselines.

Reviewed changes

Copilot reviewed 67 out of 68 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
rigs/heft-rig/profiles/default/config/heft.json	Adds the api-extractor task to the shared Heft build phase.
rigs/heft-rig/profiles/default/config/api-extractor-base.json	Introduces shared API Extractor baseline settings/output locations.
rigs/heft-rig/package.json	Adds Heft API Extractor plugin + API Extractor dependencies to the rig.
packages/workspace-nodepod/src/runtime.ts	Adds/exports public types and TSDoc for the Nodepod workspace runtime surface.
packages/workspace-nodepod/src/index.ts	Adds package-level @packageDocumentation.
packages/workspace-nodepod/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/web-agent/src/tool-provider.ts	Adds TSDoc for the web MCP tool provider public surface.
packages/web-agent/src/index.ts	Adds package-level @packageDocumentation.
packages/web-agent/src/dependencies.ts	Adds TSDoc for browser agent composition helpers and options.
packages/web-agent/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/tools-mcp-node/src/index.ts	Adds package docs, exports config types, and documents Node MCP provider API.
packages/tools-mcp-node/src/config.ts	Adds TSDoc for the Node MCP configuration types.
packages/tools-mcp-node/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/session-memory/src/index.ts	Adds package docs and TSDoc for the in-memory session manager API.
packages/session-memory/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/session-log/src/session-store.ts	Adds TSDoc for JSONL session store API.
packages/session-log/src/index.ts	Adds package-level @packageDocumentation.
packages/session-log/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/session-local-storage/src/index.ts	Adds package docs and TSDoc for the localStorage-backed session manager API.
packages/session-local-storage/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/session-file-system/src/index.ts	Adds package docs and TSDoc for the filesystem-backed session manager API.
packages/session-file-system/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/mcp-workspace/src/index.ts	Adds package-level @packageDocumentation for the CLI entrypoint.
packages/mcp-workspace/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/mcp-workspace-webcontainer/src/runtime.ts	Adds TSDoc for the WebContainer workspace runtime adapter API.
packages/mcp-workspace-webcontainer/src/index.ts	Adds package-level @packageDocumentation.
packages/mcp-workspace-webcontainer/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/mcp-workspace-browser/src/sidecar.ts	Adds TSDoc for the browser sidecar contracts and helpers.
packages/mcp-workspace-browser/src/runtime.ts	Adds TSDoc for browser workspace runtime contracts and helpers.
packages/mcp-workspace-browser/src/index.ts	Adds package-level @packageDocumentation.
packages/mcp-workspace-browser/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/context-builder/src/token-estimator.ts	Adds TSDoc for token estimation utilities.
packages/context-builder/src/prune-events.ts	Adds TSDoc for pruning options/results/types.
packages/context-builder/src/index.ts	Adds package-level @packageDocumentation.
packages/context-builder/src/build-context.ts	Adds comprehensive TSDoc for context building/compaction APIs and types.
packages/context-builder/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/common/src/session-events.ts	Adds TSDoc for session event model/public contracts.
packages/common/src/index.ts	Adds package-level @packageDocumentation.
packages/common/src/context-hints.ts	Adds TSDoc for context hint metadata/types/utilities.
packages/common/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/agent-core/src/session-cleanup.ts	Adds TSDoc for session cleanup contracts and helpers.
packages/agent-core/src/prompt-errors.ts	Adds TSDoc for prompt error normalization/sanitization APIs.
packages/agent-core/src/prompt-content.ts	Adds TSDoc for prompt content/text extraction helpers.
packages/agent-core/src/interfaces.ts	Adds TSDoc for core agent interfaces and public types.
packages/agent-core/src/index.ts	Adds package-level @packageDocumentation.
packages/agent-core/src/ai-sdk-model-turn-runner.ts	Adds TSDoc for the AI SDK model turn runner public surface.
packages/agent-core/src/agent.ts	Adds TSDoc for the main ACP agent class methods.
packages/agent-core/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/acp-host-log/src/index.ts	Adds package-level @packageDocumentation for the host CLI entrypoint.
packages/acp-host-log/config/api-extractor.json	Enables API Extractor for the package via rig base config.
packages/acp-agent/src/index.ts	Adds package-level @packageDocumentation for the agent CLI entrypoint.
packages/acp-agent/config/api-extractor.json	Enables API Extractor for the package via rig base config.
common/reviews/workspace-nodepod.public.api.md	Checks in regenerated API report baseline for @fledgling/workspace-nodepod.
common/reviews/web-agent.public.api.md	Checks in regenerated API report baseline for @fledgling/web-agent.
common/reviews/tools-mcp-node.public.api.md	Checks in regenerated API report baseline for @fledgling/tools-mcp-node.
common/reviews/session-memory.public.api.md	Checks in regenerated API report baseline for @fledgling/session-memory.
common/reviews/session-log.public.api.md	Checks in regenerated API report baseline for @fledgling/session-log.
common/reviews/session-local-storage.public.api.md	Checks in regenerated API report baseline for @fledgling/session-local-storage.
common/reviews/session-file-system.public.api.md	Checks in regenerated API report baseline for @fledgling/session-file-system.
common/reviews/mcp-workspace.public.api.md	Checks in regenerated API report baseline for @fledgling/mcp-workspace.
common/reviews/mcp-workspace-webcontainer.public.api.md	Checks in regenerated API report baseline for @fledgling/mcp-workspace-webcontainer.
common/reviews/mcp-workspace-browser.public.api.md	Checks in regenerated API report baseline for @fledgling/mcp-workspace-browser.
common/reviews/context-builder.public.api.md	Checks in regenerated API report baseline for @fledgling/context-builder.
common/reviews/common.public.api.md	Checks in regenerated API report baseline for @fledgling/common.
common/reviews/agent-core.public.api.md	Checks in regenerated API report baseline for @fledgling/agent-core.
common/reviews/acp-host-log.public.api.md	Checks in regenerated API report baseline for @fledgling/acp-host-log.
common/reviews/acp-agent.public.api.md	Checks in regenerated API report baseline for @fledgling/acp-agent.
common/config/rush/pnpm-lock.yaml	Updates lockfile for new API Extractor + Heft plugin dependencies.

Files not reviewed (1)

• common/config/rush/pnpm-lock.yaml: Language not supported

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.