@hypequery/clickhouse 1.0.2 → 1.0.4

package/README.md

@@ -10,7 +10,6 @@
   [![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
 
@@ -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
@@ -69,7 +72,7 @@ hypequery provides a CLI tool to generate TypeScript types from your ClickHouse
 
 ```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>({
@@ -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()
@@ -226,8 +229,8 @@ const db = createQueryBuilder<Schema>({
 
 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
 

package/dist/core/utils/sql-expressions.d.ts

@@ -32,14 +32,18 @@ export declare function rawAs(sql: string, alias: string): AliasedExpression;
  * @returns SQL expression or aliased expression
  */
 export declare function toDateTime(field: string, alias?: string): SqlExpression | AliasedExpression;
+export interface FormatDateTimeOptions {
+    timezone?: string;
+    alias?: string;
+}
 /**
  * Formats a DateTime value using the specified format
  * @param field The field or expression to format
  * @param format The date format string
- * @param alias Optional alias for the result
+ * @param options Optional configuration including timezone and alias
  * @returns SQL expression or aliased expression
  */
-export declare function formatDateTime(field: string, format: string, alias?: string): SqlExpression | AliasedExpression;
+export declare function formatDateTime(field: string, format: string, options?: FormatDateTimeOptions): SqlExpression | AliasedExpression;
 /**
  * Truncates a date/time value to the start of the specified interval
  * @param field The field to truncate

package/dist/core/utils/sql-expressions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sql-expressions.d.ts","sourceRoot":"","sources":["../../../src/core/utils/sql-expressions.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,IAAI,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,MAAM,EAAE,oBAAoB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAK9C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAMnE;AAID;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,iBAAiB,CAI3F;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,iBAAiB,CAI/G;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,iBAAiB,CAIpH;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,iBAAiB,CAK7K"}
+{"version":3,"file":"sql-expressions.d.ts","sourceRoot":"","sources":["../../../src/core/utils/sql-expressions.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,IAAI,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,MAAM,EAAE,oBAAoB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAK9C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAMnE;AAID;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,iBAAiB,CAI3F;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,qBAA0B,GAClC,aAAa,GAAG,iBAAiB,CAYnC;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,iBAAiB,CAIpH;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,iBAAiB,CAK7K"}

package/dist/core/utils/sql-expressions.js

@@ -38,13 +38,17 @@ export function toDateTime(field, alias) {
  * Formats a DateTime value using the specified format
  * @param field The field or expression to format
  * @param format The date format string
- * @param alias Optional alias for the result
+ * @param options Optional configuration including timezone and alias
  * @returns SQL expression or aliased expression
  */
-export function formatDateTime(field, format, alias) {
-    return alias
-        ? rawAs(`formatDateTime(${field}, '${format}')`, alias)
-        : raw(`formatDateTime(${field}, '${format}')`);
+export function formatDateTime(field, format, options = {}) {
+    const { timezone, alias } = options;
+    let sql = `formatDateTime(${field}, '${format}'`;
+    if (timezone) {
+        sql += `, '${timezone}'`;
+    }
+    sql += ')';
+    return alias ? rawAs(sql, alias) : raw(sql);
 }
 /**
  * Truncates a date/time value to the start of the specified interval

package/dist/index.d.ts

@@ -5,7 +5,7 @@ export type { TableSchema, QueryConfig, ColumnType, WhereExpression, GroupByExpr
 export type { JoinPath, JoinPathOptions } from './core/join-relationships.js';
 export { CrossFilter } from './core/cross-filter.js';
 export { logger } from './core/utils/logger.js';
-export { raw, rawAs, toDateTime, formatDateTime, toStartOfInterval, datePart } from './core/utils/sql-expressions.js';
+export { raw, rawAs, toDateTime, formatDateTime, toStartOfInterval, datePart, FormatDateTimeOptions } from './core/utils/sql-expressions.js';
 export type { SqlExpression, AliasedExpression } from './core/utils/sql-expressions.js';
 //# sourceMappingURL=index.d.ts.map
 

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,YAAY,EACV,WAAW,EACX,WAAW,EACX,UAAU,EACV,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,cAAc,EACd,eAAe,EACf,QAAQ,EACR,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EACL,GAAG,EACH,KAAK,EACL,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,QAAQ,EACT,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACV,aAAa,EACb,iBAAiB,EAClB,MAAM,iCAAiC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,YAAY,EACV,WAAW,EACX,WAAW,EACX,UAAU,EACV,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,cAAc,EACd,eAAe,EACf,QAAQ,EACR,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EACL,GAAG,EACH,KAAK,EACL,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,QAAQ,EACR,qBAAqB,EACtB,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACV,aAAa,EACb,iBAAiB,EAClB,MAAM,iCAAiC,CAAC"}

package/package.json

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