@sap/xsodata 8.1.0 → 8.1.2

package/documentation/code_samples_pure_node/direct_use__multi_services/index.js

@@ -0,0 +1,49 @@
+'use strict';
+
+var http = require("http");
+var path = require('path');
+var logger = require('<winston_api_like_logger>');
+var xsOData = require('./../../../index');
+
+logger.level = 'warn';
+
+//Webserver configuration
+var webServerPort = 8019;
+var hostPortName = "localhost:" + webServerPort;
+
+//OData handler configuration
+var configuration = {
+    //Here serviceConfiguration points to a directory: so the first uri segment behind the port
+    //must contain the name of the xsodata file to use. E.g. for name demo.xsodata:
+    //http://localhost/demo.xsodata/$metadata
+    "serviceConfiguration": path.join(__dirname, "services"),
+    "defaultSchema": 'REFSCENARIO',
+    "dbConfiguration": {
+        "host": "<your host>",
+        "port": 1234,
+        "user": "<your user>",
+        "password": "<your password>"
+    },
+    "logger": logger
+};
+
+//Instantiate ODataHandler
+var handler = new xsOData.ODataHandler(configuration);
+
+var webServer = http.createServer(function (request, response) {
+    if (request.url.indexOf("favicon.ico") === -1) {
+        try {
+            handler.processRequest(request, response, null, function done() {
+                console.log("processed request " + request.url);
+            });
+        } catch (ex) {
+            console.log(ex);
+        }
+    }
+});
+
+webServer.listen(webServerPort, function () {
+    console.log("Listen on localhost:" + webServerPort);
+    console.log("Service url for demo    : http://" + hostPortName + '/demo.xsodata');
+    console.log("Service url for demo_nav: http://" + hostPortName + '/demo_nav.xsodata');
+});

package/documentation/code_samples_pure_node/direct_use__multi_services/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "direct_use__multi_sevices",
+    "description": "Plain nodejs webserver forwarding all requests to the xsodata module",
+    "version": "0.0.1",
+    "scripts": {
+        "start": "node index.js"
+    }
+}

package/documentation/code_samples_pure_node/direct_use__multi_services/services/demo.xsodata

@@ -0,0 +1,7 @@
+service  namespace "REFSCENARIO" { 
+   	"xsodata.refscenario.tables::Employees" as "Employees";
+   	"xsodata.refscenario.tables::Teams" as "Teams";
+   	"xsodata.refscenario.tables::Rooms" as "Rooms";
+   	"xsodata.refscenario.tables::Managers" as "Managers";
+    "xsodata.refscenario.tables::Buildings" as "Buildings";
+}

package/documentation/code_samples_pure_node/direct_use__multi_services/services/demo_nav.xsodata

@@ -0,0 +1,47 @@
+service  namespace "REFSCENARIO" { 
+   	"REFSCENARIO"."xsodata.refscenario.tables::Employees" as "Employees"
+   	    navigates (
+   	    	"ManagerEmployees" as "ne_Manager" from principal,
+   	    	"TeamEmployees" as "ne_Team" from principal,
+   	    	"RoomEmployees" as "ne_Room" from principal
+   	    );
+   	    
+   	"xsodata.refscenario.tables::Teams" as "Teams"
+   		navigates (
+   	    	"TeamEmployees" as "nt_Employees" from dependent  
+   	    );
+   	    
+    "xsodata.refscenario.tables::Rooms" as "Rooms"
+    	navigates (
+   	    	"RoomEmployees" as "nr_Employees" from dependent, 
+   	    	"BuildingsRooms" as "nr_Building" from principal 
+   	    );
+   	       	    
+    "xsodata.refscenario.tables::Managers" as "Managers"
+    	navigates (
+   	    	"ManagerEmployees" as "nm_Employees" from dependent
+   	    );
+
+    	
+    "xsodata.refscenario.tables::Buildings" as "Buildings"
+    	navigates (
+   	    	"BuildingsRooms" as "nb_Rooms" from dependent
+   	    );
+    
+    association "ManagerEmployees"
+    	principal "Employees"("EmployeeId") multiplicity "*"
+		dependent "Managers"("EmployeeId") multiplicity "1";
+		
+	association "TeamEmployees"
+    	principal "Employees"("TeamId") multiplicity "*"
+		dependent "Teams"("Id") multiplicity "1";
+		
+	association "RoomEmployees"
+    	principal "Employees"("RoomId") multiplicity "*"
+		dependent "Rooms"("Id") multiplicity "1";
+		
+	association "BuildingsRooms"
+    	principal "Rooms"("BuildingId") multiplicity "*"
+		dependent "Buildings"("Id") multiplicity "1";
+		
+}

