@sap-ux/fiori-mcp-server 0.0.1

package/dist/page-editor-api/parser/model/sections/SectionsObjectAggregation.d.ts

@@ -0,0 +1,50 @@
+import type { JSONSchema4 } from 'json-schema';
+import type { ObjectAggregation, PageEditAggregationData } from '../ObjectAggregation';
+import type { ModelParserParams, PageData, PageAnnotations, PropertyPath } from '../types';
+import { SectionsAggregation } from './SectionsAggregation';
+import type { PageConfig, PageType } from '@sap/ux-specification/dist/types/src';
+/**
+ * Represents an aggregation for sections objects.
+ */
+export declare class SectionsObjectAggregation extends SectionsAggregation {
+    /**
+     * Creates an instance of `SectionsObjectAggregation`.
+     *
+     * @param data Optional aggregation data object used to initialize properties.
+     * @param schema Optional JSON schema fragment associated with this aggregation.
+     */
+    constructor(data?: PageEditAggregationData, schema?: JSONSchema4);
+    /**
+     * Overwritten method for data update of object page sections
+     * Method receives current values for sections - loops through custom sections object and appends existing/standard aggregations with custom section aggregations.
+     *
+     * @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 Page annotations.
+     * @param parser Model parser parameters.
+     */
+    updatePropertiesValues(data: PageData, page: PageConfig, pageType: PageType, path: PropertyPath, annotations?: PageAnnotations, parser?: ModelParserParams<ObjectAggregation>): void;
+    /**
+     * Method removes aggregations that are not part of schema properties.
+     */
+    private removeObsoleteAggregations;
+    /**
+     * Method parses building blocks for passed custom section.
+     *
+     * @param parseData Schema parse data and parser.
+     * @param section Section to parse.
+     * @param id Section id.
+     * @param sections Sections data.
+     * @param path Aggregation path.
+     */
+    private parseBuildingBlocks;
+    /**
+     * Public method checks if annotation sections are merged by 'sap.fe' in runtime.
+     *
+     * @returns Annotation sections are merged by 'sap.fe' in runtime.
+     */
+    isSectionsMerged(): boolean;
+}
+//# sourceMappingURL=SectionsObjectAggregation.d.ts.map

