@ui5/mcp-server 0.1.0

package/lib/tools/get_version_info/getVersionInfo.js

@@ -0,0 +1,41 @@
+import { fetchCdn, getBaseUrl } from "../../utils/cdnHelper.js";
+import { Mutex } from "async-mutex";
+import { getLogger } from "@ui5/logger";
+const log = getLogger("tools:get_version_info:getVersionInfo");
+const cachedVersionInfo = new Map();
+const versionInfoMutex = new Mutex();
+/**
+ * Fetch version information for the specified UI5 framework
+ * @param framework The UI5 framework (OpenUI5 or SAPUI5)
+ * @returns The version information
+ * @throws {Error} If the version information cannot be fetched
+ */
+export default async function getVersionInfo(params) {
+    if (cachedVersionInfo.has(params.frameworkName)) {
+        return { versions: cachedVersionInfo.get(params.frameworkName) };
+    }
+    const release = await versionInfoMutex.acquire();
+    try {
+        // Check again inside the mutex
+        if (cachedVersionInfo.has(params.frameworkName)) {
+            return { versions: cachedVersionInfo.get(params.frameworkName) };
+        }
+        const baseUrl = getBaseUrl(params.frameworkName);
+        const url = `${baseUrl}/version.json`;
+        log.info(`Fetching version information for ${params.frameworkName} from ${url}`);
+        const data = await fetchCdn(url);
+        const versions = processVersionJson(data);
+        cachedVersionInfo.set(params.frameworkName, versions);
+        return { versions };
+    }
+    finally {
+        release();
+    }
+}
+function processVersionJson(rawJsonData) {
+    if (!rawJsonData || typeof rawJsonData !== "object" || Array.isArray(rawJsonData)) {
+        throw new Error("Invalid version.json format. Expected an object.");
+    }
+    return rawJsonData;
+}
+//# sourceMappingURL=getVersionInfo.js.map

package/lib/tools/get_version_info/getVersionInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getVersionInfo.js","sourceRoot":"","sources":["../../../src/tools/get_version_info/getVersionInfo.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,QAAQ,EAAE,UAAU,EAAC,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAC;AAClC,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAEtC,MAAM,GAAG,GAAG,SAAS,CAAC,uCAAuC,CAAC,CAAC;AAE/D,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAuB,CAAC;AACzD,MAAM,gBAAgB,GAAG,IAAI,KAAK,EAAE,CAAC;AAErC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,cAAc,CAAC,MAA4B;IACxE,IAAI,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,EAAC,QAAQ,EAAE,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAE,EAAC,CAAC;IACjE,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,CAAC;IACjD,IAAI,CAAC;QACJ,+BAA+B;QAC/B,IAAI,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;YACjD,OAAO,EAAC,QAAQ,EAAE,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAE,EAAC,CAAC;QACjE,CAAC;QACD,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,GAAG,OAAO,eAAe,CAAC;QACtC,GAAG,CAAC,IAAI,CAAC,oCAAoC,MAAM,CAAC,aAAa,SAAS,GAAG,EAAE,CAAC,CAAC;QAEjF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC1C,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QACtD,OAAO,EAAC,QAAQ,EAAC,CAAC;IACnB,CAAC;YAAS,CAAC;QACV,OAAO,EAAE,CAAC;IACX,CAAC;AACF,CAAC;AAED,SAAS,kBAAkB,CAAC,WAAoB;IAC/C,IAAI,CAAC,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QACnF,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,WAA0B,CAAC;AACnC,CAAC"}

package/lib/tools/get_version_info/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * UI5 Version Info Tool
+ *
+ * This tool provides version information for UI5 (OpenUI5 and SAPUI5)
+ * by fetching data from the respective version.json files.
+ */
+import Context from "../../Context.js";
+import { RegisterTool } from "../../registerTools.js";
+export default function registerTool(registerTool: RegisterTool, _context: Context): void;

package/lib/tools/get_version_info/index.js

@@ -0,0 +1,33 @@
+/**
+ * UI5 Version Info Tool
+ *
+ * This tool provides version information for UI5 (OpenUI5 and SAPUI5)
+ * by fetching data from the respective version.json files.
+ */
+import getVersionInfo from "./getVersionInfo.js";
+import { inputSchema, outputSchema } from "./schema.js";
+import { getLogger } from "@ui5/logger";
+const log = getLogger("tools:get_version_info");
+export default function registerTool(registerTool, _context) {
+    registerTool("get_version_info", {
+        description: "Get version information for UI5 (OpenUI5 or SAPUI5)",
+        annotations: {
+            title: "UI5 Version Info",
+            readOnlyHint: true,
+            idempotentHint: true,
+        },
+        inputSchema,
+        outputSchema,
+    }, async (toolParams) => {
+        log.info(`Retrieving version info for framework '${toolParams.frameworkName}'`);
+        const versionInfo = await getVersionInfo(toolParams);
+        return {
+            content: [{
+                    type: "text",
+                    text: JSON.stringify(versionInfo, null, 2),
+                }],
+            structuredContent: versionInfo,
+        };
+    });
+}
+//# sourceMappingURL=index.js.map

