@sap-ux/fiori-mcp-server 0.0.1

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

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADD_PAGE_FUNCTIONALITY = exports.addPageHandlers = void 0;
+const application_1 = require("./application");
+Object.defineProperty(exports, "ADD_PAGE_FUNCTIONALITY", { enumerable: true, get: function () { return application_1.ADD_PAGE_FUNCTIONALITY; } });
+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");
+/**
+ * Retrieves the details of the Add Page functionality.
+ *
+ * @param params - The input parameters for getting functionality details.
+ * @returns A promise that resolves to the functionality details output.
+ */
+async function getFunctionalityDetails(params) {
+    const { appPath } = params;
+    const appDetails = await (0, utils_1.resolveApplication)(appPath);
+    if (!appDetails?.applicationAccess) {
+        return {
+            functionalityId: constant_1.ADD_PAGE,
+            name: 'Invalid Project Root or Application Path',
+            description: `To add a new page, provide a valid project root or application path. "${appPath}" is not valid`,
+            parameters: []
+        };
+    }
+    const { appId, applicationAccess } = appDetails;
+    const ftfsFileIo = new page_editor_api_1.SapuxFtfsFileIO(applicationAccess);
+    const appData = await ftfsFileIo.readApp();
+    const serviceName = await (0, page_editor_api_1.getServiceName)(applicationAccess);
+    const application = new application_1.Application({ params, applicationAccess, serviceName, appId, appData });
+    return application.getCreationOptions();
+}
+/**
+ * Executes the Add Page functionality.
+ *
+ * @param params - The input parameters for executing the functionality.
+ * @returns A promise that resolves to the execution output.
+ */
+async function executeFunctionality(params) {
+    const { appPath, parameters } = params;
+    const pageType = isValidPageTypeV4(parameters.pageType) ? parameters.pageType : undefined;
+    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';
+    if (!pageType) {
+        throw new Error('Missing or invalid parameter "pageType"');
+    }
+    const appDetails = await (0, utils_1.resolveApplication)(appPath);
+    if (!appDetails?.applicationAccess) {
+        return {
+            functionalityId: constant_1.ADD_PAGE,
+            status: 'Failed',
+            message: `Project root not found for app path: ${appPath}`,
+            parameters: [],
+            appPath: appPath,
+            changes: [],
+            timestamp: new Date().toISOString()
+        };
+    }
+    const { appId, applicationAccess } = appDetails;
+    const ftfsFileIo = new page_editor_api_1.SapuxFtfsFileIO(applicationAccess);
+    const appData = await ftfsFileIo.readApp();
+    const serviceName = await (0, page_editor_api_1.getServiceName)(applicationAccess);
+    const application = new application_1.Application({ params, applicationAccess, serviceName, appId, appData });
+    return application.createPage({
+        pageType: pageType,
+        parent: parentPage,
+        navigation: pageNavigation,
+        entitySet: entitySet,
+        viewName: viewName
+    });
+}
+/**
+ * Type guard to check whether a given value is a valid PageTypeV4 for new pages.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is one of the valid `PageTypeV4` literals.
+ */
+function isValidPageTypeV4(value) {
+    return (typeof value === 'string' &&
+        [src_1.PageTypeV4.ObjectPage, src_1.PageTypeV4.ListReport, src_1.PageTypeV4.CustomPage].includes(value));
+}
+exports.addPageHandlers = {
+    getFunctionalityDetails,
+    executeFunctionality
+};
+//# sourceMappingURL=add-page.js.map

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