package/dist/page-editor-api/parser/model/sections/SectionsObjectAggregation.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SectionsObjectAggregation = void 0;
+const types_1 = require("../types");
+const utils_1 = require("../utils");
+const SectionsAggregation_1 = require("./SectionsAggregation");
+const macros_1 = require("../macros");
+/**
+ * Represents an aggregation for sections objects.
+ */
+class SectionsObjectAggregation extends SectionsAggregation_1.SectionsAggregation {
+    /**
+     * Creates an instance of `SectionsObjectAggregation`.
+     *
+     * @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);
+        const additionalProperties = schema?.additionalProperties;
+        if (typeof additionalProperties === 'object' && additionalProperties.$ref) {
+            this.schemaCreationForms = [
+                {
+                    name: types_1.AggregationCreationForm.CustomSection,
+                    kind: types_1.SCHEMA_CREATION_FORM,
+                    title: 'PAGE_EDITOR_OUTLINE_ADD_CUSTOM_SECTIONS_TITLE',
+                    disabled: false
+                }
+            ];
+        }
+    }
+    /**
+     * Overwritten method for data update of object page sections
+     * Method receives current values for sections - loops through custom sections object and appends existing/standard aggregations with custom section aggregations.
+     *
+     * @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 Page annotations.
+     * @param parser Model parser parameters.
+     */
+    updatePropertiesValues(data, page, pageType, path, annotations, parser) {
+        super.updatePropertiesValues(data, page, pageType, path, annotations, parser);
+        this.formSchema = this.additionalProperties?.aggregations?.['sections'];
+        const sections = data || {};
+        // Remove obsolete aggregations
+        this.removeObsoleteAggregations();
+        for (const id in sections) {
+            const section = this.aggregations[id];
+            if (section?.schema && !section.schema.annotationPath) {
+                section.markAsCustomSection();
+                if (parser) {
+                    this.parseBuildingBlocks({ parser, page, pageType }, section, id, sections, path);
+                }
+            }
+        }
+        const sortDisabled = this.isSectionsMerged();
+        if (sortDisabled) {
+            for (const id in this.aggregations) {
+                if (this.aggregations[id].custom) {
+                    this.aggregations[id].sortableItem = types_1.SortingOptions.Excluded;
+                }
+            }
+        }
+    }
+    /**
+     * Method removes aggregations that are not part of schema properties.
+     */
+    removeObsoleteAggregations() {
+        const schemaSections = this.schema?.properties || {};
+        for (const id in this.aggregations) {
+            if (!(id in schemaSections)) {
+                delete this.aggregations[id];
+            }
+        }
+    }
+    /**
+     * Method parses building blocks for passed custom section.
+     *
+     * @param parseData Schema parse data and parser.
+     * @param section Section to parse.
+     * @param id Section id.
+     * @param sections Sections data.
+     * @param path Aggregation path.
+     */
+    parseBuildingBlocks(parseData, section, id, sections, path) {
+        const { parser, page, pageType } = parseData;
+        const fragmentData = sections[id];
+        const { fragmentName } = fragmentData;
+        // Get custom sections fragment from definitions schema
+        const customSectionFragmentDefinition = parser?.definitions[`CustomExtensionFragment<${fragmentName}>`];
+        // Check if custom section has controls aggregation
+        if (customSectionFragmentDefinition && section.aggregations.controls) {
+            // Create macros aggregation and add it to subsection
+            const macrosAggregation = new macros_1.MacrosRootAggregation(undefined, customSectionFragmentDefinition);
+            section.addAggregation('controls', macrosAggregation, path.concat(section.path[section.path.length - 1], 'controls'), 0, true);
+            // parse schema using attached fragment file's macros schema definition
+            parser.parse(macrosAggregation, customSectionFragmentDefinition, undefined, undefined, macrosAggregation.path, {
+                filePath: customSectionFragmentDefinition.metadata?.filePath
+            });
+            // Update values of properties inside macros aggregation
+            const macrosConfigData = (0, utils_1.getProperty)(section.value || {}, ['controls']);
+            if (macrosConfigData && typeof macrosConfigData === 'object') {
+                macrosAggregation.updatePropertiesValues(macrosConfigData, page, pageType, path, parser?.annotations);
+            }
+        }
+    }
+    /**
+     * Public method checks if annotation sections are merged by 'sap.fe' in runtime.
+     *
+     * @returns Annotation sections are merged by 'sap.fe' in runtime.
+     */
+    isSectionsMerged() {
+        return false;
+    }
+}
+exports.SectionsObjectAggregation = SectionsObjectAggregation;
+//# sourceMappingURL=SectionsObjectAggregation.js.map

package/dist/page-editor-api/parser/model/sections/SubSectionsAggregation.d.ts

@@ -0,0 +1,39 @@
+import type { JSONSchema4 } from 'json-schema';
+import type { ObjectAggregation, PageEditAggregationData } from '../ObjectAggregation';
+import type { ModelParserParams, PageData, PageAnnotations, PropertyPath } from '../types';
+import { SectionsObjectAggregation } from './SectionsObjectAggregation';
+import type { PageConfig, PageType } from '@sap/ux-specification/dist/types/src';
+/**
+ * Represents an aggregation for sub-sections objects.
+ */
+export declare class SubSectionsAggregation extends SectionsObjectAggregation {
+    /**
+     * Creates an instance of `SubSectionsAggregation`.
+     *
+     * @param data Optional aggregation data object used to initialize properties.
+     * @param schema Optional JSON schema fragment associated with this aggregation.
+     */
+    constructor(data?: PageEditAggregationData, schema?: JSONSchema4);
+    /**
+     * Overwritten method for data update of object page sections
+     * Method receives current values for sections - loops custom sections array and appends existing/standard aggregations with custom section aggregations.
+     *
+     * @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 Page annotations.
+     * @param parser Model parser parameters.
+     */
+    updatePropertiesValues(data: PageData, page: PageConfig, pageType: PageType, path: PropertyPath, annotations?: PageAnnotations, parser?: ModelParserParams<ObjectAggregation>): void;
+    /**
+     * Public method checks if annotation sections are merged by 'sap.fe' in runtime.
+     * There is two reordering approaches:
+     * 1. When annotations sections are merged into one. There no any collection section in such case.
+     * 2. When sections are separated. There is at least one collection section in such case.
+     *
+     * @returns Annotation sections are merged by 'sap.fe' in runtime.
+     */
+    isSectionsMerged(): boolean;
+}
+//# sourceMappingURL=SubSectionsAggregation.d.ts.map

