@sap-ux/fiori-mcp-server 0.0.1

package/dist/page-editor-api/parser/model/filter-fields/FilterFieldsAggregation.d.ts

@@ -0,0 +1,36 @@
+import type { JSONSchema4 } from 'json-schema';
+import type { PageConfig, PageType } from '@sap/ux-specification/dist/types/src';
+import type { PageData, PropertyPath, PageAnnotations } from '../types';
+import { AggregationCreationForm } from '../types';
+import { ObjectAggregation } from '../ObjectAggregation';
+import type { PageEditAggregationData } from '../ObjectAggregation';
+import { FilterFieldAggregation } from './FilterFieldAggregation';
+export declare const VISUAL_FILTER_PROPERTY_NAME = "visualFilters";
+/**
+ * Represents an aggregation for filter fields objects.
+ */
+export declare class FilterFieldsAggregation extends ObjectAggregation {
+    sortableList: boolean;
+    allowedAnnotationCreationForms: AggregationCreationForm[];
+    childClass: typeof FilterFieldAggregation;
+    i18nKey: string;
+    /**
+     * Creates an instance of `FilterFieldsAggregation`.
+     *
+     * @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 actions
+     * Method receives current values for actions and detects custom actions.
+     *
+     * @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): void;
+}
+//# sourceMappingURL=FilterFieldsAggregation.d.ts.map

package/dist/page-editor-api/parser/model/filter-fields/FilterFieldsAggregation.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterFieldsAggregation = exports.VISUAL_FILTER_PROPERTY_NAME = void 0;
+const types_1 = require("../types");
+const ObjectAggregation_1 = require("../ObjectAggregation");
+const FilterFieldAggregation_1 = require("./FilterFieldAggregation");
+exports.VISUAL_FILTER_PROPERTY_NAME = 'visualFilters';
+/**
+ * Represents an aggregation for filter fields objects.
+ */
+class FilterFieldsAggregation extends ObjectAggregation_1.ObjectAggregation {
+    sortableList = true;
+    allowedAnnotationCreationForms = [types_1.AggregationCreationForm.NativeFilterFields];
+    childClass = FilterFieldAggregation_1.FilterFieldAggregation;
+    i18nKey = 'FILTER_FIELDS';
+    /**
+     * Creates an instance of `FilterFieldsAggregation`.
+     *
+     * @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.isMacrosNode()) {
+            this.schemaCreationForms = [
+                {
+                    name: types_1.AggregationCreationForm.CustomFilterField,
+                    kind: types_1.SCHEMA_CREATION_FORM,
+                    title: 'PAGE_EDITOR_OUTLINE_ADD_CUSTOM_FILTER_FIELDS_TITLE',
+                    disabled: false
+                }
+            ];
+        }
+    }
+    /**
+     * Overwritten method for data update of object page actions
+     * Method receives current values for actions and detects custom actions.
+     *
+     * @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['selectionFields'];
+        const filterFields = data || {};
+        for (const id in filterFields) {
+            const filterField = this.aggregations[id];
+            if (filterField?.schema && !filterField.schema.annotationPath) {
+                filterField.markAsCustomFilterField();
+            }
+        }
+    }
+}
+exports.FilterFieldsAggregation = FilterFieldsAggregation;
+//# sourceMappingURL=FilterFieldsAggregation.js.map

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

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

package/dist/page-editor-api/parser/model/filter-fields/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("./FilterFieldAggregation"), exports);
+__exportStar(require("./FilterFieldsAggregation"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,19 @@
+export * from './actions';
+export * from './additionalObjects';
+export * from './AggregationValidator';
+export * from './ArrayAggregation';
+export * from './chart';
+export * from './fields';
+export * from './filter-fields';
+export * from './macros';
+export * from './ObjectAggregation';
+export * from './PageEditModel';
+export * from './PageEditProperty';
+export * from './RootAggregation';
+export * from './sections';
+export * from './table';
+export * from './types';
+export * from './utils';
+export * from './views';
+export * from './visual-filters';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,35 @@
+"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("./actions"), exports);
+__exportStar(require("./additionalObjects"), exports);
+__exportStar(require("./AggregationValidator"), exports);
+__exportStar(require("./ArrayAggregation"), exports);
+__exportStar(require("./chart"), exports);
+__exportStar(require("./fields"), exports);
+__exportStar(require("./filter-fields"), exports);
+__exportStar(require("./macros"), exports);
+__exportStar(require("./ObjectAggregation"), exports);
+__exportStar(require("./PageEditModel"), exports);
+__exportStar(require("./PageEditProperty"), exports);
+__exportStar(require("./RootAggregation"), exports);
+__exportStar(require("./sections"), exports);
+__exportStar(require("./table"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./views"), exports);
+__exportStar(require("./visual-filters"), exports);
+//# sourceMappingURL=index.js.map

package/dist/page-editor-api/parser/model/macros/MacrosRoot.d.ts

@@ -0,0 +1,48 @@
+import type { JSONSchema4 } from 'json-schema';
+import { ObjectAggregation } from '../ObjectAggregation';
+import type { PageEditAggregationData } from '../ObjectAggregation';
+import type { CreationFormOptions, PageAnnotations } from '../types';
+/**
+ * Represents an aggregation for macros objects.
+ */
+export declare class MacrosRootAggregation extends ObjectAggregation {
+    filePath?: string;
+    /**
+     * Creates an instance of `MacrosRootAggregation`.
+     *
+     * @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);
+    /**
+     * Method returns forms(internal/build-in and external/guided-help) based on supported features.
+     *
+     * @returns Forms(internal/build-in and external/guided-help) based on supported features.
+     */
+    private getCreationForms;
+    /**
+     * Public method returns display name of aggregation.
+     *
+     * @returns Display name of building blocks node.
+     */
+    getDisplayName(): string;
+    /**
+     * Method provides creation options for macros elements.
+     *
+     * @returns Creation forms for macros node.
+     */
+    protected getNativeNodeCreationForms(): CreationFormOptions[];
+    /**
+     * Method stores passed file path as source of macros node.
+     *
+     * @param filePath File path to set.
+     */
+    setFilePath(filePath: string): void;
+    /**
+     * Refreshes internal data based on annotation node data.
+     *
+     * @param annotations Annotation node data
+     */
+    updateAnnotationData(annotations: PageAnnotations | undefined): void;
+}
+//# sourceMappingURL=MacrosRoot.d.ts.map

package/dist/page-editor-api/parser/model/macros/MacrosRoot.js

@@ -0,0 +1,114 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MacrosRootAggregation = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const path_1 = require("path");
+const ObjectAggregation_1 = require("../ObjectAggregation");
+const types_1 = require("../types");
+const project_access_1 = require("@sap-ux/project-access");
+/**
+ * Represents an aggregation for macros objects.
+ */
+class MacrosRootAggregation extends ObjectAggregation_1.ObjectAggregation {
+    filePath;
+    /**
+     * Creates an instance of `MacrosRootAggregation`.
+     *
+     * @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);
+        this.path = ['macros'];
+        this.isViewNode = true;
+        this.virtual = true;
+        this.allowedAnnotationCreationForms = [];
+        // Creatin forms
+        const forms = this.getCreationForms();
+        this.annotationCreationForms = forms.internal;
+        this.schemaCreationForms = forms.external;
+        const filePath = this.schema?.metadata?.filePath;
+        if (filePath) {
+            this.setFilePath(filePath);
+        }
+    }
+    /**
+     * Method returns forms(internal/build-in and external/guided-help) based on supported features.
+     *
+     * @returns Forms(internal/build-in and external/guided-help) based on supported features.
+     */
+    getCreationForms() {
+        const forms = {
+            internal: [
+                {
+                    name: types_1.AggregationCreationForm.MacrosChart,
+                    kind: types_1.ANNOTATION_CREATION_FORM,
+                    disabled: false,
+                    title: 'ADD_BUILDING_BLOCK_CHART'
+                },
+                {
+                    name: types_1.AggregationCreationForm.MacrosFilterBar,
+                    kind: types_1.ANNOTATION_CREATION_FORM,
+                    disabled: false,
+                    title: 'ADD_BUILDING_BLOCK_FILTERBAR'
+                },
+                {
+                    name: types_1.AggregationCreationForm.MacrosTable,
+                    kind: types_1.ANNOTATION_CREATION_FORM,
+                    disabled: false,
+                    title: 'ADD_BUILDING_BLOCK_TABLE'
+                }
+            ],
+            external: []
+        };
+        return forms;
+    }
+    /**
+     * Public method returns display name of aggregation.
+     *
+     * @returns Display name of building blocks node.
+     */
+    getDisplayName() {
+        return i18next_1.default.t('PAGE_EDITOR_OUTLINE_NODE_BUILDING_BLOCK');
+    }
+    /**
+     * Method provides creation options for macros elements.
+     *
+     * @returns Creation forms for macros node.
+     */
+    getNativeNodeCreationForms() {
+        return this.annotationNodeId ? this.annotationCreationForms : [];
+    }
+    /**
+     * Method stores passed file path as source of macros node.
+     *
+     * @param filePath File path to set.
+     */
+    setFilePath(filePath) {
+        this.filePath = (0, path_1.join)(project_access_1.DirName.Webapp, filePath);
+    }
+    /**
+     * Refreshes internal data based on annotation node data.
+     *
+     * @param annotations Annotation node data
+     */
+    updateAnnotationData(annotations) {
+        super.updateAnnotationData(annotations);
+        // Check annotation creations forms
+        if (annotations?.dialogsContext?.analyticalChartSupport !== undefined) {
+            const form = this.annotationCreationForms.find((form) => form.name === types_1.AggregationCreationForm.MacrosChart);
+            if (form) {
+                form.disabled = !annotations.dialogsContext.analyticalChartSupport.creationEnabled;
+                if (form.disabled) {
+                    // Add tooltip with disable reason
+                    form.tooltip = annotations.dialogsContext.analyticalChartSupport.creationTooltip;
+                }
+            }
+        }
+    }
+}
+exports.MacrosRootAggregation = MacrosRootAggregation;
+//# sourceMappingURL=MacrosRoot.js.map

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

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

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

@@ -0,0 +1,18 @@
+"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("./MacrosRoot"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,31 @@
+import type { JSONSchema4 } from 'json-schema';
+import { SectionsObjectAggregation } from './SectionsObjectAggregation';
+import type { PageEditAggregationData } from '../ObjectAggregation';
+import type { PageData, PageAnnotations, PropertyPath } from '../types';
+import { AggregationCreationForm } from '../types';
+import type { PageConfig, PageType } from '@sap/ux-specification/dist/types/src';
+/**
+ * Represents an aggregation for header sections objects.
+ */
+export declare class HeaderSectionsAggregation extends SectionsObjectAggregation {
+    allowedAnnotationCreationForms?: AggregationCreationForm[];
+    /**
+     * Creates an instance of `HeaderSectionsAggregation`.
+     *
+     * @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 header 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.
+     */
+    updatePropertiesValues(data: PageData, page: PageConfig, pageType: PageType, path: PropertyPath, annotations?: PageAnnotations): void;
+}
+//# sourceMappingURL=HeaderSectionsAggregation.d.ts.map

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

@@ -0,0 +1,82 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeaderSectionsAggregation = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const SectionsObjectAggregation_1 = require("./SectionsObjectAggregation");
+const types_1 = require("../types");
+/**
+ * Represents an aggregation for header sections objects.
+ */
+class HeaderSectionsAggregation extends SectionsObjectAggregation_1.SectionsObjectAggregation {
+    allowedAnnotationCreationForms = [
+        types_1.AggregationCreationForm.NativeSection,
+        types_1.AggregationCreationForm.DataPointSection,
+        types_1.AggregationCreationForm.ProgressSection,
+        types_1.AggregationCreationForm.RatingSection,
+        types_1.AggregationCreationForm.ChartSection
+    ];
+    /**
+     * Creates an instance of `HeaderSectionsAggregation`.
+     *
+     * @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.CustomHeaderSection,
+                    kind: types_1.SCHEMA_CREATION_FORM,
+                    title: 'PAGE_EDITOR_OUTLINE_ADD_CUSTOM_SECTIONS_TITLE',
+                    disabled: false
+                }
+            ];
+        }
+    }
+    /**
+     * Overwritten method for data update of object page header 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.
+     */
+    updatePropertiesValues(data, page, pageType, path, annotations) {
+        super.updatePropertiesValues(data, page, pageType, path, annotations);
+        this.formSchema = this.additionalProperties?.aggregations?.['sections'];
+        const sections = data || {};
+        for (const id in sections) {
+            const section = this.aggregations[id];
+            if (section?.schema && !section.schema.annotationPath) {
+                const templateEdit = section.properties['templateEdit']?.value;
+                const template = section.properties['fragmentName']?.value;
+                let goToCodeAction;
+                if (typeof template === 'string' && typeof templateEdit === 'string') {
+                    goToCodeAction = {
+                        type: types_1.AggregationActions.OpenSource,
+                        subActions: [
+                            {
+                                id: template,
+                                text: i18next_1.default.t('CUSTOM_HEADER_SECTION_TEMPLATE')
+                            },
+                            {
+                                id: templateEdit,
+                                text: i18next_1.default.t('CUSTOM_HEADER_SECTION_TEMPLATE_EDIT')
+                            }
+                        ]
+                    };
+                }
+                section.markAsCustomSection(undefined, undefined, goToCodeAction);
+            }
+        }
+    }
+}
+exports.HeaderSectionsAggregation = HeaderSectionsAggregation;
+//# sourceMappingURL=HeaderSectionsAggregation.js.map

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

@@ -0,0 +1,78 @@
+import type { PageEditAggregationData } from '../ObjectAggregation';
+import { ObjectAggregation } from '../ObjectAggregation';
+import type { v2 } from '@sap/ux-specification/dist/types/src';
+import type { JSONSchema4 } from 'json-schema';
+import type { SupportedAggregationAction, SupportedAggregationActions } from '../types';
+/**
+ * Represents an aggregation for section objects.
+ */
+export declare class SectionAggregation extends ObjectAggregation {
+    actions: SupportedAggregationActions;
+    private title?;
+    id?: string;
+    position?: string;
+    data?: v2.ObjectPageCustomSectionBase;
+    useDescriptionAsId?: boolean;
+    isViewNode: boolean;
+    sortableCollection: string | undefined;
+    /**
+     * Creates an instance of `SectionAggregation`.
+     *
+     * @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);
+    /**
+     * Setter for title.
+     *
+     * @param title Title.
+     */
+    setTitle(title: string): void;
+    /**
+     * Setter for id.
+     *
+     * @param id Title.
+     */
+    setId(id: string): void;
+    /**
+     * Method returns display name of aggregation without applying i18n translation.
+     * Overwritten for section handling.
+     *
+     * @returns Display name of aggregation.
+     */
+    protected getRawDisplayName(): string;
+    /**
+     * Public method to read/determine section id.
+     *
+     * @param fallback Resolve id with V4 fallback solution by reading label/description.
+     * @returns Section id.
+     */
+    getSectionId(fallback?: boolean): string | undefined;
+    /**
+     * Public method to mark section as replaced with other section.
+     *
+     * @param replacedWith Section replaced with.
+     */
+    markAsReplaced(replacedWith: string): void;
+    /**
+     * Public method to mark section as custom section.
+     *
+     * @param data Configuration of section(segment of page config).
+     * @param i18nKey I18n custom key.
+     * @param goCodeAction Go to code action.
+     */
+    markAsCustomSection(data?: v2.ObjectPageCustomSectionBase, i18nKey?: string, goCodeAction?: SupportedAggregationAction): void;
+    /**
+     * Method parses object path key and returns field name / technical id.
+     *
+     * @returns Section id.
+     */
+    getTechnicalName(): string | undefined;
+    /**
+     * Protected method which returns name with additional formatting by removing 'SAP_ANNOTATION_NAMESPACE' from full name/id.
+     *
+     * @returns Name of aggregation.
+     */
+    protected getFormattedName(): string | undefined;
+}
+//# sourceMappingURL=SectionAggregation.d.ts.map