@hypequery/clickhouse 1.6.0 → 1.6.1

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <h1>@hypequery/clickhouse</h1>
-  <p>A typescript-first library for building type-safe dashboards with ClickHouse</p>
+  <p>A TypeScript-first query builder for ClickHouse and the foundation of the hypequery path.</p>
   
   [![GitHub license](https://img.shields.io/github/license/hypequery/hypequery)](https://github.com/hypequery/hypequery/blob/main/LICENSE)
   [![npm version](https://badge.fury.io/js/@hypequery%2Fclickhouse.svg)](https://badge.fury.io/js/@hypequery%2Fclickhouse)
@@ -10,7 +10,7 @@
 
 ## Overview
 
-hypequery is a typescript-first query builder for ClickHouse designed specifically for building type-safe analytics dashboards. Unlike generic SQL query builders, hypequery understands your ClickHouse schema and provides full type checking, making it ideal for data-intensive applications.
+`@hypequery/clickhouse` is the first step in the main hypequery flow. Generate types from your ClickHouse schema, build typed queries locally, then promote important queries into `query({ ... })` and `serve({ queries })` when they need to be reused across your app.
 
 ## Features
 
@@ -41,6 +41,13 @@ npm install @hypequery/clickhouse @clickhouse/client-web
 
 ## Quick Start
 
+Main path:
+
+1. Generate schema types
+2. Create a typed `db` with `createQueryBuilder(...)`
+3. Build and execute queries locally
+4. Add `@hypequery/serve` later if a query needs a reusable contract or HTTP surface
+
 ### Node.js Environments
 
 ```typescript
@@ -126,18 +133,15 @@ const rows = await db
 await db.cache.invalidateTags(['users']);
 ```
 
-Use `.cache()` to attach defaults to a fluent chain, pass `execute({ cache: { ... } })` for one-off overrides, or call `db.cache.*` for manual invalidation. For a deep dive on cache modes, invalidation, advanced serialization, and bring-your-own-provider recipes (Redis/Upstash, compression, etc.), see the [Caching guide](https://hypequery.com/docs/features/caching).
+Use `.cache()` to attach defaults to a fluent chain, pass `execute({ cache: { ... } })` for one-off overrides, or call `db.cache.*` for manual invalidation. For a deep dive on cache modes, invalidation, advanced serialization, and bring-your-own-provider recipes (Redis/Upstash, compression, etc.), see the [Caching guide](https://hypequery.com/docs/caching).
 
 ## Schema Generation
 
-hypequery provides a CLI tool to generate TypeScript types from your ClickHouse schema:
+Use the hypequery CLI to generate TypeScript types from your ClickHouse schema:
 
 ```bash
-# Install globally (optional)
-npm install -g @hypequery/clickhouse
-
-# Generate schema types
-npx hypequery-generate-types --host your-clickhouse-host --database your-database
+npm install -D @hypequery/cli
+npx hypequery generate
 ```
 
 This creates a `generated-schema.ts` file that you can import in your application:
@@ -278,12 +282,13 @@ hypequery follows semantic versioning and provides multiple release channels:
 
 ## Documentation
 
-For detailed documentation and examples, visit our [documentation site](https://hypequery.com/docs).
+For detailed documentation and examples, visit the main docs flow.
 
-- [Getting Started](https://hypequery.com/docs/installation)
-- [Query Building](https://hypequery.com/docs/guides/query-building)
-- [Filtering](https://hypequery.com/docs/guides/filtering)
-- [API Reference](https://hypequery.com/docs/reference/api)
+- [Quick Start](https://hypequery.com/docs/quick-start)
+- [Core Concepts](https://hypequery.com/docs/core-concepts)
+- [Query Building](https://hypequery.com/docs/query-building/basics)
+- [Filtering](https://hypequery.com/docs/query-building/where)
+- [API Reference](https://hypequery.com/docs/reference/query-builder)
 
 
 ## Troubleshooting

package/dist/cli/generate-types.js

@@ -23,7 +23,7 @@ dotenv.config();
  * @param {string} type - The ClickHouse type to convert
  * @returns {string} - The corresponding TypeScript type
  */
-const clickhouseToTsType = (type) => {
+export const clickhouseToTsType = (type) => {
   if (type.startsWith('Array(')) {
     const innerType = type.slice(6, -1);
     return `Array<${clickhouseToTsType(innerType)}>`;
@@ -44,14 +44,6 @@ const clickhouseToTsType = (type) => {
       const keyType = mapContent.substring(0, commaIndex).trim();
       const valueType = mapContent.substring(commaIndex + 1).trim();
 
-      // Handle different key types
-      let keyTsType = 'string';
-      if (keyType === 'LowCardinality(String)') {
-        keyTsType = 'string';
-      } else if (keyType.includes('Int') || keyType.includes('UInt')) {
-        keyTsType = 'number';
-      }
-
       // Handle different value types
       let valueTsType = 'unknown';
       if (valueType.startsWith('Array(')) {
@@ -64,7 +56,8 @@ const clickhouseToTsType = (type) => {
         valueTsType = clickhouseToTsType(valueType);
       }
 
-      return `Record<${keyTsType}, ${valueTsType}>`;
+      // JSON object keys are strings even when ClickHouse map keys are numeric.
+      return `Record<string, ${valueTsType}>`;
     }
     return 'Record<string, unknown>';
   }
@@ -77,11 +70,11 @@ const clickhouseToTsType = (type) => {
     case 'int16':
     case 'int32':
     case 'uint8':
-    case 'int64':
     case 'uint16':
     case 'uint32':
-    case 'uint64':
       return 'number';
+    case 'int64':
+    case 'uint64':
     case 'uint128':
     case 'uint256':
     case 'int128':

package/dist/core/adapters/clickhouse-adapter.d.ts

@@ -0,0 +1,14 @@
+import type { DatabaseAdapter, QueryExecutionOptions } from './database-adapter.js';
+import type { ClickHouseConfig } from '../query-builder.js';
+export declare class ClickHouseAdapter implements DatabaseAdapter {
+    private config;
+    readonly name = "clickhouse";
+    readonly namespace?: string;
+    private client;
+    constructor(config: ClickHouseConfig);
+    query<T>(sql: string, params?: unknown[], options?: QueryExecutionOptions): Promise<T[]>;
+    stream<T>(sql: string, params?: unknown[], options?: QueryExecutionOptions): Promise<ReadableStream<T[]>>;
+    render(sql: string, params?: unknown[]): string;
+}
+export declare function createClickHouseAdapter(config: ClickHouseConfig): DatabaseAdapter;
+//# sourceMappingURL=clickhouse-adapter.d.ts.map

package/dist/core/adapters/clickhouse-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clickhouse-adapter.d.ts","sourceRoot":"","sources":["../../../src/core/adapters/clickhouse-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAGpF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AA2B5D,qBAAa,iBAAkB,YAAW,eAAe;IAK3C,OAAO,CAAC,MAAM;IAJ1B,QAAQ,CAAC,IAAI,gBAAgB;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,MAAM,CAAmB;gBAEb,MAAM,EAAE,gBAAgB;IAKtC,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAW5F,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC;IAYnH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO,GAAG,MAAM;CAGpD;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,gBAAgB,GAAG,eAAe,CAEjF"}

package/dist/core/adapters/clickhouse-adapter.js

@@ -0,0 +1,58 @@
+import { isClientConfig } from '../query-builder.js';
+import { substituteParameters } from '../utils.js';
+import { createJsonEachRowStream } from '../utils/streaming-helpers.js';
+import { getAutoClientModule } from '../env/auto-client.js';
+function createClickHouseClient(config) {
+    if (isClientConfig(config)) {
+        return config.client;
+    }
+    const clientModule = getAutoClientModule();
+    return clientModule.createClient(config);
+}
+function deriveNamespace(config) {
+    if ('client' in config && config.client) {
+        return 'client';
+    }
+    const host = 'host' in config ? config.host : 'unknown-host';
+    const database = 'database' in config ? config.database : 'default';
+    const username = 'username' in config ? config.username : 'default';
+    return `${host || 'unknown-host'}|${database || 'default'}|${username || 'default'}`;
+}
+export class ClickHouseAdapter {
+    config;
+    name = 'clickhouse';
+    namespace;
+    client;
+    constructor(config) {
+        this.config = config;
+        this.namespace = deriveNamespace(config);
+        this.client = createClickHouseClient(config);
+    }
+    async query(sql, params = [], options) {
+        const finalSQL = substituteParameters(sql, params);
+        const result = await this.client.query({
+            query: finalSQL,
+            format: 'JSONEachRow',
+            clickhouse_settings: options?.clickhouseSettings,
+            query_id: options?.queryId,
+        });
+        return result.json();
+    }
+    async stream(sql, params = [], options) {
+        const finalSQL = substituteParameters(sql, params);
+        const result = await this.client.query({
+            query: finalSQL,
+            format: 'JSONEachRow',
+            clickhouse_settings: options?.clickhouseSettings,
+            query_id: options?.queryId,
+        });
+        const stream = result.stream();
+        return createJsonEachRowStream(stream);
+    }
+    render(sql, params = []) {
+        return substituteParameters(sql, params);
+    }
+}
+export function createClickHouseAdapter(config) {
+    return new ClickHouseAdapter(config);
+}

package/dist/core/adapters/database-adapter.d.ts

@@ -0,0 +1,13 @@
+import type { ClickHouseSettings } from '@clickhouse/client-common';
+export interface QueryExecutionOptions {
+    clickhouseSettings?: ClickHouseSettings;
+    queryId?: string;
+}
+export interface DatabaseAdapter {
+    readonly name: string;
+    readonly namespace?: string;
+    query<T>(sql: string, params?: unknown[], options?: QueryExecutionOptions): Promise<T[]>;
+    stream?<T>(sql: string, params?: unknown[], options?: QueryExecutionOptions): Promise<ReadableStream<T[]>>;
+    render?(sql: string, params?: unknown[]): string;
+}
+//# sourceMappingURL=database-adapter.d.ts.map

package/dist/core/adapters/database-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"database-adapter.d.ts","sourceRoot":"","sources":["../../../src/core/adapters/database-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IACzF,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3G,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;CAClD"}

package/dist/core/adapters/database-adapter.js

@@ -0,0 +1 @@
+export {};

package/dist/core/cache/cache-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache-manager.d.ts","sourceRoot":"","sources":["../../../src/core/cache/cache-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AA6DnF,wBAAsB,gBAAgB,CACpC,MAAM,SAAS,gBAAgB,CAAC,MAAM,CAAC,EACvC,KAAK,SAAS,eAAe,EAE7B,OAAO,EAAE,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CA0J5B"}
+{"version":3,"file":"cache-manager.d.ts","sourceRoot":"","sources":["../../../src/core/cache/cache-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AA4DnF,wBAAsB,gBAAgB,CACpC,MAAM,SAAS,gBAAgB,CAAC,MAAM,CAAC,EACvC,KAAK,SAAS,eAAe,EAE7B,OAAO,EAAE,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CA4J5B"}

package/dist/core/cache/cache-manager.js

@@ -14,11 +14,10 @@ function deriveTags(builder) {
     joins.forEach(join => tags.add(join.table));
     return Array.from(tags);
 }
-async function logCacheHit({ sql, parameters, status, cacheKey, options, rowCount, ageMs, queryId }) {
-    const finalSQL = substituteParameters(sql, parameters);
+async function logCacheHit({ renderSql, parameters, status, cacheKey, options, rowCount, ageMs, queryId }) {
     const timestamp = Date.now();
     logger.logQuery({
-        query: finalSQL,
+        query: renderSql,
         parameters,
         startTime: timestamp,
         endTime: timestamp,
@@ -46,13 +45,15 @@ export async function executeWithCache(builder, options) {
     }
     const activeProvider = provider;
     const { sql, parameters } = builder.toSQLWithParams();
+    const adapter = builder.getAdapter();
+    const renderSql = adapter.render ? adapter.render(sql, parameters) : substituteParameters(sql, parameters);
     const tableName = builder.getTableName();
     const namespace = mergedOptions.namespace || runtime.namespace;
     const key = mergedOptions.key || computeCacheKey({
         namespace,
         sql,
         parameters,
-        settings: builder.getConfig().settings ? { settings: builder.getConfig().settings } : undefined,
+        settings: builder.getConfig().settings,
         version: runtime.versionTag,
         tableName
     });
@@ -82,7 +83,7 @@ export async function executeWithCache(builder, options) {
             runtime.stats.staleHits += 1;
         }
         await logCacheHit({
-            sql,
+            renderSql,
             parameters,
             status,
             cacheKey: key,

package/dist/core/dialects/clickhouse-dialect.d.ts

@@ -0,0 +1,10 @@
+import type { QueryConfig } from '../../types/index.js';
+import type { CompileQueryContext, SqlDialect } from './sql-dialect.js';
+export declare class ClickHouseDialect implements SqlDialect {
+    readonly name = "clickhouse";
+    private formatter;
+    compileQuery(config: QueryConfig<any, any>, context: CompileQueryContext): string;
+    formatTimeInterval(column: string, interval: string, method: string): string;
+    formatSettings(settings: Record<string, unknown>): string;
+}
+//# sourceMappingURL=clickhouse-dialect.d.ts.map

package/dist/core/dialects/clickhouse-dialect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clickhouse-dialect.d.ts","sourceRoot":"","sources":["../../../src/core/dialects/clickhouse-dialect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAExE,qBAAa,iBAAkB,YAAW,UAAU;IAClD,QAAQ,CAAC,IAAI,gBAAgB;IAC7B,OAAO,CAAC,SAAS,CAAsB;IAEvC,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,mBAAmB,GAAG,MAAM;IAyCjF,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAQ5E,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;CAK1D"}

package/dist/core/dialects/clickhouse-dialect.js

@@ -0,0 +1,47 @@
+import { SQLFormatter } from '../formatters/sql-formatter.js';
+export class ClickHouseDialect {
+    name = 'clickhouse';
+    formatter = new SQLFormatter();
+    compileQuery(config, context) {
+        const parts = [];
+        if (config.ctes?.length) {
+            parts.push(`WITH ${config.ctes.join(', ')}`);
+        }
+        parts.push(`SELECT ${this.formatter.formatSelect(config)}`);
+        parts.push(`FROM ${context.tableName}`);
+        if (config.joins?.length) {
+            parts.push(this.formatter.formatJoins(config));
+        }
+        if (config.where?.length) {
+            parts.push(`WHERE ${this.formatter.formatWhere(config)}`);
+        }
+        if (config.groupBy?.length) {
+            parts.push(`GROUP BY ${this.formatter.formatGroupBy(config)}`);
+        }
+        if (config.having?.length) {
+            parts.push(`HAVING ${config.having.join(' AND ')}`);
+        }
+        if (config.orderBy?.length) {
+            const orderBy = config.orderBy
+                .map(({ column, direction }) => `${String(column)} ${direction}`.trim())
+                .join(', ');
+            parts.push(`ORDER BY ${orderBy}`);
+        }
+        if (config.limit) {
+            const offsetClause = config.offset ? `OFFSET ${config.offset}` : '';
+            parts.push(`LIMIT ${config.limit} ${offsetClause}`);
+        }
+        return parts.join(' ').trim();
+    }
+    formatTimeInterval(column, interval, method) {
+        if (method === 'toStartOfInterval') {
+            return `${method}(${column}, INTERVAL ${interval})`;
+        }
+        return `${method}(${column})`;
+    }
+    formatSettings(settings) {
+        return Object.entries(settings)
+            .map(([key, value]) => `${key}=${value}`)
+            .join(', ');
+    }
+}

package/dist/core/dialects/sql-dialect.d.ts

@@ -0,0 +1,11 @@
+import type { QueryConfig } from '../../types/index.js';
+export interface CompileQueryContext {
+    tableName: string;
+}
+export interface SqlDialect {
+    readonly name: string;
+    compileQuery(config: QueryConfig<any, any>, context: CompileQueryContext): string;
+    formatTimeInterval(column: string, interval: string, method: string): string;
+    formatSettings(settings: Record<string, unknown>): string;
+}
+//# sourceMappingURL=sql-dialect.d.ts.map

package/dist/core/dialects/sql-dialect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-dialect.d.ts","sourceRoot":"","sources":["../../../src/core/dialects/sql-dialect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExD,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,mBAAmB,GAAG,MAAM,CAAC;IAClF,kBAAkB,CAChB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GACb,MAAM,CAAC;IACV,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;CAC3D"}

package/dist/core/dialects/sql-dialect.js

@@ -0,0 +1 @@
+export {};

package/dist/core/features/aggregations.d.ts

@@ -20,7 +20,7 @@ export declare class AggregationFeature<Schema extends SchemaDefinition<Schema>,
         parameters?: any[];
         ctes?: string[];
         unionQueries?: string[];
-        settings?: string;
+        settings?: import("@clickhouse/client-common").ClickHouseSettings;
     };
     count(column: string, alias: string): {
         select: string[];
@@ -38,7 +38,7 @@ export declare class AggregationFeature<Schema extends SchemaDefinition<Schema>,
         parameters?: any[];
         ctes?: string[];
         unionQueries?: string[];
-        settings?: string;
+        settings?: import("@clickhouse/client-common").ClickHouseSettings;
     };
     avg(column: string, alias: string): {
         select: string[];
@@ -56,7 +56,7 @@ export declare class AggregationFeature<Schema extends SchemaDefinition<Schema>,
         parameters?: any[];
         ctes?: string[];
         unionQueries?: string[];
-        settings?: string;
+        settings?: import("@clickhouse/client-common").ClickHouseSettings;
     };
     min(column: string, alias: string): {
         select: string[];
@@ -74,7 +74,7 @@ export declare class AggregationFeature<Schema extends SchemaDefinition<Schema>,
         parameters?: any[];
         ctes?: string[];
         unionQueries?: string[];
-        settings?: string;
+        settings?: import("@clickhouse/client-common").ClickHouseSettings;
     };
     max(column: string, alias: string): {
         select: string[];
@@ -92,7 +92,7 @@ export declare class AggregationFeature<Schema extends SchemaDefinition<Schema>,
         parameters?: any[];
         ctes?: string[];
         unionQueries?: string[];
-        settings?: string;
+        settings?: import("@clickhouse/client-common").ClickHouseSettings;
     };
 }
 //# sourceMappingURL=aggregations.d.ts.map