@sap-ux/fiori-mcp-server 0.0.1

package/dist/page-editor-api/parser/model/views/ViewAggregation.js

@@ -0,0 +1,112 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewAggregation = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const ObjectAggregation_1 = require("../ObjectAggregation");
+const types_1 = require("../types");
+/**
+ * Represents an aggregation for view objects.
+ */
+class ViewAggregation extends ObjectAggregation_1.ObjectAggregation {
+    title;
+    actions = [];
+    sortableItem = types_1.SortingOptions.Enabled;
+    sortableCollection = 'views';
+    /**
+     * Creates an instance of `ViewAggregation`.
+     *
+     * @param data Optional aggregation data object used to initialize properties.
+     * @param schema Optional JSON schema fragment associated with this aggregation.
+     */
+    constructor(data, schema) {
+        super(data, schema);
+        if (schema?.key && !schema.annotationPath && !schema.properties?.['annotationPath']) {
+            // Custom view - generate annotation path, because it is not provided by schema
+            schema.annotationPath = `${types_1.CUSTOM_VIEW_PREFIX}${schema.key})`;
+        }
+    }
+    /**
+     * Method returns display name of aggregation without applying i18n translation.
+     * Overwritten for column handling.
+     *
+     * @returns Display name of aggregation.
+     */
+    getRawDisplayName() {
+        return this.title || super.getRawDisplayName();
+    }
+    /**
+     * Public method to mark view as custom action.
+     */
+    markAsCustomView() {
+        this.custom = true;
+        this.actions = [types_1.AggregationActions.Delete, types_1.AggregationActions.OpenSource];
+        this.sortableItem = types_1.SortingOptions.Enabled;
+        this.additionalText = i18next_1.default.t('PAGE_EDITOR_OUTLINE_NODE_DESC_CUSTOM_VIEW');
+        this.i18nKey = this.parent?.i18nKey;
+        if (this.properties.label?.value) {
+            this.title = this.properties.label.value;
+        }
+    }
+    /**
+     * Overwritten method for data update of list report view.
+     *
+     * @param data Data which should be used for value population.
+     * @param page Page config data.
+     * @param pageType Page type.
+     * @param path Aggregation path.
+     * @param annotations Annotations data.
+     */
+    updatePropertiesValues(data, page, pageType, path, annotations) {
+        super.updatePropertiesValues(data, page, pageType, path, annotations);
+        // Update icon
+        if (this.isTableView()) {
+            this.icon = 'Table';
+        }
+        else if (this.isChartView()) {
+            this.icon = 'Chart';
+        }
+        else {
+            this.icon = 'Sections';
+        }
+        // validate annotation path property
+        if (this.isAnnotationView() && !this.schema?.['annotationPath'] && this.properties['annotationPath']) {
+            // set warning for annotation path property
+            this.properties['annotationPath'].messages = [
+                {
+                    type: types_1.PropertyMessageType.Warning,
+                    text: i18next_1.default.t('PAGE_EDITOR_PROPERTIES_VIEW_NO_ANNOTATION_PATH')
+                }
+            ];
+        }
+    }
+    /**
+     * Method returns true if view aggregation is table view.
+     *
+     * @returns True if view is table view.
+     */
+    isTableView() {
+        return 'columns' in this.aggregations;
+    }
+    /**
+     * Method returns true if view aggregation is chart view.
+     *
+     * @returns True if view is chart view.
+     */
+    isChartView() {
+        return !('columns' in this.aggregations) && 'toolBar' in this.aggregations;
+    }
+    /**
+     * Method returns true if aggregation is annotation view.
+     *
+     * @returns True if view is annotation view.
+     */
+    isAnnotationView() {
+        return ((!this.custom && 'annotationPath' in this.properties) ||
+            (!this.custom && this.schema?.annotationPath && !this.schema?.annotationPath.startsWith(types_1.CUSTOM_VIEW_PREFIX)));
+    }
+}
+exports.ViewAggregation = ViewAggregation;
+//# sourceMappingURL=ViewAggregation.js.map

package/dist/page-editor-api/parser/model/views/ViewsAggregation.d.ts

