@ui5/mcp-server 0.1.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../src/tools/create_ui5_app/schema.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EAAe,kBAAkB,EAAC,MAAM,6BAA6B,CAAC;AAE7E,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;SACtB,KAAK,CAAC,uBAAuB,EAAE,EAAC,OAAO,EAAE,iEAAiE,EAAC,CAAC;SAC5G,QAAQ,CAAC,2DAA2D;QACpE,4EAA4E,CAAC;IAC/E,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;SAClB,QAAQ,CAAC,6EAA6E;QACtF,yEAAyE;QACzE,2EAA2E;QAC3E,2EAA2E,CAAC;IAC9E,sGAAsG;IACtG,oCAAoC;IACpC,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;SACtD,QAAQ,CAAC,2EAA2E;QACpF,sFAAsF;QACtF,+FAA+F;QAC/F,qFAAqF,CAAC;IACxF,SAAS,EAAE,kBAAkB,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;SACxD,QAAQ,CAAC,0DAA0D,CAAC;IACtE,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;SAC1B,KAAK,CAAC,iBAAiB,EAAE,EAAC,OAAO,EAAE,+CAA+C,EAAC,CAAC;SACpF,QAAQ,EAAE;SACV,QAAQ,CAAC,yEAAyE;QAClF,uGAAuG;QACvG,qBAAqB,CAAC;IACxB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;SAChB,KAAK,CAAC,uBAAuB,EAAE,EAAC,OAAO,EAAE,8DAA8D,EAAC,CAAC;SACzG,QAAQ,EAAE;SACV,QAAQ,CAAC,2DAA2D,CAAC;IACvE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;SACpB,QAAQ,EAAE;SACV,QAAQ,CAAC,uFAAuF;QAChG,6FAA6F;QAC7F,yFAAyF;QACzF,qFAAqF;QACrF,6FAA6F;QAC7F,8FAA8F;QAC9F,sFAAsF;QACtF,uFAAuF;QACvF,gGAAgG;QAChG,mGAAmG;QACnG,gGAAgG,CAAC;IACnG,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;SACxB,KAAK,CAAC,iBAAiB,EAAE,EAAC,OAAO,EAAE,0DAA0D,EAAC,CAAC;SAC/F,QAAQ,EAAE;SACV,QAAQ,CAAC,+FAA+F;QACxG,mGAAmG;QACnG,oDAAoD,CAAC;IACvD,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAC,OAAO,EAAE,0DAA0D,EAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC9I,QAAQ,CAAC,yFAAyF;QAClG,oGAAoG;QACpG,qGAAqG;QACrG,iEAAiE,CAAC;IACpE,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;SAC3D,QAAQ,CAAC,0EAA0E,CAAC;IACtF,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;SACjD,QAAQ,CAAC,uEAAuE,CAAC;IACnF,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;SAC9C,QAAQ,CAAC,sFAAsF;QAC/F,iFAAiF;QACjF,oGAAoG;QACpG,+FAA+F,CAAC;CAClG,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC"}

package/lib/tools/create_ui5_app/templateProcessor.d.ts

