@sap-ux/fiori-mcp-server 0.0.2 → 0.0.4

package/dist/constant.d.ts

@@ -2,4 +2,5 @@ export declare const LATEST_UI5_VERSION = "1.136.7";
 export declare const GENERATE_FIORI_UI_APP_ID = "generate-fiori-ui-app";
 export declare const ADD_PAGE = "add-page";
 export declare const DELETE_PAGE = "delete-page";
+export declare const CREATE_CONTROLLER_EXTENSION_FUNCTIONALITY_ID = "create-controller-extension";
 //# sourceMappingURL=constant.d.ts.map

package/dist/constant.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DELETE_PAGE = exports.ADD_PAGE = exports.GENERATE_FIORI_UI_APP_ID = exports.LATEST_UI5_VERSION = void 0;
+exports.CREATE_CONTROLLER_EXTENSION_FUNCTIONALITY_ID = exports.DELETE_PAGE = exports.ADD_PAGE = exports.GENERATE_FIORI_UI_APP_ID = exports.LATEST_UI5_VERSION = void 0;
 exports.LATEST_UI5_VERSION = '1.136.7';
 exports.GENERATE_FIORI_UI_APP_ID = 'generate-fiori-ui-app';
 exports.ADD_PAGE = 'add-page';
 exports.DELETE_PAGE = 'delete-page';
+exports.CREATE_CONTROLLER_EXTENSION_FUNCTIONALITY_ID = 'create-controller-extension';
 //# sourceMappingURL=constant.js.map

package/dist/tools/functionalities/controller-extension/index.js

@@ -5,6 +5,7 @@ const src_1 = require("@sap/ux-specification/dist/types/src");
 const page_editor_api_1 = require("../../../page-editor-api");
 const utils_1 = require("../../utils");
 const path_1 = require("path");
