@clickhouse/client-common 0.2.0-beta1

package/dist/settings.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * @see {@link https://github.com/ClickHouse/ClickHouse/blob/46ed4f6cdf68fbbdc59fbe0f0bfa9a361cc0dec1/src/Core/Settings.h}
+ * @see {@link https://github.com/ClickHouse/ClickHouse/blob/5f84f06d6d26672da3d97d0b236ebb46b5080989/src/Core/Defines.h}
+ * @see {@link https://github.com/ClickHouse/ClickHouse/blob/eae2667a1c29565c801be0ffd465f8bfcffe77ef/src/Storages/MergeTree/MergeTreeSettings.h}
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsMap = void 0;
+class SettingsMap {
+    constructor(record) {
+        Object.defineProperty(this, "record", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: record
+        });
+    }
+    toString() {
+        return `{${Object.entries(this.record)
+            .map(([k, v]) => `'${k}':'${v}'`)
+            .join(',')}}`;
+    }
+    static from(record) {
+        return new this(record);
+    }
+}
+exports.SettingsMap = SettingsMap;
+//# sourceMappingURL=settings.js.map

package/dist/settings.js.map

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

package/dist/utils/connection.d.ts

@@ -0,0 +1,10 @@
+import type { ClickHouseSettings } from '../settings';
+export type HttpHeader = number | string | string[];
+export type HttpHeaders = Record<string, HttpHeader | undefined>;
+export declare function withCompressionHeaders({ headers, compress_request, decompress_response, }: {
+    headers: HttpHeaders;
+    compress_request: boolean | undefined;
+    decompress_response: boolean | undefined;
+}): Record<string, string>;
+export declare function withHttpSettings(clickhouse_settings?: ClickHouseSettings, compression?: boolean): ClickHouseSettings;
+export declare function isSuccessfulResponse(statusCode?: number): boolean;

package/dist/utils/connection.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSuccessfulResponse = exports.withHttpSettings = exports.withCompressionHeaders = void 0;
+function withCompressionHeaders({ headers, compress_request, decompress_response, }) {
+    return {
+        ...headers,
+        ...(decompress_response ? { 'Accept-Encoding': 'gzip' } : {}),
+        ...(compress_request ? { 'Content-Encoding': 'gzip' } : {}),
+    };
+}
+exports.withCompressionHeaders = withCompressionHeaders;
+function withHttpSettings(clickhouse_settings, compression) {
+    return {
+        ...(compression
+            ? {
+                enable_http_compression: 1,
+            }
+            : {}),
+        ...clickhouse_settings,
+    };
+}
+exports.withHttpSettings = withHttpSettings;
+function isSuccessfulResponse(statusCode) {
+    return Boolean(statusCode && 200 <= statusCode && statusCode < 300);
+}
+exports.isSuccessfulResponse = isSuccessfulResponse;
+//# sourceMappingURL=connection.js.map

package/dist/utils/connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../../../packages/client-common/src/utils/connection.ts"],"names":[],"mappings":";;;AAKA,SAAgB,sBAAsB,CAAC,EACrC,OAAO,EACP,gBAAgB,EAChB,mBAAmB,GAKpB;IACC,OAAO;QACL,GAAG,OAAO;QACV,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5D,CAAA;AACH,CAAC;AAdD,wDAcC;AAED,SAAgB,gBAAgB,CAC9B,mBAAwC,EACxC,WAAqB;IAErB,OAAO;QACL,GAAG,CAAC,WAAW;YACb,CAAC,CAAC;gBACE,uBAAuB,EAAE,CAAC;aAC3B;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,mBAAmB;KACvB,CAAA;AACH,CAAC;AAZD,4CAYC;AAED,SAAgB,oBAAoB,CAAC,UAAmB;IACtD,OAAO,OAAO,CAAC,UAAU,IAAI,GAAG,IAAI,UAAU,IAAI,UAAU,GAAG,GAAG,CAAC,CAAA;AACrE,CAAC;AAFD,oDAEC"}

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

@@ -0,0 +1,20 @@
+"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);
+__exportStar(require("./string"), exports);
+__exportStar(require("./url"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

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

package/dist/utils/string.d.ts

@@ -0,0 +1 @@
+export declare function replaceAll(input: string, replace_char: string, new_char: string): string;

package/dist/utils/string.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceAll = void 0;
+function replaceAll(input, replace_char, new_char) {
+    return input.split(replace_char).join(new_char);
+}
+exports.replaceAll = replaceAll;
+//# sourceMappingURL=string.js.map

package/dist/utils/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../packages/client-common/src/utils/string.ts"],"names":[],"mappings":";;;AAAA,SAAgB,UAAU,CACxB,KAAa,EACb,YAAoB,EACpB,QAAgB;IAEhB,OAAO,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;AACjD,CAAC;AAND,gCAMC"}

package/dist/utils/url.d.ts

@@ -0,0 +1,16 @@
+import type { ClickHouseSettings } from '../settings';
+export declare function transformUrl({ url, pathname, searchParams, }: {
+    url: URL;
+    pathname?: string;
+    searchParams?: URLSearchParams;
+}): URL;
+type ToSearchParamsOptions = {
+    database: string;
+    clickhouse_settings?: ClickHouseSettings;
+    query_params?: Record<string, unknown>;
+    query?: string;
+    session_id?: string;
+    query_id?: string;
+};
+export declare function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, query_id, }: ToSearchParamsOptions): URLSearchParams | undefined;
+export {};

package/dist/utils/url.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toSearchParams = exports.transformUrl = void 0;
+const data_formatter_1 = require("../data_formatter");
+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;
+// TODO validate max length of the resulting query
+// https://stackoverflow.com/questions/812925/what-is-the-maximum-possible-length-of-a-query-string
+function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, query_id, }) {
+    if (clickhouse_settings === undefined &&
+        query_params === undefined &&
+        query === undefined &&
+        database === 'default') {
+        return;
+    }
+    const params = new URLSearchParams();
+    if (query_params !== undefined) {
+        for (const [key, value] of Object.entries(query_params)) {
+            params.set(`param_${key}`, (0, data_formatter_1.formatQueryParams)(value));
+        }
+    }
+    if (clickhouse_settings !== undefined) {
+        for (const [key, value] of Object.entries(clickhouse_settings)) {
+            if (value !== undefined) {
+                params.set(key, (0, data_formatter_1.formatQuerySettings)(value));
+            }
+        }
+    }
+    if (database !== 'default') {
+        params.set('database', database);
+    }
+    if (query) {
+        params.set('query', query);
+    }
+    if (session_id) {
+        params.set('session_id', session_id);
+    }
+    if (query_id) {
+        params.set('query_id', query_id);
+    }
+    return params;
+}
+exports.toSearchParams = toSearchParams;
+//# sourceMappingURL=url.js.map

