@lblod/mu-auth-sudo 0.3.1 → 0.5.1

package/README.md

@@ -9,4 +9,33 @@ npm install @lblod/mu-auth-sudo
 Include the following in your code
 ```
 import { querySudo as query, updateSudo as update } from '@lblod/mu-auth-sudo';
+
+
+//Examples
+
+// To run a normal query
+
+const queryString = `SELECT * FROM { GRAPH ?g { ?s ?p ?o. } } LIMIT 1`;
+await query(queryString);
+
+// To pass extra headers
+
+const updateString = `INSERT DATA { GRAPH <http://foo> { <http://bar> <http://baz> <http://boom>. } }`;
+const extraHeaders = { 'mu-call-scope-id':  'http://foo/bar', 'other-info'; 'hello' };
+await update(updateString, extraHeaders);
+
+// With custom sparqlEndpoint (this should be exceptional, make sure you know what you're doing)
+
+await update(updateString, extraHeaders, 'http://the.sparql.endpoint/sparql');
 ```
+
+## Logging
+
+The verbosity of logging can be configured as in the [javascript template](https://github.com/mu-semtech/mu-javascript-template/blob/6ff43eaf51856783c6946e82344e31a3348ce4a3/README.md#logging) through following environment variables:
+
+- `LOG_SPARQL_ALL`: Logging of all executed SPARQL queries, read as well as update (default `true`)
+- `LOG_SPARQL_QUERIES`: Logging of executed SPARQL read queries (default: `undefined`). Overrules `LOG_SPARQL_ALL`.
+- `LOG_SPARQL_UPDATES`: Logging of executed SPARQL update queries (default `undefined`). Overrules `LOG_SPARQL_ALL`.
+- `DEBUG_AUTH_HEADERS`: Debugging of [mu-authorization](https://github.com/mu-semtech/mu-authorization) access-control related headers (default `true`)
+
+Following values are considered true: [`"true"`, `"TRUE"`, `"1"`].

package/dist/auth-sudo.js

@@ -23,7 +23,9 @@ var DEBUG_AUTH_HEADERS = _envVar2.default.get('DEBUG_AUTH_HEADERS').asBool();
 
 function sudoSparqlClient() {
   var extraHeaders = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var sparqlEndpoint = arguments[1];
 
+  sparqlEndpoint = sparqlEndpoint || process.env.MU_SPARQL_ENDPOINT;
   var options = {
     requestDefaults: {
       headers: {
@@ -67,36 +69,44 @@ function sudoSparqlClient() {
   if (DEBUG_AUTH_HEADERS) {
     console.log('Headers set on SPARQL client: ' + JSON.stringify(options));
   }
-  return new _sparqlClient.SparqlClient(process.env.MU_SPARQL_ENDPOINT, options);
+
+  return new _sparqlClient.SparqlClient(sparqlEndpoint, options);
 }
 
-function executeRawQuery(queryString) {
-  return sudoSparqlClient().query(queryString).executeRaw().then(function (response) {
-    function maybeParseJSON(body) {
-      // Catch invalid JSON
-      try {
-        return JSON.parse(body);
-      } catch (ex) {
-        return null;
-      }
-    }
+async function executeRawQuery(queryString) {
+  var extraHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var sparqlEndpoint = arguments[2];
 
-    return maybeParseJSON(response.body);
-  });
-}
 
-function querySudo(queryString) {
   if (LOG_SPARQL_QUERIES) {
     console.log(queryString);
   }
-  return executeRawQuery(queryString);
+
+  var response = await sudoSparqlClient(extraHeaders, sparqlEndpoint).query(queryString).executeRaw();
+  return maybeParseJSON(response.body);
+}
+
+function querySudo(queryString) {
+  var extraHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var sparqlEndpoint = arguments[2];
+
+  return executeRawQuery(queryString, extraHeaders, sparqlEndpoint);
 }
 
 function updateSudo(queryString) {
-  if (LOG_SPARQL_UPDATES) {
-    console.log(queryString);
+  var extraHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var sparqlEndpoint = arguments[2];
+
+  return executeRawQuery(queryString, extraHeaders, sparqlEndpoint);
+}
+
+function maybeParseJSON(body) {
+  // Catch invalid JSON
+  try {
+    return JSON.parse(body);
+  } catch (ex) {
+    return null;
   }
-  return executeRawQuery(queryString);
 }
 
 var _exports = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/mu-auth-sudo",
-  "version": "0.3.1",
+  "version": "0.5.1",
   "description": "this package provides an alternative sparql client for the mu-javascript-template that has sudo rights.",
   "main": "dist/auth-sudo.js",
   "scripts": {
@@ -33,8 +33,8 @@
   "homepage": "https://github.com/lblod/mu-auth-sudo#readme",
   "devDependencies": {
     "babel-cli": "^6.26.0",
+    "babel-plugin-add-module-exports": "^1.0.4",
     "babel-preset-env": "^1.7.0",
-    "babel-plugin-add-module-exports": "^1.0.0",
     "babel-preset-es2015": "^6.24.1",
     "babel-register": "^6.26.0"
   },