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

package/esm/tests/metadata.test.helpers.js

@@ -0,0 +1,468 @@
+// (C) 2021-2026 GoodData Corporation
+import { tigerIdTypeToObjectType } from "@gooddata/sdk-backend-tiger";
+import { serializeObjRef } from "@gooddata/sdk-model";
+import { docsIndex } from "../docs/index.js";
+import { LdmObjects, } from "../metadata/model.js";
+export const ldmObjects = new LdmObjects([
+    {
+        type: "attribute",
+        attribute: {
+            type: "attribute",
+            id: "3",
+            title: "attribute title",
+            description: "attribute description",
+            production: false,
+            deprecated: false,
+            unlisted: false,
+            uri: "",
+            ref: {
+                type: "attribute",
+                identifier: "3",
+            },
+            displayForms: [],
+        },
+        groups: [],
+        displayForms: [
+            {
+                attribute: {
+                    type: "attribute",
+                    identifier: "3",
+                },
+                type: "displayForm",
+                id: "4",
+                title: "label title",
+                description: "label description",
+                production: false,
+                deprecated: false,
+                unlisted: false,
+                uri: "",
+                ref: {
+                    type: "displayForm",
+                    identifier: "4",
+                },
+            },
+        ],
+        defaultDisplayForm: {
+            attribute: {
+                type: "attribute",
+                identifier: "3",
+            },
+            type: "displayForm",
+            id: "4",
+            title: "label title",
+            description: "label description",
+            production: false,
+            deprecated: false,
+            unlisted: false,
+            uri: "",
+            ref: {
+                type: "displayForm",
+                identifier: "4",
+            },
+        },
+        geoPinDisplayForms: [],
+    },
+], [
+    {
+        type: "fact",
+        fact: {
+            type: "fact",
+            id: "1",
+            title: "fact title",
+            description: "fact description",
+            production: false,
+            deprecated: false,
+            unlisted: false,
+            uri: "",
+            ref: {
+                type: "fact",
+                identifier: "1",
+            },
+        },
+        groups: [],
+    },
+    {
+        type: "fact",
+        fact: {
+            type: "fact",
+            id: "2",
+            title: "fact 2 title",
+            description: "fact to be sliced",
+            production: false,
+            deprecated: false,
+            unlisted: false,
+            uri: "",
+            ref: {
+                type: "fact",
+                identifier: "2",
+            },
+        },
+        groups: [],
+    },
+], [
+    {
+        type: "measure",
+        measure: {
+            type: "measure",
+            id: "2",
+            title: "measure title",
+            description: "measure description",
+            expression: "SELECT SUM({fact/1})",
+            format: "",
+            production: false,
+            deprecated: false,
+            unlisted: false,
+            uri: "",
+            ref: {
+                type: "measure",
+                identifier: "2",
+            },
+        },
+        groups: [],
+    },
+], [
+    {
+        type: "parameter",
+        id: "topN",
+        title: "Top N",
+        description: "Top N parameter",
+        definition: {
+            type: "NUMBER",
+            defaultValue: 10,
+        },
+        production: false,
+        deprecated: false,
+        unlisted: false,
+        uri: "",
+        ref: {
+            type: "parameter",
+            identifier: "topN",
+        },
+    },
+    {
+        type: "parameter",
+        id: "scenario",
+        title: "Scenario",
+        description: "Scenario parameter",
+        definition: {
+            type: "STRING",
+            defaultValue: "actual",
+            constraints: {
+                allowedValues: [
+                    { value: "actual" },
+                    { value: "budget", title: "Budget" },
+                    { value: "forecast" },
+                ],
+            },
+        },
+        production: false,
+        deprecated: false,
+        unlisted: false,
+        uri: "",
+        ref: {
+            type: "parameter",
+            identifier: "scenario",
+        },
+    },
+    {
+        type: "parameter",
+        id: "freetext",
+        title: "Free text",
+        description: "Free text parameter",
+        definition: {
+            type: "STRING",
+            defaultValue: "x",
+        },
+        production: false,
+        deprecated: false,
+        unlisted: false,
+        uri: "",
+        ref: {
+            type: "parameter",
+            identifier: "freetext",
+        },
+    },
+], [
+    {
+        type: "dateDataset",
+        relevance: 0,
+        dataSet: {
+            type: "dataSet",
+            ref: {
+                identifier: "date",
+                type: "dataSet",
+            },
+            id: "date",
+            title: "Date",
+            description: "",
+            uri: "",
+            deprecated: false,
+            production: true,
+            unlisted: false,
+        },
+        dateAttributes: [
+            {
+                granularity: "GDC.time.year",
+                attribute: {
+                    type: "attribute",
+                    ref: {
+                        identifier: "date.year",
+                        type: "attribute",
+                    },
+                    id: "date.year",
+                    uri: "",
+                    title: "Date - Year",
+                    description: "Year",
+                    deprecated: false,
+                    production: true,
+                    unlisted: false,
+                    displayForms: [
+                        {
+                            type: "displayForm",
+                            attribute: {
+                                type: "attribute",
+                                identifier: "date.year",
+                            },
+                            ref: {
+                                identifier: "date.year",
+                                type: "displayForm",
+                            },
+                            id: "date.year",
+                            uri: "",
+                            title: "Date - Year",
+                            description: "Year",
+                            deprecated: false,
+                            production: true,
+                            unlisted: false,
+                        },
+                    ],
+                },
+                defaultDisplayForm: {
+                    type: "displayForm",
+                    attribute: {
+                        type: "attribute",
+                        identifier: "date.year",
+                    },
+                    ref: {
+                        identifier: "date.year",
+                        type: "displayForm",
+                    },
+                    id: "date.year",
+                    uri: "",
+                    title: "Date - Year",
+                    description: "Year",
+                    deprecated: false,
+                    production: true,
+                    unlisted: false,
+                },
+            },
+        ],
+    },
+], [
+    {
+        id: "dataset",
+        title: "Dataset",
+    },
+]);
+export const slicedLdmObjects = new LdmObjects([], [
+    {
+        type: "fact",
+        fact: {
+            type: "fact",
+            id: "1",
+            title: "fact title",
+            description: "fact description",
+            production: false,
+            deprecated: false,
+            unlisted: false,
+            uri: "",
+            ref: {
+                type: "fact",
+                identifier: "1",
+            },
+        },
+        groups: [],
+    },
+], [
+    {
+        type: "measure",
+        measure: {
+            type: "measure",
+            id: "2",
+            title: "measure title",
+            description: "measure description",
+            expression: "SELECT SUM({fact/1})",
+            format: "",
+            production: false,
+            deprecated: false,
+            unlisted: false,
+            uri: "",
+            ref: {
+                type: "measure",
+                identifier: "2",
+            },
+        },
+        groups: [],
+    },
+], [
+    {
+        type: "parameter",
+        id: "topN",
+        title: "Top N",
+        description: "Top N parameter",
+        definition: {
+            type: "NUMBER",
+            defaultValue: 10,
+        },
+        production: false,
+        deprecated: false,
+        unlisted: false,
+        uri: "",
+        ref: {
+            type: "parameter",
+            identifier: "topN",
+        },
+    },
+], [
+    {
+        type: "dateDataset",
+        relevance: 0,
+        dataSet: {
+            type: "dataSet",
+            ref: {
+                identifier: "date",
+                type: "dataSet",
+            },
+            id: "date",
+            title: "Date",
+            description: "",
+            uri: "",
+            deprecated: false,
+            production: true,
+            unlisted: false,
+        },
+        dateAttributes: [
+            {
+                granularity: "GDC.time.year",
+                attribute: {
+                    type: "attribute",
+                    ref: {
+                        identifier: "date.year",
+                        type: "attribute",
+                    },
+                    id: "date.year",
+                    uri: "",
+                    title: "Date - Year",
+                    description: "Year",
+                    deprecated: false,
+                    production: true,
+                    unlisted: false,
+                    displayForms: [
+                        {
+                            type: "displayForm",
+                            attribute: {
+                                type: "attribute",
+                                identifier: "date.year",
+                            },
+                            ref: {
+                                identifier: "date.year",
+                                type: "displayForm",
+                            },
+                            id: "date.year",
+                            uri: "",
+                            title: "Date - Year",
+                            description: "Year",
+                            deprecated: false,
+                            production: true,
+                            unlisted: false,
+                        },
+                    ],
+                },
+                defaultDisplayForm: {
+                    type: "displayForm",
+                    attribute: {
+                        type: "attribute",
+                        identifier: "date.year",
+                    },
+                    ref: {
+                        identifier: "date.year",
+                        type: "displayForm",
+                    },
+                    id: "date.year",
+                    uri: "",
+                    title: "Date - Year",
+                    description: "Year",
+                    deprecated: false,
+                    production: true,
+                    unlisted: false,
+                },
+            },
+        ],
+    },
+], [
+    {
+        id: "dataset",
+        title: "Dataset",
+    },
+]);
+export const labelElementsFunction = function (labels, excluded, options) {
+    const rejected = [];
+    const elements = labels
+        .map((label) => {
+        const els = mockLabelElements.get(serializeObjRef(label.ref));
+        if (!els) {
+            rejected.push(label);
+            return [];
+        }
+        return els;
+    })
+        .flat()
+        .filter((element) => 
+    // simulates SQL LIKE operator
+    element.title && options.filter
+        ? new RegExp(`.*${options.filter.toLowerCase()}.*`).test(element.title.toLowerCase())
+        : true)
+        .filter((element) => {
+        const els = options.elements;
+        return els?.values?.includes(element.uri) ?? true;
+    })
+        .filter((element) => element.title === null || !excluded.includes(element.title));
+    return Promise.resolve({
+        list: {
+            elements,
+            isIncomplete: false,
+        },
+        rejected: rejected,
+    });
+};
+export const mockLabelElements = new Map([
+    [
+        serializeObjRef({ type: tigerIdTypeToObjectType["label"], identifier: "4" }),
+        [
+            labelElement("Apricot"),
+            labelElement("Banana"),
+            labelElement("Coconut"),
+            labelElement("Cockatrice"),
+            labelElement("Date"),
+            labelElement("Locomotive"),
+        ],
+    ],
+    [
+        serializeObjRef({ type: tigerIdTypeToObjectType["label"], identifier: "special" }),
+        [
+            labelElement('hello "example" world'),
+            labelElement("goodbye\nworld"),
+            labelElement('Middle-quoted\\"title'),
+        ],
+    ],
+]);
+function labelElement(title, uri) {
+    return {
+        title: title,
+        uri: uri ?? title,
+    };
+}
+const locale = "en-us";
+export const docs = (resolveTag) => {
+    return Promise.resolve(docsIndex[locale][resolveTag]);
+};

