odsl-javascript-sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,2 +1,75 @@
 # odsl-javascript-sdk
-Javascript SDK for OpenDataDSL
+The Javascript SDK for the [OpenDataDSL](https://opendatadsl.com) data management platform
+
+## Installation
+You can install the ODSL Javascript SDK from [npm](https://www.npmjs.com/package/odsl-javascript-sdk):
+
+    npm i odsl-javascipt-sdk
+
+## About
+This javascript SDK for OpenDataDSL has the following features:
+
+* Find any data in OpenDataDSL using the ```list``` command
+* Retrieve any data using the ```get``` command
+* Update any data (if you have permission) using the ```update``` command
+
+Check out our [demo repository](https://github.com/OpenDataDSL/odsl-javascript-sdk-demo) for examples of real-world usage.
+
+## Usage
+
+### Logging in and getting started
+
+#### Logging in using a client credentials flow (client secret)
+```js
+import ODSL from '../src/sdk.js'
+import "dotenv/config";
+
+var config = {
+    auth: {
+        clientId: process.env.clientId,
+        authority: process.env.authority,
+        clientSecret: process.env.clientSecret
+    }
+};
+
+ODSL.loginWithSecret(config).then(function(odsl) {
+	# Do Something
+});
+```
+
+### Finding master data
+
+```js
+objects = ODSL.list('object', 'public', 'source=ECB')
+# objects is a JSON object wrapper containing status, statusText and body
+print(objects.body[0])
+```
+
+### Getting master data
+
+```js
+obj = ODSL.get('object', 'public', '#ECB')
+print(obj.body['description'])
+```
+
+### Getting a timeseries
+```js
+ts = ODSL.get('data', 'public', '#ABN_FX.EURUSD:SPOT')
+print(ts.body)
+```
+
+### Updating some private master data
+```js
+var = {
+    '_id': 'AAA.PYTHON',
+    'name': 'Python Example'
+}
+ODSL.update('object', 'private', var)
+```
+
+### Reading and updating some private master data
+```js
+po = ODSL.get('object', 'private', 'AAA.TEST')
+po.body['description'] = 'Updated from Javascript'
+ODSL.update('object', 'private', po.body)
+```

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "odsl-javascript-sdk",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Javascript SDK for OpenDataDSL",
   "main": "src/sdk.js",
   "scripts": {
-    "test": "mocha test/test.js"
+    "test": "mocha test/test.js",
+    "npm:publish": "npm publish"
   },
   "repository": {
     "type": "git",

package/.vscode/launch.json

@@ -1,15 +0,0 @@
-{
-	// Use IntelliSense to learn about possible attributes.
-	// Hover to view descriptions of existing attributes.
-	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"type": "chrome",
-			"request": "launch",
-			"name": "Launch Chrome against localhost",
-			"url": "http://localhost:8080",
-			"webRoot": "${workspaceFolder}/test/web"
-		}
-	]
-}

package/test/test.js

@@ -1,33 +0,0 @@
-'use strict';
-
-import ODSL from '../src/sdk.js'
-import "dotenv/config";
-
-var config = {
-    auth: {
-        clientId: process.env.clientId,
-        authority: process.env.authority,
-        clientSecret: process.env.clientSecret
-    }
-};
-
-console.log("Asynchronous GET");
-ODSL.loginWithSecret(config).then(function(odsl) {
-	odsl.getAsync('object', 'private', 'AAA', function(r) {
-        if (r.status == 200) {
-            console.log(r.body);
-        } else {
-            console.log(r.status + ": " + r.statusText);
-        }
-    });
-});
-
-console.log("Synchronous GET");
-ODSL.loginWithSecret(config).then(function(odsl) {
-    var r = odsl.get('object', 'private', 'AAA');
-    if (r.status == 200) {
-        console.log(r.body);
-    } else {
-        console.log(r.status + ": " + r.statusText);
-    }
-});