@elastic/esql 0.0.1

package/lib/parser/core/esql_error_listener.d.ts

@@ -0,0 +1,8 @@
+import * as antlr4 from 'antlr4';
+import type { EditorError } from '../../types';
+export declare class ESQLErrorListener extends antlr4.ErrorListener<unknown> {
+    protected errors: EditorError[];
+    syntaxError(recognizer: antlr4.Recognizer<unknown>, offendingSymbol: unknown, line: number, column: number, message: string, error: antlr4.RecognitionException | undefined): void;
+    getErrors(): EditorError[];
+}
+//# sourceMappingURL=esql_error_listener.d.ts.map

package/lib/parser/core/esql_error_listener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"esql_error_listener.d.ts","sourceRoot":"","sources":["../../../src/parser/core/esql_error_listener.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAU/C,qBAAa,iBAAkB,SAAQ,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC;IAClE,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,CAAM;IAErC,WAAW,CACT,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EACtC,eAAe,EAAE,OAAO,EACxB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,CAAC,oBAAoB,GAAG,SAAS,GAC7C,IAAI;IA8BP,SAAS,IAAI,WAAW,EAAE;CAG3B"}

package/lib/parser/core/helpers.d.ts

@@ -0,0 +1,9 @@
+export declare const nonNullable: <T>(v: T) => v is NonNullable<T>;
+/**
+ * Removes backtick quotes from around a field name and un-escapes any
+ * backticks (double ``) within the field name.
+ *
+ * @param field A potentially escaped field (column).
+ */
+export declare const unescapeColumn: (field: string) => string;
+//# sourceMappingURL=helpers.d.ts.map

package/lib/parser/core/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/parser/core/helpers.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,WAAW,GAAI,CAAC,EAAE,GAAG,CAAC,KAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAEvD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,MAAM,WAM3C,CAAC"}

package/lib/parser/core/parser.d.ts

@@ -0,0 +1,136 @@
+import { type Token } from 'antlr4';
+import { CommonTokenStream, type CharStream } from 'antlr4';
+import { ESQLErrorListener } from './esql_error_listener';
+import { default as ESQLLexer } from '../antlr/esql_lexer';
+import { default as ESQLParser } from '../antlr/esql_parser';
+import type { ESQLAst, ESQLAstExpression, ESQLAstHeaderCommand, ESQLAstQueryExpression, ESQLCommand, ESQLMap, ESQLProperNode, EditorError } from '../../types';
+import type { EsqlParsingTarget } from './types';
+export interface ParseOptions {
+    /**
+     * Whether to collect and attach to AST nodes user's custom formatting:
+     * comments and whitespace.
+     */
+    withFormatting?: boolean;
+}
+export interface ParseResult<T extends ESQLProperNode = ESQLAstQueryExpression> {
+    /**
+     * The root *QueryExpression* node of the parsed tree.
+     */
+    root: T;
+    /**
+     * List of parsed commands.
+     *
+     * @deprecated Use `root` instead.
+     */
+    ast: ESQLAst;
+    /**
+     * List of ANTLR tokens generated by the lexer.
+     */
+    tokens: Token[];
+    /**
+     * List of parsing errors.
+     */
+    errors: EditorError[];
+}
+export declare class Parser {
+    readonly src: string;
+    readonly options: ParseOptions;
+    static readonly create: (src: string, options?: ParseOptions) => Parser;
+    /**
+     * Parse a complete ES|QL query, generating an AST and a list of parsing errors.
+     *
+     * Make sure to check the returned `errors` list for any parsing issues.
+     *
+     * For example:
+     *
+     * ```typescript
+     * const result = Parser.parse('FROM my_index | STATS count(*)');
+     * ```
+     *
+     * @param src Source text to parse.
+     * @param options Parsing options.
+     */
+    static readonly parse: (src: string, options?: ParseOptions) => ParseResult;
+    /**
+     * Extract parsing errors from the source text without generating an AST.
+     *
+     * @param src Source text to parse for errors.
+     * @returns A list of parsing errors.
+     */
+    static readonly parseErrors: (src: string) => EditorError[];
+    static readonly parseQuery: (src: string, options?: ParseOptions) => ParseResult<ESQLAstQueryExpression>;
+    /**
+     * Parse a single ES|QL header pseudo-command, generating an AST and a list of parsing errors.
+     *
+     * Make sure to check the returned `errors` list for any parsing issues.
+     *
+     * For example:
+     *
+     * ```typescript
+     * const result = Parser.parseSetCommand('SET a = "foo"');
+     * ```
+     *
+     * @param src Source text of a SET pseudo-command to parse.
+     * @param options Parsing options.
+     * @returns A result object containing the parsed SET command, its AST, tokens, and errors.
+     */
+    static readonly parseHeaderCommand: (src: string, options?: ParseOptions) => ParseResult<ESQLAstHeaderCommand>;
+    /**
+     * Parse a single ES|QL command, generating an AST and a list of parsing errors.
+     *
+     * Make sure to check the returned `errors` list for any parsing issues.
+     *
+     * For example:
+     *
+     * ```typescript
+     * const result = Parser.parseCommand('ROW abc = 123');
+     * ```
+     *
+     * @param src Source text of a single command to parse.
+     * @param options Parsing options.
+     * @returns A result object containing the parsed command, its AST, tokens, and errors.
+     */
+    static readonly parseCommand: (src: string, options?: ParseOptions) => ParseResult<ESQLCommand>;
+    /**
+     * Parse a single ES|QL expression, generating an AST and a list of parsing errors.
+     *
+     * Make sure to check the returned `errors` list for any parsing issues.
+     *
+     * For example:
+     *
+     * ```typescript
+     * const result = Parser.parseExpression('count(*) + 1');
+     * ```
+     *
+     * @param src Source text of an expression to parse.
+     * @param options Parsing options.
+     * @returns A result object containing the parsed expression, its AST, tokens, and errors.
+     */
+    static readonly parseExpression: (src: string, options?: ParseOptions) => ParseResult<ESQLAstExpression>;
+    static readonly parseMap: (src: string, options?: ParseOptions) => ParseResult<ESQLMap>;
+    /**
+     * Get the first `count` tokens from the source text.
+     *
+     * @param src Text to parse for tokens.
+     * @param count Number of tokens to parse.
+     * @param visible Whether to return only visible tokens (not comments or whitespace).
+     * @returns An array of parsed tokens.
+     */
+    static readonly tokens: (src: string, count: number, visible?: boolean) => Token[];
+    readonly streams: CharStream;
+    readonly lexer: ESQLLexer;
+    readonly tokens: CommonTokenStream;
+    readonly parser: ESQLParser;
+    readonly errors: ESQLErrorListener;
+    constructor(src: string, options?: ParseOptions);
+    parseTarget<T extends ESQLProperNode>([rule, conversion,]: EsqlParsingTarget): ParseResult<T>;
+    parseSourceCommand(): ParseResult<ESQLCommand>;
+    parseProcessingCommand(): ParseResult<ESQLCommand>;
+    parse(): ParseResult<ESQLAstQueryExpression>;
+    parseErrors(): EditorError[];
+}
+/**
+ * @deprecated Use `Parser.parse` instead.
+ */
+export declare const parse: (src: string | undefined, options?: ParseOptions) => ParseResult;
+//# sourceMappingURL=parser.d.ts.map

