@sap-ux/fe-fpm-writer 0.18.6 → 0.18.8

package/dist/column/index.js

@@ -19,10 +19,10 @@ const semver_1 = require("semver");
  */
 function getManifestRoot(ui5Version) {
     const minVersion = (0, semver_1.coerce)(ui5Version);
-    if (!minVersion || minVersion.minor >= 86) {
+    if (!minVersion || (0, semver_1.gte)(minVersion, '1.86.0')) {
         return (0, templates_1.getTemplatePath)('/column/1.86');
     }
-    else if (minVersion.minor >= 85) {
+    else if ((0, semver_1.gte)(minVersion, '1.85.0')) {
         return (0, templates_1.getTemplatePath)('/column/1.85');
     }
     else {

package/dist/common/validate.js

@@ -13,7 +13,7 @@ const semver_1 = require("semver");
  */
 function validateVersion(ui5Version) {
     const minVersion = (0, semver_1.coerce)(ui5Version);
-    if (minVersion && minVersion.minor < 84) {
+    if (minVersion && (0, semver_1.lt)(minVersion, '1.84.0')) {
         throw new Error('SAP Fiori elements for OData v4 is only supported starting with SAPUI5 1.84.');
     }
     return true;

package/dist/controller-extension/index.js

@@ -198,6 +198,11 @@ function generateControllerExtension(basePath, controllerConfig, fs) {
     }
     if (controllerConfig.typescript) {
         (0, utils_1.addExtensionTypes)(basePath, controllerConfig.minUI5Version, fs);
+        // Typescript - add declaration ts file for 'sap/ui/core/mvc/ControllerExtension', which allows access to `this.base.getExtensionAPI()` within Controller extension classes
+        const declarationFilePath = (0, path_1.join)(basePath, '/webapp/ext/controller/ControllerExtension.d.ts');
+        if (!fs.exists(declarationFilePath)) {
+            fs.copy((0, templates_1.getTemplatePath)('controller-extension/ControllerExtension.d.ts'), declarationFilePath);
+        }
     }
     return fs;
 }

package/dist/page/common.d.ts

@@ -1,6 +1,6 @@
 import type { Editor } from 'mem-fs-editor';
 import type { ManifestNamespace } from '@sap-ux/project-access';
-import type { CustomPage, FCL, InternalCustomPage, InternalObjectPage, ObjectPage, ListReport, Navigation, InternalListReport } from './types';
+import type { CustomPage, FCL, FpmPage, InternalCustomPage, InternalObjectPage, ObjectPage, ListReport, Navigation, InternalListReport } from './types';
 import type { Manifest } from '../common/types';
 type EnhancePageConfigFunction = (data: ObjectPage | ListReport, manifest: Manifest) => InternalObjectPage | InternalListReport;
 /**
@@ -41,6 +41,14 @@ export declare function getManifestJsonExtensionHelper(config: InternalCustomPag
  * @returns fcl configuration
  */
 export declare function getFclConfig(manifest: Manifest, navigation?: Navigation): FCL;
+/**
+ * Create target settings for a Fiori elements page.
+ *
+ * @param data - incoming configuration
+ * @param addSettings - optional arbitrary settings
+ * @returns version aware settings object
+ */
+export declare function initializeTargetSettings(data: FpmPage, addSettings?: Record<string, unknown>): Record<string, unknown>;
 /**
  * Validate the input parameters for the generation of a custom or an object page.
  *

package/dist/page/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extendPageJSON = exports.validatePageConfig = exports.getFclConfig = exports.getManifestJsonExtensionHelper = exports.generateRouteTarget = exports.generateRoutePattern = exports.PATTERN_SUFFIX = void 0;
+exports.extendPageJSON = exports.validatePageConfig = exports.initializeTargetSettings = exports.getFclConfig = exports.getManifestJsonExtensionHelper = exports.generateRouteTarget = exports.generateRoutePattern = exports.PATTERN_SUFFIX = void 0;
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const path_1 = require("path");
@@ -9,6 +9,7 @@ const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const file_1 = require("../common/file");
 const templates_1 = require("../templates");
+const semver_1 = require("semver");
 /**
  * Suffix for patterns to support arbitrary paramters
  */
@@ -124,6 +125,28 @@ function getFclConfig(manifest, navigation) {
     return config;
 }
 exports.getFclConfig = getFclConfig;
+/**
+ * Create target settings for a Fiori elements page.
+ *
+ * @param data - incoming configuration
+ * @param addSettings - optional arbitrary settings
+ * @returns version aware settings object
+ */
+function initializeTargetSettings(data, addSettings) {
+    var _a, _b;
+    const settings = addSettings ? Object.assign({}, addSettings) : {};
+    (_a = settings.navigation) !== null && _a !== void 0 ? _a : (settings.navigation = {});
+    // starting with UI5 v1.94.0, contextPath is the preferred setting
+    const minVersion = (0, semver_1.coerce)(data.minUI5Version);
+    if (!minVersion || (0, semver_1.gte)(minVersion, '1.94.0')) {
+        settings.contextPath = (_b = data.contextPath) !== null && _b !== void 0 ? _b : `/${data.entity}`;
+    }
+    else {
+        settings.entitySet = data.entity;
+    }
+    return settings;
+}
+exports.initializeTargetSettings = initializeTargetSettings;
 /**
  * Validate the input parameters for the generation of a custom or an object page.
  *

package/dist/page/custom.js

@@ -24,6 +24,7 @@ function enhanceData(data, manifestPath, fs) {
     const manifest = fs.readJSON(manifestPath);
     // set common defaults
     const config = (0, defaults_1.setCommonDefaults)(data, manifestPath, manifest);
+    config.settings = (0, common_1.initializeTargetSettings)(data);
     // set FCL configuration
     const fclConfig = (0, common_1.getFclConfig)(manifest, config.navigation);
     config.fcl = fclConfig.fcl;
@@ -44,7 +45,7 @@ exports.enhanceData = enhanceData;
  */
 function getTemplateRoot(ui5Version) {
     const minVersion = (0, semver_1.coerce)(ui5Version);
-    if (!minVersion || minVersion.minor >= 94) {
+    if (!minVersion || (0, semver_1.gte)(minVersion, '1.94.0')) {
         return (0, templates_1.getTemplatePath)('/page/custom/1.94');
     }
     else {

package/dist/page/list.js

@@ -11,21 +11,18 @@ const common_1 = require("./common");
  */
 function enhanceData(data, manifest) {
     var _a, _b;
-    const config = Object.assign(Object.assign(Object.assign({ settings: {} }, data), { name: 'ListReport' }), (0, common_1.getFclConfig)(manifest));
-    // move settings into correct possition in the manifest
-    config.settings.entitySet = data.entity;
-    config.settings.navigation = {};
+    var _c;
+    const config = Object.assign(Object.assign(Object.assign({}, data), { settings: (0, common_1.initializeTargetSettings)(data, data.settings), name: 'ListReport' }), (0, common_1.getFclConfig)(manifest));
     // use standard file name if i18n enhancement required
     if (config.settings.enhanceI18n === true) {
         config.settings.enhanceI18n = `i18n/custom${config.entity}${config.name}.properties`;
     }
     // move table settings into the correct structure
     if (config.settings.tableSettings) {
-        config.settings.controlConfiguration = (_a = config.settings.controlConfiguration) !== null && _a !== void 0 ? _a : {};
-        config.settings.controlConfiguration['@com.sap.vocabularies.UI.v1.LineItem'] =
-            (_b = config.settings.controlConfiguration['@com.sap.vocabularies.UI.v1.LineItem']) !== null && _b !== void 0 ? _b : {};
-        config.settings.controlConfiguration['@com.sap.vocabularies.UI.v1.LineItem'].tableSettings =
-            config.settings.tableSettings;
+        (_a = (_c = config.settings).controlConfiguration) !== null && _a !== void 0 ? _a : (_c.controlConfiguration = {});
+        const controlConfig = config.settings.controlConfiguration;
+        (_b = controlConfig['@com.sap.vocabularies.UI.v1.LineItem']) !== null && _b !== void 0 ? _b : (controlConfig['@com.sap.vocabularies.UI.v1.LineItem'] = {});
+        controlConfig['@com.sap.vocabularies.UI.v1.LineItem'].tableSettings = config.settings.tableSettings;
         delete config.settings.tableSettings;
     }
     return config;

package/dist/page/object.js

@@ -10,10 +10,7 @@ const common_1 = require("./common");
  * @returns enhanced configuration
  */
 function enhanceData(data, manifest) {
-    const config = Object.assign(Object.assign(Object.assign({ settings: {} }, data), { name: 'ObjectPage' }), (0, common_1.getFclConfig)(manifest));
-    // move settings into correct possition in the manifest
-    config.settings.entitySet = data.entity;
-    config.settings.navigation = {};
+    const config = Object.assign(Object.assign(Object.assign({}, data), { settings: (0, common_1.initializeTargetSettings)(data, data.settings), name: 'ObjectPage' }), (0, common_1.getFclConfig)(manifest));
     // use standard file name if i18n enhancement required
     if (config.settings.enhanceI18n === true) {
         config.settings.enhanceI18n = `i18n/custom${config.entity}${config.name}.properties`;

package/dist/page/types.d.ts

@@ -16,28 +16,43 @@ export interface Navigation {
      */
     navKey?: boolean;
 }
-export interface StandardPageSettings {
+export type StandardPageSettings = {
     enhanceI18n?: string | true;
     variantManagement?: 'Page' | 'None';
-}
+};
 /**
  * Support list of settings for a ListReport page
  */
-export interface ListReportSettings extends StandardPageSettings {
+export type ListReportSettings = StandardPageSettings & {
     tableSettings?: {
         type?: 'ResponsiveTable' | 'GridTable';
         selectionMode?: 'None' | 'Single' | 'Multi' | 'Auto';
         condensedTableLayout?: boolean;
     };
-}
+};
 /**
- * Configuration options for adding a list report page.
+ * Common settings for any page supporting the Fiori elements flexible programming model.
  */
-export interface ListReport extends WriterConfig {
+export interface FpmPage {
     /**
      * Name of the entity used for the custom page.
      */
     entity: string;
+    /**
+     * With template or UI5 version 1.94 you can alternatively specify a contextPath that shall be inserted as page option, instead of the entitySet.
+     */
+    contextPath?: string;
+    /**
+     * Optional property to define the minimum UI5 version that the generated code must support.
+     * If undefined then the latest version of the template is used.
+     * If nothing can be generated for the given version then an exception is thrown.
+     */
+    minUI5Version?: string;
+}
+/**
+ * Configuration options for adding a list report page.
+ */
+export interface ListReport extends FpmPage, WriterConfig {
     /**
      * Optional settings for the ListReport page
      */
@@ -46,11 +61,7 @@ export interface ListReport extends WriterConfig {
 /**
  * Configuration options for adding an object page.
  */
-export interface ObjectPage extends WriterConfig {
-    /**
-     * Name of the entity used for the custom page.
-     */
-    entity: string;
+export interface ObjectPage extends FpmPage, WriterConfig {
     /**
      * Optional settings for the object page
      */
@@ -63,11 +74,7 @@ export interface ObjectPage extends WriterConfig {
 /**
  * Configuration options for adding a custom page.
  */
-export interface CustomPage extends CustomElement {
-    /**
-     * Name of the entity used for the custom page.
-     */
-    entity: string;
+export interface CustomPage extends FpmPage, CustomElement {
     /**
      * Optional incoming navigation configuration. If provided then a navigation configuration is added to an existing page navigating to this custom page.
      */
@@ -98,17 +105,21 @@ export interface FCL {
      */
     controlAggregation?: 'beginColumnPages' | 'midColumnPages' | 'endColumnPages';
 }
+/**
+ * Common settings for Fiori elements pages
+ */
+export type InternalFpmPage = FCL & {
+    settings: Record<string, unknown | undefined>;
+};
 /**
  * Additional internal configuration options that will be calculated based on the provided input as well as the target application.
  */
-export type InternalCustomPage = CustomPage & InternalCustomElement & FCL;
-export type InternalListReport = ListReport & FCL & {
+export type InternalCustomPage = CustomPage & InternalFpmPage & InternalCustomElement;
+export type InternalListReport = ListReport & InternalFpmPage & {
     name: 'ListReport';
     navigation?: Navigation;
-    settings: any;
 };
-export type InternalObjectPage = ObjectPage & FCL & {
+export type InternalObjectPage = ObjectPage & InternalFpmPage & {
     name: 'ObjectPage';
-    settings: any;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/section/index.js

@@ -19,7 +19,7 @@ const semver_1 = require("semver");
  */
 function getManifestRoot(ui5Version) {
     const minVersion = (0, semver_1.coerce)(ui5Version);
-    if (!minVersion || minVersion.minor >= 86) {
+    if (!minVersion || (0, semver_1.gte)(minVersion, '1.86.0')) {
         return (0, templates_1.getTemplatePath)('/section/1.86');
     }
     else {
@@ -35,7 +35,7 @@ exports.getManifestRoot = getManifestRoot;
  */
 function getAdditionalDependencies(ui5Version) {
     const minVersion = (0, semver_1.coerce)(ui5Version);
-    return !minVersion || minVersion.minor >= 90 ? { 'xmlns:macros': 'sap.fe.macros' } : undefined;
+    return !minVersion || (0, semver_1.gte)(minVersion, '1.90.0') ? { 'xmlns:macros': 'sap.fe.macros' } : undefined;
 }
 /**
  * Enhances the provided custom section configuration with additonal data.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.18.6",
+  "version": "0.18.8",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,7 +29,7 @@
     "xpath": "0.0.32"
   },
   "devDependencies": {
-    "@sap-ux/project-access": "1.1.3",
+    "@sap-ux/project-access": "1.3.0",
     "@types/ejs": "3.1.0",
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",

package/templates/controller-extension/Controller.ts

@@ -2,30 +2,19 @@ import ControllerExtension from 'sap/ui/core/mvc/ControllerExtension';
 import ExtensionAPI from 'sap/fe/<%- typeof extension === "object" ? `templates/${extension.pageType}` : "core" -%>/ExtensionAPI';
 
 /**
- * Helper to be able to define how to get the extension API when writing a controller extension.
+ * @namespace <%- ns %>.<%- name %>
+ * @controller
  */
-declare module 'sap/ui/core/mvc/ControllerExtension' {
-    export default interface ControllerExtension {
-        base: {
-            getExtensionAPI(): ExtensionAPI;
-        }
-    }
-}
-
-/**
- * Cannot change to class syntax until https://github.com/SAP/ui5-typescript/issues/332 is fixed.
- */
-export default ControllerExtension.extend('<%- ns %>.<%- name %>', {
-	// this section allows to extend lifecycle hooks or hooks provided by Fiori elements
-	override: {
+export default class <%- name %> extends ControllerExtension<ExtensionAPI> {
+	static override = {
 		/**
 		 * Called when a controller is instantiated and its View controls (if available) are already created.
 		 * Can be used to modify the View before it is displayed, to bind event handlers and do other one-time initialization.
 		 * @memberOf <%- ns %>.<%- name %>
 		 */
-		onInit(this: ControllerExtension) {
+		onInit(this: <%- name %>) {
 			// you can access the Fiori elements extensionAPI via this.base.getExtensionAPI
 			const model = this.base.getExtensionAPI().getModel();
 		}
 	}
-});
+}

package/templates/controller-extension/ControllerExtension.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Helper to be able to define how to get the page specific extension API when writing a controller extension.
+ */
+declare module 'sap/ui/core/mvc/ControllerExtension' {
+    export default class ControllerExtension<API> {
+        static override: unknown;
+        base: {
+            getExtensionAPI(): API;
+        }
+    }
+}

package/templates/page/custom/1.84/manifest.json

@@ -7,10 +7,7 @@
                     "viewName": "<%- ns %>.<%- name %>",<%if (locals.controlAggregation) {%>
                     "controlAggregation": "<%- locals.controlAggregation %>",<% } %>
                     "options": {
-                        "settings": {
-                            "entitySet": "<%- entity %>",
-                            "navigation": { }
-                        }
+                        "settings": <%- JSON.stringify(settings) %>
                     }
                 }<%if (locals.navigation) {%>,
                 "<%- navigation.sourcePage %>": {

package/templates/page/custom/1.94/manifest.json

@@ -8,11 +8,7 @@
                     "name": "sap.fe.core.fpm",<%if (locals.controlAggregation) {%>
                     "controlAggregation": "<%- locals.controlAggregation %>",<% } %>
                     "options": {
-                        "settings": {
-                            "viewName": "<%- ns %>.<%- name %>",
-                            "entitySet": "<%- entity %>",
-                            "navigation": { }
-                        }
+                        "settings": <%- JSON.stringify({ ...settings, viewName: `${ns}.${name}`}) %>
                     }
                 }<%if (locals.navigation) {%>,
                 "<%- navigation.sourcePage %>": {