@sap-ux/fiori-mcp-server 0.0.1

package/dist/tools/input-schema/get-functionality-details.json

@@ -0,0 +1,24 @@
+{
+    "type": "object",
+    "properties": {
+        "appPath": {
+            "type": "string",
+            "description": "Path to the Fiori application. Path should be an absolute path."
+        },
+        "functionalityId": {
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": ["string", "number"]
+                    }
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "The ID of the functionality to get details for"
+        }
+    },
+    "required": ["appPath", "functionalityId"]
+}

package/dist/tools/input-schema/index.d.ts

@@ -0,0 +1,5 @@
+export { default as executeFunctionalityInputSchema } from './execute-functionality.json';
+export { default as getFunctionalityDetailsInputSchema } from './get-functionality-details.json';
+export { default as listFioriAppsInputSchema } from './list-fiori-apps.json';
+export { default as listFunctionalityInputSchema } from './list-functionality.json';
+//# sourceMappingURL=index.d.ts.map

package/dist/tools/input-schema/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listFunctionalityInputSchema = exports.listFioriAppsInputSchema = exports.getFunctionalityDetailsInputSchema = exports.executeFunctionalityInputSchema = void 0;
+var execute_functionality_json_1 = require("./execute-functionality.json");
+Object.defineProperty(exports, "executeFunctionalityInputSchema", { enumerable: true, get: function () { return __importDefault(execute_functionality_json_1).default; } });
+var get_functionality_details_json_1 = require("./get-functionality-details.json");
+Object.defineProperty(exports, "getFunctionalityDetailsInputSchema", { enumerable: true, get: function () { return __importDefault(get_functionality_details_json_1).default; } });
+var list_fiori_apps_json_1 = require("./list-fiori-apps.json");
+Object.defineProperty(exports, "listFioriAppsInputSchema", { enumerable: true, get: function () { return __importDefault(list_fiori_apps_json_1).default; } });
+var list_functionality_json_1 = require("./list-functionality.json");
+Object.defineProperty(exports, "listFunctionalityInputSchema", { enumerable: true, get: function () { return __importDefault(list_functionality_json_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/tools/input-schema/list-fiori-apps.json

@@ -0,0 +1,12 @@
+{
+    "type": "object",
+    "properties": {
+        "searchPath": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "Path to search for Fiori applications (defaults to current directory). If VSCode - list of VS Code workspace folder paths(`workspace.workspaceFolders`)"
+        }
+    }
+}

package/dist/tools/input-schema/list-functionality.json

@@ -0,0 +1,10 @@
+{
+    "type": "object",
+    "properties": {
+        "appPath": {
+            "type": "string",
+            "description": "Path to the root folder of the Fiori application (where package.json and ui5.yaml reside). Path should be an absolute path."
+        }
+    },
+    "required": ["appPath"]
+}

package/dist/tools/list-fiori-apps.d.ts

@@ -0,0 +1,10 @@
+import type { ListFioriAppsInput, ListFioriAppsOutput } from '../types';
+/**
+ * Scans the provided workspace paths for Fiori applications and returns
+ * a structured list of discovered apps.
+ *
+ * @param params - Input parameters for the search.
+ * @returns A promise resolving to an object containing a list of discovered Fiori applications.
+ */
+export declare function listFioriApps(params: ListFioriAppsInput): Promise<ListFioriAppsOutput>;
+//# sourceMappingURL=list-fiori-apps.d.ts.map

package/dist/tools/list-fiori-apps.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listFioriApps = listFioriApps;
+const project_access_1 = require("@sap-ux/project-access");
+const path_1 = require("path");
+/**
+ * Scans the provided workspace paths for Fiori applications and returns
+ * a structured list of discovered apps.
+ *
+ * @param params - Input parameters for the search.
+ * @returns A promise resolving to an object containing a list of discovered Fiori applications.
+ */
+async function listFioriApps(params) {
+    const { searchPath = [] } = params;
+    const newFoundFioriArtifacts = await (0, project_access_1.findFioriArtifacts)({
+        wsFolders: searchPath,
+        artifacts: ['applications']
+    });
+    const applications = newFoundFioriArtifacts.applications ?? [];
+    return {
+        applications: (await Promise.all(applications.map(async (app) => {
+            const projectType = await (0, project_access_1.getProjectType)(app.projectRoot);
+            return {
+                name: app.manifest['sap.app']?.id ?? (0, path_1.basename)(app.appRoot),
+                appPath: app.appRoot,
+                projectPath: app.projectRoot,
+                projectType,
+                odataVersion: app.manifest['sap.app']?.dataSources?.mainService?.settings?.odataVersion ?? '4.0'
+            };
+        }))) ?? []
+    };
+}
+//# sourceMappingURL=list-fiori-apps.js.map

package/dist/tools/list-functionalities.d.ts

@@ -0,0 +1,10 @@
+import type { ListFunctionalitiesInput, ListFunctionalitiesOutput } from '../types';
+/**
+ * Lists all functionalities for a given application.
+ *
+ * @param params - The input parameters for listing functionalities.
+ * @param params.appPath - The path to the application.
+ * @returns A promise that resolves to either a ListFunctionalitiesOutput object or an error message string.
+ */
+export declare function listFunctionalities(params: ListFunctionalitiesInput): Promise<ListFunctionalitiesOutput | string>;
+//# sourceMappingURL=list-functionalities.d.ts.map

package/dist/tools/list-functionalities.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listFunctionalities = listFunctionalities;
+const page_editor_api_1 = require("../page-editor-api");
+const functionalities_1 = require("./functionalities");
+const utils_1 = require("./utils");
+/**
+ * Lists all functionalities for a given application.
+ *
+ * @param params - The input parameters for listing functionalities.
+ * @param params.appPath - The path to the application.
+ * @returns A promise that resolves to either a ListFunctionalitiesOutput object or an error message string.
+ */
+async function listFunctionalities(params) {
+    const { appPath } = params;
+    let functionalities = [];
+    try {
+        // If we need dynamic handlers then we can add additional method in interface of FUNCTIONALITIES_HANDLERS
+        for (const functionality of functionalities_1.FUNCTIONALITIES_DETAILS) {
+            functionalities.push({
+                functionalityId: functionality.functionalityId,
+                description: functionality.description
+            });
+        }
+        const project = await (0, utils_1.resolveApplication)(appPath);
+        const apps = project?.applicationAccess?.project.apps ?? {};
+        if (project?.applicationAccess && Object.keys(apps).length) {
+            const { applicationAccess } = project;
+            const ftfsFileIo = new page_editor_api_1.SapuxFtfsFileIO(applicationAccess);
+            const appData = await ftfsFileIo.readApp();
+            functionalities = functionalities.concat(await getAppFunctionalities(applicationAccess));
+            const pages = Object.keys(appData.config?.pages ?? {});
+            for (const pageId of pages) {
+                functionalities = functionalities.concat(await getPageFunctionalities(applicationAccess, pageId));
+            }
+        }
+    }
+    catch (error) {
+        return `Error while trying to list functionalities: ${error.message}`;
+    }
+    return {
+        applicationPath: appPath,
+        functionalities
+    };
+}
+/**
+ * Retrieves functionalities for the application settings.
+ *
+ * @param appAccess - The ApplicationAccess object for accessing the application.
+ * @returns A promise that resolves to an array of Functionality objects.
+ */
+async function getAppFunctionalities(appAccess) {
+    const pageEditorApi = new page_editor_api_1.PageEditorApi(appAccess, undefined);
+    const tree = await pageEditorApi.getPageTree();
+    const settingsNode = tree.children.find((node) => node.path[node.path.length - 1] === 'settings');
+    if (!settingsNode) {
+        return [];
+    }
+    // Ignore 'minVersion', 'lazy' properties
+    settingsNode.properties = settingsNode.properties.filter((setting) => !['minVersion', 'lazy', 'dependencies'].includes(setting.name));
+    return getFunctionalitiesFromPageTree(settingsNode);
+}
+/**
+ * Retrieves functionalities for a specific page in the application.
+ *
+ * @param appAccess - The ApplicationAccess object for accessing the application.
+ * @param pageId - Optional. The ID of the page to retrieve functionalities for.
+ * @returns A promise that resolves to an array of Functionality objects.
+ */
+async function getPageFunctionalities(appAccess, pageId) {
+    const pageEditorApi = new page_editor_api_1.PageEditorApi(appAccess, pageId);
+    const pageTree = await pageEditorApi.getPageTree();
+    return getFunctionalitiesFromPageTree(pageTree, undefined, pageId);
+}
+/**
+ * Extracts functionalities from a page tree structure.
+ *
+ * @param pageTree - The TreeNode representing the page structure.
+ * @param parentId - Optional. The parent ID array for nested functionalities.
+ * @param pageName - Optional. The name of the page being processed.
+ * @returns An array of Functionality objects extracted from the page tree.
+ */
+function getFunctionalitiesFromPageTree(pageTree, parentId = [], pageName) {
+    const functionalities = [];
+    // Process properties of the current node
+    if (pageTree.properties) {
+        for (const property of pageTree.properties) {
+            // Create functionality from property with schemaPath as id
+            const functionality = getPropertyFunctionality(property, pageName);
+            functionalities.push(functionality);
+            // Recursively process nested properties
+            if (property.properties) {
+                const nestedFunctionalities = processNestedProperties(property.properties);
+                functionalities.push(...nestedFunctionalities);
+            }
+        }
+    }
+    // Recursively process child nodes
+    if (pageTree.children) {
+        for (const child of pageTree.children) {
+            const childFunctionalities = getFunctionalitiesFromPageTree(child, [...parentId, ...pageTree.path.map(String)], pageName);
+            functionalities.push(...childFunctionalities);
+        }
+    }
+    return functionalities;
+}
+/**
+ * Processes nested properties to extract functionalities.
+ *
+ * @param properties - An array of TreeNodeProperty objects to process.
+ * @param pageName - Optional. The name of the page being processed.
+ * @returns An array of Functionality objects extracted from the nested properties.
+ */
+function processNestedProperties(properties, pageName) {
+    const functionalities = [];
+    for (const property of properties) {
+        const functionality = getPropertyFunctionality(property, pageName);
+        functionalities.push(functionality);
+        // Recursively process further nested properties
+        if (property.properties) {
+            const nestedFunctionalities = processNestedProperties(property.properties);
+            functionalities.push(...nestedFunctionalities);
+        }
+    }
+    return functionalities;
+}
+/**
+ * Creates a Functionality object from a TreeNodeProperty.
+ *
+ * @param property - The TreeNodeProperty to convert into a Functionality.
+ * @param pageName - Optional. The name of the page the property belongs to.
+ * @returns A Functionality object representing the property.
+ */
+function getPropertyFunctionality(property, pageName) {
+    const path = [];
+    if (pageName) {
+        path.push(pageName);
+    }
+    path.push(...property.schemaPath);
+    return {
+        functionalityId: path,
+        description: property.description || property.displayName || property.name || 'No description available'
+    };
+}
+//# sourceMappingURL=list-functionalities.js.map

package/dist/tools/output-schema/execute-functionality.json

@@ -0,0 +1,39 @@
+{
+    "type": "object",
+    "properties": {
+        "functionalityId": {
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": ["string", "number"]
+                    }
+                },
+                {
+                    "type": "string"
+                }
+            ]
+        },
+        "status": {
+            "type": "string"
+        },
+        "message": {
+            "type": "string"
+        },
+        "parameters": {},
+        "appPath": {
+            "type": "string"
+        },
+        "changes": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "timestamp": {
+            "type": "string"
+        }
+    },
+    "required": ["functionalityId", "status", "message", "parameters", "appPath", "changes", "timestamp"],
+    "additionalProperties": false
+}

