@clickhouse/client-web 1.23.0-head.287977a.1 → 1.23.0-head.71b2e8a.1

package/README.md

@@ -1,78 +1,36 @@
-<p align="center">
-<img src=".static/logo.svg" width="200px" align="center">
-<h1 align="center">ClickHouse JS client</h1>
-</p>
-<br/>
-<p align="center">
-<a href="https://www.npmjs.com/package/@clickhouse/client">
-<img alt="NPM Version" src="https://img.shields.io/npm/v/%40clickhouse%2Fclient?color=%233178C6&logo=npm">
-</a>
+# @clickhouse/client-web
 
-<a href="https://www.npmjs.com/package/@clickhouse/client">
-<img alt="NPM Downloads" src="https://img.shields.io/npm/dw/%40clickhouse%2Fclient?color=%233178C6&logo=npm">
-</a>
+Official Web client for [ClickHouse](https://clickhouse.com/), written purely in
+TypeScript and thoroughly tested against actual ClickHouse versions.
 
-<a href="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests-node.yml">
-<img src="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests-node.yml/badge.svg?branch=main">
-</a>
+It is built on top of the
+[Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) and
+[Web Streams](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) APIs
+and supports streaming for selects. It is compatible with Chrome/Firefox
+browsers and Cloudflare Workers. The client has zero external dependencies and is
+optimized for maximum performance.
 
-<a href="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests-web.yml">
-<img src="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests-web.yml/badge.svg?branch=main">
-</a>
-
-<a href="https://codecov.io/gh/ClickHouse/clickhouse-js">
-<img src="https://codecov.io/gh/ClickHouse/clickhouse-js/graph/badge.svg?token=B832WB00WJ">
-</a>
-
-<img src="https://api.scorecard.dev/projects/github.com/ClickHouse/clickhouse-js/badge">
-</p>
-
-## About
-
-Official JS client for [ClickHouse](https://clickhouse.com/), written purely in TypeScript, thoroughly tested with actual ClickHouse versions.
-
-The client has zero external dependencies and is optimized for maximum performance.
-
-The repository consists of four packages:
-
-- `@clickhouse/client` - a version of the client designed for Node.js platform only. It is built on top of [HTTP](https://nodejs.org/api/http.html)
-  and [Stream](https://nodejs.org/api/stream.html) APIs; supports streaming for both selects and inserts.
-- `@clickhouse/client-web` - a version of the client built on top of [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
-  and [Web Streams](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) APIs; supports streaming for selects.
-  Compatible with Chrome/Firefox browsers and Cloudflare workers.
-- `@clickhouse/client-common` - shared common types and the base framework for building a custom client implementation.
-- `@clickhouse/rowbinary` - a library for reading (and soon writing) ClickHouse RowBinary format.
+> Running on Node.js? Use
+> [`@clickhouse/client`](https://www.npmjs.com/package/@clickhouse/client)
+> instead, which additionally supports streaming for inserts.
 
 ## Installation
 
-Node.js client:
-
-```sh
-npm i @clickhouse/client
-```
-
-Web client (browsers, Cloudflare workers):
-
 ```sh
 npm i @clickhouse/client-web
 ```
 
 ## Environment requirements
 
-### Node.js
-
-Node.js must be available in the environment to run the Node.js client. The client is compatible with all the [maintained](https://github.com/nodejs/release#readme) Node.js releases.
+The client targets runtimes that provide the standard
+[Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) and
+[Web Streams](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) APIs,
+such as modern Chrome/Firefox browsers and Cloudflare Workers.
 
-| Node.js version | Supported?  |
-| --------------- | ----------- |
-| 24.x            | ✔           |
-| 22.x            | ✔           |
-| 20.x            | ✔           |
-| 18.x            | Best effort |
-
-### TypeScript
-
-If using TypeScript, version [4.5](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html) or above is required to enable [inline import and export syntax](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#type-modifiers-on-import-names).
+If using TypeScript, version
+[4.5](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html)
+or above is required to enable
+[inline import and export syntax](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#type-modifiers-on-import-names).
 
 ## Compatibility with ClickHouse
 
@@ -80,17 +38,18 @@ If using TypeScript, version [4.5](https://www.typescriptlang.org/docs/handbook/
 | -------------- | ---------- |
 | 1.12.0+        | 24.8+      |
 
-The client may work with older versions too; however, this is best-effort support and is not guaranteed.
+The client may work with older versions too; however, this is best-effort
+support and is not guaranteed.
 
 ## Quick start
 
 ```ts
-import { createClient } from "@clickhouse/client"; // or '@clickhouse/client-web'
+import { createClient } from "@clickhouse/client-web";
 
 const client = createClient({
-  url: process.env.CLICKHOUSE_URL ?? "http://localhost:8123",
-  username: process.env.CLICKHOUSE_USER ?? "default",
-  password: process.env.CLICKHOUSE_PASSWORD ?? "",
+  url: "http://localhost:8123",
+  username: "default",
+  password: "",
 });
 
 const resultSet = await client.query({
@@ -104,41 +63,24 @@ console.log(tables);
 await client.close();
 ```
 
-See more examples in the [examples directory](./examples).
+See more examples in the
+[examples directory](https://github.com/ClickHouse/clickhouse-js/tree/main/examples).
 
 ## Documentation
 
-See the [ClickHouse website](https://clickhouse.com/docs/integrations/javascript) for the full documentation.
-
-## AI Agent Skills
-
-This repository contains agent skills for working with the client:
-
-- `clickhouse-js-node-troubleshooting` — troubleshooting playbook for the Node.js client.
-
-Install via CLI:
+See the [ClickHouse website](https://clickhouse.com/docs/integrations/javascript)
+for the full documentation.
 
-```sh
-# per project
-npx skills add ClickHouse/clickhouse-js
-# globally
-npx skills add ClickHouse/clickhouse-js -g
-```
-
-Or ask your agent to install it for you:
+## Changelog
 
-> install agent skills from ClickHouse/clickhouse-js
-
-## Usage examples
-
-We have a wide range of [examples](./examples), aiming to cover various scenarios of client usage. The overview is available in the [examples README](https://github.com/ClickHouse/clickhouse-js/blob/main/examples/README.md#overview).
+See [`CHANGELOG.md`](https://github.com/ClickHouse/clickhouse-js/blob/main/packages/client-web/CHANGELOG.md).
 
 ## Contact us
 
-If you have any questions or need help, feel free to reach out to us in the [Community Slack](https://clickhouse.com/slack) (`#clickhouse-js` channel) or via [GitHub issues](https://github.com/ClickHouse/clickhouse-js/issues).
-
-## Contributing
+If you have any questions or need help, feel free to reach out to us in the
+[Community Slack](https://clickhouse.com/slack) (`#clickhouse-js` channel) or
+via [GitHub issues](https://github.com/ClickHouse/clickhouse-js/issues).
 
-Check out our [contributing guide](./CONTRIBUTING.md).
+## License
 
-If you'd like to build a client for an alternative runtime (such as Bun or Cloudflare Workers) or an alternative protocol (such as the native ClickHouse protocol or gRPC over a proxy), see [Building specialized clients for alternative runtimes and protocols](./ALTERNATIVE_CLIENTS.md).
+[Apache 2.0](https://github.com/ClickHouse/clickhouse-js/blob/main/LICENSE)

package/dist/index.d.ts

@@ -12,7 +12,7 @@ export { type BaseClickHouseClientConfigOptions, type BaseQueryParams, type Quer
  * applied to them in `./common/index` are NOT propagated to consumers of this package.
  * Importing these values from `@clickhouse/client-web` is the recommended, non-deprecated path.
  */
-import { ClickHouseError as ClickHouseError_, parseError as parseError_, ClickHouseLogLevel as ClickHouseLogLevel_, SettingsMap as SettingsMap_, parseColumnType as parseColumnType_, isProgressRow as isProgressRow_, isRow as isRow_, isException as isException_, TupleParam as TupleParam_ } from "./common/index";
+import { ClickHouseError as ClickHouseError_, parseError as parseError_, ClickHouseLogLevel as ClickHouseLogLevel_, SettingsMap as SettingsMap_, parseColumnType as parseColumnType_, isProgressRow as isProgressRow_, isRow as isRow_, isException as isException_, TupleParam as TupleParam_, extractErrorAtTheEndOfChunk as extractErrorAtTheEndOfChunk_ } from "./common/index";
 export declare const ClickHouseError: typeof ClickHouseError_;
 export type ClickHouseError = ClickHouseError_;
 export declare const parseError: typeof parseError_;
@@ -69,3 +69,5 @@ export declare const ClickHouseSpanKind: {
     readonly CONSUMER: 4;
 };
 export declare const defaultJSONHandling: import("./common/index").JSONHandling;
+export declare const EXCEPTION_TAG_HEADER_NAME = "x-clickhouse-exception-tag";
+export declare const extractErrorAtTheEndOfChunk: typeof extractErrorAtTheEndOfChunk_;

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultJSONHandling = exports.ClickHouseSpanKind = exports.ClickHouseSpanStatusCode = exports.ClickHouseSpanNames = exports.TupleParam = exports.isException = exports.isRow = exports.isProgressRow = exports.SimpleColumnTypes = exports.parseColumnType = exports.RecordsJSONFormats = exports.SingleDocumentJSONFormats = exports.StreamableJSONFormats = exports.StreamableFormats = exports.SupportedRawFormats = exports.SupportedJSONFormats = exports.SettingsMap = exports.ClickHouseLogLevel = exports.parseError = exports.ClickHouseError = exports.ResultSet = exports.createClient = void 0;
+exports.extractErrorAtTheEndOfChunk = exports.EXCEPTION_TAG_HEADER_NAME = exports.defaultJSONHandling = exports.ClickHouseSpanKind = exports.ClickHouseSpanStatusCode = exports.ClickHouseSpanNames = exports.TupleParam = exports.isException = exports.isRow = exports.isProgressRow = exports.SimpleColumnTypes = exports.parseColumnType = exports.RecordsJSONFormats = exports.SingleDocumentJSONFormats = exports.StreamableJSONFormats = exports.StreamableFormats = exports.SupportedRawFormats = exports.SupportedJSONFormats = exports.SettingsMap = exports.ClickHouseLogLevel = exports.parseError = exports.ClickHouseError = exports.ResultSet = exports.createClient = void 0;
 var client_1 = require("./client");
 Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_1.createClient; } });
 var result_set_1 = require("./result_set");
@@ -36,4 +36,6 @@ exports.ClickHouseSpanNames = index_1.ClickHouseSpanNames;
 exports.ClickHouseSpanStatusCode = index_1.ClickHouseSpanStatusCode;
 exports.ClickHouseSpanKind = index_1.ClickHouseSpanKind;
 exports.defaultJSONHandling = index_1.defaultJSONHandling;
+exports.EXCEPTION_TAG_HEADER_NAME = index_1.EXCEPTION_TAG_HEADER_NAME;
+exports.extractErrorAtTheEndOfChunk = index_1.extractErrorAtTheEndOfChunk;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAIA,mCAAwC;AAA/B,sGAAA,YAAY,OAAA;AAErB,2CAAyC;AAAhC,uGAAA,SAAS,OAAA;AA2DlB;;;;;;;GAOG;AACH,0CAqBwB;AAEX,QAAA,eAAe,GAAG,uBAAgB,CAAC;AAEnC,QAAA,UAAU,GAAG,kBAAW,CAAC;AACzB,QAAA,kBAAkB,GAAG,0BAAmB,CAAC;AAEzC,QAAA,WAAW,GAAG,mBAAY,CAAC;AAE3B,QAAA,oBAAoB,GAAG,4BAAqB,CAAC;AAC7C,QAAA,mBAAmB,GAAG,2BAAoB,CAAC;AAC3C,QAAA,iBAAiB,GAAG,yBAAkB,CAAC;AACvC,QAAA,qBAAqB,GAAG,6BAAsB,CAAC;AAC/C,QAAA,yBAAyB,GAAG,iCAA0B,CAAC;AACvD,QAAA,kBAAkB,GAAG,0BAAmB,CAAC;AACtD,4JAA4J;AAC/I,QAAA,eAAe,GAAG,uBAAgB,CAAC;AAChD,4JAA4J;AAC/I,QAAA,iBAAiB,GAAG,yBAAkB,CAAC;AACvC,QAAA,aAAa,GAAG,qBAAc,CAAC;AAC/B,QAAA,KAAK,GAAG,aAAM,CAAC;AACf,QAAA,WAAW,GAAG,mBAAY,CAAC;AAC3B,QAAA,UAAU,GAAG,kBAAW,CAAC;AAEzB,QAAA,mBAAmB,GAAG,2BAAoB,CAAC;AAC3C,QAAA,wBAAwB,GAAG,gCAAyB,CAAC;AACrD,QAAA,kBAAkB,GAAG,0BAAmB,CAAC;AACzC,QAAA,mBAAmB,GAAG,2BAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAIA,mCAAwC;AAA/B,sGAAA,YAAY,OAAA;AAErB,2CAAyC;AAAhC,uGAAA,SAAS,OAAA;AA2DlB;;;;;;;GAOG;AACH,0CAuBwB;AAEX,QAAA,eAAe,GAAG,uBAAgB,CAAC;AAEnC,QAAA,UAAU,GAAG,kBAAW,CAAC;AACzB,QAAA,kBAAkB,GAAG,0BAAmB,CAAC;AAEzC,QAAA,WAAW,GAAG,mBAAY,CAAC;AAE3B,QAAA,oBAAoB,GAAG,4BAAqB,CAAC;AAC7C,QAAA,mBAAmB,GAAG,2BAAoB,CAAC;AAC3C,QAAA,iBAAiB,GAAG,yBAAkB,CAAC;AACvC,QAAA,qBAAqB,GAAG,6BAAsB,CAAC;AAC/C,QAAA,yBAAyB,GAAG,iCAA0B,CAAC;AACvD,QAAA,kBAAkB,GAAG,0BAAmB,CAAC;AACtD,4JAA4J;AAC/I,QAAA,eAAe,GAAG,uBAAgB,CAAC;AAChD,4JAA4J;AAC/I,QAAA,iBAAiB,GAAG,yBAAkB,CAAC;AACvC,QAAA,aAAa,GAAG,qBAAc,CAAC;AAC/B,QAAA,KAAK,GAAG,aAAM,CAAC;AACf,QAAA,WAAW,GAAG,mBAAY,CAAC;AAC3B,QAAA,UAAU,GAAG,kBAAW,CAAC;AAEzB,QAAA,mBAAmB,GAAG,2BAAoB,CAAC;AAC3C,QAAA,wBAAwB,GAAG,gCAAyB,CAAC;AACrD,QAAA,kBAAkB,GAAG,0BAAmB,CAAC;AACzC,QAAA,mBAAmB,GAAG,2BAAoB,CAAC;AAC3C,QAAA,yBAAyB,GAAG,iCAA0B,CAAC;AACvD,QAAA,2BAA2B,GAAG,mCAA4B,CAAC"}

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.23.0-head.287977a.1";
+declare const _default: "1.23.0-head.71b2e8a.1";
 export default _default;

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = "1.23.0-head.287977a.1";
+exports.default = "1.23.0-head.71b2e8a.1";
 //# sourceMappingURL=version.js.map

package/package.json

@@ -2,7 +2,7 @@
   "name": "@clickhouse/client-web",
   "description": "Official JS client for ClickHouse DB - Web API implementation",
   "homepage": "https://clickhouse.com",
-  "version": "1.23.0-head.287977a.1",
+  "version": "1.23.0-head.71b2e8a.1",
   "license": "Apache-2.0",
   "keywords": [
     "clickhouse",
@@ -15,7 +15,8 @@
   },
   "private": false,
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "exports": {
     "types": "./dist/index.d.ts",
@@ -24,11 +25,19 @@
   },
   "scripts": {
     "pack": "npm pack",
-    "prepack": "cp ../../README.md ../../LICENSE .",
+    "prepack": "cp ../../LICENSE .",
     "typecheck": "tsc --noEmit",
     "lint": "eslint --max-warnings=0 .",
     "lint:fix": "eslint . --fix",
-    "build": "rm -rf dist; tsc"
+    "build": "rm -rf dist; tsc",
+    "test:unit": "CLICKHOUSE_TEST_SKIP_INIT=1 TEST_MODE=unit vitest",
+    "test:integration": "TEST_MODE=integration vitest",
+    "test:integration:dist": "npm --prefix ../.. run build && TEST_TARGET=dist TEST_MODE=integration vitest",
+    "test:integration:local_cluster": "CLICKHOUSE_TEST_ENVIRONMENT=local_cluster TEST_MODE=integration vitest",
+    "test:integration:cloud": "CLICKHOUSE_TEST_ENVIRONMENT=cloud TEST_MODE=integration vitest",
+    "test:integration:cloud:jwt": "CLICKHOUSE_TEST_ENVIRONMENT=cloud TEST_MODE=jwt vitest",
+    "test:all": "TEST_MODE=all vitest",
+    "test:coverage": "VITEST_COVERAGE=true TEST_MODE=all vitest"
   },
   "dependencies": {}
 }