@sap/ux-specification 1.96.15 → 1.96.16

package/dist/schemas/v4/ApplicationV4.json

@@ -29,6 +29,10 @@
           "$ref": "#/definitions/FlexibleColumnLayoutV4",
           "description": "The flexible column layout allows users to see more details on the page, and to expand and collapse the screen areas. For the overview page, this layout is not relevant."
         },
+        "viewPath": {
+          "description": "Prefix that is preceding the view",
+          "type": "string"
+        },
         "title": {
           "description": "To change the application header, in your project artifacts, change the i18n property file\nfor your app under webapp/i18n/i18n.properties ->appTitle. Then, refer to the title as\n{{appTitle}} in the sap.app section of the manifest file.",
           "i18nClassification": "TIT: Title of the application",

package/dist/schemas/v4/FreestylePageConfig.json

@@ -0,0 +1,10 @@
+{
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/src/apiTypes.d.ts

@@ -7,9 +7,9 @@ import type { FileData, File, ExportResults } from './sync/common/types';
 import type { ApplicationV2, ObjectPageConfig as ObjectPageConfigV2, ListReportConfig as ListReportConfigV2, OverviewPageConfig as OverviewPageConfigV2, AnalyticalListPageConfig as AnalyticalListPageConfigV2, Manifest as ManifestV2, FlexChangeLayer } from './v2';
 import type { ApplicationV4, ObjectPageConfig as ObjectPageConfigV4, ListReportConfig as ListReportConfigV4, Manifest as ManifestV4 } from './v4';
 import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
-import type { CustomPage, CustomTableColumn, CustomSection } from '@sap-ux/fe-fpm-writer';
 import type { Editor } from 'mem-fs-editor';
 import type { TemplateType } from './sync/common';
+import type { CustomPage as FPMCustomPage, CustomTableColumn as FPMCustomTableColumn, CustomSection as FPMCustomSection, ObjectPage as FPMObjectPage } from '@sap-ux/fe-fpm-writer';
 export declare type MessageMetadataType = (object | string | number)[];
 /**
  * Interface used to define a logger for the specificaton API
@@ -92,7 +92,15 @@ export declare type GenerateAnalyticalListPageV4 = {
         manifest?: object;
     };
 };
-export declare type GenerateSchemaV4Type = GenerateListReportV4 | GenerateObjectPageV4 | GenerateAnalyticalListPageV4;
+export declare type GenerateFreestylePageV4 = {
+    [SchemaType.FreestylePage]: {
+        genericSchema: object;
+        annotations: FileData[];
+        manifest: object;
+        logger?: ExtensionLogger;
+    };
+};
+export declare type GenerateSchemaV4Type = GenerateListReportV4 | GenerateObjectPageV4 | GenerateAnalyticalListPageV4 | GenerateFreestylePageV4;
 export interface GenerateSchemaV4 {
     [FioriElementsVersion.v4]: GenerateSchemaV4Type;
 }
@@ -292,7 +300,8 @@ export interface GenerateAppSchemaParameters {
 export declare enum CustomExtensionType {
     CustomPage = "CustomPage",
     CustomColumn = "CustomColumn",
-    CustomSection = "CustomSection"
+    CustomSection = "CustomSection",
+    ObjectPage = "ObjectPage"
 }
 export interface GenerateCustomExtensionParams {
     customExtension: CustomExtensionType;
@@ -300,7 +309,7 @@ export interface GenerateCustomExtensionParams {
     data: CustomExtensionData;
     fsEditor?: Editor;
 }
-export declare type CustomExtensionData = CustomPage | CustomTableColumn | CustomSection;
+export declare type CustomExtensionData = FPMCustomPage | FPMCustomTableColumn | FPMCustomSection | FPMObjectPage;
 export declare const FPMWriterMap: Map<CustomExtensionType, (basePath: string, data: CustomExtensionData, fs?: Editor) => Editor>;
 /**
  * API Version

package/dist/src/specification/schemaAccess.d.ts

@@ -7,7 +7,8 @@ export declare enum SchemaType {
     ObjectPage = "ObjectPage",
     ListReport = "ListReport",
     OverviewPage = "OverviewPage",
-    AnalyticalListPage = "AnalyticalListPage"
+    AnalyticalListPage = "AnalyticalListPage",
+    FreestylePage = "FreestylePage"
 }
 /**
  * Return the generic schema for a given version and type

package/dist/src/specification/v4/ApplicationV4.d.ts

@@ -6,6 +6,10 @@ export interface AppSettings extends CommonAppSettings {
      * The flexible column layout allows users to see more details on the page, and to expand and collapse the screen areas. For the overview page, this layout is not relevant.
      */
     flexibleColumnLayout?: FlexibleColumnLayoutV4;
+    /**
+     * Prefix that is preceding the view
+     */
+    viewPath?: string;
 }
 export interface PagesV4 extends Pages {
     [key: string]: PageV4;

package/dist/src/specification/v4/pages/FreestylePageConfig.d.ts

@@ -0,0 +1,2 @@
+import type { PageConfig } from '../../common';
+export declare type FreestylePageConfig = PageConfig;

package/dist/src/specification/v4/pages/index.d.ts

@@ -1,2 +1,3 @@
 export * from './ObjectPageConfig';
 export * from './ListReportConfig';
+export * from './FreestylePageConfig';

package/dist/src/specification/v4/webapp/manifest/sapUi5.d.ts

@@ -61,6 +61,7 @@ export interface SapUi5RoutingTargetSettingsV4 {
         [key: string]: SapUi5RoutingTargetNavigationV4;
     };
     variantManagement?: string;
+    viewPath?: string;
     views?: {
         paths: Array<SapUi5ViewPath>;
         showCounts?: boolean;
@@ -80,6 +81,7 @@ export declare type RouterClass = typeof FIORI_FCL_ROUTER_CLASS | string;
 export interface SapUi5RoutingConfig {
     routerClass?: RouterClass;
     flexibleColumnLayout?: FlexibleColumnLayoutV4;
+    viewPath?: string;
 }
 export declare enum FlexibleColumnLayoutAggregations {
     BeginColumnPages = "beginColumnPages",

package/dist/src/sync/common/appProvider.d.ts

@@ -10,7 +10,7 @@ export interface Controllers {
 export declare abstract class AppProvider {
     readonly app: Application;
     readonly logger: ExtensionLogger;
-    private readonly schemas;
+    readonly schemas: Files;
     unhandledControllers: Array<string>;
     protected constructor(manifest: ManifestV2 | ManifestV4, schemas: Files, home: string, pages: PagesBase, version: FioriElementsVersion, settings?: AppSettingsV2 | AppSettingsV4, logger?: ExtensionLogger);
     /**

package/dist/src/sync/common/types.d.ts

@@ -228,7 +228,9 @@ export declare enum ViewTemplateType {
     ResponsiveTableCellsExtension = "ResponsiveTableCellsExtension"
 }
 export declare enum DefinitionName {
+    Action = "Action",
     Actions = "Actions",
+    ActionsLR = "Actions<LineItems>",
     ALPChart = "ALPChart",
     ALPChartView = "ALPChartView",
     ALPTable = "ALPTable",
@@ -247,7 +249,9 @@ export declare enum DefinitionName {
     Fields4Dialog = "Fields4Dialog",
     FilterBar = "FilterBar",
     Footer = "Footer",
+    FooterAction = "FooterAction",
     FooterActions = "FooterActions",
+    FooterActionsLR = "FooterActions<LineItems>",
     Form = "Form",
     FormAction = "FormAction",
     GenericActions = "GenericActions",
@@ -295,6 +299,7 @@ export declare enum DefinitionName {
     QuickVariantSelectionV4OP = "QuickVariantSelectionV4OP",
     RelatedFacetKeys = "RelatedFacetKeys",
     Sections = "Sections",
+    SelectionFields = "SelectionFields",
     Table = "Table",
     TableSPV = "TableSPV",
     TableColumn = "TableColumn",

package/dist/src/sync/common/utils.d.ts

@@ -3,6 +3,7 @@ import type { ExtensionLogger } from '../../apiTypes';
 import type { FacetConfigs, FileData, FacetConfig, FacetSection, SchemaFilePath, anyFacetType } from './types';
 import type { Manifest } from '../../specification/common';
 import type { MetadataInstanceInterface } from './decoration/factory';
+import type { SapUiAppPageV4, SapUi5RoutingTargetCustomPageV4 } from '../../specification/v4';
 import type { DataFieldAbstractTypes } from '@sap-ux/vocabularies-types/vocabularies/UI';
 import type { ConvertedMetadata, EntityType, PropertyPath } from '@sap-ux/vocabularies-types';
 import { FioriElementsVersion, PageType, PageTypeV4 } from '../../specification/common';
@@ -13,7 +14,8 @@ export declare enum TemplateType {
     ListReportObjectPageV4 = "ListReportObjectPageV4",
     OverviewPageV2 = "OverviewPageV2",
     AnalyticalListPageV2 = "AnalyticalListPageV2",
-    AnalyticalListPageV4 = "AnalyticalListPageV4"
+    AnalyticalListPageV4 = "AnalyticalListPageV4",
+    FreestylePageV4 = "FreestylePageV4"
 }
 export declare const DEFINITION_LINK_PREFIX = "#/definitions/";
 /**
@@ -73,7 +75,7 @@ export declare function getPageTypeV2(name: string): PageType | undefined;
  * Return the page type for a given V4 page in manifest
  * @param name - page component name
  */
-export declare function getPageTypeV4(name: string): PageTypeV4 | undefined;
+export declare function getPageTypeV4(v4App: SapUiAppPageV4 | SapUi5RoutingTargetCustomPageV4): PageTypeV4 | undefined;
 /**
  * Finds the alias for a given namespace in the references' section of the converted service metadata
  * @param {string} namespace - complete namespace, e.g. 'com.sap.vocabularies.UI.v1'
@@ -226,3 +228,16 @@ export declare function getNextTargetDefinition(appSchema: object, title: string
  * @returns
  */
 export declare const arrayCombineMerge: (target: any, source: any, options: any) => string[];
+/**
+ * Converts an enum into a CSV
+ * @param {object} manifestSection - manifestSection where the key exists
+ * @param {object} configPart - Property as mentioned in config file
+ * @param {string} key - Property to be exported to manifest
+ */
+export declare function convertEnumToCSV(manifestSection: any, configPart: any, key: string): void;
+/**
+ * Converts an action ID from the internal format (schema, config) to the stable ID representation
+ * @param actionId - the (unique) internal format of the action ID
+ * @returns the converted action ID
+ */
+export declare function convertActionKeyToStableId(actionId: string): string;

package/dist/src/sync/v2/export/controls/Table.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="@sapui5/ts-types-esm" />
-import type { AnalyticalTable as AnalyticalTableConfig, TableALP as TableALPConfig, CommonTableSettings as CommonTableConfig, DefaultContentView, DefaultFilterMode, GenericColumns, GridTable as GridTableConfig, LoadDataOnAppLaunchSettings, QuickVariantSelectionX as QuickVariantSelectionXInterface, ResponsiveTable as ResponsiveTableConfig, TreeTable as TreeTableConfig, Strategy, FieldPath as FieldPathInterface, QuickVariant, QuickVariantX, CreationFieldKeys, ToolBar } from '../../../../specification/v2';
-import { TableTypeV2 } from '../../../../specification/v2';
+import type { AnalyticalTable as AnalyticalTableConfig, TableALP as TableALPConfig, CommonTableSettings as CommonTableConfig, DefaultContentView, DefaultFilterMode, GenericColumns, GridTable as GridTableConfig, LoadDataOnAppLaunchSettings, QuickVariantSelectionX as QuickVariantSelectionXInterface, ResponsiveTable as ResponsiveTableConfig, TreeTable as TreeTableConfig, Strategy, FieldPath as FieldPathInterface, QuickVariant, QuickVariantX, CreationFieldKeys, ToolBar, TableTypeV2 } from '../../../../specification/v2';
 import type { ControlTypeFunction, DeprecatedProperties } from '../../../common';
 import type { PopinLayout } from 'sap/m/library';
 import type { smarttable } from 'sap/ui/comp/library';

package/dist/src/sync/v2/import/common/index.d.ts

@@ -6,6 +6,7 @@ import type { SapUiAppPageV2 } from '../../../../specification/v2';
 import { TableTypeV2 } from '../../../../specification/v2';
 import type { ExtensionLogger } from '../../../../apiTypes';
 export declare type LROPConfigsType = ListReportConfig | AnalyticalListPageConfig | ObjectPageConfig;
+export declare function convertActionKey(actionProperty: string): string;
 /**
  * Unescapes the selector ID of a flex change
  * @param selectorId - escaped selector ID

package/dist/src/sync/v2/import/controls/table.d.ts

@@ -1,13 +1,15 @@
 import type { TreeTable, ResponsiveTable, AnalyticalTable, GridTable, TableALP } from '../../../../specification/v2/index';
+import type { Definition } from 'typescript-json-schema';
 export declare type FlexForTransfer = {
     controlId: string;
     controlType: string;
     propertyId: string;
     facetId?: string;
     newValue: any;
+    creation: string;
 };
 export interface FlexChangesForTransfer {
     [controlId: string]: FlexForTransfer;
 }
 export declare type ConfigTableType = ResponsiveTable | TreeTable | AnalyticalTable | GridTable | TableALP;
-export declare function addFlexForTable(config: ConfigTableType, change: FlexForTransfer, jsonSchema: object): void;
+export declare function addFlexForTable(config: ConfigTableType, change: FlexForTransfer, jsonSchema: Definition): void;

package/dist/src/sync/v2/types.d.ts

@@ -62,7 +62,8 @@ export declare type ObjectPageV2ConfigParameters = {
     objectPageConfig?: ObjectPageConfig;
 };
 export declare type SectionPartProperties = {
-    id: string;
-    type: SectionTypeV2;
-    schema: Definition;
+    id?: string;
+    type?: SectionTypeV2;
+    schema?: Definition;
+    title?: string;
 };

package/dist/src/sync/v4/export/pages/FreestylePage.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Sync class for import and export of V4 freestyle page
+ */
+export declare class FreestylePage {
+}

package/dist/src/sync/v4/export/pages/index.d.ts

@@ -1,2 +1,3 @@
 export * from './ListReport';
 export * from './ObjectPage';
+export * from './FreestylePage';

package/dist/src/sync/v4/generate/freestylePage.d.ts

@@ -0,0 +1,10 @@
+import type { GenerateAppSchemaParameters } from '../../../apiTypes';
+/**
+ * Generates an app specific schema for the FE V4 Freestyle page from the generic schema.
+ * Generic types are replaced by information from the app specific annotations.
+ * @param {GenerateAppSchemaParameters} generateParameters - list of API input parameters
+ * @param genericSchema  - generic JSON schema of an object page
+ *
+ * @returns {object} application-specific schema of the freestyle page
+ */
+export declare function generateFreestyleSchemaV4(_generateParameters: GenerateAppSchemaParameters, genericSchema: object): object;

package/dist/src/sync/v4/generate/generate.d.ts

@@ -28,3 +28,15 @@ export declare function generateObjectPageInterfaceV4(genericSchema: object, ent
  * @returns the app specific JSON schema
  */
 export declare function generateListReportInterfaceV4(templateType: TemplateType, genericSchema: object, entitySetName: string, annotations: FileData[], logger?: ExtensionLogger, manifest?: object): object;
+/**
+ * Generates the app specific schema of a freestyle page out of the generic schema.
+ * Generic types are replaced by information from the app specific annotations.
+ * @param {TemplateType} templateType - the template type allows distinguishing LR and ALP
+ * @param genericSchema - generic JSON schema of a list report
+ * @param annotations - list of all annotation files (file content plus URI as identifier)
+ * @param {ExtensionLogger} logger - Logger class for logging messages
+ * @param manifest - manifest.json of the app
+ *
+ * @returns the app specific JSON schema
+ */
+export declare function generateFreestyleInterfaceV4(templateType: TemplateType, genericSchema: object, annotations: FileData[], manifest?: object, entitySetName?: string, logger?: ExtensionLogger): object;

package/dist/src/sync/v4/generate/index.d.ts

@@ -1,3 +1,4 @@
 export { generateListReportSchemaV4 } from './listReport';
 export { generateObjectPageSchemaV4 } from './objectPage';
-export { generateListReportInterfaceV4, generateObjectPageInterfaceV4 } from './generate';
+export { generateFreestyleSchemaV4 } from './freestylePage';
+export { generateListReportInterfaceV4, generateObjectPageInterfaceV4, generateFreestyleInterfaceV4 } from './generate';

package/dist/src/sync/v4/import/app/appProvider.d.ts

@@ -1,20 +1,7 @@
-import { AppProvider } from '../../../common/appProvider';
-import type { Files } from '../../../common';
-import { TemplateType } from '../../../common';
-import type { SapUiAppPagesV4, Manifest, Pages } from '../../../../specification/v4';
+import type { Files, TemplateType } from '../../../common';
 import type { ExtensionLogger } from '../../../..';
-export declare enum Constants {
-    OptionalQuery = ":?query:",
-    Component = "sap/fe/AppComponent",
-    Namespace = "sap.fe.templates"
-}
-/**
- * Determines the Pages(app.json) using routing configuration from manifest and creates the configuration for each page
- * @param manifest - manifest.json of the app
- * @param schemas - list of JSON schemas of all pages
- */
-export declare function getPagesAndConfigs(manifest: Manifest, schemas: Files, templateType: TemplateType, logger?: ExtensionLogger): Pages;
-export declare class V4AppProvider extends AppProvider {
+import type { Manifest } from '../../../../specification/v4';
+import { BaseAppProvider } from './baseAppProvider';
+export declare class V4AppProvider extends BaseAppProvider {
     constructor(manifest: Manifest, schemas: Files, templateType: TemplateType, logger?: ExtensionLogger);
 }
-export declare function getPages(manifest: Manifest, targetName: string): SapUiAppPagesV4;

package/dist/src/sync/v4/import/app/baseAppProvider.d.ts

@@ -0,0 +1,45 @@
+import { AppProvider } from '../../../common/appProvider';
+import { AppSettings } from '../../application';
+import type { Files } from '../../../common';
+import { TemplateType } from '../../../common';
+import type { SapUiAppPagesV4, SapUi5RoutingV4, Manifest, Pages, Page, RoutingTargetOptions } from '../../../../specification/v4';
+import { PageTypeV4 } from '../../../../specification/common';
+import type { ExtensionLogger } from '../../../..';
+export declare enum Constants {
+    OptionalQuery = ":?query:",
+    Component = "sap/fe/AppComponent",
+    Namespace = "sap.fe.templates"
+}
+export declare const unhandledControllers: Array<string>;
+export declare type ConversionParameters = {
+    target: RoutingTargetOptions;
+    pageType: PageTypeV4;
+    manifest: Manifest;
+    schemas: Files;
+    logger: ExtensionLogger;
+    page: Page;
+    id: string;
+    templateType: TemplateType;
+};
+/**
+ * Determines the Pages(app.json) using routing configuration from manifest and creates the configuration for each page
+ * @param manifest - manifest.json of the app
+ * @param schemas - list of JSON schemas of all pages
+ */
+export declare function getPagesAndConfigs(manifest: Manifest, schemas: Files, templateType: TemplateType, logger?: ExtensionLogger): Pages;
+/**
+ * Get the id of the page that is to open when the application is started.
+ * @param routing UI5 routing configuration
+ */
+export declare function getHome(routing: SapUi5RoutingV4): string;
+/**
+ * Method which detects app settings from manifest.
+ * Currently only one setting is detected -Flexible Column Layout
+ * @param routing UI5 routing configuration.
+ * @return {AppSettings} Application settings.
+ */
+export declare function getSettings(routing: SapUi5RoutingV4): AppSettings;
+export declare function getPages(manifest: Manifest, targetName: string): SapUiAppPagesV4;
+export declare abstract class BaseAppProvider extends AppProvider {
+    constructor(manifest: Manifest, schemas: Files, templateType: TemplateType, logger?: ExtensionLogger);
+}

package/dist/src/sync/v4/import/app/freestyleProvider.d.ts

@@ -0,0 +1,7 @@
+import type { Files, TemplateType } from '../../../common';
+import type { ExtensionLogger } from '../../../..';
+import type { Manifest } from '../../../../specification/v4';
+import { BaseAppProvider } from './baseAppProvider';
+export declare class V4FreestyleAppProvider extends BaseAppProvider {
+    constructor(manifest: Manifest, schemas: Files, templateType: TemplateType, logger?: ExtensionLogger);
+}

package/dist/src/sync/v4/import/app/index.d.ts

@@ -0,0 +1,3 @@
+export { getPages, getHome, getPagesAndConfigs, getSettings } from './baseAppProvider';
+export { V4AppProvider } from './appProvider';
+export { V4FreestyleAppProvider } from './freestyleProvider';

package/dist/test/unit/generateAppSchema/generateAppSchemaFFV4.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/unit/generateGenericSchema/generateGenericSchemaFFV4.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/ux-specification",
-  "version": "1.96.15",
+  "version": "1.96.16",
   "displayName": "SAP Fiori tools - Specification",
   "description": "SAP Fiori tools - Specification",
   "files": [
@@ -46,7 +46,7 @@
   "publisher": "SAPSE",
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@sap-ux/fe-fpm-writer": "0.6.1"
+    "@sap-ux/fe-fpm-writer": "0.11.0"
   },
   "devDependencies": {
     "@sap-ux/annotation-converter": "0.5.7",