Remove sparql client dependency

.gitignore

@@ -0,0 +1 @@
+node_modules

Dockerfile

@@ -2,29 +2,30 @@ FROM node:20-bookworm
 
 LABEL maintainer="team@semantic.works"
 
-RUN apt-get update && apt-get -y upgrade && apt-get -y install git openssh-client rsync
+RUN apt-get update && apt-get -y upgrade && apt-get -y install git openssh-client rsync jq
 
-ENV MU_SPARQL_ENDPOINT 'http://database:8890/sparql'
-ENV MU_APPLICATION_GRAPH 'http://mu.semte.ch/application'
-ENV NODE_ENV 'production'
+ENV MU_SPARQL_ENDPOINT='http://database:8890/sparql'
+ENV MU_APPLICATION_GRAPH='http://mu.semte.ch/application'
+ENV NODE_ENV='production'
 
-ENV HOST '0.0.0.0'
-ENV PORT '80'
+ENV HOST='0.0.0.0'
+ENV PORT='80'
 
-ENV LOG_SPARQL_ALL 'true'
-ENV DEBUG_AUTH_HEADERS 'true'
+ENV LOG_SPARQL_ALL='true'
+ENV DEBUG_AUTH_HEADERS='true'
 
 WORKDIR /usr/src/app
 COPY package.json /usr/src/app/package.json
 COPY ./scripts /app/scripts
 RUN npm install
 COPY . /usr/src/app
 RUN chmod +x /usr/src/app/run-development.sh
+RUN chmod +x /usr/src/app/run-production.sh
 RUN chmod +x /usr/src/app/build-production.sh
 
 EXPOSE ${PORT}
 
-CMD bash boot.sh
+CMD ["bash", "boot.sh"]
 
 # This stuff only runs when building an image from the template
 ONBUILD RUN rm -Rf /app/scripts

README.md