@@ -0,0 +1,54 @@
+import { ObjectAggregation } from '../ObjectAggregation';
+import type { PageData, PageAnnotations, PropertyPath } from '../types';
+import { AggregationCreationForm } from '../types';
+import { ViewAggregation } from './ViewAggregation';
+import type { PageConfig, PageType } from '@sap/ux-specification/dist/types/src';
+/**
+ * Represents an aggregation for views objects.
+ */
+export declare class ViewsAggregation extends ObjectAggregation {
+    sortableList: boolean;
+    childClass: typeof ViewAggregation;
+    allowedAnnotationCreationForms: AggregationCreationForm[];
+    sortableCollection: string | undefined;
+    sortableConfigOnly: boolean;
+    i18nKey: string;
+    /**
+     * Refreshes internal data based on latest annotation node data.
+     *
+     * @param annotations
+     */
+    updateAnnotationData(annotations: PageAnnotations | undefined): void;
+    /**
+     * Overwritten method for data update of list report views container node.
+     *
+     * @param data Data which should be used for value population.
+     * @param page Page config data.
+     * @param pageType Page type.
+     * @param path Aggregation path.
+     * @param annotations Annotations data.
+     */
+    updatePropertiesValues(data: PageData, page: PageConfig, pageType: PageType, path: PropertyPath, annotations: PageAnnotations | undefined): void;
+    /**
+     * Determines the delete action configuration for a given view aggregation.
+     *
+     * @param viewAggregation - The view aggregation to evaluate.
+     * @param annotations - The current page annotations context.
+     * @returns The delete action configuration for the view.
+     */
+    private getViewDeleteAction;
+    /**
+     * Enables/Disables the chart form based on the annotations.
+     *
+     * @param forms Array of creation forms
+     * @param annotations Page annotations
+     */
+    private toggleChartForm;
+    /**
+     * Method returns count of annotations views.
+     *
+     * @returns Count of annotations views.
+     */
+    private getAnnotationViewCount;
+}
+//# sourceMappingURL=ViewsAggregation.d.ts.map

package/dist/page-editor-api/parser/model/views/ViewsAggregation.js