package/dist/utils/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../../packages/client-common/src/utils/url.ts"],"names":[],"mappings":";;;AACA,sDAA0E;AAE1E,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;AAWD,kDAAkD;AAClD,mGAAmG;AACnG,SAAgB,cAAc,CAAC,EAC7B,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,QAAQ,GACc;IACtB,IACE,mBAAmB,KAAK,SAAS;QACjC,YAAY,KAAK,SAAS;QAC1B,KAAK,KAAK,SAAS;QACnB,QAAQ,KAAK,SAAS,EACtB;QACA,OAAM;KACP;IAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;IAEpC,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YACvD,MAAM,CAAC,GAAG,CAAC,SAAS,GAAG,EAAE,EAAE,IAAA,kCAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;SACrD;KACF;IAED,IAAI,mBAAmB,KAAK,SAAS,EAAE;QACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE;YAC9D,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAA,oCAAmB,EAAC,KAAK,CAAC,CAAC,CAAA;aAC5C;SACF;KACF;IAED,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;KACjC;IAED,IAAI,KAAK,EAAE;QACT,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;KAC3B;IAED,IAAI,UAAU,EAAE;QACd,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,CAAA;KACrC;IAED,IAAI,QAAQ,EAAE;QACZ,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;KACjC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAlDD,wCAkDC"}

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "0.2.0-beta1";
+export default _default;

package/dist/version.js

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

package/dist/version.js.map

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

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@clickhouse/client-common",
+  "description": "Official JS client for ClickHouse DB - common types",
+  "homepage": "https://clickhouse.com",
+  "version": "0.2.0-beta1",
+  "license": "Apache-2.0",
+  "keywords": [
+    "clickhouse",
+    "sql",
+    "client"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ClickHouse/clickhouse-js.git"
+  },
+  "private": false,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {},
+  "devDependencies": {}
+}