package/dist/page-editor-api/parser/model/sections/SubSectionsAggregation.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubSectionsAggregation = void 0;
+const types_1 = require("../types");
+const SectionsObjectAggregation_1 = require("./SectionsObjectAggregation");
+/**
+ * Represents an aggregation for sub-sections objects.
+ */
+class SubSectionsAggregation extends SectionsObjectAggregation_1.SectionsObjectAggregation {
+    /**
+     * Creates an instance of `SubSectionsAggregation`.
+     *
+     * @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);
+        const additionalProperties = schema?.additionalProperties;
+        if (typeof additionalProperties === 'object' && additionalProperties.$ref) {
+            this.schemaCreationForms = [
+                {
+                    name: types_1.AggregationCreationForm.CustomSubSection,
+                    kind: types_1.SCHEMA_CREATION_FORM,
+                    title: 'PAGE_EDITOR_OUTLINE_ADD_CUSTOM_SECTIONS_TITLE',
+                    disabled: false
+                }
+            ];
+        }
+    }
+    /**
+     * Overwritten method for data update of object page sections
+     * Method receives current values for sections - loops custom sections array and appends existing/standard aggregations with custom section aggregations.
+     *
+     * @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 Page annotations.
+     * @param parser Model parser parameters.
+     */
+    updatePropertiesValues(data, page, pageType, path, annotations, parser) {
+        super.updatePropertiesValues(data, page, pageType, path, annotations, parser);
+        this.formSchema = this.additionalProperties?.aggregations?.['subsections'];
+    }
+    /**
+     * Public method checks if annotation sections are merged by 'sap.fe' in runtime.
+     * There is two reordering approaches:
+     * 1. When annotations sections are merged into one. There no any collection section in such case.
+     * 2. When sections are separated. There is at least one collection section in such case.
+     *
+     * @returns Annotation sections are merged by 'sap.fe' in runtime.
+     */
+    isSectionsMerged() {
+        let mergedAnnotationNodes = 0;
+        for (const key in this.aggregations) {
+            const aggregation = this.aggregations[key];
+            if ('subsections' in aggregation.aggregations) {
+                // Collection facet - sections are not merged in runtime by 'sap.fe'
+                return false;
+            }
+            else if (!aggregation.custom) {
+                mergedAnnotationNodes++;
+            }
+        }
+        // If there is at least one annotation node - sections are merged
+        return mergedAnnotationNodes > 0;
+    }
+}
+exports.SubSectionsAggregation = SubSectionsAggregation;
+//# sourceMappingURL=SubSectionsAggregation.js.map

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

@@ -0,0 +1,6 @@
+export * from './SectionsAggregation';
+export * from './HeaderSectionsAggregation';
+export * from './SectionAggregation';
+export * from './SectionsObjectAggregation';
+export * from './SubSectionsAggregation';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,22 @@
+"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("./SectionsAggregation"), exports);
+__exportStar(require("./HeaderSectionsAggregation"), exports);
+__exportStar(require("./SectionAggregation"), exports);
+__exportStar(require("./SectionsObjectAggregation"), exports);
+__exportStar(require("./SubSectionsAggregation"), exports);
+//# sourceMappingURL=index.js.map

package/dist/page-editor-api/parser/model/table/ColumnAggregation.d.ts