package/lib/parser/core/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../../src/parser/core/parser.ts"],"names":[],"mappings":"AAOA,OAAO,EAAe,KAAK,KAAK,EAAE,MAAM,QAAQ,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,KAAK,UAAU,EAAE,MAAM,QAAQ,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAI1D,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EACV,OAAO,EACP,iBAAiB,EACjB,oBAAoB,EACpB,sBAAsB,EACtB,WAAW,EACX,OAAO,EACP,cAAc,EACd,WAAW,EACZ,MAAM,aAAa,CAAC;AAIrB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEjD,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,cAAc,GAAG,sBAAsB;IAC5E;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IAER;;;;OAIG;IACH,GAAG,EAAE,OAAO,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,KAAK,EAAE,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AAED,qBAAa,MAAM;aA4QC,GAAG,EAAE,MAAM;aACX,OAAO,EAAE,YAAY;IA5QvC,gBAAuB,MAAM,GAAI,KAAK,MAAM,EAAE,UAAU,YAAY,YAElE;IAEF;;;;;;;;;;;;;OAaG;IACH,gBAAuB,KAAK,GAAI,KAAK,MAAM,EAAE,UAAU,YAAY,KAAG,WAAW,CAE/E;IAEF;;;;;OAKG;IACH,gBAAuB,WAAW,GAAI,KAAK,MAAM,KAAG,WAAW,EAAE,CAE/D;IAEF,gBAAuB,UAAU,GAC/B,KAAK,MAAM,EACX,UAAU,YAAY,KACrB,WAAW,CAAC,sBAAsB,CAAC,CAQpC;IAEF;;;;;;;;;;;;;;OAcG;IACH,gBAAuB,kBAAkB,GACvC,KAAK,MAAM,EACX,UAAU,YAAY,KACrB,WAAW,CAAC,oBAAoB,CAAC,CAqBlC;IAEF;;;;;;;;;;;;;;OAcG;IACH,gBAAuB,YAAY,GACjC,KAAK,MAAM,EACX,UAAU,YAAY,KACrB,WAAW,CAAC,WAAW,CAAC,CA8BzB;IAEF;;;;;;;;;;;;;;OAcG;IACH,gBAAuB,eAAe,GACpC,KAAK,MAAM,EACX,UAAU,YAAY,KACrB,WAAW,CAAC,iBAAiB,CAAC,CAmC/B;IAEF,gBAAuB,QAAQ,GAAI,KAAK,MAAM,EAAE,UAAU,YAAY,KAAG,WAAW,CAAC,OAAO,CAAC,CA+B3F;IAEF;;;;;;;OAOG;IACH,gBAAuB,MAAM,GAC3B,KAAK,MAAM,EACX,OAAO,MAAM,EACb,UAAS,OAAc,KACtB,KAAK,EAAE,CAsBR;IAEF,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,SAAgB,KAAK,EAAE,SAAS,CAAC;IACjC,SAAgB,MAAM,EAAE,iBAAiB,CAAC;IAC1C,SAAgB,MAAM,EAAE,UAAU,CAAC;IACnC,SAAgB,MAAM,oBAA2B;gBAG/B,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,YAAiB;IAcrC,WAAW,CAAC,CAAC,SAAS,cAAc,EAAE,CAC3C,IAAI,EACJ,UAAU,EACX,EAAE,iBAAiB,GAAG,WAAW,CAAC,CAAC,CAAC;IA6B9B,kBAAkB,IAAI,WAAW,CAAC,WAAW,CAAC;IAI9C,sBAAsB,IAAI,WAAW,CAAC,WAAW,CAAC;IAIlD,KAAK,IAAI,WAAW,CAAC,sBAAsB,CAAC;IAyB5C,WAAW,IAAI,WAAW,EAAE;CAKpC;AAED;;GAEG;AACH,eAAO,MAAM,KAAK,GAAI,KAAK,MAAM,GAAG,SAAS,EAAE,UAAS,YAAiB,KAAG,WAO3E,CAAC"}

