@apexdevtools/apex-parser 3.6.0 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # apex-parser - Changelog
 
+## 4.1.0 - 2024-05-12
+
+- Allow WITH USER_MODE or SYSTEM_MODE on SOSL queries
+
+## 4.0.0 - 2024-03-28
+
+- Correct trigger body parsing to allow member declarations
+- Add support for TYPEOF in SOQL subqueries
+- Change com.nawforce.apexparser packages to io.github.apexdevtools.apexparser
+
 ## 3.6.0 - 2024-02-15
 
 - Add null coalesce operator and expression

package/README.md

@@ -48,12 +48,12 @@ Maven
     <dependency>
         <groupId>io.github.apex-dev-tools</groupId>
         <artifactId>apex-parser</artifactId>
-        <version>3.6.0</version>
+        <version>4.1.0</version>
     </dependency>
 
 NPM
 
-    "@apexdevtools/apex-parser": "^3.6.0"
+    "@apexdevtools/apex-parser": "^4.1.0"
 
 ## Building
 

package/lib/ApexParser.d.ts

@@ -259,148 +259,152 @@ export declare class ApexParser extends Parser {
     static readonly LINE_COMMENT = 248;
     static readonly RULE_triggerUnit = 0;
     static readonly RULE_triggerCase = 1;
-    static readonly RULE_compilationUnit = 2;
-    static readonly RULE_typeDeclaration = 3;
-    static readonly RULE_classDeclaration = 4;
-    static readonly RULE_enumDeclaration = 5;
-    static readonly RULE_enumConstants = 6;
-    static readonly RULE_interfaceDeclaration = 7;
-    static readonly RULE_typeList = 8;
-    static readonly RULE_classBody = 9;
-    static readonly RULE_interfaceBody = 10;
-    static readonly RULE_classBodyDeclaration = 11;
-    static readonly RULE_modifier = 12;
-    static readonly RULE_memberDeclaration = 13;
-    static readonly RULE_methodDeclaration = 14;
-    static readonly RULE_constructorDeclaration = 15;
-    static readonly RULE_fieldDeclaration = 16;
-    static readonly RULE_propertyDeclaration = 17;
-    static readonly RULE_interfaceMethodDeclaration = 18;
-    static readonly RULE_variableDeclarators = 19;
-    static readonly RULE_variableDeclarator = 20;
-    static readonly RULE_arrayInitializer = 21;
-    static readonly RULE_typeRef = 22;
-    static readonly RULE_arraySubscripts = 23;
-    static readonly RULE_typeName = 24;
-    static readonly RULE_typeArguments = 25;
-    static readonly RULE_formalParameters = 26;
-    static readonly RULE_formalParameterList = 27;
-    static readonly RULE_formalParameter = 28;
-    static readonly RULE_qualifiedName = 29;
-    static readonly RULE_literal = 30;
-    static readonly RULE_annotation = 31;
-    static readonly RULE_elementValuePairs = 32;
-    static readonly RULE_elementValuePair = 33;
-    static readonly RULE_elementValue = 34;
-    static readonly RULE_elementValueArrayInitializer = 35;
-    static readonly RULE_block = 36;
-    static readonly RULE_localVariableDeclarationStatement = 37;
-    static readonly RULE_localVariableDeclaration = 38;
-    static readonly RULE_statement = 39;
-    static readonly RULE_ifStatement = 40;
-    static readonly RULE_switchStatement = 41;
-    static readonly RULE_whenControl = 42;
-    static readonly RULE_whenValue = 43;
-    static readonly RULE_whenLiteral = 44;
-    static readonly RULE_forStatement = 45;
-    static readonly RULE_whileStatement = 46;
-    static readonly RULE_doWhileStatement = 47;
-    static readonly RULE_tryStatement = 48;
-    static readonly RULE_returnStatement = 49;
-    static readonly RULE_throwStatement = 50;
-    static readonly RULE_breakStatement = 51;
-    static readonly RULE_continueStatement = 52;
-    static readonly RULE_accessLevel = 53;
-    static readonly RULE_insertStatement = 54;
-    static readonly RULE_updateStatement = 55;
-    static readonly RULE_deleteStatement = 56;
-    static readonly RULE_undeleteStatement = 57;
-    static readonly RULE_upsertStatement = 58;
-    static readonly RULE_mergeStatement = 59;
-    static readonly RULE_runAsStatement = 60;
-    static readonly RULE_expressionStatement = 61;
-    static readonly RULE_propertyBlock = 62;
-    static readonly RULE_getter = 63;
-    static readonly RULE_setter = 64;
-    static readonly RULE_catchClause = 65;
-    static readonly RULE_finallyBlock = 66;
-    static readonly RULE_forControl = 67;
-    static readonly RULE_forInit = 68;
-    static readonly RULE_enhancedForControl = 69;
-    static readonly RULE_forUpdate = 70;
-    static readonly RULE_parExpression = 71;
-    static readonly RULE_expressionList = 72;
-    static readonly RULE_expression = 73;
-    static readonly RULE_primary = 74;
-    static readonly RULE_methodCall = 75;
-    static readonly RULE_dotMethodCall = 76;
-    static readonly RULE_creator = 77;
-    static readonly RULE_createdName = 78;
-    static readonly RULE_idCreatedNamePair = 79;
-    static readonly RULE_noRest = 80;
-    static readonly RULE_classCreatorRest = 81;
-    static readonly RULE_arrayCreatorRest = 82;
-    static readonly RULE_mapCreatorRest = 83;
-    static readonly RULE_mapCreatorRestPair = 84;
-    static readonly RULE_setCreatorRest = 85;
-    static readonly RULE_arguments = 86;
-    static readonly RULE_soqlLiteral = 87;
-    static readonly RULE_query = 88;
-    static readonly RULE_subQuery = 89;
-    static readonly RULE_selectList = 90;
-    static readonly RULE_selectEntry = 91;
-    static readonly RULE_fieldName = 92;
-    static readonly RULE_fromNameList = 93;
-    static readonly RULE_subFieldList = 94;
-    static readonly RULE_subFieldEntry = 95;
-    static readonly RULE_soqlFieldsParameter = 96;
-    static readonly RULE_soqlFunction = 97;
-    static readonly RULE_dateFieldName = 98;
-    static readonly RULE_locationValue = 99;
-    static readonly RULE_coordinateValue = 100;
-    static readonly RULE_typeOf = 101;
-    static readonly RULE_whenClause = 102;
-    static readonly RULE_elseClause = 103;
-    static readonly RULE_fieldNameList = 104;
-    static readonly RULE_usingScope = 105;
-    static readonly RULE_whereClause = 106;
-    static readonly RULE_logicalExpression = 107;
-    static readonly RULE_conditionalExpression = 108;
-    static readonly RULE_fieldExpression = 109;
-    static readonly RULE_comparisonOperator = 110;
-    static readonly RULE_value = 111;
-    static readonly RULE_valueList = 112;
-    static readonly RULE_signedNumber = 113;
-    static readonly RULE_withClause = 114;
-    static readonly RULE_filteringExpression = 115;
-    static readonly RULE_dataCategorySelection = 116;
-    static readonly RULE_dataCategoryName = 117;
-    static readonly RULE_filteringSelector = 118;
-    static readonly RULE_groupByClause = 119;
-    static readonly RULE_orderByClause = 120;
-    static readonly RULE_fieldOrderList = 121;
-    static readonly RULE_fieldOrder = 122;
-    static readonly RULE_limitClause = 123;
-    static readonly RULE_offsetClause = 124;
-    static readonly RULE_allRowsClause = 125;
-    static readonly RULE_forClauses = 126;
-    static readonly RULE_boundExpression = 127;
-    static readonly RULE_dateFormula = 128;
-    static readonly RULE_signedInteger = 129;
-    static readonly RULE_soqlId = 130;
-    static readonly RULE_soslLiteral = 131;
-    static readonly RULE_soslLiteralAlt = 132;
-    static readonly RULE_soslClauses = 133;
-    static readonly RULE_searchGroup = 134;
-    static readonly RULE_fieldSpecList = 135;
-    static readonly RULE_fieldSpec = 136;
-    static readonly RULE_fieldList = 137;
-    static readonly RULE_updateList = 138;
-    static readonly RULE_updateType = 139;
-    static readonly RULE_networkList = 140;
-    static readonly RULE_soslId = 141;
-    static readonly RULE_id = 142;
-    static readonly RULE_anyId = 143;
+    static readonly RULE_triggerBlock = 2;
+    static readonly RULE_triggerBlockMember = 3;
+    static readonly RULE_compilationUnit = 4;
+    static readonly RULE_typeDeclaration = 5;
+    static readonly RULE_classDeclaration = 6;
+    static readonly RULE_enumDeclaration = 7;
+    static readonly RULE_enumConstants = 8;
+    static readonly RULE_interfaceDeclaration = 9;
+    static readonly RULE_typeList = 10;
+    static readonly RULE_classBody = 11;
+    static readonly RULE_interfaceBody = 12;
+    static readonly RULE_classBodyDeclaration = 13;
+    static readonly RULE_modifier = 14;
+    static readonly RULE_memberDeclaration = 15;
+    static readonly RULE_triggerMemberDeclaration = 16;
+    static readonly RULE_methodDeclaration = 17;
+    static readonly RULE_constructorDeclaration = 18;
+    static readonly RULE_fieldDeclaration = 19;
+    static readonly RULE_propertyDeclaration = 20;
+    static readonly RULE_interfaceMethodDeclaration = 21;
+    static readonly RULE_variableDeclarators = 22;
+    static readonly RULE_variableDeclarator = 23;
+    static readonly RULE_arrayInitializer = 24;
+    static readonly RULE_typeRef = 25;
+    static readonly RULE_arraySubscripts = 26;
+    static readonly RULE_typeName = 27;
+    static readonly RULE_typeArguments = 28;
+    static readonly RULE_formalParameters = 29;
+    static readonly RULE_formalParameterList = 30;
+    static readonly RULE_formalParameter = 31;
+    static readonly RULE_qualifiedName = 32;
+    static readonly RULE_literal = 33;
+    static readonly RULE_annotation = 34;
+    static readonly RULE_elementValuePairs = 35;
+    static readonly RULE_elementValuePair = 36;
+    static readonly RULE_elementValue = 37;
+    static readonly RULE_elementValueArrayInitializer = 38;
+    static readonly RULE_block = 39;
+    static readonly RULE_localVariableDeclarationStatement = 40;
+    static readonly RULE_localVariableDeclaration = 41;
+    static readonly RULE_statement = 42;
+    static readonly RULE_ifStatement = 43;
+    static readonly RULE_switchStatement = 44;
+    static readonly RULE_whenControl = 45;
+    static readonly RULE_whenValue = 46;
+    static readonly RULE_whenLiteral = 47;
+    static readonly RULE_forStatement = 48;
+    static readonly RULE_whileStatement = 49;
+    static readonly RULE_doWhileStatement = 50;
+    static readonly RULE_tryStatement = 51;
+    static readonly RULE_returnStatement = 52;
+    static readonly RULE_throwStatement = 53;
+    static readonly RULE_breakStatement = 54;
+    static readonly RULE_continueStatement = 55;
+    static readonly RULE_accessLevel = 56;
+    static readonly RULE_insertStatement = 57;
+    static readonly RULE_updateStatement = 58;
+    static readonly RULE_deleteStatement = 59;
+    static readonly RULE_undeleteStatement = 60;
+    static readonly RULE_upsertStatement = 61;
+    static readonly RULE_mergeStatement = 62;
+    static readonly RULE_runAsStatement = 63;
+    static readonly RULE_expressionStatement = 64;
+    static readonly RULE_propertyBlock = 65;
+    static readonly RULE_getter = 66;
+    static readonly RULE_setter = 67;
+    static readonly RULE_catchClause = 68;
+    static readonly RULE_finallyBlock = 69;
+    static readonly RULE_forControl = 70;
+    static readonly RULE_forInit = 71;
+    static readonly RULE_enhancedForControl = 72;
+    static readonly RULE_forUpdate = 73;
+    static readonly RULE_parExpression = 74;
+    static readonly RULE_expressionList = 75;
+    static readonly RULE_expression = 76;
+    static readonly RULE_primary = 77;
+    static readonly RULE_methodCall = 78;
+    static readonly RULE_dotMethodCall = 79;
+    static readonly RULE_creator = 80;
+    static readonly RULE_createdName = 81;
+    static readonly RULE_idCreatedNamePair = 82;
+    static readonly RULE_noRest = 83;
+    static readonly RULE_classCreatorRest = 84;
+    static readonly RULE_arrayCreatorRest = 85;
+    static readonly RULE_mapCreatorRest = 86;
+    static readonly RULE_mapCreatorRestPair = 87;
+    static readonly RULE_setCreatorRest = 88;
+    static readonly RULE_arguments = 89;
+    static readonly RULE_soqlLiteral = 90;
+    static readonly RULE_query = 91;
+    static readonly RULE_subQuery = 92;
+    static readonly RULE_selectList = 93;
+    static readonly RULE_selectEntry = 94;
+    static readonly RULE_fieldName = 95;
+    static readonly RULE_fromNameList = 96;
+    static readonly RULE_subFieldList = 97;
+    static readonly RULE_subFieldEntry = 98;
+    static readonly RULE_soqlFieldsParameter = 99;
+    static readonly RULE_soqlFunction = 100;
+    static readonly RULE_dateFieldName = 101;
+    static readonly RULE_locationValue = 102;
+    static readonly RULE_coordinateValue = 103;
+    static readonly RULE_typeOf = 104;
+    static readonly RULE_whenClause = 105;
+    static readonly RULE_elseClause = 106;
+    static readonly RULE_fieldNameList = 107;
+    static readonly RULE_usingScope = 108;
+    static readonly RULE_whereClause = 109;
+    static readonly RULE_logicalExpression = 110;
+    static readonly RULE_conditionalExpression = 111;
+    static readonly RULE_fieldExpression = 112;
+    static readonly RULE_comparisonOperator = 113;
+    static readonly RULE_value = 114;
+    static readonly RULE_valueList = 115;
+    static readonly RULE_signedNumber = 116;
+    static readonly RULE_withClause = 117;
+    static readonly RULE_filteringExpression = 118;
+    static readonly RULE_dataCategorySelection = 119;
+    static readonly RULE_dataCategoryName = 120;
+    static readonly RULE_filteringSelector = 121;
+    static readonly RULE_groupByClause = 122;
+    static readonly RULE_orderByClause = 123;
+    static readonly RULE_fieldOrderList = 124;
+    static readonly RULE_fieldOrder = 125;
+    static readonly RULE_limitClause = 126;
+    static readonly RULE_offsetClause = 127;
+    static readonly RULE_allRowsClause = 128;
+    static readonly RULE_forClauses = 129;
+    static readonly RULE_boundExpression = 130;
+    static readonly RULE_dateFormula = 131;
+    static readonly RULE_signedInteger = 132;
+    static readonly RULE_soqlId = 133;
+    static readonly RULE_soslLiteral = 134;
+    static readonly RULE_soslLiteralAlt = 135;
+    static readonly RULE_soslClauses = 136;
+    static readonly RULE_soslWithClause = 137;
+    static readonly RULE_searchGroup = 138;
+    static readonly RULE_fieldSpecList = 139;
+    static readonly RULE_fieldSpec = 140;
+    static readonly RULE_fieldList = 141;
+    static readonly RULE_updateList = 142;
+    static readonly RULE_updateType = 143;
+    static readonly RULE_networkList = 144;
+    static readonly RULE_soslId = 145;
+    static readonly RULE_id = 146;
+    static readonly RULE_anyId = 147;
     static readonly ruleNames: string[];
     private static readonly _LITERAL_NAMES;
     private static readonly _SYMBOLIC_NAMES;
@@ -413,6 +417,8 @@ export declare class ApexParser extends Parser {
     constructor(input: TokenStream);
     triggerUnit(): TriggerUnitContext;
     triggerCase(): TriggerCaseContext;
+    triggerBlock(): TriggerBlockContext;
+    triggerBlockMember(): TriggerBlockMemberContext;
     compilationUnit(): CompilationUnitContext;
     typeDeclaration(): TypeDeclarationContext;
     classDeclaration(): ClassDeclarationContext;
@@ -425,6 +431,7 @@ export declare class ApexParser extends Parser {
     classBodyDeclaration(): ClassBodyDeclarationContext;
     modifier(): ModifierContext;
     memberDeclaration(): MemberDeclarationContext;
+    triggerMemberDeclaration(): TriggerMemberDeclarationContext;
     methodDeclaration(): MethodDeclarationContext;
     constructorDeclaration(): ConstructorDeclarationContext;
     fieldDeclaration(): FieldDeclarationContext;
@@ -546,6 +553,7 @@ export declare class ApexParser extends Parser {
     soslLiteral(): SoslLiteralContext;
     soslLiteralAlt(): SoslLiteralAltContext;
     soslClauses(): SoslClausesContext;
+    soslWithClause(): SoslWithClauseContext;
     searchGroup(): SearchGroupContext;
     fieldSpecList(): FieldSpecListContext;
     fieldSpec(): FieldSpecContext;
@@ -576,7 +584,7 @@ export declare class TriggerUnitContext extends ParserRuleContext {
     triggerCase(): TriggerCaseContext[];
     triggerCase(i: number): TriggerCaseContext;
     RPAREN(): TerminalNode;
-    block(): BlockContext;
+    triggerBlock(): TriggerBlockContext;
     EOF(): TerminalNode;
     COMMA(): TerminalNode[];
     COMMA(i: number): TerminalNode;
@@ -599,6 +607,28 @@ export declare class TriggerCaseContext extends ParserRuleContext {
     exitRule(listener: ApexParserListener): void;
     accept<Result>(visitor: ApexParserVisitor<Result>): Result;
 }
+export declare class TriggerBlockContext extends ParserRuleContext {
+    LBRACE(): TerminalNode;
+    RBRACE(): TerminalNode;
+    triggerBlockMember(): TriggerBlockMemberContext[];
+    triggerBlockMember(i: number): TriggerBlockMemberContext;
+    constructor(parent: ParserRuleContext | undefined, invokingState: number);
+    get ruleIndex(): number;
+    enterRule(listener: ApexParserListener): void;
+    exitRule(listener: ApexParserListener): void;
+    accept<Result>(visitor: ApexParserVisitor<Result>): Result;
+}
+export declare class TriggerBlockMemberContext extends ParserRuleContext {
+    triggerMemberDeclaration(): TriggerMemberDeclarationContext | undefined;
+    modifier(): ModifierContext[];
+    modifier(i: number): ModifierContext;
+    statement(): StatementContext | undefined;
+    constructor(parent: ParserRuleContext | undefined, invokingState: number);
+    get ruleIndex(): number;
+    enterRule(listener: ApexParserListener): void;
+    exitRule(listener: ApexParserListener): void;
+    accept<Result>(visitor: ApexParserVisitor<Result>): Result;
+}
 export declare class CompilationUnitContext extends ParserRuleContext {
     typeDeclaration(): TypeDeclarationContext;
     EOF(): TerminalNode;
@@ -753,6 +783,19 @@ export declare class MemberDeclarationContext extends ParserRuleContext {
     exitRule(listener: ApexParserListener): void;
     accept<Result>(visitor: ApexParserVisitor<Result>): Result;
 }
+export declare class TriggerMemberDeclarationContext extends ParserRuleContext {
+    methodDeclaration(): MethodDeclarationContext | undefined;
+    fieldDeclaration(): FieldDeclarationContext | undefined;
+    interfaceDeclaration(): InterfaceDeclarationContext | undefined;
+    classDeclaration(): ClassDeclarationContext | undefined;
+    enumDeclaration(): EnumDeclarationContext | undefined;
+    propertyDeclaration(): PropertyDeclarationContext | undefined;
+    constructor(parent: ParserRuleContext | undefined, invokingState: number);
+    get ruleIndex(): number;
+    enterRule(listener: ApexParserListener): void;
+    exitRule(listener: ApexParserListener): void;
+    accept<Result>(visitor: ApexParserVisitor<Result>): Result;
+}
 export declare class MethodDeclarationContext extends ParserRuleContext {
     id(): IdContext;
     formalParameters(): FormalParametersContext;
@@ -1989,6 +2032,7 @@ export declare class SubFieldEntryContext extends ParserRuleContext {
     fieldName(): FieldNameContext | undefined;
     soqlId(): SoqlIdContext | undefined;
     soqlFunction(): SoqlFunctionContext | undefined;
+    typeOf(): TypeOfContext | undefined;
     constructor(parent: ParserRuleContext | undefined, invokingState: number);
     get ruleIndex(): number;
     enterRule(listener: ApexParserListener): void;
@@ -2505,36 +2549,41 @@ export declare class SoslLiteralAltContext extends ParserRuleContext {
     accept<Result>(visitor: ApexParserVisitor<Result>): Result;
 }
 export declare class SoslClausesContext extends ParserRuleContext {
-    IN(): TerminalNode[];
-    IN(i: number): TerminalNode;
+    IN(): TerminalNode | undefined;
     searchGroup(): SearchGroupContext | undefined;
     RETURNING(): TerminalNode | undefined;
     fieldSpecList(): FieldSpecListContext | undefined;
-    WITH(): TerminalNode[];
-    WITH(i: number): TerminalNode;
+    soslWithClause(): SoslWithClauseContext[];
+    soslWithClause(i: number): SoslWithClauseContext;
+    limitClause(): LimitClauseContext | undefined;
+    UPDATE(): TerminalNode | undefined;
+    updateList(): UpdateListContext | undefined;
+    constructor(parent: ParserRuleContext | undefined, invokingState: number);
+    get ruleIndex(): number;
+    enterRule(listener: ApexParserListener): void;
+    exitRule(listener: ApexParserListener): void;
+    accept<Result>(visitor: ApexParserVisitor<Result>): Result;
+}
+export declare class SoslWithClauseContext extends ParserRuleContext {
+    WITH(): TerminalNode;
     DIVISION(): TerminalNode | undefined;
-    ASSIGN(): TerminalNode[];
-    ASSIGN(i: number): TerminalNode;
-    StringLiteral(): TerminalNode[];
-    StringLiteral(i: number): TerminalNode;
+    ASSIGN(): TerminalNode | undefined;
+    StringLiteral(): TerminalNode | undefined;
     DATA(): TerminalNode | undefined;
     CATEGORY(): TerminalNode | undefined;
     filteringExpression(): FilteringExpressionContext | undefined;
     SNIPPET(): TerminalNode | undefined;
-    NETWORK(): TerminalNode[];
-    NETWORK(i: number): TerminalNode;
-    LPAREN(): TerminalNode[];
-    LPAREN(i: number): TerminalNode;
+    LPAREN(): TerminalNode | undefined;
+    TARGET_LENGTH(): TerminalNode | undefined;
+    IntegerLiteral(): TerminalNode | undefined;
+    RPAREN(): TerminalNode | undefined;
+    NETWORK(): TerminalNode | undefined;
+    IN(): TerminalNode | undefined;
     networkList(): NetworkListContext | undefined;
-    RPAREN(): TerminalNode[];
-    RPAREN(i: number): TerminalNode;
     PRICEBOOKID(): TerminalNode | undefined;
     METADATA(): TerminalNode | undefined;
-    limitClause(): LimitClauseContext | undefined;
-    UPDATE(): TerminalNode | undefined;
-    updateList(): UpdateListContext | undefined;
-    TARGET_LENGTH(): TerminalNode | undefined;
-    IntegerLiteral(): TerminalNode | undefined;
+    USER_MODE(): TerminalNode | undefined;
+    SYSTEM_MODE(): TerminalNode | undefined;
     constructor(parent: ParserRuleContext | undefined, invokingState: number);
     get ruleIndex(): number;
     enterRule(listener: ApexParserListener): void;