@clickhouse/client-web 1.19.0 → 1.20.0-head.97f135e.1

package/README.md

@@ -12,8 +12,12 @@
 <img alt="NPM Downloads" src="https://img.shields.io/npm/dw/%40clickhouse%2Fclient?color=%233178C6&logo=npm">
 </a>
 
-<a href="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests.yml">
-<img src="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests.yml/badge.svg?branch=main">
+<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>
+
+<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">
@@ -135,3 +139,5 @@ If you have any questions or need help, feel free to reach out to us in the [Com
 ## Contributing
 
 Check out our [contributing guide](./CONTRIBUTING.md).
+
+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).

package/dist/index.d.ts

@@ -3,4 +3,34 @@ export { createClient } from './client';
 export { type WebClickHouseClientConfigOptions as ClickHouseClientConfigOptions } from './config';
 export { ResultSet } from './result_set';
 /** Re-export @clickhouse/client-common types */
-export { type BaseClickHouseClientConfigOptions, type BaseQueryParams, type QueryParams, type ExecParams, type InsertParams, type InsertValues, type CommandParams, type CommandResult, type ExecResult, type InsertResult, type DataFormat, type RawDataFormat, type JSONDataFormat, type StreamableDataFormat, type StreamableJSONDataFormat, type SingleDocumentJSONFormat, type Logger, type LogParams, type ErrorLogParams, type WarnLogParams, type ClickHouseSettings, type MergeTreeSettings, type Row, type ResponseJSON, type InputJSON, type InputJSONObjectEachRow, type BaseResultSet, type PingResult, type ResponseHeaders, ClickHouseError, parseError, ClickHouseLogLevel, SettingsMap, SupportedJSONFormats, SupportedRawFormats, StreamableFormats, StreamableJSONFormats, SingleDocumentJSONFormats, RecordsJSONFormats, type SimpleColumnType, type ParsedColumnSimple, type ParsedColumnEnum, type ParsedColumnFixedString, type ParsedColumnNullable, type ParsedColumnDecimal, type ParsedColumnDateTime, type ParsedColumnDateTime64, type ParsedColumnArray, type ParsedColumnTuple, type ParsedColumnMap, type ParsedColumnType, parseColumnType, SimpleColumnTypes, type ProgressRow, isProgressRow, isRow, isException, type RowOrProgress, type ClickHouseAuth, type ClickHouseJWTAuth, type ClickHouseCredentialsAuth, TupleParam, } from '@clickhouse/client-common';
+export { type BaseClickHouseClientConfigOptions, type BaseQueryParams, type QueryParams, type ExecParams, type InsertParams, type InsertValues, type CommandParams, type CommandResult, type ExecResult, type InsertResult, type DataFormat, type RawDataFormat, type JSONDataFormat, type StreamableDataFormat, type StreamableJSONDataFormat, type SingleDocumentJSONFormat, type Logger, type LogParams, type ErrorLogParams, type WarnLogParams, type ClickHouseSettings, type MergeTreeSettings, type Row, type ResponseJSON, type InputJSON, type InputJSONObjectEachRow, type BaseResultSet, type PingResult, type ResponseHeaders, type SimpleColumnType, type ParsedColumnSimple, type ParsedColumnEnum, type ParsedColumnFixedString, type ParsedColumnNullable, type ParsedColumnDecimal, type ParsedColumnDateTime, type ParsedColumnDateTime64, type ParsedColumnArray, type ParsedColumnTuple, type ParsedColumnMap, type ParsedColumnType, type ProgressRow, type RowOrProgress, type ClickHouseAuth, type ClickHouseJWTAuth, type ClickHouseCredentialsAuth, } from '@clickhouse/client-common';
+/**
+ * Re-export @clickhouse/client-common runtime values.
+ *
+ * These are intentionally re-exported through local bindings (rather than a direct
+ * `export { ... } from '@clickhouse/client-common'`) so that the `@deprecated` JSDoc tags
+ * applied to them in `@clickhouse/client-common` 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 '@clickhouse/client-common';
+export declare const ClickHouseError: typeof ClickHouseError_;
+export type ClickHouseError = ClickHouseError_;
+export declare const parseError: typeof parseError_;
+export declare const ClickHouseLogLevel: typeof ClickHouseLogLevel_;
+export type ClickHouseLogLevel = ClickHouseLogLevel_;
+export declare const SettingsMap: typeof SettingsMap_;
+export type SettingsMap = SettingsMap_;
+export declare const SupportedJSONFormats: readonly ["JSONObjectEachRow", "JSON", "JSONStrings", "JSONCompact", "JSONCompactStrings", "JSONColumnsWithMetadata", "JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes", "JSONEachRowWithProgress"];
+export declare const SupportedRawFormats: readonly ["CSV", "CSVWithNames", "CSVWithNamesAndTypes", "TabSeparated", "TabSeparatedRaw", "TabSeparatedWithNames", "TabSeparatedWithNamesAndTypes", "CustomSeparated", "CustomSeparatedWithNames", "CustomSeparatedWithNamesAndTypes", "Parquet"];
+export declare const StreamableFormats: readonly ["JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes", "JSONEachRowWithProgress", "CSV", "CSVWithNames", "CSVWithNamesAndTypes", "TabSeparated", "TabSeparatedRaw", "TabSeparatedWithNames", "TabSeparatedWithNamesAndTypes", "CustomSeparated", "CustomSeparatedWithNames", "CustomSeparatedWithNamesAndTypes", "Parquet"];
+export declare const StreamableJSONFormats: readonly ["JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes", "JSONEachRowWithProgress"];
+export declare const SingleDocumentJSONFormats: readonly ["JSON", "JSONStrings", "JSONCompact", "JSONCompactStrings", "JSONColumnsWithMetadata"];
+export declare const RecordsJSONFormats: readonly ["JSONObjectEachRow"];
+export declare const parseColumnType: typeof parseColumnType_;
+export declare const SimpleColumnTypes: readonly ["Bool", "UInt8", "Int8", "UInt16", "Int16", "UInt32", "Int32", "UInt64", "Int64", "UInt128", "Int128", "UInt256", "Int256", "Float32", "Float64", "String", "UUID", "Date", "Date32", "IPv4", "IPv6"];
+export declare const isProgressRow: typeof isProgressRow_;
+export declare const isRow: typeof isRow_;
+export declare const isException: typeof isException_;
+export declare const TupleParam: typeof TupleParam_;
+export type TupleParam = TupleParam_;
+export declare const defaultJSONHandling: import("@clickhouse/client-common").JSONHandling;

package/dist/index.js

@@ -1,26 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.defaultJSONHandling = 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");
 Object.defineProperty(exports, "ResultSet", { enumerable: true, get: function () { return result_set_1.ResultSet; } });
-/** Re-export @clickhouse/client-common types */
-var client_common_1 = require("@clickhouse/client-common");
-Object.defineProperty(exports, "ClickHouseError", { enumerable: true, get: function () { return client_common_1.ClickHouseError; } });
-Object.defineProperty(exports, "parseError", { enumerable: true, get: function () { return client_common_1.parseError; } });
-Object.defineProperty(exports, "ClickHouseLogLevel", { enumerable: true, get: function () { return client_common_1.ClickHouseLogLevel; } });
-Object.defineProperty(exports, "SettingsMap", { enumerable: true, get: function () { return client_common_1.SettingsMap; } });
-Object.defineProperty(exports, "SupportedJSONFormats", { enumerable: true, get: function () { return client_common_1.SupportedJSONFormats; } });
-Object.defineProperty(exports, "SupportedRawFormats", { enumerable: true, get: function () { return client_common_1.SupportedRawFormats; } });
-Object.defineProperty(exports, "StreamableFormats", { enumerable: true, get: function () { return client_common_1.StreamableFormats; } });
-Object.defineProperty(exports, "StreamableJSONFormats", { enumerable: true, get: function () { return client_common_1.StreamableJSONFormats; } });
-Object.defineProperty(exports, "SingleDocumentJSONFormats", { enumerable: true, get: function () { return client_common_1.SingleDocumentJSONFormats; } });
-Object.defineProperty(exports, "RecordsJSONFormats", { enumerable: true, get: function () { return client_common_1.RecordsJSONFormats; } });
-Object.defineProperty(exports, "parseColumnType", { enumerable: true, get: function () { return client_common_1.parseColumnType; } });
-Object.defineProperty(exports, "SimpleColumnTypes", { enumerable: true, get: function () { return client_common_1.SimpleColumnTypes; } });
-Object.defineProperty(exports, "isProgressRow", { enumerable: true, get: function () { return client_common_1.isProgressRow; } });
-Object.defineProperty(exports, "isRow", { enumerable: true, get: function () { return client_common_1.isRow; } });
-Object.defineProperty(exports, "isException", { enumerable: true, get: function () { return client_common_1.isException; } });
-Object.defineProperty(exports, "TupleParam", { enumerable: true, get: function () { return client_common_1.TupleParam; } });
+/**
+ * Re-export @clickhouse/client-common runtime values.
+ *
+ * These are intentionally re-exported through local bindings (rather than a direct
+ * `export { ... } from '@clickhouse/client-common'`) so that the `@deprecated` JSDoc tags
+ * applied to them in `@clickhouse/client-common` are NOT propagated to consumers of this package.
+ * Importing these values from `@clickhouse/client-web` is the recommended, non-deprecated path.
+ */
+const client_common_1 = require("@clickhouse/client-common");
+exports.ClickHouseError = client_common_1.ClickHouseError;
+exports.parseError = client_common_1.parseError;
+exports.ClickHouseLogLevel = client_common_1.ClickHouseLogLevel;
+exports.SettingsMap = client_common_1.SettingsMap;
+exports.SupportedJSONFormats = client_common_1.SupportedJSONFormats;
+exports.SupportedRawFormats = client_common_1.SupportedRawFormats;
+exports.StreamableFormats = client_common_1.StreamableFormats;
+exports.StreamableJSONFormats = client_common_1.StreamableJSONFormats;
+exports.SingleDocumentJSONFormats = client_common_1.SingleDocumentJSONFormats;
+exports.RecordsJSONFormats = client_common_1.RecordsJSONFormats;
+exports.parseColumnType = client_common_1.parseColumnType;
+exports.SimpleColumnTypes = client_common_1.SimpleColumnTypes;
+exports.isProgressRow = client_common_1.isProgressRow;
+exports.isRow = client_common_1.isRow;
+exports.isException = client_common_1.isException;
+exports.TupleParam = client_common_1.TupleParam;
+exports.defaultJSONHandling = client_common_1.defaultJSONHandling;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAIA,mCAAuC;AAA9B,sGAAA,YAAY,OAAA;AAErB,2CAAwC;AAA/B,uGAAA,SAAS,OAAA;AAElB,gDAAgD;AAChD,2DA+DkC;AAjChC,gHAAA,eAAe,OAAA;AACf,2GAAA,UAAU,OAAA;AACV,mHAAA,kBAAkB,OAAA;AAClB,4GAAA,WAAW,OAAA;AACX,qHAAA,oBAAoB,OAAA;AACpB,oHAAA,mBAAmB,OAAA;AACnB,kHAAA,iBAAiB,OAAA;AACjB,sHAAA,qBAAqB,OAAA;AACrB,0HAAA,yBAAyB,OAAA;AACzB,mHAAA,kBAAkB,OAAA;AAalB,gHAAA,eAAe,OAAA;AACf,kHAAA,iBAAiB,OAAA;AAEjB,8GAAA,aAAa,OAAA;AACb,sGAAA,KAAK,OAAA;AACL,4GAAA,WAAW,OAAA;AAKX,2GAAA,UAAU,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAIA,mCAAuC;AAA9B,sGAAA,YAAY,OAAA;AAErB,2CAAwC;AAA/B,uGAAA,SAAS,OAAA;AAoDlB;;;;;;;GAOG;AACH,6DAkBkC;AAErB,QAAA,eAAe,GAAG,+BAAgB,CAAA;AAElC,QAAA,UAAU,GAAG,0BAAW,CAAA;AACxB,QAAA,kBAAkB,GAAG,kCAAmB,CAAA;AAExC,QAAA,WAAW,GAAG,2BAAY,CAAA;AAE1B,QAAA,oBAAoB,GAAG,oCAAqB,CAAA;AAC5C,QAAA,mBAAmB,GAAG,mCAAoB,CAAA;AAC1C,QAAA,iBAAiB,GAAG,iCAAkB,CAAA;AACtC,QAAA,qBAAqB,GAAG,qCAAsB,CAAA;AAC9C,QAAA,yBAAyB,GAAG,yCAA0B,CAAA;AACtD,QAAA,kBAAkB,GAAG,kCAAmB,CAAA;AACxC,QAAA,eAAe,GAAG,+BAAgB,CAAA;AAClC,QAAA,iBAAiB,GAAG,iCAAkB,CAAA;AACtC,QAAA,aAAa,GAAG,6BAAc,CAAA;AAC9B,QAAA,KAAK,GAAG,qBAAM,CAAA;AACd,QAAA,WAAW,GAAG,2BAAY,CAAA;AAC1B,QAAA,UAAU,GAAG,0BAAW,CAAA;AAExB,QAAA,mBAAmB,GAAG,mCAAoB,CAAA"}

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.19.0";
+declare const _default: "1.20.0-head.97f135e.1";
 export default _default;

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '1.19.0';
+exports.default = '1.20.0-head.97f135e.1';
 //# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;AAAA,kBAAe,QAAQ,CAAA"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;AAAA,kBAAe,uBAAuB,CAAA"}

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.19.0",
+  "version": "1.20.0-head.97f135e.1",
   "license": "Apache-2.0",
   "keywords": [
     "clickhouse",
@@ -31,6 +31,6 @@
     "build": "rm -rf dist; tsc"
   },
   "dependencies": {
-    "@clickhouse/client-common": "1.19.0"
+    "@clickhouse/client-common": "1.20.0-head.97f135e.1"
   }
 }