@clickhouse/client 0.3.0 → 0.4.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016-2023 ClickHouse, Inc.
+Copyright 2016-2024 ClickHouse, Inc.
 
                                  Apache License
                            Version 2.0, January 2004
@@ -188,7 +188,7 @@ Copyright 2016-2023 ClickHouse, Inc.
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2016-2023 ClickHouse, Inc.
+   Copyright 2016-2024 ClickHouse, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -4,9 +4,23 @@
 </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>
+
+<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>
+
 <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>
+
+<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

package/dist/client.d.ts

@@ -1,29 +1,14 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type { BaseClickHouseClientConfigOptions, Connection } from '@clickhouse/client-common';
+import type { DataFormat, IsSame, QueryParamsWithFormat } from '@clickhouse/client-common';
 import { ClickHouseClient } from '@clickhouse/client-common';
 import type Stream from 'stream';
-import type { NodeConnectionParams } from './connection';
-export type NodeClickHouseClientConfigOptions = BaseClickHouseClientConfigOptions<Stream.Readable> & {
-    tls?: BasicTLSOptions | MutualTLSOptions;
-    /** HTTP Keep-Alive related settings */
-    keep_alive?: {
-        /** Enable or disable HTTP Keep-Alive mechanism. Default: true */
-        enabled?: boolean;
-        /** For how long keep a particular idle socket alive on the client side (in milliseconds).
-         * It is supposed to be a fair bit less that the ClickHouse server KeepAlive timeout, which is by default 3000 ms.
-         * Default value: 2500 */
-        idle_socket_ttl?: number;
-    };
-};
-interface BasicTLSOptions {
-    ca_cert: Buffer;
+import type { NodeClickHouseClientConfigOptions } from './config';
+import type { ResultSet } from './result_set';
+/** If the Format is not a literal type, fall back to the default behavior of the ResultSet,
+ *  allowing to call all methods with all data shapes variants,
+ *  and avoiding generated types that include all possible DataFormat literal values. */
+export type QueryResult<Format extends DataFormat> = IsSame<Format, DataFormat> extends true ? ResultSet<unknown> : ResultSet<Format>;
+export declare class NodeClickHouseClient extends ClickHouseClient<Stream.Readable> {
+    /** See {@link ClickHouseClient.query}. */
+    query<Format extends DataFormat = 'JSON'>(params: QueryParamsWithFormat<Format>): Promise<QueryResult<Format>>;
 }
-interface MutualTLSOptions {
-    ca_cert: Buffer;
-    cert: Buffer;
-    key: Buffer;
-}
-export declare function createClient(config?: NodeClickHouseClientConfigOptions): ClickHouseClient<Stream.Readable>;
-export declare function createConnection(params: NodeConnectionParams): Connection<Stream.Readable>;
-export {};
+export declare function createClient(config?: NodeClickHouseClientConfigOptions): NodeClickHouseClient;

package/dist/client.js

@@ -1,62 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createConnection = exports.createClient = void 0;
+exports.NodeClickHouseClient = void 0;
+exports.createClient = createClient;
 const client_common_1 = require("@clickhouse/client-common");
-const connection_1 = require("./connection");
-const result_set_1 = require("./result_set");
-const utils_1 = require("./utils");
-function createClient(config) {
-    let tls = undefined;
-    if (config?.tls) {
-        if ('cert' in config.tls && 'key' in config.tls) {
-            tls = {
-                type: 'Mutual',
-                ...config.tls,
-            };
-        }
-        else {
-            tls = {
-                type: 'Basic',
-                ...config.tls,
-            };
-        }
+const config_1 = require("./config");
+class NodeClickHouseClient extends client_common_1.ClickHouseClient {
+    /** See {@link ClickHouseClient.query}. */
+    query(params) {
+        return super.query(params);
     }
-    const keep_alive = {
-        enabled: config?.keep_alive?.enabled ?? true,
-        idle_socket_ttl: config?.keep_alive?.idle_socket_ttl ?? 2500,
-    };
+}
+exports.NodeClickHouseClient = NodeClickHouseClient;
+function createClient(config) {
     return new client_common_1.ClickHouseClient({
-        impl: {
-            make_connection: (params) => {
-                switch (params.url.protocol) {
-                    case 'http:':
-                        return new connection_1.NodeHttpConnection({ ...params, keep_alive });
-                    case 'https:':
-                        return new connection_1.NodeHttpsConnection({ ...params, tls, keep_alive });
-                    default:
-                        throw new Error('Only HTTP(s) adapters are supported');
-                }
-            },
-            make_result_set: (stream, format, session_id) => new result_set_1.ResultSet(stream, format, session_id),
-            values_encoder: new utils_1.NodeValuesEncoder(),
-            close_stream: async (stream) => {
-                stream.destroy();
-            },
-        },
+        impl: config_1.NodeConfigImpl,
         ...(config || {}),
     });
 }
-exports.createClient = createClient;
-function createConnection(params) {
-    // TODO throw ClickHouseClient error
-    switch (params.url.protocol) {
-        case 'http:':
-            return new connection_1.NodeHttpConnection(params);
-        case 'https:':
-            return new connection_1.NodeHttpsConnection(params);
-        default:
-            throw new Error('Only HTTP(s) adapters are supported');
-    }
-}
-exports.createConnection = createConnection;
 //# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../packages/client-node/src/client.ts"],"names":[],"mappings":";;;AAMA,6DAA4D;AAG5D,6CAAsE;AACtE,6CAAwC;AACxC,mCAA2C;AA0B3C,SAAgB,YAAY,CAC1B,MAA0C;IAE1C,IAAI,GAAG,GAA0B,SAAS,CAAA;IAC1C,IAAI,MAAM,EAAE,GAAG,EAAE;QACf,IAAI,MAAM,IAAI,MAAM,CAAC,GAAG,IAAI,KAAK,IAAI,MAAM,CAAC,GAAG,EAAE;YAC/C,GAAG,GAAG;gBACJ,IAAI,EAAE,QAAQ;gBACd,GAAG,MAAM,CAAC,GAAG;aACd,CAAA;SACF;aAAM;YACL,GAAG,GAAG;gBACJ,IAAI,EAAE,OAAO;gBACb,GAAG,MAAM,CAAC,GAAG;aACd,CAAA;SACF;KACF;IACD,MAAM,UAAU,GAAG;QACjB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,IAAI,IAAI;QAC5C,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,IAAI,IAAI;KAC7D,CAAA;IACD,OAAO,IAAI,gCAAgB,CAAC;QAC1B,IAAI,EAAE;YACJ,eAAe,EAAE,CAAC,MAAwB,EAAE,EAAE;gBAC5C,QAAQ,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE;oBAC3B,KAAK,OAAO;wBACV,OAAO,IAAI,+BAAkB,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;oBAC1D,KAAK,QAAQ;wBACX,OAAO,IAAI,gCAAmB,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAA;oBAChE;wBACE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;iBACzD;YACH,CAAC;YACD,eAAe,EAAE,CACf,MAAuB,EACvB,MAAkB,EAClB,UAAkB,EAClB,EAAE,CAAC,IAAI,sBAAS,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC;YAC9C,cAAc,EAAE,IAAI,yBAAiB,EAAE;YACvC,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;gBAC7B,MAAM,CAAC,OAAO,EAAE,CAAA;YAClB,CAAC;SACF;QACD,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;KAClB,CAAC,CAAA;AACJ,CAAC;AA7CD,oCA6CC;AAED,SAAgB,gBAAgB,CAC9B,MAA4B;IAE5B,oCAAoC;IACpC,QAAQ,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE;QAC3B,KAAK,OAAO;YACV,OAAO,IAAI,+BAAkB,CAAC,MAAM,CAAC,CAAA;QACvC,KAAK,QAAQ;YACX,OAAO,IAAI,gCAAmB,CAAC,MAAM,CAAC,CAAA;QACxC;YACE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;KACzD;AACH,CAAC;AAZD,4CAYC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AA4BA,oCAOC;AA9BD,6DAA4D;AAG5D,qCAAyC;AAWzC,MAAa,oBAAqB,SAAQ,gCAAiC;IACzE,0CAA0C;IAC1C,KAAK,CACH,MAAqC;QAErC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAA+B,CAAA;IAC1D,CAAC;CACF;AAPD,oDAOC;AAED,SAAgB,YAAY,CAC1B,MAA0C;IAE1C,OAAO,IAAI,gCAAgB,CAAkB;QAC3C,IAAI,EAAE,uBAAc;QACpB,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;KAClB,CAAyB,CAAA;AAC5B,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,52 @@
+import type { ImplementationDetails } from '@clickhouse/client-common';
+import { type BaseClickHouseClientConfigOptions } from '@clickhouse/client-common';
+import type http from 'http';
+import type https from 'node:https';
+import type Stream from 'stream';
+export type NodeClickHouseClientConfigOptions = BaseClickHouseClientConfigOptions & {
+    tls?: BasicTLSOptions | MutualTLSOptions;
+    /** HTTP Keep-Alive related settings */
+    keep_alive?: {
+        /** Enable or disable the HTTP Keep-Alive mechanism.
+         *  @default true */
+        enabled?: boolean;
+        /** For how long keep a particular idle socket alive on the client side (in milliseconds).
+         *  It is supposed to be a fair bit less that the ClickHouse server KeepAlive timeout,
+         *  which is by default 3000 ms for pre-23.11 versions. <br/>
+         *  When set to `0`, the idle socket management feature is disabled.
+         *  @default 2500 */
+        idle_socket_ttl?: number;
+    };
+    /** Custom HTTP agent to use for the outgoing HTTP(s) requests.
+     *  If set, {@link BaseClickHouseClientConfigOptions.max_open_connections}, {@link tls} and {@link keep_alive}
+     *  options have no effect, as it is part of the default underlying agent configuration.
+     *  @experimental - unstable API; it might be a subject to change in the future;
+     *                  please provide your feedback in the repository.
+     *  @default undefined */
+    http_agent?: http.Agent | https.Agent;
+    /** Enable or disable the `Authorization` header with basic auth for the outgoing HTTP(s) requests.
+     *  @experimental - unstable API; it might be a subject to change in the future;
+     *                  please provide your feedback in the repository.
+     *  @default true (enabled) */
+    set_basic_auth_header?: boolean;
+    /** You could try enabling this option if you encounter an error with an unclear or truncated stack trace;
+     *  as it might happen due to the way the Node.js handles the stack traces in the async code.
+     *  Note that it might have a noticeable performance impact due to
+     *  capturing the full stack trace on each client method call.
+     *  It could also be necessary to override `Error.stackTraceLimit` and increase it
+     *  to a higher value, or even to `Infinity`, as the default value Node.js is just `10`.
+     *  @experimental - unstable API; it might be a subject to change in the future;
+     *                  please provide your feedback in the repository.
+     *  @default false (disabled) */
+    capture_enhanced_stack_trace?: boolean;
+};
+interface BasicTLSOptions {
+    ca_cert: Buffer;
+}
+interface MutualTLSOptions {
+    ca_cert: Buffer;
+    cert: Buffer;
+    key: Buffer;
+}
+export declare const NodeConfigImpl: Required<ImplementationDetails<Stream.Readable>['impl']>;
+export {};

package/dist/config.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeConfigImpl = void 0;
+const client_common_1 = require("@clickhouse/client-common");
+const connection_1 = require("./connection");
+const result_set_1 = require("./result_set");
+const utils_1 = require("./utils");
+exports.NodeConfigImpl = {
+    handle_specific_url_params: (config, url) => {
+        const nodeConfig = { ...config };
+        const unknownParams = new Set();
+        const handledParams = new Set();
+        const urlSearchParamsKeys = [...url.searchParams.keys()];
+        if (urlSearchParamsKeys.length > 0) {
+            urlSearchParamsKeys.forEach((key) => {
+                const value = url.searchParams.get(key);
+                switch (key) {
+                    case 'keep_alive_idle_socket_ttl':
+                        if (nodeConfig.keep_alive === undefined) {
+                            nodeConfig.keep_alive = {};
+                        }
+                        nodeConfig.keep_alive.idle_socket_ttl = (0, client_common_1.numberConfigURLValue)({
+                            key,
+                            value,
+                            min: 0,
+                        });
+                        handledParams.add(key);
+                        break;
+                    default:
+                        unknownParams.add(key);
+                }
+            });
+        }
+        return {
+            config: nodeConfig,
+            unknown_params: unknownParams,
+            handled_params: handledParams,
+        };
+    },
+    make_connection: (nodeConfig, params) => {
+        let tls = undefined;
+        if (nodeConfig.tls !== undefined) {
+            if ('cert' in nodeConfig.tls && 'key' in nodeConfig.tls) {
+                tls = {
+                    type: 'Mutual',
+                    ...nodeConfig.tls,
+                };
+            }
+            else {
+                tls = {
+                    type: 'Basic',
+                    ...nodeConfig.tls,
+                };
+            }
+        }
+        // normally, it should be already set after processing the config
+        const keep_alive = {
+            enabled: nodeConfig?.keep_alive?.enabled ?? true,
+            idle_socket_ttl: nodeConfig?.keep_alive?.idle_socket_ttl ?? 2500,
+        };
+        return connection_1.NodeConnectionFactory.create({
+            connection_params: params,
+            set_basic_auth_header: nodeConfig.set_basic_auth_header ?? true,
+            capture_enhanced_stack_trace: nodeConfig.capture_enhanced_stack_trace ?? false,
+            http_agent: nodeConfig.http_agent,
+            keep_alive,
+            tls,
+        });
+    },
+    values_encoder: (jsonHandling) => new utils_1.NodeValuesEncoder(jsonHandling),
+    make_result_set: ((stream, format, query_id, log_error, response_headers, jsonHandling) => result_set_1.ResultSet.instance({
+        stream,
+        format,
+        query_id,
+        log_error,
+        response_headers,
+        jsonHandling,
+    })),
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAMA,6DAIkC;AAIlC,6CAAoE;AACpE,6CAAwC;AACxC,mCAA2C;AAmD9B,QAAA,cAAc,GAEvB;IACF,0BAA0B,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QAC1C,MAAM,UAAU,GAAsC,EAAE,GAAG,MAAM,EAAE,CAAA;QACnE,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAA;QACvC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAA;QACvC,MAAM,mBAAmB,GAAG,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAA;QACxD,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,mBAAmB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAClC,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAW,CAAA;gBACjD,QAAQ,GAAG,EAAE,CAAC;oBACZ,KAAK,4BAA4B;wBAC/B,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;4BACxC,UAAU,CAAC,UAAU,GAAG,EAAE,CAAA;wBAC5B,CAAC;wBACD,UAAU,CAAC,UAAU,CAAC,eAAe,GAAG,IAAA,oCAAoB,EAAC;4BAC3D,GAAG;4BACH,KAAK;4BACL,GAAG,EAAE,CAAC;yBACP,CAAC,CAAA;wBACF,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;wBACtB,MAAK;oBACP;wBACE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBAC1B,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;QACD,OAAO;YACL,MAAM,EAAE,UAAU;YAClB,cAAc,EAAE,aAAa;YAC7B,cAAc,EAAE,aAAa;SAC9B,CAAA;IACH,CAAC;IACD,eAAe,EAAE,CACf,UAA6C,EAC7C,MAAwB,EACxB,EAAE;QACF,IAAI,GAAG,GAA0B,SAAS,CAAA;QAC1C,IAAI,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,MAAM,IAAI,UAAU,CAAC,GAAG,IAAI,KAAK,IAAI,UAAU,CAAC,GAAG,EAAE,CAAC;gBACxD,GAAG,GAAG;oBACJ,IAAI,EAAE,QAAQ;oBACd,GAAG,UAAU,CAAC,GAAG;iBAClB,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,GAAG,GAAG;oBACJ,IAAI,EAAE,OAAO;oBACb,GAAG,UAAU,CAAC,GAAG;iBAClB,CAAA;YACH,CAAC;QACH,CAAC;QACD,iEAAiE;QACjE,MAAM,UAAU,GAAG;YACjB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,IAAI,IAAI;YAChD,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,IAAI,IAAI;SACjE,CAAA;QACD,OAAO,kCAAqB,CAAC,MAAM,CAAC;YAClC,iBAAiB,EAAE,MAAM;YACzB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,IAAI,IAAI;YAC/D,4BAA4B,EAC1B,UAAU,CAAC,4BAA4B,IAAI,KAAK;YAClD,UAAU,EAAE,UAAU,CAAC,UAAU;YACjC,UAAU;YACV,GAAG;SACJ,CAAC,CAAA;IACJ,CAAC;IACD,cAAc,EAAE,CAAC,YAA0B,EAAE,EAAE,CAC7C,IAAI,yBAAiB,CAAC,YAAY,CAAC;IACrC,eAAe,EAAE,CAAC,CAChB,MAAuB,EACvB,MAAkB,EAClB,QAAgB,EAChB,SAA+B,EAC/B,gBAAiC,EACjC,YAA0B,EAC1B,EAAE,CACF,sBAAS,CAAC,QAAQ,CAAC;QACjB,MAAM;QACN,MAAM;QACN,QAAQ;QACR,SAAS;QACT,gBAAgB;QAChB,YAAY;KACb,CAAC,CAAQ;CACb,CAAA"}

package/dist/connection/compression.d.ts

@@ -1,12 +1,13 @@
-/// <reference types="node" />
-/// <reference types="node" />
+import type { LogWriter } from '@clickhouse/client-common';
 import type Http from 'http';
 import Stream from 'stream';
-export declare function decompressResponse(response: Http.IncomingMessage): {
+type DecompressResponseResult = {
     response: Stream.Readable;
 } | {
     error: Error;
 };
+export declare function decompressResponse(response: Http.IncomingMessage, logWriter: LogWriter): DecompressResponseResult;
 export declare function isDecompressionError(result: any): result is {
     error: Error;
 };
+export {};

package/dist/connection/compression.js

@@ -3,16 +3,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDecompressionError = exports.decompressResponse = void 0;
+exports.decompressResponse = decompressResponse;
+exports.isDecompressionError = isDecompressionError;
 const stream_1 = __importDefault(require("stream"));
 const zlib_1 = __importDefault(require("zlib"));
-function decompressResponse(response) {
+function decompressResponse(response, logWriter) {
     const encoding = response.headers['content-encoding'];
     if (encoding === 'gzip') {
         return {
             response: stream_1.default.pipeline(response, zlib_1.default.createGunzip(), function pipelineCb(err) {
                 if (err) {
-                    console.error(err);
+                    logWriter.error({
+                        message: 'An error occurred while decompressing the response',
+                        err,
+                    });
                 }
             }),
         };
@@ -24,9 +28,7 @@ function decompressResponse(response) {
     }
     return { response };
 }
-exports.decompressResponse = decompressResponse;
 function isDecompressionError(result) {
     return result.error !== undefined;
 }
-exports.isDecompressionError = isDecompressionError;
 //# sourceMappingURL=compression.js.map

package/dist/connection/compression.js.map

@@ -1 +1 @@
-{"version":3,"file":"compression.js","sourceRoot":"","sources":["../../../../packages/client-node/src/connection/compression.ts"],"names":[],"mappings":";;;;;;AACA,oDAA2B;AAC3B,gDAAuB;AAEvB,SAAgB,kBAAkB,CAAC,QAA8B;IAK/D,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAErD,IAAI,QAAQ,KAAK,MAAM,EAAE;QACvB,OAAO;YACL,QAAQ,EAAE,gBAAM,CAAC,QAAQ,CACvB,QAAQ,EACR,cAAI,CAAC,YAAY,EAAE,EACnB,SAAS,UAAU,CAAC,GAAG;gBACrB,IAAI,GAAG,EAAE;oBACP,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;iBACnB;YACH,CAAC,CACF;SACF,CAAA;KACF;SAAM,IAAI,QAAQ,KAAK,SAAS,EAAE;QACjC,OAAO;YACL,KAAK,EAAE,IAAI,KAAK,CAAC,wBAAwB,QAAQ,EAAE,CAAC;SACrD,CAAA;KACF;IAED,OAAO,EAAE,QAAQ,EAAE,CAAA;AACrB,CAAC;AA1BD,gDA0BC;AAED,SAAgB,oBAAoB,CAAC,MAAW;IAC9C,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAA;AACnC,CAAC;AAFD,oDAEC"}
+{"version":3,"file":"compression.js","sourceRoot":"","sources":["../../src/connection/compression.ts"],"names":[],"mappings":";;;;;AAOA,gDA4BC;AAED,oDAEC;AArCD,oDAA2B;AAC3B,gDAAuB;AAIvB,SAAgB,kBAAkB,CAChC,QAA8B,EAC9B,SAAoB;IAEpB,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAErD,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACxB,OAAO;YACL,QAAQ,EAAE,gBAAM,CAAC,QAAQ,CACvB,QAAQ,EACR,cAAI,CAAC,YAAY,EAAE,EACnB,SAAS,UAAU,CAAC,GAAG;gBACrB,IAAI,GAAG,EAAE,CAAC;oBACR,SAAS,CAAC,KAAK,CAAC;wBACd,OAAO,EAAE,oDAAoD;wBAC7D,GAAG;qBACJ,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC,CACF;SACF,CAAA;IACH,CAAC;SAAM,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO;YACL,KAAK,EAAE,IAAI,KAAK,CAAC,wBAAwB,QAAQ,EAAE,CAAC;SACrD,CAAA;IACH,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,CAAA;AACrB,CAAC;AAED,SAAgB,oBAAoB,CAAC,MAAW;IAC9C,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAA;AACnC,CAAC"}

package/dist/connection/create_connection.d.ts

@@ -0,0 +1,16 @@
+import type { ConnectionParams } from '@clickhouse/client-common';
+import type http from 'http';
+import type https from 'node:https';
+import type { NodeBaseConnection, NodeConnectionParams } from './node_base_connection';
+export interface CreateConnectionParams {
+    connection_params: ConnectionParams;
+    tls: NodeConnectionParams['tls'];
+    keep_alive: NodeConnectionParams['keep_alive'];
+    http_agent: http.Agent | https.Agent | undefined;
+    set_basic_auth_header: boolean;
+    capture_enhanced_stack_trace: boolean;
+}
+/** A factory for easier mocking after Node.js 22.18 */
+export declare class NodeConnectionFactory {
+    static create({ connection_params, tls, keep_alive, http_agent, set_basic_auth_header, capture_enhanced_stack_trace, }: CreateConnectionParams): NodeBaseConnection;
+}

package/dist/connection/create_connection.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeConnectionFactory = void 0;
+const node_custom_agent_connection_1 = require("./node_custom_agent_connection");
+const node_http_connection_1 = require("./node_http_connection");
+const node_https_connection_1 = require("./node_https_connection");
+/** A factory for easier mocking after Node.js 22.18 */
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
+class NodeConnectionFactory {
+    static create({ connection_params, tls, keep_alive, http_agent, set_basic_auth_header, capture_enhanced_stack_trace, }) {
+        if (http_agent !== undefined) {
+            return new node_custom_agent_connection_1.NodeCustomAgentConnection({
+                ...connection_params,
+                set_basic_auth_header,
+                capture_enhanced_stack_trace,
+                keep_alive, // only used to enforce proper KeepAlive headers
+                http_agent,
+            });
+        }
+        switch (connection_params.url.protocol) {
+            case 'http:':
+                return new node_http_connection_1.NodeHttpConnection({
+                    ...connection_params,
+                    set_basic_auth_header,
+                    capture_enhanced_stack_trace,
+                    keep_alive,
+                });
+            case 'https:':
+                return new node_https_connection_1.NodeHttpsConnection({
+                    ...connection_params,
+                    set_basic_auth_header,
+                    capture_enhanced_stack_trace,
+                    keep_alive,
+                    tls,
+                });
+            default:
+                throw new Error('Only HTTP and HTTPS protocols are supported');
+        }
+    }
+}
+exports.NodeConnectionFactory = NodeConnectionFactory;
+//# sourceMappingURL=create_connection.js.map

package/dist/connection/create_connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create_connection.js","sourceRoot":"","sources":["../../src/connection/create_connection.ts"],"names":[],"mappings":";;;AAOA,iFAA0E;AAC1E,iEAA2D;AAC3D,mEAA6D;AAW7D,uDAAuD;AACvD,kEAAkE;AAClE,MAAa,qBAAqB;IAChC,MAAM,CAAC,MAAM,CAAC,EACZ,iBAAiB,EACjB,GAAG,EACH,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,4BAA4B,GACL;QACvB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,wDAAyB,CAAC;gBACnC,GAAG,iBAAiB;gBACpB,qBAAqB;gBACrB,4BAA4B;gBAC5B,UAAU,EAAE,gDAAgD;gBAC5D,UAAU;aACX,CAAC,CAAA;QACJ,CAAC;QACD,QAAQ,iBAAiB,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YACvC,KAAK,OAAO;gBACV,OAAO,IAAI,yCAAkB,CAAC;oBAC5B,GAAG,iBAAiB;oBACpB,qBAAqB;oBACrB,4BAA4B;oBAC5B,UAAU;iBACX,CAAC,CAAA;YACJ,KAAK,QAAQ;gBACX,OAAO,IAAI,2CAAmB,CAAC;oBAC7B,GAAG,iBAAiB;oBACpB,qBAAqB;oBACrB,4BAA4B;oBAC5B,UAAU;oBACV,GAAG;iBACJ,CAAC,CAAA;YACJ;gBACE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;QAClE,CAAC;IACH,CAAC;CACF;AAtCD,sDAsCC"}

package/dist/connection/index.d.ts

@@ -1,3 +1,4 @@
 export * from './node_base_connection';
 export * from './node_http_connection';
 export * from './node_https_connection';
+export * from './create_connection';

package/dist/connection/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./node_base_connection"), exports);
 __exportStar(require("./node_http_connection"), exports);
 __exportStar(require("./node_https_connection"), exports);
+__exportStar(require("./create_connection"), exports);
 //# sourceMappingURL=index.js.map

package/dist/connection/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/client-node/src/connection/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,yDAAsC;AACtC,0DAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/connection/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,yDAAsC;AACtC,0DAAuC;AACvC,sDAAmC"}

package/dist/connection/node_base_connection.d.ts

@@ -1,11 +1,13 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import type { ConnBaseQueryParams, Connection, ConnectionParams, ConnExecResult, ConnInsertParams, ConnInsertResult, ConnPingResult, ConnQueryResult } from '@clickhouse/client-common';
+import type { ConnBaseQueryParams, ConnCommandResult, Connection, ConnectionParams, ConnExecParams, ConnExecResult, ConnInsertParams, ConnInsertResult, ConnPingResult, ConnQueryResult } from '@clickhouse/client-common';
+import { type ConnPingParams } from '@clickhouse/client-common';
 import type Http from 'http';
+import type Https from 'node:https';
 import Stream from 'stream';
 export type NodeConnectionParams = ConnectionParams & {
     tls?: TLSParams;
+    http_agent?: Http.Agent | Https.Agent;
+    set_basic_auth_header: boolean;
+    capture_enhanced_stack_trace: boolean;
     keep_alive: {
         enabled: boolean;
         idle_socket_ttl: number;
@@ -23,32 +25,41 @@ export type TLSParams = {
 export interface RequestParams {
     method: 'GET' | 'POST';
     url: URL;
+    headers: Http.OutgoingHttpHeaders;
     body?: string | Stream.Readable;
     abort_signal: AbortSignal;
-    decompress_response?: boolean;
-    compress_request?: boolean;
+    enable_response_compression?: boolean;
+    enable_request_compression?: boolean;
+    try_decompress_response_stream?: boolean;
+    ignore_error_response?: boolean;
     parse_summary?: boolean;
+    query: string;
 }
 export declare abstract class NodeBaseConnection implements Connection<Stream.Readable> {
     protected readonly params: NodeConnectionParams;
     protected readonly agent: Http.Agent;
-    protected readonly headers: Http.OutgoingHttpHeaders;
+    protected readonly defaultAuthHeader: string;
+    protected readonly defaultHeaders: Http.OutgoingHttpHeaders;
+    private readonly jsonHandling;
     private readonly logger;
     private readonly knownSockets;
     private readonly idleSocketTTL;
     protected constructor(params: NodeConnectionParams, agent: Http.Agent);
-    protected buildDefaultHeaders(username: string, password: string, additional_headers?: Record<string, string>): Http.OutgoingHttpHeaders;
-    protected abstract createClientRequest(params: RequestParams): Http.ClientRequest;
-    private request;
-    ping(): Promise<ConnPingResult>;
+    ping(params: ConnPingParams): Promise<ConnPingResult>;
     query(params: ConnBaseQueryParams): Promise<ConnQueryResult<Stream.Readable>>;
-    exec(params: ConnBaseQueryParams): Promise<ConnExecResult<Stream.Readable>>;
     insert(params: ConnInsertParams<Stream.Readable>): Promise<ConnInsertResult>;
+    exec(params: ConnExecParams<Stream.Readable>): Promise<ConnExecResult<Stream.Readable>>;
+    command(params: ConnBaseQueryParams): Promise<ConnCommandResult>;
     close(): Promise<void>;
+    protected defaultHeadersWithOverride(params?: ConnBaseQueryParams): Http.OutgoingHttpHeaders;
+    protected buildRequestHeaders(params?: ConnBaseQueryParams): Http.OutgoingHttpHeaders;
+    protected abstract createClientRequest(params: RequestParams): Http.ClientRequest;
     private getQueryId;
     private getAbortController;
     private logResponse;
     private logRequestError;
     private httpRequestErrorMessage;
     private parseSummary;
+    private runExec;
+    private request;
 }