@clickhouse/client 0.0.1

package/dist/connection/adapter/https_adapter.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpsAdapter = void 0;
+const base_http_adapter_1 = require("./base_http_adapter");
+const https_1 = __importDefault(require("https"));
+class HttpsAdapter extends base_http_adapter_1.BaseHttpAdapter {
+    constructor(config, logger) {
+        const agent = new https_1.default.Agent({
+            keepAlive: true,
+            timeout: config.request_timeout,
+            maxSockets: config.max_open_connections,
+        });
+        super(config, logger, agent);
+    }
+    createClientRequest(url, params) {
+        return https_1.default.request(params.url, {
+            method: params.method,
+            agent: this.agent,
+            headers: this.getHeaders(params),
+        });
+    }
+}
+exports.HttpsAdapter = HttpsAdapter;
+//# sourceMappingURL=https_adapter.js.map

package/dist/connection/adapter/https_adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"https_adapter.js","sourceRoot":"","sources":["../../../src/connection/adapter/https_adapter.ts"],"names":[],"mappings":";;;;;;AACA,2DAAqD;AAGrD,kDAAyB;AAGzB,MAAa,YAAa,SAAQ,mCAAe;IAC/C,YAAY,MAAwB,EAAE,MAAc;QAClD,MAAM,KAAK,GAAG,IAAI,eAAK,CAAC,KAAK,CAAC;YAC5B,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,MAAM,CAAC,eAAe;YAC/B,UAAU,EAAE,MAAM,CAAC,oBAAoB;SACxC,CAAC,CAAA;QACF,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IAC9B,CAAC;IAES,mBAAmB,CAC3B,GAAQ,EACR,MAAqB;QAErB,OAAO,eAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE;YAC/B,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;SACjC,CAAC,CAAA;IACJ,CAAC;CACF;AApBD,oCAoBC"}

package/dist/connection/adapter/index.d.ts

@@ -0,0 +1,2 @@
+export { HttpAdapter } from './http_adapter';
+export { HttpsAdapter } from './https_adapter';

package/dist/connection/adapter/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpsAdapter = exports.HttpAdapter = void 0;
+var http_adapter_1 = require("./http_adapter");
+Object.defineProperty(exports, "HttpAdapter", { enumerable: true, get: function () { return http_adapter_1.HttpAdapter; } });
+var https_adapter_1 = require("./https_adapter");
+Object.defineProperty(exports, "HttpsAdapter", { enumerable: true, get: function () { return https_adapter_1.HttpsAdapter; } });
+//# sourceMappingURL=index.js.map

package/dist/connection/adapter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/connection/adapter/index.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAAnC,2GAAA,WAAW,OAAA;AACpB,iDAA8C;AAArC,6GAAA,YAAY,OAAA"}

package/dist/connection/adapter/transform_url.d.ts

@@ -0,0 +1,5 @@
+export declare function transformUrl({ url, pathname, searchParams, }: {
+    url: URL;
+    pathname?: string;
+    searchParams?: URLSearchParams;
+}): URL;

package/dist/connection/adapter/transform_url.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformUrl = void 0;
+function transformUrl({ url, pathname, searchParams, }) {
+    const newUrl = new URL(url);
+    if (pathname) {
+        newUrl.pathname = pathname;
+    }
+    if (searchParams) {
+        newUrl.search = searchParams === null || searchParams === void 0 ? void 0 : searchParams.toString();
+    }
+    return newUrl;
+}
+exports.transformUrl = transformUrl;
+//# sourceMappingURL=transform_url.js.map

package/dist/connection/adapter/transform_url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform_url.js","sourceRoot":"","sources":["../../../src/connection/adapter/transform_url.ts"],"names":[],"mappings":";;;AAAA,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,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAA;KAC3B;IAED,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,MAAM,GAAG,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,QAAQ,EAAE,CAAA;KACzC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AApBD,oCAoBC"}