package/lib/parser/core/tokens.d.ts

@@ -0,0 +1,45 @@
+import type { Token } from 'antlr4';
+import type { ESQLLocation } from '../../types';
+/**
+ * Finds all tokens in the given range using binary search. Allows to further
+ * filter the tokens using a predicate.
+ *
+ * @param tokens List of ANTLR tokens.
+ * @param min Text position to start searching from.
+ * @param max Text position to stop searching at.
+ * @param predicate Function to test each token.
+ */
+export declare const findTokens: (tokens: Token[], min?: number, max?: number, predicate?: (token: Token) => boolean) => Iterable<Token>;
+/**
+ * Finds the first token in the given range using binary search. Allows to
+ * further filter the tokens using a predicate.
+ *
+ * @param tokens List of ANTLR tokens.
+ * @param min Text position to start searching from.
+ * @param max Text position to stop searching at.
+ * @param predicate Function to test each token.
+ * @returns The first token that matches the predicate or `null` if no token is found.
+ */
+export declare const findFirstToken: (tokens: Token[], min?: number, max?: number, predicate?: (token: Token) => boolean) => Token | null;
+/**
+ * Finds the first visible token in the given token range using binary search.
+ *
+ * @param tokens List of ANTLR tokens.
+ * @param min Text position to start searching from.
+ * @param max Text position to stop searching at.
+ * @returns The first punctuation token or `null` if no token is found.
+ */
+export declare const findVisibleToken: (tokens: Token[], min?: number, max?: number) => Token | null;
+export declare const isLikelyPunctuation: (text: string) => boolean;
+/**
+ * Finds the first punctuation token in the given token range using binary
+ * search.
+ *
+ * @param tokens List of ANTLR tokens.
+ * @param min Text position to start searching from.
+ * @param max Text position to stop searching at.
+ * @returns The first punctuation token or `null` if no token is found.
+ */
+export declare const findPunctuationToken: (tokens: Token[], min?: number, max?: number) => Token | null;
+export declare const getPosition: (start: Pick<Token, "start" | "stop"> | null, stop?: Pick<Token, "stop"> | undefined) => ESQLLocation;
+//# sourceMappingURL=tokens.d.ts.map

package/lib/parser/core/tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../../src/parser/core/tokens.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GACrB,QAAQ,KAAK,EAAE,EACf,MAAK,MAAU,EACf,MAAK,MAA2D,EAChE,YAAW,CAAC,KAAK,EAAE,KAAK,KAAK,OAAoB,KAChD,QAAQ,CAAC,KAAK,CA+BhB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,GACzB,QAAQ,KAAK,EAAE,EACf,MAAK,MAAU,EACf,MAAK,MAA2D,EAChE,YAAW,CAAC,KAAK,EAAE,KAAK,KAAK,OAAoB,KAChD,KAAK,GAAG,IAMV,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,KAAK,EAAE,EACf,MAAK,MAAU,EACf,MAAK,MAA2D,KAC/D,KAAK,GAAG,IAOV,CAAC;AAOF,eAAO,MAAM,mBAAmB,GAAI,MAAM,MAAM,KAAG,OACF,CAAC;AAElD;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,KAAK,EAAE,EACf,MAAK,MAAU,EACf,MAAK,MAA2D,KAC/D,KAAK,GAAG,IAQV,CAAC;AAEF,eAAO,MAAM,WAAW,GACtB,OAAO,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC,GAAG,IAAI,EAC3C,OAAO,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS,KACrC,YAWF,CAAC"}