+const constant_1 = require("../../../constant");
 /**
  * Retrieves the parameter definitions for creating a controller extension.
  *
@@ -34,7 +35,7 @@ function getParameters() {
     };
 }
 exports.CREATE_CONTROLLER_EXTENSION_FUNCTIONALITY = {
-    functionalityId: 'create-controller-extension',
+    functionalityId: constant_1.CREATE_CONTROLLER_EXTENSION_FUNCTIONALITY_ID,
     name: 'Add new controller extension by creating javascript or typescript file and updates manifest.json with entry',
     description: 'Add new controller extension by creating javascript or typescript file and updates manifest.json with entry. Controller extensions allow users to extensiate default behaviour with custom controllers code.',
     parameters: Object.values(getParameters())

package/dist/tools/functionalities/functionalities.js

@@ -4,6 +4,7 @@ exports.FUNCTIONALITIES_HANDLERS = exports.FUNCTIONALITIES_DETAILS = void 0;
 const page_1 = require("./page");
 const controller_extension_1 = require("./controller-extension");
 const generate_fiori_ui_app_1 = require("./generate-fiori-ui-app");
+const constant_1 = require("../../constant");
 exports.FUNCTIONALITIES_DETAILS = [
     page_1.ADD_PAGE_FUNCTIONALITY,
     generate_fiori_ui_app_1.GENERATE_FIORI_UI_APP,
@@ -11,9 +12,9 @@ exports.FUNCTIONALITIES_DETAILS = [
     controller_extension_1.CREATE_CONTROLLER_EXTENSION_FUNCTIONALITY
 ];
 exports.FUNCTIONALITIES_HANDLERS = new Map([
-    [page_1.ADD_PAGE_FUNCTIONALITY.functionalityId, page_1.addPageHandlers],
-    [page_1.DELETE_PAGE_FUNCTIONALITY.functionalityId, page_1.deletePageHandlers],
-    [generate_fiori_ui_app_1.GENERATE_FIORI_UI_APP.functionalityId, generate_fiori_ui_app_1.generateFioriUIAppHandlers],
-    [controller_extension_1.CREATE_CONTROLLER_EXTENSION_FUNCTIONALITY.functionalityId, controller_extension_1.createControllerExtensionHandlers]
+    [constant_1.ADD_PAGE, page_1.addPageHandlers],
+    [constant_1.DELETE_PAGE, page_1.deletePageHandlers],
+    [constant_1.GENERATE_FIORI_UI_APP_ID, generate_fiori_ui_app_1.generateFioriUIAppHandlers],
+    [constant_1.CREATE_CONTROLLER_EXTENSION_FUNCTIONALITY_ID, controller_extension_1.createControllerExtensionHandlers]
 ]);
 //# sourceMappingURL=functionalities.js.map

package/dist/tools/functionalities/page/add-page.js

@@ -7,6 +7,7 @@ const utils_1 = require("../../utils");
 const constant_1 = require("../../../constant");
 const page_editor_api_1 = require("../../../page-editor-api");
 const src_1 = require("@sap/ux-specification/dist/types/src");
+const types_1 = require("./types");
 /**
  * Retrieves the details of the Add Page functionality.
  *
@@ -43,10 +44,18 @@ async function executeFunctionality(params) {
     const parentPage = typeof parameters.parentPage === 'string' ? parameters.parentPage : undefined;
     const entitySet = typeof parameters.entitySet === 'string' ? parameters.entitySet : undefined;
     const pageNavigation = typeof parameters.pageNavigation === 'string' ? parameters.pageNavigation : undefined;
-    const viewName = typeof parameters.pageViewName === 'string' ? parameters.pageViewName : 'CustomView';
+    const viewName = typeof parameters.pageViewName === 'string' ? parameters.pageViewName : '';
     if (!pageType) {
         throw new Error('Missing or invalid parameter "pageType"');
     }
+    if (pageType === src_1.PageTypeV4.CustomPage) {
+        if (!viewName) {
+            throw new Error('Missing value for parameter "pageViewName"');
+        }
+        else if (!types_1.PAGE_VIEW_NAME_PATTERN.exec(viewName)) {
+            throw new Error(`Invalid parameter "pageViewName". Parameter "pageViewName" should match pattern "${types_1.PAGE_VIEW_NAME_PATTERN.toString()}"`);
+        }
+    }
     const appDetails = await (0, utils_1.resolveApplication)(appPath);
     if (!appDetails?.applicationAccess) {
         return {

package/dist/tools/functionalities/page/application.d.ts

@@ -181,10 +181,9 @@ export declare class Application {
     /**
      * Retrieves creation options for a new page.
      *
-     * @param pageType - Optional page type to get specific creation options.
      * @returns A promise that resolves to GetFunctionalityDetailsOutput containing creation options.
      */
-    getCreationOptions(pageType?: string): Promise<GetFunctionalityDetailsOutput>;
+    getCreationOptions(): Promise<GetFunctionalityDetailsOutput>;
     /**
      * Creates a new page in the application.
      *

package/dist/tools/functionalities/page/application.js

@@ -278,7 +278,8 @@ class Application {
             id,
             entity: targetNavigation?.entitySet ?? entitySet ?? '',
             navigation: fpnNavigation,
-            contextPath
+            contextPath,
+            name: newPage.pageType === src_1.PageTypeV4.CustomPage ? viewName : undefined
         };
         const changes = await this.writeFPM(newPage.pageType, pageApi, viewName);
         return { pageID: id, changes };
@@ -430,10 +431,9 @@ class Application {
     /**
      * Retrieves creation options for a new page.
      *
-     * @param pageType - Optional page type to get specific creation options.
      * @returns A promise that resolves to GetFunctionalityDetailsOutput containing creation options.
      */
