@sap-ux/ui5-application-writer 0.14.4 → 0.15.0

package/dist/data/defaults.d.ts

@@ -45,4 +45,11 @@ export declare const defaultUI5Libs: string[];
  * @returns {UI5} the updated copy of UI5 instance (does not change `ui5`)
  */
 export declare function mergeUi5(ui5: Partial<UI5>): UI5;
+/**
+ * Retrieve the tag version of the @sap/ux-specification based on the given version.
+ *
+ * @param ui5Version UI5 version used in the project
+ * @returns version tag
+ */
+export declare function getSpecTagVersion(ui5Version: string | undefined): string;
 //# sourceMappingURL=defaults.d.ts.map

package/dist/data/defaults.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeUi5 = exports.defaultUI5Libs = exports.UI5_DEFAULT = exports.mergeApp = exports.mergePackages = exports.packageDefaults = void 0;
+exports.getSpecTagVersion = exports.mergeUi5 = exports.defaultUI5Libs = exports.UI5_DEFAULT = exports.mergeApp = exports.mergePackages = exports.packageDefaults = void 0;
 const version_to_descriptor_mapping_json_1 = __importDefault(require("./version-to-descriptor-mapping.json")); // from https://github.com/SAP/ui5-manifest/blob/master/mapping.json
 const ui5Libs_1 = require("./ui5Libs");
 const semver_1 = __importDefault(require("semver"));
@@ -216,4 +216,23 @@ function getLocalVersion({ framework, version, localVersion }) {
     }
     return result;
 }
+/**
+ * Retrieve the tag version of the @sap/ux-specification based on the given version.
+ *
+ * @param ui5Version UI5 version used in the project
+ * @returns version tag
+ */
+function getSpecTagVersion(ui5Version) {
+    if (ui5Version) {
+        if (semver_1.default.valid(ui5Version)) {
+            return `UI5-${semver_1.default.major(ui5Version)}.${semver_1.default.minor(ui5Version)}`;
+        }
+        else if (ui5Version.includes('snapshot') && ui5Version.includes('.')) {
+            const snaphotVersion = ui5Version.split('snapshot-')[1];
+            return `UI5-${snaphotVersion}`;
+        }
+    }
+    return 'latest';
+}
+exports.getSpecTagVersion = getSpecTagVersion;
 //# sourceMappingURL=defaults.js.map

package/dist/data/index.js

@@ -16,6 +16,9 @@ function mergeWithDefaults(ui5App) {
     ui5App.appOptions = ui5App.appOptions || {};
     ui5App.ui5 = defaults_1.mergeUi5(ui5App.ui5 || {});
     ui5App.package = defaults_1.mergePackages(defaults_1.packageDefaults(ui5App.package.version, ui5App.app.description), ui5App.package);
+    if (ui5App.appOptions.sapux) {
+        ui5App.package.devDependencies['@sap/ux-specification'] = defaults_1.getSpecTagVersion(ui5App.ui5.version);
+    }
     return ui5App;
 }
 exports.mergeWithDefaults = mergeWithDefaults;

package/dist/data/ui5Libs.d.ts

@@ -5,4 +5,46 @@
  * @returns UI5 libs with defaults
  */
 export declare const getUI5Libs: (ui5Libs?: string | string[] | undefined) => string[];
+/**
+ * UI5 tasks configurations required for TypeScript projects
+ */
+export declare const ui5TsTasks: ({
+    name: string;
+    afterTask: string;
+    configuration: {
+        debug?: undefined;
+        removeConsoleStatements?: undefined;
+        transpileAsync?: undefined;
+        transpileTypeScript?: undefined;
+    };
+} | {
+    name: string;
+    afterTask: string;
+    configuration: {
+        debug: boolean;
+        removeConsoleStatements: boolean;
+        transpileAsync: boolean;
+        transpileTypeScript: boolean;
+    };
+})[];
+/**
+ * UI5 middleware configurations required for TypeScript projects
+ */
+export declare const ui5TsMiddlewares: ({
+    name: string;
+    afterMiddleware: string;
+    configuration: {
+        debug?: undefined;
+        transpileAsync?: undefined;
+        transpileTypeScript?: undefined;
+    };
+} | {
+    name: string;
+    afterMiddleware: string;
+    configuration: {
+        debug: boolean;
+        transpileAsync: boolean;
+        transpileTypeScript: boolean;
+    };
+})[];
 //# sourceMappingURL=ui5Libs.d.ts.map

