@clickhouse/client-common 0.3.1 → 0.4.0

package/dist/parse/index.d.ts

@@ -0,0 +1,2 @@
+export * from './column_types';
+export * from './json_handling';

package/dist/parse/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./column_types"), exports);
+__exportStar(require("./json_handling"), exports);
+//# sourceMappingURL=index.js.map

package/dist/parse/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/parse/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA8B;AAC9B,kDAA+B"}

package/dist/parse/json_handling.d.ts

@@ -0,0 +1,19 @@
+export interface JSONHandling {
+    /**
+     * Custom parser for JSON strings
+     *
+     * @param input stringified JSON
+     * @default JSON.parse // See {@link JSON.parse}
+     * @returns parsed object
+     */
+    parse: <T>(input: string) => T;
+    /**
+     * Custom stringifier for JSON objects
+     *
+     * @param input any JSON-compatible object
+     * @default JSON.stringify // See {@link JSON.stringify}
+     * @returns stringified JSON
+     */
+    stringify: <T = any>(input: T) => string;
+}
+export declare const defaultJSONHandling: JSONHandling;

package/dist/parse/json_handling.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultJSONHandling = void 0;
+exports.defaultJSONHandling = {
+    parse: JSON.parse,
+    stringify: JSON.stringify,
+};
+//# sourceMappingURL=json_handling.js.map

package/dist/parse/json_handling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json_handling.js","sourceRoot":"","sources":["../../src/parse/json_handling.ts"],"names":[],"mappings":";;;AAmBa,QAAA,mBAAmB,GAAiB;IAC/C,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;CAC1B,CAAA"}

package/dist/result.d.ts