package/esm/tokenRanges.d.ts

@@ -0,0 +1,36 @@
+import { type Token } from "antlr4ts";
+import { type Range } from "vscode-languageserver";
+import { type IRange } from "@gooddata/maql-antlr4ts";
+import { type ITigerMetadataObject, type ITigerMetadataObjectStub } from "./metadata/model.js";
+export type MetadataObjectAndRange = ITigerMetadataObject & {
+    range: Range;
+};
+export interface IOperand {
+    readonly range: AntlrRange;
+}
+export interface IMaqlObject extends IOperand, ITigerMetadataObjectStub {
+    readonly actualType: string;
+}
+export interface IMaqlString extends IOperand {
+    readonly string: string;
+}
+export interface IMaqlTimeMacro extends IOperand {
+    readonly transformationFunction: string;
+    readonly granularity: string;
+}
+export declare function isMaqlObject(obj: IOperand): obj is IMaqlObject;
+export declare function isMaqlString(obj: IOperand): obj is IMaqlString;
+export declare function isMaqlTimeMacro(obj: IOperand): obj is IMaqlTimeMacro;
+export declare function tokenRange(token: Token): Range;
+export declare function defaultRange(line: number, character: number, endLine?: number, endCharacter?: number): Range;
+export declare function antlrContextRange(start: Token, stop?: Token): AntlrRange;
+export declare class AntlrRange {
+    readonly startLine: number;
+    readonly startCharacter: number;
+    readonly endLine: number;
+    readonly endCharacter: number;
+    constructor(startLine: number, startCharacter: number, endLine?: number, endCharacter?: number);
+    static fromAstRange(astRange: IRange): AntlrRange;
+    toRange(): Range;
+}
+//# sourceMappingURL=tokenRanges.d.ts.map

