@gooddata/sdk-maql-language-server 0.0.0-stage → 11.65.0-alpha.3

package/esm/parseMaql.d.ts

@@ -0,0 +1,43 @@
+import { type ANTLRErrorListener, type ANTLRErrorStrategy, CommonTokenStream, type ParserRuleContext, type Token } from "antlr4ts";
+import { type AstNode, type MaqlLexer as MaqlLexerType, type MaqlParser as MaqlParserType } from "@gooddata/maql-antlr4ts";
+/**
+ * Class holding different representations of a MAQL query
+ * Raw string, ANTLR4 classes (Lexer, TokenStream, Parser, parse tree), abstract syntax tree (AST)
+ */
+declare class MaqlQuery {
+    readonly raw: string;
+    get lexer(): MaqlLexerType;
+    get tokenStream(): CommonTokenStream;
+    get parser(): MaqlParserType;
+    get tree(): ParserRuleContext;
+    get ast(): AstNode;
+    private readonly _lexer;
+    private readonly _tokenStream;
+    private readonly _parser;
+    private _tree;
+    private _ast;
+    constructor(raw: string);
+    addErrorListener(listener: ANTLRErrorListener<Token>): this;
+    removeErrorListeners(): this;
+    setErrorHandler(errorHandler: ANTLRErrorStrategy): this;
+    private notifyChangedConfiguration;
+}
+/**
+ * Class holding different representations of a MAQL metric
+ * Used for convenience, adds the string "parse metric\\n" to the beginning of the metric so
+ * that it is a valid MAQL query.
+ */
+export declare class MaqlMetric extends MaqlQuery {
+    private static readonly prefix;
+    static offset(offset: number): number;
+    /** Inverse of {@link MaqlMetric.offset}: a parser offset back into the metric's own text. */
+    static rawOffset(parserOffset: number): number;
+    constructor(raw: string, addDefaultErrorListener?: boolean);
+    get length(): number;
+}
+/**
+ * Get the first token ID matching a given string `name`
+ */
+export declare function getTokenIdFromName(name: string): number;
+export {};
+//# sourceMappingURL=parseMaql.d.ts.map

package/esm/parseMaql.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseMaql.d.ts","sourceRoot":"","sources":["../src/parseMaql.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,KAAK,EACb,MAAM,UAAU,CAAC;AAElB,OAAgB,EACZ,KAAK,OAAO,EACZ,KAAK,SAAS,IAAI,aAAa,EAC/B,KAAK,UAAU,IAAI,cAAc,EACpC,MAAM,yBAAyB,CAAC;AAGjC;;;GAGG;AACH,cAAM,SAAS;IAqCC,QAAQ,CAAC,GAAG,EAAE,MAAM;IApChC,IAAI,KAAK,IAAI,aAAa,CAGzB;IAED,IAAI,WAAW,IAAI,iBAAiB,CAGnC;IAED,IAAI,MAAM,IAAI,cAAc,CAG3B;IAED,IAAI,IAAI,IAAI,iBAAiB,CAK5B;IAED,IAAI,GAAG,IAAI,OAAO,CAMjB;IAED,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IACvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAoB;IACjD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,KAAK,CAAgC;IAC7C,OAAO,CAAC,IAAI,CAAsB;IAElC,YAAqB,GAAG,EAAE,MAAM,EAK/B;IAED,gBAAgB,CAAC,QAAQ,EAAE,kBAAkB,CAAC,KAAK,CAAC,GAAG,IAAI,CAI1D;IAED,oBAAoB,IAAI,IAAI,CAI3B;IAED,eAAe,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI,CAItD;IAED,OAAO,CAAC,0BAA0B;CAIrC;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,SAAS;IACrC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAA4B;IAE1D,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpC;IAED,6FAA6F;IAC7F,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAE7C;IAED,YAAY,GAAG,EAAE,MAAM,EAAE,uBAAuB,UAAQ,EAKvD;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;CACJ;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEvD"}

package/esm/parseMaql.js

