@hypequery/clickhouse 0.0.0-canary-20260306132943

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are advised to review the applicable
+      documentation for the specific language governing permissions and
+      limitations under each license.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 hypequery
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License. 

package/README-CLI.md

@@ -0,0 +1,123 @@
+# hypequery TypeScript Generator
+
+This tool automatically generates TypeScript type definitions from your ClickHouse database schema.
+
+## Installation
+
+The TypeScript generator is included with the `@hypequery/clickhouse` package:
+
+```bash
+npm install @hypequery/clickhouse
+```
+
+## Quick Start
+
+Generate TypeScript types for your ClickHouse database:
+
+```bash
+npx hypequery-generate-types
+```
+
+This will:
+1. Connect to your ClickHouse database using environment variables
+2. Introspect all tables in your database
+3. Generate TypeScript definitions in `./generated-schema.ts`
+
+## Example Usage
+
+**Generate types with a custom output path:**
+
+```bash
+npx hypequery-generate-types ./src/types/db-schema.ts
+```
+
+**Specify database connection directly:**
+
+```bash
+CLICKHOUSE_HOST=http://clickhouse.example.com:8123 \
+CLICKHOUSE_USER=myuser \
+CLICKHOUSE_PASSWORD=mypassword \
+CLICKHOUSE_DATABASE=analytics \
+npx hypequery-generate-types
+```
+
+## Configuration
+
+Configure the connection using environment variables:
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `CLICKHOUSE_HOST` | ClickHouse server URL | `http://localhost:8123` |
+| `CLICKHOUSE_USER` | ClickHouse username | `default` |
+| `CLICKHOUSE_PASSWORD` | ClickHouse password | _(empty)_ |
+| `CLICKHOUSE_DATABASE` | ClickHouse database name | `default` |
+
+You can set these in:
+- A `.env` file in your project root
+- Your system environment
+- Directly when running the command
+
+## Using Generated Types
+
+Import the generated types in your code:
+
+```typescript
+import { createQueryBuilder } from '@hypequery/clickhouse';
+import { IntrospectedSchema } from './generated-schema';
+
+// Create a type-safe query builder
+const db = createQueryBuilder<IntrospectedSchema>({
+  host: process.env.CLICKHOUSE_HOST,
+  username: process.env.CLICKHOUSE_USER,
+  password: process.env.CLICKHOUSE_PASSWORD,
+  database: process.env.CLICKHOUSE_DATABASE,
+});
+
+// Enjoy complete type safety!
+const results = await db
+  .table('users')          // TypeScript checks table exists
+  .select(['id', 'name'])  // TypeScript checks columns exist
+  .where('id', 'gt', 10)   // TypeScript validates types
+  .execute();
+
+// Results are properly typed
+results.forEach(user => {
+  console.log(user.name);  // TypeScript knows this is a string
+});
+```
+
+## Adding to Your Workflow
+
+Add it to your npm scripts:
+
+```json
+{
+  "scripts": {
+    "generate-types": "hypequery-generate-types ./src/types/db-schema.ts",
+    "prebuild": "npm run generate-types",
+    "build": "tsc"
+  }
+}
+```
+
+## Troubleshooting
+
+If you encounter issues:
+
+1. **Connection problems**
+   - Make sure ClickHouse is running and accessible
+   - Check your firewall settings
+
+2. **Authentication failures**
+   - Verify your username and password
+   - Ensure the user has sufficient permissions
+
+3. **Missing tables**
+   - Confirm you're connecting to the correct database
+   - Verify the tables exist in your ClickHouse instance
+
+For more help, run:
+
+```bash
+npx hypequery-generate-types --help
+``` 

package/README.md

