sqlparser-rs 0.60.3-rc1 → 0.60.3-rc3

package/dist/index.d.mts

@@ -1216,6 +1216,8 @@ type MergeClause = {
 type CommentObject = 'Column' | 'Table';
 //#endregion
 //#region src/parser.d.ts
+/** Dialect can be specified as a Dialect instance or a string name */
+type DialectInput = Dialect | DialectName;
 /**
  * Parser options
  */
@@ -1230,14 +1232,19 @@ interface ParserOptions {
   recursionLimit?: number;
 }
 /**
- * Initialize the WASM module for browser environments.
- * This must be called before using the Parser in browsers.
+ * Wait for WASM to be ready (useful for ensuring sync APIs work)
+ */
+declare function ready(): Promise<void>;
+/**
+ * Initialize the WASM module.
+ * This must be called before using the Parser in browsers and Node.js ESM.
+ * In Node.js CommonJS, the module is loaded automatically.
  *
  * @example
  * ```typescript
  * import { initWasm, Parser, GenericDialect } from 'sqlparser-rs';
  *
- * // In browser, initialize first
+ * // Initialize first
  * await initWasm();
  *
  * // Then use the parser
@@ -1299,52 +1306,108 @@ declare class Parser {
    * Parse SQL statements
    *
    * @param sql - SQL string to parse
-   * @param dialect - SQL dialect to use
+   * @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
    * @returns Array of parsed statements
    *
    * @example
    * ```typescript
-   * const statements = Parser.parse('SELECT 1', new GenericDialect());
+   * // Using default dialect
+   * const statements = Parser.parse('SELECT 1');
+   *
+   * // Using string dialect name
+   * const pgStatements = Parser.parse('SELECT $1', 'postgresql');
+   *
+   * // Using dialect instance
+   * const mysqlStatements = Parser.parse('SELECT 1', new MySqlDialect());
    * ```
    */
-  static parse(sql: string, dialect?: Dialect): Statement[];
+  static parse(sql: string, dialect?: DialectInput): Statement[];
   /**
    * Parse SQL and return the AST as a JSON string
    *
    * @param sql - SQL string to parse
-   * @param dialect - SQL dialect to use
+   * @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
    * @returns JSON string representation of the AST
    */
-  static parseToJson(sql: string, dialect?: Dialect): string;
+  static parseToJson(sql: string, dialect?: DialectInput): string;
   /**
    * Parse SQL and return a formatted string representation
    *
    * @param sql - SQL string to parse
-   * @param dialect - SQL dialect to use
+   * @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
    * @returns String representation of the parsed SQL
    */
-  static parseToString(sql: string, dialect?: Dialect): string;
+  static parseToString(sql: string, dialect?: DialectInput): string;
   /**
    * Format SQL by parsing and regenerating it (round-trip)
    *
    * @param sql - SQL string to format
-   * @param dialect - SQL dialect to use
+   * @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
    * @returns Formatted SQL string
    */
-  static format(sql: string, dialect?: Dialect): string;
+  static format(sql: string, dialect?: DialectInput): string;
   /**
    * Validate SQL syntax without returning the full AST
    *
    * @param sql - SQL string to validate
-   * @param dialect - SQL dialect to use
+   * @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
    * @returns true if valid, throws ParserError if invalid
    */
-  static validate(sql: string, dialect?: Dialect): boolean;
+  static validate(sql: string, dialect?: DialectInput): boolean;
   /**
    * Get the list of supported dialect names
    */
   static getSupportedDialects(): string[];
 }