@@ -0,0 +1,67 @@
+import { Ui5Framework } from "../../utils/ui5Framework.js";
+/**
+ * Template variable definitions for EJS templates.
+ */
+export interface TemplateVars {
+    /** Namespace for the application */
+    namespace: string;
+    /** Framework used, either OpenUI5 or SAPUI5 */
+    framework: Ui5Framework;
+    /** Version of the framework */
+    frameworkVersion: string;
+    /** Author of the application */
+    author: string;
+    /** TypeScript types npm package (only in TS case) */
+    tstypes?: string;
+    /** Version of TypeScript types npm package (only in TS case) */
+    tstypesVersion?: string;
+    /** Application ID */
+    appId: string;
+    /** Application URI (ID with slashes instead of dots) */
+    appURI: string;
+    /** CDN domain for resources */
+    cdnDomain: string;
+    /** OData V4 service URL */
+    oDataV4Url?: string;
+    /** OData entity set name */
+    oDataEntitySet?: string;
+    /** Properties of the entity to display */
+    entityProperties?: string[];
+    /** Indicates if server requires X-CSRF token , for optimized model config */
+    serverRequiresXCSRF?: boolean;
+    /** Default theme for the application */
+    defaultTheme: string;
+    /** QUnit coverage file - depends on UI5 version */
+    qunitCoverageFile: string;
+    /** Flags for version-specific features */
+    gte1_98_0: boolean;
+    gte1_100_0: boolean;
+    gte1_104_0: boolean;
+    lt1_110_0: boolean;
+    gte1_115_0: boolean;
+    gte1_120_0: boolean;
+    lt1_124_0: boolean;
+}
+/**
+ * Options for processing EJS templates with UI5-specific version handling.
+ */
+export interface TemplateProcessingOptions {
+    /** Directory containing the template files */
+    templateDir: string;
+    /** Target directory where processed files should be written */
+    targetDir: string;
+    /** Variables to pass to EJS template rendering */
+    templateVars: TemplateVars;
+    /** Version-specific logic flags */
+    versionSpecificLogic?: {
+        lt1_124_0: boolean;
+    };
+}
+/**
+ * Processes EJS templates from a source directory to a target directory.
+ * Handles UI5-specific version logic for test folder structure.
+ *
+ * @param options - Configuration for template processing
+ * @throws Error if template processing fails
+ */
+export declare function processTemplates(options: TemplateProcessingOptions): Promise<string[]>;

package/lib/tools/create_ui5_app/templateProcessor.js

@@ -0,0 +1,59 @@
+import path from "node:path";
+import { globby } from "globby";
+import ejs from "ejs";
+import { mkdir, readFile, writeFile } from "fs/promises";
+/**
+ * Processes EJS templates from a source directory to a target directory.
+ * Handles UI5-specific version logic for test folder structure.
+ *
+ * @param options - Configuration for template processing
+ * @throws Error if template processing fails
+ */
+export async function processTemplates(options) {
+    const { templateDir, targetDir, templateVars, versionSpecificLogic } = options;
+    // Paths must be POSIX, as globby always provides POSIX paths, even on Windows
+    const webappTestDir = "webapp/test/";
+    const webappTestDir_lt1_124 = "webapp/test-lt1_124/";
+    // Get all template files
+    const templateFiles = await globby("**", {
+        cwd: templateDir,
+    });
+    const generatedFiles = [];
+    for (const file of templateFiles) {
+        let targetFile = file;
+        // Handle version-specific test folder logic
+        if (versionSpecificLogic) {
+            if (file.startsWith(webappTestDir_lt1_124)) {
+                if (versionSpecificLogic.lt1_124_0) {
+                    targetFile = file.replace(webappTestDir_lt1_124, webappTestDir);
+                }
+                else {
+                    continue; // Skip this file
+                }
+            }
+            else if (file.startsWith(webappTestDir) && versionSpecificLogic.lt1_124_0) {
+                continue; // Skip this file
+            }
+        }
+        const sourcePath = path.join(templateDir, file);
+        const targetPath = path.join(targetDir, targetFile.replace(/^_/, "").replace(/\/_/, "/"));
+        // Ensure target directory exists
+        const targetDirPath = path.dirname(targetPath);
+        await mkdir(targetDirPath, { recursive: true });
+        try {
+            // Read and process template
+            const templateContent = await readFile(sourcePath, "utf8");
+            const processedContent = ejs.render(templateContent, templateVars);
+            // Write processed file
+            await writeFile(targetPath, processedContent);
+            generatedFiles.push(path.relative(targetDir, targetPath));
+        }
+        catch (error) {
+            throw new Error(`Failed to process template file '${file}': ${error instanceof Error ?
+                error.message :
+                String(error)}`);
+        }
+    }
+    return generatedFiles.sort((a, b) => a.localeCompare(b, undefined, { numeric: true, sensitivity: "base" }));
+}
+//# sourceMappingURL=templateProcessor.js.map

