Compare commits

..

147 Commits

Author SHA1 Message Date
D065023
a2febd57db Merge branch 'dkom' of https://github.com/SAP-samples/cloud-cap-samples into dkom 2020-02-10 18:05:44 +01:00
D065023
5073af37d3 change folder 2020-02-10 18:05:34 +01:00
Dr. David Kunz
e8cda443ba Update README.md 2020-02-10 13:43:01 +01:00
D065023
da63d6c287 Merge branch 'dkom' of https://github.com/SAP-samples/cloud-cap-samples into dkom 2020-02-07 18:41:56 +01:00
Dr. David Kunz
009dfc53c5 Update README.md 2020-02-05 16:09:49 +01:00
Dr. David Kunz
d760516e3e Update README.md 2020-02-05 16:09:29 +01:00
Dr. David Kunz
261d238738 Update README.md 2020-02-04 09:40:53 +01:00
D065023
136eae69eb barebone 2020-01-08 18:29:28 +01:00
D065023
e0306850b4 prettier 2020-01-08 16:04:45 +01:00
D065023
b7f9b78988 prettier 2020-01-08 16:00:50 +01:00
D065023
4e5f31a29d where -> and 2020-01-08 16:00:24 +01:00
D065023
2d7efafd30 prettier 2020-01-08 16:00:07 +01:00
D065023
cf0b9c2a52 csv -> data 2020-01-08 15:28:01 +01:00
D065023
2053450404 rm tombstone 2020-01-08 13:52:23 +01:00
D065023
920600a5ff prettier 2020-01-08 13:49:59 +01:00
D065023
dc1ea91d9e prettier 2020-01-08 13:45:53 +01:00
D065023
9ba5aae999 fix bug 2020-01-08 13:43:38 +01:00
D065023
29aee15cf3 Alice doesnt need a password anymore 2020-01-07 14:47:05 +01:00
D065023
2ca5a79c7e renaming ext service 2020-01-07 12:47:30 +01:00
Dr. David Kunz
857b28aad0 Update README.md 2020-01-07 12:37:56 +01:00
Dr. David Kunz
91d1a9bcb2 Update README.md 2020-01-07 12:36:26 +01:00
Daniel
a33dbff74e restored master .cds for db/schema and cat-service 2020-01-04 07:33:35 +01:00
Daniel
7f65729dc9 Merge branch 'master' into dkom 2020-01-04 07:28:09 +01:00
Daniel
3c4aa7427e Merge branch 'master' into dkom 2020-01-03 03:10:26 +01:00
D065023
28859993ba rm file 2020-01-02 09:20:50 +01:00
D065023
e503f157f6 cosmetics 2019-12-30 14:20:11 +01:00
D065023
4eebfb5df4 cosmetics 2019-12-30 14:12:51 +01:00
D065023
28362cc835 cosmetics 2019-12-30 14:12:14 +01:00
D065023
78e6138718 minor 2019-12-30 14:09:57 +01:00
D065023
7db2c6e781 tombstone logic 2019-12-30 14:06:41 +01:00
D065023
afc5be2610 comment 2019-12-30 13:55:06 +01:00
D065023
5bc8d4dde0 cosmetics 2019-12-30 13:54:20 +01:00
D065023
60563dc816 cosmetics 2019-12-30 13:51:02 +01:00
D065023
4a1887f424 translations 2019-12-27 12:01:20 +01:00
D065023
c28287f9e4 typo 2019-12-27 11:01:58 +01:00
D065023
8cadac0051 cleanup readme 2019-12-27 10:25:35 +01:00
D065023
034c3b84f7 adjusted 2019-12-26 14:18:35 +01:00
D065023
b155754a72 adjusted 2019-12-26 14:16:59 +01:00
D065023
782e8a6696 adjusted README 2019-12-26 14:16:18 +01:00
D065023
f3c14a0625 cds -> latest 2019-12-23 18:06:04 +01:00
D065023
4cffa85079 rm todo 2019-12-23 17:26:40 +01:00
D065023
837e6bf1c8 minor 2019-12-23 17:23:00 +01:00
D065023
b394dbd234 rm event modelling 2019-12-23 17:19:53 +01:00
D065023
fdd0a256c4 made async api work 2019-12-23 15:54:52 +01:00
D065023
5b5d9da82e added eventing 2019-12-23 11:53:24 +01:00
D065023
2af54a520c Added README 2019-12-23 10:59:44 +01:00
D065023
128213aba7 rm comment 2019-12-23 10:14:14 +01:00
D065023
4bc2257cea cleanup 2019-12-23 10:12:00 +01:00
D065023
e16a343ce3 prettier 2019-12-23 10:10:03 +01:00
D065023
1f01bdf202 req.user.id === 'anonymous' in case of not logged in 2019-12-23 10:08:42 +01:00
Daniel
45843ab7bd cleaned up 2019-12-21 18:01:58 +01:00
D065023
421cea9f2b require utils 2019-12-20 16:12:29 +01:00
D065023
aa919f9d62 async conntext 2019-12-20 16:11:10 +01:00
D065023
ed814a1f75 hack for app studio 2019-12-20 16:09:11 +01:00
Daniel
c04c93cca6 c2 2019-12-20 13:37:50 +01:00
Daniel
2cde812edd cleaned up and working end to end now 2019-12-20 13:37:31 +01:00
Daniel
2f576dbb1b gaaaanz schmaler korridor 2019-12-19 18:23:38 +01:00
Daniel
7f7cd43bff adding test for GET Orders 2019-12-19 18:23:16 +01:00
Daniel
294f9feb36 added launch conf for bookshop 2019-12-19 18:22:54 +01:00
Daniel
2ebfcd8871 fixed: .contact 2019-12-19 18:22:31 +01:00
Daniel
963d0fbb6c constraint violation 2019-12-19 17:09:29 +01:00
Daniel
eebdd74bfe more work-arounds 2019-12-19 17:04:32 +01:00
Daniel
37810c9027 quick fix for empty value help 2019-12-19 16:55:02 +01:00
Daniel
48a086e9a1 quick fix for empty valuehelp 2019-12-19 16:54:21 +01:00
Daniel
659c347c71 .BusinessPartner -> .contact 2019-12-19 16:48:18 +01:00
Daniel
0bbb8e3d3b + auth conf --> we need to remove that later 2019-12-19 16:39:43 +01:00
Daniel
b3abcbcaae cleanup 2019-12-19 16:26:17 +01:00
Daniel
3716d4d5e3 fixed: auto-exposed addresses were missing 2019-12-19 16:22:42 +01:00
Daniel
226094e85c doesn' work with hana 2019-12-19 15:26:03 +01:00
Daniel
de149ea9b3 Merge branch 'D-kom-Demo' into dkom 2019-12-17 14:35:34 +01:00
Daniel
b6c1610817 updates parser version 2019-12-17 14:24:04 +01:00
Daniel
3df0981992 BUPA -> contact 2019-12-17 13:01:35 +01:00
Daniel
8c8c5f3f9d some more cosmetics tweaks 2019-12-17 12:55:09 +01:00
Daniel
2c0f69a161 some more cleanup 2019-12-17 12:46:10 +01:00
Daniel
54d0c8b35d simplified models and impl -> requires latest snapshots 2019-12-17 12:30:13 +01:00
D065023
3027a7a1e5 hack for app studio 2019-12-17 10:03:17 +01:00
David-Kunz
8eaf34f5d3 Update package.json 2019-12-17 09:59:11 +01:00
David-Kunz
0b0a22d126 Update schema.cds 2019-12-17 09:40:17 +01:00
Daniel
c0e1fb38ac cosmetics 2019-12-16 22:12:37 +01:00
D065023
74c155ca62 better 2019-12-16 21:56:32 +01:00
D065023
db16577235 no more bla 2019-12-16 21:55:33 +01:00
Daniel
53989cf609 Merge branch 'D-kom-Demo' into dkom 2019-12-16 21:54:49 +01:00
D065023
d678b51320 revert prefix 2019-12-16 21:52:43 +01:00
Daniel
5720d73b76 revised 2019-12-16 21:50:23 +01:00
D065023
06a6ac2201 fixed bug 2019-12-16 21:14:56 +01:00
D065023
125edc34e2 fixed 2019-12-16 21:12:03 +01:00
D065023
dc8e8c55df fix bug 2019-12-16 21:05:28 +01:00
D065023
f89acc00dd fix typo 2019-12-16 21:04:04 +01:00
D065023
3e725bcc26 refactor 2019-12-16 21:02:57 +01:00
D065023
dfea19334d use prefix 2019-12-16 20:22:12 +01:00
D065023
8f11de5430 cosmetics 2019-12-16 19:18:21 +01:00
D065023
38ce94d5cd syntax cleanup 2019-12-16 18:42:59 +01:00
D065023
ffe633a493 cleanup 2019-12-16 11:31:29 +01:00
D065023
e081182a7c cleanup 2019-12-16 11:30:42 +01:00
D065023
e4f8f13dbf typo 2019-12-16 11:28:06 +01:00
D065023
cc698ec23f rename ql -> query 2019-12-16 11:13:34 +01:00
D065023
382a4c562d prettier 2019-12-16 11:11:45 +01:00
D065023
811694cdf1 revert 2019-12-16 11:11:25 +01:00
D065023
83653bd095 Merge branch 'D-kom-Demo' of https://github.com/SAP-samples/cloud-cap-samples into D-kom-Demo 2019-12-16 10:29:44 +01:00
D065023
e27275d29a go to own database when remote system unavailable 2019-12-16 10:29:36 +01:00
Daniel
b9330d7f77 Merge branch 'master' into D-kom-Demo 2019-12-16 08:41:04 +01:00
D065023
f413b45e24 more checks 2019-12-13 14:26:22 +01:00
D065023
4a21b9edc3 cleaner 2019-12-13 14:20:04 +01:00
D065023
4bfd4430e1 rm comment 2019-12-13 10:42:18 +01:00
D065023
0bb3144aea rm console.logs 2019-12-13 10:41:11 +01:00
D065023
c1d2c4caef translations and cleanup 2019-12-13 09:00:56 +01:00
D065023
59f68c0f28 code reduction 2019-12-13 08:47:36 +01:00
D065023
5ba3458b27 added limit 2019-12-13 08:46:09 +01:00
D065023
199b2c8045 it works 2019-12-12 17:33:21 +01:00
Elena Oresharova
3b4abf5600 Fix side effects for address 2019-12-12 11:12:01 +01:00
D065023
f69c0ae190 fiori3 theme 2019-12-12 10:19:44 +01:00
D065023
f48cd1cc2f cosmetics 2019-12-12 10:14:23 +01:00
D065023
6bded9df98 more test data 2019-12-12 10:05:15 +01:00
D065023
5a659774b5 use msg as transaction box 2019-12-12 09:53:46 +01:00
D065023
17d6dc8cf8 rm delete 2019-12-12 08:47:50 +01:00
D065023
1a1686e340 cleanup 2019-12-11 16:38:38 +01:00
D065023
b298c9b708 fixed a bug 2019-12-11 16:37:51 +01:00
D065023
348a7b191e format 2019-12-11 13:26:22 +01:00
D065023
f56d4fe093 readonly 2019-12-11 13:22:00 +01:00
D065023
02942f5e1a nothing 2019-12-11 13:20:45 +01:00
D065023
1aa9237d20 needed to use several transactions 2019-12-11 13:19:50 +01:00
D065023
7a760cfaf8 cleanup 2019-12-11 12:52:06 +01:00
D065023
6c0d8fa444 bug fix 2019-12-11 12:49:26 +01:00
D065023
3b06003328 fixed bugs - do not change key names 2019-12-11 11:46:55 +01:00
D065023
e686b1819b fixed bugs 2019-12-11 11:46:44 +01:00
D065023
d36c2a97fa bug fix 2019-12-11 11:24:05 +01:00
D065023
f4e119342b bug fix 2019-12-11 11:19:21 +01:00
D065023
ddd02b52f2 eventing, renaming, subselecting 2019-12-11 11:12:57 +01:00
D065023
e6d5183cce impl msg mock 2019-12-06 14:35:02 +01:00
D065023
a191ecf88d rm toUpperCase for user id 2019-12-06 14:11:21 +01:00
D065023
140db39cd4 include authorization 2019-12-06 11:32:50 +01:00
D065023
68ee29598a translations 2019-12-06 11:03:59 +01:00
D065023
7deae997bb fixed minor issues 2019-12-06 10:59:50 +01:00
D065023
12aee3e38c fixed keys 2019-12-06 10:54:45 +01:00
Elena Oresharova
dfe876e2cf Fix 'City Name' label for the Address 2019-12-03 16:17:20 +01:00
Elena Oresharova
9e2c7a0974 Add side effect of filling the fields of an address once we have a selection 2019-12-03 13:54:02 +01:00
Elena Oresharova
30b2854fac Merge branch 'D-kom-Demo' of https://github.com/SAP-samples/cloud-cap-samples into D-kom-Demo 2019-12-03 13:37:07 +01:00
Elena Oresharova
4ca7e425ec Add additional columns to the value list for Addresses 2019-12-03 13:32:50 +01:00
D065023
28a51f4837 Added Country and Postal Code 2019-12-03 10:58:53 +01:00
D065023
692a360065 minor 2019-12-02 12:01:38 +01:00
D065023
b3d9fdb8b3 refactor 2019-12-02 10:57:52 +01:00
D065023
e9d10986ff rm console.log 2019-12-02 10:35:53 +01:00
D065023
7191f61806 User mapping and refactoring 2019-12-02 10:35:22 +01:00
D065023
e688e7ecee value help 2019-11-30 14:39:00 +01:00
D065023
4a2139a5f2 Address lookup to mocked S/4HANA system
What's working:
- Address information on OP
- Reading of S/4HANA Addresses
- Translations
2019-11-30 14:17:17 +01:00
D065023
ed3ecd502f async style 2019-11-29 12:24:22 +01:00
D065023
8f3d112558 prettier 2019-11-29 12:11:29 +01:00
102 changed files with 8697 additions and 2181 deletions

1
.npmrc
View File

@@ -1 +0,0 @@
@sap:registry=https://npm.sap.com

View File