+/**
+ * Parse SQL statements (convenience function)
+ *
+ * @param sql - SQL string to parse
+ * @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
+ * @returns Array of parsed statements
+ *
+ * @example
+ * ```typescript
+ * import { parse } from 'sqlparser-rs';
+ *
+ * const statements = parse('SELECT * FROM users');
+ * const pgStatements = parse('SELECT $1', 'postgresql');
+ * ```
+ */
+declare function parse(sql: string, dialect?: DialectInput): Statement[];
+/**
+ * Validate SQL syntax (convenience function)
+ *
+ * @param sql - SQL string to validate
+ * @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
+ * @returns true if valid, throws ParserError if invalid
+ *
+ * @example
+ * ```typescript
+ * import { validate } from 'sqlparser-rs';
+ *
+ * if (validate('SELECT * FROM users')) {
+ *   console.log('Valid SQL!');
+ * }
+ * ```
+ */
+declare function validate(sql: string, dialect?: DialectInput): boolean;
+/**
+ * Format SQL by parsing and regenerating it (convenience function)
+ *
+ * @param sql - SQL string to format
+ * @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
+ * @returns Formatted SQL string
+ *
+ * @example
+ * ```typescript
+ * import { format } from 'sqlparser-rs';
+ *
+ * const formatted = format('select * from users');
+ * // Returns: "SELECT * FROM users"
+ * ```
+ */
+declare function format(sql: string, dialect?: DialectInput): string;
 //#endregion
 //#region src/types/errors.d.ts
 /**
@@ -1372,4 +1435,4 @@ declare class WasmInitError extends Error {
   constructor(message: string);
 }
 //#endregion
-export { Action, AlterColumnOperation, AlterTableOperation, AnsiDialect, Assignment, BigQueryDialect, BinaryOperator, ClickHouseDialect, CloseCursor, ColumnDef, ColumnOption, ColumnOptionDef, CommentObject, CopyLegacyOption, CopyOption, CopySource, CopyTarget, Cte, DataType, DatabricksDialect, DateTimeField, DescribeAlias, type Dialect, type DialectName, DiscardObject, Distinct, DoUpdate, DropStatement, DuckDbDialect, ErrorLocation, ExceptSelectItem, ExcludeSelectItem, Expr, Fetch, FetchDirection, FileFormat, ForeignKeyOption, FunctionArg, FunctionArgExpr, FunctionExpr, GeneratedAs, GeneratedExpressionMode, GenericDialect, GrantObjects, GroupByExpr, HiveDialect, HiveDistributionStyle, HiveFormat, HiveIOFormat, HiveRowFormat, Ident, IdentWithAlias, IndexType, IntervalExpr, Join, JoinConstraint, JoinOperator, LateralView, LockClause, LockType, MergeClause, MsSqlDialect, MySqlDialect, NamedWindowDefinition, NonBlock, ObjectName, ObjectType, Offset, OffsetRows, OnCommit, OnInsert, OracleDialect, OrderByExpr, Parser, ParserError, type ParserOptions, PostgreSqlDialect, Privileges, Query, RedshiftDialect, ReferentialAction, RenameSelectItem, ReplaceSelectElement, ReplaceSelectItem, SQLiteDialect, SUPPORTED_DIALECTS, SchemaName, Select, SelectInto, SelectItem, SetExpr, SetOperator, SetQuantifier, ShowCreateObject, ShowStatementFilter, SnowflakeDialect, SqlOption, SqliteOnConflict, Statement, TableAlias, TableConstraint, TableFactor, TableWithJoins, Top, TransactionAccessMode, TransactionIsolationLevel, TransactionMode, TrimWhereField, UnaryOperator, Value, Values, WasmInitError, WildcardAdditionalOptions, WindowFrame, WindowFrameBound, WindowFrameUnits, WindowSpec, With, dialectFromString, initWasm };
+export { Action, AlterColumnOperation, AlterTableOperation, AnsiDialect, Assignment, BigQueryDialect, BinaryOperator, ClickHouseDialect, CloseCursor, ColumnDef, ColumnOption, ColumnOptionDef, CommentObject, CopyLegacyOption, CopyOption, CopySource, CopyTarget, Cte, DataType, DatabricksDialect, DateTimeField, DescribeAlias, type Dialect, type DialectInput, type DialectName, DiscardObject, Distinct, DoUpdate, DropStatement, DuckDbDialect, ErrorLocation, ExceptSelectItem, ExcludeSelectItem, Expr, Fetch, FetchDirection, FileFormat, ForeignKeyOption, FunctionArg, FunctionArgExpr, FunctionExpr, GeneratedAs, GeneratedExpressionMode, GenericDialect, GrantObjects, GroupByExpr, HiveDialect, HiveDistributionStyle, HiveFormat, HiveIOFormat, HiveRowFormat, Ident, IdentWithAlias, IndexType, IntervalExpr, Join, JoinConstraint, JoinOperator, LateralView, LockClause, LockType, MergeClause, MsSqlDialect, MySqlDialect, NamedWindowDefinition, NonBlock, ObjectName, ObjectType, Offset, OffsetRows, OnCommit, OnInsert, OracleDialect, OrderByExpr, Parser, ParserError, type ParserOptions, PostgreSqlDialect, Privileges, Query, RedshiftDialect, ReferentialAction, RenameSelectItem, ReplaceSelectElement, ReplaceSelectItem, SQLiteDialect, SUPPORTED_DIALECTS, SchemaName, Select, SelectInto, SelectItem, SetExpr, SetOperator, SetQuantifier, ShowCreateObject, ShowStatementFilter, SnowflakeDialect, SqlOption, SqliteOnConflict, Statement, TableAlias, TableConstraint, TableFactor, TableWithJoins, Top, TransactionAccessMode, TransactionIsolationLevel, TransactionMode, TrimWhereField, UnaryOperator, Value, Values, WasmInitError, WildcardAdditionalOptions, WindowFrame, WindowFrameBound, WindowFrameUnits, WindowSpec, With, dialectFromString, format, initWasm, parse, ready, validate };

package/dist/index.mjs

@@ -214,33 +214,45 @@ var WasmInitError = class WasmInitError extends 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;
+}
 let wasmModule = null;
-const isBrowser = typeof window !== "undefined" || typeof self !== "undefined";
+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();
 function getWasmModule() {
 	if (wasmModule) return wasmModule;
-	if (isBrowser) throw new WasmInitError("WASM module not initialized. Call initWasm() first in browser environments.");
-	try {
-		const nodeRequire = (0, eval)("require");
-		const nodeModule = nodeRequire("node:module");
-		const nodeUrl = nodeRequire("node:url");
-		const nodePath = nodeRequire("node:path");
-		const currentDir = nodePath.dirname(nodeUrl.fileURLToPath(import.meta.url));
-		const wasmPath = nodePath.join(currentDir, "../wasm/sqlparser_rs_wasm.js");
-		wasmModule = nodeModule.createRequire(import.meta.url)(wasmPath);
-		return wasmModule;
-	} catch (error) {
-		throw new WasmInitError(`Failed to load WASM module: ${error instanceof Error ? error.message : String(error)}`);
-	}
+	throw new WasmInitError("WASM module not yet initialized. Use the async import or wait for module to load: import(\"sqlparser-rs\").then(({ parse }) => parse(sql))");
+}
+/**
+* Wait for WASM to be ready (useful for ensuring sync APIs work)
+*/
+async function ready() {
+	startInit();
+	await initPromise;
 }
 /**
-* Initialize the WASM module for browser environments.
-* This must be called before using the Parser in browsers.
+* Initialize the WASM module.
+* This must be called before using the Parser in browsers and Node.js ESM.
+* In Node.js CommonJS, the module is loaded automatically.
 *
 * @example
 * ```typescript
 * import { initWasm, Parser, GenericDialect } from 'sqlparser-rs';
 *
-* // In browser, initialize first
+* // Initialize first
 * await initWasm();
 *
 * // Then use the parser
@@ -249,21 +261,28 @@ function getWasmModule() {
 */
 async function initWasm() {
 	if (wasmModule) return;
-	if (!isBrowser) {
-		getWasmModule();
+	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(wasmBinaryUrl);
+			wasmModule = wasm;
+		} catch (error) {
+			throw new WasmInitError(`Failed to load WASM module in browser: ${error instanceof Error ? error.message : String(error)}`);
+		}
 		return;
 	}
 	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(
+		wasmModule = await import(
 			/* @vite-ignore */
-			wasmJsUrl.href
+			new URL("../wasm/sqlparser_rs_wasm.js", import.meta.url).href
 );
-		if (typeof wasm.default === "function") await wasm.default(wasmBinaryUrl);
-		wasmModule = wasm;
 	} catch (error) {
-		throw new WasmInitError(`Failed to load WASM module in browser: ${error instanceof Error ? error.message : String(error)}`);
+		throw new WasmInitError(`Failed to load WASM module: ${error instanceof Error ? error.message : String(error)}`);
 	}
 }
 /**
@@ -338,28 +357,35 @@ var Parser = class Parser {
 	* Parse SQL statements
 	*
 	* @param sql - SQL string to parse
-	* @param dialect - SQL dialect to use
+	* @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
 	* @returns Array of parsed statements
 	*
 	* @example
 	* ```typescript
-	* const statements = Parser.parse('SELECT 1', new GenericDialect());
+	* // Using default dialect
+	* const statements = Parser.parse('SELECT 1');
+	*
+	* // Using string dialect name
+	* const pgStatements = Parser.parse('SELECT $1', 'postgresql');
+	*
+	* // Using dialect instance
+	* const mysqlStatements = Parser.parse('SELECT 1', new MySqlDialect());
 	* ```
 	*/