package/documentation/code_samples_pure_node/direct_use__single_service/index.js

@@ -0,0 +1,48 @@
+'use strict';
+
+var http = require("http");
+var path = require('path');
+var logger = require('<winston_api_like_logger>');
+var xsOData = require('./../../../index');
+
+logger.level = 'warn';
+
+//Webserver configuration
+var webServerPort = 8019;
+var hostPortName = "localhost:" + webServerPort;
+
+//OData handler configuration
+var configuration = {
+    //Here serviceConfiguration points to a single directory: so the first uri segment behind the port
+    //must contain the name of the xsodata file to use. E.g. for name demo.xsodata:
+    //http://localhost/demo.xsodata/$metadata
+    "serviceConfiguration": path.join(__dirname, "services/demo.xsodata"),
+    "defaultSchema": 'REFSCENARIO',
+    "dbConfiguration": {
+        "host": "<your host>",
+        "port": 1234,
+        "user": "<your user>",
+        "password": "<your password>"
+    },
+    "logger": logger
+};
+
+//Instantiate ODataHandler
+var handler = new xsOData.ODataHandler(configuration);
+
+var webServer = http.createServer(function (request, response) {
+    if (request.url.indexOf("favicon.ico") === -1) {
+        try {
+            handler.processRequest(request, response, null, function done() {
+                console.log("processed request " + request.url);
+            });
+        } catch (ex) {
+            console.log(ex);
+        }
+    }
+});
+
+webServer.listen(webServerPort, function () {
+    console.log("Listen on localhost:" + webServerPort);
+    console.log("Service url for demo    : http://" + hostPortName + '/?$format=json');
+});

package/documentation/code_samples_pure_node/direct_use__single_service/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "direct_use__single_sevice",
+    "description": "Plain nodejs webserver forwarding all requests to the xsodata module",
+    "version": "0.0.1",
+    "scripts": {
+        "start": "node index.js"
+    }
+}

package/documentation/code_samples_pure_node/direct_use__single_service/services/demo.xsodata

@@ -0,0 +1,7 @@
+service  namespace "REFSCENARIO" { 
+   	"xsodata.refscenario.tables::Employees" as "Employees";
+   	"xsodata.refscenario.tables::Teams" as "Teams";
+   	"xsodata.refscenario.tables::Rooms" as "Rooms";
+   	"xsodata.refscenario.tables::Managers" as "Managers";
+    "xsodata.refscenario.tables::Buildings" as "Buildings";
+}

package/documentation/code_samples_pure_node/expressjs__multi_services/index.js

@@ -0,0 +1,53 @@
+'use strict';
+
+var path = require('path');
+var logger = require('<winston_api_like_logger>');
+var express = require('express');
+var xsOData = require('./../../../index');
+
+logger.level = 'warn';
+
+//Webserver configuration
+var webServerPort = 8019;
+var hostPortName = "localhost:" + webServerPort;
+var odataPrefix = '/odata';
+
+//OData handler configuration
+var configuration = {
+    //Here serviceConfiguration points to a directory: so the first uri segment behind the port
+    //must contain the name of the xsodata file to use. E.g. for name demo.xsodata:
+    //http://localhost/odata/demo.xsodata/$metadata
+    "serviceConfiguration": path.join(__dirname, "services"),
+    "defaultSchema": 'REFSCENARIO',
+    "dbConfiguration": {
+        "host": "<your host>",
+        "port": 1234,
+        "user": "<your user>",
+        "password": "<your password>"
+    },
+    "logger": logger
+};
+
+
+//Instantiate ODataHandler
+var handler = new xsOData.ODataHandler(configuration);
+
+
+//express stuff
+var app = express();
+
+app.use(odataPrefix, function (req, res, next) {
+    handler.processRequest(req, res, req.baseUrl, function done() {
+        console.log("processed odata request " + req.url);
+    });
+    return;
+});
+
+app.use(express.static('public'));
+
+app.listen(webServerPort, function () {
+    console.log("Listen on localhost:" + webServerPort);
+    console.log("Index url for demo    : http://" + hostPortName + '/index.html');
+    console.log("Service url for demo    : http://" + hostPortName + odataPrefix + '/demo.xsodata');
+    console.log("Service url for demo_nav: http://" + hostPortName + odataPrefix + '/demo_nav.xsodata');
+});