package/dist/data/ui5Libs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUI5Libs = void 0;
+exports.ui5TsMiddlewares = exports.ui5TsTasks = exports.getUI5Libs = void 0;
 const defaults_1 = require("./defaults");
 /**
  * Merges the specified ui5 libs with the defaults.
@@ -14,4 +14,43 @@ exports.getUI5Libs = (ui5Libs) => {
         return self.indexOf(value) === index;
     });
 };
+/**
+ * UI5 tasks configurations required for TypeScript projects
+ */
+exports.ui5TsTasks = [
+    {
+        name: 'ui5-tooling-modules-task',
+        afterTask: 'replaceVersion',
+        configuration: {}
+    },
+    {
+        name: 'ui5-tooling-transpile-task',
+        afterTask: 'replaceVersion',
+        configuration: {
+            debug: true,
+            removeConsoleStatements: true,
+            transpileAsync: true,
+            transpileTypeScript: true
+        }
+    }
+];
+/**
+ * UI5 middleware configurations required for TypeScript projects
+ */
+exports.ui5TsMiddlewares = [
+    {
+        name: 'ui5-tooling-modules-middleware',
+        afterMiddleware: 'compression',
+        configuration: {}
+    },
+    {
+        name: 'ui5-tooling-transpile-middleware',
+        afterMiddleware: 'compression',
+        configuration: {
+            debug: true,
+            transpileAsync: true,
+            transpileTypeScript: true
+        }
+    }
+];
 //# sourceMappingURL=ui5Libs.js.map

package/dist/data/version-to-descriptor-mapping.json

@@ -1,5 +1,10 @@
 {
-    "latest": "1.40.0",
+    "latest": "1.45.0",
+    "1.105": "1.45.0",
+    "1.104": "1.44.0",
+    "1.103": "1.43.0",
+    "1.102": "1.42.0",
+    "1.101": "1.41.0",
     "1.100": "1.40.0",
     "1.99": "1.39.0",
     "1.98": "1.38.0",

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
+import type { App, AppOptions, Package, UI5 } from './types';
 import { Ui5App } from './types';
 /**
  * Writes the template to the memfs editor instance.
@@ -10,5 +11,5 @@ import { Ui5App } from './types';
  */
 declare function generate(basePath: string, ui5AppConfig: Ui5App, fs?: Editor): Promise<Editor>;
 export { Ui5App, generate };
-export { App, Package, UI5 } from './types';
+export { App, Package, UI5, AppOptions };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -18,6 +18,7 @@ const json_merger_1 = require("json-merger");
 const ejs_1 = require("ejs");
 const files_1 = require("./files");
 const ui5_config_1 = require("@sap-ux/ui5-config");
+const ui5Libs_1 = require("./data/ui5Libs");
 /**
  * Writes the template to the memfs editor instance.
  *
@@ -47,13 +48,11 @@ function generate(basePath, ui5AppConfig, fs) {
             }
         });
         ui5Config.addFioriToolsAppReloadMiddleware();
-        fs.write(ui5ConfigPath, ui5Config.toString());
         // ui5-local.yaml
         const ui5LocalConfigPath = path_1.join(basePath, 'ui5-local.yaml');
         const ui5LocalConfig = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5LocalConfigPath));
         ui5LocalConfig.addUI5Framework(ui5App.ui5.framework, ui5App.ui5.localVersion, ui5App.ui5.ui5Libs, ui5App.ui5.ui5Theme);
         ui5LocalConfig.addFioriToolsAppReloadMiddleware();
-        fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
         // Add optional features
         if (ui5App.appOptions) {
             Object.entries(ui5App.appOptions).forEach(([key, value]) => {
@@ -70,7 +69,7 @@ function generate(basePath, ui5AppConfig, fs) {
                             });
                         }
                         else {
-                            const add = JSON.parse(ejs_1.render(fs === null || fs === void 0 ? void 0 : fs.read(optTmplFilePath), ui5App));
+                            const add = JSON.parse(ejs_1.render(fs === null || fs === void 0 ? void 0 : fs.read(optTmplFilePath), ui5App, {}));
                             const existingFile = JSON.parse(fs === null || fs === void 0 ? void 0 : fs.read(outPath));
                             const merged = json_merger_1.mergeObjects([existingFile, add], { defaultArrayMergeOperation: 'concat' });
                             fs === null || fs === void 0 ? void 0 : fs.writeJSON(outPath, merged);
@@ -78,7 +77,17 @@ function generate(basePath, ui5AppConfig, fs) {
                     });
                 }
             });
+            if (ui5App.appOptions.typescript) {
+                fs.delete(path_1.join(basePath, 'webapp/Component.js'));
+                ui5Config.addCustomMiddleware(ui5Libs_1.ui5TsMiddlewares);
+                ui5Config.addCustomTasks(ui5Libs_1.ui5TsTasks);
+                ui5LocalConfig.addCustomMiddleware(ui5Libs_1.ui5TsMiddlewares);
+                ui5LocalConfig.addCustomTasks(ui5Libs_1.ui5TsTasks);
+            }
         }
+        // write ui5 yamls
+        fs.write(ui5ConfigPath, ui5Config.toString());
+        fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
         return fs;
     });
 }

package/dist/types.d.ts

@@ -51,7 +51,14 @@ export interface AppOptions {
     codeAssist: boolean;
     eslint: boolean;
     sapux: boolean;
+    /**
+     * Enables loading of re-use libs
+     */
     loadReuseLibs: boolean;
+    /**
+     * Enable Typescript support and generate all files in Typescript instead of Javascript
+     */
+    typescript: boolean;
 }
 export interface Ui5App {
     app: App;

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aui5-application-writer"
   },
