@linkup-ai/abap-ai 2.0.0

package/dist/knowledge/fiori/ui5-manifest.md

@@ -0,0 +1,411 @@
+# UI5 manifest.json — complete application descriptor
+
+## Minimal manifest.json
+
+```json
+{
+    "_version": "1.59.0",
+    "sap.app": {
+        "id": "com.mycompany.orders",
+        "type": "application",
+        "applicationVersion": { "version": "1.0.0" },
+        "title": "{{appTitle}}",
+        "description": "{{appDescription}}",
+        "dataSources": {
+            "mainService": {
+                "uri": "/sap/opu/odata/sap/ZORDER_SRV/",
+                "type": "OData",
+                "settings": {
+                    "odataVersion": "2.0"
+                }
+            }
+        }
+    },
+    "sap.ui": {
+        "technology": "UI5",
+        "deviceTypes": {
+            "desktop": true,
+            "tablet": true,
+            "phone": true
+        }
+    },
+    "sap.ui5": {
+        "dependencies": {
+            "minUI5Version": "1.120.0",
+            "libs": {
+                "sap.m": {},
+                "sap.ui.core": {},
+                "sap.f": {},
+                "sap.ui.layout": {}
+            }
+        },
+        "models": {
+            "i18n": {
+                "type": "sap.ui.model.resource.ResourceModel",
+                "settings": {
+                    "bundleName": "com.mycompany.orders.i18n.i18n"
+                }
+            },
+            "": {
+                "dataSource": "mainService",
+                "preload": true,
+                "settings": {
+                    "defaultBindingMode": "TwoWay",
+                    "defaultCountMode": "Inline",
+                    "refreshAfterChange": false
+                }
+            }
+        },
+        "rootView": {
+            "viewName": "com.mycompany.orders.view.App",
+            "type": "XML",
+            "id": "app",
+            "async": true
+        },
+        "routing": {
+            "config": {
+                "routerClass": "sap.m.routing.Router",
+                "type": "View",
+                "viewType": "XML",
+                "viewPath": "com.mycompany.orders.view",
+                "controlId": "appControl",
+                "controlAggregation": "pages",
+                "async": true
+            },
+            "routes": [
+                { "name": "list", "pattern": "", "target": "list" },
+                { "name": "detail", "pattern": "Orders/{orderID}", "target": "detail" }
+            ],
+            "targets": {
+                "list": { "viewName": "List", "viewLevel": 1 },
+                "detail": { "viewName": "Detail", "viewLevel": 2 }
+            }
+        }
+    }
+}
+```
+
+## sap.app — Application Metadata
+
+```json
+{
+    "sap.app": {
+        "id": "com.mycompany.orders",
+        "type": "application",
+        "applicationVersion": { "version": "1.0.0" },
+        "title": "{{appTitle}}",
+        "description": "{{appDescription}}",
+        "ach": "FI-GL",
+        "resources": "resources.json",
+        "sourceTemplate": {
+            "id": "@sap/generator-fiori:basic",
+            "version": "1.12.0"
+        },
+        "dataSources": { },
+        "crossNavigation": { }
+    }
+}
+```
+
+## dataSources — OData V2
+
+```json
+{
+    "mainService": {
+        "uri": "/sap/opu/odata/sap/ZORDER_SRV/",
+        "type": "OData",
+        "settings": {
+            "annotations": ["annotation0"],
+            "localUri": "localService/metadata.xml",
+            "odataVersion": "2.0"
+        }
+    },
+    "annotation0": {
+        "type": "ODataAnnotation",
+        "uri": "annotations/annotation.xml",
+        "settings": {
+            "localUri": "annotations/annotation.xml"
+        }
+    }
+}
+```
+
+## dataSources — OData V4
+
+```json
+{
+    "mainService": {
+        "uri": "/sap/opu/odata4/sap/zui_order_o4/0001/",
+        "type": "OData",
+        "settings": {
+            "annotations": ["annotation0"],
+            "localUri": "localService/metadata.xml",
+            "odataVersion": "4.0"
+        }
+    }
+}
+```
+
+## models — OData V2
+
+```json
+{
+    "": {
+        "dataSource": "mainService",
+        "preload": true,
+        "settings": {
+            "defaultBindingMode": "TwoWay",
+            "defaultCountMode": "Inline",
+            "refreshAfterChange": false,
+            "useBatch": true,
+            "defaultOperationMode": "Server",
+            "metadataUrlParams": {
+                "sap-value-list": "none"
+            }
+        }
+    }
+}
+```
+
+## models — OData V4
+
+```json
+{
+    "": {
+        "dataSource": "mainService",
+        "preload": true,
+        "settings": {
+            "synchronizationMode": "None",
+            "operationMode": "Server",
+            "autoExpandSelect": true,
+            "earlyRequests": true,
+            "groupId": "$auto",
+            "updateGroupId": "$auto"
+        }
+    }
+}
+```
+
+## models — Additional Models
+
+```json
+{
+    "i18n": {
+        "type": "sap.ui.model.resource.ResourceModel",
+        "settings": {
+            "bundleName": "com.mycompany.orders.i18n.i18n",
+            "supportedLocales": ["en", "de", "pt_BR"],
+            "fallbackLocale": "en"
+        }
+    },
+    "device": {
+        "type": "sap.ui.model.json.JSONModel",
+        "settings": {
+            "data": {
+                "isPhone": false
+            }
+        }
+    }
+}
+```
+
+## crossNavigation — FLP Tile
+
+```json
+{
+    "sap.app": {
+        "crossNavigation": {
+            "inbounds": {
+                "manageOrders": {
+                    "semanticObject": "Order",
+                    "action": "manage",
+                    "title": "{{appTitle}}",
+                    "subTitle": "{{appSubTitle}}",
+                    "icon": "sap-icon://sales-order",
+                    "signature": {
+                        "parameters": {
+                            "OrderID": {
+                                "defaultValue": { "value": "" }
+                            }
+                        },
+                        "additionalParameters": "allowed"
+                    }
+                }
+            }
+        }
+    }
+}
+```
+
+## dependencies — Libraries
+
+```json
+{
+    "sap.ui5": {
+        "dependencies": {
+            "minUI5Version": "1.120.0",
+            "libs": {
+                "sap.m": {},
+                "sap.ui.core": {},
+                "sap.f": {},
+                "sap.ui.layout": {},
+                "sap.uxap": {},
+                "sap.ui.table": {},
+                "sap.viz": {},
+                "sap.suite.ui.commons": {},
+                "sap.fe.templates": {}
+            }
+        }
+    }
+}
+```
+
+| Library | Use |
+|---------|-----|
+| `sap.m` | Mobile controls (Table, List, Input, Dialog, Page) |
+| `sap.ui.core` | Core framework |
+| `sap.f` | Fiori controls (DynamicPage, FlexibleColumnLayout, Avatar) |
+| `sap.ui.layout` | Layout controls (Grid, Splitter, SimpleForm) |
+| `sap.uxap` | ObjectPageLayout |
+| `sap.ui.table` | Desktop grid table, TreeTable |
+| `sap.viz` | VizFrame charts |
+| `sap.fe.templates` | Fiori Elements templates |
+| `sap.ui.comp` | Smart controls (V2 only) |
+
+## contentDensities
+
+```json
+{
+    "sap.ui5": {
+        "contentDensities": {
+            "compact": true,
+            "cozy": true
+        }
+    }
+}
+```
+
+## Component.js — Matching rootView
+
+```js
+sap.ui.define([
+    "sap/ui/core/UIComponent",
+    "sap/ui/model/json/JSONModel",
+    "sap/ui/Device"
+], function(UIComponent, JSONModel, Device) {
+    "use strict";
+
+    return UIComponent.extend("com.mycompany.orders.Component", {
+        metadata: {
+            manifest: "json"
+        },
+
+        init: function() {
+            UIComponent.prototype.init.apply(this, arguments);
+
+            // Device model
+            this.setModel(new JSONModel(Device), "device");
+
+            // Initialize router
+            this.getRouter().initialize();
+        }
+    });
+});
+```
+
+## App.view.xml — Root View
+
+```xml
+<mvc:View
+    controllerName="com.mycompany.orders.controller.App"
+    xmlns:mvc="sap.ui.core.mvc"
+    xmlns="sap.m"
+    displayBlock="true">
+
+    <App id="appControl" busy="{view>/busy}">
+        <!-- routing inserts pages here via controlAggregation: "pages" -->
+    </App>
+
+</mvc:View>
+```
+
+## Project Structure
+
+```
+webapp/
+├── Component.js
+├── manifest.json
+├── i18n/
+│   ├── i18n.properties          # default (English)
+│   ├── i18n_de.properties       # German
+│   └── i18n_pt_BR.properties    # Portuguese (Brazil)
+├── view/
+│   ├── App.view.xml
+│   ├── List.view.xml
+│   ├── Detail.view.xml
+│   └── NotFound.view.xml
+├── controller/
+│   ├── App.controller.js
+│   ├── BaseController.js
+│   ├── List.controller.js
+│   └── Detail.controller.js
+├── fragments/
+│   ├── CreateDialog.fragment.xml
+│   └── CustomerSelect.fragment.xml
+├── model/
+│   └── formatter.js
+├── css/
+│   └── style.css
+├── localService/
+│   ├── metadata.xml
+│   └── mockdata/
+│       └── Orders.json
+└── test/
+    └── ...
+```
+
+## i18n — Properties File
+
+```properties
+# i18n/i18n.properties
+appTitle=Order Management
+appDescription=Manage sales orders
+
+# List View
+listTitle=Orders
+listNoData=No orders found
+buttonCreate=Create Order
+
+# Detail View
+detailTitle=Order Details
+labelCustomer=Customer
+labelAmount=Amount
+
+# Messages
+msgCreated=Order {0} created successfully
+msgDeleted=Order deleted
+msgConfirmDelete=Are you sure you want to delete this order?
+```
+
+## Rules
+- `id` in sap.app must match folder namespace (dots → slashes in path)
+- `"preload": true` on OData model for faster initial load
+- V2: `defaultCountMode: "Inline"` avoids extra $count requests
+- V2: `refreshAfterChange: false` + manual refresh for better control
+- V4: `autoExpandSelect: true` optimizes payload (only requested fields)
+- V4: `groupId: "$auto"` for automatic batching
+- Always define `i18n` model for translatable texts
+- `crossNavigation` required for FLP tile registration
+- `rootView` must match `App.view.xml` with `controlId` matching router config
+
+## Anti-Patterns
+| Anti-Pattern | Correct |
+|---|---|
+| Missing `odataVersion` in dataSources | Always specify `"2.0"` or `"4.0"` |
+| V2 model without `defaultCountMode: "Inline"` | Extra $count requests slow list loading |
+| Hardcoded texts in views | Use `{i18n>key}` + i18n properties file |
+| Missing `"preload": true` on OData model | Delays initial data fetch |
+| `async: false` in routing config | Deprecated — always use `async: true` |
+| Missing `crossNavigation` for launchpad app | Tile won't appear in FLP |
+| Component.js without `this.getRouter().initialize()` | Routes won't work |
+| Libraries in dependencies that aren't used | Only include what's imported in views |