@@ -0,0 +1,141 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewsAggregation = void 0;
+const ObjectAggregation_1 = require("../ObjectAggregation");
+const types_1 = require("../types");
+const ViewAggregation_1 = require("./ViewAggregation");
+const i18next_1 = __importDefault(require("i18next"));
+const utils_1 = require("../utils");
+/**
+ * Represents an aggregation for views objects.
+ */
+class ViewsAggregation extends ObjectAggregation_1.ObjectAggregation {
+    sortableList = true;
+    childClass = ViewAggregation_1.ViewAggregation;
+    allowedAnnotationCreationForms = [
+        types_1.AggregationCreationForm.TableView,
+        types_1.AggregationCreationForm.AnalyticalChartView,
+        types_1.AggregationCreationForm.CustomViewV4
+    ];
+    sortableCollection = 'views';
+    sortableConfigOnly = true;
+    // i18n key
+    i18nKey = 'VIEWS';
+    /**
+     * Refreshes internal data based on latest annotation node data.
+     *
+     * @param annotations
+     */
+    updateAnnotationData(annotations) {
+        super.updateAnnotationData(annotations);
+        if (annotations) {
+            this.toggleChartForm(this.annotationCreationForms, annotations);
+            for (const view in this.aggregations) {
+                const viewAggregation = this.aggregations[view];
+                const deleteAction = this.getViewDeleteAction(viewAggregation, annotations);
+                const actions = viewAggregation.actions || [];
+                actions.push(deleteAction);
+                viewAggregation.actions = actions;
+            }
+        }
+    }
+    /**
+     * Overwritten method for data update of list report views container node.
+     *
+     * @param data Data which should be used for value population.
+     * @param page Page config data.
+     * @param pageType Page type.
+     * @param path Aggregation path.
+     * @param annotations Annotations data.
+     */
+    updatePropertiesValues(data, page, pageType, path, annotations) {
+        super.updatePropertiesValues(data, page, pageType, path, annotations);
+        this.formSchema = this.additionalProperties?.aggregations['views'];
+        // Custom creation form - check schema if supported
+        if (this.formSchema?.properties?.template) {
+            this.schemaCreationForms = [
+                {
+                    name: types_1.AggregationCreationForm.CustomViewV4,
+                    kind: types_1.SCHEMA_CREATION_FORM,
+                    title: 'PAGE_EDITOR_OUTLINE_ADD_CUSTOM_VIEW_TITLE',
+                    disabled: false
+                }
+            ];
+        }
+        const views = data || {};
+        if (Object.keys(views).length !== 0) {
+            for (const id in views) {
+                const viewAggregation = this.aggregations[id];
+                if (viewAggregation?.schema &&
+                    !viewAggregation?.schema.properties?.['annotationPath'] &&
+                    (!viewAggregation.schema.annotationPath ||
+                        viewAggregation.schema.annotationPath.startsWith(types_1.CUSTOM_VIEW_PREFIX))) {
+                    viewAggregation.markAsCustomView();
+                }
+            }
+        }
+    }
+    /**
+     * Determines the delete action configuration for a given view aggregation.
+     *
+     * @param viewAggregation - The view aggregation to evaluate.
+     * @param annotations - The current page annotations context.
+     * @returns The delete action configuration for the view.
+     */
+    getViewDeleteAction(viewAggregation, annotations) {
+        const id = viewAggregation.annotationNodeId;
+        let disableViewDeletion = true;
+        const annotationViewsCount = this.getAnnotationViewCount();
+        if (id) {
+            disableViewDeletion = (0, utils_1.isArrayEqual)(annotations.dialogsContext?.suppressTableViewDeletionNodeId || [], id);
+        }
+        else if (annotationViewsCount > 1 || (annotationViewsCount === 1 && viewAggregation.custom)) {
+            // Allow annotation view deletion if there are at least two annotation views, else deletion only available for custom views
+            disableViewDeletion = false;
+        }
+        return {
+            type: types_1.AggregationActions.Delete,
+            disabled: disableViewDeletion,
+            title: i18next_1.default.t(disableViewDeletion ? 'TABLE_VIEW_DELETE_DISABLED_TOOLTIP' : 'PAGE_EDITOR_OUTLINE_DELETE_TOOLTIP')
+        };
+    }
+    /**
+     * Enables/Disables the chart form based on the annotations.
+     *
+     * @param forms Array of creation forms
+     * @param annotations Page annotations
+     */
+    toggleChartForm(forms, annotations) {
+        const chartForm = forms.find((form) => form.name === types_1.AggregationCreationForm.AnalyticalChartView);
+        if (chartForm && annotations.dialogsContext?.analyticalChartSupport) {
+            if (!annotations.dialogsContext.analyticalChartSupport.addToMultiViewEnabled) {
+                chartForm.disabled = true;
+                chartForm.disabledTitle = annotations.dialogsContext.analyticalChartSupport.addToMultiViewTooltip;
+            }
+            else {
+                chartForm.disabled = false;
+                delete chartForm.disabledTitle;
+            }
+        }
+    }
+    /**
+     * Method returns count of annotations views.
+     *
+     * @returns Count of annotations views.
+     */
+    getAnnotationViewCount() {
+        let count = 0;
+        for (const view in this.aggregations) {
+            const aggregation = this.aggregations[view];
+            if (aggregation instanceof ViewAggregation_1.ViewAggregation && aggregation.isAnnotationView()) {
+                count++;
+            }
+        }
+        return count;
+    }
+}
+exports.ViewsAggregation = ViewsAggregation;
+//# sourceMappingURL=ViewsAggregation.js.map

package/dist/page-editor-api/parser/model/views/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ViewAggregation';
+export * from './ViewsAggregation';
+//# sourceMappingURL=index.d.ts.map

package/dist/page-editor-api/parser/model/views/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ViewAggregation"), exports);
+__exportStar(require("./ViewsAggregation"), exports);
+//# sourceMappingURL=index.js.map

package/dist/page-editor-api/parser/model/visual-filters/VisualFilterAggregation.d.ts

