@clickhouse/datatype-parser 0.1.0

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2016-2024 ClickHouse, Inc.
+
+                                 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 solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this 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 2016-2024 ClickHouse, Inc.
+
+   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.md

@@ -0,0 +1,162 @@
+# chdt-ts — standalone ClickHouse data-type parser (TypeScript)
+
+A small, self-contained TypeScript library that parses a ClickHouse **data-type
+string** (the kind sent in the types row of `RowBinaryWithNamesAndTypes`, e.g.
+`Array(Nullable(UInt64))`, `Tuple(a UInt8, b String)`, `Enum8('a' = 1)`,
+`Decimal(10, 2)`) into a JSON AST.
+
+It is a faithful port of the C++ `chdt` library (see `./reference-cpp-extracted-parser`),
+which is itself extracted from the server's `ParserDataType`
+(`src/Parsers/ParserDataType.cpp`). It has **no runtime dependencies** — only the
+Node.js standard library. The JSON it emits mirrors the data-type subtree of the
+frozen `EXPLAIN AST json = 1` document (format **version 2**), so its output is a
+drop-in match for what the server produces — and is **byte-identical** to the C++
+parser's output across the full test corpus.
+
+## Layout
+
+The module structure tracks the C++ sources one-to-one:
+
+| TypeScript      | ported from (C++)             | role                                    |
+| --------------- | ----------------------------- | --------------------------------------- |
+| `src/ast.ts`    | `include/chdt/ast.h`          | the AST node shape + `makeNode` factory |
+| `src/lexer.ts`  | `src/lexer.{h,cpp}`           | the purpose-built tokenizer             |
+| `src/parser.ts` | `src/parser.cpp` + `parser.h` | the `ParserDataType::parseImpl` port    |
+| `src/json.ts`   | `src/json.cpp`                | the byte-faithful JSON serializer       |
+| `src/index.ts`  | —                             | public barrel                           |
+| `tool/main.ts`  | `tool/main.cpp`               | the `chdt-parse` CLI                    |
+
+The lexer and parser deliberately preserve the original control flow, branch
+ordering, helper names, and `pos` save/restore points. A few signatures changed
+where C++ used out-parameters (`std::string &`): `parseIdentifier` and
+`decodeQuoted` return small result objects instead.
+
+## Install & build
+
+```bash
+npm install
+npm run build      # emits dist/ (JS + .d.ts)
+npm run typecheck  # tsc --noEmit
+```
+
+## Usage
+
+Library:
+
+```ts
+import { parseDataType, toJSON } from "@clickhouse/datatype-parser";
+
+const r = parseDataType("Tuple(a UInt8, b String)");
+if (r.ok()) {
+  console.log(toJSON(r.ast!)); // pretty (2-space) JSON
+  console.log(toJSON(r.ast!, -1)); // compact JSON
+} else {
+  console.error(r.error!.message, r.error!.position);
+}
+```
+
+CLI (no build step needed — runs on Node.js 24+ native TypeScript support):
+
+```bash
+npm run parse -- "Array(Nullable(UInt64))"
+echo "Enum8('a' = 1, 'b' = 2)" | npm run parse
+```
+
+## Output shape
+
+Node types and slots match the server (format v2):
+
+| `type`          | slots                                                    |
+| --------------- | -------------------------------------------------------- |
+| `DataType`      | `name`, `arguments?` (present iff the type had `(...)`)  |
+| `EnumDataType`  | `name`, `values` (array of `{ name, value }`)            |
+| `TupleDataType` | `name`, `arguments?`, `element_names?` (named tuples)    |
+| `NameTypePair`  | `name`, `data_type` (a `Nested(...)` element)            |
+| `Literal`       | `value_type`, `value` (64-bit ints as JSON strings)      |
+| `Function`      | `name`, `is_operator?`, `arguments` (e.g. `max_types=5`) |
+| `Identifier`    | `name`, `name_parts?`                                    |
+
+## Coverage
+
+Supported: scalars, parametric types with literal args (`Decimal`,
+`FixedString`, `DateTime64`, …), nested type args (`Array`, `Map`, `Nullable`,
+`LowCardinality`, `Variant`, …), enums (explicit → `EnumDataType`;
+auto-assigned → generic `DataType`), named/unnamed/mixed tuples, `Nested`,
+`Dynamic(max_types = N)`, the legacy `Object('json')`, and the SQL-standard
+multi-word aliases (`DOUBLE PRECISION`, `CHAR VARYING`, `INT SIGNED`, …).
+
+**Deliberately not supported yet** (the parser returns a clear error):
+
+- `AggregateFunction` / `SimpleAggregateFunction` — needs the function-expression
+  parser the server reaches for here.
+- the new `JSON(...)` object-argument syntax (`JSON(a.b UInt32, SKIP x)`). Bare
+  `JSON` and legacy `Object('json')` parse fine.
+
+## Tests
+
+```bash
+npm test                  # node:test: unit suite + snapshot corpus — NO clickhouse needed
+npm run test:unsupported  # asserts the deferred types are rejected
+```
+
+`npm test` requires **no `clickhouse` binary** — it runs entirely against
+checked-in fixtures:
+
+- **unit** (`test/parser.test.ts`) — pins representative AST shapes and all the
+  deliberate rejections.
+- **snapshot** (`test/snapshot.test.ts`) — for every type in `test/cases.txt`
+  (356 and counting), compares the parser's JSON against a checked-in static
+  snapshot of the real server's `data_type` subtree, in `test/snapshots/`
+  (one `<sha1>.json` per query). Because a snapshot is only written when the
+  server accepted the type **and** the parser matched it, "parser == snapshot"
+  means "parser == server".
+
+### Regenerating / extending the snapshot corpus
+
+The snapshots are captured from a real server by `update_snapshots.ts`, which
+needs a `clickhouse` binary built from
+https://github.com/peter-leonov-ch/ClickHouse/pull/1 (the AST-format changes
+this parser mirrors live in that PR; a stock build will not match):
+
+```bash
+npm run snapshot:update -- --clickhouse /path/to/clickhouse
+```
+
+It validates every type in `test/cases.txt` plus any in `test/candidates.txt`
+(a seed list of additional types), keeps only those the server accepts and the
+parser matches, appends new keepers to `cases.txt`, writes a snapshot per kept
+query, and prunes orphans. Types the server rejects or where the parser diverges
+are dropped and listed in `test/snapshots_report.txt` (never silently added).
+
+There is also a live comparison that skips the snapshots and queries the server
+directly, useful while iterating:
+
+```bash
+npm run test:oracle -- --clickhouse /path/to/clickhouse
+```
+
+### Confirming the corpus is real (no invented types)
+
+The oracle compares against the server's **parser** (`ParserDataType`), which is
+what this library mirrors. To additionally confirm that every type in the corpus
+is a _real_ ClickHouse type — not just syntactically well-formed — there is a
+check that **instantiates** each type against any stock running server (no
+AST-JSON support needed; over the HTTP interface):
+
+```bash
+npm run validate:live -- --url http://localhost:8124/
+```
+
+It runs `CREATE TEMPORARY TABLE _probe (c <TYPE>)` (session-scoped, nothing
+persisted) with the relevant experimental settings enabled, so an unknown type
+family fails with `UNKNOWN_TYPE`. As of the latest run, **347/356 instantiate
+and 0 are unexpected**.
+
+The remaining 9 are listed in `test/non_instantiable.txt`: types the parser
+accepts (and whose AST matches the server's parser) but that the server's **type
+factory** later rejects — e.g. partial tuple naming (`Tuple(a UInt8, String)`),
+`Nullable` inside `Variant`, `Nullable(Tuple(...))`, `Dynamic(max_types = 255)`,
+the `BINARY` alias without a size, and the legacy `Object('json')` (removed in
+recent servers). These are deliberate parser test inputs — this is a type-string
+_parser_, not a type validator — so they are allowlisted, and `validate:live`
+exits non-zero only on an _unexpected_ failure.

package/dist/ast.d.ts

@@ -0,0 +1,28 @@
+export declare const NodeKind: {
+    readonly DataType: "DataType";
+    readonly EnumDataType: "EnumDataType";
+    readonly TupleDataType: "TupleDataType";
+    readonly NameTypePair: "NameTypePair";
+    readonly Literal: "Literal";
+    readonly Function: "Function";
+    readonly Identifier: "Identifier";
+};
+export type NodeKind = (typeof NodeKind)[keyof typeof NodeKind];
+export interface EnumValue {
+    name: string;
+    value: bigint;
+}
+export interface Node {
+    kind: NodeKind;
+    name: string;
+    arguments: Node[];
+    has_argument_list: boolean;
+    values: EnumValue[];
+    element_names: string[];
+    data_type: Node | null;
+    value_type: string;
+    value: string;
+    is_operator: boolean;
+    name_parts: string[];
+}
+export declare function makeNode(kind: NodeKind): Node;

package/dist/ast.js

@@ -0,0 +1,42 @@
+/// Minimal, self-contained AST for ClickHouse data-type strings.
+///
+/// The node shapes mirror the frozen `EXPLAIN AST json = 1` document
+/// (format version 2; see ClickHouse `AST.md`) so that JSON produced here is
+/// a drop-in match for the data-type subtree the server emits — and a
+/// superset of it: `EnumDataType.values` and `TupleDataType.element_names`
+/// are carried here as they are in the server (since v2).
+///
+/// This is a TypeScript port of the C++ `chdt/ast.h`. The C++ side uses a
+/// single "fat" struct with a `kind` discriminant and only the fields relevant
+/// to that kind populated; we mirror that exactly (rather than a discriminated
+/// union) so the parser port stays line-for-line faithful to the original.
+/// A plain `const` object rather than a TS `enum`, so the source is erasable
+/// and runs under Node's native type-stripping (which rejects `enum`). The
+/// companion type below makes `NodeKind` usable as both a value and a type,
+/// exactly as the enum was.
+export const NodeKind = {
+    DataType: "DataType", /// generic type: name + optional argument list
+    EnumDataType: "EnumDataType", /// Enum / Enum8 / Enum16 with fully explicit values
+    TupleDataType: "TupleDataType", /// Tuple, with optional element names
+    NameTypePair: "NameTypePair", /// `name Type` element of a Nested(...)
+    Literal: "Literal", /// numeric / string argument (e.g. Decimal(10, 2))
+    Function: "Function", /// operator/function argument (e.g. `max_types = 5`)
+    Identifier: "Identifier", /// bare identifier argument
+};
+/// Construct a node with all fields defaulted (mirrors the C++ struct's member
+/// initializers), so the parser can set only the slots relevant to `kind`.
+export function makeNode(kind) {
+    return {
+        kind,
+        name: "",
+        arguments: [],
+        has_argument_list: false,
+        values: [],
+        element_names: [],
+        data_type: null,
+        value_type: "",
+        value: "",
+        is_operator: false,
+        name_parts: [],
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { parseDataType } from "./parser.ts";
+export type { ParseError, ParseResult } from "./parser.ts";
+export { toJSON } from "./json.ts";
+export { NodeKind, makeNode } from "./ast.ts";
+export type { Node, EnumValue } from "./ast.ts";
+export { tokenize, TokenType } from "./lexer.ts";
+export type { Token } from "./lexer.ts";

package/dist/index.js

@@ -0,0 +1,11 @@
+/// Public entry point for the standalone ClickHouse data-type parser.
+///
+/// A TypeScript port of the C++ `chdt` library: parse a ClickHouse data-type
+/// string (the kind sent in the types row of `RowBinaryWithNamesAndTypes`, e.g.
+/// `Array(Nullable(UInt64))`, `Tuple(a UInt8, b String)`, `Enum8('a' = 1)`)
+/// into a JSON-serializable AST that mirrors the server's `EXPLAIN AST json = 1`
+/// data-type subtree (format version 2).
+export { parseDataType } from "./parser.js";
+export { toJSON } from "./json.js";
+export { NodeKind, makeNode } from "./ast.js";
+export { tokenize, TokenType } from "./lexer.js";

package/dist/json.d.ts

@@ -0,0 +1,2 @@
+import { type Node } from "./ast.ts";
+export declare function toJSON(node: Node, indent?: number): string;