@@ -0,0 +1,316 @@
+<div align="center">
+  <h1>@hypequery/clickhouse</h1>
+  <p>A typescript-first library for building type-safe dashboards with ClickHouse</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)
+  [![GitHub stars](https://img.shields.io/github/stars/hypequery/hypequery)](https://github.com/hypequery/hypequery/stargazers)
+</div>
+
+
+## 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.
+
+## Features
+
+- 🎯 **Type-Safe**: Full TypeScript support with types from your ClickHouse schema
+- 🚀 **Performant**: Built for real-time analytics with optimized query generation
+- 🔍 **Cross Filtering**: Powerful cross-filtering capabilities for interactive dashboards
+- 🛠️ **Developer Friendly**: Fluent API design for an intuitive development experience
+- 📱 **Platform Agnostic**: Works in both Node.js and browser environments
+- 🔄 **Schema Generation**: CLI tool to generate TypeScript types from your ClickHouse schema
+
+## Installation
+
+This library requires one of the following ClickHouse clients as a peer dependency:
+
+### For Node.js environments
+```bash
+npm install @hypequery/clickhouse
+```
+
+### For browser/universal environments
+```bash
+npm install @hypequery/clickhouse @clickhouse/client-web
+```
+
+**Note**: The library supports multiple client selection strategies:
+- **Manual injection**: Explicitly provide a client instance (required for browser environments)
+- **Auto-detection**: Automatically selects the client for Node.js environments
+
+## Quick Start
+
+### Node.js Environments
+
+```typescript
+import { createQueryBuilder } from '@hypequery/clickhouse';
+import type { IntrospectedSchema } from './generated-schema';
+
+// Initialize the query builder
+const db = createQueryBuilder<IntrospectedSchema>({
+  host: 'your-clickhouse-host',
+  username: 'default',
+  password: 'your-password',
+  database: 'default'
+});
+
+// Build and execute a query
+const results = await db
+  .table('trips')
+  .select(['pickup_datetime', 'dropoff_datetime', 'total_amount'])
+  .where('total_amount', '>', 50)
+  .orderBy('pickup_datetime', 'DESC')
+  .limit(10)
+  .execute();
+```
+
+### Browser Environments
+
+```typescript
+import { createQueryBuilder } from '@hypequery/clickhouse';
+import { createClient } from '@clickhouse/client-web';
+import type { IntrospectedSchema } from './generated-schema';
+
+// Create the ClickHouse client explicitly
+const client = createClient({
+  host: 'your-clickhouse-host',
+  username: 'default',
+  password: '',
+  database: 'default'
+});
+
+// Initialize the query builder with the client
+const db = createQueryBuilder<IntrospectedSchema>({
+  client // Explicitly provide the client
+});
+
+// Build and execute a query
+const results = await db
+  .table('trips')
+  .select(['pickup_datetime', 'dropoff_datetime', 'total_amount'])
+  .where('total_amount', '>', 50)
+  .orderBy('pickup_datetime', 'DESC')
+  .limit(10)
+  .execute();
+```
+
+## Caching (Experimental)
+
+The query builder can cache results with deterministic keys, stale-while-revalidate behavior, and pluggable providers.
+
+```typescript
+import { createQueryBuilder, MemoryCacheProvider } from '@hypequery/clickhouse';
+
+const db = createQueryBuilder<IntrospectedSchema>({
+  host: 'your-clickhouse-host',
+  username: 'default',
+  password: '',
+  database: 'default',
+  cache: {
+    mode: 'stale-while-revalidate',
+    ttlMs: 2_000,
+    staleTtlMs: 30_000,
+    provider: new MemoryCacheProvider({ maxEntries: 5_000 })
+  }
+});
+
+const rows = await db
+  .table('users')
+  .select(['id', 'email'])
+  .where('active', '=', true)
+  .cache({ tags: ['users'] })
+  .execute();
+
+// Programmatic invalidation
+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).
+
+## Schema Generation
+
+hypequery provides a CLI tool 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
+```
+
+This creates a `generated-schema.ts` file that you can import in your application:
+
+```typescript
+import { createQueryBuilder } from '@hypequery/clickhouse';
+import type { IntrospectedSchema } from './generated-schema';
+
+const db = createQueryBuilder<IntrospectedSchema>({
+  // connection details
+});
+```
+
+## Core Features
+
+### Type-Safe Queries
+
+hypequery provides full TypeScript support, ensuring your queries are type-safe:
+
+```typescript
+// Column names are type-checked
+const query = db.table('trips')
+  .select(['pickup_datetime', 'total_amount']) 
+  .where('total_amount', 'gt', 50)
+  .execute();
+
+// Type error if column doesn't exist
+db.table('trips').select(['non_existent_column']); // TypeScript error
+```
+
+### Cross Filtering
+
+Implement interactive dashboards with cross-filtering support:
+
+```typescript
+import { CrossFilter } from '@hypequery/clickhouse';
+
+// Create a filter
+const filter = new CrossFilter()
+  .add({
+    column: 'pickup_datetime',
+    operator: 'gte',
+    value: '2024-01-01'
+  })
+  .add({
+    column: 'total_amount',
+    operator: 'gt',
+    value: 20
+  });
+
+// Apply to multiple queries
+const query1 = db.table('trips')
+  .applyCrossFilters(filter)
+  .execute();
+
+const query2 = db.table('drivers')
+  .applyCrossFilters(filter)
+  .execute();
+```
+
+### Advanced Queries
+
+hypequery supports complex queries including joins, aggregations, and subqueries:
+
+```typescript
+// Aggregations
+const stats = await db.table('trips')
+  .avg('total_amount')
+  .max('trip_distance')
+  .count('trip_id')
+  .where('pickup_datetime', 'gte', '2024-01-01')
+  .execute();
+
+// Joins
+const tripsWithDrivers = await db.table('trips')
+  .select(['trips.trip_id', 'trips.total_amount', 'drivers.name'])
+  .join('drivers', 'trips.driver_id', 'drivers.id')
+  .execute();
+
+// After joining, TypeScript understands the expanded scope
+const tripsWithUsers = await db.table('trips')
+  .innerJoin('users', 'trips.user_id', 'users.id')
+  .select(['users.email', 'trips.trip_id'])
+  .where('users.email', 'like', '%@example.com')
+  .execute();
+
+// Keep literal column inference with selectConst and reuse joined columns in ORDER BY / HAVING
+const sortedTrips = await db.table('trips')
+  .innerJoin('users', 'trips.user_id', 'users.id')
+  .selectConst('users.email', 'trips.trip_id')
+  .groupBy(['users.email', 'trips.trip_id'])
+  .having('COUNT(*) > 1')
+  .orderBy('users.email', 'DESC')
+  .execute();
+
+```
+
+`selectConst()` preserves literal column names (including aliases like `users.email`), which means TypeScript keeps those identifiers available for downstream `orderBy`, `groupBy`, and `having` calls.
+
+**Benefits:**
+- ✅ Works in all environments (Node.js, browser, bundlers)
+- ✅ Explicit control over client configuration
+- ✅ Required for browser environments (require() doesn't work in browsers)
+- ✅ Synchronous API throughout
+
+#### 2. Auto-Detection with Fallback (Node.js Environments Only)
+
+```typescript
+const db = createQueryBuilder<IntrospectedSchema>({
+  host: 'your-clickhouse-host',
+  username: 'default',
+  password: '',
+  database: 'default'
+});
+```
+
+
+## Testing
+
+Run the fast feedback loop with:
+
+```bash
+npm run test
+```
+
+This command runs type checks + unit tests only. To exercise the ClickHouse-backed integration suite, copy `.env.test.example` to `.env.test`, point it at a ClickHouse instance, and run:
+
+```bash
+npm run test:integration
+```
+
+## Versioning and Release Channels
+
+hypequery follows semantic versioning and provides multiple release channels:
+
+- **Latest**: Stable releases (`npm install @hypequery/clickhouse`)
+- **Beta**: Pre-release versions (`npm install @hypequery/clickhouse@beta`)
+
+## Documentation
+
+For detailed documentation and examples, visit our [documentation site](https://hypequery.com/docs).
+
+- [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)
+
+
+## Troubleshooting
+
+### Common Issues
+
+- **Connection Errors**: Ensure your ClickHouse server is running and accessible
+- **CORS Issues**: Use a proxy server for browser environments
+- **Type Errors**: Make sure to regenerate your schema types after schema changes
+- **Client Not Found**: Make sure you have installed at least one of the required peer dependencies:
+  - `@clickhouse/client` (for Node.js environments)
+  - `@clickhouse/client-web` (for browser/universal environments)
+- **Browser Auto-Detection**: Auto-detection doesn't work in browsers because `require()` calls don't work. Use manual injection instead.
+
+
+## License
+
+This project is licensed under the Apache-2.0 License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- 📚 [Documentation](https://hypequery.com/docs)
+- 🐛 [Issue Tracker](https://github.com/hypequery/hypequery/issues)
+- 💬 [Discussions](https://github.com/hypequery/hypequery/discussions)
+
+---
+
+<div align="center">
+  <sub>Built with ❤️ by the hypequery team</sub>
+</div>