package/dist/connection/connection.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="node" />
+import type Stream from 'stream';
+import type { Logger } from '../logger';
+import type { ClickHouseSettings } from '../settings';
+export interface ConnectionParams {
+    url: URL;
+    connect_timeout: number;
+    request_timeout: number;
+    max_open_connections: number;
+    compression: {
+        decompress_response: boolean;
+        compress_request: boolean;
+    };
+    username: string;
+    password: string;
+    database: string;
+}
+export interface BaseParams {
+    query: string;
+    clickhouse_settings?: ClickHouseSettings;
+    query_params?: Record<string, unknown>;
+    abort_signal?: AbortSignal;
+}
+export interface InsertParams extends BaseParams {
+    values: string | Stream.Readable;
+}
+export interface Connection {
+    ping(): Promise<boolean>;
+    close(): Promise<void>;
+    select(params: BaseParams): Promise<Stream.Readable>;
+    command(params: BaseParams): Promise<Stream.Readable>;
+    insert(params: InsertParams): Promise<void>;
+}
+export declare function createConnection(params: ConnectionParams, logger: Logger): Connection;

package/dist/connection/connection.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConnection = void 0;
+const adapter_1 = require("./adapter");
+function createConnection(params, logger) {
+    // TODO throw ClickHouseClient error
+    switch (params.url.protocol) {
+        case 'http:':
+            return new adapter_1.HttpAdapter(params, logger);
+        case 'https:':
+            return new adapter_1.HttpsAdapter(params, logger);
+        default:
+            throw new Error('Only HTTP(s) adapters are supported');
+    }
+}
+exports.createConnection = createConnection;
+//# sourceMappingURL=connection.js.map

package/dist/connection/connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../src/connection/connection.ts"],"names":[],"mappings":";;;AAEA,uCAAqD;AAuCrD,SAAgB,gBAAgB,CAC9B,MAAwB,EACxB,MAAc;IAEd,oCAAoC;IACpC,QAAQ,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE;QAC3B,KAAK,OAAO;YACV,OAAO,IAAI,qBAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACxC,KAAK,QAAQ;YACX,OAAO,IAAI,sBAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC;YACE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;KACzD;AACH,CAAC;AAbD,4CAaC"}

package/dist/connection/index.d.ts

@@ -0,0 +1 @@
+export * from './connection';

package/dist/connection/index.js

@@ -0,0 +1,18 @@
+"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("./connection"), exports);
+//# sourceMappingURL=index.js.map

package/dist/connection/index.js.map

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

package/dist/data_formatter/format_query_params.d.ts

@@ -0,0 +1 @@
+export declare function formatQueryParams(value: any, wrapStringInQuotes?: boolean): string;

package/dist/data_formatter/format_query_params.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatQueryParams = void 0;
+const utils_1 = require("../utils");
+function withPadding(value) {
+    if (value > 9)
+        return String(value);
+    return `0${value}`;
+}
+function formatMillis(value) {
+    const ms = value.getMilliseconds();
+    if (ms === 0) {
+        return '';
+    }
+    if (ms > 99) {
+        return `.${ms}`;
+    }
+    if (ms > 9) {
+        return `.0${ms}`;
+    }
+    return `.00${ms}`;
+}
+function formatQueryParams(value, wrapStringInQuotes = false) {
+    if (value === null)
+        return 'NULL';
+    if (Number.isNaN(value))
+        return 'nan';
+    if (value === Number.POSITIVE_INFINITY)
+        return '+inf';
+    if (value === Number.NEGATIVE_INFINITY)
+        return '-inf';
+    if (typeof value === 'number')
+        return String(value);
+    if (typeof value === 'boolean')
+        return value ? '1' : '0';
+    if (typeof value === 'string') {
+        const escapedValue = (0, utils_1.replaceAll)((0, utils_1.replaceAll)(value, `\\`, `\\\\`), `'`, `\\'`);
+        return wrapStringInQuotes ? `'${escapedValue}'` : escapedValue;
+    }
+    if (Array.isArray(value)) {
+        const formatted = value.map((v) => formatQueryParams(v, true));
+        return `[${formatted.join(',')}]`;
+    }
+    if (value instanceof Date) {
+        // TODO add timezone support
+        const date = `${value.getFullYear()}-${withPadding(value.getMonth() + 1)}-${withPadding(value.getDate())}`;
+        const time = `${withPadding(value.getHours())}:${withPadding(value.getMinutes())}:${withPadding(value.getSeconds())}`;
+        const ms = formatMillis(value);
+        return `${date} ${time}${ms}`;
+    }
+    if (typeof value === 'object') {
+        const formatted = [];
+        for (const [key, val] of Object.entries(value)) {
+            formatted.push(`${formatQueryParams(key, true)}:${formatQueryParams(val, true)}`);
+        }
+        return `{${formatted.join(',')}}`;
+    }
+    throw new Error(`Unsupported value in query parameters: [${value}].`);
+}
+exports.formatQueryParams = formatQueryParams;
+//# sourceMappingURL=format_query_params.js.map