package/lib/parser/core/types.d.ts

@@ -0,0 +1,69 @@
+import type * as esql_parser from '../antlr/esql_parser';
+import type { CstToAstConverter } from './cst_to_ast_converter';
+import type { ESQLAstComment } from '../../types';
+/**
+ * Lines of decorations per *whitespace line*. A *whitespace line* is a line
+ * which tracks line breaks only from the HIDDEN channel. It does not take into
+ * account line breaks from the DEFAULT channel, i.e. content lines. For example,
+ * it will ignore line breaks from triple-quoted strings, but will track line
+ * breaks from comments and whitespace.
+ *
+ * Each list entry represents a line of decorations.
+ */
+export type ParsedFormattingDecorationLines = ParsedFormattingDecoration[][];
+/**
+ * A source text decoration that we are interested in.
+ *
+ * - Comments: we preserve user comments when pretty-printing.
+ * - Line breaks: we allow users to specify one custom line break.
+ */
+export type ParsedFormattingDecoration = ParsedFormattingCommentDecoration | ParsedFormattingLineBreakDecoration;
+/**
+ * A comment AST node with additional information about its position in the
+ * source text.
+ */
+export interface ParsedFormattingCommentDecoration {
+    type: 'comment';
+    /**
+     * Whether the comment has content on the same line to the left of it.
+     */
+    hasContentToLeft: boolean;
+    /**
+     * Whether the comment has content on the same line to the right of it.
+     */
+    hasContentToRight: boolean;
+    /**
+     * The comment AST node.
+     */
+    node: ESQLAstComment;
+}
+export interface ParsedFormattingLineBreakDecoration {
+    type: 'line-break';
+    /**
+     * The number of line breaks in the source text.
+     */
+    lines: number;
+}
+type Functions<T> = {
+    [K in keyof T]: T[K] extends (...args: unknown[]) => unknown ? K : never;
+};
+type GrammarRule = keyof Functions<InstanceType<typeof esql_parser.default>>;
+type CstToAstConversion = keyof Functions<CstToAstConverter>;
+/**
+ * Specifies a grammar *parsing target* for the ESQL parser. The parsing target
+ * is a grammar rule which is used to parse the source text. Picking a
+ * specific rule allows to parse any ES|QL grammar construct, such as a
+ * command, expression, or a query (instead of parsing the whole query).
+ */
+export type EsqlParsingTarget = [
+    /**
+     * ANTLR grammar rule, used to parse the source text.
+     */
+    rule: GrammarRule,
+    /**
+     * The conversion to use for converting the root ANTLR CST node to a Kibana AST node.
+     */
+    conversion: CstToAstConversion
+];
+export {};
+//# sourceMappingURL=types.d.ts.map

package/lib/parser/core/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/parser/core/types.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,KAAK,WAAW,MAAM,sBAAsB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,MAAM,+BAA+B,GAAG,0BAA0B,EAAE,EAAE,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAClC,iCAAiC,GACjC,mCAAmC,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,SAAS,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,mCAAmC;IAClD,IAAI,EAAE,YAAY,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,KAAK,SAAS,CAAC,CAAC,IAAI;KACjB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GAAG,CAAC,GAAG,KAAK;CACzE,CAAC;AACF,KAAK,WAAW,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7E,KAAK,kBAAkB,GAAG,MAAM,SAAS,CAAC,iBAAiB,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,WAAW;IAEjB;;OAEG;IACH,UAAU,EAAE,kBAAkB;CAC/B,CAAC"}

package/lib/parser/index.d.ts

@@ -0,0 +1,4 @@
+export { parse, Parser, type ParseOptions, type ParseResult } from './core/parser';
+export { TIME_SPAN_UNITS, TIME_DURATION_UNITS, HEADER_COMMANDS, SOURCE_COMMANDS, DATE_PERIOD_UNITS, } from './core/constants';
+export { ESQLErrorListener } from './core/esql_error_listener';
+//# sourceMappingURL=index.d.ts.map

package/lib/parser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/parser/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AAEnF,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,eAAe,EACf,iBAAiB,GAClB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC"}

package/lib/pretty_print/__tests__/fixtures.d.ts