package/esm/tokenRanges.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenRanges.d.ts","sourceRoot":"","sources":["../src/tokenRanges.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EAAE,KAAK,oBAAoB,EAAE,KAAK,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAE/F,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAE7E,MAAM,WAAW,QAAQ;IACrB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC9B;AACD,MAAM,WAAW,WAAY,SAAQ,QAAQ,EAAE,wBAAwB;IACnE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,WAAY,SAAQ,QAAQ;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC5C,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAChC;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,QAAQ,GAAG,GAAG,IAAI,WAAW,CAE9D;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,QAAQ,GAAG,GAAG,IAAI,WAAW,CAE9D;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,QAAQ,GAAG,GAAG,IAAI,cAAc,CAEpE;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAY9C;AAED,wBAAgB,YAAY,CACxB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,MAAa,EACtB,YAAY,GAAE,MAAkB,GACjC,KAAK,CASP;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,GAAE,KAAa,GAAG,UAAU,CAO/E;AAED,qBAAa,UAAU;IAEf,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,cAAc,EAAE,MAAM;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM;IACxB,QAAQ,CAAC,YAAY,EAAE,MAAM;IAJjC,YACa,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,EACtB,OAAO,GAAE,MAAkB,EAC3B,YAAY,GAAE,MAAuB,EAC9C;IAEJ,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,cAOnC;IAED,OAAO,IAAI,KAAK,CAEf;CACJ"}

package/esm/tokenRanges.js