package/lib/tools/create_ui5_app/templateProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateProcessor.js","sourceRoot":"","sources":["../../../src/tools/create_ui5_app/templateProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAC9B,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AA+DvD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAkC;IACxE,MAAM,EAAC,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,oBAAoB,EAAC,GAAG,OAAO,CAAC;IAE7E,8EAA8E;IAC9E,MAAM,aAAa,GAAG,cAAc,CAAC;IACrC,MAAM,qBAAqB,GAAG,sBAAsB,CAAC;IAErD,yBAAyB;IACzB,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE;QACxC,GAAG,EAAE,WAAW;KAChB,CAAC,CAAC;IACH,MAAM,cAAc,GAAG,EAAE,CAAC;IAE1B,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;QAClC,IAAI,UAAU,GAAG,IAAI,CAAC;QAEtB,4CAA4C;QAC5C,IAAI,oBAAoB,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE,CAAC;gBAC5C,IAAI,oBAAoB,CAAC,SAAS,EAAE,CAAC;oBACpC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,aAAa,CAAC,CAAC;gBACjE,CAAC;qBAAM,CAAC;oBACP,SAAS,CAAC,iBAAiB;gBAC5B,CAAC;YACF,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,SAAS,EAAE,CAAC;gBAC7E,SAAS,CAAC,iBAAiB;YAC5B,CAAC;QACF,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QAE1F,iCAAiC;QACjC,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,KAAK,CAAC,aAAa,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;QAE9C,IAAI,CAAC;YACJ,4BAA4B;YAC5B,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC3D,MAAM,gBAAgB,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;YAEnE,uBAAuB;YACvB,MAAM,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;YAC9C,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;QAC3D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACd,oCAAoC,IAAI,MAAM,KAAK,YAAY,KAAK,CAAC,CAAC;gBACrE,KAAK,CAAC,OAAO,CAAC,CAAC;gBACd,MAAM,CAAC,KAAK,CAAC,EAAE,CACjB,CAAC;QACH,CAAC;IACF,CAAC;IACD,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,EAAC,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAC,CAAC,CAAC,CAAC;AAC3G,CAAC"}

package/lib/tools/create_ui5_app/ui5Version.d.ts

@@ -0,0 +1,2 @@
+import { Ui5Framework } from "../../utils/ui5Framework.js";
+export declare function getLatestUi5Version(framework: Ui5Framework): Promise<string>;

package/lib/tools/create_ui5_app/ui5Version.js

@@ -0,0 +1,6 @@
+import getVersionInfo from "../get_version_info/getVersionInfo.js";
+export async function getLatestUi5Version(framework) {
+    const versions = await getVersionInfo({ frameworkName: framework });
+    return versions.versions.latest.version;
+}
+//# sourceMappingURL=ui5Version.js.map

package/lib/tools/create_ui5_app/ui5Version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui5Version.js","sourceRoot":"","sources":["../../../src/tools/create_ui5_app/ui5Version.ts"],"names":[],"mappings":"AACA,OAAO,cAAc,MAAM,uCAAuC,CAAC;AAEnE,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,SAAuB;IAChE,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,EAAC,aAAa,EAAE,SAAS,EAAC,CAAC,CAAC;IAClE,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC;AACzC,CAAC"}

package/lib/tools/get_api_reference/createUriForSymbol.d.ts

@@ -0,0 +1,2 @@
+import { FormattedSymbol, FormattedSymbolSummary } from "./lib/formatSymbol.js";
+export default function createUriForSymbol(symbol: FormattedSymbol | FormattedSymbolSummary, frameworkName: string, frameworkVersion: string): string;

package/lib/tools/get_api_reference/createUriForSymbol.js