@@ -0,0 +1,5 @@
+export declare const query1 = "\nfrom kibana_sample_data_logs\n| EVAL timestamp=DATE_TRUNC(3 hour, @timestamp), status = CASE(    to_integer(response.keyword) >= 200 and to_integer(response.keyword) < 400, \"HTTP 2xx and 3xx\",    to_integer(response.keyword) >= 400 and to_integer(response.keyword) < 500, \"HTTP 4xx\",     \"HTTP 5xx\")\n| stats results = count(*) by `Over time` = BUCKET(timestamp, 50, ?_tstart, ?_tend), status\n";
+export declare const query2 = "\nfrom kibana_sample_data_logs\n| sort @timestamp\n| eval t = now()\n| eval key = case(timestamp < t - 1 hour and timestamp > t - 2 hour, \"Last hour\", \"Other\")\n| stats sum = sum(bytes), count = count_distinct(clientip) by key, extension.keyword\n| eval sum_last_hour = case(key == \"Last hour\", sum), sum_rest = case(key == \"Other\", sum), count_last_hour = case(key == \"Last hour\", count), count_rest = case(key == \"Other\", count)\n| stats sum_last_hour = max(sum_last_hour), sum_rest = max(sum_rest), count_last_hour = max(count_last_hour), count_rest = max(count_rest) by key, extension.keyword\n| eval total_bytes = to_double(coalesce(sum_last_hour, 0::long) + coalesce(sum_rest, 0::long))\n| eval total_visits = to_double(coalesce(count_last_hour, 0::long) + coalesce(count_rest, 0::long))\n| eval bytes_transform = round(total_bytes / 1000000.0, 1)\n| eval bytes_transform_last_hour = round(sum_last_hour / 1000.0, 2)\n| keep count_last_hour, total_visits, bytes_transform, bytes_transform_last_hour, extension.keyword\n| stats count_last_hour = sum(count_last_hour), total_visits = sum(total_visits), bytes_transform = sum(bytes_transform), bytes_transform_last_hour = sum(bytes_transform_last_hour) by extension.keyword\n| rename total_visits as `Unique Visits (Total)`, count_last_hour as `Unique Visits (Last hour)`, bytes_transform as `Bytes(Total - MB)`, bytes_transform_last_hour as `Bytes(Last hour - KB)`, extension.keyword as `Type`\n";
+export declare const query3 = "\nfrom kibana_sample_data_logs\n| keep bytes, clientip, url.keyword, response.keyword\n| EVAL type = CASE(to_integer(response.keyword) >= 400 and to_integer(response.keyword) < 500, \"4xx\", to_integer(response.keyword) >= 500, \"5xx\", \"Other\")\n| stats Visits = count(), Unique = count_distinct(clientip), p95 = percentile(bytes, 95), median = median(bytes) by type, url.keyword\n| eval count_4xx = case(type == \"4xx\", Visits), count_5xx = case(type == \"5xx\", Visits), count_rest =  case(type == \"Other\", Visits)\n| stats count_4xx = sum(count_4xx), count_5xx  = sum(count_5xx), count_rest = sum(count_rest), Unique = sum(Unique),`95th percentile of bytes` = max(p95), `Median of bytes` = max(median)  BY url.keyword\n| eval count_4xx = COALESCE(count_4xx, 0::LONG), count_5xx = COALESCE(count_5xx, 0::LONG), count_rest = COALESCE(count_rest, 0::LONG)\n| eval total_records = TO_DOUBLE(count_4xx + count_5xx + count_rest)\n| eval percentage_4xx = count_4xx / total_records, percentage_5xx = count_5xx / total_records\n| eval percentage_4xx = round(100 * percentage_4xx, 2)\n| eval percentage_5xx = round(100 * percentage_5xx, 2)\n| drop count_4xx, count_rest, total_records\n| RENAME percentage_4xx as `HTTP 4xx`, percentage_5xx as `HTTP 5xx`\n";
+export declare const query4 = "\nfrom kibana_sample_data_logs, kibana_sample_data_flights, kibana_sample_data_ecommerce,\n  index1, my-data-2024-*, my-data-2025-01-*, xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx, yyyy-yyyy-yyyy-yyyy-yyyy-yyyy-yyyy-yyyy-yyyy\n  METADATA _index, _id, _type, _score\n\n| sort @timestamp\n| eval t = now()\n| eval key = case(timestamp < t - 1 hour and timestamp > t - 2 hour, \"Last hour\", \"Other\")\n| stats sum = sum(bytes), count = count_distinct(clientip) by key, extension.keyword\n| eval sum_last_hour = case(key == \"Last hour\", sum), sum_rest = case(key == \"Other\", sum), count_last_hour = case(key == \"Last hour\", count), count_rest = case(key == \"Other\", count)\n| stats sum_last_hour = max(sum_last_hour), sum_rest = max(sum_rest), count_last_hour = max(count_last_hour), count_rest = max(count_rest) by key, extension.keyword\n| eval total_bytes = to_double(coalesce(sum_last_hour, 0::long) + coalesce(sum_rest, 0::long))\n| eval total_visits = to_double(coalesce(count_last_hour, 0::long) + coalesce(count_rest, 0::long))\n| eval bytes_transform = round(total_bytes / 1000000.0, 1)\n| eval bytes_transform_last_hour = round(sum_last_hour / 1000.0, 2)\n| keep count_last_hour, total_visits, bytes_transform, bytes_transform_last_hour, extension.keyword\n| stats count_last_hour = sum(count_last_hour), total_visits = sum(total_visits), bytes_transform = sum(bytes_transform), bytes_transform_last_hour = sum(bytes_transform_last_hour) by extension.keyword\n| rename total_visits as `Unique Visits (Total)`, count_last_hour as `Unique Visits (Last hour)`, bytes_transform as `Bytes(Total - MB)`, bytes_transform_last_hour as `Bytes(Last hour - KB)`, extension.keyword as `Type`\n";
+//# sourceMappingURL=fixtures.d.ts.map