package/dist/data_formatter/format_query_params.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format_query_params.js","sourceRoot":"","sources":["../../src/data_formatter/format_query_params.ts"],"names":[],"mappings":";;;AAAA,oCAAqC;AAErC,SAAS,WAAW,CAAC,KAAa;IAChC,IAAI,KAAK,GAAG,CAAC;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IACnC,OAAO,IAAI,KAAK,EAAE,CAAA;AACpB,CAAC;AAED,SAAS,YAAY,CAAC,KAAW;IAC/B,MAAM,EAAE,GAAG,KAAK,CAAC,eAAe,EAAE,CAAA;IAClC,IAAI,EAAE,KAAK,CAAC,EAAE;QACZ,OAAO,EAAE,CAAA;KACV;IACD,IAAI,EAAE,GAAG,EAAE,EAAE;QACX,OAAO,IAAI,EAAE,EAAE,CAAA;KAChB;IACD,IAAI,EAAE,GAAG,CAAC,EAAE;QACV,OAAO,KAAK,EAAE,EAAE,CAAA;KACjB;IACD,OAAO,MAAM,EAAE,EAAE,CAAA;AACnB,CAAC;AAED,SAAgB,iBAAiB,CAC/B,KAAU,EACV,kBAAkB,GAAG,KAAK;IAE1B,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAA;IACjC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IACrC,IAAI,KAAK,KAAK,MAAM,CAAC,iBAAiB;QAAE,OAAO,MAAM,CAAA;IACrD,IAAI,KAAK,KAAK,MAAM,CAAC,iBAAiB;QAAE,OAAO,MAAM,CAAA;IAErD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IACnD,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAA;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,MAAM,YAAY,GAAG,IAAA,kBAAU,EAAC,IAAA,kBAAU,EAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;QAC5E,OAAO,kBAAkB,CAAC,CAAC,CAAC,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC,YAAY,CAAA;KAC/D;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;QAC9D,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAA;KAClC;IAED,IAAI,KAAK,YAAY,IAAI,EAAE;QACzB,4BAA4B;QAC5B,MAAM,IAAI,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,IAAI,WAAW,CAChD,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CACrB,IAAI,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,CAAA;QACnC,MAAM,IAAI,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,WAAW,CAC1D,KAAK,CAAC,UAAU,EAAE,CACnB,IAAI,WAAW,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,EAAE,CAAA;QAEtC,MAAM,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,EAAE,EAAE,CAAA;KAC9B;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,MAAM,SAAS,GAAa,EAAE,CAAA;QAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC9C,SAAS,CAAC,IAAI,CACZ,GAAG,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAClE,CAAA;SACF;QACD,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAA;KAClC;IAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,KAAK,IAAI,CAAC,CAAA;AACvE,CAAC;AA7CD,8CA6CC"}

package/dist/data_formatter/format_query_settings.d.ts

@@ -0,0 +1,2 @@
+import { SettingsMap } from '../settings';
+export declare function formatQuerySettings(value: number | string | boolean | SettingsMap): string;

package/dist/data_formatter/format_query_settings.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatQuerySettings = void 0;
+const settings_1 = require("../settings");
+function formatQuerySettings(value) {
+    if (typeof value === 'boolean')
+        return value ? '1' : '0';
+    if (typeof value === 'number')
+        return String(value);
+    if (typeof value === 'string')
+        return value;
+    // ClickHouse requires a specific, non-JSON format for passing maps
+    // as a setting value - single quotes instead of double
+    // Example: {'system.numbers':'number != 3'}
+    if (value instanceof settings_1.SettingsMap) {
+        return value.toString();
+    }
+    throw new Error(`Unsupported value in query settings: [${value}].`);
+}
+exports.formatQuerySettings = formatQuerySettings;
+//# sourceMappingURL=format_query_settings.js.map

