@sap-ux/fiori-elements-writer 0.9.0 → 0.9.2

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import type { Editor } from 'mem-fs-editor';
 import type { App } from '@sap-ux/ui5-application-writer';
 import type { FioriElementsApp } from './types';
+export declare const V2_FE_TYPES_AVAILABLE = "1.108.0";
 /**
  * Generate a UI5 application based on the specified Fiori Elements floorplan template.
  *

package/dist/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = void 0;
+exports.generate = exports.V2_FE_TYPES_AVAILABLE = void 0;
 const path_1 = require("path");
 const ejs_1 = require("ejs");
 const fe_fpm_writer_1 = require("@sap-ux/fe-fpm-writer");
@@ -41,6 +41,36 @@ const defaults_1 = require("./data/defaults");
 const templateAttributes_1 = require("./data/templateAttributes");
 const manifestSettings_1 = require("./data/manifestSettings");
 const semver_1 = __importDefault(require("semver"));
+exports.V2_FE_TYPES_AVAILABLE = '1.108.0';
+/**
+ * Get TypeScript Ignore Glob Pattern.
+ *
+ * @param feApp  to generate the Fiori elements application
+ * @param coercedUI5Version
+ * @returns ignore pattern
+ */
+function getTypeScriptIgnoreGlob(feApp, coercedUI5Version) {
+    var _a;
+    let ignore = [];
+    // isV2FETypesAvailable - Boolean to indicate if V2 Fiori Element types were available in the UI5 version
+    const isV2FETypesAvailable = ((_a = feApp.ui5) === null || _a === void 0 ? void 0 : _a.version) ? semver_1.default.gte(coercedUI5Version, exports.V2_FE_TYPES_AVAILABLE) : false;
+    const tsIgnoreGlob = ['**/*.js'];
+    ignore = tsIgnoreGlob;
+    // Add local ui5.d.ts if types are missing in UI5 version for V2 Odata services
+    // OR template is OVP
+    if (feApp.service.version === odata_service_writer_1.OdataVersion.v2) {
+        if (isV2FETypesAvailable) {
+            ignore.push('**/ui5.d.ts');
+        }
+        else {
+            // do nothing
+        }
+    }
+    else if (feApp.template.type !== types_1.TemplateType.OverviewPage) {
+        ignore.push('**/ui5.d.ts');
+    }
+    return ignore;
+}
 /**
  * Generate a UI5 application based on the specified Fiori Elements floorplan template.
  *
@@ -62,17 +92,19 @@ function generate(basePath, data, fs) {
         // This is done after `generateUi5Project` since defaults are set if values are not provided
         (0, validate_1.validateApp)(feApp);
         yield (0, odata_service_writer_1.generate)(basePath, feApp.service, fs);
+        const coercedUI5Version = semver_1.default.coerce((_a = feApp.ui5) === null || _a === void 0 ? void 0 : _a.version);
         const templateOptions = {
-            changesPreview: ((_a = feApp.ui5) === null || _a === void 0 ? void 0 : _a.version)
-                ? semver_1.default.lt(semver_1.default.coerce((_b = feApp.ui5) === null || _b === void 0 ? void 0 : _b.version), templateAttributes_1.changesPreviewToVersion)
-                : false,
+            changesPreview: ((_b = feApp.ui5) === null || _b === void 0 ? void 0 : _b.version) ? semver_1.default.lt(coercedUI5Version, templateAttributes_1.changesPreviewToVersion) : false,
             changesLoader: feApp.service.version === odata_service_writer_1.OdataVersion.v2
         };
         // Add new files from templates e.g.
         const rootTemplatesPath = (0, path_1.join)(__dirname, '..', 'templates');
         // Add templates common to all template types
-        // Common files
-        const ignore = [((_c = feApp.appOptions) === null || _c === void 0 ? void 0 : _c.typescript) ? '**/*.js' : '**/*.ts'];
+        const jsIgnoreGlob = ['**/*.ts'];
+        let ignore = jsIgnoreGlob;
+        if (((_c = feApp.appOptions) === null || _c === void 0 ? void 0 : _c.typescript) === true) {
+            ignore = getTypeScriptIgnoreGlob(feApp, coercedUI5Version);
+        }
         fs.copyTpl((0, path_1.join)(rootTemplatesPath, 'common', 'add', '**/*.*'), basePath, Object.assign(Object.assign({}, feApp), { templateOptions,
             escapeFLPText: templateAttributes_1.escapeFLPText }), undefined, {
             globOptions: { ignore, dot: true }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-elements-writer",
   "description": "SAP Fiori elements application writer",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -21,7 +21,7 @@
   ],
   "dependencies": {
     "@sap-ux/odata-service-writer": "0.14.19",
-    "@sap-ux/ui5-application-writer": "0.19.0",
+    "@sap-ux/ui5-application-writer": "0.19.2",
     "@sap-ux/fe-fpm-writer": "0.18.7",
     "@sap-ux/ui5-config": "0.16.5",
     "@sap-ux/ui5-test-writer": "0.1.7",

package/templates/v2/common/add/webapp/ui5.d.ts

@@ -0,0 +1,6 @@
+/**
+* Declaring the required interface of AppComponent that is currently missing in the UI5 types
+*/
+declare module "<%- app.baseComponent %>" {
+    export default class AppComponent { }
+}

package/templates/v4/ovp/add/webapp/ui5.d.ts

@@ -0,0 +1,6 @@
+/**
+* Declaring the required interface of AppComponent that is currently missing in the UI5 types
+*/
+declare module "<%- app.baseComponent %>" {
+    export default class AppComponent { }
+}