@clickhouse/client-common 0.2.0-beta1

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 || value === undefined)
+        return '\\N';
+    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":["../../../../packages/client-common/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,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAA;IACvD,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":["../../../../packages/client-common/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", "JSONStrings", "JSONCompact", "JSONCompactStrings", "JSONColumnsWithMetadata", "JSONObjectEachRow", "JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes"];
+declare const supportedRawFormats: readonly ["CSV", "CSVWithNames", "CSVWithNamesAndTypes", "TabSeparated", "TabSeparatedRaw", "TabSeparatedWithNames", "TabSeparatedWithNamesAndTypes", "CustomSeparated", "CustomSeparatedWithNames", "CustomSeparatedWithNamesAndTypes"];
+export type JSONDataFormat = (typeof supportedJSONFormats)[number];
+export type RawDataFormat = (typeof supportedRawFormats)[number];
+export 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"];
+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,96 @@
+"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 singleDocumentJSONFormats = [
+    'JSON',
+    'JSONStrings',
+    'JSONCompact',
+    'JSONCompactStrings',
+    'JSONColumnsWithMetadata',
+    'JSONObjectEachRow',
+];
+const supportedJSONFormats = [
+    ...singleDocumentJSONFormats,
+    ...streamableJSONFormats,
+];
+const supportedRawFormats = [
+    'CSV',
+    'CSVWithNames',
+    'CSVWithNamesAndTypes',
+    'TabSeparated',
+    'TabSeparatedRaw',
+    'TabSeparatedWithNames',
+    'TabSeparatedWithNamesAndTypes',
+    'CustomSeparated',
+    'CustomSeparatedWithNames',
+    'CustomSeparatedWithNamesAndTypes',
+];
+// TODO add others formats
+const streamableFormat = [
+    ...streamableJSONFormats,
+    ...supportedRawFormats,
+];
+function isNotStreamableJSONFamily(format) {
+    // @ts-expect-error JSON is not assignable to notStreamableJSONFormats
+    return singleDocumentJSONFormats.includes(format);
+}
+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 (isNotStreamableJSONFamily(format)) {
+        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 (supportedJSONFormats.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":["../../../../packages/client-common/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,yBAAyB,GAAG;IAChC,MAAM;IACN,aAAa;IACb,aAAa;IACb,oBAAoB;IACpB,yBAAyB;IACzB,mBAAmB;CACX,CAAA;AACV,MAAM,oBAAoB,GAAG;IAC3B,GAAG,yBAAyB;IAC5B,GAAG,qBAAqB;CAChB,CAAA;AACV,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;AAUV,0BAA0B;AAC1B,MAAM,gBAAgB,GAAG;IACvB,GAAG,qBAAqB;IACxB,GAAG,mBAAmB;CACd,CAAA;AAGV,SAAS,yBAAyB,CAChC,MAAkB;IAElB,sEAAsE;IACtE,OAAO,yBAAyB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;AACnD,CAAC;AAED,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,yBAAyB,CAAC,MAAM,CAAC,EAAE;QACrC,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,oBAA0C,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAChE,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":["../../../../packages/client-common/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":["../../../../packages/client-common/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 | Error): ClickHouseError | Error;
+export {};

package/dist/error/parse_error.js

@@ -0,0 +1,41 @@
+"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 inputIsError = input instanceof Error;
+    const message = inputIsError ? input.message : input;
+    const match = message.match(errorRe);
+    const groups = match === null || match === void 0 ? void 0 : match.groups;
+    if (groups) {
+        return new ClickHouseError(groups);
+    }
+    else {
+        return inputIsError ? input : 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":["../../../../packages/client-common/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,KAAqB;IAC9C,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAA;IAC3C,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAA;IACpD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IACpC,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,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;KAC/C;AACH,CAAC;AAVD,gCAUC"}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/** Should be re-exported by the implementation */
+export { type BaseClickHouseClientConfigOptions, type ClickHouseClientConfigOptions, type BaseQueryParams, type QueryParams, type ExecParams, type InsertParams, type InsertValues, ClickHouseClient, type CommandParams, type CommandResult, type ExecResult, type InsertResult, } from './client';
+export type { Row, BaseResultSet } from './result';
+export { type DataFormat } from './data_formatter';
+export { ClickHouseError } from './error';
+export { ClickHouseLogLevel, type ErrorLogParams, type Logger, type LogParams, } from './logger';
+export type { ResponseJSON, InputJSON, InputJSONObjectEachRow, } from './clickhouse_types';
+export { type ClickHouseSettings, type MergeTreeSettings, SettingsMap, } from './settings';
+/** For implementations usage only */
+export { encodeJSON, isSupportedRawFormat, decode, validateStreamFormat, } from './data_formatter';
+export { type ValuesEncoder, type MakeResultSet, type MakeConnection, } from './client';
+export { withCompressionHeaders, isSuccessfulResponse, toSearchParams, transformUrl, withHttpSettings, } from './utils';
+export { LogWriter, DefaultLogger } from './logger';
+export { parseError } from './error';
+export type { Connection, ConnectionParams, ConnInsertResult, ConnExecResult, ConnQueryResult, ConnBaseQueryParams, ConnBaseResult, ConnInsertParams, } from './connection';
+export { type RawDataFormat, type JSONDataFormat, formatQuerySettings, formatQueryParams, } from './data_formatter';

package/dist/index.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatQueryParams = exports.formatQuerySettings = exports.parseError = exports.DefaultLogger = exports.LogWriter = exports.withHttpSettings = exports.transformUrl = exports.toSearchParams = exports.isSuccessfulResponse = exports.withCompressionHeaders = exports.validateStreamFormat = exports.decode = exports.isSupportedRawFormat = exports.encodeJSON = exports.SettingsMap = exports.ClickHouseLogLevel = exports.ClickHouseError = exports.ClickHouseClient = void 0;
+/** Should be re-exported by the implementation */
+var client_1 = require("./client");
+Object.defineProperty(exports, "ClickHouseClient", { enumerable: true, get: function () { return client_1.ClickHouseClient; } });
+var error_1 = require("./error");
+Object.defineProperty(exports, "ClickHouseError", { enumerable: true, get: function () { return error_1.ClickHouseError; } });
+var logger_1 = require("./logger");
+Object.defineProperty(exports, "ClickHouseLogLevel", { enumerable: true, get: function () { return logger_1.ClickHouseLogLevel; } });
+var settings_1 = require("./settings");
+Object.defineProperty(exports, "SettingsMap", { enumerable: true, get: function () { return settings_1.SettingsMap; } });
+/** For implementations usage only */
+var data_formatter_1 = require("./data_formatter");
+Object.defineProperty(exports, "encodeJSON", { enumerable: true, get: function () { return data_formatter_1.encodeJSON; } });
+Object.defineProperty(exports, "isSupportedRawFormat", { enumerable: true, get: function () { return data_formatter_1.isSupportedRawFormat; } });
+Object.defineProperty(exports, "decode", { enumerable: true, get: function () { return data_formatter_1.decode; } });
+Object.defineProperty(exports, "validateStreamFormat", { enumerable: true, get: function () { return data_formatter_1.validateStreamFormat; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "withCompressionHeaders", { enumerable: true, get: function () { return utils_1.withCompressionHeaders; } });
+Object.defineProperty(exports, "isSuccessfulResponse", { enumerable: true, get: function () { return utils_1.isSuccessfulResponse; } });
+Object.defineProperty(exports, "toSearchParams", { enumerable: true, get: function () { return utils_1.toSearchParams; } });
+Object.defineProperty(exports, "transformUrl", { enumerable: true, get: function () { return utils_1.transformUrl; } });
+Object.defineProperty(exports, "withHttpSettings", { enumerable: true, get: function () { return utils_1.withHttpSettings; } });
+var logger_2 = require("./logger");
+Object.defineProperty(exports, "LogWriter", { enumerable: true, get: function () { return logger_2.LogWriter; } });
+Object.defineProperty(exports, "DefaultLogger", { enumerable: true, get: function () { return logger_2.DefaultLogger; } });
+var error_2 = require("./error");
+Object.defineProperty(exports, "parseError", { enumerable: true, get: function () { return error_2.parseError; } });
+var data_formatter_2 = require("./data_formatter");
+Object.defineProperty(exports, "formatQuerySettings", { enumerable: true, get: function () { return data_formatter_2.formatQuerySettings; } });
+Object.defineProperty(exports, "formatQueryParams", { enumerable: true, get: function () { return data_formatter_2.formatQueryParams; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/client-common/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,mCAaiB;AALf,0GAAA,gBAAgB,OAAA;AAQlB,iCAAyC;AAAhC,wGAAA,eAAe,OAAA;AACxB,mCAKiB;AAJf,4GAAA,kBAAkB,OAAA;AAUpB,uCAImB;AADjB,uGAAA,WAAW,OAAA;AAGb,qCAAqC;AACrC,mDAKyB;AAJvB,4GAAA,UAAU,OAAA;AACV,sHAAA,oBAAoB,OAAA;AACpB,wGAAA,MAAM,OAAA;AACN,sHAAA,oBAAoB,OAAA;AAOtB,iCAMgB;AALd,+GAAA,sBAAsB,OAAA;AACtB,6GAAA,oBAAoB,OAAA;AACpB,uGAAA,cAAc,OAAA;AACd,qGAAA,YAAY,OAAA;AACZ,yGAAA,gBAAgB,OAAA;AAElB,mCAAmD;AAA1C,mGAAA,SAAS,OAAA;AAAE,uGAAA,aAAa,OAAA;AACjC,iCAAoC;AAA3B,mGAAA,UAAU,OAAA;AAWnB,mDAKyB;AAFvB,qHAAA,mBAAmB,OAAA;AACnB,mHAAA,iBAAiB,OAAA"}

package/dist/logger.d.ts

@@ -0,0 +1,40 @@
+export interface LogParams {
+    module: string;
+    message: string;
+    args?: Record<string, unknown>;
+}
+export type ErrorLogParams = LogParams & {
+    err: Error;
+};
+export interface Logger {
+    trace(params: LogParams): void;
+    debug(params: LogParams): void;
+    info(params: LogParams): void;
+    warn(params: LogParams): void;
+    error(params: ErrorLogParams): void;
+}
+export declare class DefaultLogger implements Logger {
+    trace({ module, message, args }: LogParams): void;
+    debug({ module, message, args }: LogParams): void;
+    info({ module, message, args }: LogParams): void;
+    warn({ module, message, args }: LogParams): void;
+    error({ module, message, args, err }: ErrorLogParams): void;
+}
+export declare class LogWriter {
+    private readonly logger;
+    private readonly logLevel;
+    constructor(logger: Logger, logLevel?: ClickHouseLogLevel);
+    trace(params: LogParams): void;
+    debug(params: LogParams): void;
+    info(params: LogParams): void;
+    warn(params: LogParams): void;
+    error(params: ErrorLogParams): void;
+}
+export declare enum ClickHouseLogLevel {
+    TRACE = 0,
+    DEBUG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4,
+    OFF = 127
+}

package/dist/logger.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClickHouseLogLevel = exports.LogWriter = exports.DefaultLogger = void 0;
+class DefaultLogger {
+    trace({ module, message, args }) {
+        console.trace(formatMessage({ module, message }), args);
+    }
+    debug({ module, message, args }) {
+        console.debug(formatMessage({ module, message }), args);
+    }
+    info({ module, message, args }) {
+        console.info(formatMessage({ module, message }), args);
+    }
+    warn({ module, message, args }) {
+        console.warn(formatMessage({ module, message }), args);
+    }
+    error({ module, message, args, err }) {
+        console.error(formatMessage({ module, message }), args, err);
+    }
+}
+exports.DefaultLogger = DefaultLogger;
+class LogWriter {
+    constructor(logger, logLevel) {
+        Object.defineProperty(this, "logger", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: logger
+        });
+        Object.defineProperty(this, "logLevel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.logLevel = logLevel !== null && logLevel !== void 0 ? logLevel : ClickHouseLogLevel.OFF;
+        this.info({
+            module: 'Logger',
+            message: `Log level is set to ${ClickHouseLogLevel[this.logLevel]}`,
+        });
+    }
+    trace(params) {
+        if (this.logLevel <= ClickHouseLogLevel.TRACE) {
+            this.logger.trace(params);
+        }
+    }
+    debug(params) {
+        if (this.logLevel <= ClickHouseLogLevel.DEBUG) {
+            this.logger.debug(params);
+        }
+    }
+    info(params) {
+        if (this.logLevel <= ClickHouseLogLevel.INFO) {
+            this.logger.info(params);
+        }
+    }
+    warn(params) {
+        if (this.logLevel <= ClickHouseLogLevel.WARN) {
+            this.logger.warn(params);
+        }
+    }
+    error(params) {
+        if (this.logLevel <= ClickHouseLogLevel.ERROR) {
+            this.logger.error(params);
+        }
+    }
+}
+exports.LogWriter = LogWriter;
+var ClickHouseLogLevel;
+(function (ClickHouseLogLevel) {
+    ClickHouseLogLevel[ClickHouseLogLevel["TRACE"] = 0] = "TRACE";
+    ClickHouseLogLevel[ClickHouseLogLevel["DEBUG"] = 1] = "DEBUG";
+    ClickHouseLogLevel[ClickHouseLogLevel["INFO"] = 2] = "INFO";
+    ClickHouseLogLevel[ClickHouseLogLevel["WARN"] = 3] = "WARN";
+    ClickHouseLogLevel[ClickHouseLogLevel["ERROR"] = 4] = "ERROR";
+    ClickHouseLogLevel[ClickHouseLogLevel["OFF"] = 127] = "OFF";
+})(ClickHouseLogLevel = exports.ClickHouseLogLevel || (exports.ClickHouseLogLevel = {}));
+function formatMessage({ module, message, }) {
+    return `[@clickhouse/client][${module}] ${message}`;
+}
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../packages/client-common/src/logger.ts"],"names":[],"mappings":";;;AAcA,MAAa,aAAa;IACxB,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAa;QACxC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAA;IACzD,CAAC;IAED,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAa;QACxC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAA;IACzD,CAAC;IAED,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAa;QACvC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAA;IACxD,CAAC;IAED,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAa;QACvC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAkB;QAClD,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;IAC9D,CAAC;CACF;AApBD,sCAoBC;AACD,MAAa,SAAS;IAEpB,YAA6B,MAAc,EAAE,QAA6B;;;;;mBAA7C;;QAD7B;;;;;WAA6C;QAE3C,IAAI,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,kBAAkB,CAAC,GAAG,CAAA;QAClD,IAAI,CAAC,IAAI,CAAC;YACR,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,uBAAuB,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;SACpE,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAiB;QACrB,IAAI,IAAI,CAAC,QAAQ,IAAK,kBAAkB,CAAC,KAAgB,EAAE;YACzD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;SAC1B;IACH,CAAC;IAED,KAAK,CAAC,MAAiB;QACrB,IAAI,IAAI,CAAC,QAAQ,IAAK,kBAAkB,CAAC,KAAgB,EAAE;YACzD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;SAC1B;IACH,CAAC;IAED,IAAI,CAAC,MAAiB;QACpB,IAAI,IAAI,CAAC,QAAQ,IAAK,kBAAkB,CAAC,IAAe,EAAE;YACxD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;SACzB;IACH,CAAC;IAED,IAAI,CAAC,MAAiB;QACpB,IAAI,IAAI,CAAC,QAAQ,IAAK,kBAAkB,CAAC,IAAe,EAAE;YACxD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;SACzB;IACH,CAAC;IAED,KAAK,CAAC,MAAsB;QAC1B,IAAI,IAAI,CAAC,QAAQ,IAAK,kBAAkB,CAAC,KAAgB,EAAE;YACzD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;SAC1B;IACH,CAAC;CACF;AAvCD,8BAuCC;AAED,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,6DAAS,CAAA;IACT,6DAAS,CAAA;IACT,2DAAQ,CAAA;IACR,2DAAQ,CAAA;IACR,6DAAS,CAAA;IACT,2DAAS,CAAA;AACX,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B;AAED,SAAS,aAAa,CAAC,EACrB,MAAM,EACN,OAAO,GAIR;IACC,OAAO,wBAAwB,MAAM,KAAK,OAAO,EAAE,CAAA;AACrD,CAAC"}

package/dist/result.d.ts

@@ -0,0 +1,46 @@
+export interface Row {
+    /** 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;
+}
+export interface BaseResultSet<Stream> {
+    /**
+     * The method waits for all the rows to be fully loaded
+     * and returns the result as a string.
+     *
+     * The method should 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 should throw if the underlying stream was already consumed
+     * by calling the other methods.
+     */
+    json<T>(): Promise<T>;
+    /**
+     * Returns a readable stream for responses that can be streamed
+     * (i.e. all except JSON).
+     *
+     * Every iteration provides an array of {@link Row} instances
+     * for {@link StreamableDataFormat} format.
+     *
+     * Should be called only once.
+     *
+     * The method should 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;
+    /** Close the underlying stream. */
+    close(): void;
+    /** ClickHouse server QueryID. */
+    query_id: string;
+}

package/dist/result.js

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

package/dist/result.js.map

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