@@ -202,8 +202,8 @@ mu.app.get('/', function( req, res ) {
 ```
 
 The following helper functions are provided by the template
-  - `query(query) => Promise`: Function for sending queries to the triplestore
-  - `update(query) => Promise`: Function for sending updates to the triplestore
+  - `query(queryString, options) => Promise`: Function for sending queries to the triplestore.  Options is an object which may include `sudo` and `scope` keys.
+  - `update(query, options) => Promise`: Function for sending updates to the triplestore.  Options is an object which may include `sudo` and `scope` keys.
   - `uuid() => string`: Generates a random UUID (e.g. to construct new resource URIs)
 
 The following SPARQL escape helpers are provided to construct safe SPARQL query strings
@@ -217,6 +217,49 @@ The following SPARQL escape helpers are provided to construct safe SPARQL query
   - `sparqlEscapeBool(value) => string`: The given value is evaluated to a boolean value in javascript. E.g. the string value `'0'` evaluates to `false` in javascript.
   - `sparqlEscape(value, type) => string`: Function to escape a value in SPARQL according to the given type. Type must be one of `'string'`, `'uri'`, `'int'`, `'float'`, `'date'`, `'dateTime'`, `'bool'`.
 
+### Executing queries
+
+#### Example 
+```js
+import { query } from 'mu';
+
+const queryString = `
+  PREFIX dbo: <http://dbpedia.org/ontology/>
+  SELECT ?name WHERE {
+    ?person a dbo:Person ;
+            dbo:birthPlace <http://dbpedia.org/resource/Belgium> ;
+            dbo:name ?name .
+  } LIMIT 10
+`;
+
+const options = {
+  scope: "my-scope",
+  extraHeaders: {
+    "X-Custom-Header": "value"
+  },
+};
+
+response = await query(queryString, options);
+```
+
+#### Parameters
+The `query` and `update` helpers accept the same parameters.
+
+| Parameter                | Type      | Default              | Description                                                                        |
+|--------------------------|-----------|----------------------|------------------------------------------------------------------------------------|
+| `queryString`            | `string`  | _Required_           | The SPARQL query to execute.                                                       |
+| `options`                | `object`  | `{}`                 | Optional configuration settings.                                                   |
+| `options.sudo`           | `boolean` | `false`              | Whether to enable sudo mode (requires environment permission).                     |
+| `options.scope`          | `string`  | _(Env default)_      | The authentication scope to use. Defaults to `DEFAULT_MU_AUTH_SCOPE` if available. |
+
+#### Experimental Parameters
+| `options.sparqlEndpoint` | `string`  | `MU_SPARQL_ENDPOINT` | The SPARQL endpoint to send the request to.                                        |
+| `options.extraHeaders`   | `object`  | `{}`                 | Additional headers to send in the request.                                         |
+| `options.authUser`       | `string`  | `undefined`          | The username for HTTP authentication (optional).                                   |
+| `options.authPassword`   | `string`  | `undefined`          | The password for HTTP authentication (optional).                                   |
+| `options.authType`       | `string`  | "digest"`            | The type of authentication to use. (`"digest"` or `"basic"`)                       |
+
+
 ### Error handling
 The template offers [an error handler](https://expressjs.com/en/guide/error-handling.html) to send error responses in a JSON:API compliant way. The handler can be imported from `'mu'` and need to be loaded at the end.
 
@@ -227,7 +270,7 @@ app.get('/hello', function( req, res, next ) {
   try {
     ...
   } catch (e) {
-    next(new Error('Oops, something went wrong.))
+    next(new Error('Oops, something went wrong.'))
   }
 });
 
@@ -254,6 +297,8 @@ The following environment variables can be configured:
   - `MAX_BODY_SIZE` (default: `100kb`): max size of the request body. See [ExpressJS documentation](https://expressjs.com/en/resources/middleware/body-parser.html#limit).
   - `HOST` (default: `0.0.0.0`): The hostname you want the service to bind to.
   - `PORT` (default: `80`): The port you want the service to bind to.
+  - `ALLOW_MU_AUTH_SUDO`: Allow sudo queries when the service requests it.
+  - `DEFAULT_MU_AUTH_SCOPE`: Default mu-auth-scope to use for calls.
 
 
 #### Mounting `/config`

babel.config.json

@@ -4,16 +4,18 @@
       {
         "targets": {
           "node": 18
-        }
+        },
+        "modules": false
       }
     ],
     ["@babel/preset-typescript"]
   ],
   "plugins": [
-    ["@babel/plugin-proposal-decorators", { "version": "2023-05" }]
+    ["@babel/plugin-proposal-decorators", { "version": "2023-05" }],
+    ["babel-plugin-add-import-extension"]
   ],
   "ignore": [
     "./node_modules",
-    "/usr/src/processing/build/node_modules"
+    "/usr/src/dist/node_modules"
   ]
 }

boot.sh

@@ -9,48 +9,5 @@ then
          --exec /usr/src/app/run-development.sh
 elif [ "$NODE_ENV" == "production" ]
 then
-    diff -rq /app /app.original > /dev/null
-    APP_FILES_CHANGED="$?"
-    diff -rq /config /config.original > /dev/null
-    CONFIG_FILES_CHANGED="$?"
-
-    if [ ! -f /usr/src/build/app.js ]
-    then
-        echo "No built sources found.  If you mount new sources, please set the NODE_ENV=\"development\" environment variable."
-        sleep 5;
-        exit 1;
-    elif [ $APP_FILES_CHANGED != "0" ]
-    then
-        echo "Built sources are not the same as sources available in /app.  If you mount new sources, please set the NODE_ENV=\"development\" environment variable."
-        sleep 5;
-        exit 1;
-    elif [ $CONFIG_FILES_CHANGED != "0" ]
-    then
-        echo "Rebuilding sources to include /config."
-
-        # move new configuration into app for transpilation
-        if [[ "$(ls -A /config 2> /dev/null)" ]]
-        then
-            cp -Rf /config/* /usr/src/app/app/config/
-        fi
-
-        # make a backup of the used configuration so we can detect changes
-        rm -Rf /config.original
-        mkdir /config.original
-        if [[ "$(ls -A /config 2> /dev/null)" ]]
-        then
-            cp -Rf /config/* /config.original
-        fi
-
-        # transpile sources
-        cd /usr/src/app/
-        ./transpile-sources.sh
-
-        # boot transpiled sources
-        cd /usr/src/build/
-        exec node ./app.js
-    else
-        cd /usr/src/build/
-        exec node ./app.js
-    fi
+    /usr/src/app/run-production.sh
 fi

build-production.sh

@@ -22,12 +22,7 @@ fi
 cp -r /app /app.original
 
 # Install custom packages if need be
-if [ -f ./app/package.json ]
-then
-    echo "Running npm install"
-    cd /usr/src/app/app/
-    npm install
-    cd /usr/src/app/
-fi
+./prepare-package-json.sh
+./npm-install-dependencies.sh production
 
 ./transpile-sources.sh

helpers.sh

@@ -15,5 +15,5 @@ function docker-rsync() {
   # --numeric-ids: use uuid by number instead of by name
   # --info: silent output
   # --no-compress: no compression algorithm
-  rsync -aHAWXS --numeric-ids --info= --no-compress $@
+  rsync -aHAWXS --numeric-ids --info= --no-compress "$@"
 }

helpers/mu/index.js

@@ -1,5 +1,5 @@
-import { app, errorHandler } from './server';
-import sparql from './sparql';
+import { app, errorHandler } from './server.js';
+import sparql from './sparql.js';
 import { v1 as uuidV1 } from 'uuid';
 
 // generates a uuid

helpers/mu/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "mu",
+  "version": "0.0.1",
+  "description": "Framework layer functions for mu-javascript-template.",
+  "main": "index.js",
+  "type": "module",
+  "author": "Semantic Works",
+  "license": "MIT"
+}