package/dist/data_formatter/format_query_settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format_query_settings.js","sourceRoot":"","sources":["../../src/data_formatter/format_query_settings.ts"],"names":[],"mappings":";;;AAAA,0CAAyC;AAEzC,SAAgB,mBAAmB,CACjC,KAA8C;IAE9C,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAA;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IACnD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,mEAAmE;IACnE,uDAAuD;IACvD,4CAA4C;IAC5C,IAAI,KAAK,YAAY,sBAAW,EAAE;QAChC,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;KACxB;IACD,MAAM,IAAI,KAAK,CAAC,yCAAyC,KAAK,IAAI,CAAC,CAAA;AACrE,CAAC;AAbD,kDAaC"}

package/dist/data_formatter/formatter.d.ts

@@ -0,0 +1,23 @@
+declare const supportedJSONFormats: readonly ["JSON", "JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes"];
+declare const supportedRawFormats: readonly ["CSV", "CSVWithNames", "CSVWithNamesAndTypes", "TabSeparated", "TabSeparatedRaw", "TabSeparatedWithNames", "TabSeparatedWithNamesAndTypes", "CustomSeparated", "CustomSeparatedWithNames", "CustomSeparatedWithNamesAndTypes"];
+export declare type JSONDataFormat = typeof supportedJSONFormats[number];
+export declare type RawDataFormat = typeof supportedRawFormats[number];
+export declare type DataFormat = JSONDataFormat | RawDataFormat;
+declare const streamableFormat: readonly ["JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes", "CSV", "CSVWithNames", "CSVWithNamesAndTypes", "TabSeparated", "TabSeparatedRaw", "TabSeparatedWithNames", "TabSeparatedWithNamesAndTypes", "CustomSeparated", "CustomSeparatedWithNames", "CustomSeparatedWithNamesAndTypes"];
+declare type StreamableDataFormat = typeof streamableFormat[number];
+export declare function isSupportedRawFormat(dataFormat: DataFormat): boolean;
+export declare function validateStreamFormat(format: any): format is StreamableDataFormat;
+/**
+ * Decodes a string in a ClickHouse format into a plain JavaScript object or an array of objects.
+ * @param text a string in a ClickHouse data format
+ * @param format One of the supported formats: https://clickhouse.com/docs/en/interfaces/formats/
+ */
+export declare function decode(text: string, format: DataFormat): any;
+/**
+ * Encodes a single row of values into a string in a JSON format acceptable by ClickHouse.
+ * @param value a single value to encode.
+ * @param format One of the supported JSON formats: https://clickhouse.com/docs/en/interfaces/formats/
+ * @returns string
+ */
+export declare function encodeJSON(value: any, format: DataFormat): string;
+export {};