package/lib/tools/get_version_info/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tools/get_version_info/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAC,WAAW,EAAE,YAAY,EAAC,MAAM,aAAa,CAAC;AACtD,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAItC,MAAM,GAAG,GAAG,SAAS,CAAC,wBAAwB,CAAC,CAAC;AAEhD,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,YAA0B,EAAE,QAAiB;IACjF,YAAY,CAAC,kBAAkB,EAAE;QAChC,WAAW,EAAE,qDAAqD;QAClE,WAAW,EAAE;YACZ,KAAK,EAAE,kBAAkB;YACzB,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,IAAI;SACpB;QACD,WAAW;QACX,YAAY;KACZ,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;QACvB,GAAG,CAAC,IAAI,CAAC,0CAA0C,UAAU,CAAC,aAAa,GAAG,CAAC,CAAC;QAChF,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,UAAU,CAAC,CAAC;QACrD,OAAO;YACN,OAAO,EAAE,CAAC;oBACT,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;iBAC1C,CAAC;YACF,iBAAiB,EAAE,WAAW;SAC9B,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC"}

package/lib/tools/get_version_info/schema.d.ts

@@ -0,0 +1,66 @@
+import { z } from "zod";
+export declare const inputSchema: {
+    frameworkName: z.ZodEnum<["OpenUI5", "SAPUI5"]>;
+};
+export declare const inputSchemaObject: z.ZodObject<{
+    frameworkName: z.ZodEnum<["OpenUI5", "SAPUI5"]>;
+}, "strip", z.ZodTypeAny, {
+    frameworkName: "OpenUI5" | "SAPUI5";
+}, {
+    frameworkName: "OpenUI5" | "SAPUI5";
+}>;
+export declare const versionsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+    version: z.ZodString;
+    support: z.ZodString;
+    lts: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    support: string;
+    lts: boolean;
+}, {
+    version: string;
+    support: string;
+    lts: boolean;
+}>>;
+export declare const outputSchema: {
+    versions: z.ZodRecord<z.ZodString, z.ZodObject<{
+        version: z.ZodString;
+        support: z.ZodString;
+        lts: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        version: string;
+        support: string;
+        lts: boolean;
+    }, {
+        version: string;
+        support: string;
+        lts: boolean;
+    }>>;
+};
+export declare const outputSchemaObject: z.ZodObject<{
+    versions: z.ZodRecord<z.ZodString, z.ZodObject<{
+        version: z.ZodString;
+        support: z.ZodString;
+        lts: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        version: string;
+        support: string;
+        lts: boolean;
+    }, {
+        version: string;
+        support: string;
+        lts: boolean;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    versions: Record<string, {
+        version: string;
+        support: string;
+        lts: boolean;
+    }>;
+}, {
+    versions: Record<string, {
+        version: string;
+        support: string;
+        lts: boolean;
+    }>;
+}>;

package/lib/tools/get_version_info/schema.js

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import { Ui5FrameworkSchema } from "../../utils/ui5Framework.js";
+export const inputSchema = {
+    frameworkName: Ui5FrameworkSchema.describe("The UI5 framework to get version information for"),
+};
+export const inputSchemaObject = z.object(inputSchema);
+export const versionsSchema = z.record(z.string(), z.object({
+    version: z.string(),
+    support: z.string(),
+    lts: z.boolean(),
+})).describe("All known versions with their support information");
+export const outputSchema = {
+    versions: versionsSchema,
+};
+export const outputSchemaObject = z.object(outputSchema);
+//# sourceMappingURL=schema.js.map

package/lib/tools/get_version_info/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../src/tools/get_version_info/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AACtB,OAAO,EAAC,kBAAkB,EAAC,MAAM,6BAA6B,CAAC;AAE/D,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,aAAa,EAAE,kBAAkB,CAAC,QAAQ,CAAC,kDAAkD,CAAC;CAC9F,CAAC;AACF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAEvD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CACrC,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,MAAM,CAAC;IACR,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE;CAChB,CAAC,CACF,CAAC,QAAQ,CAAC,mDAAmD,CAAC,CAAC;AAEhE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B,QAAQ,EAAE,cAAc;CACxB,CAAC;AACF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC"}

package/lib/tools/get_version_info/types.d.ts

@@ -0,0 +1,5 @@
+import * as z from "zod";
+import { inputSchemaObject, outputSchemaObject, versionsSchema } from "./schema.js";
+export type VersionInfo = z.infer<typeof versionsSchema>;
+export type GetVersionInfoParams = z.infer<typeof inputSchemaObject>;
+export type GetVersionInfoResult = z.infer<typeof outputSchemaObject>;

package/lib/tools/get_version_info/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/tools/get_version_info/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/tools/get_version_info/types.ts"],"names":[],"mappings":""}

package/lib/tools/run_ui5_linter/index.d.ts

@@ -0,0 +1,3 @@
+import Context from "../../Context.js";
+import { RegisterTool } from "../../registerTools.js";
+export default function registerTool(registerTool: RegisterTool, context: Context): void;

package/lib/tools/run_ui5_linter/index.js

@@ -0,0 +1,86 @@
+import runUi5Linter from "./runUi5Linter.js";
+import { inputSchema, outputSchema } from "./schema.js";
+import { getLogger } from "@ui5/logger";
+import { pathToFileURL } from "node:url";
+const log = getLogger("tools:run_ui5_linter");
+export default function registerTool(registerTool, context) {
+    registerTool("run_ui5_linter", {
+        description: "Run UI5 linter on a UI5 project to find and optionally fix UI5 related problems like the usage of " +
+            "deprecated API. " +
+            "After making changes, you should always run the linter again to verify that no new problems have been " +
+            "introduced.",
+        annotations: {
+            title: "UI5 linter",
+            readOnlyHint: false,
+        },
+        inputSchema,
+        outputSchema,
+    }, async ({ projectDir, filePatterns, provideContextInformation, fix }) => {
+        log.info(`Running UI5 linter on project at ${projectDir}`);
+        if (filePatterns) {
+            log.info(`  File patterns: ${filePatterns.join(", ")}`);
+        }
+        log.info(`  Fix enabled: ${fix}`);
+        log.info(`  Provide context information: ${provideContextInformation}`);
+        const resolvedProjectPath = await context.normalizePath(projectDir);
+        const results = await runUi5Linter({
+            projectDir: resolvedProjectPath,
+            filePatterns,
+            provideContextInformation,
+            fix,
+        });
+        const content = [{
+                type: "text",
+                text: JSON.stringify(results.results, null, 2),
+            }];
+        if (results.contextInformation) {
+            const { ruleDescriptions, documentationResources, migrationGuides, apiReferences } = results.contextInformation;
+            if (apiReferences.length) {
+                const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
+                const projectUri = pathToFileURL(resolvedProjectPath);
+                content.push({
+                    type: "resource",
+                    resource: {
+                        uri: `ui5-linter-result://${projectUri.pathname}/api-reference-extract-${timestamp}.json`,
+                        text: JSON.stringify(apiReferences, null, 2),
+                        mimeType: "application/json",
+                    },
+                });
+            }
+            for (const migrationGuide of migrationGuides) {
+                content.push({
+                    type: "resource",
+                    resource: {
+                        title: migrationGuide.title,
+                        text: migrationGuide.text,
+                        uri: migrationGuide.uri,
+                        mimeType: "text/markdown",
+                    },
+                });
+            }
+            ;
+            for (const doc of documentationResources) {
+                content.push({
+                    type: "resource",
+                    resource: {
+                        title: doc.title,
+                        text: doc.text,
+                        uri: doc.uri,
+                        mimeType: "text/markdown",
+                    },
+                });
+            }
+            if (ruleDescriptions.length) {
+                content.push({
+                    type: "text",
+                    text: JSON.stringify(ruleDescriptions, null, 2),
+                });
+            }
+        }
+        return {
+            content,
+            structuredContent: results,
+        };
+    });
+}
+//# sourceMappingURL=index.js.map

package/lib/tools/run_ui5_linter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tools/run_ui5_linter/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAC,WAAW,EAAE,YAAY,EAAC,MAAM,aAAa,CAAC;AAEtD,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAGtC,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AAEvC,MAAM,GAAG,GAAG,SAAS,CAAC,sBAAsB,CAAC,CAAC;AAE9C,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,YAA0B,EAAE,OAAgB;IAChF,YAAY,CAAC,gBAAgB,EAAE;QAC9B,WAAW,EACV,oGAAoG;YACpG,kBAAkB;YAClB,wGAAwG;YACxG,aAAa;QACd,WAAW,EAAE;YACZ,KAAK,EAAE,YAAY;YACnB,YAAY,EAAE,KAAK;SACnB;QACD,WAAW;QACX,YAAY;KACZ,EAAE,KAAK,EAAE,EAAC,UAAU,EAAE,YAAY,EAAE,yBAAyB,EAAE,GAAG,EAAC,EAAE,EAAE;QACvE,GAAG,CAAC,IAAI,CAAC,oCAAoC,UAAU,EAAE,CAAC,CAAC;QAC3D,IAAI,YAAY,EAAE,CAAC;YAClB,GAAG,CAAC,IAAI,CAAC,oBAAoB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC,CAAC;QAClC,GAAG,CAAC,IAAI,CAAC,kCAAkC,yBAAyB,EAAE,CAAC,CAAC;QACxE,MAAM,mBAAmB,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACpE,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC;YAClC,UAAU,EAAE,mBAAmB;YAC/B,YAAY;YACZ,yBAAyB;YACzB,GAAG;SACH,CAAC,CAAC;QACH,MAAM,OAAO,GAAuC,CAAC;gBACpD,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;aAC9C,CAAC,CAAC;QACH,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAChC,MAAM,EAAC,gBAAgB,EAAE,sBAAsB,EAAE,eAAe,EAAE,aAAa,EAAC,GAC/E,OAAO,CAAC,kBAAkB,CAAC;YAC5B,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;gBAC1B,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBACjE,MAAM,UAAU,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;gBACtD,OAAO,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,UAAU;oBAChB,QAAQ,EAAE;wBACT,GAAG,EAAE,uBAAuB,UAAU,CAAC,QAAQ,0BAA0B,SAAS,OAAO;wBACzF,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;wBAC5C,QAAQ,EAAE,kBAAkB;qBAC5B;iBACD,CAAC,CAAC;YACJ,CAAC;YACD,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;gBAC9C,OAAO,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,UAAU;oBAChB,QAAQ,EAAE;wBACT,KAAK,EAAE,cAAc,CAAC,KAAK;wBAC3B,IAAI,EAAE,cAAc,CAAC,IAAI;wBACzB,GAAG,EAAE,cAAc,CAAC,GAAG;wBACvB,QAAQ,EAAE,eAAe;qBACzB;iBACD,CAAC,CAAC;YACJ,CAAC;YAAA,CAAC;YACF,KAAK,MAAM,GAAG,IAAI,sBAAsB,EAAE,CAAC;gBAC1C,OAAO,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,UAAU;oBAChB,QAAQ,EAAE;wBACT,KAAK,EAAE,GAAG,CAAC,KAAK;wBAChB,IAAI,EAAE,GAAG,CAAC,IAAI;wBACd,GAAG,EAAE,GAAG,CAAC,GAAG;wBACZ,QAAQ,EAAE,eAAe;qBACzB;iBACD,CAAC,CAAC;YACJ,CAAC;YACD,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;gBAC7B,OAAO,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC;iBAC/C,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,OAAO;YACN,OAAO;YACP,iBAAiB,EAAE,OAAO;SAC1B,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC"}

package/lib/tools/run_ui5_linter/migrationGuides.d.ts

@@ -0,0 +1,6 @@
+import { LintResult } from "@ui5/linter";
+export default function getMigrationGuidesForResults(results: LintResult[]): Promise<{
+    title: string;
+    text: string;
+    uri: string;
+}[]>;

package/lib/tools/run_ui5_linter/migrationGuides.js

@@ -0,0 +1,88 @@
+import Ui5TypeInfoMatcher from "@ui5/linter/Ui5TypeInfoMatcher";
+import { readFile } from "fs/promises";
+export default async function getMigrationGuidesForResults(results) {
+    const matchers = new Set();
+    matchers.add(createGlobalMigrationGuideMatcher());
+    matchers.add(createJqueryMigrationGuideMatcher());
+    matchers.add(createSapMMigrationGuideMatcher());
+    matchers.add(createSapUiCoreMigrationGuideMatcher());
+    matchers.add(createSapUiTableTableMigrationGuideMatcher());
+    const migrationGuidesBasePath = new URL(`../../../resources/migrationGuides`, import.meta.url);
+    const migrationGuidePaths = new Set();
+    for (const result of results) {
+        for (const msg of result.messages) {
+            if (msg.ui5TypeInfo) {
+                const migrationGuidePath = getMigrationGuidePathForUi5TypeInfo(msg.ui5TypeInfo, matchers);
+                if (migrationGuidePath) {
+                    migrationGuidePaths.add(migrationGuidePath);
+                }
+            }
+        }
+    }
+    return await Promise.all(Array.from(migrationGuidePaths).map(async (migrationGuidePath) => {
+        const fileUrl = new URL(`${migrationGuidesBasePath}/${migrationGuidePath}`);
+        return {
+            title: migrationGuidePath,
+            text: await readFile(fileUrl, "utf8"),
+            uri: `ui5-linter-result://migration-guides/${migrationGuidePath}`,
+        };
+    }));
+}
+function getMigrationGuidePathForUi5TypeInfo(ui5TypeInfo, matchers) {
+    for (const matcher of matchers) {
+        const migrationGuidePath = matcher.match(ui5TypeInfo);
+        if (migrationGuidePath) {
+            return migrationGuidePath;
+        }
+    }
+}
+function createGlobalMigrationGuideMatcher() {
+    const m = new Ui5TypeInfoMatcher();
+    m.declareNamespace("sap", [
+        m.namespace("ui", [
+            m.function("controller", "deprecated-controller-factory.md"),
+        ]),
+    ]);
+    return m;
+}
+function createJqueryMigrationGuideMatcher() {
+    /**
+     * NOTE: Since jQuery.sap APIs are not fully typed, UI5 linter generates "mocked" UI5 Type Info.
+     * To keep it simple, that module simply treats everything as a NAMESPACE.
+     *
+     * Therefore, the filters expressed below MUST ALWAYS USE NAMESPACE, regardless of the actual type.
+    */
+    const m = new Ui5TypeInfoMatcher("jquery");
+    m.declareModule("jQuery", [
+        m.namespace("sap", [
+            m.namespace("declare", "deprecated-jquery-sap-require.md"),
+            m.namespace("require", "deprecated-jquery-sap-require.md"),
+        ]),
+    ]);
+    return m;
+}
+function createSapMMigrationGuideMatcher() {
+    const m = new Ui5TypeInfoMatcher("sap.m");
+    m.declareModule("sap/m/MessagePage", "deprecated-message-page.md");
+    return m;
+}
+function createSapUiCoreMigrationGuideMatcher() {
+    const m = new Ui5TypeInfoMatcher("sap.ui.core");
+    // TODO: Core.getLibraryResourceBundle => sap.ui.core.Lib.getResourceBundleFor
+    return m;
+}
+function createSapUiTableTableMigrationGuideMatcher() {
+    const m = new Ui5TypeInfoMatcher("sap.ui.table");
+    m.declareModule("sap/ui/table/Table", [
+        m.managedObjectSetting("$TableSettings", [
+            m.metadataProperty("rowHeight", "deprecated-table-table-property.md"),
+            m.metadataProperty("visibleRowCountMode", "deprecated-table-table-property.md"),
+            m.metadataProperty("visibleRowCount", "deprecated-table-table-property.md"),
+            m.metadataProperty("minAutoRowCount", "deprecated-table-table-property.md"),
+            m.metadataProperty("fixedRowCount", "deprecated-table-table-property.md"),
+            m.metadataProperty("fixedBottomRowCount", "deprecated-table-table-property.md"),
+        ]),
+    ]);
+    return m;
+}
+//# sourceMappingURL=migrationGuides.js.map

package/lib/tools/run_ui5_linter/migrationGuides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrationGuides.js","sourceRoot":"","sources":["../../../src/tools/run_ui5_linter/migrationGuides.ts"],"names":[],"mappings":"AACA,OAAO,kBAAiC,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAC;AAIrC,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,4BAA4B,CAAC,OAAqB;IAC/E,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAwB,CAAC;IACjD,QAAQ,CAAC,GAAG,CAAC,iCAAiC,EAAE,CAAC,CAAC;IAClD,QAAQ,CAAC,GAAG,CAAC,iCAAiC,EAAE,CAAC,CAAC;IAClD,QAAQ,CAAC,GAAG,CAAC,+BAA+B,EAAE,CAAC,CAAC;IAChD,QAAQ,CAAC,GAAG,CAAC,oCAAoC,EAAE,CAAC,CAAC;IACrD,QAAQ,CAAC,GAAG,CAAC,0CAA0C,EAAE,CAAC,CAAC;IAE3D,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC,oCAAoC,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE/F,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC9B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,kBAAkB,GAAG,mCAAmC,CAAC,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;gBAC1F,IAAI,kBAAkB,EAAE,CAAC;oBACxB,mBAAmB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAC7C,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED,OAAO,MAAM,OAAO,CAAC,GAAG,CACvB,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE;QAChE,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,uBAAuB,IAAI,kBAAkB,EAAE,CAAC,CAAC;QAC5E,OAAO;YACN,KAAK,EAAE,kBAAkB;YACzB,IAAI,EAAE,MAAM,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;YACrC,GAAG,EAAE,wCAAwC,kBAAkB,EAAE;SACjE,CAAC;IACH,CAAC,CAAC,CACF,CAAC;AACH,CAAC;AAED,SAAS,mCAAmC,CAAC,WAAwB,EAAE,QAAmC;IACzG,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAChC,MAAM,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,kBAAkB,EAAE,CAAC;YACxB,OAAO,kBAAkB,CAAC;QAC3B,CAAC;IACF,CAAC;AACF,CAAC;AAED,SAAS,iCAAiC;IACzC,MAAM,CAAC,GAAyB,IAAI,kBAAkB,EAAE,CAAC;IACzD,CAAC,CAAC,gBAAgB,CAAC,KAAK,EAAE;QACzB,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE;YACjB,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,kCAAkC,CAAC;SAC5D,CAAC;KACF,CAAC,CAAC;IACH,OAAO,CAAC,CAAC;AACV,CAAC;AAED,SAAS,iCAAiC;IACzC;;;;;MAKE;IACF,MAAM,CAAC,GAAyB,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE;QACzB,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE;YAClB,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,kCAAkC,CAAC;YAC1D,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,kCAAkC,CAAC;SAC1D,CAAC;KACF,CAAC,CAAC;IACH,OAAO,CAAC,CAAC;AACV,CAAC;AAED,SAAS,+BAA+B;IACvC,MAAM,CAAC,GAAyB,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAEhE,CAAC,CAAC,aAAa,CAAC,mBAAmB,EAAE,4BAA4B,CAAC,CAAC;IACnE,OAAO,CAAC,CAAC;AACV,CAAC;AAED,SAAS,oCAAoC;IAC5C,MAAM,CAAC,GAAyB,IAAI,kBAAkB,CAAC,aAAa,CAAC,CAAC;IACtE,8EAA8E;IAC9E,OAAO,CAAC,CAAC;AACV,CAAC;AAED,SAAS,0CAA0C;IAClD,MAAM,CAAC,GAAyB,IAAI,kBAAkB,CAAC,cAAc,CAAC,CAAC;IACvE,CAAC,CAAC,aAAa,CAAC,oBAAoB,EAAE;QACrC,CAAC,CAAC,oBAAoB,CAAC,gBAAgB,EAAE;YACxC,CAAC,CAAC,gBAAgB,CAAC,WAAW,EAAE,oCAAoC,CAAC;YACrE,CAAC,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,oCAAoC,CAAC;YAC/E,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,oCAAoC,CAAC;YAC3E,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,oCAAoC,CAAC;YAC3E,CAAC,CAAC,gBAAgB,CAAC,eAAe,EAAE,oCAAoC,CAAC;YACzE,CAAC,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,oCAAoC,CAAC;SAC/E,CAAC;KACF,CAAC,CAAC;IACH,OAAO,CAAC,CAAC;AACV,CAAC"}

package/lib/tools/run_ui5_linter/resultContext.d.ts

@@ -0,0 +1,3 @@
+import { LintResult } from "@ui5/linter";
+import { RunUi5LinterResultContext } from "./schema.js";
+export declare function createResultContext(results: LintResult[]): Promise<RunUi5LinterResultContext>;

package/lib/tools/run_ui5_linter/resultContext.js

@@ -0,0 +1,236 @@
+import { NotFoundError } from "../../utils.js";
+import getMigrationGuidesForResults from "./migrationGuides.js";
+import { Ui5TypeInfoKind } from "@ui5/linter/Ui5TypeInfoMatcher";
+import { getApiReferenceSummary, getApiReferenceSummaryForUi5Type } from "../get_api_reference/getApiReference.js";
+import { getLogger } from "@ui5/logger";
+import { getDocumentationByLoio } from "../../resources/documentation/getDocumentation.js";
+const log = getLogger("tools:run_ui5_linter:resultContext");
+const API_REF_FRAMEWORK = "OpenUI5";
+const API_REF_VERSION = "1.136.5"; // Version currently used by UI5 linter
+export async function createResultContext(results) {
+    const { ruleIds, moduleNames, topics, relevantUi5Types } = groupResults(results);
+    const ruleDescriptions = getRuleDescriptions(ruleIds, topics);
+    const apiReferences = await getApiReferences(relevantUi5Types, topics, moduleNames);
+    const migrationGuides = await getMigrationGuidesForResults(results);
+    const documentationResources = await getDocumentationReferences(topics);
+    return {
+        ruleDescriptions,
+        apiReferences,
+        documentationResources,
+        migrationGuides,
+    };
+}
+function groupResults(result) {
+    // Collect rules for errors
+    const ruleIds = new Set();
+    const moduleNames = new Set();
+    const relevantUi5Types = new Set();
+    const topics = new Set();
+    const uniqueMessageDetails = new Set();
+    for (const res of result) {
+        res.messages.forEach((message) => {
+            ruleIds.add(message.ruleId);
+            const ui5TypeInfo = message.ui5TypeInfo;
+            if (ui5TypeInfo) {
+                const moduleName = getModuleNameForTypeInfo(ui5TypeInfo);
+                if (moduleName) {
+                    moduleNames.add(moduleName);
+                }
+                relevantUi5Types.add(ui5TypeInfo);
+            }
+            // Extract anything that remotely looks like a module name from the message details
+            if (message.messageDetails) {
+                if (uniqueMessageDetails.has(message.messageDetails)) {
+                    // Already processed this message details, skip and remove from message
+                    message.messageDetails = "";
+                }
+                else {
+                    uniqueMessageDetails.add(message.messageDetails);
+                    // Remove line-breaks from message details
+                    message.messageDetails = message.messageDetails.replace(/\r?\n/g, " ");
+                    findModuleNames(message.messageDetails, moduleNames);
+                    findTopicReferences(message.messageDetails, topics);
+                }
+            }
+        });
+    }
+    return {
+        ruleIds,
+        moduleNames,
+        topics,
+        relevantUi5Types,
+    };
+}
+function getModuleNameForTypeInfo(ui5TypeInfo) {
+    if (ui5TypeInfo.kind === Ui5TypeInfoKind.Module) {
+        return ui5TypeInfo.name;
+    }
+    while ("parent" in ui5TypeInfo && ui5TypeInfo.parent) {
+        if (ui5TypeInfo.parent.kind === Ui5TypeInfoKind.Module) {
+            return ui5TypeInfo.parent.name;
+        }
+        ui5TypeInfo = ui5TypeInfo.parent;
+    }
+    return undefined;
+}
+function getRuleDescriptions(ruleIds, topics) {
+    const ruleDescriptions = [];
+    for (const ruleId of ruleIds) {
+        const ref = RULE_REFERENCES[ruleId];
+        let text;
+        if (typeof ref === "string") {
+            text = ref;
+        }
+        else {
+            text = ref.text;
+            for (const topic of ref.topics) {
+                topics.add(topic);
+            }
+        }
+        ruleDescriptions.push({
+            ruleId,
+            description: text,
+        });
+    }
+    return ruleDescriptions;
+}
+async function getApiReferences(relevantUi5Types, topics, moduleNames) {
+    const apiReferences = [];
+    for (const ui5TypeInfo of relevantUi5Types) {
+        try {
+            // Framework and version must match the version used in UI5 linter
+            const apiReference = await getApiReferenceSummaryForUi5Type(ui5TypeInfo, API_REF_FRAMEWORK, API_REF_VERSION);
+            findTopicReferences(JSON.stringify(apiReference), topics);
+            if (apiReference.deprecatedText && typeof apiReference.deprecatedText === "string") {
+                // Examples texts:
+                // > Please use {@link sap.ui.core.Element.getElementById Element.getElementById} instead
+                // > Use the {@link sap.m.Avatar} instead
+                findModuleNames(apiReference.deprecatedText, moduleNames);
+            }
+            apiReferences.push(apiReference);
+        }
+        catch (_err) {
+            // Ignore errors, since module might not exist in API reference
+            // We only want to provide hints, so it's not a problem if something is missing
+            continue;
+        }
+    }
+    // Add short references for all module names
+    for (const moduleName of moduleNames) {
+        try {
+            const res = await getApiReferenceSummary(moduleName, API_REF_FRAMEWORK, API_REF_VERSION);
+            if (res) {
+                apiReferences.push(...res);
+            }
+        }
+        catch (_err) {
+            // Ignore errors, since module might not exist in API reference
+            // We only want to provide hints, so it's not a problem if something is missing
+            continue;
+        }
+    }
+    // De-duplicate compact API references
+    const uniqueApiReferences = new Map();
+    for (const apiReference of apiReferences) {
+        const key = `${apiReference.module ?? "<no-module>"}-${apiReference.kind}-${apiReference.name}}`;
+        if (!uniqueApiReferences.has(key)) {
+            uniqueApiReferences.set(key, apiReference);
+        }
+    }
+    return Array.from(uniqueApiReferences.values());
+}
+async function getDocumentationReferences(topics) {
+    const documentationResources = [];
+    for (const topic of topics) {
+        try {
+            const doc = await getDocumentationByLoio(topic);
+            if (doc) {
+                documentationResources.push(doc);
+            }
+        }
+        catch (err) {
+            if (err instanceof NotFoundError) {
+                log.verbose(`Failed to get documentation for topic ${topic}: ${err.message}`);
+                // Ignore not-found errors that occur during linter result collection
+                // No need to report them to the LLM, since they might be caused by
+                // incorrect JSDoc
+                continue;
+            }
+            throw err;
+        }
+    }
+    return documentationResources;
+}
+// Examples for module names: "sap.m.Avatar", "sap/ui/core/Component", "sap.ui.model.odata.v2.ODataModel"
+const MODULE_NAME_REGEX = /sap(?:[./][a-zA-Z0-9_]+)+/g;
+function findModuleNames(text, moduleNames) {
+    // Find all module names in the text
+    const matches = text.matchAll(MODULE_NAME_REGEX);
+    for (const match of matches) {
+        const moduleName = match[0]; // Use the whole match (no group)
+        moduleNames.add(moduleName);
+    }
+}
+// Example: https://ui5.sap.com/#/topic/a075ed88ef324261bca41813a6ac4a1c?q=Replacement%20of%20Deprecated%20jQuery%20APIs
+const LOIO_ID_URL_REGEX = /https:\/\/ui5\.sap\.com\/#\/topic\/([a-zA-Z0-9-]+)/g;
+function findTopicReferences(text, topics) {
+    const matches = text.matchAll(LOIO_ID_URL_REGEX);
+    for (const match of matches) {
+        const topic = match[1];
+        topics.add(topic);
+    }
+}
+const RULE_REFERENCES = {
+    "async-component-flags": {
+        text: `Components must be configured for asynchronous loading via the \`sap.ui.core.IAsyncContentCreation\` interface in the Component metadata or via \`async\` flags in the \`manifest.json\``,
+        topics: ["676b636446c94eada183b1218a824717", "0187ea5e2eff4166b0453b9dcc8fc64f"],
+    },
+    "csp-unsafe-inline-script": {
+        text: `Inline scripts in HTML files must not be used in accordance with Content Security Policy (CSP) best practices`,
+        topics: ["fe1a6dba940e479fb7c3bc753f92b28c"],
+    },
+    "no-ambiguous-event-handler": {
+        text: `Event handlers in XML views/fragments are either defined in the respective controller ` +
+            `(in which case they should be prefixed by a dot, e.g. '.<method name>') or refer to a method of an imported module (via \`core:require\` import)`,
+        topics: ["b0fb4de7364f4bcbb053a99aa645affe"],
+    },
+    "no-deprecated-api": {
+        text: `Deprecated UI5 API must not be used. Check the individual API reference for details on how to replace it.`,
+        topics: ["28fcd55b04654977b63dacbee0552712"],
+    },
+    "no-deprecated-component": {
+        text: `There must be no dependencies to deprecated components in the project's \`manifest.json\``,
+        topics: ["a87ca843bcee469f82a9072927a7dcdb"],
+    },
+    "no-deprecated-control-renderer-declaration": `The control's renderer has not been declared correctly`,
+    "no-deprecated-library": {
+        text: `The projects \`manifest.json\` and/or \`ui5.yaml\` declare dependencies to deprecated UI5 framework libraries`,
+        topics: ["a87ca843bcee469f82a9072927a7dcdb"],
+    },
+    "no-deprecated-theme": {
+        text: `The project is referencing deprecated UI5 themes`,
+        topics: ["a87ca843bcee469f82a9072927a7dcdb"],
+    },
+    "no-globals": {
+        text: `Global variables must not be used for accessing UI5 framework APIs and should be avoided in application code. ` +
+            `The respective modules should be imported explicitly.`,
+        topics: ["28fcd55b04654977b63dacbee0552712"],
+    },
+    "no-implicit-globals": {
+        text: `Either modules are accessed via the deprecated global library namespace that is exposed by the \`<namespace>/library\` module of a UI5 library,
+or \`odata\` globals are used implicitly in bindings (missing an explicit import of the corresponding module).`,
+        topics: ["28fcd55b04654977b63dacbee0552712"],
+    },
+    "no-pseudo-modules": {
+        text: `Deprecated pseudo modules are used`,
+        topics: ["00737d6c1b864dc3ab72ef56611491c4"],
+    },
+    "parsing-error": `During the linting process a syntax or parsing error occured`,
+    "prefer-test-starter": {
+        text: `Test-related files should be using the Test Starter concept`,
+        topics: ["032be2cb2e1d4115af20862673bedcdb"],
+    },
+    "ui5-class-declaration": `UI5 classes are not declared correctly. This rule only applies to TypeScript code where built-in ECMAScript classes are used instead of an \`.extend()\` call`,
+    "unsupported-api-usage": `UI5 API is not used correctly. For example, a formatter declared in a binding declaration in JavaScript is not of type \`function\``,
+};
+//# sourceMappingURL=resultContext.js.map