@@ -0,0 +1,54 @@
+// (C) 2021-2026 GoodData Corporation
+export function isMaqlObject(obj) {
+    return "actualType" in obj;
+}
+export function isMaqlString(obj) {
+    return "string" in obj;
+}
+export function isMaqlTimeMacro(obj) {
+    return "transformationFunction" in obj && "granularity" in obj;
+}
+export function tokenRange(token) {
+    // subtract one line to change to indexing from zero
+    // subtract one more for the added "parse metric" line
+    const startLine = token.line - 2;
+    const startCharacter = token.charPositionInLine;
+    const lines = token.text?.split("\n") ?? [""];
+    const endLine = startLine + lines.length - 1;
+    const endCharacter = lines[lines.length - 1].length + (startLine === endLine ? startCharacter : 0);
+    return {
+        start: { line: startLine, character: startCharacter },
+        end: { line: endLine, character: endCharacter },
+    };
+}
+export function defaultRange(line, character, endLine = line, endCharacter = character) {
+    // subtract one line to change to indexing from zero
+    // subtract one more for the added "parse metric" line
+    line = line - 2;
+    endLine = endLine - 2;
+    return {
+        start: { line: line, character: character },
+        end: { line: endLine, character: endCharacter },
+    };
+}
+export function antlrContextRange(start, stop = start) {
+    return new AntlrRange(start.line, start.charPositionInLine, stop.line, stop.charPositionInLine + (stop.text?.length ?? 1));
+}
+export class AntlrRange {
+    startLine;
+    startCharacter;
+    endLine;
+    endCharacter;
+    constructor(startLine, startCharacter, endLine = startLine, endCharacter = startCharacter) {
+        this.startLine = startLine;
+        this.startCharacter = startCharacter;
+        this.endLine = endLine;
+        this.endCharacter = endCharacter;
+    }
+    static fromAstRange(astRange) {
+        return new AntlrRange(astRange.start.line + 1, astRange.start.character, astRange.end.line + 1, astRange.end.character);
+    }
+    toRange() {
+        return defaultRange(this.startLine, this.startCharacter, this.endLine, this.endCharacter);
+    }
+}

package/esm/types/hierarchy.d.ts

@@ -0,0 +1,37 @@
+export declare enum MaqlType {
+    /** Top type (supertype of all types) */
+    ANY = 0,
+    /** Abstract granularity type */
+    GRANULARITY = 1,
+    PERIODICAL_GRANULARITY = 2,
+    CHRONOLOGICAL_GRANULARITY = 3,
+    /** Abstract numeric type - facts, numbers, null */
+    NUMERIC = 4,
+    /** Abstract string type - labels, strings, null */
+    STRING = 5,
+    /** Abstract date type - date labels, date strings, null */
+    DATE = 6,
+    /** Intersection of string and date, can be used as both */
+    STRING_AND_DATE = 7,
+    NUMERIC_LITERAL = 8,
+    INTEGER_LITERAL = 9,
+    STRING_LITERAL = 10,
+    NULL_LITERAL = 11,
+    DATASET = 12,
+    BOOLEAN = 13,
+    /** Unit type - used for statements */
+    UNIT = 14,
+    /** Bottom type (subtype of all types) - used for unresolvable nodes */
+    ALL = 15
+}
+/**
+ * Types representing values, such as numbers, texts, timestamps etc.
+ */
+export declare const abstractValueTypes: readonly [MaqlType.NUMERIC, MaqlType.STRING, MaqlType.DATE];
+/**
+ * Solves the lowest common ancestor (LCA) problem on the MAQL type hierarchy tree for the types `t1` and `t2`
+ * Complexity: O(n*b) where n = number of types, b = branching factor (average number of subtypes per type)
+ */
+export declare function lowestCommonAncestor(t1: MaqlType, t2: MaqlType): MaqlType;
+export declare function isSubtype(type: MaqlType, supertype: MaqlType): boolean;
+//# sourceMappingURL=hierarchy.d.ts.map

package/esm/types/hierarchy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hierarchy.d.ts","sourceRoot":"","sources":["../../src/types/hierarchy.ts"],"names":[],"mappings":"AAEA,oBAAY,QAAQ;IAChB,wCAAwC;IACxC,GAAG,IAAA;IACH,gCAAgC;IAChC,WAAW,IAAA;IACX,sBAAsB,IAAA;IACtB,yBAAyB,IAAA;IACzB,mDAAmD;IACnD,OAAO,IAAA;IACP,mDAAmD;IACnD,MAAM,IAAA;IACN,2DAA2D;IAC3D,IAAI,IAAA;IACJ,2DAA2D;IAC3D,eAAe,IAAA;IACf,eAAe,IAAA;IACf,eAAe,IAAA;IACf,cAAc,KAAA;IACd,YAAY,KAAA;IACZ,OAAO,KAAA;IACP,OAAO,KAAA;IACP,sCAAsC;IACtC,IAAI,KAAA;IACJ,uEAAuE;IACvE,GAAG,KAAA;CACN;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,6DAA8D,CAAC;AA2I9F;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,GAAG,QAAQ,CASzE;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,GAAG,OAAO,CAMtE"}