sqlparser-rs 0.60.4 → 0.61.1

package/wasm/README.md

@@ -1,11 +1,12 @@
-# sqlparser-rs
+# sqlparser-ts
 
-[![npm version](https://img.shields.io/npm/v/sqlparser-rs.svg)](https://www.npmjs.com/package/sqlparser-rs)
+[![npm version](https://img.shields.io/npm/v/@guanmingchiu/sqlparser-ts.svg)](https://www.npmjs.com/package/@guanmingchiu/sqlparser-ts)
+[![npm downloads](https://img.shields.io/npm/dm/@guanmingchiu/sqlparser-ts.svg)](https://www.npmjs.com/package/@guanmingchiu/sqlparser-ts)
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
 [![WebAssembly](https://img.shields.io/badge/WebAssembly-powered-blueviolet.svg)](https://webassembly.org/)
-[![sqlparser](https://img.shields.io/badge/sqlparser--rs-v0.60.0-orange.svg)](https://github.com/apache/datafusion-sqlparser-rs)
+[![sqlparser](https://img.shields.io/badge/sqlparser--rs-v0.61.0-orange.svg)](https://github.com/apache/datafusion-sqlparser-rs)
 
-A SQL parser for JavaScript and TypeScript, powered by [datafusion-sqlparser-rs](https://github.com/apache/datafusion-sqlparser-rs) via WebAssembly.
+SQL parser for JavaScript and TypeScript, powered by [datafusion-sqlparser-rs](https://github.com/apache/datafusion-sqlparser-rs) via WebAssembly.
 
 ## Features
 
@@ -18,13 +19,16 @@ A SQL parser for JavaScript and TypeScript, powered by [datafusion-sqlparser-rs]
 ## Installation
 
 ```bash
-npm install sqlparser-rs
+npm install @guanmingchiu/sqlparser-ts
 ```
 
 ## Usage
 
 ```typescript
-import { parse, format, validate } from 'sqlparser-rs';
+import { init, parse, format, validate } from '@guanmingchiu/sqlparser-ts';
+
+// Initialize WASM module (must be called once before using any parser functions)
+await init();
 
 // Parse SQL into AST
 const ast = parse('SELECT * FROM users');
@@ -40,6 +44,19 @@ const sql = format('select   *   from   users');
 validate('SELECT * FROM users'); // ok
 ```
 
+### Vite Configuration
+
+WASM packages must be excluded from Vite's dev server [dependency pre-bundling](https://github.com/vitejs/vite/discussions/9256). This only affects the dev server. Production builds use Rollup instead of esbuild and handle WASM files correctly.
+
+```typescript
+// vite.config.ts
+export default defineConfig({
+  optimizeDeps: {
+    exclude: ['@guanmingchiu/sqlparser-ts'],
+  },
+});
+```
+
 ### Working with AST
 
 ```typescript
@@ -74,6 +91,15 @@ try {
 
 `generic`, `ansi`, `mysql`, `postgresql`, `sqlite`, `snowflake`, `redshift`, `mssql`, `clickhouse`, `bigquery`, `duckdb`, `databricks`, `hive`, `oracle`
 
+## Versioning
+
+Follows [Semantic Versioning](https://semver.org/) with upstream tracking:
+
+- MAJOR.MINOR: Tracks upstream [datafusion-sqlparser-rs](https://github.com/apache/datafusion-sqlparser-rs)
+- PATCH: sqlparser-ts specific releases
+
+Example: `0.60.4` = upstream 0.60 + 4 sqlparser-ts releases
+
 ## License
 
 Apache-2.0

package/wasm/package.json

@@ -1,11 +1,12 @@
 {
   "name": "sqlparser-rs-wasm",
-  "description": "WebAssembly bindings for sqlparser-rs SQL parser",
-  "version": "0.60.4",
+  "type": "module",
+  "description": "WebAssembly bindings for sqlparser SQL parser",
+  "version": "0.61.1",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/guan404ming/sqlparser-rs"
+    "url": "https://github.com/guanmingchiu/sqlparser-ts"
   },
   "files": [
     "sqlparser_rs_wasm_bg.wasm",
@@ -13,5 +14,8 @@
     "sqlparser_rs_wasm.d.ts"
   ],
   "main": "sqlparser_rs_wasm.js",
-  "types": "sqlparser_rs_wasm.d.ts"
+  "types": "sqlparser_rs_wasm.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ]
 }

package/wasm/sqlparser_rs_wasm.d.ts

@@ -37,3 +37,47 @@ export function parse_sql_with_options(dialect: string, sql: string, options: an
  * Validate SQL syntax without returning the full AST
  */
 export function validate_sql(dialect: string, sql: string): boolean;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly format_sql: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly get_supported_dialects: () => any;
+    readonly init: () => void;
+    readonly parse_sql: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly parse_sql_to_json_string: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly parse_sql_to_string: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly parse_sql_with_options: (a: number, b: number, c: number, d: number, e: any) => [number, number, number];
+    readonly validate_sql: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/wasm/sqlparser_rs_wasm.js

@@ -6,7 +6,7 @@
  * @param {string} sql
  * @returns {string}
  */
-function format_sql(dialect, sql) {
+export function format_sql(dialect, sql) {
     let deferred4_0;
     let deferred4_1;
     try {
@@ -28,22 +28,19 @@ function format_sql(dialect, sql) {
         wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
     }
 }
-exports.format_sql = format_sql;
 
 /**
  * Get a list of all supported dialect names
  * @returns {any}
  */
-function get_supported_dialects() {
+export function get_supported_dialects() {
     const ret = wasm.get_supported_dialects();
     return ret;
 }
-exports.get_supported_dialects = get_supported_dialects;
 
-function init() {
+export function init() {
     wasm.init();
 }
-exports.init = init;
 
 /**
  * Parse SQL and return the AST as a JSON value
@@ -51,7 +48,7 @@ exports.init = init;
  * @param {string} sql
  * @returns {any}
  */
-function parse_sql(dialect, sql) {
+export function parse_sql(dialect, sql) {
     const ptr0 = passStringToWasm0(dialect, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len0 = WASM_VECTOR_LEN;
     const ptr1 = passStringToWasm0(sql, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
@@ -62,7 +59,6 @@ function parse_sql(dialect, sql) {
     }
     return takeFromExternrefTable0(ret[0]);
 }
-exports.parse_sql = parse_sql;
 
 /**
  * Parse SQL and return the AST as a JSON string
@@ -70,7 +66,7 @@ exports.parse_sql = parse_sql;
  * @param {string} sql
  * @returns {string}
  */
-function parse_sql_to_json_string(dialect, sql) {
+export function parse_sql_to_json_string(dialect, sql) {
     let deferred4_0;
     let deferred4_1;
     try {
@@ -92,7 +88,6 @@ function parse_sql_to_json_string(dialect, sql) {
         wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
     }
 }
-exports.parse_sql_to_json_string = parse_sql_to_json_string;
 
 /**
  * Parse SQL and return a string representation of the AST
@@ -100,7 +95,7 @@ exports.parse_sql_to_json_string = parse_sql_to_json_string;
  * @param {string} sql
  * @returns {string}
  */
-function parse_sql_to_string(dialect, sql) {
+export function parse_sql_to_string(dialect, sql) {
     let deferred4_0;
     let deferred4_1;
     try {
@@ -122,7 +117,6 @@ function parse_sql_to_string(dialect, sql) {
         wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
     }
 }
-exports.parse_sql_to_string = parse_sql_to_string;
 
 /**
  * Parse SQL with options and return the AST as a JSON value
@@ -131,7 +125,7 @@ exports.parse_sql_to_string = parse_sql_to_string;
  * @param {any} options
  * @returns {any}
  */
-function parse_sql_with_options(dialect, sql, options) {
+export function parse_sql_with_options(dialect, sql, options) {
     const ptr0 = passStringToWasm0(dialect, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len0 = WASM_VECTOR_LEN;
     const ptr1 = passStringToWasm0(sql, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
@@ -142,7 +136,6 @@ function parse_sql_with_options(dialect, sql, options) {
     }
     return takeFromExternrefTable0(ret[0]);
 }
-exports.parse_sql_with_options = parse_sql_with_options;
 
 /**
  * Validate SQL syntax without returning the full AST
@@ -150,7 +143,7 @@ exports.parse_sql_with_options = parse_sql_with_options;
  * @param {string} sql
  * @returns {boolean}
  */
-function validate_sql(dialect, sql) {
+export function validate_sql(dialect, sql) {
     const ptr0 = passStringToWasm0(dialect, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len0 = WASM_VECTOR_LEN;
     const ptr1 = passStringToWasm0(sql, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
@@ -161,7 +154,6 @@ function validate_sql(dialect, sql) {
     }
     return ret[0] !== 0;
 }
-exports.validate_sql = validate_sql;
 
 function __wbg_get_imports() {
     const import0 = {
@@ -515,7 +507,15 @@ function takeFromExternrefTable0(idx) {
 
 let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
 cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
 function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
     return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
 }
 
@@ -534,8 +534,95 @@ if (!('encodeInto' in cachedTextEncoder)) {
 
 let WASM_VECTOR_LEN = 0;
 
-const wasmPath = `${__dirname}/sqlparser_rs_wasm_bg.wasm`;
-const wasmBytes = require('fs').readFileSync(wasmPath);
-const wasmModule = new WebAssembly.Module(wasmBytes);
-const wasm = new WebAssembly.Instance(wasmModule, __wbg_get_imports()).exports;
-wasm.__wbindgen_start();
+let wasmModule, wasm;
+function __wbg_finalize_init(instance, module) {
+    wasm = instance.exports;
+    wasmModule = module;
+    cachedDataViewMemory0 = null;
+    cachedUint8ArrayMemory0 = null;
+    wasm.__wbindgen_start();
+    return wasm;
+}
+
+async function __wbg_load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+            } catch (e) {
+                const validResponse = module.ok && expectedResponseType(module.type);
+
+                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else { throw e; }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+        } else {
+            return instance;
+        }
+    }
+
+    function expectedResponseType(type) {
+        switch (type) {
+            case 'basic': case 'cors': case 'default': return true;
+        }
+        return false;
+    }
+}
+
+function initSync(module) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module !== undefined) {
+        if (Object.getPrototypeOf(module) === Object.prototype) {
+            ({module} = module)
+        } else {
+            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+        }
+    }
+
+    const imports = __wbg_get_imports();
+    if (!(module instanceof WebAssembly.Module)) {
+        module = new WebAssembly.Module(module);
+    }
+    const instance = new WebAssembly.Instance(module, imports);
+    return __wbg_finalize_init(instance, module);
+}
+
+async function __wbg_init(module_or_path) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module_or_path !== undefined) {
+        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+            ({module_or_path} = module_or_path)
+        } else {
+            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+        }
+    }
+
+    if (module_or_path === undefined) {
+        module_or_path = new URL('sqlparser_rs_wasm_bg.wasm', import.meta.url);
+    }
+    const imports = __wbg_get_imports();
+
+    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+        module_or_path = fetch(module_or_path);
+    }
+
+    const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+export { initSync, __wbg_init as default };