@@ -0,0 +1,49 @@
+import { InvalidInputError } from "../../utils.js";
+import { SymbolKind } from "./lib/ApiReferenceProvider.js";
+const sdkDomain = new Map([
+    ["sapui5", "https://ui5.sap.com"],
+    ["openui5", "https://openui5.org"],
+]);
+export default function createUriForSymbol(symbol, frameworkName, frameworkVersion) {
+    const domain = sdkDomain.get(frameworkName.toLowerCase());
+    if (!domain) {
+        throw new InvalidInputError(`Unknown framework name: ${frameworkName}`);
+    }
+    let entityPath;
+    if (symbol.module) {
+        entityPath = symbol.module.replaceAll("/", ".");
+    }
+    else {
+        // Some symbols like some namespaces might not have a module (e.g. sap.ui.model.odata)
+        entityPath = symbol.name;
+    }
+    let url = `${domain}/${frameworkVersion}/api/${entityPath}/`;
+    if (symbol.export) {
+        url += `${symbol.export}/`;
+    }
+    switch (symbol.kind) {
+        case SymbolKind.Constructor:
+            url += `constructor`;
+            break;
+        case SymbolKind.Ui5Aggregation:
+            url += `aggregations/${symbol.name}`;
+            break;
+        case SymbolKind.Ui5Association:
+            url += `associations/${symbol.name}`;
+            break;
+        case SymbolKind.Method:
+            url += `methods/${symbol.name}`;
+            break;
+        case SymbolKind.Function:
+            url += `functions/${symbol.name}`;
+            break;
+        case SymbolKind.Ui5Property:
+            url += `controlProperties/${symbol.name}`;
+            break;
+        case SymbolKind.Ui5Event:
+            url += `events/${symbol.name}`;
+            break;
+    }
+    return url;
+}
+//# sourceMappingURL=createUriForSymbol.js.map

package/lib/tools/get_api_reference/createUriForSymbol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createUriForSymbol.js","sourceRoot":"","sources":["../../../src/tools/get_api_reference/createUriForSymbol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAC,UAAU,EAAC,MAAM,+BAA+B,CAAC;AAGzD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAiB;IACzC,CAAC,QAAQ,EAAE,qBAAqB,CAAC;IACjC,CAAC,SAAS,EAAE,qBAAqB,CAAC;CAClC,CAAC,CAAC;AAEH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACzC,MAAgD,EAAE,aAAqB,EAAE,gBAAwB;IAEjG,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1D,IAAI,CAAC,MAAM,EAAE,CAAC;QACb,MAAM,IAAI,iBAAiB,CAAC,2BAA2B,aAAa,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,UAAU,CAAC;IACf,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC;SAAM,CAAC;QACP,sFAAsF;QACtF,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IACD,IAAI,GAAG,GAAG,GAAG,MAAM,IAAI,gBAAgB,QAAQ,UAAU,GAAG,CAAC;IAC7D,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC;IAC5B,CAAC;IACD,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,UAAU,CAAC,WAAW;YAC1B,GAAG,IAAI,aAAa,CAAC;YACrB,MAAM;QACP,KAAK,UAAU,CAAC,cAAc;YAC7B,GAAG,IAAI,gBAAgB,MAAM,CAAC,IAAI,EAAE,CAAC;YACrC,MAAM;QACP,KAAK,UAAU,CAAC,cAAc;YAC7B,GAAG,IAAI,gBAAgB,MAAM,CAAC,IAAI,EAAE,CAAC;YACrC,MAAM;QACP,KAAK,UAAU,CAAC,MAAM;YACrB,GAAG,IAAI,WAAW,MAAM,CAAC,IAAI,EAAE,CAAC;YAChC,MAAM;QACP,KAAK,UAAU,CAAC,QAAQ;YACvB,GAAG,IAAI,aAAa,MAAM,CAAC,IAAI,EAAE,CAAC;YAClC,MAAM;QACP,KAAK,UAAU,CAAC,WAAW;YAC1B,GAAG,IAAI,qBAAqB,MAAM,CAAC,IAAI,EAAE,CAAC;YAC1C,MAAM;QACP,KAAK,UAAU,CAAC,QAAQ;YACvB,GAAG,IAAI,UAAU,MAAM,CAAC,IAAI,EAAE,CAAC;YAC/B,MAAM;IACR,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC"}