package/dist/tools/output-schema/get-functionality-details.json

@@ -0,0 +1,142 @@
+{
+    "type": "object",
+    "properties": {
+        "functionalityId": {
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": ["string", "number"]
+                    }
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Identifier to pass as the `functionalityId` parameter when calling `get-functionality-details` or `execute-functionality`"
+        },
+        "name": {
+            "type": "string"
+        },
+        "description": {
+            "type": "string"
+        },
+        "technicalDescription": {
+            "type": "string"
+        },
+        "parameters": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "type": {
+                        "type": "string",
+                        "enum": ["string", "number", "boolean", "array", "object"]
+                    },
+                    "required": {
+                        "type": "boolean"
+                    },
+                    "description": {
+                        "type": "string"
+                    },
+                    "defaultValue": {},
+                    "options": {
+                        "type": "array",
+                        "items": {
+                            "anyOf": [
+                                {
+                                    "type": "string"
+                                },
+                                {
+                                    "type": "number"
+                                },
+                                {
+                                    "type": "boolean"
+                                },
+                                {
+                                    "not": {}
+                                }
+                            ]
+                        }
+                    },
+                    "currentValue": {},
+                    "parameters": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "id": {
+                                    "type": "string"
+                                },
+                                "name": {
+                                    "type": "string"
+                                },
+                                "type": {
+                                    "type": "string",
+                                    "enum": ["string", "number", "boolean", "array", "object"]
+                                },
+                                "required": {
+                                    "type": "boolean"
+                                },
+                                "description": {
+                                    "type": "string"
+                                },
+                                "defaultValue": {},
+                                "options": {
+                                    "type": "array",
+                                    "items": {
+                                        "anyOf": [
+                                            {
+                                                "type": "string"
+                                            },
+                                            {
+                                                "type": "number"
+                                            },
+                                            {
+                                                "type": "boolean"
+                                            },
+                                            {
+                                                "not": {}
+                                            }
+                                        ]
+                                    }
+                                },
+                                "currentValue": {}
+                            },
+                            "required": ["id", "type"],
+                            "additionalProperties": false
+                        }
+                    }
+                },
+                "required": ["id", "type"],
+                "additionalProperties": false
+            }
+        },
+        "prerequisites": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "impact": {
+            "type": "string"
+        },
+        "examples": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "pageName": {
+            "type": "string"
+        }
+    },
+    "required": ["id", "name", "description", "parameters"],
+    "additionalProperties": false
+}

