@sap/ux-specification 1.142.7 → 1.142.9

package/dist/templates/common/EventHandler.js

@@ -0,0 +1,25 @@
+sap.ui.define([
+    "sap/m/MessageToast"
+], function(MessageToast) {
+    'use strict';
+
+    return {
+<% if (typeof parameters !== "undefined" && parameters.length) { -%>
+        /**
+         * Generated event handler.
+         *
+<% parameters.forEach(function(param) { -%>
+         * @param <%- param.jsName %> <%- param.description %>
+<% }) -%>
+         */
+<% } -%>
+        <%- eventHandlerFnName %>: function(<%=
+            (typeof parameters !== "undefined" ? parameters : [])
+                .map(function(param) {
+                    return param.jsName;
+                }).join(", ")
+        -%>) {
+            MessageToast.show("Custom handler invoked.");
+        }
+    };
+});

package/dist/templates/common/EventHandler.ts

@@ -0,0 +1,28 @@
+import ExtensionAPI from 'sap/fe/core/ExtensionAPI';
+<%
+const importedTypes = new Set();
+parameters.forEach(param => {
+  if (param.importType && !importedTypes.has(param.importType)) {
+    importedTypes.add(param.importType);
+-%>
+import <%- param.importType %> from '<%- param.importSource %>';
+<% 
+  }
+}); -%>
+import MessageToast from 'sap/m/MessageToast';
+
+/**
+ * Generated event handler.
+ *
+ * @param this reference to the 'this' that the event handler is bound to.
+<% parameters.forEach(function(param) { -%>
+ * @param <%- param.name %> <%- param.description %>
+<% }) -%>
+ */
+export function <%- eventHandlerFnName %>(this: ExtensionAPI, <%=
+    parameters.map(function(param) {
+        return param.name + ": " + (param.paramType ?? param.importType);
+    }).join(", ")
+%>) {
+    MessageToast.show("Custom handler invoked.");
+}

package/dist/templates/common/Fragment.xml

@@ -0,0 +1,3 @@
+<core:FragmentDefinition xmlns:core="sap.ui.core" xmlns="sap.m"<%- typeof dependencies !== 'undefined' ? ` ${dependencies}` : '' %>>
+	<%- content %>
+</core:FragmentDefinition>

package/dist/templates/common/FragmentWithForm.xml

@@ -0,0 +1,7 @@
+<core:FragmentDefinition xmlns:core="sap.ui.core" xmlns="sap.m" xmlns:f="sap.ui.layout.form"<%- typeof dependencies !== 'undefined' ? ` ${dependencies}` : '' %>>
+    <f:FormElement id="<%- ids.formElement %>"<%- typeof requireAttribute !== 'undefined' ? ` ${requireAttribute}` : '' %>>
+        <f:fields>
+            <%- content %>
+        </f:fields>
+    </f:FormElement>
+</core:FragmentDefinition>

package/dist/templates/common/FragmentWithVBox.xml

@@ -0,0 +1,5 @@
+<core:FragmentDefinition xmlns:core="sap.ui.core" xmlns="sap.m"<%- typeof dependencies !== 'undefined' ? ` ${dependencies}` : '' %>>
+	<VBox id="<%- ids.vbox %>"<%- typeof requireAttribute !== 'undefined' ? ` ${requireAttribute}` : '' %>>
+		<%- content %>
+	</VBox>
+</core:FragmentDefinition>

package/dist/templates/common/sap.fe.d.ts

@@ -0,0 +1,43 @@
+import ExtensionAPI from 'sap/fe/core/ExtensionAPI';
+import Routing from 'sap/fe/core/controllerextensions/Routing';
+import EditFlow from 'sap/fe/core/controllerextensions/EditFlow';
+import IntentBasedNavigation from 'sap/fe/core/controllerextensions/IntentBasedNavigation';
+
+/**
+ * Missing public properties (https://ui5.sap.com/#/api/sap.fe.core.ExtensionAPI)
+ */
+interface ExtensionAPIProperties {
+    routing: Routing;
+    editFlow: EditFlow;
+    intentBasedNavigation: IntentBasedNavigation;
+}
+
+/**
+ * Add missing public properties
+ */
+declare module 'sap/fe/core/ExtensionAPI' {
+	export default interface ExtensionAPI extends ExtensionAPIProperties {}
+}
+
+/**
+ * Add missing public properties
+ */
+declare module 'sap/fe/templates/ObjectPage/ExtensionAPI' {
+	export default interface ExtensionAPI extends ExtensionAPIProperties {}
+}
+
+/**
+ * Add missing public properties
+ */
+declare module 'sap/fe/templates/ListReport/ExtensionAPI' {
+	export default interface ExtensionAPI extends ExtensionAPIProperties {}
+}
+
+/**
+ * Enhancing the PageController type to simplify the work with the extension API
+ */
+declare module 'sap/fe/core/PageController' {
+	export default interface PageController {
+		getExtensionAPI() : ExtensionAPI;
+	}
+}

