fix(types): re-export public API types dropped in 1.23.0 - #998
Open
Saitgalin wants to merge 3 commits into
Open
Conversation
|
|
Contributor
There was a problem hiding this comment.
Pull request overview
Restores several type-only exports at the package roots of @clickhouse/client and @clickhouse/client-web that were previously part of the @clickhouse/client-common public surface, fixing downstream TypeScript import errors introduced after the 1.23.0 bundling change.
Changes:
- Re-export
QueryParamsWithFormatfrom both clients’ root entrypoints. - Re-export result and JSON typing helpers (
ResultJSONType,RowJSONType,ResultStream) from both clients’ root entrypoints. - Re-export ping and summary-related public types (
PingParams*,ClickHouseSummary,WithClickHouseSummary,WithResponseHeaders) from both clients’ root entrypoints.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/client-web/src/index.ts | Adds missing type-only re-exports to restore the Web client’s public API typing surface. |
| packages/client-node/src/index.ts | Adds missing type-only re-exports to restore the Node client’s public API typing surface. |
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
12
to
16
| type BaseClickHouseClientConfigOptions, | ||
| type BaseQueryParams, | ||
| type QueryParams, | ||
| type QueryParamsWithFormat, | ||
| type ExecParams, |
Comment on lines
11
to
15
| type BaseClickHouseClientConfigOptions, | ||
| type BaseQueryParams, | ||
| type QueryParams, | ||
| type QueryParamsWithFormat, | ||
| type ExecParams, |
mshustov
approved these changes
Aug 14, 2026
Member
|
@Saitgalin could you sign CLA pls? |
mshustov
enabled auto-merge (squash)
August 14, 2026 08:07
Ten types that the clients use in their own public signatures are missing from the root of @clickhouse/client and @clickhouse/client-web since the common sources were bundled into the client packages. All of them were exported from @clickhouse/client-common, which is now deprecated, so there is no supported place left to import them from. Type-only re-exports: the emitted JavaScript is unchanged.
auto-merge was automatically disabled
August 15, 2026 03:02
Head branch was pushed to by a user without write access
Saitgalin
force-pushed
the
export-missing-public-types
branch
from
August 15, 2026 03:02
cc00e2f to
3ccd81c
Compare
Author
|
Signed. CLA check is green now. |
mshustov
enabled auto-merge (squash)
August 16, 2026 12:46
Addresses the Copilot review comments on ClickHouse#998: the re-exports change the public API surface of both clients, so both CHANGELOGs get a matching entry under the unreleased 1.24.0 "Bug fixes" section.
auto-merge was automatically disabled
August 18, 2026 02:35
Head branch was pushed to by a user without write access
mshustov
enabled auto-merge (squash)
August 18, 2026 13:34
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.
Closes #997. The issue lists six of these; I found the other four (the ping ones and
ResultStream) while preparing the change.All ten were exported from the root of
@clickhouse/client-common, and the ping ones sit in the block that itsindex.tsmarks with/** Should be re-exported by the implementation */. The lower level exports (Connection*,LogWriter, the encoders and utils) are clearly internal, so I left them out.WithHttpStatusCodewas never exported fromclient-commoneither, so it is not here; happy to add it if you want the whole intersection nameable.Type-only re-exports: I built the tree with and without the change,
dist/index.jsis byte identical for both packages, only the.d.tsfiles differ. Locally green: typecheck, lint, prettier, build,test:node:unit(408 passed).test:web:unitneeds Playwright browsers, which I don't have set up.No test included, and I would rather ask than guess: a type level assertion would not fail anywhere in CI today, since the package tsconfigs include only
src/**and vitest runs withouttypecheck.