package/lib/tools/get_api_reference/getApiReference.d.ts

@@ -0,0 +1,10 @@
+import { Ui5TypeInfo } from "@ui5/linter/Ui5TypeInfoMatcher";
+import { Ui5Framework } from "../../utils/ui5Framework.js";
+import { FormattedSymbol, FormattedSymbolSummary } from "./lib/formatSymbol.js";
+/**
+ * Example: await getApiReference("sapui5", 1.120.30", "sap.ui.table.Table");
+ */
+export declare function getApiReference(query: string, frameworkName: Ui5Framework, frameworkVersion: string): Promise<FormattedSymbol[]>;
+export declare function getApiReferenceSummary(query: string, frameworkName: Ui5Framework, frameworkVersion: string): Promise<(FormattedSymbol | FormattedSymbolSummary)[]>;
+export declare function getApiReferenceForUi5Type(ui5TypeInfo: Ui5TypeInfo, frameworkName: Ui5Framework, frameworkVersion: string): Promise<FormattedSymbol>;
+export declare function getApiReferenceSummaryForUi5Type(ui5TypeInfo: Ui5TypeInfo, frameworkName: Ui5Framework, frameworkVersion: string): Promise<FormattedSymbol | FormattedSymbolSummary>;

package/lib/tools/get_api_reference/getApiReference.js

@@ -0,0 +1,51 @@
+import ApiReferenceProvider from "./lib/ApiReferenceProvider.js";
+import { getApiJsonDir } from "./lib/apiReferenceResources.js";
+import { Mutex } from "async-mutex";
+async function createApiReferenceProvider(frameworkName, frameworkVersion) {
+    const apiJsonsRoot = await getApiJsonDir(frameworkName, frameworkVersion);
+    const apiRefProvider = await ApiReferenceProvider.create(apiJsonsRoot);
+    return apiRefProvider;
+}
+const apiRefProviders = new Map();
+const apiRefProviderMutex = new Mutex();
+async function getApiRefProvider(frameworkName, frameworkVersion) {
+    const key = `${frameworkName}-${frameworkVersion}`;
+    let apiRefProvider = apiRefProviders.get(key);
+    if (!apiRefProvider) {
+        const release = await apiRefProviderMutex.acquire();
+        try {
+            // Check again within the mutex
+            apiRefProvider = apiRefProviders.get(key);
+            if (!apiRefProvider) {
+                apiRefProvider = await createApiReferenceProvider(frameworkName, frameworkVersion);
+                apiRefProviders.set(key, apiRefProvider);
+            }
+        }
+        finally {
+            release();
+        }
+    }
+    return apiRefProvider;
+}
+/**
+ * Example: await getApiReference("sapui5", 1.120.30", "sap.ui.table.Table");
+ */
+export async function getApiReference(query, frameworkName, frameworkVersion) {
+    const apiRefProvider = await getApiRefProvider(frameworkName, frameworkVersion);
+    const res = await apiRefProvider.findSymbol(query);
+    return Array.isArray(res) ? res : [res];
+}
+export async function getApiReferenceSummary(query, frameworkName, frameworkVersion) {
+    const apiRefProvider = await getApiRefProvider(frameworkName, frameworkVersion);
+    const res = await apiRefProvider.findSymbolAndSummarize(query);
+    return Array.isArray(res) ? res : [res];
+}
+export async function getApiReferenceForUi5Type(ui5TypeInfo, frameworkName, frameworkVersion) {
+    const apiRefProvider = await getApiRefProvider(frameworkName, frameworkVersion);
+    return await apiRefProvider.getSymbolForUi5Type(ui5TypeInfo);
+}
+export async function getApiReferenceSummaryForUi5Type(ui5TypeInfo, frameworkName, frameworkVersion) {
+    const apiRefProvider = await getApiRefProvider(frameworkName, frameworkVersion);
+    return await apiRefProvider.getSymbolForUi5TypeAndSummarize(ui5TypeInfo);
+}
+//# sourceMappingURL=getApiReference.js.map