@@ -0,0 +1,212 @@
+import type { ApplicationAccess } from '@sap-ux/project-access';
+import { type AppData } from '../../../page-editor-api';
+import type { ExecuteFunctionalityOutput, GetFunctionalityDetailsInput, GetFunctionalityDetailsOutput } from '../../../types';
+import type { NewPage, PageDef, AllowedNavigationOptions } from './types';
+export declare const ADD_PAGE_FUNCTIONALITY: GetFunctionalityDetailsOutput;
+export declare const DELETE_PAGE_FUNCTIONALITY: GetFunctionalityDetailsOutput;
+/**
+ * Represents an application instance with its metadata, access configuration and functionality details.
+ */
+export declare class Application {
+    private readonly serviceName;
+    private readonly appData;
+    private readonly appId;
+    private readonly applicationAccess;
+    private readonly params;
+    /**
+     * Creates a new instance of the Application class.
+     *
+     * @param root0 - The constructor arguments.
+     * @param root0.params - Input parameters for functionality details.
+     * @param root0.applicationAccess - The application access object.
+     * @param root0.appId - The unique identifier of the application.
+     * @param root0.serviceName - The service name associated with the application.
+     * @param root0.appData - Metadata and configuration data for the application.
+     */
+    constructor({ params, applicationAccess, appId, serviceName, appData }: {
+        params: GetFunctionalityDetailsInput;
+        applicationAccess: ApplicationAccess;
+        appId: string;
+        serviceName: string;
+        appData: AppData;
+    });
+    /**
+     * Gets the name of an allowed navigation option.
+     *
+     * @param navigation - The allowed navigation option.
+     * @returns The name of the navigation option.
+     */
+    private getAllowedNavigationsName;
+    /**
+     * Generates a string representation of all allowed navigation options.
+     *
+     * @param navigations - An array of allowed navigation options.
+     * @returns A comma-separated string of navigation names.
+     */
+    private getAllowedNavigationsOutput;
+    /**
+     * Generates an error message for missing navigation.
+     *
+     * @param reason - The reason for the missing navigation.
+     * @param navigations - An array of allowed navigation options.
+     * @param parentPageId - Optional ID of the parent page.
+     * @returns An error message string.
+     */
+    private getMissingNavigationMessage;
+    /**
+     * Calculates the context path for a page.
+     *
+     * @param parentPage - Optional parent page definition.
+     * @param navigationProperty - Optional navigation property.
+     * @param entitySet - Optional entity set.
+     * @returns The calculated context path or undefined.
+     */
+    private calculateContextPath;
+    /**
+     * Calculates the context path based on the entity set of the parent page.
+     *
+     * @param parentPage - The parent page definition.
+     * @param navigationProperty - Optional navigation property.
+     * @returns The calculated context path or undefined.
+     */
+    private calculateContextPathBasedOnEntitySet;
+    /**
+     * Creates an error response object.
+     *
+     * @param message - The error message.
+     * @returns An ExecuteFunctionalityOutput object with error details.
+     */
+    private createErrorResponse;
+    /**
+     * Validates the input for page creation.
+     *
+     * @param newPage - The new page details.
+     * @param pages - Existing pages in the application.
+     * @param viewName - Optional view name for custom pages.
+     * @returns A promise that resolves to an ExecuteFunctionalityOutput object if there's an error, or null if validation passes.
+     */
+    private validatePageCreationInput;
+    /**
+     * Validates the view name for a custom page.
+     *
+     * @param viewName - The view name to validate.
+     * @returns An ExecuteFunctionalityOutput object if there's an error, or null if validation passes.
+     */
+    private validateCustomPageViewName;
+    /**
+     * Validates the navigation input for page creation.
+     *
+     * @param parentPage - The parent page definition, if any.
+     * @param navigation - Optional navigation string.
+     * @param entitySet - Optional entity set.
+     * @param pages - Array of existing page definitions.
+     * @returns A promise that resolves to an ExecuteFunctionalityOutput object if there's an error, or null if validation passes.
+     */
+    private validateNavigationInput;
+    /**
+     * Finds the target navigation option based on the provided navigation or entity set.
+     *
+     * @param navigations - Array of allowed navigation options.
+     * @param navigation - Optional navigation string to search for.
+     * @param entitySet - Optional entity set to search for.
+     * @returns The matching AllowedNavigationOptions object or undefined if not found.
+     */
+    private findTargetNavigation;
+    /**
+     * Generates a new page using the FPM writer.
+     *
+     * @param newPage - The new page details.
+     * @param parentPage - The parent page, if any.
+     * @param targetNavigation - The target navigation option.
+     * @param pages - Existing pages in the application.
+     * @param viewName - Optional view name for custom pages.
+     * @param entitySet - Optional entity set for the new page.
+     * @returns A promise that resolves to an object containing the new page ID and changes made.
+     */
+    private generatePageWithFPMWriter;
+    /**
+     * Writes the Flexible Programming Model (FPM) configuration.
+     *
+     * @param pageType - The type of the page.
+     * @param fpmData - The page API configuration.
+     * @param viewName - Optional view name for custom pages.
+     * @returns A promise that resolves to an array of strings representing the changes made.
+     */
+    private writeFPM;
+    /**
+     * Deletes navigation links for a given page.
+     *
+     * @param navigation - The navigation object containing links.
+     * @param pageName - The name of the page to remove links for.
+     */
+    private deleteNavigationLinks;
+    /**
+     * Function to evaluate the navigation entry of a page.
+     * Old format (spec version <=3): <target page name>: <route name>.
+     * New format (spec version >=4): <route name>: { route: <target page name>}.
+     *
+     * @param pageObjNavigation - Page data.
+     * @param key - key in schema for the route definition.
+     * @returns the target page name from the route definition.
+     */
+    private findPageByNavigation;
+    /**
+     * Method which deletes pages recursively by looping through navigation.
+     *
+     * @param app - Content of 'app.json'.
+     * @param pageName - page's name to remove
+     */
+    private deletePageRecursively;
+    /**
+     * Retrieves all pages defined in the application.
+     *
+     * @returns An array of PageDef objects representing the pages in the application.
+     */
+    getPages(): PageDef[];
+    /**
+     * Retrieves allowed navigation options for a given parent page.
+     *
+     * @param parentPage - Optional parent page definition.
+     * @param refresh - Whether to refresh the data from the service.
+     * @returns A promise that resolves to an array of AllowedNavigationOptions.
+     */
+    getAllowedNavigations(parentPage?: PageDef, refresh?: boolean): Promise<AllowedNavigationOptions[]>;
+    /**
+     * Retrieves navigation options for the root page.
+     *
+     * @param refresh - Whether to refresh the data from the service.
+     * @returns A promise that resolves to an array of AllowedNavigationOptions.
+     */
+    getRootPageNavigationOptions(refresh?: boolean): Promise<AllowedNavigationOptions[]>;
+    /**
+     * 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>;
+    /**
+     * Creates a new page in the application.
+     *
+     * @param newPage - Details of the new page to be created.
+     * @returns A promise that resolves to ExecuteFunctionalityOutput containing the result of the page creation.
+     */
+    createPage(newPage: NewPage): Promise<ExecuteFunctionalityOutput>;
+    /**
+     * Retrieves options for deleting a page.
+     *
+     * @returns A promise that resolves to GetFunctionalityDetailsOutput containing delete options.
+     */
+    getDeleteOptions(): Promise<GetFunctionalityDetailsOutput>;
+    /**
+     * Deletes a page from the application.
+     *
+     * @param page - The page to be deleted.
+     * @param page.pageId - The ID of the page to be deleted.
+     * @returns A promise that resolves to ExecuteFunctionalityOutput containing the result of the page deletion.
+     */
+    deletePage(page: {
+        pageId: string;
+    }): Promise<ExecuteFunctionalityOutput>;
+}
+//# sourceMappingURL=application.d.ts.map