@apexdevtools/apex-parser 3.0.0

package/README.md

@@ -0,0 +1,79 @@
+apex-parser
+===========
+
+Parser for Salesforce Apex (including Triggers & inline SOQL/SOQL). This is based on an [ANTLR4](https://www.antlr.org/) grammar, see antlr/ApexParser.g4. 
+
+There are two builds of the parser available, a NPM module for use with Node and a Maven package for use on JVMs.
+
+These builds just contain the Parser & Lexer and provides no further support for analysing the generated parse trees beyond what is provided by ANTLR4. 
+
+As Apex & SOQL/SOQL are case-insenstive languages you need to use the provided CaseInsensitiveInputStream for the parser to function correctly. When parsing Apex, inline SOQL/SOSL is automtaically parsed, but you can also parse SOQL/SOQL directly. You can find some minimal examples in the test classes. 
+
+### Example
+To parse a class file (NPM version):
+
+    let lexer = new ApexLexer(new CaseInsensitiveInputStream("public class Hello {}"))
+    let tokens  = new CommonTokenStream(lexer);
+
+    let parser = new ApexParser(tokens)
+    let context = parser.compilationUnit()
+
+The 'context' is a CompilationUnitContext object which is the root of the parsed representation of the class. You can access the parse tree via functions on it.
+
+### Unicode handling
+Prior to 2.12.0 the use of ANTLRInputStream for reading data in CaseInsensitiveStream would result character positions being given for UTF-16. The switch to CharStream input in 2.12.0 for JVM and 2.14.0 for node results in character positions reflecting Unicode code points. 
+
+### antlr4ts versions
+
+The npm module uses antlr4ts 0.5.0-alpha.4, this was updated from 0.5.0-alpha.3 in the 2.9.1 version. You should make
+sure that if you are using a matching versions of this dependency if you use it directly. To avoid issues you can 
+import 'CommonTokenStream' & 'ParseTreeWalker' from 'apex-parser' instead of from antlr4ts.
+
+    import { CommonTokenStream} from "apex-parser";
+    import { ParseTreeWalker } from "apex-parser";
+
+### Packages
+
+Maven
+
+    <dependency>
+        <groupId>io.github.apex-dev-tools</groupId>
+        <artifactId>apex-parser</artifactId>
+        <version>3.0.0</version>
+    </dependency>
+
+NPM
+
+    "@apexdevtools/apex-parser": "^3.0.0"
+
+### Building
+To build both distributions:
+
+    npm run build
+
+### History
+    3.0.0 - Move to @apexdevtools/apex-parser
+    2.14.0 - Change npm api to replace ANTLRInputStream with CharStream, for Unicode char positions  
+    2.13.0 - Fixes for negative numerics & Currency literals in SOQL 
+    2.12.0 - Replace deprecated ANTLRInputStream, DateTime & Currency literals fixes (contrib Aaron Hurst) 
+    2.11.0 - Fix for SOQL UPDATE VIEWSTAT/TRACKING & removal of class type arguments
+    2.10.0 - Allow type arguments on Classes (non-standard!)
+    2.9.2 - Generate .d.ts files 
+    2.9.1 - JVM build and npm dependency updates
+    2.9.0 - Add SOQL Fields function
+    2.8.0 - Apex cast priority fix, SOSL & SOQL query format fixes, Added SOQL Date functions 
+    2.7.1 - Bugfix for 'Network' identifier
+    2.7.0 - Support inline SOSL queries
+    2.6.1 - Dependency security fixes
+    2.6.0 - Add SOQL parsing support
+    2.5.0 - Allow safe navigation operator ?.
+    2.4.0 - Enable Listener & Visitor use
+    2.3.0 - Removed modifers from enhanced for loop
+    2.2.1 - Dependency security fixes
+    2.2.0 - Parser performance improvements
+    2.1.0 - Supports trigger parsing and switch statement parsing syntax was corrected
+    1.0.0 - Initial version
+
+### Source & Licenses
+
+All the source code included uses a 3-clause BSD license. The only third-party component included is the Apex Antlr4 grammar originally from [Tooling-force.com](https://github.com/neowit/tooling-force.com), although this version used is now markedly different from the original.  

package/lib/ApexLexer.d.ts

@@ -0,0 +1,265 @@
+import { ATN } from "antlr4ts/atn/ATN";
+import { CharStream } from "antlr4ts/CharStream";
+import { Lexer } from "antlr4ts/Lexer";
+import { Vocabulary } from "antlr4ts/Vocabulary";
+export declare class ApexLexer extends Lexer {
+    static readonly ABSTRACT = 1;
+    static readonly AFTER = 2;
+    static readonly BEFORE = 3;
+    static readonly BREAK = 4;
+    static readonly CATCH = 5;
+    static readonly CLASS = 6;
+    static readonly CONTINUE = 7;
+    static readonly DELETE = 8;
+    static readonly DO = 9;
+    static readonly ELSE = 10;
+    static readonly ENUM = 11;
+    static readonly EXTENDS = 12;
+    static readonly FINAL = 13;
+    static readonly FINALLY = 14;
+    static readonly FOR = 15;
+    static readonly GET = 16;
+    static readonly GLOBAL = 17;
+    static readonly IF = 18;
+    static readonly IMPLEMENTS = 19;
+    static readonly INHERITED = 20;
+    static readonly INSERT = 21;
+    static readonly INSTANCEOF = 22;
+    static readonly INTERFACE = 23;
+    static readonly MERGE = 24;
+    static readonly NEW = 25;
+    static readonly NULL = 26;
+    static readonly ON = 27;
+    static readonly OVERRIDE = 28;
+    static readonly PRIVATE = 29;
+    static readonly PROTECTED = 30;
+    static readonly PUBLIC = 31;
+    static readonly RETURN = 32;
+    static readonly SYSTEMRUNAS = 33;
+    static readonly SET = 34;
+    static readonly SHARING = 35;
+    static readonly STATIC = 36;
+    static readonly SUPER = 37;
+    static readonly SWITCH = 38;
+    static readonly TESTMETHOD = 39;
+    static readonly THIS = 40;
+    static readonly THROW = 41;
+    static readonly TRANSIENT = 42;
+    static readonly TRIGGER = 43;
+    static readonly TRY = 44;
+    static readonly UNDELETE = 45;
+    static readonly UPDATE = 46;
+    static readonly UPSERT = 47;
+    static readonly VIRTUAL = 48;
+    static readonly VOID = 49;
+    static readonly WEBSERVICE = 50;
+    static readonly WHEN = 51;
+    static readonly WHILE = 52;
+    static readonly WITH = 53;
+    static readonly WITHOUT = 54;
+    static readonly LIST = 55;
+    static readonly MAP = 56;
+    static readonly SELECT = 57;
+    static readonly COUNT = 58;
+    static readonly FROM = 59;
+    static readonly AS = 60;
+    static readonly USING = 61;
+    static readonly SCOPE = 62;
+    static readonly WHERE = 63;
+    static readonly ORDER = 64;
+    static readonly BY = 65;
+    static readonly LIMIT = 66;
+    static readonly SOQLAND = 67;
+    static readonly SOQLOR = 68;
+    static readonly NOT = 69;
+    static readonly AVG = 70;
+    static readonly COUNT_DISTINCT = 71;
+    static readonly MIN = 72;
+    static readonly MAX = 73;
+    static readonly SUM = 74;
+    static readonly TYPEOF = 75;
+    static readonly END = 76;
+    static readonly THEN = 77;
+    static readonly LIKE = 78;
+    static readonly IN = 79;
+    static readonly INCLUDES = 80;
+    static readonly EXCLUDES = 81;
+    static readonly ASC = 82;
+    static readonly DESC = 83;
+    static readonly NULLS = 84;
+    static readonly FIRST = 85;
+    static readonly LAST = 86;
+    static readonly GROUP = 87;
+    static readonly ALL = 88;
+    static readonly ROWS = 89;
+    static readonly VIEW = 90;
+    static readonly HAVING = 91;
+    static readonly ROLLUP = 92;
+    static readonly TOLABEL = 93;
+    static readonly OFFSET = 94;
+    static readonly DATA = 95;
+    static readonly CATEGORY = 96;
+    static readonly AT = 97;
+    static readonly ABOVE = 98;
+    static readonly BELOW = 99;
+    static readonly ABOVE_OR_BELOW = 100;
+    static readonly SECURITY_ENFORCED = 101;
+    static readonly REFERENCE = 102;
+    static readonly CUBE = 103;
+    static readonly FORMAT = 104;
+    static readonly TRACKING = 105;
+    static readonly VIEWSTAT = 106;
+    static readonly CUSTOM = 107;
+    static readonly STANDARD = 108;
+    static readonly CALENDAR_MONTH = 109;
+    static readonly CALENDAR_QUARTER = 110;
+    static readonly CALENDAR_YEAR = 111;
+    static readonly DAY_IN_MONTH = 112;
+    static readonly DAY_IN_WEEK = 113;
+    static readonly DAY_IN_YEAR = 114;
+    static readonly DAY_ONLY = 115;
+    static readonly FISCAL_MONTH = 116;
+    static readonly FISCAL_QUARTER = 117;
+    static readonly FISCAL_YEAR = 118;
+    static readonly HOUR_IN_DAY = 119;
+    static readonly WEEK_IN_MONTH = 120;
+    static readonly WEEK_IN_YEAR = 121;
+    static readonly CONVERT_TIMEZONE = 122;
+    static readonly YESTERDAY = 123;
+    static readonly TODAY = 124;
+    static readonly TOMORROW = 125;
+    static readonly LAST_WEEK = 126;
+    static readonly THIS_WEEK = 127;
+    static readonly NEXT_WEEK = 128;
+    static readonly LAST_MONTH = 129;
+    static readonly THIS_MONTH = 130;
+    static readonly NEXT_MONTH = 131;
+    static readonly LAST_90_DAYS = 132;
+    static readonly NEXT_90_DAYS = 133;
+    static readonly LAST_N_DAYS_N = 134;
+    static readonly NEXT_N_DAYS_N = 135;
+    static readonly NEXT_N_WEEKS_N = 136;
+    static readonly LAST_N_WEEKS_N = 137;
+    static readonly NEXT_N_MONTHS_N = 138;
+    static readonly LAST_N_MONTHS_N = 139;
+    static readonly THIS_QUARTER = 140;
+    static readonly LAST_QUARTER = 141;
+    static readonly NEXT_QUARTER = 142;
+    static readonly NEXT_N_QUARTERS_N = 143;
+    static readonly LAST_N_QUARTERS_N = 144;
+    static readonly THIS_YEAR = 145;
+    static readonly LAST_YEAR = 146;
+    static readonly NEXT_YEAR = 147;
+    static readonly NEXT_N_YEARS_N = 148;
+    static readonly LAST_N_YEARS_N = 149;
+    static readonly THIS_FISCAL_QUARTER = 150;
+    static readonly LAST_FISCAL_QUARTER = 151;
+    static readonly NEXT_FISCAL_QUARTER = 152;
+    static readonly NEXT_N_FISCAL_QUARTERS_N = 153;
+    static readonly LAST_N_FISCAL_QUARTERS_N = 154;
+    static readonly THIS_FISCAL_YEAR = 155;
+    static readonly LAST_FISCAL_YEAR = 156;
+    static readonly NEXT_FISCAL_YEAR = 157;
+    static readonly NEXT_N_FISCAL_YEARS_N = 158;
+    static readonly LAST_N_FISCAL_YEARS_N = 159;
+    static readonly DateLiteral = 160;
+    static readonly DateTimeLiteral = 161;
+    static readonly IntegralCurrencyLiteral = 162;
+    static readonly FIND = 163;
+    static readonly EMAIL = 164;
+    static readonly NAME = 165;
+    static readonly PHONE = 166;
+    static readonly SIDEBAR = 167;
+    static readonly FIELDS = 168;
+    static readonly METADATA = 169;
+    static readonly PRICEBOOKID = 170;
+    static readonly NETWORK = 171;
+    static readonly SNIPPET = 172;
+    static readonly TARGET_LENGTH = 173;
+    static readonly DIVISION = 174;
+    static readonly RETURNING = 175;
+    static readonly LISTVIEW = 176;
+    static readonly FindLiteral = 177;
+    static readonly IntegerLiteral = 178;
+    static readonly LongLiteral = 179;
+    static readonly NumberLiteral = 180;
+    static readonly BooleanLiteral = 181;
+    static readonly StringLiteral = 182;
+    static readonly NullLiteral = 183;
+    static readonly LPAREN = 184;
+    static readonly RPAREN = 185;
+    static readonly LBRACE = 186;
+    static readonly RBRACE = 187;
+    static readonly LBRACK = 188;
+    static readonly RBRACK = 189;
+    static readonly SEMI = 190;
+    static readonly COMMA = 191;
+    static readonly DOT = 192;
+    static readonly ASSIGN = 193;
+    static readonly GT = 194;
+    static readonly LT = 195;
+    static readonly BANG = 196;
+    static readonly TILDE = 197;
+    static readonly QUESTIONDOT = 198;
+    static readonly QUESTION = 199;
+    static readonly COLON = 200;
+    static readonly EQUAL = 201;
+    static readonly TRIPLEEQUAL = 202;
+    static readonly NOTEQUAL = 203;
+    static readonly LESSANDGREATER = 204;
+    static readonly TRIPLENOTEQUAL = 205;
+    static readonly AND = 206;
+    static readonly OR = 207;
+    static readonly INC = 208;
+    static readonly DEC = 209;
+    static readonly ADD = 210;
+    static readonly SUB = 211;
+    static readonly MUL = 212;
+    static readonly DIV = 213;
+    static readonly BITAND = 214;
+    static readonly BITOR = 215;
+    static readonly CARET = 216;
+    static readonly MOD = 217;
+    static readonly MAPTO = 218;
+    static readonly ADD_ASSIGN = 219;
+    static readonly SUB_ASSIGN = 220;
+    static readonly MUL_ASSIGN = 221;
+    static readonly DIV_ASSIGN = 222;
+    static readonly AND_ASSIGN = 223;
+    static readonly OR_ASSIGN = 224;
+    static readonly XOR_ASSIGN = 225;
+    static readonly MOD_ASSIGN = 226;
+    static readonly LSHIFT_ASSIGN = 227;
+    static readonly RSHIFT_ASSIGN = 228;
+    static readonly URSHIFT_ASSIGN = 229;
+    static readonly ATSIGN = 230;
+    static readonly Identifier = 231;
+    static readonly WS = 232;
+    static readonly DOC_COMMENT = 233;
+    static readonly COMMENT = 234;
+    static readonly LINE_COMMENT = 235;
+    static readonly WHITESPACE_CHANNEL = 2;
+    static readonly COMMENT_CHANNEL = 3;
+    static readonly channelNames: string[];
+    static readonly modeNames: string[];
+    static readonly ruleNames: string[];
+    private static readonly _LITERAL_NAMES;
+    private static readonly _SYMBOLIC_NAMES;
+    static readonly VOCABULARY: Vocabulary;
+    get vocabulary(): Vocabulary;
+    constructor(input: CharStream);
+    get grammarFileName(): string;
+    get ruleNames(): string[];
+    get serializedATN(): string;
+    get channelNames(): string[];
+    get modeNames(): string[];
+    private static readonly _serializedATNSegments;
+    private static readonly _serializedATNSegment0;
+    private static readonly _serializedATNSegment1;
+    private static readonly _serializedATNSegment2;
+    private static readonly _serializedATNSegment3;
+    private static readonly _serializedATNSegment4;
+    static readonly _serializedATN: string;
+    static __ATN: ATN;
+    static get _ATN(): ATN;
+}