@@ -1,42 +1,73 @@
# Welcome to SAP Cloud Application Programming model samples # cloud-cap-samples
Find here the samples for the openSAP course [Building Applications with the SAP Cloud Application Programming Model](https://open.sap.com/courses/cp7). This is a monorepository for sample projects on [SAP Cloud Application Programming Model](https://cap.cloud.sap).
## Get Access to SAP Business Application Studio ## Description
The recommended environment for the course is SAP Business Application Studio. Watch [unit 2 of week 1](https://open.sap.com/courses/cp7/items/51pzQUzbXHr2kdbOmVs6jI) for how to get access.
## Setup This repository provides a list of samples and reusable packages created based on SAP Cloud Application Programming Model.
The SAP Cloud Application Programming Model enables you to quickly create business applications by allowing you to focus on your domain logic. It offers a consistent end-to-end programming model that includes languages, libraries and APIs tailored for full-stack development on SAP Cloud Platform.
In SAP Business Application Studio, open a terminal. The samples provided can be run in a local setup on SQLite Database.
Then clone the repo with this specific branch:
## Requirements
* [Node.js](https://nodejs.org/en/) v8 or higher
* [Git](https://git-scm.com)
* [SQLite DB](https://www.sqlite.org/download.html) (Windows only; pre-installed on Mac/Linux)
#### Optional (if you want to import the code into an editor)
* [VS Code](https://code.visualstudio.com)
* [Add CDS extension to VS](https://cap.cloud.sap/docs/get-started/in-vscode#add-cds-editor)
## Download and Installation
#### Install `cds` development kit
```sh ```sh
git clone https://github.com/sap-samples/cloud-cap-samples projects/cloud-cap-samples -b openSAP-week2-unit1 # sets the registry for `@sap` packages
cd projects/cloud-cap-samples npm set @sap:registry=https://npm.sap.com
npm install -g @sap/cds-dk
cds #> test-run it
``` ```
Got issues? Check out the [documentation](https://cap.cloud.sap/docs/get-started/).
In the `cloud-cap-samples` folder run: #### Clone and build the application
```sh `git clone https://github.com/SAP-samples/cloud-cap-samples samples && cd samples && npm i`
npm install
```
## Run #### Run the samples
Now you're ready to run the samples, for example: With that you're ready to run the samples, e.g. start the [_bookshop_](./packages/bookshop) sample as follows:
```sh
cd packages/bookshop
cds watch
```
After that, watch out for the little popup in the lower right corner of SAP Business Application Studio that asks you to open the application in your browser. `npm run bookshop`
## Test
For example, try these links in your browser:
- <http://localhost:4004> to test with generic index page.
- <http://localhost:4004/fiori.html> to test with Fiori sandbox.
## Get Support ## Debug
Check out the cap docs at https://cap.cloud.sap. <br> For example, in [VS Code](https://code.visualstudio.com) switch to _Debug_ view and launch one of the prepared _cds run_ launch configurations.
In case you find a bug or need support, please [open an issue in here](https://github.com/SAP-samples/cloud-cap-samples/issues/new).
## Limitations
None
## Known Issues
None
## How to obtain support
Check out the documentation on https://cap.cloud.sap. In case you find a bug, or you need additional support, please open an issue [here](https://github.com/SAP-samples/cloud-cap-samples/issues/new) in GitHub.
## To-Do (upcoming changes)
None
## License ## License
Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under SAP Sample Code License Agreement, except as noted otherwise in the [LICENSE](/LICENSE) file. Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under SAP Sample Code License Agreement, except as noted otherwise in the [LICENSE](/LICENSE) file.

2064
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -11,12 +11,11 @@
"bookshop": "cds watch packages/bookshop", "bookshop": "cds watch packages/bookshop",
"bookshop-enhanced": "cds watch packages/bookshop-enhanced", "bookshop-enhanced": "cds watch packages/bookshop-enhanced",
"reviews-service": "cds watch packages/reviews-service", "reviews-service": "cds watch packages/reviews-service",
"bookstore": "cds watch packages/bookstore", "bookstore": "cds watch packages/bookstore"
"media-server": "cds watch packages/media-server"
}, },
"dependencies": { "dependencies": {
"@sap/cds": "^3", "@sap/cds": "latest",
"express": "^4" "express": "*"
}, },
"devDependencies": { "devDependencies": {
"sqlite3": "*" "sqlite3": "*"

View File

@@ -0,0 +1 @@
using from '@sap/capire-bookshop/app';

View File

@@ -0,0 +1,25 @@
/*
In this model we demonstrate how to add Genres to Books in
as if it was an external extension. For example we use
CDS Aspects' to extend the core domain model's Books entity
as well as the AdminService.
*/
namespace sap.capire.bookshop;
using { sap.capire.reviews.ReviewsService as external } from '@sap/capire-reviews';
using { sap.capire.bookshop.Books } from '@sap/capire-bookshop/db/schema';
using { sap.common.CodeList } from '@sap/cds/common';
// Extending Books by Reviews and Genres
extend Books with {
reviews : Composition of many external.Reviews on reviews.subject = ID;
rating : external.Reviews.rating;
genre : Association to Genres;
}
// Hierarchical Code List for Genres
entity Genres : CodeList {
key ID : Integer;
children : Composition of many Genres on children.parent = $self;
parent : Association to Genres;
}

View File

@@ -0,0 +1,29 @@
{
"name": "@sap/capire-bookshop-enhanced",
"version": "1.0.0",
"description": "A sample for extending a base application package, in this case bookshop, e.g. in context of verticalization or customization.",
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/capire-bookshop": "^1.0.0",
"@sap/capire-reviews": "^1.0.0",
"@sap/cds": "latest",
"express": "*"
},
"scripts": {
"reviews-service": "PORT=5005 cds run ../reviews-service --bind --in-memory?",
"start": "cds run --in-memory?",
"watch": "cds watch"
},
"cds": {
"requires": {
"sap.capire.reviews.ReviewsService": {
"kind": "odata",
"model": "@sap/capire-reviews"
},
"messaging": {
"kind": "file-based-messaging"
}
}
}
}

View File

@@ -0,0 +1,9 @@
namespace sap.capire.bookshop;
using { AdminService } from '@sap/capire-bookshop/srv/admin-service';
using { sap.capire.bookshop } from '../db/schema';
@impl:'srv/services'
extend service AdminService with {
entity Genres as projection on bookshop.Genres;
}

View File

@@ -0,0 +1,30 @@
const cds = require ('@sap/cds')
module.exports = cds.service.impl (async()=>{
const ReviewsService = await cds.connect.to ('sap.capire.reviews.ReviewsService')
const CatalogService = await cds.connect.to ('CatalogService')
const db = await cds.connect.to ('db')
// import model definitions from connected services to work with subsequently
const { Books } = db.entities
const { Reviews } = ReviewsService.entities
CatalogService.impl (srv => {
// delegate requests to read reviews to ReviewsService
srv.on ('READ', 'Books/reviews', (req) => {
const [ subject ] = req.params
const tx = ReviewsService.transaction (req)
return tx.run (SELECT.from (Reviews) .where ({subject}))
})
})
// react on event messages from reviews service
ReviewsService.on ('reviewed', (msg) => {
console.debug ('> received:', msg.event, msg.data)
const { subject, rating } = msg.data
const tx = db // TODO: db.transaction (msg)
return tx.run (UPDATE (Books, subject) .with ({rating}))
// return tx.update (Books, subject) .with ({rating})
})
})

View File

@@ -0,0 +1,33 @@
#################################################
#
# Genres
#
GET http://localhost:4004/admin/Genres?
###
POST http://localhost:4004/admin/Genres?
Content-Type: application/json
{ "ID":100, "name":"Some Sample Genres...", "children":[
{ "ID":101, "name":"Cat", "children":[
{ "ID":102, "name":"Kitty", "children":[
{ "ID":103, "name":"Kitty Cat", "children":[
{ "ID":104, "name":"Aristocat" } ]},
{ "ID":105, "name":"Kitty Bat" } ]},
{ "ID":106, "name":"Catwoman", "children":[
{ "ID":107, "name":"Catalina" } ]} ]},
{ "ID":108, "name":"Catweazle" }
]}
###
GET http://localhost:4004/admin/Genres(100)?
# &$expand=children
# &$expand=children($expand=children($expand=children($expand=children)))
###
DELETE http://localhost:4004/admin/Genres(103)
###
DELETE http://localhost:4004/admin/Genres(100)
###

View File

@@ -0,0 +1,32 @@
#################################################
#
# Reviews Service
#
### Use this one for ReviewsService running as a separate process
# Note: use 5005 instead of 4004 in case of separate service
POST http://localhost:5005/reviews/Reviews
# POST http://localhost:4004/reviews/Reviews
Content-Type: application/json;IEEE754Compatible=true
{"subject":"201", "rating":"5", "title":"boo"}
### Direct Request to ReviewsService
# Note: use 5005 instead of 4004 in case of separate service
GET http://localhost:5005/reviews/Reviews?
# GET http://localhost:4004/reviews/Reviews?
# &$filter=subject eq '201'
### Request to CatalogService > delegated to ReviewsService
GET http://localhost:4004/browse/Books(201)/reviews
### Alternative OData URL
GET http://localhost:4004/browse/Books/201/reviews
###
GET http://localhost:4004/browse/Books(201)?
&$select=ID,title,rating
# &$expand=reviews
# Note: the latter only works in case of ReviewsService in same process

View File

@@ -0,0 +1,3 @@
{
"printWidth": 120
}

View File

@@ -0,0 +1,65 @@
# Bookshop With Address Data From SAP S/4HANA
This is an extended bookshop with business-partner address data from SAP S/4HANA.
When the user creates an order and uses the value help of the shipping address,
a synchronous request to SAP S/4HANA is triggered yielding all possible addresses
belonging to this business partner. Once an address is selected, its data
is replicated into a local database. To keep data in sync, an event handler
is registered which listens to all changes of business partners and updates the
local database table.
## Prerequisites
`@sap/cds` >= 1.30
## Running With Mocks
Just execute the following command in the `bookshop` folder.
```
cds run --in-memory --with-mocks
```
## Running With an S/4HANA Backend
To run your app in non-mock mode you need an SAP S/4HANA Cloud system and connect it to your SAP Cloud Platform. You can use the
[SAP Cloud Platform Extension Factory](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/346864df64f24011b49abee07bbd79af.html) to automate parts of this task. You need to enable synchronous APIs as well as events that are sent whenever business partners are changed.
To run the app locally, you need to create a `default-env.json` file in the `bookshop` folder containing the binding information (credentials of Enterprise Messaging as well as the destination to the business-partner service).
Provide the credentials in the `cds.requires` section of the `package.json` file in the `bookshop` folder, e.g.
```json
"cds": {
"requires": {
"API_BUSINESS_PARTNER": {
"kind": "odata",
"model": "srv/external",
"credentials": {
"destination": "cap-api098"
}
},
"messaging": {
"kind": "enterprise-messaging",
"credentials": {
"prefix": "sap/S4HANAOD/c098/BO"
}
}
}
}
```
Here, `destination` is the destination of your business-partner service and `prefix` is the prefix
of the topic of the events.
Then simply run the following command in the `bookshop` folder.
```
cds run --in-memory
```
## User Flow
After starting the app, go to http://localhost:4004/fiori.html#Shell-home and open the app `Manage Orders` to create an order.
Use the value help of the shipping address to select an address. Create an order item and save the order.
Then change the address of your business partner (in the mocked case you can trigger the PATCH request in `req.http` ). Refresh
the object page of your order and see the change.

View File

@@ -0,0 +1,22 @@
Books = Books
Book = Book
ID = ID
Title = Title
Author = Author
AuthorID = Author ID
Stock = Stock
Name = Name
AuthorName = Author's Name
Authors = Authors
Order = Order
OrderItems = Order Items
Orders = Orders
Price = Price
shippingAddress = Shipping Address
cityName = City Name
houseNumber = House Number
streetName = Street Name
postalCode = Postal Code
country = Country
AddressID = Address ID
contact = Contact

View File

@@ -0,0 +1,13 @@
Books = Bücher
Book = Buch
ID = ID
Title = Titel
Authors = Autoren
Author = Autor
AuthorID = ID des Autors
AuthorName = Name des Autors
Name = Name
Stock = Bestand
Order = Bestellung
Orders = Bestellungen
Price = Preis

View File

@@ -0,0 +1,37 @@
using AdminService from '../../srv/admin-service';
////////////////////////////////////////////////////////////////////////////
//
// Books Object Page
//
annotate AdminService.Books with @(
UI: {
Facets: [
{$Type: 'UI.ReferenceFacet', Label: '{i18n>General}', Target: '@UI.FieldGroup#General'},
{$Type: 'UI.ReferenceFacet', Label: '{i18n>Details}', Target: '@UI.FieldGroup#Details'},
{$Type: 'UI.ReferenceFacet', Label: '{i18n>Admin}', Target: '@UI.FieldGroup#Admin'},
],
FieldGroup#General: {
Data: [
{Value: title},
{Value: author_ID},
{Value: descr},
]
},
FieldGroup#Details: {
Data: [
{Value: stock},
{Value: price},
{Value: currency_code, Label: '{i18n>Currency}'},
]
},
FieldGroup#Admin: {
Data: [
{Value: createdBy},
{Value: createdAt},
{Value: modifiedBy},
{Value: modifiedAt}
]
}
}
);

View File

@@ -0,0 +1,22 @@
sap.ui.define(["sap/fe/AppComponent"], ac => ac.extend("admin.Component", {
metadata:{ manifest:'json' }
}))
// sap.ui.define (["sap/ui/core/UIComponent"], ui5 => ui5.extend("bookshop.Component", {
// metadata: { manifest: "json" }
// }))
// sap.ui.define (["sap/ui/generic/app/AppComponent"], ui5 => ui5.extend("bookshop.Component", {
// metadata: { manifest: "json" }
// }))
// jQuery.sap.declare("bookshop.Component");
// sap.ui.getCore().loadLibrary("sap.ui.generic.app");
// jQuery.sap.require("sap.ui.generic.app.AppComponent");
// sap.ui.generic.app.AppComponent.extend("bookshop.Component", {
// metadata: {
// manifest: "json"
// }
// });
/* eslint no-undef:0 */

View File

@@ -0,0 +1,11 @@
# This is the resource bundle of itelo
# __ldi.translation.uuid=c3431418-9caf-11e8-98d0-529269fb1459
# JCI app descriptor contains lower case TITLE
appTitle=Bookshop Sample
# JCI app descriptor contains lower case DESCRIPTION
appSubTitle=CAP Sample Application
# JCI app descriptor contains lower case DESCRIPTION
appDescription=CDS Sample Service

View File

@@ -0,0 +1,128 @@
{
"_version": "1.8.0",
"sap.app": {
"id": "admin",
"type": "application",
"title": "Manage Books",
"description": "Sample Application",
"i18n": "i18n/i18n.properties",
"dataSources": {
"AdminService": {
"uri": "/admin/",
"type": "OData",
"settings": {
"odataVersion": "4.0"
}
}
},
"-sourceTemplate": {
"id": "ui5template.basicSAPUI5ApplicationProject",
"-id": "ui5template.smartTemplate",
"-version": "1.40.12"
}
},
"sap.ui5": {
"dependencies": {
"libs": {
"sap.fe": {}
}
},
"models": {
"i18n": {
"type": "sap.ui.model.resource.ResourceModel",
"uri": "i18n/i18n.properties"
},
"": {
"dataSource": "AdminService",
"settings": {
"synchronizationMode": "None",
"operationMode": "Server",
"autoExpandSelect" : true,
"earlyRequests": true,
"groupProperties": {
"default": {
"submit": "Auto"
}
}
}
}
},
"routing": {
"routes": [
{
"pattern": ":?query:",
"name": "BooksList",
"target": "BooksList"
},
{
"pattern": "Books({key}):?query:",
"name": "BooksDetails",
"target": "BooksDetails"
},
{
"pattern": "Books({key}/author({key2}):?query:",
"name": "AuthorsDetails",
"target": "AuthorsDetails"
}
],
"targets": {
"BooksList": {
"type": "Component",
"id": "BooksList",
"name": "sap.fe.templates.ListReport",
"options": {
"settings" : {
"entitySet" : "Books",
"navigation" : {
"Books" : {
"detail" : {
"route" : "BooksDetails"
}
}
}
}
}
},
"BooksDetails": {
"type": "Component",
"id": "BooksDetailsList",
"name": "sap.fe.templates.ObjectPage",
"options": {
"settings" : {
"entitySet" : "Books",
"navigation" : {
"Authors" : {
"detail" : {
"route" : "AuthorsDetails"
}
}
}
}
}
},
"AuthorsDetails": {
"type": "Component",
"id": "AuthorsDetailsList",
"name": "sap.fe.templates.ObjectPage",
"options": {
"settings" : {
"entitySet" : "Authors"
}
}
}
}
},
"contentDensities": {
"compact": true,
"cozy": true
}
},
"sap.ui": {
"technology": "UI5",
"fullWidth": false
},
"sap.fiori": {
"registrationIds": [],
"archeType": "transactional"
}
}

View File

@@ -0,0 +1,47 @@
using CatalogService from '../../srv/cat-service';
////////////////////////////////////////////////////////////////////////////
//
// Books Object Page
//
annotate CatalogService.Books with @(
UI: {
HeaderInfo: {
Description: {Value: author}
},
HeaderFacets: [
{$Type: 'UI.ReferenceFacet', Label: '{i18n>Description}', Target: '@UI.FieldGroup#Descr'},
],
Facets: [
{$Type: 'UI.ReferenceFacet', Label: '{i18n>Details}', Target: '@UI.FieldGroup#Price'},
],
FieldGroup#Descr: {
Data: [
{Value: descr},
]
},
FieldGroup#Price: {
Data: [
{Value: price},
{Value: currency.symbol, Label: '{i18n>Currency}'},
]
},
}
);
////////////////////////////////////////////////////////////////////////////
//
// Books Object Page
//
annotate CatalogService.Books with @(
UI: {
SelectionFields: [ ID, price, currency_code ],
LineItem: [
{Value: title},
{Value: author, Label:'{i18n>Author}'},
{Value: price},
{Value: currency.symbol, Label:' '},
]
},
);

View File

@@ -0,0 +1,22 @@
sap.ui.define(["sap/fe/AppComponent"], ac => ac.extend("bookshop.Component", {
metadata:{ manifest:'json' }
}))
// sap.ui.define (["sap/ui/core/UIComponent"], ui5 => ui5.extend("bookshop.Component", {
// metadata: { manifest: "json" }
// }))
// sap.ui.define (["sap/ui/generic/app/AppComponent"], ui5 => ui5.extend("bookshop.Component", {
// metadata: { manifest: "json" }
// }))
// jQuery.sap.declare("bookshop.Component");
// sap.ui.getCore().loadLibrary("sap.ui.generic.app");
// jQuery.sap.require("sap.ui.generic.app.AppComponent");
// sap.ui.generic.app.AppComponent.extend("bookshop.Component", {
// metadata: {
// manifest: "json"
// }
// });
/* eslint no-undef:0 */

View File

@@ -0,0 +1,11 @@
# This is the resource bundle of itelo
# __ldi.translation.uuid=c3431418-9caf-11e8-98d0-529269fb1459
# JCI app descriptor contains lower case TITLE
appTitle=Bookshop Sample
# JCI app descriptor contains lower case DESCRIPTION
appSubTitle=CAP Sample Application
# JCI app descriptor contains lower case DESCRIPTION
appDescription=CDS Sample Service

View File

@@ -0,0 +1,106 @@
{
"_version": "1.8.0",
"sap.app": {
"id": "bookshop",
"type": "application",
"title": "Browse Books",
"description": "Sample Application",
"i18n": "i18n/i18n.properties",
"dataSources": {
"CatalogService": {
"uri": "/browse/",
"type": "OData",
"settings": {
"odataVersion": "4.0"
}
}
},
"-sourceTemplate": {
"id": "ui5template.basicSAPUI5ApplicationProject",
"-id": "ui5template.smartTemplate",
"-version": "1.40.12"
}
},
"sap.ui5": {
"dependencies": {
"libs": {
"sap.fe": {}
}
},
"models": {
"i18n": {
"type": "sap.ui.model.resource.ResourceModel",
"uri": "i18n/i18n.properties"
},
"": {
"dataSource": "CatalogService",
"settings": {
"synchronizationMode": "None",
"operationMode": "Server",
"autoExpandSelect": true,
"earlyRequests": true,
"groupProperties": {
"default": {
"submit": "Auto"
}
}
}
}
},
"routing": {
"routes": [
{
"pattern": ":?query:",
"name": "BooksList",
"target": "BooksList"
},
{
"pattern": "Books({key}):?query:",
"name": "BooksDetails",
"target": "BooksDetails"
}
],
"targets": {
"BooksList": {
"type": "Component",
"id": "BooksList",
"name": "sap.fe.templates.ListReport",
"options": {
"settings": {
"entitySet": "Books",
"navigation": {
"Books": {
"detail": {
"route": "BooksDetails"
}
}
}
}
}
},
"BooksDetails": {
"type": "Component",
"id": "BooksDetailsList",
"name": "sap.fe.templates.ObjectPage",
"options": {
"settings": {
"entitySet": "Books"
}
}
}
}
},
"contentDensities": {
"compact": true,
"cozy": true
}
},
"sap.ui": {
"technology": "UI5",
"fullWidth": false
},
"sap.fiori": {
"registrationIds": [],
"archeType": "transactional"
}
}

View File

@@ -0,0 +1,84 @@
/*
Common Annotations shared by all apps
*/
using { sap.capire.bookshop as my } from '../db/schema';
////////////////////////////////////////////////////////////////////////////
//
// Books Lists
//
annotate my.Books with @(
UI: {
Identification: [{Value:title}],
SelectionFields: [ ID, author_ID, price, currency_code ],
LineItem: [
{Value: ID},
{Value: title},
{Value: author.name, Label:'{i18n>Author}'},
{Value: stock},
{Value: price},
{Value: currency.symbol, Label:' '},
]
}
) {
author @ValueList.entity:'Authors';
};
annotate my.Authors with @(
UI: {
Identification: [{Value:name}],
}
);
////////////////////////////////////////////////////////////////////////////
//
// Books Details
//
annotate my.Books with @(
UI: {
HeaderInfo: {
TypeName: '{i18n>Book}',
TypeNamePlural: '{i18n>Books}',
Title: {Value: title},
Description: {Value: author.name}
},
}
);
////////////////////////////////////////////////////////////////////////////
//
// Books Elements
//
annotate my.Books with {
ID @title:'{i18n>ID}' @UI.HiddenFilter;
title @title:'{i18n>Title}';
author @title:'{i18n>AuthorID}';
price @title:'{i18n>Price}';
stock @title:'{i18n>Stock}';
descr @UI.MultiLineText;
}
////////////////////////////////////////////////////////////////////////////
//
// Authors Elements
//
annotate my.Authors with {
ID @title:'{i18n>ID}' @UI.HiddenFilter;
name @title:'{i18n>AuthorName}';
}
annotate my.Addresses with {
ID @title:'{i18n>AddressID}';
contact @title:'{i18n>contact}';
@readonly cityName @title:'{i18n>cityName}';
@readonly streetName @title:'{i18n>streetName}';
@readonly postalCode @title:'{i18n>postalCode}';
@readonly country @title:'{i18n>country}';
@readonly houseNumber @title:'{i18n>houseNumber}';
}

View File

@@ -0,0 +1,55 @@
<!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: {
"browse-books": {
title: "Browse Books",
description: "... testing FE v42",
additionalInformation: "SAPUI5.Component=bookshop",
applicationType : "URL",
url: "/browse/webapp",
navigationMode: "embedded"
},
"manage-books": {
title: "Manage Books",
description: "... testing FE v42",
additionalInformation: "SAPUI5.Component=admin",
applicationType : "URL",
url: "/admin/webapp",
navigationMode: "embedded"
},
"manage-orders": {
title: "Manage Orders",
description: "... testing FE v42",
additionalInformation: "SAPUI5.Component=orders",
applicationType : "URL",
url: "/orders/webapp",
navigationMode: "embedded"
}
}
};
</script>
<script src="https://sapui5.hana.ondemand.com/test-resources/sap/ushell/bootstrap/sandbox.js"></script>
<script src="https://sapui5.hana.ondemand.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_fiori_3"
data-sap-ui-frameOptions="allow"
></script>
<script>
sap.ui.getCore().attachInit(()=> sap.ushell.Container.createRenderer().placeAt("content"))
</script>
</head>
<body class="sapUiBody" id="content"></body>
</html>

View File

@@ -0,0 +1,8 @@
/*
This model controls what gets served to Fiori frontends...
*/
using from './admin/fiori-service';
using from './browse/fiori-service';
using from './orders/fiori-service';
using from './common';

View File

@@ -0,0 +1,243 @@
using AdminService from '../../srv/admin-service';
annotate AdminService.Books with {
price @Common.FieldControl : #ReadOnly;
}
////////////////////////////////////////////////////////////////////////////
//
// Common
//
annotate AdminService.OrderItems with {
book @(
Common : {
Text : book.title,
FieldControl : #Mandatory
},
ValueList.entity : 'Books',
);
amount @(Common.FieldControl : #Mandatory);
}
annotate AdminService.Orders with {
shippingAddress @(Common : {
FieldControl : #Mandatory,
ValueList : {
CollectionPath : 'Addresses',
Label : 'Addresses',
SearchSupported : 'true',
Parameters : [
{
$Type : 'Common.ValueListParameterOut',
LocalDataProperty : 'shippingAddress_ID',
ValueListProperty : 'ID'
},
{
$Type : 'Common.ValueListParameterOut',
LocalDataProperty : 'shippingAddress_contact',
ValueListProperty : 'contact'
},
{
$Type : 'Common.ValueListParameterDisplayOnly',
ValueListProperty : 'postalCode'
},
{
$Type : 'Common.ValueListParameterDisplayOnly',
ValueListProperty : 'cityName'
},
{
$Type : 'Common.ValueListParameterDisplayOnly',
ValueListProperty : 'country'
},
{
$Type : 'Common.ValueListParameterDisplayOnly',
ValueListProperty : 'streetName'
},
{
$Type : 'Common.ValueListParameterDisplayOnly',
ValueListProperty : 'houseNumber'
},
]
},
});
}
////////////////////////////////////////////////////////////////////////////
//
// UI
//
annotate AdminService.Orders with @(UI : {
////////////////////////////////////////////////////////////////////////////
//
// Lists of Orders
//
SelectionFields : [
createdAt,
createdBy
],
LineItem : [
{
Value : createdBy,
Label : 'Customer'
},
{
Value : createdAt,
Label : 'Date'
}
],
////////////////////////////////////////////////////////////////////////////
//
// Order Details
//
HeaderInfo : {
TypeName : 'Order',
TypeNamePlural : 'Orders',
Title : {
Label : 'Order number ', //A label is possible but it is not considered on the ObjectPage yet
Value : OrderNo
},
Description : {Value : createdBy}
},
Identification : [ //Is the main field group
// labels not considered
{
Value : createdBy,
Label : 'Customer'
},
{
Value : createdAt,
Label : 'Date'
},
{Value : OrderNo},
{
Value : 'shippingAddress_ID',
Label : 'Address ID'
}
],
HeaderFacets : [
{
$Type : 'UI.ReferenceFacet',
Label : '{i18n>Created}',
Target : '@UI.FieldGroup#Created'
},
{
$Type : 'UI.ReferenceFacet',
Label : '{i18n>Modified}',
Target : '@UI.FieldGroup#Modified'
},
],
Facets : [
{
$Type : 'UI.ReferenceFacet',
Label : '{i18n>shippingAddress}',
Target : '@UI.FieldGroup#ShippingAddress'
},
{
$Type : 'UI.ReferenceFacet',
Label : '{i18n>Details}',
Target : '@UI.FieldGroup#Details'
},
{
$Type : 'UI.ReferenceFacet',
Label : '{i18n>OrderItems}',
Target : 'Items/@UI.LineItem'
},
],
FieldGroup #Details : {Data : [{
Value : currency_code,
Label : 'Currency'
}]},
FieldGroup #Created : {Data : [
{Value : createdBy},
{Value : createdAt},
]},
FieldGroup #Modified : {Data : [
{Value : modifiedBy},
{Value : modifiedAt},
]},
FieldGroup #ShippingAddress : {Data : [
{
Value : shippingAddress_ID,
Label : '{i18n>shippingAddress}'
},
{
Value : shippingAddress.houseNumber,
Label : '{i18n>houseNumber}'
},
{
Value : shippingAddress.streetName,
Label : '{i18n>streetName}'
},
{
Value : shippingAddress.cityName,
Label : '{i18n>cityName}'
},
{
Value : shippingAddress.postalCode,
Label : '{i18n>postalCode}'
},
]},
},
Common.SideEffects : {
EffectTypes : #ValueChange,
SourceProperties : [shippingAddress_ID],
TargetProperties : [
shippingAddress.country,
shippingAddress.houseNumber,
shippingAddress.streetName,
shippingAddress.cityName,
shippingAddress.postalCode
]
},
) {
createdAt @UI.HiddenFilter : false;
createdBy @UI.HiddenFilter : false;
};
//The enity types name is AdminService.my_bookshop_OrderItems
//The annotations below are not generated in edmx WHY?
annotate AdminService.OrderItems with @(UI : {
HeaderInfo : {
TypeName : 'Order Item',
TypeNamePlural : ' ',
Title : {Value : book.title},
Description : {Value : book.descr}
},
// There is no filterbar for items so the selctionfileds is not needed
SelectionFields : [book_ID],
////////////////////////////////////////////////////////////////////////////
//
// Lists of OrderItems
//
LineItem : [
{
Value : book_ID,
Label : 'Book'
},
//The following entry is only used to have the assoication followed in the read event
{
Value : book.price,
Label : 'Book Price'
},
{
Value : amount,
Label : 'Quantity'
},
],
Identification : [ //Is the main field group
//{Value: ID, Label:'ID'}, //A guid shouldn't be on the UI
{
Value : book_ID,
Label : 'Book'
},
{
Value : amount,
Label : 'Amount'
},
],
Facets : [{
$Type : 'UI.ReferenceFacet',
Label : '{i18n>OrderItems}',
Target : '@UI.Identification'
}, ],
}, );

View File

@@ -0,0 +1,22 @@
sap.ui.define(["sap/fe/AppComponent"], ac => ac.extend("orders.Component", {
metadata:{ manifest:'json' }
}))
// sap.ui.define (["sap/ui/core/UIComponent"], ui5 => ui5.extend("bookshop.Component", {
// metadata: { manifest: "json" }
// }))
// sap.ui.define (["sap/ui/generic/app/AppComponent"], ui5 => ui5.extend("bookshop.Component", {
// metadata: { manifest: "json" }
// }))
// jQuery.sap.declare("bookshop.Component");
// sap.ui.getCore().loadLibrary("sap.ui.generic.app");
// jQuery.sap.require("sap.ui.generic.app.AppComponent");
// sap.ui.generic.app.AppComponent.extend("bookshop.Component", {
// metadata: {
// manifest: "json"
// }
// });
/* eslint no-undef:0 */

View File

@@ -0,0 +1,11 @@
# This is the resource bundle of itelo
# __ldi.translation.uuid=c3431418-9caf-11e8-98d0-529269fb1459
# JCI app descriptor contains lower case TITLE
appTitle=Bookshop Sample
# JCI app descriptor contains lower case DESCRIPTION
appSubTitle=CAP Sample Application
# JCI app descriptor contains lower case DESCRIPTION
appDescription=CDS Sample Service

View File

@@ -0,0 +1,170 @@
{
"_version": "1.8.0",
"sap.app": {
"id": "orders",
"type": "application",
"title": "Manage Orders",
"description": "Sample Application",
"i18n": "i18n/i18n.properties",
"dataSources": {
"AdminService": {
"uri": "/admin/",
"type": "OData",
"settings": {
"odataVersion": "4.0"
}
}
},
"-sourceTemplate": {
"id": "ui5template.basicSAPUI5ApplicationProject",
"-id": "ui5template.smartTemplate",
"-version": "1.40.12"
}
},
"sap.ui5": {
"dependencies": {
"libs": {
"sap.fe": {}
}
},
"models": {
"i18n": {
"type": "sap.ui.model.resource.ResourceModel",
"uri": "i18n/i18n.properties"
},
"": {
"dataSource": "AdminService",
"settings": {
"synchronizationMode": "None",
"operationMode": "Server",
"autoExpandSelect" : true,
"earlyRequests": true,
"groupProperties": {
"default": {
"submit": "Auto"
}
}
}
}
},
"routing": {
"routes": [
{
"pattern": ":?query:",
"name": "OrdersList",
"target": "OrdersList"
},
{
"pattern": "Orders({key}):?query:",
"name": "OrdersDetails",
"target": "OrdersDetails"
},
{
"pattern": "Orders({boo})/Items({boo2}):?query:",
"name": "OrderItemsDetails",
"target": "OrderItemsDetails"
},
{
"pattern": "Books({key}):?query:",
"name": "BooksDetails",
"target": "BooksDetails"
}
],
"targets": {
"OrdersList": {
"type": "Component",
"id": "OrdersList",
"name": "sap.fe.templates.ListReport",
"options": {
"settings" : {
"entitySet" : "Orders",
"navigation" : {
"Orders" : {
"detail" : {
"route" : "OrdersDetails"
}
}
}
}
}
},
"OrdersDetails": {
"type": "Component",
"id": "OrdersDetails",
"name": "sap.fe.templates.ObjectPage",
"options": {
"settings" : {
"entitySet": "Orders",
"navigation" : {
"Items": {
"detail": {
"route": "OrderItemsDetails"
}
},
"book": {
"detail": {
"route": "BooksDetails"
}
},
"dummy": {
"detail": {
"route": "BooksDetails"
}
}
}
}
}
},
"OrderItemsDetails": {
"type": "Component",
"id": "OrderItemsDetails",
"name": "sap.fe.templates.ObjectPage",
"options": {
"settings" : {
"entitySet": "OrderItems"
}
}
},
"BooksDetails": {
"type": "Component",
"id": "BooksDetails",
"name": "sap.fe.templates.ObjectPage",
"options": {
"settings" : {
"entitySet": "Books",
"navigation": {
"author": {
"detail": {
"route": "AuthorsDetails"
}
}
}
}
}
},
"AuthorsDetails": {
"type": "Component",
"id": "AuthorsDetails",
"name": "sap.fe.templates.ObjectPage",
"options": {
"settings" : {
"entitySet": "Authors"
}
}
}
}
},
"contentDensities": {
"compact": true,
"cozy": true
}
},
"sap.ui": {
"technology": "UI5",
"fullWidth": false
},
"sap.fiori": {
"registrationIds": [],
"archeType": "transactional"
}
}

View File

@@ -1,5 +1,5 @@
ID;name ID;name;dateOfBirth;placeOfBirth;dateOfDeath;placeOfDeath
101;Emily Brontë 101;Emily Brontë;1818-07-30;Thornton, Yorkshire;1848-12-19;Haworth, Yorkshire
107;Charlotte Brontë 107;Charlotte Brontë;1818-04-21;Thornton, Yorkshire;1855-03-31;Haworth, Yorkshire
150;Edgar Allen Poe 150;Edgar Allen Poe;1809-01-19;Boston, Massachusetts;1849-10-07;Baltimore, Maryland
170;Richard Carpenter 170;Richard Carpenter;1929-08-14;Kings Lynn, Norfolk;2012-02-26;Hertfordshire, England
1 ID name dateOfBirth placeOfBirth dateOfDeath placeOfDeath
2 101 Emily Brontë 1818-07-30 Thornton, Yorkshire 1848-12-19 Haworth, Yorkshire
3 107 Charlotte Brontë 1818-04-21 Thornton, Yorkshire 1855-03-31 Haworth, Yorkshire
4 150 Edgar Allen Poe 1809-01-19 Boston, Massachusetts 1849-10-07 Baltimore, Maryland
5 170 Richard Carpenter 1929-08-14 King’s Lynn, Norfolk 2012-02-26 Hertfordshire, England

View File

@@ -1,6 +1,6 @@
ID;title;author_ID;stock ID;title;descr;author_ID;stock;price;currency_code
201;Wuthering Heights;101;12 201;Wuthering Heights;"Wuthering Heights, Emily Brontë's only novel, was published in 1847 under the pseudonym ""Ellis Bell"". It was written between October 1845 and June 1846. Wuthering Heights and Anne Brontë's Agnes Grey were accepted by publisher Thomas Newby before the success of their sister Charlotte's novel Jane Eyre. After Emily's death, Charlotte edited the manuscript of Wuthering Heights and arranged for the edited version to be published as a posthumous second edition in 1850.";101;12;11.11;GBP
207;Jane Eyre;107;11 207;Jane Eyre;"Jane Eyre /ɛər/ (originally published as Jane Eyre: An Autobiography) is a novel by English writer Charlotte Brontë, published under the pen name ""Currer Bell"", on 16 October 1847, by Smith, Elder & Co. of London. The first American edition was published the following year by Harper & Brothers of New York. Primarily a bildungsroman, Jane Eyre follows the experiences of its eponymous heroine, including her growth to adulthood and her love for Mr. Rochester, the brooding master of Thornfield Hall. The novel revolutionised prose fiction in that the focus on Jane's moral and spiritual development is told through an intimate, first-person narrative, where actions and events are coloured by a psychological intensity. The book contains elements of social criticism, with a strong sense of Christian morality at its core and is considered by many to be ahead of its time because of Jane's individualistic character and how the novel approaches the topics of class, sexuality, religion and feminism.";107;11;12.34;GBP
251;The Raven;150;333 251;The Raven;"""The Raven"" is a narrative poem by American writer Edgar Allan Poe. First published in January 1845, the poem is often noted for its musicality, stylized language, and supernatural atmosphere. It tells of a talking raven's mysterious visit to a distraught lover, tracing the man's slow fall into madness. The lover, often identified as being a student, is lamenting the loss of his love, Lenore. Sitting on a bust of Pallas, the raven seems to further distress the protagonist with its constant repetition of the word ""Nevermore"". The poem makes use of folk, mythological, religious, and classical references.";150;333;13.13;USD
252;Eleonora;150;555 252;Eleonora;"""Eleonora"" is a short story by Edgar Allan Poe, first published in 1842 in Philadelphia in the literary annual The Gift. It is often regarded as somewhat autobiographical and has a relatively ""happy"" ending.";150;555;14;USD
271;Catweazle;170;22 271;Catweazle;Catweazle is a British fantasy television series, starring Geoffrey Bayldon in the title role, and created by Richard Carpenter for London Weekend Television. The first series, produced and directed by Quentin Lawrence, was screened in the UK on ITV in 1970. The second series, directed by David Reid and David Lane, was shown in 1971. Each series had thirteen episodes, most but not all written by Carpenter, who also published two books based on the scripts.;170;22;15;EUR
1 ID title descr author_ID stock price currency_code
2 201 Wuthering Heights Wuthering Heights, Emily Brontë's only novel, was published in 1847 under the pseudonym "Ellis Bell". It was written between October 1845 and June 1846. Wuthering Heights and Anne Brontë's Agnes Grey were accepted by publisher Thomas Newby before the success of their sister Charlotte's novel Jane Eyre. After Emily's death, Charlotte edited the manuscript of Wuthering Heights and arranged for the edited version to be published as a posthumous second edition in 1850. 101 12 11.11 GBP
3 207 Jane Eyre Jane Eyre /ɛər/ (originally published as Jane Eyre: An Autobiography) is a novel by English writer Charlotte Brontë, published under the pen name "Currer Bell", on 16 October 1847, by Smith, Elder & Co. of London. The first American edition was published the following year by Harper & Brothers of New York. Primarily a bildungsroman, Jane Eyre follows the experiences of its eponymous heroine, including her growth to adulthood and her love for Mr. Rochester, the brooding master of Thornfield Hall. The novel revolutionised prose fiction in that the focus on Jane's moral and spiritual development is told through an intimate, first-person narrative, where actions and events are coloured by a psychological intensity. The book contains elements of social criticism, with a strong sense of Christian morality at its core and is considered by many to be ahead of its time because of Jane's individualistic character and how the novel approaches the topics of class, sexuality, religion and feminism. 107 11 12.34 GBP
4 251 The Raven "The Raven" is a narrative poem by American writer Edgar Allan Poe. First published in January 1845, the poem is often noted for its musicality, stylized language, and supernatural atmosphere. It tells of a talking raven's mysterious visit to a distraught lover, tracing the man's slow fall into madness. The lover, often identified as being a student, is lamenting the loss of his love, Lenore. Sitting on a bust of Pallas, the raven seems to further distress the protagonist with its constant repetition of the word "Nevermore". The poem makes use of folk, mythological, religious, and classical references. 150 333 13.13 USD
5 252 Eleonora "Eleonora" is a short story by Edgar Allan Poe, first published in 1842 in Philadelphia in the literary annual The Gift. It is often regarded as somewhat autobiographical and has a relatively "happy" ending. 150 555 14 USD
6 271 Catweazle Catweazle is a British fantasy television series, starring Geoffrey Bayldon in the title role, and created by Richard Carpenter for London Weekend Television. The first series, produced and directed by Quentin Lawrence, was screened in the UK on ITV in 1970. The second series, directed by David Reid and David Lane, was shown in 1971. Each series had thirteen episodes, most but not all written by Carpenter, who also published two books based on the scripts. 170 22 15 EUR

View File

@@ -0,0 +1,4 @@
ID;locale;title;descr
201;de;Sturmhöhe;Sturmhöhe (Originaltitel: Wuthering Heights) ist der einzige Roman der englischen Schriftstellerin Emily Brontë (18181848). Der 1847 unter dem Pseudonym Ellis Bell veröffentlichte Roman wurde vom viktorianischen Publikum weitgehend abgelehnt, heute gilt er als ein Klassiker der britischen Romanliteratur des 19. Jahrhunderts.
207;de;Jane Eyre;Jane Eyre. Eine Autobiographie (Originaltitel: Jane Eyre. An Autobiography), erstmals erschienen im Jahr 1847 unter dem Pseudonym Currer Bell, ist der erste veröffentlichte Roman der britischen Autorin Charlotte Brontë und ein Klassiker der viktorianischen Romanliteratur des 19. Jahrhunderts. Der Roman erzählt in Form einer Ich-Erzählung die Lebensgeschichte von Jane Eyre (ausgesprochen /ˌdʒeɪn ˈɛə/), die nach einer schweren Kindheit eine Stelle als Gouvernante annimmt und sich in ihren Arbeitgeber verliebt, jedoch immer wieder um ihre Freiheit und Selbstbestimmung kämpfen muss. Als klein, dünn, blass, stets schlicht dunkel gekleidet und mit strengem Mittelscheitel beschrieben, gilt die Heldin des Romans Jane Eyre nicht zuletzt aufgrund der Kino- und Fernsehversionen der melodramatischen Romanvorlage als die bekannteste englische Gouvernante der Literaturgeschichte
252;de;Eleonora;“Eleonora” ist eine Erzählung von Edgar Allan Poe. Sie wurde 1841 erstveröffentlicht. In ihr geht es um das Paradox der Treue in der Treulosigkeit.
1 ID locale title descr
2 201 de Sturmhöhe Sturmhöhe (Originaltitel: Wuthering Heights) ist der einzige Roman der englischen Schriftstellerin Emily Brontë (1818–1848). Der 1847 unter dem Pseudonym Ellis Bell veröffentlichte Roman wurde vom viktorianischen Publikum weitgehend abgelehnt, heute gilt er als ein Klassiker der britischen Romanliteratur des 19. Jahrhunderts.
3 207 de Jane Eyre Jane Eyre. Eine Autobiographie (Originaltitel: Jane Eyre. An Autobiography), erstmals erschienen im Jahr 1847 unter dem Pseudonym Currer Bell, ist der erste veröffentlichte Roman der britischen Autorin Charlotte Brontë und ein Klassiker der viktorianischen Romanliteratur des 19. Jahrhunderts. Der Roman erzählt in Form einer Ich-Erzählung die Lebensgeschichte von Jane Eyre (ausgesprochen /ˌdʒeɪn ˈɛə/), die nach einer schweren Kindheit eine Stelle als Gouvernante annimmt und sich in ihren Arbeitgeber verliebt, jedoch immer wieder um ihre Freiheit und Selbstbestimmung kämpfen muss. Als klein, dünn, blass, stets schlicht dunkel gekleidet und mit strengem Mittelscheitel beschrieben, gilt die Heldin des Romans Jane Eyre nicht zuletzt aufgrund der Kino- und Fernsehversionen der melodramatischen Romanvorlage als die bekannteste englische Gouvernante der Literaturgeschichte
4 252 de Eleonora “Eleonora” ist eine Erzählung von Edgar Allan Poe. Sie wurde 1841 erstveröffentlicht. In ihr geht es um das Paradox der Treue in der Treulosigkeit.

View File

@@ -0,0 +1,4 @@
ID;amount;parent_ID;book_ID;netAmount
58040e66-1dcd-4ffb-ab10-fdce32028b79;1;7e2f2640-6866-4dcf-8f4d-3027aa831cad;201;11.11
64e718c9-ff99-47f1-8ca3-950c850777d4;1;7e2f2640-6866-4dcf-8f4d-3027aa831cad;271;15
e9641166-e050-4261-bfee-d1e797e6cb7f;2;64e718c9-ff99-47f1-8ca3-950c850777d4;252;28
1 ID amount parent_ID book_ID netAmount
2 58040e66-1dcd-4ffb-ab10-fdce32028b79 1 7e2f2640-6866-4dcf-8f4d-3027aa831cad 201 11.11
3 64e718c9-ff99-47f1-8ca3-950c850777d4 1 7e2f2640-6866-4dcf-8f4d-3027aa831cad 271 15
4 e9641166-e050-4261-bfee-d1e797e6cb7f 2 64e718c9-ff99-47f1-8ca3-950c850777d4 252 28

View File

@@ -0,0 +1,3 @@
ID;modifiedAt;createdAt;createdBy;modifiedBy;OrderNo;currency_code
7e2f2640-6866-4dcf-8f4d-3027aa831cad;;2019-01-31;john.doe@test.com;;1;EUR
64e718c9-ff99-47f1-8ca3-950c850777d4;;2019-01-30;jane.doe@test.com;;2;EUR
1 ID modifiedAt createdAt createdBy modifiedBy OrderNo currency_code
2 7e2f2640-6866-4dcf-8f4d-3027aa831cad 2019-01-31 john.doe@test.com 1 EUR
3 64e718c9-ff99-47f1-8ca3-950c850777d4 2019-01-30 jane.doe@test.com 2 EUR

View File

@@ -0,0 +1,7 @@
code;symbol;name;descr
EUR;€;Euro;European Euro
USD;$;US Dollar;United States Dollar
CAD;$;Canadian Dollar;Canadian Dollar
AUD;$;Australian Dollar;Australian Dollar
GBP;£;Pound;Great Britain Pound
ILS;₪;Shekel;Israeli New Shekel
1 code symbol name descr
2 EUR Euro European Euro
3 USD $ US Dollar United States Dollar
4 CAD $ Canadian Dollar Canadian Dollar
5 AUD $ Australian Dollar Australian Dollar
6 GBP £ Pound Great Britain Pound
7 ILS Shekel Israeli New Shekel

View File

@@ -0,0 +1,13 @@
code;locale;name;descr
EUR;de;Euro;European Euro
USD;de;US-Dollar;United States Dollar
CAD;de;Kanadischer Dollar;Kanadischer Dollar
AUD;de;Australischer Dollar;Australischer Dollar
GBP;de;Pfund;Britische Pfund
ILS;de;Schekel;Israelische Schekel
EUR;fr;euro;de la Zone euro
USD;fr;dollar;dollar des États-Unis
CAD;fr;dollar canadien;dollar canadien
AUD;fr;dollar australien;dollar australien
GBP;fr;livre sterling;pound sterling
ILS;fr;Shekel;shekel israelien
1 code locale name descr
2 EUR de Euro European Euro
3 USD de US-Dollar United States Dollar
4 CAD de Kanadischer Dollar Kanadischer Dollar
5 AUD de Australischer Dollar Australischer Dollar
6 GBP de Pfund Britische Pfund
7 ILS de Schekel Israelische Schekel
8 EUR fr euro de la Zone euro
9 USD fr dollar dollar des États-Unis
10 CAD fr dollar canadien dollar canadien
11 AUD fr dollar australien dollar australien
12 GBP fr livre sterling pound sterling
13 ILS fr Shekel shekel israelien

View File

@@ -1,40 +1,35 @@
namespace sap.capire.bookshop; namespace sap.capire.bookshop;
using { Currency, managed } from '@sap/cds/common'; using { Currency, managed, cuid } from '@sap/cds/common';
entity Books : managed, additionalInfo { entity Books : managed {
key ID : Integer; key ID : Integer;
title : localized String(111); title : localized String(111);
descr : localized String(1111); descr : localized String(1111);
author : Association to Authors; author : Association to Authors;
stock : Integer; stock : Integer;
price : Decimal(9,2); price : Decimal(9,2);
currency : Currency; currency : Currency;
} }
entity Authors : managed { entity Authors : managed {
key ID : Integer; key ID : Integer;
name : String(111); name : String(111);
books : Association to many Books on books.author = $self; dateOfBirth : Date;
dateOfDeath : Date;
placeOfBirth : String;
placeOfDeath : String;
books : Association to many Books on books.author = $self;
} }
entity Orders : managed { entity Orders : cuid, managed {
key ID : UUID;
OrderNo : String @title:'Order Number'; //> readable key OrderNo : String @title:'Order Number'; //> readable key
Items : Composition of many OrderItems on Items.parent = $self; Items : Composition of many OrderItems on Items.parent = $self;
total : Decimal(9,2) @readonly;
currency : Currency;
} }
entity OrderItems { entity OrderItems : cuid {
key ID : UUID; parent : Association to Orders;
parent : Association to Orders; book : Association to Books;
book : Association to Books; amount : Integer;
amount : Integer; netAmount : Decimal(9,2);
}
entity Movies: additionalInfo {
key ID : Integer;
name : String(111);
}
aspect additionalInfo{
genre: String(100);
language: String(200);
} }

View File

@@ -1,14 +1,47 @@
{ {
"name": "bookshop", "name": "@sap/capire-bookshop",
"version": "1.0.0", "version": "1.0.0",
"description": "A simple CAP project.", "description": "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages.",
"repository": "<Add your repository here>", "license": "SAP SAMPLE CODE LICENSE",
"license": "ISC",
"dependencies": { "dependencies": {
"@sap/cds": "^3", "@sap/cds": "latest",
"express": "^4" "@sap/xb-msg-amqp-v100": "^0.9.31-SNAPSHOT",
"express": "*",
"passport": "^0.4.0",
"sqlite3": "^4.1.0"
}, },
"scripts": { "scripts": {
"start": "npx cds run" "start": "cds run --in-memory?",
"watch": "cds watch"
},
"cds": {
"requires": {
"API_BUSINESS_PARTNER": {
"kind": "odata",
"model": "srv/external",
"--credentials": {
"destination": "cap-api098"
}
},
"--messaging": {
"kind": "enterprise-messaging",
"credentials": {
"prefix": "sap/S4HANAOD/c098/BO"
}
}
},
"auth": {
"passport": {
"strategy": "mock",
"users": {
"alice": {
"roles": [
"admin"
],
"ID": "ALICE"
}
}
}
}
} }
} }

View File

@@ -0,0 +1,19 @@
PATCH http://localhost:4004/api-business-partner/A_BusinessPartnerAddress(BusinessPartner='ALICE',AddressID='62640')
Content-Type: application/json
Authorization: Basic QUxJQ0Utc2VjcmV0
{
"PostalCode": "123456",
"CityName": "AlteredTown"
}
###
GET http://localhost:4004/admin/Orders(ID=7e2f2640-6866-4dcf-8f4d-3027aa831cad,IsActiveEntity=false)?
&$expand=shippingAddress($select=cityName,houseNumber,postalCode,streetName)
Authorization: Basic QUxJQ0U6c2VjcmV0
###
DELETE http://localhost:4004/api-business-partner/A_BusinessPartnerAddress(BusinessPartner='ALICE',AddressID='62640')

View File

@@ -1,12 +0,0 @@
### Submit Orders
POST http://localhost:4004/browse/Orders
Content-Type: application/json
{ "OrderNo":"2019-09...", "Items":[
{ "book_ID":201, "amount":5 }
]}
# Sending this three times should result in a 409: 5 exceeds stock for book #201
### Check books entity that stock was reduced
GET http://localhost:4004/admin/Books(201)

View File

@@ -1,7 +1,16 @@
using { sap.capire.bookshop as my } from '../db/schema'; using { sap.capire.bookshop as my } from '../db/schema';
service AdminService @(_requires:'admin') {
service AdminService @(requires:'admin') {
entity Books as projection on my.Books; entity Books as projection on my.Books;
entity Movies as projection on my.Movies;
entity Authors as projection on my.Authors; entity Authors as projection on my.Authors;
entity Orders as select from my.Orders; entity Orders as select from my.Orders;
} }
// Enable Fiori Draft for Orders
annotate AdminService.Orders with @odata.draft.enabled;
// annotate AdminService.Books with @odata.draft.enabled;
// Temporary workaround -> https://github.wdf.sap.corp/cap/issues/issues/3121
extend service AdminService with {
entity OrderItems as select from my.OrderItems;
}

View File

@@ -0,0 +1,77 @@
const cds = require('@sap/cds')
module.exports = cds.service.impl(async () => {
// We are mashing up three services...
const bupa = await cds.connect.to('API_BUSINESS_PARTNER')
const admin = await cds.connect.to('AdminService')
const db = await cds.connect.to('db')
// Using reflected definitions from connected services/database
const { Addresses: externalAddresses } = bupa.entities // projection on external addresses
const { Books, Addresses } = db.entities('sap.capire.bookshop') // entities in local database
// Delegate ValueHelp requests to S/4 backend, fetching current user's addresses from there
admin.on('READ', 'Addresses', req => {
console.log('Delegating to S/4 bupa service...')
const UsersAddresses = SELECT.from(externalAddresses)
.where({ contact: req.user.id })
.and(req.query.SELECT.where)
return bupa.tx(req).run(UsersAddresses)
})
// Replicate chosen addresses from S/4 when filling orders.
admin.before('PATCH', 'Orders', async req => {
const assigned = { ID: req.data.shippingAddress_ID, contact: req.user.id }
if (!assigned.ID) return //> something else
const local = db.transaction(req)
const [replica] = await local.read(Addresses).where(assigned)
if (replica) return //> already replicated
const [address] = await bupa.tx(req).run(SELECT.from(externalAddresses).where(assigned))
if (address) return local.create(Addresses).entries(address)
})
// Subscribe to S/4 event to update local replicas when sources change in S/4.
bupa.on('BusinessPartner/Changed', async msg => {
console.log('>> received:', msg.data)
const BuPaID = msg.data.KEY[0].BUSINESSPARTNER //> S/4HANA's weird payload format
const { SELECT, UPDATE } = cds.ql(msg) //> convenient alternative to <srv>.transaction(req).run(SELECT...)
// fetch affected entries from local replicas
const replicas = await SELECT.from(Addresses).where({ contact: BuPaID })
if (replicas.length === 0) return //> not affected
// fetch changed data from S/4 -> might be less than local due to deletes
const changed = await SELECT.from(externalAddresses).where({
contact: BuPaID,
ID: replicas.map(({ ID }) => ID)
})
// update local replicas with changes from S/4
const local = db.transaction(msg) //> using that variant to benefit from bulk runs
return local.run(changed.map(a => UPDATE(Addresses, a.ID).with(a)))
})
// Validate incoming orders and reduce books' stocks.
admin.before('CREATE', 'Orders', async req => {
const { Items } = req.data
// validate input...
if (!Items || Items.length === 0) return req.reject('Please order at least one item.')
if (!req.data.shippingAddress_ID) return req.reject('Please enter a valid shipping address.', 'shippingAddress_ID')
// reduce stock on ordered books...
const all = await db.tx(req).run(
Items.map(each =>
UPDATE(Books)
.where('ID =', each.book_ID)
.and('stock >=', each.amount)
.set('stock -=', each.amount)
)
)
all.forEach(
(affectedRows, i) =>
affectedRows > 0 || req.error(409, `${Items[i].amount} exceeds stock for book #${Items[i].book_ID}`)
)
})
})
require('./utils')

View File

@@ -1,5 +1,7 @@
using { sap.capire.bookshop as my } from '../db/schema'; using { sap.capire.bookshop as my } from '../db/schema';
service CatalogService @(path:'/browse') {
@path:'/browse'
service CatalogService {
@readonly entity Books as SELECT from my.Books {*, @readonly entity Books as SELECT from my.Books {*,
author.name as author author.name as author
@@ -7,4 +9,5 @@ service CatalogService @(path:'/browse') {
@requires_: 'authenticated-user' @requires_: 'authenticated-user'
@insertonly entity Orders as projection on my.Orders; @insertonly entity Orders as projection on my.Orders;
}
}

View File

@@ -1,28 +1,29 @@
/** const cds = require('@sap/cds')
* Implementation for CatalogService defined in ./cat-service.cds const { Books } = cds.entities
*/
module.exports = (srv)=>{
// Use reflection to get the csn definition of Books /** Service implementation for CatalogService */
const {Books} = cds.entities module.exports = cds.service.impl(function () {
this.after('READ', 'Books', each => each.stock > 111 && _addDiscount2(each, 11))
this.before('CREATE', 'Orders', _reduceStock)
})
// Add some discount for overstocked books /** Add some discount for overstocked books */
srv.after ('READ','Books', (each)=>{ function _addDiscount2 (each, discount) {
if (each.stock > 111) each.title += ' -- 11% discount!' each.title += ` -- ${discount}% discount!`
}
/** Reduce stock of ordered books if available stock suffices */
async function _reduceStock (req) {
const { Items: OrderItems } = req.data
const all = await cds.transaction(req).run(() =>
OrderItems.map(order =>
UPDATE(Books)
.set('stock -=', order.amount)
.where('ID =', order.book_ID)
.and('stock >=', order.amount)
)
)
all.forEach((affectedRows, i) => {
if (affectedRows === 0) req.error(409, `${OrderItems[i].amount} exceeds stock for book #${OrderItems[i].book_ID}`)
}) })
}
// Reduce stock of books upon incoming orders
srv.before ('CREATE','Orders', async (req)=>{
const tx = cds.transaction(req), order = req.data;
if (order.Items) {
const affectedRows = await tx.run(order.Items.map(item =>
UPDATE(Books) .where({ID:item.book_ID})
.and(`stock >=`, item.amount)
.set(`stock -=`, item.amount)
)
)
if (affectedRows.some(row => !row)) req.error(409, 'Sold out, sorry')
}
})
}

View File

@@ -0,0 +1,39 @@
using { API_BUSINESS_PARTNER as external } from './external/API_BUSINESS_PARTNER.csn';
/**
* Tailor the imported API to our needs...
*/
extend service external with {
/**
* Simplified view on external addresses
*/
// @cds.persistence.skip: false
@mashup entity Addresses as projection on external.A_BusinessPartnerAddress {
key AddressID as ID,
key BusinessPartner as contact,
Country as country,
CityName as cityName,
PostalCode as postalCode,
StreetName as streetName,
HouseNumber as houseNumber
}
}
/**
* Add an entity to replicate external address data for quick access,
* e.g. when displaying lists of orders.
*/
@cds.persistence:{table,skip:false} //> create a table with the view's inferred signature
@cds.autoexpose //> auto-expose in services as targets for ValueHelps and joins
entity sap.capire.bookshop.Addresses as projection on external.Addresses;
/**
* Extend Orders with references to replicated external Addresses
*/
using { sap.capire.bookshop } from '../db/schema';
extend bookshop.Orders with {
shippingAddress : Association to bookshop.Addresses;
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,11 @@
module.exports = srv => {
srv.on(['CREATE', 'UPDATE', 'DELETE'], req => {
const payload = {
KEY: [{ BUSINESSPARTNER: req.data.BusinessPartner }]
}
console.log('<< emitting:', payload)
srv.emit('BusinessPartner/Changed', payload)
})
}

View File

@@ -0,0 +1,5 @@
BusinessPartner;AddressID;CityName;PostalCode;Country;StreetName;HouseNumber
ALICE;62640;Walldorf;69190;GER;Dietmer-Hopp-Allee;16
ALICE;62641;Berlin;69390;GER;Berlin-Street;19
BOB;62341;Karlsruhe;61390;GER;Karlsruhe-Street;19
anonymous;61321;Sometown;61290;GER;Sometown-Street;19
1 BusinessPartner AddressID CityName PostalCode Country StreetName HouseNumber
2 ALICE 62640 Walldorf 69190 GER Dietmer-Hopp-Allee 16
3 ALICE 62641 Berlin 69390 GER Berlin-Street 19
4 BOB 62341 Karlsruhe 61390 GER Karlsruhe-Street 19
5 anonymous 61321 Sometown 61290 GER Sometown-Street 19

View File

@@ -0,0 +1,27 @@
// Hack for SAP Application Studio
process.env['http_proxy'] = ''
process.env['https_proxy'] = ''
process.env['HTTP_PROXY'] = ''
process.env['HTTPS_PROXY'] = ''
const diff = (obj1, obj2) =>
Object.keys(obj1).reduce((res, curr) => (obj1[curr] === obj2[curr] ? res : (res[curr] = obj2[curr]) && res), {})
const queriesToUpdateDifferences = (entity, ownEntries, otherEntries) =>
ownEntries
.map(ownEntry => {
const otherEntry = otherEntries.find(otherEntry =>
Object.keys(entity.keys).reduce((res, curr) => res && otherEntry[curr] === ownEntry[curr], true)
)
if (otherEntry) {
const differences = diff(ownEntry, otherEntry)
if (Object.keys(differences).length) {
return UPDATE(entity)
.set(differences)
.where(Object.keys(entity.keys).reduce((res, curr) => (res[curr] = ownEntry[curr]) && res, {}))
}
}
})
.filter(el => el)
module.exports = { diff, queriesToUpdateDifferences }

View File

@@ -0,0 +1,18 @@
### Service Document
GET http://localhost:4004/browse
### Service $metadata document
GET http://localhost:4004/browse/$metadata
### Browsing Books
GET http://localhost:4004/browse/Books?
# &$select=title,author
# &$expand=currency
# &sap-language=de
### Browsing Authors
GET http://localhost:4004/admin/Authors?
# &$select=name,dateOfBirth,placeOfBirth
# &$expand=books($select=title;$expand=currency)
# &$filter=ID eq 101
# &sap-language=de

View File

@@ -0,0 +1,18 @@
### List Books with their current stocks
GET http://localhost:4004/admin/Books?$select=ID,stock
### List all Orders
GET http://localhost:4004/admin/Orders?
&$expand=Items
### Submit Orders
POST http://localhost:4004/browse/Orders
Content-Type: application/json
{ "OrderNo":"2019-09...", "Items":[
{ "book_ID":201, "amount":5 },
{ "book_ID":207, "amount":3 }
]}
# Sending this three times should result in a 409: 5 exceeds stock for book #201

View File

@@ -0,0 +1,5 @@
ID;firstname;lastname;dateOfBirth;placeOfBirth;dateOfDeath;placeOfDeath
101;Emily;Brontë;1818-07-30;Thornton, Yorkshire;1848-12-19;Haworth, Yorkshire
107;Charlotte;Brontë;1818-04-21;Thornton, Yorkshire;1855-03-31;Haworth, Yorkshire
150;Edgar Allen;Poe;1809-01-19;Boston, Massachusetts;1849-10-07;Baltimore, Maryland
170;Richard;Carpenter;1929-08-14;Kings Lynn, Norfolk;2012-02-26;Hertfordshire, England
1 ID firstname lastname dateOfBirth placeOfBirth dateOfDeath placeOfDeath
2 101 Emily Brontë 1818-07-30 Thornton, Yorkshire 1848-12-19 Haworth, Yorkshire
3 107 Charlotte Brontë 1818-04-21 Thornton, Yorkshire 1855-03-31 Haworth, Yorkshire
4 150 Edgar Allen Poe 1809-01-19 Boston, Massachusetts 1849-10-07 Baltimore, Maryland
5 170 Richard Carpenter 1929-08-14 King’s Lynn, Norfolk 2012-02-26 Hertfordshire, England

View File

@@ -0,0 +1,11 @@
ID;parent_ID;name
1;;Poetry
2;;Biography
3;;Fantasy
4;;Science Fiction
5;;Romance
6;;Mystery
7;;Thriller
8;;Dystopia
9;;Tragedy
10;;Novel
1 ID parent_ID name
2 1 Poetry
3 2 Biography
4 3 Fantasy
5 4 Science Fiction
6 5 Romance
7 6 Mystery
8 7 Thriller
9 8 Dystopia
10 9 Tragedy
11 10 Novel

View File

@@ -0,0 +1,6 @@
ID;title;descr;author_ID;stock;price;currency_code;category_ID
201;Wuthering Heights;"Wuthering Heights, Emily Brontë's only novel, was published in 1847 under the pseudonym ""Ellis Bell"". It was written between October 1845 and June 1846. Wuthering Heights and Anne Brontë's Agnes Grey were accepted by publisher Thomas Newby before the success of their sister Charlotte's novel Jane Eyre. After Emily's death, Charlotte edited the manuscript of Wuthering Heights and arranged for the edited version to be published as a posthumous second edition in 1850.";101;12;11.11;GBP;9
207;Jane Eyre;"Jane Eyre /ɛər/ (originally published as Jane Eyre: An Autobiography) is a novel by English writer Charlotte Brontë, published under the pen name ""Currer Bell"", on 16 October 1847, by Smith, Elder & Co. of London. The first American edition was published the following year by Harper & Brothers of New York. Primarily a bildungsroman, Jane Eyre follows the experiences of its eponymous heroine, including her growth to adulthood and her love for Mr. Rochester, the brooding master of Thornfield Hall. The novel revolutionised prose fiction in that the focus on Jane's moral and spiritual development is told through an intimate, first-person narrative, where actions and events are coloured by a psychological intensity. The book contains elements of social criticism, with a strong sense of Christian morality at its core and is considered by many to be ahead of its time because of Jane's individualistic character and how the novel approaches the topics of class, sexuality, religion and feminism.";107;11;12.34;GBP;10
251;The Raven;"“The Raven"" is a narrative poem by American writer Edgar Allan Poe. First published in January 1845, the poem is often noted for its musicality, stylized language, and supernatural atmosphere. It tells of a talking raven's mysterious visit to a distraught lover, tracing the man's slow fall into madness. The lover, often identified as being a student, is lamenting the loss of his love, Lenore. Sitting on a bust of Pallas, the raven seems to further distress the protagonist with its constant repetition of the word ""Nevermore"". The poem makes use of folk, mythological, religious, and classical references.";150;333;13.13;USD;1
252;Eleonora;"""Eleonora"" is a short story by Edgar Allan Poe, first published in 1842 in Philadelphia in the literary annual The Gift. It is often regarded as somewhat autobiographical and has a relatively ""happy"" ending.";150;555;14;USD;5
271;Catweazle;Catweazle is a British fantasy television series, starring Geoffrey Bayldon in the title role, and created by Richard Carpenter for London Weekend Television. The first series, produced and directed by Quentin Lawrence, was screened in the UK on ITV in 1970. The second series, directed by David Reid and David Lane, was shown in 1971. Each series had thirteen episodes, most but not all written by Carpenter, who also published two books based on the scripts.;170;22;15;EUR;3
1 ID title descr author_ID stock price currency_code category_ID
2 201 Wuthering Heights Wuthering Heights, Emily Brontë's only novel, was published in 1847 under the pseudonym "Ellis Bell". It was written between October 1845 and June 1846. Wuthering Heights and Anne Brontë's Agnes Grey were accepted by publisher Thomas Newby before the success of their sister Charlotte's novel Jane Eyre. After Emily's death, Charlotte edited the manuscript of Wuthering Heights and arranged for the edited version to be published as a posthumous second edition in 1850. 101 12 11.11 GBP 9
3 207 Jane Eyre Jane Eyre /ɛər/ (originally published as Jane Eyre: An Autobiography) is a novel by English writer Charlotte Brontë, published under the pen name "Currer Bell", on 16 October 1847, by Smith, Elder & Co. of London. The first American edition was published the following year by Harper & Brothers of New York. Primarily a bildungsroman, Jane Eyre follows the experiences of its eponymous heroine, including her growth to adulthood and her love for Mr. Rochester, the brooding master of Thornfield Hall. The novel revolutionised prose fiction in that the focus on Jane's moral and spiritual development is told through an intimate, first-person narrative, where actions and events are coloured by a psychological intensity. The book contains elements of social criticism, with a strong sense of Christian morality at its core and is considered by many to be ahead of its time because of Jane's individualistic character and how the novel approaches the topics of class, sexuality, religion and feminism. 107 11 12.34 GBP 10
4 251 The Raven “The Raven" is a narrative poem by American writer Edgar Allan Poe. First published in January 1845, the poem is often noted for its musicality, stylized language, and supernatural atmosphere. It tells of a talking raven's mysterious visit to a distraught lover, tracing the man's slow fall into madness. The lover, often identified as being a student, is lamenting the loss of his love, Lenore. Sitting on a bust of Pallas, the raven seems to further distress the protagonist with its constant repetition of the word "Nevermore". The poem makes use of folk, mythological, religious, and classical references. 150 333 13.13 USD 1
5 252 Eleonora "Eleonora" is a short story by Edgar Allan Poe, first published in 1842 in Philadelphia in the literary annual The Gift. It is often regarded as somewhat autobiographical and has a relatively "happy" ending. 150 555 14 USD 5
6 271 Catweazle Catweazle is a British fantasy television series, starring Geoffrey Bayldon in the title role, and created by Richard Carpenter for London Weekend Television. The first series, produced and directed by Quentin Lawrence, was screened in the UK on ITV in 1970. The second series, directed by David Reid and David Lane, was shown in 1971. Each series had thirteen episodes, most but not all written by Carpenter, who also published two books based on the scripts. 170 22 15 EUR 3

View File

@@ -0,0 +1,4 @@
ID;locale;title;descr
201;de;Sturmhöhe;Sturmhöhe (Originaltitel: Wuthering Heights) ist der einzige Roman der englischen Schriftstellerin Emily Brontë (18181848). Der 1847 unter dem Pseudonym Ellis Bell veröffentlichte Roman wurde vom viktorianischen Publikum weitgehend abgelehnt, heute gilt er als ein Klassiker der britischen Romanliteratur des 19. Jahrhunderts.
207;de;Jane Eyre;Jane Eyre. Eine Autobiographie (Originaltitel: Jane Eyre. An Autobiography), erstmals erschienen im Jahr 1847 unter dem Pseudonym Currer Bell, ist der erste veröffentlichte Roman der britischen Autorin Charlotte Brontë und ein Klassiker der viktorianischen Romanliteratur des 19. Jahrhunderts. Der Roman erzählt in Form einer Ich-Erzählung die Lebensgeschichte von Jane Eyre (ausgesprochen /ˌdʒeɪn ˈɛə/), die nach einer schweren Kindheit eine Stelle als Gouvernante annimmt und sich in ihren Arbeitgeber verliebt, jedoch immer wieder um ihre Freiheit und Selbstbestimmung kämpfen muss. Als klein, dünn, blass, stets schlicht dunkel gekleidet und mit strengem Mittelscheitel beschrieben, gilt die Heldin des Romans Jane Eyre nicht zuletzt aufgrund der Kino- und Fernsehversionen der melodramatischen Romanvorlage als die bekannteste englische Gouvernante der Literaturgeschichte
252;de;Eleonora;“Eleonora” ist eine Erzählung von Edgar Allan Poe. Sie wurde 1841 erstveröffentlicht. In ihr geht es um das Paradox der Treue in der Treulosigkeit.
1 ID locale title descr
2 201 de Sturmhöhe Sturmhöhe (Originaltitel: Wuthering Heights) ist der einzige Roman der englischen Schriftstellerin Emily Brontë (1818–1848). Der 1847 unter dem Pseudonym Ellis Bell veröffentlichte Roman wurde vom viktorianischen Publikum weitgehend abgelehnt, heute gilt er als ein Klassiker der britischen Romanliteratur des 19. Jahrhunderts.
3 207 de Jane Eyre Jane Eyre. Eine Autobiographie (Originaltitel: Jane Eyre. An Autobiography), erstmals erschienen im Jahr 1847 unter dem Pseudonym Currer Bell, ist der erste veröffentlichte Roman der britischen Autorin Charlotte Brontë und ein Klassiker der viktorianischen Romanliteratur des 19. Jahrhunderts. Der Roman erzählt in Form einer Ich-Erzählung die Lebensgeschichte von Jane Eyre (ausgesprochen /ˌdʒeɪn ˈɛə/), die nach einer schweren Kindheit eine Stelle als Gouvernante annimmt und sich in ihren Arbeitgeber verliebt, jedoch immer wieder um ihre Freiheit und Selbstbestimmung kämpfen muss. Als klein, dünn, blass, stets schlicht dunkel gekleidet und mit strengem Mittelscheitel beschrieben, gilt die Heldin des Romans Jane Eyre nicht zuletzt aufgrund der Kino- und Fernsehversionen der melodramatischen Romanvorlage als die bekannteste englische Gouvernante der Literaturgeschichte
4 252 de Eleonora “Eleonora” ist eine Erzählung von Edgar Allan Poe. Sie wurde 1841 erstveröffentlicht. In ihr geht es um das Paradox der Treue in der Treulosigkeit.

View File

@@ -0,0 +1,18 @@
namespace sap.capire.bookstore;
// We reuse Products, which are Books in our domain
using { sap.capire.products.Products as Books } from '@sap/capire-products';
extend Books with {
author : Association to Authors;
rating : Decimal(2,1);
}
// We reuse aspect Person to define Authors
using { sap.capire.contacts.Person } from '@sap/capire-contacts';
entity Authors : Person {
key ID : UUID;
books : Association to many Books on books.author = $self;
}
// we use enhanced currencies code lists
using from '@sap/capire-currencies';

View File

@@ -0,0 +1,48 @@
{
"name": "@sap/capire-bookstore",
"version": "1.0.0",
"description": "A variant of the bookshop application, built on top of products-service and common reuse packages.",
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/capire-products": "^1.0.0",
"@sap/capire-reviews": "^1.0.0",
"@sap/capire-orders": "^1.0.0",
"@sap/capire-media": "^1.0.0",
"@sap/capire-users": "^1.0.0",
"@sap/capire-contacts": "^1.0.0",
"@sap/capire-currencies": "^1.0.0",
"@sap/cds": "latest",
"express": "*"
},
"bundledDependencies": [
"@sap/capire-products",
"@sap/capire-reviews",
"@sap/capire-orders",
"@sap/capire-media",
"@sap/capire-users",
"@sap/capire-contacts",
"@sap/capire-currencies"
],
"files": [
"app", "srv", "db"
],
"scripts": {
"start": "cds run --in-memory?",
"watch": "cds watch"
},
"cds": {
"requires": {
"db": {
"kind": "sql"
},
"sap.capire.media.MediaServer": {
"kind": "rest"
},
"sap.capire.reviews.ReviewsService": {
"model": "@sap/capire-reviews",
"kind": "odata"
}
}
}
}

View File

@@ -0,0 +1,12 @@
//----------------------
// workarounds -> should be done by @cds-compiler
annotate cds.UUID with @odata.Type: 'Edm.String';
using from '@sap/capire-products';
annotate sap.capire.products.Products with { texts @odata.contained }
annotate sap.capire.products.Categories with { texts @odata.contained }
annotate sap.capire.reviews.ReviewsService with @imported;
annotate sap.capire.reviews.Reviews with @cds.persistence.skip;
annotate sap.capire.reviews.Likes with @cds.persistence.skip;

View File

@@ -0,0 +1,35 @@
namespace sap.capire.bookstore;
// Service for all users to browse books
using { sap.capire.products } from '../db/schema';
service CatalogService @(path:'browse'){
@readonly entity Books as select from products.Products { *,
author.firstname ||' '|| author.lastname as author : String,
category.name as genre,
} excluding { createdBy, modifiedBy };
@readonly entity Genres as projection on products.Categories;
}
// Reuse AdminService from @sap/capire-products...
using { sap.capire.products.AdminService } from '@sap/capire-products';
using { sap.capire.bookstore as my } from '../db/schema';
extend service AdminService with @(impl:'srv/services.js') {
entity Authors as projection on my.Authors;
}
// Adding reviews via @sap/capire-reviews service
using { sap.capire.reviews.ReviewsService as external } from '@sap/capire-reviews';
extend service CatalogService with {
@readonly entity Reviews as projection on external.Reviews;
}
// Adding images via @sap/capire-media service
using from '@sap/capire-media';
// using from '@sap/capire-orders';
// using from '@sap/capire-users';

View File

@@ -0,0 +1,38 @@
const cds = require('@sap/cds')
module.exports['sap.capire.bookstore.CatalogService'] = cds.service.impl (async (srv) => {
const ReviewsService = await cds.connect.to ('sap.capire.reviews.ReviewsService')
const { Reviews } = ReviewsService.entities
const { Books } = srv.entities
// delegate requests to reviews service
srv.on('READ', 'Reviews', async (req) => {
const { SELECT } = cds.ql(req)
const results = await SELECT.from (Reviews)
// TODO: Should actually be using .where of fluent query API
if (req.query.SELECT.where) {
return results.filter (row => row.subject === req.query.SELECT.where[2].val)
}
return results
})
// react on event messages from reviews service
ReviewsService.on ('reviewed', (msg) => {
console.debug ('> received message:', msg.event, msg.data)
const {subject,rating} = msg.data
const tx = cds // cds.transaction(msg) // TODO: how to add multi-tenancy?
return tx.run (UPDATE(Books).set({rating}) .where ({ID:subject})) //.then (console.log)
})
})
// FIXME: pls remove this...
process.env.destinations = JSON.stringify([{
name: 'reviewsDest',
url: 'http://localhost:4005/reviews',
username: 'dummy',
password: 'dummy'
}])

View File

@@ -0,0 +1,7 @@
using { sap.capire.products as my } from '../db/schema';
service BooksService {
entity Books as SELECT from my.Products;
}
annotate cds.UUID with @odata.Type: 'Edm.String';

View File

@@ -0,0 +1,190 @@
const cds = require ('@sap/cds')
describe('Localized data on db level', ()=>{
let db, Books
it ('should deploy the db schema to sqlite in-memory', async()=>{
db = await cds.deploy (__dirname+'/books') .to ('sqlite::memory:')
expect (db.model) .toBeDefined()
Books = db.entities('sap.capire.products').Products
expect (Books) .toBeDefined()
})
it ('should list all books with default language', async ()=>{
const books = await SELECT.from (Books, b=>b.title)
expect (books) .toMatchObject([
{ title: 'Wuthering Heights' },
{ title: 'Jane Eyre' },
{ title: 'The Raven' },
{ title: 'Eleonora' },
{ title: 'Catweazle' }
])
})
it ('should read translated texts from Books_texts', async ()=>{
const texts = await SELECT ('locale','title').from (Books+'_texts')
expect (texts) .toMatchObject ([
{ locale: 'de', title: 'Sturmhöhe' },
{ locale: 'de', title: 'Jane Eyre' },
{ locale: 'de', title: 'Eleonora' }
])
})
it ('should read translated texts from Books.texts', async ()=>{
const book = await SELECT.one.from (Books, b=>{
b.ID, b.title, b.texts(t=> {
t.locale, t.title
})
}) .where ({title:'Wuthering Heights'})
expect (book) .toMatchObject ({
title: 'Wuthering Heights', texts:[
{locale:'de',title:'Sturmhöhe'}
]
})
})
it ('should insert books with translated texts', async ()=>{
const n = await INSERT.into (Books) .entries ({ ID:444, title:'A New Book', texts:[
{locale:'de', title:'Ein Neues Buch'},
{locale:'fr', title:'Un Nouveau Livre'},
]})
expect(n).toBe(3)
})
it ('should delete books w/ cascaded delete to texts', async()=>{
const n = await DELETE.from(Books) .where ({ID:444})
expect(n).toBe(3)
})
})
describe('Localized data on service level', ()=>{
let srv, Books
it ('should serve BooksService', async()=>{
srv = await cds.serve('BooksService').from(__dirname+'/books')
expect (srv.model) .toBeDefined()
Books = srv.entities.Books
expect (Books) .toBeDefined()
})
it ('should list all books with default language', async ()=>{
const books = await srv.read (Books, b=>b.title)
expect (books) .toMatchObject([
{ title: 'Wuthering Heights' },
{ title: 'Jane Eyre' },
{ title: 'The Raven' },
{ title: 'Eleonora' },
{ title: 'Catweazle' }
])
})
it ('should read Books with translated texts', async ()=>{
const book = await srv.run (
SELECT.from (Books, b=>{ b.ID, b.title, b.texts(t=> {
t.locale, t.title
})}) .where ({title:'Wuthering Heights'})
)
expect (book) .toMatchObject ([{
title: 'Wuthering Heights', texts:[
{locale:'de',title:'Sturmhöhe'}
]
}])
})
it ('should do the same with convenient method', async ()=>{
const book = await srv.read (Books, b=>{ b.ID, b.title, b.texts(t=> {
t.locale, t.title
})}) .where ({title:'Wuthering Heights'})
expect (book) .toMatchObject ([{
title: 'Wuthering Heights', texts:[
{locale:'de',title:'Sturmhöhe'}
]
}])
})
it ('should read single Book with translated texts', async ()=>{
const book = await srv.run (
SELECT.one.from (Books, b=>{ b.ID, b.title, b.texts(t=> {
t.locale, t.title
})}) .where ({title:'Wuthering Heights'})
)
expect (book) .toMatchObject ({
title: 'Wuthering Heights', texts:[
{locale:'de',title:'Sturmhöhe'}
]
})
})
it ('should insert books with translated texts', async ()=>{
const book = { ID:444, title:'A New Book', texts:[
{locale:'de', title:'Ein Neues Buch'},
{locale:'fr', title:'Un Nouveau Livre'},
]}
const response = await srv.create (Books) .entries (book)
expect(response).toMatchObject(book)
})
it ('should delete books w/ cascaded delete to texts', async()=>{
await srv.delete('Books') .where ({ID:444})
})
})
describe('Localized data on OData level', () => {
const app = require('express')()
const srv = require('supertest')(app)
it ('should serve BooksService', async ()=>{
await cds.serve('BooksService').from(__dirname+'/books') .in (app)
})
it('should list all books with default language', async () => {
const books = await srv.get('/books/Books/201/title')
expect(books.body).toMatchObject({'value': 'Wuthering Heights'})
})
it('should read books with translated texts', async () => {
const books = await srv.get('/books/Books/201/title'). set('Accept-Language', 'de')
expect(books.body).toMatchObject({value: 'Sturmhöhe'})
})
it('should expand translated texts in Book', async () => {
const books = await srv. get('/books/Books/201?$select=title&$expand=texts($select=locale,title)')
expect(books.body).toMatchObject({
title: 'Wuthering Heights',
texts: [
{ locale: 'de', title: 'Sturmhöhe', },
],
})
})
const book = {
title: 'New Book', descr: 'Lorem Ipsum',
texts: [
{ locale: 'de', title: 'Neues Buch', descr: 'Dolor sit amet' },
{ locale: 'fr', title: 'Nouveau Livre', descr: 'consetetur sadipscing elitr' }
],
}
it('should insert books with translated texts', async () => {
const {body} = await srv.post('/books/Books').send(book)
expect(body).toMatchObject(book)
book.ID = body.ID
})
it ('should read the newly created book', async()=>{
const {body} = await srv.get('/books/Books/'+book.ID+'?$expand=texts').send(book)
expect(body).toMatchObject(book)
})
it ('should delete books w/ cascaded delete to texts', async()=>{
await srv.delete('/books/Books/'+book.ID)
.expect(204)
})
})

View File

@@ -0,0 +1,37 @@
using { sap.capire.contacts.PostalAddress } from './schema';
using { sap } from '@sap/cds/common';
namespace sap.capire.contacts;
/**
* The Code Lists below are designed as optional extensions to
* the base schema. Switch them on by adding an Association to
* one of the code list entities in your models or by:
* annotate sap.common.Countries with @cds.persistence.skip:false;
*/
entity Countries as select from sap.common.Countries;
extend sap.common.Countries {
regions : Composition of many Regions on regions._parent = $self.code;
}
entity Regions : sap.common.CodeList {
key code : String(5); // ISO 3166-2 alpha5 codes, e.g. DE-BW
children : Composition of many Regions on children._parent = $self.code;
cities : Composition of many Cities on cities.region = $self;
_parent : String(11);
}
entity Cities : sap.common.CodeList {
key code : String(11);
region : Association to Regions;
districts : Composition of many Districts on districts.city = $self;
}
entity Districts : sap.common.CodeList {
key code : String(11);
city : Association to Cities;
}
annotate PostalAddress with {
district @ref: sap.capire.contacts.Districts;
city @ref: sap.capire.contacts.Cities;
region @ref: sap.capire.contacts.Regions;
country @ref: sap.capire.contacts.Countries;
}

View File

@@ -0,0 +1,12 @@
code;name;descr
AU;Australia;Commonwealth of Australia
CA;Canada;Canada
CN;China;People's Republic of China (PRC)
FR;France;French Republic
DE;Germany;Federal Republic of Germany
IN;India;Republic of India
IL;Israel;State of Israel
MM;Myanmar;Republic of the Union of Myanmar
GB;United Kingdom;United Kingdom of Great Britain and Northern Ireland
US;United States;United States of America (USA)
EU;European Union;European Union
1 code name descr
2 AU Australia Commonwealth of Australia
3 CA Canada Canada
4 CN China People's Republic of China (PRC)
5 FR France French Republic
6 DE Germany Federal Republic of Germany
7 IN India Republic of India
8 IL Israel State of Israel
9 MM Myanmar Republic of the Union of Myanmar
10 GB United Kingdom United Kingdom of Great Britain and Northern Ireland
11 US United States United States of America (USA)
12 EU European Union European Union

View File

@@ -0,0 +1,12 @@
code;locale;name;descr
AU;de;Australien;Commonwealth Australien
CA;de;Kanada;Canada
CN;de;China;Volksrepublik China
FR;de;Frankreich;Republik Frankreich
DE;de;Deutschland;Bundesrepublik Deutschland
IN;de;Indien;Republik Indien
IL;de;Israel;Staat Israel
MM;de;Myanmar;Republik der Union Myanmar
GB;de;Vereinigtes Königreich;Vereinigtes Königreich Großbritannien und Nordirland
US;de;Vereinigte Staaten;Vereinigte Staaten von Amerika
EU;de;Europäische Union;Europäische Union
1 code locale name descr
2 AU de Australien Commonwealth Australien
3 CA de Kanada Canada
4 CN de China Volksrepublik China
5 FR de Frankreich Republik Frankreich
6 DE de Deutschland Bundesrepublik Deutschland
7 IN de Indien Republik Indien
8 IL de Israel Staat Israel
9 MM de Myanmar Republik der Union Myanmar
10 GB de Vereinigtes Königreich Vereinigtes Königreich Großbritannien und Nordirland
11 US de Vereinigte Staaten Vereinigte Staaten von Amerika
12 EU de Europäische Union Europäische Union

View File

@@ -0,0 +1,58 @@
namespace sap.capire.contacts;
//--------------------------------------------------------------------------
// Aspects
aspect Organization {
orgname : String(111);
}
aspect Person {
firstname : String(111);
lastname : String(111);
prefix : String(11);
suffix : String(11);
middle : String(11);
dateOfBirth : Date; placeOfBirth : String;
dateOfDeath : Date; placeOfDeath : String;
}
aspect PostalAddress {
street : String(222) @multiline;
postCode : String(11);
district : String(111);
city : String(111);
region : String(111);
country : String(111);
}
aspect ContactOptions {
email : String @JSON:[{ kind:String, address: EmailAddress }];
phone : String @JSON:[{ kind:String, number: PhoneNumber }];
// phone : array of { kind:String; number: PhoneNumber };
// addresses : Composition of many PostalAddress;
}
type EmailAddress : String;
type PhoneNumber : String;
//--------------------------------------------------------------------------
// Entities
@cds.persistence.skip:'if-unused'
entity Contacts : Person, Organization, ContactOptions {
key ID : UUID;
isOrg : Boolean;
addresses : Composition of many PostalAddresses on addresses.contact = $self;
}
@cds.persistence.skip:'if-unused'
entity PostalAddresses : PostalAddress {
contact : Association to Contacts;
kind : String;
key ID : UUID;
}

View File

@@ -0,0 +1,2 @@
using from './db/code-lists';
using from './db/schema';

View File

@@ -0,0 +1,10 @@
{
"name": "@sap/capire-contacts",
"version": "1.0.0",
"description": "A reuse package providing common domain models and services for contacts-related data.",
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/cds": "latest"
}
}

View File

@@ -0,0 +1,67 @@
# Common Contacts Sample
This sample provides a reuse package with common domain models and services for contacts-related data.
## Usage
#### Import to your project
npm install @sap/capire-contacts
> e.g. see: [bookstore](../bookstore/package.json)
#### Reusing aspects
Define own entities derived from the pre-defined aspects as in [_bookstore_](../bookstore/db/schema.cds):
```swift
using { sap.capire.contacts.Person } from '@sap/capire-contacts';
entity Authors : contacts.Person { ... }
```
> **Note:** All entities in this package are annotated with _`@cds.persistence.skip`:'if-unused'_, so they will be ignored if not referred to from other entities in your models.
#### Reusing entities
Reuse the entities as in this example from [_users-service_](../users-service/srv/services.cds):
```swift
using { sap.capire.contacts.Contacts } from '@sap/capire-contacts';
service UsersService @(requires:'authenticated-user') {
entity MyProfile as select from Contacts where ID=$user;
...
}
```
#### Reusing code lists
Reuse the code lists as in [_./tests/index.cds_](./tests/index.cds):
```swift
service Sue { ...
// expose Countries to activate provided code lists
@readonly entity Countries as projection on sap.capire.contacts.Countries;
}
```
#### Reuse code list service
```js
const { intercept } = require ('@sap/capire-contacts/srv/code-lists')
```
## Content
## Concepts
* [Reuse of packages](https://cap.cloud.sap/docs/get-started/projects#reuse)
* Code Lists, `@sap/cds/common` and `@cds.persistence.skip`: 'if-unused'
* Using `aspects` vs `entities`

View File

@@ -0,0 +1,70 @@
const cds = require ('@sap/cds')
const READ='READ', WRITE = ['CREATE','UPDATE']
const intercept = exports.intercept = cds.service.impl (async (srv) => {
for (let each in srv.entities) {
// intercept JSON-encoded elements
const jsons = await jsonsIn (srv.entities[each].elements)
if (jsons) {
srv.before (WRITE, each, ({data:row})=>{
for (let e of jsons) if (row[e]) row[e] = JSON.stringify (row[e])
})
srv.after (READ, each, (row)=>{
for (let e of jsons) if (row[e]) row[e] = JSON.parse (row[e])
})
}
// intercept references
const refs = await refsIn (srv.entities[each].elements, srv.model)
if (refs) srv.after (READ, each, (rows, req)=>{
for (let row of rows) {
for (let {element,codelist} of refs) {
const entry = codelist [row[element]]
if (entry) {
const localized = entry.texts [req.user.locale || intercept.locale]
row[element] = localized ? localized.name : entry.name
}
}
}
})
}
})
function jsonsIn (elements) {
const jsons=[]; for (let e in elements) {
if (elements[e]['@JSON']) jsons.push(e)
}
return jsons.length && jsons
}
async function refsIn (elements, model) {
const refs=[]; for (let e in elements) {
const $ref = elements[e]['@ref']
if ($ref) {
const d = model.definitions [$ref['=']]
refs.push({
element:e,
codelist: CodeLists[d.name] || (CodeLists[d.name] = await load(d))
})
}
}
return refs.length && refs
}
const load = exports.load = async (codelist) => {
const all = {}
const [entries,texts] = await Promise.all ([
SELECT.from (codelist),
SELECT.from (codelist.elements.texts.target)
])
for (let {code,name,descr} of entries) all[code] = {name,descr}
for (let {code,locale,name,descr} of texts) (all[code].texts || (all[code].texts={})) [locale] = {name,descr}
return all
}
const CodeLists = {}

View File

@@ -0,0 +1,68 @@
const {load,intercept} = require ('../srv/code-lists')
const cds = require ('@sap/cds')
// patch-enhance cds.ql
const select = SELECT.from('.').__proto__.__proto__, query = select.__proto__
query.then = function (r,e) { return db.run(this) .then (r,e || ((e)=>{throw e})) }
let db, Countries, Australia = {
name: 'Australia', descr: 'Commonwealth of Australia', texts: {
de: { name: 'Australien', descr: 'Commonwealth Australien' }
}
}
describe ('code list tests', ()=>{
it ('should deploy the db schema to sqlite in-memory', async()=>{
db = await cds.deploy (__dirname) .to ('sqlite::memory:', {silent:true,primary:true})
Countries = db.model.entities ['sap.common.Countries']
expect (Countries) .toBeDefined()
})
it ('should read Countries', async()=>{
const countries = await SELECT ('code','name') .from (Countries)
expect (countries) .toContainEqual ({ code: 'AU', name: 'Australia' })
})
it ('should read Countries_texts', async()=>{
const countries = await SELECT ('locale','code','name') .from ('sap.common.Countries_texts')
expect (countries) .toContainEqual ({ locale: 'de', code: 'AU', name: 'Australien' })
})
it ('should read code lists with translated texts', async()=>{
const {AU} = await load (Countries)
expect (AU) .toEqual (Australia)
})
cds.env.singletenant = true
it ('should serve services with localized data', async()=>{
const { Sue:sue } = await cds.serve (__dirname)
const { Foos } = sue.entities
await sue.create (Foos) .entries ({country:'Avalon'})
await sue.create (Foos) .entries ({country:'AU'})
expect (await sue.read('Foos')) .toEqual ([ { ID: 1, country: 'Avalon' }, { ID: 2, country: 'AU' } ])
})
it ('should resolve countries', async()=>{
const sue = await cds.connect.to ('Sue')
await intercept (sue)
expect (await sue.read('Foos')) .toEqual ([ { ID: 1, country: 'Avalon' }, { ID: 2, country: 'Australia' } ])
intercept.locale = 'de'
expect (await sue.read('Foos')) .toEqual ([ { ID: 1, country: 'Avalon' }, { ID: 2, country: 'Australien' } ])
console.log (await sue.read('Foos'))
})
it ('should read countries with expand to translated texts', async()=>{
const countries = await cds.read (Countries, c=>{
c.name, c.texts (t => {
t.locale, t.name
})
})
console.log (countries)
})
it ('should disconnect from db', ()=> db.disconnect())
//> FIXME: that should not be required!
})

View File

@@ -0,0 +1,11 @@
using { sap } from '..';
entity Foo {
key ID : Integer;
country : String @ref: sap.capire.contacts.Countries;
}
service Sue {
entity Foos as projection on Foo;
// expose Countries to activate provided code lists
@readonly entity Countries as projection on sap.capire.contacts.Countries;
}

View File

@@ -0,0 +1,12 @@
code;symbol;name;descr;numcode;minor;exponent
EUR;€;Euro;European Euro;978;Cent;2
USD;$;US Dollar;United States Dollar;840;Cent;2
CAD;$;Canadian Dollar;Canadian Dollar;124;Cent;2
AUD;$;Australian Dollar;Canadian Dollar;036;Cent;2
GBP;£;British Pound;Great Britain Pound;826;Penny;2
ILS;₪;Shekel;Israeli New Shekel;376;Agorat;2
INR;₹;Rupee;Indian Rupee;356;Paise;2
QAR;﷼;Riyal;Katar Riyal;356;Dirham;2
SAR;﷼;Riyal;Saudi Riyal;682;Halala;2
JPY;¥;Yen;Japanese Yen;392;Sen;2
CNY;¥;Yuan;Chinese Yuan Renminbi;156;Jiao;1
1 code symbol name descr numcode minor exponent
2 EUR Euro European Euro 978 Cent 2
3 USD $ US Dollar United States Dollar 840 Cent 2
4 CAD $ Canadian Dollar Canadian Dollar 124 Cent 2
5 AUD $ Australian Dollar Canadian Dollar 036 Cent 2
6 GBP £ British Pound Great Britain Pound 826 Penny 2
7 ILS Shekel Israeli New Shekel 376 Agorat 2
8 INR Rupee Indian Rupee 356 Paise 2
9 QAR Riyal Katar Riyal 356 Dirham 2
10 SAR Riyal Saudi Riyal 682 Halala 2
11 JPY ¥ Yen Japanese Yen 392 Sen 2
12 CNY ¥ Yuan Chinese Yuan Renminbi 156 Jiao 1

View File

@@ -0,0 +1,13 @@
code;locale;name;descr
EUR;de;Euro;European Euro
USD;de;US-Dollar;United States Dollar
CAD;de;Kanadischer Dollar;Kanadischer Dollar
AUD;de;Australischer Dollar;Australischer Dollar
GBP;de;Pfund;Britische Pfund
ILS;de;Schekel;Israelische Schekel
EUR;fr;euro;de la Zone euro
USD;fr;dollar;dollar des États-Unis
CAD;fr;dollar canadien;dollar canadien
AUD;fr;dollar australien;dollar australien
GBP;fr;livre sterling;pound sterling
ILS;fr;Shekel;shekel israelien
1 code locale name descr
2 EUR de Euro European Euro
3 USD de US-Dollar United States Dollar
4 CAD de Kanadischer Dollar Kanadischer Dollar
5 AUD de Australischer Dollar Australischer Dollar
6 GBP de Pfund Britische Pfund
7 ILS de Schekel Israelische Schekel
8 EUR fr euro de la Zone euro
9 USD fr dollar dollar des États-Unis
10 CAD fr dollar canadien dollar canadien
11 AUD fr dollar australien dollar australien
12 GBP fr livre sterling pound sterling
13 ILS fr Shekel shekel israelien

View File

@@ -0,0 +1,17 @@
namespace sap.capire.currencies;
using { sap.common.Currencies } from '@sap/cds/common';
extend Currencies with {
// Currencies.code = ISO 4217 alphabetic three-letter code
// with the first two letters being equal to ISO 3166 alphabetic country codes
numcode : Integer;
exponent : Integer; //> e.g. 2 --> 1 Dollar = 10^2 Cent
minor : String; //> e.g. 'Cent'
// country : String; //> country or region
}
// 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

View File

@@ -0,0 +1,10 @@
{
"name": "@sap/capire-currencies",
"version": "1.0.0",
"description": "A reuse package providing common domain models and services for currencies-related data.",
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/cds": "latest"
}
}

View File

@@ -0,0 +1,15 @@
namespace sap.capire.media;
service MediaServer {
entity Images {
key url : URL;
type : String enum { jpeg; png; gif; };
content : Image;
}
}
type ImageURL : URL;
// type ImageURL : Association to MediaServer.Images;
//> would need Assotiations targeting off service to turn into references w/ foreign keys
type Image : LargeBinary @stream;
type URL : String(222);

View File

@@ -0,0 +1,11 @@
{
"name": "@sap/capire-media",
"version": "1.0.0",
"description": "A generic platform service to manage and serve media content on behalf of other services and apps.",
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/cds": "latest",
"express": "*"
}
}

View File

@@ -0,0 +1,4 @@
ID;amount;parent_ID;article
58040e66-1dcd-4ffb-ab10-fdce32028b79;1;7e2f2640-6866-4dcf-8f4d-3027aa831cad;201
64e718c9-ff99-47f1-8ca3-950c850777d4;1;7e2f2640-6866-4dcf-8f4d-3027aa831cad;271
e9641166-e050-4261-bfee-d1e797e6cb7f;2;64e718c9-ff99-47f1-8ca3-950c850777d4;252
1 ID amount parent_ID article
2 58040e66-1dcd-4ffb-ab10-fdce32028b79 1 7e2f2640-6866-4dcf-8f4d-3027aa831cad 201
3 64e718c9-ff99-47f1-8ca3-950c850777d4 1 7e2f2640-6866-4dcf-8f4d-3027aa831cad 271
4 e9641166-e050-4261-bfee-d1e797e6cb7f 2 64e718c9-ff99-47f1-8ca3-950c850777d4 252

View File

@@ -0,0 +1,3 @@
ID;modifiedAt;createdAt;createdBy;modifiedBy;OrderNo;currency_code
7e2f2640-6866-4dcf-8f4d-3027aa831cad;;2019-01-31;john.doe@test.com;;1;EUR
64e718c9-ff99-47f1-8ca3-950c850777d4;;2019-01-30;christian.georgi@sap.com;;2;EUR
1 ID modifiedAt createdAt createdBy modifiedBy OrderNo currency_code
2 7e2f2640-6866-4dcf-8f4d-3027aa831cad 2019-01-31 john.doe@test.com 1 EUR
3 64e718c9-ff99-47f1-8ca3-950c850777d4 2019-01-30 christian.georgi@sap.com 2 EUR

View File

@@ -0,0 +1,15 @@
namespace sap.capire.orders;
using { Currency, cuid, managed } from '@sap/cds/common';
entity Orders : cuid, managed {
OrderNo : String @title:'Order Number'; //> readable key
Items : Composition of many OrderItems on Items.parent = $self;
currency : Currency;
}
entity OrderItems : cuid {
parent : Association to Orders not null;
article : String;
amount : Integer;
}

View File

@@ -0,0 +1,2 @@
namespace sap.capire.orders;
using from './srv/orders-service';

View File

@@ -0,0 +1,11 @@
{
"name": "@sap/capire-orders",
"version": "1.0.0",
"description": "A reuse package providing domain models and services to submit and manage purchase orders.",
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/cds": "latest",
"express": "*"
}
}

View File

@@ -0,0 +1,6 @@
namespace sap.capire.orders;
using { sap.capire.orders as my } from '../db/schema';
service OrdersService {
entity Orders as projection on my.Orders;
}

View File

@@ -0,0 +1,18 @@
namespace sap.capire.products;
using { Currency, cuid, managed, sap.common.CodeList } from '@sap/cds/common';
entity Products : cuid, managed {
title : localized String(111);
descr : localized String(1111);
stock : Integer;
price : Decimal(9,2);
currency : Currency;
category : Association to Categories;
}
entity Categories : CodeList {
key ID : Integer;
parent : Association to Categories;
children : Composition of many Categories on children.parent = $self;
}

View File

@@ -0,0 +1,2 @@
using from './db/schema';
using from './srv/admin-service';

View File

@@ -0,0 +1,16 @@
{
"name": "@sap/capire-products",
"version": "1.0.0",
"description": "A reuse package providing domain models and services to manage product catalogs.",
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/cds": "latest",
"express": "*"
},
"files": [
"db",
"srv",
"index.cds"
]
}

View File

@@ -0,0 +1,7 @@
using { sap.capire.products as db } from '../db/schema';
namespace sap.capire.products;
service AdminService @(_requires:'admin') {
entity Products as projection on db.Products;
entity Categories as projection on db.Categories;
}

View File

@@ -0,0 +1,68 @@
const cds = require ('@sap/cds')
describe('reading/writing hierarchies', ()=>{
it ('should prepare to sqlite in-memory', async()=>{
await cds.deploy (__dirname+'/../db') .to ('sqlite::memory:')
expect (cds.model) .toBeDefined()
})
it ('should insert hierarchy of categories', ()=>{
const { Categories } = cds.entities
return INSERT.into (Categories) .entries (
{ ID:100, name:'Some Sample Categories...', children:[
{ ID:101, name:'Cat', children:[
{ ID:102, name:'Kitty', children:[
{ ID:103, name:'Kitty Cat', children:[
{ ID:104, name:'Aristocat' } ]},
{ ID:105, name:'Kitty Bat' } ]},
{ ID:106, name:'Catwoman', children:[
{ ID:107, name:'Catalina' } ]} ]},
{ ID:108, name:'Catweazle' }
]}
)
})
it ('should read categories with children', async()=>{
const { Categories } = cds.entities
expect (await
SELECT.one.from (Categories, c=>{
c.ID, c.name.as('parent'), c.children (c=>{
c.name.as('child')
})
}) .where ({name:'Cat'})
) .toMatchObject (
{ ID:101, parent:'Cat', children:[
{ child:'Kitty' },
{ child:'Catwoman' },
]}
)
})
it ('should read hierarchy of categories', async()=>{
const { Categories } = cds.entities
expect (await
SELECT.one.from (Categories, c=>{
c.ID, c.name, c.children (c=>{ c.name },{levels:3})
}) .where ({name:'Cat'})
) .toMatchObject (
{ ID:101, name:'Cat', children:[
{ name:'Kitty', children:[
{ name:'Kitty Cat', children:[
{ name:'Aristocat' }, ]},
{ name:'Kitty Bat' }, ]},
{ name:'Catwoman', children:[
{ name:'Catalina' } ]},
]}
)
})
})

View File

@@ -0,0 +1,10 @@
ID;parent_ID;name
0;;Some Sample Categories...
1;;Cat
2;1;Kitty
3;2;Kitty Cat
4;3;Aristocat
5;2;Kitty Bat
6;1;Catwoman
7;6;Catalina
8;;Catweazle
1 ID parent_ID name
2 0 Some Sample Categories...
3 1 Cat
4 2 1 Kitty
5 3 2 Kitty Cat
6 4 3 Aristocat
7 5 2 Kitty Bat
8 6 1 Catwoman
9 7 6 Catalina
10 8 Catweazle

View File

@@ -0,0 +1,157 @@
{
"info": {
"_postman_id": "0f8d4e79-a1c2-47fe-aeab-0319fb4ce180",
"name": "@sap/capire-products",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Categories",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{ \"ID\":0, \"name\":\"Some Sample Categories...\", \"children\":[\n { \"ID\":1, \"name\":\"Cat\", \"children\":[\n { \"ID\":2, \"name\":\"Kitty\", \"children\":[\n { \"ID\":3, \"name\":\"Kitty Cat\", \"children\":[\n { \"ID\":4, \"name\":\"Aristocat\" }\n ]},\n { \"ID\":5, \"name\":\"Kitty Bat\" }\n ]},\n { \"ID\":6, \"name\":\"Catwoman\", \"children\":[\n { \"ID\":7, \"name\":\"Catalina\" }\n ]}\n ] },\n { \"ID\":8, \"name\":\"Catweazle\" }\n]}\n"
},
"url": {
"raw": "http://localhost:4004/admin/Categories",
"protocol": "http",
"host": [
"localhost"
],
"port": "4004",
"path": [
"admin",
"Categories"
]
}
},
"response": []
},
{
"name": "Categories",
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "http://localhost:4004/admin/Categories/0?$expand=children($expand=children($expand=children($expand=children)))",
"protocol": "http",
"host": [
"localhost"
],
"port": "4004",
"path": [
"admin",
"Categories",
"0"
],
"query": [
{
"key": "$expand",
"value": "children($expand=children($expand=children($expand=children)))"
}
]
}
},
"response": [
{
"name": "Categories",
"originalRequest": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "http://localhost:4004/admin/Categories/0?$expand=children($expand=children($expand=children($expand=children)))",
"protocol": "http",
"host": [
"localhost"
],
"port": "4004",
"path": [
"admin",
"Categories",
"0"
],
"query": [
{
"key": "$expand",
"value": "children($expand=children($expand=children($expand=children)))"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Powered-By",
"value": "Express"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "content-type",
"value": "application/json;odata.metadata=minimal"
},
{
"key": "Date",
"value": "Tue, 21 May 2019 19:20:24 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Content-Length",
"value": "767"
}
],
"cookie": [],
"body": "{\n \"@odata.context\": \"$metadata#cats(children(children(children(children()))))/$entity\",\n \"@odata.metadataEtag\": \"W/\\\"+AAp4JKNOcr+OusjrdQo55RCfM+UHKpTh8EbhsxyPhM=\\\"\",\n \"name\": \"Some Sample Categories...\",\n \"descr\": null,\n \"ID\": 0,\n \"parent_ID\": null,\n \"children\": [\n {\n \"name\": \"Cat\",\n \"descr\": null,\n \"ID\": 1,\n \"parent_ID\": 0,\n \"children\": [\n {\n \"name\": \"Kitty\",\n \"descr\": null,\n \"ID\": 2,\n \"parent_ID\": 1,\n \"children\": [\n {\n \"name\": \"Kitty Cat\",\n \"descr\": null,\n \"ID\": 3,\n \"parent_ID\": 2,\n \"children\": [\n {\n \"name\": \"Aristocat\",\n \"descr\": null,\n \"ID\": 4,\n \"parent_ID\": 3\n }\n ]\n },\n {\n \"name\": \"Kitty Bat\",\n \"descr\": null,\n \"ID\": 5,\n \"parent_ID\": 2,\n \"children\": []\n }\n ]\n },\n {\n \"name\": \"Catwoman\",\n \"descr\": null,\n \"ID\": 6,\n \"parent_ID\": 1,\n \"children\": [\n {\n \"name\": \"Catalina\",\n \"descr\": null,\n \"ID\": 7,\n \"parent_ID\": 6,\n \"children\": []\n }\n ]\n }\n ]\n },\n {\n \"name\": \"Catweazle\",\n \"descr\": null,\n \"ID\": 8,\n \"parent_ID\": 0,\n \"children\": []\n }\n ]\n}"
}
]
},
{
"name": "Categories",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "http://localhost:4004/admin/Categories/0",
"protocol": "http",
"host": [
"localhost"
],
"port": "4004",
"path": [
"admin",
"Categories",
"0"
]
}
},
"response": []
}
]
}

View File

@@ -0,0 +1,31 @@
namespace sap.capire.reviews;
using { User } from '@sap/cds/common';
// Reviewed subjects can be any entity that is uniquely identified
// by a single key element such as a UUID
type ReviewedSubject : String(111);
entity Reviews {
key ID : UUID;
subject : ReviewedSubject;
reviewer : User;
rating : Rating;
title : String(111);
text : String(1111);
date : DateTime;
likes : Composition of many Likes on likes.review = $self;
liked : Integer default 0; // counter for likes as helpful review (count of all _likes belonging to this review)
}
type Rating : Decimal(3,2) enum {
Best = 5;
Good = 4;
Avg = 3;
Poor = 2;
Worst = 1;
}
entity Likes {
key review : Association to Reviews;
key user : User;
}

View File

@@ -0,0 +1 @@
using from './srv/reviews-service';

View File

@@ -0,0 +1,30 @@
{
"name": "@sap/capire-reviews",
"version": "1.0.0",
"description": "A reuse service providing generic means to add reviews and ratings to target objects, e.g. products.",
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/cds": "latest",
"express": "*"
},
"scripts": {
"start": "cds run --in-memory?",
"watch": "cds watch"
},
"files": [
"db",
"srv",
"index.cds"
],
"cds": {
"requires": {
"db": {
"kind": "sql"
},
"messaging": {
"kind": "file-based-messaging"
}
}
}
}

View File

@@ -0,0 +1,41 @@
using { sap.capire.reviews as my } from '../db/schema';
namespace sap.capire.reviews;
service ReviewsService {
// Sync API
entity Reviews as projection on my.Reviews excluding { likes }
action like (review:Reviews.ID); // TODO: can be a bound action in OData
action unlike (review:Reviews.ID); // TODO: can be a bound action in OData
// Async API
event reviewed : { subject: Reviews.subject; rating: Decimal(2,1) };
// Input validation
annotate Reviews with {
subject @mandatory;
title @mandatory;
rating @mandatory @assert.enum;
}
// Auto-fill reviewers and review dates
annotate Reviews with {
reviewer @cds.on.insert:$user;
date @cds.on.insert:$now;
date @cds.on.update:$now;
}
}
// Access control restrictions
annotate ReviewsService.Reviews with @restrict_:[
{ grant:'READ', to:'any' }, // everybody can read reviews
{ grant:'CREATE', to:'authenticated-user' }, // users must login to add reviews
{ grant:'UPDATE', to:'authenticated-user', where:'reviewer=$user' },
{ grant:'DELETE', to:'admin' },
];
annotate ReviewsService with @restrict_:[
{ grant:'like', to:'identified-user' },
{ grant:'unlike', to:'identified-user', where:'user=$user' },
];

View File

@@ -0,0 +1,41 @@
const cds = require ('@sap/cds')
module.exports = cds.service.impl (function(){
// Get the CSN definition for Reviews from the db schema for sub-sequent queries
// ( Note: we explicitly specify the namespace to support embedded reuse )
const { Reviews, Likes } = this.entities ('sap.capire.reviews')
// Emit an event to inform subscribers about new avg ratings for reviewed subjects
// ( Note: req.on.succeeded ensures we only do that if there's no error )
this.after (['CREATE','UPDATE','DELETE'], 'Reviews', async(_,req) => {
const {subject} = req.data
const {rating} = await cds.transaction(req) .run (
SELECT.one (['round(avg(rating),2) as rating']) .from (Reviews) .where ({subject})
)
req.on ('succeeded', ()=>{
console.log ('< emitting:', 'reviewed', { subject, rating })
this.emit ('reviewed', { subject, rating })
})
})
// Increment counter for reviews considered helpful
this.on ('like', (req) => {
if (!req.user) return req.reject(400, 'You must be identified to like a review')
const {review} = req.data, {user} = req
const tx = cds.transaction(req)
return tx.run ([
INSERT.into (Likes) .entries ({review_ID: review, user: user.id}),
UPDATE (Reviews) .set({liked: {'+=': 1}}) .where({ID:review})
]).catch(() => req.reject(400, 'You already liked that review'))
})
// Delete a former like by the same user
this.on ('unlike', async (req) => {
if (!req.user) return req.reject(400, 'You must be identified to remove a former like of yours')
const {review} = req.data, {user} = req
const tx = cds.transaction(req)
const affectedRows = await tx.run (DELETE.from (Likes) .where ({review_ID: review,user: user.id}))
if (affectedRows === 1) return tx.run (UPDATE (Reviews) .set ({liked: {'-=': 1}}) .where ({ID:review}))
})
})

View File

@@ -0,0 +1,69 @@
const _model = __dirname+'/..'
const cds = require ('@sap/cds')
describe('messaging tests', ()=>{
it ('should bootstrap sqlite in-memory db', async()=>{
const db = await cds.deploy (_model) .to ('sqlite::memory:')
expect (db.model) .toBeDefined()
})
let srv
it ('should serve reviews services', async()=>{
srv = await cds.serve('ReviewsService') .from (_model)
expect (srv.name) .toMatch ('ReviewsService')
})
let N=0, received=[], M=0
it ('should add messaging event handlers', ()=>{
srv.on('reviewed', (msg)=> received.push(msg))
})
it ('should add more messaging event handlers', ()=>{
srv.on('reviewed', ()=> ++M)
})
it ('should add review', async ()=>{
const review = {
ID: 111 + (++N), // FIXME: why does the generic handler not fill this in automatically ?!? --> it does so when the request comes in via Postman / OData
subject: "201", title: "Captivating", rating: N
}
const response = await srv.create ('Reviews') .entries (review)
expect (response) .toMatchObject (review)
},100)
it ('should add more reviews', ()=> Promise.all ([
// REVISIT: mass operation should trigger one message per entry
// srv.create('Reviews').entries(
// { ID: 111 + (++N), subject: "201", title: "Captivating", rating: N },
// { ID: 111 + (++N), subject: "201", title: "Captivating", rating: N },
// { ID: 111 + (++N), subject: "201", title: "Captivating", rating: N },
// { ID: 111 + (++N), subject: "201", title: "Captivating", rating: N },
// ),
srv.create ('Reviews') .entries (
{ ID: 111 + (++N), subject: "201", title: "Captivating", rating: N }
),
srv.create ('Reviews') .entries (
{ ID: 111 + (++N), subject: "201", title: "Captivating", rating: N }
),
srv.create ('Reviews') .entries (
{ ID: 111 + (++N), subject: "201", title: "Captivating", rating: N }
),
srv.create ('Reviews') .entries (
{ ID: 111 + (++N), subject: "201", title: "Captivating", rating: N }
),
]) ,100)
it ('should have received all messages', async()=> {
await new Promise((done)=>setImmediate(done))
expect(M).toBe(N)
expect(received.length).toBe(N)
expect(received.map(m=>m.data)).toEqual([
{ subject: '201', rating: 1 },
{ subject: '201', rating: 1.5 },
{ subject: '201', rating: 2 },
{ subject: '201', rating: 2.5 },
{ subject: '201', rating: 3 },
])
})
})

View File

@@ -0,0 +1 @@
using from './srv/services';

Some files were not shown because too many files have changed in this diff Show More