@@ -0,0 +1,97 @@
+// (C) 2022-2026 GoodData Corporation
+import { CommonTokenStream, } from "antlr4ts";
+import MaqlPkg from "@gooddata/maql-antlr4ts";
+const { CaseInsensitiveCharStream, MaqlAstVisitor, MaqlLexer, MaqlParser } = MaqlPkg;
+/**
+ * Class holding different representations of a MAQL query
+ * Raw string, ANTLR4 classes (Lexer, TokenStream, Parser, parse tree), abstract syntax tree (AST)
+ */
+class MaqlQuery {
+    raw;
+    get lexer() {
+        this._lexer.reset();
+        return this._lexer;
+    }
+    get tokenStream() {
+        this._tokenStream.fill();
+        return this._tokenStream;
+    }
+    get parser() {
+        this._parser.reset();
+        return this._parser;
+    }
+    get tree() {
+        if (!this._tree) {
+            this._tree = this.parser.maql();
+        }
+        return this._tree;
+    }
+    get ast() {
+        if (!this._ast) {
+            const maqlAstVisitor = new MaqlAstVisitor("", this.tokenStream);
+            this._ast = maqlAstVisitor.visit(this.tree);
+        }
+        return this._ast;
+    }
+    _lexer;
+    _tokenStream;
+    _parser;
+    _tree;
+    _ast;
+    constructor(raw) {
+        this.raw = raw;
+        const charStream = new CaseInsensitiveCharStream(raw);
+        this._lexer = new MaqlLexer(charStream);
+        this._tokenStream = new CommonTokenStream(this._lexer);
+        this._parser = new MaqlParser(this._tokenStream);
+    }
+    addErrorListener(listener) {
+        this._parser.addErrorListener(listener);
+        this.notifyChangedConfiguration();
+        return this;
+    }
+    removeErrorListeners() {
+        this._parser.removeErrorListeners();
+        this.notifyChangedConfiguration();
+        return this;
+    }
+    setErrorHandler(errorHandler) {
+        this._parser.errorHandler = errorHandler;
+        this.notifyChangedConfiguration();
+        return this;
+    }
+    notifyChangedConfiguration() {
+        this._tree = undefined;
+        this._ast = undefined;
+    }
+}
+/**
+ * Class holding different representations of a MAQL metric
+ * Used for convenience, adds the string "parse metric\\n" to the beginning of the metric so
+ * that it is a valid MAQL query.
+ */
+export class MaqlMetric extends MaqlQuery {
+    static prefix = "parse metric\n";
+    static offset(offset) {
+        return MaqlMetric.prefix.length + offset;
+    }
+    /** Inverse of {@link MaqlMetric.offset}: a parser offset back into the metric's own text. */
+    static rawOffset(parserOffset) {
+        return parserOffset - MaqlMetric.prefix.length;
+    }
+    constructor(raw, addDefaultErrorListener = false) {
+        super(MaqlMetric.prefix + raw);
+        if (!addDefaultErrorListener) {
+            super.removeErrorListeners();
+        }
+    }
+    get length() {
+        return this.raw.length - MaqlMetric.prefix.length;
+    }
+}
+/**
+ * Get the first token ID matching a given string `name`
+ */
+export function getTokenIdFromName(name) {
+    return new MaqlLexer(new CaseInsensitiveCharStream(name)).nextToken().type;
+}

package/esm/renderParameters.d.ts

@@ -0,0 +1,33 @@
+import { type LdmObjects } from "./metadata/model.js";
+/**
+ * A MAQL template rendered with its parameters' defaults. `unresolved` lists the ids of references
+ * that could not be turned into a literal; those are left untouched in `maql`.
+ */
+export interface IRenderedMaql {
+    maql: string;
+    unresolved: string[];
+}
+/**
+ * Replaces every `{parameter/id}` reference in `maql` with its default value, so the template can be
+ * previewed as the MAQL that would actually execute. String defaults are rendered as quoted literals
+ * and numeric ones bare. Unresolvable references are reported and left in place rather than guessed.
+ *
+ * Returns undefined when the template references no parameter at all.
+ */
+export declare function renderParameterDefaults(maql: string, ldmObjects: LdmObjects): IRenderedMaql | undefined;
+/**
+ * A parameter resolved to its default value. `value` is absent when the default cannot be
+ * determined; `title` is absent when the parameter is unknown.
+ */
+export interface IResolvedParameter {
+    id: string;
+    title?: string;
+    value?: string | number;
+}
+/**
+ * Resolves every parameter the given MAQL templates and metrics depend on to its default value,
+ * following `{metric/id}` references into metric expressions. Each parameter is reported once, in
+ * order of first appearance.
+ */
+export declare function resolveParameterValues(maqls: string[], metricIds: string[], ldmObjects: LdmObjects): IResolvedParameter[];
+//# sourceMappingURL=renderParameters.d.ts.map

package/esm/renderParameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderParameters.d.ts","sourceRoot":"","sources":["../src/renderParameters.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,UAAU,EAAqB,MAAM,qBAAqB,CAAC;AAIzE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,aAAa,GAAG,SAAS,CAyBvG;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAClC,KAAK,EAAE,MAAM,EAAE,EACf,SAAS,EAAE,MAAM,EAAE,EACnB,UAAU,EAAE,UAAU,GACvB,kBAAkB,EAAE,CA6BtB"}