-    async getCreationOptions(pageType) {
+    async getCreationOptions() {
         exports.ADD_PAGE_FUNCTIONALITY.parameters = [];
         const pages = this.getPages();
         if (pages.length) {
@@ -446,15 +446,6 @@ class Application {
                 // Pass with refresh only once
                 refreshNavigations = false;
             }
-            if (pageType === src_1.PageTypeV4.CustomPage) {
-                exports.ADD_PAGE_FUNCTIONALITY.parameters.push({
-                    id: 'pageViewName',
-                    type: 'string',
-                    description: `Name of custom view file. First try to extract view name from user input that satisfies the pattern, if not possible ask user to provide view name`,
-                    pattern: '/^[a-zA-Z][a-zA-Z0-9_-]{0,}$/i',
-                    required: true
-                });
-            }
             exports.ADD_PAGE_FUNCTIONALITY.parameters = [
                 {
                     id: 'parentPage',
@@ -476,8 +467,15 @@ class Application {
                     id: 'pageType',
                     type: 'string',
                     description: `Type of page to be created. First try to extract page type from user input in a format defined in example, if not possible suggest content defined in options.`,
-                    options: Object.keys(src_1.PageTypeV4),
-                    examples: ['pageType: ' + Object.keys(src_1.PageTypeV4)[0]],
+                    options: [src_1.PageTypeV4.ListReport, src_1.PageTypeV4.ObjectPage, src_1.PageTypeV4.CustomPage],
+                    examples: ['pageType: ' + src_1.PageTypeV4.ObjectPage],
+                    required: true
+                },
+                {
+                    id: 'pageViewName',
+                    type: 'string',
+                    description: `Required if pageType is "CustomPage". Name of custom view file. First try to extract view name from user input that satisfies the pattern, if not possible ask user to provide view name`,
+                    pattern: types_1.PAGE_VIEW_NAME_PATTERN.toString(),
                     required: true
                 }
             ];

package/dist/tools/functionalities/page/types.d.ts

@@ -39,4 +39,5 @@ export declare enum MissingNavigationReason {
     NoEntityProvided = 3,
     NotFoundEntity = 4
 }
+export declare const PAGE_VIEW_NAME_PATTERN: RegExp;
 //# sourceMappingURL=types.d.ts.map

package/dist/tools/functionalities/page/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MissingNavigationReason = void 0;
+exports.PAGE_VIEW_NAME_PATTERN = exports.MissingNavigationReason = void 0;
 var MissingNavigationReason;
 (function (MissingNavigationReason) {
     MissingNavigationReason[MissingNavigationReason["NoAnyNavigationsForParent"] = 1] = "NoAnyNavigationsForParent";
@@ -8,4 +8,5 @@ var MissingNavigationReason;
     MissingNavigationReason[MissingNavigationReason["NoEntityProvided"] = 3] = "NoEntityProvided";
     MissingNavigationReason[MissingNavigationReason["NotFoundEntity"] = 4] = "NotFoundEntity";
 })(MissingNavigationReason || (exports.MissingNavigationReason = MissingNavigationReason = {}));
+exports.PAGE_VIEW_NAME_PATTERN = /^[A-Za-z][A-Za-z0-9_-]*$/;
 //# sourceMappingURL=types.js.map

package/dist/tools/get-functionality-details.d.ts

@@ -1,4 +1,4 @@
-import type { GetFunctionalityDetailsInput, GetFunctionalityDetailsOutput } from '../types';
+import type { FunctionalityId, GetFunctionalityDetailsInput, GetFunctionalityDetailsOutput } from '../types';
 import type { PropertyPath } from '../page-editor-api';
 /**
  * Retrieves functionality details based on the provided input parameters.
@@ -17,7 +17,7 @@ export declare function getFunctionalityDetails(params: GetFunctionalityDetailsI
  * @returns An object containing the resolved page name (if applicable) and property path.
  * @throws Error if the functionalityId parameter has an invalid format.
  */
-export declare function resolveFunctionality(functionalityId: string | string[]): {
+export declare function resolveFunctionality(functionalityId: FunctionalityId): {
     pageName?: string;
     propertyPath: PropertyPath;
 };

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

@@ -3,14 +3,14 @@
     "properties": {
         "functionalityId": {
             "anyOf": [
+                {
+                    "type": "string"
+                },
                 {
                     "type": "array",
                     "items": {
                         "type": ["string", "number"]
                     }
-                },
-                {
-                    "type": "string"
                 }
             ],
             "description": "Identifier to pass as the `functionalityId` parameter when calling `get-functionality-details` or `execute-functionality`"
@@ -61,11 +61,23 @@
                                 },
                                 {
                                     "not": {}
+                                },
+                                {
+                                    "type": "null"
                                 }
                             ]
                         }
                     },
                     "currentValue": {},
+                    "examples": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "pattern": {
+                        "type": "string"
+                    },
                     "parameters": {
                         "type": "array",
                         "items": {
@@ -103,11 +115,23 @@
                                             },
                                             {
                                                 "not": {}
+                                            },
+                                            {
+                                                "type": "null"
                                             }
                                         ]
                                     }
                                 },
-                                "currentValue": {}
+                                "currentValue": {},
+                                "examples": {
+                                    "type": "array",
+                                    "items": {
+                                        "type": "string"
+                                    }
+                                },
+                                "pattern": {
+                                    "type": "string"
+                                }
                             },
                             "required": ["id", "type"],
                             "additionalProperties": false