package/lib/tools/get_api_reference/getApiReference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApiReference.js","sourceRoot":"","sources":["../../../src/tools/get_api_reference/getApiReference.ts"],"names":[],"mappings":"AACA,OAAO,oBAAoB,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAE7D,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAC;AAGlC,KAAK,UAAU,0BAA0B,CAAC,aAA2B,EAAE,gBAAwB;IAC9F,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAC1E,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACvE,OAAO,cAAc,CAAC;AACvB,CAAC;AAED,MAAM,eAAe,GAAG,IAAI,GAAG,EAAgC,CAAC;AAChE,MAAM,mBAAmB,GAAG,IAAI,KAAK,EAAE,CAAC;AACxC,KAAK,UAAU,iBAAiB,CAAC,aAA2B,EAAE,gBAAwB;IACrF,MAAM,GAAG,GAAG,GAAG,aAAa,IAAI,gBAAgB,EAAE,CAAC;IACnD,IAAI,cAAc,GAAG,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAI,CAAC,cAAc,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,CAAC;QACpD,IAAI,CAAC;YACJ,+BAA+B;YAC/B,cAAc,GAAG,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;gBACrB,cAAc,GAAG,MAAM,0BAA0B,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;gBACnF,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;YAC1C,CAAC;QACF,CAAC;gBAAS,CAAC;YACV,OAAO,EAAE,CAAC;QACX,CAAC;IACF,CAAC;IACD,OAAO,cAAc,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACpC,KAAa,EAAE,aAA2B,EAAE,gBAAwB;IAEpE,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAChF,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACnD,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC3C,KAAa,EAAE,aAA2B,EAAE,gBAAwB;IAEpE,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAChF,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC/D,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC9C,WAAwB,EAAE,aAA2B,EAAE,gBAAwB;IAE/E,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAChF,OAAO,MAAM,cAAc,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gCAAgC,CACrD,WAAwB,EAAE,aAA2B,EAAE,gBAAwB;IAE/E,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAChF,OAAO,MAAM,cAAc,CAAC,+BAA+B,CAAC,WAAW,CAAC,CAAC;AAC1E,CAAC"}

package/lib/tools/get_api_reference/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/get_api_reference/index.js

