Strip the remaining nominal members from the published declarations - #6204
Closed
candrewlee14 wants to merge 6 commits into
Closed
Strip the remaining nominal members from the published declarations#6204candrewlee14 wants to merge 6 commits into
candrewlee14 wants to merge 6 commits into
Conversation
Strip implementation-only query-builder details from published declarations, infer decoder results structurally, and compile two physical package copies to prevent regressions.
The single SQL assignment only guarded one type. Replace it with a table of public types probed in one tsc program, asserting both directions: a portable type regressing fails, and a known leak becoming portable fails too, prompting the flag to be flipped. Records the measured state of the surface, annotating each known leak with the private/protected member responsible. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Qd99Mmmi1fZkKQiV3u1jXy
Name#brand, Param#brand and CodecsCollection#resolveTypes are implementation details that reached the emitted .d.ts as protected members, making all three types nominal and so non-portable between two installs of the package. resolveTypes is declared as a field rather than left as a constructor parameter property: on a parameter the @internal marker survives into the emitted constructor signature as a stray comment. Flips Param, Name and CodecsCollection to portable in the matrix. The three dialects do not follow -- with the nominal blocker gone they fail structurally instead, on the anonymous recursive BuildRelationalQueryResult['selection'], which is recorded as their blocker. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Qd99Mmmi1fZkKQiV3u1jXy
PgColumn#toBuilder returns a PgColumnBuilder, so the builder's private and protected members are part of PgColumn's published shape, and PgTable's _.columns index signature carries them up to the table. One private field was therefore enough to make every pg table and column type non-portable between two installs. config follows its base: ColumnBuilder#config is already @internal and the pg override had not inherited the marker. The other dialects declare the same foreignKeyConfigs field but are unaffected, since only pg-core exposes toBuilder() in a public return type. Flips PgTable and PgColumn to portable. NodePgDatabase stays recorded as a known leak: its chain runs through the session, transaction and relational query builder classes and does not converge to a contained change. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Qd99Mmmi1fZkKQiV3u1jXy
This was referenced Aug 29, 2026
The view classes leaked two kinds of nominal member into the emitted .d.ts: Symbol.for-keyed config properties ([PgViewConfig], [MySqlViewConfig] and the materialized/dialect equivalents). A Symbol.for key is a distinct computed key per declaration site, so copy A's PgView carries a property copy B's does not, even though Symbol.for guarantees the runtime symbol is shared. Table already marks every Symbol.for key it declares @internal, which is why the table and column types were portable while the views were not; this applies the same treatment. Protected brand members ($MySqlViewBrand and friends), which exist only to keep the view classes distinct at type level. Flips PgView, MySqlView and SQLiteView to portable. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Qd99Mmmi1fZkKQiV3u1jXy
Sweeps the private/protected members that still reached the emitted .d.ts on the dialect, session, transaction, prepared-query, relational-query-builder and view classes, and the Symbol.for-keyed view config properties. The symbol-keyed properties follow Table's precedent: every Symbol.for key it declares is already @internal, which is exactly why Table and the column types were portable while the views were not. A Symbol.for key is a distinct computed key per declaration site, so an unstripped one makes its class non-portable even though the runtime symbol is shared. Constructor parameter properties are desugared into declared fields; on a parameter the marker survives into the emitted constructor signature as a stray comment. Flips PgView, MySqlView and SQLiteView to portable. The dialects do not follow: with their nominal members gone they come to rest on EmptyFilter's unique symbol, which is an API decision and is left to its own change. NodePgDatabase outlasts every marker and its blocker is re-recorded accordingly. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Qd99Mmmi1fZkKQiV3u1jXy
candrewlee14
force-pushed
the
strip-db-chain-internals
branch
from
August 29, 2026 18:46
fe6112b to
fbe8cde
Compare
Author
|
Superseded. The dialect half of this sweep is what actually mattered and is now 41 lines of |
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
2 participants
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.
What
Sweeps the
private/protectedmembers that still reached the emitted.d.tson the dialect, session, transaction, prepared-query and relational-query-builder classes.Done with an AST codemod rather than by hand, since it spans ~20 files. Constructor parameter properties are desugared into declared fields: on a parameter the
@internalmarker strips the member but survives into the emitted constructor signature as a stray comment.This PR flips no row on its own
That is expected, and worth being upfront about. With these members gone the dialects come to rest on
EmptyFilter'sunique symbol, which is an API decision handled separately in #6205. This change is the prerequisite: #6205 flips the three dialect rows only on top of it.If #6205 is not wanted, this PR is largely inert and can be dropped too — the rows it would enable are the same three.
And it re-records the database object
NodePgDatabaseoutlasts every marker. Its blocker is re-recorded in the matrix:BuildQueryResult<..., TConfig, ...>is a mapped type deferred on an unresolved type parameter fromfindMany<TConfig>, and the compiler cannot relatekeyof Xfrom one declaration site tokeyof Xfrom the other whileXstays deferred — it widens tostring | number | symboland fails. That is a TypeScript comparison limit, not something drizzle emits, and no marker or contained type change reaches it.Verification
Full
drizzle-ormsuite green (27 files, 1344 tests);test:typesclean.drizzle-kitanddrizzle-seed— the in-repo consumers — also typecheck clean against the modified ORM.