@sap/cds-dk 9.4.3 → 9.5.0

package/lib/init/template/sample/files/app/common.cds

@@ -2,123 +2,69 @@
  Common Annotations shared by all apps
 */
 
-using {sap.capire.bookshop as my} from '../db/schema';
-using {
-  sap.common,
-  sap.common.Currencies
-} from '@sap/cds/common';
+using { sap.capire.bookshop as my } from '../db/schema';
+using { sap.common } from '@sap/cds/common';
 
 ////////////////////////////////////////////////////////////////////////////
 //
 //	Books Lists
 //
 annotate my.Books with @(
-  Common.SemanticKey: [ID],
-  UI                : {
-    Identification : [{Value: title}],
-    SelectionFields: [
+  Common.SemanticKey : [ID],
+  UI                 : {
+    Identification  : [{ Value: title }],
+    SelectionFields : [
       ID,
       author_ID,
       price,
       currency_code
     ],
-    LineItem       : [
-      {
-        Value: ID,
-        Label: '{i18n>Title}'
-      },
-      {
-        Value: author.ID,
-        Label: '{i18n>Author}'
-      },
-      {Value: genre.name},
-      {Value: stock},
-      {Value: price},
-      {Value: currency.symbol},
+    LineItem        : [
+      { Value: ID, Label: '{i18n>Title}' },
+      { Value: author.ID, Label: '{i18n>Author}' },
+      { Value: genre.name },
+      { Value: stock },
+      { Value: price },
+      { Value: currency.symbol },
     ]
   }
 ) {
-  ID     @Common          : {
+  ID  @Common: {
     SemanticObject : 'Books',
-    Text           : title,
-    TextArrangement: #TextOnly
+    Text: title,
+    TextArrangement : #TextOnly
   };
-  author @ValueList.entity: 'Authors';
+  author @ValueList.entity      : 'Authors';
 };
 
-annotate Currencies with {
-  symbol @Common.Label: '{i18n>Currency}';
-}
-
-
-////////////////////////////////////////////////////////////////////////////
-//
-//	Books Elements
-//
-annotate my.Books with {
-  ID      @title: '{i18n>ID}';
-  title   @title: '{i18n>Title}';
-  genre   @title: '{i18n>Genre}'        @Common              : {
-    Text           : genre.name,
-    TextArrangement: #TextOnly
-  };
-  author  @title: '{i18n>Author}'       @Common              : {
-    Text           : author.name,
-    TextArrangement: #TextOnly
-  };
-  price   @title: '{i18n>Price}'        @Measures.ISOCurrency: currency_code;
-  stock   @title: '{i18n>Stock}';
-  descr   @title: '{i18n>Description}'  @UI.MultiLineText;
+annotate common.Currencies with {
+  symbol @Common.Label : '{i18n>Currency}';
 }
 
 ////////////////////////////////////////////////////////////////////////////
 //
-//	Genres List
+//	Books Details
 //
-annotate my.Genres with @(
-  Common.SemanticKey: [name],
-  UI                : {
-    SelectionFields: [name],
-    LineItem       : [
-      {Value: name},
-      {
-        Value: parent.name,
-        Label: '{i18n>MainGenre}'
-      },
-    ],
-  }
-);
+annotate my.Books with @(UI : {HeaderInfo : {
+  TypeName       : '{i18n>Book}',
+  TypeNamePlural : '{i18n>Books}',
+  Title          : { Value: title },
+  Description    : { Value: author.name }
+}, });
 
-annotate my.Genres with {
-  ID  @Common.Text: name  @Common.TextArrangement: #TextOnly;
-}
 
 ////////////////////////////////////////////////////////////////////////////
 //
-//	Genre Details
-//
-annotate my.Genres with @(UI: {
-  Identification: [{Value: name}],
-  HeaderInfo    : {
-    TypeName      : '{i18n>Genre}',
-    TypeNamePlural: '{i18n>Genres}',
-    Title         : {Value: name},
-    Description   : {Value: ID}
-  },
-  Facets        : [{
-    $Type : 'UI.ReferenceFacet',
-    Label : '{i18n>SubGenres}',
-    Target: 'children/@UI.LineItem'
-  }, ],
-});
-
-////////////////////////////////////////////////////////////////////////////
-//
-//	Genres Elements
+//	Books Elements
 //
-annotate my.Genres with {
-  ID   @title: '{i18n>ID}';
-  name @title: '{i18n>Genre}';
+annotate my.Books with {
+  ID     @title: '{i18n>ID}';
+  title  @title: '{i18n>Title}';
+  genre  @title: '{i18n>Genre}'   @Common: { Text: genre.name, TextArrangement: #TextOnly };
+  author @title: '{i18n>Author}'  @Common: { Text: author.name, TextArrangement: #TextOnly };
+  price  @title: '{i18n>Price}'   @Measures.ISOCurrency : currency_code;
+  stock  @title: '{i18n>Stock}';
+  descr  @title: '{i18n>Description}'  @UI.MultiLineText;
 }
 
 ////////////////////////////////////////////////////////////////////////////
@@ -126,23 +72,23 @@ annotate my.Genres with {
 //	Authors List
 //
 annotate my.Authors with @(
-  Common.SemanticKey: [ID],
-  UI                : {
-    Identification : [{Value: name}],
-    SelectionFields: [name],
-    LineItem       : [
-      {Value: ID},
-      {Value: dateOfBirth},
-      {Value: dateOfDeath},
-      {Value: placeOfBirth},
-      {Value: placeOfDeath},
+  Common.SemanticKey : [ID],
+  UI                 : {
+    Identification  : [{ Value: name}],
+    SelectionFields : [name],
+    LineItem        : [
+      { Value: ID },
+      { Value: dateOfBirth },
+      { Value: dateOfDeath },
+      { Value: placeOfBirth },
+      { Value: placeOfDeath },
     ],
   }
 ) {
-  ID @Common: {
+  ID  @Common: {
     SemanticObject : 'Authors',
-    Text           : name,
-    TextArrangement: #TextOnly,
+    Text: name,
+    TextArrangement : #TextOnly,
   };
 };
 
@@ -150,17 +96,17 @@ annotate my.Authors with @(
 //
 //	Author Details
 //
-annotate my.Authors with @(UI: {
-  HeaderInfo: {
-    TypeName      : '{i18n>Author}',
-    TypeNamePlural: '{i18n>Authors}',
-    Title         : {Value: name},
-    Description   : {Value: dateOfBirth}
+annotate my.Authors with @(UI : {
+  HeaderInfo : {
+    TypeName       : '{i18n>Author}',
+    TypeNamePlural : '{i18n>Authors}',
+    Title          : { Value: name },
+    Description    : { Value: dateOfBirth }
   },
-  Facets    : [{
-    $Type : 'UI.ReferenceFacet',
-    Target: 'books/@UI.LineItem'
-  }],
+  Facets     : [{
+    $Type  : 'UI.ReferenceFacet',
+    Target : 'books/@UI.LineItem'
+  }, ],
 });
 
 
@@ -182,16 +128,16 @@ annotate my.Authors with {
 //	Languages List
 //
 annotate common.Languages with @(
-  Common.SemanticKey: [code],
-  Identification    : [{Value: code}],
-  UI                : {
-    SelectionFields: [
+  Common.SemanticKey : [code],
+  Identification     : [{ Value: code}],
+  UI                 : {
+    SelectionFields : [
       name,
       descr
     ],
-    LineItem       : [
-      {Value: code},
-      {Value: name},
+    LineItem        : [
+      { Value: code },
+      { Value: name },
     ],
   }
 );
@@ -200,22 +146,22 @@ annotate common.Languages with @(
 //
 //	Language Details
 //
-annotate common.Languages with @(UI: {
-  HeaderInfo         : {
-    TypeName      : '{i18n>Language}',
-    TypeNamePlural: '{i18n>Languages}',
-    Title         : {Value: name},
-    Description   : {Value: descr}
+annotate common.Languages with @(UI : {
+  HeaderInfo          : {
+    TypeName       : '{i18n>Language}',
+    TypeNamePlural : '{i18n>Languages}',
+    Title          : { Value: name },
+    Description    : { Value: descr }
   },
-  Facets             : [{
-    $Type : 'UI.ReferenceFacet',
-    Label : '{i18n>Details}',
-    Target: '@UI.FieldGroup#Details'
+  Facets              : [{
+    $Type  : 'UI.ReferenceFacet',
+    Label  : '{i18n>Details}',
+    Target : '@UI.FieldGroup#Details'
   }, ],
-  FieldGroup #Details: {Data: [
-    {Value: code},
-    {Value: name},
-    {Value: descr}
+  FieldGroup #Details : {Data : [
+    { Value: code },
+    { Value: name },
+    { Value: descr }
   ]},
 });
 
@@ -224,17 +170,17 @@ annotate common.Languages with @(UI: {
 //	Currencies List
 //
 annotate common.Currencies with @(
-  Common.SemanticKey: [code],
-  Identification    : [{Value: code}],
-  UI                : {
-    SelectionFields: [
+  Common.SemanticKey : [code],
+  Identification     : [{ Value: code}],
+  UI                 : {
+    SelectionFields : [
       name,
       descr
     ],
-    LineItem       : [
-      {Value: descr},
-      {Value: symbol},
-      {Value: code},
+    LineItem        : [
+      { Value: descr },
+      { Value: symbol },
+      { Value: code },
     ],
   }
 );
@@ -243,22 +189,44 @@ annotate common.Currencies with @(
 //
 //	Currency Details
 //
-annotate common.Currencies with @(UI: {
-  HeaderInfo         : {
-    TypeName      : '{i18n>Currency}',
-    TypeNamePlural: '{i18n>Currencies}',
-    Title         : {Value: descr},
-    Description   : {Value: code}
+annotate common.Currencies with @(UI : {
+  HeaderInfo           : {
+    TypeName       : '{i18n>Currency}',
+    TypeNamePlural : '{i18n>Currencies}',
+    Title          : { Value: descr },
+    Description    : { Value: code }
   },
-  Facets             : [{
-    $Type : 'UI.ReferenceFacet',
-    Label : '{i18n>Details}',
-    Target: '@UI.FieldGroup#Details'
-  }],
-  FieldGroup #Details: {Data: [
-    {Value: name},
-    {Value: symbol},
-    {Value: code},
-    {Value: descr}
-  ]}
+  Facets               : [
+    {
+      $Type  : 'UI.ReferenceFacet',
+      Label  : '{i18n>Details}',
+      Target : '@UI.FieldGroup#Details'
+    },
+    {
+      $Type  : 'UI.ReferenceFacet',
+      Label  : '{i18n>Extended}',
+      Target : '@UI.FieldGroup#Extended'
+    },
+  ],
+  FieldGroup #Details  : {Data : [
+    { Value: name },
+    { Value: symbol },
+    { Value: code },
+    { Value: descr }
+  ]},
+  FieldGroup #Extended : {Data : [
+    { Value: numcode },
+    { Value: minor },
+    { Value: exponent }
+  ]},
 });
+
+////////////////////////////////////////////////////////////////////////////
+//
+//	Currencies Elements
+//
+annotate common.Currencies with {
+  numcode  @title: '{i18n>NumCode}';
+  minor    @title: '{i18n>MinorUnit}';
+  exponent @title: '{i18n>Exponent}';
+}

package/lib/init/template/sample/files/app/fiori-apps.html

@@ -0,0 +1,30 @@
+<!doctype html>
+<html>
+
+<head>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+  <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Bookshop</title>
+
+  <script>
+    window["sap-ushell-config"] = {
+      defaultRenderer: "fiori2",
+      applications: {},
+    };
+  </script>
+
+  <script id="sap-ushell-bootstrap" src="https://ui5.sap.com/test-resources/sap/ushell/bootstrap/sandbox.js"></script>
+  <script id="sap-ui-bootstrap" src="https://ui5.sap.com/resources/sap-ui-core.js"
+    data-sap-ui-libs="sap.m, sap.ushell, sap.collaboration, sap.ui.layout" data-sap-ui-compatVersion="edge"
+    data-sap-ui-theme="sap_horizon"></script>
+  <script>
+    sap.ui.getCore().attachInit(() =>
+      sap.ushell.Container.createRenderer().placeAt("content")
+    );
+  </script>
+</head>
+
+<body class="sapUiBody" id="content"></body>
+
+</html>

package/lib/init/template/sample/files/app/genres/fiori-service.cds

@@ -0,0 +1,33 @@
+using { sap.capire.bookshop.Genres } from '../../db/schema';
+
+annotate Genres with @cds.search: {name};
+annotate Genres with @readonly;
+annotate Genres with {
+  name @title: '{i18n>Genre}';
+}
+
+// Lists
+annotate Genres with @(
+  Common.SemanticKey : [name],
+  UI.SelectionFields : [name],
+  UI.LineItem : [
+   { Value: name, Label: '{i18n>Name}' },
+  ],
+);
+
+// Details
+annotate Genres with @(UI : {
+  Identification : [{ Value: name }],
+  HeaderInfo     : {
+    TypeName       : '{i18n>Genre}',
+    TypeNamePlural : '{i18n>Genres}',
+    Title          : { Value: name },
+    Description    : { Value: ID }
+  }
+});
+
+
+// Tree Views
+// annotate AdminService.Genres with @hierarchy; // upcomming simplification
+using from './tree-view';
+using from './value-help';

package/lib/init/template/sample/files/app/genres/tree-view.cds

@@ -0,0 +1,42 @@
+using { AdminService } from '../../srv/admin-service';
+
+////////////////////////////////////////////////////////////////////////////
+//
+//	Genres Tree View
+//
+
+// Tell Fiori about the structure of the hierarchy
+annotate AdminService.Genres with @Aggregation.RecursiveHierarchy #GenresHierarchy : {
+  ParentNavigationProperty : parent, // navigates to a node's parent
+  NodeProperty             : ID, // identifies a node, usually the key
+};
+
+// Fiori expects the following to be defined explicitly, even though they're always the same
+extend AdminService.Genres with @(
+  // The columns expected by Fiori to be present in hierarchy entities
+  Hierarchy.RecursiveHierarchy #GenresHierarchy : {
+    LimitedDescendantCount : LimitedDescendantCount,
+    DistanceFromRoot       : DistanceFromRoot,
+    DrillState             : DrillState,
+    LimitedRank            : LimitedRank
+  },
+  // Disallow filtering on these properties from Fiori UIs
+  Capabilities.FilterRestrictions.NonFilterableProperties: [
+    'LimitedDescendantCount',
+    'DistanceFromRoot',
+    'DrillState',
+    'LimitedRank'
+  ],
+  // Disallow sorting on these properties from Fiori UIs
+  Capabilities.SortRestrictions.NonSortableProperties    : [
+    'LimitedDescendantCount',
+    'DistanceFromRoot',
+    'DrillState',
+    'LimitedRank'
+  ],
+) columns { // Ensure we can query these fields from database
+  null as LimitedDescendantCount : Int16,
+  null as DistanceFromRoot       : Int16,
+  null as DrillState             : String,
+  null as LimitedRank            : Int16,
+};

package/lib/init/template/sample/files/app/genres/value-help.cds

@@ -0,0 +1,6 @@
+// Value help with Tree View
+using from '../admin-books/fiori-service';
+annotate AdminService.Books:genre with @Common.ValueList.PresentationVariantQualifier: 'VH';
+annotate AdminService.Genres with @UI.PresentationVariant #VH: {
+  RecursiveHierarchyQualifier : 'GenresHierarchy',
+};

package/lib/init/template/sample/files/app/genres/webapp/Component.js.hbs

@@ -0,0 +1,3 @@
+sap.ui.define(["sap/fe/core/AppComponent"], ac => ac.extend("{{appName}}.{{app}}.Component", {
+  metadata:{ manifest:'json' }
+}))

package/lib/init/template/sample/files/app/genres/webapp/i18n/i18n.properties

@@ -0,0 +1,4 @@
+#XTIT
+appTitle=Browse Genres
+#XTXT
+appDescription=Genres as Tree View

package/lib/init/template/sample/files/app/genres/webapp/i18n/i18n_de.properties

@@ -0,0 +1,2 @@
+appTitle=Zeige Genres
+appDescription=Genres als Baumansicht

package/lib/init/template/sample/files/app/genres/webapp/manifest.json

@@ -0,0 +1,126 @@
+{
+  "_version": "1.8.0",
+  "sap.app": {
+    "id": "genres",
+    "type": "application",
+    "title": "{{appTitle}}",
+    "description": "{{appDescription}}",
+    "applicationVersion": {
+      "version": "1.0.0"
+    },
+    "dataSources": {
+      "AdminService": {
+        "uri": "odata/v4/admin/",
+        "type": "OData",
+        "settings": {
+          "odataVersion": "4.0"
+        }
+      }
+    },
+    "crossNavigation": {
+      "inbounds": {
+        "Genres-display": {
+          "signature": {
+            "parameters": {},
+            "additionalParameters": "allowed"
+          },
+          "title": "{{appTitle}}",
+          "subTitle": "{{appDescription}}",
+          "semanticObject": "Genres",
+          "action": "display"
+        }
+      }
+    }
+  },
+  "sap.ui5": {
+    "dependencies": {
+      "minUI5Version": "1.136.0",
+      "libs": {
+        "sap.fe.templates": {}
+      }
+    },
+    "models": {
+      "i18n": {
+        "type": "sap.ui.model.resource.ResourceModel",
+        "uri": "i18n/i18n.properties"
+      },
+      "": {
+        "dataSource": "AdminService",
+        "settings": {
+          "synchronizationMode": "None",
+          "operationMode": "Server",
+          "autoExpandSelect": true,
+          "earlyRequests": true
+        }
+      }
+    },
+    "routing": {
+      "routes": [
+        {
+          "pattern": ":?query:",
+          "name": "GenresList",
+          "target": "GenresList"
+        },
+        {
+          "pattern": "Genres({key}):?query:",
+          "name": "GenresDetails",
+          "target": "GenresDetails"
+        }
+      ],
+      "targets": {
+        "GenresList": {
+          "type": "Component",
+          "id": "GenresList",
+          "name": "sap.fe.templates.ListReport",
+          "options": {
+            "settings": {
+              "contextPath": "/Genres",
+              "liveMode": true,
+              "navigation": {
+                "Genres": {
+                  "detail": {
+                    "route": "GenresDetails"
+                  }
+                }
+              },
+              "controlConfiguration": {
+                "@com.sap.vocabularies.UI.v1.LineItem": {
+                  "tableSettings": {
+                    "hierarchyQualifier": "GenresHierarchy",
+                    "type": "TreeTable"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "GenresDetails": {
+          "type": "Component",
+          "id": "GenresDetails",
+          "name": "sap.fe.templates.ObjectPage",
+          "options": {
+            "settings": {
+              "contextPath": "/Genres"
+            }
+          }
+        }
+      }
+    },
+    "contentDensities": {
+      "compact": true,
+      "cozy": true
+    }
+  },
+  "sap.ui": {
+    "technology": "UI5",
+    "deviceTypes": {
+      "desktop": true,
+      "tablet": true,
+      "phone": true
+    }
+  },
+  "sap.fiori": {
+    "registrationIds": [],
+    "archeType": "transactional"
+  }
+}

package/lib/init/template/sample/files/app/services.cds

@@ -1,6 +1,10 @@
 /*
   This model controls what gets served to Fiori frontends...
 */
-using from './common';
-using from './browse/fiori-service';
+
+using from './admin-authors/fiori-service';
 using from './admin-books/fiori-service';
+using from './browse/fiori-service';
+using from './genres/fiori-service';
+
+using from './common';

package/lib/init/template/sample/files/db/currencies.cds

@@ -0,0 +1,13 @@
+using { sap } from '@sap/cds/common';
+
+extend sap.common.Currencies with {
+  // Currencies.code = ISO 4217 alphabetic three-letter code
+  // with the first two letters being equal to ISO 3166 alphabetic country codes
+  // See also:
+  // [1] https://www.iso.org/iso-4217-currency-codes.html
+  // [2] https://www.currency-iso.org/en/home/tables/table-a1.html
+  // [3] https://www.ibm.com/support/knowledgecenter/en/SSZLC2_7.0.0/com.ibm.commerce.payments.developer.doc/refs/rpylerl2mst97.htm
+  numcode  : Integer;
+  exponent : Integer; //> e.g. 2 --> 1 Dollar = 10^2 Cent
+  minor    : String; //> e.g. 'Cent'
+}