-	static parse(sql, dialect = new GenericDialect()) {
-		return new Parser(dialect).parse(sql);
+	static parse(sql, dialect = "generic") {
+		return new Parser(resolveDialect(dialect)).parse(sql);
 	}
 	/**
 	* Parse SQL and return the AST as a JSON string
 	*
 	* @param sql - SQL string to parse
-	* @param dialect - SQL dialect to use
+	* @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
 	* @returns JSON string representation of the AST
 	*/
-	static parseToJson(sql, dialect = new GenericDialect()) {
+	static parseToJson(sql, dialect = "generic") {
 		const wasm = getWasmModule();
 		try {
-			return wasm.parse_sql_to_json_string(dialect.name, sql);
+			return wasm.parse_sql_to_json_string(resolveDialect(dialect).name, sql);
 		} catch (error) {
 			throw ParserError.fromWasmError(error);
 		}
@@ -368,13 +394,13 @@ var Parser = class Parser {
 	* Parse SQL and return a formatted string representation
 	*
 	* @param sql - SQL string to parse
-	* @param dialect - SQL dialect to use
+	* @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
 	* @returns String representation of the parsed SQL
 	*/
-	static parseToString(sql, dialect = new GenericDialect()) {
+	static parseToString(sql, dialect = "generic") {
 		const wasm = getWasmModule();
 		try {
-			return wasm.parse_sql_to_string(dialect.name, sql);
+			return wasm.parse_sql_to_string(resolveDialect(dialect).name, sql);
 		} catch (error) {
 			throw ParserError.fromWasmError(error);
 		}
@@ -383,13 +409,13 @@ var Parser = class Parser {
 	* Format SQL by parsing and regenerating it (round-trip)
 	*
 	* @param sql - SQL string to format
-	* @param dialect - SQL dialect to use
+	* @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
 	* @returns Formatted SQL string
 	*/
-	static format(sql, dialect = new GenericDialect()) {
+	static format(sql, dialect = "generic") {
 		const wasm = getWasmModule();
 		try {
-			return wasm.format_sql(dialect.name, sql);
+			return wasm.format_sql(resolveDialect(dialect).name, sql);
 		} catch (error) {
 			throw ParserError.fromWasmError(error);
 		}
@@ -398,13 +424,13 @@ var Parser = class Parser {
 	* Validate SQL syntax without returning the full AST
 	*
 	* @param sql - SQL string to validate
-	* @param dialect - SQL dialect to use
+	* @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
 	* @returns true if valid, throws ParserError if invalid
 	*/
-	static validate(sql, dialect = new GenericDialect()) {
+	static validate(sql, dialect = "generic") {
 		const wasm = getWasmModule();
 		try {
-			return wasm.validate_sql(dialect.name, sql);
+			return wasm.validate_sql(resolveDialect(dialect).name, sql);
 		} catch (error) {
 			throw ParserError.fromWasmError(error);
 		}
@@ -416,6 +442,61 @@ var Parser = class Parser {
 		return getWasmModule().get_supported_dialects();
 	}
 };
+/**
+* Parse SQL statements (convenience function)
+*
+* @param sql - SQL string to parse
+* @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
+* @returns Array of parsed statements
+*
+* @example
+* ```typescript
+* import { parse } from 'sqlparser-rs';
+*
+* const statements = parse('SELECT * FROM users');
+* const pgStatements = parse('SELECT $1', 'postgresql');
+* ```
+*/
+function parse(sql, dialect = "generic") {
+	return Parser.parse(sql, dialect);
+}
+/**
+* Validate SQL syntax (convenience function)
+*
+* @param sql - SQL string to validate
+* @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
+* @returns true if valid, throws ParserError if invalid
+*
+* @example
+* ```typescript
+* import { validate } from 'sqlparser-rs';
+*
+* if (validate('SELECT * FROM users')) {
+*   console.log('Valid SQL!');
+* }
+* ```
+*/
+function validate(sql, dialect = "generic") {
+	return Parser.validate(sql, dialect);
+}
+/**
+* Format SQL by parsing and regenerating it (convenience function)
+*
+* @param sql - SQL string to format
+* @param dialect - SQL dialect to use (string name or Dialect instance, defaults to 'generic')
+* @returns Formatted SQL string
+*
+* @example
+* ```typescript
+* import { format } from 'sqlparser-rs';
+*
+* const formatted = format('select * from users');
+* // Returns: "SELECT * FROM users"
+* ```
+*/
+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, initWasm };
+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

@@ -1,6 +1,6 @@
 {
   "name": "sqlparser-rs",
-  "version": "0.60.3-rc1",
+  "version": "0.60.3-rc3",
   "type": "module",
   "description": "A SQL parser for JavaScript and TypeScript, powered by datafusion-sqlparser-rs via WASM",
   "main": "dist/index.cjs",
@@ -18,19 +18,6 @@
     "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",
@@ -44,7 +31,7 @@
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/guan404ming/sqlparser-rs"
+    "url": "git+https://github.com/guan404ming/sqlparser-rs.git"
   },
   "devDependencies": {
     "@types/node": "^25.0.10",
@@ -58,5 +45,17 @@
   },
   "engines": {
     "node": ">=16.0.0"
+  },
+  "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",
+    "local:pack": "npm run build:ts && npm pack",
+    "local:link": "npm run build:ts && npm link"
   }
-}
+}