package/documentation/code_samples_pure_node/expressjs__multi_services/package.json

@@ -0,0 +1,11 @@
+{
+    "name": "expressjs",
+    "description": "",
+    "version": "0.0.1",
+    "scripts": {
+        "start": "node index.js"
+    },
+    "dependencies": {
+        "express": "^4.13.3"
+    }
+}

package/documentation/code_samples_pure_node/expressjs__multi_services/public/index.html

@@ -0,0 +1,27 @@
+<html>
+<head>
+    <title>xsodata with expressjs sample</title>
+</head>
+<body bgcolor=white>
+<ul>
+    <li>
+        Demo Service Url: <a href="/odata/demo.xsodata/">http://localhost:8019/odata/demo.xsodata/</a>
+    </li>
+    <li>
+        Demo Metadata Url: <a href="/odata/demo.xsodata/$metadata">http://localhost:8019/odata/demo.xsodata/$metadata</a>
+    </li>
+    <li>
+        Demo Employee Url: <a href="/odata/demo.xsodata/Employees?$format=json">http://localhost:8019/odata/demo.xsodata/Employees?$format=json</a>
+    </li>
+    <li>
+        Demo Nav Service Url: <a href="/odata/demo_nav.xsodata/">http://localhost:8019/odata/demo_nav.xsodata/</a>
+    </li>
+    <li>
+        Demo Nav Metadata Url: <a href="/odata/demo_nav.xsodata/$metadata">http://localhost:8019/odata/demo_nav.xsodata/$metadata</a>
+    </li>
+    <li>
+        Demo Nav Employee Url: <a href="/odata/demo_nav.xsodata/Employees?$format=json">http://localhost:8019/odata/demo_nav.xsodata/Employees?$format=json</a>
+    </li>
+</ul>
+</body>
+</html>

package/documentation/code_samples_pure_node/expressjs__multi_services/services/demo.xsodata

@@ -0,0 +1,7 @@
+service  namespace "REFSCENARIO" { 
+   	"xsodata.refscenario.tables::Employees" as "Employees";
+   	"xsodata.refscenario.tables::Teams" as "Teams";
+   	"xsodata.refscenario.tables::Rooms" as "Rooms";
+   	"xsodata.refscenario.tables::Managers" as "Managers";
+    "xsodata.refscenario.tables::Buildings" as "Buildings";
+}

package/documentation/code_samples_pure_node/expressjs__multi_services/services/demo_nav.xsodata

@@ -0,0 +1,47 @@
+service  namespace "REFSCENARIO" { 
+   	"REFSCENARIO"."xsodata.refscenario.tables::Employees" as "Employees"
+   	    navigates (
+   	    	"ManagerEmployees" as "ne_Manager" from principal,
+   	    	"TeamEmployees" as "ne_Team" from principal,
+   	    	"RoomEmployees" as "ne_Room" from principal
+   	    );
+   	    
+   	"xsodata.refscenario.tables::Teams" as "Teams"
+   		navigates (
+   	    	"TeamEmployees" as "nt_Employees" from dependent  
+   	    );
+   	    
+    "xsodata.refscenario.tables::Rooms" as "Rooms"
+    	navigates (
+   	    	"RoomEmployees" as "nr_Employees" from dependent, 
+   	    	"BuildingsRooms" as "nr_Building" from principal 
+   	    );
+   	       	    
+    "xsodata.refscenario.tables::Managers" as "Managers"
+    	navigates (
+   	    	"ManagerEmployees" as "nm_Employees" from dependent
+   	    );
+
+    	
+    "xsodata.refscenario.tables::Buildings" as "Buildings"
+    	navigates (
+   	    	"BuildingsRooms" as "nb_Rooms" from dependent
+   	    );
+    
+    association "ManagerEmployees"
+    	principal "Employees"("EmployeeId") multiplicity "*"
+		dependent "Managers"("EmployeeId") multiplicity "1";
+		
+	association "TeamEmployees"
+    	principal "Employees"("TeamId") multiplicity "*"
+		dependent "Teams"("Id") multiplicity "1";
+		
+	association "RoomEmployees"
+    	principal "Employees"("RoomId") multiplicity "*"
+		dependent "Rooms"("Id") multiplicity "1";
+		
+	association "BuildingsRooms"
+    	principal "Rooms"("BuildingId") multiplicity "*"
+		dependent "Buildings"("Id") multiplicity "1";
+		
+}