@@ -0,0 +1,89 @@
+import { ObjectAggregation } from '../ObjectAggregation';
+import type { PageData, PropertyPath, PageAnnotations } from '../types';
+import { SortingOptions, AggregationActions, TableColumnExtensionType } from '../types';
+import { PageType } from '@sap/ux-specification/dist/types/src';
+import type { PageConfig } from '@sap/ux-specification/dist/types/src';
+/**
+ * Represents an aggregation for column objects.
+ */
+export declare class ColumnAggregation extends ObjectAggregation {
+    private title?;
+    originalIndex?: number;
+    isViewNode: boolean;
+    actions: AggregationActions[];
+    sortableItem: SortingOptions;
+    private readonly criticality?;
+    /**
+     * Setter for title.
+     *
+     * @param title Title.
+     */
+    setTitle(title?: string): void;
+    /**
+     * Method returns display name of aggregation without applying i18n translation.
+     * Overwritten for column handling.
+     *
+     * @returns Display name of aggregation.
+     */
+    protected getRawDisplayName(): string;
+    /**
+     * Method validates column positioning by checking anchoring.
+     */
+    private validateColumnPositioning;
+    /**
+     * Public method to mark section as custom section.
+     *
+     * @param params Parameters used to configure the custom column.
+     * @param params.pageType Page type
+     * @param params.originalIndex Original element index - data to store and use on reordering.
+     * @param params.columnExtension Column extension type.
+     * @param params.isExtensionTypeSupported Whether column extension type is supported.
+     * @param params.i18nKey I18n custom key.
+     * @param params.tableExtension Target table extension type.
+     * @param params.isV4 Whether Custom column is for V4.
+     * @param params.tabkey Tab/view key identificator.
+     */
+    markAsCustomColumn(params: {
+        pageType: PageType;
+        originalIndex: number;
+        columnExtension: TableColumnExtensionType;
+        isExtensionTypeSupported: boolean;
+        i18nKey?: string;
+        tableExtension?: TableColumnExtensionType;
+        isV4?: boolean;
+        tabkey?: string;
+    }): void;
+    /**
+     * Method parses object path key and returns field name / technical id.
+     *
+     * @returns Field name / technical id.
+     */
+    getTechnicalName(): string | undefined;
+    /**
+     * Overwritten method for aggregation update.
+     *
+     * @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 Annotation data.
+     */
+    updatePropertiesValues(data: PageData, page: PageConfig, pageType: PageType, path: PropertyPath, annotations?: PageAnnotations): void;
+    /**
+     * Method updates column move settings according to column state.
+     */
+    private updateMoveProperties;
+    /**
+     * Checks if this column represents an action column.
+     *
+     * @returns true if this is an action column.
+     */
+    isActionColumn(): boolean;
+    /**
+     * Checks if this column represents a navigation column.
+     *
+     * @returns true if this is a navigation column.
+     */
+    isNavigationColumn(): boolean;
+}
+//# sourceMappingURL=ColumnAggregation.d.ts.map

package/dist/page-editor-api/parser/model/table/ColumnAggregation.js

