refactor!: Continued public surface minimization - #4060
Draft
janbuchar wants to merge 5 commits into
Draft
Conversation
janbuchar
force-pushed
the
continued-public-surface-minimization
branch
from
August 20, 2026 18:43
25f8610 to
994808a
Compare
… changes `@internal` is only applied where the member genuinely is not promised surface. Overrides of a documented extension point are deliberately left untagged: the concrete `_launch`/`addProxyToLaunchOptions`/`isChromiumBasedBrowser` and `_close`/`_kill`/`_newPage`/`_getCookies`/`_setCookies` implementations restate a contract that `upgrading_v4.md` tells custom plugins and controllers to override, so tagging them would only shorten the report while claiming something false. `normalizeProxyOptions` and the `useRemoteConnection` overrides stay tagged -- their base declarations are internal too.
…ilder` `BasicCrawler.buildContextPipeline` only ever returned an empty pipeline, so it is gone and the eight subclasses that extended it now keep their builders `#private` — `HttpCrawler` and `BrowserCrawler` stay `protected`, being the only levels that genuinely compose stages. `FileDownload` also stops silently discarding a user-supplied `contextPipelineBuilder`.
… obsolete `@private` decorators
janbuchar
force-pushed
the
continued-public-surface-minimization
branch
from
August 21, 2026 16:31
f13057d to
aae01ca
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
follows refactor!: Continue public API minimization #4036
related to Minimize public interface of Crawlee components #3109
Visibility — members that were never extension points become
#private, TSprivateor@internal. A few exports go too:@crawlee/browser-poolis no longer re-exported fromcrawlee, theutilsbag is gone, and@crawlee/types' utility types (Dictionary,Awaitable,Constructor, …) are no longer re-exported from@crawlee/core.Context pipeline —
BasicCrawler.buildContextPipelineonly ever returned an empty pipeline, so it is gone.HttpCrawlerandBrowserCrawlerkeep theirsprotectedas the two supported override points; the remaining subclass builders are#private.FileDownloadalso stops silently discarding a user-suppliedcontextPipelineBuilder— which is what the guide had been telling people to use.BasicCrawler.requestManager— a getter over a#field. The crawler owns the manager's lifecycle (resolving therequestManager/requestList/requestQueueoptions, opening a default queue, wrapping forsameDomainDelaySecs), and subclass assignment skipped all of it.Left untagged on purpose:
BrowserPlugin's_launch/addProxyToLaunchOptions/isChromiumBasedBrowserandBrowserController's_close/_kill/_newPage/_getCookies/_setCookies. The upgrading guide tells custom plugins and controllers to override exactly these, so tagging them would only shorten the report while claiming something false.Worth knowing while reviewing:
@internalhere records "not promised" and drops the member from the surface map. It is not enforced — there is nostripInternal, so tagged members still ship in the.d.ts, and that is intended.