@@ -0,0 +1,11 @@
+import { ObjectAggregation } from '../ObjectAggregation';
+import { AggregationActions } from '../types';
+/**
+ * Represents an aggregation for visual filter objects.
+ */
+export declare class VisualFilterAggregation extends ObjectAggregation {
+    sortableCollection: string | undefined;
+    actions: AggregationActions[];
+    isViewNode: boolean;
+}
+//# sourceMappingURL=VisualFilterAggregation.d.ts.map

package/dist/page-editor-api/parser/model/visual-filters/VisualFilterAggregation.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisualFilterAggregation = void 0;
+const ObjectAggregation_1 = require("../ObjectAggregation");
+const types_1 = require("../types");
+/**
+ * Represents an aggregation for visual filter objects.
+ */
+class VisualFilterAggregation extends ObjectAggregation_1.ObjectAggregation {
+    sortableCollection = 'visualFilters';
+    actions = [types_1.AggregationActions.Delete];
+    isViewNode = true;
+}
+exports.VisualFilterAggregation = VisualFilterAggregation;
+//# sourceMappingURL=VisualFilterAggregation.js.map

package/dist/page-editor-api/parser/model/visual-filters/VisualFiltersAggregation.d.ts

@@ -0,0 +1,11 @@
+import { ObjectAggregation } from '../ObjectAggregation';
+import { VisualFilterAggregation } from './VisualFilterAggregation';
+/**
+ * Represents an aggregation for visual filters objects.
+ */
+export declare class VisualFiltersAggregation extends ObjectAggregation {
+    sortableList: boolean;
+    childClass: typeof VisualFilterAggregation;
+    i18nKey: string;
+}
+//# sourceMappingURL=VisualFiltersAggregation.d.ts.map

package/dist/page-editor-api/parser/model/visual-filters/VisualFiltersAggregation.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisualFiltersAggregation = void 0;
+const ObjectAggregation_1 = require("../ObjectAggregation");
+const VisualFilterAggregation_1 = require("./VisualFilterAggregation");
+/**
+ * Represents an aggregation for visual filters objects.
+ */
+class VisualFiltersAggregation extends ObjectAggregation_1.ObjectAggregation {
+    sortableList = true;
+    childClass = VisualFilterAggregation_1.VisualFilterAggregation;
+    i18nKey = 'VISUAL_FILTERS';
+}
+exports.VisualFiltersAggregation = VisualFiltersAggregation;
+//# sourceMappingURL=VisualFiltersAggregation.js.map

package/dist/page-editor-api/parser/model/visual-filters/index.d.ts

@@ -0,0 +1,3 @@
+export * from './VisualFilterAggregation';
+export * from './VisualFiltersAggregation';
+//# sourceMappingURL=index.d.ts.map

package/dist/page-editor-api/parser/model/visual-filters/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./VisualFilterAggregation"), exports);
+__exportStar(require("./VisualFiltersAggregation"), exports);
+//# sourceMappingURL=index.js.map

package/dist/page-editor-api/parser/tree.d.ts