package/lib/pretty_print/__tests__/fixtures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../../src/pretty_print/__tests__/fixtures.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,MAAM,uZAIlB,CAAC;AAEF,eAAO,MAAM,MAAM,07CAelB,CAAC;AAEF,eAAO,MAAM,MAAM,2uCAclB,CAAC;AAEF,eAAO,MAAM,MAAM,kqDAkBlB,CAAC"}

package/lib/pretty_print/basic_pretty_printer.d.ts

@@ -0,0 +1,87 @@
+import type { ESQLAstExpressionNode } from '../ast/visitor/types';
+import { Visitor } from '../ast/visitor';
+import type { ESQLAstBaseItem, ESQLAstCommand, ESQLAstQueryExpression, ESQLMap, ESQLProperNode } from '../types';
+export interface BasicPrettyPrinterOptions {
+    /**
+     * Whether to break the query into multiple lines on each pipe. Defaults to
+     * `false`.
+     */
+    multiline?: boolean;
+    /**
+     * Tabbing string inserted before a pipe, when `multiline` is `true`. Defaults
+     * to two spaces.
+     */
+    pipeTab?: string;
+    /**
+     * Whether to skip printing header commands (e.g., SET instructions).
+     *
+     * @default false
+     */
+    skipHeader?: boolean;
+    /**
+     * The default lowercase setting to use for all options. Defaults to `false`.
+     */
+    lowercase?: boolean;
+    /**
+     * Whether to lowercase command names. Defaults to `false`.
+     */
+    lowercaseCommands?: boolean;
+    /**
+     * Whether to lowercase command options. Defaults to `false`.
+     */
+    lowercaseOptions?: boolean;
+    /**
+     * Whether to lowercase function names. Defaults to `false`.
+     */
+    lowercaseFunctions?: boolean;
+    /**
+     * Whether to lowercase keywords. Defaults to `false`.
+     */
+    lowercaseKeywords?: boolean;
+    /**
+     * Map representation to use if cannot be determined from parent context.
+     */
+    mapRepresentation?: ESQLMap['representation'];
+}
+export type BasicPrettyPrinterMultilineOptions = Omit<BasicPrettyPrinterOptions, 'multiline'>;
+export declare class BasicPrettyPrinter {
+    /**
+     * @param query ES|QL query AST to print.
+     * @returns A single-line string representation of the query.
+     */
+    static readonly print: (node: ESQLProperNode, opts?: BasicPrettyPrinterOptions) => string;
+    /**
+     * Print a query with each command on a separate line. It is also possible to
+     * specify a tabbing option for the pipe character.
+     *
+     * @param query ES|QL query AST to print.
+     * @param opts Options for pretty-printing.
+     * @returns A multi-line string representation of the query.
+     */
+    static readonly multiline: (query: ESQLAstQueryExpression, opts?: BasicPrettyPrinterMultilineOptions) => string;
+    /**
+     * @param query ES|QL query AST to print.
+     * @returns A single-line string representation of the query.
+     */
+    static readonly query: (query: ESQLAstQueryExpression, opts?: BasicPrettyPrinterOptions) => string;
+    /**
+     * @param command ES|QL command AST node to print.
+     * @returns Prints a single-line string representation of the command.
+     */
+    static readonly command: (command: ESQLAstCommand, opts?: BasicPrettyPrinterOptions) => string;
+    /**
+     * @param expression ES|QL expression AST node to print.
+     * @returns Prints a single-line string representation of the expression.
+     */
+    static readonly expression: (expression: ESQLAstExpressionNode, opts?: BasicPrettyPrinterOptions) => string;
+    protected readonly opts: Required<BasicPrettyPrinterOptions>;
+    constructor(opts?: BasicPrettyPrinterOptions);
+    protected keyword(word: string): string;
+    protected decorateWithComments(node: ESQLAstBaseItem, formatted: string): string;
+    protected simplifyMultiplicationByOne(node: ESQLAstExpressionNode, minusCount?: number): string | undefined;
+    protected readonly visitor: Visitor;
+    print(query: ESQLAstQueryExpression): any;
+    printCommand(command: ESQLAstCommand): any;
+    printExpression(expression: ESQLAstExpressionNode): any;
+}
+//# sourceMappingURL=basic_pretty_printer.d.ts.map