package/dist/templates/controller-extension/Controller.js

@@ -0,0 +1,18 @@
+sap.ui.define(['sap/ui/core/mvc/ControllerExtension'], function (ControllerExtension) {
+	'use strict';
+
+	return ControllerExtension.extend('<%- ns %>.<%- name %>', {
+		// this section allows to extend lifecycle hooks or hooks provided by Fiori elements
+		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: function () {
+				// you can access the Fiori elements extensionAPI via this.base.getExtensionAPI
+				var oModel = this.base.getExtensionAPI().getModel();
+			}
+		}
+	});
+});

package/dist/templates/controller-extension/Controller.ts

@@ -0,0 +1,20 @@
+import ControllerExtension from 'sap/ui/core/mvc/ControllerExtension';
+import ExtensionAPI from 'sap/fe/<%- typeof extension === "object" ? `templates/${extension.pageType}` : "core" -%>/ExtensionAPI';
+
+/**
+ * @namespace <%- ns %>
+ * @controller
+ */
+export default class <%- name %> extends ControllerExtension<ExtensionAPI> {
+	static overrides = {
+		/**
+		 * 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: <%- name %>) {
+			// you can access the Fiori elements extensionAPI via this.base.getExtensionAPI
+			const model = this.base.getExtensionAPI().getModel();
+		}
+	}
+}

package/dist/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 overrides: unknown;
+        base: {
+            getExtensionAPI(): API;
+        }
+    }
+}

package/dist/templates/controller-extension/manifest.json

@@ -0,0 +1,14 @@
+{
+    "sap.ui5": {
+        "extends": {
+            "extensions": {
+                "sap.ui.controllerExtensions": {
+                    "<%- extensionId -%>": {<%if (typeof controllerNames !== 'undefined') {%>
+                        "controllerNames": <%- JSON.stringify(controllerNames) %><% } else {%>
+                        "controllerName": "<%- controllerName %>"<% } %>
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/templates/field/manifest.json

@@ -0,0 +1,32 @@
+{
+    "sap.ui5": {
+        "routing": {
+            "targets": {
+                "<%- target %>": {
+                    "options": {
+                        "settings": {
+                            "controlConfiguration": {
+                                "<%- targetEntity %>": {
+                                    "fields": {
+                                        "<%- name %>": {
+                                            "template": "<%- ns %>.<%- typeof fragmentFile !== 'undefined' ? fragmentFile : name  %>",
+                                            <%if (typeof position !== 'undefined') {%>"position": {
+                                                <% if (position.placement) { %> 
+                                                    "placement": "<%- position.placement %>"<% if (position.anchor) { %>,<% } %>
+                                                <% } %>
+                                                <% if (position.anchor) { %> 
+                                                    "anchor": "<%- position.anchor %>" 
+                                                <% } %>
+                                            },<% } %>
+                                            "label": "<%- label %>"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/templates/filter/Controller.js

@@ -0,0 +1,21 @@
+sap.ui.define(["sap/ui/model/Filter", "sap/ui/model/FilterOperator"], function(Filter, FilterOperator) {
+    "use strict";
+    return {
+        <%- eventHandlerFnName %>: function(sValue) {
+            switch (sValue) {
+                case "0":
+                        return new Filter({ path: "<%- property %>", operator: FilterOperator.LT, value1: 100 });
+                case "1":
+                        return new Filter({
+                        filters: [
+                            new Filter({ path: "<%- property %>", operator: FilterOperator.GT, value1: 100 }),
+                            new Filter({ path: "<%- property %>", operator: FilterOperator.LT, value1: 500 })
+                        ],
+                        and: true
+                    });
+                case "2":
+                        return new Filter({ path: "<%- property %>", operator: FilterOperator.GT, value1: 500 });
+            }
+        }
+    };
+});

package/dist/templates/filter/Controller.ts

@@ -0,0 +1,24 @@
+import Filter from 'sap/ui/model/Filter';
+import FilterOperator from 'sap/ui/model/FilterOperator';
+
+/**
+ * Custom filter
+ * @param sValue selected filter item
+ * @returns new Filter
+ */
+export function <%- eventHandlerFnName %>(value: string) {
+    switch (value) {
+        case "0":
+            return new Filter({ path: "<%- property %>", operator: FilterOperator.LT, value1: 100 });
+        case "1":
+            return new Filter({
+                filters: [
+                    new Filter({ path: "<%- property %>", operator: FilterOperator.GT, value1: 100 }),
+                    new Filter({ path: "<%- property %>", operator: FilterOperator.LT, value1: 500 })
+                ],
+                and: true
+            });
+        case "2":
+            return new Filter({ path: "<%- property %>", operator: FilterOperator.GT, value1: 500 });
+    }
+}

package/dist/templates/filter/fragment.xml

@@ -0,0 +1,15 @@
+<core:FragmentDefinition xmlns:core="sap.ui.core" xmlns="sap.m"><%if (typeof eventHandler !== 'undefined') {%>
+        <ComboBox
+            id="<% if (typeof controlID !== 'undefined' && controlID) { %><%- controlID %><% } else { %><%- ids.comboBox %><% } %>"
+            width="100%"
+            core:require="{handler: '<%- eventHandler.split('.').slice(0, -1).join('/') %>'}"
+            selectedKey="{path: 'filterValues>', type: 'sap.fe.macros.filter.type.Value', formatOptions: { operator: '<%- eventHandler %>' }}"
+        ><% } else { %>
+        <ComboBox id="<% if (typeof controlID !== 'undefined' && controlID) { %><%- controlID %><% } else { %><%- ids.comboBox %><% } %>" width="100%"><% } %>
+            <items>
+                <core:Item id="<%- ids.item1 %>" key="0" text="Item1"/>
+                <core:Item id="<%- ids.item2 %>" key="1" text="Item2"/>
+                <core:Item id="<%- ids.item3 %>" key="2" text="Item3"/>
+            </items>
+        </ComboBox>
+</core:FragmentDefinition>

package/dist/templates/filter/manifest.json

@@ -0,0 +1,12 @@
+{
+    "<%- name %>": {
+        "label": "<%- label %>",
+        "property": "<%- property %>",
+        "template": "<%- `${ns}.${fragmentFile}` %>",
+        "required": <%- required -%><%if (typeof position !== 'undefined') {%>,
+        "position": {
+            "placement": "<%- position.placement %>"<%if (position.anchor !== undefined) {%>,
+            "anchor": "<%- position.anchor %>"<% } %>
+        }<% } %>
+    }
+}

package/dist/templates/header-section/1.85/manifest.json

@@ -0,0 +1,43 @@
+{
+    "sap.ui5": {
+        "routing": {
+            "targets": {
+                "<%- target %>": {
+                    "options": {
+                        "settings": {
+                            "content": {
+                                "header": {
+                                    "facets": {
+                                        "<%- name %>": {
+                                            "name": "<%- ns %>.<%- name %>",
+                                            "type": "XMLFragment",
+                                            <%if (typeof position !== 'undefined') {%>"position": {
+                                                <% if (position.placement) { %> 
+                                                    "placement": "<%- position.placement %>"<% if (position.anchor) { %>,<% } %>
+                                                <% } %>
+                                                <% if (position.anchor) { %> 
+                                                    "anchor": "<%- position.anchor %>" 
+                                                <% } %>
+                                            },<% } %>
+                                            "title": "<%- title %>",
+                                            <% if (subTitle) { %> 
+                                                "subTitle": "<%- subTitle %>",
+                                            <% } %>
+                                            <% if (typeof stashed !== 'undefined') { %> 
+                                                "stashed": <%- stashed %>,
+                                            <% } %>
+                                            "requestGroupId": "<%- requestGroupId %>",
+                                            "flexSettings": {
+                                                "designtime": "<%- flexSettings.designtime %>"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/templates/header-section/1.86/manifest.json

@@ -0,0 +1,45 @@
+{
+    "sap.ui5": {
+        "routing": {
+            "targets": {
+                "<%- target %>": {
+                    "options": {
+                        "settings": {
+                            "content": {
+                                "header": {
+                                    "facets": {
+                                        "<%- name %>": {
+                                            "template": "<%- ns %>.<%- typeof fragmentFile !== 'undefined' ? fragmentFile : name  %>",
+                                            <% if (typeof edit !== 'undefined') { %> 
+                                                "templateEdit": "<%- edit.ns %>.<%- edit.name %>",
+                                            <% } %>
+                                            <%if (typeof position !== 'undefined') {%>"position": {
+                                                <% if (position.placement) { %> 
+                                                    "placement": "<%- position.placement %>"<% if (position.anchor) { %>,<% } %>
+                                                <% } %>
+                                                <% if (position.anchor) { %> 
+                                                    "anchor": "<%- position.anchor %>" 
+                                                <% } %>
+                                            },<% } %>
+                                            "title": "<%- title %>",
+                                            <% if (typeof subTitle !== 'undefined') { %> 
+                                                "subTitle": "<%- subTitle %>",
+                                            <% } %>
+                                            <% if (typeof stashed !== 'undefined') { %> 
+                                                "stashed": <%- stashed %>,
+                                            <% } %>
+                                            "requestGroupId": "<%- requestGroupId %>",
+                                            "flexSettings": {
+                                                "designtime": "<%- flexSettings.designtime %>"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/templates/page/custom/1.84/ext/Controller.js

@@ -0,0 +1,45 @@
+sap.ui.define(
+    [
+        'sap/ui/core/mvc/Controller' /** If UI5 version 1.94 or newer can be used, the change the base controller to sap/fe/core/PageController to get full FEv4 FPM support */
+    ],
+    function(PageController) {
+        'use strict';
+
+        return PageController.extend('<%- ns %>.<%- name %>', {
+            /**
+             * 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: function () {
+            //      PageController.prototype.onInit.apply(this, arguments); // needs to be called to properly initialize the page controller
+            //  },
+
+            /**
+             * Similar to onAfterRendering, but this hook is invoked before the controller's View is re-rendered
+             * (NOT before the first rendering! onInit() is used for that one!).
+             * @memberOf <%- ns %>.<%- name %>
+             */
+            //  onBeforeRendering: function() {
+            //
+            //  },
+
+            /**
+             * Called when the View has been rendered (so its HTML is part of the document). Post-rendering manipulations of the HTML could be done here.
+             * This hook is the same one that SAPUI5 controls get after being rendered.
+             * @memberOf <%- ns %>.<%- name %>
+             */
+            //  onAfterRendering: function() {
+            //
+            //  },
+
+            /**
+             * Called when the Controller is destroyed. Use this one to free resources and finalize activities.
+             * @memberOf <%- ns %>.<%- name %>
+             */
+            //  onExit: function() {
+            //
+            //  }
+        });
+    }
+);

package/dist/templates/page/custom/1.84/ext/Controller.ts

@@ -0,0 +1,42 @@
+import Controller from 'sap/ui/core/mvc/Controller'; /** If UI5 version 1.94 or newer can be used, the change the base controller to sap/fe/core/PageController to get full FEv4 FPM support */
+
+/**
+ * @namespace <%- ns %>
+ */
+export default class <%- name %> extends Controller {
+
+    /**
+     * 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 %>
+     */
+    // public onInit(): void {
+    //    super.onInit(); // needs to be called to properly initialize the page controller
+    //}
+
+    /**
+     * Similar to onAfterRendering, but this hook is invoked before the controller's View is re-rendered
+     * (NOT before the first rendering! onInit() is used for that one!).
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public  onBeforeRendering(): void {
+    //
+    //  }
+
+    /**
+     * Called when the View has been rendered (so its HTML is part of the document). Post-rendering manipulations of the HTML could be done here.
+     * This hook is the same one that SAPUI5 controls get after being rendered.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public  onAfterRendering(): void {
+    //
+    //  }
+
+    /**
+     * Called when the Controller is destroyed. Use this one to free resources and finalize activities.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public onExit(): void {
+    //
+    //  }
+}

package/dist/templates/page/custom/1.84/ext/View.xml

@@ -0,0 +1,6 @@
+<mvc:View xmlns:core="sap.ui.core" xmlns:mvc="sap.ui.core.mvc" xmlns="sap.m"
+    xmlns:html="http://www.w3.org/1999/xhtml" controllerName="<%- ns %>.<%- name %>">
+    <Page id="<%- ids.page %>" title="{i18n><%- name %>Title}">
+        <content></content>
+    </Page>
+</mvc:View>

package/dist/templates/page/custom/1.84/i18n/i18n.properties

@@ -0,0 +1,2 @@
+#XTIT: Custom view title
+<%=name%>Title=<%=view.title%>

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

@@ -0,0 +1,32 @@
+{
+    "sap.ui5": {
+        "dependencies": {
+            "libs": <%- JSON.stringify(libraries) %>
+        },
+        "routing": {
+            "targets": {
+                "<% if (typeof id !== 'undefined') { %><%- id %><% } else { %><%- entity %><%- name %><% } %>": {
+                    "viewId": "<%- name %>View",
+                    "viewName": "<%- ns %>.<%- name %>",<%if (locals.controlAggregation) {%>
+                    "controlAggregation": "<%- locals.controlAggregation %>",<% } %>
+                    "options": {
+                        "settings": <%- JSON.stringify(settings) %>
+                    }
+                }<%if (locals.navigation) {%>,
+                "<%- navigation.sourcePage %>": {
+                    "options": {
+                        "settings": {
+                            "navigation": {
+                                "<%- navigation.navEntity %>": {
+                                    "detail": {
+                                        "route": "<% if (typeof id !== 'undefined') { %><%- id %><% } else { %><%- entity %><%- name %><% } %>"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }<% } %>
+            }
+        }
+    }
+}

package/dist/templates/page/custom/1.94/ext/Controller.js

@@ -0,0 +1,45 @@
+sap.ui.define(
+    [
+        'sap/fe/core/PageController'
+    ],
+    function(PageController) {
+        'use strict';
+
+        return PageController.extend('<%- ns %>.<%- name %>', {
+            /**
+             * 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: function () {
+            //      PageController.prototype.onInit.apply(this, arguments); // needs to be called to properly initialize the page controller
+            //  },
+
+            /**
+             * Similar to onAfterRendering, but this hook is invoked before the controller's View is re-rendered
+             * (NOT before the first rendering! onInit() is used for that one!).
+             * @memberOf <%- ns %>.<%- name %>
+             */
+            //  onBeforeRendering: function() {
+            //
+            //  },
+
+            /**
+             * Called when the View has been rendered (so its HTML is part of the document). Post-rendering manipulations of the HTML could be done here.
+             * This hook is the same one that SAPUI5 controls get after being rendered.
+             * @memberOf <%- ns %>.<%- name %>
+             */
+            //  onAfterRendering: function() {
+            //
+            //  },
+
+            /**
+             * Called when the Controller is destroyed. Use this one to free resources and finalize activities.
+             * @memberOf <%- ns %>.<%- name %>
+             */
+            //  onExit: function() {
+            //
+            //  }
+        });
+    }
+);

package/dist/templates/page/custom/1.94/ext/Controller.ts

@@ -0,0 +1,42 @@
+import Controller from "sap/fe/core/PageController";
+
+/**
+ * @namespace <%- ns %>
+ */
+export default class <%- name %> extends Controller {
+
+    /**
+     * 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 %>
+     */
+    // public onInit(): void {
+    //     super.onInit(); // needs to be called to properly initialize the page controller
+    //}
+
+    /**
+     * Similar to onAfterRendering, but this hook is invoked before the controller's View is re-rendered
+     * (NOT before the first rendering! onInit() is used for that one!).
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public  onBeforeRendering(): void {
+    //
+    //  }
+
+    /**
+     * Called when the View has been rendered (so its HTML is part of the document). Post-rendering manipulations of the HTML could be done here.
+     * This hook is the same one that SAPUI5 controls get after being rendered.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public  onAfterRendering(): void {
+    //
+    //  }
+
+    /**
+     * Called when the Controller is destroyed. Use this one to free resources and finalize activities.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public onExit(): void {
+    //
+    //  }
+}

package/dist/templates/page/custom/1.94/ext/View.xml

@@ -0,0 +1,6 @@
+<mvc:View xmlns:core="sap.ui.core" xmlns:mvc="sap.ui.core.mvc" xmlns="sap.m" xmlns:macros="sap.fe.macros"
+    xmlns:html="http://www.w3.org/1999/xhtml" controllerName="<%- ns %>.<%- name %>">
+    <Page id="<%- ids.page %>" title="{i18n><%- name %>Title}">
+        <content></content>
+    </Page>
+</mvc:View>

package/dist/templates/page/custom/1.94/i18n/i18n.properties

@@ -0,0 +1,2 @@
+#XTIT: Custom view title
+<%=name%>Title=<%=view.title%>