@sap-ux/fe-fpm-writer 0.25.1 → 0.25.2

package/dist/common/validate.d.ts

@@ -11,9 +11,10 @@ export declare function validateVersion(ui5Version?: string): boolean;
  *
  * @param {string} basePath - the base path
  * @param {Editor} fs - the memfs editor instance
+ * @param {string[]} dependencies - expected dependencies
  * @returns true if the path is valid, otherwise, throws and error
  */
-export declare function validateBasePath(basePath: string, fs?: Editor): boolean;
+export declare function validateBasePath(basePath: string, fs?: Editor, dependencies?: string[]): boolean;
 /**
  * Returns the message property if the error is an instance of `Error` else a string representation of the error.
  *

package/dist/common/validate.js

@@ -24,9 +24,10 @@ exports.validateVersion = validateVersion;
  *
  * @param {string} basePath - the base path
  * @param {Editor} fs - the memfs editor instance
+ * @param {string[]} dependencies - expected dependencies
  * @returns true if the path is valid, otherwise, throws and error
  */
-function validateBasePath(basePath, fs) {
+function validateBasePath(basePath, fs, dependencies = ['sap.fe.templates']) {
     if (!fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
@@ -36,9 +37,12 @@ function validateBasePath(basePath, fs) {
     }
     else {
         const manifest = fs.readJSON(manifestPath);
-        if ((manifest['sap.ui5']?.dependencies?.libs?.['sap.fe.templates'] !== undefined) === false) {
-            throw new Error('Dependency sap.fe.templates is missing in the manifest.json. Fiori elements FPM requires the SAP FE libraries.');
-        }
+        const libs = manifest['sap.ui5']?.dependencies?.libs;
+        dependencies.forEach((dependency) => {
+            if (libs?.[dependency] === undefined) {
+                throw new Error(`Dependency ${dependency} is missing in the manifest.json. Fiori elements FPM requires the SAP FE libraries.`);
+            }
+        });
     }
     return true;
 }

package/dist/page/common.d.ts

@@ -1,6 +1,7 @@
 import type { Editor } from 'mem-fs-editor';
 import type { ManifestNamespace } from '@sap-ux/project-access';
-import type { CustomPage, FCL, FpmPage, InternalCustomPage, InternalObjectPage, ObjectPage, ListReport, Navigation, InternalListReport } from './types';
+import type { CustomPage, FCL, FpmPage, InternalCustomPage, InternalObjectPage, ObjectPage, ListReport, Navigation, InternalListReport, Libraries } from './types';
+import { PageType } from './types';
 import type { Manifest } from '../common/types';
 type EnhancePageConfigFunction = (data: ObjectPage | ListReport, manifest: Manifest) => InternalObjectPage | InternalListReport;
 /**
@@ -41,6 +42,13 @@ export declare function getManifestJsonExtensionHelper(config: InternalCustomPag
  * @returns fcl configuration
  */
 export declare function getFclConfig(manifest: Manifest, navigation?: Navigation): FCL;
+/**
+ * Get the library dependencies for a given page type.
+ *
+ * @param pageType - Page type for which the dependencies are to be added
+ * @returns Library dependencies
+ */
+export declare function getLibraryDependencies(pageType: PageType): Libraries;
 /**
  * Create target settings for a Fiori elements page.
  *
@@ -55,9 +63,10 @@ export declare function initializeTargetSettings(data: FpmPage, addSettings?: Re
  * @param basePath - the base path
  * @param config - the custom page configuration
  * @param fs - the memfs editor instance
+ * @param dependencies - expected dependencies
  * @returns the updated memfs editor instance
  */
-export declare function validatePageConfig(basePath: string, config: CustomPage | ObjectPage, fs: Editor): Editor;
+export declare function validatePageConfig(basePath: string, config: CustomPage | ObjectPage, fs: Editor, dependencies?: never[]): Editor;
 /**
  * Add an generic page to an existing UI5 application.
  * Supported pages - ListReport or ObjectPage.

package/dist/page/common.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extendPageJSON = exports.validatePageConfig = exports.initializeTargetSettings = exports.getFclConfig = exports.getManifestJsonExtensionHelper = exports.generateRouteTarget = exports.generateRoutePattern = exports.PATTERN_SUFFIX = void 0;
+exports.extendPageJSON = exports.validatePageConfig = exports.initializeTargetSettings = exports.getLibraryDependencies = 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");
 const ejs_1 = require("ejs");
 const validate_1 = require("../common/validate");
+const types_1 = require("./types");
 const defaults_1 = require("../common/defaults");
 const file_1 = require("../common/file");
 const templates_1 = require("../templates");
@@ -121,6 +122,28 @@ function getFclConfig(manifest, navigation) {
     return config;
 }
 exports.getFclConfig = getFclConfig;
+/**
+ * Get the library dependencies for a given page type.
+ *
+ * @param pageType - Page type for which the dependencies are to be added
+ * @returns Library dependencies
+ */
+function getLibraryDependencies(pageType) {
+    const libraries = {};
+    switch (pageType) {
+        case types_1.PageType.CustomPage: {
+            libraries['sap.fe.core'] = {};
+            break;
+        }
+        case types_1.PageType.ListReport:
+        case types_1.PageType.ObjectPage: {
+            libraries['sap.fe.templates'] = {};
+            break;
+        }
+    }
+    return libraries;
+}
+exports.getLibraryDependencies = getLibraryDependencies;
 /**
  * Create target settings for a Fiori elements page.
  *
@@ -148,11 +171,12 @@ exports.initializeTargetSettings = initializeTargetSettings;
  * @param basePath - the base path
  * @param config - the custom page configuration
  * @param fs - the memfs editor instance
+ * @param dependencies - expected dependencies
  * @returns the updated memfs editor instance
  */
-function validatePageConfig(basePath, config, fs) {
+function validatePageConfig(basePath, config, fs, dependencies = []) {
     // common validators
-    (0, validate_1.validateBasePath)(basePath, fs);
+    (0, validate_1.validateBasePath)(basePath, fs, dependencies);
     // validate config against the manifest
     if (config.navigation?.sourcePage) {
         const manifest = fs.readJSON((0, path_1.join)(basePath, 'webapp/manifest.json'));

package/dist/page/custom.js

@@ -5,6 +5,7 @@ const path_1 = require("path");
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const ejs_1 = require("ejs");
+const types_1 = require("./types");
 const common_1 = require("./common");
 const defaults_1 = require("../common/defaults");
 const validate_1 = require("../common/validate");
@@ -25,6 +26,8 @@ function enhanceData(data, manifestPath, fs) {
     // set common defaults
     const config = (0, defaults_1.setCommonDefaults)(data, manifestPath, manifest);
     config.settings = (0, common_1.initializeTargetSettings)(data);
+    // set library dependencies
+    config.libraries = (0, common_1.getLibraryDependencies)(types_1.PageType.CustomPage);
     // set FCL configuration
     const fclConfig = (0, common_1.getFclConfig)(manifest, config.navigation);
     config.fcl = fclConfig.fcl;
@@ -66,7 +69,7 @@ function generate(basePath, data, fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
     (0, validate_1.validateVersion)(data.minUI5Version);
-    (0, common_1.validatePageConfig)(basePath, data, fs);
+    (0, common_1.validatePageConfig)(basePath, data, fs, []);
     const manifestPath = (0, path_1.join)(basePath, 'webapp/manifest.json');
     const config = enhanceData(data, manifestPath, fs);
     // merge content into existing files

package/dist/page/list.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = void 0;
 const common_1 = require("./common");
+const types_1 = require("./types");
 /**
  * Enhances the provided list report configuration with default data.
  *
@@ -13,9 +14,11 @@ function enhanceData(data, manifest) {
     const config = {
         ...data,
         settings: (0, common_1.initializeTargetSettings)(data, data.settings),
-        name: 'ListReport',
+        name: types_1.PageType.ListReport,
         ...(0, common_1.getFclConfig)(manifest)
     };
+    // set library dependencies
+    config.libraries = (0, common_1.getLibraryDependencies)(types_1.PageType.ListReport);
     // 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/object.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = void 0;
 const common_1 = require("./common");
+const types_1 = require("./types");
 /**
  * Enhances the provided list report configuration with default data.
  *
@@ -13,9 +14,11 @@ function enhanceData(data, manifest) {
     const config = {
         ...data,
         settings: (0, common_1.initializeTargetSettings)(data, data.settings),
-        name: 'ObjectPage',
+        name: types_1.PageType.ObjectPage,
         ...(0, common_1.getFclConfig)(manifest)
     };
+    // set library dependencies
+    config.libraries = (0, common_1.getLibraryDependencies)(types_1.PageType.ObjectPage);
     // 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,6 +16,12 @@ export interface Navigation {
      */
     navKey?: boolean;
 }
+/**
+ * Libraries to be added to the application
+ */
+export type Libraries = {
+    [key: string]: {};
+};
 export type StandardPageSettings = {
     enhanceI18n?: string | true;
     variantManagement?: 'Page' | 'None';
@@ -52,6 +58,10 @@ export interface FpmPage {
      * If nothing can be generated for the given version then an exception is thrown.
      */
     minUI5Version?: string;
+    /**
+     * UI5 Libraries that should be added to the application.
+     */
+    libraries?: Libraries;
 }
 /**
  * Configuration options for adding a list report page.
@@ -115,15 +125,20 @@ export interface FCL {
 export type InternalFpmPage = FCL & {
     settings: Record<string, unknown | undefined>;
 };
+export declare enum PageType {
+    ListReport = "ListReport",
+    ObjectPage = "ObjectPage",
+    CustomPage = "CustomPage"
+}
 /**
  * Additional internal configuration options that will be calculated based on the provided input as well as the target application.
  */
 export type InternalCustomPage = CustomPage & InternalFpmPage & InternalCustomElement;
 export type InternalListReport = ListReport & InternalFpmPage & {
-    name: 'ListReport';
+    name: PageType.ListReport;
     navigation?: Navigation;
 };
 export type InternalObjectPage = ObjectPage & InternalFpmPage & {
-    name: 'ObjectPage';
+    name: PageType.ObjectPage;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/page/types.js

@@ -1,3 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageType = void 0;
+var PageType;
+(function (PageType) {
+    PageType["ListReport"] = "ListReport";
+    PageType["ObjectPage"] = "ObjectPage";
+    PageType["CustomPage"] = "CustomPage";
+})(PageType || (exports.PageType = PageType = {}));
 //# sourceMappingURL=types.js.map

package/package.json

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

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

@@ -1,5 +1,8 @@
 {
     "sap.ui5": {
+        "dependencies": {
+            "libs": <%- JSON.stringify(libraries) %>
+        },
         "routing": {
             "targets": {
                 "<% if (typeof id !== 'undefined') { %><%- id %><% } else { %><%- entity %><%- name %><% } %>": {

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

@@ -1,5 +1,8 @@
 {
     "sap.ui5": {
+        "dependencies": {
+            "libs": <%- JSON.stringify(libraries) %>
+        },
         "routing": {
             "targets": {
                 "<% if (typeof id !== 'undefined') { %><%- id %><% } else { %><%- entity %><%- name %><% } %>": {

package/templates/page/list/manifest.json

@@ -1,5 +1,8 @@
 {
     "sap.ui5": {
+        "dependencies": {
+            "libs": <%- JSON.stringify(libraries) %>
+        },
         "routing": {
             "targets": {
                 "<% if (typeof id !== 'undefined') { %><%- id %><% } else { %><%- entity %>ListReport<% } %>": {

package/templates/page/object/manifest.json

@@ -1,5 +1,8 @@
 {
     "sap.ui5": {
+        "dependencies": {
+            "libs": <%- JSON.stringify(libraries) %>
+        },
         "routing": {
             "targets": {
                 "<% if (typeof id !== 'undefined') { %><%- id %><% } else { %><%- entity %>ObjectPage<% } %>": {