-  "version": "0.14.4",
+  "version": "0.15.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -20,7 +20,7 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "@sap-ux/ui5-config": "0.14.4",
+    "@sap-ux/ui5-config": "0.14.5",
     "ejs": "3.1.7",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",

package/templates/optional/typescript/.babelrc.json

@@ -0,0 +1,4 @@
+{
+    "ignore": ["**/*.d.ts"],
+    "presets": ["transform-ui5", "@babel/preset-typescript"]
+}

package/templates/optional/typescript/.eslintrc

@@ -0,0 +1,23 @@
+{
+    "root": true,
+    "env": {
+        "browser": true,
+        "es6": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking"
+    ],
+	"ignorePatterns": [".eslintignore.js"],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": ["./tsconfig.json"],
+        "tsconfigRootDir": ".",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ]
+}

package/templates/optional/typescript/package.json

@@ -0,0 +1,19 @@
+{
+    "scripts": {
+        "ts-typecheck": "tsc --noEmit"
+    },
+    "devDependencies": {
+        "@types/openui5": "latest",
+        "ui5-tooling-modules": "^0.6.0",
+        "ui5-tooling-transpile": "^0.2.0",
+        "typescript": "^4.6.3",
+        "@typescript-eslint/eslint-plugin": "^5.17.0",
+        "@typescript-eslint/parser": "^5.17.0"
+    },
+    "ui5": {
+        "dependencies": [
+            "ui5-tooling-modules",
+            "ui5-tooling-transpile"
+        ]
+    }
+}

package/templates/optional/typescript/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "es2015",
+    "module": "es2015",
+    "skipLibCheck": true,
+    "preserveConstEnums": true,
+    "inlineSourceMap": true,
+    "allowJs": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": false,
+    "moduleResolution": "node",
+    "rootDir": "webapp",
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "paths": {
+      "<%- app.id %>/*": [
+        "webapp/*"
+      ]
+    }
+  },
+  "include": [
+    "webapp/**/*"
+  ]
+}

package/templates/optional/typescript/webapp/Component.ts

@@ -0,0 +1,24 @@
+import UIComponent from "<%- app.baseComponent %>";
+
+/**
+ * @namespace <%- app.id %>
+ */
+export default class Component extends UIComponent {
+
+	public static metadata = {
+		manifest: "json"
+	};
+
+    /**
+     * The component is initialized by UI5 automatically during the startup of the app and calls the init method once.
+     * @public
+     * @override
+     */
+	public init() : void {
+		// call the base component's init function
+		super.init();
+
+        // enable routing
+        this.getRouter().initialize();
+	}
+}