package/dist/knowledge/fiori/ui5-routing.md

@@ -0,0 +1,303 @@
+# UI5 Routing — manifest.json routing, navigation, parameters
+
+## manifest.json — Routing Configuration
+
+```json
+{
+    "sap.ui5": {
+        "routing": {
+            "config": {
+                "routerClass": "sap.m.routing.Router",
+                "type": "View",
+                "viewType": "XML",
+                "viewPath": "com.myapp.view",
+                "controlId": "app",
+                "controlAggregation": "pages",
+                "transition": "slide",
+                "async": true,
+                "bypassed": {
+                    "target": "notFound"
+                }
+            },
+            "routes": [
+                {
+                    "name": "list",
+                    "pattern": "",
+                    "target": "list"
+                },
+                {
+                    "name": "detail",
+                    "pattern": "Orders/{orderID}",
+                    "target": "detail"
+                },
+                {
+                    "name": "detailItem",
+                    "pattern": "Orders/{orderID}/Items/{itemID}",
+                    "target": "detailItem"
+                },
+                {
+                    "name": "create",
+                    "pattern": "Orders/new",
+                    "target": "create"
+                }
+            ],
+            "targets": {
+                "list": {
+                    "viewName": "List",
+                    "viewLevel": 1
+                },
+                "detail": {
+                    "viewName": "Detail",
+                    "viewLevel": 2
+                },
+                "detailItem": {
+                    "viewName": "DetailItem",
+                    "viewLevel": 3
+                },
+                "create": {
+                    "viewName": "Create",
+                    "viewLevel": 2
+                },
+                "notFound": {
+                    "viewName": "NotFound",
+                    "viewLevel": 1
+                }
+            }
+        }
+    }
+}
+```
+
+## Route Patterns
+
+| Pattern | URL Example | Parameters |
+|---------|-------------|------------|
+| `""` | `#/` | (none) |
+| `"Orders/{orderID}"` | `#/Orders/1000` | `{ orderID: "1000" }` |
+| `"Orders/{orderID}/Items/{itemID}"` | `#/Orders/1000/Items/10` | `{ orderID: "1000", itemID: "10" }` |
+| `"Orders/:orderID:"` | `#/Orders/` or `#/Orders/1000` | Optional parameter |
+| `"Orders/{orderID}:?query:"` | `#/Orders/1000?tab=items` | Query parameters |
+
+## Navigate To Route
+
+```js
+// Basic navigation
+this.getRouter().navTo("detail", {
+    orderID: sOrderID
+});
+
+// With query parameters
+this.getRouter().navTo("detail", {
+    orderID: sOrderID,
+    "?query": { tab: "items", edit: "true" }
+});
+
+// Replace history (no back possible)
+this.getRouter().navTo("list", {}, true);
+
+// Navigate from list item press
+onItemPress: function(oEvent) {
+    var oContext = oEvent.getSource().getBindingContext();
+    this.getRouter().navTo("detail", {
+        orderID: oContext.getProperty("OrderID")
+    });
+}
+```
+
+## Handle Route Matched
+
+```js
+onInit: function() {
+    this.getRouter().getRoute("detail")
+        .attachPatternMatched(this._onRouteMatched, this);
+},
+
+_onRouteMatched: function(oEvent) {
+    var sOrderID = oEvent.getParameter("arguments").orderID;
+    var oQuery = oEvent.getParameter("arguments")["?query"] || {};
+
+    // V2: Bind element with path
+    this.getView().bindElement({
+        path: "/Orders('" + sOrderID + "')",
+        parameters: { expand: "to_Items" },
+        events: {
+            change: this._onBindingChange.bind(this)
+        }
+    });
+
+    // Handle query params
+    if (oQuery.tab) {
+        this.byId("iconTabBar").setSelectedKey(oQuery.tab);
+    }
+},
+
+_onBindingChange: function() {
+    // Check if entity exists (404 handling)
+    if (!this.getView().getBindingContext()) {
+        this.getRouter().navTo("notFound", {}, true);
+    }
+}
+```
+
+## Navigate Back
+
+```js
+onNavBack: function() {
+    var oHistory = sap.ui.core.routing.History.getInstance();
+    var sPreviousHash = oHistory.getPreviousHash();
+
+    if (sPreviousHash !== undefined) {
+        window.history.go(-1);
+    } else {
+        this.getRouter().navTo("list", {}, true);
+    }
+}
+```
+
+```xml
+<Page showNavButton="true" navButtonPress=".onNavBack">
+```
+
+## Router Helper Method
+
+```js
+// In BaseController (reused by all controllers)
+sap.ui.define(["sap/ui/core/mvc/Controller"], function(Controller) {
+    return Controller.extend("com.myapp.controller.BaseController", {
+
+        getRouter: function() {
+            return this.getOwnerComponent().getRouter();
+        },
+
+        getModel: function(sName) {
+            return this.getView().getModel(sName);
+        },
+
+        setModel: function(oModel, sName) {
+            return this.getView().setModel(oModel, sName);
+        },
+
+        getResourceBundle: function() {
+            return this.getOwnerComponent().getModel("i18n").getResourceBundle();
+        },
+
+        navTo: function(sRoute, oParams, bReplace) {
+            this.getRouter().navTo(sRoute, oParams, bReplace);
+        },
+
+        onNavBack: function() {
+            var sPreviousHash = sap.ui.core.routing.History.getInstance().getPreviousHash();
+            if (sPreviousHash !== undefined) {
+                window.history.go(-1);
+            } else {
+                this.navTo("list", {}, true);
+            }
+        }
+    });
+});
+
+// Detail controller extends BaseController
+return BaseController.extend("com.myapp.controller.Detail", {
+    // inherits getRouter, navTo, onNavBack, etc.
+});
+```
+
+## Flexible Column Layout (Master-Detail)
+
+```json
+{
+    "sap.ui5": {
+        "routing": {
+            "config": {
+                "routerClass": "sap.f.routing.Router",
+                "controlId": "fcl",
+                "controlAggregation": "beginColumnPages",
+                "async": true,
+                "transition": "slide"
+            },
+            "routes": [
+                {
+                    "name": "list",
+                    "pattern": ":?query:",
+                    "target": "list"
+                },
+                {
+                    "name": "detail",
+                    "pattern": "Orders/{orderID}:?query:",
+                    "target": ["list", "detail"]
+                },
+                {
+                    "name": "detailItem",
+                    "pattern": "Orders/{orderID}/Items/{itemID}:?query:",
+                    "target": ["list", "detail", "detailItem"]
+                }
+            ],
+            "targets": {
+                "list": {
+                    "viewName": "List",
+                    "controlAggregation": "beginColumnPages"
+                },
+                "detail": {
+                    "viewName": "Detail",
+                    "controlAggregation": "midColumnPages"
+                },
+                "detailItem": {
+                    "viewName": "DetailItem",
+                    "controlAggregation": "endColumnPages"
+                }
+            }
+        }
+    }
+}
+```
+
+```xml
+<!-- App.view.xml -->
+<mvc:View xmlns:f="sap.f" xmlns:mvc="sap.ui.core.mvc">
+    <f:FlexibleColumnLayout id="fcl"
+        layout="{fcl>/layout}"
+        stateChange=".onStateChange"/>
+</mvc:View>
+```
+
+```js
+// Navigate with layout
+this.getRouter().navTo("detail", {
+    orderID: sOrderID,
+    "?query": { layout: "TwoColumnsMidExpanded" }
+});
+```
+
+## Not Found Page
+
+```xml
+<!-- NotFound.view.xml -->
+<MessagePage
+    title="Not Found"
+    text="The requested resource was not found"
+    icon="sap-icon://document"
+    showNavButton="true"
+    navButtonPress=".onNavBack"/>
+```
+
+## Rules
+- `async: true` is mandatory for modern UI5 apps
+- Routes are matched in order — put specific routes before generic ones
+- `viewLevel` determines transition direction (higher = deeper in nav stack)
+- Always attach `patternMatched` (not `matched`) for detail pages — fires only for this route
+- Handle 404 in `_onBindingChange` — redirect to notFound if context is null
+- Use `BaseController` for shared routing/model methods
+- Use `:?query:` for preserving filter/state in URL
+- FCL: use `sap.f.routing.Router` and `controlAggregation` per target column
+
+## Anti-Patterns
+| Anti-Pattern | Correct |
+|---|---|
+| `window.location.hash = "#/route"` | `this.getRouter().navTo("route")` |
+| Attaching `matched` instead of `patternMatched` | `patternMatched` fires only for the specific route |
+| Hardcoded entity path in `bindElement` | Build from route arguments |
+| Missing `bypassed` target in config | Always define a notFound target |
+| Forgetting `async: true` | Required — sync routing is deprecated |
+| Same `viewLevel` for all targets | Set incrementally (1, 2, 3) for correct transitions |
+| Missing `showNavButton` on detail pages | Always show back button on non-root pages |
+| FCL with `sap.m.routing.Router` | Use `sap.f.routing.Router` for FlexibleColumnLayout |