v0.4.0

Author: m-mohr

.gitignore

@@ -1,9 +1,15 @@
+# NPM
 node_modules/
-/dist
 /package-lock.json
 
-/nbproject/
-.vscode
+# Build related
+/openeo.min.js
 
+# Reports
 coverage/
-/test-report.html
+docs/
+
+# Temporary files from the earthengine tests
+/lorem.txt
+/randomnumber.txt
+/downloaded_file.txt

.jshintrc

@@ -0,0 +1,18 @@
+{
+	"curly": true,
+	"eqeqeq": true,
+	"esversion": 8,
+	"freeze": true,
+	"futurehostile": true,
+	"noarg": true,
+	"nocomma": true,
+	"nonbsp": true,
+	"undef": true,
+	"unused": true,
+	"browser": true,
+	"node": true,
+	"globals": {
+		"axios": true,
+		"define": true
+	}
+}

.travis.yml

@@ -10,5 +10,27 @@ cache:
     - "node_modules"
 
 script:
+# Run code checks
+  - npm run compat
+# Run tests
   - npm run test
-  - npm run test_node
+  - npm run test_node
+# - npm run test_gee
+# Build
+  - npm run build
+# Generate docs
+  - npm run docs
+# Deploy 
+  - git clone --branch gh-pages https://$GITHUB_TOKEN@github.com/Open-EO/openeo-js-client.git gh-pages
+  - cd gh-pages
+  - cp -R ../docs/@openeo/js-client/* .
+
+deploy:
+  provider: pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  keep-history: true
+  committer-from-gh: true
+  local-dir: gh-pages
+  on:
+    all_branches: true

README.md

@@ -4,40 +4,57 @@ JavaScript client for the openEO API.
 
 [![Build Status](https://travis-ci.org/Open-EO/openeo-js-client.svg?branch=master)](https://travis-ci.org/Open-EO/openeo-js-client)
 
-This client is in **version 0.3.5** and supports **openEO API versions 0.3.0 and 0.3.1**. Legacy versions are available as releases.
+The version of this client is **0.4.0** and supports **openEO API version 0.4.x**. Legacy versions are available as releases.
 
 ## Usage
-This library can run in a recent browser supporting ECMAScript 2015 or node.js.
+
+This library can run in node.js or any recent browser supporting ECMAScript 2017 (ES8). This includes [mostly all browsers released after mid 2017, but excludes Internet Explorer 11](https://caniuse.com/#search=async%20functions).
+
+### Browser environment
 
 To use it in a browser environment simply add the following code to your HTML file:
 ```html
 <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@openeo/js-client/openeo.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@openeo/js-client/openeo.min.js"></script>
 ```
 
-To install it with npm run: `npm install @openeo/js-client`
+### NodeJS environment
+
+To install it in a NodeJS environment run: `npm install @openeo/js-client`
+
+Afterwards, you can import the package: `const { OpenEO } = require('@openeo/js-client');`
+
+### Advanced options
+
+Generate a minified build: `npm run build`
+
+Generate the documentation to the `docs/` folder: `npm run docs`
+
+Check against the coding guidelines: `npm run compat`
+
+Run tests:
+
+* `npm run test` (basic browser-based tests)
+* `npm run test_node` (basic node-based tests)
+* `npm run test_gee` (full test suite using the Google Earth Engine back-end as server)
 
 ### Running a job
 
 ```js
-// Import the library if running in a nodeJS environment
-// const { OpenEO } = require('@openeo/js-client');
-
-var obj = new OpenEO();
 // Show the client version
-console.log("Client Version: " +obj.version());
+console.log("Client Version: " + OpenEO.clientVersion());
 
 try {
   // Connect to the back-end
-  var con = await obj.connect("https://earthengine.openeo.org/v0.3", "basic", {username: "group1", password: "test123"});
+  var con = await OpenEO.connect("https://earthengine.openeo.org", "basic", {username: "group1", password: "test123"});
 
   // Show implemented API version of the back-end
-  var capabilities = await con.capabilities();
-  console.log("Server API version: " +capabilities.version());
+  var capabilities = con.capabilities();
+  console.log("Server API version: " + capabilities.apiVersion());
 
   // List collection names
   var collections = await con.listCollections();
-  console.log("Collections: " +collections.collections.map(c => c.name));
+  console.log("Collections: " + collections.collections.map(c => c.name));
 
   // List process ids
   var processes = await con.listProcesses();
@@ -48,43 +65,31 @@ try {
   console.log("Files types: " + Object.keys(fileTypes.formats));
 
   // Check whether synchronous previews are supported
-  var syncSupport = capabilities.hasFeature("execute");
+  var syncSupport = capabilities.hasFeature("computeResult");
   console.log("Synchronous previews: " + (syncSupport ? "supported" : "NOT supported"));
 
   // Request a preview synchronously for a process graph
   if (syncSupport) {
-    // Derives maximum NDVI measurements over pixel time series of Sentinel 2 imagery
-    var processGraph = {
-      "imagery": {
-        "red": "B4",
-        "nir": "B8",
-        "imagery": {
-          "extent": ["2018-12-01T00:00:00Z","2018-12-31T23:59:59Z"],
-          "imagery": {
-            "extent": {"west": 8.265169,"south": 52.453917,"east": 8.42035,"north": 52.576767},
-            "imagery": {
-              "process_id": "get_collection",
-              "name": "COPERNICUS/S2"
-            },
-            "process_id": "filter_bbox"
-          },
-          "process_id": "filter_daterange"
-        },
-        "process_id": "NDVI"
-      },
-      "process_id": "max_time"
-    };
-    var preview = await con.execute(processGraph, "png");
+    // Replace ... with your JSON process graph
+    var preview = await con.computeResult(..., "png");
     // This returns a Blob object containing a binary PNG file you could further process or show.
   }
 } catch(e) {
   console.log(e);
 }
 ```
 
+More information can be found in the [**JS client documentation**](https://open-eo.github.io/openeo-js-client/0.4.0/).
+
+## Roadmap
+
+* The JS client only supports browsers with support for ECMAScript 2017 (ES8). This is a steep requirement and should be lowered by transpiling. [#18](https://github.com/Open-EO/openeo-js-client/issues/18)
+* There's no functionality to build process graphs. An easy-to-use process graph builder is envisioned to be implemented. [#19](https://github.com/Open-EO/openeo-js-client/issues/19)
+* Implement authentification via OpenID Connect. [#11](https://github.com/Open-EO/openeo-js-client/issues/11)
+* See the [issue tracker](https://github.com/Open-EO/openeo-js-client/issues) for more information.
+
 ## Interactive JS Editor
 
 There is an experimental interactive web-based editor for coding using the openEO API,
-where you can define processes and visualizations in JavaScript.
+which is based on the JavaScript client.
 See [https://github.com/Open-EO/openeo-web-editor](https://github.com/Open-EO/openeo-web-editor) for more details.
-

examples/discovery.html

@@ -7,22 +7,21 @@
 		<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
 		<script src="../openeo.js"></script>
 		<script type="text/javascript">
-			var url = "https://earthengine.openeo.org/v0.3"; // Insert the openEO server URL here
+			var url = "https://earthengine.openeo.org"; // Insert the openEO server URL here
 			var connection = null;
 
 			window.onload = function () {
 				document.getElementById('url').innerText = url;
 
-				var client = new OpenEO();
-				document.getElementById('clientVersion').innerText = client.version();
+				document.getElementById('clientVersion').innerText = OpenEO.clientVersion();
 
-				client.connect(url)
+				OpenEO.connect(url)
 				.then(c => {
 					connection = c;
 					return connection.capabilities();
 				})
 				.then(capabilities => {
-					document.getElementById('serverVersion').innerText = capabilities.version();
+					document.getElementById('serverVersion').innerText = capabilities.apiVersion();
 					return connection.listCollections();
 				})
 				.then(collections => {

jest.config.js

@@ -13,7 +13,8 @@ module.exports = {
   "reporters": [
     "default",
     ["./node_modules/jest-html-reporter", {
-      "pageTitle": "Test Report for openeo-js-client"
+      "pageTitle": "Test Report for openeo-js-client",
+      "outputPath": "./coverage/test-report.html"
     }]
   ]