package/documentation/code_samples_pure_node/expressjs__single_service/index.js

@@ -0,0 +1,52 @@
+'use strict';
+
+var path = require('path');
+var logger = require('<winston_api_like_logger>');
+var express = require('express');
+var xsOData = require('./../../../index');
+
+logger.level = 'warn';
+
+//Webserver configuration
+var webServerPort = 8019;
+var hostPortName = "localhost:" + webServerPort;
+var odataPrefix = '/odata';
+
+//OData handler configuration
+var configuration = {
+    //Here serviceConfiguration points to a single directory: so the first uri segment behind the port
+    //must contain the name of the xsodata file to use. E.g. for name demo.xsodata:
+    //http://localhost/demo.xsodata/$metadata
+    "serviceConfiguration": path.join(__dirname, "services/demo.xsodata"),
+    "defaultSchema": 'REFSCENARIO',
+    "dbConfiguration": {
+        "host": "<your host>",
+        "port": 1234,
+        "user": "<your user>",
+        "password": "<your password>"
+    },
+    "logger": logger
+};
+
+
+//Instantiate ODataHandler
+var handler = new xsOData.ODataHandler(configuration);
+
+
+//express stuff
+var app = express();
+
+app.use(odataPrefix, function (req, res, next) {
+    handler.processRequest(req, res, req.baseUrl, function done() {
+        console.log("processed odata request " + req.url);
+    });
+    return;
+});
+
+app.use(express.static('public'));
+
+app.listen(webServerPort, function () {
+    console.log("Listen on localhost:" + webServerPort);
+    console.log("Index url for demo    : http://" + hostPortName + odataPrefix + '/odata/index.html');
+    console.log("Service url for demo    : http://" + hostPortName + odataPrefix + '/');
+});

package/documentation/code_samples_pure_node/expressjs__single_service/package.json

@@ -0,0 +1,11 @@
+{
+    "name": "expressjs",
+    "description": "",
+    "version": "0.0.1",
+    "scripts": {
+        "start": "node index.js"
+    },
+    "dependencies": {
+        "express": "^4.13.3"
+    }
+}

package/documentation/code_samples_pure_node/expressjs__single_service/public/index.html

@@ -0,0 +1,18 @@
+<html>
+<head>
+    <title>xsodata with expressjs sample</title>
+</head>
+<body bgcolor=white>
+<ul>
+    <li>
+        Service url: <a href="/odata/">http://localhost:8019/odata/</a>
+    </li>
+    <li>
+        Metadata url: <a href="/odata/$metadata">http://localhost:8019/odata/$metadata</a>
+    </li>
+    <li>
+        Employee url: <a href="/odata/Employees?$format=json">http://localhost:8019/odata/Employees?$format=json</a>
+    </li>
+</ul>
+</body>
+</html>

package/documentation/code_samples_pure_node/expressjs__single_service/services/demo.xsodata

@@ -0,0 +1,7 @@
+service  namespace "REFSCENARIO" { 
+   	"xsodata.refscenario.tables::Employees" as "Employees";
+   	"xsodata.refscenario.tables::Teams" as "Teams";
+   	"xsodata.refscenario.tables::Rooms" as "Rooms";
+   	"xsodata.refscenario.tables::Managers" as "Managers";
+    "xsodata.refscenario.tables::Buildings" as "Buildings";
+}

package/documentation/code_samples_pure_node/readme.md

@@ -0,0 +1,32 @@
+xsodata code samples without xsjs
+=================================
+
+These are samples that are using the XSOData library directly (means without a HANA XSA server). 
+The code samples can be used as a reference for own web servers exporting OData payloads. 
+
+### Prerequisites  
+- Node.js 0.12.7 installed
+
+### Content
+
+- direct_use__multi_services
+  A plain node http server using the odata handler serving all xsodata files from a directory
+- direct_use__single_service  
+  A plain node http server using the odata handler 
+- expressjs__multi_services  
+  An express server using the odata handler serving all xsodata files from a directory
+- expressjs__single_service  
+  An express server using the odata handler to serve a single xsodata file
+
+To execute the examples please perform the following steps:
+- create the database table you want to expose
+- adopt the *.xsodata samples file to use your own tables
+- provide db configuration (host,user,password) in the index.js files
+- start via:  
+```sh
+$ cd documentation/examples/direct_use__single_service
+$ npm install
+$ npm start
+# The output will tell you the URL to use
+```
+- test in browser for example via url http://localhost/demo.xsodata/$metadata