@@ -1,4 +1,13 @@
-export interface Row {
+import type { ProgressRow, ResponseHeaders, ResponseJSON, SpecialEventRow } from './clickhouse_types';
+import type { DataFormat, RawDataFormat, RecordsJSONFormat, SingleDocumentJSONFormat, StreamableDataFormat, StreamableJSONDataFormat } from './data_formatter';
+export type RowOrProgress<T> = {
+    row: T;
+} | ProgressRow | SpecialEventRow<T>;
+export type ResultStream<Format extends DataFormat | unknown, Stream> = Format extends StreamableDataFormat ? Stream : Format extends SingleDocumentJSONFormat ? never : Format extends RecordsJSONFormat ? never : Stream;
+export type ResultJSONType<T, F extends DataFormat | unknown> = F extends 'JSONEachRowWithProgress' ? RowOrProgress<T>[] : F extends StreamableJSONDataFormat ? T[] : F extends SingleDocumentJSONFormat ? ResponseJSON<T> : F extends RecordsJSONFormat ? Record<string, T> : F extends RawDataFormat ? never : // happens only when Format could not be inferred from a literal
+T[] | Record<string, T> | ResponseJSON<T>;
+export type RowJSONType<T, F extends DataFormat | unknown> = F extends 'JSONEachRowWithProgress' ? RowOrProgress<T> : F extends StreamableJSONDataFormat ? T : F extends RawDataFormat | SingleDocumentJSONFormat | RecordsJSONFormat ? never : T;
+export interface Row<JSONType = unknown, Format extends DataFormat | unknown = unknown> {
     /** A string representation of a row. */
     text: string;
     /**
@@ -6,13 +15,15 @@ export interface Row {
      * The method will throw if called on a response in JSON incompatible format.
      * It is safe to call this method multiple times.
      */
-    json<T>(): T;
+    json<T = JSONType>(): RowJSONType<T, Format>;
 }
-export interface BaseResultSet<Stream> {
+export interface BaseResultSet<Stream, Format extends DataFormat | unknown> {
     /**
      * The method waits for all the rows to be fully loaded
      * and returns the result as a string.
      *
+     * It is possible to call this method for all supported formats.
+     *
      * The method should throw if the underlying stream was already consumed
      * by calling the other methods.
      */
@@ -21,13 +32,44 @@ export interface BaseResultSet<Stream> {
      * The method waits for the all the rows to be fully loaded.
      * When the response is received in full, it will be decoded to return JSON.
      *
+     * Should be called only for JSON* formats family.
+     *
      * The method should throw if the underlying stream was already consumed
-     * by calling the other methods.
+     * by calling the other methods, or if it is called for non-JSON formats,
+     * such as CSV, TSV, etc.
      */
-    json<T>(): Promise<T>;
+    json<T = unknown>(): Promise<ResultJSONType<T, Format>>;
     /**
-     * Returns a readable stream for responses that can be streamed
-     * (i.e. all except JSON).
+     * Returns a readable stream for responses that can be streamed.
+     *
+     * Formats that CAN be streamed ({@link StreamableDataFormat}):
+     *   * JSONEachRow
+     *   * JSONStringsEachRow
+     *   * JSONCompactEachRow
+     *   * JSONCompactStringsEachRow
+     *   * JSONCompactEachRowWithNames
+     *   * JSONCompactEachRowWithNamesAndTypes
+     *   * JSONCompactStringsEachRowWithNames
+     *   * JSONCompactStringsEachRowWithNamesAndTypes
+     *   * CSV
+     *   * CSVWithNames
+     *   * CSVWithNamesAndTypes
+     *   * TabSeparated
+     *   * TabSeparatedRaw
+     *   * TabSeparatedWithNames
+     *   * TabSeparatedWithNamesAndTypes
+     *   * CustomSeparated
+     *   * CustomSeparatedWithNames
+     *   * CustomSeparatedWithNamesAndTypes
+     *   * Parquet
+     *
+     * Formats that CANNOT be streamed (the method returns "never" in TS):
+     *   * JSON
+     *   * JSONStrings
+     *   * JSONCompact
+     *   * JSONCompactStrings
+     *   * JSONColumnsWithMetadata
+     *   * JSONObjectEachRow
      *
      * Every iteration provides an array of {@link Row} instances
      * for {@link StreamableDataFormat} format.
@@ -38,9 +80,11 @@ export interface BaseResultSet<Stream> {
      * and if the underlying stream was already consumed
      * by calling the other methods.
      */
-    stream(): Stream;
+    stream(): ResultStream<Format, Stream>;
     /** Close the underlying stream. */
     close(): void;
     /** ClickHouse server QueryID. */
     query_id: string;
+    /** Response headers. */
+    response_headers: ResponseHeaders;
 }

package/dist/result.js.map

@@ -1 +1 @@
-{"version":3,"file":"result.js","sourceRoot":"","sources":["../../../packages/client-common/src/result.ts"],"names":[],"mappings":""}
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":""}

package/dist/settings.d.ts

@@ -72,6 +72,18 @@ interface ClickHouseServerSettings {
     allow_experimental_undrop_table_query?: Bool;
     /** Enable WINDOW VIEW. Not mature enough. */
     allow_experimental_window_view?: Bool;
+    /** Support join with inequal conditions which involve columns from both left and right table. e.g. t1.y < t2.y. */
+    allow_experimental_join_condition?: Bool;
+    /** Since ClickHouse 24.1 */
+    allow_experimental_variant_type?: Bool;
+    /** Since ClickHouse 24.5 */
+    allow_experimental_dynamic_type?: Bool;
+    /** Since ClickHouse 24.8 */
+    allow_experimental_json_type?: Bool;
+    /** Since ClickHouse 25.3 */
+    enable_json_type?: Bool;
+    /** Since ClickHouse 25.6 */
+    enable_time_time64_type?: Bool;
     /** Allow functions that use Hyperscan library. Disable to avoid potentially long compilation times and excessive resource usage. */
     allow_hyperscan?: Bool;
     /** Allow functions for introspection of ELF and DWARF for query profiling. These functions are slow and may impose security considerations. */
@@ -160,7 +172,9 @@ interface ClickHouseServerSettings {
     bool_true_representation?: string;
     /** Calculate text stack trace in case of exceptions during query execution. This is the default. It requires symbol lookups that may slow down fuzzing tests when huge amount of wrong queries are executed. In normal cases you should not disable this option. */
     calculate_text_stack_trace?: Bool;
-    /** Cancel HTTP readonly queries when a client closes the connection without waiting for response. */
+    /** Cancel HTTP readonly queries when a client closes the connection without waiting for response.
+     * @see https://clickhouse.com/docs/operations/settings/settings#cancel_http_readonly_queries_on_client_close
+     */
     cancel_http_readonly_queries_on_client_close?: Bool;
     /** CAST operator into IPv4, CAST operator into IPV6 type, toIPv4, toIPv6 functions will return default value instead of throwing exception on conversion error. */
     cast_ipv4_ipv6_default_on_conversion_error?: Bool;
@@ -614,6 +628,8 @@ interface ClickHouseServerSettings {
     input_format_json_read_numbers_as_strings?: Bool;
     /** Allow to parse JSON objects as strings in JSON input formats */
     input_format_json_read_objects_as_strings?: Bool;
+    /** Throw an exception if JSON string contains bad escape sequence. If disabled, bad escape sequences will remain as is in the data. Default value - true. */
+    input_format_json_throw_on_bad_escape_sequence?: Bool;
     /** Try to infer numbers from string fields while schema inference */
     input_format_json_try_infer_numbers_from_strings?: Bool;
     /** For JSON/JSONCompact/JSONColumnsWithMetadata input formats this controls whether format parser should check if data types from input metadata match data types of the corresponding columns from the table */
@@ -754,6 +770,8 @@ interface ClickHouseServerSettings {
     legacy_column_name_of_tuple_literal?: Bool;
     /** Limit on read rows from the most 'end' result for select query, default 0 means no limit length */
     limit?: UInt64;
+    /** Controls the synchronicity of lightweight DELETE operations. It determines whether a DELETE statement will wait for the operation to complete before returning to the client. */
+    lightweight_deletes_sync?: UInt64;
     /** The heartbeat interval in seconds to indicate live query is alive. */
     live_view_heartbeat_interval?: Seconds;
     /** Which replicas (among healthy replicas) to preferably send a query to (on the first attempt) for distributed processing. */
@@ -1573,11 +1591,29 @@ interface ClickHouseServerSettings {
     /** Allows you to select the max window log of ZSTD (it will not be used for MergeTree family) */
     zstd_window_log_max?: Int64;
 }
+/** @see https://clickhouse.com/docs/en/interfaces/http */
 interface ClickHouseHTTPSettings {
+    /** Ensures that the entire response is buffered.
+     *  In this case, the data that is not stored in memory will be buffered in a temporary server file.
+     *  This could help prevent errors that might occur during the streaming of SELECT queries.
+     *  Additionally, this is useful when executing DDLs on clustered environments,
+     *  as the client will receive the response only when the DDL is applied on all nodes of the cluster. */
     wait_end_of_query: Bool;
+    /** Format to use if a SELECT query is executed without a FORMAT clause.
+     *  Only useful for the {@link ClickHouseClient.exec} method,
+     *  as {@link ClickHouseClient.query} method always attaches this clause. */
     default_format: DataFormat;
+    /** By default, the session is terminated after 60 seconds of inactivity
+     *  This is regulated by the `default_session_timeout` server setting. */
+    session_timeout: UInt64;
+    /** You can use this setting to check the session status before executing the query.
+     *  If a session is expired or cannot be found, the server returns `SESSION_NOT_FOUND` with error code 372.
+     *  NB: the session mechanism is only reliable when you connect directly to a particular ClickHouse server node.
+     *  Due to each particular session not being shared across the cluster, sessions won't work well in a multi-node environment with a load balancer,
+     *  as there will be no guarantee that each consequent request will be received on the same node. */
+    session_check: Bool;
 }
-export type ClickHouseSettings = Partial<ClickHouseServerSettings> & Partial<ClickHouseHTTPSettings>;
+export type ClickHouseSettings = Partial<ClickHouseServerSettings> & Partial<ClickHouseHTTPSettings> & Record<string, number | string | boolean | SettingsMap | undefined>;
 export interface MergeTreeSettings {
     /** Allow floating point as partition key */
     allow_floating_point_partition_key?: Bool;

package/dist/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../../packages/client-common/src/settings.ts"],"names":[],"mappings":";;;AAq3DA,MAAa,WAAW;IACtB,YAAqC,MAA8B;;;;;mBAA9B;;IAAiC,CAAC;IAEvE,QAAQ;QACN,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;aACnC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;aAChC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAA;IACjB,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,MAA8B;QACxC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,CAAA;IACzB,CAAC;CACF;AAZD,kCAYC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AA25DA,MAAa,WAAW;IACtB,YAAqC,MAA8B;QAA/C;;;;mBAAiB,MAAM;WAAwB;IAAG,CAAC;IAEvE,QAAQ;QACN,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;aACnC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;aAChC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAA;IACjB,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,MAA8B;QACxC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,CAAA;IACzB,CAAC;CACF;AAZD,kCAYC"}

package/dist/ts_utils.d.ts

@@ -0,0 +1,4 @@
+/** Adjusted from https://stackoverflow.com/a/72801672/4575540.
+ *  Useful for checking if we could not infer a concrete literal type
+ *  (i.e. if instead of 'JSONEachRow' or other literal we just get a generic {@link DataFormat} as an argument). */
+export type IsSame<A, B> = [A] extends [B] ? B extends A ? true : false : false;

package/dist/ts_utils.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ts_utils.js.map

package/dist/ts_utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts_utils.js","sourceRoot":"","sources":["../src/ts_utils.ts"],"names":[],"mappings":""}

package/dist/utils/connection.d.ts

@@ -1,10 +1,18 @@
 import type { ClickHouseSettings } from '../settings';
 export type HttpHeader = number | string | string[];
 export type HttpHeaders = Record<string, HttpHeader | undefined>;
-export declare function withCompressionHeaders({ headers, compress_request, decompress_response, }: {
+export declare function withCompressionHeaders({ headers, enable_request_compression, enable_response_compression, }: {
     headers: HttpHeaders;
-    compress_request: boolean | undefined;
-    decompress_response: boolean | undefined;
+    enable_request_compression: boolean | undefined;
+    enable_response_compression: boolean | undefined;
 }): Record<string, string>;
 export declare function withHttpSettings(clickhouse_settings?: ClickHouseSettings, compression?: boolean): ClickHouseSettings;
 export declare function isSuccessfulResponse(statusCode?: number): boolean;
+export declare function isJWTAuth(auth: unknown): auth is {
+    access_token: string;
+};
+export declare function isCredentialsAuth(auth: unknown): auth is {
+    username: string;
+    password: string;
+};
+export declare const EXCEPTION_TAG_HEADER_NAME = "x-clickhouse-exception-tag";

package/dist/utils/connection.js

@@ -1,14 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSuccessfulResponse = exports.withHttpSettings = exports.withCompressionHeaders = void 0;
-function withCompressionHeaders({ headers, compress_request, decompress_response, }) {
+exports.EXCEPTION_TAG_HEADER_NAME = void 0;
+exports.withCompressionHeaders = withCompressionHeaders;
+exports.withHttpSettings = withHttpSettings;
+exports.isSuccessfulResponse = isSuccessfulResponse;
+exports.isJWTAuth = isJWTAuth;
+exports.isCredentialsAuth = isCredentialsAuth;
+function withCompressionHeaders({ headers, enable_request_compression, enable_response_compression, }) {
     return {
         ...headers,
-        ...(decompress_response ? { 'Accept-Encoding': 'gzip' } : {}),
-        ...(compress_request ? { 'Content-Encoding': 'gzip' } : {}),
+        ...(enable_response_compression ? { 'Accept-Encoding': 'gzip' } : {}),
+        ...(enable_request_compression ? { 'Content-Encoding': 'gzip' } : {}),
     };
 }
-exports.withCompressionHeaders = withCompressionHeaders;
 function withHttpSettings(clickhouse_settings, compression) {
     return {
         ...(compression
@@ -19,9 +23,17 @@ function withHttpSettings(clickhouse_settings, compression) {
         ...clickhouse_settings,
     };
 }
-exports.withHttpSettings = withHttpSettings;
 function isSuccessfulResponse(statusCode) {
     return Boolean(statusCode && 200 <= statusCode && statusCode < 300);
 }
-exports.isSuccessfulResponse = isSuccessfulResponse;
+function isJWTAuth(auth) {
+    return auth !== null && typeof auth === 'object' && 'access_token' in auth;
+}
+function isCredentialsAuth(auth) {
+    return (auth !== null &&
+        typeof auth === 'object' &&
+        'username' in auth &&
+        'password' in auth);
+}
+exports.EXCEPTION_TAG_HEADER_NAME = 'x-clickhouse-exception-tag';
 //# sourceMappingURL=connection.js.map

package/dist/utils/connection.js.map

@@ -1 +1 @@
-{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../../../packages/client-common/src/utils/connection.ts"],"names":[],"mappings":";;;AAKA,SAAgB,sBAAsB,CAAC,EACrC,OAAO,EACP,gBAAgB,EAChB,mBAAmB,GAKpB;IACC,OAAO;QACL,GAAG,OAAO;QACV,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5D,CAAA;AACH,CAAC;AAdD,wDAcC;AAED,SAAgB,gBAAgB,CAC9B,mBAAwC,EACxC,WAAqB;IAErB,OAAO;QACL,GAAG,CAAC,WAAW;YACb,CAAC,CAAC;gBACE,uBAAuB,EAAE,CAAC;aAC3B;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,mBAAmB;KACvB,CAAA;AACH,CAAC;AAZD,4CAYC;AAED,SAAgB,oBAAoB,CAAC,UAAmB;IACtD,OAAO,OAAO,CAAC,UAAU,IAAI,GAAG,IAAI,UAAU,IAAI,UAAU,GAAG,GAAG,CAAC,CAAA;AACrE,CAAC;AAFD,oDAEC"}
+{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../src/utils/connection.ts"],"names":[],"mappings":";;;AAKA,wDAcC;AAED,4CAYC;AAED,oDAEC;AAED,8BAEC;AAED,8CASC;AA/CD,SAAgB,sBAAsB,CAAC,EACrC,OAAO,EACP,0BAA0B,EAC1B,2BAA2B,GAK5B;IACC,OAAO;QACL,GAAG,OAAO;QACV,GAAG,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrE,GAAG,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtE,CAAA;AACH,CAAC;AAED,SAAgB,gBAAgB,CAC9B,mBAAwC,EACxC,WAAqB;IAErB,OAAO;QACL,GAAG,CAAC,WAAW;YACb,CAAC,CAAC;gBACE,uBAAuB,EAAE,CAAC;aAC3B;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,mBAAmB;KACvB,CAAA;AACH,CAAC;AAED,SAAgB,oBAAoB,CAAC,UAAmB;IACtD,OAAO,OAAO,CAAC,UAAU,IAAI,GAAG,IAAI,UAAU,IAAI,UAAU,GAAG,GAAG,CAAC,CAAA;AACrE,CAAC;AAED,SAAgB,SAAS,CAAC,IAAa;IACrC,OAAO,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,cAAc,IAAI,IAAI,CAAA;AAC5E,CAAC;AAED,SAAgB,iBAAiB,CAC/B,IAAa;IAEb,OAAO,CACL,IAAI,KAAK,IAAI;QACb,OAAO,IAAI,KAAK,QAAQ;QACxB,UAAU,IAAI,IAAI;QAClB,UAAU,IAAI,IAAI,CACnB,CAAA;AACH,CAAC;AAEY,QAAA,yBAAyB,GAAG,4BAA4B,CAAA"}

package/dist/utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from './connection';
+export * from './sleep';
+export * from './stream';
 export * from './url';
-export * from './permutations';

package/dist/utils/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./connection"), exports);
+__exportStar(require("./sleep"), exports);
+__exportStar(require("./stream"), exports);
 __exportStar(require("./url"), exports);
-__exportStar(require("./permutations"), exports);
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/client-common/src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA4B;AAC5B,wCAAqB;AACrB,iDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA4B;AAC5B,0CAAuB;AACvB,2CAAwB;AACxB,wCAAqB"}

package/dist/utils/sleep.d.ts

@@ -0,0 +1 @@
+export declare function sleep(ms: number): Promise<void>;

package/dist/utils/sleep.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = sleep;
+async function sleep(ms) {
+    await new Promise((resolve) => setTimeout(() => {
+        resolve(void 0);
+    }, ms));
+}
+//# sourceMappingURL=sleep.js.map

package/dist/utils/sleep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../../src/utils/sleep.ts"],"names":[],"mappings":";;AAAA,sBAMC;AANM,KAAK,UAAU,KAAK,CAAC,EAAU;IACpC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC5B,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;IACjB,CAAC,EAAE,EAAE,CAAC,CACP,CAAA;AACH,CAAC"}

package/dist/utils/stream.d.ts

@@ -0,0 +1,14 @@
+/**
+ * After 25.11, a newline error character is preceded by a caret return
+ * this is a strong indication that we have an exception in the stream.
+ *
+ * Example with exception marker `FOOBAR`:
+ *
+ * \r\n__exception__\r\nFOOBAR
+ * boom
+ * 5 FOOBAR\r\n__exception__\r\n
+ *
+ * In this case, the exception length is 5 (including the newline character),
+ * and the exception message is "boom".
+ */
+export declare function checkErrorInChunkAtIndex(chunk: Uint8Array, newLineIdx: number, exceptionTag: string | undefined): Error | undefined;

package/dist/utils/stream.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkErrorInChunkAtIndex = checkErrorInChunkAtIndex;
+const error_1 = require("../error");
+const EXCEPTION_MARKER = '__exception__';
+const NEWLINE = 0x0a;
+const CARET_RETURN = 0x0d;
+/**
+ * After 25.11, a newline error character is preceded by a caret return
+ * this is a strong indication that we have an exception in the stream.
+ *
+ * Example with exception marker `FOOBAR`:
+ *
+ * \r\n__exception__\r\nFOOBAR
+ * boom
+ * 5 FOOBAR\r\n__exception__\r\n
+ *
+ * In this case, the exception length is 5 (including the newline character),
+ * and the exception message is "boom".
+ */
+function checkErrorInChunkAtIndex(chunk, newLineIdx, exceptionTag) {
+    if (newLineIdx > 0 &&
+        chunk[newLineIdx - 1] === CARET_RETURN &&
+        exceptionTag !== undefined) {
+        try {
+            const textDecoder = new TextDecoder('utf-8');
+            const bytesCountAfterErrLenHint = 1 + // space
+                EXCEPTION_MARKER.length + // __exception__
+                2 + // \r\n
+                exceptionTag.length + // <value taken from the header>
+                2; // \r\n
+            let errMsgLenStartIdx = chunk.length - bytesCountAfterErrLenHint;
+            if (errMsgLenStartIdx < 1) {
+                return new Error('there was an error in the stream, but the last chunk is malformed');
+            }
+            do {
+                --errMsgLenStartIdx;
+            } while (chunk[errMsgLenStartIdx] !== NEWLINE);
+            const errMsgLen = parseInt(textDecoder.decode(chunk.subarray(errMsgLenStartIdx, -bytesCountAfterErrLenHint)));
+            if (isNaN(errMsgLen) || errMsgLen <= 0) {
+                return new Error('there was an error in the stream; failed to parse the message length');
+            }
+            const errMsg = textDecoder.decode(chunk.subarray(errMsgLenStartIdx - errMsgLen + 1, // skipping the newline character
+            errMsgLenStartIdx));
+            return (0, error_1.parseError)(errMsg);
+        }
+        catch (err) {
+            // theoretically, it can happen if a proxy cuts the last chunk
+            return err;
+        }
+    }
+}
+//# sourceMappingURL=stream.js.map

package/dist/utils/stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../src/utils/stream.ts"],"names":[],"mappings":";;AAoBA,4DAwDC;AA5ED,oCAAqC;AAErC,MAAM,gBAAgB,GAAG,eAAe,CAAA;AAExC,MAAM,OAAO,GAAG,IAAa,CAAA;AAC7B,MAAM,YAAY,GAAG,IAAa,CAAA;AAElC;;;;;;;;;;;;GAYG;AACH,SAAgB,wBAAwB,CACtC,KAAiB,EACjB,UAAkB,EAClB,YAAgC;IAEhC,IACE,UAAU,GAAG,CAAC;QACd,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,KAAK,YAAY;QACtC,YAAY,KAAK,SAAS,EAC1B,CAAC;QACD,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAA;YAE5C,MAAM,yBAAyB,GAC7B,CAAC,GAAG,QAAQ;gBACZ,gBAAgB,CAAC,MAAM,GAAG,gBAAgB;gBAC1C,CAAC,GAAG,OAAO;gBACX,YAAY,CAAC,MAAM,GAAG,gCAAgC;gBACtD,CAAC,CAAA,CAAC,OAAO;YAEX,IAAI,iBAAiB,GAAG,KAAK,CAAC,MAAM,GAAG,yBAAyB,CAAA;YAChE,IAAI,iBAAiB,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,IAAI,KAAK,CACd,mEAAmE,CACpE,CAAA;YACH,CAAC;YAED,GAAG,CAAC;gBACF,EAAE,iBAAiB,CAAA;YACrB,CAAC,QAAQ,KAAK,CAAC,iBAAiB,CAAC,KAAK,OAAO,EAAC;YAE9C,MAAM,SAAS,GAAG,QAAQ,CACxB,WAAW,CAAC,MAAM,CAChB,KAAK,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC,yBAAyB,CAAC,CAC9D,CACF,CAAA;YAED,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;gBACvC,OAAO,IAAI,KAAK,CACd,sEAAsE,CACvE,CAAA;YACH,CAAC;YAED,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAC/B,KAAK,CAAC,QAAQ,CACZ,iBAAiB,GAAG,SAAS,GAAG,CAAC,EAAE,iCAAiC;YACpE,iBAAiB,CAClB,CACF,CAAA;YAED,OAAO,IAAA,kBAAU,EAAC,MAAM,CAAC,CAAA;QAC3B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,8DAA8D;YAC9D,OAAO,GAAY,CAAA;QACrB,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/utils/url.d.ts

@@ -4,13 +4,14 @@ export declare function transformUrl({ url, pathname, searchParams, }: {
     pathname?: string;
     searchParams?: URLSearchParams;
 }): URL;
-type ToSearchParamsOptions = {
-    database: string;
+interface ToSearchParamsOptions {
+    database: string | undefined;
     clickhouse_settings?: ClickHouseSettings;
     query_params?: Record<string, unknown>;
     query?: string;
     session_id?: string;
     query_id: string;
-};
-export declare function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, query_id, }: ToSearchParamsOptions): URLSearchParams;
+    role?: string | Array<string>;
+}
+export declare function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, query_id, role, }: ToSearchParamsOptions): URLSearchParams;
 export {};

package/dist/utils/url.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toSearchParams = exports.transformUrl = void 0;
+exports.transformUrl = transformUrl;
+exports.toSearchParams = toSearchParams;
 const data_formatter_1 = require("../data_formatter");
 function transformUrl({ url, pathname, searchParams, }) {
     const newUrl = new URL(url);
@@ -20,34 +21,42 @@ function transformUrl({ url, pathname, searchParams, }) {
     }
     return newUrl;
 }
-exports.transformUrl = transformUrl;
 // TODO validate max length of the resulting query
 // https://stackoverflow.com/questions/812925/what-is-the-maximum-possible-length-of-a-query-string
-function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, query_id, }) {
-    const params = new URLSearchParams();
-    params.set('query_id', query_id);
+function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, query_id, role, }) {
+    const entries = [['query_id', query_id]];
     if (query_params !== undefined) {
         for (const [key, value] of Object.entries(query_params)) {
-            params.set(`param_${key}`, (0, data_formatter_1.formatQueryParams)(value));
+            const formattedParam = (0, data_formatter_1.formatQueryParams)({ value });
+            entries.push([`param_${key}`, formattedParam]);
         }
     }
     if (clickhouse_settings !== undefined) {
         for (const [key, value] of Object.entries(clickhouse_settings)) {
             if (value !== undefined) {
-                params.set(key, (0, data_formatter_1.formatQuerySettings)(value));
+                entries.push([key, (0, data_formatter_1.formatQuerySettings)(value)]);
             }
         }
     }
-    if (database !== 'default') {
-        params.set('database', database);
+    if (database !== undefined && database !== 'default') {
+        entries.push(['database', database]);
     }
     if (query) {
-        params.set('query', query);
+        entries.push(['query', query]);
     }
     if (session_id) {
-        params.set('session_id', session_id);
+        entries.push(['session_id', session_id]);
+    }
+    if (role) {
+        if (typeof role === 'string') {
+            entries.push(['role', role]);
+        }
+        else if (Array.isArray(role)) {
+            for (const r of role) {
+                entries.push(['role', r]);
+            }
+        }
     }
-    return params;
+    return new URLSearchParams(entries);
 }
-exports.toSearchParams = toSearchParams;
 //# sourceMappingURL=url.js.map

package/dist/utils/url.js.map

@@ -1 +1 @@
-{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../../packages/client-common/src/utils/url.ts"],"names":[],"mappings":";;;AAAA,sDAA0E;AAG1E,SAAgB,YAAY,CAAC,EAC3B,GAAG,EACH,QAAQ,EACR,YAAY,GAKb;IACC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;IAE3B,IAAI,QAAQ,EAAE;QACZ,oEAAoE;QACpE,wEAAwE;QACxE,2DAA2D;QAC3D,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG,EAAE;YAC3B,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAA;SAC3B;aAAM;YACL,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAA;SAC5B;KACF;IAED,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,MAAM,GAAG,YAAY,EAAE,QAAQ,EAAE,CAAA;KACzC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AA3BD,oCA2BC;AAWD,kDAAkD;AAClD,mGAAmG;AACnG,SAAgB,cAAc,CAAC,EAC7B,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,QAAQ,GACc;IACtB,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;IACpC,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IAEhC,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YACvD,MAAM,CAAC,GAAG,CAAC,SAAS,GAAG,EAAE,EAAE,IAAA,kCAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;SACrD;KACF;IAED,IAAI,mBAAmB,KAAK,SAAS,EAAE;QACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE;YAC9D,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAA,oCAAmB,EAAC,KAAK,CAAC,CAAC,CAAA;aAC5C;SACF;KACF;IAED,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;KACjC;IAED,IAAI,KAAK,EAAE;QACT,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;KAC3B;IAED,IAAI,UAAU,EAAE;QACd,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,CAAA;KACrC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAtCD,wCAsCC"}
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../src/utils/url.ts"],"names":[],"mappings":";;AAGA,oCA2BC;AAcD,wCAiDC;AA7FD,sDAA0E;AAG1E,SAAgB,YAAY,CAAC,EAC3B,GAAG,EACH,QAAQ,EACR,YAAY,GAKb;IACC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;IAE3B,IAAI,QAAQ,EAAE,CAAC;QACb,oEAAoE;QACpE,wEAAwE;QACxE,2DAA2D;QAC3D,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAA;QAC5B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAA;QAC7B,CAAC;IACH,CAAC;IAED,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,CAAC,MAAM,GAAG,YAAY,EAAE,QAAQ,EAAE,CAAA;IAC1C,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAYD,kDAAkD;AAClD,mGAAmG;AACnG,SAAgB,cAAc,CAAC,EAC7B,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,QAAQ,EACR,IAAI,GACkB;IACtB,MAAM,OAAO,GAAuB,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAA;IAE5D,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,MAAM,cAAc,GAAG,IAAA,kCAAiB,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;YACnD,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAA;QAChD,CAAC;IACH,CAAC;IAED,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;QACtC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC/D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,IAAA,oCAAmB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACjD,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACrD,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAA;IACtC,CAAC;IAED,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;IAChC,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAA;IAC1C,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;QAC9B,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;gBACrB,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAA;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,CAAA;AACrC,CAAC"}

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "0.3.1";
+declare const _default: "1.15.0";
 export default _default;

package/dist/version.js

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

package/dist/version.js.map

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

package/package.json

@@ -2,7 +2,7 @@
   "name": "@clickhouse/client-common",
   "description": "Official JS client for ClickHouse DB - common types",
   "homepage": "https://clickhouse.com",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "license": "Apache-2.0",
   "keywords": [
     "clickhouse",
@@ -11,7 +11,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/ClickHouse/clickhouse-js.git"
+    "url": "git+https://github.com/ClickHouse/clickhouse-js.git"
   },
   "private": false,
   "main": "dist/index.js",
@@ -19,6 +19,10 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "prepack": "cp ../../README.md ../../LICENSE .",
+    "build": "rm -rf dist; tsc"
+  },
   "dependencies": {},
   "devDependencies": {}
 }

package/dist/error/parse_error.d.ts

@@ -1,12 +0,0 @@
-interface ParsedClickHouseError {
-    message: string;
-    code: string;
-    type?: string;
-}
-export declare class ClickHouseError extends Error {
-    readonly code: string;
-    readonly type: string | undefined;
-    constructor({ message, code, type }: ParsedClickHouseError);
-}
-export declare function parseError(input: string | Error): ClickHouseError | Error;
-export {};