@@ -0,0 +1,175 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColumnAggregation = void 0;
+const ObjectAggregation_1 = require("../ObjectAggregation");
+const i18next_1 = __importDefault(require("i18next"));
+const types_1 = require("../types");
+const utils_1 = require("../utils");
+const src_1 = require("@sap/ux-specification/dist/types/src");
+/**
+ * Represents an aggregation for column objects.
+ */
+class ColumnAggregation extends ObjectAggregation_1.ObjectAggregation {
+    title;
+    originalIndex;
+    isViewNode = true;
+    actions = [types_1.AggregationActions.Delete];
+    sortableItem = types_1.SortingOptions.Enabled;
+    criticality;
+    /**
+     * Setter for title.
+     *
+     * @param title Title.
+     */
+    setTitle(title) {
+        this.title = title;
+    }
+    /**
+     * 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();
+    }
+    /**
+     * Method validates column positioning by checking anchoring.
+     */
+    validateColumnPositioning() {
+        const value = this.value && typeof this.value === 'object' ? this.value : {};
+        const anchorEnum = this.aggregations.position?.schema?.properties?.anchor?.enum;
+        const anchorOneOf = this.schema?.properties?.anchor?.oneOf;
+        let anchorMatches = false;
+        if (this.isMacrosNode()) {
+            // validate column key
+            (0, utils_1.validateMacrosExtension)(this, value);
+            const relatedAnchors = anchorOneOf ?? [];
+            // no positioning property for macros anchor
+            const anchor = (0, utils_1.getProperty)(value, ['anchor']);
+            anchorMatches = anchor
+                ? relatedAnchors.some((relatedAnchor) => {
+                    return relatedAnchor['const'] === anchor;
+                })
+                : true;
+        }
+        else {
+            const relatedAnchors = anchorEnum ?? [];
+            const anchor = (0, utils_1.getProperty)(value, ['position', 'anchor']);
+            anchorMatches = anchor ? relatedAnchors.includes(anchor) : true;
+        }
+        // validate columns by checking related anchors
+        (0, utils_1.validateExtension)(this, anchorMatches, i18next_1.default.t('PAGE_EDITOR_CUSTOM_EXTENSION_NO_ANCHOR'));
+    }
+    /**
+     * Public method to mark section as custom section.
+     *
+     * @param params Parameters used to configure the custom column.
+     * @param params.pageType Page type
+     * @param params.originalIndex Original element index - data to store and use on reordering.
+     * @param params.columnExtension Column extension type.
+     * @param params.isExtensionTypeSupported Whether column extension type is supported.
+     * @param params.i18nKey I18n custom key.
+     * @param params.tableExtension Target table extension type.
+     * @param params.isV4 Whether Custom column is for V4.
+     * @param params.tabkey Tab/view key identificator.
+     */
+    markAsCustomColumn(params) {
+        const { pageType, originalIndex, columnExtension, isExtensionTypeSupported, i18nKey, tableExtension = "ResponsiveTableColumnsExtension" /* TableColumnExtensionType.ResponsiveTableColumnsExtension */, isV4 = false, tabkey } = params;
+        this.custom = true;
+        this.actions = [types_1.AggregationActions.OpenSource];
+        if (!this.isMacrosNode()) {
+            this.actions.push(types_1.AggregationActions.Delete);
+        }
+        this.sortableItem =
+            !isExtensionTypeSupported || tableExtension === columnExtension
+                ? types_1.SortingOptions.Enabled
+                : types_1.SortingOptions.Excluded;
+        const columnExtensionText = columnExtension ?? 'Unknown';
+        if (tabkey && pageType === src_1.PageType.ListReport) {
+            this.additionalText = isExtensionTypeSupported
+                ? i18next_1.default.t('PAGE_EDITOR_OUTLINE_NODE_DESC_CUSTOM_COLUMN_WITH_EXTENSION_TAB', {
+                    tabkey,
+                    extension: i18next_1.default.t(`PAGE_EDITOR_OUTLINE_NODE_DESC_CUSTOM_COLUMN_${columnExtensionText}`)
+                })
+                : i18next_1.default.t('PAGE_EDITOR_OUTLINE_NODE_DESC_CUSTOM_COLUMN_TAB', { tabkey });
+        }
+        else {
+            this.additionalText = isExtensionTypeSupported
+                ? i18next_1.default.t('PAGE_EDITOR_OUTLINE_NODE_DESC_CUSTOM_COLUMN_WITH_EXTENSION', {
+                    extension: i18next_1.default.t(`PAGE_EDITOR_OUTLINE_NODE_DESC_CUSTOM_COLUMN_${columnExtensionText}`)
+                })
+                : i18next_1.default.t('PAGE_EDITOR_OUTLINE_NODE_DESC_CUSTOM_COLUMN');
+        }
+        this.originalIndex = originalIndex;
+        this.i18nKey = i18nKey;
+        if (isExtensionTypeSupported && tableExtension !== columnExtensionText) {
+            // Column with different extension that target table
+            this.state = types_1.ValidationState.Invalid;
+            this.messages = [
+                {
+                    text: i18next_1.default.t('PAGE_EDITOR_CUSTOM_COLUMN_UNUSED_COLUMN', {
+                        tableType: types_1.EXTENSION_TABLE_TYPE_MAP.get(tableExtension)
+                    }),
+                    type: types_1.PropertyMessageType.Info
+                }
+            ];
+            this.inactive = true;
+        }
+        // anchor positioning is only supported for V4 columns
+        if (isV4) {
+            this.validateColumnPositioning();
+        }
+    }
+    /**
+     * Method parses object path key and returns field name / technical id.
+     *
+     * @returns Field name / technical id.
+     */
+    getTechnicalName() {
+        return (0, utils_1.getTechnicalIdFromPath)(this.path);
+    }
+    /**
+     * Overwritten method for aggregation update.
+     *
+     * @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 Annotation data.
+     */
+    updatePropertiesValues(data, page, pageType, path, annotations) {
+        super.updatePropertiesValues(data, page, pageType, path, annotations);
+        this.updateMoveProperties();
+    }
+    /**
+     * Method updates column move settings according to column state.
+     */
+    updateMoveProperties() {
+        if (this.isActionColumn() || this.isNavigationColumn()) {
+            this.sortableCollection = !this.criticality || this.criticality === 'None' ? 'actions' : undefined;
+            this.additionalText = i18next_1.default.t(`PAGE_EDITOR_OUTLINE_NODE_DESC_ACTION_COLUMN`);
+        }
+    }
+    /**
+     * Checks if this column represents an action column.
+     *
+     * @returns true if this is an action column.
+     */
+    isActionColumn() {
+        return !!this.name?.startsWith(`${types_1.DATA_FIELD_ACTION}${types_1.ANNOTATION_TYPES_SEPARATOR}`);
+    }
+    /**
+     * Checks if this column represents a navigation column.
+     *
+     * @returns true if this is a navigation column.
+     */
+    isNavigationColumn() {
+        return !!this.name?.startsWith(`${types_1.DATA_FIELD_FOR_INTENT_BASED_NAVIGATION}${types_1.ANNOTATION_TYPES_SEPARATOR}`);
+    }
+}
+exports.ColumnAggregation = ColumnAggregation;
+//# sourceMappingURL=ColumnAggregation.js.map