package/esm/renderParameters.js

@@ -0,0 +1,72 @@
+// (C) 2026 GoodData Corporation
+import { findAllObjects } from "./findObjects.js";
+import { isITigerParameter } from "./metadata/model.js";
+import { isRenderableDefinition, parameterMaqlLiteral } from "./metadata/parameters.js";
+import { MaqlMetric } from "./parseMaql.js";
+/**
+ * Replaces every `{parameter/id}` reference in `maql` with its default value, so the template can be
+ * previewed as the MAQL that would actually execute. String defaults are rendered as quoted literals
+ * and numeric ones bare. Unresolvable references are reported and left in place rather than guessed.
+ *
+ * Returns undefined when the template references no parameter at all.
+ */
+export function renderParameterDefaults(maql, ldmObjects) {
+    const parameters = findAllObjects(new MaqlMetric(maql)).filter((object) => object.tigerType === "parameter");
+    if (parameters.length === 0) {
+        return undefined;
+    }
+    const unresolved = [];
+    let rendered = "";
+    let cursor = 0;
+    for (const parameter of parameters) {
+        const found = ldmObjects.findObject(parameter);
+        if (!found || !isITigerParameter(found) || !isRenderableDefinition(found.definition)) {
+            unresolved.push(parameter.id);
+            continue;
+        }
+        rendered += maql.slice(cursor, parameter.offsets.start) + parameterMaqlLiteral(found.definition);
+        cursor = parameter.offsets.end;
+    }
+    return { maql: rendered + maql.slice(cursor), unresolved };
+}
+/**
+ * Resolves every parameter the given MAQL templates and metrics depend on to its default value,
+ * following `{metric/id}` references into metric expressions. Each parameter is reported once, in
+ * order of first appearance.
+ */
+export function resolveParameterValues(maqls, metricIds, ldmObjects) {
+    const parameters = new Map();
+    const visitedMetrics = new Set();
+    const visitTemplate = (template) => {
+        for (const object of findAllObjects(new MaqlMetric(template))) {
+            if (object.tigerType === "parameter" && !parameters.has(object.id)) {
+                parameters.set(object.id, resolveParameter(object.id, ldmObjects));
+            }
+            if (object.tigerType === "metric") {
+                visitMetric(object.id);
+            }
+        }
+    };
+    const visitMetric = (metricId) => {
+        if (visitedMetrics.has(metricId)) {
+            return;
+        }
+        visitedMetrics.add(metricId);
+        const expression = ldmObjects.findById("metric", metricId)?.expression;
+        if (expression) {
+            visitTemplate(expression);
+        }
+    };
+    maqls.forEach(visitTemplate);
+    metricIds.forEach(visitMetric);
+    return [...parameters.values()];
+}
+function resolveParameter(id, ldmObjects) {
+    const found = ldmObjects.findById("parameter", id);
+    if (!found) {
+        return { id };
+    }
+    return isRenderableDefinition(found.definition)
+        ? { id, title: found.title, value: found.definition.defaultValue }
+        : { id, title: found.title };
+}

package/esm/tests/metadata.test.helpers.d.ts

@@ -0,0 +1,8 @@
+import { type IAttributeElement } from "@gooddata/sdk-model";
+import { type LabelElementsFunc, LdmObjects } from "../metadata/model.js";
+export declare const ldmObjects: LdmObjects;
+export declare const slicedLdmObjects: LdmObjects;
+export declare const labelElementsFunction: LabelElementsFunc;
+export declare const mockLabelElements: Map<string, IAttributeElement[]>;
+export declare const docs: (resolveTag: string) => Promise<string | undefined>;
+//# sourceMappingURL=metadata.test.helpers.d.ts.map

package/esm/tests/metadata.test.helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.test.helpers.d.ts","sourceRoot":"","sources":["../../src/tests/metadata.test.helpers.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,iBAAiB,EAAmB,MAAM,qBAAqB,CAAC;AAG9E,OAAO,EAGH,KAAK,iBAAiB,EACtB,UAAU,EACb,MAAM,sBAAsB,CAAC;AAE9B,eAAO,MAAM,UAAU,EAAE,UA2QxB,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,UAmJ9B,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,iBAkCnC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,CAoB7D,CAAC;AAUH,eAAO,MAAM,IAAI,eAAgB,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAInE,CAAC"}