@@ -0,0 +1,135 @@
+import type { ArtifactType, PageConfig } from '@sap/ux-specification/dist/types/src';
+import { PageTypeV4 } from '@sap/ux-specification/dist/types/src';
+import type { AllowedMoveRange, ObjectAggregation, PageAnnotations, PropertyPath, SettingOption } from './model';
+import { PageEditModel, AggregationNodeType } from './model';
+interface TraverseNodeData {
+    text: string;
+    level: number;
+    path: string;
+    model: PageEditModel;
+}
+export interface TreeNode {
+    path: PropertyPath;
+    text: string;
+    /**
+     * Property to set tooltip to node. If title is not passed then value of "text" will be applied as tooltip.
+     */
+    title?: string;
+    children: TreeNode[];
+    root?: boolean;
+    locations?: Location[];
+    id?: string;
+    hidden?: boolean;
+    additionalText?: string;
+    moveProps?: NodeMoveProps;
+    properties: TreeNodeProperty[];
+    annotationNodeId?: number[];
+    type?: AggregationNodeType;
+    value?: unknown;
+}
+/**
+ * Use cases:
+ * 1. Drag enabled - drop validity are checked bassed on allowedParents or allowedChildTypes;
+ * Properties should be used "movable" + ("allowedParents" or ("type" + "allowedChildTypes")
+ * 2. Drag disabled - move buttons are hidden
+ * movable = false and moveBtn = undefined
+ * 3. Drag disabled - move buttons are visible, but disabled
+ * movable = false and moveBtn defined with "disabled" property
+ * 4. Item is restricted to drop - use case when we need mark some nodes as restricted.
+ * undroppable = true
+ */
+export interface NodeMoveProps {
+    movable: boolean;
+    dropRestricted?: boolean;
+    type?: string;
+    allowedChildTypes?: string[];
+    allowedParents?: AllowedParent[];
+}
+export interface AllowedParent {
+    path: PropertyPath;
+    allowedRanges?: AllowedMoveRange[];
+}
+export interface NodePropertyOptions {
+    key: boolean | string | number | undefined;
+    text: string;
+    reset?: boolean;
+}
+export interface TreeNodeProperty {
+    name: string;
+    value?: unknown;
+    description?: string;
+    displayName?: string;
+    artifactType?: ArtifactType;
+    schemaPath: PropertyPath;
+    type: 'string' | 'number' | 'boolean' | 'object';
+    options?: NodePropertyOptions[];
+    properties?: TreeNodeProperty[];
+}
+export declare const BOOLEAN_DISPLAY_TRUE = "True";
+export declare const BOOLEAN_DISPLAY_FALSE = "False";
+/**
+ * Method returns dom id for node.
+ *
+ * @param path Node path.
+ * @returns Outline node id.
+ */
+export declare function getNodeId(path: string): string;
+/**
+ * Creates a generic `TreeNodeProperty` object from a property or aggregation.
+ *
+ * @param name - The name of the property.
+ * @param displayName - The display name of the property.
+ * @param property - The source property or aggregation.
+ * @param schemaPath - The schema path for the property.
+ * @returns The generated tree node property.
+ */
+export declare function getGenericBase(name: string, displayName: string, property: SettingOption | ObjectAggregation, schemaPath: PropertyPath): TreeNodeProperty;
+/**
+ * Generates a `TreeNodeProperty` with type-specific configurations based on a `SettingOption`.
+ *
+ * @param name - The name of the property.
+ * @param displayName - The display name of the property.
+ * @param property - The source property.
+ * @param schemaPath - The schema path for the property.
+ * @returns The configured tree node property, or `undefined` if unhandled.
+ */
+export declare function getPropertyData(name: string, displayName: string, property: SettingOption, schemaPath: PropertyPath): undefined | TreeNodeProperty;
+/**
+ * Recursive method goes through aggregation tree and creates tree node.
+ *
+ * @param aggregation Start Aggregation.
+ * @param traverseNodeData Traverse data contains traverse context information.
+ * @returns Outline tree node.
+ */
+export declare function traverseTree(aggregation: ObjectAggregation, traverseNodeData: TraverseNodeData): TreeNode;
+/**
+ * Method creates tree for passed edit model.
+ *
+ * @param schema Page or application schema.
+ * @param data Configuration file mapped to schema.
+ * @param pageType Page type. If pageType is not passed, then considered as application.
+ * @param annotation Page annotations.
+ * @returns Outline tree.
+ */
+export declare function getTree(schema: string, data: PageConfig, pageType: PageTypeV4, annotation?: PageAnnotations): TreeNode;
+/**
+ * Method finds node by passed annotation nodeId.
+ *
+ * @param tree Nodes tree to lookup.
+ * @param nodeId Annotation node id.
+ * @returns Found node information.
+ */
+export declare function findNodeByAnnotationNodeId(tree: TreeNode[], nodeId: number[]): TreeNode | undefined;
+/**
+ * Finds a node or property in a tree by its property path.
+ *
+ * @param tree - The tree of nodes to search.
+ * @param propertyPath - The path of the property to find.
+ * @returns The matching node or property if found, otherwise `undefined`.
+ */
+export declare function findByPath(tree: TreeNode[], propertyPath: PropertyPath): {
+    node?: TreeNode;
+    property?: TreeNodeProperty;
+} | undefined;
+export {};
+//# sourceMappingURL=tree.d.ts.map