package/lib/pretty_print/basic_pretty_printer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic_pretty_printer.d.ts","sourceRoot":"","sources":["../../src/pretty_print/basic_pretty_printer.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAQzC,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EAEd,sBAAsB,EACtB,OAAO,EACP,cAAc,EACf,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC/C;AAED,MAAM,MAAM,kCAAkC,GAAG,IAAI,CAAC,yBAAyB,EAAE,WAAW,CAAC,CAAC;AAE9F,qBAAa,kBAAkB;IAC7B;;;OAGG;IACH,gBAAuB,KAAK,GAC1B,MAAM,cAAc,EACpB,OAAO,yBAAyB,KAC/B,MAAM,CAQP;IAEF;;;;;;;OAOG;IACH,gBAAuB,SAAS,GAC9B,OAAO,sBAAsB,EAC7B,OAAO,kCAAkC,KACxC,MAAM,CAAkE;IAE3E;;;OAGG;IACH,gBAAuB,KAAK,GAC1B,OAAO,sBAAsB,EAC7B,OAAO,yBAAyB,KAC/B,MAAM,CAGP;IAEF;;;OAGG;IACH,gBAAuB,OAAO,GAC5B,SAAS,cAAc,EACvB,OAAO,yBAAyB,KAC/B,MAAM,CAGP;IAEF;;;OAGG;IACH,gBAAuB,UAAU,GAC/B,YAAY,qBAAqB,EACjC,OAAO,yBAAyB,KAC/B,MAAM,CAGP;IAEF,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;gBAEjD,IAAI,GAAE,yBAA8B;IAchD,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM;IAM9B,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IA0BhF,SAAS,CAAC,2BAA2B,CACnC,IAAI,EAAE,qBAAqB,EAC3B,UAAU,GAAE,MAAU,GACrB,MAAM,GAAG,SAAS;IAqDrB,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CA4WR;IAEpB,KAAK,CAAC,KAAK,EAAE,sBAAsB;IAInC,YAAY,CAAC,OAAO,EAAE,cAAc;IAIpC,eAAe,CAAC,UAAU,EAAE,qBAAqB;CAGzD"}

package/lib/pretty_print/constants.d.ts

@@ -0,0 +1,47 @@
+/**
+ * This set tracks commands that don't use commas to separate their
+ * arguments.
+ *
+ * Normally ES|QL command arguments are separated by commas.
+ *
+ * ```
+ * COMMAND arg1, arg2, arg3
+ * ```
+ *
+ * But there are some commands (namely `dissect`) which don't
+ * use commas to separate their arguments.
+ *
+ * ```
+ * DISSECT input "pattern"
+ * GROK input "pattern1", "pattern2", "pattern3"
+ * ```
+ */
+export declare const commandsWithNoCommaArgSeparator: Set<string>;
+export declare const commandsWithSpecialCommaRules: Map<string, (argIndex: number) => boolean>;
+/**
+ * This set tracks command options which use an equals sign to separate
+ * the option label from the option value.
+ *
+ * Most ES|QL commands use a space to separate the option label from the
+ * option value.
+ *
+ * ```
+ * COMMAND arg1, arg2, arg3 OPTION option
+ * FROM index METADATA _id
+ *                    |
+ *                    |
+ *                    space
+ * ```
+ *
+ * However, the `APPEND_SEPARATOR` in the `DISSECT` command uses an equals
+ * sign to separate the option label from the option value.
+ *
+ * ```
+ * DISSECT input "pattern" APPEND_SEPARATOR = "separator"
+ *                                          |
+ *                                          |
+ *                                          equals sign
+ * ```
+ */
+export declare const commandOptionsWithEqualsSeparator: Set<string>;
+//# sourceMappingURL=constants.d.ts.map

package/lib/pretty_print/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/pretty_print/constants.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,+BAA+B,aAAmD,CAAC;AAEhG,eAAO,MAAM,6BAA6B,yBAA8B,MAAM,KAAK,OAAO,CAExF,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,iCAAiC,aAAgC,CAAC"}

package/lib/pretty_print/helpers.d.ts

