sqlparser-rs 0.60.3 → 0.60.4

package/dist/index.d.cts

@@ -101,20 +101,7 @@ declare class OracleDialect implements Dialect {
  */
 declare const SUPPORTED_DIALECTS: readonly ["generic", "ansi", "mysql", "postgresql", "sqlite", "snowflake", "redshift", "mssql", "clickhouse", "bigquery", "duckdb", "databricks", "hive", "oracle"];
 type DialectName = (typeof SUPPORTED_DIALECTS)[number];
-/**
- * Create a dialect instance from a string name
- *
- * @param name - The name of the dialect (case-insensitive)
- * @returns A dialect instance, or undefined if the dialect is not recognized
- *
- * @example
- * ```typescript
- * const dialect = dialectFromString('postgresql');
- * if (dialect) {
- *   const ast = Parser.parse('SELECT 1', dialect);
- * }
- * ```
- */
+/** Create a dialect instance from a string name (case-insensitive) */
 declare function dialectFromString(name: string): Dialect | undefined;
 //#endregion
 //#region src/types/ast.d.ts
@@ -1215,120 +1202,83 @@ type MergeClause = {
 };
 type CommentObject = 'Column' | 'Table';
 //#endregion
+//#region src/wasm.d.ts
+/**
+ * Wait for WASM module to be ready
+ */
+declare function ready(): Promise<void>;
+/**
+ * Initialize the WASM module explicitly.
+ * Usually not needed - the module auto-initializes on first use.
+ */
+declare function initWasm(): Promise<void>;
+//#endregion
 //#region src/parser.d.ts
+/** Dialect can be specified as a Dialect instance or a string name */
+type DialectInput = Dialect | DialectName;
 /**
  * Parser options
  */
 interface ParserOptions {
-  /**
-   * Allow trailing commas in SELECT lists
-   */
+  /** Allow trailing commas in SELECT lists */
   trailingCommas?: boolean;
-  /**
-   * Maximum recursion depth for parsing nested expressions
-   */
+  /** Maximum recursion depth for parsing nested expressions */
   recursionLimit?: number;
 }
 /**
- * SQL Parser
- *
- * Parses SQL statements into an Abstract Syntax Tree (AST).
+ * SQL Parser - parses SQL statements into AST
  *
  * @example
  * ```typescript
  * import { Parser, PostgreSqlDialect } from 'sqlparser-rs';
  *
- * // Simple parsing
- * const statements = Parser.parse('SELECT * FROM users', new PostgreSqlDialect());
+ * const statements = Parser.parse('SELECT * FROM users', 'postgresql');
  *
- * // With builder pattern
+ * // With options
  * const parser = new Parser(new PostgreSqlDialect())
- *   .withRecursionLimit(50)
  *   .withOptions({ trailingCommas: true });
- *
- * const ast = parser.parse('SELECT * FROM users');
+ * const ast = parser.parse('SELECT a, b, FROM users');
  * ```
  */
 declare class Parser {
   private dialect;
   private options;
-  /**
-   * Create a new parser instance
-   *
-   * @param dialect - The SQL dialect to use (defaults to GenericDialect)
-   */
   constructor(dialect?: Dialect);
-  /**
-   * Set the recursion limit for parsing nested expressions
-   *
-   * @param limit - Maximum recursion depth
-   * @returns This parser instance for chaining
-   */
+  /** Set recursion limit for parsing nested expressions */
   withRecursionLimit(limit: number): Parser;
-  /**
-   * Set parser options
-   *
-   * @param options - Parser options
-   * @returns This parser instance for chaining
-   */
+  /** Set parser options */
   withOptions(options: ParserOptions): Parser;
-  /**
-   * Parse SQL statements
-   *
-   * @param sql - SQL string to parse
-   * @returns Array of parsed statements
-   */
+  /** Parse SQL statements */
   parse(sql: string): Statement[];
+  /** Parse SQL into AST */
+  static parse(sql: string, dialect?: DialectInput): Statement[];
+  /** Parse SQL and return AST as JSON string */
+  static parseToJson(sql: string, dialect?: DialectInput): string;
+  /** Parse SQL and return formatted string representation */
+  static parseToString(sql: string, dialect?: DialectInput): string;
+  /** Format SQL by parsing and regenerating it */
+  static format(sql: string, dialect?: DialectInput): string;
   /**
-   * Parse SQL statements
-   *
-   * @param sql - SQL string to parse
-   * @param dialect - SQL dialect to use
-   * @returns Array of parsed statements
-   *
-   * @example
-   * ```typescript
-   * const statements = Parser.parse('SELECT 1', new GenericDialect());
-   * ```
-   */
-  static parse(sql: string, dialect?: Dialect): Statement[];
-  /**
-   * Parse SQL and return the AST as a JSON string
-   *
-   * @param sql - SQL string to parse
-   * @param dialect - SQL dialect to use
-   * @returns JSON string representation of the AST
-   */
-  static parseToJson(sql: string, dialect?: Dialect): string;
-  /**
-   * Parse SQL and return a formatted string representation
-   *
-   * @param sql - SQL string to parse
-   * @param dialect - SQL dialect to use
-   * @returns String representation of the parsed SQL
-   */
-  static parseToString(sql: string, dialect?: Dialect): string;
-  /**
-   * Format SQL by parsing and regenerating it (round-trip)
-   *
-   * @param sql - SQL string to format
-   * @param dialect - SQL dialect to use
-   * @returns Formatted SQL string
-   */
-  static format(sql: string, dialect?: Dialect): string;
-  /**
-   * Validate SQL syntax without returning the full AST
-   *
-   * @param sql - SQL string to validate
-   * @param dialect - SQL dialect to use
-   * @returns true if valid, throws ParserError if invalid
-   */
-  static validate(sql: string, dialect?: Dialect): boolean;
-  /**
-   * Get the list of supported dialect names
+   * Validate SQL syntax
+   * @throws ParserError if SQL is invalid
    */
+  static validate(sql: string, dialect?: DialectInput): boolean;
+  /** Get list of supported dialect names */
   static getSupportedDialects(): string[];
 }
+/**
+ * Parse SQL into AST
+ */
+declare function parse(sql: string, dialect?: DialectInput): Statement[];
+/**
+ * Validate SQL syntax
+ * @throws ParserError if SQL is invalid
+ */
+declare function validate(sql: string, dialect?: DialectInput): boolean;
+/**
+ * Format SQL by parsing and regenerating it
+ */
+declare function format(sql: string, dialect?: DialectInput): string;
 //#endregion
 //#region src/types/errors.d.ts
 /**
@@ -1356,4 +1306,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 };
+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.d.mts

@@ -101,20 +101,7 @@ declare class OracleDialect implements Dialect {
  */
 declare const SUPPORTED_DIALECTS: readonly ["generic", "ansi", "mysql", "postgresql", "sqlite", "snowflake", "redshift", "mssql", "clickhouse", "bigquery", "duckdb", "databricks", "hive", "oracle"];
 type DialectName = (typeof SUPPORTED_DIALECTS)[number];
-/**
- * Create a dialect instance from a string name
- *
- * @param name - The name of the dialect (case-insensitive)
- * @returns A dialect instance, or undefined if the dialect is not recognized
- *
- * @example
- * ```typescript
- * const dialect = dialectFromString('postgresql');
- * if (dialect) {
- *   const ast = Parser.parse('SELECT 1', dialect);
- * }
- * ```
- */
+/** Create a dialect instance from a string name (case-insensitive) */
 declare function dialectFromString(name: string): Dialect | undefined;
 //#endregion
 //#region src/types/ast.d.ts
@@ -1215,120 +1202,83 @@ type MergeClause = {
 };
 type CommentObject = 'Column' | 'Table';
 //#endregion
+//#region src/wasm.d.ts
+/**
+ * Wait for WASM module to be ready
+ */
+declare function ready(): Promise<void>;
+/**
+ * Initialize the WASM module explicitly.
+ * Usually not needed - the module auto-initializes on first use.
+ */
+declare function initWasm(): Promise<void>;
+//#endregion
 //#region src/parser.d.ts
+/** Dialect can be specified as a Dialect instance or a string name */
+type DialectInput = Dialect | DialectName;
 /**
  * Parser options
  */
 interface ParserOptions {
-  /**
-   * Allow trailing commas in SELECT lists
-   */
+  /** Allow trailing commas in SELECT lists */
   trailingCommas?: boolean;
-  /**
-   * Maximum recursion depth for parsing nested expressions
-   */
+  /** Maximum recursion depth for parsing nested expressions */
   recursionLimit?: number;
 }
 /**
- * SQL Parser
- *
- * Parses SQL statements into an Abstract Syntax Tree (AST).
+ * SQL Parser - parses SQL statements into AST
  *
  * @example
  * ```typescript
  * import { Parser, PostgreSqlDialect } from 'sqlparser-rs';
  *
- * // Simple parsing
- * const statements = Parser.parse('SELECT * FROM users', new PostgreSqlDialect());
+ * const statements = Parser.parse('SELECT * FROM users', 'postgresql');
  *
- * // With builder pattern
+ * // With options
  * const parser = new Parser(new PostgreSqlDialect())
- *   .withRecursionLimit(50)
  *   .withOptions({ trailingCommas: true });
- *
- * const ast = parser.parse('SELECT * FROM users');
+ * const ast = parser.parse('SELECT a, b, FROM users');
  * ```
  */
 declare class Parser {
   private dialect;
   private options;
-  /**
-   * Create a new parser instance
-   *
-   * @param dialect - The SQL dialect to use (defaults to GenericDialect)
-   */
   constructor(dialect?: Dialect);
-  /**
-   * Set the recursion limit for parsing nested expressions
-   *
-   * @param limit - Maximum recursion depth
-   * @returns This parser instance for chaining
-   */
+  /** Set recursion limit for parsing nested expressions */
   withRecursionLimit(limit: number): Parser;
-  /**
-   * Set parser options
-   *
-   * @param options - Parser options
-   * @returns This parser instance for chaining
-   */
+  /** Set parser options */
   withOptions(options: ParserOptions): Parser;
-  /**
-   * Parse SQL statements
-   *
-   * @param sql - SQL string to parse
-   * @returns Array of parsed statements
-   */
+  /** Parse SQL statements */
   parse(sql: string): Statement[];
+  /** Parse SQL into AST */
+  static parse(sql: string, dialect?: DialectInput): Statement[];
+  /** Parse SQL and return AST as JSON string */
+  static parseToJson(sql: string, dialect?: DialectInput): string;
+  /** Parse SQL and return formatted string representation */
+  static parseToString(sql: string, dialect?: DialectInput): string;
+  /** Format SQL by parsing and regenerating it */
+  static format(sql: string, dialect?: DialectInput): string;
   /**
-   * Parse SQL statements
-   *
-   * @param sql - SQL string to parse
-   * @param dialect - SQL dialect to use
-   * @returns Array of parsed statements
-   *
-   * @example
-   * ```typescript
-   * const statements = Parser.parse('SELECT 1', new GenericDialect());
-   * ```
-   */
-  static parse(sql: string, dialect?: Dialect): Statement[];
-  /**
-   * Parse SQL and return the AST as a JSON string
-   *
-   * @param sql - SQL string to parse
-   * @param dialect - SQL dialect to use
-   * @returns JSON string representation of the AST
-   */
-  static parseToJson(sql: string, dialect?: Dialect): string;
-  /**
-   * Parse SQL and return a formatted string representation
-   *
-   * @param sql - SQL string to parse
-   * @param dialect - SQL dialect to use
-   * @returns String representation of the parsed SQL
-   */
-  static parseToString(sql: string, dialect?: Dialect): string;
-  /**
-   * Format SQL by parsing and regenerating it (round-trip)
-   *
-   * @param sql - SQL string to format
-   * @param dialect - SQL dialect to use
-   * @returns Formatted SQL string
-   */
-  static format(sql: string, dialect?: Dialect): string;
-  /**
-   * Validate SQL syntax without returning the full AST
-   *
-   * @param sql - SQL string to validate
-   * @param dialect - SQL dialect to use
-   * @returns true if valid, throws ParserError if invalid
-   */
-  static validate(sql: string, dialect?: Dialect): boolean;
-  /**
-   * Get the list of supported dialect names
+   * Validate SQL syntax
+   * @throws ParserError if SQL is invalid
    */
+  static validate(sql: string, dialect?: DialectInput): boolean;
+  /** Get list of supported dialect names */
   static getSupportedDialects(): string[];
 }
+/**
+ * Parse SQL into AST
+ */
+declare function parse(sql: string, dialect?: DialectInput): Statement[];
+/**
+ * Validate SQL syntax
+ * @throws ParserError if SQL is invalid
+ */
+declare function validate(sql: string, dialect?: DialectInput): boolean;
+/**
+ * Format SQL by parsing and regenerating it
+ */
+declare function format(sql: string, dialect?: DialectInput): string;
 //#endregion
 //#region src/types/errors.d.ts
 /**
@@ -1356,4 +1306,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 };
+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 };