@gooddata/maql-antlr4ts 0.3.1-d86294d3.0 → 0.3.1-d88e5901.0

package/README.md

@@ -67,31 +67,4 @@ Use [yalc](https://github.com/wclr/yalc) to link the package to other repositori
 
 ## Publishing
 
-The package is published automatically after merging to master branch.
-
-### Manual publishing
-
-> Unless you have a good reason to do so (i.e. you cannot test a feature otherwise)
-**do not** publish the package manually.
-
-Create a GitLab access token with `api` permissions and store it
-in the `NPM_TOKEN` environment variable.
-
-`export NPM_TOKEN=<your acces token>`
-
-Build and publish the package. You must first set a new version of the package. You must choose one that is not yet
-taken
-(or delete the existing package). You can use
-`yarn bump`  or `yarn version <new version>`.
-
-Then you should build the package
-
-`yarn build`
-
-and publish.
-
-`npm publish`
-
-You should now be able to see the package in the GitLab project registry.
-
-The id of the project is set to `16539767`
+The package can be published by triggering the workflow https://github.com/gooddata/gdc-nas/actions/workflows/publish_maql_antlr4ts_npm.yml manually.

package/dist/index.d.ts

@@ -101,37 +101,41 @@ declare class MaqlLexer extends Lexer {
     static readonly YEAR = 85;
     static readonly WEEK = 86;
     static readonly WEEKOFYEAR = 87;
-    static readonly WS = 88;
-    static readonly Comment = 89;
-    static readonly UnterminatedString = 90;
-    static readonly String = 91;
-    static readonly LBRACE = 92;
-    static readonly RBRACE = 93;
-    static readonly RELOP = 94;
-    static readonly COMMA = 95;
-    static readonly SEMICOLON = 96;
-    static readonly LPAREN = 97;
-    static readonly RPAREN = 98;
-    static readonly MINUS = 99;
-    static readonly PERCENT = 100;
-    static readonly PLUS = 101;
-    static readonly MUL = 102;
-    static readonly DIV = 103;
-    static readonly ZERO = 104;
-    static readonly Natural = 105;
-    static readonly Real = 106;
-    static readonly Identifier = 107;
-    static readonly ERROR_CHARACTER = 108;
-    static readonly FACT = 109;
-    static readonly ATTRIBUTE = 110;
-    static readonly METRIC_TYPE = 111;
-    static readonly LABEL = 112;
-    static readonly LOCAL = 113;
-    static readonly PROMPT = 114;
-    static readonly DATASET = 115;
-    static readonly UNKNOWN_TYPE = 116;
-    static readonly SEP = 117;
-    static readonly ID = 118;
+    static readonly FISCALMONTH = 88;
+    static readonly FISCALQUARTER = 89;
+    static readonly FISCALYEAR = 90;
+    static readonly WS = 91;
+    static readonly Comment = 92;
+    static readonly UnterminatedString = 93;
+    static readonly String = 94;
+    static readonly LBRACE = 95;
+    static readonly RBRACE = 96;
+    static readonly RELOP = 97;
+    static readonly COMMA = 98;
+    static readonly SEMICOLON = 99;
+    static readonly LPAREN = 100;
+    static readonly RPAREN = 101;
+    static readonly MINUS = 102;
+    static readonly PERCENT = 103;
+    static readonly PLUS = 104;
+    static readonly MUL = 105;
+    static readonly DIV = 106;
+    static readonly ZERO = 107;
+    static readonly Natural = 108;
+    static readonly Real = 109;
+    static readonly Identifier = 110;
+    static readonly ERROR_CHARACTER = 111;
+    static readonly FACT = 112;
+    static readonly ATTRIBUTE = 113;
+    static readonly METRIC_TYPE = 114;
+    static readonly LABEL = 115;
+    static readonly LOCAL = 116;
+    static readonly PARAMETER = 117;
+    static readonly PROMPT = 118;
+    static readonly DATASET = 119;
+    static readonly UNKNOWN_TYPE = 120;
+    static readonly SEP = 121;
+    static readonly ID = 122;
     static readonly OBJECT_TYPE = 1;
     static readonly OBJECT_ID = 2;
     static readonly channelNames: string[];
@@ -1154,6 +1158,16 @@ interface MaqlParserListener extends ParseTreeListener {
      * @param ctx the parse tree
      */
     exitPrompt?: (ctx: PromptContext) => void;
+    /**
+     * Enter a parse tree produced by `MaqlParser.parameter`.
+     * @param ctx the parse tree
+     */
+    enterParameter?: (ctx: ParameterContext) => void;
+    /**
+     * Exit a parse tree produced by `MaqlParser.parameter`.
+     * @param ctx the parse tree
+     */
+    exitParameter?: (ctx: ParameterContext) => void;
     /**
      * Enter a parse tree produced by `MaqlParser.literal`.
      * @param ctx the parse tree
@@ -1254,6 +1268,16 @@ interface MaqlParserListener extends ParseTreeListener {
      * @param ctx the parse tree
      */
     exitListLiteral?: (ctx: ListLiteralContext) => void;
+    /**
+     * Enter a parse tree produced by `MaqlParser.listItem`.
+     * @param ctx the parse tree
+     */
+    enterListItem?: (ctx: ListItemContext) => void;
+    /**
+     * Exit a parse tree produced by `MaqlParser.listItem`.
+     * @param ctx the parse tree
+     */
+    exitListItem?: (ctx: ListItemContext) => void;
     /**
      * Enter a parse tree produced by `MaqlParser.nullLiteral`.
      * @param ctx the parse tree
@@ -1875,6 +1899,12 @@ interface MaqlParserVisitor<Result> extends ParseTreeVisitor<Result> {
      * @return the visitor result
      */
     visitPrompt?: (ctx: PromptContext) => Result;
+    /**
+     * Visit a parse tree produced by `MaqlParser.parameter`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitParameter?: (ctx: ParameterContext) => Result;
     /**
      * Visit a parse tree produced by `MaqlParser.literal`.
      * @param ctx the parse tree
@@ -1935,6 +1965,12 @@ interface MaqlParserVisitor<Result> extends ParseTreeVisitor<Result> {
      * @return the visitor result
      */
     visitListLiteral?: (ctx: ListLiteralContext) => Result;
+    /**
+     * Visit a parse tree produced by `MaqlParser.listItem`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitListItem?: (ctx: ListItemContext) => Result;
     /**
      * Visit a parse tree produced by `MaqlParser.nullLiteral`.
      * @param ctx the parse tree
@@ -2037,37 +2073,41 @@ declare class MaqlParser extends Parser {
     static readonly YEAR = 85;
     static readonly WEEK = 86;
     static readonly WEEKOFYEAR = 87;
-    static readonly WS = 88;
-    static readonly Comment = 89;
-    static readonly UnterminatedString = 90;
-    static readonly String = 91;
-    static readonly LBRACE = 92;
-    static readonly RBRACE = 93;
-    static readonly RELOP = 94;
-    static readonly COMMA = 95;
-    static readonly SEMICOLON = 96;
-    static readonly LPAREN = 97;
-    static readonly RPAREN = 98;
-    static readonly MINUS = 99;
-    static readonly PERCENT = 100;
-    static readonly PLUS = 101;
-    static readonly MUL = 102;
-    static readonly DIV = 103;
-    static readonly ZERO = 104;
-    static readonly Natural = 105;
-    static readonly Real = 106;
-    static readonly Identifier = 107;
-    static readonly ERROR_CHARACTER = 108;
-    static readonly FACT = 109;
-    static readonly ATTRIBUTE = 110;
-    static readonly METRIC_TYPE = 111;
-    static readonly LABEL = 112;
-    static readonly LOCAL = 113;
-    static readonly PROMPT = 114;
-    static readonly DATASET = 115;
-    static readonly UNKNOWN_TYPE = 116;
-    static readonly SEP = 117;
-    static readonly ID = 118;
+    static readonly FISCALMONTH = 88;
+    static readonly FISCALQUARTER = 89;
+    static readonly FISCALYEAR = 90;
+    static readonly WS = 91;
+    static readonly Comment = 92;
+    static readonly UnterminatedString = 93;
+    static readonly String = 94;
+    static readonly LBRACE = 95;
+    static readonly RBRACE = 96;
+    static readonly RELOP = 97;
+    static readonly COMMA = 98;
+    static readonly SEMICOLON = 99;
+    static readonly LPAREN = 100;
+    static readonly RPAREN = 101;
+    static readonly MINUS = 102;
+    static readonly PERCENT = 103;
+    static readonly PLUS = 104;
+    static readonly MUL = 105;
+    static readonly DIV = 106;
+    static readonly ZERO = 107;
+    static readonly Natural = 108;
+    static readonly Real = 109;
+    static readonly Identifier = 110;
+    static readonly ERROR_CHARACTER = 111;
+    static readonly FACT = 112;
+    static readonly ATTRIBUTE = 113;
+    static readonly METRIC_TYPE = 114;
+    static readonly LABEL = 115;
+    static readonly LOCAL = 116;
+    static readonly PARAMETER = 117;
+    static readonly PROMPT = 118;
+    static readonly DATASET = 119;
+    static readonly UNKNOWN_TYPE = 120;
+    static readonly SEP = 121;
+    static readonly ID = 122;
     static readonly RULE_maql = 0;
     static readonly RULE_maqlExpression = 1;
     static readonly RULE_selectExpression = 2;
@@ -2135,18 +2175,20 @@ declare class MaqlParser extends Parser {
     static readonly RULE_numericType = 64;
     static readonly RULE_numeric = 65;
     static readonly RULE_prompt = 66;
-    static readonly RULE_literal = 67;
-    static readonly RULE_number = 68;
-    static readonly RULE_uNumber = 69;
-    static readonly RULE_integer = 70;
-    static readonly RULE_uInteger = 71;
-    static readonly RULE_posInteger = 72;
-    static readonly RULE_uReal = 73;
-    static readonly RULE_percentage = 74;
-    static readonly RULE_string = 75;
-    static readonly RULE_listLiteral = 76;
-    static readonly RULE_nullLiteral = 77;
-    static readonly RULE_granularity = 78;
+    static readonly RULE_parameter = 67;
+    static readonly RULE_literal = 68;
+    static readonly RULE_number = 69;
+    static readonly RULE_uNumber = 70;
+    static readonly RULE_integer = 71;
+    static readonly RULE_uInteger = 72;
+    static readonly RULE_posInteger = 73;
+    static readonly RULE_uReal = 74;
+    static readonly RULE_percentage = 75;
+    static readonly RULE_string = 76;
+    static readonly RULE_listLiteral = 77;
+    static readonly RULE_listItem = 78;
+    static readonly RULE_nullLiteral = 79;
+    static readonly RULE_granularity = 80;
     static readonly ruleNames: string[];
     private static readonly _LITERAL_NAMES;
     private static readonly _SYMBOLIC_NAMES;
@@ -2224,6 +2266,7 @@ declare class MaqlParser extends Parser {
     numericType(): NumericTypeContext;
     numeric(): NumericContext;
     prompt(): PromptContext;
+    parameter(): ParameterContext;
     literal(): LiteralContext;
     number(): NumberContext;
     uNumber(): UNumberContext;
@@ -2234,6 +2277,7 @@ declare class MaqlParser extends Parser {
     percentage(): PercentageContext;
     string(): StringContext;
     listLiteral(): ListLiteralContext;
+    listItem(): ListItemContext;
     nullLiteral(): NullLiteralContext;
     granularity(): GranularityContext;
     private static readonly _serializedATNSegments;
@@ -2487,6 +2531,7 @@ declare class PrimaryExpressionContext extends ParserRuleContext {
     numeric(): NumericContext | undefined;
     attribute(): AttributeContext | undefined;
     prompt(): PromptContext | undefined;
+    parameter(): ParameterContext | undefined;
     literal(): LiteralContext | undefined;
     timeMacro(): TimeMacroContext | undefined;
     granularity(): GranularityContext | undefined;
@@ -3150,6 +3195,18 @@ declare class PromptContext extends ParserRuleContext {
     exitRule(listener: MaqlParserListener): void;
     accept<Result>(visitor: MaqlParserVisitor<Result>): Result;
 }
+declare class ParameterContext extends ParserRuleContext {
+    LBRACE(): TerminalNode;
+    PARAMETER(): TerminalNode;
+    SEP(): TerminalNode;
+    ID(): TerminalNode;
+    RBRACE(): TerminalNode;
+    constructor(parent: ParserRuleContext | undefined, invokingState: number);
+    get ruleIndex(): number;
+    enterRule(listener: MaqlParserListener): void;
+    exitRule(listener: MaqlParserListener): void;
+    accept<Result>(visitor: MaqlParserVisitor<Result>): Result;
+}
 declare class LiteralContext extends ParserRuleContext {
     uNumber(): UNumberContext | undefined;
     string(): StringContext | undefined;
@@ -3241,11 +3298,20 @@ declare class StringContext extends ParserRuleContext {
     accept<Result>(visitor: MaqlParserVisitor<Result>): Result;
 }
 declare class ListLiteralContext extends ParserRuleContext {
+    listItem(): ListItemContext[];
+    listItem(i: number): ListItemContext;
+    COMMA(): TerminalNode[];
+    COMMA(i: number): TerminalNode;
+    constructor(parent: ParserRuleContext | undefined, invokingState: number);
+    get ruleIndex(): number;
+    enterRule(listener: MaqlParserListener): void;
+    exitRule(listener: MaqlParserListener): void;
+    accept<Result>(visitor: MaqlParserVisitor<Result>): Result;
+}
+declare class ListItemContext extends ParserRuleContext {
     string(): StringContext | undefined;
     number(): NumberContext | undefined;
     nullLiteral(): NullLiteralContext | undefined;
-    COMMA(): TerminalNode | undefined;
-    listLiteral(): ListLiteralContext | undefined;
     constructor(parent: ParserRuleContext | undefined, invokingState: number);
     get ruleIndex(): number;
     enterRule(listener: MaqlParserListener): void;
@@ -3277,6 +3343,9 @@ declare class GranularityContext extends ParserRuleContext {
     YEAR(): TerminalNode | undefined;
     WEEK(): TerminalNode | undefined;
     WEEKOFYEAR(): TerminalNode | undefined;
+    FISCALMONTH(): TerminalNode | undefined;
+    FISCALQUARTER(): TerminalNode | undefined;
+    FISCALYEAR(): TerminalNode | undefined;
     constructor(parent: ParserRuleContext | undefined, invokingState: number);
     get ruleIndex(): number;
     enterRule(listener: MaqlParserListener): void;
@@ -4578,6 +4647,7 @@ declare class MaqlAstVisitor extends AbstractParseTreeVisitor<AstNode> implement
     visitRelationBetween(ctx: RelationBetweenContext): AstNode;
     visitRelationIn(ctx: RelationInContext): AstNode;
     visitListLiteral(ctx: ListLiteralContext): AstNode;
+    visitListItem(ctx: ListItemContext): AstNode;
     visitRelationLike(ctx: RelationLikeContext): AstNode;
     visitAddition(ctx: AdditionContext): AstNode;
     visitMultiplication(ctx: MultiplicationContext): AstNode;
@@ -4624,6 +4694,7 @@ declare class MaqlAstVisitor extends AbstractParseTreeVisitor<AstNode> implement
     visitFact(ctx: FactContext): AstNode;
     visitAttribute(ctx: AttributeContext): AstNode;
     visitAttributeList(ctx: AttributeListContext): AstNode;
+    visitParameter(ctx: ParameterContext): AstNode;
     visitPrompt(ctx: PromptContext): AstNode;
     private visitObject;
     visitUReal(ctx: URealContext): AstNode;
@@ -4655,7 +4726,7 @@ declare class MaqlAstVisitor extends AbstractParseTreeVisitor<AstNode> implement
     visitWithoutPf(ctx: WithoutPfContext): AstNode;
     visitPf(ctx: WithPfContext | WithoutPfContext, pfType: ParentFilterModification, operator: ModificationOperator): AstNode;
 }
-declare type ObjectContext = NumericContext | AttributeContext | FactContext | PromptContext;
+declare type ObjectContext = NumericContext | AttributeContext | FactContext | ParameterContext | PromptContext;
 
 /**
  * AST visitor which makes adjustment to an AST such that its shape is the same as the output of
@@ -4668,4 +4739,4 @@ declare class AstNormalizer extends AbstractAstVisitor<AstNode> {
     visitOperatorNode(node: OperatorNode): AstNode;
 }
 
-export { AbstractAstVisitor, AdditionContext, AdditiveOperatorContext, AllOtherContext, AstNode, AstNormalizer, AstType, AttributeContext, AttributeListContext, AttributeTypeContext, BooleanLiteral, BooleanLiteralNode, By, ByContext, ByNode, Case, CaseConditionalContext, CaseContext, CaseInsensitiveCharStream, CaseNode, ComparisonContext, Conditional, ConditionalContext, ConditionalNode, ConjunctionContext, CurrentRowContext, DatetimeTransformation, DatetimeTransformationNode, DimensionAllContext, DimensionContext, DimensionListContext, DimensionObjectContext, DimensionOperator, DimensionOperatorNode, DimensionsAllOtherContext, DimensionsContext, DimensionsDimensionListContext, Direction, DirectionNode, DisjunctionContext, Else, ElseNode, EmptyNode, Expression, ExpressionContext, ExpressionListContext, ExpressionNode, FactContext, FalseLiteralContext, Filter, FilterNode, ForEach, ForEachContext, ForEachNode, ForTransformationContext, FunctionAstType, FunctionCallContext, FunctionCallLastFirstValueContext, FunctionCallRankContext, FunctionCallRunContext, FunctionContext, FunctionDefinition, FunctionName, FunctionNode, FunctionParameter, Granularity, GranularityContext, GranularityNode, HavingContext, IAstNode, IPosition, IRange, Identifier, IdentifierNode, IfContext, Image, ImageNode, IntegerContext, LastFirstValueFunction, LastFirstValueFunctionNode, LastfirstvalFunctionNameContext, LikeContext, List, ListLiteralContext, ListNode, LiteralContext, MaqlAstVisitor, MaqlComputedAttributeContext, MaqlContext, MaqlExpressionContext, MaqlFilterContext, MaqlFunction, MaqlLexer, MaqlMeasureContext, MaqlParser, MaqlParserListener, MaqlParserVisitor, MetricReference, MetricReferenceNode, ModificationOperator, ModificationOperatorNode, MultiplicationContext, MultiplicativeOperatorContext, NegationContext, NullLiteral, NullLiteralContext, NullLiteralNode, NumberContext, NumberLiteral, NumberLiteralFormat, NumberLiteralNode, NumericContext, NumericTypeContext, ObjectContext, ObjectId, ObjectSpace, ObjectType, Operator, OperatorNode, OrderBy, OrderByElement, OrderByElementNode, OrderByNode, OrderListContext, OrderbyContext, OrderedElementContext, OverToContext, ParameterType, ParentFilterModification, ParentFilterModificationNode, ParenthesizedExpressionContext, PercentageContext, PosIntegerContext, PrefixUnaryExpressionContext, PrefixUnaryOperatorContext, PrimaryExpressionContext, PromptContext, RankDirContext, RankFunction, RankFunctionNameContext, RankFunctionNode, RankSpecContext, RankSpecPercentageContext, RankSpecUnumberContext, RankingFilter, RankingFilterContext, RankingFilterInContext, RankingFilterInOfContext, RankingFilterNode, RankingFilterOfContext, RelationBetweenContext, RelationContext, RelationInContext, RelationLikeContext, RelationNegatableContext, RelationNotContext, RelationRelopContext, ReportMetricContext, RollWindowContext, RunningFunction, RunningFunctionNameContext, RunningFunctionNode, Select, SelectExpressionContext, SelectNode, StringContext, StringLiteral, StringLiteralNode, SyntaxErrorListener, TimeMacroContext, TimeMacroName, TimeMacroNameContext, TopBottomContext, TransFunctionContext, TrueLiteralContext, UIntegerContext, UIntegerPosContext, UIntegerZeroContext, UNumberContext, URealContext, Using, UsingContext, UsingNode, WhereContext, WhereHavingContext, Window, WindowBound, WindowBoundContext, WindowBoundNode, WindowBoundedContext, WindowDirContext, WindowNode, WindowUnboundedContext, WithPfContext, WithWithoutPfContext, WithinContext, WithinDimensionsContext, WithoutPfContext, escapeString, functionDefinitions, isMaqlFunction, isMaqlFunctionName, isOperator, isRankingFilter, isWindowBound, mergeRanges, nonNullContent, positionInRange };
+export { AbstractAstVisitor, AdditionContext, AdditiveOperatorContext, AllOtherContext, AstNode, AstNormalizer, AstType, AttributeContext, AttributeListContext, AttributeTypeContext, BooleanLiteral, BooleanLiteralNode, By, ByContext, ByNode, Case, CaseConditionalContext, CaseContext, CaseInsensitiveCharStream, CaseNode, ComparisonContext, Conditional, ConditionalContext, ConditionalNode, ConjunctionContext, CurrentRowContext, DatetimeTransformation, DatetimeTransformationNode, DimensionAllContext, DimensionContext, DimensionListContext, DimensionObjectContext, DimensionOperator, DimensionOperatorNode, DimensionsAllOtherContext, DimensionsContext, DimensionsDimensionListContext, Direction, DirectionNode, DisjunctionContext, Else, ElseNode, EmptyNode, Expression, ExpressionContext, ExpressionListContext, ExpressionNode, FactContext, FalseLiteralContext, Filter, FilterNode, ForEach, ForEachContext, ForEachNode, ForTransformationContext, FunctionAstType, FunctionCallContext, FunctionCallLastFirstValueContext, FunctionCallRankContext, FunctionCallRunContext, FunctionContext, FunctionDefinition, FunctionName, FunctionNode, FunctionParameter, Granularity, GranularityContext, GranularityNode, HavingContext, IAstNode, IPosition, IRange, Identifier, IdentifierNode, IfContext, Image, ImageNode, IntegerContext, LastFirstValueFunction, LastFirstValueFunctionNode, LastfirstvalFunctionNameContext, LikeContext, List, ListItemContext, ListLiteralContext, ListNode, LiteralContext, MaqlAstVisitor, MaqlComputedAttributeContext, MaqlContext, MaqlExpressionContext, MaqlFilterContext, MaqlFunction, MaqlLexer, MaqlMeasureContext, MaqlParser, MaqlParserListener, MaqlParserVisitor, MetricReference, MetricReferenceNode, ModificationOperator, ModificationOperatorNode, MultiplicationContext, MultiplicativeOperatorContext, NegationContext, NullLiteral, NullLiteralContext, NullLiteralNode, NumberContext, NumberLiteral, NumberLiteralFormat, NumberLiteralNode, NumericContext, NumericTypeContext, ObjectContext, ObjectId, ObjectSpace, ObjectType, Operator, OperatorNode, OrderBy, OrderByElement, OrderByElementNode, OrderByNode, OrderListContext, OrderbyContext, OrderedElementContext, OverToContext, ParameterContext, ParameterType, ParentFilterModification, ParentFilterModificationNode, ParenthesizedExpressionContext, PercentageContext, PosIntegerContext, PrefixUnaryExpressionContext, PrefixUnaryOperatorContext, PrimaryExpressionContext, PromptContext, RankDirContext, RankFunction, RankFunctionNameContext, RankFunctionNode, RankSpecContext, RankSpecPercentageContext, RankSpecUnumberContext, RankingFilter, RankingFilterContext, RankingFilterInContext, RankingFilterInOfContext, RankingFilterNode, RankingFilterOfContext, RelationBetweenContext, RelationContext, RelationInContext, RelationLikeContext, RelationNegatableContext, RelationNotContext, RelationRelopContext, ReportMetricContext, RollWindowContext, RunningFunction, RunningFunctionNameContext, RunningFunctionNode, Select, SelectExpressionContext, SelectNode, StringContext, StringLiteral, StringLiteralNode, SyntaxErrorListener, TimeMacroContext, TimeMacroName, TimeMacroNameContext, TopBottomContext, TransFunctionContext, TrueLiteralContext, UIntegerContext, UIntegerPosContext, UIntegerZeroContext, UNumberContext, URealContext, Using, UsingContext, UsingNode, WhereContext, WhereHavingContext, Window, WindowBound, WindowBoundContext, WindowBoundNode, WindowBoundedContext, WindowDirContext, WindowNode, WindowUnboundedContext, WithPfContext, WithWithoutPfContext, WithinContext, WithinDimensionsContext, WithoutPfContext, escapeString, functionDefinitions, isMaqlFunction, isMaqlFunctionName, isOperator, isRankingFilter, isWindowBound, mergeRanges, nonNullContent, positionInRange };