package/dist/data_formatter/formatter.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeJSON = exports.decode = exports.validateStreamFormat = exports.isSupportedRawFormat = void 0;
+const streamableJSONFormats = [
+    'JSONEachRow',
+    'JSONStringsEachRow',
+    'JSONCompactEachRow',
+    'JSONCompactStringsEachRow',
+    'JSONCompactEachRowWithNames',
+    'JSONCompactEachRowWithNamesAndTypes',
+    'JSONCompactStringsEachRowWithNames',
+    'JSONCompactStringsEachRowWithNamesAndTypes',
+];
+const supportedJSONFormats = ['JSON', ...streamableJSONFormats];
+const supportedRawFormats = [
+    'CSV',
+    'CSVWithNames',
+    'CSVWithNamesAndTypes',
+    'TabSeparated',
+    'TabSeparatedRaw',
+    'TabSeparatedWithNames',
+    'TabSeparatedWithNamesAndTypes',
+    'CustomSeparated',
+    'CustomSeparatedWithNames',
+    'CustomSeparatedWithNamesAndTypes',
+];
+// TODO add others formats
+const streamableFormat = [
+    ...streamableJSONFormats,
+    ...supportedRawFormats,
+];
+function isStreamableJSONFamily(format) {
+    // @ts-expect-error JSON is not assignable to streamableJSONFormats
+    return streamableJSONFormats.includes(format);
+}
+function isSupportedRawFormat(dataFormat) {
+    return supportedRawFormats.includes(dataFormat);
+}
+exports.isSupportedRawFormat = isSupportedRawFormat;
+function validateStreamFormat(format) {
+    if (!streamableFormat.includes(format)) {
+        throw new Error(`${format} format is not streamable. Streamable formats: ${streamableFormat.join(',')}`);
+    }
+    return true;
+}
+exports.validateStreamFormat = validateStreamFormat;
+/**
+ * Decodes a string in a ClickHouse format into a plain JavaScript object or an array of objects.
+ * @param text a string in a ClickHouse data format
+ * @param format One of the supported formats: https://clickhouse.com/docs/en/interfaces/formats/
+ */
+function decode(text, format) {
+    if (format === 'JSON') {
+        return JSON.parse(text);
+    }
+    if (isStreamableJSONFamily(format)) {
+        return text
+            .split('\n')
+            .filter(Boolean)
+            .map((l) => decode(l, 'JSON'));
+    }
+    if (isSupportedRawFormat(format)) {
+        throw new Error(`cannot decode ${format} to JSON`);
+    }
+    throw new Error(`The client does not support [${format}] format decoding.`);
+}
+exports.decode = decode;
+/**
+ * Encodes a single row of values into a string in a JSON format acceptable by ClickHouse.
+ * @param value a single value to encode.
+ * @param format One of the supported JSON formats: https://clickhouse.com/docs/en/interfaces/formats/
+ * @returns string
+ */
+function encodeJSON(value, format) {
+    if (streamableJSONFormats.includes(format)) {
+        return JSON.stringify(value) + '\n';
+    }
+    throw new Error(`The client does not support JSON encoding in [${format}] format.`);
+}
+exports.encodeJSON = encodeJSON;
+//# sourceMappingURL=formatter.js.map

package/dist/data_formatter/formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../src/data_formatter/formatter.ts"],"names":[],"mappings":";;;AAAA,MAAM,qBAAqB,GAAG;IAC5B,aAAa;IACb,oBAAoB;IACpB,oBAAoB;IACpB,2BAA2B;IAC3B,6BAA6B;IAC7B,qCAAqC;IACrC,oCAAoC;IACpC,4CAA4C;CACpC,CAAA;AACV,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,GAAG,qBAAqB,CAAU,CAAA;AACxE,MAAM,mBAAmB,GAAG;IAC1B,KAAK;IACL,cAAc;IACd,sBAAsB;IACtB,cAAc;IACd,iBAAiB;IACjB,uBAAuB;IACvB,+BAA+B;IAC/B,iBAAiB;IACjB,0BAA0B;IAC1B,kCAAkC;CAC1B,CAAA;AAQV,0BAA0B;AAC1B,MAAM,gBAAgB,GAAG;IACvB,GAAG,qBAAqB;IACxB,GAAG,mBAAmB;CACd,CAAA;AAGV,SAAS,sBAAsB,CAC7B,MAAkB;IAElB,mEAAmE;IACnE,OAAO,qBAAqB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;AAC/C,CAAC;AAED,SAAgB,oBAAoB,CAAC,UAAsB;IACzD,OAAQ,mBAAyC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;AACxE,CAAC;AAFD,oDAEC;AAED,SAAgB,oBAAoB,CAClC,MAAW;IAEX,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACtC,MAAM,IAAI,KAAK,CACb,GAAG,MAAM,kDAAkD,gBAAgB,CAAC,IAAI,CAC9E,GAAG,CACJ,EAAE,CACJ,CAAA;KACF;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAXD,oDAWC;AAED;;;;GAIG;AACH,SAAgB,MAAM,CAAC,IAAY,EAAE,MAAkB;IACrD,IAAI,MAAM,KAAK,MAAM,EAAE;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;KACxB;IACD,IAAI,sBAAsB,CAAC,MAAM,CAAC,EAAE;QAClC,OAAO,IAAI;aACR,KAAK,CAAC,IAAI,CAAC;aACX,MAAM,CAAC,OAAO,CAAC;aACf,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;KACjC;IACD,IAAI,oBAAoB,CAAC,MAAM,CAAC,EAAE;QAChC,MAAM,IAAI,KAAK,CAAC,iBAAiB,MAAM,UAAU,CAAC,CAAA;KACnD;IACD,MAAM,IAAI,KAAK,CAAC,gCAAgC,MAAM,oBAAoB,CAAC,CAAA;AAC7E,CAAC;AAdD,wBAcC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAU,EAAE,MAAkB;IACvD,IAAK,qBAA2C,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACjE,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;KACpC;IACD,MAAM,IAAI,KAAK,CACb,iDAAiD,MAAM,WAAW,CACnE,CAAA;AACH,CAAC;AAPD,gCAOC"}

