model WHERE clause

packages/language-server/package.json

@@ -19,7 +19,7 @@
     "antlr4": "4.8.0",
     "vscode-languageserver": "6.1.1",
     "vscode-languageserver-textdocument": "1.0.1",
-    "@salesforce/soql-parser": "file:../../Dependencies/soql-parser-0.16.0.tgz"
+    "@salesforce/soql-parser": "file:../../Dependencies/salesforce-soql-parser-0.17.0.tgz"
   },
   "devDependencies": {
     "@babel/core": "^7.12.3",

packages/language-server/scripts/unbundle-parser.js

@@ -5,7 +5,7 @@ var path = require('path');
 var packagePath = '../package.json';
 var package = require(packagePath);
 var parser = '@salesforce/soql-parser';
-var tarballPath = 'file:../../Dependencies/soql-parser-0.16.0.tgz';
+var tarballPath = 'file:../../Dependencies/salesforce-soql-parser-0.17.0.tgz';
 
 delete package.bundledDependencies;
 package.dependencies[parser] = tarballPath;

packages/soql-model/package.json

@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "antlr4": "4.8.0",
-    "@salesforce/soql-parser": "file:../../Dependencies/soql-parser-0.16.0.tgz"
+    "@salesforce/soql-parser": "file:../../Dependencies/salesforce-soql-parser-0.17.0.tgz"
   },
   "devDependencies": {
     "@types/antlr4": "4.7.2",

packages/soql-model/scripts/getquery.js

@@ -13,7 +13,21 @@ var selectExprs = fields.map(
 var queryModel = new model.Impl.QueryImpl(
   new model.Impl.SelectExprsImpl(selectExprs),
   new model.Impl.FromImpl(sobjectName),
-  new model.Impl.UnmodeledSyntaxImpl('WHERE field1 = 5'),
+  new model.Impl.WhereImpl(
+    new model.Impl.AndOrConditionImpl(
+      new model.Impl.FieldCompareConditionImpl(
+        new model.Impl.FieldRefImpl('field1'),
+        model.Soql.CompareOperator.LT,
+        new model.Impl.LiteralImpl(model.Soql.LiteralType.Number, '5')
+      ),
+      'And',
+      new model.Impl.FieldCompareConditionImpl(
+        new model.Impl.FieldRefImpl('field2'),
+        model.Soql.CompareOperator.GT,
+        new model.Impl.LiteralImpl(model.Soql.LiteralType.Number, '5')
+      )
+    )
+  ),
   undefined,
   undefined,
   new model.Impl.OrderByImpl([

packages/soql-model/scripts/getsobject.js

@@ -5,7 +5,7 @@
 var model = require('../lib');
 
 var query =
-  'SELECT field1, field2 FROM object1 ORDER BY field1 DESC NULLS LAST, field2 ASC NULLS FIRST';
+  "SELECT field1, field2 FROM object1 WHERE field1='Hello' AND field2 < 1 ORDER BY field1 DESC NULLS LAST, field2 ASC NULLS FIRST";
 // var query =
 //   'SELECT field1, field2, field3 alias3, (SELECT fieldA FROM objectA), TYPEOF obj WHEN typeX THEN fieldX ELSE fieldY END FROM object1 ' +
 //   'WHERE field1 = 5 WITH DATA CATEGORY cat__c AT val__c GROUP BY field1 ORDER BY field2 DESC NULLS LAST LIMIT 20 OFFSET 2 BIND field1 = 5 FOR VIEW UPDATE TRACKING';
@@ -21,13 +21,15 @@ var fields =
     : undefined;
 var sObject = queryModel.from ? queryModel.from.sobjectName : undefined;
 var errors = queryModel.errors;
+var where = queryModel.where ? queryModel.where.toSoqlSyntax() : undefined;
 var orderBy = queryModel.orderBy.orderByExpressions.map(
   (expr) => `${expr.field.fieldName} ${expr.order} ${expr.nullsOrder}`
 );
 var limit = queryModel.limit ? queryModel.limit.limit : 'undefined';
 console.log(`Query:    ${query}`);
 console.log(`SObject:  ${sObject}`);
 console.log(`Fields:   ${fields}`);
+console.log(`Where:    ${where}`);
 console.log(`Order By: ${orderBy}`);
 console.log(`Limit:    ${limit}`);
 console.log(`Errors:   ${JSON.stringify(errors)}`);

packages/soql-model/scripts/unbundle-parser.js

@@ -5,7 +5,7 @@ var path = require('path');
 var packagePath = '../package.json';
 var package = require(packagePath);
 var parser = '@salesforce/soql-parser';
-var tarballPath = 'file:../../Dependencies/soql-parser-0.16.0.tgz';
+var tarballPath = 'file:../../Dependencies/salesforce-soql-parser-0.17.0.tgz';
 
 delete package.bundledDependencies;
 package.dependencies[parser] = tarballPath;

packages/soql-model/src/model/impl/andOrConditionImpl.test.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Impl from '.';
+import { AndOr, CompareOperator, LiteralType } from '../model';
+
+describe('AndOrConditionImpl should', () => {
+  it('store left and right conditions and the AndOr operator', () => {
+    const expected = {
+      leftCondition: { field: { fieldName: 'field' }, operator: '>', compareValue: { type: 'NUMBER', value: '1' } },
+      andOr: 'OR',
+      rightCondition: { field: { fieldName: 'field' }, operator: '<', compareValue: { type: 'NUMBER', value: '5' } }
+    };
+    const actual = new Impl.AndOrConditionImpl(
+      new Impl.FieldCompareConditionImpl(new Impl.FieldRefImpl('field'), CompareOperator.GT, new Impl.LiteralImpl(LiteralType.Number, '1')),
+      AndOr.Or,
+      new Impl.FieldCompareConditionImpl(new Impl.FieldRefImpl('field'), CompareOperator.LT, new Impl.LiteralImpl(LiteralType.Number, '5'))
+    );
+    expect(actual).toEqual(expected);
+  });
+  it('return left condition followed by AndOr operator followed by right condition for toSoqlSyntax()', () => {
+    const expected = 'field > 1 OR field < 5';
+    const actual = new Impl.AndOrConditionImpl(
+      new Impl.FieldCompareConditionImpl(new Impl.FieldRefImpl('field'), CompareOperator.GT, new Impl.LiteralImpl(LiteralType.Number, '1')),
+      AndOr.Or,
+      new Impl.FieldCompareConditionImpl(new Impl.FieldRefImpl('field'), CompareOperator.LT, new Impl.LiteralImpl(LiteralType.Number, '5'))
+    ).toSoqlSyntax();
+    expect(actual).toEqual(expected);
+  });
+});

packages/soql-model/src/model/impl/andOrConditionImpl.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Soql from '../model';
+import { SoqlModelObjectImpl } from './soqlModelObjectImpl';
+
+export class AndOrConditionImpl extends SoqlModelObjectImpl implements Soql.AndOrCondition {
+  public constructor(public leftCondition: Soql.Condition, public andOr: Soql.AndOr, public rightCondition: Soql.Condition) {
+    super();
+  }
+  public toSoqlSyntax(options?: Soql.SyntaxOptions): string {
+    return `${this.leftCondition.toSoqlSyntax(options)} ${this.andOr} ${this.rightCondition.toSoqlSyntax(options)}`;
+  }
+}

packages/soql-model/src/model/impl/fieldCompareConditionImpl.test.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Impl from '.';
+import { CompareOperator, LiteralType } from '../model';
+
+describe('FieldCompareConditionImpl should', () => {
+  it('store field, operator, and value', () => {
+    const expected = { field: { fieldName: 'field' }, operator: '=', compareValue: { type: 'STRING', value: "'abc'" } };
+    const actual = new Impl.FieldCompareConditionImpl(
+      new Impl.FieldRefImpl('field'),
+      CompareOperator.EQ,
+      new Impl.LiteralImpl(LiteralType.String, "'abc'")
+    );
+    expect(actual).toEqual(expected);
+  });
+  it('return field, operator, and value separated by spaces for toSoqlSyntax()', () => {
+    const expected = `field = 'abc'`;
+    const actual = new Impl.FieldCompareConditionImpl(
+      new Impl.FieldRefImpl('field'),
+      CompareOperator.EQ,
+      new Impl.LiteralImpl(LiteralType.String, "'abc'")
+    ).toSoqlSyntax();
+    expect(actual).toEqual(expected);
+  });
+});

packages/soql-model/src/model/impl/fieldCompareConditionImpl.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Soql from '../model';
+import { SoqlModelObjectImpl } from './soqlModelObjectImpl';
+
+export class FieldCompareConditionImpl extends SoqlModelObjectImpl implements Soql.FieldCompareCondition {
+  public constructor(public field: Soql.Field, public operator: Soql.CompareOperator, public compareValue: Soql.CompareValue) {
+    super();
+  }
+  public toSoqlSyntax(options?: Soql.SyntaxOptions): string {
+    return `${this.field.toSoqlSyntax(options)} ${this.operator} ${this.compareValue.toSoqlSyntax(options)}`;
+  }
+}

packages/soql-model/src/model/impl/inListConditionImpl.test.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Impl from '.';
+import { InOperator, LiteralType } from '../model';
+
+describe('InListConditionImpl should', () => {
+  it('store field, operator, and values', () => {
+    const expected = { field: { fieldName: 'field' }, operator: 'NOT IN', values: [{ type: 'STRING', value: "'abc'" }, { type: 'STRING', value: "'def'" }] };
+    const actual = new Impl.InListConditionImpl(
+      new Impl.FieldRefImpl('field'),
+      InOperator.NotIn,
+      [new Impl.LiteralImpl(LiteralType.String, "'abc'"), new Impl.LiteralImpl(LiteralType.String, "'def'")]
+    );
+    expect(actual).toEqual(expected);
+  });
+  it('return field, operator, and parenthesized comma-separated values separated by spaces for toSoqlSyntax()', () => {
+    const expected = "field NOT IN ( 'abc', 'def' )";
+    const actual = new Impl.InListConditionImpl(
+      new Impl.FieldRefImpl('field'),
+      InOperator.NotIn,
+      [new Impl.LiteralImpl(LiteralType.String, "'abc'"), new Impl.LiteralImpl(LiteralType.String, "'def'")]
+    ).toSoqlSyntax();
+    expect(actual).toEqual(expected);
+  });
+});

packages/soql-model/src/model/impl/inListConditionImpl.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Soql from '../model';
+import { SoqlModelObjectImpl } from './soqlModelObjectImpl';
+
+export class InListConditionImpl extends SoqlModelObjectImpl implements Soql.InListCondition {
+  public constructor(public field: Soql.Field, public operator: Soql.InOperator, public values: Soql.CompareValue[]) {
+    super();
+  }
+  public toSoqlSyntax(options?: Soql.SyntaxOptions): string {
+    let valuesSyntax = '';
+    this.values.forEach(value => valuesSyntax = `${valuesSyntax}, ${value.toSoqlSyntax(options)}`);
+    if (valuesSyntax.length > 2) {
+      // remove comma separator at start of string
+      valuesSyntax = valuesSyntax.substring(2);
+    }
+    return `${this.field.toSoqlSyntax(options)} ${this.operator} ( ${valuesSyntax} )`;
+  }
+}

packages/soql-model/src/model/impl/includesConditionImpl.test.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Impl from '.';
+import { IncludesOperator, LiteralType } from '../model';
+
+describe('IncludesConditionImpl should', () => {
+  it('store field, operator, and values', () => {
+    const expected = { field: { fieldName: 'field' }, operator: 'INCLUDES', values: [{ type: 'STRING', value: "'abc'" }, { type: 'STRING', value: "'def'" }] };
+    const actual = new Impl.IncludesConditionImpl(
+      new Impl.FieldRefImpl('field'),
+      IncludesOperator.Includes,
+      [new Impl.LiteralImpl(LiteralType.String, "'abc'"), new Impl.LiteralImpl(LiteralType.String, "'def'")]
+    );
+    expect(actual).toEqual(expected);
+  });
+  it('return field, operator, and parenthesized comma-separated values separated by spaces for toSoqlSyntax()', () => {
+    const expected = "field INCLUDES ( 'abc', 'def' )";
+    const actual = new Impl.IncludesConditionImpl(
+      new Impl.FieldRefImpl('field'),
+      IncludesOperator.Includes,
+      [new Impl.LiteralImpl(LiteralType.String, "'abc'"), new Impl.LiteralImpl(LiteralType.String, "'def'")]
+    ).toSoqlSyntax();
+    expect(actual).toEqual(expected);
+  });
+});

packages/soql-model/src/model/impl/includesConditionImpl.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Soql from '../model';
+import { SoqlModelObjectImpl } from './soqlModelObjectImpl';
+
+export class IncludesConditionImpl extends SoqlModelObjectImpl implements Soql.IncludesCondition {
+  public constructor(public field: Soql.Field, public operator: Soql.IncludesOperator, public values: Soql.CompareValue[]) {
+    super();
+  }
+  public toSoqlSyntax(options?: Soql.SyntaxOptions): string {
+    let valuesSyntax = '';
+    this.values.forEach(value => valuesSyntax = `${valuesSyntax}, ${value.toSoqlSyntax(options)}`);
+    if (valuesSyntax.length > 2) {
+      // remove comma separator at start of string
+      valuesSyntax = valuesSyntax.substring(2);
+    }
+    return `${this.field.toSoqlSyntax(options)} ${this.operator} ( ${valuesSyntax} )`;
+  }
+}

packages/soql-model/src/model/impl/index.ts

@@ -1,21 +1,39 @@
+import { AndOrConditionImpl } from './andOrConditionImpl';
+import { FieldCompareConditionImpl } from './fieldCompareConditionImpl';
 import { FieldRefImpl } from './fieldRefImpl';
 import { FieldSelectionImpl } from './fieldSelectionImpl';
 import { FromImpl } from './fromImpl';
+import { IncludesConditionImpl } from './includesConditionImpl';
+import { InListConditionImpl } from './inListConditionImpl';
+import { LikeConditionImpl } from './likeConditionImpl';
 import { LimitImpl } from './limitImpl';
+import { LiteralImpl } from './literalImpl';
+import { NestedConditionImpl } from './nestedConditionImpl';
+import { NotConditionImpl } from './notConditionImpl';
 import { OrderByImpl } from './orderByImpl';
 import { OrderByExpressionImpl } from './orderByExpressionImpl';
 import { QueryImpl } from './queryImpl';
 import { SelectExprsImpl } from './selectExprsImpl';
+import { WhereImpl } from './whereImpl';
 import { UnmodeledSyntaxImpl } from './unmodeledSyntaxImpl';
 
 export {
+  AndOrConditionImpl,
+  FieldCompareConditionImpl,
   FieldRefImpl,
   FieldSelectionImpl,
   FromImpl,
+  IncludesConditionImpl,
+  InListConditionImpl,
+  LikeConditionImpl,
   LimitImpl,
+  LiteralImpl,
+  NestedConditionImpl,
+  NotConditionImpl,
   QueryImpl,
   SelectExprsImpl,
   OrderByImpl,
   OrderByExpressionImpl,
+  WhereImpl,
   UnmodeledSyntaxImpl,
 };

packages/soql-model/src/model/impl/likeConditionImpl.test.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Impl from '.';
+import { LiteralType } from '../model';
+
+describe('LikeConditionImpl should', () => {
+  it('store field and value', () => {
+    const expected = { field: { fieldName: 'field' }, compareValue: { type: 'STRING', value: "'abc'" } };
+    const actual = new Impl.LikeConditionImpl(
+      new Impl.FieldRefImpl('field'),
+      new Impl.LiteralImpl(LiteralType.String, "'abc'")
+    );
+    expect(actual).toEqual(expected);
+  });
+  it('return field, LIKE keyword, and value separated by spaces for toSoqlSyntax()', () => {
+    const expected = `field LIKE 'abc'`;
+    const actual = new Impl.LikeConditionImpl(
+      new Impl.FieldRefImpl('field'),
+      new Impl.LiteralImpl(LiteralType.String, "'abc'")
+    ).toSoqlSyntax();
+    expect(actual).toEqual(expected);
+  });
+});

packages/soql-model/src/model/impl/likeConditionImpl.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as Soql from '../model';
+import { SoqlModelObjectImpl } from './soqlModelObjectImpl';
+
+export class LikeConditionImpl extends SoqlModelObjectImpl implements Soql.LikeCondition {
+  public constructor(public field: Soql.Field, public compareValue: Soql.CompareValue) {
+    super();
+  }
+  public toSoqlSyntax(options?: Soql.SyntaxOptions): string {
+    return `${this.field.toSoqlSyntax(options)} LIKE ${this.compareValue.toSoqlSyntax(options)}`;
+  }
+}