package/dist/tools/output-schema/index.d.ts

@@ -0,0 +1,5 @@
+export { default as executeFunctionalityOutputSchema } from './execute-functionality.json';
+export { default as getFunctionalityDetailsOutputSchema } from './get-functionality-details.json';
+export { default as listFioriAppsOutputSchema } from './list-fiori-apps.json';
+export { default as listFunctionalityOutputSchema } from './list-functionality.json';
+//# sourceMappingURL=index.d.ts.map

package/dist/tools/output-schema/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listFunctionalityOutputSchema = exports.listFioriAppsOutputSchema = exports.getFunctionalityDetailsOutputSchema = exports.executeFunctionalityOutputSchema = void 0;
+var execute_functionality_json_1 = require("./execute-functionality.json");
+Object.defineProperty(exports, "executeFunctionalityOutputSchema", { enumerable: true, get: function () { return __importDefault(execute_functionality_json_1).default; } });
+var get_functionality_details_json_1 = require("./get-functionality-details.json");
+Object.defineProperty(exports, "getFunctionalityDetailsOutputSchema", { enumerable: true, get: function () { return __importDefault(get_functionality_details_json_1).default; } });
+var list_fiori_apps_json_1 = require("./list-fiori-apps.json");
+Object.defineProperty(exports, "listFioriAppsOutputSchema", { enumerable: true, get: function () { return __importDefault(list_fiori_apps_json_1).default; } });
+var list_functionality_json_1 = require("./list-functionality.json");
+Object.defineProperty(exports, "listFunctionalityOutputSchema", { enumerable: true, get: function () { return __importDefault(list_functionality_json_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/tools/output-schema/list-fiori-apps.json

@@ -0,0 +1,41 @@
+{
+    "type": "object",
+    "properties": {
+        "type": "object",
+        "properties": {
+            "applications": {
+                "type": "array",
+                "items": {
+                    "type": "object",
+                    "properties": {
+                        "name": {
+                            "type": "string",
+                            "description": "Name of the Fiori application. Usually derived from the `sap.app/id` field in the application's manifest.json."
+                        },
+                        "appPath": {
+                            "type": "string",
+                            "description": "Absolute path to the Fiori application's root directory."
+                        },
+                        "projectPath": {
+                            "type": "string",
+                            "description": "Absolute path to the root directory of the project containing this Fiori application. For EDMXBackend (standalone) projects, this is the same as `appPath`. For CAP projects, this points to the CAP project root, which may contain multiple Fiori applications."
+                        },
+                        "projectType": {
+                            "type": "string",
+                            "enum": ["EDMXBackend", "CAPJava", "CAPNodejs"],
+                            "description": "Type of project the application belongs to."
+                        },
+                        "odataVersion": {
+                            "type": "string",
+                            "description": "OData protocol version used by the application's main service."
+                        }
+                    },
+                    "required": ["name", "appPath", "projectPath", "projectType", "odataVersion"],
+                    "additionalProperties": false
+                }
+            }
+        },
+        "required": ["applications"],
+        "additionalProperties": false
+    }
+}

package/dist/tools/output-schema/list-functionality.json

@@ -0,0 +1,37 @@
+{
+    "type": "object",
+    "properties": {
+        "applicationPath": {
+            "type": "string"
+        },
+        "functionalities": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "functionalityId": {
+                        "anyOf": [
+                            {
+                                "type": "array",
+                                "items": {
+                                    "type": ["string", "number"]
+                                }
+                            },
+                            {
+                                "type": "string"
+                            }
+                        ],
+                        "description": "Identifier to pass as the `functionalityId` parameter when calling `get-functionality-details` or `execute-functionality`"
+                    },
+                    "description": {
+                        "type": "string"
+                    }
+                },
+                "required": ["functionalityId", "description"],
+                "additionalProperties": false
+            }
+        }
+    },
+    "required": ["applicationPath", "functionalities"],
+    "additionalProperties": false
+}

package/dist/tools/utils.d.ts

@@ -0,0 +1,16 @@
+import type { Appdetails } from '../types';
+/**
+ * Resolves the application details from a given path.
+ *
+ * @param path - The file system path to resolve the application from.
+ * @returns A promise that resolves to an Appdetails object if the application is found, or undefined otherwise.
+ */
+export declare function resolveApplication(path: string): Promise<Appdetails | undefined>;
+/**
+ * Returns the folder path for new extension creation using the FPM writer approach.
+ *
+ * @param directory - Target file type (fragment, view, controller) or a custom subfolder.
+ * @returns The relative path for the extension folder, or undefined if the directory type is not recognized.
+ */
+export declare const getDefaultExtensionFolder: (directory: string) => string | undefined;
+//# sourceMappingURL=utils.d.ts.map

package/dist/tools/utils.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultExtensionFolder = void 0;
+exports.resolveApplication = resolveApplication;
+const project_access_1 = require("@sap-ux/project-access");
+const path_1 = require("path");
+/**
+ * Resolves the application details from a given path.
+ *
+ * @param path - The file system path to resolve the application from.
+ * @returns A promise that resolves to an Appdetails object if the application is found, or undefined otherwise.
+ */
+async function resolveApplication(path) {
+    try {
+        // normalize app path
+        path = (0, path_1.join)(path);
+        try {
+            const applicationAccess = await (0, project_access_1.createApplicationAccess)(path);
+            return {
+                root: applicationAccess.project.root,
+                appId: applicationAccess.getAppId(),
+                // projectProvider,
+                applicationAccess
+            };
+        }
+        catch (e) {
+            console.log(`Application was not found by given path. Error: ${e}`);
+            // Fallback - project without app
+            const root = await (0, project_access_1.findProjectRoot)(path);
+            const project = await (0, project_access_1.getProject)(root);
+            if (project) {
+                return {
+                    root: project.root,
+                    appId: ''
+                };
+            }
+        }
+    }
+    catch (e) {
+        console.log(`Project was not found by given path. Error: ${e}`);
+        return undefined;
+    }
+    return undefined;
+}
+/**
+ * Returns the folder path for new extension creation using the FPM writer approach.
+ *
+ * @param directory - Target file type (fragment, view, controller) or a custom subfolder.
+ * @returns The relative path for the extension folder, or undefined if the directory type is not recognized.
+ */
+const getDefaultExtensionFolder = (directory) => {
+    let subFolder;
+    switch (directory) {
+        case project_access_1.DirName.View: {
+            subFolder = (0, path_1.join)(project_access_1.DirName.Ext, project_access_1.DirName.View);
+            break;
+        }
+        case project_access_1.DirName.Fragment: {
+            subFolder = (0, path_1.join)(project_access_1.DirName.Ext, project_access_1.DirName.Fragment);
+            break;
+        }
+        case project_access_1.DirName.Controller: {
+            subFolder = (0, path_1.join)(project_access_1.DirName.Ext, project_access_1.DirName.Controller);
+            break;
+        }
+        default: {
+            // Subfolder is passed
+            subFolder = directory;
+        }
+    }
+    return subFolder;
+};
+exports.getDefaultExtensionFolder = getDefaultExtensionFolder;
+//# sourceMappingURL=utils.js.map