@sap-ux/fe-fpm-writer 0.16.0 → 0.17.0

package/dist/action/index.js

@@ -67,7 +67,7 @@ exports.enhanceManifestAndGetActionsElementReference = enhanceManifestAndGetActi
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
 function generateCustomAction(basePath, actionConfig, fs) {
-    validate_1.validateVersion(actionConfig.ui5Version);
+    validate_1.validateVersion(actionConfig.minUI5Version);
     if (!fs) {
         fs = mem_fs_editor_1.create(mem_fs_1.create());
     }

package/dist/column/index.d.ts

@@ -6,7 +6,7 @@ import type { CustomTableColumn } from './types';
  * @param ui5Version required UI5 version.
  * @returns path to the template folder containing the manifest.json ejs template
  */
-export declare function getManifestRoot(ui5Version?: number): string;
+export declare function getManifestRoot(ui5Version?: string): string;
 /**
  * Add a custom column to an existing UI5 application.
  *

package/dist/column/index.js

@@ -9,6 +9,7 @@ const defaults_1 = require("../common/defaults");
 const validate_1 = require("../common/validate");
 const event_handler_1 = require("../common/event-handler");
 const templates_1 = require("../templates");
+const semver_1 = require("semver");
 /**
  * Get the template folder for the given UI5 version.
  *
@@ -16,10 +17,11 @@ const templates_1 = require("../templates");
  * @returns path to the template folder containing the manifest.json ejs template
  */
 function getManifestRoot(ui5Version) {
-    if (ui5Version === undefined || ui5Version >= 1.86) {
+    const minVersion = semver_1.coerce(ui5Version);
+    if (!minVersion || minVersion.minor >= 86) {
         return templates_1.getTemplatePath('/column/1.86');
     }
-    else if (ui5Version === 1.85) {
+    else if (minVersion.minor >= 85) {
         return templates_1.getTemplatePath('/column/1.85');
     }
     else {
@@ -60,7 +62,7 @@ function enhanceConfig(fs, data, manifestPath, manifest) {
  * @param {Editor} [fs] - the mem-fs editor instance
  */
 function generateCustomColumn(basePath, customColumn, fs) {
-    validate_1.validateVersion(customColumn.ui5Version);
+    validate_1.validateVersion(customColumn.minUI5Version);
     if (!fs) {
         fs = mem_fs_editor_1.create(mem_fs_1.create());
     }
@@ -70,7 +72,7 @@ function generateCustomColumn(basePath, customColumn, fs) {
     // merge with defaults
     const completeColumn = enhanceConfig(fs, customColumn, manifestPath, manifest);
     // enhance manifest with column definition
-    const manifestRoot = getManifestRoot(customColumn.ui5Version);
+    const manifestRoot = getManifestRoot(customColumn.minUI5Version);
     const filledTemplate = ejs_1.render(fs.read(path_1.join(manifestRoot, `manifest.json`)), completeColumn, {});
     fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
     // add fragment

package/dist/common/types.d.ts

@@ -20,7 +20,7 @@ export interface CustomElement {
      * 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.
      */
-    ui5Version?: number;
+    minUI5Version?: string;
     /**
      * If set to true then all code snippets are generated in Typescript instead of Javascript.
      */

package/dist/common/validate.d.ts

@@ -5,7 +5,7 @@ import type { Editor } from 'mem-fs-editor';
  * @param ui5Version - optional minimum required UI5 version
  * @returns true if the version is supported otherwise throws an error
  */
-export declare function validateVersion(ui5Version?: number): boolean;
+export declare function validateVersion(ui5Version?: string): boolean;
 /**
  * Validates the provided base path.
  *

package/dist/common/validate.js

@@ -4,6 +4,7 @@ exports.getErrorMessage = exports.validateBasePath = exports.validateVersion = v
 const path_1 = require("path");
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
+const semver_1 = require("semver");
 /**
  * Validate that the UI5 version requirement is valid.
  *
@@ -11,7 +12,8 @@ const mem_fs_editor_1 = require("mem-fs-editor");
  * @returns true if the version is supported otherwise throws an error
  */
 function validateVersion(ui5Version) {
-    if (ui5Version && ui5Version < 1.84) {
+    const minVersion = semver_1.coerce(ui5Version);
+    if (minVersion && minVersion.minor < 84) {
         throw new Error('SAP Fiori elements for OData v4 is only supported starting with SAPUI5 1.84.');
     }
     return true;

package/dist/page/custom.d.ts

@@ -15,7 +15,7 @@ export declare function enhanceData(data: CustomPage, manifestPath: string, fs:
  * @param ui5Version - optional minimum required UI5 version
  * @returns root folder  containg the templates if the version is supported otherwise throws an error
  */
-export declare function getTemplateRoot(ui5Version?: number): string;
+export declare function getTemplateRoot(ui5Version?: string): string;
 /**
  * Add a custom page to an existing UI5 application.
  *

package/dist/page/custom.js

@@ -9,6 +9,7 @@ const common_1 = require("./common");
 const defaults_1 = require("../common/defaults");
 const validate_1 = require("../common/validate");
 const templates_1 = require("../templates");
+const semver_1 = require("semver");
 /**
  * Enhances the provided custom page configuration with default data.
  *
@@ -40,7 +41,8 @@ exports.enhanceData = enhanceData;
  * @returns root folder  containg the templates if the version is supported otherwise throws an error
  */
 function getTemplateRoot(ui5Version) {
-    if (ui5Version === undefined || ui5Version >= 1.94) {
+    const minVersion = semver_1.coerce(ui5Version);
+    if (!minVersion || minVersion.minor >= 94) {
         return templates_1.getTemplatePath('/page/custom/1.94');
     }
     else {
@@ -60,12 +62,12 @@ function generate(basePath, data, fs) {
     if (!fs) {
         fs = mem_fs_editor_1.create(mem_fs_1.create());
     }
-    validate_1.validateVersion(data.ui5Version);
+    validate_1.validateVersion(data.minUI5Version);
     common_1.validatePageConfig(basePath, data, fs);
     const manifestPath = path_1.join(basePath, 'webapp/manifest.json');
     const config = enhanceData(data, manifestPath, fs);
     // merge content into existing files
-    const root = getTemplateRoot(data.ui5Version);
+    const root = getTemplateRoot(data.minUI5Version);
     // enhance manifest.json
     fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(path_1.join(root, `manifest.json`)), config, {})), common_1.getManifestJsonExtensionHelper(config));
     // add extension content

package/dist/section/index.d.ts

@@ -6,7 +6,7 @@ import type { CustomSection } from './types';
  * @param ui5Version required UI5 version.
  * @returns path to the template folder containing the manifest.json ejs template
  */
-export declare function getManifestRoot(ui5Version?: number): string;
+export declare function getManifestRoot(ui5Version?: string): string;
 /**
  * Add a custom section to an existing UI5 application.
  *

package/dist/section/index.js

@@ -9,6 +9,7 @@ const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const event_handler_1 = require("../common/event-handler");
 const templates_1 = require("../templates");
+const semver_1 = require("semver");
 /**
  * Get the template folder for the given UI5 version.
  *
@@ -16,12 +17,13 @@ const templates_1 = require("../templates");
  * @returns path to the template folder containing the manifest.json ejs template
  */
 function getManifestRoot(ui5Version) {
-    let subFolder = '1.86';
-    if (ui5Version !== undefined && ui5Version < 1.86) {
-        // Old
-        subFolder = '1.85';
+    const minVersion = semver_1.coerce(ui5Version);
+    if (!minVersion || minVersion.minor >= 86) {
+        return templates_1.getTemplatePath('/section/1.86');
+    }
+    else {
+        return templates_1.getTemplatePath('/section/1.85');
     }
-    return templates_1.getTemplatePath(path_1.join('section', subFolder));
 }
 exports.getManifestRoot = getManifestRoot;
 /**
@@ -53,7 +55,7 @@ function enhanceConfig(fs, data, manifestPath, manifest) {
  * @returns {Promise<Editor>} the updated mem-fs editor instance
  */
 function generateCustomSection(basePath, customSection, fs) {
-    validate_1.validateVersion(customSection.ui5Version);
+    validate_1.validateVersion(customSection.minUI5Version);
     if (!fs) {
         fs = mem_fs_editor_1.create(mem_fs_1.create());
     }
@@ -63,7 +65,7 @@ function generateCustomSection(basePath, customSection, fs) {
     // merge with defaults
     const completeSection = enhanceConfig(fs, customSection, manifestPath, manifest);
     // enhance manifest with section definition
-    const manifestRoot = getManifestRoot(customSection.ui5Version);
+    const manifestRoot = getManifestRoot(customSection.minUI5Version);
     const filledTemplate = ejs_1.render(fs.read(path_1.join(manifestRoot, `manifest.json`)), completeSection, {});
     fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
     // add fragment

package/dist/view/index.js

@@ -50,7 +50,7 @@ function enhanceConfig(fs, data, manifestPath, manifest) {
  * @returns {Promise<Editor>} the updated mem-fs editor instance
  */
 function generateCustomView(basePath, customView, fs) {
-    validate_1.validateVersion(customView.ui5Version);
+    validate_1.validateVersion(customView.minUI5Version);
     if (!fs) {
         fs = mem_fs_editor_1.create(mem_fs_1.create());
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",