@@ -137,6 +161,6 @@
             "type": "string"
         }
     },
-    "required": ["id", "name", "description", "parameters"],
+    "required": ["functionalityId", "name", "description", "parameters"],
     "additionalProperties": false
 }

package/dist/types.d.ts

@@ -39,14 +39,14 @@ export interface GetFunctionalityDetailsInput {
     /** Path to the Fiori application */
     appPath: string;
     /** ID or array of IDs of the functionality(ies) */
-    functionalityId: string | string[];
+    functionalityId: FunctionalityId;
 }
 /**
  * Output interface for the 'get-functionality-details' functionality
  */
 export interface GetFunctionalityDetailsOutput {
     /** ID of the functionality */
-    functionalityId: string;
+    functionalityId: FunctionalityId;
     /** Name of the functionality */
     name: string;
     /** Description of the functionality */
@@ -69,7 +69,7 @@ export interface GetFunctionalityDetailsOutput {
  */
 export interface ExecuteFunctionalitiesInput {
     /** ID or array of IDs of the functionality(ies) to execute */
-    functionalityId: string | string[];
+    functionalityId: FunctionalityId;
     /** Parameters for the functionality execution */
     parameters: {
         [key: string]: unknown;
@@ -82,7 +82,7 @@ export interface ExecuteFunctionalitiesInput {
  */
 export interface ExecuteFunctionalityOutput {
     /** ID or array of IDs of the executed functionality(ies) */
-    functionalityId: string | string[];
+    functionalityId: FunctionalityId;
     /** Status of the execution */
     status: string;
     /** Message describing the execution result */
@@ -116,10 +116,14 @@ export interface FioriApp {
  */
 export interface Functionality {
     /** ID or array of IDs for the functionality */
-    functionalityId: Array<string | number> | string;
+    functionalityId: FunctionalityId;
     /** Description of the functionality */
     description: string;
 }
+/**
+ * Type for functionality id
+ */
+export type FunctionalityId = Array<string | number> | string;
 /**
  * Interface representing a parameter
  */
@@ -137,7 +141,7 @@ export interface Parameter {
     /** Default value of the parameter */
     defaultValue?: unknown;
     /** Possible options for the parameter */
-    options?: Array<string | number | boolean | undefined>;
+    options?: Array<string | number | boolean | undefined | null>;
     /** Current value of the parameter */
     currentValue?: unknown;
     /** Examples for the parameter */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-mcp-server",
   "description": "SAP Fiori - Model Context Protocol (MCP) server",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "keywords": [
     "SAP Fiori tools",
     "SAP Fiori elements",
@@ -30,10 +30,10 @@
   "devDependencies": {
     "@types/json-schema": "7.0.5",
     "@types/mem-fs": "1.1.2",
-    "@sap-ux/i18n": "0.3.3",
-    "@sap-ux/odata-annotation-core-types": "0.4.5",
+    "@sap-ux/text-document-utils": "0.3.1",
     "@sap-ux/odata-entity-model": "0.3.1",
-    "@sap-ux/text-document-utils": "0.3.1"
+    "@sap-ux/odata-annotation-core-types": "0.4.5",
+    "@sap-ux/i18n": "0.3.3"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "1.17.4",
@@ -41,9 +41,9 @@
     "@sap-ux/annotation-converter": "0.10.3",
     "i18next": "25.3.0",
     "zod": "4.1.5",
+    "@sap-ux/project-access": "1.30.13",
     "@sap-ux/fiori-annotation-api": "0.6.17",
-    "@sap-ux/nodejs-utils": "0.2.3",
-    "@sap-ux/project-access": "1.30.13"
+    "@sap-ux/nodejs-utils": "0.2.3"
   },
   "engines": {
     "node": ">=20.x"