sqlparser-devexpress 2.3.3 → 2.3.5

package/README.md

@@ -126,6 +126,60 @@ console.log("DevExpress Filter:", JSON.stringify(devexpressFilter, null, 2));
   const devexpressFilter = convertAstToDevextreme(ast, sampleState, false); // Disables short-circuiting
   ```
 
+### **DevExtreme with React Example**
+
+First, install the necessary DevExtreme packages:
+
+```sh
+npm install devextreme devextreme-react
+```
+
+Now, create a simple React component that integrates DevExtreme with the `sqlparser-devexpress` library:
+
+```javascript
+import React, { useState } from 'react';
+import DataGrid, { Column, FilterRow, HeaderFilter } from 'devextreme-react/data-grid';
+import 'devextreme/dist/css/dx.light.css';
+import { convertSQLToAst, convertAstToDevextreme } from 'sqlparser-devexpress';
+
+const App = () => {
+  const [data, setData] = useState([
+    { OrderID: 76548, Status: 1 },
+    { OrderID: 76549, Status: 3 },
+    { OrderID: 76550, Status: 2 },
+  ]);
+
+  const sqlQuery = "OrderID = {CustomerOrders.OrderID} OR Status IN (1, 3)";
+  const { ast, variables } = convertSQLToAst(sqlQuery);
+
+  // Extracted state for dynamic variables (usually fetched from your app state)
+  const sampleState = { "CustomerOrders.OrderID": 76548 };
+
+  const devexpressFilter = convertAstToDevextreme(ast, sampleState);
+
+  return (
+    <div>
+      <DataGrid dataSource={data} filterValue={devexpressFilter}>
+        <Column dataField="OrderID" />
+        <Column dataField="Status" />
+        <FilterRow visible={true} />
+        <HeaderFilter visible={true} />
+      </DataGrid>
+    </div>
+  );
+};
+
+export default App;
+```
+
+### **Explanation**:
+1. **DataGrid**: Displays the data with filtering.
+2. **convertSQLToAst**: Converts the SQL `WHERE` clause into an AST.
+3. **convertAstToDevextreme**: Converts the AST to the DevExtreme filter format.
+4. **filterValue**: Applies the filter to the `DataGrid`.
+
+This is a simple integration where the filter from SQLParser is used to filter the grid data in a React app using DevExtreme's `DataGrid`.
+
 ## Roadmap
 
 - Support for additional SQL operators and functions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqlparser-devexpress",
-  "version": "2.3.3",
+  "version": "2.3.5",
   "main": "src/index.js",
   "type": "module",
   "scripts": {

package/src/@types/default.d.ts

@@ -12,7 +12,7 @@ export interface ParsedResult {
 
 export interface ConvertToDevExpressFormatParams {
     ast: any; // Define a more specific type if possible
-    resultObject: StateDataObject;
+    resultObject?: StateDataObject | null;
     enableShortCircuit?: boolean;
 }
 

package/src/core/converter.js

@@ -136,14 +136,20 @@ function DevExpressConverter() {
 
         const left = ast.left !== undefined ? processAstNode(ast.left) : convertValue(ast.field);
         const right = ast.right !== undefined ? processAstNode(ast.right) : convertValue(ast.value);
-        const operatorToken = ast.operator.toLowerCase();
+        let operatorToken = ast.operator.toLowerCase();
+
+        if(operatorToken === "like") {
+            operatorToken = "contains";
+        }else if (operatorToken === "not like") {
+            operatorToken = "notcontains";
+        }
 
         let comparison = [left, operatorToken, right];
 
         if ((ast.left && isFunctionNullCheck(ast.left, true)) || (ast.value && isFunctionNullCheck(ast.value, false))) {
-            comparison = [[left, operatorToken, right], 'or', [left, operatorToken, null]];
+            comparison = [[left, operatorToken, right], 'or', [left, operatorToken, null, {type: "ISNULL", defaultValue: (ast.left ?? ast.value).args[1]?.value}]];
         } else if (ast.right && isFunctionNullCheck(ast.right, true)) {
-            comparison = [[left, operatorToken, right], 'or', [right, operatorToken, null]];
+            comparison = [[left, operatorToken, right], 'or', [right, operatorToken, null, {type: "ISNULL", defaultValue: ast.right.args[1]?.value}]];
         }
 
         // Apply short-circuit evaluation if enabled
@@ -322,7 +328,7 @@ function DevExpressConverter() {
      * @returns {boolean} True if the condition is always true.
      */
     function isAlwaysTrue(condition) {
-        return Array.isArray(condition) && condition.length === 3 && evaluateExpression(...condition) == true;
+        return Array.isArray(condition) && condition.length >= 3 && evaluateExpression(...condition) == true;
     }
 
     /**
@@ -331,7 +337,7 @@ function DevExpressConverter() {
      * @returns {boolean} True if the condition is always false.
      */
     function isAlwaysFalse(condition) {
-        return Array.isArray(condition) && condition.length === 3 && evaluateExpression(...condition) == false;
+        return Array.isArray(condition) && condition.length >= 3 && evaluateExpression(...condition) == false;
     }
 
     /**

package/src/core/parser.js

@@ -173,6 +173,15 @@ export function parse(input, variables = []) {
 			if (currentToken.type === "function") {
 				const functionNode = parseFunction();
 
+				if(fieldType === "identifier" && functionNode.type === "function") {
+					return {
+						type: "comparison",
+						field,
+						operator,
+						value: functionNode
+					}
+				}
+
 				// Wrap the function inside a comparison if it's directly after an operator
 				const leftComparison = {
 					type: "comparison",

package/src/debug.js

@@ -28,7 +28,7 @@
 //     return convertToDevExpressFormat({ ast: astTree, resultObject: sampleData });
 // }
 
-// const devexpress = parseFilterString("(ISNULL(TicketID, 0) = ISNULL({CustomerOrders.OrderID}, 0))", sampleData);
+// const devexpress = parseFilterString("CompanyID not like '{CustomerOrders.OrderID}'", sampleData);
 // console.log("DevExpress Filter:", JSON.stringify(devexpress, null, 2));
 // // const devexpress = parseFilterString("(RS2ID in ({LeadStatementGlobalRpt.StateID}) Or ({LeadStatementGlobalRpt.StateID} =0)) And (RS3ID  in (0,{LeadStatementGlobalRpt.RegionID}) Or {LeadStatementGlobalRpt.RegionID} =0 )", sampleData);
 

package/src/index.js

@@ -16,7 +16,7 @@ export function convertSQLToAst(filterString, enableConsoleLogs = false) {
     return parsedResult;
 }
 
-export function convertAstToDevextreme(ast, state, enableShortCircuit = true) {
+export function convertAstToDevextreme(ast, state = null, enableShortCircuit = true) {
     return convertToDevExpressFormat({ ast, resultObject: state, enableShortCircuit })
 }
 

package/tests/parser.test.js

@@ -137,11 +137,11 @@ describe("Parser SQL to dx Filter Builder", () => {
             expected: [
                 ["SourceID", "=", 2],
                 "or",
-                ["SourceID", "=", null],
+                ["SourceID", "=", null,{ "defaultValue": 0, "type": "ISNULL"}],
                 "or",
                 ["SourceID", "=", 0],
                 "or",
-                ["SourceID", "=", null]
+                ["SourceID", "=", null,{ "defaultValue": 0, "type": "ISNULL"}]
             ]
         },
         {
@@ -153,14 +153,14 @@ describe("Parser SQL to dx Filter Builder", () => {
                     [
                         ["CompanyID", "=", 0],
                         "or",
-                        ["CompanyID", "=", null]
+                        ["CompanyID", "=", null,{ "defaultValue": 0, "type": "ISNULL"}]
                     ]
                 ],
                 "and",
                 [
                     ["IsSubdealer", "=", true],
                     "or",
-                    ["IsSubdealer", "=", null]
+                    ["IsSubdealer", "=", null,{ "defaultValue": 0, "type": "ISNULL"}]
                 ]
             ]
         },
@@ -187,7 +187,7 @@ describe("Parser SQL to dx Filter Builder", () => {
             expected: [
                 ["TicketID", "=", 123],
                 "or",
-                ["TicketID", "=", null]
+                ["TicketID", "=", null,{ "defaultValue": 0, "type": "ISNULL"}]
             ]
         },
         {
@@ -195,13 +195,23 @@ describe("Parser SQL to dx Filter Builder", () => {
             expected: [
                 ["CompanyID", "=", 7],
                 "or",
-                ["CompanyID", "=", null],
+                ["CompanyID", "=", null,{ "defaultValue": 0, "type": "ISNULL"}],
                 "or",
                 ["CompanyID", "=", 0],
                 "or",
-                ["CompanyID", "=", null]
+                ["CompanyID", "=", null,{ "defaultValue": 0, "type": "ISNULL"},
+
+                ]
                 
             ]
+        },
+        {
+            input: "CompanyName like '{LeadDocument.CompanyID}' AND BranchName not like '{LeadDocument.BranchID}'",
+            expected: [
+                ["CompanyName", "contains", "7"],
+                "and",
+                ["BranchName", "notcontains", "42"]
+            ]
         }
     ];