@@ -0,0 +1,38 @@
+import { inputSchema } from "./schema.js";
+import { getApiReference } from "./getApiReference.js";
+import getProjectInfo from "../get_project_info/getProjectInfo.js";
+import createUriForSymbol from "./createUriForSymbol.js";
+import { getLogger } from "@ui5/logger";
+const log = getLogger("tools:get_api_reference");
+export default function registerTool(registerTool, context) {
+    registerTool("get_api_reference", {
+        description: "Search the UI5 API reference for module names and symbols",
+        annotations: {
+            title: "UI5 API Reference",
+            readOnlyHint: true,
+            idempotentHint: true,
+        },
+        inputSchema,
+    }, async ({ projectDir, query }) => {
+        log.info(`Searching API reference with query '${query}' based on project '${projectDir}'`);
+        const resolvedProjectDir = await context.normalizePath(projectDir);
+        const projectInfo = await getProjectInfo(resolvedProjectDir);
+        const frameworkName = projectInfo.frameworkName ?? "OpenUI5";
+        const frameworkVersion = projectInfo.frameworkVersion ?? (projectInfo.frameworkName === "OpenUI5" ? "1.136.5" : "1.136.7");
+        const apiRef = await getApiReference(query, frameworkName, frameworkVersion);
+        return {
+            content: apiRef.map((apiRef) => createResource(apiRef, frameworkName, frameworkVersion)),
+        };
+    });
+}
+function createResource(apiRef, frameworkName, frameworkVersion) {
+    return {
+        type: "resource",
+        resource: {
+            text: JSON.stringify(apiRef, null, 2),
+            uri: createUriForSymbol(apiRef, frameworkName, frameworkVersion),
+            mimeType: "application/json",
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tools/get_api_reference/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AACxC,OAAO,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAC;AACrD,OAAO,cAAc,MAAM,uCAAuC,CAAC;AACnE,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAMtC,MAAM,GAAG,GAAG,SAAS,CAAC,yBAAyB,CAAC,CAAC;AAEjD,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,YAA0B,EAAE,OAAgB;IAChF,YAAY,CAAC,mBAAmB,EAAE;QACjC,WAAW,EAAE,2DAA2D;QACxE,WAAW,EAAE;YACZ,KAAK,EAAE,mBAAmB;YAC1B,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,IAAI;SACpB;QACD,WAAW;KACX,EAAE,KAAK,EAAE,EAAC,UAAU,EAAE,KAAK,EAAC,EAAE,EAAE;QAChC,GAAG,CAAC,IAAI,CAAC,uCAAuC,KAAK,uBAAuB,UAAU,GAAG,CAAC,CAAC;QAC3F,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACnE,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,kBAAkB,CAAC,CAAC;QAC7D,MAAM,aAAa,GAAG,WAAW,CAAC,aAAa,IAAI,SAAS,CAAC;QAC7D,MAAM,gBAAgB,GACrB,WAAW,CAAC,gBAAgB,IAAI,CAAC,WAAW,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACnG,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,KAAK,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC;QAE7E,OAAO;YACN,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC;SACxF,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,MAAuB,EAAE,aAAqB,EAAE,gBAAwB;IAC/F,OAAO;QACN,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE;YACT,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YACrC,GAAG,EAAE,kBAAkB,CAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,CAAC;YAChE,QAAQ,EAAE,kBAAkB;SAC5B;KACD,CAAC;AACH,CAAC"}

package/lib/tools/get_api_reference/lib/ApiReferenceProvider.d.ts

@@ -0,0 +1,85 @@
+import { ApiReferenceIndex } from "./apiReferenceResources.js";
+import type { ConcreteSymbol, ObjMethod, ObjProperty, Ui5Property, ObjEvent, Ui5Event, EnumProperty, Ui5Aggregation, Ui5Association, Ui5SpecialSetting, ObjConstructor, ObjCallableParameter, NamespaceSymbol, SymbolBase, InterfaceSymbol, ClassSymbol, EnumSymbol } from "./api-json.js";
+import { Ui5TypeInfo } from "@ui5/linter/Ui5TypeInfoMatcher";
+import { FormattedSymbol, FormattedSymbolSummary } from "./formatSymbol.js";
+interface SymbolCache {
+    symbols: Map<string, ConcreteSymbol>;
+    library: string;
+}
+interface SymbolInfo {
+    symbol: ConcreteSymbol | ConcreteSymbolField;
+    library: string;
+    moduleName: string | undefined;
+}
+type AddToUnion<T, U> = T extends unknown ? T & U : never;
+export declare enum SymbolKind {
+    Class = "class",
+    Interface = "interface",
+    Namespace = "namespace",
+    Enum = "enum",
+    Member = "member",// 'member' is treated like 'namespace' or 'object'
+    Object = "object",
+    Typedef = "typedef",
+    Function = "function",
+    Property = "property",
+    Constructor = "constructor",
+    Method = "method",
+    Event = "event",
+    Parameter = "parameter",
+    EnumProperty = "enum-property",
+    Ui5Property = "ui5-property",
+    Ui5Event = "ui5-event",
+    Ui5Aggregation = "ui5-aggregation",
+    Ui5Association = "ui5-association",
+    Ui5SpecialSetting = "ui5-specialSetting"
+}
+export type ConcreteSymbolField = AddToUnion<ObjMethod | ObjProperty | Ui5Property | ObjEvent | Ui5Event | EnumProperty | Ui5Aggregation | Ui5Association | Ui5SpecialSetting | ObjConstructor | ObjCallableParameter, {
+    kind: SymbolKind;
+}>;
+export default class ApiReferenceProvider {
+    private apiJsonsRootDir;
+    private index;
+    private symbolCache;
+    private apiJsonLoadMutex;
+    constructor(apiJsonsRootDir: string, index: ApiReferenceIndex);
+    static create(apiJsonsRootDir: string): Promise<ApiReferenceProvider>;
+    findSymbol(query: string): Promise<FormattedSymbol | FormattedSymbol[]>;
+    findSymbolAndSummarize(query: string): Promise<FormattedSymbol | FormattedSymbolSummary | (FormattedSymbol | FormattedSymbolSummary)[]>;
+    _findSymbol(query: string): Promise<SymbolInfo | SymbolInfo[]>;
+    _findSymbolsInModule(moduleName: string, symbolCache: SymbolCache): SymbolInfo[];
+    /**
+     * Searches for a field (e.g. method, property, event) by name within a UI5 symbol.
+     *
+     * @param symbol The ConcreteSymbol to search within.
+     * @param field The name of the field to find.
+     * @returns The found entity (method, property, event, etc.) or undefined if not found.
+     */
+    _getFieldInSymbol(symbol: ConcreteSymbol, field: string): ConcreteSymbolField | undefined;
+    _findFieldByName<T extends {
+        name: string;
+    }>(fieldName: string, symbolFields: T[] | undefined, fieldKind: SymbolKind): ConcreteSymbolField | undefined;
+    getSymbolForUi5Type(ui5TypeInfo: Ui5TypeInfo): Promise<FormattedSymbol>;
+    getSymbolForUi5TypeAndSummarize(ui5TypeInfo: Ui5TypeInfo): Promise<FormattedSymbol | FormattedSymbolSummary>;
+    _getSymbolForUi5Type(ui5TypeInfo: Ui5TypeInfo): Promise<SymbolInfo>;
+    _parseUi5TypeInfo(ui5TypeInfo: Ui5TypeInfo): {
+        moduleName: string;
+        relevantNode: Ui5TypeInfo;
+    } | undefined;
+    _findSymbolForSubType(symbol: ClassSymbol | InterfaceSymbol | NamespaceSymbol | EnumSymbol, ui5TypeInfo: Ui5TypeInfo): ConcreteSymbol | ConcreteSymbolField | undefined;
+    _getApiJson(filePath: string): Promise<SymbolCache>;
+    /**
+     * Normalizes the search query by removing white space, replacing slashes and hashes with dots,
+     * and making it lower case (to allow case-insensitive search).
+     *
+     * @param query - The search query to normalize. E.g. " module:sap/ui/core/Component#onInit "
+     * @returns The normalized query. E.g. "sap.ui.core.Component"
+     */
+    _normalizeForIndex(query: string): string;
+    _normalizeForModuleName(query: string): string;
+}
+export declare function isUi5ClassSymbol(symbol: SymbolBase): symbol is ClassSymbol;
+export declare function isUi5InterfaceSymbol(symbol: SymbolBase): symbol is InterfaceSymbol;
+export declare function isUi5NamespaceSymbol(symbol: SymbolBase): symbol is NamespaceSymbol;
+export declare function isUi5EnumSymbol(symbol: SymbolBase): symbol is EnumSymbol;
+export declare function isConcreteSymbol(symbol: ConcreteSymbol | ConcreteSymbolField): symbol is ConcreteSymbol;
+export {};