chore: export public API option types from the package entry#5
Conversation
StartMountOptions, FlushMountOptions and StopMountOptions are parameter types of public SandboxOrchestrator methods; LocalSandboxRuntimeOptions is the constructor parameter of the exported LocalSandboxRuntime; SandboxLookupOptions and SandboxCountOptions are parameter types on the SandboxRuntime port. None were reachable from the package entry, and the exports map only exposes ".", so consumers could not name them at all. buildRelayfileMountLifecycleShell and buildRelayfileMountCleanupInvocationShell are exported from orchestrator.ts but were likewise unreachable.
|
Warning Review limit reached
Next review available in: 6 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request exports several new types and functions from src/index.ts to expose them as part of the public API, including sandbox options, mount lifecycle shell builders, and mount options. Feedback suggests also exporting AsyncRunStartResult from ./port.js as it is part of the public API surface but currently missing from the package entry.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| AsyncRunStatus, | ||
| DeclaredSandboxRuntimeCapabilities, | ||
| RunScriptResult, | ||
| SandboxCountOptions, |
There was a problem hiding this comment.
The type AsyncRunStartResult (defined in src/port.ts) is part of the public API surface as the return type of SandboxRuntime.startScript, but it is not exported from the package entry.
To ensure consumers can name this type, please add it to the exports from ./port.js in alphabetical order:
export type {
AsyncRunStartResult,
AsyncRunStatus,
DeclaredSandboxRuntimeCapabilities,
RunScriptResult,
SandboxCountOptions,
SandboxLookupOptions,
SandboxRuntime,
SandboxRuntimeCapabilities,
} from "./port.js";
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
1 participant
Why
Nine symbols are part of the public API surface but are not reachable from the
package entry. The
exportsmap only exposes".", so a consumer cannotdeep-import them either — they are unnameable.
StartMountOptionsSandboxOrchestratormethod (orchestrator.ts:154)FlushMountOptionsSandboxOrchestratormethod (:272)StopMountOptionsSandboxOrchestratormethod (:288)LocalSandboxRuntimeOptionsLocalSandboxRuntime(local/runtime.ts:45)SandboxLookupOptionsSandboxRuntimeport (port.ts:43,47)SandboxCountOptionsSandboxRuntimeport (port.ts:51)RelayfileMountLifecycleShellOptionsbuildRelayfileMountLifecycleShellbuildRelayfileMountCleanupInvocationShellA class whose constructor options type cannot be named, or a method whose
parameter type cannot be named, forces consumers to restate the shape by hand —
which then silently drifts from the real one.
Verification
build*functions aretypeof === "function"when importingdist/index.js.dist/index.d.ts: a probe module importing allseven types compiles clean under
--module nodenext.34 pass / 0 fail.Export-list change only. No source, behavior, config, or CI changes.
Summary by cubic
Exported missing public API types and orchestrator shell builders from the package entry so consumers can import them directly. No runtime or config changes.
src/index.tsforStartMountOptions,FlushMountOptions,StopMountOptions,LocalSandboxRuntimeOptions,SandboxLookupOptions,SandboxCountOptions,RelayfileMountLifecycleShellOptions.buildRelayfileMountLifecycleShellandbuildRelayfileMountCleanupInvocationShell.Written for commit 3e0e635. Summary will update on new commits.