package/dist/data_formatter/index.d.ts

@@ -0,0 +1,3 @@
+export * from './formatter';
+export { formatQueryParams } from './format_query_params';
+export { formatQuerySettings } from './format_query_settings';

package/dist/data_formatter/index.js

@@ -0,0 +1,23 @@
+"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 });
+exports.formatQuerySettings = exports.formatQueryParams = void 0;
+__exportStar(require("./formatter"), exports);
+var format_query_params_1 = require("./format_query_params");
+Object.defineProperty(exports, "formatQueryParams", { enumerable: true, get: function () { return format_query_params_1.formatQueryParams; } });
+var format_query_settings_1 = require("./format_query_settings");
+Object.defineProperty(exports, "formatQuerySettings", { enumerable: true, get: function () { return format_query_settings_1.formatQuerySettings; } });
+//# sourceMappingURL=index.js.map

package/dist/data_formatter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data_formatter/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,6DAAyD;AAAhD,wHAAA,iBAAiB,OAAA;AAC1B,iEAA6D;AAApD,4HAAA,mBAAmB,OAAA"}

package/dist/error/index.d.ts

@@ -0,0 +1 @@
+export * from './parse_error';

package/dist/error/index.js

@@ -0,0 +1,18 @@
+"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("./parse_error"), exports);
+//# sourceMappingURL=index.js.map

package/dist/error/index.js.map

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

package/dist/error/parse_error.d.ts

@@ -0,0 +1,12 @@
+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): ClickHouseError | Error;
+export {};

