@clickhouse/client-common 0.3.1 → 1.0.1

package/dist/result.d.ts

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

package/dist/settings.d.ts

@@ -1577,7 +1577,7 @@ interface ClickHouseHTTPSettings {
     wait_end_of_query: Bool;
     default_format: DataFormat;
 }
-export type ClickHouseSettings = Partial<ClickHouseServerSettings> & Partial<ClickHouseHTTPSettings>;
+export type ClickHouseSettings = Partial<ClickHouseServerSettings> & Partial<ClickHouseHTTPSettings> & Record<string, number | string | boolean | SettingsMap | undefined>;
 export interface MergeTreeSettings {
     /** Allow floating point as partition key */
     allow_floating_point_partition_key?: Bool;

package/dist/settings.js.map

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

package/dist/ts_utils.d.ts

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

package/dist/ts_utils.js

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

package/dist/ts_utils.js.map

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

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

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

package/dist/utils/index.js.map

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

package/dist/utils/url.js.map

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

package/dist/version.d.ts

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

package/dist/version.js

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

package/package.json

@@ -2,7 +2,7 @@
   "name": "@clickhouse/client-common",
   "description": "Official JS client for ClickHouse DB - common types",
   "homepage": "https://clickhouse.com",
-  "version": "0.3.1",
+  "version": "1.0.1",
   "license": "Apache-2.0",
   "keywords": [
     "clickhouse",

package/dist/utils/permutations.d.ts

@@ -1 +0,0 @@
-export declare function permutations<T>(args: T[], n: number, prefix?: T[]): T[][];

package/dist/utils/permutations.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.permutations = void 0;
-// adjusted from https://stackoverflow.com/a/64414875/4575540
-function permutations(args, n, prefix = []) {
-    if (n === 0) {
-        return [prefix];
-    }
-    return args.flatMap((arg, i) => permutations(args.slice(i + 1), n - 1, [...prefix, arg]));
-}
-exports.permutations = permutations;
-//# sourceMappingURL=permutations.js.map

package/dist/utils/permutations.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"permutations.js","sourceRoot":"","sources":["../../../../packages/client-common/src/utils/permutations.ts"],"names":[],"mappings":";;;AAAA,6DAA6D;AAC7D,SAAgB,YAAY,CAAI,IAAS,EAAE,CAAS,EAAE,SAAc,EAAE;IACpE,IAAI,CAAC,KAAK,CAAC,EAAE;QACX,OAAO,CAAC,MAAM,CAAC,CAAA;KAChB;IACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAC7B,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC,CACzD,CAAA;AACH,CAAC;AAPD,oCAOC"}