@@ -0,0 +1,22 @@
+import type { ESQLAstBaseItem } from '../types';
+import { type WalkerAstNode } from '../ast/walker';
+export interface QueryPrettyPrintStats {
+    /**
+     * `true` if the given AST has a line breaking decoration. A line breaking
+     * decoration is any decoration that requires a newline "\n" to be printed.
+     */
+    hasLineBreakingDecorations: boolean;
+    /**
+     * Whether the given AST has at least one single line comment to the right of
+     * some node.
+     */
+    hasRightSingleLineComments: boolean;
+}
+/**
+ * Walks once the given AST sub-tree and computes the pretty print stats.
+ *
+ * @param ast The part to compute the stats for.
+ */
+export declare const getPrettyPrintStats: (ast: WalkerAstNode) => QueryPrettyPrintStats;
+export declare const hasLineBreakingDecoration: (node: ESQLAstBaseItem) => boolean;
+//# sourceMappingURL=helpers.d.ts.map

package/lib/pretty_print/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/pretty_print/helpers.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAU,KAAK,aAAa,EAAE,MAAM,eAAe,CAAC;AAE3D,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;;OAGG;IACH,0BAA0B,EAAE,OAAO,CAAC;CACrC;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,KAAK,aAAa,KAAG,qBAkBxD,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAAI,MAAM,eAAe,KAAG,OA2BjE,CAAC"}

package/lib/pretty_print/index.d.ts

@@ -0,0 +1,4 @@
+export { LeafPrinter } from './leaf_printer';
+export { BasicPrettyPrinter, type BasicPrettyPrinterOptions, type BasicPrettyPrinterMultilineOptions, } from './basic_pretty_printer';
+export { WrappingPrettyPrinter, type WrappingPrettyPrinterOptions, } from './wrapping_pretty_printer';
+//# sourceMappingURL=index.d.ts.map

package/lib/pretty_print/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/pretty_print/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,EAC9B,KAAK,kCAAkC,GACxC,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EACL,qBAAqB,EACrB,KAAK,4BAA4B,GAClC,MAAM,2BAA2B,CAAC"}

package/lib/pretty_print/leaf_printer.d.ts

@@ -0,0 +1,19 @@
+import type { ESQLAstComment, ESQLAstCommentMultiLine, ESQLColumn, ESQLDatePeriodLiteral, ESQLIdentifier, ESQLLiteral, ESQLParamLiteral, ESQLProperNode, ESQLSource, ESQLStringLiteral, ESQLTimeDurationLiteral } from '../types';
+/**
+ * Printer for leaf AST nodes. The printing output of these nodes should
+ * typically not depend on word wrapping settings, should always return an
+ * atomic short string.
+ */
+export declare const LeafPrinter: {
+    source: (node: ESQLSource) => string;
+    identifier: (node: ESQLIdentifier) => string;
+    column: (node: ESQLColumn) => string;
+    string: (node: Pick<ESQLStringLiteral, "valueUnquoted" | "unquoted">) => string;
+    literal: (node: ESQLLiteral) => string;
+    param: (node: ESQLParamLiteral) => string;
+    timespan: (node: ESQLTimeDurationLiteral | ESQLDatePeriodLiteral) => string;
+    comment: (node: ESQLAstComment) => string;
+    commentList: (comments: ESQLAstCommentMultiLine[]) => string;
+    print: (node: ESQLProperNode | ESQLAstComment) => string;
+};
+//# sourceMappingURL=leaf_printer.d.ts.map

package/lib/pretty_print/leaf_printer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"leaf_printer.d.ts","sourceRoot":"","sources":["../../src/pretty_print/leaf_printer.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACvB,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,WAAW,EAEX,gBAAgB,EAChB,cAAc,EACd,UAAU,EACV,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,UAAU,CAAC;AAIlB;;;;GAIG;AACH,eAAO,MAAM,WAAW;mBACP,UAAU,KAAG,MAAM;uBAcf,cAAc;mBAelB,UAAU;mBAeV,IAAI,CAAC,iBAAiB,EAAE,eAAe,GAAG,UAAU,CAAC;oBAoBpD,WAAW;kBAiCb,gBAAgB;qBAYb,uBAAuB,GAAG,qBAAqB;oBAUhD,cAAc,KAAG,MAAM;4BAcf,uBAAuB,EAAE,KAAG,MAAM;kBAS5C,cAAc,GAAG,cAAc,KAAG,MAAM;CAoBvD,CAAC"}

package/lib/pretty_print/utils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Lazily retrieves a set of keywords that should be quoted in ESQL.
+ *
+ * @returns Set of keywords that should be quoted in ESQL.
+ */
+export declare const quotableKeywords: () => Set<string>;
+//# sourceMappingURL=utils.d.ts.map

package/lib/pretty_print/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/pretty_print/utils.ts"],"names":[],"mappings":"AAWA;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAAO,GAAG,CAAC,MAAM,CA6B7C,CAAC"}