@guanmingchiu/sqlparser-ts 0.60.0-rc3

package/dist/index.mjs

@@ -0,0 +1,379 @@
+//#region src/dialects.ts
+/**
+* Generic SQL dialect - accepts most SQL syntax
+*/
+var GenericDialect = class {
+	constructor() {
+		this.name = "generic";
+	}
+};
+/**
+* ANSI SQL standard dialect
+*/
+var AnsiDialect = class {
+	constructor() {
+		this.name = "ansi";
+	}
+};
+/**
+* MySQL dialect
+*/
+var MySqlDialect = class {
+	constructor() {
+		this.name = "mysql";
+	}
+};
+/**
+* PostgreSQL dialect
+*/
+var PostgreSqlDialect = class {
+	constructor() {
+		this.name = "postgresql";
+	}
+};
+/**
+* SQLite dialect
+*/
+var SQLiteDialect = class {
+	constructor() {
+		this.name = "sqlite";
+	}
+};
+/**
+* Snowflake dialect
+*/
+var SnowflakeDialect = class {
+	constructor() {
+		this.name = "snowflake";
+	}
+};
+/**
+* Amazon Redshift dialect
+*/
+var RedshiftDialect = class {
+	constructor() {
+		this.name = "redshift";
+	}
+};
+/**
+* Microsoft SQL Server dialect
+*/
+var MsSqlDialect = class {
+	constructor() {
+		this.name = "mssql";
+	}
+};
+/**
+* ClickHouse dialect
+*/
+var ClickHouseDialect = class {
+	constructor() {
+		this.name = "clickhouse";
+	}
+};
+/**
+* Google BigQuery dialect
+*/
+var BigQueryDialect = class {
+	constructor() {
+		this.name = "bigquery";
+	}
+};
+/**
+* DuckDB dialect
+*/
+var DuckDbDialect = class {
+	constructor() {
+		this.name = "duckdb";
+	}
+};
+/**
+* Databricks dialect
+*/
+var DatabricksDialect = class {
+	constructor() {
+		this.name = "databricks";
+	}
+};
+/**
+* Apache Hive dialect
+*/
+var HiveDialect = class {
+	constructor() {
+		this.name = "hive";
+	}
+};
+/**
+* Oracle dialect
+*/
+var OracleDialect = class {
+	constructor() {
+		this.name = "oracle";
+	}
+};
+/**
+* All supported dialect names
+*/
+const SUPPORTED_DIALECTS = [
+	"generic",
+	"ansi",
+	"mysql",
+	"postgresql",
+	"sqlite",
+	"snowflake",
+	"redshift",
+	"mssql",
+	"clickhouse",
+	"bigquery",
+	"duckdb",
+	"databricks",
+	"hive",
+	"oracle"
+];
+/**
+* Map of dialect names to dialect classes
+*/
+const DIALECT_MAP = {
+	generic: GenericDialect,
+	ansi: AnsiDialect,
+	mysql: MySqlDialect,
+	postgresql: PostgreSqlDialect,
+	sqlite: SQLiteDialect,
+	snowflake: SnowflakeDialect,
+	redshift: RedshiftDialect,
+	mssql: MsSqlDialect,
+	clickhouse: ClickHouseDialect,
+	bigquery: BigQueryDialect,
+	duckdb: DuckDbDialect,
+	databricks: DatabricksDialect,
+	hive: HiveDialect,
+	oracle: OracleDialect
+};
+/** Create a dialect instance from a string name (case-insensitive) */
+function dialectFromString(name) {
+	const normalized = name.toLowerCase();
+	const DialectClass = DIALECT_MAP[{
+		postgres: "postgresql",
+		pg: "postgresql",
+		sqlserver: "mssql",
+		duck: "duckdb"
+	}[normalized] ?? normalized];
+	return DialectClass ? new DialectClass() : void 0;
+}
+
+//#endregion
+//#region src/types/errors.ts
+/**
+* Error thrown when SQL parsing fails
+*/
+var ParserError = class ParserError extends Error {
+	constructor(message, location) {
+		super(message);
+		this.name = "ParserError";
+		this.location = location;
+		if (Error.captureStackTrace) Error.captureStackTrace(this, ParserError);
+	}
+	/**
+	* Create a ParserError from a WASM error object
+	*/
+	static fromWasmError(error) {
+		if (typeof error === "string") return new ParserError(error);
+		if (error && typeof error === "object") {
+			const err = error;
+			return new ParserError(typeof err.message === "string" ? err.message : String(error), typeof err.line === "number" && typeof err.column === "number" ? {
+				line: err.line,
+				column: err.column
+			} : void 0);
+		}
+		return new ParserError(String(error));
+	}
+};
+/**
+* Error thrown when WASM module fails to initialize
+*/
+var WasmInitError = class WasmInitError extends Error {
+	constructor(message) {
+		super(message);
+		this.name = "WasmInitError";
+		if (Error.captureStackTrace) Error.captureStackTrace(this, WasmInitError);
+	}
+};
+
+//#endregion
+//#region src/wasm.ts
+let wasmModule = null;
+let initPromise = null;
+let initStarted = false;
+const isBrowser = typeof window !== "undefined" && typeof process === "undefined";
+function startInit() {
+	if (initStarted) return;
+	initStarted = true;
+	initPromise = initWasm().catch(() => {});
+}
+startInit();
+/** Get initialized WASM module or throw */
+function getWasmModule() {
+	if (wasmModule) return wasmModule;
+	throw new WasmInitError("WASM module not yet initialized. Use the async import or wait for module to load: import(\"@guanmingchiu/sqlparser-ts\").then(({ parse }) => parse(sql))");
+}
+/**
+* Wait for WASM module to be ready
+*/
+async function ready() {
+	startInit();
+	await initPromise;
+}
+/**
+* Initialize the WASM module explicitly.
+* Usually not needed - the module auto-initializes on first use.
+*/
+async function initWasm() {
+	if (wasmModule) return;
+	if (isBrowser) {
+		try {
+			const wasmJsUrl = new URL("../wasm/sqlparser_rs_wasm_web.js", import.meta.url);
+			const wasmBinaryUrl = new URL("../wasm/sqlparser_rs_wasm_web_bg.wasm", import.meta.url);
+			const wasm = await import(
+				/* @vite-ignore */
+				wasmJsUrl.href
+);
+			if (typeof wasm.default === "function") await wasm.default({ module_or_path: wasmBinaryUrl });
+			wasmModule = wasm;
+		} catch (error) {
+			throw new WasmInitError(`Failed to load WASM module in browser: ${error instanceof Error ? error.message : String(error)}`);
+		}
+		return;
+	}
+	try {
+		wasmModule = await import(
+			/* @vite-ignore */
+			new URL("../wasm/sqlparser_rs_wasm.js", import.meta.url).href
+);
+	} catch (error) {
+		throw new WasmInitError(`Failed to load WASM module: ${error instanceof Error ? error.message : String(error)}`);
+	}
+}
+
+//#endregion
+//#region src/parser.ts
+function resolveDialect(dialect = "generic") {
+	if (typeof dialect === "string") {
+		const resolved = dialectFromString(dialect);
+		if (!resolved) throw new Error(`Unknown dialect: ${dialect}`);
+		return resolved;
+	}
+	return dialect;
+}
+/**
+* SQL Parser - parses SQL statements into AST
+*
+* @example
+* ```typescript
+* import { Parser, PostgreSqlDialect } from '@guanmingchiu/sqlparser-ts';
+*
+* const statements = Parser.parse('SELECT * FROM users', 'postgresql');
+*
+* // With options
+* const parser = new Parser(new PostgreSqlDialect())
+*   .withOptions({ trailingCommas: true });
+* const ast = parser.parse('SELECT a, b, FROM users');
+* ```
+*/
+var Parser = class Parser {
+	constructor(dialect = new GenericDialect()) {
+		this.dialect = dialect;
+		this.options = {};
+	}
+	/** Set recursion limit for parsing nested expressions */
+	withRecursionLimit(limit) {
+		this.options.recursionLimit = limit;
+		return this;
+	}
+	/** Set parser options */
+	withOptions(options) {
+		this.options = {
+			...this.options,
+			...options
+		};
+		return this;
+	}
+	/** Parse SQL statements */
+	parse(sql) {
+		const wasm = getWasmModule();
+		try {
+			if (Object.keys(this.options).length > 0) return wasm.parse_sql_with_options(this.dialect.name, sql, this.options);
+			return wasm.parse_sql(this.dialect.name, sql);
+		} catch (error) {
+			throw ParserError.fromWasmError(error);
+		}
+	}
+	/** Parse SQL into AST */
+	static parse(sql, dialect = "generic") {
+		return new Parser(resolveDialect(dialect)).parse(sql);
+	}
+	/** Parse SQL and return AST as JSON string */
+	static parseToJson(sql, dialect = "generic") {
+		const wasm = getWasmModule();
+		try {
+			return wasm.parse_sql_to_json_string(resolveDialect(dialect).name, sql);
+		} catch (error) {
+			throw ParserError.fromWasmError(error);
+		}
+	}
+	/** Parse SQL and return formatted string representation */
+	static parseToString(sql, dialect = "generic") {
+		const wasm = getWasmModule();
+		try {
+			return wasm.parse_sql_to_string(resolveDialect(dialect).name, sql);
+		} catch (error) {
+			throw ParserError.fromWasmError(error);
+		}
+	}
+	/** Format SQL by parsing and regenerating it */
+	static format(sql, dialect = "generic") {
+		const wasm = getWasmModule();
+		try {
+			return wasm.format_sql(resolveDialect(dialect).name, sql);
+		} catch (error) {
+			throw ParserError.fromWasmError(error);
+		}
+	}
+	/**
+	* Validate SQL syntax
+	* @throws ParserError if SQL is invalid
+	*/
+	static validate(sql, dialect = "generic") {
+		const wasm = getWasmModule();
+		try {
+			return wasm.validate_sql(resolveDialect(dialect).name, sql);
+		} catch (error) {
+			throw ParserError.fromWasmError(error);
+		}
+	}
+	/** Get list of supported dialect names */
+	static getSupportedDialects() {
+		return getWasmModule().get_supported_dialects();
+	}
+};
+/**
+* Parse SQL into AST
+*/
+function parse(sql, dialect = "generic") {
+	return Parser.parse(sql, dialect);
+}
+/**
+* Validate SQL syntax
+* @throws ParserError if SQL is invalid
+*/
+function validate(sql, dialect = "generic") {
+	return Parser.validate(sql, dialect);
+}
+/**
+* Format SQL by parsing and regenerating it
+*/
+function format(sql, dialect = "generic") {
+	return Parser.format(sql, dialect);
+}
+
+//#endregion
+export { AnsiDialect, BigQueryDialect, ClickHouseDialect, DatabricksDialect, DuckDbDialect, GenericDialect, HiveDialect, MsSqlDialect, MySqlDialect, OracleDialect, Parser, ParserError, PostgreSqlDialect, RedshiftDialect, SQLiteDialect, SUPPORTED_DIALECTS, SnowflakeDialect, WasmInitError, dialectFromString, format, initWasm, parse, ready, validate };

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@guanmingchiu/sqlparser-ts",
+  "version": "0.60.0-rc3",
+  "type": "module",
+  "description": "A SQL parser for JavaScript and TypeScript, powered by datafusion-sqlparser-rs via WASM",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "wasm",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "npm run build:wasm && npm run build:ts",
+    "build:wasm": "cd .. && wasm-pack build --target nodejs --out-dir ts/wasm && rm -f ts/wasm/.gitignore",
+    "build:wasm:web": "cd .. && wasm-pack build --target web --out-dir ts/wasm-web",
+    "build:ts": "tsdown",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src tests",
+    "lint:fix": "eslint src tests --fix",
+    "prepublishOnly": "npm run build",
+    "local:pack": "npm run build:ts && npm pack",
+    "local:link": "npm run build:ts && npm link"
+  },
+  "keywords": [
+    "sql",
+    "parser",
+    "sqlparser",
+    "ast",
+    "wasm",
+    "webassembly",
+    "typescript"
+  ],
+  "author": "Guan-Ming Chiu",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/guanmingchiu/sqlparser-ts.git"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.10",
+    "@vitest/ui": "^4.0.18",
+    "eslint": "^9.18.0",
+    "eslint-plugin-unused-imports": "^4.3.0",
+    "tsdown": "^0.20.1",
+    "typescript": "^5.7.0",
+    "typescript-eslint": "^8.21.0",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}

package/wasm/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 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 [yyyy] [name of copyright owner]
+
+   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.