@hypequery/clickhouse 1.0.1 → 1.0.3

package/README-CLI.md

@@ -1,4 +1,4 @@
-# HypeQuery TypeScript Generator
+# hypequery TypeScript Generator
 
 This tool automatically generates TypeScript type definitions from your ClickHouse database schema.
 

package/README.md

@@ -1,7 +1,7 @@
-# HypeQuery
+# hypequery
 
 <div align="center">
-  <img src="https://hypequery.dev/img/logo.svg" alt="HypeQuery Logo" width="200"/>
+  <img src="https://hypequery.dev/img/logo.svg" alt="hypequery Logo" width="200"/>
   <h1>@hypequery/clickhouse</h1>
   <p>A typescript-first library for building type-safe dashboards with ClickHouse</p>
   
@@ -10,11 +10,10 @@
   [![GitHub stars](https://img.shields.io/github/stars/lukejreilly/hypequery)](https://github.com/lukejreilly/hypequery/stargazers)
 </div>
 
-> **Note:** This package is published on npm as `@hypequery/core`. The unscoped package `hypequery-core` is unrelated and should not be used.
 
 ## Overview
 
-hypequery is a typescript-first query builder for ClickHouse designed specifically for building real-time, type-safe analytics dashboards. Unlike generic SQL query builders, HypeQuery understands your ClickHouse schema and provides full type checking throughout your codebase, making it ideal for data-intensive applications.
+hypequery is a typescript-first query builder for ClickHouse designed specifically for building real-time, type-safe analytics dashboards. Unlike generic SQL query builders, hypequery understands your ClickHouse schema and provides full type checking throughout your codebase, making it ideal for data-intensive applications.
 
 ## Features
 
@@ -28,21 +27,25 @@ hypequery is a typescript-first query builder for ClickHouse designed specifical
 
 ## Installation
 
+### npm
 ```bash
-# npm
-npm install @hypequery/core
+npm install @hypequery/clickhouse
+```
 
-# yarn
-yarn add @hypequery/core
+### yarn
+```bash
+yarn add @hypequery/clickhouse
+```
 
-# pnpm
-pnpm add @hypequery/core
+### pnpm
+```bash
+pnpm add @hypequery/clickhouse
 ```
 
 ## Quick Start
 
 ```typescript
-import { createQueryBuilder } from '@hypequery/core';
+import { createQueryBuilder } from '@hypequery/clickhouse';
 import type { Schema } from './generated-schema';
 
 // Initialize the query builder
@@ -65,11 +68,11 @@ const results = await db
 
 ## Schema Generation
 
-HypeQuery provides a CLI tool to generate TypeScript types from your ClickHouse schema:
+hypequery provides a CLI tool to generate TypeScript types from your ClickHouse schema:
 
 ```bash
 # Install globally (optional)
-npm install -g @hypequery/core
+npm install -g @hypequery/clickhouse
 
 # Generate schema types
 npx hypequery-generate --host your-clickhouse-host --database your-database
@@ -78,7 +81,7 @@ npx hypequery-generate --host your-clickhouse-host --database your-database
 This creates a `generated-schema.ts` file that you can import in your application:
 
 ```typescript
-import { createQueryBuilder } from '@hypequery/core';
+import { createQueryBuilder } from '@hypequery/clickhouse';
 import type { IntrospectedSchema } from './generated-schema';
 
 const db = createQueryBuilder<IntrospectedSchema>({
@@ -90,7 +93,7 @@ const db = createQueryBuilder<IntrospectedSchema>({
 
 ### Type-Safe Queries
 
-HypeQuery provides full TypeScript support, ensuring your queries are type-safe:
+hypequery provides full TypeScript support, ensuring your queries are type-safe:
 
 ```typescript
 // Column names are type-checked
@@ -108,7 +111,7 @@ db.table('trips').select(['non_existent_column']); // TypeScript error
 Implement interactive dashboards with cross-filtering support:
 
 ```typescript
-import { CrossFilter } from '@hypequery/core';
+import { CrossFilter } from '@hypequery/clickhouse';
 
 // Create a filter
 const filter = new CrossFilter()
@@ -167,7 +170,7 @@ const prevPage = await db.table('trips')
 
 ### Advanced Queries
 
-HypeQuery supports complex queries including joins, aggregations, and subqueries:
+hypequery supports complex queries including joins, aggregations, and subqueries:
 
 ```typescript
 // Aggregations
@@ -224,10 +227,10 @@ const db = createQueryBuilder<Schema>({
 
 ## Versioning and Release Channels
 
-HypeQuery follows semantic versioning and provides multiple release channels:
+hypequery follows semantic versioning and provides multiple release channels:
 
-- **Latest**: Stable releases (`npm install @hypequery/core`)
-- **Beta**: Pre-release versions (`npm install @hypequery/core@beta`)
+- **Latest**: Stable releases (`npm install @hypequery/clickhouse`)
+- **Beta**: Pre-release versions (`npm install @hypequery/clickhouse@beta`)
 
 ## Documentation
 
@@ -243,8 +246,8 @@ For detailed documentation and examples, visit our [documentation site](https://
 
 Check out our example implementations:
 
-- [Example Dashboard](https://github.com/lukejreilly/hypequery/tree/main/examples/example-dashboard): A complete Next.js dashboard with HypeQuery
-- [React Query Integration](https://hypequery.dev/docs/guides/integrations/react-query): Using HypeQuery with React Query
+- [Example Dashboard](https://github.com/lukejreilly/hypequery/tree/main/examples/example-dashboard): A complete Next.js dashboard with hypequery
+- [React Query Integration](https://hypequery.dev/docs/guides/integrations/react-query): Using hypequery with React Query
 - [Time Series Analysis](https://hypequery.dev/docs/guides/timeseries): Building time series analytics
 
 ## Troubleshooting
@@ -272,5 +275,5 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 ---
 
 <div align="center">
-  <sub>Built with ❤️ by the HypeQuery team</sub>
+  <sub>Built with ❤️ by the hypequery team</sub>
 </div> 

package/dist/cli/bin.js

@@ -26,7 +26,7 @@ const colors = {
  */
 function showBanner() {
   console.log(`
-${colors.bright}${colors.cyan}HypeQuery TypeScript Generator${colors.reset}
+${colors.bright}${colors.cyan}hypequery TypeScript Generator${colors.reset}
 ${colors.dim}Generate TypeScript types from your ClickHouse database schema${colors.reset}
   `);
 }

package/dist/cli/generate-types.js

@@ -118,7 +118,8 @@ export interface IntrospectedSchema {`;
 
     typeDefinitions += `\n  ${table.name}: {`;
     for (const column of columns) {
-      typeDefinitions += `\n    ${column.name}: '${clickhouseToTsType(column.type)}';`;
+      const clickHouseType = column.type.replace.replace(/'/g, "\\'"); // Escape single quotes, e.g. `DateTime('UTC')`
+      typeDefinitions += `\n    ${column.name}: '${clickHouseType}';`;
     }
     typeDefinitions += '\n  };';
   }
@@ -177,4 +178,4 @@ export interface IntrospectedSchema {`;
  */
 function capitalizeFirstLetter(str) {
   return str.charAt(0).toUpperCase() + str.slice(1);
-} 
+} 

package/dist/core/tests/integration/setup.js

@@ -4,7 +4,7 @@ import { ClickHouseConnection } from '../../connection';
 import { exec } from 'child_process';
 import { promisify } from 'util';
 import { logger as hypeQueryLogger } from '../../utils/logger';
-// Disable the HypeQuery logger to prevent "logs after tests" errors
+// Disable the hypequery logger to prevent "logs after tests" errors
 // This must be done early in the setup, before any queries run
 hypeQueryLogger.configure({ enabled: false });
 // Setup a logger that respects test environment

package/dist/core/utils/logger.js

@@ -44,22 +44,22 @@ class Logger {
     }
     debug(message, ...args) {
         if (this.shouldLog('debug')) {
-            console.debug(`[HypeQuery Debug] ${message}`, ...args);
+            console.debug(`[hypequery Debug] ${message}`, ...args);
         }
     }
     info(message, ...args) {
         if (this.shouldLog('info')) {
-            console.info(`[HypeQuery Info] ${message}`, ...args);
+            console.info(`[hypequery Info] ${message}`, ...args);
         }
     }
     warn(message, ...args) {
         if (this.shouldLog('warn')) {
-            console.warn(`[HypeQuery Warn] ${message}`, ...args);
+            console.warn(`[hypequery Warn] ${message}`, ...args);
         }
     }
     error(message, ...args) {
         if (this.shouldLog('error')) {
-            console.error(`[HypeQuery Error] ${message}`, ...args);
+            console.error(`[hypequery Error] ${message}`, ...args);
         }
     }
     logQuery(log) {

package/dist/types/clickhouse-types.d.ts

@@ -1,7 +1,7 @@
 export type ClickHouseInteger = 'Int8' | 'Int16' | 'Int32' | 'Int64' | 'Int128' | 'Int256' | 'UInt8' | 'UInt16' | 'UInt32' | 'UInt64' | 'UInt128' | 'UInt256';
 export type ClickHouseFloat = 'Float32' | 'Float64';
 export type ClickHouseDecimal = 'Decimal32' | 'Decimal64' | 'Decimal128' | 'Decimal256' | `Decimal(${number}, ${number})`;
-export type ClickHouseDateTime = 'Date' | 'Date32' | 'DateTime' | `DateTime64(${number})` | `DateTime64(${number}, '${string}')`;
+export type ClickHouseDateTime = 'Date' | 'Date32' | 'DateTime' | `DateTime('${string}')` | `DateTime64(${number})` | `DateTime64(${number}, '${string}')`;
 export type ClickHouseString = 'String' | `FixedString(${number})` | 'UUID';
 export type ClickHouseArray = `Array(${ClickHouseBaseType})`;
 export type ClickHouseNullable = `Nullable(${ClickHouseBaseType})`;

package/dist/types/clickhouse-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clickhouse-types.d.ts","sourceRoot":"","sources":["../../src/types/clickhouse-types.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,iBAAiB,GACzB,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAC1D,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;AAErE,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,SAAS,CAAC;AAEpD,MAAM,MAAM,iBAAiB,GACzB,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,GACvD,WAAW,MAAM,KAAK,MAAM,GAAG,CAAC;AAGpC,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GAAG,QAAQ,GACjB,UAAU,GACV,cAAc,MAAM,GAAG,GACvB,cAAc,MAAM,MAAM,MAAM,IAAI,CAAC;AAGzC,MAAM,MAAM,gBAAgB,GACxB,QAAQ,GACR,eAAe,MAAM,GAAG,GACxB,MAAM,CAAC;AAGX,MAAM,MAAM,eAAe,GAAG,SAAS,kBAAkB,GAAG,CAAC;AAC7D,MAAM,MAAM,kBAAkB,GAAG,YAAY,kBAAkB,GAAG,CAAC;AACnE,MAAM,MAAM,wBAAwB,GAAG,kBAAkB,gBAAgB,GAAG,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,OAAO,kBAAkB,KAAK,kBAAkB,GAAG,CAAC;AAGhF,MAAM,MAAM,kBAAkB,GAC1B,iBAAiB,GACjB,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,CAAC;AAGrB,MAAM,MAAM,cAAc,GACtB,kBAAkB,GAClB,eAAe,GACf,kBAAkB,GAClB,wBAAwB,GACxB,aAAa,CAAC;AAGlB,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,cAAc,IACtD,CAAC,SAAS,iBAAiB,GAAG,MAAM,GACpC,CAAC,SAAS,eAAe,GAAG,MAAM,GAClC,CAAC,SAAS,iBAAiB,GAAG,MAAM,GACpC,CAAC,SAAS,kBAAkB,GAAG,IAAI,GACnC,CAAC,SAAS,gBAAgB,GAAG,MAAM,GACnC,CAAC,SAAS,SAAS,MAAM,CAAC,SAAS,kBAAkB,GAAG,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GACxF,CAAC,SAAS,YAAY,MAAM,CAAC,SAAS,kBAAkB,GAAG,GAAG,mBAAmB,CAAC,CAAC,CAAC,GAAG,IAAI,GAC3F,CAAC,SAAS,kBAAkB,MAAM,CAAC,SAAS,gBAAgB,GAAG,GAAG,mBAAmB,CAAC,CAAC,CAAC,GACxF,CAAC,SAAS,OAAO,MAAM,CAAC,SAAS,kBAAkB,KAAK,MAAM,CAAC,SAAS,kBAAkB,GAAG,GAC7F,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,GACnD,KAAK,CAAC"}
+{"version":3,"file":"clickhouse-types.d.ts","sourceRoot":"","sources":["../../src/types/clickhouse-types.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,iBAAiB,GACzB,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAC1D,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;AAErE,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,SAAS,CAAC;AAEpD,MAAM,MAAM,iBAAiB,GACzB,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,GACvD,WAAW,MAAM,KAAK,MAAM,GAAG,CAAC;AAGpC,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GAAG,QAAQ,GACjB,UAAU,GACV,aAAa,MAAM,IAAI,GACvB,cAAc,MAAM,GAAG,GACvB,cAAc,MAAM,MAAM,MAAM,IAAI,CAAC;AAGzC,MAAM,MAAM,gBAAgB,GACxB,QAAQ,GACR,eAAe,MAAM,GAAG,GACxB,MAAM,CAAC;AAGX,MAAM,MAAM,eAAe,GAAG,SAAS,kBAAkB,GAAG,CAAC;AAC7D,MAAM,MAAM,kBAAkB,GAAG,YAAY,kBAAkB,GAAG,CAAC;AACnE,MAAM,MAAM,wBAAwB,GAAG,kBAAkB,gBAAgB,GAAG,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,OAAO,kBAAkB,KAAK,kBAAkB,GAAG,CAAC;AAGhF,MAAM,MAAM,kBAAkB,GAC1B,iBAAiB,GACjB,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,CAAC;AAGrB,MAAM,MAAM,cAAc,GACtB,kBAAkB,GAClB,eAAe,GACf,kBAAkB,GAClB,wBAAwB,GACxB,aAAa,CAAC;AAGlB,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,cAAc,IACtD,CAAC,SAAS,iBAAiB,GAAG,MAAM,GACpC,CAAC,SAAS,eAAe,GAAG,MAAM,GAClC,CAAC,SAAS,iBAAiB,GAAG,MAAM,GACpC,CAAC,SAAS,kBAAkB,GAAG,IAAI,GACnC,CAAC,SAAS,gBAAgB,GAAG,MAAM,GACnC,CAAC,SAAS,SAAS,MAAM,CAAC,SAAS,kBAAkB,GAAG,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GACxF,CAAC,SAAS,YAAY,MAAM,CAAC,SAAS,kBAAkB,GAAG,GAAG,mBAAmB,CAAC,CAAC,CAAC,GAAG,IAAI,GAC3F,CAAC,SAAS,kBAAkB,MAAM,CAAC,SAAS,gBAAgB,GAAG,GAAG,mBAAmB,CAAC,CAAC,CAAC,GACxF,CAAC,SAAS,OAAO,MAAM,CAAC,SAAS,kBAAkB,KAAK,MAAM,CAAC,SAAS,kBAAkB,GAAG,GAC7F,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,GACnD,KAAK,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypequery/clickhouse",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "ClickHouse typescript query builder",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",