package/dist/error/parse_error.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseError = exports.ClickHouseError = void 0;
+const errorRe = /(Code|Error): (?<code>\d+).*Exception: (?<message>.+)\((?<type>(?=.+[A-Z]{3})[A-Z0-9_]+?)\)/s;
+class ClickHouseError extends Error {
+    constructor({ message, code, type }) {
+        super(message);
+        Object.defineProperty(this, "code", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "type", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.code = code;
+        this.type = type;
+        // Set the prototype explicitly, see:
+        // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work
+        Object.setPrototypeOf(this, ClickHouseError.prototype);
+    }
+}
+exports.ClickHouseError = ClickHouseError;
+function parseError(input) {
+    const match = input.match(errorRe);
+    const groups = match === null || match === void 0 ? void 0 : match.groups;
+    if (groups) {
+        return new ClickHouseError(groups);
+    }
+    else {
+        return new Error(input);
+    }
+}
+exports.parseError = parseError;
+//# sourceMappingURL=parse_error.js.map

package/dist/error/parse_error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse_error.js","sourceRoot":"","sources":["../../src/error/parse_error.ts"],"names":[],"mappings":";;;AAAA,MAAM,OAAO,GACX,8FAA8F,CAAA;AAOhG,MAAa,eAAgB,SAAQ,KAAK;IAGxC,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAyB;QACxD,KAAK,CAAC,OAAO,CAAC,CAAA;QAHhB;;;;;WAAqB;QACrB;;;;;WAAiC;QAG/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAEhB,qCAAqC;QACrC,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;IACxD,CAAC;CACF;AAZD,0CAYC;AAED,SAAgB,UAAU,CAAC,KAAa;IACtC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAClC,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAA2C,CAAA;IACjE,IAAI,MAAM,EAAE;QACV,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAA;KACnC;SAAM;QACL,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;KACxB;AACH,CAAC;AARD,gCAQC"}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { createClient } from './client';
+export { createClient };
+declare const _default: {
+    createClient: typeof createClient;
+};
+export default _default;
+export { type ClickHouseClientConfigOptions, type ClickHouseClient, type BaseParams, type QueryParams, type ExecParams, type InsertParams, } from './client';
+export { Row, Rows } from './rows';
+export type { Connection } from './connection';
+export type { DataFormat } from './data_formatter';
+export type { ClickHouseError } from './error';
+export type { Logger } from './logger';
+export type { ResponseJSON, DataType } from './clickhouse_types';
+export type { ClickHouseSettings } from './settings';
+export { SettingsMap } from './settings';

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsMap = exports.Rows = exports.Row = exports.createClient = void 0;
+const client_1 = require("./client");
+Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_1.createClient; } });
+exports.default = {
+    createClient: client_1.createClient,
+};
+var rows_1 = require("./rows");
+Object.defineProperty(exports, "Row", { enumerable: true, get: function () { return rows_1.Row; } });
+Object.defineProperty(exports, "Rows", { enumerable: true, get: function () { return rows_1.Rows; } });
+var settings_1 = require("./settings");
+Object.defineProperty(exports, "SettingsMap", { enumerable: true, get: function () { return settings_1.SettingsMap; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAuC;AAE9B,6FAFA,qBAAY,OAEA;AACrB,kBAAe;IACb,YAAY,EAAZ,qBAAY;CACb,CAAA;AAWD,+BAAkC;AAAzB,2FAAA,GAAG,OAAA;AAAE,4FAAA,IAAI,OAAA;AAQlB,uCAAwC;AAA/B,uGAAA,WAAW,OAAA"}

package/dist/logger.d.ts

@@ -0,0 +1,8 @@
+export declare class Logger {
+    readonly enabled: boolean;
+    constructor(enabled?: boolean);
+    debug(message: string): void;
+    info(message: string): void;
+    warning(message: string): void;
+    error(message: string): void;
+}

package/dist/logger.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+class Logger {
+    constructor(enabled = false) {
+        Object.defineProperty(this, "enabled", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: enabled
+        });
+    }
+    debug(message) {
+        if (!this.enabled)
+            return;
+        console.log(message);
+    }
+    info(message) {
+        if (!this.enabled)
+            return;
+        console.log(message);
+    }
+    warning(message) {
+        if (!this.enabled)
+            return;
+        console.warn(message);
+    }
+    error(message) {
+        if (!this.enabled)
+            return;
+        console.error(message);
+    }
+}
+exports.Logger = Logger;
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;AAAA,MAAa,MAAM;IACjB,YAAqB,UAAU,KAAK;;;;;mBAAf;;IAAkB,CAAC;IAExC,KAAK,CAAC,OAAe;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAM;QACzB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACtB,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAM;QACzB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACtB,CAAC;IAED,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAM;QACzB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACvB,CAAC;IAED,KAAK,CAAC,OAAe;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAM;QACzB,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IACxB,CAAC;CACF;AAtBD,wBAsBC"}

package/dist/rows.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+import Stream from 'stream';
+import { type DataFormat } from './data_formatter';
+export declare class Rows {
+    private _stream;
+    private readonly format;
+    constructor(_stream: Stream.Readable, format: DataFormat);
+    /**
+     * The method waits for all the rows to be fully loaded
+     * and returns the result as a string.
+     *
+     * The method will throw if the underlying stream was already consumed
+     * by calling the other methods
+     */
+    text(): Promise<string>;
+    /**
+     * 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.
+     *
+     * The method will throw if the underlying stream was already consumed
+     * by calling the other methods
+     */
+    json<T>(): Promise<T>;
+    /**
+     * Returns a readable stream of {@link Row}s for responses
+     * in {@link StreamableDataFormat} format.
+     *
+     * The method will throw if called on a response in non-streamable format,
+     * and if the underlying stream was already consumed
+     * by calling the other methods
+     */
+    stream(): Stream.Readable;
+    close(): void;
+}
+export declare class Row {
+    private readonly chunk;
+    private readonly format;
+    constructor(chunk: string, format: DataFormat);
+    /**
+     * Returns a string representation of a row.
+     */
+    text(): string;
+    /**
+     * Returns a JSON representation of a 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;
+}